Send review notification to reviewers

justusdieckmann · justusdieckmann · commit 2e5ff486b454 · 2022-07-26T17:27:51.000+02:00
diff --git a/classes/task/send_mails.php b/classes/task/send_mails.php
@@ -24,6 +24,9 @@
 
 namespace mod_moodleoverflow\task;
 
+use core\session\exception;
+use mod_moodleoverflow\output\moodleoverflow_email;
+
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__ . '/../../locallib.php');
 
@@ -53,10 +56,108 @@ public function execute() {
         // Send mail notifications.
         moodleoverflow_send_mails();
 
+        $this->send_review_notifications();
+
         // The cron is finished.
         return true;
 
     }
 
+    /**
+     * Sends initial notifications for needed reviews to all users with review capability.
+     */
+    public function send_review_notifications() {
+        global $DB, $OUTPUT, $PAGE;
+
+        $rendererhtml = $PAGE->get_renderer('mod_moodleoverflow', 'email', 'htmlemail');
+        $renderertext = $PAGE->get_renderer('mod_moodleoverflow', 'email', 'textemail');
+
+        $postinfos = $DB->get_records_sql(
+            'SELECT p.*, d.course as cid, d.moodleoverflow as mid, d.id as did FROM {moodleoverflow_posts} p ' .
+            'JOIN {moodleoverflow_discussions} d ON p.discussion = d.id ' .
+            "WHERE p.mailed = :mailpending AND p.reviewed = 0 AND p.created < :timecutoff " .
+            "ORDER BY d.course, d.moodleoverflow, d.id",
+            [
+                'mailpending' => MOODLEOVERFLOW_MAILED_PENDING,
+                'timecutoff' => time() - get_config('moodleoverflow', 'reviewpossibleaftertime')
+            ]
+        );
+
+        if (empty($postinfos)) {
+            mtrace('No review notifications to send.');
+            return;
+        }
+
+        $course = null;
+
+        $moodleoverflow = null;
+        $usersto = null;
+        $cm = null;
+
+        $discussion = null;
+
+        $success = [];
+
+        foreach ($postinfos as $postinfo) {
+            if ($course == null || $course->id != $postinfo->cid) {
+                $course = get_course($postinfo->cid);
+            }
+
+            if ($moodleoverflow == null || $moodleoverflow->id != $postinfo->mid) {
+                $cm = get_coursemodule_from_instance('moodleoverflow', $postinfo->mid, 0, false, MUST_EXIST);
+                $modulecontext = \context_module::instance($cm->id);
+                $usersto = get_users_by_capability($modulecontext, 'mod/moodleoverflow:reviewpost');
+                $moodleoverflow = $DB->get_record('moodleoverflow', ['id' => $postinfo->mid], '*', MUST_EXIST);
+            }
+
+            if ($discussion == null || $discussion->id != $postinfo->did) {
+                $discussion = $DB->get_record('moodleoverflow_discussions', ['id' => $postinfo->did], '*', MUST_EXIST);
+            }
+
+            $post = $postinfo;
+            $userfrom = \core_user::get_user($postinfo->userid, '*', MUST_EXIST);
+
+            foreach ($usersto as $userto) {
+                try {
+                    cron_setup_user($userto, $course);
+
+                    $maildata = new moodleoverflow_email(
+                        $course,
+                        $cm,
+                        $moodleoverflow,
+                        $discussion,
+                        $post,
+                        $userfrom,
+                        $userto,
+                        false
+                    );
+
+                    $textcontext = $maildata->export_for_template($renderertext, true);
+                    $htmlcontext = $maildata->export_for_template($rendererhtml, false);
+
+                    email_to_user(
+                        $userto,
+                        \core_user::get_noreply_user(),
+                        get_string('email_review_needed_subject', 'moodleoverflow', $textcontext),
+                        $OUTPUT->render_from_template('mod_moodleoverflow/email_review_needed_text', $textcontext),
+                        $OUTPUT->render_from_template('mod_moodleoverflow/email_review_needed_html', $htmlcontext)
+                    );
+                } catch (exception $e) {
+                    mtrace("Error sending review notification for post $post->id to user $userto->id!");
+                }
+            }
+            $success[] = $post->id;
+        }
+
+        if (!empty($success)) {
+            list($insql, $inparams) = $DB->get_in_or_equal($success);
+            $DB->set_field_select(
+                'moodleoverflow_posts', 'mailed', MOODLEOVERFLOW_MAILED_REVIEW_SUCCESS,
+                    'id ' . $insql, $inparams
+                );
+            mtrace('Sent review notifications for ' . count($success) . ' posts successfully!');
+        }
+    }
+
 }
 
