enwikipedia-acc / waca

includes/Fragments/RequestData.php

Indentation +320 added lines, -320 removed lines

@@ -24,324 +24,324 @@
 
 trait RequestData
 {
-    /**
-     * @var array Array of IP address classed as 'private' by RFC1918.
-     */
-    protected static $rfc1918ips = array(
-        "10.0.0.0"    => "10.255.255.255",
-        "172.16.0.0"  => "172.31.255.255",
-        "192.168.0.0" => "192.168.255.255",
-        "169.254.0.0" => "169.254.255.255",
-        "127.0.0.0"   => "127.255.255.255",
-    );
-
-    /**
-     * Gets a request object
-     *
-     * @param PdoDatabase $database  The database connection
-     * @param int         $requestId The ID of the request to retrieve
-     *
-     * @return Request
-     * @throws ApplicationLogicException
-     */
-    protected function getRequest(PdoDatabase $database, $requestId)
-    {
-        if ($requestId === null) {
-            throw new ApplicationLogicException("No request specified");
-        }
-
-        $request = Request::getById($requestId, $database);
-        if ($request === false || !is_a($request, Request::class)) {
-            throw new ApplicationLogicException('Could not load the requested request!');
-        }
-
-        return $request;
-    }
-
-    /**
-     * Returns a value stating whether the user is allowed to see private data or not
-     *
-     * @param Request $request
-     * @param User    $currentUser
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    protected function isAllowedPrivateData(Request $request, User $currentUser)
-    {
-        // Test the main security barrier for private data access using SecurityManager
-        if ($this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
-            // Tool admins/check-users can always see private data
-            return true;
-        }
-
-        // reserving user is allowed to see the data
-        if ($currentUser->getId() === $request->getReserved()
-            && $request->getReserved() !== null
-            && $this->barrierTest('seePrivateDataWhenReserved', $currentUser, 'RequestData')
-        ) {
-            return true;
-        }
-
-        // user has the reveal hash
-        if (WebRequest::getString('hash') === $request->getRevealHash()
-            && $this->barrierTest('seePrivateDataWithHash', $currentUser, 'RequestData')
-        ) {
-            return true;
-        }
-
-        // nope. Not allowed.
-        return false;
-    }
-
-    /**
-     * Tests the security barrier for a specified action.
-     *
-     * Don't use within templates
-     *
-     * @param string      $action
-     *
-     * @param User        $user
-     * @param null|string $pageName
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    abstract protected function barrierTest($action, User $user, $pageName = null);
-
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    abstract protected function getRouteName();
-
-    /** @return SecurityManager */
-    abstract protected function getSecurityManager();
-
-    /**
-     * Sets the name of the template this page should display.
-     *
-     * @param string $name
-     */
-    abstract protected function setTemplate($name);
-
-    /** @return IXffTrustProvider */
-    abstract protected function getXffTrustProvider();
-
-    /** @return ILocationProvider */
-    abstract protected function getLocationProvider();
-
-    /** @return IRDnsProvider */
-    abstract protected function getRdnsProvider();
-
-    /**
-     * Assigns a Smarty variable
-     *
-     * @param  array|string $name  the template variable name(s)
-     * @param  mixed        $value the value to assign
-     */
-    abstract protected function assign($name, $value);
-
-    /**
-     * @param int         $requestReservationId
-     * @param PdoDatabase $database
-     * @param User        $currentUser
-     */
-    protected function setupReservationDetails($requestReservationId, PdoDatabase $database, User $currentUser)
-    {
-        $requestIsReserved = $requestReservationId !== null;
-        $this->assign('requestIsReserved', $requestIsReserved);
-        $this->assign('requestIsReservedByMe', false);
-
-        if ($requestIsReserved) {
-            $this->assign('requestReservedByName', User::getById($requestReservationId, $database)->getUsername());
-            $this->assign('requestReservedById', $requestReservationId);
-
-            if ($requestReservationId === $currentUser->getId()) {
-                $this->assign('requestIsReservedByMe', true);
-            }
-        }
-
-        $this->assign('canBreakReservation', $this->barrierTest('force', $currentUser, PageBreakReservation::class));
-    }
-
-    /**
-     * Adds private request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
-     *
-     * @param Request           $request
-     * @param User              $currentUser
-     * @param SiteConfiguration $configuration
-     *
-     * @param PdoDatabase       $database
-     */
-    protected function setupPrivateData(
-        $request,
-        User $currentUser,
-        SiteConfiguration $configuration,
-        PdoDatabase $database
-    ) {
-        $xffProvider = $this->getXffTrustProvider();
-
-        $relatedEmailRequests = RequestSearchHelper::get($database)
-            ->byEmailAddress($request->getEmail())
-            ->withConfirmedEmail()
-            ->excludingPurgedData($configuration)
-            ->excludingRequest($request->getId())
-            ->fetch();
-
-        $this->assign('requestEmail', $request->getEmail());
-        $emailDomain = explode("@", $request->getEmail())[1];
-        $this->assign("emailurl", $emailDomain);
-        $this->assign('requestRelatedEmailRequestsCount', count($relatedEmailRequests));
-        $this->assign('requestRelatedEmailRequests', $relatedEmailRequests);
-
-        $trustedIp = $xffProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
-        $this->assign('requestTrustedIp', $trustedIp);
-        $this->assign('requestRealIp', $request->getIp());
-        $this->assign('requestForwardedIp', $request->getForwardedIp());
-
-        $trustedIpLocation = $this->getLocationProvider()->getIpLocation($trustedIp);
-        $this->assign('requestTrustedIpLocation', $trustedIpLocation);
-
-        $this->assign('requestHasForwardedIp', $request->getForwardedIp() !== null);
-
-        $relatedIpRequests = RequestSearchHelper::get($database)
-            ->byIp($trustedIp)
-            ->withConfirmedEmail()
-            ->excludingPurgedData($configuration)
-            ->excludingRequest($request->getId())
-            ->fetch();
-
-        $this->assign('requestRelatedIpRequestsCount', count($relatedIpRequests));
-        $this->assign('requestRelatedIpRequests', $relatedIpRequests);
-
-        $this->assign('showRevealLink', false);
-        if ($request->getReserved() === $currentUser->getId() ||
-            $this->barrierTest('alwaysSeeHash', $currentUser, 'RequestData')
-        ) {
-            $this->assign('showRevealLink', true);
-            $this->assign('revealHash', $request->getRevealHash());
-        }
-
-        $this->setupForwardedIpData($request);
-    }
-
-    /**
-     * Adds checkuser request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
-     *
-     * @param Request $request
-     */
-    protected function setupCheckUserData(Request $request)
-    {
-        $this->assign('requestUserAgent', $request->getUserAgent());
-    }
-
-    /**
-     * Sets up the basic data for this request, and adds it to Smarty
-     *
-     * @param Request           $request
-     * @param SiteConfiguration $config
-     */
-    protected function setupBasicData(Request $request, SiteConfiguration $config)
-    {
-        $this->assign('requestId', $request->getId());
-        $this->assign('updateVersion', $request->getUpdateVersion());
-        $this->assign('requestName', $request->getName());
-        $this->assign('requestDate', $request->getDate());
-        $this->assign('requestStatus', $request->getStatus());
-
-        $isClosed = !array_key_exists($request->getStatus(), $config->getRequestStates())
-            && $request->getStatus() !== RequestStatus::HOSPITAL;
-        $this->assign('requestIsClosed', $isClosed);
-    }
-
-    /**
-     * Sets up the forwarded IP data for this request and adds it to Smarty
-     *
-     * @param Request $request
-     */
-    protected function setupForwardedIpData(Request $request)
-    {
-        if ($request->getForwardedIp() !== null) {
-            $requestProxyData = array(); // Initialize array to store data to be output in Smarty template.
-            $proxyIndex = 0;
-
-            // Assuming [client] <=> [proxy1] <=> [proxy2] <=> [proxy3] <=> [us], we will see an XFF header of [client],
-            // [proxy1], [proxy2], and our actual IP will be [proxy3]
-            $proxies = explode(",", $request->getForwardedIp());
-            $proxies[] = $request->getIp();
-
-            // Origin is the supposed "client" IP.
-            $origin = $proxies[0];
-            $this->assign("forwardedOrigin", $origin);
-
-            // We step through the servers in reverse order, from closest to furthest
-            $proxies = array_reverse($proxies);
-
-            // By default, we have trust, because the first in the chain is now REMOTE_ADDR, which is hardest to spoof.
-            $trust = true;
-
-            /**
-             * @var int    $index     The zero-based index of the proxy.
-             * @var string $proxyData The proxy IP address (although possibly not!)
-             */
-            foreach ($proxies as $index => $proxyData) {
-                $proxyAddress = trim($proxyData);
-                $requestProxyData[$proxyIndex]['ip'] = $proxyAddress;
-
-                // get data on this IP.
-                $thisProxyIsTrusted = $this->getXffTrustProvider()->isTrusted($proxyAddress);
-
-                $proxyIsInPrivateRange = $this->getXffTrustProvider()
-                    ->ipInRange(self::$rfc1918ips, $proxyAddress);
-
-                if (!$proxyIsInPrivateRange) {
-                    $proxyReverseDns = $this->getRdnsProvider()->getReverseDNS($proxyAddress);
-                    $proxyLocation = $this->getLocationProvider()->getIpLocation($proxyAddress);
-                }
-                else {
-                    // this is going to fail, so why bother trying?
-                    $proxyReverseDns = false;
-                    $proxyLocation = false;
-                }
-
-                // current trust chain status BEFORE this link
-                $preLinkTrust = $trust;
-
-                // is *this* link trusted? Note, this will be true even if there is an untrusted link before this!
-                $requestProxyData[$proxyIndex]['trustedlink'] = $thisProxyIsTrusted;
-
-                // set the trust status of the chain to this point
-                $trust = $trust & $thisProxyIsTrusted;
-
-                // If this is the origin address, and the chain was trusted before this point, then we can trust
-                // the origin.
-                if ($preLinkTrust && $proxyAddress == $origin) {
-                    // if this is the origin, then we are at the last point in the chain.
-                    // @todo: this is probably the cause of some bugs when an IP appears twice - we're missing a check
-                    // to see if this is *really* the last in the chain, rather than just the same IP as it.
-                    $trust = true;
-                }
-
-                $requestProxyData[$proxyIndex]['trust'] = $trust;
-
-                $requestProxyData[$proxyIndex]['rdnsfailed'] = $proxyReverseDns === false;
-                $requestProxyData[$proxyIndex]['rdns'] = $proxyReverseDns;
-                $requestProxyData[$proxyIndex]['routable'] = !$proxyIsInPrivateRange;
-
-                $requestProxyData[$proxyIndex]['location'] = $proxyLocation;
-
-                if ($proxyReverseDns === $proxyAddress && $proxyIsInPrivateRange === false) {
-                    $requestProxyData[$proxyIndex]['rdns'] = null;
-                }
-
-                $showLinks = (!$trust || $proxyAddress == $origin) && !$proxyIsInPrivateRange;
-                $requestProxyData[$proxyIndex]['showlinks'] = $showLinks;
-
-                $proxyIndex++;
-            }
-
-            $this->assign("requestProxyData", $requestProxyData);
-        }
-    }
+	/**
+	 * @var array Array of IP address classed as 'private' by RFC1918.
+	 */
+	protected static $rfc1918ips = array(
+		"10.0.0.0"    => "10.255.255.255",
+		"172.16.0.0"  => "172.31.255.255",
+		"192.168.0.0" => "192.168.255.255",
+		"169.254.0.0" => "169.254.255.255",
+		"127.0.0.0"   => "127.255.255.255",
+	);
+
+	/**
+	 * Gets a request object
+	 *
+	 * @param PdoDatabase $database  The database connection
+	 * @param int         $requestId The ID of the request to retrieve
+	 *
+	 * @return Request
+	 * @throws ApplicationLogicException
+	 */
+	protected function getRequest(PdoDatabase $database, $requestId)
+	{
+		if ($requestId === null) {
+			throw new ApplicationLogicException("No request specified");
+		}
+
+		$request = Request::getById($requestId, $database);
+		if ($request === false || !is_a($request, Request::class)) {
+			throw new ApplicationLogicException('Could not load the requested request!');
+		}
+
+		return $request;
+	}
+
+	/**
+	 * Returns a value stating whether the user is allowed to see private data or not
+	 *
+	 * @param Request $request
+	 * @param User    $currentUser
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	protected function isAllowedPrivateData(Request $request, User $currentUser)
+	{
+		// Test the main security barrier for private data access using SecurityManager
+		if ($this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
+			// Tool admins/check-users can always see private data
+			return true;
+		}
+
+		// reserving user is allowed to see the data
+		if ($currentUser->getId() === $request->getReserved()
+			&& $request->getReserved() !== null
+			&& $this->barrierTest('seePrivateDataWhenReserved', $currentUser, 'RequestData')
+		) {
+			return true;
+		}
+
+		// user has the reveal hash
+		if (WebRequest::getString('hash') === $request->getRevealHash()
+			&& $this->barrierTest('seePrivateDataWithHash', $currentUser, 'RequestData')
+		) {
+			return true;
+		}
+
+		// nope. Not allowed.
+		return false;
+	}
+
+	/**
+	 * Tests the security barrier for a specified action.
+	 *
+	 * Don't use within templates
+	 *
+	 * @param string      $action
+	 *
+	 * @param User        $user
+	 * @param null|string $pageName
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	abstract protected function barrierTest($action, User $user, $pageName = null);
+
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	abstract protected function getRouteName();
+
+	/** @return SecurityManager */
+	abstract protected function getSecurityManager();
+
+	/**
+	 * Sets the name of the template this page should display.
+	 *
+	 * @param string $name
+	 */
+	abstract protected function setTemplate($name);
+
+	/** @return IXffTrustProvider */
+	abstract protected function getXffTrustProvider();
+
+	/** @return ILocationProvider */
+	abstract protected function getLocationProvider();
+
+	/** @return IRDnsProvider */
+	abstract protected function getRdnsProvider();
+
+	/**
+	 * Assigns a Smarty variable
+	 *
+	 * @param  array|string $name  the template variable name(s)
+	 * @param  mixed        $value the value to assign
+	 */
+	abstract protected function assign($name, $value);
+
+	/**
+	 * @param int         $requestReservationId
+	 * @param PdoDatabase $database
+	 * @param User        $currentUser
+	 */
+	protected function setupReservationDetails($requestReservationId, PdoDatabase $database, User $currentUser)
+	{
+		$requestIsReserved = $requestReservationId !== null;
+		$this->assign('requestIsReserved', $requestIsReserved);
+		$this->assign('requestIsReservedByMe', false);
+
+		if ($requestIsReserved) {
+			$this->assign('requestReservedByName', User::getById($requestReservationId, $database)->getUsername());
+			$this->assign('requestReservedById', $requestReservationId);
+
+			if ($requestReservationId === $currentUser->getId()) {
+				$this->assign('requestIsReservedByMe', true);
+			}
+		}
+
+		$this->assign('canBreakReservation', $this->barrierTest('force', $currentUser, PageBreakReservation::class));
+	}
+
+	/**
+	 * Adds private request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
+	 *
+	 * @param Request           $request
+	 * @param User              $currentUser
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @param PdoDatabase       $database
+	 */
+	protected function setupPrivateData(
+		$request,
+		User $currentUser,
+		SiteConfiguration $configuration,
+		PdoDatabase $database
+	) {
+		$xffProvider = $this->getXffTrustProvider();
+
+		$relatedEmailRequests = RequestSearchHelper::get($database)
+			->byEmailAddress($request->getEmail())
+			->withConfirmedEmail()
+			->excludingPurgedData($configuration)
+			->excludingRequest($request->getId())
+			->fetch();
+
+		$this->assign('requestEmail', $request->getEmail());
+		$emailDomain = explode("@", $request->getEmail())[1];
+		$this->assign("emailurl", $emailDomain);
+		$this->assign('requestRelatedEmailRequestsCount', count($relatedEmailRequests));
+		$this->assign('requestRelatedEmailRequests', $relatedEmailRequests);
+
+		$trustedIp = $xffProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
+		$this->assign('requestTrustedIp', $trustedIp);
+		$this->assign('requestRealIp', $request->getIp());
+		$this->assign('requestForwardedIp', $request->getForwardedIp());
+
+		$trustedIpLocation = $this->getLocationProvider()->getIpLocation($trustedIp);
+		$this->assign('requestTrustedIpLocation', $trustedIpLocation);
+
+		$this->assign('requestHasForwardedIp', $request->getForwardedIp() !== null);
+
+		$relatedIpRequests = RequestSearchHelper::get($database)
+			->byIp($trustedIp)
+			->withConfirmedEmail()
+			->excludingPurgedData($configuration)
+			->excludingRequest($request->getId())
+			->fetch();
+
+		$this->assign('requestRelatedIpRequestsCount', count($relatedIpRequests));
+		$this->assign('requestRelatedIpRequests', $relatedIpRequests);
+
+		$this->assign('showRevealLink', false);
+		if ($request->getReserved() === $currentUser->getId() ||
+			$this->barrierTest('alwaysSeeHash', $currentUser, 'RequestData')
+		) {
+			$this->assign('showRevealLink', true);
+			$this->assign('revealHash', $request->getRevealHash());
+		}
+
+		$this->setupForwardedIpData($request);
+	}
+
+	/**
+	 * Adds checkuser request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
+	 *
+	 * @param Request $request
+	 */
+	protected function setupCheckUserData(Request $request)
+	{
+		$this->assign('requestUserAgent', $request->getUserAgent());
+	}
+
+	/**
+	 * Sets up the basic data for this request, and adds it to Smarty
+	 *
+	 * @param Request           $request
+	 * @param SiteConfiguration $config
+	 */
+	protected function setupBasicData(Request $request, SiteConfiguration $config)
+	{
+		$this->assign('requestId', $request->getId());
+		$this->assign('updateVersion', $request->getUpdateVersion());
+		$this->assign('requestName', $request->getName());
+		$this->assign('requestDate', $request->getDate());
+		$this->assign('requestStatus', $request->getStatus());
+
+		$isClosed = !array_key_exists($request->getStatus(), $config->getRequestStates())
+			&& $request->getStatus() !== RequestStatus::HOSPITAL;
+		$this->assign('requestIsClosed', $isClosed);
+	}
+
+	/**
+	 * Sets up the forwarded IP data for this request and adds it to Smarty
+	 *
+	 * @param Request $request
+	 */
+	protected function setupForwardedIpData(Request $request)
+	{
+		if ($request->getForwardedIp() !== null) {
+			$requestProxyData = array(); // Initialize array to store data to be output in Smarty template.
+			$proxyIndex = 0;
+
+			// Assuming [client] <=> [proxy1] <=> [proxy2] <=> [proxy3] <=> [us], we will see an XFF header of [client],
+			// [proxy1], [proxy2], and our actual IP will be [proxy3]
+			$proxies = explode(",", $request->getForwardedIp());
+			$proxies[] = $request->getIp();
+
+			// Origin is the supposed "client" IP.
+			$origin = $proxies[0];
+			$this->assign("forwardedOrigin", $origin);
+
+			// We step through the servers in reverse order, from closest to furthest
+			$proxies = array_reverse($proxies);
+
+			// By default, we have trust, because the first in the chain is now REMOTE_ADDR, which is hardest to spoof.
+			$trust = true;
+
+			/**
+			 * @var int    $index     The zero-based index of the proxy.
+			 * @var string $proxyData The proxy IP address (although possibly not!)
+			 */
+			foreach ($proxies as $index => $proxyData) {
+				$proxyAddress = trim($proxyData);
+				$requestProxyData[$proxyIndex]['ip'] = $proxyAddress;
+
+				// get data on this IP.
+				$thisProxyIsTrusted = $this->getXffTrustProvider()->isTrusted($proxyAddress);
+
+				$proxyIsInPrivateRange = $this->getXffTrustProvider()
+					->ipInRange(self::$rfc1918ips, $proxyAddress);
+
+				if (!$proxyIsInPrivateRange) {
+					$proxyReverseDns = $this->getRdnsProvider()->getReverseDNS($proxyAddress);
+					$proxyLocation = $this->getLocationProvider()->getIpLocation($proxyAddress);
+				}
+				else {
+					// this is going to fail, so why bother trying?
+					$proxyReverseDns = false;
+					$proxyLocation = false;
+				}
+
+				// current trust chain status BEFORE this link
+				$preLinkTrust = $trust;
+
+				// is *this* link trusted? Note, this will be true even if there is an untrusted link before this!
+				$requestProxyData[$proxyIndex]['trustedlink'] = $thisProxyIsTrusted;
+
+				// set the trust status of the chain to this point
+				$trust = $trust & $thisProxyIsTrusted;
+
+				// If this is the origin address, and the chain was trusted before this point, then we can trust
+				// the origin.
+				if ($preLinkTrust && $proxyAddress == $origin) {
+					// if this is the origin, then we are at the last point in the chain.
+					// @todo: this is probably the cause of some bugs when an IP appears twice - we're missing a check
+					// to see if this is *really* the last in the chain, rather than just the same IP as it.
+					$trust = true;
+				}
+
+				$requestProxyData[$proxyIndex]['trust'] = $trust;
+
+				$requestProxyData[$proxyIndex]['rdnsfailed'] = $proxyReverseDns === false;
+				$requestProxyData[$proxyIndex]['rdns'] = $proxyReverseDns;
+				$requestProxyData[$proxyIndex]['routable'] = !$proxyIsInPrivateRange;
+
+				$requestProxyData[$proxyIndex]['location'] = $proxyLocation;
+
+				if ($proxyReverseDns === $proxyAddress && $proxyIsInPrivateRange === false) {
+					$requestProxyData[$proxyIndex]['rdns'] = null;
+				}
+
+				$showLinks = (!$trust || $proxyAddress == $origin) && !$proxyIsInPrivateRange;
+				$requestProxyData[$proxyIndex]['showlinks'] = $showLinks;
+
+				$proxyIndex++;
+			}
+
+			$this->assign("requestProxyData", $requestProxyData);
+		}
+	}
 }

