mdaniels5757 / waca

includes/Helpers/LogHelper.php

Indentation +485 added lines, -485 removed lines

@@ -30,505 +30,505 @@
 
 class LogHelper
 {
-    /**
-     * @param int             $requestId
-     *
-     * @return DataObject[]
-     */
-    public static function getRequestLogsWithComments(
-        $requestId,
-        PdoDatabase $db,
-        SecurityManager $securityManager
-    ): array {
-        // FIXME: domains
-        $logs = LogSearchHelper::get($db, 1)->byObjectType('Request')->byObjectId($requestId)->fetch();
-
-        $currentUser = User::getCurrent($db);
-        $showRestrictedComments = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser) === SecurityManager::ALLOWED;
-        $showCheckuserComments = $securityManager->allows('RequestData', 'seeCheckuserComments', $currentUser) === SecurityManager::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',
-            'Suspended'           => 'suspended',
-            'RoleChange'          => 'changed roles',
-            'GlobalRoleChange'    => 'changed global roles',
-            'Banned'              => 'banned',
-            'Edited'              => 'edited interface message',
-            'Declined'            => 'declined',
-            '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',
-                'Suspended'           => 'suspended',
-                'RoleChange'          => 'changed roles',
-                'GlobalRoleChange'    => 'changed global roles',
-                'Declined'            => 'declined',
-                'Prefchange'          => 'changed user preferences',
-                'Renamed'             => 'renamed',
-                'Promoted'            => 'promoted to tool admin',
-                'Demoted'             => 'demoted from tool admin',
-                'Registered'          => 'registered a tool account',
-            ],
-            "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,
+		SecurityManager $securityManager
+	): array {
+		// FIXME: domains
+		$logs = LogSearchHelper::get($db, 1)->byObjectType('Request')->byObjectId($requestId)->fetch();
+
+		$currentUser = User::getCurrent($db);
+		$showRestrictedComments = $securityManager->allows('RequestData', 'seeRestrictedComments', $currentUser) === SecurityManager::ALLOWED;
+		$showCheckuserComments = $securityManager->allows('RequestData', 'seeCheckuserComments', $currentUser) === SecurityManager::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',
+			'Suspended'           => 'suspended',
+			'RoleChange'          => 'changed roles',
+			'GlobalRoleChange'    => 'changed global roles',
+			'Banned'              => 'banned',
+			'Edited'              => 'edited interface message',
+			'Declined'            => 'declined',
+			'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',
+				'Suspended'           => 'suspended',
+				'RoleChange'          => 'changed roles',
+				'GlobalRoleChange'    => 'changed global roles',
+				'Declined'            => 'declined',
+				'Prefchange'          => 'changed user preferences',
+				'Renamed'             => 'renamed',
+				'Promoted'            => 'promoted to tool admin',
+				'Demoted'             => 'demoted from tool admin',
+				'Registered'          => 'registered a tool account',
+			],
+			"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
-     */
-    public static function prepareLogsForTemplate(array $logs, PdoDatabase $database, SiteConfiguration $configuration): 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();
-
-        $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;
-            }
-
-            $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
+	 */
+	public static function prepareLogsForTemplate(array $logs, PdoDatabase $database, SiteConfiguration $configuration): 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();
+
+		$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;
+			}
+
+			$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 +2 added lines, -4 removed lines

@@ -361,8 +361,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>";
@@ -380,8 +379,7 @@ 
                 $task = $job->getTask();
                 if (isset($taskDescriptions[$task])) {
                     $description = $taskDescriptions[$task];
-                }
-                else {
+                } else {
                     $description = 'Unknown task';
                 }
 

includes/Helpers/BanHelper.php

Indentation +163 added lines, -163 removed lines

@@ -20,66 +20,66 @@ 
 
 class BanHelper implements IBanHelper
 {
-    /** @var PdoDatabase */
-    private $database;
-    /** @var IXffTrustProvider */
-    private $xffTrustProvider;
-    /** @var Ban[][] */
-    private $banCache = [];
-    /**
-     * @var null|SecurityManager
-     */
-    private $securityManager;
-
-    public function __construct(
-        PdoDatabase $database,
-        IXffTrustProvider $xffTrustProvider,
-        ?SecurityManager $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 = [];
+	/**
+	 * @var null|SecurityManager
+	 */
+	private $securityManager;
+
+	public function __construct(
+		PdoDatabase $database,
+		IXffTrustProvider $xffTrustProvider,
+		?SecurityManager $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)
@@ -92,85 +92,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) === SecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getEmail() === null || $this->securityManager->allows('BanType', 'email', $user) === SecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getIp() === null || $this->securityManager->allows('BanType', 'ip', $user) === SecurityManager::ALLOWED);
-        $allowed = $allowed && ($ban->getUseragent() === null || $this->securityManager->allows('BanType', 'useragent', $user) === SecurityManager::ALLOWED);
-
-        if ($ban->getDomain() === null) {
-            $allowed &= $this->securityManager->allows('BanType', 'global', $user) === SecurityManager::ALLOWED;
-        }
-        else {
-            $currentDomain = Domain::getCurrent($this->database);
-            $allowed &= $currentDomain->getId() === $ban->getDomain();
-        }
-
-        $allowed = $allowed && $this->securityManager->allows('BanVisibility', $ban->getVisibility(), $user) === SecurityManager::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) === SecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getEmail() === null || $this->securityManager->allows('BanType', 'email', $user) === SecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getIp() === null || $this->securityManager->allows('BanType', 'ip', $user) === SecurityManager::ALLOWED);
+		$allowed = $allowed && ($ban->getUseragent() === null || $this->securityManager->allows('BanType', 'useragent', $user) === SecurityManager::ALLOWED);
+
+		if ($ban->getDomain() === null) {
+			$allowed &= $this->securityManager->allows('BanType', 'global', $user) === SecurityManager::ALLOWED;
+		}
+		else {
+			$currentDomain = Domain::getCurrent($this->database);
+			$allowed &= $currentDomain->getId() === $ban->getDomain();
+		}
+
+		$allowed = $allowed && $this->securityManager->allows('BanVisibility', $ban->getVisibility(), $user) === SecurityManager::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
@@ -192,28 +192,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

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

includes/PdoDatabase.php

Indentation +120 added lines, -120 removed lines

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

includes/DataObjects/CommunityUser.php

Indentation +124 added lines, -124 removed lines