diff --git a/db/install.xml b/db/install.xml
@@ -67,7 +67,7 @@
         <FIELD NAME="message" TYPE="text" NOTNULL="true" SEQUENCE="false" COMMENT="text of the post"/>
         <FIELD NAME="messageformat" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <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="mailed" TYPE="int" LENGTH="2" 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>
diff --git a/db/upgrade.php b/db/upgrade.php
@@ -222,6 +222,10 @@ function xmldb_moodleoverflow_upgrade($oldversion) {
             $dbman->add_field($table, $field);
         }
 
+        $field = new xmldb_field('mailed', XMLDB_TYPE_INTEGER, '2', null, null, null, '0', 'attachment');
+        // Launch change of precision for field mailed.
+        $dbman->change_field_precision($table, $field);
+
         // Moodleoverflow savepoint reached.
         upgrade_mod_savepoint(true, 2022072000, 'moodleoverflow');
     }
diff --git a/lang/en/moodleoverflow.php b/lang/en/moodleoverflow.php
@@ -432,13 +432,16 @@
 $string['post_was_approved'] = 'The post was approved.';
 $string['post_was_rejected'] = 'The post was rejected.';
 $string['jump_to_next_post_needing_review'] = 'Jump to next post needing to be reviewed.';
-$string['there_are_no_posts_needing_review'] = 'There are no more posts needing to be reviewed.';
+$string['there_are_no_posts_needing_review'] = 'There are no more posts in this forum that need to be reviewed.';
 $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}';
+$string['review_needed'] = 'Review needed!';
+
+$string['email_review_needed_subject'] = 'Review needed in {$a->coursename}: {$a->subject}';
+
+$string['email_rejected_subject'] = '{$a->coursename}: One of your posts has been rejected.';
diff --git a/lib.php b/lib.php
@@ -48,6 +48,7 @@
 define('MOODLEOVERFLOW_MAILED_PENDING', 0);
 define('MOODLEOVERFLOW_MAILED_SUCCESS', 1);
 define('MOODLEOVERFLOW_MAILED_ERROR', 2);
+define('MOODLEOVERFLOW_MAILED_REVIEW_SUCCESS', 3);
 
 // Constants for the post rating.
 define('MOODLEOVERFLOW_PREFERENCE_STARTER', 0);
