mod/forum/subscribe.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  * Subscribe to or unsubscribe from a forum or manage forum subscription mode
  20  *
  21  * This script can be used by either individual users to subscribe to or
  22  * unsubscribe from a forum (no 'mode' param provided), or by forum managers
  23  * to control the subscription mode (by 'mode' param).
  24  * This script can be called from a link in email so the sesskey is not
  25  * required parameter. However, if sesskey is missing, the user has to go
  26  * through a confirmation page that redirects the user back with the
  27  * sesskey.
  28  *
  29  * @package    mod
  30  * @subpackage forum
  31  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34
  35 require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
  36 require_once($CFG->dirroot.'/mod/forum/lib.php');
  37
  38 $id      = required_param('id', PARAM_INT);             // the forum to subscribe or unsubscribe to
  39 $mode    = optional_param('mode', null, PARAM_INT);     // the forum's subscription mode
  40 $user    = optional_param('user', 0, PARAM_INT);        // userid of the user to subscribe, defaults to $USER
  41 $sesskey = optional_param('sesskey', null, PARAM_RAW);  // sesskey
  42
  43 $url = new moodle_url('/mod/forum/subscribe.php', array('id'=>$id));
  44 if (!is_null($mode)) {
  45     $url->param('mode', $mode);
  46 }
  47 if ($user !== 0) {
  48     $url->param('user', $user);
  49 }
  50 if (!is_null($sesskey)) {
  51     $url->param('sesskey', $sesskey);
  52 }
  53 $PAGE->set_url($url);
  54
  55 $forum   = $DB->get_record('forum', array('id' => $id), '*', MUST_EXIST);
  56 $course  = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST);
  57 $cm      = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
  58 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  59
  60 if ($user) {
  61     require_sesskey();
  62     if (!has_capability('mod/forum:managesubscriptions', $context)) {
  63         print_error('nopermissiontosubscribe', 'forum');
  64     }
  65     $user = $DB->get_record('user', array('id' => $user), MUST_EXIST);
  66 } else {
  67     $user = $USER;
  68 }
  69
  70 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
  71     $groupmode = $cm->groupmode;
  72 } else {
  73     $groupmode = $course->groupmode;
  74 }
  75 if ($groupmode && !forum_is_subscribed($user->id, $forum) && !has_capability('moodle/site:accessallgroups', $context)) {
  76     if (!groups_get_all_groups($course->id, $USER->id)) {
  77         print_error('cannotsubscribe', 'forum');
  78     }
  79 }
  80
  81 require_login($course->id, false, $cm);
  82
  83 if (is_null($mode) and !is_enrolled($context, $USER, '', true)) {   // Guests and visitors can't subscribe - only enrolled
  84     $PAGE->set_title($course->shortname);
  85     $PAGE->set_heading($course->fullname);
  86     if (isguestuser()) {
  87         echo $OUTPUT->header();
  88         echo $OUTPUT->confirm(get_string('subscribeenrolledonly', 'forum').'<br /><br />'.get_string('liketologin'),
  89                      get_login_url(), new moodle_url('/mod/forum/view.php', array('f'=>$id)));
  90         echo $OUTPUT->footer();
  91         exit;
  92     } else {
  93         // there should not be any links leading to this place, just redirect
  94         redirect(new moodle_url('/mod/forum/view.php', array('f'=>$id)), get_string('subscribeenrolledonly', 'forum'));
  95     }
  96 }
  97
  98 $returnto = optional_param('backtoindex',0,PARAM_INT)
  99     ? "index.php?id=".$course->id
 100     : "view.php?f=$id";
 101
 102 if (!is_null($mode) and has_capability('mod/forum:managesubscriptions', $context)) {
 103     require_sesskey();
 104     switch ($mode) {
 105         case FORUM_CHOOSESUBSCRIBE : // 0
 106             forum_forcesubscribe($forum->id, 0);
 107             redirect($returnto, get_string("everyonecannowchoose", "forum"), 1);
 108             break;
 109         case FORUM_FORCESUBSCRIBE : // 1
 110             forum_forcesubscribe($forum->id, 1);
 111             redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 112             break;
 113         case FORUM_INITIALSUBSCRIBE : // 2
 114             forum_forcesubscribe($forum->id, 2);
 115             redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 116             break;
 117         case FORUM_DISALLOWSUBSCRIBE : // 3
 118             forum_forcesubscribe($forum->id, 3);
 119             redirect($returnto, get_string("noonecansubscribenow", "forum"), 1);
 120             break;
 121         default:
 122             print_error(get_string('invalidforcesubscribe', 'forum'));
 123     }
 124 }
 125
 126 if (forum_is_forcesubscribed($forum)) {
 127     redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 128 }
 129
 130 $info->name  = fullname($user);
 131 $info->forum = format_string($forum->name);
 132
 133 if (forum_is_subscribed($user->id, $forum->id)) {
 134     if (is_null($sesskey)) {    // we came here via link in email
 135         $PAGE->set_title($course->shortname);
 136         $PAGE->set_heading($course->fullname);
 137         echo $OUTPUT->header();
 138         echo $OUTPUT->confirm(get_string('confirmunsubscribe', 'forum', format_string($forum->name)),
 139                 new moodle_url($PAGE->url, array('sesskey' => sesskey())), new moodle_url('/mod/forum/view.php', array('f' => $id)));
 140         echo $OUTPUT->footer();
 141         exit;
 142     }
 143     require_sesskey();
 144     if (forum_unsubscribe($user->id, $forum->id)) {
 145         add_to_log($course->id, "forum", "unsubscribe", "view.php?f=$forum->id", $forum->id, $cm->id);
 146         redirect($returnto, get_string("nownotsubscribed", "forum", $info), 1);
 147     } else {
 148         print_error('cannotunsubscribe', 'forum', $_SERVER["HTTP_REFERER"]);
 149     }
 150
 151 } else {  // subscribe
 152     if ($forum->forcesubscribe == FORUM_DISALLOWSUBSCRIBE &&
 153                 !has_capability('mod/forum:managesubscriptions', $context)) {
 154         print_error('disallowsubscribe', 'forum', $_SERVER["HTTP_REFERER"]);
 155     }
 156     if (!has_capability('mod/forum:viewdiscussion', $context)) {
 157         print_error('noviewdiscussionspermission', 'forum', $_SERVER["HTTP_REFERER"]);
 158     }
 159     if (is_null($sesskey)) {    // we came here via link in email
 160         $PAGE->set_title($course->shortname);
 161         $PAGE->set_heading($course->fullname);
 162         echo $OUTPUT->header();
 163         echo $OUTPUT->confirm(get_string('confirmsubscribe', 'forum', format_string($forum->name)),
 164                 new moodle_url($PAGE->url, array('sesskey' => sesskey())), new moodle_url('/mod/forum/view.php', array('f' => $id)));
 165         echo $OUTPUT->footer();
 166         exit;
 167     }
 168     require_sesskey();
 169     forum_subscribe($user->id, $forum->id);
 170     add_to_log($course->id, "forum", "subscribe", "view.php?f=$forum->id", $forum->id, $cm->id);
 171     redirect($returnto, get_string("nowsubscribed", "forum", $info), 1);
 172 }