Include filelib.php to fix class not found exception

disable pg test for now, but we should think about adding it back.

.github/workflows/ci.yml

@@ -1,10 +1,126 @@
-# .github/workflows/ci.yml
-name: ci
+name: Moodle plugin CI for master
 
+# Controls when the action will run.
 on: [push, pull_request]
 
 jobs:
-  ci:
-    uses: catalyst/catalyst-moodle-workflows/.github/workflows/ci.yml@main
-    with:
-      disable_behat: true
+  citest:
+    name: CI test
+    runs-on: 'ubuntu-latest'
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: 'postgres'
+          POSTGRES_HOST_AUTH_METHOD: 'trust'
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+        ports:
+          - 5432:5432
+
+      mariadb:
+        image: mariadb
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+    strategy:
+      fail-fast: false
+      matrix:
+        database: ['mariadb']
+        moodle-branch: ['MOODLE_35_STABLE']
+        node: ['14.15.1']
+        php: ['7.1']
+        include:
+          - {moodle-branch: 'MOODLE_38_STABLE', php: '7.1', node: '14.15.1', database: 'mariadb'}
+          - {moodle-branch: 'MOODLE_38_STABLE', php: '7.4', node: '14.15.1', database: 'pgsql'}
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+          path: plugin
+
+      - name: Install node  ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: pgsql, zip, gd, xmlrpc, soap
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+          # Add dirs to $PATH
+          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
+          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
+          # PHPUnit depends on en_AU.UTF-8 locale
+          sudo locale-gen en_AU.UTF-8
+      - name: Install Moodle
+        run: |
+          mkdir ~/.npm-global
+          export PATH=~/.npm-global/bin:$PATH
+          source ~/.profile
+          moodle-plugin-ci install -vvv --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+
+      - name: Run phplint
+        if: ${{ always() }}
+        run: moodle-plugin-ci phplint
+
+      - name: Run phpcpd
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpcpd || true
+
+      - name: Run phpmd
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpmd
+
+      - name: Run codechecker
+        if: ${{ always() }}
+        run: moodle-plugin-ci codechecker
+
+      - name: Run validate
+        if: ${{ always() }}
+        run: moodle-plugin-ci validate
+
+      - name: Run savepoints
+        if: ${{ always() }}
+        run: moodle-plugin-ci savepoints
+
+      - name: Run mustache
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpcpd
+
+      - name: Run grunt
+        if: ${{ always() }}
+        run: moodle-plugin-ci grunt
+
+      - name: Run phpdoc
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpdoc
+
+      - name: Run phpunit
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpunit
+
+#      - name: Run behat
+#        if: ${{ always() }}
+#        run: moodle-plugin-ci behat --profile chrome

.github/workflows/moodle-release.yml

@@ -1,21 +0,0 @@
-#
-# 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,9 +59,6 @@ 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,6 @@
-![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/catalyst/moodle-auth_outage/ci.yml?branch=MOODLE_39_STABLE)
+<a href="https://travis-ci.org/catalyst/moodle-auth_outage">
+<img src="https://travis-ci.org/catalyst/moodle-auth_outage.svg?branch=master">
+</a>
 
 # Moodle Outage manager plugin
 * [Version Support](#version-support)
@@ -24,7 +26,10 @@ 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.
 
-![image](https://user-images.githubusercontent.com/187449/149717343-1d2c5237-dbc6-4d2a-a08c-2bdb343e87d2.png)
+<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">
+
 
 Moodle Requirements
 -------------------
@@ -37,12 +42,14 @@ need to manually add one extra plugin, please check:
 
 Branches
 --------
-| 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+ |
+| 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+ |
 
 Screenshots
 -----------
@@ -100,48 +107,6 @@ 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
 ----------

auth.php

@@ -65,13 +65,4 @@ class auth_plugin_outage extends auth_plugin_base {
     public function user_login($username, $password) {
         return false;
     }
-
-    /**
-     * Returns true if the plugin supports the new login flow for MFA.
-     *
-     * @return bool True
-     */
-    public static function supports_mfa(): bool {
-        return true;
-    }
 }

bootstrap.php

@@ -29,16 +29,18 @@
  * @var stdClass $CFG
  */
 
-define('MOODLE_INTERNAL', true);
-defined('MOODLE_INTERNAL') || die();  // Make sniffer happy.
-//
+// This call is required by Moodle, but this script should have been called by config.php anyway.
+// @codingStandardsIgnoreStart
+require_once(__DIR__.'/../../config.php');
+// @codingStandardsIgnoreEnd
+
 // We need the CFG->dataroot, if not set yet this script is called too early in config.php file.
 if (!isset($CFG->dataroot)) {
     return;
 }
 
 // 1) Make sure we replace the configurations for behat as we have not ran 'lib/setup.php' yet.
-if (!empty($CFG->behat_wwwroot) || !empty($CFG->behat_dataroot) || !empty($CFG->behat_prefix)) {
+if (!empty($CFG->behat_wwwroot) or !empty($CFG->behat_dataroot) or !empty($CFG->behat_prefix)) {
     require_once(__DIR__.'/../../lib/behat/lib.php');
     behat_update_vars_for_process();
     if (behat_is_test_site()) {

classes/dml/outagedb.php

@@ -211,20 +211,21 @@ class outagedb {
             throw new coding_exception('$time must be null or a positive int.', $time);
         }
 
-        // Get cached outage, or null.
-        $outageinfo = get_config('moodle', 'auth_outage_active_outage');
+        $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
+        );
 
-        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;
+        // 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));
     }
 
     /**

classes/event/outage_created.php

@@ -28,6 +28,8 @@ namespace auth_outage\event;
 use core\event\base;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * outage_created class.
  *

classes/event/outage_deleted.php

@@ -27,6 +27,8 @@ namespace auth_outage\event;
 use core\event\base;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * outage_deleted class.
  *

classes/event/outage_updated.php

@@ -28,6 +28,8 @@ namespace auth_outage\event;
 use core\event\base;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * outage_updated class.
  *

classes/form/outage/edit.php

@@ -147,7 +147,7 @@ class edit extends moodleform {
      * @throws coding_exception
      */
     public function set_data($outage) {
-        global $OUTPUT, $CFG;
+        global $OUTPUT;
         $mform = $this->_form;
 
         // Cannot change method signature, check type.
@@ -162,15 +162,6 @@ 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/cli_exception.php

@@ -27,6 +27,8 @@ namespace auth_outage\local\cli;
 
 use Exception;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * cli_exception class.
  *

classes/local/cli/clibase.php

@@ -29,6 +29,8 @@ use auth_outage\local\outagelib;
 use coding_exception;
 use core\session\manager;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * clibase class.
  *
@@ -122,7 +124,7 @@ abstract class clibase {
      */
     protected function become_admin_user() {
         global $DB;
-        $user = get_admin();
+        $user = $DB->get_record('user', ['id' => 2]);
         unset($user->description);
         unset($user->access);
         unset($user->preference);

classes/local/cli/create.php

@@ -29,6 +29,8 @@ use auth_outage\dml\outagedb;
 use auth_outage\local\outage;
 use coding_exception;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * create class.
  *

classes/local/cli/finish.php

@@ -28,6 +28,8 @@ namespace auth_outage\local\cli;
 use auth_outage\dml\outagedb;
 use auth_outage\local\outage;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * finish class.
  *

classes/local/cli/waitforit.php

@@ -28,6 +28,8 @@ namespace auth_outage\local\cli;
 use auth_outage\dml\outagedb;
 use auth_outage\local\outage;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * waitforit class.
  *
@@ -129,7 +131,7 @@ class waitforit extends clibase {
             return;
         }
 
-        $time = date('Y-m-d H:i:s T', time());
+        $time = strftime('%F %T %Z');
         printf("[%s] %s\n", $time, $message);
     }
 

classes/local/controllers/infopage.php

@@ -32,6 +32,8 @@ use coding_exception;
 use context_system;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * infopage class.
  *
@@ -46,11 +48,6 @@ 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).
@@ -65,13 +62,11 @@ 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);
         }
@@ -106,10 +101,6 @@ 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());
@@ -152,6 +143,5 @@ class infopage {
         }
 
         $this->outage = $params['outage'];
-        $this->static = $params['static'];
     }
 }

