login/index.php

   1 <?php
   2
   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/>.
  17
  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  */
  26
  27 require('../config.php');
  28
  29 redirect_if_major_upgrade_required();
  30
  31 $testsession = optional_param('testsession', 0, PARAM_INT); // test session works properly
  32 $cancel      = optional_param('cancel', 0, PARAM_BOOL);      // redirect to frontpage, needed for loginhttps
  33
  34 if ($cancel) {
  35     redirect(new moodle_url('/'));
  36 }
  37
  38 //HTTPS is required in this page when $CFG->loginhttps enabled
  39 $PAGE->https_required();
  40
  41 $context = get_context_instance(CONTEXT_SYSTEM);
  42 $PAGE->set_url("$CFG->httpswwwroot/login/index.php");
  43 $PAGE->set_context($context);
  44 $PAGE->set_pagelayout('login');
  45
  46 /// Initialize variables
  47 $errormsg = '';
  48 $errorcode = 0;
  49
  50 // login page requested session test
  51 if ($testsession) {
  52     if ($testsession == $USER->id) {
  53         if (isset($SESSION->wantsurl)) {
  54             $urltogo = $SESSION->wantsurl;
  55         } else {
  56             $urltogo = $CFG->wwwroot.'/';
  57         }
  58         unset($SESSION->wantsurl);
  59         redirect($urltogo);
  60     } else {
  61         // TODO: try to find out what is the exact reason why sessions do not work
  62         $errormsg = get_string("cookiesnotenabled");
  63         $errorcode = 1;
  64     }
  65 }
  66
  67 /// Check for timed out sessions
  68 if (!empty($SESSION->has_timed_out)) {
  69     $session_has_timed_out = true;
  70     unset($SESSION->has_timed_out);
  71 } else {
  72     $session_has_timed_out = false;
  73 }
  74
  75 /// auth plugins may override these - SSO anyone?
  76 $frm  = false;
  77 $user = false;
  78
  79 $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
  80 foreach($authsequence as $authname) {
  81     $authplugin = get_auth_plugin($authname);
  82     $authplugin->loginpage_hook();
  83 }
  84
  85
  86 /// Define variables used in page
  87 $site = get_site();
  88
  89 $loginsite = get_string("loginsite");
  90 $PAGE->navbar->add($loginsite);
  91
  92 if ($user !== false or $frm !== false or $errormsg !== '') {
  93     // some auth plugin already supplied full user, fake form data or prevented user login with error message
  94
  95 } else if (!empty($SESSION->wantsurl) && file_exists($CFG->dirroot.'/login/weblinkauth.php')) {
  96     // Handles the case of another Moodle site linking into a page on this site
  97     //TODO: move weblink into own auth plugin
  98     include($CFG->dirroot.'/login/weblinkauth.php');
  99     if (function_exists('weblink_auth')) {
 100         $user = weblink_auth($SESSION->wantsurl);
 101     }
 102     if ($user) {
 103         $frm->username = $user->username;
 104     } else {
 105         $frm = data_submitted();
 106     }
 107
 108 } else {
 109     $frm = data_submitted();
 110 }
 111
 112 /// Check if the user has actually submitted login data to us
 113
 114 if ($frm and isset($frm->username)) {                             // Login WITH cookies
 115
 116     $frm->username = trim(textlib::strtolower($frm->username));
 117
 118     if (is_enabled_auth('none') ) {
 119         if ($frm->username !== clean_param($frm->username, PARAM_USERNAME)) {
 120             $errormsg = get_string('username').': '.get_string("invalidusername");
 121             $errorcode = 2;
 122             $user = null;
 123         }
 124     }
 125
 126     if ($user) {
 127         //user already supplied by aut plugin prelogin hook
 128     } else if (($frm->username == 'guest') and empty($CFG->guestloginbutton)) {
 129         $user = false;    /// Can't log in as guest if guest button is disabled
 130         $frm = false;
 131     } else {
 132         if (empty($errormsg)) {
 133             $user = authenticate_user_login($frm->username, $frm->password);
 134         }
 135     }
 136
 137     // Intercept 'restored' users to provide them with info & reset password
 138     if (!$user and $frm and is_restored_user($frm->username)) {
 139         $PAGE->set_title(get_string('restoredaccount'));
 140         $PAGE->set_heading($site->fullname);
 141         echo $OUTPUT->header();
 142         echo $OUTPUT->heading(get_string('restoredaccount'));
 143         echo $OUTPUT->box(get_string('restoredaccountinfo'), 'generalbox boxaligncenter');
 144         require_once('restored_password_form.php'); // Use our "supplanter" login_forgot_password_form. MDL-20846
 145         $form = new login_forgot_password_form('forgot_password.php', array('username' => $frm->username));
 146         $form->display();
 147         echo $OUTPUT->footer();
 148         die;
 149     }
 150
 151     update_login_count();
 152
 153     if ($user) {
 154
 155         // language setup
 156         if (isguestuser($user)) {
 157             // no predefined language for guests - use existing session or default site lang
 158             unset($user->lang);
 159
 160         } else if (!empty($user->lang)) {
 161             // unset previous session language - use user preference instead
 162             unset($SESSION->lang);
 163         }
 164
 165         if (empty($user->confirmed)) {       // This account was never confirmed
 166             $PAGE->set_title(get_string("mustconfirm"));
 167             $PAGE->set_heading($site->fullname);
 168             echo $OUTPUT->header();
 169             echo $OUTPUT->heading(get_string("mustconfirm"));
 170             echo $OUTPUT->box(get_string("emailconfirmsent", "", $user->email), "generalbox boxaligncenter");
 171             echo $OUTPUT->footer();
 172             die;
 173         }
 174
 175     /// Let's get them all set up.
 176         add_to_log(SITEID, 'user', 'login', "view.php?id=$USER->id&course=".SITEID,
 177                    $user->id, 0, $user->id);
 178         complete_user_login($user);
 179
 180         // sets the username cookie
 181         if (!empty($CFG->nolastloggedin)) {
 182             // do not store last logged in user in cookie
 183             // auth plugins can temporarily override this from loginpage_hook()
 184             // do not save $CFG->nolastloggedin in database!
 185
 186         } else if (empty($CFG->rememberusername) or ($CFG->rememberusername == 2 and empty($frm->rememberusername))) {
 187             // no permanent cookies, delete old one if exists
 188             set_moodle_cookie('');
 189
 190         } else {
 191             set_moodle_cookie($USER->username);
 192         }
 193
 194     /// Prepare redirection
 195         if (user_not_fully_set_up($USER)) {
 196             $urltogo = $CFG->wwwroot.'/user/edit.php';
 197             // We don't delete $SESSION->wantsurl yet, so we get there later
 198
 199         } else if (isset($SESSION->wantsurl) and (strpos($SESSION->wantsurl, $CFG->wwwroot) === 0 or strpos($SESSION->wantsurl, str_replace('http://', 'https://', $CFG->wwwroot)) === 0)) {
 200             $urltogo = $SESSION->wantsurl;    /// Because it's an address in this site
 201             unset($SESSION->wantsurl);
 202
 203         } else {
 204             // no wantsurl stored or external - go to homepage
 205             $urltogo = $CFG->wwwroot.'/';
 206             unset($SESSION->wantsurl);
 207
 208             $home_page = get_home_page();
 209             // Go to my-moodle page instead of site homepage if defaulthomepage set to homepage_my
 210             if ($home_page == HOMEPAGE_MY && !is_siteadmin() && !isguestuser()) {
 211                 if ($urltogo == $CFG->wwwroot or $urltogo == $CFG->wwwroot.'/' or $urltogo == $CFG->wwwroot.'/index.php') {
 212                     $urltogo = $CFG->wwwroot.'/my/';
 213                 }
 214             }
 215         }
 216
 217     /// check if user password has expired
 218     /// Currently supported only for ldap-authentication module
 219         $userauth = get_auth_plugin($USER->auth);
 220         if (!empty($userauth->config->expiration) and $userauth->config->expiration == 1) {
 221             if ($userauth->can_change_password()) {
 222                 $passwordchangeurl = $userauth->change_password_url();
 223                 if (!$passwordchangeurl) {
 224                     $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
 225                 }
 226             } else {
 227                 $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
 228             }
 229             $days2expire = $userauth->password_expire($USER->username);
 230             $PAGE->set_title("$site->fullname: $loginsite");
 231             $PAGE->set_heading("$site->fullname");
 232             if (intval($days2expire) > 0 && intval($days2expire) < intval($userauth->config->expiration_warning)) {
 233                 echo $OUTPUT->header();
 234                 echo $OUTPUT->confirm(get_string('auth_passwordwillexpire', 'auth', $days2expire), $passwordchangeurl, $urltogo);
 235                 echo $OUTPUT->footer();
 236                 exit;
 237             } elseif (intval($days2expire) < 0 ) {
 238                 echo $OUTPUT->header();
 239                 echo $OUTPUT->confirm(get_string('auth_passwordisexpired', 'auth'), $passwordchangeurl, $urltogo);
 240                 echo $OUTPUT->footer();
 241                 exit;
 242             }
 243         }
 244
 245         reset_login_count();
 246
 247         // test the session actually works by redirecting to self
 248         $SESSION->wantsurl = $urltogo;
 249         redirect(new moodle_url(get_login_url(), array('testsession'=>$USER->id)));
 250
 251     } else {
 252         if (empty($errormsg)) {
 253             $errormsg = get_string("invalidlogin");
 254             $errorcode = 3;
 255         }
 256     }
 257 }
 258
 259 /// Detect problems with timedout sessions
 260 if ($session_has_timed_out and !data_submitted()) {
 261     $errormsg = get_string('sessionerroruser', 'error');
 262     $errorcode = 4;
 263 }
 264
 265 /// First, let's remember where the user was trying to get to before they got here
 266
 267 if (empty($SESSION->wantsurl)) {
 268     $SESSION->wantsurl = (array_key_exists('HTTP_REFERER',$_SERVER) &&
 269                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot &&
 270                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot.'/' &&
 271                           $_SERVER["HTTP_REFERER"] != $CFG->httpswwwroot.'/login/' &&
 272                           $_SERVER["HTTP_REFERER"] != $CFG->httpswwwroot.'/login/index.php')
 273         ? $_SERVER["HTTP_REFERER"] : NULL;
 274 }
 275
 276 /// Redirect to alternative login URL if needed
 277 if (!empty($CFG->alternateloginurl)) {
 278     $loginurl = $CFG->alternateloginurl;
 279
 280     if (strpos($SESSION->wantsurl, $loginurl) === 0) {
 281         //we do not want to return to alternate url
 282         $SESSION->wantsurl = NULL;
 283     }
 284
 285     if ($errorcode) {
 286         if (strpos($loginurl, '?') === false) {
 287             $loginurl .= '?';
 288         } else {
 289             $loginurl .= '&';
 290         }
 291         $loginurl .= 'errorcode='.$errorcode;
 292     }
 293
 294     redirect($loginurl);
 295 }
 296
 297 // make sure we really are on the https page when https login required
 298 $PAGE->verify_https_required();
 299
 300 /// Generate the login page with forms
 301
 302 if (!isset($frm) or !is_object($frm)) {
 303     $frm = new stdClass();
 304 }
 305
 306 if (empty($frm->username) && $authsequence[0] != 'shibboleth') {  // See bug 5184
 307     if (!empty($_GET["username"])) {
 308         $frm->username = clean_param($_GET["username"], PARAM_RAW); // we do not want data from _POST here
 309     } else {
 310         $frm->username = get_moodle_cookie();
 311     }
 312
 313     $frm->password = "";
 314 }
 315
 316 if (!empty($frm->username)) {
 317     $focus = "password";
 318 } else {
 319     $focus = "username";
 320 }
 321
 322 if (!empty($CFG->registerauth) or is_enabled_auth('none') or !empty($CFG->auth_instructions)) {
 323     $show_instructions = true;
 324 } else {
 325     $show_instructions = false;
 326 }
 327
 328 $potentialidps = array();
 329 foreach($authsequence as $authname) {
 330     $authplugin = get_auth_plugin($authname);
 331     $potentialidps = array_merge($potentialidps, $authplugin->loginpage_idp_list($SESSION->wantsurl));
 332 }
 333
 334 $PAGE->set_title("$site->fullname: $loginsite");
 335 $PAGE->set_heading("$site->fullname");
 336
 337 echo $OUTPUT->header();
 338
 339 if (isloggedin() and !isguestuser()) {
 340     // prevent logging when already logged in, we do not want them to relogin by accident because sesskey would be changed
 341     echo $OUTPUT->box_start();
 342     $logout = new single_button(new moodle_url($CFG->httpswwwroot.'/login/logout.php', array('sesskey'=>sesskey(),'loginpage'=>1)), get_string('logout'), 'post');
 343     $continue = new single_button(new moodle_url($CFG->httpswwwroot.'/login/index.php', array('cancel'=>1)), get_string('cancel'), 'get');
 344     echo $OUTPUT->confirm(get_string('alreadyloggedin', 'error', fullname($USER)), $logout, $continue);
 345     echo $OUTPUT->box_end();
 346 } else {
 347     include("index_form.html");
 348     if (!empty($CFG->loginpageautofocus)) {
 349         //focus username or password
 350         $PAGE->requires->js_init_call('M.util.focus_login_form', null, true);
 351     }
 352 }
 353
 354 echo $OUTPUT->footer();