replace deprecated strftime function for Tōtara 17

Fix for Moodle 4.1 [#306]

.github/workflows/ci.yml

@@ -1,11 +1,10 @@
+# .github/workflows/ci.yml
 name: ci
 
 on: [push, pull_request]
 
 jobs:
-  test:
+  ci:
     uses: catalyst/catalyst-moodle-workflows/.github/workflows/ci.yml@main
-    secrets:
-      moodle_org_token: ${{ secrets.MOODLE_ORG_TOKEN }}
     with:
       disable_behat: true

.github/workflows/moodle-release.yml

@@ -0,0 +1,21 @@
+#
+# Whenever version.php is changed, add the latest version
+# to the Moodle Plugins directory at https://moodle.org/plugins
+#
+name: Releasing in the Plugins directory
+
+on:
+  push:
+    branches:
+      - MOODLE_39_STABLE
+    paths:
+      - 'version.php'
+
+jobs:
+  workflow_group_39_plus_release:
+    uses: catalyst/catalyst-moodle-workflows/.github/workflows/group-39-plus-release.yml@main
+    with:
+      plugin_name: auth_outage
+      disable_behat: true
+    secrets:
+      moodle_org_token: ${{ secrets.MOODLE_ORG_TOKEN }}

QUICKGUIDE.md

@@ -59,6 +59,9 @@ Basic Usage
 
     _Anyone who tries to use Moodle now will receive a maintenance message._
 
+    **Note:** If the outage starts with the option `Auto start maintenance mode` checked, the maint mode won't exit automatically.
+    It will need to be disabled through command line.
+
 1) Perform the maintenance activities.
 
     At this point it is safe to perform the required maintenance as no one can use the system, not even admins.

README.md