classes/local/controllers/maintenance_static_page.php

@@ -29,6 +29,8 @@ use auth_outage\local\outage;
 use coding_exception;
 use DOMDocument;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * maintenance_static_page class.
  *
@@ -59,7 +61,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&static=1&id='.$outage->id);
+                $CFG->wwwroot.'/auth/outage/info.php?auth_outage_hide_warning=1&id='.$outage->id);
             $html = $data['contents'];
         }
 

classes/local/controllers/maintenance_static_page_generator.php

@@ -27,12 +27,13 @@ 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;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * maintenance_static_page_generator class.
  *
@@ -42,15 +43,6 @@ 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;
 
@@ -83,10 +75,6 @@ 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();
@@ -95,7 +83,6 @@ 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) == '') {
@@ -163,18 +150,6 @@ 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.
      *
@@ -243,31 +218,6 @@ 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/controllers/maintenance_static_page_io.php

@@ -31,6 +31,8 @@ use finfo;
 use invalid_parameter_exception;
 use moodle_url;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * maintenance_static_page_io class.
  *

classes/local/outage.php

@@ -28,6 +28,8 @@ namespace auth_outage\local;
 use coding_exception;
 use stdClass;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * outage class.
  *
@@ -297,12 +299,4 @@ 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,12 +168,7 @@ class outagelib {
             }
         }
 
-        $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;
+        return (object)array_merge(self::get_config_defaults(), $config);
     }
 
     /**
@@ -210,10 +205,6 @@ 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)) {
@@ -246,7 +237,6 @@ class outagelib {
                 unset_config('maintenance_message');
             }
             set_config('maintenance_later', $outage->starttime);
-            self::maintenance_config_log($outage);
         }
     }
 
@@ -415,18 +405,4 @@ 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'));
-    }
 }

classes/output/renderer.php

@@ -33,6 +33,8 @@ use html_writer;
 use moodle_url;
 use plugin_renderer_base;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * auth_outage_renderer class.
  *

classes/privacy/provider.php

@@ -23,6 +23,10 @@
 
 namespace auth_outage\privacy;
 
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\local\legacy_polyfill;
+
 /**
  * Privacy provider for the authentication manual.
  *
@@ -32,6 +36,8 @@ namespace auth_outage\privacy;
 class provider implements
     \core_privacy\local\metadata\null_provider {
 
+    use legacy_polyfill;
+
     /**
      * Get the language string identifier with the component's language
      * file to explain why this plugin stores no data.
@@ -41,7 +47,7 @@ class provider implements
      *
      * @return  string
      */
-    public static function get_reason() : string {
+    public static function _get_reason() {
         return 'privacy:no_data_reason';
     }
 

classes/task/update_static_page.php

@@ -29,6 +29,8 @@ use auth_outage\local\controllers\infopage;
 use auth_outage\local\outagelib;
 use core\task\scheduled_task;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * update_static_page class.
  *

db/access.php

@@ -1,37 +0,0 @@
-<?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,
-        )
-    ),
-];

db/uninstall.php

@@ -24,6 +24,8 @@
  */
 use auth_outage\local\controllers\maintenance_static_page;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Auth Outage plugin uninstall code.
  * @return bool result

db/upgrade.php

