enwikipedia-acc / waca

includes/Tasks/PageBase.php

Indentation +349 added lines, -349 removed lines

@@ -21,353 +21,353 @@
 
 abstract class PageBase extends TaskBase implements IRoutedTask
 {
-    use TemplateOutput;
-    /** @var string Smarty template to display */
-    protected $template = "base.tpl";
-    /** @var string HTML title. Currently unused. */
-    protected $htmlTitle;
-    /** @var bool Determines if the page is a redirect or not */
-    protected $isRedirecting = false;
-    /** @var array Queue of headers to be sent on successful completion */
-    protected $headerQueue = array();
-    /** @var string The name of the route to use, as determined by the request router. */
-    private $routeName = null;
-    /** @var TokenManager */
-    protected $tokenManager;
-    /** @var string[] Extra CSS files to include */
-    private $extraCss = array();
-    /** @var string[] Extra JS files to include */
-    private $extraJs = array();
-
-    /**
-     * Sets the route the request will take. Only should be called from the request router or barrier test.
-     *
-     * @param string $routeName        The name of the route
-     * @param bool   $skipCallableTest Don't use this unless you know what you're doing, and what the implications are.
-     *
-     * @throws Exception
-     * @category Security-Critical
-     */
-    final public function setRoute($routeName, $skipCallableTest = false)
-    {
-        // Test the new route is callable before adopting it.
-        if (!$skipCallableTest && !is_callable(array($this, $routeName))) {
-            throw new Exception("Proposed route '$routeName' is not callable.");
-        }
-
-        // Adopt the new route
-        $this->routeName = $routeName;
-    }
-
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    final public function getRouteName()
-    {
-        return $this->routeName;
-    }
-
-    /**
-     * Performs generic page setup actions
-     */
-    final protected function setupPage()
-    {
-        $this->setUpSmarty();
-
-        $siteNoticeText = SiteNotice::get($this->getDatabase());
-
-        $this->assign('siteNoticeText', $siteNoticeText);
-
-        $currentUser = User::getCurrent($this->getDatabase());
-        $this->assign('currentUser', $currentUser);
-        $this->assign('loggedIn', (!$currentUser->isCommunityUser()));
-    }
-
-    /**
-     * Runs the page logic as routed by the RequestRouter
-     *
-     * Only should be called after a security barrier! That means only from execute().
-     */
-    final protected function runPage()
-    {
-        $database = $this->getDatabase();
-
-        // initialise a database transaction
-        if (!$database->beginTransaction()) {
-            throw new Exception('Failed to start transaction on primary database.');
-        }
-
-        try {
-            // run the page code
-            $this->{$this->getRouteName()}();
-
-            $database->commit();
-        }
-        catch (ApplicationLogicException $ex) {
-            // it's an application logic exception, so nothing went seriously wrong with the site. We can use the
-            // standard templating system for this.
-
-            // Firstly, let's undo anything that happened to the database.
-            $database->rollBack();
-
-            // Reset smarty
-            $this->setUpSmarty();
-
-            // Set the template
-            $this->setTemplate('exception/application-logic.tpl');
-            $this->assign('message', $ex->getMessage());
-
-            // Force this back to false
-            $this->isRedirecting = false;
-            $this->headerQueue = array();
-        }
-        catch (OptimisticLockFailedException $ex) {
-            // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the
-            // standard templating system for this.
-
-            // Firstly, let's undo anything that happened to the database.
-            $database->rollBack();
-
-            // Reset smarty
-            $this->setUpSmarty();
-
-            // Set the template
-            $this->setTemplate('exception/optimistic-lock-failure.tpl');
-            $this->assign('message', $ex->getMessage());
-
-            $this->assign('debugTrace', false);
-
-            if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) {
-                ob_start();
-                var_dump(ExceptionHandler::getExceptionData($ex));
-                $textErrorData = ob_get_contents();
-                ob_end_clean();
-
-                $this->assign('exceptionData', $textErrorData);
-                $this->assign('debugTrace', true);
-            }
-
-            // Force this back to false
-            $this->isRedirecting = false;
-            $this->headerQueue = array();
-        }
-        finally {
-            // Catch any hanging on transactions
-            if ($database->hasActiveTransaction()) {
-                $database->rollBack();
-            }
-        }
-
-        // run any finalisation code needed before we send the output to the browser.
-        $this->finalisePage();
-
-        // Send the headers
-        $this->sendResponseHeaders();
-
-        // Check we have a template to use!
-        if ($this->template !== null) {
-            $content = $this->fetchTemplate($this->template);
-            ob_clean();
-            print($content);
-            ob_flush();
-
-            return;
-        }
-    }
-
-    /**
-     * Performs final tasks needed before rendering the page.
-     */
-    protected function finalisePage()
-    {
-        if ($this->isRedirecting) {
-            $this->template = null;
-
-            return;
-        }
-
-        $this->assign('extraCss', $this->extraCss);
-        $this->assign('extraJs', $this->extraJs);
-
-        // If we're actually displaying content, we want to add the session alerts here!
-        $this->assign('alerts', SessionAlert::getAlerts());
-        SessionAlert::clearAlerts();
-
-        $this->assign('htmlTitle', $this->htmlTitle);
-    }
-
-    /**
-     * @return TokenManager
-     */
-    public function getTokenManager()
-    {
-        return $this->tokenManager;
-    }
-
-    /**
-     * @param TokenManager $tokenManager
-     */
-    public function setTokenManager($tokenManager)
-    {
-        $this->tokenManager = $tokenManager;
-    }
-
-    /**
-     * Sends the redirect headers to perform a GET at the destination page.
-     *
-     * Also nullifies the set template so Smarty does not render it.
-     *
-     * @param string      $page   The page to redirect requests to (as used in the UR)
-     * @param null|string $action The action to use on the page.
-     * @param null|array  $parameters
-     * @param null|string $script The script (relative to index.php) to redirect to
-     */
-    final protected function redirect($page = '', $action = null, $parameters = null, $script = null)
-    {
-        $currentScriptName = WebRequest::scriptName();
-
-        // Are we changing script?
-        if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
-            $targetScriptName = $currentScriptName;
-        }
-        else {
-            $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
-        }
-
-        $pathInfo = array($targetScriptName);
-
-        $pathInfo[1] = $page;
-
-        if ($action !== null) {
-            $pathInfo[2] = $action;
-        }
-
-        $url = implode('/', $pathInfo);
-
-        if (is_array($parameters) && count($parameters) > 0) {
-            $url .= '?' . http_build_query($parameters);
-        }
-
-        $this->redirectUrl($url);
-    }
-
-    /**
-     * Sends the redirect headers to perform a GET at the new address.
-     *
-     * Also nullifies the set template so Smarty does not render it.
-     *
-     * @param string $path URL to redirect to
-     */
-    final protected function redirectUrl($path)
-    {
-        // 303 See Other = re-request at new address with a GET.
-        $this->headerQueue[] = 'HTTP/1.1 303 See Other';
-        $this->headerQueue[] = "Location: $path";
-
-        $this->setTemplate(null);
-        $this->isRedirecting = true;
-    }
-
-    /**
-     * Sets the name of the template this page should display.
-     *
-     * @param string $name
-     *
-     * @throws Exception
-     */
-    final protected function setTemplate($name)
-    {
-        if ($this->isRedirecting) {
-            throw new Exception('This page has been set as a redirect, no template can be displayed!');
-        }
-
-        $this->template = $name;
-    }
-
-    /**
-     * Adds an extra CSS file to to the page
-     *
-     * @param string $path The path (relative to the application root) of the file
-     */
-    final protected function addCss($path) {
-        if(in_array($path, $this->extraCss)){
-            // nothing to do
-            return;
-        }
-
-        $this->extraCss[] = $path;
-    }
-
-    /**
-     * Adds an extra JS file to to the page
-     *
-     * @param string $path The path (relative to the application root) of the file
-     */
-    final protected function addJs($path){
-        if(in_array($path, $this->extraJs)){
-            // nothing to do
-            return;
-        }
-
-        $this->extraJs[] = $path;
-    }
-
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    abstract protected function main();
-
-    /**
-     * @param string $title
-     */
-    final protected function setHtmlTitle($title)
-    {
-        $this->htmlTitle = $title;
-    }
-
-    public function execute()
-    {
-        if ($this->getRouteName() === null) {
-            throw new Exception('Request is unrouted.');
-        }
-
-        if ($this->getSiteConfiguration() === null) {
-            throw new Exception('Page has no configuration!');
-        }
-
-        $this->setupPage();
-
-        $this->runPage();
-    }
-
-    public function assignCSRFToken()
-    {
-        $token = $this->tokenManager->getNewToken();
-        $this->assign('csrfTokenData', $token->getTokenData());
-    }
-
-    public function validateCSRFToken()
-    {
-        if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) {
-            throw new ApplicationLogicException('Form token is not valid, please reload and try again');
-        }
-    }
-
-    protected function sendResponseHeaders()
-    {
-        if (headers_sent()) {
-            throw new ApplicationLogicException          ('Headers have already been sent! This is likely a bug in the application.');
-        }
-
-        foreach ($this->headerQueue as $item) {
-            if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) {
-                // Oops. We're not allowed to do this.
-                throw new Exception('Unable to split header');
-            }
-
-            header($item);
-        }
-    }
+	use TemplateOutput;
+	/** @var string Smarty template to display */
+	protected $template = "base.tpl";
+	/** @var string HTML title. Currently unused. */
+	protected $htmlTitle;
+	/** @var bool Determines if the page is a redirect or not */
+	protected $isRedirecting = false;
+	/** @var array Queue of headers to be sent on successful completion */
+	protected $headerQueue = array();
+	/** @var string The name of the route to use, as determined by the request router. */
+	private $routeName = null;
+	/** @var TokenManager */
+	protected $tokenManager;
+	/** @var string[] Extra CSS files to include */
+	private $extraCss = array();
+	/** @var string[] Extra JS files to include */
+	private $extraJs = array();
+
+	/**
+	 * Sets the route the request will take. Only should be called from the request router or barrier test.
+	 *
+	 * @param string $routeName        The name of the route
+	 * @param bool   $skipCallableTest Don't use this unless you know what you're doing, and what the implications are.
+	 *
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	final public function setRoute($routeName, $skipCallableTest = false)
+	{
+		// Test the new route is callable before adopting it.
+		if (!$skipCallableTest && !is_callable(array($this, $routeName))) {
+			throw new Exception("Proposed route '$routeName' is not callable.");
+		}
+
+		// Adopt the new route
+		$this->routeName = $routeName;
+	}
+
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	final public function getRouteName()
+	{
+		return $this->routeName;
+	}
+
+	/**
+	 * Performs generic page setup actions
+	 */
+	final protected function setupPage()
+	{
+		$this->setUpSmarty();
+
+		$siteNoticeText = SiteNotice::get($this->getDatabase());
+
+		$this->assign('siteNoticeText', $siteNoticeText);
+
+		$currentUser = User::getCurrent($this->getDatabase());
+		$this->assign('currentUser', $currentUser);
+		$this->assign('loggedIn', (!$currentUser->isCommunityUser()));
+	}
+
+	/**
+	 * Runs the page logic as routed by the RequestRouter
+	 *
+	 * Only should be called after a security barrier! That means only from execute().
+	 */
+	final protected function runPage()
+	{
+		$database = $this->getDatabase();
+
+		// initialise a database transaction
+		if (!$database->beginTransaction()) {
+			throw new Exception('Failed to start transaction on primary database.');
+		}
+
+		try {
+			// run the page code
+			$this->{$this->getRouteName()}();
+
+			$database->commit();
+		}
+		catch (ApplicationLogicException $ex) {
+			// it's an application logic exception, so nothing went seriously wrong with the site. We can use the
+			// standard templating system for this.
+
+			// Firstly, let's undo anything that happened to the database.
+			$database->rollBack();
+
+			// Reset smarty
+			$this->setUpSmarty();
+
+			// Set the template
+			$this->setTemplate('exception/application-logic.tpl');
+			$this->assign('message', $ex->getMessage());
+
+			// Force this back to false
+			$this->isRedirecting = false;
+			$this->headerQueue = array();
+		}
+		catch (OptimisticLockFailedException $ex) {
+			// it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the
+			// standard templating system for this.
+
+			// Firstly, let's undo anything that happened to the database.
+			$database->rollBack();
+
+			// Reset smarty
+			$this->setUpSmarty();
+
+			// Set the template
+			$this->setTemplate('exception/optimistic-lock-failure.tpl');
+			$this->assign('message', $ex->getMessage());
+
+			$this->assign('debugTrace', false);
+
+			if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) {
+				ob_start();
+				var_dump(ExceptionHandler::getExceptionData($ex));
+				$textErrorData = ob_get_contents();
+				ob_end_clean();
+
+				$this->assign('exceptionData', $textErrorData);
+				$this->assign('debugTrace', true);
+			}
+
+			// Force this back to false
+			$this->isRedirecting = false;
+			$this->headerQueue = array();
+		}
+		finally {
+			// Catch any hanging on transactions
+			if ($database->hasActiveTransaction()) {
+				$database->rollBack();
+			}
+		}
+
+		// run any finalisation code needed before we send the output to the browser.
+		$this->finalisePage();
+
+		// Send the headers
+		$this->sendResponseHeaders();
+
+		// Check we have a template to use!
+		if ($this->template !== null) {
+			$content = $this->fetchTemplate($this->template);
+			ob_clean();
+			print($content);
+			ob_flush();
+
+			return;
+		}
+	}
+
+	/**
+	 * Performs final tasks needed before rendering the page.
+	 */
+	protected function finalisePage()
+	{
+		if ($this->isRedirecting) {
+			$this->template = null;
+
+			return;
+		}
+
+		$this->assign('extraCss', $this->extraCss);
+		$this->assign('extraJs', $this->extraJs);
+
+		// If we're actually displaying content, we want to add the session alerts here!
+		$this->assign('alerts', SessionAlert::getAlerts());
+		SessionAlert::clearAlerts();
+
+		$this->assign('htmlTitle', $this->htmlTitle);
+	}
+
+	/**
+	 * @return TokenManager
+	 */
+	public function getTokenManager()
+	{
+		return $this->tokenManager;
+	}
+
+	/**
+	 * @param TokenManager $tokenManager
+	 */
+	public function setTokenManager($tokenManager)
+	{
+		$this->tokenManager = $tokenManager;
+	}
+
+	/**
+	 * Sends the redirect headers to perform a GET at the destination page.
+	 *
+	 * Also nullifies the set template so Smarty does not render it.
+	 *
+	 * @param string      $page   The page to redirect requests to (as used in the UR)
+	 * @param null|string $action The action to use on the page.
+	 * @param null|array  $parameters
+	 * @param null|string $script The script (relative to index.php) to redirect to
+	 */
+	final protected function redirect($page = '', $action = null, $parameters = null, $script = null)
+	{
+		$currentScriptName = WebRequest::scriptName();
+
+		// Are we changing script?
+		if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
+			$targetScriptName = $currentScriptName;
+		}
+		else {
+			$targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
+		}
+
+		$pathInfo = array($targetScriptName);
+
+		$pathInfo[1] = $page;
+
+		if ($action !== null) {
+			$pathInfo[2] = $action;
+		}
+
+		$url = implode('/', $pathInfo);
+
+		if (is_array($parameters) && count($parameters) > 0) {
+			$url .= '?' . http_build_query($parameters);
+		}
+
+		$this->redirectUrl($url);
+	}
+
+	/**
+	 * Sends the redirect headers to perform a GET at the new address.
+	 *
+	 * Also nullifies the set template so Smarty does not render it.
+	 *
+	 * @param string $path URL to redirect to
+	 */
+	final protected function redirectUrl($path)
+	{
+		// 303 See Other = re-request at new address with a GET.
+		$this->headerQueue[] = 'HTTP/1.1 303 See Other';
+		$this->headerQueue[] = "Location: $path";
+
+		$this->setTemplate(null);
+		$this->isRedirecting = true;
+	}
+
+	/**
+	 * Sets the name of the template this page should display.
+	 *
+	 * @param string $name
+	 *
+	 * @throws Exception
+	 */
+	final protected function setTemplate($name)
+	{
+		if ($this->isRedirecting) {
+			throw new Exception('This page has been set as a redirect, no template can be displayed!');
+		}
+
+		$this->template = $name;
+	}
+
+	/**
+	 * Adds an extra CSS file to to the page
+	 *
+	 * @param string $path The path (relative to the application root) of the file
+	 */
+	final protected function addCss($path) {
+		if(in_array($path, $this->extraCss)){
+			// nothing to do
+			return;
+		}
+
+		$this->extraCss[] = $path;
+	}
+
+	/**
+	 * Adds an extra JS file to to the page
+	 *
+	 * @param string $path The path (relative to the application root) of the file
+	 */
+	final protected function addJs($path){
+		if(in_array($path, $this->extraJs)){
+			// nothing to do
+			return;
+		}
+
+		$this->extraJs[] = $path;
+	}
+
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	abstract protected function main();
+
+	/**
+	 * @param string $title
+	 */
+	final protected function setHtmlTitle($title)
+	{
+		$this->htmlTitle = $title;
+	}
+
+	public function execute()
+	{
+		if ($this->getRouteName() === null) {
+			throw new Exception('Request is unrouted.');
+		}
+
+		if ($this->getSiteConfiguration() === null) {
+			throw new Exception('Page has no configuration!');
+		}
+
+		$this->setupPage();
+
+		$this->runPage();
+	}
+
+	public function assignCSRFToken()
+	{
+		$token = $this->tokenManager->getNewToken();
+		$this->assign('csrfTokenData', $token->getTokenData());
+	}
+
+	public function validateCSRFToken()
+	{
+		if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) {
+			throw new ApplicationLogicException('Form token is not valid, please reload and try again');
+		}
+	}
+
+	protected function sendResponseHeaders()
+	{
+		if (headers_sent()) {
+			throw new ApplicationLogicException          ('Headers have already been sent! This is likely a bug in the application.');
+		}
+
+		foreach ($this->headerQueue as $item) {
+			if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) {
+				// Oops. We're not allowed to do this.
+				throw new Exception('Unable to split header');
+			}
+
+			header($item);
+		}
+	}
 }

