MediawikiApi::postRequestAsync() - Code Metrics - Inspection of "Add new MultipartRequest class to handle extra par..." - addwiki/mediawiki-api-base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6fb038...2eb635 )

by adam

created 2017-10-10 08:49 UTC

MediawikiApi::postRequestAsync() A

↳ Parent: MediawikiApi

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
ccs	8
cts	8
cp	1
rs	9.4285
cc	1
eloc	7
nc	1
nop	1
crap	1

<?php

namespace Mediawiki\Api;

use DOMDocument;
use DOMXPath;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Promise\PromiseInterface;
use InvalidArgumentException;
use Mediawiki\Api\Guzzle\ClientFactory;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use Psr\Log\NullLogger;
use SimpleXMLElement;

/**
 * Main class for this library
 *
 * @since 0.1
 *
 * @author Addshore
 */
class MediawikiApi implements MediawikiApiInterface, LoggerAwareInterface {

	/**
	 * @var ClientInterface|null Should be accessed through getClient
	 */
	private $client = null;

	/**
	 * @var bool|string
	 */
	private $isLoggedIn;

	/**
	 * @var MediawikiSession
	 */
	private $session;

	/**
	 * @var string
	 */
	private $version;

	/**
	 * @var LoggerInterface
	 */
	private $logger;

	/**
	 * @var string
	 */
	private $apiUrl;

	/**
	 * @since 2.0
	 *
	 * @param string $apiEndpoint e.g. https://en.wikipedia.org/w/api.php
	 *
	 * @return self returns a MediawikiApi instance using $apiEndpoint
	 */
	public static function newFromApiEndpoint( $apiEndpoint ) {
		return new self( $apiEndpoint );
	}

	/**
	 * Create a new MediawikiApi object from a URL to any page in a MediaWiki website.
	 *
	 * @since 2.0
	 * @see https://en.wikipedia.org/wiki/Really_Simple_Discovery
	 *
	 * @param string $url e.g. https://en.wikipedia.org OR https://de.wikipedia.org/wiki/Berlin
	 * @return self returns a MediawikiApi instance using the apiEndpoint provided by the RSD
	 *              file accessible on all Mediawiki pages
	 * @throws RsdException If the RSD URL could not be found in the page's HTML.
	 */
	public static function newFromPage( $url ) {
		// Set up HTTP client and HTML document.
		$tempClient = new Client( [ 'headers' => [ 'User-Agent' => 'addwiki-mediawiki-client' ] ] );
		$pageHtml = $tempClient->get( $url )->getBody();
		$pageDoc = new DOMDocument();

		// Try to load the HTML (turn off errors temporarily; most don't matter, and if they do get
		// in the way of finding the API URL, will be reported in the RsdException below).
		$internalErrors = libxml_use_internal_errors( true );
		$pageDoc->loadHTML( $pageHtml );
		$libXmlErrors = libxml_get_errors();
		libxml_use_internal_errors( $internalErrors );

		// Extract the RSD link.
		$xpath = 'head/link[@type="application/rsd+xml"][@href]';
		$link = ( new DOMXpath( $pageDoc ) )->query( $xpath );
		if ( $link->length === 0 ) {
			// Format libxml errors for display.
			$libXmlErrorStr = array_reduce( $libXmlErrors, function ( $prevErr, $err ) {
				return $prevErr . ', ' . $err->message . ' (line '.$err->line . ')';
			} );
			if ( $libXmlErrorStr ) {
				$libXmlErrorStr = "In addition, libxml had the following errors: $libXmlErrorStr";
			}
			throw new RsdException( "Unable to find RSD URL in page: $url $libXmlErrorStr" );
		}
		$rsdUrl = $link->item( 0 )->attributes->getnamedItem( 'href' )->nodeValue;

		// Then get the RSD XML, and return the API link.
		$rsdXml = new SimpleXMLElement( $tempClient->get( $rsdUrl )->getBody() );
		return self::newFromApiEndpoint( (string)$rsdXml->service->apis->api->attributes()->apiLink );
	}

