mdaniels5757 / waca

includes/Helpers/SearchHelpers/RequestSearchHelper.php

Indentation +211 added lines, -211 removed lines

@@ -15,215 +15,215 @@
 
 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
-     * @param int|null    $domain
-     *
-     * @return RequestSearchHelper
-     */
-    public static function get(PdoDatabase $database, ?int $domain)
-    {
-        $helper = new RequestSearchHelper($database);
-
-        if ($domain !== null) {
-            $helper->whereClause .= ' AND domain = ?';
-            $helper->parameterList[] = $domain;
-        }
-
-        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 results by comment
-     *
-     * @param string $comment
-     *
-     * @return $this
-     */
-    public function byComment($comment)
-    {
-        $this->modifiersClause = 'DISTINCT';
-        $this->joinClause .= ' INNER JOIN comment c ON origin.id = c.request';
-        $this->whereClause .= ' AND c.comment LIKE ?';
-        $this->parameterList[] = $comment;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by comment security
-     *
-     * @param array $security List of allowed values for the security clause
-     *
-     * @return $this
-     */
-    public function byCommentSecurity(array $security)
-    {
-        $this->inClause('c.visibility', $security);
-
-        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 fetchByQueue($queues)
-    {
-        return $this->fetchByParameter(' AND queue = ?', $queues);
-    }
+	/**
+	 * RequestSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'request', Request::class);
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 * @param int|null    $domain
+	 *
+	 * @return RequestSearchHelper
+	 */
+	public static function get(PdoDatabase $database, ?int $domain)
+	{
+		$helper = new RequestSearchHelper($database);
+
+		if ($domain !== null) {
+			$helper->whereClause .= ' AND domain = ?';
+			$helper->parameterList[] = $domain;
+		}
+
+		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 results by comment
+	 *
+	 * @param string $comment
+	 *
+	 * @return $this
+	 */
+	public function byComment($comment)
+	{
+		$this->modifiersClause = 'DISTINCT';
+		$this->joinClause .= ' INNER JOIN comment c ON origin.id = c.request';
+		$this->whereClause .= ' AND c.comment LIKE ?';
+		$this->parameterList[] = $comment;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by comment security
+	 *
+	 * @param array $security List of allowed values for the security clause
+	 *
+	 * @return $this
+	 */
+	public function byCommentSecurity(array $security)
+	{
+		$this->inClause('c.visibility', $security);
+
+		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 fetchByQueue($queues)
+	{
+		return $this->fetchByParameter(' AND queue = ?', $queues);
+	}
 }

includes/Helpers/SearchHelpers/SearchHelperBase.php

Indentation +272 added lines, -272 removed lines

@@ -16,276 +16,276 @@
 
 abstract class SearchHelperBase
 {
-    /** @var PdoDatabase */
-    protected $database;
-    /** @var array */
-    protected $parameterList = array();
-    /** @var null|int */
-    private $limit = null;
-    /** @var null|int */
-    private $offset = null;
-    protected $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} /* " . get_called_class() . " */ " . 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) {
-            $this->whereClause .= ' AND 1 = 2 /* empty IN() */';
-            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;
+	protected $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} /* " . get_called_class() . " */ " . 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) {
+			$this->whereClause .= ' AND 1 = 2 /* empty IN() */';
+			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/JobQueueSearchHelper.php

Indentation +79 added lines, -79 removed lines

@@ -13,85 +13,85 @@
 
 class JobQueueSearchHelper extends SearchHelperBase
 {
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'jobqueue', JobQueue::class, null);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param int         $domain
-     *
-     * @return JobQueueSearchHelper
-     */
-    public static function get(PdoDatabase $database, int $domain)
-    {
-        $helper = new JobQueueSearchHelper($database);
-
-        $helper->whereClause .= ' AND domain = ?';
-        $helper->parameterList[] = $domain;
-
-        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
+	 * @param int         $domain
+	 *
+	 * @return JobQueueSearchHelper
+	 */
+	public static function get(PdoDatabase $database, int $domain)
+	{
+		$helper = new JobQueueSearchHelper($database);
+
+		$helper->whereClause .= ' AND domain = ?';
+		$helper->parameterList[] = $domain;
+
+		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;
+	}
     
-    public function newestFirst()
-    {
-        $this->orderBy = 'id DESC';
+	public function newestFirst()
+	{
+		$this->orderBy = 'id DESC';
         
-        return $this;
-    }     
+		return $this;
+	}     
 }

includes/Helpers/SearchHelpers/LogSearchHelper.php

Indentation +83 added lines, -83 removed lines

@@ -13,98 +13,98 @@
 
 class LogSearchHelper extends SearchHelperBase
 {
-    /**
-     * LogSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'log', Log::class, 'timestamp DESC');
-    }
+	/**
+	 * LogSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'log', Log::class, 'timestamp DESC');
+	}
 
-    /**
-     * Initiates a search for logs
-     *
-     * @param PdoDatabase $database
-     * @param int|null $domain The domain to search for. This will retrieve both logs for the specified domain and
-     *                         global logs if a value is specified. If null, only global logs are returned.
-     *
-     * @return LogSearchHelper
-     */
-    public static function get(PdoDatabase $database, ?int $domain)
-    {
-        $helper = new LogSearchHelper($database);
+	/**
+	 * Initiates a search for logs
+	 *
+	 * @param PdoDatabase $database
+	 * @param int|null $domain The domain to search for. This will retrieve both logs for the specified domain and
+	 *                         global logs if a value is specified. If null, only global logs are returned.
+	 *
+	 * @return LogSearchHelper
+	 */
+	public static function get(PdoDatabase $database, ?int $domain)
+	{
+		$helper = new LogSearchHelper($database);
 
-        if ($domain === null) {
-            $helper->whereClause .= ' AND domain IS NULL';
-        }
-        else {
-            $helper->whereClause .= ' AND coalesce(domain, ?) = ?';
-            $helper->parameterList[] = $domain;
-            $helper->parameterList[] = $domain;
-        }
+		if ($domain === null) {
+			$helper->whereClause .= ' AND domain IS NULL';
+		}
+		else {
+			$helper->whereClause .= ' AND coalesce(domain, ?) = ?';
+			$helper->parameterList[] = $domain;
+			$helper->parameterList[] = $domain;
+		}
 
-        return $helper;
-    }
+		return $helper;
+	}
 
-    /**
-     * Filters the results by user
-     *
-     * @param int $userId
-     *
-     * @return $this
-     */
-    public function byUser($userId)
-    {
-        $this->whereClause .= ' AND user = ?';
-        $this->parameterList[] = $userId;
+	/**
+	 * Filters the results by user
+	 *
+	 * @param int $userId
+	 *
+	 * @return $this
+	 */
+	public function byUser($userId)
+	{
+		$this->whereClause .= ' AND user = ?';
+		$this->parameterList[] = $userId;
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Filters the results by log action
-     *
-     * @param string $action
-     *
-     * @return $this
-     */
-    public function byAction($action)
-    {
-        $this->whereClause .= ' AND action = ?';
-        $this->parameterList[] = $action;
+	/**
+	 * Filters the results by log action
+	 *
+	 * @param string $action
+	 *
+	 * @return $this
+	 */
+	public function byAction($action)
+	{
+		$this->whereClause .= ' AND action = ?';
+		$this->parameterList[] = $action;
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Filters the results by object type
-     *
-     * @param string $objectType
-     *
-     * @return $this
-     */
-    public function byObjectType($objectType)
-    {
-        $this->whereClause .= ' AND objecttype = ?';
-        $this->parameterList[] = $objectType;
+	/**
+	 * Filters the results by object type
+	 *
+	 * @param string $objectType
+	 *
+	 * @return $this
+	 */
+	public function byObjectType($objectType)
+	{
+		$this->whereClause .= ' AND objecttype = ?';
+		$this->parameterList[] = $objectType;
 
-        return $this;
-    }
+		return $this;
+	}
 
-    /**
-     * Filters the results by object type
-     *
-     * @param integer $objectId
-     *
-     * @return $this
-     */
-    public function byObjectId($objectId)
-    {
-        $this->whereClause .= ' AND objectid = ?';
-        $this->parameterList[] = $objectId;
+	/**
+	 * Filters the results by object type
+	 *
+	 * @param integer $objectId
+	 *
+	 * @return $this
+	 */
+	public function byObjectId($objectId)
+	{
+		$this->whereClause .= ' AND objectid = ?';
+		$this->parameterList[] = $objectId;
 
-        return $this;
-    }
+		return $this;
+	}
 }
\ No newline at end of file

Braces +1 added lines, -2 removed lines

@@ -38,8 +38,7 @@
 
         if ($domain === null) {
             $helper->whereClause .= ' AND domain IS NULL';
-        }
-        else {
+        } else {
             $helper->whereClause .= ' AND coalesce(domain, ?) = ?';
             $helper->parameterList[] = $domain;
             $helper->parameterList[] = $domain;

includes/DataObject.php

Indentation +120 added lines, -120 removed lines

@@ -23,124 +23,124 @@
  */
 abstract class DataObject
 {
-    /** @var int|null ID of the object */
-    protected $id = null;
-    /** @var int update version for optimistic locking */
-    protected $updateversion = 0;
-    /**
-     * @var PdoDatabase
-     */
-    protected $dbObject;
-
-    /**
-     * Retrieves a data object by it's row ID.
-     *
-     * @param int         $id
-     * @param PdoDatabase $database
-     *
-     * @return DataObject|false
-     */
-    public static function getById($id, PdoDatabase $database)
-    {
-        $array = explode('\\', get_called_class());
-        $realClassName = strtolower(end($array));
-
-        $statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;");
-        $statement->bindValue(":id", $id);
-
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    public function setDatabase(PdoDatabase $db)
-    {
-        $this->dbObject = $db;
-    }
-
-    /**
-     * Gets the database associated with this data object.
-     * @return PdoDatabase
-     */
-    public function getDatabase()
-    {
-        return $this->dbObject;
-    }
-
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     *
-     * @return void
-     */
-    abstract public function save();
-
-    /**
-     * Retrieves the ID attribute
-     */
-    public function getId()
-    {
-        return (int)$this->id;
-    }
-
-    /**
-     * Deletes the object from the database
-     */
-    public function delete()
-    {
-        if ($this->id === null) {
-            // wtf?
-            return;
-        }
-
-        $array = explode('\\', get_called_class());
-        $realClassName = strtolower(end($array));
-
-        $deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion;";
-        $statement = $this->dbObject->prepare($deleteQuery);
-
-        $statement->bindValue(":id", $this->id);
-        $statement->bindValue(":updateversion", $this->updateversion);
-        $statement->execute();
-
-        if ($statement->rowCount() !== 1) {
-            throw new OptimisticLockFailedException();
-        }
-
-        $this->id = null;
-    }
-
-    /**
-     * @return int
-     */
-    public function getUpdateVersion()
-    {
-        return $this->updateversion;
-    }
-
-    /**
-     * Sets the update version.
-     *
-     * You should never call this to change the value of the update version. You should only call it when passing user
-     * input through.
-     *
-     * @param int $updateVersion
-     */
-    public function setUpdateVersion($updateVersion)
-    {
-        $this->updateversion = $updateVersion;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isNew()
-    {
-        return $this->id === null;
-    }
+	/** @var int|null ID of the object */
+	protected $id = null;
+	/** @var int update version for optimistic locking */
+	protected $updateversion = 0;
+	/**
+	 * @var PdoDatabase
+	 */
+	protected $dbObject;
+
+	/**
+	 * Retrieves a data object by it's row ID.
+	 *
+	 * @param int         $id
+	 * @param PdoDatabase $database
+	 *
+	 * @return DataObject|false
+	 */
+	public static function getById($id, PdoDatabase $database)
+	{
+		$array = explode('\\', get_called_class());
+		$realClassName = strtolower(end($array));
+
+		$statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;");
+		$statement->bindValue(":id", $id);
+
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	public function setDatabase(PdoDatabase $db)
+	{
+		$this->dbObject = $db;
+	}
+
+	/**
+	 * Gets the database associated with this data object.
+	 * @return PdoDatabase
+	 */
+	public function getDatabase()
+	{
+		return $this->dbObject;
+	}
+
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 *
+	 * @return void
+	 */
+	abstract public function save();
+
+	/**
+	 * Retrieves the ID attribute
+	 */
+	public function getId()
+	{
+		return (int)$this->id;
+	}
+
+	/**
+	 * Deletes the object from the database
+	 */
+	public function delete()
+	{
+		if ($this->id === null) {
+			// wtf?
+			return;
+		}
+
+		$array = explode('\\', get_called_class());
+		$realClassName = strtolower(end($array));
+
+		$deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion;";
+		$statement = $this->dbObject->prepare($deleteQuery);
+
+		$statement->bindValue(":id", $this->id);
+		$statement->bindValue(":updateversion", $this->updateversion);
+		$statement->execute();
+
+		if ($statement->rowCount() !== 1) {
+			throw new OptimisticLockFailedException();
+		}
+
+		$this->id = null;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUpdateVersion()
+	{
+		return $this->updateversion;
+	}
+
+	/**
+	 * Sets the update version.
+	 *
+	 * You should never call this to change the value of the update version. You should only call it when passing user
+	 * input through.
+	 *
+	 * @param int $updateVersion
+	 */
+	public function setUpdateVersion($updateVersion)
+	{
+		$this->updateversion = $updateVersion;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isNew()
+	{
+		return $this->id === null;
+	}
 }

includes/IdentificationVerifier.php

Indentation +161 added lines, -161 removed lines

@@ -26,133 +26,133 @@ 
  */
 class IdentificationVerifier
 {
-    /**
-     * This field is an array of parameters, in key => value format, that should be appended to the Meta Wikimedia
-     * Web Service Endpoint URL to query if a user is listed on the Identification Noticeboard.  Note that URL encoding
-     * of these values is *not* necessary; this is done automatically.
-     *
-     * @var string[]
-     * @category Security-Critical
-     */
-    private static $apiQueryParameters = array(
-        'action'   => 'query',
-        'format'   => 'json',
-        'prop'     => 'links',
-        // Populated from SiteConfiguration->getIdentificationNoticeboardPage
-        'titles'   => '',
-        // Username of the user to be checked, with User: prefix, goes here!  Set in isIdentifiedOnWiki()
-        'pltitles' => '',
-    );
-    /** @var HttpHelper */
-    private $httpHelper;
-    /** @var SiteConfiguration */
-    private $siteConfiguration;
-    /** @var PdoDatabase */
-    private $dbObject;
-
-    /**
-     * IdentificationVerifier constructor.
-     *
-     * @param HttpHelper        $httpHelper
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $dbObject
-     */
-    public function __construct(HttpHelper $httpHelper, SiteConfiguration $siteConfiguration, PdoDatabase $dbObject)
-    {
-        $this->httpHelper = $httpHelper;
-        $this->siteConfiguration = $siteConfiguration;
-        $this->dbObject = $dbObject;
-    }
-
-    /**
-     * Checks if the given user is identified to the Wikimedia Foundation.
-     *
-     * @param string $onWikiName The Wikipedia username of the user
-     *
-     * @return bool
-     * @category Security-Critical
-     * @throws EnvironmentException
-     */
-    public function isUserIdentified($onWikiName)
-    {
-        if ($this->checkIdentificationCache($onWikiName)) {
-            return true;
-        }
-        else {
-            if ($this->isIdentifiedOnWiki($onWikiName)) {
-                $this->cacheIdentificationStatus($onWikiName);
-
-                return true;
-            }
-            else {
-                return false;
-            }
-        }
-    }
-
-    /**
-     * Checks if the given user has a valid entry in the idcache table.
-     *
-     * @param string $onWikiName The Wikipedia username of the user
-     *
-     * @return bool
-     * @category Security-Critical
-     */
-    private function checkIdentificationCache($onWikiName)
-    {
-        $interval = $this->siteConfiguration->getIdentificationCacheExpiry();
-
-        $query = <<<SQL
+	/**
+	 * This field is an array of parameters, in key => value format, that should be appended to the Meta Wikimedia
+	 * Web Service Endpoint URL to query if a user is listed on the Identification Noticeboard.  Note that URL encoding
+	 * of these values is *not* necessary; this is done automatically.
+	 *
+	 * @var string[]
+	 * @category Security-Critical
+	 */
+	private static $apiQueryParameters = array(
+		'action'   => 'query',
+		'format'   => 'json',
+		'prop'     => 'links',
+		// Populated from SiteConfiguration->getIdentificationNoticeboardPage
+		'titles'   => '',
+		// Username of the user to be checked, with User: prefix, goes here!  Set in isIdentifiedOnWiki()
+		'pltitles' => '',
+	);
+	/** @var HttpHelper */
+	private $httpHelper;
+	/** @var SiteConfiguration */
+	private $siteConfiguration;
+	/** @var PdoDatabase */
+	private $dbObject;
+
+	/**
+	 * IdentificationVerifier constructor.
+	 *
+	 * @param HttpHelper        $httpHelper
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $dbObject
+	 */
+	public function __construct(HttpHelper $httpHelper, SiteConfiguration $siteConfiguration, PdoDatabase $dbObject)
+	{
+		$this->httpHelper = $httpHelper;
+		$this->siteConfiguration = $siteConfiguration;
+		$this->dbObject = $dbObject;
+	}
+
+	/**
+	 * Checks if the given user is identified to the Wikimedia Foundation.
+	 *
+	 * @param string $onWikiName The Wikipedia username of the user
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 * @throws EnvironmentException
+	 */
+	public function isUserIdentified($onWikiName)
+	{
+		if ($this->checkIdentificationCache($onWikiName)) {
+			return true;
+		}
+		else {
+			if ($this->isIdentifiedOnWiki($onWikiName)) {
+				$this->cacheIdentificationStatus($onWikiName);
+
+				return true;
+			}
+			else {
+				return false;
+			}
+		}
+	}
+
+	/**
+	 * Checks if the given user has a valid entry in the idcache table.
+	 *
+	 * @param string $onWikiName The Wikipedia username of the user
+	 *
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	private function checkIdentificationCache($onWikiName)
+	{
+		$interval = $this->siteConfiguration->getIdentificationCacheExpiry();
+
+		$query = <<<SQL
 			SELECT COUNT(`id`)
 			FROM `idcache`
 			WHERE `onwikiusername` = :onwikiname
 				AND DATE_ADD(`checktime`, INTERVAL {$interval}) >= NOW();
 SQL;
-        $stmt = $this->dbObject->prepare($query);
-        $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR);
-        $stmt->execute();
-
-        // Guaranteed by the query to only return a single row with a single column
-        $results = $stmt->fetch(PDO::FETCH_NUM);
-
-        // I don't expect this to ever be a value other than 0 or 1 since the `onwikiusername` column is declared as a
-        // unique key - but meh.
-        return $results[0] != 0;
-    }
-
-    /**
-     * Does pretty much exactly what it says on the label - this method will clear all expired idcache entries from the
-     * idcache table.  Meant to be called periodically by a maintenance script.
-     *
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $dbObject
-     *
-     * @return void
-     */
-    public static function clearExpiredCacheEntries(SiteConfiguration $siteConfiguration, PdoDatabase $dbObject)
-    {
-        $interval = $siteConfiguration->getIdentificationCacheExpiry();
-
-        $query = <<<SQL
+		$stmt = $this->dbObject->prepare($query);
+		$stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR);
+		$stmt->execute();
+
+		// Guaranteed by the query to only return a single row with a single column
+		$results = $stmt->fetch(PDO::FETCH_NUM);
+
+		// I don't expect this to ever be a value other than 0 or 1 since the `onwikiusername` column is declared as a
+		// unique key - but meh.
+		return $results[0] != 0;
+	}
+
+	/**
+	 * Does pretty much exactly what it says on the label - this method will clear all expired idcache entries from the
+	 * idcache table.  Meant to be called periodically by a maintenance script.
+	 *
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $dbObject
+	 *
+	 * @return void
+	 */
+	public static function clearExpiredCacheEntries(SiteConfiguration $siteConfiguration, PdoDatabase $dbObject)
+	{
+		$interval = $siteConfiguration->getIdentificationCacheExpiry();
+
+		$query = <<<SQL
 			DELETE FROM `idcache`
 			WHERE DATE_ADD(`checktime`, INTERVAL {$interval}) < NOW();
 SQL;
-        $dbObject->prepare($query)->execute();
-    }
-
-    /**
-     * This method will add an entry to the idcache that the given Wikipedia user has been verified as identified.  This
-     * is so we don't have to hit the API every single time we check.  The cache entry is valid for as long as specified
-     * in the ACC configuration (validity enforced by checkIdentificationCache() and clearExpiredCacheEntries()).
-     *
-     * @param string $onWikiName The Wikipedia username of the user
-     *
-     * @return void
-     * @category Security-Critical
-     */
-    private function cacheIdentificationStatus($onWikiName)
-    {
-        $query = <<<SQL
+		$dbObject->prepare($query)->execute();
+	}
+
+	/**
+	 * This method will add an entry to the idcache that the given Wikipedia user has been verified as identified.  This
+	 * is so we don't have to hit the API every single time we check.  The cache entry is valid for as long as specified
+	 * in the ACC configuration (validity enforced by checkIdentificationCache() and clearExpiredCacheEntries()).
+	 *
+	 * @param string $onWikiName The Wikipedia username of the user
+	 *
+	 * @return void
+	 * @category Security-Critical
+	 */
+	private function cacheIdentificationStatus($onWikiName)
+	{
+		$query = <<<SQL
 			INSERT INTO `idcache`
 				(`onwikiusername`)
 			VALUES
@@ -161,46 +161,46 @@ 
 				`onwikiusername` = VALUES(`onwikiusername`),
 				`checktime` = CURRENT_TIMESTAMP;
 SQL;
-        $stmt = $this->dbObject->prepare($query);
-        $stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR);
-        $stmt->execute();
-    }
-
-    /**
-     * Queries the Wikimedia API to determine if the specified user is listed on the identification noticeboard.
-     *
-     * @param string $onWikiName The Wikipedia username of the user
-     *
-     * @return bool
-     * @throws EnvironmentException
-     * @category Security-Critical
-     */
-    private function isIdentifiedOnWiki($onWikiName)
-    {
-        $strings = new StringFunctions();
-
-        // First character of Wikipedia usernames is always capitalized.
-        $onWikiName = $strings->upperCaseFirst($onWikiName);
-
-        $parameters = self::$apiQueryParameters;
-        $parameters['pltitles'] = "User:" . $onWikiName;
-        $parameters['titles'] = $this->siteConfiguration->getIdentificationNoticeboardPage();
-
-        try {
-            $endpoint = $this->siteConfiguration->getIdentificationNoticeboardWebserviceEndpoint();
-            $response = $this->httpHelper->get($endpoint, $parameters);
-            $response = json_decode($response, true);
-        }
-        catch (CurlException $ex) {
-            // failed getting identification status, so throw a nicer error.
-            $message = 'Could not contact metawiki API to determine user\' identification status. '
-                . 'This is probably a transient error, so please try again.';
-
-            throw new EnvironmentException($message);
-        }
-
-        $page = @array_pop($response['query']['pages']);
-
-        return @$page['links'][0]['title'] === "User:" . $onWikiName;
-    }
+		$stmt = $this->dbObject->prepare($query);
+		$stmt->bindValue(':onwikiname', $onWikiName, PDO::PARAM_STR);
+		$stmt->execute();
+	}
+
+	/**
+	 * Queries the Wikimedia API to determine if the specified user is listed on the identification noticeboard.
+	 *
+	 * @param string $onWikiName The Wikipedia username of the user
+	 *
+	 * @return bool
+	 * @throws EnvironmentException
+	 * @category Security-Critical
+	 */
+	private function isIdentifiedOnWiki($onWikiName)
+	{
+		$strings = new StringFunctions();
+
+		// First character of Wikipedia usernames is always capitalized.
+		$onWikiName = $strings->upperCaseFirst($onWikiName);
+
+		$parameters = self::$apiQueryParameters;
+		$parameters['pltitles'] = "User:" . $onWikiName;
+		$parameters['titles'] = $this->siteConfiguration->getIdentificationNoticeboardPage();
+
+		try {
+			$endpoint = $this->siteConfiguration->getIdentificationNoticeboardWebserviceEndpoint();
+			$response = $this->httpHelper->get($endpoint, $parameters);
+			$response = json_decode($response, true);
+		}
+		catch (CurlException $ex) {
+			// failed getting identification status, so throw a nicer error.
+			$message = 'Could not contact metawiki API to determine user\' identification status. '
+				. 'This is probably a transient error, so please try again.';
+
+			throw new EnvironmentException($message);
+		}
+
+		$page = @array_pop($response['query']['pages']);
+
+		return @$page['links'][0]['title'] === "User:" . $onWikiName;
+	}
 }

Braces +2 added lines, -4 removed lines

@@ -77,14 +77,12 @@
     {
         if ($this->checkIdentificationCache($onWikiName)) {
             return true;
-        }
-        else {
+        } else {
             if ($this->isIdentifiedOnWiki($onWikiName)) {
                 $this->cacheIdentificationStatus($onWikiName);
 
                 return true;
-            }
-            else {
+            } else {
                 return false;
             }
         }

includes/ExceptionHandler.php

Indentation +116 added lines, -116 removed lines

@@ -13,22 +13,22 @@ 
 
 class ExceptionHandler
 {
-    /**
-     * Global exception handler
-     *
-     * Smarty would be nice to use, but it COULD BE smarty that throws the errors.
-     * Let's build something ourselves, and hope it works.
-     *
-     * @param $exception
-     *
-     * @category Security-Critical - has the potential to leak data when exception is thrown.
-     */
-    public static function exceptionHandler(Throwable $exception)
-    {
-        /** @global $siteConfiguration SiteConfiguration */
-        global $siteConfiguration;
-
-        $errorDocument = <<<HTML
+	/**
+	 * Global exception handler
+	 *
+	 * Smarty would be nice to use, but it COULD BE smarty that throws the errors.
+	 * Let's build something ourselves, and hope it works.
+	 *
+	 * @param $exception
+	 *
+	 * @category Security-Critical - has the potential to leak data when exception is thrown.
+	 */
+	public static function exceptionHandler(Throwable $exception)
+	{
+		/** @global $siteConfiguration SiteConfiguration */
+		global $siteConfiguration;
+
+		$errorDocument = <<<HTML
 <!DOCTYPE html>
 <html lang="en"><head>
 <meta charset="utf-8">
@@ -48,104 +48,104 @@ 
 </div></body></html>
 HTML;
 
-        list($errorData, $errorId) = self::logExceptionToDisk($exception, $siteConfiguration, true);
-
-        // clear and discard any content that's been saved to the output buffer
-        if (ob_get_level() > 0) {
-            ob_end_clean();
-        }
-
-        // push error ID into the document.
-        $message = str_replace('$1$', $errorId, $errorDocument);
-
-        if ($siteConfiguration->getDebuggingTraceEnabled()) {
-            ob_start();
-            var_dump($errorData);
-            $textErrorData = ob_get_contents();
-            ob_end_clean();
-
-            $message = str_replace('$2$', $textErrorData, $message);
-        }
-        else {
-            $message = str_replace('$2$', "", $message);
-        }
-
-        // While we *shouldn't* have sent headers by now due to the output buffering, PHPUnit does weird things.
-        // This is "only" needed for the tests, but it's a good idea to wrap this anyway.
-        if (!headers_sent()) {
-            header('HTTP/1.1 500 Internal Server Error');
-        }
-
-        // output the document
-        print $message;
-    }
-
-    /**
-     * @param int    $errorSeverity The severity level of the exception.
-     * @param string $errorMessage  The Exception message to throw.
-     * @param string $errorFile     The filename where the exception is thrown.
-     * @param int    $errorLine     The line number where the exception is thrown.
-     *
-     * @throws ErrorException
-     */
-    public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
-    {
-        // call into the main exception handler above
-        throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
-    }
-
-    /**
-     * @param Throwable $exception
-     *
-     * @return null|array
-     */
-    public static function getExceptionData($exception)
-    {
-        if ($exception == null) {
-            return null;
-        }
-
-        $array = array(
-            'exception' => get_class($exception),
-            'message'   => $exception->getMessage(),
-            'stack'     => $exception->getTraceAsString(),
-        );
-
-        $array['previous'] = self::getExceptionData($exception->getPrevious());
-
-        return $array;
-    }
-
-    public static function logExceptionToDisk(
-        Throwable $exception,
-        SiteConfiguration $siteConfiguration,
-        bool $fromGlobalHandler = false
-    ): array {
-        $errorData = self::getExceptionData($exception);
-        $errorData['server'] = $_SERVER;
-        $errorData['get'] = $_GET;
-        $errorData['post'] = $_POST;
-
-        $redactions = ['password', 'newpassword', 'newpasswordconfirm', 'otp'];
-        foreach ($redactions as $redaction) {
-            if (isset($errorData['post'][$redaction])) {
-                $errorData['post'][$redaction] = '<redacted>';
-            }
-        }
-
-        if ($fromGlobalHandler) {
-            $errorData['globalHandler'] = true;
-        }
-        else {
-            $errorData['globalHandler'] = false;
-        }
-
-        $state = serialize($errorData);
-        $errorId = sha1($state);
-
-        // Save the error for later analysis
-        file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);
-
-        return array($errorData, $errorId);
-    }
+		list($errorData, $errorId) = self::logExceptionToDisk($exception, $siteConfiguration, true);
+
+		// clear and discard any content that's been saved to the output buffer
+		if (ob_get_level() > 0) {
+			ob_end_clean();
+		}
+
+		// push error ID into the document.
+		$message = str_replace('$1$', $errorId, $errorDocument);
+
+		if ($siteConfiguration->getDebuggingTraceEnabled()) {
+			ob_start();
+			var_dump($errorData);
+			$textErrorData = ob_get_contents();
+			ob_end_clean();
+
+			$message = str_replace('$2$', $textErrorData, $message);
+		}
+		else {
+			$message = str_replace('$2$', "", $message);
+		}
+
+		// While we *shouldn't* have sent headers by now due to the output buffering, PHPUnit does weird things.
+		// This is "only" needed for the tests, but it's a good idea to wrap this anyway.
+		if (!headers_sent()) {
+			header('HTTP/1.1 500 Internal Server Error');
+		}
+
+		// output the document
+		print $message;
+	}
+
+	/**
+	 * @param int    $errorSeverity The severity level of the exception.
+	 * @param string $errorMessage  The Exception message to throw.
+	 * @param string $errorFile     The filename where the exception is thrown.
+	 * @param int    $errorLine     The line number where the exception is thrown.
+	 *
+	 * @throws ErrorException
+	 */
+	public static function errorHandler($errorSeverity, $errorMessage, $errorFile, $errorLine)
+	{
+		// call into the main exception handler above
+		throw new ErrorException($errorMessage, 0, $errorSeverity, $errorFile, $errorLine);
+	}
+
+	/**
+	 * @param Throwable $exception
+	 *
+	 * @return null|array
+	 */
+	public static function getExceptionData($exception)
+	{
+		if ($exception == null) {
+			return null;
+		}
+
+		$array = array(
+			'exception' => get_class($exception),
+			'message'   => $exception->getMessage(),
+			'stack'     => $exception->getTraceAsString(),
+		);
+
+		$array['previous'] = self::getExceptionData($exception->getPrevious());
+
+		return $array;
+	}
+
+	public static function logExceptionToDisk(
+		Throwable $exception,
+		SiteConfiguration $siteConfiguration,
+		bool $fromGlobalHandler = false
+	): array {
+		$errorData = self::getExceptionData($exception);
+		$errorData['server'] = $_SERVER;
+		$errorData['get'] = $_GET;
+		$errorData['post'] = $_POST;
+
+		$redactions = ['password', 'newpassword', 'newpasswordconfirm', 'otp'];
+		foreach ($redactions as $redaction) {
+			if (isset($errorData['post'][$redaction])) {
+				$errorData['post'][$redaction] = '<redacted>';
+			}
+		}
+
+		if ($fromGlobalHandler) {
+			$errorData['globalHandler'] = true;
+		}
+		else {
+			$errorData['globalHandler'] = false;
+		}
+
+		$state = serialize($errorData);
+		$errorId = sha1($state);
+
+		// Save the error for later analysis
+		file_put_contents($siteConfiguration->getErrorLog() . '/' . $errorId . '.log', $state);
+
+		return array($errorData, $errorId);
+	}
 }

Braces +2 added lines, -4 removed lines

@@ -65,8 +65,7 @@ 
             ob_end_clean();
 
             $message = str_replace('$2$', $textErrorData, $message);
-        }
-        else {
+        } else {
             $message = str_replace('$2$', "", $message);
         }
 
@@ -135,8 +134,7 @@ 
 
         if ($fromGlobalHandler) {
             $errorData['globalHandler'] = true;
-        }
-        else {
+        } else {
             $errorData['globalHandler'] = false;
         }
 

includes/Fragments/NavigationMenuAccessControl.php

Indentation +95 added lines, -95 removed lines

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

Spacing +2 added lines, -2 removed lines

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

Braces +2 added lines, -1 removed lines

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

includes/PdoDatabase.php

Braces +1 added lines, -2 removed lines

@@ -97,8 +97,7 @@
         // all over the rest of the code
         if ($this->hasActiveTransaction) {
             return false;
-        }
-        else {
+        } else {
             $accessMode = 'READ WRITE';
 
             switch ($isolationLevel) {

Indentation +120 added lines, -120 removed lines

@@ -15,124 +15,124 @@
 
 class PdoDatabase extends PDO
 {
-    public const ISOLATION_SERIALIZABLE = 'SERIALIZABLE';
-    public const ISOLATION_READ_COMMITTED = 'READ COMMITTED';
-    public const ISOLATION_READ_ONLY = 'READ ONLY';
-
-    private static PdoDatabase $connection;
-    /**
-     * @var bool True if a transaction is active
-     */
-    protected bool $hasActiveTransaction = false;
-
-    /**
-     * Unless you're doing low-level work, this is not the function you want.
-     *
-     * @throws Exception
-     */
-    public static function getDatabaseConnection(SiteConfiguration $configuration): PdoDatabase
-    {
-        if (!isset(self::$connection)) {
-            $dbConfig = $configuration->getDatabaseConfig();
-
-            try {
-                $databaseObject = new PdoDatabase(
-                    $dbConfig['datasource'],
-                    $dbConfig['username'],
-                    $dbConfig['password'],
-                    [PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4 COLLATE utf8mb4_unicode_520_ci']
-                );
-            }
-            catch (PDOException $ex) {
-                // wrap around any potential stack traces which may include passwords
-                throw new EnvironmentException('Error connecting to database: ' . $ex->getMessage());
-            }
-
-            $databaseObject->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
-
-            // emulating prepared statements gives a performance boost on MySQL.
-            //
-            // however, our version of PDO doesn't seem to understand parameter types when emulating
-            // the prepared statements, so we're forced to turn this off for now.
-            // -- stw 2014-02-11
-            //
-            // and that's not the only problem with emulated prepares. We've now got code that relies
-            // on real prepares.
-            // -- stw 2023-09-30
-            $databaseObject->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
-
-            // Set the default transaction mode
-            $databaseObject->exec("SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED;");
-
-            self::$connection = $databaseObject;
-        }
-
-        return self::$connection;
-    }
-
-    /**
-     * Determines if this connection has a transaction in progress or not
-     * @return boolean true if there is a transaction in progress.
-     */
-    public function hasActiveTransaction(): bool
-    {
-        return $this->hasActiveTransaction;
-    }
-
-    public function beginTransaction(string $isolationLevel = self::ISOLATION_READ_COMMITTED): bool
-    {
-        // Override the pre-existing method, which doesn't stop you from
-        // starting transactions within transactions - which doesn't work and
-        // will throw an exception. This eliminates the need to catch exceptions
-        // all over the rest of the code
-        if ($this->hasActiveTransaction) {
-            return false;
-        }
-        else {
-            $accessMode = 'READ WRITE';
-
-            switch ($isolationLevel) {
-                case self::ISOLATION_SERIALIZABLE:
-                case self::ISOLATION_READ_COMMITTED:
-                    break;
-                case self::ISOLATION_READ_ONLY:
-                    $isolationLevel = self::ISOLATION_READ_COMMITTED;
-                    $accessMode = 'READ ONLY';
-                    break;
-                default:
-                    throw new Exception("Invalid transaction isolation level");
-            }
-
-            // set the transaction isolation level for every transaction.
-            // string substitution is safe here; values can only be one of the above constants
-            parent::exec("SET TRANSACTION ISOLATION LEVEL ${isolationLevel}, ${accessMode};");
-
-            // start a new transaction, and return whether the start was successful
-            $this->hasActiveTransaction = parent::beginTransaction();
-
-            return $this->hasActiveTransaction;
-        }
-    }
-
-    /**
-     * Commits the active transaction
-     */
-    public function commit(): void
-    {
-        if ($this->hasActiveTransaction) {
-            parent::commit();
-            $this->hasActiveTransaction = false;
-        }
-    }
-
-    /**
-     * Rolls back a transaction
-     */
-    public function rollBack(): void
-    {
-        if ($this->hasActiveTransaction) {
-            parent::rollback();
-            $this->hasActiveTransaction = false;
-        }
-    }
+	public const ISOLATION_SERIALIZABLE = 'SERIALIZABLE';
+	public const ISOLATION_READ_COMMITTED = 'READ COMMITTED';
+	public const ISOLATION_READ_ONLY = 'READ ONLY';
+
+	private static PdoDatabase $connection;
+	/**
+	 * @var bool True if a transaction is active
+	 */
+	protected bool $hasActiveTransaction = false;
+
+	/**
+	 * Unless you're doing low-level work, this is not the function you want.
+	 *
+	 * @throws Exception
+	 */
+	public static function getDatabaseConnection(SiteConfiguration $configuration): PdoDatabase
+	{
+		if (!isset(self::$connection)) {
+			$dbConfig = $configuration->getDatabaseConfig();
+
+			try {
+				$databaseObject = new PdoDatabase(
+					$dbConfig['datasource'],
+					$dbConfig['username'],
+					$dbConfig['password'],
+					[PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4 COLLATE utf8mb4_unicode_520_ci']
+				);
+			}
+			catch (PDOException $ex) {
+				// wrap around any potential stack traces which may include passwords
+				throw new EnvironmentException('Error connecting to database: ' . $ex->getMessage());
+			}
+
+			$databaseObject->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
+
+			// emulating prepared statements gives a performance boost on MySQL.
+			//
+			// however, our version of PDO doesn't seem to understand parameter types when emulating
+			// the prepared statements, so we're forced to turn this off for now.
+			// -- stw 2014-02-11
+			//
+			// and that's not the only problem with emulated prepares. We've now got code that relies
+			// on real prepares.
+			// -- stw 2023-09-30
+			$databaseObject->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
+
+			// Set the default transaction mode
+			$databaseObject->exec("SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED;");
+
+			self::$connection = $databaseObject;
+		}
+
+		return self::$connection;
+	}
+
+	/**
+	 * Determines if this connection has a transaction in progress or not
+	 * @return boolean true if there is a transaction in progress.
+	 */
+	public function hasActiveTransaction(): bool
+	{
+		return $this->hasActiveTransaction;
+	}
+
+	public function beginTransaction(string $isolationLevel = self::ISOLATION_READ_COMMITTED): bool
+	{
+		// Override the pre-existing method, which doesn't stop you from
+		// starting transactions within transactions - which doesn't work and
+		// will throw an exception. This eliminates the need to catch exceptions
+		// all over the rest of the code
+		if ($this->hasActiveTransaction) {
+			return false;
+		}
+		else {
+			$accessMode = 'READ WRITE';
+
+			switch ($isolationLevel) {
+				case self::ISOLATION_SERIALIZABLE:
+				case self::ISOLATION_READ_COMMITTED:
+					break;
+				case self::ISOLATION_READ_ONLY:
+					$isolationLevel = self::ISOLATION_READ_COMMITTED;
+					$accessMode = 'READ ONLY';
+					break;
+				default:
+					throw new Exception("Invalid transaction isolation level");
+			}
+
+			// set the transaction isolation level for every transaction.
+			// string substitution is safe here; values can only be one of the above constants
+			parent::exec("SET TRANSACTION ISOLATION LEVEL ${isolationLevel}, ${accessMode};");
+
+			// start a new transaction, and return whether the start was successful
+			$this->hasActiveTransaction = parent::beginTransaction();
+
+			return $this->hasActiveTransaction;
+		}
+	}
+
+	/**
+	 * Commits the active transaction
+	 */
+	public function commit(): void
+	{
+		if ($this->hasActiveTransaction) {
+			parent::commit();
+			$this->hasActiveTransaction = false;
+		}
+	}
+
+	/**
+	 * Rolls back a transaction
+	 */
+	public function rollBack(): void
+	{
+		if ($this->hasActiveTransaction) {
+			parent::rollback();
+			$this->hasActiveTransaction = false;
+		}
+	}
 }