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 = context_system::instance();
  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
 209         // If the url to go to is the same as the site page, check for default homepage.
 210         if ($urltogo == ($CFG->wwwroot . '/')) {
 211             $home_page = get_home_page();
 212             // Go to my-moodle page instead of site homepage if defaulthomepage set to homepage_my
 213             if ($home_page == HOMEPAGE_MY && !is_siteadmin() && !isguestuser()) {
 214                 if ($urltogo == $CFG->wwwroot or $urltogo == $CFG->wwwroot.'/' or $urltogo == $CFG->wwwroot.'/index.php') {
 215                     $urltogo = $CFG->wwwroot.'/my/';
 216                 }
 217             }
 218         }
 219
 220     /// check if user password has expired
 221     /// Currently supported only for ldap-authentication module
 222         $userauth = get_auth_plugin($USER->auth);
 223         if (!empty($userauth->config->expiration) and $userauth->config->expiration == 1) {
 224             if ($userauth->can_change_password()) {
 225                 $passwordchangeurl = $userauth->change_password_url();
 226                 if (!$passwordchangeurl) {
 227                     $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
 228                 }
 229             } else {
 230                 $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
 231             }
 232             $days2expire = $userauth->password_expire($USER->username);
 233             $PAGE->set_title("$site->fullname: $loginsite");
 234             $PAGE->set_heading("$site->fullname");
 235             if (intval($days2expire) > 0 && intval($days2expire) < intval($userauth->config->expiration_warning)) {
 236                 echo $OUTPUT->header();
 237                 echo $OUTPUT->confirm(get_string('auth_passwordwillexpire', 'auth', $days2expire), $passwordchangeurl, $urltogo);
 238                 echo $OUTPUT->footer();
 239                 exit;
 240             } elseif (intval($days2expire) < 0 ) {
 241                 echo $OUTPUT->header();
 242                 echo $OUTPUT->confirm(get_string('auth_passwordisexpired', 'auth'), $passwordchangeurl, $urltogo);
 243                 echo $OUTPUT->footer();
 244                 exit;
 245             }
 246         }
 247
 248         reset_login_count();
 249
 250         // test the session actually works by redirecting to self
 251         $SESSION->wantsurl = $urltogo;
 252         redirect(new moodle_url(get_login_url(), array('testsession'=>$USER->id)));
 253
 254     } else {
 255         if (empty($errormsg)) {
 256             $errormsg = get_string("invalidlogin");
 257             $errorcode = 3;
 258         }
 259     }
 260 }
 261
 262 /// Detect problems with timedout sessions
 263 if ($session_has_timed_out and !data_submitted()) {
 264     $errormsg = get_string('sessionerroruser', 'error');
 265     $errorcode = 4;
 266 }
 267
 268 /// First, let's remember where the user was trying to get to before they got here
 269
 270 if (empty($SESSION->wantsurl)) {
 271     $SESSION->wantsurl = (array_key_exists('HTTP_REFERER',$_SERVER) &&
 272                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot &&
 273                           $_SERVER["HTTP_REFERER"] != $CFG->wwwroot.'/' &&
 274                           $_SERVER["HTTP_REFERER"] != $CFG->httpswwwroot.'/login/' &&
 275                           strpos($_SERVER["HTTP_REFERER"], $CFG->httpswwwroot.'/login/?') !== 0 &&
 276                           strpos($_SERVER["HTTP_REFERER"], $CFG->httpswwwroot.'/login/index.php') !== 0) // There might be some extra params such as ?lang=.
 277         ? $_SERVER["HTTP_REFERER"] : NULL;
 278 }
 279
 280 /// Redirect to alternative login URL if needed
 281 if (!empty($CFG->alternateloginurl)) {
 282     $loginurl = $CFG->alternateloginurl;
 283
 284     if (strpos($SESSION->wantsurl, $loginurl) === 0) {
 285         //we do not want to return to alternate url
 286         $SESSION->wantsurl = NULL;
 287     }
 288
 289     if ($errorcode) {
 290         if (strpos($loginurl, '?') === false) {
 291             $loginurl .= '?';
 292         } else {
 293             $loginurl .= '&';
 294         }
 295         $loginurl .= 'errorcode='.$errorcode;
 296     }
 297
 298     redirect($loginurl);
 299 }
 300
 301 // make sure we really are on the https page when https login required
 302 $PAGE->verify_https_required();
 303
 304 /// Generate the login page with forms
 305
 306 if (!isset($frm) or !is_object($frm)) {
 307     $frm = new stdClass();
 308 }
 309
 310 if (empty($frm->username) && $authsequence[0] != 'shibboleth') {  // See bug 5184
 311     if (!empty($_GET["username"])) {
 312         $frm->username = clean_param($_GET["username"], PARAM_RAW); // we do not want data from _POST here
 313     } else {
 314         $frm->username = get_moodle_cookie();
 315     }
 316
 317     $frm->password = "";
 318 }
 319
 320 if (!empty($frm->username)) {
 321     $focus = "password";
 322 } else {
 323     $focus = "username";
 324 }
 325
 326 if (!empty($CFG->registerauth) or is_enabled_auth('none') or !empty($CFG->auth_instructions)) {
 327     $show_instructions = true;
 328 } else {
 329     $show_instructions = false;
 330 }
 331
 332 $potentialidps = array();
 333 foreach($authsequence as $authname) {
 334     $authplugin = get_auth_plugin($authname);
 335     $potentialidps = array_merge($potentialidps, $authplugin->loginpage_idp_list($SESSION->wantsurl));
 336 }
 337
 338 $PAGE->set_title("$site->fullname: $loginsite");
 339 $PAGE->set_heading("$site->fullname");
 340
 341 echo $OUTPUT->header();
 342
 343 if (isloggedin() and !isguestuser()) {
 344     // prevent logging when already logged in, we do not want them to relogin by accident because sesskey would be changed
 345     echo $OUTPUT->box_start();
 346     $logout = new single_button(new moodle_url($CFG->httpswwwroot.'/login/logout.php', array('sesskey'=>sesskey(),'loginpage'=>1)), get_string('logout'), 'post');
 347     $continue = new single_button(new moodle_url($CFG->httpswwwroot.'/login/index.php', array('cancel'=>1)), get_string('cancel'), 'get');
 348     echo $OUTPUT->confirm(get_string('alreadyloggedin', 'error', fullname($USER)), $logout, $continue);
 349     echo $OUTPUT->box_end();
 350 } else {
 351     include("index_form.html");
 352     if ($errormsg) {
 353         $PAGE->requires->js_init_call('M.util.focus_login_error', null, true);
 354     } else if (!empty($CFG->loginpageautofocus)) {
 355         //focus username or password
 356         $PAGE->requires->js_init_call('M.util.focus_login_form', null, true);
 357     }
 358 }
 359
 360 echo $OUTPUT->footer();