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;
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 ucFirst($name) != $u->getName() )
213 $this->mainLoginForm( wfMsg( 'noname' ) );
216 if ( wfReadOnly() ) {
217 $wgOut->readOnlyPage();
221 if ( 0 != $u->idForName() ) {
222 $this->mainLoginForm( wfMsg( 'userexists' ) );
226 if ( strlen( $this->mPassword
) < $wgMinimalPasswordLength ) {
227 $this->mainLoginForm( wfMsg( 'passwordtooshort', $wgMinimalPasswordLength ) );
231 if ( $wgAccountCreationThrottle ) {
232 $key = $wgDBname.':acctcreate:ip:'.$wgIP;
233 $value = $wgMemc->incr( $key );
235 $wgMemc->set( $key, 1, 86400 );
237 if ( $value > $wgAccountCreationThrottle ) {
238 $this->throttleHit( $wgAccountCreationThrottle );
243 return $this->initUser( $u );
247 * Actually add a user to the database.
248 * Give it a User object that has been initialised with a name.
254 function &initUser( &$u ) {
256 $u->setPassword( $this->mPassword
);
257 $u->setEmail( $this->mEmail
);
258 $u->setRealName( $this->mRealName
);
261 $wgAuth->initUser( $u );
263 if ( $this->mRemember
) { $r = 1; }
265 $u->setOption( 'rememberpassword', $r );
273 function processLogin() {
274 global $wgUser, $wgLang;
275 global $wgEmailAuthentication;
277 if ( '' == $this->mName
) {
278 $this->mainLoginForm( wfMsg( 'noname' ) );
281 $u = User
::newFromName( $this->mName
);
282 if( is_null( $u ) ) {
283 $this->mainLoginForm( wfMsg( 'noname' ) );
286 if ( 0 == $u->getID() ) {
289 * If the external authentication plugin allows it,
290 * automatically create a new account for users that
291 * are externally defined but have not yet logged in.
293 if( $wgAuth->autoCreate() &&
294 $wgAuth->userExists( $u->getName() ) &&
295 $wgAuth->authenticate( $u->getName(), $this->mPassword
) ) {
296 $u =& $this->initUser( $u );
298 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
302 $u->loadFromDatabase();
305 # store temporarily the status before the password check is performed
307 $oldadr = strtolower($u->getEmail());
308 $newadr = strtolower($this->mEmail
);
309 $alreadyauthenticated = (( $u->mEmailAuthenticationtimestamp
!= 0 ) ||
($oldadr == '')) ;
311 # checkPassword sets EmailAuthenticationtimestamp, if the newPassword is used
313 if (!$u->checkPassword( $this->mPassword
)) {
314 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
318 # We've verified now, update the real record
320 if ( $this->mRemember
) {
325 $u->setOption( 'rememberpassword', $r );
327 /* check if user with correct password has entered a new email address */
328 if (($newadr <> '') && ($newadr <> $oldadr)) { # the user supplied a new email address on the login page
330 # prepare for authentication and mail a temporary password to newadr
331 if ( !$u->isValidEmailAddr( $newadr ) ) {
332 return $this->mainLoginForm( wfMsg( 'invalidemailaddress', $error ) );
334 $u->mEmail
= $newadr; # new behaviour: store this new emailaddr from login-page now into user database record ...
335 $u->mEmailAuthenticationtimestamp
= 0; # ... but flag the address as "dirty" (unauthenticated)
336 $alreadyauthenticated = false;
338 if ($wgEmailAuthentication) {
340 # mail a temporary one-time password to the dirty address and return here to complete the user login
341 # if the user returns now or later using this temp. password, then the new email address $newadr
342 # - which is already stored in his user record - gets authenticated in checkpassword()
344 $error = $this->mailPasswordInternal( $u, false, $newpassword_temp);
345 $u->mNewpassword
= $newpassword_temp;
347 # The temporary password is mailed. The user is logged-in as he entered his correct password
348 # This appears to be more intuitive than alternative 2.
351 $mailmsg = '<br />' . wfMsg( 'passwordsentforemailauthentication', $u->getName() );
353 $mailmsg = '<br />' . wfMsg( 'mailerror', $error ) ;
359 $wgUser->setCookies();
361 # save all settings (incl. new email address and/or temporary password, if applicable)
362 $wgUser->saveSettings();
364 if ( !$wgEmailAuthentication ||
$alreadyauthenticated ) {
367 } elseif ($u->mEmailAuthenticationtimestamp
!= 0) {
368 $authenticated = ' ' . wfMsg( 'emailauthenticated', $wgLang->timeanddate( $u->mEmailAuthenticationtimestamp
, true ) );
370 $authenticated = ' ' . wfMsg( 'emailnotauthenticated' );
373 if( $this->hasSessionCookie() ) {
374 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) . $authenticated . $mailmsg );
376 return $this->cookieRedirectCheck( 'login' );
383 function mailPassword() {
384 global $wgUser, $wgDeferredUpdateList, $wgOutputEncoding;
385 global $wgCookiePath, $wgCookieDomain, $wgDBname;
387 if ( '' == $this->mName
) {
388 $this->mainLoginForm( wfMsg( 'noname' ) );
391 $u = User
::newFromName( $this->mName
);
392 if( is_null( $u ) ) {
393 $this->mainLoginForm( wfMsg( 'noname' ) );
396 if ( 0 == $u->getID() ) {
397 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
401 $u->loadFromDatabase();
403 $error = $this->mailPasswordInternal( $u, true, $dummy );
405 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ) );
407 $this->mainLoginForm( wfMsg( 'mailerror', $error ) );
416 function mailPasswordInternal( $u, $savesettings = true, &$newpassword_out ) {
417 global $wgPasswordSender, $wgDBname, $wgIP;
418 global $wgCookiePath, $wgCookieDomain;
420 if ( '' == $u->getEmail() ) {
421 return wfMsg( 'noemail', $u->getName() );
424 $np = $u->randomPassword();
425 $u->setNewpassword( $np );
427 # we want to store this new password together with other values in the calling function
428 $newpassword_out = $u->mNewpassword
;
430 # WHY IS THIS HERE ? SHOULDN'T IT BE User::setcookie ???
431 setcookie( "{$wgDBname}Token", '', time() - 3600, $wgCookiePath, $wgCookieDomain );
438 if ( '' == $ip ) { $ip = '(Unknown)'; }
440 $m = wfMsg( 'passwordremindermailbody', $ip, $u->getName(), wfUrlencode($u->getName()), $np );
442 require_once('UserMailer.php');
443 $error = userMailer( $u->getEmail(), $wgPasswordSender, wfMsg( 'passwordremindermailsubject' ), $m );
445 return htmlspecialchars( $error );
452 function successfulLogin( $msg ) {
456 # Run any hooks; ignore results
458 wfRunHooks('UserLoginComplete', $wgUser);
460 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
461 $wgOut->setRobotpolicy( 'noindex,nofollow' );
462 $wgOut->setArticleRelated( false );
463 $wgOut->addWikiText( $msg );
464 $wgOut->returnToMain();
467 function userNotPrivilegedMessage() {
468 global $wgOut, $wgUser, $wgLang;
470 $wgOut->setPageTitle( wfMsg( 'whitelistacctitle' ) );
471 $wgOut->setRobotpolicy( 'noindex,nofollow' );
472 $wgOut->setArticleRelated( false );
474 $wgOut->addWikiText( wfMsg( 'whitelistacctext' ) );
476 $wgOut->returnToMain( false );
482 function mainLoginForm( $err ) {
483 global $wgUser, $wgOut, $wgLang;
484 global $wgDBname, $wgAllowRealName, $wgEnableEmail;
485 global $wgEmailAuthentication;
487 if ( '' == $this->mName
) {
488 if ( 0 != $wgUser->getID() ) {
489 $this->mName
= $wgUser->getName();
491 $this->mName
= @$_COOKIE[$wgDBname.'UserName'];
495 $q = 'action=submit';
496 if ( !empty( $this->mReturnto
) ) {
497 $q .= '&returnto=' . wfUrlencode( $this->mReturnto
);
499 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Userlogin' );
501 require_once( 'templates/Userlogin.php' );
502 $template =& new UserloginTemplate();
504 $template->set( 'name', $this->mName
);
505 $template->set( 'password', $this->mPassword
);
506 $template->set( 'retype', $this->mRetype
);
507 $template->set( 'email', $this->mEmail
);
508 $template->set( 'realname', $this->mRealName
);
510 $template->set( 'action', $titleObj->getLocalUrl( $q ) );
511 $template->set( 'error', $err );
512 $template->set( 'create', $wgUser->isAllowedToCreateAccount() );
513 $template->set( 'createemail', $wgEnableEmail && ($wgUser->getID() != 0) );
514 $template->set( 'userealname', $wgAllowRealName );
515 $template->set( 'useemail', $wgEnableEmail );
516 $template->set( 'useemailauthent', $wgEmailAuthentication );
517 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) );
519 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
520 $wgOut->setRobotpolicy( 'noindex,nofollow' );
521 $wgOut->setArticleRelated( false );
522 $wgOut->addTemplate( $template );
528 function hasSessionCookie() {
529 global $wgDisableCookieCheck;
530 return ( $wgDisableCookieCheck ) ?
true : ( '' != $_COOKIE[session_name()] );
536 function cookieRedirectCheck( $type ) {
537 global $wgOut, $wgLang;
539 $titleObj = Title
::makeTitle( NS_SPECIAL
, 'Userlogin' );
540 $check = $titleObj->getFullURL( 'wpCookieCheck='.$type );
542 return $wgOut->redirect( $check );
548 function onCookieRedirectCheck( $type ) {
551 if ( !$this->hasSessionCookie() ) {
552 if ( $type == 'new' ) {
553 return $this->mainLoginForm( wfMsg( 'nocookiesnew' ) );
554 } else if ( $type == 'login' ) {
555 return $this->mainLoginForm( wfMsg( 'nocookieslogin' ) );
558 return $this->mainLoginForm( wfMsg( 'error' ) );
561 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
568 function throttleHit( $limit ) {
571 $wgOut->addWikiText( wfMsg( 'acct_creation_throttle_hit', $limit ) );