enwikipedia-acc / waca

includes/API/Actions/StatsAction.php

Indentation +44 added lines, -44 removed lines

@@ -20,58 +20,58 @@
  */
 class StatsAction extends ApiPageBase implements IApiAction
 {
-    /**
-     * The target user
-     * @var User $user
-     */
-    private $user;
+	/**
+	 * The target user
+	 * @var User $user
+	 */
+	private $user;
 
-    /**
-     * Summary of execute
-     *
-     * @param \DOMElement $apiDocument
-     *
-     * @return \DOMElement
-     * @throws ApiException
-     * @throws \Exception
-     */
-    public function executeApiAction(\DOMElement $apiDocument)
-    {
-        $username = WebRequest::getString('user');
-        $wikiusername = WebRequest::getString('wikiuser');
+	/**
+	 * Summary of execute
+	 *
+	 * @param \DOMElement $apiDocument
+	 *
+	 * @return \DOMElement
+	 * @throws ApiException
+	 * @throws \Exception
+	 */
+	public function executeApiAction(\DOMElement $apiDocument)
+	{
+		$username = WebRequest::getString('user');
+		$wikiusername = WebRequest::getString('wikiuser');
 
-        if ($username === null && $wikiusername === null) {
-            throw new ApiException("Please specify a username using either user or wikiuser parameters.");
-        }
+		if ($username === null && $wikiusername === null) {
+			throw new ApiException("Please specify a username using either user or wikiuser parameters.");
+		}
 
-        $userElement = $this->document->createElement("user");
-        $apiDocument->appendChild($userElement);
+		$userElement = $this->document->createElement("user");
+		$apiDocument->appendChild($userElement);
 
-        if ($username !== null) {
-            $user = User::getByUsername($username, $this->getDatabase());
-        }
-        else {
-            $user = User::getByOnWikiUsername($wikiusername, $this->getDatabase());
-        }
+		if ($username !== null) {
+			$user = User::getByUsername($username, $this->getDatabase());
+		}
+		else {
+			$user = User::getByOnWikiUsername($wikiusername, $this->getDatabase());
+		}
 
-        if ($user === false) {
-            $userElement->setAttribute("missing", "true");
+		if ($user === false) {
+			$userElement->setAttribute("missing", "true");
 
-            return $apiDocument;
-        }
+			return $apiDocument;
+		}
 
-        $this->user = $user;
+		$this->user = $user;
 
-        $oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
-            $this->getSiteConfiguration());
+		$oauth = new OAuthUserHelper($user, $this->getDatabase(), $this->getOAuthProtocolHelper(),
+			$this->getSiteConfiguration());
 
-        $userElement->setAttribute("username", $this->user->getUsername());
-        $userElement->setAttribute("status", $this->user->getStatus());
-        $userElement->setAttribute("lastactive", $this->user->getLastActive());
-        $userElement->setAttribute("welcome_template", $this->user->getWelcomeTemplate());
-        $userElement->setAttribute("onwikiname", $this->user->getOnWikiName());
-        $userElement->setAttribute("oauth", $oauth->isFullyLinked() ? "true" : "false");
+		$userElement->setAttribute("username", $this->user->getUsername());
+		$userElement->setAttribute("status", $this->user->getStatus());
+		$userElement->setAttribute("lastactive", $this->user->getLastActive());
+		$userElement->setAttribute("welcome_template", $this->user->getWelcomeTemplate());
+		$userElement->setAttribute("onwikiname", $this->user->getOnWikiName());
+		$userElement->setAttribute("oauth", $oauth->isFullyLinked() ? "true" : "false");
 
-        return $apiDocument;
-    }
+		return $apiDocument;
+	}
 }

includes/Helpers/BotMediaWikiClient.php

Indentation +132 added lines, -132 removed lines

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

includes/Helpers/OAuthUserHelper.php

Indentation +403 added lines, -403 removed lines

@@ -22,411 +22,411 @@
 
 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;
-
-    #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;
+
+	#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');
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * @throws OAuthException
-     */
-    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();
-
-        $rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
-
-        $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();
-    }
-
-    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);
-    }
-
-    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
-            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');
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * @throws OAuthException
+	 */
+	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();
+
+		$rawTicket = $this->oauthProtocolHelper->getIdentityTicket($token->getToken(), $token->getSecret());
+
+		$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();
+	}
+
+	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);
+	}
+
+	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
+			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;
+	}
 }
