stwalkerster / waca

config.inc.php

Indentation +58 added lines, -58 removed lines

@@ -178,12 +178,12 @@ 
 require_once('config.local.inc.php');
 
 $cDatabaseConfig = array(
-    "acc"           => array(
-        "dsrcname" => "mysql:host=" . $toolserver_host . ";dbname=" . $toolserver_database,
-        "username" => $toolserver_username,
-        "password" => $toolserver_password,
-        "options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
-    ),
+	"acc"           => array(
+		"dsrcname" => "mysql:host=" . $toolserver_host . ";dbname=" . $toolserver_database,
+		"username" => $toolserver_username,
+		"password" => $toolserver_password,
+		"options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
+	),
 );
 
 // //Keep the included files from being executed.
@@ -195,18 +195,18 @@ 
 ini_set('user_agent', $toolUserAgent);
 
 foreach (array(
-    "mbstring", // unicode and stuff
-    "pdo",
-    "pdo_mysql", // new database module
-    "session",
-    "date",
-    "pcre", // core stuff
-    "curl", // mediawiki api access etc
-    "openssl", // token generation
+	"mbstring", // unicode and stuff
+	"pdo",
+	"pdo_mysql", // new database module
+	"session",
+	"date",
+	"pcre", // core stuff
+	"curl", // mediawiki api access etc
+	"openssl", // token generation
 ) as $x) {
-    if (!extension_loaded($x)) {
-        die("extension $x is required.");
-    }
+	if (!extension_loaded($x)) {
+		die("extension $x is required.");
+	}
 }
 
 // Set up the AutoLoader
@@ -231,44 +231,44 @@ 
 $siteConfiguration = new \Waca\SiteConfiguration();
 
 $siteConfiguration->setBaseUrl($baseurl)
-    ->setFilePath(__DIR__)
-    ->setDebuggingTraceEnabled($enableErrorTrace)
-    ->setDebuggingCssBreakpointsEnabled($enableCssBreakpoints)
-    ->setForceIdentification($forceIdentification)
-    ->setIdentificationCacheExpiry($identificationCacheExpiry)
-    ->setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
-    ->setEnforceOAuth($enforceOAuth)
-    ->setEmailConfirmationEnabled($enableEmailConfirm == 1)
-    ->setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
-    ->setMiserModeLimit($requestLimitShowOnly)
-    ->setSquidList($squidIpList)
-    ->setUseStrictTransportSecurity($strictTransportSecurityExpiry)
-    ->setUserAgent($toolUserAgent)
-    ->setCurlDisableVerifyPeer($curlDisableSSLVerifyPeer)
-    ->setUseOAuthSignup($useOauthSignup)
-    ->setOAuthConsumerToken($oauthConsumerToken)
-    ->setOAuthLegacyConsumerTokens($oauthLegacyTokens)
-    ->setOAuthConsumerSecret($oauthSecretToken)
-    ->setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
-    ->setDataClearInterval($dataclear_interval)
-    ->setXffTrustedHostsFile($xff_trusted_hosts_file)
-    ->setIrcNotificationsEnabled($ircBotNotificationsEnabled == 1)
-    ->setIrcNotificationsInstance($whichami)
-    ->setTitleBlacklistEnabled($enableTitleblacklist == 1)
-    ->setTorExitPaths(array_merge(gethostbynamel('en.wikipedia.org'), gethostbynamel('accounts.wmflabs.org')))
-    ->setCreationBotUsername($creationBotUsername)
-    ->setCreationBotPassword($creationBotPassword)
-    ->setCurlCookieJar($curlCookieJar)
-    ->setYubicoApiId($yubicoApiId)
-    ->setYubicoApiKey($yubicoApiKey)
-    ->setTotpEncryptionKey($totpEncryptionKey)
-    ->setRegistrationAllowed($allowRegistration)
-    ->setCspReportUri($cspReportUri)
-    ->setResourceCacheEpoch($resourceCacheEpoch)
-    ->setLocationProviderApiKey($locationProviderApiKey)
-    ->setCommonEmailDomains($commonEmailDomains)
-    ->setBanMaxIpRange($banMaxIpRange)
-    ->setBanMaxIpBlockRange($banMaxIpBlockRange)
-    ->setJobQueueBatchSize($jobQueueBatchSize)
-    ->setAmqpConfiguration($amqpConfiguration)
-    ->setEmailSender($emailSender);
+	->setFilePath(__DIR__)
+	->setDebuggingTraceEnabled($enableErrorTrace)
+	->setDebuggingCssBreakpointsEnabled($enableCssBreakpoints)
+	->setForceIdentification($forceIdentification)
+	->setIdentificationCacheExpiry($identificationCacheExpiry)
+	->setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
+	->setEnforceOAuth($enforceOAuth)
+	->setEmailConfirmationEnabled($enableEmailConfirm == 1)
+	->setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
+	->setMiserModeLimit($requestLimitShowOnly)
+	->setSquidList($squidIpList)
+	->setUseStrictTransportSecurity($strictTransportSecurityExpiry)
+	->setUserAgent($toolUserAgent)
+	->setCurlDisableVerifyPeer($curlDisableSSLVerifyPeer)
+	->setUseOAuthSignup($useOauthSignup)
+	->setOAuthConsumerToken($oauthConsumerToken)
+	->setOAuthLegacyConsumerTokens($oauthLegacyTokens)
+	->setOAuthConsumerSecret($oauthSecretToken)
+	->setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
+	->setDataClearInterval($dataclear_interval)
+	->setXffTrustedHostsFile($xff_trusted_hosts_file)
+	->setIrcNotificationsEnabled($ircBotNotificationsEnabled == 1)
+	->setIrcNotificationsInstance($whichami)
+	->setTitleBlacklistEnabled($enableTitleblacklist == 1)
+	->setTorExitPaths(array_merge(gethostbynamel('en.wikipedia.org'), gethostbynamel('accounts.wmflabs.org')))
+	->setCreationBotUsername($creationBotUsername)
+	->setCreationBotPassword($creationBotPassword)
+	->setCurlCookieJar($curlCookieJar)
+	->setYubicoApiId($yubicoApiId)
+	->setYubicoApiKey($yubicoApiKey)
+	->setTotpEncryptionKey($totpEncryptionKey)
+	->setRegistrationAllowed($allowRegistration)
+	->setCspReportUri($cspReportUri)
+	->setResourceCacheEpoch($resourceCacheEpoch)
+	->setLocationProviderApiKey($locationProviderApiKey)
+	->setCommonEmailDomains($commonEmailDomains)
+	->setBanMaxIpRange($banMaxIpRange)
+	->setBanMaxIpBlockRange($banMaxIpBlockRange)
+	->setJobQueueBatchSize($jobQueueBatchSize)
+	->setAmqpConfiguration($amqpConfiguration)
+	->setEmailSender($emailSender);

