mdaniels5757 / waca

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/IrcColourCode.php

Indentation +23 added lines, -23 removed lines

@@ -10,27 +10,27 @@
 
 class IrcColourCode
 {
-    const BOLD = "\x02";
-    const ITALIC = "\x09";
-    const STRIKE = "\x13";
-    const UNDERLINE = "\x15";
-    const UNDERLINE2 = "\x1f";
-    const REVERSE = "\x16";
-    const RESET = "\x0f";
-    const WHITE = "\x0300";
-    const BLACK = "\x0301";
-    const DARK_BLUE = "\x0302";
-    const DARK_GREEN = "\x0303";
-    const RED = "\x0304";
-    const DARK_RED = "\x0305";
-    const DARK_VIOLET = "\x0306";
-    const ORANGE = "\x0307";
-    const YELLOW = "\x0308";
-    const LIGHT_GREEN = "\x0309";
-    const CYAN = "\x0310";
-    const LIGHT_CYAN = "\x0311";
-    const BLUE = "\x0312";
-    const VIOLET = "\x0313";
-    const DARK_GREY = "\x0314";
-    const LIGHT_GREY = "\x0315";
+	const BOLD = "\x02";
+	const ITALIC = "\x09";
+	const STRIKE = "\x13";
+	const UNDERLINE = "\x15";
+	const UNDERLINE2 = "\x1f";
+	const REVERSE = "\x16";
+	const RESET = "\x0f";
+	const WHITE = "\x0300";
+	const BLACK = "\x0301";
+	const DARK_BLUE = "\x0302";
+	const DARK_GREEN = "\x0303";
+	const RED = "\x0304";
+	const DARK_RED = "\x0305";
+	const DARK_VIOLET = "\x0306";
+	const ORANGE = "\x0307";
+	const YELLOW = "\x0308";
+	const LIGHT_GREEN = "\x0309";
+	const CYAN = "\x0310";
+	const LIGHT_CYAN = "\x0311";
+	const BLUE = "\x0312";
+	const VIOLET = "\x0313";
+	const DARK_GREY = "\x0314";
+	const LIGHT_GREY = "\x0315";
 }

includes/Session.php

Indentation +17 added lines, -17 removed lines

@@ -17,25 +17,25 @@
  */
 class Session
 {
-    public static function start()
-    {
-        ini_set('session.cookie_httponly', 1);
+	public static function start()
+	{
+		ini_set('session.cookie_httponly', 1);
 
-        if (WebRequest::isHttps()) {
-            ini_set('session.cookie_secure', 1);
-        }
+		if (WebRequest::isHttps()) {
+			ini_set('session.cookie_secure', 1);
+		}
 
-        session_start();
-    }
+		session_start();
+	}
 
-    public static function destroy()
-    {
-        session_destroy();
-    }
+	public static function destroy()
+	{
+		session_destroy();
+	}
 
-    public static function restart()
-    {
-        self::destroy();
-        self::start();
-    }
+	public static function restart()
+	{
+		self::destroy();
+		self::start();
+	}
 }

includes/Helpers/DebugHelper.php

Indentation +41 added lines, -41 removed lines