\ No newline at end of file

includes/Helpers/Interfaces/IMediaWikiClient.php

Indentation +1 added lines, -1 removed lines

@@ -10,5 +10,5 @@
 
 interface IMediaWikiClient
 {
-    function doApiCall($params, $method);
+	function doApiCall($params, $method);
 }
\ No newline at end of file

includes/Helpers/Interfaces/IOAuthProtocolHelper.php

Indentation +44 added lines, -44 removed lines

@@ -19,52 +19,52 @@
 
 interface IOAuthProtocolHelper
 {
-    /**
-     * @return stdClass
-     *
-     * @throws Exception
-     * @throws CurlException
-     */
-    public function getRequestToken();
+	/**
+	 * @return stdClass
+	 *
+	 * @throws Exception
+	 * @throws CurlException
+	 */
+	public function getRequestToken();
 
-    /**
-     * @param string $requestToken
-     *
-     * @return string
-     */
-    public function getAuthoriseUrl($requestToken);
+	/**
+	 * @param string $requestToken
+	 *
+	 * @return string
+	 */
+	public function getAuthoriseUrl($requestToken);
 
-    /**
-     * @param string $oauthRequestToken
-     * @param string $oauthRequestSecret
-     * @param string $oauthVerifier
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
+	/**
+	 * @param string $oauthRequestToken
+	 * @param string $oauthRequestSecret
+	 * @param string $oauthVerifier
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function callbackCompleted($oauthRequestToken, $oauthRequestSecret, $oauthVerifier);
 
-    /**
-     * @param string $oauthAccessToken
-     * @param string $oauthAccessSecret
-     *
-     * @return stdClass
-     * @throws CurlException
-     * @throws Exception
-     */
-    public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
+	/**
+	 * @param string $oauthAccessToken
+	 * @param string $oauthAccessSecret
+	 *
+	 * @return stdClass
+	 * @throws CurlException
+	 * @throws Exception
+	 */
+	public function getIdentityTicket($oauthAccessToken, $oauthAccessSecret);
 
-    /**
-     * @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');
+	/**
+	 * @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');
 }
\ No newline at end of file

includes/Helpers/HttpHelper.php

Indentation +105 added lines, -105 removed lines

@@ -12,109 +12,109 @@
 
 class HttpHelper
 {
-    private $curlHandle;
-
-    /**
-     * HttpHelper constructor.
-     *
-     * @param string  $userAgent
-     * @param boolean $disableVerifyPeer
-     * @param string  $cookieJar
-     */
-    public function __construct($userAgent, $disableVerifyPeer, $cookieJar = null)
-    {
-        $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);
-        }
-
-        if($cookieJar !== null) {
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
-            curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
-        }
-    }
-
-    public function __destruct()
-    {
-        curl_close($this->curlHandle);
-    }
-
-    /**
-     * Fetches the content of a URL, with an optional parameter set.
-     *
-     * @param string     $url        The URL to fetch.
-     * @param null|array $parameters Key/value pair of GET parameters to add to the request.
-     *                               Null lets you handle it yourself.
-     *
-     * @param array      $headers
-     *
-     * @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
+	 * @param string  $cookieJar
+	 */
+	public function __construct($userAgent, $disableVerifyPeer, $cookieJar = null)
+	{
+		$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);
+		}
+
+		if($cookieJar !== null) {
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEFILE, $cookieJar);
+			curl_setopt($this->curlHandle, CURLOPT_COOKIEJAR, $cookieJar);
+		}
+	}
+
+	public function __destruct()
+	{
+		curl_close($this->curlHandle);
+	}
+
+	/**
+	 * Fetches the content of a URL, with an optional parameter set.
+	 *
+	 * @param string     $url        The URL to fetch.
+	 * @param null|array $parameters Key/value pair of GET parameters to add to the request.
+	 *                               Null lets you handle it yourself.
+	 *
+	 * @param array      $headers
+	 *
+	 * @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

includes/Helpers/SearchHelpers/UserSearchHelper.php

Indentation +88 added lines, -88 removed lines

@@ -15,80 +15,80 @@ 
 
 class UserSearchHelper extends SearchHelperBase
 {
-    /**
-     * UserSearchHelper constructor.
-     *
-     * @param PdoDatabase $database
-     */
-    public function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'user', User::class);
-    }
-
-    /**
-     * Initiates a search for requests
-     *
-     * @param PdoDatabase $database
-     *
-     * @return UserSearchHelper
-     */
-    public static function get(PdoDatabase $database)
-    {
-        $helper = new UserSearchHelper($database);
-
-        return $helper;
-    }
-
-    /**
-     * @param string $status
-     *
-     * @return $this
-     */
-    public function byStatus($status)
-    {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    public function statusIn($statuses)
-    {
-        $this->inClause('status', $statuses);
-
-        return $this;
-    }
-
-    /**
-     * @param string $role
-     *
-     * @return $this
-     */
-    public function byRole($role)
-    {
-        $this->joinClause .= ' INNER JOIN userrole r on origin.id = r.user';
-        $this->whereClause .= ' AND r.role = ?';
-        $this->parameterList[] = $role;
-
-        return $this;
-    }
-
-    /**
-     * @param DateTime $instant
-     *
-     * @return $this
-     */
-    public function lastActiveBefore(DateTime $instant)
-    {
-        $this->whereClause .= ' AND origin.lastactive < ?';
-        $this->parameterList[] = $instant->format("Y-m-d H:i:s");
-
-        return $this;
-    }
-
-    public function getRoleMap(&$roleMap)
-    {
-        $query = <<<SQL
+	/**
+	 * UserSearchHelper constructor.
+	 *
+	 * @param PdoDatabase $database
+	 */
+	public function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'user', User::class);
+	}
+
+	/**
+	 * Initiates a search for requests
+	 *
+	 * @param PdoDatabase $database
+	 *
+	 * @return UserSearchHelper
+	 */
+	public static function get(PdoDatabase $database)
+	{
+		$helper = new UserSearchHelper($database);
+
+		return $helper;
+	}
+
+	/**
+	 * @param string $status
+	 *
+	 * @return $this
+	 */
+	public function byStatus($status)
+	{
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	public function statusIn($statuses)
+	{
+		$this->inClause('status', $statuses);
+
+		return $this;
+	}
+
+	/**
+	 * @param string $role
+	 *
+	 * @return $this
+	 */
+	public function byRole($role)
+	{
+		$this->joinClause .= ' INNER JOIN userrole r on origin.id = r.user';
+		$this->whereClause .= ' AND r.role = ?';
+		$this->parameterList[] = $role;
+
+		return $this;
+	}
+
+	/**
+	 * @param DateTime $instant
+	 *
+	 * @return $this
+	 */
+	public function lastActiveBefore(DateTime $instant)
+	{
+		$this->whereClause .= ' AND origin.lastactive < ?';
+		$this->parameterList[] = $instant->format("Y-m-d H:i:s");
+
+		return $this;
+	}
+
+	public function getRoleMap(&$roleMap)
+	{
+		$query = <<<SQL
             SELECT /* UserSearchHelper/roleMap */ 
                   r.user user
                 , group_concat(r.role SEPARATOR ', ') roles 
@@ -97,22 +97,22 @@ 
             GROUP BY r.user
 SQL;
 
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
 
-        $roleMap = array();
-        foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
-            $roleMap[$row['user']] = $row['roles'];
-        }
+		$roleMap = array();
+		foreach ($statement->fetchAll(PDO::FETCH_ASSOC) as $row) {
+			$roleMap[$row['user']] = $row['roles'];
+		}
 
-        return $this;
-    }
+		return $this;
+	}
 
