Emailfrom

.travis.yml

@@ -7,7 +7,7 @@ services:
 
 addons:
  firefox: "47.0.1"
- postgresql: "9.4"
+ postgresql: "9.5"
  apt:
   packages:
    - openjdk-8-jre-headless

db/install.xml

@@ -27,6 +27,8 @@
         <FIELD NAME="remindercount" TYPE="int" LENGTH="3" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="how many times to send the email"/>
         <FIELD NAME="suppresstarget" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="ID of module that, if completed, should prevent an email being sent out."/>
         <FIELD NAME="emaildelay" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="604800" SEQUENCE="false" COMMENT="Time setting related to email"/>
+        <FIELD NAME="emailfrom" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="ID of user to use as sender, 0 for support user, -1 for default teacher."/>
+        <FIELD NAME="instantmessage" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Notification type, 0 for email, 1 for instant message"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -178,5 +178,20 @@ function xmldb_reengagement_upgrade($oldversion=0) {
         upgrade_mod_savepoint(true, 2017102001, 'reengagement');
     }
 
+    // Add emailfrom and instantmessage fields.
+    if ($oldversion < 2022092900) {
+
+        $table = new xmldb_table('reengagement');
+        $field = new xmldb_field('emailfrom', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+        $field = new xmldb_field('instantmessage', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, '0');
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+        upgrade_mod_savepoint(true, 2020022202, 'reengagement');
+    }
+
     return true;
-}
+}

lang/en/reengagement.php

@@ -60,6 +60,10 @@
 $string['emailcontentmanagerdefaultvalue'] = 'This is a reminder notification from course %courseshortname%, regarding user %userfirstname% %userlastname%.';
 $string['emaildelay'] = 'Notification delay';
 $string['emaildelay_help'] = 'When module is set to notify users "after delay", this setting controls how long the delay is.';
+$string['emailfrom'] = 'Send notification from';
+$string['emailfrom_help'] = 'The user to send the message from, pending permissions check. Default teacher is the first teacher in the course, will send from support user if no teachers are found.';
+$string['emailfromsupport'] = 'Support user';
+$string['emailfromteacher'] = 'Default teacher';
 $string['emailrecipient'] = 'Notify recipient(s)';
 $string['emailrecipient_help'] = 'When a notification needs to be sent out to prompt a user\'s re-engagement with the course, this setting controls if a notification is sent to the user, their manager(s), or both.';
 $string['emailsubject'] = 'Notification subject (User)';
@@ -88,6 +92,10 @@
 $string['nochangenoaccess'] = 'No change (user has not accessed course)';
 $string['noemailattimex'] = 'Message scheduled for {$a} will not be sent because you have completed the target activity';
 $string['nosuppresstarget'] = 'No target activity selected';
+$string['notificationemail'] = 'Email';
+$string['notificationim'] = 'Instant message';
+$string['notificationtype'] = 'Notification type';
+$string['notificationtype_help'] = 'Send notifications as an email or as a Moodle instant message. Third party notifications always send as emails.';
 $string['oncompletion'] = 'On reengagement completion';
 $string['receiveemailattimex'] = 'Message will be sent on {$a}.';
 $string['receiveemailattimexunless'] = 'Message will be sent on {$a} unless you complete target activity.';

lib.php

@@ -35,6 +35,12 @@
 define('REENGAGEMENT_RECIPIENT_MANAGER', 1);
 define('REENGAGEMENT_RECIPIENT_BOTH', 2);
 
