stwalkerster / waca

config.inc.php

Indentation +95 added lines, -95 removed lines

@@ -192,27 +192,27 @@ 
 
 // request states
 $availableRequestStates = array(
-    'Open'          => array(
-        'defertolog' => 'users', // don't change or you'll break old logs
-        'deferto'    => 'users',
-        'header'     => 'Open requests',
-        'api'        => "open",
-        'queuehelp'  => null
-    ),
-    'Flagged users' => array(
-        'defertolog' => 'flagged users', // don't change or you'll break old logs
-        'deferto'    => 'flagged users',
-        'header'     => 'Flagged user needed',
-        'api'        => "admin",
-        'queuehelp'  => 'This queue lists the requests which require a user with the <code>accountcreator</code> flag to create.<br />If creation is determined to be the correct course of action, requests here will require the overriding the AntiSpoof checks or the title blacklist in order to create. It is recommended to try to create the account <em>without</em> checking the flags to validate the results of the AntiSpoof and/or title blacklist hits.'
-    ),
-    'Checkuser'     => array(
-        'defertolog' => 'checkusers', // don't change or you'll break old logs
-        'deferto'    => 'checkusers',
-        'header'     => 'Checkuser needed',
-        'api'        => "checkuser",
-        'queuehelp'  => null
-    ),
+	'Open'          => array(
+		'defertolog' => 'users', // don't change or you'll break old logs
+		'deferto'    => 'users',
+		'header'     => 'Open requests',
+		'api'        => "open",
+		'queuehelp'  => null
+	),
+	'Flagged users' => array(
+		'defertolog' => 'flagged users', // don't change or you'll break old logs
+		'deferto'    => 'flagged users',
+		'header'     => 'Flagged user needed',
+		'api'        => "admin",
+		'queuehelp'  => 'This queue lists the requests which require a user with the <code>accountcreator</code> flag to create.<br />If creation is determined to be the correct course of action, requests here will require the overriding the AntiSpoof checks or the title blacklist in order to create. It is recommended to try to create the account <em>without</em> checking the flags to validate the results of the AntiSpoof and/or title blacklist hits.'
+	),
+	'Checkuser'     => array(
+		'defertolog' => 'checkusers', // don't change or you'll break old logs
+		'deferto'    => 'checkusers',
+		'header'     => 'Checkuser needed',
+		'api'        => "checkuser",
+		'queuehelp'  => null
+	),
 );
 
 $defaultRequestStateKey = 'Open';