includes/Tasks/TaskBase.php

Indentation +225 added lines, -225 removed lines

@@ -23,229 +23,229 @@
 
 abstract class TaskBase implements ITask
 {
-    /** @var SiteConfiguration */
-    private $siteConfiguration;
-    /** @var IEmailHelper */
-    private $emailHelper;
-    /** @var HttpHelper */
-    private $httpHelper;
-    /** @var WikiTextHelper */
-    private $wikiTextHelper;
-    /** @var ILocationProvider */
-    private $locationProvider;
-    /** @var IXffTrustProvider */
-    private $xffTrustProvider;
-    /** @var IRDnsProvider */
-    private $rdnsProvider;
-    /** @var IAntiSpoofProvider */
-    private $antiSpoofProvider;
-    /** @var IOAuthProtocolHelper */
-    private $oauthHelper;
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IrcNotificationHelper */
-    private $notificationHelper;
-    /** @var TorExitProvider */
-    private $torExitProvider;
-
-    /**
-     * @return IEmailHelper
-     */
-    final public function getEmailHelper()
-    {
-        return $this->emailHelper;
-    }
-
-    /**
-     * @param IEmailHelper $emailHelper
-     */
-    final public function setEmailHelper($emailHelper)
-    {
-        $this->emailHelper = $emailHelper;
-    }
-
-    /**
-     * @return HttpHelper
-     */
-    final public function getHttpHelper()
-    {
-        return $this->httpHelper;
-    }
-
-    /**
-     * @param HttpHelper $httpHelper
-     */
-    final public function setHttpHelper($httpHelper)
-    {
-        $this->httpHelper = $httpHelper;
-    }
-
-    /**
-     * @return WikiTextHelper
-     */
-    final public function getWikiTextHelper()
-    {
-        return $this->wikiTextHelper;
-    }
-
-    /**
-     * @param WikiTextHelper $wikiTextHelper
-     */
-    final public function setWikiTextHelper($wikiTextHelper)
-    {
-        $this->wikiTextHelper = $wikiTextHelper;
-    }
-
-    /**
-     * @return ILocationProvider
-     */
-    final public function getLocationProvider()
-    {
-        return $this->locationProvider;
-    }
-
-    /**
-     * @param ILocationProvider $locationProvider
-     */
-    final public function setLocationProvider(ILocationProvider $locationProvider)
-    {
-        $this->locationProvider = $locationProvider;
-    }
-
-    /**
-     * @return IXffTrustProvider
-     */
-    final public function getXffTrustProvider()
-    {
-        return $this->xffTrustProvider;
-    }
-
-    /**
-     * @param IXffTrustProvider $xffTrustProvider
-     */
-    final public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider)
-    {
-        $this->xffTrustProvider = $xffTrustProvider;
-    }
-
-    /**
-     * @return IRDnsProvider
-     */
-    final public function getRdnsProvider()
-    {
-        return $this->rdnsProvider;
-    }
-
-    /**
-     * @param IRDnsProvider $rdnsProvider
-     */
-    public function setRdnsProvider($rdnsProvider)
-    {
-        $this->rdnsProvider = $rdnsProvider;
-    }
-
-    /**
-     * @return IAntiSpoofProvider
-     */
-    public function getAntiSpoofProvider()
-    {
-        return $this->antiSpoofProvider;
-    }
-
-    /**
-     * @param IAntiSpoofProvider $antiSpoofProvider
-     */
-    public function setAntiSpoofProvider($antiSpoofProvider)
-    {
-        $this->antiSpoofProvider = $antiSpoofProvider;
-    }
-
-    /**
-     * @return PdoDatabase
-     */
-    final public function getDatabase()
-    {
-        return $this->database;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     */
-    final public function setDatabase($database)
-    {
-        $this->database = $database;
-    }
-
-    /**
-     * @return IOAuthProtocolHelper
-     */
-    public function getOAuthProtocolHelper()
-    {
-        return $this->oauthHelper;
-    }
-
-    /**
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     */
-    public function setOAuthProtocolHelper($oauthProtocolHelper)
-    {
-        $this->oauthHelper = $oauthProtocolHelper;
-    }
-
-    /**
-     * @return void
-     */
-    abstract public function execute();
-
-    /**
-     * @return IrcNotificationHelper
-     */
-    public function getNotificationHelper()
-    {
-        return $this->notificationHelper;
-    }
-
-    /**
-     * @param IrcNotificationHelper $notificationHelper
-     */
-    public function setNotificationHelper($notificationHelper)
-    {
-        $this->notificationHelper = $notificationHelper;
-    }
-
-    /**
-     * @return TorExitProvider
-     */
-    public function getTorExitProvider()
-    {
-        return $this->torExitProvider;
-    }
-
-    /**
-     * @param TorExitProvider $torExitProvider
-     */
-    public function setTorExitProvider($torExitProvider)
-    {
-        $this->torExitProvider = $torExitProvider;
-    }
-
-    /**
-     * Gets the site configuration object
-     *
-     * @return SiteConfiguration
-     */
-    final protected function getSiteConfiguration()
-    {
-        return $this->siteConfiguration;
-    }
-
-    /**
-     * Sets the site configuration object for this page
-     *
-     * @param SiteConfiguration $configuration
-     */
-    final public function setSiteConfiguration($configuration)
-    {
-        $this->siteConfiguration = $configuration;
-    }
+	/** @var SiteConfiguration */
+	private $siteConfiguration;
+	/** @var IEmailHelper */
+	private $emailHelper;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/** @var WikiTextHelper */
+	private $wikiTextHelper;
+	/** @var ILocationProvider */
+	private $locationProvider;
+	/** @var IXffTrustProvider */
+	private $xffTrustProvider;
+	/** @var IRDnsProvider */
+	private $rdnsProvider;
+	/** @var IAntiSpoofProvider */
+	private $antiSpoofProvider;
+	/** @var IOAuthProtocolHelper */
+	private $oauthHelper;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IrcNotificationHelper */
+	private $notificationHelper;
+	/** @var TorExitProvider */
+	private $torExitProvider;
+
+	/**
+	 * @return IEmailHelper
+	 */
+	final public function getEmailHelper()
+	{
+		return $this->emailHelper;
+	}
+
+	/**
+	 * @param IEmailHelper $emailHelper
+	 */
+	final public function setEmailHelper($emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
+
+	/**
+	 * @return HttpHelper
+	 */
+	final public function getHttpHelper()
+	{
+		return $this->httpHelper;
+	}
+
+	/**
+	 * @param HttpHelper $httpHelper
+	 */
+	final public function setHttpHelper($httpHelper)
+	{
+		$this->httpHelper = $httpHelper;
+	}
+
+	/**
+	 * @return WikiTextHelper
+	 */
+	final public function getWikiTextHelper()
+	{
+		return $this->wikiTextHelper;
+	}
+
+	/**
+	 * @param WikiTextHelper $wikiTextHelper
+	 */
+	final public function setWikiTextHelper($wikiTextHelper)
+	{
+		$this->wikiTextHelper = $wikiTextHelper;
+	}
+
+	/**
+	 * @return ILocationProvider
+	 */
+	final public function getLocationProvider()
+	{
+		return $this->locationProvider;
+	}
+
+	/**
+	 * @param ILocationProvider $locationProvider
+	 */
+	final public function setLocationProvider(ILocationProvider $locationProvider)
+	{
+		$this->locationProvider = $locationProvider;
+	}
+
+	/**
+	 * @return IXffTrustProvider
+	 */
+	final public function getXffTrustProvider()
+	{
+		return $this->xffTrustProvider;
+	}
+
+	/**
+	 * @param IXffTrustProvider $xffTrustProvider
+	 */
+	final public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider)
+	{
+		$this->xffTrustProvider = $xffTrustProvider;
+	}
+
+	/**
+	 * @return IRDnsProvider
+	 */
+	final public function getRdnsProvider()
+	{
+		return $this->rdnsProvider;
+	}
+
+	/**
+	 * @param IRDnsProvider $rdnsProvider
+	 */
+	public function setRdnsProvider($rdnsProvider)
+	{
+		$this->rdnsProvider = $rdnsProvider;
+	}
+
+	/**
+	 * @return IAntiSpoofProvider
+	 */
+	public function getAntiSpoofProvider()
+	{
+		return $this->antiSpoofProvider;
+	}
+
+	/**
+	 * @param IAntiSpoofProvider $antiSpoofProvider
+	 */
+	public function setAntiSpoofProvider($antiSpoofProvider)
+	{
+		$this->antiSpoofProvider = $antiSpoofProvider;
+	}
+
+	/**
+	 * @return PdoDatabase
+	 */
+	final public function getDatabase()
+	{
+		return $this->database;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	final public function setDatabase($database)
+	{
+		$this->database = $database;
+	}
+
+	/**
+	 * @return IOAuthProtocolHelper
+	 */
+	public function getOAuthProtocolHelper()
+	{
+		return $this->oauthHelper;
+	}
+
+	/**
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 */
+	public function setOAuthProtocolHelper($oauthProtocolHelper)
+	{
+		$this->oauthHelper = $oauthProtocolHelper;
+	}
+
+	/**
+	 * @return void
+	 */
+	abstract public function execute();
+
+	/**
+	 * @return IrcNotificationHelper
+	 */
+	public function getNotificationHelper()
+	{
+		return $this->notificationHelper;
+	}
+
+	/**
+	 * @param IrcNotificationHelper $notificationHelper
+	 */
+	public function setNotificationHelper($notificationHelper)
+	{
+		$this->notificationHelper = $notificationHelper;
+	}
+
+	/**
+	 * @return TorExitProvider
+	 */
+	public function getTorExitProvider()
+	{
+		return $this->torExitProvider;
+	}
+
+	/**
+	 * @param TorExitProvider $torExitProvider
+	 */
+	public function setTorExitProvider($torExitProvider)
+	{
+		$this->torExitProvider = $torExitProvider;
+	}
+
+	/**
+	 * Gets the site configuration object
+	 *
+	 * @return SiteConfiguration
+	 */
+	final protected function getSiteConfiguration()
+	{
+		return $this->siteConfiguration;
+	}
+
+	/**
+	 * Sets the site configuration object for this page
+	 *
+	 * @param SiteConfiguration $configuration
+	 */
+	final public function setSiteConfiguration($configuration)
+	{
+		$this->siteConfiguration = $configuration;
+	}
 }
\ No newline at end of file

includes/DataObjects/User.php

Indentation +542 added lines, -542 removed lines

@@ -21,159 +21,159 @@ 
  */
 class User extends DataObject
 {
-    const STATUS_ACTIVE = 'Active';
-    const STATUS_SUSPENDED = 'Suspended';
-    const STATUS_DECLINED = 'Declined';
-    const STATUS_NEW = 'New';
-    const CREATION_MANUAL = 0;
-    const CREATION_OAUTH = 1;
-    const CREATION_BOT = 2;
-    private $username;
-    private $email;
-    private $status = self::STATUS_NEW;
-    private $onwikiname;
-    private $welcome_sig = "";
-    private $lastactive = "0000-00-00 00:00:00";
-    private $forcelogout = 0;
-    private $forceidentified = null;
-    private $welcome_template = 0;
-    private $abortpref = 0;
-    private $confirmationdiff = 0;
-    private $emailsig = "";
-    private $creationmode = 0;
-    /** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
-    private static $currentUser;
-    #region Object load methods
-
-    /**
-     * Gets the currently logged in user
-     *
-     * @param PdoDatabase $database
-     *
-     * @return User|CommunityUser
-     */
-    public static function getCurrent(PdoDatabase $database)
-    {
-        if (self::$currentUser === null) {
-            $sessionId = WebRequest::getSessionUserId();
-
-            if ($sessionId !== null) {
-                /** @var User $user */
-                $user = self::getById($sessionId, $database);
-
-                if ($user === false) {
-                    self::$currentUser = new CommunityUser();
-                }
-                else {
-                    self::$currentUser = $user;
-                }
-            }
-            else {
-                $anonymousCoward = new CommunityUser();
-
-                self::$currentUser = $anonymousCoward;
-            }
-        }
-
-        return self::$currentUser;
-    }
-
-    /**
-     * Gets a user by their user ID
-     *
-     * Pass -1 to get the community user.
-     *
-     * @param int|null    $id
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getById($id, PdoDatabase $database)
-    {
-        if ($id === null || $id == -1) {
-            return new CommunityUser();
-        }
-
-        /** @var User|false $user */
-        $user = parent::getById($id, $database);
-
-        return $user;
-    }
-
-    /**
-     * @return CommunityUser
-     */
-    public static function getCommunity()
-    {
-        return new CommunityUser();
-    }
-
-    /**
-     * Gets a user by their username
-     *
-     * @param  string      $username
-     * @param  PdoDatabase $database
-     *
-     * @return CommunityUser|User|false
-     */
-    public static function getByUsername($username, PdoDatabase $database)
-    {
-        global $communityUsername;
-        if ($username == $communityUsername) {
-            return new CommunityUser();
-        }
-
-        $statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;");
-        $statement->bindValue(":id", $username);
-
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    /**
-     * Gets a user by their on-wiki username.
-     *
-     * @param string      $username
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getByOnWikiUsername($username, PdoDatabase $database)
-    {
-        $statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;");
-        $statement->bindValue(":id", $username);
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-
-            return $resultObject;
-        }
-
-        return false;
-    }
-
-    #endregion
-
-    /**
-     * Saves the current object
-     *
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	const STATUS_ACTIVE = 'Active';
+	const STATUS_SUSPENDED = 'Suspended';
+	const STATUS_DECLINED = 'Declined';
+	const STATUS_NEW = 'New';
+	const CREATION_MANUAL = 0;
+	const CREATION_OAUTH = 1;
+	const CREATION_BOT = 2;
+	private $username;
+	private $email;
+	private $status = self::STATUS_NEW;
+	private $onwikiname;
+	private $welcome_sig = "";
+	private $lastactive = "0000-00-00 00:00:00";
+	private $forcelogout = 0;
+	private $forceidentified = null;
+	private $welcome_template = 0;
+	private $abortpref = 0;
+	private $confirmationdiff = 0;
+	private $emailsig = "";
+	private $creationmode = 0;
+	/** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
+	private static $currentUser;
+	#region Object load methods
+
+	/**
+	 * Gets the currently logged in user
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|CommunityUser
+	 */
+	public static function getCurrent(PdoDatabase $database)
+	{
+		if (self::$currentUser === null) {
+			$sessionId = WebRequest::getSessionUserId();
+
+			if ($sessionId !== null) {
+				/** @var User $user */
+				$user = self::getById($sessionId, $database);
+
+				if ($user === false) {
+					self::$currentUser = new CommunityUser();
+				}
+				else {
+					self::$currentUser = $user;
+				}
+			}
+			else {
+				$anonymousCoward = new CommunityUser();
+
+				self::$currentUser = $anonymousCoward;
+			}
+		}
+
+		return self::$currentUser;
+	}
+
+	/**
+	 * Gets a user by their user ID
+	 *
+	 * Pass -1 to get the community user.
+	 *
+	 * @param int|null    $id
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getById($id, PdoDatabase $database)
+	{
+		if ($id === null || $id == -1) {
+			return new CommunityUser();
+		}
+
+		/** @var User|false $user */
+		$user = parent::getById($id, $database);
+
+		return $user;
+	}
+
+	/**
+	 * @return CommunityUser
+	 */
+	public static function getCommunity()
+	{
+		return new CommunityUser();
+	}
+
+	/**
+	 * Gets a user by their username
+	 *
+	 * @param  string      $username
+	 * @param  PdoDatabase $database
+	 *
+	 * @return CommunityUser|User|false
+	 */
+	public static function getByUsername($username, PdoDatabase $database)
+	{
+		global $communityUsername;
+		if ($username == $communityUsername) {
+			return new CommunityUser();
+		}
+
+		$statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;");
+		$statement->bindValue(":id", $username);
+
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	/**
+	 * Gets a user by their on-wiki username.
+	 *
+	 * @param string      $username
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getByOnWikiUsername($username, PdoDatabase $database)
+	{
+		$statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;");
+		$statement->bindValue(":id", $username);
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+
+			return $resultObject;
+		}
+
+		return false;
+	}
+
+	#endregion
+
+	/**
+	 * Saves the current object
+	 *
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 				INSERT INTO `user` ( 
 					username, email, status, onwikiname, welcome_sig, 
 					lastactive, forcelogout, forceidentified,
@@ -184,31 +184,31 @@ 
 					:welcome_template, :abortpref, :confirmationdiff, :emailsig, :creationmode
 				);
 SQL
-            );
-            $statement->bindValue(":username", $this->username);
-            $statement->bindValue(":email", $this->email);
-            $statement->bindValue(":status", $this->status);
-            $statement->bindValue(":onwikiname", $this->onwikiname);
-            $statement->bindValue(":welcome_sig", $this->welcome_sig);
-            $statement->bindValue(":lastactive", $this->lastactive);
-            $statement->bindValue(":forcelogout", $this->forcelogout);
-            $statement->bindValue(":forceidentified", $this->forceidentified);
-            $statement->bindValue(":welcome_template", $this->welcome_template);
-            $statement->bindValue(":abortpref", $this->abortpref);
-            $statement->bindValue(":confirmationdiff", $this->confirmationdiff);
-            $statement->bindValue(":emailsig", $this->emailsig);
-            $statement->bindValue(":creationmode", $this->creationmode);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":username", $this->username);
+			$statement->bindValue(":email", $this->email);
+			$statement->bindValue(":status", $this->status);
+			$statement->bindValue(":onwikiname", $this->onwikiname);
+			$statement->bindValue(":welcome_sig", $this->welcome_sig);
+			$statement->bindValue(":lastactive", $this->lastactive);
+			$statement->bindValue(":forcelogout", $this->forcelogout);
+			$statement->bindValue(":forceidentified", $this->forceidentified);
+			$statement->bindValue(":welcome_template", $this->welcome_template);
+			$statement->bindValue(":abortpref", $this->abortpref);
+			$statement->bindValue(":confirmationdiff", $this->confirmationdiff);
+			$statement->bindValue(":emailsig", $this->emailsig);
+			$statement->bindValue(":creationmode", $this->creationmode);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
 				UPDATE `user` SET 
 					username = :username, email = :email, 
 					status = :status,
@@ -221,364 +221,364 @@ 
 				WHERE id = :id AND updateversion = :updateversion
 				LIMIT 1;
 SQL
-            );
-            $statement->bindValue(":forceidentified", $this->forceidentified);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':username', $this->username);
-            $statement->bindValue(':email', $this->email);
-            $statement->bindValue(':status', $this->status);
-            $statement->bindValue(':onwikiname', $this->onwikiname);
-            $statement->bindValue(':welcome_sig', $this->welcome_sig);
-            $statement->bindValue(':lastactive', $this->lastactive);
-            $statement->bindValue(':forcelogout', $this->forcelogout);
-            $statement->bindValue(':forceidentified', $this->forceidentified);
-            $statement->bindValue(':welcome_template', $this->welcome_template);
-            $statement->bindValue(':abortpref', $this->abortpref);
-            $statement->bindValue(':confirmationdiff', $this->confirmationdiff);
-            $statement->bindValue(':emailsig', $this->emailsig);
-            $statement->bindValue(':creationmode', $this->creationmode);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    #region properties
-
-    /**
-     * Gets the tool username
-     * @return string
-     */
-    public function getUsername()
-    {
-        return $this->username;
-    }
-
-    /**
-     * Sets the tool username
-     *
-     * @param string $username
-     */
-    public function setUsername($username)
-    {
-        $this->username = $username;
-
-        // If this isn't a brand new user, then it's a rename, force the logout
-        if (!$this->isNew()) {
-            $this->forcelogout = 1;
-        }
-    }
-
-    /**
-     * Gets the user's email address
-     * @return string
-     */
-    public function getEmail()
-    {
-        return $this->email;
-    }
-
-    /**
-     * Sets the user's email address
-     *
-     * @param string $email
-     */
-    public function setEmail($email)
-    {
-        $this->email = $email;
-    }
-
-    /**
-     * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user.
-     * @return string
-     */
-    public function getStatus()
-    {
-        return $this->status;
-    }
-
-    /**
-     * @param string $status
-     */
-    public function setStatus($status)
-    {
-        $this->status = $status;
-    }
-
-    /**
-     * Gets the user's on-wiki name
-     * @return string
-     */
-    public function getOnWikiName()
-    {
-        return $this->onwikiname;
-    }
-
-    /**
-     * Sets the user's on-wiki name
-     *
-     * This can have interesting side-effects with OAuth.
-     *
-     * @param string $onWikiName
-     */
-    public function setOnWikiName($onWikiName)
-    {
-        $this->onwikiname = $onWikiName;
-    }
-
-    /**
-     * Gets the welcome signature
-     * @return string
-     */
-    public function getWelcomeSig()
-    {
-        return $this->welcome_sig;
-    }
-
-    /**
-     * Sets the welcome signature
-     *
-     * @param string $welcomeSig
-     */
-    public function setWelcomeSig($welcomeSig)
-    {
-        $this->welcome_sig = $welcomeSig;
-    }
-
-    /**
-     * Gets the last activity date for the user
-     *
-     * @return string
-     * @todo This should probably return an instance of DateTime
-     */
-    public function getLastActive()
-    {
-        return $this->lastactive;
-    }
-
-    /**
-     * Gets the user's forced logout status
-     *
-     * @return bool
-     */
-    public function getForceLogout()
-    {
-        return $this->forcelogout == 1;
-    }
-
-    /**
-     * Sets the user's forced logout status
-     *
-     * @param bool $forceLogout
-     */
-    public function setForceLogout($forceLogout)
-    {
-        $this->forcelogout = $forceLogout ? 1 : 0;
-    }
-
-    /**
-     * Returns the ID of the welcome template used.
-     * @return int
-     */
-    public function getWelcomeTemplate()
-    {
-        return $this->welcome_template;
-    }
-
-    /**
-     * Sets the ID of the welcome template used.
-     *
-     * @param int $welcomeTemplate
-     */
-    public function setWelcomeTemplate($welcomeTemplate)
-    {
-        $this->welcome_template = $welcomeTemplate;
-    }
-
-    /**
-     * Gets the user's abort preference
-     * @todo this is badly named too! Also a bool that's actually an int.
-     * @return int
-     */
-    public function getAbortPref()
-    {
-        return $this->abortpref;
-    }
-
-    /**
-     * Sets the user's abort preference
-     * @todo rename, retype, and re-comment.
-     *
-     * @param int $abortPreference
-     */
-    public function setAbortPref($abortPreference)
-    {
-        $this->abortpref = $abortPreference;
-    }
-
-    /**
-     * Gets the user's confirmation diff. Unused if OAuth is in use.
-     * @return int the diff ID
-     */
-    public function getConfirmationDiff()
-    {
-        return $this->confirmationdiff;
-    }
-
-    /**
-     * Sets the user's confirmation diff.
-     *
-     * @param int $confirmationDiff
-     */
-    public function setConfirmationDiff($confirmationDiff)
-    {
-        $this->confirmationdiff = $confirmationDiff;
-    }
-
-    /**
-     * Gets the users' email signature used on outbound mail.
-     * @todo rename me!
-     * @return string
-     */
-    public function getEmailSig()
-    {
-        return $this->emailsig;
-    }
-
-    /**
-     * Sets the user's email signature for outbound mail.
-     *
-     * @param string $emailSignature
-     */
-    public function setEmailSig($emailSignature)
-    {
-        $this->emailsig = $emailSignature;
-    }
-
-    /**
-     * @return int
-     */
-    public function getCreationMode()
-    {
-        return $this->creationmode;
-    }
-
-    /**
-     * @param $creationMode int
-     */
-    public function setCreationMode($creationMode)
-    {
-        $this->creationmode = $creationMode;
-    }
-
-    #endregion
-
-    #region user access checks
-
-    public function isActive()
-    {
-        return $this->status == self::STATUS_ACTIVE;
-    }
-
-    /**
-     * Tests if the user is identified
-     *
-     * @param IdentificationVerifier $iv
-     *
-     * @return bool
-     * @todo     Figure out what on earth is going on with PDO's typecasting here.  Apparently, it returns string("0") for
-     *       the force-unidentified case, and int(1) for the identified case?!  This is quite ugly, but probably needed
-     *       to play it safe for now.
-     * @category Security-Critical
-     */
-    public function isIdentified(IdentificationVerifier $iv)
-    {
-        if ($this->forceidentified === 0 || $this->forceidentified === "0") {
-            // User forced to unidentified in the database.
-            return false;
-        }
-        elseif ($this->forceidentified === 1 || $this->forceidentified === "1") {
-            // User forced to identified in the database.
-            return true;
-        }
-        else {
-            // User not forced to any particular identified status; consult IdentificationVerifier
-            return $iv->isUserIdentified($this->getOnWikiName());
-        }
-    }
-
-    /**
-     * Tests if the user is suspended
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isSuspended()
-    {
-        return $this->status == self::STATUS_SUSPENDED;
-    }
-
-    /**
-     * Tests if the user is new
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isNewUser()
-    {
-        return $this->status == self::STATUS_NEW;
-    }
-
-    /**
-     * Tests if the user has been declined access to the tool
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isDeclined()
-    {
-        return $this->status == self::STATUS_DECLINED;
-    }
-
-    /**
-     * Tests if the user is the community user
-     *
-     * @todo     decide if this means logged out. I think it usually does.
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isCommunityUser()
-    {
-        return false;
-    }
-
-    #endregion 
-
-    /**
-     * Gets a hash of data for the user to reset their password with.
-     * @category Security-Critical
-     * @return string
-     */
-    public function getForgottenPasswordHash()
-    {
-        // FIXME
-        return md5($this->username . $this->email . $this->welcome_template . $this->id);
-    }
-
-    /**
-     * Gets the approval date of the user
-     * @return DateTime|false
-     */
-    public function getApprovalDate()
-    {
-        $query = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":forceidentified", $this->forceidentified);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(':username', $this->username);
+			$statement->bindValue(':email', $this->email);
+			$statement->bindValue(':status', $this->status);
+			$statement->bindValue(':onwikiname', $this->onwikiname);
+			$statement->bindValue(':welcome_sig', $this->welcome_sig);
+			$statement->bindValue(':lastactive', $this->lastactive);
+			$statement->bindValue(':forcelogout', $this->forcelogout);
+			$statement->bindValue(':forceidentified', $this->forceidentified);
+			$statement->bindValue(':welcome_template', $this->welcome_template);
+			$statement->bindValue(':abortpref', $this->abortpref);
+			$statement->bindValue(':confirmationdiff', $this->confirmationdiff);
+			$statement->bindValue(':emailsig', $this->emailsig);
+			$statement->bindValue(':creationmode', $this->creationmode);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	#region properties
+
+	/**
+	 * Gets the tool username
+	 * @return string
+	 */
+	public function getUsername()
+	{
+		return $this->username;
+	}
+
+	/**
+	 * Sets the tool username
+	 *
+	 * @param string $username
+	 */
+	public function setUsername($username)
+	{
+		$this->username = $username;
+
+		// If this isn't a brand new user, then it's a rename, force the logout
+		if (!$this->isNew()) {
+			$this->forcelogout = 1;
+		}
+	}
+
+	/**
+	 * Gets the user's email address
+	 * @return string
+	 */
+	public function getEmail()
+	{
+		return $this->email;
+	}
+
+	/**
+	 * Sets the user's email address
+	 *
+	 * @param string $email
+	 */
+	public function setEmail($email)
+	{
+		$this->email = $email;
+	}
+
+	/**
+	 * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user.
+	 * @return string
+	 */
+	public function getStatus()
+	{
+		return $this->status;
+	}
+
+	/**
+	 * @param string $status
+	 */
+	public function setStatus($status)
+	{
+		$this->status = $status;
+	}
+
+	/**
+	 * Gets the user's on-wiki name
+	 * @return string
+	 */
+	public function getOnWikiName()
+	{
+		return $this->onwikiname;
+	}
+
+	/**
+	 * Sets the user's on-wiki name
+	 *
+	 * This can have interesting side-effects with OAuth.
+	 *
+	 * @param string $onWikiName
+	 */
+	public function setOnWikiName($onWikiName)
+	{
+		$this->onwikiname = $onWikiName;
+	}
+
+	/**
+	 * Gets the welcome signature
+	 * @return string
+	 */
+	public function getWelcomeSig()
+	{
+		return $this->welcome_sig;
+	}
+
+	/**
+	 * Sets the welcome signature
+	 *
+	 * @param string $welcomeSig
+	 */
+	public function setWelcomeSig($welcomeSig)
+	{
+		$this->welcome_sig = $welcomeSig;
+	}
+
+	/**
+	 * Gets the last activity date for the user
+	 *
+	 * @return string
+	 * @todo This should probably return an instance of DateTime
+	 */
+	public function getLastActive()
+	{
+		return $this->lastactive;
+	}
+
+	/**
+	 * Gets the user's forced logout status
+	 *
+	 * @return bool
+	 */
+	public function getForceLogout()
+	{
+		return $this->forcelogout == 1;
+	}
+
+	/**
+	 * Sets the user's forced logout status
+	 *
+	 * @param bool $forceLogout
+	 */
+	public function setForceLogout($forceLogout)
+	{
+		$this->forcelogout = $forceLogout ? 1 : 0;
+	}
+
+	/**
+	 * Returns the ID of the welcome template used.
+	 * @return int
+	 */
+	public function getWelcomeTemplate()
+	{
+		return $this->welcome_template;
+	}
+
+	/**
+	 * Sets the ID of the welcome template used.
+	 *
+	 * @param int $welcomeTemplate
+	 */
+	public function setWelcomeTemplate($welcomeTemplate)
+	{
+		$this->welcome_template = $welcomeTemplate;
+	}
+
+	/**
+	 * Gets the user's abort preference
+	 * @todo this is badly named too! Also a bool that's actually an int.
+	 * @return int
+	 */
+	public function getAbortPref()
+	{
+		return $this->abortpref;
+	}
+
+	/**
+	 * Sets the user's abort preference
+	 * @todo rename, retype, and re-comment.
+	 *
+	 * @param int $abortPreference
+	 */
+	public function setAbortPref($abortPreference)
+	{
+		$this->abortpref = $abortPreference;
+	}
+
+	/**
+	 * Gets the user's confirmation diff. Unused if OAuth is in use.
+	 * @return int the diff ID
+	 */
+	public function getConfirmationDiff()
+	{
+		return $this->confirmationdiff;
+	}
+
+	/**
+	 * Sets the user's confirmation diff.
+	 *
+	 * @param int $confirmationDiff
+	 */
+	public function setConfirmationDiff($confirmationDiff)
+	{
+		$this->confirmationdiff = $confirmationDiff;
+	}
+
+	/**
+	 * Gets the users' email signature used on outbound mail.
+	 * @todo rename me!
+	 * @return string
+	 */
+	public function getEmailSig()
+	{
+		return $this->emailsig;
+	}
+
+	/**
+	 * Sets the user's email signature for outbound mail.
+	 *
+	 * @param string $emailSignature
+	 */
+	public function setEmailSig($emailSignature)
+	{
+		$this->emailsig = $emailSignature;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getCreationMode()
+	{
+		return $this->creationmode;
+	}
+
+	/**
+	 * @param $creationMode int
+	 */
+	public function setCreationMode($creationMode)
+	{
+		$this->creationmode = $creationMode;
+	}
+
+	#endregion
+
+	#region user access checks
+
+	public function isActive()
+	{
+		return $this->status == self::STATUS_ACTIVE;
+	}
+
+	/**
+	 * Tests if the user is identified
+	 *
+	 * @param IdentificationVerifier $iv
+	 *
+	 * @return bool
+	 * @todo     Figure out what on earth is going on with PDO's typecasting here.  Apparently, it returns string("0") for
+	 *       the force-unidentified case, and int(1) for the identified case?!  This is quite ugly, but probably needed
+	 *       to play it safe for now.
+	 * @category Security-Critical
+	 */
+	public function isIdentified(IdentificationVerifier $iv)
+	{
+		if ($this->forceidentified === 0 || $this->forceidentified === "0") {
+			// User forced to unidentified in the database.
+			return false;
+		}
+		elseif ($this->forceidentified === 1 || $this->forceidentified === "1") {
+			// User forced to identified in the database.
+			return true;
+		}
+		else {
+			// User not forced to any particular identified status; consult IdentificationVerifier
+			return $iv->isUserIdentified($this->getOnWikiName());
+		}
+	}
+
+	/**
+	 * Tests if the user is suspended
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isSuspended()
+	{
+		return $this->status == self::STATUS_SUSPENDED;
+	}
+
+	/**
+	 * Tests if the user is new
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isNewUser()
+	{
+		return $this->status == self::STATUS_NEW;
+	}
+
+	/**
+	 * Tests if the user has been declined access to the tool
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isDeclined()
+	{
+		return $this->status == self::STATUS_DECLINED;
+	}
+
+	/**
+	 * Tests if the user is the community user
+	 *
+	 * @todo     decide if this means logged out. I think it usually does.
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isCommunityUser()
+	{
+		return false;
+	}
+
+	#endregion 
+
+	/**
+	 * Gets a hash of data for the user to reset their password with.
+	 * @category Security-Critical
+	 * @return string
+	 */
+	public function getForgottenPasswordHash()
+	{
+		// FIXME
+		return md5($this->username . $this->email . $this->welcome_template . $this->id);
+	}
+
+	/**
+	 * Gets the approval date of the user
+	 * @return DateTime|false
+	 */
+	public function getApprovalDate()
+	{
+		$query = $this->dbObject->prepare(<<<SQL
 			SELECT timestamp 
 			FROM log 
 			WHERE objectid = :userid
@@ -587,12 +587,12 @@ 
 			ORDER BY id DESC 
 			LIMIT 1;
 SQL
-        );
-        $query->execute(array(":userid" => $this->id));
+		);
+		$query->execute(array(":userid" => $this->id));
 
-        $data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
-        $query->closeCursor();
+		$data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
+		$query->closeCursor();
 
-        return $data;
-    }
+		return $data;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -569,7 +569,7 @@
     public function getForgottenPasswordHash()
     {
         // FIXME
-        return md5($this->username . $this->email . $this->welcome_template . $this->id);
+        return md5($this->username.$this->email.$this->welcome_template.$this->id);
     }
 
     /**

includes/DataObjects/Credential.php

Indentation +128 added lines, -128 removed lines

@@ -14,122 +14,122 @@ 
 
 class Credential extends DataObject
 {
-    /** @var int */
-    private $user;
-    /** @var int */
-    private $factor;
-    /** @var string */
-    private $type;
-    /** @var string */
-    private $data;
-    /** @var int */
-    private $version;
-
-    /**
-     * @return int
-     */
-    public function getUserId()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user
-     */
-    public function setUserId($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return int
-     */
-    public function getFactor()
-    {
-        return $this->factor;
-    }
-
-    /**
-     * @param int $factor
-     */
-    public function setFactor($factor)
-    {
-        $this->factor = $factor;
-    }
-
-    /**
-     * @return string
-     */
-    public function getType()
-    {
-        return $this->type;
-    }
-
-    /**
-     * @param string $type
-     */
-    public function setType($type)
-    {
-        $this->type = $type;
-    }
-
-    /**
-     * @return string
-     */
-    public function getData()
-    {
-        return $this->data;
-    }
-
-    /**
-     * @param string $data
-     */
-    public function setData($data)
-    {
-        $this->data = $data;
-    }
-
-    /**
-     * @return int
-     */
-    public function getVersion()
-    {
-        return $this->version;
-    }
-
-    /**
-     * @param int $version
-     */
-    public function setVersion($version)
-    {
-        $this->version = $version;
-    }
-
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	/** @var int */
+	private $user;
+	/** @var int */
+	private $factor;
+	/** @var string */
+	private $type;
+	/** @var string */
+	private $data;
+	/** @var int */
+	private $version;
+
+	/**
+	 * @return int
+	 */
+	public function getUserId()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user
+	 */
+	public function setUserId($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getFactor()
+	{
+		return $this->factor;
+	}
+
+	/**
+	 * @param int $factor
+	 */
+	public function setFactor($factor)
+	{
+		$this->factor = $factor;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getType()
+	{
+		return $this->type;
+	}
+
+	/**
+	 * @param string $type
+	 */
+	public function setType($type)
+	{
+		$this->type = $type;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getData()
+	{
+		return $this->data;
+	}
+
+	/**
+	 * @param string $data
+	 */
+	public function setData($data)
+	{
+		$this->data = $data;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getVersion()
+	{
+		return $this->version;
+	}
+
+	/**
+	 * @param int $version
+	 */
+	public function setVersion($version)
+	{
+		$this->version = $version;
+	}
+
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 INSERT INTO credential ( updateversion, user, factor, type, data, version )
 VALUES ( 0, :user, :factor, :type, :data, :version );
 SQL
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":factor", $this->factor);
-            $statement->bindValue(":type", $this->type);
-            $statement->bindValue(":data", $this->data);
-            $statement->bindValue(":version", $this->version);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":factor", $this->factor);
+			$statement->bindValue(":type", $this->type);
+			$statement->bindValue(":data", $this->data);
+			$statement->bindValue(":version", $this->version);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE credential
                 SET   factor = :factor
                     , data = :data
@@ -137,24 +137,24 @@ 
                     , updateversion = updateversion + 1
                 WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
+			);
 
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
 
-            $statement->bindValue(":factor", $this->factor);
-            $statement->bindValue(":data", $this->data);
-            $statement->bindValue(":version", $this->version);
+			$statement->bindValue(":factor", $this->factor);
+			$statement->bindValue(":data", $this->data);
+			$statement->bindValue(":version", $this->version);
 
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
 
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
 
-            $this->updateversion++;
-        }
-    }
+			$this->updateversion++;
+		}
+	}
 }
