Implement admin notification on process errors

And other small fixes

Author: justusdieckmann

classes/local/table/process_errors_table.php

@@ -95,9 +95,9 @@ public function __construct() {
     public function col_error($row) {
         return "<details><summary>" .
                 nl2br(htmlentities($row->errormessage)) .
-                "</summary>" .
+                "</summary><code>" .
                 nl2br(htmlentities($row->errortrace)) .
-                "</details>";
+                "</code></details>";
     }
 
     /**
@@ -165,6 +165,27 @@ protected function show_hide_link($column, $index) {
         return '';
     }
 
+    /**
+     * Show custom nothing to display message.
+     * @return void
+     */
+    public function print_nothing_to_display() {
+        global $OUTPUT;
+
+        // Render the dynamic table header.
+        echo $this->get_dynamic_table_html_start();
+
+        // Render button to allow user to reset table preferences.
+        echo $this->render_reset_button();
+
+        $this->print_initials_bar();
+
+        echo $OUTPUT->heading(get_string('noprocesserrors', 'tool_lifecycle'));
+
+        // Render the dynamic table footer.
+        echo $this->get_dynamic_table_html_end();
+    }
+
     /**
      * Hook that can be overridden in child classes to wrap a table in a form
      * for example. Called only when there is data to display and not

classes/task/lifecycle_error_notify_task.php

@@ -0,0 +1,69 @@
+<?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/>.
+
+/**
+ * Scheduled task for notify admin upon process errors
+ *
+ * @package tool_lifecycle
+ * @copyright  2022 Justus Dieckmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace tool_lifecycle\task;
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * Scheduled task for notify admin upon process errors
+ *
+ * @package tool_lifecycle
+ * @copyright  2022 Justus Dieckmann WWU
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class lifecycle_error_notify_task extends \core\task\scheduled_task {
+
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     * @throws \coding_exception
+     */
+    public function get_name() {
+        return get_string('lifecycle_error_notify_task', 'tool_lifecycle');
+    }
+
+    /**
+     * Do the job.
+     */
+    public function execute() {
+        global $DB, $CFG;
+
+        $errorcount = $DB->count_records('tool_lifecycle_proc_error');
+
+        if (!$errorcount) {
+            return;
+        }
+
+        $obj = new \stdClass();
+        $obj->amount = $errorcount;
+        $obj->url = $CFG->wwwroot . '/admin/tool/lifecycle/errors.php';
+
+        email_to_user(get_admin(), \core_user::get_noreply_user(),
+            get_string('notifyerrorsemailsubject', 'tool_lifecycle', $obj),
+            get_string('notifyerrorsemailcontent', 'tool_lifecycle', $obj),
+            get_string('notifyerrorsemailcontenthtml', 'tool_lifecycle', $obj),
+        );
+    }
+}

db/tasks.php

@@ -44,5 +44,14 @@
         'day' => '*',
         'month' => '*',
         'dayofweek' => '0',
-    )
+    ),
+    array(
+        'classname' => 'tool_lifecycle\task\lifecycle_error_notify_task',
+        'blocking' => 0,
+        'minute' => 'R',
+        'hour' => '5',
+        'day' => '*',
+        'month' => '*',
+        'dayofweek' => '0',
+    ),
 );

errors.php

@@ -50,6 +50,8 @@
         foreach ($ids as $id) {
             process_manager::rollback_process_after_error($id);
         }
+    } else {
+        throw new coding_exception("action must be either 'proceed' or 'rollback'");
     }
     redirect($PAGE->url);
 }

lang/de/tool_lifecycle.php

@@ -177,5 +177,12 @@
 $string['process_rollback_event'] = 'Ein Prozess wurde zurückgesetzt';
 
 $string['courseid'] = 'Kurs-ID';
-$string['process_errors_header'] = 'Prozessfehler';
+$string['process_errors_header'] = 'Fehlermanagement';
+$string['proceed'] = 'Fortfahren';
 $string['forselected'] = 'Für alle ausgewählten Prozesse';
+$string['noprocesserrors'] = 'Es gibt keine fehlerhaften Prozesse, die behandelt werden müssen!';
+
+$string['lifecycle_error_notify_task'] = 'Benachrichtigt die Administratoren bei Fehlern in tool_lifecycle-Prozessen.';
+$string['notifyerrorsemailsubject'] = '{$a->amount} fehlerhafte tool_lifecycle Prozesse warten darauf, behandelt zu werden!';
+$string['notifyerrorsemailcontent'] = '{$a->amount} fehlerhafte tool_lifecycle Prozesse warten darauf, behandelt zu werden!' . "\n" . 'Bitte besuchen Sie {$a->url}.';
+$string['notifyerrorsemailcontenthtml'] = '{$a->amount} fehlerhafte tool_lifecycle Prozesse warten darauf, behandelt zu werden!<br>Bitte besuchen Sie <a href="{$a->url}">die Übersichtsseite</a>.';

lang/en/tool_lifecycle.php

@@ -212,7 +212,13 @@
 $string['delete_all_delays'] = 'Delete all delays';
 
 $string['courseid'] = 'Course ID';
-$string['process_errors_header'] = 'Process errors';
+$string['process_errors_header'] = 'Error handling';
 $string['proceed'] = 'Proceed';
 $string['rollback'] = 'Rollback';
 $string['forselected'] = 'For all selected processes';
+$string['noprocesserrors'] = 'There are no process errors to handle!';
+
+$string['lifecycle_error_notify_task'] = 'Notify the admin upon errors in tool_lifecycle processes';
+$string['notifyerrorsemailsubject'] = 'There are {$a->amount} tool_lifecycle process errors waiting to be fixed!';
+$string['notifyerrorsemailcontent'] = 'There are {$a->amount} tool_lifecycle process errors waiting to be fixed!' . "\n" . 'Please review them at {$a->url}.';
+$string['notifyerrorsemailcontenthtml'] = 'There are {$a->amount} tool_lifecycle process errors waiting to be fixed!<br>Please review them at the <a href="{$a->url}">error handling overview</a>.';