mirror/moodle-auth_outage
1
0
Fork 0
mirror of https://github.com/catalyst/moodle-auth_outage.git synced 2026-05-17 05:48:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Issue #22 - Split maintenance.php into preview.php and file.php

Browse Source
This commit is contained in:
Daniel Thee Roperto
2016-11-09 16:21:46 +11:00
parent afd17994fe
commit ce2da24b1b
5 changed files with 112 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
classes/local/controllers/maintenance_static_page.php
View File

@@ -132,12 +132,14 @@ class maintenance_static_page {
*/
public function get_resources_folder() {
global $CFG;
// If you change the path, also change file auth/outage/maintenance.php as it does not use this reference.
// If you change the path, also change file auth/outage/file.php as it does not use this reference.
$dir = $CFG->dataroot.'/auth_outage/climaintenance';
if ($this->preview) {
return $CFG->dataroot.'/auth_outage/climaintenance/preview';
} else {
return $CFG->dataroot.'/auth_outage/climaintenance';
$dir = $dir.'/preview';
}
return $dir;
}
/**
@@ -319,7 +321,7 @@ class maintenance_static_page {
if ($this->preview) {
$filename = 'preview/'.$filename;
}
$url = (string)new moodle_url('/auth/outage/maintenance.php', ['file' => $filename]);
$url = (string)new moodle_url('/auth/outage/file.php', ['file' => $filename]);
return $url;
}
}

63
file.php Normal file
View File

@@ -0,0 +1,63 @@
<?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/>.
/**
* This page is used to fetch files while in maintenance mode.
*
* It should avoid as much as possible using code Moodle API.
*
* @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
*
* @var stdClass $CFG
*/
if (!isset($_GET['file'])) {
http_response_code(400);
die('Missing file parameter.');
}
define('NO_DEBUG_DISPLAY', true);
define('ABORT_AFTER_CONFIG', true);
require_once(__DIR__.'/../../config.php');
// We are not using any external libraries or references in this file (cli maintenance is active).
// If you change the path below maybe you need to change maintenance_static_page::get_resources_folder() as well.
$resourcedir = $CFG->dataroot.'/auth_outage/climaintenance';
// Protect against path traversal attacks.
$file = $resourcedir.'/'.$_GET['file'];
if (realpath($file) !== $file) {
// @codingStandardsIgnoreStart
error_log('Invalid file: '.$_GET['file']);
// @codingStandardsIgnoreEnd
http_response_code(404);
die('Not found.');
}
// Detect type, we only support css or PNG images.
header('Content-Type: '.(substr($file, -3) == 'css' ? 'text/css' : 'image/png'));
// Use cache.
$lifetime = 60 * 60 * 24; // 1 day.
header('Expires: '.gmdate('D, d M Y H:i:s', time() + $lifetime).' GMT');
header('Pragma: ');
header('Cache-Control: public, max-age='.$lifetime);
header('Accept-Ranges: none');
readfile($file);

79
maintenance.php
View File

@@ -1,79 +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/>.
/**
* This page is used to regenerate and preview a maintenance mode static 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
*
* @var stdClass $CFG
*/
use auth_outage\dml\outagedb;
use auth_outage\local\controllers\maintenance_static_page;
if (isset($_GET['file'])) {
define('NO_DEBUG_DISPLAY', true);
define('ABORT_AFTER_CONFIG', true);
require_once(__DIR__.'/../../config.php');
// We are not using any external libraries or references in this file (cli maintenance is active).
// If you change the path below maybe you need to change maintenance_static_page::get_resources_folder() as well.
$resourcedir = $CFG->dataroot.'/auth_outage/climaintenance';
// Protect against path traversal attacks.
$file = $resourcedir.'/'.$_GET['file'];
if (realpath($file) !== $file) {
// @codingStandardsIgnoreStart
error_log('Invalid file: '.$_GET['file']);
// @codingStandardsIgnoreEnd
http_response_code(404);
die('Not found.');
}
// Detect type, we only support css or PNG images.
header('Content-Type: '.(substr($file, -3) == 'css' ? 'text/css' : 'image/png'));
// Use cache.
$lifetime = 60 * 60 * 24; // 1 day.
header('Expires: '.gmdate('D, d M Y H:i:s', time() + $lifetime).' GMT');
header('Pragma: ');
header('Cache-Control: public, max-age='.$lifetime);
header('Accept-Ranges: none');
readfile($file);
return;
}
if (isset($_GET['debug'])) {
// Use auth/outage/maintenance.php?debug to preview how it will render without triggering maintenance mode.
require_once(__DIR__.'/../../config.php');
$id = optional_param('id', null, PARAM_INT);
$outage = is_null($id) ? outagedb::get_next_starting() : outagedb::get_by_id($id);
if (is_null($outage)) {
throw new invalid_parameter_exception('Outage not found.');
}
$page = maintenance_static_page::create_from_outage($outage);
$page->set_preview(true);
$page->generate();
readfile($page->get_template_file());
return;
}

41
preview.php Normal file
View File

@@ -0,0 +1,41 @@
<?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/>.
/**
* This page is used to regenerate and preview a maintenance mode static 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
*
* @var stdClass $CFG
*/
use auth_outage\dml\outagedb;
use auth_outage\local\controllers\maintenance_static_page;
require_once(__DIR__.'/../../config.php');
$id = optional_param('id', null, PARAM_INT);
$outage = is_null($id) ? outagedb::get_next_starting() : outagedb::get_by_id($id);
if (is_null($outage)) {
throw new invalid_parameter_exception('Outage not found.');
}
$page = maintenance_static_page::create_from_outage($outage);
$page->set_preview(true);
$page->generate();
readfile($page->get_template_file());

2
views/info/content.php
View File

@@ -58,7 +58,7 @@ if ($viewbag['admin']) {
get_string('infohidewarning', 'auth_outage')
);
$adminlinks[] = html_writer::link(
new moodle_url('/auth/outage/maintenance.php', ['debug' => '', 'id' => $viewbag['outage']->id]),
new moodle_url('/auth/outage/preview.php', ['id' => $viewbag['outage']->id]),
get_string('infostaticpage', 'auth_outage')
);