mdaniels5757 / waca

includes/Pages/UserAuth/Login/LoginCredentialPageBase.php

Braces +8 added lines, -13 removed lines

@@ -65,8 +65,7 @@ 
                     }
 
                     $user = User::getByUsername($username, $database);
-                }
-                else {
+                } else {
                     $user = User::getById($partialId, $database);
                 }
 
@@ -105,8 +104,7 @@ 
 
                 return;
             }
-        }
-        else {
+        } else {
             $this->assign('showSignIn', true);
 
             $this->setupPartial();
@@ -131,8 +129,7 @@ 
             if (WebRequest::isHttps()) {
                 // Client can clearly use HTTPS, so let's enforce it for all connections.
                 $this->headerQueue[] = "Strict-Transport-Security: max-age=15768000";
-            }
-            else {
+            } else {
                 // This is the login form, not the request form. We need protection here.
                 $this->redirectUrl('https://' . WebRequest::serverName() . WebRequest::requestUri());
 
@@ -166,8 +163,7 @@ 
             $username = $this->partialUser->getUsername();
 
             $this->setupAlternates($this->partialUser, $partialStage, $database);
-        }
-        else {
+        } else {
             // No, see if we've preloaded a username
             $preloadUsername = WebRequest::getString('tplUsername');
             if ($preloadUsername !== null) {
@@ -194,13 +190,11 @@ 
         $redirectDestination = WebRequest::clearPostLoginRedirect();
         if ($redirectDestination !== null) {
             $this->redirectUrl($redirectDestination);
-        }
-        else {
+        } else {
             if ($user->isNewUser()) {
                 // home page isn't allowed, go to preferences instead
                 $this->redirect('preferences');
-            }
-            else {
+            } else {
                 // go to the home page
                 $this->redirect('');
             }
@@ -323,7 +317,8 @@ 
         if (isset($types[$type])) {
             $options = $types[$type];
 
-            array_walk($options, function(&$val) {
+            array_walk($options, function(&$val)
+            {
                 $val = $this->names[$val];
             });
 

Indentation +306 added lines, -306 removed lines

@@ -21,310 +21,310 @@
 
 abstract class LoginCredentialPageBase extends InternalPageBase
 {
-    /** @var User */
-    protected $partialUser = null;
-    protected $nextPageMap = array(
-        'yubikeyotp' => 'otp',
-        'totp'       => 'otp',
-        'scratch'    => 'otp',
-    );
-    protected $names = array(
-        'yubikeyotp' => 'Yubikey OTP',
-        'totp'       => 'TOTP (phone code generator)',
-        'scratch'    => 'scratch token',
-    );
-
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        if (!$this->enforceHttps()) {
-            return;
-        }
-
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-
-            $database = $this->getDatabase();
-            try {
-                list($partialId, $partialStage) = WebRequest::getAuthPartialLogin();
-
-                if ($partialStage === null) {
-                    $partialStage = 1;
-                }
-
-                if ($partialId === null) {
-                    $username = WebRequest::postString('username');
-
-                    if ($username === null || trim($username) === '') {
-                        throw new ApplicationLogicException('No username specified.');
-                    }
-
-                    $user = User::getByUsername($username, $database);
-                }
-                else {
-                    $user = User::getById($partialId, $database);
-                }
-
-                if ($user === false) {
-                    throw new ApplicationLogicException("Authentication failed");
-                }
-
-                $authMan = new AuthenticationManager($database, $this->getSiteConfiguration(),
-                    $this->getHttpHelper());
-
-                $credential = $this->getProviderCredentials();
-
-                $authResult = $authMan->authenticate($user, $credential, $partialStage);
-
-                if ($authResult === AuthenticationManager::AUTH_FAIL) {
-                    throw new ApplicationLogicException("Authentication failed");
-                }
-
-                if ($authResult === AuthenticationManager::AUTH_REQUIRE_NEXT_STAGE) {
-                    $this->processJumpNextStage($user, $partialStage, $database);
-
-                    return;
-                }
-
-                if ($authResult === AuthenticationManager::AUTH_OK) {
-                    $this->processLoginSuccess($user);
-
-                    return;
-                }
-            }
-            catch (ApplicationLogicException $ex) {
-                WebRequest::clearAuthPartialLogin();
-
-                SessionAlert::error($ex->getMessage());
-                $this->redirect('login');
-
-                return;
-            }
-        }
-        else {
-            $this->assign('showSignIn', true);
-
-            $this->setupPartial();
-            $this->assignCSRFToken();
-            $this->providerSpecificSetup();
-        }
-    }
-
-    protected function isProtectedPage()
-    {
-        return false;
-    }
-
-    /**
-     * Enforces HTTPS on the login form
-     *
-     * @return bool
-     */
-    private function enforceHttps()
-    {
-        if ($this->getSiteConfiguration()->getUseStrictTransportSecurity() !== false) {
-            if (WebRequest::isHttps()) {
-                // Client can clearly use HTTPS, so let's enforce it for all connections.
-                $this->headerQueue[] = "Strict-Transport-Security: max-age=15768000";
-            }
-            else {
-                // This is the login form, not the request form. We need protection here.
-                $this->redirectUrl('https://' . WebRequest::serverName() . WebRequest::requestUri());
-
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    protected abstract function providerSpecificSetup();
-
-    protected function setupPartial()
-    {
-        $database = $this->getDatabase();
-
-        // default stuff
-        $this->assign('alternatives', array()); // 'u2f' => array('U2F token'), 'otp' => array('TOTP', 'scratch', 'yubiotp')));
-
-        // is this stage one?
-        list($partialId, $partialStage) = WebRequest::getAuthPartialLogin();
-        if ($partialStage === null || $partialId === null) {
-            WebRequest::clearAuthPartialLogin();
-        }
-
-        // Check to see if we have a partial login in progress
-        $username = null;
-        if ($partialId !== null) {
-            // Yes, enforce this username
-            $this->partialUser = User::getById($partialId, $database);
-            $username = $this->partialUser->getUsername();
-
-            $this->setupAlternates($this->partialUser, $partialStage, $database);
-        }
-        else {
-            // No, see if we've preloaded a username
-            $preloadUsername = WebRequest::getString('tplUsername');
-            if ($preloadUsername !== null) {
-                $username = $preloadUsername;
-            }
-        }
-
-        if ($partialStage === null) {
-            $partialStage = 1;
-        }
-
-        $this->assign('partialStage', $partialStage);
-        $this->assign('username', $username);
-    }
-
-    /**
-     * Redirect the user back to wherever they came from after a successful login
-     *
-     * @param User $user
-     */
-    protected function goBackWhenceYouCame(User $user)
-    {
-        // Redirect to wherever the user came from
-        $redirectDestination = WebRequest::clearPostLoginRedirect();
-        if ($redirectDestination !== null) {
-            $this->redirectUrl($redirectDestination);
-        }
-        else {
-            if ($user->isNewUser()) {
-                // home page isn't allowed, go to preferences instead
-                $this->redirect('preferences');
-            }
-            else {
-                // go to the home page
-                $this->redirect('');
-            }
-        }
-    }
-
-    private function processLoginSuccess(User $user)
-    {
-        // Touch force logout
-        $user->setForceLogout(false);
-        $user->save();
-
-        $oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
-            $this->getSiteConfiguration());
-
-        if ($oauth->isFullyLinked()) {
-            try {
-                // Reload the user's identity ticket.
-                $oauth->refreshIdentity();
-
-                // Check for blocks
-                if ($oauth->getIdentity()->getBlocked()) {
-                    // blocked!
-                    SessionAlert::error("You are currently blocked on-wiki. You will not be able to log in until you are unblocked.");
-                    $this->redirect('login');
-
-                    return;
-                }
-            }
-            catch (OAuthException $ex) {
-                // Oops. Refreshing ticket failed. Force a re-auth.
-                $authoriseUrl = $oauth->getRequestToken();
-                WebRequest::setOAuthPartialLogin($user);
-                $this->redirectUrl($authoriseUrl);
-
-                return;
-            }
-        }
-
-        if (($this->getSiteConfiguration()->getEnforceOAuth() && !$oauth->isFullyLinked())
-            || $oauth->isPartiallyLinked()
-        ) {
-            $authoriseUrl = $oauth->getRequestToken();
-            WebRequest::setOAuthPartialLogin($user);
-            $this->redirectUrl($authoriseUrl);
-
-            return;
-        }
-
-        WebRequest::setLoggedInUser($user);
-        $this->getDomainAccessManager()->switchToDefaultDomain($user);
-
-        $this->goBackWhenceYouCame($user);
-    }
-
-    protected abstract function getProviderCredentials();
-
-    /**
-     * @param User        $user
-     * @param int         $partialStage
-     * @param PdoDatabase $database
-     *
-     * @throws ApplicationLogicException
-     */
-    private function processJumpNextStage(User $user, $partialStage, PdoDatabase $database)
-    {
-        WebRequest::setAuthPartialLogin($user->getId(), $partialStage + 1);
-
-        $sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage AND disabled = 0 ORDER BY priority';
-        $statement = $database->prepare($sql);
-        $statement->execute(array(':user' => $user->getId(), ':stage' => $partialStage + 1));
-        $nextStage = $statement->fetchColumn();
-        $statement->closeCursor();
-
-        if (!isset($this->nextPageMap[$nextStage])) {
-            throw new ApplicationLogicException('Unknown page handler for next authentication stage.');
-        }
-
-        $this->redirect("login/" . $this->nextPageMap[$nextStage]);
-    }
-
-    private function setupAlternates(User $user, $partialStage, PdoDatabase $database)
-    {
-        // get the providers available
-        $sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage AND disabled = 0';
-        $statement = $database->prepare($sql);
-        $statement->execute(array(':user' => $user->getId(), ':stage' => $partialStage));
-        $alternates = $statement->fetchAll(PDO::FETCH_COLUMN);
-
-        $types = array();
-        foreach ($alternates as $item) {
-            $type = $this->nextPageMap[$item];
-            if (!isset($types[$type])) {
-                $types[$type] = array();
-            }
-
-            $types[$type][] = $item;
-        }
-
-        $userOptions = array();
-        if (get_called_class() !== PageOtpLogin::class) {
-            $userOptions = array_merge($userOptions, $this->setupUserOptionsForType($types, 'otp', $userOptions));
-        }
-
-        $this->assign('alternatives', $userOptions);
-    }
-
-    /**
-     * @param $types
-     * @param $type
-     * @param $userOptions
-     *
-     * @return mixed
-     */
-    private function setupUserOptionsForType($types, $type, $userOptions)
-    {
-        if (isset($types[$type])) {
-            $options = $types[$type];
-
-            array_walk($options, function(&$val) {
-                $val = $this->names[$val];
-            });
-
-            $userOptions[$type] = $options;
-        }
-
-        return $userOptions;
-    }
+	/** @var User */
+	protected $partialUser = null;
+	protected $nextPageMap = array(
+		'yubikeyotp' => 'otp',
+		'totp'       => 'otp',
+		'scratch'    => 'otp',
+	);
+	protected $names = array(
+		'yubikeyotp' => 'Yubikey OTP',
+		'totp'       => 'TOTP (phone code generator)',
+		'scratch'    => 'scratch token',
+	);
+
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		if (!$this->enforceHttps()) {
+			return;
+		}
+
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+
+			$database = $this->getDatabase();
+			try {
+				list($partialId, $partialStage) = WebRequest::getAuthPartialLogin();
+
+				if ($partialStage === null) {
+					$partialStage = 1;
+				}
+
+				if ($partialId === null) {
+					$username = WebRequest::postString('username');
+
+					if ($username === null || trim($username) === '') {
+						throw new ApplicationLogicException('No username specified.');
+					}
+
+					$user = User::getByUsername($username, $database);
+				}
+				else {
+					$user = User::getById($partialId, $database);
+				}
+
+				if ($user === false) {
+					throw new ApplicationLogicException("Authentication failed");
+				}
+
+				$authMan = new AuthenticationManager($database, $this->getSiteConfiguration(),
+					$this->getHttpHelper());
+
+				$credential = $this->getProviderCredentials();
+
+				$authResult = $authMan->authenticate($user, $credential, $partialStage);
+
+				if ($authResult === AuthenticationManager::AUTH_FAIL) {
+					throw new ApplicationLogicException("Authentication failed");
+				}
+
+				if ($authResult === AuthenticationManager::AUTH_REQUIRE_NEXT_STAGE) {
+					$this->processJumpNextStage($user, $partialStage, $database);
+
+					return;
+				}
+
+				if ($authResult === AuthenticationManager::AUTH_OK) {
+					$this->processLoginSuccess($user);
+
+					return;
+				}
+			}
+			catch (ApplicationLogicException $ex) {
+				WebRequest::clearAuthPartialLogin();
+
+				SessionAlert::error($ex->getMessage());
+				$this->redirect('login');
+
+				return;
+			}
+		}
+		else {
+			$this->assign('showSignIn', true);
+
+			$this->setupPartial();
+			$this->assignCSRFToken();
+			$this->providerSpecificSetup();
+		}
+	}
+
+	protected function isProtectedPage()
+	{
+		return false;
+	}
+
+	/**
+	 * Enforces HTTPS on the login form
+	 *
+	 * @return bool
+	 */
+	private function enforceHttps()
+	{
+		if ($this->getSiteConfiguration()->getUseStrictTransportSecurity() !== false) {
+			if (WebRequest::isHttps()) {
+				// Client can clearly use HTTPS, so let's enforce it for all connections.
+				$this->headerQueue[] = "Strict-Transport-Security: max-age=15768000";
+			}
+			else {
+				// This is the login form, not the request form. We need protection here.
+				$this->redirectUrl('https://' . WebRequest::serverName() . WebRequest::requestUri());
+
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	protected abstract function providerSpecificSetup();
+
+	protected function setupPartial()
+	{
+		$database = $this->getDatabase();
+
+		// default stuff
+		$this->assign('alternatives', array()); // 'u2f' => array('U2F token'), 'otp' => array('TOTP', 'scratch', 'yubiotp')));
+
+		// is this stage one?
+		list($partialId, $partialStage) = WebRequest::getAuthPartialLogin();
+		if ($partialStage === null || $partialId === null) {
+			WebRequest::clearAuthPartialLogin();
+		}
+
+		// Check to see if we have a partial login in progress
+		$username = null;
+		if ($partialId !== null) {
+			// Yes, enforce this username
+			$this->partialUser = User::getById($partialId, $database);
+			$username = $this->partialUser->getUsername();
+
+			$this->setupAlternates($this->partialUser, $partialStage, $database);
+		}
+		else {
+			// No, see if we've preloaded a username
+			$preloadUsername = WebRequest::getString('tplUsername');
+			if ($preloadUsername !== null) {
+				$username = $preloadUsername;
+			}
+		}
+
+		if ($partialStage === null) {
+			$partialStage = 1;
+		}
+
+		$this->assign('partialStage', $partialStage);
+		$this->assign('username', $username);
+	}
+
+	/**
+	 * Redirect the user back to wherever they came from after a successful login
+	 *
+	 * @param User $user
+	 */
+	protected function goBackWhenceYouCame(User $user)
+	{
+		// Redirect to wherever the user came from
+		$redirectDestination = WebRequest::clearPostLoginRedirect();
+		if ($redirectDestination !== null) {
+			$this->redirectUrl($redirectDestination);
+		}
+		else {
+			if ($user->isNewUser()) {
+				// home page isn't allowed, go to preferences instead
+				$this->redirect('preferences');
+			}
+			else {
+				// go to the home page
+				$this->redirect('');
+			}
+		}
+	}
+
+	private function processLoginSuccess(User $user)
+	{
+		// Touch force logout
+		$user->setForceLogout(false);
+		$user->save();
+
+		$oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
+			$this->getSiteConfiguration());
+
+		if ($oauth->isFullyLinked()) {
+			try {
+				// Reload the user's identity ticket.
+				$oauth->refreshIdentity();
+
+				// Check for blocks
+				if ($oauth->getIdentity()->getBlocked()) {
+					// blocked!
+					SessionAlert::error("You are currently blocked on-wiki. You will not be able to log in until you are unblocked.");
+					$this->redirect('login');
+
+					return;
+				}
+			}
+			catch (OAuthException $ex) {
+				// Oops. Refreshing ticket failed. Force a re-auth.
+				$authoriseUrl = $oauth->getRequestToken();
+				WebRequest::setOAuthPartialLogin($user);
+				$this->redirectUrl($authoriseUrl);
+
+				return;
+			}
+		}
+
+		if (($this->getSiteConfiguration()->getEnforceOAuth() && !$oauth->isFullyLinked())
+			|| $oauth->isPartiallyLinked()
+		) {
+			$authoriseUrl = $oauth->getRequestToken();
+			WebRequest::setOAuthPartialLogin($user);
+			$this->redirectUrl($authoriseUrl);
+
+			return;
+		}
+
+		WebRequest::setLoggedInUser($user);
+		$this->getDomainAccessManager()->switchToDefaultDomain($user);
+
+		$this->goBackWhenceYouCame($user);
+	}
+
+	protected abstract function getProviderCredentials();
+
+	/**
+	 * @param User        $user
+	 * @param int         $partialStage
+	 * @param PdoDatabase $database
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	private function processJumpNextStage(User $user, $partialStage, PdoDatabase $database)
+	{
+		WebRequest::setAuthPartialLogin($user->getId(), $partialStage + 1);
+
+		$sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage AND disabled = 0 ORDER BY priority';
+		$statement = $database->prepare($sql);
+		$statement->execute(array(':user' => $user->getId(), ':stage' => $partialStage + 1));
+		$nextStage = $statement->fetchColumn();
+		$statement->closeCursor();
+
+		if (!isset($this->nextPageMap[$nextStage])) {
+			throw new ApplicationLogicException('Unknown page handler for next authentication stage.');
+		}
+
+		$this->redirect("login/" . $this->nextPageMap[$nextStage]);
+	}
+
+	private function setupAlternates(User $user, $partialStage, PdoDatabase $database)
+	{
+		// get the providers available
+		$sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage AND disabled = 0';
+		$statement = $database->prepare($sql);
+		$statement->execute(array(':user' => $user->getId(), ':stage' => $partialStage));
+		$alternates = $statement->fetchAll(PDO::FETCH_COLUMN);
+
+		$types = array();
+		foreach ($alternates as $item) {
+			$type = $this->nextPageMap[$item];
+			if (!isset($types[$type])) {
+				$types[$type] = array();
+			}
+
+			$types[$type][] = $item;
+		}
+
+		$userOptions = array();
+		if (get_called_class() !== PageOtpLogin::class) {
+			$userOptions = array_merge($userOptions, $this->setupUserOptionsForType($types, 'otp', $userOptions));
+		}
+
+		$this->assign('alternatives', $userOptions);
+	}
+
+	/**
+	 * @param $types
+	 * @param $type
+	 * @param $userOptions
+	 *
+	 * @return mixed
+	 */
+	private function setupUserOptionsForType($types, $type, $userOptions)
+	{
+		if (isset($types[$type])) {
+			$options = $types[$type];
+
+			array_walk($options, function(&$val) {
+				$val = $this->names[$val];
+			});
+
+			$userOptions[$type] = $options;
+		}
+
+		return $userOptions;
+	}
 }

includes/Pages/UserAuth/Login/PageOtpLogin.php

Indentation +12 added lines, -12 removed lines

@@ -13,18 +13,18 @@
 
 class PageOtpLogin extends LoginCredentialPageBase
 {
-    protected function providerSpecificSetup()
-    {
-        $this->setTemplate('login/otp.tpl');
-    }
+	protected function providerSpecificSetup()
+	{
+		$this->setTemplate('login/otp.tpl');
+	}
 
-    protected function getProviderCredentials()
-    {
-        $otp = WebRequest::postString("otp");
-        if ($otp === null || $otp === "") {
-            throw new ApplicationLogicException("No one-time code specified");
-        }
+	protected function getProviderCredentials()
+	{
+		$otp = WebRequest::postString("otp");
+		if ($otp === null || $otp === "") {
+			throw new ApplicationLogicException("No one-time code specified");
+		}
 
-        return $otp;
-    }
+		return $otp;
+	}
 }
\ No newline at end of file

includes/Pages/UserAuth/PageOAuthCallback.php

Braces +1 added lines, -2 removed lines

@@ -116,8 +116,7 @@
         $redirectDestination = WebRequest::clearPostLoginRedirect();
         if ($redirectDestination !== null && !$user->isNewUser()) {
             $this->redirectUrl($redirectDestination);
-        }
-        else {
+        } else {
             $this->redirect('preferences', null, null, 'internal.php');
         }
     }

Indentation +78 added lines, -78 removed lines

@@ -18,93 +18,93 @@
 
 class PageOAuthCallback extends InternalPageBase
 {
-    /**
-     * @return bool
-     */
-    protected function isProtectedPage()
-    {
-        // This page is critical to ensuring OAuth functionality is operational.
-        return false;
-    }
+	/**
+	 * @return bool
+	 */
+	protected function isProtectedPage()
+	{
+		// This page is critical to ensuring OAuth functionality is operational.
+		return false;
+	}
 
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        // This should never get hit except by URL manipulation.
-        $this->redirect('');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		// This should never get hit except by URL manipulation.
+		$this->redirect('');
+	}
 
-    /**
-     * Registered endpoint for the account creation callback.
-     *
-     * If this ever gets hit, something is wrong somewhere.
-     */
-    protected function create()
-    {
-        throw new Exception('OAuth account creation endpoint triggered.');
-    }
+	/**
+	 * Registered endpoint for the account creation callback.
+	 *
+	 * If this ever gets hit, something is wrong somewhere.
+	 */
+	protected function create()
+	{
+		throw new Exception('OAuth account creation endpoint triggered.');
+	}
 
-    /**
-     * Callback entry point
-     * @throws ApplicationLogicException
-     * @throws OptimisticLockFailedException
-     */
-    protected function authorise()
-    {
-        $oauthToken = WebRequest::getString('oauth_token');
-        $oauthVerifier = WebRequest::getString('oauth_verifier');
+	/**
+	 * Callback entry point
+	 * @throws ApplicationLogicException
+	 * @throws OptimisticLockFailedException
+	 */
+	protected function authorise()
+	{
+		$oauthToken = WebRequest::getString('oauth_token');
+		$oauthVerifier = WebRequest::getString('oauth_verifier');
 
-        $this->doCallbackValidation($oauthToken, $oauthVerifier);
+		$this->doCallbackValidation($oauthToken, $oauthVerifier);
 
-        $database = $this->getDatabase();
+		$database = $this->getDatabase();
 
-        $user = OAuthUserHelper::findUserByRequestToken($oauthToken, $database);
-        $oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
+		$user = OAuthUserHelper::findUserByRequestToken($oauthToken, $database);
+		$oauth = new OAuthUserHelper($user, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
 
-        try {
-            $oauth->completeHandshake($oauthVerifier);
-        }
-        catch (CurlException $ex) {
-            throw new ApplicationLogicException($ex->getMessage(), 0, $ex);
-        }
+		try {
+			$oauth->completeHandshake($oauthVerifier);
+		}
+		catch (CurlException $ex) {
+			throw new ApplicationLogicException($ex->getMessage(), 0, $ex);
+		}
 
-        // OK, we're the same session that just did a partial login that was redirected to OAuth. Let's upgrade the
-        // login to a full login
-        if (WebRequest::getOAuthPartialLogin() === $user->getId()) {
-            WebRequest::setLoggedInUser($user);
-            $this->getDomainAccessManager()->switchToDefaultDomain($user);
-        }
+		// OK, we're the same session that just did a partial login that was redirected to OAuth. Let's upgrade the
+		// login to a full login
+		if (WebRequest::getOAuthPartialLogin() === $user->getId()) {
+			WebRequest::setLoggedInUser($user);
+			$this->getDomainAccessManager()->switchToDefaultDomain($user);
+		}
 
-        // My thinking is there are three cases here:
-        //   a) new user => redirect to prefs - it's the only thing they can access other than stats
-        //   b) existing user hit the connect button in prefs => redirect to prefs since it's where they were
-        //   c) existing user logging in => redirect to wherever they came from
-        $redirectDestination = WebRequest::clearPostLoginRedirect();
-        if ($redirectDestination !== null && !$user->isNewUser()) {
-            $this->redirectUrl($redirectDestination);
-        }
-        else {
-            $this->redirect('preferences', null, null, 'internal.php');
-        }
-    }
+		// My thinking is there are three cases here:
+		//   a) new user => redirect to prefs - it's the only thing they can access other than stats
+		//   b) existing user hit the connect button in prefs => redirect to prefs since it's where they were
+		//   c) existing user logging in => redirect to wherever they came from
+		$redirectDestination = WebRequest::clearPostLoginRedirect();
+		if ($redirectDestination !== null && !$user->isNewUser()) {
+			$this->redirectUrl($redirectDestination);
+		}
+		else {
+			$this->redirect('preferences', null, null, 'internal.php');
+		}
+	}
 
-    /**
-     * @param string $oauthToken
-     * @param string $oauthVerifier
-     *
-     * @throws ApplicationLogicException
-     */
-    private function doCallbackValidation($oauthToken, $oauthVerifier)
-    {
-        if ($oauthToken === null) {
-            throw new ApplicationLogicException('No token provided');
-        }
+	/**
+	 * @param string $oauthToken
+	 * @param string $oauthVerifier
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	private function doCallbackValidation($oauthToken, $oauthVerifier)
+	{
+		if ($oauthToken === null) {
+			throw new ApplicationLogicException('No token provided');
+		}
 
-        if ($oauthVerifier === null) {
-            throw new ApplicationLogicException('No oauth verifier provided.');
-        }
-    }
+		if ($oauthVerifier === null) {
+			throw new ApplicationLogicException('No oauth verifier provided.');
+		}
+	}
 }
\ No newline at end of file

includes/Pages/UserAuth/PageChangePassword.php

Braces +1 added lines, -2 removed lines

@@ -52,8 +52,7 @@
             SessionAlert::success('Password changed successfully!');
 
             $this->redirect('preferences');
-        }
-        else {
+        } else {
             $this->assignCSRFToken();
             $this->setTemplate('preferences/changePassword.tpl');
             $this->addJs("/vendor/dropbox/zxcvbn/dist/zxcvbn.js");

Indentation +57 added lines, -57 removed lines

@@ -17,71 +17,71 @@
 
 class PageChangePassword extends InternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setHtmlTitle('Change Password');
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setHtmlTitle('Change Password');
 
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-            try {
-                $oldPassword = WebRequest::postString('password');
-                $newPassword = WebRequest::postString('newpassword');
-                $newPasswordConfirmation = WebRequest::postString('newpasswordconfirm');
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+			try {
+				$oldPassword = WebRequest::postString('password');
+				$newPassword = WebRequest::postString('newpassword');
+				$newPasswordConfirmation = WebRequest::postString('newpasswordconfirm');
 
-                $user = User::getCurrent($this->getDatabase());
-                if (!$user instanceof User) {
-                    throw new ApplicationLogicException('User not found');
-                }
+				$user = User::getCurrent($this->getDatabase());
+				if (!$user instanceof User) {
+					throw new ApplicationLogicException('User not found');
+				}
 
-                $this->validateNewPassword($oldPassword, $newPassword, $newPasswordConfirmation, $user);
+				$this->validateNewPassword($oldPassword, $newPassword, $newPasswordConfirmation, $user);
 
-                $passwordProvider = new PasswordCredentialProvider($this->getDatabase(), $this->getSiteConfiguration());
-                $passwordProvider->setCredential($user, 1, $newPassword);
-            }
-            catch (ApplicationLogicException $ex) {
-                SessionAlert::error($ex->getMessage());
-                $this->redirect('changePassword');
+				$passwordProvider = new PasswordCredentialProvider($this->getDatabase(), $this->getSiteConfiguration());
+				$passwordProvider->setCredential($user, 1, $newPassword);
+			}
+			catch (ApplicationLogicException $ex) {
+				SessionAlert::error($ex->getMessage());
+				$this->redirect('changePassword');
 
-                return;
-            }
+				return;
+			}
 
-            SessionAlert::success('Password changed successfully!');
+			SessionAlert::success('Password changed successfully!');
 
-            $this->redirect('preferences');
-        }
-        else {
-            $this->assignCSRFToken();
-            $this->setTemplate('preferences/changePassword.tpl');
-            $this->addJs("/vendor/dropbox/zxcvbn/dist/zxcvbn.js");
-        }
-    }
+			$this->redirect('preferences');
+		}
+		else {
+			$this->assignCSRFToken();
+			$this->setTemplate('preferences/changePassword.tpl');
+			$this->addJs("/vendor/dropbox/zxcvbn/dist/zxcvbn.js");
+		}
+	}
 
-    /**
-     * @param string $oldPassword
-     * @param string $newPassword
-     * @param string $newPasswordConfirmation
-     * @param User   $user
-     *
-     * @throws ApplicationLogicException
-     */
-    protected function validateNewPassword($oldPassword, $newPassword, $newPasswordConfirmation, User $user)
-    {
-        if ($oldPassword === null || $newPassword === null || $newPasswordConfirmation === null) {
-            throw new ApplicationLogicException('All three fields must be completed to change your password');
-        }
+	/**
+	 * @param string $oldPassword
+	 * @param string $newPassword
+	 * @param string $newPasswordConfirmation
+	 * @param User   $user
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	protected function validateNewPassword($oldPassword, $newPassword, $newPasswordConfirmation, User $user)
+	{
+		if ($oldPassword === null || $newPassword === null || $newPasswordConfirmation === null) {
+			throw new ApplicationLogicException('All three fields must be completed to change your password');
+		}
 
-        if ($newPassword !== $newPasswordConfirmation) {
-            throw new ApplicationLogicException('Your new passwords did not match!');
-        }
+		if ($newPassword !== $newPasswordConfirmation) {
+			throw new ApplicationLogicException('Your new passwords did not match!');
+		}
 
-        // TODO: adapt for MFA support
-        $passwordProvider = new PasswordCredentialProvider($this->getDatabase(), $this->getSiteConfiguration());
-        if (!$passwordProvider->authenticate($user, $oldPassword)) {
-            throw new ApplicationLogicException('The password you entered was incorrect.');
-        }
-    }
+		// TODO: adapt for MFA support
+		$passwordProvider = new PasswordCredentialProvider($this->getDatabase(), $this->getSiteConfiguration());
+		if (!$passwordProvider->authenticate($user, $oldPassword)) {
+			throw new ApplicationLogicException('The password you entered was incorrect.');
+		}
+	}
 }

includes/Pages/UserAuth/PageForgotPassword.php

Braces +2 added lines, -4 removed lines

@@ -46,8 +46,7 @@ 
             SessionAlert::success('<strong>Your password reset request has been completed.</strong> If the details you have provided match our records, you should receive an email shortly.');
 
             $this->redirect('login');
-        }
-        else {
+        } else {
             $this->assignCSRFToken();
             $this->setTemplate('forgot-password/forgotpw.tpl');
         }
@@ -130,8 +129,7 @@ 
 
                 return;
             }
-        }
-        else {
+        } else {
             $this->assignCSRFToken();
             $this->assign('user', $user);
             $this->setTemplate('forgot-password/forgotpwreset.tpl');

Indentation +209 added lines, -209 removed lines

@@ -23,213 +23,213 @@
 
 class PageForgotPassword extends InternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     *
-     * This is the forgotten password reset form
-     * @category Security-Critical
-     */
-    protected function main()
-    {
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-            $username = WebRequest::postString('username');
-            $email = WebRequest::postEmail('email');
-            $database = $this->getDatabase();
-
-            if ($username === null || trim($username) === "" || $email === null || trim($email) === "") {
-                throw new ApplicationLogicException("Both username and email address must be specified!");
-            }
-
-            $user = User::getByUsername($username, $database);
-            $this->sendResetMail($user, $email);
-
-            SessionAlert::success('<strong>Your password reset request has been completed.</strong> If the details you have provided match our records, you should receive an email shortly.');
-
-            $this->redirect('login');
-        }
-        else {
-            $this->assignCSRFToken();
-            $this->setTemplate('forgot-password/forgotpw.tpl');
-        }
-    }
-
-    /**
-     * Sends a reset email if the user is authenticated
-     *
-     * @param User|boolean $user  The user located from the database, or false. Doesn't really matter, since we do the
-     *                            check anyway within this method and silently skip if we don't have a user.
-     * @param string       $email The provided email address
-     */
-    private function sendResetMail($user, $email)
-    {
-        // If the user isn't found, or the email address is wrong, skip sending the details silently.
-        if (!$user instanceof User) {
-            return;
-        }
-
-        if (strtolower($user->getEmail()) === strtolower($email)) {
-            $clientIp = $this->getXffTrustProvider()
-                ->getTrustedClientIp(WebRequest::remoteAddress(), WebRequest::forwardedAddress());
-
-            $this->cleanExistingTokens($user);
-
-            $hash = Base32::encodeUpper(openssl_random_pseudo_bytes(30));
-
-            $encryptionHelper = new EncryptionHelper($this->getSiteConfiguration());
-
-            $cred = new Credential();
-            $cred->setDatabase($this->getDatabase());
-            $cred->setFactor(-1);
-            $cred->setUserId($user->getId());
-            $cred->setType('reset');
-            $cred->setData($encryptionHelper->encryptData($hash));
-            $cred->setVersion(0);
-            $cred->setDisabled(0);
-            $cred->setTimeout(new DateTimeImmutable('+ 1 hour'));
-            $cred->setPriority(9);
-            $cred->save();
-
-            $this->assign("user", $user);
-            $this->assign("hash", $hash);
-            $this->assign("remoteAddress", $clientIp);
-
-            $emailContent = $this->fetchTemplate('forgot-password/reset-mail.tpl');
-
-            // FIXME: domains!
-            /** @var Domain $domain */
-            $domain = Domain::getById(1, $this->getDatabase());
-            $this->getEmailHelper()->sendMail(
-                null, $user->getEmail(), "WP:ACC password reset", $emailContent);
-        }
-    }
-
-    /**
-     * Entry point for the reset action
-     *
-     * This is the reset password part of the form.
-     * @category Security-Critical
-     */
-    protected function reset()
-    {
-        $si = WebRequest::getString('si');
-        $id = WebRequest::getString('id');
-
-        if ($si === null || trim($si) === "" || $id === null || trim($id) === "") {
-            throw new ApplicationLogicException("Link not valid, please ensure it has copied correctly");
-        }
-
-        $database = $this->getDatabase();
-        $user = $this->getResettingUser($id, $database, $si);
-
-        // Dual mode
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-            try {
-                $this->doReset($user);
-                $this->cleanExistingTokens($user);
-            }
-            catch (ApplicationLogicException $ex) {
-                SessionAlert::error($ex->getMessage());
-                $this->redirect('forgotPassword', 'reset', array('si' => $si, 'id' => $id));
-
-                return;
-            }
-        }
-        else {
-            $this->assignCSRFToken();
-            $this->assign('user', $user);
-            $this->setTemplate('forgot-password/forgotpwreset.tpl');
-            $this->addJs("/vendor/dropbox/zxcvbn/dist/zxcvbn.js");
-        }
-    }
-
-    /**
-     * Gets the user resetting their password from the database, or throwing an exception if that is not possible.
-     *
-     * @param integer     $id       The ID of the user to retrieve
-     * @param PdoDatabase $database The database object to use
-     * @param string      $si       The reset hash provided
-     *
-     * @return User
-     * @throws ApplicationLogicException
-     */
-    private function getResettingUser($id, $database, $si)
-    {
-        $user = User::getById($id, $database);
-
-        if ($user === false || $user->isCommunityUser()) {
-            throw new ApplicationLogicException("Password reset failed. Please try again.");
-        }
-
-        $statement = $database->prepare("SELECT * FROM credential WHERE type = 'reset' AND user = :user;");
-        $statement->execute([':user' => $user->getId()]);
-
-        /** @var Credential $credential */
-        $credential = $statement->fetchObject(Credential::class);
-
-        $statement->closeCursor();
-
-        if ($credential === false) {
-            throw new ApplicationLogicException("Password reset failed. Please try again.");
-        }
-
-        $credential->setDatabase($database);
-
-        $encryptionHelper = new EncryptionHelper($this->getSiteConfiguration());
-        if ($encryptionHelper->decryptData($credential->getData()) != $si) {
-            throw new ApplicationLogicException("Password reset failed. Please try again.");
-        }
-
-        if ($credential->getTimeout() < new DateTimeImmutable()) {
-            $credential->delete();
-            throw new ApplicationLogicException("Password reset token expired. Please try again.");
-        }
-
-        return $user;
-    }
-
-    /**
-     * Performs the setting of the new password
-     *
-     * @param User $user The user to set the password for
-     *
-     * @throws ApplicationLogicException
-     */
-    private function doReset(User $user)
-    {
-        $pw = WebRequest::postString('newpassword');
-        $pw2 = WebRequest::postString('newpasswordconfirm');
-
-        if ($pw !== $pw2) {
-            throw new ApplicationLogicException('Passwords do not match!');
-        }
-
-        $passwordCredentialProvider = new PasswordCredentialProvider($user->getDatabase(), $this->getSiteConfiguration());
-        $passwordCredentialProvider->setCredential($user, 1, $pw);
-
-        SessionAlert::success('You may now log in!');
-        $this->redirect('login');
-    }
-
-    protected function isProtectedPage()
-    {
-        return false;
-    }
-
-    /**
-     * @param $user
-     */
-    private function cleanExistingTokens($user): void
-    {
-        // clean out existing reset tokens
-        $statement = $this->getDatabase()->prepare("SELECT * FROM credential WHERE type = 'reset' AND user = :user;");
-        $statement->execute([':user' => $user->getId()]);
-        $existing = $statement->fetchAll(PdoDatabase::FETCH_CLASS, Credential::class);
-
-        foreach ($existing as $c) {
-            $c->setDatabase($this->getDatabase());
-            $c->delete();
-        }
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 *
+	 * This is the forgotten password reset form
+	 * @category Security-Critical
+	 */
+	protected function main()
+	{
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+			$username = WebRequest::postString('username');
+			$email = WebRequest::postEmail('email');
+			$database = $this->getDatabase();
+
+			if ($username === null || trim($username) === "" || $email === null || trim($email) === "") {
+				throw new ApplicationLogicException("Both username and email address must be specified!");
+			}
+
+			$user = User::getByUsername($username, $database);
+			$this->sendResetMail($user, $email);
+
+			SessionAlert::success('<strong>Your password reset request has been completed.</strong> If the details you have provided match our records, you should receive an email shortly.');
+
+			$this->redirect('login');
+		}
+		else {
+			$this->assignCSRFToken();
+			$this->setTemplate('forgot-password/forgotpw.tpl');
+		}
+	}
+
+	/**
+	 * Sends a reset email if the user is authenticated
+	 *
+	 * @param User|boolean $user  The user located from the database, or false. Doesn't really matter, since we do the
+	 *                            check anyway within this method and silently skip if we don't have a user.
+	 * @param string       $email The provided email address
+	 */
+	private function sendResetMail($user, $email)
+	{
+		// If the user isn't found, or the email address is wrong, skip sending the details silently.
+		if (!$user instanceof User) {
+			return;
+		}
+
+		if (strtolower($user->getEmail()) === strtolower($email)) {
+			$clientIp = $this->getXffTrustProvider()
+				->getTrustedClientIp(WebRequest::remoteAddress(), WebRequest::forwardedAddress());
+
+			$this->cleanExistingTokens($user);
+
+			$hash = Base32::encodeUpper(openssl_random_pseudo_bytes(30));
+
+			$encryptionHelper = new EncryptionHelper($this->getSiteConfiguration());
+
+			$cred = new Credential();
+			$cred->setDatabase($this->getDatabase());
+			$cred->setFactor(-1);
+			$cred->setUserId($user->getId());
+			$cred->setType('reset');
+			$cred->setData($encryptionHelper->encryptData($hash));
+			$cred->setVersion(0);
+			$cred->setDisabled(0);
+			$cred->setTimeout(new DateTimeImmutable('+ 1 hour'));
+			$cred->setPriority(9);
+			$cred->save();
+
+			$this->assign("user", $user);
+			$this->assign("hash", $hash);
+			$this->assign("remoteAddress", $clientIp);
+
+			$emailContent = $this->fetchTemplate('forgot-password/reset-mail.tpl');
+
+			// FIXME: domains!
+			/** @var Domain $domain */
+			$domain = Domain::getById(1, $this->getDatabase());
+			$this->getEmailHelper()->sendMail(
+				null, $user->getEmail(), "WP:ACC password reset", $emailContent);
+		}
+	}
+
+	/**
+	 * Entry point for the reset action
+	 *
+	 * This is the reset password part of the form.
+	 * @category Security-Critical
+	 */
+	protected function reset()
+	{
+		$si = WebRequest::getString('si');
+		$id = WebRequest::getString('id');
+
+		if ($si === null || trim($si) === "" || $id === null || trim($id) === "") {
+			throw new ApplicationLogicException("Link not valid, please ensure it has copied correctly");
+		}
+
+		$database = $this->getDatabase();
+		$user = $this->getResettingUser($id, $database, $si);
+
+		// Dual mode
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+			try {
+				$this->doReset($user);
+				$this->cleanExistingTokens($user);
+			}
+			catch (ApplicationLogicException $ex) {
+				SessionAlert::error($ex->getMessage());
+				$this->redirect('forgotPassword', 'reset', array('si' => $si, 'id' => $id));
+
+				return;
+			}
+		}
+		else {
+			$this->assignCSRFToken();
+			$this->assign('user', $user);
+			$this->setTemplate('forgot-password/forgotpwreset.tpl');
+			$this->addJs("/vendor/dropbox/zxcvbn/dist/zxcvbn.js");
+		}
+	}
+
+	/**
+	 * Gets the user resetting their password from the database, or throwing an exception if that is not possible.
+	 *
+	 * @param integer     $id       The ID of the user to retrieve
+	 * @param PdoDatabase $database The database object to use
+	 * @param string      $si       The reset hash provided
+	 *
+	 * @return User
+	 * @throws ApplicationLogicException
+	 */
+	private function getResettingUser($id, $database, $si)
+	{
+		$user = User::getById($id, $database);
+
+		if ($user === false || $user->isCommunityUser()) {
+			throw new ApplicationLogicException("Password reset failed. Please try again.");
+		}
+
+		$statement = $database->prepare("SELECT * FROM credential WHERE type = 'reset' AND user = :user;");
+		$statement->execute([':user' => $user->getId()]);
+
+		/** @var Credential $credential */
+		$credential = $statement->fetchObject(Credential::class);
+
+		$statement->closeCursor();
+
+		if ($credential === false) {
+			throw new ApplicationLogicException("Password reset failed. Please try again.");
+		}
+
+		$credential->setDatabase($database);
+
+		$encryptionHelper = new EncryptionHelper($this->getSiteConfiguration());
+		if ($encryptionHelper->decryptData($credential->getData()) != $si) {
+			throw new ApplicationLogicException("Password reset failed. Please try again.");
+		}
+
+		if ($credential->getTimeout() < new DateTimeImmutable()) {
+			$credential->delete();
+			throw new ApplicationLogicException("Password reset token expired. Please try again.");
+		}
+
+		return $user;
+	}
+
+	/**
+	 * Performs the setting of the new password
+	 *
+	 * @param User $user The user to set the password for
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	private function doReset(User $user)
+	{
+		$pw = WebRequest::postString('newpassword');
+		$pw2 = WebRequest::postString('newpasswordconfirm');
+
+		if ($pw !== $pw2) {
+			throw new ApplicationLogicException('Passwords do not match!');
+		}
+
+		$passwordCredentialProvider = new PasswordCredentialProvider($user->getDatabase(), $this->getSiteConfiguration());
+		$passwordCredentialProvider->setCredential($user, 1, $pw);
+
+		SessionAlert::success('You may now log in!');
+		$this->redirect('login');
+	}
+
+	protected function isProtectedPage()
+	{
+		return false;
+	}
+
+	/**
+	 * @param $user
+	 */
+	private function cleanExistingTokens($user): void
+	{
+		// clean out existing reset tokens
+		$statement = $this->getDatabase()->prepare("SELECT * FROM credential WHERE type = 'reset' AND user = :user;");
+		$statement->execute([':user' => $user->getId()]);
+		$existing = $statement->fetchAll(PdoDatabase::FETCH_CLASS, Credential::class);
+
+		foreach ($existing as $c) {
+			$c->setDatabase($this->getDatabase());
+			$c->delete();
+		}
+	}
 }

includes/Pages/PageJobQueue.php

Braces +3 added lines, -3 removed lines

@@ -116,7 +116,8 @@ 
             $job->setDatabase($database);
         }
 
-        $this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database) {
+        $this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database)
+        {
             return UserSearchHelper::get($database)->fetchColumn('username');
         });
 
@@ -158,8 +159,7 @@ 
             ->byObjectId($job->getId())->getRecordCount($logCount)->fetch();
         if ($logCount === 0) {
             $this->assign('log', array());
-        }
-        else {
+        } else {
             list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration());
 
             $this->assign("log", $logData);

Indentation +269 added lines, -269 removed lines

@@ -28,309 +28,309 @@
 
 class PageJobQueue extends PagedInternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setHtmlTitle('Job Queue Management');
-
-        $this->prepareMaps();
-
-        $database = $this->getDatabase();
-
-        /** @var JobQueue[] $jobList */
-        // FIXME: domains
-        $jobList = JobQueueSearchHelper::get($database, 1)
-            ->statusIn([
-                JobQueue::STATUS_QUEUED,
-                JobQueue::STATUS_READY,
-                JobQueue::STATUS_WAITING,
-                JobQueue::STATUS_RUNNING,
-                JobQueue::STATUS_FAILED,
-            ])
-            ->notAcknowledged()
-            ->fetch();
-
-        $userIds = array();
-        $requestIds = array();
-
-        foreach ($jobList as $job) {
-            $userIds[] = $job->getTriggerUserId();
-            $requestIds[] = $job->getRequest();
-
-            $job->setDatabase($database);
-        }
-
-        $this->assign('canSeeAll', $this->barrierTest('all', User::getCurrent($database)));
-
-        $this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
-        // FIXME: domains
-        $this->assign('requests', RequestSearchHelper::get($database, 1)->inIds($requestIds)->fetchMap('name'));
-
-        $this->assign('joblist', $jobList);
-        $this->setTemplate('jobqueue/main.tpl');
-    }
-
-    protected function all()
-    {
-        $this->setHtmlTitle('All Jobs');
-
-        $this->prepareMaps();
-
-        $database = $this->getDatabase();
-
-        // FIXME: domains
-        $searchHelper = JobQueueSearchHelper::get($database, 1);
-        $this->setSearchHelper($searchHelper);
-        $this->setupLimits();
-
-        $filterUser = WebRequest::getString('filterUser');
-        $filterTask = WebRequest::getString('filterTask');
-        $filterStatus = WebRequest::getString('filterStatus');
-        $filterRequest = WebRequest::getString('filterRequest');
-        $order = WebRequest::getString('order');
-
-        if ($filterUser !== null) {
-            $searchHelper->byUser(User::getByUsername($filterUser, $database)->getId());
-        }
-
-        if ($filterTask !== null) {
-            $searchHelper->byTask($filterTask);
-        }
-
-        if ($filterStatus !== null) {
-            $searchHelper->byStatus($filterStatus);
-        }
-
-        if ($filterRequest !== null) {
-            $searchHelper->byRequest($filterRequest);
-        }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setHtmlTitle('Job Queue Management');
+
+		$this->prepareMaps();
+
+		$database = $this->getDatabase();
+
+		/** @var JobQueue[] $jobList */
+		// FIXME: domains
+		$jobList = JobQueueSearchHelper::get($database, 1)
+			->statusIn([
+				JobQueue::STATUS_QUEUED,
+				JobQueue::STATUS_READY,
+				JobQueue::STATUS_WAITING,
+				JobQueue::STATUS_RUNNING,
+				JobQueue::STATUS_FAILED,
+			])
+			->notAcknowledged()
+			->fetch();
+
+		$userIds = array();
+		$requestIds = array();
+
+		foreach ($jobList as $job) {
+			$userIds[] = $job->getTriggerUserId();
+			$requestIds[] = $job->getRequest();
+
+			$job->setDatabase($database);
+		}
+
+		$this->assign('canSeeAll', $this->barrierTest('all', User::getCurrent($database)));
+
+		$this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
+		// FIXME: domains
+		$this->assign('requests', RequestSearchHelper::get($database, 1)->inIds($requestIds)->fetchMap('name'));
+
+		$this->assign('joblist', $jobList);
+		$this->setTemplate('jobqueue/main.tpl');
+	}
+
+	protected function all()
+	{
+		$this->setHtmlTitle('All Jobs');
+
+		$this->prepareMaps();
+
+		$database = $this->getDatabase();
+
+		// FIXME: domains
+		$searchHelper = JobQueueSearchHelper::get($database, 1);
+		$this->setSearchHelper($searchHelper);
+		$this->setupLimits();
+
+		$filterUser = WebRequest::getString('filterUser');
+		$filterTask = WebRequest::getString('filterTask');
+		$filterStatus = WebRequest::getString('filterStatus');
+		$filterRequest = WebRequest::getString('filterRequest');
+		$order = WebRequest::getString('order');
+
+		if ($filterUser !== null) {
+			$searchHelper->byUser(User::getByUsername($filterUser, $database)->getId());
+		}
+
+		if ($filterTask !== null) {
+			$searchHelper->byTask($filterTask);
+		}
+
+		if ($filterStatus !== null) {
+			$searchHelper->byStatus($filterStatus);
+		}
+
+		if ($filterRequest !== null) {
+			$searchHelper->byRequest($filterRequest);
+		}
         
-        if ($order === null) {
-            $searchHelper->newestFirst();
-        }
-
-        /** @var JobQueue[] $jobList */
-        $jobList = $searchHelper->getRecordCount($count)->fetch();
+		if ($order === null) {
+			$searchHelper->newestFirst();
+		}
+
+		/** @var JobQueue[] $jobList */
+		$jobList = $searchHelper->getRecordCount($count)->fetch();
 
-        $this->setupPageData($count, array(
-            'filterUser' => $filterUser,
-            'filterTask' => $filterTask,
-            'filterStatus' => $filterStatus,
-            'filterRequest' => $filterRequest,
-            'order' => $order,
-        ));
+		$this->setupPageData($count, array(
+			'filterUser' => $filterUser,
+			'filterTask' => $filterTask,
+			'filterStatus' => $filterStatus,
+			'filterRequest' => $filterRequest,
+			'order' => $order,
+		));
 
-        $userIds = array();
-        $requestIds = array();
+		$userIds = array();
+		$requestIds = array();
 
-        foreach ($jobList as $job) {
-            $userIds[] = $job->getTriggerUserId();
-            $requestIds[] = $job->getRequest();
+		foreach ($jobList as $job) {
+			$userIds[] = $job->getTriggerUserId();
+			$requestIds[] = $job->getRequest();
 
-            $job->setDatabase($database);
-        }
+			$job->setDatabase($database);
+		}
 
-        $this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database) {
-            return UserSearchHelper::get($database)->fetchColumn('username');
-        });
+		$this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database) {
+			return UserSearchHelper::get($database)->fetchColumn('username');
+		});
 
