mdaniels5757 / waca

includes/Pages/Registration/PageRegisterStandard.php

Indentation +14 added lines, -14 removed lines

@@ -10,19 +10,19 @@
 
 class PageRegisterStandard extends PageRegisterBase
 {
-    /**
-     * @return string
-     */
-    protected function getRegistrationTemplate()
-    {
-        return "registration/register.tpl";
-    }
+	/**
+	 * @return string
+	 */
+	protected function getRegistrationTemplate()
+	{
+		return "registration/register.tpl";
+	}
 
-    /**
-     * @return string
-     */
-    protected function getDefaultRole()
-    {
-        return 'user';
-    }
+	/**
+	 * @return string
+	 */
+	protected function getDefaultRole()
+	{
+		return 'user';
+	}
 }

includes/Pages/PageSiteNotice.php

Indentation +33 added lines, -33 removed lines

@@ -15,37 +15,37 @@
 
 class PageSiteNotice extends InternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setHtmlTitle('Site Notice');
-
-        $database = $this->getDatabase();
-
-        /** @var SiteNotice $siteNoticeMessage */
-        $siteNoticeMessage = SiteNotice::getById(1, $database);
-
-        // Dual-mode
-        if (WebRequest::wasPosted()) {
-            $this->validateCSRFToken();
-
-            $siteNoticeMessage->setContent(WebRequest::postString('mailtext'));
-            $siteNoticeMessage->setUpdateVersion(WebRequest::postInt('updateversion'));
-            $siteNoticeMessage->save();
-
-            Logger::siteNoticeEdited($database, $siteNoticeMessage);
-            $this->getNotificationHelper()->siteNoticeEdited();
-
-            $this->redirect();
-        }
-        else {
-            $this->assignCSRFToken();
-
-            $this->setTemplate('site-notice/edit-form.tpl');
-            $this->assign('message', $siteNoticeMessage);
-        }
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setHtmlTitle('Site Notice');
+
+		$database = $this->getDatabase();
+
+		/** @var SiteNotice $siteNoticeMessage */
+		$siteNoticeMessage = SiteNotice::getById(1, $database);
+
+		// Dual-mode
+		if (WebRequest::wasPosted()) {
+			$this->validateCSRFToken();
+
+			$siteNoticeMessage->setContent(WebRequest::postString('mailtext'));
+			$siteNoticeMessage->setUpdateVersion(WebRequest::postInt('updateversion'));
+			$siteNoticeMessage->save();
+
+			Logger::siteNoticeEdited($database, $siteNoticeMessage);
+			$this->getNotificationHelper()->siteNoticeEdited();
+
+			$this->redirect();
+		}
+		else {
+			$this->assignCSRFToken();
+
+			$this->setTemplate('site-notice/edit-form.tpl');
+			$this->assign('message', $siteNoticeMessage);
+		}
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -40,8 +40,7 @@
             $this->getNotificationHelper()->siteNoticeEdited();
 
             $this->redirect();
-        }
-        else {
+        } else {
             $this->assignCSRFToken();
 
             $this->setTemplate('site-notice/edit-form.tpl');

includes/Pages/Statistics/StatsReservedRequests.php

Indentation +11 added lines, -11 removed lines

@@ -13,11 +13,11 @@ 
 
 class StatsReservedRequests extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Reserved Requests :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Reserved Requests :: Statistics');
 
-        $query = <<<sql
+		$query = <<<sql
 SELECT
     p.id AS requestid,
     p.name AS name,
@@ -29,11 +29,11 @@ 
 WHERE reserved != 0;
 sql;
 
-        $database = $this->getDatabase();
-        $statement = $database->query($query);
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $this->assign('dataTable', $data);
-        $this->assign('statsPageTitle', 'All currently reserved requests');
-        $this->setTemplate('statistics/reserved-requests.tpl');
-    }
+		$database = $this->getDatabase();
+		$statement = $database->query($query);
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$this->assign('dataTable', $data);
+		$this->assign('statsPageTitle', 'All currently reserved requests');
+		$this->setTemplate('statistics/reserved-requests.tpl');
+	}
 }

includes/Pages/Request/PageConfirmEmail.php

Braces +1 added lines, -2 removed lines

