Allow users without capability 'allowforcesubscribe' to optionally subscribe in forcedsubscription mode

Author: justusdieckmann

classes/subscriptions.php

@@ -98,10 +98,11 @@ class subscriptions {
      *
      * @return bool
      */
-    public static function is_subscribed($userid, $moodleoverflow, $discussionid = null) {
+    public static function is_subscribed($userid, $moodleoverflow, $context, $discussionid = null) {
 
         // Is the user forced to be subscribed to the moodleoverflow?
-        if (self::is_forcesubscribed($moodleoverflow)) {
+        if (self::is_forcesubscribed($moodleoverflow) &&
+            has_capability('mod/moodleoverflow:allowforcesubscribe', $context, $userid)) {
             return true;
         }
 
@@ -539,13 +540,7 @@ public static function get_subscribed_users($moodleoverflow, $context, $fields =
                 u.picture, u.timezone, u.theme, u.lang, u.trackforums, u.mnethostid";
         }
 
-        // Check if the user is forced to e subscribed to a moodleoverflow.
-        if (self::is_forcesubscribed($moodleoverflow)) {
-
-            // Find the list of potential subscribers.
-            $results = self::get_potential_subscribers($context, $fields, 'u.email ASC');
-
-        } else if (self::subscription_disabled($moodleoverflow)) {
+        if (self::subscription_disabled($moodleoverflow)) {
             $results = [];
         } else {
 
@@ -588,6 +583,12 @@ public static function get_subscribed_users($moodleoverflow, $context, $fields =
 
             // Fetch the data.
             $results = $DB->get_records_sql($sql, $params);
+
+            if (self::is_forcesubscribed($moodleoverflow)) {
+                foreach (self::get_potential_subscribers($context, $fields, 'u.email ASC') as $id => $user) {
+                    $results[$id] = $user;
+                }
+            }
         }
 
         // Remove all guest users from the results. They should never be subscribed to a moodleoverflow.
@@ -647,7 +648,7 @@ public static function subscribe_user($userid, $moodleoverflow, $context, $userr
         global $DB;
 
         // Check if the user is already subscribed.
-        if (self::is_subscribed($userid, $moodleoverflow)) {
+        if (self::is_subscribed($userid, $moodleoverflow, $context)) {
             return true;
         }
 
@@ -914,7 +915,7 @@ public static function unsubscribe_user_from_discussion($userid, $discussion, $c
      * Generate and return the subscribe or unsubscribe link for a moodleoverflow.
      *
      * @param object $moodleoverflow the moodleoverflow. Fields used are $moodleoverflow->id and $moodleoverflow->forcesubscribe.
-     * @param object $context        the context object for this moodleoverflow.
+     * @param \context $context        the context object for this moodleoverflow.
      * @param array  $messages       text used for the link in its various states
      *                               (subscribed, unsubscribed, forcesubscribed or cantsubscribe).
      *                               Any strings not passed in are taken from the $defaultmessages array
@@ -953,7 +954,7 @@ public static function moodleoverflow_get_subscribe_link($moodleoverflow, $conte
             }
 
             // Check whether the user is subscribed.
-            $issubscribed = self::is_subscribed($USER->id, $moodleoverflow);
+            $issubscribed = self::is_subscribed($USER->id, $moodleoverflow, $context);
 
             // Define the text of the link depending on the subscription state.
             if ($issubscribed) {
@@ -984,7 +985,7 @@ public static function moodleoverflow_get_subscribe_link($moodleoverflow, $conte
      * @param object $fromform       The submitted form
      * @param \stdClass       $moodleoverflow The moodleoverflow record
      * @param \stdClass       $discussion     The discussion record
-     * @param \context_course $modulecontext  The context of the module
+     * @param \context_module $modulecontext  The context of the module
      *
      * @return bool
      */
@@ -996,15 +997,15 @@ public static function moodleoverflow_post_subscription($fromform, $moodleoverfl
         $disabled = self::subscription_disabled($moodleoverflow);
 
         // Do not continue if the user is already forced to be subscribed.
-        if ($force) {
+        if ($force && has_capability('mod/moodleoverflow:allowforcesubscribe', $modulecontext)) {
             return false;
         }
 
         // Do not continue if subscriptions are disabled.
         if ($disabled) {
 
             // If the user is subscribed, unsubscribe him.
-            $subscribed    = self::is_subscribed($USER->id, $moodleoverflow);
+            $subscribed    = self::is_subscribed($USER->id, $moodleoverflow, $modulecontext);
             $coursecontext = \context_course::instance($moodleoverflow->course);
             $canmanage     = has_capability('moodle/course:manageactivities', $coursecontext, $USER->id);
             if ($subscribed AND !$canmanage) {
@@ -1025,18 +1026,19 @@ public static function moodleoverflow_post_subscription($fromform, $moodleoverfl
      * Return the markup for the discussion subscription toggling icon.
      *
      * @param object $moodleoverflow The forum moodleoverflow.
+     * @param \context $context
      * @param int    $discussionid   The discussion to create an icon for.
      *
      * @return string The generated markup.
      */
-    public static function get_discussion_subscription_icon($moodleoverflow, $discussionid) {
+    public static function get_discussion_subscription_icon($moodleoverflow, $context, $discussionid) {
         global $OUTPUT, $PAGE, $USER;
 
         // Set the url to return to.
         $returnurl = $PAGE->url->out();
 
         // Check if the discussion is subscrived.
-        $status = self::is_subscribed($USER->id, $moodleoverflow, $discussionid);
+        $status = self::is_subscribed($USER->id, $moodleoverflow, $context, $discussionid);
 
         // Create a link to subscribe or unsubscribe to the discussion.
         $array            = array(

index.php

@@ -141,7 +141,7 @@
     // Get information about the subscription state.
     $cansubscribe                 = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow);
     $moodleoverflow->cansubscribe = $cansubscribe || has_capability('mod/moodleoverflow:managesubscriptions', $modulecontext);
-    $moodleoverflow->issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, null);
+    $moodleoverflow->issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, $modulecontext);
     $showsubscriptioncolumns      = $showsubscriptioncolumns || $moodleoverflow->issubscribed || $moodleoverflow->cansubscribe;
 
     // Add the moodleoverflow to the cache.
@@ -196,7 +196,7 @@
         if (!$forcesubscribed) {
 
             // Check the current state.
-            $subscribed   = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, null);
+            $subscribed   = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, $modulecontext);
             $subscribable = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow);
 
             // Check whether to subscribe or unsubscribe the user.

lib.php

@@ -489,7 +489,8 @@ function moodleoverflow_extend_settings_navigation(settings_navigation $settings
     $canmanage       = has_capability('mod/moodleoverflow:managesubscriptions', $PAGE->cm->context);
     $forcesubscribed = \mod_moodleoverflow\subscriptions::is_forcesubscribed($moodleoverflow);
     $subscdisabled   = \mod_moodleoverflow\subscriptions::subscription_disabled($moodleoverflow);
-    $cansubscribe    = ($activeenrolled AND !$forcesubscribed AND (!$subscdisabled OR $canmanage));
+    $cansubscribe    = $activeenrolled && (!$subscdisabled || $canmanage) &&
+        !($forcesubscribed && has_capability('mod/moodleoverflow:allowforcesubscribe', $PAGE->cm->context));
     $cantrack        = \mod_moodleoverflow\readtracking::moodleoverflow_can_track_moodleoverflows($moodleoverflow);
 
     // Display a link to the index.
@@ -511,7 +512,7 @@ function moodleoverflow_extend_settings_navigation(settings_navigation $settings
     if ($cansubscribe) {
 
         // Choose the linktext depending on the current state of subscription.
-        $issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, null);
+        $issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, $PAGE->cm->context);
         if ($issubscribed) {
             $linktext = get_string('unsubscribe', 'moodleoverflow');
         } else {
@@ -779,7 +780,7 @@ function moodleoverflow_send_mails() {
                 $iscm         = $coursemodules[$moodleoverflow->id];
                 $uid          = $userto->id;
                 $did          = $post->discussion;
-                $issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($uid, $moodleoverflow, $did);
+                $issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($uid, $moodleoverflow, $modulecontext, $did);
                 if (!$issubscribed) {
                     continue;
                 }

locallib.php

@@ -334,7 +334,7 @@ function moodleoverflow_print_latest_discussions($moodleoverflow, $cm, $page = -
             // Discussion subscription.
             if (\mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow)) {
                 $preparedarray[$i]['discussionsubicon'] = \mod_moodleoverflow\subscriptions::get_discussion_subscription_icon(
-                    $moodleoverflow, $discussion->discussion);
+                    $moodleoverflow, $context, $discussion->discussion);
             }
         }
 

subscribe.php

@@ -97,7 +97,7 @@
 }
 
 // Check if the user is already subscribed.
-$issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($user->id, $moodleoverflow, $discussionid, $cm);
+$issubscribed = \mod_moodleoverflow\subscriptions::is_subscribed($user->id, $moodleoverflow, $context, $discussionid);
 
 // To subscribe to a moodleoverflow or a discussion, the user needs to be logged in.
 require_login($course, false, $cm);
@@ -184,7 +184,7 @@
 
 // Redirect the user back if the user is forced to be subscribed.
 $isforced = \mod_moodleoverflow\subscriptions::is_forcesubscribed($moodleoverflow);
-if ($isforced) {
+if ($isforced && has_capability('mod/moodleoverflow:allowforcesubscribe', $context)) {
     redirect($returnto, $strings['everyoneisnowsubscribed'], null, $notify['success']);
     exit;
 }

tests/locallib_test.php

@@ -71,7 +71,7 @@ public function test_moodleoverflow_auto_subscribe_on_create() {
         $result = \mod_moodleoverflow\subscriptions::get_subscribed_users($mo, $context);
         $this->assertEquals($usercount, count($result));
         foreach ($users as $user) {
-            $this->assertTrue(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo));
+            $this->assertTrue(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo, $context));
         }
     }
 
@@ -103,7 +103,7 @@ public function test_moodleoverflow_forced_subscribe_on_create() {
         $result = \mod_moodleoverflow\subscriptions::get_subscribed_users($mo, $context);
         $this->assertEquals($usercount, count($result));
         foreach ($users as $user) {
-            $this->assertTrue(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo));
+            $this->assertTrue(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo, $context));
         }
     }
 
@@ -134,7 +134,7 @@ public function test_moodleoverflow_optional_subscribe_on_create() {
         $result = \mod_moodleoverflow\subscriptions::get_subscribed_users($mo, $context);
         $this->assertEquals(0, count($result));
         foreach ($users as $user) {
-            $this->assertFalse(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo));
+            $this->assertFalse(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo, $context));
         }
     }
 
@@ -165,7 +165,7 @@ public function test_moodleoverflow_disallow_subscribe_on_create() {
         $result = \mod_moodleoverflow\subscriptions::get_subscribed_users($mo, $context);
         $this->assertEquals(0, count($result));
         foreach ($users as $user) {
-            $this->assertFalse(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo));
+            $this->assertFalse(\mod_moodleoverflow\subscriptions::is_subscribed($user->id, $mo, $context));
         }
     }