@@ -1,4 +1,4 @@
-[![ci](https://github.com/catalyst/moodle-auth_outage/actions/workflows/ci.yml/badge.svg?branch=MOODLE_38_STABLE)](https://github.com/catalyst/moodle-auth_outage/actions/workflows/ci.yml?branch=MOODLE_38_STABLE)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/catalyst/moodle-auth_outage/ci.yml?branch=MOODLE_39_STABLE)
 
 # Moodle Outage manager plugin
 * [Version Support](#version-support)
@@ -24,10 +24,7 @@ this plugin creates the concept of graduated outages where at predefined times b
 an outage and after, different levels of warning and access can be provided to students
 and testers letting them know what is about to happen and why.
 
-<img alt="Default" src="https://cdn.rawgit.com/catalyst/moodle-auth_outage/master/docs/default.svg" width="520">
-
-<img alt="Manager" src="https://cdn.rawgit.com/catalyst/moodle-auth_outage/master/docs/outage.svg" width="520">
-
+![image](https://user-images.githubusercontent.com/187449/149717343-1d2c5237-dbc6-4d2a-a08c-2bdb343e87d2.png)
 
 Moodle Requirements
 -------------------
@@ -40,14 +37,12 @@ need to manually add one extra plugin, please check:
 
 Branches
 --------
-| Moodle version     | Branch      | PHP  |
-| ----------------- | ----------- | ---- |
-| Moodle 2.7 to 3.2 | MOODLE_32_STABLE | 5.5+ |
-| Totara up to 10 | TOTARA_10 | 5.5+ |
-| Moodle 3.3 to 3.8 | MOODLE_38_STABLE | 7.1+ |
-| Totara 11 to 12 | MOODLE_38_STABLE | 7.1+ |
-| Moodle 3.9+ | MOODLE_39_STABLE | 7.2+ |
-| Totara 13+ | MOODLE_39_STABLE | 7.2+ |
+| Moodle version     | Totara          | Branch           | PHP  |
+| ------------------ | --------------- | ---------------- | ---- |
+| Moodle 3.9+        | Totara 13+      | MOODLE_39_STABLE | 7.2+ |
+| Moodle 3.3 to 3.8  | Totara 11 to 12 | MOODLE_38_STABLE | 7.1+ |
+| Moodle 2.7 to 3.2  |                 | MOODLE_32_STABLE | 5.5+ |
+|                    | Totara up to 10 | TOTARA_10        | 5.5+ |
 
 Screenshots
 -----------
@@ -105,6 +100,48 @@ This can be found at:
 
 
 
+Custom Theme Additional SCSS
+-------------------
+
+Custom themes generally do not have the same `$navbar-height` variable set to 80px (MOODLE), therefore custom themes will not calculate the change in navbar height with page elements that calculate the navbar total height. 
+
+Add the following SCSS For Moodle 3.11+
+
+```
+body.auth_outage {
+    #page-wrapper {
+        #nav-drawer {
+            top: $navbar-height + 100px;
+            height: calc(100% - (#{$navbar-height} + 100px));
+        }
+        #page {
+            margin-top: $navbar-height + 100px;
+        }
+    }
+    [data-region=right-hand-drawer].drawer {
+        top: $navbar-height + 100px;
+        height: calc(100% - (#{$navbar-height} + 100px));
+    } 
+}
+```
+
+Totara is a little different with version 13+ and no variables are used to set the `totaraNav` height 
+
+Add the following CSS For Totara 13+
+
+```
+.totaraNav {
+    margin-top: 100px;
+}
+.local_envbar .totaraNav {
+    margin-top: 50px;
+}
+body.auth_outage #page {
+    margin-top: 0;
+}
+```
+
+
 
 How to use
 ----------

classes/dml/outagedb.php

@@ -211,21 +211,20 @@ class outagedb {
             throw new coding_exception('$time must be null or a positive int.', $time);
         }
 
-        $select = ':datetime2 <= stoptime AND (finished IS NULL OR :datetime3 <= finished)'; // End condition.
-        $select = "(warntime <= :datetime1 AND (${select}))"; // Full select part.
-        $data = $DB->get_records_select(
-            'auth_outage',
-            $select,
-            ['datetime1' => $time, 'datetime2' => $time, 'datetime3' => $time],
-            'starttime ASC, stoptime DESC, title ASC',
-            '*',
-            0,
-            1
-        );
+        // Get cached outage, or null.
+        $outageinfo = get_config('moodle', 'auth_outage_active_outage');
 
-        // Not using $DB->get_record_select instead because there is no 'limit' parameter.
-        // Allowing multiple records still raises an internal error.
-        return (count($data) == 0) ? null : new outage(array_shift($data));
+        if (!$outageinfo) {
+            return null;
+        } else {
+            $outagecache = new outage(json_decode($outageinfo));
+        }
+
+        if ($outagecache && $outagecache->warntime <= $time && $outagecache->stoptime >= $time
+            && (!$outagecache->finished || $outagecache->finished >= $time)) {
+            return  $outagecache;
+        }
+        return null;
     }
 
     /**

classes/form/outage/edit.php

@@ -147,7 +147,7 @@ class edit extends moodleform {
      * @throws coding_exception
      */
     public function set_data($outage) {
-        global $OUTPUT;
+        global $OUTPUT, $CFG;
         $mform = $this->_form;
 
         // Cannot change method signature, check type.
@@ -162,6 +162,15 @@ class edit extends moodleform {
                 'description' => ['text' => $outage->description, 'format' => '1'],
             ]);
 
+            // If the default_autostart is configured in config, then force autostart to be the default value.
+            if (array_key_exists('auth_outage', $CFG->forced_plugin_settings)
+                && array_key_exists('default_autostart', $CFG->forced_plugin_settings['auth_outage'])) {
+                $this->_form->setDefaults([
+                    'autostart' => $CFG->forced_plugin_settings['auth_outage']['default_autostart']
+                ]);
+                $mform->freeze('autostart');
+            }
+
             if (!empty($outage->id) && $outage->autostart && $outage->starttime < time() && $outage->stoptime > time()) {
                 $warning = $mform->getElement('warningreenablemaintenancemode');
                 $warning->setValue($OUTPUT->notification(get_string('warningreenablemaintenancemode', 'auth_outage'),

classes/local/cli/clibase.php

@@ -122,7 +122,7 @@ abstract class clibase {
      */
     protected function become_admin_user() {
         global $DB;
-        $user = $DB->get_record('user', ['id' => 2]);
+        $user = get_admin();
         unset($user->description);
         unset($user->access);
         unset($user->preference);

classes/local/cli/waitforit.php

@@ -129,7 +129,7 @@ class waitforit extends clibase {
             return;
         }
 
-        $time = strftime('%F %T %Z');
+        $time = \totara_core\strftime::format('%F %T %Z');
         printf("[%s] %s\n", $time, $message);
     }
 

classes/local/controllers/infopage.php

@@ -46,6 +46,11 @@ class infopage {
      */
     private $outage;
 
+    /**
+     * @var bool|null Defines if the page is generated for a static outage page.
+     */
+    private $static;
+
     /**
      * infopage_controller constructor.
      * @param array $params Parameters to use or null to get from Moodle API (request).
@@ -60,11 +65,13 @@ class infopage {
             $params = [
                 'id' => optional_param('id', null, PARAM_INT),
                 'outage' => null,
+                'static' => optional_param('static', false, PARAM_BOOL),
             ];
         } else {
             $defaults = [
                 'id' => null,
                 'outage' => null,
+                'static' => false,
             ];
             $params = array_merge($defaults, $params);
         }
@@ -99,6 +106,10 @@ class infopage {
             redirect(new moodle_url('/'));
         }
 
+        // If it's not static outage page, then check access, then redirect if not allowed.
+        if (!$this->static && !has_capability('auth/outage:viewinfo', context_system::instance())) {
+            redirect(new moodle_url('/'));
+        }
         $PAGE->set_context(context_system::instance());
         $PAGE->set_title($this->outage->get_title());
         $PAGE->set_heading($this->outage->get_title());
@@ -141,5 +152,6 @@ class infopage {
         }
 
         $this->outage = $params['outage'];
+        $this->static = $params['static'];
     }
 }

classes/local/controllers/maintenance_static_page.php

@@ -59,7 +59,7 @@ class maintenance_static_page {
             $html = '<html></html>';
         } else {
             $data = maintenance_static_page_io::file_get_data(
-                $CFG->wwwroot.'/auth/outage/info.php?auth_outage_hide_warning=1&id='.$outage->id);
+                $CFG->wwwroot.'/auth/outage/info.php?auth_outage_hide_warning=1&static=1&id='.$outage->id);
             $html = $data['contents'];
         }
 

classes/local/controllers/maintenance_static_page_generator.php

@@ -27,6 +27,7 @@ namespace auth_outage\local\controllers;
 
 use auth_outage\local\outagelib;
 use coding_exception;
+use core_php_time_limit;
 use DOMDocument;
 use DOMElement;
 use invalid_state_exception;
@@ -41,6 +42,15 @@ use moodle_url;
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class maintenance_static_page_generator {
+    /** PATTERN
+     * The pattern should match the attribute values that
+     * go as 'url(xxxxx)', but make sure 'url(data:xxxxx)' is not
+     * rewritten. Must be case insensitive to match 'URL(xxxxx)'.
+     * It should be possible to specify other background attributes as
+     * 'background: color url(xxxxx) no-repeat'.
+     */
+    protected const PATTERN = '/url\s*\(\s*[\'"]?(?![\'"]?data:)([^\s\'"]+)[\'"]?\s*\)/i';
+
     /** @var DOMDocument */
     protected $dom;
 
@@ -73,6 +83,10 @@ class maintenance_static_page_generator {
         $this->io->cleanup();
 
         if (!is_null($this->dom)) {
+
+            // This can take a while to process using repeated curls.
+            core_php_time_limit::raise();
+
             $this->io->create_resources_path();
 
             $this->remove_script_tags();
@@ -81,6 +95,7 @@ class maintenance_static_page_generator {
             $this->update_link_favicon();
             $this->update_images();
             $this->remove_configured_css_selectors();
+            $this->update_inline_background_images();
 
             $html = $this->dom->saveHTML();
             if (trim($html) == '') {
@@ -148,6 +163,18 @@ class maintenance_static_page_generator {
         return $matches;
     }
 
+    /**
+     * Retrieves a URL from inline style using regular expressions.
+     *
+     * @param string $style Content of the style attribute
+     * @return array Array containing match
+     */
+    public function get_url_from_inline_style($style) {
+        preg_match(self::PATTERN, $style, $match);
+        return $match;
+    }
+
+
     /**
      * Checks for urls inside filename.
      *
@@ -216,6 +243,31 @@ class maintenance_static_page_generator {
         }
     }
 
+    /**
+     * Fetch and fixes all inline background images.
+     */
+    private function update_inline_background_images() {
+        global $CFG;
+        $xpath = new \DOMXPath($this->dom);
+        $elements = $xpath->query("//*[contains(@style,'background')]");
+
+        foreach ($elements as $element) {
+            $style = $element->getAttribute("style");
+            $matches = $this->get_url_from_inline_style($style);
+            if (isset($matches[1])) {
+                // Allow incomplete URLs in style, assume it is from moodle root.
+                if (maintenance_static_page_io::is_url($matches[1])) {
+                    $fullurl = $matches[1];
+                } else {
+                    $fullurl = (string) new moodle_url($matches[1]);
+                }
+                $newurl = $this->io->generate_file_url($fullurl);
+                $updated = preg_replace(self::PATTERN, ' url('.$newurl.') ', $style);
+                $element->setAttribute('style', $updated);
+            }
+        }
+    }
+
     /**
      * Remove from DOM the CSS selectores defined in the plugin settings.
      */

classes/local/outage.php

@@ -297,4 +297,12 @@ class outage {
         // Adjust bool fields.
         $this->autostart = ($this->autostart === null) ? null : (bool)$this->autostart;
     }
+
+    /**
+     * Return json encoded outage.
+     * @return string Json string.
+     */
+    public function __toString() {
+        return json_encode(get_object_vars($this));
+    }
 }

classes/local/outagelib.php

@@ -168,7 +168,12 @@ class outagelib {
             }
         }
 
-        return (object)array_merge(self::get_config_defaults(), $config);
+        $config = array_merge(self::get_config_defaults(), $config);
+        // Combine allowed IPs config values together.
+        if (isset($config['allowedips_forced'])) {
+            $config['allowedips'] = trim($config['allowedips'] . "\n" . $config['allowedips_forced']);
+        }
+        return (object)$config;
     }
 
     /**
@@ -205,6 +210,10 @@ class outagelib {
         } else {
             $ongoingoutage = true;
         }
+
+        // Set json formatted outage string to cache.
+        set_config('auth_outage_active_outage', (string)$outage);
+
         maintenance_static_page::create_from_outage($outage)->generate();
         self::update_climaintenance_code($outage);
         if (!$ongoingoutage || $reenablemaint || is_null($outage)) {
@@ -237,6 +246,7 @@ class outagelib {
                 unset_config('maintenance_message');
             }
             set_config('maintenance_later', $outage->starttime);
+            self::maintenance_config_log($outage);
         }
     }
 
@@ -405,4 +415,18 @@ EOT;
 
         return $message;
     }
+
+    /**
+     * Logging for maintenance mode configuration.
+     *
+     * @param outage|null $outage Outage or null if no scheduled outage.
+     */
+    private static function maintenance_config_log(outage $outage) {
+        mtrace(get_string('logformaintmodeconfig', 'auth_outage'));
+        $timezone = ' (Timezone ' . \core_date::get_server_timezone_object()->getName() . ')';
+        mtrace('... updated at ' . date('H:i:s'));
+        $time = date("Y-m-d H:i:s", $outage->starttime);
+        mtrace("... enable maintenance mode at $time $timezone");
+        mtrace(get_string('logformaintmodeconfigcomplete', 'auth_outage'));
+    }
 }

db/access.php

@@ -0,0 +1,37 @@
+<?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/>.
+
+/**
+ * Define capabilities for plugin.
+ *
+ * @package    auth_outage
+ * @author     Andrew Madden <andrewmadden@catalyst-au.net>
+ * @copyright  2021 Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = [
+    'auth/outage:viewinfo' => array(
+        'captype' => 'read',
+        'contextlevel' => CONTEXT_SYSTEM,
+        'archetypes' => array(
+            'guest' => CAP_ALLOW,
+            'user' => CAP_ALLOW,
+        )
+    ),
+];

lang/en/auth_outage.php

@@ -26,6 +26,8 @@
 $string['auth_outagedescription'] = 'Auxiliary plugin that warns users about a future outage and prevents them from logging in once the outage starts.';
 $string['autostart'] = 'Auto start maintenance mode.';
 $string['autostart_help'] = 'If selected, when the outage starts it will automatically turn on Moodle maintenance mode.';
+$string['builtinallowediplist'] = 'Builtin Allowed IP List';
+$string['builtinallowediplist_desc'] = 'A second allowed IP list which makes it easier to have some IPs forced in config.php and others editable in the UI';
 $string['clicreatehelp'] = 'Creates a new outage.';
 $string['clicreateexamples'] = "Create an outage starting in 10 seconds\n\n> php create.php -s=10";
 $string['clicreateparamautostart'] = 'must be Y or N, sets if the outage automatically triggers maintenance mode.';
@@ -100,10 +102,13 @@ $string['infostart'] = 'start';
 $string['infostartofwarning'] = 'start of warning';
 $string['infostaticpage'] = 'static page';
 $string['infopagestaticgenerated'] = 'This warning was generated on {$a->time}.';
+$string['ips_combine'] = 'The IPs listed above will be combined with the IPs listed below.';
 $string['allowedipsempty'] = 'When the allowed IPs list is empty we will not block anyone. You can add your own IP address (<i>{$a->ip}</i>) and block all other IPs.';
 $string['allowedipshasmyip'] = 'Your IP (<i>{$a->ip}</i>) is in the list and you will not be blocked out during an Outage.';
 $string['allowedipshasntmyip'] = 'Your IP (<i>{$a->ip}</i>) is not in the list and you will be blocked out during an outage.';
 $string['allowedipsnoconfig'] = 'Your config.php does not have the extra setup to allow blocking via IP.<br />Please refer to our <a href="https://github.com/catalyst/moodle-auth_outage#installation" target="_blank">README.md</a> file for more information.';
+$string['logformaintmodeconfig'] = 'Update maintenance mode configuration.';
+$string['logformaintmodeconfigcomplete'] = 'Updating maintenance mode configuration complete.';
 $string['menusettings'] = 'Settings';
 $string['menumanage'] = 'Manage outages';
 $string['messageoutagebackonline'] = 'We are back online!';
@@ -112,6 +117,7 @@ $string['messageoutageongoing'] = 'Back online at {$a->stop}.';
 $string['messageoutagewarning'] = 'Shutting down in {{countdown}}';
 $string['na'] = 'n/a';
 $string['notfound'] = 'No outages found.';
+$string['outage:viewinfo'] = 'View outage info';
 $string['outageedit'] = 'Edit outage';
 $string['outageeditcrumb'] = 'Edit';
 $string['outageclone'] = 'Clone outage';

settings.php

@@ -26,25 +26,30 @@
  * @var admin_settingpage $settings
  * @var bootstrap_renderer $OUTPUT
  * @var admin_root $ADMIN
+ * @var moodle_page $PAGE
  */
 use auth_outage\local\outagelib;
 
 defined('MOODLE_INTERNAL') || die;
 
-if ($hassiteconfig && is_enabled_auth('outage')) {
+if ($hassiteconfig) {
     $defaults = outagelib::get_config_defaults();
     $settings->visiblename = get_string('menusettings', 'auth_outage');
+    $description = outagelib::generate_plugin_configuration_warning();
 
     $settings->add(new admin_setting_heading(
         'defaults',
         get_string('settingssectiondefaults', 'auth_outage'),
-        get_string('settingssectiondefaultsdescription', 'auth_outage')));
+        get_string('settingssectiondefaultsdescription', 'auth_outage') . $description
+    ));
+
     $settings->add(new admin_setting_configcheckbox(
         'auth_outage/default_autostart',
         get_string('defaultoutageautostart', 'auth_outage'),
         get_string('defaultoutageautostartdescription', 'auth_outage'),
         $defaults['default_autostart']
     ));
+
     $settings->add(new admin_setting_configduration(
         'auth_outage/default_warning_duration',
         get_string('defaultwarningduration', 'auth_outage'),
@@ -96,20 +101,23 @@ if ($hassiteconfig && is_enabled_auth('outage')) {
 
     // Create 'Allowed IPs' settings.
     $allowedips = outagelib::get_config()->allowedips;
-    $description = outagelib::generate_plugin_configuration_warning();
     if (trim($allowedips) == '') {
         $message = 'allowedipsempty';
         $type = 'notifymessage';
-    } else if (remoteip_in_list($allowedips)) {
-        $message = 'allowedipshasmyip';
-        $type = 'notifysuccess';
     } else {
-        $message = 'allowedipshasntmyip';
-        $type = 'notifyerror';
+        if (remoteip_in_list($allowedips)) {
+            $message = 'allowedipshasmyip';
+            $type = 'notifysuccess';
+        } else {
+            $message = 'allowedipshasntmyip';
+            $type = 'notifyerror';
+        }
     };
-    $description .= $OUTPUT->notification(get_string($message, 'auth_outage', ['ip' => getremoteaddr()]), $type);
+    $description = $OUTPUT->notification(get_string($message, 'auth_outage', ['ip' => getremoteaddr()]), $type);
+
+    $description .= '<p>' . get_string('ipblockersyntax', 'admin') . '</p>';
+    $description .= '<p>' . get_string('ips_combine', 'auth_outage') . '</p>';
 
-    $description .= '<p>'.get_string('ipblockersyntax', 'admin').'</p>';
     $iplist = new admin_setting_configiplist(
         'auth_outage/allowedips',
         get_string('allowediplist', 'admin'),
@@ -119,6 +127,14 @@ if ($hassiteconfig && is_enabled_auth('outage')) {
     $iplist->set_updatedcallback('auth_outage_outagelib_prepare_next_outage');
     $settings->add($iplist);
 
+    $iplist = new admin_setting_configiplist(
+        'auth_outage/allowedips_forced',
+        get_string('builtinallowediplist', 'auth_outage'),
+        get_string('builtinallowediplist_desc', 'auth_outage'),
+        ''
+    );
+    $settings->add($iplist);
+
     // Create 'Static Page - Elements to Remove' settings.
     $toremove = new admin_setting_configtextarea(
         'auth_outage/remove_selectors',
@@ -140,7 +156,7 @@ if ($hassiteconfig && is_enabled_auth('outage')) {
         new admin_externalpage(
             'auth_outage_manage',
             get_string('menumanage', 'auth_outage'),
-            new moodle_url($CFG->wwwroot.'/auth/outage/manage.php')
+            new moodle_url($CFG->wwwroot . '/auth/outage/manage.php')
         )
     );
 }

tests/phpunit/base_testcase.php

@@ -32,6 +32,7 @@
  */
 
 use auth_outage\dml\outagedb;
+use auth_outage\local\outage;
 
 /**
  * auth_outage_base_testcase class.
@@ -63,6 +64,37 @@ abstract class auth_outage_base_testcase extends advanced_testcase {
         }
     }
 
+    /**
+     * Revoke permission to see info page.
+     */
+    protected function revoke_info_page_permissions() {
+        global $DB;
+
+        $guestrole = $DB->get_record('role', array('shortname' => 'guest'));
+        role_change_permission($guestrole->id, context_system::instance(), 'auth/outage:viewinfo', CAP_PREVENT);
+
+        $this->setGuestUser();
+    }
+
+    /**
+     * Get an outage object.
+     *
+     * @return \auth_outage\local\outage
+     */
+    protected function get_dummy_outage() {
+        $now = time();
+
+        return new outage([
+            'id' => 1,
+            'autostart' => false,
+            'warntime' => $now - 100,
+            'starttime' => $now + 100,
+            'stoptime' => $now + 200,
+            'title' => 'Title',
+            'description' => 'Description',
+        ]);
+    }
+
     /**
      * Setup testcase.
      */

tests/phpunit/calendar/calendar_test.php

@@ -37,7 +37,7 @@ use auth_outage\local\outage;
  * @copyright       Catalyst IT
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class calendar_test extends advanced_testcase {
+class auth_outage_calendar_test extends advanced_testcase {
     /**
      * @var outage|null The calendar entry owner.
      */
@@ -132,8 +132,8 @@ class calendar_test extends advanced_testcase {
         ]);
 
         calendar::update($outage);
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**
@@ -144,8 +144,8 @@ class calendar_test extends advanced_testcase {
         self::setAdminUser();
 
         calendar::delete(1);
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**

tests/phpunit/dml/outagedb_test.php

@@ -37,7 +37,7 @@ require_once(__DIR__.'/../base_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class outagedb_test extends auth_outage_base_testcase {
+class auth_outage_outagedb_test extends auth_outage_base_testcase {
     /**
      * Creates an array of ids in from the given outages array.
      * @param outage[] $outages An array of outages.
@@ -244,6 +244,15 @@ class outagedb_test extends auth_outage_base_testcase {
         $activeid = self::saveoutage(false, $now, -2, 1, 2, 'An outage in warning period.');
         self::assertSame($activeid, outagedb::get_active($now)->id, 'Wrong active outage picked.');
 
+        $activeid = self::saveoutage(false, $now, -2, 0, 2, 'An outage starts now.');
+        self::assertSame($activeid, outagedb::get_active($now)->id, 'Wrong active outage picked.');
+
+        self::saveoutage(false, $now, -2, 0, -1, 'Invalid outage.');
+        self::assertSame($activeid, outagedb::get_active($now)->id, 'Wrong active outage picked.');
+
+        self::saveoutage(false, $now, -2, 0, 0, 'Invalid outage.');
+        self::assertSame($activeid, outagedb::get_active($now)->id, 'Wrong active outage picked.');
+
         self::saveoutage(false, $now, -1, 2, 3,
             'Another outage in warning period, but ignored as it starts after the previous one.');
         self::assertSame($activeid, outagedb::get_active($now)->id, 'Wrong active outage picked.');
@@ -427,8 +436,8 @@ class outagedb_test extends auth_outage_base_testcase {
     public function test_finish_now_notfound() {
         $this->resetAfterTest(true);
         outagedb::finish(1);
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**
@@ -449,8 +458,8 @@ class outagedb_test extends auth_outage_base_testcase {
         self::assertTrue(!$outage->is_ongoing($time));
 
         outagedb::finish($id, $time);
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**

tests/phpunit/event/events_test.php

@@ -37,7 +37,7 @@ use auth_outage\local\outage;
  * @copyright       Catalyst IT
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class events_test extends advanced_testcase {
+class auth_outage_events_test extends advanced_testcase {
     /**
      * @var outage|null Outage used in the tests.
      */

tests/phpunit/form/forms_test.php

@@ -39,7 +39,7 @@ require_once(__DIR__.'/../base_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class forms_test extends auth_outage_base_testcase {
+class auth_outage_forms_test extends auth_outage_base_testcase {
     /**
      * Create a delete form.
      */
@@ -146,8 +146,8 @@ class forms_test extends auth_outage_base_testcase {
         $_POST['description'] = ['text' => 'The <b>description</b>.', 'format' => '2'];
         $edit = new edit();
         self::assertNull($edit->get_data());
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**

tests/phpunit/installation_test.php

@@ -40,7 +40,7 @@ require_once(__DIR__.'/base_testcase.php');
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class installation_test extends auth_outage_base_testcase {
+class auth_outage_installation_test extends auth_outage_base_testcase {
     /**
      * Checks if plugin cleans up data after uninstall.
      *
@@ -63,7 +63,11 @@ class installation_test extends auth_outage_base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         \auth_outage\dml\outagedb::save($outage);
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
         self::assertSame(1, $DB->count_records_select('event', "eventtype = 'auth_outage'", null));
 
         // Uninstall plugin.
@@ -71,7 +75,7 @@ class installation_test extends auth_outage_base_testcase {
         $progress = new progress_trace_buffer(new text_progress_trace(), false);
         core_plugin_manager::instance()->uninstall_plugin('auth_outage', $progress);
         $progress->finished();
-        self::assertContains('++ Success ++', $progress->get_buffer());
+        self::assertStringContainsString('++ Success ++', $progress->get_buffer());
 
         // Check ...
         self::assertSame(0, $DB->count_records_select('event', "eventtype = 'auth_outage'", null),

tests/phpunit/lib_test.php

@@ -35,7 +35,7 @@ require_once(__DIR__.'/../../lib.php');
  * @copyright  2017 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class lib_test extends auth_outage_base_testcase {
+class auth_outage_lib_test extends auth_outage_base_testcase {
     /**
      * Test this plugin gets climaintenance resource file.
      */

tests/phpunit/local/cli/cli_test.php

@@ -37,7 +37,7 @@ require_once(__DIR__.'/cli_testcase.php');
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class cli_test extends auth_outage_cli_testcase {
+class auth_outage_cli_test extends auth_outage_cli_testcase {
     /**
      * Tests providing an unknown parameter.
      */
@@ -81,8 +81,8 @@ class cli_test extends auth_outage_cli_testcase {
         $this->set_parameters(['-h']);
         $cli = new create();
         $output = $this->execute($cli);
-        self::assertContains('-h', $output);
-        self::assertContains('--help', $output);
+        self::assertStringContainsString('-h', $output);
+        self::assertStringContainsString('--help', $output);
     }
 
     /**

tests/phpunit/local/cli/create_test.php

@@ -39,7 +39,7 @@ require_once(__DIR__.'/cli_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class create_test extends auth_outage_cli_testcase {
+class auth_outage_create_test extends auth_outage_cli_testcase {
     /**
      * Tests without any arguments.
      */
@@ -120,8 +120,8 @@ class create_test extends auth_outage_cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new create();
         $output = $this->execute($cli);
-        self::assertContains('Creates', $output);
-        self::assertContains('--help', $output);
+        self::assertStringContainsString('Creates', $output);
+        self::assertStringContainsString('--help', $output);
     }
 
     /**
@@ -157,10 +157,10 @@ class create_test extends auth_outage_cli_testcase {
         $cli = new create();
         $cli->set_referencetime($now);
         $text = $this->execute($cli);
-        self::assertContains('created', $text);
+        self::assertStringContainsString('created', $text);
         // Check creted outage.
-        list(, $id) = explode(':', $text);
-        $id = (int)$id;
+        $clioutput = explode(':', $text);
+        $id = (int)end($clioutput);
         $outage = outagedb::get_by_id($id);
         self::assertSame($now, $outage->starttime);
         self::assertSame(10, $outage->get_warning_duration());
@@ -221,10 +221,10 @@ class create_test extends auth_outage_cli_testcase {
             'description' => 'Default Description',
         ]);
         $text = $this->execute($cli);
-        self::assertContains('created', $text);
+        self::assertStringContainsString('created', $text);
         // Check creted outage.
-        list(, $id) = explode(':', $text);
-        $id = (int)$id;
+        $clioutput = explode(':', $text);
+        $id = (int)end($clioutput);
         $outage = outagedb::get_by_id($id);
         self::assertSame($now + 50, $outage->starttime, 'Wrong starttime.');
         self::assertSame($outage->starttime - 100, $outage->warntime, 'Wrong warntime.');
@@ -299,8 +299,8 @@ class create_test extends auth_outage_cli_testcase {
         $cli = new create();
         $cli->set_referencetime($now);
         $text = $this->execute($cli);
-        self::assertContains('created', $text);
-        self::assertContains('started', $text);
+        self::assertStringContainsString('created', $text);
+        self::assertStringContainsString('started', $text);
     }
 
     /**

tests/phpunit/local/cli/finish_test.php

@@ -39,7 +39,7 @@ require_once(__DIR__.'/cli_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class finish_test extends auth_outage_cli_testcase {
+class auth_outage_finish_test extends auth_outage_cli_testcase {
     /**
      * Tests the constructor.
      */
@@ -72,8 +72,8 @@ class finish_test extends auth_outage_cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new finish();
         $text = $this->execute($cli);
-        self::assertContains('Finishes', $text);
-        self::assertContains('--help', $text);
+        self::assertStringContainsString('Finishes', $text);
+        self::assertStringContainsString('--help', $text);
     }
 
     /**

tests/phpunit/local/cli/waitforit_test.php

@@ -39,7 +39,7 @@ require_once(__DIR__.'/cli_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class waitforit_test extends auth_outage_cli_testcase {
+class auth_outage_waitforit_test extends auth_outage_cli_testcase {
     /**
      * Tests the constructor.
      */
@@ -78,8 +78,8 @@ class waitforit_test extends auth_outage_cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new waitforit();
         $text = $this->execute($cli);
-        self::assertContains('Waits', $text);
-        self::assertContains('--help', $text);
+        self::assertStringContainsString('Waits', $text);
+        self::assertStringContainsString('--help', $text);
     }
 
     /**
@@ -151,9 +151,9 @@ class waitforit_test extends auth_outage_cli_testcase {
         $cli = new waitforit();
         $cli->set_referencetime($now);
         $output = $this->execute($cli);
-        self::assertContains('Verbose mode', $output);
-        self::assertContains('starting in 1 sec', $output);
-        self::assertContains('started', $output);
+        self::assertStringContainsString('Verbose mode', $output);
+        self::assertStringContainsString('starting in 1 sec', $output);
+        self::assertStringContainsString('started', $output);
     }
 
     /**
@@ -178,11 +178,11 @@ class waitforit_test extends auth_outage_cli_testcase {
             return $now;
         });
         $output = $this->execute($cli);
-        self::assertContains("starting in 45", $output);
-        self::assertContains("sleep 30 second", $output);
-        self::assertContains("starting in 15", $output);
-        self::assertContains("sleep 15 second", $output);
-        self::assertContains("started!", $output);
+        self::assertStringContainsString("starting in 45", $output);
+        self::assertStringContainsString("sleep 30 second", $output);
+        self::assertStringContainsString("starting in 15", $output);
+        self::assertStringContainsString("sleep 15 second", $output);
+        self::assertStringContainsString("started!", $output);
     }
 
     /**

tests/phpunit/local/controllers/infopage_test.php

@@ -37,11 +37,13 @@ require_once(__DIR__.'/../../base_testcase.php');
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class infopagecontroller_test extends auth_outage_base_testcase {
+class auth_outage_infopagecontroller_test extends auth_outage_base_testcase {
     /**
      * Tests the constructor.
      */
     public function test_constructor() {
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
         new infopage();
     }
 
@@ -49,6 +51,8 @@ class infopagecontroller_test extends auth_outage_base_testcase {
      * Tests the constructor with given parameters.
      */
     public function test_constructor_withparams() {
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
         $_GET = ['id' => 1, 'static' => 'true'];
         new infopage();
     }
@@ -57,16 +61,10 @@ class infopagecontroller_test extends auth_outage_base_testcase {
      * Tests the constructor with different id and outage id.
      */
     public function test_constructor_idmismatch() {
-        $outage = new outage([
-            'id' => 1,
-            'autostart' => false,
-            'warntime' => time() - 60,
-            'starttime' => time(),
-            'stoptime' => time() + 60,
-            'title' => 'Title',
-            'description' => 'Description',
-        ]);
-        $this->set_expected_exception('coding_exception');
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        $outage = $this->get_dummy_outage();
+        $this->set_expected_exception('coding_exception', 'Provided id and outage->id do not match. (2/1)');
         new infopage(['id' => 2, 'outage' => $outage]);
     }
 
@@ -74,36 +72,82 @@ class infopagecontroller_test extends auth_outage_base_testcase {
      * Tests the constructor with an invalid outage.
      */
     public function test_constructor_invalidoutage() {
-        $this->set_expected_exception('coding_exception');
-        new infopage(['outage' => 'My outage']);
-    }
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
 
-    /**
-     * We should have an exception because CLI cannot redirect.
-     */
-    public function test_output_nonstatic_nooutage() {
-        $info = new infopage(['static' => false]);
-        $this->set_expected_exception('moodle_exception');
-        $info->output();
+        $this->set_expected_exception('coding_exception', 'Provided outage is not a valid outage object. (My outage)');
+        new infopage(['outage' => 'My outage']);
     }
 
     /**
      * Checks the output of the info page.
      */
     public function test_output() {
-        $now = time();
-        $outage = new outage([
-            'id' => 1,
-            'autostart' => false,
-            'warntime' => $now - 100,
-            'starttime' => $now + 100,
-            'stoptime' => $now + 200,
-            'title' => 'Title',
-            'description' => 'Description',
-        ]);
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        $outage = $this->get_dummy_outage();
+
         $info = new infopage(['outage' => $outage]);
         $output = $info->get_output();
-        self::assertContains('auth_outage_info', $output);
+        self::assertStringContainsString('auth_outage_info', $output);
+    }
+
+    /**
+     * Checks the output of the info page.
+     */
+    public function test_output_without_permission() {
+        $this->revoke_info_page_permissions();
+        $this->assertFalse(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        $outage = $this->get_dummy_outage();
+        $info = new infopage(['outage' => $outage]);
+
+        $this->set_expected_exception('moodle_exception', 'Unsupported redirect detected, script execution terminated');
+        $output = $info->get_output();
+    }
+
+    /**
+     * Checks the output of the info page.
+     */
+    public function test_output_without_permission_but_static() {
+        $this->revoke_info_page_permissions();
+        $this->assertFalse(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        $outage = $this->get_dummy_outage();
+        $info = new infopage(['outage' => $outage, 'static' => true]);
+
+        $output = $info->get_output();
+        self::assertStringContainsString('auth_outage_info', $output);
+    }
+
+    /**
+     * Checks the output of the info page.
+     */
+    public function test_output_with_forcelogin() {
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        set_config('forcelogin', true);
+
+        $outage = $this->get_dummy_outage();
+        $info = new infopage(['outage' => $outage]);
+
+        $this->set_expected_exception('moodle_exception', 'Unsupported redirect detected, script execution terminated');
+        $info->get_output();
+    }
+
+    /**
+     * Checks the output of the info page.
+     */
+    public function test_output_with_forcelogin_if_static() {
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
+        set_config('forcelogin', true);
+
+        $outage = $this->get_dummy_outage();
+
+        $info = new infopage(['outage' => $outage, 'static' => true]);
+
+        $output = $info->get_output();
+        self::assertStringContainsString('auth_outage_info', $output);
     }
 
     /**
@@ -111,6 +155,9 @@ class infopagecontroller_test extends auth_outage_base_testcase {
      */
     public function test_svgicons_is_true() {
         global $CFG;
+
+        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
+
         $CFG->svgicons = false;
         new infopage();
         self::assertTrue($CFG->svgicons);

tests/phpunit/local/controllers/maintenance_static_page_test.php

@@ -39,7 +39,7 @@ require_once(__DIR__.'/../../base_testcase.php');
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class maintenance_static_page_test extends auth_outage_base_testcase {
+class auth_outage_maintenance_static_page_test extends auth_outage_base_testcase {
     /**
      * Test template file.
      */
@@ -90,7 +90,7 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         maintenance_static_page::create_from_html($html)->generate();
 
         $generated = $this->generated_page_html($html);
-        self::assertNotContains('<script', $generated);
+        self::assertStringNotContainsString('<script', $generated);
     }
 
     /**
@@ -104,9 +104,9 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
                 '<body>Content<link rel="stylesheet" href="'.$externalcsslink.'"></body></html>';
         $generated = $this->generated_page_html($html);
 
-        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
-        self::assertNotContains($localcsslink, $generated);
-        self::assertContains($externalcsslink, $generated);
+        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+        self::assertStringNotContainsString($localcsslink, $generated);
+        self::assertStringContainsString($externalcsslink, $generated);
     }
 
     /**
@@ -174,9 +174,9 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
                 '<body><img src="'.$localimglink.'">Content<img src="'.$externalimglink.'" /></body></html>';
         $generated = $this->generated_page_html($html);
 
-        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
-        self::assertNotContains($localimglink, $generated);
-        self::assertContains($externalimglink, $generated);
+        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+        self::assertStringNotContainsString($localimglink, $generated);
+        self::assertStringContainsString($externalimglink, $generated);
     }
 
      /**
@@ -189,8 +189,62 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
                 '<body>Content</body></html>';
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains($link, $generated);
-        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+        self::assertStringNotContainsString($link, $generated);
+        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+    }
+
+
+    /**
+     * Data provider for test_update_inline_background_images
+     * @return array
+     */
+    public function test_update_inline_background_images_provider() {
+        return [
+            // Empty string.
+            ["", false],
+            // URLs that should be retrieved.
+            ["color: #FF00FF; background: lightblue url(/pluginfile.php/1/theme_custom/banner/251298630/0001.png) no-repeat", true],
+            ["background: lightblue url(https://www.example.com/moodle/pluginfile.php/1/theme_custom/banner/251298630/0001.png) no-repeat", true],
+            ["background:url('https://www.example.com/moodle/pluginfile.php/1/theme_custom/banner/251298630/0001.png')", true],
+            ["background-image : url( /pix/help.png);", true],
+            ["background-image: url ('/pix/help.png')", true],
+            // URLs that should not be retrieved.
+            ["background-image:url(data:image/gif;base64,R0lGODlhYADIAP=)", false],
+            ["background-image:url('data:image/gif;base64,R0lGODlhYADIAP=')", false]
+        ];
+    }
+
+    /**
+     * Tests update_inline_background_images() method to update the background images.
+     *
+     * @dataProvider test_update_inline_background_images_provider
+     * @param string $stylecontent Content of the style to test
+     * @param bool $rewrite Flag if URL should be rewritten
+     * @throws coding_exception
+     */
+    public function test_update_inline_background_images($stylecontent, $rewrite) {
+        global $CFG;
+        $this->resetAfterTest(true);
+        $generator = new maintenance_static_page_generator(new DOMDocument(), new maintenance_static_page_io());
+
+        $html = '<!DOCTYPE html>\n'.
+            '<html><head><title>Title</title></head>'.
+            '<body><div style="'.$stylecontent.'">Content</div></body></html>';
+
+        // Temporarily disable debugging to prevent errors because file does not exist
+        $debuglevel = $CFG->debug;
+        $CFG->debug = '';
+        $generated = $this->generated_page_html($html);
+        // Restore debugging level
+        $CFG->debug = $debuglevel;
+        $matches = $generator->get_url_from_inline_style($stylecontent);
+        if ($rewrite) {
+            self::assertStringNotContainsString($matches[1], $generated);
+            self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+            self::assertIsArray($matches);
+        } else {
+            self::assertStringContainsString($stylecontent, $generated);
+        }
     }
 
      /**
@@ -206,8 +260,8 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         $page->generate();
         $generated = trim(file_get_contents($page->get_io()->get_template_file()));
 
-        self::assertNotContains($link, $generated);
-        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=preview%2F', $generated);
+        self::assertStringNotContainsString($link, $generated);
+        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=preview%2F', $generated);
     }
 
     /**
@@ -243,7 +297,12 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         touch($file);
         self::assertFileExists($file);
         maintenance_static_page::create_from_outage(null)->generate();
-        self::assertFileNotExists($file);
+        // Backwards compatibility with older PHPUnit - use old assertFile method.
+        if (method_exists($this, 'assertFileDoesNotExist')) {
+            self::assertFileDoesNotExist($file);
+        } else {
+            self::assertFileNotExists($file);
+        }
     }
 
     /**
@@ -303,7 +362,7 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
      */
     public function test_get_url_for_file() {
         $io = new maintenance_static_page_io();
-        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=img.png', $io->get_url_for_file('img.png'));
+        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=img.png', $io->get_url_for_file('img.png'));
     }
 
     /**
@@ -347,8 +406,8 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         $found = maintenance_static_page_io::file_get_data(__DIR__.'/fixtures/invalidfile');
         self::assertSame('', $found['contents']);
         self::assertSame('unknown', $found['mime']);
-        self::assertCount(1, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(1, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**
@@ -370,8 +429,8 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', '.removeme', 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains('removeme', $generated);
-        self::assertNotContains('Goodbye cruel world', $generated);
+        self::assertStringNotContainsString('removeme', $generated);
+        self::assertStringNotContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -385,8 +444,8 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', '#removeme', 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains('removeme', $generated);
-        self::assertNotContains('Goodbye cruel world', $generated);
+        self::assertStringNotContainsString('removeme', $generated);
+        self::assertStringNotContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -403,9 +462,9 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', ".removeme\n.deleteme", 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains('removeme', $generated);
-        self::assertNotContains('deleteme', $generated);
-        self::assertNotContains('Goodbye cruel world', $generated);
+        self::assertStringNotContainsString('removeme', $generated);
+        self::assertStringNotContainsString('deleteme', $generated);
+        self::assertStringNotContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -422,9 +481,9 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', " .removeme     \n    .deleteme   ", 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains('removeme', $generated);
-        self::assertNotContains('deleteme', $generated);
-        self::assertNotContains('Goodbye cruel world', $generated);
+        self::assertStringNotContainsString('removeme', $generated);
+        self::assertStringNotContainsString('deleteme', $generated);
+        self::assertStringNotContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -441,9 +500,9 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', "\n\n.removeme\n\n\n\n.deleteme\n\n", 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertNotContains('removeme', $generated);
-        self::assertNotContains('deleteme', $generated);
-        self::assertNotContains('Goodbye cruel world', $generated);
+        self::assertStringNotContainsString('removeme', $generated);
+        self::assertStringNotContainsString('deleteme', $generated);
+        self::assertStringNotContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -457,8 +516,8 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', '#invalidid', 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertContains('removeme', $generated);
-        self::assertContains('Goodbye cruel world', $generated);
+        self::assertStringContainsString('removeme', $generated);
+        self::assertStringContainsString('Goodbye cruel world', $generated);
     }
 
     /**
@@ -472,7 +531,7 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         set_config('remove_selectors', '#invalidid', 'auth_outage');
         $generated = $this->generated_page_html($html);
 
-        self::assertContains('<meta http-equiv="refresh" content="300">', $generated);
+        self::assertStringContainsString('<meta http-equiv="refresh" content="300">', $generated);
     }
 
     /**
@@ -490,7 +549,7 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         $generated = trim(file_get_contents($page->get_io()->get_template_file()));
         return $generated;
 
-        self::assertContains('<meta http-equiv="refresh" content="5">', $generated);
+        self::assertStringContainsString('<meta http-equiv="refresh" content="5">', $generated);
     }
 
     /**
@@ -529,7 +588,7 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
         $generator = new maintenance_static_page_generator(new DOMDocument(), new maintenance_static_page_io());
         $matches = $generator->get_urls_from_stylesheet($filecontent);
 
-        self::assertInternalType('array', $matches);
+        self::assertIsArray($matches);
         self::assertCount(2, $matches);
         self::assertCount($count, $matches[1]);
     }

tests/phpunit/local/outage_test.php

@@ -36,7 +36,7 @@ require_once(__DIR__.'/../base_testcase.php');
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class outage_test extends auth_outage_base_testcase {
+class auth_outage_outage_test extends auth_outage_base_testcase {
     /**
      * Tests the constructor.
      */
@@ -280,11 +280,11 @@ class outage_test extends auth_outage_base_testcase {
             'description' => 'Description {{start}} {{stop}} {{duration}}',
         ]);
         $title = $outage->get_title();
-        self::assertNotContains('{', $title);
-        self::assertNotContains('}', $title);
+        self::assertStringNotContainsString('{', $title);
+        self::assertStringNotContainsString('}', $title);
         $description = $outage->get_description();
-        self::assertNotContains('{', $description);
-        self::assertNotContains('}', $description);
+        self::assertStringNotContainsString('{', $description);
+        self::assertStringNotContainsString('}', $description);
     }
 
     /**

tests/phpunit/local/outagelib_test.php

@@ -41,7 +41,7 @@ require_once(__DIR__.'/../base_testcase.php');
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class outagelib_test extends auth_outage_base_testcase {
+class auth_outage_outagelib_test extends auth_outage_base_testcase {
     /**
      * Check if maintenance message is disabled as needed.
      */
@@ -60,10 +60,14 @@ class outagelib_test extends auth_outage_base_testcase {
         ]);
 
         set_config('maintenance_message', 'A message.');
+        ob_start();
         outagedb::save($outage);
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
         self::assertFalse((bool)get_config('moodle', 'maintenance_message'));
-        self::assertCount(2, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(2, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**
@@ -94,19 +98,23 @@ class outagelib_test extends auth_outage_base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         $outage->id = outagedb::save($outage);
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
 
         outagelib::reset_injectcalled();
         // Get full header to avoid interactions with other single inject plugins.
         $header1 = $OUTPUT->standard_top_of_body_html();
-        self::assertContains('<style>', $header1);
-        self::assertContains('<script>', $header1);
+        self::assertStringContainsString('<style>', $header1);
+        self::assertStringContainsString('<script>', $header1);
 
         // Should not inject more than once.
         $size = strlen($OUTPUT->standard_top_of_body_html());
         self::assertSame($size, strlen($OUTPUT->standard_top_of_body_html()));
         // Check styles aren't reinjected.
-        self::assertNotContains('<style>', $OUTPUT->standard_top_of_body_html());
+        self::assertStringNotContainsString('<style>', $OUTPUT->standard_top_of_body_html());
     }
 
     /**
@@ -116,8 +124,8 @@ class outagelib_test extends auth_outage_base_testcase {
         $_GET = ['auth_outage_break_code' => '1'];
         outagelib::reset_injectcalled();
         $header = outagelib::get_inject_code();
-        self::assertCount(2, phpunit_util::get_debugging_messages());
-        phpunit_util::reset_debugging();
+        self::assertCount(2, $this->getDebuggingMessages());
+        $this->resetDebugging();
     }
 
     /**
@@ -136,14 +144,18 @@ class outagelib_test extends auth_outage_base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         $outage->id = outagedb::save($outage);
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
 
         $_GET = ['auth_outage_preview' => (string)$outage->id];
 
         outagelib::reset_injectcalled();
         $header = outagelib::get_inject_code();
-        self::assertContains('<style>', $header);
-        self::assertContains('<script>', $header);
+        self::assertStringContainsString('<style>', $header);
+        self::assertStringContainsString('<script>', $header);
     }
 
     /**
@@ -175,8 +187,11 @@ class outagelib_test extends auth_outage_base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         $outage->id = outagedb::save($outage);
-
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
         $_GET = ['auth_outage_preview' => (string)$outage->id, 'auth_outage_delta' => '500'];
         outagelib::reset_injectcalled();
         $header = outagelib::get_inject_code();
@@ -216,6 +231,10 @@ class outagelib_test extends auth_outage_base_testcase {
         foreach ($keys as $k) {
             self::assertSame($config->$k, $k.'_value', 'auth_outage');
         }
+
+        set_config('allowedips_forced', 'allowedips_forced_value', 'auth_outage');
+        $config = outagelib::get_config();
+        self::assertSame($config->allowedips, "allowedips_value\nallowedips_forced_value", 'auth_outage');
     }
 
     /**
@@ -278,7 +297,11 @@ class outagelib_test extends auth_outage_base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         $outage->id = outagedb::save($outage);
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
 
         // Pretend we are there...
         $_SERVER['SCRIPT_FILENAME'] = '/var/www/alternativepath/admin/settings.php'; // Issue #88 regression test.
@@ -336,8 +359,11 @@ EOT;
 
     /**
      * Test create maintenance php code without age
+     *
+     * @param string $configkey The key of the config.
+     * @dataProvider test_createmaintenancephpcode_withoutage_provider
      */
-    public function test_createmaintenancephpcode_withoutage() {
+    public function test_createmaintenancephpcode_withoutage($configkey) {
         global $CFG;
         $this->resetAfterTest(true);
 
@@ -380,7 +406,7 @@ EOT;
             'stoptime' => 456,
         ]);
         $file = $CFG->dataroot.'/climaintenance.php';
-        set_config('allowedips', '127.0.0.1', 'auth_outage');
+        set_config($configkey, '127.0.0.1', 'auth_outage');
 
         outagelib::update_climaintenance_code($outage);
         self::assertFileExists($file);
@@ -388,6 +414,10 @@ EOT;
         self::assertSame($found, $expected);
     }
 
+    public function test_createmaintenancephpcode_withoutage_provider(): array {
+        return [['allowedips'], ['allowedips_forced']];
+    }
+
     /**
      * Test create maintenance php code without IPs
      */
@@ -401,10 +431,16 @@ EOT;
         ]);
         $file = $CFG->dataroot.'/climaintenance.php';
         set_config('allowedips', '', 'auth_outage');
+        set_config('allowedips_forced', '', 'auth_outage');
 
         touch($file);
         outagelib::update_climaintenance_code($outage);
-        self::assertFileNotExists($file);
+        // Backwards compatibility with older PHPUnit - use old assertFile method.
+        if (method_exists($this, 'assertFileDoesNotExist')) {
+            self::assertFileDoesNotExist($file);
+        } else {
+            self::assertFileNotExists($file);
+        }
     }
 
     /**
@@ -416,7 +452,12 @@ EOT;
 
         touch($file);
         outagelib::update_climaintenance_code(null);
-        self::assertFileNotExists($file);
+        // Backwards compatibility with older PHPUnit - use old assertFile method.
+        if (method_exists($this, 'assertFileDoesNotExist')) {
+            self::assertFileDoesNotExist($file);
+        } else {
+            self::assertFileNotExists($file);
+        }
     }
 
     /**
@@ -443,9 +484,7 @@ EOT;
         $this->create_outage();
 
         // Change settings.
-        admin_write_settings((object)[
-            's_auth_outage_allowedips' => '127',
-        ]);
+        set_config('s_auth_outage_allowedips', '127', 'auth_outage');
 
         // The method outagelib::prepare_next_outage() should have been called from admin_write_settings().
         foreach ([$CFG->dataroot.'/climaintenance.template.html', $CFG->dataroot.'/climaintenance.php'] as $file) {
@@ -463,9 +502,7 @@ EOT;
         $this->create_outage();
 
         // Change settings.
-        admin_write_settings((object)[
-            's_auth_outage_remove_selectors' => '.something',
-        ]);
+        set_config('s_auth_outage_remove_selectors', '.something', 'auth_outage');
 
         // The method outagelib::prepare_next_outage() should have been called from admin_write_settings().
         foreach ([$CFG->dataroot.'/climaintenance.template.html', $CFG->dataroot.'/climaintenance.php'] as $file) {
@@ -496,7 +533,12 @@ EOT;
         // The method outagelib::prepare_next_outage() should have been called by save().
         self::assertFalse(get_config('moodle', 'maintenance_later'));
         // This file should not exist even if the statement above fails as Moodle does not create it immediately but test anyway.
-        self::assertFileNotExists($CFG->dataroot.'/climaintenance.html');
+        // Backwards compatibility with older PHPUnit - use old assertFile method.
+        if (method_exists($this, 'assertFileDoesNotExist')) {
+            self::assertFileDoesNotExist($CFG->dataroot.'/climaintenance.html');
+        } else {
+            self::assertFileNotExists($CFG->dataroot.'/climaintenance.html');
+        }
     }
 
     /**
@@ -516,8 +558,11 @@ EOT;
             'title' => 'Title',
             'description' => 'Description',
         ]);
+        ob_start();
         $outage->id = outagedb::save($outage);
-
+        $text = trim(ob_get_contents());
+        ob_end_clean();
+        self::assertStringContainsString('Update maintenance mode configuration', $text);
         // Pretend we are there...
         $_SERVER['SCRIPT_FILENAME'] = '/var/www/alternativepath/admin/settings.php'; // Issue #88 regression test.
         $_SERVER['SCRIPT_NAME'] = '/admin/settings.php';

version.php

@@ -28,8 +28,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = "auth_outage";
-$plugin->version = 2021032503;                  // The current plugin version (Date: YYYYMMDDXX).
-$plugin->release = 2021032503;                  // Human-readable release information.
-$plugin->requires = 2017051500;                 // Requires 3.3 and higher.
+$plugin->version = 2023012700;                  // The current plugin version (Date: YYYYMMDDXX).
+$plugin->release = 2023012700;                  // Human-readable release information.
+$plugin->requires = 2017111309;                 // 2017111309 = T13, but this really requires 3.9 and higher.
 $plugin->maturity = MATURITY_STABLE;            // Suitable for PRODUCTION environments!
-$plugin->supported = [33, 38];                  // A range of branch numbers of supported moodle versions.
+$plugin->supported = [39, 401];                 // A range of branch numbers of supported moodle versions.

views/warningbar/warningbar.css

@@ -12,12 +12,21 @@ If you need to make changes here, remember to update your settings inside Moodle
     padding: 0;
     position: fixed;
     text-align: center;
+    display: flex;
+    justify-content: center;
+    align-items: center;
     top: 0;
     transition: background 3s ease-out;
     width: 100%;
     z-index: 9999;
 }
 
+#auth_outage_warningbar_box .auth_outage_warningbar_center {
+    /* fix to prevent existing theme hacks to fix issue */
+    margin-top: 0;
+    position: static;
+}
+
 #auth_outage_warningbar_box.auth_outage_warning_period {
     background:
         repeating-linear-gradient(
@@ -66,16 +75,10 @@ If you need to make changes here, remember to update your settings inside Moodle
     background-color: #090;
 }
 
-.auth_outage_warningbar_center {
-    margin-top: -35px;
-    position: relative;
-    top: 50%;
-}
-
 #auth_outage_warningbar_message {
     font-size: 200%;
     font-weight: bold;
-    margin: 10px 0;
+    margin: 0;
 }
 
 a.auth_outage_warningbar_box_title {
@@ -87,6 +90,7 @@ a.auth_outage_warningbar_box_finish {
     border: 1px solid black;
     border-radius: 5px;
     color: darkgray;
+    white-space: nowrap;
     font-weight: bold;
     margin-left: 10px;
     padding-left: 5px;
@@ -126,3 +130,9 @@ body.auth_outage .layout.fullscreen {
 body.auth_outage .modal-dialog {
     margin: calc(150px + 1.75rem) auto;
 }
+
+@media (max-width: 767px) {
+    #auth_outage_warningbar_message {
+        font-size: 120%;
+    }
+}

views/warningbar/warningbar.js

@@ -56,6 +56,8 @@ var authOutageWarningBar = {
     },
 
     tickOngoing: function() {
+        const MINSECS = 60;
+
         if (this.finished) {
             return;
         }
@@ -78,13 +80,8 @@ var authOutageWarningBar = {
         xmlhttp.open("GET", this.checkfinishedurl, true);
         xmlhttp.send();
 
-        var estimatedServerTime = this.servertime + (Date.now() - this.clienttime);
-        var sleepSeconds = this.stops - estimatedServerTime; // How long to sleep until it stops.
-        if (sleepSeconds <= 0) {
-            sleepSeconds = 5; // It should be back, keep checking every 5 seconds.
-        } else {
-            sleepSeconds = Math.min(sleepSeconds, (5 * 60)); // Check at least every 5 minutes.
-        }
+        // Checking if the site is back online every 4-6 minutes.
+        var sleepSeconds = 4 * MINSECS + (2 * MINSECS * Math.random());
 
         setTimeout(function() {
             $this.tickOngoing();