@@ -13,53 +13,53 @@
  */
 class DebugHelper
 {
-    /**
-     * Internal mockable method wrapper for debug_backtrace.
-     *
-     * As mocking out debug_backtrace uses debug_backtrace internally, we need this in order to not cause a recursive
-     * cascade until the runtime explodes.
-     *
-     * Instead, we mock this method, which allows debug_backtrace to still be called correctly.
-     *
-     * @return array
-     */
-    public function get_debug_backtrace()
-    {
-        return debug_backtrace();
-    }
+	/**
+	 * Internal mockable method wrapper for debug_backtrace.
+	 *
+	 * As mocking out debug_backtrace uses debug_backtrace internally, we need this in order to not cause a recursive
+	 * cascade until the runtime explodes.
+	 *
+	 * Instead, we mock this method, which allows debug_backtrace to still be called correctly.
+	 *
+	 * @return array
+	 */
+	public function get_debug_backtrace()
+	{
+		return debug_backtrace();
+	}
 
-    /**
-     * Returns a string representation of the current backtrace for display.
-     *
-     * Note that this explicitly excludes the top two frames, which will be methods from this class.
-     *
-     * @return string
-     */
-    public function getBacktrace()
-    {
-        $backtrace = $this->get_debug_backtrace();
+	/**
+	 * Returns a string representation of the current backtrace for display.
+	 *
+	 * Note that this explicitly excludes the top two frames, which will be methods from this class.
+	 *
+	 * @return string
+	 */
+	public function getBacktrace()
+	{
+		$backtrace = $this->get_debug_backtrace();
 
-        $output = "";
+		$output = "";
 
-        $count = 0;
-        foreach ($backtrace as $line) {
-            if ($count <= 1) {
-                $count++;
-                continue;
-            }
+		$count = 0;
+		foreach ($backtrace as $line) {
+			if ($count <= 1) {
+				$count++;
+				continue;
+			}
 
-            $output .= "#{$count}: ";
+			$output .= "#{$count}: ";
 
-            if (isset($line['type']) && $line['type'] != "") {
-                $output .= $line['class'] . $line['type'];
-            }
+			if (isset($line['type']) && $line['type'] != "") {
+				$output .= $line['class'] . $line['type'];
+			}
 
-            $output .= $line['function'] . "(...)";
-            $output .= " [{$line['file']}#{$line['line']}\r\n";
+			$output .= $line['function'] . "(...)";
+			$output .= " [{$line['file']}#{$line['line']}\r\n";
 
-            $count++;
-        }
+			$count++;
+		}
 
-        return $output;
-    }
+		return $output;
+	}
 }

includes/Helpers/FakeBlacklistHelper.php

Indentation +12 added lines, -12 removed lines

@@ -12,16 +12,16 @@
 
 class FakeBlacklistHelper implements IBlacklistHelper
 {
-    /**
-     * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
-     *
-     * @param string $username
-     *
-     * @return bool
-     */
-    public function isBlacklisted($username)
-    {
-        // Short-circuit
-        return false;
-    }
+	/**
+	 * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
+	 *
+	 * @param string $username
+	 *
+	 * @return bool
+	 */
+	public function isBlacklisted($username)
+	{
+		// Short-circuit
+		return false;
+	}
 }
\ No newline at end of file

includes/Helpers/BanHelper.php

Indentation +41 added lines, -41 removed lines

@@ -14,49 +14,49 @@
 
 class BanHelper implements IBanHelper
 {
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
 
-    public function __construct(PdoDatabase $database)
-    {
-        $this->database = $database;
-    }
+	public function __construct(PdoDatabase $database)
+	{
+		$this->database = $database;
+	}
 
-    /**
-     * Summary of nameIsBanned
-     *
-     * @param string $name The name to test if is banned.
-     *
-     * @return Ban
-     */
-    public function nameIsBanned($name)
-    {
-        return Ban::getBanByTarget($name, "Name", $this->database);
-    }
+	/**
+	 * Summary of nameIsBanned
+	 *
+	 * @param string $name The name to test if is banned.
+	 *
+	 * @return Ban
+	 */
+	public function nameIsBanned($name)
+	{
+		return Ban::getBanByTarget($name, "Name", $this->database);
+	}
 
-    /**
-     * Summary of emailIsBanned
-     *
-     * @param string $email
-     *
-     * @return Ban
-     */
-    public function emailIsBanned($email)
-    {
-        return Ban::getBanByTarget($email, "EMail", $this->database);
-    }
+	/**
+	 * Summary of emailIsBanned
+	 *
+	 * @param string $email
+	 *
+	 * @return Ban
+	 */
+	public function emailIsBanned($email)
+	{
+		return Ban::getBanByTarget($email, "EMail", $this->database);
+	}
 
-    /**
-     * Summary of ipIsBanned
-     *
-     * @param string $ip
-     *
-     * @return Ban
-     */
-    public function ipIsBanned($ip)
-    {
-        return Ban::getBanByTarget($ip, "IP", $this->database);
-    }
+	/**
+	 * Summary of ipIsBanned
+	 *
+	 * @param string $ip
+	 *
+	 * @return Ban
+	 */
+	public function ipIsBanned($ip)
+	{
+		return Ban::getBanByTarget($ip, "IP", $this->database);
+	}
 }

includes/Helpers/LogHelper.php

Indentation +355 added lines, -355 removed lines