redir.php

Indentation +32 added lines, -32 removed lines

@@ -7,48 +7,48 @@
  ******************************************************************************/
 
 $toolList = array(
-    'tparis-pcount'      => '//tools.wmflabs.org/supercount/index.php?user=%DATA%&project=en.wikipedia',
-    'guc'                => '//tools.wmflabs.org/guc/?by=date&user=%DATA%',
-    'oq-whois'           => 'https://whois.domaintools.com/%DATA%',
-    'tl-whois'           => 'https://tools.wmflabs.org/whois/gateway.py?lookup=true&ip=%DATA%',
-    'honeypot'           => 'https://www.projecthoneypot.org/ip_%DATA%',
-    'stopforumspam'      => 'https://www.stopforumspam.com/ipcheck/%DATA%',
-    'google'             => 'https://www.google.com/search?q=%DATA%',
-    'domain'             => 'http://%DATA%/',
-    'rangefinder'        => 'https://tools.wmflabs.org/rangeblockfinder/?ip=%DATA%',
-    'ipcheck'            => 'https://ipcheck.toolforge.org/index.php?ip=%DATA%',
-    'bgpview'            => 'https://bgpview.io/ip/%DATA%',
-    'bullseye'           => 'https://bullseye.toolforge.org/ip/%DATA%',
-    'ipalyzer'           => 'https://ipalyzer.com/%DATA%'
+	'tparis-pcount'      => '//tools.wmflabs.org/supercount/index.php?user=%DATA%&project=en.wikipedia',
+	'guc'                => '//tools.wmflabs.org/guc/?by=date&user=%DATA%',
+	'oq-whois'           => 'https://whois.domaintools.com/%DATA%',
+	'tl-whois'           => 'https://tools.wmflabs.org/whois/gateway.py?lookup=true&ip=%DATA%',
+	'honeypot'           => 'https://www.projecthoneypot.org/ip_%DATA%',
+	'stopforumspam'      => 'https://www.stopforumspam.com/ipcheck/%DATA%',
+	'google'             => 'https://www.google.com/search?q=%DATA%',
+	'domain'             => 'http://%DATA%/',
+	'rangefinder'        => 'https://tools.wmflabs.org/rangeblockfinder/?ip=%DATA%',
+	'ipcheck'            => 'https://ipcheck.toolforge.org/index.php?ip=%DATA%',
+	'bgpview'            => 'https://bgpview.io/ip/%DATA%',
+	'bullseye'           => 'https://bullseye.toolforge.org/ip/%DATA%',
+	'ipalyzer'           => 'https://ipalyzer.com/%DATA%'
 );
 
 if (!isset($_GET['tool'])
-    || !isset($toolList[$_GET['tool']])
-    || !isset($_GET['data'])
+	|| !isset($toolList[$_GET['tool']])
+	|| !isset($_GET['data'])
 ) {
-    header("HTTP/1.1 403 Forbidden");
+	header("HTTP/1.1 403 Forbidden");
 
-    return;
+	return;
 }
 
 if (isset($_GET['round2'])) {
-    $data = $_GET['data'];
-    $tool = $_GET['tool'];
+	$data = $_GET['data'];
+	$tool = $_GET['tool'];
 
-    if ($tool === 'domain') {
-        // quick security check - if you want to exploit something, you better be sure your exploit resolves via dns.
-        // this is not intended to catch everything, just as a quick sanity check.
-        if (gethostbyname($data) == $data) {
-            echo 'Error resolving hostname, it doesn\'t look like this domain exists.';
-            die();
-        }
-    }
-    else {
-        $data = urlencode($data);
-    }
+	if ($tool === 'domain') {
+		// quick security check - if you want to exploit something, you better be sure your exploit resolves via dns.
+		// this is not intended to catch everything, just as a quick sanity check.
+		if (gethostbyname($data) == $data) {
+			echo 'Error resolving hostname, it doesn\'t look like this domain exists.';
+			die();
+		}
+	}
+	else {
+		$data = urlencode($data);
+	}
 
-    echo '<script>window.location.href=' . json_encode(str_replace("%DATA%", $data, $toolList[$tool])) . '</script>';
+	echo '<script>window.location.href=' . json_encode(str_replace("%DATA%", $data, $toolList[$tool])) . '</script>';
 }
 else {
-    header("Location: " . $_SERVER["REQUEST_URI"] . "&round2=true");
+	header("Location: " . $_SERVER["REQUEST_URI"] . "&round2=true");
 }

includes/Providers/CachedApiAntispoofProvider.php

Indentation +73 added lines, -73 removed lines