	/**
	 * @param string $apiUrl The API Url
	 * @param ClientInterface|null $client Guzzle Client
	 * @param MediawikiSession|null $session Inject a custom session here
	 */
	public function __construct( $apiUrl, ClientInterface $client = null,
								 MediawikiSession $session = null ) {
		if ( !is_string( $apiUrl ) ) {
			throw new InvalidArgumentException( '$apiUrl must be a string' );
		}
		if ( $session === null ) {
			$session = new MediawikiSession( $this );
		}

		$this->apiUrl = $apiUrl;
		$this->client = $client;
		$this->session = $session;

		$this->logger = new NullLogger();
	}

	/**
	 * Get the API URL (the URL to which API requests are sent, usually ending in api.php).
	 * This is useful if you've created this object via MediawikiApi::newFromPage().
	 *
	 * @since 2.3
	 *
	 * @return string The API URL.
	 */
	public function getApiUrl() {
		return $this->apiUrl;
	}

	/**
	 * @return ClientInterface
	 */
	private function getClient() {
		if ( $this->client === null ) {
			$clientFactory = new ClientFactory();
			$clientFactory->setLogger( $this->logger );
			$this->client = $clientFactory->getClient();
		}
		return $this->client;
	}

	/**
	 * Sets a logger instance on the object
	 *
	 * @since 1.1
	 *
	 * @param LoggerInterface $logger The new Logger object.
	 *
	 * @return null
	 */
	public function setLogger( LoggerInterface $logger ) {
		$this->logger = $logger;
		$this->session->setLogger( $logger );
	}

	/**
	 * @since 2.0
	 *
	 * @param Request $request The GET request to send.
	 *
	 * @return PromiseInterface
	 *         Normally promising an array, though can be mixed (json_decode result)
	 *         Can throw UsageExceptions or RejectionExceptions
	 */
	public function getRequestAsync( Request $request ) {
		$promise = $this->getClient()->requestAsync(
			'GET',
			$this->apiUrl,
			$this->getClientRequestOptions( $request, 'query' )
		);

		return $promise->then( function ( ResponseInterface $response ) {
			return call_user_func( [ $this, 'decodeResponse' ], $response );
		} );
	}

	/**
	 * @since 2.0
	 *
	 * @param Request $request The POST request to send.
	 *
	 * @return PromiseInterface
	 *         Normally promising an array, though can be mixed (json_decode result)
	 *         Can throw UsageExceptions or RejectionExceptions
	 */
	public function postRequestAsync( Request $request ) {
		$promise = $this->getClient()->requestAsync(
			'POST',
			$this->apiUrl,
			$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
		);

		return $promise->then( function ( ResponseInterface $response ) {
			return call_user_func( [ $this, 'decodeResponse' ], $response );
		} );
	}

	/**
	 * @since 0.2
	 *
	 * @param Request $request The GET request to send.
	 *
	 * @return mixed Normally an array
	 */
	public function getRequest( Request $request ) {
		$response = $this->getClient()->request(
			'GET',
			$this->apiUrl,
			$this->getClientRequestOptions( $request, 'query' )
		);

		return $this->decodeResponse( $response );
	}

	/**
	 * @since 0.2
	 *
	 * @param Request $request The POST request to send.
	 *
	 * @return mixed Normally an array
	 */
	public function postRequest( Request $request ) {
		$response = $this->getClient()->request(
			'POST',
			$this->apiUrl,
			$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
		);

		return $this->decodeResponse( $response );
	}

	/**
	 * @param ResponseInterface $response
	 *
	 * @return mixed
	 * @throws UsageException
	 */
	private function decodeResponse( ResponseInterface $response ) {
		$resultArray = json_decode( $response->getBody(), true );

		$this->logWarnings( $resultArray );
		$this->throwUsageExceptions( $resultArray );

		return $resultArray;
	}

