enwikipedia-acc / waca

includes/Exceptions/ReadableException.php

Indentation +15 added lines, -15 removed lines

@@ -21,22 +21,22 @@
  */
 abstract class ReadableException extends Exception
 {
-    use TemplateOutput;
+	use TemplateOutput;
 
-    /**
-     * Returns a readable HTML error message that's displayable to the user using templates.
-     * @return string
-     */
-    abstract public function getReadableError();
+	/**
+	 * Returns a readable HTML error message that's displayable to the user using templates.
+	 * @return string
+	 */
+	abstract public function getReadableError();
 
-    /**
-     * @return SiteConfiguration
-     */
-    protected function getSiteConfiguration()
-    {
-        // Uck. However, we have encountered an exception.
-        global $siteConfiguration;
+	/**
+	 * @return SiteConfiguration
+	 */
+	protected function getSiteConfiguration()
+	{
+		// Uck. However, we have encountered an exception.
+		global $siteConfiguration;
 
-        return $siteConfiguration;
-    }
+		return $siteConfiguration;
+	}
 }
\ No newline at end of file

includes/Exceptions/EnvironmentException.php

Indentation +9 added lines, -9 removed lines

@@ -21,13 +21,13 @@
  */
 class EnvironmentException extends Exception
 {
-    /**
-     * EnvironmentException constructor.
-     *
-     * @param string $friendlyMessage
-     */
-    public function __construct($friendlyMessage)
-    {
-        parent::__construct($friendlyMessage);
-    }
+	/**
+	 * EnvironmentException constructor.
+	 *
+	 * @param string $friendlyMessage
+	 */
+	public function __construct($friendlyMessage)
+	{
+		parent::__construct($friendlyMessage);
+	}
 }
\ No newline at end of file

includes/Exceptions/AccessDeniedException.php

Indentation +45 added lines, -45 removed lines

@@ -22,60 +22,60 @@
  */
 class AccessDeniedException extends ReadableException
 {
-    public function getReadableError()
-    {
-        if (!headers_sent()) {
-            header("HTTP/1.1 403 Forbidden");
-        }
+	public function getReadableError()
+	{
+		if (!headers_sent()) {
+			header("HTTP/1.1 403 Forbidden");
+		}
 
-        $this->setUpSmarty();
+		$this->setUpSmarty();
 
-        // uck. We should still be able to access the database in this situation though.
-        $database = PdoDatabase::getDatabaseConnection('acc');
-        $currentUser = User::getCurrent($database);
-        $this->assign('currentUser', $currentUser);
-        $this->assign("loggedIn", (!$currentUser->isCommunityUser()));
+		// uck. We should still be able to access the database in this situation though.
+		$database = PdoDatabase::getDatabaseConnection('acc');
+		$currentUser = User::getCurrent($database);
+		$this->assign('currentUser', $currentUser);
+		$this->assign("loggedIn", (!$currentUser->isCommunityUser()));
 
-        if ($currentUser->isDeclined()) {
-            $this->assign('htmlTitle', 'Account Declined');
-            $this->assign('declineReason', $this->getLogEntry('Declined', $currentUser, $database));
+		if ($currentUser->isDeclined()) {
+			$this->assign('htmlTitle', 'Account Declined');
+			$this->assign('declineReason', $this->getLogEntry('Declined', $currentUser, $database));
 
-            return $this->fetchTemplate("exception/account-declined.tpl");
-        }
+			return $this->fetchTemplate("exception/account-declined.tpl");
+		}
 
-        if ($currentUser->isSuspended()) {
-            $this->assign('htmlTitle', 'Account Suspended');
-            $this->assign('suspendReason', $this->getLogEntry('Suspended', $currentUser, $database));
+		if ($currentUser->isSuspended()) {
+			$this->assign('htmlTitle', 'Account Suspended');
+			$this->assign('suspendReason', $this->getLogEntry('Suspended', $currentUser, $database));
 
-            return $this->fetchTemplate("exception/account-suspended.tpl");
-        }
+			return $this->fetchTemplate("exception/account-suspended.tpl");
+		}
 
-        if ($currentUser->isNewUser()) {
-            $this->assign('htmlTitle', 'Account Pending');
+		if ($currentUser->isNewUser()) {
+			$this->assign('htmlTitle', 'Account Pending');
 
-            return $this->fetchTemplate("exception/account-new.tpl");
-        }
+			return $this->fetchTemplate("exception/account-new.tpl");
+		}
 
-        return $this->fetchTemplate("exception/access-denied.tpl");
-    }
+		return $this->fetchTemplate("exception/access-denied.tpl");
+	}
 
-    /**
-     * @param string      $action
-     * @param User        $user
-     * @param PdoDatabase $database
-     *
-     * @return null|string
-     */
-    private function getLogEntry($action, User $user, PdoDatabase $database)
-    {
-        /** @var Log[] $logs */
-        $logs = LogSearchHelper::get($database)
-            ->byAction($action)
-            ->byObjectType('User')
-            ->byObjectId($user->getId())
-            ->limit(1)
-            ->fetch();
+	/**
+	 * @param string      $action
+	 * @param User        $user
+	 * @param PdoDatabase $database
+	 *
+	 * @return null|string
+	 */
+	private function getLogEntry($action, User $user, PdoDatabase $database)
+	{
+		/** @var Log[] $logs */
+		$logs = LogSearchHelper::get($database)
+			->byAction($action)
+			->byObjectType('User')
+			->byObjectId($user->getId())
+			->limit(1)
+			->fetch();
 
-        return $logs[0]->getComment();
-    }
+		return $logs[0]->getComment();
+	}
 }
\ No newline at end of file

includes/PdoDatabase.php

Indentation +108 added lines, -108 removed lines