@@ -23,77 +23,77 @@
  */
 class CachedApiAntispoofProvider implements IAntiSpoofProvider
 {
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-
-    public function __construct(PdoDatabase $database, HttpHelper $httpHelper)
-    {
-        $this->database = $database;
-        $this->httpHelper = $httpHelper;
-    }
-
-    public function getSpoofs($username)
-    {
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        /** @var AntiSpoofCache $cacheResult */
-        $cacheResult = AntiSpoofCache::getByUsername($username, $this->database);
-        if ($cacheResult == false) {
-            // get the data from the API
-            $data = $this->httpHelper->get($domain->getWikiApiPath(), array(
-                'action'   => 'antispoof',
-                'format'   => 'php',
-                'username' => $username,
-            ));
-
-            $cacheEntry = new AntiSpoofCache();
-            $cacheEntry->setDatabase($this->database);
-            $cacheEntry->setUsername($username);
-            $cacheEntry->setData($data);
-            $cacheEntry->save();
-
-            $cacheResult = $cacheEntry;
-        }
-        else {
-            $data = $cacheResult->getData();
-        }
-
-        $result = unserialize($data);
-
-        if (!isset($result['antispoof']) || !isset($result['antispoof']['result'])) {
-            $cacheResult->delete();
-
-            if (isset($result['error']['info'])) {
-                throw new Exception("Unrecognised API response to query: " . $result['error']['info']);
-            }
-
-            throw new Exception("Unrecognised API response to query.");
-        }
-
-        if ($result['antispoof']['result'] == "pass") {
-            // All good here!
-            return array();
-        }
-
-        if ($result['antispoof']['result'] == "conflict") {
-            // we've got conflicts, let's do something with them.
-            return $result['antispoof']['users'];
-        }
-
-        if ($result['antispoof']['result'] == "error") {
-            // we've got conflicts, let's do something with them.
-            throw new Exception("Encountered error while getting result: " . $result['antispoof']['error']);
-        }
-
-        throw new Exception("Unrecognised API response to query.");
-    }
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+
+	public function __construct(PdoDatabase $database, HttpHelper $httpHelper)
+	{
+		$this->database = $database;
+		$this->httpHelper = $httpHelper;
+	}
+
+	public function getSpoofs($username)
+	{
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		/** @var AntiSpoofCache $cacheResult */
+		$cacheResult = AntiSpoofCache::getByUsername($username, $this->database);
+		if ($cacheResult == false) {
+			// get the data from the API
+			$data = $this->httpHelper->get($domain->getWikiApiPath(), array(
+				'action'   => 'antispoof',
+				'format'   => 'php',
+				'username' => $username,
+			));
+
+			$cacheEntry = new AntiSpoofCache();
+			$cacheEntry->setDatabase($this->database);
+			$cacheEntry->setUsername($username);
+			$cacheEntry->setData($data);
+			$cacheEntry->save();
+
+			$cacheResult = $cacheEntry;
+		}
+		else {
+			$data = $cacheResult->getData();
+		}
+
+		$result = unserialize($data);
+
+		if (!isset($result['antispoof']) || !isset($result['antispoof']['result'])) {
+			$cacheResult->delete();
+
+			if (isset($result['error']['info'])) {
+				throw new Exception("Unrecognised API response to query: " . $result['error']['info']);
+			}
+
+			throw new Exception("Unrecognised API response to query.");
+		}
+
+		if ($result['antispoof']['result'] == "pass") {
+			// All good here!
+			return array();
+		}
+
+		if ($result['antispoof']['result'] == "conflict") {
+			// we've got conflicts, let's do something with them.
+			return $result['antispoof']['users'];
+		}
+
+		if ($result['antispoof']['result'] == "error") {
+			// we've got conflicts, let's do something with them.
+			throw new Exception("Encountered error while getting result: " . $result['antispoof']['error']);
+		}
+
+		throw new Exception("Unrecognised API response to query.");
+	}
 }

includes/Router/RequestRouter.php

Indentation +481 added lines, -481 removed lines

@@ -71,485 +71,485 @@
  */
 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(),
-            ),
-        'login/u2f'                   =>
-            array(
-                'class'   => PageU2FLogin::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'),
-            ),
-        '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',
-                    'enableU2F',
-                    'disableU2F',
-                ),
-            ),
-        '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'),
-            ),
-    );
-
-    /**
-     * @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(),
+			),
+		'login/u2f'                   =>
+			array(
+				'class'   => PageU2FLogin::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'),
+			),
+		'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',
+					'enableU2F',
+					'disableU2F',
+				),
+			),
+		'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'),
+			),
+	);
+
+	/**
+	 * @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/PublicRequestRouter.php

Indentation +47 added lines, -47 removed lines

@@ -15,53 +15,53 @@
 
 class PublicRequestRouter extends RequestRouter
 {
-    /**
-     * Gets the route map to be used by this request router.
-     *
-     * @return array
-     */
-    protected function getRouteMap()
-    {
-        return array(
-            // Page showing a message stating the request has been submitted to our internal queues
-            'requestSubmitted'          =>
-                array(
-                    'class'   => PageRequestSubmitted::class,
-                    'actions' => array(),
-                ),
-            // Page showing a message stating that email confirmation is required to continue
-            'emailConfirmationRequired' =>
-                array(
-                    'class'   => PageEmailConfirmationRequired::class,
-                    'actions' => array(),
-                ),
-            // Action page which handles email confirmation
-            'confirmEmail'              =>
-                array(
-                    'class'   => PageConfirmEmail::class,
-                    'actions' => array(),
-                ),
-        );
-    }
+	/**
+	 * Gets the route map to be used by this request router.
+	 *
+	 * @return array
+	 */
+	protected function getRouteMap()
+	{
+		return array(
+			// Page showing a message stating the request has been submitted to our internal queues
+			'requestSubmitted'          =>
+				array(
+					'class'   => PageRequestSubmitted::class,
+					'actions' => array(),
+				),
+			// Page showing a message stating that email confirmation is required to continue
+			'emailConfirmationRequired' =>
+				array(
+					'class'   => PageEmailConfirmationRequired::class,
+					'actions' => array(),
+				),
+			// Action page which handles email confirmation
+			'confirmEmail'              =>
+				array(
+					'class'   => PageConfirmEmail::class,
+					'actions' => array(),
+				),
+		);
+	}
 
-    /**
-     * Gets the default route if no explicit route is requested.
-     *
-     * @return callable
-     */
-    protected function getDefaultRoute()
-    {
-        return array(PageRequestAccount::class, 'main');
-    }
+	/**
+	 * Gets the default route if no explicit route is requested.
+	 *
+	 * @return callable
+	 */
+	protected function getDefaultRoute()
+	{
+		return array(PageRequestAccount::class, 'main');
+	}
 