-        $this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
-        // FIXME: domains!
-        $this->assign('requests', RequestSearchHelper::get($database, 1)->inIds($requestIds)->fetchMap('name'));
+		$this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
+		// FIXME: domains!
+		$this->assign('requests', RequestSearchHelper::get($database, 1)->inIds($requestIds)->fetchMap('name'));
 
-        $this->assign('joblist', $jobList);
+		$this->assign('joblist', $jobList);
 
-        $this->addJs("/api.php?action=users&all=true&targetVariable=typeaheaddata");
+		$this->addJs("/api.php?action=users&all=true&targetVariable=typeaheaddata");
 
-        $this->setTemplate('jobqueue/all.tpl');
-    }
+		$this->setTemplate('jobqueue/all.tpl');
+	}
 
-    protected function view()
-    {
-        $jobId = WebRequest::getInt('id');
-        $database = $this->getDatabase();
+	protected function view()
+	{
+		$jobId = WebRequest::getInt('id');
+		$database = $this->getDatabase();
 
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
 
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
 
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
 
-        $this->prepareMaps();
+		$this->prepareMaps();
 
-        $this->assign('user', User::getById($job->getTriggerUserId(), $database));
-        $this->assign('request', Request::getById($job->getRequest(), $database));
-        $this->assign('emailTemplate', EmailTemplate::getById($job->getEmailTemplate(), $database));
-        $this->assign('parent', JobQueue::getById($job->getParent(), $database));
+		$this->assign('user', User::getById($job->getTriggerUserId(), $database));
+		$this->assign('request', Request::getById($job->getRequest(), $database));
+		$this->assign('emailTemplate', EmailTemplate::getById($job->getEmailTemplate(), $database));
+		$this->assign('parent', JobQueue::getById($job->getParent(), $database));
 
-        /** @var Log[] $logs */
-        // FIXME: domains
-        $logs = LogSearchHelper::get($database, 1)->byObjectType('JobQueue')
-            ->byObjectId($job->getId())->getRecordCount($logCount)->fetch();
-        if ($logCount === 0) {
-            $this->assign('log', array());
-        }
-        else {
-            list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration());
+		/** @var Log[] $logs */
+		// FIXME: domains
+		$logs = LogSearchHelper::get($database, 1)->byObjectType('JobQueue')
+			->byObjectId($job->getId())->getRecordCount($logCount)->fetch();
+		if ($logCount === 0) {
+			$this->assign('log', array());
+		}
+		else {
+			list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration());
 
-            $this->assign("log", $logData);
-            $this->assign("users", $users);
-        }
+			$this->assign("log", $logData);
+			$this->assign("users", $users);
+		}
 