@@ -1005,16 +1006,18 @@ function moodleoverflow_get_unmailed_posts($starttime, $endtime) {
 
     // Set params for the sql query.
     $params               = array();
-    $params['mailed']     = MOODLEOVERFLOW_MAILED_PENDING;
     $params['ptimestart'] = $starttime;
     $params['ptimeend']   = $endtime;
 
+    $pendingmail = MOODLEOVERFLOW_MAILED_PENDING;
+    $reviewsent = MOODLEOVERFLOW_MAILED_REVIEW_SUCCESS;
+
     // Retrieve the records.
     $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.reviewed = 1
-            AND COALESCE(p.timereview, p.created) >= :ptimestart AND COALESCE(p.timereview, p.created) < :ptimeend
+            WHERE p.mailed IN ($pendingmail, $reviewsent) AND p.reviewed = 1
+            AND COALESCE(p.timereviewed, p.created) >= :ptimestart AND p.created < :ptimeend
             ORDER BY p.modified ASC";
 
     return $DB->get_records_sql($sql, $params);
@@ -1036,14 +1039,15 @@ function moodleoverflow_mark_old_posts_as_mailed($endtime) {
     // Define variables for the sql query.
     $params                  = array();
     $params['mailedsuccess'] = MOODLEOVERFLOW_MAILED_SUCCESS;
+    $params['mailedreviewsent'] = MOODLEOVERFLOW_MAILED_REVIEW_SUCCESS;
     $params['now']           = $now;
     $params['endtime']       = $endtime;
     $params['mailedpending'] = MOODLEOVERFLOW_MAILED_PENDING;
 
     // Define the sql query.
     $sql = "UPDATE {moodleoverflow_posts}
             SET mailed = :mailedsuccess
-            WHERE (created < :endtime) AND mailed = :mailedpending AND reviewed = 1";
+            WHERE (created < :endtime) AND mailed IN (:mailedpending, :mailedreviewsent) AND reviewed = 1";
 
     return $DB->execute($sql, $params);
 
diff --git a/templates/email_review_needed_html.mustache b/templates/email_review_needed_html.mustache
@@ -0,0 +1,129 @@
+{{!
+    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/>.
+}}
+{{!
+    @template mod_moodleoverflow/email_html
+
+    Template which defines a moodleoverflow post for sending in a single-post HTML email.
+
+    Classes required for JS:
+    * none
+
+    Data attributes required for JS:
+    * none
+
+    Context variables required for this template:
+    * courselink
+    * coursename
+    * moodleoverflowindexlink
+    * moodleoverflowviewlink
+    * moodleoverflowname
+    * discussionlink
+    * discussionname
+    * showdiscussionname
+    * firstpost
+    * subject
+    * authorlink
+    * authorpicture
+    * authorfullname
+    * postdate
+    * grouppicture
+    * attachments
+    * message
+    * parentpostlink
+    * canreply
+    * replylink
+    * permalink
+    * unsubscribemoodleoverflowlink
+    * unsubscribediscussionlink
+
+    Example context (json):
+    {
+        "courselink": "https://example.com/course/view.php?id=2",
+        "coursename": "Example course",
+        "moodleoverflowindexlink": "https://example.com/mod/moodleoverflow/index.php?id=2",
+        "moodleoverflowviewlink": "https://example.com/mod/moodleoverflow/view.php?f=2",
+        "moodleoverflowname": "Lorem ipsum dolor",
+        "discussionlink": "https://example.com/mod/moodleoverflow/discuss.php?d=70",
+        "discussionname": "Is Lorem ipsum Latin?",
+        "showdiscussionname": 1,
+        "firstpost": 1,
+        "subject": "Is Lorem ipsum Latin?",
+        "authorlink": "https://example.com/user/view.php?id=2&course=2",
+        "authorpicture": "<a href=\"https://example.com/user/view.php?id=2&amp;course=6\"><img src=\"https://example.com/theme/image.php?theme=clean&amp;component=core&amp;image=u%2Ff2&amp;svg=0\" alt=\"Picture of Admin User\" title=\"Picture of Admin User\" class=\"userpicture defaultuserpic\" width=\"35\" height=\"35\" /></a>",
+        "authorfullname": "Lucius Caecilius lucundus",
+        "postdate": "Sunday, 13 September 2015, 2:22 pm",
+        "grouppicture": "",
+        "attachments": "",
+        "message": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum et auctor libero. Quisque porta egestas neque, et bibendum libero dignissim at. Nulla facilisi. Morbi eget accumsan felis. Nunc et vulputate odio, vel venenatis nisl. Nunc maximus ipsum sed tincidunt mollis. Integer nunc erat, luctus sit amet arcu tincidunt, volutpat dignissim mi. Sed ut magna quam.  Mauris accumsan porta turpis sed aliquam. Etiam at justo tristique, imperdiet augue quis, consectetur sapien. Ut nec erat malesuada sem suscipit lobortis. Vivamus posuere nibh eu ipsum porta fringilla.  Sed vitae dapibus ipsum, ac condimentum enim. Sed dignissim ante at elit mollis, ac tempor lacus iaculis. Etiam nec lectus vitae nibh vulputate volutpat. Nulla quis tellus aliquam, commodo nisi et, dictum est.</p><p><br /></p>",
+        "parentpostlink": "",
+        "canreply": 1,
+        "replylink": "https://example.com/mod/moodleoverflow/post.php?reply=2",
+        "permalink": "https://example.com/mod/moodleoverflow/discuss.php?d=2#2",
+        "unsubscribemoodleoverflowlink": "https://example.com/mod/moodleoverflow/subscribe.php?id=2",
+        "unsubscribediscussionlink": "https://example.com/mod/discussion/subscribe.php?id=2&d=2"
+    }
+}}
+<div class="navbar">
+    <a target="_blank" href="{{{ courselink }}}">{{{ coursename }}}</a>
+    &raquo;
+    <a target="_blank" href="{{{ moodleoverflowviewlink }}}">{{{ moodleoverflowname }}}</a>
+    {{# showdiscussionname }}
+        &raquo;
+        <a target="_blank" href="{{{ discussionlink }}}">{{{ discussionname }}}</a>
+    {{/ showdiscussionname }}
+</div>
+
+<a href="{{{permalink}}}"><h3>{{#str}}review_needed, mod_moodleoverflow{{/str}}</h3></a>
+
+<table border="0" cellpadding="3" cellspacing="0" class="moodleoverflowpost">
+    <tr class="header">
+        <td width="35" valign="top" class="picture left">
+            {{{ authorpicture }}}
+        </td>
+        <td class="topic {{# firstpost }}starter{{/ firstpost }}">
+            <div class="subject">
+                {{{ subject }}}
+            </div>
+            <div class="author">
+                {{# str }} bynameondatenorating, moodleoverflow, {
+                    "name":
+                    {{# authorlink }}{{# quote }} <a target='_blank' href='{{{ authorlink }}}'>{{ authorfullname }}</a>{{/ quote }}{{/authorlink}}
+                    {{^ authorlink }}{{# quote }} {{ authorfullname }} {{/ quote }}{{/ authorlink }} ,
+                    "date": {{# quote }}{{ postdate }}{{/ quote }}
+                    } {{/ str }}
+            </div>
+        </td>
+    </tr>
+    <tr>
+        <td class="left side" valign="top">
+            {{# grouppicture }}
+                {{{ grouppicture }}}
+            {{/ grouppicture }}
+            {{^ grouppicture }}
+                &nbsp;
+            {{/ grouppicture }}
+        </td>
+        <td class="content">
+            {{{ message }}}
+            <div class="link">
+                <a target="_blank" href="{{{ permalink }}}">
+                    {{# str }} review, mod_moodleoverflow {{/ str }}
+                </a>
+            </div>
+        </td>
+    </tr>
+</table>
diff --git a/templates/email_review_needed_text.mustache b/templates/email_review_needed_text.mustache
@@ -15,7 +15,7 @@
     along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 }}
 {{!
-    @template mod_moodleoverflow/email_html
+    @template mod_moodleoverflow/email_reject_text
 
     Template which defines a moodleoverflow post for sending in a single-post HTML email.
 
@@ -77,12 +77,15 @@
         "unsubscribediscussionlink": "https://example.com/mod/discussion/subscribe.php?id=2&d=2"
     }
 }}
-<div class="navbar">
-    <a target="_blank" href="{{{ courselink }}}">{{{ coursename }}}</a>
-    &raquo;
-    <a target="_blank" href="{{{ moodleoverflowviewlink }}}">{{{ moodleoverflowname }}}</a>
-    {{# showdiscussionname }}
-        &raquo;
-        <a target="_blank" href="{{{ discussionlink }}}">{{{ discussionname }}}</a>
-    {{/ showdiscussionname }}
-</div>
+{{{ coursename }}} -> {{{ moodleoverflowname }}}{{# showdiscussionname }} -> {{{ discussionname }}} {{/ showdiscussionname }}
+
+{{# str }}review_needed, mod_moodleoverflow {{/str}}: {{ permalink }}
+
+{{{ subject }}}
+{{# str }} bynameondate, mod_moodleoverflow, {
+"name": {{# quote }}{{{ authorfullname }}}{{/ quote }},
+"date": {{# quote}}{{ postdate }}{{/ quote }}
+} {{/ str }}
+---------------------------------------------------------------------
+{{{ message }}}
+---------------------------------------------------------------------

Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,10 @@ function xmldb_moodleoverflow_upgrade($oldversion) {`
`222`	`222`	`$dbman->add_field($table, $field);`
`223`	`223`	`}`
`224`	`224`
	`225`	`+ $field = new xmldb_field('mailed', XMLDB_TYPE_INTEGER, '2', null, null, null, '0', 'attachment');`
	`226`	`+ // Launch change of precision for field mailed.`
	`227`	`+ $dbman->change_field_precision($table, $field);`
	`228`	`+`
`225`	`229`	`// Moodleoverflow savepoint reached.`
`226`	`230`	`upgrade_mod_savepoint(true, 2022072000, 'moodleoverflow');`
`227`	`231`	`}`