enwikipedia-acc / waca

includes/RegexConstants.php

Indentation +4 added lines, -4 removed lines

@@ -10,8 +10,8 @@
 
 class RegexConstants
 {
-    const IPV6_CIDR = '(?:/(?:12[0-8]|1[01][0-9]|[0-9]{1,2}))?';
-    const IPV4_CIDR = '(?:/(?:32|3[01]|[0-2]?[0-9]))?';
-    const IPV4 = '(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)';
-    const IPV6 = '(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))';
+	const IPV6_CIDR = '(?:/(?:12[0-8]|1[01][0-9]|[0-9]{1,2}))?';
+	const IPV4_CIDR = '(?:/(?:32|3[01]|[0-2]?[0-9]))?';
+	const IPV4 = '(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)';
+	const IPV6 = '(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))';
 }
\ No newline at end of file

includes/Helpers/IrcNotificationHelper.php

Indentation +439 added lines, -439 removed lines

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

Spacing +26 added lines, -26 removed lines

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

includes/Helpers/HttpHelper.php

Indentation +99 added lines, -99 removed lines

@@ -12,103 +12,103 @@
 
 class HttpHelper
 {
-    private $curlHandle;
-
-    /**
-     * HttpHelper constructor.
-     *
-     * @param string  $userAgent
-     * @param boolean $disableVerifyPeer
-     */
-    public function __construct($userAgent, $disableVerifyPeer)
-    {
-        $this->curlHandle = curl_init();
-
-        curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
-        curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $userAgent);
-        curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
-
-        if ($disableVerifyPeer) {
-            curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
-        }
-    }
-
-    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
-     *
-     * @return string
-     * @throws CurlException
-     */
-    public function get($url, $parameters = null, $headers = array())
-    {
-        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);
-
-        $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 string  $userAgent
+	 * @param boolean $disableVerifyPeer
+	 */
+	public function __construct($userAgent, $disableVerifyPeer)
+	{
+		$this->curlHandle = curl_init();
+
+		curl_setopt($this->curlHandle, CURLOPT_RETURNTRANSFER, true);
+		curl_setopt($this->curlHandle, CURLOPT_USERAGENT, $userAgent);
+		curl_setopt($this->curlHandle, CURLOPT_FAILONERROR, true);
+
+		if ($disableVerifyPeer) {
+			curl_setopt($this->curlHandle, CURLOPT_SSL_VERIFYPEER, false);
+		}
+	}
+
+	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
+	 *
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function get($url, $parameters = null, $headers = array())
+	{
+		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);
+
+		$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);
+	}
 }
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
     public function get($url, $parameters = null, $headers = array())
     {
         if ($parameters !== null && is_array($parameters)) {
-            $getString = '?' . http_build_query($parameters);
+            $getString = '?'.http_build_query($parameters);
             $url .= $getString;
         }
 
@@ -68,7 +68,7 @@ 
 
         if ($result === false) {
             $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
+            throw new CurlException('Remote request failed with error '.$error);
         }
 
         return $result;
@@ -98,7 +98,7 @@ 
 
         if ($result === false) {
             $error = curl_error($this->curlHandle);
-            throw new CurlException('Remote request failed with error ' . $error);
+            throw new CurlException('Remote request failed with error '.$error);
         }
 
         return $result;

includes/Helpers/SearchHelpers/LogSearchHelper.php

Indentation +98 added lines, -98 removed lines

@@ -13,102 +13,102 @@
 
 class LogSearchHelper extends SearchHelperBase
 {
-    /**
-     * LogSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'log', 'timestamp DESC');
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return LogSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new LogSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * Returns the requested requests
-     *
-     * @return Log[]
-     */
-    public function fetch()
-    {
-        $targetClass = Log::class;
-
-        /** @var Log[] $returnedObjects */
-        $returnedObjects = $this->fetchObjects($targetClass);
-
-        return $returnedObjects;
-    }
-
-    /**
-     * Filters the results by user
-     *
-     * @param int $userId
-     *
-     * @return $this
-     */
-    public function byUser($userId)
-    {
-        $this->whereClause .= ' AND user = ?';
-        $this->parameterList[] = $userId;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by log action
-     *
-     * @param string $action
-     *
-     * @return $this
-     */
-    public function byAction($action)
-    {
-        $this->whereClause .= ' AND action = ?';
-        $this->parameterList[] = $action;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by object type
-     *
-     * @param string $objectType
-     *
-     * @return $this
-     */
-    public function byObjectType($objectType)
-    {
-        $this->whereClause .= ' AND objecttype = ?';
-        $this->parameterList[] = $objectType;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by object type
-     *
-     * @param integer $objectId
-     *
-     * @return $this
-     */
-    public function byObjectId($objectId)
-    {
-        $this->whereClause .= ' AND objectid = ?';
-        $this->parameterList[] = $objectId;
-
-        return $this;
-    }
+	/**
+	 * LogSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'log', 'timestamp DESC');
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return LogSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new LogSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * Returns the requested requests
+	 *
+	 * @return Log[]
+	 */
+	public function fetch()
+	{
+		$targetClass = Log::class;
+
+		/** @var Log[] $returnedObjects */
+		$returnedObjects = $this->fetchObjects($targetClass);
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * Filters the results by user
+	 *
+	 * @param int $userId
+	 *
+	 * @return $this
+	 */
+	public function byUser($userId)
+	{
+		$this->whereClause .= ' AND user = ?';
+		$this->parameterList[] = $userId;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by log action
+	 *
+	 * @param string $action
+	 *
+	 * @return $this
+	 */
+	public function byAction($action)
+	{
+		$this->whereClause .= ' AND action = ?';
+		$this->parameterList[] = $action;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by object type
+	 *
+	 * @param string $objectType
+	 *
+	 * @return $this
+	 */
+	public function byObjectType($objectType)
+	{
+		$this->whereClause .= ' AND objecttype = ?';
+		$this->parameterList[] = $objectType;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by object type
+	 *
+	 * @param integer $objectId
+	 *
+	 * @return $this
+	 */
+	public function byObjectId($objectId)
+	{
+		$this->whereClause .= ' AND objectid = ?';
+		$this->parameterList[] = $objectId;
+
+		return $this;
+	}
 }
\ No newline at end of file

includes/Helpers/SearchHelpers/SearchHelperBase.php

Indentation +115 added lines, -115 removed lines

@@ -14,119 +14,119 @@
 
 abstract class SearchHelperBase
 {
-    /** @var PdoDatabase */
-    protected $database;
-    /** @var array */
-    protected $parameterList = array();
-    /** @var null|int */
-    private $limit = null;
-    /** @var null|int */
-    private $offset = null;
-    private $orderBy = null;
-    /**
-     * @var string The where clause.
-     *
-     * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
-     * that we use positional parameters instead of named parameters because we don't know many times different options
-     * will be called (looking at excluding() here, but there's the option for others).
-     */
-    protected $whereClause = 'WHERE 1 = 1';
-    /** @var string */
-    private $table;
-
-    /**
-     * SearchHelperBase constructor.
-     *
-     * @param PdoDatabase $database
-     * @param string      $table
-     * @param null|string $order Order by clause, excluding ORDER BY.
-     */
-    protected function __construct(PdoDatabase $database, $table, $order = null)
-    {
-        $this->database = $database;
-        $this->table = $table;
-        $this->orderBy = $order;
-    }
-
-    /**
-     * @param $targetClass
-     *
-     * @return DataObject[]
-     */
-    protected function fetchObjects($targetClass)
-    {
-        $query = 'SELECT * FROM ' . $this->table . ' ' . $this->whereClause;
-        $query .= $this->applyOrder();
-        $query .= $this->applyLimit();
-
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        /** @var DataObject[] $returnedObjects */
-        $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $targetClass);
-        foreach ($returnedObjects as $req) {
-            $req->setDatabase($this->database);
-        }
-
-        return $returnedObjects;
-    }
-
-    /**
-     * @param int $count Returns the record count of the result set
-     *
-     * @return $this
-     */
-    public function getRecordCount(&$count)
-    {
-        $query = 'SELECT COUNT(1) FROM ' . $this->table . ' ' . $this->whereClause;
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        $count = $statement->fetchColumn(0);
-        $statement->closeCursor();
-
-        return $this;
-    }
-
-    /**
-     * Limits the results
-     *
-     * @param integer      $limit
-     * @param integer|null $offset
-     *
-     * @return $this
-     *
-     */
-    public function limit($limit, $offset = null)
-    {
-        $this->limit = $limit;
-        $this->offset = $offset;
-
-        return $this;
-    }
-
-    private function applyLimit()
-    {
-        $clause = '';
-        if ($this->limit !== null) {
-            $clause = ' LIMIT ?';
-            $this->parameterList[] = $this->limit;
-
-            if ($this->offset !== null) {
-                $clause .= ' OFFSET ?';
-                $this->parameterList[] = $this->offset;
-            }
-        }
-
-        return $clause;
-    }
-
-    private function applyOrder()
-    {
-        if ($this->orderBy !== null) {
-            return ' ORDER BY ' . $this->orderBy;
-        }
-
-        return '';
-    }
+	/** @var PdoDatabase */
+	protected $database;
+	/** @var array */
+	protected $parameterList = array();
+	/** @var null|int */
+	private $limit = null;
+	/** @var null|int */
+	private $offset = null;
+	private $orderBy = null;
+	/**
+	 * @var string The where clause.
+	 *
+	 * (the 1=1 condition will be optimised out of the query by the query planner, and simplifies our code here). Note
+	 * that we use positional parameters instead of named parameters because we don't know many times different options
+	 * will be called (looking at excluding() here, but there's the option for others).
+	 */
+	protected $whereClause = 'WHERE 1 = 1';
+	/** @var string */
+	private $table;
+
+	/**
+	 * SearchHelperBase constructor.
+	 *
+	 * @param PdoDatabase $database
+	 * @param string      $table
+	 * @param null|string $order Order by clause, excluding ORDER BY.
+	 */
+	protected function __construct(PdoDatabase $database, $table, $order = null)
+	{
+		$this->database = $database;
+		$this->table = $table;
+		$this->orderBy = $order;
+	}
+
+	/**
+	 * @param $targetClass
+	 *
+	 * @return DataObject[]
+	 */
+	protected function fetchObjects($targetClass)
+	{
+		$query = 'SELECT * FROM ' . $this->table . ' ' . $this->whereClause;
+		$query .= $this->applyOrder();
+		$query .= $this->applyLimit();
+
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		/** @var DataObject[] $returnedObjects */
+		$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $targetClass);
+		foreach ($returnedObjects as $req) {
+			$req->setDatabase($this->database);
+		}
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * @param int $count Returns the record count of the result set
+	 *
+	 * @return $this
+	 */
+	public function getRecordCount(&$count)
+	{
+		$query = 'SELECT COUNT(1) FROM ' . $this->table . ' ' . $this->whereClause;
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		$count = $statement->fetchColumn(0);
+		$statement->closeCursor();
+
+		return $this;
+	}
+
+	/**
+	 * Limits the results
+	 *
+	 * @param integer      $limit
+	 * @param integer|null $offset
+	 *
+	 * @return $this
+	 *
+	 */
+	public function limit($limit, $offset = null)
+	{
+		$this->limit = $limit;
+		$this->offset = $offset;
+
+		return $this;
+	}
+
+	private function applyLimit()
+	{
+		$clause = '';
+		if ($this->limit !== null) {
+			$clause = ' LIMIT ?';
+			$this->parameterList[] = $this->limit;
+
+			if ($this->offset !== null) {
+				$clause .= ' OFFSET ?';
+				$this->parameterList[] = $this->offset;
+			}
+		}
+
+		return $clause;
+	}
+
+	private function applyOrder()
+	{
+		if ($this->orderBy !== null) {
+			return ' ORDER BY ' . $this->orderBy;
+		}
+
+		return '';
+	}
 }
\ No newline at end of file

Spacing +3 added lines, -3 removed lines

@@ -55,7 +55,7 @@ 
      */
     protected function fetchObjects($targetClass)
     {
-        $query = 'SELECT * FROM ' . $this->table . ' ' . $this->whereClause;
+        $query = 'SELECT * FROM '.$this->table.' '.$this->whereClause;
         $query .= $this->applyOrder();
         $query .= $this->applyLimit();
 
@@ -78,7 +78,7 @@ 
      */
     public function getRecordCount(&$count)
     {
-        $query = 'SELECT COUNT(1) FROM ' . $this->table . ' ' . $this->whereClause;
+        $query = 'SELECT COUNT(1) FROM '.$this->table.' '.$this->whereClause;
         $statement = $this->database->prepare($query);
         $statement->execute($this->parameterList);
 
@@ -124,7 +124,7 @@ 
     private function applyOrder()
     {
         if ($this->orderBy !== null) {
-            return ' ORDER BY ' . $this->orderBy;
+            return ' ORDER BY '.$this->orderBy;
         }
 
         return '';

includes/Helpers/SearchHelpers/RequestSearchHelper.php

Indentation +127 added lines, -127 removed lines

@@ -14,131 +14,131 @@
 
 class RequestSearchHelper extends SearchHelperBase
 {
-    /**
-     * RequestSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'request');
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return RequestSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new RequestSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * Returns the requested requests
-     *
-     * @return Request[]
-     */
-    public function fetch()
-    {
-        $targetClass = Request::class;
-        /** @var Request[] $returnedObjects */
-        $returnedObjects = $this->fetchObjects($targetClass);
-
-        return $returnedObjects;
-    }
-
-    /**
-     * Filters the results by IP address
-     *
-     * @param string $ipAddress
-     *
-     * @return $this
-     */
-    public function byIp($ipAddress)
-    {
-        $this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
-        $this->parameterList[] = $ipAddress;
-        $this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by email address
-     *
-     * @param string $emailAddress
-     *
-     * @return $this
-     */
-    public function byEmailAddress($emailAddress)
-    {
-        $this->whereClause .= ' AND email LIKE ?';
-        $this->parameterList[] = $emailAddress;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results by name
-     *
-     * @param string $name
-     *
-     * @return $this
-     */
-    public function byName($name)
-    {
-        $this->whereClause .= ' AND name LIKE ?';
-        $this->parameterList[] = $name;
-
-        return $this;
-    }
-
-    /**
-     * Excludes a request from the results
-     *
-     * @param int $requestId
-     *
-     * @return $this
-     */
-    public function excludingRequest($requestId)
-    {
-        $this->whereClause .= ' AND id <> ?';
-        $this->parameterList[] = $requestId;
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to only those with a confirmed email address
-     *
-     * @return $this
-     */
-    public function withConfirmedEmail()
-    {
-        $this->whereClause .= ' AND emailconfirm = ?';
-        $this->parameterList[] = 'Confirmed';
-
-        return $this;
-    }
-
-    /**
-     * Filters the results to exclude purged data
-     *
-     * @param SiteConfiguration $configuration
-     *
-     * @return $this
-     */
-    public function excludingPurgedData(SiteConfiguration $configuration)
-    {
-        $this->whereClause .= ' AND ip <> ? AND email <> ?';
-        $this->parameterList[] = $configuration->getDataClearIp();
-        $this->parameterList[] = $configuration->getDataClearEmail();
-
-        return $this;
-    }
+	/**
+	 * RequestSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'request');
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return RequestSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new RequestSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * Returns the requested requests
+	 *
+	 * @return Request[]
+	 */
+	public function fetch()
+	{
+		$targetClass = Request::class;
+		/** @var Request[] $returnedObjects */
+		$returnedObjects = $this->fetchObjects($targetClass);
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * Filters the results by IP address
+	 *
+	 * @param string $ipAddress
+	 *
+	 * @return $this
+	 */
+	public function byIp($ipAddress)
+	{
+		$this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
+		$this->parameterList[] = $ipAddress;
+		$this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by email address
+	 *
+	 * @param string $emailAddress
+	 *
+	 * @return $this
+	 */
+	public function byEmailAddress($emailAddress)
+	{
+		$this->whereClause .= ' AND email LIKE ?';
+		$this->parameterList[] = $emailAddress;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results by name
+	 *
+	 * @param string $name
+	 *
+	 * @return $this
+	 */
+	public function byName($name)
+	{
+		$this->whereClause .= ' AND name LIKE ?';
+		$this->parameterList[] = $name;
+
+		return $this;
+	}
+
+	/**
+	 * Excludes a request from the results
+	 *
+	 * @param int $requestId
+	 *
+	 * @return $this
+	 */
+	public function excludingRequest($requestId)
+	{
+		$this->whereClause .= ' AND id <> ?';
+		$this->parameterList[] = $requestId;
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to only those with a confirmed email address
+	 *
+	 * @return $this
+	 */
+	public function withConfirmedEmail()
+	{
+		$this->whereClause .= ' AND emailconfirm = ?';
+		$this->parameterList[] = 'Confirmed';
+
+		return $this;
+	}
+
+	/**
+	 * Filters the results to exclude purged data
+	 *
+	 * @param SiteConfiguration $configuration
+	 *
+	 * @return $this
+	 */
+	public function excludingPurgedData(SiteConfiguration $configuration)
+	{
+		$this->whereClause .= ' AND ip <> ? AND email <> ?';
+		$this->parameterList[] = $configuration->getDataClearIp();
+		$this->parameterList[] = $configuration->getDataClearEmail();
+
+		return $this;
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
     {
         $this->whereClause .= ' AND (ip LIKE ? OR forwardedip LIKE ?)';
         $this->parameterList[] = $ipAddress;
-        $this->parameterList[] = '%' . trim($ipAddress, '%') . '%';
+        $this->parameterList[] = '%'.trim($ipAddress, '%').'%';
 
         return $this;
     }

includes/Helpers/WikiTextHelper.php

Indentation +48 added lines, -48 removed lines

@@ -12,52 +12,52 @@
 
 class WikiTextHelper
 {
-    /**
-     * @var SiteConfiguration
-     */
-    private $configuration;
-    /**
-     * @var HttpHelper
-     */
-    private $http;
-
-    /**
-     * WikiTextHelper constructor.
-     *
-     * @param SiteConfiguration $configuration
-     * @param HttpHelper        $http
-     */
-    public function __construct(SiteConfiguration $configuration, HttpHelper $http)
-    {
-        $this->configuration = $configuration;
-        $this->http = $http;
-    }
-
-    /**
-     * Gets the HTML for the provided wiki-markup from the MediaWiki service endpoint
-     *
-     * @param string $wikiText
-     *
-     * @return string
-     */
-    public function getHtmlForWikiText($wikiText)
-    {
-        $endpoint = $this->configuration->getMediawikiWebServiceEndpoint();
-
-        $parameters = array(
-            'action'             => 'parse',
-            'pst'                => true,
-            'contentmodel'       => 'wikitext',
-            'disablelimitreport' => true,
-            'disabletoc'         => true,
-            'disableeditsection' => true,
-            'format'             => 'php',
-            'text'               => $wikiText,
-        );
-
-        $apiResult = $this->http->get($endpoint, $parameters);
-        $parseResult = unserialize($apiResult);
-
-        return $parseResult['parse']['text']['*'];
-    }
+	/**
+	 * @var SiteConfiguration
+	 */
+	private $configuration;
+	/**
+	 * @var HttpHelper
+	 */
+	private $http;
+
+	/**
+	 * WikiTextHelper constructor.
+	 *
+	 * @param SiteConfiguration $configuration
+	 * @param HttpHelper        $http
+	 */
+	public function __construct(SiteConfiguration $configuration, HttpHelper $http)
+	{
+		$this->configuration = $configuration;
+		$this->http = $http;
+	}
+
+	/**
+	 * Gets the HTML for the provided wiki-markup from the MediaWiki service endpoint
+	 *
+	 * @param string $wikiText
+	 *
+	 * @return string
+	 */
+	public function getHtmlForWikiText($wikiText)
+	{
+		$endpoint = $this->configuration->getMediawikiWebServiceEndpoint();
+
+		$parameters = array(
+			'action'             => 'parse',
+			'pst'                => true,
+			'contentmodel'       => 'wikitext',
+			'disablelimitreport' => true,
+			'disabletoc'         => true,
+			'disableeditsection' => true,
+			'format'             => 'php',
+			'text'               => $wikiText,
+		);
+
+		$apiResult = $this->http->get($endpoint, $parameters);
+		$parseResult = unserialize($apiResult);
+
+		return $parseResult['parse']['text']['*'];
+	}
 }
\ No newline at end of file

includes/Helpers/Logger.php

Indentation +296 added lines, -296 removed lines

@@ -30,300 +30,300 @@
  */
 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");
-    }
-
-    #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
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment);
-    }
-
-    /**
-     * @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);
-    }
-    #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
+	/**
+	 * @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");
+	}
+
+	#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
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment);
+	}
+
+	/**
+	 * @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);
+	}
+	#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
 }

includes/Helpers/OAuthHelper.php

Indentation +226 added lines, -226 removed lines

@@ -21,231 +21,231 @@
 
 class OAuthHelper implements IOAuthHelper
 {
-    private $oauthConsumer;
-    /**
-     * @var string
-     */
-    private $oauthEndpoint;
-    /**
-     * @var string
-     */
-    private $consumerToken;
-    /**
-     * @var string
-     */
-    private $consumerSecret;
-    /**
-     * @var HttpHelper
-     */
-    private $httpHelper;
-    /**
-     * @var string
-     */
-    private $mediawikiWebServiceEndpoint;
-
-    /**
-     * OAuthHelper constructor.
-     *
-     * @param string     $oauthEndpoint
-     * @param string     $consumerKey
-     * @param string     $consumerSecret
-     * @param HttpHelper $httpHelper
-     * @param string     $mediawikiWebServiceEndpoint
-     */
-    public function __construct(
-        $oauthEndpoint,
-        $consumerKey,
-        $consumerSecret,
-        HttpHelper $httpHelper,
-        $mediawikiWebServiceEndpoint
-    ) {
-        $this->oauthEndpoint = $oauthEndpoint;
-        $this->consumerToken = $consumerKey;
-        $this->consumerSecret = $consumerSecret;
-        $this->httpHelper = $httpHelper;
-
-        $this->oauthConsumer = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
-        $this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
-    }
-
-    /**
-     * @return stdClass
-     *
-     * @throws Exception
-     * @throws CurlException
-     */
-    public function getRequestToken()
-    {
-        $endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
-
-        $parsedUrl = parse_url($endpoint);
-        $urlParameters = array();
-        parse_str($parsedUrl['query'], $urlParameters);
-
-        $req_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, null, 'GET', $endpoint, $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $req_req->sign_request($hmac_method, $this->oauthConsumer, null);
-
-        $targetUrl = (string)$req_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $token = json_decode($data);
-
-        if (!isset($token)) {
-            throw new Exception('Unknown error encountered getting request token while decoding json data.');
-        }
-
-        if (isset($token->error)) {
-            throw new Exception('Error encountered while getting request token: ' . $token->error);
-        }
-
-        return $token;
-    }
-
-    /**
-     * @param string $requestToken
-     *
-     * @return string
-     */
-    public function getAuthoriseUrl($requestToken)
-    {
-        return "{$this->oauthEndpoint}/authorize&oauth_token={$requestToken}&oauth_consumer_key={$this->consumerToken}";
-    }
-
-    /**
-     * @param string $oauthRequestToken
-     * @param string $oauthRequestSecret
-     * @param string $oauthVerifier
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
-    {
-        $endpoint = $this->oauthEndpoint . '/token&format=json';
-
-        $requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
-
-        $parsedUrl = parse_url($endpoint);
-        parse_str($parsedUrl['query'], $urlParameters);
-        $urlParameters['oauth_verifier'] = trim($oauthVerifier);
-
-        $acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $requestConsumer, 'GET', $endpoint,
-            $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $acc_req->sign_request($hmac_method, $this->oauthConsumer, $requestConsumer);
-
-        $targetUrl = (string)$acc_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $token = json_decode($data);
-
-        if (!isset($token)) {
-            throw new Exception('Unknown error encountered getting access token while decoding json data.');
-        }
-
-        if (isset($token->error)) {
-            throw new Exception('Error encountered while getting access token: ' . $token->error);
-        }
-
-        return $token;
-    }
-
-    /**
-     * @param string $oauthAccessToken
-     * @param string $oauthAccessSecret
-     *
-     * @return JWT
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
-    {
-        $endpoint = $this->oauthEndpoint . '/identify&format=json';
-
-        $oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
-
-        $parsedUrl = parse_url($endpoint);
-        parse_str($parsedUrl['query'], $urlParameters);
-
-        $acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $oauthToken, 'GET', $endpoint,
-            $urlParameters);
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
-        $acc_req->sign_request($hmac_method, $this->oauthConsumer, $oauthToken);
-
-        $targetUrl = (string)$acc_req;
-
-        $data = $this->httpHelper->get($targetUrl, null);
-
-        if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        $decodedData = json_decode($data);
-
-        if (isset($decodedData->error)) {
-            throw new Exception($decodedData->error);
-        }
-
-        $identity = JWT::decode($data, $this->consumerSecret);
-
-        return $identity;
-    }
-
-    /**
-     * @param array  $apiParams    array of parameters to send to the API
-     * @param string $accessToken  user's access token
-     * @param string $accessSecret user's secret
-     * @param string $method       HTTP method
-     *
-     * @return stdClass
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
-    {
-        $userToken = new OAuthToken($accessToken, $accessSecret);
-
-        $apiParams['format'] = 'json';
-
-        $api_req = OAuthRequest::from_consumer_and_token(
-            $this->oauthConsumer, // Consumer
-            $userToken, // User Access Token
-            $method, // HTTP Method
-            $this->mediawikiWebServiceEndpoint, // Endpoint url
-            $apiParams    // Extra signed parameters
-        );
-
-        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+	private $oauthConsumer;
+	/**
+	 * @var string
+	 */
+	private $oauthEndpoint;
+	/**
+	 * @var string
+	 */
+	private $consumerToken;
+	/**
+	 * @var string
+	 */
+	private $consumerSecret;
+	/**
+	 * @var HttpHelper
+	 */
+	private $httpHelper;
+	/**
+	 * @var string
+	 */
+	private $mediawikiWebServiceEndpoint;
+
+	/**
+	 * OAuthHelper constructor.
+	 *
+	 * @param string     $oauthEndpoint
+	 * @param string     $consumerKey
+	 * @param string     $consumerSecret
+	 * @param HttpHelper $httpHelper
+	 * @param string     $mediawikiWebServiceEndpoint
+	 */
+	public function __construct(
+		$oauthEndpoint,
+		$consumerKey,
+		$consumerSecret,
+		HttpHelper $httpHelper,
+		$mediawikiWebServiceEndpoint
+	) {
+		$this->oauthEndpoint = $oauthEndpoint;
+		$this->consumerToken = $consumerKey;
+		$this->consumerSecret = $consumerSecret;
+		$this->httpHelper = $httpHelper;
+
+		$this->oauthConsumer = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
+		$this->mediawikiWebServiceEndpoint = $mediawikiWebServiceEndpoint;
+	}
+
+	/**
+	 * @return stdClass
+	 *
+	 * @throws Exception
+	 * @throws CurlException
+	 */
+	public function getRequestToken()
+	{
+		$endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
+
+		$parsedUrl = parse_url($endpoint);
+		$urlParameters = array();
+		parse_str($parsedUrl['query'], $urlParameters);
+
+		$req_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, null, 'GET', $endpoint, $urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$req_req->sign_request($hmac_method, $this->oauthConsumer, null);
+
+		$targetUrl = (string)$req_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new Exception('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$token = json_decode($data);
+
+		if (!isset($token)) {
+			throw new Exception('Unknown error encountered getting request token while decoding json data.');
+		}
+
+		if (isset($token->error)) {
+			throw new Exception('Error encountered while getting request token: ' . $token->error);
+		}
+
+		return $token;
+	}
+
+	/**
+	 * @param string $requestToken
+	 *
+	 * @return string
+	 */
+	public function getAuthoriseUrl($requestToken)
+	{
+		return "{$this->oauthEndpoint}/authorize&oauth_token={$requestToken}&oauth_consumer_key={$this->consumerToken}";
+	}
+
+	/**
+	 * @param string $oauthRequestToken
+	 * @param string $oauthRequestSecret
+	 * @param string $oauthVerifier
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
+	{
+		$endpoint = $this->oauthEndpoint . '/token&format=json';
+
+		$requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
+
+		$parsedUrl = parse_url($endpoint);
+		parse_str($parsedUrl['query'], $urlParameters);
+		$urlParameters['oauth_verifier'] = trim($oauthVerifier);
+
+		$acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $requestConsumer, 'GET', $endpoint,
+			$urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$acc_req->sign_request($hmac_method, $this->oauthConsumer, $requestConsumer);
+
+		$targetUrl = (string)$acc_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new Exception('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$token = json_decode($data);
+
+		if (!isset($token)) {
+			throw new Exception('Unknown error encountered getting access token while decoding json data.');
+		}
+
+		if (isset($token->error)) {
+			throw new Exception('Error encountered while getting access token: ' . $token->error);
+		}
+
+		return $token;
+	}
+
+	/**
+	 * @param string $oauthAccessToken
+	 * @param string $oauthAccessSecret
+	 *
+	 * @return JWT
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
+	{
+		$endpoint = $this->oauthEndpoint . '/identify&format=json';
+
+		$oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
+
+		$parsedUrl = parse_url($endpoint);
+		parse_str($parsedUrl['query'], $urlParameters);
+
+		$acc_req = OAuthRequest::from_consumer_and_token($this->oauthConsumer, $oauthToken, 'GET', $endpoint,
+			$urlParameters);
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
+		$acc_req->sign_request($hmac_method, $this->oauthConsumer, $oauthToken);
+
+		$targetUrl = (string)$acc_req;
+
+		$data = $this->httpHelper->get($targetUrl, null);
+
+		if ($data === false) {
+			throw new Exception('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		$decodedData = json_decode($data);
+
+		if (isset($decodedData->error)) {
+			throw new Exception($decodedData->error);
+		}
+
+		$identity = JWT::decode($data, $this->consumerSecret);
+
+		return $identity;
+	}
+
+	/**
+	 * @param array  $apiParams    array of parameters to send to the API
+	 * @param string $accessToken  user's access token
+	 * @param string $accessSecret user's secret
+	 * @param string $method       HTTP method
+	 *
+	 * @return stdClass
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
+	{
+		$userToken = new OAuthToken($accessToken, $accessSecret);
+
+		$apiParams['format'] = 'json';
+
+		$api_req = OAuthRequest::from_consumer_and_token(
+			$this->oauthConsumer, // Consumer
+			$userToken, // User Access Token
+			$method, // HTTP Method
+			$this->mediawikiWebServiceEndpoint, // Endpoint url
+			$apiParams    // Extra signed parameters
+		);
+
+		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 
-        $api_req->sign_request($hmac_method, $this->oauthConsumer, $userToken);
-
-        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 Exception('Curl error: ' . $this->httpHelper->getError());
-        }
-
-        return json_decode($data);
-    }
+		$api_req->sign_request($hmac_method, $this->oauthConsumer, $userToken);
+
+		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 Exception('Curl error: ' . $this->httpHelper->getError());
+		}
+
+		return json_decode($data);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -76,7 +76,7 @@ 
      */
     public function getRequestToken()
     {
-        $endpoint = $this->oauthEndpoint . '/initiate&format=json&oauth_callback=oob';
+        $endpoint = $this->oauthEndpoint.'/initiate&format=json&oauth_callback=oob';
 
         $parsedUrl = parse_url($endpoint);
         $urlParameters = array();
@@ -91,7 +91,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
+            throw new Exception('Curl error: '.$this->httpHelper->getError());
         }
 
         $token = json_decode($data);
@@ -101,7 +101,7 @@ 
         }
 
         if (isset($token->error)) {
-            throw new Exception('Error encountered while getting request token: ' . $token->error);
+            throw new Exception('Error encountered while getting request token: '.$token->error);
         }
 
         return $token;
@@ -128,7 +128,7 @@ 
      */
     public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
     {
-        $endpoint = $this->oauthEndpoint . '/token&format=json';
+        $endpoint = $this->oauthEndpoint.'/token&format=json';
 
         $requestConsumer = new OAuthConsumer($oauthRequestToken, $oauthRequestSecret);
 
@@ -146,7 +146,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
+            throw new Exception('Curl error: '.$this->httpHelper->getError());
         }
 
         $token = json_decode($data);
@@ -156,7 +156,7 @@ 
         }
 
         if (isset($token->error)) {
-            throw new Exception('Error encountered while getting access token: ' . $token->error);
+            throw new Exception('Error encountered while getting access token: '.$token->error);
         }
 
         return $token;
@@ -172,7 +172,7 @@ 
      */
     public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
     {
-        $endpoint = $this->oauthEndpoint . '/identify&format=json';
+        $endpoint = $this->oauthEndpoint.'/identify&format=json';
 
         $oauthToken = new OAuthToken($oauthAccessToken, $oauthAccessSecret);
 
@@ -189,7 +189,7 @@ 
         $data = $this->httpHelper->get($targetUrl, null);
 
         if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
+            throw new Exception('Curl error: '.$this->httpHelper->getError());
         }
 
         $decodedData = json_decode($data);
@@ -243,7 +243,7 @@ 
         }
 
         if ($data === false) {
-            throw new Exception('Curl error: ' . $this->httpHelper->getError());
+            throw new Exception('Curl error: '.$this->httpHelper->getError());
         }
 
         return json_decode($data);