@@ -15,112 +15,112 @@
 
 class PdoDatabase extends PDO
 {
-    /**
-     * @var PdoDatabase[]
-     */
-    private static $connections = array();
-    /**
-     * @var bool True if a transaction is active
-     */
-    protected $hasActiveTransaction = false;
-
-    /**
-     * Unless you're doing low-level work, this is not the function you want.
-     *
-     * @param string $connectionName
-     *
-     * @return PdoDatabase
-     * @throws Exception
-     */
-    public static function getDatabaseConnection($connectionName)
-    {
-        if (!isset(self::$connections[$connectionName])) {
-            global $cDatabaseConfig;
-
-            if (!array_key_exists($connectionName, $cDatabaseConfig)) {
-                throw new Exception("Database configuration not found for alias $connectionName");
-            }
-
-            try {
-                $databaseObject = new PdoDatabase(
-                    $cDatabaseConfig[$connectionName]["dsrcname"],
-                    $cDatabaseConfig[$connectionName]["username"],
-                    $cDatabaseConfig[$connectionName]["password"]
-                );
-            }
-            catch (PDOException $ex) {
-                // wrap around any potential stack traces which may include passwords
-                throw new EnvironmentException("Error connecting to database '$connectionName': " . $ex->getMessage());
-            }
-
-            $databaseObject->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
-
-            // emulating prepared statements gives a performance boost on MySQL.
-            //
-            // however, our version of PDO doesn't seem to understand parameter types when emulating
-            // the prepared statements, so we're forced to turn this off for now.
-            // -- stw 2014-02-11
-            $databaseObject->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
-
-            self::$connections[$connectionName] = $databaseObject;
-        }
-
-        return self::$connections[$connectionName];
-    }
-
-    /**
-     * Determines if this connection has a transaction in progress or not
-     * @return boolean true if there is a transaction in progress.
-     */
-    public function hasActiveTransaction()
-    {
-        return $this->hasActiveTransaction;
-    }
-
-    /**
-     * Summary of beginTransaction
-     * @return bool
-     */
-    public function beginTransaction()
-    {
-        // Override the pre-existing method, which doesn't stop you from
-        // starting transactions within transactions - which doesn't work and
-        // will throw an exception. This eliminates the need to catch exceptions
-        // all over the rest of the code
-        if ($this->hasActiveTransaction) {
-            return false;
-        }
-        else {
-            // set the transaction isolation level for every transaction.
-            $this->exec("SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;");
-
-            // start a new transaction, and return whether or not the start was
-            // successful
-            $this->hasActiveTransaction = parent::beginTransaction();
-
-            return $this->hasActiveTransaction;
-        }
-    }
-
-    /**
-     * Commits the active transaction
-     */
-    public function commit()
-    {
-        if ($this->hasActiveTransaction) {
-            parent::commit();
-            $this->hasActiveTransaction = false;
-        }
-    }
-
-    /**
-     * Rolls back a transaction
-     */
-    public function rollBack()
-    {
-        if ($this->hasActiveTransaction) {
-            parent::rollback();
-            $this->hasActiveTransaction = false;
-        }
-    }
+	/**
+	 * @var PdoDatabase[]
+	 */
+	private static $connections = array();
+	/**
+	 * @var bool True if a transaction is active
+	 */
+	protected $hasActiveTransaction = false;
+
+	/**
+	 * Unless you're doing low-level work, this is not the function you want.
+	 *
+	 * @param string $connectionName
+	 *
+	 * @return PdoDatabase
+	 * @throws Exception
+	 */
+	public static function getDatabaseConnection($connectionName)
+	{
+		if (!isset(self::$connections[$connectionName])) {
+			global $cDatabaseConfig;
+
+			if (!array_key_exists($connectionName, $cDatabaseConfig)) {
+				throw new Exception("Database configuration not found for alias $connectionName");
+			}
+
+			try {
+				$databaseObject = new PdoDatabase(
+					$cDatabaseConfig[$connectionName]["dsrcname"],
+					$cDatabaseConfig[$connectionName]["username"],
+					$cDatabaseConfig[$connectionName]["password"]
+				);
+			}
+			catch (PDOException $ex) {
+				// wrap around any potential stack traces which may include passwords
+				throw new EnvironmentException("Error connecting to database '$connectionName': " . $ex->getMessage());
+			}
+
+			$databaseObject->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+
+			// emulating prepared statements gives a performance boost on MySQL.
+			//
+			// however, our version of PDO doesn't seem to understand parameter types when emulating
+			// the prepared statements, so we're forced to turn this off for now.
+			// -- stw 2014-02-11
+			$databaseObject->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
+
+			self::$connections[$connectionName] = $databaseObject;
+		}
+
+		return self::$connections[$connectionName];
+	}
+
+	/**
+	 * Determines if this connection has a transaction in progress or not
+	 * @return boolean true if there is a transaction in progress.
+	 */
+	public function hasActiveTransaction()
+	{
+		return $this->hasActiveTransaction;
+	}
+
+	/**
+	 * Summary of beginTransaction
+	 * @return bool
+	 */
+	public function beginTransaction()
+	{
+		// Override the pre-existing method, which doesn't stop you from
+		// starting transactions within transactions - which doesn't work and
+		// will throw an exception. This eliminates the need to catch exceptions
+		// all over the rest of the code
+		if ($this->hasActiveTransaction) {
+			return false;
+		}
+		else {
+			// set the transaction isolation level for every transaction.
+			$this->exec("SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;");
+
+			// start a new transaction, and return whether or not the start was
+			// successful
+			$this->hasActiveTransaction = parent::beginTransaction();
+
+			return $this->hasActiveTransaction;
+		}
+	}
+
+	/**
+	 * Commits the active transaction
+	 */
+	public function commit()
+	{
+		if ($this->hasActiveTransaction) {
+			parent::commit();
+			$this->hasActiveTransaction = false;
+		}
+	}
+
+	/**
+	 * Rolls back a transaction
+	 */
+	public function rollBack()
+	{
+		if ($this->hasActiveTransaction) {
+			parent::rollback();
+			$this->hasActiveTransaction = false;
+		}
+	}
 }

includes/ExceptionHandler.php

Indentation +89 added lines, -89 removed lines

