C:/xampp/htdocs/moodle/lib/authlib.php

Go to the documentation of this file.

<?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();

define('AUTH_OK',     0);

define('AUTH_FAIL',   1);

define('AUTH_DENIED', 2);

define('AUTH_ERROR',  4);

define('AUTH_CONFIRM_FAIL', 0);
define('AUTH_CONFIRM_OK', 1);
define('AUTH_CONFIRM_ALREADY', 2);
define('AUTH_CONFIRM_ERROR', 3);

# MDL-14055
define('AUTH_REMOVEUSER_KEEP', 0);
define('AUTH_REMOVEUSER_SUSPEND', 1);
define('AUTH_REMOVEUSER_FULLDELETE', 2);

class auth_plugin_base {

    var $config;

    var $authtype;
    /*
     * The fields we can lock and update from/to external authentication backends
     * @var array
     */
    var $userfields = array(
        'firstname',
        'lastname',
        'email',
        'city',
        'country',
        'lang',
        'description',
        'url',
        'idnumber',
        'institution',
        'department',
        'phone1',
        'phone2',
        'address'
    );

    function user_login($username, $password) {
        print_error('mustbeoveride', 'debug', '', 'user_login()' );
    }

    function can_change_password() {
        //override if needed
        return false;
    }

    function change_password_url() {
        //override if needed
        return null;
    }

    function can_edit_profile() {
        //override if needed
        return true;
    }

    function edit_profile_url() {
        //override if needed
        return null;
    }

    function is_internal() {
        //override if needed
        return true;
    }

    function prevent_local_passwords() {
        return !$this->is_internal();
    }

    function is_synchronised_with_external() {
        return !$this->is_internal();
    }

    function user_update_password($user, $newpassword) {
        //override if needed
        return true;
    }

    function user_update($olduser, $newuser) {
        //override if needed
        return true;
    }

    function user_delete($olduser) {
        //override if needed
        return;
    }

    function can_reset_password() {
        //override if needed
        return false;
    }

    function can_signup() {
        //override if needed
        return false;
    }

    function user_signup($user, $notify=true) {
        //override when can signup
        print_error('mustbeoveride', 'debug', '', 'user_signup()' );
    }

    function can_confirm() {
        //override if needed
        return false;
    }

    function user_confirm($username, $confirmsecret) {
        //override when can confirm
        print_error('mustbeoveride', 'debug', '', 'user_confirm()' );
    }

    function user_exists($username) {
        //override if needed
        return false;
    }

    function password_expire($username) {
        return 0;
    }
    function sync_roles($user) {
        //override if needed
    }

    function get_userinfo($username) {
        //override if needed
        return array();
    }

    function config_form($config, $err, $user_fields) {
        //override if needed
    }

     function validate_form(&$form, &$err) {
        //override if needed
    }

    function process_config($config) {
        //override if needed
        return true;
    }

    function loginpage_hook() {
        global $frm;  // can be used to override submitted login form
        global $user; // can be used to replace authenticate_user_login()

        //override if needed
    }

    function user_authenticated_hook(&$user, $username, $password) {
        //override if needed
    }

    function prelogout_hook() {
        global $USER; // use $USER->auth to find the plugin used for login

        //override if needed
    }

    function logoutpage_hook() {
        global $USER;     // use $USER->auth to find the plugin used for login
        global $redirect; // can be used to override redirect after logout

        //override if needed
    }

    function ignore_timeout_hook($user, $sid, $timecreated, $timemodified) {
        return false;
    }

    function get_title() {
        return get_string('pluginname', "auth_{$this->authtype}");
    }

    function get_description() {
        $authdescription = get_string("auth_{$this->authtype}description", "auth_{$this->authtype}");
        return $authdescription;
    }

    function is_captcha_enabled() {
        return false;
    }

    function loginpage_idp_list($wantsurl) {
        return array();
    }

}