@@ -26,366 +26,366 @@
 
 class LogHelper
 {
-    /**
-     * Summary of getRequestLogsWithComments
-     *
-     * @param int             $requestId
-     * @param PdoDatabase     $db
-     * @param SecurityManager $securityManager
-     *
-     * @return \Waca\DataObject[]
-     */
-    public static function getRequestLogsWithComments($requestId, PdoDatabase $db, SecurityManager $securityManager)
-    {
-        $logs = LogSearchHelper::get($db)->byObjectType('Request')->byObjectId($requestId)->fetch();
-
-        $currentUser = User::getCurrent($db);
-        $securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);
-        $showAllComments = $securityResult === SecurityManager::ALLOWED;
-
-        $comments = Comment::getForRequest($requestId, $db, $showAllComments, $currentUser->getId());
-
-        $items = array_merge($logs, $comments);
-
-        /**
-         * @param DataObject $item
-         *
-         * @return int
-         */
-        $sortKey = function(DataObject $item) {
-            if ($item instanceof Log) {
-                return $item->getTimestamp()->getTimestamp();
-            }
-
-            if ($item instanceof Comment) {
-                return $item->getTime()->getTimestamp();
-            }
-
-            return 0;
-        };
-
-        do {
-            $flag = false;
-
-            $loopLimit = (count($items) - 1);
-            for ($i = 0; $i < $loopLimit; $i++) {
-                // are these two items out of order?
-                if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
-                    // swap them
-                    $swap = $items[$i];
-                    $items[$i] = $items[$i + 1];
-                    $items[$i + 1] = $swap;
-
-                    // set a flag to say we've modified the array this time around
-                    $flag = true;
-                }
-            }
-        }
-        while ($flag);
-
-        return $items;
-    }
-
-    /**
-     * Summary of getLogDescription
-     *
-     * @param Log $entry
-     *
-     * @return string
-     */
-    public static function getLogDescription(Log $entry)
-    {
-        $text = "Deferred to ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Deferred to a different queue
-            // This is exactly what we want to display.
-            return $entry->getAction();
-        }
-
-        $text = "Closed custom-n";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account not created)";
-        }
-
-        $text = "Closed custom-y";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account created)";
-        }
-
-        $text = "Closed 0";
-        if ($entry->getAction() == $text) {
-            // Dropped the request - short-circuit the lookup
-            return "dropped request";
-        }
-
-        $text = "Closed ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Closed with a reason - do a lookup here.
-            $id = substr($entry->getAction(), strlen($text));
-            /** @var EmailTemplate $template */
-            $template = EmailTemplate::getById((int)$id, $entry->getDatabase());
-
-            if ($template != false) {
-                return "closed (" . $template->getName() . ")";
-            }
-        }
-
-        // Fall back to the basic stuff
-        $lookup = array(
-            'Reserved'        => 'reserved',
-            'Email Confirmed' => 'email-confirmed',
-            'Unreserved'      => 'unreserved',
-            'Approved'        => 'approved',
-            'Suspended'       => 'suspended',
-            'RoleChange'      => 'changed roles',
-            'Banned'          => 'banned',
-            'Edited'          => 'edited interface message',
-            'Declined'        => 'declined',
-            'EditComment-c'   => 'edited a comment',
-            'EditComment-r'   => 'edited a comment',
-            'Unbanned'        => 'unbanned',
-            'Promoted'        => 'promoted to tool admin',
-            'BreakReserve'    => 'forcibly broke the reservation',
-            'Prefchange'      => 'changed user preferences',
-            'Renamed'         => 'renamed',
-            'Demoted'         => 'demoted from tool admin',
-            'ReceiveReserved' => 'received the reservation',
-            'SendReserved'    => 'sent the reservation',
-            'EditedEmail'     => 'edited email',
-            'DeletedTemplate' => 'deleted template',
-            'EditedTemplate'  => 'edited template',
-            'CreatedEmail'    => 'created email',
-            'CreatedTemplate' => 'created template',
-            'SentMail'        => 'sent an email to the requestor',
-            'Registered'      => 'registered a tool account',
-        );
-
-        if (array_key_exists($entry->getAction(), $lookup)) {
-            return $lookup[$entry->getAction()];
-        }
-
-        // OK, I don't know what this is. Fall back to something sane.
-        return "performed an unknown action ({$entry->getAction()})";
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return array
-     */
-    public static function getLogActions(PdoDatabase $database)
-    {
-        $lookup = array(
-            'Reserved'        => 'reserved',
-            'Email Confirmed' => 'email-confirmed',
-            'Unreserved'      => 'unreserved',
-            'Approved'        => 'approved',
-            'Suspended'       => 'suspended',
-            'RoleChange'      => 'changed roles',
-            'Banned'          => 'banned',
-            'Edited'          => 'edited interface message',
-            'Declined'        => 'declined',
-            'EditComment-c'   => 'edited a comment (by comment ID)',
-            'EditComment-r'   => 'edited a comment (by request)',
-            'Unbanned'        => 'unbanned',
-            'Promoted'        => 'promoted to tool admin',
-            'BreakReserve'    => 'forcibly broke the reservation',
-            'Prefchange'      => 'changed user preferences',
-            'Renamed'         => 'renamed',
-            'Demoted'         => 'demoted from tool admin',
-            'ReceiveReserved' => 'received the reservation',
-            'SendReserved'    => 'sent the reservation',
-            'EditedEmail'     => 'edited email',
-            'DeletedTemplate' => 'deleted template',
-            'EditedTemplate'  => 'edited template',
-            'CreatedEmail'    => 'created email',
-            'CreatedTemplate' => 'created template',
-            'SentMail'        => 'sent an email to the requestor',
-            'Registered'      => 'registered a tool account',
-            'Closed 0'        => 'dropped request',
-        );
-
-        $statement = $database->query(<<<SQL
+	/**
+	 * Summary of getRequestLogsWithComments
+	 *
+	 * @param int             $requestId
+	 * @param PdoDatabase     $db
+	 * @param SecurityManager $securityManager
+	 *
+	 * @return \Waca\DataObject[]
+	 */
+	public static function getRequestLogsWithComments($requestId, PdoDatabase $db, SecurityManager $securityManager)
+	{
+		$logs = LogSearchHelper::get($db)->byObjectType('Request')->byObjectId($requestId)->fetch();
+
+		$currentUser = User::getCurrent($db);
+		$securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);
+		$showAllComments = $securityResult === SecurityManager::ALLOWED;
+
+		$comments = Comment::getForRequest($requestId, $db, $showAllComments, $currentUser->getId());
+
+		$items = array_merge($logs, $comments);
+
+		/**
+		 * @param DataObject $item
+		 *
+		 * @return int
+		 */
+		$sortKey = function(DataObject $item) {
+			if ($item instanceof Log) {
+				return $item->getTimestamp()->getTimestamp();
+			}
+
+			if ($item instanceof Comment) {
+				return $item->getTime()->getTimestamp();
+			}
+
+			return 0;
+		};
+
+		do {
+			$flag = false;
+
+			$loopLimit = (count($items) - 1);
+			for ($i = 0; $i < $loopLimit; $i++) {
+				// are these two items out of order?
+				if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
+					// swap them
+					$swap = $items[$i];
+					$items[$i] = $items[$i + 1];
+					$items[$i + 1] = $swap;
+
+					// set a flag to say we've modified the array this time around
+					$flag = true;
+				}
+			}
+		}
+		while ($flag);
+
+		return $items;
+	}
+
+	/**
+	 * Summary of getLogDescription
+	 *
+	 * @param Log $entry
+	 *
+	 * @return string
+	 */
+	public static function getLogDescription(Log $entry)
+	{
+		$text = "Deferred to ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Deferred to a different queue
+			// This is exactly what we want to display.
+			return $entry->getAction();
+		}
+
+		$text = "Closed custom-n";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account not created)";
+		}
+
+		$text = "Closed custom-y";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account created)";
+		}
+
+		$text = "Closed 0";
+		if ($entry->getAction() == $text) {
+			// Dropped the request - short-circuit the lookup
+			return "dropped request";
+		}
+
+		$text = "Closed ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Closed with a reason - do a lookup here.
+			$id = substr($entry->getAction(), strlen($text));
+			/** @var EmailTemplate $template */
+			$template = EmailTemplate::getById((int)$id, $entry->getDatabase());
+
+			if ($template != false) {
+				return "closed (" . $template->getName() . ")";
+			}
+		}
+
+		// Fall back to the basic stuff
+		$lookup = array(
+			'Reserved'        => 'reserved',
+			'Email Confirmed' => 'email-confirmed',
+			'Unreserved'      => 'unreserved',
+			'Approved'        => 'approved',
+			'Suspended'       => 'suspended',
+			'RoleChange'      => 'changed roles',
+			'Banned'          => 'banned',
+			'Edited'          => 'edited interface message',
+			'Declined'        => 'declined',
+			'EditComment-c'   => 'edited a comment',
+			'EditComment-r'   => 'edited a comment',
+			'Unbanned'        => 'unbanned',
+			'Promoted'        => 'promoted to tool admin',
+			'BreakReserve'    => 'forcibly broke the reservation',
+			'Prefchange'      => 'changed user preferences',
+			'Renamed'         => 'renamed',
+			'Demoted'         => 'demoted from tool admin',
+			'ReceiveReserved' => 'received the reservation',
+			'SendReserved'    => 'sent the reservation',
+			'EditedEmail'     => 'edited email',
+			'DeletedTemplate' => 'deleted template',
+			'EditedTemplate'  => 'edited template',
+			'CreatedEmail'    => 'created email',
+			'CreatedTemplate' => 'created template',
+			'SentMail'        => 'sent an email to the requestor',
+			'Registered'      => 'registered a tool account',
+		);
+
+		if (array_key_exists($entry->getAction(), $lookup)) {
+			return $lookup[$entry->getAction()];
+		}
+
+		// OK, I don't know what this is. Fall back to something sane.
+		return "performed an unknown action ({$entry->getAction()})";
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return array
+	 */
+	public static function getLogActions(PdoDatabase $database)
+	{
+		$lookup = array(
+			'Reserved'        => 'reserved',
+			'Email Confirmed' => 'email-confirmed',
+			'Unreserved'      => 'unreserved',
+			'Approved'        => 'approved',
+			'Suspended'       => 'suspended',
+			'RoleChange'      => 'changed roles',
+			'Banned'          => 'banned',
+			'Edited'          => 'edited interface message',
+			'Declined'        => 'declined',
+			'EditComment-c'   => 'edited a comment (by comment ID)',
+			'EditComment-r'   => 'edited a comment (by request)',
+			'Unbanned'        => 'unbanned',
+			'Promoted'        => 'promoted to tool admin',
+			'BreakReserve'    => 'forcibly broke the reservation',
+			'Prefchange'      => 'changed user preferences',
+			'Renamed'         => 'renamed',
+			'Demoted'         => 'demoted from tool admin',
+			'ReceiveReserved' => 'received the reservation',
+			'SendReserved'    => 'sent the reservation',
+			'EditedEmail'     => 'edited email',
+			'DeletedTemplate' => 'deleted template',
+			'EditedTemplate'  => 'edited template',
+			'CreatedEmail'    => 'created email',
+			'CreatedTemplate' => 'created template',
+			'SentMail'        => 'sent an email to the requestor',
+			'Registered'      => 'registered a tool account',
+			'Closed 0'        => 'dropped request',
+		);
+
+		$statement = $database->query(<<<SQL
 SELECT CONCAT('Closed ', id) AS k, CONCAT('closed (',name,')') AS v
 FROM emailtemplate;
 SQL
-        );
-        foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $lookup[$row['k']] = $row['v'];
-        }
-
-        return $lookup;
-    }
-
-    public static function getObjectTypes()
-    {
-        return array(
-            'Ban'             => 'Ban',
-            'Comment'         => 'Comment',
-            'EmailTemplate'   => 'Email template',
-            'Request'         => 'Request',
-            'SiteNotice'      => 'Site notice',
-            'User'            => 'User',
-            'WelcomeTemplate' => 'Welcome template',
-        );
-    }
-
-    /**
-     * This returns a HTML
-     *
-     * @param string            $objectId
-     * @param string            $objectType
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return null|string
-     * @category Security-Critical
-     */
-    private static function getObjectDescription(
-        $objectId,
-        $objectType,
-        PdoDatabase $database,
-        SiteConfiguration $configuration
-    ) {
-        if ($objectType == '') {
-            return null;
-        }
-
-        $baseurl = $configuration->getBaseUrl();
-
-        switch ($objectType) {
-            case 'Ban':
-                /** @var Ban $ban */
-                $ban = Ban::getById($objectId, $database);
-
-                if ($ban === false) {
-                    return 'Ban #' . $objectId . "</a>";
-                }
-
-                return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
-            case 'EmailTemplate':
-                /** @var EmailTemplate $emailTemplate */
-                $emailTemplate = EmailTemplate::getById($objectId, $database);
-                $name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+		);
+		foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$lookup[$row['k']] = $row['v'];
+		}
+
+		return $lookup;
+	}
+
+	public static function getObjectTypes()
+	{
+		return array(
+			'Ban'             => 'Ban',
+			'Comment'         => 'Comment',
+			'EmailTemplate'   => 'Email template',
+			'Request'         => 'Request',
+			'SiteNotice'      => 'Site notice',
+			'User'            => 'User',
+			'WelcomeTemplate' => 'Welcome template',
+		);
+	}
+
+	/**
+	 * This returns a HTML
+	 *
+	 * @param string            $objectId
+	 * @param string            $objectType
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return null|string
+	 * @category Security-Critical
+	 */
+	private static function getObjectDescription(
+		$objectId,
+		$objectType,
+		PdoDatabase $database,
+		SiteConfiguration $configuration
+	) {
+		if ($objectType == '') {
+			return null;
+		}
+
+		$baseurl = $configuration->getBaseUrl();
+
+		switch ($objectType) {
+			case 'Ban':
+				/** @var Ban $ban */
+				$ban = Ban::getById($objectId, $database);
+
+				if ($ban === false) {
+					return 'Ban #' . $objectId . "</a>";
+				}
+
+				return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
+			case 'EmailTemplate':
+				/** @var EmailTemplate $emailTemplate */
+				$emailTemplate = EmailTemplate::getById($objectId, $database);
+				$name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/emailManagement/view?id={$objectId}">Email Template #{$objectId} ({$name})</a>
 HTML;
-            case 'SiteNotice':
-                return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
-            case 'Request':
-                /** @var Request $request */
-                $request = Request::getById($objectId, $database);
-                $name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+			case 'SiteNotice':
+				return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
+			case 'Request':
+				/** @var Request $request */
+				$request = Request::getById($objectId, $database);
+				$name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/viewRequest?id={$objectId}">Request #{$objectId} ({$name})</a>
 HTML;
-            case 'User':
-                /** @var User $user */
-                $user = User::getById($objectId, $database);
-                $username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
-            case 'WelcomeTemplate':
-                /** @var WelcomeTemplate $welcomeTemplate */
-                $welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
-
-                // some old templates have been completely deleted and lost to the depths of time.
-                if ($welcomeTemplate === false) {
-                    return "Welcome template #{$objectId}";
-                }
-                else {
-                    $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
-
-                    return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
-                }
-            default:
-                return '[' . $objectType . " " . $objectId . ']';
-        }
-    }
-
-    /**
-     * @param    Log[]          $logs
-     * @param     PdoDatabase   $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
-    {
-        $userIds = array();
-
-        /** @var Log $logEntry */
-        foreach ($logs as $logEntry) {
-            if (!$logEntry instanceof Log) {
-                // if this happens, we've done something wrong with passing back the log data.
-                throw new Exception('Log entry is not an instance of a Log, this should never happen.');
-            }
-
-            $user = $logEntry->getUser();
-            if ($user === -1) {
-                continue;
-            }
-
-            if (!array_search($user, $userIds)) {
-                $userIds[] = $user;
-            }
-        }
-
-        $users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
-        $users[-1] = User::getCommunity()->getUsername();
-
-        $logData = array();
-
-        /** @var Log $logEntry */
-        foreach ($logs as $logEntry) {
-            $objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
-                $database, $configuration);
-
-            switch ($logEntry->getAction()) {
-                case 'Renamed':
-                    $renameData = unserialize($logEntry->getComment());
-                    $oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
-                    $newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
-                    $comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
-                    break;
-                case 'RoleChange':
-                    $roleChangeData = unserialize($logEntry->getComment());
-
-                    $removed = array();
-                    foreach ($roleChangeData['removed'] as $r) {
-                        $removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $added = array();
-                    foreach ($roleChangeData['added'] as $r) {
-                        $added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
-
-                    $roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
-                    $comment = $roleDelta . ' with comment: ' . $reason;
-                    break;
-                default:
-                    $comment = $logEntry->getComment();
-                    break;
-            }
-
-            $logData[] = array(
-                'timestamp'         => $logEntry->getTimestamp(),
-                'userid'            => $logEntry->getUser(),
-                'username'          => $users[$logEntry->getUser()],
-                'description'       => self::getLogDescription($logEntry),
-                'objectdescription' => $objectDescription,
-                'comment'           => $comment,
-            );
-        }
-
-        return array($users, $logData);
-    }
+			case 'User':
+				/** @var User $user */
+				$user = User::getById($objectId, $database);
+				$username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
+			case 'WelcomeTemplate':
+				/** @var WelcomeTemplate $welcomeTemplate */
+				$welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
+
+				// some old templates have been completely deleted and lost to the depths of time.
+				if ($welcomeTemplate === false) {
+					return "Welcome template #{$objectId}";
+				}
+				else {
+					$userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
+
+					return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
+				}
+			default:
+				return '[' . $objectType . " " . $objectId . ']';
+		}
+	}
+
+	/**
+	 * @param    Log[]          $logs
+	 * @param     PdoDatabase   $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
+	{
+		$userIds = array();
+
+		/** @var Log $logEntry */
+		foreach ($logs as $logEntry) {
+			if (!$logEntry instanceof Log) {
+				// if this happens, we've done something wrong with passing back the log data.
+				throw new Exception('Log entry is not an instance of a Log, this should never happen.');
+			}
+
+			$user = $logEntry->getUser();
+			if ($user === -1) {
+				continue;
+			}
+
+			if (!array_search($user, $userIds)) {
+				$userIds[] = $user;
+			}
+		}
+
+		$users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
+		$users[-1] = User::getCommunity()->getUsername();
+
+		$logData = array();
+
+		/** @var Log $logEntry */
+		foreach ($logs as $logEntry) {
+			$objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
+				$database, $configuration);
+
+			switch ($logEntry->getAction()) {
+				case 'Renamed':
+					$renameData = unserialize($logEntry->getComment());
+					$oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
+					$newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
+					$comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
+					break;
+				case 'RoleChange':
+					$roleChangeData = unserialize($logEntry->getComment());
+
+					$removed = array();
+					foreach ($roleChangeData['removed'] as $r) {
+						$removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$added = array();
+					foreach ($roleChangeData['added'] as $r) {
+						$added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
+
+					$roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
+					$comment = $roleDelta . ' with comment: ' . $reason;
+					break;
+				default:
+					$comment = $logEntry->getComment();
+					break;
+			}
+
+			$logData[] = array(
+				'timestamp'         => $logEntry->getTimestamp(),
+				'userid'            => $logEntry->getUser(),
+				'username'          => $users[$logEntry->getUser()],
+				'description'       => self::getLogDescription($logEntry),
+				'objectdescription' => $objectDescription,
+				'comment'           => $comment,
+			);
+		}
+
+		return array($users, $logData);
+	}
 }