includes/Router/OAuthRequestRouter.php

Indentation +5 added lines, -5 removed lines

@@ -17,9 +17,9 @@
  */
 class OAuthRequestRouter extends RequestRouter
 {
-    protected function getRouteFromPath($pathInfo)
-    {
-        // Hardcode the route for this entry point
-        return array(PageOAuthCallback::class, 'authorise');
-    }
+	protected function getRouteFromPath($pathInfo)
+	{
+		// Hardcode the route for this entry point
+		return array(PageOAuthCallback::class, 'authorise');
+	}
 }
\ No newline at end of file

includes/Tasks/PagedInternalPageBase.php

Indentation +93 added lines, -93 removed lines

@@ -13,97 +13,97 @@
 
 abstract class PagedInternalPageBase extends InternalPageBase
 {
-    /** @var SearchHelperBase */
-    private $searchHelper;
-    private $page;
-    private $limit;
-
-    /**
-     * Sets up the pager with the current page, current limit, and total number of records.
-     *
-     * @param int   $count
-     * @param array $formParameters
-     */
-    protected function setupPageData($count, $formParameters)
-    {
-        $page = $this->page;
-        $limit = $this->limit;
-
-        // The number of pages on the pager to show. Must be odd
-        $pageLimit = 9;
-
-        $pageData = array(
-            // Can the user go to the previous page?
-            'canprev'   => $page != 1,
-            // Can the user go to the next page?
-            'cannext'   => ($page * $limit) < $count,
-            // Maximum page number
-            'maxpage'   => ceil($count / $limit),
-            // Limit to the number of pages to display
-            'pagelimit' => $pageLimit,
-        );
-
-        // number of pages either side of the current to show
-        $pageMargin = (($pageLimit - 1) / 2);
-
-        // Calculate the number of pages either side to show - this is for situations like:
-        //  [1]  [2] [[3]] [4]  [5]  [6]  [7]  [8]  [9] - where you can't just use the page margin calculated
-        $pageData['lowpage'] = max(1, $page - $pageMargin);
-        $pageData['hipage'] = min($pageData['maxpage'], $page + $pageMargin);
-        $pageCount = ($pageData['hipage'] - $pageData['lowpage']) + 1;
-
-        if ($pageCount < $pageLimit) {
-            if ($pageData['lowpage'] == 1 && $pageData['hipage'] < $pageData['maxpage']) {
-                $pageData['hipage'] = min($pageLimit, $pageData['maxpage']);
-            }
-            elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
-                $pageData['lowpage'] = max(1, $pageData['maxpage'] - $pageLimit + 1);
-            }
-        }
-
-        // Put the range of pages into the page data
-        $pageData['pages'] = range($pageData['lowpage'], $pageData['hipage']);
-
-        $this->assign("pagedata", $pageData);
-
-        $this->assign("limit", $limit);
-        $this->assign("page", $page);
-
-        $this->setupFormParameters($formParameters);
-    }
-
-    protected function setSearchHelper(SearchHelperBase $searchHelper)
-    {
-        $this->searchHelper = $searchHelper;
-    }
-
-    protected function setupLimits()
-    {
-        $limit = WebRequest::getInt('limit');
-        if ($limit === null) {
-            $limit = 100;
-        }
-
-        $page = WebRequest::getInt('page');
-        if ($page === null) {
-            $page = 1;
-        }
-
-        $offset = ($page - 1) * $limit;
-
-        $this->searchHelper->limit($limit, $offset);
-
-        $this->page = $page;
-        $this->limit = $limit;
-    }
-
-    private function setupFormParameters($formParameters)
-    {
-        $formParameters['limit'] = $this->limit;
-        $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&amp;'));
-
-        foreach ($formParameters as $key => $value)  {
-            $this->assign($key, $value);
-        }
-    }
+	/** @var SearchHelperBase */
+	private $searchHelper;
+	private $page;
+	private $limit;
+
+	/**
+	 * Sets up the pager with the current page, current limit, and total number of records.
+	 *
+	 * @param int   $count
+	 * @param array $formParameters
+	 */
+	protected function setupPageData($count, $formParameters)
+	{
+		$page = $this->page;
+		$limit = $this->limit;
+
+		// The number of pages on the pager to show. Must be odd
+		$pageLimit = 9;
+
+		$pageData = array(
+			// Can the user go to the previous page?
+			'canprev'   => $page != 1,
+			// Can the user go to the next page?
+			'cannext'   => ($page * $limit) < $count,
+			// Maximum page number
+			'maxpage'   => ceil($count / $limit),
+			// Limit to the number of pages to display
+			'pagelimit' => $pageLimit,
+		);
+
+		// number of pages either side of the current to show
+		$pageMargin = (($pageLimit - 1) / 2);
+
+		// Calculate the number of pages either side to show - this is for situations like:
+		//  [1]  [2] [[3]] [4]  [5]  [6]  [7]  [8]  [9] - where you can't just use the page margin calculated
+		$pageData['lowpage'] = max(1, $page - $pageMargin);
+		$pageData['hipage'] = min($pageData['maxpage'], $page + $pageMargin);
+		$pageCount = ($pageData['hipage'] - $pageData['lowpage']) + 1;
+
+		if ($pageCount < $pageLimit) {
+			if ($pageData['lowpage'] == 1 && $pageData['hipage'] < $pageData['maxpage']) {
+				$pageData['hipage'] = min($pageLimit, $pageData['maxpage']);
+			}
+			elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
+				$pageData['lowpage'] = max(1, $pageData['maxpage'] - $pageLimit + 1);
+			}
+		}
+
+		// Put the range of pages into the page data
+		$pageData['pages'] = range($pageData['lowpage'], $pageData['hipage']);
+
+		$this->assign("pagedata", $pageData);
+
+		$this->assign("limit", $limit);
+		$this->assign("page", $page);
+
+		$this->setupFormParameters($formParameters);
+	}
+
+	protected function setSearchHelper(SearchHelperBase $searchHelper)
+	{
+		$this->searchHelper = $searchHelper;
+	}
+
+	protected function setupLimits()
+	{
+		$limit = WebRequest::getInt('limit');
+		if ($limit === null) {
+			$limit = 100;
+		}
+
+		$page = WebRequest::getInt('page');
+		if ($page === null) {
+			$page = 1;
+		}
+
+		$offset = ($page - 1) * $limit;
+
+		$this->searchHelper->limit($limit, $offset);
+
+		$this->page = $page;
+		$this->limit = $limit;
+	}
+
+	private function setupFormParameters($formParameters)
+	{
+		$formParameters['limit'] = $this->limit;
+		$this->assign('searchParamsUrl', http_build_query($formParameters, '', '&amp;'));
+
+		foreach ($formParameters as $key => $value)  {
+			$this->assign($key, $value);
+		}
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
         $formParameters['limit'] = $this->limit;
         $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&'));
 
-        foreach ($formParameters as $key => $value)  {
+        foreach ($formParameters as $key => $value) {
             $this->assign($key, $value);
         }
     }

Braces +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
         $formParameters['limit'] = $this->limit;
         $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&'));
 
-        foreach ($formParameters as $key => $value)  {
+        foreach ($formParameters as $key => $value) {
             $this->assign($key, $value);
         }
     }

includes/Tasks/ITask.php

Indentation +145 added lines, -145 removed lines

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

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

Indentation +137 added lines, -137 removed lines

@@ -14,42 +14,42 @@ 
 
 class OAuthToken extends DataObject
 {
-    /** @var int */
-    private $user;
-    /** @var string */
-    private $token;
-    /** @var string */
-    private $secret;
-    /** @var string */
-    private $type;
-    /** @var string */
-    private $expiry;
-
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	/** @var int */
+	private $user;
+	/** @var string */
+	private $token;
+	/** @var string */
+	private $secret;
+	/** @var string */
+	private $type;
+	/** @var string */
+	private $expiry;
+
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO oauthtoken ( user, token, secret, type, expiry )
                 VALUES ( :user, :token, :secret, :type, :expiry );
 SQL
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":token", $this->token);
-            $statement->bindValue(":secret", $this->secret);
-            $statement->bindValue(":type", $this->type);
-            $statement->bindValue(":expiry", $this->expiry);
-
-            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(":token", $this->token);
+			$statement->bindValue(":secret", $this->secret);
+			$statement->bindValue(":type", $this->type);
+			$statement->bindValue(":expiry", $this->expiry);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE oauthtoken
                 SET   token = :token
                     , secret = :secret
@@ -58,109 +58,109 @@ 
                     , updateversion = updateversion + 1
                 WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(":token", $this->token);
-            $statement->bindValue(":secret", $this->secret);
-            $statement->bindValue(":type", $this->type);
-            $statement->bindValue(":expiry", $this->expiry);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    #region properties
-
-    /**
-     * @return mixed
-     */
-    public function getUserId()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param mixed $user
-     */
-    public function setUserId($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getToken()
-    {
-        return $this->token;
-    }
-
-    /**
-     * @param mixed $token
-     */
-    public function setToken($token)
-    {
-        $this->token = $token;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getSecret()
-    {
-        return $this->secret;
-    }
-
-    /**
-     * @param mixed $secret
-     */
-    public function setSecret($secret)
-    {
-        $this->secret = $secret;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getType()
-    {
-        return $this->type;
-    }
-
-    /**
-     * @param mixed $type
-     */
-    public function setType($type)
-    {
-        $this->type = $type;
-    }
-
-    /**
-     * @return string
-     */
-    public function getExpiry()
-    {
-        return $this->expiry;
-    }
-
-    /**
-     * @param string $expiry
-     */
-    public function setExpiry($expiry)
-    {
-        $this->expiry = $expiry;
-    }
-    #endregion
+			);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(":token", $this->token);
+			$statement->bindValue(":secret", $this->secret);
+			$statement->bindValue(":type", $this->type);
+			$statement->bindValue(":expiry", $this->expiry);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	#region properties
+
+	/**
+	 * @return mixed
+	 */
+	public function getUserId()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param mixed $user
+	 */
+	public function setUserId($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getToken()
+	{
+		return $this->token;
+	}
+
+	/**
+	 * @param mixed $token
+	 */
+	public function setToken($token)
+	{
+		$this->token = $token;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getSecret()
+	{
+		return $this->secret;
+	}
+
+	/**
+	 * @param mixed $secret
+	 */
+	public function setSecret($secret)
+	{
+		$this->secret = $secret;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getType()
+	{
+		return $this->type;
+	}
+
+	/**
+	 * @param mixed $type
+	 */
+	public function setType($type)
+	{
+		$this->type = $type;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getExpiry()
+	{
+		return $this->expiry;
+	}
+
+	/**
+	 * @param string $expiry
+	 */
+	public function setExpiry($expiry)
+	{
+		$this->expiry = $expiry;
+	}
+	#endregion
 
 }
\ No newline at end of file

includes/DataObjects/User.php

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);
     }
 
     /**

Indentation +569 added lines, -569 removed lines

@@ -21,160 +21,160 @@ 
  */
 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;
-    private $skin = "main";
-    /** @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;
+	private $skin = "main";
+	/** @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,
@@ -185,32 +185,32 @@ 
 					:welcome_template, :abortpref, :confirmationdiff, :emailsig, :creationmode, :skin
 				);
 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);
-            $statement->bindValue(":skin", $this->skin);
-
-            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);
+			$statement->bindValue(":skin", $this->skin);
+
+			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,
@@ -223,389 +223,389 @@ 
                     updateversion = updateversion + 1
 				WHERE id = :id AND updateversion = :updateversion;
 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);
-            $statement->bindValue(':skin', $this->skin);
-
-            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;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getUseAlternateSkin()
-    {
-        return $this->skin === 'alt';
-    }
-
-    /**
-     * @return string
-     */
-    public function getSkin()
-    {
-        return $this->skin;
-    }
-
-    /**
-     * @param $skin string
-     */
-    public function setSkin($skin)
-    {
-        $this->skin = $skin;
-    }
-
-    #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);
+			$statement->bindValue(':skin', $this->skin);
+
+			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;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getUseAlternateSkin()
+	{
+		return $this->skin === 'alt';
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSkin()
+	{
+		return $this->skin;
+	}
+
+	/**
+	 * @param $skin string
+	 */
+	public function setSkin($skin)
+	{
+		$this->skin = $skin;
+	}
+
+	#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
@@ -614,12 +614,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;
+	}
 }

includes/DataObjects/JobQueue.php

Indentation +253 added lines, -253 removed lines

@@ -17,7 +17,7 @@ 
 
 class JobQueue extends DataObject
 {
-    /*
+	/*
      * Status workflow is this:
      *
      * 1) Ready. The job has been added to the queue
@@ -26,78 +26,78 @@ 
      * 3) Complete / Failed. The job has been processed
      *
      */
-    const STATUS_READY = 'ready';
-    const STATUS_WAITING = 'waiting';
-    const STATUS_RUNNING = 'running';
-    const STATUS_COMPLETE = 'complete';
-    const STATUS_CANCELLED = 'cancelled';
-    const STATUS_FAILED = 'failed';
-    const STATUS_HELD = 'held';
-
-    /** @var string */
-    private $task;
-    /** @var int */
-    private $user;
-    /** @var int */
-    private $request;
-    /** @var int */
-    private $emailtemplate;
-    /** @var string */
-    private $status;
-    /** @var string */
-    private $enqueue;
-    /** @var string */
-    private $parameters;
-    /** @var string */
-    private $error;
-    /** @var int */
-    private $acknowledged;
-    /** @var int */
-    private $parent;
-
-    /**
-     * This feels like the least bad place to put this method.
-     */
-    public static function getTaskDescriptions() {
-        return array(
-            BotCreationTask::class  => 'Create account (via bot)',
-            UserCreationTask::class => 'Create account (via OAuth)',
-            WelcomeUserTask::class  => 'Welcome user',
-        );
-    }
-
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     * @return void
-     * @throws Exception
-     * @throws OptimisticLockFailedException
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	const STATUS_READY = 'ready';
+	const STATUS_WAITING = 'waiting';
+	const STATUS_RUNNING = 'running';
+	const STATUS_COMPLETE = 'complete';
+	const STATUS_CANCELLED = 'cancelled';
+	const STATUS_FAILED = 'failed';
+	const STATUS_HELD = 'held';
+
+	/** @var string */
+	private $task;
+	/** @var int */
+	private $user;
+	/** @var int */
+	private $request;
+	/** @var int */
+	private $emailtemplate;
+	/** @var string */
+	private $status;
+	/** @var string */
+	private $enqueue;
+	/** @var string */
+	private $parameters;
+	/** @var string */
+	private $error;
+	/** @var int */
+	private $acknowledged;
+	/** @var int */
+	private $parent;
+
+	/**
+	 * This feels like the least bad place to put this method.
+	 */
+	public static function getTaskDescriptions() {
+		return array(
+			BotCreationTask::class  => 'Create account (via bot)',
+			UserCreationTask::class => 'Create account (via OAuth)',
+			WelcomeUserTask::class  => 'Welcome user',
+		);
+	}
+
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 * @return void
+	 * @throws Exception
+	 * @throws OptimisticLockFailedException
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO jobqueue (task, user, request, emailtemplate, parameters, parent) 
                 VALUES (:task, :user, :request, :emailtemplate, :parameters, :parent)
 SQL
-            );
-            $statement->bindValue(":task", $this->task);
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":request", $this->request);
-            $statement->bindValue(":emailtemplate", $this->emailtemplate);
-            $statement->bindValue(":parameters", $this->parameters);
-            $statement->bindValue(":parent", $this->parent);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":task", $this->task);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":request", $this->request);
+			$statement->bindValue(":emailtemplate", $this->emailtemplate);
+			$statement->bindValue(":parameters", $this->parameters);
+			$statement->bindValue(":parent", $this->parent);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE jobqueue SET 
                       status = :status
                     , error = :error