-        $this->assignCSRFToken();
+		$this->assignCSRFToken();
 
-        $this->assign('job', $job);
+		$this->assign('job', $job);
 
-        $this->assign('canAcknowledge', $this->barrierTest('acknowledge', User::getCurrent($database)));
-        $this->assign('canRequeue', $this->barrierTest('requeue', User::getCurrent($database)));
-        $this->assign('canCancel', $this->barrierTest('cancel', User::getCurrent($database)));
+		$this->assign('canAcknowledge', $this->barrierTest('acknowledge', User::getCurrent($database)));
+		$this->assign('canRequeue', $this->barrierTest('requeue', User::getCurrent($database)));
+		$this->assign('canCancel', $this->barrierTest('cancel', User::getCurrent($database)));
 
-        if ($job->getTask() === UserCreationTask::class || $job->getTask() === BotCreationTask::class) {
-            if ($job->getEmailTemplate() === null) {
-                $params = json_decode($job->getParameters());
+		if ($job->getTask() === UserCreationTask::class || $job->getTask() === BotCreationTask::class) {
+			if ($job->getEmailTemplate() === null) {
+				$params = json_decode($job->getParameters());
 
-                if (isset($params->emailText)) {
-                    $this->assign("creationEmailText", $params->emailText);
-                }
-            }
-        }
+				if (isset($params->emailText)) {
+					$this->assign("creationEmailText", $params->emailText);
+				}
+			}
+		}
 
