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(__DIR__.'/../../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_LOCALURL);
  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(
 106                 new moodle_url('/mod/forum/view.php', array('f'=>$id)),
 107                 get_string('subscribeenrolledonly', 'forum'),
 108                 null,
 109                 \core\output\notification::NOTIFY_ERROR
 110             );
 111     }
 112 }
 113
 114 $returnto = optional_param('backtoindex',0,PARAM_INT)
 115     ? "index.php?id=".$course->id
 116     : "view.php?f=$id";
 117
 118 if ($returnurl) {
 119     $returnto = $returnurl;
 120 }
 121
 122 if (!is_null($mode) and has_capability('mod/forum:managesubscriptions', $context)) {
 123     require_sesskey();
 124     switch ($mode) {
 125         case FORUM_CHOOSESUBSCRIBE : // 0
 126             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_CHOOSESUBSCRIBE);
 127             redirect(
 128                     $returnto,
 129                     get_string('everyonecannowchoose', 'forum'),
 130                     null,
 131                     \core\output\notification::NOTIFY_SUCCESS
 132                 );
 133             break;
 134         case FORUM_FORCESUBSCRIBE : // 1
 135             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_FORCESUBSCRIBE);
 136             redirect(
 137                     $returnto,
 138                     get_string('everyoneisnowsubscribed', 'forum'),
 139                     null,
 140                     \core\output\notification::NOTIFY_SUCCESS
 141                 );
 142             break;
 143         case FORUM_INITIALSUBSCRIBE : // 2
 144             if ($forum->forcesubscribe <> FORUM_INITIALSUBSCRIBE) {
 145                 $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email', '');
 146                 foreach ($users as $user) {
 147                     \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
 148                 }
 149             }
 150             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_INITIALSUBSCRIBE);
 151             redirect(
 152                     $returnto,
 153                     get_string('everyoneisnowsubscribed', 'forum'),
 154                     null,
 155                     \core\output\notification::NOTIFY_SUCCESS
 156                 );
 157             break;
 158         case FORUM_DISALLOWSUBSCRIBE : // 3
 159             \mod_forum\subscriptions::set_subscription_mode($forum->id, FORUM_DISALLOWSUBSCRIBE);
 160             redirect(
 161                     $returnto,
 162                     get_string('noonecansubscribenow', 'forum'),
 163                     null,
 164                     \core\output\notification::NOTIFY_SUCCESS
 165                 );
 166             break;
 167         default:
 168             print_error(get_string('invalidforcesubscribe', 'forum'));
 169     }
 170 }
 171
 172 if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
 173     redirect(
 174             $returnto,
 175             get_string('everyoneisnowsubscribed', 'forum'),
 176             null,
 177             \core\output\notification::NOTIFY_SUCCESS
 178         );
 179 }
 180
 181 $info = new stdClass();
 182 $info->name  = fullname($user);
 183 $info->forum = format_string($forum->name);
 184
 185 if ($issubscribed) {
 186     if (is_null($sesskey)) {
 187         // We came here via link in email.
 188         $PAGE->set_title($course->shortname);
 189         $PAGE->set_heading($course->fullname);
 190         echo $OUTPUT->header();
 191
 192         $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id));
 193         if ($discussionid) {
 194             $a = new stdClass();
 195             $a->forum = format_string($forum->name);
 196             $a->discussion = format_string($discussion->name);
 197             echo $OUTPUT->confirm(get_string('confirmunsubscribediscussion', 'forum', $a),
 198                     $PAGE->url, $viewurl);
 199         } else {
 200             echo $OUTPUT->confirm(get_string('confirmunsubscribe', 'forum', format_string($forum->name)),
 201                     $PAGE->url, $viewurl);
 202         }
 203         echo $OUTPUT->footer();
 204         exit;
 205     }
 206     require_sesskey();
 207     if ($discussionid === null) {
 208         if (\mod_forum\subscriptions::unsubscribe_user($user->id, $forum, $context, true)) {
 209             redirect(
 210                     $returnto,
 211                     get_string('nownotsubscribed', 'forum', $info),
 212                     null,
 213                     \core\output\notification::NOTIFY_SUCCESS
 214                 );
 215         } else {
 216             print_error('cannotunsubscribe', 'forum', get_local_referer(false));
 217         }
 218     } else {
 219         if (\mod_forum\subscriptions::unsubscribe_user_from_discussion($user->id, $discussion, $context)) {
 220             $info->discussion = $discussion->name;
 221             redirect(
 222                     $returnto,
 223                     get_string('discussionnownotsubscribed', 'forum', $info),
 224                     null,
 225                     \core\output\notification::NOTIFY_SUCCESS
 226                 );
 227         } else {
 228             print_error('cannotunsubscribe', 'forum', get_local_referer(false));
 229         }
 230     }
 231
 232 } else {  // subscribe
 233     if (\mod_forum\subscriptions::subscription_disabled($forum) && !has_capability('mod/forum:managesubscriptions', $context)) {
 234         print_error('disallowsubscribe', 'forum', get_local_referer(false));
 235     }
 236     if (!has_capability('mod/forum:viewdiscussion', $context)) {
 237         print_error('noviewdiscussionspermission', 'forum', get_local_referer(false));
 238     }
 239     if (is_null($sesskey)) {
 240         // We came here via link in email.
 241         $PAGE->set_title($course->shortname);
 242         $PAGE->set_heading($course->fullname);
 243         echo $OUTPUT->header();
 244
 245         $viewurl = new moodle_url('/mod/forum/view.php', array('f' => $id));
 246         if ($discussionid) {
 247             $a = new stdClass();
 248             $a->forum = format_string($forum->name);
 249             $a->discussion = format_string($discussion->name);
 250             echo $OUTPUT->confirm(get_string('confirmsubscribediscussion', 'forum', $a),
 251                     $PAGE->url, $viewurl);
 252         } else {
 253             echo $OUTPUT->confirm(get_string('confirmsubscribe', 'forum', format_string($forum->name)),
 254                     $PAGE->url, $viewurl);
 255         }
 256         echo $OUTPUT->footer();
 257         exit;
 258     }
 259     require_sesskey();
 260     if ($discussionid == null) {
 261         \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context, true);
 262         redirect(
 263                 $returnto,
 264                 get_string('nowsubscribed', 'forum', $info),
 265                 null,
 266                 \core\output\notification::NOTIFY_SUCCESS
 267             );
 268     } else {
 269         $info->discussion = $discussion->name;
 270         \mod_forum\subscriptions::subscribe_user_to_discussion($user->id, $discussion, $context);
 271         redirect(
 272                 $returnto,
 273                 get_string('discussionnowsubscribed', 'forum', $info),
 274                 null,
 275                 \core\output\notification::NOTIFY_SUCCESS
 276             );
 277     }
 278 }