\ No newline at end of file

includes/DataObjects/CommunityUser.php

Indentation +159 added lines, -159 removed lines

@@ -16,163 +16,163 @@
  */
 class CommunityUser extends User
 {
-    public function getId()
-    {
-        return -1;
-    }
-
-    public function save()
-    {
-        // Do nothing
-    }
-
-    #region properties
-
-    /**
-     * @return string
-     */
-    public function getUsername()
-    {
-        global $communityUsername;
-
-        return $communityUsername;
-    }
-
-    public function setUsername($username)
-    {
-    }
-
-    /**
-     * @return string
-     */
-    public function getEmail()
-    {
-        global $cDataClearEmail;
-
-        return $cDataClearEmail;
-    }
-
-    public function setEmail($email)
-    {
-    }
-
-    public function getStatus()
-    {
-        return "Community";
-    }
-
-    public function getOnWikiName()
-    {
-        return "127.0.0.1";
-    }
-
-    public function setOnWikiName($onWikiName)
-    {
-    }
-
-    public function getWelcomeSig()
-    {
-        return null;
-    }
-
-    public function setWelcomeSig($welcomeSig)
-    {
-    }
-
-    public function getLastActive()
-    {
-        $now = new DateTime();
-
-        return $now->format("Y-m-d H:i:s");
-    }
-
-    public function getForceLogout()
-    {
-        return true;
-    }
-
-    public function setForceLogout($forceLogout)
-    {
-    }
-
-    /**
-     * @param string $status
-     */
-    public function setStatus($status)
-    {
-    }
-
-    public function getWelcomeTemplate()
-    {
-        return 0;
-    }
-
-    public function setWelcomeTemplate($welcomeTemplate)
-    {
-    }
-
-    public function getAbortPref()
-    {
-        return 0;
-    }
-
-    public function setAbortPref($abortPreference)
-    {
-    }
-
-    public function getConfirmationDiff()
-    {
-        return null;
-    }
-
-    public function setConfirmationDiff($confirmationDiff)
-    {
-    }
-
-    public function getEmailSig()
-    {
-        return null;
-    }
-
-    public function setEmailSig($emailSignature)
-    {
-    }
-
-    #endregion
-
-    #region user access checks
-
-    public function isIdentified(IdentificationVerifier $iv)
-    {
-        return false;
-    }
-
-    public function isSuspended()
-    {
-        return false;
-    }
-
-    public function isNewUser()
-    {
-        return false;
-    }
-
-    public function isDeclined()
-    {
-        return false;
-    }
-
-    public function isCommunityUser()
-    {
-        return true;
-    }
-
-    #endregion
-
-    public function getApprovalDate()
-    {
-        $data = DateTime::createFromFormat("Y-m-d H:i:s", "1970-01-01 00:00:00");
-
-        return $data;
-    }
+	public function getId()
+	{
+		return -1;
+	}
+
+	public function save()
+	{
+		// Do nothing
+	}
+
+	#region properties
+
+	/**
+	 * @return string
+	 */
+	public function getUsername()
+	{
+		global $communityUsername;
+
+		return $communityUsername;
+	}
+
+	public function setUsername($username)
+	{
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEmail()
+	{
+		global $cDataClearEmail;
+
+		return $cDataClearEmail;
+	}
+
+	public function setEmail($email)
+	{
+	}
+
+	public function getStatus()
+	{
+		return "Community";
+	}
+
+	public function getOnWikiName()
+	{
+		return "127.0.0.1";
+	}
+
+	public function setOnWikiName($onWikiName)
+	{
+	}
+
+	public function getWelcomeSig()
+	{
+		return null;
+	}
+
+	public function setWelcomeSig($welcomeSig)
+	{
+	}
+
+	public function getLastActive()
+	{
+		$now = new DateTime();
+
+		return $now->format("Y-m-d H:i:s");
+	}
+
+	public function getForceLogout()
+	{
+		return true;
+	}
+
+	public function setForceLogout($forceLogout)
+	{
+	}
+
+	/**
+	 * @param string $status
+	 */
+	public function setStatus($status)
+	{
+	}
+
+	public function getWelcomeTemplate()
+	{
+		return 0;
+	}
+
+	public function setWelcomeTemplate($welcomeTemplate)
+	{
+	}
+
+	public function getAbortPref()
+	{
+		return 0;
+	}
+
+	public function setAbortPref($abortPreference)
+	{
+	}
+
+	public function getConfirmationDiff()
+	{
+		return null;
+	}
+
+	public function setConfirmationDiff($confirmationDiff)
+	{
+	}
+
+	public function getEmailSig()
+	{
+		return null;
+	}
+
+	public function setEmailSig($emailSignature)
+	{
+	}
+
+	#endregion
+
+	#region user access checks
+
+	public function isIdentified(IdentificationVerifier $iv)
+	{
+		return false;
+	}
+
+	public function isSuspended()
+	{
+		return false;
+	}
+
+	public function isNewUser()
+	{
+		return false;
+	}
+
+	public function isDeclined()
+	{
+		return false;
+	}
+
+	public function isCommunityUser()
+	{
+		return true;
+	}
+
+	#endregion
+
+	public function getApprovalDate()
+	{
+		$data = DateTime::createFromFormat("Y-m-d H:i:s", "1970-01-01 00:00:00");
+
+		return $data;
+	}
 }

includes/ApplicationBase.php

Indentation +151 added lines, -151 removed lines

@@ -25,155 +25,155 @@
 
 abstract class ApplicationBase
 {
-    private $configuration;
-
-    public function __construct(SiteConfiguration $configuration)
-    {
-        $this->configuration = $configuration;
-    }
-
-    /**
-     * Application entry point.
-     *
-     * Sets up the environment and runs the application, performing any global cleanup operations when done.
-     */
-    public function run()
-    {
-        try {
-            if ($this->setupEnvironment()) {
-                $this->main();
-            }
-        }
-        catch (Exception $ex) {
-            print $ex->getMessage();
-        }
-        finally {
-            $this->cleanupEnvironment();
-        }
-    }
-
-    /**
-     * Environment setup
-     *
-     * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
-     * and shut down prematurely.
-     *
-     * @return bool
-     * @throws EnvironmentException
-     */
-    protected function setupEnvironment()
-    {
-        $this->setupDatabase();
-
-        return true;
-    }
-
-    /**
-     * @return PdoDatabase
-     * @throws EnvironmentException
-     * @throws Exception
-     */
-    protected function setupDatabase()
-    {
-        // check the schema version
-        $database = PdoDatabase::getDatabaseConnection('acc');
-
-        /** @var int $actualVersion */
-        $actualVersion = (int)$database->query('SELECT version FROM schemaversion')->fetchColumn();
-        if ($actualVersion !== $this->getConfiguration()->getSchemaVersion()) {
-            throw new EnvironmentException('Database schema is wrong version! Please either update configuration or database.');
-        }
-
-        return $database;
-    }
-
-    /**
-     * @return SiteConfiguration
-     */
-    public function getConfiguration()
-    {
-        return $this->configuration;
-    }
-
-    /**
-     * Main application logic
-     * @return void
-     */
-    abstract protected function main();
-
-    /**
-     * Any cleanup tasks should go here
-     *
-     * Note that we need to be very careful here, as exceptions may have been thrown and handled.
-     * This should *only* be for cleaning up, no logic should go here.
-     *
-     * @return void
-     */
-    abstract protected function cleanupEnvironment();
-
-    /**
-     * @param ITask             $page
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $database
-     * @param PdoDatabase       $notificationsDatabase
-     *
-     * @return void
-     */
-    protected function setupHelpers(
-        ITask $page,
-        SiteConfiguration $siteConfiguration,
-        PdoDatabase $database,
-        PdoDatabase $notificationsDatabase = null
-    ) {
-        $page->setSiteConfiguration($siteConfiguration);
-
-        // setup the global database object
-        $page->setDatabase($database);
-
-        // set up helpers and inject them into the page.
-        $httpHelper = new HttpHelper(
-            $siteConfiguration->getUserAgent(),
-            $siteConfiguration->getCurlDisableVerifyPeer()
-        );
-
-        $page->setEmailHelper(new EmailHelper());
-        $page->setHttpHelper($httpHelper);
-        $page->setWikiTextHelper(new WikiTextHelper($siteConfiguration, $page->getHttpHelper()));
-
-        if ($siteConfiguration->getLocationProviderApiKey() === null) {
-            $page->setLocationProvider(new FakeLocationProvider());
-        }
-        else {
-            $page->setLocationProvider(
-                new IpLocationProvider(
-                    $database,
-                    $siteConfiguration->getLocationProviderApiKey(),
-                    $httpHelper
-                ));
-        }
-
-        $page->setXffTrustProvider(new XffTrustProvider($siteConfiguration->getSquidList(), $database));
-
-        $page->setRdnsProvider(new CachedRDnsLookupProvider($database));
-
-        $page->setAntiSpoofProvider(new CachedApiAntispoofProvider(
-            $database,
-            $this->getConfiguration()->getMediawikiWebServiceEndpoint(),
-            $httpHelper));
-
-        $page->setOAuthProtocolHelper(new OAuthProtocolHelper(
-            $siteConfiguration->getOAuthBaseUrl(),
-            $siteConfiguration->getOAuthConsumerToken(),
-            $siteConfiguration->getOAuthConsumerSecret(),
-            $httpHelper,
-            $siteConfiguration->getMediawikiWebServiceEndpoint()
-        ));
-
-        $page->setNotificationHelper(new IrcNotificationHelper(
-            $siteConfiguration,
-            $database,
-            $notificationsDatabase));
-
-        $page->setTorExitProvider(new TorExitProvider($database));
-    }
+	private $configuration;
+
+	public function __construct(SiteConfiguration $configuration)
+	{
+		$this->configuration = $configuration;
+	}
+
+	/**
+	 * Application entry point.
+	 *
+	 * Sets up the environment and runs the application, performing any global cleanup operations when done.
+	 */
+	public function run()
+	{
+		try {
+			if ($this->setupEnvironment()) {
+				$this->main();
+			}
+		}
+		catch (Exception $ex) {
+			print $ex->getMessage();
+		}
+		finally {
+			$this->cleanupEnvironment();
+		}
+	}
+
+	/**
+	 * Environment setup
+	 *
+	 * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
+	 * and shut down prematurely.
+	 *
+	 * @return bool
+	 * @throws EnvironmentException
+	 */
+	protected function setupEnvironment()
+	{
+		$this->setupDatabase();
+
+		return true;
+	}
+
+	/**
+	 * @return PdoDatabase
+	 * @throws EnvironmentException
+	 * @throws Exception
+	 */
+	protected function setupDatabase()
+	{
+		// check the schema version
+		$database = PdoDatabase::getDatabaseConnection('acc');
+
+		/** @var int $actualVersion */
+		$actualVersion = (int)$database->query('SELECT version FROM schemaversion')->fetchColumn();
+		if ($actualVersion !== $this->getConfiguration()->getSchemaVersion()) {
+			throw new EnvironmentException('Database schema is wrong version! Please either update configuration or database.');
+		}
+
+		return $database;
+	}
+
+	/**
+	 * @return SiteConfiguration
+	 */
+	public function getConfiguration()
+	{
+		return $this->configuration;
+	}
+
+	/**
+	 * Main application logic
+	 * @return void
+	 */
+	abstract protected function main();
+
+	/**
+	 * Any cleanup tasks should go here
+	 *
+	 * Note that we need to be very careful here, as exceptions may have been thrown and handled.
+	 * This should *only* be for cleaning up, no logic should go here.
+	 *
+	 * @return void
+	 */
+	abstract protected function cleanupEnvironment();
+
+	/**
+	 * @param ITask             $page
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $database
+	 * @param PdoDatabase       $notificationsDatabase
+	 *
+	 * @return void
+	 */
+	protected function setupHelpers(
+		ITask $page,
+		SiteConfiguration $siteConfiguration,
+		PdoDatabase $database,
+		PdoDatabase $notificationsDatabase = null
+	) {
+		$page->setSiteConfiguration($siteConfiguration);
+
+		// setup the global database object
+		$page->setDatabase($database);
+
+		// set up helpers and inject them into the page.
+		$httpHelper = new HttpHelper(
+			$siteConfiguration->getUserAgent(),
+			$siteConfiguration->getCurlDisableVerifyPeer()
+		);
+
+		$page->setEmailHelper(new EmailHelper());
+		$page->setHttpHelper($httpHelper);
+		$page->setWikiTextHelper(new WikiTextHelper($siteConfiguration, $page->getHttpHelper()));
+
+		if ($siteConfiguration->getLocationProviderApiKey() === null) {
+			$page->setLocationProvider(new FakeLocationProvider());
+		}
+		else {
+			$page->setLocationProvider(
+				new IpLocationProvider(
+					$database,
+					$siteConfiguration->getLocationProviderApiKey(),
+					$httpHelper
+				));
+		}
+
+		$page->setXffTrustProvider(new XffTrustProvider($siteConfiguration->getSquidList(), $database));
+
+		$page->setRdnsProvider(new CachedRDnsLookupProvider($database));
+
+		$page->setAntiSpoofProvider(new CachedApiAntispoofProvider(
+			$database,
+			$this->getConfiguration()->getMediawikiWebServiceEndpoint(),
+			$httpHelper));
+
+		$page->setOAuthProtocolHelper(new OAuthProtocolHelper(
+			$siteConfiguration->getOAuthBaseUrl(),
+			$siteConfiguration->getOAuthConsumerToken(),
+			$siteConfiguration->getOAuthConsumerSecret(),
+			$httpHelper,
+			$siteConfiguration->getMediawikiWebServiceEndpoint()
+		));
+
+		$page->setNotificationHelper(new IrcNotificationHelper(
+			$siteConfiguration,
+			$database,
+			$notificationsDatabase));
+
+		$page->setTorExitProvider(new TorExitProvider($database));
+	}
 }
\ No newline at end of file

includes/ConsoleStart.php

Indentation +59 added lines, -59 removed lines

@@ -15,74 +15,74 @@
 
 class ConsoleStart extends ApplicationBase
 {
-    /**
-     * @var ConsoleTaskBase
-     */
-    private $consoleTask;
+	/**
+	 * @var ConsoleTaskBase
+	 */
+	private $consoleTask;
 
-    /**
-     * ConsoleStart constructor.
-     *
-     * @param SiteConfiguration $configuration
-     * @param ConsoleTaskBase   $consoleTask
-     */
-    public function __construct(SiteConfiguration $configuration, ConsoleTaskBase $consoleTask)
-    {
-        parent::__construct($configuration);
-        $this->consoleTask = $consoleTask;
-    }
+	/**
+	 * ConsoleStart constructor.
+	 *
+	 * @param SiteConfiguration $configuration
+	 * @param ConsoleTaskBase   $consoleTask
+	 */
+	public function __construct(SiteConfiguration $configuration, ConsoleTaskBase $consoleTask)
+	{
+		parent::__construct($configuration);
+		$this->consoleTask = $consoleTask;
+	}
 
-    protected function setupEnvironment()
-    {
-        // initialise super-global providers
-        WebRequest::setGlobalStateProvider(new FakeGlobalStateProvider());
+	protected function setupEnvironment()
+	{
+		// initialise super-global providers
+		WebRequest::setGlobalStateProvider(new FakeGlobalStateProvider());
 
-        if (WebRequest::method() !== null) {
-            throw new EnvironmentException('This is a console task, which cannot be executed via the web.');
-        }
+		if (WebRequest::method() !== null) {
+			throw new EnvironmentException('This is a console task, which cannot be executed via the web.');
+		}
 
-        return parent::setupEnvironment();
-    }
+		return parent::setupEnvironment();
+	}
 
-    protected function cleanupEnvironment()
-    {
-    }
+	protected function cleanupEnvironment()
+	{
+	}
 
-    /**
-     * Main application logic
-     */
-    protected function main()
-    {
-        $database = PdoDatabase::getDatabaseConnection('acc');
+	/**
+	 * Main application logic
+	 */
+	protected function main()
+	{
+		$database = PdoDatabase::getDatabaseConnection('acc');
 
-        if ($this->getConfiguration()->getIrcNotificationsEnabled()) {
-            $notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications');
-        }
-        else {
-            // pass through null
-            $notificationsDatabase = null;
-        }
+		if ($this->getConfiguration()->getIrcNotificationsEnabled()) {
+			$notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications');
+		}
+		else {
+			// pass through null
+			$notificationsDatabase = null;
+		}
 
-        $this->setupHelpers($this->consoleTask, $this->getConfiguration(), $database, $notificationsDatabase);
+		$this->setupHelpers($this->consoleTask, $this->getConfiguration(), $database, $notificationsDatabase);
 
-        // initialise a database transaction
-        if (!$database->beginTransaction()) {
-            throw new Exception('Failed to start transaction on primary database.');
-        }
+		// initialise a database transaction
+		if (!$database->beginTransaction()) {
+			throw new Exception('Failed to start transaction on primary database.');
+		}
 
-        try {
-            // run the task
-            $this->consoleTask->execute();
+		try {
+			// run the task
+			$this->consoleTask->execute();
 
-            if ($database->hasActiveTransaction()) {
-                $database->commit();
-            }
-        }
-        finally {
-            // Catch any hanging on transactions
-            if ($database->hasActiveTransaction()) {
-                $database->rollBack();
-            }
-        }
-    }
+			if ($database->hasActiveTransaction()) {
+				$database->commit();
+			}
+		}
+		finally {
+			// Catch any hanging on transactions
+			if ($database->hasActiveTransaction()) {
+				$database->rollBack();
+			}
+		}
+	}
 }
\ No newline at end of file

includes/ConsoleTasks/RefreshOAuthDataTask.php

Indentation +31 added lines, -31 removed lines

@@ -17,35 +17,35 @@
 
 class RefreshOAuthDataTask extends ConsoleTaskBase
 {
-    public function execute()
-    {
-        $database = $this->getDatabase();
-
-        $idList = $database
-            ->query('SELECT user FROM oauthtoken WHERE type = \'access\' AND expiry IS NULL')
-            ->fetchAll(PDO::FETCH_COLUMN);
-
-        if (count($idList) > 0) {
-            /** @var User[] $users */
-            $users = UserSearchHelper::get($database)->inIds($idList)->fetch();
-
-            $expiredStatement = $database
-                ->prepare('UPDATE oauthtoken SET expiry = CURRENT_TIMESTAMP() WHERE user = :u AND type = \'access\'');
-
-            foreach ($users as $u) {
-                $oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(),
-                    $this->getSiteConfiguration());
-
-                try {
-                    $oauth->refreshIdentity();
-                }
-                catch (OAuthException $ex) {
-                    $expiredStatement->execute(array(':u' => $u->getId()));
-                }
-            }
-        }
-
-        $this->getDatabase()
-            ->exec('DELETE FROM oauthtoken WHERE expiry IS NOT NULL AND expiry < NOW() AND type = \'request\'');
-    }
+	public function execute()
+	{
+		$database = $this->getDatabase();
+
+		$idList = $database
+			->query('SELECT user FROM oauthtoken WHERE type = \'access\' AND expiry IS NULL')
+			->fetchAll(PDO::FETCH_COLUMN);
+
+		if (count($idList) > 0) {
+			/** @var User[] $users */
+			$users = UserSearchHelper::get($database)->inIds($idList)->fetch();
+
+			$expiredStatement = $database
+				->prepare('UPDATE oauthtoken SET expiry = CURRENT_TIMESTAMP() WHERE user = :u AND type = \'access\'');
+
+			foreach ($users as $u) {
+				$oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(),
+					$this->getSiteConfiguration());
+
+				try {
+					$oauth->refreshIdentity();
+				}
+				catch (OAuthException $ex) {
+					$expiredStatement->execute(array(':u' => $u->getId()));
+				}
+			}
+		}
+
+		$this->getDatabase()
+			->exec('DELETE FROM oauthtoken WHERE expiry IS NOT NULL AND expiry < NOW() AND type = \'request\'');
+	}
 }