-        $this->setHtmlTitle('Job #{$job->getId()|escape}');
-        $this->setTemplate('jobqueue/view.tpl');
-    }
+		$this->setHtmlTitle('Job #{$job->getId()|escape}');
+		$this->setTemplate('jobqueue/view.tpl');
+	}
 
-    protected function acknowledge()
-    {
-        if (!WebRequest::wasPosted()) {
-            throw new ApplicationLogicException('This page does not support GET methods.');
-        }
+	protected function acknowledge()
+	{
+		if (!WebRequest::wasPosted()) {
+			throw new ApplicationLogicException('This page does not support GET methods.');
+		}
 
-        $this->validateCSRFToken();
+		$this->validateCSRFToken();
 
-        $jobId = WebRequest::postInt('job');
-        $database = $this->getDatabase();
+		$jobId = WebRequest::postInt('job');
+		$database = $this->getDatabase();
 
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
 
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
 
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
 
-        $job->setUpdateVersion(WebRequest::postInt('updateVersion'));
-        $job->setAcknowledged(true);
-        $job->save();
+		$job->setUpdateVersion(WebRequest::postInt('updateVersion'));
+		$job->setAcknowledged(true);
+		$job->save();
 
-        Logger::backgroundJobAcknowledged($database, $job);
+		Logger::backgroundJobAcknowledged($database, $job);
 
-        $this->redirect('jobQueue', 'view', array('id' => $jobId));
-    }
-
-    protected function cancel()
-    {
-        if (!WebRequest::wasPosted()) {
-            throw new ApplicationLogicException('This page does not support GET methods.');
-        }
-
-        $this->validateCSRFToken();
-
-        $jobId = WebRequest::postInt('job');
-        $database = $this->getDatabase();
-
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
-
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
-
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
-
-        if ($job->getStatus() !== JobQueue::STATUS_READY
-            && $job->getStatus() !== JobQueue::STATUS_QUEUED
-            && $job->getStatus() === JobQueue::STATUS_WAITING) {
-            throw new ApplicationLogicException('Cannot cancel job not queued for execution');
-        }
-
-        $job->setUpdateVersion(WebRequest::postInt('updateVersion'));
-        $job->setStatus(JobQueue::STATUS_CANCELLED);
-        $job->setError("Manually cancelled");
-        $job->setAcknowledged(null);
-        $job->save();
-
-        Logger::backgroundJobCancelled($this->getDatabase(), $job);
-
-        $this->redirect('jobQueue', 'view', array('id' => $jobId));
-    }
-
-    protected function requeue()
-    {
-        if (!WebRequest::wasPosted()) {
-            throw new ApplicationLogicException('This page does not support GET methods.');
-        }
+		$this->redirect('jobQueue', 'view', array('id' => $jobId));
+	}
+
+	protected function cancel()
+	{
+		if (!WebRequest::wasPosted()) {
+			throw new ApplicationLogicException('This page does not support GET methods.');
+		}
+
+		$this->validateCSRFToken();
+
+		$jobId = WebRequest::postInt('job');
+		$database = $this->getDatabase();
+
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
+
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
+
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
+
+		if ($job->getStatus() !== JobQueue::STATUS_READY
+			&& $job->getStatus() !== JobQueue::STATUS_QUEUED
+			&& $job->getStatus() === JobQueue::STATUS_WAITING) {
+			throw new ApplicationLogicException('Cannot cancel job not queued for execution');
+		}
+
+		$job->setUpdateVersion(WebRequest::postInt('updateVersion'));
+		$job->setStatus(JobQueue::STATUS_CANCELLED);
+		$job->setError("Manually cancelled");
+		$job->setAcknowledged(null);
+		$job->save();
+
+		Logger::backgroundJobCancelled($this->getDatabase(), $job);
+
+		$this->redirect('jobQueue', 'view', array('id' => $jobId));
+	}
+
+	protected function requeue()
+	{
+		if (!WebRequest::wasPosted()) {
+			throw new ApplicationLogicException('This page does not support GET methods.');
+		}
 
-        $this->validateCSRFToken();
+		$this->validateCSRFToken();
 
-        $jobId = WebRequest::postInt('job');
-        $database = $this->getDatabase();
-
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
-
-        /** @var JobQueue|false $job */
-        $job = JobQueue::getById($jobId, $database);
-
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
-
-        $job->setStatus(JobQueue::STATUS_QUEUED);
-        $job->setUpdateVersion(WebRequest::postInt('updateVersion'));
-        $job->setAcknowledged(null);
-        $job->setError(null);
-        $job->save();
-
-        /** @var Request $request */
-        $request = Request::getById($job->getRequest(), $database);
-        $request->setStatus(RequestStatus::JOBQUEUE);
-        $request->save();
-
-        Logger::enqueuedJobQueue($database, $request);
-        Logger::backgroundJobRequeued($database, $job);
+		$jobId = WebRequest::postInt('job');
+		$database = $this->getDatabase();
+
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
+
+		/** @var JobQueue|false $job */
+		$job = JobQueue::getById($jobId, $database);
+
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
+
+		$job->setStatus(JobQueue::STATUS_QUEUED);
+		$job->setUpdateVersion(WebRequest::postInt('updateVersion'));
+		$job->setAcknowledged(null);
+		$job->setError(null);
+		$job->save();
+
+		/** @var Request $request */
+		$request = Request::getById($job->getRequest(), $database);
+		$request->setStatus(RequestStatus::JOBQUEUE);
+		$request->save();
+
+		Logger::enqueuedJobQueue($database, $request);
+		Logger::backgroundJobRequeued($database, $job);
 
-        $this->redirect('jobQueue', 'view', array('id' => $jobId));
-    }
-
-    protected function prepareMaps()
-    {
-        $taskNameMap = JobQueue::getTaskDescriptions();
-
-        $statusDecriptionMap = array(
-            JobQueue::STATUS_CANCELLED => 'The job was cancelled',
-            JobQueue::STATUS_COMPLETE  => 'The job completed successfully',
-            JobQueue::STATUS_FAILED    => 'The job encountered an error',
-            JobQueue::STATUS_QUEUED    => 'The job is in the queue',
-            JobQueue::STATUS_READY     => 'The job is ready to be picked up by the next job runner execution',
-            JobQueue::STATUS_RUNNING   => 'The job is being run right now by the job runner',
-            JobQueue::STATUS_WAITING   => 'The job has been picked up by a job runner',
-            JobQueue::STATUS_HELD      => 'The job has manually held from processing',
-        );
-        $this->assign('taskNameMap', $taskNameMap);
-        $this->assign('statusDescriptionMap', $statusDecriptionMap);
-    }
+		$this->redirect('jobQueue', 'view', array('id' => $jobId));
+	}
+
+	protected function prepareMaps()
+	{
+		$taskNameMap = JobQueue::getTaskDescriptions();
+
+		$statusDecriptionMap = array(
+			JobQueue::STATUS_CANCELLED => 'The job was cancelled',
+			JobQueue::STATUS_COMPLETE  => 'The job completed successfully',
+			JobQueue::STATUS_FAILED    => 'The job encountered an error',
+			JobQueue::STATUS_QUEUED    => 'The job is in the queue',
+			JobQueue::STATUS_READY     => 'The job is ready to be picked up by the next job runner execution',
+			JobQueue::STATUS_RUNNING   => 'The job is being run right now by the job runner',
+			JobQueue::STATUS_WAITING   => 'The job has been picked up by a job runner',
+			JobQueue::STATUS_HELD      => 'The job has manually held from processing',
+		);
+		$this->assign('taskNameMap', $taskNameMap);
+		$this->assign('statusDescriptionMap', $statusDecriptionMap);
+	}
 }

