mdaniels5757 / waca

includes/Background/CreationTaskBase.php

Indentation +152 added lines, -152 removed lines

@@ -21,156 +21,156 @@
 
 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();
-        $parameters = $this->getParameters();
-
-        if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
-            $this->markCancelled('Request is not deferred to the job queue');
-
-            return;
-        }
-
-        if ($this->request->getEmailSent() != 0 && !isset($parameters->emailText)) {
-            $this->markFailed('Request has already been sent a templated email');
-
-            return;
-        }
-
-        if ($this->request->getEmail() === $this->getSiteConfiguration()->getDataClearEmail()) {
-            $this->markFailed('Private data of request has been purged.');
-
-            return;
-        }
-
-        $emailText = null;
-        $ccMailingList = null;
-        $logTarget = null;
-
-        if (isset($parameters->emailText) && isset($parameters->ccMailingList)) {
-            $emailText = $parameters->emailText;
-            $ccMailingList = $parameters->ccMailingList;
-            $logTarget = "custom-y";
-        }
-
-        if ($this->getEmailTemplate() !== null) {
-            $emailText = $this->getEmailTemplate()->getText();
-            $ccMailingList = false;
-            $logTarget = $this->getEmailTemplate()->getId();
-        }
-
-        if ($emailText === null || $ccMailingList === null) {
-            $this->markFailed('Unable to get closure email text');
-
-            return;
-        }
-
-        try {
-            $this->performCreation($user);
-
-            $this->request->setStatus(RequestStatus::CLOSED);
-            $this->request->setQueue(null);
-            $this->request->setReserved(null);
-            $this->request->setEmailSent(true);
-            $this->request->save();
-
-            // Log the closure as the user
-            $logComment = $this->getEmailTemplate() === null ? $emailText : null;
-            Logger::closeRequest($this->getDatabase(), $this->request, $logTarget, $logComment, $this->getTriggerUser());
-
-            $requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
-            $requestEmailHelper->sendMail($this->request, $emailText, $this->getTriggerUser(), $ccMailingList);
-        }
-        catch (Exception $ex) {
-            if (mb_strlen($ex->getMessage()) > 255) {
-                ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
-            }
-
-            $this->markFailed(substr($ex->getMessage(), 0, 255));
-
-            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;
-    }
-
-    /** @noinspection PhpUnusedParameterInspection */
-    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, bool $acknowledged = false)
-    {
-        $this->request->setStatus(RequestStatus::HOSPITAL);
-        $this->request->setQueue(null);
-        $this->request->save();
-
-        $this->getNotificationHelper()->requestCreationFailed($this->request, $this->getTriggerUser());
-
-        Logger::hospitalised($this->getDatabase(), $this->request);
-
-        // auto-acknowledge failed creation tasks, as these land in the hospital queue anyway.
-        parent::markFailed($reason, true);
-        Logger::backgroundJobAcknowledged($this->getDatabase(), $this->getJob(), "Auto-acknowledged due to request deferral to hospital queue");
-    }
-
-    /**
-     * @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');
-        }
-
-        $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.');
-        }
-
-        $this->request->setStatus(RequestStatus::CLOSED);
-        $this->request->save();
-    }
+	/** @var Request */
+	private $request;
+	/**
+	 * @var MediaWikiHelper
+	 * Don't use this directly.
+	 */
+	private $mwHelper = null;
+
+	public function execute()
+	{
+		$this->request = $this->getRequest();
+		$user = $this->getTriggerUser();
+		$parameters = $this->getParameters();
+
+		if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
+			$this->markCancelled('Request is not deferred to the job queue');
+
+			return;
+		}
+
+		if ($this->request->getEmailSent() != 0 && !isset($parameters->emailText)) {
+			$this->markFailed('Request has already been sent a templated email');
+
+			return;
+		}
+
+		if ($this->request->getEmail() === $this->getSiteConfiguration()->getDataClearEmail()) {
+			$this->markFailed('Private data of request has been purged.');
+
+			return;
+		}
+
+		$emailText = null;
+		$ccMailingList = null;
+		$logTarget = null;
+
+		if (isset($parameters->emailText) && isset($parameters->ccMailingList)) {
+			$emailText = $parameters->emailText;
+			$ccMailingList = $parameters->ccMailingList;
+			$logTarget = "custom-y";
+		}
+
+		if ($this->getEmailTemplate() !== null) {
+			$emailText = $this->getEmailTemplate()->getText();
+			$ccMailingList = false;
+			$logTarget = $this->getEmailTemplate()->getId();
+		}
+
+		if ($emailText === null || $ccMailingList === null) {
+			$this->markFailed('Unable to get closure email text');
+
+			return;
+		}
+
+		try {
+			$this->performCreation($user);
+
+			$this->request->setStatus(RequestStatus::CLOSED);
+			$this->request->setQueue(null);
+			$this->request->setReserved(null);
+			$this->request->setEmailSent(true);
+			$this->request->save();
+
+			// Log the closure as the user
+			$logComment = $this->getEmailTemplate() === null ? $emailText : null;
+			Logger::closeRequest($this->getDatabase(), $this->request, $logTarget, $logComment, $this->getTriggerUser());
+
+			$requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
+			$requestEmailHelper->sendMail($this->request, $emailText, $this->getTriggerUser(), $ccMailingList);
+		}
+		catch (Exception $ex) {
+			if (mb_strlen($ex->getMessage()) > 255) {
+				ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
+			}
+
+			$this->markFailed(substr($ex->getMessage(), 0, 255));
+
+			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;
+	}
+
+	/** @noinspection PhpUnusedParameterInspection */
+	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, bool $acknowledged = false)
+	{
+		$this->request->setStatus(RequestStatus::HOSPITAL);
+		$this->request->setQueue(null);
+		$this->request->save();
+
+		$this->getNotificationHelper()->requestCreationFailed($this->request, $this->getTriggerUser());
+
+		Logger::hospitalised($this->getDatabase(), $this->request);
+
+		// auto-acknowledge failed creation tasks, as these land in the hospital queue anyway.
+		parent::markFailed($reason, true);
+		Logger::backgroundJobAcknowledged($this->getDatabase(), $this->getJob(), "Auto-acknowledged due to request deferral to hospital queue");
+	}
+
+	/**
+	 * @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');
+		}
+
+		$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.');
+		}
+
+		$this->request->setStatus(RequestStatus::CLOSED);
+		$this->request->save();
+	}
 }
\ No newline at end of file

includes/Background/BackgroundTaskBase.php

Indentation +264 added lines, -264 removed lines

@@ -23,268 +23,268 @@
 
 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');
-            }
-        }
-
-        if ($this->job->getParameters() !== null) {
-            $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_QUEUED:
-                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, bool $acknowledged = false)
-    {
-        $this->job->setStatus(JobQueue::STATUS_FAILED);
-        $this->job->setError($reason);
-        $this->job->setAcknowledged($acknowledged ? 1 : 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');
+			}
+		}
+
+		if ($this->job->getParameters() !== null) {
+			$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_QUEUED:
+				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, bool $acknowledged = false)
+	{
+		$this->job->setStatus(JobQueue::STATUS_FAILED);
+		$this->job->setError($reason);
+		$this->job->setAcknowledged($acknowledged ? 1 : 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;
+	}
 }

includes/Helpers/MediaWikiHelper.php

Indentation +266 added lines, -266 removed lines

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

Braces +1 added lines, -2 removed lines

@@ -228,8 +228,7 @@
                 foreach ($req->fields as $name => $data) {
                     if ($data->type === 'checkbox') {
                         $checkboxFields[] = $name;
-                    }
-                    else {
+                    } else {
                         $requiredFields[] = $name;
                     }
                 }

includes/Helpers/RequestEmailHelper.php

Indentation +43 added lines, -43 removed lines

@@ -15,57 +15,57 @@
 
 class RequestEmailHelper
 {
-    /**
-     * @var IEmailHelper
-     */
-    private $emailHelper;
+	/**
+	 * @var IEmailHelper
+	 */
+	private $emailHelper;
 
