enwikipedia-acc / waca

includes/Fragments/TemplateOutput.php

Indentation +73 added lines, -73 removed lines

@@ -15,88 +15,88 @@
 
 trait TemplateOutput
 {
-    /** @var Smarty */
-    private $smarty;
-    /** @var string Extra JavaScript to include at the end of the page's execution */
-    private $tailScript;
+	/** @var Smarty */
+	private $smarty;
+	/** @var string Extra JavaScript to include at the end of the page's execution */
+	private $tailScript;
 
-    /**
-     * @return SiteConfiguration
-     */
-    protected abstract function getSiteConfiguration();
+	/**
+	 * @return SiteConfiguration
+	 */
+	protected abstract function getSiteConfiguration();
 
-    /**
-     * Include extra JavaScript at the end of the page's execution
-     *
-     * @param $script string JavaScript to include at the end of the page
-     */
-    final protected function setTailScript($script)
-    {
-        $this->tailScript = $script;
-    }
+	/**
+	 * Include extra JavaScript at the end of the page's execution
+	 *
+	 * @param $script string JavaScript to include at the end of the page
+	 */
+	final protected function setTailScript($script)
+	{
+		$this->tailScript = $script;
+	}
 
-    /**
-     * Assigns a Smarty variable
-     *
-     * @param  array|string $name  the template variable name(s)
-     * @param  mixed        $value the value to assign
-     */
-    final protected function assign($name, $value)
-    {
-        $this->smarty->assign($name, $value);
-    }
+	/**
+	 * Assigns a Smarty variable
+	 *
+	 * @param  array|string $name  the template variable name(s)
+	 * @param  mixed        $value the value to assign
+	 */
+	final protected function assign($name, $value)
+	{
+		$this->smarty->assign($name, $value);
+	}
 
-    /**
-     * Sets up the variables used by the main Smarty base template.
-     *
-     * This list is getting kinda long.
-     */
-    final protected function setUpSmarty()
-    {
-        $this->smarty = new Smarty();
-        $this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
+	/**
+	 * Sets up the variables used by the main Smarty base template.
+	 *
+	 * This list is getting kinda long.
+	 */
+	final protected function setUpSmarty()
+	{
+		$this->smarty = new Smarty();
+		$this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
 
-        $this->assign('currentUser', User::getCommunity());
-        $this->assign('loggedIn', false);
-        $this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
-        $this->assign('mediawikiScriptPath', $this->getSiteConfiguration()->getMediawikiScriptPath());
+		$this->assign('currentUser', User::getCommunity());
+		$this->assign('loggedIn', false);
+		$this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
+		$this->assign('mediawikiScriptPath', $this->getSiteConfiguration()->getMediawikiScriptPath());
 
-        $this->assign('siteNoticeText', '');
-        $this->assign('toolversion', Environment::getToolVersion());
+		$this->assign('siteNoticeText', '');
+		$this->assign('toolversion', Environment::getToolVersion());
 
-        // default these
-        $this->assign('onlineusers', array());
-        $this->assign('typeAheadBlock', '');
-        $this->assign('extraJs', array());
-        $this->assign('extraCss', array());
+		// default these
+		$this->assign('onlineusers', array());
+		$this->assign('typeAheadBlock', '');
+		$this->assign('extraJs', array());
+		$this->assign('extraCss', array());
 
-        // nav menu access control
-        $this->assign('nav__canRequests', false);
-        $this->assign('nav__canLogs', false);
-        $this->assign('nav__canUsers', false);
-        $this->assign('nav__canSearch', false);
-        $this->assign('nav__canStats', false);
-        $this->assign('nav__canBan', false);
-        $this->assign('nav__canEmailMgmt', false);
-        $this->assign('nav__canWelcomeMgmt', false);
-        $this->assign('nav__canSiteNoticeMgmt', false);
-        $this->assign('nav__canUserMgmt', false);
-        $this->assign('nav__canViewRequest', false);
+		// nav menu access control
+		$this->assign('nav__canRequests', false);
+		$this->assign('nav__canLogs', false);
+		$this->assign('nav__canUsers', false);
+		$this->assign('nav__canSearch', false);
+		$this->assign('nav__canStats', false);
+		$this->assign('nav__canBan', false);
+		$this->assign('nav__canEmailMgmt', false);
+		$this->assign('nav__canWelcomeMgmt', false);
+		$this->assign('nav__canSiteNoticeMgmt', false);
+		$this->assign('nav__canUserMgmt', false);
+		$this->assign('nav__canViewRequest', false);
 
-        $this->assign('page', $this);
-    }
+		$this->assign('page', $this);
+	}
 
-    /**
-     * Fetches a rendered Smarty template
-     *
-     * @param $template string Template file path, relative to /templates/
-     *
-     * @return string Templated HTML
-     */
-    final protected function fetchTemplate($template)
-    {
-        $this->assign("tailScript", $this->tailScript);
+	/**
+	 * Fetches a rendered Smarty template
+	 *
+	 * @param $template string Template file path, relative to /templates/
+	 *
+	 * @return string Templated HTML
+	 */
+	final protected function fetchTemplate($template)
+	{
+		$this->assign("tailScript", $this->tailScript);
 
-        return $this->smarty->fetch($template);
-    }
+		return $this->smarty->fetch($template);
+	}
 }

includes/Fragments/RequestData.php

Indentation +318 added lines, -318 removed lines

@@ -23,322 +23,322 @@
 
 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());
-
-        $this->assign('requestIsClosed', !array_key_exists($request->getStatus(), $config->getRequestStates()));
-    }
-
-    /**
-     * 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());
+
+		$this->assign('requestIsClosed', !array_key_exists($request->getStatus(), $config->getRequestStates()));
+	}
+
+	/**
+	 * 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/DataObjects/CommunityUser.php

Indentation +207 added lines, -207 removed lines

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

includes/DataObjects/UserRole.php

Indentation +79 added lines, -79 removed lines

@@ -15,95 +15,95 @@
 
 class UserRole extends DataObject
 {
-    /** @var int */
-    private $user;
-    /** @var string */
-    private $role;
+	/** @var int */
+	private $user;
+	/** @var string */
+	private $role;
 
