Merge pull request #108 from learnweb/fix/subscription-cap

Fix/use allowforcesubscription capability

Author: Laur0r

amd/build/warnmodechange.min.js

@@ -0,0 +1,53 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Warns on changing the subscription mode.
+ *
+ * @module     mod_moodleoverflow/warnmodechange
+ * @copyright  2022 Justus Dieckmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+import {get_string as getString} from 'core/str';
+import Notification from 'core/notification';
+import Prefetch from 'core/prefetch';
+
+/**
+ * Init function.
+ * @param {string} previousSetting
+ */
+export function init(previousSetting) {
+    Prefetch.prefetchStrings('mod_moodleoverflow', ['switchtooptional', 'switchtoauto']);
+    Prefetch.prefetchStrings('moodle', ['confirm', 'cancel']);
+    const form = document.querySelector('form.mform');
+    const select = document.getElementById('id_forcesubscribe');
+    form.onsubmit = async(e) => {
+        const value = select.selectedOptions[0].value;
+        if (value == previousSetting || value == 1 || value == 3) {
+            return;
+        }
+        e.preventDefault();
+        await Notification.confirm(
+            await getString('confirm'),
+            await getString(value == 0 ? 'switchtooptional' : 'switchtoauto', 'mod_moodleoverflow'),
+            await getString('confirm'),
+            await getString('cancel'),
+            () => {
+                // Prevent this listener from preventing the event again.
+                form.onsubmit = undefined;
+                form.requestSubmit(e.submitter);
+            }, undefined);
+    };
+}

amd/build/warnmodechange.min.js.map

@@ -251,7 +251,8 @@ public function __set($name, $value) {
     public function get_unsubscribediscussionlink() {
 
         // Check whether the moodleoverflow is subscribable.
-        $subscribable = \mod_moodleoverflow\subscriptions::is_subscribable($this->moodleoverflow);
+        $subscribable = \mod_moodleoverflow\subscriptions::is_subscribable($this->moodleoverflow,
+                \context_module::instance($this->cm->id));
         if (!$subscribable) {
             return null;
         }
@@ -431,7 +432,8 @@ public function get_replylink() {
      * @return string
      */
     public function get_unsubscribemoodleoverflowlink() {
-        if (!\mod_moodleoverflow\subscriptions::is_subscribable($this->moodleoverflow)) {
+        if (!\mod_moodleoverflow\subscriptions::is_subscribable($this->moodleoverflow,
+                \context_module::instance($this->cm->id))) {
             return null;
         }
         $link = new \moodle_url(

amd/src/warnmodechange.js

@@ -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;
         }
 
@@ -354,10 +355,11 @@ public static function subscription_disabled($moodleoverflow) {
      * Checks wheter the specified moodleoverflow can be subscribed to.
      *
      * @param object $moodleoverflow The moodleoverflow ID
+     * @param \context_module $context The module context.
      *
      * @return boolean
      */
-    public static function is_subscribable($moodleoverflow) {
+    public static function is_subscribable($moodleoverflow, $context) {
 
         // Check if the user is an authenticated user.
         $authenticated = (isloggedin() AND !isguestuser());
@@ -366,7 +368,8 @@ public static function is_subscribable($moodleoverflow) {
         $disabled = self::subscription_disabled($moodleoverflow);
 
         // Check if the moodleoverflow forces the user to be subscribed.
-        $forced = self::is_forcesubscribed($moodleoverflow);
+        $forced = self::is_forcesubscribed($moodleoverflow) &&
+                has_capability('mod/moodleoverflow:allowforcesubscribe', $context);
 
         // Return the result.
         return ($authenticated AND !$forced AND !$disabled);
@@ -462,7 +465,7 @@ public static function get_potential_subscribers($context, $fields, $sort = '')
         global $DB;
 
         // Only enrolled users can subscribe.
-        list($esql, $params) = get_enrolled_sql($context);
+        list($esql, $params) = get_enrolled_sql($context, 'mod/moodleoverflow:allowforcesubscribe');
 
         // Default ordering of the list.
         if (!$sort) {
@@ -539,12 +542,8 @@ 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');
-
+        if (self::subscription_disabled($moodleoverflow)) {
+            $results = [];
         } else {
 
             // Only enrolled users can subscribe to a moodleoverflow.
@@ -586,6 +585,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.
@@ -645,7 +650,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;
         }
 
@@ -912,7 +917,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
@@ -935,7 +940,7 @@ public static function moodleoverflow_get_subscribe_link($moodleoverflow, $conte
         $messages = $messages + $defaultmessages;
 
         // Check whether the user is forced to be subscribed to the moodleoverflow.
-        $isforced   = self::is_forcesubscribed($moodleoverflow);
+        $isforced   = self::is_forcesubscribed($moodleoverflow) && has_capability('mod/moodleoverflow:allowforcesubscribe', $context);
         $isdisabled = self::subscription_disabled($moodleoverflow);
 
         // Return messages depending on the subscription state.
@@ -951,7 +956,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) {
@@ -982,7 +987,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
      */
@@ -994,15 +999,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) {
@@ -1023,18 +1028,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(

classes/output/moodleoverflow_email.php

@@ -139,9 +139,9 @@
     }
 
     // Get information about the subscription state.
-    $cansubscribe                 = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow);
+    $cansubscribe                 = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow, $modulecontext);
     $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.
@@ -192,12 +192,13 @@
         }
 
         // Check the subscription state.
-        $forcesubscribed = \mod_moodleoverflow\subscriptions::is_forcesubscribed($moodleoverflow);
+        $forcesubscribed = \mod_moodleoverflow\subscriptions::is_forcesubscribed($moodleoverflow) &&
+                has_capability('mod/moodleoverflow:allowforcesubscribe', $modulecontext);
         if (!$forcesubscribed) {
 
             // Check the current state.
-            $subscribed   = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, null);
-            $subscribable = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow);
+            $subscribed   = \mod_moodleoverflow\subscriptions::is_subscribed($USER->id, $moodleoverflow, $modulecontext);
+            $subscribable = \mod_moodleoverflow\subscriptions::is_subscribable($moodleoverflow, $modulecontext);
 
             // Check whether to subscribe or unsubscribe the user.
             if ($cap['manageactivities'] OR $subscribable AND $subscribe AND !$subscribed AND $cansub) {

classes/subscriptions.php

@@ -53,6 +53,7 @@
 $string['moodleoverflow:viewdiscussion']      = 'View discussion';
 $string['moodleoverflow:view']                = 'View discussionlist';
 $string['moodleoverflow:marksolved']          = 'Mark a post as solution';
+$string['moodleoverflow:reviewpost']          = 'Review (approve or reject) posts';
 $string['nowallsubscribed']                   = 'All forums in {$a} are subscribed.';
 $string['nowallunsubscribed']                 = 'All forums in {$a} are unsubscribed.';
 
@@ -293,6 +294,8 @@
 $string['subscriptionforced']           = 'Forced subscription';
 $string['subscriptionauto']             = 'Auto subscription';
 $string['subscriptiondisabled']         = 'Subscription disabled';
+$string['switchtooptional']             = 'If you switch to the optional subscription, all currently subscribed users will be unsubscribed from this forum!';
+$string['switchtoauto']                 = 'If you switch to the auto subscription, all enrolled users will be subscribed to this forum!';
 $string['trackingoff']                  = 'Off';
 $string['trackingon']                   = 'Forced';
 $string['trackingoptional']             = 'Optional';