@@ -274,24 +274,24 @@ 
 require_once('config.local.inc.php');
 
 $cDatabaseConfig = array(
-    "acc"           => array(
-        "dsrcname" => "mysql:host=" . $toolserver_host . ";dbname=" . $toolserver_database,
-        "username" => $toolserver_username,
-        "password" => $toolserver_password,
-        "options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
-    ),
-    "wikipedia"     => array(
-        "dsrcname" => "mysql:host=" . $antispoof_host . ";dbname=" . $antispoof_db,
-        "username" => $toolserver_username,
-        "password" => $toolserver_password,
-        "options"  => array(),
-    ),
-    "notifications" => array(
-        "dsrcname" => "mysql:host=" . $toolserver_notification_dbhost . ";dbname=" . $toolserver_notification_database,
-        "username" => $notifications_username,
-        "password" => $notifications_password,
-        "options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
-    ),
+	"acc"           => array(
+		"dsrcname" => "mysql:host=" . $toolserver_host . ";dbname=" . $toolserver_database,
+		"username" => $toolserver_username,
+		"password" => $toolserver_password,
+		"options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
+	),
+	"wikipedia"     => array(
+		"dsrcname" => "mysql:host=" . $antispoof_host . ";dbname=" . $antispoof_db,
+		"username" => $toolserver_username,
+		"password" => $toolserver_password,
+		"options"  => array(),
+	),
+	"notifications" => array(
+		"dsrcname" => "mysql:host=" . $toolserver_notification_dbhost . ";dbname=" . $toolserver_notification_database,
+		"username" => $notifications_username,
+		"password" => $notifications_password,
+		"options"  => array(PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8mb4'),
+	),
 );
 
 // //Keep the included files from being executed.
@@ -303,18 +303,18 @@ 
 ini_set('user_agent', $toolUserAgent);
 
 foreach (array(
-    "mbstring", // unicode and stuff
-    "pdo",
-    "pdo_mysql", // new database module
-    "session",
-    "date",
-    "pcre", // core stuff
-    "curl", // mediawiki api access etc
-    "openssl", // token generation
+	"mbstring", // unicode and stuff
+	"pdo",
+	"pdo_mysql", // new database module
+	"session",
+	"date",
+	"pcre", // core stuff
+	"curl", // mediawiki api access etc
+	"openssl", // token generation
 ) as $x) {
-    if (!extension_loaded($x)) {
-        die("extension $x is required.");
-    }
+	if (!extension_loaded($x)) {
+		die("extension $x is required.");
+	}
 }
 
 // Set up the AutoLoader
@@ -338,48 +338,48 @@ 
 $siteConfiguration = new \Waca\SiteConfiguration();
 
 $siteConfiguration->setBaseUrl($baseurl)
-    ->setFilePath(__DIR__)
-    ->setDebuggingTraceEnabled($enableErrorTrace)
-    ->setForceIdentification($forceIdentification)
-    ->setIdentificationCacheExpiry($identificationCacheExpiry)
-    ->setMediawikiScriptPath($mediawikiScriptPath)
-    ->setMediawikiWebServiceEndpoint($mediawikiWebServiceEndpoint)
-    ->setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
-    ->setEnforceOAuth($enforceOAuth)
-    ->setEmailConfirmationEnabled($enableEmailConfirm == 1)
-    ->setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
-    ->setMiserModeLimit($requestLimitShowOnly)
-    ->setRequestStates($availableRequestStates)
-    ->setSquidList($squidIpList)
-    ->setDefaultCreatedTemplateId($createdid)
-    ->setDefaultRequestStateKey($defaultRequestStateKey)
-    ->setUseStrictTransportSecurity($strictTransportSecurityExpiry)
-    ->setUserAgent($toolUserAgent)
-    ->setCurlDisableVerifyPeer($curlDisableSSLVerifyPeer)
-    ->setUseOAuthSignup($useOauthSignup)
-    ->setOAuthBaseUrl($oauthBaseUrl)//
-    ->setOAuthConsumerToken($oauthConsumerToken)
-    ->setOAuthLegacyConsumerTokens($oauthLegacyTokens)
-    ->setOAuthConsumerSecret($oauthSecretToken)
-    ->setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
-    ->setDataClearInterval($dataclear_interval)
-    ->setXffTrustedHostsFile($xff_trusted_hosts_file)
-    ->setIrcNotificationsEnabled($ircBotNotificationsEnabled == 1)
-    ->setIrcNotificationType($ircBotNotificationType)
-    ->setIrcNotificationsInstance($whichami)
-    ->setTitleBlacklistEnabled($enableTitleblacklist == 1)
-    ->setTorExitPaths(array_merge(gethostbynamel('en.wikipedia.org'), gethostbynamel('accounts.wmflabs.org')))
-    ->setCreationBotUsername($creationBotUsername)
-    ->setCreationBotPassword($creationBotPassword)
-    ->setCurlCookieJar($curlCookieJar)
-    ->setYubicoApiId($yubicoApiId)
-    ->setYubicoApiKey($yubicoApiKey)
-    ->setTotpEncryptionKey($totpEncryptionKey)
-    ->setRegistrationAllowed($allowRegistration)
-    ->setCspReportUri($cspReportUri)
-    ->setResourceCacheEpoch($resourceCacheEpoch)
-    ->setLocationProviderApiKey($locationProviderApiKey)
-    ->setCommonEmailDomains($commonEmailDomains)
-    ->setBanMaxIpRange($banMaxIpRange)
-    ->setBanMaxIpBlockRange($banMaxIpBlockRange)
-    ->setJobQueueBatchSize($jobQueueBatchSize);
+	->setFilePath(__DIR__)
+	->setDebuggingTraceEnabled($enableErrorTrace)
+	->setForceIdentification($forceIdentification)
+	->setIdentificationCacheExpiry($identificationCacheExpiry)
+	->setMediawikiScriptPath($mediawikiScriptPath)
+	->setMediawikiWebServiceEndpoint($mediawikiWebServiceEndpoint)
+	->setMetaWikimediaWebServiceEndpoint($metaWikimediaWebServiceEndpoint)
+	->setEnforceOAuth($enforceOAuth)
+	->setEmailConfirmationEnabled($enableEmailConfirm == 1)
+	->setEmailConfirmationExpiryDays($emailConfirmationExpiryDays)
+	->setMiserModeLimit($requestLimitShowOnly)
+	->setRequestStates($availableRequestStates)
+	->setSquidList($squidIpList)
+	->setDefaultCreatedTemplateId($createdid)
+	->setDefaultRequestStateKey($defaultRequestStateKey)
+	->setUseStrictTransportSecurity($strictTransportSecurityExpiry)
+	->setUserAgent($toolUserAgent)
+	->setCurlDisableVerifyPeer($curlDisableSSLVerifyPeer)
+	->setUseOAuthSignup($useOauthSignup)
+	->setOAuthBaseUrl($oauthBaseUrl)//
+	->setOAuthConsumerToken($oauthConsumerToken)
+	->setOAuthLegacyConsumerTokens($oauthLegacyTokens)
+	->setOAuthConsumerSecret($oauthSecretToken)
+	->setOauthMediaWikiCanonicalServer($oauthMediaWikiCanonicalServer)
+	->setDataClearInterval($dataclear_interval)
+	->setXffTrustedHostsFile($xff_trusted_hosts_file)
+	->setIrcNotificationsEnabled($ircBotNotificationsEnabled == 1)
+	->setIrcNotificationType($ircBotNotificationType)
+	->setIrcNotificationsInstance($whichami)
+	->setTitleBlacklistEnabled($enableTitleblacklist == 1)
+	->setTorExitPaths(array_merge(gethostbynamel('en.wikipedia.org'), gethostbynamel('accounts.wmflabs.org')))
+	->setCreationBotUsername($creationBotUsername)
+	->setCreationBotPassword($creationBotPassword)
+	->setCurlCookieJar($curlCookieJar)
+	->setYubicoApiId($yubicoApiId)
+	->setYubicoApiKey($yubicoApiKey)
+	->setTotpEncryptionKey($totpEncryptionKey)
+	->setRegistrationAllowed($allowRegistration)
+	->setCspReportUri($cspReportUri)
+	->setResourceCacheEpoch($resourceCacheEpoch)
+	->setLocationProviderApiKey($locationProviderApiKey)
+	->setCommonEmailDomains($commonEmailDomains)
+	->setBanMaxIpRange($banMaxIpRange)
+	->setBanMaxIpBlockRange($banMaxIpBlockRange)
+	->setJobQueueBatchSize($jobQueueBatchSize);

includes/Helpers/LogHelper.php

Indentation +436 added lines, -436 removed lines

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

includes/Helpers/HttpHelper.php

Indentation +108 added lines, -108 removed lines

@@ -13,112 +13,112 @@
 
 class HttpHelper
 {
-    private $curlHandle;
-
-    /**
-     * HttpHelper constructor.
-     *
-     * @param SiteConfiguration $siteConfiguration
-     * @param string            $cookieJar
-     */
-    public function __construct($siteConfiguration, $cookieJar = null)
-    {
-        $this->curlHandle = curl_init();
-
-        curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $siteConfiguration->getUserAgent());
-        curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
-
-        if ($siteConfiguration->getCurlDisableVerifyPeer()) {
-            curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
-        }
-
-        if ($cookieJar !== null) {
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
-        }
-    }
-
-    public function __destruct()
-    {
-        curl_close($this->curlHandle);
-    }
-
-    /**
-     * Fetches the content of a URL, with an optional parameter set.
-     *
-     * @param string     $url        The URL to fetch.
-     * @param null|array $parameters Key/value pair of GET parameters to add to the request.
-     *                               Null lets you handle it yourself.
-     *
-     * @param array      $headers
-     * @param int        $timeout Timeout in ms
-     *
-     * @return string
-     * @throws CurlException
-     */
-    public function get($url, $parameters = null, $headers = array(), $timeout = 300000)
-    {
-        if ($parameters !== null && is_array($parameters)) {
-            $getString = '?' . http_build_query($parameters);
-            $url .= $getString;
-        }
-
-        curl_setopt($this->curlHandle, CURLOPT_URL, $url);
-
-        // Make sure we're doing a GET
-        curl_setopt($this->curlHandle, CURLOPT_POST, false);
-
-        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
-
-        curl_setopt($this->curlHandle, CURLOPT_CONNECTTIMEOUT_MS, $timeout);
-        curl_setopt($this->curlHandle, CURLOPT_TIMEOUT_MS, $timeout);
-
-        $result = curl_exec($this->curlHandle);
-
-        if ($result === false) {
-            $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Posts data to a URL
-     *
-     * @param string $url        The URL to fetch.
-     * @param array  $parameters Key/value pair of POST parameters to add to the request.
-     * @param array  $headers
-     *
-     * @return string
-     * @throws CurlException
-     */
-    public function post($url, $parameters, $headers = array())
-    {
-        curl_setopt($this->curlHandle, CURLOPT_URL, $url);
-
-        // Make sure we're doing a POST
-        curl_setopt($this->curlHandle, CURLOPT_POST, true);
-        curl_setopt($this->curlHandle, CURLOPT_POSTFIELDS, http_build_query($parameters));
-
-        curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
-
-        $result = curl_exec($this->curlHandle);
-
-        if ($result === false) {
-            $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @return string
-     */
-    public function getError()
-    {
-        return curl_error($this->curlHandle);
-    }
+	private $curlHandle;
+
+	/**
+	 * HttpHelper constructor.
+	 *
+	 * @param SiteConfiguration $siteConfiguration
+	 * @param string            $cookieJar
+	 */
+	public function __construct($siteConfiguration, $cookieJar = null)
+	{
+		$this->curlHandle = curl_init();
+
+		curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
+		curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $siteConfiguration->getUserAgent());
+		curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
+
+		if ($siteConfiguration->getCurlDisableVerifyPeer()) {
+			curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
+		}
+
+		if ($cookieJar !== null) {
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
+		}
+	}
+
+	public function __destruct()
+	{
+		curl_close($this->curlHandle);
+	}
+
+	/**
+	 * Fetches the content of a URL, with an optional parameter set.
+	 *
+	 * @param string     $url        The URL to fetch.
+	 * @param null|array $parameters Key/value pair of GET parameters to add to the request.
+	 *                               Null lets you handle it yourself.
+	 *
+	 * @param array      $headers
+	 * @param int        $timeout Timeout in ms
+	 *
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function get($url, $parameters = null, $headers = array(), $timeout = 300000)
+	{
+		if ($parameters !== null && is_array($parameters)) {
+			$getString = '?' . http_build_query($parameters);
+			$url .= $getString;
+		}
+
+		curl_setopt($this->curlHandle, CURLOPT_URL, $url);
+
+		// Make sure we're doing a GET
+		curl_setopt($this->curlHandle, CURLOPT_POST, false);
+
+		curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
+
+		curl_setopt($this->curlHandle, CURLOPT_CONNECTTIMEOUT_MS, $timeout);
+		curl_setopt($this->curlHandle, CURLOPT_TIMEOUT_MS, $timeout);
+
+		$result = curl_exec($this->curlHandle);
+
+		if ($result === false) {
+			$error = curl_error($this->curlHandle);
+			throw new CurlException('Remote request failed with error ' . $error);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Posts data to a URL
+	 *
+	 * @param string $url        The URL to fetch.
+	 * @param array  $parameters Key/value pair of POST parameters to add to the request.
+	 * @param array  $headers
+	 *
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function post($url, $parameters, $headers = array())
+	{
+		curl_setopt($this->curlHandle, CURLOPT_URL, $url);
+
+		// Make sure we're doing a POST
+		curl_setopt($this->curlHandle, CURLOPT_POST, true);
+		curl_setopt($this->curlHandle, CURLOPT_POSTFIELDS, http_build_query($parameters));
+
+		curl_setopt($this->curlHandle, CURLOPT_HTTPHEADER, $headers);
+
+		$result = curl_exec($this->curlHandle);
+
+		if ($result === false) {
+			$error = curl_error($this->curlHandle);
+			throw new CurlException('Remote request failed with error ' . $error);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getError()
+	{
+		return curl_error($this->curlHandle);
+	}
 }

includes/Helpers/BanHelper.php

Indentation +147 added lines, -147 removed lines

@@ -19,60 +19,60 @@ 
 
 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)
-    {
-        /** @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)
+	{
+		/** @noinspection SqlConstantCondition */
+		$query = <<<SQL
 SELECT * FROM ban 
 WHERE 1 = 1
   AND ((name is null and :nname is null) OR name = :name)
@@ -84,76 +84,76 @@ 
   AND active = 1;
 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,
-        ]);
-
-        $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);
-
-        $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,
+		]);
+
+		$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);
+
+		$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
@@ -174,27 +174,27 @@ 
     and (duration > UNIX_TIMESTAMP() or duration is null)
 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(),
