Merge branch 'master' into admin-message

Issue #207: Use Moodle curl to honor proxy settings

.travis.yml

@@ -2,13 +2,15 @@ language: php
 
 sudo: true
 
+services:
+  - mysql
+
 addons:
   firefox: "47.0.1"
-  postgresql: "9.4"
+  postgresql: "9.6"
   apt:
     packages:
-    - oracle-java8-installer
-    - oracle-java8-set-default
+    - openjdk-8-jre
 
 cache:
   directories:
@@ -16,29 +18,39 @@ cache:
   - $HOME/.npm
 
 php:
- - 7.0
+ - 7.2
 
 env:
-  - DB=pgsql MOODLE_BRANCH=MOODLE_33_STABLE
-  - DB=pgsql MOODLE_BRANCH=MOODLE_34_STABLE
-  - DB=pgsql MOODLE_BRANCH=MOODLE_35_STABLE
-  - DB=pgsql MOODLE_BRANCH=master
-  - DB=mysqli MOODLE_BRANCH=master
+  - DB=pgsql  MOODLE_BRANCH=MOODLE_36_STABLE NODEJS=8
+  - DB=mysqli MOODLE_BRANCH=MOODLE_36_STABLE NODEJS=8
+  - DB=pgsql  MOODLE_BRANCH=MOODLE_37_STABLE
+  - DB=pgsql  MOODLE_BRANCH=MOODLE_38_STABLE
+  - DB=pgsql  MOODLE_BRANCH=MOODLE_39_STABLE
+  - DB=mysqli MOODLE_BRANCH=MOODLE_39_STABLE
 
 matrix:
   include:
     - php: 5.6
-      env: DB=pgsql MOODLE_BRANCH=MOODLE_33_STABLE
-    - php: 5.6
-      env: DB=mysqli MOODLE_BRANCH=MOODLE_33_STABLE
+      env: DB=pgsql  MOODLE_BRANCH=MOODLE_33_STABLE NODEJS=8
+    - php: 7.0
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_35_STABLE
     - php: 7.1
+      env: DB=mysqli MOODLE_BRANCH=MOODLE_33_STABLE NODEJS=8
+    - php: 7.4
+      env: DB=mysqli MOODLE_BRANCH=master
+    - php: 7.4
       env: DB=pgsql MOODLE_BRANCH=master
 
-
 before_install:
+  - export MOODLE_VERSION=$(echo "$MOODLE_BRANCH" | cut -d'_' -f 2)
   - phpenv config-rm xdebug.ini
-  - nvm install 8.9
-  - nvm use 8.9
+  - if [ "$NODEJS" = 8 ]; then
+      nvm install 8.9;
+      nvm use 8.9;
+    else
+      nvm install 14.0.0;
+      nvm use 14.0.0;
+    fi
   - cd ../..
   - composer selfupdate
   - composer create-project -n --no-dev --prefer-dist blackboard-open-source/moodle-plugin-ci ci ^2
@@ -57,4 +69,7 @@ script:
  - moodle-plugin-ci mustache
  - moodle-plugin-ci grunt
  - moodle-plugin-ci phpunit
- - moodle-plugin-ci behat
+# Behat tests are failing due to issue:
+# https://github.com/blackboard-open-source/moodle-plugin-ci/issues/70
+# Commenting it out until the issue is fixed.
+# - moodle-plugin-ci behat

README.md

