enwikipedia-acc / waca

includes/Helpers/Interfaces/IOAuthProtocolHelper.php

Indentation +44 added lines, -44 removed lines

@@ -19,52 +19,52 @@
 
 interface IOAuthProtocolHelper
 {
-    /**
-     * @return stdClass
-     *
-     * @throws Exception
-     * @throws CurlException
-     */
-    public function getRequestToken();
+	/**
+	 * @return stdClass
+	 *
+	 * @throws Exception
+	 * @throws CurlException
+	 */
+	public function getRequestToken();
 
-    /**
-     * @param string $requestToken
-     *
-     * @return string
-     */
-    public function getAuthoriseUrl($requestToken);
+	/**
+	 * @param string $requestToken
+	 *
+	 * @return string
+	 */
+	public function getAuthoriseUrl($requestToken);
 
-    /**
-     * @param string $oauthRequestToken
-     * @param string $oauthRequestSecret
-     * @param string $oauthVerifier
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
+	/**
+	 * @param string $oauthRequestToken
+	 * @param string $oauthRequestSecret
+	 * @param string $oauthVerifier
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
 
-    /**
-     * @param string $oauthAccessToken
-     * @param string $oauthAccessSecret
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
+	/**
+	 * @param string $oauthAccessToken
+	 * @param string $oauthAccessSecret
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
 
-    /**
-     * @param array  $apiParams    array of parameters to send to the API
-     * @param string $accessToken  user's access token
-     * @param string $accessSecret user's secret
-     * @param string $method       HTTP method
-     *
-     * @return stdClass
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET');
+	/**
+	 * @param array  $apiParams    array of parameters to send to the API
+	 * @param string $accessToken  user's access token
+	 * @param string $accessSecret user's secret
+	 * @param string $method       HTTP method
+	 *
+	 * @return stdClass
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET');
 }
\ No newline at end of file

includes/Helpers/HttpHelper.php

Indentation +105 added lines, -105 removed lines

@@ -12,109 +12,109 @@
 
 class HttpHelper
 {
-    private $curlHandle;
-
-    /**
-     * HttpHelper constructor.
-     *
-     * @param string  $userAgent
-     * @param boolean $disableVerifyPeer
-     * @param string  $cookieJar
-     */
-    public function __construct($userAgent, $disableVerifyPeer, $cookieJar = null)
-    {
-        $this->curlHandle = curl_init();
-
-        curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $userAgent);
-        curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
-
-        if ($disableVerifyPeer) {
-            curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
-        }
-
-        if($cookieJar !== null) {
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
-        }
-    }
-
-    public function __destruct()
-    {
-        curl_close($this->curlHandle);
-    }
-
-    /**
-     * Fetches the content of a URL, with an optional parameter set.
-     *
-     * @param string     $url        The URL to fetch.
-     * @param null|array $parameters Key/value pair of GET parameters to add to the request.
-     *                               Null lets you handle it yourself.
-     *
-     * @param array      $headers
-     *
-     * @return string
-     * @throws CurlException
-     */
-    public function get($url, $parameters = null, $headers = array())
-    {
-        if ($parameters !== null && is_array($parameters)) {
-            $getString = '?' . http_build_query($parameters);
-            $url .= $getString;
-        }
-
-        curl_setopt($this->curlHandle, CURLOPT_URL, $url);
-
-        // Make sure we're doing a GET
-        curl_setopt($this->curlHandle, CURLOPT_POST, false);
-
-        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
-
-        $result = curl_exec($this->curlHandle);
-
-        if ($result === false) {
-            $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Posts data to a URL
-     *
-     * @param string $url        The URL to fetch.
-     * @param array  $parameters Key/value pair of POST parameters to add to the request.
-     * @param array  $headers
-     *
-     * @return string
-     * @throws CurlException
-     */
-    public function post($url, $parameters, $headers = array())
-    {
-        curl_setopt($this->curlHandle, CURLOPT_URL, $url);
-
-        // Make sure we're doing a POST
-        curl_setopt($this->curlHandle, CURLOPT_POST, true);
-        curl_setopt($this->curlHandle, CURLOPT_POSTFIELDS, http_build_query($parameters));
-
-        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
-
-        $result = curl_exec($this->curlHandle);
-
-        if ($result === false) {
-            $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @return string
-     */
-    public function getError()
-    {
-        return curl_error($this->curlHandle);
-    }
+	private $curlHandle;
+
+	/**
+	 * HttpHelper constructor.
+	 *
+	 * @param string  $userAgent
+	 * @param boolean $disableVerifyPeer
+	 * @param string  $cookieJar
+	 */
+	public function __construct($userAgent, $disableVerifyPeer, $cookieJar = null)
+	{
+		$this->curlHandle = curl_init();
+
+		curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
+		curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $userAgent);
+		curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
+
+		if ($disableVerifyPeer) {
+			curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
+		}
+
+		if($cookieJar !== null) {
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
+		}
+	}
+
+	public function __destruct()
+	{
+		curl_close($this->curlHandle);
+	}
+
+	/**
+	 * Fetches the content of a URL, with an optional parameter set.
+	 *
+	 * @param string     $url        The URL to fetch.
+	 * @param null|array $parameters Key/value pair of GET parameters to add to the request.
+	 *                               Null lets you handle it yourself.
+	 *
+	 * @param array      $headers
+	 *
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function get($url, $parameters = null, $headers = array())
+	{
+		if ($parameters !== null && is_array($parameters)) {
+			$getString = '?' . http_build_query($parameters);
+			$url .= $getString;
+		}
+
+		curl_setopt($this->curlHandle, CURLOPT_URL, $url);
+
+		// Make sure we're doing a GET
+		curl_setopt($this->curlHandle, CURLOPT_POST, false);
+
+		curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
+
+		$result = curl_exec($this->curlHandle);
+
+		if ($result === false) {
+			$error = curl_error($this->curlHandle);
+			throw new CurlException('Remote request failed with error ' . $error);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Posts data to a URL
+	 *
+	 * @param string $url        The URL to fetch.
+	 * @param array  $parameters Key/value pair of POST parameters to add to the request.
+	 * @param array  $headers
+	 *
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function post($url, $parameters, $headers = array())
+	{
+		curl_setopt($this->curlHandle, CURLOPT_URL, $url);
+
+		// Make sure we're doing a POST
+		curl_setopt($this->curlHandle, CURLOPT_POST, true);
+		curl_setopt($this->curlHandle, CURLOPT_POSTFIELDS, http_build_query($parameters));
+
+		curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
+
+		$result = curl_exec($this->curlHandle);
+
+		if ($result === false) {
+			$error = curl_error($this->curlHandle);
+			throw new CurlException('Remote request failed with error ' . $error);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getError()
+	{
+		return curl_error($this->curlHandle);
+	}
 }
\ No newline at end of file

Spacing +4 added lines, -4 removed lines

@@ -33,7 +33,7 @@ 
             curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
         }
 
-        if($cookieJar !== null) {
+        if ($cookieJar !== null) {
             curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
             curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
         }
@@ -59,7 +59,7 @@ 
     public function get($url, $parameters = null, $headers = array())
     {
         if ($parameters !== null && is_array($parameters)) {
-            $getString = '?' . http_build_query($parameters);
+            $getString = '?'.http_build_query($parameters);
             $url .= $getString;
         }
 
@@ -74,7 +74,7 @@ 
 
         if ($result === false) {
             $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
+            throw new CurlException('Remote request failed with error '.$error);
         }
 
         return $result;
@@ -104,7 +104,7 @@ 
 
         if ($result === false) {
             $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
+            throw new CurlException('Remote request failed with error '.$error);
         }
 
         return $result;

includes/Helpers/MediaWikiHelper.php

Braces +2 added lines, -1 removed lines

@@ -241,7 +241,8 @@
      * @param string $username
      * @return bool
      */
-    public function checkAccountExists($username) {
+    public function checkAccountExists($username)
+    {
         $parameters = array(
             'action'  => 'query',
             'list'    => 'users',

Indentation +241 added lines, -241 removed lines

@@ -15,245 +15,245 @@
 
 class MediaWikiHelper
 {
-    /**
-     * @var IMediaWikiClient
-     */
-    private $mediaWikiClient;
-    /**
-     * @var SiteConfiguration
-     */
-    private $siteConfiguration;
-
-    /**
-     * MediaWikiHelper constructor.
-     *
-     * @param IMediaWikiClient  $mediaWikiClient
-     * @param SiteConfiguration $siteConfiguration
-     */
-    public function __construct(IMediaWikiClient $mediaWikiClient, SiteConfiguration $siteConfiguration)
-    {
-        $this->mediaWikiClient = $mediaWikiClient;
-        $this->siteConfiguration = $siteConfiguration;
-    }
-
-    /**
-     * @todo handle override antispoof and titleblacklist issues
-     *
-     * @param string $username
-     * @param string $emailAddress
-     * @param string $reason
-     *
-     * @throws Exception
-     * @throws MediaWikiApiException
-     */
-    public function createAccount($username, $emailAddress, $reason)
-    {
-        // get token
-        $tokenParams = array(
-            'action' => 'query',
-            'meta'   => 'tokens',
-            'type'   => 'createaccount',
-        );
-
-        $response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
-
-        if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        $token = $response->query->tokens->createaccounttoken;
-
-        $callback = $this->siteConfiguration->getBaseUrl() . '/internal.php/oauth/createCallback';
-
-        $checkboxFields = array();
-        $requiredFields = array();
-        $this->getCreationFieldData($requiredFields, $checkboxFields);
-
-        $apiCallData = array(
-            'action'              => 'createaccount',
-            'createreturnurl'     => $callback,
-            'createtoken'         => $token,
-            'createmessageformat' => 'html',
-        );
-
-        $createParams = array_fill_keys($requiredFields, '') + $apiCallData;
-
-        $createParams['username'] = $username;
-        $createParams['mailpassword'] = true;
-        $createParams['email'] = $emailAddress;
-        $createParams['reason'] = $reason;
-
-        $createResponse = $this->mediaWikiClient->doApiCall($createParams, 'POST');
-
-        if (isset($createResponse->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        if (!isset($createResponse->createaccount) || !isset($createResponse->createaccount->status)) {
-            throw new MediaWikiApiException('Unknown error creating account');
-        }
-
-        if ($createResponse->createaccount->status === 'FAIL') {
-            throw new MediaWikiApiException($createResponse->createaccount->message);
-        }
-
-        if ($createResponse->createaccount->status === 'PASS') {
-            // success!
-            return;
-        }
-
-        throw new Exception('API result reported status of ' . $createResponse->createaccount->status);
-    }
-
-    /**
-     * @param string $username
-     * @param string $title
-     * @param        $summary
-     * @param string $message
-     * @param bool   $createOnly
-     *
-     * @throws MediaWikiApiException
-     */
-    public function addTalkPageMessage($username, $title, $summary, $message, $createOnly = true)
-    {
-        // get token
-        $tokenParams = array(
-            'action' => 'query',
-            'meta'   => 'tokens',
-            'type'   => 'csrf',
-        );
-
-        $response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
-
-        if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        $token = $response->query->tokens->csrftoken;
-
-        if ($token === null) {
-            throw new MediaWikiApiException('Edit token could not be acquired');
-        }
-
-        $editParameters = array(
-            'action'       => 'edit',
-            'title'        => 'User talk:' . $username,
-            'section'      => 'new',
-            'sectiontitle' => $title,
-            'summary'      => $summary,
-            'text'         => $message,
-            'token'        => $token,
-        );
-
-        if ($createOnly) {
-            $editParameters['createonly'] = true;
-        }
-
-        $response = $this->mediaWikiClient->doApiCall($editParameters, 'POST');
-
-        if (!isset($response->edit)) {
-            if (isset($response->error)) {
-                throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-            }
-
-            throw new MediaWikiApiException('Unknown error encountered during editing.');
-        }
-
-        $editResponse = $response->edit;
-        if ($editResponse->result === "Success") {
-            return;
-        }
-
-        throw new MediaWikiApiException('Edit status unsuccessful: ' . $editResponse->result);
-    }
-
-    public function getCreationFieldData(&$requiredFields, &$checkboxFields)
-    {
-        // get token
-        $params = array(
-            'action'         => 'query',
-            'meta'           => 'authmanagerinfo',
-            'amirequestsfor' => 'create',
-        );
-
-        $response = $this->mediaWikiClient->doApiCall($params, 'GET');
-
-        if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        $requests = $response->query->authmanagerinfo->requests;
-
-        // We don't want to deal with these providers ever.
-        $discardList = array(
-            // Requires a username and password
-            'MediaWiki\\Auth\\PasswordAuthenticationRequest',
-        );
-
-        // We require these providers to function
-        $requireList = array(
-            'MediaWiki\\Auth\\TemporaryPasswordAuthenticationRequest',
-            'MediaWiki\\Auth\\UsernameAuthenticationRequest',
-            'MediaWiki\\Auth\\UserDataAuthenticationRequest',
-            'MediaWiki\\Auth\\CreationReasonAuthenticationRequest',
-        );
-
-        $requiredFields = array();
-        // Keep checkbox fields separate, since "required" actually means optional as absent == false.
-        $checkboxFields = array();
-
-        foreach ($requests as $req) {
-            // Immediately discard anything that is on the discard list.
-            if (in_array($req->id, $discardList)) {
-                continue;
-            }
-
-            $required = false;
-
-            if ($req->required === 'primary-required' && !in_array($req->id, $requireList)) {
-                // Only want one.
-                continue;
-            }
-
-            if (in_array($req->id, $requireList)) {
-                unset($requireList[$req->id]);
-                $required = true;
-            }
-
-            if ($req->required === 'required') {
-                $required = true;
-            }
-
-            if ($required) {
-                foreach ($req->fields as $name => $data) {
-                    if ($data->type === 'checkbox') {
-                        $checkboxFields[] = $name;
-                    }
-                    else {
-                        $requiredFields[] = $name;
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * @param string $username
-     * @return bool
-     */
-    public function checkAccountExists($username) {
-        $parameters = array(
-            'action'  => 'query',
-            'list'    => 'users',
-            'format'  => 'php',
-            'ususers' => $username,
-        );
-
-        $apiResult = $this->mediaWikiClient->doApiCall($parameters, 'GET');
-
-        $entry = $apiResult->query->users[0];
-        $exists = !isset($entry->missing);
-
-        return $exists;
-    }
+	/**
+	 * @var IMediaWikiClient
+	 */
+	private $mediaWikiClient;
+	/**
+	 * @var SiteConfiguration
+	 */
+	private $siteConfiguration;
+
+	/**
+	 * MediaWikiHelper constructor.
+	 *
+	 * @param IMediaWikiClient  $mediaWikiClient
+	 * @param SiteConfiguration $siteConfiguration
+	 */
+	public function __construct(IMediaWikiClient $mediaWikiClient, SiteConfiguration $siteConfiguration)
+	{
+		$this->mediaWikiClient = $mediaWikiClient;
+		$this->siteConfiguration = $siteConfiguration;
+	}
+
+	/**
+	 * @todo handle override antispoof and titleblacklist issues
+	 *
+	 * @param string $username
+	 * @param string $emailAddress
+	 * @param string $reason
+	 *
+	 * @throws Exception
+	 * @throws MediaWikiApiException
+	 */
+	public function createAccount($username, $emailAddress, $reason)
+	{
+		// get token
+		$tokenParams = array(
+			'action' => 'query',
+			'meta'   => 'tokens',
+			'type'   => 'createaccount',
+		);
+
+		$response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
+
+		if (isset($response->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		$token = $response->query->tokens->createaccounttoken;
+
+		$callback = $this->siteConfiguration->getBaseUrl() . '/internal.php/oauth/createCallback';
+
+		$checkboxFields = array();
+		$requiredFields = array();
+		$this->getCreationFieldData($requiredFields, $checkboxFields);
+
+		$apiCallData = array(
+			'action'              => 'createaccount',
+			'createreturnurl'     => $callback,
+			'createtoken'         => $token,
+			'createmessageformat' => 'html',
+		);
+
+		$createParams = array_fill_keys($requiredFields, '') + $apiCallData;
+
+		$createParams['username'] = $username;
+		$createParams['mailpassword'] = true;
+		$createParams['email'] = $emailAddress;
+		$createParams['reason'] = $reason;
+
+		$createResponse = $this->mediaWikiClient->doApiCall($createParams, 'POST');
+
+		if (isset($createResponse->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		if (!isset($createResponse->createaccount) || !isset($createResponse->createaccount->status)) {
+			throw new MediaWikiApiException('Unknown error creating account');
+		}
+
+		if ($createResponse->createaccount->status === 'FAIL') {
+			throw new MediaWikiApiException($createResponse->createaccount->message);
+		}
+
+		if ($createResponse->createaccount->status === 'PASS') {
+			// success!
+			return;
+		}
+
+		throw new Exception('API result reported status of ' . $createResponse->createaccount->status);
+	}
+
+	/**
+	 * @param string $username
+	 * @param string $title
+	 * @param        $summary
+	 * @param string $message
+	 * @param bool   $createOnly
+	 *
+	 * @throws MediaWikiApiException
+	 */
+	public function addTalkPageMessage($username, $title, $summary, $message, $createOnly = true)
+	{
+		// get token
+		$tokenParams = array(
+			'action' => 'query',
+			'meta'   => 'tokens',
+			'type'   => 'csrf',
+		);
+
+		$response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
+
+		if (isset($response->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		$token = $response->query->tokens->csrftoken;
+
+		if ($token === null) {
+			throw new MediaWikiApiException('Edit token could not be acquired');
+		}
+
+		$editParameters = array(
+			'action'       => 'edit',
+			'title'        => 'User talk:' . $username,
+			'section'      => 'new',
+			'sectiontitle' => $title,
+			'summary'      => $summary,
+			'text'         => $message,
+			'token'        => $token,
+		);
+
+		if ($createOnly) {
+			$editParameters['createonly'] = true;
+		}
+
+		$response = $this->mediaWikiClient->doApiCall($editParameters, 'POST');
+
+		if (!isset($response->edit)) {
+			if (isset($response->error)) {
+				throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+			}
+
+			throw new MediaWikiApiException('Unknown error encountered during editing.');
+		}
+
+		$editResponse = $response->edit;
+		if ($editResponse->result === "Success") {
+			return;
+		}
+
+		throw new MediaWikiApiException('Edit status unsuccessful: ' . $editResponse->result);
+	}
+
+	public function getCreationFieldData(&$requiredFields, &$checkboxFields)
+	{
+		// get token
+		$params = array(
+			'action'         => 'query',
+			'meta'           => 'authmanagerinfo',
+			'amirequestsfor' => 'create',
+		);
+
+		$response = $this->mediaWikiClient->doApiCall($params, 'GET');
+
+		if (isset($response->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		$requests = $response->query->authmanagerinfo->requests;
+
+		// We don't want to deal with these providers ever.
+		$discardList = array(
+			// Requires a username and password
+			'MediaWiki\\Auth\\PasswordAuthenticationRequest',
+		);
+
+		// We require these providers to function
+		$requireList = array(
+			'MediaWiki\\Auth\\TemporaryPasswordAuthenticationRequest',
+			'MediaWiki\\Auth\\UsernameAuthenticationRequest',
+			'MediaWiki\\Auth\\UserDataAuthenticationRequest',
+			'MediaWiki\\Auth\\CreationReasonAuthenticationRequest',
+		);
+
+		$requiredFields = array();
+		// Keep checkbox fields separate, since "required" actually means optional as absent == false.
+		$checkboxFields = array();
+
+		foreach ($requests as $req) {
+			// Immediately discard anything that is on the discard list.
+			if (in_array($req->id, $discardList)) {
+				continue;
+			}
+
+			$required = false;
+
+			if ($req->required === 'primary-required' && !in_array($req->id, $requireList)) {
+				// Only want one.
+				continue;
+			}
+
+			if (in_array($req->id, $requireList)) {
+				unset($requireList[$req->id]);
+				$required = true;
+			}
+
+			if ($req->required === 'required') {
+				$required = true;
+			}
+
+			if ($required) {
+				foreach ($req->fields as $name => $data) {
+					if ($data->type === 'checkbox') {
+						$checkboxFields[] = $name;
+					}
+					else {
+						$requiredFields[] = $name;
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * @param string $username
+	 * @return bool
+	 */
+	public function checkAccountExists($username) {
+		$parameters = array(
+			'action'  => 'query',
+			'list'    => 'users',
+			'format'  => 'php',
+			'ususers' => $username,
+		);
+
+		$apiResult = $this->mediaWikiClient->doApiCall($parameters, 'GET');
+
+		$entry = $apiResult->query->users[0];
+		$exists = !isset($entry->missing);
+
+		return $exists;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,12 +58,12 @@ 
         $response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
 
         if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+            throw new MediaWikiApiException($response->error->code.': '.$response->error->info);
         }
 
         $token = $response->query->tokens->createaccounttoken;
 
-        $callback = $this->siteConfiguration->getBaseUrl() . '/internal.php/oauth/createCallback';
+        $callback = $this->siteConfiguration->getBaseUrl().'/internal.php/oauth/createCallback';
 
         $checkboxFields = array();
         $requiredFields = array();
@@ -86,7 +86,7 @@ 
         $createResponse = $this->mediaWikiClient->doApiCall($createParams, 'POST');
 
         if (isset($createResponse->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+            throw new MediaWikiApiException($response->error->code.': '.$response->error->info);
         }
 
         if (!isset($createResponse->createaccount) || !isset($createResponse->createaccount->status)) {
@@ -102,7 +102,7 @@ 
             return;
         }
 
-        throw new Exception('API result reported status of ' . $createResponse->createaccount->status);
+        throw new Exception('API result reported status of '.$createResponse->createaccount->status);
     }
 
     /**
@@ -126,7 +126,7 @@ 
         $response = $this->mediaWikiClient->doApiCall($tokenParams, 'POST');
 
         if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+            throw new MediaWikiApiException($response->error->code.': '.$response->error->info);
         }
 
         $token = $response->query->tokens->csrftoken;
@@ -137,7 +137,7 @@ 
 
         $editParameters = array(
             'action'       => 'edit',
-            'title'        => 'User talk:' . $username,
+            'title'        => 'User talk:'.$username,
             'section'      => 'new',
             'sectiontitle' => $title,
             'summary'      => $summary,
@@ -153,7 +153,7 @@ 
 
         if (!isset($response->edit)) {
             if (isset($response->error)) {
-                throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+                throw new MediaWikiApiException($response->error->code.': '.$response->error->info);
             }
 
             throw new MediaWikiApiException('Unknown error encountered during editing.');
@@ -164,7 +164,7 @@ 
             return;
         }
 
-        throw new MediaWikiApiException('Edit status unsuccessful: ' . $editResponse->result);
+        throw new MediaWikiApiException('Edit status unsuccessful: '.$editResponse->result);
     }
 
     public function getCreationFieldData(&$requiredFields, &$checkboxFields)
@@ -179,7 +179,7 @@ 
         $response = $this->mediaWikiClient->doApiCall($params, 'GET');
 
         if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+            throw new MediaWikiApiException($response->error->code.': '.$response->error->info);
         }
 
         $requests = $response->query->authmanagerinfo->requests;

includes/Helpers/SearchHelpers/UserSearchHelper.php

Indentation +88 added lines, -88 removed lines

@@ -15,80 +15,80 @@ 
 
 class UserSearchHelper extends SearchHelperBase
 {
-    /**
-     * UserSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    public function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'user', User::class);
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return UserSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new UserSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * @param string $status
-     *
-     * @return $this
-     */
-    public function byStatus($status)
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    public function statusIn($statuses)
-    {
-        $this->inClause('status', $statuses);
-
-        return $this;
-    }
-
-    /**
-     * @param string $role
-     *
-     * @return $this
-     */
-    public function byRole($role)
-    {
-        $this->joinClause .= ' INNER JOIN userrole r on origin.id = r.user';
-        $this->whereClause .= ' AND r.role = ?';
-        $this->parameterList[] = $role;
-
-        return $this;
-    }
-
-    /**
-     * @param DateTime $instant
-     *
-     * @return $this
-     */
-    public function lastActiveBefore(DateTime $instant)
-    {
-        $this->whereClause .= ' AND origin.lastactive < ?';
-        $this->parameterList[] = $instant->format("Y-m-d H:i:s");
-
-        return $this;
-    }
-
-    public function getRoleMap(&$roleMap)
-    {
-        $query = <<<SQL
+	/**
+	 * UserSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	public function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'user', User::class);
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return UserSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new UserSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * @param string $status
+	 *
+	 * @return $this
+	 */
+	public function byStatus($status)
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	public function statusIn($statuses)
+	{
+		$this->inClause('status', $statuses);
+
+		return $this;
+	}
+
+	/**
+	 * @param string $role
+	 *
+	 * @return $this
+	 */
+	public function byRole($role)
+	{
+		$this->joinClause .= ' INNER JOIN userrole r on origin.id = r.user';
+		$this->whereClause .= ' AND r.role = ?';
+		$this->parameterList[] = $role;
+
+		return $this;
+	}
+
+	/**
+	 * @param DateTime $instant
+	 *
+	 * @return $this
+	 */
+	public function lastActiveBefore(DateTime $instant)
+	{
+		$this->whereClause .= ' AND origin.lastactive < ?';
+		$this->parameterList[] = $instant->format("Y-m-d H:i:s");
+
+		return $this;
+	}
+
+	public function getRoleMap(&$roleMap)
+	{
+		$query = <<<SQL
             SELECT /* UserSearchHelper/roleMap */ 
                   r.user user
                 , group_concat(r.role SEPARATOR ', ') roles 
@@ -97,22 +97,22 @@ 
             GROUP BY r.user
 SQL;
 
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
 
-        $roleMap = array();
-        foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $roleMap[$row['user']] = $row['roles'];
-        }
+		$roleMap = array();
+		foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$roleMap[$row['user']] = $row['roles'];
+		}
 
-        return $this;
-    }
+		return $this;
+	}
 
-    public function withReservedRequest()
-    {
-        $this->joinClause = ' INNER JOIN request req ON req.reserved = origin.id';
-        $this->groupByClause = ' GROUP BY origin.id, origin.username';
+	public function withReservedRequest()
+	{
+		$this->joinClause = ' INNER JOIN request req ON req.reserved = origin.id';
+		$this->groupByClause = ' GROUP BY origin.id, origin.username';
 
-        return $this->fetchMap('username');
-    }
+		return $this->fetchMap('username');
+	}
 }

includes/Helpers/SearchHelpers/JobQueueSearchHelper.php

Indentation +63 added lines, -63 removed lines

@@ -13,67 +13,67 @@
 
 class JobQueueSearchHelper extends SearchHelperBase
 {
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'jobqueue', JobQueue::class, null);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return JobQueueSearchHelper
-     */
-    public static function get(PdoDatabase $database) {
-        $helper = new JobQueueSearchHelper($database);
-        return $helper;
-    }
-
-    /**
-     * @param string[] $statuses
-     *
-     * @return $this
-     */
-    public function statusIn($statuses) {
-        $this->inClause('status', $statuses);
-
-        return $this;
-    }
-
-    /**
-     * @return $this
-     */
-    public function notAcknowledged() {
-        $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
-
-        return $this;
-    }
-
-    public function byTask($task) {
-        $this->whereClause .= ' AND task = ?';
-        $this->parameterList[] = $task;
-
-        return $this;
-    }
-
-    public function byUser($userId) {
-        $this->whereClause .= ' AND user = ?';
-        $this->parameterList[] = $userId;
-
-        return $this;
-    }
-
-    public function byStatus($status) {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    public function byRequest($request)
-    {
-        $this->whereClause .= ' AND request = ?';
-        $this->parameterList[] = $request;
-
-        return $this;
-    }
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'jobqueue', JobQueue::class, null);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return JobQueueSearchHelper
+	 */
+	public static function get(PdoDatabase $database) {
+		$helper = new JobQueueSearchHelper($database);
+		return $helper;
+	}
+
+	/**
+	 * @param string[] $statuses
+	 *
+	 * @return $this
+	 */
+	public function statusIn($statuses) {
+		$this->inClause('status', $statuses);
+
+		return $this;
+	}
+
+	/**
+	 * @return $this
+	 */
+	public function notAcknowledged() {
+		$this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
+
+		return $this;
+	}
+
+	public function byTask($task) {
+		$this->whereClause .= ' AND task = ?';
+		$this->parameterList[] = $task;
+
+		return $this;
+	}
+
+	public function byUser($userId) {
+		$this->whereClause .= ' AND user = ?';
+		$this->parameterList[] = $userId;
+
+		return $this;
+	}
+
+	public function byStatus($status) {
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	public function byRequest($request)
+	{
+		$this->whereClause .= ' AND request = ?';
+		$this->parameterList[] = $request;
+
+		return $this;
+	}
 }
\ No newline at end of file

Braces +12 added lines, -6 removed lines

@@ -23,7 +23,8 @@ 
      *
      * @return JobQueueSearchHelper
      */
-    public static function get(PdoDatabase $database) {
+    public static function get(PdoDatabase $database)
+    {
         $helper = new JobQueueSearchHelper($database);
         return $helper;
     }
@@ -33,7 +34,8 @@ 
      *
      * @return $this
      */
-    public function statusIn($statuses) {
+    public function statusIn($statuses)
+    {
         $this->inClause('status', $statuses);
 
         return $this;
@@ -42,27 +44,31 @@ 
     /**
      * @return $this
      */
-    public function notAcknowledged() {
+    public function notAcknowledged()
+    {
         $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
 
         return $this;
     }
 
-    public function byTask($task) {
+    public function byTask($task)
+    {
         $this->whereClause .= ' AND task = ?';
         $this->parameterList[] = $task;
 
         return $this;
     }
 
-    public function byUser($userId) {
+    public function byUser($userId)
+    {
         $this->whereClause .= ' AND user = ?';
         $this->parameterList[] = $userId;
 
         return $this;
     }
 
-    public function byStatus($status) {
+    public function byStatus($status)
+    {
         $this->whereClause .= ' AND status = ?';
         $this->parameterList[] = $status;
 

includes/Helpers/SearchHelpers/SearchHelperBase.php

Indentation +270 added lines, -270 removed lines

@@ -16,274 +16,274 @@
 
 abstract class SearchHelperBase
 {
-    /** @var PdoDatabase */
-    protected $database;
-    /** @var array */
-    protected $parameterList = array();
-    /** @var null|int */
-    private $limit = null;
-    /** @var null|int */
-    private $offset = null;
-    private $orderBy = null;
-    /**
-     * @var string The where clause.
-     *
-     * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
-     * that we use positional parameters instead of named parameters because we don't know many times different options
-     * will be called (looking at excluding() here, but there's the option for others).
-     */
-    protected $whereClause = ' WHERE 1 = 1';
-    /** @var string */
-    protected $table;
-    protected $joinClause = '';
-    protected $groupByClause = '';
-    protected $modifiersClause = '';
-    private $targetClass;
-
-    /**
-     * SearchHelperBase constructor.
-     *
-     * @param PdoDatabase $database
-     * @param string      $table
-     * @param             $targetClass
-     * @param null|string $order Order by clause, excluding ORDER BY.
-     */
-    protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
-    {
-        $this->database = $database;
-        $this->table = $table;
-        $this->orderBy = $order;
-        $this->targetClass = $targetClass;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning a set of objects.
-     *
-     * @return DataObject[]
-     */
-    public function fetch()
-    {
-        $statement = $this->getData();
-
-        /** @var DataObject[] $returnedObjects */
-        $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-        foreach ($returnedObjects as $req) {
-            $req->setDatabase($this->database);
-        }
-
-        return $returnedObjects;
-    }
-
-    /**
-     * @param string $whereClauseSection
-     * @param array  $values
-     *
-     * @return array
-     */
-    protected function fetchByParameter($whereClauseSection, $values)
-    {
-        $this->whereClause .= $whereClauseSection;
-
-        $countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $countQuery .= $this->joinClause . $this->whereClause;
-
-        $query = $this->buildQuery(array('*'));
-        $query .= $this->applyOrder();
-
-        // shuffle around hackily TODO: fix this abomination - T593
-        $localParameterList = $this->parameterList;
-        $this->parameterList = array();
-
-        $query .= $this->applyLimit();
-
-        $limitParameters = $this->parameterList;
-
-        $statement = $this->database->prepare($query);
-        $countStatement = $this->database->prepare($countQuery);
-
-        $result = array();
-        foreach ($values as $v) {
-            // reset parameter list
-            $params = $localParameterList;
-            $params[] = $v;
-
-            $countStatement->execute($params);
-
-            // reapply the limit parameters
-            $params = array_merge($params, $limitParameters);
-
-            $statement->execute($params);
-
-            /** @var DataObject[] $returnedObjects */
-            $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-            foreach ($returnedObjects as $req) {
-                $req->setDatabase($this->database);
-            }
-
-            $result[$v] = array(
-                'count' => $countStatement->fetchColumn(0),
-                'data'  => $returnedObjects,
-            );
-        }
-
-        return $result;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning only the requested column.
-     *
-     * @param string $column The required column
-     *
-     * @param bool   $distinct
-     *
-     * @return array
-     * @throws ApplicationLogicException
-     */
-    public function fetchColumn($column, $distinct = false)
-    {
-        if ($distinct) {
-            if ($this->groupByClause !== '') {
-                throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
-            }
-
-            $this->groupByClause = ' GROUP BY origin.' . $column;
-        }
-
-        $statement = $this->getData(array($column));
-
-        return $statement->fetchAll(PDO::FETCH_COLUMN);
-    }
-
-    public function fetchMap($column)
-    {
-        $statement = $this->getData(array('id', $column));
-
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $map = array();
-
-        foreach ($data as $row) {
-            $map[$row['id']] = $row[$column];
-        }
-
-        return $map;
-    }
-
-    /**
-     * @param int $count Returns the record count of the result set
-     *
-     * @return $this
-     */
-    public function getRecordCount(&$count)
-    {
-        $query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause;
-
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        $count = $statement->fetchColumn(0);
-        $statement->closeCursor();
-
-        return $this;
-    }
-
-    /**
-     * Limits the results
-     *
-     * @param integer      $limit
-     * @param integer|null $offset
-     *
-     * @return $this
-     *
-     */
-    public function limit($limit, $offset = null)
-    {
-        $this->limit = $limit;
-        $this->offset = $offset;
-
-        return $this;
-    }
-
-    private function applyLimit()
-    {
-        $clause = '';
-        if ($this->limit !== null) {
-            $clause = ' LIMIT ?';
-            $this->parameterList[] = $this->limit;
-
-            if ($this->offset !== null) {
-                $clause .= ' OFFSET ?';
-                $this->parameterList[] = $this->offset;
-            }
-        }
-
-        return $clause;
-    }
-
-    private function applyOrder()
-    {
-        if ($this->orderBy !== null) {
-            return ' ORDER BY ' . $this->orderBy;
-        }
-
-        return '';
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return PDOStatement
-     */
-    private function getData($columns = array('*'))
-    {
-        $query = $this->buildQuery($columns);
-        $query .= $this->applyOrder();
-        $query .= $this->applyLimit();
-
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        return $statement;
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return string
-     */
-    protected function buildQuery($columns)
-    {
-        $colData = array();
-        foreach ($columns as $c) {
-            $colData[] = 'origin.' . $c;
-        }
-
-        $query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause . $this->groupByClause;
-
-        return $query;
-    }
-
-    public function inIds($idList)
-    {
-        $this->inClause('id', $idList);
-
-        return $this;
-    }
-
-    protected function inClause($column, $values)
-    {
-        if (count($values) === 0) {
-            return;
-        }
-
-        // Urgh. OK. You can't use IN() with parameters directly, so let's munge something together.
-        $valueCount = count($values);
-
-        // Firstly, let's create a string of question marks, which will do as positional parameters.
-        $inSection = str_repeat('?,', $valueCount - 1) . '?';
-
-        $this->whereClause .= " AND {$column} IN ({$inSection})";
-        $this->parameterList = array_merge($this->parameterList, $values);
-    }
+	/** @var PdoDatabase */
+	protected $database;
+	/** @var array */
+	protected $parameterList = array();
+	/** @var null|int */
+	private $limit = null;
+	/** @var null|int */
+	private $offset = null;
+	private $orderBy = null;
+	/**
+	 * @var string The where clause.
+	 *
+	 * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
+	 * that we use positional parameters instead of named parameters because we don't know many times different options
+	 * will be called (looking at excluding() here, but there's the option for others).
+	 */
+	protected $whereClause = ' WHERE 1 = 1';
+	/** @var string */
+	protected $table;
+	protected $joinClause = '';
+	protected $groupByClause = '';
+	protected $modifiersClause = '';
+	private $targetClass;
+
+	/**
+	 * SearchHelperBase constructor.
+	 *
+	 * @param PdoDatabase $database
+	 * @param string      $table
+	 * @param             $targetClass
+	 * @param null|string $order Order by clause, excluding ORDER BY.
+	 */
+	protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
+	{
+		$this->database = $database;
+		$this->table = $table;
+		$this->orderBy = $order;
+		$this->targetClass = $targetClass;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning a set of objects.
+	 *
+	 * @return DataObject[]
+	 */
+	public function fetch()
+	{
+		$statement = $this->getData();
+
+		/** @var DataObject[] $returnedObjects */
+		$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+		foreach ($returnedObjects as $req) {
+			$req->setDatabase($this->database);
+		}
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * @param string $whereClauseSection
+	 * @param array  $values
+	 *
+	 * @return array
+	 */
+	protected function fetchByParameter($whereClauseSection, $values)
+	{
+		$this->whereClause .= $whereClauseSection;
+
+		$countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$countQuery .= $this->joinClause . $this->whereClause;
+
+		$query = $this->buildQuery(array('*'));
+		$query .= $this->applyOrder();
+
+		// shuffle around hackily TODO: fix this abomination - T593
+		$localParameterList = $this->parameterList;
+		$this->parameterList = array();
+
+		$query .= $this->applyLimit();
+
+		$limitParameters = $this->parameterList;
+
+		$statement = $this->database->prepare($query);
+		$countStatement = $this->database->prepare($countQuery);
+
+		$result = array();
+		foreach ($values as $v) {
+			// reset parameter list
+			$params = $localParameterList;
+			$params[] = $v;
+
+			$countStatement->execute($params);
+
+			// reapply the limit parameters
+			$params = array_merge($params, $limitParameters);
+
+			$statement->execute($params);
+
+			/** @var DataObject[] $returnedObjects */
+			$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+			foreach ($returnedObjects as $req) {
+				$req->setDatabase($this->database);
+			}
+
+			$result[$v] = array(
+				'count' => $countStatement->fetchColumn(0),
+				'data'  => $returnedObjects,
+			);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning only the requested column.
+	 *
+	 * @param string $column The required column
+	 *
+	 * @param bool   $distinct
+	 *
+	 * @return array
+	 * @throws ApplicationLogicException
+	 */
+	public function fetchColumn($column, $distinct = false)
+	{
+		if ($distinct) {
+			if ($this->groupByClause !== '') {
+				throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
+			}
+
+			$this->groupByClause = ' GROUP BY origin.' . $column;
+		}
+
+		$statement = $this->getData(array($column));
+
+		return $statement->fetchAll(PDO::FETCH_COLUMN);
+	}
+
+	public function fetchMap($column)
+	{
+		$statement = $this->getData(array('id', $column));
+
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$map = array();
+
+		foreach ($data as $row) {
+			$map[$row['id']] = $row[$column];
+		}
+
+		return $map;
+	}
+
+	/**
+	 * @param int $count Returns the record count of the result set
+	 *
+	 * @return $this
+	 */
+	public function getRecordCount(&$count)
+	{
+		$query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $this->whereClause;
+
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		$count = $statement->fetchColumn(0);
+		$statement->closeCursor();
+
+		return $this;
+	}
+
+	/**
+	 * Limits the results
+	 *
+	 * @param integer      $limit
+	 * @param integer|null $offset
+	 *
+	 * @return $this
+	 *
+	 */
+	public function limit($limit, $offset = null)
+	{
+		$this->limit = $limit;
+		$this->offset = $offset;
+
+		return $this;
+	}
+
+	private function applyLimit()
+	{
+		$clause = '';
+		if ($this->limit !== null) {
+			$clause = ' LIMIT ?';
+			$this->parameterList[] = $this->limit;
+
+			if ($this->offset !== null) {
+				$clause .= ' OFFSET ?';
+				$this->parameterList[] = $this->offset;
+			}
+		}
+
+		return $clause;
+	}
+
+	private function applyOrder()
+	{
+		if ($this->orderBy !== null) {
+			return ' ORDER BY ' . $this->orderBy;
+		}
+
+		return '';
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return PDOStatement
+	 */
+	private function getData($columns = array('*'))
+	{
+		$query = $this->buildQuery($columns);
+		$query .= $this->applyOrder();
+		$query .= $this->applyLimit();
+
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		return $statement;
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return string
+	 */
+	protected function buildQuery($columns)
+	{
+		$colData = array();
+		foreach ($columns as $c) {
+			$colData[] = 'origin.' . $c;
+		}
+
+		$query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $this->whereClause . $this->groupByClause;
+
+		return $query;
+	}
+
+	public function inIds($idList)
+	{
+		$this->inClause('id', $idList);
+
+		return $this;
+	}
+
+	protected function inClause($column, $values)
+	{
+		if (count($values) === 0) {
+			return;
+		}
+
+		// Urgh. OK. You can't use IN() with parameters directly, so let's munge something together.
+		$valueCount = count($values);
+
+		// Firstly, let's create a string of question marks, which will do as positional parameters.
+		$inSection = str_repeat('?,', $valueCount - 1) . '?';
+
+		$this->whereClause .= " AND {$column} IN ({$inSection})";
+		$this->parameterList = array_merge($this->parameterList, $values);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -84,8 +84,8 @@ 
     {
         $this->whereClause .= $whereClauseSection;
 
-        $countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $countQuery .= $this->joinClause . $this->whereClause;
+        $countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM '.$this->table.' origin ';
+        $countQuery .= $this->joinClause.$this->whereClause;
 
         $query = $this->buildQuery(array('*'));
         $query .= $this->applyOrder();
@@ -146,7 +146,7 @@ 
                 throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
             }
 
-            $this->groupByClause = ' GROUP BY origin.' . $column;
+            $this->groupByClause = ' GROUP BY origin.'.$column;
         }
 
         $statement = $this->getData(array($column));
@@ -175,8 +175,8 @@ 
      */
     public function getRecordCount(&$count)
     {
-        $query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause;
+        $query = 'SELECT /* SearchHelper */ COUNT(*) FROM '.$this->table.' origin ';
+        $query .= $this->joinClause.$this->whereClause;
 
         $statement = $this->database->prepare($query);
         $statement->execute($this->parameterList);
@@ -223,7 +223,7 @@ 
     private function applyOrder()
     {
         if ($this->orderBy !== null) {
-            return ' ORDER BY ' . $this->orderBy;
+            return ' ORDER BY '.$this->orderBy;
         }
 
         return '';
@@ -255,11 +255,11 @@ 
     {
         $colData = array();
         foreach ($columns as $c) {
-            $colData[] = 'origin.' . $c;
+            $colData[] = 'origin.'.$c;
         }
 
-        $query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause . $this->groupByClause;
+        $query = "SELECT {$this->modifiersClause} /* SearchHelper */ ".implode(', ', $colData).' FROM '.$this->table.' origin ';
+        $query .= $this->joinClause.$this->whereClause.$this->groupByClause;
 
         return $query;
     }
@@ -281,7 +281,7 @@ 
         $valueCount = count($values);
 
         // Firstly, let's create a string of question marks, which will do as positional parameters.
-        $inSection = str_repeat('?,', $valueCount - 1) . '?';
+        $inSection = str_repeat('?,', $valueCount - 1).'?';
 
         $this->whereClause .= " AND {$column} IN ({$inSection})";
         $this->parameterList = array_merge($this->parameterList, $values);

includes/Helpers/SearchHelpers/RequestSearchHelper.php

Indentation +174 added lines, -174 removed lines

@@ -15,178 +15,178 @@
 
 class RequestSearchHelper extends SearchHelperBase
 {
-    /**
-     * RequestSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'request', Request::class);
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return RequestSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new RequestSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * Filters the results by IP address
-     *
-     * @param string $ipAddress
-     *
-     * @return $this
-     */
-    public function byIp($ipAddress)
-    {
-        $this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
-        $this->parameterList[] = $ipAddress;
-        $this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by email address
-     *
-     * @param string $emailAddress
-     *
-     * @return $this
-     */
-    public function byEmailAddress($emailAddress)
-    {
-        $this->whereClause .= ' AND email LIKE ?';
-        $this->parameterList[] = $emailAddress;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by name
-     *
-     * @param string $name
-     *
-     * @return $this
-     */
-    public function byName($name)
-    {
-        $this->whereClause .= ' AND name LIKE ?';
-        $this->parameterList[] = $name;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those with a defined status
-     *
-     * @param $status
-     *
-     * @return $this
-     */
-    public function byStatus($status)
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    /**
-     * Excludes a request from the results
-     *
-     * @param int $requestId
-     *
-     * @return $this
-     */
-    public function excludingRequest($requestId)
-    {
-        $this->whereClause .= ' AND id <> ?';
-        $this->parameterList[] = $requestId;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to only those with a confirmed email address
-     *
-     * @return $this
-     */
-    public function withConfirmedEmail()
-    {
-        $this->whereClause .= ' AND emailconfirm = ?';
-        $this->parameterList[] = 'Confirmed';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to exclude purged data
-     *
-     * @param SiteConfiguration $configuration
-     *
-     * @return $this
-     */
-    public function excludingPurgedData(SiteConfiguration $configuration)
-    {
-        $this->whereClause .= ' AND ip <> ? AND email <> ?';
-        $this->parameterList[] = $configuration->getDataClearIp();
-        $this->parameterList[] = $configuration->getDataClearEmail();
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those without a defined status
-     *
-     * @param $status
-     *
-     * @return $this
-     */
-    public function excludingStatus($status)
-    {
-        $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those which have failed an auto-creation
-     *
-     * @return $this
-     */
-    public function isHospitalised()
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those which have not failed an auto-creation
-     *
-     * @return $this
-     */
-    public function notHospitalised()
-    {
-        $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
-
-        return $this;
-    }
-
-    public function fetchByStatus($statuses)
-    {
-        return $this->fetchByParameter(' AND status = ?', $statuses);
-    }
+	/**
+	 * RequestSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'request', Request::class);
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return RequestSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new RequestSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * Filters the results by IP address
+	 *
+	 * @param string $ipAddress
+	 *
+	 * @return $this
+	 */
+	public function byIp($ipAddress)
+	{
+		$this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
+		$this->parameterList[] = $ipAddress;
+		$this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by email address
+	 *
+	 * @param string $emailAddress
+	 *
+	 * @return $this
+	 */
+	public function byEmailAddress($emailAddress)
+	{
+		$this->whereClause .= ' AND email LIKE ?';
+		$this->parameterList[] = $emailAddress;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by name
+	 *
+	 * @param string $name
+	 *
+	 * @return $this
+	 */
+	public function byName($name)
+	{
+		$this->whereClause .= ' AND name LIKE ?';
+		$this->parameterList[] = $name;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those with a defined status
+	 *
+	 * @param $status
+	 *
+	 * @return $this
+	 */
+	public function byStatus($status)
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	/**
+	 * Excludes a request from the results
+	 *
+	 * @param int $requestId
+	 *
+	 * @return $this
+	 */
+	public function excludingRequest($requestId)
+	{
+		$this->whereClause .= ' AND id <> ?';
+		$this->parameterList[] = $requestId;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to only those with a confirmed email address
+	 *
+	 * @return $this
+	 */
+	public function withConfirmedEmail()
+	{
+		$this->whereClause .= ' AND emailconfirm = ?';
+		$this->parameterList[] = 'Confirmed';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to exclude purged data
+	 *
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return $this
+	 */
+	public function excludingPurgedData(SiteConfiguration $configuration)
+	{
+		$this->whereClause .= ' AND ip <> ? AND email <> ?';
+		$this->parameterList[] = $configuration->getDataClearIp();
+		$this->parameterList[] = $configuration->getDataClearEmail();
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those without a defined status
+	 *
+	 * @param $status
+	 *
+	 * @return $this
+	 */
+	public function excludingStatus($status)
+	{
+		$this->whereClause .= ' AND status <> ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those which have failed an auto-creation
+	 *
+	 * @return $this
+	 */
+	public function isHospitalised()
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] =  RequestStatus::HOSPITAL;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those which have not failed an auto-creation
+	 *
+	 * @return $this
+	 */
+	public function notHospitalised()
+	{
+		$this->whereClause .= ' AND status <> ?';
+		$this->parameterList[] =  RequestStatus::HOSPITAL;
+
+		return $this;
+	}
+
+	public function fetchByStatus($statuses)
+	{
+		return $this->fetchByParameter(' AND status = ?', $statuses);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
     {
         $this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
         $this->parameterList[] = $ipAddress;
-        $this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
+        $this->parameterList[] = '%'.trim($ipAddress, '%').'%';
 
         return $this;
     }
@@ -167,7 +167,7 @@ 
     public function isHospitalised()
     {
         $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
+        $this->parameterList[] = RequestStatus::HOSPITAL;
 
         return $this;
     }
@@ -180,7 +180,7 @@ 
     public function notHospitalised()
     {
         $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
+        $this->parameterList[] = RequestStatus::HOSPITAL;
 
         return $this;
     }

includes/Helpers/LogHelper.php

Indentation +402 added lines, -402 removed lines

@@ -27,413 +27,413 @@
 
 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',
-            'JobIssue'            => 'ran a background job unsuccessfully',
-            'JobCompleted'        => 'completed a background job',
-            'JobAcknowledged'     => 'acknowledged a job failure',
-            'JobRequeued'         => 'requeued a job for re-execution',
-            'EnqueuedJobQueue'    => 'scheduled for creation',
-            'Hospitalised'        => 'sent to the hospital',
-        );
-
-        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',
-            'JobIssue'            => 'ran a background job unsuccessfully',
-            'JobCompleted'        => 'completed a background job',
-            'JobAcknowledged'     => 'acknowledged a job failure',
-            'JobRequeued'         => 'requeued a job for re-execution',
-            'EnqueuedJobQueue'    => 'scheduled for creation',
-            'Hospitalised'        => 'sent to the hospital',
-        );
-
-        $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',
+			'JobIssue'            => 'ran a background job unsuccessfully',
+			'JobCompleted'        => 'completed a background job',
+			'JobAcknowledged'     => 'acknowledged a job failure',
+			'JobRequeued'         => 'requeued a job for re-execution',
+			'EnqueuedJobQueue'    => 'scheduled for creation',
+			'Hospitalised'        => 'sent to the hospital',
+		);
+
+		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',
+			'JobIssue'            => 'ran a background job unsuccessfully',
+			'JobCompleted'        => 'completed a background job',
+			'JobAcknowledged'     => 'acknowledged a job failure',
+			'JobRequeued'         => 'requeued a job for re-execution',
+			'EnqueuedJobQueue'    => 'scheduled for creation',
+			'Hospitalised'        => 'sent to the hospital',
+		);
+
+		$statement = $database->query(<<<SQL
 SELECT CONCAT('Closed ', id) AS k, CONCAT('closed (',name,')') AS v
 FROM emailtemplate;
 SQL
-        );
-        foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $lookup[$row['k']] = $row['v'];
-        }
-
-        return $lookup;
-    }
-
-    public static function getObjectTypes()
-    {
-        return array(
-            'Ban'             => 'Ban',
-            'Comment'         => 'Comment',
-            'EmailTemplate'   => 'Email template',
-            'JobQueue'        => 'Job queue item',
-            'Request'         => 'Request',
-            'SiteNotice'      => 'Site notice',
-            'User'            => 'User',
-            'WelcomeTemplate' => 'Welcome template',
-        );
-    }
-
-    /**
-     * This returns a HTML
-     *
-     * @param string            $objectId
-     * @param string            $objectType
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return null|string
-     * @category Security-Critical
-     */
-    private static function getObjectDescription(
-        $objectId,
-        $objectType,
-        PdoDatabase $database,
-        SiteConfiguration $configuration
-    ) {
-        if ($objectType == '') {
-            return null;
-        }
-
-        $baseurl = $configuration->getBaseUrl();
-
-        switch ($objectType) {
-            case 'Ban':
-                /** @var Ban $ban */
-                $ban = Ban::getById($objectId, $database);
-
-                if ($ban === false) {
-                    return 'Ban #' . $objectId . "</a>";
-                }
-
-                return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
-            case 'EmailTemplate':
-                /** @var EmailTemplate $emailTemplate */
-                $emailTemplate = EmailTemplate::getById($objectId, $database);
-                $name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+		);
+		foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$lookup[$row['k']] = $row['v'];
+		}
+
+		return $lookup;
+	}
+
+	public static function getObjectTypes()
+	{
+		return array(
+			'Ban'             => 'Ban',
+			'Comment'         => 'Comment',
+			'EmailTemplate'   => 'Email template',
+			'JobQueue'        => 'Job queue item',
+			'Request'         => 'Request',
+			'SiteNotice'      => 'Site notice',
+			'User'            => 'User',
+			'WelcomeTemplate' => 'Welcome template',
+		);
+	}
+
+	/**
+	 * This returns a HTML
+	 *
+	 * @param string            $objectId
+	 * @param string            $objectType
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return null|string
+	 * @category Security-Critical
+	 */
+	private static function getObjectDescription(
+		$objectId,
+		$objectType,
+		PdoDatabase $database,
+		SiteConfiguration $configuration
+	) {
+		if ($objectType == '') {
+			return null;
+		}
+
+		$baseurl = $configuration->getBaseUrl();
+
+		switch ($objectType) {
+			case 'Ban':
+				/** @var Ban $ban */
+				$ban = Ban::getById($objectId, $database);
+
+				if ($ban === false) {
+					return 'Ban #' . $objectId . "</a>";
+				}
+
+				return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
+			case 'EmailTemplate':
+				/** @var EmailTemplate $emailTemplate */
+				$emailTemplate = EmailTemplate::getById($objectId, $database);
+				$name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/emailManagement/view?id={$objectId}">Email Template #{$objectId} ({$name})</a>
 HTML;
-            case 'SiteNotice':
-                return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
-            case 'Request':
-                /** @var Request $request */
-                $request = Request::getById($objectId, $database);
-                $name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+			case 'SiteNotice':
+				return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
+			case 'Request':
+				/** @var Request $request */
+				$request = Request::getById($objectId, $database);
+				$name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/viewRequest?id={$objectId}">Request #{$objectId} ({$name})</a>
 HTML;
-            case 'User':
-                /** @var User $user */
-                $user = User::getById($objectId, $database);
-                $username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
-            case 'WelcomeTemplate':
-                /** @var WelcomeTemplate $welcomeTemplate */
-                $welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
-
-                // some old templates have been completely deleted and lost to the depths of time.
-                if ($welcomeTemplate === false) {
-                    return "Welcome template #{$objectId}";
-                }
-                else {
-                    $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
-
-                    return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
-                }
-            case 'JobQueue':
-                /** @var JobQueue $job */
-                $job = JobQueue::getById($objectId, $database);
-
-                $taskDescriptions = JobQueue::getTaskDescriptions();
-
-                $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
-                    $description = $taskDescriptions[$task];
-                } else {
-                    $description = 'Unknown task';
-                }
-
-                return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
-            default:
-                return '[' . $objectType . " " . $objectId . ']';
-        }
-    }
-
-    /**
-     * @param Log[]             $logs
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
-    {
-        $userIds = array();
-
-        /** @var Log $logEntry */
-        foreach ($logs as $logEntry) {
-            if (!$logEntry instanceof Log) {
-                // if this happens, we've done something wrong with passing back the log data.
-                throw new Exception('Log entry is not an instance of a Log, this should never happen.');
-            }
-
-            $user = $logEntry->getUser();
-            if ($user === -1) {
-                continue;
-            }
-
-            if (!array_search($user, $userIds)) {
-                $userIds[] = $user;
-            }
-        }
-
-        $users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
-        $users[-1] = User::getCommunity()->getUsername();
-
-        $logData = array();
-
-        /** @var Log $logEntry */
-        foreach ($logs as $logEntry) {
-            $objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
-                $database, $configuration);
-
-            switch ($logEntry->getAction()) {
-                case 'Renamed':
-                    $renameData = unserialize($logEntry->getComment());
-                    $oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
-                    $newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
-                    $comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
-                    break;
-                case 'RoleChange':
-                    $roleChangeData = unserialize($logEntry->getComment());
-
-                    $removed = array();
-                    foreach ($roleChangeData['removed'] as $r) {
-                        $removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $added = array();
-                    foreach ($roleChangeData['added'] as $r) {
-                        $added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
-
-                    $roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
-                    $comment = $roleDelta . ' with comment: ' . $reason;
-                    break;
-                case 'JobIssue':
-                    $jobIssueData = unserialize($logEntry->getComment());
-                    $errorMessage = $jobIssueData['error'];
-                    $status = $jobIssueData['status'];
-
-                    $comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
-                    $comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
-                    break;
-                case 'JobIssueRequest':
-                case 'JobCompletedRequest':
-                    $jobData = unserialize($logEntry->getComment());
-
-                    /** @var JobQueue $job */
-                    $job = JobQueue::getById($jobData['job'], $database);
-                    $descs = JobQueue::getTaskDescriptions();
-                    $comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
-                    break;
-
-                case 'JobCompleted':
-                    break;
-                default:
-                    $comment = $logEntry->getComment();
-                    break;
-            }
-
-            $logData[] = array(
-                'timestamp'         => $logEntry->getTimestamp(),
-                'userid'            => $logEntry->getUser(),
-                'username'          => $users[$logEntry->getUser()],
-                'description'       => self::getLogDescription($logEntry),
-                'objectdescription' => $objectDescription,
-                'comment'           => $comment,
-            );
-        }
-
-        return array($users, $logData);
-    }
+			case 'User':
+				/** @var User $user */
+				$user = User::getById($objectId, $database);
+				$username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
+			case 'WelcomeTemplate':
+				/** @var WelcomeTemplate $welcomeTemplate */
+				$welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
+
+				// some old templates have been completely deleted and lost to the depths of time.
+				if ($welcomeTemplate === false) {
+					return "Welcome template #{$objectId}";
+				}
+				else {
+					$userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
+
+					return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
+				}
+			case 'JobQueue':
+				/** @var JobQueue $job */
+				$job = JobQueue::getById($objectId, $database);
+
+				$taskDescriptions = JobQueue::getTaskDescriptions();
+
+				$task = $job->getTask();
+				if(isset($taskDescriptions[$task])){
+					$description = $taskDescriptions[$task];
+				} else {
+					$description = 'Unknown task';
+				}
+
+				return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
+			default:
+				return '[' . $objectType . " " . $objectId . ']';
+		}
+	}
+
+	/**
+	 * @param Log[]             $logs
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
+	{
+		$userIds = array();
+
+		/** @var Log $logEntry */
+		foreach ($logs as $logEntry) {
+			if (!$logEntry instanceof Log) {
+				// if this happens, we've done something wrong with passing back the log data.
+				throw new Exception('Log entry is not an instance of a Log, this should never happen.');
+			}
+
+			$user = $logEntry->getUser();
+			if ($user === -1) {
+				continue;
+			}
+
+			if (!array_search($user, $userIds)) {
+				$userIds[] = $user;
+			}
+		}
+
+		$users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
+		$users[-1] = User::getCommunity()->getUsername();
+
+		$logData = array();
+
+		/** @var Log $logEntry */
+		foreach ($logs as $logEntry) {
+			$objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
+				$database, $configuration);
+
+			switch ($logEntry->getAction()) {
+				case 'Renamed':
+					$renameData = unserialize($logEntry->getComment());
+					$oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
+					$newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
+					$comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
+					break;
+				case 'RoleChange':
+					$roleChangeData = unserialize($logEntry->getComment());
+
+					$removed = array();
+					foreach ($roleChangeData['removed'] as $r) {
+						$removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$added = array();
+					foreach ($roleChangeData['added'] as $r) {
+						$added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
+
+					$roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
+					$comment = $roleDelta . ' with comment: ' . $reason;
+					break;
+				case 'JobIssue':
+					$jobIssueData = unserialize($logEntry->getComment());
+					$errorMessage = $jobIssueData['error'];
+					$status = $jobIssueData['status'];
+
+					$comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
+					$comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
+					break;
+				case 'JobIssueRequest':
+				case 'JobCompletedRequest':
+					$jobData = unserialize($logEntry->getComment());
+
+					/** @var JobQueue $job */
+					$job = JobQueue::getById($jobData['job'], $database);
+					$descs = JobQueue::getTaskDescriptions();
+					$comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
+					break;
+
+				case 'JobCompleted':
+					break;
+				default:
+					$comment = $logEntry->getComment();
+					break;
+			}
+
+			$logData[] = array(
+				'timestamp'         => $logEntry->getTimestamp(),
+				'userid'            => $logEntry->getUser(),
+				'username'          => $users[$logEntry->getUser()],
+				'description'       => self::getLogDescription($logEntry),
+				'objectdescription' => $objectDescription,
+				'comment'           => $comment,
+			);
+		}
+
+		return array($users, $logData);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -129,7 +129,7 @@ 
             $template = EmailTemplate::getById((int)$id, $entry->getDatabase());
 
             if ($template != false) {
-                return "closed (" . $template->getName() . ")";
+                return "closed (".$template->getName().")";
             }
         }
 
@@ -275,10 +275,10 @@ 
                 $ban = Ban::getById($objectId, $database);
 
                 if ($ban === false) {
-                    return 'Ban #' . $objectId . "</a>";
+                    return 'Ban #'.$objectId."</a>";
                 }
 
-                return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
+                return 'Ban #'.$objectId." (".htmlentities($ban->getTarget()).")</a>";
             case 'EmailTemplate':
                 /** @var EmailTemplate $emailTemplate */
                 $emailTemplate = EmailTemplate::getById($objectId, $database);
@@ -323,7 +323,7 @@ 
                 $taskDescriptions = JobQueue::getTaskDescriptions();
 
                 $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
+                if (isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
                 } else {
                     $description = 'Unknown task';
@@ -331,7 +331,7 @@ 
 
                 return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
             default:
-                return '[' . $objectType . " " . $objectId . ']';
+                return '['.$objectType." ".$objectId.']';
         }
     }
 
@@ -379,7 +379,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.'\'.';
                     break;
                 case 'RoleChange':
                     $roleChangeData = unserialize($logEntry->getComment());
@@ -396,15 +396,15 @@ 
 
                     $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;
                     break;
                 case 'JobIssue':
                     $jobIssueData = unserialize($logEntry->getComment());
                     $errorMessage = $jobIssueData['error'];
                     $status = $jobIssueData['status'];
 
-                    $comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
+                    $comment = 'Job '.htmlentities($status, ENT_COMPAT, 'UTF-8').': ';
                     $comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
                     break;
                 case 'JobIssueRequest':

Braces +3 added lines, -2 removed lines

@@ -323,9 +323,10 @@
                 $taskDescriptions = JobQueue::getTaskDescriptions();
 
                 $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
+                if(isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
-                } else {
+                }
+                else {
                     $description = 'Unknown task';
                 }
 

includes/Helpers/Logger.php

Indentation +353 added lines, -353 removed lines

@@ -31,357 +31,357 @@
  */
 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
-     * @param User|null   $logUser
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
-    }
-
-    /**
-     * @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);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'EnqueuedJobQueue');
-    }
-
-    public static function hospitalised(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'Hospitalised');
-    }
-    #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
-
-    #region Automation
-
-    public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
-    }
-
-    public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
-    {
-        $data = array('status' => $job->getStatus(), 'error' => $job->getError());
-        self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
-    }
-
-    public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobRequeued');
-    }
-
-    public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobAcknowledged');
-    }
-    #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
+	 * @param User|null   $logUser
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
+	}
+
+	/**
+	 * @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);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'EnqueuedJobQueue');
+	}
+
+	public static function hospitalised(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'Hospitalised');
+	}
+	#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
+
+	#region Automation
+
+	public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
+	}
+
+	public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
+	{
+		$data = array('status' => $job->getStatus(), 'error' => $job->getError());
+		self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
+	}
+
+	public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobRequeued');
+	}
+
+	public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobAcknowledged');
+	}
+	#endregion
 }