-    /**
-     * @param int         $userId
-     * @param PdoDatabase $database
-     *
-     * @return UserRole[]
-     */
-    public static function getForUser($userId, PdoDatabase $database)
-    {
-        $sql = 'SELECT * FROM userrole WHERE user = :user';
-        $statement = $database->prepare($sql);
-        $statement->bindValue(':user', $userId);
+	/**
+	 * @param int         $userId
+	 * @param PdoDatabase $database
+	 *
+	 * @return UserRole[]
+	 */
+	public static function getForUser($userId, PdoDatabase $database)
+	{
+		$sql = 'SELECT * FROM userrole WHERE user = :user';
+		$statement = $database->prepare($sql);
+		$statement->bindValue(':user', $userId);
 
-        $statement->execute();
+		$statement->execute();
 
-        $result = array();
+		$result = array();
 
-        /** @var Ban $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
+		/** @var Ban $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     *
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare('INSERT INTO `userrole` (user, role) VALUES (:user, :role);'
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":role", $this->role);
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 *
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare('INSERT INTO `userrole` (user, role) VALUES (:user, :role);'
+			);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":role", $this->role);
 
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            throw new Exception('Updating roles is not available');
-        }
-    }
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			throw new Exception('Updating roles is not available');
+		}
+	}
 
-    #region Properties
+	#region Properties
 
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
 
-    /**
-     * @param int $user
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-    }
+	/**
+	 * @param int $user
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+	}
 
-    /**
-     * @return string
-     */
-    public function getRole()
-    {
-        return $this->role;
-    }
+	/**
+	 * @return string
+	 */
+	public function getRole()
+	{
+		return $this->role;
+	}
 
-    /**
-     * @param string $role
-     */
-    public function setRole($role)
-    {
-        $this->role = $role;
-    }
-    #endregion
+	/**
+	 * @param string $role
+	 */
+	public function setRole($role)
+	{
+		$this->role = $role;
+	}
+	#endregion
 }

includes/DataObjects/User.php

Indentation +947 added lines, -947 removed lines

@@ -27,229 +27,229 @@ 
  */
 class User extends DataObject
 {
-    const STATUS_ACTIVE = 'Active';
-    const STATUS_SUSPENDED = 'Suspended';
-    const STATUS_DECLINED = 'Declined';
-    const STATUS_NEW = 'New';
-    private $username;
-    private $email;
-    private $password;
-    private $status = self::STATUS_NEW;
-    private $onwikiname = "##OAUTH##";
-    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 = "";
-    /** @var null|string */
-    private $oauthrequesttoken = null;
-    /** @var null|string */
-    private $oauthrequestsecret = null;
-    /** @var null|string */
-    private $oauthaccesstoken = null;
-    /** @var null|string */
-    private $oauthaccesssecret = null;
-    private $oauthidentitycache = null;
-    /** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
-    private static $currentUser;
-    /** @var null|JWT The identity cache */
-    private $identityCache = null;
-    #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.
-     *
-     * Don't use without asking me first. It's really inefficient in it's current implementation.
-     * We need to restructure the user table again to make this more efficient.
-     * We don't actually store the on-wiki name in the table any more, instead we
-     * are storing JSON in a column (!!). Yep, my fault. Code review is an awesome thing.
-     *            -- stw 2015-10-20
-     *
-     * @param string      $username
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getByOnWikiUsername($username, PdoDatabase $database)
-    {
-        // Firstly, try to search by the efficient database lookup.
-        $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;
-        }
-
-        // For active users, the above has failed. Let's do it the hard way.
-        $sqlStatement = "SELECT * FROM user WHERE onwikiname = '##OAUTH##' AND oauthaccesstoken IS NOT NULL;";
-        $statement = $database->prepare($sqlStatement);
-        $statement->execute();
-        $resultSet = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
-
-        /** @var User $user */
-        foreach ($resultSet as $user) {
-            // We have to set this before doing OAuth queries. :(
-            $user->setDatabase($database);
-
-            // Using cached data here!
-            if ($user->getOAuthOnWikiName(true) == $username) {
-                // Success.
-                return $user;
-            }
-        }
-
-        // Cached data failed. Let's do it the *REALLY* hard way.
-        foreach ($resultSet as $user) {
-            // We have to set this before doing OAuth queries. :(
-            $user->setDatabase($database);
-
-            // Don't use the cached data, but instead query the API.
-            if ($user->getOAuthOnWikiName(false) == $username) {
-                // Success.
-                return $user;
-            }
-        }
-
-        // Nope. Sorry.
-        return false;
-    }
-
-    /**
-     * Gets a user by their OAuth request token
-     *
-     * @param string      $requestToken
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getByRequestToken($requestToken, PdoDatabase $database)
-    {
-        $statement = $database->prepare("SELECT * FROM user WHERE oauthrequesttoken = :id LIMIT 1;");
-        $statement->bindValue(":id", $requestToken);
-
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    #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';
+	private $username;
+	private $email;
+	private $password;
+	private $status = self::STATUS_NEW;
+	private $onwikiname = "##OAUTH##";
+	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 = "";
+	/** @var null|string */
+	private $oauthrequesttoken = null;
+	/** @var null|string */
+	private $oauthrequestsecret = null;
+	/** @var null|string */
+	private $oauthaccesstoken = null;
+	/** @var null|string */
+	private $oauthaccesssecret = null;
+	private $oauthidentitycache = null;
+	/** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
+	private static $currentUser;
+	/** @var null|JWT The identity cache */
+	private $identityCache = null;
+	#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.
+	 *
+	 * Don't use without asking me first. It's really inefficient in it's current implementation.
+	 * We need to restructure the user table again to make this more efficient.
+	 * We don't actually store the on-wiki name in the table any more, instead we
+	 * are storing JSON in a column (!!). Yep, my fault. Code review is an awesome thing.
+	 *            -- stw 2015-10-20
+	 *
+	 * @param string      $username
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getByOnWikiUsername($username, PdoDatabase $database)
+	{
+		// Firstly, try to search by the efficient database lookup.
+		$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;
+		}
+
+		// For active users, the above has failed. Let's do it the hard way.
+		$sqlStatement = "SELECT * FROM user WHERE onwikiname = '##OAUTH##' AND oauthaccesstoken IS NOT NULL;";
+		$statement = $database->prepare($sqlStatement);
+		$statement->execute();
+		$resultSet = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
+
+		/** @var User $user */
+		foreach ($resultSet as $user) {
+			// We have to set this before doing OAuth queries. :(
+			$user->setDatabase($database);
+
+			// Using cached data here!
+			if ($user->getOAuthOnWikiName(true) == $username) {
+				// Success.
+				return $user;
+			}
+		}
+
+		// Cached data failed. Let's do it the *REALLY* hard way.
+		foreach ($resultSet as $user) {
+			// We have to set this before doing OAuth queries. :(
+			$user->setDatabase($database);
+
+			// Don't use the cached data, but instead query the API.
+			if ($user->getOAuthOnWikiName(false) == $username) {
+				// Success.
+				return $user;
+			}
+		}
+
+		// Nope. Sorry.
+		return false;
+	}
+
+	/**
+	 * Gets a user by their OAuth request token
+	 *
+	 * @param string      $requestToken
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getByRequestToken($requestToken, PdoDatabase $database)
+	{
+		$statement = $database->prepare("SELECT * FROM user WHERE oauthrequesttoken = :id LIMIT 1;");
+		$statement->bindValue(":id", $requestToken);
+
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	#endregion
+
+	/**
+	 * Saves the current object
+	 *
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 				INSERT INTO `user` ( 
 					username, email, password, status, onwikiname, welcome_sig, 
 					lastactive, forcelogout, forceidentified,
@@ -263,35 +263,35 @@ 
 					:ort, :ors, :oat, :oas
 				);
 SQL
-            );
-            $statement->bindValue(":username", $this->username);
-            $statement->bindValue(":email", $this->email);
-            $statement->bindValue(":password", $this->password);
-            $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(":ort", $this->oauthrequesttoken);
-            $statement->bindValue(":ors", $this->oauthrequestsecret);
-            $statement->bindValue(":oat", $this->oauthaccesstoken);
-            $statement->bindValue(":oas", $this->oauthaccesssecret);
-
-            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(":password", $this->password);
+			$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(":ort", $this->oauthrequesttoken);
+			$statement->bindValue(":ors", $this->oauthrequestsecret);
+			$statement->bindValue(":oat", $this->oauthaccesstoken);
+			$statement->bindValue(":oas", $this->oauthaccesssecret);
+
+			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, 
 					password = :password, status = :status,
@@ -306,695 +306,695 @@ 
 				WHERE id = :id AND updateversion = :updateversion
 				LIMIT 1;
 SQL
-            );
-            $statement->bindValue(":forceidentified", $this->forceidentified);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':username', $this->username);
-            $statement->bindValue(':email', $this->email);
-            $statement->bindValue(':password', $this->password);
-            $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(':ort', $this->oauthrequesttoken);
-            $statement->bindValue(':ors', $this->oauthrequestsecret);
-            $statement->bindValue(':oat', $this->oauthaccesstoken);
-            $statement->bindValue(':oas', $this->oauthaccesssecret);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * Authenticates the user with the supplied password
-     *
-     * @param string $password
-     *
-     * @return bool
-     * @throws Exception
-     * @category Security-Critical
-     */
-    public function authenticate($password)
-    {
-        $result = AuthUtility::testCredentials($password, $this->password);
-
-        if ($result === true) {
-            // password version is out of date, update it.
-            if (!AuthUtility::isCredentialVersionLatest($this->password)) {
-                $this->password = AuthUtility::encryptPassword($password);
-                $this->save();
-            }
-        }
-
-        return $result;
-    }
-
-    #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;
-    }
-
-    /**
-     * Sets the user's password
-     *
-     * @param string $password the plaintext password
-     *
-     * @category Security-Critical
-     */
-    public function setPassword($password)
-    {
-        $this->password = AuthUtility::encryptPassword($password);
-    }
-
-    /**
-     * 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()
-    {
-        if ($this->oauthaccesstoken !== null) {
-            try {
-                return $this->getOAuthOnWikiName();
-            }
-            catch (Exception $ex) {
-                // urm.. log this?
-                return $this->onwikiname;
-            }
-        }
-
-        return $this->onwikiname;
-    }
-
-    /**
-     * This is probably NOT the function you want!
-     *
-     * Take a look at getOnWikiName() instead.
-     * @return string
-     */
-    public function getStoredOnWikiName()
-    {
-        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;
-    }
-
-    /**
-     * Gets the user's OAuth request token.
-     *
-     * @todo move me to a collaborator.
-     * @return null|string
-     */
-    public function getOAuthRequestToken()
-    {
-        return $this->oauthrequesttoken;
-    }
-
-    /**
-     * Sets the user's OAuth request token
-     * @todo move me to a collaborator
-     *
-     * @param string $oAuthRequestToken
-     */
-    public function setOAuthRequestToken($oAuthRequestToken)
-    {
-        $this->oauthrequesttoken = $oAuthRequestToken;
-    }
-
-    /**
-     * Gets the users OAuth request secret
-     * @category Security-Critical
-     * @todo     move me to a collaborator
-     * @return null|string
-     */
-    public function getOAuthRequestSecret()
-    {
-        return $this->oauthrequestsecret;
-    }
-
-    /**
-     * Sets the user's OAuth request secret
-     * @todo move me to a collaborator
-     *
-     * @param string $oAuthRequestSecret
-     */
-    public function setOAuthRequestSecret($oAuthRequestSecret)
-    {
-        $this->oauthrequestsecret = $oAuthRequestSecret;
-    }
-
-    /**
-     * Gets the user's access token
-     * @category Security-Critical
-     * @todo     move me to a collaborator
-     * @return null|string
-     */
-    public function getOAuthAccessToken()
-    {
-        return $this->oauthaccesstoken;
-    }
-
-    /**
-     * Sets the user's access token
-     * @todo move me to a collaborator
-     *
-     * @param string $oAuthAccessToken
-     */
-    public function setOAuthAccessToken($oAuthAccessToken)
-    {
-        $this->oauthaccesstoken = $oAuthAccessToken;
-    }
-
-    /**
-     * Gets the user's OAuth access secret
-     * @category Security-Critical
-     * @todo     move me to a collaborator
-     * @return null|string
-     */
-    public function getOAuthAccessSecret()
-    {
-        return $this->oauthaccesssecret;
-    }
-
-    /**
-     * Sets the user's OAuth access secret
-     * @todo move me to a collaborator
-     *
-     * @param string $oAuthAccessSecret
-     */
-    public function setOAuthAccessSecret($oAuthAccessSecret)
-    {
-        $this->oauthaccesssecret = $oAuthAccessSecret;
-    }
-
-    #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 
-
-    #region OAuth
-
-    /**
-     * @todo     move me to a collaborator
-     *
-     * @param bool $useCached
-     *
-     * @return mixed|null
-     * @category Security-Critical
-     */
-    public function getOAuthIdentity($useCached = false)
-    {
-        if ($this->oauthaccesstoken === null) {
-            $this->clearOAuthData();
-        }
-
-        global $oauthConsumerToken, $oauthMediaWikiCanonicalServer;
-
-        if ($this->oauthidentitycache == null) {
-            $this->identityCache = null;
-        }
-        else {
-            $this->identityCache = unserialize($this->oauthidentitycache);
-        }
-
-        // check the cache
-        if (
-            $this->identityCache != null &&
-            $this->identityCache->aud == $oauthConsumerToken &&
-            $this->identityCache->iss == $oauthMediaWikiCanonicalServer
-        ) {
-            if (
-                $useCached || (
-                    DateTime::createFromFormat("U", $this->identityCache->iat) < new DateTime() &&
-                    DateTime::createFromFormat("U", $this->identityCache->exp) > new DateTime()
-                )
-            ) {
-                // Use cached value - it's either valid or we don't care.
-                return $this->identityCache;
-            }
-            else {
-                // Cache expired and not forcing use of cached value
-                $this->getIdentityCache();
-
-                return $this->identityCache;
-            }
-        }
-        else {
-            // Cache isn't ours or doesn't exist
-            $this->getIdentityCache();
-
-            return $this->identityCache;
-        }
-    }
-
-    /**
-     * @todo     move me to a collaborator
-     *
-     * @param mixed $useCached Set to false for everything where up-to-date data is important.
-     *
-     * @return mixed
-     * @category Security-Critical
-     */
-    private function getOAuthOnWikiName($useCached = false)
-    {
-        $identity = $this->getOAuthIdentity($useCached);
-        if ($identity !== null) {
-            return $identity->username;
-        }
-
-        return false;
-    }
-
-    /**
-     * @return bool
-     * @todo move me to a collaborator
-     */
-    public function isOAuthLinked()
-    {
-        if ($this->onwikiname === "##OAUTH##") {
-            return true; // special value. If an account must be oauth linked, this is true.
-        }
-
-        return $this->oauthaccesstoken !== null;
-    }
-
-    /**
-     * @return null
-     * @todo move me to a collaborator
-     */
-    public function clearOAuthData()
-    {
-        $this->identityCache = null;
-        $this->oauthidentitycache = null;
-        $clearCacheQuery = "UPDATE user SET oauthidentitycache = NULL WHERE id = :id;";
-        $this->dbObject->prepare($clearCacheQuery)->execute(array(":id" => $this->id));
-
-        return null;
-    }
-
-    /**
-     * @throws Exception
-     * @todo     move me to a collaborator
-     * @category Security-Critical
-     */
-    private function getIdentityCache()
-    {
-        /** @var IOAuthHelper $oauthHelper */
-        global $oauthHelper;
-
-        try {
-            $this->identityCache = $oauthHelper->getIdentityTicket($this->oauthaccesstoken, $this->oauthaccesssecret);
-
-            $this->oauthidentitycache = serialize($this->identityCache);
-            $this->dbObject->prepare("UPDATE user SET oauthidentitycache = :identity WHERE id = :id;")
-                ->execute(array(":id" => $this->id, ":identity" => $this->oauthidentitycache));
-        }
-        catch (UnexpectedValueException $ex) {
-            $this->identityCache = null;
-            $this->oauthidentitycache = null;
-            $this->dbObject->prepare("UPDATE user SET oauthidentitycache = NULL WHERE id = :id;")
-                ->execute(array(":id" => $this->id));
-
-            SessionAlert::warning("OAuth error getting identity from MediaWiki: " . $ex->getMessage());
-        }
-    }
-
-    /**
-     * @return bool
-     * @todo move me to a collaborator
-     */
-    public function oauthCanUse()
-    {
-        try {
-            return in_array('useoauth', $this->getOAuthIdentity()->grants);
-        }
-        catch (Exception $ex) {
-            return false;
-        }
-    }
-
-    /**
-     * @return bool
-     * @todo move me to a collaborator
-     */
-    public function oauthCanEdit()
-    {
-        try {
-            return in_array('useoauth', $this->getOAuthIdentity()->grants)
-            && in_array('createeditmovepage', $this->getOAuthIdentity()->grants)
-            && in_array('createtalk', $this->getOAuthIdentity()->rights)
-            && in_array('edit', $this->getOAuthIdentity()->rights)
-            && in_array('writeapi', $this->getOAuthIdentity()->rights);
-        }
-        catch (Exception $ex) {
-            return false;
-        }
-    }
-
-    /**
-     * @return bool
-     * @todo move me to a collaborator
-     */
-    public function oauthCanCreateAccount()
-    {
-        try {
-            return in_array('useoauth', $this->getOAuthIdentity()->grants)
-            && in_array('createaccount', $this->getOAuthIdentity()->grants)
-            && in_array('createaccount', $this->getOAuthIdentity()->rights)
-            && in_array('writeapi', $this->getOAuthIdentity()->rights);
-        }
-        catch (Exception $ex) {
-            return false;
-        }
-    }
-
-    /**
-     * @return bool
-     * @todo     move me to a collaborator
-     * @category Security-Critical
-     */
-    protected function oauthCanCheckUser()
-    {
-        if (!$this->isOAuthLinked()) {
-            return false;
-        }
-
-        try {
-            $identity = $this->getOAuthIdentity();
-
-            return in_array('checkuser', $identity->rights);
-        }
-        catch (Exception $ex) {
-            return false;
-        }
-    }
-
-    #endregion
-
-    /**
-     * Gets a hash of data for the user to reset their password with.
-     * @category Security-Critical
-     * @return string
-     */
-    public function getForgottenPasswordHash()
-    {
-        return md5($this->username . $this->email . $this->welcome_template . $this->id . $this->password);
-    }
-
-    /**
-     * 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(':password', $this->password);
+			$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(':ort', $this->oauthrequesttoken);
+			$statement->bindValue(':ors', $this->oauthrequestsecret);
+			$statement->bindValue(':oat', $this->oauthaccesstoken);
+			$statement->bindValue(':oas', $this->oauthaccesssecret);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * Authenticates the user with the supplied password
+	 *
+	 * @param string $password
+	 *
+	 * @return bool
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	public function authenticate($password)
+	{
+		$result = AuthUtility::testCredentials($password, $this->password);
+
+		if ($result === true) {
+			// password version is out of date, update it.
+			if (!AuthUtility::isCredentialVersionLatest($this->password)) {
+				$this->password = AuthUtility::encryptPassword($password);
+				$this->save();
+			}
+		}
+
+		return $result;
+	}
+
+	#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;
+	}
+
+	/**
+	 * Sets the user's password
+	 *
+	 * @param string $password the plaintext password
+	 *
+	 * @category Security-Critical
+	 */
+	public function setPassword($password)
+	{
+		$this->password = AuthUtility::encryptPassword($password);
+	}
+
+	/**
+	 * 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()
+	{
+		if ($this->oauthaccesstoken !== null) {
+			try {
+				return $this->getOAuthOnWikiName();
+			}
+			catch (Exception $ex) {
+				// urm.. log this?
+				return $this->onwikiname;
+			}
+		}
+
+		return $this->onwikiname;
+	}
+
+	/**
+	 * This is probably NOT the function you want!
+	 *
+	 * Take a look at getOnWikiName() instead.
+	 * @return string
+	 */
+	public function getStoredOnWikiName()
+	{
+		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;
+	}
+
+	/**
+	 * Gets the user's OAuth request token.
+	 *
+	 * @todo move me to a collaborator.
+	 * @return null|string
+	 */
+	public function getOAuthRequestToken()
+	{
+		return $this->oauthrequesttoken;
+	}
+
+	/**
+	 * Sets the user's OAuth request token
+	 * @todo move me to a collaborator
+	 *
+	 * @param string $oAuthRequestToken
+	 */
+	public function setOAuthRequestToken($oAuthRequestToken)
+	{
+		$this->oauthrequesttoken = $oAuthRequestToken;
+	}
+
+	/**
+	 * Gets the users OAuth request secret
+	 * @category Security-Critical
+	 * @todo     move me to a collaborator
+	 * @return null|string
+	 */
+	public function getOAuthRequestSecret()
+	{
+		return $this->oauthrequestsecret;
+	}
+
+	/**
+	 * Sets the user's OAuth request secret
+	 * @todo move me to a collaborator
+	 *
+	 * @param string $oAuthRequestSecret
+	 */
+	public function setOAuthRequestSecret($oAuthRequestSecret)
+	{
+		$this->oauthrequestsecret = $oAuthRequestSecret;
+	}
+
+	/**
+	 * Gets the user's access token
+	 * @category Security-Critical
+	 * @todo     move me to a collaborator
+	 * @return null|string
+	 */
+	public function getOAuthAccessToken()
+	{
+		return $this->oauthaccesstoken;
+	}
+
+	/**
+	 * Sets the user's access token
+	 * @todo move me to a collaborator
+	 *
+	 * @param string $oAuthAccessToken
+	 */
+	public function setOAuthAccessToken($oAuthAccessToken)
+	{
+		$this->oauthaccesstoken = $oAuthAccessToken;
+	}
+
+	/**
+	 * Gets the user's OAuth access secret
+	 * @category Security-Critical
+	 * @todo     move me to a collaborator
+	 * @return null|string
+	 */
+	public function getOAuthAccessSecret()
+	{
+		return $this->oauthaccesssecret;
+	}
+
+	/**
+	 * Sets the user's OAuth access secret
+	 * @todo move me to a collaborator
+	 *
+	 * @param string $oAuthAccessSecret
+	 */
+	public function setOAuthAccessSecret($oAuthAccessSecret)
+	{
+		$this->oauthaccesssecret = $oAuthAccessSecret;
+	}
+
+	#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 
+
+	#region OAuth
+
+	/**
+	 * @todo     move me to a collaborator
+	 *
+	 * @param bool $useCached
+	 *
+	 * @return mixed|null
+	 * @category Security-Critical
+	 */
+	public function getOAuthIdentity($useCached = false)
+	{
+		if ($this->oauthaccesstoken === null) {
+			$this->clearOAuthData();
+		}
+
+		global $oauthConsumerToken, $oauthMediaWikiCanonicalServer;
+
+		if ($this->oauthidentitycache == null) {
+			$this->identityCache = null;
+		}
+		else {
+			$this->identityCache = unserialize($this->oauthidentitycache);
+		}
+
+		// check the cache
+		if (
+			$this->identityCache != null &&
+			$this->identityCache->aud == $oauthConsumerToken &&
+			$this->identityCache->iss == $oauthMediaWikiCanonicalServer
+		) {
+			if (
+				$useCached || (
+					DateTime::createFromFormat("U", $this->identityCache->iat) < new DateTime() &&
+					DateTime::createFromFormat("U", $this->identityCache->exp) > new DateTime()
+				)
+			) {
+				// Use cached value - it's either valid or we don't care.
+				return $this->identityCache;
+			}
+			else {
+				// Cache expired and not forcing use of cached value
+				$this->getIdentityCache();
+
+				return $this->identityCache;
+			}
+		}
+		else {
+			// Cache isn't ours or doesn't exist
+			$this->getIdentityCache();
+
+			return $this->identityCache;
+		}
+	}
+
+	/**
+	 * @todo     move me to a collaborator
+	 *
+	 * @param mixed $useCached Set to false for everything where up-to-date data is important.
+	 *
+	 * @return mixed
+	 * @category Security-Critical
+	 */
+	private function getOAuthOnWikiName($useCached = false)
+	{
+		$identity = $this->getOAuthIdentity($useCached);
+		if ($identity !== null) {
+			return $identity->username;
+		}
+
+		return false;
+	}
+
+	/**
+	 * @return bool
+	 * @todo move me to a collaborator
+	 */
+	public function isOAuthLinked()
+	{
+		if ($this->onwikiname === "##OAUTH##") {
+			return true; // special value. If an account must be oauth linked, this is true.
+		}
+
+		return $this->oauthaccesstoken !== null;
+	}
+
+	/**
+	 * @return null
+	 * @todo move me to a collaborator
+	 */
+	public function clearOAuthData()
+	{
+		$this->identityCache = null;
+		$this->oauthidentitycache = null;
+		$clearCacheQuery = "UPDATE user SET oauthidentitycache = NULL WHERE id = :id;";
+		$this->dbObject->prepare($clearCacheQuery)->execute(array(":id" => $this->id));
+
+		return null;
+	}
+
+	/**
+	 * @throws Exception
+	 * @todo     move me to a collaborator
+	 * @category Security-Critical
+	 */
+	private function getIdentityCache()
+	{
+		/** @var IOAuthHelper $oauthHelper */
+		global $oauthHelper;
+
+		try {
+			$this->identityCache = $oauthHelper->getIdentityTicket($this->oauthaccesstoken, $this->oauthaccesssecret);
+
+			$this->oauthidentitycache = serialize($this->identityCache);
+			$this->dbObject->prepare("UPDATE user SET oauthidentitycache = :identity WHERE id = :id;")
+				->execute(array(":id" => $this->id, ":identity" => $this->oauthidentitycache));
+		}
+		catch (UnexpectedValueException $ex) {
+			$this->identityCache = null;
+			$this->oauthidentitycache = null;
+			$this->dbObject->prepare("UPDATE user SET oauthidentitycache = NULL WHERE id = :id;")
+				->execute(array(":id" => $this->id));
+
+			SessionAlert::warning("OAuth error getting identity from MediaWiki: " . $ex->getMessage());
+		}
+	}
+
+	/**
+	 * @return bool
+	 * @todo move me to a collaborator
+	 */
+	public function oauthCanUse()
+	{
+		try {
+			return in_array('useoauth', $this->getOAuthIdentity()->grants);
+		}
+		catch (Exception $ex) {
+			return false;
+		}
+	}
+
+	/**
+	 * @return bool
+	 * @todo move me to a collaborator
+	 */
+	public function oauthCanEdit()
+	{
+		try {
+			return in_array('useoauth', $this->getOAuthIdentity()->grants)
+			&& in_array('createeditmovepage', $this->getOAuthIdentity()->grants)
+			&& in_array('createtalk', $this->getOAuthIdentity()->rights)
+			&& in_array('edit', $this->getOAuthIdentity()->rights)
+			&& in_array('writeapi', $this->getOAuthIdentity()->rights);
+		}
+		catch (Exception $ex) {
+			return false;
+		}
+	}
+
+	/**
+	 * @return bool
+	 * @todo move me to a collaborator
+	 */
+	public function oauthCanCreateAccount()
+	{
+		try {
+			return in_array('useoauth', $this->getOAuthIdentity()->grants)
+			&& in_array('createaccount', $this->getOAuthIdentity()->grants)
+			&& in_array('createaccount', $this->getOAuthIdentity()->rights)
+			&& in_array('writeapi', $this->getOAuthIdentity()->rights);
+		}
+		catch (Exception $ex) {
+			return false;
+		}
+	}
+
+	/**
+	 * @return bool
+	 * @todo     move me to a collaborator
+	 * @category Security-Critical
+	 */
+	protected function oauthCanCheckUser()
+	{
+		if (!$this->isOAuthLinked()) {
+			return false;
+		}
+
+		try {
+			$identity = $this->getOAuthIdentity();
+
+			return in_array('checkuser', $identity->rights);
+		}
+		catch (Exception $ex) {
+			return false;
+		}
+	}
+
+	#endregion
+
+	/**
+	 * Gets a hash of data for the user to reset their password with.
+	 * @category Security-Critical
+	 * @return string
+	 */
+	public function getForgottenPasswordHash()
+	{
+		return md5($this->username . $this->email . $this->welcome_template . $this->id . $this->password);
+	}
+
+	/**
+	 * 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
@@ -1003,12 +1003,12 @@ 
 			ORDER BY id DESC 
 			LIMIT 1;
 SQL
-        );
-        $query->execute(array(":userid" => $this->id));
+		);
+		$query->execute(array(":userid" => $this->id));
 
-        $data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
-        $query->closeCursor();
+		$data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
+		$query->closeCursor();
 
-        return $data;
-    }
+		return $data;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -902,7 +902,7 @@ 
             $this->dbObject->prepare("UPDATE user SET oauthidentitycache = NULL WHERE id = :id;")
                 ->execute(array(":id" => $this->id));
 
-            SessionAlert::warning("OAuth error getting identity from MediaWiki: " . $ex->getMessage());
+            SessionAlert::warning("OAuth error getting identity from MediaWiki: ".$ex->getMessage());
         }
     }
 
@@ -985,7 +985,7 @@ 
      */
     public function getForgottenPasswordHash()
     {
-        return md5($this->username . $this->email . $this->welcome_template . $this->id . $this->password);
+        return md5($this->username.$this->email.$this->welcome_template.$this->id.$this->password);
     }
 
     /**

includes/DataObjects/Comment.php

Indentation +157 added lines, -157 removed lines

@@ -20,172 +20,172 @@
  */
 class Comment extends DataObject
 {
-    private $time;
-    private $user;
-    private $comment;
-    private $visibility = "user";
-    private $request;
-
-    /**
-     * Retrieves all comments for a request, optionally filtered
-     *
-     * @param integer     $id      Request ID to search by
-     * @param PdoDatabase $database
-     * @param bool        $showAll True to show all comments, False to show only unprotected comments, and protected
-     *                             comments visible to $userId
-     * @param null|int    $userId  User to filter by
-     *
-     * @return Comment[]
-     */
-    public static function getForRequest($id, PdoDatabase $database, $showAll = false, $userId = null)
-    {
-        if ($showAll) {
-            $statement = $database->prepare('SELECT * FROM comment WHERE request = :target;');
-        }
-        else {
-            $statement = $database->prepare(<<<SQL
+	private $time;
+	private $user;
+	private $comment;
+	private $visibility = "user";
+	private $request;
+
+	/**
+	 * Retrieves all comments for a request, optionally filtered
+	 *
+	 * @param integer     $id      Request ID to search by
+	 * @param PdoDatabase $database
+	 * @param bool        $showAll True to show all comments, False to show only unprotected comments, and protected
+	 *                             comments visible to $userId
+	 * @param null|int    $userId  User to filter by
+	 *
+	 * @return Comment[]
+	 */
+	public static function getForRequest($id, PdoDatabase $database, $showAll = false, $userId = null)
+	{
+		if ($showAll) {
+			$statement = $database->prepare('SELECT * FROM comment WHERE request = :target;');
+		}
+		else {
+			$statement = $database->prepare(<<<SQL
 SELECT * FROM comment
 WHERE request = :target AND (visibility = 'user' OR user = :userid);
 SQL
-            );
-            $statement->bindValue(':userid', $userId);
-        }
-
-        $statement->bindValue(':target', $id);
-
-        $statement->execute();
-
-        $result = array();
-        /** @var Comment $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
-
-        return $result;
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(':userid', $userId);
+		}
+
+		$statement->bindValue(':target', $id);
+
+		$statement->execute();
+
+		$result = array();
+		/** @var Comment $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 INSERT INTO comment ( time, user, comment, visibility, request )
 VALUES ( CURRENT_TIMESTAMP(), :user, :comment, :visibility, :request );
 SQL
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":comment", $this->comment);
-            $statement->bindValue(":visibility", $this->visibility);
-            $statement->bindValue(":request", $this->request);
-
-            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(":comment", $this->comment);
+			$statement->bindValue(":visibility", $this->visibility);
+			$statement->bindValue(":request", $this->request);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
 UPDATE comment
 SET comment = :comment, visibility = :visibility, updateversion = updateversion + 1
 WHERE id = :id AND updateversion = :updateversion
 LIMIT 1;
 SQL
-            );
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':comment', $this->comment);
-            $statement->bindValue(':visibility', $this->visibility);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * @return DateTimeImmutable
-     */
-    public function getTime()
-    {
-        return new DateTimeImmutable($this->time);
-    }
-
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return string
-     */
-    public function getComment()
-    {
-        return $this->comment;
-    }
-
-    /**
-     * @param string $comment
-     */
-    public function setComment($comment)
-    {
-        $this->comment = $comment;
-    }
-
-    /**
-     * @return string
-     */
-    public function getVisibility()
-    {
-        return $this->visibility;
-    }
-
-    /**
-     * @param string $visibility
-     */
-    public function setVisibility($visibility)
-    {
-        $this->visibility = $visibility;
-    }
-
-    /**
-     * @return int
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @param int $request
-     */
-    public function setRequest($request)
-    {
-        $this->request = $request;
-    }
+			);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(':comment', $this->comment);
+			$statement->bindValue(':visibility', $this->visibility);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * @return DateTimeImmutable
+	 */
+	public function getTime()
+	{
+		return new DateTimeImmutable($this->time);
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getComment()
+	{
+		return $this->comment;
+	}
+
+	/**
+	 * @param string $comment
+	 */
+	public function setComment($comment)
+	{
+		$this->comment = $comment;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getVisibility()
+	{
+		return $this->visibility;
+	}
+
+	/**
+	 * @param string $visibility
+	 */
+	public function setVisibility($visibility)
+	{
+		$this->visibility = $visibility;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @param int $request
+	 */
+	public function setRequest($request)
+	{
+		$this->request = $request;
+	}
 }

includes/API/Actions/CountAction.php

Indentation +121 added lines, -121 removed lines

@@ -20,47 +20,47 @@ 
  */
 class CountAction extends ApiPageBase implements IApiAction
 {
-    /**
-     * The target user
-     * @var User $user
-     */
-    private $user;
+	/**
+	 * The target user
+	 * @var User $user
+	 */
+	private $user;
 
-    public function executeApiAction(DOMElement $apiDocument)
-    {
-        $username = WebRequest::getString('user');
-        if ($username === null) {
-            throw new ApiException("Please specify a username");
-        }
+	public function executeApiAction(DOMElement $apiDocument)
+	{
+		$username = WebRequest::getString('user');
+		if ($username === null) {
+			throw new ApiException("Please specify a username");
+		}
 
-        $userElement = $this->document->createElement("user");
-        $userElement->setAttribute("name", $username);
-        $apiDocument->appendChild($userElement);
+		$userElement = $this->document->createElement("user");
+		$userElement->setAttribute("name", $username);
+		$apiDocument->appendChild($userElement);
 
-        $user = User::getByUsername($username, $this->getDatabase());
+		$user = User::getByUsername($username, $this->getDatabase());
 
-        if ($user === false) {
-            $userElement->setAttribute("missing", "true");
+		if ($user === false) {
+			$userElement->setAttribute("missing", "true");
 
-            return $apiDocument;
-        }
+			return $apiDocument;
+		}
 
-        $this->user = $user;
+		$this->user = $user;
 
-        $userElement->setAttribute("level", $this->user->getStatus());
-        $userElement->setAttribute("created", $this->getAccountsCreated());
+		$userElement->setAttribute("level", $this->user->getStatus());
+		$userElement->setAttribute("created", $this->getAccountsCreated());
 
-        $userElement->setAttribute("today", $this->getToday());
+		$userElement->setAttribute("today", $this->getToday());
 
-        // Let the IRC bot handle the result of this.
-        $this->fetchAdminData($userElement);
+		// Let the IRC bot handle the result of this.
+		$this->fetchAdminData($userElement);
 
-        return $apiDocument;
-    }
+		return $apiDocument;
+	}
 
-    private function getAccountsCreated()
-    {
-        $query = <<<QUERY
+	private function getAccountsCreated()
+	{
+		$query = <<<QUERY
         SELECT COUNT(*) AS count
         FROM log
             LEFT JOIN emailtemplate ON concat('Closed ', emailtemplate.id) = log.action
@@ -71,17 +71,17 @@ 
             AND user.username = :username;
 QUERY;
 
-        $statement = $this->getDatabase()->prepare($query);
-        $statement->execute(array(":username" => $this->user->getUsername()));
-        $result = $statement->fetchColumn();
-        $statement->closeCursor();
+		$statement = $this->getDatabase()->prepare($query);
+		$statement->execute(array(":username" => $this->user->getUsername()));
+		$result = $statement->fetchColumn();
+		$statement->closeCursor();
 
-        return $result;
-    }
+		return $result;
+	}
 
-    private function getToday()
-    {
-        $query = <<<QUERY
+	private function getToday()
+	{
+		$query = <<<QUERY
         SELECT
             COUNT(*) AS count
         FROM log
@@ -93,99 +93,99 @@ 
             AND user.username = :username;
 QUERY;
 
-        $statement = $this->getDatabase()->prepare($query);
-        $statement->bindValue(":username", $this->user->getUsername());
-        $statement->bindValue(":date", date('Y-m-d') . "%");
-        $statement->execute();
-        $today = $statement->fetchColumn();
-        $statement->closeCursor();
-
-        return $today;
-    }
-
-    private function fetchAdminData(DOMElement $userElement)
-    {
-        $query = "SELECT COUNT(*) AS count FROM log WHERE log.user = :userid AND log.action = :action;";
-
-        $statement = $this->getDatabase()->prepare($query);
-        $statement->bindValue(":userid", $this->user->getId());
-        $statement->bindValue(":action", "Suspended");
-        $statement->execute();
-        $sus = $statement->fetchColumn();
-        $userElement->setAttribute("suspended", $sus);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Promoted");
-        $statement->execute();
-        $pro = $statement->fetchColumn();
-        $userElement->setAttribute("promoted", $pro);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Approved");
-        $statement->execute();
-        $app = $statement->fetchColumn();
-        $userElement->setAttribute("approved", $app);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Demoted");
-        $statement->execute();
-        $dem = $statement->fetchColumn();
-        $userElement->setAttribute("demoted", $dem);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Declined");
-        $statement->execute();
-        $dec = $statement->fetchColumn();
-        $userElement->setAttribute("declined", $dec);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Renamed");
-        $statement->execute();
-        $rnc = $statement->fetchColumn();
-        $userElement->setAttribute("renamed", $rnc);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Edited");
-        $statement->execute();
-        $mec = $statement->fetchColumn();
-        $userElement->setAttribute("edited", $mec);
-        $statement->closeCursor();
-
-        $statement->bindValue(":action", "Prefchange");
-        $statement->execute();
-        $pcc = $statement->fetchColumn();
-        $userElement->setAttribute("prefchange", $pcc);
-        $statement->closeCursor();
-
-        // Combine all three actions affecting Welcome templates into one count.
-        $combinedquery = $this->getDatabase()->prepare(<<<SQL
+		$statement = $this->getDatabase()->prepare($query);
+		$statement->bindValue(":username", $this->user->getUsername());
+		$statement->bindValue(":date", date('Y-m-d') . "%");
+		$statement->execute();
+		$today = $statement->fetchColumn();
+		$statement->closeCursor();
+
+		return $today;
+	}
+
+	private function fetchAdminData(DOMElement $userElement)
+	{
+		$query = "SELECT COUNT(*) AS count FROM log WHERE log.user = :userid AND log.action = :action;";
+
+		$statement = $this->getDatabase()->prepare($query);
+		$statement->bindValue(":userid", $this->user->getId());
+		$statement->bindValue(":action", "Suspended");
+		$statement->execute();
+		$sus = $statement->fetchColumn();
+		$userElement->setAttribute("suspended", $sus);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Promoted");
+		$statement->execute();
+		$pro = $statement->fetchColumn();
+		$userElement->setAttribute("promoted", $pro);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Approved");
+		$statement->execute();
+		$app = $statement->fetchColumn();
+		$userElement->setAttribute("approved", $app);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Demoted");
+		$statement->execute();
+		$dem = $statement->fetchColumn();
+		$userElement->setAttribute("demoted", $dem);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Declined");
+		$statement->execute();
+		$dec = $statement->fetchColumn();
+		$userElement->setAttribute("declined", $dec);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Renamed");
+		$statement->execute();
+		$rnc = $statement->fetchColumn();
+		$userElement->setAttribute("renamed", $rnc);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Edited");
+		$statement->execute();
+		$mec = $statement->fetchColumn();
+		$userElement->setAttribute("edited", $mec);
+		$statement->closeCursor();
+
+		$statement->bindValue(":action", "Prefchange");
+		$statement->execute();
+		$pcc = $statement->fetchColumn();
+		$userElement->setAttribute("prefchange", $pcc);
+		$statement->closeCursor();
+
+		// Combine all three actions affecting Welcome templates into one count.
+		$combinedquery = $this->getDatabase()->prepare(<<<SQL
             SELECT
                 COUNT(*) AS count
             FROM log
             WHERE log.user = :userid
                 AND log.action IN ('CreatedTemplate', 'EditedTemplate', 'DeletedTemplate');
 SQL
-        );
+		);
 
-        $combinedquery->bindValue(":userid", $this->user->getId());
-        $combinedquery->execute();
-        $dtc = $combinedquery->fetchColumn();
-        $userElement->setAttribute("welctempchange", $dtc);
-        $combinedquery->closeCursor();
+		$combinedquery->bindValue(":userid", $this->user->getId());
+		$combinedquery->execute();
+		$dtc = $combinedquery->fetchColumn();
+		$userElement->setAttribute("welctempchange", $dtc);
+		$combinedquery->closeCursor();
 
-        // Combine both actions affecting Email templates into one count.
-        $combinedquery = $this->getDatabase()->prepare(<<<SQL
+		// Combine both actions affecting Email templates into one count.
+		$combinedquery = $this->getDatabase()->prepare(<<<SQL
             SELECT COUNT(*) AS count
             FROM log
             WHERE log.user = :userid
                 AND log.action IN ('CreatedEmail', 'EditedEmail');
 SQL
-        );
-
-        $combinedquery->bindValue(":userid", $this->user->getId());
-        $combinedquery->execute();
-        $cec = $combinedquery->fetchColumn();
-        $userElement->setAttribute("emailtempchange", $cec);
-        $combinedquery->closeCursor();
-    }
+		);
+
+		$combinedquery->bindValue(":userid", $this->user->getId());
+		$combinedquery->execute();
+		$cec = $combinedquery->fetchColumn();
+		$userElement->setAttribute("emailtempchange", $cec);
+		$combinedquery->closeCursor();
+	}
 }

includes/Helpers/Logger.php

Indentation +314 added lines, -314 removed lines

@@ -30,318 +30,318 @@
  */
 class Logger
 {
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function emailConfirmed(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param DataObject  $object
-     * @param string      $logAction
-     * @param null|string $comment
-     * @param User        $user
-     *
-     * @throws Exception
-     */
-    private static function createLogEntry(
-        PdoDatabase $database,
-        DataObject $object,
-        $logAction,
-        $comment = null,
-        $user = null
-    ) {
-        if ($user == null) {
-            $user = User::getCurrent($database);
-        }
-
-        $objectType = get_class($object);
-        if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
-            $objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
-        }
-
-        $log = new Log();
-        $log->setDatabase($database);
-        $log->setAction($logAction);
-        $log->setObjectId($object->getId());
-        $log->setObjectType($objectType);
-        $log->setUser($user);
-        $log->setComment($comment);
-        $log->save();
-    }
-
-    #region Users
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $user
-     */
-    public static function newUser(PdoDatabase $database, User $user)
-    {
-        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function approvedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Approved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function declinedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Declined", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function suspendedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Suspended", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function demotedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Demoted", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function promotedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Promoted");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function renamedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Renamed", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function userPreferencesChange(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Prefchange");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $reason
-     * @param array       $added
-     * @param array       $removed
-     */
-    public static function userRolesEdited(PdoDatabase $database, User $object, $reason, $added, $removed)
-    {
-        $logData = serialize(array(
-            'added'   => $added,
-            'removed' => $removed,
-            'reason'  => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "RoleChange", $logData);
-    }
-
-    #endregion
-
-    /**
-     * @param PdoDatabase $database
-     * @param SiteNotice  $object
-     */
-    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
-    {
-        self::createLogEntry($database, $object, "Edited");
-    }
-
-    #region Welcome Templates
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "DeletedTemplate");
-    }
-
-    #endregion
-
-    #region Bans
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function banned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Banned", $reason);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Unbanned", $reason);
-    }
-
-    #endregion
-
-    #region Requests
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $target
-     */
-    public static function deferRequest(PdoDatabase $database, Request $object, $target)
-    {
-        self::createLogEntry($database, $object, "Deferred to $target");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param integer     $target
-     * @param string      $comment
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function reserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Reserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function breakReserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "BreakReserve");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function unreserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Unreserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     * @param Request     $request
-     */
-    public static function editComment(PdoDatabase $database, Comment $object, Request $request)
-    {
-        self::createLogEntry($database, $request, "EditComment-r");
-        self::createLogEntry($database, $object, "EditComment-c");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param User        $target
-     */
-    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
-    {
-        self::createLogEntry($database, $object, "SendReserved");
-        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $comment
-     */
-    public static function sentMail(PdoDatabase $database, Request $object, $comment)
-    {
-        self::createLogEntry($database, $object, "SentMail", $comment);
-    }
-    #endregion
-
-    #region Email templates
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedEmail");
-    }
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedEmail");
-    }
-
-    #endregion
-
-    #region Display
-
-    #endregion
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function emailConfirmed(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param DataObject  $object
+	 * @param string      $logAction
+	 * @param null|string $comment
+	 * @param User        $user
+	 *
+	 * @throws Exception
+	 */
+	private static function createLogEntry(
+		PdoDatabase $database,
+		DataObject $object,
+		$logAction,
+		$comment = null,
+		$user = null
+	) {
+		if ($user == null) {
+			$user = User::getCurrent($database);
+		}
+
+		$objectType = get_class($object);
+		if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
+			$objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
+		}
+
+		$log = new Log();
+		$log->setDatabase($database);
+		$log->setAction($logAction);
+		$log->setObjectId($object->getId());
+		$log->setObjectType($objectType);
+		$log->setUser($user);
+		$log->setComment($comment);
+		$log->save();
+	}
+
+	#region Users
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $user
+	 */
+	public static function newUser(PdoDatabase $database, User $user)
+	{
+		self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function approvedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Approved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function declinedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Declined", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function suspendedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Suspended", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function demotedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Demoted", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function promotedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Promoted");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function renamedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Renamed", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function userPreferencesChange(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Prefchange");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $reason
+	 * @param array       $added
+	 * @param array       $removed
+	 */
+	public static function userRolesEdited(PdoDatabase $database, User $object, $reason, $added, $removed)
+	{
+		$logData = serialize(array(
+			'added'   => $added,
+			'removed' => $removed,
+			'reason'  => $reason,
+		));
+
+		self::createLogEntry($database, $object, "RoleChange", $logData);
+	}
+
+	#endregion
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param SiteNotice  $object
+	 */
+	public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
+	{
+		self::createLogEntry($database, $object, "Edited");
+	}
+
+	#region Welcome Templates
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "DeletedTemplate");
+	}
+
+	#endregion
+
+	#region Bans
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function banned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Banned", $reason);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function unbanned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Unbanned", $reason);
+	}
+
+	#endregion
+
+	#region Requests
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $target
+	 */
+	public static function deferRequest(PdoDatabase $database, Request $object, $target)
+	{
+		self::createLogEntry($database, $object, "Deferred to $target");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param integer     $target
+	 * @param string      $comment
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function reserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Reserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function breakReserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "BreakReserve");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function unreserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Unreserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 * @param Request     $request
+	 */
+	public static function editComment(PdoDatabase $database, Comment $object, Request $request)
+	{
+		self::createLogEntry($database, $request, "EditComment-r");
+		self::createLogEntry($database, $object, "EditComment-c");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param User        $target
+	 */
+	public static function sendReservation(PdoDatabase $database, Request $object, User $target)
+	{
+		self::createLogEntry($database, $object, "SendReserved");
+		self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $comment
+	 */
+	public static function sentMail(PdoDatabase $database, Request $object, $comment)
+	{
+		self::createLogEntry($database, $object, "SentMail", $comment);
+	}
+	#endregion
+
+	#region Email templates
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function createEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedEmail");
+	}
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedEmail");
+	}
+
+	#endregion
+
+	#region Display
+
+	#endregion
 }

