1b95fb7cfb03257088768b83ba369d373817725d
[moodle.git] / mod / forum / index.php
1 <?php
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/>.
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  */
24 require_once(dirname(__FILE__) . '/../../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');
29 $id = optional_param('id', 0, PARAM_INT);                   // Course id
30 $subscribe = optional_param('subscribe', null, PARAM_INT);  // Subscribe/Unsubscribe all forums
32 $url = new moodle_url('/mod/forum/index.php', array('id'=>$id));
33 if ($subscribe !== null) {
34     $url->param('subscribe', $subscribe);
35 }
36 $PAGE->set_url($url);
38 if ($id) {
39     if (! $course = $DB->get_record('course', array('id' => $id))) {
40         print_error('invalidcourseid');
41     }
42 } else {
43     $course = get_site();
44 }
46 require_course_login($course);
47 $PAGE->set_pagelayout('incourse');
48 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
51 unset($SESSION->fromdiscussion);
53 add_to_log($course->id, 'forum', 'view forums', "index.php?id=$course->id");
55 $strforums       = get_string('forums', 'forum');
56 $strforum        = get_string('forum', 'forum');
57 $strdescription  = get_string('description');
58 $strdiscussions  = get_string('discussions', 'forum');
59 $strsubscribed   = get_string('subscribed', 'forum');
60 $strunreadposts  = get_string('unreadposts', 'forum');
61 $strtracking     = get_string('tracking', 'forum');
62 $strmarkallread  = get_string('markallread', 'forum');
63 $strtrackforum   = get_string('trackforum', 'forum');
64 $strnotrackforum = get_string('notrackforum', 'forum');
65 $strsubscribe    = get_string('subscribe', 'forum');
66 $strunsubscribe  = get_string('unsubscribe', 'forum');
67 $stryes          = get_string('yes');
68 $strno           = get_string('no');
69 $strrss          = get_string('rss');
70 $strsectionname  = get_string('sectionname', 'format_'.$course->format);
72 $searchform = forum_search_form($course);
75 // Start of the table for General Forums
77 $generaltable = new html_table();
78 $generaltable->head  = array ($strforum, $strdescription, $strdiscussions);
79 $generaltable->align = array ('left', 'left', 'center');
81 if ($usetracking = forum_tp_can_track_forums()) {
82     $untracked = forum_tp_get_untracked_forums($USER->id, $course->id);
84     $generaltable->head[] = $strunreadposts;
85     $generaltable->align[] = 'center';
87     $generaltable->head[] = $strtracking;
88     $generaltable->align[] = 'center';
89 }
91 $subscribed_forums = forum_get_subscribed_forums($course);
93 $can_subscribe = is_enrolled($coursecontext);
94 if ($can_subscribe) {
95     $generaltable->head[] = $strsubscribed;
96     $generaltable->align[] = 'center';
97 }
99 if ($show_rss = (($can_subscribe || $course->id == SITEID) &&
100                  isset($CFG->enablerssfeeds) && isset($CFG->forum_enablerssfeeds) &&
101                  $CFG->enablerssfeeds && $CFG->forum_enablerssfeeds)) {
102     $generaltable->head[] = $strrss;
103     $generaltable->align[] = 'center';
106 $usesections = course_format_uses_sections($course->format);
107 $sections = get_all_sections($course->id);
109 $table = new html_table();
111 // Parse and organise all the forums.  Most forums are course modules but
112 // some special ones are not.  These get placed in the general forums
113 // category with the forums in section 0.
115 $forums = $DB->get_records('forum', array('course' => $course->id));
117 $generalforums  = array();
118 $learningforums = array();
119 $modinfo =& get_fast_modinfo($course);
121 if (!isset($modinfo->instances['forum'])) {
122     $modinfo->instances['forum'] = array();
125 foreach ($modinfo->instances['forum'] as $forumid=>$cm) {
126     if (!$cm->uservisible or !isset($forums[$forumid])) {
127         continue;
128     }
130     $forum = $forums[$forumid];
132     if (!$context = get_context_instance(CONTEXT_MODULE, $cm->id)) {
133         continue;   // Shouldn't happen
134     }
136     if (!has_capability('mod/forum:viewdiscussion', $context)) {
137         continue;
138     }
140     // fill two type array - order in modinfo is the same as in course
141     if ($forum->type == 'news' or $forum->type == 'social') {
142         $generalforums[$forum->id] = $forum;
144     } else if ($course->id == SITEID or empty($cm->sectionnum)) {
145         $generalforums[$forum->id] = $forum;
147     } else {
148         $learningforums[$forum->id] = $forum;
149     }
152 /// Do course wide subscribe/unsubscribe
153 if (!is_null($subscribe) and !isguestuser()) {
154     foreach ($modinfo->instances['forum'] as $forumid=>$cm) {
155         $forum = $forums[$forumid];
156         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
157         $cansub = false;
159         if (has_capability('mod/forum:viewdiscussion', $modcontext)) {
160             $cansub = true;
161         }
162         if ($cansub && $cm->visible == 0 &&
163             !has_capability('mod/forum:managesubscriptions', $modcontext))
164         {
165             $cansub = false;
166         }
167         if (!forum_is_forcesubscribed($forum)) {
168             $subscribed = forum_is_subscribed($USER->id, $forum);
169             if ((has_capability('moodle/course:manageactivities', $coursecontext, $USER->id) || $forum->forcesubscribe != FORUM_DISALLOWSUBSCRIBE) && $subscribe && !$subscribed && $cansub) {
170                 forum_subscribe($USER->id, $forumid);
171             } else if (!$subscribe && $subscribed) {
172                 forum_unsubscribe($USER->id, $forumid);
173             }
174         }
175     }
176     $returnto = forum_go_back_to("index.php?id=$course->id");
177     if ($subscribe) {
178         add_to_log($course->id, 'forum', 'subscribeall', "index.php?id=$course->id", $course->id);
179         redirect($returnto, get_string('nowallsubscribed', 'forum', format_string($course->shortname)), 1);
180     } else {
181         add_to_log($course->id, 'forum', 'unsubscribeall', "index.php?id=$course->id", $course->id);
182         redirect($returnto, get_string('nowallunsubscribed', 'forum', format_string($course->shortname)), 1);
183     }
186 /// First, let's process the general forums and build up a display
188 if ($generalforums) {
189     foreach ($generalforums as $forum) {
190         $cm      = $modinfo->instances['forum'][$forum->id];
191         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
193         $count = forum_count_discussions($forum, $cm, $course);
195         if ($usetracking) {
196             if ($forum->trackingtype == FORUM_TRACKING_OFF) {
197                 $unreadlink  = '-';
198                 $trackedlink = '-';
200             } else {
201                 if (isset($untracked[$forum->id])) {
202                         $unreadlink  = '-';
203                 } else if ($unread = forum_tp_count_forum_unread_posts($cm, $course)) {
204                         $unreadlink = '<span class="unread"><a href="view.php?f='.$forum->id.'">'.$unread.'</a>';
205                     $unreadlink .= '<a title="'.$strmarkallread.'" href="markposts.php?f='.
206                                    $forum->id.'&amp;mark=read"><img src="'.$OUTPUT->pix_url('t/clear') . '" alt="'.$strmarkallread.'" /></a></span>';
207                 } else {
208                     $unreadlink = '<span class="read">0</span>';
209                 }
211                 if ($forum->trackingtype == FORUM_TRACKING_ON) {
212                     $trackedlink = $stryes;
214                 } else {
215                     $aurl = new moodle_url('/mod/forum/settracking.php', array('id'=>$forum->id));
216                     if (!isset($untracked[$forum->id])) {
217                         $trackedlink = $OUTPUT->single_button($aurl, $stryes, 'post', array('title'=>$strnotrackforum));
218                     } else {
219                         $trackedlink = $OUTPUT->single_button($aurl, $strno, 'post', array('title'=>$strtrackforum));
220                     }
221                 }
222             }
223         }
225         $forum->intro = shorten_text(format_module_intro('forum', $forum, $cm->id), $CFG->forum_shortpost);
226         $forumname = format_string($forum->name, true);;
228         if ($cm->visible) {
229             $style = '';
230         } else {
231             $style = 'class="dimmed"';
232         }
233         $forumlink = "<a href=\"view.php?f=$forum->id\" $style>".format_string($forum->name,true)."</a>";
234         $discussionlink = "<a href=\"view.php?f=$forum->id\" $style>".$count."</a>";
236         $row = array ($forumlink, $forum->intro, $discussionlink);
237         if ($usetracking) {
238             $row[] = $unreadlink;
239             $row[] = $trackedlink;    // Tracking.
240         }
242         if ($can_subscribe) {
243             if ($forum->forcesubscribe != FORUM_DISALLOWSUBSCRIBE) {
244                 $row[] = forum_get_subscribe_link($forum, $context, array('subscribed' => $stryes,
245                         'unsubscribed' => $strno, 'forcesubscribed' => $stryes,
246                         'cantsubscribe' => '-'), false, false, true, $subscribed_forums);
247             } else {
248                 $row[] = '-';
249             }
250         }
252         //If this forum has RSS activated, calculate it
253         if ($show_rss) {
254             if ($forum->rsstype and $forum->rssarticles) {
255                 //Calculate the tooltip text
256                 if ($forum->rsstype == 1) {
257                     $tooltiptext = get_string('rsssubscriberssdiscussions', 'forum');
258                 } else {
259                     $tooltiptext = get_string('rsssubscriberssposts', 'forum');
260                 }
261                 //Get html code for RSS link
262                 $row[] = rss_get_link($context->id, $USER->id, 'mod_forum', $forum->id, $tooltiptext);
263             } else {
264                 $row[] = '&nbsp;';
265             }
266         }
268         $generaltable->data[] = $row;
269     }
273 // Start of the table for Learning Forums
274 $learningtable = new html_table();
275 $learningtable->head  = array ($strforum, $strdescription, $strdiscussions);
276 $learningtable->align = array ('left', 'left', 'center');
278 if ($usetracking) {
279     $learningtable->head[] = $strunreadposts;
280     $learningtable->align[] = 'center';
282     $learningtable->head[] = $strtracking;
283     $learningtable->align[] = 'center';
286 if ($can_subscribe) {
287     $learningtable->head[] = $strsubscribed;
288     $learningtable->align[] = 'center';
291 if ($show_rss = (($can_subscribe || $course->id == SITEID) &&
292                  isset($CFG->enablerssfeeds) && isset($CFG->forum_enablerssfeeds) &&
293                  $CFG->enablerssfeeds && $CFG->forum_enablerssfeeds)) {
294     $learningtable->head[] = $strrss;
295     $learningtable->align[] = 'center';
298 /// Now let's process the learning forums
300 if ($course->id != SITEID) {    // Only real courses have learning forums
301     // Add extra field for section number, at the front
302     array_unshift($learningtable->head, $strsectionname);
303     array_unshift($learningtable->align, 'center');
306     if ($learningforums) {
307         $currentsection = '';
308             foreach ($learningforums as $forum) {
309             $cm      = $modinfo->instances['forum'][$forum->id];
310             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
312             $count = forum_count_discussions($forum, $cm, $course);
314             if ($usetracking) {
315                 if ($forum->trackingtype == FORUM_TRACKING_OFF) {
316                     $unreadlink  = '-';
317                     $trackedlink = '-';
319                 } else {
320                     if (isset($untracked[$forum->id])) {
321                         $unreadlink  = '-';
322                     } else if ($unread = forum_tp_count_forum_unread_posts($cm, $course)) {
323                         $unreadlink = '<span class="unread"><a href="view.php?f='.$forum->id.'">'.$unread.'</a>';
324                         $unreadlink .= '<a title="'.$strmarkallread.'" href="markposts.php?f='.
325                                        $forum->id.'&amp;mark=read"><img src="'.$OUTPUT->pix_url('t/clear') . '" alt="'.$strmarkallread.'" /></a></span>';
326                     } else {
327                         $unreadlink = '<span class="read">0</span>';
328                     }
330                     if ($forum->trackingtype == FORUM_TRACKING_ON) {
331                         $trackedlink = $stryes;
333                     } else {
334                         $aurl = new moodle_url('/mod/forum/settracking.php', array('id'=>$forum->id));
335                         if (!isset($untracked[$forum->id])) {
336                             $trackedlink = $OUTPUT->single_button($aurl, $stryes, 'post', array('title'=>$strnotrackforum));
337                         } else {
338                             $trackedlink = $OUTPUT->single_button($aurl, $strno, 'post', array('title'=>$strtrackforum));
339                         }
340                     }
341                 }
342             }
344             $forum->intro = shorten_text(format_module_intro('forum', $forum, $cm->id), $CFG->forum_shortpost);
346             if ($cm->sectionnum != $currentsection) {
347                 $printsection = get_section_name($course, $sections[$cm->sectionnum]);
348                 if ($currentsection) {
349                     $learningtable->data[] = 'hr';
350                 }
351                 $currentsection = $cm->sectionnum;
352             } else {
353                 $printsection = '';
354             }
356             $forumname = format_string($forum->name,true);;
358             if ($cm->visible) {
359                 $style = '';
360             } else {
361                 $style = 'class="dimmed"';
362             }
363             $forumlink = "<a href=\"view.php?f=$forum->id\" $style>".format_string($forum->name,true)."</a>";
364             $discussionlink = "<a href=\"view.php?f=$forum->id\" $style>".$count."</a>";
366             $row = array ($printsection, $forumlink, $forum->intro, $discussionlink);
367             if ($usetracking) {
368                 $row[] = $unreadlink;
369                 $row[] = $trackedlink;    // Tracking.
370             }
372             if ($can_subscribe) {
373                 if ($forum->forcesubscribe != FORUM_DISALLOWSUBSCRIBE) {
374                     $row[] = forum_get_subscribe_link($forum, $context, array('subscribed' => $stryes,
375                         'unsubscribed' => $strno, 'forcesubscribed' => $stryes,
376                         'cantsubscribe' => '-'), false, false, true, $subscribed_forums);
377                 } else {
378                     $row[] = '-';
379                 }
380             }
382             //If this forum has RSS activated, calculate it
383             if ($show_rss) {
384                 if ($forum->rsstype and $forum->rssarticles) {
385                     //Calculate the tolltip text
386                     if ($forum->rsstype == 1) {
387                         $tooltiptext = get_string('rsssubscriberssdiscussions', 'forum');
388                     } else {
389                         $tooltiptext = get_string('rsssubscriberssposts', 'forum');
390                     }
391                     //Get html code for RSS link
392                     $row[] = rss_get_link($context->id, $USER->id, 'mod_forum', $forum->id, $tooltiptext);
393                 } else {
394                     $row[] = '&nbsp;';
395                 }
396             }
398             $learningtable->data[] = $row;
399         }
400     }
404 /// Output the page
405 $PAGE->navbar->add($strforums);
406 $PAGE->set_title("$course->shortname: $strforums");
407 $PAGE->set_heading($course->fullname);
408 $PAGE->set_button($searchform);
409 echo $OUTPUT->header();
411 if (!isguestuser()) {
412     echo $OUTPUT->box_start('subscription');
413     echo '<span class="helplink">';
414     echo '<a href="index.php?id='.$course->id.'&amp;subscribe=1">'.get_string('allsubscribe', 'forum').'</a>';
415     echo '</span><br /><span class="helplink">';
416     echo '<a href="index.php?id='.$course->id.'&amp;subscribe=0">'.get_string('allunsubscribe', 'forum').'</a>';
417     echo '</span>';
418     echo $OUTPUT->box_end();
419     echo $OUTPUT->box('&nbsp;', 'clearer');
422 if ($generalforums) {
423     echo $OUTPUT->heading(get_string('generalforums', 'forum'));
424     echo html_writer::table($generaltable);
427 if ($learningforums) {
428     echo $OUTPUT->heading(get_string('learningforums', 'forum'));
429     echo html_writer::table($learningtable);
432 echo $OUTPUT->footer();