mdaniels5757 / waca

includes/Helpers/SearchHelpers/JobQueueSearchHelper.php

Indentation +63 added lines, -63 removed lines

@@ -13,67 +13,67 @@
 
 class JobQueueSearchHelper extends SearchHelperBase
 {
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'jobqueue', JobQueue::class, null);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return JobQueueSearchHelper
-     */
-    public static function get(PdoDatabase $database) {
-        $helper = new JobQueueSearchHelper($database);
-        return $helper;
-    }
-
-    /**
-     * @param string[] $statuses
-     *
-     * @return $this
-     */
-    public function statusIn($statuses) {
-        $this->inClause('status', $statuses);
-
-        return $this;
-    }
-
-    /**
-     * @return $this
-     */
-    public function notAcknowledged() {
-        $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
-
-        return $this;
-    }
-
-    public function byTask($task) {
-        $this->whereClause .= ' AND task = ?';
-        $this->parameterList[] = $task;
-
-        return $this;
-    }
-
-    public function byUser($userId) {
-        $this->whereClause .= ' AND user = ?';
-        $this->parameterList[] = $userId;
-
-        return $this;
-    }
-
-    public function byStatus($status) {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    public function byRequest(int $request) : JobQueueSearchHelper
-    {
-        $this->whereClause .= ' AND request = ?';
-        $this->parameterList[] = $request;
-
-        return $this;
-    }
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'jobqueue', JobQueue::class, null);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return JobQueueSearchHelper
+	 */
+	public static function get(PdoDatabase $database) {
+		$helper = new JobQueueSearchHelper($database);
+		return $helper;
+	}
+
+	/**
+	 * @param string[] $statuses
+	 *
+	 * @return $this
+	 */
+	public function statusIn($statuses) {
+		$this->inClause('status', $statuses);
+
+		return $this;
+	}
+
+	/**
+	 * @return $this
+	 */
+	public function notAcknowledged() {
+		$this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
+
+		return $this;
+	}
+
+	public function byTask($task) {
+		$this->whereClause .= ' AND task = ?';
+		$this->parameterList[] = $task;
+
+		return $this;
+	}
+
+	public function byUser($userId) {
+		$this->whereClause .= ' AND user = ?';
+		$this->parameterList[] = $userId;
+
+		return $this;
+	}
+
+	public function byStatus($status) {
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	public function byRequest(int $request) : JobQueueSearchHelper
+	{
+		$this->whereClause .= ' AND request = ?';
+		$this->parameterList[] = $request;
+
+		return $this;
+	}
 }

Braces +12 added lines, -6 removed lines

@@ -23,7 +23,8 @@ 
      *
      * @return JobQueueSearchHelper
      */