-    public function getRouteFromPath($pathInfo): array
-    {
-        if (count($pathInfo) === 3 && $pathInfo[0] === 'r') {
-            // this request should be routed to the dynamic request form handler
-            return [PageRequestAccount::class, 'dynamic'];
-        }
-        else {
-            return parent::getRouteFromPath($pathInfo);
-        }
-    }
+	public function getRouteFromPath($pathInfo): array
+	{
+		if (count($pathInfo) === 3 && $pathInfo[0] === 'r') {
+			// this request should be routed to the dynamic request form handler
+			return [PageRequestAccount::class, 'dynamic'];
+		}
+		else {
+			return parent::getRouteFromPath($pathInfo);
+		}
+	}
 }
\ No newline at end of file

includes/Background/CreationTaskBase.php

Indentation +152 added lines, -152 removed lines

@@ -21,156 +21,156 @@
 
 abstract class CreationTaskBase extends BackgroundTaskBase
 {
-    /** @var Request */
-    private $request;
-    /**
-     * @var MediaWikiHelper
-     * Don't use this directly.
-     */
-    private $mwHelper = null;
-
-    public function execute()
-    {
-        $this->request = $this->getRequest();
-        $user = $this->getTriggerUser();
-        $parameters = $this->getParameters();
-
-        if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
-            $this->markCancelled('Request is not deferred to the job queue');
-
-            return;
-        }
-
-        if ($this->request->getEmailSent() != 0 && !isset($parameters->emailText)) {
-            $this->markFailed('Request has already been sent a templated email');
-
-            return;
-        }
-
-        if ($this->request->getEmail() === $this->getSiteConfiguration()->getDataClearEmail()) {
-            $this->markFailed('Private data of request has been purged.');
-
-            return;
-        }
-
-        $emailText = null;
-        $ccMailingList = null;
-        $logTarget = null;
-
-        if (isset($parameters->emailText) && isset($parameters->ccMailingList)) {
-            $emailText = $parameters->emailText;
-            $ccMailingList = $parameters->ccMailingList;
-            $logTarget = "custom-y";
-        }
-
-        if ($this->getEmailTemplate() !== null) {
-            $emailText = $this->getEmailTemplate()->getText();
-            $ccMailingList = false;
-            $logTarget = $this->getEmailTemplate()->getId();
-        }
-
-        if ($emailText === null || $ccMailingList === null) {
-            $this->markFailed('Unable to get closure email text');
-
-            return;
-        }
-
-        try {
-            $this->performCreation($user);
-
-            $this->request->setStatus(RequestStatus::CLOSED);
-            $this->request->setQueue(null);
-            $this->request->setReserved(null);
-            $this->request->setEmailSent(true);
-            $this->request->save();
-
-            // Log the closure as the user
-            $logComment = $this->getEmailTemplate() === null ? $emailText : null;
-            Logger::closeRequest($this->getDatabase(), $this->request, $logTarget, $logComment, $this->getTriggerUser());
-
-            $requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
-            $requestEmailHelper->sendMail($this->request, $emailText, $this->getTriggerUser(), $ccMailingList);
-        }
-        catch (Exception $ex) {
-            if (mb_strlen($ex->getMessage()) > 255) {
-                ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
-            }
-
-            $this->markFailed(substr($ex->getMessage(), 0, 255));
-
-            return;
-        }
-
-        $this->markComplete();
-    }
-
-    /**
-     * @return IMediaWikiClient
-     */
-    protected abstract function getMediaWikiClient();
-
-    protected function getMediaWikiHelper()
-    {
-        if ($this->mwHelper === null) {
-            $this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
-        }
-
-        return $this->mwHelper;
-    }
-
-    /** @noinspection PhpUnusedParameterInspection */
-    protected function getCreationReason(Request $request, User $user)
-    {
-        return 'Requested account at [[WP:ACC]], request #' . $request->getId();
-    }
-
-    /**
-     * @param string $name
-     *
-     * @return bool
-     */
-    protected function checkAccountExists($name)
-    {
-        return $this->getMediaWikiHelper()->checkAccountExists($name);
-    }
-
-    protected function markFailed($reason = null, bool $acknowledged = false)
-    {
-        $this->request->setStatus(RequestStatus::HOSPITAL);
-        $this->request->setQueue(null);
-        $this->request->save();
-
-        $this->getNotificationHelper()->requestCreationFailed($this->request, $this->getTriggerUser());
-
-        Logger::hospitalised($this->getDatabase(), $this->request);
-
-        // auto-acknowledge failed creation tasks, as these land in the hospital queue anyway.
-        parent::markFailed($reason, true);
-        Logger::backgroundJobAcknowledged($this->getDatabase(), $this->getJob(), "Auto-acknowledged due to request deferral to hospital queue");
-    }
-
-    /**
-     * @param $user
-     *
-     * @throws ApplicationLogicException
-     */
-    protected function performCreation($user)
-    {
-        $mw = $this->getMediaWikiHelper();
-
-        $reason = $this->getCreationReason($this->request, $user);
-
-        if ($this->checkAccountExists($this->request->getName())) {
-            throw new ApplicationLogicException('Account already exists');
-        }
-
-        $mw->createAccount($this->request->getName(), $this->request->getEmail(), $reason);
-
-        if (!$this->checkAccountExists($this->request->getName())) {
-            throw new ApplicationLogicException('Account creation appeared to succeed but account does not exist.');
-        }
-
-        $this->request->setStatus(RequestStatus::CLOSED);
-        $this->request->save();
-    }
+	/** @var Request */
+	private $request;
+	/**
+	 * @var MediaWikiHelper
+	 * Don't use this directly.
+	 */
+	private $mwHelper = null;
+
+	public function execute()
+	{
+		$this->request = $this->getRequest();
+		$user = $this->getTriggerUser();
+		$parameters = $this->getParameters();
+
+		if ($this->request->getStatus() !== RequestStatus::JOBQUEUE) {
+			$this->markCancelled('Request is not deferred to the job queue');
+
+			return;
+		}
+
+		if ($this->request->getEmailSent() != 0 && !isset($parameters->emailText)) {
+			$this->markFailed('Request has already been sent a templated email');
+
+			return;
+		}
+
+		if ($this->request->getEmail() === $this->getSiteConfiguration()->getDataClearEmail()) {
+			$this->markFailed('Private data of request has been purged.');
+
+			return;
+		}
+
+		$emailText = null;
+		$ccMailingList = null;
+		$logTarget = null;
+
+		if (isset($parameters->emailText) && isset($parameters->ccMailingList)) {
+			$emailText = $parameters->emailText;
+			$ccMailingList = $parameters->ccMailingList;
+			$logTarget = "custom-y";
+		}
+
+		if ($this->getEmailTemplate() !== null) {
+			$emailText = $this->getEmailTemplate()->getText();
+			$ccMailingList = false;
+			$logTarget = $this->getEmailTemplate()->getId();
+		}
+
+		if ($emailText === null || $ccMailingList === null) {
+			$this->markFailed('Unable to get closure email text');
+
+			return;
+		}
+
+		try {
+			$this->performCreation($user);
+
+			$this->request->setStatus(RequestStatus::CLOSED);
+			$this->request->setQueue(null);
+			$this->request->setReserved(null);
+			$this->request->setEmailSent(true);
+			$this->request->save();
+
+			// Log the closure as the user
+			$logComment = $this->getEmailTemplate() === null ? $emailText : null;
+			Logger::closeRequest($this->getDatabase(), $this->request, $logTarget, $logComment, $this->getTriggerUser());
+
+			$requestEmailHelper = new RequestEmailHelper($this->getEmailHelper());
+			$requestEmailHelper->sendMail($this->request, $emailText, $this->getTriggerUser(), $ccMailingList);
+		}
+		catch (Exception $ex) {
+			if (mb_strlen($ex->getMessage()) > 255) {
+				ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
+			}
+
+			$this->markFailed(substr($ex->getMessage(), 0, 255));
+
+			return;
+		}
+
+		$this->markComplete();
+	}
+
+	/**
+	 * @return IMediaWikiClient
+	 */
+	protected abstract function getMediaWikiClient();
+
+	protected function getMediaWikiHelper()
+	{
+		if ($this->mwHelper === null) {
+			$this->mwHelper = new MediaWikiHelper($this->getMediaWikiClient(), $this->getSiteConfiguration());
+		}
+
+		return $this->mwHelper;
+	}
+
+	/** @noinspection PhpUnusedParameterInspection */
+	protected function getCreationReason(Request $request, User $user)
+	{
+		return 'Requested account at [[WP:ACC]], request #' . $request->getId();
+	}
+
+	/**
+	 * @param string $name
+	 *
+	 * @return bool
+	 */
+	protected function checkAccountExists($name)
+	{
+		return $this->getMediaWikiHelper()->checkAccountExists($name);
+	}
+
+	protected function markFailed($reason = null, bool $acknowledged = false)
+	{
+		$this->request->setStatus(RequestStatus::HOSPITAL);
+		$this->request->setQueue(null);
+		$this->request->save();
+
+		$this->getNotificationHelper()->requestCreationFailed($this->request, $this->getTriggerUser());
+
+		Logger::hospitalised($this->getDatabase(), $this->request);
+
+		// auto-acknowledge failed creation tasks, as these land in the hospital queue anyway.
+		parent::markFailed($reason, true);
+		Logger::backgroundJobAcknowledged($this->getDatabase(), $this->getJob(), "Auto-acknowledged due to request deferral to hospital queue");
+	}
+
+	/**
+	 * @param $user
+	 *
+	 * @throws ApplicationLogicException
+	 */
+	protected function performCreation($user)
+	{
+		$mw = $this->getMediaWikiHelper();
+
+		$reason = $this->getCreationReason($this->request, $user);
+
+		if ($this->checkAccountExists($this->request->getName())) {
+			throw new ApplicationLogicException('Account already exists');
+		}
+
+		$mw->createAccount($this->request->getName(), $this->request->getEmail(), $reason);
+
+		if (!$this->checkAccountExists($this->request->getName())) {
+			throw new ApplicationLogicException('Account creation appeared to succeed but account does not exist.');
+		}
+
+		$this->request->setStatus(RequestStatus::CLOSED);
+		$this->request->save();
+	}
 }
