MediaWiki  master
ApiParseTest.php
Go to the documentation of this file.
1 <?php
2 
10 class ApiParseTest extends ApiTestCase {
11 
12  protected static $pageId;
13  protected static $revIds = [];
14 
15  public function addDBDataOnce() {
16  $title = Title::newFromText( __CLASS__ );
17 
18  $status = $this->editPage( __CLASS__, 'Test for revdel' );
19  self::$pageId = $status->value['revision']->getPage();
20  self::$revIds['revdel'] = $status->value['revision']->getId();
21 
22  $status = $this->editPage( __CLASS__, 'Test for suppressed' );
23  self::$revIds['suppressed'] = $status->value['revision']->getId();
24 
25  $status = $this->editPage( __CLASS__, 'Test for oldid' );
26  self::$revIds['oldid'] = $status->value['revision']->getId();
27 
28  $status = $this->editPage( __CLASS__, 'Test for latest' );
29  self::$revIds['latest'] = $status->value['revision']->getId();
30 
31  $this->revisionDelete( self::$revIds['revdel'] );
32  $this->revisionDelete(
33  self::$revIds['suppressed'],
35  );
36 
37  Title::clearCaches(); // Otherwise it has the wrong latest revision for some reason
38  }
39 
51  protected function assertParsedTo( $expected, array $res, $warnings = null ) {
52  $this->doAssertParsedTo( $expected, $res, $warnings, [ $this, 'assertSame' ] );
53  }
54 
64  protected function assertParsedToRegExp( $expected, array $res, $warnings = null ) {
65  $this->doAssertParsedTo( $expected, $res, $warnings, [ $this, 'assertRegExp' ] );
66  }
67 
68  private function doAssertParsedTo( $expected, array $res, $warnings, callable $callback ) {
69  $html = $res[0]['parse']['text'];
70 
71  $expectedStart = '<div class="mw-parser-output">';
72  $this->assertSame( $expectedStart, substr( $html, 0, strlen( $expectedStart ) ) );
73 
74  $html = substr( $html, strlen( $expectedStart ) );
75 
76  if ( $res[1]->getBool( 'disablelimitreport' ) ) {
77  $expectedEnd = "</div>";
78  $this->assertSame( $expectedEnd, substr( $html, -strlen( $expectedEnd ) ) );
79 
80  $unexpectedEnd = '#<!-- \nNewPP limit report|' .
81  '<!--\nTransclusion expansion time report#s';
82  $this->assertNotRegExp( $unexpectedEnd, $html );
83 
84  $html = substr( $html, 0, strlen( $html ) - strlen( $expectedEnd ) );
85  } else {
86  $expectedEnd = '#\n<!-- \nNewPP limit report\n(?>.+?\n-->)\n' .
87  '<!--\nTransclusion expansion time report \(%,ms,calls,template\)\n(?>.*?\n-->)\n' .
88  '(\n<!-- Saved in parser cache (?>.*?\n -->)\n)?</div>$#s';
89  $this->assertRegExp( $expectedEnd, $html );
90 
91  $html = preg_replace( $expectedEnd, '', $html );
92  }
93 
94  call_user_func( $callback, $expected, $html );
95 
96  if ( $warnings === null ) {
97  $this->assertCount( 1, $res[0] );
98  } else {
99  $this->assertCount( 2, $res[0] );
100  $this->assertSame( [ 'warnings' => $warnings ], $res[0]['warnings']['parse'] );
101  }
102  }
103 
107  protected function setupInterwiki() {
108  $dbw = wfGetDB( DB_MASTER );
109  $dbw->insert(
110  'interwiki',
111  [
112  'iw_prefix' => 'madeuplanguage',
113  'iw_url' => "https://example.com/wiki/$1",
114  'iw_api' => '',
115  'iw_wikiid' => '',
116  'iw_local' => false,
117  ],
118  __METHOD__,
119  'IGNORE'
120  );
121 
122  $this->setMwGlobals( 'wgExtraInterlanguageLinkPrefixes', [ 'madeuplanguage' ] );
123  $this->tablesUsed[] = 'interwiki';
124  }
125 
131  protected function setupSkin() {
132  $factory = new SkinFactory();
133  $factory->register( 'testing', 'Testing', function () {
134  $skin = $this->getMockBuilder( SkinFallback::class )
135  ->setMethods( [ 'getDefaultModules', 'setupSkinUserCss' ] )
136  ->getMock();
137  $skin->expects( $this->once() )->method( 'getDefaultModules' )
138  ->willReturn( [
139  'styles' => [ 'core' => [ 'quux.styles' ] ],
140  'core' => [ 'foo', 'bar' ],
141  'content' => [ 'baz' ]
142  ] );
143  $skin->expects( $this->once() )->method( 'setupSkinUserCss' )
144  ->will( $this->returnCallback( function ( OutputPage $out ) {
145  $out->addModuleStyles( 'foo.styles' );
146  } ) );
147  return $skin;
148  } );
149  $this->setService( 'SkinFactory', $factory );
150  }
151 
152  public function testParseByName() {
153  $res = $this->doApiRequest( [
154  'action' => 'parse',
155  'page' => __CLASS__,
156  ] );
157  $this->assertParsedTo( "<p>Test for latest\n</p>", $res );
158 
159  $res = $this->doApiRequest( [
160  'action' => 'parse',
161  'page' => __CLASS__,
162  'disablelimitreport' => 1,
163  ] );
164  $this->assertParsedTo( "<p>Test for latest\n</p>", $res );
165  }
166 
167  public function testParseById() {
168  $res = $this->doApiRequest( [
169  'action' => 'parse',
170  'pageid' => self::$pageId,
171  ] );
172  $this->assertParsedTo( "<p>Test for latest\n</p>", $res );
173  }
174 
175  public function testParseByOldId() {
176  $res = $this->doApiRequest( [
177  'action' => 'parse',
178  'oldid' => self::$revIds['oldid'],
179  ] );
180  $this->assertParsedTo( "<p>Test for oldid\n</p>", $res );
181  $this->assertArrayNotHasKey( 'textdeleted', $res[0]['parse'] );
182  $this->assertArrayNotHasKey( 'textsuppressed', $res[0]['parse'] );
183  }
184 
185  public function testRevDel() {
186  $res = $this->doApiRequest( [
187  'action' => 'parse',
188  'oldid' => self::$revIds['revdel'],
189  ] );
190 
191  $this->assertParsedTo( "<p>Test for revdel\n</p>", $res );
192  $this->assertArrayHasKey( 'textdeleted', $res[0]['parse'] );
193  $this->assertArrayNotHasKey( 'textsuppressed', $res[0]['parse'] );
194  }
195 
196  public function testRevDelNoPermission() {
197  $this->setExpectedException( ApiUsageException::class,
198  "You don't have permission to view deleted revision text." );
199 
200  $this->doApiRequest( [
201  'action' => 'parse',
202  'oldid' => self::$revIds['revdel'],
203  ], null, null, static::getTestUser()->getUser() );
204  }
205 
206  public function testSuppressed() {
207  $this->setGroupPermissions( 'sysop', 'viewsuppressed', true );
208 
209  $res = $this->doApiRequest( [
210  'action' => 'parse',
211  'oldid' => self::$revIds['suppressed']
212  ] );
213 
214  $this->assertParsedTo( "<p>Test for suppressed\n</p>", $res );
215  $this->assertArrayHasKey( 'textsuppressed', $res[0]['parse'] );
216  $this->assertArrayHasKey( 'textdeleted', $res[0]['parse'] );
217  }
218 
219  public function testNonexistentPage() {
220  try {
221  $this->doApiRequest( [
222  'action' => 'parse',
223  'page' => 'DoesNotExist',
224  ] );
225 
226  $this->fail( "API did not return an error when parsing a nonexistent page" );
227  } catch ( ApiUsageException $ex ) {
228  $this->assertTrue( ApiTestCase::apiExceptionHasCode( $ex, 'missingtitle' ),
229  "Parse request for nonexistent page must give 'missingtitle' error: "
230  . var_export( self::getErrorFormatter()->arrayFromStatus( $ex->getStatusValue() ), true )
231  );
232  }
233  }
234 
235  public function testTitleProvided() {
236  $res = $this->doApiRequest( [
237  'action' => 'parse',
238  'title' => 'Some interesting page',
239  'text' => '{{PAGENAME}} has attracted my attention',
240  ] );
241 
242  $this->assertParsedTo( "<p>Some interesting page has attracted my attention\n</p>", $res );
243  }
244 
245  public function testSection() {
246  $name = ucfirst( __FUNCTION__ );
247 
248  $this->editPage( $name,
249  "Intro\n\n== Section 1 ==\n\nContent 1\n\n== Section 2 ==\n\nContent 2" );
250 
251  $res = $this->doApiRequest( [
252  'action' => 'parse',
253  'page' => $name,
254  'section' => 1,
255  ] );
256 
257  $this->assertParsedToRegExp( '!<h2>.*Section 1.*</h2>\n<p>Content 1\n</p>!', $res );
258  }
259 
260  public function testInvalidSection() {
261  $this->setExpectedException( ApiUsageException::class,
262  'The "section" parameter must be a valid section ID or "new".' );
263 
264  $this->doApiRequest( [
265  'action' => 'parse',
266  'section' => 'T-new',
267  ] );
268  }
269 
270  public function testSectionNoContent() {
271  $name = ucfirst( __FUNCTION__ );
272 
273  $status = $this->editPage( $name,
274  "Intro\n\n== Section 1 ==\n\nContent 1\n\n== Section 2 ==\n\nContent 2" );
275 
276  $this->setExpectedException( ApiUsageException::class,
277  "Missing content for page ID {$status->value['revision']->getPage()}." );
278 
279  $this->db->delete( 'revision', [ 'rev_id' => $status->value['revision']->getId() ] );
280 
281  // Suppress warning in WikiPage::getContentModel
282  Wikimedia\suppressWarnings();
283  try {
284  $this->doApiRequest( [
285  'action' => 'parse',
286  'page' => $name,
287  'section' => 1,
288  ] );
289  } finally {
290  Wikimedia\restoreWarnings();
291  }
292  }
293 
294  public function testNewSectionWithPage() {
295  $this->setExpectedException( ApiUsageException::class,
296  '"section=new" cannot be combined with the "oldid", "pageid" or "page" ' .
297  'parameters. Please use "title" and "text".' );
298 
299  $this->doApiRequest( [
300  'action' => 'parse',
301  'page' => __CLASS__,
302  'section' => 'new',
303  ] );
304  }
305 
306  public function testNonexistentOldId() {
307  $this->setExpectedException( ApiUsageException::class,
308  'There is no revision with ID 2147483647.' );
309 
310  $this->doApiRequest( [
311  'action' => 'parse',
312  'oldid' => pow( 2, 31 ) - 1,
313  ] );
314  }
315 
316  public function testUnfollowedRedirect() {
317  $name = ucfirst( __FUNCTION__ );
318 
319  $this->editPage( $name, "#REDIRECT [[$name 2]]" );
320  $this->editPage( "$name 2", "Some ''text''" );
321 
322  $res = $this->doApiRequest( [
323  'action' => 'parse',
324  'page' => $name,
325  ] );
326 
327  // Can't use assertParsedTo because the parser output is different for
328  // redirects
329  $this->assertRegExp( "/Redirect to:.*$name 2/", $res[0]['parse']['text'] );
330  $this->assertArrayNotHasKey( 'warnings', $res[0] );
331  }
332 
333  public function testFollowedRedirect() {
334  $name = ucfirst( __FUNCTION__ );
335 
336  $this->editPage( $name, "#REDIRECT [[$name 2]]" );
337  $this->editPage( "$name 2", "Some ''text''" );
338 
339  $res = $this->doApiRequest( [
340  'action' => 'parse',
341  'page' => $name,
342  'redirects' => true,
343  ] );
344 
345  $this->assertParsedTo( "<p>Some <i>text</i>\n</p>", $res );
346  }
347 
348  public function testFollowedRedirectById() {
349  $name = ucfirst( __FUNCTION__ );
350 
351  $id = $this->editPage( $name, "#REDIRECT [[$name 2]]" )->value['revision']->getPage();
352  $this->editPage( "$name 2", "Some ''text''" );
353 
354  $res = $this->doApiRequest( [
355  'action' => 'parse',
356  'pageid' => $id,
357  'redirects' => true,
358  ] );
359 
360  $this->assertParsedTo( "<p>Some <i>text</i>\n</p>", $res );
361  }
362 
363  public function testInvalidTitle() {
364  $this->setExpectedException( ApiUsageException::class, 'Bad title "|".' );
365 
366  $this->doApiRequest( [
367  'action' => 'parse',
368  'title' => '|',
369  ] );
370  }
371 
372  public function testTitleWithNonexistentRevId() {
373  $this->setExpectedException( ApiUsageException::class,
374  'There is no revision with ID 2147483647.' );
375 
376  $this->doApiRequest( [
377  'action' => 'parse',
378  'title' => __CLASS__,
379  'revid' => pow( 2, 31 ) - 1,
380  ] );
381  }
382 
383  public function testTitleWithNonMatchingRevId() {
384  $name = ucfirst( __FUNCTION__ );
385 
386  $res = $this->doApiRequest( [
387  'action' => 'parse',
388  'title' => $name,
389  'revid' => self::$revIds['latest'],
390  'text' => 'Some text',
391  ] );
392 
393  $this->assertParsedTo( "<p>Some text\n</p>", $res,
394  'r' . self::$revIds['latest'] . " is not a revision of $name." );
395  }
396 
397  public function testRevId() {
398  $res = $this->doApiRequest( [
399  'action' => 'parse',
400  'revid' => self::$revIds['latest'],
401  'text' => 'My revid is {{REVISIONID}}!',
402  ] );
403 
404  $this->assertParsedTo( "<p>My revid is " . self::$revIds['latest'] . "!\n</p>", $res );
405  }
406 
407  public function testTitleNoText() {
408  $res = $this->doApiRequest( [
409  'action' => 'parse',
410  'title' => 'Special:AllPages',
411  ] );
412 
413  $this->assertParsedTo( '', $res,
414  '"title" used without "text", and parsed page properties were requested. ' .
415  'Did you mean to use "page" instead of "title"?' );
416  }
417 
418  public function testRevidNoText() {
419  $res = $this->doApiRequest( [
420  'action' => 'parse',
421  'revid' => self::$revIds['latest'],
422  ] );
423 
424  $this->assertParsedTo( '', $res,
425  '"revid" used without "text", and parsed page properties were requested. ' .
426  'Did you mean to use "oldid" instead of "revid"?' );
427  }
428 
429  public function testTextNoContentModel() {
430  $res = $this->doApiRequest( [
431  'action' => 'parse',
432  'text' => "Some ''text''",
433  ] );
434 
435  $this->assertParsedTo( "<p>Some <i>text</i>\n</p>", $res,
436  'No "title" or "contentmodel" was given, assuming wikitext.' );
437  }
438 
439  public function testSerializationError() {
440  $this->setExpectedException( APIUsageException::class,
441  'Content serialization failed: Could not unserialize content' );
442 
443  $this->mergeMwGlobalArrayValue( 'wgContentHandlers',
444  [ 'testing-serialize-error' => 'DummySerializeErrorContentHandler' ] );
445 
446  $this->doApiRequest( [
447  'action' => 'parse',
448  'text' => "Some ''text''",
449  'contentmodel' => 'testing-serialize-error',
450  ] );
451  }
452 
453  public function testNewSection() {
454  $res = $this->doApiRequest( [
455  'action' => 'parse',
456  'title' => __CLASS__,
457  'section' => 'new',
458  'sectiontitle' => 'Title',
459  'text' => 'Content',
460  ] );
461 
462  $this->assertParsedToRegExp( '!<h2>.*Title.*</h2>\n<p>Content\n</p>!', $res );
463  }
464 
465  public function testExistingSection() {
466  $res = $this->doApiRequest( [
467  'action' => 'parse',
468  'title' => __CLASS__,
469  'section' => 1,
470  'text' => "Intro\n\n== Section 1 ==\n\nContent\n\n== Section 2 ==\n\nMore content",
471  ] );
472 
473  $this->assertParsedToRegExp( '!<h2>.*Section 1.*</h2>\n<p>Content\n</p>!', $res );
474  }
475 
476  public function testNoPst() {
477  $name = ucfirst( __FUNCTION__ );
478 
479  $this->editPage( "Template:$name", "Template ''text''" );
480 
481  $res = $this->doApiRequest( [
482  'action' => 'parse',
483  'text' => "{{subst:$name}}",
484  'contentmodel' => 'wikitext',
485  ] );
486 
487  $this->assertParsedTo( "<p>{{subst:$name}}\n</p>", $res );
488  }
489 
490  public function testPst() {
491  $name = ucfirst( __FUNCTION__ );
492 
493  $this->editPage( "Template:$name", "Template ''text''" );
494 
495  $res = $this->doApiRequest( [
496  'action' => 'parse',
497  'pst' => '',
498  'text' => "{{subst:$name}}",
499  'contentmodel' => 'wikitext',
500  'prop' => 'text|wikitext',
501  ] );
502 
503  $this->assertParsedTo( "<p>Template <i>text</i>\n</p>", $res );
504  $this->assertSame( "{{subst:$name}}", $res[0]['parse']['wikitext'] );
505  }
506 
507  public function testOnlyPst() {
508  $name = ucfirst( __FUNCTION__ );
509 
510  $this->editPage( "Template:$name", "Template ''text''" );
511 
512  $res = $this->doApiRequest( [
513  'action' => 'parse',
514  'onlypst' => '',
515  'text' => "{{subst:$name}}",
516  'contentmodel' => 'wikitext',
517  'prop' => 'text|wikitext',
518  'summary' => 'Summary',
519  ] );
520 
521  $this->assertSame(
522  [ 'parse' => [
523  'text' => "Template ''text''",
524  'wikitext' => "{{subst:$name}}",
525  'parsedsummary' => 'Summary',
526  ] ],
527  $res[0]
528  );
529  }
530 
531  public function testHeadHtml() {
532  $res = $this->doApiRequest( [
533  'action' => 'parse',
534  'page' => __CLASS__,
535  'prop' => 'headhtml',
536  ] );
537 
538  // Just do a rough sanity check
539  $this->assertRegExp( '#<!DOCTYPE.*<html.*<head.*</head>.*<body#s',
540  $res[0]['parse']['headhtml'] );
541  $this->assertArrayNotHasKey( 'warnings', $res[0] );
542  }
543 
544  public function testCategoriesHtml() {
545  $name = ucfirst( __FUNCTION__ );
546 
547  $this->editPage( $name, "[[Category:$name]]" );
548 
549  $res = $this->doApiRequest( [
550  'action' => 'parse',
551  'page' => $name,
552  'prop' => 'categorieshtml',
553  ] );
554 
555  $this->assertRegExp( "#Category.*Category:$name.*$name#",
556  $res[0]['parse']['categorieshtml'] );
557  $this->assertArrayNotHasKey( 'warnings', $res[0] );
558  }
559 
560  public function testEffectiveLangLinks() {
561  $hookRan = false;
562  $this->setTemporaryHook( 'LanguageLinks',
563  function () use ( &$hookRan ) {
564  $hookRan = true;
565  }
566  );
567 
568  $res = $this->doApiRequest( [
569  'action' => 'parse',
570  'title' => __CLASS__,
571  'text' => '[[zh:' . __CLASS__ . ']]',
572  'effectivelanglinks' => '',
573  ] );
574 
575  $this->assertTrue( $hookRan );
576  $this->assertSame( 'The parameter "effectivelanglinks" has been deprecated.',
577  $res[0]['warnings']['parse']['warnings'] );
578  }
579 
583  private function doTestLangLinks( array $arr = [] ) {
584  $this->setupInterwiki();
585 
586  $res = $this->doApiRequest( array_merge( [
587  'action' => 'parse',
588  'title' => 'Omelette',
589  'text' => '[[madeuplanguage:Omelette]]',
590  'prop' => 'langlinks',
591  ], $arr ) );
592 
593  $langLinks = $res[0]['parse']['langlinks'];
594 
595  $this->assertCount( 1, $langLinks );
596  $this->assertSame( 'madeuplanguage', $langLinks[0]['lang'] );
597  $this->assertSame( 'Omelette', $langLinks[0]['title'] );
598  $this->assertSame( 'https://example.com/wiki/Omelette', $langLinks[0]['url'] );
599  $this->assertArrayNotHasKey( 'warnings', $res[0] );
600  }
601 
602  public function testLangLinks() {
603  $this->doTestLangLinks();
604  }
605 
606  public function testLangLinksWithSkin() {
607  $this->setupSkin();
608  $this->doTestLangLinks( [ 'useskin' => 'testing' ] );
609  }
610 
611  public function testHeadItems() {
612  $res = $this->doApiRequest( [
613  'action' => 'parse',
614  'title' => __CLASS__,
615  'text' => '',
616  'prop' => 'headitems',
617  ] );
618 
619  $this->assertSame( [], $res[0]['parse']['headitems'] );
620  $this->assertSame(
621  '"prop=headitems" is deprecated since MediaWiki 1.28. ' .
622  'Use "prop=headhtml" when creating new HTML documents, ' .
623  'or "prop=modules|jsconfigvars" when updating a document client-side.',
624  $res[0]['warnings']['parse']['warnings']
625  );
626  }
627 
628  public function testHeadItemsWithSkin() {
629  $this->setupSkin();
630 
631  $res = $this->doApiRequest( [
632  'action' => 'parse',
633  'title' => __CLASS__,
634  'text' => '',
635  'prop' => 'headitems',
636  'useskin' => 'testing',
637  ] );
638 
639  $this->assertSame( [], $res[0]['parse']['headitems'] );
640  $this->assertSame(
641  '"prop=headitems" is deprecated since MediaWiki 1.28. ' .
642  'Use "prop=headhtml" when creating new HTML documents, ' .
643  'or "prop=modules|jsconfigvars" when updating a document client-side.',
644  $res[0]['warnings']['parse']['warnings']
645  );
646  }
647 
648  public function testModules() {
649  $this->setTemporaryHook( 'ParserAfterParse',
650  function ( $parser ) {
651  $output = $parser->getOutput();
652  $output->addModules( [ 'foo', 'bar' ] );
653  $output->addModuleStyles( [ 'aaa', 'zzz' ] );
654  $output->addJsConfigVars( [ 'x' => 'y', 'z' => -3 ] );
655  }
656  );
657  $res = $this->doApiRequest( [
658  'action' => 'parse',
659  'title' => __CLASS__,
660  'text' => 'Content',
661  'prop' => 'modules|jsconfigvars|encodedjsconfigvars',
662  ] );
663 
664  $this->assertSame( [ 'foo', 'bar' ], $res[0]['parse']['modules'] );
665  $this->assertSame( [], $res[0]['parse']['modulescripts'] );
666  $this->assertSame( [ 'aaa', 'zzz' ], $res[0]['parse']['modulestyles'] );
667  $this->assertSame( [ 'x' => 'y', 'z' => -3 ], $res[0]['parse']['jsconfigvars'] );
668  $this->assertSame( '{"x":"y","z":-3}', $res[0]['parse']['encodedjsconfigvars'] );
669  $this->assertArrayNotHasKey( 'warnings', $res[0] );
670  }
671 
672  public function testModulesWithSkin() {
673  $this->setupSkin();
674 
675  $res = $this->doApiRequest( [
676  'action' => 'parse',
677  'pageid' => self::$pageId,
678  'useskin' => 'testing',
679  'prop' => 'modules',
680  ] );
681  $this->assertSame(
682  [ 'foo', 'bar', 'baz' ],
683  $res[0]['parse']['modules'],
684  'resp.parse.modules'
685  );
686  $this->assertSame(
687  [],
688  $res[0]['parse']['modulescripts'],
689  'resp.parse.modulescripts'
690  );
691  $this->assertSame(
692  [ 'foo.styles', 'quux.styles' ],
693  $res[0]['parse']['modulestyles'],
694  'resp.parse.modulestyles'
695  );
696  $this->assertSame(
697  [ 'parse' =>
698  [ 'warnings' =>
699  'Property "modules" was set but not "jsconfigvars" or ' .
700  '"encodedjsconfigvars". Configuration variables are necessary for ' .
701  'proper module usage.'
702  ]
703  ],
704  $res[0]['warnings']
705  );
706  }
707 
708  public function testIndicators() {
709  $res = $this->doApiRequest( [
710  'action' => 'parse',
711  'title' => __CLASS__,
712  'text' =>
713  '<indicator name="b">BBB!</indicator>Some text<indicator name="a">aaa</indicator>',
714  'prop' => 'indicators',
715  ] );
716 
717  $this->assertSame(
718  // It seems we return in markup order and not display order
719  [ 'b' => 'BBB!', 'a' => 'aaa' ],
720  $res[0]['parse']['indicators']
721  );
722  $this->assertArrayNotHasKey( 'warnings', $res[0] );
723  }
724 
725  public function testIndicatorsWithSkin() {
726  $this->setupSkin();
727 
728  $res = $this->doApiRequest( [
729  'action' => 'parse',
730  'title' => __CLASS__,
731  'text' =>
732  '<indicator name="b">BBB!</indicator>Some text<indicator name="a">aaa</indicator>',
733  'prop' => 'indicators',
734  'useskin' => 'testing',
735  ] );
736 
737  $this->assertSame(
738  // Now we return in display order rather than markup order
739  [ 'a' => 'aaa', 'b' => 'BBB!' ],
740  $res[0]['parse']['indicators']
741  );
742  $this->assertArrayNotHasKey( 'warnings', $res[0] );
743  }
744 
745  public function testIwlinks() {
746  $this->setupInterwiki();
747 
748  $res = $this->doApiRequest( [
749  'action' => 'parse',
750  'title' => 'Omelette',
751  'text' => '[[:madeuplanguage:Omelette]][[madeuplanguage:Spaghetti]]',
752  'prop' => 'iwlinks',
753  ] );
754 
755  $iwlinks = $res[0]['parse']['iwlinks'];
756 
757  $this->assertCount( 1, $iwlinks );
758  $this->assertSame( 'madeuplanguage', $iwlinks[0]['prefix'] );
759  $this->assertSame( 'https://example.com/wiki/Omelette', $iwlinks[0]['url'] );
760  $this->assertSame( 'madeuplanguage:Omelette', $iwlinks[0]['title'] );
761  $this->assertArrayNotHasKey( 'warnings', $res[0] );
762  }
763 
764  public function testLimitReports() {
765  $res = $this->doApiRequest( [
766  'action' => 'parse',
767  'pageid' => self::$pageId,
768  'prop' => 'limitreportdata|limitreporthtml',
769  ] );
770 
771  // We don't bother testing the actual values here
772  $this->assertInternalType( 'array', $res[0]['parse']['limitreportdata'] );
773  $this->assertInternalType( 'string', $res[0]['parse']['limitreporthtml'] );
774  $this->assertArrayNotHasKey( 'warnings', $res[0] );
775  }
776 
777  public function testParseTreeNonWikitext() {
778  $this->setExpectedException( ApiUsageException::class,
779  '"prop=parsetree" is only supported for wikitext content.' );
780 
781  $this->doApiRequest( [
782  'action' => 'parse',
783  'text' => '',
784  'contentmodel' => 'json',
785  'prop' => 'parsetree',
786  ] );
787  }
788 
789  public function testParseTree() {
790  $res = $this->doApiRequest( [
791  'action' => 'parse',
792  'text' => "Some ''text'' is {{nice|to have|i=think}}",
793  'contentmodel' => 'wikitext',
794  'prop' => 'parsetree',
795  ] );
796 
797  // Preprocessor_DOM and Preprocessor_Hash give different results here,
798  // so we'll accept either
799  $this->assertRegExp(
800  '#^<root>Some \'\'text\'\' is <template><title>nice</title>' .
801  '<part><name index="1"/><value>to have</value></part>' .
802  '<part><name>i</name>(?:<equals>)?=(?:</equals>)?<value>think</value></part>' .
803  '</template></root>$#',
804  $res[0]['parse']['parsetree']
805  );
806  $this->assertArrayNotHasKey( 'warnings', $res[0] );
807  }
808 
809  public function testDisableTidy() {
810  $this->setMwGlobals( 'wgTidyConfig', [ 'driver' => 'RemexHtml' ] );
811 
812  // Check that disabletidy doesn't have an effect just because tidying
813  // doesn't work for some other reason
814  $res1 = $this->doApiRequest( [
815  'action' => 'parse',
816  'text' => "<b>Mixed <i>up</b></i>",
817  'contentmodel' => 'wikitext',
818  ] );
819  $this->assertParsedTo( "<p><b>Mixed <i>up</i></b>\n</p>", $res1 );
820 
821  $res2 = $this->doApiRequest( [
822  'action' => 'parse',
823  'text' => "<b>Mixed <i>up</b></i>",
824  'contentmodel' => 'wikitext',
825  'disabletidy' => '',
826  ] );
827 
828  $this->assertParsedTo( "<p><b>Mixed <i>up</b></i>\n</p>", $res2,
829  'The parameter "disabletidy" has been deprecated.' );
830  }
831 
832  public function testFormatCategories() {
833  $name = ucfirst( __FUNCTION__ );
834 
835  $this->editPage( "Category:$name", 'Content' );
836  $this->editPage( 'Category:Hidden', '__HIDDENCAT__' );
837 
838  $res = $this->doApiRequest( [
839  'action' => 'parse',
840  'title' => __CLASS__,
841  'text' => "[[Category:$name]][[Category:Foo|Sort me]][[Category:Hidden]]",
842  'prop' => 'categories',
843  ] );
844 
845  $this->assertSame(
846  [ [ 'sortkey' => '', 'category' => $name ],
847  [ 'sortkey' => 'Sort me', 'category' => 'Foo', 'missing' => true ],
848  [ 'sortkey' => '', 'category' => 'Hidden', 'hidden' => true ] ],
849  $res[0]['parse']['categories']
850  );
851  $this->assertArrayNotHasKey( 'warnings', $res[0] );
852  }
853 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
setupSkin()
Set up a skin for testing.
testTitleWithNonexistentRevId()
assertParsedTo( $expected, array $res, $warnings=null)
Assert that the given result of calling $this->doApiRequest() with action=parse resulted in $html...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1982
setTemporaryHook( $hookName, $handler)
Create a temporary hook handler which will be reset by tearDown.
static clearCaches()
Definition: Title.php:3126
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
assertParsedToRegExp( $expected, array $res, $warnings=null)
Same as above, but asserts that the HTML matches a regexp instead of a literal string match...
Exception used to abort API execution with an error.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
doApiRequest(array $params, array $session=null, $appendModule=false, User $user=null, $tokenType=null)
Does the API request and returns the result.
Definition: ApiTestCase.php:62
doTestLangLinks(array $arr=[])
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
const DB_MASTER
Definition: defines.php:26
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
setGroupPermissions( $newPerms, $newKey=null, $newValue=null)
Alters $wgGroupPermissions for the duration of the test.
editPage( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
Edits or creates a page/revision.
revisionDelete( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
Revision-deletes a revision.
$res
Definition: database.txt:21
const DELETED_RESTRICTED
Definition: Revision.php:49
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
addModuleStyles( $modules)
Load the styles of one or more ResourceLoader modules on this page.
Definition: OutputPage.php:582
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1982
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown...
static $pageId
const DELETED_TEXT
Definition: Revision.php:46
setService( $name, $object)
Sets a service, maintaining a stashed version of the previous service to be restored in tearDown...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
setupInterwiki()
Set up an interwiki entry for testing.
testTitleWithNonMatchingRevId()
doAssertParsedTo( $expected, array $res, $warnings, callable $callback)
testFollowedRedirectById()
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static $revIds
API Database medium.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
testParseTreeNonWikitext()
getStatusValue()
Fetch the error status.
static apiExceptionHasCode(ApiUsageException $ex, $code)
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319