-    public static function get(PdoDatabase $database) {
+    public static function get(PdoDatabase $database)
+    {
         $helper = new JobQueueSearchHelper($database);
         return $helper;
     }
@@ -33,7 +34,8 @@ 
      *
      * @return $this
      */
-    public function statusIn($statuses) {
+    public function statusIn($statuses)
+    {
         $this->inClause('status', $statuses);
 
         return $this;
@@ -42,27 +44,31 @@ 
     /**
      * @return $this
      */
-    public function notAcknowledged() {
+    public function notAcknowledged()
+    {
         $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
 
         return $this;
     }
 
-    public function byTask($task) {
+    public function byTask($task)
+    {
         $this->whereClause .= ' AND task = ?';
         $this->parameterList[] = $task;
 
         return $this;
     }
 
-    public function byUser($userId) {
+    public function byUser($userId)
+    {
         $this->whereClause .= ' AND user = ?';
         $this->parameterList[] = $userId;
 
         return $this;
     }
 
-    public function byStatus($status) {
+    public function byStatus($status)
+    {
         $this->whereClause .= ' AND status = ?';
         $this->parameterList[] = $status;
 

includes/Helpers/SearchHelpers/SearchHelperBase.php

Indentation +271 added lines, -271 removed lines

@@ -16,275 +16,275 @@
 
 abstract class SearchHelperBase
 {
-    /** @var PdoDatabase */
-    protected $database;
-    /** @var array */
-    protected $parameterList = array();
-    /** @var null|int */
-    private $limit = null;
-    /** @var null|int */
-    private $offset = null;
-    private $orderBy;
-    /**
-     * @var string The where clause.
-     *
-     * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
-     * that we use positional parameters instead of named parameters because we don't know many times different options
-     * will be called (looking at excluding() here, but there's the option for others).
-     */
-    protected $whereClause = ' WHERE 1 = 1';
-    /** @var string */
-    protected $table;
-    protected $joinClause = '';
-    protected $groupByClause = '';
-    protected $modifiersClause = '';
-    private $targetClass;
-
-    /**
-     * SearchHelperBase constructor.
-     *
-     * @param PdoDatabase $database
-     * @param string      $table
-     * @param             $targetClass
-     * @param null|string $order Order by clause, excluding ORDER BY.
-     */
-    protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
-    {
-        $this->database = $database;
-        $this->table = $table;
-        $this->orderBy = $order;
-        $this->targetClass = $targetClass;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning a set of objects.
-     *
-     * @return DataObject[]
-     */
-    public function fetch()
-    {
-        $statement = $this->getData();
-
-        /** @var DataObject[] $returnedObjects */
-        $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-        foreach ($returnedObjects as $req) {
-            $req->setDatabase($this->database);
-        }
-
-        return $returnedObjects;
-    }
-
-    /**
-     * @param string $whereClauseSection
-     * @param array  $values
-     *
-     * @return array
-     */
-    protected function fetchByParameter($whereClauseSection, $values)
-    {
-        $this->whereClause .= $whereClauseSection;
-
-        $countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $countQuery .= $this->joinClause . $this->whereClause;
-
-        $query = $this->buildQuery(array('*'));
-        $query .= $this->applyOrder();
-
-        // shuffle around parameters
-        // applyLimit() appends parameters to the parameter list, which is useless when we want to run
-        // many queries with different parameters. As such, we back up the parameter list, wipe it, apply the limit
-        // parameters, and hold them separately, merging again prior to running the actual query.
-        $localParameterList = $this->parameterList;
-        $this->parameterList = array();
-        $query .= $this->applyLimit();
-        $limitParameters = $this->parameterList;
-
-        $statement = $this->database->prepare($query);
-        $countStatement = $this->database->prepare($countQuery);
-
-        $result = array();
-        foreach ($values as $v) {
-            // reset parameter list
-            $params = $localParameterList;
-            $params[] = $v;
-
-            $countStatement->execute($params);
-
-            // reapply the limit parameters
-            $params = array_merge($params, $limitParameters);
-
-            $statement->execute($params);
-
-            /** @var DataObject[] $returnedObjects */
-            $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-            foreach ($returnedObjects as $req) {
-                $req->setDatabase($this->database);
-            }
-
-            $result[$v] = array(
-                'count' => $countStatement->fetchColumn(0),
-                'data'  => $returnedObjects,
-            );
-        }
-
-        return $result;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning only the requested column.
-     *
-     * @param string $column The required column
-     *
-     * @param bool   $distinct
-     *
-     * @return array
-     * @throws ApplicationLogicException
-     */
-    public function fetchColumn($column, $distinct = false)
-    {
-        if ($distinct) {
-            if ($this->groupByClause !== '') {
-                throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
-            }
-
-            $this->groupByClause = ' GROUP BY origin.' . $column;
-        }
-
-        $statement = $this->getData(array($column));
-
-        return $statement->fetchAll(PDO::FETCH_COLUMN);
-    }
-
-    public function fetchMap($column)
-    {
-        $statement = $this->getData(array('id', $column));
-
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $map = array();
-
-        foreach ($data as $row) {
-            $map[$row['id']] = $row[$column];
-        }
-
-        return $map;
-    }
-
-    /**
-     * @param int $count Returns the record count of the result set
-     *
-     * @return $this
-     */
-    public function getRecordCount(&$count)
-    {
-        $query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause;
-
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        $count = $statement->fetchColumn(0);
-        $statement->closeCursor();
-
-        return $this;
-    }
-
-    /**
-     * Limits the results
-     *
-     * @param integer      $limit
-     * @param integer|null $offset
-     *
-     * @return $this
-     *
-     */
-    public function limit($limit, $offset = null)
-    {
-        $this->limit = $limit;
-        $this->offset = $offset;
-
-        return $this;
-    }
-
-    private function applyLimit()
-    {
-        $clause = '';
-        if ($this->limit !== null) {
-            $clause = ' LIMIT ?';
-            $this->parameterList[] = $this->limit;
-
-            if ($this->offset !== null) {
-                $clause .= ' OFFSET ?';
-                $this->parameterList[] = $this->offset;
-            }
-        }
-
-        return $clause;
-    }
-
-    private function applyOrder()
-    {
-        if ($this->orderBy !== null) {
-            return ' ORDER BY ' . $this->orderBy;
-        }
-
-        return '';
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return PDOStatement
-     */
-    private function getData($columns = array('*'))
-    {
-        $query = $this->buildQuery($columns);
-        $query .= $this->applyOrder();
-        $query .= $this->applyLimit();
-
-        /** @var PDOStatement $statement */
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        return $statement;
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return string
-     */
-    protected function buildQuery($columns)
-    {
-        $colData = array();
-        foreach ($columns as $c) {
-            $colData[] = 'origin.' . $c;
-        }
-
-        $query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause . $this->groupByClause;
-
-        return $query;
-    }
-
-    public function inIds($idList)
-    {
-        $this->inClause('id', $idList);
-
-        return $this;
-    }
-
-    protected function inClause($column, $values)
-    {
-        if (count($values) === 0) {
-            return;
-        }
-
-        // You can't use IN() with parameters directly, so let's munge something together.
-        // Let's create a string of question marks, which will do as positional parameters.
-        $valueCount = count($values);
-        $inSection = str_repeat('?,', $valueCount - 1) . '?';
-
-        $this->whereClause .= " AND {$column} IN ({$inSection})";
-        $this->parameterList = array_merge($this->parameterList, $values);
-    }
+	/** @var PdoDatabase */
+	protected $database;
+	/** @var array */
+	protected $parameterList = array();
+	/** @var null|int */
+	private $limit = null;
+	/** @var null|int */
+	private $offset = null;
+	private $orderBy;
+	/**
+	 * @var string The where clause.
+	 *
+	 * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
+	 * that we use positional parameters instead of named parameters because we don't know many times different options
+	 * will be called (looking at excluding() here, but there's the option for others).
+	 */
+	protected $whereClause = ' WHERE 1 = 1';
+	/** @var string */
+	protected $table;
+	protected $joinClause = '';
+	protected $groupByClause = '';
+	protected $modifiersClause = '';
+	private $targetClass;
+
+	/**
+	 * SearchHelperBase constructor.
+	 *
+	 * @param PdoDatabase $database
+	 * @param string      $table
+	 * @param             $targetClass
+	 * @param null|string $order Order by clause, excluding ORDER BY.
+	 */
+	protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
+	{
+		$this->database = $database;
+		$this->table = $table;
+		$this->orderBy = $order;
+		$this->targetClass = $targetClass;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning a set of objects.
+	 *
+	 * @return DataObject[]
+	 */
+	public function fetch()
+	{
+		$statement = $this->getData();
+
+		/** @var DataObject[] $returnedObjects */
+		$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+		foreach ($returnedObjects as $req) {
+			$req->setDatabase($this->database);
+		}
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * @param string $whereClauseSection
+	 * @param array  $values
+	 *
+	 * @return array
+	 */
+	protected function fetchByParameter($whereClauseSection, $values)
+	{
+		$this->whereClause .= $whereClauseSection;
+
+		$countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$countQuery .= $this->joinClause . $this->whereClause;
+
+		$query = $this->buildQuery(array('*'));
+		$query .= $this->applyOrder();
+
+		// shuffle around parameters
+		// applyLimit() appends parameters to the parameter list, which is useless when we want to run
+		// many queries with different parameters. As such, we back up the parameter list, wipe it, apply the limit
+		// parameters, and hold them separately, merging again prior to running the actual query.
+		$localParameterList = $this->parameterList;
+		$this->parameterList = array();
+		$query .= $this->applyLimit();
+		$limitParameters = $this->parameterList;
+
+		$statement = $this->database->prepare($query);
+		$countStatement = $this->database->prepare($countQuery);
+
+		$result = array();
+		foreach ($values as $v) {
+			// reset parameter list
+			$params = $localParameterList;
+			$params[] = $v;
+
+			$countStatement->execute($params);
+
+			// reapply the limit parameters
+			$params = array_merge($params, $limitParameters);
+
+			$statement->execute($params);
+
+			/** @var DataObject[] $returnedObjects */
+			$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+			foreach ($returnedObjects as $req) {
+				$req->setDatabase($this->database);
+			}
+
+			$result[$v] = array(
+				'count' => $countStatement->fetchColumn(0),
+				'data'  => $returnedObjects,
+			);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning only the requested column.
+	 *
+	 * @param string $column The required column
+	 *
+	 * @param bool   $distinct
+	 *
+	 * @return array
+	 * @throws ApplicationLogicException
+	 */
+	public function fetchColumn($column, $distinct = false)
+	{
+		if ($distinct) {
+			if ($this->groupByClause !== '') {
+				throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
+			}
+
+			$this->groupByClause = ' GROUP BY origin.' . $column;
+		}
+
+		$statement = $this->getData(array($column));
+
+		return $statement->fetchAll(PDO::FETCH_COLUMN);
+	}
+
+	public function fetchMap($column)
+	{
+		$statement = $this->getData(array('id', $column));
+
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$map = array();
+
+		foreach ($data as $row) {
+			$map[$row['id']] = $row[$column];
+		}
+
+		return $map;
+	}
+
+	/**
+	 * @param int $count Returns the record count of the result set
+	 *
+	 * @return $this
+	 */
+	public function getRecordCount(&$count)
+	{
+		$query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $this->whereClause;
+
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		$count = $statement->fetchColumn(0);
+		$statement->closeCursor();
+
+		return $this;
+	}
+
+	/**
+	 * Limits the results
+	 *
+	 * @param integer      $limit
+	 * @param integer|null $offset
+	 *
+	 * @return $this
+	 *
+	 */
+	public function limit($limit, $offset = null)
+	{
+		$this->limit = $limit;
+		$this->offset = $offset;
+
+		return $this;
+	}
+
+	private function applyLimit()
+	{
+		$clause = '';
+		if ($this->limit !== null) {
+			$clause = ' LIMIT ?';
+			$this->parameterList[] = $this->limit;
+
+			if ($this->offset !== null) {
+				$clause .= ' OFFSET ?';
+				$this->parameterList[] = $this->offset;
+			}
+		}
+
+		return $clause;
+	}
+
+	private function applyOrder()
+	{
+		if ($this->orderBy !== null) {
+			return ' ORDER BY ' . $this->orderBy;
+		}
+
+		return '';
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return PDOStatement
+	 */
+	private function getData($columns = array('*'))
+	{
+		$query = $this->buildQuery($columns);
+		$query .= $this->applyOrder();
+		$query .= $this->applyLimit();
+
+		/** @var PDOStatement $statement */
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		return $statement;
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return string
+	 */
+	protected function buildQuery($columns)
+	{
+		$colData = array();
+		foreach ($columns as $c) {
+			$colData[] = 'origin.' . $c;
+		}
+
+		$query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $this->whereClause . $this->groupByClause;
+
+		return $query;
+	}
+
+	public function inIds($idList)
+	{
+		$this->inClause('id', $idList);
+
+		return $this;
+	}
+
+	protected function inClause($column, $values)
+	{
+		if (count($values) === 0) {
+			return;
+		}
+
+		// You can't use IN() with parameters directly, so let's munge something together.
+		// Let's create a string of question marks, which will do as positional parameters.
+		$valueCount = count($values);
+		$inSection = str_repeat('?,', $valueCount - 1) . '?';
+
+		$this->whereClause .= " AND {$column} IN ({$inSection})";
+		$this->parameterList = array_merge($this->parameterList, $values);
+	}
 }

includes/Helpers/SearchHelpers/RequestSearchHelper.php

Indentation +174 added lines, -174 removed lines

@@ -15,178 +15,178 @@
 
 class RequestSearchHelper extends SearchHelperBase
 {
-    /**
-     * RequestSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'request', Request::class);
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return RequestSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new RequestSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * Filters the results by IP address
-     *
-     * @param string $ipAddress
-     *
-     * @return $this
-     */
-    public function byIp($ipAddress)
-    {
-        $this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
-        $this->parameterList[] = $ipAddress;
-        $this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by email address
-     *
-     * @param string $emailAddress
-     *
-     * @return $this
-     */
-    public function byEmailAddress($emailAddress)
-    {
-        $this->whereClause .= ' AND email LIKE ?';
-        $this->parameterList[] = $emailAddress;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by name
-     *
-     * @param string $name
-     *
-     * @return $this
-     */
-    public function byName($name)
-    {
-        $this->whereClause .= ' AND name LIKE ?';
-        $this->parameterList[] = $name;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those with a defined status
-     *
-     * @param $status
-     *
-     * @return $this
-     */
-    public function byStatus($status)
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    /**
-     * Excludes a request from the results
-     *
-     * @param int $requestId
-     *
-     * @return $this
-     */
-    public function excludingRequest($requestId)
-    {
-        $this->whereClause .= ' AND id <> ?';
-        $this->parameterList[] = $requestId;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to only those with a confirmed email address
-     *
-     * @return $this
-     */
-    public function withConfirmedEmail()
-    {
-        $this->whereClause .= ' AND emailconfirm = ?';
-        $this->parameterList[] = 'Confirmed';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to exclude purged data
-     *
-     * @param SiteConfiguration $configuration
-     *
-     * @return $this
-     */
-    public function excludingPurgedData(SiteConfiguration $configuration)
-    {
-        $this->whereClause .= ' AND ip <> ? AND email <> ?';
-        $this->parameterList[] = $configuration->getDataClearIp();
-        $this->parameterList[] = $configuration->getDataClearEmail();
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those without a defined status
-     *
-     * @param $status
-     *
-     * @return $this
-     */
-    public function excludingStatus($status)
-    {
-        $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those which have failed an auto-creation
-     *
-     * @return $this
-     */
-    public function isHospitalised()
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
-
-        return $this;
-    }
-
-    /**
-     * Filters the requests to those which have not failed an auto-creation
-     *
-     * @return $this
-     */
-    public function notHospitalised()
-    {
-        $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
-
-        return $this;
-    }
-
-    public function fetchByStatus($statuses)
-    {
-        return $this->fetchByParameter(' AND status = ?', $statuses);
-    }
+	/**
+	 * RequestSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'request', Request::class);
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return RequestSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new RequestSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * Filters the results by IP address
+	 *
+	 * @param string $ipAddress
+	 *
+	 * @return $this
+	 */
+	public function byIp($ipAddress)
+	{
+		$this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
+		$this->parameterList[] = $ipAddress;
+		$this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by email address
+	 *
+	 * @param string $emailAddress
+	 *
+	 * @return $this
+	 */
+	public function byEmailAddress($emailAddress)
+	{
+		$this->whereClause .= ' AND email LIKE ?';
+		$this->parameterList[] = $emailAddress;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by name
+	 *
+	 * @param string $name
+	 *
+	 * @return $this
+	 */
+	public function byName($name)
+	{
+		$this->whereClause .= ' AND name LIKE ?';
+		$this->parameterList[] = $name;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those with a defined status
+	 *
+	 * @param $status
+	 *
+	 * @return $this
+	 */
+	public function byStatus($status)
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	/**
+	 * Excludes a request from the results
+	 *
+	 * @param int $requestId
+	 *
+	 * @return $this
+	 */
+	public function excludingRequest($requestId)
+	{
+		$this->whereClause .= ' AND id <> ?';
+		$this->parameterList[] = $requestId;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to only those with a confirmed email address
+	 *
+	 * @return $this
+	 */
+	public function withConfirmedEmail()
+	{
+		$this->whereClause .= ' AND emailconfirm = ?';
+		$this->parameterList[] = 'Confirmed';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to exclude purged data
+	 *
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return $this
+	 */
+	public function excludingPurgedData(SiteConfiguration $configuration)
+	{
+		$this->whereClause .= ' AND ip <> ? AND email <> ?';
+		$this->parameterList[] = $configuration->getDataClearIp();
+		$this->parameterList[] = $configuration->getDataClearEmail();
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those without a defined status
+	 *
+	 * @param $status
+	 *
+	 * @return $this
+	 */
+	public function excludingStatus($status)
+	{
+		$this->whereClause .= ' AND status <> ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those which have failed an auto-creation
+	 *
+	 * @return $this
+	 */
+	public function isHospitalised()
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] =  RequestStatus::HOSPITAL;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the requests to those which have not failed an auto-creation
+	 *
+	 * @return $this
+	 */
+	public function notHospitalised()
+	{
+		$this->whereClause .= ' AND status <> ?';
+		$this->parameterList[] =  RequestStatus::HOSPITAL;
+
+		return $this;
+	}
+
+	public function fetchByStatus($statuses)
+	{
+		return $this->fetchByParameter(' AND status = ?', $statuses);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -167,7 +167,7 @@ 
     public function isHospitalised()
     {
         $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
+        $this->parameterList[] = RequestStatus::HOSPITAL;
 
         return $this;
     }
@@ -180,7 +180,7 @@ 
     public function notHospitalised()
     {
         $this->whereClause .= ' AND status <> ?';
-        $this->parameterList[] =  RequestStatus::HOSPITAL;
+        $this->parameterList[] = RequestStatus::HOSPITAL;
 
         return $this;
     }

includes/Helpers/Interfaces/IMediaWikiClient.php

Indentation +1 added lines, -1 removed lines

@@ -10,5 +10,5 @@
 
 interface IMediaWikiClient
 {
-    function doApiCall($params, $method);
+	function doApiCall($params, $method);
 }
\ No newline at end of file

includes/Helpers/Interfaces/IOAuthProtocolHelper.php

Indentation +44 added lines, -44 removed lines

@@ -15,52 +15,52 @@
 
 interface IOAuthProtocolHelper
 {
-    /**
-     * @return stdClass
-     *
-     * @throws Exception
-     * @throws CurlException
-     */
-    public function getRequestToken();
+	/**
+	 * @return stdClass
+	 *
+	 * @throws Exception
+	 * @throws CurlException
+	 */
+	public function getRequestToken();
 
-    /**
-     * @param string $requestToken
-     *
-     * @return string
-     */
-    public function getAuthoriseUrl($requestToken);
+	/**
+	 * @param string $requestToken
+	 *
+	 * @return string
+	 */
+	public function getAuthoriseUrl($requestToken);
 
-    /**
-     * @param string $oauthRequestToken
-     * @param string $oauthRequestSecret
-     * @param string $oauthVerifier
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
+	/**
+	 * @param string $oauthRequestToken
+	 * @param string $oauthRequestSecret
+	 * @param string $oauthVerifier
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
 
-    /**
-     * @param string $oauthAccessToken
-     * @param string $oauthAccessSecret
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
+	/**
+	 * @param string $oauthAccessToken
+	 * @param string $oauthAccessSecret
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
 
-    /**
-     * @param array  $apiParams    array of parameters to send to the API
-     * @param string $accessToken  user's access token
-     * @param string $accessSecret user's secret
-     * @param string $method       HTTP method
-     *
-     * @return stdClass
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET');
+	/**
+	 * @param array  $apiParams    array of parameters to send to the API
+	 * @param string $accessToken  user's access token
+	 * @param string $accessSecret user's secret
+	 * @param string $method       HTTP method
+	 *
+	 * @return stdClass
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET');
 }
\ No newline at end of file

includes/Helpers/Logger.php

Indentation +353 added lines, -353 removed lines

@@ -31,357 +31,357 @@
  */
 class Logger
 {
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function emailConfirmed(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param DataObject  $object
-     * @param string      $logAction
-     * @param null|string $comment
-     * @param User        $user
-     *
-     * @throws Exception
-     */
-    private static function createLogEntry(
-        PdoDatabase $database,
-        DataObject $object,
-        $logAction,
-        $comment = null,
-        $user = null
-    ) {
-        if ($user == null) {
-            $user = User::getCurrent($database);
-        }
-
-        $objectType = get_class($object);
-        if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
-            $objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
-        }
-
-        $log = new Log();
-        $log->setDatabase($database);
-        $log->setAction($logAction);
-        $log->setObjectId($object->getId());
-        $log->setObjectType($objectType);
-        $log->setUser($user);
-        $log->setComment($comment);
-        $log->save();
-    }
-
-    #region Users
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $user
-     */
-    public static function newUser(PdoDatabase $database, User $user)
-    {
-        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function approvedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Approved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function declinedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Declined", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function suspendedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Suspended", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function demotedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Demoted", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function promotedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Promoted");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $comment
-     */
-    public static function renamedUser(PdoDatabase $database, User $object, $comment)
-    {
-        self::createLogEntry($database, $object, "Renamed", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     */
-    public static function userPreferencesChange(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Prefchange");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param User        $object
-     * @param string      $reason
-     * @param array       $added
-     * @param array       $removed
-     */
-    public static function userRolesEdited(PdoDatabase $database, User $object, $reason, $added, $removed)
-    {
-        $logData = serialize(array(
-            'added'   => $added,
-            'removed' => $removed,
-            'reason'  => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "RoleChange", $logData);
-    }
-
-    #endregion
-
-    /**
-     * @param PdoDatabase $database
-     * @param SiteNotice  $object
-     */
-    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
-    {
-        self::createLogEntry($database, $object, "Edited");
-    }
-
-    #region Welcome Templates
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "DeletedTemplate");
-    }
-
-    #endregion
-
-    #region Bans
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function banned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Banned", $reason);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Unbanned", $reason);
-    }
-
-    #endregion
-
-    #region Requests
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $target
-     */
-    public static function deferRequest(PdoDatabase $database, Request $object, $target)
-    {
-        self::createLogEntry($database, $object, "Deferred to $target");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param integer     $target
-     * @param string      $comment
-     * @param User|null   $logUser
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function reserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Reserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function breakReserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "BreakReserve");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function unreserve(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Unreserved");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     * @param Request     $request
-     */
-    public static function editComment(PdoDatabase $database, Comment $object, Request $request)
-    {
-        self::createLogEntry($database, $request, "EditComment-r");
-        self::createLogEntry($database, $object, "EditComment-c");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param User        $target
-     */
-    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
-    {
-        self::createLogEntry($database, $object, "SendReserved");
-        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $comment
-     */
-    public static function sentMail(PdoDatabase $database, Request $object, $comment)
-    {
-        self::createLogEntry($database, $object, "SentMail", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'EnqueuedJobQueue');
-    }
-
-    public static function hospitalised(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'Hospitalised');
-    }
-    #endregion
-
-    #region Email templates
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedEmail");
-    }
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedEmail");
-    }
-
-    #endregion
-
-    #region Display
-
-    #endregion
-
-    #region Automation
-
-    public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
-    }
-
-    public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
-    {
-        $data = array('status' => $job->getStatus(), 'error' => $job->getError());
-        self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
-    }
-
-    public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobRequeued');
-    }
-
-    public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobAcknowledged');
-    }
-    #endregion
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function emailConfirmed(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Email Confirmed", null, User::getCommunity());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param DataObject  $object
+	 * @param string      $logAction
+	 * @param null|string $comment
+	 * @param User        $user
+	 *
+	 * @throws Exception
+	 */
+	private static function createLogEntry(
+		PdoDatabase $database,
+		DataObject $object,
+		$logAction,
+		$comment = null,
+		$user = null
+	) {
+		if ($user == null) {
+			$user = User::getCurrent($database);
+		}
+
+		$objectType = get_class($object);
+		if (strpos($objectType, 'Waca\\DataObjects\\') !== false) {
+			$objectType = str_replace('Waca\\DataObjects\\', '', $objectType);
+		}
+
+		$log = new Log();
+		$log->setDatabase($database);
+		$log->setAction($logAction);
+		$log->setObjectId($object->getId());
+		$log->setObjectType($objectType);
+		$log->setUser($user);
+		$log->setComment($comment);
+		$log->save();
+	}
+
+	#region Users
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $user
+	 */
+	public static function newUser(PdoDatabase $database, User $user)
+	{
+		self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function approvedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Approved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function declinedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Declined", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function suspendedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Suspended", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function demotedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Demoted", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function promotedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Promoted");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $comment
+	 */
+	public static function renamedUser(PdoDatabase $database, User $object, $comment)
+	{
+		self::createLogEntry($database, $object, "Renamed", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 */
+	public static function userPreferencesChange(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Prefchange");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param User        $object
+	 * @param string      $reason
+	 * @param array       $added
+	 * @param array       $removed
+	 */
+	public static function userRolesEdited(PdoDatabase $database, User $object, $reason, $added, $removed)
+	{
+		$logData = serialize(array(
+			'added'   => $added,
+			'removed' => $removed,
+			'reason'  => $reason,
+		));
+
+		self::createLogEntry($database, $object, "RoleChange", $logData);
+	}
+
+	#endregion
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param SiteNotice  $object
+	 */
+	public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
+	{
+		self::createLogEntry($database, $object, "Edited");
+	}
+
+	#region Welcome Templates
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "DeletedTemplate");
+	}
+
+	#endregion
+
+	#region Bans
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function banned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Banned", $reason);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function unbanned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Unbanned", $reason);
+	}
+
+	#endregion
+
+	#region Requests
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $target
+	 */
+	public static function deferRequest(PdoDatabase $database, Request $object, $target)
+	{
+		self::createLogEntry($database, $object, "Deferred to $target");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param integer     $target
+	 * @param string      $comment
+	 * @param User|null   $logUser
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function reserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Reserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function breakReserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "BreakReserve");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function unreserve(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Unreserved");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 * @param Request     $request
+	 */
+	public static function editComment(PdoDatabase $database, Comment $object, Request $request)
+	{
+		self::createLogEntry($database, $request, "EditComment-r");
+		self::createLogEntry($database, $object, "EditComment-c");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param User        $target
+	 */
+	public static function sendReservation(PdoDatabase $database, Request $object, User $target)
+	{
+		self::createLogEntry($database, $object, "SendReserved");
+		self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $comment
+	 */
+	public static function sentMail(PdoDatabase $database, Request $object, $comment)
+	{
+		self::createLogEntry($database, $object, "SentMail", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'EnqueuedJobQueue');
+	}
+
+	public static function hospitalised(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'Hospitalised');
+	}
+	#endregion
+
+	#region Email templates
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function createEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedEmail");
+	}
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedEmail");
+	}
+
+	#endregion
+
+	#region Display
+
+	#endregion
+
+	#region Automation
+
+	public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
+	}
+
+	public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
+	{
+		$data = array('status' => $job->getStatus(), 'error' => $job->getError());
+		self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
+	}
+
+	public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobRequeued');
+	}
+
+	public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobAcknowledged');
+	}
+	#endregion
 }

includes/Helpers/LogHelper.php

Indentation +403 added lines, -403 removed lines

@@ -27,414 +27,414 @@
 
 class LogHelper
 {
-    /**
-     * Summary of getRequestLogsWithComments
-     *
-     * @param int             $requestId
-     * @param PdoDatabase     $db
-     * @param SecurityManager $securityManager
-     *
-     * @return DataObject[]
-     */
-    public static function getRequestLogsWithComments($requestId, PdoDatabase $db, SecurityManager $securityManager)
-    {
-        $logs = LogSearchHelper::get($db)->byObjectType('Request')->byObjectId($requestId)->fetch();
-
-        $currentUser = User::getCurrent($db);
-        $securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);
-        $showAllComments = $securityResult === SecurityManager::ALLOWED;
-
-        $comments = Comment::getForRequest($requestId, $db, $showAllComments, $currentUser->getId());
-
-        $items = array_merge($logs, $comments);
-
-        /**
-         * @param DataObject $item
-         *
-         * @return int
-         */
-        $sortKey = function(DataObject $item) {
-            if ($item instanceof Log) {
-                return $item->getTimestamp()->getTimestamp();
-            }
-
-            if ($item instanceof Comment) {
-                return $item->getTime()->getTimestamp();
-            }
-
-            return 0;
-        };
-
-        do {
-            $flag = false;
-
-            $loopLimit = (count($items) - 1);
-            for ($i = 0; $i < $loopLimit; $i++) {
-                // are these two items out of order?
-                if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
-                    // swap them
-                    $swap = $items[$i];
-                    $items[$i] = $items[$i + 1];
-                    $items[$i + 1] = $swap;
-
-                    // set a flag to say we've modified the array this time around
-                    $flag = true;
-                }
-            }
-        }
-        while ($flag);
-
-        return $items;
-    }
-
-    /**
-     * Summary of getLogDescription
-     *
-     * @param Log $entry
-     *
-     * @return string
-     */
-    public static function getLogDescription(Log $entry)
-    {
-        $text = "Deferred to ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Deferred to a different queue
-            // This is exactly what we want to display.
-            return $entry->getAction();
-        }
-
-        $text = "Closed custom-n";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account not created)";
-        }
-
-        $text = "Closed custom-y";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account created)";
-        }
-
-        $text = "Closed 0";
-        if ($entry->getAction() == $text) {
-            // Dropped the request - short-circuit the lookup
-            return "dropped request";
-        }
-
-        $text = "Closed ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Closed with a reason - do a lookup here.
-            $id = substr($entry->getAction(), strlen($text));
-            /** @var EmailTemplate $template */
-            $template = EmailTemplate::getById((int)$id, $entry->getDatabase());
-
-            if ($template != false) {
-                return "closed (" . $template->getName() . ")";
-            }
-        }
-
-        // Fall back to the basic stuff
-        $lookup = array(
-            'Reserved'            => 'reserved',
-            'Email Confirmed'     => 'email-confirmed',
-            'Unreserved'          => 'unreserved',
-            'Approved'            => 'approved',
-            'Suspended'           => 'suspended',
-            'RoleChange'          => 'changed roles',
-            'Banned'              => 'banned',
-            'Edited'              => 'edited interface message',
-            'Declined'            => 'declined',
-            'EditComment-c'       => 'edited a comment',
-            'EditComment-r'       => 'edited a comment',
-            'Unbanned'            => 'unbanned',
-            'Promoted'            => 'promoted to tool admin',
-            'BreakReserve'        => 'forcibly broke the reservation',
-            'Prefchange'          => 'changed user preferences',
-            'Renamed'             => 'renamed',
-            'Demoted'             => 'demoted from tool admin',
-            'ReceiveReserved'     => 'received the reservation',
-            'SendReserved'        => 'sent the reservation',
-            'EditedEmail'         => 'edited email',
-            'DeletedTemplate'     => 'deleted template',
-            'EditedTemplate'      => 'edited template',
-            'CreatedEmail'        => 'created email',
-            'CreatedTemplate'     => 'created template',
-            'SentMail'            => 'sent an email to the requester',
-            'Registered'          => 'registered a tool account',
-            'JobIssue'            => 'ran a background job unsuccessfully',
-            'JobCompleted'        => 'completed a background job',
-            'JobAcknowledged'     => 'acknowledged a job failure',
-            'JobRequeued'         => 'requeued a job for re-execution',
-            'EnqueuedJobQueue'    => 'scheduled for creation',
-            'Hospitalised'        => 'sent to the hospital',
-        );
-
-        if (array_key_exists($entry->getAction(), $lookup)) {
-            return $lookup[$entry->getAction()];
-        }
-
-        // OK, I don't know what this is. Fall back to something sane.
-        return "performed an unknown action ({$entry->getAction()})";
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return array
-     */
-    public static function getLogActions(PdoDatabase $database)
-    {
-        $lookup = array(
-            'Reserved'            => 'reserved',
-            'Email Confirmed'     => 'email-confirmed',
-            'Unreserved'          => 'unreserved',
-            'Approved'            => 'approved',
-            'Suspended'           => 'suspended',
-            'RoleChange'          => 'changed roles',
-            'Banned'              => 'banned',
-            'Edited'              => 'edited interface message',
-            'Declined'            => 'declined',
-            'EditComment-c'       => 'edited a comment (by comment ID)',
-            'EditComment-r'       => 'edited a comment (by request)',
-            'Unbanned'            => 'unbanned',
-            'Promoted'            => 'promoted to tool admin',
-            'BreakReserve'        => 'forcibly broke the reservation',
-            'Prefchange'          => 'changed user preferences',
-            'Renamed'             => 'renamed',
-            'Demoted'             => 'demoted from tool admin',
-            'ReceiveReserved'     => 'received the reservation',
-            'SendReserved'        => 'sent the reservation',
-            'EditedEmail'         => 'edited email',
-            'DeletedTemplate'     => 'deleted template',
-            'EditedTemplate'      => 'edited template',
-            'CreatedEmail'        => 'created email',
-            'CreatedTemplate'     => 'created template',
-            'SentMail'            => 'sent an email to the requester',
-            'Registered'          => 'registered a tool account',
-            'Closed 0'            => 'dropped request',
-            'JobIssue'            => 'ran a background job unsuccessfully',
-            'JobCompleted'        => 'completed a background job',
-            'JobAcknowledged'     => 'acknowledged a job failure',
-            'JobRequeued'         => 'requeued a job for re-execution',
-            'EnqueuedJobQueue'    => 'scheduled for creation',
-            'Hospitalised'        => 'sent to the hospital',
-        );
-
-        $statement = $database->query(<<<SQL
+	/**
+	 * Summary of getRequestLogsWithComments
+	 *
+	 * @param int             $requestId
+	 * @param PdoDatabase     $db
+	 * @param SecurityManager $securityManager
+	 *
+	 * @return DataObject[]
+	 */
+	public static function getRequestLogsWithComments($requestId, PdoDatabase $db, SecurityManager $securityManager)
+	{
+		$logs = LogSearchHelper::get($db)->byObjectType('Request')->byObjectId($requestId)->fetch();
+
+		$currentUser = User::getCurrent($db);
+		$securityResult = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser);
+		$showAllComments = $securityResult === SecurityManager::ALLOWED;
+
+		$comments = Comment::getForRequest($requestId, $db, $showAllComments, $currentUser->getId());
+
+		$items = array_merge($logs, $comments);
+
+		/**
+		 * @param DataObject $item
+		 *
+		 * @return int
+		 */
+		$sortKey = function(DataObject $item) {
+			if ($item instanceof Log) {
+				return $item->getTimestamp()->getTimestamp();
+			}
+
+			if ($item instanceof Comment) {
+				return $item->getTime()->getTimestamp();
+			}
+
+			return 0;
+		};
+
+		do {
+			$flag = false;
+
+			$loopLimit = (count($items) - 1);
+			for ($i = 0; $i < $loopLimit; $i++) {
+				// are these two items out of order?
+				if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
+					// swap them
+					$swap = $items[$i];
+					$items[$i] = $items[$i + 1];
+					$items[$i + 1] = $swap;
+
+					// set a flag to say we've modified the array this time around
+					$flag = true;
+				}
+			}
+		}
+		while ($flag);
+
+		return $items;
+	}
+
+	/**
+	 * Summary of getLogDescription
+	 *
+	 * @param Log $entry
+	 *
+	 * @return string
+	 */
+	public static function getLogDescription(Log $entry)
+	{
+		$text = "Deferred to ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Deferred to a different queue
+			// This is exactly what we want to display.
+			return $entry->getAction();
+		}
+
+		$text = "Closed custom-n";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account not created)";
+		}
+
+		$text = "Closed custom-y";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account created)";
+		}
+
+		$text = "Closed 0";
+		if ($entry->getAction() == $text) {
+			// Dropped the request - short-circuit the lookup
+			return "dropped request";
+		}
+
+		$text = "Closed ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Closed with a reason - do a lookup here.
+			$id = substr($entry->getAction(), strlen($text));
+			/** @var EmailTemplate $template */
+			$template = EmailTemplate::getById((int)$id, $entry->getDatabase());
+
+			if ($template != false) {
+				return "closed (" . $template->getName() . ")";
+			}
+		}
+
+		// Fall back to the basic stuff
+		$lookup = array(
+			'Reserved'            => 'reserved',
+			'Email Confirmed'     => 'email-confirmed',
+			'Unreserved'          => 'unreserved',
+			'Approved'            => 'approved',
+			'Suspended'           => 'suspended',
+			'RoleChange'          => 'changed roles',
+			'Banned'              => 'banned',
+			'Edited'              => 'edited interface message',
+			'Declined'            => 'declined',
+			'EditComment-c'       => 'edited a comment',
+			'EditComment-r'       => 'edited a comment',
+			'Unbanned'            => 'unbanned',
+			'Promoted'            => 'promoted to tool admin',
+			'BreakReserve'        => 'forcibly broke the reservation',
+			'Prefchange'          => 'changed user preferences',
+			'Renamed'             => 'renamed',
+			'Demoted'             => 'demoted from tool admin',
+			'ReceiveReserved'     => 'received the reservation',
+			'SendReserved'        => 'sent the reservation',
+			'EditedEmail'         => 'edited email',
+			'DeletedTemplate'     => 'deleted template',
+			'EditedTemplate'      => 'edited template',
+			'CreatedEmail'        => 'created email',
+			'CreatedTemplate'     => 'created template',
+			'SentMail'            => 'sent an email to the requester',
+			'Registered'          => 'registered a tool account',
+			'JobIssue'            => 'ran a background job unsuccessfully',
+			'JobCompleted'        => 'completed a background job',
+			'JobAcknowledged'     => 'acknowledged a job failure',
+			'JobRequeued'         => 'requeued a job for re-execution',
+			'EnqueuedJobQueue'    => 'scheduled for creation',
+			'Hospitalised'        => 'sent to the hospital',
+		);
+
+		if (array_key_exists($entry->getAction(), $lookup)) {
+			return $lookup[$entry->getAction()];
+		}
+
+		// OK, I don't know what this is. Fall back to something sane.
+		return "performed an unknown action ({$entry->getAction()})";
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return array
+	 */
+	public static function getLogActions(PdoDatabase $database)
+	{
+		$lookup = array(
+			'Reserved'            => 'reserved',
+			'Email Confirmed'     => 'email-confirmed',
+			'Unreserved'          => 'unreserved',
+			'Approved'            => 'approved',
+			'Suspended'           => 'suspended',
+			'RoleChange'          => 'changed roles',
+			'Banned'              => 'banned',
+			'Edited'              => 'edited interface message',
+			'Declined'            => 'declined',
+			'EditComment-c'       => 'edited a comment (by comment ID)',
+			'EditComment-r'       => 'edited a comment (by request)',
+			'Unbanned'            => 'unbanned',
+			'Promoted'            => 'promoted to tool admin',
+			'BreakReserve'        => 'forcibly broke the reservation',
+			'Prefchange'          => 'changed user preferences',
+			'Renamed'             => 'renamed',
+			'Demoted'             => 'demoted from tool admin',
+			'ReceiveReserved'     => 'received the reservation',
+			'SendReserved'        => 'sent the reservation',
+			'EditedEmail'         => 'edited email',
+			'DeletedTemplate'     => 'deleted template',
+			'EditedTemplate'      => 'edited template',
+			'CreatedEmail'        => 'created email',
+			'CreatedTemplate'     => 'created template',
+			'SentMail'            => 'sent an email to the requester',
+			'Registered'          => 'registered a tool account',
+			'Closed 0'            => 'dropped request',
+			'JobIssue'            => 'ran a background job unsuccessfully',
+			'JobCompleted'        => 'completed a background job',
+			'JobAcknowledged'     => 'acknowledged a job failure',
+			'JobRequeued'         => 'requeued a job for re-execution',
+			'EnqueuedJobQueue'    => 'scheduled for creation',
+			'Hospitalised'        => 'sent to the hospital',
+		);
+
+		$statement = $database->query(<<<SQL
 SELECT CONCAT('Closed ', id) AS k, CONCAT('closed (',name,')') AS v
 FROM emailtemplate;
 SQL
-        );
-        foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $lookup[$row['k']] = $row['v'];
-        }
-
-        return $lookup;
-    }
-
-    public static function getObjectTypes()
-    {
-        return array(
-            'Ban'             => 'Ban',
-            'Comment'         => 'Comment',
-            'EmailTemplate'   => 'Email template',
-            'JobQueue'        => 'Job queue item',
-            'Request'         => 'Request',
-            'SiteNotice'      => 'Site notice',
-            'User'            => 'User',
-            'WelcomeTemplate' => 'Welcome template',
-        );
-    }
-
-    /**
-     * This returns a HTML
-     *
-     * @param string            $objectId
-     * @param string            $objectType
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return null|string
-     * @category Security-Critical
-     */
-    private static function getObjectDescription(
-        $objectId,
-        $objectType,
-        PdoDatabase $database,
-        SiteConfiguration $configuration
-    ) {
-        if ($objectType == '') {
-            return null;
-        }
-
-        $baseurl = $configuration->getBaseUrl();
-
-        switch ($objectType) {
-            case 'Ban':
-                /** @var Ban $ban */
-                $ban = Ban::getById($objectId, $database);
-
-                if ($ban === false) {
-                    return 'Ban #' . $objectId . "</a>";
-                }
-
-                return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
-            case 'EmailTemplate':
-                /** @var EmailTemplate $emailTemplate */
-                $emailTemplate = EmailTemplate::getById($objectId, $database);
-                $name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+		);
+		foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$lookup[$row['k']] = $row['v'];
+		}
+
+		return $lookup;
+	}
+
+	public static function getObjectTypes()
+	{
+		return array(
+			'Ban'             => 'Ban',
+			'Comment'         => 'Comment',
+			'EmailTemplate'   => 'Email template',
+			'JobQueue'        => 'Job queue item',
+			'Request'         => 'Request',
+			'SiteNotice'      => 'Site notice',
+			'User'            => 'User',
+			'WelcomeTemplate' => 'Welcome template',
+		);
+	}
+
+	/**
+	 * This returns a HTML
+	 *
+	 * @param string            $objectId
+	 * @param string            $objectType
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return null|string
+	 * @category Security-Critical
+	 */
+	private static function getObjectDescription(
+		$objectId,
+		$objectType,
+		PdoDatabase $database,
+		SiteConfiguration $configuration
+	) {
+		if ($objectType == '') {
+			return null;
+		}
+
+		$baseurl = $configuration->getBaseUrl();
+
+		switch ($objectType) {
+			case 'Ban':
+				/** @var Ban $ban */
+				$ban = Ban::getById($objectId, $database);
+
+				if ($ban === false) {
+					return 'Ban #' . $objectId . "</a>";
+				}
+
+				return 'Ban #' . $objectId . " (" . htmlentities($ban->getTarget()) . ")</a>";
+			case 'EmailTemplate':
+				/** @var EmailTemplate $emailTemplate */
+				$emailTemplate = EmailTemplate::getById($objectId, $database);
+				$name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/emailManagement/view?id={$objectId}">Email Template #{$objectId} ({$name})</a>
 HTML;
-            case 'SiteNotice':
-                return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
-            case 'Request':
-                /** @var Request $request */
-                $request = Request::getById($objectId, $database);
-                $name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
-
-                return <<<HTML
+			case 'SiteNotice':
+				return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
+			case 'Request':
+				/** @var Request $request */
+				$request = Request::getById($objectId, $database);
+				$name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/viewRequest?id={$objectId}">Request #{$objectId} ({$name})</a>
 HTML;
-            case 'User':
-                /** @var User $user */
-                $user = User::getById($objectId, $database);
-                $username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
-            case 'WelcomeTemplate':
-                /** @var WelcomeTemplate $welcomeTemplate */
-                $welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
-
-                // some old templates have been completely deleted and lost to the depths of time.
-                if ($welcomeTemplate === false) {
-                    return "Welcome template #{$objectId}";
-                }
-                else {
-                    $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
-
-                    return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
-                }
-            case 'JobQueue':
-                /** @var JobQueue $job */
-                $job = JobQueue::getById($objectId, $database);
-
-                $taskDescriptions = JobQueue::getTaskDescriptions();
-
-                $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
-                    $description = $taskDescriptions[$task];
-                } else {
-                    $description = 'Unknown task';
-                }
-
-                return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
-            default:
-                return '[' . $objectType . " " . $objectId . ']';
-        }
-    }
-
-    /**
-     * @param Log[]             $logs
-     * @param PdoDatabase       $database
-     * @param SiteConfiguration $configuration
-     *
-     * @return array
-     * @throws Exception
-     */
-    public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
-    {
-        $userIds = array();
-
-	    foreach ($logs as $logEntry) {
-            if (!$logEntry instanceof Log) {
-                // if this happens, we've done something wrong with passing back the log data.
-                throw new Exception('Log entry is not an instance of a Log, this should never happen.');
-            }
-
-            $user = $logEntry->getUser();
-            if ($user === -1) {
-                continue;
-            }
-
-            if (!array_search($user, $userIds)) {
-                $userIds[] = $user;
-            }
-        }
-
-        $users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
-        $users[-1] = User::getCommunity()->getUsername();
-
-        $logData = array();
-
-	    foreach ($logs as $logEntry) {
-            $objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
-                $database, $configuration);
-
-            // initialise to sane default
-            $comment = null;
-
-            switch ($logEntry->getAction()) {
-                case 'Renamed':
-                    $renameData = unserialize($logEntry->getComment());
-                    $oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
-                    $newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
-                    $comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
-                    break;
-                case 'RoleChange':
-                    $roleChangeData = unserialize($logEntry->getComment());
-
-                    $removed = array();
-                    foreach ($roleChangeData['removed'] as $r) {
-                        $removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $added = array();
-                    foreach ($roleChangeData['added'] as $r) {
-                        $added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
-
-                    $roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
-                    $comment = $roleDelta . ' with comment: ' . $reason;
-                    break;
-                case 'JobIssue':
-                    $jobIssueData = unserialize($logEntry->getComment());
-                    $errorMessage = $jobIssueData['error'];
-                    $status = $jobIssueData['status'];
-
-                    $comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
-                    $comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
-                    break;
-                case 'JobIssueRequest':
-                case 'JobCompletedRequest':
-                    $jobData = unserialize($logEntry->getComment());
-
-                    /** @var JobQueue $job */
-                    $job = JobQueue::getById($jobData['job'], $database);
-                    $descs = JobQueue::getTaskDescriptions();
-                    $comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
-                    break;
-
-                case 'JobCompleted':
-                    break;
-                default:
-                    $comment = $logEntry->getComment();
-                    break;
-            }
-
-            $logData[] = array(
-                'timestamp'         => $logEntry->getTimestamp(),
-                'userid'            => $logEntry->getUser(),
-                'username'          => $users[$logEntry->getUser()],
-                'description'       => self::getLogDescription($logEntry),
-                'objectdescription' => $objectDescription,
-                'comment'           => $comment,
-            );
-        }
-
-        return array($users, $logData);
-    }
+			case 'User':
+				/** @var User $user */
+				$user = User::getById($objectId, $database);
+				$username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
+			case 'WelcomeTemplate':
+				/** @var WelcomeTemplate $welcomeTemplate */
+				$welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
+
+				// some old templates have been completely deleted and lost to the depths of time.
+				if ($welcomeTemplate === false) {
+					return "Welcome template #{$objectId}";
+				}
+				else {
+					$userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
+
+					return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
+				}
+			case 'JobQueue':
+				/** @var JobQueue $job */
+				$job = JobQueue::getById($objectId, $database);
+
+				$taskDescriptions = JobQueue::getTaskDescriptions();
+
+				$task = $job->getTask();
+				if(isset($taskDescriptions[$task])){
+					$description = $taskDescriptions[$task];
+				} else {
+					$description = 'Unknown task';
+				}
+
+				return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
+			default:
+				return '[' . $objectType . " " . $objectId . ']';
+		}
+	}
+
+	/**
+	 * @param Log[]             $logs
+	 * @param PdoDatabase       $database
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return array
+	 * @throws Exception
+	 */
+	public static function prepareLogsForTemplate($logs, PdoDatabase $database, SiteConfiguration $configuration)
+	{
+		$userIds = array();
+
+		foreach ($logs as $logEntry) {
+			if (!$logEntry instanceof Log) {
+				// if this happens, we've done something wrong with passing back the log data.
+				throw new Exception('Log entry is not an instance of a Log, this should never happen.');
+			}
+
+			$user = $logEntry->getUser();
+			if ($user === -1) {
+				continue;
+			}
+
+			if (!array_search($user, $userIds)) {
+				$userIds[] = $user;
+			}
+		}
+
+		$users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
+		$users[-1] = User::getCommunity()->getUsername();
+
+		$logData = array();
+
+		foreach ($logs as $logEntry) {
+			$objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
+				$database, $configuration);
+
+			// initialise to sane default
+			$comment = null;
+
+			switch ($logEntry->getAction()) {
+				case 'Renamed':
+					$renameData = unserialize($logEntry->getComment());
+					$oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
+					$newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
+					$comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
+					break;
+				case 'RoleChange':
+					$roleChangeData = unserialize($logEntry->getComment());
+
+					$removed = array();
+					foreach ($roleChangeData['removed'] as $r) {
+						$removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$added = array();
+					foreach ($roleChangeData['added'] as $r) {
+						$added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
+
+					$roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
+					$comment = $roleDelta . ' with comment: ' . $reason;
+					break;
+				case 'JobIssue':
+					$jobIssueData = unserialize($logEntry->getComment());
+					$errorMessage = $jobIssueData['error'];
+					$status = $jobIssueData['status'];
+
+					$comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
+					$comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
+					break;
+				case 'JobIssueRequest':
+				case 'JobCompletedRequest':
+					$jobData = unserialize($logEntry->getComment());
+
+					/** @var JobQueue $job */
+					$job = JobQueue::getById($jobData['job'], $database);
+					$descs = JobQueue::getTaskDescriptions();
+					$comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
+					break;
+
+				case 'JobCompleted':
+					break;
+				default:
+					$comment = $logEntry->getComment();
+					break;
+			}
+
+			$logData[] = array(
+				'timestamp'         => $logEntry->getTimestamp(),
+				'userid'            => $logEntry->getUser(),
+				'username'          => $users[$logEntry->getUser()],
+				'description'       => self::getLogDescription($logEntry),
+				'objectdescription' => $objectDescription,
+				'comment'           => $comment,
+			);
+		}
+
+		return array($users, $logData);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -323,7 +323,7 @@
                 $taskDescriptions = JobQueue::getTaskDescriptions();
 
                 $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
+                if (isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
                 } else {
                     $description = 'Unknown task';

Braces +4 added lines, -4 removed lines

@@ -53,7 +53,8 @@ 
          *
          * @return int
          */
-        $sortKey = function(DataObject $item) {
+        $sortKey = function(DataObject $item)
+        {
             if ($item instanceof Log) {
                 return $item->getTimestamp()->getTimestamp();
             }
@@ -310,8 +311,7 @@ 
                 // some old templates have been completely deleted and lost to the depths of time.
                 if ($welcomeTemplate === false) {
                     return "Welcome template #{$objectId}";
-                }
-                else {
+                } else {
                     $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
 
                     return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
@@ -323,7 +323,7 @@ 
                 $taskDescriptions = JobQueue::getTaskDescriptions();
 
                 $task = $job->getTask();
-                if(isset($taskDescriptions[$task])){
+                if(isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
                 } else {
                     $description = 'Unknown task';

includes/Tasks/InternalPageBase.php

Indentation +220 added lines, -220 removed lines

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

Braces +5 added lines, -10 removed lines

@@ -85,8 +85,7 @@ 
         if ($securityResult === SecurityManager::ALLOWED) {
             // We're allowed to run the page, so let's run it.
             $this->runPage();
-        }
-        else {
+        } else {
             $this->handleAccessDenied($securityResult);
 
             // Send the headers
@@ -110,8 +109,7 @@ 
 
             if (WebRequest::testSiteNoticeCookieValue($siteNoticeHash)) {
                 $this->assign('siteNoticeState', 'd-none');
-            }
-            else {
+            } else {
                 $this->assign('siteNoticeState', 'd-block');
             }
 
@@ -157,19 +155,16 @@ 
             $this->redirect("login");
 
             return;
-        }
-        else {
+        } else {
             // Decide whether this was a rights failure, or an identification failure.
 
             if ($denyReason === SecurityManager::ERROR_NOT_IDENTIFIED) {
                 // Not identified
                 throw new NotIdentifiedException($this->getSecurityManager());
-            }
-            elseif ($denyReason === SecurityManager::ERROR_DENIED) {
+            } elseif ($denyReason === SecurityManager::ERROR_DENIED) {
                 // Nope, plain old access denied
                 throw new AccessDeniedException($this->getSecurityManager());
-            }
-            else {
+            } else {
                 throw new Exception('Unknown response from security manager.');
             }
         }

includes/Tasks/PageBase.php

Indentation +370 added lines, -370 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -319,8 +319,8 @@
      *
      * @param string $path The path (relative to the application root) of the file
      */
-    final protected function addJs($path){
-        if(in_array($path, $this->extraJs)){
+    final protected function addJs($path) {
+        if (in_array($path, $this->extraJs)) {
             // nothing to do
             return;
         }

Braces +4 added lines, -4 removed lines

@@ -259,8 +259,7 @@ 
         // Are we changing script?
         if ($script === null || substr($currentScriptName, -1 * count($script)) === $script) {
             $targetScriptName = $currentScriptName;
-        }
-        else {
+        } else {
             $targetScriptName = $this->getSiteConfiguration()->getBaseUrl() . '/' . $script;
         }
 
@@ -319,8 +318,9 @@ 
      *
      * @param string $path The path (relative to the application root) of the file
      */
-    final protected function addJs($path){
-        if(in_array($path, $this->extraJs)){
+    final protected function addJs($path)
+    {
+        if(in_array($path, $this->extraJs)) {
             // nothing to do
             return;
         }