mirror of
https://github.com/catalyst/moodle-auth_outage.git
synced 2026-05-16 21:41:31 +02:00
Basic settings and database
This commit is contained in:
Daniel Thee Roperto
100
auth.php
100
auth.php
@@ -19,8 +19,7 @@
|
||||
* and then optionally allows only a subset of IPs to connect,
|
||||
* it also shows an outage notification to users.
|
||||
*
|
||||
* @package auth
|
||||
* @subpackage outage
|
||||
* @package auth_outage
|
||||
* @author Marcus Boon<marcus@catalyst-au.net>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
|
||||
*/
|
||||
@@ -29,12 +28,17 @@ if (!defined('MOODLE_INTERNAL')) {
|
||||
die('Direct access to this script is forbidden.'); // It must be included from a Moodle page.
|
||||
}
|
||||
|
||||
require_once($CFG->libdir.'/authlib.php');
|
||||
require_once($CFG->libdir . '/authlib.php');
|
||||
|
||||
class auth_plugin_outage extends auth_plugin_base {
|
||||
|
||||
public function __construct() {
|
||||
/**
|
||||
* Class auth_plugin_outage
|
||||
*/
|
||||
class auth_plugin_outage extends auth_plugin_base
|
||||
{
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
$this->pluginconfig = 'auth_outage';
|
||||
$this->authtype = 'outage';
|
||||
$this->roleauth = 'auth_outage';
|
||||
$this->component = 'auth_outage';
|
||||
@@ -42,6 +46,88 @@ class auth_plugin_outage extends auth_plugin_base {
|
||||
$this->config = get_config('auth_outage');
|
||||
|
||||
// Set to defaults if undefined.
|
||||
$this->config = $this->set_defaults($this->config);
|
||||
//$this->config = $this->set_defaults($this->config);
|
||||
}
|
||||
|
||||
/**
|
||||
* This is the primary method that is used by the authenticate_user_login()
|
||||
* function in moodlelib.php.
|
||||
*
|
||||
* This method should return a boolean indicating
|
||||
* whether or not the username and password authenticate successfully.
|
||||
*
|
||||
* Returns true if the username and password work and false if they are
|
||||
* wrong or don't exist.
|
||||
*
|
||||
* @param string $username The username (with system magic quotes)
|
||||
* @param string $password The password (with system magic quotes)
|
||||
*
|
||||
* @return bool Authentication success or failure.
|
||||
*/
|
||||
function user_login($username, $password)
|
||||
{
|
||||
// do not authenticate users
|
||||
return false;
|
||||
}
|
||||
|
||||
// /**
|
||||
// * Prints a form for configuring this authentication plugin.
|
||||
// *
|
||||
// * This function is called from admin/auth.php, and outputs a full page with
|
||||
// * a form for configuring this plugin.
|
||||
// *
|
||||
// * @param object $config
|
||||
// * @param object $err
|
||||
// * @param array $user_fields
|
||||
// */
|
||||
// function config_form($config, $err, $user_fields)
|
||||
// {
|
||||
// require('config.php');
|
||||
// }
|
||||
//
|
||||
// /**
|
||||
// * A chance to validate form data, and last chance to
|
||||
// * do stuff before it is inserted in config_plugin
|
||||
// * @param object object with submitted configuration settings (without system magic quotes)
|
||||
// * @param array $err array of error messages
|
||||
// */
|
||||
// function validate_form($form, &$err)
|
||||
// {
|
||||
// if (strlen(trim($form->default_warning_message)) == 0) {
|
||||
// $err['invalid_message'] = 'Please provide a descriptive message.';
|
||||
// }
|
||||
//
|
||||
// $starts = DateTime::createFromFormat('Y-m-d\\TH:i', $form->starts);
|
||||
// if ($starts === false) {
|
||||
// $err['invalid_start'] = 'Invalid start date.';
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// /**
|
||||
// * Processes and stores configuration data for this authentication plugin.
|
||||
// *
|
||||
// * @param object object with submitted configuration settings (without system magic quotes)
|
||||
// */
|
||||
// function process_config($config)
|
||||
// {
|
||||
// if (!isset($config->active)) {
|
||||
// $config->active = 'N';
|
||||
// }
|
||||
// if (!isset($config->message)) {
|
||||
// $config->message = 'Maintenance scheduled from %s to %s.';
|
||||
// }
|
||||
// if (!isset($config->starts)) {
|
||||
// $config->starts = '';
|
||||
// }
|
||||
// if (!isset($config->ends)) {
|
||||
// $config->ends = '';
|
||||
// }
|
||||
//
|
||||
// set_config('active', ($config->active == 'Y' ? 'Y' : 'N'), $this->pluginconfig);
|
||||
// set_config('message', trim($config->message), $this->pluginconfig);
|
||||
// set_config('starts', $config->starts, $this->pluginconfig);
|
||||
// set_config('ends', $config->ends, $this->pluginconfig);
|
||||
//
|
||||
// return true;
|
||||
// }
|
||||
}
|
||||
|
||||
27
db/install.xml
Normal file
27
db/install.xml
Normal file
@@ -0,0 +1,27 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<XMLDB PATH="auth/outage/db" VERSION="20160825" COMMENT="XMLDB file for Moodle auth/outage"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
|
||||
>
|
||||
<TABLES>
|
||||
<TABLE NAME="auth_outage" COMMENT="Table used for auth/outage plugin. Holds information about all past, current and future outages.">
|
||||
<FIELDS>
|
||||
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
|
||||
<FIELD NAME="starttime" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="When outage starts."/>
|
||||
<FIELD NAME="stoptime" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="When outage ends."/>
|
||||
<FIELD NAME="warning_minutes" TYPE="int" LENGTH="7" NOTNULL="true" SEQUENCE="false" COMMENT="How many minutes before the outage to display a warning to all users."/>
|
||||
<FIELD NAME="title" TYPE="char" LENGTH="20" NOTNULL="true" SEQUENCE="false" COMMENT="Title for the outage (short description)."/>
|
||||
<FIELD NAME="description" TYPE="text" NOTNULL="true" SEQUENCE="false" COMMENT="More information about the outage."/>
|
||||
<FIELD NAME="createdby" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="Who created this entry."/>
|
||||
<FIELD NAME="modifiedby" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="Who last modified this entry."/>
|
||||
<FIELD NAME="lastmod" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false" COMMENT="When was this entry last modified."/>
|
||||
</FIELDS>
|
||||
<KEYS>
|
||||
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
|
||||
</KEYS>
|
||||
<INDEXES>
|
||||
<INDEX NAME="start_stop_title" UNIQUE="false" FIELDS="starttime, stoptime, title"/>
|
||||
</INDEXES>
|
||||
</TABLE>
|
||||
</TABLES>
|
||||
</XMLDB>
|
||||
12
lang/en/auth_outage.php
Normal file
12
lang/en/auth_outage.php
Normal file
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
/**
|
||||
* Strings for component 'auth_outage', language 'en'.
|
||||
*
|
||||
* @package auth_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
|
||||
*/
|
||||
|
||||
$string['auth_outagedescription'] = 'Auxiliary plugin that warns users about a future outage and prevents them from logging in once the outage starts.';
|
||||
$string['pluginname'] = 'Outage';
|
||||
22
settings.php
Normal file
22
settings.php
Normal file
@@ -0,0 +1,22 @@
|
||||
<?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/>.
|
||||
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
if ($ADMIN->fulltree) {
|
||||
$settings->add(new admin_setting_configselect('data_auth_outage', get_string('enablerssfeeds', 'admin'),
|
||||
$str, 0, $options));
|
||||
}
|
||||
Reference in New Issue
Block a user