@@ -13,22 +13,22 @@ 
 
 class ExceptionHandler
 {
-    /**
-     * Global exception handler
-     *
-     * Smarty would be nice to use, but it COULD BE smarty that throws the errors.
-     * Let's build something ourselves, and hope it works.
-     *
-     * @param $exception
-     *
-     * @category Security-Critical - has the potential to leak data when exception is thrown.
-     */
-    public static function exceptionHandler(Exception $exception)
-    {
-        /** @global $siteConfiguration SiteConfiguration */
-        global $siteConfiguration;
-
-        $errorDocument = <<<HTML
+	/**
+	 * Global exception handler
+	 *
+	 * Smarty would be nice to use, but it COULD BE smarty that throws the errors.
+	 * Let's build something ourselves, and hope it works.
+	 *
+	 * @param $exception
+	 *
+	 * @category Security-Critical - has the potential to leak data when exception is thrown.
+	 */
+	public static function exceptionHandler(Exception $exception)
+	{
+		/** @global $siteConfiguration SiteConfiguration */
+		global $siteConfiguration;
+
+		$errorDocument = <<<HTML
 <!DOCTYPE html>
 <html lang="en"><head>
 <meta charset="utf-8">
@@ -49,77 +49,77 @@ 
 </div></body></html>
 HTML;
 
-        $errorData = self::getExceptionData($exception);
-        $errorData['server'] = $_SERVER;
-        $errorData['get'] = $_GET;
-        $errorData['post'] = $_POST;
-
-        $state = serialize($errorData);
-        $errorId = sha1($state);
-
-        // Save the error for later analysis
-        file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);
-
-        // clear and discard any content that's been saved to the output buffer
-        if (ob_get_level() > 0) {
-            ob_end_clean();
-        }
-
-        // push error ID into the document.
-        $message = str_replace('$1$', $errorId, $errorDocument);
-
-        if ($siteConfiguration->getDebuggingTraceEnabled()) {
-            ob_start();
-            var_dump($errorData);
-            $textErrorData = ob_get_contents();
-            ob_end_clean();
-
-            $message = str_replace('$2$', $textErrorData, $message);
-        }
-        else {
-            $message = str_replace('$2$', "", $message);
-        }
-
-        // While we *shouldn't* have sent headers by now due to the output buffering, PHPUnit does weird things.
-        // This is "only" needed for the tests, but it's a good idea to wrap this anyway.
-        if (!headers_sent()) {
-            header('HTTP/1.1 500 Internal Server Error');
-        }
-
-        // output the document
-        print $message;
-    }
-
-    /**
-     * @param int    $errorSeverity The severity level of the exception.
-     * @param string $errorMessage  The Exception message to throw.
-     * @param string $errorFile     The filename where the exception is thrown.
-     * @param int    $errorLine     The line number where the exception is thrown.
-     *
-     * @throws ErrorException
-     */
-    public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
-    {
-        // call into the main exception handler above
-        throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
-    }
-
-    /**
-     * @param Exception $exception
-     *
-     * @return null|array
-     */
-    private static function getExceptionData($exception)
-    {
-        if ($exception == null) {
-            return null;
-        }
-
-        return array(
-            'exception' => get_class($exception),
-            'message'   => $exception->getMessage(),
-            'stack'     => $exception->getTraceAsString(),
-            'previous'  => self::getExceptionData($exception->getPrevious()),
-        );
-    }
+		$errorData = self::getExceptionData($exception);
+		$errorData['server'] = $_SERVER;
+		$errorData['get'] = $_GET;
+		$errorData['post'] = $_POST;
+
+		$state = serialize($errorData);
+		$errorId = sha1($state);
+
+		// Save the error for later analysis
+		file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);
+
+		// clear and discard any content that's been saved to the output buffer
+		if (ob_get_level() > 0) {
+			ob_end_clean();
+		}
+
+		// push error ID into the document.
+		$message = str_replace('$1$', $errorId, $errorDocument);
+
+		if ($siteConfiguration->getDebuggingTraceEnabled()) {
+			ob_start();
+			var_dump($errorData);
+			$textErrorData = ob_get_contents();
+			ob_end_clean();
+
+			$message = str_replace('$2$', $textErrorData, $message);
+		}
+		else {
+			$message = str_replace('$2$', "", $message);
+		}
+
+		// While we *shouldn't* have sent headers by now due to the output buffering, PHPUnit does weird things.
+		// This is "only" needed for the tests, but it's a good idea to wrap this anyway.
+		if (!headers_sent()) {
+			header('HTTP/1.1 500 Internal Server Error');
+		}
+
+		// output the document
+		print $message;
+	}
+
+	/**
+	 * @param int    $errorSeverity The severity level of the exception.
+	 * @param string $errorMessage  The Exception message to throw.
+	 * @param string $errorFile     The filename where the exception is thrown.
+	 * @param int    $errorLine     The line number where the exception is thrown.
+	 *
+	 * @throws ErrorException
+	 */
+	public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
+	{
+		// call into the main exception handler above
+		throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
+	}
+
+	/**
+	 * @param Exception $exception
+	 *
+	 * @return null|array
+	 */
+	private static function getExceptionData($exception)
+	{
+		if ($exception == null) {
+			return null;
+		}
+
+		return array(
+			'exception' => get_class($exception),
+			'message'   => $exception->getMessage(),
+			'stack'     => $exception->getTraceAsString(),
+			'previous'  => self::getExceptionData($exception->getPrevious()),
+		);
+	}
 }
\ No newline at end of file

includes/Validation/RequestValidationHelper.php

Indentation +284 added lines, -284 removed lines

