MDL-23833 rewritten guest autologin - not using redirect any more + migration to...
[moodle.git] / login / index.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Main login page.
20  *
21  * @package    core
22  * @subpackage auth
23  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require('../config.php');
29 redirect_if_major_upgrade_required();
31 $testcookies = optional_param('testcookies', 0, PARAM_BOOL); // request cookie test
33 //HTTPS is potentially required in this page
34 httpsrequired();
36 $context = get_context_instance(CONTEXT_SYSTEM);
37 $PAGE->set_url("$CFG->httpswwwroot/login/index.php");
38 $PAGE->set_context($context);
39 $PAGE->set_pagelayout('login');
41 /// Initialize variables
42 $errormsg = '';
43 $errorcode = 0;
45 /// Check for timed out sessions
46 if (!empty($SESSION->has_timed_out)) {
47     $session_has_timed_out = true;
48     unset($SESSION->has_timed_out);
49 } else {
50     $session_has_timed_out = false;
51 }
53 /// auth plugins may override these - SSO anyone?
54 $frm  = false;
55 $user = false;
57 $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
58 foreach($authsequence as $authname) {
59     $authplugin = get_auth_plugin($authname);
60     $authplugin->loginpage_hook();
61 }
64 /// Define variables used in page
65 $site = get_site();
67 $loginsite = get_string("loginsite");
68 $PAGE->navbar->add($loginsite);
70 if ($user !== false or $frm !== false or $errormsg !== '') {
71     // some auth plugin already supplied full user, fake form data or prevented user login with error message
73 } else if (!empty($SESSION->wantsurl) && file_exists($CFG->dirroot.'/login/weblinkauth.php')) {
74     // Handles the case of another Moodle site linking into a page on this site
75     //TODO: move weblink into own auth plugin
76     include($CFG->dirroot.'/login/weblinkauth.php');
77     if (function_exists('weblink_auth')) {
78         $user = weblink_auth($SESSION->wantsurl);
79     }
80     if ($user) {
81         $frm->username = $user->username;
82     } else {
83         $frm = data_submitted();
84     }
86 } else {
87     $frm = data_submitted();
88 }
90 /// Check if the user has actually submitted login data to us
92 if (empty($CFG->usesid) and $testcookies and (get_moodle_cookie() == '')) {    // Login without cookie when test requested
94     $errormsg = get_string("cookiesnotenabled");
95     $errorcode = 1;
97 } else if ($frm and isset($frm->username)) {                             // Login WITH cookies
99     $frm->username = trim(moodle_strtolower($frm->username));
101     if (is_enabled_auth('none') ) {
102         if ($frm->username !== clean_param($frm->username, PARAM_USERNAME)) {
103             $errormsg = get_string('username').': '.get_string("invalidusername");
104             $errorcode = 2;
105             $user = null;
106         }
107     }
109     if ($user) {
110         //user already supplied by aut plugin prelogin hook
111     } else if (($frm->username == 'guest') and empty($CFG->guestloginbutton)) {
112         $user = false;    /// Can't log in as guest if guest button is disabled
113         $frm = false;
114     } else {
115         if (empty($errormsg)) {
116             $user = authenticate_user_login($frm->username, $frm->password);
117         }
118     }
120     // Intercept 'restored' users to provide them with info & reset password
121     if (!$user and $frm and is_restored_user($frm->username)) {
122         $PAGE->set_title(get_string('restoredaccount'));
123         $PAGE->set_heading($site->fullname);
124         echo $OUTPUT->header();
125         echo $OUTPUT->heading(get_string('restoredaccount'));
126         echo $OUTPUT->box(get_string('restoredaccountinfo'), 'generalbox boxaligncenter');
127         require_once('restored_password_form.php'); // Use our "supplanter" login_forgot_password_form. MDL-20846
128         $form = new login_forgot_password_form('forgot_password.php', array('username' => $frm->username));
129         $form->display();
130         echo $OUTPUT->footer();
131         die;
132     }
134     update_login_count();
136     if ($user) {
138         // language setup
139         if ($user->username == 'guest') {
140             // no predefined language for guests - use existing session or default site lang
141             unset($user->lang);
143         } else if (!empty($user->lang)) {
144             // unset previous session language - use user preference instead
145             unset($SESSION->lang);
146         }
148         if (empty($user->confirmed)) {       // This account was never confirmed
149             $PAGE->set_title(get_string("mustconfirm"));
150             $PAGE->set_heading($site->fullname);
151             echo $OUTPUT->header();
152             echo $OUTPUT->heading(get_string("mustconfirm"));
153             echo $OUTPUT->box(get_string("emailconfirmsent", "", $user->email), "generalbox boxaligncenter");
154             echo $OUTPUT->footer();
155             die;
156         }
158         if ($frm->password == 'changeme') {
159             //force the change
160             set_user_preference('auth_forcepasswordchange', true, $user->id);
161         }
163     /// Let's get them all set up.
164         add_to_log(SITEID, 'user', 'login', "view.php?id=$USER->id&course=".SITEID,
165                    $user->id, 0, $user->id);
166         complete_user_login($user);
168     /// Prepare redirection
169         if (user_not_fully_set_up($USER)) {
170             $urltogo = $CFG->wwwroot.'/user/edit.php';
171             // We don't delete $SESSION->wantsurl yet, so we get there later
173         } else if (isset($SESSION->wantsurl) and (strpos($SESSION->wantsurl, $CFG->wwwroot) === 0)) {
174             $urltogo = $SESSION->wantsurl;    /// Because it's an address in this site
175             unset($SESSION->wantsurl);
177         } else {
178             // no wantsurl stored or external - go to homepage
179             $urltogo = $CFG->wwwroot.'/';
180             unset($SESSION->wantsurl);
181         }
183     /// Go to my-moodle page instead of site homepage if defaulthomepage set to homepage_my
184         if (!empty($CFG->defaulthomepage) && $CFG->defaulthomepage == HOMEPAGE_MY && !is_siteadmin() && !isguestuser()) {
185             if ($urltogo == $CFG->wwwroot or $urltogo == $CFG->wwwroot.'/' or $urltogo == $CFG->wwwroot.'/index.php') {
186                 $urltogo = $CFG->wwwroot.'/my/';
187             }
188         }
191     /// check if user password has expired
192     /// Currently supported only for ldap-authentication module
193         $userauth = get_auth_plugin($USER->auth);
194         if (!empty($userauth->config->expiration) and $userauth->config->expiration == 1) {
195             if ($userauth->can_change_password()) {
196                 $passwordchangeurl = $userauth->change_password_url();
197                 if(!$passwordchangeurl) {
198                     $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
199                 }
200             } else {
201                 $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
202             }
203             $days2expire = $userauth->password_expire($USER->username);
204             $PAGE->set_title("$site->fullname: $loginsite");
205             $PAGE->set_heading("$site->fullname");
206             if (intval($days2expire) > 0 && intval($days2expire) < intval($userauth->config->expiration_warning)) {
207                 echo $OUTPUT->header();
208                 echo $OUTPUT->confirm(get_string('auth_passwordwillexpire', 'auth', $days2expire), $passwordchangeurl, $urltogo);
209                 echo $OUTPUT->footer();
210                 exit;
211             } elseif (intval($days2expire) < 0 ) {
212                 echo $OUTPUT->header();
213                 echo $OUTPUT->confirm(get_string('auth_passwordisexpired', 'auth'), $passwordchangeurl, $urltogo);
214                 echo $OUTPUT->footer();
215                 exit;
216             }
217         }
219         reset_login_count();
221         redirect($urltogo);
223         exit;
225     } else {
226         if (empty($errormsg)) {
227             $errormsg = get_string("invalidlogin");
228             $errorcode = 3;
229         }
230     }
233 /// Detect problems with timedout sessions
234 if ($session_has_timed_out and !data_submitted()) {
235     $errormsg = get_string('sessionerroruser', 'error');
236     $errorcode = 4;
239 /// First, let's remember where the user was trying to get to before they got here
241 if (empty($SESSION->wantsurl)) {
242     $SESSION->wantsurl = (array_key_exists('HTTP_REFERER',$_SERVER) &&
243                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot &&
244                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot.'/' &&
245                           $_SERVER["HTTP_REFERER"] != $CFG->httpswwwroot.'/login/' &&
246                           $_SERVER["HTTP_REFERER"] != $CFG->httpswwwroot.'/login/index.php')
247         ? $_SERVER["HTTP_REFERER"] : NULL;
250 /// Redirect to alternative login URL if needed
251 if (!empty($CFG->alternateloginurl)) {
252     $loginurl = $CFG->alternateloginurl;
254     if (strpos($SESSION->wantsurl, $loginurl) === 0) {
255         //we do not want to return to alternate url
256         $SESSION->wantsurl = NULL;
257     }
259     if ($errorcode) {
260         if (strpos($loginurl, '?') === false) {
261             $loginurl .= '?';
262         } else {
263             $loginurl .= '&';
264         }
265         $loginurl .= 'errorcode='.$errorcode;
266     }
268     redirect($loginurl);
272 /// Generate the login page with forms
274 if (get_moodle_cookie() == '') {
275     set_moodle_cookie('nobody');   // To help search for cookies
278 if (empty($frm->username) && $authsequence[0] != 'shibboleth') {  // See bug 5184
279     if (!empty($_GET["username"])) {
280         $frm->username = $_GET["username"];
281     } else {
282         $frm->username = get_moodle_cookie() === 'nobody' ? '' : get_moodle_cookie();
283     }
285     $frm->password = "";
288 if (!empty($frm->username)) {
289     $focus = "password";
290 } else {
291     $focus = "username";
294 if (!empty($CFG->registerauth) or is_enabled_auth('none') or !empty($CFG->auth_instructions)) {
295     $show_instructions = true;
296 } else {
297     $show_instructions = false;
300 $potentialidps = array();
301 foreach($authsequence as $authname) {
302     $authplugin = get_auth_plugin($authname);
303     $potentialidps = array_merge($potentialidps, $authplugin->loginpage_idp_list($SESSION->wantsurl));
306 $PAGE->set_title("$site->fullname: $loginsite");
307 $PAGE->set_heading("$site->fullname");
309 echo $OUTPUT->header();
310 include("index_form.html");
311 echo $OUTPUT->footer();