@@ -8,16 +8,12 @@
 * [Moodle Requirements](#moodle-requirements)
 * [Screenshots](#screenshots)
 * [Installation](#installation)
+* [Theme configuration](#theme-configuration)
 * [How to use](#how-to-use)
 * [Quick Guide](#quick-guide)
 * [Why is it an auth plugin?](#why-it-is-an-auth-plugin)
 * [Feedback and issues](#feedback-and-issues)
 
-Version Support
--------------
-The master branch supports Moodle 3.3 and higher.
-The MOODLE_32_STABLE branch supports Moodle 2.7 -> Moodle 3.2
-
 What is this?
 -------------
 
@@ -44,6 +40,14 @@ If you have an older version of Moodle you can still make it work but you will
 need to manually add one extra plugin, please check:
 * https://github.com/catalyst/moodle-local_outage
 
+Branches
+--------
+| Moodle version     | Branch      | PHP  |
+| ----------------- | ----------- | ---- |
+| Moodle 2.7 to 3.2 | MOODLE_32_STABLE | 5.5+ |
+| Totara up to 10 | TOTARA_10 | 5.5+ |
+| Moodle 3.3+ | master | 7.0+ |
+| Totara 11+ | master | 7.0+ |
 
 Screenshots
 -----------
@@ -88,6 +92,20 @@ if (file_exists(__DIR__.'/auth/outage/bootstrap.php')) {
 }
 ```
 
+Theme configuration
+-------------------
+
+This plugin must work gracefully with your theme, but every theme can be different so it's impossible to get this right out of the box (other than with the default moodle theme Boost).
+
+There is an admin setting which allows you to add or override and css to fix css issues. Typically these include properly pushing the page down when the outage notification bar is visible, including making this work with fixed headers and when the hamburger menu is open / closed and at different responsive breakpoints.
+
+This can be found at:
+
+`Dashboard / Site administration / Plugins / Authentication / Outage manager / Settings`
+
+
+
+
 How to use
 ----------
 
@@ -104,7 +122,7 @@ Creates a new outage.
   -c,  --clone              clone another outage except for the start time.
   -a,  --autostart          must be Y or N, sets if the outage automatically triggers maintenance mode.
   -w,  --warn               how many seconds before it starts to display a warning.
-  -s,  --start              in how many seconds should this outage start. Required.
+  -s,  --start              in how many seconds should this outage start or unix time to start outage. Required.
   -d,  --duration           how many seconds should the outage last.
   -t,  --title              the title of the outage.
   -e,  --description        the description of the outage.

bootstrap.php

@@ -67,9 +67,19 @@ if (is_callable('auth_outage_bootstrap_callback')) {
 }
 
 // 3) Check for allowed scripts or IPs during outages.
+if (!empty($_SERVER['REQUEST_URI'])) {
+    $rooturl = parse_url($CFG->wwwroot);
+    $path = '';
+    if (array_key_exists('path', $rooturl) && !empty($rooturl['path'])) {
+        $path = $rooturl['url'];
+    }
+    $url = $path.'/auth/outage/info.php';
+    $outageinfo = strpos($_SERVER['REQUEST_URI'], $url) === 0 ? true : false;
+}
 $allowed = !file_exists($CFG->dataroot.'/climaintenance.php') // Not in maintenance mode.
            || (defined('ABORT_AFTER_CONFIG') && ABORT_AFTER_CONFIG) // Only config requested.
-           || (defined('CLI_SCRIPT') && CLI_SCRIPT); // Allow CLI scripts.
+           || (defined('CLI_SCRIPT') && CLI_SCRIPT) // Allow CLI scripts.
+           || $outageinfo; // Allow outage info requests.
 if (!$allowed) {
     // Call the climaintenance.php which will check for allowed IPs.
     $CFG->dirroot = dirname(dirname(dirname(__FILE__))); // It is not defined yet but the script below needs it.

classes/calendar/calendar.php

@@ -65,7 +65,7 @@ class calendar {
             debugging('Cannot update calendar entry for outage #'.$outage->id.', event not found. Creating it...');
             self::create($outage);
         } else {
-            $event->update(self::create_data($outage));
+            $event->update(self::create_data($outage), false);
         }
     }
 

classes/dml/outagedb.php

@@ -96,6 +96,79 @@ class outagedb {
         return new outage($outage);
     }
 
+    /**
+     * Also sends all admins the event as a message
+     *
+     * @param $outage
+     * @param $event
+     */
+    private static function notify($outage, $event) {
+
+        $admins = get_admins();
+
+        foreach ($admins as $admin) {
+            self::notify_user($outage, $event, $admin);
+        }
+
+    }
+
+    /**
+     * Send outage info to one user
+     *
+     * @param $outage outage
+     * @param $event event
+     * @param $to user object
+     */
+    private static function notify_user($outage, $event, $to) {
+
+        global $SITE, $CFG;
+
+        $from = \core_user::get_user($event->userid);
+        $fields = [
+            'site_shortname'    => $SITE->shortname,
+            'site_fullname'     => $SITE->fullname,
+            'site_wwwroot'      => $CFG->wwwroot,
+
+            'outage_id'         => $outage->id,
+            'outage_title'      => $outage->get_title(),
+            'outage_desc'       => $outage->get_description(),
+            'outage_start'      => userdate($outage->starttime, get_string('datetimeformat', 'auth_outage')),
+            'outage_stop'       => userdate($outage->stoptime, get_string('datetimeformat', 'auth_outage')),
+            'outage_duration'   => format_time($outage->get_duration_planned()),
+
+            'event_name'        => $event->get_name(),
+            'event_desc'        => $event->get_description(),
+            'event_link'        => $event->get_url()->out(),
+
+            'from_name'         => fullname($from),
+            'to_name'           => fullname($to),
+            'prefs_link'        => (new \moodle_url('/message/notificationpreferences.php'))->out(),
+
+        ];
+
+        $message = new \core\message\message();
+        $message->component = 'auth_outage';
+        $message->name = 'updatenotify';
+        $message->userto = $to;
+        $message->subject         = get_string('messagesubject', 'auth_outage', $fields);
+        $message->fullmessage     = get_string('messagetext',    'auth_outage', $fields);
+        $message->fullmessagehtml = get_string('messagehtml',    'auth_outage', $fields);
+        $message->fullmessageformat = FORMAT_HTML;
+
+        $threadid = generate_email_messageid('outage' . $outage->id);
+        $message->userfrom = $from;
+        $message->userfrom->customheaders = [
+            "In-Reply-To: $threadid",
+            "References: $threadid",
+            "Thread-Topic: " . $message->subject,
+            "Thread-Index: $threadid",
+        ];
+
+        $message->notification = '1';
+        $messageid = message_send($message);
+
+    }
+
     /**
      * Saves an outage to the database.
      *
@@ -117,25 +190,42 @@ class outagedb {
             $outage->createdby = $USER->id;
             // Then create it, log it and adjust its id.
             $outage->id = $DB->insert_record('auth_outage', $outage, true);
-            outage_created::create(
-                ['objectid' => $outage->id, 'other' => (array)$outage]
-            )->trigger();
+
+            $other = (array) $outage;
+            $other['title'] = $outage->get_title();
+            $event = outage_created::create([
+                'objectid' => $outage->id,
+                'other' => $other,
+            ]);
+            $event->add_record_snapshot('auth_outage', (object)(array) $outage);
+            $event->trigger();
+            self::notify($outage, $event);
+
             // Create calendar entry.
             calendar::create($outage);
         } else {
+
+            $other = (array) $outage;
+            $other['title'] = $outage->get_title();
+            $event = outage_updated::create([
+                'objectid' => $outage->id,
+                'other' => $other,
+            ]);
+
+            $event->add_record_snapshot('auth_outage', (object)(array) $outage);
+            $event->trigger();
+            self::notify($outage, $event);
+
             // Remove the createdby field so it does not get updated.
             unset($outage->createdby);
             $DB->update_record('auth_outage', $outage);
-            // Log it.
-            outage_updated::create(
-                ['objectid' => $outage->id, 'other' => (array)$outage]
-            )->trigger();
+
             // Update calendar entry.
             calendar::update($outage);
         }
 
         // Trigger outages modified events.
-        outagelib::prepare_next_outage();
+        outagelib::prepare_next_outage(true);
 
         // All done, return the id.
         return $outage->id;
@@ -156,9 +246,19 @@ class outagedb {
 
         // Log it.
         $previous = $DB->get_record('auth_outage', ['id' => $id], '*', MUST_EXIST);
-        $event = outage_deleted::create(['objectid' => $id, 'other' => (array)$previous]);
+
+        $outage = new outage($previous);
+
+        $other = (array) $outage;
+        $other['title'] = $outage->get_title();
+        $event = outage_deleted::create([
+            'objectid' => $id,
+            'other' => $other,
+        ]);
+
         $event->add_record_snapshot('auth_outage', $previous);
         $event->trigger();
+        self::notify($outage, $event);
 
         // Delete it and remove from calendar.
         $DB->delete_records('auth_outage', ['id' => $id]);

classes/event/outage_created.php

@@ -39,14 +39,23 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class outage_created extends base {
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventoutagecreated', 'auth_outage');
+    }
+
     /**
      * Returns non-localised event description with id's for admin use only.
      *
      * @return string
      */
     public function get_description() {
-        return "The user with the id '{$this->userid}' created a new outage title '{$this->other['title']}' ".
-               " with id '{$this->other['id']}'.";
+        return "The user with the id '{$this->userid}' scheduled outage {$this->other['id']} '{$this->other['title']}'";
     }
 
     /**
@@ -54,7 +63,7 @@ class outage_created extends base {
      * @return moodle_url
      */
     public function get_url() {
-        return new moodle_url('/auth/outage/list.php#auth_outage_id_'.$this->other['id']);
+        return new moodle_url('/auth/outage/edit.php', ['edit' => $this->other['id']]);
     }
 
     /**

classes/event/outage_deleted.php

@@ -38,14 +38,23 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class outage_deleted extends base {
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventoutagedeleted', 'auth_outage');
+    }
+
     /**
      * Returns non-localised event description with id's for admin use only.
      *
      * @return string
      */
     public function get_description() {
-        return "The user with the id '{$this->userid}' deleted the outage titled '{$this->other['title']}' ".
-               "with id '{$this->other['id']}'.";
+        return "The user with the id '{$this->userid}' deleted outage {$this->other['id']} '{$this->other['title']}'";
     }
 
     /**
@@ -53,7 +62,7 @@ class outage_deleted extends base {
      * @return moodle_url
      */
     public function get_url() {
-        return new moodle_url('/auth/outage/list.php#auth_outage_id_'.$this->other['id']);
+        return new moodle_url('/auth/outage/manage.php');
     }
 
     /**

classes/event/outage_updated.php

@@ -39,14 +39,23 @@ defined('MOODLE_INTERNAL') || die();
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class outage_updated extends base {
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name() {
+        return get_string('eventoutageupdated', 'auth_outage');
+    }
+
     /**
      * Returns non-localised event description with id's for admin use only.
      *
      * @return string
      */
     public function get_description() {
-        return "The user with the id '{$this->userid}' updated the outage title '{$this->other['title']}' ".
-               "with id '{$this->other['id']}'.";
+        return "The user with the id '{$this->userid}' updated outage {$this->other['id']} '{$this->other['title']}'";
     }
 
     /**
@@ -54,7 +63,7 @@ class outage_updated extends base {
      * @return moodle_url
      */
     public function get_url() {
-        return new moodle_url('/auth/outage/list.php');
+        return new moodle_url('/auth/outage/edit.php', ['edit' => $this->other['id']]);
     }
 
     /**

classes/form/outage/edit.php

@@ -82,6 +82,7 @@ class edit extends moodleform {
         $mform->addHelpButton('description', 'description', 'auth_outage');
 
         $mform->addElement('static', 'usagehints', '', get_string('textplaceholdershint', 'auth_outage'));
+        $mform->addElement('static', 'warningreenablemaintenancemode', '');
 
         $this->add_action_buttons();
     }
@@ -146,6 +147,9 @@ class edit extends moodleform {
      * @throws coding_exception
      */
     public function set_data($outage) {
+        global $OUTPUT;
+        $mform = $this->_form;
+
         // Cannot change method signature, check type.
         if ($outage instanceof outage) {
             $this->_form->setDefaults([
@@ -157,6 +161,12 @@ class edit extends moodleform {
                 'title' => $outage->title,
                 'description' => ['text' => $outage->description, 'format' => '1'],
             ]);
+
+            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'),
+                    'notifywarning'));
+            }
         } else {
             throw new coding_exception('$outage must be an outage object.', $outage);
         }

classes/local/cli/clibase.php

@@ -147,5 +147,6 @@ abstract class clibase {
             $long = '--'.$long;
             printf("  %-4s %-20s %s\n", $short, $long, $text);
         }
+        printf("\n%s\n\n", get_string('cli'.$cliname.'examples', 'auth_outage'));
     }
 }

classes/local/cli/create.php

@@ -170,7 +170,9 @@ class create extends clibase {
         $this->become_admin_user();
 
         // Create the outage.
-        $start = $this->time + $options['start'];
+        // If time is above 1500000000 then it must be a unix time timestamp, otherwise they are trying to create
+        // an outage 47 years in advance.
+        $start = $options['start'] > 1500000000 ? $options['start'] : $this->time + $options['start'];
         $outage = new outage([
             'autostart' => $options['autostart'],
             'warntime' => $start - $options['warn'],
@@ -198,7 +200,7 @@ class create extends clibase {
     private function clone_defaults() {
         $id = $this->options['clone'];
         if (!is_number($id) || ($id <= 0)) {
-            throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => 'clone']),
+            throw new cli_exception(get_string('clierrorinvalidvaluenotid', 'auth_outage', ['param' => 'clone']),
                 cli_exception::ERROR_PARAMETER_INVALID);
         }
 
@@ -243,12 +245,12 @@ class create extends clibase {
      */
     private function merge_options_check_parameters_int_nonnegative($option, $param) {
         if (!is_number($option)) {
-            throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]),
+            throw new cli_exception(get_string('clierrorinvalidvaluenotnumber', 'auth_outage', ['param' => $param]),
                 cli_exception::ERROR_PARAMETER_INVALID);
         }
         $option = (int)$option;
         if ($option < 0) {
-            throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]),
+            throw new cli_exception(get_string('clierrorinvalidvaluenegativenumber', 'auth_outage', ['param' => $param]),
                 cli_exception::ERROR_PARAMETER_INVALID);
         }
         return $option;
@@ -263,12 +265,12 @@ class create extends clibase {
      */
     private function merge_options_check_parameters_string_nonempty($option, $param) {
         if (!is_string($option)) {
-            throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]),
+            throw new cli_exception(get_string('clierrorinvalidvaluenotstring', 'auth_outage', ['param' => $param]),
                 cli_exception::ERROR_PARAMETER_INVALID);
         }
         $option = trim($option);
         if (strlen($option) == 0) {
-            throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]),
+            throw new cli_exception(get_string('clierrorinvalidvalueemptystring', 'auth_outage', ['param' => $param]),
                 cli_exception::ERROR_PARAMETER_INVALID);
         }
         return $option;
@@ -296,7 +298,7 @@ class create extends clibase {
             }
         }
 
-        throw new cli_exception(get_string('clierrorinvalidvalue', 'auth_outage', ['param' => $param]),
+        throw new cli_exception(get_string('clierrorinvalidvaluenotbool', 'auth_outage', ['param' => $param]),
             cli_exception::ERROR_PARAMETER_INVALID);
     }
 }

classes/local/controllers/infopage.php

@@ -53,6 +53,11 @@ class infopage {
      * @param array $params Parameters to use or null to get from Moodle API (request).
      */
     public function __construct(array $params = null) {
+        global $CFG;
+        // Enable SVG support here to make sure all SVG files
+        // used in the current theme are served properly.
+        $CFG->svgicons = true;
+
         if (is_null($params)) {
             $params = [
                 'id' => optional_param('id', null, PARAM_INT),

classes/local/controllers/maintenance_static_page_generator.php

@@ -128,7 +128,7 @@ class maintenance_static_page_generator {
                 continue;
             }
             $saved = $this->io->save_url_file($href);
-            if (is_null($saved['url'])) {
+            if (empty($saved['url'])) {
                 $url = $href; // Skipped, use original URL.
             } else {
                 $this->update_link_stylesheet_parse($saved['file'], dirname($href));
@@ -138,6 +138,17 @@ class maintenance_static_page_generator {
         }
     }
 
+    /**
+     * Retrieves all URLs from file content using regular expressions.
+     *
+     * @param string $contents Content of the file
+     * @return array Array of all matches in multi-dimensional array
+     */
+    public function get_urls_from_stylesheet($contents) {
+        preg_match_all('#url\([\'"]?(?!data:)([^\'"\)]+)#', $contents, $matches);
+        return $matches;
+    }
+
     /**
      * Checks for urls inside filename.
      *
@@ -148,15 +159,15 @@ class maintenance_static_page_generator {
         global $CFG;
 
         $contents = file_get_contents($filename);
-        if (!preg_match_all('#url\([\'"]?([^\'"\)]+)#', $contents, $matches)) {
-            return;
-        }
+        $matches = $this->get_urls_from_stylesheet($contents);
+
         foreach ($matches[1] as $originalurl) {
             // Allow incomplete URLs in CSS, assume it is from moodle root.
             if (maintenance_static_page_io::is_url($originalurl)) {
                 $fullurl = $originalurl;
             } else if ($originalurl[0] == '/') {
-                $fullurl = $CFG->wwwroot.$originalurl;
+                $rooturl = parse_url($CFG->wwwroot);
+                $fullurl = $rooturl['scheme'].'://'.$rooturl['host'].$originalurl;
             } else {
                 $fullurl = $baseref.'/'.$originalurl;
             }

classes/local/controllers/maintenance_static_page_io.php

@@ -213,7 +213,7 @@ class maintenance_static_page_io {
     /**
      * Saves the content of the URL into a file, returning the local filename.
      * @param string $url Input URL.
-     * @return string|null Output filename or null if skipped.
+     * @return array|null Output an array with the filename and url or null if skipped.
      */
     public function save_url_file($url) {
         global $CFG;

classes/local/outage.php

@@ -281,7 +281,17 @@ class outage {
      */
     private function adjust_field_types() {
         // Adjust int fields.
-        $fs = ['createdby', 'id', 'lastmodified', 'modifiedby', 'starttime', 'stoptime', 'warntime', 'finished'];
+        $fs = [
+            'id',
+            'starttime',
+            'stoptime',
+            'warntime',
+            'finished',
+            'createdby',
+            'lastmodified',
+            'modifiedby',
+        ];
+
         foreach ($fs as $f) {
             $this->$f = ($this->$f === null) ? null : (int)$this->$f;
         }

classes/local/outagelib.php

@@ -29,6 +29,7 @@ use auth_outage\dml\outagedb;
 use auth_outage\local\controllers\maintenance_static_page;
 use auth_outage\output\renderer;
 use coding_exception;
+use curl;
 use Exception;
 use file_exception;
 use invalid_parameter_exception;
@@ -47,22 +48,25 @@ require_once(__DIR__.'/../../lib.php');
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class outagelib {
+
+    const OUTAGE_START = '<!-- OUTAGESTART -->';
+
+    const OUTAGE_END = '<!-- OUTAGEEND -->';
+
     /**
      * @var bool Flags in the injection function was already called.
      */
     private static $injectcalled = false;
 
     public static function fetch_page($file) {
-        $curl = curl_init();
-        curl_setopt($curl, CURLOPT_URL, $file);
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
-        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
-        curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 5); // It is localhost, time to connect is enough.
-        curl_setopt($curl, CURLOPT_TIMEOUT, 15); // It is localhost, time to fetch index is enough.
-        $contents = curl_exec($curl);
-        $mime = curl_getinfo($curl, CURLINFO_CONTENT_TYPE);
-        curl_close($curl);
+        $curl = new curl();
+        $contents = $curl->get($file);
+        $info = $curl->get_info();
+        if (!empty($info['content_type'])) {
+            $mime = $info['content_type'];
+        } else {
+            $mime = '';
+        }
         return compact('contents', 'mime');
     }
 
@@ -74,6 +78,26 @@ class outagelib {
         self::inject();
     }
 
+    /**
+     * Given a time, usually now, when is the next outage window?
+     */
+    public static function get_next_window($time = null) {
+
+        $config = self::get_config();
+
+        if (!$time) {
+            $time = time();
+        }
+
+        $default = $config->default_time;
+        if ($default) {
+            // First try natural language parsing.
+            $time = strtotime($default, $time);
+        }
+        return $time;
+    }
+
+
     /**
      * Will check for ongoing or warning outages and will attach the message bar as required.
      */
@@ -87,6 +111,8 @@ class outagelib {
                 return;
             }
 
+            self::clean_outages();
+
             // Check for a previewing outage, then for an active outage.
             $previewid = optional_param('auth_outage_preview', null, PARAM_INT);
             $time = time();
@@ -145,6 +171,7 @@ class outagelib {
         return [
             'allowedips'               => '',
             'css'                      => '',
+            'default_time'             => '',
             'default_autostart'        => '0',
             'default_duration'         => (string)(60 * 60),
             'default_warning_duration' => (string)(60 * 60),
@@ -156,16 +183,25 @@ class outagelib {
 
     /**
      * Executed when outages are modified (created, updated or deleted).
+     *
+     * @param bool $reenablemaint should we re-enable maintenance mode for ongoing outage
+     * @throws coding_exception
+     * @throws file_exception
      */
-    public static function prepare_next_outage() {
+    public static function prepare_next_outage($reenablemaint = false) {
         // If there is an ongoing outage, prepare it instead.
         $outage = outagedb::get_ongoing();
         if (is_null($outage)) {
             $outage = outagedb::get_next_starting();
+            $ongoingoutage = false;
+        } else {
+            $ongoingoutage = true;
         }
         maintenance_static_page::create_from_outage($outage)->generate();
         self::update_climaintenance_code($outage);
-        self::update_maintenance_later($outage);
+        if (!$ongoingoutage || $reenablemaint || is_null($outage)) {
+            self::update_maintenance_later($outage);
+        }
     }
 
     private static function check_wwwroot_accessible() {
@@ -253,6 +289,9 @@ class outagelib {
 if ((time() >= {{STARTTIME}}) && (time() < {{STOPTIME}})) {
     define('MOODLE_INTERNAL', true);
     require_once($CFG->dirroot.'/lib/moodlelib.php');
+    if (file_exists($CFG->dirroot.'/lib/classes/ip_utils.php')) {
+        require_once($CFG->dirroot.'/lib/classes/ip_utils.php');
+    }
     if (!remoteip_in_list('{{ALLOWEDIPS}}')) {
         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance');
         header('Status: 503 Moodle under maintenance');
@@ -265,6 +304,7 @@ if ((time() >= {{STARTTIME}}) && (time() < {{STOPTIME}})) {
         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
         header('Accept-Ranges: none');
+        header('X-Moodle-Maintenance: manager');
         if ((defined('AJAX_SCRIPT') && AJAX_SCRIPT) || (defined('WS_SERVER') && WS_SERVER)) {
             exit(0);
         }
@@ -356,4 +396,26 @@ EOT;
 
         return $message;
     }
+
+    /**
+     * Checks $CFG->additionalhtmltopofbody for saved outages and removes them.
+     * We should only be temporarily injecting into that variable and not saving them to the database.
+     *
+     * @return string the cleaned content
+     */
+    public static function clean_outages() {
+        global $CFG;
+
+        // Replace the content to clean up pages that do not have the injection.
+        $re = '/' . self::OUTAGE_START . '[\s\S]*' . self::OUTAGE_END . '/m';
+        $replaced = preg_replace($re, '', $CFG->additionalhtmltopofbody);
+
+        // We have removed the outages and any duplicates as it should be injected and not saved to $CFG.
+        if ($CFG->additionalhtmltopofbody != $replaced) {
+            set_config('additionalhtmltopofbody', $replaced);
+            return $replaced;
+        }
+
+        return '';
+    }
 }

classes/output/renderer.php

@@ -26,6 +26,7 @@
 namespace auth_outage\output;
 
 use auth_outage\local\outage;
+use auth_outage\local\outagelib;
 use coding_exception;
 use core_user;
 use html_writer;
@@ -196,35 +197,38 @@ class renderer extends plugin_renderer_base {
             $finished = userdate($finished, get_string('datetimeformat', 'auth_outage'));
         }
 
-        return html_writer::div(
+        $start = outagelib::OUTAGE_START;
+        $end = outagelib::OUTAGE_END;
+        $outagehtml = html_writer::div(
             html_writer::tag('blockquote',
-                html_writer::div(html_writer::tag('b', $outage->get_title(), ['data-id' => $outage->id])).
-                html_writer::div(html_writer::tag('i', $outage->get_description())).
-                html_writer::div(
-                    html_writer::tag('b', get_string('tableheaderwarnbefore', 'auth_outage').': ').
-                    format_time($outage->get_warning_duration())
-                ).
-                html_writer::div(
-                    html_writer::tag('b', get_string('tableheaderstarttime', 'auth_outage').': ').
-                    userdate($outage->starttime, get_string('datetimeformat', 'auth_outage'))
-                ).
-                html_writer::div(
-                    html_writer::tag('b', get_string('tableheaderdurationplanned', 'auth_outage').': ').
-                    format_time($outage->get_duration_planned())
-                ).
-                html_writer::div(
-                    html_writer::tag('b', get_string('tableheaderdurationactual', 'auth_outage').': ').
-                    $finished
-                ).
-                html_writer::div(
-                    html_writer::tag('small',
-                        'Created by '.$created.
-                        ', modified by '.$modified.' on '.
-                        userdate($outage->lastmodified, get_string('datetimeformat', 'auth_outage'))
-                    )
-                ).
-                ($buttons ? html_writer::div($linkedit.$linkdelete) : '')
+                             html_writer::div(html_writer::tag('b', $outage->get_title(), ['data-id' => $outage->id])).
+                             html_writer::div(html_writer::tag('i', $outage->get_description())).
+                             html_writer::div(
+                                 html_writer::tag('b', get_string('tableheaderwarnbefore', 'auth_outage').': ').
+                                 format_time($outage->get_warning_duration())
+                             ).
+                             html_writer::div(
+                                 html_writer::tag('b', get_string('tableheaderstarttime', 'auth_outage').': ').
+                                 userdate($outage->starttime, get_string('datetimeformat', 'auth_outage'))
+                             ).
+                             html_writer::div(
+                                 html_writer::tag('b', get_string('tableheaderdurationplanned', 'auth_outage').': ').
+                                 format_time($outage->get_duration_planned())
+                             ).
+                             html_writer::div(
+                                 html_writer::tag('b', get_string('tableheaderdurationactual', 'auth_outage').': ').
+                                 $finished
+                             ).
+                             html_writer::div(
+                                 html_writer::tag('small',
+                                                  'Created by '.$created.
+                                                  ', modified by '.$modified.' on '.
+                                                  userdate($outage->lastmodified, get_string('datetimeformat', 'auth_outage'))
+                                 )
+                             ).
+                             ($buttons ? html_writer::div($linkedit.$linkdelete) : '')
             )
         );
+        return $start . $outagehtml . $end;
     }
 }

db/access.php

@@ -0,0 +1,37 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Defines capabilities
+ *
+ * @package    auth_outage
+ * @copyright  2020 Brendan Heywood <brendan@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = [
+    'auth/outage:updatenotify' => [
+        'captype'       => 'write',
+        'riskbitmask'   => RISK_XSS,
+        'contextlevel'  => CONTEXT_SYSTEM,
+        'archetypes'    => [
+            'manager'   => CAP_ALLOW,
+        ]
+    ],
+];
+

db/messages.php

@@ -0,0 +1,32 @@
+<?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/>.
+
+/**
+ * Defines message providers for outage
+ *
+ * @package    auth_outage
+ * @copyright  2020 Brendan Heywood <brendan@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$messageproviders = [
+    'updatenotify' => [
+        'capability'  => 'auth/outage:updatenotify',
+    ]
+];
+

edit.php

@@ -42,11 +42,12 @@ if ($mform->is_cancelled()) {
     redirect(new moodle_url('/auth/outage/manage.php'));
 } else if ($outage = $mform->get_data()) {
     $id = outagedb::save($outage);
-    redirect($CFG->wwwroot. '/auth/outage/manage.php#auth_outage_id_'.$id);
+    redirect(new moodle_url('/auth/outage/manage.php'));
 }
 
 $clone = optional_param('clone', 0, PARAM_INT);
 $edit = optional_param('edit', 0, PARAM_INT);
+$time = optional_param('starttime', 0, PARAM_INT);
 if ($clone && $edit) {
     throw new invalid_parameter_exception('Cannot provide both clone and edit ids.');
 }
@@ -60,7 +61,10 @@ if ($clone) {
     $action = 'outageedit';
 } else {
     $config = outagelib::get_config();
-    $time = time();
+    if (empty($time)) {
+        $time = outagelib::get_next_window();
+    }
+
     $outage = new outage([
         'autostart' => $config->default_autostart,
         'starttime' => $time,

lang/en/auth_outage.php

@@ -27,6 +27,7 @@ $string['auth_outagedescription'] = 'Auxiliary plugin that warns users about a f
 $string['autostart'] = 'Auto start maintenance mode.';
 $string['autostart_help'] = 'If selected, when the outage starts it will automatically turn on Moodle maintenance mode.';
 $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.';
 $string['clicreateparamblock'] = 'blocks until outage starts.';
 $string['clicreateparamclone'] = 'clone another outage except for the start time.';
@@ -34,10 +35,11 @@ $string['clicreateparamdescription'] = 'the description of the outage.';
 $string['clicreateparamduration'] = 'how many seconds should the outage last.';
 $string['clicreateparamhelp'] = 'shows parameters help.';
 $string['clicreateparamonlyid'] = 'only outputs the new outage id, useful for scripts.';
-$string['clicreateparamstart'] = 'in how many seconds should this outage start. Required.';
+$string['clicreateparamstart'] = 'in how many seconds should this outage start or unix time to start outage. Required.';
 $string['clicreateparamtitle'] = 'the title of the outage.';
 $string['clicreateparamwarn'] = 'how many seconds before it starts to display a warning.';
 $string['clifinishhelp'] = 'Finishes an ongoing outage.';
+$string['clifinishexamples'] = '';
 $string['clifinishnotongoing'] = 'Outage is not ongoing.';
 $string['clifinishparamhelp'] = 'shows parameters help.';
 $string['clifinishparamactive'] = 'finishes the currently active outage.';
@@ -45,6 +47,7 @@ $string['clifinishparamoutageid'] = 'the id of the outage to finish.';
 $string['cliinmaintenancemode'] = 'Moodle maintenance mode is on. Use "php admin/cli/maintenance.php --disable" to disable it before finishing the outage.';
 $string['cliwaitforiterroridxoractive'] = 'You must use --outageid=# or --active parameter but not both.';
 $string['cliwaitforithelp'] = 'Waits until an outage starts.';
+$string['cliwaitforitexamples'] = '';
 $string['cliwaitforitoutagestarted'] = 'Outage started!';
 $string['cliwaitforitoutagestartingin'] = 'Outage starting in {$a->countdown}.';
 $string['cliwaitforitparamactive'] = 'wait for the currently active outage.';
@@ -53,6 +56,12 @@ $string['cliwaitforitparamoutageid'] = 'the id of the outage to wait until it st
 $string['cliwaitforitparamsleep'] = 'maximum amount of seconds before status output.';
 $string['cliwaitforitparamverbose'] = 'enable verbose mode.';
 $string['clierrorinvalidvalue'] = 'Invalid value for parameter: {$a->param}';
+$string['clierrorinvalidvaluenotid'] = 'Param --{$a->param} must be an id number';
+$string['clierrorinvalidvaluenotbool'] = 'Param --{$a->param} must be set to either Y or N';
+$string['clierrorinvalidvaluenotnumber'] = 'Param --{$a->param} must be a number';
+$string['clierrorinvalidvaluenegativenumber'] = 'Param --{$a->param} must be a positive number';
+$string['clierrorinvalidvaluenotstring'] = 'Param --{$a->param} must be a string';
+$string['clierrorinvalidvalueemptystring'] = 'Param --{$a->param} must not be an empty string';
 $string['clierrormissingparamaters'] = 'You must specify the start time, use --help for more information.';
 $string['clierroroutagechanged'] = 'Outage was changed while waiting.';
 $string['clierroroutageended'] = 'Outage has already ended.';
@@ -71,14 +80,19 @@ $string['defaultoutageduration'] = 'Outage duration';
 $string['defaultoutagedurationdescription'] = 'Default duration (in minutes) of an outage.';
 $string['defaultwarningduration'] = 'Warning duration';
 $string['defaultwarningdurationdescription'] = 'Default warning time (in minutes) for outages.';
+$string['defaulttime'] = 'Default time';
+$string['defaulttimedescription'] = 'The default time for the next outage, expressed in natural language eg "next Thursday 7pm". See <a target=_blank href="https://www.php.net/manual/en/datetime.formats.relative.php">PHP relative dates</a>';
 $string['defaulttitle'] = 'Title';
 $string['defaulttitledescription'] = 'Default title for outages. Use {{start}} and {{stop}} placeholders as required.';
-$string['defaulttitlevalue'] = 'System down from {{start}} for {{duration}}.';
+$string['defaulttitlevalue'] = 'System down from {{start}} for {{duration}}';
 $string['defaultdescription'] = 'Description';
 $string['defaultdescriptiondescription'] = 'Default warning message for outages. Use {{start}} and {{stop}} placeholders as required.';
 $string['defaultdescriptionvalue'] = 'There is an scheduled maintenance from {{start}} to {{stop}} and our system will not be available during that time.';
 $string['description'] = 'Public Description';
 $string['description_help'] = 'A full description of the outage, publicly visible by all users.';
+$string['eventoutagecreated'] = 'Outage scheduled';
+$string['eventoutagedeleted'] = 'Outage cancelled';
+$string['eventoutageupdated'] = 'Outage updated';
 $string['finish'] = 'Finish';
 $string['info15secondsbefore'] = '15 seconds before';
 $string['infoendofoutage'] = 'end of outage';
@@ -99,6 +113,45 @@ $string['messageoutagebackonline'] = 'We are back online!';
 $string['messageoutagebackonlinedescription'] = 'You may resume browsing safely.';
 $string['messageoutageongoing'] = 'Back online at {$a->stop}.';
 $string['messageoutagewarning'] = 'Shutting down in {{countdown}}';
+$string['messageprovider:updatenotify'] = 'Changes to planned outages';
+$string['messagesubject'] = '[{$a->site_shortname}] {$a->event_name} #{$a->outage_id}: {$a->outage_start}';
+$string['messagetext'] = '{$a->event_name}
+
+{$a->site_fullname} ({$a->site_wwwroot})
+
+{$a->event_link}
+
+ID: {$a->outage_id}
+NAME: {$a->outage_title}
+START: {$a->outage_start}
+DURATION: {$a->outage_duration}
+DESCRIPTION:
+{$a->outage_desc}
+
+--
+
+To unsubscribe visit:
+{$a->prefs_link}';
+$string['messagehtml'] = '
+<h3>{$a->event_name}</h3>
+
+<p>{$a->site_fullname} (<a href="{$a->site_wwwroot}">{$a->site_wwwroot}</a>)</p>
+
+<p><a href="{$a->event_link}">{$a->event_link}</a></p>
+
+<h4>Name:</h4>
+<p>{$a->outage_title}</p>
+<h4>Start:</h4>
+<p>{$a->outage_start}</p>
+<h4>Duration:</h4>
+<p>{$a->outage_duration}</p>
+<h4>Description:</h4>
+<p>{$a->outage_desc}</p>
+
+<hr>
+<p>To unsubscribe visit:<br>
+<a href="{$a->prefs_link}">{$a->prefs_link}</a></p>
+';
 $string['na'] = 'n/a';
 $string['notfound'] = 'No outages found.';
 $string['outageedit'] = 'Edit outage';
@@ -116,6 +169,7 @@ $string['outagefinish'] = 'Finish outage';
 $string['outagefinishwarning'] = 'You are about to mark this outage as finished. The system will be immediately back online.';
 $string['outageslistfuture'] = 'Planned outages';
 $string['outageslistpast'] = 'Outage history';
+$string['outage:updatenotify'] = '';
 $string['pluginname'] = 'Outage manager';
 $string['removeselectors'] = 'Remove selectors';
 $string['removeselectorsdescription'] = 'CSS selectors to remove when rendering a static themed maintenance page. One selector per line.';
@@ -143,6 +197,7 @@ $string['title_help'] = 'A short title to for this outage. It will be displayed
 $string['warningdurationerrorinvalid'] = 'Warning duration must be positive.';
 $string['warningduration'] = 'Warning duration';
 $string['warningduration_help'] = 'How long before the start of the outage should the warning be displayed.';
+$string['warningreenablemaintenancemode'] = 'Please note that saving this outage will re-enable maintenance mode.<br />Untick "Auto start maintenance mode" if you want to prevent this.';
 
 /*
  * Privacy provider (GDPR)

settings.php

@@ -59,6 +59,13 @@ if ($hassiteconfig && is_enabled_auth('outage')) {
         $defaults['default_duration'],
         60
     ));
+    $settings->add(new admin_setting_configtext(
+        'auth_outage/default_time',
+        get_string('defaulttime', 'auth_outage'),
+        get_string('defaulttimedescription', 'auth_outage'),
+        '',
+        PARAM_TEXT
+    ));
     $settings->add(new admin_setting_configtext(
         'auth_outage/default_title',
         get_string('defaulttitle', 'auth_outage'),

tests/phpunit/base_testcase.php

@@ -31,6 +31,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+use auth_outage\dml\outagedb;
+
 defined('MOODLE_INTERNAL') || die();
 
 /**
@@ -70,4 +72,12 @@ abstract class auth_outage_base_testcase extends advanced_testcase {
         parent::setUp();
         $this->resetAfterTest(true);
     }
+
+    public function tearDown() {
+        global $DB;
+
+        foreach (outagedb::get_all() as $i => $outage) {
+            $DB->delete_records('auth_outage', ['id' => $outage->id]);
+        }
+    }
 }

tests/phpunit/calendar/calendar_test.php

@@ -49,8 +49,8 @@ class calendar_test extends advanced_testcase {
      * Creates an outage and checks if its in the calendar.
      */
     public function test_create() {
+        $this->resetAfterTest(true);
         self::setAdminUser();
-        $this->resetAfterTest(false);
 
         $time = time();
         self::$outage = new outage([
@@ -70,8 +70,20 @@ class calendar_test extends advanced_testcase {
      * Updates an outage and checks the calendar.
      */
     public function test_update() {
+        $this->resetAfterTest(true);
         self::setAdminUser();
-        $this->resetAfterTest(false);
+
+        $time = time();
+        self::$outage = new outage([
+            'id' => 1,
+            'autostart' => false,
+            'warntime' => $time - 100,
+            'starttime' => $time,
+            'stoptime' => $time + (2 * 60 * 60),
+            'title' => 'Title',
+            'description' => 'Description',
+        ]);
+        calendar::create(self::$outage);
 
         self::$outage->title = 'New Title';
         calendar::update(self::$outage);
@@ -82,8 +94,22 @@ class calendar_test extends advanced_testcase {
      * Deletes an outage and checks the calendar.
      */
     public function test_delete() {
-        self::setAdminUser();
         $this->resetAfterTest(true);
+        self::setAdminUser();
+
+        $time = time();
+        self::$outage = new outage([
+            'id' => 1,
+            'autostart' => false,
+            'warntime' => $time - 100,
+            'starttime' => $time,
+            'stoptime' => $time + (2 * 60 * 60),
+            'title' => 'Title',
+            'description' => 'Description',
+        ]);
+        calendar::create(self::$outage);
+
+        $this->check_calendar();
 
         calendar::delete(self::$outage->id);
         self::assertNull(calendar::load(self::$outage->id));
@@ -93,8 +119,8 @@ class calendar_test extends advanced_testcase {
      * Try to update a non existing outage.
      */
     public function test_update_notfound() {
-        self::setAdminUser();
         $this->resetAfterTest(true);
+        self::setAdminUser();
 
         $time = time();
         $outage = new outage([
@@ -116,8 +142,9 @@ class calendar_test extends advanced_testcase {
      * Try to delete a non existing outage.
      */
     public function test_delete_notfound() {
-        self::setAdminUser();
         $this->resetAfterTest(true);
+        self::setAdminUser();
+
         calendar::delete(1);
         self::assertCount(1, phpunit_util::get_debugging_messages());
         phpunit_util::reset_debugging();

tests/phpunit/event/events_test.php

@@ -57,7 +57,7 @@ class events_test extends advanced_testcase {
     public function test_save() {
         global $DB;
         self::setAdminUser();
-        $this->resetAfterTest(false);
+        $this->resetAfterTest(true);
 
         // Save new outage.
         $now = time();
@@ -90,7 +90,20 @@ class events_test extends advanced_testcase {
         global $DB;
 
         self::setAdminUser();
-        $this->resetAfterTest(false);
+        $this->resetAfterTest(true);
+
+        // Save new outage.
+        $now = time();
+        $outage = new outage([
+            'autostart' => false,
+            'warntime' => $now - 60,
+            'starttime' => 60,
+            'stoptime' => 120,
+            'title' => 'Title',
+            'description' => 'Description',
+        ]);
+        $outage->id = outagedb::save($outage);
+        self::$outage = $outage;
 
         self::$outage->starttime += 10;
         outagedb::save(self::$outage);
@@ -117,6 +130,19 @@ class events_test extends advanced_testcase {
         self::setAdminUser();
         $this->resetAfterTest(true);
 
+        // Save new outage.
+        $now = time();
+        $outage = new outage([
+            'autostart' => false,
+            'warntime' => $now - 60,
+            'starttime' => 60,
+            'stoptime' => 120,
+            'title' => 'Title',
+            'description' => 'Description',
+        ]);
+        $outage->id = outagedb::save($outage);
+        self::$outage = $outage;
+
         outagedb::delete(self::$outage->id);
 
         // Should not exist.

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

@@ -3,5 +3,5 @@ a {
 }
 
 div {
-    background-image: url('/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png');
+    background-image: url('/moodle/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png');
 }

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

@@ -3,5 +3,5 @@ a {
 }
 
 div {
-    background-image: url(/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png);
+    background-image: url(/moodle/auth/outage/tests/phpunit/local/controllers/fixtures/catalyst.png);
 }

tests/phpunit/local/controllers/infopage_test.php

@@ -106,4 +106,14 @@ class infopagecontroller_test extends auth_outage_base_testcase {
         $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

@@ -25,6 +25,7 @@
 
 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;
 
 defined('MOODLE_INTERNAL') || die();
@@ -101,7 +102,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().'/622ef6e83acfcb274cdf37bdb3bffa0923f9a7ad.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');
@@ -116,7 +117,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().'/1d84b6d321fef780237f84834b7316c079221a31.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');
@@ -395,4 +396,45 @@ class maintenance_static_page_test extends auth_outage_base_testcase {
 
         self::assertContains('<meta http-equiv="refresh" content="5">', $generated);
     }
+
+    /**
+     * Data provider for test_get_urls_from_stylesheet
+     * @return array
+     */
+    public function test_get_urls_from_stylesheet_provider() {
+        return [
+            // Empty string.
+            ["", 0],
+            // URLs that should be retrieved.
+            ["background:url(/theme/image.php/_s/boost/core/1581292565/t/expanded)", 1],
+            ["background:url('/theme/image.php/_s/boost/core/1581292565/t/expanded')", 1],
+            ["src:url(\"/theme/font.php/boost/core/1581292565/fontawesome-webfont.eot?#iefix&v=4.7.0\")", 1],
+            ["background-image:url(pix/vline-rtl.gif)", 1],
+            // URLs that should not be retrieved.
+            ["background-image:url(data:image/gif;base64,R0lGODlhYADIAP=)", 0],
+            ["background-image:url('data:image/gif;base64,R0lGODlhYADIAP=')", 0],
+            ["background-image:url(\"data:image/svg+xml;charset=utf8,%3Csvg xmlns=\'http://www.w3.org/2000/svg\'\")", 0],
+            // Combination of URLs used above.
+            ["background-image:url(pix/vline-rtl.gif) background:url(/theme/image.php/_s/boost/core/158/t/expanded)", 2],
+            ["background-image:url(data:image/gif;base64,R0lG=)src:url(\"/theme/font.php/fontawesome-webfont.eot\")", 1],
+        ];
+    }
+
+    /**
+     * Tests get_urls_from_stylesheet() method to get all appropriate URLS from the file.
+     *
+     * @dataProvider test_get_urls_from_stylesheet_provider
+     * @param string $filecontent Content of the file
+     * @param int $count Expected quantity of found URLs
+     * @throws coding_exception
+     */
+    public function test_get_urls_from_stylesheet($filecontent, $count) {
+        $this->resetAfterTest(true);
+        $generator = new maintenance_static_page_generator(new DOMDocument(), new maintenance_static_page_io());
+        $matches = $generator->get_urls_from_stylesheet($filecontent);
+
+        self::assertInternalType('array', $matches);
+        self::assertCount(2, $matches);
+        self::assertCount($count, $matches[1]);
+    }
 }

tests/phpunit/local/outagelib_test.php

@@ -31,6 +31,7 @@ defined('MOODLE_INTERNAL') || die();
 
 global $CFG;
 require_once($CFG->libdir.'/adminlib.php');
+require_once(__DIR__.'/../base_testcase.php');
 
 /**
  * outagelib_test test class.
@@ -41,7 +42,7 @@ require_once($CFG->libdir.'/adminlib.php');
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @SuppressWarnings(public) Allow as many methods as needed.
  */
-class outagelib_test extends advanced_testcase {
+class outagelib_test extends auth_outage_base_testcase {
     /**
      * Check if maintenance message is disabled as needed.
      */
@@ -289,6 +290,9 @@ class outagelib_test extends advanced_testcase {
 if ((time() >= 123) && (time() < 456)) {
     define('MOODLE_INTERNAL', true);
     require_once($CFG->dirroot.'/lib/moodlelib.php');
+    if (file_exists($CFG->dirroot.'/lib/classes/ip_utils.php')) {
+        require_once($CFG->dirroot.'/lib/classes/ip_utils.php');
+    }
     if (!remoteip_in_list('hey\'\"you
 a.b.c.d
 e.e.e.e/20')) {
@@ -303,6 +307,7 @@ e.e.e.e/20')) {
         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
         header('Accept-Ranges: none');
+        header('X-Moodle-Maintenance: manager');
         if ((defined('AJAX_SCRIPT') && AJAX_SCRIPT) || (defined('WS_SERVER') && WS_SERVER)) {
             exit(0);
         }
@@ -329,6 +334,9 @@ EOT;
 if ((time() >= 123) && (time() < 456)) {
     define('MOODLE_INTERNAL', true);
     require_once($CFG->dirroot.'/lib/moodlelib.php');
+    if (file_exists($CFG->dirroot.'/lib/classes/ip_utils.php')) {
+        require_once($CFG->dirroot.'/lib/classes/ip_utils.php');
+    }
     if (!remoteip_in_list('127.0.0.1')) {
         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance');
         header('Status: 503 Moodle under maintenance');
@@ -341,6 +349,7 @@ if ((time() >= 123) && (time() < 456)) {
         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
         header('Accept-Ranges: none');
+        header('X-Moodle-Maintenance: manager');
         if ((defined('AJAX_SCRIPT') && AJAX_SCRIPT) || (defined('WS_SERVER') && WS_SERVER)) {
             exit(0);
         }

version.php

@@ -28,7 +28,7 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = "auth_outage";
-$plugin->version = 2019022200;                  // The current plugin version (Date: YYYYMMDDXX).
-$plugin->release = '1.0.10';                     // Human-readable release information.
-$plugin->requires = 2017051500; // Requires 3.3 and higher.
+$plugin->version = 2020032500;                  // The current plugin version (Date: YYYYMMDDXX).
+$plugin->release = 2020032500;                  // Human-readable release information.
+$plugin->requires = 2017051500;                 // Requires 3.3 and higher.
 $plugin->maturity = MATURITY_STABLE;            // Suitable for PRODUCTION environments!

views/manage.php

@@ -26,9 +26,12 @@
 use auth_outage\output\manage\history_table;
 use auth_outage\output\manage\planned_table;
 use auth_outage\output\renderer;
+use auth_outage\dml\outagedb;
+use auth_outage\local\outagelib;
 
 defined('MOODLE_INTERNAL') || die();
 
+global $OUTPUT;
 $urlnew = new moodle_url('/auth/outage/edit.php');
 
 echo $viewbag['warning'];
@@ -47,9 +50,23 @@ echo $viewbag['warning'];
         $table->finish_output();
         ?>
     <?php endif; ?>
-    <input type="button" class="form-submit"
-           value="<?php echo get_string('outagecreate', 'auth_outage'); ?>"
-           onclick="location.href='<?php echo $urlnew; ?>';"/>
+    <?php
+    $outage = outagedb::get_ongoing();
+    if (is_null($outage)) :
+        $config = outagelib::get_config();
+        $default = $config->default_time;
+        $max = $default ? 3 : 1;
+        $next = time();
+        for ($c = 0; $c < $max; $c++) {
+            echo '<p>';
+            $next = outagelib::get_next_window($next);
+            $urlnew->param('starttime', $next);
+            echo $OUTPUT->single_button($urlnew, get_string('outagecreate', 'auth_outage'));
+            if ($default) {
+                echo ' ' . userdate( $next, get_string('datetimeformat', 'auth_outage'));
+            }
+        }
+    endif; ?>
 </section>
 
 <section id="section_outage_history">