mdaniels5757 / waca

includes/WebStart.php

Indentation +209 added lines, -209 removed lines

@@ -35,213 +35,213 @@
  */
 class WebStart extends ApplicationBase
 {
-    /**
-     * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different
-     *                                    routers and hence different URL mappings
-     */
-    private $requestRouter;
-    /**
-     * @var bool $isPublic Determines whether to use public interface objects or internal interface objects
-     */
-    private bool $isPublic = false;
-
-    /**
-     * WebStart constructor.
-     *
-     * @param SiteConfiguration $configuration The site configuration
-     * @param IRequestRouter    $router        The request router to use
-     */
-    public function __construct(SiteConfiguration $configuration, IRequestRouter $router)
-    {
-        parent::__construct($configuration);
-
-        $this->requestRouter = $router;
-    }
-
-    /**
-     * @param ITask             $page
-     * @param SiteConfiguration $siteConfiguration
-     * @param PdoDatabase       $database
-     *
-     * @return void
-     */
-    protected function setupHelpers(
-        ITask $page,
-        SiteConfiguration $siteConfiguration,
-        PdoDatabase $database
-    ) {
-        parent::setupHelpers($page, $siteConfiguration, $database);
-
-        if ($page instanceof PageBase) {
-            $page->setTokenManager(new TokenManager());
-            $page->setCspManager(new ContentSecurityPolicyManager($siteConfiguration));
-
-            if ($page instanceof InternalPageBase) {
-                $page->setTypeAheadHelper(new TypeAheadHelper());
-
-                $httpHelper = $page->getHttpHelper();
-
-                $userAccessLoader = new UserAccessLoader();
-                $domainAccessManager = new DomainAccessManager($userAccessLoader);
-
-                $identificationVerifier = new IdentificationVerifier($httpHelper, $siteConfiguration, $database);
-
-                $page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration(), $userAccessLoader));
-                $page->setDomainAccessManager($domainAccessManager);
-
-                if ($siteConfiguration->getTitleBlacklistEnabled()) {
-                    $page->setBlacklistHelper(new BlacklistHelper($httpHelper, $database, $siteConfiguration));
-                }
-                else {
-                    $page->setBlacklistHelper(new FakeBlacklistHelper());
-                }
-            }
-        }
-    }
-
-    /**
-     * Application entry point.
-     *
-     * Sets up the environment and runs the application, performing any global cleanup operations when done.
-     */
-    public function run()
-    {
-        try {
-            if ($this->setupEnvironment()) {
-                $this->main();
-            }
-        }
-        catch (EnvironmentException $ex) {
-            ob_end_clean();
-            print Offline::getOfflineMessage($this->isPublic(), $this->getConfiguration(), $ex->getMessage());
-        }
-            /** @noinspection PhpRedundantCatchClauseInspection */
-        catch (ReadableException $ex) {
-            ob_end_clean();
-            print $ex->getReadableError();
-        }
-        finally {
-            $this->cleanupEnvironment();
-        }
-    }
-
-    /**
-     * Environment setup
-     *
-     * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
-     * and shut down prematurely.
-     *
-     * @return bool
-     * @throws EnvironmentException
-     */
-    protected function setupEnvironment()
-    {
-        // initialise global exception handler
-        set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler'));
-        set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR);
-
-        // start output buffering if necessary
-        if (ob_get_level() === 0) {
-            ob_start();
-        }
-
-        // initialise super-global providers
-        WebRequest::setGlobalStateProvider(new GlobalStateProvider());
-
-        if (Offline::isOffline($this->getConfiguration())) {
-            print Offline::getOfflineMessage($this->isPublic(), $this->getConfiguration());
-            ob_end_flush();
-
-            return false;
-        }
-
-        // Call parent setup
-        if (!parent::setupEnvironment()) {
-            return false;
-        }
-
-        // Start up sessions
-        ini_set('session.cookie_path', $this->getConfiguration()->getCookiePath());
-        ini_set('session.name', $this->getConfiguration()->getCookieSessionName());
-        Session::start();
-
-        // Check the user is allowed to be logged in still. This must be before we call any user-loading functions and
-        // get the current user cached.
-        // I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a
-        // session I suppose.
-        $this->checkForceLogout();
-
-        // environment initialised!
-        return true;
-    }
-
-    /**
-     * Main application logic
-     */
-    protected function main()
-    {
-        // Get the right route for the request
-        $page = $this->requestRouter->route();
-
-        $siteConfiguration = $this->getConfiguration();
-        $database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
-
-        $this->setupHelpers($page, $siteConfiguration, $database);
-
-        // run the route code for the request.
-        $page->execute();
-    }
-
-    /**
-     * Any cleanup tasks should go here
-     *
-     * Note that we need to be very careful here, as exceptions may have been thrown and handled.
-     * This should *only* be for cleaning up, no logic should go here.
-     */
-    protected function cleanupEnvironment()
-    {
-        // Clean up anything we splurged after sending the page.
-        if (ob_get_level() > 0) {
-            for ($i = ob_get_level(); $i > 0; $i--) {
-                ob_end_clean();
-            }
-        }
-    }
-
-    private function checkForceLogout()
-    {
-        $database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
-
-        $sessionUserId = WebRequest::getSessionUserId();
-        iF ($sessionUserId === null) {
-            return;
-        }
-
-        // Note, User::getCurrent() caches it's result, which we *really* don't want to trigger.
-        $currentUser = User::getById($sessionUserId, $database);
-
-        if ($currentUser === false) {
-            // Umm... this user has a session cookie with a userId set, but no user exists...
-            Session::restart();
-
-            $currentUser = User::getCurrent($database);
-        }
-
-        if ($currentUser->getForceLogout()) {
-            Session::restart();
-
-            $currentUser->setForceLogout(false);
-            $currentUser->save();
-        }
-    }
-
-    public function isPublic(): bool
-    {
-        return $this->isPublic;
-    }
-
-    public function setPublic(bool $isPublic): void
-    {
-        $this->isPublic = $isPublic;
-    }
+	/**
+	 * @var IRequestRouter $requestRouter The request router to use. Note that different entry points have different
+	 *                                    routers and hence different URL mappings
+	 */
+	private $requestRouter;
+	/**
+	 * @var bool $isPublic Determines whether to use public interface objects or internal interface objects
+	 */
+	private bool $isPublic = false;
+
+	/**
+	 * WebStart constructor.
+	 *
+	 * @param SiteConfiguration $configuration The site configuration
+	 * @param IRequestRouter    $router        The request router to use
+	 */
+	public function __construct(SiteConfiguration $configuration, IRequestRouter $router)
+	{
+		parent::__construct($configuration);
+
+		$this->requestRouter = $router;
+	}
+
+	/**
+	 * @param ITask             $page
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param PdoDatabase       $database
+	 *
+	 * @return void
+	 */
+	protected function setupHelpers(
+		ITask $page,
+		SiteConfiguration $siteConfiguration,
+		PdoDatabase $database
+	) {
+		parent::setupHelpers($page, $siteConfiguration, $database);
+
+		if ($page instanceof PageBase) {
+			$page->setTokenManager(new TokenManager());
+			$page->setCspManager(new ContentSecurityPolicyManager($siteConfiguration));
+
+			if ($page instanceof InternalPageBase) {
+				$page->setTypeAheadHelper(new TypeAheadHelper());
+
+				$httpHelper = $page->getHttpHelper();
+
+				$userAccessLoader = new UserAccessLoader();
+				$domainAccessManager = new DomainAccessManager($userAccessLoader);
+
+				$identificationVerifier = new IdentificationVerifier($httpHelper, $siteConfiguration, $database);
+
+				$page->setSecurityManager(new SecurityManager($identificationVerifier, new RoleConfiguration(), $userAccessLoader));
+				$page->setDomainAccessManager($domainAccessManager);
+
+				if ($siteConfiguration->getTitleBlacklistEnabled()) {
+					$page->setBlacklistHelper(new BlacklistHelper($httpHelper, $database, $siteConfiguration));
+				}
+				else {
+					$page->setBlacklistHelper(new FakeBlacklistHelper());
+				}
+			}
+		}
+	}
+
+	/**
+	 * Application entry point.
+	 *
+	 * Sets up the environment and runs the application, performing any global cleanup operations when done.
+	 */
+	public function run()
+	{
+		try {
+			if ($this->setupEnvironment()) {
+				$this->main();
+			}
+		}
+		catch (EnvironmentException $ex) {
+			ob_end_clean();
+			print Offline::getOfflineMessage($this->isPublic(), $this->getConfiguration(), $ex->getMessage());
+		}
+			/** @noinspection PhpRedundantCatchClauseInspection */
+		catch (ReadableException $ex) {
+			ob_end_clean();
+			print $ex->getReadableError();
+		}
+		finally {
+			$this->cleanupEnvironment();
+		}
+	}
+
+	/**
+	 * Environment setup
+	 *
+	 * This method initialises the tool environment. If the tool cannot be initialised correctly, it will return false
+	 * and shut down prematurely.
+	 *
+	 * @return bool
+	 * @throws EnvironmentException
+	 */
+	protected function setupEnvironment()
+	{
+		// initialise global exception handler
+		set_exception_handler(array(ExceptionHandler::class, 'exceptionHandler'));
+		set_error_handler(array(ExceptionHandler::class, 'errorHandler'), E_RECOVERABLE_ERROR);
+
+		// start output buffering if necessary
+		if (ob_get_level() === 0) {
+			ob_start();
+		}
+
+		// initialise super-global providers
+		WebRequest::setGlobalStateProvider(new GlobalStateProvider());
+
+		if (Offline::isOffline($this->getConfiguration())) {
+			print Offline::getOfflineMessage($this->isPublic(), $this->getConfiguration());
+			ob_end_flush();
+
+			return false;
+		}
+
+		// Call parent setup
+		if (!parent::setupEnvironment()) {
+			return false;
+		}
+
+		// Start up sessions
+		ini_set('session.cookie_path', $this->getConfiguration()->getCookiePath());
+		ini_set('session.name', $this->getConfiguration()->getCookieSessionName());
+		Session::start();
+
+		// Check the user is allowed to be logged in still. This must be before we call any user-loading functions and
+		// get the current user cached.
+		// I'm not sure if this function call being here is particularly a good thing, but it's part of starting up a
+		// session I suppose.
+		$this->checkForceLogout();
+
+		// environment initialised!
+		return true;
+	}
+
+	/**
+	 * Main application logic
+	 */
+	protected function main()
+	{
+		// Get the right route for the request
+		$page = $this->requestRouter->route();
+
+		$siteConfiguration = $this->getConfiguration();
+		$database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
+
+		$this->setupHelpers($page, $siteConfiguration, $database);
+
+		// run the route code for the request.
+		$page->execute();
+	}
+
+	/**
+	 * Any cleanup tasks should go here
+	 *
+	 * Note that we need to be very careful here, as exceptions may have been thrown and handled.
+	 * This should *only* be for cleaning up, no logic should go here.
+	 */
+	protected function cleanupEnvironment()
+	{
+		// Clean up anything we splurged after sending the page.
+		if (ob_get_level() > 0) {
+			for ($i = ob_get_level(); $i > 0; $i--) {
+				ob_end_clean();
+			}
+		}
+	}
+
+	private function checkForceLogout()
+	{
+		$database = PdoDatabase::getDatabaseConnection($this->getConfiguration());
+
+		$sessionUserId = WebRequest::getSessionUserId();
+		iF ($sessionUserId === null) {
+			return;
+		}
+
+		// Note, User::getCurrent() caches it's result, which we *really* don't want to trigger.
+		$currentUser = User::getById($sessionUserId, $database);
+
+		if ($currentUser === false) {
+			// Umm... this user has a session cookie with a userId set, but no user exists...
+			Session::restart();
+
+			$currentUser = User::getCurrent($database);
+		}
+
+		if ($currentUser->getForceLogout()) {
+			Session::restart();
+
+			$currentUser->setForceLogout(false);
+			$currentUser->save();
+		}
+	}
+
+	public function isPublic(): bool
+	{
+		return $this->isPublic;
+	}
+
+	public function setPublic(bool $isPublic): void
+	{
+		$this->isPublic = $isPublic;
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -91,8 +91,7 @@
 
                 if ($siteConfiguration->getTitleBlacklistEnabled()) {
                     $page->setBlacklistHelper(new BlacklistHelper($httpHelper, $database, $siteConfiguration));
-                }
-                else {
+                } else {
                     $page->setBlacklistHelper(new FakeBlacklistHelper());
                 }
             }

