mirror of
https://github.com/catalyst/moodle-auth_outage.git
synced 2026-05-16 21:41:31 +02:00
Issue #33 - Refactored code, created infopage_controller to control the display of an info page.
This commit is contained in:
Daniel Thee Roperto
224
classes/infopage_controller.php
Normal file
224
classes/infopage_controller.php
Normal file
@@ -0,0 +1,224 @@
|
||||
<?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/>.
|
||||
|
||||
namespace auth_outage;
|
||||
|
||||
use auth_outage\models\outage;
|
||||
use coding_exception;
|
||||
use context_system;
|
||||
use Exception;
|
||||
use InvalidArgumentException;
|
||||
use moodle_url;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
/**
|
||||
* Controller for the info page.
|
||||
*
|
||||
* @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 infopage_controller {
|
||||
/**
|
||||
* @var outage|null The outage to display or null if none found.
|
||||
*/
|
||||
private $outage;
|
||||
|
||||
/**
|
||||
* @var bool Flags if a static version of this page should be displayed (maintenance mode).
|
||||
*/
|
||||
private $static;
|
||||
|
||||
/**
|
||||
* infopage_controller constructor.
|
||||
* @param array|null $params Parameters to use or null to get from Moodle API (request).
|
||||
*/
|
||||
public function __construct(array $params = null) {
|
||||
if (is_null($params)) {
|
||||
$params = [
|
||||
'id' => optional_param('id', null, PARAM_INT),
|
||||
'static' => optional_param('static', false, PARAM_BOOL),
|
||||
'outage' => null,
|
||||
];
|
||||
} else {
|
||||
$defaults = [
|
||||
'id' => null,
|
||||
'outage' => null,
|
||||
'static' => false,
|
||||
];
|
||||
$params = array_merge($defaults, $params);
|
||||
}
|
||||
|
||||
$this->set_parameters($params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Given the HTML code for the static page, find the outage id for that page.
|
||||
* @param string $html Static info page HTML.
|
||||
* @return int|null Outage id or null if not found.
|
||||
*/
|
||||
public static function find_outageid_from_infopage($html) {
|
||||
if (!is_string($html)) {
|
||||
throw new InvalidArgumentException('$html must be a string.');
|
||||
}
|
||||
|
||||
$output = [];
|
||||
if (preg_match('/data-outage-id="(?P<id>\d+)"/', $html, $output)) {
|
||||
return (int)$output['id'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a static info page for the given outage.
|
||||
* @param outage $outage Outage to generate the info page.
|
||||
* @param string $file File to save the static info page.
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function save_static_page(outage $outage, $file) {
|
||||
if (!is_string($file)) {
|
||||
throw new InvalidArgumentException('$file is not a string.');
|
||||
}
|
||||
|
||||
$info = new infopage_controller(['outage' => $outage, 'static' => true]);
|
||||
$html = $info->get_output();
|
||||
|
||||
// Sanity check before writing/overwriting old file.
|
||||
if (!is_string($html) || ($html == '') || (html_to_text($html) == '')) {
|
||||
throw new Exception('Sanity check failed. Invalid contents on $html.');
|
||||
}
|
||||
|
||||
$dir = dirname($file);
|
||||
if (!file_exists($dir) || !is_dir($dir)) {
|
||||
throw new Exception('Directory must exists: ' . $dir);
|
||||
}
|
||||
file_put_contents($file, $html);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the static info page by (re)creating or deleting it as needed.
|
||||
* @param null $file
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function update_static_page($file = null) {
|
||||
if (is_null($file)) {
|
||||
$file = self::get_defaulttemplatefile();
|
||||
}
|
||||
if (!is_string($file)) {
|
||||
throw new InvalidArgumentException('$file is not a string.');
|
||||
}
|
||||
|
||||
$outage = outagedb::get_next_starting();
|
||||
if (is_null($outage)) {
|
||||
if (file_exists($file)) {
|
||||
if (is_file($file) && is_writable($file)) {
|
||||
unlink($file);
|
||||
} else {
|
||||
throw new Exception('Cannot remove: ' . $file);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
self::save_static_page($outage, $file);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string The default template file to use for static info page.
|
||||
*/
|
||||
public static function get_defaulttemplatefile() {
|
||||
global $CFG;
|
||||
return $CFG->dataroot . '/climaintenance.template.html';
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates and returns the HTML for the info page.
|
||||
* @return string HTML for the info page.
|
||||
*/
|
||||
public function get_output() {
|
||||
ob_start();
|
||||
try {
|
||||
$this->output();
|
||||
return ob_get_contents();
|
||||
} finally {
|
||||
ob_end_clean();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if this page should have admin options, taking in consideration it should happen if generating a static page.
|
||||
* @return bool True if it should display admin options.
|
||||
*/
|
||||
public function has_admin_options() {
|
||||
return (!$this->static && is_siteadmin());
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates and outputs the HTML for the info page.
|
||||
* @uses redirect
|
||||
*/
|
||||
public function output() {
|
||||
global $PAGE, $CFG, $OUTPUT;
|
||||
|
||||
if (is_null($this->outage)) {
|
||||
if ($this->static) {
|
||||
throw new coding_exception('Cannot render a static info page without an outage.');
|
||||
} else {
|
||||
redirect(new moodle_url('/'));
|
||||
}
|
||||
}
|
||||
|
||||
$PAGE->set_context(context_system::instance());
|
||||
if ($this->static) {
|
||||
require($CFG->dirroot . '/auth/outage/views/info/static.php');
|
||||
} else {
|
||||
$PAGE->set_title($this->outage->get_title());
|
||||
$PAGE->set_heading($this->outage->get_title());
|
||||
$PAGE->set_url(new moodle_url('/auth/outage/info.php'));
|
||||
|
||||
// No hooks injecting into this page, do it manually.
|
||||
outagelib::inject();
|
||||
|
||||
echo $OUTPUT->header();
|
||||
require($CFG->dirroot . '/auth/outage/views/info/content.php');
|
||||
echo $OUTPUT->footer();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adjusts the fields according to the given parameters.
|
||||
* @param array $params
|
||||
*/
|
||||
private function set_parameters(array $params) {
|
||||
if (!is_null($params['outage']) && !($params['outage'] instanceof outage)) {
|
||||
throw new InvalidArgumentException('Provided outage is not a valid outage object.');
|
||||
}
|
||||
|
||||
if (!is_null($params['id']) && !is_null($params['outage']) && ($params['id'] !== $params['outage']->id)) {
|
||||
throw new InvalidArgumentException('Provided id and outage->id do not match.');
|
||||
}
|
||||
|
||||
if (is_null($params['id']) && is_null($params['outage'])) {
|
||||
$params['outage'] = outagedb::get_active();
|
||||
} else if (is_null($params['outage'])) {
|
||||
$params['outage'] = outagedb::get_by_id($params['id']);
|
||||
}
|
||||
|
||||
$this->outage = $params['outage'];
|
||||
$this->static = (bool)$params['static'];
|
||||
}
|
||||
}
|
||||
@@ -121,7 +121,7 @@ class outagedb {
|
||||
}
|
||||
|
||||
// Trigger static page update.
|
||||
outagelib::updatestaticinfopagefile();
|
||||
infopage_controller::update_static_page();
|
||||
|
||||
// All done, return the id.
|
||||
return $outage->id;
|
||||
@@ -154,7 +154,7 @@ class outagedb {
|
||||
self::calendar_delete($id);
|
||||
|
||||
// Trigger static page update.
|
||||
outagelib::updatestaticinfopagefile();
|
||||
infopage_controller::update_static_page();
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -16,10 +16,8 @@
|
||||
|
||||
namespace auth_outage;
|
||||
|
||||
use auth_outage\models\outage;
|
||||
use auth_outage_renderer;
|
||||
use Exception;
|
||||
use InvalidArgumentException;
|
||||
use moodle_url;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
@@ -120,81 +118,4 @@ class outagelib {
|
||||
'css' => file_get_contents($CFG->dirroot . '/auth/outage/views/warningbar.css'),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a static info page for the given outage.
|
||||
* @param outage $outage Outage to generate the info page.
|
||||
* @param string $file File to save the static info page.
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function savestaticinfopage(outage $outage, $file) {
|
||||
if (!is_string($file)) {
|
||||
throw new InvalidArgumentException('$file is not a string.');
|
||||
}
|
||||
|
||||
$html = self::get_renderer()->renderoutagepagestatic($outage);
|
||||
|
||||
// Sanity check before writing/overwriting old file.
|
||||
if (!is_string($html) || ($html == '')) {
|
||||
throw new Exception('Sanity check failed. Invalid contents on $html.');
|
||||
}
|
||||
|
||||
$dir = dirname($file);
|
||||
if (!file_exists($dir) || !is_dir($dir)) {
|
||||
throw new Exception('Directory must exists: ' . $dir);
|
||||
}
|
||||
file_put_contents($file, $html);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the static info page by (re)creating or deleting it as needed.
|
||||
* @param null $file
|
||||
* @throws Exception
|
||||
*/
|
||||
public static function updatestaticinfopagefile($file = null) {
|
||||
if (is_null($file)) {
|
||||
$file = self::get_defaulttemplatefile();
|
||||
}
|
||||
if (!is_string($file)) {
|
||||
throw new InvalidArgumentException('$file is not a string.');
|
||||
}
|
||||
|
||||
$outage = outagedb::get_next_starting();
|
||||
if (is_null($outage)) {
|
||||
if (file_exists($file)) {
|
||||
if (is_file($file)) {
|
||||
unlink($file);
|
||||
} else {
|
||||
throw new Exception('Cannot remove non-file: ' . $file);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
self::savestaticinfopage($outage, $file);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given the HTML code for the static page, find the outage id for that page.
|
||||
* @param $html Static info page HTML.
|
||||
* @return int|null Outage id or null if not found.
|
||||
*/
|
||||
public static function get_outageidfrominfopage($html) {
|
||||
if (!is_string($html)) {
|
||||
throw new InvalidArgumentException('$html must be a string.');
|
||||
}
|
||||
|
||||
$output = [];
|
||||
if (preg_match('/data-outage-id="(?P<id>\d+)"/', $html, $output)) {
|
||||
return (int)$output['id'];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string The default template file to use for static info page.
|
||||
*/
|
||||
public static function get_defaulttemplatefile() {
|
||||
global $CFG;
|
||||
return $CFG->dataroot . '/climaintenance.template.html';
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user