+define('REENGAGEMENT_EMAILFROM_SUPPORT', 0);
+define('REENGAGEMENT_EMAILFROM_TEACHER', -1);
+
+define('REENGAGEMENT_NOTIFICATION_EMAIL', 0);
+define('REENGAGEMENT_NOTIFICATION_IM', 1);
+
 /**
  * Given an object containing all the necessary data,
  * (defined by the form in mod_form.php) this function
@@ -249,7 +255,8 @@ function reengagement_crontask() {
                                 r.thirdpartyemails, r.emailcontentmanager, r.emailcontentmanagerformat, r.emailsubjectmanager,
                                 r.emailcontentthirdparty, r.emailcontentthirdpartyformat, r.emailsubjectthirdparty,
                                 r.emailuser, r.name, r.suppresstarget, r.remindercount, c.shortname as courseshortname,
-                                c.fullname as coursefullname, c.id as courseid, r.emailrecipient, r.emaildelay
+                                c.fullname as coursefullname, c.id as courseid, r.emailrecipient, r.emaildelay,
+                                r.emailfrom, r.instantmessage
                           FROM {reengagement} r
                     INNER JOIN {course_modules} cm ON cm.instance = r.id
                     INNER JOIN {course} c ON cm.course = c.id
@@ -546,22 +553,29 @@ function reengagement_email_user($reengagement, $inprogress) {
  * @param object $reengagement database record
  */
 function reengagement_send_notification($userto, $subject, $messageplain, $messagehtml, $reengagement) {
-    $eventdata = new \core\message\message();
-    $eventdata->courseid = $reengagement->courseid;
-    $eventdata->modulename = 'reengagement';
-    $eventdata->userfrom = core_user::get_support_user();
-    $eventdata->userto = $userto;
-    $eventdata->subject = $subject;
-    $eventdata->fullmessage = $messageplain;
-    $eventdata->fullmessageformat = FORMAT_HTML;
-    $eventdata->fullmessagehtml = $messagehtml;
-    $eventdata->smallmessage = $subject;
-
-    // Required for messaging framework
-    $eventdata->name = 'mod_reengagement';
-    $eventdata->component = 'mod_reengagement';
-
-    return message_send($eventdata);
+    $emailfrom = reengagement_get_emailfrom($reengagement);
+    // Check instant message setting and verify we're sending to a real user, not third party.
+    if ($reengagement->instantmessage == REENGAGEMENT_NOTIFICATION_IM && $userto->id > 0) {
+        return message_post_message($emailfrom, $userto, $messagehtml, FORMAT_HTML);
+    } else {
+        $eventdata = new \core\message\message();
+        $eventdata->courseid = $reengagement->courseid;
+        $eventdata->modulename = 'reengagement';
+        $eventdata->userfrom = $emailfrom;
+        $eventdata->userto = $userto;
+        $eventdata->subject = $subject;
+        $eventdata->fullmessage = $messageplain;
+        $eventdata->fullmessageformat = FORMAT_HTML;
+        $eventdata->fullmessagehtml = $messagehtml;
+        $eventdata->smallmessage = $subject;
+        $eventdata->replyto = $emailfrom->email;
+
+        // Required for messaging framework
+        $eventdata->name = 'mod_reengagement';
+        $eventdata->component = 'mod_reengagement';
+
+        return message_send($eventdata);
+    }
 }
 
 
