enwikipedia-acc / waca

includes/Background/BackgroundTaskBase.php

Doc Comments +3 added lines

@@ -233,6 +233,9 @@
         Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
     }
 
+    /**
+     * @param string $reason
+     */
     protected function markCancelled($reason = null)
     {
         $this->job->setStatus(JobQueue::STATUS_CANCELLED);

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

includes/Background/CreationTaskBase.php

Doc Comments +4 added lines, -1 removed lines

@@ -105,6 +105,9 @@ 
         return $this->getMediaWikiHelper()->checkAccountExists($name);
     }
 
+    /**
+     * @param string $reason
+     */
     protected function markFailed($reason = null)
     {
         $this->request->setStatus(RequestStatus::HOSPITAL);
@@ -116,7 +119,7 @@ 
     }
 
     /**
-     * @param $user
+     * @param User $user
      *
      * @throws ApplicationLogicException
      */

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

includes/DataObjects/JobQueue.php

Doc Comments +1 added lines, -1 removed lines

@@ -225,7 +225,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getError()
     {

Indentation +253 added lines, -253 removed lines

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

includes/DataObjects/OAuthToken.php

Doc Comments +5 added lines, -5 removed lines

@@ -83,7 +83,7 @@ 
     #region properties
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getUserId()
     {
@@ -99,7 +99,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getToken()
     {
@@ -115,7 +115,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getSecret()
     {
@@ -131,7 +131,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getType()
     {
@@ -139,7 +139,7 @@ 
     }
 
     /**
-     * @param mixed $type
+     * @param string $type
      */
     public function setType($type)
     {

Indentation +137 added lines, -137 removed lines

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

includes/Helpers/BotMediaWikiClient.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
 
     /**
      * @param $apiParams
-     * @param $method
+     * @param string $method
      *
      * @return mixed
      * @throws ApplicationLogicException

Indentation +132 added lines, -132 removed lines

@@ -16,136 +16,136 @@
 
 class BotMediaWikiClient implements IMediaWikiClient
 {
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-    /** @var string */
-    private $mediawikiWebServiceEndpoint;
-    /** @var string */
-    private $creationBotUsername;
-    /** @var string */
-    private $creationBotPassword;
-    /** @var bool */
-    private $knownLoggedIn = false;
-
-    /**
-     * BotMediaWikiClient constructor.
-     *
-     * @param SiteConfiguration $siteConfiguration
-     */
-    public function __construct(SiteConfiguration $siteConfiguration)
-    {
-        $this->mediawikiWebServiceEndpoint = $siteConfiguration->getMediawikiWebServiceEndpoint();
-
-        $this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
-        $this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
-
-        $this->httpHelper = new HttpHelper(
-            $siteConfiguration->getUserAgent(),
-            $siteConfiguration->getCurlDisableVerifyPeer(),
-            $siteConfiguration->getCurlCookieJar()
-        );
-    }
-
-    function doApiCall($apiParams, $method = 'GET')
-    {
-        $this->ensureLoggedIn();
-        $apiParams['assert'] = 'user';
-
-        return $this->callApi($apiParams, $method);
-    }
-
-    private function ensureLoggedIn()
-    {
-        if ($this->knownLoggedIn) {
-            return;
-        }
-
-        $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
-        if (isset($userinfoResult->query->userinfo->anon)) {
-            // not logged in.
-            $this->logIn();
-
-            // retest
-            $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
-            if (isset($userinfoResult->query->userinfo->anon)) {
-                throw new MediaWikiApiException('Unable to log in.');
-            }
-            else {
-                $this->knownLoggedIn = true;
-            }
-        }
-        else {
-            $this->knownLoggedIn = true;
-        }
-    }
-
-    /**
-     * @param $apiParams
-     * @param $method
-     *
-     * @return mixed
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     */
-    private function callApi($apiParams, $method)
-    {
-        $apiParams['format'] = 'json';
-
-        if ($method == 'GET') {
-            $data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        elseif ($method == 'POST') {
-            $data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        else {
-            throw new ApplicationLogicException('Unsupported HTTP Method');
-        }
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $result = json_decode($data);
-
-        return $result;
-    }
-
-    private function logIn()
-    {
-        // get token
-        $tokenParams = array(
-            'action' => 'query',
-            'meta'   => 'tokens',
-            'type'   => 'login',
-        );
-
-        $response = $this->callApi($tokenParams, 'POST');
-
-        if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        $token = $response->query->tokens->logintoken;
-
-        if ($token === null) {
-            throw new MediaWikiApiException('Edit token could not be acquired');
-        }
-
-        $params = array(
-            'action' => 'login',
-            'lgname' => $this->creationBotUsername,
-            'lgpassword' => $this->creationBotPassword,
-            'lgtoken' => $token,
-        );
-
-        $loginResponse = $this->callApi($params, 'POST');
-
-        if($loginResponse->login->result == 'Success'){
-            return;
-        }
-
-        throw new ApplicationLogicException(json_encode($loginResponse));
-    }
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+	/** @var string */
+	private $mediawikiWebServiceEndpoint;
+	/** @var string */
+	private $creationBotUsername;
+	/** @var string */
+	private $creationBotPassword;
+	/** @var bool */
+	private $knownLoggedIn = false;
+
+	/**
+	 * BotMediaWikiClient constructor.
+	 *
+	 * @param SiteConfiguration $siteConfiguration
+	 */
+	public function __construct(SiteConfiguration $siteConfiguration)
+	{
+		$this->mediawikiWebServiceEndpoint = $siteConfiguration->getMediawikiWebServiceEndpoint();
+
+		$this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
+		$this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
+
+		$this->httpHelper = new HttpHelper(
+			$siteConfiguration->getUserAgent(),
+			$siteConfiguration->getCurlDisableVerifyPeer(),
+			$siteConfiguration->getCurlCookieJar()
+		);
+	}
+
+	function doApiCall($apiParams, $method = 'GET')
+	{
+		$this->ensureLoggedIn();
+		$apiParams['assert'] = 'user';
+
+		return $this->callApi($apiParams, $method);
+	}
+
+	private function ensureLoggedIn()
+	{
+		if ($this->knownLoggedIn) {
+			return;
+		}
+
+		$userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
+		if (isset($userinfoResult->query->userinfo->anon)) {
+			// not logged in.
+			$this->logIn();
+
+			// retest
+			$userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
+			if (isset($userinfoResult->query->userinfo->anon)) {
+				throw new MediaWikiApiException('Unable to log in.');
+			}
+			else {
+				$this->knownLoggedIn = true;
+			}
+		}
+		else {
+			$this->knownLoggedIn = true;
+		}
+	}
+
+	/**
+	 * @param $apiParams
+	 * @param $method
+	 *
+	 * @return mixed
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 */
+	private function callApi($apiParams, $method)
+	{
+		$apiParams['format'] = 'json';
+
+		if ($method == 'GET') {
+			$data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
+		}
+		elseif ($method == 'POST') {
+			$data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
+		}
+		else {
+			throw new ApplicationLogicException('Unsupported HTTP Method');
+		}
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$result = json_decode($data);
+
+		return $result;
+	}
+
+	private function logIn()
+	{
+		// get token
+		$tokenParams = array(
+			'action' => 'query',
+			'meta'   => 'tokens',
+			'type'   => 'login',
+		);
+
+		$response = $this->callApi($tokenParams, 'POST');
+
+		if (isset($response->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		$token = $response->query->tokens->logintoken;
+
+		if ($token === null) {
+			throw new MediaWikiApiException('Edit token could not be acquired');
+		}
+
+		$params = array(
+			'action' => 'login',
+			'lgname' => $this->creationBotUsername,
+			'lgpassword' => $this->creationBotPassword,
+			'lgtoken' => $token,
+		);
+
+		$loginResponse = $this->callApi($params, 'POST');
+
+		if($loginResponse->login->result == 'Success'){
+			return;
+		}
+
+		throw new ApplicationLogicException(json_encode($loginResponse));
+	}
 }
\ No newline at end of file

includes/Helpers/Interfaces/IMediaWikiClient.php

Doc Comments +3 added lines

@@ -10,5 +10,8 @@
 
 interface IMediaWikiClient
 {
+    /**
+     * @param string $method
+     */
     function doApiCall($params, $method);
 }
\ No newline at end of file

Indentation +1 added lines, -1 removed lines

@@ -10,5 +10,5 @@
 
 interface IMediaWikiClient
 {
-    function doApiCall($params, $method);
+	function doApiCall($params, $method);
 }
\ No newline at end of file

includes/Helpers/OAuthUserHelper.php

Doc Comments +13 added lines, -1 removed lines

@@ -63,6 +63,10 @@ 
     private $siteConfiguration;
 
     #region Static methods
+
+    /**
+     * @param null|string $requestToken
+     */
     public static function findUserByRequestToken($requestToken, PdoDatabase $database)
     {
         $statement = $database->prepare(<<<'SQL'
@@ -119,6 +123,11 @@ 
         }
     }
 
+    /**
+     * @param integer $userId
+     * @param null|PdoDatabase $database
+     * @param string $tokenType
+     */
     private static function runTokenCount($userId, $database, $tokenType)
     {
         if (self::$tokenCountStatement === null) {
@@ -182,7 +191,7 @@ 
     /**
      * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
      * procedure before configuring.
-     * @return bool
+     * @return boolean|null
      */
     public function isPartiallyLinked()
     {
@@ -245,6 +254,9 @@ 
         return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
     }
 
+    /**
+     * @param null|string $verificationToken
+     */
     public function completeHandshake($verificationToken)
     {
         $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));

Indentation +403 added lines, -403 removed lines

@@ -22,411 +22,411 @@
 
 class OAuthUserHelper implements IMediaWikiClient
 {
-    const TOKEN_REQUEST = 'request';
-    const TOKEN_ACCESS = 'access';
-    /** @var PDOStatement */
-    private static $tokenCountStatement = null;
-    /** @var PDOStatement */
-    private $getTokenStatement;
-    /**
-     * @var User
-     */
-    private $user;
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-    /**
-     * @var IOAuthProtocolHelper
-     */
-    private $oauthProtocolHelper;
-    /**
-     * @var bool|null Is the user linked to OAuth
-     */
-    private $linked;
-    private $partiallyLinked;
-    /** @var OAuthToken */
-    private $accessToken;
-    /** @var bool */
-    private $accessTokenLoaded = false;
-    /**
-     * @var OAuthIdentity
-     */
-    private $identity = null;
-    /**
-     * @var bool
-     */
-    private $identityLoaded = false;
-    /**
-     * @var SiteConfiguration
-     */
-    private $siteConfiguration;
-
-    #region Static methods
-    public static function findUserByRequestToken($requestToken, PdoDatabase $database)
-    {
-        $statement = $database->prepare(<<<'SQL'
+	const TOKEN_REQUEST = 'request';
+	const TOKEN_ACCESS = 'access';
+	/** @var PDOStatement */
+	private static $tokenCountStatement = null;
+	/** @var PDOStatement */
+	private $getTokenStatement;
+	/**
+	 * @var User
+	 */
+	private $user;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+	/**
+	 * @var IOAuthProtocolHelper
+	 */
+	private $oauthProtocolHelper;
+	/**
+	 * @var bool|null Is the user linked to OAuth
+	 */
+	private $linked;
+	private $partiallyLinked;
+	/** @var OAuthToken */
+	private $accessToken;
+	/** @var bool */
+	private $accessTokenLoaded = false;
+	/**
+	 * @var OAuthIdentity
+	 */
+	private $identity = null;
+	/**
+	 * @var bool
+	 */
+	private $identityLoaded = false;
+	/**
+	 * @var SiteConfiguration
+	 */
+	private $siteConfiguration;
+
+	#region Static methods
+	public static function findUserByRequestToken($requestToken, PdoDatabase $database)
+	{
+		$statement = $database->prepare(<<<'SQL'
             SELECT u.* FROM user u 
             INNER JOIN oauthtoken t ON t.user = u.id 
             WHERE t.type = :type AND t.token = :token
 SQL
-        );
-        $statement->execute(array(':type' => self::TOKEN_REQUEST, ':token' => $requestToken));
-
-        /** @var User $user */
-        $user = $statement->fetchObject(User::class);
-        $statement->closeCursor();
-
-        if ($user === false) {
-            throw new ApplicationLogicException('Token not found in store, please try again');
-        }
-
-        $user->setDatabase($database);
-
-        return $user;
-    }
-
-    public static function userIsFullyLinked(User $user, PdoDatabase $database = null)
-    {
-        if (self::$tokenCountStatement === null && $database === null) {
-            throw new ApplicationLogicException('Static link request without initialised statement');
-        }
-
-        return self::runTokenCount($user->getId(), $database, self::TOKEN_ACCESS);
-    }
-
-    public static function userIsPartiallyLinked(User $user, PdoDatabase $database = null)
-    {
-        if (self::$tokenCountStatement === null && $database === null) {
-            throw new ApplicationLogicException('Static link request without initialised statement');
-        }
-
-        if (self::userIsFullyLinked($user, $database)) {
-            return false;
-        }
-
-        return self::runTokenCount($user->getId(), $database, self::TOKEN_REQUEST)
-            || $user->getOnWikiName() == null;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     */
-    public static function prepareTokenCountStatement(PdoDatabase $database)
-    {
-        if (self::$tokenCountStatement === null) {
-            self::$tokenCountStatement = $database->prepare('SELECT COUNT(*) FROM oauthtoken WHERE user = :user AND type = :type');
-        }
-    }
-
-    private static function runTokenCount($userId, $database, $tokenType)
-    {
-        if (self::$tokenCountStatement === null) {
-            self::prepareTokenCountStatement($database);
-        }
-
-        self::$tokenCountStatement->execute(array(
-            ':user' => $userId,
-            ':type' => $tokenType,
-        ));
-
-        $tokenCount = self::$tokenCountStatement->fetchColumn();
-        $linked = $tokenCount > 0;
-        self::$tokenCountStatement->closeCursor();
-
-        return $linked;
-    }
-
-    #endregion Static methods
-
-    /**
-     * OAuthUserHelper constructor.
-     *
-     * @param User                 $user
-     * @param PdoDatabase          $database
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     * @param SiteConfiguration    $siteConfiguration
-     */
-    public function __construct(
-        User $user,
-        PdoDatabase $database,
-        IOAuthProtocolHelper $oauthProtocolHelper,
-        SiteConfiguration $siteConfiguration
-    ) {
-        $this->user = $user;
-        $this->database = $database;
-        $this->oauthProtocolHelper = $oauthProtocolHelper;
-
-        $this->linked = null;
-        $this->partiallyLinked = null;
-        $this->siteConfiguration = $siteConfiguration;
-
-        self::prepareTokenCountStatement($database);
-        $this->getTokenStatement = $this->database->prepare('SELECT * FROM oauthtoken WHERE user = :user AND type = :type');
-    }
-
-    /**
-     * Determines if the user is fully connected to OAuth.
-     *
-     * @return bool
-     */
-    public function isFullyLinked()
-    {
-        if ($this->linked === null) {
-            $this->linked = self::userIsFullyLinked($this->user, $this->database);
-        }
-
-        return $this->linked;
-    }
-
-    /**
-     * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
-     * procedure before configuring.
-     * @return bool
-     */
-    public function isPartiallyLinked()
-    {
-        if ($this->partiallyLinked === null) {
-            $this->partiallyLinked = self::userIsPartiallyLinked($this->user, $this->database);
-        }
-
-        return $this->partiallyLinked;
-    }
-
-    /**
-     * @throws OAuthException
-     */
-    public function refreshIdentity()
-    {
-        $this->loadIdentity();
-
-        if ($this->identity === null) {
-            $this->identity = new OAuthIdentity();
-            $this->identity->setUserId($this->user->getId());
-            $this->identity->setDatabase($this->database);
-        }
-
-        $token = $this->loadAccessToken();
-
-        $rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
-
-        $this->identity->populate($rawTicket);
-
-        if (!$this->identityIsValid()) {
-            throw new OAuthException('Identity ticket is not valid!');
-        }
-
-        $this->identity->save();
-
-        $this->user->setOnWikiName($this->identity->getUsername());
-        $this->user->save();
-    }
-
-    public function getRequestToken()
-    {
-        $token = $this->oauthProtocolHelper->getRequestToken();
-
-        $this->partiallyLinked = true;
-        $this->linked = false;
-
-        $this->database
-            ->prepare('DELETE FROM oauthtoken WHERE user = :user AND type = :type')
-            ->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
-
-        $this->database
-            ->prepare('INSERT INTO oauthtoken (user, type, token, secret, expiry) VALUES (:user, :type, :token, :secret, DATE_ADD(NOW(), INTERVAL 1 DAY))')
-            ->execute(array(
-                ':user'   => $this->user->getId(),
-                ':type'   => self::TOKEN_REQUEST,
-                ':token'  => $token->key,
-                ':secret' => $token->secret,
-            ));
-
-        return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
-    }
-
-    public function completeHandshake($verificationToken)
-    {
-        $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
-
-        /** @var OAuthToken $token */
-        $token = $this->getTokenStatement->fetchObject(OAuthToken::class);
-        $this->getTokenStatement->closeCursor();
-
-        if ($token === false) {
-            throw new ApplicationLogicException('Cannot find request token');
-        }
-
-        $token->setDatabase($this->database);
-
-        $accessToken = $this->oauthProtocolHelper->callbackCompleted($token->getToken(), $token->getSecret(),
-            $verificationToken);
-
-        $clearStatement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :u AND type = :t');
-        $clearStatement->execute(array(':u' => $this->user->getId(), ':t' => self::TOKEN_ACCESS));
-
-        $token->setToken($accessToken->key);
-        $token->setSecret($accessToken->secret);
-        $token->setType(self::TOKEN_ACCESS);
-        $token->setExpiry(null);
-        $token->save();
-
-        $this->partiallyLinked = false;
-        $this->linked = true;
-
-        $this->refreshIdentity();
-    }
-
-    public function detach()
-    {
-        $this->loadIdentity();
-
-        $this->identity->delete();
-        $statement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :user');
-        $statement->execute(array(':user' => $this->user->getId()));
-
-        $this->identity = null;
-        $this->linked = false;
-        $this->partiallyLinked = false;
-    }
-
-    /**
-     * @param bool $expiredOk
-     *
-     * @return OAuthIdentity
-     * @throws OAuthException
-     */
-    public function getIdentity($expiredOk = false)
-    {
-        $this->loadIdentity();
-
-        if (!$this->identityIsValid($expiredOk)) {
-            throw new OAuthException('Stored identity is not valid.');
-        }
-
-        return $this->identity;
-    }
-
-    public function doApiCall($params, $method)
-    {
-        // Ensure we're logged in
-        $params['assert'] = 'user';
-
-        $token = $this->loadAccessToken();
-        return $this->oauthProtocolHelper->apiCall($params, $token->getToken(), $token->getSecret(), $method);
-    }
-
-    /**
-     * @param bool $expiredOk
-     *
-     * @return bool
-     */
-    private function identityIsValid($expiredOk = false)
-    {
-        $this->loadIdentity();
-
-        if ($this->identity === null) {
-            return false;
-        }
-
-        if ($this->identity->getIssuedAtTime() === false
-            || $this->identity->getExpirationTime() === false
-            || $this->identity->getAudience() === false
-            || $this->identity->getIssuer() === false
-        ) {
-            // this isn't populated properly.
-            return false;
-        }
-
-        $issue = DateTimeImmutable::createFromFormat("U", $this->identity->getIssuedAtTime());
-        $now = new DateTimeImmutable();
-
-        if ($issue > $now) {
-            // wat.
-            return false;
-        }
-
-        if ($this->identityExpired() && !$expiredOk) {
-            // soz.
-            return false;
-        }
-
-        if ($this->identity->getAudience() !== $this->siteConfiguration->getOAuthConsumerToken()) {
-            // token not issued for us
-            return false;
-        }
-
-        if ($this->identity->getIssuer() !== $this->siteConfiguration->getOauthMediaWikiCanonicalServer()) {
-            // token not issued by the right person
-            return false;
-        }
-
-        // can't find a reason to not trust it
-        return true;
-    }
-
-    /**
-     * @return bool
-     */
-    public function identityExpired()
-    {
-        // allowed max age
-        $gracePeriod = $this->siteConfiguration->getOauthIdentityGraceTime();
-
-        $expiry = DateTimeImmutable::createFromFormat("U", $this->identity->getExpirationTime());
-        $graceExpiry = $expiry->modify($gracePeriod);
-        $now = new DateTimeImmutable();
-
-        return $graceExpiry < $now;
-    }
-
-    /**
-     * Loads the OAuth identity from the database for the current user.
-     */
-    private function loadIdentity()
-    {
-        if ($this->identityLoaded) {
-            return;
-        }
-
-        $statement = $this->database->prepare('SELECT * FROM oauthidentity WHERE user = :user');
-        $statement->execute(array(':user' => $this->user->getId()));
-        /** @var OAuthIdentity $obj */
-        $obj = $statement->fetchObject(OAuthIdentity::class);
-
-        if ($obj === false) {
-            // failed to load identity.
-            $this->identityLoaded = true;
-            $this->identity = null;
-
-            return;
-        }
-
-        $obj->setDatabase($this->database);
-        $this->identityLoaded = true;
-        $this->identity = $obj;
-    }
-
-    /**
-     * @return OAuthToken
-     * @throws OAuthException
-     */
-    private function loadAccessToken()
-    {
-        if (!$this->accessTokenLoaded) {
-            $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_ACCESS));
-            /** @var OAuthToken $token */
-            $token = $this->getTokenStatement->fetchObject(OAuthToken::class);
-            $this->getTokenStatement->closeCursor();
-
-            if ($token === false) {
-                throw new OAuthException('Access token not found!');
-            }
-
-            $this->accessToken = $token;
-            $this->accessTokenLoaded = true;
-        }
-
-        return $this->accessToken;
-    }
+		);
+		$statement->execute(array(':type' => self::TOKEN_REQUEST, ':token' => $requestToken));
+
+		/** @var User $user */
+		$user = $statement->fetchObject(User::class);
+		$statement->closeCursor();
+
+		if ($user === false) {
+			throw new ApplicationLogicException('Token not found in store, please try again');
+		}
+
+		$user->setDatabase($database);
+
+		return $user;
+	}
+
+	public static function userIsFullyLinked(User $user, PdoDatabase $database = null)
+	{
+		if (self::$tokenCountStatement === null && $database === null) {
+			throw new ApplicationLogicException('Static link request without initialised statement');
+		}
+
+		return self::runTokenCount($user->getId(), $database, self::TOKEN_ACCESS);
+	}
+
+	public static function userIsPartiallyLinked(User $user, PdoDatabase $database = null)
+	{
+		if (self::$tokenCountStatement === null && $database === null) {
+			throw new ApplicationLogicException('Static link request without initialised statement');
+		}
+
+		if (self::userIsFullyLinked($user, $database)) {
+			return false;
+		}
+
+		return self::runTokenCount($user->getId(), $database, self::TOKEN_REQUEST)
+			|| $user->getOnWikiName() == null;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	public static function prepareTokenCountStatement(PdoDatabase $database)
+	{
+		if (self::$tokenCountStatement === null) {
+			self::$tokenCountStatement = $database->prepare('SELECT COUNT(*) FROM oauthtoken WHERE user = :user AND type = :type');
+		}
+	}
+
+	private static function runTokenCount($userId, $database, $tokenType)
+	{
+		if (self::$tokenCountStatement === null) {
+			self::prepareTokenCountStatement($database);
+		}
+
+		self::$tokenCountStatement->execute(array(
+			':user' => $userId,
+			':type' => $tokenType,
+		));
+
+		$tokenCount = self::$tokenCountStatement->fetchColumn();
+		$linked = $tokenCount > 0;
+		self::$tokenCountStatement->closeCursor();
+
+		return $linked;
+	}
+
+	#endregion Static methods
+
+	/**
+	 * OAuthUserHelper constructor.
+	 *
+	 * @param User                 $user
+	 * @param PdoDatabase          $database
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 * @param SiteConfiguration    $siteConfiguration
+	 */
+	public function __construct(
+		User $user,
+		PdoDatabase $database,
+		IOAuthProtocolHelper $oauthProtocolHelper,
+		SiteConfiguration $siteConfiguration
+	) {
+		$this->user = $user;
+		$this->database = $database;
+		$this->oauthProtocolHelper = $oauthProtocolHelper;
+
+		$this->linked = null;
+		$this->partiallyLinked = null;
+		$this->siteConfiguration = $siteConfiguration;
+
+		self::prepareTokenCountStatement($database);
+		$this->getTokenStatement = $this->database->prepare('SELECT * FROM oauthtoken WHERE user = :user AND type = :type');
+	}
+
+	/**
+	 * Determines if the user is fully connected to OAuth.
+	 *
+	 * @return bool
+	 */
+	public function isFullyLinked()
+	{
+		if ($this->linked === null) {
+			$this->linked = self::userIsFullyLinked($this->user, $this->database);
+		}
+
+		return $this->linked;
+	}
+
+	/**
+	 * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
+	 * procedure before configuring.
+	 * @return bool
+	 */
+	public function isPartiallyLinked()
+	{
+		if ($this->partiallyLinked === null) {
+			$this->partiallyLinked = self::userIsPartiallyLinked($this->user, $this->database);
+		}
+
+		return $this->partiallyLinked;
+	}
+
+	/**
+	 * @throws OAuthException
+	 */
+	public function refreshIdentity()
+	{
+		$this->loadIdentity();
+
+		if ($this->identity === null) {
+			$this->identity = new OAuthIdentity();
+			$this->identity->setUserId($this->user->getId());
+			$this->identity->setDatabase($this->database);
+		}
+
+		$token = $this->loadAccessToken();
+
+		$rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
+
+		$this->identity->populate($rawTicket);
+
+		if (!$this->identityIsValid()) {
+			throw new OAuthException('Identity ticket is not valid!');
+		}
+
+		$this->identity->save();
+
+		$this->user->setOnWikiName($this->identity->getUsername());
+		$this->user->save();
+	}
+
+	public function getRequestToken()
+	{
+		$token = $this->oauthProtocolHelper->getRequestToken();
+
+		$this->partiallyLinked = true;
+		$this->linked = false;
+
+		$this->database
+			->prepare('DELETE FROM oauthtoken WHERE user = :user AND type = :type')
+			->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
+
+		$this->database
+			->prepare('INSERT INTO oauthtoken (user, type, token, secret, expiry) VALUES (:user, :type, :token, :secret, DATE_ADD(NOW(), INTERVAL 1 DAY))')
+			->execute(array(
+				':user'   => $this->user->getId(),
+				':type'   => self::TOKEN_REQUEST,
+				':token'  => $token->key,
+				':secret' => $token->secret,
+			));
+
+		return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
+	}
+
+	public function completeHandshake($verificationToken)
+	{
+		$this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
+
+		/** @var OAuthToken $token */
+		$token = $this->getTokenStatement->fetchObject(OAuthToken::class);
+		$this->getTokenStatement->closeCursor();
+
+		if ($token === false) {
+			throw new ApplicationLogicException('Cannot find request token');
+		}
+
+		$token->setDatabase($this->database);
+
+		$accessToken = $this->oauthProtocolHelper->callbackCompleted($token->getToken(), $token->getSecret(),
+			$verificationToken);
+
+		$clearStatement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :u AND type = :t');
+		$clearStatement->execute(array(':u' => $this->user->getId(), ':t' => self::TOKEN_ACCESS));
+
+		$token->setToken($accessToken->key);
+		$token->setSecret($accessToken->secret);
+		$token->setType(self::TOKEN_ACCESS);
+		$token->setExpiry(null);
+		$token->save();
+
+		$this->partiallyLinked = false;
+		$this->linked = true;
+
+		$this->refreshIdentity();
+	}
+
+	public function detach()
+	{
+		$this->loadIdentity();
+
+		$this->identity->delete();
+		$statement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :user');
+		$statement->execute(array(':user' => $this->user->getId()));
+
+		$this->identity = null;
+		$this->linked = false;
+		$this->partiallyLinked = false;
+	}
+
+	/**
+	 * @param bool $expiredOk
+	 *
+	 * @return OAuthIdentity
+	 * @throws OAuthException
+	 */
+	public function getIdentity($expiredOk = false)
+	{
+		$this->loadIdentity();
+
+		if (!$this->identityIsValid($expiredOk)) {
+			throw new OAuthException('Stored identity is not valid.');
+		}
+
+		return $this->identity;
+	}
+
+	public function doApiCall($params, $method)
+	{
+		// Ensure we're logged in
+		$params['assert'] = 'user';
+
+		$token = $this->loadAccessToken();
+		return $this->oauthProtocolHelper->apiCall($params, $token->getToken(), $token->getSecret(), $method);
+	}
+
+	/**
+	 * @param bool $expiredOk
+	 *
+	 * @return bool
+	 */
+	private function identityIsValid($expiredOk = false)
+	{
+		$this->loadIdentity();
+
+		if ($this->identity === null) {
+			return false;
+		}
+
+		if ($this->identity->getIssuedAtTime() === false
+			|| $this->identity->getExpirationTime() === false
+			|| $this->identity->getAudience() === false
+			|| $this->identity->getIssuer() === false
+		) {
+			// this isn't populated properly.
+			return false;
+		}
+
+		$issue = DateTimeImmutable::createFromFormat("U", $this->identity->getIssuedAtTime());
+		$now = new DateTimeImmutable();
+
+		if ($issue > $now) {
+			// wat.
+			return false;
+		}
+
+		if ($this->identityExpired() && !$expiredOk) {
+			// soz.
+			return false;
+		}
+
+		if ($this->identity->getAudience() !== $this->siteConfiguration->getOAuthConsumerToken()) {
+			// token not issued for us
+			return false;
+		}
+
+		if ($this->identity->getIssuer() !== $this->siteConfiguration->getOauthMediaWikiCanonicalServer()) {
+			// token not issued by the right person
+			return false;
+		}
+
+		// can't find a reason to not trust it
+		return true;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function identityExpired()
+	{
+		// allowed max age
+		$gracePeriod = $this->siteConfiguration->getOauthIdentityGraceTime();
+
+		$expiry = DateTimeImmutable::createFromFormat("U", $this->identity->getExpirationTime());
+		$graceExpiry = $expiry->modify($gracePeriod);
+		$now = new DateTimeImmutable();
+
+		return $graceExpiry < $now;
+	}
+
+	/**
+	 * Loads the OAuth identity from the database for the current user.
+	 */
+	private function loadIdentity()
+	{
+		if ($this->identityLoaded) {
+			return;
+		}
+
+		$statement = $this->database->prepare('SELECT * FROM oauthidentity WHERE user = :user');
+		$statement->execute(array(':user' => $this->user->getId()));
+		/** @var OAuthIdentity $obj */
+		$obj = $statement->fetchObject(OAuthIdentity::class);
+
+		if ($obj === false) {
+			// failed to load identity.
+			$this->identityLoaded = true;
+			$this->identity = null;
+
+			return;
+		}
+
+		$obj->setDatabase($this->database);
+		$this->identityLoaded = true;
+		$this->identity = $obj;
+	}
+
+	/**
+	 * @return OAuthToken
+	 * @throws OAuthException
+	 */
+	private function loadAccessToken()
+	{
+		if (!$this->accessTokenLoaded) {
+			$this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_ACCESS));
+			/** @var OAuthToken $token */
+			$token = $this->getTokenStatement->fetchObject(OAuthToken::class);
+			$this->getTokenStatement->closeCursor();
+
+			if ($token === false) {
+				throw new OAuthException('Access token not found!');
+			}
+
+			$this->accessToken = $token;
+			$this->accessTokenLoaded = true;
+		}
+
+		return $this->accessToken;
+	}
 }
\ No newline at end of file

includes/API/Actions/StatsAction.php

Indentation +44 added lines, -44 removed lines

@@ -20,58 +20,58 @@
  */
 class StatsAction extends ApiPageBase implements IApiAction
 {
-    /**
-     * The target user
-     * @var User $user
-     */
-    private $user;
+	/**
+	 * The target user
+	 * @var User $user
+	 */
+	private $user;
 
-    /**
-     * Summary of execute
-     *
-     * @param \DOMElement $apiDocument
-     *
-     * @return \DOMElement
-     * @throws ApiException
-     * @throws \Exception
-     */
-    public function executeApiAction(\DOMElement $apiDocument)
-    {
-        $username = WebRequest::getString('user');
-        $wikiusername = WebRequest::getString('wikiuser');
+	/**
+	 * Summary of execute
+	 *
+	 * @param \DOMElement $apiDocument
+	 *
+	 * @return \DOMElement
+	 * @throws ApiException
+	 * @throws \Exception
+	 */
+	public function executeApiAction(\DOMElement $apiDocument)
+	{
+		$username = WebRequest::getString('user');
+		$wikiusername = WebRequest::getString('wikiuser');
 
-        if ($username === null && $wikiusername === null) {
-            throw new ApiException("Please specify a username using either user or wikiuser parameters.");
-        }
+		if ($username === null && $wikiusername === null) {
+			throw new ApiException("Please specify a username using either user or wikiuser parameters.");
+		}
 
-        $userElement = $this->document->createElement("user");
-        $apiDocument->appendChild($userElement);
+		$userElement = $this->document->createElement("user");
+		$apiDocument->appendChild($userElement);
 
-        if ($username !== null) {
-            $user = User::getByUsername($username, $this->getDatabase());
-        }
-        else {
-            $user = User::getByOnWikiUsername($wikiusername, $this->getDatabase());
-        }
+		if ($username !== null) {
+			$user = User::getByUsername($username, $this->getDatabase());
+		}
+		else {
+			$user = User::getByOnWikiUsername($wikiusername, $this->getDatabase());
+		}
 
-        if ($user === false) {
-            $userElement->setAttribute("missing", "true");
+		if ($user === false) {
+			$userElement->setAttribute("missing", "true");
 
-            return $apiDocument;
-        }
+			return $apiDocument;
+		}
 
-        $this->user = $user;
+		$this->user = $user;
 
-        $oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
-            $this->getSiteConfiguration());
+		$oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
+			$this->getSiteConfiguration());
 
-        $userElement->setAttribute("username", $this->user->getUsername());
-        $userElement->setAttribute("status", $this->user->getStatus());
-        $userElement->setAttribute("lastactive", $this->user->getLastActive());
-        $userElement->setAttribute("welcome_template", $this->user->getWelcomeTemplate());
-        $userElement->setAttribute("onwikiname", $this->user->getOnWikiName());
-        $userElement->setAttribute("oauth", $oauth->isFullyLinked() ? "true" : "false");
+		$userElement->setAttribute("username", $this->user->getUsername());
+		$userElement->setAttribute("status", $this->user->getStatus());
+		$userElement->setAttribute("lastactive", $this->user->getLastActive());
+		$userElement->setAttribute("welcome_template", $this->user->getWelcomeTemplate());
+		$userElement->setAttribute("onwikiname", $this->user->getOnWikiName());
+		$userElement->setAttribute("oauth", $oauth->isFullyLinked() ? "true" : "false");
 
-        return $apiDocument;
-    }
+		return $apiDocument;
+	}
 }

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