enwikipedia-acc / waca

includes/Tasks/InternalPageBase.php

Indentation +221 added lines, -221 removed lines

@@ -22,225 +22,225 @@
 
 abstract class InternalPageBase extends PageBase
 {
-    use NavigationMenuAccessControl;
-
-    /** @var IdentificationVerifier */
-    private $identificationVerifier;
-    /** @var ITypeAheadHelper */
-    private $typeAheadHelper;
-    /** @var SecurityManager */
-    private $securityManager;
-    /** @var IBlacklistHelper */
-    private $blacklistHelper;
-
-    /**
-     * @return ITypeAheadHelper
-     */
-    public function getTypeAheadHelper()
-    {
-        return $this->typeAheadHelper;
-    }
-
-    /**
-     * Sets up the internal IdentificationVerifier instance.  Intended to be called from WebStart::setupHelpers().
-     *
-     * @param IdentificationVerifier $identificationVerifier
-     *
-     * @return void
-     */
-    public function setIdentificationVerifier(IdentificationVerifier $identificationVerifier)
-    {
-        $this->identificationVerifier = $identificationVerifier;
-    }
-
-    /**
-     * @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();
-
-        $this->assign('typeAheadBlock', $this->getTypeAheadHelper()->getTypeAheadScriptBlock());
-
-        $database = $this->getDatabase();
-
-        $currentUser = User::getCurrent($database);
-        if (!$currentUser->isCommunityUser()) {
-            $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 IdentificationVerifier */
+	private $identificationVerifier;
+	/** @var ITypeAheadHelper */
+	private $typeAheadHelper;
+	/** @var SecurityManager */
+	private $securityManager;
+	/** @var IBlacklistHelper */
+	private $blacklistHelper;
+
+	/**
+	 * @return ITypeAheadHelper
+	 */
+	public function getTypeAheadHelper()
+	{
+		return $this->typeAheadHelper;
+	}
+
+	/**
+	 * Sets up the internal IdentificationVerifier instance.  Intended to be called from WebStart::setupHelpers().
+	 *
+	 * @param IdentificationVerifier $identificationVerifier
+	 *
+	 * @return void
+	 */
+	public function setIdentificationVerifier(IdentificationVerifier $identificationVerifier)
+	{
+		$this->identificationVerifier = $identificationVerifier;
+	}
+
+	/**
+	 * @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();
+
+		$this->assign('typeAheadBlock', $this->getTypeAheadHelper()->getTypeAheadScriptBlock());
+
+		$database = $this->getDatabase();
+
+		$currentUser = User::getCurrent($database);
+		if (!$currentUser->isCommunityUser()) {
+			$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;
+	}
 }

includes/Exceptions/NotIdentifiedException.php

Indentation +41 added lines, -41 removed lines

@@ -15,52 +15,52 @@
 
 class NotIdentifiedException extends ReadableException
 {
-    use NavigationMenuAccessControl;
-    /**
-     * @var SecurityManager
-     */
-    private $securityManager;
+	use NavigationMenuAccessControl;
+	/**
+	 * @var SecurityManager
+	 */
+	private $securityManager;
 
-    /**
-     * NotIdentifiedException constructor.
-     *
-     * @param SecurityManager $securityManager
-     */
-    public function __construct(SecurityManager $securityManager = null)
-    {
-        $this->securityManager = $securityManager;
-    }
+	/**
+	 * NotIdentifiedException constructor.
+	 *
+	 * @param SecurityManager $securityManager
+	 */
+	public function __construct(SecurityManager $securityManager = null)
+	{
+		$this->securityManager = $securityManager;
+	}
 
-    /**
-     * Returns a readable HTML error message that's displayable to the user using templates.
-     * @return string
-     */
-    public function getReadableError()
-    {
-        if (!headers_sent()) {
-            header("HTTP/1.1 403 Forbidden");
-        }
+	/**
+	 * Returns a readable HTML error message that's displayable to the user using templates.
+	 * @return string
+	 */
+	public function getReadableError()
+	{
+		if (!headers_sent()) {
+			header("HTTP/1.1 403 Forbidden");
+		}
 
-        $this->setUpSmarty();
+		$this->setUpSmarty();
 
-        // uck. We should still be able to access the database in this situation though.
-        $database = PdoDatabase::getDatabaseConnection('acc');
-        $currentUser = User::getCurrent($database);
-        $this->assign('currentUser', $currentUser);
-        $this->assign("loggedIn", (!$currentUser->isCommunityUser()));
+		// uck. We should still be able to access the database in this situation though.
+		$database = PdoDatabase::getDatabaseConnection('acc');
+		$currentUser = User::getCurrent($database);
+		$this->assign('currentUser', $currentUser);
+		$this->assign("loggedIn", (!$currentUser->isCommunityUser()));
 
-        if($this->securityManager !== null) {
-            $this->setupNavMenuAccess($currentUser);
-        }
+		if($this->securityManager !== null) {
+			$this->setupNavMenuAccess($currentUser);
+		}
 
-        return $this->fetchTemplate("exception/not-identified.tpl");
-    }
+		return $this->fetchTemplate("exception/not-identified.tpl");
+	}
 
-    /**
-     * @return SecurityManager
-     */
-    protected function getSecurityManager()
-    {
-        return $this->securityManager;
-    }
+	/**
+	 * @return SecurityManager
+	 */
+	protected function getSecurityManager()
+	{
+		return $this->securityManager;
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
         $this->assign('currentUser', $currentUser);
         $this->assign("loggedIn", (!$currentUser->isCommunityUser()));
 
-        if($this->securityManager !== null) {
+        if ($this->securityManager !== null) {
             $this->setupNavMenuAccess($currentUser);
         }
 

includes/ConsoleTasks/MigrateToRoles.php

Indentation +41 added lines, -41 removed lines

@@ -16,55 +16,55 @@
 
 class MigrateToRoles extends ConsoleTaskBase
 {
-    public function execute()
-    {
-        $communityUser = User::getCommunity();
+	public function execute()
+	{
+		$communityUser = User::getCommunity();
 
-        $database = $this->getDatabase();
-        $statement = $database->query('SELECT id, status, checkuser FROM user;');
-        $update = $database->prepare("UPDATE user SET status = 'Active' WHERE id = :id;");
+		$database = $this->getDatabase();
+		$statement = $database->query('SELECT id, status, checkuser FROM user;');
+		$update = $database->prepare("UPDATE user SET status = 'Active' WHERE id = :id;");
 
-        $users = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$users = $statement->fetchAll(PDO::FETCH_ASSOC);
 
-        foreach ($users as $user) {
-            $toAdd = array('user');
+		foreach ($users as $user) {
+			$toAdd = array('user');
 
-            if($user['status'] === 'Admin'){
-                $toAdd[] = 'admin';
-            }
+			if($user['status'] === 'Admin'){
+				$toAdd[] = 'admin';
+			}
 
-            if($user['checkuser'] == 1){
-                $toAdd[] = 'checkuser';
-            }
+			if($user['checkuser'] == 1){
+				$toAdd[] = 'checkuser';
+			}
 
-            foreach ($toAdd as $x) {
-                $a = new UserRole();
-                $a->setUser($user['id']);
-                $a->setRole($x);
-                $a->setDatabase($database);
-                $a->save();
-            }
+			foreach ($toAdd as $x) {
+				$a = new UserRole();
+				$a->setUser($user['id']);
+				$a->setRole($x);
+				$a->setDatabase($database);
+				$a->save();
+			}
 
-            $logData = serialize(array(
-                'added' => $toAdd,
-                'removed' => array(),
-                'reason' => 'Initial migration'
-            ));
+			$logData = serialize(array(
+				'added' => $toAdd,
+				'removed' => array(),
+				'reason' => 'Initial migration'
+			));
 
-            $log = new Log();
-            $log->setDatabase($database);
-            $log->setAction('RoleChange');
-            $log->setObjectId($user['id']);
-            $log->setObjectType('User');
-            $log->setUser($communityUser);
-            $log->setComment($logData);
-            $log->save();
+			$log = new Log();
+			$log->setDatabase($database);
+			$log->setAction('RoleChange');
+			$log->setObjectId($user['id']);
+			$log->setObjectType('User');
+			$log->setUser($communityUser);
+			$log->setComment($logData);
+			$log->save();
 
-            if($user['status'] === 'Admin' || $user['status'] === 'User'){
-                $update->execute(array('id' => $user['id']));
-            }
-        }
+			if($user['status'] === 'Admin' || $user['status'] === 'User'){
+				$update->execute(array('id' => $user['id']));
+			}
+		}
 
-        $database->exec("UPDATE schemaversion SET version = 25;");
-    }
+		$database->exec("UPDATE schemaversion SET version = 25;");
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -29,11 +29,11 @@ 
         foreach ($users as $user) {
             $toAdd = array('user');
 
-            if($user['status'] === 'Admin'){
+            if ($user['status'] === 'Admin') {
                 $toAdd[] = 'admin';
             }
 
-            if($user['checkuser'] == 1){
+            if ($user['checkuser'] == 1) {
                 $toAdd[] = 'checkuser';
             }
 
@@ -60,7 +60,7 @@ 
             $log->setComment($logData);
             $log->save();
 
-            if($user['status'] === 'Admin' || $user['status'] === 'User'){
+            if ($user['status'] === 'Admin' || $user['status'] === 'User') {
                 $update->execute(array('id' => $user['id']));
             }
         }

Braces +3 added lines, -3 removed lines

@@ -29,11 +29,11 @@ 
         foreach ($users as $user) {
             $toAdd = array('user');
 
-            if($user['status'] === 'Admin'){
+            if($user['status'] === 'Admin') {
                 $toAdd[] = 'admin';
             }
 
-            if($user['checkuser'] == 1){
+            if($user['checkuser'] == 1) {
                 $toAdd[] = 'checkuser';
             }
 
@@ -60,7 +60,7 @@ 
             $log->setComment($logData);
             $log->save();
 
-            if($user['status'] === 'Admin' || $user['status'] === 'User'){
+            if($user['status'] === 'Admin' || $user['status'] === 'User') {
                 $update->execute(array('id' => $user['id']));
             }
         }

includes/DataObjects/UserRole.php

Indentation +79 added lines, -79 removed lines

@@ -15,95 +15,95 @@
 
 class UserRole extends DataObject
 {
-    /** @var int */
-    private $user;
-    /** @var string */
-    private $role;
+	/** @var int */
+	private $user;
+	/** @var string */
+	private $role;
 
-    /**
-     * @param int         $userId
-     * @param PdoDatabase $database
-     *
-     * @return UserRole[]
-     */
-    public static function getForUser($userId, PdoDatabase $database)
-    {
-        $sql = 'SELECT * FROM userrole WHERE user = :user';
-        $statement = $database->prepare($sql);
-        $statement->bindValue(':user', $userId);
+	/**
+	 * @param int         $userId
+	 * @param PdoDatabase $database
+	 *
+	 * @return UserRole[]
+	 */
+	public static function getForUser($userId, PdoDatabase $database)
+	{
+		$sql = 'SELECT * FROM userrole WHERE user = :user';
+		$statement = $database->prepare($sql);
+		$statement->bindValue(':user', $userId);
 
-        $statement->execute();
+		$statement->execute();
 
-        $result = array();
+		$result = array();
 
-        /** @var Ban $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
+		/** @var Ban $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     *
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare('INSERT INTO `userrole` (user, role) VALUES (:user, :role);'
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":role", $this->role);
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 *
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare('INSERT INTO `userrole` (user, role) VALUES (:user, :role);'
+			);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":role", $this->role);
 
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            throw new Exception('Updating roles is not available');
-        }
-    }
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			throw new Exception('Updating roles is not available');
+		}
+	}
 
-    #region Properties
+	#region Properties
 
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
 
-    /**
-     * @param int $user
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-    }
+	/**
+	 * @param int $user
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+	}
 
-    /**
-     * @return string
-     */
-    public function getRole()
-    {
-        return $this->role;
-    }
+	/**
+	 * @return string
+	 */
+	public function getRole()
+	{
+		return $this->role;
+	}
 
-    /**
-     * @param string $role
-     */
-    public function setRole($role)
-    {
-        $this->role = $role;
-    }
-    #endregion
+	/**
+	 * @param string $role
+	 */
+	public function setRole($role)
+	{
+		$this->role = $role;
+	}
+	#endregion
 }

includes/DataObjects/Comment.php

Indentation +157 added lines, -157 removed lines

@@ -20,172 +20,172 @@
  */
 class Comment extends DataObject
 {
-    private $time;
-    private $user;
-    private $comment;
-    private $visibility = "user";
-    private $request;
-
-    /**
-     * Retrieves all comments for a request, optionally filtered
-     *
-     * @param integer     $id      Request ID to search by
-     * @param PdoDatabase $database
-     * @param bool        $showAll True to show all comments, False to show only unprotected comments, and protected
-     *                             comments visible to $userId
-     * @param null|int    $userId  User to filter by
-     *
-     * @return Comment[]
-     */
-    public static function getForRequest($id, PdoDatabase $database, $showAll = false, $userId = null)
-    {
-        if ($showAll) {
-            $statement = $database->prepare('SELECT * FROM comment WHERE request = :target;');
-        }
-        else {
-            $statement = $database->prepare(<<<SQL
+	private $time;
+	private $user;
+	private $comment;
+	private $visibility = "user";
+	private $request;
+
+	/**
+	 * Retrieves all comments for a request, optionally filtered
+	 *
+	 * @param integer     $id      Request ID to search by
+	 * @param PdoDatabase $database
+	 * @param bool        $showAll True to show all comments, False to show only unprotected comments, and protected
+	 *                             comments visible to $userId
+	 * @param null|int    $userId  User to filter by
+	 *
+	 * @return Comment[]
+	 */
+	public static function getForRequest($id, PdoDatabase $database, $showAll = false, $userId = null)
+	{
+		if ($showAll) {
+			$statement = $database->prepare('SELECT * FROM comment WHERE request = :target;');
+		}
+		else {
+			$statement = $database->prepare(<<<SQL
 SELECT * FROM comment
 WHERE request = :target AND (visibility = 'user' OR user = :userid);
 SQL
-            );
-            $statement->bindValue(':userid', $userId);
-        }
-
-        $statement->bindValue(':target', $id);
-
-        $statement->execute();
-
-        $result = array();
-        /** @var Comment $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
-
-        return $result;
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(':userid', $userId);
+		}
+
+		$statement->bindValue(':target', $id);
+
+		$statement->execute();
+
+		$result = array();
+		/** @var Comment $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 INSERT INTO comment ( time, user, comment, visibility, request )
 VALUES ( CURRENT_TIMESTAMP(), :user, :comment, :visibility, :request );
 SQL
-            );
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":comment", $this->comment);
-            $statement->bindValue(":visibility", $this->visibility);
-            $statement->bindValue(":request", $this->request);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":comment", $this->comment);
+			$statement->bindValue(":visibility", $this->visibility);
+			$statement->bindValue(":request", $this->request);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
 UPDATE comment
 SET comment = :comment, visibility = :visibility, updateversion = updateversion + 1
 WHERE id = :id AND updateversion = :updateversion
 LIMIT 1;
 SQL
-            );
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':comment', $this->comment);
-            $statement->bindValue(':visibility', $this->visibility);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * @return DateTimeImmutable
-     */
-    public function getTime()
-    {
-        return new DateTimeImmutable($this->time);
-    }
-
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return string
-     */
-    public function getComment()
-    {
-        return $this->comment;
-    }
-
-    /**
-     * @param string $comment
-     */
-    public function setComment($comment)
-    {
-        $this->comment = $comment;
-    }
-
-    /**
-     * @return string
-     */
-    public function getVisibility()
-    {
-        return $this->visibility;
-    }
-
-    /**
-     * @param string $visibility
-     */
-    public function setVisibility($visibility)
-    {
-        $this->visibility = $visibility;
-    }
-
-    /**
-     * @return int
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @param int $request
-     */
-    public function setRequest($request)
-    {
-        $this->request = $request;
-    }
+			);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(':comment', $this->comment);
+			$statement->bindValue(':visibility', $this->visibility);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * @return DateTimeImmutable
+	 */
+	public function getTime()
+	{
+		return new DateTimeImmutable($this->time);
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getComment()
+	{
+		return $this->comment;
+	}
+
+	/**
+	 * @param string $comment
+	 */
+	public function setComment($comment)
+	{
+		$this->comment = $comment;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getVisibility()
+	{
+		return $this->visibility;
+	}
+
+	/**
+	 * @param string $visibility
+	 */
+	public function setVisibility($visibility)
+	{
+		$this->visibility = $visibility;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @param int $request
+	 */
+	public function setRequest($request)
+	{
+		$this->request = $request;
+	}
 }

includes/Helpers/IrcNotificationHelper.php

Indentation +449 added lines, -449 removed lines

@@ -26,455 +26,455 @@
  */
 class IrcNotificationHelper
 {
-    /** @var PdoDatabase $notificationsDatabase */
-    private $notificationsDatabase;
-    /** @var PdoDatabase $primaryDatabase */
-    private $primaryDatabase;
-    /** @var bool $notificationsEnabled */
-    private $notificationsEnabled;
-    /** @var int $notificationType */
-    private $notificationType;
-    /** @var User $currentUser */
-    private $currentUser;
-    /** @var string $instanceName */
-    private $instanceName;
-    /** @var string */
-    private $baseUrl;
-    /** @var array */
-    private $requestStates;
-
-    /**
-     * IrcNotificationHelper constructor.
-     *
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $primaryDatabase
-     * @param PdoDatabase       $notificationsDatabase
-     */
-    public function __construct(
-        SiteConfiguration $siteConfiguration,
-        PdoDatabase $primaryDatabase,
-        PdoDatabase $notificationsDatabase = null
-    ) {
-        $this->primaryDatabase = $primaryDatabase;
-
-        if ($this->notificationsDatabase !== null) {
-            $this->notificationsDatabase = $notificationsDatabase;
-            $this->notificationsEnabled = $siteConfiguration->getIrcNotificationsEnabled();
-        }
-        else {
-            $this->notificationsEnabled = false;
-        }
-
-        $this->notificationType = $siteConfiguration->getIrcNotificationType();
-        $this->instanceName = $siteConfiguration->getIrcNotificationsInstance();
-        $this->baseUrl = $siteConfiguration->getBaseUrl();
-        $this->requestStates = $siteConfiguration->getRequestStates();
-
-        $this->currentUser = User::getCurrent($primaryDatabase);
-    }
-
-    /**
-     * Send a notification
-     *
-     * @param string $message The text to send
-     */
-    protected function send($message)
-    {
-        $instanceName = $this->instanceName;
-
-        if (!$this->notificationsEnabled) {
-            return;
-        }
-
-        $blacklist = array("DCC", "CCTP", "PRIVMSG");
-        $message = str_replace($blacklist, "(IRC Blacklist)", $message); // Lets stop DCC etc
-
-        $msg = IrcColourCode::RESET . IrcColourCode::BOLD . "[$instanceName]" . IrcColourCode::RESET . ": $message";
-
-        try {
-            $notification = new Notification();
-            $notification->setDatabase($this->notificationsDatabase);
-            $notification->setType($this->notificationType);
-            $notification->setText($msg);
-
-            $notification->save();
-        }
-        catch (Exception $ex) {
-            // OK, so we failed to send the notification - that db might be down?
-            // This is non-critical, so silently fail.
-
-            // Disable notifications for remainder of request.
-            $this->notificationsEnabled = false;
-        }
-    }
-
-    #region user management
-
-    /**
-     * send a new user notification
-     *
-     * @param User $user
-     */
-    public function userNew(User $user)
-    {
-        $this->send("New user: {$user->getUsername()}");
-    }
-
-    /**
-     * send an approved notification
-     *
-     * @param User $user
-     */
-    public function userApproved(User $user)
-    {
-        $this->send("{$user->getUsername()} approved by " . $this->currentUser->getUsername());
-    }
-
-    /**
-     * send a promoted notification
-     *
-     * @param User $user
-     */
-    public function userPromoted(User $user)
-    {
-        $this->send("{$user->getUsername()} promoted to tool admin by " . $this->currentUser->getUsername());
-    }
-
-    /**
-     * send a declined notification
-     *
-     * @param User   $user
-     * @param string $reason the reason the user was declined
-     */
-    public function userDeclined(User $user, $reason)
-    {
-        $this->send("{$user->getUsername()} declined by " . $this->currentUser->getUsername() . " ($reason)");
-    }
-
-    /**
-     * send a demotion notification
-     *
-     * @param User   $user
-     * @param string $reason the reason the user was demoted
-     */
-    public function userDemoted(User $user, $reason)
-    {
-        $this->send("{$user->getUsername()} demoted by " . $this->currentUser->getUsername() . " ($reason)");
-    }
-
-    /**
-     * send a suspended notification
-     *
-     * @param User   $user
-     * @param string $reason The reason the user has been suspended
-     */
-    public function userSuspended(User $user, $reason)
-    {
-        $this->send("{$user->getUsername()} suspended by " . $this->currentUser->getUsername() . " ($reason)");
-    }
-
-    /**
-     * Send a preference change notification
-     *
-     * @param User $user
-     */
-    public function userPrefChange(User $user)
-    {
-        $this->send("{$user->getUsername()}'s preferences were changed by " . $this->currentUser->getUsername());
-    }
-
-    /**
-     * Send a user renamed notification
-     *
-     * @param User   $user
-     * @param string $old
-     */
-    public function userRenamed(User $user, $old)
-    {
-        $this->send($this->currentUser->getUsername() . " renamed $old to {$user->getUsername()}");
-    }
-
-    /**
-     * @param User   $user
-     * @param string $reason
-     */
-    public function userRolesEdited(User $user, $reason)
-    {
-        $currentUser = $this->currentUser->getUsername();
-        $this->send("Active roles for {$user->getUsername()} changed by " . $currentUser . " ($reason)");
-    }
-
-    #endregion
-
-    #region Site Notice
-
-    /**
-     * Summary of siteNoticeEdited
-     */
-    public function siteNoticeEdited()
-    {
-        $this->send("Site notice edited by " . $this->currentUser->getUsername());
-    }
-    #endregion
-
-    #region Welcome Templates
-    /**
-     * Summary of welcomeTemplateCreated
-     *
-     * @param WelcomeTemplate $template
-     */
-    public function welcomeTemplateCreated(WelcomeTemplate $template)
-    {
-        $this->send("Welcome template {$template->getId()} created by " . $this->currentUser->getUsername());
-    }
-
-    /**
-     * Summary of welcomeTemplateDeleted
-     *
-     * @param int $templateid
-     */
-    public function welcomeTemplateDeleted($templateid)
-    {
-        $this->send("Welcome template {$templateid} deleted by " . $this->currentUser->getUsername());
-    }
-
-    /**
-     * Summary of welcomeTemplateEdited
-     *
-     * @param WelcomeTemplate $template
-     */
-    public function welcomeTemplateEdited(WelcomeTemplate $template)
-    {
-        $this->send("Welcome template {$template->getId()} edited by " . $this->currentUser->getUsername());
-    }
-
-    #endregion
-
-    #region bans
-    /**
-     * Summary of banned
-     *
-     * @param Ban $ban
-     */
-    public function banned(Ban $ban)
-    {
-        if ($ban->getDuration() == -1) {
-            $duration = "indefinitely";
-        }
-        else {
-            $duration = "until " . date("F j, Y, g:i a", $ban->getDuration());
-        }
-
-        $username = $this->currentUser->getUsername();
-
-        $this->send("{$ban->getTarget()} banned by {$username} for '{$ban->getReason()}' {$duration}");
-    }
-
-    /**
-     * Summary of unbanned
-     *
-     * @param Ban    $ban
-     * @param string $unbanreason
-     */
-    public function unbanned(Ban $ban, $unbanreason)
-    {
-        $this->send($ban->getTarget() . " unbanned by " . $this->currentUser
-                ->getUsername() . " (" . $unbanreason . ")");
-    }
-
-    #endregion
-
-    #region request management
-
-    /**
-     * Summary of requestReceived
-     *
-     * @param Request $request
-     */
-    public function requestReceived(Request $request)
-    {
-        $this->send(
-            IrcColourCode::DARK_GREY . "[["
-            . IrcColourCode::DARK_GREEN . "acc:"
-            . IrcColourCode::ORANGE . $request->getId()
-            . IrcColourCode::DARK_GREY . "]]"
-            . IrcColourCode::RED . " N "
-            . IrcColourCode::DARK_BLUE . $this->baseUrl . "/internal.php/viewRequest?id={$request->getId()} "
-            . IrcColourCode::DARK_RED . "* "
-            . IrcColourCode::DARK_GREEN . $request->getName()
-            . IrcColourCode::DARK_RED . " * "
-            . IrcColourCode::RESET
-        );
-    }
-
-    /**
-     * Summary of requestDeferred
-     *
-     * @param Request $request
-     */
-    public function requestDeferred(Request $request)
-    {
-        $availableRequestStates = $this->requestStates;
-
-        $deferTo = $availableRequestStates[$request->getStatus()]['deferto'];
-        $username = $this->currentUser->getUsername();
-
-        $this->send("Request {$request->getId()} ({$request->getName()}) deferred to {$deferTo} by {$username}");
-    }
-
-    /**
-     *
-     * Summary of requestDeferredWithMail
-     *
-     * @param Request $request
-     */
-    public function requestDeferredWithMail(Request $request)
-    {
-        $availableRequestStates = $this->requestStates;
-
-        $deferTo = $availableRequestStates[$request->getStatus()]['deferto'];
-        $username = $this->currentUser->getUsername();
-        $id = $request->getId();
-        $name = $request->getName();
-
-        $this->send("Request {$id} ({$name}) deferred to {$deferTo} with an email by {$username}");
-    }
-
-    /**
-     * Summary of requestClosed
-     *
-     * @param Request $request
-     * @param string  $closetype
-     */
-    public function requestClosed(Request $request, $closetype)
-    {
-        $username = $this->currentUser->getUsername();
-
-        $this->send("Request {$request->getId()} ({$request->getName()}) closed ($closetype) by {$username}");
-    }
-
-    /**
-     * Summary of sentMail
-     *
-     * @param Request $request
-     */
-    public function sentMail(Request $request)
-    {
-        $this->send($this->currentUser->getUsername()
-            . " sent an email related to Request {$request->getId()} ({$request->getName()})");
-    }
-
-    #endregion
-
-    #region reservations
-
-    /**
-     * Summary of requestReserved
-     *
-     * @param Request $request
-     */
-    public function requestReserved(Request $request)
-    {
-        $username = $this->currentUser->getUsername();
-
-        $this->send("Request {$request->getId()} ({$request->getName()}) reserved by {$username}");
-    }
-
-    /**
-     * Summary of requestReserveBroken
-     *
-     * @param Request $request
-     */
-    public function requestReserveBroken(Request $request)
-    {
-        $username = $this->currentUser->getUsername();
-
-        $this->send("Reservation on request {$request->getId()} ({$request->getName()}) broken by {$username}");
-    }
-
-    /**
-     * Summary of requestUnreserved
-     *
-     * @param Request $request
-     */
-    public function requestUnreserved(Request $request)
-    {
-        $this->send("Request {$request->getId()} ({$request->getName()}) is no longer being handled.");
-    }
-
-    /**
-     * Summary of requestReservationSent
-     *
-     * @param Request $request
-     * @param User    $target
-     */
-    public function requestReservationSent(Request $request, User $target)
-    {
-        $username = $this->currentUser->getUsername();
-
-        $this->send(
-            "Reservation of request {$request->getId()} ({$request->getName()}) sent to {$target->getUsername()} by "
-            . $username);
-    }
-
-    #endregion
-
-    #region comments
-
-    /**
-     * Summary of commentCreated
-     *
-     * @param Comment $comment
-     * @param Request $request
-     */
-    public function commentCreated(Comment $comment, Request $request)
-    {
-        $username = $this->currentUser->getUsername();
-        $visibility = ($comment->getVisibility() == "admin" ? "private " : "");
-
-        $this->send("{$username} posted a {$visibility}comment on request {$request->getId()} ({$request->getName()})");
-    }
-
-    /**
-     * Summary of commentEdited
-     *
-     * @param Comment $comment
-     * @param Request $request
-     */
-    public function commentEdited(Comment $comment, Request $request)
-    {
-        $username = $this->currentUser->getUsername();
-
-        $this->send(<<<TAG
+	/** @var PdoDatabase $notificationsDatabase */
+	private $notificationsDatabase;
+	/** @var PdoDatabase $primaryDatabase */
+	private $primaryDatabase;
+	/** @var bool $notificationsEnabled */
+	private $notificationsEnabled;
+	/** @var int $notificationType */
+	private $notificationType;
+	/** @var User $currentUser */
+	private $currentUser;
+	/** @var string $instanceName */
+	private $instanceName;
+	/** @var string */
+	private $baseUrl;
+	/** @var array */
+	private $requestStates;
+
+	/**
+	 * IrcNotificationHelper constructor.
+	 *
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $primaryDatabase
+	 * @param PdoDatabase       $notificationsDatabase
+	 */
+	public function __construct(
+		SiteConfiguration $siteConfiguration,
+		PdoDatabase $primaryDatabase,
+		PdoDatabase $notificationsDatabase = null
+	) {
+		$this->primaryDatabase = $primaryDatabase;
+
+		if ($this->notificationsDatabase !== null) {
+			$this->notificationsDatabase = $notificationsDatabase;
+			$this->notificationsEnabled = $siteConfiguration->getIrcNotificationsEnabled();
+		}
+		else {
+			$this->notificationsEnabled = false;
+		}
+
+		$this->notificationType = $siteConfiguration->getIrcNotificationType();
+		$this->instanceName = $siteConfiguration->getIrcNotificationsInstance();
+		$this->baseUrl = $siteConfiguration->getBaseUrl();
+		$this->requestStates = $siteConfiguration->getRequestStates();
+
+		$this->currentUser = User::getCurrent($primaryDatabase);
+	}
+
+	/**
+	 * Send a notification
+	 *
+	 * @param string $message The text to send
+	 */
+	protected function send($message)
+	{
+		$instanceName = $this->instanceName;
+
+		if (!$this->notificationsEnabled) {
+			return;
+		}
+
+		$blacklist = array("DCC", "CCTP", "PRIVMSG");
+		$message = str_replace($blacklist, "(IRC Blacklist)", $message); // Lets stop DCC etc
+
+		$msg = IrcColourCode::RESET . IrcColourCode::BOLD . "[$instanceName]" . IrcColourCode::RESET . ": $message";
+
+		try {
+			$notification = new Notification();
+			$notification->setDatabase($this->notificationsDatabase);
+			$notification->setType($this->notificationType);
+			$notification->setText($msg);
+
+			$notification->save();
+		}
+		catch (Exception $ex) {
+			// OK, so we failed to send the notification - that db might be down?
+			// This is non-critical, so silently fail.
+
+			// Disable notifications for remainder of request.
+			$this->notificationsEnabled = false;
+		}
+	}
+
+	#region user management
+
+	/**
+	 * send a new user notification
+	 *
+	 * @param User $user
+	 */
+	public function userNew(User $user)
+	{
+		$this->send("New user: {$user->getUsername()}");
+	}
+
+	/**
+	 * send an approved notification
+	 *
+	 * @param User $user
+	 */
+	public function userApproved(User $user)
+	{
+		$this->send("{$user->getUsername()} approved by " . $this->currentUser->getUsername());
+	}
+
+	/**
+	 * send a promoted notification
+	 *
+	 * @param User $user
+	 */
+	public function userPromoted(User $user)
+	{
+		$this->send("{$user->getUsername()} promoted to tool admin by " . $this->currentUser->getUsername());
+	}
+
+	/**
+	 * send a declined notification
+	 *
+	 * @param User   $user
+	 * @param string $reason the reason the user was declined
+	 */
+	public function userDeclined(User $user, $reason)
+	{
+		$this->send("{$user->getUsername()} declined by " . $this->currentUser->getUsername() . " ($reason)");
+	}
+
+	/**
+	 * send a demotion notification
+	 *
+	 * @param User   $user
+	 * @param string $reason the reason the user was demoted
+	 */
+	public function userDemoted(User $user, $reason)
+	{
+		$this->send("{$user->getUsername()} demoted by " . $this->currentUser->getUsername() . " ($reason)");
+	}
+
+	/**
+	 * send a suspended notification
+	 *
+	 * @param User   $user
+	 * @param string $reason The reason the user has been suspended
+	 */
+	public function userSuspended(User $user, $reason)
+	{
+		$this->send("{$user->getUsername()} suspended by " . $this->currentUser->getUsername() . " ($reason)");
+	}
+
+	/**
+	 * Send a preference change notification
+	 *
+	 * @param User $user
+	 */
+	public function userPrefChange(User $user)
+	{
+		$this->send("{$user->getUsername()}'s preferences were changed by " . $this->currentUser->getUsername());
+	}
+
+	/**
+	 * Send a user renamed notification
+	 *
+	 * @param User   $user
+	 * @param string $old
+	 */
+	public function userRenamed(User $user, $old)
+	{
+		$this->send($this->currentUser->getUsername() . " renamed $old to {$user->getUsername()}");
+	}
+
+	/**
+	 * @param User   $user
+	 * @param string $reason
+	 */
+	public function userRolesEdited(User $user, $reason)
+	{
+		$currentUser = $this->currentUser->getUsername();
+		$this->send("Active roles for {$user->getUsername()} changed by " . $currentUser . " ($reason)");
+	}
+
+	#endregion
+
+	#region Site Notice
+
+	/**
+	 * Summary of siteNoticeEdited
+	 */
+	public function siteNoticeEdited()
+	{
+		$this->send("Site notice edited by " . $this->currentUser->getUsername());
+	}
+	#endregion
+
+	#region Welcome Templates
+	/**
+	 * Summary of welcomeTemplateCreated
+	 *
+	 * @param WelcomeTemplate $template
+	 */
+	public function welcomeTemplateCreated(WelcomeTemplate $template)
+	{
+		$this->send("Welcome template {$template->getId()} created by " . $this->currentUser->getUsername());
+	}
+
+	/**
+	 * Summary of welcomeTemplateDeleted
+	 *
+	 * @param int $templateid
+	 */
+	public function welcomeTemplateDeleted($templateid)
+	{
+		$this->send("Welcome template {$templateid} deleted by " . $this->currentUser->getUsername());
+	}
+
+	/**
+	 * Summary of welcomeTemplateEdited
+	 *
+	 * @param WelcomeTemplate $template
+	 */
+	public function welcomeTemplateEdited(WelcomeTemplate $template)
+	{
+		$this->send("Welcome template {$template->getId()} edited by " . $this->currentUser->getUsername());
+	}
+
+	#endregion
+
+	#region bans
+	/**
+	 * Summary of banned
+	 *
+	 * @param Ban $ban
+	 */
+	public function banned(Ban $ban)
+	{
+		if ($ban->getDuration() == -1) {
+			$duration = "indefinitely";
+		}
+		else {
+			$duration = "until " . date("F j, Y, g:i a", $ban->getDuration());
+		}
+
+		$username = $this->currentUser->getUsername();
+
+		$this->send("{$ban->getTarget()} banned by {$username} for '{$ban->getReason()}' {$duration}");
+	}
+
+	/**
+	 * Summary of unbanned
+	 *
+	 * @param Ban    $ban
+	 * @param string $unbanreason
+	 */
+	public function unbanned(Ban $ban, $unbanreason)
+	{
+		$this->send($ban->getTarget() . " unbanned by " . $this->currentUser
+				->getUsername() . " (" . $unbanreason . ")");
+	}
+
+	#endregion
+
+	#region request management
+
+	/**
+	 * Summary of requestReceived
+	 *
+	 * @param Request $request
+	 */
+	public function requestReceived(Request $request)
+	{
+		$this->send(
+			IrcColourCode::DARK_GREY . "[["
+			. IrcColourCode::DARK_GREEN . "acc:"
+			. IrcColourCode::ORANGE . $request->getId()
+			. IrcColourCode::DARK_GREY . "]]"
+			. IrcColourCode::RED . " N "
+			. IrcColourCode::DARK_BLUE . $this->baseUrl . "/internal.php/viewRequest?id={$request->getId()} "
+			. IrcColourCode::DARK_RED . "* "
+			. IrcColourCode::DARK_GREEN . $request->getName()
+			. IrcColourCode::DARK_RED . " * "
+			. IrcColourCode::RESET
+		);
+	}
+
+	/**
+	 * Summary of requestDeferred
+	 *
+	 * @param Request $request
+	 */
+	public function requestDeferred(Request $request)
+	{
+		$availableRequestStates = $this->requestStates;
+
+		$deferTo = $availableRequestStates[$request->getStatus()]['deferto'];
+		$username = $this->currentUser->getUsername();
+
+		$this->send("Request {$request->getId()} ({$request->getName()}) deferred to {$deferTo} by {$username}");
+	}
+
+	/**
+	 *
+	 * Summary of requestDeferredWithMail
+	 *
+	 * @param Request $request
+	 */
+	public function requestDeferredWithMail(Request $request)
+	{
+		$availableRequestStates = $this->requestStates;
+
+		$deferTo = $availableRequestStates[$request->getStatus()]['deferto'];
+		$username = $this->currentUser->getUsername();
+		$id = $request->getId();
+		$name = $request->getName();
+
+		$this->send("Request {$id} ({$name}) deferred to {$deferTo} with an email by {$username}");
+	}
+
+	/**
+	 * Summary of requestClosed
+	 *
+	 * @param Request $request
+	 * @param string  $closetype
+	 */
+	public function requestClosed(Request $request, $closetype)
+	{
+		$username = $this->currentUser->getUsername();
+
+		$this->send("Request {$request->getId()} ({$request->getName()}) closed ($closetype) by {$username}");
+	}
+
+	/**
+	 * Summary of sentMail
+	 *
+	 * @param Request $request
+	 */
+	public function sentMail(Request $request)
+	{
+		$this->send($this->currentUser->getUsername()
+			. " sent an email related to Request {$request->getId()} ({$request->getName()})");
+	}
+
+	#endregion
+
+	#region reservations
+
+	/**
+	 * Summary of requestReserved
+	 *
+	 * @param Request $request
+	 */
+	public function requestReserved(Request $request)
+	{
+		$username = $this->currentUser->getUsername();
+
+		$this->send("Request {$request->getId()} ({$request->getName()}) reserved by {$username}");
+	}
+
+	/**
+	 * Summary of requestReserveBroken
+	 *
+	 * @param Request $request
+	 */
+	public function requestReserveBroken(Request $request)
+	{
+		$username = $this->currentUser->getUsername();
+
+		$this->send("Reservation on request {$request->getId()} ({$request->getName()}) broken by {$username}");
+	}
+
+	/**
+	 * Summary of requestUnreserved
+	 *
+	 * @param Request $request
+	 */
+	public function requestUnreserved(Request $request)
+	{
+		$this->send("Request {$request->getId()} ({$request->getName()}) is no longer being handled.");
+	}
+
+	/**
+	 * Summary of requestReservationSent
+	 *
+	 * @param Request $request
+	 * @param User    $target
+	 */
+	public function requestReservationSent(Request $request, User $target)
+	{
+		$username = $this->currentUser->getUsername();
+
+		$this->send(
+			"Reservation of request {$request->getId()} ({$request->getName()}) sent to {$target->getUsername()} by "
+			. $username);
+	}
+
+	#endregion
+
+	#region comments
+
+	/**
+	 * Summary of commentCreated
+	 *
+	 * @param Comment $comment
+	 * @param Request $request
+	 */
+	public function commentCreated(Comment $comment, Request $request)
+	{
+		$username = $this->currentUser->getUsername();
+		$visibility = ($comment->getVisibility() == "admin" ? "private " : "");
+
+		$this->send("{$username} posted a {$visibility}comment on request {$request->getId()} ({$request->getName()})");
+	}
+
+	/**
+	 * Summary of commentEdited
+	 *
+	 * @param Comment $comment
+	 * @param Request $request
+	 */
+	public function commentEdited(Comment $comment, Request $request)
+	{
+		$username = $this->currentUser->getUsername();
+
+		$this->send(<<<TAG
 Comment {$comment->getId()} on request {$request->getId()} ({$request->getName()}) edited by {$username}
 TAG
-        );
-    }
-
-    #endregion
-
-    #region email management (close reasons)
-
-    /**
-     * Summary of emailCreated
-     *
-     * @param EmailTemplate $template
-     */
-    public function emailCreated(EmailTemplate $template)
-    {
-        $username = $this->currentUser->getUsername();
-        $this->send("Email {$template->getId()} ({$template->getName()}) created by " . $username);
-    }
-
-    /**
-     * Summary of emailEdited
-     *
-     * @param EmailTemplate $template
-     */
-    public function emailEdited(EmailTemplate $template)
-    {
-        $username = $this->currentUser->getUsername();
-        $this->send("Email {$template->getId()} ({$template->getName()}) edited by " . $username);
-    }
-    #endregion
+		);
+	}
+
+	#endregion
+
+	#region email management (close reasons)
+
+	/**
+	 * Summary of emailCreated
+	 *
+	 * @param EmailTemplate $template
+	 */
+	public function emailCreated(EmailTemplate $template)
+	{
+		$username = $this->currentUser->getUsername();
+		$this->send("Email {$template->getId()} ({$template->getName()}) created by " . $username);
+	}
+
+	/**
+	 * Summary of emailEdited
+	 *
+	 * @param EmailTemplate $template
+	 */
+	public function emailEdited(EmailTemplate $template)
+	{
+		$username = $this->currentUser->getUsername();
+		$this->send("Email {$template->getId()} ({$template->getName()}) edited by " . $username);
+	}
+	#endregion
 }

Spacing +27 added lines, -27 removed lines

@@ -89,7 +89,7 @@ 
         $blacklist = array("DCC", "CCTP", "PRIVMSG");
         $message = str_replace($blacklist, "(IRC Blacklist)", $message); // Lets stop DCC etc
 
-        $msg = IrcColourCode::RESET . IrcColourCode::BOLD . "[$instanceName]" . IrcColourCode::RESET . ": $message";
+        $msg = IrcColourCode::RESET.IrcColourCode::BOLD."[$instanceName]".IrcColourCode::RESET.": $message";
 
         try {
             $notification = new Notification();
@@ -127,7 +127,7 @@ 
      */
     public function userApproved(User $user)
     {
-        $this->send("{$user->getUsername()} approved by " . $this->currentUser->getUsername());
+        $this->send("{$user->getUsername()} approved by ".$this->currentUser->getUsername());
     }
 
     /**
@@ -137,7 +137,7 @@ 
      */
     public function userPromoted(User $user)
     {
-        $this->send("{$user->getUsername()} promoted to tool admin by " . $this->currentUser->getUsername());
+        $this->send("{$user->getUsername()} promoted to tool admin by ".$this->currentUser->getUsername());
     }
 
     /**
@@ -148,7 +148,7 @@ 
      */
     public function userDeclined(User $user, $reason)
     {
-        $this->send("{$user->getUsername()} declined by " . $this->currentUser->getUsername() . " ($reason)");
+        $this->send("{$user->getUsername()} declined by ".$this->currentUser->getUsername()." ($reason)");
     }
 
     /**
@@ -159,7 +159,7 @@ 
      */
     public function userDemoted(User $user, $reason)
     {
-        $this->send("{$user->getUsername()} demoted by " . $this->currentUser->getUsername() . " ($reason)");
+        $this->send("{$user->getUsername()} demoted by ".$this->currentUser->getUsername()." ($reason)");
     }
 
     /**
@@ -170,7 +170,7 @@ 
      */
     public function userSuspended(User $user, $reason)
     {
-        $this->send("{$user->getUsername()} suspended by " . $this->currentUser->getUsername() . " ($reason)");
+        $this->send("{$user->getUsername()} suspended by ".$this->currentUser->getUsername()." ($reason)");
     }
 
     /**
@@ -180,7 +180,7 @@ 
      */
     public function userPrefChange(User $user)
     {
-        $this->send("{$user->getUsername()}'s preferences were changed by " . $this->currentUser->getUsername());
+        $this->send("{$user->getUsername()}'s preferences were changed by ".$this->currentUser->getUsername());
     }
 
     /**
@@ -191,7 +191,7 @@ 
      */
     public function userRenamed(User $user, $old)
     {
-        $this->send($this->currentUser->getUsername() . " renamed $old to {$user->getUsername()}");
+        $this->send($this->currentUser->getUsername()." renamed $old to {$user->getUsername()}");
     }
 
     /**
@@ -201,7 +201,7 @@ 
     public function userRolesEdited(User $user, $reason)
     {
         $currentUser = $this->currentUser->getUsername();
-        $this->send("Active roles for {$user->getUsername()} changed by " . $currentUser . " ($reason)");
+        $this->send("Active roles for {$user->getUsername()} changed by ".$currentUser." ($reason)");
     }
 
     #endregion
@@ -213,7 +213,7 @@ 
      */
     public function siteNoticeEdited()
     {
-        $this->send("Site notice edited by " . $this->currentUser->getUsername());
+        $this->send("Site notice edited by ".$this->currentUser->getUsername());
     }
     #endregion
 
@@ -225,7 +225,7 @@ 
      */
     public function welcomeTemplateCreated(WelcomeTemplate $template)
     {
-        $this->send("Welcome template {$template->getId()} created by " . $this->currentUser->getUsername());
+        $this->send("Welcome template {$template->getId()} created by ".$this->currentUser->getUsername());
     }
 
     /**
@@ -235,7 +235,7 @@ 
      */
     public function welcomeTemplateDeleted($templateid)
     {
-        $this->send("Welcome template {$templateid} deleted by " . $this->currentUser->getUsername());
+        $this->send("Welcome template {$templateid} deleted by ".$this->currentUser->getUsername());
     }
 
     /**
@@ -245,7 +245,7 @@ 
      */
     public function welcomeTemplateEdited(WelcomeTemplate $template)
     {
-        $this->send("Welcome template {$template->getId()} edited by " . $this->currentUser->getUsername());
+        $this->send("Welcome template {$template->getId()} edited by ".$this->currentUser->getUsername());
     }
 
     #endregion
@@ -262,7 +262,7 @@ 
             $duration = "indefinitely";
         }
         else {
-            $duration = "until " . date("F j, Y, g:i a", $ban->getDuration());
+            $duration = "until ".date("F j, Y, g:i a", $ban->getDuration());
         }
 
         $username = $this->currentUser->getUsername();
@@ -278,8 +278,8 @@ 
      */
     public function unbanned(Ban $ban, $unbanreason)
     {
-        $this->send($ban->getTarget() . " unbanned by " . $this->currentUser
-                ->getUsername() . " (" . $unbanreason . ")");
+        $this->send($ban->getTarget()." unbanned by ".$this->currentUser
+                ->getUsername()." (".$unbanreason.")");
     }
 
     #endregion
@@ -294,15 +294,15 @@ 
     public function requestReceived(Request $request)
     {
         $this->send(
-            IrcColourCode::DARK_GREY . "[["
-            . IrcColourCode::DARK_GREEN . "acc:"
-            . IrcColourCode::ORANGE . $request->getId()
-            . IrcColourCode::DARK_GREY . "]]"
-            . IrcColourCode::RED . " N "
-            . IrcColourCode::DARK_BLUE . $this->baseUrl . "/internal.php/viewRequest?id={$request->getId()} "
-            . IrcColourCode::DARK_RED . "* "
-            . IrcColourCode::DARK_GREEN . $request->getName()
-            . IrcColourCode::DARK_RED . " * "
+            IrcColourCode::DARK_GREY."[["
+            . IrcColourCode::DARK_GREEN."acc:"
+            . IrcColourCode::ORANGE.$request->getId()
+            . IrcColourCode::DARK_GREY."]]"
+            . IrcColourCode::RED." N "
+            . IrcColourCode::DARK_BLUE.$this->baseUrl."/internal.php/viewRequest?id={$request->getId()} "
+            . IrcColourCode::DARK_RED."* "
+            . IrcColourCode::DARK_GREEN.$request->getName()
+            . IrcColourCode::DARK_RED." * "
             . IrcColourCode::RESET
         );
     }
@@ -463,7 +463,7 @@ 
     public function emailCreated(EmailTemplate $template)
     {
         $username = $this->currentUser->getUsername();
-        $this->send("Email {$template->getId()} ({$template->getName()}) created by " . $username);
+        $this->send("Email {$template->getId()} ({$template->getName()}) created by ".$username);
     }
 
     /**
@@ -474,7 +474,7 @@ 
     public function emailEdited(EmailTemplate $template)
     {
         $username = $this->currentUser->getUsername();
-        $this->send("Email {$template->getId()} ({$template->getName()}) edited by " . $username);
+        $this->send("Email {$template->getId()} ({$template->getName()}) edited by ".$username);
     }
     #endregion
 }

includes/Pages/Statistics/StatsTopCreators.php

Indentation +33 added lines, -33 removed lines

@@ -13,12 +13,12 @@ 
 
 class StatsTopCreators extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Top Creators :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Top Creators :: Statistics');
 
-        // Retrieve all-time stats
-        $queryAllTime = <<<SQL
+		// Retrieve all-time stats
+		$queryAllTime = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/queryAllTime */
     COUNT(*) count,
@@ -35,8 +35,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve all-time stats for active users only
-        $queryAllTimeActive = <<<SQL
+		// Retrieve all-time stats for active users only
+		$queryAllTimeActive = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/queryAllTimeActive */
     COUNT(*) count,
@@ -53,8 +53,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve today's stats (so far)
-        $queryToday = <<<SQL
+		// Retrieve today's stats (so far)
+		$queryToday = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5out */
     COUNT(*) count,
@@ -70,8 +70,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve Yesterday's stats
-        $queryYesterday = <<<SQL
+		// Retrieve Yesterday's stats
+		$queryYesterday = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5yout */
     COUNT(*) count,
@@ -87,8 +87,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve last 7 days
-        $queryLast7Days = <<<SQL
+		// Retrieve last 7 days
+		$queryLast7Days = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5wout */
     COUNT(*) count,
@@ -104,8 +104,8 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Retrieve last month's stats
-        $queryLast28Days = <<<SQL
+		// Retrieve last month's stats
+		$queryLast28Days = <<<SQL
 SELECT
 	/* StatsTopCreators::execute()/top5mout */
     COUNT(*) count,
@@ -121,24 +121,24 @@ 
 ORDER BY COUNT(*) DESC;
 SQL;
 
-        // Put it all together
-        $queries = array(
-            'queryAllTime'       => $queryAllTime,
-            'queryAllTimeActive' => $queryAllTimeActive,
-            'queryToday'         => $queryToday,
-            'queryYesterday'     => $queryYesterday,
-            'queryLast7Days'     => $queryLast7Days,
-            'queryLast28Days'    => $queryLast28Days,
-        );
+		// Put it all together
+		$queries = array(
+			'queryAllTime'       => $queryAllTime,
+			'queryAllTimeActive' => $queryAllTimeActive,
+			'queryToday'         => $queryToday,
+			'queryYesterday'     => $queryYesterday,
+			'queryLast7Days'     => $queryLast7Days,
+			'queryLast28Days'    => $queryLast28Days,
+		);
 
-        $database = $this->getDatabase();
-        foreach ($queries as $name => $sql) {
-            $statement = $database->query($sql);
-            $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-            $this->assign($name, $data);
-        }
+		$database = $this->getDatabase();
+		foreach ($queries as $name => $sql) {
+			$statement = $database->query($sql);
+			$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+			$this->assign($name, $data);
+		}
 
-        $this->assign('statsPageTitle', 'Top Account Creators');
-        $this->setTemplate('statistics/top-creators.tpl');
-    }
+		$this->assign('statsPageTitle', 'Top Account Creators');
+		$this->setTemplate('statistics/top-creators.tpl');
+	}
 }

includes/Pages/Statistics/StatsInactiveUsers.php

Indentation +25 added lines, -25 removed lines

@@ -17,31 +17,31 @@
 
 class StatsInactiveUsers extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Inactive Users :: Statistics');
-
-        $date = new DateTime();
-        $date->modify("-45 days");
-
-        $inactiveUsers = UserSearchHelper::get($this->getDatabase())
-            ->byStatus('Active')
-            ->lastActiveBefore($date)
-            ->getRoleMap($roleMap)
-            ->fetch();
-
-        $this->assign('inactiveUsers', $inactiveUsers);
-        $this->assign('roles', $roleMap);
-        $this->assign('canSuspend',
-            $this->barrierTest('suspend', User::getCurrent($this->getDatabase()), PageUserManagement::class));
-
-        $immuneUsers = $this->getDatabase()
-            ->query("SELECT user FROM userrole WHERE role IN ('toolRoot', 'checkuser') GROUP BY user;")
-            ->fetchAll(PDO::FETCH_COLUMN);
+	public function main()
+	{
+		$this->setHtmlTitle('Inactive Users :: Statistics');
+
+		$date = new DateTime();
+		$date->modify("-45 days");
+
+		$inactiveUsers = UserSearchHelper::get($this->getDatabase())
+			->byStatus('Active')
+			->lastActiveBefore($date)
+			->getRoleMap($roleMap)
+			->fetch();
+
+		$this->assign('inactiveUsers', $inactiveUsers);
+		$this->assign('roles', $roleMap);
+		$this->assign('canSuspend',
+			$this->barrierTest('suspend', User::getCurrent($this->getDatabase()), PageUserManagement::class));
+
+		$immuneUsers = $this->getDatabase()
+			->query("SELECT user FROM userrole WHERE role IN ('toolRoot', 'checkuser') GROUP BY user;")
+			->fetchAll(PDO::FETCH_COLUMN);
         
-        $this->assign('immune', array_fill_keys($immuneUsers, true));
+		$this->assign('immune', array_fill_keys($immuneUsers, true));
 
-        $this->setTemplate('statistics/inactive-users.tpl');
-        $this->assign('statsPageTitle', 'Inactive tool users');
-    }
+		$this->setTemplate('statistics/inactive-users.tpl');
+		$this->assign('statsPageTitle', 'Inactive tool users');
+	}
 }

includes/Pages/Statistics/StatsMonthlyStats.php

Indentation +11 added lines, -11 removed lines

@@ -13,11 +13,11 @@ 
 
 class StatsMonthlyStats extends InternalPageBase
 {
-    public function main()
-    {
-        $this->setHtmlTitle('Monthly Stats :: Statistics');
+	public function main()
+	{
+		$this->setHtmlTitle('Monthly Stats :: Statistics');
 
-        $query = <<<SQL
+		$query = <<<SQL
 SELECT
     COUNT(DISTINCT id) AS closed,
     YEAR(timestamp) AS year,
@@ -28,12 +28,12 @@ 
 ORDER BY YEAR(timestamp) , MONTH(timestamp) ASC;
 SQL;
 
-        $database = $this->getDatabase();
-        $statement = $database->query($query);
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$database = $this->getDatabase();
+		$statement = $database->query($query);
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
 
-        $this->assign('dataTable', $data);
-        $this->assign('statsPageTitle', 'Monthly Statistics');
-        $this->setTemplate('statistics/monthly-stats.tpl');
-    }
+		$this->assign('dataTable', $data);
+		$this->assign('statsPageTitle', 'Monthly Statistics');
+		$this->setTemplate('statistics/monthly-stats.tpl');
+	}
 }