From ff18d83b360135955c64fac8f186c7b73f680575 Mon Sep 17 00:00:00 2001 From: Jack Phoenix Date: Sun, 22 Aug 2010 21:34:44 +0000 Subject: [PATCH] coding style tweaks --- includes/specials/SpecialUserlogin.php | 150 +++++++++++++------------ 1 file changed, 79 insertions(+), 71 deletions(-) diff --git a/includes/specials/SpecialUserlogin.php b/includes/specials/SpecialUserlogin.php index 6a5799ea79..6d074f3c67 100644 --- a/includes/specials/SpecialUserlogin.php +++ b/includes/specials/SpecialUserlogin.php @@ -1,6 +1,6 @@ mRemember = $request->getCheck( 'wpRemember' ); $this->mLanguage = $request->getText( 'uselang' ); $this->mSkipCookieCheck = $request->getCheck( 'wpSkipCookieCheck' ); - $this->mToken = ($this->mType == 'signup' ) ? $request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' ); + $this->mToken = ( $this->mType == 'signup' ) ? $request->getVal( 'wpCreateaccountToken' ) : $request->getVal( 'wpLoginToken' ); if ( $wgRedirectOnLogin ) { $this->mReturnTo = $wgRedirectOnLogin; @@ -126,14 +126,14 @@ class LoginForm { if ( !is_null( $this->mCookieCheck ) ) { $this->onCookieRedirectCheck( $this->mCookieCheck ); return; - } else if( $this->mPosted ) { + } elseif( $this->mPosted ) { if( $this->mCreateaccount ) { return $this->addNewAccount(); - } else if ( $this->mCreateaccountMail ) { + } elseif ( $this->mCreateaccountMail ) { return $this->addNewAccountMailPassword(); - } else if ( $this->mMailmypassword ) { + } elseif ( $this->mMailmypassword ) { return $this->mailPassword(); - } else if ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) { + } elseif ( ( 'submitlogin' == $this->mAction ) || $this->mLoginattempt ) { return $this->processLogin(); } } @@ -153,7 +153,7 @@ class LoginForm { $u = $this->addNewaccountInternal(); - if ($u == null) { + if ( $u == null ) { return; } @@ -178,7 +178,6 @@ class LoginForm { $u = 0; } - /** * @private */ @@ -187,14 +186,16 @@ class LoginForm { # Create the account and abort if there's a problem doing so $u = $this->addNewAccountInternal(); - if( $u == null ) + if( $u == null ) { return; + } # If we showed up language selection links, and one was in use, be # smart (and sensible) and save that language as the user's preference global $wgLoginLanguageSelector; - if( $wgLoginLanguageSelector && $this->mLanguage ) + if( $wgLoginLanguageSelector && $this->mLanguage ) { $u->setOption( 'language', $this->mLanguage ); + } # Send out an email authentication message if needed if( $wgEmailAuthentication && User::isValidEmailAddr( $u->getEmail() ) ) { @@ -274,13 +275,13 @@ class LoginForm { $this->mainLoginForm( wfMsg( 'sessionfailure' ) ); return false; } - + # The user didn't pass a createaccount token if ( !$this->mToken ) { $this->mainLoginForm( wfMsg( 'sessionfailure' ) ); return false; } - + # Validate the createaccount token if ( $this->mToken !== self::getCreateaccountToken() ) { $this->mainLoginForm( wfMsg( 'sessionfailure' ) ); @@ -376,7 +377,7 @@ class LoginForm { return false; } - self::clearCreateaccountToken(); + self::clearCreateaccountToken(); return $this->initUser( $u, false ); } @@ -431,16 +432,16 @@ class LoginForm { */ public function authenticateUserData() { global $wgUser, $wgAuth, $wgMemc; - + if ( $this->mName == '' ) { return self::NO_NAME; } - + // We require a login token to prevent login CSRF // Handle part of this before incrementing the throttle so // token-less login attempts don't count towards the throttle // but wrong-token attempts do. - + // If the user doesn't have a login token yet, set one. if ( !self::getLoginToken() ) { self::setLoginToken(); @@ -450,7 +451,7 @@ class LoginForm { if ( !$this->mToken ) { return self::NEED_TOKEN; } - + global $wgPasswordAttemptThrottle; $throttleCount = 0; @@ -458,17 +459,17 @@ class LoginForm { $throttleKey = wfMemcKey( 'password-throttle', wfGetIP(), md5( $this->mName ) ); $count = $wgPasswordAttemptThrottle['count']; $period = $wgPasswordAttemptThrottle['seconds']; - + $throttleCount = $wgMemc->get( $throttleKey ); if ( !$throttleCount ) { $wgMemc->add( $throttleKey, 1, $period ); // start counter - } else if ( $throttleCount < $count ) { - $wgMemc->incr($throttleKey); - } else if ( $throttleCount >= $count ) { + } elseif ( $throttleCount < $count ) { + $wgMemc->incr( $throttleKey ); + } elseif ( $throttleCount >= $count ) { return self::THROTTLED; } } - + // Validate the login token if ( $this->mToken !== self::getLoginToken() ) { return self::WRONG_TOKEN; @@ -481,7 +482,7 @@ class LoginForm { // for user existence using User::newFromName($name)->getId() below // will effectively be using stale data. if ( $wgUser->getName() === $this->mName ) { - wfDebug( __METHOD__.": already logged in as {$this->mName}\n" ); + wfDebug( __METHOD__ . ": already logged in as {$this->mName}\n" ); return self::SUCCESS; } @@ -522,7 +523,7 @@ class LoginForm { } global $wgBlockDisablesLogin; - if (!$u->checkPassword( $this->mPassword )) { + if ( !$u->checkPassword( $this->mPassword ) ) { if( $u->checkTemporaryPassword( $this->mPassword ) ) { // The e-mailed temporary password should not be used for actu- // al logins; that's a very sloppy habit, and insecure if an @@ -550,7 +551,7 @@ class LoginForm { // faces etc will probably just fail cleanly here. $retval = self::RESET_PASS; } else { - $retval = ($this->mPassword == '') ? self::EMPTY_PASS : self::WRONG_PASS; + $retval = ( $this->mPassword == '' ) ? self::EMPTY_PASS : self::WRONG_PASS; } } elseif ( $wgBlockDisablesLogin && $u->isBlocked() ) { // If we've enabled it, make it so that a blocked user cannot login @@ -560,8 +561,8 @@ class LoginForm { $wgUser = $u; // Please reset throttle for successful logins, thanks! - if($throttleCount) { - $wgMemc->delete($throttleKey); + if( $throttleCount ) { + $wgMemc->delete( $throttleKey ); } if ( $isAutoCreated ) { @@ -584,7 +585,7 @@ class LoginForm { global $wgAuth, $wgUser, $wgAutocreatePolicy; if ( $wgUser->isBlockedFromCreateAccount() ) { - wfDebug( __METHOD__.": user is blocked from account creation\n" ); + wfDebug( __METHOD__ . ": user is blocked from account creation\n" ); return self::CREATE_BLOCKED; } @@ -608,16 +609,16 @@ class LoginForm { return self::NOT_EXISTS; } if ( !$wgAuth->userExists( $user->getName() ) ) { - wfDebug( __METHOD__.": user does not exist\n" ); + wfDebug( __METHOD__ . ": user does not exist\n" ); return self::NOT_EXISTS; } if ( !$wgAuth->authenticate( $user->getName(), $this->mPassword ) ) { - wfDebug( __METHOD__.": \$wgAuth->authenticate() returned false, aborting\n" ); + wfDebug( __METHOD__ . ": \$wgAuth->authenticate() returned false, aborting\n" ); return self::WRONG_PLUGIN_PASS; } } - wfDebug( __METHOD__.": creating account\n" ); + wfDebug( __METHOD__ . ": creating account\n" ); $user = $this->initUser( $user, true ); return self::SUCCESS; } @@ -654,7 +655,7 @@ class LoginForm { return $this->cookieRedirectCheck( 'login' ); } break; - + case self::NEED_TOKEN: case self::WRONG_TOKEN: $this->mainLoginForm( wfMsg( 'sessionfailure' ) ); @@ -667,7 +668,7 @@ class LoginForm { $this->mainLoginForm( wfMsg( 'wrongpassword' ) ); break; case self::NOT_EXISTS: - if( $wgUser->isAllowed( 'createaccount' ) ){ + if( $wgUser->isAllowed( 'createaccount' ) ) { $this->mainLoginForm( wfMsgWikiHtml( 'nosuchuser', htmlspecialchars( $this->mName ) ) ); } else { $this->mainLoginForm( wfMsg( 'nosuchusershort', htmlspecialchars( $this->mName ) ) ); @@ -693,7 +694,7 @@ class LoginForm { array( 'parsemag', 'escape' ), $this->mName ) ); break; default: - throw new MWException( "Unhandled case value" ); + throw new MWException( 'Unhandled case value' ); } } @@ -709,27 +710,27 @@ class LoginForm { */ function mailPassword() { global $wgUser, $wgOut, $wgAuth; - + if ( wfReadOnly() ) { $wgOut->readOnlyPage(); return false; } - + if( !$wgAuth->allowPasswordChange() ) { $this->mainLoginForm( wfMsg( 'resetpass_forbidden' ) ); return; } - # Check against blocked IPs so blocked users can't flood admins + # Check against blocked IPs so blocked users can't flood admins # with password resets if( $wgUser->isBlocked() ) { $this->mainLoginForm( wfMsg( 'blocked-mailpassword' ) ); return; } - + # Check for hooks $error = null; - if ( ! wfRunHooks( 'UserLoginMailPassword', array( $this->mName, &$error ) ) ) { + if ( !wfRunHooks( 'UserLoginMailPassword', array( $this->mName, &$error ) ) ) { $this->mainLoginForm( $error ); return; } @@ -746,7 +747,7 @@ class LoginForm { $this->mainLoginForm( wfMsg( 'sessionfailure' ) ); return; } - + # Check against the rate limiter if( $wgUser->pingLimiter( 'mailpassword' ) ) { $wgOut->rateLimited(); @@ -811,8 +812,8 @@ class LoginForm { if( !$ip ) { return new WikiError( wfMsg( 'badipaddress' ) ); } - - wfRunHooks( 'User::mailPasswordInternal', array(&$wgUser, &$ip, &$u) ); + + wfRunHooks( 'User::mailPasswordInternal', array( &$wgUser, &$ip, &$u ) ); $np = $u->randomPassword(); $u->setNewpassword( $np, $throttle ); @@ -841,7 +842,7 @@ class LoginForm { # Run any hooks; display injected HTML if any, else redirect $injected_html = ''; - wfRunHooks('UserLoginComplete', array(&$wgUser, &$injected_html)); + wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) ); if( $injected_html !== '' ) { $this->displaySuccessfulLogin( 'loginsuccess', $injected_html ); @@ -864,7 +865,7 @@ class LoginForm { global $wgUser; # Run any hooks; display injected HTML $injected_html = ''; - wfRunHooks('UserLoginComplete', array(&$wgUser, &$injected_html)); + wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) ); $this->displaySuccessfulLogin( 'welcomecreation', $injected_html ); } @@ -896,7 +897,7 @@ class LoginForm { $wgOut->setRobotPolicy( 'noindex,nofollow' ); $wgOut->setArticleRelated( false ); - $wgOut->addWikitext( $wgOut->formatPermissionsErrorMessage( $errors, 'createaccount' ) ); + $wgOut->addWikiText( $wgOut->formatPermissionsErrorMessage( $errors, 'createaccount' ) ); // Stuff that might want to be added at the end. For example, instruc- // tions if blocked. $wgOut->addWikiMsg( 'cantcreateaccount-nonblock-text' ); @@ -938,12 +939,12 @@ class LoginForm { global $wgUser, $wgOut, $wgHiddenPrefs, $wgEnableEmail; global $wgRequest, $wgLoginLanguageSelector; global $wgAuth, $wgEmailConfirmToEdit, $wgCookieExpiration; - + $titleObj = SpecialPage::getTitleFor( 'Userlogin' ); - + if ( $this->mType == 'signup' ) { - // Block signup here if in readonly. Keeps user from - // going through the process (filling out data, etc) + // Block signup here if in readonly. Keeps user from + // going through the process (filling out data, etc) // and being informed later. if ( wfReadOnly() ) { $wgOut->readOnlyPage(); @@ -985,26 +986,29 @@ class LoginForm { if ( !empty( $this->mReturnTo ) ) { $returnto = '&returnto=' . wfUrlencode( $this->mReturnTo ); - if ( !empty( $this->mReturnToQuery ) ) + if ( !empty( $this->mReturnToQuery ) ) { $returnto .= '&returntoquery=' . wfUrlencode( $this->mReturnToQuery ); + } $q .= $returnto; $linkq .= $returnto; } # Pass any language selection on to the mode switch link - if( $wgLoginLanguageSelector && $this->mLanguage ) + if( $wgLoginLanguageSelector && $this->mLanguage ) { $linkq .= '&uselang=' . $this->mLanguage; + } - $link = ''; + $link = ''; $link .= wfMsgHtml( $linkmsg . 'link' ); # Calling either 'gotaccountlink' or 'nologinlink' $link .= ''; # Don't show a "create account" link if the user can't - if( $this->showCreateOrLoginLink( $wgUser ) ) + if( $this->showCreateOrLoginLink( $wgUser ) ) { $template->set( 'link', wfMsgExt( $linkmsg, array( 'parseinline', 'replaceafter' ), $link ) ); - else + } else { $template->set( 'link', '' ); + } $template->set( 'header', '' ); $template->set( 'name', $this->mName ); @@ -1015,7 +1019,7 @@ class LoginForm { $template->set( 'domain', $this->mDomain ); $template->set( 'reason', $this->mReason ); - $template->set( 'action', $titleObj->getLocalUrl( $q ) ); + $template->set( 'action', $titleObj->getLocalURL( $q ) ); $template->set( 'message', $msg ); $template->set( 'messagetype', $msgtype ); $template->set( 'createemail', $wgEnableEmail && $wgUser->isLoggedIn() ); @@ -1025,7 +1029,7 @@ class LoginForm { $template->set( 'canreset', $wgAuth->allowPasswordChange() ); $template->set( 'canremember', ( $wgCookieExpiration > 0 ) ); $template->set( 'usereason', $wgUser->isLoggedIn() ); - $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) or $this->mRemember ); + $template->set( 'remember', $wgUser->getOption( 'rememberpassword' ) || $this->mRemember ); if ( $this->mType == 'signup' ) { if ( !self::getCreateaccountToken() ) { @@ -1038,7 +1042,7 @@ class LoginForm { } $template->set( 'token', self::getLoginToken() ); } - + # Prepare language selection links as needed if( $wgLoginLanguageSelector ) { $template->set( 'languages', $this->makeLanguageSelector() ); @@ -1054,7 +1058,7 @@ class LoginForm { wfRunHooks( 'UserLoginForm', array( &$template ) ); } - //Changes the title depending on permissions for creating account + // Changes the title depending on permissions for creating account if ( $wgUser->isAllowed( 'createaccount' ) ) { $wgOut->setPageTitle( wfMsg( 'userlogin' ) ); } else { @@ -1063,7 +1067,7 @@ class LoginForm { $wgOut->setRobotPolicy( 'noindex,nofollow' ); $wgOut->setArticleRelated( false ); - $wgOut->disallowUserJs(); // just in case... + $wgOut->disallowUserJs(); // just in case... $wgOut->addTemplate( $template ); } @@ -1093,7 +1097,7 @@ class LoginForm { global $wgDisableCookieCheck, $wgRequest; return $wgDisableCookieCheck ? true : $wgRequest->checkSessionCookie(); } - + /** * Get the login token from the current session */ @@ -1101,7 +1105,7 @@ class LoginForm { global $wgRequest; return $wgRequest->getSessionData( 'wsLoginToken' ); } - + /** * Randomly generate a new login token and attach it to the current session */ @@ -1111,7 +1115,7 @@ class LoginForm { // because the latter reuses $_SESSION['wsEditToken'] $wgRequest->setSessionData( 'wsLoginToken', User::generateToken() ); } - + /** * Remove any login token attached to the current session */ @@ -1127,7 +1131,7 @@ class LoginForm { global $wgRequest; return $wgRequest->getSessionData( 'wsCreateaccountToken' ); } - + /** * Randomly generate a new createaccount token and attach it to the current session */ @@ -1135,7 +1139,7 @@ class LoginForm { global $wgRequest; $wgRequest->setSessionData( 'wsCreateaccountToken', User::generateToken() ); } - + /** * Remove any createaccount token attached to the current session */ @@ -1152,7 +1156,9 @@ class LoginForm { $titleObj = SpecialPage::getTitleFor( 'Userlogin' ); $query = array( 'wpCookieCheck' => $type ); - if ( $this->mReturnTo ) $query['returnto'] = $this->mReturnTo; + if ( $this->mReturnTo ) { + $query['returnto'] = $this->mReturnTo; + } $check = $titleObj->getFullURL( $query ); return $wgOut->redirect( $check ); @@ -1165,7 +1171,7 @@ class LoginForm { if ( !$this->hasSessionCookie() ) { if ( $type == 'new' ) { return $this->mainLoginForm( wfMsgExt( 'nocookiesnew', array( 'parseinline' ) ) ); - } else if ( $type == 'login' ) { + } elseif ( $type == 'login' ) { return $this->mainLoginForm( wfMsgExt( 'nocookieslogin', array( 'parseinline' ) ) ); } else { # shouldn't happen @@ -1199,7 +1205,7 @@ class LoginForm { foreach( $langs as $lang ) { $lang = trim( $lang, '* ' ); $parts = explode( '|', $lang ); - if (count($parts) >= 2) { + if ( count( $parts ) >= 2 ) { $links[] = $this->makeLanguageSelectorLink( $parts[0], $parts[1] ); } } @@ -1220,10 +1226,12 @@ class LoginForm { global $wgUser; $self = SpecialPage::getTitleFor( 'Userlogin' ); $attr = array( 'uselang' => $lang ); - if( $this->mType == 'signup' ) + if( $this->mType == 'signup' ) { $attr['type'] = 'signup'; - if( $this->mReturnTo ) + } + if( $this->mReturnTo ) { $attr['returnto'] = $this->mReturnTo; + } $skin = $wgUser->getSkin(); return $skin->linkKnown( $self, -- 2.20.1