enwikipedia-acc / waca

includes/Background/Task/BotCreationTask.php

Indentation +11 added lines, -11 removed lines

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

Spacing +1 added lines, -1 removed lines

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

includes/Background/Task/UserCreationTask.php

Indentation +9 added lines, -9 removed lines

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

includes/Background/Task/WelcomeUserTask.php

Indentation +69 added lines, -69 removed lines

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

Spacing +1 added lines, -1 removed lines

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

Braces +1 added lines, -1 removed lines

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

includes/Background/CreationTaskBase.php

Indentation +115 added lines, -115 removed lines

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

Spacing +3 added lines, -3 removed lines

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

Braces +2 added lines, -1 removed lines

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

includes/Background/BackgroundTaskBase.php

Braces +1 added lines, -1 removed lines

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

Indentation +263 added lines, -263 removed lines

@@ -23,267 +23,267 @@
 
 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_RUNNING:
-                case JobQueue::STATUS_HELD:
-                    // Defer to next execution
-                    $this->job->setStatus(JobQueue::STATUS_READY);
-                    $this->job->save();
-                    return;
-                case JobQueue::STATUS_COMPLETE:
-                    // do nothing
-                    break;
-            }
-        }
-
-        $this->execute();
-    }
-
-    protected function markComplete()
-    {
-        $this->job->setStatus(JobQueue::STATUS_COMPLETE);
-        $this->job->setError(null);
-        $this->job->setAcknowledged(null);
-        $this->job->save();
-
-        Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
-    }
-
-    protected function markCancelled($reason = null)
-    {
-        $this->job->setStatus(JobQueue::STATUS_CANCELLED);
-        $this->job->setError($reason);
-        $this->job->setAcknowledged(null);
-        $this->job->save();
-
-        Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
-    }
-
-    protected function markFailed($reason = null)
-    {
-        $this->job->setStatus(JobQueue::STATUS_FAILED);
-        $this->job->setError($reason);
-        $this->job->setAcknowledged(0);
-        $this->job->save();
-
-        Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
-    }
-
-    /**
-     * @return User
-     */
-    public function getTriggerUser()
-    {
-        return $this->triggerUser;
-    }
-
-    /**
-     * @return Request
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @return EmailTemplate
-     */
-    public function getEmailTemplate()
-    {
-        return $this->emailTemplate;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getParameters()
-    {
-        return $this->parameters;
-    }
+	/** @var JobQueue */
+	private $job;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IOAuthProtocolHelper */
+	private $oauthProtocolHelper;
+	/** @var SiteConfiguration */
+	private $siteConfiguration;
+	/** @var IEmailHelper */
+	private $emailHelper;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/** @var IrcNotificationHelper */
+	private $notificationHelper;
+	/** @var User */
+	private $triggerUser;
+	/** @var Request */
+	private $request;
+	/** @var EmailTemplate */
+	private $emailTemplate = null;
+	/** @var mixed */
+	private $parameters;
+
+	/**
+	 * @return JobQueue
+	 */
+	public function getJob()
+	{
+		return $this->job;
+	}
+
+	/**
+	 * @param JobQueue $job
+	 */
+	public function setJob(JobQueue $job)
+	{
+		$this->job = $job;
+	}
+
+	/**
+	 * @return PdoDatabase
+	 */
+	public function getDatabase()
+	{
+		return $this->database;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	public function setDatabase(PdoDatabase $database)
+	{
+		$this->database = $database;
+	}
+
+	/**
+	 * @return IOAuthProtocolHelper
+	 */
+	public function getOauthProtocolHelper()
+	{
+		return $this->oauthProtocolHelper;
+	}
+
+	/**
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 */
+	public function setOauthProtocolHelper(IOAuthProtocolHelper $oauthProtocolHelper)
+	{
+		$this->oauthProtocolHelper = $oauthProtocolHelper;
+	}
+
+	/**
+	 * @return SiteConfiguration
+	 */
+	public function getSiteConfiguration()
+	{
+		return $this->siteConfiguration;
+	}
+
+	/**
+	 * @param SiteConfiguration $siteConfiguration
+	 */
+	public function setSiteConfiguration(SiteConfiguration $siteConfiguration)
+	{
+		$this->siteConfiguration = $siteConfiguration;
+	}
+
+	/**
+	 * @return HttpHelper
+	 */
+	public function getHttpHelper()
+	{
+		return $this->httpHelper;
+	}
+
+	/**
+	 * @param HttpHelper $httpHelper
+	 */
+	public function setHttpHelper(HttpHelper $httpHelper)
+	{
+		$this->httpHelper = $httpHelper;
+	}
+
+	/**
+	 * @return IEmailHelper
+	 */
+	public function getEmailHelper()
+	{
+		return $this->emailHelper;
+	}
+
+	/**
+	 * @param IEmailHelper $emailHelper
+	 */
+	public function setEmailHelper(IEmailHelper $emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
+
+	/**
+	 * @return IrcNotificationHelper
+	 */
+	public function getNotificationHelper()
+	{
+		return $this->notificationHelper;
+	}
+
+	/**
+	 * @param IrcNotificationHelper $notificationHelper
+	 */
+	public function setNotificationHelper($notificationHelper)
+	{
+		$this->notificationHelper = $notificationHelper;
+	}
+
+	/**
+	 * @return void
+	 */
+	protected abstract function execute();
+
+	public function run()
+	{
+		$this->triggerUser = User::getById($this->job->getTriggerUserId(), $this->getDatabase());
+
+		if ($this->triggerUser === false) {
+			throw new ApplicationLogicException('Cannot locate trigger user');
+		}
+
+		$this->request = Request::getById($this->job->getRequest(), $this->getDatabase());
+
+		if ($this->request === false) {
+			throw new ApplicationLogicException('Cannot locate request');
+		}
+
+		if($this->job->getEmailTemplate() !== null){
+			$this->emailTemplate = EmailTemplate::getById($this->job->getEmailTemplate(), $this->getDatabase());
+
+			if ($this->emailTemplate === false) {
+				throw new ApplicationLogicException('Cannot locate email template');
+			}
+		}
+
+		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_RUNNING:
+				case JobQueue::STATUS_HELD:
+					// Defer to next execution
+					$this->job->setStatus(JobQueue::STATUS_READY);
+					$this->job->save();
+					return;
+				case JobQueue::STATUS_COMPLETE:
+					// do nothing
+					break;
+			}
+		}
+
+		$this->execute();
+	}
+
+	protected function markComplete()
+	{
+		$this->job->setStatus(JobQueue::STATUS_COMPLETE);
+		$this->job->setError(null);
+		$this->job->setAcknowledged(null);
+		$this->job->save();
+
+		Logger::backgroundJobComplete($this->getDatabase(), $this->getJob());
+	}
+
+	protected function markCancelled($reason = null)
+	{
+		$this->job->setStatus(JobQueue::STATUS_CANCELLED);
+		$this->job->setError($reason);
+		$this->job->setAcknowledged(null);
+		$this->job->save();
+
+		Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
+	}
+
+	protected function markFailed($reason = null)
+	{
+		$this->job->setStatus(JobQueue::STATUS_FAILED);
+		$this->job->setError($reason);
+		$this->job->setAcknowledged(0);
+		$this->job->save();
+
+		Logger::backgroundJobIssue($this->getDatabase(), $this->getJob());
+	}
+
+	/**
+	 * @return User
+	 */
+	public function getTriggerUser()
+	{
+		return $this->triggerUser;
+	}
+
+	/**
+	 * @return Request
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @return EmailTemplate
+	 */
+	public function getEmailTemplate()
+	{
+		return $this->emailTemplate;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getParameters()
+	{
+		return $this->parameters;
+	}
 }

Spacing +5 added lines, -5 removed lines

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

includes/Fragments/NavigationMenuAccessControl.php

Indentation +39 added lines, -39 removed lines

@@ -25,48 +25,48 @@
 
 trait NavigationMenuAccessControl
 {
-    protected abstract function assign($name, $value);
+	protected abstract function assign($name, $value);
 
-    /**
-     * @return SecurityManager
-     */
-    protected abstract function getSecurityManager();
+	/**
+	 * @return SecurityManager
+	 */
+	protected abstract function getSecurityManager();
 
-    /**
-     * @param $currentUser
-     */
-    protected function setupNavMenuAccess($currentUser)
-    {
-        $this->assign('nav__canRequests', $this->getSecurityManager()
-                ->allows(PageMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+	/**
+	 * @param $currentUser
+	 */
+	protected function setupNavMenuAccess($currentUser)
+	{
+		$this->assign('nav__canRequests', $this->getSecurityManager()
+				->allows(PageMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canLogs', $this->getSecurityManager()
-                ->allows(PageLog::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canUsers', $this->getSecurityManager()
-                ->allows(StatsUsers::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canSearch', $this->getSecurityManager()
-                ->allows(PageSearch::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canStats', $this->getSecurityManager()
-                ->allows(StatsMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canLogs', $this->getSecurityManager()
+				->allows(PageLog::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canUsers', $this->getSecurityManager()
+				->allows(StatsUsers::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canSearch', $this->getSecurityManager()
+				->allows(PageSearch::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canStats', $this->getSecurityManager()
+				->allows(StatsMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canBan', $this->getSecurityManager()
-                ->allows(PageBan::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canEmailMgmt', $this->getSecurityManager()
-                ->allows(PageEmailManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canWelcomeMgmt', $this->getSecurityManager()
-                ->allows(PageWelcomeTemplateManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canSiteNoticeMgmt', $this->getSecurityManager()
-                ->allows(PageSiteNotice::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canUserMgmt', $this->getSecurityManager()
-                ->allows(PageUserManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canJobQueue', $this->getSecurityManager()
-                ->allows(PageJobQueue::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canBan', $this->getSecurityManager()
+				->allows(PageBan::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canEmailMgmt', $this->getSecurityManager()
+				->allows(PageEmailManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canWelcomeMgmt', $this->getSecurityManager()
+				->allows(PageWelcomeTemplateManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canSiteNoticeMgmt', $this->getSecurityManager()
+				->allows(PageSiteNotice::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canUserMgmt', $this->getSecurityManager()
+				->allows(PageUserManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canJobQueue', $this->getSecurityManager()
+				->allows(PageJobQueue::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canViewRequest', $this->getSecurityManager()
-                ->allows(PageViewRequest::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-    }
+		$this->assign('nav__canViewRequest', $this->getSecurityManager()
+				->allows(PageViewRequest::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+	}
 }
\ No newline at end of file

includes/Fragments/RequestData.php

Indentation +320 added lines, -320 removed lines

@@ -24,324 +24,324 @@
 
 trait RequestData
 {
-    /**
-     * @var array Array of IP address classed as 'private' by RFC1918.
-     */
-    protected static $rfc1918ips = array(
-        "10.0.0.0"    => "10.255.255.255",
-        "172.16.0.0"  => "172.31.255.255",
-        "192.168.0.0" => "192.168.255.255",
-        "169.254.0.0" => "169.254.255.255",
-        "127.0.0.0"   => "127.255.255.255",
-    );
-
-    /**
-     * Gets a request object
-     *
-     * @param PdoDatabase $database  The database connection
-     * @param int         $requestId The ID of the request to retrieve
-     *
-     * @return Request
-     * @throws ApplicationLogicException
-     */
-    protected function getRequest(PdoDatabase $database, $requestId)
-    {
-        if ($requestId === null) {
-            throw new ApplicationLogicException("No request specified");
-        }
-
-        $request = Request::getById($requestId, $database);
-        if ($request === false || !is_a($request, Request::class)) {
-            throw new ApplicationLogicException('Could not load the requested request!');
-        }
-
-        return $request;
-    }
-
-    /**
-     * Returns a value stating whether the user is allowed to see private data or not
-     *
-     * @param Request $request
-     * @param User    $currentUser
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    protected function isAllowedPrivateData(Request $request, User $currentUser)
-    {
-        // Test the main security barrier for private data access using SecurityManager
-        if ($this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
-            // Tool admins/check-users can always see private data
-            return true;
-        }
-
-        // reserving user is allowed to see the data
-        if ($currentUser->getId() === $request->getReserved()
-            && $request->getReserved() !== null
-            && $this->barrierTest('seePrivateDataWhenReserved', $currentUser, 'RequestData')
-        ) {
-            return true;
-        }
-
-        // user has the reveal hash
-        if (WebRequest::getString('hash') === $request->getRevealHash()
-            && $this->barrierTest('seePrivateDataWithHash', $currentUser, 'RequestData')
-        ) {
-            return true;
-        }
-
-        // nope. Not allowed.
-        return false;
-    }
-
-    /**
-     * Tests the security barrier for a specified action.
-     *
-     * Don't use within templates
-     *
-     * @param string      $action
-     *
-     * @param User        $user
-     * @param null|string $pageName
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    abstract protected function barrierTest($action, User $user, $pageName = null);
-
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    abstract protected function getRouteName();
-
-    /** @return SecurityManager */
-    abstract protected function getSecurityManager();
-
-    /**
-     * Sets the name of the template this page should display.
-     *
-     * @param string $name
-     */
-    abstract protected function setTemplate($name);
-
-    /** @return IXffTrustProvider */
-    abstract protected function getXffTrustProvider();
-
-    /** @return ILocationProvider */
-    abstract protected function getLocationProvider();
-
-    /** @return IRDnsProvider */
-    abstract protected function getRdnsProvider();
-
-    /**
-     * Assigns a Smarty variable
-     *
-     * @param  array|string $name  the template variable name(s)
-     * @param  mixed        $value the value to assign
-     */
-    abstract protected function assign($name, $value);
-
-    /**
-     * @param int         $requestReservationId
-     * @param PdoDatabase $database
-     * @param User        $currentUser
-     */
-    protected function setupReservationDetails($requestReservationId, PdoDatabase $database, User $currentUser)
-    {
-        $requestIsReserved = $requestReservationId !== null;
-        $this->assign('requestIsReserved', $requestIsReserved);
-        $this->assign('requestIsReservedByMe', false);
-
-        if ($requestIsReserved) {
-            $this->assign('requestReservedByName', User::getById($requestReservationId, $database)->getUsername());
-            $this->assign('requestReservedById', $requestReservationId);
-
-            if ($requestReservationId === $currentUser->getId()) {
-                $this->assign('requestIsReservedByMe', true);
-            }
-        }
-
-        $this->assign('canBreakReservation', $this->barrierTest('force', $currentUser, PageBreakReservation::class));
-    }
-
-    /**
-     * Adds private request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
-     *
-     * @param Request           $request
-     * @param User              $currentUser
-     * @param SiteConfiguration $configuration
-     *
-     * @param PdoDatabase       $database
-     */
-    protected function setupPrivateData(
-        $request,
-        User $currentUser,
-        SiteConfiguration $configuration,
-        PdoDatabase $database
-    ) {
-        $xffProvider = $this->getXffTrustProvider();
-
-        $relatedEmailRequests = RequestSearchHelper::get($database)
-            ->byEmailAddress($request->getEmail())
-            ->withConfirmedEmail()
-            ->excludingPurgedData($configuration)
-            ->excludingRequest($request->getId())
-            ->fetch();
-
-        $this->assign('requestEmail', $request->getEmail());
-        $emailDomain = explode("@", $request->getEmail())[1];
-        $this->assign("emailurl", $emailDomain);
-        $this->assign('requestRelatedEmailRequestsCount', count($relatedEmailRequests));
-        $this->assign('requestRelatedEmailRequests', $relatedEmailRequests);
-
-        $trustedIp = $xffProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
-        $this->assign('requestTrustedIp', $trustedIp);
-        $this->assign('requestRealIp', $request->getIp());
-        $this->assign('requestForwardedIp', $request->getForwardedIp());
-
-        $trustedIpLocation = $this->getLocationProvider()->getIpLocation($trustedIp);
-        $this->assign('requestTrustedIpLocation', $trustedIpLocation);
-
-        $this->assign('requestHasForwardedIp', $request->getForwardedIp() !== null);
-
-        $relatedIpRequests = RequestSearchHelper::get($database)
-            ->byIp($trustedIp)
-            ->withConfirmedEmail()
-            ->excludingPurgedData($configuration)
-            ->excludingRequest($request->getId())
-            ->fetch();
-
-        $this->assign('requestRelatedIpRequestsCount', count($relatedIpRequests));
-        $this->assign('requestRelatedIpRequests', $relatedIpRequests);
-
-        $this->assign('showRevealLink', false);
-        if ($request->getReserved() === $currentUser->getId() ||
-            $this->barrierTest('alwaysSeeHash', $currentUser, 'RequestData')
-        ) {
-            $this->assign('showRevealLink', true);
-            $this->assign('revealHash', $request->getRevealHash());
-        }
-
-        $this->setupForwardedIpData($request);
-    }
-
-    /**
-     * Adds checkuser request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
-     *
-     * @param Request $request
-     */
-    protected function setupCheckUserData(Request $request)
-    {
-        $this->assign('requestUserAgent', $request->getUserAgent());
-    }
-
-    /**
-     * Sets up the basic data for this request, and adds it to Smarty
-     *
-     * @param Request           $request
-     * @param SiteConfiguration $config
-     */
-    protected function setupBasicData(Request $request, SiteConfiguration $config)
-    {
-        $this->assign('requestId', $request->getId());
-        $this->assign('updateVersion', $request->getUpdateVersion());
-        $this->assign('requestName', $request->getName());
-        $this->assign('requestDate', $request->getDate());
-        $this->assign('requestStatus', $request->getStatus());
-
-        $isClosed = !array_key_exists($request->getStatus(), $config->getRequestStates())
-            && $request->getStatus() !== RequestStatus::HOSPITAL;
-        $this->assign('requestIsClosed', $isClosed);
-    }
-
-    /**
-     * Sets up the forwarded IP data for this request and adds it to Smarty
-     *
-     * @param Request $request
-     */
-    protected function setupForwardedIpData(Request $request)
-    {
-        if ($request->getForwardedIp() !== null) {
-            $requestProxyData = array(); // Initialize array to store data to be output in Smarty template.
-            $proxyIndex = 0;
-
-            // Assuming [client] <=> [proxy1] <=> [proxy2] <=> [proxy3] <=> [us], we will see an XFF header of [client],
-            // [proxy1], [proxy2], and our actual IP will be [proxy3]
-            $proxies = explode(",", $request->getForwardedIp());
-            $proxies[] = $request->getIp();
-
-            // Origin is the supposed "client" IP.
-            $origin = $proxies[0];
-            $this->assign("forwardedOrigin", $origin);
-
-            // We step through the servers in reverse order, from closest to furthest
-            $proxies = array_reverse($proxies);
-
-            // By default, we have trust, because the first in the chain is now REMOTE_ADDR, which is hardest to spoof.
-            $trust = true;
-
-            /**
-             * @var int    $index     The zero-based index of the proxy.
-             * @var string $proxyData The proxy IP address (although possibly not!)
-             */
-            foreach ($proxies as $index => $proxyData) {
-                $proxyAddress = trim($proxyData);
-                $requestProxyData[$proxyIndex]['ip'] = $proxyAddress;
-
-                // get data on this IP.
-                $thisProxyIsTrusted = $this->getXffTrustProvider()->isTrusted($proxyAddress);
-
-                $proxyIsInPrivateRange = $this->getXffTrustProvider()
-                    ->ipInRange(self::$rfc1918ips, $proxyAddress);
-
-                if (!$proxyIsInPrivateRange) {
-                    $proxyReverseDns = $this->getRdnsProvider()->getReverseDNS($proxyAddress);
-                    $proxyLocation = $this->getLocationProvider()->getIpLocation($proxyAddress);
-                }
-                else {
-                    // this is going to fail, so why bother trying?
-                    $proxyReverseDns = false;
-                    $proxyLocation = false;
-                }
-
-                // current trust chain status BEFORE this link
-                $preLinkTrust = $trust;
-
-                // is *this* link trusted? Note, this will be true even if there is an untrusted link before this!
-                $requestProxyData[$proxyIndex]['trustedlink'] = $thisProxyIsTrusted;
-
-                // set the trust status of the chain to this point
-                $trust = $trust & $thisProxyIsTrusted;
-
-                // If this is the origin address, and the chain was trusted before this point, then we can trust
-                // the origin.
-                if ($preLinkTrust && $proxyAddress == $origin) {
-                    // if this is the origin, then we are at the last point in the chain.
-                    // @todo: this is probably the cause of some bugs when an IP appears twice - we're missing a check
-                    // to see if this is *really* the last in the chain, rather than just the same IP as it.
-                    $trust = true;
-                }
-
-                $requestProxyData[$proxyIndex]['trust'] = $trust;
-
-                $requestProxyData[$proxyIndex]['rdnsfailed'] = $proxyReverseDns === false;
-                $requestProxyData[$proxyIndex]['rdns'] = $proxyReverseDns;
-                $requestProxyData[$proxyIndex]['routable'] = !$proxyIsInPrivateRange;
-
-                $requestProxyData[$proxyIndex]['location'] = $proxyLocation;
-
-                if ($proxyReverseDns === $proxyAddress && $proxyIsInPrivateRange === false) {
-                    $requestProxyData[$proxyIndex]['rdns'] = null;
-                }
-
-                $showLinks = (!$trust || $proxyAddress == $origin) && !$proxyIsInPrivateRange;
-                $requestProxyData[$proxyIndex]['showlinks'] = $showLinks;
-
-                $proxyIndex++;
-            }
-
-            $this->assign("requestProxyData", $requestProxyData);
-        }
-    }
+	/**
+	 * @var array Array of IP address classed as 'private' by RFC1918.
+	 */
+	protected static $rfc1918ips = array(
+		"10.0.0.0"    => "10.255.255.255",
+		"172.16.0.0"  => "172.31.255.255",
+		"192.168.0.0" => "192.168.255.255",
+		"169.254.0.0" => "169.254.255.255",
+		"127.0.0.0"   => "127.255.255.255",
+	);
+
+	/**
+	 * Gets a request object
+	 *
+	 * @param PdoDatabase $database  The database connection
+	 * @param int         $requestId The ID of the request to retrieve
+	 *
+	 * @return Request
+	 * @throws ApplicationLogicException
+	 */
+	protected function getRequest(PdoDatabase $database, $requestId)
+	{
+		if ($requestId === null) {
+			throw new ApplicationLogicException("No request specified");
+		}
+
+		$request = Request::getById($requestId, $database);
+		if ($request === false || !is_a($request, Request::class)) {
+			throw new ApplicationLogicException('Could not load the requested request!');
+		}
+
+		return $request;
+	}
+
+	/**
+	 * Returns a value stating whether the user is allowed to see private data or not
+	 *
+	 * @param Request $request
+	 * @param User    $currentUser
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	protected function isAllowedPrivateData(Request $request, User $currentUser)
+	{
+		// Test the main security barrier for private data access using SecurityManager
+		if ($this->barrierTest('alwaysSeePrivateData', $currentUser, 'RequestData')) {
+			// Tool admins/check-users can always see private data
+			return true;
+		}
+
+		// reserving user is allowed to see the data
+		if ($currentUser->getId() === $request->getReserved()
+			&& $request->getReserved() !== null
+			&& $this->barrierTest('seePrivateDataWhenReserved', $currentUser, 'RequestData')
+		) {
+			return true;
+		}
+
+		// user has the reveal hash
+		if (WebRequest::getString('hash') === $request->getRevealHash()
+			&& $this->barrierTest('seePrivateDataWithHash', $currentUser, 'RequestData')
+		) {
+			return true;
+		}
+
+		// nope. Not allowed.
+		return false;
+	}
+
+	/**
+	 * Tests the security barrier for a specified action.
+	 *
+	 * Don't use within templates
+	 *
+	 * @param string      $action
+	 *
+	 * @param User        $user
+	 * @param null|string $pageName
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	abstract protected function barrierTest($action, User $user, $pageName = null);
+
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	abstract protected function getRouteName();
+
+	/** @return SecurityManager */
+	abstract protected function getSecurityManager();
+
+	/**
+	 * Sets the name of the template this page should display.
+	 *
+	 * @param string $name
+	 */
+	abstract protected function setTemplate($name);
+
+	/** @return IXffTrustProvider */
+	abstract protected function getXffTrustProvider();
+
+	/** @return ILocationProvider */
+	abstract protected function getLocationProvider();
+
+	/** @return IRDnsProvider */
+	abstract protected function getRdnsProvider();
+
+	/**
+	 * Assigns a Smarty variable
+	 *
+	 * @param  array|string $name  the template variable name(s)
+	 * @param  mixed        $value the value to assign
+	 */
+	abstract protected function assign($name, $value);
+
+	/**
+	 * @param int         $requestReservationId
+	 * @param PdoDatabase $database
+	 * @param User        $currentUser
+	 */
+	protected function setupReservationDetails($requestReservationId, PdoDatabase $database, User $currentUser)
+	{
+		$requestIsReserved = $requestReservationId !== null;
+		$this->assign('requestIsReserved', $requestIsReserved);
+		$this->assign('requestIsReservedByMe', false);
+
+		if ($requestIsReserved) {
+			$this->assign('requestReservedByName', User::getById($requestReservationId, $database)->getUsername());
+			$this->assign('requestReservedById', $requestReservationId);
+
+			if ($requestReservationId === $currentUser->getId()) {
+				$this->assign('requestIsReservedByMe', true);
+			}
+		}
+
+		$this->assign('canBreakReservation', $this->barrierTest('force', $currentUser, PageBreakReservation::class));
+	}
+
+	/**
+	 * Adds private request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
+	 *
+	 * @param Request           $request
+	 * @param User              $currentUser
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @param PdoDatabase       $database
+	 */
+	protected function setupPrivateData(
+		$request,
+		User $currentUser,
+		SiteConfiguration $configuration,
+		PdoDatabase $database
+	) {
+		$xffProvider = $this->getXffTrustProvider();
+
+		$relatedEmailRequests = RequestSearchHelper::get($database)
+			->byEmailAddress($request->getEmail())
+			->withConfirmedEmail()
+			->excludingPurgedData($configuration)
+			->excludingRequest($request->getId())
+			->fetch();
+
+		$this->assign('requestEmail', $request->getEmail());
+		$emailDomain = explode("@", $request->getEmail())[1];
+		$this->assign("emailurl", $emailDomain);
+		$this->assign('requestRelatedEmailRequestsCount', count($relatedEmailRequests));
+		$this->assign('requestRelatedEmailRequests', $relatedEmailRequests);
+
+		$trustedIp = $xffProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
+		$this->assign('requestTrustedIp', $trustedIp);
+		$this->assign('requestRealIp', $request->getIp());
+		$this->assign('requestForwardedIp', $request->getForwardedIp());
+
+		$trustedIpLocation = $this->getLocationProvider()->getIpLocation($trustedIp);
+		$this->assign('requestTrustedIpLocation', $trustedIpLocation);
+
+		$this->assign('requestHasForwardedIp', $request->getForwardedIp() !== null);
+
+		$relatedIpRequests = RequestSearchHelper::get($database)
+			->byIp($trustedIp)
+			->withConfirmedEmail()
+			->excludingPurgedData($configuration)
+			->excludingRequest($request->getId())
+			->fetch();
+
+		$this->assign('requestRelatedIpRequestsCount', count($relatedIpRequests));
+		$this->assign('requestRelatedIpRequests', $relatedIpRequests);
+
+		$this->assign('showRevealLink', false);
+		if ($request->getReserved() === $currentUser->getId() ||
+			$this->barrierTest('alwaysSeeHash', $currentUser, 'RequestData')
+		) {
+			$this->assign('showRevealLink', true);
+			$this->assign('revealHash', $request->getRevealHash());
+		}
+
+		$this->setupForwardedIpData($request);
+	}
+
+	/**
+	 * Adds checkuser request data to Smarty. DO NOT USE WITHOUT FIRST CHECKING THAT THE USER IS AUTHORISED!
+	 *
+	 * @param Request $request
+	 */
+	protected function setupCheckUserData(Request $request)
+	{
+		$this->assign('requestUserAgent', $request->getUserAgent());
+	}
+
+	/**
+	 * Sets up the basic data for this request, and adds it to Smarty
+	 *
+	 * @param Request           $request
+	 * @param SiteConfiguration $config
+	 */
+	protected function setupBasicData(Request $request, SiteConfiguration $config)
+	{
+		$this->assign('requestId', $request->getId());
+		$this->assign('updateVersion', $request->getUpdateVersion());
+		$this->assign('requestName', $request->getName());
+		$this->assign('requestDate', $request->getDate());
+		$this->assign('requestStatus', $request->getStatus());
+
+		$isClosed = !array_key_exists($request->getStatus(), $config->getRequestStates())
+			&& $request->getStatus() !== RequestStatus::HOSPITAL;
+		$this->assign('requestIsClosed', $isClosed);
+	}
+
+	/**
+	 * Sets up the forwarded IP data for this request and adds it to Smarty
+	 *
+	 * @param Request $request
+	 */
+	protected function setupForwardedIpData(Request $request)
+	{
+		if ($request->getForwardedIp() !== null) {
+			$requestProxyData = array(); // Initialize array to store data to be output in Smarty template.
+			$proxyIndex = 0;
+
+			// Assuming [client] <=> [proxy1] <=> [proxy2] <=> [proxy3] <=> [us], we will see an XFF header of [client],
+			// [proxy1], [proxy2], and our actual IP will be [proxy3]
+			$proxies = explode(",", $request->getForwardedIp());
+			$proxies[] = $request->getIp();
+
+			// Origin is the supposed "client" IP.
+			$origin = $proxies[0];
+			$this->assign("forwardedOrigin", $origin);
+
+			// We step through the servers in reverse order, from closest to furthest
+			$proxies = array_reverse($proxies);
+
+			// By default, we have trust, because the first in the chain is now REMOTE_ADDR, which is hardest to spoof.
+			$trust = true;
+
+			/**
+			 * @var int    $index     The zero-based index of the proxy.
+			 * @var string $proxyData The proxy IP address (although possibly not!)
+			 */
+			foreach ($proxies as $index => $proxyData) {
+				$proxyAddress = trim($proxyData);
+				$requestProxyData[$proxyIndex]['ip'] = $proxyAddress;
+
+				// get data on this IP.
+				$thisProxyIsTrusted = $this->getXffTrustProvider()->isTrusted($proxyAddress);
+
+				$proxyIsInPrivateRange = $this->getXffTrustProvider()
+					->ipInRange(self::$rfc1918ips, $proxyAddress);
+
+				if (!$proxyIsInPrivateRange) {
+					$proxyReverseDns = $this->getRdnsProvider()->getReverseDNS($proxyAddress);
+					$proxyLocation = $this->getLocationProvider()->getIpLocation($proxyAddress);
+				}
+				else {
+					// this is going to fail, so why bother trying?
+					$proxyReverseDns = false;
+					$proxyLocation = false;
+				}
+
+				// current trust chain status BEFORE this link
+				$preLinkTrust = $trust;
+
+				// is *this* link trusted? Note, this will be true even if there is an untrusted link before this!
+				$requestProxyData[$proxyIndex]['trustedlink'] = $thisProxyIsTrusted;
+
+				// set the trust status of the chain to this point
+				$trust = $trust & $thisProxyIsTrusted;
+
+				// If this is the origin address, and the chain was trusted before this point, then we can trust
+				// the origin.
+				if ($preLinkTrust && $proxyAddress == $origin) {
+					// if this is the origin, then we are at the last point in the chain.
+					// @todo: this is probably the cause of some bugs when an IP appears twice - we're missing a check
+					// to see if this is *really* the last in the chain, rather than just the same IP as it.
+					$trust = true;
+				}
+
+				$requestProxyData[$proxyIndex]['trust'] = $trust;
+
+				$requestProxyData[$proxyIndex]['rdnsfailed'] = $proxyReverseDns === false;
+				$requestProxyData[$proxyIndex]['rdns'] = $proxyReverseDns;
+				$requestProxyData[$proxyIndex]['routable'] = !$proxyIsInPrivateRange;
+
+				$requestProxyData[$proxyIndex]['location'] = $proxyLocation;
+
+				if ($proxyReverseDns === $proxyAddress && $proxyIsInPrivateRange === false) {
+					$requestProxyData[$proxyIndex]['rdns'] = null;
+				}
+
+				$showLinks = (!$trust || $proxyAddress == $origin) && !$proxyIsInPrivateRange;
+				$requestProxyData[$proxyIndex]['showlinks'] = $showLinks;
+
+				$proxyIndex++;
+			}
+
+			$this->assign("requestProxyData", $requestProxyData);
+		}
+	}
 }

includes/Router/OAuthRequestRouter.php

Indentation +5 added lines, -5 removed lines

@@ -17,9 +17,9 @@
  */
 class OAuthRequestRouter extends RequestRouter
 {
-    protected function getRouteFromPath($pathInfo)
-    {
-        // Hardcode the route for this entry point
-        return array(PageOAuthCallback::class, 'authorise');
-    }
+	protected function getRouteFromPath($pathInfo)
+	{
+		// Hardcode the route for this entry point
+		return array(PageOAuthCallback::class, 'authorise');
+	}
 }
\ No newline at end of file

includes/Tasks/PagedInternalPageBase.php

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
         $formParameters['limit'] = $this->limit;
         $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&'));
 
-        foreach ($formParameters as $key => $value)  {
+        foreach ($formParameters as $key => $value) {
             $this->assign($key, $value);
         }
     }

Braces +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
         $formParameters['limit'] = $this->limit;
         $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&'));
 
-        foreach ($formParameters as $key => $value)  {
+        foreach ($formParameters as $key => $value) {
             $this->assign($key, $value);
         }
     }

Indentation +93 added lines, -93 removed lines

@@ -13,97 +13,97 @@
 
 abstract class PagedInternalPageBase extends InternalPageBase
 {
-    /** @var SearchHelperBase */
-    private $searchHelper;
-    private $page;
-    private $limit;
-
-    /**
-     * Sets up the pager with the current page, current limit, and total number of records.
-     *
-     * @param int   $count
-     * @param array $formParameters
-     */
-    protected function setupPageData($count, $formParameters)
-    {
-        $page = $this->page;
-        $limit = $this->limit;
-
-        // The number of pages on the pager to show. Must be odd
-        $pageLimit = 9;
-
-        $pageData = array(
-            // Can the user go to the previous page?
-            'canprev'   => $page != 1,
-            // Can the user go to the next page?
-            'cannext'   => ($page * $limit) < $count,
-            // Maximum page number
-            'maxpage'   => max(1, ceil($count / $limit)),
-            // Limit to the number of pages to display
-            'pagelimit' => $pageLimit,
-        );
-
-        // number of pages either side of the current to show
-        $pageMargin = (($pageLimit - 1) / 2);
-
-        // Calculate the number of pages either side to show - this is for situations like:
-        //  [1]  [2] [[3]] [4]  [5]  [6]  [7]  [8]  [9] - where you can't just use the page margin calculated
-        $pageData['lowpage'] = max(1, $page - $pageMargin);
-        $pageData['hipage'] = min($pageData['maxpage'], $page + $pageMargin);
-        $pageCount = ($pageData['hipage'] - $pageData['lowpage']) + 1;
-
-        if ($pageCount < $pageLimit) {
-            if ($pageData['lowpage'] == 1 && $pageData['hipage'] < $pageData['maxpage']) {
-                $pageData['hipage'] = min($pageLimit, $pageData['maxpage']);
-            }
-            elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
-                $pageData['lowpage'] = max(1, $pageData['maxpage'] - $pageLimit + 1);
-            }
-        }
-
-        // Put the range of pages into the page data
-        $pageData['pages'] = range($pageData['lowpage'], $pageData['hipage']);
-
-        $this->assign("pagedata", $pageData);
-
-        $this->assign("limit", $limit);
-        $this->assign("page", $page);
-
-        $this->setupFormParameters($formParameters);
-    }
-
-    protected function setSearchHelper(SearchHelperBase $searchHelper)
-    {
-        $this->searchHelper = $searchHelper;
-    }
-
-    protected function setupLimits()
-    {
-        $limit = WebRequest::getInt('limit');
-        if ($limit === null) {
-            $limit = 100;
-        }
-
-        $page = WebRequest::getInt('page');
-        if ($page === null) {
-            $page = 1;
-        }
-
-        $offset = ($page - 1) * $limit;
-
-        $this->searchHelper->limit($limit, $offset);
-
-        $this->page = $page;
-        $this->limit = $limit;
-    }
-
-    private function setupFormParameters($formParameters)
-    {
-        $formParameters['limit'] = $this->limit;
-        $this->assign('searchParamsUrl', http_build_query($formParameters, '', '&amp;'));
-
-        foreach ($formParameters as $key => $value)  {
-            $this->assign($key, $value);
-        }
-    }
+	/** @var SearchHelperBase */
+	private $searchHelper;
+	private $page;
+	private $limit;
+
+	/**
+	 * Sets up the pager with the current page, current limit, and total number of records.
+	 *
+	 * @param int   $count
+	 * @param array $formParameters
+	 */
+	protected function setupPageData($count, $formParameters)
+	{
+		$page = $this->page;
+		$limit = $this->limit;
+
+		// The number of pages on the pager to show. Must be odd
+		$pageLimit = 9;
+
+		$pageData = array(
+			// Can the user go to the previous page?
+			'canprev'   => $page != 1,
+			// Can the user go to the next page?
+			'cannext'   => ($page * $limit) < $count,
+			// Maximum page number
+			'maxpage'   => max(1, ceil($count / $limit)),
+			// Limit to the number of pages to display
+			'pagelimit' => $pageLimit,
+		);
+
+		// number of pages either side of the current to show
+		$pageMargin = (($pageLimit - 1) / 2);
+
+		// Calculate the number of pages either side to show - this is for situations like:
+		//  [1]  [2] [[3]] [4]  [5]  [6]  [7]  [8]  [9] - where you can't just use the page margin calculated
+		$pageData['lowpage'] = max(1, $page - $pageMargin);
+		$pageData['hipage'] = min($pageData['maxpage'], $page + $pageMargin);
+		$pageCount = ($pageData['hipage'] - $pageData['lowpage']) + 1;
+
+		if ($pageCount < $pageLimit) {
+			if ($pageData['lowpage'] == 1 && $pageData['hipage'] < $pageData['maxpage']) {
+				$pageData['hipage'] = min($pageLimit, $pageData['maxpage']);
+			}
+			elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
+				$pageData['lowpage'] = max(1, $pageData['maxpage'] - $pageLimit + 1);
+			}
+		}
+
+		// Put the range of pages into the page data
+		$pageData['pages'] = range($pageData['lowpage'], $pageData['hipage']);
+
+		$this->assign("pagedata", $pageData);
+
+		$this->assign("limit", $limit);
+		$this->assign("page", $page);
+
+		$this->setupFormParameters($formParameters);
+	}
+
+	protected function setSearchHelper(SearchHelperBase $searchHelper)
+	{
+		$this->searchHelper = $searchHelper;
+	}
+
+	protected function setupLimits()
+	{
+		$limit = WebRequest::getInt('limit');
+		if ($limit === null) {
+			$limit = 100;
+		}
+
+		$page = WebRequest::getInt('page');
+		if ($page === null) {
+			$page = 1;
+		}
+
+		$offset = ($page - 1) * $limit;
+
+		$this->searchHelper->limit($limit, $offset);
+
+		$this->page = $page;
+		$this->limit = $limit;
+	}
+
+	private function setupFormParameters($formParameters)
+	{
+		$formParameters['limit'] = $this->limit;
+		$this->assign('searchParamsUrl', http_build_query($formParameters, '', '&amp;'));
+
+		foreach ($formParameters as $key => $value)  {
+			$this->assign($key, $value);
+		}
+	}
 }