Merge pull request #8 from ngandrass/feature/moodle51

Moodle 5.1 Support

Author: ngandrass

.github/workflows/moodle-plugin-ci.yml

@@ -12,7 +12,7 @@ jobs:
 
     services:
       postgres:
-        image: postgres:14
+        image: postgres:15
         env:
           POSTGRES_USER: 'postgres'
           POSTGRES_HOST_AUTH_METHOD: 'trust'
@@ -72,6 +72,14 @@ jobs:
           - {moodle-branch: 'MOODLE_500_STABLE', php: '8.3', database: 'mariadb'}
           - {moodle-branch: 'MOODLE_500_STABLE', php: '8.4', database: 'pgsql'}
           - {moodle-branch: 'MOODLE_500_STABLE', php: '8.4', database: 'mariadb'}
+
+          # Moodle 5.1, PHP 8.2 to 8.4, PostgreSQL and MariaDB
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.2', database: 'pgsql'}
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.2', database: 'mariadb'}
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.3', database: 'pgsql'}
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.3', database: 'mariadb'}
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.4', database: 'pgsql'}
+          - {moodle-branch: 'MOODLE_501_STABLE', php: '8.4', database: 'mariadb'}
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4

.gitlab-ci.yml

@@ -23,7 +23,7 @@ stages:
   stage: pluginci
   image: moodlehq/moodle-php-apache:${PHP_VERSION}
   services:
-    - name: postgres:14
+    - name: postgres:15
       alias: postgres
       variables:
         POSTGRES_USER: "postgres"
@@ -114,3 +114,10 @@ moodle-plugin-ci-M500:
     MOODLE_BRANCH: "MOODLE_500_STABLE"
     PHP_VERSION: "8.2"
     DB: "pgsql"
+
+moodle-plugin-ci-M501:
+  <<: *stage-pluginci-common
+  variables:
+    MOODLE_BRANCH: "MOODLE_500_STABLE"
+    PHP_VERSION: "8.2"
+    DB: "pgsql"

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version X.Y.Z (YYYYMMDDXX)
+
+- Fix background color of Bootstrap badges on dry-run page with Moodle 5.1
+- Add Moodle 5.1 and all supported PHP versions to CI test matrix
+- Comply with Moodle coding style version 3.6
+
+
 ## Version 1.3.0 (2025100600)
 
 - Allow to ignore users based on their authentication method (e.g., ignore all users authenticated via LDAP)

README.md

