mod/forum/index.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * @package   mod_forum
  20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  */
  23
  24 require_once(__DIR__ . '/../../config.php');
  25 require_once($CFG->dirroot . '/course/lib.php');
  26 require_once($CFG->dirroot . '/mod/forum/lib.php');
  27 require_once($CFG->libdir . '/rsslib.php');
  28
  29 $id = optional_param('id', 0, PARAM_INT);                   // Course id
  30 $subscribe = optional_param('subscribe', null, PARAM_INT);  // Subscribe/Unsubscribe all forums
  31
  32 $url = new moodle_url('/mod/forum/index.php', array('id' => $id));
  33 if ($subscribe !== null) {
  34     require_sesskey();
  35     $url->param('subscribe', $subscribe);
  36 }
  37 $PAGE->set_url($url);
  38
  39 if ($id) {
  40     if (!$course = $DB->get_record('course', array('id' => $id))) {
  41         print_error('invalidcourseid');
  42     }
  43 } else {
  44     $course = get_site();
  45 }
  46
  47 require_course_login($course);
  48 $PAGE->set_pagelayout('incourse');
  49 $coursecontext = context_course::instance($course->id);
  50
  51 unset($SESSION->fromdiscussion);
  52
  53 $params = array(
  54     'context' => context_course::instance($course->id)
  55 );
  56 $event = \mod_forum\event\course_module_instance_list_viewed::create($params);
  57 $event->add_record_snapshot('course', $course);
  58 $event->trigger();
  59
  60 $strforums       = get_string('forums', 'forum');
  61 $strforum        = get_string('forum', 'forum');
  62 $strdescription  = get_string('description');
  63 $strdiscussions  = get_string('discussions', 'forum');
  64 $strsubscribed   = get_string('subscribed', 'forum');
  65 $strunreadposts  = get_string('unreadposts', 'forum');
  66 $strtracking     = get_string('tracking', 'forum');
  67 $strmarkallread  = get_string('markallread', 'forum');
  68 $strtrackforum   = get_string('trackforum', 'forum');
  69 $strnotrackforum = get_string('notrackforum', 'forum');
  70 $strsubscribe    = get_string('subscribe', 'forum');
  71 $strunsubscribe  = get_string('unsubscribe', 'forum');
  72 $stryes          = get_string('yes');
  73 $strno           = get_string('no');
  74 $strrss          = get_string('rss');
  75 $stremaildigest  = get_string('emaildigest');
  76
  77 $searchform = forum_search_form($course);
  78
  79 // Start of the table for General Forums.
  80 $generaltable = new html_table();
  81 $generaltable->head  = array ($strforum, $strdescription, $strdiscussions);
  82 $generaltable->align = array ('left', 'left', 'center');
  83
  84 if ($usetracking = forum_tp_can_track_forums()) {
  85     $untracked = forum_tp_get_untracked_forums($USER->id, $course->id);
  86
  87     $generaltable->head[] = $strunreadposts;
  88     $generaltable->align[] = 'center';
  89
  90     $generaltable->head[] = $strtracking;
  91     $generaltable->align[] = 'center';
  92 }
  93
  94 // Fill the subscription cache for this course and user combination.
  95 \mod_forum\subscriptions::fill_subscription_cache_for_course($course->id, $USER->id);
  96
  97 $usesections = course_format_uses_sections($course->format);
  98
  99 $table = new html_table();
 100
 101 // Parse and organise all the forums.  Most forums are course modules but
 102 // some special ones are not.  These get placed in the general forums
 103 // category with the forums in section 0.
 104
 105 $forums = $DB->get_records_sql("
 106     SELECT f.*,
 107            d.maildigest
 108       FROM {forum} f
 109  LEFT JOIN {forum_digests} d ON d.forum = f.id AND d.userid = ?
 110      WHERE f.course = ?
 111     ", array($USER->id, $course->id));
 112
 113 $generalforums  = array();
 114 $learningforums = array();
 115 $modinfo = get_fast_modinfo($course);
 116 $showsubscriptioncolumns = false;
 117
 118 foreach ($modinfo->get_instances_of('forum') as $forumid => $cm) {
 119     if (!$cm->uservisible or !isset($forums[$forumid])) {
 120         continue;
 121     }
 122
 123     $forum = $forums[$forumid];
 124
 125     if (!$context = context_module::instance($cm->id, IGNORE_MISSING)) {
 126         // Shouldn't happen.
 127         continue;
 128     }
 129
 130     if (!has_capability('mod/forum:viewdiscussion', $context)) {
 131         // User can't view this one - skip it.
 132         continue;
 133     }
 134
 135     // Determine whether subscription options should be displayed.
 136     $forum->cansubscribe = mod_forum\subscriptions::is_subscribable($forum);
 137     $forum->cansubscribe = $forum->cansubscribe || has_capability('mod/forum:managesubscriptions', $context);
 138     $forum->issubscribed = mod_forum\subscriptions::is_subscribed($USER->id, $forum, null, $cm);
 139
 140     $showsubscriptioncolumns = $showsubscriptioncolumns || $forum->issubscribed || $forum->cansubscribe;
 141
 142     // Fill two type array - order in modinfo is the same as in course.
 143     if ($forum->type == 'news' or $forum->type == 'social') {
 144         $generalforums[$forum->id] = $forum;
 145
 146     } else if ($course->id == SITEID or empty($cm->sectionnum)) {
 147         $generalforums[$forum->id] = $forum;
 148
 149     } else {
 150         $learningforums[$forum->id] = $forum;
 151     }
 152 }
 153
 154 if ($showsubscriptioncolumns) {
 155     // The user can subscribe to at least one forum.
 156     $generaltable->head[] = $strsubscribed;
 157     $generaltable->align[] = 'center';
 158
 159     $generaltable->head[] = $stremaildigest . ' ' . $OUTPUT->help_icon('emaildigesttype', 'mod_forum');
 160     $generaltable->align[] = 'center';
 161
 162 }
 163
 164 if ($show_rss = (($showsubscriptioncolumns || $course->id == SITEID) &&
 165                  isset($CFG->enablerssfeeds) && isset($CFG->forum_enablerssfeeds) &&
 166                  $CFG->enablerssfeeds && $CFG->forum_enablerssfeeds)) {
 167     $generaltable->head[] = $strrss;
 168     $generaltable->align[] = 'center';
 169 }
 170
 171
 172 // Do course wide subscribe/unsubscribe if requested
 173 if (!is_null($subscribe)) {
 174     if (isguestuser() or !$showsubscriptioncolumns) {
 175         // There should not be any links leading to this place, just redirect.
 176         redirect(
 177                 new moodle_url('/mod/forum/index.php', array('id' => $id)),
 178                 get_string('subscribeenrolledonly', 'forum'),
 179                 null,
 180                 \core\output\notification::NOTIFY_ERROR
 181             );
 182     }
 183     // Can proceed now, the user is not guest and is enrolled
 184     foreach ($modinfo->get_instances_of('forum') as $forumid => $cm) {
 185         $forum = $forums[$forumid];
 186         $modcontext = context_module::instance($cm->id);
 187         $cansub = false;
 188
 189         if (has_capability('mod/forum:viewdiscussion', $modcontext)) {
 190             $cansub = true;
 191         }
 192         if ($cansub && $cm->visible == 0 &&
 193             !has_capability('mod/forum:managesubscriptions', $modcontext))
 194         {
 195             $cansub = false;
 196         }
 197         if (!\mod_forum\subscriptions::is_forcesubscribed($forum)) {
 198             $subscribed = \mod_forum\subscriptions::is_subscribed($USER->id, $forum, null, $cm);
 199             $canmanageactivities = has_capability('moodle/course:manageactivities', $coursecontext, $USER->id);
 200             if (($canmanageactivities || \mod_forum\subscriptions::is_subscribable($forum)) && $subscribe && !$subscribed && $cansub) {
 201                 \mod_forum\subscriptions::subscribe_user($USER->id, $forum, $modcontext, true);
 202             } else if (!$subscribe && $subscribed) {
 203                 \mod_forum\subscriptions::unsubscribe_user($USER->id, $forum, $modcontext, true);
 204             }
 205         }
 206     }
 207     $returnto = forum_go_back_to(new moodle_url('/mod/forum/index.php', array('id' => $course->id)));
 208     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
 209     if ($subscribe) {
 210         redirect(
 211                 $returnto,
 212                 get_string('nowallsubscribed', 'forum', $shortname),
 213                 null,
 214                 \core\output\notification::NOTIFY_SUCCESS
 215             );
 216     } else {
 217         redirect(
 218                 $returnto,
 219                 get_string('nowallunsubscribed', 'forum', $shortname),
 220                 null,
 221                 \core\output\notification::NOTIFY_SUCCESS
 222             );
 223     }
 224 }
 225
 226 if ($generalforums) {
 227     // Process general forums.
 228     foreach ($generalforums as $forum) {
 229         $cm      = $modinfo->instances['forum'][$forum->id];
 230         $context = context_module::instance($cm->id);
 231
 232         $count = forum_count_discussions($forum, $cm, $course);
 233
 234         if ($usetracking) {
 235             if ($forum->trackingtype == FORUM_TRACKING_OFF) {
 236                 $unreadlink  = '-';
 237                 $trackedlink = '-';
 238
 239             } else {
 240                 if (isset($untracked[$forum->id])) {
 241                         $unreadlink  = '-';
 242                 } else if ($unread = forum_tp_count_forum_unread_posts($cm, $course)) {
 243                         $unreadlink = '<span class="unread"><a href="view.php?f='.$forum->id.'">'.$unread.'</a>';
 244                     $unreadlink .= '<a title="'.$strmarkallread.'" href="markposts.php?f='.
 245                                    $forum->id.'&amp;mark=read&amp;sesskey=' . sesskey() . '"><img src="'.$OUTPUT->pix_url('t/markasread') . '" alt="'.$strmarkallread.'" class="iconsmall" /></a></span>';
 246                 } else {
 247                     $unreadlink = '<span class="read">0</span>';
 248                 }
 249
 250                 if (($forum->trackingtype == FORUM_TRACKING_FORCED) && ($CFG->forum_allowforcedreadtracking)) {
 251                     $trackedlink = $stryes;
 252                 } else if ($forum->trackingtype === FORUM_TRACKING_OFF || ($USER->trackforums == 0)) {
 253                     $trackedlink = '-';
 254                 } else {
 255                     $aurl = new moodle_url('/mod/forum/settracking.php', array(
 256                             'id' => $forum->id,
 257                             'sesskey' => sesskey(),
 258                         ));
 259                     if (!isset($untracked[$forum->id])) {
 260                         $trackedlink = $OUTPUT->single_button($aurl, $stryes, 'post', array('title' => $strnotrackforum));
 261                     } else {
 262                         $trackedlink = $OUTPUT->single_button($aurl, $strno, 'post', array('title' => $strtrackforum));
 263                     }
 264                 }
 265             }
 266         }
 267
 268         $forum->intro = shorten_text(format_module_intro('forum', $forum, $cm->id), $CFG->forum_shortpost);
 269         $forumname = format_string($forum->name, true);
 270
 271         if ($cm->visible) {
 272             $style = '';
 273         } else {
 274             $style = 'class="dimmed"';
 275         }
 276         $forumlink = "<a href=\"view.php?f=$forum->id\" $style>".format_string($forum->name,true)."</a>";
 277         $discussionlink = "<a href=\"view.php?f=$forum->id\" $style>".$count."</a>";
 278
 279         $row = array ($forumlink, $forum->intro, $discussionlink);
 280         if ($usetracking) {
 281             $row[] = $unreadlink;
 282             $row[] = $trackedlink;    // Tracking.
 283         }
 284
 285         if ($showsubscriptioncolumns) {
 286             $row[] = forum_get_subscribe_link($forum, $context, array('subscribed' => $stryes,
 287                 'unsubscribed' => $strno, 'forcesubscribed' => $stryes,
 288                 'cantsubscribe' => '-'), false, false, true);
 289             $row[] = forum_index_get_forum_subscription_selector($forum);
 290         }
 291
 292         // If this forum has RSS activated, calculate it.
 293         if ($show_rss) {
 294             if ($forum->rsstype and $forum->rssarticles) {
 295                 //Calculate the tooltip text
 296                 if ($forum->rsstype == 1) {
 297                     $tooltiptext = get_string('rsssubscriberssdiscussions', 'forum');
 298                 } else {
 299                     $tooltiptext = get_string('rsssubscriberssposts', 'forum');
 300                 }
 301
 302                 if (!isloggedin() && $course->id == SITEID) {
 303                     $userid = guest_user()->id;
 304                 } else {
 305                     $userid = $USER->id;
 306                 }
 307                 //Get html code for RSS link
 308                 $row[] = rss_get_link($context->id, $userid, 'mod_forum', $forum->id, $tooltiptext);
 309             } else {
 310                 $row[] = '&nbsp;';
 311             }
 312         }
 313
 314         $generaltable->data[] = $row;
 315     }
 316 }
 317
 318
 319 // Start of the table for Learning Forums
 320 $learningtable = new html_table();
 321 $learningtable->head  = array ($strforum, $strdescription, $strdiscussions);
 322 $learningtable->align = array ('left', 'left', 'center');
 323
 324 if ($usetracking) {
 325     $learningtable->head[] = $strunreadposts;
 326     $learningtable->align[] = 'center';
 327
 328     $learningtable->head[] = $strtracking;
 329     $learningtable->align[] = 'center';
 330 }
 331
 332 if ($showsubscriptioncolumns) {
 333     $learningtable->head[] = $strsubscribed;
 334     $learningtable->align[] = 'center';
 335
 336     $learningtable->head[] = $stremaildigest . ' ' . $OUTPUT->help_icon('emaildigesttype', 'mod_forum');
 337     $learningtable->align[] = 'center';
 338 }
 339
 340 if ($show_rss = (($showsubscriptioncolumns || $course->id == SITEID) &&
 341                  isset($CFG->enablerssfeeds) && isset($CFG->forum_enablerssfeeds) &&
 342                  $CFG->enablerssfeeds && $CFG->forum_enablerssfeeds)) {
 343     $learningtable->head[] = $strrss;
 344     $learningtable->align[] = 'center';
 345 }
 346
 347 // Now let's process the learning forums.
 348 if ($course->id != SITEID) {    // Only real courses have learning forums
 349     // 'format_.'$course->format only applicable when not SITEID (format_site is not a format)
 350     $strsectionname  = get_string('sectionname', 'format_'.$course->format);
 351     // Add extra field for section number, at the front
 352     array_unshift($learningtable->head, $strsectionname);
 353     array_unshift($learningtable->align, 'center');
 354
 355
 356     if ($learningforums) {
 357         $currentsection = '';
 358             foreach ($learningforums as $forum) {
 359             $cm      = $modinfo->instances['forum'][$forum->id];
 360             $context = context_module::instance($cm->id);
 361
 362             $count = forum_count_discussions($forum, $cm, $course);
 363
 364             if ($usetracking) {
 365                 if ($forum->trackingtype == FORUM_TRACKING_OFF) {
 366                     $unreadlink  = '-';
 367                     $trackedlink = '-';
 368
 369                 } else {
 370                     if (isset($untracked[$forum->id])) {
 371                         $unreadlink  = '-';
 372                     } else if ($unread = forum_tp_count_forum_unread_posts($cm, $course)) {
 373                         $unreadlink = '<span class="unread"><a href="view.php?f='.$forum->id.'">'.$unread.'</a>';
 374                         $unreadlink .= '<a title="'.$strmarkallread.'" href="markposts.php?f='.
 375                                        $forum->id.'&amp;mark=read&sesskey=' . sesskey() . '"><img src="'.$OUTPUT->pix_url('t/markasread') . '" alt="'.$strmarkallread.'" class="iconsmall" /></a></span>';
 376                     } else {
 377                         $unreadlink = '<span class="read">0</span>';
 378                     }
 379
 380                     if (($forum->trackingtype == FORUM_TRACKING_FORCED) && ($CFG->forum_allowforcedreadtracking)) {
 381                         $trackedlink = $stryes;
 382                     } else if ($forum->trackingtype === FORUM_TRACKING_OFF || ($USER->trackforums == 0)) {
 383                         $trackedlink = '-';
 384                     } else {
 385                         $aurl = new moodle_url('/mod/forum/settracking.php', array('id' => $forum->id));
 386                         if (!isset($untracked[$forum->id])) {
 387                             $trackedlink = $OUTPUT->single_button($aurl, $stryes, 'post', array('title' => $strnotrackforum));
 388                         } else {
 389                             $trackedlink = $OUTPUT->single_button($aurl, $strno, 'post', array('title' => $strtrackforum));
 390                         }
 391                     }
 392                 }
 393             }
 394
 395             $forum->intro = shorten_text(format_module_intro('forum', $forum, $cm->id), $CFG->forum_shortpost);
 396
 397             if ($cm->sectionnum != $currentsection) {
 398                 $printsection = get_section_name($course, $cm->sectionnum);
 399                 if ($currentsection) {
 400                     $learningtable->data[] = 'hr';
 401                 }
 402                 $currentsection = $cm->sectionnum;
 403             } else {
 404                 $printsection = '';
 405             }
 406
 407             $forumname = format_string($forum->name,true);
 408
 409             if ($cm->visible) {
 410                 $style = '';
 411             } else {
 412                 $style = 'class="dimmed"';
 413             }
 414             $forumlink = "<a href=\"view.php?f=$forum->id\" $style>".format_string($forum->name,true)."</a>";
 415             $discussionlink = "<a href=\"view.php?f=$forum->id\" $style>".$count."</a>";
 416
 417             $row = array ($printsection, $forumlink, $forum->intro, $discussionlink);
 418             if ($usetracking) {
 419                 $row[] = $unreadlink;
 420                 $row[] = $trackedlink;    // Tracking.
 421             }
 422
 423             if ($showsubscriptioncolumns) {
 424                 $row[] = forum_get_subscribe_link($forum, $context, array('subscribed' => $stryes,
 425                     'unsubscribed' => $strno, 'forcesubscribed' => $stryes,
 426                     'cantsubscribe' => '-'), false, false, true);
 427                 $row[] = forum_index_get_forum_subscription_selector($forum);
 428             }
 429
 430             //If this forum has RSS activated, calculate it
 431             if ($show_rss) {
 432                 if ($forum->rsstype and $forum->rssarticles) {
 433                     //Calculate the tolltip text
 434                     if ($forum->rsstype == 1) {
 435                         $tooltiptext = get_string('rsssubscriberssdiscussions', 'forum');
 436                     } else {
 437                         $tooltiptext = get_string('rsssubscriberssposts', 'forum');
 438                     }
 439                     //Get html code for RSS link
 440                     $row[] = rss_get_link($context->id, $USER->id, 'mod_forum', $forum->id, $tooltiptext);
 441                 } else {
 442                     $row[] = '&nbsp;';
 443                 }
 444             }
 445
 446             $learningtable->data[] = $row;
 447         }
 448     }
 449 }
 450
 451 // Output the page.
 452 $PAGE->navbar->add($strforums);
 453 $PAGE->set_title("$course->shortname: $strforums");
 454 $PAGE->set_heading($course->fullname);
 455 $PAGE->set_button($searchform);
 456 echo $OUTPUT->header();
 457
 458 if (!isguestuser() && isloggedin() && $showsubscriptioncolumns) {
 459     // Show the subscribe all options only to non-guest, enrolled users.
 460     echo $OUTPUT->box_start('subscription');
 461
 462     $subscriptionlink = new moodle_url('/mod/forum/index.php', [
 463         'id'        => $course->id,
 464         'sesskey'   => sesskey(),
 465     ]);
 466
 467     // Subscribe all.
 468     $subscriptionlink->param('subscribe', 1);
 469     echo html_writer::tag('div', html_writer::link($subscriptionlink, get_string('allsubscribe', 'forum')), [
 470             'class' => 'helplink',
 471         ]);
 472
 473     // Unsubscribe all.
 474     $subscriptionlink->param('subscribe', 0);
 475     echo html_writer::tag('div', html_writer::link($subscriptionlink, get_string('allunsubscribe', 'forum')), [
 476             'class' => 'helplink',
 477         ]);
 478
 479     echo $OUTPUT->box_end();
 480     echo $OUTPUT->box('&nbsp;', 'clearer');
 481 }
 482
 483 if ($generalforums) {
 484     echo $OUTPUT->heading(get_string('generalforums', 'forum'), 2);
 485     echo html_writer::table($generaltable);
 486 }
 487
 488 if ($learningforums) {
 489     echo $OUTPUT->heading(get_string('learningforums', 'forum'), 2);
 490     echo html_writer::table($learningtable);
 491 }
 492
 493 echo $OUTPUT->footer();
 494
 495 /**
 496  * Get the content of the forum subscription options for this forum.
 497  *
 498  * @param   stdClass    $forum      The forum to return options for
 499  * @return  string
 500  */
 501 function forum_index_get_forum_subscription_selector($forum) {
 502     global $OUTPUT, $PAGE;
 503
 504     if ($forum->cansubscribe || $forum->issubscribed) {
 505         if ($forum->maildigest === null) {
 506             $forum->maildigest = -1;
 507         }
 508
 509         $renderer = $PAGE->get_renderer('mod_forum');
 510         return $OUTPUT->render($renderer->render_digest_options($forum, $forum->maildigest));
 511     } else {
 512         // This user can subscribe to some forums. Add the empty fields.
 513         return '';
 514     }
 515 };