\ No newline at end of file

includes/ConsoleTasks/ClearOAuthDataTask.php

Indentation +12 added lines, -12 removed lines

@@ -14,19 +14,19 @@
 
 class ClearOAuthDataTask extends ConsoleTaskBase
 {
-    public function execute()
-    {
-        $database = $this->getDatabase();
+	public function execute()
+	{
+		$database = $this->getDatabase();
 
-        $users = UserSearchHelper::get($database)->inIds(
-            $database->query('SELECT user FROM oauthtoken WHERE type = \'access\'')->fetchColumn());
+		$users = UserSearchHelper::get($database)->inIds(
+			$database->query('SELECT user FROM oauthtoken WHERE type = \'access\'')->fetchColumn());
 
-        foreach ($users as $u){
-            $oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
-            $oauth->detach();
-        }
+		foreach ($users as $u){
+			$oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
+			$oauth->detach();
+		}
 
-        $database->exec('DELETE FROM oauthtoken');
-        $database->exec('DELETE FROM oauthidentity');
-    }
+		$database->exec('DELETE FROM oauthtoken');
+		$database->exec('DELETE FROM oauthidentity');
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
         $users = UserSearchHelper::get($database)->inIds(
             $database->query('SELECT user FROM oauthtoken WHERE type = \'access\'')->fetchColumn());
 
-        foreach ($users as $u){
+        foreach ($users as $u) {
             $oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
             $oauth->detach();
         }

Braces +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
         $users = UserSearchHelper::get($database)->inIds(
             $database->query('SELECT user FROM oauthtoken WHERE type = \'access\'')->fetchColumn());
 
-        foreach ($users as $u){
+        foreach ($users as $u) {
             $oauth = new OAuthUserHelper($u, $database, $this->getOAuthProtocolHelper(), $this->getSiteConfiguration());
             $oauth->detach();
         }