-    /**
-     * RequestEmailHelper constructor.
-     *
-     * @param IEmailHelper $emailHelper
-     */
-    public function __construct(IEmailHelper $emailHelper)
-    {
-        $this->emailHelper = $emailHelper;
-    }
+	/**
+	 * RequestEmailHelper constructor.
+	 *
+	 * @param IEmailHelper $emailHelper
+	 */
+	public function __construct(IEmailHelper $emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
 
-    /**
-     * @param Request $request
-     * @param string  $mailText
-     * @param User    $sendingUser      The user sending the email
-     * @param boolean $ccMailingList
-     */
-    public function sendMail(Request $request, $mailText, User $sendingUser, $ccMailingList)
-    {
-        $headers = array(
-            'X-ACC-Request' => $request->getId(),
-            'X-ACC-UserID'  => $sendingUser->getId(),
-        );
+	/**
+	 * @param Request $request
+	 * @param string  $mailText
+	 * @param User    $sendingUser      The user sending the email
+	 * @param boolean $ccMailingList
+	 */
+	public function sendMail(Request $request, $mailText, User $sendingUser, $ccMailingList)
+	{
+		$headers = array(
+			'X-ACC-Request' => $request->getId(),
+			'X-ACC-UserID'  => $sendingUser->getId(),
+		);
 
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $request->getDatabase());
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $request->getDatabase());
 
-        if ($ccMailingList) {
-            $headers['Cc'] = $domain->getEmailReplyAddress();
-        }
+		if ($ccMailingList) {
+			$headers['Cc'] = $domain->getEmailReplyAddress();
+		}
 
-        $helper = $this->emailHelper;
+		$helper = $this->emailHelper;
 
-        // FIXME: domains
-        $preferenceManager = new PreferenceManager($request->getDatabase(), $sendingUser->getId(), 1);
+		// FIXME: domains
+		$preferenceManager = new PreferenceManager($request->getDatabase(), $sendingUser->getId(), 1);
 
-        $emailSig = $preferenceManager->getPreference(PreferenceManager::PREF_EMAIL_SIGNATURE);
-        if ($emailSig !== '' || $emailSig !== null) {
-            $emailSig = "\n\n" . $emailSig;
-        }
+		$emailSig = $preferenceManager->getPreference(PreferenceManager::PREF_EMAIL_SIGNATURE);
+		if ($emailSig !== '' || $emailSig !== null) {
+			$emailSig = "\n\n" . $emailSig;
+		}
 
-        $subject = "RE: [ACC #{$request->getId()}] English Wikipedia Account Request";
-        $content = $mailText . $emailSig;
+		$subject = "RE: [ACC #{$request->getId()}] English Wikipedia Account Request";
+		$content = $mailText . $emailSig;
 
-        $helper->sendMail($domain->getEmailReplyAddress(), $request->getEmail(), $subject, $content, $headers);
+		$helper->sendMail($domain->getEmailReplyAddress(), $request->getEmail(), $subject, $content, $headers);
 
-        $request->setEmailSent(true);
-    }
+		$request->setEmailSent(true);
+	}
 }

