stwalkerster / waca

includes/SiteConfiguration.php

Indentation +1008 added lines, -1008 removed lines

@@ -17,1013 +17,1013 @@
  */
 class SiteConfiguration
 {
-    private $baseUrl;
-    private $filePath;
-    private $schemaVersion = 42;
-    private $debuggingTraceEnabled;
-    private $debuggingCssBreakpointsEnabled;
-    private $dataClearIp = '127.0.0.1';
-    private $dataClearEmail = 'acc@toolserver.org';
-    private $dataClearInterval = '15 DAY';
-    private $forceIdentification = true;
-    private $identificationCacheExpiry = '1 DAY';
-    private $metaWikimediaWebServiceEndpoint = 'https://meta.wikimedia.org/w/api.php';
-    private $enforceOAuth = true;
-    private $emailConfirmationEnabled = true;
-    private $emailConfirmationExpiryDays = 7;
-    private $miserModeLimit = 25;
-    private $squidList = array();
-    private $useStrictTransportSecurity = false;
-    private $userAgent = 'Wikipedia-ACC Tool/0.1 (+https://accounts.wmflabs.org/internal.php/team)';
-    private $curlDisableVerifyPeer = false;
-    private $useOAuthSignup = true;
-    private $oauthConsumerToken;
-    /** @var array */
-    private $oauthLegacyConsumerTokens;
-    private $oauthConsumerSecret;
-    private $oauthIdentityGraceTime = '24 hours';
-    private $oauthMediaWikiCanonicalServer = 'http://en.wikipedia.org';
-    private $xffTrustedHostsFile = '../TrustedXFF/trusted-hosts.txt';
-    private $crossOriginResourceSharingHosts = array(
-        "http://en.wikipedia.org",
-        "https://en.wikipedia.org",
-        "http://meta.wikimedia.org",
-        "https://meta.wikimedia.org",
-    );
-    private $ircNotificationsEnabled = true;
-    private $ircNotificationsInstance = 'Development';
-    private $errorLog = 'errorlog';
-    private $titleBlacklistEnabled = false;
-    /** @var null|string $locationProviderApiKey */
-    private $locationProviderApiKey = null;
-    private $torExitPaths = array();
-    private $creationBotUsername = '';
-    private $creationBotPassword = '';
-    private $curlCookieJar = null;
-    private $yubicoApiId = 0;
-    private $yubicoApiKey = "";
-    private $totpEncryptionKey = "1234";
-    private $identificationNoticeboardPage = 'Access to nonpublic personal data policy/Noticeboard';
-    private $registrationAllowed = true;
-    private $cspReportUri = null;
-    private $resourceCacheEpoch = 1;
-    private $commonEmailDomains = [];
-    private $banMaxIpBlockRange = [4 => 20, 6 => 48];
-    private $banMaxIpRange = [4 => 16, 6 => 32];
-    private $jobQueueBatchSize = 10;
-    private $amqpConfiguration = ['host' => 'localhost', 'port' => 5672, 'user' => 'guest', 'password' => 'guest', 'exchange' => ''];
-    private $emailSender = 'accounts@wmflabs.org';
-
-    /**
-     * Gets the base URL of the tool
-     *
-     * If the internal page of the tool is at http://localhost/path/internal.php, this would be set to
-     * http://localhost/path
-     * @return string
-     */
-    public function getBaseUrl()
-    {
-        return $this->baseUrl;
-    }
-
-    /**
-     * @param string $baseUrl
-     *
-     * @return SiteConfiguration
-     */
-    public function setBaseUrl($baseUrl)
-    {
-        $this->baseUrl = $baseUrl;
-
-        return $this;
-    }
-
-    /**
-     * Path on disk to the directory containing the tool's code
-     * @return string
-     */
-    public function getFilePath()
-    {
-        return $this->filePath;
-    }
-
-    /**
-     * @param string $filePath
-     *
-     * @return SiteConfiguration
-     */
-    public function setFilePath($filePath)
-    {
-        $this->filePath = $filePath;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getSchemaVersion()
-    {
-        return $this->schemaVersion;
-    }
-
-    /**
-     * @param int $schemaVersion
-     *
-     * @return SiteConfiguration
-     */
-    public function setSchemaVersion($schemaVersion)
-    {
-        $this->schemaVersion = $schemaVersion;
-
-        return $this;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getDebuggingTraceEnabled()
-    {
-        return $this->debuggingTraceEnabled;
-    }
-
-    /**
-     * @param mixed $debuggingTraceEnabled
-     *
-     * @return SiteConfiguration
-     */
-    public function setDebuggingTraceEnabled($debuggingTraceEnabled)
-    {
-        $this->debuggingTraceEnabled = $debuggingTraceEnabled;
-
-        return $this;
-    }
-
-    public function getDebuggingCssBreakpointsEnabled() : bool
-    {
-        return $this->debuggingCssBreakpointsEnabled;
-    }
-
-    public function setDebuggingCssBreakpointsEnabled(bool $debuggingCssBreakpointsEnabled) : SiteConfiguration
-    {
-        $this->debuggingCssBreakpointsEnabled = $debuggingCssBreakpointsEnabled;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDataClearIp()
-    {
-        return $this->dataClearIp;
-    }
-
-    /**
-     * @param string $dataClearIp
-     *
-     * @return SiteConfiguration
-     */
-    public function setDataClearIp($dataClearIp)
-    {
-        $this->dataClearIp = $dataClearIp;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDataClearEmail()
-    {
-        return $this->dataClearEmail;
-    }
-
-    /**
-     * @param string $dataClearEmail
-     *
-     * @return SiteConfiguration
-     */
-    public function setDataClearEmail($dataClearEmail)
-    {
-        $this->dataClearEmail = $dataClearEmail;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getForceIdentification()
-    {
-        return $this->forceIdentification;
-    }
-
-    /**
-     * @param boolean $forceIdentification
-     *
-     * @return SiteConfiguration
-     */
-    public function setForceIdentification($forceIdentification)
-    {
-        $this->forceIdentification = $forceIdentification;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getIdentificationCacheExpiry()
-    {
-        return $this->identificationCacheExpiry;
-    }
-
-    /**
-     * @param string $identificationCacheExpiry
-     *
-     * @return SiteConfiguration
-     */
-    public function setIdentificationCacheExpiry($identificationCacheExpiry)
-    {
-        $this->identificationCacheExpiry = $identificationCacheExpiry;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getMetaWikimediaWebServiceEndpoint()
-    {
-        return $this->metaWikimediaWebServiceEndpoint;
-    }
-
-    /**
-     * @param string $metaWikimediaWebServiceEndpoint
-     *
-     * @return SiteConfiguration
-     */
-    public function setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
-    {
-        $this->metaWikimediaWebServiceEndpoint = $metaWikimediaWebServiceEndpoint;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getEnforceOAuth()
-    {
-        return $this->enforceOAuth;
-    }
-
-    /**
-     * @param boolean $enforceOAuth
-     *
-     * @return SiteConfiguration
-     */
-    public function setEnforceOAuth($enforceOAuth)
-    {
-        $this->enforceOAuth = $enforceOAuth;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getEmailConfirmationEnabled()
-    {
-        return $this->emailConfirmationEnabled;
-    }
-
-    /**
-     * @param boolean $emailConfirmationEnabled
-     *
-     * @return $this
-     */
-    public function setEmailConfirmationEnabled($emailConfirmationEnabled)
-    {
-        $this->emailConfirmationEnabled = $emailConfirmationEnabled;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getMiserModeLimit()
-    {
-        return $this->miserModeLimit;
-    }
-
-    /**
-     * @param int $miserModeLimit
-     *
-     * @return SiteConfiguration
-     */
-    public function setMiserModeLimit($miserModeLimit)
-    {
-        $this->miserModeLimit = $miserModeLimit;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getSquidList()
-    {
-        return $this->squidList;
-    }
-
-    /**
-     * @param array $squidList
-     *
-     * @return SiteConfiguration
-     */
-    public function setSquidList($squidList)
-    {
-        $this->squidList = $squidList;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getUseStrictTransportSecurity()
-    {
-        return $this->useStrictTransportSecurity;
-    }
-
-    /**
-     * @param boolean $useStrictTransportSecurity
-     *
-     * @return SiteConfiguration
-     */
-    public function setUseStrictTransportSecurity($useStrictTransportSecurity)
-    {
-        $this->useStrictTransportSecurity = $useStrictTransportSecurity;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getUserAgent()
-    {
-        return $this->userAgent;
-    }
-
-    /**
-     * @param string $userAgent
-     *
-     * @return SiteConfiguration
-     */
-    public function setUserAgent($userAgent)
-    {
-        $this->userAgent = $userAgent;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getCurlDisableVerifyPeer()
-    {
-        return $this->curlDisableVerifyPeer;
-    }
-
-    /**
-     * @param boolean $curlDisableVerifyPeer
-     *
-     * @return SiteConfiguration
-     */
-    public function setCurlDisableVerifyPeer($curlDisableVerifyPeer)
-    {
-        $this->curlDisableVerifyPeer = $curlDisableVerifyPeer;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getUseOAuthSignup()
-    {
-        return $this->useOAuthSignup;
-    }
-
-    /**
-     * @param boolean $useOAuthSignup
-     *
-     * @return SiteConfiguration
-     */
-    public function setUseOAuthSignup($useOAuthSignup)
-    {
-        $this->useOAuthSignup = $useOAuthSignup;
-
-        return $this;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getOAuthConsumerToken()
-    {
-        return $this->oauthConsumerToken;
-    }
-
-    /**
-     * @param mixed $oauthConsumerToken
-     *
-     * @return SiteConfiguration
-     */
-    public function setOAuthConsumerToken($oauthConsumerToken)
-    {
-        $this->oauthConsumerToken = $oauthConsumerToken;
-
-        return $this;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getOAuthConsumerSecret()
-    {
-        return $this->oauthConsumerSecret;
-    }
-
-    /**
-     * @param mixed $oauthConsumerSecret
-     *
-     * @return SiteConfiguration
-     */
-    public function setOAuthConsumerSecret($oauthConsumerSecret)
-    {
-        $this->oauthConsumerSecret = $oauthConsumerSecret;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDataClearInterval()
-    {
-        return $this->dataClearInterval;
-    }
-
-    /**
-     * @param string $dataClearInterval
-     *
-     * @return SiteConfiguration
-     */
-    public function setDataClearInterval($dataClearInterval)
-    {
-        $this->dataClearInterval = $dataClearInterval;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getXffTrustedHostsFile()
-    {
-        return $this->xffTrustedHostsFile;
-    }
-
-    /**
-     * @param string $xffTrustedHostsFile
-     *
-     * @return SiteConfiguration
-     */
-    public function setXffTrustedHostsFile($xffTrustedHostsFile)
-    {
-        $this->xffTrustedHostsFile = $xffTrustedHostsFile;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getCrossOriginResourceSharingHosts()
-    {
-        return $this->crossOriginResourceSharingHosts;
-    }
-
-    /**
-     * @param array $crossOriginResourceSharingHosts
-     *
-     * @return SiteConfiguration
-     */
-    public function setCrossOriginResourceSharingHosts($crossOriginResourceSharingHosts)
-    {
-        $this->crossOriginResourceSharingHosts = $crossOriginResourceSharingHosts;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getIrcNotificationsEnabled()
-    {
-        return $this->ircNotificationsEnabled;
-    }
-
-    /**
-     * @param boolean $ircNotificationsEnabled
-     *
-     * @return SiteConfiguration
-     */
-    public function setIrcNotificationsEnabled($ircNotificationsEnabled)
-    {
-        $this->ircNotificationsEnabled = $ircNotificationsEnabled;
-
-        return $this;
-    }
-
-    /**
-     * @param string $errorLog
-     *
-     * @return SiteConfiguration
-     */
-    public function setErrorLog($errorLog)
-    {
-        $this->errorLog = $errorLog;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getErrorLog()
-    {
-        return $this->errorLog;
-    }
-
-    /**
-     * @param int $emailConfirmationExpiryDays
-     *
-     * @return SiteConfiguration
-     */
-    public function setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
-    {
-        $this->emailConfirmationExpiryDays = $emailConfirmationExpiryDays;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getEmailConfirmationExpiryDays()
-    {
-        return $this->emailConfirmationExpiryDays;
-    }
-
-    /**
-     * @param string $ircNotificationsInstance
-     *
-     * @return SiteConfiguration
-     */
-    public function setIrcNotificationsInstance($ircNotificationsInstance)
-    {
-        $this->ircNotificationsInstance = $ircNotificationsInstance;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getIrcNotificationsInstance()
-    {
-        return $this->ircNotificationsInstance;
-    }
-
-    /**
-     * @param boolean $titleBlacklistEnabled
-     *
-     * @return SiteConfiguration
-     */
-    public function setTitleBlacklistEnabled($titleBlacklistEnabled)
-    {
-        $this->titleBlacklistEnabled = $titleBlacklistEnabled;
-
-        return $this;
-    }
-
-    /**
-     * @return boolean
-     */
-    public function getTitleBlacklistEnabled()
-    {
-        return $this->titleBlacklistEnabled;
-    }
-
-    /**
-     * @param string|null $locationProviderApiKey
-     *
-     * @return SiteConfiguration
-     */
-    public function setLocationProviderApiKey($locationProviderApiKey)
-    {
-        $this->locationProviderApiKey = $locationProviderApiKey;
-
-        return $this;
-    }
-
-    /**
-     * @return null|string
-     */
-    public function getLocationProviderApiKey()
-    {
-        return $this->locationProviderApiKey;
-    }
-
-    /**
-     * @param array $torExitPaths
-     *
-     * @return SiteConfiguration
-     */
-    public function setTorExitPaths($torExitPaths)
-    {
-        $this->torExitPaths = $torExitPaths;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getTorExitPaths()
-    {
-        return $this->torExitPaths;
-    }
-
-    /**
-     * @param string $oauthIdentityGraceTime
-     *
-     * @return SiteConfiguration
-     */
-    public function setOauthIdentityGraceTime($oauthIdentityGraceTime)
-    {
-        $this->oauthIdentityGraceTime = $oauthIdentityGraceTime;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getOauthIdentityGraceTime()
-    {
-        return $this->oauthIdentityGraceTime;
-    }
-
-    /**
-     * @param string $oauthMediaWikiCanonicalServer
-     *
-     * @return SiteConfiguration
-     */
-    public function setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
-    {
-        $this->oauthMediaWikiCanonicalServer = $oauthMediaWikiCanonicalServer;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getOauthMediaWikiCanonicalServer()
-    {
-        return $this->oauthMediaWikiCanonicalServer;
-    }
-
-    /**
-     * @param string $creationBotUsername
-     *
-     * @return SiteConfiguration
-     */
-    public function setCreationBotUsername($creationBotUsername)
-    {
-        $this->creationBotUsername = $creationBotUsername;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCreationBotUsername()
-    {
-        return $this->creationBotUsername;
-    }
-
-    /**
-     * @param string $creationBotPassword
-     *
-     * @return SiteConfiguration
-     */
-    public function setCreationBotPassword($creationBotPassword)
-    {
-        $this->creationBotPassword = $creationBotPassword;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getCreationBotPassword()
-    {
-        return $this->creationBotPassword;
-    }
-
-    /**
-     * @param string|null $curlCookieJar
-     *
-     * @return SiteConfiguration
-     */
-    public function setCurlCookieJar($curlCookieJar)
-    {
-        $this->curlCookieJar = $curlCookieJar;
-
-        return $this;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getCurlCookieJar()
-    {
-        return $this->curlCookieJar;
-    }
-
-    public function getYubicoApiId()
-    {
-        return $this->yubicoApiId;
-    }
-
-    public function setYubicoApiId($id)
-    {
-        $this->yubicoApiId = $id;
-
-        return $this;
-    }
-
-    public function getYubicoApiKey()
-    {
-        return $this->yubicoApiKey;
-    }
-
-    public function setYubicoApiKey($key)
-    {
-        $this->yubicoApiKey = $key;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getTotpEncryptionKey()
-    {
-        return $this->totpEncryptionKey;
-    }
-
-    /**
-     * @param string $totpEncryptionKey
-     *
-     * @return SiteConfiguration
-     */
-    public function setTotpEncryptionKey($totpEncryptionKey)
-    {
-        $this->totpEncryptionKey = $totpEncryptionKey;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getIdentificationNoticeboardPage()
-    {
-        return $this->identificationNoticeboardPage;
-    }
-
-    /**
-     * @param string $identificationNoticeboardPage
-     *
-     * @return SiteConfiguration
-     */
-    public function setIdentificationNoticeboardPage($identificationNoticeboardPage)
-    {
-        $this->identificationNoticeboardPage = $identificationNoticeboardPage;
-
-        return $this;
-    }
-
-    public function isRegistrationAllowed(): bool
-    {
-        return $this->registrationAllowed;
-    }
-
-    public function setRegistrationAllowed(bool $registrationAllowed): SiteConfiguration
-    {
-        $this->registrationAllowed = $registrationAllowed;
-
-        return $this;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getCspReportUri()
-    {
-        return $this->cspReportUri;
-    }
-
-    /**
-     * @param string|null $cspReportUri
-     *
-     * @return SiteConfiguration
-     */
-    public function setCspReportUri($cspReportUri)
-    {
-        $this->cspReportUri = $cspReportUri;
-
-        return $this;
-    }
-
-    /**
-     * @return int
-     */
-    public function getResourceCacheEpoch(): int
-    {
-        return $this->resourceCacheEpoch;
-    }
-
-    /**
-     * @param int $resourceCacheEpoch
-     *
-     * @return SiteConfiguration
-     */
-    public function setResourceCacheEpoch(int $resourceCacheEpoch): SiteConfiguration
-    {
-        $this->resourceCacheEpoch = $resourceCacheEpoch;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getCommonEmailDomains(): array
-    {
-        return $this->commonEmailDomains;
-    }
-
-    /**
-     * @param array $commonEmailDomains
-     *
-     * @return SiteConfiguration
-     */
-    public function setCommonEmailDomains(array $commonEmailDomains): SiteConfiguration
-    {
-        $this->commonEmailDomains = $commonEmailDomains;
-
-        return $this;
-    }
-
-    /**
-     * @param int[] $banMaxIpBlockRange
-     *
-     * @return SiteConfiguration
-     */
-    public function setBanMaxIpBlockRange(array $banMaxIpBlockRange): SiteConfiguration
-    {
-        $this->banMaxIpBlockRange = $banMaxIpBlockRange;
-
-        return $this;
-    }
-
-    /**
-     * @return int[]
-     */
-    public function getBanMaxIpBlockRange(): array
-    {
-        return $this->banMaxIpBlockRange;
-    }
-
-    /**
-     * @param int[] $banMaxIpRange
-     *
-     * @return SiteConfiguration
-     */
-    public function setBanMaxIpRange(array $banMaxIpRange): SiteConfiguration
-    {
-        $this->banMaxIpRange = $banMaxIpRange;
-
-        return $this;
-    }
-
-    /**
-     * @return int[]
-     */
-    public function getBanMaxIpRange(): array
-    {
-        return $this->banMaxIpRange;
-    }
-
-    /**
-     * @param array $oauthLegacyConsumerTokens
-     *
-     * @return SiteConfiguration
-     */
-    public function setOauthLegacyConsumerTokens(array $oauthLegacyConsumerTokens): SiteConfiguration
-    {
-        $this->oauthLegacyConsumerTokens = $oauthLegacyConsumerTokens;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getOauthLegacyConsumerTokens(): array
-    {
-        return $this->oauthLegacyConsumerTokens;
-    }
-
-    /**
-     * @return int
-     */
-    public function getJobQueueBatchSize(): int
-    {
-        return $this->jobQueueBatchSize;
-    }
-
-    /**
-     * @param int $jobQueueBatchSize
-     *
-     * @return SiteConfiguration
-     */
-    public function setJobQueueBatchSize(int $jobQueueBatchSize): SiteConfiguration
-    {
-        $this->jobQueueBatchSize = $jobQueueBatchSize;
-
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getAmqpConfiguration(): array
-    {
-        return $this->amqpConfiguration;
-    }
-
-    /**
-     * @param array $amqpConfiguration
-     *
-     * @return SiteConfiguration
-     */
-    public function setAmqpConfiguration(array $amqpConfiguration): SiteConfiguration
-    {
-        $this->amqpConfiguration = $amqpConfiguration;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getEmailSender(): string
-    {
-        return $this->emailSender;
-    }
-
-    /**
-     * @param string $emailSender
-     *
-     * @return SiteConfiguration
-     */
-    public function setEmailSender(string $emailSender): SiteConfiguration
-    {
-        $this->emailSender = $emailSender;
-
-        return $this;
+	private $baseUrl;
+	private $filePath;
+	private $schemaVersion = 42;
+	private $debuggingTraceEnabled;
+	private $debuggingCssBreakpointsEnabled;
+	private $dataClearIp = '127.0.0.1';
+	private $dataClearEmail = 'acc@toolserver.org';
+	private $dataClearInterval = '15 DAY';
+	private $forceIdentification = true;
+	private $identificationCacheExpiry = '1 DAY';
+	private $metaWikimediaWebServiceEndpoint = 'https://meta.wikimedia.org/w/api.php';
+	private $enforceOAuth = true;
+	private $emailConfirmationEnabled = true;
+	private $emailConfirmationExpiryDays = 7;
+	private $miserModeLimit = 25;
+	private $squidList = array();
+	private $useStrictTransportSecurity = false;
+	private $userAgent = 'Wikipedia-ACC Tool/0.1 (+https://accounts.wmflabs.org/internal.php/team)';
+	private $curlDisableVerifyPeer = false;
+	private $useOAuthSignup = true;
+	private $oauthConsumerToken;
+	/** @var array */
+	private $oauthLegacyConsumerTokens;
+	private $oauthConsumerSecret;
+	private $oauthIdentityGraceTime = '24 hours';
+	private $oauthMediaWikiCanonicalServer = 'http://en.wikipedia.org';
+	private $xffTrustedHostsFile = '../TrustedXFF/trusted-hosts.txt';
+	private $crossOriginResourceSharingHosts = array(
+		"http://en.wikipedia.org",
+		"https://en.wikipedia.org",
+		"http://meta.wikimedia.org",
+		"https://meta.wikimedia.org",
+	);
+	private $ircNotificationsEnabled = true;
+	private $ircNotificationsInstance = 'Development';
+	private $errorLog = 'errorlog';
+	private $titleBlacklistEnabled = false;
+	/** @var null|string $locationProviderApiKey */
+	private $locationProviderApiKey = null;
+	private $torExitPaths = array();
+	private $creationBotUsername = '';
+	private $creationBotPassword = '';
+	private $curlCookieJar = null;
+	private $yubicoApiId = 0;
+	private $yubicoApiKey = "";
+	private $totpEncryptionKey = "1234";
+	private $identificationNoticeboardPage = 'Access to nonpublic personal data policy/Noticeboard';
+	private $registrationAllowed = true;
+	private $cspReportUri = null;
+	private $resourceCacheEpoch = 1;
+	private $commonEmailDomains = [];
+	private $banMaxIpBlockRange = [4 => 20, 6 => 48];
+	private $banMaxIpRange = [4 => 16, 6 => 32];
+	private $jobQueueBatchSize = 10;
+	private $amqpConfiguration = ['host' => 'localhost', 'port' => 5672, 'user' => 'guest', 'password' => 'guest', 'exchange' => ''];
+	private $emailSender = 'accounts@wmflabs.org';
+
+	/**
+	 * Gets the base URL of the tool
+	 *
+	 * If the internal page of the tool is at http://localhost/path/internal.php, this would be set to
+	 * http://localhost/path
+	 * @return string
+	 */
+	public function getBaseUrl()
+	{
+		return $this->baseUrl;
+	}
+
+	/**
+	 * @param string $baseUrl
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setBaseUrl($baseUrl)
+	{
+		$this->baseUrl = $baseUrl;
+
+		return $this;
+	}
+
+	/**
+	 * Path on disk to the directory containing the tool's code
+	 * @return string
+	 */
+	public function getFilePath()
+	{
+		return $this->filePath;
+	}
+
+	/**
+	 * @param string $filePath
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setFilePath($filePath)
+	{
+		$this->filePath = $filePath;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getSchemaVersion()
+	{
+		return $this->schemaVersion;
+	}
+
+	/**
+	 * @param int $schemaVersion
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setSchemaVersion($schemaVersion)
+	{
+		$this->schemaVersion = $schemaVersion;
+
+		return $this;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getDebuggingTraceEnabled()
+	{
+		return $this->debuggingTraceEnabled;
+	}
+
+	/**
+	 * @param mixed $debuggingTraceEnabled
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setDebuggingTraceEnabled($debuggingTraceEnabled)
+	{
+		$this->debuggingTraceEnabled = $debuggingTraceEnabled;
+
+		return $this;
+	}
+
+	public function getDebuggingCssBreakpointsEnabled() : bool
+	{
+		return $this->debuggingCssBreakpointsEnabled;
+	}
+
+	public function setDebuggingCssBreakpointsEnabled(bool $debuggingCssBreakpointsEnabled) : SiteConfiguration
+	{
+		$this->debuggingCssBreakpointsEnabled = $debuggingCssBreakpointsEnabled;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDataClearIp()
+	{
+		return $this->dataClearIp;
+	}
+
+	/**
+	 * @param string $dataClearIp
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setDataClearIp($dataClearIp)
+	{
+		$this->dataClearIp = $dataClearIp;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDataClearEmail()
+	{
+		return $this->dataClearEmail;
+	}
+
+	/**
+	 * @param string $dataClearEmail
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setDataClearEmail($dataClearEmail)
+	{
+		$this->dataClearEmail = $dataClearEmail;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getForceIdentification()
+	{
+		return $this->forceIdentification;
+	}
+
+	/**
+	 * @param boolean $forceIdentification
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setForceIdentification($forceIdentification)
+	{
+		$this->forceIdentification = $forceIdentification;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getIdentificationCacheExpiry()
+	{
+		return $this->identificationCacheExpiry;
+	}
+
+	/**
+	 * @param string $identificationCacheExpiry
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setIdentificationCacheExpiry($identificationCacheExpiry)
+	{
+		$this->identificationCacheExpiry = $identificationCacheExpiry;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getMetaWikimediaWebServiceEndpoint()
+	{
+		return $this->metaWikimediaWebServiceEndpoint;
+	}
+
+	/**
+	 * @param string $metaWikimediaWebServiceEndpoint
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
+	{
+		$this->metaWikimediaWebServiceEndpoint = $metaWikimediaWebServiceEndpoint;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getEnforceOAuth()
+	{
+		return $this->enforceOAuth;
+	}
+
+	/**
+	 * @param boolean $enforceOAuth
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setEnforceOAuth($enforceOAuth)
+	{
+		$this->enforceOAuth = $enforceOAuth;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getEmailConfirmationEnabled()
+	{
+		return $this->emailConfirmationEnabled;
+	}
+
+	/**
+	 * @param boolean $emailConfirmationEnabled
+	 *
+	 * @return $this
+	 */
+	public function setEmailConfirmationEnabled($emailConfirmationEnabled)
+	{
+		$this->emailConfirmationEnabled = $emailConfirmationEnabled;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getMiserModeLimit()
+	{
+		return $this->miserModeLimit;
+	}
+
+	/**
+	 * @param int $miserModeLimit
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setMiserModeLimit($miserModeLimit)
+	{
+		$this->miserModeLimit = $miserModeLimit;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getSquidList()
+	{
+		return $this->squidList;
+	}
+
+	/**
+	 * @param array $squidList
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setSquidList($squidList)
+	{
+		$this->squidList = $squidList;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getUseStrictTransportSecurity()
+	{
+		return $this->useStrictTransportSecurity;
+	}
+
+	/**
+	 * @param boolean $useStrictTransportSecurity
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setUseStrictTransportSecurity($useStrictTransportSecurity)
+	{
+		$this->useStrictTransportSecurity = $useStrictTransportSecurity;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getUserAgent()
+	{
+		return $this->userAgent;
+	}
+
+	/**
+	 * @param string $userAgent
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setUserAgent($userAgent)
+	{
+		$this->userAgent = $userAgent;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getCurlDisableVerifyPeer()
+	{
+		return $this->curlDisableVerifyPeer;
+	}
+
+	/**
+	 * @param boolean $curlDisableVerifyPeer
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCurlDisableVerifyPeer($curlDisableVerifyPeer)
+	{
+		$this->curlDisableVerifyPeer = $curlDisableVerifyPeer;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getUseOAuthSignup()
+	{
+		return $this->useOAuthSignup;
+	}
+
+	/**
+	 * @param boolean $useOAuthSignup
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setUseOAuthSignup($useOAuthSignup)
+	{
+		$this->useOAuthSignup = $useOAuthSignup;
+
+		return $this;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getOAuthConsumerToken()
+	{
+		return $this->oauthConsumerToken;
+	}
+
+	/**
+	 * @param mixed $oauthConsumerToken
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setOAuthConsumerToken($oauthConsumerToken)
+	{
+		$this->oauthConsumerToken = $oauthConsumerToken;
+
+		return $this;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getOAuthConsumerSecret()
+	{
+		return $this->oauthConsumerSecret;
+	}
+
+	/**
+	 * @param mixed $oauthConsumerSecret
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setOAuthConsumerSecret($oauthConsumerSecret)
+	{
+		$this->oauthConsumerSecret = $oauthConsumerSecret;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDataClearInterval()
+	{
+		return $this->dataClearInterval;
+	}
+
+	/**
+	 * @param string $dataClearInterval
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setDataClearInterval($dataClearInterval)
+	{
+		$this->dataClearInterval = $dataClearInterval;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getXffTrustedHostsFile()
+	{
+		return $this->xffTrustedHostsFile;
+	}
+
+	/**
+	 * @param string $xffTrustedHostsFile
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setXffTrustedHostsFile($xffTrustedHostsFile)
+	{
+		$this->xffTrustedHostsFile = $xffTrustedHostsFile;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getCrossOriginResourceSharingHosts()
+	{
+		return $this->crossOriginResourceSharingHosts;
+	}
+
+	/**
+	 * @param array $crossOriginResourceSharingHosts
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCrossOriginResourceSharingHosts($crossOriginResourceSharingHosts)
+	{
+		$this->crossOriginResourceSharingHosts = $crossOriginResourceSharingHosts;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getIrcNotificationsEnabled()
+	{
+		return $this->ircNotificationsEnabled;
+	}
+
+	/**
+	 * @param boolean $ircNotificationsEnabled
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setIrcNotificationsEnabled($ircNotificationsEnabled)
+	{
+		$this->ircNotificationsEnabled = $ircNotificationsEnabled;
+
+		return $this;
+	}
+
+	/**
+	 * @param string $errorLog
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setErrorLog($errorLog)
+	{
+		$this->errorLog = $errorLog;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getErrorLog()
+	{
+		return $this->errorLog;
+	}
+
+	/**
+	 * @param int $emailConfirmationExpiryDays
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
+	{
+		$this->emailConfirmationExpiryDays = $emailConfirmationExpiryDays;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getEmailConfirmationExpiryDays()
+	{
+		return $this->emailConfirmationExpiryDays;
+	}
+
+	/**
+	 * @param string $ircNotificationsInstance
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setIrcNotificationsInstance($ircNotificationsInstance)
+	{
+		$this->ircNotificationsInstance = $ircNotificationsInstance;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getIrcNotificationsInstance()
+	{
+		return $this->ircNotificationsInstance;
+	}
+
+	/**
+	 * @param boolean $titleBlacklistEnabled
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setTitleBlacklistEnabled($titleBlacklistEnabled)
+	{
+		$this->titleBlacklistEnabled = $titleBlacklistEnabled;
+
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getTitleBlacklistEnabled()
+	{
+		return $this->titleBlacklistEnabled;
+	}
+
+	/**
+	 * @param string|null $locationProviderApiKey
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setLocationProviderApiKey($locationProviderApiKey)
+	{
+		$this->locationProviderApiKey = $locationProviderApiKey;
+
+		return $this;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public function getLocationProviderApiKey()
+	{
+		return $this->locationProviderApiKey;
+	}
+
+	/**
+	 * @param array $torExitPaths
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setTorExitPaths($torExitPaths)
+	{
+		$this->torExitPaths = $torExitPaths;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getTorExitPaths()
+	{
+		return $this->torExitPaths;
+	}
+
+	/**
+	 * @param string $oauthIdentityGraceTime
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setOauthIdentityGraceTime($oauthIdentityGraceTime)
+	{
+		$this->oauthIdentityGraceTime = $oauthIdentityGraceTime;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getOauthIdentityGraceTime()
+	{
+		return $this->oauthIdentityGraceTime;
+	}
+
+	/**
+	 * @param string $oauthMediaWikiCanonicalServer
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
+	{
+		$this->oauthMediaWikiCanonicalServer = $oauthMediaWikiCanonicalServer;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getOauthMediaWikiCanonicalServer()
+	{
+		return $this->oauthMediaWikiCanonicalServer;
+	}
+
+	/**
+	 * @param string $creationBotUsername
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCreationBotUsername($creationBotUsername)
+	{
+		$this->creationBotUsername = $creationBotUsername;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCreationBotUsername()
+	{
+		return $this->creationBotUsername;
+	}
+
+	/**
+	 * @param string $creationBotPassword
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCreationBotPassword($creationBotPassword)
+	{
+		$this->creationBotPassword = $creationBotPassword;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCreationBotPassword()
+	{
+		return $this->creationBotPassword;
+	}
+
+	/**
+	 * @param string|null $curlCookieJar
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCurlCookieJar($curlCookieJar)
+	{
+		$this->curlCookieJar = $curlCookieJar;
+
+		return $this;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getCurlCookieJar()
+	{
+		return $this->curlCookieJar;
+	}
+
+	public function getYubicoApiId()
+	{
+		return $this->yubicoApiId;
+	}
+
+	public function setYubicoApiId($id)
+	{
+		$this->yubicoApiId = $id;
+
+		return $this;
+	}
+
+	public function getYubicoApiKey()
+	{
+		return $this->yubicoApiKey;
+	}
+
+	public function setYubicoApiKey($key)
+	{
+		$this->yubicoApiKey = $key;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getTotpEncryptionKey()
+	{
+		return $this->totpEncryptionKey;
+	}
+
+	/**
+	 * @param string $totpEncryptionKey
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setTotpEncryptionKey($totpEncryptionKey)
+	{
+		$this->totpEncryptionKey = $totpEncryptionKey;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getIdentificationNoticeboardPage()
+	{
+		return $this->identificationNoticeboardPage;
+	}
+
+	/**
+	 * @param string $identificationNoticeboardPage
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setIdentificationNoticeboardPage($identificationNoticeboardPage)
+	{
+		$this->identificationNoticeboardPage = $identificationNoticeboardPage;
+
+		return $this;
+	}
+
+	public function isRegistrationAllowed(): bool
+	{
+		return $this->registrationAllowed;
+	}
+
+	public function setRegistrationAllowed(bool $registrationAllowed): SiteConfiguration
+	{
+		$this->registrationAllowed = $registrationAllowed;
+
+		return $this;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getCspReportUri()
+	{
+		return $this->cspReportUri;
+	}
+
+	/**
+	 * @param string|null $cspReportUri
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCspReportUri($cspReportUri)
+	{
+		$this->cspReportUri = $cspReportUri;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getResourceCacheEpoch(): int
+	{
+		return $this->resourceCacheEpoch;
+	}
+
+	/**
+	 * @param int $resourceCacheEpoch
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setResourceCacheEpoch(int $resourceCacheEpoch): SiteConfiguration
+	{
+		$this->resourceCacheEpoch = $resourceCacheEpoch;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getCommonEmailDomains(): array
+	{
+		return $this->commonEmailDomains;
+	}
+
+	/**
+	 * @param array $commonEmailDomains
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setCommonEmailDomains(array $commonEmailDomains): SiteConfiguration
+	{
+		$this->commonEmailDomains = $commonEmailDomains;
+
+		return $this;
+	}
+
+	/**
+	 * @param int[] $banMaxIpBlockRange
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setBanMaxIpBlockRange(array $banMaxIpBlockRange): SiteConfiguration
+	{
+		$this->banMaxIpBlockRange = $banMaxIpBlockRange;
+
+		return $this;
+	}
+
+	/**
+	 * @return int[]
+	 */
+	public function getBanMaxIpBlockRange(): array
+	{
+		return $this->banMaxIpBlockRange;
+	}
+
+	/**
+	 * @param int[] $banMaxIpRange
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setBanMaxIpRange(array $banMaxIpRange): SiteConfiguration
+	{
+		$this->banMaxIpRange = $banMaxIpRange;
+
+		return $this;
+	}
+
+	/**
+	 * @return int[]
+	 */
+	public function getBanMaxIpRange(): array
+	{
+		return $this->banMaxIpRange;
+	}
+
+	/**
+	 * @param array $oauthLegacyConsumerTokens
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setOauthLegacyConsumerTokens(array $oauthLegacyConsumerTokens): SiteConfiguration
+	{
+		$this->oauthLegacyConsumerTokens = $oauthLegacyConsumerTokens;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getOauthLegacyConsumerTokens(): array
+	{
+		return $this->oauthLegacyConsumerTokens;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getJobQueueBatchSize(): int
+	{
+		return $this->jobQueueBatchSize;
+	}
+
+	/**
+	 * @param int $jobQueueBatchSize
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setJobQueueBatchSize(int $jobQueueBatchSize): SiteConfiguration
+	{
+		$this->jobQueueBatchSize = $jobQueueBatchSize;
+
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getAmqpConfiguration(): array
+	{
+		return $this->amqpConfiguration;
+	}
+
+	/**
+	 * @param array $amqpConfiguration
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setAmqpConfiguration(array $amqpConfiguration): SiteConfiguration
+	{
+		$this->amqpConfiguration = $amqpConfiguration;
+
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEmailSender(): string
+	{
+		return $this->emailSender;
+	}
+
+	/**
+	 * @param string $emailSender
+	 *
+	 * @return SiteConfiguration
+	 */
+	public function setEmailSender(string $emailSender): SiteConfiguration
+	{
+		$this->emailSender = $emailSender;
+
+		return $this;
 }
 }

includes/Tasks/InternalPageBase.php

Indentation +241 added lines, -241 removed lines

@@ -23,245 +23,245 @@
 
 abstract class InternalPageBase extends PageBase
 {
-    use NavigationMenuAccessControl;
-
-    /** @var ITypeAheadHelper */
-    private $typeAheadHelper;
-    /** @var SecurityManager */
-    private $securityManager;
-    /** @var IBlacklistHelper */
-    private $blacklistHelper;
-    /** @var DomainAccessManager */
-    private $domainAccessManager;
-
-    /**
-     * @return ITypeAheadHelper
-     */
-    public function getTypeAheadHelper()
-    {
-        return $this->typeAheadHelper;
-    }
-
-    /**
-     * @param ITypeAheadHelper $typeAheadHelper
-     */
-    public function setTypeAheadHelper(ITypeAheadHelper $typeAheadHelper)
-    {
-        $this->typeAheadHelper = $typeAheadHelper;
-    }
-
-    /**
-     * Runs the page code
-     *
-     * @throws Exception
-     * @category Security-Critical
-     */
-    final public function execute()
-    {
-        if ($this->getRouteName() === null) {
-            throw new Exception("Request is unrouted.");
-        }
-
-        if ($this->getSiteConfiguration() === null) {
-            throw new Exception("Page has no configuration!");
-        }
-
-        $this->setupPage();
-
-        $this->touchUserLastActive();
-
-        $currentUser = User::getCurrent($this->getDatabase());
-
-        // Hey, this is also a security barrier, in addition to the below. Separated out for readability.
-        if (!$this->isProtectedPage()) {
-            // This page is /not/ a protected page, as such we can just run it.
-            $this->runPage();
-
-            return;
-        }
-
-        // Security barrier.
-        //
-        // This code essentially doesn't care if the user is logged in or not, as the security manager hides all that
-        // away for us
-        $securityResult = $this->getSecurityManager()->allows(get_called_class(), $this->getRouteName(), $currentUser);
-        if ($securityResult === SecurityManager::ALLOWED) {
-            // We're allowed to run the page, so let's run it.
-            $this->runPage();
-        }
-        else {
-            $this->handleAccessDenied($securityResult);
-
-            // Send the headers
-            $this->sendResponseHeaders();
-        }
-    }
-
-    /**
-     * Performs final tasks needed before rendering the page.
-     */
-    final public function finalisePage()
-    {
-        parent::finalisePage();
-
-        $database = $this->getDatabase();
-        $currentUser = User::getCurrent($database);
-
-        // Load in the badges for the navbar
-        $this->setUpNavBarBadges($currentUser, $database);
-
-        if ($this->barrierTest('viewSiteNotice', User::getCurrent($database), 'GlobalInfo')) {
-            $siteNotice = SiteNotice::get($this->getDatabase());
-            $siteNoticeHash = sha1($siteNotice);
-
-            if (WebRequest::testSiteNoticeCookieValue($siteNoticeHash)) {
-                $this->assign('siteNoticeState', 'd-none');
-            }
-            else {
-                $this->assign('siteNoticeState', 'd-block');
-            }
-
-            $this->assign('siteNoticeText', $siteNotice);
-            $this->assign('siteNoticeVersion', $siteNoticeHash);
-        }
-
-        if ($this->barrierTest('viewOnlineUsers', User::getCurrent($database), 'GlobalInfo')) {
-            $sql = 'SELECT * FROM user WHERE lastactive > DATE_SUB(CURRENT_TIMESTAMP(), INTERVAL 5 MINUTE);';
-            $statement = $database->query($sql);
-            $activeUsers = $statement->fetchAll(PDO::FETCH_CLASS, User::class);
-            $this->assign('onlineusers', $activeUsers);
-        }
-
-        $this->setupNavMenuAccess($currentUser);
-    }
-
-    /**
-     * Configures whether the page respects roles or not. You probably want this to return true.
-     *
-     * Set to false for public pages. You probably want this to return true.
-     *
-     * This defaults to true unless you explicitly set it to false. Setting it to false means anybody can do anything
-     * on this page, so you probably want this to return true.
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    protected function isProtectedPage()
-    {
-        return true;
-    }
-
-    protected function handleAccessDenied($denyReason)
-    {
-        $currentUser = User::getCurrent($this->getDatabase());
-
-        // Not allowed to access this resource.
-        // Firstly, let's check if we're even logged in.
-        if ($currentUser->isCommunityUser()) {
-            // Not logged in, redirect to login page
-            WebRequest::setPostLoginRedirect();
-            $this->redirect("login");
-
-            return;
-        }
-        else {
-            // Decide whether this was a rights failure, or an identification failure.
-
-            if ($denyReason === SecurityManager::ERROR_NOT_IDENTIFIED) {
-                // Not identified
-                throw new NotIdentifiedException($this->getSecurityManager(), $this->getDomainAccessManager());
-            }
-            elseif ($denyReason === SecurityManager::ERROR_DENIED) {
-                // Nope, plain old access denied
-                throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
-            }
-            else {
-                throw new Exception('Unknown response from security manager.');
-            }
-        }
-    }
-
-    /**
-     * Tests the security barrier for a specified action.
-     *
-     * Don't use within templates
-     *
-     * @param string      $action
-     *
-     * @param User        $user
-     * @param null|string $pageName
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    final public function barrierTest($action, User $user, $pageName = null)
-    {
-        $page = get_called_class();
-        if ($pageName !== null) {
-            $page = $pageName;
-        }
-
-        $securityResult = $this->getSecurityManager()->allows($page, $action, $user);
-
-        return $securityResult === SecurityManager::ALLOWED;
-    }
-
-    /**
-     * Updates the lastactive timestamp
-     */
-    private function touchUserLastActive()
-    {
-        if (WebRequest::getSessionUserId() !== null) {
-            $query = 'UPDATE user SET lastactive = CURRENT_TIMESTAMP() WHERE id = :id;';
-            $this->getDatabase()->prepare($query)->execute(array(":id" => WebRequest::getSessionUserId()));
-        }
-    }
-
-    /**
-     * @return SecurityManager
-     */
-    public function getSecurityManager()
-    {
-        return $this->securityManager;
-    }
-
-    /**
-     * @param SecurityManager $securityManager
-     */
-    public function setSecurityManager(SecurityManager $securityManager)
-    {
-        $this->securityManager = $securityManager;
-    }
-
-    /**
-     * @return IBlacklistHelper
-     */
-    public function getBlacklistHelper()
-    {
-        return $this->blacklistHelper;
-    }
-
-    /**
-     * @param IBlacklistHelper $blacklistHelper
-     */
-    public function setBlacklistHelper(IBlacklistHelper $blacklistHelper)
-    {
-        $this->blacklistHelper = $blacklistHelper;
-    }
-
-    /**
-     * @return DomainAccessManager
-     */
-    public function getDomainAccessManager(): DomainAccessManager
-    {
-        return $this->domainAccessManager;
-    }
-
-    /**
-     * @param DomainAccessManager $domainAccessManager
-     */
-    public function setDomainAccessManager(DomainAccessManager $domainAccessManager): void
-    {
-        $this->domainAccessManager = $domainAccessManager;
-    }
+	use NavigationMenuAccessControl;
+
+	/** @var ITypeAheadHelper */
+	private $typeAheadHelper;
+	/** @var SecurityManager */
+	private $securityManager;
+	/** @var IBlacklistHelper */
+	private $blacklistHelper;
+	/** @var DomainAccessManager */
+	private $domainAccessManager;
+
+	/**
+	 * @return ITypeAheadHelper
+	 */
+	public function getTypeAheadHelper()
+	{
+		return $this->typeAheadHelper;
+	}
+
+	/**
+	 * @param ITypeAheadHelper $typeAheadHelper
+	 */
+	public function setTypeAheadHelper(ITypeAheadHelper $typeAheadHelper)
+	{
+		$this->typeAheadHelper = $typeAheadHelper;
+	}
+
+	/**
+	 * Runs the page code
+	 *
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	final public function execute()
+	{
+		if ($this->getRouteName() === null) {
+			throw new Exception("Request is unrouted.");
+		}
+
+		if ($this->getSiteConfiguration() === null) {
+			throw new Exception("Page has no configuration!");
+		}
+
+		$this->setupPage();
+
+		$this->touchUserLastActive();
+
+		$currentUser = User::getCurrent($this->getDatabase());
+
+		// Hey, this is also a security barrier, in addition to the below. Separated out for readability.
+		if (!$this->isProtectedPage()) {
+			// This page is /not/ a protected page, as such we can just run it.
+			$this->runPage();
+
+			return;
+		}
+
+		// Security barrier.
+		//
+		// This code essentially doesn't care if the user is logged in or not, as the security manager hides all that
+		// away for us
+		$securityResult = $this->getSecurityManager()->allows(get_called_class(), $this->getRouteName(), $currentUser);
+		if ($securityResult === SecurityManager::ALLOWED) {
+			// We're allowed to run the page, so let's run it.
+			$this->runPage();
+		}
+		else {
+			$this->handleAccessDenied($securityResult);
+
+			// Send the headers
+			$this->sendResponseHeaders();
+		}
+	}
+
+	/**
+	 * Performs final tasks needed before rendering the page.
+	 */
+	final public function finalisePage()
+	{
+		parent::finalisePage();
+
+		$database = $this->getDatabase();
+		$currentUser = User::getCurrent($database);
+
+		// Load in the badges for the navbar
+		$this->setUpNavBarBadges($currentUser, $database);
+
+		if ($this->barrierTest('viewSiteNotice', User::getCurrent($database), 'GlobalInfo')) {
+			$siteNotice = SiteNotice::get($this->getDatabase());
+			$siteNoticeHash = sha1($siteNotice);
+
+			if (WebRequest::testSiteNoticeCookieValue($siteNoticeHash)) {
+				$this->assign('siteNoticeState', 'd-none');
+			}
+			else {
+				$this->assign('siteNoticeState', 'd-block');
+			}
+
+			$this->assign('siteNoticeText', $siteNotice);
+			$this->assign('siteNoticeVersion', $siteNoticeHash);
+		}
+
+		if ($this->barrierTest('viewOnlineUsers', User::getCurrent($database), 'GlobalInfo')) {
+			$sql = 'SELECT * FROM user WHERE lastactive > DATE_SUB(CURRENT_TIMESTAMP(), INTERVAL 5 MINUTE);';
+			$statement = $database->query($sql);
+			$activeUsers = $statement->fetchAll(PDO::FETCH_CLASS, User::class);
+			$this->assign('onlineusers', $activeUsers);
+		}
+
+		$this->setupNavMenuAccess($currentUser);
+	}
+
+	/**
+	 * Configures whether the page respects roles or not. You probably want this to return true.
+	 *
+	 * Set to false for public pages. You probably want this to return true.
+	 *
+	 * This defaults to true unless you explicitly set it to false. Setting it to false means anybody can do anything
+	 * on this page, so you probably want this to return true.
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	protected function isProtectedPage()
+	{
+		return true;
+	}
+
+	protected function handleAccessDenied($denyReason)
+	{
+		$currentUser = User::getCurrent($this->getDatabase());
+
+		// Not allowed to access this resource.
+		// Firstly, let's check if we're even logged in.
+		if ($currentUser->isCommunityUser()) {
+			// Not logged in, redirect to login page
+			WebRequest::setPostLoginRedirect();
+			$this->redirect("login");
+
+			return;
+		}
+		else {
+			// Decide whether this was a rights failure, or an identification failure.
+
+			if ($denyReason === SecurityManager::ERROR_NOT_IDENTIFIED) {
+				// Not identified
+				throw new NotIdentifiedException($this->getSecurityManager(), $this->getDomainAccessManager());
+			}
+			elseif ($denyReason === SecurityManager::ERROR_DENIED) {
+				// Nope, plain old access denied
+				throw new AccessDeniedException($this->getSecurityManager(), $this->getDomainAccessManager());
+			}
+			else {
+				throw new Exception('Unknown response from security manager.');
+			}
+		}
+	}
+
+	/**
+	 * Tests the security barrier for a specified action.
+	 *
+	 * Don't use within templates
+	 *
+	 * @param string      $action
+	 *
+	 * @param User        $user
+	 * @param null|string $pageName
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	final public function barrierTest($action, User $user, $pageName = null)
+	{
+		$page = get_called_class();
+		if ($pageName !== null) {
+			$page = $pageName;
+		}
+
+		$securityResult = $this->getSecurityManager()->allows($page, $action, $user);
+
+		return $securityResult === SecurityManager::ALLOWED;
+	}
+
+	/**
+	 * Updates the lastactive timestamp
+	 */
+	private function touchUserLastActive()
+	{
+		if (WebRequest::getSessionUserId() !== null) {
+			$query = 'UPDATE user SET lastactive = CURRENT_TIMESTAMP() WHERE id = :id;';
+			$this->getDatabase()->prepare($query)->execute(array(":id" => WebRequest::getSessionUserId()));
+		}
+	}
+
+	/**
+	 * @return SecurityManager
+	 */
+	public function getSecurityManager()
+	{
+		return $this->securityManager;
+	}
+
+	/**
+	 * @param SecurityManager $securityManager
+	 */
+	public function setSecurityManager(SecurityManager $securityManager)
+	{
+		$this->securityManager = $securityManager;
+	}
+
+	/**
+	 * @return IBlacklistHelper
+	 */
+	public function getBlacklistHelper()
+	{
+		return $this->blacklistHelper;
+	}
+
+	/**
+	 * @param IBlacklistHelper $blacklistHelper
+	 */
+	public function setBlacklistHelper(IBlacklistHelper $blacklistHelper)
+	{
+		$this->blacklistHelper = $blacklistHelper;
+	}
+
+	/**
+	 * @return DomainAccessManager
+	 */
+	public function getDomainAccessManager(): DomainAccessManager
+	{
+		return $this->domainAccessManager;
+	}
+
+	/**
+	 * @param DomainAccessManager $domainAccessManager
+	 */
+	public function setDomainAccessManager(DomainAccessManager $domainAccessManager): void
+	{
+		$this->domainAccessManager = $domainAccessManager;
+	}
 }

includes/Tasks/PageBase.php

Indentation +372 added lines, -372 removed lines

@@ -23,376 +23,376 @@
 
 abstract class PageBase extends TaskBase implements IRoutedTask
 {
-    use TemplateOutput;
-    /** @var string Smarty template to display */
-    protected $template = "base.tpl";
-    /** @var string HTML title. Currently unused. */
-    protected $htmlTitle;
-    /** @var bool Determines if the page is a redirect or not */
-    protected $isRedirecting = false;
-    /** @var array Queue of headers to be sent on successful completion */
-    protected $headerQueue = array();
-    /** @var string The name of the route to use, as determined by the request router. */
-    private $routeName = null;
-    /** @var TokenManager */
-    protected $tokenManager;
-    /** @var ContentSecurityPolicyManager */
-    private $cspManager;
-    /** @var string[] Extra JS files to include */
-    private $extraJs = array();
-    /** @var bool Don't show (and hence clear) session alerts when this page is displayed  */
-    private $hideAlerts = false;
-
-    /**
-     * Sets the route the request will take. Only should be called from the request router or barrier test.
-     *
-     * @param string $routeName        The name of the route
-     * @param bool   $skipCallableTest Don't use this unless you know what you're doing, and what the implications are.
-     *
-     * @throws Exception
-     * @category Security-Critical
-     */
-    final public function setRoute($routeName, $skipCallableTest = false)
-    {
-        // Test the new route is callable before adopting it.
-        if (!$skipCallableTest && !is_callable(array($this, $routeName))) {
-            throw new Exception("Proposed route '$routeName' is not callable.");
-        }
-
-        // Adopt the new route
-        $this->routeName = $routeName;
-    }
-
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    final public function getRouteName()
-    {
-        return $this->routeName;
-    }
-
-    /**
-     * Performs generic page setup actions
-     */
-    final protected function setupPage()
-    {
-        $this->setUpSmarty();
-
-        $currentUser = User::getCurrent($this->getDatabase());
-        $this->assign('currentUser', $currentUser);
-        $this->assign('currentDomain', Domain::getCurrent($this->getDatabase()));
-        $this->assign('loggedIn', (!$currentUser->isCommunityUser()));
-    }
-
-    /**
-     * Runs the page logic as routed by the RequestRouter
-     *
-     * Only should be called after a security barrier! That means only from execute().
-     */
-    final protected function runPage()
-    {
-        $database = $this->getDatabase();
-
-        // initialise a database transaction
-        if (!$database->beginTransaction()) {
-            throw new Exception('Failed to start transaction on primary database.');
-        }
-
-        try {
-            // run the page code
-            $this->{$this->getRouteName()}();
-
-            $database->commit();
-        }
-        /** @noinspection PhpRedundantCatchClauseInspection */
-        catch (ApplicationLogicException $ex) {
-            // it's an application logic exception, so nothing went seriously wrong with the site. We can use the
-            // standard templating system for this.
-
-            // Firstly, let's undo anything that happened to the database.
-            $database->rollBack();
-
-            // Reset smarty
-            $this->setupPage();
-
-            $this->skipAlerts();
-
-            // Set the template
-            $this->setTemplate('exception/application-logic.tpl');
-            $this->assign('message', $ex->getMessage());
-
-            // Force this back to false
-            $this->isRedirecting = false;
-            $this->headerQueue = array();
-        }
-        /** @noinspection PhpRedundantCatchClauseInspection */
-        catch (OptimisticLockFailedException $ex) {
-            // it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the
-            // standard templating system for this.
-
-            // Firstly, let's undo anything that happened to the database.
-            $database->rollBack();
-
-            // Reset smarty
-            $this->setupPage();
-
-            // Set the template
-            $this->skipAlerts();
-            $this->setTemplate('exception/optimistic-lock-failure.tpl');
-            $this->assign('message', $ex->getMessage());
-
-            $this->assign('debugTrace', false);
-
-            if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) {
-                ob_start();
-                var_dump(ExceptionHandler::getExceptionData($ex));
-                $textErrorData = ob_get_contents();
-                ob_end_clean();
-
-                $this->assign('exceptionData', $textErrorData);
-                $this->assign('debugTrace', true);
-            }
-
-            // Force this back to false
-            $this->isRedirecting = false;
-            $this->headerQueue = array();
-        }
-        finally {
-            // Catch any hanging on transactions
-            if ($database->hasActiveTransaction()) {
-                $database->rollBack();
-            }
-        }
-
-        // run any finalisation code needed before we send the output to the browser.
-        $this->finalisePage();
-
-        // Send the headers
-        $this->sendResponseHeaders();
-
-        // Check we have a template to use!
-        if ($this->template !== null) {
-            $content = $this->fetchTemplate($this->template);
-            ob_clean();
-            print($content);
-            ob_flush();
-
-            return;
-        }
-    }
-
-    /**
-     * Performs final tasks needed before rendering the page.
-     */
-    protected function finalisePage()
-    {
-        if ($this->isRedirecting) {
-            $this->template = null;
-
-            return;
-        }
-
-        $this->assign('extraJs', $this->extraJs);
-
-        if (!$this->hideAlerts) {
-            // If we're actually displaying content, we want to add the session alerts here!
-            $this->assign('alerts', SessionAlert::getAlerts());
-            SessionAlert::clearAlerts();
-        }
-
-        $this->assign('htmlTitle', $this->htmlTitle);
-    }
-
-    /**
-     * @return TokenManager
-     */
-    public function getTokenManager()
-    {
-        return $this->tokenManager;
-    }
-
-    /**
-     * @param TokenManager $tokenManager
-     */
-    public function setTokenManager($tokenManager)
-    {
-        $this->tokenManager = $tokenManager;
-    }
-
-    /**
-     * @return ContentSecurityPolicyManager
-     */
-    public function getCspManager(): ContentSecurityPolicyManager
-    {
-        return $this->cspManager;
-    }
-
-    /**
-     * @param ContentSecurityPolicyManager $cspManager
-     */
-    public function setCspManager(ContentSecurityPolicyManager $cspManager): void
-    {
-        $this->cspManager = $cspManager;
-    }
-
-    /**
-     * Skip the display of session alerts in this page
-     */
-    public function skipAlerts(): void
-    {
-        $this->hideAlerts = true;
-    }
-
-    /**
-     * Sends the redirect headers to perform a GET at the destination page.
-     *
-     * Also nullifies the set template so Smarty does not render it.
-     *
-     * @param string      $page   The page to redirect requests to (as used in the UR)
-     * @param null|string $action The action to use on the page.
-     * @param null|array  $parameters
-     * @param null|string $script The script (relative to index.php) to redirect to
-     */
-    final protected function redirect($page = '', $action = null, $parameters = null, $script = null)
-    {
-        $currentScriptName = WebRequest::scriptName();
-
-        // Are we changing script?
-        if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
-            $targetScriptName = $currentScriptName;
-        }
-        else {
-            $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
-        }
-
-        $pathInfo = array($targetScriptName);
-
-        $pathInfo[1] = $page;
-
-        if ($action !== null) {
-            $pathInfo[2] = $action;
-        }
-
-        $url = implode('/', $pathInfo);
-
-        if (is_array($parameters) && count($parameters) > 0) {
-            $url .= '?' . http_build_query($parameters);
-        }
-
-        $this->redirectUrl($url);
-    }
-
-    /**
-     * Sends the redirect headers to perform a GET at the new address.
-     *
-     * Also nullifies the set template so Smarty does not render it.
-     *
-     * @param string $path URL to redirect to
-     */
-    final protected function redirectUrl($path)
-    {
-        // 303 See Other = re-request at new address with a GET.
-        $this->headerQueue[] = 'HTTP/1.1 303 See Other';
-        $this->headerQueue[] = "Location: $path";
-
-        $this->setTemplate(null);
-        $this->isRedirecting = true;
-    }
-
-    /**
-     * Sets the name of the template this page should display.
-     *
-     * @param string $name
-     *
-     * @throws Exception
-     */
-    final protected function setTemplate($name)
-    {
-        if ($this->isRedirecting) {
-            throw new Exception('This page has been set as a redirect, no template can be displayed!');
-        }
-
-        $this->template = $name;
-    }
-
-    /**
-     * Adds an extra JS file to to the page
-     *
-     * @param string $path The path (relative to the application root) of the file
-     */
-    final protected function addJs($path)
-    {
-        if (in_array($path, $this->extraJs)) {
-            // nothing to do
-            return;
-        }
-
-        $this->extraJs[] = $path;
-    }
-
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    abstract protected function main();
-
-    /**
-     * Takes a smarty template string and sets the HTML title to that value
-     *
-     * @param string $title
-     *
-     * @throws SmartyException
-     */
-    final protected function setHtmlTitle($title)
-    {
-        $this->htmlTitle = $this->smarty->fetch('string:' . $title);
-    }
-
-    public function execute()
-    {
-        if ($this->getRouteName() === null) {
-            throw new Exception('Request is unrouted.');
-        }
-
-        if ($this->getSiteConfiguration() === null) {
-            throw new Exception('Page has no configuration!');
-        }
-
-        $this->setupPage();
-
-        $this->runPage();
-    }
-
-    public function assignCSRFToken()
-    {
-        $token = $this->tokenManager->getNewToken();
-        $this->assign('csrfTokenData', $token->getTokenData());
-    }
-
-    public function validateCSRFToken()
-    {
-        if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) {
-            throw new ApplicationLogicException('Form token is not valid, please reload and try again');
-        }
-    }
-
-    protected function sendResponseHeaders()
-    {
-        if (headers_sent()) {
-            throw new ApplicationLogicException('Headers have already been sent! This is likely a bug in the application.');
-        }
-
-        // send the CSP headers now
-        header($this->getCspManager()->getHeader());
-
-        foreach ($this->headerQueue as $item) {
-            if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) {
-                // Oops. We're not allowed to do this.
-                throw new Exception('Unable to split header');
-            }
-
-            header($item);
-        }
-    }
+	use TemplateOutput;
+	/** @var string Smarty template to display */
+	protected $template = "base.tpl";
+	/** @var string HTML title. Currently unused. */
+	protected $htmlTitle;
+	/** @var bool Determines if the page is a redirect or not */
+	protected $isRedirecting = false;
+	/** @var array Queue of headers to be sent on successful completion */
+	protected $headerQueue = array();
+	/** @var string The name of the route to use, as determined by the request router. */
+	private $routeName = null;
+	/** @var TokenManager */
+	protected $tokenManager;
+	/** @var ContentSecurityPolicyManager */
+	private $cspManager;
+	/** @var string[] Extra JS files to include */
+	private $extraJs = array();
+	/** @var bool Don't show (and hence clear) session alerts when this page is displayed  */
+	private $hideAlerts = false;
+
+	/**
+	 * Sets the route the request will take. Only should be called from the request router or barrier test.
+	 *
+	 * @param string $routeName        The name of the route
+	 * @param bool   $skipCallableTest Don't use this unless you know what you're doing, and what the implications are.
+	 *
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	final public function setRoute($routeName, $skipCallableTest = false)
+	{
+		// Test the new route is callable before adopting it.
+		if (!$skipCallableTest && !is_callable(array($this, $routeName))) {
+			throw new Exception("Proposed route '$routeName' is not callable.");
+		}
+
+		// Adopt the new route
+		$this->routeName = $routeName;
+	}
+
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	final public function getRouteName()
+	{
+		return $this->routeName;
+	}
+
+	/**
+	 * Performs generic page setup actions
+	 */
+	final protected function setupPage()
+	{
+		$this->setUpSmarty();
+
+		$currentUser = User::getCurrent($this->getDatabase());
+		$this->assign('currentUser', $currentUser);
+		$this->assign('currentDomain', Domain::getCurrent($this->getDatabase()));
+		$this->assign('loggedIn', (!$currentUser->isCommunityUser()));
+	}
+
+	/**
+	 * Runs the page logic as routed by the RequestRouter
+	 *
+	 * Only should be called after a security barrier! That means only from execute().
+	 */
+	final protected function runPage()
+	{
+		$database = $this->getDatabase();
+
+		// initialise a database transaction
+		if (!$database->beginTransaction()) {
+			throw new Exception('Failed to start transaction on primary database.');
+		}
+
+		try {
+			// run the page code
+			$this->{$this->getRouteName()}();
+
+			$database->commit();
+		}
+		/** @noinspection PhpRedundantCatchClauseInspection */
+		catch (ApplicationLogicException $ex) {
+			// it's an application logic exception, so nothing went seriously wrong with the site. We can use the
+			// standard templating system for this.
+
+			// Firstly, let's undo anything that happened to the database.
+			$database->rollBack();
+
+			// Reset smarty
+			$this->setupPage();
+
+			$this->skipAlerts();
+
+			// Set the template
+			$this->setTemplate('exception/application-logic.tpl');
+			$this->assign('message', $ex->getMessage());
+
+			// Force this back to false
+			$this->isRedirecting = false;
+			$this->headerQueue = array();
+		}
+		/** @noinspection PhpRedundantCatchClauseInspection */
+		catch (OptimisticLockFailedException $ex) {
+			// it's an optimistic lock failure exception, so nothing went seriously wrong with the site. We can use the
+			// standard templating system for this.
+
+			// Firstly, let's undo anything that happened to the database.
+			$database->rollBack();
+
+			// Reset smarty
+			$this->setupPage();
+
+			// Set the template
+			$this->skipAlerts();
+			$this->setTemplate('exception/optimistic-lock-failure.tpl');
+			$this->assign('message', $ex->getMessage());
+
+			$this->assign('debugTrace', false);
+
+			if ($this->getSiteConfiguration()->getDebuggingTraceEnabled()) {
+				ob_start();
+				var_dump(ExceptionHandler::getExceptionData($ex));
+				$textErrorData = ob_get_contents();
+				ob_end_clean();
+
+				$this->assign('exceptionData', $textErrorData);
+				$this->assign('debugTrace', true);
+			}
+
+			// Force this back to false
+			$this->isRedirecting = false;
+			$this->headerQueue = array();
+		}
+		finally {
+			// Catch any hanging on transactions
+			if ($database->hasActiveTransaction()) {
+				$database->rollBack();
+			}
+		}
+
+		// run any finalisation code needed before we send the output to the browser.
+		$this->finalisePage();
+
+		// Send the headers
+		$this->sendResponseHeaders();
+
+		// Check we have a template to use!
+		if ($this->template !== null) {
+			$content = $this->fetchTemplate($this->template);
+			ob_clean();
+			print($content);
+			ob_flush();
+
+			return;
+		}
+	}
+
+	/**
+	 * Performs final tasks needed before rendering the page.
+	 */
+	protected function finalisePage()
+	{
+		if ($this->isRedirecting) {
+			$this->template = null;
+
+			return;
+		}
+
+		$this->assign('extraJs', $this->extraJs);
+
+		if (!$this->hideAlerts) {
+			// If we're actually displaying content, we want to add the session alerts here!
+			$this->assign('alerts', SessionAlert::getAlerts());
+			SessionAlert::clearAlerts();
+		}
+
+		$this->assign('htmlTitle', $this->htmlTitle);
+	}
+
+	/**
+	 * @return TokenManager
+	 */
+	public function getTokenManager()
+	{
+		return $this->tokenManager;
+	}
+
+	/**
+	 * @param TokenManager $tokenManager
+	 */
+	public function setTokenManager($tokenManager)
+	{
+		$this->tokenManager = $tokenManager;
+	}
+
+	/**
+	 * @return ContentSecurityPolicyManager
+	 */
+	public function getCspManager(): ContentSecurityPolicyManager
+	{
+		return $this->cspManager;
+	}
+
+	/**
+	 * @param ContentSecurityPolicyManager $cspManager
+	 */
+	public function setCspManager(ContentSecurityPolicyManager $cspManager): void
+	{
+		$this->cspManager = $cspManager;
+	}
+
+	/**
+	 * Skip the display of session alerts in this page
+	 */
+	public function skipAlerts(): void
+	{
+		$this->hideAlerts = true;
+	}
+
+	/**
+	 * Sends the redirect headers to perform a GET at the destination page.
+	 *
+	 * Also nullifies the set template so Smarty does not render it.
+	 *
+	 * @param string      $page   The page to redirect requests to (as used in the UR)
+	 * @param null|string $action The action to use on the page.
+	 * @param null|array  $parameters
+	 * @param null|string $script The script (relative to index.php) to redirect to
+	 */
+	final protected function redirect($page = '', $action = null, $parameters = null, $script = null)
+	{
+		$currentScriptName = WebRequest::scriptName();
+
+		// Are we changing script?
+		if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
+			$targetScriptName = $currentScriptName;
+		}
+		else {
+			$targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
+		}
+
+		$pathInfo = array($targetScriptName);
+
+		$pathInfo[1] = $page;
+
+		if ($action !== null) {
+			$pathInfo[2] = $action;
+		}
+
+		$url = implode('/', $pathInfo);
+
+		if (is_array($parameters) && count($parameters) > 0) {
+			$url .= '?' . http_build_query($parameters);
+		}
+
+		$this->redirectUrl($url);
+	}
+
+	/**
+	 * Sends the redirect headers to perform a GET at the new address.
+	 *
+	 * Also nullifies the set template so Smarty does not render it.
+	 *
+	 * @param string $path URL to redirect to
+	 */
+	final protected function redirectUrl($path)
+	{
+		// 303 See Other = re-request at new address with a GET.
+		$this->headerQueue[] = 'HTTP/1.1 303 See Other';
+		$this->headerQueue[] = "Location: $path";
+
+		$this->setTemplate(null);
+		$this->isRedirecting = true;
+	}
+
+	/**
+	 * Sets the name of the template this page should display.
+	 *
+	 * @param string $name
+	 *
+	 * @throws Exception
+	 */
+	final protected function setTemplate($name)
+	{
+		if ($this->isRedirecting) {
+			throw new Exception('This page has been set as a redirect, no template can be displayed!');
+		}
+
+		$this->template = $name;
+	}
+
+	/**
+	 * Adds an extra JS file to to the page
+	 *
+	 * @param string $path The path (relative to the application root) of the file
+	 */
+	final protected function addJs($path)
+	{
+		if (in_array($path, $this->extraJs)) {
+			// nothing to do
+			return;
+		}
+
+		$this->extraJs[] = $path;
+	}
+
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	abstract protected function main();
+
+	/**
+	 * Takes a smarty template string and sets the HTML title to that value
+	 *
+	 * @param string $title
+	 *
+	 * @throws SmartyException
+	 */
+	final protected function setHtmlTitle($title)
+	{
+		$this->htmlTitle = $this->smarty->fetch('string:' . $title);
+	}
+
+	public function execute()
+	{
+		if ($this->getRouteName() === null) {
+			throw new Exception('Request is unrouted.');
+		}
+
+		if ($this->getSiteConfiguration() === null) {
+			throw new Exception('Page has no configuration!');
+		}
+
+		$this->setupPage();
+
+		$this->runPage();
+	}
+
+	public function assignCSRFToken()
+	{
+		$token = $this->tokenManager->getNewToken();
+		$this->assign('csrfTokenData', $token->getTokenData());
+	}
+
+	public function validateCSRFToken()
+	{
+		if (!$this->tokenManager->validateToken(WebRequest::postString('csrfTokenData'))) {
+			throw new ApplicationLogicException('Form token is not valid, please reload and try again');
+		}
+	}
+
+	protected function sendResponseHeaders()
+	{
+		if (headers_sent()) {
+			throw new ApplicationLogicException('Headers have already been sent! This is likely a bug in the application.');
+		}
+
+		// send the CSP headers now
+		header($this->getCspManager()->getHeader());
+
+		foreach ($this->headerQueue as $item) {
+			if (mb_strpos($item, "\r") !== false || mb_strpos($item, "\n") !== false) {
+				// Oops. We're not allowed to do this.
+				throw new Exception('Unable to split header');
+			}
+
+			header($item);
+		}
+	}
 }

includes/Fragments/RequestData.php

Indentation +339 added lines, -339 removed lines

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

includes/Fragments/NavigationMenuAccessControl.php

Indentation +95 added lines, -95 removed lines

@@ -36,111 +36,111 @@
 
 trait NavigationMenuAccessControl
 {
-    protected abstract function assign($name, $value);
+	protected abstract function assign($name, $value);
 
-    /**
-     * @return SecurityManager
-     */
-    protected abstract function getSecurityManager();
+	/**
+	 * @return SecurityManager
+	 */
+	protected abstract function getSecurityManager();
 
-    public abstract function getDomainAccessManager(): DomainAccessManager;
+	public abstract function getDomainAccessManager(): DomainAccessManager;
 
-    /**
-     * @param $currentUser
-     */
-    protected function setupNavMenuAccess($currentUser)
-    {
-        $this->assign('nav__canRequests', $this->getSecurityManager()
-                ->allows(PageMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+	/**
+	 * @param $currentUser
+	 */
+	protected function setupNavMenuAccess($currentUser)
+	{
+		$this->assign('nav__canRequests', $this->getSecurityManager()
+				->allows(PageMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canLogs', $this->getSecurityManager()
-                ->allows(PageLog::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canUsers', $this->getSecurityManager()
-                ->allows(StatsUsers::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canSearch', $this->getSecurityManager()
-                ->allows(PageSearch::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canStats', $this->getSecurityManager()
-                ->allows(StatsMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canLogs', $this->getSecurityManager()
+				->allows(PageLog::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canUsers', $this->getSecurityManager()
+				->allows(StatsUsers::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canSearch', $this->getSecurityManager()
+				->allows(PageSearch::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canStats', $this->getSecurityManager()
+				->allows(StatsMain::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canBan', $this->getSecurityManager()
-                ->allows(PageBan::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canEmailMgmt', $this->getSecurityManager()
-                ->allows(PageEmailManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canWelcomeMgmt', $this->getSecurityManager()
-                ->allows(PageWelcomeTemplateManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canSiteNoticeMgmt', $this->getSecurityManager()
-                ->allows(PageSiteNotice::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canUserMgmt', $this->getSecurityManager()
-                ->allows(PageUserManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canJobQueue', $this->getSecurityManager()
-                ->allows(PageJobQueue::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canDomainMgmt', $this->getSecurityManager()
-                ->allows(PageDomainManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canFlaggedComments', $this->getSecurityManager()
-                ->allows(PageListFlaggedComments::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canQueueMgmt', $this->getSecurityManager()
-                ->allows(PageQueueManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canFormMgmt', $this->getSecurityManager()
-                ->allows(PageRequestFormManagement::class, RoleConfiguration::MAIN,
-                    $currentUser) === SecurityManager::ALLOWED);
-        $this->assign('nav__canErrorLog', $this->getSecurityManager()
-                ->allows(PageErrorLogViewer::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canBan', $this->getSecurityManager()
+				->allows(PageBan::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canEmailMgmt', $this->getSecurityManager()
+				->allows(PageEmailManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canWelcomeMgmt', $this->getSecurityManager()
+				->allows(PageWelcomeTemplateManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canSiteNoticeMgmt', $this->getSecurityManager()
+				->allows(PageSiteNotice::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canUserMgmt', $this->getSecurityManager()
+				->allows(PageUserManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canJobQueue', $this->getSecurityManager()
+				->allows(PageJobQueue::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canDomainMgmt', $this->getSecurityManager()
+				->allows(PageDomainManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canFlaggedComments', $this->getSecurityManager()
+				->allows(PageListFlaggedComments::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canQueueMgmt', $this->getSecurityManager()
+				->allows(PageQueueManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canFormMgmt', $this->getSecurityManager()
+				->allows(PageRequestFormManagement::class, RoleConfiguration::MAIN,
+					$currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canErrorLog', $this->getSecurityManager()
+				->allows(PageErrorLogViewer::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__canViewRequest', $this->getSecurityManager()
-                ->allows(PageViewRequest::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
+		$this->assign('nav__canViewRequest', $this->getSecurityManager()
+				->allows(PageViewRequest::class, RoleConfiguration::MAIN, $currentUser) === SecurityManager::ALLOWED);
 
-        $this->assign('nav__domainList', []);
-        if ($this->getDomainAccessManager() !== null) {
-            $this->assign('nav__domainList', $this->getDomainAccessManager()->getAllowedDomains($currentUser));
-        }
-    }
+		$this->assign('nav__domainList', []);
+		if ($this->getDomainAccessManager() !== null) {
+			$this->assign('nav__domainList', $this->getDomainAccessManager()->getAllowedDomains($currentUser));
+		}
+	}
 
-    /**
-     * Sets up the badges to draw attention to issues on various admin pages.
-     *
-     * This function checks to see if a user can access the pages, and if so checks the count of problem areas.
-     * If problem areas are found, a number greater than 0 will cause the badge to show up.
-     *
-     * @param User        $currentUser The current user
-     * @param PdoDatabase $database    Database instance
-     *
-     * @return void
-     */
-    public function setUpNavBarBadges(User $currentUser, PdoDatabase $database) {
-        // Set up some variables.
-        // A size of 0 causes nothing to show up on the page (checked on navigation-menu.tpl) so leaving it 0 here is fine.
-        $countOfFlagged = 0;
-        $countOfJobQueue = 0;
+	/**
+	 * Sets up the badges to draw attention to issues on various admin pages.
+	 *
+	 * This function checks to see if a user can access the pages, and if so checks the count of problem areas.
+	 * If problem areas are found, a number greater than 0 will cause the badge to show up.
+	 *
+	 * @param User        $currentUser The current user
+	 * @param PdoDatabase $database    Database instance
+	 *
+	 * @return void
+	 */
+	public function setUpNavBarBadges(User $currentUser, PdoDatabase $database) {
+		// Set up some variables.
+		// A size of 0 causes nothing to show up on the page (checked on navigation-menu.tpl) so leaving it 0 here is fine.
+		$countOfFlagged = 0;
+		$countOfJobQueue = 0;
 
-        // Count of flagged comments:
-        if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageListFlaggedComments::class)) {
-            // We want all flagged comments that haven't been acknowledged if we can visit the page.
-            $countOfFlagged = sizeof(Comment::getFlaggedComments($database));
-        }
+		// Count of flagged comments:
+		if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageListFlaggedComments::class)) {
+			// We want all flagged comments that haven't been acknowledged if we can visit the page.
+			$countOfFlagged = sizeof(Comment::getFlaggedComments($database));
+		}
 
-        // Count of failed job queue changes:
-        if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageJobQueue::class)) {
-            // We want all failed jobs that haven't been acknowledged if we can visit the page.
-            JobQueueSearchHelper::get($database)
-                ->statusIn([JobQueue::STATUS_FAILED])
-                ->notAcknowledged()
-                ->getRecordCount($countOfJobQueue);
-        }
+		// Count of failed job queue changes:
+		if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageJobQueue::class)) {
+			// We want all failed jobs that haven't been acknowledged if we can visit the page.
+			JobQueueSearchHelper::get($database)
+				->statusIn([JobQueue::STATUS_FAILED])
+				->notAcknowledged()
+				->getRecordCount($countOfJobQueue);
+		}
 
-        // To generate the main badge, add both up.
-        // If we add more badges in the future, don't forget to add them here!
-        $countOfAll = $countOfFlagged + $countOfJobQueue;
+		// To generate the main badge, add both up.
+		// If we add more badges in the future, don't forget to add them here!
+		$countOfAll = $countOfFlagged + $countOfJobQueue;
 
-        // Set badge variables
-        $this->assign("nav__numFlaggedComments", $countOfFlagged);
-        $this->assign("nav__numJobQueueFailed", $countOfJobQueue);
-        $this->assign("nav__numAdmin", $countOfAll);
-    }
+		// Set badge variables
+		$this->assign("nav__numFlaggedComments", $countOfFlagged);
+		$this->assign("nav__numJobQueueFailed", $countOfJobQueue);
+		$this->assign("nav__numAdmin", $countOfAll);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -120,13 +120,13 @@
         $countOfJobQueue = 0;
 
         // Count of flagged comments:
-        if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageListFlaggedComments::class)) {
+        if ($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageListFlaggedComments::class)) {
             // We want all flagged comments that haven't been acknowledged if we can visit the page.
             $countOfFlagged = sizeof(Comment::getFlaggedComments($database));
         }
 
         // Count of failed job queue changes:
-        if($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageJobQueue::class)) {
+        if ($this->barrierTest(RoleConfiguration::MAIN, $currentUser, PageJobQueue::class)) {
             // We want all failed jobs that haven't been acknowledged if we can visit the page.
             JobQueueSearchHelper::get($database)
                 ->statusIn([JobQueue::STATUS_FAILED])

Braces +2 added lines, -1 removed lines

@@ -113,7 +113,8 @@
      *
      * @return void
      */
-    public function setUpNavBarBadges(User $currentUser, PdoDatabase $database) {
+    public function setUpNavBarBadges(User $currentUser, PdoDatabase $database)
+    {
         // Set up some variables.
         // A size of 0 causes nothing to show up on the page (checked on navigation-menu.tpl) so leaving it 0 here is fine.
         $countOfFlagged = 0;

includes/Fragments/TemplateOutput.php

Indentation +105 added lines, -105 removed lines

@@ -15,109 +15,109 @@
 
 trait TemplateOutput
 {
-    /** @var Smarty */
-    private $smarty;
-    /** @var string Extra JavaScript to include at the end of the page's execution */
-    private $tailScript;
-    /** @var string */
-    private $tailScriptNonce;
-
-    /**
-     * @return SiteConfiguration
-     */
-    protected abstract function getSiteConfiguration();
-
-    /**
-     * Include extra JavaScript at the end of the page's execution
-     *
-     * @param $nonce string CSP Nonce generated by ContentSecurityPolicyManager::getNonce()
-     * @param $script string JavaScript to include at the end of the page
-     */
-    final protected function setTailScript($nonce, $script)
-    {
-        $this->tailScriptNonce = $nonce;
-        $this->tailScript = $script;
-    }
-
-    /**
-     * Assigns a Smarty variable
-     *
-     * @param  array|string $name  the template variable name(s)
-     * @param  mixed        $value the value to assign
-     */
-    final protected function assign($name, $value)
-    {
-        $this->smarty->assign($name, $value);
-    }
-
-    /**
-     * Sets up the variables used by the main Smarty base template.
-     *
-     * This list is getting kinda long.
-     */
-    final protected function setUpSmarty()
-    {
-        $this->smarty = new Smarty();
-        $this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
-
-        $this->assign('currentUser', User::getCommunity());
-        $this->assign('currentDomain', null);
-        $this->assign('loggedIn', false);
-        $this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
-        $this->assign('resourceCacheEpoch', $this->getSiteConfiguration()->getResourceCacheEpoch());
-
-        $this->assign('siteNoticeText', '');
-        $this->assign('siteNoticeVersion', 0);
-        $this->assign('siteNoticeState', 'd-none');
-        $this->assign('toolversion', Environment::getToolVersion());
-
-        // default these
-        $this->assign('onlineusers', array());
-        $this->assign('typeAheadBlock', '');
-        $this->assign('extraJs', array());
-
-        // nav menu access control
-        $this->assign('nav__canRequests', false);
-        $this->assign('nav__canLogs', false);
-        $this->assign('nav__canUsers', false);
-        $this->assign('nav__canSearch', false);
-        $this->assign('nav__canStats', false);
-        $this->assign('nav__canBan', false);
-        $this->assign('nav__canEmailMgmt', false);
-        $this->assign('nav__canWelcomeMgmt', false);
-        $this->assign('nav__canSiteNoticeMgmt', false);
-        $this->assign('nav__canUserMgmt', false);
-        $this->assign('nav__canViewRequest', false);
-        $this->assign('nav__canJobQueue', false);
-        $this->assign('nav__canFlaggedComments', false);
-        $this->assign('nav__canDomainMgmt', false);
-        $this->assign('nav__canQueueMgmt', false);
-        $this->assign('nav__canFormMgmt', false);
-        $this->assign('nav__canErrorLog', false);
-
-        // Navigation badges for concern areas.
-        $this->assign("nav__numAdmin", 0);
-        $this->assign("nav__numFlaggedComments", 0);
-        $this->assign("nav__numJobQueueFailed", 0);
-
-        // debug helpers
-        $this->assign('showDebugCssBreakpoints', $this->getSiteConfiguration()->getDebuggingCssBreakpointsEnabled());
-
-        $this->assign('page', $this);
-    }
-
-    /**
-     * Fetches a rendered Smarty template
-     *
-     * @param $template string Template file path, relative to /templates/
-     *
-     * @return string Templated HTML
-     */
-    final protected function fetchTemplate($template)
-    {
-        $this->assign('tailScript', $this->tailScript);
-        $this->assign('tailScriptNonce', $this->tailScriptNonce);
-
-        return $this->smarty->fetch($template);
-    }
+	/** @var Smarty */
+	private $smarty;
+	/** @var string Extra JavaScript to include at the end of the page's execution */
+	private $tailScript;
+	/** @var string */
+	private $tailScriptNonce;
+
+	/**
+	 * @return SiteConfiguration
+	 */
+	protected abstract function getSiteConfiguration();
+
+	/**
+	 * Include extra JavaScript at the end of the page's execution
+	 *
+	 * @param $nonce string CSP Nonce generated by ContentSecurityPolicyManager::getNonce()
+	 * @param $script string JavaScript to include at the end of the page
+	 */
+	final protected function setTailScript($nonce, $script)
+	{
+		$this->tailScriptNonce = $nonce;
+		$this->tailScript = $script;
+	}
+
+	/**
+	 * Assigns a Smarty variable
+	 *
+	 * @param  array|string $name  the template variable name(s)
+	 * @param  mixed        $value the value to assign
+	 */
+	final protected function assign($name, $value)
+	{
+		$this->smarty->assign($name, $value);
+	}
+
+	/**
+	 * Sets up the variables used by the main Smarty base template.
+	 *
+	 * This list is getting kinda long.
+	 */
+	final protected function setUpSmarty()
+	{
+		$this->smarty = new Smarty();
+		$this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
+
+		$this->assign('currentUser', User::getCommunity());
+		$this->assign('currentDomain', null);
+		$this->assign('loggedIn', false);
+		$this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
+		$this->assign('resourceCacheEpoch', $this->getSiteConfiguration()->getResourceCacheEpoch());
+
+		$this->assign('siteNoticeText', '');
+		$this->assign('siteNoticeVersion', 0);
+		$this->assign('siteNoticeState', 'd-none');
+		$this->assign('toolversion', Environment::getToolVersion());
+
+		// default these
+		$this->assign('onlineusers', array());
+		$this->assign('typeAheadBlock', '');
+		$this->assign('extraJs', array());
+
+		// nav menu access control
+		$this->assign('nav__canRequests', false);
+		$this->assign('nav__canLogs', false);
+		$this->assign('nav__canUsers', false);
+		$this->assign('nav__canSearch', false);
+		$this->assign('nav__canStats', false);
+		$this->assign('nav__canBan', false);
+		$this->assign('nav__canEmailMgmt', false);
+		$this->assign('nav__canWelcomeMgmt', false);
+		$this->assign('nav__canSiteNoticeMgmt', false);
+		$this->assign('nav__canUserMgmt', false);
+		$this->assign('nav__canViewRequest', false);
+		$this->assign('nav__canJobQueue', false);
+		$this->assign('nav__canFlaggedComments', false);
+		$this->assign('nav__canDomainMgmt', false);
+		$this->assign('nav__canQueueMgmt', false);
+		$this->assign('nav__canFormMgmt', false);
+		$this->assign('nav__canErrorLog', false);
+
+		// Navigation badges for concern areas.
+		$this->assign("nav__numAdmin", 0);
+		$this->assign("nav__numFlaggedComments", 0);
+		$this->assign("nav__numJobQueueFailed", 0);
+
+		// debug helpers
+		$this->assign('showDebugCssBreakpoints', $this->getSiteConfiguration()->getDebuggingCssBreakpointsEnabled());
+
+		$this->assign('page', $this);
+	}
+
+	/**
+	 * Fetches a rendered Smarty template
+	 *
+	 * @param $template string Template file path, relative to /templates/
+	 *
+	 * @return string Templated HTML
+	 */
+	final protected function fetchTemplate($template)
+	{
+		$this->assign('tailScript', $this->tailScript);
+		$this->assign('tailScriptNonce', $this->tailScriptNonce);
+
+		return $this->smarty->fetch($template);
+	}
 }

includes/ConsoleTasks/RecreateTrustedIpTableTask.php

Indentation +148 added lines, -148 removed lines

@@ -16,152 +16,152 @@
 
 class RecreateTrustedIpTableTask extends ConsoleTaskBase
 {
-    public function execute()
-    {
-
-        echo "Fetching file...\n";
-
-        $htmlfile = file($this->getSiteConfiguration()->getXffTrustedHostsFile(),
-            FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
-
-        $ip = array();
-        $iprange = array();
-        $dnsdomain = array();
-
-        echo "Sorting file...\n";
-        $this->readFile($htmlfile, $iprange, $ip, $dnsdomain);
-
-        echo "Exploding CIDRs...\n";
-        $this->explodeCidrs($iprange, $ip);
-
-        echo "Resolving DNS...\n";
-        $this->resolveDns($dnsdomain, $ip);
-
-        echo "Uniq-ing array...\n";
-
-        $ip = array_unique($ip);
-
-        $database = $this->getDatabase();
-
-        $database->exec('DELETE FROM xfftrustcache;');
-
-        $insert = $database->prepare('INSERT INTO xfftrustcache (ip) VALUES (:ip);');
-
-        $this->doInserts($ip, $insert);
-    }
-
-    /**
-     * @param string[] $dnsDomains  the DNS domains to resolve
-     * @param string[] $ipAddresses existing array of IPs to add to
-     */
-    protected function resolveDns($dnsDomains, &$ipAddresses)
-    {
-        foreach ($dnsDomains as $domain) {
-            $ipList = gethostbynamel($domain);
-
-            if ($ipList === false) {
-                echo "Invalid DNS name $domain\n";
-                continue;
-            }
-
-            foreach ($ipList as $ipAddress) {
-                $ipAddresses[] = $ipAddress;
-            }
-
-            // don't DoS
-            usleep(10000);
-        }
-    }
-
-    /**
-     * @param $iprange
-     * @param $ip
-     */
-    protected function explodeCidrs($iprange, &$ip)
-    {
-        foreach ($iprange as $r) {
-            $ips = $this->getXffTrustProvider()->explodeCidr($r);
-
-            foreach ($ips as $i) {
-                $ip[] = $i;
-            }
-        }
-    }
-
-    /**
-     * @param $htmlfile
-     * @param $iprange
-     * @param $ip
-     * @param $dnsdomain
-     */
-    protected function readFile($htmlfile, &$iprange, &$ip, &$dnsdomain)
-    {
-        foreach ($htmlfile as $line_num => $rawline) {
-            // remove the comments
-            $hashPos = strpos($rawline, '#');
-            if ($hashPos !== false) {
-                $line = substr($rawline, 0, $hashPos);
-            }
-            else {
-                $line = $rawline;
-            }
-
-            $line = trim($line);
-
-            // this was a comment or empty line...
-            if ($line == "") {
-                continue;
-            }
-
-            // match a regex of an CIDR range:
-            $ipcidr = '@' . RegexConstants::IPV4 . RegexConstants::IPV4_CIDR . '@';
-            if (preg_match($ipcidr, $line) === 1) {
-                $iprange[] = $line;
-                continue;
-            }
-
-            $ipnoncidr = '@' . RegexConstants::IPV4 . '@';
-            if (preg_match($ipnoncidr, $line) === 1) {
-                $ip[] = $line;
-                continue;
-            }
-
-            // it's probably a DNS name.
-            $dnsdomain[] = $line;
-        }
-    }
-
-    /**
-     * @param array        $ip
-     * @param PDOStatement $insert
-     *
-     * @throws Exception
-     */
-    protected function doInserts($ip, PDOStatement $insert)
-    {
-        $successful = true;
-
-        foreach ($ip as $i) {
-            if (strlen($i) > 15) {
-                echo "Rejected $i\n";
-                $successful = false;
-
-                continue;
-            }
-
-            try {
-                $insert->execute(array(':ip' => $i));
-            }
-            catch (PDOException $ex) {
-                echo "Exception on $i :\n";
-                echo $ex->getMessage();
-                $successful = false;
-                break;
-            }
-        }
-
-        if (!$successful) {
-            throw new Exception('Encountered errors during transaction processing');
-        }
-    }
+	public function execute()
+	{
+
+		echo "Fetching file...\n";
+
+		$htmlfile = file($this->getSiteConfiguration()->getXffTrustedHostsFile(),
+			FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+
+		$ip = array();
+		$iprange = array();
+		$dnsdomain = array();
+
+		echo "Sorting file...\n";
+		$this->readFile($htmlfile, $iprange, $ip, $dnsdomain);
+
+		echo "Exploding CIDRs...\n";
+		$this->explodeCidrs($iprange, $ip);
+
+		echo "Resolving DNS...\n";
+		$this->resolveDns($dnsdomain, $ip);
+
+		echo "Uniq-ing array...\n";
+
+		$ip = array_unique($ip);
+
+		$database = $this->getDatabase();
+
+		$database->exec('DELETE FROM xfftrustcache;');
+
+		$insert = $database->prepare('INSERT INTO xfftrustcache (ip) VALUES (:ip);');
+
+		$this->doInserts($ip, $insert);
+	}
+
+	/**
+	 * @param string[] $dnsDomains  the DNS domains to resolve
+	 * @param string[] $ipAddresses existing array of IPs to add to
+	 */
+	protected function resolveDns($dnsDomains, &$ipAddresses)
+	{
+		foreach ($dnsDomains as $domain) {
+			$ipList = gethostbynamel($domain);
+
+			if ($ipList === false) {
+				echo "Invalid DNS name $domain\n";
+				continue;
+			}
+
+			foreach ($ipList as $ipAddress) {
+				$ipAddresses[] = $ipAddress;
+			}
+
+			// don't DoS
+			usleep(10000);
+		}
+	}
+
+	/**
+	 * @param $iprange
+	 * @param $ip
+	 */
+	protected function explodeCidrs($iprange, &$ip)
+	{
+		foreach ($iprange as $r) {
+			$ips = $this->getXffTrustProvider()->explodeCidr($r);
+
+			foreach ($ips as $i) {
+				$ip[] = $i;
+			}
+		}
+	}
+
+	/**
+	 * @param $htmlfile
+	 * @param $iprange
+	 * @param $ip
+	 * @param $dnsdomain
+	 */
+	protected function readFile($htmlfile, &$iprange, &$ip, &$dnsdomain)
+	{
+		foreach ($htmlfile as $line_num => $rawline) {
+			// remove the comments
+			$hashPos = strpos($rawline, '#');
+			if ($hashPos !== false) {
+				$line = substr($rawline, 0, $hashPos);
+			}
+			else {
+				$line = $rawline;
+			}
+
+			$line = trim($line);
+
+			// this was a comment or empty line...
+			if ($line == "") {
+				continue;
+			}
+
+			// match a regex of an CIDR range:
+			$ipcidr = '@' . RegexConstants::IPV4 . RegexConstants::IPV4_CIDR . '@';
+			if (preg_match($ipcidr, $line) === 1) {
+				$iprange[] = $line;
+				continue;
+			}
+
+			$ipnoncidr = '@' . RegexConstants::IPV4 . '@';
+			if (preg_match($ipnoncidr, $line) === 1) {
+				$ip[] = $line;
+				continue;
+			}
+
+			// it's probably a DNS name.
+			$dnsdomain[] = $line;
+		}
+	}
+
+	/**
+	 * @param array        $ip
+	 * @param PDOStatement $insert
+	 *
+	 * @throws Exception
+	 */
+	protected function doInserts($ip, PDOStatement $insert)
+	{
+		$successful = true;
+
+		foreach ($ip as $i) {
+			if (strlen($i) > 15) {
+				echo "Rejected $i\n";
+				$successful = false;
+
+				continue;
+			}
+
+			try {
+				$insert->execute(array(':ip' => $i));
+			}
+			catch (PDOException $ex) {
+				echo "Exception on $i :\n";
+				echo $ex->getMessage();
+				$successful = false;
+				break;
+			}
+		}
+
+		if (!$successful) {
+			throw new Exception('Encountered errors during transaction processing');
+		}
+	}
 }
\ No newline at end of file

includes/ConsoleTasks/RunJobQueueTask.php

Indentation +168 added lines, -168 removed lines

@@ -23,172 +23,172 @@
 
 class RunJobQueueTask extends ConsoleTaskBase
 {
-    private $taskList = array(
-        WelcomeUserTask::class,
-        BotCreationTask::class,
-        UserCreationTask::class
-    );
-
-    public function execute()
-    {
-        $database = $this->getDatabase();
-
-        // ensure we're running inside a tx here.
-        if (!$database->hasActiveTransaction()) {
-            $database->beginTransaction();
-        }
-
-        $sql = 'SELECT * FROM jobqueue WHERE status = :status ORDER BY enqueue LIMIT :lim';
-        $statement = $database->prepare($sql);
-        $statement->execute(array(
-            ':status' => JobQueue::STATUS_READY,
-            ':lim' => $this->getSiteConfiguration()->getJobQueueBatchSize()
-        ));
-
-        /** @var JobQueue[] $queuedJobs */
-        $queuedJobs = $statement->fetchAll(PDO::FETCH_CLASS, JobQueue::class);
-
-        // mark all the jobs as running, and commit the txn so we're not holding onto long-running transactions.
-        // We'll re-lock the row when we get to it.
-        foreach ($queuedJobs as $job) {
-            $job->setDatabase($database);
-            $job->setStatus(JobQueue::STATUS_WAITING);
-            $job->setError(null);
-            $job->setAcknowledged(null);
-            $job->save();
-        }
-
-        $database->commit();
-
-        set_error_handler(array(RunJobQueueTask::class, 'errorHandler'), E_ALL);
-
-        foreach ($queuedJobs as $job) {
-            try {
-                // refresh from the database
-                /** @var JobQueue $job */
-                $job = JobQueue::getById($job->getId(), $database);
-
-                if ($job->getStatus() !== JobQueue::STATUS_WAITING) {
-                    continue;
-                }
-
-                $database->beginTransaction();
-                $job->setStatus(JobQueue::STATUS_RUNNING);
-                $job->save();
-                $database->commit();
-
-                $database->beginTransaction();
-
-                // re-lock the job
-                $job->setStatus(JobQueue::STATUS_RUNNING);
-                $job->save();
-
-                // validate we're allowed to run the requested task (whitelist)
-                if (!in_array($job->getTask(), $this->taskList)) {
-                    throw new ApplicationLogicException('Job task not registered');
-                }
-
-                // Create a task.
-                $taskName = $job->getTask();
-
-                if (!class_exists($taskName)) {
-                    throw new ApplicationLogicException('Job task does not exist');
-                }
-
-                /** @var BackgroundTaskBase $task */
-                $task = new $taskName;
-
-                $this->setupTask($task, $job);
-                $task->run();
-            }
-            catch (Exception $ex) {
-                $database->rollBack();
-                try {
-                    $database->beginTransaction();
-
-                    /** @var JobQueue $job */
-                    $job = JobQueue::getById($job->getId(), $database);
-                    $job->setDatabase($database);
-                    $job->setStatus(JobQueue::STATUS_FAILED);
-                    $job->setError($ex->getMessage());
-                    $job->setAcknowledged(0);
-                    $job->save();
-
-                    Logger::backgroundJobIssue($this->getDatabase(), $job);
-
-                    $database->commit();
-                }
-                catch (Exception $ex) {
-                    // oops, something went horribly wrong trying to handle this in a nice way; let's just fall back to
-                    // logging this to disk for a tool root to investigate.
-                    ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
-                }
-            }
-            finally {
-                $database->commit();
-            }
-        }
-
-        $this->stageQueuedTasks($database);
-    }
-
-    /**
-     * @param BackgroundTaskBase $task
-     * @param JobQueue           $job
-     */
-    private function setupTask(BackgroundTaskBase $task, JobQueue $job)
-    {
-        $task->setJob($job);
-        $task->setDatabase($this->getDatabase());
-        $task->setHttpHelper($this->getHttpHelper());
-        $task->setOauthProtocolHelper($this->getOAuthProtocolHelper());
-        $task->setEmailHelper($this->getEmailHelper());
-        $task->setSiteConfiguration($this->getSiteConfiguration());
-        $task->setNotificationHelper($this->getNotificationHelper());
-    }
-
-    /** @noinspection PhpUnusedParameterInspection */
-    public static function errorHandler($errno, $errstr, $errfile, $errline)
-    {
-        throw new Exception($errfile . "@" . $errline . ": " . $errstr);
-    }
-
-    /**
-     * Stages tasks for execution during the *next* jobqueue run.
-     *
-     * This is to build in some delay between enqueue and execution to allow for accidentally-triggered tasks to be
-     * cancelled.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function stageQueuedTasks(PdoDatabase $database): void
-    {
-        try {
-            $database->beginTransaction();
-
-            $sql = 'SELECT * FROM jobqueue WHERE status = :status ORDER BY enqueue LIMIT :lim';
-            $statement = $database->prepare($sql);
-
-            // use a larger batch size than the main runner, but still keep it limited in case things go crazy.
-            $statement->execute(array(
-                ':status' => JobQueue::STATUS_QUEUED,
-                ':lim' => $this->getSiteConfiguration()->getJobQueueBatchSize() * 2
-            ));
-
-            /** @var JobQueue[] $queuedJobs */
-            $queuedJobs = $statement->fetchAll(PDO::FETCH_CLASS, JobQueue::class);
-
-            foreach ($queuedJobs as $job) {
-                $job->setDatabase($database);
-                $job->setStatus(JobQueue::STATUS_READY);
-                $job->save();
-            }
-
-            $database->commit();
-        }
-        catch (Exception $ex) {
-            $database->rollBack();
-            ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
-        }
-    }
+	private $taskList = array(
+		WelcomeUserTask::class,
+		BotCreationTask::class,
+		UserCreationTask::class
+	);
+
+	public function execute()
+	{
+		$database = $this->getDatabase();
+
+		// ensure we're running inside a tx here.
+		if (!$database->hasActiveTransaction()) {
+			$database->beginTransaction();
+		}
+
+		$sql = 'SELECT * FROM jobqueue WHERE status = :status ORDER BY enqueue LIMIT :lim';
+		$statement = $database->prepare($sql);
+		$statement->execute(array(
+			':status' => JobQueue::STATUS_READY,
+			':lim' => $this->getSiteConfiguration()->getJobQueueBatchSize()
+		));
+
+		/** @var JobQueue[] $queuedJobs */
+		$queuedJobs = $statement->fetchAll(PDO::FETCH_CLASS, JobQueue::class);
+
+		// mark all the jobs as running, and commit the txn so we're not holding onto long-running transactions.
+		// We'll re-lock the row when we get to it.
+		foreach ($queuedJobs as $job) {
+			$job->setDatabase($database);
+			$job->setStatus(JobQueue::STATUS_WAITING);
+			$job->setError(null);
+			$job->setAcknowledged(null);
+			$job->save();
+		}
+
+		$database->commit();
+
+		set_error_handler(array(RunJobQueueTask::class, 'errorHandler'), E_ALL);
+
+		foreach ($queuedJobs as $job) {
+			try {
+				// refresh from the database
+				/** @var JobQueue $job */
+				$job = JobQueue::getById($job->getId(), $database);
+
+				if ($job->getStatus() !== JobQueue::STATUS_WAITING) {
+					continue;
+				}
+
+				$database->beginTransaction();
+				$job->setStatus(JobQueue::STATUS_RUNNING);
+				$job->save();
+				$database->commit();
+
+				$database->beginTransaction();
+
+				// re-lock the job
+				$job->setStatus(JobQueue::STATUS_RUNNING);
+				$job->save();
+
+				// validate we're allowed to run the requested task (whitelist)
+				if (!in_array($job->getTask(), $this->taskList)) {
+					throw new ApplicationLogicException('Job task not registered');
+				}
+
+				// Create a task.
+				$taskName = $job->getTask();
+
+				if (!class_exists($taskName)) {
+					throw new ApplicationLogicException('Job task does not exist');
+				}
+
+				/** @var BackgroundTaskBase $task */
+				$task = new $taskName;
+
+				$this->setupTask($task, $job);
+				$task->run();
+			}
+			catch (Exception $ex) {
+				$database->rollBack();
+				try {
+					$database->beginTransaction();
+
+					/** @var JobQueue $job */
+					$job = JobQueue::getById($job->getId(), $database);
+					$job->setDatabase($database);
+					$job->setStatus(JobQueue::STATUS_FAILED);
+					$job->setError($ex->getMessage());
+					$job->setAcknowledged(0);
+					$job->save();
+
+					Logger::backgroundJobIssue($this->getDatabase(), $job);
+
+					$database->commit();
+				}
+				catch (Exception $ex) {
+					// oops, something went horribly wrong trying to handle this in a nice way; let's just fall back to
+					// logging this to disk for a tool root to investigate.
+					ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
+				}
+			}
+			finally {
+				$database->commit();
+			}
+		}
+
+		$this->stageQueuedTasks($database);
+	}
+
+	/**
+	 * @param BackgroundTaskBase $task
+	 * @param JobQueue           $job
+	 */
+	private function setupTask(BackgroundTaskBase $task, JobQueue $job)
+	{
+		$task->setJob($job);
+		$task->setDatabase($this->getDatabase());
+		$task->setHttpHelper($this->getHttpHelper());
+		$task->setOauthProtocolHelper($this->getOAuthProtocolHelper());
+		$task->setEmailHelper($this->getEmailHelper());
+		$task->setSiteConfiguration($this->getSiteConfiguration());
+		$task->setNotificationHelper($this->getNotificationHelper());
+	}
+
+	/** @noinspection PhpUnusedParameterInspection */
+	public static function errorHandler($errno, $errstr, $errfile, $errline)
+	{
+		throw new Exception($errfile . "@" . $errline . ": " . $errstr);
+	}
+
+	/**
+	 * Stages tasks for execution during the *next* jobqueue run.
+	 *
+	 * This is to build in some delay between enqueue and execution to allow for accidentally-triggered tasks to be
+	 * cancelled.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function stageQueuedTasks(PdoDatabase $database): void
+	{
+		try {
+			$database->beginTransaction();
+
+			$sql = 'SELECT * FROM jobqueue WHERE status = :status ORDER BY enqueue LIMIT :lim';
+			$statement = $database->prepare($sql);
+
+			// use a larger batch size than the main runner, but still keep it limited in case things go crazy.
+			$statement->execute(array(
+				':status' => JobQueue::STATUS_QUEUED,
+				':lim' => $this->getSiteConfiguration()->getJobQueueBatchSize() * 2
+			));
+
+			/** @var JobQueue[] $queuedJobs */
+			$queuedJobs = $statement->fetchAll(PDO::FETCH_CLASS, JobQueue::class);
+
+			foreach ($queuedJobs as $job) {
+				$job->setDatabase($database);
+				$job->setStatus(JobQueue::STATUS_READY);
+				$job->save();
+			}
+
+			$database->commit();
+		}
+		catch (Exception $ex) {
+			$database->rollBack();
+			ExceptionHandler::logExceptionToDisk($ex, $this->getSiteConfiguration());
+		}
+	}
 }

includes/ConsoleTasks/MigrateToDomains.php

Indentation +4 added lines, -4 removed lines

@@ -14,8 +14,8 @@
 
 class MigrateToDomains extends ConsoleTaskBase
 {
-    public function execute()
-    {
-        echo "This migration script must be run with the entire application at an earlier version.";
-    }
+	public function execute()
+	{
+		echo "This migration script must be run with the entire application at an earlier version.";
+	}
 }