OAuthUtility

Complexity

Total Complexity

15

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	apiCall()	0	46	4
A	getRequestToken()	0	33	4
A	getAuthoriseUrl()	0	3	1
A	getIdentity()	0	40	3
A	callbackCompleted()	0	34	2
A	__construct()	0	6	1

<?php

function wfDebugLog($section, $message)

The parameter $message is not used and could be removed.

The parameter $section is not used and could be removed.

{
	// no op, needed by the mediawiki oauth library.
}

class OAuthUtility
{
	private $consumerToken;
	private $consumerSecret;
	private $baseUrl;
	private $baseUrlInternal;

	public function __construct($consumerToken, $consumerSecret, $baseUrl, $baseUrlInternal)
	{
		$this->consumerSecret = $consumerSecret;
		$this->consumerToken = $consumerToken;
		$this->baseUrl = $baseUrl;
		$this->baseUrlInternal = $baseUrlInternal;
	}

	public function getRequestToken()
	{
		global $toolUserAgent;

		$endpoint = $this->baseUrlInternal . '/initiate&format=json&oauth_callback=oob';

		$c = new OAuthConsumer($this->consumerToken, $this->consumerSecret);

The type OAuthConsumer was not found. Maybe you did not declare it correctly or list all dependencies?

		$parsed = parse_url($endpoint);
		$params = array();
		parse_str($parsed['query'], $params);
		$req_req = OAuthRequest::from_consumer_and_token($c, null, "GET", $endpoint, $params);

The type OAuthRequest was not found. Maybe you did not declare it correctly or list all dependencies?

		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();

The type OAuthSignatureMethod_HMAC_SHA1 was not found. Maybe you did not declare it correctly or list all dependencies?

		$req_req->sign_request($hmac_method, $c, null);

		$ch = curl_init();
		curl_setopt($ch, CURLOPT_URL, (string)$req_req);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
		curl_setopt($ch, CURLOPT_HEADER, 0);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($ch, CURLOPT_USERAGENT, $toolUserAgent);
		$data = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

		if (!$data) {
			throw new Exception('Curl error: ' . curl_error($ch));

It seems like $ch can also be of type false; however, parameter $ch of curl_error() does only seem to accept resource, maybe add an additional type check?

		}

		$token = json_decode($data);

It seems like $data can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

		if (!isset($token) || isset($token->error)) {
			throw new Exception("Error encountered while getting token.");
		}

		return $token;
	}

	public function getAuthoriseUrl($requestToken)
	{
		return "{$this->baseUrl}/authorize&oauth_token={$requestToken->key}&oauth_consumer_key={$this->consumerToken}";
	}

	public function callbackCompleted($requestToken, $requestSecret, $verifyToken)
	{
		global $toolUserAgent;

		$endpoint = $this->baseUrlInternal . '/token&format=json';

		$c = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
		$rc = new OAuthConsumer($requestToken, $requestSecret);
		$parsed = parse_url($endpoint);
		parse_str($parsed['query'], $params);
		$params['oauth_verifier'] = trim($verifyToken);

		$acc_req = OAuthRequest::from_consumer_and_token($c, $rc, "GET", $endpoint, $params);

		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
		$acc_req->sign_request($hmac_method, $c, $rc);

		unset($ch);

The variable $ch seems to be never defined.

		$ch = curl_init();
		curl_setopt($ch, CURLOPT_URL, (string)$acc_req);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
		curl_setopt($ch, CURLOPT_HEADER, 0);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($ch, CURLOPT_USERAGENT, $toolUserAgent);

		$data = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

		if (!$data) {
			throw new Exception('Curl error: ' . curl_error($ch));

It seems like $ch can also be of type false; however, parameter $ch of curl_error() does only seem to accept resource, maybe add an additional type check?

		}

		$token = json_decode($data);

It seems like $data can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

		return $token;
	}

	public function apiCall($apiParams, $accessToken, $accessSecret, $method = "GET")
	{
		global $mediawikiWebServiceEndpoint, $toolUserAgent;

		$userToken = new OAuthToken($accessToken, $accessSecret);

The type OAuthToken was not found. Maybe you did not declare it correctly or list all dependencies?

		$apiParams['format'] = 'json';

		$c = new OAuthConsumer($this->consumerToken, $this->consumerSecret);

		$api_req = OAuthRequest::from_consumer_and_token(
			$c, // Consumer
			$userToken, // User Access Token
			$method, // HTTP Method
			$mediawikiWebServiceEndpoint, // Endpoint url
			$apiParams    // Extra signed parameters
		);

		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();

		$api_req->sign_request($hmac_method, $c, $userToken);

		$ch = curl_init();
		if ($method == "GET") {
			curl_setopt($ch, CURLOPT_URL, $mediawikiWebServiceEndpoint . "?" . http_build_query($apiParams));

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

		}
        
		if ($method == "POST") {
			curl_setopt($ch, CURLOPT_URL, $mediawikiWebServiceEndpoint);
			curl_setopt($ch, CURLOPT_POST, count($apiParams));
			curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($apiParams));   
		}
        
		curl_setopt($ch, CURLOPT_HEADER, 0);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
		curl_setopt($ch, CURLOPT_HTTPHEADER, array($api_req->to_header())); // Authorization header required for api
		curl_setopt($ch, CURLOPT_USERAGENT, $toolUserAgent);

		$data = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

		if (!$data) {
			throw new Exception('Curl error: ' . curl_error($ch));

It seems like $ch can also be of type false; however, parameter $ch of curl_error() does only seem to accept resource, maybe add an additional type check?

		}

		return json_decode($data);

It seems like $data can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

	}

	public function getIdentity($accessToken, $accessSecret)
	{

		global $toolUserAgent;

		$endpoint = $this->baseUrlInternal . '/identify&format=json';

		$c = new OAuthConsumer($this->consumerToken, $this->consumerSecret);
		$rc = new OAuthToken($accessToken, $accessSecret);
		$parsed = parse_url($endpoint);
		parse_str($parsed['query'], $params);

		$acc_req = OAuthRequest::from_consumer_and_token($c, $rc, "GET", $endpoint, $params);

		$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
		$acc_req->sign_request($hmac_method, $c, $rc);

		unset($ch);

The variable $ch seems to be never defined.

		$ch = curl_init();
		curl_setopt($ch, CURLOPT_URL, (string)$acc_req);

It seems like $ch can also be of type false; however, parameter $ch of curl_setopt() does only seem to accept resource, maybe add an additional type check?

		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
		curl_setopt($ch, CURLOPT_HEADER, 0);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($ch, CURLOPT_USERAGENT, $toolUserAgent);

		$data = curl_exec($ch);

It seems like $ch can also be of type false; however, parameter $ch of curl_exec() does only seem to accept resource, maybe add an additional type check?

		if (!$data) {
			throw new Exception('Curl error: ' . curl_error($ch));

It seems like $ch can also be of type false; however, parameter $ch of curl_error() does only seem to accept resource, maybe add an additional type check?

		}

		$decodedData = json_decode($data);

It seems like $data can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

		if (isset($decodedData->error)) {
			throw new TransactionException($decodedData->error);
		}

		$identity = JWT::decode($data, $this->consumerSecret);

The type JWT was not found. Maybe you did not declare it correctly or list all dependencies?

		return $identity;
	}
}