-    public function withReservedRequest()
-    {
-        $this->joinClause = ' INNER JOIN request req ON req.reserved = origin.id';
-        $this->groupByClause = ' GROUP BY origin.id, origin.username';
+	public function withReservedRequest()
+	{
+		$this->joinClause = ' INNER JOIN request req ON req.reserved = origin.id';
+		$this->groupByClause = ' GROUP BY origin.id, origin.username';
 
-        return $this->fetchMap('username');
-    }
+		return $this->fetchMap('username');
+	}
 }

includes/Helpers/SearchHelpers/JobQueueSearchHelper.php

Indentation +63 added lines, -63 removed lines

@@ -13,67 +13,67 @@
 
 class JobQueueSearchHelper extends SearchHelperBase
 {
-    protected function __construct(PdoDatabase $database)
-    {
-        parent::__construct($database, 'jobqueue', JobQueue::class, null);
-    }
-
-    /**
-     * @param PdoDatabase $database
-     *
-     * @return JobQueueSearchHelper
-     */
-    public static function get(PdoDatabase $database) {
-        $helper = new JobQueueSearchHelper($database);
-        return $helper;
-    }
-
-    /**
-     * @param string[] $statuses
-     *
-     * @return $this
-     */
-    public function statusIn($statuses) {
-        $this->inClause('status', $statuses);
-
-        return $this;
-    }
-
-    /**
-     * @return $this
-     */
-    public function notAcknowledged() {
-        $this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
-
-        return $this;
-    }
-
-    public function byTask($task) {
-        $this->whereClause .= ' AND task = ?';
-        $this->parameterList[] = $task;
-
-        return $this;
-    }
-
-    public function byUser($userId) {
-        $this->whereClause .= ' AND user = ?';
-        $this->parameterList[] = $userId;
-
-        return $this;
-    }
-
-    public function byStatus($status) {
-        $this->whereClause .= ' AND status = ?';
-        $this->parameterList[] = $status;
-
-        return $this;
-    }
-
-    public function byRequest($request)
-    {
-        $this->whereClause .= ' AND request = ?';
-        $this->parameterList[] = $request;
-
-        return $this;
-    }
+	protected function __construct(PdoDatabase $database)
+	{
+		parent::__construct($database, 'jobqueue', JobQueue::class, null);
+	}
+
+	/**
+	 * @param PdoDatabase $database
+	 *
+	 * @return JobQueueSearchHelper
+	 */
+	public static function get(PdoDatabase $database) {
+		$helper = new JobQueueSearchHelper($database);
+		return $helper;
+	}
+
+	/**
+	 * @param string[] $statuses
+	 *
+	 * @return $this
+	 */
+	public function statusIn($statuses) {
+		$this->inClause('status', $statuses);
+
+		return $this;
+	}
+
+	/**
+	 * @return $this
+	 */
+	public function notAcknowledged() {
+		$this->whereClause .= ' AND (acknowledged IS NULL OR acknowledged = 0)';
+
+		return $this;
+	}
+
+	public function byTask($task) {
+		$this->whereClause .= ' AND task = ?';
+		$this->parameterList[] = $task;
+
+		return $this;
+	}
+
+	public function byUser($userId) {
+		$this->whereClause .= ' AND user = ?';
+		$this->parameterList[] = $userId;
+
+		return $this;
+	}
+
+	public function byStatus($status) {
+		$this->whereClause .= ' AND status = ?';
+		$this->parameterList[] = $status;
+
+		return $this;
+	}
+
+	public function byRequest($request)
+	{
+		$this->whereClause .= ' AND request = ?';
+		$this->parameterList[] = $request;
+
+		return $this;
+	}
 }