	/**
	 * @param Request $request
	 *
	 * @return string
	 */
	private function getPostRequestEncoding( Request $request ) {
		if ( $request instanceof MultipartRequest ) {
			return 'multipart';
		}
		foreach ( $request->getParams() as $value ) {
			if ( is_resource( $value ) ) {
				return 'multipart';
			}
		}
		return 'form_params';
	}

	/**
	 * @param Request $request
	 * @param string $paramsKey either 'query' or 'multipart'
	 *
	 * @throws RequestException
	 *
	 * @return array as needed by ClientInterface::get and ClientInterface::post
	 */
	private function getClientRequestOptions( Request $request, $paramsKey ) {
		$params = array_merge( $request->getParams(), [ 'format' => 'json' ] );
		if ( $paramsKey === 'multipart' ) {
			$params = $this->encodeMultipartParams( $request, $params );
		}

		return [
			$paramsKey => $params,
			'headers' => array_merge( $this->getDefaultHeaders(), $request->getHeaders() ),
		];
	}

	/**
	 * Turn the normal key-value array of request parameters into a multipart array where each
	 * parameter is a new array with a 'name' and 'contents' elements (and optionally more, if the
	 * request is a MultipartRequest).
	 *
	 * @param Request $request The request to which the parameters belong.
	 * @param string[] $params The existing parameters. Not the same as $request->getParams().
	 *
	 * @return array
	 */
	private function encodeMultipartParams( Request $request, $params ) {
		// See if there are any multipart parameters in this request.
		$multipartParams = ( $request instanceof MultipartRequest )
			? $request->getMultipartParams()
			: [];
		return array_map(
			function ( $name, $value ) use ( $multipartParams ) {
				$partParams = [
					'name' => $name,
					'contents' => $value,
				];
				if ( isset( $multipartParams[ $name ] ) ) {
					// If extra parameters have been set for this part, use them.
					$partParams = array_merge( $multipartParams[ $name ], $partParams );
				}
				return $partParams;
			},
			array_keys( $params ),
			$params
		);
	}

	/**
	 * @return array
	 */
	private function getDefaultHeaders() {
		return [
			'User-Agent' => $this->getUserAgent(),
		];
	}

	private function getUserAgent() {
		$loggedIn = $this->isLoggedin();
		if ( $loggedIn ) {
			return 'addwiki-mediawiki-client/' . $loggedIn;
		}
		return 'addwiki-mediawiki-client';
	}

	/**
	 * @param $result
	 */
	private function logWarnings( $result ) {
		if ( is_array( $result ) && array_key_exists( 'warnings', $result ) ) {
			foreach ( $result['warnings'] as $module => $warningData ) {
				// Accomodate both formatversion=2 and old-style API results
				$logPrefix = $module . ': ';
				if ( isset( $warningData['*'] ) ) {
					$this->logger->warning( $logPrefix . $warningData['*'], [ 'data' => $warningData ] );
				} else {
					$this->logger->warning( $logPrefix . $warningData['warnings'], [ 'data' => $warningData ] );
				}
			}
		}
	}

	/**
	 * @param array $result
	 *
	 * @throws UsageException
	 */
	private function throwUsageExceptions( $result ) {
		if ( is_array( $result ) && array_key_exists( 'error', $result ) ) {
			throw new UsageException(
				$result['error']['code'],
				$result['error']['info'],
				$result
			);
		}
	}

	/**
	 * @since 0.1
	 *
	 * @return bool|string false or the name of the current user
	 */
	public function isLoggedin() {
		return $this->isLoggedIn;
	}