@@ -22,288 +22,288 @@
  */
 class RequestValidationHelper
 {
-    /** @var IBanHelper */
-    private $banHelper;
-    /** @var Request */
-    private $request;
-    private $emailConfirmation;
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IAntiSpoofProvider */
-    private $antiSpoofProvider;
-    /** @var IXffTrustProvider */
-    private $xffTrustProvider;
-    /** @var HttpHelper */
-    private $httpHelper;
-    /**
-     * @var string
-     */
-    private $mediawikiApiEndpoint;
-    private $titleBlacklistEnabled;
-    /**
-     * @var TorExitProvider
-     */
-    private $torExitProvider;
-
-    /**
-     * Summary of __construct
-     *
-     * @param IBanHelper         $banHelper
-     * @param Request            $request
-     * @param string             $emailConfirmation
-     * @param PdoDatabase        $database
-     * @param IAntiSpoofProvider $antiSpoofProvider
-     * @param IXffTrustProvider  $xffTrustProvider
-     * @param HttpHelper         $httpHelper
-     * @param string             $mediawikiApiEndpoint
-     * @param boolean            $titleBlacklistEnabled
-     * @param TorExitProvider    $torExitProvider
-     */
-    public function __construct(
-        IBanHelper $banHelper,
-        Request $request,
-        $emailConfirmation,
-        PdoDatabase $database,
-        IAntiSpoofProvider $antiSpoofProvider,
-        IXffTrustProvider $xffTrustProvider,
-        HttpHelper $httpHelper,
-        $mediawikiApiEndpoint,
-        $titleBlacklistEnabled,
-        TorExitProvider $torExitProvider
-    ) {
-        $this->banHelper = $banHelper;
-        $this->request = $request;
-        $this->emailConfirmation = $emailConfirmation;
-        $this->database = $database;
-        $this->antiSpoofProvider = $antiSpoofProvider;
-        $this->xffTrustProvider = $xffTrustProvider;
-        $this->httpHelper = $httpHelper;
-        $this->mediawikiApiEndpoint = $mediawikiApiEndpoint;
-        $this->titleBlacklistEnabled = $titleBlacklistEnabled;
-        $this->torExitProvider = $torExitProvider;
-    }
-
-    /**
-     * Summary of validateName
-     * @return ValidationError[]
-     */
-    public function validateName()
-    {
-        $errorList = array();
-
-        // ERRORS
-        // name is empty
-        if (trim($this->request->getName()) == "") {
-            $errorList[ValidationError::NAME_EMPTY] = new ValidationError(ValidationError::NAME_EMPTY);
-        }
-
-        // name is banned
-        $ban = $this->banHelper->nameIsBanned($this->request->getName());
-        if ($ban != false) {
-            $errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
-        }
-
-        // username already exists
-        if ($this->userExists()) {
-            $errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS);
-        }
-
-        // username part of SUL account
-        if ($this->userSulExists()) {
-            // using same error slot as name exists - it's the same sort of error, and we probably only want to show one.
-            $errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS_SUL);
-        }
-
-        // username is numbers
-        if (preg_match("/^[0-9]+$/", $this->request->getName()) === 1) {
-            $errorList[ValidationError::NAME_NUMONLY] = new ValidationError(ValidationError::NAME_NUMONLY);
-        }
-
-        // username can't contain #@/<>[]|{}
-        if (preg_match("/[" . preg_quote("#@/<>[]|{}", "/") . "]/", $this->request->getName()) === 1) {
-            $errorList[ValidationError::NAME_INVALIDCHAR] = new ValidationError(ValidationError::NAME_INVALIDCHAR);
-        }
-
-        // existing non-closed request for this name
-        if ($this->nameRequestExists()) {
-            $errorList[ValidationError::OPEN_REQUEST_NAME] = new ValidationError(ValidationError::OPEN_REQUEST_NAME);
-        }
-
-        return $errorList;
-    }
-
-    /**
-     * Summary of validateEmail
-     * @return ValidationError[]
-     */
-    public function validateEmail()
-    {
-        $errorList = array();
-
-        // ERRORS
-
-        // Email is banned
-        $ban = $this->banHelper->emailIsBanned($this->request->getEmail());
-        if ($ban != false) {
-            $errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
-        }
-
-        // email addresses must match
-        if ($this->request->getEmail() != $this->emailConfirmation) {
-            $errorList[ValidationError::EMAIL_MISMATCH] = new ValidationError(ValidationError::EMAIL_MISMATCH);
-        }
-
-        // email address must be validly formed
-        if (trim($this->request->getEmail()) == "") {
-            $errorList[ValidationError::EMAIL_EMPTY] = new ValidationError(ValidationError::EMAIL_EMPTY);
-        }
-
-        // email address must be validly formed
-        if (!filter_var($this->request->getEmail(), FILTER_VALIDATE_EMAIL)) {
-            if (trim($this->request->getEmail()) != "") {
-                $errorList[ValidationError::EMAIL_INVALID] = new ValidationError(ValidationError::EMAIL_INVALID);
-            }
-        }
-
-        // email address can't be wikimedia/wikipedia .com/org
-        if (preg_match('/.*@.*wiki(m.dia|p.dia)\.(org|com)/i', $this->request->getEmail()) === 1) {
-            $errorList[ValidationError::EMAIL_WIKIMEDIA] = new ValidationError(ValidationError::EMAIL_WIKIMEDIA);
-        }
-
-        // WARNINGS
-
-        return $errorList;
-    }
-
-    /**
-     * Summary of validateOther
-     * @return ValidationError[]
-     */
-    public function validateOther()
-    {
-        $errorList = array();
-
-        $trustedIp = $this->xffTrustProvider->getTrustedClientIp($this->request->getIp(),
-            $this->request->getForwardedIp());
-
-        // ERRORS
-
-        // TOR nodes
-        if ($this->torExitProvider->isTorExit($trustedIp)) {
-            $errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED_TOR);
-        }
-
-        // IP banned
-        $ban = $this->banHelper->ipIsBanned($trustedIp);
-        if ($ban != false) {
-            $errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
-        }
-
-        // WARNINGS
-
-        // Antispoof check
-        $this->checkAntiSpoof();
-
-        // Blacklist check
-        $this->checkTitleBlacklist();
-
-        return $errorList;
-    }
-
-    private function checkAntiSpoof()
-    {
-        try {
-            if (count($this->antiSpoofProvider->getSpoofs($this->request->getName())) > 0) {
-                // If there were spoofs an Admin should handle the request.
-                $this->request->setStatus("Flagged users");
-            }
-        }
-        catch (Exception $ex) {
-            // logme
-        }
-    }
-
-    private function checkTitleBlacklist()
-    {
-        if ($this->titleBlacklistEnabled == 1) {
-            $apiResult = $this->httpHelper->get(
-                $this->mediawikiApiEndpoint,
-                array(
-                    'action'       => 'titleblacklist',
-                    'tbtitle'      => $this->request->getName(),
-                    'tbaction'     => 'new-account',
-                    'tbnooverride' => true,
-                    'format'       => 'php',
-                )
-            );
-
-            $data = unserialize($apiResult);
-
-            $requestIsOk = $data['titleblacklist']['result'] == "ok";
-
-            if (!$requestIsOk) {
-                $this->request->setStatus("Flagged users");
-            }
-        }
-    }
-
-    private function userExists()
-    {
-        $userExists = $this->httpHelper->get(
-            $this->mediawikiApiEndpoint,
-            array(
-                'action'  => 'query',
-                'list'    => 'users',
-                'ususers' => $this->request->getName(),
-                'format'  => 'php',
-            )
-        );
-
-        $ue = unserialize($userExists);
-        if (!isset ($ue['query']['users']['0']['missing']) && isset ($ue['query']['users']['0']['userid'])) {
-            return true;
-        }
-
-        return false;
-    }
-
-    private function userSulExists()
-    {
-        $requestName = $this->request->getName();
-
-        $userExists = $this->httpHelper->get(
-            $this->mediawikiApiEndpoint,
-            array(
-                'action'  => 'query',
-                'meta'    => 'globaluserinfo',
-                'guiuser' => $requestName,
-                'format'  => 'php',
-            )
-        );
-
-        $ue = unserialize($userExists);
-        if (isset ($ue['query']['globaluserinfo']['id'])) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Checks if a request with this name is currently open
-     *
-     * @return bool
-     */
-    private function nameRequestExists()
-    {
-        $query = "SELECT COUNT(id) FROM request WHERE status != 'Closed' AND name = :name;";
-        $statement = $this->database->prepare($query);
-        $statement->execute(array(':name' => $this->request->getName()));
-
-        if (!$statement) {
-            return false;
-        }
-
-        return $statement->fetchColumn() > 0;
-    }
+	/** @var IBanHelper */
+	private $banHelper;
+	/** @var Request */
+	private $request;
+	private $emailConfirmation;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IAntiSpoofProvider */
+	private $antiSpoofProvider;
+	/** @var IXffTrustProvider */
+	private $xffTrustProvider;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/**
+	 * @var string
+	 */
+	private $mediawikiApiEndpoint;
+	private $titleBlacklistEnabled;
+	/**
+	 * @var TorExitProvider
+	 */
+	private $torExitProvider;
+
+	/**
+	 * Summary of __construct
+	 *
+	 * @param IBanHelper         $banHelper
+	 * @param Request            $request
+	 * @param string             $emailConfirmation
+	 * @param PdoDatabase        $database
+	 * @param IAntiSpoofProvider $antiSpoofProvider
+	 * @param IXffTrustProvider  $xffTrustProvider
+	 * @param HttpHelper         $httpHelper
+	 * @param string             $mediawikiApiEndpoint
+	 * @param boolean            $titleBlacklistEnabled
+	 * @param TorExitProvider    $torExitProvider
+	 */
+	public function __construct(
+		IBanHelper $banHelper,
+		Request $request,
+		$emailConfirmation,
+		PdoDatabase $database,
+		IAntiSpoofProvider $antiSpoofProvider,
+		IXffTrustProvider $xffTrustProvider,
+		HttpHelper $httpHelper,
+		$mediawikiApiEndpoint,
+		$titleBlacklistEnabled,
+		TorExitProvider $torExitProvider
+	) {
+		$this->banHelper = $banHelper;
+		$this->request = $request;
+		$this->emailConfirmation = $emailConfirmation;
+		$this->database = $database;
+		$this->antiSpoofProvider = $antiSpoofProvider;
+		$this->xffTrustProvider = $xffTrustProvider;
+		$this->httpHelper = $httpHelper;
+		$this->mediawikiApiEndpoint = $mediawikiApiEndpoint;
+		$this->titleBlacklistEnabled = $titleBlacklistEnabled;
+		$this->torExitProvider = $torExitProvider;
+	}
+
+	/**
+	 * Summary of validateName
+	 * @return ValidationError[]
+	 */
+	public function validateName()
+	{
+		$errorList = array();
+
+		// ERRORS
+		// name is empty
+		if (trim($this->request->getName()) == "") {
+			$errorList[ValidationError::NAME_EMPTY] = new ValidationError(ValidationError::NAME_EMPTY);
+		}
+
+		// name is banned
+		$ban = $this->banHelper->nameIsBanned($this->request->getName());
+		if ($ban != false) {
+			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
+		}
+
+		// username already exists
+		if ($this->userExists()) {
+			$errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS);
+		}
+
+		// username part of SUL account
+		if ($this->userSulExists()) {
+			// using same error slot as name exists - it's the same sort of error, and we probably only want to show one.
+			$errorList[ValidationError::NAME_EXISTS] = new ValidationError(ValidationError::NAME_EXISTS_SUL);
+		}
+
+		// username is numbers
+		if (preg_match("/^[0-9]+$/", $this->request->getName()) === 1) {
+			$errorList[ValidationError::NAME_NUMONLY] = new ValidationError(ValidationError::NAME_NUMONLY);
+		}
+
+		// username can't contain #@/<>[]|{}
+		if (preg_match("/[" . preg_quote("#@/<>[]|{}", "/") . "]/", $this->request->getName()) === 1) {
+			$errorList[ValidationError::NAME_INVALIDCHAR] = new ValidationError(ValidationError::NAME_INVALIDCHAR);
+		}
+
+		// existing non-closed request for this name
+		if ($this->nameRequestExists()) {
+			$errorList[ValidationError::OPEN_REQUEST_NAME] = new ValidationError(ValidationError::OPEN_REQUEST_NAME);
+		}
+
+		return $errorList;
+	}
+
+	/**
+	 * Summary of validateEmail
+	 * @return ValidationError[]
+	 */
+	public function validateEmail()
+	{
+		$errorList = array();
+
+		// ERRORS
+
+		// Email is banned
+		$ban = $this->banHelper->emailIsBanned($this->request->getEmail());
+		if ($ban != false) {
+			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
+		}
+
+		// email addresses must match
+		if ($this->request->getEmail() != $this->emailConfirmation) {
+			$errorList[ValidationError::EMAIL_MISMATCH] = new ValidationError(ValidationError::EMAIL_MISMATCH);
+		}
+
+		// email address must be validly formed
+		if (trim($this->request->getEmail()) == "") {
+			$errorList[ValidationError::EMAIL_EMPTY] = new ValidationError(ValidationError::EMAIL_EMPTY);
+		}
+
+		// email address must be validly formed
+		if (!filter_var($this->request->getEmail(), FILTER_VALIDATE_EMAIL)) {
+			if (trim($this->request->getEmail()) != "") {
+				$errorList[ValidationError::EMAIL_INVALID] = new ValidationError(ValidationError::EMAIL_INVALID);
+			}
+		}
+
+		// email address can't be wikimedia/wikipedia .com/org
+		if (preg_match('/.*@.*wiki(m.dia|p.dia)\.(org|com)/i', $this->request->getEmail()) === 1) {
+			$errorList[ValidationError::EMAIL_WIKIMEDIA] = new ValidationError(ValidationError::EMAIL_WIKIMEDIA);
+		}
+
+		// WARNINGS
+
+		return $errorList;
+	}
+
+	/**
+	 * Summary of validateOther
+	 * @return ValidationError[]
+	 */
+	public function validateOther()
+	{
+		$errorList = array();
+
+		$trustedIp = $this->xffTrustProvider->getTrustedClientIp($this->request->getIp(),
+			$this->request->getForwardedIp());
+
+		// ERRORS
+
+		// TOR nodes
+		if ($this->torExitProvider->isTorExit($trustedIp)) {
+			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED_TOR);
+		}
+
+		// IP banned
+		$ban = $this->banHelper->ipIsBanned($trustedIp);
+		if ($ban != false) {
+			$errorList[ValidationError::BANNED] = new ValidationError(ValidationError::BANNED);
+		}
+
+		// WARNINGS
+
+		// Antispoof check
+		$this->checkAntiSpoof();
+
+		// Blacklist check
+		$this->checkTitleBlacklist();
+
+		return $errorList;
+	}
+
+	private function checkAntiSpoof()
+	{
+		try {
+			if (count($this->antiSpoofProvider->getSpoofs($this->request->getName())) > 0) {
+				// If there were spoofs an Admin should handle the request.
+				$this->request->setStatus("Flagged users");
+			}
+		}
+		catch (Exception $ex) {
+			// logme
+		}
+	}
+
+	private function checkTitleBlacklist()
+	{
+		if ($this->titleBlacklistEnabled == 1) {
+			$apiResult = $this->httpHelper->get(
+				$this->mediawikiApiEndpoint,
+				array(
+					'action'       => 'titleblacklist',
+					'tbtitle'      => $this->request->getName(),
+					'tbaction'     => 'new-account',
+					'tbnooverride' => true,
+					'format'       => 'php',
+				)
+			);
+
+			$data = unserialize($apiResult);
+
+			$requestIsOk = $data['titleblacklist']['result'] == "ok";
+
+			if (!$requestIsOk) {
+				$this->request->setStatus("Flagged users");
+			}
+		}
+	}
+
+	private function userExists()
+	{
+		$userExists = $this->httpHelper->get(
+			$this->mediawikiApiEndpoint,
+			array(
+				'action'  => 'query',
+				'list'    => 'users',
+				'ususers' => $this->request->getName(),
+				'format'  => 'php',
+			)
+		);
+
+		$ue = unserialize($userExists);
+		if (!isset ($ue['query']['users']['0']['missing']) && isset ($ue['query']['users']['0']['userid'])) {
+			return true;
+		}
+
+		return false;
+	}
+
+	private function userSulExists()
+	{
+		$requestName = $this->request->getName();
+
+		$userExists = $this->httpHelper->get(
+			$this->mediawikiApiEndpoint,
+			array(
+				'action'  => 'query',
+				'meta'    => 'globaluserinfo',
+				'guiuser' => $requestName,
+				'format'  => 'php',
+			)
+		);
+
+		$ue = unserialize($userExists);
+		if (isset ($ue['query']['globaluserinfo']['id'])) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Checks if a request with this name is currently open
+	 *
+	 * @return bool
+	 */
+	private function nameRequestExists()
+	{
+		$query = "SELECT COUNT(id) FROM request WHERE status != 'Closed' AND name = :name;";
+		$statement = $this->database->prepare($query);
+		$statement->execute(array(':name' => $this->request->getName()));
+
+		if (!$statement) {
+			return false;
+		}
+
+		return $statement->fetchColumn() > 0;
+	}
 }