includes/Helpers/LogHelper.php

Spacing +6 added lines, -6 removed lines

@@ -128,7 +128,7 @@ 
             $template = EmailTemplate::getById((int)$id, $entry->getDatabase());
 
             if ($template != false) {
-                return "closed (" . $template->getName() . ")";
+                return "closed (".$template->getName().")";
             }
         }
 
@@ -247,7 +247,7 @@ 
                 /** @var Ban $ban */
                 $ban = Ban::getById($objectId, $database);
 
-                return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
+                return 'Ban #'.$objectId." (".htmlentities($ban->getTarget()).")</a>";
             case 'EmailTemplate':
                 /** @var EmailTemplate $emailTemplate */
                 $emailTemplate = EmailTemplate::getById($objectId, $database);
@@ -286,7 +286,7 @@ 
                     return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
                 }
             default:
-                return '[' . $objectType . " " . $objectId . ']';
+                return '['.$objectType." ".$objectId.']';
         }
     }
 
@@ -333,7 +333,7 @@ 
                 $renameData = unserialize($logEntry->getComment());
                 $oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
                 $newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
-                $comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
+                $comment = 'Renamed \''.$oldName.'\' to \''.$newName.'\'.';
             }
             else if ($logEntry->getAction() === 'RoleChange') {
                 $roleChangeData = unserialize($logEntry->getComment());
@@ -350,8 +350,8 @@ 
 
                 $reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
 
-                $roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
-                $comment = $roleDelta . ' with comment: ' . $reason;
+                $roleDelta = 'Removed ['.implode(', ', $removed).'], Added ['.implode(', ', $added).']';
+                $comment = $roleDelta.' with comment: '.$reason;
             }
             else {
                 $comment = $logEntry->getComment();

Indentation +336 added lines, -336 removed lines

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