	/**
	 * @since 0.1
	 *
	 * @param ApiUser $apiUser The ApiUser to log in as.
	 *
	 * @throws UsageException
	 * @return bool success
	 */
	public function login( ApiUser $apiUser ) {
		$this->logger->log( LogLevel::DEBUG, 'Logging in' );
		$credentials = $this->getLoginParams( $apiUser );
		$result = $this->postRequest( new SimpleRequest( 'login', $credentials ) );
		if ( $result['login']['result'] == "NeedToken" ) {
			$params = array_merge( [ 'lgtoken' => $result['login']['token'] ], $credentials );
			$result = $this->postRequest( new SimpleRequest( 'login', $params ) );
		}
		if ( $result['login']['result'] == "Success" ) {
			$this->isLoggedIn = $apiUser->getUsername();
			return true;
		}

		$this->isLoggedIn = false;
		$this->logger->log( LogLevel::DEBUG, 'Login failed.', $result );
		$this->throwLoginUsageException( $result );
		return false;
	}

	/**
	 * @param ApiUser $apiUser
	 *
	 * @return string[]
	 */
	private function getLoginParams( ApiUser $apiUser ) {
		$params = [
			'lgname' => $apiUser->getUsername(),
			'lgpassword' => $apiUser->getPassword(),
		];

		if ( !is_null( $apiUser->getDomain() ) ) {
			$params['lgdomain'] = $apiUser->getDomain();
		}
		return $params;
	}

	/**
	 * @param array $result
	 *
	 * @throws UsageException
	 */
	private function throwLoginUsageException( $result ) {
		$loginResult = $result['login']['result'];

		throw new UsageException(
			'login-' . $loginResult,
			array_key_exists( 'reason', $result['login'] )
				? $result['login']['reason']
				: 'No Reason given',
			$result
		);
	}

	/**
	 * @since 0.1
	 *
	 * @return bool success
	 */
	public function logout() {
		$this->logger->log( LogLevel::DEBUG, 'Logging out' );
		$result = $this->postRequest( new SimpleRequest( 'logout' ) );
		if ( $result === [] ) {
			$this->isLoggedIn = false;
			$this->clearTokens();
			return true;
		}
		return false;
	}

	/**
	 * @since 0.1
	 *
	 * @param string $type The token type to get.
	 *
	 * @return string
	 */
	public function getToken( $type = 'csrf' ) {
		return $this->session->getToken( $type );
	}

	/**
	 * Clear all tokens stored by the API.
	 *
	 * @since 0.1
	 */
	public function clearTokens() {
		$this->session->clearTokens();
	}

	/**
	 * @return string
	 */
	public function getVersion() {
		if ( !isset( $this->version ) ) {
			$result = $this->getRequest( new SimpleRequest( 'query', [
				'meta' => 'siteinfo',
				'continue' => '',
			] ) );
			preg_match(
				'/\d+(?:\.\d+)+/',
				$result['query']['general']['generator'],
				$versionParts
			);
			$this->version = $versionParts[0];
		}
		return $this->version;
	}

}