@@ -16,130 +16,130 @@
  */
 class CommunityUser extends User
 {
-    public function getId()
-    {
-        return -1;
-    }
-
-    public function save()
-    {
-        // Do nothing
-    }
-
-    #region properties
-
-    /**
-     * @return string
-     */
-    public function getUsername()
-    {
-        return '[Community]';
-    }
-
-    public function setUsername($username)
-    {
-    }
-
-    /**
-     * @return string
-     */
-    public function getEmail()
-    {
-        global $cDataClearEmail;
-
-        return $cDataClearEmail;
-    }
-
-    public function setEmail($email)
-    {
-    }
-
-    public function getStatus()
-    {
-        return "Community";
-    }
-
-    public function getOnWikiName()
-    {
-        return "127.0.0.1";
-    }
-
-    public function setOnWikiName($onWikiName)
-    {
-    }
-
-    public function getLastActive()
-    {
-        $now = new DateTime();
-
-        return $now->format("Y-m-d H:i:s");
-    }
-
-    public function getForceLogout()
-    {
-        return true;
-    }
-
-    public function setForceLogout($forceLogout)
-    {
-    }
-
-    /**
-     * @param string $status
-     */
-    public function setStatus($status)
-    {
-    }
-
-    public function getConfirmationDiff()
-    {
-        return null;
-    }
-
-    public function setConfirmationDiff($confirmationDiff)
-    {
-    }
-
-
-    public function setUseAlternateSkin($useAlternate)
-    {
-    }
-
-    #endregion
-
-    #region user access checks
-
-    public function isIdentified(IdentificationVerifier $iv)
-    {
-        return false;
-    }
-
-    public function isSuspended()
-    {
-        return false;
-    }
-
-    public function isNewUser()
-    {
-        return false;
-    }
-
-    public function isDeclined()
-    {
-        return false;
-    }
-
-    public function isCommunityUser()
-    {
-        return true;
-    }
-
-    #endregion
+	public function getId()
+	{
+		return -1;
+	}
+
+	public function save()
+	{
+		// Do nothing
+	}
+
+	#region properties
+
+	/**
+	 * @return string
+	 */
+	public function getUsername()
+	{
+		return '[Community]';
+	}
+
+	public function setUsername($username)
+	{
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getEmail()
+	{
+		global $cDataClearEmail;
+
+		return $cDataClearEmail;
+	}
+
+	public function setEmail($email)
+	{
+	}
+
+	public function getStatus()
+	{
+		return "Community";
+	}
+
+	public function getOnWikiName()
+	{
+		return "127.0.0.1";
+	}
+
+	public function setOnWikiName($onWikiName)
+	{
+	}
+
+	public function getLastActive()
+	{
+		$now = new DateTime();
+
+		return $now->format("Y-m-d H:i:s");
+	}
+
+	public function getForceLogout()
+	{
+		return true;
+	}
+
+	public function setForceLogout($forceLogout)
+	{
+	}
+
+	/**
+	 * @param string $status
+	 */
+	public function setStatus($status)
+	{
+	}
+
+	public function getConfirmationDiff()
+	{
+		return null;
+	}
+
+	public function setConfirmationDiff($confirmationDiff)
+	{
+	}
+
+
+	public function setUseAlternateSkin($useAlternate)
+	{
+	}
+
+	#endregion
+
+	#region user access checks
+
+	public function isIdentified(IdentificationVerifier $iv)
+	{
+		return false;
+	}
+
+	public function isSuspended()
+	{
+		return false;
+	}
+
+	public function isNewUser()
+	{
+		return false;
+	}
+
+	public function isDeclined()
+	{
+		return false;
+	}
+
+	public function isCommunityUser()
+	{
+		return true;
+	}
+
+	#endregion
 
-    public function getApprovalDate()
-    {
-        $data = DateTime::createFromFormat("Y-m-d H:i:s", "1970-01-01 00:00:00");
+	public function getApprovalDate()
+	{
+		$data = DateTime::createFromFormat("Y-m-d H:i:s", "1970-01-01 00:00:00");
 
-        return $data;
-    }
+		return $data;
+	}
 }

includes/DataObjects/User.php

Indentation +431 added lines, -431 removed lines

@@ -21,154 +21,154 @@ 
  */
 class User extends DataObject
 {
-    const STATUS_ACTIVE = 'Active';
-    const STATUS_SUSPENDED = 'Suspended';
-    const STATUS_DECLINED = 'Declined';
-    const STATUS_NEW = 'New';
-
-    private static CommunityUser $community;
-
-    private $username;
-    private $email;
-    private $status = self::STATUS_NEW;
-    private $onwikiname;
-    private $lastactive = "0000-00-00 00:00:00";
-    private $forcelogout = 0;
-    private $forceidentified = null;
-    private $confirmationdiff = 0;
-    /** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
-    private static $currentUser;
-    #region Object load methods
-
-    /**
-     * Gets the currently logged in user
-     *
-     * @param PdoDatabase $database
-     *
-     * @return User|CommunityUser
-     */
-    public static function getCurrent(PdoDatabase $database)
-    {
-        if (self::$currentUser === null) {
-            $sessionId = WebRequest::getSessionUserId();
-
-            if ($sessionId !== null) {
-                /** @var User $user */
-                $user = self::getById($sessionId, $database);
-
-                if ($user === false) {
-                    self::$currentUser = new CommunityUser();
-                }
-                else {
-                    self::$currentUser = $user;
-                }
-            }
-            else {
-                $anonymousCoward = new CommunityUser();
-
-                self::$currentUser = $anonymousCoward;
-            }
-        }
-
-        return self::$currentUser;
-    }
-
-    /**
-     * Gets a user by their user ID
-     *
-     * Pass -1 to get the community user.
-     *
-     * @param int|null    $id
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getById($id, PdoDatabase $database)
-    {
-        if ($id === null || $id == -1) {
-            return new CommunityUser();
-        }
-
-        /** @var User|false $user */
-        $user = parent::getById($id, $database);
-
-        return $user;
-    }
-
-    public static function getCommunity(): CommunityUser
-    {
-        if (!isset(self::$community)) {
-            self::$community = new CommunityUser();
-        }
-
-        return self::$community;
-    }
-
-    /**
-     * Gets a user by their username
-     *
-     * @param  string      $username
-     * @param  PdoDatabase $database
-     *
-     * @return CommunityUser|User|false
-     */
-    public static function getByUsername($username, PdoDatabase $database)
-    {
-        if ($username === self::getCommunity()->getUsername()) {
-            return new CommunityUser();
-        }
-
-        $statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;");
-        $statement->bindValue(":id", $username);
-
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    /**
-     * Gets a user by their on-wiki username.
-     *
-     * @param string      $username
-     * @param PdoDatabase $database
-     *
-     * @return User|false
-     */
-    public static function getByOnWikiUsername($username, PdoDatabase $database)
-    {
-        $statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;");
-        $statement->bindValue(":id", $username);
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-
-            return $resultObject;
-        }
-
-        return false;
-    }
-
-    #endregion
-
-    /**
-     * Saves the current object
-     *
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	const STATUS_ACTIVE = 'Active';
+	const STATUS_SUSPENDED = 'Suspended';
+	const STATUS_DECLINED = 'Declined';
+	const STATUS_NEW = 'New';
+
+	private static CommunityUser $community;
+
+	private $username;
+	private $email;
+	private $status = self::STATUS_NEW;
+	private $onwikiname;
+	private $lastactive = "0000-00-00 00:00:00";
+	private $forcelogout = 0;
+	private $forceidentified = null;
+	private $confirmationdiff = 0;
+	/** @var User Cache variable of the current user - it's never going to change in the middle of a request. */
+	private static $currentUser;
+	#region Object load methods
+
+	/**
+	 * Gets the currently logged in user
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|CommunityUser
+	 */
+	public static function getCurrent(PdoDatabase $database)
+	{
+		if (self::$currentUser === null) {
+			$sessionId = WebRequest::getSessionUserId();
+
+			if ($sessionId !== null) {
+				/** @var User $user */
+				$user = self::getById($sessionId, $database);
+
+				if ($user === false) {
+					self::$currentUser = new CommunityUser();
+				}
+				else {
+					self::$currentUser = $user;
+				}
+			}
+			else {
+				$anonymousCoward = new CommunityUser();
+
+				self::$currentUser = $anonymousCoward;
+			}
+		}
+
+		return self::$currentUser;
+	}
+
+	/**
+	 * Gets a user by their user ID
+	 *
+	 * Pass -1 to get the community user.
+	 *
+	 * @param int|null    $id
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getById($id, PdoDatabase $database)
+	{
+		if ($id === null || $id == -1) {
+			return new CommunityUser();
+		}
+
+		/** @var User|false $user */
+		$user = parent::getById($id, $database);
+
+		return $user;
+	}
+
+	public static function getCommunity(): CommunityUser
+	{
+		if (!isset(self::$community)) {
+			self::$community = new CommunityUser();
+		}
+
+		return self::$community;
+	}
+
+	/**
+	 * Gets a user by their username
+	 *
+	 * @param  string      $username
+	 * @param  PdoDatabase $database
+	 *
+	 * @return CommunityUser|User|false
+	 */
+	public static function getByUsername($username, PdoDatabase $database)
+	{
+		if ($username === self::getCommunity()->getUsername()) {
+			return new CommunityUser();
+		}
+
+		$statement = $database->prepare("SELECT * FROM user WHERE username = :id LIMIT 1;");
+		$statement->bindValue(":id", $username);
+
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	/**
+	 * Gets a user by their on-wiki username.
+	 *
+	 * @param string      $username
+	 * @param PdoDatabase $database
+	 *
+	 * @return User|false
+	 */
+	public static function getByOnWikiUsername($username, PdoDatabase $database)
+	{
+		$statement = $database->prepare("SELECT * FROM user WHERE onwikiname = :id LIMIT 1;");
+		$statement->bindValue(":id", $username);
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+
+			return $resultObject;
+		}
+
+		return false;
+	}
+
+	#endregion
+
+	/**
+	 * Saves the current object
+	 *
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 				INSERT INTO `user` ( 
 					username, email, status, onwikiname, 
 					lastactive, forcelogout, forceidentified,
@@ -179,26 +179,26 @@ 
 					:confirmationdiff
 				);
 SQL
-            );
-            $statement->bindValue(":username", $this->username);
-            $statement->bindValue(":email", $this->email);
-            $statement->bindValue(":status", $this->status);
-            $statement->bindValue(":onwikiname", $this->onwikiname);
-            $statement->bindValue(":lastactive", $this->lastactive);
-            $statement->bindValue(":forcelogout", $this->forcelogout);
-            $statement->bindValue(":forceidentified", $this->forceidentified);
-            $statement->bindValue(":confirmationdiff", $this->confirmationdiff);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":username", $this->username);
+			$statement->bindValue(":email", $this->email);
+			$statement->bindValue(":status", $this->status);
+			$statement->bindValue(":onwikiname", $this->onwikiname);
+			$statement->bindValue(":lastactive", $this->lastactive);
+			$statement->bindValue(":forcelogout", $this->forcelogout);
+			$statement->bindValue(":forceidentified", $this->forceidentified);
+			$statement->bindValue(":confirmationdiff", $this->confirmationdiff);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
 				UPDATE `user` SET 
 					username = :username, email = :email, 
 					status = :status,
@@ -210,263 +210,263 @@ 
                     updateversion = updateversion + 1
 				WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-            $statement->bindValue(":forceidentified", $this->forceidentified);
-
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':username', $this->username);
-            $statement->bindValue(':email', $this->email);
-            $statement->bindValue(':status', $this->status);
-            $statement->bindValue(':onwikiname', $this->onwikiname);
-            $statement->bindValue(':lastactive', $this->lastactive);
-            $statement->bindValue(':forcelogout', $this->forcelogout);
-            $statement->bindValue(':forceidentified', $this->forceidentified);
-            $statement->bindValue(':confirmationdiff', $this->confirmationdiff);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    #region properties
-
-    /**
-     * Gets the tool username
-     * @return string
-     */
-    public function getUsername()
-    {
-        return $this->username;
-    }
-
-    /**
-     * Sets the tool username
-     *
-     * @param string $username
-     */
-    public function setUsername($username)
-    {
-        $this->username = $username;
-
-        // If this isn't a brand new user, then it's a rename, force the logout
-        if (!$this->isNew()) {
-            $this->forcelogout = 1;
-        }
-    }
-
-    /**
-     * Gets the user's email address
-     * @return string
-     */
-    public function getEmail()
-    {
-        return $this->email;
-    }
-
-    /**
-     * Sets the user's email address
-     *
-     * @param string $email
-     */
-    public function setEmail($email)
-    {
-        $this->email = $email;
-    }
-
-    /**
-     * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user.
-     * @return string
-     */
-    public function getStatus()
-    {
-        return $this->status;
-    }
-
-    /**
-     * @param string $status
-     */
-    public function setStatus($status)
-    {
-        $this->status = $status;
-    }
-
-    /**
-     * Gets the user's on-wiki name
-     * @return string
-     */
-    public function getOnWikiName()
-    {
-        return $this->onwikiname;
-    }
-
-    /**
-     * Sets the user's on-wiki name
-     *
-     * This can have interesting side-effects with OAuth.
-     *
-     * @param string $onWikiName
-     */
-    public function setOnWikiName($onWikiName)
-    {
-        $this->onwikiname = $onWikiName;
-    }
-
-    /**
-     * Gets the last activity date for the user
-     *
-     * @return string
-     * @todo This should probably return an instance of DateTime
-     */
-    public function getLastActive()
-    {
-        return $this->lastactive;
-    }
-
-    /**
-     * Gets the user's forced logout status
-     *
-     * @return bool
-     */
-    public function getForceLogout()
-    {
-        return $this->forcelogout == 1;
-    }
-
-    /**
-     * Sets the user's forced logout status
-     *
-     * @param bool $forceLogout
-     */
-    public function setForceLogout($forceLogout)
-    {
-        $this->forcelogout = $forceLogout ? 1 : 0;
-    }
-
-    /**
-     * Gets the user's confirmation diff. Unused if OAuth is in use.
-     * @return int the diff ID
-     */
-    public function getConfirmationDiff()
-    {
-        return $this->confirmationdiff;
-    }
-
-    /**
-     * Sets the user's confirmation diff.
-     *
-     * @param int $confirmationDiff
-     */
-    public function setConfirmationDiff($confirmationDiff)
-    {
-        $this->confirmationdiff = $confirmationDiff;
-    }
-
-    #endregion
-
-    #region user access checks
-
-    public function isActive()
-    {
-        return $this->status == self::STATUS_ACTIVE;
-    }
-
-    /**
-     * Tests if the user is identified
-     *
-     * @param IdentificationVerifier $iv
-     *
-     * @return bool
-     * @todo     Figure out what on earth is going on with PDO's typecasting here.  Apparently, it returns string("0") for
-     *       the force-unidentified case, and int(1) for the identified case?!  This is quite ugly, but probably needed
-     *       to play it safe for now.
-     * @category Security-Critical
-     */
-    public function isIdentified(IdentificationVerifier $iv)
-    {
-        if ($this->forceidentified === 0 || $this->forceidentified === "0") {
-            // User forced to unidentified in the database.
-            return false;
-        }
-        elseif ($this->forceidentified === 1 || $this->forceidentified === "1") {
-            // User forced to identified in the database.
-            return true;
-        }
-        else {
-            // User not forced to any particular identified status; consult IdentificationVerifier
-            return $iv->isUserIdentified($this->getOnWikiName());
-        }
-    }
-
-    /**
-     * DO NOT USE FOR TESTING IDENTIFICATION STATUS.
-     *
-     * @return bool|null
-     */
-    public function getForceIdentified()
-    {
-        return $this->forceidentified;
-    }
-
-    /**
-     * Tests if the user is suspended
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isSuspended()
-    {
-        return $this->status == self::STATUS_SUSPENDED;
-    }
-
-    /**
-     * Tests if the user is new
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isNewUser()
-    {
-        return $this->status == self::STATUS_NEW;
-    }
-
-    /**
-     * Tests if the user has been declined access to the tool
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isDeclined()
-    {
-        return $this->status == self::STATUS_DECLINED;
-    }
-
-    /**
-     * Tests if the user is the community user
-     *
-     * @todo     decide if this means logged out. I think it usually does.
-     * @return bool
-     * @category Security-Critical
-     */
-    public function isCommunityUser()
-    {
-        return false;
-    }
-
-    #endregion 
-
-    /**
-     * Gets the approval date of the user
-     * @return DateTime|false
-     */
-    public function getApprovalDate()
-    {
-        $query = $this->dbObject->prepare(<<<SQL
+			);
+			$statement->bindValue(":forceidentified", $this->forceidentified);
+
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(':username', $this->username);
+			$statement->bindValue(':email', $this->email);
+			$statement->bindValue(':status', $this->status);
+			$statement->bindValue(':onwikiname', $this->onwikiname);
+			$statement->bindValue(':lastactive', $this->lastactive);
+			$statement->bindValue(':forcelogout', $this->forcelogout);
+			$statement->bindValue(':forceidentified', $this->forceidentified);
+			$statement->bindValue(':confirmationdiff', $this->confirmationdiff);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	#region properties
+
+	/**
+	 * Gets the tool username
+	 * @return string
+	 */
+	public function getUsername()
+	{
+		return $this->username;
+	}
+
+	/**
+	 * Sets the tool username
+	 *
+	 * @param string $username
+	 */
+	public function setUsername($username)
+	{
+		$this->username = $username;
+
+		// If this isn't a brand new user, then it's a rename, force the logout
+		if (!$this->isNew()) {
+			$this->forcelogout = 1;
+		}
+	}
+
+	/**
+	 * Gets the user's email address
+	 * @return string
+	 */
+	public function getEmail()
+	{
+		return $this->email;
+	}
+
+	/**
+	 * Sets the user's email address
+	 *
+	 * @param string $email
+	 */
+	public function setEmail($email)
+	{
+		$this->email = $email;
+	}
+
+	/**
+	 * Gets the status (User, Admin, Suspended, etc - excludes checkuser) of the user.
+	 * @return string
+	 */
+	public function getStatus()
+	{
+		return $this->status;
+	}
+
+	/**
+	 * @param string $status
+	 */
+	public function setStatus($status)
+	{
+		$this->status = $status;
+	}
+
+	/**
+	 * Gets the user's on-wiki name
+	 * @return string
+	 */
+	public function getOnWikiName()
+	{
+		return $this->onwikiname;
+	}
+
+	/**
+	 * Sets the user's on-wiki name
+	 *
+	 * This can have interesting side-effects with OAuth.
+	 *
+	 * @param string $onWikiName
+	 */
+	public function setOnWikiName($onWikiName)
+	{
+		$this->onwikiname = $onWikiName;
+	}
+
+	/**
+	 * Gets the last activity date for the user
+	 *
+	 * @return string
+	 * @todo This should probably return an instance of DateTime
+	 */
+	public function getLastActive()
+	{
+		return $this->lastactive;
+	}
+
+	/**
+	 * Gets the user's forced logout status
+	 *
+	 * @return bool
+	 */
+	public function getForceLogout()
+	{
+		return $this->forcelogout == 1;
+	}
+
+	/**
+	 * Sets the user's forced logout status
+	 *
+	 * @param bool $forceLogout
+	 */
+	public function setForceLogout($forceLogout)
+	{
+		$this->forcelogout = $forceLogout ? 1 : 0;
+	}
+
+	/**
+	 * Gets the user's confirmation diff. Unused if OAuth is in use.
+	 * @return int the diff ID
+	 */
+	public function getConfirmationDiff()
+	{
+		return $this->confirmationdiff;
+	}
+
+	/**
+	 * Sets the user's confirmation diff.
+	 *
+	 * @param int $confirmationDiff
+	 */
+	public function setConfirmationDiff($confirmationDiff)
+	{
+		$this->confirmationdiff = $confirmationDiff;
+	}
+
+	#endregion
+
+	#region user access checks
+
+	public function isActive()
+	{
+		return $this->status == self::STATUS_ACTIVE;
+	}
+
+	/**
+	 * Tests if the user is identified
+	 *
+	 * @param IdentificationVerifier $iv
+	 *
+	 * @return bool
+	 * @todo     Figure out what on earth is going on with PDO's typecasting here.  Apparently, it returns string("0") for
+	 *       the force-unidentified case, and int(1) for the identified case?!  This is quite ugly, but probably needed
+	 *       to play it safe for now.
+	 * @category Security-Critical
+	 */
+	public function isIdentified(IdentificationVerifier $iv)
+	{
+		if ($this->forceidentified === 0 || $this->forceidentified === "0") {
+			// User forced to unidentified in the database.
+			return false;
+		}
+		elseif ($this->forceidentified === 1 || $this->forceidentified === "1") {
+			// User forced to identified in the database.
+			return true;
+		}
+		else {
+			// User not forced to any particular identified status; consult IdentificationVerifier
+			return $iv->isUserIdentified($this->getOnWikiName());
+		}
+	}
+
+	/**
+	 * DO NOT USE FOR TESTING IDENTIFICATION STATUS.
+	 *
+	 * @return bool|null
+	 */
+	public function getForceIdentified()
+	{
+		return $this->forceidentified;
+	}
+
+	/**
+	 * Tests if the user is suspended
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isSuspended()
+	{
+		return $this->status == self::STATUS_SUSPENDED;
+	}
+
+	/**
+	 * Tests if the user is new
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isNewUser()
+	{
+		return $this->status == self::STATUS_NEW;
+	}
+
+	/**
+	 * Tests if the user has been declined access to the tool
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isDeclined()
+	{
+		return $this->status == self::STATUS_DECLINED;
+	}
+
+	/**
+	 * Tests if the user is the community user
+	 *
+	 * @todo     decide if this means logged out. I think it usually does.
+	 * @return bool
+	 * @category Security-Critical
+	 */
+	public function isCommunityUser()
+	{
+		return false;
+	}
+
+	#endregion 
+
+	/**
+	 * Gets the approval date of the user
+	 * @return DateTime|false
+	 */
+	public function getApprovalDate()
+	{
+		$query = $this->dbObject->prepare(<<<SQL
 			SELECT timestamp 
 			FROM log 
 			WHERE objectid = :userid
@@ -475,12 +475,12 @@ 
 			ORDER BY id DESC 
 			LIMIT 1;
 SQL
-        );
-        $query->execute(array(":userid" => $this->id));
+		);
+		$query->execute(array(":userid" => $this->id));
 
-        $data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
-        $query->closeCursor();
+		$data = DateTime::createFromFormat("Y-m-d H:i:s", $query->fetchColumn());
+		$query->closeCursor();
 
-        return $data;
-    }
+		return $data;
+	}
 }

