mdaniels5757 / waca

includes/DataObjects/RequestQueue.php

Indentation +422 added lines, -422 removed lines

@@ -17,254 +17,254 @@ 
 
 class RequestQueue extends DataObject
 {
-    const DEFAULT_DEFAULT = 'default';
-    const DEFAULT_ANTISPOOF = 'antispoof';
-    const DEFAULT_TITLEBLACKLIST = 'titleblacklist';
-
-    /** @var int */
-    private $enabled = 0;
-    /** @var int */
-    private $isdefault = 0;
-    /** @var int */
-    private $defaultantispoof = 0;
-    /** @var int */
-    private $defaulttitleblacklist = 0;
-    /** @var int */
-    private $domain;
-    /** @var string */
-    private $apiname;
-    /** @var string */
-    private $displayname;
-    /** @var string */
-    private $header;
-    /** @var string|null */
-    private $help;
-    /**
-     * @var string
-     * @deprecated Removal due as part of #607
-     */
-    private $logname;
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return RequestQueue[]
-     */
-    public static function getAllQueues(PdoDatabase $database)
-    {
-        $statement = $database->prepare(<<<SQL
+	const DEFAULT_DEFAULT = 'default';
+	const DEFAULT_ANTISPOOF = 'antispoof';
+	const DEFAULT_TITLEBLACKLIST = 'titleblacklist';
+
+	/** @var int */
+	private $enabled = 0;
+	/** @var int */
+	private $isdefault = 0;
+	/** @var int */
+	private $defaultantispoof = 0;
+	/** @var int */
+	private $defaulttitleblacklist = 0;
+	/** @var int */
+	private $domain;
+	/** @var string */
+	private $apiname;
+	/** @var string */
+	private $displayname;
+	/** @var string */
+	private $header;
+	/** @var string|null */
+	private $help;
+	/**
+	 * @var string
+	 * @deprecated Removal due as part of #607
+	 */
+	private $logname;
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return RequestQueue[]
+	 */
+	public static function getAllQueues(PdoDatabase $database)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM requestqueue;
 SQL
-        );
-        $statement->execute();
-
-        $resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
-
-        /** @var RequestQueue $t */
-        foreach ($resultObject as $t) {
-            $t->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return RequestQueue[]
-     */
-    public static function getEnabledQueues(PdoDatabase $database)
-    {
-        $statement = $database->prepare(<<<SQL
+		);
+		$statement->execute();
+
+		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
+
+		/** @var RequestQueue $t */
+		foreach ($resultObject as $t) {
+			$t->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return RequestQueue[]
+	 */
+	public static function getEnabledQueues(PdoDatabase $database)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM requestqueue WHERE enabled = 1;
 SQL
-        );
-        $statement->execute();
-
-        $resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
-
-        /** @var RequestQueue $t */
-        foreach ($resultObject as $t) {
-            $t->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param string      $apiName
-     * @param int         $domain
-     *
-     * @return false|RequestQueue
-     */
-    public static function getByApiName(PdoDatabase $database, string $apiName, int $domain)
-    {
-        $statement = $database->prepare(<<<SQL
+		);
+		$statement->execute();
+
+		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
+
+		/** @var RequestQueue $t */
+		foreach ($resultObject as $t) {
+			$t->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param string      $apiName
+	 * @param int         $domain
+	 *
+	 * @return false|RequestQueue
+	 */
+	public static function getByApiName(PdoDatabase $database, string $apiName, int $domain)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM requestqueue WHERE apiname = :apiName AND domain = :domain;
 SQL
-        );
-
-        $statement->execute([
-            ':apiName' => $apiName,
-            ':domain'  => $domain,
-        ]);
-
-        /** @var RequestQueue|false $result */
-        $result = $statement->fetchObject(get_called_class());
-
-        if ($result !== false) {
-            $result->setDatabase($database);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param string      $displayName
-     * @param int         $domain
-     *
-     * @return false|RequestQueue
-     */
-    public static function getByDisplayName(PdoDatabase $database, string $displayName, int $domain)
-    {
-        $statement = $database->prepare(<<<SQL
+		);
+
+		$statement->execute([
+			':apiName' => $apiName,
+			':domain'  => $domain,
+		]);
+
+		/** @var RequestQueue|false $result */
+		$result = $statement->fetchObject(get_called_class());
+
+		if ($result !== false) {
+			$result->setDatabase($database);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param string      $displayName
+	 * @param int         $domain
+	 *
+	 * @return false|RequestQueue
+	 */
+	public static function getByDisplayName(PdoDatabase $database, string $displayName, int $domain)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM requestqueue WHERE displayname = :displayName AND domain = :domain;
 SQL
-        );
-
-        $statement->execute([
-            ':displayName' => $displayName,
-            ':domain'      => $domain,
-        ]);
-
-        /** @var RequestQueue|false $result */
-        $result = $statement->fetchObject(get_called_class());
-
-        if ($result !== false) {
-            $result->setDatabase($database);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param string      $header
-     * @param int         $domain
-     *
-     * @return false|RequestQueue
-     */
-    public static function getByHeader(PdoDatabase $database, string $header, int $domain)
-    {
-        $statement = $database->prepare(<<<SQL
+		);
+
+		$statement->execute([
+			':displayName' => $displayName,
+			':domain'      => $domain,
+		]);
+
+		/** @var RequestQueue|false $result */
+		$result = $statement->fetchObject(get_called_class());
+
+		if ($result !== false) {
+			$result->setDatabase($database);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param string      $header
+	 * @param int         $domain
+	 *
+	 * @return false|RequestQueue
+	 */
+	public static function getByHeader(PdoDatabase $database, string $header, int $domain)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM requestqueue WHERE header = :header AND domain = :domain;
 SQL
-        );
-
-        $statement->execute([
-            ':header' => $header,
-            ':domain' => $domain,
-        ]);
-
-        /** @var RequestQueue|false $result */
-        $result = $statement->fetchObject(get_called_class());
-
-        if ($result !== false) {
-            $result->setDatabase($database);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param int         $domain
-     *
-     * @param string      $defaultType The type of default queue to get.
-     *
-     * @return false|RequestQueue
-     * @throws ApplicationLogicException
-     */
-    public static function getDefaultQueue(PdoDatabase $database, int $domain, string $defaultType = 'default')
-    {
-        switch ($defaultType) {
-            case self::DEFAULT_DEFAULT:
-                $sql = 'SELECT * FROM requestqueue WHERE isdefault = 1 AND domain = :domain;';
-                break;
-            case self::DEFAULT_ANTISPOOF:
-                $sql = 'SELECT * FROM requestqueue WHERE defaultantispoof = 1 AND domain = :domain;';
-                break;
-            case self::DEFAULT_TITLEBLACKLIST:
-                $sql = 'SELECT * FROM requestqueue WHERE defaulttitleblacklist = 1 AND domain = :domain;';
-                break;
-            default:
-                throw new ApplicationLogicException('Unknown request for default queue');
-        }
-
-        $statement = $database->prepare($sql);
-
-        $statement->execute([':domain' => $domain]);
-
-        /** @var RequestQueue|false $result */
-        $result = $statement->fetchObject(get_called_class());
-
-        if ($result !== false) {
-            $result->setDatabase($database);
-        }
-
-        return $result;
-    }
-
-    public function save()
-    {
-        // find and squish existing defaults
-        if ($this->isDefault()) {
-            $squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET isdefault = 0 WHERE isdefault = 1 AND domain = :domain;');
-            $squishStatement->execute([':domain' => $this->domain]);
-        }
-
-        if ($this->isDefaultAntispoof()) {
-            $squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET defaultantispoof = 0 WHERE defaultantispoof = 1 AND domain = :domain;');
-            $squishStatement->execute([':domain' => $this->domain]);
-        }
-
-        if ($this->isDefaultTitleBlacklist()) {
-            $squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET defaulttitleblacklist = 0 WHERE defaulttitleblacklist = 1 AND domain = :domain;');
-            $squishStatement->execute([':domain' => $this->domain]);
-        }
-
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+		);
+
+		$statement->execute([
+			':header' => $header,
+			':domain' => $domain,
+		]);
+
+		/** @var RequestQueue|false $result */
+		$result = $statement->fetchObject(get_called_class());
+
+		if ($result !== false) {
+			$result->setDatabase($database);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param int         $domain
+	 *
+	 * @param string      $defaultType The type of default queue to get.
+	 *
+	 * @return false|RequestQueue
+	 * @throws ApplicationLogicException
+	 */
+	public static function getDefaultQueue(PdoDatabase $database, int $domain, string $defaultType = 'default')
+	{
+		switch ($defaultType) {
+			case self::DEFAULT_DEFAULT:
+				$sql = 'SELECT * FROM requestqueue WHERE isdefault = 1 AND domain = :domain;';
+				break;
+			case self::DEFAULT_ANTISPOOF:
+				$sql = 'SELECT * FROM requestqueue WHERE defaultantispoof = 1 AND domain = :domain;';
+				break;
+			case self::DEFAULT_TITLEBLACKLIST:
+				$sql = 'SELECT * FROM requestqueue WHERE defaulttitleblacklist = 1 AND domain = :domain;';
+				break;
+			default:
+				throw new ApplicationLogicException('Unknown request for default queue');
+		}
+
+		$statement = $database->prepare($sql);
+
+		$statement->execute([':domain' => $domain]);
+
+		/** @var RequestQueue|false $result */
+		$result = $statement->fetchObject(get_called_class());
+
+		if ($result !== false) {
+			$result->setDatabase($database);
+		}
+
+		return $result;
+	}
+
+	public function save()
+	{
+		// find and squish existing defaults
+		if ($this->isDefault()) {
+			$squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET isdefault = 0 WHERE isdefault = 1 AND domain = :domain;');
+			$squishStatement->execute([':domain' => $this->domain]);
+		}
+
+		if ($this->isDefaultAntispoof()) {
+			$squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET defaultantispoof = 0 WHERE defaultantispoof = 1 AND domain = :domain;');
+			$squishStatement->execute([':domain' => $this->domain]);
+		}
+
+		if ($this->isDefaultTitleBlacklist()) {
+			$squishStatement = $this->dbObject->prepare('UPDATE requestqueue SET defaulttitleblacklist = 0 WHERE defaulttitleblacklist = 1 AND domain = :domain;');
+			$squishStatement->execute([':domain' => $this->domain]);
+		}
+
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO requestqueue (
                     enabled, isdefault, defaultantispoof, defaulttitleblacklist, domain, apiname, displayname, header, help, logname
                 ) VALUES (
                     :enabled, :isdefault, :defaultantispoof, :defaulttitleblacklist, :domain, :apiname, :displayname, :header, :help, :logname
                 );
 SQL
-            );
-
-            $statement->bindValue(":enabled", $this->enabled);
-            $statement->bindValue(":isdefault", $this->isdefault);
-            $statement->bindValue(":defaultantispoof", $this->defaultantispoof);
-            $statement->bindValue(":defaulttitleblacklist", $this->defaulttitleblacklist);
-            $statement->bindValue(":domain", $this->domain);
-            $statement->bindValue(":apiname", $this->apiname);
-            $statement->bindValue(":displayname", $this->displayname);
-            $statement->bindValue(":header", $this->header);
-            $statement->bindValue(":help", $this->help);
-            $statement->bindValue(":logname", $this->logname);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+
+			$statement->bindValue(":enabled", $this->enabled);
+			$statement->bindValue(":isdefault", $this->isdefault);
+			$statement->bindValue(":defaultantispoof", $this->defaultantispoof);
+			$statement->bindValue(":defaulttitleblacklist", $this->defaulttitleblacklist);
+			$statement->bindValue(":domain", $this->domain);
+			$statement->bindValue(":apiname", $this->apiname);
+			$statement->bindValue(":displayname", $this->displayname);
+			$statement->bindValue(":header", $this->header);
+			$statement->bindValue(":help", $this->help);
+			$statement->bindValue(":logname", $this->logname);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE requestqueue SET
                     enabled = :enabled,
                     isdefault = :isdefault,
@@ -280,194 +280,194 @@ 
                     updateversion = updateversion + 1
 				WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-
-            $statement->bindValue(":enabled", $this->enabled);
-            $statement->bindValue(":isdefault", $this->isdefault);
-            $statement->bindValue(":defaultantispoof", $this->defaultantispoof);
-            $statement->bindValue(":defaulttitleblacklist", $this->defaulttitleblacklist);
-            $statement->bindValue(":domain", $this->domain);
-            $statement->bindValue(":apiname", $this->apiname);
-            $statement->bindValue(":displayname", $this->displayname);
-            $statement->bindValue(":header", $this->header);
-            $statement->bindValue(":help", $this->help);
-            $statement->bindValue(":logname", $this->logname);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled == 1;
-    }
-
-    /**
-     * @param bool $enabled
-     */
-    public function setEnabled(bool $enabled): void
-    {
-        $this->enabled = $enabled ? 1 : 0;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isDefault(): bool
-    {
-        return $this->isdefault == 1;
-    }
-
-    /**
-     * @param bool $isDefault
-     */
-    public function setDefault(bool $isDefault): void
-    {
-        $this->isdefault = $isDefault ? 1 : 0;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isDefaultAntispoof(): bool
-    {
-        return $this->defaultantispoof == 1;
-    }
-
-    /**
-     * @param bool $isDefault
-     */
-    public function setDefaultAntispoof(bool $isDefault): void
-    {
-        $this->defaultantispoof = $isDefault ? 1 : 0;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isDefaultTitleBlacklist(): bool
-    {
-        return $this->defaulttitleblacklist == 1;
-    }
-
-    /**
-     * @param bool $isDefault
-     */
-    public function setDefaultTitleBlacklist(bool $isDefault): void
-    {
-        $this->defaulttitleblacklist = $isDefault ? 1 : 0;
-    }
-
-    /**
-     * @return int
-     */
-    public function getDomain(): int
-    {
-        return $this->domain;
-    }
-
-    /**
-     * @param int $domain
-     */
-    public function setDomain(int $domain): void
-    {
-        $this->domain = $domain;
-    }
-
-    /**
-     * @return string
-     */
-    public function getApiName(): string
-    {
-        return $this->apiname;
-    }
-
-    /**
-     * @param string $apiName
-     */
-    public function setApiName(string $apiName): void
-    {
-        $this->apiname = $apiName;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDisplayName(): string
-    {
-        return $this->displayname;
-    }
-
-    /**
-     * @param string $displayName
-     */
-    public function setDisplayName(string $displayName): void
-    {
-        $this->displayname = $displayName;
-    }
-
-    /**
-     * @return string
-     */
-    public function getHeader(): string
-    {
-        return $this->header;
-    }
-
-    /**
-     * @param string $header
-     */
-    public function setHeader(string $header): void
-    {
-        $this->header = $header;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getHelp(): ?string
-    {
-        return $this->help;
-    }
-
-    /**
-     * @param string|null $help
-     */
-    public function setHelp(?string $help): void
-    {
-        $this->help = $help;
-    }
-
-    /**
-     * @return string
-     * @deprecated
-     */
-    public function getLogName(): string
-    {
-        return $this->logname;
-    }
-
-    /**
-     * @param string $logName
-     *
-     * @deprecated
-     */
-    public function setLogName(string $logName): void
-    {
-        $this->logname = $logName;
-    }
+			);
+
+			$statement->bindValue(":enabled", $this->enabled);
+			$statement->bindValue(":isdefault", $this->isdefault);
+			$statement->bindValue(":defaultantispoof", $this->defaultantispoof);
+			$statement->bindValue(":defaulttitleblacklist", $this->defaulttitleblacklist);
+			$statement->bindValue(":domain", $this->domain);
+			$statement->bindValue(":apiname", $this->apiname);
+			$statement->bindValue(":displayname", $this->displayname);
+			$statement->bindValue(":header", $this->header);
+			$statement->bindValue(":help", $this->help);
+			$statement->bindValue(":logname", $this->logname);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled == 1;
+	}
+
+	/**
+	 * @param bool $enabled
+	 */
+	public function setEnabled(bool $enabled): void
+	{
+		$this->enabled = $enabled ? 1 : 0;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isDefault(): bool
+	{
+		return $this->isdefault == 1;
+	}
+
+	/**
+	 * @param bool $isDefault
+	 */
+	public function setDefault(bool $isDefault): void
+	{
+		$this->isdefault = $isDefault ? 1 : 0;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isDefaultAntispoof(): bool
+	{
+		return $this->defaultantispoof == 1;
+	}
+
+	/**
+	 * @param bool $isDefault
+	 */
+	public function setDefaultAntispoof(bool $isDefault): void
+	{
+		$this->defaultantispoof = $isDefault ? 1 : 0;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isDefaultTitleBlacklist(): bool
+	{
+		return $this->defaulttitleblacklist == 1;
+	}
+
+	/**
+	 * @param bool $isDefault
+	 */
+	public function setDefaultTitleBlacklist(bool $isDefault): void
+	{
+		$this->defaulttitleblacklist = $isDefault ? 1 : 0;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getDomain(): int
+	{
+		return $this->domain;
+	}
+
+	/**
+	 * @param int $domain
+	 */
+	public function setDomain(int $domain): void
+	{
+		$this->domain = $domain;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getApiName(): string
+	{
+		return $this->apiname;
+	}
+
+	/**
+	 * @param string $apiName
+	 */
+	public function setApiName(string $apiName): void
+	{
+		$this->apiname = $apiName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDisplayName(): string
+	{
+		return $this->displayname;
+	}
+
+	/**
+	 * @param string $displayName
+	 */
+	public function setDisplayName(string $displayName): void
+	{
+		$this->displayname = $displayName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getHeader(): string
+	{
+		return $this->header;
+	}
+
+	/**
+	 * @param string $header
+	 */
+	public function setHeader(string $header): void
+	{
+		$this->header = $header;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getHelp(): ?string
+	{
+		return $this->help;
+	}
+
+	/**
+	 * @param string|null $help
+	 */
+	public function setHelp(?string $help): void
+	{
+		$this->help = $help;
+	}
+
+	/**
+	 * @return string
+	 * @deprecated
+	 */
+	public function getLogName(): string
+	{
+		return $this->logname;
+	}
+
+	/**
+	 * @param string $logName
+	 *
+	 * @deprecated
+	 */
+	public function setLogName(string $logName): void
+	{
+		$this->logname = $logName;
+	}
 }
\ No newline at end of file

Braces +2 added lines, -4 removed lines

@@ -258,12 +258,10 @@
 
             if ($statement->execute()) {
                 $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
+            } else {
                 throw new Exception($statement->errorInfo());
             }
-        }
-        else {
+        } else {
             $statement = $this->dbObject->prepare(<<<SQL
                 UPDATE requestqueue SET
                     enabled = :enabled,

includes/DataObjects/Domain.php

Braces +6 added lines, -9 removed lines

@@ -52,12 +52,10 @@ 
 
                 if ($domain === false) {
                     self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
-                }
-                else {
+                } else {
                     self::$currentDomain = $domain;
                 }
-            }
-            else {
+            } else {
                 self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
             }
         }
@@ -86,7 +84,8 @@ 
         return $result;
     }
 
-    public static function getAll(PdoDatabase $database) {
+    public static function getAll(PdoDatabase $database)
+    {
         $statement = $database->prepare("SELECT * FROM domain;");
         $statement->execute();
 
@@ -155,12 +154,10 @@ 
 
             if ($statement->execute()) {
                 $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
+            } else {
                 throw new Exception($statement->errorInfo());
             }
-        }
-        else {
+        } else {
             $statement = $this->dbObject->prepare(<<<SQL
                 UPDATE domain SET
                     longname = :longname,

Indentation +286 added lines, -286 removed lines

@@ -18,94 +18,94 @@ 
 
 class Domain extends DataObject
 {
-    /** @var string */
-    private $shortname;
-    /** @var string */
-    private $longname;
-    /** @var string */
-    private $wikiarticlepath;
-    /** @var string */
-    private $wikiapipath;
-    /** @var int */
-    private $enabled = 0;
-    /** @var int|null */
-    private $defaultclose;
-    /** @var string */
-    private $defaultlanguage = 'en';
-    /** @var string */
-    private $emailreplyaddress;
-    /** @var string|null */
-    private $notificationtarget;
-    /** @var string */
-    private $localdocumentation;
-
-    /** @var Domain Cache variable of the current domain */
-    private static $currentDomain;
-
-    public static function getCurrent(PdoDatabase $database)
-    {
-        if (self::$currentDomain === null) {
-            $sessionDomain = WebRequest::getSessionDomain();
-
-            if ($sessionDomain !== null) {
-                /** @var Domain $domain */
-                $domain = self::getById($sessionDomain, $database);
-
-                if ($domain === false) {
-                    self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
-                }
-                else {
-                    self::$currentDomain = $domain;
-                }
-            }
-            else {
-                self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
-            }
-        }
-
-        return self::$currentDomain;
-    }
-
-    public static function getByShortName(string $shortName, PdoDatabase $database)
-    {
-        $statement = $database->prepare(<<<SQL
+	/** @var string */
+	private $shortname;
+	/** @var string */
+	private $longname;
+	/** @var string */
+	private $wikiarticlepath;
+	/** @var string */
+	private $wikiapipath;
+	/** @var int */
+	private $enabled = 0;
+	/** @var int|null */
+	private $defaultclose;
+	/** @var string */
+	private $defaultlanguage = 'en';
+	/** @var string */
+	private $emailreplyaddress;
+	/** @var string|null */
+	private $notificationtarget;
+	/** @var string */
+	private $localdocumentation;
+
+	/** @var Domain Cache variable of the current domain */
+	private static $currentDomain;
+
+	public static function getCurrent(PdoDatabase $database)
+	{
+		if (self::$currentDomain === null) {
+			$sessionDomain = WebRequest::getSessionDomain();
+
+			if ($sessionDomain !== null) {
+				/** @var Domain $domain */
+				$domain = self::getById($sessionDomain, $database);
+
+				if ($domain === false) {
+					self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
+				}
+				else {
+					self::$currentDomain = $domain;
+				}
+			}
+			else {
+				self::$currentDomain = self::getById(1, $database); // FIXME: #594 User::getCurrent($database)->getDefaultDomain();
+			}
+		}
+
+		return self::$currentDomain;
+	}
+
+	public static function getByShortName(string $shortName, PdoDatabase $database)
+	{
+		$statement = $database->prepare(<<<SQL
             SELECT * FROM domain WHERE shortname = :name;
 SQL
-        );
+		);
 
-        $statement->execute([
-            ':name' => $shortName,
-        ]);
+		$statement->execute([
+			':name' => $shortName,
+		]);
 
-        /** @var RequestForm|false $result */
-        $result = $statement->fetchObject(get_called_class());
+		/** @var RequestForm|false $result */
+		$result = $statement->fetchObject(get_called_class());
 
-        if ($result !== false) {
-            $result->setDatabase($database);
-        }
+		if ($result !== false) {
+			$result->setDatabase($database);
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    public static function getAll(PdoDatabase $database) {
-        $statement = $database->prepare("SELECT * FROM domain;");
-        $statement->execute();
+	public static function getAll(PdoDatabase $database) {
+		$statement = $database->prepare("SELECT * FROM domain;");
+		$statement->execute();
 
-        $resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
+		$resultObject = $statement->fetchAll(PDO::FETCH_CLASS, get_called_class());
 
-        /** @var Domain $t */
-        foreach ($resultObject as $t) {
-            $t->setDatabase($database);
-        }
+		/** @var Domain $t */
+		foreach ($resultObject as $t) {
+			$t->setDatabase($database);
+		}
 
-        return $resultObject;
-    }
+		return $resultObject;
+	}
 
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO domain (
                     shortname, longname, wikiarticlepath, wikiapipath, enabled, defaultclose, defaultlanguage, 
                     emailreplyaddress, notificationtarget, localdocumentation
@@ -114,29 +114,29 @@ 
                     :emailreplyaddress, :notificationtarget, :localdocumentation
                 );
 SQL
-            );
-
-            $statement->bindValue(":shortname", $this->shortname);
-            $statement->bindValue(":longname", $this->longname);
-            $statement->bindValue(":wikiarticlepath", $this->wikiarticlepath);
-            $statement->bindValue(":wikiapipath", $this->wikiapipath);
-            $statement->bindValue(":enabled", $this->enabled);
-            $statement->bindValue(":defaultclose", $this->defaultclose);
-            $statement->bindValue(":defaultlanguage", $this->defaultlanguage);
-            $statement->bindValue(":emailreplyaddress", $this->emailreplyaddress);
-            $statement->bindValue(":notificationtarget", $this->notificationtarget);
-            $statement->bindValue(":localdocumentation", $this->localdocumentation);
-
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+
+			$statement->bindValue(":shortname", $this->shortname);
+			$statement->bindValue(":longname", $this->longname);
+			$statement->bindValue(":wikiarticlepath", $this->wikiarticlepath);
+			$statement->bindValue(":wikiapipath", $this->wikiapipath);
+			$statement->bindValue(":enabled", $this->enabled);
+			$statement->bindValue(":defaultclose", $this->defaultclose);
+			$statement->bindValue(":defaultlanguage", $this->defaultlanguage);
+			$statement->bindValue(":emailreplyaddress", $this->emailreplyaddress);
+			$statement->bindValue(":notificationtarget", $this->notificationtarget);
+			$statement->bindValue(":localdocumentation", $this->localdocumentation);
+
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			$statement = $this->dbObject->prepare(<<<SQL
                 UPDATE domain SET
                     longname = :longname,
                     wikiarticlepath = :wikiarticlepath,
@@ -151,190 +151,190 @@ 
                     updateversion = updateversion + 1
 				WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-
-            $statement->bindValue(":longname", $this->longname);
-            $statement->bindValue(":wikiarticlepath", $this->wikiarticlepath);
-            $statement->bindValue(":wikiapipath", $this->wikiapipath);
-            $statement->bindValue(":enabled", $this->enabled);
-            $statement->bindValue(":defaultclose", $this->defaultclose);
-            $statement->bindValue(":defaultlanguage", $this->defaultlanguage);
-            $statement->bindValue(":emailreplyaddress", $this->emailreplyaddress);
-            $statement->bindValue(":notificationtarget", $this->notificationtarget);
-            $statement->bindValue(":localdocumentation", $this->localdocumentation);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getShortName(): string
-    {
-        return $this->shortname;
-    }
-
-    /**
-     * @param string $shortName
-     */
-    public function setShortName(string $shortName): void
-    {
-        $this->shortname = $shortName;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLongName(): string
-    {
-        return $this->longname;
-    }
-
-    /**
-     * @param string $longName
-     */
-    public function setLongName(string $longName): void
-    {
-        $this->longname = $longName;
-    }
-
-    /**
-     * @return string
-     */
-    public function getWikiArticlePath(): string
-    {
-        return $this->wikiarticlepath;
-    }
-
-    /**
-     * @param string $wikiArticlePath
-     */
-    public function setWikiArticlePath(string $wikiArticlePath): void
-    {
-        $this->wikiarticlepath = $wikiArticlePath;
-    }
-
-    /**
-     * @return string
-     */
-    public function getWikiApiPath(): string
-    {
-        return $this->wikiapipath;
-    }
-
-    /**
-     * @param string $wikiApiPath
-     */
-    public function setWikiApiPath(string $wikiApiPath): void
-    {
-        $this->wikiapipath = $wikiApiPath;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled == 1;
-    }
-
-    /**
-     * @param bool $enabled
-     */
-    public function setEnabled(bool $enabled): void
-    {
-        $this->enabled = $enabled ? 1 : 0;
-    }
-
-    /**
-     * @return int
-     */
-    public function getDefaultClose(): ?int
-    {
-        return $this->defaultclose;
-    }
-
-    /**
-     * @param int $defaultClose
-     */
-    public function setDefaultClose(?int $defaultClose): void
-    {
-        $this->defaultclose = $defaultClose;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultLanguage(): string
-    {
-        return $this->defaultlanguage;
-    }
-
-    /**
-     * @param string $defaultLanguage
-     */
-    public function setDefaultLanguage(string $defaultLanguage): void
-    {
-        $this->defaultlanguage = $defaultLanguage;
-    }
-
-    /**
-     * @return string
-     */
-    public function getEmailReplyAddress(): string
-    {
-        return $this->emailreplyaddress;
-    }
-
-    /**
-     * @param string $emailReplyAddress
-     */
-    public function setEmailReplyAddress(string $emailReplyAddress): void
-    {
-        $this->emailreplyaddress = $emailReplyAddress;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getNotificationTarget(): ?string
-    {
-        return $this->notificationtarget;
-    }
-
-    /**
-     * @param string|null $notificationTarget
-     */
-    public function setNotificationTarget(?string $notificationTarget): void
-    {
-        $this->notificationtarget = $notificationTarget;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLocalDocumentation(): string
-    {
-        return $this->localdocumentation;
-    }
-
-    /**
-     * @param string $localDocumentation
-     */
-    public function setLocalDocumentation(string $localDocumentation): void
-    {
-        $this->localdocumentation = $localDocumentation;
-    }
+			);
+
+			$statement->bindValue(":longname", $this->longname);
+			$statement->bindValue(":wikiarticlepath", $this->wikiarticlepath);
+			$statement->bindValue(":wikiapipath", $this->wikiapipath);
+			$statement->bindValue(":enabled", $this->enabled);
+			$statement->bindValue(":defaultclose", $this->defaultclose);
+			$statement->bindValue(":defaultlanguage", $this->defaultlanguage);
+			$statement->bindValue(":emailreplyaddress", $this->emailreplyaddress);
+			$statement->bindValue(":notificationtarget", $this->notificationtarget);
+			$statement->bindValue(":localdocumentation", $this->localdocumentation);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getShortName(): string
+	{
+		return $this->shortname;
+	}
+
+	/**
+	 * @param string $shortName
+	 */
+	public function setShortName(string $shortName): void
+	{
+		$this->shortname = $shortName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLongName(): string
+	{
+		return $this->longname;
+	}
+
+	/**
+	 * @param string $longName
+	 */
+	public function setLongName(string $longName): void
+	{
+		$this->longname = $longName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getWikiArticlePath(): string
+	{
+		return $this->wikiarticlepath;
+	}
+
+	/**
+	 * @param string $wikiArticlePath
+	 */
+	public function setWikiArticlePath(string $wikiArticlePath): void
+	{
+		$this->wikiarticlepath = $wikiArticlePath;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getWikiApiPath(): string
+	{
+		return $this->wikiapipath;
+	}
+
+	/**
+	 * @param string $wikiApiPath
+	 */
+	public function setWikiApiPath(string $wikiApiPath): void
+	{
+		$this->wikiapipath = $wikiApiPath;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled == 1;
+	}
+
+	/**
+	 * @param bool $enabled
+	 */
+	public function setEnabled(bool $enabled): void
+	{
+		$this->enabled = $enabled ? 1 : 0;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getDefaultClose(): ?int
+	{
+		return $this->defaultclose;
+	}
+
+	/**
+	 * @param int $defaultClose
+	 */
+	public function setDefaultClose(?int $defaultClose): void
+	{
+		$this->defaultclose = $defaultClose;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultLanguage(): string
+	{
+		return $this->defaultlanguage;
+	}
+
+	/**
+	 * @param string $defaultLanguage
+	 */
+	public function setDefaultLanguage(string $defaultLanguage): void
+	{
+		$this->defaultlanguage = $defaultLanguage;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEmailReplyAddress(): string
+	{
+		return $this->emailreplyaddress;
+	}
+
+	/**
+	 * @param string $emailReplyAddress
+	 */
+	public function setEmailReplyAddress(string $emailReplyAddress): void
+	{
+		$this->emailreplyaddress = $emailReplyAddress;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getNotificationTarget(): ?string
+	{
+		return $this->notificationtarget;
+	}
+
+	/**
+	 * @param string|null $notificationTarget
+	 */
+	public function setNotificationTarget(?string $notificationTarget): void
+	{
+		$this->notificationtarget = $notificationTarget;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLocalDocumentation(): string
+	{
+		return $this->localdocumentation;
+	}
+
+	/**
+	 * @param string $localDocumentation
+	 */
+	public function setLocalDocumentation(string $localDocumentation): void
+	{
+		$this->localdocumentation = $localDocumentation;
+	}
 }
\ No newline at end of file

includes/Tasks/PageBase.php

Indentation +374 added lines, -374 removed lines

@@ -24,378 +24,378 @@
 
 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();
-
-        $database = $this->getDatabase();
-        $currentUser = User::getCurrent($database);
-        $this->assign('currentUser', $currentUser);
-        $this->assign('skin', PreferenceManager::getForCurrent($database)->getPreference(PreferenceManager::PREF_SKIN));
-        $this->assign('currentDomain', Domain::getCurrent($database));
-        $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();
+
+		$database = $this->getDatabase();
+		$currentUser = User::getCurrent($database);
+		$this->assign('currentUser', $currentUser);
+		$this->assign('skin', PreferenceManager::getForCurrent($database)->getPreference(PreferenceManager::PREF_SKIN));
+		$this->assign('currentDomain', Domain::getCurrent($database));
+		$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);
+		}
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -264,8 +264,7 @@
         // Are we changing script?
         if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
             $targetScriptName = $currentScriptName;
-        }
-        else {
+        } else {
             $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
         }
 

includes/Tasks/JsonApiPageBase.php

Indentation +55 added lines, -55 removed lines

@@ -14,69 +14,69 @@
 
 abstract class JsonApiPageBase extends ApiPageBase implements IJsonApiAction
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     *
-     * @return void
-     * @throws ApiException
-     */
-    final protected function main()
-    {
-        if (headers_sent()) {
-            throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
-        }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 *
+	 * @return void
+	 * @throws ApiException
+	 */
+	final protected function main()
+	{
+		if (headers_sent()) {
+			throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
+		}
 
-        // javascript access control
-        $httpOrigin = WebRequest::origin();
+		// javascript access control
+		$httpOrigin = WebRequest::origin();
 
-        if ($httpOrigin !== null) {
-            $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts();
+		if ($httpOrigin !== null) {
+			$CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts();
 
-            if (in_array($httpOrigin, $CORSallowed)) {
-                header("Access-Control-Allow-Origin: " . $httpOrigin);
-            }
-        }
+			if (in_array($httpOrigin, $CORSallowed)) {
+				header("Access-Control-Allow-Origin: " . $httpOrigin);
+			}
+		}
 
-        $responseData = $this->runApiPage();
+		$responseData = $this->runApiPage();
 
-        ob_end_clean();
-        print($responseData);
-        ob_start();
-    }
+		ob_end_clean();
+		print($responseData);
+		ob_start();
+	}
 
-    /**
-     * Method that runs API action
-     *
-     * @return object|array The modified API document
-     */
-    public abstract function executeApiAction();
+	/**
+	 * Method that runs API action
+	 *
+	 * @return object|array The modified API document
+	 */
+	public abstract function executeApiAction();
 
-    /**
-     * @return string
-     */
-    final public function runApiPage()
-    {
-        try {
-            $apiDocument = $this->executeApiAction();
-        }
-            /** @noinspection PhpRedundantCatchClauseInspection */
-        catch (ApiException $ex) {
-            $apiDocument = [
-                'error' => $ex->getMessage(),
-            ];
-        }
+	/**
+	 * @return string
+	 */
+	final public function runApiPage()
+	{
+		try {
+			$apiDocument = $this->executeApiAction();
+		}
+			/** @noinspection PhpRedundantCatchClauseInspection */
+		catch (ApiException $ex) {
+			$apiDocument = [
+				'error' => $ex->getMessage(),
+			];
+		}
 
-        $data = json_encode($apiDocument, JSON_UNESCAPED_UNICODE);
+		$data = json_encode($apiDocument, JSON_UNESCAPED_UNICODE);
 
-        $targetVar = WebRequest::getString('targetVariable');
-        if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) {
-            $data = $targetVar . ' = ' . $data . ';';
-            header("Content-Type: text/javascript");
-        }
-        else {
-            header("Content-Type: application/json");
-        }
+		$targetVar = WebRequest::getString('targetVariable');
+		if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) {
+			$data = $targetVar . ' = ' . $data . ';';
+			header("Content-Type: text/javascript");
+		}
+		else {
+			header("Content-Type: application/json");
+		}
 
-        return $data;
-    }
+		return $data;
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -72,8 +72,7 @@
         if ($targetVar !== null && preg_match('/^[a-z]+$/', $targetVar)) {
             $data = $targetVar . ' = ' . $data . ';';
             header("Content-Type: text/javascript");
-        }
-        else {
+        } else {
             header("Content-Type: application/json");
         }
 

includes/Tasks/TaskBase.php

Indentation +207 added lines, -207 removed lines

@@ -22,211 +22,211 @@
 
 abstract class TaskBase implements ITask
 {
-    /** @var SiteConfiguration */
-    private $siteConfiguration;
-    /** @var IEmailHelper */
-    private $emailHelper;
-    /** @var HttpHelper */
-    private $httpHelper;
-    /** @var ILocationProvider */
-    private $locationProvider;
-    /** @var IXffTrustProvider */
-    private $xffTrustProvider;
-    /** @var IRDnsProvider */
-    private $rdnsProvider;
-    /** @var IAntiSpoofProvider */
-    private $antiSpoofProvider;
-    /** @var IOAuthProtocolHelper */
-    private $oauthHelper;
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IrcNotificationHelper */
-    private $notificationHelper;
-    /** @var TorExitProvider */
-    private $torExitProvider;
-
-    /**
-     * @return IEmailHelper
-     */
-    final public function getEmailHelper()
-    {
-        return $this->emailHelper;
-    }
-
-    /**
-     * @param IEmailHelper $emailHelper
-     */
-    final public function setEmailHelper($emailHelper)
-    {
-        $this->emailHelper = $emailHelper;
-    }
-
-    /**
-     * @return HttpHelper
-     */
-    final public function getHttpHelper()
-    {
-        return $this->httpHelper;
-    }
-
-    /**
-     * @param HttpHelper $httpHelper
-     */
-    final public function setHttpHelper($httpHelper)
-    {
-        $this->httpHelper = $httpHelper;
-    }
-
-    /**
-     * @return ILocationProvider
-     */
-    final public function getLocationProvider()
-    {
-        return $this->locationProvider;
-    }
-
-    /**
-     * @param ILocationProvider $locationProvider
-     */
-    final public function setLocationProvider(ILocationProvider $locationProvider)
-    {
-        $this->locationProvider = $locationProvider;
-    }
-
-    /**
-     * @return IXffTrustProvider
-     */
-    final public function getXffTrustProvider()
-    {
-        return $this->xffTrustProvider;
-    }
-
-    /**
-     * @param IXffTrustProvider $xffTrustProvider
-     */
-    final public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider)
-    {
-        $this->xffTrustProvider = $xffTrustProvider;
-    }
-
-    /**
-     * @return IRDnsProvider
-     */
-    final public function getRdnsProvider()
-    {
-        return $this->rdnsProvider;
-    }
-
-    /**
-     * @param IRDnsProvider $rdnsProvider
-     */
-    public function setRdnsProvider($rdnsProvider)
-    {
-        $this->rdnsProvider = $rdnsProvider;
-    }
-
-    /**
-     * @return IAntiSpoofProvider
-     */
-    public function getAntiSpoofProvider()
-    {
-        return $this->antiSpoofProvider;
-    }
-
-    /**
-     * @param IAntiSpoofProvider $antiSpoofProvider
-     */
-    public function setAntiSpoofProvider($antiSpoofProvider)
-    {
-        $this->antiSpoofProvider = $antiSpoofProvider;
-    }
-
-    /**
-     * @return PdoDatabase
-     */
-    final public function getDatabase()
-    {
-        return $this->database;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     */
-    final public function setDatabase($database)
-    {
-        $this->database = $database;
-    }
-
-    /**
-     * @return IOAuthProtocolHelper
-     */
-    public function getOAuthProtocolHelper()
-    {
-        return $this->oauthHelper;
-    }
-
-    /**
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     */
-    public function setOAuthProtocolHelper($oauthProtocolHelper)
-    {
-        $this->oauthHelper = $oauthProtocolHelper;
-    }
-
-    /**
-     * @return void
-     */
-    abstract public function execute();
-
-    /**
-     * @return IrcNotificationHelper
-     */
-    public function getNotificationHelper()
-    {
-        return $this->notificationHelper;
-    }
-
-    /**
-     * @param IrcNotificationHelper $notificationHelper
-     */
-    public function setNotificationHelper($notificationHelper)
-    {
-        $this->notificationHelper = $notificationHelper;
-    }
-
-    /**
-     * @return TorExitProvider
-     */
-    public function getTorExitProvider()
-    {
-        return $this->torExitProvider;
-    }
-
-    /**
-     * @param TorExitProvider $torExitProvider
-     */
-    public function setTorExitProvider($torExitProvider)
-    {
-        $this->torExitProvider = $torExitProvider;
-    }
-
-    /**
-     * Gets the site configuration object
-     *
-     * @return SiteConfiguration
-     */
-    final protected function getSiteConfiguration()
-    {
-        return $this->siteConfiguration;
-    }
-
-    /**
-     * Sets the site configuration object for this page
-     *
-     * @param SiteConfiguration $configuration
-     */
-    final public function setSiteConfiguration($configuration)
-    {
-        $this->siteConfiguration = $configuration;
-    }
+	/** @var SiteConfiguration */
+	private $siteConfiguration;
+	/** @var IEmailHelper */
+	private $emailHelper;
+	/** @var HttpHelper */
+	private $httpHelper;
+	/** @var ILocationProvider */
+	private $locationProvider;
+	/** @var IXffTrustProvider */
+	private $xffTrustProvider;
+	/** @var IRDnsProvider */
+	private $rdnsProvider;
+	/** @var IAntiSpoofProvider */
+	private $antiSpoofProvider;
+	/** @var IOAuthProtocolHelper */
+	private $oauthHelper;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IrcNotificationHelper */
+	private $notificationHelper;
+	/** @var TorExitProvider */
+	private $torExitProvider;
+
+	/**
+	 * @return IEmailHelper
+	 */
+	final public function getEmailHelper()
+	{
+		return $this->emailHelper;
+	}
+
+	/**
+	 * @param IEmailHelper $emailHelper
+	 */
+	final public function setEmailHelper($emailHelper)
+	{
+		$this->emailHelper = $emailHelper;
+	}
+
+	/**
+	 * @return HttpHelper
+	 */
+	final public function getHttpHelper()
+	{
+		return $this->httpHelper;
+	}
+
+	/**
+	 * @param HttpHelper $httpHelper
+	 */
+	final public function setHttpHelper($httpHelper)
+	{
+		$this->httpHelper = $httpHelper;
+	}
+
+	/**
+	 * @return ILocationProvider
+	 */
+	final public function getLocationProvider()
+	{
+		return $this->locationProvider;
+	}
+
+	/**
+	 * @param ILocationProvider $locationProvider
+	 */
+	final public function setLocationProvider(ILocationProvider $locationProvider)
+	{
+		$this->locationProvider = $locationProvider;
+	}
+
+	/**
+	 * @return IXffTrustProvider
+	 */
+	final public function getXffTrustProvider()
+	{
+		return $this->xffTrustProvider;
+	}
+
+	/**
+	 * @param IXffTrustProvider $xffTrustProvider
+	 */
+	final public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider)
+	{
+		$this->xffTrustProvider = $xffTrustProvider;
+	}
+
+	/**
+	 * @return IRDnsProvider
+	 */
+	final public function getRdnsProvider()
+	{
+		return $this->rdnsProvider;
+	}
+
+	/**
+	 * @param IRDnsProvider $rdnsProvider
+	 */
+	public function setRdnsProvider($rdnsProvider)
+	{
+		$this->rdnsProvider = $rdnsProvider;
+	}
+
+	/**
+	 * @return IAntiSpoofProvider
+	 */
+	public function getAntiSpoofProvider()
+	{
+		return $this->antiSpoofProvider;
+	}
+
+	/**
+	 * @param IAntiSpoofProvider $antiSpoofProvider
+	 */
+	public function setAntiSpoofProvider($antiSpoofProvider)
+	{
+		$this->antiSpoofProvider = $antiSpoofProvider;
+	}
+
+	/**
+	 * @return PdoDatabase
+	 */
+	final public function getDatabase()
+	{
+		return $this->database;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	final public function setDatabase($database)
+	{
+		$this->database = $database;
+	}
+
+	/**
+	 * @return IOAuthProtocolHelper
+	 */
+	public function getOAuthProtocolHelper()
+	{
+		return $this->oauthHelper;
+	}
+
+	/**
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 */
+	public function setOAuthProtocolHelper($oauthProtocolHelper)
+	{
+		$this->oauthHelper = $oauthProtocolHelper;
+	}
+
+	/**
+	 * @return void
+	 */
+	abstract public function execute();
+
+	/**
+	 * @return IrcNotificationHelper
+	 */
+	public function getNotificationHelper()
+	{
+		return $this->notificationHelper;
+	}
+
+	/**
+	 * @param IrcNotificationHelper $notificationHelper
+	 */
+	public function setNotificationHelper($notificationHelper)
+	{
+		$this->notificationHelper = $notificationHelper;
+	}
+
+	/**
+	 * @return TorExitProvider
+	 */
+	public function getTorExitProvider()
+	{
+		return $this->torExitProvider;
+	}
+
+	/**
+	 * @param TorExitProvider $torExitProvider
+	 */
+	public function setTorExitProvider($torExitProvider)
+	{
+		$this->torExitProvider = $torExitProvider;
+	}
+
+	/**
+	 * Gets the site configuration object
+	 *
+	 * @return SiteConfiguration
+	 */
+	final protected function getSiteConfiguration()
+	{
+		return $this->siteConfiguration;
+	}
+
+	/**
+	 * Sets the site configuration object for this page
+	 *
+	 * @param SiteConfiguration $configuration
+	 */
+	final public function setSiteConfiguration($configuration)
+	{
+		$this->siteConfiguration = $configuration;
+	}
 }
\ No newline at end of file

includes/Tasks/PagedInternalPageBase.php

Indentation +93 added lines, -93 removed lines

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

Braces +1 added lines, -2 removed lines

@@ -55,8 +55,7 @@
         if ($pageCount < $pageLimit) {
             if ($pageData['lowpage'] == 1 && $pageData['hipage'] < $pageData['maxpage']) {
                 $pageData['hipage'] = min($pageLimit, $pageData['maxpage']);
-            }
-            elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
+            } elseif ($pageData['lowpage'] > 1 && $pageData['hipage'] == $pageData['maxpage']) {
                 $pageData['lowpage'] = max(1, $pageData['maxpage'] - $pageLimit + 1);
             }
         }

includes/Tasks/ITask.php

Indentation +133 added lines, -133 removed lines

@@ -22,137 +22,137 @@
 
 interface ITask
 {
-    /**
-     * @return IEmailHelper
-     */
-    public function getEmailHelper();
-
-    /**
-     * @param IEmailHelper $emailHelper
-     *
-     * @return void
-     */
-    public function setEmailHelper($emailHelper);
-
-    /**
-     * @return HttpHelper
-     */
-    public function getHttpHelper();
-
-    /**
-     * @param HttpHelper $httpHelper
-     *
-     * @return void
-     */
-    public function setHttpHelper($httpHelper);
-
-    /**
-     * @return ILocationProvider
-     */
-    public function getLocationProvider();
-
-    /**
-     * @param ILocationProvider $locationProvider
-     *
-     * @return void
-     */
-    public function setLocationProvider(ILocationProvider $locationProvider);
-
-    /**
-     * @return IXffTrustProvider
-     */
-    public function getXffTrustProvider();
-
-    /**
-     * @param IXffTrustProvider $xffTrustProvider
-     *
-     * @return void
-     */
-    public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider);
-
-    /**
-     * @return IRDnsProvider
-     */
-    public function getRdnsProvider();
-
-    /**
-     * @param IRDnsProvider $rdnsProvider
-     *
-     * @return void
-     */
-    public function setRdnsProvider($rdnsProvider);
-
-    /**
-     * @return IAntiSpoofProvider
-     */
-    public function getAntiSpoofProvider();
-
-    /**
-     * @param IAntiSpoofProvider $antiSpoofProvider
-     *
-     * @return void
-     */
-    public function setAntiSpoofProvider($antiSpoofProvider);
-
-    /**
-     * @return PdoDatabase
-     */
-    public function getDatabase();
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return void
-     */
-    public function setDatabase($database);
-
-    /**
-     * @return IOAuthProtocolHelper
-     */
-    public function getOAuthProtocolHelper();
-
-    /**
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     *
-     * @return void
-     */
-    public function setOAuthProtocolHelper($oauthProtocolHelper);
-
-    /**
-     * @return void
-     */
-    public function execute();
-
-    /**
-     * Sets the site configuration object for this page
-     *
-     * @param SiteConfiguration $configuration
-     *
-     * @return void
-     */
-    public function setSiteConfiguration($configuration);
-
-    /**
-     * @return IrcNotificationHelper
-     */
-    public function getNotificationHelper();
-
-    /**
-     * @param IrcNotificationHelper $notificationHelper
-     *
-     * @return void
-     */
-    public function setNotificationHelper($notificationHelper);
-
-    /**
-     * @return TorExitProvider
-     */
-    public function getTorExitProvider();
-
-    /**
-     * @param TorExitProvider $torExitProvider
-     *
-     * @return void
-     */
-    public function setTorExitProvider($torExitProvider);
+	/**
+	 * @return IEmailHelper
+	 */
+	public function getEmailHelper();
+
+	/**
+	 * @param IEmailHelper $emailHelper
+	 *
+	 * @return void
+	 */
+	public function setEmailHelper($emailHelper);
+
+	/**
+	 * @return HttpHelper
+	 */
+	public function getHttpHelper();
+
+	/**
+	 * @param HttpHelper $httpHelper
+	 *
+	 * @return void
+	 */
+	public function setHttpHelper($httpHelper);
+
+	/**
+	 * @return ILocationProvider
+	 */
+	public function getLocationProvider();
+
+	/**
+	 * @param ILocationProvider $locationProvider
+	 *
+	 * @return void
+	 */
+	public function setLocationProvider(ILocationProvider $locationProvider);
+
+	/**
+	 * @return IXffTrustProvider
+	 */
+	public function getXffTrustProvider();
+
+	/**
+	 * @param IXffTrustProvider $xffTrustProvider
+	 *
+	 * @return void
+	 */
+	public function setXffTrustProvider(IXffTrustProvider $xffTrustProvider);
+
+	/**
+	 * @return IRDnsProvider
+	 */
+	public function getRdnsProvider();
+
+	/**
+	 * @param IRDnsProvider $rdnsProvider
+	 *
+	 * @return void
+	 */
+	public function setRdnsProvider($rdnsProvider);
+
+	/**
+	 * @return IAntiSpoofProvider
+	 */
+	public function getAntiSpoofProvider();
+
+	/**
+	 * @param IAntiSpoofProvider $antiSpoofProvider
+	 *
+	 * @return void
+	 */
+	public function setAntiSpoofProvider($antiSpoofProvider);
+
+	/**
+	 * @return PdoDatabase
+	 */
+	public function getDatabase();
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return void
+	 */
+	public function setDatabase($database);
+
+	/**
+	 * @return IOAuthProtocolHelper
+	 */
+	public function getOAuthProtocolHelper();
+
+	/**
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 *
+	 * @return void
+	 */
+	public function setOAuthProtocolHelper($oauthProtocolHelper);
+
+	/**
+	 * @return void
+	 */
+	public function execute();
+
+	/**
+	 * Sets the site configuration object for this page
+	 *
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return void
+	 */
+	public function setSiteConfiguration($configuration);
+
+	/**
+	 * @return IrcNotificationHelper
+	 */
+	public function getNotificationHelper();
+
+	/**
+	 * @param IrcNotificationHelper $notificationHelper
+	 *
+	 * @return void
+	 */
+	public function setNotificationHelper($notificationHelper);
+
+	/**
+	 * @return TorExitProvider
+	 */
+	public function getTorExitProvider();
+
+	/**
+	 * @param TorExitProvider $torExitProvider
+	 *
+	 * @return void
+	 */
+	public function setTorExitProvider($torExitProvider);
 }
\ No newline at end of file

includes/RequestList.php

Indentation +11 added lines, -11 removed lines

@@ -16,15 +16,15 @@
  */
 class RequestList
 {
-    public $requests;
-    public $showPrivateData;
-    public $dataClearEmail;
-    public $dataClearIp;
-    public $relatedEmailRequests;
-    public $relatedIpRequests;
-    public $requestTrustedIp;
-    public $canBan;
-    public $canBreakReservation;
-    public $userList;
-    public $commonEmail;
+	public $requests;
+	public $showPrivateData;
+	public $dataClearEmail;
+	public $dataClearIp;
+	public $relatedEmailRequests;
+	public $relatedIpRequests;
+	public $requestTrustedIp;
+	public $canBan;
+	public $canBreakReservation;
+	public $userList;
+	public $commonEmail;
 }

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());
+		}
+	}
 }