mdaniels5757 / waca

includes/Helpers/PreferenceManager.php

Indentation +183 added lines, -183 removed lines

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

includes/Helpers/OAuthUserHelper.php

Indentation +452 added lines, -452 removed lines

@@ -25,460 +25,460 @@
 
 class OAuthUserHelper implements IMediaWikiClient
 {
-    const TOKEN_REQUEST = 'request';
-    const TOKEN_ACCESS = 'access';
-    /** @var PDOStatement */
-    private static $tokenCountStatement = null;
-    /** @var PDOStatement */
-    private $getTokenStatement;
-    /**
-     * @var User
-     */
-    private $user;
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-    /**
-     * @var IOAuthProtocolHelper
-     */
-    private $oauthProtocolHelper;
-    /**
-     * @var bool|null Is the user linked to OAuth
-     */
-    private $linked;
-    private $partiallyLinked;
-    /** @var OAuthToken */
-    private $accessToken;
-    /** @var bool */
-    private $accessTokenLoaded = false;
-    /**
-     * @var OAuthIdentity
-     */
-    private $identity = null;
-    /**
-     * @var bool
-     */
-    private $identityLoaded = false;
-    /**
-     * @var SiteConfiguration
-     */
-    private $siteConfiguration;
-
-    private $legacyTokens;
-
-    #region Static methods
-
-    public static function findUserByRequestToken($requestToken, PdoDatabase $database)
-    {
-        $statement = $database->prepare(<<<'SQL'
+	const TOKEN_REQUEST = 'request';
+	const TOKEN_ACCESS = 'access';
+	/** @var PDOStatement */
+	private static $tokenCountStatement = null;
+	/** @var PDOStatement */
+	private $getTokenStatement;
+	/**
+	 * @var User
+	 */
+	private $user;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+	/**
+	 * @var IOAuthProtocolHelper
+	 */
+	private $oauthProtocolHelper;
+	/**
+	 * @var bool|null Is the user linked to OAuth
+	 */
+	private $linked;
+	private $partiallyLinked;
+	/** @var OAuthToken */
+	private $accessToken;
+	/** @var bool */
+	private $accessTokenLoaded = false;
+	/**
+	 * @var OAuthIdentity
+	 */
+	private $identity = null;
+	/**
+	 * @var bool
+	 */
+	private $identityLoaded = false;
+	/**
+	 * @var SiteConfiguration
+	 */
+	private $siteConfiguration;
+
+	private $legacyTokens;
+
+	#region Static methods
+
+	public static function findUserByRequestToken($requestToken, PdoDatabase $database)
+	{
+		$statement = $database->prepare(<<<'SQL'
             SELECT u.* FROM user u 
             INNER JOIN oauthtoken t ON t.user = u.id 
             WHERE t.type = :type AND t.token = :token
 SQL
-        );
-        $statement->execute(array(':type' => self::TOKEN_REQUEST, ':token' => $requestToken));
-
-        /** @var User $user */
-        $user = $statement->fetchObject(User::class);
-        $statement->closeCursor();
-
-        if ($user === false) {
-            throw new ApplicationLogicException('Token not found in store, please try again');
-        }
-
-        $user->setDatabase($database);
-
-        return $user;
-    }
-
-    public static function userIsFullyLinked(User $user, PdoDatabase $database = null)
-    {
-        if (self::$tokenCountStatement === null && $database === null) {
-            throw new ApplicationLogicException('Static link request without initialised statement');
-        }
-
-        return self::runTokenCount($user->getId(), $database, self::TOKEN_ACCESS);
-    }
-
-    public static function userIsPartiallyLinked(User $user, PdoDatabase $database = null)
-    {
-        if (self::$tokenCountStatement === null && $database === null) {
-            throw new ApplicationLogicException('Static link request without initialised statement');
-        }
-
-        if (self::userIsFullyLinked($user, $database)) {
-            return false;
-        }
-
-        return self::runTokenCount($user->getId(), $database, self::TOKEN_REQUEST)
-            || $user->getOnWikiName() == null;
-    }
-
-    /**
-     * @param PdoDatabase $database
-     */
-    public static function prepareTokenCountStatement(PdoDatabase $database)
-    {
-        if (self::$tokenCountStatement === null) {
-            self::$tokenCountStatement = $database->prepare('SELECT COUNT(*) FROM oauthtoken WHERE user = :user AND type = :type');
-        }
-    }
-
-    private static function runTokenCount($userId, $database, $tokenType)
-    {
-        if (self::$tokenCountStatement === null) {
-            self::prepareTokenCountStatement($database);
-        }
-
-        self::$tokenCountStatement->execute(array(
-            ':user' => $userId,
-            ':type' => $tokenType,
-        ));
-
-        $tokenCount = self::$tokenCountStatement->fetchColumn();
-        $linked = $tokenCount > 0;
-        self::$tokenCountStatement->closeCursor();
-
-        return $linked;
-    }
-
-    #endregion Static methods
-
-    /**
-     * OAuthUserHelper constructor.
-     *
-     * @param User                 $user
-     * @param PdoDatabase          $database
-     * @param IOAuthProtocolHelper $oauthProtocolHelper
-     * @param SiteConfiguration    $siteConfiguration
-     */
-    public function __construct(
-        User $user,
-        PdoDatabase $database,
-        IOAuthProtocolHelper $oauthProtocolHelper,
-        SiteConfiguration $siteConfiguration
-    ) {
-        $this->user = $user;
-        $this->database = $database;
-        $this->oauthProtocolHelper = $oauthProtocolHelper;
-
-        $this->linked = null;
-        $this->partiallyLinked = null;
-        $this->siteConfiguration = $siteConfiguration;
-
-        self::prepareTokenCountStatement($database);
-        $this->getTokenStatement = $this->database->prepare('SELECT * FROM oauthtoken WHERE user = :user AND type = :type');
-
-        $this->legacyTokens = $this->siteConfiguration->getOauthLegacyConsumerTokens();
-    }
-
-    /**
-     * Determines if the user is fully connected to OAuth.
-     *
-     * @return bool
-     */
-    public function isFullyLinked()
-    {
-        if ($this->linked === null) {
-            $this->linked = self::userIsFullyLinked($this->user, $this->database);
-        }
-
-        return $this->linked;
-    }
-
-    /**
-     * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
-     * procedure before configuring.
-     * @return bool
-     */
-    public function isPartiallyLinked()
-    {
-        if ($this->partiallyLinked === null) {
-            $this->partiallyLinked = self::userIsPartiallyLinked($this->user, $this->database);
-        }
-
-        return $this->partiallyLinked;
-    }
-
-    public function canCreateAccount()
-    {
-        return $this->isFullyLinked()
-            && $this->getIdentity(true)->getGrantBasic()
-            && $this->getIdentity(true)->getGrantHighVolume()
-            && $this->getIdentity(true)->getGrantCreateAccount();
-    }
-
-    public function canWelcome()
-    {
-        return $this->isFullyLinked()
-            && $this->getIdentity(true)->getGrantBasic()
-            && $this->getIdentity(true)->getGrantHighVolume()
-            && $this->getIdentity(true)->getGrantCreateEditMovePage();
-    }
-
-    /**
-     * @throws OAuthException
-     * @throws CurlException
-     * @throws OptimisticLockFailedException
-     * @throws Exception
-     */
-    public function refreshIdentity()
-    {
-        $this->loadIdentity();
-
-        if ($this->identity === null) {
-            $this->identity = new OAuthIdentity();
-            $this->identity->setUserId($this->user->getId());
-            $this->identity->setDatabase($this->database);
-        }
-
-        $token = $this->loadAccessToken();
-
-        try {
-            $rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
-        }
-        catch (Exception $ex) {
-            if (strpos($ex->getMessage(), "mwoauthdatastore-access-token-not-found") !== false) {
-                throw new OAuthException('No approved grants for this access token.', -1, $ex);
-            }
-
-            throw $ex;
-        }
-
-        $this->identity->populate($rawTicket);
-
-        if (!$this->identityIsValid()) {
-            throw new OAuthException('Identity ticket is not valid!');
-        }
-
-        $this->identity->save();
-
-        $this->user->setOnWikiName($this->identity->getUsername());
-        $this->user->save();
-    }
-
-    /**
-     * @return string
-     * @throws CurlException
-     */
-    public function getRequestToken()
-    {
-        $token = $this->oauthProtocolHelper->getRequestToken();
-
-        $this->partiallyLinked = true;
-        $this->linked = false;
-
-        $this->database
-            ->prepare('DELETE FROM oauthtoken WHERE user = :user AND type = :type')
-            ->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
-
-        $this->database
-            ->prepare('INSERT INTO oauthtoken (user, type, token, secret, expiry) VALUES (:user, :type, :token, :secret, DATE_ADD(NOW(), INTERVAL 1 DAY))')
-            ->execute(array(
-                ':user'   => $this->user->getId(),
-                ':type'   => self::TOKEN_REQUEST,
-                ':token'  => $token->key,
-                ':secret' => $token->secret,
-            ));
-
-        return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
-    }
-
-    /**
-     * @param $verificationToken
-     *
-     * @throws ApplicationLogicException
-     * @throws CurlException
-     * @throws OAuthException
-     * @throws OptimisticLockFailedException
-     */
-    public function completeHandshake($verificationToken)
-    {
-        $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
-
-        /** @var OAuthToken $token */
-        $token = $this->getTokenStatement->fetchObject(OAuthToken::class);
-        $this->getTokenStatement->closeCursor();
-
-        if ($token === false) {
-            throw new ApplicationLogicException('Cannot find request token');
-        }
-
-        $token->setDatabase($this->database);
-
-        $accessToken = $this->oauthProtocolHelper->callbackCompleted($token->getToken(), $token->getSecret(),
-            $verificationToken);
-
-        $clearStatement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :u AND type = :t');
-        $clearStatement->execute(array(':u' => $this->user->getId(), ':t' => self::TOKEN_ACCESS));
-
-        $token->setToken($accessToken->key);
-        $token->setSecret($accessToken->secret);
-        $token->setType(self::TOKEN_ACCESS);
-        $token->setExpiry(null);
-        $token->save();
-
-        $this->partiallyLinked = false;
-        $this->linked = true;
-
-        $this->refreshIdentity();
-    }
-
-    public function detach()
-    {
-        $this->loadIdentity();
-
-        $this->identity->delete();
-        $statement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :user');
-        $statement->execute(array(':user' => $this->user->getId()));
-
-        $this->identity = null;
-        $this->linked = false;
-        $this->partiallyLinked = false;
-    }
-
-    /**
-     * @param bool $expiredOk
-     *
-     * @return OAuthIdentity
-     * @throws OAuthException
-     */
-    public function getIdentity($expiredOk = false)
-    {
-        $this->loadIdentity();
-
-        if (!$this->identityIsValid($expiredOk)) {
-            throw new OAuthException('Stored identity is not valid.');
-        }
-
-        return $this->identity;
-    }
-
-    public function doApiCall($params, $method)
-    {
-        // Ensure we're logged in
-        $params['assert'] = 'user';
-
-        $token = $this->loadAccessToken();
-        return $this->oauthProtocolHelper->apiCall($params, $token->getToken(), $token->getSecret(), $method);
-    }
-
-    /**
-     * @param bool $expiredOk
-     *
-     * @return bool
-     */
-    private function identityIsValid($expiredOk = false)
-    {
-        $this->loadIdentity();
-
-        if ($this->identity === null) {
-            return false;
-        }
-
-        if ($this->identity->getIssuedAtTime() === false
-            || $this->identity->getExpirationTime() === false
-            || $this->identity->getAudience() === false
-            || $this->identity->getIssuer() === false
-        ) {
-            // this isn't populated properly.
-            return false;
-        }
-
-        $issue = DateTimeImmutable::createFromFormat("U", $this->identity->getIssuedAtTime());
-        $now = new DateTimeImmutable();
-
-        if ($issue > $now) {
-            // wat.
-            return false;
-        }
-
-        if ($this->identityExpired() && !$expiredOk) {
-            // soz.
-            return false;
-        }
-
-        if ($this->identity->getAudience() !== $this->siteConfiguration->getOAuthConsumerToken()) {
-            // token not issued for us
-
-            // we allow cases where the cache is expired and the cache is for a legacy token
-            if (!($expiredOk && in_array($this->identity->getAudience(), $this->legacyTokens))) {
-                return false;
-            }
-        }
-
-        if ($this->identity->getIssuer() !== $this->siteConfiguration->getOauthMediaWikiCanonicalServer()) {
-            // token not issued by the right person
-            return false;
-        }
-
-        // can't find a reason to not trust it
-        return true;
-    }
-
-    /**
-     * @return bool
-     */
-    public function identityExpired()
-    {
-        // allowed max age
-        $gracePeriod = $this->siteConfiguration->getOauthIdentityGraceTime();
-
-        $expiry = DateTimeImmutable::createFromFormat("U", $this->identity->getExpirationTime());
-        $graceExpiry = $expiry->modify($gracePeriod);
-        $now = new DateTimeImmutable();
-
-        return $graceExpiry < $now;
-    }
-
-    /**
-     * Loads the OAuth identity from the database for the current user.
-     */
-    private function loadIdentity()
-    {
-        if ($this->identityLoaded) {
-            return;
-        }
-
-        $statement = $this->database->prepare('SELECT * FROM oauthidentity WHERE user = :user');
-        $statement->execute(array(':user' => $this->user->getId()));
-        /** @var OAuthIdentity $obj */
-        $obj = $statement->fetchObject(OAuthIdentity::class);
-
-        if ($obj === false) {
-            // failed to load identity.
-            $this->identityLoaded = true;
-            $this->identity = null;
-
-            return;
-        }
-
-        $obj->setDatabase($this->database);
-        $this->identityLoaded = true;
-        $this->identity = $obj;
-    }
-
-    /**
-     * @return OAuthToken
-     * @throws OAuthException
-     */
-    private function loadAccessToken()
-    {
-        if (!$this->accessTokenLoaded) {
-            $this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_ACCESS));
-            /** @var OAuthToken $token */
-            $token = $this->getTokenStatement->fetchObject(OAuthToken::class);
-            $this->getTokenStatement->closeCursor();
-
-            if ($token === false) {
-                throw new OAuthException('Access token not found!');
-            }
-
-            $this->accessToken = $token;
-            $this->accessTokenLoaded = true;
-        }
-
-        return $this->accessToken;
-    }
+		);
+		$statement->execute(array(':type' => self::TOKEN_REQUEST, ':token' => $requestToken));
+
+		/** @var User $user */
+		$user = $statement->fetchObject(User::class);
+		$statement->closeCursor();
+
+		if ($user === false) {
+			throw new ApplicationLogicException('Token not found in store, please try again');
+		}
+
+		$user->setDatabase($database);
+
+		return $user;
+	}
+
+	public static function userIsFullyLinked(User $user, PdoDatabase $database = null)
+	{
+		if (self::$tokenCountStatement === null && $database === null) {
+			throw new ApplicationLogicException('Static link request without initialised statement');
+		}
+
+		return self::runTokenCount($user->getId(), $database, self::TOKEN_ACCESS);
+	}
+
+	public static function userIsPartiallyLinked(User $user, PdoDatabase $database = null)
+	{
+		if (self::$tokenCountStatement === null && $database === null) {
+			throw new ApplicationLogicException('Static link request without initialised statement');
+		}
+
+		if (self::userIsFullyLinked($user, $database)) {
+			return false;
+		}
+
+		return self::runTokenCount($user->getId(), $database, self::TOKEN_REQUEST)
+			|| $user->getOnWikiName() == null;
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 */
+	public static function prepareTokenCountStatement(PdoDatabase $database)
+	{
+		if (self::$tokenCountStatement === null) {
+			self::$tokenCountStatement = $database->prepare('SELECT COUNT(*) FROM oauthtoken WHERE user = :user AND type = :type');
+		}
+	}
+
+	private static function runTokenCount($userId, $database, $tokenType)
+	{
+		if (self::$tokenCountStatement === null) {
+			self::prepareTokenCountStatement($database);
+		}
+
+		self::$tokenCountStatement->execute(array(
+			':user' => $userId,
+			':type' => $tokenType,
+		));
+
+		$tokenCount = self::$tokenCountStatement->fetchColumn();
+		$linked = $tokenCount > 0;
+		self::$tokenCountStatement->closeCursor();
+
+		return $linked;
+	}
+
+	#endregion Static methods
+
+	/**
+	 * OAuthUserHelper constructor.
+	 *
+	 * @param User                 $user
+	 * @param PdoDatabase          $database
+	 * @param IOAuthProtocolHelper $oauthProtocolHelper
+	 * @param SiteConfiguration    $siteConfiguration
+	 */
+	public function __construct(
+		User $user,
+		PdoDatabase $database,
+		IOAuthProtocolHelper $oauthProtocolHelper,
+		SiteConfiguration $siteConfiguration
+	) {
+		$this->user = $user;
+		$this->database = $database;
+		$this->oauthProtocolHelper = $oauthProtocolHelper;
+
+		$this->linked = null;
+		$this->partiallyLinked = null;
+		$this->siteConfiguration = $siteConfiguration;
+
+		self::prepareTokenCountStatement($database);
+		$this->getTokenStatement = $this->database->prepare('SELECT * FROM oauthtoken WHERE user = :user AND type = :type');
+
+		$this->legacyTokens = $this->siteConfiguration->getOauthLegacyConsumerTokens();
+	}
+
+	/**
+	 * Determines if the user is fully connected to OAuth.
+	 *
+	 * @return bool
+	 */
+	public function isFullyLinked()
+	{
+		if ($this->linked === null) {
+			$this->linked = self::userIsFullyLinked($this->user, $this->database);
+		}
+
+		return $this->linked;
+	}
+
+	/**
+	 * Attempts to figure out if a user is partially linked to OAuth, and therefore needs to complete the OAuth
+	 * procedure before configuring.
+	 * @return bool
+	 */
+	public function isPartiallyLinked()
+	{
+		if ($this->partiallyLinked === null) {
+			$this->partiallyLinked = self::userIsPartiallyLinked($this->user, $this->database);
+		}
+
+		return $this->partiallyLinked;
+	}
+
+	public function canCreateAccount()
+	{
+		return $this->isFullyLinked()
+			&& $this->getIdentity(true)->getGrantBasic()
+			&& $this->getIdentity(true)->getGrantHighVolume()
+			&& $this->getIdentity(true)->getGrantCreateAccount();
+	}
+
+	public function canWelcome()
+	{
+		return $this->isFullyLinked()
+			&& $this->getIdentity(true)->getGrantBasic()
+			&& $this->getIdentity(true)->getGrantHighVolume()
+			&& $this->getIdentity(true)->getGrantCreateEditMovePage();
+	}
+
+	/**
+	 * @throws OAuthException
+	 * @throws CurlException
+	 * @throws OptimisticLockFailedException
+	 * @throws Exception
+	 */
+	public function refreshIdentity()
+	{
+		$this->loadIdentity();
+
+		if ($this->identity === null) {
+			$this->identity = new OAuthIdentity();
+			$this->identity->setUserId($this->user->getId());
+			$this->identity->setDatabase($this->database);
+		}
+
+		$token = $this->loadAccessToken();
+
+		try {
+			$rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
+		}
+		catch (Exception $ex) {
+			if (strpos($ex->getMessage(), "mwoauthdatastore-access-token-not-found") !== false) {
+				throw new OAuthException('No approved grants for this access token.', -1, $ex);
+			}
+
+			throw $ex;
+		}
+
+		$this->identity->populate($rawTicket);
+
+		if (!$this->identityIsValid()) {
+			throw new OAuthException('Identity ticket is not valid!');
+		}
+
+		$this->identity->save();
+
+		$this->user->setOnWikiName($this->identity->getUsername());
+		$this->user->save();
+	}
+
+	/**
+	 * @return string
+	 * @throws CurlException
+	 */
+	public function getRequestToken()
+	{
+		$token = $this->oauthProtocolHelper->getRequestToken();
+
+		$this->partiallyLinked = true;
+		$this->linked = false;
+
+		$this->database
+			->prepare('DELETE FROM oauthtoken WHERE user = :user AND type = :type')
+			->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
+
+		$this->database
+			->prepare('INSERT INTO oauthtoken (user, type, token, secret, expiry) VALUES (:user, :type, :token, :secret, DATE_ADD(NOW(), INTERVAL 1 DAY))')
+			->execute(array(
+				':user'   => $this->user->getId(),
+				':type'   => self::TOKEN_REQUEST,
+				':token'  => $token->key,
+				':secret' => $token->secret,
+			));
+
+		return $this->oauthProtocolHelper->getAuthoriseUrl($token->key);
+	}
+
+	/**
+	 * @param $verificationToken
+	 *
+	 * @throws ApplicationLogicException
+	 * @throws CurlException
+	 * @throws OAuthException
+	 * @throws OptimisticLockFailedException
+	 */
+	public function completeHandshake($verificationToken)
+	{
+		$this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_REQUEST));
+
+		/** @var OAuthToken $token */
+		$token = $this->getTokenStatement->fetchObject(OAuthToken::class);
+		$this->getTokenStatement->closeCursor();
+
+		if ($token === false) {
+			throw new ApplicationLogicException('Cannot find request token');
+		}
+
+		$token->setDatabase($this->database);
+
+		$accessToken = $this->oauthProtocolHelper->callbackCompleted($token->getToken(), $token->getSecret(),
+			$verificationToken);
+
+		$clearStatement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :u AND type = :t');
+		$clearStatement->execute(array(':u' => $this->user->getId(), ':t' => self::TOKEN_ACCESS));
+
+		$token->setToken($accessToken->key);
+		$token->setSecret($accessToken->secret);
+		$token->setType(self::TOKEN_ACCESS);
+		$token->setExpiry(null);
+		$token->save();
+
+		$this->partiallyLinked = false;
+		$this->linked = true;
+
+		$this->refreshIdentity();
+	}
+
+	public function detach()
+	{
+		$this->loadIdentity();
+
+		$this->identity->delete();
+		$statement = $this->database->prepare('DELETE FROM oauthtoken WHERE user = :user');
+		$statement->execute(array(':user' => $this->user->getId()));
+
+		$this->identity = null;
+		$this->linked = false;
+		$this->partiallyLinked = false;
+	}
+
+	/**
+	 * @param bool $expiredOk
+	 *
+	 * @return OAuthIdentity
+	 * @throws OAuthException
+	 */
+	public function getIdentity($expiredOk = false)
+	{
+		$this->loadIdentity();
+
+		if (!$this->identityIsValid($expiredOk)) {
+			throw new OAuthException('Stored identity is not valid.');
+		}
+
+		return $this->identity;
+	}
+
+	public function doApiCall($params, $method)
+	{
+		// Ensure we're logged in
+		$params['assert'] = 'user';
+
+		$token = $this->loadAccessToken();
+		return $this->oauthProtocolHelper->apiCall($params, $token->getToken(), $token->getSecret(), $method);
+	}
+
+	/**
+	 * @param bool $expiredOk
+	 *
+	 * @return bool
+	 */
+	private function identityIsValid($expiredOk = false)
+	{
+		$this->loadIdentity();
+
+		if ($this->identity === null) {
+			return false;
+		}
+
+		if ($this->identity->getIssuedAtTime() === false
+			|| $this->identity->getExpirationTime() === false
+			|| $this->identity->getAudience() === false
+			|| $this->identity->getIssuer() === false
+		) {
+			// this isn't populated properly.
+			return false;
+		}
+
+		$issue = DateTimeImmutable::createFromFormat("U", $this->identity->getIssuedAtTime());
+		$now = new DateTimeImmutable();
+
+		if ($issue > $now) {
+			// wat.
+			return false;
+		}
+
+		if ($this->identityExpired() && !$expiredOk) {
+			// soz.
+			return false;
+		}
+
+		if ($this->identity->getAudience() !== $this->siteConfiguration->getOAuthConsumerToken()) {
+			// token not issued for us
+
+			// we allow cases where the cache is expired and the cache is for a legacy token
+			if (!($expiredOk && in_array($this->identity->getAudience(), $this->legacyTokens))) {
+				return false;
+			}
+		}
+
+		if ($this->identity->getIssuer() !== $this->siteConfiguration->getOauthMediaWikiCanonicalServer()) {
+			// token not issued by the right person
+			return false;
+		}
+
+		// can't find a reason to not trust it
+		return true;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function identityExpired()
+	{
+		// allowed max age
+		$gracePeriod = $this->siteConfiguration->getOauthIdentityGraceTime();
+
+		$expiry = DateTimeImmutable::createFromFormat("U", $this->identity->getExpirationTime());
+		$graceExpiry = $expiry->modify($gracePeriod);
+		$now = new DateTimeImmutable();
+
+		return $graceExpiry < $now;
+	}
+
+	/**
+	 * Loads the OAuth identity from the database for the current user.
+	 */
+	private function loadIdentity()
+	{
+		if ($this->identityLoaded) {
+			return;
+		}
+
+		$statement = $this->database->prepare('SELECT * FROM oauthidentity WHERE user = :user');
+		$statement->execute(array(':user' => $this->user->getId()));
+		/** @var OAuthIdentity $obj */
+		$obj = $statement->fetchObject(OAuthIdentity::class);
+
+		if ($obj === false) {
+			// failed to load identity.
+			$this->identityLoaded = true;
+			$this->identity = null;
+
+			return;
+		}
+
+		$obj->setDatabase($this->database);
+		$this->identityLoaded = true;
+		$this->identity = $obj;
+	}
+
+	/**
+	 * @return OAuthToken
+	 * @throws OAuthException
+	 */
+	private function loadAccessToken()
+	{
+		if (!$this->accessTokenLoaded) {
+			$this->getTokenStatement->execute(array(':user' => $this->user->getId(), ':type' => self::TOKEN_ACCESS));
+			/** @var OAuthToken $token */
+			$token = $this->getTokenStatement->fetchObject(OAuthToken::class);
+			$this->getTokenStatement->closeCursor();
+
+			if ($token === false) {
+				throw new OAuthException('Access token not found!');
+			}
+
+			$this->accessToken = $token;
+			$this->accessTokenLoaded = true;
+		}
+
+		return $this->accessToken;
+	}
 }

