enwikipedia-acc / waca

includes/Helpers/RequestEmailHelper.php

Indentation +46 added lines, -46 removed lines

@@ -14,50 +14,50 @@
 
 class RequestEmailHelper
 {
-    /**
-     * @var IEmailHelper
-     */
-    private $emailHelper;
-
-    /**
-     * RequestEmailHelper constructor.
-     *
-     * @param IEmailHelper $emailHelper
-     */
-    public function __construct(IEmailHelper $emailHelper)
-    {
-        $this->emailHelper = $emailHelper;
-    }
-
-    /**
-     * @param Request $request
-     * @param string  $mailText
-     * @param User    $currentUser
-     * @param boolean $ccMailingList
-     */
-    public function sendMail(Request $request, $mailText, User $currentUser, $ccMailingList)
-    {
-        $headers = array(
-            'X-ACC-Request' => $request->getId(),
-            'X-ACC-UserID'  => $currentUser->getId(),
-        );
-
-        if ($ccMailingList) {
-            $headers['Cc'] = 'accounts-enwiki-l@lists.wikimedia.org';
-        }
-
-        $helper = $this->emailHelper;
-
-        $emailSig = $currentUser->getEmailSig();
-        if ($emailSig !== '' || $emailSig !== null) {
-            $emailSig = "\n\n" . $emailSig;
-        }
-
-        $subject = "RE: [ACC #{$request->getId()}] English Wikipedia Account Request";
-        $content = $mailText . $emailSig;
-
-        $helper->sendMail($request->getEmail(), $subject, $content, $headers);
-
-        $request->setEmailSent(true);
-    }
+	/**
+	 * @var IEmailHelper
+	 */
+	private $emailHelper;
+
+	/**
+	 * RequestEmailHelper constructor.
+	 *
+	 * @param IEmailHelper $emailHelper
+	 */
+	public function __construct(IEmailHelper $emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
+
+	/**
+	 * @param Request $request
+	 * @param string  $mailText
+	 * @param User    $currentUser
+	 * @param boolean $ccMailingList
+	 */
+	public function sendMail(Request $request, $mailText, User $currentUser, $ccMailingList)
+	{
+		$headers = array(
+			'X-ACC-Request' => $request->getId(),
+			'X-ACC-UserID'  => $currentUser->getId(),
+		);
+
+		if ($ccMailingList) {
+			$headers['Cc'] = 'accounts-enwiki-l@lists.wikimedia.org';
+		}
+
+		$helper = $this->emailHelper;
+
+		$emailSig = $currentUser->getEmailSig();
+		if ($emailSig !== '' || $emailSig !== null) {
+			$emailSig = "\n\n" . $emailSig;
+		}
+
+		$subject = "RE: [ACC #{$request->getId()}] English Wikipedia Account Request";
+		$content = $mailText . $emailSig;
+
+		$helper->sendMail($request->getEmail(), $subject, $content, $headers);
+
+		$request->setEmailSent(true);
+	}
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -239,11 +239,11 @@
 
         $emailSig = $currentUser->getEmailSig();
         if ($emailSig !== '' || $emailSig !== null) {
-            $emailSig = "\n\n" . $emailSig;
+            $emailSig = "\n\n".$emailSig;
         }
 
         $subject = "RE: [ACC #{$request->getId()}] English Wikipedia Account Request";
-        $content = $mailText . $emailSig;
+        $content = $mailText.$emailSig;
 
         $helper->sendMail($request->getEmail(), $subject, $content, $headers);
 

includes/Helpers/OAuthProtocolHelper.php

Indentation +226 added lines, -226 removed lines

@@ -22,233 +22,233 @@
 
 class OAuthProtocolHelper implements IOAuthProtocolHelper
 {
-    private $oauthConsumer;
-    /**
-     * @var string
-     */
-    private $oauthEndpoint;
-    /**
-     * @var string
-     */
-    private $consumerToken;
-    /**
-     * @var string
-     */
-    private $consumerSecret;
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-    /**
-     * @var string
-     */
-    private $mediawikiWebServiceEndpoint;
-
-    /**
-     * OAuthHelper constructor.
-     *
-     * @param string     $oauthEndpoint
-     * @param string     $consumerKey
-     * @param string     $consumerSecret
-     * @param HttpHelper $httpHelper
-     * @param string     $mediawikiWebServiceEndpoint
-     */
-    public function __construct(
-        $oauthEndpoint,
-        $consumerKey,
-        $consumerSecret,
-        HttpHelper $httpHelper,
-        $mediawikiWebServiceEndpoint
-    ) {
-        $this->oauthEndpoint = $oauthEndpoint;
-        $this->consumerToken = $consumerKey;
-        $this->consumerSecret = $consumerSecret;
-        $this->httpHelper = $httpHelper;
-
-        $this->oauthConsumer = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
-        $this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
-    }
-
-    /**
-     * @return stdClass
-     *
-     * @throws Exception
-     * @throws CurlException
-     */
-    public function getRequestToken()
-    {
-        $endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
-
-        $parsedUrl = parse_url($endpoint);
-        $urlParameters = array();
-        parse_str($parsedUrl['query'], $urlParameters);
-
-        $req_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, null, 'GET', $endpoint, $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $req_req->sign_request($hmac_method, $this->oauthConsumer, null);
-
-        $targetUrl = (string)$req_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $token = json_decode($data);
-
-        if (!isset($token)) {
-            throw new OAuthException('Unknown error encountered getting request token while decoding json data.');
-        }
-
-        if (isset($token->error)) {
-            throw new OAuthException('Error encountered while getting request token: ' . $token->error);
-        }
-
-        return $token;
-    }
-
-    /**
-     * @param string $requestToken
-     *
-     * @return string
-     */
-    public function getAuthoriseUrl($requestToken)
-    {
-        return "{$this->oauthEndpoint}/authorize&oauth_token={$requestToken}&oauth_consumer_key={$this->consumerToken}";
-    }
-
-    /**
-     * @param string $oauthRequestToken
-     * @param string $oauthRequestSecret
-     * @param string $oauthVerifier
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
-    {
-        $endpoint = $this->oauthEndpoint . '/token&format=json';
-
-        $requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
-
-        $parsedUrl = parse_url($endpoint);
-        parse_str($parsedUrl['query'], $urlParameters);
-        $urlParameters['oauth_verifier'] = trim($oauthVerifier);
-
-        $acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $requestConsumer, 'GET', $endpoint,
-            $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $acc_req->sign_request($hmac_method, $this->oauthConsumer, $requestConsumer);
-
-        $targetUrl = (string)$acc_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $token = json_decode($data);
-
-        if (!isset($token)) {
-            throw new OAuthException('Unknown error encountered getting access token while decoding json data.');
-        }
-
-        if (isset($token->error)) {
-            throw new OAuthException('Error encountered while getting access token: ' . $token->error);
-        }
-
-        return $token;
-    }
-
-    /**
-     * @param string $oauthAccessToken
-     * @param string $oauthAccessSecret
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
-    {
-        $endpoint = $this->oauthEndpoint . '/identify&format=json';
-
-        $oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
-
-        $parsedUrl = parse_url($endpoint);
-        parse_str($parsedUrl['query'], $urlParameters);
-
-        $acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $oauthToken, 'GET', $endpoint,
-            $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $acc_req->sign_request($hmac_method, $this->oauthConsumer, $oauthToken);
-
-        $targetUrl = (string)$acc_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $decodedData = json_decode($data);
-
-        if (isset($decodedData->error)) {
-            throw new OAuthException($decodedData->error);
-        }
-
-        $identity = JWT::decode($data, $this->consumerSecret);
-
-        return $identity;
-    }
-
-    /**
-     * @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')
-    {
-        $userToken = new OAuthToken($accessToken, $accessSecret);
-
-        $apiParams['format'] = 'json';
-
-        $api_req = OAuthRequest::from_consumer_and_token(
-            $this->oauthConsumer, // Consumer
-            $userToken, // User Access Token
-            $method, // HTTP Method
-            $this->mediawikiWebServiceEndpoint, // Endpoint url
-            $apiParams    // Extra signed parameters
-        );
+	private $oauthConsumer;
+	/**
+	 * @var string
+	 */
+	private $oauthEndpoint;
+	/**
+	 * @var string
+	 */
+	private $consumerToken;
+	/**
+	 * @var string
+	 */
+	private $consumerSecret;
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+	/**
+	 * @var string
+	 */
+	private $mediawikiWebServiceEndpoint;
+
+	/**
+	 * OAuthHelper constructor.
+	 *
+	 * @param string     $oauthEndpoint
+	 * @param string     $consumerKey
+	 * @param string     $consumerSecret
+	 * @param HttpHelper $httpHelper
+	 * @param string     $mediawikiWebServiceEndpoint
+	 */
+	public function __construct(
+		$oauthEndpoint,
+		$consumerKey,
+		$consumerSecret,
+		HttpHelper $httpHelper,
+		$mediawikiWebServiceEndpoint
+	) {
+		$this->oauthEndpoint = $oauthEndpoint;
+		$this->consumerToken = $consumerKey;
+		$this->consumerSecret = $consumerSecret;
+		$this->httpHelper = $httpHelper;
+
+		$this->oauthConsumer = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
+		$this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
+	}
+
+	/**
+	 * @return stdClass
+	 *
+	 * @throws Exception
+	 * @throws CurlException
+	 */
+	public function getRequestToken()
+	{
+		$endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
+
+		$parsedUrl = parse_url($endpoint);
+		$urlParameters = array();
+		parse_str($parsedUrl['query'], $urlParameters);
+
+		$req_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, null, 'GET', $endpoint, $urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$req_req->sign_request($hmac_method, $this->oauthConsumer, null);
+
+		$targetUrl = (string)$req_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$token = json_decode($data);
+
+		if (!isset($token)) {
+			throw new OAuthException('Unknown error encountered getting request token while decoding json data.');
+		}
+
+		if (isset($token->error)) {
+			throw new OAuthException('Error encountered while getting request token: ' . $token->error);
+		}
+
+		return $token;
+	}
+
+	/**
+	 * @param string $requestToken
+	 *
+	 * @return string
+	 */
+	public function getAuthoriseUrl($requestToken)
+	{
+		return "{$this->oauthEndpoint}/authorize&oauth_token={$requestToken}&oauth_consumer_key={$this->consumerToken}";
+	}
+
+	/**
+	 * @param string $oauthRequestToken
+	 * @param string $oauthRequestSecret
+	 * @param string $oauthVerifier
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
+	{
+		$endpoint = $this->oauthEndpoint . '/token&format=json';
+
+		$requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
+
+		$parsedUrl = parse_url($endpoint);
+		parse_str($parsedUrl['query'], $urlParameters);
+		$urlParameters['oauth_verifier'] = trim($oauthVerifier);
+
+		$acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $requestConsumer, 'GET', $endpoint,
+			$urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$acc_req->sign_request($hmac_method, $this->oauthConsumer, $requestConsumer);
+
+		$targetUrl = (string)$acc_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$token = json_decode($data);
+
+		if (!isset($token)) {
+			throw new OAuthException('Unknown error encountered getting access token while decoding json data.');
+		}
+
+		if (isset($token->error)) {
+			throw new OAuthException('Error encountered while getting access token: ' . $token->error);
+		}
+
+		return $token;
+	}
+
+	/**
+	 * @param string $oauthAccessToken
+	 * @param string $oauthAccessSecret
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
+	{
+		$endpoint = $this->oauthEndpoint . '/identify&format=json';
+
+		$oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
+
+		$parsedUrl = parse_url($endpoint);
+		parse_str($parsedUrl['query'], $urlParameters);
+
+		$acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $oauthToken, 'GET', $endpoint,
+			$urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$acc_req->sign_request($hmac_method, $this->oauthConsumer, $oauthToken);
+
+		$targetUrl = (string)$acc_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$decodedData = json_decode($data);
+
+		if (isset($decodedData->error)) {
+			throw new OAuthException($decodedData->error);
+		}
+
+		$identity = JWT::decode($data, $this->consumerSecret);
+
+		return $identity;
+	}
+
+	/**
+	 * @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')
+	{
+		$userToken = new OAuthToken($accessToken, $accessSecret);
+
+		$apiParams['format'] = 'json';
+
+		$api_req = OAuthRequest::from_consumer_and_token(
+			$this->oauthConsumer, // Consumer
+			$userToken, // User Access Token
+			$method, // HTTP Method
+			$this->mediawikiWebServiceEndpoint, // Endpoint url
+			$apiParams    // Extra signed parameters
+		);
 
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 
-        $api_req->sign_request($hmac_method, $this->oauthConsumer, $userToken);
+		$api_req->sign_request($hmac_method, $this->oauthConsumer, $userToken);
 
-        $headers = array($api_req->to_header());
-
-        if ($method == 'GET') {
-            $data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams, $headers);
-        }
-        elseif ($method == 'POST') {
-            $data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams, $headers);
-        }
-        else {
-            throw new ApplicationLogicException('Unsupported HTTP Method');
-        }
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        return json_decode($data);
-    }
+		$headers = array($api_req->to_header());
+
+		if ($method == 'GET') {
+			$data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams, $headers);
+		}
+		elseif ($method == 'POST') {
+			$data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams, $headers);
+		}
+		else {
+			throw new ApplicationLogicException('Unsupported HTTP Method');
+		}
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		return json_decode($data);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -77,7 +77,7 @@ 
      */
     public function getRequestToken()
     {
-        $endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
+        $endpoint = $this->oauthEndpoint.'/initiate&format=json&oauth_callback=oob';
 
         $parsedUrl = parse_url($endpoint);
         $urlParameters = array();
@@ -92,7 +92,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+            throw new CurlException('Curl error: '.$this->httpHelper->getError());
         }
 
         $token = json_decode($data);
@@ -102,7 +102,7 @@ 
         }
 
         if (isset($token->error)) {
-            throw new OAuthException('Error encountered while getting request token: ' . $token->error);
+            throw new OAuthException('Error encountered while getting request token: '.$token->error);
         }
 
         return $token;
@@ -129,7 +129,7 @@ 
      */
     public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
     {
-        $endpoint = $this->oauthEndpoint . '/token&format=json';
+        $endpoint = $this->oauthEndpoint.'/token&format=json';
 
         $requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
 
@@ -147,7 +147,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+            throw new CurlException('Curl error: '.$this->httpHelper->getError());
         }
 
         $token = json_decode($data);
@@ -157,7 +157,7 @@ 
         }
 
         if (isset($token->error)) {
-            throw new OAuthException('Error encountered while getting access token: ' . $token->error);
+            throw new OAuthException('Error encountered while getting access token: '.$token->error);
         }
 
         return $token;
@@ -173,7 +173,7 @@ 
      */
     public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
     {
-        $endpoint = $this->oauthEndpoint . '/identify&format=json';
+        $endpoint = $this->oauthEndpoint.'/identify&format=json';
 
         $oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
 
@@ -190,7 +190,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+            throw new CurlException('Curl error: '.$this->httpHelper->getError());
         }
 
         $decodedData = json_decode($data);
@@ -246,7 +246,7 @@ 
         }
 
         if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+            throw new CurlException('Curl error: '.$this->httpHelper->getError());
         }
 
         return json_decode($data);

