chillerlan / php-oauth-core

src/Core/OAuthProvider.php

Spacing +31 added lines, -31 removed lines

@@ -41,7 +41,7 @@ 
  * @property string                                          $serviceName
  * @property string|null                                     $userRevokeURL
  */
-abstract class OAuthProvider implements OAuthInterface{
+abstract class OAuthProvider implements OAuthInterface {
 	use LoggerAwareTrait;
 
 	protected const ALLOWED_PROPERTIES = [
@@ -150,7 +150,7 @@ 
 		OAuthStorageInterface $storage,
 		SettingsContainerInterface $options,
 		LoggerInterface $logger = null
-	){
+	) {
 		$this->http    = $http;
 		$this->storage = $storage;
 		$this->options = $options;
@@ -164,10 +164,10 @@ 
 
 		$this->serviceName = (new ReflectionClass($this))->getShortName();
 
-		if(!empty($this->endpointMap) && class_exists($this->endpointMap)){
+		if (!empty($this->endpointMap) && class_exists($this->endpointMap)) {
 			$this->endpoints = new $this->endpointMap;
 
-			if(!$this->endpoints instanceof EndpointMapInterface){
+			if (!$this->endpoints instanceof EndpointMapInterface) {
 				throw new ApiClientException('invalid endpoint map'); // @codeCoverageIgnore
 			}
 
@@ -180,9 +180,9 @@ 
 	 *
 	 * @return mixed|null
 	 */
-	public function __get(string $name){
+	public function __get(string $name) {
 
-		if(in_array($name, $this::ALLOWED_PROPERTIES, true)){
+		if (in_array($name, $this::ALLOWED_PROPERTIES, true)) {
 			return $this->{$name};
 		}
 
@@ -251,11 +251,11 @@ 
 	 */
 	public function __call(string $endpointName, array $arguments):ResponseInterface{
 
-		if(!$this->endpoints instanceof EndpointMap){
+		if (!$this->endpoints instanceof EndpointMap) {
 			throw new ApiClientException('MagicAPI not available'); // @codeCoverageIgnore
 		}
 
-		if(!isset($this->endpoints->{$endpointName})){
+		if (!isset($this->endpoints->{$endpointName})) {
 			throw new ApiClientException('endpoint not found: "'.$endpointName.'"');
 		}
 
@@ -275,25 +275,25 @@ 
 		$path_element_count = count($path_elements);
 		$query_param_count  = count($query_params);
 
-		if($path_element_count > 0){
+		if ($path_element_count > 0) {
 			$path = $this->parsePathElements($path, $path_elements, $path_element_count, $arguments);
 		}
 
-		if($query_param_count > 0){
+		if ($query_param_count > 0) {
 			// $params is the first argument after path segments
 			$params = $arguments[$path_element_count] ?? null;
 
-			if(is_array($params)){
+			if (is_array($params)) {
 				$params = $this->cleanQueryParams($this->removeUnlistedParams($params, $query_params));
 			}
 		}
 
-		if(in_array($method, ['POST', 'PATCH', 'PUT', 'DELETE']) && $has_body){
+		if (in_array($method, ['POST', 'PATCH', 'PUT', 'DELETE']) && $has_body) {
 			// if no query params are present, $body is the first argument after any path segments
 			$argPos = $query_param_count > 0 ? 1 : 0;
 			$body   = $arguments[$path_element_count + $argPos] ?? null;
 
-			if(is_array($body)){
+			if (is_array($body)) {
 				$body = $this->cleanBodyParams($body);
 			}
 		}
@@ -314,13 +314,13 @@ 
 		// we don't know if all of the given arguments are path elements...
 		$urlparams = array_slice($arguments, 0, $path_element_count);
 
-		if(count($urlparams) !== $path_element_count){
+		if (count($urlparams) !== $path_element_count) {
 			throw new APIClientException('too few URL params, required: '.implode(', ', $path_elements));
 		}
 
-		foreach($urlparams as $i => $param){
+		foreach ($urlparams as $i => $param) {
 			// ...but we do know that the arguments after the path elements are usually array or null
-			if(!is_scalar($param)){
+			if (!is_scalar($param)) {
 				$msg = 'invalid path element value for "%s": %s';
 
 				throw new APIClientException(sprintf($msg, $path_elements[$i], var_export($param, true)));
@@ -336,9 +336,9 @@ 
 	protected function removeUnlistedParams(array $params, array $allowed):array{
 		$query = [];
 		// remove any params that are not listed
-		foreach($params as $key => $value){
+		foreach ($params as $key => $value) {
 
-			if(!in_array($key, $allowed, true)){
+			if (!in_array($key, $allowed, true)) {
 				continue;
 			}
 
@@ -397,28 +397,28 @@ 
 		$request = $this->requestFactory
 			->createRequest($method ?? 'GET', $this->mergeQuery($this->getRequestTarget($path), $params ?? []));
 
-		foreach(array_merge($this->apiHeaders, $headers ?? []) as $header => $value){
+		foreach (array_merge($this->apiHeaders, $headers ?? []) as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
-		if($request->hasHeader('content-type')){
+		if ($request->hasHeader('content-type')) {
 			$contentType = strtolower($request->getHeaderLine('content-type'));
 
-			if(is_array($body)){
-				if($contentType === 'application/x-www-form-urlencoded'){
+			if (is_array($body)) {
+				if ($contentType === 'application/x-www-form-urlencoded') {
 					$body = $this->streamFactory->createStream($this->buildQuery($body, PHP_QUERY_RFC1738));
 				}
-				elseif($contentType === 'application/json' || $contentType === 'application/vnd.api+json'){
+				elseif ($contentType === 'application/json' || $contentType === 'application/vnd.api+json') {
 					$body = $this->streamFactory->createStream(json_encode($body));
 				}
 			}
-			elseif(is_string($body)){
+			elseif (is_string($body)) {
 				// we don't check if the given string matches the content type - this is the implementor's responsibility
 				$body = $this->streamFactory->createStream($body);
 			}
 		}
 
-		if($body instanceof StreamInterface){
+		if ($body instanceof StreamInterface) {
 			$request = $request
 				->withBody($body)
 				->withHeader('Content-length', (string)$body->getSize())
@@ -440,16 +440,16 @@ 
 	protected function getRequestTarget(string $uri):string{
 		$parsedURL = QueryUtil::parseUrl($uri);
 
-		if(!isset($parsedURL['path'])){
+		if (!isset($parsedURL['path'])) {
 			throw new ProviderException('invalid path');
 		}
 
 		// for some reason we were given a host name
-		if(isset($parsedURL['host'])){
+		if (isset($parsedURL['host'])) {
 
 			// back out if it doesn't match
 			/** @phan-suppress-next-line PhanTypeArraySuspiciousNullable - $this->>apiURL should always return a host */
-			if($parsedURL['host'] !== QueryUtil::parseUrl($this->apiURL)['host']){
+			if ($parsedURL['host'] !== QueryUtil::parseUrl($this->apiURL)['host']) {
 				throw new ProviderException('given host does not match provider host');
 			}
 
@@ -467,15 +467,15 @@ 
 	public function sendRequest(RequestInterface $request):ResponseInterface{
 
 		// get authorization only if we request the provider API
-		if(strpos((string)$request->getUri(), $this->apiURL) === 0){
+		if (strpos((string)$request->getUri(), $this->apiURL) === 0) {
 			$token = $this->storage->getAccessToken($this->serviceName);
 
 			// attempt to refresh an expired token
-			if(
+			if (
 				$this instanceof TokenRefresh
 				&& $this->options->tokenAutoRefresh
 				&& ($token->isExpired() || $token->expires === $token::EOL_UNKNOWN)
-			){
+			) {
 				$token = $this->refreshAccessToken($token);
 			}
 

src/Core/OAuth1Provider.php

Spacing +10 added lines, -10 removed lines

@@ -21,7 +21,7 @@ 
 /**
  * Implements an abstract OAuth1 provider with all methods required by the OAuth1Interface.
  */
-abstract class OAuth1Provider extends OAuthProvider implements OAuth1Interface{
+abstract class OAuth1Provider extends OAuthProvider implements OAuth1Interface {
 
 	/**
 	 * The request OAuth1 token URL
@@ -60,7 +60,7 @@ 
 			->withHeader('Content-Length', '0') // tumblr requires a content-length header set
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
@@ -77,20 +77,20 @@ 
 	protected function parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed = null):AccessToken{
 		$data = $this->parseQuery(MessageUtil::decompress($response));
 
-		if(empty($data)){
+		if (empty($data)) {
 			throw new ProviderException('unable to parse token response');
 		}
-		elseif(isset($data['error'])){
+		elseif (isset($data['error'])) {
 			throw new ProviderException('error retrieving access token: '.$data['error']);
 		}
-		elseif(!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])){
+		elseif (!isset($data['oauth_token']) || !isset($data['oauth_token_secret'])) {
 			throw new ProviderException('invalid token');
 		}
 
-		if(
+		if (
 			$checkCallbackConfirmed
 			&& (!isset($data['oauth_callback_confirmed']) || $data['oauth_callback_confirmed'] !== 'true')
-		){
+		) {
 			throw new ProviderException('oauth callback unconfirmed');
 		}
 
@@ -132,7 +132,7 @@ 
 	protected function getSignature(string $url, array $params, string $method, string $accessTokenSecret = null):string{
 		$parsed = QueryUtil::parseUrl($url);
 
-		if(!isset($parsed['host']) || !isset($parsed['scheme']) || !in_array($parsed['scheme'], ['http', 'https'], true)){
+		if (!isset($parsed['host']) || !isset($parsed['scheme']) || !in_array($parsed['scheme'], ['http', 'https'], true)) {
 			throw new ProviderException('getSignature: invalid url');
 		}
 
@@ -149,7 +149,7 @@ 
 		]);
 
 		// https://tools.ietf.org/html/rfc5849#section-3.4.2
-		$key  = array_map('rawurlencode', [
+		$key = array_map('rawurlencode', [
 			$this->options->secret,
 			$accessTokenSecret ?? ''
 		]);
@@ -196,7 +196,7 @@ 
 			$token->accessTokenSecret
 		);
 
-		if(isset($query['oauth_session_handle'])){
+		if (isset($query['oauth_session_handle'])) {
 			$parameters['oauth_session_handle'] = $query['oauth_session_handle']; // @codeCoverageIgnore
 		}
 

src/Core/OAuth2Provider.php

Spacing +24 added lines, -24 removed lines

@@ -26,7 +26,7 @@ 
  * Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
  * It also implements the ClientCredentials, CSRFToken and TokenRefresh interfaces in favor over traits.
  */
-abstract class OAuth2Provider extends OAuthProvider implements OAuth2Interface{
+abstract class OAuth2Provider extends OAuthProvider implements OAuth2Interface {
 
 	/**
 	 * Specifies the authentication method:
@@ -83,11 +83,11 @@ 
 			'type'          => 'web_server',
 		]);
 
-		if(!empty($scopes)){
+		if (!empty($scopes)) {
 			$params['scope'] = implode($this->scopesDelimiter, $scopes);
 		}
 
-		if($this instanceof CSRFToken){
+		if ($this instanceof CSRFToken) {
 			$params = $this->setState($params);
 		}
 
@@ -106,19 +106,19 @@ 
 		// silly amazon sends compressed data...
 		$data = json_decode(MessageUtil::decompress($response), true, 512, JSON_THROW_ON_ERROR);
 
-		if(!is_array($data)){
+		if (!is_array($data)) {
 			throw new ProviderException('unable to parse token response');
 		}
 
-		foreach(['error_description', 'error'] as $field){
+		foreach (['error_description', 'error'] as $field) {
 
-			if(isset($data[$field])){
+			if (isset($data[$field])) {
 				throw new ProviderException('error retrieving access token: "'.$data[$field].'"');
 			}
 
 		}
 
-		if(!isset($data['access_token'])){
+		if (!isset($data['access_token'])) {
 			throw new ProviderException('token missing');
 		}
 
@@ -140,7 +140,7 @@ 
 	 */
 	public function getAccessToken(string $code, string $state = null):AccessToken{
 
-		if($this instanceof CSRFToken){
+		if ($this instanceof CSRFToken) {
 			$this->checkState($state);
 		}
 
@@ -158,7 +158,7 @@ 
 			->withHeader('Accept-Encoding', 'identity')
 			->withBody($this->streamFactory->createStream($this->buildQuery($body, PHP_QUERY_RFC1738)));
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withHeader($header, $value);
 		}
 
@@ -174,11 +174,11 @@ 
 	 */
 	public function getRequestAuthorization(RequestInterface $request, AccessToken $token):RequestInterface{
 
-		if($this->authMethod === OAuth2Interface::AUTH_METHOD_HEADER){
+		if ($this->authMethod === OAuth2Interface::AUTH_METHOD_HEADER) {
 			return $request->withHeader('Authorization', $this->authMethodHeader.' '.$token->accessToken);
 		}
 
-		if($this->authMethod === OAuth2Interface::AUTH_METHOD_QUERY){
+		if ($this->authMethod === OAuth2Interface::AUTH_METHOD_QUERY) {
 			$uri = $this->mergeQuery((string)$request->getUri(), [$this->authMethodQuery => $token->accessToken]);
 
 			return $request->withUri($this->uriFactory->createUri($uri));
@@ -196,13 +196,13 @@ 
 	 */
 	public function getClientCredentialsToken(array $scopes = null):AccessToken{
 
-		if(!$this instanceof ClientCredentials){
+		if (!$this instanceof ClientCredentials) {
 			throw new ProviderException('client credentials token not supported');
 		}
 
 		$params = ['grant_type' => 'client_credentials'];
 
-		if($scopes !== null){
+		if ($scopes !== null) {
 			$params['scope'] = implode($this->scopesDelimiter, $scopes);
 		}
 
@@ -214,7 +214,7 @@ 
 			->withBody($this->streamFactory->createStream($this->buildQuery($params, PHP_QUERY_RFC1738)))
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
@@ -234,17 +234,17 @@ 
 	 */
 	public function refreshAccessToken(AccessToken $token = null):AccessToken{
 
-		if(!$this instanceof TokenRefresh){
+		if (!$this instanceof TokenRefresh) {
 			throw new ProviderException('token refresh not supported');
 		}
 
-		if($token === null){
+		if ($token === null) {
 			$token = $this->storage->getAccessToken($this->serviceName);
 		}
 
 		$refreshToken = $token->refreshToken;
 
-		if(empty($refreshToken)){
+		if (empty($refreshToken)) {
 			throw new ProviderException(
 				sprintf('no refresh token available, token expired [%s]', date('Y-m-d h:i:s A', $token->expires))
 			);
@@ -265,13 +265,13 @@ 
 			->withBody($this->streamFactory->createStream($this->buildQuery($body, PHP_QUERY_RFC1738)))
 		;
 
-		foreach($this->authHeaders as $header => $value){
+		foreach ($this->authHeaders as $header => $value) {
 			$request = $request->withAddedHeader($header, $value);
 		}
 
 		$newToken = $this->parseTokenResponse($this->http->sendRequest($request));
 
-		if(empty($newToken->refreshToken)){
+		if (empty($newToken->refreshToken)) {
 			$newToken->refreshToken = $refreshToken;
 		}
 
@@ -291,17 +291,17 @@ 
 	 */
 	public function checkState(string $state = null):void{
 
-		if(!$this instanceof CSRFToken){
+		if (!$this instanceof CSRFToken) {
 			throw new ProviderException('CSRF protection not supported');
 		}
 
-		if(empty($state) || !$this->storage->hasCSRFState($this->serviceName)){
+		if (empty($state) || !$this->storage->hasCSRFState($this->serviceName)) {
 			throw new ProviderException('invalid state for '.$this->serviceName);
 		}
 
 		$knownState = $this->storage->getCSRFState($this->serviceName);
 
-		if(!hash_equals($knownState, $state)){
+		if (!hash_equals($knownState, $state)) {
 			throw new ProviderException('invalid CSRF state: '.$this->serviceName.' '.$state);
 		}
 
@@ -318,11 +318,11 @@ 
 	 */
 	public function setState(array $params):array{
 
-		if(!$this instanceof CSRFToken){
+		if (!$this instanceof CSRFToken) {
 			throw new ProviderException('CSRF protection not supported');
 		}
 
-		if(!isset($params['state'])){
+		if (!isset($params['state'])) {
 			$params['state'] = sha1(random_bytes(256));
 		}