\ No newline at end of file

includes/Helpers/SearchHelpers/SearchHelperBase.php

Indentation +270 added lines, -270 removed lines

@@ -16,274 +16,274 @@
 
 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 */
-    protected $table;
-    protected $joinClause = '';
-    protected $groupByClause = '';
-    protected $modifiersClause = '';
-    private $targetClass;
-
-    /**
-     * SearchHelperBase constructor.
-     *
-     * @param PdoDatabase $database
-     * @param string      $table
-     * @param             $targetClass
-     * @param null|string $order Order by clause, excluding ORDER BY.
-     */
-    protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
-    {
-        $this->database = $database;
-        $this->table = $table;
-        $this->orderBy = $order;
-        $this->targetClass = $targetClass;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning a set of objects.
-     *
-     * @return DataObject[]
-     */
-    public function fetch()
-    {
-        $statement = $this->getData();
-
-        /** @var DataObject[] $returnedObjects */
-        $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-        foreach ($returnedObjects as $req) {
-            $req->setDatabase($this->database);
-        }
-
-        return $returnedObjects;
-    }
-
-    /**
-     * @param string $whereClauseSection
-     * @param array  $values
-     *
-     * @return array
-     */
-    protected function fetchByParameter($whereClauseSection, $values)
-    {
-        $this->whereClause .= $whereClauseSection;
-
-        $countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $countQuery .= $this->joinClause . $this->whereClause;
-
-        $query = $this->buildQuery(array('*'));
-        $query .= $this->applyOrder();
-
-        // shuffle around hackily TODO: fix this abomination - T593
-        $localParameterList = $this->parameterList;
-        $this->parameterList = array();
-
-        $query .= $this->applyLimit();
-
-        $limitParameters = $this->parameterList;
-
-        $statement = $this->database->prepare($query);
-        $countStatement = $this->database->prepare($countQuery);
-
-        $result = array();
-        foreach ($values as $v) {
-            // reset parameter list
-            $params = $localParameterList;
-            $params[] = $v;
-
-            $countStatement->execute($params);
-
-            // reapply the limit parameters
-            $params = array_merge($params, $limitParameters);
-
-            $statement->execute($params);
-
-            /** @var DataObject[] $returnedObjects */
-            $returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
-            foreach ($returnedObjects as $req) {
-                $req->setDatabase($this->database);
-            }
-
-            $result[$v] = array(
-                'count' => $countStatement->fetchColumn(0),
-                'data'  => $returnedObjects,
-            );
-        }
-
-        return $result;
-    }
-
-    /**
-     * Finalises the database query, and executes it, returning only the requested column.
-     *
-     * @param string $column The required column
-     *
-     * @param bool   $distinct
-     *
-     * @return array
-     * @throws ApplicationLogicException
-     */
-    public function fetchColumn($column, $distinct = false)
-    {
-        if ($distinct) {
-            if ($this->groupByClause !== '') {
-                throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
-            }
-
-            $this->groupByClause = ' GROUP BY origin.' . $column;
-        }
-
-        $statement = $this->getData(array($column));
-
-        return $statement->fetchAll(PDO::FETCH_COLUMN);
-    }
-
-    public function fetchMap($column)
-    {
-        $statement = $this->getData(array('id', $column));
-
-        $data = $statement->fetchAll(PDO::FETCH_ASSOC);
-        $map = array();
-
-        foreach ($data as $row) {
-            $map[$row['id']] = $row[$column];
-        }
-
-        return $map;
-    }
-
-    /**
-     * @param int $count Returns the record count of the result set
-     *
-     * @return $this
-     */
-    public function getRecordCount(&$count)
-    {
-        $query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $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 '';
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return PDOStatement
-     */
-    private function getData($columns = array('*'))
-    {
-        $query = $this->buildQuery($columns);
-        $query .= $this->applyOrder();
-        $query .= $this->applyLimit();
-
-        $statement = $this->database->prepare($query);
-        $statement->execute($this->parameterList);
-
-        return $statement;
-    }
-
-    /**
-     * @param array $columns
-     *
-     * @return string
-     */
-    protected function buildQuery($columns)
-    {
-        $colData = array();
-        foreach ($columns as $c) {
-            $colData[] = 'origin.' . $c;
-        }
-
-        $query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
-        $query .= $this->joinClause . $this->whereClause . $this->groupByClause;
-
-        return $query;
-    }
-
-    public function inIds($idList)
-    {
-        $this->inClause('id', $idList);
-
-        return $this;
-    }
-
-    protected function inClause($column, $values)
-    {
-        if (count($values) === 0) {
-            return;
-        }
-
-        // Urgh. OK. You can't use IN() with parameters directly, so let's munge something together.
-        $valueCount = count($values);
-
-        // Firstly, let's create a string of question marks, which will do as positional parameters.
-        $inSection = str_repeat('?,', $valueCount - 1) . '?';
-
-        $this->whereClause .= " AND {$column} IN ({$inSection})";
-        $this->parameterList = array_merge($this->parameterList, $values);
-    }
+	/** @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 */
+	protected $table;
+	protected $joinClause = '';
+	protected $groupByClause = '';
+	protected $modifiersClause = '';
+	private $targetClass;
+
+	/**
+	 * SearchHelperBase constructor.
+	 *
+	 * @param PdoDatabase $database
+	 * @param string      $table
+	 * @param             $targetClass
+	 * @param null|string $order Order by clause, excluding ORDER BY.
+	 */
+	protected function __construct(PdoDatabase $database, $table, $targetClass, $order = null)
+	{
+		$this->database = $database;
+		$this->table = $table;
+		$this->orderBy = $order;
+		$this->targetClass = $targetClass;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning a set of objects.
+	 *
+	 * @return DataObject[]
+	 */
+	public function fetch()
+	{
+		$statement = $this->getData();
+
+		/** @var DataObject[] $returnedObjects */
+		$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+		foreach ($returnedObjects as $req) {
+			$req->setDatabase($this->database);
+		}
+
+		return $returnedObjects;
+	}
+
+	/**
+	 * @param string $whereClauseSection
+	 * @param array  $values
+	 *
+	 * @return array
+	 */
+	protected function fetchByParameter($whereClauseSection, $values)
+	{
+		$this->whereClause .= $whereClauseSection;
+
+		$countQuery = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$countQuery .= $this->joinClause . $this->whereClause;
+
+		$query = $this->buildQuery(array('*'));
+		$query .= $this->applyOrder();
+
+		// shuffle around hackily TODO: fix this abomination - T593
+		$localParameterList = $this->parameterList;
+		$this->parameterList = array();
+
+		$query .= $this->applyLimit();
+
+		$limitParameters = $this->parameterList;
+
+		$statement = $this->database->prepare($query);
+		$countStatement = $this->database->prepare($countQuery);
+
+		$result = array();
+		foreach ($values as $v) {
+			// reset parameter list
+			$params = $localParameterList;
+			$params[] = $v;
+
+			$countStatement->execute($params);
+
+			// reapply the limit parameters
+			$params = array_merge($params, $limitParameters);
+
+			$statement->execute($params);
+
+			/** @var DataObject[] $returnedObjects */
+			$returnedObjects = $statement->fetchAll(PDO::FETCH_CLASS, $this->targetClass);
+			foreach ($returnedObjects as $req) {
+				$req->setDatabase($this->database);
+			}
+
+			$result[$v] = array(
+				'count' => $countStatement->fetchColumn(0),
+				'data'  => $returnedObjects,
+			);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Finalises the database query, and executes it, returning only the requested column.
+	 *
+	 * @param string $column The required column
+	 *
+	 * @param bool   $distinct
+	 *
+	 * @return array
+	 * @throws ApplicationLogicException
+	 */
+	public function fetchColumn($column, $distinct = false)
+	{
+		if ($distinct) {
+			if ($this->groupByClause !== '') {
+				throw new ApplicationLogicException('Cannot apply distinct to column fetch already using group by');
+			}
+
+			$this->groupByClause = ' GROUP BY origin.' . $column;
+		}
+
+		$statement = $this->getData(array($column));
+
+		return $statement->fetchAll(PDO::FETCH_COLUMN);
+	}
+
+	public function fetchMap($column)
+	{
+		$statement = $this->getData(array('id', $column));
+
+		$data = $statement->fetchAll(PDO::FETCH_ASSOC);
+		$map = array();
+
+		foreach ($data as $row) {
+			$map[$row['id']] = $row[$column];
+		}
+
+		return $map;
+	}
+
+	/**
+	 * @param int $count Returns the record count of the result set
+	 *
+	 * @return $this
+	 */
+	public function getRecordCount(&$count)
+	{
+		$query = 'SELECT /* SearchHelper */ COUNT(*) FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $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 '';
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return PDOStatement
+	 */
+	private function getData($columns = array('*'))
+	{
+		$query = $this->buildQuery($columns);
+		$query .= $this->applyOrder();
+		$query .= $this->applyLimit();
+
+		$statement = $this->database->prepare($query);
+		$statement->execute($this->parameterList);
+
+		return $statement;
+	}
+
+	/**
+	 * @param array $columns
+	 *
+	 * @return string
+	 */
+	protected function buildQuery($columns)
+	{
+		$colData = array();
+		foreach ($columns as $c) {
+			$colData[] = 'origin.' . $c;
+		}
+
+		$query = "SELECT {$this->modifiersClause} /* SearchHelper */ " . implode(', ', $colData) . ' FROM ' . $this->table . ' origin ';
+		$query .= $this->joinClause . $this->whereClause . $this->groupByClause;
+
+		return $query;
+	}
+
+	public function inIds($idList)
+	{
+		$this->inClause('id', $idList);
+
+		return $this;
+	}
+
+	protected function inClause($column, $values)
+	{
+		if (count($values) === 0) {
+			return;
+		}
+
+		// Urgh. OK. You can't use IN() with parameters directly, so let's munge something together.
+		$valueCount = count($values);
+
+		// Firstly, let's create a string of question marks, which will do as positional parameters.
+		$inSection = str_repeat('?,', $valueCount - 1) . '?';
+
+		$this->whereClause .= " AND {$column} IN ({$inSection})";
+		$this->parameterList = array_merge($this->parameterList, $values);
+	}
 }