5 * @subpackage SpecialPage
11 function wfSpecialUserlogin() {
12 global $wgCommandLineMode;
14 if( !$wgCommandLineMode && !isset( $_COOKIE[ini_get('session.name')] ) ) {
18 $form = new LoginForm( $wgRequest );
25 * @subpackage SpecialPage
28 var $mName, $mPassword, $mRetype, $mReturnto, $mCookieCheck, $mPosted;
29 var $mAction, $mCreateaccount, $mCreateaccountMail, $mMailmypassword;
30 var $mLoginattempt, $mRemember, $mEmail;
32 function LoginForm( &$request ) {
33 global $wgLang, $wgAllowRealName, $wgEnableEmail;
34 global $wgEmailAuthentication;
36 $this->mName
= $request->getText( 'wpName' );
37 $this->mPassword
= $request->getText( 'wpPassword' );
38 $this->mRetype
= $request->getText( 'wpRetype' );
39 $this->mReturnto
= $request->getVal( 'returnto' );
40 $this->mCookieCheck
= $request->getVal( 'wpCookieCheck' );
41 $this->mPosted
= $request->wasPosted();
42 $this->mCreateaccount
= $request->getCheck( 'wpCreateaccount' );
43 $this->mCreateaccountMail
= $request->getCheck( 'wpCreateaccountMail' )
45 $this->mMailmypassword
= $request->getCheck( 'wpMailmypassword' )
47 $this->mLoginattempt
= $request->getCheck( 'wpLoginattempt' );
48 $this->mAction
= $request->getVal( 'action' );
49 $this->mRemember
= $request->getCheck( 'wpRemember' );
51 if( $wgEnableEmail ) {
52 $this->mEmail
= $request->getText( 'wpEmail' );
56 if( $wgAllowRealName ) {
57 $this->mRealName
= $request->getText( 'wpRealName' );
59 $this->mRealName
= '';
62 # When switching accounts, it sucks to get automatically logged out
63 if( $this->mReturnto
== $wgLang->specialPage( 'Userlogout' ) ) {
64 $this->mReturnto
= '';
69 if ( !is_null( $this->mCookieCheck
) ) {
70 $this->onCookieRedirectCheck( $this->mCookieCheck
);
72 } else if( $this->mPosted
) {
73 if( $this->mCreateaccount
) {
74 return $this->addNewAccount();
75 } else if ( $this->mCreateaccountMail
) {
76 return $this->addNewAccountMailPassword();
77 } else if ( $this->mMailmypassword
) {
78 return $this->mailPassword();
79 } else if ( ( 'submit' == $this->mAction
) ||
$this->mLoginattempt
) {
80 return $this->processLogin();
83 $this->mainLoginForm( '' );
89 function addNewAccountMailPassword() {
91 global $wgEmailAuthentication;
93 if ('' == $this->mEmail
) {
94 $this->mainLoginForm( wfMsg( 'noemail', htmlspecialchars( $this->mName
) ) );
98 $u = $this->addNewaccountInternal();
104 $newadr = strtolower($this->mEmail
);
106 # prepare for authentication and mail a temporary password to newadr
107 if ( !$u->isValidEmailAddr( $newadr ) ) {
108 return $this->mainLoginForm( wfMsg( 'invalidemailaddress', $error ) );
110 $u->mEmail
= $newadr; # new behaviour: set this new emailaddr from login-page into user database record
111 $u->mEmailAuthenticationtimestamp
= 0; # but flag as "dirty" = unauthenticated
113 if ($wgEmailAuthentication) {
114 $error = $this->mailPasswordInternal( $u, true, $dummy ); # mail a temporary password to the dirty address
117 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
118 $wgOut->setRobotpolicy( 'noindex,nofollow' );
119 $wgOut->setArticleRelated( false );
121 if ($wgEmailAuthentication) {
123 return $this->mainLoginForm( wfMsg( 'passwordsentforemailauthentication', $u->getName() ) );
125 return $this->mainLoginForm( wfMsg( 'mailerror', $error ) );
127 # if user returns, that new email address gets authenticated in checkpassword()
129 # if ( $error === '' ) {
130 # $wgOut->addWikiText( wfMsg( 'accmailtext', $u->getName(), $u->getEmail() ) );
131 # $wgOut->returnToMain( false );
133 # $this->mainLoginForm( wfMsg( 'mailerror', $error ) );
142 function addNewAccount() {
143 global $wgUser, $wgOut;
144 global $wgEmailAuthentication;
146 $u = $this->addNewAccountInternal();
152 $newadr = strtolower($this->mEmail
);
153 if ($newadr != '') { # prepare for authentication and mail a temporary password to newadr
154 if ( !$u->isValidEmailAddr( $newadr ) ) {
155 return $this->mainLoginForm( wfMsg( 'invalidemailaddress', $error ) );
157 $u->mEmail
= $newadr; # new behaviour: set this new emailaddr from login-page into user database record
158 $u->mEmailAuthenticationtimestamp
= 0; # but flag as "dirty" = unauthenticated
160 if ($wgEmailAuthentication) {
161 # mail a temporary password to the dirty address
163 $error = $this->mailPasswordInternal( $u, true, $dummy );
165 return $this->mainLoginForm( wfMsg( 'passwordsentforemailauthentication', $u->getName() ) );
167 return $this->mainLoginForm( wfMsg( 'mailerror', $error ) );
169 # if user returns, that new email address gets authenticated in checkpassword()
174 $wgUser->setCookies();
176 $wgUser->saveSettings();
178 if( $this->hasSessionCookie() ) {
179 return $this->successfulLogin( wfMsg( 'welcomecreation', $wgUser->getName() ) );
181 return $this->cookieRedirectCheck( 'new' );
188 function addNewAccountInternal() {
189 global $wgUser, $wgOut;
190 global $wgMaxNameChars, $wgUseLatin1;
191 global $wgMemc, $wgAccountCreationThrottle, $wgDBname, $wgIP;
192 global $wgMinimalPasswordLength;
194 if (!$wgUser->isAllowedToCreateAccount()) {
195 $this->userNotPrivilegedMessage();
199 if ( 0 != strcmp( $this->mPassword
, $this->mRetype
) ) {
200 $this->mainLoginForm( wfMsg( 'badretype' ) );
204 $name = trim( $this->mName
);
205 $u = User
::newFromName( $name );
206 if ( is_null( $u ) ||
208 $wgUser->isIP( $name ) ||
209 (strpos( $name, "/" ) !== false) ||
210 (strlen( $name ) > $wgMaxNameChars) ||
211 ($wgUseLatin1 && preg_match( "/[\x80-\xA0]/", $name )) ||
212 ucFirst($name) != $u->getName() )
214 $this->mainLoginForm( wfMsg( 'noname' ) );
217 if ( wfReadOnly() ) {
218 $wgOut->readOnlyPage();
222 if ( 0 != $u->idForName() ) {
223 $this->mainLoginForm( wfMsg( 'userexists' ) );
227 if ( strlen( $this->mPassword
) < $wgMinimalPasswordLength ) {
228 $this->mainLoginForm( wfMsg( 'passwordtooshort', $wgMinimalPasswordLength ) );
232 if ( $wgAccountCreationThrottle ) {
233 $key = $wgDBname.':acctcreate:ip:'.$wgIP;
234 $value = $wgMemc->incr( $key );
236 $wgMemc->set( $key, 1, 86400 );
238 if ( $value > $wgAccountCreationThrottle ) {
239 $this->throttleHit( $wgAccountCreationThrottle );
244 return $this->initUser( $u );
248 * Actually add a user to the database.
249 * Give it a User object that has been initialised with a name.
255 function &initUser( &$u ) {
257 $u->setPassword( $this->mPassword
);
258 $u->setEmail( $this->mEmail
);
259 $u->setRealName( $this->mRealName
);
262 $wgAuth->initUser( $u );
264 if ( $this->mRemember
) { $r = 1; }
266 $u->setOption( 'rememberpassword', $r );
274 function processLogin() {
275 global $wgUser, $wgLang;
276 global $wgEmailAuthentication;
278 if ( '' == $this->mName
) {
279 $this->mainLoginForm( wfMsg( 'noname' ) );
282 $u = User
::newFromName( $this->mName
);
283 if( is_null( $u ) ) {
284 $this->mainLoginForm( wfMsg( 'noname' ) );
287 if ( 0 == $u->getID() ) {
290 * If the external authentication plugin allows it,
291 * automatically create a new account for users that
292 * are externally defined but have not yet logged in.
294 if( $wgAuth->autoCreate() &&
295 $wgAuth->userExists( $u->getName() ) &&
296 $wgAuth->authenticate( $u->getName(), $this->mPassword
) ) {
297 $u =& $this->initUser( $u );
299 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
303 $u->loadFromDatabase();
306 # store temporarily the status before the password check is performed
308 $oldadr = strtolower($u->getEmail());
309 $newadr = strtolower($this->mEmail
);
310 $alreadyauthenticated = (( $u->mEmailAuthenticationtimestamp
!= 0 ) ||
($oldadr == '')) ;
312 # checkPassword sets EmailAuthenticationtimestamp, if the newPassword is used
314 if (!$u->checkPassword( $this->mPassword
)) {
315 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
319 # We've verified now, update the real record
321 if ( $this->mRemember
) {
326 $u->setOption( 'rememberpassword', $r );
328 /* check if user with correct password has entered a new email address */
329 if (($newadr <> '') && ($newadr <> $oldadr)) { # the user supplied a new email address on the login page
331 # prepare for authentication and mail a temporary password to newadr
332 if ( !$u->isValidEmailAddr( $newadr ) ) {
333 return $this->mainLoginForm( wfMsg( 'invalidemailaddress', $error ) );
335 $u->mEmail
= $newadr; # new behaviour: store this new emailaddr from login-page now into user database record ...
336 $u->mEmailAuthenticationtimestamp
= 0; # ... but flag the address as "dirty" (unauthenticated)
337 $alreadyauthenticated = false;
339 if ($wgEmailAuthentication) {
341 # mail a temporary one-time password to the dirty address and return here to complete the user login
342 # if the user returns now or later using this temp. password, then the new email address $newadr
343 # - which is already stored in his user record - gets authenticated in checkpassword()
345 $error = $this->mailPasswordInternal( $u, false, $newpassword_temp);
346 $u->mNewpassword
= $newpassword_temp;
348 # The temporary password is mailed. The user is logged-in as he entered his correct password
349 # This appears to be more intuitive than alternative 2.
352 $mailmsg = '<br />' . wfMsg( 'passwordsentforemailauthentication', $u->getName() );
354 $mailmsg = '<br />' . wfMsg( 'mailerror', $error ) ;
360 $wgUser->setCookies();
362 # save all settings (incl. new email address and/or temporary password, if applicable)
363 $wgUser->saveSettings();
365 if ( !$wgEmailAuthentication ||
$alreadyauthenticated ) {
368 } elseif ($u->mEmailAuthenticationtimestamp
!= 0) {
369 $authenticated = ' ' . wfMsg( 'emailauthenticated', $wgLang->timeanddate( $u->mEmailAuthenticationtimestamp
, true ) );
371 $authenticated = ' ' . wfMsg( 'emailnotauthenticated' );
374 if( $this->hasSessionCookie() ) {
375 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) . $authenticated . $mailmsg );
377 return $this->cookieRedirectCheck( 'login' );
384 function mailPassword() {
385 global $wgUser, $wgDeferredUpdateList, $wgOutputEncoding;
386 global $wgCookiePath, $wgCookieDomain, $wgDBname;
388 if ( '' == $this->mName
) {
389 $this->mainLoginForm( wfMsg( 'noname' ) );
392 $u = User
::newFromName( $this->mName
);
393 if( is_null( $u ) ) {
394 $this->mainLoginForm( wfMsg( 'noname' ) );
397 if ( 0 == $u->getID() ) {
398 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
402 $u->loadFromDatabase();
404 $error = $this->mailPasswordInternal( $u, true, $dummy );
406 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ) );
408 $this->mainLoginForm( wfMsg( 'mailerror', $error ) );
417 function mailPasswordInternal( $u, $savesettings = true, &$newpassword_out ) {
418 global $wgPasswordSender, $wgDBname, $wgIP;
419 global $wgCookiePath, $wgCookieDomain;
421 if ( '' == $u->getEmail() ) {
422 return wfMsg( 'noemail', $u->getName() );
425 $np = $u->randomPassword();
426 $u->setNewpassword( $np );
428 # we want to store this new password together with other values in the calling function
429 $newpassword_out = $u->mNewpassword
;
431 # WHY IS THIS HERE ? SHOULDN'T IT BE User::setcookie ???
432 setcookie( "{$wgDBname}Token", '', time() - 3600, $wgCookiePath, $wgCookieDomain );
439 if ( '' == $ip ) { $ip = '(Unknown)'; }
441 $m = wfMsg( 'passwordremindermailbody', $ip, $u->getName(), wfUrlencode($u->getName()), $np );
443 require_once('UserMailer.php');
444 $error = userMailer( $u->getEmail(), $wgPasswordSender, wfMsg( 'passwordremindermailsubject' ), $m );
446 return htmlspecialchars( $error );
453 function successfulLogin( $msg ) {
457 # Run any hooks; ignore results
459 wfRunHooks('UserLoginComplete', $wgUser);
461 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
462 $wgOut->setRobotpolicy( 'noindex,nofollow' );
463 $wgOut->setArticleRelated( false );
464 $wgOut->addWikiText( $msg );
465 $wgOut->returnToMain();
468 function userNotPrivilegedMessage() {
469 global $wgOut, $wgUser, $wgLang;
471 $wgOut->setPageTitle( wfMsg( 'whitelistacctitle' ) );
472 $wgOut->setRobotpolicy( 'noindex,nofollow' );
473 $wgOut->setArticleRelated( false );
475 $wgOut->addWikiText( wfMsg( 'whitelistacctext' ) );
477 $wgOut->returnToMain( false );
483 function mainLoginForm( $err ) {
484 global $wgUser, $wgOut, $wgLang;
485 global $wgDBname, $wgAllowRealName, $wgEnableEmail;
486 global $wgEmailAuthentication;
488 if ( '' == $this->mName
) {
489 if ( $wgUser->isLoggedIn() ) {
490 $this->mName
= $wgUser->getName();
492 $this->mName
= @$_COOKIE[$wgDBname.'UserName'];
496 $q = 'action=submit';
497 if ( !empty( $this->mReturnto
) ) {
498 $q .= '&returnto=' . wfUrlencode( $this->mReturnto
);
500 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Userlogin' );
502 require_once( 'templates/Userlogin.php' );
503 $template =& new UserloginTemplate();
505 $template->set( 'name', $this->mName
);
506 $template->set( 'password', $this->mPassword
);
507 $template->set( 'retype', $this->mRetype
);
508 $template->set( 'email', $this->mEmail
);
509 $template->set( 'realname', $this->mRealName
);
511 $template->set( 'action', $titleObj->getLocalUrl( $q ) );
512 $template->set( 'error', $err );
513 $template->set( 'create', $wgUser->isAllowedToCreateAccount() );
514 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
515 $template->set( 'userealname', $wgAllowRealName );
516 $template->set( 'useemail', $wgEnableEmail );
517 $template->set( 'useemailauthent', $wgEmailAuthentication );
518 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) );
520 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
521 $wgOut->setRobotpolicy( 'noindex,nofollow' );
522 $wgOut->setArticleRelated( false );
523 $wgOut->addTemplate( $template );
529 function hasSessionCookie() {
530 global $wgDisableCookieCheck;
531 return ( $wgDisableCookieCheck ) ?
true : ( '' != $_COOKIE[session_name()] );
537 function cookieRedirectCheck( $type ) {
538 global $wgOut, $wgLang;
540 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Userlogin' );
541 $check = $titleObj->getFullURL( 'wpCookieCheck='.$type );
543 return $wgOut->redirect( $check );
549 function onCookieRedirectCheck( $type ) {
552 if ( !$this->hasSessionCookie() ) {
553 if ( $type == 'new' ) {
554 return $this->mainLoginForm( wfMsg( 'nocookiesnew' ) );
555 } else if ( $type == 'login' ) {
556 return $this->mainLoginForm( wfMsg( 'nocookieslogin' ) );
559 return $this->mainLoginForm( wfMsg( 'error' ) );
562 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
569 function throttleHit( $limit ) {
572 $wgOut->addWikiText( wfMsg( 'acct_creation_throttle_hit', $limit ) );