/**
* Test the logic in the test_anonforum_tp_is_tracked() function.
*/
public function test_anonforum_tp_is_tracked()
{
global $CFG;
$this->resetAfterTest();
$useron = $this->getDataGenerator()->create_user(array('trackforums' => 1));
$useroff = $this->getDataGenerator()->create_user(array('trackforums' => 0));
$course = $this->getDataGenerator()->create_course();
$options = array('course' => $course->id, 'trackingtype' => FORUM_TRACKING_OFF);
// Off.
$anonforumoff = $this->getDataGenerator()->create_module('anonforum', $options);
$options = array('course' => $course->id, 'trackingtype' => FORUM_TRACKING_FORCED);
// On.
$anonforumforce = $this->getDataGenerator()->create_module('anonforum', $options);
$options = array('course' => $course->id, 'trackingtype' => FORUM_TRACKING_OPTIONAL);
// Optional.
$anonforumoptional = $this->getDataGenerator()->create_module('anonforum', $options);
// Allow force.
$CFG->anonforum_allowforcedreadtracking = 1;
// User on, anonforum off, should be off.
$result = anonforum_tp_is_tracked($anonforumoff, $useron);
$this->assertEquals(false, $result);
// User on, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useron);
$this->assertEquals(true, $result);
// User on, anonforum optional, should be on.
$result = anonforum_tp_is_tracked($anonforumoptional, $useron);
$this->assertEquals(true, $result);
// User off, anonforum off, should be off.
$result = anonforum_tp_is_tracked($anonforumoff, $useroff);
$this->assertEquals(false, $result);
// User off, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useroff);
$this->assertEquals(true, $result);
// User off, anonforum optional, should be off.
$result = anonforum_tp_is_tracked($anonforumoptional, $useroff);
$this->assertEquals(false, $result);
// Don't allow force.
$CFG->anonforum_allowforcedreadtracking = 0;
// User on, anonforum off, should be off.
$result = anonforum_tp_is_tracked($anonforumoff, $useron);
$this->assertEquals(false, $result);
// User on, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useron);
$this->assertEquals(true, $result);
// User on, anonforum optional, should be on.
$result = anonforum_tp_is_tracked($anonforumoptional, $useron);
$this->assertEquals(true, $result);
// User off, anonforum off, should be off.
$result = anonforum_tp_is_tracked($anonforumoff, $useroff);
$this->assertEquals(false, $result);
// User off, anonforum force, should be off.
$result = anonforum_tp_is_tracked($anonforumforce, $useroff);
$this->assertEquals(false, $result);
// User off, anonforum optional, should be off.
$result = anonforum_tp_is_tracked($anonforumoptional, $useroff);
$this->assertEquals(false, $result);
// Stop tracking so we can test again.
anonforum_tp_stop_tracking($anonforumforce->id, $useron->id);
anonforum_tp_stop_tracking($anonforumoptional->id, $useron->id);
anonforum_tp_stop_tracking($anonforumforce->id, $useroff->id);
anonforum_tp_stop_tracking($anonforumoptional->id, $useroff->id);
// Allow force.
$CFG->anonforum_allowforcedreadtracking = 1;
// User on, preference off, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useron);
$this->assertEquals(true, $result);
// User on, preference off, anonforum optional, should be on.
$result = anonforum_tp_is_tracked($anonforumoptional, $useron);
$this->assertEquals(false, $result);
// User off, preference off, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useroff);
$this->assertEquals(true, $result);
// User off, preference off, anonforum optional, should be off.
$result = anonforum_tp_is_tracked($anonforumoptional, $useroff);
$this->assertEquals(false, $result);
// Don't allow force.
$CFG->anonforum_allowforcedreadtracking = 0;
// User on, preference off, anonforum force, should be on.
$result = anonforum_tp_is_tracked($anonforumforce, $useron);
$this->assertEquals(false, $result);
// User on, preference off, anonforum optional, should be on.
$result = anonforum_tp_is_tracked($anonforumoptional, $useron);
$this->assertEquals(false, $result);
// User off, preference off, anonforum force, should be off.
$result = anonforum_tp_is_tracked($anonforumforce, $useroff);
$this->assertEquals(false, $result);
// User off, preference off, anonforum optional, should be off.
$result = anonforum_tp_is_tracked($anonforumoptional, $useroff);
$this->assertEquals(false, $result);
}
/**
* Returns a list of anonforum discussions as well as a summary of the discussion
* in a provided list of anonforums.
*
* @param array $anonforumids the anonforum ids
* @return array the anonforum discussion details
* @since Moodle 2.5
*/
public static function get_anonforum_discussions($anonforumids)
{
global $CFG, $DB, $USER;
require_once $CFG->dirroot . "/mod/anonforum/lib.php";
// Validate the parameter.
$params = self::validate_parameters(self::get_anonforum_discussions_parameters(), array('anonforumids' => $anonforumids));
$anonforumids = $params['anonforumids'];
// Array to store the anonymous forum discussions to return.
$arrdiscussions = array();
// Keep track of the course ids we have performed a require_course_login check on to avoid repeating.
$arrcourseschecked = array();
// Store the modinfo for the anonymous forums in an individual courses.
$arrcoursesanonforuminfo = array();
// Keep track of the users we have looked up in the DB.
$arrusers = array();
// Loop through them.
foreach ($anonforumids as $id) {
// Get the anonymous forum object.
$anonforum = $DB->get_record('anonforum', array('id' => $id), '*', MUST_EXIST);
// Check that that user can view this course if check not performed yet.
if (!in_array($anonforum->course, $arrcourseschecked)) {
// Check the user can function in this context.
self::validate_context(context_course::instance($anonforum->course));
// Add to the array.
$arrcourseschecked[] = $anonforum->course;
}
// Get the modinfo for the course if we haven't already.
if (!isset($arrcoursesanonforuminfo[$anonforum->course])) {
$modinfo = get_fast_modinfo($anonforum->course);
$arrcoursesanonforuminfo[$anonforum->course] = $modinfo->get_instances_of('anonforum');
}
// Check if this anonymous forum does not exist in the modinfo array, should always be false unless DB is borked.
if (empty($arrcoursesanonforuminfo[$anonforum->course][$anonforum->id])) {
throw new moodle_exception('invalidmodule', 'error');
}
// We now have the course module.
$cm = $arrcoursesanonforuminfo[$anonforum->course][$anonforum->id];
// If the anonymous forum is not visible throw an exception.
if (!$cm->uservisible) {
throw new moodle_exception('nopermissiontoshow', 'error');
}
// Get the module context.
$modcontext = context_module::instance($cm->id);
// Check they have the view anonymous forum capability.
require_capability('mod/anonforum:viewdiscussion', $modcontext);
// Check if they can view full names.
$canviewfullname = has_capability('moodle/site:viewfullnames', $modcontext);
// Get the unreads array, this takes a anonymous forum id and returns data for all discussions.
$unreads = array();
if ($cantrack = anonforum_tp_can_track_anonforums($anonforum)) {
if ($anonforumtracked = anonforum_tp_is_tracked($anonforum)) {
$unreads = anonforum_get_discussions_unread($cm);
}
}
// The anonforum function returns the replies for all the discussions in a given anonymous forum.
$replies = anonforum_count_discussion_replies($id);
// Get the discussions for this anonymous forum.
if ($discussions = $DB->get_records('anonforum_discussions', array('anonforum' => $id))) {
foreach ($discussions as $discussion) {
// If the anonymous forum is of type qanda and the user has not posted in the discussion
// we need to ensure that they have the required capability.
if ($anonforum->type == 'qanda' && !anonforum_user_has_posted($discussion->anonforum, $discussion->id, $USER->id)) {
require_capability('mod/anonforum:viewqandawithoutposting', $modcontext);
}
$usernamefields = user_picture::fields();
// If we don't have the users details then perform DB call.
if (empty($arrusers[$discussion->userid])) {
$arrusers[$discussion->userid] = $DB->get_record('user', array('id' => $discussion->userid), $usernamefields, MUST_EXIST);
}
// Get the subject.
$subject = $DB->get_field('anonforum_posts', 'subject', array('id' => $discussion->firstpost), MUST_EXIST);
// Create object to return.
$return = new stdClass();
$return->id = (int) $discussion->id;
$return->course = $discussion->course;
$return->anonforum = $discussion->anonforum;
$return->name = $discussion->name;
$return->userid = $discussion->userid;
$return->groupid = $discussion->groupid;
$return->assessed = $discussion->assessed;
$return->timemodified = (int) $discussion->timemodified;
$return->usermodified = $discussion->usermodified;
$return->timestart = $discussion->timestart;
$return->timeend = $discussion->timeend;
$return->firstpost = (int) $discussion->firstpost;
$return->firstuserfullname = fullname($arrusers[$discussion->userid], $canviewfullname);
$return->firstuserimagealt = $arrusers[$discussion->userid]->imagealt;
$return->firstuserpicture = $arrusers[$discussion->userid]->picture;
$return->firstuseremail = $arrusers[$discussion->userid]->email;
$return->subject = $subject;
$return->numunread = '';
if ($cantrack && $anonforumtracked) {
if (isset($unreads[$discussion->id])) {
$return->numunread = (int) $unreads[$discussion->id];
}
}
// Check if there are any replies to this discussion.
if (!empty($replies[$discussion->id])) {
$return->numreplies = (int) $replies[$discussion->id]->replies;
$return->lastpost = (int) $replies[$discussion->id]->lastpostid;
} else {
// No replies, so the last post will be the first post.
$return->numreplies = 0;
$return->lastpost = (int) $discussion->firstpost;
}
// Get the last post as well as the user who made it.
$lastpost = $DB->get_record('anonforum_posts', array('id' => $return->lastpost), '*', MUST_EXIST);
if (empty($arrusers[$lastpost->userid])) {
$arrusers[$lastpost->userid] = $DB->get_record('user', array('id' => $lastpost->userid), $usernamefields, MUST_EXIST);
}
$return->lastuserid = $lastpost->userid;
$return->lastuserfullname = fullname($arrusers[$lastpost->userid], $canviewfullname);
$return->lastuserimagealt = $arrusers[$lastpost->userid]->imagealt;
$return->lastuserpicture = $arrusers[$lastpost->userid]->picture;
$return->lastuseremail = $arrusers[$lastpost->userid]->email;
// Add the discussion statistics to the array to return.
$arrdiscussions[$return->id] = (array) $return;
}
}
}
return $arrdiscussions;
}
/**
* Adds module specific settings to the settings block
*
* @param settings_navigation $settings The settings navigation object
* @param navigation_node $anonforumnode The node to add module settings to
*/
function anonforum_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $anonforumnode)
{
global $USER, $PAGE, $CFG, $DB, $OUTPUT;
$anonforumobject = $DB->get_record("anonforum", array("id" => $PAGE->cm->instance));
if (empty($PAGE->cm->context)) {
$PAGE->cm->context = context_module::instance($PAGE->cm->instance);
}
// for some actions you need to be enrolled, beiing admin is not enough sometimes here
$enrolled = is_enrolled($PAGE->cm->context, $USER, '', false);
$activeenrolled = is_enrolled($PAGE->cm->context, $USER, '', true);
$canmanage = has_capability('mod/anonforum:managesubscriptions', $PAGE->cm->context);
$subscriptionmode = anonforum_get_forcesubscribed($anonforumobject);
$cansubscribe = $activeenrolled && $subscriptionmode != ANONFORUM_FORCESUBSCRIBE && ($subscriptionmode != ANONFORUM_DISALLOWSUBSCRIBE || $canmanage);
if ($canmanage) {
$mode = $anonforumnode->add(get_string('subscriptionmode', 'anonforum'), null, navigation_node::TYPE_CONTAINER);
$allowchoice = $mode->add(get_string('subscriptionoptional', 'anonforum'), new moodle_url('/mod/anonforum/subscribe.php', array('id' => $anonforumobject->id, 'mode' => ANONFORUM_CHOOSESUBSCRIBE, 'sesskey' => sesskey())), navigation_node::TYPE_SETTING);
$forceforever = $mode->add(get_string("subscriptionforced", "anonforum"), new moodle_url('/mod/anonforum/subscribe.php', array('id' => $anonforumobject->id, 'mode' => ANONFORUM_FORCESUBSCRIBE, 'sesskey' => sesskey())), navigation_node::TYPE_SETTING);
$forceinitially = $mode->add(get_string("subscriptionauto", "anonforum"), new moodle_url('/mod/anonforum/subscribe.php', array('id' => $anonforumobject->id, 'mode' => ANONFORUM_INITIALSUBSCRIBE, 'sesskey' => sesskey())), navigation_node::TYPE_SETTING);
$disallowchoice = $mode->add(get_string('subscriptiondisabled', 'anonforum'), new moodle_url('/mod/anonforum/subscribe.php', array('id' => $anonforumobject->id, 'mode' => ANONFORUM_DISALLOWSUBSCRIBE, 'sesskey' => sesskey())), navigation_node::TYPE_SETTING);
switch ($subscriptionmode) {
case ANONFORUM_CHOOSESUBSCRIBE:
// 0
$allowchoice->action = null;
$allowchoice->add_class('activesetting');
break;
case ANONFORUM_FORCESUBSCRIBE:
// 1
$forceforever->action = null;
$forceforever->add_class('activesetting');
break;
case ANONFORUM_INITIALSUBSCRIBE:
// 2
$forceinitially->action = null;
$forceinitially->add_class('activesetting');
break;
case ANONFORUM_DISALLOWSUBSCRIBE:
// 3
$disallowchoice->action = null;
$disallowchoice->add_class('activesetting');
break;
}
} else {
if ($activeenrolled) {
switch ($subscriptionmode) {
case ANONFORUM_CHOOSESUBSCRIBE:
// 0
$notenode = $anonforumnode->add(get_string('subscriptionoptional', 'anonforum'));
break;
case ANONFORUM_FORCESUBSCRIBE:
// 1
$notenode = $anonforumnode->add(get_string('subscriptionforced', 'anonforum'));
break;
case ANONFORUM_INITIALSUBSCRIBE:
// 2
$notenode = $anonforumnode->add(get_string('subscriptionauto', 'anonforum'));
break;
case ANONFORUM_DISALLOWSUBSCRIBE:
// 3
$notenode = $anonforumnode->add(get_string('subscriptiondisabled', 'anonforum'));
break;
}
}
}
if ($cansubscribe) {
if (anonforum_is_subscribed($USER->id, $anonforumobject)) {
$linktext = get_string('unsubscribe', 'anonforum');
} else {
$linktext = get_string('subscribe', 'anonforum');
}
$url = new moodle_url('/mod/anonforum/subscribe.php', array('id' => $anonforumobject->id, 'sesskey' => sesskey()));
$anonforumnode->add($linktext, $url, navigation_node::TYPE_SETTING);
}
if (has_capability('mod/anonforum:viewsubscribers', $PAGE->cm->context)) {
$url = new moodle_url('/mod/anonforum/subscribers.php', array('id' => $anonforumobject->id));
$anonforumnode->add(get_string('showsubscribers', 'anonforum'), $url, navigation_node::TYPE_SETTING);
}
if ($enrolled && anonforum_tp_can_track_anonforums($anonforumobject)) {
// keep tracking info for users with suspended enrolments
if ($anonforumobject->trackingtype == ANONFORUM_TRACKING_OPTIONAL || !$CFG->anonforum_allowforcedreadtracking && $anonforumobject->trackingtype == ANONFORUM_TRACKING_FORCED) {
if (anonforum_tp_is_tracked($anonforumobject)) {
$linktext = get_string('notrackanonforum', 'anonforum');
} else {
$linktext = get_string('trackanonforum', 'anonforum');
}
$url = new moodle_url('/mod/anonforum/settracking.php', array('id' => $anonforumobject->id));
$anonforumnode->add($linktext, $url, navigation_node::TYPE_SETTING);
}
}
if (!isloggedin() && $PAGE->course->id == SITEID) {
$userid = guest_user()->id;
} else {
$userid = $USER->id;
}
$hascourseaccess = $PAGE->course->id == SITEID || can_access_course($PAGE->course, $userid);
$enablerssfeeds = !empty($CFG->enablerssfeeds) && !empty($CFG->anonforum_enablerssfeeds);
if ($enablerssfeeds && $anonforumobject->rsstype && $anonforumobject->rssarticles && $hascourseaccess) {
if (!function_exists('rss_get_url')) {
require_once "{$CFG->libdir}/rsslib.php";
}
if ($anonforumobject->rsstype == 1) {
$string = get_string('rsssubscriberssdiscussions', 'anonforum');
} else {
$string = get_string('rsssubscriberssposts', 'anonforum');
}
$url = new moodle_url(rss_get_url($PAGE->cm->context->id, $userid, "mod_anonforum", $anonforumobject->id));
$anonforumnode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
}
}
if (!($course = $DB->get_record("course", array("id" => $anonforum->course)))) {
print_error('invalidcoursemodule');
}
if (!($cm = get_coursemodule_from_instance("anonforum", $anonforum->id, $course->id))) {
print_error('invalidcoursemodule');
}
require_course_login($course, false, $cm);
$returnto = anonforum_go_back_to($returnpage . '?id=' . $course->id . '&f=' . $anonforum->id);
if (!anonforum_tp_can_track_anonforums($anonforum)) {
redirect($returnto);
}
$info = new stdClass();
$info->name = fullname($USER);
$info->anonforum = format_string($anonforum->name);
$eventparams = array('context' => context_module::instance($cm->id), 'relateduserid' => $USER->id, 'anonymous' => 1, 'other' => array('anonforumid' => $anonforum->id));
if (anonforum_tp_is_tracked($anonforum)) {
if (anonforum_tp_stop_tracking($anonforum->id)) {
if (empty($anonforum->anonymous)) {
$event = \mod_anonforum\event\readtracking_disabled::create($eventparams);
$event->trigger();
}
redirect($returnto, get_string("nownottracking", "anonforum", $info), 1);
} else {
print_error('cannottrack', '', $_SERVER["HTTP_REFERER"]);
}
} else {
// subscribe
if (anonforum_tp_start_tracking($anonforum->id)) {
if (empty($anonforum->anonymous)) {
$event = \mod_anonforum\event\readtracking_enabled::create($eventparams);
$event->trigger();
if ($parent) {
// If flat AND parent, then force nested display this time
if ($displaymode == ANONFORUM_MODE_FLATOLDEST or $displaymode == ANONFORUM_MODE_FLATNEWEST) {
$displaymode = ANONFORUM_MODE_NESTED;
}
} else {
$parent = $discussion->firstpost;
}
if (!($post = anonforum_get_post_full($parent))) {
print_error("notexists", 'anonforum', "{$CFG->wwwroot}/mod/anonforum/view.php?f={$anonforum->id}");
}
if (!anonforum_user_can_see_post($anonforum, $discussion, $post, null, $cm)) {
print_error('noviewdiscussionspermission', 'anonforum', "{$CFG->wwwroot}/mod/anonforum/view.php?id={$anonforum->id}");
}
if ($mark == 'read' or $mark == 'unread') {
if ($CFG->anonforum_usermarksread && anonforum_tp_can_track_anonforums($anonforum) && anonforum_tp_is_tracked($anonforum)) {
if ($mark == 'read') {
anonforum_tp_add_read_record($USER->id, $postid);
} else {
// unread
anonforum_tp_delete_read_records($USER->id, $postid);
}
}
}
$searchform = anonforum_search_form($course);
$anonforumnode = $PAGE->navigation->find($cm->id, navigation_node::TYPE_ACTIVITY);
if (empty($anonforumnode)) {
$anonforumnode = $PAGE->navbar;
} else {
$anonforumnode->make_active();
}