@@ -22,6 +22,7 @@
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+defined('MOODLE_INTERNAL') || die();
 
 /**
  * Outage plugin upgrade code

lang/en/auth_outage.php

@@ -26,8 +26,6 @@
 $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.';
@@ -102,13 +100,10 @@ $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!';
@@ -117,7 +112,6 @@ $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';

lib.php

@@ -25,6 +25,8 @@
 
 use auth_outage\local\outagelib;
 
+defined('MOODLE_INTERNAL') || die;
+
 /**
  * Used for adminlib::set_updatedcallback which requires a string that resolves to a function.
  *
@@ -84,4 +86,4 @@ function auth_outage_get_fontawesome_icon_map() {
 function auth_outage_before_standard_top_of_body_html() {
     // Get code to inject.
     return outagelib::get_inject_code();
-}
+}

renderer.php

@@ -26,6 +26,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * auth_outage_renderer class.
  *

settings.php

@@ -26,30 +26,25 @@
  * @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) {
+if ($hassiteconfig && is_enabled_auth('outage')) {
     $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') . $description
-    ));
-
+        get_string('settingssectiondefaultsdescription', 'auth_outage')));
     $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'),
@@ -101,23 +96,20 @@ if ($hassiteconfig) {
 
     // 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 {
-        if (remoteip_in_list($allowedips)) {
-            $message = 'allowedipshasmyip';
-            $type = 'notifysuccess';
-        } else {
-            $message = 'allowedipshasntmyip';
-            $type = 'notifyerror';
-        }
+        $message = 'allowedipshasntmyip';
+        $type = 'notifyerror';
     };
-    $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 .= $OUTPUT->notification(get_string($message, 'auth_outage', ['ip' => getremoteaddr()]), $type);
 
+    $description .= '<p>'.get_string('ipblockersyntax', 'admin').'</p>';
     $iplist = new admin_setting_configiplist(
         'auth_outage/allowedips',
         get_string('allowediplist', 'admin'),
@@ -127,14 +119,6 @@ if ($hassiteconfig) {
     $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',
@@ -156,7 +140,7 @@ if ($hassiteconfig) {
         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/local/controllers/fixtures/withurls-quoted.css

@@ -1,7 +0,0 @@
-a {
-    font-size: 200%;
-}
-
-div {
-    background-image: url('/moodle/auth/outage/tests/local/controllers/fixtures/catalyst.png');
-}

tests/local/controllers/fixtures/withurls.css

@@ -1,7 +0,0 @@
-a {
-    font-size: 200%;
-}
-
-div {
-    background-image: url(/moodle/auth/outage/tests/local/controllers/fixtures/catalyst.png);
-}

tests/local/controllers/infopage_test.php

@@ -1,168 +0,0 @@
-<?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/>.
-
-/**
- * Tests performed on infopage controller class and update_static_page task class.
- *
- * @package    auth_outage
- * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
- * @copyright  2016 Catalyst IT
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace auth_outage\local\controllers;
-
-use auth_outage\local\outage;
-use context_system;
-
-defined('MOODLE_INTERNAL') || die();
-require_once(__DIR__.'/../../base_testcase.php');
-
-/**
- * Tests performed on infopage controller class and update_static_page task class.
- *
- * @package    auth_outage
- * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
- * @copyright  2016 Catalyst IT
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\local\controllers\infopage
- */
-class infopage_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();
-    }
-
-    /**
-     * 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();
-    }
-
-    /**
-     * Tests the constructor with different id and outage id.
-     */
-    public function test_constructor_idmismatch() {
-        $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]);
-    }
-
-    /**
-     * Tests the constructor with an invalid outage.
-     */
-    public function test_constructor_invalidoutage() {
-        $this->assertTrue(has_capability('auth/outage:viewinfo', context_system::instance()));
-
-        $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() {
-        $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::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);
-    }
-
-    /**
-     * Tests the constructor enables SVG support.
-     */
-    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/base_testcase.php

@@ -31,20 +31,19 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage;
-
 use auth_outage\dml\outagedb;
-use auth_outage\local\outage;
+
+defined('MOODLE_INTERNAL') || die();
 
 /**
- * base_testcase class.
+ * auth_outage_base_testcase class.
  *
  * @package    auth_outage
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-abstract class base_testcase extends \advanced_testcase {
+abstract class auth_outage_base_testcase extends advanced_testcase {
     /**
      * Checks PHPUnit version and calls the functions accordingly.
      * @param string $exception Expected exception class.
@@ -66,37 +65,6 @@ abstract class 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

@@ -23,10 +23,11 @@
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\calendar;
-
+use auth_outage\calendar\calendar;
 use auth_outage\local\outage;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * calendar_test test class.
  *
@@ -37,9 +38,8 @@ use auth_outage\local\outage;
  * @author          Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright       Catalyst IT
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers          \auth_outage\calendar\calendar
  */