includes/Helpers/OAuthUserHelper.php

Indentation +452 added lines, -452 removed lines

@@ -25,460 +25,460 @@
 
 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;
-
-    private $legacyTokens;
-
-    #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;
+
+	private $legacyTokens;
+
+	#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');
-
-        $this->legacyTokens = $this->siteConfiguration->getOauthLegacyConsumerTokens();
-    }
-
-    /**
-     * 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;
-    }
-
-    public function canCreateAccount()
-    {
-        return $this->isFullyLinked()
-            && $this->getIdentity(true)->getGrantBasic()
-            && $this->getIdentity(true)->getGrantHighVolume()
-            && $this->getIdentity(true)->getGrantCreateAccount();
-    }
-
-    public function canWelcome()
-    {
-        return $this->isFullyLinked()
-            && $this->getIdentity(true)->getGrantBasic()
-            && $this->getIdentity(true)->getGrantHighVolume()
-            && $this->getIdentity(true)->getGrantCreateEditMovePage();
-    }
-
-    /**
-     * @throws OAuthException
-     * @throws CurlException
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    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();
-
-        try {
-            $rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
-        }
-        catch (Exception $ex) {
-            if (strpos($ex->getMessage(), "mwoauthdatastore-access-token-not-found") !== false) {
-                throw new OAuthException('No approved grants for this access token.', -1, $ex);
-            }
-
-            throw $ex;
-        }
-
-        $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();
-    }
-
-    /**
-     * @return string
-     * @throws CurlException
-     */
-    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);
-    }
-
-    /**
-     * @param $verificationToken
-     *
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     * @throws OAuthException
-     * @throws OptimisticLockFailedException
-     */
-    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
-
-            // we allow cases where the cache is expired and the cache is for a legacy token
-            if (!($expiredOk && in_array($this->identity->getAudience(), $this->legacyTokens))) {
-                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');
+
+		$this->legacyTokens = $this->siteConfiguration->getOauthLegacyConsumerTokens();
+	}
+
+	/**
+	 * 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;
+	}
+
+	public function canCreateAccount()
+	{
+		return $this->isFullyLinked()
+			&& $this->getIdentity(true)->getGrantBasic()
+			&& $this->getIdentity(true)->getGrantHighVolume()
+			&& $this->getIdentity(true)->getGrantCreateAccount();
+	}
+
+	public function canWelcome()
+	{
+		return $this->isFullyLinked()
+			&& $this->getIdentity(true)->getGrantBasic()
+			&& $this->getIdentity(true)->getGrantHighVolume()
+			&& $this->getIdentity(true)->getGrantCreateEditMovePage();
+	}
+
+	/**
+	 * @throws OAuthException
+	 * @throws CurlException
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	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();
+
+		try {
+			$rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
+		}
+		catch (Exception $ex) {
+			if (strpos($ex->getMessage(), "mwoauthdatastore-access-token-not-found") !== false) {
+				throw new OAuthException('No approved grants for this access token.', -1, $ex);
+			}
+
+			throw $ex;
+		}
+
+		$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();
+	}
+
+	/**
+	 * @return string
+	 * @throws CurlException
+	 */
+	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);
+	}
+
+	/**
+	 * @param $verificationToken
+	 *
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 * @throws OAuthException
+	 * @throws OptimisticLockFailedException
+	 */
+	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
+
+			// we allow cases where the cache is expired and the cache is for a legacy token
+			if (!($expiredOk && in_array($this->identity->getAudience(), $this->legacyTokens))) {
+				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;
+	}
 }

includes/Helpers/BotMediaWikiClient.php

Indentation +132 added lines, -132 removed lines

