enwikipedia-acc / waca

includes/DataObjects/OAuthIdentity.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -10,9 +10,9 @@
 
 use DateTimeImmutable;
 use Exception;
-use stdClass;
 use Waca\DataObject;
 use Waca\Exceptions\OptimisticLockFailedException;
+use stdClass;
 
 class OAuthIdentity extends DataObject
 {

Indentation +285 added lines, -285 removed lines

@@ -16,51 +16,51 @@ 
 
 class OAuthIdentity extends DataObject
 {
-    #region Fields
-    /** @var int */
-    private $user;
-    /** @var string */
-    private $iss;
-    /** @var int */
-    private $sub;
-    /** @var string */
-    private $aud;
-    /** @var int */
-    private $exp;
-    /** @var int */
-    private $iat;
-    /** @var string */
-    private $username;
-    /** @var int */
-    private $editcount;
-    /** @var int */
-    private $confirmed_email;
-    /** @var int */
-    private $blocked;
-    /** @var string */
-    private $registered;
-    /** @var int */
-    private $checkuser;
-    /** @var int */
-    private $grantbasic;
-    /** @var int */
-    private $grantcreateaccount;
-    /** @var int */
-    private $granthighvolume;
-    /** @var int */
-    private $grantcreateeditmovepage;
-    #endregion
-
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     * @return void
-     * @throws Exception
-     * @throws OptimisticLockFailedException
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            $statement = $this->dbObject->prepare(<<<SQL
+	#region Fields
+	/** @var int */
+	private $user;
+	/** @var string */
+	private $iss;
+	/** @var int */
+	private $sub;
+	/** @var string */
+	private $aud;
+	/** @var int */
+	private $exp;
+	/** @var int */
+	private $iat;
+	/** @var string */
+	private $username;
+	/** @var int */
+	private $editcount;
+	/** @var int */
+	private $confirmed_email;
+	/** @var int */
+	private $blocked;
+	/** @var string */
+	private $registered;
+	/** @var int */
+	private $checkuser;
+	/** @var int */
+	private $grantbasic;
+	/** @var int */
+	private $grantcreateaccount;
+	/** @var int */
+	private $granthighvolume;
+	/** @var int */
+	private $grantcreateeditmovepage;
+	#endregion
+
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 * @return void
+	 * @throws Exception
+	 * @throws OptimisticLockFailedException
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO oauthidentity (
                     user, iss, sub, aud, exp, iat, username, editcount, confirmed_email, blocked, registered, checkuser, 
                     grantbasic, grantcreateaccount, granthighvolume, grantcreateeditmovepage
@@ -69,34 +69,34 @@ 
                     :checkuser, :grantbasic, :grantcreateaccount, :granthighvolume, :grantcreateeditmovepage
                 )
 SQL
-            );
-
-            $statement->bindValue(':user', $this->user);
-            $statement->bindValue(':iss', $this->iss);
-            $statement->bindValue(':sub', $this->sub);
-            $statement->bindValue(':aud', $this->aud);
-            $statement->bindValue(':exp', $this->exp);
-            $statement->bindValue(':iat', $this->iat);
-            $statement->bindValue(':username', $this->username);
-            $statement->bindValue(':editcount', $this->editcount);
-            $statement->bindValue(':confirmed_email', $this->confirmed_email);
-            $statement->bindValue(':blocked', $this->blocked);
-            $statement->bindValue(':registered', $this->registered);
-            $statement->bindValue(':checkuser', $this->checkuser);
-            $statement->bindValue(':grantbasic', $this->grantbasic);
-            $statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
-            $statement->bindValue(':granthighvolume', $this->granthighvolume);
-            $statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+
+			$statement->bindValue(':user', $this->user);
+			$statement->bindValue(':iss', $this->iss);
+			$statement->bindValue(':sub', $this->sub);
+			$statement->bindValue(':aud', $this->aud);
+			$statement->bindValue(':exp', $this->exp);
+			$statement->bindValue(':iat', $this->iat);
+			$statement->bindValue(':username', $this->username);
+			$statement->bindValue(':editcount', $this->editcount);
+			$statement->bindValue(':confirmed_email', $this->confirmed_email);
+			$statement->bindValue(':blocked', $this->blocked);
+			$statement->bindValue(':registered', $this->registered);
+			$statement->bindValue(':checkuser', $this->checkuser);
+			$statement->bindValue(':grantbasic', $this->grantbasic);
+			$statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
+			$statement->bindValue(':granthighvolume', $this->granthighvolume);
+			$statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE oauthidentity SET
                       iss                     = :iss
                     , sub                     = :sub
@@ -116,211 +116,211 @@ 
                     , updateversion           = updateversion + 1
                 WHERE  id = :id AND updateversion = :updateversion
 SQL
-            );
-
-            $statement->bindValue(':iss', $this->iss);
-            $statement->bindValue(':sub', $this->sub);
-            $statement->bindValue(':aud', $this->aud);
-            $statement->bindValue(':exp', $this->exp);
-            $statement->bindValue(':iat', $this->iat);
-            $statement->bindValue(':username', $this->username);
-            $statement->bindValue(':editcount', $this->editcount);
-            $statement->bindValue(':confirmed_email', $this->confirmed_email);
-            $statement->bindValue(':blocked', $this->blocked);
-            $statement->bindValue(':registered', $this->registered);
-            $statement->bindValue(':checkuser', $this->checkuser);
-            $statement->bindValue(':grantbasic', $this->grantbasic);
-            $statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
-            $statement->bindValue(':granthighvolume', $this->granthighvolume);
-            $statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    #region Properties
-
-    /**
-     * @return int
-     */
-    public function getUserId()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user
-     */
-    public function setUserId($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return string
-     */
-    public function getIssuer()
-    {
-        return $this->iss;
-    }
-
-    /**
-     * @return int
-     */
-    public function getSubject()
-    {
-        return $this->sub;
-    }
-
-    /**
-     * @return string
-     */
-    public function getAudience()
-    {
-        return $this->aud;
-    }
-
-    /**
-     * @return int
-     */
-    public function getExpirationTime()
-    {
-        return $this->exp;
-    }
-
-    /**
-     * @return int
-     */
-    public function getIssuedAtTime()
-    {
-        return $this->iat;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUsername()
-    {
-        return $this->username;
-    }
-
-    /**
-     * @return int
-     */
-    public function getEditCount()
-    {
-        return $this->editcount;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getConfirmedEmail()
-    {
-        return $this->confirmed_email == 1;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getBlocked()
-    {
-        return $this->blocked == 1;
-    }
-
-    /**
-     * @return string
-     */
-    public function getRegistered()
-    {
-        return $this->registered;
-    }
-
-    public function getRegistrationDate()
-    {
-        return DateTimeImmutable::createFromFormat('YmdHis', $this->registered)->format('r');
-    }
-
-    public function getAccountAge()
-    {
-        $regDate = DateTimeImmutable::createFromFormat('YmdHis', $this->registered);
-        $interval = $regDate->diff(new DateTimeImmutable(), true);
-
-        return $interval->days;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getCheckuser()
-    {
-        return $this->checkuser == 1;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getGrantBasic()
-    {
-        return $this->grantbasic == 1;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getGrantCreateAccount()
-    {
-        return $this->grantcreateaccount == 1;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getGrantHighVolume()
-    {
-        return $this->granthighvolume == 1;
-    }
-
-    /**
-     * @return bool
-     */
-    public function getGrantCreateEditMovePage()
-    {
-        return $this->grantcreateeditmovepage == 1;
-    }
-
-    #endregion Properties
-
-    /**
-     * Populates the fields of this instance from a provided JSON Web Token
-     *
-     * @param stdClass $jwt
-     */
-    public function populate($jwt)
-    {
-        $this->iss = $jwt->iss;
-        $this->sub = $jwt->sub;
-        $this->aud = $jwt->aud;
-        $this->exp = $jwt->exp;
-        $this->iat = $jwt->iat;
-        $this->username = $jwt->username;
-        $this->editcount = $jwt->editcount;
-        $this->confirmed_email = $jwt->confirmed_email ? 1 : 0;
-        $this->blocked = $jwt->blocked ? 1 : 0;
-        $this->registered = $jwt->registered;
-
-        /*
+			);
+
+			$statement->bindValue(':iss', $this->iss);
+			$statement->bindValue(':sub', $this->sub);
+			$statement->bindValue(':aud', $this->aud);
+			$statement->bindValue(':exp', $this->exp);
+			$statement->bindValue(':iat', $this->iat);
+			$statement->bindValue(':username', $this->username);
+			$statement->bindValue(':editcount', $this->editcount);
+			$statement->bindValue(':confirmed_email', $this->confirmed_email);
+			$statement->bindValue(':blocked', $this->blocked);
+			$statement->bindValue(':registered', $this->registered);
+			$statement->bindValue(':checkuser', $this->checkuser);
+			$statement->bindValue(':grantbasic', $this->grantbasic);
+			$statement->bindValue(':grantcreateaccount', $this->grantcreateaccount);
+			$statement->bindValue(':granthighvolume', $this->granthighvolume);
+			$statement->bindValue(':grantcreateeditmovepage', $this->grantcreateeditmovepage);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	#region Properties
+
+	/**
+	 * @return int
+	 */
+	public function getUserId()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user
+	 */
+	public function setUserId($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getIssuer()
+	{
+		return $this->iss;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getSubject()
+	{
+		return $this->sub;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getAudience()
+	{
+		return $this->aud;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getExpirationTime()
+	{
+		return $this->exp;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getIssuedAtTime()
+	{
+		return $this->iat;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getUsername()
+	{
+		return $this->username;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getEditCount()
+	{
+		return $this->editcount;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getConfirmedEmail()
+	{
+		return $this->confirmed_email == 1;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getBlocked()
+	{
+		return $this->blocked == 1;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getRegistered()
+	{
+		return $this->registered;
+	}
+
+	public function getRegistrationDate()
+	{
+		return DateTimeImmutable::createFromFormat('YmdHis', $this->registered)->format('r');
+	}
+
+	public function getAccountAge()
+	{
+		$regDate = DateTimeImmutable::createFromFormat('YmdHis', $this->registered);
+		$interval = $regDate->diff(new DateTimeImmutable(), true);
+
+		return $interval->days;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getCheckuser()
+	{
+		return $this->checkuser == 1;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getGrantBasic()
+	{
+		return $this->grantbasic == 1;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getGrantCreateAccount()
+	{
+		return $this->grantcreateaccount == 1;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getGrantHighVolume()
+	{
+		return $this->granthighvolume == 1;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getGrantCreateEditMovePage()
+	{
+		return $this->grantcreateeditmovepage == 1;
+	}
+
+	#endregion Properties
+
+	/**
+	 * Populates the fields of this instance from a provided JSON Web Token
+	 *
+	 * @param stdClass $jwt
+	 */
+	public function populate($jwt)
+	{
+		$this->iss = $jwt->iss;
+		$this->sub = $jwt->sub;
+		$this->aud = $jwt->aud;
+		$this->exp = $jwt->exp;
+		$this->iat = $jwt->iat;
+		$this->username = $jwt->username;
+		$this->editcount = $jwt->editcount;
+		$this->confirmed_email = $jwt->confirmed_email ? 1 : 0;
+		$this->blocked = $jwt->blocked ? 1 : 0;
+		$this->registered = $jwt->registered;
+
+		/*
          * Rights we need:
          *  Account creation
          *      createaccount      => createaccount
@@ -342,13 +342,13 @@ 
          * Any antispoof conflicts will still have to be resolved manually using the normal creation form.
          */
 
-        $this->grantbasic = in_array('basic', $jwt->grants) ? 1 : 0;
-        $this->grantcreateaccount = in_array('createaccount', $jwt->grants) ? 1 : 0;
-        $this->grantcreateeditmovepage = in_array('createeditmovepage', $jwt->grants) ? 1 : 0;
+		$this->grantbasic = in_array('basic', $jwt->grants) ? 1 : 0;
+		$this->grantcreateaccount = in_array('createaccount', $jwt->grants) ? 1 : 0;
+		$this->grantcreateeditmovepage = in_array('createeditmovepage', $jwt->grants) ? 1 : 0;
 
-        // we don't request these yet.
-        $this->granthighvolume = 0;
+		// we don't request these yet.
+		$this->granthighvolume = 0;
 
-        $this->checkuser = in_array('checkuser', $jwt->rights) ? 1 : 0;
-    }
+		$this->checkuser = in_array('checkuser', $jwt->rights) ? 1 : 0;
+	}
 }
\ No newline at end of file

includes/Pages/PageJobQueue.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -14,8 +14,8 @@
 use Waca\DataObjects\Request;
 use Waca\DataObjects\User;
 use Waca\Exceptions\ApplicationLogicException;
-use Waca\Helpers\Logger;
 use Waca\Helpers\LogHelper;
+use Waca\Helpers\Logger;
 use Waca\Helpers\SearchHelpers\JobQueueSearchHelper;
 use Waca\Helpers\SearchHelpers\LogSearchHelper;
 use Waca\Helpers\SearchHelpers\RequestSearchHelper;

Indentation +179 added lines, -179 removed lines

@@ -26,239 +26,239 @@
 
 class PageJobQueue extends PagedInternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setHtmlTitle('Job Queue Management');
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setHtmlTitle('Job Queue Management');
 
-        $this->prepareMaps();
+		$this->prepareMaps();
 
-        $database = $this->getDatabase();
+		$database = $this->getDatabase();
 
-        /** @var JobQueue[] $jobList */
-        $jobList = JobQueueSearchHelper::get($database)
-            ->statusIn(array('ready', 'waiting', 'running', 'failed'))
-            ->notAcknowledged()
-            ->fetch();
+		/** @var JobQueue[] $jobList */
+		$jobList = JobQueueSearchHelper::get($database)
+			->statusIn(array('ready', 'waiting', 'running', 'failed'))
+			->notAcknowledged()
+			->fetch();
 
-        $userIds = array();
-        $requestIds = array();
+		$userIds = array();
+		$requestIds = array();
 
-        foreach ($jobList as $job) {
-            $userIds[] = $job->getTriggerUserId();
-            $requestIds[] = $job->getRequest();
+		foreach ($jobList as $job) {
+			$userIds[] = $job->getTriggerUserId();
+			$requestIds[] = $job->getRequest();
 
-            $job->setDatabase($database);
-        }
+			$job->setDatabase($database);
+		}
 
-        $this->assign('canSeeAll', $this->barrierTest('all', User::getCurrent($database)));
+		$this->assign('canSeeAll', $this->barrierTest('all', User::getCurrent($database)));
 
-        $this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
-        $this->assign('requests', RequestSearchHelper::get($database)->inIds($requestIds)->fetchMap('name'));
+		$this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
+		$this->assign('requests', RequestSearchHelper::get($database)->inIds($requestIds)->fetchMap('name'));
 
-        $this->assign('joblist', $jobList);
-        $this->setTemplate('jobqueue/main.tpl');
-    }
+		$this->assign('joblist', $jobList);
+		$this->setTemplate('jobqueue/main.tpl');
+	}
 
-    protected function all()
-    {
-        $this->setHtmlTitle('All Jobs');
+	protected function all()
+	{
+		$this->setHtmlTitle('All Jobs');
 
-        $this->prepareMaps();
+		$this->prepareMaps();
 
-        $database = $this->getDatabase();
+		$database = $this->getDatabase();
 
-        $searchHelper = JobQueueSearchHelper::get($database);
-        $this->setSearchHelper($searchHelper);
-        $this->setupLimits();
+		$searchHelper = JobQueueSearchHelper::get($database);
+		$this->setSearchHelper($searchHelper);
+		$this->setupLimits();
 
-        $filterUser = WebRequest::getString('filterUser');
-        $filterTask = WebRequest::getString('filterTask');
-        $filterStatus = WebRequest::getString('filterStatus');
-        $filterRequest = WebRequest::getString('filterRequest');
+		$filterUser = WebRequest::getString('filterUser');
+		$filterTask = WebRequest::getString('filterTask');
+		$filterStatus = WebRequest::getString('filterStatus');
+		$filterRequest = WebRequest::getString('filterRequest');
 
-        if ($filterUser !== null) {
-            $searchHelper->byUser(User::getByUsername($filterUser, $database)->getId());
-        }
+		if ($filterUser !== null) {
+			$searchHelper->byUser(User::getByUsername($filterUser, $database)->getId());
+		}
 
-        if ($filterTask !== null) {
-            $searchHelper->byTask($filterTask);
-        }
+		if ($filterTask !== null) {
+			$searchHelper->byTask($filterTask);
+		}
 
-        if ($filterStatus !== null) {
-            $searchHelper->byStatus($filterStatus);
-        }
+		if ($filterStatus !== null) {
+			$searchHelper->byStatus($filterStatus);
+		}
 
-        if ($filterRequest !== null) {
-            $searchHelper->byRequest($filterRequest);
-        }
+		if ($filterRequest !== null) {
+			$searchHelper->byRequest($filterRequest);
+		}
 
-        /** @var JobQueue[] $jobList */
-        $jobList = $searchHelper->getRecordCount($count)->fetch();
+		/** @var JobQueue[] $jobList */
+		$jobList = $searchHelper->getRecordCount($count)->fetch();
 
-        $this->setupPageData($count, array(
-            'filterUser' => $filterUser,
-            'filterTask' => $filterTask,
-            'filterStatus' => $filterStatus,
-            'filterRequest' => $filterRequest,
-        ));
+		$this->setupPageData($count, array(
+			'filterUser' => $filterUser,
+			'filterTask' => $filterTask,
+			'filterStatus' => $filterStatus,
+			'filterRequest' => $filterRequest,
+		));
 
-        $userIds = array();
-        $requestIds = array();
+		$userIds = array();
+		$requestIds = array();
 
-        foreach ($jobList as $job) {
-            $userIds[] = $job->getTriggerUserId();
-            $requestIds[] = $job->getRequest();
+		foreach ($jobList as $job) {
+			$userIds[] = $job->getTriggerUserId();
+			$requestIds[] = $job->getRequest();
 
-            $job->setDatabase($database);
-        }
+			$job->setDatabase($database);
+		}
 
-        $this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database) {
-            return UserSearchHelper::get($database)->fetchColumn('username');
-        });
+		$this->getTypeAheadHelper()->defineTypeAheadSource('username-typeahead', function() use ($database) {
+			return UserSearchHelper::get($database)->fetchColumn('username');
+		});
 
-        $this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
-        $this->assign('requests', RequestSearchHelper::get($database)->inIds($requestIds)->fetchMap('name'));
+		$this->assign('users', UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username'));
+		$this->assign('requests', RequestSearchHelper::get($database)->inIds($requestIds)->fetchMap('name'));
 
-        $this->assign('joblist', $jobList);
+		$this->assign('joblist', $jobList);
 
-        $this->setTemplate('jobqueue/all.tpl');
-    }
+		$this->setTemplate('jobqueue/all.tpl');
+	}
 
-    protected function view()
-    {
-        $jobId = WebRequest::getInt('id');
-        $database = $this->getDatabase();
+	protected function view()
+	{
+		$jobId = WebRequest::getInt('id');
+		$database = $this->getDatabase();
 
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
 
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
 
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
 
-        $this->setHtmlTitle('Job #' . $job->getId());
+		$this->setHtmlTitle('Job #' . $job->getId());
 
-        $this->prepareMaps();
+		$this->prepareMaps();
 
-        $this->assign('user', User::getById($job->getTriggerUserId(), $database));
-        $this->assign('request', Request::getById($job->getRequest(), $database));
-        $this->assign('emailTemplate', EmailTemplate::getById($job->getEmailTemplate(), $database));
-        $this->assign('parent', JobQueue::getById($job->getParent(), $database));
+		$this->assign('user', User::getById($job->getTriggerUserId(), $database));
+		$this->assign('request', Request::getById($job->getRequest(), $database));
+		$this->assign('emailTemplate', EmailTemplate::getById($job->getEmailTemplate(), $database));
+		$this->assign('parent', JobQueue::getById($job->getParent(), $database));
 
-        /** @var Log[] $logs */
-        $logs = LogSearchHelper::get($database)->byObjectType('JobQueue')
-            ->byObjectId($job->getId())->getRecordCount($logCount)->fetch();
-        if ($logCount === 0) {
-            $this->assign('log', array());
-        }
-        else {
-            list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration());
+		/** @var Log[] $logs */
+		$logs = LogSearchHelper::get($database)->byObjectType('JobQueue')
+			->byObjectId($job->getId())->getRecordCount($logCount)->fetch();
+		if ($logCount === 0) {
+			$this->assign('log', array());
+		}
+		else {
+			list($users, $logData) = LogHelper::prepareLogsForTemplate($logs, $database, $this->getSiteConfiguration());
 
-            $this->assign("log", $logData);
-            $this->assign("users", $users);
-        }
+			$this->assign("log", $logData);
+			$this->assign("users", $users);
+		}
 
-        $this->assignCSRFToken();
+		$this->assignCSRFToken();
 
-        $this->assign('job', $job);
+		$this->assign('job', $job);
 
-        $this->assign('canAcknowledge', $this->barrierTest('acknowledge', User::getCurrent($database)));
-        $this->assign('canRequeue', $this->barrierTest('requeue', User::getCurrent($database)));
-        $this->setTemplate('jobqueue/view.tpl');
-    }
+		$this->assign('canAcknowledge', $this->barrierTest('acknowledge', User::getCurrent($database)));
+		$this->assign('canRequeue', $this->barrierTest('requeue', User::getCurrent($database)));
+		$this->setTemplate('jobqueue/view.tpl');
+	}
 
-    protected function acknowledge()
-    {
-        if (!WebRequest::wasPosted()) {
-            throw new ApplicationLogicException('This page does not support GET methods.');
-        }
+	protected function acknowledge()
+	{
+		if (!WebRequest::wasPosted()) {
+			throw new ApplicationLogicException('This page does not support GET methods.');
+		}
 
-        $this->validateCSRFToken();
+		$this->validateCSRFToken();
 
-        $jobId = WebRequest::postInt('job');
-        $database = $this->getDatabase();
+		$jobId = WebRequest::postInt('job');
+		$database = $this->getDatabase();
 
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
 
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
 
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
 
-        $job->setUpdateVersion(WebRequest::postInt('updateVersion'));
-        $job->setAcknowledged(true);
-        $job->save();
+		$job->setUpdateVersion(WebRequest::postInt('updateVersion'));
+		$job->setAcknowledged(true);
+		$job->save();
 
-        Logger::backgroundJobAcknowledged($database, $job);
+		Logger::backgroundJobAcknowledged($database, $job);
 
-        $this->redirect('jobQueue', 'view', array('id' => $jobId));
-    }
+		$this->redirect('jobQueue', 'view', array('id' => $jobId));
+	}
 
-    protected function requeue()
-    {
-        if (!WebRequest::wasPosted()) {
-            throw new ApplicationLogicException('This page does not support GET methods.');
-        }
+	protected function requeue()
+	{
+		if (!WebRequest::wasPosted()) {
+			throw new ApplicationLogicException('This page does not support GET methods.');
+		}
 
-        $this->validateCSRFToken();
+		$this->validateCSRFToken();
 
-        $jobId = WebRequest::postInt('job');
-        $database = $this->getDatabase();
+		$jobId = WebRequest::postInt('job');
+		$database = $this->getDatabase();
 
-        if ($jobId === null) {
-            throw new ApplicationLogicException('No job specified');
-        }
+		if ($jobId === null) {
+			throw new ApplicationLogicException('No job specified');
+		}
 
-        /** @var JobQueue $job */
-        $job = JobQueue::getById($jobId, $database);
+		/** @var JobQueue $job */
+		$job = JobQueue::getById($jobId, $database);
 
-        if ($job === false) {
-            throw new ApplicationLogicException('Could not find requested job');
-        }
+		if ($job === false) {
+			throw new ApplicationLogicException('Could not find requested job');
+		}
 
-        $job->setStatus(JobQueue::STATUS_READY);
-        $job->setUpdateVersion(WebRequest::postInt('updateVersion'));
-        $job->setAcknowledged(null);
-        $job->setError(null);
-        $job->save();
-
-        /** @var Request $request */
-        $request = Request::getById($job->getRequest(), $database);
-        $request->setStatus(RequestStatus::JOBQUEUE);
-        $request->save();
+		$job->setStatus(JobQueue::STATUS_READY);
+		$job->setUpdateVersion(WebRequest::postInt('updateVersion'));
+		$job->setAcknowledged(null);
+		$job->setError(null);
+		$job->save();
+
+		/** @var Request $request */
+		$request = Request::getById($job->getRequest(), $database);
+		$request->setStatus(RequestStatus::JOBQUEUE);
+		$request->save();
 
-        Logger::enqueuedJobQueue($database, $request);
-        Logger::backgroundJobRequeued($database, $job);
-
-        $this->redirect('jobQueue', 'view', array('id' => $jobId));
-    }
-
-    protected function prepareMaps()
-    {
-        $taskNameMap = JobQueue::getTaskDescriptions();
-
-        $statusDecriptionMap = array(
-            JobQueue::STATUS_CANCELLED => 'The job was cancelled',
-            JobQueue::STATUS_COMPLETE  => 'The job completed successfully',
-            JobQueue::STATUS_FAILED    => 'The job encountered an error',
-            JobQueue::STATUS_READY     => 'The job is ready to be picked up by the next job runner execution',
-            JobQueue::STATUS_RUNNING   => 'The job is being run right now by the job runner',
-            JobQueue::STATUS_WAITING   => 'The job has been picked up by a job runner',
-            JobQueue::STATUS_HELD      => 'The job has manually held from processing',
-        );
-        $this->assign('taskNameMap', $taskNameMap);
-        $this->assign('statusDescriptionMap', $statusDecriptionMap);
-    }
+		Logger::enqueuedJobQueue($database, $request);
+		Logger::backgroundJobRequeued($database, $job);
+
+		$this->redirect('jobQueue', 'view', array('id' => $jobId));
+	}
+
+	protected function prepareMaps()
+	{
+		$taskNameMap = JobQueue::getTaskDescriptions();
+
+		$statusDecriptionMap = array(
+			JobQueue::STATUS_CANCELLED => 'The job was cancelled',
+			JobQueue::STATUS_COMPLETE  => 'The job completed successfully',
+			JobQueue::STATUS_FAILED    => 'The job encountered an error',
+			JobQueue::STATUS_READY     => 'The job is ready to be picked up by the next job runner execution',
+			JobQueue::STATUS_RUNNING   => 'The job is being run right now by the job runner',
+			JobQueue::STATUS_WAITING   => 'The job has been picked up by a job runner',
+			JobQueue::STATUS_HELD      => 'The job has manually held from processing',
+		);
+		$this->assign('taskNameMap', $taskNameMap);
+		$this->assign('statusDescriptionMap', $statusDecriptionMap);
+	}
 }
\ No newline at end of file

includes/Router/RequestRouter.php

Unused Use Statements +10 added lines, -10 removed lines

@@ -15,27 +15,20 @@ 
 use Waca\Pages\PageEmailManagement;
 use Waca\Pages\PageExpandedRequestList;
 use Waca\Pages\PageJobQueue;
-use Waca\Pages\RequestAction\PageCreateRequest;
-use Waca\Pages\UserAuth\PageChangePassword;
-use Waca\Pages\UserAuth\PageForgotPassword;
 use Waca\Pages\PageLog;
-use Waca\Pages\UserAuth\PageLogin;
-use Waca\Pages\UserAuth\PageLogout;
 use Waca\Pages\PageMain;
-use Waca\Pages\UserAuth\PageOAuth;
-use Waca\Pages\UserAuth\PageOAuthCallback;
-use Waca\Pages\UserAuth\PagePreferences;
-use Waca\Pages\Registration\PageRegisterStandard;
-use Waca\Pages\Registration\PageRegisterOption;
 use Waca\Pages\PageSearch;
 use Waca\Pages\PageSiteNotice;
 use Waca\Pages\PageTeam;
 use Waca\Pages\PageUserManagement;
 use Waca\Pages\PageViewRequest;
 use Waca\Pages\PageWelcomeTemplateManagement;
+use Waca\Pages\Registration\PageRegisterOption;
+use Waca\Pages\Registration\PageRegisterStandard;
 use Waca\Pages\RequestAction\PageBreakReservation;
 use Waca\Pages\RequestAction\PageCloseRequest;
 use Waca\Pages\RequestAction\PageComment;
+use Waca\Pages\RequestAction\PageCreateRequest;
 use Waca\Pages\RequestAction\PageCustomClose;
 use Waca\Pages\RequestAction\PageDeferRequest;
 use Waca\Pages\RequestAction\PageDropRequest;
@@ -49,6 +42,13 @@ 
 use Waca\Pages\Statistics\StatsTemplateStats;
 use Waca\Pages\Statistics\StatsTopCreators;
 use Waca\Pages\Statistics\StatsUsers;
+use Waca\Pages\UserAuth\PageChangePassword;
+use Waca\Pages\UserAuth\PageForgotPassword;
+use Waca\Pages\UserAuth\PageLogin;
+use Waca\Pages\UserAuth\PageLogout;
+use Waca\Pages\UserAuth\PageOAuth;
+use Waca\Pages\UserAuth\PageOAuthCallback;
+use Waca\Pages\UserAuth\PagePreferences;
 use Waca\Tasks\IRoutedTask;
 use Waca\WebRequest;
 

Indentation +411 added lines, -411 removed lines

@@ -59,415 +59,415 @@
  */
 class RequestRouter implements IRequestRouter
 {
-    /**
-     * This is the core routing table for the application. The basic idea is:
-     *
-     *      array(
-     *          "foo" =>
-     *              array(
-     *                  "class"   => PageFoo::class,
-     *                  "actions" => array("bar", "other")
-     *              ),
-     * );
-     *
-     * Things to note:
-     *     - If no page is requested, we go to PageMain. PageMain can't have actions defined.
-     *
-     *     - If a page is defined and requested, but no action is requested, go to that page's main() method
-     *     - If a page is defined and requested, and an action is defined and requested, go to that action's method.
-     *     - If a page is defined and requested, and an action NOT defined and requested, go to Page404 and it's main()
-     *       method.
-     *     - If a page is NOT defined and requested, go to Page404 and it's main() method.
-     *
-     *     - Query parameters are ignored.
-     *
-     * The key point here is request routing with validation that this is allowed, before we start hitting the
-     * filesystem through the AutoLoader, and opening random files. Also, so that we validate the action requested
-     * before we start calling random methods through the web UI.
-     *
-     * Examples:
-     * /internal.php                => returns instance of PageMain, routed to main()
-     * /internal.php?query          => returns instance of PageMain, routed to main()
-     * /internal.php/foo            => returns instance of PageFoo, routed to main()
-     * /internal.php/foo?query      => returns instance of PageFoo, routed to main()
-     * /internal.php/foo/bar        => returns instance of PageFoo, routed to bar()
-     * /internal.php/foo/bar?query  => returns instance of PageFoo, routed to bar()
-     * /internal.php/foo/baz        => returns instance of Page404, routed to main()
-     * /internal.php/foo/baz?query  => returns instance of Page404, routed to main()
-     * /internal.php/bar            => returns instance of Page404, routed to main()
-     * /internal.php/bar?query      => returns instance of Page404, routed to main()
-     * /internal.php/bar/baz        => returns instance of Page404, routed to main()
-     * /internal.php/bar/baz?query  => returns instance of Page404, routed to main()
-     *
-     * Take care when changing this - a lot of places rely on the array key for redirects and other links. If you need
-     * to change the key, then you'll likely have to update a lot of files.
-     *
-     * @var array
-     */
-    private $routeMap = array(
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Login and registration
-        'logout'                      =>
-            array(
-                'class'   => PageLogout::class,
-                'actions' => array(),
-            ),
-        'login'                       =>
-            array(
-                'class'   => PageLogin::class,
-                'actions' => array(),
-            ),
-        'forgotPassword'              =>
-            array(
-                'class'   => PageForgotPassword::class,
-                'actions' => array('reset'),
-            ),
-        'register'                    =>
-            array(
-                'class'   => PageRegisterOption::class,
-                'actions' => array(),
-            ),
-        'register/standard'           =>
-            array(
-                'class'   => PageRegisterStandard::class,
-                'actions' => array('done'),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Discovery
-        'search'                      =>
-            array(
-                'class'   => PageSearch::class,
-                'actions' => array(),
-            ),
-        'logs'                        =>
-            array(
-                'class'   => PageLog::class,
-                'actions' => array(),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Administration
-        'bans'                        =>
-            array(
-                'class'   => PageBan::class,
-                'actions' => array('set', 'remove'),
-            ),
-        'userManagement'              =>
-            array(
-                'class'   => PageUserManagement::class,
-                'actions' => array(
-                    'approve',
-                    'decline',
-                    'rename',
-                    'editUser',
-                    'suspend',
-                    'editRoles',
-                ),
-            ),
-        'siteNotice'                  =>
-            array(
-                'class'   => PageSiteNotice::class,
-                'actions' => array(),
-            ),
-        'emailManagement'             =>
-            array(
-                'class'   => PageEmailManagement::class,
-                'actions' => array('create', 'edit', 'view'),
-            ),
-        'jobQueue'                    =>
-            array(
-                'class'   => PageJobQueue::class,
-                'actions' => array('acknowledge', 'requeue', 'view', 'all'),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Personal preferences
-        'preferences'                 =>
-            array(
-                'class'   => PagePreferences::class,
-                'actions' => array(),
-            ),
-        'changePassword'              =>
-            array(
-                'class'   => PageChangePassword::class,
-                'actions' => array(),
-            ),
-        'oauth'                       =>
-            array(
-                'class'   => PageOAuth::class,
-                'actions' => array('detach', 'attach'),
-            ),
-        'oauth/callback'              =>
-            array(
-                'class' => PageOAuthCallback::class,
-                'actions' => array('authorise', 'create'),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Welcomer configuration
-        'welcomeTemplates'            =>
-            array(
-                'class'   => PageWelcomeTemplateManagement::class,
-                'actions' => array('select', 'edit', 'delete', 'add', 'view'),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Statistics
-        'statistics'                  =>
-            array(
-                'class'   => StatsMain::class,
-                'actions' => array(),
-            ),
-        'statistics/fastCloses'       =>
-            array(
-                'class'   => StatsFastCloses::class,
-                'actions' => array(),
-            ),
-        'statistics/inactiveUsers'    =>
-            array(
-                'class'   => StatsInactiveUsers::class,
-                'actions' => array(),
-            ),
-        'statistics/monthlyStats'     =>
-            array(
-                'class'   => StatsMonthlyStats::class,
-                'actions' => array(),
-            ),
-        'statistics/reservedRequests' =>
-            array(
-                'class'   => StatsReservedRequests::class,
-                'actions' => array(),
-            ),
-        'statistics/templateStats'    =>
-            array(
-                'class'   => StatsTemplateStats::class,
-                'actions' => array(),
-            ),
-        'statistics/topCreators'      =>
-            array(
-                'class'   => StatsTopCreators::class,
-                'actions' => array(),
-            ),
-        'statistics/users'            =>
-            array(
-                'class'   => StatsUsers::class,
-                'actions' => array('detail'),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Zoom page
-        'viewRequest'                 =>
-            array(
-                'class'   => PageViewRequest::class,
-                'actions' => array(),
-            ),
-        'viewRequest/reserve'         =>
-            array(
-                'class'   => PageReservation::class,
-                'actions' => array(),
-            ),
-        'viewRequest/breakReserve'    =>
-            array(
-                'class'   => PageBreakReservation::class,
-                'actions' => array(),
-            ),
-        'viewRequest/defer'           =>
-            array(
-                'class'   => PageDeferRequest::class,
-                'actions' => array(),
-            ),
-        'viewRequest/comment'         =>
-            array(
-                'class'   => PageComment::class,
-                'actions' => array(),
-            ),
-        'viewRequest/sendToUser'      =>
-            array(
-                'class'   => PageSendToUser::class,
-                'actions' => array(),
-            ),
-        'viewRequest/close'           =>
-            array(
-                'class'   => PageCloseRequest::class,
-                'actions' => array(),
-            ),
-        'viewRequest/create'           =>
-            array(
-                'class'   => PageCreateRequest::class,
-                'actions' => array(),
-            ),
-        'viewRequest/drop'            =>
-            array(
-                'class'   => PageDropRequest::class,
-                'actions' => array(),
-            ),
-        'viewRequest/custom'          =>
-            array(
-                'class'   => PageCustomClose::class,
-                'actions' => array(),
-            ),
-        'editComment'                 =>
-            array(
-                'class'   => PageEditComment::class,
-                'actions' => array(),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Misc stuff
-        'team'                        =>
-            array(
-                'class'   => PageTeam::class,
-                'actions' => array(),
-            ),
-        'requestList'                 =>
-            array(
-                'class'   => PageExpandedRequestList::class,
-                'actions' => array(),
-            ),
-    );
-
-    /**
-     * @return IRoutedTask
-     * @throws Exception
-     */
-    final public function route()
-    {
-        $pathInfo = WebRequest::pathInfo();
-
-        list($pageClass, $action) = $this->getRouteFromPath($pathInfo);
-
-        /** @var IRoutedTask $page */
-        $page = new $pageClass();
-
-        // Dynamic creation, so we've got to be careful here. We can't use built-in language type protection, so
-        // let's use our own.
-        if (!($page instanceof IRoutedTask)) {
-            throw new Exception('Expected a page, but this is not a page.');
-        }
-
-        // OK, I'm happy at this point that we know we're running a page, and we know it's probably what we want if it
-        // inherits PageBase and has been created from the routing map.
-        $page->setRoute($action);
-
-        return $page;
-    }
-
-    /**
-     * @param $pathInfo
-     *
-     * @return array
-     */
-    protected function getRouteFromPath($pathInfo)
-    {
-        if (count($pathInfo) === 0) {
-            // No pathInfo, so no page to load. Load the main page.
-            return $this->getDefaultRoute();
-        }
-        elseif (count($pathInfo) === 1) {
-            // Exactly one path info segment, it's got to be a page.
-            $classSegment = $pathInfo[0];
-
-            return $this->routeSinglePathSegment($classSegment);
-        }
-
-        // OK, we have two or more segments now.
-        if (count($pathInfo) > 2) {
-            // Let's handle more than two, and collapse it down into two.
-            $requestedAction = array_pop($pathInfo);
-            $classSegment = implode('/', $pathInfo);
-        }
-        else {
-            // Two path info segments.
-            $classSegment = $pathInfo[0];
-            $requestedAction = $pathInfo[1];
-        }
-
-        $routeMap = $this->routePathSegments($classSegment, $requestedAction);
-
-        if ($routeMap[0] === Page404::class) {
-            $routeMap = $this->routeSinglePathSegment($classSegment . '/' . $requestedAction);
-        }
-
-        return $routeMap;
-    }
-
-    /**
-     * @param $classSegment
-     *
-     * @return array
-     */
-    final protected function routeSinglePathSegment($classSegment)
-    {
-        $routeMap = $this->getRouteMap();
-        if (array_key_exists($classSegment, $routeMap)) {
-            // Route exists, but we don't have an action in path info, so default to main.
-            $pageClass = $routeMap[$classSegment]['class'];
-            $action = 'main';
-
-            return array($pageClass, $action);
-        }
-        else {
-            // Doesn't exist in map. Fall back to 404
-            $pageClass = Page404::class;
-            $action = "main";
-
-            return array($pageClass, $action);
-        }
-    }
-
-    /**
-     * @param $classSegment
-     * @param $requestedAction
-     *
-     * @return array
-     */
-    final protected function routePathSegments($classSegment, $requestedAction)
-    {
-        $routeMap = $this->getRouteMap();
-        if (array_key_exists($classSegment, $routeMap)) {
-            // Route exists, but we don't have an action in path info, so default to main.
-
-            if (isset($routeMap[$classSegment]['actions'])
-                && array_search($requestedAction, $routeMap[$classSegment]['actions']) !== false
-            ) {
-                // Action exists in allowed action list. Allow both the page and the action
-                $pageClass = $routeMap[$classSegment]['class'];
-                $action = $requestedAction;
-
-                return array($pageClass, $action);
-            }
-            else {
-                // Valid page, invalid action. 404 our way out.
-                $pageClass = Page404::class;
-                $action = 'main';
-
-                return array($pageClass, $action);
-            }
-        }
-        else {
-            // Class doesn't exist in map. Fall back to 404
-            $pageClass = Page404::class;
-            $action = 'main';
-
-            return array($pageClass, $action);
-        }
-    }
-
-    /**
-     * @return array
-     */
-    protected function getRouteMap()
-    {
-        return $this->routeMap;
-    }
-
-    /**
-     * @return callable
-     */
-    protected function getDefaultRoute()
-    {
-        return array(PageMain::class, "main");
-    }
+	/**
+	 * This is the core routing table for the application. The basic idea is:
+	 *
+	 *      array(
+	 *          "foo" =>
+	 *              array(
+	 *                  "class"   => PageFoo::class,
+	 *                  "actions" => array("bar", "other")
+	 *              ),
+	 * );
+	 *
+	 * Things to note:
+	 *     - If no page is requested, we go to PageMain. PageMain can't have actions defined.
+	 *
+	 *     - If a page is defined and requested, but no action is requested, go to that page's main() method
+	 *     - If a page is defined and requested, and an action is defined and requested, go to that action's method.
+	 *     - If a page is defined and requested, and an action NOT defined and requested, go to Page404 and it's main()
+	 *       method.
+	 *     - If a page is NOT defined and requested, go to Page404 and it's main() method.
+	 *
+	 *     - Query parameters are ignored.
+	 *
+	 * The key point here is request routing with validation that this is allowed, before we start hitting the
+	 * filesystem through the AutoLoader, and opening random files. Also, so that we validate the action requested
+	 * before we start calling random methods through the web UI.
+	 *
+	 * Examples:
+	 * /internal.php                => returns instance of PageMain, routed to main()
+	 * /internal.php?query          => returns instance of PageMain, routed to main()
+	 * /internal.php/foo            => returns instance of PageFoo, routed to main()
+	 * /internal.php/foo?query      => returns instance of PageFoo, routed to main()
+	 * /internal.php/foo/bar        => returns instance of PageFoo, routed to bar()
+	 * /internal.php/foo/bar?query  => returns instance of PageFoo, routed to bar()
+	 * /internal.php/foo/baz        => returns instance of Page404, routed to main()
+	 * /internal.php/foo/baz?query  => returns instance of Page404, routed to main()
+	 * /internal.php/bar            => returns instance of Page404, routed to main()
+	 * /internal.php/bar?query      => returns instance of Page404, routed to main()
+	 * /internal.php/bar/baz        => returns instance of Page404, routed to main()
+	 * /internal.php/bar/baz?query  => returns instance of Page404, routed to main()
+	 *
+	 * Take care when changing this - a lot of places rely on the array key for redirects and other links. If you need
+	 * to change the key, then you'll likely have to update a lot of files.
+	 *
+	 * @var array
+	 */
+	private $routeMap = array(
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Login and registration
+		'logout'                      =>
+			array(
+				'class'   => PageLogout::class,
+				'actions' => array(),
+			),
+		'login'                       =>
+			array(
+				'class'   => PageLogin::class,
+				'actions' => array(),
+			),
+		'forgotPassword'              =>
+			array(
+				'class'   => PageForgotPassword::class,
+				'actions' => array('reset'),
+			),
+		'register'                    =>
+			array(
+				'class'   => PageRegisterOption::class,
+				'actions' => array(),
+			),
+		'register/standard'           =>
+			array(
+				'class'   => PageRegisterStandard::class,
+				'actions' => array('done'),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Discovery
+		'search'                      =>
+			array(
+				'class'   => PageSearch::class,
+				'actions' => array(),
+			),
+		'logs'                        =>
+			array(
+				'class'   => PageLog::class,
+				'actions' => array(),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Administration
+		'bans'                        =>
+			array(
+				'class'   => PageBan::class,
+				'actions' => array('set', 'remove'),
+			),
+		'userManagement'              =>
+			array(
+				'class'   => PageUserManagement::class,
+				'actions' => array(
+					'approve',
+					'decline',
+					'rename',
+					'editUser',
+					'suspend',
+					'editRoles',
+				),
+			),
+		'siteNotice'                  =>
+			array(
+				'class'   => PageSiteNotice::class,
+				'actions' => array(),
+			),
+		'emailManagement'             =>
+			array(
+				'class'   => PageEmailManagement::class,
+				'actions' => array('create', 'edit', 'view'),
+			),
+		'jobQueue'                    =>
+			array(
+				'class'   => PageJobQueue::class,
+				'actions' => array('acknowledge', 'requeue', 'view', 'all'),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Personal preferences
+		'preferences'                 =>
+			array(
+				'class'   => PagePreferences::class,
+				'actions' => array(),
+			),
+		'changePassword'              =>
+			array(
+				'class'   => PageChangePassword::class,
+				'actions' => array(),
+			),
+		'oauth'                       =>
+			array(
+				'class'   => PageOAuth::class,
+				'actions' => array('detach', 'attach'),
+			),
+		'oauth/callback'              =>
+			array(
+				'class' => PageOAuthCallback::class,
+				'actions' => array('authorise', 'create'),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Welcomer configuration
+		'welcomeTemplates'            =>
+			array(
+				'class'   => PageWelcomeTemplateManagement::class,
+				'actions' => array('select', 'edit', 'delete', 'add', 'view'),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Statistics
+		'statistics'                  =>
+			array(
+				'class'   => StatsMain::class,
+				'actions' => array(),
+			),
+		'statistics/fastCloses'       =>
+			array(
+				'class'   => StatsFastCloses::class,
+				'actions' => array(),
+			),
+		'statistics/inactiveUsers'    =>
+			array(
+				'class'   => StatsInactiveUsers::class,
+				'actions' => array(),
+			),
+		'statistics/monthlyStats'     =>
+			array(
+				'class'   => StatsMonthlyStats::class,
+				'actions' => array(),
+			),
+		'statistics/reservedRequests' =>
+			array(
+				'class'   => StatsReservedRequests::class,
+				'actions' => array(),
+			),
+		'statistics/templateStats'    =>
+			array(
+				'class'   => StatsTemplateStats::class,
+				'actions' => array(),
+			),
+		'statistics/topCreators'      =>
+			array(
+				'class'   => StatsTopCreators::class,
+				'actions' => array(),
+			),
+		'statistics/users'            =>
+			array(
+				'class'   => StatsUsers::class,
+				'actions' => array('detail'),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Zoom page
+		'viewRequest'                 =>
+			array(
+				'class'   => PageViewRequest::class,
+				'actions' => array(),
+			),
+		'viewRequest/reserve'         =>
+			array(
+				'class'   => PageReservation::class,
+				'actions' => array(),
+			),
+		'viewRequest/breakReserve'    =>
+			array(
+				'class'   => PageBreakReservation::class,
+				'actions' => array(),
+			),
+		'viewRequest/defer'           =>
+			array(
+				'class'   => PageDeferRequest::class,
+				'actions' => array(),
+			),
+		'viewRequest/comment'         =>
+			array(
+				'class'   => PageComment::class,
+				'actions' => array(),
+			),
+		'viewRequest/sendToUser'      =>
+			array(
+				'class'   => PageSendToUser::class,
+				'actions' => array(),
+			),
+		'viewRequest/close'           =>
+			array(
+				'class'   => PageCloseRequest::class,
+				'actions' => array(),
+			),
+		'viewRequest/create'           =>
+			array(
+				'class'   => PageCreateRequest::class,
+				'actions' => array(),
+			),
+		'viewRequest/drop'            =>
+			array(
+				'class'   => PageDropRequest::class,
+				'actions' => array(),
+			),
+		'viewRequest/custom'          =>
+			array(
+				'class'   => PageCustomClose::class,
+				'actions' => array(),
+			),
+		'editComment'                 =>
+			array(
+				'class'   => PageEditComment::class,
+				'actions' => array(),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Misc stuff
+		'team'                        =>
+			array(
+				'class'   => PageTeam::class,
+				'actions' => array(),
+			),
+		'requestList'                 =>
+			array(
+				'class'   => PageExpandedRequestList::class,
+				'actions' => array(),
+			),
+	);
+
+	/**
+	 * @return IRoutedTask
+	 * @throws Exception
+	 */
+	final public function route()
+	{
+		$pathInfo = WebRequest::pathInfo();
+
+		list($pageClass, $action) = $this->getRouteFromPath($pathInfo);
+
+		/** @var IRoutedTask $page */
+		$page = new $pageClass();
+
+		// Dynamic creation, so we've got to be careful here. We can't use built-in language type protection, so
+		// let's use our own.
+		if (!($page instanceof IRoutedTask)) {
+			throw new Exception('Expected a page, but this is not a page.');
+		}
+
+		// OK, I'm happy at this point that we know we're running a page, and we know it's probably what we want if it
+		// inherits PageBase and has been created from the routing map.
+		$page->setRoute($action);
+
+		return $page;
+	}
+
+	/**
+	 * @param $pathInfo
+	 *
+	 * @return array
+	 */
+	protected function getRouteFromPath($pathInfo)
+	{
+		if (count($pathInfo) === 0) {
+			// No pathInfo, so no page to load. Load the main page.
+			return $this->getDefaultRoute();
+		}
+		elseif (count($pathInfo) === 1) {
+			// Exactly one path info segment, it's got to be a page.
+			$classSegment = $pathInfo[0];
+
+			return $this->routeSinglePathSegment($classSegment);
+		}
+
+		// OK, we have two or more segments now.
+		if (count($pathInfo) > 2) {
+			// Let's handle more than two, and collapse it down into two.
+			$requestedAction = array_pop($pathInfo);
+			$classSegment = implode('/', $pathInfo);
+		}
+		else {
+			// Two path info segments.
+			$classSegment = $pathInfo[0];
+			$requestedAction = $pathInfo[1];
+		}
+
+		$routeMap = $this->routePathSegments($classSegment, $requestedAction);
+
+		if ($routeMap[0] === Page404::class) {
+			$routeMap = $this->routeSinglePathSegment($classSegment . '/' . $requestedAction);
+		}
+
+		return $routeMap;
+	}
+
+	/**
+	 * @param $classSegment
+	 *
+	 * @return array
+	 */
+	final protected function routeSinglePathSegment($classSegment)
+	{
+		$routeMap = $this->getRouteMap();
+		if (array_key_exists($classSegment, $routeMap)) {
+			// Route exists, but we don't have an action in path info, so default to main.
+			$pageClass = $routeMap[$classSegment]['class'];
+			$action = 'main';
+
+			return array($pageClass, $action);
+		}
+		else {
+			// Doesn't exist in map. Fall back to 404
+			$pageClass = Page404::class;
+			$action = "main";
+
+			return array($pageClass, $action);
+		}
+	}
+
+	/**
+	 * @param $classSegment
+	 * @param $requestedAction
+	 *
+	 * @return array
+	 */
+	final protected function routePathSegments($classSegment, $requestedAction)
+	{
+		$routeMap = $this->getRouteMap();
+		if (array_key_exists($classSegment, $routeMap)) {
+			// Route exists, but we don't have an action in path info, so default to main.
+
+			if (isset($routeMap[$classSegment]['actions'])
+				&& array_search($requestedAction, $routeMap[$classSegment]['actions']) !== false
+			) {
+				// Action exists in allowed action list. Allow both the page and the action
+				$pageClass = $routeMap[$classSegment]['class'];
+				$action = $requestedAction;
+
+				return array($pageClass, $action);
+			}
+			else {
+				// Valid page, invalid action. 404 our way out.
+				$pageClass = Page404::class;
+				$action = 'main';
+
+				return array($pageClass, $action);
+			}
+		}
+		else {
+			// Class doesn't exist in map. Fall back to 404
+			$pageClass = Page404::class;
+			$action = 'main';
+
+			return array($pageClass, $action);
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function getRouteMap()
+	{
+		return $this->routeMap;
+	}
+
+	/**
+	 * @return callable
+	 */
+	protected function getDefaultRoute()
+	{
+		return array(PageMain::class, "main");
+	}
 }

includes/Security/AuthenticationManager.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 use Waca\PdoDatabase;
 use Waca\Security\CredentialProviders\ICredentialProvider;
 use Waca\Security\CredentialProviders\PasswordCredentialProvider;
-use Waca\Security\CredentialProviders\YubikeyCredentialProvider;
 use Waca\SiteConfiguration;
 
 class AuthenticationManager

Indentation +51 added lines, -51 removed lines

@@ -19,62 +19,62 @@
 
 class AuthenticationManager
 {
-    const AUTH_OK = 1;
-    const AUTH_FAIL = 2;
-    const AUTH_REQUIRE_NEXT_STAGE = 3;
-    private $typeMap = array();
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
+	const AUTH_OK = 1;
+	const AUTH_FAIL = 2;
+	const AUTH_REQUIRE_NEXT_STAGE = 3;
+	private $typeMap = array();
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
 
-    /**
-     * AuthenticationManager constructor.
-     *
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $siteConfiguration
-     * @param HttpHelper        $httpHelper
-     */
-    public function __construct(PdoDatabase $database, SiteConfiguration $siteConfiguration, HttpHelper $httpHelper)
-    {
-        // setup providers
-        $this->typeMap['password'] = new PasswordCredentialProvider($database, $siteConfiguration);
-        $this->database = $database;
-    }
+	/**
+	 * AuthenticationManager constructor.
+	 *
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param HttpHelper        $httpHelper
+	 */
+	public function __construct(PdoDatabase $database, SiteConfiguration $siteConfiguration, HttpHelper $httpHelper)
+	{
+		// setup providers
+		$this->typeMap['password'] = new PasswordCredentialProvider($database, $siteConfiguration);
+		$this->database = $database;
+	}
 
-    public function authenticate(User $user, $data, $stage)
-    {
-        $sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage';
-        $statement = $this->database->prepare($sql);
-        $statement->execute(array(':user' => $user->getId(), ':stage' => $stage));
-        $options = $statement->fetchAll(PDO::FETCH_COLUMN);
+	public function authenticate(User $user, $data, $stage)
+	{
+		$sql = 'SELECT type FROM credential WHERE user = :user AND factor = :stage';
+		$statement = $this->database->prepare($sql);
+		$statement->execute(array(':user' => $user->getId(), ':stage' => $stage));
+		$options = $statement->fetchAll(PDO::FETCH_COLUMN);
 
-        $sql = 'SELECT count(DISTINCT factor) FROM credential WHERE user = :user AND factor > :stage';
-        $statement = $this->database->prepare($sql);
-        $statement->execute(array(':user' => $user->getId(), ':stage' => $stage));
-        $requiredFactors = $statement->fetchColumn();
+		$sql = 'SELECT count(DISTINCT factor) FROM credential WHERE user = :user AND factor > :stage';
+		$statement = $this->database->prepare($sql);
+		$statement->execute(array(':user' => $user->getId(), ':stage' => $stage));
+		$requiredFactors = $statement->fetchColumn();
 
-        // prep the correct OK response based on how many factors are ahead of this one
-        $success = self::AUTH_OK;
-        if ($requiredFactors > 0) {
-            $success = self::AUTH_REQUIRE_NEXT_STAGE;
-        }
+		// prep the correct OK response based on how many factors are ahead of this one
+		$success = self::AUTH_OK;
+		if ($requiredFactors > 0) {
+			$success = self::AUTH_REQUIRE_NEXT_STAGE;
+		}
 
-        foreach ($options as $type) {
-            if (!isset($this->typeMap[$type])) {
-                // does this type have a credentialProvider registered?
-                continue;
-            }
+		foreach ($options as $type) {
+			if (!isset($this->typeMap[$type])) {
+				// does this type have a credentialProvider registered?
+				continue;
+			}
 
-            /** @var ICredentialProvider $credentialProvider */
-            $credentialProvider = $this->typeMap[$type];
-            if ($credentialProvider->authenticate($user, $data)) {
-                return $success;
-            }
-        }
+			/** @var ICredentialProvider $credentialProvider */
+			$credentialProvider = $this->typeMap[$type];
+			if ($credentialProvider->authenticate($user, $data)) {
+				return $success;
+			}
+		}
 
-        // We've iterated over all the available providers for this stage.
-        // They all hate you.
-        return self::AUTH_FAIL;
-    }
+		// We've iterated over all the available providers for this stage.
+		// They all hate you.
+		return self::AUTH_FAIL;
+	}
 }
\ No newline at end of file

includes/Security/RoleConfiguration.php

Unused Use Statements +4 added lines, -4 removed lines

@@ -16,10 +16,6 @@ 
 use Waca\Pages\PageJobQueue;
 use Waca\Pages\PageLog;
 use Waca\Pages\PageMain;
-use Waca\Pages\RequestAction\PageCreateRequest;
-use Waca\Pages\UserAuth\PageChangePassword;
-use Waca\Pages\UserAuth\PageOAuth;
-use Waca\Pages\UserAuth\PagePreferences;
 use Waca\Pages\PageSearch;
 use Waca\Pages\PageSiteNotice;
 use Waca\Pages\PageTeam;
@@ -29,6 +25,7 @@ 
 use Waca\Pages\RequestAction\PageBreakReservation;
 use Waca\Pages\RequestAction\PageCloseRequest;
 use Waca\Pages\RequestAction\PageComment;
+use Waca\Pages\RequestAction\PageCreateRequest;
 use Waca\Pages\RequestAction\PageCustomClose;
 use Waca\Pages\RequestAction\PageDeferRequest;
 use Waca\Pages\RequestAction\PageDropRequest;
@@ -42,6 +39,9 @@ 
 use Waca\Pages\Statistics\StatsTemplateStats;
 use Waca\Pages\Statistics\StatsTopCreators;
 use Waca\Pages\Statistics\StatsUsers;
+use Waca\Pages\UserAuth\PageChangePassword;
+use Waca\Pages\UserAuth\PageOAuth;
+use Waca\Pages\UserAuth\PagePreferences;
 
 class RoleConfiguration
 {

Indentation +334 added lines, -334 removed lines

@@ -45,364 +45,364 @@
 
 class RoleConfiguration
 {
-    const ACCESS_ALLOW = 1;
-    const ACCESS_DENY = -1;
-    const ACCESS_DEFAULT = 0;
-    const MAIN = 'main';
-    const ALL = '*';
-    /**
-     * A map of roles to rights
-     *
-     * For example:
-     *
-     * array(
-     *   'myrole' => array(
-     *       PageMyPage::class => array(
-     *           'edit' => self::ACCESS_ALLOW,
-     *           'create' => self::ACCESS_DENY,
-     *       )
-     *   )
-     * )
-     *
-     * Note that DENY takes precedence over everything else when roles are combined, followed by ALLOW, followed by
-     * DEFAULT. Thus, if you have the following ([A]llow, [D]eny, [-] (default)) grants in different roles, this should
-     * be the expected result:
-     *
-     * - (-,-,-) = - (default because nothing to explicitly say allowed or denied equates to a denial)
-     * - (A,-,-) = A
-     * - (D,-,-) = D
-     * - (A,D,-) = D (deny takes precedence over allow)
-     * - (A,A,A) = A (repetition has no effect)
-     *
-     * The public role is special, and is applied to all users automatically. Avoid using deny on this role.
-     *
-     * @var array
-     */
-    private $roleConfig = array(
-        'public'            => array(
-            /*
+	const ACCESS_ALLOW = 1;
+	const ACCESS_DENY = -1;
+	const ACCESS_DEFAULT = 0;
+	const MAIN = 'main';
+	const ALL = '*';
+	/**
+	 * A map of roles to rights
+	 *
+	 * For example:
+	 *
+	 * array(
+	 *   'myrole' => array(
+	 *       PageMyPage::class => array(
+	 *           'edit' => self::ACCESS_ALLOW,
+	 *           'create' => self::ACCESS_DENY,
+	 *       )
+	 *   )
+	 * )
+	 *
+	 * Note that DENY takes precedence over everything else when roles are combined, followed by ALLOW, followed by
+	 * DEFAULT. Thus, if you have the following ([A]llow, [D]eny, [-] (default)) grants in different roles, this should
+	 * be the expected result:
+	 *
+	 * - (-,-,-) = - (default because nothing to explicitly say allowed or denied equates to a denial)
+	 * - (A,-,-) = A
+	 * - (D,-,-) = D
+	 * - (A,D,-) = D (deny takes precedence over allow)
+	 * - (A,A,A) = A (repetition has no effect)
+	 *
+	 * The public role is special, and is applied to all users automatically. Avoid using deny on this role.
+	 *
+	 * @var array
+	 */
+	private $roleConfig = array(
+		'public'            => array(
+			/*
              * THIS ROLE IS GRANTED TO ALL LOGGED *OUT* USERS IMPLICITLY.
              *
              * USERS IN THIS ROLE DO NOT HAVE TO BE IDENTIFIED TO GET THE RIGHTS CONFERRED HERE.
              * DO NOT ADD ANY SECURITY-SENSITIVE RIGHTS HERE.
              */
-            '_childRoles'   => array(
-                'publicStats',
-            ),
-            PageTeam::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-        ),
-        'loggedIn'          => array(
-            /*
+			'_childRoles'   => array(
+				'publicStats',
+			),
+			PageTeam::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+		),
+		'loggedIn'          => array(
+			/*
              * THIS ROLE IS GRANTED TO ALL LOGGED IN USERS IMPLICITLY.
              *
              * USERS IN THIS ROLE DO NOT HAVE TO BE IDENTIFIED TO GET THE RIGHTS CONFERRED HERE.
              * DO NOT ADD ANY SECURITY-SENSITIVE RIGHTS HERE.
              */
-            '_childRoles'             => array(
-                'public',
-            ),
-            PagePreferences::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageChangePassword::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageOAuth::class          => array(
-                'attach' => self::ACCESS_ALLOW,
-                'detach' => self::ACCESS_ALLOW,
-            ),
-        ),
-        'user'              => array(
-            '_description'                       => 'A standard tool user.',
-            '_editableBy'                        => array('admin', 'toolRoot'),
-            '_childRoles'                        => array(
-                'internalStats',
-            ),
-            PageMain::class                      => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageBan::class                       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageEditComment::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageEmailManagement::class           => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-            ),
-            PageExpandedRequestList::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageLog::class                       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageSearch::class                    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageWelcomeTemplateManagement::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'select'   => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-            ),
-            PageViewRequest::class               => array(
-                self::MAIN       => self::ACCESS_ALLOW,
-                'seeAllRequests' => self::ACCESS_ALLOW,
-            ),
-            'RequestData'                        => array(
-                'seePrivateDataWhenReserved' => self::ACCESS_ALLOW,
-                'seePrivateDataWithHash'     => self::ACCESS_ALLOW,
-            ),
-            PageCustomClose::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageComment::class                   => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageCloseRequest::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageCreateRequest::class             => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageDeferRequest::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageDropRequest::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageReservation::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageSendToUser::class                => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageBreakReservation::class          => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageJobQueue::class                  => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-                'all'      => self::ACCESS_ALLOW,
-            ),
-            'RequestCreation'                    => array(
-                User::CREATION_MANUAL => self::ACCESS_ALLOW,
-                User::CREATION_OAUTH  => self::ACCESS_ALLOW,
-            ),
-        ),
-        'admin'             => array(
-            '_description'                       => 'A tool administrator.',
-            '_editableBy'                        => array('admin', 'toolRoot'),
-            '_childRoles'                        => array(
-                'user',
-                'requestAdminTools',
-            ),
-            PageEmailManagement::class           => array(
-                'edit'   => self::ACCESS_ALLOW,
-                'create' => self::ACCESS_ALLOW,
-            ),
-            PageSiteNotice::class                => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageUserManagement::class            => array(
-                self::MAIN  => self::ACCESS_ALLOW,
-                'approve'   => self::ACCESS_ALLOW,
-                'decline'   => self::ACCESS_ALLOW,
-                'rename'    => self::ACCESS_ALLOW,
-                'editUser'  => self::ACCESS_ALLOW,
-                'suspend'   => self::ACCESS_ALLOW,
-                'editRoles' => self::ACCESS_ALLOW,
-            ),
-            PageWelcomeTemplateManagement::class => array(
-                'edit'   => self::ACCESS_ALLOW,
-                'delete' => self::ACCESS_ALLOW,
-                'add'    => self::ACCESS_ALLOW,
-            ),
-            PageJobQueue::class                  => array(
-                'acknowledge' => self::ACCESS_ALLOW,
-                'requeue'     => self::ACCESS_ALLOW,
-            ),
-        ),
-        'checkuser'         => array(
-            '_description'            => 'A user with CheckUser access',
-            '_editableBy'             => array('checkuser', 'toolRoot'),
-            '_childRoles'             => array(
-                'user',
-                'requestAdminTools',
-            ),
-            PageUserManagement::class => array(
-                self::MAIN  => self::ACCESS_ALLOW,
-                'suspend'   => self::ACCESS_ALLOW,
-                'editRoles' => self::ACCESS_ALLOW,
-            ),
-            'RequestData'             => array(
-                'seeUserAgentData' => self::ACCESS_ALLOW,
-            ),
-        ),
-        'toolRoot'          => array(
-            '_description' => 'A user with shell access to the servers running the tool',
-            '_editableBy'  => array('toolRoot'),
-            '_childRoles'  => array(
-                'admin',
-                'checkuser',
-            ),
-        ),
-        'botCreation'       => array(
-            '_description'    => 'A user allowed to use the bot to perform account creations',
-            '_editableBy'     => array('admin', 'toolRoot'),
-            '_childRoles'     => array(),
-            'RequestCreation' => array(
-                User::CREATION_BOT => self::ACCESS_ALLOW,
-            ),
-        ),
+			'_childRoles'             => array(
+				'public',
+			),
+			PagePreferences::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageChangePassword::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageOAuth::class          => array(
+				'attach' => self::ACCESS_ALLOW,
+				'detach' => self::ACCESS_ALLOW,
+			),
+		),
+		'user'              => array(
+			'_description'                       => 'A standard tool user.',
+			'_editableBy'                        => array('admin', 'toolRoot'),
+			'_childRoles'                        => array(
+				'internalStats',
+			),
+			PageMain::class                      => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageBan::class                       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageEditComment::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageEmailManagement::class           => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+			),
+			PageExpandedRequestList::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageLog::class                       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageSearch::class                    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageWelcomeTemplateManagement::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'select'   => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+			),
+			PageViewRequest::class               => array(
+				self::MAIN       => self::ACCESS_ALLOW,
+				'seeAllRequests' => self::ACCESS_ALLOW,
+			),
+			'RequestData'                        => array(
+				'seePrivateDataWhenReserved' => self::ACCESS_ALLOW,
+				'seePrivateDataWithHash'     => self::ACCESS_ALLOW,
+			),
+			PageCustomClose::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageComment::class                   => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageCloseRequest::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageCreateRequest::class             => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageDeferRequest::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageDropRequest::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageReservation::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageSendToUser::class                => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageBreakReservation::class          => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageJobQueue::class                  => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+				'all'      => self::ACCESS_ALLOW,
+			),
+			'RequestCreation'                    => array(
+				User::CREATION_MANUAL => self::ACCESS_ALLOW,
+				User::CREATION_OAUTH  => self::ACCESS_ALLOW,
+			),
+		),
+		'admin'             => array(
+			'_description'                       => 'A tool administrator.',
+			'_editableBy'                        => array('admin', 'toolRoot'),
+			'_childRoles'                        => array(
+				'user',
+				'requestAdminTools',
+			),
+			PageEmailManagement::class           => array(
+				'edit'   => self::ACCESS_ALLOW,
+				'create' => self::ACCESS_ALLOW,
+			),
+			PageSiteNotice::class                => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageUserManagement::class            => array(
+				self::MAIN  => self::ACCESS_ALLOW,
+				'approve'   => self::ACCESS_ALLOW,
+				'decline'   => self::ACCESS_ALLOW,
+				'rename'    => self::ACCESS_ALLOW,
+				'editUser'  => self::ACCESS_ALLOW,
+				'suspend'   => self::ACCESS_ALLOW,
+				'editRoles' => self::ACCESS_ALLOW,
+			),
+			PageWelcomeTemplateManagement::class => array(
+				'edit'   => self::ACCESS_ALLOW,
+				'delete' => self::ACCESS_ALLOW,
+				'add'    => self::ACCESS_ALLOW,
+			),
+			PageJobQueue::class                  => array(
+				'acknowledge' => self::ACCESS_ALLOW,
+				'requeue'     => self::ACCESS_ALLOW,
+			),
+		),
+		'checkuser'         => array(
+			'_description'            => 'A user with CheckUser access',
+			'_editableBy'             => array('checkuser', 'toolRoot'),
+			'_childRoles'             => array(
+				'user',
+				'requestAdminTools',
+			),
+			PageUserManagement::class => array(
+				self::MAIN  => self::ACCESS_ALLOW,
+				'suspend'   => self::ACCESS_ALLOW,
+				'editRoles' => self::ACCESS_ALLOW,
+			),
+			'RequestData'             => array(
+				'seeUserAgentData' => self::ACCESS_ALLOW,
+			),
+		),
+		'toolRoot'          => array(
+			'_description' => 'A user with shell access to the servers running the tool',
+			'_editableBy'  => array('toolRoot'),
+			'_childRoles'  => array(
+				'admin',
+				'checkuser',
+			),
+		),
+		'botCreation'       => array(
+			'_description'    => 'A user allowed to use the bot to perform account creations',
+			'_editableBy'     => array('admin', 'toolRoot'),
+			'_childRoles'     => array(),
+			'RequestCreation' => array(
+				User::CREATION_BOT => self::ACCESS_ALLOW,
+			),
+		),
 
-        // Child roles go below this point
-        'publicStats'       => array(
-            '_hidden'               => true,
-            StatsUsers::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'detail'   => self::ACCESS_ALLOW,
-            ),
-            StatsTopCreators::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-        ),
-        'internalStats'     => array(
-            '_hidden'                    => true,
-            StatsMain::class             => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsFastCloses::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsInactiveUsers::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsMonthlyStats::class     => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsReservedRequests::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsTemplateStats::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-        ),
-        'requestAdminTools' => array(
-            '_hidden'                   => true,
-            PageBan::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'set'      => self::ACCESS_ALLOW,
-                'remove'   => self::ACCESS_ALLOW,
-            ),
-            PageEditComment::class      => array(
-                'editOthers' => self::ACCESS_ALLOW,
-            ),
-            PageBreakReservation::class => array(
-                'force' => self::ACCESS_ALLOW,
-            ),
-            PageCustomClose::class      => array(
-                'skipCcMailingList' => self::ACCESS_ALLOW,
-            ),
-            'RequestData'               => array(
-                'reopenOldRequest'      => self::ACCESS_ALLOW,
-                'alwaysSeePrivateData'  => self::ACCESS_ALLOW,
-                'alwaysSeeHash'         => self::ACCESS_ALLOW,
-                'seeRestrictedComments' => self::ACCESS_ALLOW,
-            ),
-        ),
-    );
-    /** @var array
-     * List of roles which are *exempt* from the identification requirements
-     *
-     * Think twice about adding roles to this list.
-     *
-     * @category Security-Critical
-     */
-    private $identificationExempt = array('public', 'loggedIn');
+		// Child roles go below this point
+		'publicStats'       => array(
+			'_hidden'               => true,
+			StatsUsers::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'detail'   => self::ACCESS_ALLOW,
+			),
+			StatsTopCreators::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+		),
+		'internalStats'     => array(
+			'_hidden'                    => true,
+			StatsMain::class             => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsFastCloses::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsInactiveUsers::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsMonthlyStats::class     => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsReservedRequests::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsTemplateStats::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+		),
+		'requestAdminTools' => array(
+			'_hidden'                   => true,
+			PageBan::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'set'      => self::ACCESS_ALLOW,
+				'remove'   => self::ACCESS_ALLOW,
+			),
+			PageEditComment::class      => array(
+				'editOthers' => self::ACCESS_ALLOW,
+			),
+			PageBreakReservation::class => array(
+				'force' => self::ACCESS_ALLOW,
+			),
+			PageCustomClose::class      => array(
+				'skipCcMailingList' => self::ACCESS_ALLOW,
+			),
+			'RequestData'               => array(
+				'reopenOldRequest'      => self::ACCESS_ALLOW,
+				'alwaysSeePrivateData'  => self::ACCESS_ALLOW,
+				'alwaysSeeHash'         => self::ACCESS_ALLOW,
+				'seeRestrictedComments' => self::ACCESS_ALLOW,
+			),
+		),
+	);
+	/** @var array
+	 * List of roles which are *exempt* from the identification requirements
+	 *
+	 * Think twice about adding roles to this list.
+	 *
+	 * @category Security-Critical
+	 */
+	private $identificationExempt = array('public', 'loggedIn');
 
-    /**
-     * RoleConfiguration constructor.
-     *
-     * @param array $roleConfig           Set to non-null to override the default configuration.
-     * @param array $identificationExempt Set to non-null to override the default configuration.
-     */
-    public function __construct(array $roleConfig = null, array $identificationExempt = null)
-    {
-        if ($roleConfig !== null) {
-            $this->roleConfig = $roleConfig;
-        }
+	/**
+	 * RoleConfiguration constructor.
+	 *
+	 * @param array $roleConfig           Set to non-null to override the default configuration.
+	 * @param array $identificationExempt Set to non-null to override the default configuration.
+	 */
+	public function __construct(array $roleConfig = null, array $identificationExempt = null)
+	{
+		if ($roleConfig !== null) {
+			$this->roleConfig = $roleConfig;
+		}
 
-        if ($identificationExempt !== null) {
-            $this->identificationExempt = $identificationExempt;
-        }
-    }
+		if ($identificationExempt !== null) {
+			$this->identificationExempt = $identificationExempt;
+		}
+	}
 
-    /**
-     * @param array $roles The roles to check
-     *
-     * @return array
-     */
-    public function getApplicableRoles(array $roles)
-    {
-        $available = array();
+	/**
+	 * @param array $roles The roles to check
+	 *
+	 * @return array
+	 */
+	public function getApplicableRoles(array $roles)
+	{
+		$available = array();
 
-        foreach ($roles as $role) {
-            if (!isset($this->roleConfig[$role])) {
-                // wat
-                continue;
-            }
+		foreach ($roles as $role) {
+			if (!isset($this->roleConfig[$role])) {
+				// wat
+				continue;
+			}
 
-            $available[$role] = $this->roleConfig[$role];
+			$available[$role] = $this->roleConfig[$role];
 
-            if (isset($available[$role]['_childRoles'])) {
-                $childRoles = self::getApplicableRoles($available[$role]['_childRoles']);
-                $available = array_merge($available, $childRoles);
+			if (isset($available[$role]['_childRoles'])) {
+				$childRoles = self::getApplicableRoles($available[$role]['_childRoles']);
+				$available = array_merge($available, $childRoles);
 
-                unset($available[$role]['_childRoles']);
-            }
+				unset($available[$role]['_childRoles']);
+			}
 
-            foreach (array('_hidden', '_editableBy', '_description') as $item) {
-                if (isset($available[$role][$item])) {
-                    unset($available[$role][$item]);
-                }
-            }
-        }
+			foreach (array('_hidden', '_editableBy', '_description') as $item) {
+				if (isset($available[$role][$item])) {
+					unset($available[$role][$item]);
+				}
+			}
+		}
 
-        return $available;
-    }
+		return $available;
+	}
 
-    public function getAvailableRoles()
-    {
-        $possible = array_diff(array_keys($this->roleConfig), array('public', 'loggedIn'));
+	public function getAvailableRoles()
+	{
+		$possible = array_diff(array_keys($this->roleConfig), array('public', 'loggedIn'));
 
-        $actual = array();
+		$actual = array();
 
-        foreach ($possible as $role) {
-            if (!isset($this->roleConfig[$role]['_hidden'])) {
-                $actual[$role] = array(
-                    'description' => $this->roleConfig[$role]['_description'],
-                    'editableBy'  => $this->roleConfig[$role]['_editableBy'],
-                );
-            }
-        }
+		foreach ($possible as $role) {
+			if (!isset($this->roleConfig[$role]['_hidden'])) {
+				$actual[$role] = array(
+					'description' => $this->roleConfig[$role]['_description'],
+					'editableBy'  => $this->roleConfig[$role]['_editableBy'],
+				);
+			}
+		}
 
-        return $actual;
-    }
+		return $actual;
+	}
 
-    /**
-     * @param string $role
-     *
-     * @return bool
-     */
-    public function roleNeedsIdentification($role)
-    {
-        if (in_array($role, $this->identificationExempt)) {
-            return false;
-        }
+	/**
+	 * @param string $role
+	 *
+	 * @return bool
+	 */
+	public function roleNeedsIdentification($role)
+	{
+		if (in_array($role, $this->identificationExempt)) {
+			return false;
+		}
 
-        return true;
-    }
+		return true;
+	}
 }

includes/AuthUtility.php

Indentation +83 added lines, -83 removed lines

@@ -10,99 +10,99 @@
 
 class AuthUtility
 {
-    /**
-     * Test the specified data against the specified credentials
-     *
-     * @param string $password
-     * @param string $credentials
-     *
-     * @return bool
-     * @deprecated
-     */
-    public static function testCredentials($password, $credentials)
-    {
-        global $minimumPasswordVersion;
+	/**
+	 * Test the specified data against the specified credentials
+	 *
+	 * @param string $password
+	 * @param string $credentials
+	 *
+	 * @return bool
+	 * @deprecated
+	 */
+	public static function testCredentials($password, $credentials)
+	{
+		global $minimumPasswordVersion;
 
-        if (substr($credentials, 0, 1) != ":") {
-            return false;
-        }
+		if (substr($credentials, 0, 1) != ":") {
+			return false;
+		}
 
-        // determine password version
-        $data = explode(':', substr($credentials, 1));
+		// determine password version
+		$data = explode(':', substr($credentials, 1));
 
-        // call the encryptVersion function for the version that this password actually is.
-        // syntax: :1:SALT:HASH
-        // syntax: :2:x:HASH
+		// call the encryptVersion function for the version that this password actually is.
+		// syntax: :1:SALT:HASH
+		// syntax: :2:x:HASH
 
-        // check the version is one of the allowed ones:
-        if ($minimumPasswordVersion > $data[0]) {
-            return false;
-        }
+		// check the version is one of the allowed ones:
+		if ($minimumPasswordVersion > $data[0]) {
+			return false;
+		}
 
-        if ($data[0] == 1) {
-            return $credentials == self::encryptVersion1($password, $data[1]);
-        }
+		if ($data[0] == 1) {
+			return $credentials == self::encryptVersion1($password, $data[1]);
+		}
 
-        if ($data[0] == 2) {
-            return self::verifyVersion2($password, $data[2]);
-        }
+		if ($data[0] == 2) {
+			return self::verifyVersion2($password, $data[2]);
+		}
 
-        return false;
-    }
+		return false;
+	}
 
-    /**
-     * @param string $credentials
-     *
-     * @return bool
-     * @deprecated
-     */
-    public static function isCredentialVersionLatest($credentials)
-    {
-        return substr($credentials, 0, 3) === ":2:";
-    }
+	/**
+	 * @param string $credentials
+	 *
+	 * @return bool
+	 * @deprecated
+	 */
+	public static function isCredentialVersionLatest($credentials)
+	{
+		return substr($credentials, 0, 3) === ":2:";
+	}
 
-    /**
-     * Encrypts a user's password with the latest version of the hash algorithm
-     *
-     * @param string $password
-     *
-     * @return string
-     * @deprecated
-     */
-    public static function encryptPassword($password)
-    {
-        return self::encryptVersion2($password);
-    }
+	/**
+	 * Encrypts a user's password with the latest version of the hash algorithm
+	 *
+	 * @param string $password
+	 *
+	 * @return string
+	 * @deprecated
+	 */
+	public static function encryptPassword($password)
+	{
+		return self::encryptVersion2($password);
+	}
 
-    /**
-     * @param string $password
-     * @param string $salt
-     *
-     * @return string
-     */
-    private static function encryptVersion1($password, $salt)
-    {
-        return ':1:' . $salt . ':' . md5($salt . '-' . md5($password));
-    }
+	/**
+	 * @param string $password
+	 * @param string $salt
+	 *
+	 * @return string
+	 */
+	private static function encryptVersion1($password, $salt)
+	{
+		return ':1:' . $salt . ':' . md5($salt . '-' . md5($password));
+	}
 
-    /**
-     * @param string $password
-     *
-     * @return string
-     */
-    private static function encryptVersion2($password)
-    {
-        return ':2:x:' . password_hash($password, PASSWORD_BCRYPT);
-    }
+	/**
+	 * @param string $password
+	 *
+	 * @return string
+	 */
+	private static function encryptVersion2($password)
+	{
+		return ':2:x:' . password_hash($password, PASSWORD_BCRYPT);
+	}
 
-    /**
-     * @param string $password
-     * @param string $hash
-     *
-     * @return bool
-     */
-    private static function verifyVersion2($password, $hash)
-    {
-        return password_verify($password, $hash);
-    }
+	/**
+	 * @param string $password
+	 * @param string $hash
+	 *
+	 * @return bool
+	 */
+	private static function verifyVersion2($password, $hash)
+	{
+		return password_verify($password, $hash);
+	}
 }

includes/Security/CredentialProviders/ICredentialProvider.php

Indentation +15 added lines, -15 removed lines

@@ -12,20 +12,20 @@
 
 interface ICredentialProvider
 {
-    /**
-     * Validates a user-provided credential
-     *
-     * @param User $user The user to test the authentication against
-     * @param string $data The raw credential data to be validated
-     *
-     * @return bool
-     */
-    public function authenticate(User $user, $data);
+	/**
+	 * Validates a user-provided credential
+	 *
+	 * @param User $user The user to test the authentication against
+	 * @param string $data The raw credential data to be validated
+	 *
+	 * @return bool
+	 */
+	public function authenticate(User $user, $data);
 
-    /**
-     * @param User $user The user the credential belongs to
-     * @param int $factor The factor this credential provides
-     * @param string $data
-     */
-    public function setCredential(User $user, $factor, $data);
+	/**
+	 * @param User $user The user the credential belongs to
+	 * @param int $factor The factor this credential provides
+	 * @param string $data
+	 */
+	public function setCredential(User $user, $factor, $data);
 }
\ No newline at end of file

includes/Security/CredentialProviders/PasswordCredentialProvider.php

Indentation +46 added lines, -46 removed lines

@@ -14,50 +14,50 @@
 
 class PasswordCredentialProvider extends CredentialProviderBase
 {
-    const PASSWORD_COST = 10;
-
-    public function __construct(PdoDatabase $database, SiteConfiguration $configuration)
-    {
-        parent::__construct($database, $configuration, 'password');
-    }
-
-    public function authenticate(User $user, $data)
-    {
-        $storedData = $this->getCredentialData($user->getId());
-        if($storedData === null)
-        {
-            // No available credential matching these parameters
-            return false;
-        }
-
-        if($storedData->getVersion() !== 2) {
-            // Non-2 versions are not supported.
-            return false;
-        }
-
-        if(password_verify($data, $storedData->getData())) {
-            if(password_needs_rehash($storedData->getData(), PASSWORD_BCRYPT, array('cost' => self::PASSWORD_COST))){
-                $this->setCredential($user, $storedData->getFactor(), $data);
-            }
-
-            return true;
-        }
-
-        return false;
-    }
-
-    public function setCredential(User $user, $factor, $password)
-    {
-        $storedData = $this->getCredentialData($user->getId());
-
-        if($storedData === null){
-            $storedData = $this->createNewCredential($user);
-        }
-
-        $storedData->setData(password_hash($password, PASSWORD_BCRYPT, array('cost' => self::PASSWORD_COST)));
-        $storedData->setFactor($factor);
-        $storedData->setVersion(2);
-
-        $storedData->save();
-    }
+	const PASSWORD_COST = 10;
+
+	public function __construct(PdoDatabase $database, SiteConfiguration $configuration)
+	{
+		parent::__construct($database, $configuration, 'password');
+	}
+
+	public function authenticate(User $user, $data)
+	{
+		$storedData = $this->getCredentialData($user->getId());
+		if($storedData === null)
+		{
+			// No available credential matching these parameters
+			return false;
+		}
+
+		if($storedData->getVersion() !== 2) {
+			// Non-2 versions are not supported.
+			return false;
+		}
+
+		if(password_verify($data, $storedData->getData())) {
+			if(password_needs_rehash($storedData->getData(), PASSWORD_BCRYPT, array('cost' => self::PASSWORD_COST))){
+				$this->setCredential($user, $storedData->getFactor(), $data);
+			}
+
+			return true;
+		}
+
+		return false;
+	}
+
+	public function setCredential(User $user, $factor, $password)
+	{
+		$storedData = $this->getCredentialData($user->getId());
+
+		if($storedData === null){
+			$storedData = $this->createNewCredential($user);
+		}
+
+		$storedData->setData(password_hash($password, PASSWORD_BCRYPT, array('cost' => self::PASSWORD_COST)));
+		$storedData->setFactor($factor);
+		$storedData->setVersion(2);
+
+		$storedData->save();
+	}
 }
\ No newline at end of file

includes/Security/CredentialProviders/CredentialProviderBase.php

Indentation +69 added lines, -69 removed lines

@@ -15,85 +15,85 @@
 
 abstract class CredentialProviderBase implements ICredentialProvider
 {
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-    /**
-     * @var SiteConfiguration
-     */
-    private $configuration;
-    /** @var string */
-    private $type;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+	/**
+	 * @var SiteConfiguration
+	 */
+	private $configuration;
+	/** @var string */
+	private $type;
 
-    /**
-     * CredentialProviderBase constructor.
-     *
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     * @param string            $type
-     */
-    public function __construct(PdoDatabase $database, SiteConfiguration $configuration, $type)
-    {
-        $this->database = $database;
-        $this->configuration = $configuration;
-        $this->type = $type;
-    }
+	/**
+	 * CredentialProviderBase constructor.
+	 *
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 * @param string            $type
+	 */
+	public function __construct(PdoDatabase $database, SiteConfiguration $configuration, $type)
+	{
+		$this->database = $database;
+		$this->configuration = $configuration;
+		$this->type = $type;
+	}
 
-    /**
-     * @param int $userId
-     *
-     * @return Credential
-     */
-    protected function getCredentialData($userId)
-    {
-        $sql = 'SELECT * FROM credential WHERE type = :t AND user = :u AND disabled = 0';
+	/**
+	 * @param int $userId
+	 *
+	 * @return Credential
+	 */
+	protected function getCredentialData($userId)
+	{
+		$sql = 'SELECT * FROM credential WHERE type = :t AND user = :u AND disabled = 0';
 
-        $statement = $this->database->prepare($sql);
-        $statement->execute(array(':u' => $userId, ':t' => $this->type));
+		$statement = $this->database->prepare($sql);
+		$statement->execute(array(':u' => $userId, ':t' => $this->type));
 
-        /** @var Credential $obj */
-        $obj = $statement->fetchObject(Credential::class);
+		/** @var Credential $obj */
+		$obj = $statement->fetchObject(Credential::class);
 
-        if ($obj === false) {
-            return null;
-        }
+		if ($obj === false) {
+			return null;
+		}
 
-        $obj->setDatabase($this->database);
+		$obj->setDatabase($this->database);
 
-        $statement->closeCursor();
+		$statement->closeCursor();
 
-        return $obj;
-    }
+		return $obj;
+	}
 
-    /**
-     * @return PdoDatabase
-     */
-    public function getDatabase()
-    {
-        return $this->database;
-    }
+	/**
+	 * @return PdoDatabase
+	 */
+	public function getDatabase()
+	{
+		return $this->database;
+	}
 
-    /**
-     * @return SiteConfiguration
-     */
-    public function getConfiguration()
-    {
-        return $this->configuration;
-    }
+	/**
+	 * @return SiteConfiguration
+	 */
+	public function getConfiguration()
+	{
+		return $this->configuration;
+	}
 
-    /**
-     * @param User $user
-     *
-     * @return Credential
-     */
-    protected function createNewCredential(User $user)
-    {
-        $credential = new Credential();
-        $credential->setDatabase($this->getDatabase());
-        $credential->setUserId($user->getId());
-        $credential->setType($this->type);
+	/**
+	 * @param User $user
+	 *
+	 * @return Credential
+	 */
+	protected function createNewCredential(User $user)
+	{
+		$credential = new Credential();
+		$credential->setDatabase($this->getDatabase());
+		$credential->setUserId($user->getId());
+		$credential->setType($this->type);
 
-        return $credential;
-    }
+		return $credential;
+	}
 }
\ No newline at end of file