@@ -48,8 +48,7 @@
 
         if ($request->getEmailConfirm() === $si) {
             $request->setEmailConfirm('Confirmed');
-        }
-        else {
+        } else {
             throw new ApplicationLogicException('The confirmation value does not appear to match the expected value');
         }
 

Indentation +66 added lines, -66 removed lines

@@ -19,70 +19,70 @@
 
 class PageConfirmEmail extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @throws ApplicationLogicException
-     * @throws Exception
-     */
-    protected function main()
-    {
-        $id = WebRequest::getInt('id');
-        $si = WebRequest::getString('si');
-
-        if ($id === null || $si === null) {
-            throw new ApplicationLogicException('Link incomplete - please double check the link you received.');
-        }
-
-        /** @var Request|false $request */
-        $request = Request::getById($id, $this->getDatabase());
-
-        if ($request === false) {
-            throw new ApplicationLogicException('Request not found');
-        }
-
-        if ($request->getEmailConfirm() === 'Confirmed') {
-            // request has already been confirmed. Bomb out silently.
-            $this->redirect('requestSubmitted');
-
-            return;
-        }
-
-        if ($request->getEmailConfirm() === $si) {
-            $request->setEmailConfirm('Confirmed');
-        }
-        else {
-            throw new ApplicationLogicException('The confirmation value does not appear to match the expected value');
-        }
-
-        try {
-            $request->save();
-        }
-        catch (OptimisticLockFailedException $ex) {
-            // Okay. Someone's edited this in the time between us loading this page and doing the checks, and us getting
-            // to saving the page. We *do not* want to show an optimistic lock failure, the most likely problem is they
-            // double-loaded this page (see #255). Let's confirm this, and bomb out with a success message if it's the
-            // case.
-
-            $request = Request::getById($id, $this->getDatabase());
-            if ($request->getEmailConfirm() === 'Confirmed') {
-                // we've already done the sanity checks above
-
-                $this->redirect('requestSubmitted');
-
-                // skip the log and notification
-                return;
-            }
-
-            // something really weird happened. Another race condition?
-            throw $ex;
-        }
-
-        Logger::emailConfirmed($this->getDatabase(), $request);
-
-        if ($request->getStatus() != RequestStatus::CLOSED) {
-            $this->getNotificationHelper()->requestReceived($request);
-        }
-
-        $this->redirect('requestSubmitted');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @throws ApplicationLogicException
+	 * @throws Exception
+	 */
+	protected function main()
+	{
+		$id = WebRequest::getInt('id');
+		$si = WebRequest::getString('si');
+
+		if ($id === null || $si === null) {
+			throw new ApplicationLogicException('Link incomplete - please double check the link you received.');
+		}
+
+		/** @var Request|false $request */
+		$request = Request::getById($id, $this->getDatabase());
+
+		if ($request === false) {
+			throw new ApplicationLogicException('Request not found');
+		}
+
+		if ($request->getEmailConfirm() === 'Confirmed') {
+			// request has already been confirmed. Bomb out silently.
+			$this->redirect('requestSubmitted');
+
+			return;
+		}
+
+		if ($request->getEmailConfirm() === $si) {
+			$request->setEmailConfirm('Confirmed');
+		}
+		else {
+			throw new ApplicationLogicException('The confirmation value does not appear to match the expected value');
+		}
+
+		try {
+			$request->save();
+		}
+		catch (OptimisticLockFailedException $ex) {
+			// Okay. Someone's edited this in the time between us loading this page and doing the checks, and us getting
+			// to saving the page. We *do not* want to show an optimistic lock failure, the most likely problem is they
+			// double-loaded this page (see #255). Let's confirm this, and bomb out with a success message if it's the
+			// case.
+
+			$request = Request::getById($id, $this->getDatabase());
+			if ($request->getEmailConfirm() === 'Confirmed') {
+				// we've already done the sanity checks above
+
+				$this->redirect('requestSubmitted');
+
+				// skip the log and notification
+				return;
+			}
+
+			// something really weird happened. Another race condition?
+			throw $ex;
+		}
+
+		Logger::emailConfirmed($this->getDatabase(), $request);
+
+		if ($request->getStatus() != RequestStatus::CLOSED) {
+			$this->getNotificationHelper()->requestReceived($request);
+		}
+
+		$this->redirect('requestSubmitted');
+	}
 }