@@ -2,7 +2,7 @@
 
 [![Latest Version](https://img.shields.io/github/v/release/ngandrass/moodle-tool_userautodelete)](https://github.com/ngandrass/moodle-tool_userautodelete/releases)
 [![PHP Support](https://img.shields.io/badge/PHP-7.4%20--%208.4-blue)](https://github.com/ngandrass/moodle-tool_userautodelete)
-[![Moodle Support](https://img.shields.io/badge/Moodle-4.1%20--%205.0-orange)](https://github.com/ngandrass/moodle-tool_userautodelete)
+[![Moodle Support](https://img.shields.io/badge/Moodle-4.1%20--%205.1-orange)](https://github.com/ngandrass/moodle-tool_userautodelete)
 [![GitHub Workflow Status: Moodle Plugin CI](https://img.shields.io/github/actions/workflow/status/ngandrass/moodle-tool_userautodelete/moodle-plugin-ci.yml?label=Moodle%20Plugin%20CI)](https://github.com/ngandrass/moodle-tool_userautodelete/actions/workflows/moodle-plugin-ci.yml)
 [![Code Coverage](https://img.shields.io/coverallsCoverage/github/ngandrass/moodle-tool_userautodelete)](https://coveralls.io/github/ngandrass/moodle-tool_userautodelete)
 [![GitHub Issues](https://img.shields.io/github/issues/ngandrass/moodle-tool_userautodelete)](https://github.com/ngandrass/moodle-tool_userautodelete/issues)

classes/local/admin/admin_setting_configcheckbox_alwaystrue.php

@@ -30,7 +30,6 @@
  * @license   https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class admin_setting_configcheckbox_alwaystrue extends \admin_setting_configcheckbox {
-
     /**
      * Retrieves the current setting using the objects name
      *
@@ -48,5 +47,4 @@ public function get_setting() {
     public function is_readonly(): bool {
         return true;
     }
-
 }

classes/logger.php

@@ -35,7 +35,6 @@
  * of the logging system.
  */
 class logger {
-
     /** @var bool If true, all logging operations are suppressed */
     protected static bool $suppresslogs = false;
 
@@ -104,5 +103,4 @@ public static function error(string $message): void {
             mtrace("[ERROR] $message");
         }
     }
-
 }

classes/manager.php

@@ -32,7 +32,6 @@
  * Manages the user notification and deletion workflow
  */
 class manager {
-
     /** @var \stdClass Moodle config object for this plugin */
     protected \stdClass $config;
 
@@ -370,13 +369,15 @@ protected function warn_inactive_users(): int {
         // Notify users.
         $numwarnedusers = 0;
         foreach ($userstowarn as $user) {
-            if (!email_to_user(
-                $user,
-                get_admin(),
-                $this->config->warning_email_subject,
-                html_to_text(nl2br($this->config->warning_email_body)),
-                $this->config->warning_email_body
-            )) {
+            if (
+                !email_to_user(
+                    $user,
+                    get_admin(),
+                    $this->config->warning_email_subject,
+                    html_to_text(nl2br($this->config->warning_email_body)),
+                    $this->config->warning_email_body
+                )
+            ) {
                 logger::error(get_string('error_sending_warning_mail_to_user', 'tool_userautodelete', $user->id));
                 continue;
             }
@@ -416,13 +417,15 @@ protected function delete_inactive_users(): int {
         foreach ($userstodelete as $user) {
             // Send deletion mail if enabled.
             if ($this->config->delete_email_enable) {
-                if (!email_to_user(
-                    $user,
-                    get_admin(),
-                    $this->config->delete_email_subject,
-                    html_to_text(nl2br($this->config->delete_email_body)),
-                    $this->config->delete_email_body
-                )) {
+                if (
+                    !email_to_user(
+                        $user,
+                        get_admin(),
+                        $this->config->delete_email_subject,
+                        html_to_text(nl2br($this->config->delete_email_body)),
+                        $this->config->delete_email_body
+                    )
+                ) {
                     logger::error(get_string('error_sending_delete_mail_to_user', 'tool_userautodelete', $user->id));
                 } else {
                     logger::info(get_string('delete_email_sent_to_user', 'tool_userautodelete', $user->id));
@@ -458,32 +461,34 @@ protected function delete_inactive_users(): int {
     protected function anonymize_user_record(int $userid): void {
         global $DB;
 
-        if ($DB->update_record('user', [
-            'id' => $userid,
-            'username' => "DELETED-USER-{$userid}",
-            'password' => '',
-            'idnumber' => '',
-            'firstname' => 'DELETED',
-            'lastname' => 'DELETED',
-            'email' => "DELETED-USER-{$userid}@localhost",
-            'phone1' => '',
-            'phone2' => '',
-            'institution' => '',
-            'department' => '',
-            'address' => '',
-            'city' => '',
-            'country' => '',
-            'lastip' => '',
-            'secret' => '',
-            'picture' => 0,
-            'description' => '',
-            'imagealt' => '',
-            'lastnamephonetic' => '',
-            'firstnamephonetic' => '',
-            'middlename' => '',
-            'alternatename' => '',
-            'moodlenetprofile' => '',
-        ])) {
+        if (
+            $DB->update_record('user', [
+                'id' => $userid,
+                'username' => "DELETED-USER-{$userid}",
+                'password' => '',
+                'idnumber' => '',
+                'firstname' => 'DELETED',
+                'lastname' => 'DELETED',
+                'email' => "DELETED-USER-{$userid}@localhost",
+                'phone1' => '',
+                'phone2' => '',
+                'institution' => '',
+                'department' => '',
+                'address' => '',
+                'city' => '',
+                'country' => '',
+                'lastip' => '',
+                'secret' => '',
+                'picture' => 0,
+                'description' => '',
+                'imagealt' => '',
+                'lastnamephonetic' => '',
+                'firstnamephonetic' => '',
+                'middlename' => '',
+                'alternatename' => '',
+                'moodlenetprofile' => '',
+            ])
+        ) {
             logger::info(get_string('user_anonymized', 'tool_userautodelete', $userid));
         } else {
             logger::error(get_string('error_anonymizing_user', 'tool_userautodelete', $userid));
@@ -527,5 +532,4 @@ protected function cleanup(): int {
 
         return $numrecoveredusers;
     }
-
 }

classes/output/log_table.php

@@ -31,15 +31,14 @@
 
 // @codeCoverageIgnoreStart
 global $CFG;
-require_once($CFG->libdir.'/tablelib.php');
+require_once($CFG->libdir . '/tablelib.php');
 // @codeCoverageIgnoreEnd
 
 
 /**
  * Table renderer for the log table
  */
 class log_table extends \table_sql {
-
     /**
      * Constructor
      *
@@ -116,5 +115,4 @@ public function col_deleted($values) {
         $color = $values->deleted > 0 ? 'danger' : 'secondary';
         return html_writer::span($values->deleted, "badge badge-{$color} text-bg-{$color} p-2");
     }
-
 }

classes/privacy/provider.php

@@ -40,11 +40,10 @@
  *
  * @codeCoverageIgnore This is handled by Moodle core tests
  */
-class provider implements
+class provider implements // phpcs:ignore
     \core_privacy\local\metadata\provider,
-    \core_privacy\local\request\plugin\provider,
-    \core_privacy\local\request\core_userlist_provider {
-
+    \core_privacy\local\request\core_userlist_provider,
+    \core_privacy\local\request\plugin\provider {
     /**
      * Returns meta data about this plugin.
      *
@@ -99,7 +98,7 @@ public static function export_user_data(approved_contextlist $contextlist) {
                     writer::with_context($context)->export_data(
                         [
                             get_string('pluginname', 'tool_userautodelete'),
-                            get_string('inactivity_warning', 'tool_userautodelete')." #{$row->id}",
+                            get_string('inactivity_warning', 'tool_userautodelete') . " #{$row->id}",
                         ],
                         (object) [
                             'userid' => $row->userid,
@@ -184,5 +183,4 @@ public static function delete_data_for_users(approved_userlist $userlist) {
         [$insql, $inparams] = $DB->get_in_or_equal($userlist->get_userids());
         $DB->delete_records_select('tool_userautodelete_mail', "userid {$insql}", $inparams);
     }
-
 }

classes/task/check_and_delete_users.php

@@ -34,7 +34,6 @@
  * and finally deletes eligible users
  */
 class check_and_delete_users extends \core\task\scheduled_task {
-
     /**
      * Get a descriptive name for the task (shown to admins)
      *
@@ -50,10 +49,10 @@ public function get_name() {
      * Throw exceptions on errors (the job will be retried).
      *
      * @throws \coding_exception
+     * @throws \dml_exception
      */
     public function execute() {
         $manager = new \tool_userautodelete\manager();
         $manager->execute();
     }
-
 }