\ No newline at end of file

includes/Background/Task/BotCreationTask.php

Indentation +14 added lines, -14 removed lines

@@ -17,20 +17,20 @@
 
 class BotCreationTask extends CreationTaskBase
 {
-    /**
-     * @return IMediaWikiClient
-     */
-    protected function getMediaWikiClient()
-    {
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->getDatabase());
+	/**
+	 * @return IMediaWikiClient
+	 */
+	protected function getMediaWikiClient()
+	{
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->getDatabase());
 
-        return new BotMediaWikiClient($this->getSiteConfiguration(), $domain);
-    }
+		return new BotMediaWikiClient($this->getSiteConfiguration(), $domain);
+	}
 
-    protected function getCreationReason(Request $request, User $user)
-    {
-        return parent::getCreationReason($request, $user) . ', on behalf of [[User:' . $user->getOnWikiName() . ']]';
-    }
+	protected function getCreationReason(Request $request, User $user)
+	{
+		return parent::getCreationReason($request, $user) . ', on behalf of [[User:' . $user->getOnWikiName() . ']]';
+	}
 }
\ No newline at end of file

includes/WebRequest.php

Indentation +603 added lines, -603 removed lines

@@ -25,607 +25,607 @@
  */
 class WebRequest
 {
-    /**
-     * @var IGlobalStateProvider Provides access to the global state.
-     */
-    private static $globalStateProvider;
-
-    /**
-     * Returns a boolean value if the request was submitted with the HTTP POST method.
-     * @return bool
-     */
-    public static function wasPosted()
-    {
-        return self::method() === 'POST';
-    }
-
-    /**
-     * Gets the HTTP Method used
-     * @return string|null
-     */
-    public static function method()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REQUEST_METHOD'])) {
-            return $server['REQUEST_METHOD'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Gets a boolean value stating whether the request was served over HTTPS or not.
-     * @return bool
-     */
-    public static function isHttps()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
-            if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') {
-                // Client <=> Proxy is encrypted
-                return true;
-            }
-            else {
-                // Proxy <=> Server link unknown, Client <=> Proxy is not encrypted.
-                return false;
-            }
-        }
-
-        if (isset($server['HTTPS'])) {
-            if ($server['HTTPS'] === 'off') {
-                // ISAPI on IIS breaks the spec. :(
-                return false;
-            }
-
-            if ($server['HTTPS'] !== '') {
-                // Set to a non-empty value
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Gets the path info
-     *
-     * @return array Array of path info segments
-     */
-    public static function pathInfo()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-        if (!isset($server['PATH_INFO'])) {
-            return array();
-        }
-
-        $exploded = explode('/', $server['PATH_INFO']);
-
-        // filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts
-        // with a /
-        return array_values(array_filter($exploded));
-    }
-
-    /**
-     * Gets the remote address of the web request
-     * @return null|string
-     */
-    public static function remoteAddress()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REMOTE_ADDR'])) {
-            return $server['REMOTE_ADDR'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Gets the remote address of the web request
-     * @return null|string
-     */
-    public static function httpHost()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_HOST'])) {
-            return $server['HTTP_HOST'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Gets the XFF header contents for the web request
-     * @return null|string
-     */
-    public static function forwardedAddress()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_X_FORWARDED_FOR'])) {
-            return $server['HTTP_X_FORWARDED_FOR'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Sets the global state provider.
-     *
-     * Almost guaranteed this is not the method you want in production code.
-     *
-     * @param IGlobalStateProvider $globalState
-     */
-    public static function setGlobalStateProvider($globalState)
-    {
-        self::$globalStateProvider = $globalState;
-    }
-
-    #region POST variables
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function postString($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        if ($post[$key] === "") {
-            return null;
-        }
-
-        return (string)$post[$key];
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function postEmail($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL);
-
-        if ($filteredValue === false) {
-            return null;
-        }
-
-        return (string)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return int|null
-     */
-    public static function postInt($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
-
-        if ($filteredValue === null) {
-            return null;
-        }
-
-        return (int)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return bool
-     */
-    public static function postBoolean($key)
-    {
-        $get = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return false;
-        }
-
-        // presence of parameter only
-        if ($get[$key] === "") {
-            return true;
-        }
-
-        if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
-            return false;
-        }
-
-        return true;
-    }
-
-    #endregion
-
-    #region GET variables
-
-    /**
-     * @param string $key
-     *
-     * @return bool
-     */
-    public static function getBoolean($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return false;
-        }
-
-        // presence of parameter only
-        if ($get[$key] === "") {
-            return true;
-        }
-
-        if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return int|null
-     */
-    public static function getInt($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
-
-        if ($filteredValue === null) {
-            return null;
-        }
-
-        return (int)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function getString($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return null;
-        }
-
-        if ($get[$key] === "") {
-            return null;
-        }
-
-        return (string)$get[$key];
-    }
-
-    #endregion
-
-    /**
-     * Sets the logged-in user to the specified user.
-     *
-     * @param User $user
-     */
-    public static function setLoggedInUser(User $user)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        $session['userID'] = $user->getId();
-        unset($session['partialLogin']);
-    }
-
-    public static function setActiveDomain(Domain $domain)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        $session['domainID'] = $domain->getId();
-    }
-
-    /**
-     * Sets the post-login redirect
-     *
-     * @param string|null $uri The URI to redirect to
-     */
-    public static function setPostLoginRedirect($uri = null)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        if ($uri === null) {
-            $uri = self::requestUri();
-        }
-
-        $session['returnTo'] = $uri;
-    }
-
-    /**
-     * @return string|null
-     */
-    public static function requestUri()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REQUEST_URI'])) {
-            return $server['REQUEST_URI'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Clears the post-login redirect
-     * @return string
-     */
-    public static function clearPostLoginRedirect()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('returnTo', $session)) {
-            $path = $session['returnTo'];
-            unset($session['returnTo']);
-
-            return $path;
-        }
-
-        return null;
-    }
-
-    /**
-     * @return string|null
-     */
-    public static function serverName()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['SERVER_NAME'])) {
-            return $server['SERVER_NAME'];
-        }
-
-        return null;
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     * @return void
-     */
-    public static function clearSessionAlertData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('alerts', $session)) {
-            unset($session['alerts']);
-        }
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     *
-     * @return string[]
-     */
-    public static function getSessionAlertData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('alerts', $session)) {
-            return $session['alerts'];
-        }
-
-        return array();
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     *
-     * @param string[] $data
-     */
-    public static function setSessionAlertData($data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['alerts'] = $data;
-    }
-
-    /**
-     * You probably only want to deal with this through TokenManager.
-     *
-     * @return string[]
-     */
-    public static function getSessionTokenData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('tokens', $session)) {
-            return $session['tokens'];
-        }
-
-        return array();
-    }
-
-    /**
-     * You probably only want to deal with this through TokenManager.
-     *
-     * @param string[] $data
-     */
-    public static function setSessionTokenData($data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['tokens'] = $data;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return mixed
-     */
-    public static function getSessionContext($key)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        if (!isset($session['context'])) {
-            $session['context'] = array();
-        }
-
-        if (!isset($session['context'][$key])) {
-            return null;
-        }
-
-        return $session['context'][$key];
-    }
-
-    /**
-     * @param string $key
-     * @param mixed  $data
-     */
-    public static function setSessionContext($key, $data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        if (!isset($session['context'])) {
-            $session['context'] = array();
-        }
-
-        $session['context'][$key] = $data;
-    }
-
-    /**
-     * @return int|null
-     */
-    public static function getSessionUserId()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        return isset($session['userID']) ? (int)$session['userID'] : null;
-    }
-
-    /**
-     * @return int|null
-     */
-    public static function getSessionDomain()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        return isset($session['domainID']) ? (int)$session['domainID'] : null;
-    }
-
-    /**
-     * @param User $user
-     */
-    public static function setOAuthPartialLogin(User $user)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['oauthPartialLogin'] = $user->getId();
-    }
-
-    /**
-     * @return int|null
-     */
-    public static function getOAuthPartialLogin()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        return isset($session['oauthPartialLogin']) ? (int)$session['oauthPartialLogin'] : null;
-    }
-
-    public static function setAuthPartialLogin($userId, $stage)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['authPartialLoginId'] = $userId;
-        $session['authPartialLoginStage'] = $stage;
-    }
-
-    public static function getAuthPartialLogin()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        $userId = isset($session['authPartialLoginId']) ? (int)$session['authPartialLoginId'] : null;
-        $stage = isset($session['authPartialLoginStage']) ? (int)$session['authPartialLoginStage'] : null;
-
-        return array($userId, $stage);
-    }
-
-    public static function clearAuthPartialLogin()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        unset($session['authPartialLoginId']);
-        unset($session['authPartialLoginStage']);
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function userAgent()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_USER_AGENT'])) {
-            return $server['HTTP_USER_AGENT'];
-        }
-
-        return null;
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function scriptName()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['SCRIPT_NAME'])) {
-            return $server['SCRIPT_NAME'];
-        }
-
-        return null;
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function origin()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_ORIGIN'])) {
-            return $server['HTTP_ORIGIN'];
-        }
-
-        return null;
-    }
-
-    public static function testSiteNoticeCookieValue($expectedHash)
-    {
-        $cookie = &self::$globalStateProvider->getCookieSuperGlobal();
-
-        if (isset($cookie['sitenotice'])) {
-            return $cookie['sitenotice'] === $expectedHash;
-        }
-
-        return false;
-    }
-
-    public static function requestListDefaultSort()
-    {
-        $cookie = &self::$globalStateProvider->getCookieSuperGlobal();
-
-        if (isset($cookie['request_table_sort'])) {
-            return explode('/', $cookie['request_table_sort'], 2);
-        }
-        else {
-            return ['id', 'asc'];
-        }
-    }
+	/**
+	 * @var IGlobalStateProvider Provides access to the global state.
+	 */
+	private static $globalStateProvider;
+
+	/**
+	 * Returns a boolean value if the request was submitted with the HTTP POST method.
+	 * @return bool
+	 */
+	public static function wasPosted()
+	{
+		return self::method() === 'POST';
+	}
+
+	/**
+	 * Gets the HTTP Method used
+	 * @return string|null
+	 */
+	public static function method()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REQUEST_METHOD'])) {
+			return $server['REQUEST_METHOD'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Gets a boolean value stating whether the request was served over HTTPS or not.
+	 * @return bool
+	 */
+	public static function isHttps()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
+			if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') {
+				// Client <=> Proxy is encrypted
+				return true;
+			}
+			else {
+				// Proxy <=> Server link unknown, Client <=> Proxy is not encrypted.
+				return false;
+			}
+		}
+
+		if (isset($server['HTTPS'])) {
+			if ($server['HTTPS'] === 'off') {
+				// ISAPI on IIS breaks the spec. :(
+				return false;
+			}
+
+			if ($server['HTTPS'] !== '') {
+				// Set to a non-empty value
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Gets the path info
+	 *
+	 * @return array Array of path info segments
+	 */
+	public static function pathInfo()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+		if (!isset($server['PATH_INFO'])) {
+			return array();
+		}
+
+		$exploded = explode('/', $server['PATH_INFO']);
+
+		// filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts
+		// with a /
+		return array_values(array_filter($exploded));
+	}
+
+	/**
+	 * Gets the remote address of the web request
+	 * @return null|string
+	 */
+	public static function remoteAddress()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REMOTE_ADDR'])) {
+			return $server['REMOTE_ADDR'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Gets the remote address of the web request
+	 * @return null|string
+	 */
+	public static function httpHost()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_HOST'])) {
+			return $server['HTTP_HOST'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Gets the XFF header contents for the web request
+	 * @return null|string
+	 */
+	public static function forwardedAddress()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_X_FORWARDED_FOR'])) {
+			return $server['HTTP_X_FORWARDED_FOR'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Sets the global state provider.
+	 *
+	 * Almost guaranteed this is not the method you want in production code.
+	 *
+	 * @param IGlobalStateProvider $globalState
+	 */
+	public static function setGlobalStateProvider($globalState)
+	{
+		self::$globalStateProvider = $globalState;
+	}
+
+	#region POST variables
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function postString($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		if ($post[$key] === "") {
+			return null;
+		}
+
+		return (string)$post[$key];
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function postEmail($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL);
+
+		if ($filteredValue === false) {
+			return null;
+		}
+
+		return (string)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return int|null
+	 */
+	public static function postInt($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
+
+		if ($filteredValue === null) {
+			return null;
+		}
+
+		return (int)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return bool
+	 */
+	public static function postBoolean($key)
+	{
+		$get = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return false;
+		}
+
+		// presence of parameter only
+		if ($get[$key] === "") {
+			return true;
+		}
+
+		if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	#endregion
+
+	#region GET variables
+
+	/**
+	 * @param string $key
+	 *
+	 * @return bool
+	 */
+	public static function getBoolean($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return false;
+		}
+
+		// presence of parameter only
+		if ($get[$key] === "") {
+			return true;
+		}
+
+		if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return int|null
+	 */
+	public static function getInt($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
+
+		if ($filteredValue === null) {
+			return null;
+		}
+
+		return (int)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function getString($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return null;
+		}
+
+		if ($get[$key] === "") {
+			return null;
+		}
+
+		return (string)$get[$key];
+	}
+
+	#endregion
+
+	/**
+	 * Sets the logged-in user to the specified user.
+	 *
+	 * @param User $user
+	 */
+	public static function setLoggedInUser(User $user)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		$session['userID'] = $user->getId();
+		unset($session['partialLogin']);
+	}
+
+	public static function setActiveDomain(Domain $domain)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		$session['domainID'] = $domain->getId();
+	}
+
+	/**
+	 * Sets the post-login redirect
+	 *
+	 * @param string|null $uri The URI to redirect to
+	 */
+	public static function setPostLoginRedirect($uri = null)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		if ($uri === null) {
+			$uri = self::requestUri();
+		}
+
+		$session['returnTo'] = $uri;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public static function requestUri()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REQUEST_URI'])) {
+			return $server['REQUEST_URI'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Clears the post-login redirect
+	 * @return string
+	 */
+	public static function clearPostLoginRedirect()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('returnTo', $session)) {
+			$path = $session['returnTo'];
+			unset($session['returnTo']);
+
+			return $path;
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public static function serverName()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['SERVER_NAME'])) {
+			return $server['SERVER_NAME'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 * @return void
+	 */
+	public static function clearSessionAlertData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('alerts', $session)) {
+			unset($session['alerts']);
+		}
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 *
+	 * @return string[]
+	 */
+	public static function getSessionAlertData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('alerts', $session)) {
+			return $session['alerts'];
+		}
+
+		return array();
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 *
+	 * @param string[] $data
+	 */
+	public static function setSessionAlertData($data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['alerts'] = $data;
+	}
+
+	/**
+	 * You probably only want to deal with this through TokenManager.
+	 *
+	 * @return string[]
+	 */
+	public static function getSessionTokenData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('tokens', $session)) {
+			return $session['tokens'];
+		}
+
+		return array();
+	}
+
+	/**
+	 * You probably only want to deal with this through TokenManager.
+	 *
+	 * @param string[] $data
+	 */
+	public static function setSessionTokenData($data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['tokens'] = $data;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return mixed
+	 */
+	public static function getSessionContext($key)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		if (!isset($session['context'])) {
+			$session['context'] = array();
+		}
+
+		if (!isset($session['context'][$key])) {
+			return null;
+		}
+
+		return $session['context'][$key];
+	}
+
+	/**
+	 * @param string $key
+	 * @param mixed  $data
+	 */
+	public static function setSessionContext($key, $data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		if (!isset($session['context'])) {
+			$session['context'] = array();
+		}
+
+		$session['context'][$key] = $data;
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public static function getSessionUserId()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		return isset($session['userID']) ? (int)$session['userID'] : null;
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public static function getSessionDomain()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		return isset($session['domainID']) ? (int)$session['domainID'] : null;
+	}
+
+	/**
+	 * @param User $user
+	 */
+	public static function setOAuthPartialLogin(User $user)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['oauthPartialLogin'] = $user->getId();
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public static function getOAuthPartialLogin()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		return isset($session['oauthPartialLogin']) ? (int)$session['oauthPartialLogin'] : null;
+	}
+
+	public static function setAuthPartialLogin($userId, $stage)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['authPartialLoginId'] = $userId;
+		$session['authPartialLoginStage'] = $stage;
+	}
+
+	public static function getAuthPartialLogin()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		$userId = isset($session['authPartialLoginId']) ? (int)$session['authPartialLoginId'] : null;
+		$stage = isset($session['authPartialLoginStage']) ? (int)$session['authPartialLoginStage'] : null;
+
+		return array($userId, $stage);
+	}
+
+	public static function clearAuthPartialLogin()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		unset($session['authPartialLoginId']);
+		unset($session['authPartialLoginStage']);
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function userAgent()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_USER_AGENT'])) {
+			return $server['HTTP_USER_AGENT'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function scriptName()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['SCRIPT_NAME'])) {
+			return $server['SCRIPT_NAME'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function origin()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_ORIGIN'])) {
+			return $server['HTTP_ORIGIN'];
+		}
+
+		return null;
+	}
+
+	public static function testSiteNoticeCookieValue($expectedHash)
+	{
+		$cookie = &self::$globalStateProvider->getCookieSuperGlobal();
+
+		if (isset($cookie['sitenotice'])) {
+			return $cookie['sitenotice'] === $expectedHash;
+		}
+
+		return false;
+	}
+
+	public static function requestListDefaultSort()
+	{
+		$cookie = &self::$globalStateProvider->getCookieSuperGlobal();
+
+		if (isset($cookie['request_table_sort'])) {
+			return explode('/', $cookie['request_table_sort'], 2);
+		}
+		else {
+			return ['id', 'asc'];
+		}
+	}
 }