\ No newline at end of file

includes/Pages/PageTeam.php

Braces +1 added lines, -2 removed lines

@@ -29,8 +29,7 @@
         foreach ($teamData as $name => $item) {
             if (count($item['Role']) == 0) {
                 $inactive[$name] = $item;
-            }
-            else {
+            } else {
                 $active[$name] = $item;
             }
         }

Indentation +40 added lines, -40 removed lines

@@ -12,44 +12,44 @@
 
 class PageTeam extends InternalPageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $path = $this->getSiteConfiguration()->getFilePath() . '/team.json';
-        $json = file_get_contents($path);
-
-        $teamData = json_decode($json, true);
-
-        $active = array();
-        $inactive = array();
-
-        foreach ($teamData as $name => $item) {
-            if (count($item['Role']) == 0) {
-                $inactive[$name] = $item;
-            }
-            else {
-                $active[$name] = $item;
-            }
-        }
-
-        $this->assign('developer', $this->assocArrayShuffle($active));
-        $this->assign('inactiveDeveloper', $this->assocArrayShuffle($inactive));
-        $this->setTemplate('team/team.tpl');
-    }
-
-    private function assocArrayShuffle($array)
-    {
-        $arrayKeys = array_keys($array);
-        shuffle($arrayKeys);
-
-        $sorted = [];
-        foreach ($arrayKeys as $k) {
-            $sorted[$k] = $array[$k];
-        }
-
-        return $sorted;
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$path = $this->getSiteConfiguration()->getFilePath() . '/team.json';
+		$json = file_get_contents($path);
+
+		$teamData = json_decode($json, true);
+
+		$active = array();
+		$inactive = array();
+
+		foreach ($teamData as $name => $item) {
+			if (count($item['Role']) == 0) {
+				$inactive[$name] = $item;
+			}
+			else {
+				$active[$name] = $item;
+			}
+		}
+
+		$this->assign('developer', $this->assocArrayShuffle($active));
+		$this->assign('inactiveDeveloper', $this->assocArrayShuffle($inactive));
+		$this->setTemplate('team/team.tpl');
+	}
+
+	private function assocArrayShuffle($array)
+	{
+		$arrayKeys = array_keys($array);
+		shuffle($arrayKeys);
+
+		$sorted = [];
+		foreach ($arrayKeys as $k) {
+			$sorted[$k] = $array[$k];
+		}
+
+		return $sorted;
+	}
 }

includes/Pages/RequestAction/PageSendToUser.php

Indentation +39 added lines, -39 removed lines

@@ -17,43 +17,43 @@
 
 class PageSendToUser extends RequestActionBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @throws ApplicationLogicException
-     * @throws Exception
-     */
-    protected function main()
-    {
-        $this->checkPosted();
-        $database = $this->getDatabase();
-        $request = $this->getRequest($database);
-
-        if ($request->getReserved() !== User::getCurrent($database)->getId()) {
-            throw new ApplicationLogicException('You don\'t have this request reserved!');
-        }
-
-        $username = WebRequest::postString('user');
-        if ($username === null) {
-            throw new ApplicationLogicException('User must be specified');
-        }
-
-        $user = User::getByUsername($username, $database);
-        if ($user === false) {
-            throw new ApplicationLogicException('User not found');
-        }
-
-        if (!$user->isActive()) {
-            throw new ApplicationLogicException('User is currently not active on the tool');
-        }
-
-        $request->setReserved($user->getId());
-        $request->setUpdateVersion(WebRequest::postInt('updateversion'));
-        $request->save();
-
-        Logger::sendReservation($database, $request, $user);
-        $this->getNotificationHelper()->requestReservationSent($request, $user);
-        SessionAlert::success("Reservation sent successfully");
-
-        $this->redirect('viewRequest', null, array('id' => $request->getId()));
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @throws ApplicationLogicException
+	 * @throws Exception
+	 */
+	protected function main()
+	{
+		$this->checkPosted();
+		$database = $this->getDatabase();
+		$request = $this->getRequest($database);
+
+		if ($request->getReserved() !== User::getCurrent($database)->getId()) {
+			throw new ApplicationLogicException('You don\'t have this request reserved!');
+		}
+
+		$username = WebRequest::postString('user');
+		if ($username === null) {
+			throw new ApplicationLogicException('User must be specified');
+		}
+
+		$user = User::getByUsername($username, $database);
+		if ($user === false) {
+			throw new ApplicationLogicException('User not found');
+		}
+
+		if (!$user->isActive()) {
+			throw new ApplicationLogicException('User is currently not active on the tool');
+		}
+
+		$request->setReserved($user->getId());
+		$request->setUpdateVersion(WebRequest::postInt('updateversion'));
+		$request->save();
+
+		Logger::sendReservation($database, $request, $user);
+		$this->getNotificationHelper()->requestReservationSent($request, $user);
+		SessionAlert::success("Reservation sent successfully");
+
+		$this->redirect('viewRequest', null, array('id' => $request->getId()));
+	}
 }

