WIP - update unread posts after marking posts as read

Author: TamaroWalter

amd/build/readtracking.min.js

@@ -30,7 +30,7 @@ import Ajax from 'core/ajax';
  */
 export function init(itemid) {
     const element = document.getElementById(itemid);
-    element.addEventListener('click', function() {
+    element.addEventListener('click', async function() {
         const userid = parseInt(element.dataset.userid);
         const instanceid = parseInt(element.dataset.instanceid);
         const domain = element.dataset.domain;
@@ -42,6 +42,8 @@ export function init(itemid) {
                 userid: userid
             },
         };
-        return Ajax.call([data]);
+        const result = await Ajax.call([data])[0];
+        // Update the red bubble icon with the new amount of unread posts.
+        return result;
     });
 }

amd/build/readtracking.min.js.map

@@ -458,23 +458,11 @@ public static function get_untracked_moodleoverflows($userid, $courseid) {
      */
     public static function moodleoverflow_count_unread_posts_moodleoverflow($cm) {
         global $DB, $USER;
-
-        $moodleoverflow = $DB->get_record_sql("SELECT m.*, tm.id as hasdisabledtracking " .
-                "FROM {moodleoverflow} m " .
-                "LEFT JOIN {moodleoverflow_tracking} tm ON m.id = tm.moodleoverflowid AND tm.userid = :userid " .
-                "WHERE m.id = :moodleoverflowid", ['userid' => $USER->id, 'moodleoverflowid' => $cm->instance]);
-
         // Return if tracking is off, or ((optional or forced, but forced disallowed by admin) and user has disabled tracking).
-        if (
-            $moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_OFF || (
-                        ($moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_OPTIONAL || (
-                                        $moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_FORCED &&
-                                        !get_config('moodleoverflow', 'allowforcedreadtracking')
-                                )
-                        ) && $moodleoverflow->hasdisabledtracking)
-        ) {
+        if (self::check_tracking_off($cm->instance, $USER->id)) {
             return 0;
         }
+
         // Get the current timestamp and the cutoffdate.
         $now = round(time(), -2);
         $cutoffdate = $now - (get_config('moodleoverflow', 'oldpostdays') * 24 * 60 * 60);
@@ -490,4 +478,63 @@ public static function moodleoverflow_count_unread_posts_moodleoverflow($cm) {
         // Return the number of unread posts per moodleoverflow.
         return $DB->get_field_sql($sql, $params);
     }
+
+    /**
+     * Get amound of unread posts in a discussion
+     * @param int $discussionid
+     * @param int $userid
+     * @return int
+     */
+    public static function moodleoverflow_count_unread_posts_discussion(int $discussionid, int $userid = 0) {
+        global $DB, $USER;
+        if ($userid == 0) {
+            $userid = $USER->id;
+        }
+        $discussion = $DB->get_record('moodleoverflow_discussions', ['id' => $discussionid]);
+
+        if (self::check_tracking_off($discussion->moodleoverflow, $userid)) {
+            return 0;
+        }
+
+        // Get the current timestamp and the cutoffdate.
+        $now = round(time(), -2);
+        $cutoffdate = $now - (get_config('moodleoverflow', 'oldpostdays') * 24 * 60 * 60);
+
+        // Define a sql-query.
+        $params = [$USER->id, $discussion->id, $cutoffdate];
+        $sql = "SELECT COUNT(p.id)
+                  FROM {moodleoverflow_posts} p
+                  JOIN {moodleoverflow_discussions} d ON p.discussion = d.id
+             LEFT JOIN {moodleoverflow_read} r ON (r.postid = p.id AND r.userid = ?)
+                 WHERE d.id = ? AND p.modified >= ? AND r.id IS NULL";
+
+        // Return the number of unread posts per discussion.
+        return $DB->get_field_sql($sql, $params);
+    }
+
+    /**
+     * Helper function, checks if:
+     * tracking is off, or ((optional or forced, but forced disallowed by admin) and user has disabled tracking).
+     * @param int $moodleoverflowid Object from DB.
+     * @param int $userid
+     * @return bool
+     */
+    private static function check_tracking_off(int $moodleoverflowid, int $userid): bool {
+        global $DB;
+        $moodleoverflow = $DB->get_record_sql("SELECT m.*, tm.id as hasdisabledtracking " .
+            "FROM {moodleoverflow} m " .
+            "LEFT JOIN {moodleoverflow_tracking} tm ON m.id = tm.moodleoverflowid AND tm.userid = :userid " .
+            "WHERE m.id = :moodleoverflowid", ['userid' => $userid, 'moodleoverflowid' => $moodleoverflowid]);
+
+        return (
+            $moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_OFF || (
+                $moodleoverflow->hasdisabledtracking && (
+                    $moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_OPTIONAL || (
+                        $moodleoverflow->trackingtype == MOODLEOVERFLOW_TRACKING_FORCED &&
+                        !get_config('moodleoverflow', 'allowforcedreadtracking')
+                    )
+                )
+            )
+        );
+    }
 }

amd/src/readtracking.js

@@ -412,27 +412,31 @@ public static function mark_post_read_parameters(): external_function_parameters
      * @return external_value
      */
     public static function mark_post_read_returns(): external_value {
-        return new external_value(PARAM_BOOL, 'true if successful');
+        return new external_value(PARAM_INT, 'Amount of unread posts after calling the function');
     }
 
     /**
      * Marks all posts of a discussion/moodleoverflow as read
      * @param int $instanceid id of the discussion/moodleoverflow.
      * @param string $domain Can be "moodleoverflow" or "discussion"
      * @param int $userid
-     * @return bool
+     * @return int Return how many unread posts the user has in the discussion/moodleoverflow. JS uses it to update the unread info.
+     *             (It should always be 0, otherwise an error ocurred. This is important for behat testing).
      * @throws coding_exception|dml_exception
      */
-    public static function mark_post_read(int $instanceid, string $domain, int $userid): bool {
+    public static function mark_post_read(int $instanceid, string $domain, int $userid): int {
         global $DB;
         if ($domain == 'moodleoverflow') {
             $cm = get_coursemodule_from_instance('moodleoverflow', $instanceid);
-            return readtracking::moodleoverflow_mark_moodleoverflow_read($cm, $userid);
+            readtracking::moodleoverflow_mark_moodleoverflow_read($cm, $userid);
+            return readtracking::moodleoverflow_count_unread_posts_moodleoverflow($cm);
         } else {
             $discussion = $DB->get_record('moodleoverflow_discussions', ['id' => $instanceid]);
             $cm = get_coursemodule_from_instance('moodleoverflow', $discussion->moodleoverflow, $discussion->course);
-            $modcontext = context_module::instance($cm->id);
-            return readtracking::moodleoverflow_mark_discussion_read($instanceid, $modcontext, $userid);
+            readtracking::moodleoverflow_mark_discussion_read($instanceid, context_module::instance($cm->id), $userid);
+            return readtracking::moodleoverflow_count_unread_posts_discussion($instanceid);
         }
+
+
     }
 }

classes/readtracking.php

@@ -26,7 +26,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2025112706;
+$plugin->version = 2025112707;
 $plugin->requires = 2024100700.00; // Require Moodle 4.5.
 $plugin->supported = [405, 501];
 $plugin->component = 'mod_moodleoverflow';