includes/DataObjects/Ban.php

Indentation +363 added lines, -363 removed lines

@@ -19,66 +19,66 @@ 
  */
 class Ban extends DataObject
 {
-    const ACTION_BLOCK = 'block';
-    const ACTION_DROP = 'drop';
-    const ACTION_DEFER = 'defer';
-    const ACTION_NONE = 'none';
-
-    /** @var string|null */
-    private $name;
-    /** @var string|null */
-    private $ip;
-    /** @var int|null */
-    private $ipmask;
-    /** @var string|null */
-    private $email;
-    /** @var string|null */
-    private $useragent;
-
-    private $user;
-    private $reason;
-    private $date;
-    private $duration;
-    private $active;
-    private $action = self::ACTION_BLOCK;
-    private $targetqueue;
-    private $visibility = 'user';
-    private ?int $domain;
-
-    /**
-     * Gets all active bans, filtered by the optional target.
-     *
-     * @return Ban[]
-     */
-    public static function getActiveBans(PdoDatabase $database, int $domain)
-    {
-        $query = <<<SQL
+	const ACTION_BLOCK = 'block';
+	const ACTION_DROP = 'drop';
+	const ACTION_DEFER = 'defer';
+	const ACTION_NONE = 'none';
+
+	/** @var string|null */
+	private $name;
+	/** @var string|null */
+	private $ip;
+	/** @var int|null */
+	private $ipmask;
+	/** @var string|null */
+	private $email;
+	/** @var string|null */
+	private $useragent;
+
+	private $user;
+	private $reason;
+	private $date;
+	private $duration;
+	private $active;
+	private $action = self::ACTION_BLOCK;
+	private $targetqueue;
+	private $visibility = 'user';
+	private ?int $domain;
+
+	/**
+	 * Gets all active bans, filtered by the optional target.
+	 *
+	 * @return Ban[]
+	 */
+	public static function getActiveBans(PdoDatabase $database, int $domain)
+	{
+		$query = <<<SQL
 SELECT * FROM ban 
 WHERE (duration > UNIX_TIMESTAMP() OR duration is null) 
     AND active = 1
     AND (domain IS NULL OR domain = :domain);
 SQL;
-        $statement = $database->prepare($query);
-        $statement->execute([':domain' => $domain]);
-        $result = array();
-
-        /** @var Ban $v */
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
-
-        return $result;
-    }
-
-    /**
-     * Gets a ban by its ID if it's currently active.
-     *
-     * @return Ban|false
-     */
-    public static function getActiveId($id, PdoDatabase $database, int $domain)
-    {
-        $statement = $database->prepare(<<<SQL
+		$statement = $database->prepare($query);
+		$statement->execute([':domain' => $domain]);
+		$result = array();
+
+		/** @var Ban $v */
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Gets a ban by its ID if it's currently active.
+	 *
+	 * @return Ban|false
+	 */
+	public static function getActiveId($id, PdoDatabase $database, int $domain)
+	{
+		$statement = $database->prepare(<<<SQL
 SELECT *
 FROM ban
 WHERE id = :id  
@@ -86,332 +86,332 @@ 
   AND (duration > UNIX_TIMESTAMP() OR duration is null) 
   AND active = 1;
 SQL
-        );
-        $statement->bindValue(":id", $id);
-        $statement->bindValue(":domain", $domain);
+		);
+		$statement->bindValue(":id", $id);
+		$statement->bindValue(":domain", $domain);
 
-        $statement->execute();
+		$statement->execute();
 
-        $resultObject = $statement->fetchObject(get_called_class());
+		$resultObject = $statement->fetchObject(get_called_class());
 
-        if ($resultObject !== false) {
-            $resultObject->setDatabase($database);
-        }
+		if ($resultObject !== false) {
+			$resultObject->setDatabase($database);
+		}
 
-        return $resultObject;
-    }
+		return $resultObject;
+	}
 
-    public static function getByIdList($values, PdoDatabase $database, int $domain): array
-    {
-        if (count($values) === 0) {
-            return [];
-        }
+	public static function getByIdList($values, PdoDatabase $database, int $domain): array
+	{
+		if (count($values) === 0) {
+			return [];
+		}
 
-        // use the provided array to produce a list of question marks of the same length as the array.
-        $valueCount = count($values);
-        $inSection = str_repeat('?,', $valueCount - 1) . '?';
+		// use the provided array to produce a list of question marks of the same length as the array.
+		$valueCount = count($values);
+		$inSection = str_repeat('?,', $valueCount - 1) . '?';
 
-        // this is still parameterised! It's using positional parameters instead of named ones.
-        $query = 'SELECT * FROM ban WHERE id IN (' . $inSection . ')';
+		// this is still parameterised! It's using positional parameters instead of named ones.
+		$query = 'SELECT * FROM ban WHERE id IN (' . $inSection . ')';
 
-        $query .= ' AND (domain IS NULL OR domain = ?)';
-        $values[] = $domain;
+		$query .= ' AND (domain IS NULL OR domain = ?)';
+		$values[] = $domain;
 
-        $statement = $database->prepare($query);
+		$statement = $database->prepare($query);
 
-        // execute the statement with the provided parameter list.
-        $statement->execute($values);
+		// execute the statement with the provided parameter list.
+		$statement->execute($values);
 
-        $result = [];
-        foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
-            $v->setDatabase($database);
-            $result[] = $v;
-        }
+		$result = [];
+		foreach ($statement->fetchAll(PDO::FETCH_CLASS, get_called_class()) as $v) {
+			$v->setDatabase($database);
+			$result[] = $v;
+		}
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            // insert
-            $statement = $this->dbObject->prepare(<<<SQL
+	/**
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			// insert
+			$statement = $this->dbObject->prepare(<<<SQL
 INSERT INTO `ban` (name, email, ip, ipmask, useragent, user, reason, date, duration, active, action, targetqueue, visibility, domain)
 VALUES (:name, :email, :ip, :ipmask, :useragent, :user, :reason, CURRENT_TIMESTAMP(), :duration, :active, :action, :targetqueue, :visibility, :domain);
 SQL
-            );
-
-            $statement->bindValue(":name", $this->name);
-            $statement->bindValue(":email", $this->email);
-            $statement->bindValue(":ip", $this->ip);
-            $statement->bindValue(":ipmask", $this->ipmask);
-            $statement->bindValue(":useragent", $this->useragent);
-
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":reason", $this->reason);
-            $statement->bindValue(":duration", $this->duration);
-            $statement->bindValue(":active", $this->active);
-            $statement->bindValue(":action", $this->action);
-            $statement->bindValue(":targetqueue", $this->targetqueue);
-            $statement->bindValue(":visibility", $this->visibility);
-            $statement->bindValue(":domain", $this->domain);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            // update
-            $statement = $this->dbObject->prepare(<<<SQL
+			);
+
+			$statement->bindValue(":name", $this->name);
+			$statement->bindValue(":email", $this->email);
+			$statement->bindValue(":ip", $this->ip);
+			$statement->bindValue(":ipmask", $this->ipmask);
+			$statement->bindValue(":useragent", $this->useragent);
+
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":reason", $this->reason);
+			$statement->bindValue(":duration", $this->duration);
+			$statement->bindValue(":active", $this->active);
+			$statement->bindValue(":action", $this->action);
+			$statement->bindValue(":targetqueue", $this->targetqueue);
+			$statement->bindValue(":visibility", $this->visibility);
+			$statement->bindValue(":domain", $this->domain);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			// update
+			$statement = $this->dbObject->prepare(<<<SQL
 UPDATE `ban`
 SET active = :active, updateversion = updateversion + 1
 WHERE id = :id AND updateversion = :updateversion;
 SQL
-            );
-            $statement->bindValue(':id', $this->id);
-            $statement->bindValue(':updateversion', $this->updateversion);
-
-            $statement->bindValue(':active', $this->active);
-
-            if (!$statement->execute()) {
-                throw new Exception($statement->errorInfo());
-            }
-
-            if ($statement->rowCount() !== 1) {
-                throw new OptimisticLockFailedException();
-            }
-
-            $this->updateversion++;
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getReason()
-    {
-        return $this->reason;
-    }
-
-    /**
-     * @param string $reason
-     */
-    public function setReason($reason)
-    {
-        $this->reason = $reason;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getDate()
-    {
-        return $this->date;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getDuration()
-    {
-        return $this->duration;
-    }
-
-    /**
-     * @param mixed $duration
-     */
-    public function setDuration($duration)
-    {
-        $this->duration = $duration;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->active == 1;
-    }
-
-    /**
-     * @param bool $active
-     */
-    public function setActive($active)
-    {
-        $this->active = $active ? 1 : 0;
-    }
-
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
-
-    /**
-     * @param int $user UserID of user who is setting the ban
-     */
-    public function setUser($user)
-    {
-        $this->user = $user;
-    }
-
-    /**
-     * @return string
-     */
-    public function getAction(): string
-    {
-        return $this->action;
-    }
-
-    /**
-     * @param string $action
-     */
-    public function setAction(string $action): void
-    {
-        $this->action = $action;
-    }
-
-    /**
-     * @return string
-     */
-    public function getVisibility() : string
-    {
-        return $this->visibility;
-    }
-
-    /**
-     * @param string $visibility
-     */
-    public function setVisibility(string $visibility): void
-    {
-        $this->visibility = $visibility;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getName(): ?string
-    {
-        return $this->name;
-    }
-
-    /**
-     * @param string|null $name
-     */
-    public function setName(?string $name): void
-    {
-        $this->name = $name;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getIp(): ?string
-    {
-        if ($this->ip === null) {
-            return null;
-        }
-
-        return inet_ntop($this->ip);
-    }
-
-    /**
-     * @return int|null
-     */
-    public function getIpMask(): ?int
-    {
-        return $this->ipmask;
-    }
-
-    /**
-     * @param string|null $ip
-     * @param int|null    $mask
-     */
-    public function setIp(?string $ip, ?int $mask): void
-    {
-        if ($ip === null) {
-            $this->ip = null;
-        }
-        else {
-            $this->ip = inet_pton($ip);
-        }
-
-        $this->ipmask = $mask;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getEmail(): ?string
-    {
-        return $this->email;
-    }
-
-    /**
-     * @param string|null $email
-     */
-    public function setEmail(?string $email): void
-    {
-        $this->email = $email;
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getUseragent(): ?string
-    {
-        return $this->useragent;
-    }
-
-    /**
-     * @param string|null $useragent
-     */
-    public function setUseragent(?string $useragent): void
-    {
-        $this->useragent = $useragent;
-    }
-
-    /**
-     * @return int|null
-     */
-    public function getTargetQueue(): ?int
-    {
-        return $this->targetqueue;
-    }
-
-    /**
-     * @return RequestQueue|null
-     */
-    public function getTargetQueueObject(): ?RequestQueue
-    {
-        /** @var RequestQueue $queue */
-        $queue = RequestQueue::getById($this->targetqueue, $this->getDatabase());
-        return $queue === false ? null : $queue;
-    }
-
-    /**
-     * @param int|null $targetQueue
-     */
-    public function setTargetQueue(?int $targetQueue): void
-    {
-        $this->targetqueue = $targetQueue;
-    }
-
-    public function setDomain(?int $domain): void
-    {
-        $this->domain = $domain;
-    }
-
-    public function getDomain(): ?int
-    {
-        return $this->domain;
-    }
+			);
+			$statement->bindValue(':id', $this->id);
+			$statement->bindValue(':updateversion', $this->updateversion);
+
+			$statement->bindValue(':active', $this->active);
+
+			if (!$statement->execute()) {
+				throw new Exception($statement->errorInfo());
+			}
+
+			if ($statement->rowCount() !== 1) {
+				throw new OptimisticLockFailedException();
+			}
+
+			$this->updateversion++;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getReason()
+	{
+		return $this->reason;
+	}
+
+	/**
+	 * @param string $reason
+	 */
+	public function setReason($reason)
+	{
+		$this->reason = $reason;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getDate()
+	{
+		return $this->date;
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getDuration()
+	{
+		return $this->duration;
+	}
+
+	/**
+	 * @param mixed $duration
+	 */
+	public function setDuration($duration)
+	{
+		$this->duration = $duration;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->active == 1;
+	}
+
+	/**
+	 * @param bool $active
+	 */
+	public function setActive($active)
+	{
+		$this->active = $active ? 1 : 0;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * @param int $user UserID of user who is setting the ban
+	 */
+	public function setUser($user)
+	{
+		$this->user = $user;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getAction(): string
+	{
+		return $this->action;
+	}
+
+	/**
+	 * @param string $action
+	 */
+	public function setAction(string $action): void
+	{
+		$this->action = $action;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getVisibility() : string
+	{
+		return $this->visibility;
+	}
+
+	/**
+	 * @param string $visibility
+	 */
+	public function setVisibility(string $visibility): void
+	{
+		$this->visibility = $visibility;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getName(): ?string
+	{
+		return $this->name;
+	}
+
+	/**
+	 * @param string|null $name
+	 */
+	public function setName(?string $name): void
+	{
+		$this->name = $name;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getIp(): ?string
+	{
+		if ($this->ip === null) {
+			return null;
+		}
+
+		return inet_ntop($this->ip);
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public function getIpMask(): ?int
+	{
+		return $this->ipmask;
+	}
+
+	/**
+	 * @param string|null $ip
+	 * @param int|null    $mask
+	 */
+	public function setIp(?string $ip, ?int $mask): void
+	{
+		if ($ip === null) {
+			$this->ip = null;
+		}
+		else {
+			$this->ip = inet_pton($ip);
+		}
+
+		$this->ipmask = $mask;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getEmail(): ?string
+	{
+		return $this->email;
+	}
+
+	/**
+	 * @param string|null $email
+	 */
+	public function setEmail(?string $email): void
+	{
+		$this->email = $email;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getUseragent(): ?string
+	{
+		return $this->useragent;
+	}
+
+	/**
+	 * @param string|null $useragent
+	 */
+	public function setUseragent(?string $useragent): void
+	{
+		$this->useragent = $useragent;
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public function getTargetQueue(): ?int
+	{
+		return $this->targetqueue;
+	}
+
+	/**
+	 * @return RequestQueue|null
+	 */
+	public function getTargetQueueObject(): ?RequestQueue
+	{
+		/** @var RequestQueue $queue */
+		$queue = RequestQueue::getById($this->targetqueue, $this->getDatabase());
+		return $queue === false ? null : $queue;
+	}
+
+	/**
+	 * @param int|null $targetQueue
+	 */
+	public function setTargetQueue(?int $targetQueue): void
+	{
+		$this->targetqueue = $targetQueue;
+	}
+
+	public function setDomain(?int $domain): void
+	{
+		$this->domain = $domain;
+	}
+
+	public function getDomain(): ?int
+	{
+		return $this->domain;
+	}
 }

includes/DataObjects/UserRole.php

Indentation +102 added lines, -102 removed lines

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

includes/DataObjects/Log.php

Indentation +157 added lines, -157 removed lines

@@ -17,164 +17,164 @@
  */
 class Log extends DataObject
 {
-    /** @var int */
-    private $objectid;
-    /** @var string */
-    private $objecttype;
-    /** @var int */
-    private $user;
-    /** @var string */
-    private $action;
-    private $timestamp;
-    /** @var string|null */
-    private $comment;
-    /** @var int|null */
-    private $domain;
-
-    /**
-     * @throws Exception
-     */
-    public function save()
-    {
-        if ($this->isNew()) {
-            $statement = $this->dbObject->prepare(<<<SQL
+	/** @var int */
+	private $objectid;
+	/** @var string */
+	private $objecttype;
+	/** @var int */
+	private $user;
+	/** @var string */
+	private $action;
+	private $timestamp;
+	/** @var string|null */
+	private $comment;
+	/** @var int|null */
+	private $domain;
+
+	/**
+	 * @throws Exception
+	 */
+	public function save()
+	{
+		if ($this->isNew()) {
+			$statement = $this->dbObject->prepare(<<<SQL
                 INSERT INTO log (objectid, objecttype, user, action, timestamp, comment, domain) 
                 VALUES (:id, :type, :user, :action, CURRENT_TIMESTAMP(), :comment, :domain);
 SQL
-            );
-
-            $statement->bindValue(":id", $this->objectid);
-            $statement->bindValue(":type", $this->objecttype);
-            $statement->bindValue(":user", $this->user);
-            $statement->bindValue(":action", $this->action);
-            $statement->bindValue(":comment", $this->comment);
-            $statement->bindValue(":domain", $this->domain);
-
-            if ($statement->execute()) {
-                $this->id = (int)$this->dbObject->lastInsertId();
-            }
-            else {
-                throw new Exception($statement->errorInfo());
-            }
-        }
-        else {
-            throw new Exception("Updating logs is not available");
-        }
-    }
-
-    /**
-     * @throws Exception
-     */
-    public function delete()
-    {
-        throw new Exception("Deleting logs is not available.");
-    }
-
-    /**
-     * @return int
-     */
-    public function getObjectId()
-    {
-        return $this->objectid;
-    }
-
-    /**
-     * Summary of setObjectId
-     *
-     * @param int $objectId
-     */
-    public function setObjectId($objectId)
-    {
-        $this->objectid = $objectId;
-    }
-
-    /**
-     * @return string
-     */
-    public function getObjectType()
-    {
-        return $this->objecttype;
-    }
-
-    /**
-     * Summary of setObjectType
-     *
-     * @param string $objectType
-     */
-    public function setObjectType($objectType)
-    {
-        $this->objecttype = $objectType;
-    }
-
-    /**
-     * @return int
-     */
-    public function getUser()
-    {
-        return $this->user;
-    }
-
-    /**
-     * Summary of setUser
-     *
-     * @param User $user
-     */
-    public function setUser(User $user)
-    {
-        $this->user = $user->getId();
-    }
-
-    /**
-     * @return string
-     */
-    public function getAction()
-    {
-        return $this->action;
-    }
-
-    /**
-     * Summary of setAction
-     *
-     * @param string $action
-     */
-    public function setAction($action)
-    {
-        $this->action = $action;
-    }
-
-    /**
-     * @return DateTimeImmutable
-     */
-    public function getTimestamp()
-    {
-        return new DateTimeImmutable($this->timestamp);
-    }
-
-    /**
-     * @return string|null
-     */
-    public function getComment()
-    {
-        return $this->comment;
-    }
-
-    /**
-     * Summary of setComment
-     *
-     * @param string $comment
-     */
-    public function setComment($comment)
-    {
-        $this->comment = $comment;
-    }
-
-    public function getDomain(): ?int
-    {
-        return $this->domain;
-    }
-
-    public function setDomain(?int $domain): void
-    {
-        $this->domain = $domain;
-    }
+			);
+
+			$statement->bindValue(":id", $this->objectid);
+			$statement->bindValue(":type", $this->objecttype);
+			$statement->bindValue(":user", $this->user);
+			$statement->bindValue(":action", $this->action);
+			$statement->bindValue(":comment", $this->comment);
+			$statement->bindValue(":domain", $this->domain);
+
+			if ($statement->execute()) {
+				$this->id = (int)$this->dbObject->lastInsertId();
+			}
+			else {
+				throw new Exception($statement->errorInfo());
+			}
+		}
+		else {
+			throw new Exception("Updating logs is not available");
+		}
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function delete()
+	{
+		throw new Exception("Deleting logs is not available.");
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getObjectId()
+	{
+		return $this->objectid;
+	}
+
+	/**
+	 * Summary of setObjectId
+	 *
+	 * @param int $objectId
+	 */
+	public function setObjectId($objectId)
+	{
+		$this->objectid = $objectId;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getObjectType()
+	{
+		return $this->objecttype;
+	}
+
+	/**
+	 * Summary of setObjectType
+	 *
+	 * @param string $objectType
+	 */
+	public function setObjectType($objectType)
+	{
+		$this->objecttype = $objectType;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUser()
+	{
+		return $this->user;
+	}
+
+	/**
+	 * Summary of setUser
+	 *
+	 * @param User $user
+	 */
+	public function setUser(User $user)
+	{
+		$this->user = $user->getId();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getAction()
+	{
+		return $this->action;
+	}
+
+	/**
+	 * Summary of setAction
+	 *
+	 * @param string $action
+	 */
+	public function setAction($action)
+	{
+		$this->action = $action;
+	}
+
+	/**
+	 * @return DateTimeImmutable
+	 */
+	public function getTimestamp()
+	{
+		return new DateTimeImmutable($this->timestamp);
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getComment()
+	{
+		return $this->comment;
+	}
+
+	/**
+	 * Summary of setComment
+	 *
+	 * @param string $comment
+	 */
+	public function setComment($comment)
+	{
+		$this->comment = $comment;
+	}
+
+	public function getDomain(): ?int
+	{
+		return $this->domain;
+	}
+
+	public function setDomain(?int $domain): void
+	{
+		$this->domain = $domain;
+	}
 }

includes/Security/RoleConfiguration.php

Indentation +449 added lines, -449 removed lines

@@ -55,481 +55,481 @@
 
 class RoleConfiguration
 {
-    const ACCESS_ALLOW = 1;
-    const ACCESS_DENY = -1;
-    const ACCESS_DEFAULT = 0;
-    const MAIN = 'main';
-    const ALL = '*';
+	const ACCESS_ALLOW = 1;
+	const ACCESS_DENY = -1;
+	const ACCESS_DEFAULT = 0;
+	const MAIN = 'main';
+	const ALL = '*';
 
-    /**
-     * A map of roles to rights
-     *
-     * For example:
-     *
-     * array(
-     *   'myRole' => array(
-     *       PageMyPage::class => array(
-     *           'edit' => self::ACCESS_ALLOW,
-     *           'create' => self::ACCESS_DENY,
-     *       )
-     *   )
-     * )
-     *
-     * Note that DENY takes precedence over everything else when roles are combined, followed by ALLOW, followed by
-     * DEFAULT. Thus, if you have the following ([A]llow, [D]eny, [-] (default)) grants in different roles, this should
-     * be the expected result:
-     *
-     * - (-,-,-) = - (default because nothing to explicitly say allowed or denied equates to a denial)
-     * - (A,-,-) = A
-     * - (D,-,-) = D
-     * - (A,D,-) = D (deny takes precedence over allow)
-     * - (A,A,A) = A (repetition has no effect)
-     *
-     * The public role is special, and is applied to all users automatically. Avoid using deny on this role.
-     *
-     * @var array
-     */
-    private array $roleConfig = array(
-        'public'            => array(
-            /*
+	/**
+	 * A map of roles to rights
+	 *
+	 * For example:
+	 *
+	 * array(
+	 *   'myRole' => array(
+	 *       PageMyPage::class => array(
+	 *           'edit' => self::ACCESS_ALLOW,
+	 *           'create' => self::ACCESS_DENY,
+	 *       )
+	 *   )
+	 * )
+	 *
+	 * Note that DENY takes precedence over everything else when roles are combined, followed by ALLOW, followed by
+	 * DEFAULT. Thus, if you have the following ([A]llow, [D]eny, [-] (default)) grants in different roles, this should
+	 * be the expected result:
+	 *
+	 * - (-,-,-) = - (default because nothing to explicitly say allowed or denied equates to a denial)
+	 * - (A,-,-) = A
+	 * - (D,-,-) = D
+	 * - (A,D,-) = D (deny takes precedence over allow)
+	 * - (A,A,A) = A (repetition has no effect)
+	 *
+	 * The public role is special, and is applied to all users automatically. Avoid using deny on this role.
+	 *
+	 * @var array
+	 */
+	private array $roleConfig = array(
+		'public'            => array(
+			/*
              * THIS ROLE IS GRANTED TO ALL LOGGED *OUT* USERS IMPLICITLY.
              *
              * USERS IN THIS ROLE DO NOT HAVE TO BE IDENTIFIED TO GET THE RIGHTS CONFERRED HERE.
              * DO NOT ADD ANY SECURITY-SENSITIVE RIGHTS HERE.
              */
-            '_childRoles'   => array(
-                'publicStats',
-            ),
-            PageTeam::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageXffDemo::class        => array(
-                self::MAIN  => self::ACCESS_ALLOW,
-            )
-        ),
-        'loggedIn'          => array(
-            /*
+			'_childRoles'   => array(
+				'publicStats',
+			),
+			PageTeam::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageXffDemo::class        => array(
+				self::MAIN  => self::ACCESS_ALLOW,
+			)
+		),
+		'loggedIn'          => array(
+			/*
              * THIS ROLE IS GRANTED TO ALL LOGGED-IN USERS IMPLICITLY.
              *
              * USERS IN THIS ROLE DO NOT HAVE TO BE IDENTIFIED TO GET THE RIGHTS CONFERRED HERE.
              * DO NOT ADD ANY SECURITY-SENSITIVE RIGHTS HERE.
              */
-            '_childRoles'             => array(
-                'public',
-            ),
-            PagePreferences::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'refreshOAuth' => self::ACCESS_ALLOW,
-            ),
-            PageChangePassword::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageMultiFactor::class    => array(
-                self::MAIN          => self::ACCESS_ALLOW,
-                'scratch'           => self::ACCESS_ALLOW,
-                'enableYubikeyOtp'  => self::ACCESS_ALLOW,
-                'enableTotp'        => self::ACCESS_ALLOW,
-                // allow a user to disable this even when they're not allowed to enable it
-                'disableYubikeyOtp' => self::ACCESS_ALLOW,
-                'disableTotp'       => self::ACCESS_ALLOW,
-            ),
-            PageOAuth::class          => array(
-                'attach' => self::ACCESS_ALLOW,
-                'detach' => self::ACCESS_ALLOW,
-            ),
-            PageDomainSwitch::class   => array(
-                self::MAIN => self::ACCESS_ALLOW
-            )
-        ),
-        'user'              => array(
-            '_description'                       => 'A standard tool user.',
-            '_editableBy'                        => array('admin', 'toolRoot'),
-            '_childRoles'                        => array(
-                'internalStats',
-            ),
-            PageMain::class                      => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageBan::class                       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'show'     => self::ACCESS_ALLOW,
-            ),
-            'BanVisibility'             => array(
-                'user' => self::ACCESS_ALLOW,
-            ),
-            'BanType'                   => array(
-                'ip' => self::ACCESS_ALLOW,
-                'name' => self::ACCESS_ALLOW,
-            ),
-            PageEditComment::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageEmailManagement::class           => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-            ),
-            PageExpandedRequestList::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageLog::class                       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageSearch::class                    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'byName'   => self::ACCESS_ALLOW,
-                'byEmail'  => self::ACCESS_ALLOW,
-                'byIp'     => self::ACCESS_ALLOW,
-                'allowNonConfirmed' => self::ACCESS_ALLOW,
-            ),
-            PageWelcomeTemplateManagement::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'select'   => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-            ),
-            PageViewRequest::class               => array(
-                self::MAIN       => self::ACCESS_ALLOW,
-                'seeAllRequests' => self::ACCESS_ALLOW,
-            ),
-            'RequestData'                        => array(
-                'seePrivateDataWhenReserved' => self::ACCESS_ALLOW,
-                'seePrivateDataWithHash'     => self::ACCESS_ALLOW,
-                'seeRelatedRequests'         => self::ACCESS_ALLOW,
-            ),
-            PageCustomClose::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageComment::class                   => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageFlagComment::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageCloseRequest::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageCreateRequest::class             => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageDeferRequest::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageDropRequest::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageReservation::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageSendToUser::class                => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageBreakReservation::class          => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageJobQueue::class                  => array(
-                self::MAIN    => self::ACCESS_ALLOW,
-                'view'        => self::ACCESS_ALLOW,
-                'all'         => self::ACCESS_ALLOW,
-                'acknowledge' => self::ACCESS_ALLOW,
-                'cancel'      => self::ACCESS_ALLOW
-            ),
-            PageDomainManagement::class          => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageRequestFormManagement::class     => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'view'     => self::ACCESS_ALLOW,
-                'preview'  => self::ACCESS_ALLOW,
-            ),
-            'RequestCreation'                    => array(
-                PreferenceManager::CREATION_MANUAL => self::ACCESS_ALLOW,
-                PreferenceManager::CREATION_OAUTH  => self::ACCESS_ALLOW,
-            ),
-            'GlobalInfo'                         => array(
-                'viewSiteNotice' => self::ACCESS_ALLOW,
-                'viewOnlineUsers' => self::ACCESS_ALLOW,
-            ),
-        ),
-        'admin'             => array(
-            '_description'                       => 'A tool administrator.',
-            '_editableBy'                        => array('admin', 'toolRoot'),
-            '_childRoles'                        => array(
-                'user',
-                'requestAdminTools',
-            ),
-            PageEmailManagement::class           => array(
-                'edit'   => self::ACCESS_ALLOW,
-                'create' => self::ACCESS_ALLOW,
-            ),
-            PageSiteNotice::class                => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageUserManagement::class            => array(
-                self::MAIN  => self::ACCESS_ALLOW,
-                'approve'   => self::ACCESS_ALLOW,
-                'decline'   => self::ACCESS_ALLOW,
-                'rename'    => self::ACCESS_ALLOW,
-                'editUser'  => self::ACCESS_ALLOW,
-                'suspend'   => self::ACCESS_ALLOW,
-                'editRoles' => self::ACCESS_ALLOW,
-            ),
-            PageSearch::class                    => array(
-                'byComment' => self::ACCESS_ALLOW,
-            ),
-            PageManuallyConfirm::class               => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            PageWelcomeTemplateManagement::class => array(
-                'edit'   => self::ACCESS_ALLOW,
-                'delete' => self::ACCESS_ALLOW,
-                'add'    => self::ACCESS_ALLOW,
-            ),
-            PageJobQueue::class                  => array(
-                'acknowledge' => self::ACCESS_ALLOW,
-                'requeue'     => self::ACCESS_ALLOW,
-                'cancel'      => self::ACCESS_ALLOW,
-            ),
-            'RequestData'               => array(
-                'reopenClearedRequest'  => self::ACCESS_ALLOW,
-            ),
-            PageQueueManagement::class           => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'edit'     => self::ACCESS_ALLOW,
-                'create'   => self::ACCESS_ALLOW,
-            ),
-            PageRequestFormManagement::class     => array(
-                'edit'     => self::ACCESS_ALLOW,
-                'create'   => self::ACCESS_ALLOW,
-            ),
-            PageDomainManagement::class          => array(
-                'edit'     => self::ACCESS_ALLOW,
-            ),
-        ),
-        'checkuser'         => array(
-            '_description'            => 'A user with CheckUser access',
-            '_editableBy'             => array('checkuser', 'steward', 'toolRoot'),
-            '_childRoles'             => array(
-                'user',
-                'requestAdminTools',
-            ),
-            PageUserManagement::class => array(
-                self::MAIN  => self::ACCESS_ALLOW,
-                'suspend'   => self::ACCESS_ALLOW,
-                'editRoles' => self::ACCESS_ALLOW,
-            ),
-            'RequestData'             => array(
-                'seeUserAgentData'      => self::ACCESS_ALLOW,
-                'seeCheckuserComments'  => self::ACCESS_ALLOW,
-                'createLocalAccount'    => self::ACCESS_ALLOW,
-            ),
-            'BanType'                   => array(
-                'useragent' => self::ACCESS_ALLOW,
-            ),
-            'BanVisibility'             => array(
-                'checkuser' => self::ACCESS_ALLOW,
-            ),
-        ),
-        'steward'         => array(
-            '_description'  => 'A user with Steward access',
-            '_editableBy'   => array('steward', 'toolRoot'),
-            '_globalOnly'   => true,
-            '_childRoles'   => array(
-                'user',
-                'checkuser',
-            ),
-            'BanType'                   => array(
-                'ip-largerange' => self::ACCESS_ALLOW,
-                'global'        => self::ACCESS_ALLOW,
-            ),
-        ),
-        'toolRoot'          => array(
-            '_description' => 'A user with shell access to the servers running the tool',
-            '_editableBy'  => array('toolRoot'),
-            '_globalOnly'  => true,
-            '_childRoles'  => array(
-                'admin',
-            ),
-            'BanType'                   => array(
-                'ip-largerange' => self::ACCESS_ALLOW,
-                'global'        => self::ACCESS_ALLOW,
-            ),
-            PageDomainManagement::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'editAll'  => self::ACCESS_ALLOW,
-                'edit'     => self::ACCESS_ALLOW,
-                'create'   => self::ACCESS_ALLOW,
-            ),
-            PageErrorLogViewer::class => array(
-                self::MAIN      => self::ACCESS_ALLOW,
-                'view'          => self::ACCESS_ALLOW,
-                'remove'        => self::ACCESS_ALLOW,
-            ),
-        ),
-        'botCreation'       => array(
-            '_hidden'         => true,
-            '_description'    => 'A user allowed to use the bot to perform account creations',
-            '_editableBy'     => array('admin', 'toolRoot'),
-            '_childRoles'     => array(),
-            'RequestCreation' => array(
-                PreferenceManager::CREATION_BOT => self::ACCESS_ALLOW,
-            ),
-        ),
+			'_childRoles'             => array(
+				'public',
+			),
+			PagePreferences::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'refreshOAuth' => self::ACCESS_ALLOW,
+			),
+			PageChangePassword::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageMultiFactor::class    => array(
+				self::MAIN          => self::ACCESS_ALLOW,
+				'scratch'           => self::ACCESS_ALLOW,
+				'enableYubikeyOtp'  => self::ACCESS_ALLOW,
+				'enableTotp'        => self::ACCESS_ALLOW,
+				// allow a user to disable this even when they're not allowed to enable it
+				'disableYubikeyOtp' => self::ACCESS_ALLOW,
+				'disableTotp'       => self::ACCESS_ALLOW,
+			),
+			PageOAuth::class          => array(
+				'attach' => self::ACCESS_ALLOW,
+				'detach' => self::ACCESS_ALLOW,
+			),
+			PageDomainSwitch::class   => array(
+				self::MAIN => self::ACCESS_ALLOW
+			)
+		),
+		'user'              => array(
+			'_description'                       => 'A standard tool user.',
+			'_editableBy'                        => array('admin', 'toolRoot'),
+			'_childRoles'                        => array(
+				'internalStats',
+			),
+			PageMain::class                      => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageBan::class                       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'show'     => self::ACCESS_ALLOW,
+			),
+			'BanVisibility'             => array(
+				'user' => self::ACCESS_ALLOW,
+			),
+			'BanType'                   => array(
+				'ip' => self::ACCESS_ALLOW,
+				'name' => self::ACCESS_ALLOW,
+			),
+			PageEditComment::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageEmailManagement::class           => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+			),
+			PageExpandedRequestList::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageLog::class                       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageSearch::class                    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'byName'   => self::ACCESS_ALLOW,
+				'byEmail'  => self::ACCESS_ALLOW,
+				'byIp'     => self::ACCESS_ALLOW,
+				'allowNonConfirmed' => self::ACCESS_ALLOW,
+			),
+			PageWelcomeTemplateManagement::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'select'   => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+			),
+			PageViewRequest::class               => array(
+				self::MAIN       => self::ACCESS_ALLOW,
+				'seeAllRequests' => self::ACCESS_ALLOW,
+			),
+			'RequestData'                        => array(
+				'seePrivateDataWhenReserved' => self::ACCESS_ALLOW,
+				'seePrivateDataWithHash'     => self::ACCESS_ALLOW,
+				'seeRelatedRequests'         => self::ACCESS_ALLOW,
+			),
+			PageCustomClose::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageComment::class                   => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageFlagComment::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageCloseRequest::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageCreateRequest::class             => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageDeferRequest::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageDropRequest::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageReservation::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageSendToUser::class                => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageBreakReservation::class          => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageJobQueue::class                  => array(
+				self::MAIN    => self::ACCESS_ALLOW,
+				'view'        => self::ACCESS_ALLOW,
+				'all'         => self::ACCESS_ALLOW,
+				'acknowledge' => self::ACCESS_ALLOW,
+				'cancel'      => self::ACCESS_ALLOW
+			),
+			PageDomainManagement::class          => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageRequestFormManagement::class     => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'view'     => self::ACCESS_ALLOW,
+				'preview'  => self::ACCESS_ALLOW,
+			),
+			'RequestCreation'                    => array(
+				PreferenceManager::CREATION_MANUAL => self::ACCESS_ALLOW,
+				PreferenceManager::CREATION_OAUTH  => self::ACCESS_ALLOW,
+			),
+			'GlobalInfo'                         => array(
+				'viewSiteNotice' => self::ACCESS_ALLOW,
+				'viewOnlineUsers' => self::ACCESS_ALLOW,
+			),
+		),
+		'admin'             => array(
+			'_description'                       => 'A tool administrator.',
+			'_editableBy'                        => array('admin', 'toolRoot'),
+			'_childRoles'                        => array(
+				'user',
+				'requestAdminTools',
+			),
+			PageEmailManagement::class           => array(
+				'edit'   => self::ACCESS_ALLOW,
+				'create' => self::ACCESS_ALLOW,
+			),
+			PageSiteNotice::class                => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageUserManagement::class            => array(
+				self::MAIN  => self::ACCESS_ALLOW,
+				'approve'   => self::ACCESS_ALLOW,
+				'decline'   => self::ACCESS_ALLOW,
+				'rename'    => self::ACCESS_ALLOW,
+				'editUser'  => self::ACCESS_ALLOW,
+				'suspend'   => self::ACCESS_ALLOW,
+				'editRoles' => self::ACCESS_ALLOW,
+			),
+			PageSearch::class                    => array(
+				'byComment' => self::ACCESS_ALLOW,
+			),
+			PageManuallyConfirm::class               => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			PageWelcomeTemplateManagement::class => array(
+				'edit'   => self::ACCESS_ALLOW,
+				'delete' => self::ACCESS_ALLOW,
+				'add'    => self::ACCESS_ALLOW,
+			),
+			PageJobQueue::class                  => array(
+				'acknowledge' => self::ACCESS_ALLOW,
+				'requeue'     => self::ACCESS_ALLOW,
+				'cancel'      => self::ACCESS_ALLOW,
+			),
+			'RequestData'               => array(
+				'reopenClearedRequest'  => self::ACCESS_ALLOW,
+			),
+			PageQueueManagement::class           => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'edit'     => self::ACCESS_ALLOW,
+				'create'   => self::ACCESS_ALLOW,
+			),
+			PageRequestFormManagement::class     => array(
+				'edit'     => self::ACCESS_ALLOW,
+				'create'   => self::ACCESS_ALLOW,
+			),
+			PageDomainManagement::class          => array(
+				'edit'     => self::ACCESS_ALLOW,
+			),
+		),
+		'checkuser'         => array(
+			'_description'            => 'A user with CheckUser access',
+			'_editableBy'             => array('checkuser', 'steward', 'toolRoot'),
+			'_childRoles'             => array(
+				'user',
+				'requestAdminTools',
+			),
+			PageUserManagement::class => array(
+				self::MAIN  => self::ACCESS_ALLOW,
+				'suspend'   => self::ACCESS_ALLOW,
+				'editRoles' => self::ACCESS_ALLOW,
+			),
+			'RequestData'             => array(
+				'seeUserAgentData'      => self::ACCESS_ALLOW,
+				'seeCheckuserComments'  => self::ACCESS_ALLOW,
+				'createLocalAccount'    => self::ACCESS_ALLOW,
+			),
+			'BanType'                   => array(
+				'useragent' => self::ACCESS_ALLOW,
+			),
+			'BanVisibility'             => array(
+				'checkuser' => self::ACCESS_ALLOW,
+			),
+		),
+		'steward'         => array(
+			'_description'  => 'A user with Steward access',
+			'_editableBy'   => array('steward', 'toolRoot'),
+			'_globalOnly'   => true,
+			'_childRoles'   => array(
+				'user',
+				'checkuser',
+			),
+			'BanType'                   => array(
+				'ip-largerange' => self::ACCESS_ALLOW,
+				'global'        => self::ACCESS_ALLOW,
+			),
+		),
+		'toolRoot'          => array(
+			'_description' => 'A user with shell access to the servers running the tool',
+			'_editableBy'  => array('toolRoot'),
+			'_globalOnly'  => true,
+			'_childRoles'  => array(
+				'admin',
+			),
+			'BanType'                   => array(
+				'ip-largerange' => self::ACCESS_ALLOW,
+				'global'        => self::ACCESS_ALLOW,
+			),
+			PageDomainManagement::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'editAll'  => self::ACCESS_ALLOW,
+				'edit'     => self::ACCESS_ALLOW,
+				'create'   => self::ACCESS_ALLOW,
+			),
+			PageErrorLogViewer::class => array(
+				self::MAIN      => self::ACCESS_ALLOW,
+				'view'          => self::ACCESS_ALLOW,
+				'remove'        => self::ACCESS_ALLOW,
+			),
+		),
+		'botCreation'       => array(
+			'_hidden'         => true,
+			'_description'    => 'A user allowed to use the bot to perform account creations',
+			'_editableBy'     => array('admin', 'toolRoot'),
+			'_childRoles'     => array(),
+			'RequestCreation' => array(
+				PreferenceManager::CREATION_BOT => self::ACCESS_ALLOW,
+			),
+		),
 
-        // Child roles go below this point
-        'publicStats'       => array(
-            '_hidden'               => true,
-            StatsUsers::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'detail'   => self::ACCESS_ALLOW,
-            ),
-            StatsTopCreators::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsMonthlyStats::class     => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-        ),
-        'internalStats'     => array(
-            '_hidden'                    => true,
-            StatsMain::class             => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsFastCloses::class       => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsInactiveUsers::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsReservedRequests::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            StatsTemplateStats::class    => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-        ),
-        'requestAdminTools' => array(
-            '_hidden'                   => true,
-            PageBan::class              => array(
-                self::MAIN => self::ACCESS_ALLOW,
-                'set'      => self::ACCESS_ALLOW,
-                'remove'   => self::ACCESS_ALLOW,
-                'replace'  => self::ACCESS_ALLOW,
-            ),
-            'BanType'                   => array(
-                'ip' => self::ACCESS_ALLOW,
-                'email' => self::ACCESS_ALLOW,
-                'name' => self::ACCESS_ALLOW,
-            ),
-            'BanVisibility'             => array(
-                'user' => self::ACCESS_ALLOW,
-                'admin' => self::ACCESS_ALLOW,
-            ),
-            PageEditComment::class      => array(
-                'editOthers' => self::ACCESS_ALLOW,
-            ),
-            PageBreakReservation::class => array(
-                'force' => self::ACCESS_ALLOW,
-            ),
-            PageCustomClose::class      => array(
-                'skipCcMailingList' => self::ACCESS_ALLOW,
-            ),
-            PageFlagComment::class      => array(
-                'unflag'   => self::ACCESS_ALLOW,
-            ),
-            PageListFlaggedComments::class => array(
-                self::MAIN => self::ACCESS_ALLOW,
-            ),
-            'RequestData'               => array(
-                'reopenOldRequest'      => self::ACCESS_ALLOW,
-                'alwaysSeePrivateData'  => self::ACCESS_ALLOW,
-                'alwaysSeeHash'         => self::ACCESS_ALLOW,
-                'seeRestrictedComments' => self::ACCESS_ALLOW,
-            ),
-        ),
-    );
+		// Child roles go below this point
+		'publicStats'       => array(
+			'_hidden'               => true,
+			StatsUsers::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'detail'   => self::ACCESS_ALLOW,
+			),
+			StatsTopCreators::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsMonthlyStats::class     => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+		),
+		'internalStats'     => array(
+			'_hidden'                    => true,
+			StatsMain::class             => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsFastCloses::class       => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsInactiveUsers::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsReservedRequests::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			StatsTemplateStats::class    => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+		),
+		'requestAdminTools' => array(
+			'_hidden'                   => true,
+			PageBan::class              => array(
+				self::MAIN => self::ACCESS_ALLOW,
+				'set'      => self::ACCESS_ALLOW,
+				'remove'   => self::ACCESS_ALLOW,
+				'replace'  => self::ACCESS_ALLOW,
+			),
+			'BanType'                   => array(
+				'ip' => self::ACCESS_ALLOW,
+				'email' => self::ACCESS_ALLOW,
+				'name' => self::ACCESS_ALLOW,
+			),
+			'BanVisibility'             => array(
+				'user' => self::ACCESS_ALLOW,
+				'admin' => self::ACCESS_ALLOW,
+			),
+			PageEditComment::class      => array(
+				'editOthers' => self::ACCESS_ALLOW,
+			),
+			PageBreakReservation::class => array(
+				'force' => self::ACCESS_ALLOW,
+			),
+			PageCustomClose::class      => array(
+				'skipCcMailingList' => self::ACCESS_ALLOW,
+			),
+			PageFlagComment::class      => array(
+				'unflag'   => self::ACCESS_ALLOW,
+			),
+			PageListFlaggedComments::class => array(
+				self::MAIN => self::ACCESS_ALLOW,
+			),
+			'RequestData'               => array(
+				'reopenOldRequest'      => self::ACCESS_ALLOW,
+				'alwaysSeePrivateData'  => self::ACCESS_ALLOW,
+				'alwaysSeeHash'         => self::ACCESS_ALLOW,
+				'seeRestrictedComments' => self::ACCESS_ALLOW,
+			),
+		),
+	);
 
-    /** @var array
-     * List of roles which are *exempt* from the identification requirements
-     *
-     * Think twice about adding roles to this list.
-     *
-     * @category Security-Critical
-     */
-    private array $identificationExempt = array('public', 'loggedIn');
+	/** @var array
+	 * List of roles which are *exempt* from the identification requirements
+	 *
+	 * Think twice about adding roles to this list.
+	 *
+	 * @category Security-Critical
+	 */
+	private array $identificationExempt = array('public', 'loggedIn');
 
-    /**
-     * RoleConfiguration constructor.
-     *
-     * @param ?array $roleConfig           Set to non-null to override the default configuration.
-     * @param ?array $identificationExempt Set to non-null to override the default configuration.
-     */
-    public function __construct(array $roleConfig = null, array $identificationExempt = null)
-    {
-        if ($roleConfig !== null) {
-            $this->roleConfig = $roleConfig;
-        }
+	/**
+	 * RoleConfiguration constructor.
+	 *
+	 * @param ?array $roleConfig           Set to non-null to override the default configuration.
+	 * @param ?array $identificationExempt Set to non-null to override the default configuration.
+	 */
+	public function __construct(array $roleConfig = null, array $identificationExempt = null)
+	{
+		if ($roleConfig !== null) {
+			$this->roleConfig = $roleConfig;
+		}
 
-        if ($identificationExempt !== null) {
-            $this->identificationExempt = $identificationExempt;
-        }
-    }
+		if ($identificationExempt !== null) {
+			$this->identificationExempt = $identificationExempt;
+		}
+	}
 
-    /**
-     * @param array $roles The roles to check
-     */
-    public function getApplicableRoles(array $roles): array
-    {
-        $available = array();
+	/**
+	 * @param array $roles The roles to check
+	 */
+	public function getApplicableRoles(array $roles): array
+	{
+		$available = array();
 
-        foreach ($roles as $role) {
-            if (!isset($this->roleConfig[$role])) {
-                // wat
-                continue;
-            }
+		foreach ($roles as $role) {
+			if (!isset($this->roleConfig[$role])) {
+				// wat
+				continue;
+			}
 
-            $available[$role] = $this->roleConfig[$role];
+			$available[$role] = $this->roleConfig[$role];
 
-            if (isset($available[$role]['_childRoles'])) {
-                $childRoles = $this->getApplicableRoles($available[$role]['_childRoles']);
-                $available = array_merge($available, $childRoles);
+			if (isset($available[$role]['_childRoles'])) {
+				$childRoles = $this->getApplicableRoles($available[$role]['_childRoles']);
+				$available = array_merge($available, $childRoles);
 
-                unset($available[$role]['_childRoles']);
-            }
+				unset($available[$role]['_childRoles']);
+			}
 
-            foreach (array('_hidden', '_editableBy', '_description') as $item) {
-                if (isset($available[$role][$item])) {
-                    unset($available[$role][$item]);
-                }
-            }
-        }
+			foreach (array('_hidden', '_editableBy', '_description') as $item) {
+				if (isset($available[$role][$item])) {
+					unset($available[$role][$item]);
+				}
+			}
+		}
 
-        return $available;
-    }
+		return $available;
+	}
 
-    public function getAvailableRoles(): array
-    {
-        $possible = array_diff(array_keys($this->roleConfig), array('public', 'loggedIn'));
+	public function getAvailableRoles(): array
+	{
+		$possible = array_diff(array_keys($this->roleConfig), array('public', 'loggedIn'));
 
-        $actual = array();
+		$actual = array();
 
-        foreach ($possible as $role) {
-            if (!isset($this->roleConfig[$role]['_hidden'])) {
-                $actual[$role] = array(
-                    'description' => $this->roleConfig[$role]['_description'],
-                    'editableBy'  => $this->roleConfig[$role]['_editableBy'],
-                    'globalOnly'  => isset($this->roleConfig[$role]['_globalOnly']) && $this->roleConfig[$role]['_globalOnly'],
-                );
-            }
-        }
+		foreach ($possible as $role) {
+			if (!isset($this->roleConfig[$role]['_hidden'])) {
+				$actual[$role] = array(
+					'description' => $this->roleConfig[$role]['_description'],
+					'editableBy'  => $this->roleConfig[$role]['_editableBy'],
+					'globalOnly'  => isset($this->roleConfig[$role]['_globalOnly']) && $this->roleConfig[$role]['_globalOnly'],
+				);
+			}
+		}
 
-        return $actual;
-    }
+		return $actual;
+	}
 
-    public function roleNeedsIdentification(string $role): bool
-    {
-        if (in_array($role, $this->identificationExempt)) {
-            return false;
-        }
+	public function roleNeedsIdentification(string $role): bool
+	{
+		if (in_array($role, $this->identificationExempt)) {
+			return false;
+		}
 
-        return true;
-    }
+		return true;
+	}
 }