<?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/>.
/**
* Login renderable.
*
* @package core_auth
* @copyright 2016 Frédéric Massart - FMCorz.net
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_auth\output;
< defined('MOODLE_INTERNAL') || die();
<
< require_once($CFG->libdir . '/externallib.php');
use context_system;
use help_icon;
use moodle_url;
use renderable;
use renderer_base;
use stdClass;
use templatable;
/**
* Login renderable class.
*
* @package core_auth
* @copyright 2016 Frédéric Massart - FMCorz.net
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class login implements renderable, templatable {
/** @var bool Whether to auto focus the form fields. */
public $autofocusform;
/** @var bool Whether we can login as guest. */
public $canloginasguest;
/** @var bool Whether we can login by e-mail. */
public $canloginbyemail;
/** @var bool Whether we can sign-up. */
public $cansignup;
/** @var help_icon The cookies help icon. */
public $cookieshelpicon;
/** @var string The error message, if any. */
public $error;
/** @var moodle_url Forgot password URL. */
public $forgotpasswordurl;
/** @var array Additional identify providers, contains the keys 'url', 'name' and 'icon'. */
public $identityproviders;
/** @var string Login instructions, if any. */
public $instructions;
/** @var moodle_url The form action login URL. */
public $loginurl;
/** @var moodle_url The sign-up URL. */
public $signupurl;
/** @var string The user name to pre-fill the form with. */
public $username;
/** @var string The language selector menu. */
public $languagemenu;
/** @var string The csrf token to limit login to requests that come from the login form. */
public $logintoken;
/** @var string Maintenance message, if Maintenance is enabled. */
public $maintenance;
/**
* Constructor.
*
* @param array $authsequence The enabled sequence of authentication plugins.
* @param string $username The username to display.
*/
public function __construct(array $authsequence, $username = '') {
global $CFG, $OUTPUT, $PAGE;
$this->username = $username;
$languagedata = new \core\output\language_menu($PAGE);
$this->languagemenu = $languagedata->export_for_action_menu($OUTPUT);
$this->canloginasguest = $CFG->guestloginbutton && !isguestuser();
$this->canloginbyemail = !empty($CFG->authloginviaemail);
$this->cansignup = $CFG->registerauth == 'email' || !empty($CFG->registerauth);
if ($CFG->rememberusername == 0) {
$this->cookieshelpicon = new help_icon('cookiesenabledonlysession', 'core');
} else {
$this->cookieshelpicon = new help_icon('cookiesenabled', 'core');
}
$this->autofocusform = !empty($CFG->loginpageautofocus);
$this->forgotpasswordurl = new moodle_url('/login/forgot_password.php');
$this->loginurl = new moodle_url('/login/index.php');
$this->signupurl = new moodle_url('/login/signup.php');
// Authentication instructions.
$this->instructions = $CFG->auth_instructions;
if (is_enabled_auth('none')) {
$this->instructions = get_string('loginstepsnone');
} else if ($CFG->registerauth == 'email' && empty($this->instructions)) {
$this->instructions = get_string('loginsteps', 'core', 'signup.php');
}
if ($CFG->maintenance_enabled == true) {
if (!empty($CFG->maintenance_message)) {
$this->maintenance = $CFG->maintenance_message;
} else {
$this->maintenance = get_string('sitemaintenance', 'admin');
}
}
// Identity providers.
$this->identityproviders = \auth_plugin_base::get_identity_providers($authsequence);
$this->logintoken = \core\session\manager::get_login_token();
}
/**
* Set the error message.
*
* @param string $error The error message.
*/
public function set_error($error) {
$this->error = $error;
}
public function export_for_template(renderer_base $output) {
$identityproviders = \auth_plugin_base::prepare_identity_providers_for_output($this->identityproviders, $output);
$data = new stdClass();
$data->autofocusform = $this->autofocusform;
$data->canloginasguest = $this->canloginasguest;
$data->canloginbyemail = $this->canloginbyemail;
$data->cansignup = $this->cansignup;
$data->cookieshelpicon = $this->cookieshelpicon->export_for_template($output);
$data->error = $this->error;
$data->forgotpasswordurl = $this->forgotpasswordurl->out(false);
$data->hasidentityproviders = !empty($this->identityproviders);
$data->hasinstructions = !empty($this->instructions) || $this->cansignup;
$data->identityproviders = $identityproviders;
< list($data->instructions, $data->instructionsformat) = external_format_text($this->instructions, FORMAT_MOODLE,
> list($data->instructions, $data->instructionsformat) = \core_external\util::format_text($this->instructions, FORMAT_MOODLE,
context_system::instance()->id);
$data->loginurl = $this->loginurl->out(false);
$data->signupurl = $this->signupurl->out(false);
$data->username = $this->username;
$data->logintoken = $this->logintoken;
$data->maintenance = format_text($this->maintenance, FORMAT_MOODLE);
$data->languagemenu = $this->languagemenu;
return $data;
}
}