includes/API/IXmlApiAction.php

Indentation +8 added lines, -8 removed lines

@@ -16,12 +16,12 @@
  */
 interface IXmlApiAction extends IRoutedTask, IApiAction
 {
-    /**
-     * Method that runs API action
-     *
-     * @param DOMElement $apiDocument
-     *
-     * @return DOMElement The modified API document
-     */
-    public function executeApiAction(DOMElement $apiDocument);
+	/**
+	 * Method that runs API action
+	 *
+	 * @param DOMElement $apiDocument
+	 *
+	 * @return DOMElement The modified API document
+	 */
+	public function executeApiAction(DOMElement $apiDocument);
 }

includes/API/IJsonApiAction.php

Indentation +6 added lines, -6 removed lines

@@ -15,10 +15,10 @@
  */
 interface IJsonApiAction extends IRoutedTask, IApiAction
 {
-    /**
-     * Method that runs API action
-     *
-     * @return object|array The modified API document
-     */
-    public function executeApiAction();
+	/**
+	 * Method that runs API action
+	 *
+	 * @return object|array The modified API document
+	 */
+	public function executeApiAction();
 }

includes/API/Actions/UnknownAction.php

Indentation +9 added lines, -9 removed lines

@@ -16,15 +16,15 @@
  */
 class UnknownAction extends HelpAction implements IXmlApiAction
 {
-    public function executeApiAction(DOMElement $apiDocument)
-    {
-        $errorText = "Unknown API action specified.";
-        $errorNode = $this->document->createElement("error", $errorText);
-        $apiDocument->appendChild($errorNode);
+	public function executeApiAction(DOMElement $apiDocument)
+	{
+		$errorText = "Unknown API action specified.";
+		$errorNode = $this->document->createElement("error", $errorText);
+		$apiDocument->appendChild($errorNode);
 
-        $helpElement = $this->getHelpElement();
-        $apiDocument->appendChild($helpElement);
+		$helpElement = $this->getHelpElement();
+		$apiDocument->appendChild($helpElement);
 
-        return $apiDocument;
-    }
+		return $apiDocument;
+	}
 }