-            ':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(),
+			':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;
+	}
 }

includes/Helpers/OAuthProtocolHelper.php

Indentation +91 added lines, -91 removed lines

@@ -16,95 +16,95 @@
 
 class OAuthProtocolHelper implements Interfaces\IOAuthProtocolHelper
 {
-    private $oauthClient;
-
-    private $mediawikiWebServiceEndpoint;
-
-    private $authUrl;
-
-    /**
-     * OAuthHelper constructor.
-     *
-     * @param string     $oauthEndpoint
-     * @param string     $consumerKey
-     * @param string     $consumerSecret
-     * @param string     $mediawikiWebServiceEndpoint
-     */
-    public function __construct(
-        $oauthEndpoint,
-        $consumerKey,
-        $consumerSecret,
-        $mediawikiWebServiceEndpoint
-    ) {
-        $this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
-
-        $oauthClientConfig = new ClientConfig($oauthEndpoint);
-        $oauthClientConfig->setConsumer(new Consumer($consumerKey, $consumerSecret));
-
-        $this->oauthClient = new Client($oauthClientConfig);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getRequestToken()
-    {
-        /** @var Token $requestToken */
-        list($authUrl, $requestToken) = $this->oauthClient->initiate();
-        $this->authUrl = $authUrl;
-        return $requestToken;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getAuthoriseUrl($requestToken)
-    {
-        return $this->authUrl;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
-    {
-        $requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
-
-        return $this->oauthClient->complete($requestToken, $oauthVerifier);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
-    {
-        return $this->oauthClient->identify(new Token($oauthAccessToken, $oauthAccessSecret));
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
-    {
-        $userToken = new Token($accessToken, $accessSecret);
-
-        $apiParams['format'] = 'json';
-
-        if ($apiParams === null || !is_array($apiParams)) {
-            throw new CurlException("Invalid API call");
-        }
-
-        $url = $this->mediawikiWebServiceEndpoint;
-        $isPost = ($method === 'POST');
-
-        if ($method === 'GET') {
-            $query = http_build_query($apiParams);
-            $url .= '?' . $query;
-            $apiParams = null;
-        }
-
-        $data = $this->oauthClient->makeOAuthCall($userToken, $url, $isPost, $apiParams);
-
-        return json_decode($data);
-    }
+	private $oauthClient;
+
+	private $mediawikiWebServiceEndpoint;
+
+	private $authUrl;
+
+	/**
+	 * OAuthHelper constructor.
+	 *
+	 * @param string     $oauthEndpoint
+	 * @param string     $consumerKey
+	 * @param string     $consumerSecret
+	 * @param string     $mediawikiWebServiceEndpoint
+	 */
+	public function __construct(
+		$oauthEndpoint,
+		$consumerKey,
+		$consumerSecret,
+		$mediawikiWebServiceEndpoint
+	) {
+		$this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
+
+		$oauthClientConfig = new ClientConfig($oauthEndpoint);
+		$oauthClientConfig->setConsumer(new Consumer($consumerKey, $consumerSecret));
+
+		$this->oauthClient = new Client($oauthClientConfig);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getRequestToken()
+	{
+		/** @var Token $requestToken */
+		list($authUrl, $requestToken) = $this->oauthClient->initiate();
+		$this->authUrl = $authUrl;
+		return $requestToken;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getAuthoriseUrl($requestToken)
+	{
+		return $this->authUrl;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
+	{
+		$requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
+
+		return $this->oauthClient->complete($requestToken, $oauthVerifier);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
+	{
+		return $this->oauthClient->identify(new Token($oauthAccessToken, $oauthAccessSecret));
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
+	{
+		$userToken = new Token($accessToken, $accessSecret);
+
+		$apiParams['format'] = 'json';
+
+		if ($apiParams === null || !is_array($apiParams)) {
+			throw new CurlException("Invalid API call");
+		}
+
+		$url = $this->mediawikiWebServiceEndpoint;
+		$isPost = ($method === 'POST');
+
+		if ($method === 'GET') {
+			$query = http_build_query($apiParams);
+			$url .= '?' . $query;
+			$apiParams = null;
+		}
+
+		$data = $this->oauthClient->makeOAuthCall($userToken, $url, $isPost, $apiParams);
+
+		return json_decode($data);
+	}
 }
\ No newline at end of file

includes/Helpers/TypeAheadHelper.php

Indentation +31 added lines, -31 removed lines

@@ -12,21 +12,21 @@ 
 
 class TypeAheadHelper implements ITypeAheadHelper
 {
-    private $definedClasses = array();
+	private $definedClasses = array();
 
-    /**
-     * @param string   $class     CSS class to apply this typeahead to.
-     * @param callable $generator Generator function taking no arguments to return an array of strings.
-     */
-    public function defineTypeAheadSource($class, callable $generator)
-    {
-        $dataList = '';
-        foreach ($generator() as $dataItem) {
-            $dataList .= '"' . htmlentities($dataItem) . '", ';
-        }
-        $dataList = "[" . rtrim($dataList, ", ") . "]";
+	/**
+	 * @param string   $class     CSS class to apply this typeahead to.
+	 * @param callable $generator Generator function taking no arguments to return an array of strings.
+	 */
+	public function defineTypeAheadSource($class, callable $generator)
+	{
+		$dataList = '';
+		foreach ($generator() as $dataItem) {
+			$dataList .= '"' . htmlentities($dataItem) . '", ';
+		}
+		$dataList = "[" . rtrim($dataList, ", ") . "]";
 
-        $script = <<<JS
+		$script = <<<JS
 
 $('.{$class}').typeahead({
         hint: true,
@@ -39,32 +39,32 @@ 
 })
 ;
 JS;
-        $this->definedClasses[$class] = $script;
-    }
+		$this->definedClasses[$class] = $script;
+	}
 
-    /**
-     * @return string HTML fragment containing a JS block for typeaheads.
-     */
-    public function getTypeAheadScriptBlock()
-    {
-        $jsBlocks = '';
+	/**
+	 * @return string HTML fragment containing a JS block for typeaheads.
+	 */
+	public function getTypeAheadScriptBlock()
+	{
+		$jsBlocks = '';
 
-        if (count($this->definedClasses) === 0) {
-            return '';
-        }
+		if (count($this->definedClasses) === 0) {
+			return '';
+		}
 
-        foreach ($this->definedClasses as $class => $js) {
-            $jsBlocks = $js . "\r\n\r\n";
-        }
+		foreach ($this->definedClasses as $class => $js) {
+			$jsBlocks = $js . "\r\n\r\n";
+		}
 
-        $data = <<<HTML
+		$data = <<<HTML
 <script type="text/javascript">
 	{$jsBlocks}
 </script>
 HTML;
 
-        $this->definedClasses = array();
+		$this->definedClasses = array();
 
-        return $data;
-    }
+		return $data;
+	}
 }

includes/Helpers/Logger.php

Indentation +358 added lines, -358 removed lines

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

includes/Helpers/BotMediaWikiClient.php

Indentation +131 added lines, -131 removed lines

@@ -16,135 +16,135 @@
 
 class BotMediaWikiClient implements IMediaWikiClient
 {
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-    /** @var string */
-    private $mediawikiWebServiceEndpoint;
-    /** @var string */
-    private $creationBotUsername;
-    /** @var string */
-    private $creationBotPassword;
-    /** @var bool */
-    private $knownLoggedIn = false;
-
-    /**
-     * BotMediaWikiClient constructor.
-     *
-     * @param SiteConfiguration $siteConfiguration
-     */
-    public function __construct(SiteConfiguration $siteConfiguration)
-    {
-        $this->mediawikiWebServiceEndpoint = $siteConfiguration->getMediawikiWebServiceEndpoint();
-
-        $this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
-        $this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
-
-        $this->httpHelper = new HttpHelper(
-            $siteConfiguration,
-            $siteConfiguration->getCurlCookieJar()
-        );
-    }
-
-    public function doApiCall($apiParams, $method = 'GET')
-    {
-        $this->ensureLoggedIn();
-        $apiParams['assert'] = 'user';
-
-        return $this->callApi($apiParams, $method);
-    }
-
-    private function ensureLoggedIn()
-    {
-        if ($this->knownLoggedIn) {
-            return;
-        }
-
-        $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
-        if (isset($userinfoResult->query->userinfo->anon)) {
-            // not logged in.
-            $this->logIn();
-
-            // retest
-            $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
-            if (isset($userinfoResult->query->userinfo->anon)) {
-                throw new MediaWikiApiException('Unable to log in.');
-            }
-            else {
-                $this->knownLoggedIn = true;
-            }
-        }
-        else {
-            $this->knownLoggedIn = true;
-        }
-    }
-
-    /**
-     * @param $apiParams
-     * @param $method
-     *
-     * @return mixed
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     */
-    private function callApi($apiParams, $method)
-    {
-        $apiParams['format'] = 'json';
-
-        if ($method == 'GET') {
-            $data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        elseif ($method == 'POST') {
-            $data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        else {
-            throw new ApplicationLogicException('Unsupported HTTP Method');
-        }
-
-        if ($data === false) {
-            throw new CurlException('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $result = json_decode($data);
-
-        return $result;
-    }
-
-    private function logIn()
-    {
-        // get token
-        $tokenParams = array(
-            'action' => 'query',
-            'meta'   => 'tokens',
-            'type'   => 'login',
-        );
-
-        $response = $this->callApi($tokenParams, 'POST');
-
-        if (isset($response->error)) {
-            throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
-        }
-
-        $token = $response->query->tokens->logintoken;
-
-        if ($token === null) {
-            throw new MediaWikiApiException('Edit token could not be acquired');
-        }
-
-        $params = array(
-            'action' => 'login',
-            'lgname' => $this->creationBotUsername,
-            'lgpassword' => $this->creationBotPassword,
-            'lgtoken' => $token,
-        );
-
-        $loginResponse = $this->callApi($params, 'POST');
-
-        if ($loginResponse->login->result == 'Success') {
-            return;
-        }
-
-        throw new ApplicationLogicException(json_encode($loginResponse));
-    }
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+	/** @var string */
+	private $mediawikiWebServiceEndpoint;
+	/** @var string */
+	private $creationBotUsername;
+	/** @var string */
+	private $creationBotPassword;
+	/** @var bool */
+	private $knownLoggedIn = false;
+
+	/**
+	 * BotMediaWikiClient constructor.
+	 *
+	 * @param SiteConfiguration $siteConfiguration
+	 */
+	public function __construct(SiteConfiguration $siteConfiguration)
+	{
+		$this->mediawikiWebServiceEndpoint = $siteConfiguration->getMediawikiWebServiceEndpoint();
+
+		$this->creationBotUsername = $siteConfiguration->getCreationBotUsername();
+		$this->creationBotPassword = $siteConfiguration->getCreationBotPassword();
+
+		$this->httpHelper = new HttpHelper(
+			$siteConfiguration,
+			$siteConfiguration->getCurlCookieJar()
+		);
+	}
+
+	public function doApiCall($apiParams, $method = 'GET')
+	{
+		$this->ensureLoggedIn();
+		$apiParams['assert'] = 'user';
+
+		return $this->callApi($apiParams, $method);
+	}
+
+	private function ensureLoggedIn()
+	{
+		if ($this->knownLoggedIn) {
+			return;
+		}
+
+		$userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
+		if (isset($userinfoResult->query->userinfo->anon)) {
+			// not logged in.
+			$this->logIn();
+
+			// retest
+			$userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
+			if (isset($userinfoResult->query->userinfo->anon)) {
+				throw new MediaWikiApiException('Unable to log in.');
+			}
+			else {
+				$this->knownLoggedIn = true;
+			}
+		}
+		else {
+			$this->knownLoggedIn = true;
+		}
+	}
+
+	/**
+	 * @param $apiParams
+	 * @param $method
+	 *
+	 * @return mixed
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 */
+	private function callApi($apiParams, $method)
+	{
+		$apiParams['format'] = 'json';
+
+		if ($method == 'GET') {
+			$data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
+		}
+		elseif ($method == 'POST') {
+			$data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
+		}
+		else {
+			throw new ApplicationLogicException('Unsupported HTTP Method');
+		}
+
+		if ($data === false) {
+			throw new CurlException('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$result = json_decode($data);
+
+		return $result;
+	}
+
+	private function logIn()
+	{
+		// get token
+		$tokenParams = array(
+			'action' => 'query',
+			'meta'   => 'tokens',
+			'type'   => 'login',
+		);
+
+		$response = $this->callApi($tokenParams, 'POST');
+
+		if (isset($response->error)) {
+			throw new MediaWikiApiException($response->error->code . ': ' . $response->error->info);
+		}
+
+		$token = $response->query->tokens->logintoken;
+
+		if ($token === null) {
+			throw new MediaWikiApiException('Edit token could not be acquired');
+		}
+
+		$params = array(
+			'action' => 'login',
+			'lgname' => $this->creationBotUsername,
+			'lgpassword' => $this->creationBotPassword,
+			'lgtoken' => $token,
+		);
+
+		$loginResponse = $this->callApi($params, 'POST');
+
+		if ($loginResponse->login->result == 'Success') {
+			return;
+		}
+
+		throw new ApplicationLogicException(json_encode($loginResponse));
+	}
 }

includes/Helpers/Interfaces/IBlacklistHelper.php

Indentation +8 added lines, -8 removed lines

@@ -10,12 +10,12 @@
 
 interface IBlacklistHelper
 {
-    /**
-     * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
-     *
-     * @param string $username
-     *
-     * @return bool
-     */
-    public function isBlacklisted($username);
+	/**
+	 * Returns a value indicating whether the provided username is blacklisted by the on-wiki title blacklist
+	 *
+	 * @param string $username
+	 *
+	 * @return bool
+	 */
+	public function isBlacklisted($username);
 }
\ No newline at end of file