MediawikiApi::getPostRequestEncoding() - Code Metrics - Inspection of "Merge pull request #22 from addwiki/multipart" - addwiki/mediawiki-api-base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 480ef2...9a7c34 )

by adam

created 2016-09-25 09:31 UTC

MediawikiApi::getPostRequestEncoding() A

↳ Parent: MediawikiApi

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

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

<?php

namespace Mediawiki\Api;

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.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 );
	}

	/**
	 * @since 2.0.0
	 *
	 * @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
	 *
	 * @see https://en.wikipedia.org/wiki/Really_Simple_Discovery
	 */
	public static function newFromPage( $url ) {
		$tempClient = new Client( array( 'headers' => array( 'User-Agent' => 'addwiki-mediawiki-client' ) ) );
		$pageXml = new SimpleXMLElement( $tempClient->get( $url )->getBody() );
		$rsdElement = $pageXml->xpath( 'head/link[@type="application/rsd+xml"][@href]' );
		$rsdXml = new SimpleXMLElement( $tempClient->get( (string) $rsdElement[0]->attributes()['href'] )->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().
	 * @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
	 *
	 * @return null
	 */
	public function setLogger( LoggerInterface $logger ) {
		$this->logger = $logger;
		$this->session->setLogger( $logger );
	}

	/**
	 * @since 2.0
	 *
	 * @param Request $request
	 *
	 * @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( array( $this, 'decodeResponse' ), $response );
		} );
	}

	/**
	 * @since 2.0
	 *
	 * @param Request $request
	 *
	 * @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( array( $this, 'decodeResponse' ), $response );
		} );
	}

	/**
	 * @since 0.2
	 *
	 * @param Request $request
	 *
	 * @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
	 *
	 * @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 ) {
	    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(), array( 'format' => 'json' ) );
	    if ( $paramsKey === 'multipart' ) {
            $params = $this->encodeMultipartParams( $params );
        }

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

    /**
     * @param array $params
     * @return array
     */
	private function encodeMultipartParams( $params ) {
	    return array_map( function( $name, $value ) {
            return array(
                'name' => $name,
                'contents' => $value
            );
        }, array_keys( $params ), $params );
    }

	/**
	 * @return array
	 */
	private function getDefaultHeaders() {
		return array(
			'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 ) {
				$this->logger->log( LogLevel::WARNING, $module . ': ' . $warningData['*'], array( '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
	 *
	 * @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" ) {
			$result = $this->postRequest( new SimpleRequest( 'login', array_merge( array( 'lgtoken' => $result['login']['token'] ), $credentials) ) );
		}
		if ( $result['login']['result'] == "Success" ) {
			$this->isLoggedIn = $apiUser->getUsername();
			return true;
		}

		$this->isLoggedIn = false;
		$this->throwLoginUsageException( $result );
		return false;
	}

	/**
	 * @param ApiUser $apiUser
	 *
	 * @return string[]
	 */
	private function getLoginParams( ApiUser $apiUser ) {
		$params = array(
			'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,
			$this->getLoginExceptionMessage( $loginResult ),
			$result
		);
	}

	/**
	 * @param string $loginResult
	 *
	 * @return string
	 */
	private function getLoginExceptionMessage( $loginResult ) {
		switch( $loginResult ) {
			case 'Illegal';
				return 'You provided an illegal username';
			case 'NotExists';
				return 'The username you provided doesn\'t exist';
			case 'WrongPass';
				return 'The password you provided is incorrect';
			case 'WrongPluginPass';
				return 'An authentication plugin rather than MediaWiki itself rejected the password';
			case 'CreateBlocked';
				return 'The wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation';
			case 'Throttled';
				return 'You\'ve logged in too many times in a short time.';
			case 'Blocked';
				return 'User is blocked';
			case 'NeedToken';
				return 'Either you did not provide the login token or the sessionid cookie.';
			default:
				return $loginResult;
		}
	}

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

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

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

	/**
	 * @return string
	 */
	public function getVersion(){
		if( !isset( $this->version ) ) {
			$result = $this->getRequest( new SimpleRequest( 'query', array(
				'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 GuzzleHttp\Client;
6		use GuzzleHttp\ClientInterface;
7		use GuzzleHttp\Exception\RequestException;
8		use GuzzleHttp\Promise\PromiseInterface;
9		use InvalidArgumentException;
10		use Mediawiki\Api\Guzzle\ClientFactory;
11		use Psr\Http\Message\ResponseInterface;
12		use Psr\Log\LoggerAwareInterface;
13		use Psr\Log\LoggerInterface;
14		use Psr\Log\LogLevel;
15		use Psr\Log\NullLogger;
16		use SimpleXMLElement;
17
18		/**
19		* Main class for this library
20		*
21		* @since 0.1
22		*
23		* @author Addshore
24		*/
25		class MediawikiApi implements MediawikiApiInterface, LoggerAwareInterface {
26
27		/**
28		* @var ClientInterface\|null Should be accessed through getClient
29		*/
30		private $client = null;
31
32		/**
33		* @var bool\|string
34		*/
35		private $isLoggedIn;
36
37		/**
38		* @var MediawikiSession
39		*/
40		private $session;
41
42		/**
43		* @var string
44		*/
45		private $version;
46
47		/**
48		* @var LoggerInterface
49		*/
50		private $logger;
51
52		/**
53		* @var string
54		*/
55		private $apiUrl;
56
57		/**
58		* @since 2.0.0
59		*
60		* @param string $apiEndpoint e.g. https://en.wikipedia.org/w/api.php
61		*
62		* @return self returns a MediawikiApi instance using $apiEndpoint
63		*/
64		public static function newFromApiEndpoint( $apiEndpoint ) {
65		return new self( $apiEndpoint );
66		}
67
68		/**
69		* @since 2.0.0
70		*
71		* @param string $url e.g. https://en.wikipedia.org OR https://de.wikipedia.org/wiki/Berlin
72		*
73		* @return self returns a MediawikiApi instance using the apiEndpoint provided by the RSD
74		* file accessible on all Mediawiki pages
75		*
76		* @see https://en.wikipedia.org/wiki/Really_Simple_Discovery
77		*/
78	1	public static function newFromPage( $url ) {
79	1	$tempClient = new Client( array( 'headers' => array( 'User-Agent' => 'addwiki-mediawiki-client' ) ) );
80	1	$pageXml = new SimpleXMLElement( $tempClient->get( $url )->getBody() );
81	1	$rsdElement = $pageXml->xpath( 'head/link[@type="application/rsd+xml"][@href]' );
82	1	$rsdXml = new SimpleXMLElement( $tempClient->get( (string) $rsdElement[0]->attributes()['href'] )->getBody() );
83	1	return self::newFromApiEndpoint( (string) $rsdXml->service->apis->api->attributes()->apiLink );
84		}
85
86		/**
87		* @param string $apiUrl The API Url
88		* @param ClientInterface\|null $client Guzzle Client
89		* @param MediawikiSession\|null $session Inject a custom session here
90		*/
91	23	public function __construct( $apiUrl, ClientInterface $client = null, MediawikiSession $session = null ) {
92	23	if( !is_string( $apiUrl ) ) {
93	4	throw new InvalidArgumentException( '$apiUrl must be a string' );
94		}
95	19	if( $session === null ) {
96	19	$session = new MediawikiSession( $this );
97	19	}
98
99	19	$this->apiUrl = $apiUrl;
100	19	$this->client = $client;
101	19	$this->session = $session;
102
103	19	$this->logger = new NullLogger();
104	19	}
105
106		/**
107		* Get the API URL (the URL to which API requests are sent, usually ending in api.php).
108		* This is useful if you've created this object via MediawikiApi::newFromPage().
109		* @return string The API URL.
110		*/
111		public function getApiUrl() {
112		return $this->apiUrl;
113		}
114
115		/**
116		* @return ClientInterface
117		*/
118	20	private function getClient() {
119	20	if( $this->client === null ) {
120	4	$clientFactory = new ClientFactory();
121	4	$clientFactory->setLogger( $this->logger );
122	4	$this->client = $clientFactory->getClient();
123	4	}
124	20	return $this->client;
125		}
126
127		/**
128		* Sets a logger instance on the object
129		*
130		* @since 1.1
131		*
132		* @param LoggerInterface $logger
133		*
134		* @return null
135		*/
136		public function setLogger( LoggerInterface $logger ) {
137		$this->logger = $logger;
138		$this->session->setLogger( $logger );
139		}
140
141		/**
142		* @since 2.0
143		*
144		* @param Request $request
145		*
146		* @return PromiseInterface
147		* Normally promising an array, though can be mixed (json_decode result)
148		* Can throw UsageExceptions or RejectionExceptions
149		*/
150	1	public function getRequestAsync( Request $request ) {
151	1	$promise = $this->getClient()->requestAsync(
152	1	'GET',
153	1	$this->apiUrl,
154	1	$this->getClientRequestOptions( $request, 'query' )
155	1	);
156
157		return $promise->then( function( ResponseInterface $response ) {
158	1	return call_user_func( array( $this, 'decodeResponse' ), $response );
159	1	} );
160		}
161
162		/**
163		* @since 2.0
164		*
165		* @param Request $request
166		*
167		* @return PromiseInterface
168		* Normally promising an array, though can be mixed (json_decode result)
169		* Can throw UsageExceptions or RejectionExceptions
170		*/
171	1	public function postRequestAsync( Request $request ) {
172	1	$promise = $this->getClient()->requestAsync(
173	1	'POST',
174	1	$this->apiUrl,
175	1	$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
176	1	);
177
178	1	return $promise->then( function( ResponseInterface $response ) {
179	1	return call_user_func( array( $this, 'decodeResponse' ), $response );
180	1	} );
181		}
182
183		/**
184		* @since 0.2
185		*
186		* @param Request $request
187		*
188		* @return mixed Normally an array
189		*/
190	9	public function getRequest( Request $request ) {
191	9	$response = $this->getClient()->request(
192	9	'GET',
193	9	$this->apiUrl,
194	9	$this->getClientRequestOptions( $request, 'query' )
195	9	);
196
197	9	return $this->decodeResponse( $response );
198		}
199
200		/**
201		* @since 0.2
202		*
203		* @param Request $request
204		*
205		* @return mixed Normally an array
206		*/
207	9	public function postRequest( Request $request ) {
208	9	$response = $this->getClient()->request(
209	9	'POST',
210	9	$this->apiUrl,
211	9	$this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) )
212	9	);
213
214	9	return $this->decodeResponse( $response );
215		}
216
217		/**
218		* @param ResponseInterface $response
219		*
220		* @return mixed
221		* @throws UsageException
222		*/
223	20	private function decodeResponse( ResponseInterface $response ) {
224	20	$resultArray = json_decode( $response->getBody(), true );
225
226	20	$this->logWarnings( $resultArray );
227	20	$this->throwUsageExceptions( $resultArray );
228
229	18	return $resultArray;
230		}
231
232		/**
233		* @param Request $request
234		*
235		* @return string
236		*/
237		private function getPostRequestEncoding( Request $request ) {
238		foreach ( $request->getParams() as $value ) {
239		if ( is_resource( $value ) ) {
240	20	return 'multipart';
241		}
242	20	}
243	20	return 'form_params';
244	20	}
245
246		/**
247		* @param Request $request
248		* @param string $paramsKey either 'query' or 'multipart'
249		*
250	16	* @throws RequestException
251		*
252	16	* @return array as needed by ClientInterface::get and ClientInterface::post
253	16	*/
254		private function getClientRequestOptions( Request $request, $paramsKey ) {
255		$params = array_merge( $request->getParams(), array( 'format' => 'json' ) );
256	16	if ( $paramsKey === 'multipart' ) {
257	16	$params = $this->encodeMultipartParams( $params );
258	16	}
259
260		return array(
261	16	$paramsKey => $params,
262		'headers' => array_merge( $this->getDefaultHeaders(), $request->getHeaders() ),
263		);
264		}
265
266		/**
267	16	* @param array $params
268	16	* @return array
269		*/
270		private function encodeMultipartParams( $params ) {
271		return array_map( function( $name, $value ) {
272		return array(
273	16	'name' => $name,
274		'contents' => $value
275		);
276		}, array_keys( $params ), $params );
277		}
278
279		/**
280	16	* @return array
281	16	*/
282	2	private function getDefaultHeaders() {
283	2	return array(
284	2	'User-Agent' => $this->getUserAgent(),
285		);
286	2	}
287
288	14	private function getUserAgent() {
289		$loggedIn = $this->isLoggedin();
290		if( $loggedIn ) {
291		return 'addwiki-mediawiki-client/' . $loggedIn;
292		}
293		return 'addwiki-mediawiki-client';
294		}
295	16
296	16	/**
297		* @param $result
298		*/
299		private function logWarnings( $result ) {
300		if( is_array( $result ) && array_key_exists( 'warnings', $result ) ) {
301		foreach( $result['warnings'] as $module => $warningData ) {
302		$this->logger->log( LogLevel::WARNING, $module . ': ' . $warningData['*'], array( 'data' => $warningData ) );
303		}
304		}
305		}
306
307	2	/**
308	2	* @param array $result
309	2	*
310	2	* @throws UsageException
311	2	*/
312	2	private function throwUsageExceptions( $result ) {
313	2	if( is_array( $result ) && array_key_exists( 'error', $result ) ) {
314	2	throw new UsageException(
315	1	$result['error']['code'],
316	1	$result['error']['info'],
317		$result
318		);
319	1	}
320	1	}
321
322		/**
323		* @since 0.1
324		*
325		* @return bool\|string false or the name of the current user
326		*/
327		public function isLoggedin() {
328		return $this->isLoggedIn;
329	2	}
330
331	2	/**
332	2	* @since 0.1
333	2	*
334		* @param ApiUser $apiUser
335	2	*
336		* @throws UsageException
337		* @return bool success
338	2	*/
339		public function login( ApiUser $apiUser ) {
340		$this->logger->log( LogLevel::DEBUG, 'Logging in' );
341		$credentials = $this->getLoginParams( $apiUser );
342		$result = $this->postRequest( new SimpleRequest( 'login', $credentials ) );
343		if ( $result['login']['result'] == "NeedToken" ) {
344		$result = $this->postRequest( new SimpleRequest( 'login', array_merge( array( 'lgtoken' => $result['login']['token'] ), $credentials) ) );
345		}
346	1	if ( $result['login']['result'] == "Success" ) {
347	1	$this->isLoggedIn = $apiUser->getUsername();
348		return true;
349	1	}
350	1
351	1	$this->isLoggedIn = false;
352		$this->throwLoginUsageException( $result );
353	1	return false;
354		}
355
356		/**
357		* @param ApiUser $apiUser
358		*
359		* @return string[]
360		*/
361	1	private function getLoginParams( ApiUser $apiUser ) {
362		$params = array(
363	1	'lgname' => $apiUser->getUsername(),
364		'lgpassword' => $apiUser->getPassword(),
365	1	);
366
367	1	if( !is_null( $apiUser->getDomain() ) ) {
368		$params['lgdomain'] = $apiUser->getDomain();
369	1	}
370		return $params;
371	1	}
372
373	1	/**
374		* @param array $result
375	1	*
376		* @throws UsageException
377	1	*/
378		private function throwLoginUsageException( $result ) {
379	1	$loginResult = $result['login']['result'];
380	1
381	1	throw new UsageException(
382		'login-' . $loginResult,
383		$this->getLoginExceptionMessage( $loginResult ),
384		$result
385		);
386		}
387
388		/**
389	2	* @param string $loginResult
390	2	*
391	2	* @return string
392	2	*/
393	1	private function getLoginExceptionMessage( $loginResult ) {
394	1	switch( $loginResult ) {
395	1	case 'Illegal';
396		return 'You provided an illegal username';
397	1	case 'NotExists';
398		return 'The username you provided doesn\'t exist';
399		case 'WrongPass';
400		return 'The password you provided is incorrect';
401		case 'WrongPluginPass';
402		return 'An authentication plugin rather than MediaWiki itself rejected the password';
403		case 'CreateBlocked';
404		return 'The wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation';
405		case 'Throttled';
406		return 'You\'ve logged in too many times in a short time.';
407	2	case 'Blocked';
408	2	return 'User is blocked';
409		case 'NeedToken';
410		return 'Either you did not provide the login token or the sessionid cookie.';
411		default:
412		return $loginResult;
413		}
414		}
415
416	1	/**
417	1	* @since 0.1
418	1	*
419		* @return bool success
420		*/
421		public function logout() {
422		$this->logger->log( LogLevel::DEBUG, 'Logging out' );
423	4	$result = $this->postRequest( new SimpleRequest( 'logout' ) );
424	4	if( $result === array() ) {
425	4	$this->isLoggedIn = false;
426	4	$this->clearTokens();
427	4	return true;
428	4	}
429	4	return false;
430	4	}
431	4
432		/**
433	4	* @since 0.1
434	4	*
435	4	* @param string $type
436	4	*
437		* @return string
438		*/
439		public function getToken( $type = 'csrf' ) {
440		return $this->session->getToken( $type );
441		}
442
443		/**
444		* @since 0.1
445		*
446		* Clears all tokens stored by the api
447		*/
448		public function clearTokens() {
449		$this->session->clearTokens();
450		}
451
452		/**
453		* @return string
454		*/
455		public function getVersion(){
456		if( !isset( $this->version ) ) {
457		$result = $this->getRequest( new SimpleRequest( 'query', array(
458		'meta' => 'siteinfo',
459		'continue' => '',
460		) ) );
461		preg_match(
462		'/\d+(?:\.\d+)+/',
463		$result['query']['general']['generator'],
464		$versionParts
465		);
466		$this->version = $versionParts[0];
467		}
468		return $this->version;
469		}
470
471		}
472

addwiki / mediawiki-api-base

Push — master ( 480ef2...9a7c34 )

MediawikiApi::getPostRequestEncoding() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like