includes/RequestStatus.php

Indentation +3 added lines, -3 removed lines

@@ -10,7 +10,7 @@
 
 class RequestStatus
 {
-    const HOSPITAL = 'Hospital';
-    const JOBQUEUE = 'JobQueue';
-    const CLOSED = 'Closed';
+	const HOSPITAL = 'Hospital';
+	const JOBQUEUE = 'JobQueue';
+	const CLOSED = 'Closed';
 }
\ No newline at end of file

includes/Background/Task/BotCreationTask.php

Indentation +11 added lines, -11 removed lines

@@ -16,16 +16,16 @@
 
 class BotCreationTask extends CreationTaskBase
 {
-    /**
-     * @return IMediaWikiClient
-     */
-    protected function getMediaWikiClient()
-    {
-        return new BotMediaWikiClient($this->getSiteConfiguration());
-    }
+	/**
+	 * @return IMediaWikiClient
+	 */
+	protected function getMediaWikiClient()
+	{
+		return new BotMediaWikiClient($this->getSiteConfiguration());
+	}
 
-    protected function getCreationReason(Request $request, User $user)
-    {
-        return parent::getCreationReason($request, $user) . ', on behalf of [[User:' . $user->getOnWikiName() . ']]';
-    }
+	protected function getCreationReason(Request $request, User $user)
+	{
+		return parent::getCreationReason($request, $user) . ', on behalf of [[User:' . $user->getOnWikiName() . ']]';
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
 
     protected function getCreationReason(Request $request, User $user)
     {
-        return parent::getCreationReason($request, $user) . ', on behalf of [[User:' . $user->getOnWikiName() . ']]';
+        return parent::getCreationReason($request, $user).', on behalf of [[User:'.$user->getOnWikiName().']]';
     }
 }
\ No newline at end of file

includes/Background/Task/UserCreationTask.php

Indentation +9 added lines, -9 removed lines

@@ -14,14 +14,14 @@
 
 class UserCreationTask extends CreationTaskBase
 {
-    /**
-     * @return IMediaWikiClient
-     */
-    protected function getMediaWikiClient()
-    {
-        $oauth = new OAuthUserHelper($this->getTriggerUser(), $this->getDatabase(), $this->getOauthProtocolHelper(),
-            $this->getSiteConfiguration());
+	/**
+	 * @return IMediaWikiClient
+	 */
+	protected function getMediaWikiClient()
+	{
+		$oauth = new OAuthUserHelper($this->getTriggerUser(), $this->getDatabase(), $this->getOauthProtocolHelper(),
+			$this->getSiteConfiguration());
 
-        return $oauth;
-    }
+		return $oauth;
+	}
 }
\ No newline at end of file

includes/Background/Task/WelcomeUserTask.php

Indentation +69 added lines, -69 removed lines

@@ -20,73 +20,73 @@
 
 class WelcomeUserTask extends BackgroundTaskBase
 {
-    public static function enqueue(User $triggerUser, Request $request, PdoDatabase $database)
-    {
-        $job = new JobQueue();
-        $job->setDatabase($database);
-        $job->setTask(WelcomeUserTask::class);
-        $job->setRequest($request->getId());
-        $job->setTriggerUserId($triggerUser->getId());
-        $job->save();
-    }
-
-    public function execute()
-    {
-        $database = $this->getDatabase();
-        $request = $this->getRequest();
-        $user = $this->getTriggerUser();
-
-        if ($user->getWelcomeTemplate() === null) {
-            $this->markFailed('Welcome template not specified');
-
-            return;
-        }
-
-        /** @var WelcomeTemplate $template */
-        $template = WelcomeTemplate::getById($user->getWelcomeTemplate(), $database);
-
-        if ($template === false) {
-            $this->markFailed('Welcome template missing');
-
-            return;
-        }
-
-        $oauth = new OAuthUserHelper($user, $database, $this->getOauthProtocolHelper(),
-            $this->getSiteConfiguration());
-        $mediaWikiHelper = new MediaWikiHelper($oauth, $this->getSiteConfiguration());
-
-        if ($request->getStatus() !== RequestStatus::CLOSED) {
-            $this->markFailed('Request is currently open');
-
-            return;
-        }
-
-        if (!$mediaWikiHelper->checkAccountExists($request->getName())){
-            $this->markFailed('Account does not exist!');
-
-            return;
-        }
-
-        $this->performWelcome($template, $request, $mediaWikiHelper);
-        $this->markComplete();
-    }
-
-    /**
-     * Performs the welcome
-     *
-     * @param WelcomeTemplate $template
-     * @param Request         $request
-     * @param MediaWikiHelper $mediaWikiHelper
-     */
-    private function performWelcome(
-        WelcomeTemplate $template,
-        Request $request,
-        MediaWikiHelper $mediaWikiHelper
-    ) {
-        $templateText = $template->getBotCode();
-        $templateText = str_replace('$signature', '~~~~', $templateText);
-        $templateText = str_replace('$username', $request->getName(), $templateText);
-
-        $mediaWikiHelper->addTalkPageMessage($request->getName(), 'Welcome!', 'Welcoming user created through [[WP:ACC]]', $templateText);
-    }
+	public static function enqueue(User $triggerUser, Request $request, PdoDatabase $database)
+	{
+		$job = new JobQueue();
+		$job->setDatabase($database);
+		$job->setTask(WelcomeUserTask::class);
+		$job->setRequest($request->getId());
+		$job->setTriggerUserId($triggerUser->getId());
+		$job->save();
+	}
+
+	public function execute()
+	{
+		$database = $this->getDatabase();
+		$request = $this->getRequest();
+		$user = $this->getTriggerUser();
+
+		if ($user->getWelcomeTemplate() === null) {
+			$this->markFailed('Welcome template not specified');
+
+			return;
+		}
+
+		/** @var WelcomeTemplate $template */
+		$template = WelcomeTemplate::getById($user->getWelcomeTemplate(), $database);
+
+		if ($template === false) {
+			$this->markFailed('Welcome template missing');
+
+			return;
+		}
+
+		$oauth = new OAuthUserHelper($user, $database, $this->getOauthProtocolHelper(),
+			$this->getSiteConfiguration());
+		$mediaWikiHelper = new MediaWikiHelper($oauth, $this->getSiteConfiguration());
+
+		if ($request->getStatus() !== RequestStatus::CLOSED) {
+			$this->markFailed('Request is currently open');
+
+			return;
+		}
+
+		if (!$mediaWikiHelper->checkAccountExists($request->getName())){
+			$this->markFailed('Account does not exist!');
+
+			return;
+		}
+
+		$this->performWelcome($template, $request, $mediaWikiHelper);
+		$this->markComplete();
+	}
+
+	/**
+	 * Performs the welcome
+	 *
+	 * @param WelcomeTemplate $template
+	 * @param Request         $request
+	 * @param MediaWikiHelper $mediaWikiHelper
+	 */
+	private function performWelcome(
+		WelcomeTemplate $template,
+		Request $request,
+		MediaWikiHelper $mediaWikiHelper
+	) {
+		$templateText = $template->getBotCode();
+		$templateText = str_replace('$signature', '~~~~', $templateText);
+		$templateText = str_replace('$username', $request->getName(), $templateText);
+
+		$mediaWikiHelper->addTalkPageMessage($request->getName(), 'Welcome!', 'Welcoming user created through [[WP:ACC]]', $templateText);
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
             return;
         }
 
-        if (!$mediaWikiHelper->checkAccountExists($request->getName())){
+        if (!$mediaWikiHelper->checkAccountExists($request->getName())) {
             $this->markFailed('Account does not exist!');
 
             return;

Braces +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
             return;
         }
 
-        if (!$mediaWikiHelper->checkAccountExists($request->getName())){
+        if (!$mediaWikiHelper->checkAccountExists($request->getName())) {
             $this->markFailed('Account does not exist!');
 
             return;

includes/Background/CreationTaskBase.php

Indentation +115 added lines, -115 removed lines

@@ -20,123 +20,123 @@
 
 abstract class CreationTaskBase extends BackgroundTaskBase
 {
-    /** @var Request */
-    private $request;
-    /**
-     * @var MediaWikiHelper
-     * Don't use this directly.
-     */
-    private $mwHelper = null;
-
-    public function execute()
-    {
-        $this->request = $this->getRequest();
-        $user = $this->getTriggerUser();
-
-        if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
-            $this->markCancelled('Request is not deferred to the job queue');
-
-            return;
-        }
-
-        if ($this->request->getEmailSent() != 0) {
-            $this->markFailed('Request has already been sent an email');
-
-            return;
-        }
-
-        if ($this->getEmailTemplate() === null) {
-            $this->markFailed('No email template specified');
-
-            return;
-        }
-
-        try {
-            $this->performCreation($user);
-
-            $this->request->setStatus(RequestStatus::CLOSED);
-            $this->request->setReserved(null);
-            $this->request->save();
-
-            // Log the closure as the user
-            Logger::closeRequest($this->getDatabase(), $this->request, $this->getEmailTemplate()->getId(), null,
-                $this->getTriggerUser());
-
-            $requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
-            $requestEmailHelper->sendMail($this->request, $this->getEmailTemplate()->getText(), $this->getTriggerUser(),
-                false);
-
-            $this->getNotificationHelper()->requestClosed($this->request, $this->getEmailTemplate()->getName());
-        }
-        catch (Exception $ex) {
-            $this->markFailed($ex->getMessage());
-
-            return;
-        }
-
-        $this->markComplete();
-    }
-
-    /**
-     * @return IMediaWikiClient
-     */
-    protected abstract function getMediaWikiClient();
-
-    protected function getMediaWikiHelper(){
-        if($this->mwHelper === null) {
-            $this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
-        }
-
-        return $this->mwHelper;
-    }
-
-    protected function getCreationReason(Request $request, User $user)
-    {
-        return 'Requested account at [[WP:ACC]], request #' . $request->getId();
-    }
-
-    /**
-     * @param string $name
-     *
-     * @return bool
-     */
-    protected function checkAccountExists($name)
-    {
-        return $this->getMediaWikiHelper()->checkAccountExists($name);
-    }
-
-    protected function markFailed($reason = null)
-    {
-        $this->request->setStatus(RequestStatus::HOSPITAL);
-        $this->request->save();
-
-        Logger::hospitalised($this->getDatabase(), $this->request);
-
-        parent::markFailed($reason);
-    }
-
-    /**
-     * @param $user
-     *
-     * @throws ApplicationLogicException
-     */
-    protected function performCreation($user)
-    {
-        $mw = $this->getMediaWikiHelper();
-
-        $reason = $this->getCreationReason($this->request, $user);
+	/** @var Request */
+	private $request;
+	/**
+	 * @var MediaWikiHelper
+	 * Don't use this directly.
+	 */
+	private $mwHelper = null;
+
+	public function execute()
+	{
+		$this->request = $this->getRequest();
+		$user = $this->getTriggerUser();
+
+		if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
+			$this->markCancelled('Request is not deferred to the job queue');
+
+			return;
+		}
+
+		if ($this->request->getEmailSent() != 0) {
+			$this->markFailed('Request has already been sent an email');
+
+			return;
+		}
+
+		if ($this->getEmailTemplate() === null) {
+			$this->markFailed('No email template specified');
+
+			return;
+		}
+
+		try {
+			$this->performCreation($user);
+
+			$this->request->setStatus(RequestStatus::CLOSED);
+			$this->request->setReserved(null);
+			$this->request->save();
+
+			// Log the closure as the user
+			Logger::closeRequest($this->getDatabase(), $this->request, $this->getEmailTemplate()->getId(), null,
+				$this->getTriggerUser());
+
+			$requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
+			$requestEmailHelper->sendMail($this->request, $this->getEmailTemplate()->getText(), $this->getTriggerUser(),
+				false);
+
+			$this->getNotificationHelper()->requestClosed($this->request, $this->getEmailTemplate()->getName());
+		}
+		catch (Exception $ex) {
+			$this->markFailed($ex->getMessage());
+
+			return;
+		}
+
+		$this->markComplete();
+	}
+
+	/**
+	 * @return IMediaWikiClient
+	 */
+	protected abstract function getMediaWikiClient();
+
+	protected function getMediaWikiHelper(){
+		if($this->mwHelper === null) {
+			$this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
+		}
+
+		return $this->mwHelper;
+	}
+
+	protected function getCreationReason(Request $request, User $user)
+	{
+		return 'Requested account at [[WP:ACC]], request #' . $request->getId();
+	}
+
+	/**
+	 * @param string $name
+	 *
+	 * @return bool
+	 */
+	protected function checkAccountExists($name)
+	{
+		return $this->getMediaWikiHelper()->checkAccountExists($name);
+	}
+
+	protected function markFailed($reason = null)
+	{
+		$this->request->setStatus(RequestStatus::HOSPITAL);
+		$this->request->save();
+
+		Logger::hospitalised($this->getDatabase(), $this->request);
+
+		parent::markFailed($reason);
+	}
+
+	/**
+	 * @param $user
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	protected function performCreation($user)
+	{
+		$mw = $this->getMediaWikiHelper();
+
+		$reason = $this->getCreationReason($this->request, $user);
 
-        if ($this->checkAccountExists($this->request->getName())) {
-            throw new ApplicationLogicException('Account already exists');
-        }
+		if ($this->checkAccountExists($this->request->getName())) {
+			throw new ApplicationLogicException('Account already exists');
+		}
 
-        $mw->createAccount($this->request->getName(), $this->request->getEmail(), $reason);
+		$mw->createAccount($this->request->getName(), $this->request->getEmail(), $reason);
 
-        if (!$this->checkAccountExists($this->request->getName())) {
-            throw new ApplicationLogicException('Account creation appeared to succeed but account does not exist.');
-        }
+		if (!$this->checkAccountExists($this->request->getName())) {
+			throw new ApplicationLogicException('Account creation appeared to succeed but account does not exist.');
+		}
 
-        $this->request->setStatus(RequestStatus::CLOSED);
-        $this->request->save();
-    }
+		$this->request->setStatus(RequestStatus::CLOSED);
+		$this->request->save();
+	}
 }
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -82,8 +82,8 @@ 
      */
     protected abstract function getMediaWikiClient();
 
-    protected function getMediaWikiHelper(){
-        if($this->mwHelper === null) {
+    protected function getMediaWikiHelper() {
+        if ($this->mwHelper === null) {
             $this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
         }
 
@@ -92,7 +92,7 @@ 
 
     protected function getCreationReason(Request $request, User $user)
     {
-        return 'Requested account at [[WP:ACC]], request #' . $request->getId();
+        return 'Requested account at [[WP:ACC]], request #'.$request->getId();
     }
 
     /**

Braces +2 added lines, -1 removed lines

@@ -82,7 +82,8 @@
      */
     protected abstract function getMediaWikiClient();
 
-    protected function getMediaWikiHelper(){
+    protected function getMediaWikiHelper()
+    {
         if($this->mwHelper === null) {
             $this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
         }

includes/Background/BackgroundTaskBase.php

Indentation +261 added lines, -261 removed lines

@@ -23,265 +23,265 @@
 
 abstract class BackgroundTaskBase
 {
-    /** @var JobQueue */
-    private $job;
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IOAuthProtocolHelper */
-    private $oauthProtocolHelper;
-    /** @var SiteConfiguration */
-    private $siteConfiguration;
-    /** @var IEmailHelper */
-    private $emailHelper;
-    /** @var HttpHelper */
-    private $httpHelper;
-    /** @var IrcNotificationHelper */
-    private $notificationHelper;
-    /** @var User */
-    private $triggerUser;
-    /** @var Request */
-    private $request;
-    /** @var EmailTemplate */
-    private $emailTemplate = null;
-    /** @var mixed */
-    private $parameters;
-
-    /**
-     * @return JobQueue
-     */
-    public function getJob()
-    {
-        return $this->job;
-    }
-
-    /**
-     * @param JobQueue $job
-     */
-    public function setJob(JobQueue $job)
-    {
-        $this->job = $job;
-    }
-
-    /**
-     * @return PdoDatabase
-     */
-    public function getDatabase()
-    {
-        return $this->database;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     */
-    public function setDatabase(PdoDatabase $database)
-    {
-        $this->database = $database;
-    }
-
-    /**
-     * @return IOAuthProtocolHelper
-     */
-    public function getOauthProtocolHelper()
-    {
-        return $this->oauthProtocolHelper;
-    }
-
-    /**
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     */
-    public function setOauthProtocolHelper(IOAuthProtocolHelper $oauthProtocolHelper)
-    {
-        $this->oauthProtocolHelper = $oauthProtocolHelper;
-    }
-
-    /**
-     * @return SiteConfiguration
-     */
-    public function getSiteConfiguration()
-    {
-        return $this->siteConfiguration;
-    }
-
-    /**
-     * @param SiteConfiguration $siteConfiguration
-     */
-    public function setSiteConfiguration(SiteConfiguration $siteConfiguration)
-    {
-        $this->siteConfiguration = $siteConfiguration;
-    }
-
-    /**
-     * @return HttpHelper
-     */
-    public function getHttpHelper()
-    {
-        return $this->httpHelper;
-    }
-
-    /**
-     * @param HttpHelper $httpHelper
-     */
-    public function setHttpHelper(HttpHelper $httpHelper)
-    {
-        $this->httpHelper = $httpHelper;
-    }
-
-    /**
-     * @return IEmailHelper
-     */
-    public function getEmailHelper()
-    {
-        return $this->emailHelper;
-    }
-
-    /**
-     * @param IEmailHelper $emailHelper
-     */
-    public function setEmailHelper(IEmailHelper $emailHelper)
-    {
-        $this->emailHelper = $emailHelper;
-    }
-
-    /**
-     * @return IrcNotificationHelper
-     */
-    public function getNotificationHelper()
-    {
-        return $this->notificationHelper;
-    }
-
-    /**
-     * @param IrcNotificationHelper $notificationHelper
-     */
-    public function setNotificationHelper($notificationHelper)
-    {
-        $this->notificationHelper = $notificationHelper;
-    }
-
-    /**
-     * @return void
-     */
-    protected abstract function execute();
-
-    public function run()
-    {
-        $this->triggerUser = User::getById($this->job->getTriggerUserId(), $this->getDatabase());
-
-        if ($this->triggerUser === false) {
-            throw new ApplicationLogicException('Cannot locate trigger user');
-        }
-
-        $this->request = Request::getById($this->job->getRequest(), $this->getDatabase());
-
-        if ($this->request === false) {
-            throw new ApplicationLogicException('Cannot locate request');
-        }
-
-        if($this->job->getEmailTemplate() !== null){
-            $this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
-
-            if ($this->emailTemplate === false) {
-                throw new ApplicationLogicException('Cannot locate email template');
-            }
-        }
-
-        $this->parameters = json_decode($this->job->getParameters());
-
-        if (json_last_error() !== JSON_ERROR_NONE) {
-            throw new ApplicationLogicException('JSON decode: ' . json_last_error_msg());
-        }
-
-        // Should we wait for a parent job?
-        if($this->job->getParent() !== null) {
-            /** @var JobQueue $parentJob */
-            $parentJob = JobQueue::getById($this->job->getParent(), $this->getDatabase());
-
-            if($parentJob === false) {
-                $this->markFailed("Parent job could not be found");
-                return;
-            }
-
-            switch ($parentJob->getStatus()) {
-                case JobQueue::STATUS_CANCELLED:
-                case JobQueue::STATUS_FAILED:
-                    $this->markCancelled('Parent job failed/cancelled');
-                    return;
-                case JobQueue::STATUS_WAITING:
-                case JobQueue::STATUS_READY:
-                case JobQueue::STATUS_RUNNING:
-                case JobQueue::STATUS_HELD:
-                    // Defer to next execution
-                    $this->job->setStatus(JobQueue::STATUS_READY);
-                    $this->job->save();
-                    return;
-                case JobQueue::STATUS_COMPLETE:
-                    // do nothing
-                    break;
-            }
-        }
-
-        $this->execute();
-    }
-
-    protected function markComplete()
-    {
-        $this->job->setStatus(JobQueue::STATUS_COMPLETE);
-        $this->job->setError(null);
-        $this->job->setAcknowledged(null);
-        $this->job->save();
-
-        Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
-    }
-
-    protected function markCancelled($reason = null)
-    {
-        $this->job->setStatus(JobQueue::STATUS_CANCELLED);
-        $this->job->setError($reason);
-        $this->job->setAcknowledged(null);
-        $this->job->save();
-
-        Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
-    }
-
-    protected function markFailed($reason = null)
-    {
-        $this->job->setStatus(JobQueue::STATUS_FAILED);
-        $this->job->setError($reason);
-        $this->job->setAcknowledged(0);
-        $this->job->save();
-
-        Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
-    }
-
-    /**
-     * @return User
-     */
-    public function getTriggerUser()
-    {
-        return $this->triggerUser;
-    }
-
-    /**
-     * @return Request
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @return EmailTemplate
-     */
-    public function getEmailTemplate()
-    {
-        return $this->emailTemplate;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getParameters()
-    {
-        return $this->parameters;
-    }
+	/** @var JobQueue */
+	private $job;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IOAuthProtocolHelper */
+	private $oauthProtocolHelper;
+	/** @var SiteConfiguration */
+	private $siteConfiguration;
+	/** @var IEmailHelper */
+	private $emailHelper;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/** @var IrcNotificationHelper */
+	private $notificationHelper;
+	/** @var User */
+	private $triggerUser;
+	/** @var Request */
+	private $request;
+	/** @var EmailTemplate */
+	private $emailTemplate = null;
+	/** @var mixed */
+	private $parameters;
+
+	/**
+	 * @return JobQueue
+	 */
+	public function getJob()
+	{
+		return $this->job;
+	}
+
+	/**
+	 * @param JobQueue $job
+	 */
+	public function setJob(JobQueue $job)
+	{
+		$this->job = $job;
+	}
+
+	/**
+	 * @return PdoDatabase
+	 */
+	public function getDatabase()
+	{
+		return $this->database;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	public function setDatabase(PdoDatabase $database)
+	{
+		$this->database = $database;
+	}
+
+	/**
+	 * @return IOAuthProtocolHelper
+	 */
+	public function getOauthProtocolHelper()
+	{
+		return $this->oauthProtocolHelper;
+	}
+
+	/**
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 */
+	public function setOauthProtocolHelper(IOAuthProtocolHelper $oauthProtocolHelper)
+	{
+		$this->oauthProtocolHelper = $oauthProtocolHelper;
+	}
+
+	/**
+	 * @return SiteConfiguration
+	 */
+	public function getSiteConfiguration()
+	{
+		return $this->siteConfiguration;
+	}
+
+	/**
+	 * @param SiteConfiguration $siteConfiguration
+	 */
+	public function setSiteConfiguration(SiteConfiguration $siteConfiguration)
+	{
+		$this->siteConfiguration = $siteConfiguration;
+	}
+
+	/**
+	 * @return HttpHelper
+	 */
+	public function getHttpHelper()
+	{
+		return $this->httpHelper;
+	}
+
+	/**
+	 * @param HttpHelper $httpHelper
+	 */
+	public function setHttpHelper(HttpHelper $httpHelper)
+	{
+		$this->httpHelper = $httpHelper;
+	}
+
+	/**
+	 * @return IEmailHelper
+	 */
+	public function getEmailHelper()
+	{
+		return $this->emailHelper;
+	}
+
+	/**
+	 * @param IEmailHelper $emailHelper
+	 */
+	public function setEmailHelper(IEmailHelper $emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
+
+	/**
+	 * @return IrcNotificationHelper
+	 */
+	public function getNotificationHelper()
+	{
+		return $this->notificationHelper;
+	}
+
+	/**
+	 * @param IrcNotificationHelper $notificationHelper
+	 */
+	public function setNotificationHelper($notificationHelper)
+	{
+		$this->notificationHelper = $notificationHelper;
+	}
+
+	/**
+	 * @return void
+	 */
+	protected abstract function execute();
+
+	public function run()
+	{
+		$this->triggerUser = User::getById($this->job->getTriggerUserId(), $this->getDatabase());
+
+		if ($this->triggerUser === false) {
+			throw new ApplicationLogicException('Cannot locate trigger user');
+		}
+
+		$this->request = Request::getById($this->job->getRequest(), $this->getDatabase());
+
+		if ($this->request === false) {
+			throw new ApplicationLogicException('Cannot locate request');
+		}
+
+		if($this->job->getEmailTemplate() !== null){
+			$this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
+
+			if ($this->emailTemplate === false) {
+				throw new ApplicationLogicException('Cannot locate email template');
+			}
+		}
+
+		$this->parameters = json_decode($this->job->getParameters());
+
+		if (json_last_error() !== JSON_ERROR_NONE) {
+			throw new ApplicationLogicException('JSON decode: ' . json_last_error_msg());
+		}
+
+		// Should we wait for a parent job?
+		if($this->job->getParent() !== null) {
+			/** @var JobQueue $parentJob */
+			$parentJob = JobQueue::getById($this->job->getParent(), $this->getDatabase());
+
+			if($parentJob === false) {
+				$this->markFailed("Parent job could not be found");
+				return;
+			}
+
+			switch ($parentJob->getStatus()) {
+				case JobQueue::STATUS_CANCELLED:
+				case JobQueue::STATUS_FAILED:
+					$this->markCancelled('Parent job failed/cancelled');
+					return;
+				case JobQueue::STATUS_WAITING:
+				case JobQueue::STATUS_READY:
+				case JobQueue::STATUS_RUNNING:
+				case JobQueue::STATUS_HELD:
+					// Defer to next execution
+					$this->job->setStatus(JobQueue::STATUS_READY);
+					$this->job->save();
+					return;
+				case JobQueue::STATUS_COMPLETE:
+					// do nothing
+					break;
+			}
+		}
+
+		$this->execute();
+	}
+
+	protected function markComplete()
+	{
+		$this->job->setStatus(JobQueue::STATUS_COMPLETE);
+		$this->job->setError(null);
+		$this->job->setAcknowledged(null);
+		$this->job->save();
+
+		Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
+	}
+
+	protected function markCancelled($reason = null)
+	{
+		$this->job->setStatus(JobQueue::STATUS_CANCELLED);
+		$this->job->setError($reason);
+		$this->job->setAcknowledged(null);
+		$this->job->save();
+
+		Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
+	}
+
+	protected function markFailed($reason = null)
+	{
+		$this->job->setStatus(JobQueue::STATUS_FAILED);
+		$this->job->setError($reason);
+		$this->job->setAcknowledged(0);
+		$this->job->save();
+
+		Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
+	}
+
+	/**
+	 * @return User
+	 */
+	public function getTriggerUser()
+	{
+		return $this->triggerUser;
+	}
+
+	/**
+	 * @return Request
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @return EmailTemplate
+	 */
+	public function getEmailTemplate()
+	{
+		return $this->emailTemplate;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getParameters()
+	{
+		return $this->parameters;
+	}
 }
\ No newline at end of file

Spacing +4 added lines, -4 removed lines

@@ -177,7 +177,7 @@ 
             throw new ApplicationLogicException('Cannot locate request');
         }
 
-        if($this->job->getEmailTemplate() !== null){
+        if ($this->job->getEmailTemplate() !== null) {
             $this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
 
             if ($this->emailTemplate === false) {
@@ -188,15 +188,15 @@ 
         $this->parameters = json_decode($this->job->getParameters());
 
         if (json_last_error() !== JSON_ERROR_NONE) {
-            throw new ApplicationLogicException('JSON decode: ' . json_last_error_msg());
+            throw new ApplicationLogicException('JSON decode: '.json_last_error_msg());
         }
 
         // Should we wait for a parent job?
-        if($this->job->getParent() !== null) {
+        if ($this->job->getParent() !== null) {
             /** @var JobQueue $parentJob */
             $parentJob = JobQueue::getById($this->job->getParent(), $this->getDatabase());
 
-            if($parentJob === false) {
+            if ($parentJob === false) {
                 $this->markFailed("Parent job could not be found");
                 return;
             }

Braces +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
             throw new ApplicationLogicException('Cannot locate request');
         }
 
-        if($this->job->getEmailTemplate() !== null){
+        if($this->job->getEmailTemplate() !== null) {
             $this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
 
             if ($this->emailTemplate === false) {

includes/WebStart.php

Indentation +220 added lines, -220 removed lines

@@ -30,224 +30,224 @@
  */
 class WebStart extends ApplicationBase
 {
-    /**
-     * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different
-     *                                    routers and hence different URL mappings
-     */
-    private $requestRouter;
-    /**
-     * @var bool $isPublic Determines whether to use public interface objects or internal interface objects
-     */
-    private $isPublic = false;
-
-    /**
-     * WebStart constructor.
-     *
-     * @param SiteConfiguration $configuration The site configuration
-     * @param IRequestRouter    $router        The request router to use
-     */
-    public function __construct(SiteConfiguration $configuration, IRequestRouter $router)
-    {
-        parent::__construct($configuration);
-
-        $this->requestRouter = $router;
-    }
-
-    /**
-     * @param ITask             $page
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $database
-     * @param PdoDatabase       $notificationsDatabase
-     *
-     * @return void
-     */
-    protected function setupHelpers(
-        ITask $page,
-        SiteConfiguration $siteConfiguration,
-        PdoDatabase $database,
-        PdoDatabase $notificationsDatabase = null
-    ) {
-        parent::setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase);
-
-        if ($page instanceof PageBase) {
-            $page->setTokenManager(new TokenManager());
-
-            if ($page instanceof InternalPageBase) {
-                $page->setTypeAheadHelper(new TypeAheadHelper());
-
-                $identificationVerifier = new IdentificationVerifier($page->getHttpHelper(), $siteConfiguration,
-                    $database);
-                $page->setIdentificationVerifier($identificationVerifier);
-
-                $page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration()));
-
-                if ($siteConfiguration->getTitleBlacklistEnabled()) {
-                    $page->setBlacklistHelper(new FakeBlacklistHelper());
-                }
-                else {
-                    $page->setBlacklistHelper(new BlacklistHelper($page->getHttpHelper(),
-                        $siteConfiguration->getMediawikiWebServiceEndpoint()));
-                }
-            }
-        }
-    }
-
-    /**
-     * Application entry point.
-     *
-     * Sets up the environment and runs the application, performing any global cleanup operations when done.
-     */
-    public function run()
-    {
-        try {
-            if ($this->setupEnvironment()) {
-                $this->main();
-            }
-        }
-        catch (EnvironmentException $ex) {
-            ob_end_clean();
-            print Offline::getOfflineMessage($this->isPublic(), $ex->getMessage());
-        }
-        catch (ReadableException $ex) {
-            ob_end_clean();
-            print $ex->getReadableError();
-        }
-        finally {
-            $this->cleanupEnvironment();
-        }
-    }
-
-    /**
-     * Environment setup
-     *
-     * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
-     * and shut down prematurely.
-     *
-     * @return bool
-     * @throws EnvironmentException
-     */
-    protected function setupEnvironment()
-    {
-        // initialise global exception handler
-        set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler'));
-        set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR);
-
-        // start output buffering if necessary
-        if (ob_get_level() === 0) {
-            ob_start();
-        }
-
-        // initialise super-global providers
-        WebRequest::setGlobalStateProvider(new GlobalStateProvider());
-
-        if (Offline::isOffline()) {
-            print Offline::getOfflineMessage($this->isPublic());
-            ob_end_flush();
-
-            return false;
-        }
-
-        // Call parent setup
-        if (!parent::setupEnvironment()) {
-            return false;
-        }
-
-        // Start up sessions
-        Session::start();
-
-        // Check the user is allowed to be logged in still. This must be before we call any user-loading functions and
-        // get the current user cached.
-        // I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a
-        // session I suppose.
-        $this->checkForceLogout();
-
-        // environment initialised!
-        return true;
-    }
-
-    /**
-     * Main application logic
-     */
-    protected function main()
-    {
-        // Get the right route for the request
-        $page = $this->requestRouter->route();
-
-        $siteConfiguration = $this->getConfiguration();
-        $database = PdoDatabase::getDatabaseConnection('acc');
-
-        if ($siteConfiguration->getIrcNotificationsEnabled()) {
-            $notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications');
-        }
-        else {
-            // @todo federated table here?
-            $notificationsDatabase = $database;
-        }
-
-        $this->setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase);
-
-        /* @todo Remove this global statement! It's here for User.php, which does far more than it should. */
-        global $oauthProtocolHelper;
-        $oauthProtocolHelper = $page->getOAuthProtocolHelper();
-
-        /* @todo Remove this global statement! It's here for Request.php, which does far more than it should. */
-        global $globalXffTrustProvider;
-        $globalXffTrustProvider = $page->getXffTrustProvider();
-
-        // run the route code for the request.
-        $page->execute();
-    }
-
-    /**
-     * Any cleanup tasks should go here
-     *
-     * Note that we need to be very careful here, as exceptions may have been thrown and handled.
-     * This should *only* be for cleaning up, no logic should go here.
-     */
-    protected function cleanupEnvironment()
-    {
-        // Clean up anything we splurged after sending the page.
-        if (ob_get_level() > 0) {
-            for ($i = ob_get_level(); $i > 0; $i--) {
-                ob_end_clean();
-            }
-        }
-    }
-
-    private function checkForceLogout()
-    {
-        $database = PdoDatabase::getDatabaseConnection('acc');
-
-        $sessionUserId = WebRequest::getSessionUserId();
-        iF ($sessionUserId === null) {
-            return;
-        }
-
-        // Note, User::getCurrent() caches it's result, which we *really* don't want to trigger.
-        $currentUser = User::getById($sessionUserId, $database);
-
-        if ($currentUser === false) {
-            // Umm... this user has a session cookie with a userId set, but no user exists...
-            Session::restart();
-
-            $currentUser = User::getCurrent($database);
-        }
-
-        if ($currentUser->getForceLogout()) {
-            Session::restart();
-
-            $currentUser->setForceLogout(false);
-            $currentUser->save();
-        }
-    }
-
-    public function isPublic()
-    {
-        return $this->isPublic;
-    }
-
-    public function setPublic($isPublic)
-    {
-        $this->isPublic = $isPublic;
-    }
+	/**
+	 * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different
+	 *                                    routers and hence different URL mappings
+	 */
+	private $requestRouter;
+	/**
+	 * @var bool $isPublic Determines whether to use public interface objects or internal interface objects
+	 */
+	private $isPublic = false;
+
+	/**
+	 * WebStart constructor.
+	 *
+	 * @param SiteConfiguration $configuration The site configuration
+	 * @param IRequestRouter    $router        The request router to use
+	 */
+	public function __construct(SiteConfiguration $configuration, IRequestRouter $router)
+	{
+		parent::__construct($configuration);
+
+		$this->requestRouter = $router;
+	}
+
+	/**
+	 * @param ITask             $page
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $database
+	 * @param PdoDatabase       $notificationsDatabase
+	 *
+	 * @return void
+	 */
+	protected function setupHelpers(
+		ITask $page,
+		SiteConfiguration $siteConfiguration,
+		PdoDatabase $database,
+		PdoDatabase $notificationsDatabase = null
+	) {
+		parent::setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase);
+
+		if ($page instanceof PageBase) {
+			$page->setTokenManager(new TokenManager());
+
+			if ($page instanceof InternalPageBase) {
+				$page->setTypeAheadHelper(new TypeAheadHelper());
+
+				$identificationVerifier = new IdentificationVerifier($page->getHttpHelper(), $siteConfiguration,
+					$database);
+				$page->setIdentificationVerifier($identificationVerifier);
+
+				$page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration()));
+
+				if ($siteConfiguration->getTitleBlacklistEnabled()) {
+					$page->setBlacklistHelper(new FakeBlacklistHelper());
+				}
+				else {
+					$page->setBlacklistHelper(new BlacklistHelper($page->getHttpHelper(),
+						$siteConfiguration->getMediawikiWebServiceEndpoint()));
+				}
+			}
+		}
+	}
+
+	/**
+	 * Application entry point.
+	 *
+	 * Sets up the environment and runs the application, performing any global cleanup operations when done.
+	 */
+	public function run()
+	{
+		try {
+			if ($this->setupEnvironment()) {
+				$this->main();
+			}
+		}
+		catch (EnvironmentException $ex) {
+			ob_end_clean();
+			print Offline::getOfflineMessage($this->isPublic(), $ex->getMessage());
+		}
+		catch (ReadableException $ex) {
+			ob_end_clean();
+			print $ex->getReadableError();
+		}
+		finally {
+			$this->cleanupEnvironment();
+		}
+	}
+
+	/**
+	 * Environment setup
+	 *
+	 * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
+	 * and shut down prematurely.
+	 *
+	 * @return bool
+	 * @throws EnvironmentException
+	 */
+	protected function setupEnvironment()
+	{
+		// initialise global exception handler
+		set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler'));
+		set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR);
+
+		// start output buffering if necessary
+		if (ob_get_level() === 0) {
+			ob_start();
+		}
+
+		// initialise super-global providers
+		WebRequest::setGlobalStateProvider(new GlobalStateProvider());
+
+		if (Offline::isOffline()) {
+			print Offline::getOfflineMessage($this->isPublic());
+			ob_end_flush();
+
+			return false;
+		}
+
+		// Call parent setup
+		if (!parent::setupEnvironment()) {
+			return false;
+		}
+
+		// Start up sessions
+		Session::start();
+
+		// Check the user is allowed to be logged in still. This must be before we call any user-loading functions and
+		// get the current user cached.
+		// I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a
+		// session I suppose.
+		$this->checkForceLogout();
+
+		// environment initialised!
+		return true;
+	}
+
+	/**
+	 * Main application logic
+	 */
+	protected function main()
+	{
+		// Get the right route for the request
+		$page = $this->requestRouter->route();
+
+		$siteConfiguration = $this->getConfiguration();
+		$database = PdoDatabase::getDatabaseConnection('acc');
+
+		if ($siteConfiguration->getIrcNotificationsEnabled()) {
+			$notificationsDatabase = PdoDatabase::getDatabaseConnection('notifications');
+		}
+		else {
+			// @todo federated table here?
+			$notificationsDatabase = $database;
+		}
+
+		$this->setupHelpers($page, $siteConfiguration, $database, $notificationsDatabase);
+
+		/* @todo Remove this global statement! It's here for User.php, which does far more than it should. */
+		global $oauthProtocolHelper;
+		$oauthProtocolHelper = $page->getOAuthProtocolHelper();
+
+		/* @todo Remove this global statement! It's here for Request.php, which does far more than it should. */
+		global $globalXffTrustProvider;
+		$globalXffTrustProvider = $page->getXffTrustProvider();
+
+		// run the route code for the request.
+		$page->execute();
+	}
+
+	/**
+	 * Any cleanup tasks should go here
+	 *
+	 * Note that we need to be very careful here, as exceptions may have been thrown and handled.
+	 * This should *only* be for cleaning up, no logic should go here.
+	 */
+	protected function cleanupEnvironment()
+	{
+		// Clean up anything we splurged after sending the page.
+		if (ob_get_level() > 0) {
+			for ($i = ob_get_level(); $i > 0; $i--) {
+				ob_end_clean();
+			}
+		}
+	}
+
+	private function checkForceLogout()
+	{
+		$database = PdoDatabase::getDatabaseConnection('acc');
+
+		$sessionUserId = WebRequest::getSessionUserId();
+		iF ($sessionUserId === null) {
+			return;
+		}
+
+		// Note, User::getCurrent() caches it's result, which we *really* don't want to trigger.
+		$currentUser = User::getById($sessionUserId, $database);
+
+		if ($currentUser === false) {
+			// Umm... this user has a session cookie with a userId set, but no user exists...
+			Session::restart();
+
+			$currentUser = User::getCurrent($database);
+		}
+
+		if ($currentUser->getForceLogout()) {
+			Session::restart();
+
+			$currentUser->setForceLogout(false);
+			$currentUser->save();
+		}
+	}
+
+	public function isPublic()
+	{
+		return $this->isPublic;
+	}
+
+	public function setPublic($isPublic)
+	{
+		$this->isPublic = $isPublic;
+	}
 }