includes/Offline.php

Braces +1 added lines, -2 removed lines

@@ -48,8 +48,7 @@
 
         if ($external) {
             return $smarty->fetch("offline/external.tpl");
-        }
-        else {
+        } else {
             $hideCulprit = true;
 
             // Use the provided message if possible

Indentation +46 added lines, -46 removed lines

@@ -17,57 +17,57 @@
  */
 class Offline
 {
-    /**
-     * Determines if the tool is offline
-     * @return bool
-     */
-    public static function isOffline(SiteConfiguration $configuration): bool
-    {
-        return (bool)$configuration->getOffline()['offline'];
-    }
+	/**
+	 * Determines if the tool is offline
+	 * @return bool
+	 */
+	public static function isOffline(SiteConfiguration $configuration): bool
+	{
+		return (bool)$configuration->getOffline()['offline'];
+	}
 
-    /**
-     * Gets the offline message
-     *
-     * @throws Smarty\Exception
-     */
-    public static function getOfflineMessage(bool $external, SiteConfiguration $configuration, ?string $message = null): string
-    {
-        $baseurl = $configuration->getBaseUrl();
-        $culprit = $configuration->getOffline()['culprit'];
-        $reason = $configuration->getOffline()['reason'];
+	/**
+	 * Gets the offline message
+	 *
+	 * @throws Smarty\Exception
+	 */
+	public static function getOfflineMessage(bool $external, SiteConfiguration $configuration, ?string $message = null): string
+	{
+		$baseurl = $configuration->getBaseUrl();
+		$culprit = $configuration->getOffline()['culprit'];
+		$reason = $configuration->getOffline()['reason'];
 
-        $smarty = new Smarty();
-        $smarty->assign("baseurl", $baseurl);
-        $smarty->assign("resourceCacheEpoch", 0);
-        $smarty->assign("alerts", []);
-        $smarty->assign("toolversion", Environment::getToolVersion());
+		$smarty = new Smarty();
+		$smarty->assign("baseurl", $baseurl);
+		$smarty->assign("resourceCacheEpoch", 0);
+		$smarty->assign("alerts", []);
+		$smarty->assign("toolversion", Environment::getToolVersion());
 
-        if (!headers_sent()) {
-            header("HTTP/1.1 503 Service Unavailable");
-        }
+		if (!headers_sent()) {
+			header("HTTP/1.1 503 Service Unavailable");
+		}
 
-        if ($external) {
-            return $smarty->fetch("offline/external.tpl");
-        }
-        else {
-            $hideCulprit = true;
+		if ($external) {
+			return $smarty->fetch("offline/external.tpl");
+		}
+		else {
+			$hideCulprit = true;
 
-            // Use the provided message if possible
-            if ($message === null) {
-                $hideCulprit = false;
-                $message = $reason;
-            }
+			// Use the provided message if possible
+			if ($message === null) {
+				$hideCulprit = false;
+				$message = $reason;
+			}
 
-            $smarty->assign("hideCulprit", $hideCulprit);
-            $smarty->assign("dontUseDbCulprit", $culprit);
-            $smarty->assign("dontUseDbReason", $message);
-            $smarty->assign("alerts", []);
-            $smarty->assign('currentUser', User::getCommunity());
-            $smarty->assign('skin', 'main');
-            $smarty->assign('currentDomain', null);
+			$smarty->assign("hideCulprit", $hideCulprit);
+			$smarty->assign("dontUseDbCulprit", $culprit);
+			$smarty->assign("dontUseDbReason", $message);
+			$smarty->assign("alerts", []);
+			$smarty->assign('currentUser', User::getCommunity());
+			$smarty->assign('skin', 'main');
+			$smarty->assign('currentDomain', null);
 
-            return $smarty->fetch("offline/internal.tpl");
-        }
-    }
+			return $smarty->fetch("offline/internal.tpl");
+		}
+	}
 }

includes/Router/RequestRouter.php

Braces +5 added lines, -10 removed lines

@@ -340,8 +340,7 @@ 
         if (count($pathInfo) === 0) {
             // No pathInfo, so no page to load. Load the main page.
             return $this->getDefaultRoute();
-        }
-        elseif (count($pathInfo) === 1) {
+        } elseif (count($pathInfo) === 1) {
             // Exactly one path info segment, it's got to be a page.
             $classSegment = $pathInfo[0];
 
@@ -353,8 +352,7 @@ 
             // Let's handle more than two, and collapse it down into two.
             $requestedAction = array_pop($pathInfo);
             $classSegment = implode('/', $pathInfo);
-        }
-        else {
+        } else {
             // Two path info segments.
             $classSegment = $pathInfo[0];
             $requestedAction = $pathInfo[1];
@@ -383,8 +381,7 @@ 
             $action = 'main';
 
             return array($pageClass, $action);
-        }
-        else {
+        } else {
             // Doesn't exist in map. Fall back to 404
             $pageClass = Page404::class;
             $action = "main";
@@ -413,16 +410,14 @@ 
                 $action = $requestedAction;
 
                 return array($pageClass, $action);
-            }
-            else {
+            } else {
                 // Valid page, invalid action. 404 our way out.
                 $pageClass = Page404::class;
                 $action = 'main';
 
                 return array($pageClass, $action);
             }
-        }
-        else {
+        } else {
             // Class doesn't exist in map. Fall back to 404
             $pageClass = Page404::class;
             $action = 'main';

Indentation +479 added lines, -479 removed lines

@@ -72,483 +72,483 @@
  */
 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'   => PagePasswordLogin::class,
-                'actions' => array(),
-            ),
-        'login/otp'                   =>
-            array(
-                'class'   => PageOtpLogin::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'),
-            ),
-        'domainSwitch'                =>
-            array(
-                'class'   => PageDomainSwitch::class,
-                'actions' => array(),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // 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', 'show', 'replace'),
-            ),
-        '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'),
-            ),
-        'queueManagement'             =>
-            array(
-                'class'   => PageQueueManagement::class,
-                'actions' => array('create', 'edit'),
-            ),
-        'requestFormManagement'       =>
-            array(
-                'class'   => PageRequestFormManagement::class,
-                'actions' => array('create', 'edit', 'view', 'preview'),
-            ),
-        'jobQueue'                    =>
-            array(
-                'class'   => PageJobQueue::class,
-                'actions' => array('acknowledge', 'requeue', 'view', 'all', 'cancel'),
-            ),
-        'domainManagement'            =>
-            array(
-                'class'   => PageDomainManagement::class,
-                'actions' => array('create', 'edit'),
-            ),
-        'flaggedComments'             =>
-            array(
-                'class'   => PageListFlaggedComments::class,
-                'actions' => array(),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Personal preferences
-        'preferences'                 =>
-            array(
-                'class'   => PagePreferences::class,
-                'actions' => array(
-                    'refreshOAuth'
-                ),
-            ),
-        'changePassword'              =>
-            array(
-                'class'   => PageChangePassword::class,
-                'actions' => array(),
-            ),
-        'multiFactor'                 =>
-            array(
-                'class'   => PageMultiFactor::class,
-                'actions' => array(
-                    'scratch',
-                    'enableYubikeyOtp',
-                    'disableYubikeyOtp',
-                    'enableTotp',
-                    'disableTotp',
-                ),
-            ),
-        '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/confirm'         =>
-            array(
-                'class'   => PageManuallyConfirm::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(),
-            ),
-        'flagComment'                 =>
-            array(
-                'class'   => PageFlagComment::class,
-                'actions' => array(),
-            ),
-
-        //////////////////////////////////////////////////////////////////////////////////////////////////
-        // Misc stuff
-        'team'                        =>
-            array(
-                'class'   => PageTeam::class,
-                'actions' => array(),
-            ),
-        'requestList'                 =>
-            array(
-                'class'   => PageExpandedRequestList::class,
-                'actions' => array(),
-            ),
-        'xffdemo'                     =>
-            array(
-                'class'   => PageXffDemo::class,
-                'actions' => array(),
-            ),
-        'errorLog'                    =>
-            array(
-                'class'   => PageErrorLogViewer::class,
-                'actions' => array('remove', 'view'),
-            ),
-        'privacy'                     =>
-            array(
-                'class'   => PagePrivacy::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
-     */
-    public 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 array
-     */
-    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'   => PagePasswordLogin::class,
+				'actions' => array(),
+			),
+		'login/otp'                   =>
+			array(
+				'class'   => PageOtpLogin::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'),
+			),
+		'domainSwitch'                =>
+			array(
+				'class'   => PageDomainSwitch::class,
+				'actions' => array(),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// 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', 'show', 'replace'),
+			),
+		'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'),
+			),
+		'queueManagement'             =>
+			array(
+				'class'   => PageQueueManagement::class,
+				'actions' => array('create', 'edit'),
+			),
+		'requestFormManagement'       =>
+			array(
+				'class'   => PageRequestFormManagement::class,
+				'actions' => array('create', 'edit', 'view', 'preview'),
+			),
+		'jobQueue'                    =>
+			array(
+				'class'   => PageJobQueue::class,
+				'actions' => array('acknowledge', 'requeue', 'view', 'all', 'cancel'),
+			),
+		'domainManagement'            =>
+			array(
+				'class'   => PageDomainManagement::class,
+				'actions' => array('create', 'edit'),
+			),
+		'flaggedComments'             =>
+			array(
+				'class'   => PageListFlaggedComments::class,
+				'actions' => array(),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Personal preferences
+		'preferences'                 =>
+			array(
+				'class'   => PagePreferences::class,
+				'actions' => array(
+					'refreshOAuth'
+				),
+			),
+		'changePassword'              =>
+			array(
+				'class'   => PageChangePassword::class,
+				'actions' => array(),
+			),
+		'multiFactor'                 =>
+			array(
+				'class'   => PageMultiFactor::class,
+				'actions' => array(
+					'scratch',
+					'enableYubikeyOtp',
+					'disableYubikeyOtp',
+					'enableTotp',
+					'disableTotp',
+				),
+			),
+		'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/confirm'         =>
+			array(
+				'class'   => PageManuallyConfirm::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(),
+			),
+		'flagComment'                 =>
+			array(
+				'class'   => PageFlagComment::class,
+				'actions' => array(),
+			),
+
+		//////////////////////////////////////////////////////////////////////////////////////////////////
+		// Misc stuff
+		'team'                        =>
+			array(
+				'class'   => PageTeam::class,
+				'actions' => array(),
+			),
+		'requestList'                 =>
+			array(
+				'class'   => PageExpandedRequestList::class,
+				'actions' => array(),
+			),
+		'xffdemo'                     =>
+			array(
+				'class'   => PageXffDemo::class,
+				'actions' => array(),
+			),
+		'errorLog'                    =>
+			array(
+				'class'   => PageErrorLogViewer::class,
+				'actions' => array('remove', 'view'),
+			),
+		'privacy'                     =>
+			array(
+				'class'   => PagePrivacy::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
+	 */
+	public 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 array
+	 */
+	protected function getDefaultRoute()
+	{
+		return array(PageMain::class, "main");
+	}
 }

includes/Router/IRequestRouter.php

Indentation +5 added lines, -5 removed lines

@@ -18,9 +18,9 @@
  */
 interface IRequestRouter
 {
-    /**
-     * @return IRoutedTask
-     * @throws Exception
-     */
-    public function route();
+	/**
+	 * @return IRoutedTask
+	 * @throws Exception
+	 */
+	public function route();
 }
\ No newline at end of file