@@ -105,187 +105,187 @@ 
                     , updateversion = updateversion + 1
                 WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-
-            $statement->bindValue(":id", $this->id);
-            $statement->bindValue(":updateversion", $this->updateversion);
-
-            $statement->bindValue(":status", $this->status);
-            $statement->bindValue(":error", $this->error);
-            $statement->bindValue(":ack", $this->acknowledged);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    #region Properties
-
-    /**
-     * @return string
-     */
-    public function getTask()
-    {
-        return $this->task;
-    }
-
-    /**
-     * @param string $task
-     */
-    public function setTask($task)
-    {
-        $this->task = $task;
-    }
-
-    /**
-     * @return int
-     */
-    public function getTriggerUserId()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user
-     */
-    public function setTriggerUserId($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return int
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @param int $request
-     */
-    public function setRequest($request)
-    {
-        $this->request = $request;
-    }
-
-    /**
-     * @return string
-     */
-    public function getStatus()
-    {
-        return $this->status;
-    }
-
-    /**
-     * @param string $status
-     */
-    public function setStatus($status)
-    {
-        $this->status = $status;
-    }
-
-    /**
-     * @return string
-     */
-    public function getEnqueue()
-    {
-        return $this->enqueue;
-    }
-
-    /**
-     * @param string $enqueue
-     */
-    public function setEnqueue($enqueue)
-    {
-        $this->enqueue = $enqueue;
-    }
-
-    /**
-     * @return string
-     */
-    public function getParameters()
-    {
-        return $this->parameters;
-    }
-
-    /**
-     * @param string $parameters
-     */
-    public function setParameters($parameters)
-    {
-        $this->parameters = $parameters;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getError()
-    {
-        return $this->error;
-    }
-
-    /**
-     * @param mixed $error
-     */
-    public function setError($error)
-    {
-        $this->error = $error;
-    }
-
-    /**
-     * @return int
-     */
-    public function getAcknowledged()
-    {
-        return $this->acknowledged;
-    }
-
-    /**
-     * @param int $acknowledged
-     */
-    public function setAcknowledged($acknowledged)
-    {
-        $this->acknowledged = $acknowledged;
-    }
-
-    /**
-     * @return int
-     */
-    public function getParent()
-    {
-        return $this->parent;
-    }
-
-    /**
-     * @param int $parent
-     */
-    public function setParent($parent)
-    {
-        $this->parent = $parent;
-    }
-
-    /**
-     * @return int
-     */
-    public function getEmailTemplate()
-    {
-        return $this->emailtemplate;
-    }
-
-    /**
-     * @param int $emailTemplate
-     */
-    public function setEmailTemplate($emailTemplate)
-    {
-        $this->emailtemplate = $emailTemplate;
-    }
-    #endregion
+			);
+
+			$statement->bindValue(":id", $this->id);
+			$statement->bindValue(":updateversion", $this->updateversion);
+
+			$statement->bindValue(":status", $this->status);
+			$statement->bindValue(":error", $this->error);
+			$statement->bindValue(":ack", $this->acknowledged);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	#region Properties
+
+	/**
+	 * @return string
+	 */
+	public function getTask()
+	{
+		return $this->task;
+	}
+
+	/**
+	 * @param string $task
+	 */
+	public function setTask($task)
+	{
+		$this->task = $task;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getTriggerUserId()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user
+	 */
+	public function setTriggerUserId($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @param int $request
+	 */
+	public function setRequest($request)
+	{
+		$this->request = $request;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getStatus()
+	{
+		return $this->status;
+	}
+
+	/**
+	 * @param string $status
+	 */
+	public function setStatus($status)
+	{
+		$this->status = $status;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEnqueue()
+	{
+		return $this->enqueue;
+	}
+
+	/**
+	 * @param string $enqueue
+	 */
+	public function setEnqueue($enqueue)
+	{
+		$this->enqueue = $enqueue;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getParameters()
+	{
+		return $this->parameters;
+	}
+
+	/**
+	 * @param string $parameters
+	 */
+	public function setParameters($parameters)
+	{
+		$this->parameters = $parameters;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getError()
+	{
+		return $this->error;
+	}
+
+	/**
+	 * @param mixed $error
+	 */
+	public function setError($error)
+	{
+		$this->error = $error;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getAcknowledged()
+	{
+		return $this->acknowledged;
+	}
+
+	/**
+	 * @param int $acknowledged
+	 */
+	public function setAcknowledged($acknowledged)
+	{
+		$this->acknowledged = $acknowledged;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getParent()
+	{
+		return $this->parent;
+	}
+
+	/**
+	 * @param int $parent
+	 */
+	public function setParent($parent)
+	{
+		$this->parent = $parent;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getEmailTemplate()
+	{
+		return $this->emailtemplate;
+	}
+
+	/**
+	 * @param int $emailTemplate
+	 */
+	public function setEmailTemplate($emailTemplate)
+	{
+		$this->emailtemplate = $emailTemplate;
+	}
+	#endregion
 }
\ No newline at end of file

Braces +2 added lines, -1 removed lines

@@ -58,7 +58,8 @@
     /**
      * This feels like the least bad place to put this method.
      */
-    public static function getTaskDescriptions() {
+    public static function getTaskDescriptions()
+    {
         return array(
             BotCreationTask::class  => 'Create account (via bot)',
             UserCreationTask::class => 'Create account (via OAuth)',

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