@@ -17,136 +17,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
-     * @param Domain $domain
-     */
-    public function __construct(SiteConfiguration $siteConfiguration, Domain $domain)
-    {
-        $this->mediawikiWebServiceEndpoint = $domain->getWikiApiPath();
-
-        $this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
-        $this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
-
-        $this->httpHelper = new HttpHelper(
-            $siteConfiguration,
-            $siteConfiguration->getCurlCookieJar()
-        );
-    }
-
-    public 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
+	 * @param Domain $domain
+	 */
+	public function __construct(SiteConfiguration $siteConfiguration, Domain $domain)
+	{
+		$this->mediawikiWebServiceEndpoint = $domain->getWikiApiPath();
+
+		$this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
+		$this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
+
+		$this->httpHelper = new HttpHelper(
+			$siteConfiguration,
+			$siteConfiguration->getCurlCookieJar()
+		);
+	}
+
+	public 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));
+	}
 }

Braces +4 added lines, -8 removed lines

@@ -72,12 +72,10 @@ 
             $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
             if (isset($userinfoResult->query->userinfo->anon)) {
                 throw new MediaWikiApiException('Unable to log in.');
-            }
-            else {
+            } else {
                 $this->knownLoggedIn = true;
             }
-        }
-        else {
+        } else {
             $this->knownLoggedIn = true;
         }
     }
