3 use Wikimedia\TestingAccessWrapper
;
12 class ApiMainTest
extends ApiTestCase
{
15 * Test that the API will accept a FauxRequest and execute.
17 public function testApi() {
19 new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] )
22 $data = $api->getResult()->getResultData();
23 $this->assertInternalType( 'array', $data );
24 $this->assertArrayHasKey( 'query', $data );
27 public function testApiNoParam() {
30 $data = $api->getResult()->getResultData();
31 $this->assertInternalType( 'array', $data );
35 * ApiMain behaves differently if passed a FauxRequest (mInternalMode set
36 * to true) or a proper WebRequest (mInternalMode false). For most tests
37 * we can just set mInternalMode to false using TestingAccessWrapper, but
38 * this doesn't work for the constructor. This method returns an ApiMain
39 * that's been set up in non-internal mode.
41 * Note that calling execute() will print to the console. Wrap it in
42 * ob_start()/ob_end_clean() to prevent this.
44 * @param array $requestData Query parameters for the WebRequest
45 * @param array $headers Headers for the WebRequest
47 private function getNonInternalApiMain( array $requestData, array $headers = [] ) {
48 $req = $this->getMockBuilder( WebRequest
::class )
49 ->setMethods( [ 'response', 'getRawIP' ] )
51 $response = new FauxResponse();
52 $req->method( 'response' )->willReturn( $response );
53 $req->method( 'getRawIP' )->willReturn( '127.0.0.1' );
55 $wrapper = TestingAccessWrapper
::newFromObject( $req );
56 $wrapper->data
= $requestData;
58 $wrapper->headers
= $headers;
61 return new ApiMain( $req );
64 public function testUselang() {
67 $api = $this->getNonInternalApiMain( [
77 $this->assertSame( 'fr', $wgLang->getCode() );
80 public function testNonWhitelistedCorsWithCookies() {
81 $logFile = $this->getNewTempFile();
83 $this->mergeMwGlobalArrayValue( '_COOKIE', [ 'forceHTTPS' => '1' ] );
84 $logger = new TestLogger( true );
85 $this->setLogger( 'cors', $logger );
87 $api = $this->getNonInternalApiMain( [
90 // For some reason multiple origins (which are not allowed in the
91 // WHATWG Fetch spec that supersedes the RFC) are always considered to
93 ], [ 'ORIGIN' => 'https://www.example.com https://www.com.example' ] );
96 [ [ Psr\Log\LogLevel
::WARNING
, 'Non-whitelisted CORS request with session cookies' ] ],
101 public function testSuppressedLogin() {
105 $api = $this->getNonInternalApiMain( [
107 'meta' => 'siteinfo',
115 $this->assertNotSame( $origUser, $wgUser );
116 $this->assertSame( 'true', $api->getContext()->getRequest()->response()
117 ->getHeader( 'MediaWiki-Login-Suppressed' ) );
120 public function testSetContinuationManager() {
121 $api = new ApiMain();
122 $manager = $this->createMock( ApiContinuationManager
::class );
123 $api->setContinuationManager( $manager );
124 $this->assertTrue( true, 'No exception' );
125 return [ $api, $manager ];
129 * @depends testSetContinuationManager
131 public function testSetContinuationManagerTwice( $args ) {
132 $this->setExpectedException( UnexpectedValueException
::class,
133 'ApiMain::setContinuationManager: tried to set manager from ' .
134 'when a manager is already set from ' );
136 list( $api, $manager ) = $args;
137 $api->setContinuationManager( $manager );
140 public function testSetCacheModeUnrecognized() {
141 $api = new ApiMain();
142 $api->setCacheMode( 'unrecognized' );
145 TestingAccessWrapper
::newFromObject( $api )->mCacheMode
,
146 'Unrecognized params must be silently ignored'
150 public function testSetCacheModePrivateWiki() {
151 $this->setGroupPermissions( '*', 'read', false );
153 $wrappedApi = TestingAccessWrapper
::newFromObject( new ApiMain() );
154 $wrappedApi->setCacheMode( 'public' );
155 $this->assertSame( 'private', $wrappedApi->mCacheMode
);
156 $wrappedApi->setCacheMode( 'anon-public-user-private' );
157 $this->assertSame( 'private', $wrappedApi->mCacheMode
);
160 public function testAddRequestedFieldsRequestId() {
161 $req = new FauxRequest( [
163 'meta' => 'siteinfo',
164 'requestid' => '123456',
166 $api = new ApiMain( $req );
168 $this->assertSame( '123456', $api->getResult()->getResultData()['requestid'] );
171 public function testAddRequestedFieldsCurTimestamp() {
172 $req = new FauxRequest( [
174 'meta' => 'siteinfo',
175 'curtimestamp' => '',
177 $api = new ApiMain( $req );
179 $timestamp = $api->getResult()->getResultData()['curtimestamp'];
180 $this->assertLessThanOrEqual( 1, abs( strtotime( $timestamp ) - time() ) );
183 public function testAddRequestedFieldsResponseLangInfo() {
184 $req = new FauxRequest( [
186 'meta' => 'siteinfo',
187 // errorlang is ignored if errorformat is not specified
188 'errorformat' => 'plaintext',
191 'responselanginfo' => '',
193 $api = new ApiMain( $req );
195 $data = $api->getResult()->getResultData();
196 $this->assertSame( 'fr', $data['uselang'] );
197 $this->assertSame( 'ja', $data['errorlang'] );
200 public function testSetupModuleUnknown() {
201 $this->setExpectedException( ApiUsageException
::class,
202 'Unrecognized value for parameter "action": unknownaction.' );
204 $req = new FauxRequest( [ 'action' => 'unknownaction' ] );
205 $api = new ApiMain( $req );
209 public function testSetupModuleNoTokenProvided() {
210 $this->setExpectedException( ApiUsageException
::class,
211 'The "token" parameter must be set.' );
213 $req = new FauxRequest( [
215 'title' => 'New page',
216 'text' => 'Some text',
218 $api = new ApiMain( $req );
222 public function testSetupModuleInvalidTokenProvided() {
223 $this->setExpectedException( ApiUsageException
::class, 'Invalid CSRF token.' );
225 $req = new FauxRequest( [
227 'title' => 'New page',
228 'text' => 'Some text',
229 'token' => "This isn't a real token!",
231 $api = new ApiMain( $req );
235 public function testSetupModuleNeedsTokenTrue() {
236 $this->setExpectedException( MWException
::class,
237 "Module 'testmodule' must be updated for the new token handling. " .
238 "See documentation for ApiBase::needsToken for details." );
240 $mock = $this->createMock( ApiBase
::class );
241 $mock->method( 'getModuleName' )->willReturn( 'testmodule' );
242 $mock->method( 'needsToken' )->willReturn( true );
244 $api = new ApiMain( new FauxRequest( [ 'action' => 'testmodule' ] ) );
245 $api->getModuleManager()->addModule( 'testmodule', 'action', get_class( $mock ),
246 function () use ( $mock ) {
253 public function testSetupModuleNeedsTokenNeedntBePosted() {
254 $this->setExpectedException( MWException
::class,
255 "Module 'testmodule' must require POST to use tokens." );
257 $mock = $this->createMock( ApiBase
::class );
258 $mock->method( 'getModuleName' )->willReturn( 'testmodule' );
259 $mock->method( 'needsToken' )->willReturn( 'csrf' );
260 $mock->method( 'mustBePosted' )->willReturn( false );
262 $api = new ApiMain( new FauxRequest( [ 'action' => 'testmodule' ] ) );
263 $api->getModuleManager()->addModule( 'testmodule', 'action', get_class( $mock ),
264 function () use ( $mock ) {
271 public function testCheckMaxLagFailed() {
272 // It's hard to mock the LoadBalancer properly, so instead we'll mock
273 // checkMaxLag (which is tested directly in other tests below).
274 $req = new FauxRequest( [
276 'meta' => 'siteinfo',
279 $mock = $this->getMockBuilder( ApiMain
::class )
280 ->setConstructorArgs( [ $req ] )
281 ->setMethods( [ 'checkMaxLag' ] )
283 $mock->method( 'checkMaxLag' )->willReturn( false );
287 $this->assertArrayNotHasKey( 'query', $mock->getResult()->getResultData() );
290 public function testCheckConditionalRequestHeadersFailed() {
291 // The detailed checking of all cases of checkConditionalRequestHeaders
292 // is below in testCheckConditionalRequestHeaders(), which calls the
293 // method directly. Here we just check that it will stop execution if
297 $this->setMwGlobals( 'wgCacheEpoch', '20030516000000' );
299 $mock = $this->createMock( ApiBase
::class );
300 $mock->method( 'getModuleName' )->willReturn( 'testmodule' );
301 $mock->method( 'getConditionalRequestData' )
302 ->willReturn( wfTimestamp( TS_MW
, $now - 3600 ) );
303 $mock->expects( $this->exactly( 0 ) )->method( 'execute' );
305 $req = new FauxRequest( [
306 'action' => 'testmodule',
308 $req->setHeader( 'If-Modified-Since', wfTimestamp( TS_RFC2822
, $now - 3600 ) );
309 $req->setRequestURL( "http://localhost" );
311 $api = new ApiMain( $req );
312 $api->getModuleManager()->addModule( 'testmodule', 'action', get_class( $mock ),
313 function () use ( $mock ) {
318 $wrapper = TestingAccessWrapper
::newFromObject( $api );
319 $wrapper->mInternalMode
= false;
326 private function doTestCheckMaxLag( $lag ) {
327 $mockLB = $this->getMockBuilder( LoadBalancer
::class )
328 ->disableOriginalConstructor()
329 ->setMethods( [ 'getMaxLag', '__destruct' ] )
331 $mockLB->method( 'getMaxLag' )->willReturn( [ 'somehost', $lag ] );
332 $this->setService( 'DBLoadBalancer', $mockLB );
334 $req = new FauxRequest();
336 $api = new ApiMain( $req );
337 $wrapper = TestingAccessWrapper
::newFromObject( $api );
339 $mockModule = $this->createMock( ApiBase
::class );
340 $mockModule->method( 'shouldCheckMaxLag' )->willReturn( true );
343 $wrapper->checkMaxLag( $mockModule, [ 'maxlag' => 3 ] );
346 $this->assertSame( '5', $req->response()->getHeader( 'Retry-After' ) );
347 $this->assertSame( (string)$lag, $req->response()->getHeader( 'X-Database-Lag' ) );
352 public function testCheckMaxLagOkay() {
353 $this->doTestCheckMaxLag( 3 );
355 // No exception, we're happy
356 $this->assertTrue( true );
359 public function testCheckMaxLagExceeded() {
360 $this->setExpectedException( ApiUsageException
::class,
361 'Waiting for a database server: 4 seconds lagged.' );
363 $this->setMwGlobals( 'wgShowHostnames', false );
365 $this->doTestCheckMaxLag( 4 );
368 public function testCheckMaxLagExceededWithHostNames() {
369 $this->setExpectedException( ApiUsageException
::class,
370 'Waiting for somehost: 4 seconds lagged.' );
372 $this->setMwGlobals( 'wgShowHostnames', true );
374 $this->doTestCheckMaxLag( 4 );
377 public static function provideAssert() {
379 [ false, [], 'user', 'assertuserfailed' ],
380 [ true, [], 'user', false ],
381 [ true, [], 'bot', 'assertbotfailed' ],
382 [ true, [ 'bot' ], 'user', false ],
383 [ true, [ 'bot' ], 'bot', false ],
388 * Tests the assert={user|bot} functionality
390 * @dataProvider provideAssert
391 * @param bool $registered
392 * @param array $rights
393 * @param string $assert
394 * @param string|bool $error False if no error expected
396 public function testAssert( $registered, $rights, $assert, $error ) {
398 $user = $this->getMutableTestUser()->getUser();
399 $user->load(); // load before setting mRights
403 $user->mRights
= $rights;
405 $this->doApiRequest( [
408 ], null, null, $user );
409 $this->assertFalse( $error ); // That no error was expected
410 } catch ( ApiUsageException
$e ) {
411 $this->assertTrue( self
::apiExceptionHasCode( $e, $error ),
412 "Error '{$e->getMessage()}' matched expected '$error'" );
417 * Tests the assertuser= functionality
419 public function testAssertUser() {
420 $user = $this->getTestUser()->getUser();
421 $this->doApiRequest( [
423 'assertuser' => $user->getName(),
424 ], null, null, $user );
427 $this->doApiRequest( [
429 'assertuser' => $user->getName() . 'X',
430 ], null, null, $user );
431 $this->fail( 'Expected exception not thrown' );
432 } catch ( ApiUsageException
$e ) {
433 $this->assertTrue( self
::apiExceptionHasCode( $e, 'assertnameduserfailed' ) );
438 * Test that 'assert' is processed before module errors
440 public function testAssertBeforeModule() {
441 // Sanity check that the query without assert throws too-many-titles
443 $this->doApiRequest( [
445 'titles' => implode( '|', range( 1, ApiBase
::LIMIT_SML1 +
1 ) ),
446 ], null, null, new User
);
447 $this->fail( 'Expected exception not thrown' );
448 } catch ( ApiUsageException
$e ) {
449 $this->assertTrue( self
::apiExceptionHasCode( $e, 'too-many-titles' ), 'sanity check' );
452 // Now test that the assert happens first
454 $this->doApiRequest( [
456 'titles' => implode( '|', range( 1, ApiBase
::LIMIT_SML1 +
1 ) ),
458 ], null, null, new User
);
459 $this->fail( 'Expected exception not thrown' );
460 } catch ( ApiUsageException
$e ) {
461 $this->assertTrue( self
::apiExceptionHasCode( $e, 'assertuserfailed' ),
462 "Error '{$e->getMessage()}' matched expected 'assertuserfailed'" );
467 * Test if all classes in the main module manager exists
469 public function testClassNamesInModuleManager() {
471 new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] )
473 $modules = $api->getModuleManager()->getNamesWithClasses();
475 foreach ( $modules as $name => $class ) {
477 class_exists( $class ),
478 'Class ' . $class . ' for api module ' . $name . ' does not exist (with exact case)'
484 * Test HTTP precondition headers
486 * @dataProvider provideCheckConditionalRequestHeaders
487 * @param array $headers HTTP headers
488 * @param array $conditions Return data for ApiBase::getConditionalRequestData
489 * @param int $status Expected response status
490 * @param array $options Array of options:
491 * post => true Request is a POST
492 * cdn => true CDN is enabled ($wgUseSquid)
494 public function testCheckConditionalRequestHeaders(
495 $headers, $conditions, $status, $options = []
497 $request = new FauxRequest(
498 [ 'action' => 'query', 'meta' => 'siteinfo' ],
499 !empty( $options['post'] )
501 $request->setHeaders( $headers );
502 $request->response()->statusHeader( 200 ); // Why doesn't it default?
504 $context = $this->apiContext
->newTestContext( $request, null );
505 $api = new ApiMain( $context );
506 $priv = TestingAccessWrapper
::newFromObject( $api );
507 $priv->mInternalMode
= false;
509 if ( !empty( $options['cdn'] ) ) {
510 $this->setMwGlobals( 'wgUseSquid', true );
513 // Can't do this in TestSetup.php because Setup.php will override it
514 $this->setMwGlobals( 'wgCacheEpoch', '20030516000000' );
516 $module = $this->getMockBuilder( ApiBase
::class )
517 ->setConstructorArgs( [ $api, 'mock' ] )
518 ->setMethods( [ 'getConditionalRequestData' ] )
519 ->getMockForAbstractClass();
520 $module->expects( $this->any() )
521 ->method( 'getConditionalRequestData' )
522 ->will( $this->returnCallback( function ( $condition ) use ( $conditions ) {
523 return $conditions[$condition] ??
null;
526 $ret = $priv->checkConditionalRequestHeaders( $module );
528 $this->assertSame( $status, $request->response()->getStatusCode() );
529 $this->assertSame( $status === 200, $ret );
532 public static function provideCheckConditionalRequestHeaders() {
533 global $wgSquidMaxage;
537 // Non-existing from module is ignored
538 'If-None-Match' => [ [ 'If-None-Match' => '"foo", "bar"' ], [], 200 ],
539 'If-Modified-Since' =>
540 [ [ 'If-Modified-Since' => 'Tue, 18 Aug 2015 00:00:00 GMT' ], [], 200 ],
543 'No headers' => [ [], [ 'etag' => '""', 'last-modified' => '20150815000000', ], 200 ],
545 // Basic If-None-Match
546 'If-None-Match with matching etag' =>
547 [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"bar"' ], 304 ],
548 'If-None-Match with non-matching etag' =>
549 [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"baz"' ], 200 ],
550 'Strong If-None-Match with weak matching etag' =>
551 [ [ 'If-None-Match' => '"foo"' ], [ 'etag' => 'W/"foo"' ], 304 ],
552 'Weak If-None-Match with strong matching etag' =>
553 [ [ 'If-None-Match' => 'W/"foo"' ], [ 'etag' => '"foo"' ], 304 ],
554 'Weak If-None-Match with weak matching etag' =>
555 [ [ 'If-None-Match' => 'W/"foo"' ], [ 'etag' => 'W/"foo"' ], 304 ],
557 // Pointless for GET, but supported
558 'If-None-Match: *' => [ [ 'If-None-Match' => '*' ], [], 304 ],
560 // Basic If-Modified-Since
561 'If-Modified-Since, modified one second earlier' =>
562 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) ],
563 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 304 ],
564 'If-Modified-Since, modified now' =>
565 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) ],
566 [ 'last-modified' => wfTimestamp( TS_MW
, $now ) ], 304 ],
567 'If-Modified-Since, modified one second later' =>
568 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) ],
569 [ 'last-modified' => wfTimestamp( TS_MW
, $now +
1 ) ], 200 ],
571 // If-Modified-Since ignored when If-None-Match is given too
572 'Non-matching If-None-Match and matching If-Modified-Since' =>
573 [ [ 'If-None-Match' => '""',
574 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) ],
575 [ 'etag' => '"x"', 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 200 ],
576 'Non-matching If-None-Match and matching If-Modified-Since with no ETag' =>
579 'If-None-Match' => '""',
580 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now )
582 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ],
587 'Matching If-None-Match with POST' =>
588 [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"bar"' ], 200,
589 [ 'post' => true ] ],
590 'Matching If-Modified-Since with POST' =>
591 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) ],
592 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 200,
593 [ 'post' => true ] ],
595 // Other date formats allowed by the RFC
596 'If-Modified-Since with alternate date format 1' =>
597 [ [ 'If-Modified-Since' => gmdate( 'l, d-M-y H:i:s', $now ) . ' GMT' ],
598 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 304 ],
599 'If-Modified-Since with alternate date format 2' =>
600 [ [ 'If-Modified-Since' => gmdate( 'D M j H:i:s Y', $now ) ],
601 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 304 ],
603 // Old browser extension to HTTP/1.0
604 'If-Modified-Since with length' =>
605 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now ) . '; length=123' ],
606 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 304 ],
608 // Invalid date formats should be ignored
609 'If-Modified-Since with invalid date format' =>
610 [ [ 'If-Modified-Since' => gmdate( 'Y-m-d H:i:s', $now ) . ' GMT' ],
611 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 200 ],
612 'If-Modified-Since with entirely unparseable date' =>
613 [ [ 'If-Modified-Since' => 'a potato' ],
614 [ 'last-modified' => wfTimestamp( TS_MW
, $now - 1 ) ], 200 ],
616 // Anything before $wgSquidMaxage seconds ago should be considered
618 'If-Modified-Since with CDN post-expiry' =>
619 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now - $wgSquidMaxage * 2 ) ],
620 [ 'last-modified' => wfTimestamp( TS_MW
, $now - $wgSquidMaxage * 3 ) ],
621 200, [ 'cdn' => true ] ],
622 'If-Modified-Since with CDN pre-expiry' =>
623 [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822
, $now - $wgSquidMaxage / 2 ) ],
624 [ 'last-modified' => wfTimestamp( TS_MW
, $now - $wgSquidMaxage * 3 ) ],
625 304, [ 'cdn' => true ] ],
630 * Test conditional headers output
631 * @dataProvider provideConditionalRequestHeadersOutput
632 * @param array $conditions Return data for ApiBase::getConditionalRequestData
633 * @param array $headers Expected output headers
634 * @param bool $isError $isError flag
635 * @param bool $post Request is a POST
637 public function testConditionalRequestHeadersOutput(
638 $conditions, $headers, $isError = false, $post = false
640 $request = new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ], $post );
641 $response = $request->response();
643 $api = new ApiMain( $request );
644 $priv = TestingAccessWrapper
::newFromObject( $api );
645 $priv->mInternalMode
= false;
647 $module = $this->getMockBuilder( ApiBase
::class )
648 ->setConstructorArgs( [ $api, 'mock' ] )
649 ->setMethods( [ 'getConditionalRequestData' ] )
650 ->getMockForAbstractClass();
651 $module->expects( $this->any() )
652 ->method( 'getConditionalRequestData' )
653 ->will( $this->returnCallback( function ( $condition ) use ( $conditions ) {
654 return $conditions[$condition] ??
null;
656 $priv->mModule
= $module;
658 $priv->sendCacheHeaders( $isError );
660 foreach ( [ 'Last-Modified', 'ETag' ] as $header ) {
662 $headers[$header] ??
null,
663 $response->getHeader( $header ),
669 public static function provideConditionalRequestHeadersOutput() {
676 [ 'etag' => '"foo"' ],
677 [ 'ETag' => '"foo"' ]
680 [ 'last-modified' => '20150818000102' ],
681 [ 'Last-Modified' => 'Tue, 18 Aug 2015 00:01:02 GMT' ]
684 [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
685 [ 'ETag' => '"foo"', 'Last-Modified' => 'Tue, 18 Aug 2015 00:01:02 GMT' ]
688 [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
693 [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
701 public function testCheckExecutePermissionsReadProhibited() {
702 $this->setExpectedException( ApiUsageException
::class,
703 'You need read permission to use this module.' );
705 $this->setGroupPermissions( '*', 'read', false );
707 $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) );
711 public function testCheckExecutePermissionWriteDisabled() {
712 $this->setExpectedException( ApiUsageException
::class,
713 'Editing of this wiki through the API is disabled. Make sure the ' .
714 '"$wgEnableWriteAPI=true;" statement is included in the wiki\'s ' .
715 '"LocalSettings.php" file.' );
716 $main = new ApiMain( new FauxRequest( [
718 'title' => 'Some page',
719 'text' => 'Some text',
725 public function testCheckExecutePermissionWriteApiProhibited() {
726 $this->setExpectedException( ApiUsageException
::class,
727 "You're not allowed to edit this wiki through the API." );
728 $this->setGroupPermissions( '*', 'writeapi', false );
730 $main = new ApiMain( new FauxRequest( [
732 'title' => 'Some page',
733 'text' => 'Some text',
735 ] ), /* enableWrite = */ true );
739 public function testCheckExecutePermissionPromiseNonWrite() {
740 $this->setExpectedException( ApiUsageException
::class,
741 'The "Promise-Non-Write-API-Action" HTTP header cannot be sent ' .
742 'to write-mode API modules.' );
744 $req = new FauxRequest( [
746 'title' => 'Some page',
747 'text' => 'Some text',
750 $req->setHeaders( [ 'Promise-Non-Write-API-Action' => '1' ] );
751 $main = new ApiMain( $req, /* enableWrite = */ true );
755 public function testCheckExecutePermissionHookAbort() {
756 $this->setExpectedException( ApiUsageException
::class, 'Main Page' );
758 $this->setTemporaryHook( 'ApiCheckCanExecute', function ( $unused1, $unused2, &$message ) {
759 $message = 'mainpage';
763 $main = new ApiMain( new FauxRequest( [
765 'title' => 'Some page',
766 'text' => 'Some text',
768 ] ), /* enableWrite = */ true );
772 public function testGetValUnsupportedArray() {
773 $main = new ApiMain( new FauxRequest( [
775 'meta' => 'siteinfo',
776 'siprop' => [ 'general', 'namespaces' ],
778 $this->assertSame( 'myDefault', $main->getVal( 'siprop', 'myDefault' ) );
780 $this->assertSame( 'Parameter "siprop" uses unsupported PHP array syntax.',
781 $main->getResult()->getResultData()['warnings']['main']['warnings'] );
784 public function testReportUnusedParams() {
785 $main = new ApiMain( new FauxRequest( [
787 'meta' => 'siteinfo',
788 'unusedparam' => 'unusedval',
789 'anotherunusedparam' => 'anotherval',
792 $this->assertSame( 'Unrecognized parameters: unusedparam, anotherunusedparam.',
793 $main->getResult()->getResultData()['warnings']['main']['warnings'] );
796 public function testLacksSameOriginSecurity() {
798 $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) );
799 $this->assertFalse( $main->lacksSameOriginSecurity(), 'Basic test, should have security' );
803 new FauxRequest( [ 'action' => 'query', 'format' => 'xml', 'callback' => 'foo' ] )
805 $this->assertTrue( $main->lacksSameOriginSecurity(), 'JSONp, should lack security' );
808 $request = new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] );
809 $request->setHeader( 'TrEaT-As-UnTrUsTeD', '' ); // With falsey value!
810 $main = new ApiMain( $request );
811 $this->assertTrue( $main->lacksSameOriginSecurity(), 'Header supplied, should lack security' );
814 $this->mergeMwGlobalArrayValue( 'wgHooks', [
815 'RequestHasSameOriginSecurity' => [ function () {
819 $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) );
820 $this->assertTrue( $main->lacksSameOriginSecurity(), 'Hook, should lack security' );
824 * Test proper creation of the ApiErrorFormatter
826 * @dataProvider provideApiErrorFormatterCreation
827 * @param array $request Request parameters
828 * @param array $expect Expected data
829 * - uselang: ApiMain language
830 * - class: ApiErrorFormatter class
831 * - lang: ApiErrorFormatter language
832 * - format: ApiErrorFormatter format
833 * - usedb: ApiErrorFormatter use-database flag
835 public function testApiErrorFormatterCreation( array $request, array $expect ) {
836 $context = new RequestContext();
837 $context->setRequest( new FauxRequest( $request ) );
838 $context->setLanguage( 'ru' );
840 $main = new ApiMain( $context );
841 $formatter = $main->getErrorFormatter();
842 $wrappedFormatter = TestingAccessWrapper
::newFromObject( $formatter );
844 $this->assertSame( $expect['uselang'], $main->getLanguage()->getCode() );
845 $this->assertInstanceOf( $expect['class'], $formatter );
846 $this->assertSame( $expect['lang'], $formatter->getLanguage()->getCode() );
847 $this->assertSame( $expect['format'], $wrappedFormatter->format
);
848 $this->assertSame( $expect['usedb'], $wrappedFormatter->useDB
);
851 public static function provideApiErrorFormatterCreation() {
853 'Default (BC)' => [ [], [
855 'class' => ApiErrorFormatter_BackCompat
::class,
860 'BC ignores fields' => [ [ 'errorlang' => 'de', 'errorsuselocal' => 1 ], [
862 'class' => ApiErrorFormatter_BackCompat
::class,
867 'Explicit BC' => [ [ 'errorformat' => 'bc' ], [
869 'class' => ApiErrorFormatter_BackCompat
::class,
874 'Basic' => [ [ 'errorformat' => 'wikitext' ], [
876 'class' => ApiErrorFormatter
::class,
878 'format' => 'wikitext',
881 'Follows uselang' => [ [ 'uselang' => 'fr', 'errorformat' => 'plaintext' ], [
883 'class' => ApiErrorFormatter
::class,
885 'format' => 'plaintext',
888 'Explicitly follows uselang' => [
889 [ 'uselang' => 'fr', 'errorlang' => 'uselang', 'errorformat' => 'plaintext' ],
892 'class' => ApiErrorFormatter
::class,
894 'format' => 'plaintext',
898 'uselang=content' => [
899 [ 'uselang' => 'content', 'errorformat' => 'plaintext' ],
902 'class' => ApiErrorFormatter
::class,
904 'format' => 'plaintext',
908 'errorlang=content' => [
909 [ 'errorlang' => 'content', 'errorformat' => 'plaintext' ],
912 'class' => ApiErrorFormatter
::class,
914 'format' => 'plaintext',
918 'Explicit parameters' => [
919 [ 'errorlang' => 'de', 'errorformat' => 'html', 'errorsuselocal' => 1 ],
922 'class' => ApiErrorFormatter
::class,
928 'Explicit parameters override uselang' => [
929 [ 'errorlang' => 'de', 'uselang' => 'fr', 'errorformat' => 'raw' ],
932 'class' => ApiErrorFormatter
::class,
938 'Bogus language doesn\'t explode' => [
939 [ 'errorlang' => '<bogus1>', 'uselang' => '<bogus2>', 'errorformat' => 'none' ],
942 'class' => ApiErrorFormatter
::class,
948 'Bogus format doesn\'t explode' => [ [ 'errorformat' => 'bogus' ], [
950 'class' => ApiErrorFormatter_BackCompat
::class,
959 * @dataProvider provideExceptionErrors
960 * @param Exception $exception
961 * @param array $expectReturn
962 * @param array $expectResult
964 public function testExceptionErrors( $error, $expectReturn, $expectResult ) {
965 $context = new RequestContext();
966 $context->setRequest( new FauxRequest( [ 'errorformat' => 'plaintext' ] ) );
967 $context->setLanguage( 'en' );
968 $context->setConfig( new MultiConfig( [
970 'ShowHostnames' => true, 'ShowExceptionDetails' => true,
972 $context->getConfig()
975 $main = new ApiMain( $context );
976 $main->addWarning( new RawMessage( 'existing warning' ), 'existing-warning' );
977 $main->addError( new RawMessage( 'existing error' ), 'existing-error' );
979 $ret = TestingAccessWrapper
::newFromObject( $main )->substituteResultWithError( $error );
980 $this->assertSame( $expectReturn, $ret );
982 // PHPUnit sometimes adds some SplObjectStorage garbage to the arrays,
983 // so let's try ->assertEquals().
986 $main->getResult()->getResultData( [], [ 'Strip' => 'all' ] )
990 // Not static so $this can be used
991 public function provideExceptionErrors() {
992 $reqId = WebRequest
::getRequestId();
993 $doclink = wfExpandUrl( wfScript( 'api' ) );
995 $ex = new InvalidArgumentException( 'Random exception' );
996 $trace = wfMessage( 'api-exception-trace',
1000 MWExceptionHandler
::getRedactedTraceAsString( $ex )
1001 )->inLanguage( 'en' )->useDatabase( false )->text();
1003 $dbex = new DBQueryError(
1004 $this->createMock( \Wikimedia\Rdbms\IDatabase
::class ),
1005 'error', 1234, 'SELECT 1', __METHOD__
);
1006 $dbtrace = wfMessage( 'api-exception-trace',
1010 MWExceptionHandler
::getRedactedTraceAsString( $dbex )
1011 )->inLanguage( 'en' )->useDatabase( false )->text();
1013 $apiEx1 = new ApiUsageException( null,
1014 StatusValue
::newFatal( new ApiRawMessage( 'An error', 'sv-error1' ) ) );
1015 TestingAccessWrapper
::newFromObject( $apiEx1 )->modulePath
= 'foo+bar';
1016 $apiEx1->getStatusValue()->warning( new ApiRawMessage( 'A warning', 'sv-warn1' ) );
1017 $apiEx1->getStatusValue()->warning( new ApiRawMessage( 'Another warning', 'sv-warn2' ) );
1018 $apiEx1->getStatusValue()->fatal( new ApiRawMessage( 'Another error', 'sv-error2' ) );
1023 [ 'existing-error', 'internal_api_error_InvalidArgumentException' ],
1026 [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ],
1029 [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ],
1031 'code' => 'internal_api_error_InvalidArgumentException',
1032 'text' => "[$reqId] Exception caught: Random exception",
1036 'servedby' => wfHostname(),
1041 [ 'existing-error', 'internal_api_error_DBQueryError' ],
1044 [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ],
1047 [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ],
1049 'code' => 'internal_api_error_DBQueryError',
1050 'text' => "[$reqId] Exception caught: A database query error has occurred. " .
1051 "This may indicate a bug in the software.",
1054 'trace' => $dbtrace,
1055 'servedby' => wfHostname(),
1060 [ 'existing-error', 'sv-error1', 'sv-error2' ],
1063 [ 'code' => 'existing-warning', 'text' => 'existing warning', 'module' => 'main' ],
1064 [ 'code' => 'sv-warn1', 'text' => 'A warning', 'module' => 'foo+bar' ],
1065 [ 'code' => 'sv-warn2', 'text' => 'Another warning', 'module' => 'foo+bar' ],
1068 [ 'code' => 'existing-error', 'text' => 'existing error', 'module' => 'main' ],
1069 [ 'code' => 'sv-error1', 'text' => 'An error', 'module' => 'foo+bar' ],
1070 [ 'code' => 'sv-error2', 'text' => 'Another error', 'module' => 'foo+bar' ],
1072 'docref' => "See $doclink for API usage. Subscribe to the mediawiki-api-announce mailing " .
1073 "list at <https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce> " .
1074 "for notice of API deprecations and breaking changes.",
1075 'servedby' => wfHostname(),
1081 public function testPrinterParameterValidationError() {
1082 $api = $this->getNonInternalApiMain( [
1083 'action' => 'query', 'meta' => 'siteinfo', 'format' => 'json', 'formatversion' => 'bogus',
1088 $txt = ob_get_clean();
1090 // Test that the actual output is valid JSON, not just the format of the ApiResult.
1091 $data = FormatJson
::decode( $txt, true );
1092 $this->assertInternalType( 'array', $data );
1093 $this->assertArrayHasKey( 'error', $data );
1094 $this->assertArrayHasKey( 'code', $data['error'] );
1095 $this->assertSame( 'unknown_formatversion', $data['error']['code'] );