includes/Router/ApiRequestRouter.php

Indentation +45 added lines, -45 removed lines

@@ -24,52 +24,52 @@
 
 class ApiRequestRouter implements IRequestRouter
 {
-    /**
-     * @return string[]
-     */
-    public static function getActionList()
-    {
-        return array('count', 'status', 'stats', 'help', 'monitor', 'metrics');
-    }
+	/**
+	 * @return string[]
+	 */
+	public static function getActionList()
+	{
+		return array('count', 'status', 'stats', 'help', 'monitor', 'metrics');
+	}
 
-    /**
-     * @return IRoutedTask
-     * @throws Exception
-     */
-    public function route()
-    {
-        $requestAction = WebRequest::getString('action');
+	/**
+	 * @return IRoutedTask
+	 * @throws Exception
+	 */
+	public function route()
+	{
+		$requestAction = WebRequest::getString('action');
 
-        switch ($requestAction) {
-            case "count":
-                $result = new CountAction();
-                break;
-            case "status":
-                $result = new StatusAction();
-                break;
-            case "stats":
-                $result = new StatsAction();
-                break;
-            case "help":
-                $result = new HelpAction();
-                break;
-            case "monitor":
-                $result = new MonitorAction();
-                break;
-            case "users":
-                $result = new JsUsersAction();
-                break;
-            case "templates":
-                $result = new JsTemplateConfirmsAction();
-                break;
-            case 'metrics':
-                $result = new MetricsAction();
-                break;
-            default:
-                $result = new UnknownAction();
-                break;
-        }
+		switch ($requestAction) {
+			case "count":
+				$result = new CountAction();
+				break;
+			case "status":
+				$result = new StatusAction();
+				break;
+			case "stats":
+				$result = new StatsAction();
+				break;
+			case "help":
+				$result = new HelpAction();
+				break;
+			case "monitor":
+				$result = new MonitorAction();
+				break;
+			case "users":
+				$result = new JsUsersAction();
+				break;
+			case "templates":
+				$result = new JsTemplateConfirmsAction();
+				break;
+			case 'metrics':
+				$result = new MetricsAction();
+				break;
+			default:
+				$result = new UnknownAction();
+				break;
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 }

includes/ConsoleTasks/AutoFlagCommentsTask.php

Indentation +18 added lines, -18 removed lines

@@ -17,11 +17,11 @@ 
 
 class AutoFlagCommentsTask extends ConsoleTaskBase
 {
-    public function execute()
-    {
-        $database = $this->getDatabase();
+	public function execute()
+	{
+		$database = $this->getDatabase();
 
-        $query = $database->prepare(<<<'SQL'
+		$query = $database->prepare(<<<'SQL'
 select c.id, r.domain
 from comment c
 inner join request r on r.id = c.request
@@ -81,22 +81,22 @@ 
 and c.comment not like '%[redacted]%'
 ;
 SQL
-        );
+		);
 
-        $success = $query->execute();
+		$success = $query->execute();
 
-        if (!$success) {
-            throw new Exception('Error in transaction: Could not load data.');
-        }
+		if (!$success) {
+			throw new Exception('Error in transaction: Could not load data.');
+		}
 
-        $data = $query->fetchAll(PDO::FETCH_ASSOC);
-        foreach ($data as $row) {
-            /** @var Comment $dataObject */
-            $dataObject = Comment::getById($row['id'], $database);
+		$data = $query->fetchAll(PDO::FETCH_ASSOC);
+		foreach ($data as $row) {
+			/** @var Comment $dataObject */
+			$dataObject = Comment::getById($row['id'], $database);
 
-            Logger::flaggedComment($database, $dataObject, $row['domain']);
-            $dataObject->setFlagged(true);
-            $dataObject->save();
-        }
-    }
+			Logger::flaggedComment($database, $dataObject, $row['domain']);
+			$dataObject->setFlagged(true);
+			$dataObject->save();
+		}
+	}
 }
\ No newline at end of file

includes/Helpers/PreferenceManager.php

Indentation +186 added lines, -186 removed lines

@@ -18,172 +18,172 @@ 
 
 class PreferenceManager
 {
-    const PREF_WELCOMETEMPLATE = 'welcomeTemplate';
-    const PREF_SKIP_JS_ABORT = 'skipJsAbort';
-    const PREF_EMAIL_SIGNATURE = 'emailSignature';
-    const PREF_CREATION_MODE = 'creationMode';
-    const PREF_SKIN = 'skin';
-    const PREF_DEFAULT_DOMAIN = 'defaultDomain';
-    const PREF_QUEUE_HELP = 'showQueueHelp';
-
-    const ADMIN_PREF_PREVENT_REACTIVATION = 'preventReactivation';
-
-    const CREATION_MANUAL = 0;
-    const CREATION_OAUTH = 1;
-    const CREATION_BOT = 2;
-    /** @var PdoDatabase */
-    private $database;
-    /** @var int */
-    private $user;
-    /** @var ?int */
-    private $domain;
-    /** @var PreferenceManager|null */
-    private static $currentUser = null;
-    private $cachedPreferences = null;
-
-    public function __construct(PdoDatabase $database, int $user, ?int $domain)
-    {
-        $this->database = $database;
-        $this->user = $user;
-        $this->domain = $domain;
-    }
-
-    public static function getForCurrent(PdoDatabase $database): PreferenceManager
-    {
-        if (self::$currentUser === null) {
-            $user = User::getCurrent($database)->getId();
-            $domain = WebRequest::getSessionDomain();
-
-            self::$currentUser = new self($database, $user, $domain);
-        }
-
-        return self::$currentUser;
-    }
-
-    public function setLocalPreference(string $preference, $value): void
-    {
-        if ($this->cachedPreferences === null) {
-            $this->loadPreferences();
-        }
-
-        if ($this->cachedPreferences[$preference]['value'] == $value
-            && $this->cachedPreferences[$preference]['global'] === false) {
-            return;
-        }
-
-        $localPreference = UserPreference::getLocalPreference($this->database, $this->user, $preference, $this->domain);
-        if ($localPreference === false) {
-            $localPreference = new UserPreference();
-            $localPreference->setDatabase($this->database);
-            $localPreference->setDomain($this->domain);
-            $localPreference->setUser($this->user);
-            $localPreference->setPreference($preference);
-        }
-
-        $localPreference->setValue($value);
-        $localPreference->save();
-
-        $this->cachedPreferences[$preference] = [
-            'value'  => $value,
-            'global' => false,
-        ];
-    }
-
-    public function setGlobalPreference(string $preference, $value): void
-    {
-        if ($this->cachedPreferences === null) {
-            $this->loadPreferences();
-        }
-
-        if ($this->cachedPreferences[$preference]['value'] == $value
-            && $this->cachedPreferences[$preference]['global'] === true) {
-            return;
-        }
-
-        $this->deleteLocalPreference($preference);
-
-        $globalPreference = UserPreference::getGlobalPreference($this->database, $this->user, $preference);
-        if ($globalPreference === false) {
-            $globalPreference = new UserPreference();
-            $globalPreference->setDatabase($this->database);
-            $globalPreference->setDomain(null);
-            $globalPreference->setUser($this->user);
-            $globalPreference->setPreference($preference);
-        }
-
-        $globalPreference->setValue($value);
-        $globalPreference->save();
-
-        $this->cachedPreferences[$preference] = [
-            'value'  => $value,
-            'global' => true,
-        ];
-    }
-
-    public function getPreference(string $preference)
-    {
-        if ($this->cachedPreferences === null) {
-            $this->loadPreferences();
-        }
-
-        if (!isset($this->cachedPreferences[$preference])) {
-            return null;
-        }
-
-        return $this->cachedPreferences[$preference]['value'];
-    }
-
-    public function isGlobalPreference(string $preference) : ?bool
-    {
-        if ($this->cachedPreferences === null) {
-            $this->loadPreferences();
-        }
-
-        if (!isset($this->cachedPreferences[$preference])) {
-            return null;
-        }
-
-        return $this->cachedPreferences[$preference]['global'];
-    }
-
-    protected function deleteLocalPreference(string $preference): void
-    {
-        $getStatement = $this->database->prepare('SELECT * FROM userpreference WHERE preference = :preference AND USER = :user AND domain = :domain');
-        $getStatement->execute([
-            ':user'       => $this->user,
-            ':preference' => $preference,
-            ':domain'     => $this->domain
-        ]);
-
-        $localPreference = $getStatement->fetchObject(UserPreference::class);
-        if ($localPreference !== false) {
-            $localPreference->setDatabase($this->database);
-            $localPreference->delete();
-        }
-    }
-
-    protected function loadPreferences(): void
-    {
-        /**
-         * OK, this is a bit of a complicated query.
-         * It's designed to get all the preferences defined for a user in a specified domain, falling back to globally
-         * defined preferences if a local preference isn't set. As such, this query is the *heart* of how global
-         * preferences work.
-         *
-         * Starting with the WHERE, we filter rows:
-         *   a) where the row's domain is the domain we're looking for
-         *   b) where the row's domain is null, thus it's a global setting
-         *   c) if we don't have a domain we're looking for, fall back to global only
-         *
-         * The MAX(...) OVER(...) is a window function, *not* an aggregate. It basically takes the max of all selected
-         * rows' domain columns, grouped by the preference column. Since any number N < null, this highlights all the
-         * correct settings (local has precedence over global) such that prefpart == domain.
-         *
-         * -1 is used to represent null in the COALESCE() calls, since domain.id is an unsigned int hence -1 is an
-         * impossible value
-         */
-        $sql = /** @lang SQL */
-            <<<'EOF'
+	const PREF_WELCOMETEMPLATE = 'welcomeTemplate';
+	const PREF_SKIP_JS_ABORT = 'skipJsAbort';
+	const PREF_EMAIL_SIGNATURE = 'emailSignature';
+	const PREF_CREATION_MODE = 'creationMode';
+	const PREF_SKIN = 'skin';
+	const PREF_DEFAULT_DOMAIN = 'defaultDomain';
+	const PREF_QUEUE_HELP = 'showQueueHelp';
+
+	const ADMIN_PREF_PREVENT_REACTIVATION = 'preventReactivation';
+
+	const CREATION_MANUAL = 0;
+	const CREATION_OAUTH = 1;
+	const CREATION_BOT = 2;
+	/** @var PdoDatabase */
+	private $database;
+	/** @var int */
+	private $user;
+	/** @var ?int */
+	private $domain;
+	/** @var PreferenceManager|null */
+	private static $currentUser = null;
+	private $cachedPreferences = null;
+
+	public function __construct(PdoDatabase $database, int $user, ?int $domain)
+	{
+		$this->database = $database;
+		$this->user = $user;
+		$this->domain = $domain;
+	}
+
+	public static function getForCurrent(PdoDatabase $database): PreferenceManager
+	{
+		if (self::$currentUser === null) {
+			$user = User::getCurrent($database)->getId();
+			$domain = WebRequest::getSessionDomain();
+
+			self::$currentUser = new self($database, $user, $domain);
+		}
+
+		return self::$currentUser;
+	}
+
+	public function setLocalPreference(string $preference, $value): void
+	{
+		if ($this->cachedPreferences === null) {
+			$this->loadPreferences();
+		}
+
+		if ($this->cachedPreferences[$preference]['value'] == $value
+			&& $this->cachedPreferences[$preference]['global'] === false) {
+			return;
+		}
+
+		$localPreference = UserPreference::getLocalPreference($this->database, $this->user, $preference, $this->domain);
+		if ($localPreference === false) {
+			$localPreference = new UserPreference();
+			$localPreference->setDatabase($this->database);
+			$localPreference->setDomain($this->domain);
+			$localPreference->setUser($this->user);
+			$localPreference->setPreference($preference);
+		}
+
+		$localPreference->setValue($value);
+		$localPreference->save();
+
+		$this->cachedPreferences[$preference] = [
+			'value'  => $value,
+			'global' => false,
+		];
+	}
+
+	public function setGlobalPreference(string $preference, $value): void
+	{
+		if ($this->cachedPreferences === null) {
+			$this->loadPreferences();
+		}
+
+		if ($this->cachedPreferences[$preference]['value'] == $value
+			&& $this->cachedPreferences[$preference]['global'] === true) {
+			return;
+		}
+
+		$this->deleteLocalPreference($preference);
+
+		$globalPreference = UserPreference::getGlobalPreference($this->database, $this->user, $preference);
+		if ($globalPreference === false) {
+			$globalPreference = new UserPreference();
+			$globalPreference->setDatabase($this->database);
+			$globalPreference->setDomain(null);
+			$globalPreference->setUser($this->user);
+			$globalPreference->setPreference($preference);
+		}
+
+		$globalPreference->setValue($value);
+		$globalPreference->save();
+
+		$this->cachedPreferences[$preference] = [
+			'value'  => $value,
+			'global' => true,
+		];
+	}
+
+	public function getPreference(string $preference)
+	{
+		if ($this->cachedPreferences === null) {
+			$this->loadPreferences();
+		}
+
+		if (!isset($this->cachedPreferences[$preference])) {
+			return null;
+		}
+
+		return $this->cachedPreferences[$preference]['value'];
+	}
+
+	public function isGlobalPreference(string $preference) : ?bool
+	{
+		if ($this->cachedPreferences === null) {
+			$this->loadPreferences();
+		}
+
+		if (!isset($this->cachedPreferences[$preference])) {
+			return null;
+		}
+
+		return $this->cachedPreferences[$preference]['global'];
+	}
+
+	protected function deleteLocalPreference(string $preference): void
+	{
+		$getStatement = $this->database->prepare('SELECT * FROM userpreference WHERE preference = :preference AND USER = :user AND domain = :domain');
+		$getStatement->execute([
+			':user'       => $this->user,
+			':preference' => $preference,
+			':domain'     => $this->domain
+		]);
+
+		$localPreference = $getStatement->fetchObject(UserPreference::class);
+		if ($localPreference !== false) {
+			$localPreference->setDatabase($this->database);
+			$localPreference->delete();
+		}
+	}
+
+	protected function loadPreferences(): void
+	{
+		/**
+		 * OK, this is a bit of a complicated query.
+		 * It's designed to get all the preferences defined for a user in a specified domain, falling back to globally
+		 * defined preferences if a local preference isn't set. As such, this query is the *heart* of how global
+		 * preferences work.
+		 *
+		 * Starting with the WHERE, we filter rows:
+		 *   a) where the row's domain is the domain we're looking for
+		 *   b) where the row's domain is null, thus it's a global setting
+		 *   c) if we don't have a domain we're looking for, fall back to global only
+		 *
+		 * The MAX(...) OVER(...) is a window function, *not* an aggregate. It basically takes the max of all selected
+		 * rows' domain columns, grouped by the preference column. Since any number N < null, this highlights all the
+		 * correct settings (local has precedence over global) such that prefpart == domain.
+		 *
+		 * -1 is used to represent null in the COALESCE() calls, since domain.id is an unsigned int hence -1 is an
+		 * impossible value
+		 */
+		$sql = /** @lang SQL */
+			<<<'EOF'
 WITH allprefs AS (
     SELECT up.domain, up.preference, MAX(up.domain) OVER (PARTITION BY up.preference) AS prefpart, up.value, CASE WHEN up.domain IS NULL THEN 1 END AS isglobal
     FROM userpreference up
@@ -194,24 +194,24 @@ 
 FROM allprefs p
 WHERE COALESCE(p.prefpart, -1) = COALESCE(p.domain, -1);
 EOF;
-        $statement = $this->database->prepare($sql);
-
-        $statement->execute([
-            ':domain'  => $this->domain,
-            ':domainc' => $this->domain,
-            ':user'    => $this->user,
-        ]);
-
-        $rawPrefs = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $prefs = [];
-
-        foreach ($rawPrefs as $p) {
-            $prefs[$p['preference']] = [
-                'value'  => $p['value'],
-                'global' => $p['isglobal'] == 1,
-            ];
-        }
-
-        $this->cachedPreferences = $prefs;
-    }
+		$statement = $this->database->prepare($sql);
+
+		$statement->execute([
+			':domain'  => $this->domain,
+			':domainc' => $this->domain,
+			':user'    => $this->user,
+		]);
+
+		$rawPrefs = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$prefs = [];
+
+		foreach ($rawPrefs as $p) {
+			$prefs[$p['preference']] = [
+				'value'  => $p['value'],
+				'global' => $p['isglobal'] == 1,
+			];
+		}
+
+		$this->cachedPreferences = $prefs;
+	}
 }

includes/Helpers/BanHelper.php

Indentation +161 added lines, -161 removed lines

@@ -21,64 +21,64 @@ 
 
 class BanHelper implements IBanHelper
 {
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IXffTrustProvider */
-    private $xffTrustProvider;
-    /** @var Ban[][] */
-    private $banCache = [];
-
-    private ?ISecurityManager $securityManager;
-
-    public function __construct(
-        PdoDatabase $database,
-        IXffTrustProvider $xffTrustProvider,
-        ?ISecurityManager $securityManager
-    ) {
-        $this->database = $database;
-        $this->xffTrustProvider = $xffTrustProvider;
-        $this->securityManager = $securityManager;
-    }
-
-    public function isBlockBanned(Request $request): bool
-    {
-        if (!isset($this->banCache[$request->getId()])) {
-            $this->banCache[$request->getId()] = $this->getBansForRequestFromDatabase($request);
-        }
-
-        foreach ($this->banCache[$request->getId()] as $ban) {
-            if ($ban->getAction() === Ban::ACTION_BLOCK) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @return Ban[]
-     */
-    public function getBans(Request $request): array
-    {
-        if (!isset($this->banCache[$request->getId()])) {
-            $this->banCache[$request->getId()] = $this->getBansForRequestFromDatabase($request);
-        }
-
-        return $this->banCache[$request->getId()];
-    }
-
-    public function getBansByTarget(
-        ?string $name,
-        ?string $email,
-        ?string $ip,
-        ?int $mask,
-        ?string $useragent,
-        int $domain
-    ) {
-        /** @noinspection SqlConstantCondition */
-        $query = <<<SQL
+	/** @var PdoDatabase */
+	private $database;
+	/** @var IXffTrustProvider */
+	private $xffTrustProvider;
+	/** @var Ban[][] */
+	private $banCache = [];
+
+	private ?ISecurityManager $securityManager;
+
+	public function __construct(
+		PdoDatabase $database,
+		IXffTrustProvider $xffTrustProvider,
+		?ISecurityManager $securityManager
+	) {
+		$this->database = $database;
+		$this->xffTrustProvider = $xffTrustProvider;
+		$this->securityManager = $securityManager;
+	}
+
+	public function isBlockBanned(Request $request): bool
+	{
+		if (!isset($this->banCache[$request->getId()])) {
+			$this->banCache[$request->getId()] = $this->getBansForRequestFromDatabase($request);
+		}
+
+		foreach ($this->banCache[$request->getId()] as $ban) {
+			if ($ban->getAction() === Ban::ACTION_BLOCK) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @return Ban[]
+	 */
+	public function getBans(Request $request): array
+	{
+		if (!isset($this->banCache[$request->getId()])) {
+			$this->banCache[$request->getId()] = $this->getBansForRequestFromDatabase($request);
+		}
+
+		return $this->banCache[$request->getId()];
+	}
+
+	public function getBansByTarget(
+		?string $name,
+		?string $email,
+		?string $ip,
+		?int $mask,
+		?string $useragent,
+		int $domain
+	) {
+		/** @noinspection SqlConstantCondition */
+		$query = <<<SQL
 SELECT * FROM ban 
 WHERE 1 = 1
   AND ((name IS NULL AND :nname IS NULL) OR name = :name)
@@ -91,85 +91,85 @@ 
   AND (domain IS NULL OR domain = :domain);
 SQL;
 
-        $statement = $this->database->prepare($query);
-        $statement->execute([
-            ':name'       => $name,
-            ':nname'      => $name,
-            ':email'      => $email,
-            ':nemail'     => $email,
-            ':ip'         => $ip,
-            ':nip'        => $ip,
-            ':ipmask'     => $mask,
-            ':nipmask'    => $mask,
-            ':useragent'  => $useragent,
-            ':nuseragent' => $useragent,
-            ':domain'     => $domain,
-        ]);
-
-        $result = array();
-
-        /** @var Ban $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, Ban::class) as $v) {
-            $v->setDatabase($this->database);
-            $result[] = $v;
-        }
-
-        return $result;
-    }
-
-    public function isActive(Ban $ban): bool
-    {
-        if (!$ban->isActive()) {
-            return false;
-        }
-
-        if ($ban->getDuration() !== null && $ban->getDuration() < time()) {
-            return false;
-        }
-
-        return true;
-    }
-
-    public function canUnban(Ban $ban): bool
-    {
-        if ($this->securityManager === null) {
-            return false;
-        }
-
-        if (!$this->isActive($ban)) {
-            return false;
-        }
-
-        $user = User::getCurrent($this->database);
-
-        $allowed = true;
-        $allowed = $allowed && ($ban->getName() === null || $this->securityManager->allows('BanType', 'name', $user) === ISecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getEmail() === null || $this->securityManager->allows('BanType', 'email', $user) === ISecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getIp() === null || $this->securityManager->allows('BanType', 'ip', $user) === ISecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getUseragent() === null || $this->securityManager->allows('BanType', 'useragent', $user) === ISecurityManager::ALLOWED);
-
-        if ($ban->getDomain() === null) {
-            $allowed &= $this->securityManager->allows('BanType', 'global', $user) === ISecurityManager::ALLOWED;
-        }
-        else {
-            $currentDomain = Domain::getCurrent($this->database);
-            $allowed &= $currentDomain->getId() === $ban->getDomain();
-        }
-
-        $allowed = $allowed && $this->securityManager->allows('BanVisibility', $ban->getVisibility(), $user) === ISecurityManager::ALLOWED;
-
-        return $allowed;
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @return Ban[]
-     */
-    private function getBansForRequestFromDatabase(Request $request): array
-    {
-        /** @noinspection SqlConstantCondition - included for clarity of code */
-        $query = <<<SQL
+		$statement = $this->database->prepare($query);
+		$statement->execute([
+			':name'       => $name,
+			':nname'      => $name,
+			':email'      => $email,
+			':nemail'     => $email,
+			':ip'         => $ip,
+			':nip'        => $ip,
+			':ipmask'     => $mask,
+			':nipmask'    => $mask,
+			':useragent'  => $useragent,
+			':nuseragent' => $useragent,
+			':domain'     => $domain,
+		]);
+
+		$result = array();
+
+		/** @var Ban $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, Ban::class) as $v) {
+			$v->setDatabase($this->database);
+			$result[] = $v;
+		}
+
+		return $result;
+	}
+
+	public function isActive(Ban $ban): bool
+	{
+		if (!$ban->isActive()) {
+			return false;
+		}
+
+		if ($ban->getDuration() !== null && $ban->getDuration() < time()) {
+			return false;
+		}
+
+		return true;
+	}
+
+	public function canUnban(Ban $ban): bool
+	{
+		if ($this->securityManager === null) {
+			return false;
+		}
+
+		if (!$this->isActive($ban)) {
+			return false;
+		}
+
+		$user = User::getCurrent($this->database);
+
+		$allowed = true;
+		$allowed = $allowed && ($ban->getName() === null || $this->securityManager->allows('BanType', 'name', $user) === ISecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getEmail() === null || $this->securityManager->allows('BanType', 'email', $user) === ISecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getIp() === null || $this->securityManager->allows('BanType', 'ip', $user) === ISecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getUseragent() === null || $this->securityManager->allows('BanType', 'useragent', $user) === ISecurityManager::ALLOWED);
+
+		if ($ban->getDomain() === null) {
+			$allowed &= $this->securityManager->allows('BanType', 'global', $user) === ISecurityManager::ALLOWED;
+		}
+		else {
+			$currentDomain = Domain::getCurrent($this->database);
+			$allowed &= $currentDomain->getId() === $ban->getDomain();
+		}
+
+		$allowed = $allowed && $this->securityManager->allows('BanVisibility', $ban->getVisibility(), $user) === ISecurityManager::ALLOWED;
+
+		return $allowed;
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @return Ban[]
+	 */
+	private function getBansForRequestFromDatabase(Request $request): array
+	{
+		/** @noinspection SqlConstantCondition - included for clarity of code */
+		$query = <<<SQL
 SELECT b.* FROM ban b
 LEFT JOIN netmask n ON 1 = 1
     AND n.cidr = b.ipmask
@@ -191,28 +191,28 @@ 
     AND (b.domain IS NULL OR b.domain = :domain)
 SQL;
 
-        $statement = $this->database->prepare($query);
-        $trustedIp = $this->xffTrustProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
-
-        $statement->execute([
-            ':name'      => $request->getName(),
-            ':email'     => $request->getEmail(),
-            ':useragent' => $request->getUserAgent(),
-            ':domain'    => $request->getDomain(),
-            ':ip4'       => $trustedIp,
-            ':ip6h'      => $trustedIp,
-            ':ip6l'      => $trustedIp,
-        ]);
-
-        /** @var Ban[] $result */
-        $result = [];
-
-        /** @var Ban $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, Ban::class) as $v) {
-            $v->setDatabase($this->database);
-            $result[] = $v;
-        }
-
-        return $result;
-    }
+		$statement = $this->database->prepare($query);
+		$trustedIp = $this->xffTrustProvider->getTrustedClientIp($request->getIp(), $request->getForwardedIp());
+
+		$statement->execute([
+			':name'      => $request->getName(),
+			':email'     => $request->getEmail(),
+			':useragent' => $request->getUserAgent(),
+			':domain'    => $request->getDomain(),
+			':ip4'       => $trustedIp,
+			':ip6h'      => $trustedIp,
+			':ip6l'      => $trustedIp,
+		]);
+
+		/** @var Ban[] $result */
+		$result = [];
+
+		/** @var Ban $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, Ban::class) as $v) {
+			$v->setDatabase($this->database);
+			$result[] = $v;
+		}
+
+		return $result;
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -150,8 +150,7 @@
 
         if ($ban->getDomain() === null) {
             $allowed &= $this->securityManager->allows('BanType', 'global', $user) === ISecurityManager::ALLOWED;
-        }
-        else {
+        } else {
             $currentDomain = Domain::getCurrent($this->database);
             $allowed &= $currentDomain->getId() === $ban->getDomain();
         }

includes/Helpers/LogHelper.php

Indentation +523 added lines, -523 removed lines

@@ -31,543 +31,543 @@
 
 class LogHelper
 {
-    /**
-     * @param int             $requestId
-     *
-     * @return DataObject[]
-     */
-    public static function getRequestLogsWithComments(
-        $requestId,
-        PdoDatabase $db,
-        ISecurityManager $securityManager
-    ): array {
-        // FIXME: domains
-        $logs = LogSearchHelper::get($db, 1)->byObjectType('Request')->byObjectId($requestId)->fetch();
-
-        $currentUser = User::getCurrent($db);
-        $showRestrictedComments = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser) === ISecurityManager::ALLOWED;
-        $showCheckuserComments = $securityManager->allows('RequestData', 'seeCheckuserComments', $currentUser) === ISecurityManager::ALLOWED;
-
-        $comments = Comment::getForRequest($requestId, $db, $showRestrictedComments, $showCheckuserComments, $currentUser->getId());
-
-        $items = array_merge($logs, $comments);
-
-        $sortKey = function(DataObject $item): int {
-            if ($item instanceof Log) {
-                return $item->getTimestamp()->getTimestamp();
-            }
-
-            if ($item instanceof Comment) {
-                return $item->getTime()->getTimestamp();
-            }
-
-            return 0;
-        };
-
-        do {
-            $flag = false;
-
-            $loopLimit = (count($items) - 1);
-            for ($i = 0; $i < $loopLimit; $i++) {
-                // are these two items out of order?
-                if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
-                    // swap them
-                    $swap = $items[$i];
-                    $items[$i] = $items[$i + 1];
-                    $items[$i + 1] = $swap;
-
-                    // set a flag to say we've modified the array this time around
-                    $flag = true;
-                }
-            }
-        }
-        while ($flag);
-
-        return $items;
-    }
-
-    public static function getLogDescription(Log $entry): string
-    {
-        $text = "Deferred to ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Deferred to a different queue
-            // This is exactly what we want to display.
-            return $entry->getAction();
-        }
-
-        $text = "Closed custom-n";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account not created)";
-        }
-
-        $text = "Closed custom-y";
-        if ($entry->getAction() == $text) {
-            // Custom-closed
-            return "closed (custom reason - account created)";
-        }
-
-        $text = "Closed 0";
-        if ($entry->getAction() == $text) {
-            // Dropped the request - short-circuit the lookup
-            return "dropped request";
-        }
-
-        $text = "Closed ";
-        if (substr($entry->getAction(), 0, strlen($text)) == $text) {
-            // Closed with a reason - do a lookup here.
-            $id = substr($entry->getAction(), strlen($text));
-            /** @var EmailTemplate|false $template */
-            $template = EmailTemplate::getById((int)$id, $entry->getDatabase());
-
-            if ($template !== false) {
-                return 'closed (' . $template->getName() . ')';
-            }
-        }
-
-        // Fall back to the basic stuff
-        $lookup = array(
-            'Reserved'            => 'reserved',
-            'Email Confirmed'     => 'email-confirmed',
-            'Manually Confirmed'  => 'manually confirmed the request',
-            'Unreserved'          => 'unreserved',
-            'Approved'            => 'approved',
-            'DeactivatedUser'     => 'deactivated user',
-            'RoleChange'          => 'changed roles',
-            'GlobalRoleChange'    => 'changed global roles',
-            'RequestedReactivation' => 'requested reactivation',
-            'Banned'              => 'banned',
-            'Edited'              => 'edited interface message',
-            'EditComment-c'       => 'edited a comment',
-            'EditComment-r'       => 'edited a comment',
-            'FlaggedComment'      => 'flagged a comment',
-            'UnflaggedComment'    => 'unflagged a comment',
-            'Unbanned'            => 'unbanned',
-            'BanReplaced'         => 'replaced ban',
-            'Promoted'            => 'promoted to tool admin',
-            'BreakReserve'        => 'forcibly broke the reservation',
-            'Prefchange'          => 'changed user preferences',
-            'Renamed'             => 'renamed',
-            'Demoted'             => 'demoted from tool admin',
-            'ReceiveReserved'     => 'received the reservation',
-            'SendReserved'        => 'sent the reservation',
-            'EditedEmail'         => 'edited email',
-            'DeletedTemplate'     => 'deleted template',
-            'EditedTemplate'      => 'edited template',
-            'CreatedEmail'        => 'created email',
-            'CreatedTemplate'     => 'created template',
-            'SentMail'            => 'sent an email to the requester',
-            'Registered'          => 'registered a tool account',
-            'JobIssue'            => 'ran a background job unsuccessfully',
-            'JobCompleted'        => 'completed a background job',
-            'JobAcknowledged'     => 'acknowledged a job failure',
-            'JobRequeued'         => 'requeued a job for re-execution',
-            'JobCancelled'        => 'cancelled execution of a job',
-            'EnqueuedJobQueue'    => 'scheduled for creation',
-            'Hospitalised'        => 'sent to the hospital',
-            'QueueCreated'        => 'created a request queue',
-            'QueueEdited'         => 'edited a request queue',
-            'DomainCreated'       => 'created a domain',
-            'DomainEdited'        => 'edited a domain',
-            'RequestFormCreated'  => 'created a request form',
-            'RequestFormEdited'   => 'edited a request form',
-        );
-
-        if (array_key_exists($entry->getAction(), $lookup)) {
-            return $lookup[$entry->getAction()];
-        }
-
-        // OK, I don't know what this is. Fall back to something sane.
-        return "performed an unknown action ({$entry->getAction()})";
-    }
-
-    public static function getLogActions(PdoDatabase $database): array
-    {
-        $lookup = array(
-            "Requests" => [
-                'Reserved'            => 'reserved',
-                'Email Confirmed'     => 'email-confirmed',
-                'Manually Confirmed'  => 'manually confirmed',
-                'Unreserved'          => 'unreserved',
-                'EditComment-c'       => 'edited a comment (by comment ID)',
-                'EditComment-r'       => 'edited a comment (by request)',
-                'FlaggedComment'      => 'flagged a comment',
-                'UnflaggedComment'    => 'unflagged a comment',
-                'BreakReserve'        => 'forcibly broke the reservation',
-                'ReceiveReserved'     => 'received the reservation',
-                'SendReserved'        => 'sent the reservation',
-                'SentMail'            => 'sent an email to the requester',
-                'Closed 0'            => 'dropped request',
-                'Closed custom-y'     => 'closed (custom reason - account created)',
-                'Closed custom-n'     => 'closed (custom reason - account not created)',
-            ],
-            'Users' => [
-                'Approved'            => 'approved',
-                'DeactivatedUser'     => 'deactivated user',
-                'RoleChange'          => 'changed roles',
-                'GlobalRoleChange'    => 'changed global roles',
-                'Prefchange'          => 'changed user preferences',
-                'Renamed'             => 'renamed',
-                'Promoted'            => 'promoted to tool admin',
-                'Demoted'             => 'demoted from tool admin',
-                'Registered'          => 'registered a tool account',
-                'RequestedReactivation' => 'requested reactivation',
-            ],
-            "Bans" => [
-                'Banned'              => 'banned',
-                'Unbanned'            => 'unbanned',
-                'BanReplaced'         => 'replaced ban',
-            ],
-            "Site notice" => [
-                'Edited'              => 'edited interface message',
-            ],
-            "Email close templates" => [
-                'EditedEmail'         => 'edited email',
-                'CreatedEmail'        => 'created email',
-            ],
-            "Welcome templates" => [
-                'DeletedTemplate'     => 'deleted template',
-                'EditedTemplate'      => 'edited template',
-                'CreatedTemplate'     => 'created template',
-            ],
-            "Job queue" => [
-                'JobIssue'            => 'ran a background job unsuccessfully',
-                'JobCompleted'        => 'completed a background job',
-                'JobAcknowledged'     => 'acknowledged a job failure',
-                'JobRequeued'         => 'requeued a job for re-execution',
-                'JobCancelled'        => 'cancelled execution of a job',
-                'EnqueuedJobQueue'    => 'scheduled for creation',
-                'Hospitalised'        => 'sent to the hospital',
-            ],
-            "Request queues" => [
-                'QueueCreated'        => 'created a request queue',
-                'QueueEdited'         => 'edited a request queue',
-            ],
-            "Domains" => [
-                'DomainCreated'       => 'created a domain',
-                'DomainEdited'        => 'edited a domain',
-            ],
-            "Request forms" => [
-                'RequestFormCreated'        => 'created a request form',
-                'RequestFormEdited'         => 'edited a request form',
-            ],
-        );
-
-        $databaseDrivenLogKeys = $database->query(<<<SQL
+	/**
+	 * @param int             $requestId
+	 *
+	 * @return DataObject[]
+	 */
+	public static function getRequestLogsWithComments(
+		$requestId,
+		PdoDatabase $db,
+		ISecurityManager $securityManager
+	): array {
+		// FIXME: domains
+		$logs = LogSearchHelper::get($db, 1)->byObjectType('Request')->byObjectId($requestId)->fetch();
+
+		$currentUser = User::getCurrent($db);
+		$showRestrictedComments = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser) === ISecurityManager::ALLOWED;
+		$showCheckuserComments = $securityManager->allows('RequestData', 'seeCheckuserComments', $currentUser) === ISecurityManager::ALLOWED;
+
+		$comments = Comment::getForRequest($requestId, $db, $showRestrictedComments, $showCheckuserComments, $currentUser->getId());
+
+		$items = array_merge($logs, $comments);
+
+		$sortKey = function(DataObject $item): int {
+			if ($item instanceof Log) {
+				return $item->getTimestamp()->getTimestamp();
+			}
+
+			if ($item instanceof Comment) {
+				return $item->getTime()->getTimestamp();
+			}
+
+			return 0;
+		};
+
+		do {
+			$flag = false;
+
+			$loopLimit = (count($items) - 1);
+			for ($i = 0; $i < $loopLimit; $i++) {
+				// are these two items out of order?
+				if ($sortKey($items[$i]) > $sortKey($items[$i + 1])) {
+					// swap them
+					$swap = $items[$i];
+					$items[$i] = $items[$i + 1];
+					$items[$i + 1] = $swap;
+
+					// set a flag to say we've modified the array this time around
+					$flag = true;
+				}
+			}
+		}
+		while ($flag);
+
+		return $items;
+	}
+
+	public static function getLogDescription(Log $entry): string
+	{
+		$text = "Deferred to ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Deferred to a different queue
+			// This is exactly what we want to display.
+			return $entry->getAction();
+		}
+
+		$text = "Closed custom-n";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account not created)";
+		}
+
+		$text = "Closed custom-y";
+		if ($entry->getAction() == $text) {
+			// Custom-closed
+			return "closed (custom reason - account created)";
+		}
+
+		$text = "Closed 0";
+		if ($entry->getAction() == $text) {
+			// Dropped the request - short-circuit the lookup
+			return "dropped request";
+		}
+
+		$text = "Closed ";
+		if (substr($entry->getAction(), 0, strlen($text)) == $text) {
+			// Closed with a reason - do a lookup here.
+			$id = substr($entry->getAction(), strlen($text));
+			/** @var EmailTemplate|false $template */
+			$template = EmailTemplate::getById((int)$id, $entry->getDatabase());
+
+			if ($template !== false) {
+				return 'closed (' . $template->getName() . ')';
+			}
+		}
+
+		// Fall back to the basic stuff
+		$lookup = array(
+			'Reserved'            => 'reserved',
+			'Email Confirmed'     => 'email-confirmed',
+			'Manually Confirmed'  => 'manually confirmed the request',
+			'Unreserved'          => 'unreserved',
+			'Approved'            => 'approved',
+			'DeactivatedUser'     => 'deactivated user',
+			'RoleChange'          => 'changed roles',
+			'GlobalRoleChange'    => 'changed global roles',
+			'RequestedReactivation' => 'requested reactivation',
+			'Banned'              => 'banned',
+			'Edited'              => 'edited interface message',
+			'EditComment-c'       => 'edited a comment',
+			'EditComment-r'       => 'edited a comment',
+			'FlaggedComment'      => 'flagged a comment',
+			'UnflaggedComment'    => 'unflagged a comment',
+			'Unbanned'            => 'unbanned',
+			'BanReplaced'         => 'replaced ban',
+			'Promoted'            => 'promoted to tool admin',
+			'BreakReserve'        => 'forcibly broke the reservation',
+			'Prefchange'          => 'changed user preferences',
+			'Renamed'             => 'renamed',
+			'Demoted'             => 'demoted from tool admin',
+			'ReceiveReserved'     => 'received the reservation',
+			'SendReserved'        => 'sent the reservation',
+			'EditedEmail'         => 'edited email',
+			'DeletedTemplate'     => 'deleted template',
+			'EditedTemplate'      => 'edited template',
+			'CreatedEmail'        => 'created email',
+			'CreatedTemplate'     => 'created template',
+			'SentMail'            => 'sent an email to the requester',
+			'Registered'          => 'registered a tool account',
+			'JobIssue'            => 'ran a background job unsuccessfully',
+			'JobCompleted'        => 'completed a background job',
+			'JobAcknowledged'     => 'acknowledged a job failure',
+			'JobRequeued'         => 'requeued a job for re-execution',
+			'JobCancelled'        => 'cancelled execution of a job',
+			'EnqueuedJobQueue'    => 'scheduled for creation',
+			'Hospitalised'        => 'sent to the hospital',
+			'QueueCreated'        => 'created a request queue',
+			'QueueEdited'         => 'edited a request queue',
+			'DomainCreated'       => 'created a domain',
+			'DomainEdited'        => 'edited a domain',
+			'RequestFormCreated'  => 'created a request form',
+			'RequestFormEdited'   => 'edited a request form',
+		);
+
+		if (array_key_exists($entry->getAction(), $lookup)) {
+			return $lookup[$entry->getAction()];
+		}
+
+		// OK, I don't know what this is. Fall back to something sane.
+		return "performed an unknown action ({$entry->getAction()})";
+	}
+
+	public static function getLogActions(PdoDatabase $database): array
+	{
+		$lookup = array(
+			"Requests" => [
+				'Reserved'            => 'reserved',
+				'Email Confirmed'     => 'email-confirmed',
+				'Manually Confirmed'  => 'manually confirmed',
+				'Unreserved'          => 'unreserved',
+				'EditComment-c'       => 'edited a comment (by comment ID)',
+				'EditComment-r'       => 'edited a comment (by request)',
+				'FlaggedComment'      => 'flagged a comment',
+				'UnflaggedComment'    => 'unflagged a comment',
+				'BreakReserve'        => 'forcibly broke the reservation',
+				'ReceiveReserved'     => 'received the reservation',
+				'SendReserved'        => 'sent the reservation',
+				'SentMail'            => 'sent an email to the requester',
+				'Closed 0'            => 'dropped request',
+				'Closed custom-y'     => 'closed (custom reason - account created)',
+				'Closed custom-n'     => 'closed (custom reason - account not created)',
+			],
+			'Users' => [
+				'Approved'            => 'approved',
+				'DeactivatedUser'     => 'deactivated user',
+				'RoleChange'          => 'changed roles',
+				'GlobalRoleChange'    => 'changed global roles',
+				'Prefchange'          => 'changed user preferences',
+				'Renamed'             => 'renamed',
+				'Promoted'            => 'promoted to tool admin',
+				'Demoted'             => 'demoted from tool admin',
+				'Registered'          => 'registered a tool account',
+				'RequestedReactivation' => 'requested reactivation',
+			],
+			"Bans" => [
+				'Banned'              => 'banned',
+				'Unbanned'            => 'unbanned',
+				'BanReplaced'         => 'replaced ban',
+			],
+			"Site notice" => [
+				'Edited'              => 'edited interface message',
+			],
+			"Email close templates" => [
+				'EditedEmail'         => 'edited email',
+				'CreatedEmail'        => 'created email',
+			],
+			"Welcome templates" => [
+				'DeletedTemplate'     => 'deleted template',
+				'EditedTemplate'      => 'edited template',
+				'CreatedTemplate'     => 'created template',
+			],
+			"Job queue" => [
+				'JobIssue'            => 'ran a background job unsuccessfully',
+				'JobCompleted'        => 'completed a background job',
+				'JobAcknowledged'     => 'acknowledged a job failure',
+				'JobRequeued'         => 'requeued a job for re-execution',
+				'JobCancelled'        => 'cancelled execution of a job',
+				'EnqueuedJobQueue'    => 'scheduled for creation',
+				'Hospitalised'        => 'sent to the hospital',
+			],
+			"Request queues" => [
+				'QueueCreated'        => 'created a request queue',
+				'QueueEdited'         => 'edited a request queue',
+			],
+			"Domains" => [
+				'DomainCreated'       => 'created a domain',
+				'DomainEdited'        => 'edited a domain',
+			],
+			"Request forms" => [
+				'RequestFormCreated'        => 'created a request form',
+				'RequestFormEdited'         => 'edited a request form',
+			],
+		);
+
+		$databaseDrivenLogKeys = $database->query(<<<SQL
 SELECT CONCAT('Closed ', id) AS k, CONCAT('closed (',name,')') AS v FROM emailtemplate
 UNION ALL
 SELECT CONCAT('Deferred to ', logname) AS k, CONCAT('deferred to ', displayname) AS v FROM requestqueue;
 SQL
-        );
-        foreach ($databaseDrivenLogKeys->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $lookup["Requests"][$row['k']] = $row['v'];
-        }
-
-        return $lookup;
-    }
-
-    public static function getObjectTypes(): array
-    {
-        return array(
-            'Ban'             => 'Ban',
-            'Comment'         => 'Comment',
-            'EmailTemplate'   => 'Email template',
-            'JobQueue'        => 'Job queue item',
-            'Request'         => 'Request',
-            'SiteNotice'      => 'Site notice',
-            'User'            => 'User',
-            'WelcomeTemplate' => 'Welcome template',
-            'RequestQueue'    => 'Request queue',
-            'Domain'          => 'Domain',
-            'RequestForm'     => 'Request form'
-        );
-    }
-
-    /**
-     * This returns an HTML representation of the object
-     *
-     * @param int               $objectId
-     * @param string            $objectType
-     *
-     * @category Security-Critical
-     */
-    private static function getObjectDescription(
-        $objectId,
-        $objectType,
-        PdoDatabase $database,
-        SiteConfiguration $configuration
-    ): ?string {
-        if ($objectType == '') {
-            return null;
-        }
-
-        $baseurl = $configuration->getBaseUrl();
-
-        switch ($objectType) {
-            case 'Ban':
-                /** @var Ban $ban */
-                $ban = Ban::getById($objectId, $database);
-
-                if ($ban === false) {
-                    return 'Ban #' . $objectId;
-                }
-
-                return <<<HTML
+		);
+		foreach ($databaseDrivenLogKeys->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$lookup["Requests"][$row['k']] = $row['v'];
+		}
+
+		return $lookup;
+	}
+
+	public static function getObjectTypes(): array
+	{
+		return array(
+			'Ban'             => 'Ban',
+			'Comment'         => 'Comment',
+			'EmailTemplate'   => 'Email template',
+			'JobQueue'        => 'Job queue item',
+			'Request'         => 'Request',
+			'SiteNotice'      => 'Site notice',
+			'User'            => 'User',
+			'WelcomeTemplate' => 'Welcome template',
+			'RequestQueue'    => 'Request queue',
+			'Domain'          => 'Domain',
+			'RequestForm'     => 'Request form'
+		);
+	}
+
+	/**
+	 * This returns an HTML representation of the object
+	 *
+	 * @param int               $objectId
+	 * @param string            $objectType
+	 *
+	 * @category Security-Critical
+	 */
+	private static function getObjectDescription(
+		$objectId,
+		$objectType,
+		PdoDatabase $database,
+		SiteConfiguration $configuration
+	): ?string {
+		if ($objectType == '') {
+			return null;
+		}
+
+		$baseurl = $configuration->getBaseUrl();
+
+		switch ($objectType) {
+			case 'Ban':
+				/** @var Ban $ban */
+				$ban = Ban::getById($objectId, $database);
+
+				if ($ban === false) {
+					return 'Ban #' . $objectId;
+				}
+
+				return <<<HTML
 <a href="{$baseurl}/internal.php/bans/show?id={$objectId}">Ban #{$objectId}</a>
 HTML;
-            case 'EmailTemplate':
-                /** @var EmailTemplate $emailTemplate */
-                $emailTemplate = EmailTemplate::getById($objectId, $database);
+			case 'EmailTemplate':
+				/** @var EmailTemplate $emailTemplate */
+				$emailTemplate = EmailTemplate::getById($objectId, $database);
 
-                if ($emailTemplate === false) {
-                    return 'Email Template #' . $objectId;
-                }
+				if ($emailTemplate === false) {
+					return 'Email Template #' . $objectId;
+				}
 
-                $name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
+				$name = htmlentities($emailTemplate->getName(), ENT_COMPAT, 'UTF-8');
 
-                return <<<HTML
+				return <<<HTML
 <a href="{$baseurl}/internal.php/emailManagement/view?id={$objectId}">Email Template #{$objectId} ({$name})</a>
 HTML;
-            case 'SiteNotice':
-                return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
-            case 'Request':
-                /** @var Request $request */
-                $request = Request::getById($objectId, $database);
+			case 'SiteNotice':
+				return "<a href=\"{$baseurl}/internal.php/siteNotice\">the site notice</a>";
+			case 'Request':
+				/** @var Request $request */
+				$request = Request::getById($objectId, $database);
 
-                if ($request === false) {
-                    return 'Request #' . $objectId;
-                }
+				if ($request === false) {
+					return 'Request #' . $objectId;
+				}
 
-                $name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
+				$name = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
 
-                return <<<HTML
+				return <<<HTML
 <a href="{$baseurl}/internal.php/viewRequest?id={$objectId}">Request #{$objectId} ({$name})</a>
 HTML;
-            case 'User':
-                /** @var User $user */
-                $user = User::getById($objectId, $database);
-
-                // Some users were merged out of existence
-                if ($user === false) {
-                    return 'User #' . $objectId;
-                }
-
-                $username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
-            case 'WelcomeTemplate':
-                /** @var WelcomeTemplate $welcomeTemplate */
-                $welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
-
-                // some old templates have been completely deleted and lost to the depths of time.
-                if ($welcomeTemplate === false) {
-                    return "Welcome template #{$objectId}";
-                }
-                else {
-                    $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
-
-                    return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
-                }
-            case 'JobQueue':
-                /** @var JobQueue $job */
-                $job = JobQueue::getById($objectId, $database);
-
-                $taskDescriptions = JobQueue::getTaskDescriptions();
-
-                if ($job === false) {
-                    return 'Job Queue Task #' . $objectId;
-                }
-
-                $task = $job->getTask();
-                if (isset($taskDescriptions[$task])) {
-                    $description = $taskDescriptions[$task];
-                }
-                else {
-                    $description = 'Unknown task';
-                }
-
-                return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
-            case 'RequestQueue':
-                /** @var RequestQueue $queue */
-                $queue = RequestQueue::getById($objectId, $database);
-
-                if ($queue === false) {
-                    return "Request Queue #{$objectId}";
-                }
-
-                $queueHeader = htmlentities($queue->getHeader(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/queueManagement/edit?queue={$objectId}\">{$queueHeader}</a>";
-            case 'Domain':
-                /** @var Domain $domain */
-                $domain = Domain::getById($objectId, $database);
-
-                if ($domain === false) {
-                    return "Domain #{$objectId}";
-                }
-
-                $domainName = htmlentities($domain->getShortName(), ENT_COMPAT, 'UTF-8');
-                return "<a href=\"{$baseurl}/internal.php/domainManagement/edit?domain={$objectId}\">{$domainName}</a>";
-            case 'RequestForm':
-                /** @var RequestForm $queue */
-                $queue = RequestForm::getById($objectId, $database);
-
-                if ($queue === false) {
-                    return "Request Form #{$objectId}";
-                }
-
-                $formName = htmlentities($queue->getName(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/requestFormManagement/edit?form={$objectId}\">{$formName}</a>";
-            case 'Comment':
-                /** @var Comment $comment */
-                $comment = Comment::getById($objectId, $database);
-                /** @var Request $request */
-                $request = Request::getById($comment->getRequest(), $database);
-                $requestName = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
-
-                return "<a href=\"{$baseurl}/internal.php/editComment?id={$objectId}\">Comment {$objectId}</a> on request <a href=\"{$baseurl}/internal.php/viewRequest?id={$comment->getRequest()}#comment-{$objectId}\">#{$comment->getRequest()} ({$requestName})</a>";
-            default:
-                return '[' . $objectType . " " . $objectId . ']';
-        }
-    }
-
-    /**
-     * @param Log[] $logs
-     * @throws Exception
-     *
-     * @returns User[]
-     */
-    private static function loadUsersFromLogs(array $logs, PdoDatabase $database): array
-    {
-        $userIds = array();
-
-        foreach ($logs as $logEntry) {
-            if (!$logEntry instanceof Log) {
-                // if this happens, we've done something wrong with passing back the log data.
-                throw new Exception('Log entry is not an instance of a Log, this should never happen.');
-            }
-
-            $user = $logEntry->getUser();
-            if ($user === -1) {
-                continue;
-            }
-
-            if (!array_search($user, $userIds)) {
-                $userIds[] = $user;
-            }
-        }
-
-        $users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
-        $users[-1] = User::getCommunity()->getUsername();
-
-        return $users;
-    }
-
-    /**
-     * @param Log[] $logs
-     *
-     * @throws Exception
-     */
-    public static function prepareLogsForTemplate(
-        array $logs,
-        PdoDatabase $database,
-        SiteConfiguration $configuration,
-        ISecurityManager $securityManager
-    ): array {
-        $users = self::loadUsersFromLogs($logs, $database);
-        $currentUser = User::getCurrent($database);
-
-        $allowAccountLogSelf = $securityManager->allows('UserData', 'accountLogSelf', $currentUser) === ISecurityManager::ALLOWED;
-        $allowAccountLog = $securityManager->allows('UserData', 'accountLog', $currentUser) === ISecurityManager::ALLOWED;
-
-        $protectedLogActions = [
-            'RequestedReactivation',
-            'DeactivatedUser',
-        ];
-
-        $logData = array();
-        foreach ($logs as $logEntry) {
-            $objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
-                $database, $configuration);
-
-            // initialise to sane default
-            $comment = null;
-
-            switch ($logEntry->getAction()) {
-                case 'Renamed':
-                    $renameData = unserialize($logEntry->getComment());
-                    $oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
-                    $newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
-                    $comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
-                    break;
-                case 'RoleChange':
-                case 'GlobalRoleChange':
-                    $roleChangeData = unserialize($logEntry->getComment());
-
-                    $removed = array();
-                    foreach ($roleChangeData['removed'] as $r) {
-                        $removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $added = array();
-                    foreach ($roleChangeData['added'] as $r) {
-                        $added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
-                    }
-
-                    $reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
-
-                    $roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
-                    $comment = $roleDelta . ' with comment: ' . $reason;
-                    break;
-                case 'JobIssue':
-                    $jobIssueData = unserialize($logEntry->getComment());
-                    $errorMessage = $jobIssueData['error'];
-                    $status = $jobIssueData['status'];
-
-                    $comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
-                    $comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
-                    break;
-                case 'JobIssueRequest':
-                case 'JobCompletedRequest':
-                    $jobData = unserialize($logEntry->getComment());
-
-                    /** @var JobQueue $job */
-                    $job = JobQueue::getById($jobData['job'], $database);
-                    $descs = JobQueue::getTaskDescriptions();
-                    $comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
-                    break;
-
-                case 'JobCompleted':
-                    break;
-
-                default:
-                    $comment = $logEntry->getComment();
-                    break;
-            }
-
-            if (in_array($logEntry->getAction(), $protectedLogActions) && $logEntry->getObjectType() === 'User') {
-                if ($allowAccountLog) {
-                    // do nothing, allowed to see all account logs
-                }
-                else if ($allowAccountLogSelf && $currentUser->getId() === $logEntry->getObjectId()) {
-                    // do nothing, allowed to see own account log
-                }
-                else {
-                    $comment = null;
-                }
-            }
-
-            $logData[] = array(
-                'timestamp'         => $logEntry->getTimestamp(),
-                'userid'            => $logEntry->getUser(),
-                'username'          => $users[$logEntry->getUser()],
-                'description'       => self::getLogDescription($logEntry),
-                'objectdescription' => $objectDescription,
-                'comment'           => $comment,
-            );
-        }
-
-        return array($users, $logData);
-    }
+			case 'User':
+				/** @var User $user */
+				$user = User::getById($objectId, $database);
+
+				// Some users were merged out of existence
+				if ($user === false) {
+					return 'User #' . $objectId;
+				}
+
+				$username = htmlentities($user->getUsername(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/statistics/users/detail?user={$objectId}\">{$username}</a>";
+			case 'WelcomeTemplate':
+				/** @var WelcomeTemplate $welcomeTemplate */
+				$welcomeTemplate = WelcomeTemplate::getById($objectId, $database);
+
+				// some old templates have been completely deleted and lost to the depths of time.
+				if ($welcomeTemplate === false) {
+					return "Welcome template #{$objectId}";
+				}
+				else {
+					$userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
+
+					return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
+				}
+			case 'JobQueue':
+				/** @var JobQueue $job */
+				$job = JobQueue::getById($objectId, $database);
+
+				$taskDescriptions = JobQueue::getTaskDescriptions();
+
+				if ($job === false) {
+					return 'Job Queue Task #' . $objectId;
+				}
+
+				$task = $job->getTask();
+				if (isset($taskDescriptions[$task])) {
+					$description = $taskDescriptions[$task];
+				}
+				else {
+					$description = 'Unknown task';
+				}
+
+				return "<a href=\"{$baseurl}/internal.php/jobQueue/view?id={$objectId}\">Job #{$job->getId()} ({$description})</a>";
+			case 'RequestQueue':
+				/** @var RequestQueue $queue */
+				$queue = RequestQueue::getById($objectId, $database);
+
+				if ($queue === false) {
+					return "Request Queue #{$objectId}";
+				}
+
+				$queueHeader = htmlentities($queue->getHeader(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/queueManagement/edit?queue={$objectId}\">{$queueHeader}</a>";
+			case 'Domain':
+				/** @var Domain $domain */
+				$domain = Domain::getById($objectId, $database);
+
+				if ($domain === false) {
+					return "Domain #{$objectId}";
+				}
+
+				$domainName = htmlentities($domain->getShortName(), ENT_COMPAT, 'UTF-8');
+				return "<a href=\"{$baseurl}/internal.php/domainManagement/edit?domain={$objectId}\">{$domainName}</a>";
+			case 'RequestForm':
+				/** @var RequestForm $queue */
+				$queue = RequestForm::getById($objectId, $database);
+
+				if ($queue === false) {
+					return "Request Form #{$objectId}";
+				}
+
+				$formName = htmlentities($queue->getName(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/requestFormManagement/edit?form={$objectId}\">{$formName}</a>";
+			case 'Comment':
+				/** @var Comment $comment */
+				$comment = Comment::getById($objectId, $database);
+				/** @var Request $request */
+				$request = Request::getById($comment->getRequest(), $database);
+				$requestName = htmlentities($request->getName(), ENT_COMPAT, 'UTF-8');
+
+				return "<a href=\"{$baseurl}/internal.php/editComment?id={$objectId}\">Comment {$objectId}</a> on request <a href=\"{$baseurl}/internal.php/viewRequest?id={$comment->getRequest()}#comment-{$objectId}\">#{$comment->getRequest()} ({$requestName})</a>";
+			default:
+				return '[' . $objectType . " " . $objectId . ']';
+		}
+	}
+
+	/**
+	 * @param Log[] $logs
+	 * @throws Exception
+	 *
+	 * @returns User[]
+	 */
+	private static function loadUsersFromLogs(array $logs, PdoDatabase $database): array
+	{
+		$userIds = array();
+
+		foreach ($logs as $logEntry) {
+			if (!$logEntry instanceof Log) {
+				// if this happens, we've done something wrong with passing back the log data.
+				throw new Exception('Log entry is not an instance of a Log, this should never happen.');
+			}
+
+			$user = $logEntry->getUser();
+			if ($user === -1) {
+				continue;
+			}
+
+			if (!array_search($user, $userIds)) {
+				$userIds[] = $user;
+			}
+		}
+
+		$users = UserSearchHelper::get($database)->inIds($userIds)->fetchMap('username');
+		$users[-1] = User::getCommunity()->getUsername();
+
+		return $users;
+	}
+
+	/**
+	 * @param Log[] $logs
+	 *
+	 * @throws Exception
+	 */
+	public static function prepareLogsForTemplate(
+		array $logs,
+		PdoDatabase $database,
+		SiteConfiguration $configuration,
+		ISecurityManager $securityManager
+	): array {
+		$users = self::loadUsersFromLogs($logs, $database);
+		$currentUser = User::getCurrent($database);
+
+		$allowAccountLogSelf = $securityManager->allows('UserData', 'accountLogSelf', $currentUser) === ISecurityManager::ALLOWED;
+		$allowAccountLog = $securityManager->allows('UserData', 'accountLog', $currentUser) === ISecurityManager::ALLOWED;
+
+		$protectedLogActions = [
+			'RequestedReactivation',
+			'DeactivatedUser',
+		];
+
+		$logData = array();
+		foreach ($logs as $logEntry) {
+			$objectDescription = self::getObjectDescription($logEntry->getObjectId(), $logEntry->getObjectType(),
+				$database, $configuration);
+
+			// initialise to sane default
+			$comment = null;
+
+			switch ($logEntry->getAction()) {
+				case 'Renamed':
+					$renameData = unserialize($logEntry->getComment());
+					$oldName = htmlentities($renameData['old'], ENT_COMPAT, 'UTF-8');
+					$newName = htmlentities($renameData['new'], ENT_COMPAT, 'UTF-8');
+					$comment = 'Renamed \'' . $oldName . '\' to \'' . $newName . '\'.';
+					break;
+				case 'RoleChange':
+				case 'GlobalRoleChange':
+					$roleChangeData = unserialize($logEntry->getComment());
+
+					$removed = array();
+					foreach ($roleChangeData['removed'] as $r) {
+						$removed[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$added = array();
+					foreach ($roleChangeData['added'] as $r) {
+						$added[] = htmlentities($r, ENT_COMPAT, 'UTF-8');
+					}
+
+					$reason = htmlentities($roleChangeData['reason'], ENT_COMPAT, 'UTF-8');
+
+					$roleDelta = 'Removed [' . implode(', ', $removed) . '], Added [' . implode(', ', $added) . ']';
+					$comment = $roleDelta . ' with comment: ' . $reason;
+					break;
+				case 'JobIssue':
+					$jobIssueData = unserialize($logEntry->getComment());
+					$errorMessage = $jobIssueData['error'];
+					$status = $jobIssueData['status'];
+
+					$comment = 'Job ' . htmlentities($status, ENT_COMPAT, 'UTF-8') . ': ';
+					$comment .= htmlentities($errorMessage, ENT_COMPAT, 'UTF-8');
+					break;
+				case 'JobIssueRequest':
+				case 'JobCompletedRequest':
+					$jobData = unserialize($logEntry->getComment());
+
+					/** @var JobQueue $job */
+					$job = JobQueue::getById($jobData['job'], $database);
+					$descs = JobQueue::getTaskDescriptions();
+					$comment = htmlentities($descs[$job->getTask()], ENT_COMPAT, 'UTF-8');
+					break;
+
+				case 'JobCompleted':
+					break;
+
+				default:
+					$comment = $logEntry->getComment();
+					break;
+			}
+
+			if (in_array($logEntry->getAction(), $protectedLogActions) && $logEntry->getObjectType() === 'User') {
+				if ($allowAccountLog) {
+					// do nothing, allowed to see all account logs
+				}
+				else if ($allowAccountLogSelf && $currentUser->getId() === $logEntry->getObjectId()) {
+					// do nothing, allowed to see own account log
+				}
+				else {
+					$comment = null;
+				}
+			}
+
+			$logData[] = array(
+				'timestamp'         => $logEntry->getTimestamp(),
+				'userid'            => $logEntry->getUser(),
+				'username'          => $users[$logEntry->getUser()],
+				'description'       => self::getLogDescription($logEntry),
+				'objectdescription' => $objectDescription,
+				'comment'           => $comment,
+			);
+		}
+
+		return array($users, $logData);
+	}
 }

Braces +4 added lines, -8 removed lines

@@ -362,8 +362,7 @@ 
                 // some old templates have been completely deleted and lost to the depths of time.
                 if ($welcomeTemplate === false) {
                     return "Welcome template #{$objectId}";
-                }
-                else {
+                } else {
                     $userCode = htmlentities($welcomeTemplate->getUserCode(), ENT_COMPAT, 'UTF-8');
 
                     return "<a href=\"{$baseurl}/internal.php/welcomeTemplates/view?template={$objectId}\">{$userCode}</a>";
@@ -381,8 +380,7 @@ 
                 $task = $job->getTask();
                 if (isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
-                }
-                else {
+                } else {
                     $description = 'Unknown task';
                 }
 
@@ -549,11 +547,9 @@ 
             if (in_array($logEntry->getAction(), $protectedLogActions) && $logEntry->getObjectType() === 'User') {
                 if ($allowAccountLog) {
                     // do nothing, allowed to see all account logs
-                }
-                else if ($allowAccountLogSelf && $currentUser->getId() === $logEntry->getObjectId()) {
+                } else if ($allowAccountLogSelf && $currentUser->getId() === $logEntry->getObjectId()) {
                     // do nothing, allowed to see own account log
-                }
-                else {
+                } else {
                     $comment = null;
                 }
             }

includes/Fragments/LogEntryLookup.php

Indentation +14 added lines, -14 removed lines

@@ -16,20 +16,20 @@
 
 trait LogEntryLookup
 {
-    protected function getLogEntry(string $action, User $user, PdoDatabase $database): ?string
-    {
-        /** @var Log[] $logs */
-        $logs = LogSearchHelper::get($database, null)
-            ->byAction($action)
-            ->byObjectType('User')
-            ->byObjectId($user->getId())
-            ->limit(1)
-            ->fetch();
+	protected function getLogEntry(string $action, User $user, PdoDatabase $database): ?string
+	{
+		/** @var Log[] $logs */
+		$logs = LogSearchHelper::get($database, null)
+			->byAction($action)
+			->byObjectType('User')
+			->byObjectId($user->getId())
+			->limit(1)
+			->fetch();
 
-        if (count($logs) > 0) {
-            return $logs[0]->getComment();
-        }
+		if (count($logs) > 0) {
+			return $logs[0]->getComment();
+		}
 
-        return null;
-    }
+		return null;
+	}
 }
\ No newline at end of file

includes/Tasks/InternalPageBase.php

Indentation +228 added lines, -228 removed lines

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

Braces +5 added lines, -10 removed lines

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

includes/Tasks/TextApiPageBase.php

Indentation +16 added lines, -16 removed lines

@@ -13,23 +13,23 @@
 
 abstract class TextApiPageBase extends ApiPageBase implements IRoutedTask
 {
-    final protected function main()
-    {
-        if (headers_sent()) {
-            throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
-        }
+	final protected function main()
+	{
+		if (headers_sent()) {
+			throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
+		}
 
-        try {
-            $responseData = $this->runApiPage();
-        }
-        catch (ApiException $ex) {
-            $responseData = $ex->getMessage();
-        }
+		try {
+			$responseData = $this->runApiPage();
+		}
+		catch (ApiException $ex) {
+			$responseData = $ex->getMessage();
+		}
 
-        header('Content-Type: text/plain');
+		header('Content-Type: text/plain');
 
-        ob_end_clean();
-        print($responseData);
-        ob_start();
-    }
+		ob_end_clean();
+		print($responseData);
+		ob_start();
+	}
 }