Implement initial delay for reviews to allow posters time for editing

Author: justusdieckmann

classes/review.php

@@ -114,5 +114,29 @@ public static function get_first_review_post($afterpostid = null) {
         }
     }
 
+    /**
+     * Return if the post does need/needed a review with the current moodleoverflow settings.
+     * @param object $post
+     * @param object $moodleoverflow
+     * @return bool
+     */
+    public static function should_post_be_reviewed($post, $moodleoverflow): bool {
+        $reviewlevel = self::get_review_level($moodleoverflow);
+        if ($post->parent) {
+            return $reviewlevel == self::EVERYTHING;
+        } else {
+            return $reviewlevel >= self::QUESTIONS;
+        }
+    }
+
+    /**
+     * Returns whether a post is reviewable depending on its review state and review period.
+     * @param object $post
+     * @return bool
+     */
+    public static function is_post_in_review_period($post): bool {
+        return time() - $post->created > get_config('moodleoverflow', 'reviewpossibleaftertime');
+    }
+
 
 }

externallib.php

@@ -22,6 +22,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+use mod_moodleoverflow\review;
+
 defined('MOODLE_INTERNAL') || die;
 
 require_once("$CFG->libdir/externallib.php");
@@ -176,23 +178,34 @@ public static function review_approve_post($postid) {
         $postid = $params['postid'];
 
         $post = $DB->get_record('moodleoverflow_posts', ['id' => $postid], '*', MUST_EXIST);
-        $moodleoverflow = $DB->get_record_sql(
-            'SELECT m.* FROM {moodleoverflow} m ' .
-            'JOIN {moodleoverflow_discussions} d ON d.moodleoverflow = m.id ' .
-            'WHERE d.id = :discussionid',
-            ['discussionid' => $post->discussion], MUST_EXIST
-        );
+        $discussion = $DB->get_record('moodleoverflow_discussions', ['id' => $post->discussion], '*', MUST_EXIST);
+        $moodleoverflow = $DB->get_record('moodleoverflow', ['id' => $discussion->moodleoverflow], '*', MUST_EXIST);
+
         $cm = get_coursemodule_from_instance('moodleoverflow', $moodleoverflow->id);
         $context = context_module::instance($cm->id);
 
         require_capability('mod/moodleoverflow:reviewpost', $context);
 
+        if ($post->reviewed) {
+            throw new coding_exception('post was already approved!');
+        }
+
+        if (!review::is_post_in_review_period($post)) {
+            throw new coding_exception('post is not yet in review period!');
+        }
+
         $post->reviewed = 1;
         $post->timereviewed = time();
 
         $DB->update_record('moodleoverflow_posts', $post);
 
-        return \mod_moodleoverflow\review::get_first_review_post($post->id);
+        if ($post->modified > $discussion->timemodified) {
+            $discussion->timemodified = $post->modified;
+            $discussion->usermodified = $post->userid;
+            $DB->update_record('moodleoverflow_discussions', $discussion);
+        }
+
+        return review::get_first_review_post($post->id);
     }
 
     /**
@@ -239,8 +252,16 @@ public static function review_reject_post($postid, $reason = null) {
 
         require_capability('mod/moodleoverflow:reviewpost', $context);
 
+        if ($post->reviewed) {
+            throw new coding_exception('post was already approved!');
+        }
+
+        if (!review::is_post_in_review_period($post)) {
+            throw new coding_exception('post is not yet in review period!');
+        }
+
         // Has to be done before deleting the post.
-        $url = \mod_moodleoverflow\review::get_first_review_post($post->id);
+        $url = review::get_first_review_post($post->id);
 
         moodleoverflow_delete_post($post, true, $cm, $moodleoverflow);
 

lang/en/moodleoverflow.php

@@ -92,7 +92,7 @@
 $string['maxattachments_help']       = 'This setting specifies the maximum number of files that can be attached to a forum post.';
 $string['configmaxattachments']      = 'Default maximum number of attachments allowed per post.';
 $string['maxeditingtime']            = 'Maximum amount of time during which a post can be edited by its owner (sec)';
-$string['configmaxeditingtime']      = 'Default maximum seconds are 3600 (= one hour).';
+$string['configmaxeditingtime']      = 'Default maximum seconds are 3600 (= one hour). Regarding editing posts, please also consider the <a href="#admin-reviewpossibleaftertime">"Review possible after" setting</a> for moderated forums.';
 $string['configoldpostdays']         = 'Number of days old any post is considered read.';
 $string['oldpostdays']               = 'Read after days';
 $string['trackingoff']               = 'Off';
@@ -425,7 +425,7 @@
 $string['nothing'] = 'Nothing';
 $string['questions'] = 'Questions';
 $string['questions_and_posts'] = 'Questions and answers';
-$string['allowreview'] = 'Allow reviews';
+$string['allowreview'] = 'Allow moderated forums';
 $string['allowreview_desc'] = 'Allow teachers to enable that all posts (or only all questions) have to be reviewed by them in order to be published.';
 $string['amount_waiting_for_review'] = '{$a} post(s) need to be reviewed!';
 $string['pending_review'] = 'Pending review';
@@ -436,6 +436,9 @@
 $string['give_a_reason'] = 'Give a reason (optional)';
 $string['approve'] = 'Approve';
 $string['reject'] = 'Reject';
+$string['reviewpossibleaftertime'] = 'Review possible after (secs)';
+$string['reviewpossibleaftertime_desc'] = 'A teacher can only reject or approve a post at least this amount of time (in seconds) after the creation of the post. After a teacher has approved a post, the post cannot be edited by it\'s author anymore, even if still within the maxeditingtime duration.';
+$string['pending_review_but_cannot_now'] = 'Pending review, but can only be approved at least {$a} after the creation of this post to allow the author a bit of time to edit it.';
 
 $string['rejected_email_subject'] = 'One of your posts in {$a->course} {$a->activity} has been rejected.';
 $string['rejected_email_content'] = 'This post has been rejected in {$a->course} {$a->activity}';

locallib.php

@@ -1191,8 +1191,9 @@ function moodleoverflow_print_post($post, $discussion, $moodleoverflow, $cm, $co
     // Calculate the age of the post.
     $age = time() - $post->created;
 
-    // Make a link to edit your own post within the given time.
-    if (($ownpost AND ($age < get_config('moodleoverflow', 'maxeditingtime')))
+    // Make a link to edit your own post within the given time and not already reviewed.
+    if (($ownpost AND ($age < get_config('moodleoverflow', 'maxeditingtime')) &&
+                    (!review::should_post_be_reviewed($post, $moodleoverflow) || !$post->reviewed))
         OR $cm->cache->caps['mod/moodleoverflow:editanypost']
     ) {
         $editurl = new moodle_url('/mod/moodleoverflow/post.php', array('edit' => $post->id));
@@ -1363,8 +1364,12 @@ function moodleoverflow_print_post($post, $discussion, $moodleoverflow, $cm, $co
     $options->trusted = false;
     $options->context = $modulecontext;
 
+    $reviewdelay = get_config('moodleoverflow', 'reviewpossibleaftertime');
+    $mustachedata->reviewdelay = format_time($reviewdelay);
     $mustachedata->needsreview = !$post->reviewed;
-    $mustachedata->canreview = $cm->cache->caps['mod/moodleoverflow:reviewpost'];
+    $reviewable = time() - $post->created > $reviewdelay;
+    $mustachedata->canreview = $cm->cache->caps['mod/moodleoverflow:reviewpost'] && $reviewable;
+    $mustachedata->withinreviewperiod = $reviewable;
 
     // Prepare the post.
     $mustachedata->postcontent = format_text($post->message, $post->messageformat, $options, $course->id);
@@ -1644,9 +1649,9 @@ function moodleoverflow_update_post($newpost) {
         }
     }
 
+    $post->modified = time();
     if ($newpost->reviewed ?? $post->reviewed) {
         // Update the date and the user of the post and the discussion.
-        $post->modified = time();
         $discussion->timemodified = $post->modified;
         $discussion->usermodified = $post->userid;
     }

post.php

@@ -25,6 +25,8 @@
 // TODO refactor this. For more readability, and to avoid security issues.
 
 // Include config and locallib.
+use mod_moodleoverflow\review;
+
 require_once(dirname(dirname(dirname(__FILE__))) . '/config.php');
 global $CFG, $USER, $DB, $PAGE, $SESSION, $OUTPUT;
 require_once(dirname(__FILE__) . '/locallib.php');
@@ -298,12 +300,15 @@
     $PAGE->set_cm($cm, $course, $moodleoverflow);
 
     // Check if the post can be edited.
-    $intime = ((time() - $post->created) > get_config('moodleoverflow', 'maxeditingtime'));
-    if ($intime AND !has_capability('mod/moodleoverflow:editanypost', $modulecontext)) {
+    $beyondtime = ((time() - $post->created) > get_config('moodleoverflow', 'maxeditingtime'));
+    $alreadyreviewed = review::should_post_be_reviewed($post, $moodleoverflow) && $post->reviewed;
+    if (($beyondtime || $alreadyreviewed) AND !has_capability('mod/moodleoverflow:editanypost', $modulecontext)) {
         throw new moodle_exception('maxtimehaspassed', 'moodleoverflow', '',
             format_time(get_config('moodleoverflow', 'maxeditingtime')));
     }
 
+
+
     // If the current user is not the one who posted this post.
     if ($post->userid <> $USER->id) {
 
@@ -603,7 +608,7 @@
         $replypost = has_capability('mod/moodleoverflow:replypost', $modulecontext);
         $startdiscussion = has_capability('mod/moodleoverflow:startdiscussion', $modulecontext);
         $ownpost = ($realpost->userid == $USER->id);
-        if (!((($ownpost AND $replypost OR $startdiscussion)) OR $editanypost)) {
+        if (!(($ownpost AND ($replypost OR $startdiscussion)) OR $editanypost)) {
             throw new moodle_exception('cannotupdatepost', 'moodleoverflow');
         }
 

settings.php

@@ -97,6 +97,9 @@
     $settings->add(new admin_setting_configcheckbox('moodleoverflow/allowreview',
         get_string('allowreview', 'moodleoverflow'), get_string('allowreview_desc', 'moodleoverflow'), 1));
 
+    $settings->add(new admin_setting_configtext('moodleoverflow/reviewpossibleaftertime', get_string('reviewpossibleaftertime', 'moodleoverflow'),
+            get_string('reviewpossibleaftertime_desc', 'moodleoverflow'), 3600, PARAM_INT));
+
     // Set scales for the reputation.
     $votesettings = [];
 

templates/answer.mustache

@@ -47,7 +47,14 @@
         {{/showvotes}}
         {{#needsreview}}
             <div class="p-2 onlyifnotreviewed">
-                {{#pix}}i/pending-big, mod_moodleoverflow, {{#str}}pending_review, mod_moodleoverflow{{/str}}{{/pix}}
+                {{#pix}}i/pending-big, mod_moodleoverflow,
+                    {{#withinreviewperiod}}
+                        {{#str}}pending_review, mod_moodleoverflow{{/str}}
+                    {{/withinreviewperiod}}
+                    {{^withinreviewperiod}}
+                        {{#str}}pending_review_but_cannot_now, mod_moodleoverflow, {{reviewdelay}} {{/str}}
+                    {{/withinreviewperiod}}
+                {{/pix}}
             </div>
         {{/needsreview}}
         <div class="answercell">

templates/comment.mustache

@@ -49,7 +49,14 @@
         {{/needsreview}}
         {{#needsreview}}
             <div class="p-2">
-                {{#pix}}i/pending-big, mod_moodleoverflow, {{#str}}pending_review, mod_moodleoverflow{{/str}}{{/pix}}
+                {{#pix}}i/pending-big, mod_moodleoverflow,
+                    {{#withinreviewperiod}}
+                        {{#str}}pending_review, mod_moodleoverflow{{/str}}
+                    {{/withinreviewperiod}}
+                    {{^withinreviewperiod}}
+                        {{#str}}pending_review_but_cannot_now, mod_moodleoverflow, {{reviewdelay}} {{/str}}
+                    {{/withinreviewperiod}}
+                {{/pix}}
             </div>
         {{/needsreview}}
         <div class="commentcell">