5 * @subpackage SpecialPage
11 function wfSpecialUserlogin() {
12 global $wgCommandLineMode;
14 if( !$wgCommandLineMode && !isset( $_COOKIE[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, $mDomain;
34 * @param webrequest $request A webrequest object passed by reference
36 function LoginForm( &$request ) {
37 global $wgLang, $wgAllowRealName, $wgEnableEmail;
40 $this->mName = $request->getText( 'wpName' );
41 $this->mPassword = $request->getText( 'wpPassword' );
42 $this->mRetype = $request->getText( 'wpRetype' );
43 $this->mDomain = $request->getText( 'wpDomain' );
44 $this->mReturnto = $request->getVal( 'returnto' );
45 $this->mCookieCheck = $request->getVal( 'wpCookieCheck' );
46 $this->mPosted = $request->wasPosted();
47 $this->mCreateaccount = $request->getCheck( 'wpCreateaccount' );
48 $this->mCreateaccountMail = $request->getCheck( 'wpCreateaccountMail' )
50 $this->mMailmypassword = $request->getCheck( 'wpMailmypassword' )
52 $this->mLoginattempt = $request->getCheck( 'wpLoginattempt' );
53 $this->mAction = $request->getVal( 'action' );
54 $this->mRemember = $request->getCheck( 'wpRemember' );
56 if( $wgEnableEmail ) {
57 $this->mEmail = $request->getText( 'wpEmail' );
61 if( $wgAllowRealName ) {
62 $this->mRealName = $request->getText( 'wpRealName' );
64 $this->mRealName = '';
67 if( !$wgAuth->validDomain( $this->mDomain ) ) {
68 $this->mDomain = 'invaliddomain';
70 $wgAuth->setDomain( $this->mDomain );
72 # When switching accounts, it sucks to get automatically logged out
73 if( $this->mReturnto == $wgLang->specialPage( 'Userlogout' ) ) {
74 $this->mReturnto = '';
79 if ( !is_null( $this->mCookieCheck ) ) {
80 $this->onCookieRedirectCheck( $this->mCookieCheck );
82 } else if( $this->mPosted ) {
83 if( $this->mCreateaccount ) {
84 return $this->addNewAccount();
85 } else if ( $this->mCreateaccountMail ) {
86 return $this->addNewAccountMailPassword();
87 } else if ( $this->mMailmypassword ) {
88 return $this->mailPassword();
89 } else if ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) {
90 return $this->processLogin();
93 $this->mainLoginForm( '' );
99 function addNewAccountMailPassword() {
102 if ('' == $this->mEmail) {
103 $this->mainLoginForm( wfMsg( 'noemail', htmlspecialchars( $this->mName ) ) );
107 $u = $this->addNewaccountInternal();
114 $result = $this->mailPasswordInternal($u);
116 $wgOut->setPageTitle( wfMsg( 'accmailtitle' ) );
117 $wgOut->setRobotpolicy( 'noindex,nofollow' );
118 $wgOut->setArticleRelated( false );
120 if( WikiError::isError( $result ) ) {
121 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
123 $wgOut->addWikiText( wfMsg( 'accmailtext', $u->getName(), $u->getEmail() ) );
124 $wgOut->returnToMain( false );
133 function addNewAccount() {
134 global $wgUser, $wgOut, $wgEmailAuthentication;
136 $u = $this->addNewAccountInternal();
143 $wgUser->setCookies();
145 $wgUser->saveSettings();
146 if( $wgEmailAuthentication && $wgUser->isValidEmailAddr( $wgUser->getEmail() ) ) {
147 $wgUser->sendConfirmationMail();
150 wfRunHooks( 'AddNewAccount' );
152 if( $this->hasSessionCookie() ) {
153 return $this->successfulLogin( wfMsg( 'welcomecreation', $wgUser->getName() ) );
155 return $this->cookieRedirectCheck( 'new' );
162 function addNewAccountInternal() {
163 global $wgUser, $wgOut;
164 global $wgUseLatin1, $wgEnableSorbs, $wgProxyWhitelist;
165 global $wgMemc, $wgAccountCreationThrottle, $wgDBname, $wgIP;
168 // If the user passes an invalid domain, something is fishy
169 if( !$wgAuth->validDomain( $this->mDomain ) ) {
170 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
174 // If we are not allowing users to login locally, we should
175 // be checking to see if the user is actually able to
176 // authenticate to the authentication server before they
177 // create an account (otherwise, they can create a local account
178 // and login as any domain user). We only need to check this for
179 // domains that aren't local.
180 if( 'local' != $this->mDomain && '' != $this->mDomain ) {
181 if( !$wgAuth->canCreateAccounts() && ( !$wgAuth->userExists( $this->mName ) || !$wgAuth->authenticate( $this->mName, $this->mPassword ) ) ) {
182 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
187 if (!$wgUser->isAllowedToCreateAccount()) {
188 $this->userNotPrivilegedMessage();
192 if ( $wgEnableSorbs && !in_array( $wgIP, $wgProxyWhitelist ) &&
193 $wgUser->inSorbsBlacklist( $wgIP ) )
195 $this->mainLoginForm( wfMsg( 'sorbs_create_account_reason' ) . ' (' . htmlspecialchars( $wgIP ) . ')' );
200 if ( 0 != strcmp( $this->mPassword, $this->mRetype ) ) {
201 $this->mainLoginForm( wfMsg( 'badretype' ) );
205 $name = trim( $this->mName );
206 $u = User::newFromName( $name );
207 if ( is_null( $u ) ) {
208 $this->mainLoginForm( wfMsg( 'noname' ) );
212 if ( wfReadOnly() ) {
213 $wgOut->readOnlyPage();
217 if ( 0 != $u->idForName() ) {
218 $this->mainLoginForm( wfMsg( 'userexists' ) );
222 if ( !$wgUser->isValidPassword( $this->mPassword ) ) {
223 $this->mainLoginForm( wfMsg( 'passwordtooshort', $wgMinimalPasswordLength ) );
227 if ( $wgAccountCreationThrottle ) {
228 $key = $wgDBname.':acctcreate:ip:'.$wgIP;
229 $value = $wgMemc->incr( $key );
231 $wgMemc->set( $key, 1, 86400 );
233 if ( $value > $wgAccountCreationThrottle ) {
234 $this->throttleHit( $wgAccountCreationThrottle );
240 if( !wfRunHooks( 'AbortNewAccount', array( $u, &$abortError ) ) ) {
241 wfDebug( "LoginForm::addNewAccountInternal: a hook blocked creation\n" );
242 $this->mainLoginForm( $abortError );
246 if( !$wgAuth->addUser( $u, $this->mPassword ) ) {
247 $this->mainLoginForm( wfMsg( 'externaldberror' ) );
252 $ssUpdate = new SiteStatsUpdate( 0, 0, 0, 0, 1 );
253 $ssUpdate->doUpdate();
255 return $this->initUser( $u );
259 * Actually add a user to the database.
260 * Give it a User object that has been initialised with a name.
266 function &initUser( &$u ) {
268 $u->setPassword( $this->mPassword );
269 $u->setEmail( $this->mEmail );
270 $u->setRealName( $this->mRealName );
274 $wgAuth->initUser( $u );
276 if ( $this->mRemember ) { $r = 1; }
278 $u->setOption( 'rememberpassword', $r );
286 function processLogin() {
290 if ( '' == $this->mName ) {
291 $this->mainLoginForm( wfMsg( 'noname' ) );
294 $u = User::newFromName( $this->mName );
295 if( is_null( $u ) ) {
296 $this->mainLoginForm( wfMsg( 'noname' ) );
299 if ( 0 == $u->getID() ) {
302 * If the external authentication plugin allows it,
303 * automatically create a new account for users that
304 * are externally defined but have not yet logged in.
306 if ( $wgAuth->autoCreate() && $wgAuth->userExists( $u->getName() ) ) {
307 if ( $wgAuth->authenticate( $u->getName(), $this->mPassword ) ) {
308 $u =& $this->initUser( $u );
310 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
314 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
318 $u->loadFromDatabase();
321 if (!$u->checkPassword( $this->mPassword )) {
322 $this->mainLoginForm( wfMsg( 'wrongpassword' ) );
326 # We've verified now, update the real record
328 if ( $this->mRemember ) {
333 $u->setOption( 'rememberpassword', $r );
335 $wgAuth->updateUser( $u );
338 $wgUser->setCookies();
340 $wgUser->saveSettings();
342 if( $this->hasSessionCookie() ) {
343 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
345 return $this->cookieRedirectCheck( 'login' );
352 function mailPassword() {
353 global $wgUser, $wgDeferredUpdateList, $wgOutputEncoding;
354 global $wgCookiePath, $wgCookieDomain, $wgDBname;
356 if ( '' == $this->mName ) {
357 $this->mainLoginForm( wfMsg( 'noname' ) );
360 $u = User::newFromName( $this->mName );
361 if( is_null( $u ) ) {
362 $this->mainLoginForm( wfMsg( 'noname' ) );
365 if ( 0 == $u->getID() ) {
366 $this->mainLoginForm( wfMsg( 'nosuchuser', $u->getName() ) );
370 $u->loadFromDatabase();
372 $result = $this->mailPasswordInternal( $u );
373 if( WikiError::isError( $result ) ) {
374 $this->mainLoginForm( wfMsg( 'mailerror', $result->getMessage() ) );
376 $this->mainLoginForm( wfMsg( 'passwordsent', $u->getName() ) );
382 * @return mixed true on success, WikiError on failure
385 function mailPasswordInternal( $u ) {
386 global $wgPasswordSender, $wgIP;
387 global $wgCookiePath, $wgCookieDomain, $wgCookiePrefix;
389 if ( '' == $u->getEmail() ) {
390 return wfMsg( 'noemail', $u->getName() );
393 $np = $u->randomPassword();
394 $u->setNewpassword( $np );
396 setcookie( "{$wgCookiePrefix}Token", '', time() - 3600, $wgCookiePath, $wgCookieDomain );
401 if ( '' == $ip ) { $ip = '(Unknown)'; }
403 $m = wfMsg( 'passwordremindertext', $ip, $u->getName(), $np );
405 $result = $u->sendMail( wfMsg( 'passwordremindertitle' ), $m );
411 * @param string $msg Message that will be shown on success.
414 function successfulLogin( $msg ) {
418 # Run any hooks; ignore results
420 wfRunHooks('UserLoginComplete', array(&$wgUser));
422 $wgOut->setPageTitle( wfMsg( 'loginsuccesstitle' ) );
423 $wgOut->setRobotpolicy( 'noindex,nofollow' );
424 $wgOut->setArticleRelated( false );
425 $wgOut->addWikiText( $msg );
426 $wgOut->returnToMain();
430 function userNotPrivilegedMessage() {
433 $wgOut->setPageTitle( wfMsg( 'whitelistacctitle' ) );
434 $wgOut->setRobotpolicy( 'noindex,nofollow' );
435 $wgOut->setArticleRelated( false );
437 $wgOut->addWikiText( wfMsg( 'whitelistacctext' ) );
439 $wgOut->returnToMain( false );
445 function mainLoginForm( $err ) {
446 global $wgUser, $wgOut, $wgLang;
447 global $wgAllowRealName, $wgEnableEmail;
448 global $wgCookiePrefix;
451 if ( '' == $this->mName ) {
452 if ( $wgUser->isLoggedIn() ) {
453 $this->mName = $wgUser->getName();
455 $this->mName = @$_COOKIE[$wgCookiePrefix.'UserName'];
459 $q = 'action=submitlogin';
460 if ( !empty( $this->mReturnto ) ) {
461 $q .= '&returnto=' . wfUrlencode( $this->mReturnto );
463 $titleObj = Title::makeTitle( NS_SPECIAL, 'Userlogin' );
465 require_once( 'templates/Userlogin.php' );
466 $template =& new UserloginTemplate();
468 $template->set( 'name', $this->mName );
469 $template->set( 'password', $this->mPassword );
470 $template->set( 'retype', $this->mRetype );
471 $template->set( 'email', $this->mEmail );
472 $template->set( 'realname', $this->mRealName );
473 $template->set( 'domain', $this->mDomain );
475 $template->set( 'action', $titleObj->getLocalUrl( $q ) );
476 $template->set( 'error', $err );
477 $template->set( 'create', $wgUser->isAllowedToCreateAccount() );
478 $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() );
479 $template->set( 'userealname', $wgAllowRealName );
480 $template->set( 'useemail', $wgEnableEmail );
481 $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) or $this->mRemember );
482 $wgAuth->modifyUITemplate( $template );
484 $wgOut->setPageTitle( wfMsg( 'userlogin' ) );
485 $wgOut->setRobotpolicy( 'noindex,nofollow' );
486 $wgOut->setArticleRelated( false );
487 $wgOut->addTemplate( $template );
493 function hasSessionCookie() {
494 global $wgDisableCookieCheck;
495 return ( $wgDisableCookieCheck ) ? true : ( isset( $_COOKIE[session_name()] ) );
501 function cookieRedirectCheck( $type ) {
502 global $wgOut, $wgLang;
504 $titleObj = Title::makeTitle( NS_SPECIAL, 'Userlogin' );
505 $check = $titleObj->getFullURL( 'wpCookieCheck='.$type );
507 return $wgOut->redirect( $check );
513 function onCookieRedirectCheck( $type ) {
516 if ( !$this->hasSessionCookie() ) {
517 if ( $type == 'new' ) {
518 return $this->mainLoginForm( wfMsg( 'nocookiesnew' ) );
519 } else if ( $type == 'login' ) {
520 return $this->mainLoginForm( wfMsg( 'nocookieslogin' ) );
523 return $this->mainLoginForm( wfMsg( 'error' ) );
526 return $this->successfulLogin( wfMsg( 'loginsuccess', $wgUser->getName() ) );
533 function throttleHit( $limit ) {
536 $wgOut->addWikiText( wfMsg( 'acct_creation_throttle_hit', $limit ) );