1		<?php
2
3		namespace Mediawiki\Api;
4
5		use DOMDocument;
6		use DOMXPath;
7		use GuzzleHttp\Client;
8		use GuzzleHttp\ClientInterface;
9		use GuzzleHttp\Exception\RequestException;
10		use GuzzleHttp\Promise\PromiseInterface;
11		use InvalidArgumentException;
12		use Mediawiki\Api\Guzzle\ClientFactory;
13		use Psr\Http\Message\ResponseInterface;
14		use Psr\Log\LoggerAwareInterface;
15		use Psr\Log\LoggerInterface;
16		use Psr\Log\LogLevel;
17		use Psr\Log\NullLogger;
18		use SimpleXMLElement;
19
20		/**
21		* Main class for this library
22		*
23		* @since 0.1
24		*
25		* @author Addshore
26		*/
27		class MediawikiApi implements MediawikiApiInterface, LoggerAwareInterface {
28
29		/**
30		* @var ClientInterface\|null Should be accessed through getClient
31		*/
32		private $client = null;
33
34		/**
35		* @var bool\|string
36		*/
37		private $isLoggedIn;
38
39		/**
40		* @var MediawikiSession
41		*/
42		private $session;
43
44		/**
45		* @var string
46		*/
47		private $version;
48
49		/**
50		* @var LoggerInterface
51		*/
52		private $logger;
53
54		/**
55		* @var string
56		*/
57		private $apiUrl;
58
59		/**
60		* @since 2.0
61		*
62		* @param string $apiEndpoint e.g. https://en.wikipedia.org/w/api.php
63		*
64		* @return self returns a MediawikiApi instance using $apiEndpoint
65		*/
66		public static function newFromApiEndpoint( $apiEndpoint ) {
67		return new self( $apiEndpoint );
68		}
69
70		/**
71		* Create a new MediawikiApi object from a URL to any page in a MediaWiki website.
72		*
73		* @since 2.0
74		* @see https://en.wikipedia.org/wiki/Really_Simple_Discovery
75		*
76		* @param string $url e.g. https://en.wikipedia.org OR https://de.wikipedia.org/wiki/Berlin
77		* @return self returns a MediawikiApi instance using the apiEndpoint provided by the RSD
78		* file accessible on all Mediawiki pages
79		* @throws RsdException If the RSD URL could not be found in the page's HTML.
80		*/
81	3	public static function newFromPage( $url ) {
82		// Set up HTTP client and HTML document.
83	3	$tempClient = new Client( [ 'headers' => [ 'User-Agent' => 'addwiki-mediawiki-client' ] ] );
84	3	$pageHtml = $tempClient->get( $url )->getBody();
85	3	$pageDoc = new DOMDocument();
86
87		// Try to load the HTML (turn off errors temporarily; most don't matter, and if they do get
88		// in the way of finding the API URL, will be reported in the RsdException below).
89	3	$internalErrors = libxml_use_internal_errors( true );
90	3	$pageDoc->loadHTML( $pageHtml );
91	3	$libXmlErrors = libxml_get_errors();
92	3	libxml_use_internal_errors( $internalErrors );
93
94		// Extract the RSD link.
95	3	$xpath = 'head/link[@type="application/rsd+xml"][@href]';
96	3	$link = ( new DOMXpath( $pageDoc ) )->query( $xpath );
97	3	if ( $link->length === 0 ) {
98		// Format libxml errors for display.
99		$libXmlErrorStr = array_reduce( $libXmlErrors, function ( $prevErr, $err ) {
100		return $prevErr . ', ' . $err->message . ' (line '.$err->line . ')';
101	1	} );
102	1	if ( $libXmlErrorStr ) {
103		$libXmlErrorStr = "In addition, libxml had the following errors: $libXmlErrorStr";
104		}
105	1	throw new RsdException( "Unable to find RSD URL in page: $url $libXmlErrorStr" );
106		}
107	2	$rsdUrl = $link->item( 0 )->attributes->getnamedItem( 'href' )->nodeValue;
108
109		// Then get the RSD XML, and return the API link.
110	2	$rsdXml = new SimpleXMLElement( $tempClient->get( $rsdUrl )->getBody() );
111	2	return self::newFromApiEndpoint( (string)$rsdXml->service->apis->api->attributes()->apiLink );
112		}
113
114		/**
115		* @param string $apiUrl The API Url
116		* @param ClientInterface\|null $client Guzzle Client
117		* @param MediawikiSession\|null $session Inject a custom session here
118		*/
119	24	public function __construct( $apiUrl, ClientInterface $client = null,
120		MediawikiSession $session = null ) {
121	24	if ( !is_string( $apiUrl ) ) {
122	4	throw new InvalidArgumentException( '$apiUrl must be a string' );
123		}
124	20	if ( $session === null ) {
125	20	$session = new MediawikiSession( $this );
126	20	}
127
128	20	$this->apiUrl = $apiUrl;
129	20	$this->client = $client;
130	20	$this->session = $session;
131
132	20	$this->logger = new NullLogger();
133	20	}
134
135		/**
136		* Get the API URL (the URL to which API requests are sent, usually ending in api.php).
137		* This is useful if you've created this object via MediawikiApi::newFromPage().
138		*
139		* @since 2.3
140		*
141		* @return string The API URL.
142		*/
143		public function getApiUrl() {
144		return $this->apiUrl;
145		}
146
147		/**
148		* @return ClientInterface
149		*/
150	21	private function getClient() {
151	21	if ( $this->client === null ) {
152	4	$clientFactory = new ClientFactory();
153	4	$clientFactory->setLogger( $this->logger );
154	4	$this->client = $clientFactory->getClient();
155	4	}
156	21	return $this->client;
157		}
158
159		/**
160		* Sets a logger instance on the object
161		*
162		* @since 1.1
163		*
164		* @param LoggerInterface $logger The new Logger object.
165		*
166		* @return null
167		*/
168		public function setLogger( LoggerInterface $logger ) {
169		$this->logger = $logger;
170		$this->session->setLogger( $logger );
171		}
172
173		/**
174		* @since 2.0
175		*
176		* @param Request $request The GET request to send.
177		*
178		* @return PromiseInterface
179		* Normally promising an array, though can be mixed (json_decode result)
180		* Can throw UsageExceptions or RejectionExceptions
181		*/
182	1	public function getRequestAsync( Request $request ) {
183	1	$promise = $this->getClient()->requestAsync(
184	1	'GET',
185	1	$this->apiUrl,
186	1	$this->getClientRequestOptions( $request, 'query' )
187	1	);
188
189		return $promise->then( function ( ResponseInterface $response ) {
190	1	return call_user_func( [ $this, 'decodeResponse' ], $response );
191	1	} );
192		}
193
194		/**
195		* @since 2.0
196		*
197		* @param Request $request The POST request to send.
198		*
199		* @return PromiseInterface
200		* Normally promising an array, though can be mixed (json_decode result)
201		* Can throw UsageExceptions or RejectionExceptions
202		*/
203	1	public function postRequestAsync( Request $request ) {
204	1	$promise = $this->getClient()->requestAsync(
205	1	'POST',
206	1	$this->apiUrl,
207	1	$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
208	1	);
209
210		return $promise->then( function ( ResponseInterface $response ) {
211	1	return call_user_func( [ $this, 'decodeResponse' ], $response );
212	1	} );
213		}
214
215		/**
216		* @since 0.2
217		*
218		* @param Request $request The GET request to send.
219		*
220		* @return mixed Normally an array
221		*/
222	9	public function getRequest( Request $request ) {
223	9	$response = $this->getClient()->request(
224	9	'GET',
225	9	$this->apiUrl,
226	9	$this->getClientRequestOptions( $request, 'query' )
227	9	);
228
229	9	return $this->decodeResponse( $response );
230		}
231
232		/**
233		* @since 0.2
234		*
235		* @param Request $request The POST request to send.
236		*
237		* @return mixed Normally an array
238		*/
239	10	public function postRequest( Request $request ) {
240	10	$response = $this->getClient()->request(
241	10	'POST',
242	10	$this->apiUrl,
243	10	$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
244	10	);
245
246	10	return $this->decodeResponse( $response );
247		}
248
249		/**
250		* @param ResponseInterface $response
251		*
252		* @return mixed
253		* @throws UsageException
254		*/
255	21	private function decodeResponse( ResponseInterface $response ) {
256	21	$resultArray = json_decode( $response->getBody(), true );
257
258	21	$this->logWarnings( $resultArray );
259	21	$this->throwUsageExceptions( $resultArray );
260
261	19	return $resultArray;
262		}
263
264		/**
265		* @param Request $request
266		*
267		* @return string
268		*/
269	9	private function getPostRequestEncoding( Request $request ) {
270	9	if ( $request instanceof MultipartRequest ) {
271		return 'multipart';
272		}
273	9	foreach ( $request->getParams() as $value ) {
274	9	if ( is_resource( $value ) ) {
275	1	return 'multipart';
276		}
277	9	}
278	8	return 'form_params';
279		}
280
281		/**
282		* @param Request $request
283		* @param string $paramsKey either 'query' or 'multipart'
284		*
285		* @throws RequestException
286		*
287		* @return array as needed by ClientInterface::get and ClientInterface::post
288		*/
289	21	private function getClientRequestOptions( Request $request, $paramsKey ) {
290	21	$params = array_merge( $request->getParams(), [ 'format' => 'json' ] );
291	21	if ( $paramsKey === 'multipart' ) {
292	1	$params = $this->encodeMultipartParams( $request, $params );
293	1	}
294
295		return [
296	21	$paramsKey => $params,
297	21	'headers' => array_merge( $this->getDefaultHeaders(), $request->getHeaders() ),
298	21	];
299		}
300
301		/**
302		* Turn the normal key-value array of request parameters into a multipart array where each
303		* parameter is a new array with a 'name' and 'contents' elements (and optionally more, if the
304		* request is a MultipartRequest).
305		*
306		* @param Request $request The request to which the parameters belong.
307		* @param string[] $params The existing parameters. Not the same as $request->getParams().
308		*
309		* @return array
310		*/
311	1	private function encodeMultipartParams( Request $request, $params ) {
312		// See if there are any multipart parameters in this request.
313	1	$multipartParams = ( $request instanceof MultipartRequest )
314	1	? $request->getMultipartParams()
315	1	: [];
316	1	return array_map(
317	1	function ( $name, $value ) use ( $multipartParams ) {
318		$partParams = [
319	1	'name' => $name,
320	1	'contents' => $value,
321	1	];
322	1	if ( isset( $multipartParams[ $name ] ) ) {
323		// If extra parameters have been set for this part, use them.
324		$partParams = array_merge( $multipartParams[ $name ], $partParams );
325		}
326	1	return $partParams;
327	1	},
328	1	array_keys( $params ),
329		$params
330	1	);
331		}
332
333		/**
334		* @return array
335		*/
336	17	private function getDefaultHeaders() {
337		return [
338	17	'User-Agent' => $this->getUserAgent(),
339	17	];
340		}
341
342	17	private function getUserAgent() {
343	17	$loggedIn = $this->isLoggedin();
344	17	if ( $loggedIn ) {
345		return 'addwiki-mediawiki-client/' . $loggedIn;
346		}
347	17	return 'addwiki-mediawiki-client';
348		}
349
350		/**
351		* @param $result
352		*/
353	17	private function logWarnings( $result ) {
354	17	if ( is_array( $result ) && array_key_exists( 'warnings', $result ) ) {
355		foreach ( $result['warnings'] as $module => $warningData ) {
356		// Accomodate both formatversion=2 and old-style API results
357		$logPrefix = $module . ': ';
358		if ( isset( $warningData['*'] ) ) {
359		$this->logger->warning( $logPrefix . $warningData['*'], [ 'data' => $warningData ] );
360		} else {
361		$this->logger->warning( $logPrefix . $warningData['warnings'], [ 'data' => $warningData ] );
362		}
363		}
364		}
365	17	}
366
367		/**
368		* @param array $result
369		*
370		* @throws UsageException
371		*/
372	17	private function throwUsageExceptions( $result ) {
373	17	if ( is_array( $result ) && array_key_exists( 'error', $result ) ) {
374	2	throw new UsageException(
375	2	$result['error']['code'],
376	2	$result['error']['info'],
377		$result
378	2	);
379		}
380	15	}
381
382		/**
383		* @since 0.1
384		*
385		* @return bool\|string false or the name of the current user
386		*/
387	17	public function isLoggedin() {
388	17	return $this->isLoggedIn;
389		}
390
391		/**
392		* @since 0.1
393		*
394		* @param ApiUser $apiUser The ApiUser to log in as.
395		*
396		* @throws UsageException
397		* @return bool success
398		*/
399	2	public function login( ApiUser $apiUser ) {
400	2	$this->logger->log( LogLevel::DEBUG, 'Logging in' );
401	2	$credentials = $this->getLoginParams( $apiUser );
402	2	$result = $this->postRequest( new SimpleRequest( 'login', $credentials ) );
403	2	if ( $result['login']['result'] == "NeedToken" ) {
404	2	$params = array_merge( [ 'lgtoken' => $result['login']['token'] ], $credentials );
405	2	$result = $this->postRequest( new SimpleRequest( 'login', $params ) );
406	2	}
407	2	if ( $result['login']['result'] == "Success" ) {
408	1	$this->isLoggedIn = $apiUser->getUsername();
409	1	return true;
410		}
411
412	1	$this->isLoggedIn = false;
413	1	$this->logger->log( LogLevel::DEBUG, 'Login failed.', $result );
414	1	$this->throwLoginUsageException( $result );
415		return false;
416		}
417
418		/**
419		* @param ApiUser $apiUser
420		*
421		* @return string[]
422		*/
423	2	private function getLoginParams( ApiUser $apiUser ) {
424		$params = [
425	2	'lgname' => $apiUser->getUsername(),
426	2	'lgpassword' => $apiUser->getPassword(),
427	2	];
428
429	2	if ( !is_null( $apiUser->getDomain() ) ) {
430		$params['lgdomain'] = $apiUser->getDomain();
431		}
432	2	return $params;
433		}
434
435		/**
436		* @param array $result
437		*
438		* @throws UsageException
439		*/
440	1	private function throwLoginUsageException( $result ) {
441	1	$loginResult = $result['login']['result'];
442
443	1	throw new UsageException(
444	1	'login-' . $loginResult,
445	1	array_key_exists( 'reason', $result['login'] )
446	1	? $result['login']['reason']
447	1	: 'No Reason given',
448		$result
449	1	);
450		}
451
452		/**
453		* @since 0.1
454		*
455		* @return bool success
456		*/
457	2	public function logout() {
458	2	$this->logger->log( LogLevel::DEBUG, 'Logging out' );
459	2	$result = $this->postRequest( new SimpleRequest( 'logout' ) );
460	2	if ( $result === [] ) {
461	1	$this->isLoggedIn = false;
462	1	$this->clearTokens();
463	1	return true;
464		}
465	1	return false;
466		}
467
468		/**
469		* @since 0.1
470		*
471		* @param string $type The token type to get.
472		*
473		* @return string
474		*/
475	2	public function getToken( $type = 'csrf' ) {
476	2	return $this->session->getToken( $type );
477		}
478
479		/**
480		* Clear all tokens stored by the API.
481		*
482		* @since 0.1
483		*/
484	1	public function clearTokens() {
485	1	$this->session->clearTokens();
486	1	}
487
488		/**
489		* @return string
490		*/
491	4	public function getVersion() {
492	4	if ( !isset( $this->version ) ) {
493	4	$result = $this->getRequest( new SimpleRequest( 'query', [
494	4	'meta' => 'siteinfo',
495	4	'continue' => '',
496	4	] ) );
497	4	preg_match(
498	4	'/\d+(?:\.\d+)+/',
499	4	$result['query']['general']['generator'],
500		$versionParts
501	4	);
502	4	$this->version = $versionParts[0];
503	4	}
504	4	return $this->version;
505		}
506
507		}
508

addwiki / mediawiki-api-base

Push — master ( 6fb038...2eb635 )

MediawikiApi::postRequestAsync() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like