includes/Validation/ValidationError.php

Indentation +89 added lines, -89 removed lines

@@ -12,99 +12,99 @@
 
 class ValidationError
 {
-    const NAME_EMPTY = "name_empty";
-    const NAME_EXISTS = "name_exists";
-    const NAME_EXISTS_SUL = "name_exists";
-    const NAME_NUMONLY = "name_numonly";
-    const NAME_INVALIDCHAR = "name_invalidchar";
-    const NAME_SANITISED = "name_sanitised";
-    const EMAIL_EMPTY = "email_empty";
-    const EMAIL_WIKIMEDIA = "email_wikimedia";
-    const EMAIL_INVALID = "email_invalid";
-    const EMAIL_MISMATCH = "email_mismatch";
-    const OPEN_REQUEST_NAME = "open_request_name";
-    const BANNED = "banned";
-    const BANNED_TOR = "banned_tor";
-    /**
-     * @var array Error text for the above
-     */
-    private static $errorText = array(
-        self::NAME_EMPTY        => 'You\'ve not chosen a username!',
-        self::NAME_EXISTS       => 'I\'m sorry, but the username you selected is already taken. Please try another. '
-            . 'Please note that Wikipedia automatically capitalizes the first letter of any user name, therefore '
-            . '[[User:example]] would become [[User:Example]].',
-        self::NAME_EXISTS_SUL   => 'I\'m sorry, but the username you selected is already taken. Please try another. '
-            . 'Please note that Wikipedia automatically capitalizes the first letter of any user name, therefore '
-            . '[[User:example]] would become [[User:Example]].',
-        self::NAME_NUMONLY      => 'The username you chose is invalid: it consists entirely of numbers. Please retry '
-            . 'with a valid username.',
-        self::NAME_INVALIDCHAR  => 'There appears to be an invalid character in your username. Please note that the '
-            . 'following characters are not allowed: <code># @ / &lt; &gt; [ ] | { }</code>',
-        self::NAME_SANITISED    => 'Your requested username has been automatically adjusted due to technical '
-            . 'restrictions. Underscores have been replaced with spaces, and the first character has been capitalised.',
-        self::EMAIL_EMPTY       => 'You need to supply an email address.',
-        self::EMAIL_WIKIMEDIA   => 'Please provide your email address here.',
-        self::EMAIL_INVALID     => 'Invalid E-mail address supplied. Please check you entered it correctly.',
-        self::EMAIL_MISMATCH    => 'The email addresses you entered do not match. Please try again.',
-        self::OPEN_REQUEST_NAME => 'There is already an open request with this name in this system.',
-        self::BANNED            => 'I\'m sorry, but you are currently banned from requesting accounts using this tool. '
-            . 'However, you can still send an email to accounts-enwiki-l@lists.wikimedia.org to request an account.',
-        self::BANNED_TOR        => 'Tor exit nodes are currently banned from using this tool due to excessive abuse. '
-            . 'Please note that Tor is also currently banned from editing Wikipedia.',
-    );
-    /**
-     * Summary of $errorCode
-     * @var string
-     */
-    private $errorCode;
-    /**
-     * Summary of $isError
-     * @var bool
-     */
-    private $isError;
+	const NAME_EMPTY = "name_empty";
+	const NAME_EXISTS = "name_exists";
+	const NAME_EXISTS_SUL = "name_exists";
+	const NAME_NUMONLY = "name_numonly";
+	const NAME_INVALIDCHAR = "name_invalidchar";
+	const NAME_SANITISED = "name_sanitised";
+	const EMAIL_EMPTY = "email_empty";
+	const EMAIL_WIKIMEDIA = "email_wikimedia";
+	const EMAIL_INVALID = "email_invalid";
+	const EMAIL_MISMATCH = "email_mismatch";
+	const OPEN_REQUEST_NAME = "open_request_name";
+	const BANNED = "banned";
+	const BANNED_TOR = "banned_tor";
+	/**
+	 * @var array Error text for the above
+	 */
+	private static $errorText = array(
+		self::NAME_EMPTY        => 'You\'ve not chosen a username!',
+		self::NAME_EXISTS       => 'I\'m sorry, but the username you selected is already taken. Please try another. '
+			. 'Please note that Wikipedia automatically capitalizes the first letter of any user name, therefore '
+			. '[[User:example]] would become [[User:Example]].',
+		self::NAME_EXISTS_SUL   => 'I\'m sorry, but the username you selected is already taken. Please try another. '
+			. 'Please note that Wikipedia automatically capitalizes the first letter of any user name, therefore '
+			. '[[User:example]] would become [[User:Example]].',
+		self::NAME_NUMONLY      => 'The username you chose is invalid: it consists entirely of numbers. Please retry '
+			. 'with a valid username.',
+		self::NAME_INVALIDCHAR  => 'There appears to be an invalid character in your username. Please note that the '
+			. 'following characters are not allowed: <code># @ / &lt; &gt; [ ] | { }</code>',
+		self::NAME_SANITISED    => 'Your requested username has been automatically adjusted due to technical '
+			. 'restrictions. Underscores have been replaced with spaces, and the first character has been capitalised.',
+		self::EMAIL_EMPTY       => 'You need to supply an email address.',
+		self::EMAIL_WIKIMEDIA   => 'Please provide your email address here.',
+		self::EMAIL_INVALID     => 'Invalid E-mail address supplied. Please check you entered it correctly.',
+		self::EMAIL_MISMATCH    => 'The email addresses you entered do not match. Please try again.',
+		self::OPEN_REQUEST_NAME => 'There is already an open request with this name in this system.',
+		self::BANNED            => 'I\'m sorry, but you are currently banned from requesting accounts using this tool. '
+			. 'However, you can still send an email to accounts-enwiki-l@lists.wikimedia.org to request an account.',
+		self::BANNED_TOR        => 'Tor exit nodes are currently banned from using this tool due to excessive abuse. '
+			. 'Please note that Tor is also currently banned from editing Wikipedia.',
+	);
+	/**
+	 * Summary of $errorCode
+	 * @var string
+	 */
+	private $errorCode;
+	/**
+	 * Summary of $isError
+	 * @var bool
+	 */
+	private $isError;
 
-    /**
-     * Summary of __construct
-     *
-     * @param string $errorCode
-     * @param bool   $isError
-     */
-    public function __construct($errorCode, $isError = true)
-    {
-        $this->errorCode = $errorCode;
-        $this->isError = $isError;
-    }
+	/**
+	 * Summary of __construct
+	 *
+	 * @param string $errorCode
+	 * @param bool   $isError
+	 */
+	public function __construct($errorCode, $isError = true)
+	{
+		$this->errorCode = $errorCode;
+		$this->isError = $isError;
+	}
 
-    /**
-     * Summary of getErrorCode
-     * @return string
-     */
-    public function getErrorCode()
-    {
-        return $this->errorCode;
-    }
+	/**
+	 * Summary of getErrorCode
+	 * @return string
+	 */
+	public function getErrorCode()
+	{
+		return $this->errorCode;
+	}
 
-    /**
-     * @return string
-     * @throws Exception
-     */
-    public function getErrorMessage()
-    {
-        $text = self::$errorText[$this->errorCode];
+	/**
+	 * @return string
+	 * @throws Exception
+	 */
+	public function getErrorMessage()
+	{
+		$text = self::$errorText[$this->errorCode];
 
-        if ($text == null) {
-            throw new Exception('Unknown validation error');
-        }
+		if ($text == null) {
+			throw new Exception('Unknown validation error');
+		}
 
-        return $text;
-    }
+		return $text;
+	}
 
-    /**
-     * Summary of isError
-     * @return bool
-     */
-    public function isError()
-    {
-        return $this->isError;
-    }
+	/**
+	 * Summary of isError
+	 * @return bool
+	 */
+	public function isError()
+	{
+		return $this->isError;
+	}
 }

