Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * @package mod
- * @subpackage forum
- * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- /** Include required files */
- require_once($CFG->libdir.'/filelib.php');
- require_once($CFG->libdir.'/eventslib.php');
- require_once($CFG->dirroot.'/user/selector/lib.php');
- require_once($CFG->dirroot.'/mod/forum/post_form.php');
- /// CONSTANTS ///////////////////////////////////////////////////////////
- define('FORUM_MODE_FLATOLDEST', 1);
- define('FORUM_MODE_FLATNEWEST', -1);
- define('FORUM_MODE_THREADED', 2);
- define('FORUM_MODE_NESTED', 3);
- define('FORUM_CHOOSESUBSCRIBE', 0);
- define('FORUM_FORCESUBSCRIBE', 1);
- define('FORUM_INITIALSUBSCRIBE', 2);
- define('FORUM_DISALLOWSUBSCRIBE',3);
- define('FORUM_TRACKING_OFF', 0);
- define('FORUM_TRACKING_OPTIONAL', 1);
- define('FORUM_TRACKING_ON', 2);
- define('FORUM_MAILED_PENDING', 0);
- define('FORUM_MAILED_SUCCESS', 1);
- define('FORUM_MAILED_ERROR', 2);
- if (!defined('FORUM_CRON_USER_CACHE')) {
- /** Defines how many full user records are cached in forum cron. */
- define('FORUM_CRON_USER_CACHE', 5000);
- }
- /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
- /**
- * Given an object containing all the necessary data,
- * (defined by the form in mod_form.php) this function
- * will create a new instance and return the id number
- * of the new instance.
- *
- * @param stdClass $forum add forum instance
- * @param mod_forum_mod_form $mform
- * @return int intance id
- */
- function forum_add_instance($forum, $mform = null) {
- global $CFG, $DB;
- $forum->timemodified = time();
- if (empty($forum->assessed)) {
- $forum->assessed = 0;
- }
- if (empty($forum->ratingtime) or empty($forum->assessed)) {
- $forum->assesstimestart = 0;
- $forum->assesstimefinish = 0;
- }
- $forum->id = $DB->insert_record('forum', $forum);
- $modcontext = context_module::instance($forum->coursemodule);
- if ($forum->type == 'single') { // Create related discussion.
- $discussion = new stdClass();
- $discussion->course = $forum->course;
- $discussion->forum = $forum->id;
- $discussion->name = $forum->name;
- $discussion->assessed = $forum->assessed;
- $discussion->message = $forum->intro;
- $discussion->messageformat = $forum->introformat;
- $discussion->messagetrust = trusttext_trusted(context_course::instance($forum->course));
- $discussion->mailnow = false;
- $discussion->groupid = -1;
- $message = '';
- $discussion->id = forum_add_discussion($discussion, null, $message);
- if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
- // Ugly hack - we need to copy the files somehow.
- $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
- $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
- $options = array('subdirs'=>true); // Use the same options as intro field!
- $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
- $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
- }
- }
- if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
- $users = forum_get_potential_subscribers($modcontext, 0, 'u.id, u.email');
- foreach ($users as $user) {
- forum_subscribe($user->id, $forum->id);
- }
- }
- forum_grade_item_update($forum);
- return $forum->id;
- }
- /**
- * Given an object containing all the necessary data,
- * (defined by the form in mod_form.php) this function
- * will update an existing instance with new data.
- *
- * @global object
- * @param object $forum forum instance (with magic quotes)
- * @return bool success
- */
- function forum_update_instance($forum, $mform) {
- global $DB, $OUTPUT, $USER;
- $forum->timemodified = time();
- $forum->id = $forum->instance;
- if (empty($forum->assessed)) {
- $forum->assessed = 0;
- }
- if (empty($forum->ratingtime) or empty($forum->assessed)) {
- $forum->assesstimestart = 0;
- $forum->assesstimefinish = 0;
- }
- $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
- // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
- // if scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
- // for count and sum aggregation types the grade we check to make sure they do not exceed the scale (i.e. max score) when calculating the grade
- if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
- forum_update_grades($forum); // recalculate grades for the forum
- }
- if ($forum->type == 'single') { // Update related discussion and post.
- $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
- if (!empty($discussions)) {
- if (count($discussions) > 1) {
- echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
- }
- $discussion = array_pop($discussions);
- } else {
- // try to recover by creating initial discussion - MDL-16262
- $discussion = new stdClass();
- $discussion->course = $forum->course;
- $discussion->forum = $forum->id;
- $discussion->name = $forum->name;
- $discussion->assessed = $forum->assessed;
- $discussion->message = $forum->intro;
- $discussion->messageformat = $forum->introformat;
- $discussion->messagetrust = true;
- $discussion->mailnow = false;
- $discussion->groupid = -1;
- $message = '';
- forum_add_discussion($discussion, null, $message);
- if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
- print_error('cannotadd', 'forum');
- }
- }
- if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
- print_error('cannotfindfirstpost', 'forum');
- }
- $cm = get_coursemodule_from_instance('forum', $forum->id);
- $modcontext = context_module::instance($cm->id, MUST_EXIST);
- $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
- $post->subject = $forum->name;
- $post->message = $forum->intro;
- $post->messageformat = $forum->introformat;
- $post->messagetrust = trusttext_trusted($modcontext);
- $post->modified = $forum->timemodified;
- $post->userid = $USER->id; // MDL-18599, so that current teacher can take ownership of activities.
- if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
- // Ugly hack - we need to copy the files somehow.
- $options = array('subdirs'=>true); // Use the same options as intro field!
- $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
- }
- $DB->update_record('forum_posts', $post);
- $discussion->name = $forum->name;
- $DB->update_record('forum_discussions', $discussion);
- }
- $DB->update_record('forum', $forum);
- $modcontext = context_module::instance($forum->coursemodule);
- if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
- $users = forum_get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
- foreach ($users as $user) {
- forum_subscribe($user->id, $forum->id);
- }
- }
- forum_grade_item_update($forum);
- return true;
- }
- /**
- * Given an ID of an instance of this module,
- * this function will permanently delete the instance
- * and any data that depends on it.
- *
- * @global object
- * @param int $id forum instance id
- * @return bool success
- */
- function forum_delete_instance($id) {
- global $DB;
- if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
- return false;
- }
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
- return false;
- }
- if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
- return false;
- }
- $context = context_module::instance($cm->id);
- // now get rid of all files
- $fs = get_file_storage();
- $fs->delete_area_files($context->id);
- $result = true;
- if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
- foreach ($discussions as $discussion) {
- if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
- $result = false;
- }
- }
- }
- if (!$DB->delete_records('forum_subscriptions', array('forum'=>$forum->id))) {
- $result = false;
- }
- forum_tp_delete_read_records(-1, -1, -1, $forum->id);
- if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
- $result = false;
- }
- forum_grade_item_delete($forum);
- return $result;
- }
- /**
- * Indicates API features that the forum supports.
- *
- * @uses FEATURE_GROUPS
- * @uses FEATURE_GROUPINGS
- * @uses FEATURE_GROUPMEMBERSONLY
- * @uses FEATURE_MOD_INTRO
- * @uses FEATURE_COMPLETION_TRACKS_VIEWS
- * @uses FEATURE_COMPLETION_HAS_RULES
- * @uses FEATURE_GRADE_HAS_GRADE
- * @uses FEATURE_GRADE_OUTCOMES
- * @param string $feature
- * @return mixed True if yes (some features may use other values)
- */
- function forum_supports($feature) {
- switch($feature) {
- case FEATURE_GROUPS: return true;
- case FEATURE_GROUPINGS: return true;
- case FEATURE_GROUPMEMBERSONLY: return true;
- case FEATURE_MOD_INTRO: return true;
- case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
- case FEATURE_COMPLETION_HAS_RULES: return true;
- case FEATURE_GRADE_HAS_GRADE: return true;
- case FEATURE_GRADE_OUTCOMES: return true;
- case FEATURE_RATE: return true;
- case FEATURE_BACKUP_MOODLE2: return true;
- case FEATURE_SHOW_DESCRIPTION: return true;
- case FEATURE_PLAGIARISM: return true;
- default: return null;
- }
- }
- /**
- * Obtains the automatic completion state for this forum based on any conditions
- * in forum settings.
- *
- * @global object
- * @global object
- * @param object $course Course
- * @param object $cm Course-module
- * @param int $userid User ID
- * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
- * @return bool True if completed, false if not. (If no conditions, then return
- * value depends on comparison type)
- */
- function forum_get_completion_state($course,$cm,$userid,$type) {
- global $CFG,$DB;
- // Get forum details
- if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
- throw new Exception("Can't find forum {$cm->instance}");
- }
- $result=$type; // Default return value
- $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
- $postcountsql="
- SELECT
- COUNT(1)
- FROM
- {forum_posts} fp
- INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
- WHERE
- fp.userid=:userid AND fd.forum=:forumid";
- if ($forum->completiondiscussions) {
- $value = $forum->completiondiscussions <=
- $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
- if ($type == COMPLETION_AND) {
- $result = $result && $value;
- } else {
- $result = $result || $value;
- }
- }
- if ($forum->completionreplies) {
- $value = $forum->completionreplies <=
- $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
- if ($type==COMPLETION_AND) {
- $result = $result && $value;
- } else {
- $result = $result || $value;
- }
- }
- if ($forum->completionposts) {
- $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
- if ($type == COMPLETION_AND) {
- $result = $result && $value;
- } else {
- $result = $result || $value;
- }
- }
- return $result;
- }
- /**
- * Create a message-id string to use in the custom headers of forum notification emails
- *
- * message-id is used by email clients to identify emails and to nest conversations
- *
- * @param int $postid The ID of the forum post we are notifying the user about
- * @param int $usertoid The ID of the user being notified
- * @param string $hostname The server's hostname
- * @return string A unique message-id
- */
- function forum_get_email_message_id($postid, $usertoid, $hostname) {
- return '<'.hash('sha256',$postid.'to'.$usertoid).'@'.$hostname.'>';
- }
- /**
- * Removes properties from user record that are not necessary
- * for sending post notifications.
- * @param stdClass $user
- * @return void, $user parameter is modified
- */
- function forum_cron_minimise_user_record(stdClass $user) {
- // We store large amount of users in one huge array,
- // make sure we do not store info there we do not actually need
- // in mail generation code or messaging.
- unset($user->institution);
- unset($user->department);
- unset($user->address);
- unset($user->city);
- unset($user->url);
- unset($user->currentlogin);
- unset($user->description);
- unset($user->descriptionformat);
- }
- /**
- * Function to be run periodically according to the moodle cron
- * Finds all posts that have yet to be mailed out, and mails them
- * out to all subscribers
- *
- * @global object
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @uses CONTEXT_COURSE
- * @uses SITEID
- * @uses FORMAT_PLAIN
- * @return void
- */
- function forum_cron() {
- global $CFG, $USER, $DB;
- $site = get_site();
- // All users that are subscribed to any post that needs sending,
- // please increase $CFG->extramemorylimit on large sites that
- // send notifications to a large number of users.
- $users = array();
- $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
- // status arrays
- $mailcount = array();
- $errorcount = array();
- // caches
- $discussions = array();
- $forums = array();
- $courses = array();
- $coursemodules = array();
- $subscribedusers = array();
- // Posts older than 2 days will not be mailed. This is to avoid the problem where
- // cron has not been running for a long time, and then suddenly people are flooded
- // with mail from the past few weeks or months
- $timenow = time();
- $endtime = $timenow - $CFG->maxeditingtime;
- $starttime = $endtime - 48 * 3600; // Two days earlier
- if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
- // Mark them all now as being mailed. It's unlikely but possible there
- // might be an error later so that a post is NOT actually mailed out,
- // but since mail isn't crucial, we can accept this risk. Doing it now
- // prevents the risk of duplicated mails, which is a worse problem.
- if (!forum_mark_old_posts_as_mailed($endtime)) {
- mtrace('Errors occurred while trying to mark some posts as being mailed.');
- return false; // Don't continue trying to mail them, in case we are in a cron loop
- }
- // checking post validity, and adding users to loop through later
- foreach ($posts as $pid => $post) {
- $discussionid = $post->discussion;
- if (!isset($discussions[$discussionid])) {
- if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
- $discussions[$discussionid] = $discussion;
- } else {
- mtrace('Could not find discussion '.$discussionid);
- unset($posts[$pid]);
- continue;
- }
- }
- $forumid = $discussions[$discussionid]->forum;
- if (!isset($forums[$forumid])) {
- if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
- $forums[$forumid] = $forum;
- } else {
- mtrace('Could not find forum '.$forumid);
- unset($posts[$pid]);
- continue;
- }
- }
- $courseid = $forums[$forumid]->course;
- if (!isset($courses[$courseid])) {
- if ($course = $DB->get_record('course', array('id' => $courseid))) {
- $courses[$courseid] = $course;
- } else {
- mtrace('Could not find course '.$courseid);
- unset($posts[$pid]);
- continue;
- }
- }
- if (!isset($coursemodules[$forumid])) {
- if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
- $coursemodules[$forumid] = $cm;
- } else {
- mtrace('Could not find course module for forum '.$forumid);
- unset($posts[$pid]);
- continue;
- }
- }
- // caching subscribed users of each forum
- if (!isset($subscribedusers[$forumid])) {
- $modcontext = context_module::instance($coursemodules[$forumid]->id);
- if ($subusers = forum_subscribed_users($courses[$courseid], $forums[$forumid], 0, $modcontext, "u.*")) {
- foreach ($subusers as $postuser) {
- // this user is subscribed to this forum
- $subscribedusers[$forumid][$postuser->id] = $postuser->id;
- $userscount++;
- if ($userscount > FORUM_CRON_USER_CACHE) {
- // Store minimal user info.
- $minuser = new stdClass();
- $minuser->id = $postuser->id;
- $users[$postuser->id] = $minuser;
- } else {
- // Cache full user record.
- forum_cron_minimise_user_record($postuser);
- $users[$postuser->id] = $postuser;
- }
- }
- // Release memory.
- unset($subusers);
- unset($postuser);
- }
- }
- $mailcount[$pid] = 0;
- $errorcount[$pid] = 0;
- }
- }
- if ($users && $posts) {
- $urlinfo = parse_url($CFG->wwwroot);
- $hostname = $urlinfo['host'];
- foreach ($users as $userto) {
- @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
- mtrace('Processing user '.$userto->id);
- // Init user caches - we keep the cache for one cycle only,
- // otherwise it could consume too much memory.
- if (isset($userto->username)) {
- $userto = clone($userto);
- } else {
- $userto = $DB->get_record('user', array('id' => $userto->id));
- forum_cron_minimise_user_record($userto);
- }
- $userto->viewfullnames = array();
- $userto->canpost = array();
- $userto->markposts = array();
- // set this so that the capabilities are cached, and environment matches receiving user
- cron_setup_user($userto);
- // reset the caches
- foreach ($coursemodules as $forumid=>$unused) {
- $coursemodules[$forumid]->cache = new stdClass();
- $coursemodules[$forumid]->cache->caps = array();
- unset($coursemodules[$forumid]->uservisible);
- }
- foreach ($posts as $pid => $post) {
- // Set up the environment for the post, discussion, forum, course
- $discussion = $discussions[$post->discussion];
- $forum = $forums[$discussion->forum];
- $course = $courses[$forum->course];
- $cm =& $coursemodules[$forum->id];
- // Do some checks to see if we can bail out now
- // Only active enrolled users are in the list of subscribers
- if (!isset($subscribedusers[$forum->id][$userto->id])) {
- continue; // user does not subscribe to this forum
- }
- // Don't send email if the forum is Q&A and the user has not posted
- // Initial topics are still mailed
- if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
- mtrace('Did not email '.$userto->id.' because user has not posted in discussion');
- continue;
- }
- // Get info about the sending user
- if (array_key_exists($post->userid, $users)) { // we might know him/her already
- $userfrom = $users[$post->userid];
- if (!isset($userfrom->idnumber)) {
- // Minimalised user info, fetch full record.
- $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
- forum_cron_minimise_user_record($userfrom);
- }
- } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
- forum_cron_minimise_user_record($userfrom);
- // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
- if ($userscount <= FORUM_CRON_USER_CACHE) {
- $userscount++;
- $users[$userfrom->id] = $userfrom;
- }
- } else {
- mtrace('Could not find user '.$post->userid);
- continue;
- }
- //if we want to check that userto and userfrom are not the same person this is probably the spot to do it
- // setup global $COURSE properly - needed for roles and languages
- cron_setup_user($userto, $course);
- // Fill caches
- if (!isset($userto->viewfullnames[$forum->id])) {
- $modcontext = context_module::instance($cm->id);
- $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
- }
- if (!isset($userto->canpost[$discussion->id])) {
- $modcontext = context_module::instance($cm->id);
- $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
- }
- if (!isset($userfrom->groups[$forum->id])) {
- if (!isset($userfrom->groups)) {
- $userfrom->groups = array();
- if (isset($users[$userfrom->id])) {
- $users[$userfrom->id]->groups = array();
- }
- }
- $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
- if (isset($users[$userfrom->id])) {
- $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
- }
- }
- // Make sure groups allow this user to see this email
- if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) { // Groups are being used
- if (!groups_group_exists($discussion->groupid)) { // Can't find group
- continue; // Be safe and don't send it to anyone
- }
- if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
- // do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
- continue;
- }
- }
- // Make sure we're allowed to see it...
- if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
- mtrace('user '.$userto->id. ' can not see '.$post->id);
- continue;
- }
- // OK so we need to send the email.
- // Does the user want this post in a digest? If so postpone it for now.
- if ($userto->maildigest > 0) {
- // This user wants the mails to be in digest form
- $queue = new stdClass();
- $queue->userid = $userto->id;
- $queue->discussionid = $discussion->id;
- $queue->postid = $post->id;
- $queue->timemodified = $post->created;
- $DB->insert_record('forum_queue', $queue);
- continue;
- }
- // Prepare to actually send the post now, and build up the content
- $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
- $userfrom->customheaders = array ( // Headers to make emails easier to track
- 'Precedence: Bulk',
- 'List-Id: "'.$cleanforumname.'" <moodleforum'.$forum->id.'@'.$hostname.'>',
- 'List-Help: '.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id,
- 'Message-ID: '.forum_get_email_message_id($post->id, $userto->id, $hostname),
- 'X-Course-Id: '.$course->id,
- 'X-Course-Name: '.format_string($course->fullname, true)
- );
- if ($post->parent) { // This post is a reply, so add headers for threading (see MDL-22551)
- $userfrom->customheaders[] = 'In-Reply-To: '.forum_get_email_message_id($post->parent, $userto->id, $hostname);
- $userfrom->customheaders[] = 'References: '.forum_get_email_message_id($post->parent, $userto->id, $hostname);
- }
- $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
- $postsubject = html_to_text("$shortname: ".format_string($post->subject, true));
- $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
- $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
- // Send the post now!
- mtrace('Sending ', '');
- $eventdata = new stdClass();
- $eventdata->component = 'mod_forum';
- $eventdata->name = 'posts';
- $eventdata->userfrom = $userfrom;
- $eventdata->userto = $userto;
- $eventdata->subject = $postsubject;
- $eventdata->fullmessage = $posttext;
- $eventdata->fullmessageformat = FORMAT_PLAIN;
- $eventdata->fullmessagehtml = $posthtml;
- $eventdata->notification = 1;
- // If forum_replytouser is not set then send mail using the noreplyaddress.
- if (empty($CFG->forum_replytouser)) {
- // Clone userfrom as it is referenced by $users.
- $cloneduserfrom = clone($userfrom);
- $cloneduserfrom->email = $CFG->noreplyaddress;
- $eventdata->userfrom = $cloneduserfrom;
- }
- $smallmessagestrings = new stdClass();
- $smallmessagestrings->user = fullname($userfrom);
- $smallmessagestrings->forumname = "$shortname: ".format_string($forum->name,true).": ".$discussion->name;
- $smallmessagestrings->message = $post->message;
- //make sure strings are in message recipients language
- $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
- $eventdata->contexturl = "{$CFG->wwwroot}/mod/forum/discuss.php?d={$discussion->id}#p{$post->id}";
- $eventdata->contexturlname = $discussion->name;
- $mailresult = message_send($eventdata);
- if (!$mailresult){
- mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
- " ($userto->email) .. not trying again.");
- add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#p$post->id",
- substr(format_string($post->subject,true),0,30), $cm->id, $userto->id);
- $errorcount[$post->id]++;
- } else {
- $mailcount[$post->id]++;
- // Mark post as read if forum_usermarksread is set off
- if (!$CFG->forum_usermarksread) {
- $userto->markposts[$post->id] = $post->id;
- }
- }
- mtrace('post '.$post->id. ': '.$post->subject);
- }
- // mark processed posts as read
- forum_tp_mark_posts_read($userto, $userto->markposts);
- unset($userto);
- }
- }
- if ($posts) {
- foreach ($posts as $post) {
- mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
- if ($errorcount[$post->id]) {
- $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
- }
- }
- }
- // release some memory
- unset($subscribedusers);
- unset($mailcount);
- unset($errorcount);
- cron_setup_user();
- $sitetimezone = $CFG->timezone;
- // Now see if there are any digest mails waiting to be sent, and if we should send them
- mtrace('Starting digest processing...');
- @set_time_limit(300); // terminate if not able to fetch all digests in 5 minutes
- if (!isset($CFG->digestmailtimelast)) { // To catch the first time
- set_config('digestmailtimelast', 0);
- }
- $timenow = time();
- $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
- // Delete any really old ones (normally there shouldn't be any)
- $weekago = $timenow - (7 * 24 * 3600);
- $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
- mtrace ('Cleaned old digest records');
- if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
- mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
- $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
- if ($digestposts_rs->valid()) {
- // We have work to do
- $usermailcount = 0;
- //caches - reuse the those filled before too
- $discussionposts = array();
- $userdiscussions = array();
- foreach ($digestposts_rs as $digestpost) {
- if (!isset($posts[$digestpost->postid])) {
- if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
- $posts[$digestpost->postid] = $post;
- } else {
- continue;
- }
- }
- $discussionid = $digestpost->discussionid;
- if (!isset($discussions[$discussionid])) {
- if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
- $discussions[$discussionid] = $discussion;
- } else {
- continue;
- }
- }
- $forumid = $discussions[$discussionid]->forum;
- if (!isset($forums[$forumid])) {
- if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
- $forums[$forumid] = $forum;
- } else {
- continue;
- }
- }
- $courseid = $forums[$forumid]->course;
- if (!isset($courses[$courseid])) {
- if ($course = $DB->get_record('course', array('id' => $courseid))) {
- $courses[$courseid] = $course;
- } else {
- continue;
- }
- }
- if (!isset($coursemodules[$forumid])) {
- if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
- $coursemodules[$forumid] = $cm;
- } else {
- continue;
- }
- }
- $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
- $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
- }
- $digestposts_rs->close(); /// Finished iteration, let's close the resultset
- // Data collected, start sending out emails to each user
- foreach ($userdiscussions as $userid => $thesediscussions) {
- @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
- cron_setup_user();
- mtrace(get_string('processingdigest', 'forum', $userid), '... ');
- // First of all delete all the queue entries for this user
- $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
- // Init user caches - we keep the cache for one cycle only,
- // otherwise it would unnecessarily consume memory.
- if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
- $userto = clone($users[$userid]);
- } else {
- $userto = $DB->get_record('user', array('id' => $userid));
- forum_cron_minimise_user_record($userto);
- }
- $userto->viewfullnames = array();
- $userto->canpost = array();
- $userto->markposts = array();
- // Override the language and timezone of the "current" user, so that
- // mail is customised for the receiver.
- cron_setup_user($userto);
- $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
- $headerdata = new stdClass();
- $headerdata->sitename = format_string($site->fullname, true);
- $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&course='.$site->id;
- $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
- $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
- $posthtml = "<head>";
- /* foreach ($CFG->stylesheets as $stylesheet) {
- //TODO: MDL-21120
- $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
- }*/
- $posthtml .= "</head>\n<body id=\"email\">\n";
- $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
- foreach ($thesediscussions as $discussionid) {
- @set_time_limit(120); // to be reset for each post
- $discussion = $discussions[$discussionid];
- $forum = $forums[$discussion->forum];
- $course = $courses[$forum->course];
- $cm = $coursemodules[$forum->id];
- //override language
- cron_setup_user($userto, $course);
- // Fill caches
- if (!isset($userto->viewfullnames[$forum->id])) {
- $modcontext = context_module::instance($cm->id);
- $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
- }
- if (!isset($userto->canpost[$discussion->id])) {
- $modcontext = context_module::instance($cm->id);
- $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
- }
- $strforums = get_string('forums', 'forum');
- $canunsubscribe = ! forum_is_forcesubscribed($forum);
- $canreply = $userto->canpost[$discussion->id];
- $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
- $posttext .= "\n \n";
- $posttext .= '=====================================================================';
- $posttext .= "\n \n";
- $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
- if ($discussion->name != $forum->name) {
- $posttext .= " -> ".format_string($discussion->name,true);
- }
- $posttext .= "\n";
- $posthtml .= "<p><font face=\"sans-serif\">".
- "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
- "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
- "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
- if ($discussion->name == $forum->name) {
- $posthtml .= "</font></p>";
- } else {
- $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
- }
- $posthtml .= '<p>';
- $postsarray = $discussionposts[$discussionid];
- sort($postsarray);
- foreach ($postsarray as $postid) {
- $post = $posts[$postid];
- if (array_key_exists($post->userid, $users)) { // we might know him/her already
- $userfrom = $users[$post->userid];
- if (!isset($userfrom->idnumber)) {
- $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
- forum_cron_minimise_user_record($userfrom);
- }
- } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
- forum_cron_minimise_user_record($userfrom);
- if ($userscount <= FORUM_CRON_USER_CACHE) {
- $userscount++;
- $users[$userfrom->id] = $userfrom;
- }
- } else {
- mtrace('Could not find user '.$post->userid);
- continue;
- }
- if (!isset($userfrom->groups[$forum->id])) {
- if (!isset($userfrom->groups)) {
- $userfrom->groups = array();
- if (isset($users[$userfrom->id])) {
- $users[$userfrom->id]->groups = array();
- }
- }
- $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
- if (isset($users[$userfrom->id])) {
- $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
- }
- }
- $userfrom->customheaders = array ("Precedence: Bulk");
- if ($userto->maildigest == 2) {
- // Subjects only
- $by = new stdClass();
- $by->name = fullname($userfrom);
- $by->date = userdate($post->modified);
- $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
- $posttext .= "\n---------------------------------------------------------------------";
- $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&course=$course->id\">$by->name</a>";
- $posthtml .= '<div><a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'#p'.$post->id.'">'.format_string($post->subject,true).'</a> '.get_string("bynameondate", "forum", $by).'</div>';
- } else {
- // The full treatment
- $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
- $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
- // Create an array of postid's for this user to mark as read.
- if (!$CFG->forum_usermarksread) {
- $userto->markposts[$post->id] = $post->id;
- }
- }
- }
- if ($canunsubscribe) {
- $posthtml .= "\n<div class='mdl-right'><font size=\"1\"><a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">".get_string("unsubscribe", "forum")."</a></font></div>";
- } else {
- $posthtml .= "\n<div class='mdl-right'><font size=\"1\">".get_string("everyoneissubscribed", "forum")."</font></div>";
- }
- $posthtml .= '<hr size="1" noshade="noshade" /></p>';
- }
- $posthtml .= '</body>';
- if (empty($userto->mailformat) || $userto->mailformat != 1) {
- // This user DOESN'T want to receive HTML
- $posthtml = '';
- }
- $attachment = $attachname='';
- // Directly email forum digests rather than sending them via messaging, use the
- // site shortname as 'from name', the noreply address will be used by email_to_user.
- $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname);
- if (!$mailresult) {
- mtrace("ERROR!");
- echo "Error: mod/forum/cron.php: Could not send out digest mail to user $userto->id ($userto->email)... not trying again.\n";
- add_to_log($course->id, 'forum', 'mail digest error', '', '', $cm->id, $userto->id);
- } else {
- mtrace("success.");
- $usermailcount++;
- // Mark post as read if forum_usermarksread is set off
- forum_tp_mark_posts_read($userto, $userto->markposts);
- }
- }
- }
- /// We have finishied all digest emails, update $CFG->digestmailtimelast
- set_config('digestmailtimelast', $timenow);
- }
- cron_setup_user();
- if (!empty($usermailcount)) {
- mtrace(get_string('digestsentusers', 'forum', $usermailcount));
- }
- if (!empty($CFG->forum_lastreadclean)) {
- $timenow = time();
- if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
- set_config('forum_lastreadclean', $timenow);
- mtrace('Removing old forum read tracking info...');
- forum_tp_clean_read_records();
- }
- } else {
- set_config('forum_lastreadclean', time());
- }
- return true;
- }
- /**
- * Builds and returns the body of the email notification in plain text.
- *
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @param object $course
- * @param object $cm
- * @param object $forum
- * @param object $discussion
- * @param object $post
- * @param object $userfrom
- * @param object $userto
- * @param boolean $bare
- * @return string The email body in plain text format.
- */
- function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
- global $CFG, $USER;
- $modcontext = context_module::instance($cm->id);
- if (!isset($userto->viewfullnames[$forum->id])) {
- $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
- } else {
- $viewfullnames = $userto->viewfullnames[$forum->id];
- }
- if (!isset($userto->canpost[$discussion->id])) {
- $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
- } else {
- $canreply = $userto->canpost[$discussion->id];
- }
- $by = New stdClass;
- $by->name = fullname($userfrom, $viewfullnames);
- $by->date = userdate($post->modified, "", $userto->timezone);
- $strbynameondate = get_string('bynameondate', 'forum', $by);
- $strforums = get_string('forums', 'forum');
- $canunsubscribe = ! forum_is_forcesubscribed($forum);
- $posttext = '';
- if (!$bare) {
- $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
- $posttext = "$shortname -> $strforums -> ".format_string($forum->name,true);
- if ($discussion->name != $forum->name) {
- $posttext .= " -> ".format_string($discussion->name,true);
- }
- }
- // add absolute file links
- $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
- $posttext .= "\n---------------------------------------------------------------------\n";
- $posttext .= format_string($post->subject,true);
- if ($bare) {
- $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
- }
- $posttext .= "\n".$strbynameondate."\n";
- $posttext .= "---------------------------------------------------------------------\n";
- $posttext .= format_text_email($post->message, $post->messageformat);
- $posttext .= "\n\n";
- $posttext .= forum_print_attachments($post, $cm, "text");
- if (!$bare && $canreply) {
- $posttext .= "---------------------------------------------------------------------\n";
- $posttext .= get_string("postmailinfo", "forum", $shortname)."\n";
- $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
- }
- if (!$bare && $canunsubscribe) {
- $posttext .= "\n---------------------------------------------------------------------\n";
- $posttext .= get_string("unsubscribe", "forum");
- $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
- }
- return $posttext;
- }
- /**
- * Builds and returns the body of the email notification in html format.
- *
- * @global object
- * @param object $course
- * @param object $cm
- * @param object $forum
- * @param object $discussion
- * @param object $post
- * @param object $userfrom
- * @param object $userto
- * @return string The email text in HTML format
- */
- function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto) {
- global $CFG;
- if ($userto->mailformat != 1) { // Needs to be HTML
- return '';
- }
- if (!isset($userto->canpost[$discussion->id])) {
- $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course);
- } else {
- $canreply = $userto->canpost[$discussion->id];
- }
- $strforums = get_string('forums', 'forum');
- $canunsubscribe = ! forum_is_forcesubscribed($forum);
- $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
- $posthtml = '<head>';
- /* foreach ($CFG->stylesheets as $stylesheet) {
- //TODO: MDL-21120
- $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
- }*/
- $posthtml .= '</head>';
- $posthtml .= "\n<body id=\"email\">\n\n";
- $posthtml .= '<div class="navbar">'.
- '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$shortname.'</a> » '.
- '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> » '.
- '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
- if ($discussion->name == $forum->name) {
- $posthtml .= '</div>';
- } else {
- $posthtml .= ' » <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
- format_string($discussion->name,true).'</a></div>';
- }
- $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
- if ($canunsubscribe) {
- $posthtml .= '<hr /><div class="mdl-align unsubscribelink">
- <a href="'.$CFG->wwwroot.'/mod/forum/subscribe.php?id='.$forum->id.'">'.get_string('unsubscribe', 'forum').'</a>
- <a href="'.$CFG->wwwroot.'/mod/forum/unsubscribeall.php">'.get_string('unsubscribeall', 'forum').'</a></div>';
- }
- $posthtml .= '</body>';
- return $posthtml;
- }
- /**
- *
- * @param object $course
- * @param object $user
- * @param object $mod TODO this is not used in this function, refactor
- * @param object $forum
- * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
- */
- function forum_user_outline($course, $user, $mod, $forum) {
- global $CFG;
- require_once("$CFG->libdir/gradelib.php");
- $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
- if (empty($grades->items[0]->grades)) {
- $grade = false;
- } else {
- $grade = reset($grades->items[0]->grades);
- }
- $count = forum_count_user_posts($forum->id, $user->id);
- if ($count && $count->postcount > 0) {
- $result = new stdClass();
- $result->info = get_string("numposts", "forum", $count->postcount);
- $result->time = $count->lastpost;
- if ($grade) {
- $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
- }
- return $result;
- } else if ($grade) {
- $result = new stdClass();
- $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
- //datesubmitted == time created. dategraded == time modified or time overridden
- //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
- //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
- if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
- $result->time = $grade->dategraded;
- } else {
- $result->time = $grade->datesubmitted;
- }
- return $result;
- }
- return NULL;
- }
- /**
- * @global object
- * @global object
- * @param object $coure
- * @param object $user
- * @param object $mod
- * @param object $forum
- */
- function forum_user_complete($course, $user, $mod, $forum) {
- global $CFG,$USER, $OUTPUT;
- require_once("$CFG->libdir/gradelib.php");
- $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
- if (!empty($grades->items[0]->grades)) {
- $grade = reset($grades->items[0]->grades);
- echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
- if ($grade->str_feedback) {
- echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
- }
- }
- if ($posts = forum_get_user_posts($forum->id, $user->id)) {
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
- print_error('invalidcoursemodule');
- }
- $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
- foreach ($posts as $post) {
- if (!isset($discussions[$post->discussion])) {
- continue;
- }
- $discussion = $discussions[$post->discussion];
- forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
- }
- } else {
- echo "<p>".get_string("noposts", "forum")."</p>";
- }
- }
- /**
- * @global object
- * @global object
- * @global object
- * @param array $courses
- * @param array $htmlarray
- */
- function forum_print_overview($courses,&$htmlarray) {
- global $USER, $CFG, $DB, $SESSION;
- if (empty($courses) || !is_array($courses) || count($courses) == 0) {
- return array();
- }
- if (!$forums = get_all_instances_in_courses('forum',$courses)) {
- return;
- }
- // Courses to search for new posts
- $coursessqls = array();
- $params = array();
- foreach ($courses as $course) {
- // If the user has never entered into the course all posts are pending
- if ($course->lastaccess == 0) {
- $coursessqls[] = '(f.course = ?)';
- $params[] = $course->id;
- // Only posts created after the course last access
- } else {
- $coursessqls[] = '(f.course = ? AND p.created > ?)';
- $params[] = $course->id;
- $params[] = $course->lastaccess;
- }
- }
- $params[] = $USER->id;
- $coursessql = implode(' OR ', $coursessqls);
- $sql = "SELECT f.id, COUNT(*) as count "
- .'FROM {forum} f '
- .'JOIN {forum_discussions} d ON d.forum = f.id '
- .'JOIN {forum_posts} p ON p.discussion = d.id '
- ."WHERE ($coursessql) "
- .'AND p.userid != ? '
- .'GROUP BY f.id';
- if (!$new = $DB->get_records_sql($sql, $params)) {
- $new = array(); // avoid warnings
- }
- // also get all forum tracking stuff ONCE.
- $trackingforums = array();
- foreach ($forums as $forum) {
- if (forum_tp_can_track_forums($forum)) {
- $trackingforums[$forum->id] = $forum;
- }
- }
- if (count($trackingforums) > 0) {
- $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
- $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
- ' FROM {forum_posts} p '.
- ' JOIN {forum_discussions} d ON p.discussion = d.id '.
- ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
- $params = array($USER->id);
- foreach ($trackingforums as $track) {
- $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
- $params[] = $track->id;
- if (isset($SESSION->currentgroup[$track->course])) {
- $groupid = $SESSION->currentgroup[$track->course];
- } else {
- // get first groupid
- $groupids = groups_get_all_groups($track->course, $USER->id);
- if ($groupids) {
- reset($groupids);
- $groupid = key($groupids);
- $SESSION->currentgroup[$track->course] = $groupid;
- } else {
- $groupid = 0;
- }
- unset($groupids);
- }
- $params[] = $groupid;
- }
- $sql = substr($sql,0,-3); // take off the last OR
- $sql .= ') AND p.modified >= ? AND r.id is NULL GROUP BY d.forum,d.course';
- $params[] = $cutoffdate;
- if (!$unread = $DB->get_records_sql($sql, $params)) {
- $unread = array();
- }
- } else {
- $unread = array();
- }
- if (empty($unread) and empty($new)) {
- return;
- }
- $strforum = get_string('modulename','forum');
- foreach ($forums as $forum) {
- $str = '';
- $count = 0;
- $thisunread = 0;
- $showunread = false;
- // either we have something from logs, or trackposts, or nothing.
- if (array_key_exists($forum->id, $new) && !empty($new[$forum->id])) {
- $count = $new[$forum->id]->count;
- }
- if (array_key_exists($forum->id,$unread)) {
- $thisunread = $unread[$forum->id]->count;
- $showunread = true;
- }
- if ($count > 0 || $thisunread > 0) {
- $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
- $forum->name.'</a></div>';
- $str .= '<div class="info"><span class="postsincelogin">';
- $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
- if (!empty($showunread)) {
- $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
- }
- $str .= '</div></div>';
- }
- if (!empty($str)) {
- if (!array_key_exists($forum->course,$htmlarray)) {
- $htmlarray[$forum->course] = array();
- }
- if (!array_key_exists('forum',$htmlarray[$forum->course])) {
- $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
- }
- $htmlarray[$forum->course]['forum'] .= $str;
- }
- }
- }
- /**
- * Given a course and a date, prints a summary of all the new
- * messages posted in the course since that date
- *
- * @global object
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @uses VISIBLEGROUPS
- * @param object $course
- * @param bool $viewfullnames capability
- * @param int $timestart
- * @return bool success
- */
- function forum_print_recent_activity($course, $viewfullnames, $timestart) {
- global $CFG, $USER, $DB, $OUTPUT;
- // do not use log table if possible, it may be huge and is expensive to join with other tables
- if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
- d.timestart, d.timeend, d.userid AS duserid,
- u.firstname, u.lastname, u.email, u.picture
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- JOIN {forum} f ON f.id = d.forum
- JOIN {user} u ON u.id = p.userid
- WHERE p.created > ? AND f.course = ?
- ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
- return false;
- }
- $modinfo = get_fast_modinfo($course);
- $groupmodes = array();
- $cms = array();
- $strftimerecent = get_string('strftimerecent');
- $printposts = array();
- foreach ($posts as $post) {
- if (!isset($modinfo->instances['forum'][$post->forum])) {
- // not visible
- continue;
- }
- $cm = $modinfo->instances['forum'][$post->forum];
- if (!$cm->uservisible) {
- continue;
- }
- $context = context_module::instance($cm->id);
- if (!has_capability('mod/forum:viewdiscussion', $context)) {
- continue;
- }
- if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
- and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
- if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
- continue;
- }
- }
- $groupmode = groups_get_activity_groupmode($cm, $course);
- if ($groupmode) {
- if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
- // oki (Open discussions have groupid -1)
- } else {
- // separate mode
- if (isguestuser()) {
- // shortcut
- continue;
- }
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
- }
- if (!in_array($post->groupid, $modinfo->get_groups($cm->groupingid))) {
- continue;
- }
- }
- }
- $printposts[] = $post;
- }
- unset($posts);
- if (!$printposts) {
- return false;
- }
- echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
- echo "\n<ul class='unlist'>\n";
- foreach ($printposts as $post) {
- $subjectclass = empty($post->parent) ? ' bold' : '';
- echo '<li><div class="head">'.
- '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
- '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
- '</div>';
- echo '<div class="info'.$subjectclass.'">';
- if (empty($post->parent)) {
- echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
- } else {
- echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&parent='.$post->parent.'#p'.$post->id.'">';
- }
- $post->subject = break_up_long_words(format_string($post->subject, true));
- echo $post->subject;
- echo "</a>\"</div></li>\n";
- }
- echo "</ul>\n";
- return true;
- }
- /**
- * Return grade for given user or all users.
- *
- * @global object
- * @global object
- * @param object $forum
- * @param int $userid optional user id, 0 means all users
- * @return array array of grades, false if none
- */
- function forum_get_user_grades($forum, $userid = 0) {
- global $CFG;
- require_once($CFG->dirroot.'/rating/lib.php');
- $ratingoptions = new stdClass;
- $ratingoptions->component = 'mod_forum';
- $ratingoptions->ratingarea = 'post';
- //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
- $ratingoptions->modulename = 'forum';
- $ratingoptions->moduleid = $forum->id;
- $ratingoptions->userid = $userid;
- $ratingoptions->aggregationmethod = $forum->assessed;
- $ratingoptions->scaleid = $forum->scale;
- $ratingoptions->itemtable = 'forum_posts';
- $ratingoptions->itemtableusercolumn = 'userid';
- $rm = new rating_manager();
- return $rm->get_user_grades($ratingoptions);
- }
- /**
- * Update activity grades
- *
- * @category grade
- * @param object $forum
- * @param int $userid specific user only, 0 means all
- * @param boolean $nullifnone return null if grade does not exist
- * @return void
- */
- function forum_update_grades($forum, $userid=0, $nullifnone=true) {
- global $CFG, $DB;
- require_once($CFG->libdir.'/gradelib.php');
- if (!$forum->assessed) {
- forum_grade_item_update($forum);
- } else if ($grades = forum_get_user_grades($forum, $userid)) {
- forum_grade_item_update($forum, $grades);
- } else if ($userid and $nullifnone) {
- $grade = new stdClass();
- $grade->userid = $userid;
- $grade->rawgrade = NULL;
- forum_grade_item_update($forum, $grade);
- } else {
- forum_grade_item_update($forum);
- }
- }
- /**
- * Update all grades in gradebook.
- * @global object
- */
- function forum_upgrade_grades() {
- global $DB;
- $sql = "SELECT COUNT('x')
- FROM {forum} f, {course_modules} cm, {modules} m
- WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
- $count = $DB->count_records_sql($sql);
- $sql = "SELECT f.*, cm.idnumber AS cmidnumber, f.course AS courseid
- FROM {forum} f, {course_modules} cm, {modules} m
- WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
- $rs = $DB->get_recordset_sql($sql);
- if ($rs->valid()) {
- $pbar = new progress_bar('forumupgradegrades', 500, true);
- $i=0;
- foreach ($rs as $forum) {
- $i++;
- upgrade_set_timeout(60*5); // set up timeout, may also abort execution
- forum_update_grades($forum, 0, false);
- $pbar->update($i, $count, "Updating Forum grades ($i/$count).");
- }
- }
- $rs->close();
- }
- /**
- * Create/update grade item for given forum
- *
- * @category grade
- * @uses GRADE_TYPE_NONE
- * @uses GRADE_TYPE_VALUE
- * @uses GRADE_TYPE_SCALE
- * @param stdClass $forum Forum object with extra cmidnumber
- * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
- * @return int 0 if ok
- */
- function forum_grade_item_update($forum, $grades=NULL) {
- global $CFG;
- if (!function_exists('grade_update')) { //workaround for buggy PHP versions
- require_once($CFG->libdir.'/gradelib.php');
- }
- $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
- if (!$forum->assessed or $forum->scale == 0) {
- $params['gradetype'] = GRADE_TYPE_NONE;
- } else if ($forum->scale > 0) {
- $params['gradetype'] = GRADE_TYPE_VALUE;
- $params['grademax'] = $forum->scale;
- $params['grademin'] = 0;
- } else if ($forum->scale < 0) {
- $params['gradetype'] = GRADE_TYPE_SCALE;
- $params['scaleid'] = -$forum->scale;
- }
- if ($grades === 'reset') {
- $params['reset'] = true;
- $grades = NULL;
- }
- return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
- }
- /**
- * Delete grade item for given forum
- *
- * @category grade
- * @param stdClass $forum Forum object
- * @return grade_item
- */
- function forum_grade_item_delete($forum) {
- global $CFG;
- require_once($CFG->libdir.'/gradelib.php');
- return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
- }
- /**
- * This function returns if a scale is being used by one forum
- *
- * @global object
- * @param int $forumid
- * @param int $scaleid negative number
- * @return bool
- */
- function forum_scale_used ($forumid,$scaleid) {
- global $DB;
- $return = false;
- $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
- if (!empty($rec) && !empty($scaleid)) {
- $return = true;
- }
- return $return;
- }
- /**
- * Checks if scale is being used by any instance of forum
- *
- * This is used to find out if scale used anywhere
- *
- * @global object
- * @param $scaleid int
- * @return boolean True if the scale is used by any forum
- */
- function forum_scale_used_anywhere($scaleid) {
- global $DB;
- if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
- return true;
- } else {
- return false;
- }
- }
- // SQL FUNCTIONS ///////////////////////////////////////////////////////////
- /**
- * Gets a post with all info ready for forum_print_post
- * Most of these joins are just to get the forum id
- *
- * @global object
- * @global object
- * @param int $postid
- * @return mixed array of posts or false
- */
- function forum_get_post_full($postid) {
- global $CFG, $DB;
- return $DB->get_record_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON p.discussion = d.id
- LEFT JOIN {user} u ON p.userid = u.id
- WHERE p.id = ?", array($postid));
- }
- /**
- * Gets posts with all info ready for forum_print_post
- * We pass forumid in because we always know it so no need to make a
- * complicated join to find it out.
- *
- * @global object
- * @global object
- * @return mixed array of posts or false
- */
- function forum_get_discussion_posts($discussion, $sort, $forumid) {
- global $CFG, $DB;
- return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
- FROM {forum_posts} p
- LEFT JOIN {user} u ON p.userid = u.id
- WHERE p.discussion = ?
- AND p.parent > 0 $sort", array($discussion));
- }
- /**
- * Gets all posts in discussion including top parent.
- *
- * @global object
- * @global object
- * @global object
- * @param int $discussionid
- * @param string $sort
- * @param bool $tracking does user track the forum?
- * @return array of posts
- */
- function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
- global $CFG, $DB, $USER;
- $tr_sel = "";
- $tr_join = "";
- $params = array();
- if ($tracking) {
- $now = time();
- $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
- $tr_sel = ", fr.id AS postread";
- $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
- $params[] = $USER->id;
- }
- $params[] = $discussionid;
- if (!$posts = $DB->get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture, u.imagealt $tr_sel
- FROM {forum_posts} p
- LEFT JOIN {user} u ON p.userid = u.id
- $tr_join
- WHERE p.discussion = ?
- ORDER BY $sort", $params)) {
- return array();
- }
- foreach ($posts as $pid=>$p) {
- if ($tracking) {
- if (forum_tp_is_post_old($p)) {
- $posts[$pid]->postread = true;
- }
- }
- if (!$p->parent) {
- continue;
- }
- if (!isset($posts[$p->parent])) {
- continue; // parent does not exist??
- }
- if (!isset($posts[$p->parent]->children)) {
- $posts[$p->parent]->children = array();
- }
- $posts[$p->parent]->children[$pid] =& $posts[$pid];
- }
- return $posts;
- }
- /**
- * Gets posts with all info ready for forum_print_post
- * We pass forumid in because we always know it so no need to make a
- * complicated join to find it out.
- *
- * @global object
- * @global object
- * @param int $parent
- * @param int $forumid
- * @return array
- */
- function forum_get_child_posts($parent, $forumid) {
- global $CFG, $DB;
- return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
- FROM {forum_posts} p
- LEFT JOIN {user} u ON p.userid = u.id
- WHERE p.parent = ?
- ORDER BY p.created ASC", array($parent));
- }
- /**
- * An array of forum objects that the user is allowed to read/search through.
- *
- * @global object
- * @global object
- * @global object
- * @param int $userid
- * @param int $courseid if 0, we look for forums throughout the whole site.
- * @return array of forum objects, or false if no matches
- * Forum objects have the following attributes:
- * id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
- * viewhiddentimedposts
- */
- function forum_get_readable_forums($userid, $courseid=0) {
- global $CFG, $DB, $USER;
- require_once($CFG->dirroot.'/course/lib.php');
- if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
- print_error('notinstalled', 'forum');
- }
- if ($courseid) {
- $courses = $DB->get_records('course', array('id' => $courseid));
- } else {
- // If no course is specified, then the user can see SITE + his courses.
- $courses1 = $DB->get_records('course', array('id' => SITEID));
- $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
- $courses = array_merge($courses1, $courses2);
- }
- if (!$courses) {
- return array();
- }
- $readableforums = array();
- foreach ($courses as $course) {
- $modinfo = get_fast_modinfo($course);
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id, $userid);
- }
- if (empty($modinfo->instances['forum'])) {
- // hmm, no forums?
- continue;
- }
- $courseforums = $DB->get_records('forum', array('course' => $course->id));
- foreach ($modinfo->instances['forum'] as $forumid => $cm) {
- if (!$cm->uservisible or !isset($courseforums[$forumid])) {
- continue;
- }
- $context = context_module::instance($cm->id);
- $forum = $courseforums[$forumid];
- $forum->context = $context;
- $forum->cm = $cm;
- if (!has_capability('mod/forum:viewdiscussion', $context)) {
- continue;
- }
- /// group access
- if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
- }
- if (isset($modinfo->groups[$cm->groupingid])) {
- $forum->onlygroups = $modinfo->groups[$cm->groupingid];
- $forum->onlygroups[] = -1;
- } else {
- $forum->onlygroups = array(-1);
- }
- }
- /// hidden timed discussions
- $forum->viewhiddentimedposts = true;
- if (!empty($CFG->forum_enabletimedposts)) {
- if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
- $forum->viewhiddentimedposts = false;
- }
- }
- /// qanda access
- if ($forum->type == 'qanda'
- && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
- // We need to check whether the user has posted in the qanda forum.
- $forum->onlydiscussions = array(); // Holds discussion ids for the discussions
- // the user is allowed to see in this forum.
- if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
- foreach ($discussionspostedin as $d) {
- $forum->onlydiscussions[] = $d->id;
- }
- }
- }
- $readableforums[$forum->id] = $forum;
- }
- unset($modinfo);
- } // End foreach $courses
- return $readableforums;
- }
- /**
- * Returns a list of posts found using an array of search terms.
- *
- * @global object
- * @global object
- * @global object
- * @param array $searchterms array of search terms, e.g. word +word -word
- * @param int $courseid if 0, we search through the whole site
- * @param int $limitfrom
- * @param int $limitnum
- * @param int &$totalcount
- * @param string $extrasql
- * @return array|bool Array of posts found or false
- */
- function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
- &$totalcount, $extrasql='') {
- global $CFG, $DB, $USER;
- require_once($CFG->libdir.'/searchlib.php');
- $forums = forum_get_readable_forums($USER->id, $courseid);
- if (count($forums) == 0) {
- $totalcount = 0;
- return false;
- }
- $now = round(time(), -2); // db friendly
- $fullaccess = array();
- $where = array();
- $params = array();
- foreach ($forums as $forumid => $forum) {
- $select = array();
- if (!$forum->viewhiddentimedposts) {
- $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
- $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
- }
- $cm = $forum->cm;
- $context = $forum->context;
- if ($forum->type == 'qanda'
- && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
- if (!empty($forum->onlydiscussions)) {
- list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
- $params = array_merge($params, $discussionid_params);
- $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
- } else {
- $select[] = "p.parent = 0";
- }
- }
- if (!empty($forum->onlygroups)) {
- list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
- $params = array_merge($params, $groupid_params);
- $select[] = "d.groupid $groupid_sql";
- }
- if ($select) {
- $selects = implode(" AND ", $select);
- $where[] = "(d.forum = :forum{$forumid} AND $selects)";
- $params['forum'.$forumid] = $forumid;
- } else {
- $fullaccess[] = $forumid;
- }
- }
- if ($fullaccess) {
- list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
- $params = array_merge($params, $fullid_params);
- $where[] = "(d.forum $fullid_sql)";
- }
- $selectdiscussion = "(".implode(" OR ", $where).")";
- $messagesearch = '';
- $searchstring = '';
- // Need to concat these back together for parser to work.
- foreach($searchterms as $searchterm){
- if ($searchstring != '') {
- $searchstring .= ' ';
- }
- $searchstring .= $searchterm;
- }
- // We need to allow quoted strings for the search. The quotes *should* be stripped
- // by the parser, but this should be examined carefully for security implications.
- $searchstring = str_replace("\\\"","\"",$searchstring);
- $parser = new search_parser();
- $lexer = new search_lexer($parser);
- if ($lexer->parse($searchstring)) {
- $parsearray = $parser->get_parsed_array();
- // Experimental feature under 1.8! MDL-8830
- // Use alternative text searches if defined
- // This feature only works under mysql until properly implemented for other DBs
- // Requires manual creation of text index for forum_posts before enabling it:
- // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
- // Experimental feature under 1.8! MDL-8830
- if (!empty($CFG->forum_usetextsearches)) {
- list($messagesearch, $msparams) = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
- 'p.userid', 'u.id', 'u.firstname',
- 'u.lastname', 'p.modified', 'd.forum');
- } else {
- list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
- 'p.userid', 'u.id', 'u.firstname',
- 'u.lastname', 'p.modified', 'd.forum');
- }
- $params = array_merge($params, $msparams);
- }
- $fromsql = "{forum_posts} p,
- {forum_discussions} d,
- {user} u";
- $selectsql = " $messagesearch
- AND p.discussion = d.id
- AND p.userid = u.id
- AND $selectdiscussion
- $extrasql";
- $countsql = "SELECT COUNT(*)
- FROM $fromsql
- WHERE $selectsql";
- $searchsql = "SELECT p.*,
- d.forum,
- u.firstname,
- u.lastname,
- u.email,
- u.picture,
- u.imagealt
- FROM $fromsql
- WHERE $selectsql
- ORDER BY p.modified DESC";
- $totalcount = $DB->count_records_sql($countsql, $params);
- return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
- }
- /**
- * Returns a list of ratings for a particular post - sorted.
- *
- * TODO: Check if this function is actually used anywhere.
- * Up until the fix for MDL-27471 this function wasn't even returning.
- *
- * @param stdClass $context
- * @param int $postid
- * @param string $sort
- * @return array Array of ratings or false
- */
- function forum_get_ratings($context, $postid, $sort = "u.firstname ASC") {
- $options = new stdClass;
- $options->context = $context;
- $options->component = 'mod_forum';
- $options->ratingarea = 'post';
- $options->itemid = $postid;
- $options->sort = "ORDER BY $sort";
- $rm = new rating_manager();
- return $rm->get_all_ratings_for_item($options);
- }
- /**
- * Returns a list of all new posts that have not been mailed yet
- *
- * @param int $starttime posts created after this time
- * @param int $endtime posts created before this
- * @param int $now used for timed discussions only
- * @return array
- */
- function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
- global $CFG, $DB;
- $params = array();
- $params['mailed'] = FORUM_MAILED_PENDING;
- $params['ptimestart'] = $starttime;
- $params['ptimeend'] = $endtime;
- $params['mailnow'] = 1;
- if (!empty($CFG->forum_enabletimedposts)) {
- if (empty($now)) {
- $now = time();
- }
- $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
- $params['dtimestart'] = $now;
- $params['dtimeend'] = $now;
- } else {
- $timedsql = "";
- }
- return $DB->get_records_sql("SELECT p.*, d.course, d.forum
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- WHERE p.mailed = :mailed
- AND p.created >= :ptimestart
- AND (p.created < :ptimeend OR p.mailnow = :mailnow)
- $timedsql
- ORDER BY p.modified ASC", $params);
- }
- /**
- * Marks posts before a certain time as being mailed already
- *
- * @global object
- * @global object
- * @param int $endtime
- * @param int $now Defaults to time()
- * @return bool
- */
- function forum_mark_old_posts_as_mailed($endtime, $now=null) {
- global $CFG, $DB;
- if (empty($now)) {
- $now = time();
- }
- $params = array();
- $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
- $params['now'] = $now;
- $params['endtime'] = $endtime;
- $params['mailnow'] = 1;
- $params['mailedpending'] = FORUM_MAILED_PENDING;
- if (empty($CFG->forum_enabletimedposts)) {
- return $DB->execute("UPDATE {forum_posts}
- SET mailed = :mailedsuccess
- WHERE (created < :endtime OR mailnow = :mailnow)
- AND mailed = :mailedpending", $params);
- } else {
- return $DB->execute("UPDATE {forum_posts}
- SET mailed = :mailedsuccess
- WHERE discussion NOT IN (SELECT d.id
- FROM {forum_discussions} d
- WHERE d.timestart > :now)
- AND (created < :endtime OR mailnow = :mailnow)
- AND mailed = :mailedpending", $params);
- }
- }
- /**
- * Get all the posts for a user in a forum suitable for forum_print_post
- *
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @return array
- */
- function forum_get_user_posts($forumid, $userid) {
- global $CFG, $DB;
- $timedsql = "";
- $params = array($forumid, $userid);
- if (!empty($CFG->forum_enabletimedposts)) {
- $cm = get_coursemodule_from_instance('forum', $forumid);
- if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
- $now = time();
- $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
- $params[] = $now;
- $params[] = $now;
- }
- }
- return $DB->get_records_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
- FROM {forum} f
- JOIN {forum_discussions} d ON d.forum = f.id
- JOIN {forum_posts} p ON p.discussion = d.id
- JOIN {user} u ON u.id = p.userid
- WHERE f.id = ?
- AND p.userid = ?
- $timedsql
- ORDER BY p.modified ASC", $params);
- }
- /**
- * Get all the discussions user participated in
- *
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @param int $forumid
- * @param int $userid
- * @return array Array or false
- */
- function forum_get_user_involved_discussions($forumid, $userid) {
- global $CFG, $DB;
- $timedsql = "";
- $params = array($forumid, $userid);
- if (!empty($CFG->forum_enabletimedposts)) {
- $cm = get_coursemodule_from_instance('forum', $forumid);
- if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
- $now = time();
- $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
- $params[] = $now;
- $params[] = $now;
- }
- }
- return $DB->get_records_sql("SELECT DISTINCT d.*
- FROM {forum} f
- JOIN {forum_discussions} d ON d.forum = f.id
- JOIN {forum_posts} p ON p.discussion = d.id
- WHERE f.id = ?
- AND p.userid = ?
- $timedsql", $params);
- }
- /**
- * Get all the posts for a user in a forum suitable for forum_print_post
- *
- * @global object
- * @global object
- * @param int $forumid
- * @param int $userid
- * @return array of counts or false
- */
- function forum_count_user_posts($forumid, $userid) {
- global $CFG, $DB;
- $timedsql = "";
- $params = array($forumid, $userid);
- if (!empty($CFG->forum_enabletimedposts)) {
- $cm = get_coursemodule_from_instance('forum', $forumid);
- if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
- $now = time();
- $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
- $params[] = $now;
- $params[] = $now;
- }
- }
- return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
- FROM {forum} f
- JOIN {forum_discussions} d ON d.forum = f.id
- JOIN {forum_posts} p ON p.discussion = d.id
- JOIN {user} u ON u.id = p.userid
- WHERE f.id = ?
- AND p.userid = ?
- $timedsql", $params);
- }
- /**
- * Given a log entry, return the forum post details for it.
- *
- * @global object
- * @global object
- * @param object $log
- * @return array|null
- */
- function forum_get_post_from_log($log) {
- global $CFG, $DB;
- if ($log->action == "add post") {
- return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
- u.firstname, u.lastname, u.email, u.picture
- FROM {forum_discussions} d,
- {forum_posts} p,
- {forum} f,
- {user} u
- WHERE p.id = ?
- AND d.id = p.discussion
- AND p.userid = u.id
- AND u.deleted <> '1'
- AND f.id = d.forum", array($log->info));
- } else if ($log->action == "add discussion") {
- return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
- u.firstname, u.lastname, u.email, u.picture
- FROM {forum_discussions} d,
- {forum_posts} p,
- {forum} f,
- {user} u
- WHERE d.id = ?
- AND d.firstpost = p.id
- AND p.userid = u.id
- AND u.deleted <> '1'
- AND f.id = d.forum", array($log->info));
- }
- return NULL;
- }
- /**
- * Given a discussion id, return the first post from the discussion
- *
- * @global object
- * @global object
- * @param int $dicsussionid
- * @return array
- */
- function forum_get_firstpost_from_discussion($discussionid) {
- global $CFG, $DB;
- return $DB->get_record_sql("SELECT p.*
- FROM {forum_discussions} d,
- {forum_posts} p
- WHERE d.id = ?
- AND d.firstpost = p.id ", array($discussionid));
- }
- /**
- * Returns an array of counts of replies to each discussion
- *
- * @global object
- * @global object
- * @param int $forumid
- * @param string $forumsort
- * @param int $limit
- * @param int $page
- * @param int $perpage
- * @return array
- */
- function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
- global $CFG, $DB;
- if ($limit > 0) {
- $limitfrom = 0;
- $limitnum = $limit;
- } else if ($page != -1) {
- $limitfrom = $page*$perpage;
- $limitnum = $perpage;
- } else {
- $limitfrom = 0;
- $limitnum = 0;
- }
- if ($forumsort == "") {
- $orderby = "";
- $groupby = "";
- } else {
- $orderby = "ORDER BY $forumsort";
- $groupby = ", ".strtolower($forumsort);
- $groupby = str_replace('desc', '', $groupby);
- $groupby = str_replace('asc', '', $groupby);
- }
- if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
- $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON p.discussion = d.id
- WHERE p.parent > 0 AND d.forum = ?
- GROUP BY p.discussion";
- return $DB->get_records_sql($sql, array($forumid));
- } else {
- $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON p.discussion = d.id
- WHERE d.forum = ?
- GROUP BY p.discussion $groupby
- $orderby";
- return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
- }
- }
- /**
- * @global object
- * @global object
- * @global object
- * @staticvar array $cache
- * @param object $forum
- * @param object $cm
- * @param object $course
- * @return mixed
- */
- function forum_count_discussions($forum, $cm, $course) {
- global $CFG, $DB, $USER;
- static $cache = array();
- $now = round(time(), -2); // db cache friendliness
- $params = array($course->id);
- if (!isset($cache[$course->id])) {
- if (!empty($CFG->forum_enabletimedposts)) {
- $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
- $params[] = $now;
- $params[] = $now;
- } else {
- $timedsql = "";
- }
- $sql = "SELECT f.id, COUNT(d.id) as dcount
- FROM {forum} f
- JOIN {forum_discussions} d ON d.forum = f.id
- WHERE f.course = ?
- $timedsql
- GROUP BY f.id";
- if ($counts = $DB->get_records_sql($sql, $params)) {
- foreach ($counts as $count) {
- $counts[$count->id] = $count->dcount;
- }
- $cache[$course->id] = $counts;
- } else {
- $cache[$course->id] = array();
- }
- }
- if (empty($cache[$course->id][$forum->id])) {
- return 0;
- }
- $groupmode = groups_get_activity_groupmode($cm, $course);
- if ($groupmode != SEPARATEGROUPS) {
- return $cache[$course->id][$forum->id];
- }
- if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
- return $cache[$course->id][$forum->id];
- }
- require_once($CFG->dirroot.'/course/lib.php');
- $modinfo = get_fast_modinfo($course);
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
- }
- if (array_key_exists($cm->groupingid, $modinfo->groups)) {
- $mygroups = $modinfo->groups[$cm->groupingid];
- } else {
- $mygroups = false; // Will be set below
- }
- // add all groups posts
- if (empty($mygroups)) {
- $mygroups = array(-1=>-1);
- } else {
- $mygroups[-1] = -1;
- }
- list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
- $params[] = $forum->id;
- if (!empty($CFG->forum_enabletimedposts)) {
- $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
- $params[] = $now;
- $params[] = $now;
- } else {
- $timedsql = "";
- }
- $sql = "SELECT COUNT(d.id)
- FROM {forum_discussions} d
- WHERE d.groupid $mygroups_sql AND d.forum = ?
- $timedsql";
- return $DB->get_field_sql($sql, $params);
- }
- /**
- * How many posts by other users are unrated by a given user in the given discussion?
- *
- * TODO: Is this function still used anywhere?
- *
- * @param int $discussionid
- * @param int $userid
- * @return mixed
- */
- function forum_count_unrated_posts($discussionid, $userid) {
- global $CFG, $DB;
- $sql = "SELECT COUNT(*) as num
- FROM {forum_posts}
- WHERE parent > 0
- AND discussion = :discussionid
- AND userid <> :userid";
- $params = array('discussionid' => $discussionid, 'userid' => $userid);
- $posts = $DB->get_record_sql($sql, $params);
- if ($posts) {
- $sql = "SELECT count(*) as num
- FROM {forum_posts} p,
- {rating} r
- WHERE p.discussion = :discussionid AND
- p.id = r.itemid AND
- r.userid = userid AND
- r.component = 'mod_forum' AND
- r.ratingarea = 'post'";
- $rated = $DB->get_record_sql($sql, $params);
- if ($rated) {
- if ($posts->num > $rated->num) {
- return $posts->num - $rated->num;
- } else {
- return 0; // Just in case there was a counting error
- }
- } else {
- return $posts->num;
- }
- } else {
- return 0;
- }
- }
- /**
- * Get all discussions in a forum
- *
- * @global object
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @uses VISIBLEGROUPS
- * @param object $cm
- * @param string $forumsort
- * @param bool $fullpost
- * @param int $unused
- * @param int $limit
- * @param bool $userlastmodified
- * @param int $page
- * @param int $perpage
- * @return array
- */
- function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
- global $CFG, $DB, $USER;
- $timelimit = '';
- $now = round(time(), -2);
- $params = array($cm->instance);
- $modcontext = context_module::instance($cm->id);
- if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
- return array();
- }
- if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
- if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
- $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
- $params[] = $now;
- $params[] = $now;
- if (isloggedin()) {
- $timelimit .= " OR d.userid = ?";
- $params[] = $USER->id;
- }
- $timelimit .= ")";
- }
- }
- if ($limit > 0) {
- $limitfrom = 0;
- $limitnum = $limit;
- } else if ($page != -1) {
- $limitfrom = $page*$perpage;
- $limitnum = $perpage;
- } else {
- $limitfrom = 0;
- $limitnum = 0;
- }
- $groupmode = groups_get_activity_groupmode($cm);
- $currentgroup = groups_get_activity_group($cm);
- if ($groupmode) {
- if (empty($modcontext)) {
- $modcontext = context_module::instance($cm->id);
- }
- if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $currentgroup;
- } else {
- $groupselect = "";
- }
- } else {
- //seprate groups without access all
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $currentgroup;
- } else {
- $groupselect = "AND d.groupid = -1";
- }
- }
- } else {
- $groupselect = "";
- }
- if (empty($forumsort)) {
- $forumsort = "d.timemodified DESC";
- }
- if (empty($fullpost)) {
- $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
- } else {
- $postdata = "p.*";
- }
- if (empty($userlastmodified)) { // We don't need to know this
- $umfields = "";
- $umtable = "";
- } else {
- $umfields = ", um.firstname AS umfirstname, um.lastname AS umlastname";
- $umtable = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
- }
- $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend,
- u.firstname, u.lastname, u.email, u.picture, u.imagealt $umfields
- FROM {forum_discussions} d
- JOIN {forum_posts} p ON p.discussion = d.id
- JOIN {user} u ON p.userid = u.id
- $umtable
- WHERE d.forum = ? AND p.parent = 0
- $timelimit $groupselect
- ORDER BY $forumsort";
- return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
- }
- /**
- *
- * @global object
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @uses VISIBLEGROUPS
- * @param object $cm
- * @return array
- */
- function forum_get_discussions_unread($cm) {
- global $CFG, $DB, $USER;
- $now = round(time(), -2);
- $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
- $params = array();
- $groupmode = groups_get_activity_groupmode($cm);
- $currentgroup = groups_get_activity_group($cm);
- if ($groupmode) {
- $modcontext = context_module::instance($cm->id);
- if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
- $params['currentgroup'] = $currentgroup;
- } else {
- $groupselect = "";
- }
- } else {
- //separate groups without access all
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
- $params['currentgroup'] = $currentgroup;
- } else {
- $groupselect = "AND d.groupid = -1";
- }
- }
- } else {
- $groupselect = "";
- }
- if (!empty($CFG->forum_enabletimedposts)) {
- $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
- $params['now1'] = $now;
- $params['now2'] = $now;
- } else {
- $timedsql = "";
- }
- $sql = "SELECT d.id, COUNT(p.id) AS unread
- FROM {forum_discussions} d
- JOIN {forum_posts} p ON p.discussion = d.id
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
- WHERE d.forum = {$cm->instance}
- AND p.modified >= :cutoffdate AND r.id is NULL
- $groupselect
- $timedsql
- GROUP BY d.id";
- $params['cutoffdate'] = $cutoffdate;
- if ($unreads = $DB->get_records_sql($sql, $params)) {
- foreach ($unreads as $unread) {
- $unreads[$unread->id] = $unread->unread;
- }
- return $unreads;
- } else {
- return array();
- }
- }
- /**
- * @global object
- * @global object
- * @global object
- * @uses CONEXT_MODULE
- * @uses VISIBLEGROUPS
- * @param object $cm
- * @return array
- */
- function forum_get_discussions_count($cm) {
- global $CFG, $DB, $USER;
- $now = round(time(), -2);
- $params = array($cm->instance);
- $groupmode = groups_get_activity_groupmode($cm);
- $currentgroup = groups_get_activity_group($cm);
- if ($groupmode) {
- $modcontext = context_module::instance($cm->id);
- if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $currentgroup;
- } else {
- $groupselect = "";
- }
- } else {
- //seprate groups without access all
- if ($currentgroup) {
- $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $currentgroup;
- } else {
- $groupselect = "AND d.groupid = -1";
- }
- }
- } else {
- $groupselect = "";
- }
- $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
- $timelimit = "";
- if (!empty($CFG->forum_enabletimedposts)) {
- $modcontext = context_module::instance($cm->id);
- if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
- $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
- $params[] = $now;
- $params[] = $now;
- if (isloggedin()) {
- $timelimit .= " OR d.userid = ?";
- $params[] = $USER->id;
- }
- $timelimit .= ")";
- }
- }
- $sql = "SELECT COUNT(d.id)
- FROM {forum_discussions} d
- JOIN {forum_posts} p ON p.discussion = d.id
- WHERE d.forum = ? AND p.parent = 0
- $groupselect $timelimit";
- return $DB->get_field_sql($sql, $params);
- }
- /**
- * Get all discussions started by a particular user in a course (or group)
- * This function no longer used ...
- *
- * @todo Remove this function if no longer used
- * @global object
- * @global object
- * @param int $courseid
- * @param int $userid
- * @param int $groupid
- * @return array
- */
- function forum_get_user_discussions($courseid, $userid, $groupid=0) {
- global $CFG, $DB;
- $params = array($courseid, $userid);
- if ($groupid) {
- $groupselect = " AND d.groupid = ? ";
- $params[] = $groupid;
- } else {
- $groupselect = "";
- }
- return $DB->get_records_sql("SELECT p.*, d.groupid, u.firstname, u.lastname, u.email, u.picture, u.imagealt,
- f.type as forumtype, f.name as forumname, f.id as forumid
- FROM {forum_discussions} d,
- {forum_posts} p,
- {user} u,
- {forum} f
- WHERE d.course = ?
- AND p.discussion = d.id
- AND p.parent = 0
- AND p.userid = u.id
- AND u.id = ?
- AND d.forum = f.id $groupselect
- ORDER BY p.created DESC", $params);
- }
- /**
- * Get the list of potential subscribers to a forum.
- *
- * @param object $forumcontext the forum context.
- * @param integer $groupid the id of a group, or 0 for all groups.
- * @param string $fields the list of fields to return for each user. As for get_users_by_capability.
- * @param string $sort sort order. As for get_users_by_capability.
- * @return array list of users.
- */
- function forum_get_potential_subscribers($forumcontext, $groupid, $fields, $sort = '') {
- global $DB;
- // only active enrolled users or everybody on the frontpage
- list($esql, $params) = get_enrolled_sql($forumcontext, 'mod/forum:allowforcesubscribe', $groupid, true);
- if (!$sort) {
- list($sort, $sortparams) = users_order_by_sql('u');
- $params = array_merge($params, $sortparams);
- }
- $sql = "SELECT $fields
- FROM {user} u
- JOIN ($esql) je ON je.id = u.id
- ORDER BY $sort";
- return $DB->get_records_sql($sql, $params);
- }
- /**
- * Returns list of user objects that are subscribed to this forum
- *
- * @global object
- * @global object
- * @param object $course the course
- * @param forum $forum the forum
- * @param integer $groupid group id, or 0 for all.
- * @param object $context the forum context, to save re-fetching it where possible.
- * @param string $fields requested user fields (with "u." table prefix)
- * @return array list of users.
- */
- function forum_subscribed_users($course, $forum, $groupid=0, $context = null, $fields = null) {
- global $CFG, $DB;
- if (empty($fields)) {
- $fields ="u.id,
- u.username,
- u.firstname,
- u.lastname,
- u.maildisplay,
- u.mailformat,
- u.maildigest,
- u.imagealt,
- u.email,
- u.emailstop,
- u.city,
- u.country,
- u.lastaccess,
- u.lastlogin,
- u.picture,
- u.timezone,
- u.theme,
- u.lang,
- u.trackforums,
- u.mnethostid";
- }
- if (empty($context)) {
- $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id);
- $context = context_module::instance($cm->id);
- }
- if (forum_is_forcesubscribed($forum)) {
- $results = forum_get_potential_subscribers($context, $groupid, $fields, "u.email ASC");
- } else {
- // only active enrolled users or everybody on the frontpage
- list($esql, $params) = get_enrolled_sql($context, '', $groupid, true);
- $params['forumid'] = $forum->id;
- $results = $DB->get_records_sql("SELECT $fields
- FROM {user} u
- JOIN ($esql) je ON je.id = u.id
- JOIN {forum_subscriptions} s ON s.userid = u.id
- WHERE s.forum = :forumid
- ORDER BY u.email ASC", $params);
- }
- // Guest user should never be subscribed to a forum.
- unset($results[$CFG->siteguest]);
- return $results;
- }
- // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
- /**
- * @global object
- * @global object
- * @param int $courseid
- * @param string $type
- */
- function forum_get_course_forum($courseid, $type) {
- // How to set up special 1-per-course forums
- global $CFG, $DB, $OUTPUT, $USER;
- if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
- // There should always only be ONE, but with the right combination of
- // errors there might be more. In this case, just return the oldest one (lowest ID).
- foreach ($forums as $forum) {
- return $forum; // ie the first one
- }
- }
- // Doesn't exist, so create one now.
- $forum = new stdClass();
- $forum->course = $courseid;
- $forum->type = "$type";
- if (!empty($USER->htmleditor)) {
- $forum->introformat = $USER->htmleditor;
- }
- switch ($forum->type) {
- case "news":
- $forum->name = get_string("namenews", "forum");
- $forum->intro = get_string("intronews", "forum");
- $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
- $forum->assessed = 0;
- if ($courseid == SITEID) {
- $forum->name = get_string("sitenews");
- $forum->forcesubscribe = 0;
- }
- break;
- case "social":
- $forum->name = get_string("namesocial", "forum");
- $forum->intro = get_string("introsocial", "forum");
- $forum->assessed = 0;
- $forum->forcesubscribe = 0;
- break;
- case "blog":
- $forum->name = get_string('blogforum', 'forum');
- $forum->intro = get_string('introblog', 'forum');
- $forum->assessed = 0;
- $forum->forcesubscribe = 0;
- break;
- default:
- echo $OUTPUT->notification("That forum type doesn't exist!");
- return false;
- break;
- }
- $forum->timemodified = time();
- $forum->id = $DB->insert_record("forum", $forum);
- if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
- echo $OUTPUT->notification("Could not find forum module!!");
- return false;
- }
- $mod = new stdClass();
- $mod->course = $courseid;
- $mod->module = $module->id;
- $mod->instance = $forum->id;
- $mod->section = 0;
- include_once("$CFG->dirroot/course/lib.php");
- if (! $mod->coursemodule = add_course_module($mod) ) {
- echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
- return false;
- }
- $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
- return $DB->get_record("forum", array("id" => "$forum->id"));
- }
- /**
- * Given the data about a posting, builds up the HTML to display it and
- * returns the HTML in a string. This is designed for sending via HTML email.
- *
- * @global object
- * @param object $course
- * @param object $cm
- * @param object $forum
- * @param object $discussion
- * @param object $post
- * @param object $userform
- * @param object $userto
- * @param bool $ownpost
- * @param bool $reply
- * @param bool $link
- * @param bool $rate
- * @param string $footer
- * @return string
- */
- function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
- $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
- global $CFG, $OUTPUT;
- $modcontext = context_module::instance($cm->id);
- if (!isset($userto->viewfullnames[$forum->id])) {
- $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
- } else {
- $viewfullnames = $userto->viewfullnames[$forum->id];
- }
- // add absolute file links
- $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
- // format the post body
- $options = new stdClass();
- $options->para = true;
- $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
- $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
- $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
- $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
- $output .= '</td>';
- if ($post->parent) {
- $output .= '<td class="topic">';
- } else {
- $output .= '<td class="topic starter">';
- }
- $output .= '<div class="subject">'.format_string($post->subject).'</div>';
- $fullname = fullname($userfrom, $viewfullnames);
- $by = new stdClass();
- $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&course='.$course->id.'">'.$fullname.'</a>';
- $by->date = userdate($post->modified, '', $userto->timezone);
- $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
- $output .= '</td></tr>';
- $output .= '<tr><td class="left side" valign="top">';
- if (isset($userfrom->groups)) {
- $groups = $userfrom->groups[$forum->id];
- } else {
- $groups = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
- }
- if ($groups) {
- $output .= print_group_picture($groups, $course->id, false, true, true);
- } else {
- $output .= ' ';
- }
- $output .= '</td><td class="content">';
- $attachments = forum_print_attachments($post, $cm, 'html');
- if ($attachments !== '') {
- $output .= '<div class="attachments">';
- $output .= $attachments;
- $output .= '</div>';
- }
- $output .= $formattedtext;
- // Commands
- $commands = array();
- if ($post->parent) {
- $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
- $post->discussion.'&parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
- }
- if ($reply) {
- $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
- get_string('reply', 'forum').'</a>';
- }
- $output .= '<div class="commands">';
- $output .= implode(' | ', $commands);
- $output .= '</div>';
- // Context link to post if required
- if ($link) {
- $output .= '<div class="link">';
- $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
- get_string('postincontext', 'forum').'</a>';
- $output .= '</div>';
- }
- if ($footer) {
- $output .= '<div class="footer">'.$footer.'</div>';
- }
- $output .= '</td></tr></table>'."\n\n";
- return $output;
- }
- /**
- * Print a forum post
- *
- * @global object
- * @global object
- * @uses FORUM_MODE_THREADED
- * @uses PORTFOLIO_FORMAT_PLAINHTML
- * @uses PORTFOLIO_FORMAT_FILE
- * @uses PORTFOLIO_FORMAT_RICHHTML
- * @uses PORTFOLIO_ADD_TEXT_LINK
- * @uses CONTEXT_MODULE
- * @param object $post The post to print.
- * @param object $discussion
- * @param object $forum
- * @param object $cm
- * @param object $course
- * @param boolean $ownpost Whether this post belongs to the current user.
- * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
- * @param boolean $link Just print a shortened version of the post as a link to the full post.
- * @param string $footer Extra stuff to print after the message.
- * @param string $highlight Space-separated list of terms to highlight.
- * @param int $post_read true, false or -99. If we already know whether this user
- * has read this post, pass that in, otherwise, pass in -99, and this
- * function will work it out.
- * @param boolean $dummyifcantsee When forum_user_can_see_post says that
- * the current user can't see this post, if this argument is true
- * (the default) then print a dummy 'you can't see this post' post.
- * If false, don't output anything at all.
- * @param bool|null $istracked
- * @return void
- */
- function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
- $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
- global $USER, $CFG, $OUTPUT;
- require_once($CFG->libdir . '/filelib.php');
- // String cache
- static $str;
- $modcontext = context_module::instance($cm->id);
- $post->course = $course->id;
- $post->forum = $forum->id;
- $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
- if (!empty($CFG->enableplagiarism)) {
- require_once($CFG->libdir.'/plagiarismlib.php');
- $post->message .= plagiarism_get_links(array('userid' => $post->userid,
- 'content' => $post->message,
- 'cmid' => $cm->id,
- 'course' => $post->course,
- 'forum' => $post->forum));
- }
- // caching
- if (!isset($cm->cache)) {
- $cm->cache = new stdClass;
- }
- if (!isset($cm->cache->caps)) {
- $cm->cache->caps = array();
- $cm->cache->caps['mod/forum:viewdiscussion'] = has_capability('mod/forum:viewdiscussion', $modcontext);
- $cm->cache->caps['moodle/site:viewfullnames'] = has_capability('moodle/site:viewfullnames', $modcontext);
- $cm->cache->caps['mod/forum:editanypost'] = has_capability('mod/forum:editanypost', $modcontext);
- $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
- $cm->cache->caps['mod/forum:deleteownpost'] = has_capability('mod/forum:deleteownpost', $modcontext);
- $cm->cache->caps['mod/forum:deleteanypost'] = has_capability('mod/forum:deleteanypost', $modcontext);
- $cm->cache->caps['mod/forum:viewanyrating'] = has_capability('mod/forum:viewanyrating', $modcontext);
- $cm->cache->caps['mod/forum:exportpost'] = has_capability('mod/forum:exportpost', $modcontext);
- $cm->cache->caps['mod/forum:exportownpost'] = has_capability('mod/forum:exportownpost', $modcontext);
- }
- if (!isset($cm->uservisible)) {
- $cm->uservisible = coursemodule_visible_for_user($cm);
- }
- if ($istracked && is_null($postisread)) {
- $postisread = forum_tp_is_post_read($USER->id, $post);
- }
- if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
- $output = '';
- if (!$dummyifcantsee) {
- if ($return) {
- return $output;
- }
- echo $output;
- return;
- }
- $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
- $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'));
- $output .= html_writer::start_tag('div', array('class'=>'row header'));
- $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
- if ($post->parent) {
- $output .= html_writer::start_tag('div', array('class'=>'topic'));
- } else {
- $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
- }
- $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class'=>'subject')); // Subject
- $output .= html_writer::tag('div', get_string('forumauthorhidden','forum'), array('class'=>'author')); // author
- $output .= html_writer::end_tag('div');
- $output .= html_writer::end_tag('div'); // row
- $output .= html_writer::start_tag('div', array('class'=>'row'));
- $output .= html_writer::tag('div', ' ', array('class'=>'left side')); // Groups
- $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
- $output .= html_writer::end_tag('div'); // row
- $output .= html_writer::end_tag('div'); // forumpost
- if ($return) {
- return $output;
- }
- echo $output;
- return;
- }
- if (empty($str)) {
- $str = new stdClass;
- $str->edit = get_string('edit', 'forum');
- $str->delete = get_string('delete', 'forum');
- $str->reply = get_string('reply', 'forum');
- $str->parent = get_string('parent', 'forum');
- $str->pruneheading = get_string('pruneheading', 'forum');
- $str->prune = get_string('prune', 'forum');
- $str->displaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
- $str->markread = get_string('markread', 'forum');
- $str->markunread = get_string('markunread', 'forum');
- }
- $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
- // Build an object that represents the posting user
- $postuser = new stdClass;
- $postuser->id = $post->userid;
- $postuser->firstname = $post->firstname;
- $postuser->lastname = $post->lastname;
- $postuser->imagealt = $post->imagealt;
- $postuser->picture = $post->picture;
- $postuser->email = $post->email;
- // Some handy things for later on
- $postuser->fullname = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
- $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
- // Prepare the groups the posting user belongs to
- if (isset($cm->cache->usersgroups)) {
- $groups = array();
- if (isset($cm->cache->usersgroups[$post->userid])) {
- foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
- $groups[$gid] = $cm->cache->groups[$gid];
- }
- }
- } else {
- $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
- }
- // Prepare the attachements for the post, files then images
- list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
- // Determine if we need to shorten this post
- $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
- // Prepare an array of commands
- $commands = array();
- // SPECIAL CASE: The front page can display a news item post to non-logged in users.
- // Don't display the mark read / unread controls in this case.
- if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
- $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
- $text = $str->markunread;
- if (!$postisread) {
- $url->param('mark', 'read');
- $text = $str->markread;
- }
- if ($str->displaymode == FORUM_MODE_THREADED) {
- $url->param('parent', $post->parent);
- } else {
- $url->set_anchor('p'.$post->id);
- }
- $commands[] = array('url'=>$url, 'text'=>$text);
- }
- // Zoom in to the parent specifically
- if ($post->parent) {
- $url = new moodle_url($discussionlink);
- if ($str->displaymode == FORUM_MODE_THREADED) {
- $url->param('parent', $post->parent);
- } else {
- $url->set_anchor('p'.$post->parent);
- }
- $commands[] = array('url'=>$url, 'text'=>$str->parent);
- }
- // Hack for allow to edit news posts those are not displayed yet until they are displayed
- $age = time() - $post->created;
- if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
- $age = 0;
- }
- if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
- if (has_capability('moodle/course:manageactivities', $modcontext)) {
- // The first post in single simple is the forum description.
- $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
- }
- } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
- $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
- }
- // Added by Girish N J
- $commands[] = array('url'=>new moodle_url('#'), 'text'=>'LIKE','attributes'=>array('id'=>'demolike'));
- // attempt 1
- $commands[]= array ('sub'=>$post->subject);
- // attempt 2
- global $content;
- $content=$post->subject;
- if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
- $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
- }
- if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
- // Do not allow deleting of first post in single simple type.
- } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
- $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
- }
- if ($reply) {
- $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
- }
- if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
- $p = array('postid' => $post->id);
- require_once($CFG->libdir.'/portfoliolib.php');
- $button = new portfolio_add_button();
- $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
- if (empty($attachments)) {
- $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
- } else {
- $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
- }
- $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
- if (!empty($porfoliohtml)) {
- $commands[] = $porfoliohtml;
- }
- }
- // Finished building commands
- // Begin output
- $output = '';
- if ($istracked) {
- if ($postisread) {
- $forumpostclass = ' read';
- } else {
- $forumpostclass = ' unread';
- $output .= html_writer::tag('a', '', array('name'=>'unread'));
- }
- } else {
- // ignore trackign status if not tracked or tracked param missing
- $forumpostclass = '';
- }
- $topicclass = '';
- if (empty($post->parent)) {
- $topicclass = ' firstpost starter';
- }
- $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
- $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass));
- $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
- $output .= html_writer::start_tag('div', array('class'=>'left picture'));
- $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
- $output .= html_writer::end_tag('div');
- $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
- $postsubject = $post->subject;
- if (empty($post->subjectnoformat)) {
- $postsubject = format_string($postsubject);
- }
- $output .= html_writer::tag('div', $postsubject, array('class'=>'subject'));
- $by = new stdClass();
- $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
- $by->date = userdate($post->modified);
- $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author'));
- $output .= html_writer::end_tag('div'); //topic
- $output .= html_writer::end_tag('div'); //row
- $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
- $output .= html_writer::start_tag('div', array('class'=>'left'));
- $groupoutput = '';
- if ($groups) {
- $groupoutput = print_group_picture($groups, $course->id, false, true, true);
- }
- if (empty($groupoutput)) {
- $groupoutput = ' ';
- }
- $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
- $output .= html_writer::end_tag('div'); //left side
- $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
- $output .= html_writer::start_tag('div', array('class'=>'content'));
- if (!empty($attachments)) {
- $output .= html_writer::tag('div', $attachments, array('class'=>'attachments'));
- }
- $options = new stdClass;
- $options->para = false;
- $options->trusted = $post->messagetrust;
- $options->context = $modcontext;
- if ($shortenpost) {
- // Prepare shortened version by filtering the text then shortening it.
- $postclass = 'shortenedpost';
- $postcontent = format_text($post->message, $post->messageformat, $options);
- $postcontent = forum_shorten_post($postcontent);
- $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
- $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
- array('class'=>'post-word-count'));
- } else {
- // Prepare whole post
- $postclass = 'fullpost';
- $postcontent = format_text($post->message, $post->messageformat, $options, $course->id);
- if (!empty($highlight)) {
- $postcontent = highlight($highlight, $postcontent);
- }
- if (!empty($forum->displaywordcount)) {
- $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
- array('class'=>'post-word-count'));
- }
- $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
- }
- // Output the post content
- $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
- $output .= html_writer::end_tag('div'); // Content
- $output .= html_writer::end_tag('div'); // Content mask
- $output .= html_writer::end_tag('div'); // Row
- $output .= html_writer::start_tag('div', array('class'=>'row side'));
- $output .= html_writer::tag('div',' ', array('class'=>'left'));
- $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
- // Output ratings
- if (!empty($post->rating)) {
- $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
- }
- // Output the commands
- $commandhtml = array();
- foreach ($commands as $command) {
- if (is_array($command)) {
- $commandhtml[] = html_writer::link($command['url'], $command['text'],$command['attributes']);
- } else {
- $commandhtml[] = $command;
- }
- }
- $output .= html_writer::tag('div', implode(' | ', $commandhtml), array('class'=>'commands'));
- // Output link to post if required
- if ($link) {
- if ($post->replies == 1) {
- $replystring = get_string('repliesone', 'forum', $post->replies);
- } else {
- $replystring = get_string('repliesmany', 'forum', $post->replies);
- }
- $output .= html_writer::start_tag('div', array('class'=>'link'));
- $output .= html_writer::link($discussionlink, get_string('discussthistopic', 'forum'));
- $output .= ' ('.$replystring.')';
- $output .= html_writer::end_tag('div'); // link
- }
- // Output footer if required
- if ($footer) {
- $output .= html_writer::tag('div', $footer, array('class'=>'footer'));
- }
- // Close remaining open divs
- $output .= html_writer::end_tag('div'); // content
- $output .= html_writer::end_tag('div'); // row
- $output .= html_writer::end_tag('div'); // forumpost
- // Mark the forum post as read if required
- if ($istracked && !$CFG->forum_usermarksread && !$postisread) {
- forum_tp_mark_post_read($USER->id, $post, $forum->id);
- }
- if ($return) {
- return $output;
- }
- echo $output;
- return;
- }
- /**
- * Return rating related permissions
- *
- * @param string $options the context id
- * @return array an associative array of the user's rating permissions
- */
- function forum_rating_permissions($contextid, $component, $ratingarea) {
- $context = context::instance_by_id($contextid, MUST_EXIST);
- if ($component != 'mod_forum' || $ratingarea != 'post') {
- // We don't know about this component/ratingarea so just return null to get the
- // default restrictive permissions.
- return null;
- }
- return array(
- 'view' => has_capability('mod/forum:viewrating', $context),
- 'viewany' => has_capability('mod/forum:viewanyrating', $context),
- 'viewall' => has_capability('mod/forum:viewallratings', $context),
- 'rate' => has_capability('mod/forum:rate', $context)
- );
- }
- /**
- * Validates a submitted rating
- * @param array $params submitted data
- * context => object the context in which the rated items exists [required]
- * component => The component for this module - should always be mod_forum [required]
- * ratingarea => object the context in which the rated items exists [required]
- * itemid => int the ID of the object being rated [required]
- * scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
- * rating => int the submitted rating [required]
- * rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
- * aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
- * @return boolean true if the rating is valid. Will throw rating_exception if not
- */
- function forum_rating_validate($params) {
- global $DB, $USER;
- // Check the component is mod_forum
- if ($params['component'] != 'mod_forum') {
- throw new rating_exception('invalidcomponent');
- }
- // Check the ratingarea is post (the only rating area in forum)
- if ($params['ratingarea'] != 'post') {
- throw new rating_exception('invalidratingarea');
- }
- // Check the rateduserid is not the current user .. you can't rate your own posts
- if ($params['rateduserid'] == $USER->id) {
- throw new rating_exception('nopermissiontorate');
- }
- // Fetch all the related records ... we need to do this anyway to call forum_user_can_see_post
- $post = $DB->get_record('forum_posts', array('id' => $params['itemid'], 'userid' => $params['rateduserid']), '*', MUST_EXIST);
- $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion), '*', MUST_EXIST);
- $forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
- $course = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST);
- $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id , false, MUST_EXIST);
- $context = context_module::instance($cm->id);
- // Make sure the context provided is the context of the forum
- if ($context->id != $params['context']->id) {
- throw new rating_exception('invalidcontext');
- }
- if ($forum->scale != $params['scaleid']) {
- //the scale being submitted doesnt match the one in the database
- throw new rating_exception('invalidscaleid');
- }
- // check the item we're rating was created in the assessable time window
- if (!empty($forum->assesstimestart) && !empty($forum->assesstimefinish)) {
- if ($post->created < $forum->assesstimestart || $post->created > $forum->assesstimefinish) {
- throw new rating_exception('notavailable');
- }
- }
- //check that the submitted rating is valid for the scale
- // lower limit
- if ($params['rating'] < 0 && $params['rating'] != RATING_UNSET_RATING) {
- throw new rating_exception('invalidnum');
- }
- // upper limit
- if ($forum->scale < 0) {
- //its a custom scale
- $scalerecord = $DB->get_record('scale', array('id' => -$forum->scale));
- if ($scalerecord) {
- $scalearray = explode(',', $scalerecord->scale);
- if ($params['rating'] > count($scalearray)) {
- throw new rating_exception('invalidnum');
- }
- } else {
- throw new rating_exception('invalidscaleid');
- }
- } else if ($params['rating'] > $forum->scale) {
- //if its numeric and submitted rating is above maximum
- throw new rating_exception('invalidnum');
- }
- // Make sure groups allow this user to see the item they're rating
- if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) { // Groups are being used
- if (!groups_group_exists($discussion->groupid)) { // Can't find group
- throw new rating_exception('cannotfindgroup');//something is wrong
- }
- if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
- // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
- throw new rating_exception('notmemberofgroup');
- }
- }
- // perform some final capability checks
- if (!forum_user_can_see_post($forum, $discussion, $post, $USER, $cm)) {
- throw new rating_exception('nopermissiontorate');
- }
- return true;
- }
- /**
- * This function prints the overview of a discussion in the forum listing.
- * It needs some discussion information and some post information, these
- * happen to be combined for efficiency in the $post parameter by the function
- * that calls this one: forum_print_latest_discussions()
- *
- * @global object
- * @global object
- * @param object $post The post object (passed by reference for speed).
- * @param object $forum The forum object.
- * @param int $group Current group.
- * @param string $datestring Format to use for the dates.
- * @param boolean $cantrack Is tracking enabled for this forum.
- * @param boolean $forumtracked Is the user tracking this forum.
- * @param boolean $canviewparticipants True if user has the viewparticipants permission for this course
- */
- function forum_print_discussion_header(&$post, $forum, $group=-1, $datestring="",
- $cantrack=true, $forumtracked=true, $canviewparticipants=true, $modcontext=NULL) {
- global $USER, $CFG, $OUTPUT;
- static $rowcount;
- static $strmarkalldread;
- if (empty($modcontext)) {
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- $modcontext = context_module::instance($cm->id);
- }
- if (!isset($rowcount)) {
- $rowcount = 0;
- $strmarkalldread = get_string('markalldread', 'forum');
- } else {
- $rowcount = ($rowcount + 1) % 2;
- }
- $post->subject = format_string($post->subject,true);
- echo "\n\n";
- echo '<tr class="discussion r'.$rowcount.'">';
- // Topic
- echo '<td class="topic starter">';
- echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">'.$post->subject.'</a>';
- echo "</td>\n";
- // Picture
- $postuser = new stdClass();
- $postuser->id = $post->userid;
- $postuser->firstname = $post->firstname;
- $postuser->lastname = $post->lastname;
- $postuser->imagealt = $post->imagealt;
- $postuser->picture = $post->picture;
- $postuser->email = $post->email;
- echo '<td class="picture">';
- echo $OUTPUT->user_picture($postuser, array('courseid'=>$forum->course));
- echo "</td>\n";
- // User name
- $fullname = fullname($postuser, has_capability('moodle/site:viewfullnames', $modcontext));
- echo '<td class="author">';
- echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->userid.'&course='.$forum->course.'">'.$fullname.'</a>';
- echo "</td>\n";
- // Group picture
- if ($group !== -1) { // Groups are active - group is a group data object or NULL
- echo '<td class="picture group">';
- if (!empty($group->picture) and empty($group->hidepicture)) {
- print_group_picture($group, $forum->course, false, false, true);
- } else if (isset($group->id)) {
- if($canviewparticipants) {
- echo '<a href="'.$CFG->wwwroot.'/user/index.php?id='.$forum->course.'&group='.$group->id.'">'.$group->name.'</a>';
- } else {
- echo $group->name;
- }
- }
- echo "</td>\n";
- }
- if (has_capability('mod/forum:viewdiscussion', $modcontext)) { // Show the column with replies
- echo '<td class="replies">';
- echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
- echo $post->replies.'</a>';
- echo "</td>\n";
- if ($cantrack) {
- echo '<td class="replies">';
- if ($forumtracked) {
- if ($post->unread > 0) {
- echo '<span class="unread">';
- echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#unread">';
- echo $post->unread;
- echo '</a>';
- echo '<a title="'.$strmarkalldread.'" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
- $forum->id.'&d='.$post->discussion.'&mark=read&returnpage=view.php">' .
- '<img src="'.$OUTPUT->pix_url('t/markasread') . '" class="iconsmall" alt="'.$strmarkalldread.'" /></a>';
- echo '</span>';
- } else {
- echo '<span class="read">';
- echo $post->unread;
- echo '</span>';
- }
- } else {
- echo '<span class="read">';
- echo '-';
- echo '</span>';
- }
- echo "</td>\n";
- }
- }
- echo '<td class="lastpost">';
- $usedate = (empty($post->timemodified)) ? $post->modified : $post->timemodified; // Just in case
- $parenturl = (empty($post->lastpostid)) ? '' : '&parent='.$post->lastpostid;
- $usermodified = new stdClass();
- $usermodified->id = $post->usermodified;
- $usermodified->firstname = $post->umfirstname;
- $usermodified->lastname = $post->umlastname;
- echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->usermodified.'&course='.$forum->course.'">'.
- fullname($usermodified).'</a><br />';
- echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.$parenturl.'">'.
- userdate($usedate, $datestring).'</a>';
- echo "</td>\n";
- echo "</tr>\n\n";
- }
- /**
- * Given a post object that we already know has a long message
- * this function truncates the message nicely to the first
- * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
- *
- * @global object
- * @param string $message
- * @return string
- */
- function forum_shorten_post($message) {
- global $CFG;
- return shorten_text($message, $CFG->forum_shortpost);
- }
- /**
- * Print the drop down that allows the user to select how they want to have
- * the discussion displayed.
- *
- * @param int $id forum id if $forumtype is 'single',
- * discussion id for any other forum type
- * @param mixed $mode forum layout mode
- * @param string $forumtype optional
- */
- function forum_print_mode_form($id, $mode, $forumtype='') {
- global $OUTPUT;
- if ($forumtype == 'single') {
- $select = new single_select(new moodle_url("/mod/forum/view.php", array('f'=>$id)), 'mode', forum_get_layout_modes(), $mode, null, "mode");
- $select->set_label(get_string('displaymode', 'forum'), array('class' => 'accesshide'));
- $select->class = "forummode";
- } else {
- $select = new single_select(new moodle_url("/mod/forum/discuss.php", array('d'=>$id)), 'mode', forum_get_layout_modes(), $mode, null, "mode");
- $select->set_label(get_string('displaymode', 'forum'), array('class' => 'accesshide'));
- }
- echo $OUTPUT->render($select);
- }
- /**
- * @global object
- * @param object $course
- * @param string $search
- * @return string
- */
- function forum_search_form($course, $search='') {
- global $CFG, $OUTPUT;
- $output = '<div class="forumsearch">';
- $output .= '<form action="'.$CFG->wwwroot.'/mod/forum/search.php" style="display:inline">';
- $output .= '<fieldset class="invisiblefieldset">';
- $output .= $OUTPUT->help_icon('search');
- $output .= '<label class="accesshide" for="search" >'.get_string('search', 'forum').'</label>';
- $output .= '<input id="search" name="search" type="text" size="18" value="'.s($search, true).'" alt="search" />';
- $output .= '<label class="accesshide" for="searchforums" >'.get_string('searchforums', 'forum').'</label>';
- $output .= '<input id="searchforums" value="'.get_string('searchforums', 'forum').'" type="submit" />';
- $output .= '<input name="id" type="hidden" value="'.$course->id.'" />';
- $output .= '</fieldset>';
- $output .= '</form>';
- $output .= '</div>';
- return $output;
- }
- /**
- * @global object
- * @global object
- */
- function forum_set_return() {
- global $CFG, $SESSION;
- if (! isset($SESSION->fromdiscussion)) {
- if (!empty($_SERVER['HTTP_REFERER'])) {
- $referer = $_SERVER['HTTP_REFERER'];
- } else {
- $referer = "";
- }
- // If the referer is NOT a login screen then save it.
- if (! strncasecmp("$CFG->wwwroot/login", $referer, 300)) {
- $SESSION->fromdiscussion = $_SERVER["HTTP_REFERER"];
- }
- }
- }
- /**
- * @global object
- * @param string $default
- * @return string
- */
- function forum_go_back_to($default) {
- global $SESSION;
- if (!empty($SESSION->fromdiscussion)) {
- $returnto = $SESSION->fromdiscussion;
- unset($SESSION->fromdiscussion);
- return $returnto;
- } else {
- return $default;
- }
- }
- /**
- * Given a discussion object that is being moved to $forumto,
- * this function checks all posts in that discussion
- * for attachments, and if any are found, these are
- * moved to the new forum directory.
- *
- * @global object
- * @param object $discussion
- * @param int $forumfrom source forum id
- * @param int $forumto target forum id
- * @return bool success
- */
- function forum_move_attachments($discussion, $forumfrom, $forumto) {
- global $DB;
- $fs = get_file_storage();
- $newcm = get_coursemodule_from_instance('forum', $forumto);
- $oldcm = get_coursemodule_from_instance('forum', $forumfrom);
- $newcontext = context_module::instance($newcm->id);
- $oldcontext = context_module::instance($oldcm->id);
- // loop through all posts, better not use attachment flag ;-)
- if ($posts = $DB->get_records('forum_posts', array('discussion'=>$discussion->id), '', 'id, attachment')) {
- foreach ($posts as $post) {
- $fs->move_area_files_to_new_context($oldcontext->id,
- $newcontext->id, 'mod_forum', 'post', $post->id);
- $attachmentsmoved = $fs->move_area_files_to_new_context($oldcontext->id,
- $newcontext->id, 'mod_forum', 'attachment', $post->id);
- if ($attachmentsmoved > 0 && $post->attachment != '1') {
- // Weird - let's fix it
- $post->attachment = '1';
- $DB->update_record('forum_posts', $post);
- } else if ($attachmentsmoved == 0 && $post->attachment != '') {
- // Weird - let's fix it
- $post->attachment = '';
- $DB->update_record('forum_posts', $post);
- }
- }
- }
- return true;
- }
- /**
- * Returns attachments as formated text/html optionally with separate images
- *
- * @global object
- * @global object
- * @global object
- * @param object $post
- * @param object $cm
- * @param string $type html/text/separateimages
- * @return mixed string or array of (html text withouth images and image HTML)
- */
- function forum_print_attachments($post, $cm, $type) {
- global $CFG, $DB, $USER, $OUTPUT;
- if (empty($post->attachment)) {
- return $type !== 'separateimages' ? '' : array('', '');
- }
- if (!in_array($type, array('separateimages', 'html', 'text'))) {
- return $type !== 'separateimages' ? '' : array('', '');
- }
- if (!$context = context_module::instance($cm->id)) {
- return $type !== 'separateimages' ? '' : array('', '');
- }
- $strattachment = get_string('attachment', 'forum');
- $fs = get_file_storage();
- $imagereturn = '';
- $output = '';
- $canexport = !empty($CFG->enableportfolios) && (has_capability('mod/forum:exportpost', $context) || ($post->userid == $USER->id && has_capability('mod/forum:exportownpost', $context)));
- if ($canexport) {
- require_once($CFG->libdir.'/portfoliolib.php');
- }
- $files = $fs->get_area_files($context->id, 'mod_forum', 'attachment', $post->id, "timemodified", false);
- if ($files) {
- if ($canexport) {
- $button = new portfolio_add_button();
- }
- foreach ($files as $file) {
- $filename = $file->get_filename();
- $mimetype = $file->get_mimetype();
- $iconimage = $OUTPUT->pix_icon(file_file_icon($file), get_mimetype_description($file), 'moodle', array('class' => 'icon'));
- $path = file_encode_url($CFG->wwwroot.'/pluginfile.php', '/'.$context->id.'/mod_forum/attachment/'.$post->id.'/'.$filename);
- if ($type == 'html') {
- $output .= "<a href=\"$path\">$iconimage</a> ";
- $output .= "<a href=\"$path\">".s($filename)."</a>";
- if ($canexport) {
- $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id, 'attachment' => $file->get_id()), 'mod_forum');
- $button->set_format_by_file($file);
- $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
- }
- $output .= "<br />";
- } else if ($type == 'text') {
- $output .= "$strattachment ".s($filename).":\n$path\n";
- } else { //'returnimages'
- if (in_array($mimetype, array('image/gif', 'image/jpeg', 'image/png'))) {
- // Image attachments don't get printed as links
- $imagereturn .= "<br /><img src=\"$path\" alt=\"\" />";
- if ($canexport) {
- $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id, 'attachment' => $file->get_id()), 'mod_forum');
- $button->set_format_by_file($file);
- $imagereturn .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
- }
- } else {
- $output .= "<a href=\"$path\">$iconimage</a> ";
- $output .= format_text("<a href=\"$path\">".s($filename)."</a>", FORMAT_HTML, array('context'=>$context));
- if ($canexport) {
- $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id, 'attachment' => $file->get_id()), 'mod_forum');
- $button->set_format_by_file($file);
- $output .= $button->to_html(PORTFOLIO_ADD_ICON_LINK);
- }
- $output .= '<br />';
- }
- }
- if (!empty($CFG->enableplagiarism)) {
- require_once($CFG->libdir.'/plagiarismlib.php');
- $output .= plagiarism_get_links(array('userid' => $post->userid,
- 'file' => $file,
- 'cmid' => $cm->id,
- 'course' => $post->course,
- 'forum' => $post->forum));
- $output .= '<br />';
- }
- }
- }
- if ($type !== 'separateimages') {
- return $output;
- } else {
- return array($output, $imagereturn);
- }
- }
- ////////////////////////////////////////////////////////////////////////////////
- // File API //
- ////////////////////////////////////////////////////////////////////////////////
- /**
- * Lists all browsable file areas
- *
- * @package mod_forum
- * @category files
- * @param stdClass $course course object
- * @param stdClass $cm course module object
- * @param stdClass $context context object
- * @return array
- */
- function forum_get_file_areas($course, $cm, $context) {
- return array(
- 'attachment' => get_string('areaattachment', 'mod_forum'),
- 'post' => get_string('areapost', 'mod_forum'),
- );
- }
- /**
- * File browsing support for forum module.
- *
- * @package mod_forum
- * @category files
- * @param stdClass $browser file browser object
- * @param stdClass $areas file areas
- * @param stdClass $course course object
- * @param stdClass $cm course module
- * @param stdClass $context context module
- * @param string $filearea file area
- * @param int $itemid item ID
- * @param string $filepath file path
- * @param string $filename file name
- * @return file_info instance or null if not found
- */
- function forum_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
- global $CFG, $DB, $USER;
- if ($context->contextlevel != CONTEXT_MODULE) {
- return null;
- }
- // filearea must contain a real area
- if (!isset($areas[$filearea])) {
- return null;
- }
- // Note that forum_user_can_see_post() additionally allows access for parent roles
- // and it explicitly checks qanda forum type, too. One day, when we stop requiring
- // course:managefiles, we will need to extend this.
- if (!has_capability('mod/forum:viewdiscussion', $context)) {
- return null;
- }
- if (is_null($itemid)) {
- require_once($CFG->dirroot.'/mod/forum/locallib.php');
- return new forum_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
- }
- static $cached = array();
- // $cached will store last retrieved post, discussion and forum. To make sure that the cache
- // is cleared between unit tests we check if this is the same session
- if (!isset($cached['sesskey']) || $cached['sesskey'] != sesskey()) {
- $cached = array('sesskey' => sesskey());
- }
- if (isset($cached['post']) && $cached['post']->id == $itemid) {
- $post = $cached['post'];
- } else if ($post = $DB->get_record('forum_posts', array('id' => $itemid))) {
- $cached['post'] = $post;
- } else {
- return null;
- }
- if (isset($cached['discussion']) && $cached['discussion']->id == $post->discussion) {
- $discussion = $cached['discussion'];
- } else if ($discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion))) {
- $cached['discussion'] = $discussion;
- } else {
- return null;
- }
- if (isset($cached['forum']) && $cached['forum']->id == $cm->instance) {
- $forum = $cached['forum'];
- } else if ($forum = $DB->get_record('forum', array('id' => $cm->instance))) {
- $cached['forum'] = $forum;
- } else {
- return null;
- }
- $fs = get_file_storage();
- $filepath = is_null($filepath) ? '/' : $filepath;
- $filename = is_null($filename) ? '.' : $filename;
- if (!($storedfile = $fs->get_file($context->id, 'mod_forum', $filearea, $itemid, $filepath, $filename))) {
- return null;
- }
- // Checks to see if the user can manage files or is the owner.
- // TODO MDL-33805 - Do not use userid here and move the capability check above.
- if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
- return null;
- }
- // Make sure groups allow this user to see this file
- if ($discussion->groupid > 0 && !has_capability('moodle/site:accessallgroups', $context)) {
- $groupmode = groups_get_activity_groupmode($cm, $course);
- if ($groupmode == SEPARATEGROUPS && !groups_is_member($discussion->groupid)) {
- return null;
- }
- }
- // Make sure we're allowed to see it...
- if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
- return null;
- }
- $urlbase = $CFG->wwwroot.'/pluginfile.php';
- return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
- }
- /**
- * Serves the forum attachments. Implements needed access control ;-)
- *
- * @package mod_forum
- * @category files
- * @param stdClass $course course object
- * @param stdClass $cm course module object
- * @param stdClass $context context object
- * @param string $filearea file area
- * @param array $args extra arguments
- * @param bool $forcedownload whether or not force download
- * @param array $options additional options affecting the file serving
- * @return bool false if file not found, does not return if found - justsend the file
- */
- function forum_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
- global $CFG, $DB;
- if ($context->contextlevel != CONTEXT_MODULE) {
- return false;
- }
- require_course_login($course, true, $cm);
- $areas = forum_get_file_areas($course, $cm, $context);
- // filearea must contain a real area
- if (!isset($areas[$filearea])) {
- return false;
- }
- $postid = (int)array_shift($args);
- if (!$post = $DB->get_record('forum_posts', array('id'=>$postid))) {
- return false;
- }
- if (!$discussion = $DB->get_record('forum_discussions', array('id'=>$post->discussion))) {
- return false;
- }
- if (!$forum = $DB->get_record('forum', array('id'=>$cm->instance))) {
- return false;
- }
- $fs = get_file_storage();
- $relativepath = implode('/', $args);
- $fullpath = "/$context->id/mod_forum/$filearea/$postid/$relativepath";
- if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
- return false;
- }
- // Make sure groups allow this user to see this file
- if ($discussion->groupid > 0) {
- $groupmode = groups_get_activity_groupmode($cm, $course);
- if ($groupmode == SEPARATEGROUPS) {
- if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
- return false;
- }
- }
- }
- // Make sure we're allowed to see it...
- if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
- return false;
- }
- // finally send the file
- send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
- }
- /**
- * If successful, this function returns the name of the file
- *
- * @global object
- * @param object $post is a full post record, including course and forum
- * @param object $forum
- * @param object $cm
- * @param mixed $mform
- * @param string $unused
- * @return bool
- */
- function forum_add_attachment($post, $forum, $cm, $mform=null, $unused=null) {
- global $DB;
- if (empty($mform)) {
- return false;
- }
- if (empty($post->attachments)) {
- return true; // Nothing to do
- }
- $context = context_module::instance($cm->id);
- $info = file_get_draft_area_info($post->attachments);
- $present = ($info['filecount']>0) ? '1' : '';
- file_save_draft_area_files($post->attachments, $context->id, 'mod_forum', 'attachment', $post->id,
- mod_forum_post_form::attachment_options($forum));
- $DB->set_field('forum_posts', 'attachment', $present, array('id'=>$post->id));
- return true;
- }
- /**
- * Add a new post in an existing discussion.
- *
- * @global object
- * @global object
- * @global object
- * @param object $post
- * @param mixed $mform
- * @param string $message
- * @return int
- */
- function forum_add_new_post($post, $mform, &$message) {
- global $USER, $CFG, $DB;
- $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion));
- $forum = $DB->get_record('forum', array('id' => $discussion->forum));
- $cm = get_coursemodule_from_instance('forum', $forum->id);
- $context = context_module::instance($cm->id);
- $post->created = $post->modified = time();
- $post->mailed = FORUM_MAILED_PENDING;
- $post->userid = $USER->id;
- $post->attachment = "";
- $post->id = $DB->insert_record("forum_posts", $post);
- $post->message = file_save_draft_area_files($post->itemid, $context->id, 'mod_forum', 'post', $post->id,
- mod_forum_post_form::editor_options(), $post->message);
- $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
- forum_add_attachment($post, $forum, $cm, $mform, $message);
- // Update discussion modified date
- $DB->set_field("forum_discussions", "timemodified", $post->modified, array("id" => $post->discussion));
- $DB->set_field("forum_discussions", "usermodified", $post->userid, array("id" => $post->discussion));
- if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
- forum_tp_mark_post_read($post->userid, $post, $post->forum);
- }
- // Let Moodle know that assessable content is uploaded (eg for plagiarism detection)
- forum_trigger_content_uploaded_event($post, $cm, 'forum_add_new_post');
- return $post->id;
- }
- /**
- * Update a post
- *
- * @global object
- * @global object
- * @global object
- * @param object $post
- * @param mixed $mform
- * @param string $message
- * @return bool
- */
- function forum_update_post($post, $mform, &$message) {
- global $USER, $CFG, $DB;
- $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion));
- $forum = $DB->get_record('forum', array('id' => $discussion->forum));
- $cm = get_coursemodule_from_instance('forum', $forum->id);
- $context = context_module::instance($cm->id);
- $post->modified = time();
- $DB->update_record('forum_posts', $post);
- $discussion->timemodified = $post->modified; // last modified tracking
- $discussion->usermodified = $post->userid; // last modified tracking
- if (!$post->parent) { // Post is a discussion starter - update discussion title and times too
- $discussion->name = $post->subject;
- $discussion->timestart = $post->timestart;
- $discussion->timeend = $post->timeend;
- }
- $post->message = file_save_draft_area_files($post->itemid, $context->id, 'mod_forum', 'post', $post->id,
- mod_forum_post_form::editor_options(), $post->message);
- $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
- $DB->update_record('forum_discussions', $discussion);
- forum_add_attachment($post, $forum, $cm, $mform, $message);
- if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
- forum_tp_mark_post_read($post->userid, $post, $post->forum);
- }
- // Let Moodle know that assessable content is uploaded (eg for plagiarism detection)
- forum_trigger_content_uploaded_event($post, $cm, 'forum_update_post');
- return true;
- }
- /**
- * Given an object containing all the necessary data,
- * create a new discussion and return the id
- *
- * @param object $post
- * @param mixed $mform
- * @param string $unused
- * @param int $userid
- * @return object
- */
- function forum_add_discussion($discussion, $mform=null, $unused=null, $userid=null) {
- global $USER, $CFG, $DB;
- $timenow = time();
- if (is_null($userid)) {
- $userid = $USER->id;
- }
- // The first post is stored as a real post, and linked
- // to from the discuss entry.
- $forum = $DB->get_record('forum', array('id'=>$discussion->forum));
- $cm = get_coursemodule_from_instance('forum', $forum->id);
- $post = new stdClass();
- $post->discussion = 0;
- $post->parent = 0;
- $post->userid = $userid;
- $post->created = $timenow;
- $post->modified = $timenow;
- $post->mailed = FORUM_MAILED_PENDING;
- $post->subject = $discussion->name;
- $post->message = $discussion->message;
- $post->messageformat = $discussion->messageformat;
- $post->messagetrust = $discussion->messagetrust;
- $post->attachments = isset($discussion->attachments) ? $discussion->attachments : null;
- $post->forum = $forum->id; // speedup
- $post->course = $forum->course; // speedup
- $post->mailnow = $discussion->mailnow;
- $post->id = $DB->insert_record("forum_posts", $post);
- // TODO: Fix the calling code so that there always is a $cm when this function is called
- if (!empty($cm->id) && !empty($discussion->itemid)) { // In "single simple discussions" this may not exist yet
- $context = context_module::instance($cm->id);
- $text = file_save_draft_area_files($discussion->itemid, $context->id, 'mod_forum', 'post', $post->id,
- mod_forum_post_form::editor_options(), $post->message);
- $DB->set_field('forum_posts', 'message', $text, array('id'=>$post->id));
- }
- // Now do the main entry for the discussion, linking to this first post
- $discussion->firstpost = $post->id;
- $discussion->timemodified = $timenow;
- $discussion->usermodified = $post->userid;
- $discussion->userid = $userid;
- $post->discussion = $DB->insert_record("forum_discussions", $discussion);
- // Finally, set the pointer on the post.
- $DB->set_field("forum_posts", "discussion", $post->discussion, array("id"=>$post->id));
- if (!empty($cm->id)) {
- forum_add_attachment($post, $forum, $cm, $mform, $unused);
- }
- if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
- forum_tp_mark_post_read($post->userid, $post, $post->forum);
- }
- // Let Moodle know that assessable content is uploaded (eg for plagiarism detection)
- if (!empty($cm->id)) {
- forum_trigger_content_uploaded_event($post, $cm, 'forum_add_discussion');
- }
- return $post->discussion;
- }
- /**
- * Deletes a discussion and handles all associated cleanup.
- *
- * @global object
- * @param object $discussion Discussion to delete
- * @param bool $fulldelete True when deleting entire forum
- * @param object $course Course
- * @param object $cm Course-module
- * @param object $forum Forum
- * @return bool
- */
- function forum_delete_discussion($discussion, $fulldelete, $course, $cm, $forum) {
- global $DB, $CFG;
- require_once($CFG->libdir.'/completionlib.php');
- $result = true;
- if ($posts = $DB->get_records("forum_posts", array("discussion" => $discussion->id))) {
- foreach ($posts as $post) {
- $post->course = $discussion->course;
- $post->forum = $discussion->forum;
- if (!forum_delete_post($post, 'ignore', $course, $cm, $forum, $fulldelete)) {
- $result = false;
- }
- }
- }
- forum_tp_delete_read_records(-1, -1, $discussion->id);
- if (!$DB->delete_records("forum_discussions", array("id"=>$discussion->id))) {
- $result = false;
- }
- // Update completion state if we are tracking completion based on number of posts
- // But don't bother when deleting whole thing
- if (!$fulldelete) {
- $completion = new completion_info($course);
- if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC &&
- ($forum->completiondiscussions || $forum->completionreplies || $forum->completionposts)) {
- $completion->update_state($cm, COMPLETION_INCOMPLETE, $discussion->userid);
- }
- }
- return $result;
- }
- /**
- * Deletes a single forum post.
- *
- * @global object
- * @param object $post Forum post object
- * @param mixed $children Whether to delete children. If false, returns false
- * if there are any children (without deleting the post). If true,
- * recursively deletes all children. If set to special value 'ignore', deletes
- * post regardless of children (this is for use only when deleting all posts
- * in a disussion).
- * @param object $course Course
- * @param object $cm Course-module
- * @param object $forum Forum
- * @param bool $skipcompletion True to skip updating completion state if it
- * would otherwise be updated, i.e. when deleting entire forum anyway.
- * @return bool
- */
- function forum_delete_post($post, $children, $course, $cm, $forum, $skipcompletion=false) {
- global $DB, $CFG;
- require_once($CFG->libdir.'/completionlib.php');
- $context = context_module::instance($cm->id);
- if ($children !== 'ignore' && ($childposts = $DB->get_records('forum_posts', array('parent'=>$post->id)))) {
- if ($children) {
- foreach ($childposts as $childpost) {
- forum_delete_post($childpost, true, $course, $cm, $forum, $skipcompletion);
- }
- } else {
- return false;
- }
- }
- // Delete ratings.
- require_once($CFG->dirroot.'/rating/lib.php');
- $delopt = new stdClass;
- $delopt->contextid = $context->id;
- $delopt->component = 'mod_forum';
- $delopt->ratingarea = 'post';
- $delopt->itemid = $post->id;
- $rm = new rating_manager();
- $rm->delete_ratings($delopt);
- // Delete attachments.
- $fs = get_file_storage();
- $fs->delete_area_files($context->id, 'mod_forum', 'attachment', $post->id);
- $fs->delete_area_files($context->id, 'mod_forum', 'post', $post->id);
- // Delete cached RSS feeds.
- if (!empty($CFG->enablerssfeeds)) {
- require_once($CFG->dirroot.'/mod/forum/rsslib.php');
- forum_rss_delete_file($forum);
- }
- if ($DB->delete_records("forum_posts", array("id" => $post->id))) {
- forum_tp_delete_read_records(-1, $post->id);
- // Just in case we are deleting the last post
- forum_discussion_update_last_post($post->discussion);
- // Update completion state if we are tracking completion based on number of posts
- // But don't bother when deleting whole thing
- if (!$skipcompletion) {
- $completion = new completion_info($course);
- if ($completion->is_enabled($cm) == COMPLETION_TRACKING_AUTOMATIC &&
- ($forum->completiondiscussions || $forum->completionreplies || $forum->completionposts)) {
- $completion->update_state($cm, COMPLETION_INCOMPLETE, $post->userid);
- }
- }
- return true;
- }
- return false;
- }
- /**
- * Sends post content to plagiarism plugin
- * @param object $post Forum post object
- * @param object $cm Course-module
- * @param string $name
- * @return bool
- */
- function forum_trigger_content_uploaded_event($post, $cm, $name) {
- $context = context_module::instance($cm->id);
- $fs = get_file_storage();
- $files = $fs->get_area_files($context->id, 'mod_forum', 'attachment', $post->id, "timemodified", false);
- $eventdata = new stdClass();
- $eventdata->modulename = 'forum';
- $eventdata->name = $name;
- $eventdata->cmid = $cm->id;
- $eventdata->itemid = $post->id;
- $eventdata->courseid = $post->course;
- $eventdata->userid = $post->userid;
- $eventdata->content = $post->message;
- if ($files) {
- $eventdata->pathnamehashes = array_keys($files);
- }
- events_trigger('assessable_content_uploaded', $eventdata);
- return true;
- }
- /**
- * @global object
- * @param object $post
- * @param bool $children
- * @return int
- */
- function forum_count_replies($post, $children=true) {
- global $DB;
- $count = 0;
- if ($children) {
- if ($childposts = $DB->get_records('forum_posts', array('parent' => $post->id))) {
- foreach ($childposts as $childpost) {
- $count ++; // For this child
- $count += forum_count_replies($childpost, true);
- }
- }
- } else {
- $count += $DB->count_records('forum_posts', array('parent' => $post->id));
- }
- return $count;
- }
- /**
- * @global object
- * @param int $forumid
- * @param mixed $value
- * @return bool
- */
- function forum_forcesubscribe($forumid, $value=1) {
- global $DB;
- return $DB->set_field("forum", "forcesubscribe", $value, array("id" => $forumid));
- }
- /**
- * @global object
- * @param object $forum
- * @return bool
- */
- function forum_is_forcesubscribed($forum) {
- global $DB;
- if (isset($forum->forcesubscribe)) { // then we use that
- return ($forum->forcesubscribe == FORUM_FORCESUBSCRIBE);
- } else { // Check the database
- return ($DB->get_field('forum', 'forcesubscribe', array('id' => $forum)) == FORUM_FORCESUBSCRIBE);
- }
- }
- function forum_get_forcesubscribed($forum) {
- global $DB;
- if (isset($forum->forcesubscribe)) { // then we use that
- return $forum->forcesubscribe;
- } else { // Check the database
- return $DB->get_field('forum', 'forcesubscribe', array('id' => $forum));
- }
- }
- /**
- * @global object
- * @param int $userid
- * @param object $forum
- * @return bool
- */
- function forum_is_subscribed($userid, $forum) {
- global $DB;
- if (is_numeric($forum)) {
- $forum = $DB->get_record('forum', array('id' => $forum));
- }
- // If forum is force subscribed and has allowforcesubscribe, then user is subscribed.
- $cm = get_coursemodule_from_instance('forum', $forum->id);
- if (forum_is_forcesubscribed($forum) && $cm &&
- has_capability('mod/forum:allowforcesubscribe', context_module::instance($cm->id), $userid)) {
- return true;
- }
- return $DB->record_exists("forum_subscriptions", array("userid" => $userid, "forum" => $forum->id));
- }
- function forum_get_subscribed_forums($course) {
- global $USER, $CFG, $DB;
- $sql = "SELECT f.id
- FROM {forum} f
- LEFT JOIN {forum_subscriptions} fs ON (fs.forum = f.id AND fs.userid = ?)
- WHERE f.course = ?
- AND f.forcesubscribe <> ".FORUM_DISALLOWSUBSCRIBE."
- AND (f.forcesubscribe = ".FORUM_FORCESUBSCRIBE." OR fs.id IS NOT NULL)";
- if ($subscribed = $DB->get_records_sql($sql, array($USER->id, $course->id))) {
- foreach ($subscribed as $s) {
- $subscribed[$s->id] = $s->id;
- }
- return $subscribed;
- } else {
- return array();
- }
- }
- /**
- * Returns an array of forums that the current user is subscribed to and is allowed to unsubscribe from
- *
- * @return array An array of unsubscribable forums
- */
- function forum_get_optional_subscribed_forums() {
- global $USER, $DB;
- // Get courses that $USER is enrolled in and can see
- $courses = enrol_get_my_courses();
- if (empty($courses)) {
- return array();
- }
- $courseids = array();
- foreach($courses as $course) {
- $courseids[] = $course->id;
- }
- list($coursesql, $courseparams) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED, 'c');
- // get all forums from the user's courses that they are subscribed to and which are not set to forced
- $sql = "SELECT f.id, cm.id as cm, cm.visible
- FROM {forum} f
- JOIN {course_modules} cm ON cm.instance = f.id
- JOIN {modules} m ON m.name = :modulename AND m.id = cm.module
- LEFT JOIN {forum_subscriptions} fs ON (fs.forum = f.id AND fs.userid = :userid)
- WHERE f.forcesubscribe <> :forcesubscribe AND fs.id IS NOT NULL
- AND cm.course $coursesql";
- $params = array_merge($courseparams, array('modulename'=>'forum', 'userid'=>$USER->id, 'forcesubscribe'=>FORUM_FORCESUBSCRIBE));
- if (!$forums = $DB->get_records_sql($sql, $params)) {
- return array();
- }
- $unsubscribableforums = array(); // Array to return
- foreach($forums as $forum) {
- if (empty($forum->visible)) {
- // the forum is hidden
- $context = context_module::instance($forum->cm);
- if (!has_capability('moodle/course:viewhiddenactivities', $context)) {
- // the user can't see the hidden forum
- continue;
- }
- }
- // subscribe.php only requires 'mod/forum:managesubscriptions' when
- // unsubscribing a user other than yourself so we don't require it here either
- // A check for whether the forum has subscription set to forced is built into the SQL above
- $unsubscribableforums[] = $forum;
- }
- return $unsubscribableforums;
- }
- /**
- * Adds user to the subscriber list
- *
- * @global object
- * @param int $userid
- * @param int $forumid
- */
- function forum_subscribe($userid, $forumid) {
- global $DB;
- if ($DB->record_exists("forum_subscriptions", array("userid"=>$userid, "forum"=>$forumid))) {
- return true;
- }
- $sub = new stdClass();
- $sub->userid = $userid;
- $sub->forum = $forumid;
- return $DB->insert_record("forum_subscriptions", $sub);
- }
- /**
- * Removes user from the subscriber list
- *
- * @global object
- * @param int $userid
- * @param int $forumid
- */
- function forum_unsubscribe($userid, $forumid) {
- global $DB;
- return $DB->delete_records("forum_subscriptions", array("userid"=>$userid, "forum"=>$forumid));
- }
- /**
- * Given a new post, subscribes or unsubscribes as appropriate.
- * Returns some text which describes what happened.
- *
- * @global objec
- * @param object $post
- * @param object $forum
- */
- function forum_post_subscription($post, $forum) {
- global $USER;
- $action = '';
- $subscribed = forum_is_subscribed($USER->id, $forum);
- if ($forum->forcesubscribe == FORUM_FORCESUBSCRIBE) { // database ignored
- return "";
- } elseif (($forum->forcesubscribe == FORUM_DISALLOWSUBSCRIBE)
- && !has_capability('moodle/course:manageactivities', context_course::instance($forum->course), $USER->id)) {
- if ($subscribed) {
- $action = 'unsubscribe'; // sanity check, following MDL-14558
- } else {
- return "";
- }
- } else { // go with the user's choice
- if (isset($post->subscribe)) {
- // no change
- if ((!empty($post->subscribe) && $subscribed)
- || (empty($post->subscribe) && !$subscribed)) {
- return "";
- } elseif (!empty($post->subscribe) && !$subscribed) {
- $action = 'subscribe';
- } elseif (empty($post->subscribe) && $subscribed) {
- $action = 'unsubscribe';
- }
- }
- }
- $info = new stdClass();
- $info->name = fullname($USER);
- $info->forum = format_string($forum->name);
- switch ($action) {
- case 'subscribe':
- forum_subscribe($USER->id, $post->forum);
- return "<p>".get_string("nowsubscribed", "forum", $info)."</p>";
- case 'unsubscribe':
- forum_unsubscribe($USER->id, $post->forum);
- return "<p>".get_string("nownotsubscribed", "forum", $info)."</p>";
- }
- }
- /**
- * Generate and return the subscribe or unsubscribe link for a forum.
- *
- * @param object $forum the forum. Fields used are $forum->id and $forum->forcesubscribe.
- * @param object $context the context object for this forum.
- * @param array $messages text used for the link in its various states
- * (subscribed, unsubscribed, forcesubscribed or cantsubscribe).
- * Any strings not passed in are taken from the $defaultmessages array
- * at the top of the function.
- * @param bool $cantaccessagroup
- * @param bool $fakelink
- * @param bool $backtoindex
- * @param array $subscribed_forums
- * @return string
- */
- function forum_get_subscribe_link($forum, $context, $messages = array(), $cantaccessagroup = false, $fakelink=true, $backtoindex=false, $subscribed_forums=null) {
- global $CFG, $USER, $PAGE, $OUTPUT;
- $defaultmessages = array(
- 'subscribed' => get_string('unsubscribe', 'forum'),
- 'unsubscribed' => get_string('subscribe', 'forum'),
- 'cantaccessgroup' => get_string('no'),
- 'forcesubscribed' => get_string('everyoneissubscribed', 'forum'),
- 'cantsubscribe' => get_string('disallowsubscribe','forum')
- );
- $messages = $messages + $defaultmessages;
- if (forum_is_forcesubscribed($forum)) {
- return $messages['forcesubscribed'];
- } else if ($forum->forcesubscribe == FORUM_DISALLOWSUBSCRIBE && !has_capability('mod/forum:managesubscriptions', $context)) {
- return $messages['cantsubscribe'];
- } else if ($cantaccessagroup) {
- return $messages['cantaccessgroup'];
- } else {
- if (!is_enrolled($context, $USER, '', true)) {
- return '';
- }
- if (is_null($subscribed_forums)) {
- $subscribed = forum_is_subscribed($USER->id, $forum);
- } else {
- $subscribed = !empty($subscribed_forums[$forum->id]);
- }
- if ($subscribed) {
- $linktext = $messages['subscribed'];
- $linktitle = get_string('subscribestop', 'forum');
- } else {
- $linktext = $messages['unsubscribed'];
- $linktitle = get_string('subscribestart', 'forum');
- }
- $options = array();
- if ($backtoindex) {
- $backtoindexlink = '&backtoindex=1';
- $options['backtoindex'] = 1;
- } else {
- $backtoindexlink = '';
- }
- $link = '';
- if ($fakelink) {
- $PAGE->requires->js('/mod/forum/forum.js');
- $PAGE->requires->js_function_call('forum_produce_subscribe_link', array($forum->id, $backtoindexlink, $linktext, $linktitle));
- $link = "<noscript>";
- }
- $options['id'] = $forum->id;
- $options['sesskey'] = sesskey();
- $url = new moodle_url('/mod/forum/subscribe.php', $options);
- $link .= $OUTPUT->single_button($url, $linktext, 'get', array('title'=>$linktitle));
- if ($fakelink) {
- $link .= '</noscript>';
- }
- return $link;
- }
- }
- /**
- * Generate and return the track or no track link for a forum.
- *
- * @global object
- * @global object
- * @global object
- * @param object $forum the forum. Fields used are $forum->id and $forum->forcesubscribe.
- * @param array $messages
- * @param bool $fakelink
- * @return string
- */
- function forum_get_tracking_link($forum, $messages=array(), $fakelink=true) {
- global $CFG, $USER, $PAGE, $OUTPUT;
- static $strnotrackforum, $strtrackforum;
- if (isset($messages['trackforum'])) {
- $strtrackforum = $messages['trackforum'];
- }
- if (isset($messages['notrackforum'])) {
- $strnotrackforum = $messages['notrackforum'];
- }
- if (empty($strtrackforum)) {
- $strtrackforum = get_string('trackforum', 'forum');
- }
- if (empty($strnotrackforum)) {
- $strnotrackforum = get_string('notrackforum', 'forum');
- }
- if (forum_tp_is_tracked($forum)) {
- $linktitle = $strnotrackforum;
- $linktext = $strnotrackforum;
- } else {
- $linktitle = $strtrackforum;
- $linktext = $strtrackforum;
- }
- $link = '';
- if ($fakelink) {
- $PAGE->requires->js('/mod/forum/forum.js');
- $PAGE->requires->js_function_call('forum_produce_tracking_link', Array($forum->id, $linktext, $linktitle));
- // use <noscript> to print button in case javascript is not enabled
- $link .= '<noscript>';
- }
- $url = new moodle_url('/mod/forum/settracking.php', array('id'=>$forum->id));
- $link .= $OUTPUT->single_button($url, $linktext, 'get', array('title'=>$linktitle));
- if ($fakelink) {
- $link .= '</noscript>';
- }
- return $link;
- }
- /**
- * Returns true if user created new discussion already
- *
- * @global object
- * @global object
- * @param int $forumid
- * @param int $userid
- * @return bool
- */
- function forum_user_has_posted_discussion($forumid, $userid) {
- global $CFG, $DB;
- $sql = "SELECT 'x'
- FROM {forum_discussions} d, {forum_posts} p
- WHERE d.forum = ? AND p.discussion = d.id AND p.parent = 0 and p.userid = ?";
- return $DB->record_exists_sql($sql, array($forumid, $userid));
- }
- /**
- * @global object
- * @global object
- * @param int $forumid
- * @param int $userid
- * @return array
- */
- function forum_discussions_user_has_posted_in($forumid, $userid) {
- global $CFG, $DB;
- $haspostedsql = "SELECT d.id AS id,
- d.*
- FROM {forum_posts} p,
- {forum_discussions} d
- WHERE p.discussion = d.id
- AND d.forum = ?
- AND p.userid = ?";
- return $DB->get_records_sql($haspostedsql, array($forumid, $userid));
- }
- /**
- * @global object
- * @global object
- * @param int $forumid
- * @param int $did
- * @param int $userid
- * @return bool
- */
- function forum_user_has_posted($forumid, $did, $userid) {
- global $DB;
- if (empty($did)) {
- // posted in any forum discussion?
- $sql = "SELECT 'x'
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- WHERE p.userid = :userid AND d.forum = :forumid";
- return $DB->record_exists_sql($sql, array('forumid'=>$forumid,'userid'=>$userid));
- } else {
- return $DB->record_exists('forum_posts', array('discussion'=>$did,'userid'=>$userid));
- }
- }
- /**
- * Returns creation time of the first user's post in given discussion
- * @global object $DB
- * @param int $did Discussion id
- * @param int $userid User id
- * @return int|bool post creation time stamp or return false
- */
- function forum_get_user_posted_time($did, $userid) {
- global $DB;
- $posttime = $DB->get_field('forum_posts', 'MIN(created)', array('userid'=>$userid, 'discussion'=>$did));
- if (empty($posttime)) {
- return false;
- }
- return $posttime;
- }
- /**
- * @global object
- * @param object $forum
- * @param object $currentgroup
- * @param int $unused
- * @param object $cm
- * @param object $context
- * @return bool
- */
- function forum_user_can_post_discussion($forum, $currentgroup=null, $unused=-1, $cm=NULL, $context=NULL) {
- // $forum is an object
- global $USER;
- // shortcut - guest and not-logged-in users can not post
- if (isguestuser() or !isloggedin()) {
- return false;
- }
- if (!$cm) {
- debugging('missing cm', DEBUG_DEVELOPER);
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- }
- if (!$context) {
- $context = context_module::instance($cm->id);
- }
- if ($currentgroup === null) {
- $currentgroup = groups_get_activity_group($cm);
- }
- $groupmode = groups_get_activity_groupmode($cm);
- if ($forum->type == 'news') {
- $capname = 'mod/forum:addnews';
- } else if ($forum->type == 'qanda') {
- $capname = 'mod/forum:addquestion';
- } else {
- $capname = 'mod/forum:startdiscussion';
- }
- if (!has_capability($capname, $context)) {
- return false;
- }
- if ($forum->type == 'single') {
- return false;
- }
- if ($forum->type == 'eachuser') {
- if (forum_user_has_posted_discussion($forum->id, $USER->id)) {
- return false;
- }
- }
- if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
- return true;
- }
- if ($currentgroup) {
- return groups_is_member($currentgroup);
- } else {
- // no group membership and no accessallgroups means no new discussions
- // reverted to 1.7 behaviour in 1.9+, buggy in 1.8.0-1.9.0
- return false;
- }
- }
- /**
- * This function checks whether the user can reply to posts in a forum
- * discussion. Use forum_user_can_post_discussion() to check whether the user
- * can start discussions.
- *
- * @global object
- * @global object
- * @uses DEBUG_DEVELOPER
- * @uses CONTEXT_MODULE
- * @uses VISIBLEGROUPS
- * @param object $forum forum object
- * @param object $discussion
- * @param object $user
- * @param object $cm
- * @param object $course
- * @param object $context
- * @return bool
- */
- function forum_user_can_post($forum, $discussion, $user=NULL, $cm=NULL, $course=NULL, $context=NULL) {
- global $USER, $DB;
- if (empty($user)) {
- $user = $USER;
- }
- // shortcut - guest and not-logged-in users can not post
- if (isguestuser($user) or empty($user->id)) {
- return false;
- }
- if (!isset($discussion->groupid)) {
- debugging('incorrect discussion parameter', DEBUG_DEVELOPER);
- return false;
- }
- if (!$cm) {
- debugging('missing cm', DEBUG_DEVELOPER);
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- }
- if (!$course) {
- debugging('missing course', DEBUG_DEVELOPER);
- if (!$course = $DB->get_record('course', array('id' => $forum->course))) {
- print_error('invalidcourseid');
- }
- }
- if (!$context) {
- $context = context_module::instance($cm->id);
- }
- // normal users with temporary guest access can not post, suspended users can not post either
- if (!is_viewing($context, $user->id) and !is_enrolled($context, $user->id, '', true)) {
- return false;
- }
- if ($forum->type == 'news') {
- $capname = 'mod/forum:replynews';
- } else {
- $capname = 'mod/forum:replypost';
- }
- if (!has_capability($capname, $context, $user->id)) {
- return false;
- }
- if (!$groupmode = groups_get_activity_groupmode($cm, $course)) {
- return true;
- }
- if (has_capability('moodle/site:accessallgroups', $context)) {
- return true;
- }
- if ($groupmode == VISIBLEGROUPS) {
- if ($discussion->groupid == -1) {
- // allow students to reply to all participants discussions - this was not possible in Moodle <1.8
- return true;
- }
- return groups_is_member($discussion->groupid);
- } else {
- //separate groups
- if ($discussion->groupid == -1) {
- return false;
- }
- return groups_is_member($discussion->groupid);
- }
- }
- /**
- * Checks to see if a user can view a particular post.
- *
- * @deprecated since Moodle 2.4 use forum_user_can_see_post() instead
- *
- * @param object $post
- * @param object $course
- * @param object $cm
- * @param object $forum
- * @param object $discussion
- * @param object $user
- * @return boolean
- */
- function forum_user_can_view_post($post, $course, $cm, $forum, $discussion, $user=null){
- debugging('forum_user_can_view_post() is deprecated. Please use forum_user_can_see_post() instead.', DEBUG_DEVELOPER);
- return forum_user_can_see_post($forum, $discussion, $post, $user, $cm);
- }
- /**
- * Check to ensure a user can view a timed discussion.
- *
- * @param object $discussion
- * @param object $user
- * @param object $context
- * @return boolean returns true if they can view post, false otherwise
- */
- function forum_user_can_see_timed_discussion($discussion, $user, $context) {
- global $CFG;
- // Check that the user can view a discussion that is normally hidden due to access times.
- if (!empty($CFG->forum_enabletimedposts)) {
- $time = time();
- if (($discussion->timestart != 0 && $discussion->timestart > $time)
- || ($discussion->timeend != 0 && $discussion->timeend < $time)) {
- if (!has_capability('mod/forum:viewhiddentimedposts', $context, $user->id)) {
- return false;
- }
- }
- }
- return true;
- }
- /**
- * Check to ensure a user can view a group discussion.
- *
- * @param object $discussion
- * @param object $cm
- * @param object $context
- * @return boolean returns true if they can view post, false otherwise
- */
- function forum_user_can_see_group_discussion($discussion, $cm, $context) {
- // If it's a grouped discussion, make sure the user is a member.
- if ($discussion->groupid > 0) {
- $groupmode = groups_get_activity_groupmode($cm);
- if ($groupmode == SEPARATEGROUPS) {
- return groups_is_member($discussion->groupid) || has_capability('moodle/site:accessallgroups', $context);
- }
- }
- return true;
- }
- /**
- * @global object
- * @global object
- * @uses DEBUG_DEVELOPER
- * @param object $forum
- * @param object $discussion
- * @param object $context
- * @param object $user
- * @return bool
- */
- function forum_user_can_see_discussion($forum, $discussion, $context, $user=NULL) {
- global $USER, $DB;
- if (empty($user) || empty($user->id)) {
- $user = $USER;
- }
- // retrieve objects (yuk)
- if (is_numeric($forum)) {
- debugging('missing full forum', DEBUG_DEVELOPER);
- if (!$forum = $DB->get_record('forum',array('id'=>$forum))) {
- return false;
- }
- }
- if (is_numeric($discussion)) {
- debugging('missing full discussion', DEBUG_DEVELOPER);
- if (!$discussion = $DB->get_record('forum_discussions',array('id'=>$discussion))) {
- return false;
- }
- }
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- if (!has_capability('mod/forum:viewdiscussion', $context)) {
- return false;
- }
- if (!forum_user_can_see_timed_discussion($discussion, $user, $context)) {
- return false;
- }
- if (!forum_user_can_see_group_discussion($discussion, $cm, $context)) {
- return false;
- }
- if ($forum->type == 'qanda' &&
- !forum_user_has_posted($forum->id, $discussion->id, $user->id) &&
- !has_capability('mod/forum:viewqandawithoutposting', $context)) {
- return false;
- }
- return true;
- }
- /**
- * @global object
- * @global object
- * @param object $forum
- * @param object $discussion
- * @param object $post
- * @param object $user
- * @param object $cm
- * @return bool
- */
- function forum_user_can_see_post($forum, $discussion, $post, $user=NULL, $cm=NULL) {
- global $CFG, $USER, $DB;
- // Context used throughout function.
- $modcontext = context_module::instance($cm->id);
- // retrieve objects (yuk)
- if (is_numeric($forum)) {
- debugging('missing full forum', DEBUG_DEVELOPER);
- if (!$forum = $DB->get_record('forum',array('id'=>$forum))) {
- return false;
- }
- }
- if (is_numeric($discussion)) {
- debugging('missing full discussion', DEBUG_DEVELOPER);
- if (!$discussion = $DB->get_record('forum_discussions',array('id'=>$discussion))) {
- return false;
- }
- }
- if (is_numeric($post)) {
- debugging('missing full post', DEBUG_DEVELOPER);
- if (!$post = $DB->get_record('forum_posts',array('id'=>$post))) {
- return false;
- }
- }
- if (!isset($post->id) && isset($post->parent)) {
- $post->id = $post->parent;
- }
- if (!$cm) {
- debugging('missing cm', DEBUG_DEVELOPER);
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- }
- if (empty($user) || empty($user->id)) {
- $user = $USER;
- }
- $canviewdiscussion = !empty($cm->cache->caps['mod/forum:viewdiscussion']) || has_capability('mod/forum:viewdiscussion', $modcontext, $user->id);
- if (!$canviewdiscussion && !has_all_capabilities(array('moodle/user:viewdetails', 'moodle/user:readuserposts'), context_user::instance($post->userid))) {
- return false;
- }
- if (isset($cm->uservisible)) {
- if (!$cm->uservisible) {
- return false;
- }
- } else {
- if (!coursemodule_visible_for_user($cm, $user->id)) {
- return false;
- }
- }
- if (!forum_user_can_see_timed_discussion($discussion, $user, $modcontext)) {
- return false;
- }
- if (!forum_user_can_see_group_discussion($discussion, $cm, $modcontext)) {
- return false;
- }
- if ($forum->type == 'qanda') {
- $firstpost = forum_get_firstpost_from_discussion($discussion->id);
- $userfirstpost = forum_get_user_posted_time($discussion->id, $user->id);
- return (($userfirstpost !== false && (time() - $userfirstpost >= $CFG->maxeditingtime)) ||
- $firstpost->id == $post->id || $post->userid == $user->id || $firstpost->userid == $user->id ||
- has_capability('mod/forum:viewqandawithoutposting', $modcontext, $user->id));
- }
- return true;
- }
- /**
- * Prints the discussion view screen for a forum.
- *
- * @global object
- * @global object
- * @param object $course The current course object.
- * @param object $forum Forum to be printed.
- * @param int $maxdiscussions .
- * @param string $displayformat The display format to use (optional).
- * @param string $sort Sort arguments for database query (optional).
- * @param int $groupmode Group mode of the forum (optional).
- * @param void $unused (originally current group)
- * @param int $page Page mode, page to display (optional).
- * @param int $perpage The maximum number of discussions per page(optional)
- *
- */
- function forum_print_latest_discussions($course, $forum, $maxdiscussions=-1, $displayformat='plain', $sort='',
- $currentgroup=-1, $groupmode=-1, $page=-1, $perpage=100, $cm=NULL) {
- global $CFG, $USER, $OUTPUT;
- if (!$cm) {
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
- print_error('invalidcoursemodule');
- }
- }
- $context = context_module::instance($cm->id);
- if (empty($sort)) {
- $sort = "d.timemodified DESC";
- }
- $olddiscussionlink = false;
- // Sort out some defaults
- if ($perpage <= 0) {
- $perpage = 0;
- $page = -1;
- }
- if ($maxdiscussions == 0) {
- // all discussions - backwards compatibility
- $page = -1;
- $perpage = 0;
- if ($displayformat == 'plain') {
- $displayformat = 'header'; // Abbreviate display by default
- }
- } else if ($maxdiscussions > 0) {
- $page = -1;
- $perpage = $maxdiscussions;
- }
- $fullpost = false;
- if ($displayformat == 'plain') {
- $fullpost = true;
- }
- // Decide if current user is allowed to see ALL the current discussions or not
- // First check the group stuff
- if ($currentgroup == -1 or $groupmode == -1) {
- $groupmode = groups_get_activity_groupmode($cm, $course);
- $currentgroup = groups_get_activity_group($cm);
- }
- $groups = array(); //cache
- // If the user can post discussions, then this is a good place to put the
- // button for it. We do not show the button if we are showing site news
- // and the current user is a guest.
- $canstart = forum_user_can_post_discussion($forum, $currentgroup, $groupmode, $cm, $context);
- if (!$canstart and $forum->type !== 'news') {
- if (isguestuser() or !isloggedin()) {
- $canstart = true;
- }
- if (!is_enrolled($context) and !is_viewing($context)) {
- // allow guests and not-logged-in to see the button - they are prompted to log in after clicking the link
- // normal users with temporary guest access see this button too, they are asked to enrol instead
- // do not show the button to users with suspended enrolments here
- $canstart = enrol_selfenrol_available($course->id);
- }
- }
- if ($canstart) {
- echo '<div class="singlebutton forumaddnew">';
- echo "<form id=\"newdiscussionform\" method=\"get\" action=\"$CFG->wwwroot/mod/forum/post.php\">";
- echo '<div>';
- echo "<input type=\"hidden\" name=\"forum\" value=\"$forum->id\" />";
- switch ($forum->type) {
- case 'news':
- case 'blog':
- $buttonadd = get_string('addanewtopic', 'forum');
- break;
- case 'qanda':
- $buttonadd = get_string('addanewquestion', 'forum');
- break;
- default:
- $buttonadd = get_string('addanewdiscussion', 'forum');
- break;
- }
- echo '<input type="submit" value="'.$buttonadd.'" />';
- echo '</div>';
- echo '</form>';
- echo "</div>\n";
- } else if (isguestuser() or !isloggedin() or $forum->type == 'news') {
- // no button and no info
- } else if ($groupmode and has_capability('mod/forum:startdiscussion', $context)) {
- // inform users why they can not post new discussion
- if ($currentgroup) {
- echo $OUTPUT->notification(get_string('cannotadddiscussion', 'forum'));
- } else {
- echo $OUTPUT->notification(get_string('cannotadddiscussionall', 'forum'));
- }
- }
- // Get all the recent discussions we're allowed to see
- $getuserlastmodified = ($displayformat == 'header');
- if (! $discussions = forum_get_discussions($cm, $sort, $fullpost, null, $maxdiscussions, $getuserlastmodified, $page, $perpage) ) {
- echo '<div class="forumnodiscuss">';
- if ($forum->type == 'news') {
- echo '('.get_string('nonews', 'forum').')';
- } else if ($forum->type == 'qanda') {
- echo '('.get_string('noquestions','forum').')';
- } else {
- echo '('.get_string('nodiscussions', 'forum').')';
- }
- echo "</div>\n";
- return;
- }
- // If we want paging
- if ($page != -1) {
- ///Get the number of discussions found
- $numdiscussions = forum_get_discussions_count($cm);
- ///Show the paging bar
- echo $OUTPUT->paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id");
- if ($numdiscussions > 1000) {
- // saves some memory on sites with very large forums
- $replies = forum_count_discussion_replies($forum->id, $sort, $maxdiscussions, $page, $perpage);
- } else {
- $replies = forum_count_discussion_replies($forum->id);
- }
- } else {
- $replies = forum_count_discussion_replies($forum->id);
- if ($maxdiscussions > 0 and $maxdiscussions <= count($discussions)) {
- $olddiscussionlink = true;
- }
- }
- $canviewparticipants = has_capability('moodle/course:viewparticipants',$context);
- $strdatestring = get_string('strftimerecentfull');
- // Check if the forum is tracked.
- if ($cantrack = forum_tp_can_track_forums($forum)) {
- $forumtracked = forum_tp_is_tracked($forum);
- } else {
- $forumtracked = false;
- }
- if ($forumtracked) {
- $unreads = forum_get_discussions_unread($cm);
- } else {
- $unreads = array();
- }
- if ($displayformat == 'header') {
- echo '<table cellspacing="0" class="forumheaderlist">';
- echo '<thead>';
- echo '<tr>';
- echo '<th class="header topic" scope="col">'.get_string('discussion', 'forum').'</th>';
- echo '<th class="header author" colspan="2" scope="col">'.get_string('startedby', 'forum').'</th>';
- if ($groupmode > 0) {
- echo '<th class="header group" scope="col">'.get_string('group').'</th>';
- }
- if (has_capability('mod/forum:viewdiscussion', $context)) {
- echo '<th class="header replies" scope="col">'.get_string('replies', 'forum').'</th>';
- // If the forum can be tracked, display the unread column.
- if ($cantrack) {
- echo '<th class="header replies" scope="col">'.get_string('unread', 'forum');
- if ($forumtracked) {
- echo '<a title="'.get_string('markallread', 'forum').
- '" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
- $forum->id.'&mark=read&returnpage=view.php">'.
- '<img src="'.$OUTPUT->pix_url('t/markasread') . '" class="iconsmall" alt="'.get_string('markallread', 'forum').'" /></a>';
- }
- echo '</th>';
- }
- }
- echo '<th class="header lastpost" scope="col">'.get_string('lastpost', 'forum').'</th>';
- echo '</tr>';
- echo '</thead>';
- echo '<tbody>';
- }
- foreach ($discussions as $discussion) {
- if (!empty($replies[$discussion->discussion])) {
- $discussion->replies = $replies[$discussion->discussion]->replies;
- $discussion->lastpostid = $replies[$discussion->discussion]->lastpostid;
- } else {
- $discussion->replies = 0;
- }
- // SPECIAL CASE: The front page can display a news item post to non-logged in users.
- // All posts are read in this case.
- if (!$forumtracked) {
- $discussion->unread = '-';
- } else if (empty($USER)) {
- $discussion->unread = 0;
- } else {
- if (empty($unreads[$discussion->discussion])) {
- $discussion->unread = 0;
- } else {
- $discussion->unread = $unreads[$discussion->discussion];
- }
- }
- if (isloggedin()) {
- $ownpost = ($discussion->userid == $USER->id);
- } else {
- $ownpost=false;
- }
- // Use discussion name instead of subject of first post
- $discussion->subject = $discussion->name;
- switch ($displayformat) {
- case 'header':
- if ($groupmode > 0) {
- if (isset($groups[$discussion->groupid])) {
- $group = $groups[$discussion->groupid];
- } else {
- $group = $groups[$discussion->groupid] = groups_get_group($discussion->groupid);
- }
- } else {
- $group = -1;
- }
- forum_print_discussion_header($discussion, $forum, $group, $strdatestring, $cantrack, $forumtracked,
- $canviewparticipants, $context);
- break;
- default:
- $link = false;
- if ($discussion->replies) {
- $link = true;
- } else {
- $modcontext = context_module::instance($cm->id);
- $link = forum_user_can_see_discussion($forum, $discussion, $modcontext, $USER);
- }
- $discussion->forum = $forum->id;
- forum_print_post($discussion, $discussion, $forum, $cm, $course, $ownpost, 0, $link, false,
- '', null, true, $forumtracked);
- break;
- }
- }
- if ($displayformat == "header") {
- echo '</tbody>';
- echo '</table>';
- }
- if ($olddiscussionlink) {
- if ($forum->type == 'news') {
- $strolder = get_string('oldertopics', 'forum');
- } else {
- $strolder = get_string('olderdiscussions', 'forum');
- }
- echo '<div class="forumolddiscuss">';
- echo '<a href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'&showall=1">';
- echo $strolder.'</a> ...</div>';
- }
- if ($page != -1) { ///Show the paging bar
- echo $OUTPUT->paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id");
- }
- }
- /**
- * Prints a forum discussion
- *
- * @uses CONTEXT_MODULE
- * @uses FORUM_MODE_FLATNEWEST
- * @uses FORUM_MODE_FLATOLDEST
- * @uses FORUM_MODE_THREADED
- * @uses FORUM_MODE_NESTED
- * @param stdClass $course
- * @param stdClass $cm
- * @param stdClass $forum
- * @param stdClass $discussion
- * @param stdClass $post
- * @param int $mode
- * @param mixed $canreply
- * @param bool $canrate
- */
- function forum_print_discussion($course, $cm, $forum, $discussion, $post, $mode, $canreply=NULL, $canrate=false) {
- global $USER, $CFG;
- require_once($CFG->dirroot.'/rating/lib.php');
- $ownpost = (isloggedin() && $USER->id == $post->userid);
- $modcontext = context_module::instance($cm->id);
- if ($canreply === NULL) {
- $reply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
- } else {
- $reply = $canreply;
- }
- // $cm holds general cache for forum functions
- $cm->cache = new stdClass;
- $cm->cache->groups = groups_get_all_groups($course->id, 0, $cm->groupingid);
- $cm->cache->usersgroups = array();
- $posters = array();
- // preload all posts - TODO: improve...
- if ($mode == FORUM_MODE_FLATNEWEST) {
- $sort = "p.created DESC";
- } else {
- $sort = "p.created ASC";
- }
- $forumtracked = forum_tp_is_tracked($forum);
- $posts = forum_get_all_discussion_posts($discussion->id, $sort, $forumtracked);
- $post = $posts[$post->id];
- foreach ($posts as $pid=>$p) {
- $posters[$p->userid] = $p->userid;
- }
- // preload all groups of ppl that posted in this discussion
- if ($postersgroups = groups_get_all_groups($course->id, $posters, $cm->groupingid, 'gm.id, gm.groupid, gm.userid')) {
- foreach($postersgroups as $pg) {
- if (!isset($cm->cache->usersgroups[$pg->userid])) {
- $cm->cache->usersgroups[$pg->userid] = array();
- }
- $cm->cache->usersgroups[$pg->userid][$pg->groupid] = $pg->groupid;
- }
- unset($postersgroups);
- }
- //load ratings
- if ($forum->assessed != RATING_AGGREGATE_NONE) {
- $ratingoptions = new stdClass;
- $ratingoptions->context = $modcontext;
- $ratingoptions->component = 'mod_forum';
- $ratingoptions->ratingarea = 'post';
- $ratingoptions->items = $posts;
- $ratingoptions->aggregate = $forum->assessed;//the aggregation method
- $ratingoptions->scaleid = $forum->scale;
- $ratingoptions->userid = $USER->id;
- if ($forum->type == 'single' or !$discussion->id) {
- $ratingoptions->returnurl = "$CFG->wwwroot/mod/forum/view.php?id=$cm->id";
- } else {
- $ratingoptions->returnurl = "$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id";
- }
- $ratingoptions->assesstimestart = $forum->assesstimestart;
- $ratingoptions->assesstimefinish = $forum->assesstimefinish;
- $rm = new rating_manager();
- $posts = $rm->get_ratings($ratingoptions);
- }
- $post->forum = $forum->id; // Add the forum id to the post object, later used by forum_print_post
- $post->forumtype = $forum->type;
- $post->subject = format_string($post->subject);
- $postread = !empty($post->postread);
- forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, false,
- '', '', $postread, true, $forumtracked);
- switch ($mode) {
- case FORUM_MODE_FLATOLDEST :
- case FORUM_MODE_FLATNEWEST :
- default:
- forum_print_posts_flat($course, $cm, $forum, $discussion, $post, $mode, $reply, $forumtracked, $posts);
- break;
- case FORUM_MODE_THREADED :
- forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, 0, $reply, $forumtracked, $posts);
- break;
- case FORUM_MODE_NESTED :
- forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $reply, $forumtracked, $posts);
- break;
- }
- }
- /**
- * @global object
- * @global object
- * @uses FORUM_MODE_FLATNEWEST
- * @param object $course
- * @param object $cm
- * @param object $forum
- * @param object $discussion
- * @param object $post
- * @param object $mode
- * @param bool $reply
- * @param bool $forumtracked
- * @param array $posts
- * @return void
- */
- function forum_print_posts_flat($course, &$cm, $forum, $discussion, $post, $mode, $reply, $forumtracked, $posts) {
- global $USER, $CFG;
- $link = false;
- if ($mode == FORUM_MODE_FLATNEWEST) {
- $sort = "ORDER BY created DESC";
- } else {
- $sort = "ORDER BY created ASC";
- }
- foreach ($posts as $post) {
- if (!$post->parent) {
- continue;
- }
- $post->subject = format_string($post->subject);
- $ownpost = ($USER->id == $post->userid);
- $postread = !empty($post->postread);
- forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
- '', '', $postread, true, $forumtracked);
- }
- }
- /**
- * @todo Document this function
- *
- * @global object
- * @global object
- * @uses CONTEXT_MODULE
- * @return void
- */
- function forum_print_posts_threaded($course, &$cm, $forum, $discussion, $parent, $depth, $reply, $forumtracked, $posts) {
- global $USER, $CFG;
- $link = false;
- if (!empty($posts[$parent->id]->children)) {
- $posts = $posts[$parent->id]->children;
- $modcontext = context_module::instance($cm->id);
- $canviewfullnames = has_capability('moodle/site:viewfullnames', $modcontext);
- foreach ($posts as $post) {
- echo '<div class="indent">';
- if ($depth > 0) {
- $ownpost = ($USER->id == $post->userid);
- $post->subject = format_string($post->subject);
- $postread = !empty($post->postread);
- forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
- '', '', $postread, true, $forumtracked);
- } else {
- if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
- echo "</div>\n";
- continue;
- }
- $by = new stdClass();
- $by->name = fullname($post, $canviewfullnames);
- $by->date = userdate($post->modified);
- if ($forumtracked) {
- if (!empty($post->postread)) {
- $style = '<span class="forumthread read">';
- } else {
- $style = '<span class="forumthread unread">';
- }
- } else {
- $style = '<span class="forumthread">';
- }
- echo $style."<a name=\"$post->id\"></a>".
- "<a href=\"discuss.php?d=$post->discussion&parent=$post->id\">".format_string($post->subject,true)."</a> ";
- print_string("bynameondate", "forum", $by);
- echo "</span>";
- }
- forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, $depth-1, $reply, $forumtracked, $posts);
- echo "</div>\n";
- }
- }
- }
- /**
- * @todo Document this function
- * @global object
- * @global object
- * @return void
- */
- function forum_print_posts_nested($course, &$cm, $forum, $discussion, $parent, $reply, $forumtracked, $posts) {
- global $USER, $CFG;
- $link = false;
- if (!empty($posts[$parent->id]->children)) {
- $posts = $posts[$parent->id]->children;
- foreach ($posts as $post) {
- echo '<div class="indent">';
- if (!isloggedin()) {
- $ownpost = false;
- } else {
- $ownpost = ($USER->id == $post->userid);
- }
- $post->subject = format_string($post->subject);
- $postread = !empty($post->postread);
- forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
- '', '', $postread, true, $forumtracked);
- forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $reply, $forumtracked, $posts);
- echo "</div>\n";
- }
- }
- }
- /**
- * Returns all forum posts since a given time in specified forum.
- *
- * @todo Document this functions args
- * @global object
- * @global object
- * @global object
- * @global object
- */
- function forum_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
- global $CFG, $COURSE, $USER, $DB;
- if ($COURSE->id == $courseid) {
- $course = $COURSE;
- } else {
- $course = $DB->get_record('course', array('id' => $courseid));
- }
- $modinfo = get_fast_modinfo($course);
- $cm = $modinfo->cms[$cmid];
- $params = array($timestart, $cm->instance);
- if ($userid) {
- $userselect = "AND u.id = ?";
- $params[] = $userid;
- } else {
- $userselect = "";
- }
- if ($groupid) {
- $groupselect = "AND d.groupid = ?";
- $params[] = $groupid;
- } else {
- $groupselect = "";
- }
- if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
- d.timestart, d.timeend, d.userid AS duserid,
- u.firstname, u.lastname, u.email, u.picture, u.imagealt, u.email
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- JOIN {forum} f ON f.id = d.forum
- JOIN {user} u ON u.id = p.userid
- WHERE p.created > ? AND f.id = ?
- $userselect $groupselect
- ORDER BY p.id ASC", $params)) { // order by initial posting date
- return;
- }
- $groupmode = groups_get_activity_groupmode($cm, $course);
- $cm_context = context_module::instance($cm->id);
- $viewhiddentimed = has_capability('mod/forum:viewhiddentimedposts', $cm_context);
- $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
- }
- $printposts = array();
- foreach ($posts as $post) {
- if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
- and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
- if (!$viewhiddentimed) {
- continue;
- }
- }
- if ($groupmode) {
- if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or $accessallgroups) {
- // oki (Open discussions have groupid -1)
- } else {
- // separate mode
- if (isguestuser()) {
- // shortcut
- continue;
- }
- if (!in_array($post->groupid, $modinfo->get_groups($cm->groupingid))) {
- continue;
- }
- }
- }
- $printposts[] = $post;
- }
- if (!$printposts) {
- return;
- }
- $aname = format_string($cm->name,true);
- foreach ($printposts as $post) {
- $tmpactivity = new stdClass();
- $tmpactivity->type = 'forum';
- $tmpactivity->cmid = $cm->id;
- $tmpactivity->name = $aname;
- $tmpactivity->sectionnum = $cm->sectionnum;
- $tmpactivity->timestamp = $post->modified;
- $tmpactivity->content = new stdClass();
- $tmpactivity->content->id = $post->id;
- $tmpactivity->content->discussion = $post->discussion;
- $tmpactivity->content->subject = format_string($post->subject);
- $tmpactivity->content->parent = $post->parent;
- $tmpactivity->user = new stdClass();
- $tmpactivity->user->id = $post->userid;
- $tmpactivity->user->firstname = $post->firstname;
- $tmpactivity->user->lastname = $post->lastname;
- $tmpactivity->user->picture = $post->picture;
- $tmpactivity->user->imagealt = $post->imagealt;
- $tmpactivity->user->email = $post->email;
- $activities[$index++] = $tmpactivity;
- }
- return;
- }
- /**
- * @todo Document this function
- * @global object
- */
- function forum_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
- global $CFG, $OUTPUT;
- if ($activity->content->parent) {
- $class = 'reply';
- } else {
- $class = 'discussion';
- }
- echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
- echo "<tr><td class=\"userpicture\" valign=\"top\">";
- echo $OUTPUT->user_picture($activity->user, array('courseid'=>$courseid));
- echo "</td><td class=\"$class\">";
- echo '<div class="title">';
- if ($detail) {
- $aname = s($activity->name);
- echo "<img src=\"" . $OUTPUT->pix_url('icon', $activity->type) . "\" ".
- "class=\"icon\" alt=\"{$aname}\" />";
- }
- echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d={$activity->content->discussion}"
- ."#p{$activity->content->id}\">{$activity->content->subject}</a>";
- echo '</div>';
- echo '<div class="user">';
- $fullname = fullname($activity->user, $viewfullnames);
- echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&course=$courseid\">"
- ."{$fullname}</a> - ".userdate($activity->timestamp);
- echo '</div>';
- echo "</td></tr></table>";
- return;
- }
- /**
- * recursively sets the discussion field to $discussionid on $postid and all its children
- * used when pruning a post
- *
- * @global object
- * @param int $postid
- * @param int $discussionid
- * @return bool
- */
- function forum_change_discussionid($postid, $discussionid) {
- global $DB;
- $DB->set_field('forum_posts', 'discussion', $discussionid, array('id' => $postid));
- if ($posts = $DB->get_records('forum_posts', array('parent' => $postid))) {
- foreach ($posts as $post) {
- forum_change_discussionid($post->id, $discussionid);
- }
- }
- return true;
- }
- /**
- * Prints the editing button on subscribers page
- *
- * @global object
- * @global object
- * @param int $courseid
- * @param int $forumid
- * @return string
- */
- function forum_update_subscriptions_button($courseid, $forumid) {
- global $CFG, $USER;
- if (!empty($USER->subscriptionsediting)) {
- $string = get_string('turneditingoff');
- $edit = "off";
- } else {
- $string = get_string('turneditingon');
- $edit = "on";
- }
- return "<form method=\"get\" action=\"$CFG->wwwroot/mod/forum/subscribers.php\">".
- "<input type=\"hidden\" name=\"id\" value=\"$forumid\" />".
- "<input type=\"hidden\" name=\"edit\" value=\"$edit\" />".
- "<input type=\"submit\" value=\"$string\" /></form>";
- }
- /**
- * This function gets run whenever user is enrolled into course
- *
- * @deprecated deprecating this function as we will be using forum_user_role_assigned
- * @param stdClass $cp
- * @return void
- */
- function forum_user_enrolled($cp) {
- global $DB;
- // NOTE: this has to be as fast as possible - we do not want to slow down enrolments!
- // Originally there used to be 'mod/forum:initialsubscriptions' which was
- // introduced because we did not have enrolment information in earlier versions...
- $sql = "SELECT f.id
- FROM {forum} f
- LEFT JOIN {forum_subscriptions} fs ON (fs.forum = f.id AND fs.userid = :userid)
- WHERE f.course = :courseid AND f.forcesubscribe = :initial AND fs.id IS NULL";
- $params = array('courseid'=>$cp->courseid, 'userid'=>$cp->userid, 'initial'=>FORUM_INITIALSUBSCRIBE);
- $forums = $DB->get_records_sql($sql, $params);
- foreach ($forums as $forum) {
- forum_subscribe($cp->userid, $forum->id);
- }
- }
- /**
- * This function gets run whenever user is assigned role in course
- *
- * @param stdClass $cp
- * @return void
- */
- function forum_user_role_assigned($cp) {
- global $DB;
- $context = context::instance_by_id($cp->contextid, MUST_EXIST);
- // If contextlevel is course then only subscribe user. Role assignment
- // at course level means user is enroled in course and can subscribe to forum.
- if ($context->contextlevel != CONTEXT_COURSE) {
- return;
- }
- $sql = "SELECT f.id, cm.id AS cmid
- FROM {forum} f
- JOIN {course_modules} cm ON (cm.instance = f.id)
- JOIN {modules} m ON (m.id = cm.module)
- LEFT JOIN {forum_subscriptions} fs ON (fs.forum = f.id AND fs.userid = :userid)
- WHERE f.course = :courseid
- AND f.forcesubscribe = :initial
- AND m.name = 'forum'
- AND fs.id IS NULL";
- $params = array('courseid'=>$context->instanceid, 'userid'=>$cp->userid, 'initial'=>FORUM_INITIALSUBSCRIBE);
- $forums = $DB->get_records_sql($sql, $params);
- foreach ($forums as $forum) {
- // If user doesn't have allowforcesubscribe capability then don't subscribe.
- if (has_capability('mod/forum:allowforcesubscribe', context_module::instance($forum->cmid), $cp->userid)) {
- forum_subscribe($cp->userid, $forum->id);
- }
- }
- }
- /**
- * This function gets run whenever user is unenrolled from course
- *
- * @param stdClass $cp
- * @return void
- */
- function forum_user_unenrolled($cp) {
- global $DB;
- // NOTE: this has to be as fast as possible!
- if ($cp->lastenrol) {
- $params = array('userid'=>$cp->userid, 'courseid'=>$cp->courseid);
- $forumselect = "IN (SELECT f.id FROM {forum} f WHERE f.course = :courseid)";
- $DB->delete_records_select('forum_subscriptions', "userid = :userid AND forum $forumselect", $params);
- $DB->delete_records_select('forum_track_prefs', "userid = :userid AND forumid $forumselect", $params);
- $DB->delete_records_select('forum_read', "userid = :userid AND forumid $forumselect", $params);
- }
- }
- // Functions to do with read tracking.
- /**
- * Mark posts as read.
- *
- * @global object
- * @global object
- * @param object $user object
- * @param array $postids array of post ids
- * @return boolean success
- */
- function forum_tp_mark_posts_read($user, $postids) {
- global $CFG, $DB;
- if (!forum_tp_can_track_forums(false, $user)) {
- return true;
- }
- $status = true;
- $now = time();
- $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
- if (empty($postids)) {
- return true;
- } else if (count($postids) > 200) {
- while ($part = array_splice($postids, 0, 200)) {
- $status = forum_tp_mark_posts_read($user, $part) && $status;
- }
- return $status;
- }
- list($usql, $params) = $DB->get_in_or_equal($postids);
- $params[] = $user->id;
- $sql = "SELECT id
- FROM {forum_read}
- WHERE postid $usql AND userid = ?";
- if ($existing = $DB->get_records_sql($sql, $params)) {
- $existing = array_keys($existing);
- } else {
- $existing = array();
- }
- $new = array_diff($postids, $existing);
- if ($new) {
- list($usql, $new_params) = $DB->get_in_or_equal($new);
- $params = array($user->id, $now, $now, $user->id);
- $params = array_merge($params, $new_params);
- $params[] = $cutoffdate;
- $sql = "INSERT INTO {forum_read} (userid, postid, discussionid, forumid, firstread, lastread)
- SELECT ?, p.id, p.discussion, d.forum, ?, ?
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- JOIN {forum} f ON f.id = d.forum
- LEFT JOIN {forum_track_prefs} tf ON (tf.userid = ? AND tf.forumid = f.id)
- WHERE p.id $usql
- AND p.modified >= ?
- AND (f.trackingtype = ".FORUM_TRACKING_ON."
- OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND tf.id IS NULL))";
- $status = $DB->execute($sql, $params) && $status;
- }
- if ($existing) {
- list($usql, $new_params) = $DB->get_in_or_equal($existing);
- $params = array($now, $user->id);
- $params = array_merge($params, $new_params);
- $sql = "UPDATE {forum_read}
- SET lastread = ?
- WHERE userid = ? AND postid $usql";
- $status = $DB->execute($sql, $params) && $status;
- }
- return $status;
- }
- /**
- * Mark post as read.
- * @global object
- * @global object
- * @param int $userid
- * @param int $postid
- */
- function forum_tp_add_read_record($userid, $postid) {
- global $CFG, $DB;
- $now = time();
- $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
- if (!$DB->record_exists('forum_read', array('userid' => $userid, 'postid' => $postid))) {
- $sql = "INSERT INTO {forum_read} (userid, postid, discussionid, forumid, firstread, lastread)
- SELECT ?, p.id, p.discussion, d.forum, ?, ?
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- WHERE p.id = ? AND p.modified >= ?";
- return $DB->execute($sql, array($userid, $now, $now, $postid, $cutoffdate));
- } else {
- $sql = "UPDATE {forum_read}
- SET lastread = ?
- WHERE userid = ? AND postid = ?";
- return $DB->execute($sql, array($now, $userid, $userid));
- }
- }
- /**
- * Returns all records in the 'forum_read' table matching the passed keys, indexed
- * by userid.
- *
- * @global object
- * @param int $userid
- * @param int $postid
- * @param int $discussionid
- * @param int $forumid
- * @return array
- */
- function forum_tp_get_read_records($userid=-1, $postid=-1, $discussionid=-1, $forumid=-1) {
- global $DB;
- $select = '';
- $params = array();
- if ($userid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'userid = ?';
- $params[] = $userid;
- }
- if ($postid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'postid = ?';
- $params[] = $postid;
- }
- if ($discussionid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'discussionid = ?';
- $params[] = $discussionid;
- }
- if ($forumid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'forumid = ?';
- $params[] = $forumid;
- }
- return $DB->get_records_select('forum_read', $select, $params);
- }
- /**
- * Returns all read records for the provided user and discussion, indexed by postid.
- *
- * @global object
- * @param inti $userid
- * @param int $discussionid
- */
- function forum_tp_get_discussion_read_records($userid, $discussionid) {
- global $DB;
- $select = 'userid = ? AND discussionid = ?';
- $fields = 'postid, firstread, lastread';
- return $DB->get_records_select('forum_read', $select, array($userid, $discussionid), '', $fields);
- }
- /**
- * If its an old post, do nothing. If the record exists, the maintenance will clear it up later.
- *
- * @return bool
- */
- function forum_tp_mark_post_read($userid, $post, $forumid) {
- if (!forum_tp_is_post_old($post)) {
- return forum_tp_add_read_record($userid, $post->id);
- } else {
- return true;
- }
- }
- /**
- * Marks a whole forum as read, for a given user
- *
- * @global object
- * @global object
- * @param object $user
- * @param int $forumid
- * @param int|bool $groupid
- * @return bool
- */
- function forum_tp_mark_forum_read($user, $forumid, $groupid=false) {
- global $CFG, $DB;
- $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
- $groupsel = "";
- $params = array($user->id, $forumid, $cutoffdate);
- if ($groupid !== false) {
- $groupsel = " AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $groupid;
- }
- $sql = "SELECT p.id
- FROM {forum_posts} p
- LEFT JOIN {forum_discussions} d ON d.id = p.discussion
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = ?)
- WHERE d.forum = ?
- AND p.modified >= ? AND r.id is NULL
- $groupsel";
- if ($posts = $DB->get_records_sql($sql, $params)) {
- $postids = array_keys($posts);
- return forum_tp_mark_posts_read($user, $postids);
- }
- return true;
- }
- /**
- * Marks a whole discussion as read, for a given user
- *
- * @global object
- * @global object
- * @param object $user
- * @param int $discussionid
- * @return bool
- */
- function forum_tp_mark_discussion_read($user, $discussionid) {
- global $CFG, $DB;
- $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
- $sql = "SELECT p.id
- FROM {forum_posts} p
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = ?)
- WHERE p.discussion = ?
- AND p.modified >= ? AND r.id is NULL";
- if ($posts = $DB->get_records_sql($sql, array($user->id, $discussionid, $cutoffdate))) {
- $postids = array_keys($posts);
- return forum_tp_mark_posts_read($user, $postids);
- }
- return true;
- }
- /**
- * @global object
- * @param int $userid
- * @param object $post
- */
- function forum_tp_is_post_read($userid, $post) {
- global $DB;
- return (forum_tp_is_post_old($post) ||
- $DB->record_exists('forum_read', array('userid' => $userid, 'postid' => $post->id)));
- }
- /**
- * @global object
- * @param object $post
- * @param int $time Defautls to time()
- */
- function forum_tp_is_post_old($post, $time=null) {
- global $CFG;
- if (is_null($time)) {
- $time = time();
- }
- return ($post->modified < ($time - ($CFG->forum_oldpostdays * 24 * 3600)));
- }
- /**
- * Returns the count of records for the provided user and discussion.
- *
- * @global object
- * @global object
- * @param int $userid
- * @param int $discussionid
- * @return bool
- */
- function forum_tp_count_discussion_read_records($userid, $discussionid) {
- global $CFG, $DB;
- $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
- $sql = 'SELECT COUNT(DISTINCT p.id) '.
- 'FROM {forum_discussions} d '.
- 'LEFT JOIN {forum_read} r ON d.id = r.discussionid AND r.userid = ? '.
- 'LEFT JOIN {forum_posts} p ON p.discussion = d.id '.
- 'AND (p.modified < ? OR p.id = r.postid) '.
- 'WHERE d.id = ? ';
- return ($DB->count_records_sql($sql, array($userid, $cutoffdate, $discussionid)));
- }
- /**
- * Returns the count of records for the provided user and discussion.
- *
- * @global object
- * @global object
- * @param int $userid
- * @param int $discussionid
- * @return int
- */
- function forum_tp_count_discussion_unread_posts($userid, $discussionid) {
- global $CFG, $DB;
- $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
- $sql = 'SELECT COUNT(p.id) '.
- 'FROM {forum_posts} p '.
- 'LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? '.
- 'WHERE p.discussion = ? '.
- 'AND p.modified >= ? AND r.id is NULL';
- return $DB->count_records_sql($sql, array($userid, $discussionid, $cutoffdate));
- }
- /**
- * Returns the count of posts for the provided forum and [optionally] group.
- * @global object
- * @global object
- * @param int $forumid
- * @param int|bool $groupid
- * @return int
- */
- function forum_tp_count_forum_posts($forumid, $groupid=false) {
- global $CFG, $DB;
- $params = array($forumid);
- $sql = 'SELECT COUNT(*) '.
- 'FROM {forum_posts} fp,{forum_discussions} fd '.
- 'WHERE fd.forum = ? AND fp.discussion = fd.id';
- if ($groupid !== false) {
- $sql .= ' AND (fd.groupid = ? OR fd.groupid = -1)';
- $params[] = $groupid;
- }
- $count = $DB->count_records_sql($sql, $params);
- return $count;
- }
- /**
- * Returns the count of records for the provided user and forum and [optionally] group.
- * @global object
- * @global object
- * @param int $userid
- * @param int $forumid
- * @param int|bool $groupid
- * @return int
- */
- function forum_tp_count_forum_read_records($userid, $forumid, $groupid=false) {
- global $CFG, $DB;
- $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
- $groupsel = '';
- $params = array($userid, $forumid, $cutoffdate);
- if ($groupid !== false) {
- $groupsel = "AND (d.groupid = ? OR d.groupid = -1)";
- $params[] = $groupid;
- }
- $sql = "SELECT COUNT(p.id)
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid= ?)
- WHERE d.forum = ?
- AND (p.modified < $cutoffdate OR (p.modified >= ? AND r.id IS NOT NULL))
- $groupsel";
- return $DB->get_field_sql($sql, $params);
- }
- /**
- * Returns the count of records for the provided user and course.
- * Please note that group access is ignored!
- *
- * @global object
- * @global object
- * @param int $userid
- * @param int $courseid
- * @return array
- */
- function forum_tp_get_course_unread_posts($userid, $courseid) {
- global $CFG, $DB;
- $now = round(time(), -2); // db cache friendliness
- $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
- $params = array($userid, $userid, $courseid, $cutoffdate);
- if (!empty($CFG->forum_enabletimedposts)) {
- $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
- $params[] = $now;
- $params[] = $now;
- } else {
- $timedsql = "";
- }
- $sql = "SELECT f.id, COUNT(p.id) AS unread
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- JOIN {forum} f ON f.id = d.forum
- JOIN {course} c ON c.id = f.course
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = ?)
- LEFT JOIN {forum_track_prefs} tf ON (tf.userid = ? AND tf.forumid = f.id)
- WHERE f.course = ?
- AND p.modified >= ? AND r.id is NULL
- AND (f.trackingtype = ".FORUM_TRACKING_ON."
- OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND tf.id IS NULL))
- $timedsql
- GROUP BY f.id";
- if ($return = $DB->get_records_sql($sql, $params)) {
- return $return;
- }
- return array();
- }
- /**
- * Returns the count of records for the provided user and forum and [optionally] group.
- *
- * @global object
- * @global object
- * @global object
- * @param object $cm
- * @param object $course
- * @return int
- */
- function forum_tp_count_forum_unread_posts($cm, $course) {
- global $CFG, $USER, $DB;
- static $readcache = array();
- $forumid = $cm->instance;
- if (!isset($readcache[$course->id])) {
- $readcache[$course->id] = array();
- if ($counts = forum_tp_get_course_unread_posts($USER->id, $course->id)) {
- foreach ($counts as $count) {
- $readcache[$course->id][$count->id] = $count->unread;
- }
- }
- }
- if (empty($readcache[$course->id][$forumid])) {
- // no need to check group mode ;-)
- return 0;
- }
- $groupmode = groups_get_activity_groupmode($cm, $course);
- if ($groupmode != SEPARATEGROUPS) {
- return $readcache[$course->id][$forumid];
- }
- if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
- return $readcache[$course->id][$forumid];
- }
- require_once($CFG->dirroot.'/course/lib.php');
- $modinfo = get_fast_modinfo($course);
- if (is_null($modinfo->groups)) {
- $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
- }
- if (array_key_exists($cm->groupingid, $modinfo->groups)) {
- $mygroups = $modinfo->groups[$cm->groupingid];
- } else {
- $mygroups = false; // Will be set below
- }
- // add all groups posts
- if (empty($mygroups)) {
- $mygroups = array(-1=>-1);
- } else {
- $mygroups[-1] = -1;
- }
- list ($groups_sql, $groups_params) = $DB->get_in_or_equal($mygroups);
- $now = round(time(), -2); // db cache friendliness
- $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
- $params = array($USER->id, $forumid, $cutoffdate);
- if (!empty($CFG->forum_enabletimedposts)) {
- $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
- $params[] = $now;
- $params[] = $now;
- } else {
- $timedsql = "";
- }
- $params = array_merge($params, $groups_params);
- $sql = "SELECT COUNT(p.id)
- FROM {forum_posts} p
- JOIN {forum_discussions} d ON p.discussion = d.id
- LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = ?)
- WHERE d.forum = ?
- AND p.modified >= ? AND r.id is NULL
- $timedsql
- AND d.groupid $groups_sql";
- return $DB->get_field_sql($sql, $params);
- }
- /**
- * Deletes read records for the specified index. At least one parameter must be specified.
- *
- * @global object
- * @param int $userid
- * @param int $postid
- * @param int $discussionid
- * @param int $forumid
- * @return bool
- */
- function forum_tp_delete_read_records($userid=-1, $postid=-1, $discussionid=-1, $forumid=-1) {
- global $DB;
- $params = array();
- $select = '';
- if ($userid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'userid = ?';
- $params[] = $userid;
- }
- if ($postid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'postid = ?';
- $params[] = $postid;
- }
- if ($discussionid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'discussionid = ?';
- $params[] = $discussionid;
- }
- if ($forumid > -1) {
- if ($select != '') $select .= ' AND ';
- $select .= 'forumid = ?';
- $params[] = $forumid;
- }
- if ($select == '') {
- return false;
- }
- else {
- return $DB->delete_records_select('forum_read', $select, $params);
- }
- }
- /**
- * Get a list of forums not tracked by the user.
- *
- * @global object
- * @global object
- * @param int $userid The id of the user to use.
- * @param int $courseid The id of the course being checked.
- * @return mixed An array indexed by forum id, or false.
- */
- function forum_tp_get_untracked_forums($userid, $courseid) {
- global $CFG, $DB;
- $sql = "SELECT f.id
- FROM {forum} f
- LEFT JOIN {forum_track_prefs} ft ON (ft.forumid = f.id AND ft.userid = ?)
- WHERE f.course = ?
- AND (f.trackingtype = ".FORUM_TRACKING_OFF."
- OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND ft.id IS NOT NULL))";
- if ($forums = $DB->get_records_sql($sql, array($userid, $courseid))) {
- foreach ($forums as $forum) {
- $forums[$forum->id] = $forum;
- }
- return $forums;
- } else {
- return array();
- }
- }
- /**
- * Determine if a user can track forums and optionally a particular forum.
- * Checks the site settings, the user settings and the forum settings (if
- * requested).
- *
- * @global object
- * @global object
- * @global object
- * @param mixed $forum The forum object to test, or the int id (optional).
- * @param mixed $userid The user object to check for (optional).
- * @return boolean
- */
- function forum_tp_can_track_forums($forum=false, $user=false) {
- global $USER, $CFG, $DB;
- // if possible, avoid expensive
- // queries
- if (empty($CFG->forum_trackreadposts)) {
- return false;
- }
- if ($user === false) {
- $user = $USER;
- }
- if (isguestuser($user) or empty($user->id)) {
- return false;
- }
- if ($forum === false) {
- // general abitily to track forums
- return (bool)$user->trackforums;
- }
- // Work toward always passing an object...
- if (is_numeric($forum)) {
- debugging('Better use proper forum object.', DEBUG_DEVELOPER);
- $forum = $DB->get_record('forum', array('id' => $forum), '', 'id,trackingtype');
- }
- $forumallows = ($forum->trackingtype == FORUM_TRACKING_OPTIONAL);
- $forumforced = ($forum->trackingtype == FORUM_TRACKING_ON);
- return ($forumforced || $forumallows) && !empty($user->trackforums);
- }
- /**
- * Tells whether a specific forum is tracked by the user. A user can optionally
- * be specified. If not specified, the current user is assumed.
- *
- * @global object
- * @global object
- * @global object
- * @param mixed $forum If int, the id of the forum being checked; if object, the forum object
- * @param int $userid The id of the user being checked (optional).
- * @return boolean
- */
- function forum_tp_is_tracked($forum, $user=false) {
- global $USER, $CFG, $DB;
- if ($user === false) {
- $user = $USER;
- }
- if (isguestuser($user) or empty($user->id)) {
- return false;
- }
- // Work toward always passing an object...
- if (is_numeric($forum)) {
- debugging('Better use proper forum object.', DEBUG_DEVELOPER);
- $forum = $DB->get_record('forum', array('id' => $forum));
- }
- if (!forum_tp_can_track_forums($forum, $user)) {
- return false;
- }
- $forumallows = ($forum->trackingtype == FORUM_TRACKING_OPTIONAL);
- $forumforced = ($forum->trackingtype == FORUM_TRACKING_ON);
- return $forumforced ||
- ($forumallows && $DB->get_record('forum_track_prefs', array('userid' => $user->id, 'forumid' => $forum->id)) === false);
- }
- /**
- * @global object
- * @global object
- * @param int $forumid
- * @param int $userid
- */
- function forum_tp_start_tracking($forumid, $userid=false) {
- global $USER, $DB;
- if ($userid === false) {
- $userid = $USER->id;
- }
- return $DB->delete_records('forum_track_prefs', array('userid' => $userid, 'forumid' => $forumid));
- }
- /**
- * @global object
- * @global object
- * @param int $forumid
- * @param int $userid
- */
- function forum_tp_stop_tracking($forumid, $userid=false) {
- global $USER, $DB;
- if ($userid === false) {
- $userid = $USER->id;
- }
- if (!$DB->record_exists('forum_track_prefs', array('userid' => $userid, 'forumid' => $forumid))) {
- $track_prefs = new stdClass();
- $track_prefs->userid = $userid;
- $track_prefs->forumid = $forumid;
- $DB->insert_record('forum_track_prefs', $track_prefs);
- }
- return forum_tp_delete_read_records($userid, -1, -1, $forumid);
- }
- /**
- * Clean old records from the forum_read table.
- * @global object
- * @global object
- * @return void
- */
- function forum_tp_clean_read_records() {
- global $CFG, $DB;
- if (!isset($CFG->forum_oldpostdays)) {
- return;
- }
- // Look for records older than the cutoffdate that are still in the forum_read table.
- $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
- //first get the oldest tracking present - we need tis to speedup the next delete query
- $sql = "SELECT MIN(fp.modified) AS first
- FROM {forum_posts} fp
- JOIN {forum_read} fr ON fr.postid=fp.id";
- if (!$first = $DB->get_field_sql($sql)) {
- // nothing to delete;
- return;
- }
- // now delete old tracking info
- $sql = "DELETE
- FROM {forum_read}
- WHERE postid IN (SELECT fp.id
- FROM {forum_posts} fp
- WHERE fp.modified >= ? AND fp.modified < ?)";
- $DB->execute($sql, array($first, $cutoffdate));
- }
- /**
- * Sets the last post for a given discussion
- *
- * @global object
- * @global object
- * @param into $discussionid
- * @return bool|int
- **/
- function forum_discussion_update_last_post($discussionid) {
- global $CFG, $DB;
- // Check the given discussion exists
- if (!$DB->record_exists('forum_discussions', array('id' => $discussionid))) {
- return false;
- }
- // Use SQL to find the last post for this discussion
- $sql = "SELECT id, userid, modified
- FROM {forum_posts}
- WHERE discussion=?
- ORDER BY modified DESC";
- // Lets go find the last post
- if (($lastposts = $DB->get_records_sql($sql, array($discussionid), 0, 1))) {
- $lastpost = reset($lastposts);
- $discussionobject = new stdClass();
- $discussionobject->id = $discussionid;
- $discussionobject->usermodified = $lastpost->userid;
- $discussionobject->timemodified = $lastpost->modified;
- $DB->update_record('forum_discussions', $discussionobject);
- return $lastpost->id;
- }
- // To get here either we couldn't find a post for the discussion (weird)
- // or we couldn't update the discussion record (weird x2)
- return false;
- }
- /**
- * @return array
- */
- function forum_get_view_actions() {
- return array('view discussion', 'search', 'forum', 'forums', 'subscribers', 'view forum');
- }
- /**
- * @return array
- */
- function forum_get_post_actions() {
- return array('add discussion','add post','delete discussion','delete post','move discussion','prune post','update post');
- }
- /**
- * Returns a warning object if a user has reached the number of posts equal to
- * the warning/blocking setting, or false if there is no warning to show.
- *
- * @param int|stdClass $forum the forum id or the forum object
- * @param stdClass $cm the course module
- * @return stdClass|bool returns an object with the warning information, else
- * returns false if no warning is required.
- */
- function forum_check_throttling($forum, $cm = null) {
- global $CFG, $DB, $USER;
- if (is_numeric($forum)) {
- $forum = $DB->get_record('forum', array('id' => $forum), '*', MUST_EXIST);
- }
- if (!is_object($forum)) {
- return false; // This is broken.
- }
- if (!$cm) {
- $cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course, false, MUST_EXIST);
- }
- if (empty($forum->blockafter)) {
- return false;
- }
- if (empty($forum->blockperiod)) {
- return false;
- }
- $modcontext = context_module::instance($cm->id);
- if (has_capability('mod/forum:postwithoutthrottling', $modcontext)) {
- return false;
- }
- // Get the number of posts in the last period we care about.
- $timenow = time();
- $timeafter = $timenow - $forum->blockperiod;
- $numposts = $DB->count_records_sql('SELECT COUNT(p.id) FROM {forum_posts} p
- JOIN {forum_discussions} d
- ON p.discussion = d.id WHERE d.forum = ?
- AND p.userid = ? AND p.created > ?', array($forum->id, $USER->id, $timeafter));
- $a = new stdClass();
- $a->blockafter = $forum->blockafter;
- $a->numposts = $numposts;
- $a->blockperiod = get_string('secondstotime'.$forum->blockperiod);
- if ($forum->blockafter <= $numposts) {
- $warning = new stdClass();
- $warning->canpost = false;
- $warning->errorcode = 'forumblockingtoomanyposts';
- $warning->module = 'error';
- $warning->additional = $a;
- $warning->link = $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id;
- return $warning;
- }
- if ($forum->warnafter <= $numposts) {
- $warning = new stdClass();
- $warning->canpost = true;
- $warning->errorcode = 'forumblockingalmosttoomanyposts';
- $warning->module = 'forum';
- $warning->additional = $a;
- $warning->link = null;
- return $warning;
- }
- }
- /**
- * Throws an error if the user is no longer allowed to post due to having reached
- * or exceeded the number of posts specified in 'Post threshold for blocking'
- * setting.
- *
- * @since Moodle 2.5
- * @param stdClass $thresholdwarning the warning information returned
- * from the function forum_check_throttling.
- */
- function forum_check_blocking_threshold($thresholdwarning) {
- if (!empty($thresholdwarning) && !$thresholdwarning->canpost) {
- print_error($thresholdwarning->errorcode,
- $thresholdwarning->module,
- $thresholdwarning->link,
- $thresholdwarning->additional);
- }
- }
- /**
- * Removes all grades from gradebook
- *
- * @global object
- * @global object
- * @param int $courseid
- * @param string $type optional
- */
- function forum_reset_gradebook($courseid, $type='') {
- global $CFG, $DB;
- $wheresql = '';
- $params = array($courseid);
- if ($type) {
- $wheresql = "AND f.type=?";
- $params[] = $type;
- }
- $sql = "SELECT f.*, cm.idnumber as cmidnumber, f.course as courseid
- FROM {forum} f, {course_modules} cm, {modules} m
- WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id AND f.course=? $wheresql";
- if ($forums = $DB->get_records_sql($sql, $params)) {
- foreach ($forums as $forum) {
- forum_grade_item_update($forum, 'reset');
- }
- }
- }
- /**
- * This function is used by the reset_course_userdata function in moodlelib.
- * This function will remove all posts from the specified forum
- * and clean up any related data.
- *
- * @global object
- * @global object
- * @param $data the data submitted from the reset course.
- * @return array status array
- */
- function forum_reset_userdata($data) {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/rating/lib.php');
- $componentstr = get_string('modulenameplural', 'forum');
- $status = array();
- $params = array($data->courseid);
- $removeposts = false;
- $typesql = "";
- if (!empty($data->reset_forum_all)) {
- $removeposts = true;
- $typesstr = get_string('resetforumsall', 'forum');
- $types = array();
- } else if (!empty($data->reset_forum_types)){
- $removeposts = true;
- $typesql = "";
- $types = array();
- $forum_types_all = forum_get_forum_types_all();
- foreach ($data->reset_forum_types as $type) {
- if (!array_key_exists($type, $forum_types_all)) {
- continue;
- }
- $typesql .= " AND f.type=?";
- $types[] = $forum_types_all[$type];
- $params[] = $type;
- }
- $typesstr = get_string('resetforums', 'forum').': '.implode(', ', $types);
- }
- $alldiscussionssql = "SELECT fd.id
- FROM {forum_discussions} fd, {forum} f
- WHERE f.course=? AND f.id=fd.forum";
- $allforumssql = "SELECT f.id
- FROM {forum} f
- WHERE f.course=?";
- $allpostssql = "SELECT fp.id
- FROM {forum_posts} fp, {forum_discussions} fd, {forum} f
- WHERE f.course=? AND f.id=fd.forum AND fd.id=fp.discussion";
- $forumssql = $forums = $rm = null;
- if( $removeposts || !empty($data->reset_forum_ratings) ) {
- $forumssql = "$allforumssql $typesql";
- $forums = $forums = $DB->get_records_sql($forumssql, $params);
- $rm = new rating_manager();
- $ratingdeloptions = new stdClass;
- $ratingdeloptions->component = 'mod_forum';
- $ratingdeloptions->ratingarea = 'post';
- }
- if ($removeposts) {
- $discussionssql = "$alldiscussionssql $typesql";
- $postssql = "$allpostssql $typesql";
- // now get rid of all attachments
- $fs = get_file_storage();
- if ($forums) {
- foreach ($forums as $forumid=>$unused) {
- if (!$cm = get_coursemodule_from_instance('forum', $forumid)) {
- continue;
- }
- $context = context_module::instance($cm->id);
- $fs->delete_area_files($context->id, 'mod_forum', 'attachment');
- $fs->delete_area_files($context->id, 'mod_forum', 'post');
- //remove ratings
- $ratingdeloptions->contextid = $context->id;
- $rm->delete_ratings($ratingdeloptions);
- }
- }
- // first delete all read flags
- $DB->delete_records_select('forum_read', "forumid IN ($forumssql)", $params);
- // remove tracking prefs
- $DB->delete_records_select('forum_track_prefs', "forumid IN ($forumssql)", $params);
- // remove posts from queue
- $DB->delete_records_select('forum_queue', "discussionid IN ($discussionssql)", $params);
- // all posts - initial posts must be kept in single simple discussion forums
- $DB->delete_records_select('forum_posts', "discussion IN ($discussionssql) AND parent <> 0", $params); // first all children
- $DB->delete_records_select('forum_posts', "discussion IN ($discussionssql AND f.type <> 'single') AND parent = 0", $params); // now the initial posts for non single simple
- // finally all discussions except single simple forums
- $DB->delete_records_select('forum_discussions', "forum IN ($forumssql AND f.type <> 'single')", $params);
- // remove all grades from gradebook
- if (empty($data->reset_gradebook_grades)) {
- if (empty($types)) {
- forum_reset_gradebook($data->courseid);
- } else {
- foreach ($types as $type) {
- forum_reset_gradebook($data->courseid, $type);
- }
- }
- }
- $status[] = array('component'=>$componentstr, 'item'=>$typesstr, 'error'=>false);
- }
- // remove all ratings in this course's forums
- if (!empty($data->reset_forum_ratings)) {
- if ($forums) {
- foreach ($forums as $forumid=>$unused) {
- if (!$cm = get_coursemodule_from_instance('forum', $forumid)) {
- continue;
- }
- $context = context_module::instance($cm->id);
- //remove ratings
- $ratingdeloptions->contextid = $context->id;
- $rm->delete_ratings($ratingdeloptions);
- }
- }
- // remove all grades from gradebook
- if (empty($data->reset_gradebook_grades)) {
- forum_reset_gradebook($data->courseid);
- }
- }
- // remove all subscriptions unconditionally - even for users still enrolled in course
- if (!empty($data->reset_forum_subscriptions)) {
- $DB->delete_records_select('forum_subscriptions', "forum IN ($allforumssql)", $params);
- $status[] = array('component'=>$componentstr, 'item'=>get_string('resetsubscriptions','forum'), 'error'=>false);
- }
- // remove all tracking prefs unconditionally - even for users still enrolled in course
- if (!empty($data->reset_forum_track_prefs)) {
- $DB->delete_records_select('forum_track_prefs', "forumid IN ($allforumssql)", $params);
- $status[] = array('component'=>$componentstr, 'item'=>get_string('resettrackprefs','forum'), 'error'=>false);
- }
- /// updating dates - shift may be negative too
- if ($data->timeshift) {
- shift_course_mod_dates('forum', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
- $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
- }
- return $status;
- }
- /**
- * Called by course/reset.php
- *
- * @param $mform form passed by reference
- */
- function forum_reset_course_form_definition(&$mform) {
- $mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));
- $mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));
- $mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
- $mform->setAdvanced('reset_forum_types');
- $mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');
- $mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
- $mform->setAdvanced('reset_forum_subscriptions');
- $mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
- $mform->setAdvanced('reset_forum_track_prefs');
- $mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');
- $mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
- $mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
- }
- /**
- * Course reset form defaults.
- * @return array
- */
- function forum_reset_course_form_defaults($course) {
- return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
- }
- /**
- * Converts a forum to use the Roles System
- *
- * @global object
- * @global object
- * @param object $forum a forum object with the same attributes as a record
- * from the forum database table
- * @param int $forummodid the id of the forum module, from the modules table
- * @param array $teacherroles array of roles that have archetype teacher
- * @param array $studentroles array of roles that have archetype student
- * @param array $guestroles array of roles that have archetype guest
- * @param int $cmid the course_module id for this forum instance
- * @return boolean forum was converted or not
- */
- function forum_convert_to_roles($forum, $forummodid, $teacherroles=array(),
- $studentroles=array(), $guestroles=array(), $cmid=NULL) {
- global $CFG, $DB, $OUTPUT;
- if (!isset($forum->open) && !isset($forum->assesspublic)) {
- // We assume that this forum has already been converted to use the
- // Roles System. Columns forum.open and forum.assesspublic get dropped
- // once the forum module has been upgraded to use Roles.
- return false;
- }
- if ($forum->type == 'teacher') {
- // Teacher forums should be converted to normal forums that
- // use the Roles System to implement the old behavior.
- // Note:
- // Seems that teacher forums were never backed up in 1.6 since they
- // didn't have an entry in the course_modules table.
- require_once($CFG->dirroot.'/course/lib.php');
- if ($DB->count_records('forum_discussions', array('forum' => $forum->id)) == 0) {
- // Delete empty teacher forums.
- $DB->delete_records('forum', array('id' => $forum->id));
- } else {
- // Create a course module for the forum and assign it to
- // section 0 in the course.
- $mod = new stdClass();
- $mod->course = $forum->course;
- $mod->module = $forummodid;
- $mod->instance = $forum->id;
- $mod->section = 0;
- $mod->visible = 0; // Hide the forum
- $mod->visibleold = 0; // Hide the forum
- $mod->groupmode = 0;
- if (!$cmid = add_course_module($mod)) {
- print_error('cannotcreateinstanceforteacher', 'forum');
- } else {
- $sectionid = course_add_cm_to_section($forum->course, $mod->coursemodule, 0);
- }
- // Change the forum type to general.
- $forum->type = 'general';
- $DB->update_record('forum', $forum);
- $context = context_module::instance($cmid);
- // Create overrides for default student and guest roles (prevent).
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:viewdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:viewhiddentimedposts', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:replypost', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:rate', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:createattachment', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:deleteownpost', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:deleteanypost', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:splitdiscussions', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:movediscussions', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:editanypost', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:viewqandawithoutposting', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:viewsubscribers', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:managesubscriptions', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:postwithoutthrottling', CAP_PREVENT, $studentrole->id, $context->id);
- }
- foreach ($guestroles as $guestrole) {
- assign_capability('mod/forum:viewdiscussion', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:viewhiddentimedposts', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:replypost', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:viewrating', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:rate', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:createattachment', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:deleteownpost', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:deleteanypost', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:splitdiscussions', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:movediscussions', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:editanypost', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:viewqandawithoutposting', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:viewsubscribers', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:managesubscriptions', CAP_PREVENT, $guestrole->id, $context->id);
- assign_capability('mod/forum:postwithoutthrottling', CAP_PREVENT, $guestrole->id, $context->id);
- }
- }
- } else {
- // Non-teacher forum.
- if (empty($cmid)) {
- // We were not given the course_module id. Try to find it.
- if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
- echo $OUTPUT->notification('Could not get the course module for the forum');
- return false;
- } else {
- $cmid = $cm->id;
- }
- }
- $context = context_module::instance($cmid);
- // $forum->open defines what students can do:
- // 0 = No discussions, no replies
- // 1 = No discussions, but replies are allowed
- // 2 = Discussions and replies are allowed
- switch ($forum->open) {
- case 0:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:replypost', CAP_PREVENT, $studentrole->id, $context->id);
- }
- break;
- case 1:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
- assign_capability('mod/forum:replypost', CAP_ALLOW, $studentrole->id, $context->id);
- }
- break;
- case 2:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:startdiscussion', CAP_ALLOW, $studentrole->id, $context->id);
- assign_capability('mod/forum:replypost', CAP_ALLOW, $studentrole->id, $context->id);
- }
- break;
- }
- // $forum->assessed defines whether forum rating is turned
- // on (1 or 2) and who can rate posts:
- // 1 = Everyone can rate posts
- // 2 = Only teachers can rate posts
- switch ($forum->assessed) {
- case 1:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:rate', CAP_ALLOW, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('mod/forum:rate', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- case 2:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:rate', CAP_PREVENT, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('mod/forum:rate', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- }
- // $forum->assesspublic defines whether students can see
- // everybody's ratings:
- // 0 = Students can only see their own ratings
- // 1 = Students can see everyone's ratings
- switch ($forum->assesspublic) {
- case 0:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- case 1:
- foreach ($studentroles as $studentrole) {
- assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- }
- if (empty($cm)) {
- $cm = $DB->get_record('course_modules', array('id' => $cmid));
- }
- // $cm->groupmode:
- // 0 - No groups
- // 1 - Separate groups
- // 2 - Visible groups
- switch ($cm->groupmode) {
- case 0:
- break;
- case 1:
- foreach ($studentroles as $studentrole) {
- assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- case 2:
- foreach ($studentroles as $studentrole) {
- assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
- }
- foreach ($teacherroles as $teacherrole) {
- assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
- }
- break;
- }
- }
- return true;
- }
- /**
- * Returns array of forum layout modes
- *
- * @return array
- */
- function forum_get_layout_modes() {
- return array (FORUM_MODE_FLATOLDEST => get_string('modeflatoldestfirst', 'forum'),
- FORUM_MODE_FLATNEWEST => get_string('modeflatnewestfirst', 'forum'),
- FORUM_MODE_THREADED => get_string('modethreaded', 'forum'),
- FORUM_MODE_NESTED => get_string('modenested', 'forum'));
- }
- /**
- * Returns array of forum types chooseable on the forum editing form
- *
- * @return array
- */
- function forum_get_forum_types() {
- return array ('general' => get_string('generalforum', 'forum'),
- 'eachuser' => get_string('eachuserforum', 'forum'),
- 'single' => get_string('singleforum', 'forum'),
- 'qanda' => get_string('qandaforum', 'forum'),
- 'blog' => get_string('blogforum', 'forum'));
- }
- /**
- * Returns array of all forum layout modes
- *
- * @return array
- */
- function forum_get_forum_types_all() {
- return array ('news' => get_string('namenews','forum'),
- 'social' => get_string('namesocial','forum'),
- 'general' => get_string('generalforum', 'forum'),
- 'eachuser' => get_string('eachuserforum', 'forum'),
- 'single' => get_string('singleforum', 'forum'),
- 'qanda' => get_string('qandaforum', 'forum'),
- 'blog' => get_string('blogforum', 'forum'));
- }
- /**
- * Returns array of forum open modes
- *
- * @return array
- */
- function forum_get_open_modes() {
- return array ('2' => get_string('openmode2', 'forum'),
- '1' => get_string('openmode1', 'forum'),
- '0' => get_string('openmode0', 'forum') );
- }
- /**
- * Returns all other caps used in module
- *
- * @return array
- */
- function forum_get_extra_capabilities() {
- return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate');
- }
- /**
- * This function is used to extend the global navigation by add forum nodes if there
- * is relevant content.
- *
- * @param navigation_node $navref
- * @param stdClass $course
- * @param stdClass $module
- * @param stdClass $cm
- */
- /*************************************************
- function forum_extend_navigation($navref, $course, $module, $cm) {
- global $CFG, $OUTPUT, $USER;
- $limit = 5;
- $discussions = forum_get_discussions($cm,"d.timemodified DESC", false, -1, $limit);
- $discussioncount = forum_get_discussions_count($cm);
- if (!is_array($discussions) || count($discussions)==0) {
- return;
- }
- $discussionnode = $navref->add(get_string('discussions', 'forum').' ('.$discussioncount.')');
- $discussionnode->mainnavonly = true;
- $discussionnode->display = false; // Do not display on navigation (only on navbar)
- foreach ($discussions as $discussion) {
- $icon = new pix_icon('i/feedback', '');
- $url = new moodle_url('/mod/forum/discuss.php', array('d'=>$discussion->discussion));
- $discussionnode->add($discussion->subject, $url, navigation_node::TYPE_SETTING, null, null, $icon);
- }
- if ($discussioncount > count($discussions)) {
- if (!empty($navref->action)) {
- $url = $navref->action;
- } else {
- $url = new moodle_url('/mod/forum/view.php', array('id'=>$cm->id));
- }
- $discussionnode->add(get_string('viewalldiscussions', 'forum'), $url, navigation_node::TYPE_SETTING, null, null, $icon);
- }
- $index = 0;
- $recentposts = array();
- $lastlogin = time() - COURSE_MAX_RECENT_PERIOD;
- if (!isguestuser() and !empty($USER->lastcourseaccess[$course->id])) {
- if ($USER->lastcourseaccess[$course->id] > $lastlogin) {
- $lastlogin = $USER->lastcourseaccess[$course->id];
- }
- }
- forum_get_recent_mod_activity($recentposts, $index, $lastlogin, $course->id, $cm->id);
- if (is_array($recentposts) && count($recentposts)>0) {
- $recentnode = $navref->add(get_string('recentactivity').' ('.count($recentposts).')');
- $recentnode->mainnavonly = true;
- $recentnode->display = false;
- foreach ($recentposts as $post) {
- $icon = new pix_icon('i/feedback', '');
- $url = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->content->discussion));
- $title = $post->content->subject."\n".userdate($post->timestamp, get_string('strftimerecent', 'langconfig'))."\n".$post->user->firstname.' '.$post->user->lastname;
- $recentnode->add($title, $url, navigation_node::TYPE_SETTING, null, null, $icon);
- }
- }
- }
- *************************/
- /**
- * Adds module specific settings to the settings block
- *
- * @param settings_navigation $settings The settings navigation object
- * @param navigation_node $forumnode The node to add module settings to
- */
- function forum_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $forumnode) {
- global $USER, $PAGE, $CFG, $DB, $OUTPUT;
- $forumobject = $DB->get_record("forum", 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/forum:managesubscriptions', $PAGE->cm->context);
- $subscriptionmode = forum_get_forcesubscribed($forumobject);
- $cansubscribe = ($activeenrolled && $subscriptionmode != FORUM_FORCESUBSCRIBE && ($subscriptionmode != FORUM_DISALLOWSUBSCRIBE || $canmanage));
- if ($canmanage) {
- $mode = $forumnode->add(get_string('subscriptionmode', 'forum'), null, navigation_node::TYPE_CONTAINER);
- $allowchoice = $mode->add(get_string('subscriptionoptional', 'forum'), new moodle_url('/mod/forum/subscribe.php', array('id'=>$forumobject->id, 'mode'=>FORUM_CHOOSESUBSCRIBE, 'sesskey'=>sesskey())), navigation_node::TYPE_SETTING);
- $forceforever = $mode->add(get_string("subscriptionforced", "forum"), new moodle_url('/mod/forum/subscribe.php', array('id'=>$forumobject->id, 'mode'=>FORUM_FORCESUBSCRIBE, 'sesskey'=>sesskey())), navigation_node::TYPE_SETTING);
- $forceinitially = $mode->add(get_string("subscriptionauto", "forum"), new moodle_url('/mod/forum/subscribe.php', array('id'=>$forumobject->id, 'mode'=>FORUM_INITIALSUBSCRIBE, 'sesskey'=>sesskey())), navigation_node::TYPE_SETTING);
- $disallowchoice = $mode->add(get_string('subscriptiondisabled', 'forum'), new moodle_url('/mod/forum/subscribe.php', array('id'=>$forumobject->id, 'mode'=>FORUM_DISALLOWSUBSCRIBE, 'sesskey'=>sesskey())), navigation_node::TYPE_SETTING);
- switch ($subscriptionmode) {
- case FORUM_CHOOSESUBSCRIBE : // 0
- $allowchoice->action = null;
- $allowchoice->add_class('activesetting');
- break;
- case FORUM_FORCESUBSCRIBE : // 1
- $forceforever->action = null;
- $forceforever->add_class('activesetting');
- break;
- case FORUM_INITIALSUBSCRIBE : // 2
- $forceinitially->action = null;
- $forceinitially->add_class('activesetting');
- break;
- case FORUM_DISALLOWSUBSCRIBE : // 3
- $disallowchoice->action = null;
- $disallowchoice->add_class('activesetting');
- break;
- }
- } else if ($activeenrolled) {
- switch ($subscriptionmode) {
- case FORUM_CHOOSESUBSCRIBE : // 0
- $notenode = $forumnode->add(get_string('subscriptionoptional', 'forum'));
- break;
- case FORUM_FORCESUBSCRIBE : // 1
- $notenode = $forumnode->add(get_string('subscriptionforced', 'forum'));
- break;
- case FORUM_INITIALSUBSCRIBE : // 2
- $notenode = $forumnode->add(get_string('subscriptionauto', 'forum'));
- break;
- case FORUM_DISALLOWSUBSCRIBE : // 3
- $notenode = $forumnode->add(get_string('subscriptiondisabled', 'forum'));
- break;
- }
- }
- if ($cansubscribe) {
- if (forum_is_subscribed($USER->id, $forumobject)) {
- $linktext = get_string('unsubscribe', 'forum');
- } else {
- $linktext = get_string('subscribe', 'forum');
- }
- $url = new moodle_url('/mod/forum/subscribe.php', array('id'=>$forumobject->id, 'sesskey'=>sesskey()));
- $forumnode->add($linktext, $url, navigation_node::TYPE_SETTING);
- }
- if (has_capability('mod/forum:viewsubscribers', $PAGE->cm->context)){
- $url = new moodle_url('/mod/forum/subscribers.php', array('id'=>$forumobject->id));
- $forumnode->add(get_string('showsubscribers', 'forum'), $url, navigation_node::TYPE_SETTING);
- }
- if ($enrolled && forum_tp_can_track_forums($forumobject)) { // keep tracking info for users with suspended enrolments
- if ($forumobject->trackingtype != FORUM_TRACKING_OPTIONAL) {
- //tracking forced on or off in forum settings so dont provide a link here to change it
- //could add unclickable text like for forced subscription but not sure this justifies adding another menu item
- } else {
- if (forum_tp_is_tracked($forumobject)) {
- $linktext = get_string('notrackforum', 'forum');
- } else {
- $linktext = get_string('trackforum', 'forum');
- }
- $url = new moodle_url('/mod/forum/settracking.php', array('id'=>$forumobject->id));
- $forumnode->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->forum_enablerssfeeds);
- if ($enablerssfeeds && $forumobject->rsstype && $forumobject->rssarticles && $hascourseaccess) {
- if (!function_exists('rss_get_url')) {
- require_once("$CFG->libdir/rsslib.php");
- }
- if ($forumobject->rsstype == 1) {
- $string = get_string('rsssubscriberssdiscussions','forum');
- } else {
- $string = get_string('rsssubscriberssposts','forum');
- }
- $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $userid, "mod_forum", $forumobject->id));
- $forumnode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
- }
- }
- /**
- * Abstract class used by forum subscriber selection controls
- * @package mod-forum
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- abstract class forum_subscriber_selector_base extends user_selector_base {
- /**
- * The id of the forum this selector is being used for
- * @var int
- */
- protected $forumid = null;
- /**
- * The context of the forum this selector is being used for
- * @var object
- */
- protected $context = null;
- /**
- * The id of the current group
- * @var int
- */
- protected $currentgroup = null;
- /**
- * Constructor method
- * @param string $name
- * @param array $options
- */
- public function __construct($name, $options) {
- $options['accesscontext'] = $options['context'];
- parent::__construct($name, $options);
- if (isset($options['context'])) {
- $this->context = $options['context'];
- }
- if (isset($options['currentgroup'])) {
- $this->currentgroup = $options['currentgroup'];
- }
- if (isset($options['forumid'])) {
- $this->forumid = $options['forumid'];
- }
- }
- /**
- * Returns an array of options to seralise and store for searches
- *
- * @return array
- */
- protected function get_options() {
- global $CFG;
- $options = parent::get_options();
- $options['file'] = substr(__FILE__, strlen($CFG->dirroot.'/'));
- $options['context'] = $this->context;
- $options['currentgroup'] = $this->currentgroup;
- $options['forumid'] = $this->forumid;
- return $options;
- }
- }
- /**
- * A user selector control for potential subscribers to the selected forum
- * @package mod-forum
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class forum_potential_subscriber_selector extends forum_subscriber_selector_base {
- /**
- * If set to true EVERYONE in this course is force subscribed to this forum
- * @var bool
- */
- protected $forcesubscribed = false;
- /**
- * Can be used to store existing subscribers so that they can be removed from
- * the potential subscribers list
- */
- protected $existingsubscribers = array();
- /**
- * Constructor method
- * @param string $name
- * @param array $options
- */
- public function __construct($name, $options) {
- parent::__construct($name, $options);
- if (isset($options['forcesubscribed'])) {
- $this->forcesubscribed=true;
- }
- }
- /**
- * Returns an arary of options for this control
- * @return array
- */
- protected function get_options() {
- $options = parent::get_options();
- if ($this->forcesubscribed===true) {
- $options['forcesubscribed']=1;
- }
- return $options;
- }
- /**
- * Finds all potential users
- *
- * Potential subscribers are all enroled users who are not already subscribed.
- *
- * @param string $search
- * @return array
- */
- public function find_users($search) {
- global $DB;
- $whereconditions = array();
- list($wherecondition, $params) = $this->search_sql($search, 'u');
- if ($wherecondition) {
- $whereconditions[] = $wherecondition;
- }
- if (!$this->forcesubscribed) {
- $existingids = array();
- foreach ($this->existingsubscribers as $group) {
- foreach ($group as $user) {
- $existingids[$user->id] = 1;
- }
- }
- if ($existingids) {
- list($usertest, $userparams) = $DB->get_in_or_equal(
- array_keys($existingids), SQL_PARAMS_NAMED, 'existing', false);
- $whereconditions[] = 'u.id ' . $usertest;
- $params = array_merge($params, $userparams);
- }
- }
- if ($whereconditions) {
- $wherecondition = 'WHERE ' . implode(' AND ', $whereconditions);
- }
- list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
- $params = array_merge($params, $eparams);
- $fields = 'SELECT ' . $this->required_fields_sql('u');
- $countfields = 'SELECT COUNT(u.id)';
- $sql = " FROM {user} u
- JOIN ($esql) je ON je.id = u.id
- $wherecondition";
- list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
- $order = ' ORDER BY ' . $sort;
- // Check to see if there are too many to show sensibly.
- if (!$this->is_validating()) {
- $potentialmemberscount = $DB->count_records_sql($countfields . $sql, $params);
- if ($potentialmemberscount > $this->maxusersperpage) {
- return $this->too_many_results($search, $potentialmemberscount);
- }
- }
- // If not, show them.
- $availableusers = $DB->get_records_sql($fields . $sql . $order, array_merge($params, $sortparams));
- if (empty($availableusers)) {
- return array();
- }
- if ($this->forcesubscribed) {
- return array(get_string("existingsubscribers", 'forum') => $availableusers);
- } else {
- return array(get_string("potentialsubscribers", 'forum') => $availableusers);
- }
- }
- /**
- * Sets the existing subscribers
- * @param array $users
- */
- public function set_existing_subscribers(array $users) {
- $this->existingsubscribers = $users;
- }
- /**
- * Sets this forum as force subscribed or not
- */
- public function set_force_subscribed($setting=true) {
- $this->forcesubscribed = true;
- }
- }
- /**
- * User selector control for removing subscribed users
- * @package mod-forum
- * @copyright 2009 Sam Hemelryk
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class forum_existing_subscriber_selector extends forum_subscriber_selector_base {
- /**
- * Finds all subscribed users
- *
- * @param string $search
- * @return array
- */
- public function find_users($search) {
- global $DB;
- list($wherecondition, $params) = $this->search_sql($search, 'u');
- $params['forumid'] = $this->forumid;
- // only active enrolled or everybody on the frontpage
- list($esql, $eparams) = get_enrolled_sql($this->context, '', $this->currentgroup, true);
- $fields = $this->required_fields_sql('u');
- list($sort, $sortparams) = users_order_by_sql('u', $search, $this->accesscontext);
- $params = array_merge($params, $eparams, $sortparams);
- $subscribers = $DB->get_records_sql("SELECT $fields
- FROM {user} u
- JOIN ($esql) je ON je.id = u.id
- JOIN {forum_subscriptions} s ON s.userid = u.id
- WHERE $wherecondition AND s.forum = :forumid
- ORDER BY $sort", $params);
- return array(get_string("existingsubscribers", 'forum') => $subscribers);
- }
- }
- /**
- * Adds information about unread messages, that is only required for the course view page (and
- * similar), to the course-module object.
- * @param cm_info $cm Course-module object
- */
- function forum_cm_info_view(cm_info $cm) {
- global $CFG;
- // Get tracking status (once per request)
- static $initialised;
- static $usetracking, $strunreadpostsone;
- if (!isset($initialised)) {
- if ($usetracking = forum_tp_can_track_forums()) {
- $strunreadpostsone = get_string('unreadpostsone', 'forum');
- }
- $initialised = true;
- }
- if ($usetracking) {
- if ($unread = forum_tp_count_forum_unread_posts($cm, $cm->get_course())) {
- $out = '<span class="unread"> <a href="' . $cm->get_url() . '">';
- if ($unread == 1) {
- $out .= $strunreadpostsone;
- } else {
- $out .= get_string('unreadpostsnumber', 'forum', $unread);
- }
- $out .= '</a></span>';
- $cm->set_after_link($out);
- }
- }
- }
- /**
- * Return a list of page types
- * @param string $pagetype current page type
- * @param stdClass $parentcontext Block's parent context
- * @param stdClass $currentcontext Current context of block
- */
- function forum_page_type_list($pagetype, $parentcontext, $currentcontext) {
- $forum_pagetype = array(
- 'mod-forum-*'=>get_string('page-mod-forum-x', 'forum'),
- 'mod-forum-view'=>get_string('page-mod-forum-view', 'forum'),
- 'mod-forum-discuss'=>get_string('page-mod-forum-discuss', 'forum')
- );
- return $forum_pagetype;
- }
- /**
- * Gets all of the courses where the provided user has posted in a forum.
- *
- * @global moodle_database $DB The database connection
- * @param stdClass $user The user who's posts we are looking for
- * @param bool $discussionsonly If true only look for discussions started by the user
- * @param bool $includecontexts If set to trye contexts for the courses will be preloaded
- * @param int $limitfrom The offset of records to return
- * @param int $limitnum The number of records to return
- * @return array An array of courses
- */
- function forum_get_courses_user_posted_in($user, $discussionsonly = false, $includecontexts = true, $limitfrom = null, $limitnum = null) {
- global $DB;
- // If we are only after discussions we need only look at the forum_discussions
- // table and join to the userid there. If we are looking for posts then we need
- // to join to the forum_posts table.
- if (!$discussionsonly) {
- $subquery = "(SELECT DISTINCT fd.course
- FROM {forum_discussions} fd
- JOIN {forum_posts} fp ON fp.discussion = fd.id
- WHERE fp.userid = :userid )";
- } else {
- $subquery= "(SELECT DISTINCT fd.course
- FROM {forum_discussions} fd
- WHERE fd.userid = :userid )";
- }
- $params = array('userid' => $user->id);
- // Join to the context table so that we can preload contexts if required.
- if ($includecontexts) {
- list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
- } else {
- $ctxselect = '';
- $ctxjoin = '';
- }
- // Now we need to get all of the courses to search.
- // All courses where the user has posted within a forum will be returned.
- $sql = "SELECT c.* $ctxselect
- FROM {course} c
- $ctxjoin
- WHERE c.id IN ($subquery)";
- $courses = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
- if ($includecontexts) {
- array_map('context_instance_preload', $courses);
- }
- return $courses;
- }
- /**
- * Gets all of the forums a user has posted in for one or more courses.
- *
- * @global moodle_database $DB
- * @param stdClass $user
- * @param array $courseids An array of courseids to search or if not provided
- * all courses the user has posted within
- * @param bool $discussionsonly If true then only forums where the user has started
- * a discussion will be returned.
- * @param int $limitfrom The offset of records to return
- * @param int $limitnum The number of records to return
- * @return array An array of forums the user has posted within in the provided courses
- */
- function forum_get_forums_user_posted_in($user, array $courseids = null, $discussionsonly = false, $limitfrom = null, $limitnum = null) {
- global $DB;
- if (!is_null($courseids)) {
- list($coursewhere, $params) = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED, 'courseid');
- $coursewhere = ' AND f.course '.$coursewhere;
- } else {
- $coursewhere = '';
- $params = array();
- }
- $params['userid'] = $user->id;
- $params['forum'] = 'forum';
- if ($discussionsonly) {
- $join = 'JOIN {forum_discussions} ff ON ff.forum = f.id';
- } else {
- $join = 'JOIN {forum_discussions} fd ON fd.forum = f.id
- JOIN {forum_posts} ff ON ff.discussion = fd.id';
- }
- $sql = "SELECT f.*, cm.id AS cmid
- FROM {forum} f
- JOIN {course_modules} cm ON cm.instance = f.id
- JOIN {modules} m ON m.id = cm.module
- JOIN (
- SELECT f.id
- FROM {forum} f
- {$join}
- WHERE ff.userid = :userid
- GROUP BY f.id
- ) j ON j.id = f.id
- WHERE m.name = :forum
- {$coursewhere}";
- $courseforums = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
- return $courseforums;
- }
- /**
- * Returns posts made by the selected user in the requested courses.
- *
- * This method can be used to return all of the posts made by the requested user
- * within the given courses.
- * For each course the access of the current user and requested user is checked
- * and then for each post access to the post and forum is checked as well.
- *
- * This function is safe to use with usercapabilities.
- *
- * @global moodle_database $DB
- * @param stdClass $user The user whose posts we want to get
- * @param array $courses The courses to search
- * @param bool $musthaveaccess If set to true errors will be thrown if the user
- * cannot access one or more of the courses to search
- * @param bool $discussionsonly If set to true only discussion starting posts
- * will be returned.
- * @param int $limitfrom The offset of records to return
- * @param int $limitnum The number of records to return
- * @return stdClass An object the following properties
- * ->totalcount: the total number of posts made by the requested user
- * that the current user can see.
- * ->courses: An array of courses the current user can see that the
- * requested user has posted in.
- * ->forums: An array of forums relating to the posts returned in the
- * property below.
- * ->posts: An array containing the posts to show for this request.
- */
- function forum_get_posts_by_user($user, array $courses, $musthaveaccess = false, $discussionsonly = false, $limitfrom = 0, $limitnum = 50) {
- global $DB, $USER, $CFG;
- $return = new stdClass;
- $return->totalcount = 0; // The total number of posts that the current user is able to view
- $return->courses = array(); // The courses the current user can access
- $return->forums = array(); // The forums that the current user can access that contain posts
- $return->posts = array(); // The posts to display
- // First up a small sanity check. If there are no courses to check we can
- // return immediately, there is obviously nothing to search.
- if (empty($courses)) {
- return $return;
- }
- // A couple of quick setups
- $isloggedin = isloggedin();
- $isguestuser = $isloggedin && isguestuser();
- $iscurrentuser = $isloggedin && $USER->id == $user->id;
- // Checkout whether or not the current user has capabilities over the requested
- // user and if so they have the capabilities required to view the requested
- // users content.
- $usercontext = context_user::instance($user->id, MUST_EXIST);
- $hascapsonuser = !$iscurrentuser && $DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id));
- $hascapsonuser = $hascapsonuser && has_all_capabilities(array('moodle/user:viewdetails', 'moodle/user:readuserposts'), $usercontext);
- // Before we actually search each course we need to check the user's access to the
- // course. If the user doesn't have the appropraite access then we either throw an
- // error if a particular course was requested or we just skip over the course.
- foreach ($courses as $course) {
- $coursecontext = context_course::instance($course->id, MUST_EXIST);
- if ($iscurrentuser || $hascapsonuser) {
- // If it is the current user, or the current user has capabilities to the
- // requested user then all we need to do is check the requested users
- // current access to the course.
- // Note: There is no need to check group access or anything of the like
- // as either the current user is the requested user, or has granted
- // capabilities on the requested user. Either way they can see what the
- // requested user posted, although its VERY unlikely in the `parent` situation
- // that the current user will be able to view the posts in context.
- if (!is_viewing($coursecontext, $user) && !is_enrolled($coursecontext, $user)) {
- // Need to have full access to a course to see the rest of own info
- if ($musthaveaccess) {
- print_error('errorenrolmentrequired', 'forum');
- }
- continue;
- }
- } else {
- // Check whether the current user is enrolled or has access to view the course
- // if they don't we immediately have a problem.
- if (!can_access_course($course)) {
- if ($musthaveaccess) {
- print_error('errorenrolmentrequired', 'forum');
- }
- continue;
- }
- // Check whether the requested user is enrolled or has access to view the course
- // if they don't we immediately have a problem.
- if (!can_access_course($course, $user)) {
- if ($musthaveaccess) {
- print_error('notenrolled', 'forum');
- }
- continue;
- }
- // If groups are in use and enforced throughout the course then make sure
- // we can meet in at least one course level group.
- // Note that we check if either the current user or the requested user have
- // the capability to access all groups. This is because with that capability
- // a user in group A could post in the group B forum. Grrrr.
- if (groups_get_course_groupmode($course) == SEPARATEGROUPS && $course->groupmodeforce
- && !has_capability('moodle/site:accessallgroups', $coursecontext) && !has_capability('moodle/site:accessallgroups', $coursecontext, $user->id)) {
- // If its the guest user to bad... the guest user cannot access groups
- if (!$isloggedin or $isguestuser) {
- // do not use require_login() here because we might have already used require_login($course)
- if ($musthaveaccess) {
- redirect(get_login_url());
- }
- continue;
- }
- // Get the groups of the current user
- $mygroups = array_keys(groups_get_all_groups($course->id, $USER->id, $course->defaultgroupingid, 'g.id, g.name'));
- // Get the groups the requested user is a member of
- $usergroups = array_keys(groups_get_all_groups($course->id, $user->id, $course->defaultgroupingid, 'g.id, g.name'));
- // Check whether they are members of the same group. If they are great.
- $intersect = array_intersect($mygroups, $usergroups);
- if (empty($intersect)) {
- // But they're not... if it was a specific course throw an error otherwise
- // just skip this course so that it is not searched.
- if ($musthaveaccess) {
- print_error("groupnotamember", '', $CFG->wwwroot."/course/view.php?id=$course->id");
- }
- continue;
- }
- }
- }
- // Woo hoo we got this far which means the current user can search this
- // this course for the requested user. Although this is only the course accessibility
- // handling that is complete, the forum accessibility tests are yet to come.
- $return->courses[$course->id] = $course;
- }
- // No longer beed $courses array - lose it not it may be big
- unset($courses);
- // Make sure that we have some courses to search
- if (empty($return->courses)) {
- // If we don't have any courses to search then the reality is that the current
- // user doesn't have access to any courses is which the requested user has posted.
- // Although we do know at this point that the requested user has posts.
- if ($musthaveaccess) {
- print_error('permissiondenied');
- } else {
- return $return;
- }
- }
- // Next step: Collect all of the forums that we will want to search.
- // It is important to note that this step isn't actually about searching, it is
- // about determining which forums we can search by testing accessibility.
- $forums = forum_get_forums_user_posted_in($user, array_keys($return->courses), $discussionsonly);
- // Will be used to build the where conditions for the search
- $forumsearchwhere = array();
- // Will be used to store the where condition params for the search
- $forumsearchparams = array();
- // Will record forums where the user can freely access everything
- $forumsearchfullaccess = array();
- // DB caching friendly
- $now = round(time(), -2);
- // For each course to search we want to find the forums the user has posted in
- // and providing the current user can access the forum create a search condition
- // for the forum to get the requested users posts.
- foreach ($return->courses as $course) {
- // Now we need to get the forums
- $modinfo = get_fast_modinfo($course);
- if (empty($modinfo->instances['forum'])) {
- // hmmm, no forums? well at least its easy... skip!
- continue;
- }
- // Iterate
- foreach ($modinfo->get_instances_of('forum') as $forumid => $cm) {
- if (!$cm->uservisible or !isset($forums[$forumid])) {
- continue;
- }
- // Get the forum in question
- $forum = $forums[$forumid];
- // This is needed for functionality later on in the forum code....
- $forum->cm = $cm;
- // Check that either the current user can view the forum, or that the
- // current user has capabilities over the requested user and the requested
- // user can view the discussion
- if (!has_capability('mod/forum:viewdiscussion', $cm->context) && !($hascapsonuser && has_capability('mod/forum:viewdiscussion', $cm->context, $user->id))) {
- continue;
- }
- // This will contain forum specific where clauses
- $forumsearchselect = array();
- if (!$iscurrentuser && !$hascapsonuser) {
- // Make sure we check group access
- if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $cm->context)) {
- $groups = $modinfo->get_groups($cm->groupingid);
- $groups[] = -1;
- list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
- $forumsearchparams = array_merge($forumsearchparams, $groupid_params);
- $forumsearchselect[] = "d.groupid $groupid_sql";
- }
- // hidden timed discussions
- if (!empty($CFG->forum_enabletimedposts) && !has_capability('mod/forum:viewhiddentimedposts', $cm->context)) {
- $forumsearchselect[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
- $forumsearchparams['userid'.$forumid] = $user->id;
- $forumsearchparams['timestart'.$forumid] = $now;
- $forumsearchparams['timeend'.$forumid] = $now;
- }
- // qanda access
- if ($forum->type == 'qanda' && !has_capability('mod/forum:viewqandawithoutposting', $cm->context)) {
- // We need to check whether the user has posted in the qanda forum.
- $discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $user->id);
- if (!empty($discussionspostedin)) {
- $forumonlydiscussions = array(); // Holds discussion ids for the discussions the user is allowed to see in this forum.
- foreach ($discussionspostedin as $d) {
- $forumonlydiscussions[] = $d->id;
- }
- list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forumonlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
- $forumsearchparams = array_merge($forumsearchparams, $discussionid_params);
- $forumsearchselect[] = "(d.id $discussionid_sql OR p.parent = 0)";
- } else {
- $forumsearchselect[] = "p.parent = 0";
- }
- }
- if (count($forumsearchselect) > 0) {
- $forumsearchwhere[] = "(d.forum = :forum{$forumid} AND ".implode(" AND ", $forumsearchselect).")";
- $forumsearchparams['forum'.$forumid] = $forumid;
- } else {
- $forumsearchfullaccess[] = $forumid;
- }
- } else {
- // The current user/parent can see all of their own posts
- $forumsearchfullaccess[] = $forumid;
- }
- }
- }
- // If we dont have any search conditions, and we don't have any forums where
- // the user has full access then we just return the default.
- if (empty($forumsearchwhere) && empty($forumsearchfullaccess)) {
- return $return;
- }
- // Prepare a where condition for the full access forums.
- if (count($forumsearchfullaccess) > 0) {
- list($fullidsql, $fullidparams) = $DB->get_in_or_equal($forumsearchfullaccess, SQL_PARAMS_NAMED, 'fula');
- $forumsearchparams = array_merge($forumsearchparams, $fullidparams);
- $forumsearchwhere[] = "(d.forum $fullidsql)";
- }
- // Prepare SQL to both count and search.
- // We alias user.id to useridx because we forum_posts already has a userid field and not aliasing this would break
- // oracle and mssql.
- $userfields = user_picture::fields('u', null, 'useridx');
- $countsql = 'SELECT COUNT(*) ';
- $selectsql = 'SELECT p.*, d.forum, d.name AS discussionname, '.$userfields.' ';
- $wheresql = implode(" OR ", $forumsearchwhere);
- if ($discussionsonly) {
- if ($wheresql == '') {
- $wheresql = 'p.parent = 0';
- } else {
- $wheresql = 'p.parent = 0 AND ('.$wheresql.')';
- }
- }
- $sql = "FROM {forum_posts} p
- JOIN {forum_discussions} d ON d.id = p.discussion
- JOIN {user} u ON u.id = p.userid
- WHERE ($wheresql)
- AND p.userid = :userid ";
- $orderby = "ORDER BY p.modified DESC";
- $forumsearchparams['userid'] = $user->id;
- // Set the total number posts made by the requested user that the current user can see
- $return->totalcount = $DB->count_records_sql($countsql.$sql, $forumsearchparams);
- // Set the collection of posts that has been requested
- $return->posts = $DB->get_records_sql($selectsql.$sql.$orderby, $forumsearchparams, $limitfrom, $limitnum);
- // We need to build an array of forums for which posts will be displayed.
- // We do this here to save the caller needing to retrieve them themselves before
- // printing these forums posts. Given we have the forums already there is
- // practically no overhead here.
- foreach ($return->posts as $post) {
- if (!array_key_exists($post->forum, $return->forums)) {
- $return->forums[$post->forum] = $forums[$post->forum];
- }
- }
- return $return;
- }
Add Comment
Please, Sign In to add comment