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_forum
  30  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32  */
  33
  34 require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
  35 require_once($CFG->dirroot.'/mod/forum/lib.php');
  36
  37 $id             = required_param('id', PARAM_INT);             // The forum to set subscription on.
  38 $mode           = optional_param('mode', null, PARAM_INT);     // The forum's subscription mode.
  39 $user           = optional_param('user', 0, PARAM_INT);        // The userid of the user to subscribe, defaults to $USER.
  40 $discussionid   = optional_param('d', null, PARAM_INT);        // The discussionid to subscribe.
  41 $sesskey        = optional_param('sesskey', null, PARAM_RAW);
  42 $returnurl      = optional_param('returnurl', null, PARAM_RAW);
  43
  44 $url = new moodle_url('/mod/forum/subscribe.php', array('id'=>$id));
  45 if (!is_null($mode)) {
  46     $url->param('mode', $mode);
  47 }
  48 if ($user !== 0) {
  49     $url->param('user', $user);
  50 }
  51 if (!is_null($sesskey)) {
  52     $url->param('sesskey', $sesskey);
  53 }
  54 if (!is_null($discussionid)) {
  55     $url->param('d', $discussionid);
  56     if (!$discussion = $DB->get_record('forum_discussions', array('id' => $discussionid, 'forum' => $id))) {
  57         print_error('invaliddiscussionid', 'forum');
  58     }
  59 }
  60 $PAGE->set_url($url);
  61
  62 $forum   = $DB->get_record('forum', array('id' => $id), '*', MUST_EXIST);
  63 $course  = $DB->get_record('course', array('id' => $forum->course), '*', MUST_EXIST);
  64 $cm      = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
  65 $context = context_module::instance($cm->id);
  66
  67 if ($user) {
  68     require_sesskey();
  69     if (!has_capability('mod/forum:managesubscriptions', $context)) {
  70         print_error('nopermissiontosubscribe', 'forum');
  71     }
  72     $user = $DB->get_record('user', array('id' => $user), '*', MUST_EXIST);
  73 } else {
  74     $user = $USER;
  75 }
  76
  77 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
  78     $groupmode = $cm->groupmode;
  79 } else {
  80     $groupmode = $course->groupmode;
  81 }
  82
  83 $issubscribed = \mod_forum\subscriptions::is_subscribed($user->id, $forum, $discussionid, $cm);
  84
  85 // For a user to subscribe when a groupmode is set, they must have access to at least one group.
  86 if ($groupmode && !$issubscribed && !has_capability('moodle/site:accessallgroups', $context)) {
  87     if (!groups_get_all_groups($course->id, $USER->id)) {
  88         print_error('cannotsubscribe', 'forum');
  89     }
  90 }
  91
  92 require_login($course, false, $cm);
  93
  94 if (is_null($mode) and !is_enrolled($context, $USER, '', true)) {   // Guests and visitors can't subscribe - only enrolled
  95     $PAGE->set_title($course->shortname);
  96     $PAGE->set_heading($course->fullname);
  97     if (isguestuser()) {
  98         echo $OUTPUT->header();
  99         echo $OUTPUT->confirm(get_string('subscribeenrolledonly', 'forum').'<br /><br />'.get_string('liketologin'),
 100                      get_login_url(), new moodle_url('/mod/forum/view.php', array('f'=>$id)));
 101         echo $OUTPUT->footer();
 102         exit;
 103     } else {
 104         // there should not be any links leading to this place, just redirect
 105         redirect(new moodle_url('/mod/forum/view.php', array('f'=>$id)), get_string('subscribeenrolledonly', 'forum'));
 106     }
 107 }
 108
 109 $returnto = optional_param('backtoindex',0,PARAM_INT)
 110     ? "index.php?id=".$course->id
 111     : "view.php?f=$id";
 112
 113 if ($returnurl) {
 114     $returnto = $returnurl;
 115 }
 116
 117 if (!is_null($mode) and has_capability('mod/forum:managesubscriptions', $context)) {
 118     require_sesskey();
 119     switch ($mode) {
 120         case FORUM_CHOOSESUBSCRIBE : // 0
 121             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_CHOOSESUBSCRIBE);
 122             redirect($returnto, get_string("everyonecannowchoose", "forum"), 1);
 123             break;
 124         case FORUM_FORCESUBSCRIBE : // 1
 125             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_FORCESUBSCRIBE);
 126             redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 127             break;
 128         case FORUM_INITIALSUBSCRIBE : // 2
 129             if ($forum->forcesubscribe <> FORUM_INITIALSUBSCRIBE) {
 130                 $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email', '');
 131                 foreach ($users as $user) {
 132                     \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
 133                 }
 134             }
 135             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_INITIALSUBSCRIBE);
 136             redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 137             break;
 138         case FORUM_DISALLOWSUBSCRIBE : // 3
 139             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_DISALLOWSUBSCRIBE);
 140             redirect($returnto, get_string("noonecansubscribenow", "forum"), 1);
 141             break;
 142         default:
 143             print_error(get_string('invalidforcesubscribe', 'forum'));
 144     }
 145 }
 146
 147 if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
 148     redirect($returnto, get_string("everyoneisnowsubscribed", "forum"), 1);
 149 }
 150
 151 $info = new stdClass();
 152 $info->name  = fullname($user);
 153 $info->forum = format_string($forum->name);
 154
 155 if ($issubscribed) {
 156     if (is_null($sesskey)) {
 157         // We came here via link in email.
 158         $PAGE->set_title($course->shortname);
 159         $PAGE->set_heading($course->fullname);
 160         echo $OUTPUT->header();
 161
 162         $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id));
 163         if ($discussionid) {
 164             $a = new stdClass();
 165             $a->forum = format_string($forum->name);
 166             $a->discussion = format_string($discussion->name);
 167             echo $OUTPUT->confirm(get_string('confirmunsubscribediscussion', 'forum', $a),
 168                     $PAGE->url, $viewurl);
 169         } else {
 170             echo $OUTPUT->confirm(get_string('confirmunsubscribe', 'forum', format_string($forum->name)),
 171                     $PAGE->url, $viewurl);
 172         }
 173         echo $OUTPUT->footer();
 174         exit;
 175     }
 176     require_sesskey();
 177     if ($discussionid === null) {
 178         if (\mod_forum\subscriptions::unsubscribe_user($user->id, $forum, $context, true)) {
 179             redirect($returnto, get_string("nownotsubscribed", "forum", $info), 1);
 180         } else {
 181             print_error('cannotunsubscribe', 'forum', get_local_referer(false));
 182         }
 183     } else {
 184         if (\mod_forum\subscriptions::unsubscribe_user_from_discussion($user->id, $discussion, $context)) {
 185             $info->discussion = $discussion->name;
 186             redirect($returnto, get_string("discussionnownotsubscribed", "forum", $info), 1);
 187         } else {
 188             print_error('cannotunsubscribe', 'forum', get_local_referer(false));
 189         }
 190     }
 191
 192 } else {  // subscribe
 193     if (\mod_forum\subscriptions::subscription_disabled($forum) && !has_capability('mod/forum:managesubscriptions', $context)) {
 194         print_error('disallowsubscribe', 'forum', get_local_referer(false));
 195     }
 196     if (!has_capability('mod/forum:viewdiscussion', $context)) {
 197         print_error('noviewdiscussionspermission', 'forum', get_local_referer(false));
 198     }
 199     if (is_null($sesskey)) {
 200         // We came here via link in email.
 201         $PAGE->set_title($course->shortname);
 202         $PAGE->set_heading($course->fullname);
 203         echo $OUTPUT->header();
 204
 205         $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id));
 206         if ($discussionid) {
 207             $a = new stdClass();
 208             $a->forum = format_string($forum->name);
 209             $a->discussion = format_string($discussion->name);
 210             echo $OUTPUT->confirm(get_string('confirmsubscribediscussion', 'forum', $a),
 211                     $PAGE->url, $viewurl);
 212         } else {
 213             echo $OUTPUT->confirm(get_string('confirmsubscribe', 'forum', format_string($forum->name)),
 214                     $PAGE->url, $viewurl);
 215         }
 216         echo $OUTPUT->footer();
 217         exit;
 218     }
 219     require_sesskey();
 220     if ($discussionid == null) {
 221         \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context, true);
 222         redirect($returnto, get_string("nowsubscribed", "forum", $info), 1);
 223     } else {
 224         $info->discussion = $discussion->name;
 225         \mod_forum\subscriptions::subscribe_user_to_discussion($user->id, $discussion, $context);
 226         redirect($returnto, get_string("discussionnowsubscribed", "forum", $info), 1);
 227     }
 228 }