includes/Security/Token.php

Indentation +69 added lines, -69 removed lines

@@ -12,80 +12,80 @@
 
 class Token
 {
-    /** @var string */
-    private $tokenData;
-    /** @var string */
-    private $context;
-    /** @var DateTimeImmutable */
-    private $generationTimestamp;
-    /** @var DateTimeImmutable */
-    private $usageTimestamp;
-    /** @var bool */
-    private $used;
+	/** @var string */
+	private $tokenData;
+	/** @var string */
+	private $context;
+	/** @var DateTimeImmutable */
+	private $generationTimestamp;
+	/** @var DateTimeImmutable */
+	private $usageTimestamp;
+	/** @var bool */
+	private $used;
 
-    /**
-     * Token constructor.
-     *
-     * @param string $tokenData
-     * @param string $context
-     */
-    public function __construct($tokenData, $context)
-    {
-        $this->tokenData = $tokenData;
-        $this->context = $context;
-        $this->generationTimestamp = new DateTimeImmutable();
-        $this->usageTimestamp = null;
-        $this->used = false;
-    }
+	/**
+	 * Token constructor.
+	 *
+	 * @param string $tokenData
+	 * @param string $context
+	 */
+	public function __construct($tokenData, $context)
+	{
+		$this->tokenData = $tokenData;
+		$this->context = $context;
+		$this->generationTimestamp = new DateTimeImmutable();
+		$this->usageTimestamp = null;
+		$this->used = false;
+	}
 
-    /**
-     * @return DateTimeImmutable
-     */
-    public function getGenerationTimestamp()
-    {
-        return $this->generationTimestamp;
-    }
+	/**
+	 * @return DateTimeImmutable
+	 */
+	public function getGenerationTimestamp()
+	{
+		return $this->generationTimestamp;
+	}
 
-    /**
-     * @return string
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
+	/**
+	 * @return string
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
 
-    /**
-     * @return string
-     */
-    public function getTokenData()
-    {
-        return $this->tokenData;
-    }
+	/**
+	 * @return string
+	 */
+	public function getTokenData()
+	{
+		return $this->tokenData;
+	}
 
-    /**
-     * Returns a value indicating whether the token has already been used or not
-     *
-     * @return boolean
-     */
-    public function isUsed()
-    {
-        return $this->used;
-    }
+	/**
+	 * Returns a value indicating whether the token has already been used or not
+	 *
+	 * @return boolean
+	 */
+	public function isUsed()
+	{
+		return $this->used;
+	}
 
-    /**
-     * Marks the token as used
-     */
-    public function markAsUsed()
-    {
-        $this->used = true;
-        $this->usageTimestamp = new DateTimeImmutable();
-    }
+	/**
+	 * Marks the token as used
+	 */
+	public function markAsUsed()
+	{
+		$this->used = true;
+		$this->usageTimestamp = new DateTimeImmutable();
+	}
 
-    /**
-     * @return DateTimeImmutable
-     */
-    public function getUsageTimestamp()
-    {
-        return $this->usageTimestamp;
-    }
+	/**
+	 * @return DateTimeImmutable
+	 */
+	public function getUsageTimestamp()
+	{
+		return $this->usageTimestamp;
+	}
 }