@@ -96,11 +94,9 @@ 
 
         if ($method == 'GET') {
             $data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        elseif ($method == 'POST') {
+        } elseif ($method == 'POST') {
             $data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        else {
+        } else {
             throw new ApplicationLogicException('Unsupported HTTP Method');
         }
 

includes/Helpers/Logger.php

Braces +1 added lines, -2 removed lines

@@ -74,8 +74,7 @@
 
         if ($domain !== null) {
             $log->setDomain($domain);
-        }
-        elseif (method_exists($object, 'getDomain')) {
+        } elseif (method_exists($object, 'getDomain')) {
             $log->setDomain($object->getDomain());
         }
 

Indentation +423 added lines, -423 removed lines

@@ -35,427 +35,427 @@
  */
 class Logger
 {
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function emailConfirmed(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param DataObject  $object
-     * @param string      $logAction
-     * @param null|string $comment
-     * @param User|null   $user
-     * @param int|null    $domain
-     *
-     * @throws Exception
-     */
-    private static function createLogEntry(
-        PdoDatabase $database,
-        DataObject $object,
-        $logAction,
-        $comment = null,
-        $user = null,
-        ?int $domain = null
-    ) {
-        if ($user == null) {
-            $user = User::getCurrent($database);
-        }
-
-        $objectType = get_class($object);
-        if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
-            $objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
-        }
-
-        $log = new Log();
-
-        if ($domain !== null) {
-            $log->setDomain($domain);
-        }
-        elseif (method_exists($object, 'getDomain')) {
-            $log->setDomain($object->getDomain());
-        }
-
-        $log->setDatabase($database);
-        $log->setAction($logAction);
-        $log->setObjectId($object->getId());
-        $log->setObjectType($objectType);
-        $log->setUser($user);
-        $log->setComment($comment);
-        $log->save();
-    }
-
-    #region Users
-
-    /**
-     * @throws Exception
-     */
-    public static function newUser(PdoDatabase $database, User $user)
-    {
-        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function approvedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Approved");
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function deactivatedUser(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, 'DeactivatedUser', $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function requestedReactivation(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, 'RequestedReactivation', $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function renamedUser(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, "Renamed", $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userPreferencesChange(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Prefchange");
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userRolesEdited(
-        PdoDatabase $database,
-        User $object,
-        string $reason,
-        array $added,
-        array $removed,
-        int $domain
-    ) {
-        $logData = serialize(array(
-            'added'   => $added,
-            'removed' => $removed,
-            'reason'  => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "RoleChange", $logData, null, $domain);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userGlobalRolesEdited(
-        PdoDatabase $database,
-        User $object,
-        string $reason,
-        array $added,
-        array $removed
-    ): void {
-        $logData = serialize(array(
-            'added' => $added,
-            'removed' => $removed,
-            'reason' => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "GlobalRoleChange", $logData);
-    }
-
-    #endregion
-
-    /**
-     * @param PdoDatabase $database
-     * @param SiteNotice  $object
-     */
-    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
-    {
-        self::createLogEntry($database, $object, "Edited");
-    }
-
-    #region Welcome Templates
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "DeletedTemplate");
-    }
-
-    #endregion
-
-    #region Bans
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function banned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Banned", $reason);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Unbanned", $reason);
-    }
-
-    public static function banReplaced(PdoDatabase $database, Ban $object)
-    {
-        self::createLogEntry($database, $object, "BanReplaced");
-    }
-
-    #endregion
-
-    #region Requests
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $target
-     */
-    public static function deferRequest(PdoDatabase $database, Request $object, $target)
-    {
-        self::createLogEntry($database, $object, "Deferred to $target");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param integer     $target
-     * @param string      $comment
-     * @param User|null   $logUser
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
-    }
-
-    public static function manuallyConfirmRequest(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Manually Confirmed");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function reserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Reserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function breakReserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "BreakReserve");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function unreserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Unreserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     * @param Request     $request
-     */
-    public static function editComment(PdoDatabase $database, Comment $object, Request $request)
-    {
-        self::createLogEntry($database, $request, "EditComment-r");
-        self::createLogEntry($database, $object, "EditComment-c", null, null, $request->getDomain());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     */
-    public static function flaggedComment(PdoDatabase $database, Comment $object, int $domain)
-    {
-        self::createLogEntry($database, $object, "FlaggedComment", null, null, $domain);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     */
-    public static function unflaggedComment(PdoDatabase $database, Comment $object, int $domain)
-    {
-        self::createLogEntry($database, $object, "UnflaggedComment", null, null, $domain);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param User        $target
-     */
-    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
-    {
-        self::createLogEntry($database, $object, "SendReserved");
-        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $comment
-     */
-    public static function sentMail(PdoDatabase $database, Request $object, $comment)
-    {
-        self::createLogEntry($database, $object, "SentMail", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'EnqueuedJobQueue');
-    }
-
-    public static function hospitalised(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'Hospitalised');
-    }
-    #endregion
-
-    #region Email templates
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedEmail");
-    }
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedEmail");
-    }
-
-    #endregion
-
-    #region Display
-
-    #endregion
-
-    #region Automation
-
-    public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
-    }
-
-    public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
-    {
-        $data = array('status' => $job->getStatus(), 'error' => $job->getError());
-        self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
-    }
-
-    public static function backgroundJobCancelled(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCancelled', $job->getError());
-    }
-
-    public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobRequeued');
-    }
-
-    public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job, $comment = null)
-    {
-        self::createLogEntry($database, $job, 'JobAcknowledged', $comment);
-    }
-    #endregion
-
-    #region Request Queues
-    public static function requestQueueCreated(PdoDatabase $database, RequestQueue $queue)
-    {
-        self::createLogEntry($database, $queue, 'QueueCreated');
-    }
-
-    public static function requestQueueEdited(PdoDatabase $database, RequestQueue $queue)
-    {
-        self::createLogEntry($database, $queue, 'QueueEdited');
-    }
-    #endregion
-    #region Domains
-    public static function domainCreated(PdoDatabase $database, Domain $domain)
-    {
-        self::createLogEntry($database, $domain, 'DomainCreated');
-    }
-
-    public static function domainEdited(PdoDatabase $database, Domain $domain)
-    {
-        self::createLogEntry($database, $domain, 'DomainEdited');
-    }
-    #endregion
-    #region Request Forms
-    public static function requestFormCreated(PdoDatabase $database, RequestForm $requestForm)
-    {
-        self::createLogEntry($database, $requestForm, 'RequestFormCreated');
-    }
-
-    public static function requestFormEdited(PdoDatabase $database, RequestForm $requestForm)
-    {
-        self::createLogEntry($database, $requestForm, 'RequestFormEdited');
-    }
-    #endregion
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function emailConfirmed(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param DataObject  $object
+	 * @param string      $logAction
+	 * @param null|string $comment
+	 * @param User|null   $user
+	 * @param int|null    $domain
+	 *
+	 * @throws Exception
+	 */
+	private static function createLogEntry(
+		PdoDatabase $database,
+		DataObject $object,
+		$logAction,
+		$comment = null,
+		$user = null,
+		?int $domain = null
+	) {
+		if ($user == null) {
+			$user = User::getCurrent($database);
+		}
+
+		$objectType = get_class($object);
+		if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
+			$objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
+		}
+
+		$log = new Log();
+
+		if ($domain !== null) {
+			$log->setDomain($domain);
+		}
+		elseif (method_exists($object, 'getDomain')) {
+			$log->setDomain($object->getDomain());
+		}
+
+		$log->setDatabase($database);
+		$log->setAction($logAction);
+		$log->setObjectId($object->getId());
+		$log->setObjectType($objectType);
+		$log->setUser($user);
+		$log->setComment($comment);
+		$log->save();
+	}
+
+	#region Users
+
+	/**
+	 * @throws Exception
+	 */
+	public static function newUser(PdoDatabase $database, User $user)
+	{
+		self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function approvedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Approved");
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function deactivatedUser(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, 'DeactivatedUser', $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function requestedReactivation(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, 'RequestedReactivation', $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function renamedUser(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, "Renamed", $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userPreferencesChange(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Prefchange");
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userRolesEdited(
+		PdoDatabase $database,
+		User $object,
+		string $reason,
+		array $added,
+		array $removed,
+		int $domain
+	) {
+		$logData = serialize(array(
+			'added'   => $added,
+			'removed' => $removed,
+			'reason'  => $reason,
+		));
+
+		self::createLogEntry($database, $object, "RoleChange", $logData, null, $domain);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userGlobalRolesEdited(
+		PdoDatabase $database,
+		User $object,
+		string $reason,
+		array $added,
+		array $removed
+	): void {
+		$logData = serialize(array(
+			'added' => $added,
+			'removed' => $removed,
+			'reason' => $reason,
+		));
+
+		self::createLogEntry($database, $object, "GlobalRoleChange", $logData);
+	}
+
+	#endregion
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param SiteNotice  $object
+	 */
+	public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
+	{
+		self::createLogEntry($database, $object, "Edited");
+	}
+
+	#region Welcome Templates
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "DeletedTemplate");
+	}
+
+	#endregion
+
+	#region Bans
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function banned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Banned", $reason);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function unbanned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Unbanned", $reason);
+	}
+
+	public static function banReplaced(PdoDatabase $database, Ban $object)
+	{
+		self::createLogEntry($database, $object, "BanReplaced");
+	}
+
+	#endregion
+
+	#region Requests
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $target
+	 */
+	public static function deferRequest(PdoDatabase $database, Request $object, $target)
+	{
+		self::createLogEntry($database, $object, "Deferred to $target");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param integer     $target
+	 * @param string      $comment
+	 * @param User|null   $logUser
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
+	}
+
+	public static function manuallyConfirmRequest(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Manually Confirmed");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function reserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Reserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function breakReserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "BreakReserve");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function unreserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Unreserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 * @param Request     $request
+	 */
+	public static function editComment(PdoDatabase $database, Comment $object, Request $request)
+	{
+		self::createLogEntry($database, $request, "EditComment-r");
+		self::createLogEntry($database, $object, "EditComment-c", null, null, $request->getDomain());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 */
+	public static function flaggedComment(PdoDatabase $database, Comment $object, int $domain)
+	{
+		self::createLogEntry($database, $object, "FlaggedComment", null, null, $domain);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 */
+	public static function unflaggedComment(PdoDatabase $database, Comment $object, int $domain)
+	{
+		self::createLogEntry($database, $object, "UnflaggedComment", null, null, $domain);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param User        $target
+	 */
+	public static function sendReservation(PdoDatabase $database, Request $object, User $target)
+	{
+		self::createLogEntry($database, $object, "SendReserved");
+		self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $comment
+	 */
+	public static function sentMail(PdoDatabase $database, Request $object, $comment)
+	{
+		self::createLogEntry($database, $object, "SentMail", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'EnqueuedJobQueue');
+	}
+
+	public static function hospitalised(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'Hospitalised');
+	}
+	#endregion
+
+	#region Email templates
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function createEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedEmail");
+	}
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedEmail");
+	}
+
+	#endregion
+
+	#region Display
+
+	#endregion
+
+	#region Automation
+
+	public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
+	}
+
+	public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
+	{
+		$data = array('status' => $job->getStatus(), 'error' => $job->getError());
+		self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
+	}
+
+	public static function backgroundJobCancelled(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCancelled', $job->getError());
+	}
+
+	public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobRequeued');
+	}
+
+	public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job, $comment = null)
+	{
+		self::createLogEntry($database, $job, 'JobAcknowledged', $comment);
+	}
+	#endregion
+
+	#region Request Queues
+	public static function requestQueueCreated(PdoDatabase $database, RequestQueue $queue)
+	{
+		self::createLogEntry($database, $queue, 'QueueCreated');
+	}
+
+	public static function requestQueueEdited(PdoDatabase $database, RequestQueue $queue)
+	{
+		self::createLogEntry($database, $queue, 'QueueEdited');
+	}
+	#endregion
+	#region Domains
+	public static function domainCreated(PdoDatabase $database, Domain $domain)
+	{
+		self::createLogEntry($database, $domain, 'DomainCreated');
+	}
+
+	public static function domainEdited(PdoDatabase $database, Domain $domain)
+	{
+		self::createLogEntry($database, $domain, 'DomainEdited');
+	}
+	#endregion
+	#region Request Forms
+	public static function requestFormCreated(PdoDatabase $database, RequestForm $requestForm)
+	{
+		self::createLogEntry($database, $requestForm, 'RequestFormCreated');
+	}
+
+	public static function requestFormEdited(PdoDatabase $database, RequestForm $requestForm)
+	{
+		self::createLogEntry($database, $requestForm, 'RequestFormEdited');
+	}
+	#endregion
 }

includes/Helpers/OAuthProtocolHelper.php

Indentation +131 added lines, -131 removed lines

@@ -18,135 +18,135 @@
 
 class OAuthProtocolHelper implements Interfaces\IOAuthProtocolHelper
 {
-    private $authUrl;
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-    /**
-     * @var string
-     */
-    private $consumerKey;
-    /**
-     * @var string
-     */
-    private $consumerSecret;
-    /**
-     * @var string
-     */
-    private $userAgent;
-
-    /**
-     * OAuthHelper constructor.
-     *
-     * @param string     $consumerKey
-     * @param string     $consumerSecret
-     * @param PdoDatabase $database
-     * @param string      $userAgent
-     */
-    public function __construct(
-        $consumerKey,
-        $consumerSecret,
-        PdoDatabase $database,
-        $userAgent
-    ) {
-        $this->consumerKey = $consumerKey;
-        $this->consumerSecret = $consumerSecret;
-        $this->userAgent = $userAgent;
-        $this->database = $database;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getRequestToken()
-    {
-        /** @var Token $requestToken */
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        list($authUrl, $requestToken) = $this->getClient($domain)->initiate();
-        $this->authUrl = $authUrl;
-        return $requestToken;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getAuthoriseUrl($requestToken)
-    {
-        return $this->authUrl;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
-    {
-        $requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        return $this->getClient($domain)->complete($requestToken, $oauthVerifier);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
-    {
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        return $this->getClient($domain)->identify(new Token($oauthAccessToken, $oauthAccessSecret));
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
-    {
-        $userToken = new Token($accessToken, $accessSecret);
-
-        $apiParams['format'] = 'json';
-
-        if ($apiParams === null || !is_array($apiParams)) {
-            throw new CurlException("Invalid API call");
-        }
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        $url = $domain->getWikiApiPath();
-        $isPost = ($method === 'POST');
-
-        if ($method === 'GET') {
-            $query = http_build_query($apiParams);
-            $url .= '?' . $query;
-            $apiParams = null;
-        }
-
-        $data = $this->getClient($domain)->makeOAuthCall($userToken, $url, $isPost, $apiParams);
-
-        return json_decode($data);
-    }
-
-    /**
-     * @param string $oauthEndpoint
-     *
-     * @return Client
-     */
-    protected function getClient(Domain $domain) : Client
-    {
-        $oauthClientConfig = new ClientConfig($domain->getWikiArticlePath() . "?title=Special:OAuth");
-        $oauthClientConfig->setConsumer(new Consumer($this->consumerKey, $this->consumerSecret));
-        $oauthClientConfig->setUserAgent($this->userAgent);
-        return new Client($oauthClientConfig);
-    }
+	private $authUrl;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+	/**
+	 * @var string
+	 */
+	private $consumerKey;
+	/**
+	 * @var string
+	 */
+	private $consumerSecret;
+	/**
+	 * @var string
+	 */
+	private $userAgent;
+
+	/**
+	 * OAuthHelper constructor.
+	 *
+	 * @param string     $consumerKey
+	 * @param string     $consumerSecret
+	 * @param PdoDatabase $database
+	 * @param string      $userAgent
+	 */
+	public function __construct(
+		$consumerKey,
+		$consumerSecret,
+		PdoDatabase $database,
+		$userAgent
+	) {
+		$this->consumerKey = $consumerKey;
+		$this->consumerSecret = $consumerSecret;
+		$this->userAgent = $userAgent;
+		$this->database = $database;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getRequestToken()
+	{
+		/** @var Token $requestToken */
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		list($authUrl, $requestToken) = $this->getClient($domain)->initiate();
+		$this->authUrl = $authUrl;
+		return $requestToken;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getAuthoriseUrl($requestToken)
+	{
+		return $this->authUrl;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
+	{
+		$requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		return $this->getClient($domain)->complete($requestToken, $oauthVerifier);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
+	{
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		return $this->getClient($domain)->identify(new Token($oauthAccessToken, $oauthAccessSecret));
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
+	{
+		$userToken = new Token($accessToken, $accessSecret);
+
+		$apiParams['format'] = 'json';
+
+		if ($apiParams === null || !is_array($apiParams)) {
+			throw new CurlException("Invalid API call");
+		}
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		$url = $domain->getWikiApiPath();
+		$isPost = ($method === 'POST');
+
+		if ($method === 'GET') {
+			$query = http_build_query($apiParams);
+			$url .= '?' . $query;
+			$apiParams = null;
+		}
+
+		$data = $this->getClient($domain)->makeOAuthCall($userToken, $url, $isPost, $apiParams);
+
+		return json_decode($data);
+	}
+
+	/**
+	 * @param string $oauthEndpoint
+	 *
+	 * @return Client
+	 */
+	protected function getClient(Domain $domain) : Client
+	{
+		$oauthClientConfig = new ClientConfig($domain->getWikiArticlePath() . "?title=Special:OAuth");
+		$oauthClientConfig->setConsumer(new Consumer($this->consumerKey, $this->consumerSecret));
+		$oauthClientConfig->setUserAgent($this->userAgent);
+		return new Client($oauthClientConfig);
+	}
 }

includes/Helpers/RequestQueueHelper.php

Indentation +63 added lines, -63 removed lines

@@ -15,73 +15,73 @@
 
 class RequestQueueHelper
 {
-    /**
-     * @param RequestQueue $queue
-     * @param bool         $enabled
-     * @param bool         $default
-     * @param bool         $antiSpoof
-     * @param bool         $titleBlacklist
-     */
-    public function configureDefaults(
-        RequestQueue $queue,
-        bool $enabled,
-        bool $default,
-        bool $antiSpoof,
-        bool $titleBlacklist,
-        bool $isTarget
-    ) {
-        // always allow enabling a queue
-        if ($enabled) {
-            $queue->setEnabled($enabled);
-        }
+	/**
+	 * @param RequestQueue $queue
+	 * @param bool         $enabled
+	 * @param bool         $default
+	 * @param bool         $antiSpoof
+	 * @param bool         $titleBlacklist
+	 */
+	public function configureDefaults(
+		RequestQueue $queue,
+		bool $enabled,
+		bool $default,
+		bool $antiSpoof,
+		bool $titleBlacklist,
+		bool $isTarget
+	) {
+		// always allow enabling a queue
+		if ($enabled) {
+			$queue->setEnabled($enabled);
+		}
 
-        // only allow other enable-flag changes if we're not a default
-        if (!($queue->isDefault() || $queue->isDefaultAntispoof() || $queue->isDefaultTitleBlacklist() || $isTarget)) {
-            $queue->setEnabled($enabled);
-        }
+		// only allow other enable-flag changes if we're not a default
+		if (!($queue->isDefault() || $queue->isDefaultAntispoof() || $queue->isDefaultTitleBlacklist() || $isTarget)) {
+			$queue->setEnabled($enabled);
+		}
 
-        // only allow enabling the default flags, and only when we're enabled.
-        $queue->setDefault(($queue->isDefault() || $default) && $queue->isEnabled());
-        $queue->setDefaultAntispoof(($queue->isDefaultAntispoof() || $antiSpoof) && $queue->isEnabled());
-        $queue->setDefaultTitleBlacklist(($queue->isDefaultTitleBlacklist() || $titleBlacklist) && $queue->isEnabled());
-    }
+		// only allow enabling the default flags, and only when we're enabled.
+		$queue->setDefault(($queue->isDefault() || $default) && $queue->isEnabled());
+		$queue->setDefaultAntispoof(($queue->isDefaultAntispoof() || $antiSpoof) && $queue->isEnabled());
+		$queue->setDefaultTitleBlacklist(($queue->isDefaultTitleBlacklist() || $titleBlacklist) && $queue->isEnabled());
+	}
 
-    /**
-     * Returns true if the specified queue is a target of an enabled email template with a defer action.
-     *
-     * @param RequestQueue $queue
-     * @param PdoDatabase  $database
-     *
-     * @return bool
-     */
-    public function isEmailTemplateTarget(RequestQueue $queue, PdoDatabase $database): bool
-    {
-        $isTarget = false;
-        /** @var EmailTemplate[] $deferralTemplates */
-        $deferralTemplates = EmailTemplate::getAllActiveTemplates(EmailTemplate::ACTION_DEFER, $database, $queue->getDomain());
-        foreach ($deferralTemplates as $t) {
-            if ($t->getQueue() === $queue->getId()) {
-                $isTarget = true;
-                break;
-            }
-        }
+	/**
+	 * Returns true if the specified queue is a target of an enabled email template with a defer action.
+	 *
+	 * @param RequestQueue $queue
+	 * @param PdoDatabase  $database
+	 *
+	 * @return bool
+	 */
+	public function isEmailTemplateTarget(RequestQueue $queue, PdoDatabase $database): bool
+	{
+		$isTarget = false;
+		/** @var EmailTemplate[] $deferralTemplates */
+		$deferralTemplates = EmailTemplate::getAllActiveTemplates(EmailTemplate::ACTION_DEFER, $database, $queue->getDomain());
+		foreach ($deferralTemplates as $t) {
+			if ($t->getQueue() === $queue->getId()) {
+				$isTarget = true;
+				break;
+			}
+		}
 
-        return $isTarget;
-    }
+		return $isTarget;
+	}
 
-    public function isRequestFormTarget(RequestQueue $queue, PdoDatabase $database): bool
-    {
-        $isTarget = false;
-        $forms = RequestForm::getAllForms($database, 1); // FIXME: domains
-        foreach ($forms as $t) {
-            if ($t->isEnabled()) {
-                if ($t->getOverrideQueue() === $queue->getId()) {
-                    $isTarget = true;
-                    break;
-                }
-            }
-        }
+	public function isRequestFormTarget(RequestQueue $queue, PdoDatabase $database): bool
+	{
+		$isTarget = false;
+		$forms = RequestForm::getAllForms($database, 1); // FIXME: domains
+		foreach ($forms as $t) {
+			if ($t->isEnabled()) {
+				if ($t->getOverrideQueue() === $queue->getId()) {
+					$isTarget = true;
+					break;
+				}
+			}
+		}
 
-        return $isTarget;
-    }
+		return $isTarget;
+	}
 }
\ No newline at end of file