Braces +3 added lines, -3 removed lines

@@ -52,7 +52,8 @@ 
          *
          * @return int
          */
-        $sortKey = function(DataObject $item) {
+        $sortKey = function(DataObject $item)
+        {
             if ($item instanceof Log) {
                 return $item->getTimestamp()->getTimestamp();
             }
@@ -296,8 +297,7 @@ 
                 // some old templates have been completely deleted and lost to the depths of time.
                 if ($welcomeTemplate === false) {
                     return "Welcome template #{$objectId}";
-                }
-                else {
+                } else {
                     $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
 
                     return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";

includes/Helpers/BlacklistHelper.php

Indentation +75 added lines, -75 removed lines

@@ -13,91 +13,91 @@
 
 class BlacklistHelper implements IBlacklistHelper
 {
-    /** @var HttpHelper */
-    private $httpHelper;
-    /**
-     * Cache of previously requested usernames
-     * @var array
-     */
-    private $cache = array();
-    /** @var string */
-    private $mediawikiWebServiceEndpoint;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/**
+	 * Cache of previously requested usernames
+	 * @var array
+	 */
+	private $cache = array();
+	/** @var string */
+	private $mediawikiWebServiceEndpoint;
 
-    /**
-     * BlacklistHelper constructor.
-     *
-     * @param HttpHelper $httpHelper
-     * @param string     $mediawikiWebServiceEndpoint
-     */
-    public function __construct(HttpHelper $httpHelper, $mediawikiWebServiceEndpoint)
-    {
-        $this->httpHelper = $httpHelper;
-        $this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
-    }
+	/**
+	 * BlacklistHelper constructor.
+	 *
+	 * @param HttpHelper $httpHelper
+	 * @param string     $mediawikiWebServiceEndpoint
+	 */
+	public function __construct(HttpHelper $httpHelper, $mediawikiWebServiceEndpoint)
+	{
+		$this->httpHelper = $httpHelper;
+		$this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
+	}
 
-    /**
-     * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
-     *
-     * @param string $username
-     *
-     * @return false|string False if the username is not blacklisted, else the blacklist entry.
-     */
-    public function isBlacklisted($username)
-    {
-        if (isset($this->cache[$username])) {
-            $result = $this->cache[$username];
-            if ($result === false) {
-                return false;
-            }
+	/**
+	 * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
+	 *
+	 * @param string $username
+	 *
+	 * @return false|string False if the username is not blacklisted, else the blacklist entry.
+	 */
+	public function isBlacklisted($username)
+	{
+		if (isset($this->cache[$username])) {
+			$result = $this->cache[$username];
+			if ($result === false) {
+				return false;
+			}
 
-            return $result['line'];
-        }
+			return $result['line'];
+		}
 
-        try {
-            $result = $this->performWikiLookup($username);
-        }
-        catch (CurlException $ex) {
-            // LOGME log this, but fail gracefully.
-            return false;
-        }
+		try {
+			$result = $this->performWikiLookup($username);
+		}
+		catch (CurlException $ex) {
+			// LOGME log this, but fail gracefully.
+			return false;
+		}
 
-        if ($result['result'] === 'ok') {
-            // not blacklisted
-            $this->cache[$username] = false;
+		if ($result['result'] === 'ok') {
+			// not blacklisted
+			$this->cache[$username] = false;
 
-            return false;
-        }
-        else {
-            $this->cache[$username] = $result;
+			return false;
+		}
+		else {
+			$this->cache[$username] = $result;
 
-            return $result['line'];
-        }
-    }
+			return $result['line'];
+		}
+	}
 
-    /**
-     * Performs a fetch to MediaWiki for the relevant title blacklist entry
-     *
-     * @param string $username The username to look up
-     *
-     * @return array
-     * @throws CurlException
-     */
-    private function performWikiLookup($username)
-    {
-        $endpoint = $this->mediawikiWebServiceEndpoint;
+	/**
+	 * Performs a fetch to MediaWiki for the relevant title blacklist entry
+	 *
+	 * @param string $username The username to look up
+	 *
+	 * @return array
+	 * @throws CurlException
+	 */
+	private function performWikiLookup($username)
+	{
+		$endpoint = $this->mediawikiWebServiceEndpoint;
 
-        $parameters = array(
-            'action'       => 'titleblacklist',
-            'format'       => 'php',
-            'tbtitle'      => $username,
-            'tbaction'     => 'new-account',
-            'tbnooverride' => true,
-        );
+		$parameters = array(
+			'action'       => 'titleblacklist',
+			'format'       => 'php',
+			'tbtitle'      => $username,
+			'tbaction'     => 'new-account',
+			'tbnooverride' => true,
+		);
 
-        $apiResult = $this->httpHelper->get($endpoint, $parameters);
+		$apiResult = $this->httpHelper->get($endpoint, $parameters);
 
-        $data = unserialize($apiResult);
+		$data = unserialize($apiResult);
 
-        return $data['titleblacklist'];
-    }
+		return $data['titleblacklist'];
+	}
 }
\ No newline at end of file

Braces +1 added lines, -2 removed lines

@@ -66,8 +66,7 @@
             $this->cache[$username] = false;
 
             return false;
-        }
-        else {
+        } else {
             $this->cache[$username] = $result;
 
             return $result['line'];