Issue #2: Added origin script flag to email logs

classes/helper.php

@@ -50,12 +50,22 @@ static function purge($maxdays) {
 	}
 
 	static function log_mail($success, $msg, $user, $from, $subject, $messagetext, $messagehtml, $attachment, $attachname, $usetrueaddress, $replyto, $replytoname, $wordwrapwidth, $queuestatus=0) {
-		global $DB;
+		global $CFG, $DB;
 
 		if (!\get_config('local_maillog', 'logmails')) {
 			return true;
 		}
 
+		// Find originating script. It will be the layer with the first email_to_user call.
+		$stack = debug_backtrace();
+		foreach ($stack as $call) {
+			if ($call['function'] === 'email_to_user') {
+				$layer = $call;
+				break;
+			}
+		}
+		$originscript = '/' . str_replace($CFG->dirroot . '/', '', $layer['file']) . ':' . $layer['line'];
+
 		$transaction = $DB->start_delegated_transaction();
 
 		$todb = new \stdClass();
@@ -77,6 +87,7 @@ static function log_mail($success, $msg, $user, $from, $subject, $messagetext, $
 		$todb->success = $success ? 1 : 0;
 		$todb->returnmsg = substr($msg, 0, 255);
 		$todb->queuestatus = $queuestatus;
+		$todb->originscript = $originscript;
 
 		$newrecordid = $DB->insert_record('mail_log', $todb);
 

classes/output/log_table.php

@@ -30,20 +30,24 @@ public function __construct($uniqueid, \moodle_url $url, $perpage = 100) {
         parent::__construct($uniqueid);
 
         $this->set_attribute('class', 'generaltable generalbox');
-        $this->define_columns(array(
+        $cols = [
             'to',
             'subject',
             'content',
             'hasattachment',
             'timesent',
+            'originscript',
             'status',
-        ));
+        ];
+
+        $this->define_columns($cols);
         $this->define_headers(array(
                 get_string('to'),
                 get_string('subject', 'hub'),
                 get_string('content'),
                 get_string('hasattachment', 'local_maillog'),
                 get_string('timesent', 'local_maillog'),
+                get_string('originscript', 'local_maillog'),
                 get_string('status'),
             )
         );
@@ -88,4 +92,8 @@ public function col_timesent($row) {
     public function col_status($row) {
         return $row->success ? get_string('sent', 'local_maillog') : get_string('failed', 'local_maillog');
     }
-}
+
+    public function col_originscript($row) {
+        return $row->originscript ?? 'Unknown';
+    }
+}

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="local/maillog/db" VERSION="2016042200" COMMENT="XMLDB file for Moodle local/maillog"
+<XMLDB PATH="local/maillog/db" VERSION="20201106" COMMENT="XMLDB file for Moodle local/maillog"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
 >
@@ -24,6 +24,7 @@
         <FIELD NAME="success" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="returnmsg" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false"/>
         <FIELD NAME="queuestatus" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="originscript" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>
@@ -38,4 +39,4 @@
       </INDEXES>
     </TABLE>
   </TABLES>
-</XMLDB>
+</XMLDB>

db/upgrade.php

@@ -0,0 +1,48 @@
+<?php
+// 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/>.
+
+/**
+ * Maillog upgrade library.
+ *
+ * @package    local_maillog
+ * @copyright  2020 Peter Burnett <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+function xmldb_local_maillog_upgrade($oldversion) {
+    global $DB;
+
+    $dbman = $DB->get_manager();
+
+    if ($oldversion < 20201106000) {
+
+    // Define field originscript to be added to mail_log.
+    $table = new xmldb_table('mail_log');
+    $field = new xmldb_field('originscript', XMLDB_TYPE_CHAR, '255', null, null, null, null, 'queuestatus');
+
+    // Conditionally launch add field originscript.
+    if (!$dbman->field_exists($table, $field)) {
+        $dbman->add_field($table, $field);
+    }
+
+    // Maillog savepoint reached.
+    upgrade_plugin_savepoint(true, 20201106000, 'local', 'maillog');
+    }
+
+    return true;
+}

lang/en/local_maillog.php

@@ -40,6 +40,7 @@
 $string['mailqueue'] = 'Mail Queue';
 $string['maxdays'] = 'Max days to keep emails in log/queue';
 $string['maxdaysinfo'] = 'Any mail log entries older than the configured amount of days will be purged.';
+$string['originscript'] = 'Originating script';
 $string['pendingsend'] = 'Pending send';
 $string['queued'] = 'Queued';
 $string['queuemails'] = 'Queue emails';

log_report.php

@@ -43,7 +43,7 @@
 }
 
 // Setup the SQL query and display
-$fields = 'userid, subject, messagetext, messagehtml, attachname, timesent, success';
+$fields = 'id, userid, subject, messagetext, messagehtml, attachname, timesent, originscript, success';
 $from = '{mail_log}';
 $where = 'queuestatus = 0';
 $table->set_sql($fields, $from, $where);

version.php

@@ -25,7 +25,8 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 20170111100;
+// Extra 0 due to broken previous version number.
+$plugin->version   = 20201106000;
 $plugin->requires  = 2015051100;
 $plugin->cron      = 0;
 $plugin->component = 'local_maillog';