\ No newline at end of file

includes/Security/SecurityConfiguration.php

Indentation +182 added lines, -182 removed lines

@@ -15,186 +15,186 @@
  */
 final class SecurityConfiguration
 {
-    const ALLOW = "allow";
-    const DENY = "deny";
-    private $admin = "default";
-    private $user = "default";
-    private $checkuser = "default";
-    private $community = "default";
-    private $suspended = "default";
-    private $declined = "default";
-    private $new = "default";
-    private $requireIdentified;
-
-    /**
-     * Sets whether a checkuser is able to gain access.
-     *
-     * This is private because it's DANGEROUS. Checkusers are not mutually-exclusive with other rights. As such, a
-     * suspended checkuser who tries to access a page which allows checkusers will be granted access to the page, UNLESS
-     * that page is also set to DENY (note, not default) New/Declined/Suspended users. I have no problem with this
-     * method being used, but please ONLY use it in this class in static methods of Security. Nowhere else.
-     *
-     * @param string $checkuser
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setCheckuser($checkuser)
-    {
-        $this->checkuser = $checkuser;
-
-        return $this;
-    }
-
-    /**
-     * Returns if a user is required to be identified.
-     *
-     * @return boolean
-     */
-    public function requiresIdentifiedUser()
-    {
-        return $this->requireIdentified;
-    }
-
-    /**
-     * @return string
-     */
-    public function getAdmin()
-    {
-        return $this->admin;
-    }
-
-    /**
-     * @param string $admin
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setAdmin($admin)
-    {
-        $this->admin = $admin;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param string $user
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCheckuser()
-    {
-        return $this->checkuser;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCommunity()
-    {
-        return $this->community;
-    }
-
-    /**
-     * @param string $community
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setCommunity($community)
-    {
-        $this->community = $community;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getSuspended()
-    {
-        return $this->suspended;
-    }
-
-    /**
-     * @param string $suspended
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setSuspended($suspended)
-    {
-        $this->suspended = $suspended;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDeclined()
-    {
-        return $this->declined;
-    }
-
-    /**
-     * @param string $declined
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setDeclined($declined)
-    {
-        $this->declined = $declined;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getNew()
-    {
-        return $this->new;
-    }
-
-    /**
-     * @param string $new
-     *
-     * @return SecurityConfiguration
-     * @category Security-Critical
-     */
-    public function setNew($new)
-    {
-        $this->new = $new;
-
-        return $this;
-    }
-
-    /**
-     * @param boolean $requireIdentified
-     */
-    public function setRequireIdentified($requireIdentified)
-    {
-        $this->requireIdentified = $requireIdentified;
-    }
+	const ALLOW = "allow";
+	const DENY = "deny";
+	private $admin = "default";
+	private $user = "default";
+	private $checkuser = "default";
+	private $community = "default";
+	private $suspended = "default";
+	private $declined = "default";
+	private $new = "default";
+	private $requireIdentified;
+
+	/**
+	 * Sets whether a checkuser is able to gain access.
+	 *
+	 * This is private because it's DANGEROUS. Checkusers are not mutually-exclusive with other rights. As such, a
+	 * suspended checkuser who tries to access a page which allows checkusers will be granted access to the page, UNLESS
+	 * that page is also set to DENY (note, not default) New/Declined/Suspended users. I have no problem with this
+	 * method being used, but please ONLY use it in this class in static methods of Security. Nowhere else.
+	 *
+	 * @param string $checkuser
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setCheckuser($checkuser)
+	{
+		$this->checkuser = $checkuser;
+
+		return $this;
+	}
+
+	/**
+	 * Returns if a user is required to be identified.
+	 *
+	 * @return boolean
+	 */
+	public function requiresIdentifiedUser()
+	{
+		return $this->requireIdentified;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getAdmin()
+	{
+		return $this->admin;
+	}
+
+	/**
+	 * @param string $admin
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setAdmin($admin)
+	{
+		$this->admin = $admin;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param string $user
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCheckuser()
+	{
+		return $this->checkuser;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCommunity()
+	{
+		return $this->community;
+	}
+
+	/**
+	 * @param string $community
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setCommunity($community)
+	{
+		$this->community = $community;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSuspended()
+	{
+		return $this->suspended;
+	}
+
+	/**
+	 * @param string $suspended
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setSuspended($suspended)
+	{
+		$this->suspended = $suspended;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDeclined()
+	{
+		return $this->declined;
+	}
+
+	/**
+	 * @param string $declined
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setDeclined($declined)
+	{
+		$this->declined = $declined;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getNew()
+	{
+		return $this->new;
+	}
+
+	/**
+	 * @param string $new
+	 *
+	 * @return SecurityConfiguration
+	 * @category Security-Critical
+	 */
+	public function setNew($new)
+	{
+		$this->new = $new;
+
+		return $this;
+	}
+
+	/**
+	 * @param boolean $requireIdentified
+	 */
+	public function setRequireIdentified($requireIdentified)
+	{
+		$this->requireIdentified = $requireIdentified;
+	}
 }
\ No newline at end of file