@@ -578,6 +592,8 @@ function reengagement_template_variables($reengagement, $inprogress, $user) {
 
     require_once($CFG->dirroot.'/user/profile/lib.php');
 
+    $emailfrom = reengagement_get_emailfrom($reengagement);
+
     $templatevars = array(
         '/%courseshortname%/' => $reengagement->courseshortname,
         '/%coursefullname%/' => $reengagement->coursefullname,
@@ -588,6 +604,10 @@ function reengagement_template_variables($reengagement, $inprogress, $user) {
         '/%usercity%/' => $user->city,
         '/%userinstitution%/' => $user->institution,
         '/%userdepartment%/' => $user->department,
+        '/%fromfirstname%/' => $emailfrom->firstname,
+        '/%fromlastname%/' => $emailfrom->lastname,
+        '/%fromid%/' => $emailfrom->id,
+        '/%fromemail%/' => $emailfrom->email,
     );
     // Add the users course groups as a template item.
     $groups = $DB->get_records_sql_menu("SELECT g.id, g.name
@@ -980,3 +1000,33 @@ function reengagement_checkstart($course, $cm, $reengagement) {
     }
     return $output;
 }
+
+/**
+ * Check that emailfrom user has capability to add reengagments,
+ *  otherwise return support user
+ *
+ * @param object $reengagement
+ * @return object $user
+ */
+function reengagement_get_emailfrom($reengagement) {
+    $userid = $reengagement->emailfrom;
+    if ($userid != 0) {
+        $context = context_course::instance($reengagement->courseid);
+        if ($userid == REENGAGEMENT_EMAILFROM_TEACHER) { // Default teacher, get first teacher in course.
+            $users = get_enrolled_users($context, 'mod/reengagement:addinstance', 0, 'u.*', '', 0, 1);
+            if ($users && $user = reset($users)) {
+                return $user;
+            }
+        } else {
+            $user = $userid ? core_user::get_user($userid) : null;
+
+            // Check selected teacher still has capability.
+            if ($user && has_capability('mod/reengagement:addinstance', $context, $user) ) {
+                return $user;
+            }
+        }
+    }
+
+    // If no default teacher, or selected teacher now lacks capability, return support user.
+    return core_user::get_support_user();
+}

mod_form.php

@@ -44,7 +44,7 @@ class mod_reengagement_mod_form extends moodleform_mod {
      */
     public function definition() {
 
-        global $COURSE, $CFG;
+        global $COURSE, $CFG, $DB;
         $mform =& $this->_form;
         // Make sure completion and restriction is enabled.
         if (empty($CFG->enablecompletion) || empty($CFG->enableavailability)) {
@@ -127,10 +127,32 @@ public function definition() {
         $mform->addHelpButton('remindercount', 'remindercount', 'reengagement');
         $mform->hideif('remindercount', 'emailuser', 'neq', REENGAGEMENT_EMAILUSER_TIME);
 
+        // Add emailfrom selector.
+        $emailfromoptions = array();
+        $emailfromoptions[REENGAGEMENT_EMAILFROM_SUPPORT] = get_string('emailfromsupport', 'reengagement');
+        $emailfromoptions[REENGAGEMENT_EMAILFROM_TEACHER] = get_string('emailfromteacher', 'reengagement');
+        $coursecontext = context_course::instance($COURSE->id);
+        $emailfromusers = get_enrolled_users($coursecontext, 'mod/reengagement:addinstance');
+        foreach ($emailfromusers as $emailfromuser) {
+            $emailfromoptions[$emailfromuser->id] = get_string('fullnamedisplay', '', $emailfromuser);
+        }
+        $mform->addElement('select', 'emailfrom', get_string('emailfrom', 'reengagement'), $emailfromoptions);
+        $mform->hideif('emailfrom', 'emailuser', 'eq', REENGAGEMENT_EMAILUSER_NEVER);
+        $mform->addHelpButton('emailfrom', 'emailfrom', 'reengagement');
+
+        // Add notification type selector.
+        $instantmessageoptions = array();
+        $instantmessageoptions[REENGAGEMENT_NOTIFICATION_EMAIL] = get_string('notificationemail', 'reengagement');
+        $instantmessageoptions[REENGAGEMENT_NOTIFICATION_IM] = get_string('notificationim', 'reengagement');
+        $mform->addElement('select', 'instantmessage', get_string('notificationtype', 'reengagement'), $instantmessageoptions);
+        $mform->hideif('instantmessage', 'emailuser', 'eq', REENGAGEMENT_EMAILUSER_NEVER);
+        $mform->addHelpButton('instantmessage', 'notificationtype', 'reengagement');
+
         $mform->addElement('text', 'emailsubject', get_string('emailsubject', 'reengagement'), array('size' => '64'));
         $mform->setType('emailsubject', PARAM_TEXT);
         $mform->addRule('emailsubject', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
         $mform->hideif('emailsubject', 'emailuser', 'eq', REENGAGEMENT_EMAILUSER_NEVER);
+        $mform->hideif('emailsubject', 'instantmessage', 'eq', REENGAGEMENT_NOTIFICATION_IM);
         $mform->addHelpButton('emailsubject', 'emailsubject', 'reengagement');
         $mform->addElement('editor', 'emailcontent', get_string('emailcontent', 'reengagement'), null, null);
         $mform->setDefault('emailcontent', get_string('emailcontentdefaultvalue', 'reengagement'));
@@ -143,6 +165,7 @@ public function definition() {
             $mform->setType('emailsubjectmanager', PARAM_TEXT);
             $mform->addRule('emailsubjectmanager', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
             $mform->hideif('emailsubjectmanager', 'emailuser', 'eq', REENGAGEMENT_EMAILUSER_NEVER);
+            $mform->hideif('emailsubjectmanager', 'instantmessage', 'eq', REENGAGEMENT_NOTIFICATION_IM);
             $mform->addHelpButton('emailsubjectmanager', 'emailsubjectmanager', 'reengagement');
             $mform->addElement('editor', 'emailcontentmanager', get_string('emailcontentmanager', 'reengagement'), null, null);
             $mform->setDefault('emailcontentmanager', get_string('emailcontentmanagerdefaultvalue', 'reengagement'));

version.php

@@ -25,7 +25,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2019091000;   // The current module version.
+$plugin->version   = 2022092900;   // The current module version.
 $plugin->requires  = 2018111800; // Requires 3.6
 $plugin->component = 'mod_reengagement';
 $plugin->release   = '3.6.3';