GuildWars2.php

<?php
/**
 * Class GuildWars2
 *
 * @created      22.10.2017
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 *
 * @noinspection PhpUnused
 */
declare(strict_types=1);

namespace chillerlan\OAuth\Providers;

use chillerlan\HTTP\Utils\{MessageUtil, QueryUtil};
use chillerlan\OAuth\Core\{AccessToken, AuthenticatedUser, OAuth2Provider, UserInfo};
use Psr\Http\Message\UriInterface;
use function implode, preg_match, str_starts_with, substr;

/**
 * Guild Wars 2
 *
 * Note: GW2 does not support authentication (anymore) but the API still works like a regular OAUth API, so...
 *
 * @link https://api.guildwars2.com/v2
 * @link https://wiki.guildwars2.com/wiki/API:Main
 */
class GuildWars2 extends OAuth2Provider implements UserInfo{

	public const IDENTIFIER = 'GUILDWARS2';

	public const SCOPE_ACCOUNT     = 'account';
	public const SCOPE_INVENTORIES = 'inventories';
	public const SCOPE_CHARACTERS  = 'characters';
	public const SCOPE_TRADINGPOST = 'tradingpost';
	public const SCOPE_WALLET      = 'wallet';
	public const SCOPE_UNLOCKS     = 'unlocks';
	public const SCOPE_PVP         = 'pvp';
	public const SCOPE_BUILDS      = 'builds';
	public const SCOPE_PROGRESSION = 'progression';
	public const SCOPE_GUILDS      = 'guilds';

	protected string      $authorizationURL = 'https://api.guildwars2.com/v2/tokeninfo';
	protected string      $apiURL           = 'https://api.guildwars2.com';
	protected string|null $userRevokeURL    = 'https://account.arena.net/applications';
	protected string|null $apiDocs          = 'https://wiki.guildwars2.com/wiki/API:Main';
	protected string|null $applicationURL   = 'https://account.arena.net/applications';

	/**
	 * @throws \chillerlan\OAuth\Providers\ProviderException
	 */
	public function storeGW2Token(string $access_token):AccessToken{

		if(!preg_match('/^[a-f\d\-]{72}$/i', $access_token)){
			throw new ProviderException('invalid token');
		}

		// to verify the token we need to send a request without authentication
		$request = $this->requestFactory
			->createRequest('GET', QueryUtil::merge($this->authorizationURL, ['access_token' => $access_token]))
		;

		$tokeninfo = MessageUtil::decodeJSON($this->http->sendRequest($request));

		if(isset($tokeninfo->id) && str_starts_with($access_token, $tokeninfo->id)){
			$token                    = $this->createAccessToken();
			$token->accessToken       = $access_token;
			$token->accessTokenSecret = substr($access_token, 36, 36); // the actual token
			$token->expires           = AccessToken::NEVER_EXPIRES;
			$token->extraParams       = [
				'token_type' => 'Bearer',
				'id'         => $tokeninfo->id,
				'name'       => $tokeninfo->name,
				'scope'      => implode($this::SCOPES_DELIMITER, $tokeninfo->permissions),
			];

			$this->storage->storeAccessToken($token, $this->name);

			return $token;
		}

		throw new ProviderException('unverified token'); // @codeCoverageIgnore
	}

	/**
	 * @throws \chillerlan\OAuth\Providers\ProviderException
	 */
	public function getAuthorizationURL(array|null $params = null, array|null $scopes = null):UriInterface{
		throw new ProviderException('GuildWars2 does not support authentication anymore.');
	}

	/**
	 * @throws \chillerlan\OAuth\Providers\ProviderException
	 */
	public function getAccessToken(string $code, string|null $state = null):AccessToken{
		throw new ProviderException('GuildWars2 does not support authentication anymore.');
	}

	/** @codeCoverageIgnore */
	public function me():AuthenticatedUser{
		$json = $this->getMeResponseData('/v2/tokeninfo');

		$userdata = [
			'data'   => $json,
			'handle' => $json['name'],
			'id'     => $json['id'],
		];

		return new AuthenticatedUser($userdata);
	}

}