includes/Helpers/BotMediaWikiClient.php

Indentation +132 added lines, -132 removed lines

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

Braces +4 added lines, -8 removed lines

@@ -72,12 +72,10 @@ 
             $userinfoResult = $this->callApi(array('action' => 'query', 'meta' => 'userinfo'), 'GET');
             if (isset($userinfoResult->query->userinfo->anon)) {
                 throw new MediaWikiApiException('Unable to log in.');
-            }
-            else {
+            } else {
                 $this->knownLoggedIn = true;
             }
-        }
-        else {
+        } else {
             $this->knownLoggedIn = true;
         }
     }
@@ -96,11 +94,9 @@ 
 
         if ($method == 'GET') {
             $data = $this->httpHelper->get($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        elseif ($method == 'POST') {
+        } elseif ($method == 'POST') {
             $data = $this->httpHelper->post($this->mediawikiWebServiceEndpoint, $apiParams);
-        }
-        else {
+        } else {
             throw new ApplicationLogicException('Unsupported HTTP Method');
         }
 

includes/Helpers/Logger.php

Braces +1 added lines, -2 removed lines

@@ -74,8 +74,7 @@
 
         if ($domain !== null) {
             $log->setDomain($domain);
-        }
-        elseif (method_exists($object, 'getDomain')) {
+        } elseif (method_exists($object, 'getDomain')) {
             $log->setDomain($object->getDomain());
         }
 

Indentation +423 added lines, -423 removed lines

@@ -34,427 +34,427 @@
  */
 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|null   $user
-     * @param int|null    $domain
-     *
-     * @throws Exception
-     */
-    private static function createLogEntry(
-        PdoDatabase $database,
-        DataObject $object,
-        $logAction,
-        $comment = null,
-        $user = null,
-        ?int $domain = 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();
-
-        if ($domain !== null) {
-            $log->setDomain($domain);
-        }
-        elseif (method_exists($object, 'getDomain')) {
-            $log->setDomain($object->getDomain());
-        }
-
-        $log->setDatabase($database);
-        $log->setAction($logAction);
-        $log->setObjectId($object->getId());
-        $log->setObjectType($objectType);
-        $log->setUser($user);
-        $log->setComment($comment);
-        $log->save();
-    }
-
-    #region Users
-
-    /**
-     * @throws Exception
-     */
-    public static function newUser(PdoDatabase $database, User $user)
-    {
-        self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function approvedUser(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Approved");
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function declinedUser(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, "Declined", $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function suspendedUser(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, "Suspended", $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function renamedUser(PdoDatabase $database, User $object, string $comment)
-    {
-        self::createLogEntry($database, $object, "Renamed", $comment);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userPreferencesChange(PdoDatabase $database, User $object)
-    {
-        self::createLogEntry($database, $object, "Prefchange");
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userRolesEdited(
-        PdoDatabase $database,
-        User $object,
-        string $reason,
-        array $added,
-        array $removed,
-        int $domain
-    ) {
-        $logData = serialize(array(
-            'added'   => $added,
-            'removed' => $removed,
-            'reason'  => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "RoleChange", $logData, null, $domain);
-    }
-
-    /**
-     * @throws Exception
-     */
-    public static function userGlobalRolesEdited(
-        PdoDatabase $database,
-        User $object,
-        string $reason,
-        array $added,
-        array $removed
-    ): void {
-        $logData = serialize(array(
-            'added' => $added,
-            'removed' => $removed,
-            'reason' => $reason,
-        ));
-
-        self::createLogEntry($database, $object, "GlobalRoleChange", $logData);
-    }
-
-    #endregion
-
-    /**
-     * @param PdoDatabase $database
-     * @param SiteNotice  $object
-     */
-    public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
-    {
-        self::createLogEntry($database, $object, "Edited");
-    }
-
-    #region Welcome Templates
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedTemplate");
-    }
-
-    /**
-     * @param PdoDatabase     $database
-     * @param WelcomeTemplate $object
-     */
-    public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
-    {
-        self::createLogEntry($database, $object, "DeletedTemplate");
-    }
-
-    #endregion
-
-    #region Bans
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function banned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Banned", $reason);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Ban         $object
-     * @param string      $reason
-     */
-    public static function unbanned(PdoDatabase $database, Ban $object, $reason)
-    {
-        self::createLogEntry($database, $object, "Unbanned", $reason);
-    }
-
-    public static function banReplaced(PdoDatabase $database, Ban $object)
-    {
-        self::createLogEntry($database, $object, "BanReplaced");
-    }
-
-    #endregion
-
-    #region Requests
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $target
-     */
-    public static function deferRequest(PdoDatabase $database, Request $object, $target)
-    {
-        self::createLogEntry($database, $object, "Deferred to $target");
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param integer     $target
-     * @param string      $comment
-     * @param User|null   $logUser
-     */
-    public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
-    {
-        self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
-    }
-
-    public static function manuallyConfirmRequest(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, "Manually Confirmed");
-    }
-
-    /**
-     * @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", null, null, $request->getDomain());
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     */
-    public static function flaggedComment(PdoDatabase $database, Comment $object, int $domain)
-    {
-        self::createLogEntry($database, $object, "FlaggedComment", null, null, $domain);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Comment     $object
-     */
-    public static function unflaggedComment(PdoDatabase $database, Comment $object, int $domain)
-    {
-        self::createLogEntry($database, $object, "UnflaggedComment", null, null, $domain);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param User        $target
-     */
-    public static function sendReservation(PdoDatabase $database, Request $object, User $target)
-    {
-        self::createLogEntry($database, $object, "SendReserved");
-        self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     * @param string      $comment
-     */
-    public static function sentMail(PdoDatabase $database, Request $object, $comment)
-    {
-        self::createLogEntry($database, $object, "SentMail", $comment);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     * @param Request     $object
-     */
-    public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'EnqueuedJobQueue');
-    }
-
-    public static function hospitalised(PdoDatabase $database, Request $object)
-    {
-        self::createLogEntry($database, $object, 'Hospitalised');
-    }
-    #endregion
-
-    #region Email templates
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function createEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "CreatedEmail");
-    }
-
-    /**
-     * @param PdoDatabase   $database
-     * @param EmailTemplate $object
-     */
-    public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
-    {
-        self::createLogEntry($database, $object, "EditedEmail");
-    }
-
-    #endregion
-
-    #region Display
-
-    #endregion
-
-    #region Automation
-
-    public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
-    }
-
-    public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
-    {
-        $data = array('status' => $job->getStatus(), 'error' => $job->getError());
-        self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
-    }
-
-    public static function backgroundJobCancelled(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobCancelled', $job->getError());
-    }
-
-    public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
-    {
-        self::createLogEntry($database, $job, 'JobRequeued');
-    }
-
-    public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job, $comment = null)
-    {
-        self::createLogEntry($database, $job, 'JobAcknowledged', $comment);
-    }
-    #endregion
-
-    #region Request Queues
-    public static function requestQueueCreated(PdoDatabase $database, RequestQueue $queue)
-    {
-        self::createLogEntry($database, $queue, 'QueueCreated');
-    }
-
-    public static function requestQueueEdited(PdoDatabase $database, RequestQueue $queue)
-    {
-        self::createLogEntry($database, $queue, 'QueueEdited');
-    }
-    #endregion
-    #region Domains
-    public static function domainCreated(PdoDatabase $database, Domain $domain)
-    {
-        self::createLogEntry($database, $domain, 'DomainCreated');
-    }
-
-    public static function domainEdited(PdoDatabase $database, Domain $domain)
-    {
-        self::createLogEntry($database, $domain, 'DomainEdited');
-    }
-    #endregion
-    #region Request Forms
-    public static function requestFormCreated(PdoDatabase $database, RequestForm $requestForm)
-    {
-        self::createLogEntry($database, $requestForm, 'RequestFormCreated');
-    }
-
-    public static function requestFormEdited(PdoDatabase $database, RequestForm $requestForm)
-    {
-        self::createLogEntry($database, $requestForm, 'RequestFormEdited');
-    }
-    #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|null   $user
+	 * @param int|null    $domain
+	 *
+	 * @throws Exception
+	 */
+	private static function createLogEntry(
+		PdoDatabase $database,
+		DataObject $object,
+		$logAction,
+		$comment = null,
+		$user = null,
+		?int $domain = 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();
+
+		if ($domain !== null) {
+			$log->setDomain($domain);
+		}
+		elseif (method_exists($object, 'getDomain')) {
+			$log->setDomain($object->getDomain());
+		}
+
+		$log->setDatabase($database);
+		$log->setAction($logAction);
+		$log->setObjectId($object->getId());
+		$log->setObjectType($objectType);
+		$log->setUser($user);
+		$log->setComment($comment);
+		$log->save();
+	}
+
+	#region Users
+
+	/**
+	 * @throws Exception
+	 */
+	public static function newUser(PdoDatabase $database, User $user)
+	{
+		self::createLogEntry($database, $user, 'Registered', null, User::getCommunity());
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function approvedUser(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Approved");
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function declinedUser(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, "Declined", $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function suspendedUser(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, "Suspended", $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function renamedUser(PdoDatabase $database, User $object, string $comment)
+	{
+		self::createLogEntry($database, $object, "Renamed", $comment);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userPreferencesChange(PdoDatabase $database, User $object)
+	{
+		self::createLogEntry($database, $object, "Prefchange");
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userRolesEdited(
+		PdoDatabase $database,
+		User $object,
+		string $reason,
+		array $added,
+		array $removed,
+		int $domain
+	) {
+		$logData = serialize(array(
+			'added'   => $added,
+			'removed' => $removed,
+			'reason'  => $reason,
+		));
+
+		self::createLogEntry($database, $object, "RoleChange", $logData, null, $domain);
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public static function userGlobalRolesEdited(
+		PdoDatabase $database,
+		User $object,
+		string $reason,
+		array $added,
+		array $removed
+	): void {
+		$logData = serialize(array(
+			'added' => $added,
+			'removed' => $removed,
+			'reason' => $reason,
+		));
+
+		self::createLogEntry($database, $object, "GlobalRoleChange", $logData);
+	}
+
+	#endregion
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param SiteNotice  $object
+	 */
+	public static function siteNoticeEdited(PdoDatabase $database, SiteNotice $object)
+	{
+		self::createLogEntry($database, $object, "Edited");
+	}
+
+	#region Welcome Templates
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateCreated(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateEdited(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedTemplate");
+	}
+
+	/**
+	 * @param PdoDatabase     $database
+	 * @param WelcomeTemplate $object
+	 */
+	public static function welcomeTemplateDeleted(PdoDatabase $database, WelcomeTemplate $object)
+	{
+		self::createLogEntry($database, $object, "DeletedTemplate");
+	}
+
+	#endregion
+
+	#region Bans
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function banned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Banned", $reason);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Ban         $object
+	 * @param string      $reason
+	 */
+	public static function unbanned(PdoDatabase $database, Ban $object, $reason)
+	{
+		self::createLogEntry($database, $object, "Unbanned", $reason);
+	}
+
+	public static function banReplaced(PdoDatabase $database, Ban $object)
+	{
+		self::createLogEntry($database, $object, "BanReplaced");
+	}
+
+	#endregion
+
+	#region Requests
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $target
+	 */
+	public static function deferRequest(PdoDatabase $database, Request $object, $target)
+	{
+		self::createLogEntry($database, $object, "Deferred to $target");
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param integer     $target
+	 * @param string      $comment
+	 * @param User|null   $logUser
+	 */
+	public static function closeRequest(PdoDatabase $database, Request $object, $target, $comment, User $logUser = null)
+	{
+		self::createLogEntry($database, $object, "Closed $target", $comment, $logUser);
+	}
+
+	public static function manuallyConfirmRequest(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, "Manually Confirmed");
+	}
+
+	/**
+	 * @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", null, null, $request->getDomain());
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 */
+	public static function flaggedComment(PdoDatabase $database, Comment $object, int $domain)
+	{
+		self::createLogEntry($database, $object, "FlaggedComment", null, null, $domain);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Comment     $object
+	 */
+	public static function unflaggedComment(PdoDatabase $database, Comment $object, int $domain)
+	{
+		self::createLogEntry($database, $object, "UnflaggedComment", null, null, $domain);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param User        $target
+	 */
+	public static function sendReservation(PdoDatabase $database, Request $object, User $target)
+	{
+		self::createLogEntry($database, $object, "SendReserved");
+		self::createLogEntry($database, $object, "ReceiveReserved", null, $target);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 * @param string      $comment
+	 */
+	public static function sentMail(PdoDatabase $database, Request $object, $comment)
+	{
+		self::createLogEntry($database, $object, "SentMail", $comment);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 * @param Request     $object
+	 */
+	public static function enqueuedJobQueue(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'EnqueuedJobQueue');
+	}
+
+	public static function hospitalised(PdoDatabase $database, Request $object)
+	{
+		self::createLogEntry($database, $object, 'Hospitalised');
+	}
+	#endregion
+
+	#region Email templates
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function createEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "CreatedEmail");
+	}
+
+	/**
+	 * @param PdoDatabase   $database
+	 * @param EmailTemplate $object
+	 */
+	public static function editedEmail(PdoDatabase $database, EmailTemplate $object)
+	{
+		self::createLogEntry($database, $object, "EditedEmail");
+	}
+
+	#endregion
+
+	#region Display
+
+	#endregion
+
+	#region Automation
+
+	public static function backgroundJobComplete(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCompleted', null, User::getCommunity());
+	}
+
+	public static function backgroundJobIssue(PdoDatabase $database, JobQueue $job)
+	{
+		$data = array('status' => $job->getStatus(), 'error' => $job->getError());
+		self::createLogEntry($database, $job, 'JobIssue', serialize($data), User::getCommunity());
+	}
+
+	public static function backgroundJobCancelled(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobCancelled', $job->getError());
+	}
+
+	public static function backgroundJobRequeued(PdoDatabase $database, JobQueue $job)
+	{
+		self::createLogEntry($database, $job, 'JobRequeued');
+	}
+
+	public static function backgroundJobAcknowledged(PdoDatabase $database, JobQueue $job, $comment = null)
+	{
+		self::createLogEntry($database, $job, 'JobAcknowledged', $comment);
+	}
+	#endregion
+
+	#region Request Queues
+	public static function requestQueueCreated(PdoDatabase $database, RequestQueue $queue)
+	{
+		self::createLogEntry($database, $queue, 'QueueCreated');
+	}
+
+	public static function requestQueueEdited(PdoDatabase $database, RequestQueue $queue)
+	{
+		self::createLogEntry($database, $queue, 'QueueEdited');
+	}
+	#endregion
+	#region Domains
+	public static function domainCreated(PdoDatabase $database, Domain $domain)
+	{
+		self::createLogEntry($database, $domain, 'DomainCreated');
+	}
+
+	public static function domainEdited(PdoDatabase $database, Domain $domain)
+	{
+		self::createLogEntry($database, $domain, 'DomainEdited');
+	}
+	#endregion
+	#region Request Forms
+	public static function requestFormCreated(PdoDatabase $database, RequestForm $requestForm)
+	{
+		self::createLogEntry($database, $requestForm, 'RequestFormCreated');
+	}
+
+	public static function requestFormEdited(PdoDatabase $database, RequestForm $requestForm)
+	{
+		self::createLogEntry($database, $requestForm, 'RequestFormEdited');
+	}
+	#endregion
 }

includes/Helpers/OAuthProtocolHelper.php

Indentation +131 added lines, -131 removed lines

@@ -18,135 +18,135 @@
 
 class OAuthProtocolHelper implements Interfaces\IOAuthProtocolHelper
 {
-    private $authUrl;
-    /**
-     * @var PdoDatabase
-     */
-    private $database;
-    /**
-     * @var string
-     */
-    private $consumerKey;
-    /**
-     * @var string
-     */
-    private $consumerSecret;
-    /**
-     * @var string
-     */
-    private $userAgent;
-
-    /**
-     * OAuthHelper constructor.
-     *
-     * @param string     $consumerKey
-     * @param string     $consumerSecret
-     * @param PdoDatabase $database
-     * @param string      $userAgent
-     */
-    public function __construct(
-        $consumerKey,
-        $consumerSecret,
-        PdoDatabase $database,
-        $userAgent
-    ) {
-        $this->consumerKey = $consumerKey;
-        $this->consumerSecret = $consumerSecret;
-        $this->userAgent = $userAgent;
-        $this->database = $database;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getRequestToken()
-    {
-        /** @var Token $requestToken */
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        list($authUrl, $requestToken) = $this->getClient($domain)->initiate();
-        $this->authUrl = $authUrl;
-        return $requestToken;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getAuthoriseUrl($requestToken)
-    {
-        return $this->authUrl;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
-    {
-        $requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        return $this->getClient($domain)->complete($requestToken, $oauthVerifier);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
-    {
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        return $this->getClient($domain)->identify(new Token($oauthAccessToken, $oauthAccessSecret));
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
-    {
-        $userToken = new Token($accessToken, $accessSecret);
-
-        $apiParams['format'] = 'json';
-
-        if ($apiParams === null || !is_array($apiParams)) {
-            throw new CurlException("Invalid API call");
-        }
-
-        // FIXME: domains!
-        /** @var Domain $domain */
-        $domain = Domain::getById(1, $this->database);
-
-        $url = $domain->getWikiApiPath();
-        $isPost = ($method === 'POST');
-
-        if ($method === 'GET') {
-            $query = http_build_query($apiParams);
-            $url .= '?' . $query;
-            $apiParams = null;
-        }
-
-        $data = $this->getClient($domain)->makeOAuthCall($userToken, $url, $isPost, $apiParams);
-
-        return json_decode($data);
-    }
-
-    /**
-     * @param string $oauthEndpoint
-     *
-     * @return Client
-     */
-    protected function getClient(Domain $domain) : Client
-    {
-        $oauthClientConfig = new ClientConfig($domain->getWikiArticlePath() . "?title=Special:OAuth");
-        $oauthClientConfig->setConsumer(new Consumer($this->consumerKey, $this->consumerSecret));
-        $oauthClientConfig->setUserAgent($this->userAgent);
-        return new Client($oauthClientConfig);
-    }
+	private $authUrl;
+	/**
+	 * @var PdoDatabase
+	 */
+	private $database;
+	/**
+	 * @var string
+	 */
+	private $consumerKey;
+	/**
+	 * @var string
+	 */
+	private $consumerSecret;
+	/**
+	 * @var string
+	 */
+	private $userAgent;
+
+	/**
+	 * OAuthHelper constructor.
+	 *
+	 * @param string     $consumerKey
+	 * @param string     $consumerSecret
+	 * @param PdoDatabase $database
+	 * @param string      $userAgent
+	 */
+	public function __construct(
+		$consumerKey,
+		$consumerSecret,
+		PdoDatabase $database,
+		$userAgent
+	) {
+		$this->consumerKey = $consumerKey;
+		$this->consumerSecret = $consumerSecret;
+		$this->userAgent = $userAgent;
+		$this->database = $database;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getRequestToken()
+	{
+		/** @var Token $requestToken */
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		list($authUrl, $requestToken) = $this->getClient($domain)->initiate();
+		$this->authUrl = $authUrl;
+		return $requestToken;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getAuthoriseUrl($requestToken)
+	{
+		return $this->authUrl;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier)
+	{
+		$requestToken = new Token($oauthRequestToken, $oauthRequestSecret);
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		return $this->getClient($domain)->complete($requestToken, $oauthVerifier);
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret)
+	{
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		return $this->getClient($domain)->identify(new Token($oauthAccessToken, $oauthAccessSecret));
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function apiCall($apiParams, $accessToken, $accessSecret, $method = 'GET')
+	{
+		$userToken = new Token($accessToken, $accessSecret);
+
+		$apiParams['format'] = 'json';
+
+		if ($apiParams === null || !is_array($apiParams)) {
+			throw new CurlException("Invalid API call");
+		}
+
+		// FIXME: domains!
+		/** @var Domain $domain */
+		$domain = Domain::getById(1, $this->database);
+
+		$url = $domain->getWikiApiPath();
+		$isPost = ($method === 'POST');
+
+		if ($method === 'GET') {
+			$query = http_build_query($apiParams);
+			$url .= '?' . $query;
+			$apiParams = null;
+		}
+
+		$data = $this->getClient($domain)->makeOAuthCall($userToken, $url, $isPost, $apiParams);
+
+		return json_decode($data);
+	}
+
+	/**
+	 * @param string $oauthEndpoint
+	 *
+	 * @return Client
+	 */
+	protected function getClient(Domain $domain) : Client
+	{
+		$oauthClientConfig = new ClientConfig($domain->getWikiArticlePath() . "?title=Special:OAuth");
+		$oauthClientConfig->setConsumer(new Consumer($this->consumerKey, $this->consumerSecret));
+		$oauthClientConfig->setUserAgent($this->userAgent);
+		return new Client($oauthClientConfig);
+	}
 }

includes/Helpers/RequestQueueHelper.php

Indentation +63 added lines, -63 removed lines

@@ -15,73 +15,73 @@
 
 class RequestQueueHelper
 {
-    /**
-     * @param RequestQueue $queue
-     * @param bool         $enabled
-     * @param bool         $default
-     * @param bool         $antiSpoof
-     * @param bool         $titleBlacklist
-     */
-    public function configureDefaults(
-        RequestQueue $queue,
-        bool $enabled,
-        bool $default,
-        bool $antiSpoof,
-        bool $titleBlacklist,
-        bool $isTarget
-    ) {
-        // always allow enabling a queue
-        if ($enabled) {
-            $queue->setEnabled($enabled);
-        }
+	/**
+	 * @param RequestQueue $queue
+	 * @param bool         $enabled
+	 * @param bool         $default
+	 * @param bool         $antiSpoof
+	 * @param bool         $titleBlacklist
+	 */
+	public function configureDefaults(
+		RequestQueue $queue,
+		bool $enabled,
+		bool $default,
+		bool $antiSpoof,
+		bool $titleBlacklist,
+		bool $isTarget
+	) {
+		// always allow enabling a queue
+		if ($enabled) {
+			$queue->setEnabled($enabled);
+		}
 
-        // only allow other enable-flag changes if we're not a default
-        if (!($queue->isDefault() || $queue->isDefaultAntispoof() || $queue->isDefaultTitleBlacklist() || $isTarget)) {
-            $queue->setEnabled($enabled);
-        }
+		// only allow other enable-flag changes if we're not a default
+		if (!($queue->isDefault() || $queue->isDefaultAntispoof() || $queue->isDefaultTitleBlacklist() || $isTarget)) {
+			$queue->setEnabled($enabled);
+		}
 
-        // only allow enabling the default flags, and only when we're enabled.
-        $queue->setDefault(($queue->isDefault() || $default) && $queue->isEnabled());
-        $queue->setDefaultAntispoof(($queue->isDefaultAntispoof() || $antiSpoof) && $queue->isEnabled());
-        $queue->setDefaultTitleBlacklist(($queue->isDefaultTitleBlacklist() || $titleBlacklist) && $queue->isEnabled());
-    }
+		// only allow enabling the default flags, and only when we're enabled.
+		$queue->setDefault(($queue->isDefault() || $default) && $queue->isEnabled());
+		$queue->setDefaultAntispoof(($queue->isDefaultAntispoof() || $antiSpoof) && $queue->isEnabled());
+		$queue->setDefaultTitleBlacklist(($queue->isDefaultTitleBlacklist() || $titleBlacklist) && $queue->isEnabled());
+	}
 
-    /**
-     * Returns true if the specified queue is a target of an enabled email template with a defer action.
-     *
-     * @param RequestQueue $queue
-     * @param PdoDatabase  $database
-     *
-     * @return bool
-     */
-    public function isEmailTemplateTarget(RequestQueue $queue, PdoDatabase $database): bool
-    {
-        $isTarget = false;
-        /** @var EmailTemplate[] $deferralTemplates */
-        $deferralTemplates = EmailTemplate::getAllActiveTemplates(EmailTemplate::ACTION_DEFER, $database, $queue->getDomain());
-        foreach ($deferralTemplates as $t) {
-            if ($t->getQueue() === $queue->getId()) {
-                $isTarget = true;
-                break;
-            }
-        }
+	/**
+	 * Returns true if the specified queue is a target of an enabled email template with a defer action.
+	 *
+	 * @param RequestQueue $queue
+	 * @param PdoDatabase  $database
+	 *
+	 * @return bool
+	 */
+	public function isEmailTemplateTarget(RequestQueue $queue, PdoDatabase $database): bool
+	{
+		$isTarget = false;
+		/** @var EmailTemplate[] $deferralTemplates */
+		$deferralTemplates = EmailTemplate::getAllActiveTemplates(EmailTemplate::ACTION_DEFER, $database, $queue->getDomain());
+		foreach ($deferralTemplates as $t) {
+			if ($t->getQueue() === $queue->getId()) {
+				$isTarget = true;
+				break;
+			}
+		}
 
-        return $isTarget;
-    }
+		return $isTarget;
+	}
 
-    public function isRequestFormTarget(RequestQueue $queue, PdoDatabase $database): bool
-    {
-        $isTarget = false;
-        $forms = RequestForm::getAllForms($database, 1); // FIXME: domains
-        foreach ($forms as $t) {
-            if ($t->isEnabled()) {
-                if ($t->getOverrideQueue() === $queue->getId()) {
-                    $isTarget = true;
-                    break;
-                }
-            }
-        }
+	public function isRequestFormTarget(RequestQueue $queue, PdoDatabase $database): bool
+	{
+		$isTarget = false;
+		$forms = RequestForm::getAllForms($database, 1); // FIXME: domains
+		foreach ($forms as $t) {
+			if ($t->isEnabled()) {
+				if ($t->getOverrideQueue() === $queue->getId()) {
+					$isTarget = true;
+					break;
+				}
+			}
+		}
 
-        return $isTarget;
-    }
+		return $isTarget;
+	}
 }
\ No newline at end of file

includes/Helpers/EmailHelper.php

Indentation +33 added lines, -33 removed lines

@@ -12,37 +12,37 @@
 
 class EmailHelper implements IEmailHelper
 {
-    /** @var string */
-    private $emailFrom;
-    private $instance;
-
-    public function __construct(string $emailFrom, $instance)
-    {
-        $this->emailFrom = $emailFrom;
-        $this->instance = $instance;
-    }
-
-    /**
-     * @param string|null $replyAddress
-     * @param string      $to
-     * @param string      $subject
-     * @param string      $content
-     * @param array       $headers Extra headers to include
-     */
-    public function sendMail(?string $replyAddress, $to, $subject, $content, $headers = array())
-    {
-        if ($replyAddress !== null) {
-            $headers['Reply-To'] = $replyAddress;
-        }
-
-        $headers['From'] = $this->emailFrom;
-        $headers['X-ACC-Instance'] = $this->instance;
-        $headerString = '';
-
-        foreach ($headers as $header => $headerValue) {
-            $headerString .= $header . ': ' . $headerValue . "\r\n";
-        }
-
-        mail($to, $subject, $content, $headerString);
-    }
+	/** @var string */
+	private $emailFrom;
+	private $instance;
+
+	public function __construct(string $emailFrom, $instance)
+	{
+		$this->emailFrom = $emailFrom;
+		$this->instance = $instance;
+	}
+
+	/**
+	 * @param string|null $replyAddress
+	 * @param string      $to
+	 * @param string      $subject
+	 * @param string      $content
+	 * @param array       $headers Extra headers to include
+	 */
+	public function sendMail(?string $replyAddress, $to, $subject, $content, $headers = array())
+	{
+		if ($replyAddress !== null) {
+			$headers['Reply-To'] = $replyAddress;
+		}
+
+		$headers['From'] = $this->emailFrom;
+		$headers['X-ACC-Instance'] = $this->instance;
+		$headerString = '';
+
+		foreach ($headers as $header => $headerValue) {
+			$headerString .= $header . ': ' . $headerValue . "\r\n";
+		}
+
+		mail($to, $subject, $content, $headerString);
+	}
 }
\ No newline at end of file

includes/Helpers/Interfaces/IEmailHelper.php

Indentation +12 added lines, -12 removed lines

@@ -17,16 +17,16 @@
  */
 interface IEmailHelper
 {
-    /**
-     * Sends an email to the specified email address.
-     *
-     * @param string $replyAddress
-     * @param string $to
-     * @param string $subject
-     * @param string $content
-     * @param array  $headers Extra headers to include
-     *
-     * @return void
-     */
-    public function sendMail(?string $replyAddress, $to, $subject, $content, $headers = array());
+	/**
+	 * Sends an email to the specified email address.
+	 *
+	 * @param string $replyAddress
+	 * @param string $to
+	 * @param string $subject
+	 * @param string $content
+	 * @param array  $headers Extra headers to include
+	 *
+	 * @return void
+	 */
+	public function sendMail(?string $replyAddress, $to, $subject, $content, $headers = array());
 }
\ No newline at end of file

includes/Helpers/Interfaces/IBanHelper.php

Indentation +14 added lines, -14 removed lines

@@ -13,21 +13,21 @@
 
 interface IBanHelper
 {
-    /**
-     * @param Request $request
-     *
-     * @return bool
-     */
-    public function isBlockBanned(Request $request): bool;
+	/**
+	 * @param Request $request
+	 *
+	 * @return bool
+	 */
+	public function isBlockBanned(Request $request): bool;
 
-    /**
-     * @param Request $request
-     *
-     * @return Ban[]
-     */
-    public function getBans(Request $request): array;
+	/**
+	 * @param Request $request
+	 *
+	 * @return Ban[]
+	 */
+	public function getBans(Request $request): array;
 
-    public function canUnban(Ban $ban): bool;
+	public function canUnban(Ban $ban): bool;
 
-    public function isActive(Ban $ban): bool;
+	public function isActive(Ban $ban): bool;
 }