Posts of users who are reviewers are already marked as reviewed upon creation; Correctly mail reviewed posts

Author: justusdieckmann

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="mod/moodleoverflow/db" VERSION="20190523" COMMENT="XMLDB file for Moodle mod/moodleoverflow"
+<XMLDB PATH="mod/moodleoverflow/db" VERSION="20220720" COMMENT="XMLDB file for Moodle mod/moodleoverflow"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
 >
@@ -69,6 +69,7 @@
         <FIELD NAME="attachment" TYPE="char" LENGTH="100" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="mailed" TYPE="int" LENGTH="1" NOTNULL="false" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="reviewed" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
+        <FIELD NAME="timereviewed" TYPE="int" LENGTH="10" NOTNULL="false" SEQUENCE="false"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -195,7 +195,7 @@ function xmldb_moodleoverflow_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2021111700, 'moodleoverflow');
     }
 
-    if ($oldversion < 2022070600) {
+    if ($oldversion < 2022072000) {
 
         // Define field needsreview to be added to moodleoverflow.
         $table = new xmldb_table('moodleoverflow');
@@ -206,7 +206,7 @@ function xmldb_moodleoverflow_upgrade($oldversion) {
             $dbman->add_field($table, $field);
         }
 
-        // Define field reviewed to be added to moodleoverflow_posts.
+        // Define field reviewed and timereviewed to be added to moodleoverflow_posts.
         $table = new xmldb_table('moodleoverflow_posts');
         $field = new xmldb_field('reviewed', XMLDB_TYPE_INTEGER, '1', null, XMLDB_NOTNULL, null, '1', 'mailed');
 
@@ -215,8 +215,15 @@ function xmldb_moodleoverflow_upgrade($oldversion) {
             $dbman->add_field($table, $field);
         }
 
+        $field = new xmldb_field('timereviewed', XMLDB_TYPE_INTEGER, '10', null, null, null, null, 'reviewed');
+
+        // Conditionally launch add field timereviewed.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
         // Moodleoverflow savepoint reached.
-        upgrade_mod_savepoint(true, 2022070600, 'moodleoverflow');
+        upgrade_mod_savepoint(true, 2022072000, 'moodleoverflow');
     }
 
     return true;

externallib.php

@@ -163,6 +163,12 @@ public static function review_approve_post_returns() {
         return new external_value(PARAM_TEXT, 'the url of the next post to review');
     }
 
+    /**
+     * Approve a post.
+     *
+     * @param int $postid ID of post to approve.
+     * @return string|null Url of next post to review.
+     */
     public static function review_approve_post($postid) {
         global $DB;
 
@@ -182,6 +188,7 @@ public static function review_approve_post($postid) {
         require_capability('mod/moodleoverflow:reviewpost', $context);
 
         $post->reviewed = 1;
+        $post->timereviewed = time();
 
         $DB->update_record('moodleoverflow_posts', $post);
 
@@ -207,10 +214,17 @@ public static function review_reject_post_returns() {
         return new external_value(PARAM_TEXT, 'the url of the next post to review');
     }
 
-    public static function review_reject_post($postid) {
+    /**
+     * Rejects a post.
+     *
+     * @param int $postid ID of post to reject.
+     * @param string|null $reason The reason for rejection.
+     * @return string|null Url of next post to review.
+     */
+    public static function review_reject_post($postid, $reason = null) {
         global $DB;
 
-        $params = self::validate_parameters(self::review_reject_post_parameters(), ['postid' => $postid]);
+        $params = self::validate_parameters(self::review_reject_post_parameters(), ['postid' => $postid, 'reason' => $reason]);
         $postid = $params['postid'];
 
         $post = $DB->get_record('moodleoverflow_posts', ['id' => $postid], '*', MUST_EXIST);

lib.php

@@ -1013,7 +1013,8 @@ function moodleoverflow_get_unmailed_posts($starttime, $endtime) {
     $sql = "SELECT p.*, d.course, d.moodleoverflow
             FROM {moodleoverflow_posts} p
             JOIN {moodleoverflow_discussions} d ON d.id = p.discussion
-            WHERE p.mailed = :mailed AND p.created >= :ptimestart AND p.created < :ptimeend AND p.reviewed = 1
+            WHERE p.mailed = :mailed AND p.reviewed = 1
+            AND COALESCE(p.timereview, p.created) >= :ptimestart AND COALESCE(p.timereview, p.created) < :ptimeend
             ORDER BY p.modified ASC";
 
     return $DB->get_records_sql($sql, $params);
@@ -1039,12 +1040,10 @@ function moodleoverflow_mark_old_posts_as_mailed($endtime) {
     $params['endtime']       = $endtime;
     $params['mailedpending'] = MOODLEOVERFLOW_MAILED_PENDING;
 
-    // TODO do something about this. Add field timereviewed to post? / Make reviewed contain either null or timestamp?
-
     // Define the sql query.
     $sql = "UPDATE {moodleoverflow_posts}
             SET mailed = :mailedsuccess
-            WHERE (created < :endtime) AND mailed = :mailedpending";
+            WHERE (created < :endtime) AND mailed = :mailedpending AND reviewed = 1";
 
     return $DB->execute($sql, $params);
 
@@ -1096,7 +1095,7 @@ function moodleoverflow_cm_info_view(cm_info $cm) {
  * Check if the user can create attachments in moodleoverflow.
  *
  * @param  stdClass $moodleoverflow moodleoverflow object
- * @param  stdClass $context        context object
+ * @param  context_module $context        context object
  *
  * @return bool true if the user can create attachments, false otherwise
  * @since  Moodle 3.3

locallib.php

@@ -696,7 +696,7 @@ function moodleoverflow_user_can_see_discussion($moodleoverflow, $discussion, $c
  * Creates a new moodleoverflow discussion.
  *
  * @param stdClass $discussion The discussion object
- * @param object   $modulecontext
+ * @param context_module $modulecontext
  * @param int      $userid     The user ID
  *
  * @return bool|int The id of the created discussion
@@ -737,7 +737,9 @@ function moodleoverflow_add_discussion($discussion, $modulecontext, $userid = nu
     $post->moodleoverflow = $moodleoverflow->id;
     $post->course = $moodleoverflow->course;
 
-    if (review::get_review_level($moodleoverflow) > review::QUESTIONS) {
+    // Set to not reviewed, if questions should be reviewed, and user is not a reviewer themselves.
+    if (review::get_review_level($moodleoverflow) > review::QUESTIONS &&
+            !has_capability('mod/moodleoverflow:reviewpost', $modulecontext, $userid)) {
         $post->reviewed = 0;
     }
 
@@ -1562,10 +1564,11 @@ function moodleoverflow_add_attachment($post, $forum, $cm) {
  * Adds a new post in an existing discussion.
  *
  * @param object $post The post object
+ * @param context_module $modulecontext
  *
  * @return bool|int The Id of the post if operation was successful
  */
-function moodleoverflow_add_new_post($post) {
+function moodleoverflow_add_new_post($post, $modulecontext) {
     global $USER, $DB;
 
     // We do not check if these variables exist because this function
@@ -1581,18 +1584,24 @@ function moodleoverflow_add_new_post($post) {
         $post->totalscore = 0;
     }
 
-    if (review::get_review_level($moodleoverflow) == review::EVERYTHING) {
+    // Set to not reviewed, if posts should be reviewed, and user is not a reviewer themselves.
+    if (review::get_review_level($moodleoverflow) == review::EVERYTHING &&
+            !has_capability('mod/moodleoverflow:reviewpost', $modulecontext)) {
         $post->reviewed = 0;
+    } else {
+        $post->reviewed = 1;
     }
 
     // Add the post to the database.
     $post->id = $DB->insert_record('moodleoverflow_posts', $post);
     $DB->set_field('moodleoverflow_posts', 'message', $post->message, array('id' => $post->id)); // ??
     moodleoverflow_add_attachment($post, $moodleoverflow, $cm);
 
-    // Update the discussion.
-    $DB->set_field('moodleoverflow_discussions', 'timemodified', $post->modified, array('id' => $post->discussion));
-    $DB->set_field('moodleoverflow_discussions', 'usermodified', $post->userid, array('id' => $post->discussion));
+    if ($post->reviewed) {
+        // Update the discussion.
+        $DB->set_field('moodleoverflow_discussions', 'timemodified', $post->modified, array('id' => $post->discussion));
+        $DB->set_field('moodleoverflow_discussions', 'usermodified', $post->userid, array('id' => $post->discussion));
+    }
 
     // Mark the created post as read if the user is tracking the discussion.
     $cantrack = \mod_moodleoverflow\readtracking::moodleoverflow_can_track_moodleoverflows($moodleoverflow);
@@ -1635,7 +1644,7 @@ function moodleoverflow_update_post($newpost) {
         }
     }
 
-    if (isset($newpost->reviewed) ? $newpost->reviewed : $post->reviewed) {
+    if ($newpost->reviewed ?? $post->reviewed) {
         // Update the date and the user of the post and the discussion.
         $post->modified = time();
         $discussion->timemodified = $post->modified;

post.php

@@ -659,7 +659,7 @@
         $addpost->moodleoverflow = $moodleoverflow->id;
 
         // Create the new post.
-        if ($fromform->id = moodleoverflow_add_new_post($addpost)) {
+        if ($fromform->id = moodleoverflow_add_new_post($addpost, $modulecontext)) {
 
             // Subscribe to this thread.
             $discussion = new \stdClass();

version.php

@@ -28,7 +28,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'mod_moodleoverflow';
-$plugin->version = 2022071900;
+$plugin->version = 2022072000;
 $plugin->release = 'v4.0-r2';
 $plugin->requires = 2020061500; // Requires Moodle 3.9+.
 $plugin->maturity = MATURITY_STABLE;