moodle-auth_outage/auth.php

<?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 plugin allows for an outage window to be configured
 * and then optionally allows only a subset of IPs to connect,
 * it also shows an outage notification to users.
 *
 * @package     auth_outage
 * @author      Marcus Boon<marcus@catalyst-au.net>
 * @license     http://www.gnu.org/copyleft/gpl.html GNU Public License
 */

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');

/**
 * 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';
        $this->errorlogtag = '[AUTH_OUTAGE]';
        $this->config = get_config('auth_outage');

        // Set to defaults if undefined.
        //$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;
//    }
}