includes/DataObjects/UserDomain.php

Indentation +52 added lines, -52 removed lines

@@ -13,72 +13,72 @@
 
 class UserDomain extends DataObject
 {
-    /** @var int */
-    private $user;
+	/** @var int */
+	private $user;
 
-    /** @var int */
-    private $domain;
+	/** @var int */
+	private $domain;
 
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO userdomain (
                     user, domain
                 ) VALUES (
                     :user, :domain
                 );
 SQL
-            );
+			);
 
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":domain", $this->domain);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":domain", $this->domain);
 
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // insert / delete only, no updates please.
-            throw new Exception('Updating domain membership is not available');
-        }
-    }
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// insert / delete only, no updates please.
+			throw new Exception('Updating domain membership is not available');
+		}
+	}
 
-    /**
-     * @return int
-     */
-    public function getUser(): int
-    {
-        return $this->user;
-    }
+	/**
+	 * @return int
+	 */
+	public function getUser(): int
+	{
+		return $this->user;
+	}
 
-    /**
-     * @param int $user
-     */
-    public function setUser(int $user): void
-    {
-        $this->user = $user;
-    }
+	/**
+	 * @param int $user
+	 */
+	public function setUser(int $user): void
+	{
+		$this->user = $user;
+	}
 
-    /**
-     * @return int
-     */
-    public function getDomain(): int
-    {
-        return $this->domain;
-    }
+	/**
+	 * @return int
+	 */
+	public function getDomain(): int
+	{
+		return $this->domain;
+	}
 
-    /**
-     * @param int $domain
-     */
-    public function setDomain(int $domain): void
-    {
-        $this->domain = $domain;
-    }
+	/**
+	 * @param int $domain
+	 */
+	public function setDomain(int $domain): void
+	{
+		$this->domain = $domain;
+	}
 
 
 }
\ No newline at end of file