-class calendar_test extends \advanced_testcase {
+class calendar_test extends advanced_testcase {
     /**
      * @var outage|null The calendar entry owner.
      */
@@ -134,8 +134,8 @@ class calendar_test extends \advanced_testcase {
         ]);
 
         calendar::update($outage);
-        self::assertCount(1, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**
@@ -146,8 +146,8 @@ class calendar_test extends \advanced_testcase {
         self::setAdminUser();
 
         calendar::delete(1);
-        self::assertCount(1, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**

tests/phpunit/dml/outagedb_test.php

@@ -23,8 +23,7 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\dml;
-
+use auth_outage\dml\outagedb;
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
@@ -37,9 +36,8 @@ require_once(__DIR__.'/../base_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\dml\outagedb
  */
-class outagedb_test extends \auth_outage\base_testcase {
+class 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.
@@ -246,15 +244,6 @@ 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.');
@@ -438,8 +427,8 @@ class outagedb_test extends \auth_outage\base_testcase {
     public function test_finish_now_notfound() {
         $this->resetAfterTest(true);
         outagedb::finish(1);
-        self::assertCount(1, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**
@@ -460,8 +449,8 @@ class outagedb_test extends \auth_outage\base_testcase {
         self::assertTrue(!$outage->is_ongoing($time));
 
         outagedb::finish($id, $time);
-        self::assertCount(1, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**

tests/phpunit/event/events_test.php

@@ -23,10 +23,11 @@
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\dml;
-
+use auth_outage\dml\outagedb;
 use auth_outage\local\outage;
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * events_test tests class.
  *
@@ -37,9 +38,8 @@ use auth_outage\local\outage;
  * @author          Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright       Catalyst IT
  * @license         http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers          \auth_outage\dml\outagedb
  */
-class events_test extends \advanced_testcase {
+class events_test extends advanced_testcase {
     /**
      * @var outage|null Outage used in the tests.
      */

tests/phpunit/form/forms_test.php

@@ -23,12 +23,13 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\form\outage;
-
+use auth_outage\form\outage\delete;
+use auth_outage\form\outage\edit;
+use auth_outage\form\outage\finish;
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
-require_once(__DIR__.'/../../base_testcase.php');
+require_once(__DIR__.'/../base_testcase.php');
 
 /**
  * forms_test test class.
@@ -37,9 +38,8 @@ require_once(__DIR__.'/../../base_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers      \auth_outage\form\outage\edit
  */
-class forms_test extends \auth_outage\base_testcase {
+class 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, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**

tests/phpunit/installation_test.php

@@ -25,12 +25,10 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\dml;
-
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
-require_once(__DIR__.'/../base_testcase.php');
+require_once(__DIR__.'/base_testcase.php');
 
 /**
  * installation_test test class.
@@ -41,9 +39,8 @@ require_once(__DIR__.'/../base_testcase.php');
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\dml\outagedb
  */
-class installation_test extends \auth_outage\base_testcase {
+class installation_test extends auth_outage_base_testcase {
     /**
      * Checks if plugin cleans up data after uninstall.
      *
@@ -66,19 +63,15 @@ class installation_test extends \auth_outage\base_testcase {
             'title' => 'Title',
             'description' => 'Description',
         ]);
-        ob_start();
-        outagedb::save($outage);
-        $text = trim(ob_get_contents());
-        ob_end_clean();
-        self::assertStringContainsString('Update maintenance mode configuration', $text);
+        \auth_outage\dml\outagedb::save($outage);
         self::assertSame(1, $DB->count_records_select('event', "eventtype = 'auth_outage'", null));
 
         // Uninstall plugin.
         require_once($CFG->libdir.'/adminlib.php');
-        $progress = new \progress_trace_buffer(new \text_progress_trace(), false);
-        \core_plugin_manager::instance()->uninstall_plugin('auth_outage', $progress);
+        $progress = new progress_trace_buffer(new text_progress_trace(), false);
+        core_plugin_manager::instance()->uninstall_plugin('auth_outage', $progress);
         $progress->finished();
-        self::assertStringContainsString('++ Success ++', $progress->get_buffer());
+        self::assertContains('++ Success ++', $progress->get_buffer());
 
         // Check ...
         self::assertSame(0, $DB->count_records_select('event', "eventtype = 'auth_outage'", null),

tests/phpunit/lib_test.php

@@ -23,11 +23,9 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage;
-
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__.'/base_testcase.php');
-require_once(__DIR__.'/../lib.php');
+require_once(__DIR__.'/../../lib.php');
 
 /**
  * tests for lib.php
@@ -36,9 +34,8 @@ require_once(__DIR__.'/../lib.php');
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2017 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     ::auth_outage_get_climaintenance_resource_file
  */
-class lib_test extends base_testcase {
+class lib_test extends auth_outage_base_testcase {
     /**
      * Test this plugin gets climaintenance resource file.
      */

tests/phpunit/local/cli/cli_test.php

@@ -23,7 +23,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\cli;
+use auth_outage\local\cli\cli_exception;
+use auth_outage\local\cli\create;
 
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__.'/cli_testcase.php');
@@ -35,9 +36,8 @@ require_once(__DIR__.'/cli_testcase.php');
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers      \auth_outage\local\cli\create
  */
-class cli_test extends cli_testcase {
+class cli_test extends auth_outage_cli_testcase {
     /**
      * Tests providing an unknown parameter.
      */
@@ -81,8 +81,8 @@ class cli_test extends cli_testcase {
         $this->set_parameters(['-h']);
         $cli = new create();
         $output = $this->execute($cli);
-        self::assertStringContainsString('-h', $output);
-        self::assertStringContainsString('--help', $output);
+        self::assertContains('-h', $output);
+        self::assertContains('--help', $output);
     }
 
     /**
@@ -100,7 +100,7 @@ class cli_test extends cli_testcase {
         // Disable all auth plugins.
         set_config('auth', '');
         \core\session\manager::gc(); // Remove stale sessions.
-        \core_plugin_manager::reset_caches();
+        core_plugin_manager::reset_caches();
         // Try to create an CLI object.
         $this->set_expected_cli_exception(cli_exception::ERROR_PLUGIN_CONFIGURATION);
         new create();

tests/phpunit/local/cli/cli_testcase.php

@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * cli_testcase class.
+ * auth_outage_cli_testcase class.
  *
  * @package    auth_outage
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
@@ -23,20 +23,20 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\cli;
+use auth_outage\local\cli\clibase;
 
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__.'/../../base_testcase.php');
 
 /**
- * cli_testcase class.
+ * auth_outage_cli_testcase class.
  *
  * @package    auth_outage
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-abstract class cli_testcase extends \auth_outage\base_testcase {
+abstract class auth_outage_cli_testcase extends auth_outage_base_testcase {
     /**
      * Always enable the auth outage plugin, resets after test and set no parameters.
      */
@@ -49,7 +49,7 @@ abstract class cli_testcase extends \auth_outage\base_testcase {
         // Enable auth plugins.
         set_config('auth', 'outage');
         \core\session\manager::gc(); // Remove stale sessions.
-        \core_plugin_manager::reset_caches();
+        core_plugin_manager::reset_caches();
 
         $this->set_parameters([]);
         parent::setUp();

tests/phpunit/local/cli/create_test.php

@@ -23,9 +23,9 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\cli;
-
 use auth_outage\dml\outagedb;
+use auth_outage\local\cli\cli_exception;
+use auth_outage\local\cli\create;
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
@@ -38,9 +38,8 @@ require_once(__DIR__.'/cli_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers      \auth_outage\local\cli\create
  */
-class create_test extends cli_testcase {
+class create_test extends auth_outage_cli_testcase {
     /**
      * Tests without any arguments.
      */
@@ -121,8 +120,8 @@ class create_test extends cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new create();
         $output = $this->execute($cli);
-        self::assertStringContainsString('Creates', $output);
-        self::assertStringContainsString('--help', $output);
+        self::assertContains('Creates', $output);
+        self::assertContains('--help', $output);
     }
 
     /**
@@ -158,10 +157,10 @@ class create_test extends cli_testcase {
         $cli = new create();
         $cli->set_referencetime($now);
         $text = $this->execute($cli);
-        self::assertStringContainsString('created', $text);
+        self::assertContains('created', $text);
         // Check creted outage.
-        $clioutput = explode(':', $text);
-        $id = (int)end($clioutput);
+        list(, $id) = explode(':', $text);
+        $id = (int)$id;
         $outage = outagedb::get_by_id($id);
         self::assertSame($now, $outage->starttime);
         self::assertSame(10, $outage->get_warning_duration());
@@ -222,10 +221,10 @@ class create_test extends cli_testcase {
             'description' => 'Default Description',
         ]);
         $text = $this->execute($cli);
-        self::assertStringContainsString('created', $text);
+        self::assertContains('created', $text);
         // Check creted outage.
-        $clioutput = explode(':', $text);
-        $id = (int)end($clioutput);
+        list(, $id) = explode(':', $text);
+        $id = (int)$id;
         $outage = outagedb::get_by_id($id);
         self::assertSame($now + 50, $outage->starttime, 'Wrong starttime.');
         self::assertSame($outage->starttime - 100, $outage->warntime, 'Wrong warntime.');
@@ -300,8 +299,8 @@ class create_test extends cli_testcase {
         $cli = new create();
         $cli->set_referencetime($now);
         $text = $this->execute($cli);
-        self::assertStringContainsString('created', $text);
-        self::assertStringContainsString('started', $text);
+        self::assertContains('created', $text);
+        self::assertContains('started', $text);
     }
 
     /**

tests/phpunit/local/cli/finish_test.php

@@ -23,9 +23,9 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\cli;
-
 use auth_outage\dml\outagedb;
+use auth_outage\local\cli\cli_exception;
+use auth_outage\local\cli\finish;
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
@@ -38,9 +38,8 @@ require_once(__DIR__.'/cli_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers      \auth_outage\local\cli\finish
  */
-class finish_test extends cli_testcase {
+class finish_test extends auth_outage_cli_testcase {
     /**
      * Tests the constructor.
      */
@@ -73,8 +72,8 @@ class finish_test extends cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new finish();
         $text = $this->execute($cli);
-        self::assertStringContainsString('Finishes', $text);
-        self::assertStringContainsString('--help', $text);
+        self::assertContains('Finishes', $text);
+        self::assertContains('--help', $text);
     }
 
     /**

tests/phpunit/local/cli/waitforit_test.php

@@ -23,9 +23,9 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\cli;
-
 use auth_outage\dml\outagedb;
+use auth_outage\local\cli\cli_exception;
+use auth_outage\local\cli\waitforit;
 use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
@@ -38,9 +38,8 @@ require_once(__DIR__.'/cli_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers      \auth_outage\local\cli\waitforit
  */
-class waitforit_test extends cli_testcase {
+class waitforit_test extends auth_outage_cli_testcase {
     /**
      * Tests the constructor.
      */
@@ -79,8 +78,8 @@ class waitforit_test extends cli_testcase {
         $this->set_parameters(['--help']);
         $cli = new waitforit();
         $text = $this->execute($cli);
-        self::assertStringContainsString('Waits', $text);
-        self::assertStringContainsString('--help', $text);
+        self::assertContains('Waits', $text);
+        self::assertContains('--help', $text);
     }
 
     /**
@@ -152,9 +151,9 @@ class waitforit_test extends cli_testcase {
         $cli = new waitforit();
         $cli->set_referencetime($now);
         $output = $this->execute($cli);
-        self::assertStringContainsString('Verbose mode', $output);
-        self::assertStringContainsString('starting in 1 sec', $output);
-        self::assertStringContainsString('started', $output);
+        self::assertContains('Verbose mode', $output);
+        self::assertContains('starting in 1 sec', $output);
+        self::assertContains('started', $output);
     }
 
     /**
@@ -179,11 +178,11 @@ class waitforit_test extends cli_testcase {
             return $now;
         });
         $output = $this->execute($cli);
-        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);
+        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);
     }
 
     /**

tests/phpunit/local/controllers/fixtures/withurls-quoted.css

@@ -0,0 +1,7 @@
+a {
+    font-size: 200%;
+}
+
+div {
+    background-image: url('/moodle/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png');
+}

tests/phpunit/local/controllers/fixtures/withurls.css

@@ -0,0 +1,7 @@
+a {
+    font-size: 200%;
+}
+
+div {
+    background-image: url(/moodle/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png);
+}

tests/phpunit/local/controllers/infopage_test.php

@@ -0,0 +1,118 @@
+<?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/>.
+
+/**
+ * Tests performed on infopage controller class and update_static_page task class.
+ *
+ * @package    auth_outage
+ * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
+ * @copyright  2016 Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+use auth_outage\local\controllers\infopage;
+use auth_outage\local\outage;
+
+defined('MOODLE_INTERNAL') || die();
+require_once(__DIR__.'/../../base_testcase.php');
+
+/**
+ * Tests performed on infopage controller class and update_static_page task class.
+ *
+ * @package    auth_outage
+ * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
+ * @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 {
+    /**
+     * Tests the constructor.
+     */
+    public function test_constructor() {
+        new infopage();
+    }
+
+    /**
+     * Tests the constructor with given parameters.
+     */
+    public function test_constructor_withparams() {
+        $_GET = ['id' => 1, 'static' => 'true'];
+        new infopage();
+    }
+
+    /**
+     * 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');
+        new infopage(['id' => 2, 'outage' => $outage]);
+    }
+
+    /**
+     * Tests the constructor with an invalid outage.
+     */
+    public function test_constructor_invalidoutage() {
+        $this->set_expected_exception('coding_exception');
+        new infopage(['outage' => 'My outage']);
+    }
+
+    /**
+     * 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();
+    }
+
+    /**
+     * 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',
+        ]);
+        $info = new infopage(['outage' => $outage]);
+        $output = $info->get_output();
+        self::assertContains('auth_outage_info', $output);
+    }
+
+    /**
+     * Tests the constructor enables SVG support.
+     */
+    public function test_svgicons_is_true() {
+        global $CFG;
+        $CFG->svgicons = false;
+        new infopage();
+        self::assertTrue($CFG->svgicons);
+    }
+}

tests/phpunit/local/controllers/maintenance_static_page_test.php

@@ -23,10 +23,10 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local\controllers;
-
+use auth_outage\local\controllers\maintenance_static_page;
+use auth_outage\local\controllers\maintenance_static_page_io;
+use auth_outage\local\controllers\maintenance_static_page_generator;
 use auth_outage\task\update_static_page;
-use DOMDocument;
 
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__.'/../../base_testcase.php');
@@ -38,9 +38,8 @@ require_once(__DIR__.'/../../base_testcase.php');
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\local\controllers\maintenance_static_page_generator
  */
-class maintenance_static_page_test extends \auth_outage\base_testcase {
+class maintenance_static_page_test extends auth_outage_base_testcase {
     /**
      * Test template file.
      */
@@ -91,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::assertStringNotContainsString('<script', $generated);
+        self::assertNotContains('<script', $generated);
     }
 
     /**
@@ -105,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::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
-        self::assertStringNotContainsString($localcsslink, $generated);
-        self::assertStringContainsString($externalcsslink, $generated);
+        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+        self::assertNotContains($localcsslink, $generated);
+        self::assertContains($externalcsslink, $generated);
     }
 
     /**
@@ -122,7 +121,7 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
         $page->generate();
 
         // Check for css file.
-        self::assertFileExists($page->get_io()->get_resources_folder().'/53365950336b070c0b26ca50e7d0dad962c364e6.dGV4dC9wbGFpbg');
+        self::assertFileExists($page->get_io()->get_resources_folder().'/d8643101d96b093e642b15544e4d1f7815b5ba55.dGV4dC9wbGFpbg');
 
         // Check for catalyst.png file referenced in url(..) of css.
         self::assertFileExists($page->get_io()->get_resources_folder().'/ff7f7f87a26a908fc72930eaefb6b57306361d16.aW1hZ2UvcG5n');
@@ -140,7 +139,7 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
         $page->generate();
 
         // Check for css file.
-        self::assertFileExists($page->get_io()->get_resources_folder().'/e0b34925c1f939c247a4b50d6bf08c76088def39.dGV4dC9wbGFpbg');
+        self::assertFileExists($page->get_io()->get_resources_folder().'/9fe2374b03953e1949d54ab750be2d8706891c03.dGV4dC9wbGFpbg');
 
         // Check for catalyst.png file referenced in url(..) of css.
         self::assertFileExists($page->get_io()->get_resources_folder().'/ff7f7f87a26a908fc72930eaefb6b57306361d16.aW1hZ2UvcG5n');
@@ -175,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::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=', $generated);
-        self::assertStringNotContainsString($localimglink, $generated);
-        self::assertStringContainsString($externalimglink, $generated);
+        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
+        self::assertNotContains($localimglink, $generated);
+        self::assertContains($externalimglink, $generated);
     }
 
      /**
@@ -190,62 +189,8 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
                 '<body>Content</body></html>';
         $generated = $this->generated_page_html($html);
 
-        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);
-        }
+        self::assertNotContains($link, $generated);
+        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=', $generated);
     }
 
      /**
@@ -261,8 +206,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::assertStringNotContainsString($link, $generated);
-        self::assertStringContainsString('www.example.com/moodle/auth/outage/file.php?file=preview%2F', $generated);
+        self::assertNotContains($link, $generated);
+        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=preview%2F', $generated);
     }
 
     /**
@@ -298,12 +243,7 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
         touch($file);
         self::assertFileExists($file);
         maintenance_static_page::create_from_outage(null)->generate();
-        // Backwards compatibility with older PHPUnit - use old assertFile method.
-        if (method_exists($this, 'assertFileDoesNotExist')) {
-            self::assertFileDoesNotExist($file);
-        } else {
-            self::assertFileNotExists($file);
-        }
+        self::assertFileNotExists($file);
     }
 
     /**
@@ -325,7 +265,7 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
 
         // We can still assert the contents really match, not just the hash.
         $found = file_get_contents($file);
-        $expected = file_get_contents(__DIR__.'/fixtures/catalyst.png');
+        $expected = file_get_contents($CFG->dirroot.'/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png');
         self::assertSame($found, $expected);
     }
 
@@ -337,7 +277,7 @@ class maintenance_static_page_test extends \auth_outage\base_testcase {
      * @return string
      */
     private function get_fixture_path($file) {
-        return (string)new \moodle_url('/auth/outage/tests/local/controllers/fixtures/'.$file);
+        return (string)new moodle_url('/auth/outage/tests/phpunit/local/controllers/fixtures/'.$file);
     }
 
     /**
@@ -363,10 +303,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::assertStringContainsString(
-            'www.example.com/moodle/auth/outage/file.php?file=img.png',
-            $io->get_url_for_file('img.png')
-        );
+        self::assertContains('www.example.com/moodle/auth/outage/file.php?file=img.png', $io->get_url_for_file('img.png'));
     }
 
     /**
@@ -410,8 +347,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, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(1, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**
@@ -433,8 +370,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::assertStringNotContainsString('removeme', $generated);
-        self::assertStringNotContainsString('Goodbye cruel world', $generated);
+        self::assertNotContains('removeme', $generated);
+        self::assertNotContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -448,8 +385,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::assertStringNotContainsString('removeme', $generated);
-        self::assertStringNotContainsString('Goodbye cruel world', $generated);
+        self::assertNotContains('removeme', $generated);
+        self::assertNotContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -466,9 +403,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::assertStringNotContainsString('removeme', $generated);
-        self::assertStringNotContainsString('deleteme', $generated);
-        self::assertStringNotContainsString('Goodbye cruel world', $generated);
+        self::assertNotContains('removeme', $generated);
+        self::assertNotContains('deleteme', $generated);
+        self::assertNotContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -485,9 +422,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::assertStringNotContainsString('removeme', $generated);
-        self::assertStringNotContainsString('deleteme', $generated);
-        self::assertStringNotContainsString('Goodbye cruel world', $generated);
+        self::assertNotContains('removeme', $generated);
+        self::assertNotContains('deleteme', $generated);
+        self::assertNotContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -504,9 +441,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::assertStringNotContainsString('removeme', $generated);
-        self::assertStringNotContainsString('deleteme', $generated);
-        self::assertStringNotContainsString('Goodbye cruel world', $generated);
+        self::assertNotContains('removeme', $generated);
+        self::assertNotContains('deleteme', $generated);
+        self::assertNotContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -520,8 +457,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::assertStringContainsString('removeme', $generated);
-        self::assertStringContainsString('Goodbye cruel world', $generated);
+        self::assertContains('removeme', $generated);
+        self::assertContains('Goodbye cruel world', $generated);
     }
 
     /**
@@ -535,7 +472,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::assertStringContainsString('<meta http-equiv="refresh" content="300">', $generated);
+        self::assertContains('<meta http-equiv="refresh" content="300">', $generated);
     }
 
     /**
@@ -553,7 +490,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::assertStringContainsString('<meta http-equiv="refresh" content="5">', $generated);
+        self::assertContains('<meta http-equiv="refresh" content="5">', $generated);
     }
 
     /**
@@ -592,7 +529,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::assertIsArray($matches);
+        self::assertInternalType('array', $matches);
         self::assertCount(2, $matches);
         self::assertCount($count, $matches[1]);
     }

tests/phpunit/local/outage_test.php

@@ -23,7 +23,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local;
+use auth_outage\local\outage;
 
 defined('MOODLE_INTERNAL') || die();
 require_once(__DIR__.'/../base_testcase.php');
@@ -35,9 +35,8 @@ require_once(__DIR__.'/../base_testcase.php');
  * @author     Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright  2016 Catalyst IT
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\local\outage
  */
-class outage_test extends \auth_outage\base_testcase {
+class outage_test extends auth_outage_base_testcase {
     /**
      * Tests the constructor.
      */
@@ -55,7 +54,7 @@ class outage_test extends \auth_outage\base_testcase {
      * Tests the constructor, giving data as an object.
      */
     public function test_constructor_object() {
-        $obj = new \stdClass();
+        $obj = new stdClass();
         $obj->id = 1;
         $obj->autostart = true;
         $obj->warntime = 2;
@@ -281,11 +280,11 @@ class outage_test extends \auth_outage\base_testcase {
             'description' => 'Description {{start}} {{stop}} {{duration}}',
         ]);
         $title = $outage->get_title();
-        self::assertStringNotContainsString('{', $title);
-        self::assertStringNotContainsString('}', $title);
+        self::assertNotContains('{', $title);
+        self::assertNotContains('}', $title);
         $description = $outage->get_description();
-        self::assertStringNotContainsString('{', $description);
-        self::assertStringNotContainsString('}', $description);
+        self::assertNotContains('{', $description);
+        self::assertNotContains('}', $description);
     }
 
     /**

tests/phpunit/local/outagelib_test.php

@@ -23,11 +23,12 @@
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-namespace auth_outage\local;
-
 use auth_outage\dml\outagedb;
+use auth_outage\local\outage;
+use auth_outage\local\outagelib;
 
 defined('MOODLE_INTERNAL') || die();
+
 global $CFG;
 require_once($CFG->libdir.'/adminlib.php');
 require_once(__DIR__.'/../base_testcase.php');
@@ -39,9 +40,8 @@ require_once(__DIR__.'/../base_testcase.php');
  * @author      Daniel Thee Roperto <daniel.roperto@catalyst-au.net>
  * @copyright   2016 Catalyst IT
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @covers     \auth_outage\local\outagelib
  */
-class outagelib_test extends \auth_outage\base_testcase {
+class outagelib_test extends auth_outage_base_testcase {
     /**
      * Check if maintenance message is disabled as needed.
      */
@@ -60,14 +60,10 @@ 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, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(2, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**
@@ -98,23 +94,19 @@ 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::assertStringContainsString('<style>', $header1);
-        self::assertStringContainsString('<script>', $header1);
+        self::assertContains('<style>', $header1);
+        self::assertContains('<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::assertStringNotContainsString('<style>', $OUTPUT->standard_top_of_body_html());
+        self::assertNotContains('<style>', $OUTPUT->standard_top_of_body_html());
     }
 
     /**
@@ -124,8 +116,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, $this->getDebuggingMessages());
-        $this->resetDebugging();
+        self::assertCount(2, phpunit_util::get_debugging_messages());
+        phpunit_util::reset_debugging();
     }
 
     /**
@@ -144,18 +136,14 @@ 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::assertStringContainsString('<style>', $header);
-        self::assertStringContainsString('<script>', $header);
+        self::assertContains('<style>', $header);
+        self::assertContains('<script>', $header);
     }
 
     /**
@@ -187,11 +175,8 @@ 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();
@@ -231,10 +216,6 @@ 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');
     }
 
     /**
@@ -297,11 +278,7 @@ 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.
@@ -359,11 +336,8 @@ 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($configkey) {
+    public function test_createmaintenancephpcode_withoutage() {
         global $CFG;
         $this->resetAfterTest(true);
 
@@ -406,7 +380,7 @@ EOT;
             'stoptime' => 456,
         ]);
         $file = $CFG->dataroot.'/climaintenance.php';
-        set_config($configkey, '127.0.0.1', 'auth_outage');
+        set_config('allowedips', '127.0.0.1', 'auth_outage');
 
         outagelib::update_climaintenance_code($outage);
         self::assertFileExists($file);
@@ -414,10 +388,6 @@ EOT;
         self::assertSame($found, $expected);
     }
 
-    public function test_createmaintenancephpcode_withoutage_provider(): array {
-        return [['allowedips'], ['allowedips_forced']];
-    }
-
     /**
      * Test create maintenance php code without IPs
      */
@@ -431,16 +401,10 @@ EOT;
         ]);
         $file = $CFG->dataroot.'/climaintenance.php';
         set_config('allowedips', '', 'auth_outage');
-        set_config('allowedips_forced', '', 'auth_outage');
 
         touch($file);
         outagelib::update_climaintenance_code($outage);
-        // Backwards compatibility with older PHPUnit - use old assertFile method.
-        if (method_exists($this, 'assertFileDoesNotExist')) {
-            self::assertFileDoesNotExist($file);
-        } else {
-            self::assertFileNotExists($file);
-        }
+        self::assertFileNotExists($file);
     }
 
     /**
@@ -452,12 +416,7 @@ EOT;
 
         touch($file);
         outagelib::update_climaintenance_code(null);
-        // Backwards compatibility with older PHPUnit - use old assertFile method.
-        if (method_exists($this, 'assertFileDoesNotExist')) {
-            self::assertFileDoesNotExist($file);
-        } else {
-            self::assertFileNotExists($file);
-        }
+        self::assertFileNotExists($file);
     }
 
     /**
@@ -484,7 +443,9 @@ EOT;
         $this->create_outage();
 
         // Change settings.
-        set_config('s_auth_outage_allowedips', '127', 'auth_outage');
+        admin_write_settings((object)[
+            's_auth_outage_allowedips' => '127',
+        ]);
 
         // 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) {
@@ -502,7 +463,9 @@ EOT;
         $this->create_outage();
 
         // Change settings.
-        set_config('s_auth_outage_remove_selectors', '.something', 'auth_outage');
+        admin_write_settings((object)[
+            's_auth_outage_remove_selectors' => '.something',
+        ]);
 
         // 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) {
@@ -533,12 +496,7 @@ 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.
-        // 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');
-        }
+        self::assertFileNotExists($CFG->dataroot.'/climaintenance.html');
     }
 
     /**
@@ -558,11 +516,8 @@ 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';
@@ -594,6 +549,6 @@ EOT;
         // Enable outage plugin so settings can be changed.
         set_config('auth', 'outage');
         \core\session\manager::gc(); // Remove stale sessions.
-        \core_plugin_manager::reset_caches();
+        core_plugin_manager::reset_caches();
     }
 }

version.php

@@ -28,8 +28,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = "auth_outage";
-$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->version = 2021032500;                  // The current plugin version (Date: YYYYMMDDXX).
+$plugin->release = 2021032500;                  // Human-readable release information.
+$plugin->requires = 2017051500;                 // Requires 3.3 and higher.
 $plugin->maturity = MATURITY_STABLE;            // Suitable for PRODUCTION environments!
-$plugin->supported = [39, 401];                 // A range of branch numbers of supported moodle versions.

views/warningbar/warningbar.css

@@ -12,21 +12,12 @@ 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(
@@ -75,10 +66,16 @@ 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: 0;
+    margin: 10px 0;
 }
 
 a.auth_outage_warningbar_box_title {
@@ -90,7 +87,6 @@ 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;
@@ -130,9 +126,3 @@ 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,8 +56,6 @@ var authOutageWarningBar = {
     },
 
     tickOngoing: function() {
-        const MINSECS = 60;
-
         if (this.finished) {
             return;
         }
@@ -80,8 +78,13 @@ var authOutageWarningBar = {
         xmlhttp.open("GET", this.checkfinishedurl, true);
         xmlhttp.send();
 
-        // Checking if the site is back online every 4-6 minutes.
-        var sleepSeconds = 4 * MINSECS + (2 * MINSECS * Math.random());
+        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.
+        }
 
         setTimeout(function() {
             $this.tickOngoing();