MediaWiki  1.30.0
ParserTestRunner.php
Go to the documentation of this file.
1 <?php
30 use Wikimedia\ScopedCallback;
31 use Wikimedia\TestingAccessWrapper;
32 
36 class ParserTestRunner {
37 
44  private static $coreTestFiles = [
45  'parserTests.txt',
46  'extraParserTests.txt',
47  ];
48 
52  private $useTemporaryTables = true;
53 
57  private $setupDone = [
58  'staticSetup' => false,
59  'perTestSetup' => false,
60  'setupDatabase' => false,
61  'setDatabase' => false,
62  'setupUploads' => false,
63  ];
64 
69  private $db;
70 
75  private $dbClone;
76 
80  private $tidySupport;
81 
85  private $tidyDriver = null;
86 
90  private $recorder;
91 
97  private $uploadDir = null;
98 
103  private $fileBackendName;
104 
109  private $regex;
110 
116  private $normalizationFunctions = [];
117 
122  public function __construct( TestRecorder $recorder, $options = [] ) {
123  $this->recorder = $recorder;
124 
125  if ( isset( $options['norm'] ) ) {
126  foreach ( $options['norm'] as $func ) {
127  if ( in_array( $func, [ 'removeTbody', 'trimWhitespace' ] ) ) {
128  $this->normalizationFunctions[] = $func;
129  } else {
130  $this->recorder->warning(
131  "Warning: unknown normalization option \"$func\"\n" );
132  }
133  }
134  }
135 
136  if ( isset( $options['regex'] ) && $options['regex'] !== false ) {
137  $this->regex = $options['regex'];
138  } else {
139  # Matches anything
140  $this->regex = '//';
141  }
142 
143  $this->keepUploads = !empty( $options['keep-uploads'] );
144 
145  $this->fileBackendName = isset( $options['file-backend'] ) ?
146  $options['file-backend'] : false;
147 
148  $this->runDisabled = !empty( $options['run-disabled'] );
149  $this->runParsoid = !empty( $options['run-parsoid'] );
150 
151  $this->tidySupport = new TidySupport( !empty( $options['use-tidy-config'] ) );
152  if ( !$this->tidySupport->isEnabled() ) {
153  $this->recorder->warning(
154  "Warning: tidy is not installed, skipping some tests\n" );
155  }
156 
157  if ( isset( $options['upload-dir'] ) ) {
158  $this->uploadDir = $options['upload-dir'];
159  }
160  }
161 
167  public static function getParserTestFiles() {
169 
170  // Add core test files
171  $files = array_map( function ( $item ) {
172  return __DIR__ . "/$item";
173  }, self::$coreTestFiles );
174 
175  // Plus legacy global files
176  $files = array_merge( $files, $wgParserTestFiles );
177 
178  // Auto-discover extension parser tests
179  $registry = ExtensionRegistry::getInstance();
180  foreach ( $registry->getAllThings() as $info ) {
181  $dir = dirname( $info['path'] ) . '/tests/parser';
182  if ( !file_exists( $dir ) ) {
183  continue;
184  }
185  $counter = 1;
186  $dirIterator = new RecursiveIteratorIterator(
187  new RecursiveDirectoryIterator( $dir )
188  );
189  foreach ( $dirIterator as $fileInfo ) {
191  if ( substr( $fileInfo->getFilename(), -4 ) === '.txt' ) {
192  $name = $info['name'] . $counter;
193  while ( isset( $files[$name] ) ) {
194  $name = $info['name'] . '_' . $counter++;
195  }
196  $files[$name] = $fileInfo->getPathname();
197  }
198  }
199  }
200 
201  return array_unique( $files );
202  }
203 
204  public function getRecorder() {
205  return $this->recorder;
206  }
207 
227  public function staticSetup( $nextTeardown = null ) {
228  // A note on coding style:
229 
230  // The general idea here is to keep setup code together with
231  // corresponding teardown code, in a fine-grained manner. We have two
232  // arrays: $setup and $teardown. The code snippets in the $setup array
233  // are executed at the end of the method, before it returns, and the
234  // code snippets in the $teardown array are executed in reverse order
235  // when the Wikimedia\ScopedCallback object is consumed.
236 
237  // Because it is a common operation to save, set and restore global
238  // variables, we have an additional convention: when the array key of
239  // $setup is a string, the string is taken to be the name of the global
240  // variable, and the element value is taken to be the desired new value.
241 
242  // It's acceptable to just do the setup immediately, instead of adding
243  // a closure to $setup, except when the setup action depends on global
244  // variable initialisation being done first. In this case, you have to
245  // append a closure to $setup after the global variable is appended.
246 
247  // When you add to setup functions in this class, please keep associated
248  // setup and teardown actions together in the source code, and please
249  // add comments explaining why the setup action is necessary.
250 
251  $setup = [];
252  $teardown = [];
253 
254  $teardown[] = $this->markSetupDone( 'staticSetup' );
255 
256  // Some settings which influence HTML output
257  $setup['wgSitename'] = 'MediaWiki';
258  $setup['wgServer'] = 'http://example.org';
259  $setup['wgServerName'] = 'example.org';
260  $setup['wgScriptPath'] = '';
261  $setup['wgScript'] = '/index.php';
262  $setup['wgResourceBasePath'] = '';
263  $setup['wgStylePath'] = '/skins';
264  $setup['wgExtensionAssetsPath'] = '/extensions';
265  $setup['wgArticlePath'] = '/wiki/$1';
266  $setup['wgActionPaths'] = [];
267  $setup['wgVariantArticlePath'] = false;
268  $setup['wgUploadNavigationUrl'] = false;
269  $setup['wgCapitalLinks'] = true;
270  $setup['wgNoFollowLinks'] = true;
271  $setup['wgNoFollowDomainExceptions'] = [ 'no-nofollow.org' ];
272  $setup['wgExternalLinkTarget'] = false;
273  $setup['wgExperimentalHtmlIds'] = false;
274  $setup['wgLocaltimezone'] = 'UTC';
275  $setup['wgHtml5'] = true;
276  $setup['wgDisableLangConversion'] = false;
277  $setup['wgDisableTitleConversion'] = false;
278 
279  // "extra language links"
280  // see https://gerrit.wikimedia.org/r/111390
281  $setup['wgExtraInterlanguageLinkPrefixes'] = [ 'mul' ];
282 
283  // All FileRepo changes should be done here by injecting services,
284  // there should be no need to change global variables.
285  RepoGroup::setSingleton( $this->createRepoGroup() );
286  $teardown[] = function () {
288  };
289 
290  // Set up null lock managers
291  $setup['wgLockManagers'] = [ [
292  'name' => 'fsLockManager',
293  'class' => 'NullLockManager',
294  ], [
295  'name' => 'nullLockManager',
296  'class' => 'NullLockManager',
297  ] ];
298  $reset = function () {
300  };
301  $setup[] = $reset;
302  $teardown[] = $reset;
303 
304  // This allows article insertion into the prefixed DB
305  $setup['wgDefaultExternalStore'] = false;
306 
307  // This might slightly reduce memory usage
308  $setup['wgAdaptiveMessageCache'] = true;
309 
310  // This is essential and overrides disabling of database messages in TestSetup
311  $setup['wgUseDatabaseMessages'] = true;
312  $reset = function () {
314  };
315  $setup[] = $reset;
316  $teardown[] = $reset;
317 
318  // It's not necessary to actually convert any files
319  $setup['wgSVGConverter'] = 'null';
320  $setup['wgSVGConverters'] = [ 'null' => 'echo "1">$output' ];
321 
322  // Fake constant timestamp
323  Hooks::register( 'ParserGetVariableValueTs', function ( &$parser, &$ts ) {
324  $ts = $this->getFakeTimestamp();
325  return true;
326  } );
327  $teardown[] = function () {
328  Hooks::clear( 'ParserGetVariableValueTs' );
329  };
330 
331  $this->appendNamespaceSetup( $setup, $teardown );
332 
333  // Set up interwikis and append teardown function
334  $teardown[] = $this->setupInterwikis();
335 
336  // This affects title normalization in links. It invalidates
337  // MediaWikiTitleCodec objects.
338  $setup['wgLocalInterwikis'] = [ 'local', 'mi' ];
339  $reset = function () {
340  $this->resetTitleServices();
341  };
342  $setup[] = $reset;
343  $teardown[] = $reset;
344 
345  // Set up a mock MediaHandlerFactory
346  MediaWikiServices::getInstance()->disableService( 'MediaHandlerFactory' );
347  MediaWikiServices::getInstance()->redefineService(
348  'MediaHandlerFactory',
349  function ( MediaWikiServices $services ) {
350  $handlers = $services->getMainConfig()->get( 'ParserTestMediaHandlers' );
351  return new MediaHandlerFactory( $handlers );
352  }
353  );
354  $teardown[] = function () {
355  MediaWikiServices::getInstance()->resetServiceForTesting( 'MediaHandlerFactory' );
356  };
357 
358  // SqlBagOStuff broke when using temporary tables on r40209 (T17892).
359  // It seems to have been fixed since (r55079?), but regressed at some point before r85701.
360  // This works around it for now...
362  $setup['wgObjectCaches'] = [ CACHE_DB => $wgObjectCaches['hash'] ] + $wgObjectCaches;
363  if ( isset( ObjectCache::$instances[CACHE_DB] ) ) {
364  $savedCache = ObjectCache::$instances[CACHE_DB];
366  $teardown[] = function () use ( $savedCache ) {
367  ObjectCache::$instances[CACHE_DB] = $savedCache;
368  };
369  }
370 
371  $teardown[] = $this->executeSetupSnippets( $setup );
372 
373  // Schedule teardown snippets in reverse order
374  return $this->createTeardownObject( $teardown, $nextTeardown );
375  }
376 
377  private function appendNamespaceSetup( &$setup, &$teardown ) {
378  // Add a namespace shadowing a interwiki link, to test
379  // proper precedence when resolving links. (T53680)
380  $setup['wgExtraNamespaces'] = [
381  100 => 'MemoryAlpha',
382  101 => 'MemoryAlpha_talk'
383  ];
384  // Changing wgExtraNamespaces invalidates caches in MWNamespace and
385  // any live Language object, both on setup and teardown
386  $reset = function () {
388  $GLOBALS['wgContLang']->resetNamespaces();
389  };
390  $setup[] = $reset;
391  $teardown[] = $reset;
392  }
393 
398  protected function createRepoGroup() {
399  if ( $this->uploadDir ) {
400  if ( $this->fileBackendName ) {
401  throw new MWException( 'You cannot specify both use-filebackend and upload-dir' );
402  }
403  $backend = new FSFileBackend( [
404  'name' => 'local-backend',
405  'wikiId' => wfWikiID(),
406  'basePath' => $this->uploadDir,
407  'tmpDirectory' => wfTempDir()
408  ] );
409  } elseif ( $this->fileBackendName ) {
411  $name = $this->fileBackendName;
412  $useConfig = false;
413  foreach ( $wgFileBackends as $conf ) {
414  if ( $conf['name'] === $name ) {
415  $useConfig = $conf;
416  }
417  }
418  if ( $useConfig === false ) {
419  throw new MWException( "Unable to find file backend \"$name\"" );
420  }
421  $useConfig['name'] = 'local-backend'; // swap name
422  unset( $useConfig['lockManager'] );
423  unset( $useConfig['fileJournal'] );
424  $class = $useConfig['class'];
425  $backend = new $class( $useConfig );
426  } else {
427  # Replace with a mock. We do not care about generating real
428  # files on the filesystem, just need to expose the file
429  # informations.
430  $backend = new MockFileBackend( [
431  'name' => 'local-backend',
432  'wikiId' => wfWikiID()
433  ] );
434  }
435 
436  return new RepoGroup(
437  [
438  'class' => 'MockLocalRepo',
439  'name' => 'local',
440  'url' => 'http://example.com/images',
441  'hashLevels' => 2,
442  'transformVia404' => false,
443  'backend' => $backend
444  ],
445  []
446  );
447  }
448 
462  protected function executeSetupSnippets( $setup ) {
463  $saved = [];
464  foreach ( $setup as $name => $value ) {
465  if ( is_int( $name ) ) {
466  $value();
467  } else {
468  $saved[$name] = isset( $GLOBALS[$name] ) ? $GLOBALS[$name] : null;
469  $GLOBALS[$name] = $value;
470  }
471  }
472  return function () use ( $saved ) {
473  $this->executeSetupSnippets( $saved );
474  };
475  }
476 
489  protected function createTeardownObject( $teardown, $nextTeardown = null ) {
490  return new ScopedCallback( function () use ( $teardown, $nextTeardown ) {
491  // Schedule teardown snippets in reverse order
492  $teardown = array_reverse( $teardown );
493 
494  $this->executeSetupSnippets( $teardown );
495  if ( $nextTeardown ) {
496  ScopedCallback::consume( $nextTeardown );
497  }
498  } );
499  }
500 
508  protected function markSetupDone( $funcName ) {
509  if ( $this->setupDone[$funcName] ) {
510  throw new MWException( "$funcName is already done" );
511  }
512  $this->setupDone[$funcName] = true;
513  return function () use ( $funcName ) {
514  $this->setupDone[$funcName] = false;
515  };
516  }
517 
524  protected function checkSetupDone( $funcName, $funcName2 = null ) {
525  if ( !$this->setupDone[$funcName]
526  && ( $funcName === null || !$this->setupDone[$funcName2] )
527  ) {
528  throw new MWException( "$funcName must be called before calling " .
529  wfGetCaller() );
530  }
531  }
532 
539  public function isSetupDone( $funcName ) {
540  return isset( $this->setupDone[$funcName] ) ? $this->setupDone[$funcName] : false;
541  }
542 
554  private function setupInterwikis() {
555  # Hack: insert a few Wikipedia in-project interwiki prefixes,
556  # for testing inter-language links
557  Hooks::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) {
558  static $testInterwikis = [
559  'local' => [
560  'iw_url' => 'http://doesnt.matter.org/$1',
561  'iw_api' => '',
562  'iw_wikiid' => '',
563  'iw_local' => 0 ],
564  'wikipedia' => [
565  'iw_url' => 'http://en.wikipedia.org/wiki/$1',
566  'iw_api' => '',
567  'iw_wikiid' => '',
568  'iw_local' => 0 ],
569  'meatball' => [
570  'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
571  'iw_api' => '',
572  'iw_wikiid' => '',
573  'iw_local' => 0 ],
574  'memoryalpha' => [
575  'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1',
576  'iw_api' => '',
577  'iw_wikiid' => '',
578  'iw_local' => 0 ],
579  'zh' => [
580  'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
581  'iw_api' => '',
582  'iw_wikiid' => '',
583  'iw_local' => 1 ],
584  'es' => [
585  'iw_url' => 'http://es.wikipedia.org/wiki/$1',
586  'iw_api' => '',
587  'iw_wikiid' => '',
588  'iw_local' => 1 ],
589  'fr' => [
590  'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
591  'iw_api' => '',
592  'iw_wikiid' => '',
593  'iw_local' => 1 ],
594  'ru' => [
595  'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
596  'iw_api' => '',
597  'iw_wikiid' => '',
598  'iw_local' => 1 ],
599  'mi' => [
600  'iw_url' => 'http://mi.wikipedia.org/wiki/$1',
601  'iw_api' => '',
602  'iw_wikiid' => '',
603  'iw_local' => 1 ],
604  'mul' => [
605  'iw_url' => 'http://wikisource.org/wiki/$1',
606  'iw_api' => '',
607  'iw_wikiid' => '',
608  'iw_local' => 1 ],
609  ];
610  if ( array_key_exists( $prefix, $testInterwikis ) ) {
611  $iwData = $testInterwikis[$prefix];
612  }
613 
614  // We only want to rely on the above fixtures
615  return false;
616  } );// hooks::register
617 
618  return function () {
619  // Tear down
620  Hooks::clear( 'InterwikiLoadPrefix' );
621  };
622  }
623 
628  private function resetTitleServices() {
629  $services = MediaWikiServices::getInstance();
630  $services->resetServiceForTesting( 'TitleFormatter' );
631  $services->resetServiceForTesting( 'TitleParser' );
632  $services->resetServiceForTesting( '_MediaWikiTitleCodec' );
633  $services->resetServiceForTesting( 'LinkRenderer' );
634  $services->resetServiceForTesting( 'LinkRendererFactory' );
635  }
636 
643  public static function chomp( $s ) {
644  if ( substr( $s, -1 ) === "\n" ) {
645  return substr( $s, 0, -1 );
646  } else {
647  return $s;
648  }
649  }
650 
664  public function runTestsFromFiles( $filenames ) {
665  $ok = false;
666 
667  $teardownGuard = $this->staticSetup();
668  $teardownGuard = $this->setupDatabase( $teardownGuard );
669  $teardownGuard = $this->setupUploads( $teardownGuard );
670 
671  $this->recorder->start();
672  try {
673  $ok = true;
674 
675  foreach ( $filenames as $filename ) {
676  $testFileInfo = TestFileReader::read( $filename, [
677  'runDisabled' => $this->runDisabled,
678  'runParsoid' => $this->runParsoid,
679  'regex' => $this->regex ] );
680 
681  // Don't start the suite if there are no enabled tests in the file
682  if ( !$testFileInfo['tests'] ) {
683  continue;
684  }
685 
686  $this->recorder->startSuite( $filename );
687  $ok = $this->runTests( $testFileInfo ) && $ok;
688  $this->recorder->endSuite( $filename );
689  }
690 
691  $this->recorder->report();
692  } catch ( DBError $e ) {
693  $this->recorder->warning( $e->getMessage() );
694  }
695  $this->recorder->end();
696 
697  ScopedCallback::consume( $teardownGuard );
698 
699  return $ok;
700  }
701 
708  public function meetsRequirements( $requirements ) {
709  foreach ( $requirements as $requirement ) {
710  switch ( $requirement['type'] ) {
711  case 'hook':
712  $ok = $this->requireHook( $requirement['name'] );
713  break;
714  case 'functionHook':
715  $ok = $this->requireFunctionHook( $requirement['name'] );
716  break;
717  case 'transparentHook':
718  $ok = $this->requireTransparentHook( $requirement['name'] );
719  break;
720  }
721  if ( !$ok ) {
722  return false;
723  }
724  }
725  return true;
726  }
727 
735  public function runTests( $testFileInfo ) {
736  $ok = true;
737 
738  $this->checkSetupDone( 'staticSetup' );
739 
740  // Don't add articles from the file if there are no enabled tests from the file
741  if ( !$testFileInfo['tests'] ) {
742  return true;
743  }
744 
745  // If any requirements are not met, mark all tests from the file as skipped
746  if ( !$this->meetsRequirements( $testFileInfo['requirements'] ) ) {
747  foreach ( $testFileInfo['tests'] as $test ) {
748  $this->recorder->startTest( $test );
749  $this->recorder->skipped( $test, 'required extension not enabled' );
750  }
751  return true;
752  }
753 
754  // Add articles
755  $this->addArticles( $testFileInfo['articles'] );
756 
757  // Run tests
758  foreach ( $testFileInfo['tests'] as $test ) {
759  $this->recorder->startTest( $test );
760  $result =
761  $this->runTest( $test );
762  if ( $result !== false ) {
763  $ok = $ok && $result->isSuccess();
764  $this->recorder->record( $test, $result );
765  }
766  }
767 
768  return $ok;
769  }
770 
777  function getParser( $preprocessor = null ) {
779 
780  $class = $wgParserConf['class'];
781  $parser = new $class( [ 'preprocessorClass' => $preprocessor ] + $wgParserConf );
783 
784  return $parser;
785  }
786 
804  public function runTest( $test ) {
805  wfDebug( __METHOD__.": running {$test['desc']}" );
806  $opts = $this->parseOptions( $test['options'] );
807  $teardownGuard = $this->perTestSetup( $test );
808 
810  $user = $context->getUser();
812  $options->setTimestamp( $this->getFakeTimestamp() );
813 
814  if ( !isset( $opts['wrap'] ) ) {
815  $options->setWrapOutputClass( false );
816  }
817 
818  if ( isset( $opts['tidy'] ) ) {
819  if ( !$this->tidySupport->isEnabled() ) {
820  $this->recorder->skipped( $test, 'tidy extension is not installed' );
821  return false;
822  } else {
823  $options->setTidy( true );
824  }
825  }
826 
827  if ( isset( $opts['title'] ) ) {
828  $titleText = $opts['title'];
829  } else {
830  $titleText = 'Parser test';
831  }
832 
833  $local = isset( $opts['local'] );
834  $preprocessor = isset( $opts['preprocessor'] ) ? $opts['preprocessor'] : null;
835  $parser = $this->getParser( $preprocessor );
836  $title = Title::newFromText( $titleText );
837 
838  if ( isset( $opts['pst'] ) ) {
839  $out = $parser->preSaveTransform( $test['input'], $title, $user, $options );
840  $output = $parser->getOutput();
841  } elseif ( isset( $opts['msg'] ) ) {
842  $out = $parser->transformMsg( $test['input'], $options, $title );
843  } elseif ( isset( $opts['section'] ) ) {
844  $section = $opts['section'];
845  $out = $parser->getSection( $test['input'], $section );
846  } elseif ( isset( $opts['replace'] ) ) {
847  $section = $opts['replace'][0];
848  $replace = $opts['replace'][1];
849  $out = $parser->replaceSection( $test['input'], $section, $replace );
850  } elseif ( isset( $opts['comment'] ) ) {
851  $out = Linker::formatComment( $test['input'], $title, $local );
852  } elseif ( isset( $opts['preload'] ) ) {
853  $out = $parser->getPreloadText( $test['input'], $title, $options );
854  } else {
855  $output = $parser->parse( $test['input'], $title, $options, true, true, 1337 );
856  $output->setTOCEnabled( !isset( $opts['notoc'] ) );
857  $out = $output->getText();
858  if ( isset( $opts['tidy'] ) ) {
859  $out = preg_replace( '/\s+$/', '', $out );
860  }
861 
862  if ( isset( $opts['showtitle'] ) ) {
863  if ( $output->getTitleText() ) {
864  $title = $output->getTitleText();
865  }
866 
867  $out = "$title\n$out";
868  }
869 
870  if ( isset( $opts['showindicators'] ) ) {
871  $indicators = '';
872  foreach ( $output->getIndicators() as $id => $content ) {
873  $indicators .= "$id=$content\n";
874  }
875  $out = $indicators . $out;
876  }
877 
878  if ( isset( $opts['ill'] ) ) {
879  $out = implode( ' ', $output->getLanguageLinks() );
880  } elseif ( isset( $opts['cat'] ) ) {
881  $out = '';
882  foreach ( $output->getCategories() as $name => $sortkey ) {
883  if ( $out !== '' ) {
884  $out .= "\n";
885  }
886  $out .= "cat=$name sort=$sortkey";
887  }
888  }
889  }
890 
891  if ( isset( $output ) && isset( $opts['showflags'] ) ) {
892  $actualFlags = array_keys( TestingAccessWrapper::newFromObject( $output )->mFlags );
893  sort( $actualFlags );
894  $out .= "\nflags=" . join( ', ', $actualFlags );
895  }
896 
897  ScopedCallback::consume( $teardownGuard );
898 
899  $expected = $test['result'];
900  if ( count( $this->normalizationFunctions ) ) {
902  $test['expected'], $this->normalizationFunctions );
903  $out = ParserTestResultNormalizer::normalize( $out, $this->normalizationFunctions );
904  }
905 
906  $testResult = new ParserTestResult( $test, $expected, $out );
907  return $testResult;
908  }
909 
917  private static function getOptionValue( $key, $opts, $default ) {
918  $key = strtolower( $key );
919 
920  if ( isset( $opts[$key] ) ) {
921  return $opts[$key];
922  } else {
923  return $default;
924  }
925  }
926 
934  private function parseOptions( $instring ) {
935  $opts = [];
936  // foo
937  // foo=bar
938  // foo="bar baz"
939  // foo=[[bar baz]]
940  // foo=bar,"baz quux"
941  // foo={...json...}
942  $defs = '(?(DEFINE)
943  (?<qstr> # Quoted string
944  "
945  (?:[^\\\\"] | \\\\.)*
946  "
947  )
948  (?<json>
949  \{ # Open bracket
950  (?:
951  [^"{}] | # Not a quoted string or object, or
952  (?&qstr) | # A quoted string, or
953  (?&json) # A json object (recursively)
954  )*
955  \} # Close bracket
956  )
957  (?<value>
958  (?:
959  (?&qstr) # Quoted val
960  |
961  \[\[
962  [^]]* # Link target
963  \]\]
964  |
965  [\w-]+ # Plain word
966  |
967  (?&json) # JSON object
968  )
969  )
970  )';
971  $regex = '/' . $defs . '\b
972  (?<k>[\w-]+) # Key
973  \b
974  (?:\s*
975  = # First sub-value
976  \s*
977  (?<v>
978  (?&value)
979  (?:\s*
980  , # Sub-vals 1..N
981  \s*
982  (?&value)
983  )*
984  )
985  )?
986  /x';
987  $valueregex = '/' . $defs . '(?&value)/x';
988 
989  if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) {
990  foreach ( $matches as $bits ) {
991  $key = strtolower( $bits['k'] );
992  if ( !isset( $bits['v'] ) ) {
993  $opts[$key] = true;
994  } else {
995  preg_match_all( $valueregex, $bits['v'], $vmatches );
996  $opts[$key] = array_map( [ $this, 'cleanupOption' ], $vmatches[0] );
997  if ( count( $opts[$key] ) == 1 ) {
998  $opts[$key] = $opts[$key][0];
999  }
1000  }
1001  }
1002  }
1003  return $opts;
1004  }
1005 
1006  private function cleanupOption( $opt ) {
1007  if ( substr( $opt, 0, 1 ) == '"' ) {
1008  return stripcslashes( substr( $opt, 1, -1 ) );
1009  }
1010 
1011  if ( substr( $opt, 0, 2 ) == '[[' ) {
1012  return substr( $opt, 2, -2 );
1013  }
1014 
1015  if ( substr( $opt, 0, 1 ) == '{' ) {
1016  return FormatJson::decode( $opt, true );
1017  }
1018  return $opt;
1019  }
1020 
1030  public function perTestSetup( $test, $nextTeardown = null ) {
1031  $teardown = [];
1032 
1033  $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
1034  $teardown[] = $this->markSetupDone( 'perTestSetup' );
1035 
1036  $opts = $this->parseOptions( $test['options'] );
1037  $config = $test['config'];
1038 
1039  // Find out values for some special options.
1040  $langCode =
1041  self::getOptionValue( 'language', $opts, 'en' );
1042  $variant =
1043  self::getOptionValue( 'variant', $opts, false );
1044  $maxtoclevel =
1045  self::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
1046  $linkHolderBatchSize =
1047  self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
1048 
1049  // Default to fallback skin, but allow it to be overridden
1050  $skin = self::getOptionValue( 'skin', $opts, 'fallback' );
1051 
1052  $setup = [
1053  'wgEnableUploads' => self::getOptionValue( 'wgEnableUploads', $opts, true ),
1054  'wgLanguageCode' => $langCode,
1055  'wgRawHtml' => self::getOptionValue( 'wgRawHtml', $opts, false ),
1056  'wgNamespacesWithSubpages' => array_fill_keys(
1057  MWNamespace::getValidNamespaces(), isset( $opts['subpage'] )
1058  ),
1059  'wgMaxTocLevel' => $maxtoclevel,
1060  'wgAllowExternalImages' => self::getOptionValue( 'wgAllowExternalImages', $opts, true ),
1061  'wgThumbLimits' => [ self::getOptionValue( 'thumbsize', $opts, 180 ) ],
1062  'wgDefaultLanguageVariant' => $variant,
1063  'wgLinkHolderBatchSize' => $linkHolderBatchSize,
1064  // Set as a JSON object like:
1065  // wgEnableMagicLinks={"ISBN":false, "PMID":false, "RFC":false}
1066  'wgEnableMagicLinks' => self::getOptionValue( 'wgEnableMagicLinks', $opts, [] )
1067  + [ 'ISBN' => true, 'PMID' => true, 'RFC' => true ],
1068  // Test with legacy encoding by default until HTML5 is very stable and default
1069  'wgFragmentMode' => [ 'legacy' ],
1070  ];
1071 
1072  if ( $config ) {
1073  $configLines = explode( "\n", $config );
1074 
1075  foreach ( $configLines as $line ) {
1076  list( $var, $value ) = explode( '=', $line, 2 );
1077  $setup[$var] = eval( "return $value;" );
1078  }
1079  }
1080 
1082  Hooks::run( 'ParserTestGlobals', [ &$setup ] );
1083 
1084  // Create tidy driver
1085  if ( isset( $opts['tidy'] ) ) {
1086  // Cache a driver instance
1087  if ( $this->tidyDriver === null ) {
1088  $this->tidyDriver = MWTidy::factory( $this->tidySupport->getConfig() );
1089  }
1090  $tidy = $this->tidyDriver;
1091  } else {
1092  $tidy = false;
1093  }
1094  MWTidy::setInstance( $tidy );
1095  $teardown[] = function () {
1097  };
1098 
1099  // Set content language. This invalidates the magic word cache and title services
1100  $lang = Language::factory( $langCode );
1101  $setup['wgContLang'] = $lang;
1102  $reset = function () {
1104  $this->resetTitleServices();
1105  };
1106  $setup[] = $reset;
1107  $teardown[] = $reset;
1108 
1109  // Make a user object with the same language
1110  $user = new User;
1111  $user->setOption( 'language', $langCode );
1112  $setup['wgLang'] = $lang;
1113 
1114  // We (re)set $wgThumbLimits to a single-element array above.
1115  $user->setOption( 'thumbsize', 0 );
1116 
1117  $setup['wgUser'] = $user;
1118 
1119  // And put both user and language into the context
1121  $context->setUser( $user );
1122  $context->setLanguage( $lang );
1123  // And the skin!
1124  $oldSkin = $context->getSkin();
1125  $skinFactory = MediaWikiServices::getInstance()->getSkinFactory();
1126  $context->setSkin( $skinFactory->makeSkin( $skin ) );
1127  $context->setOutput( new OutputPage( $context ) );
1128  $setup['wgOut'] = $context->getOutput();
1129  $teardown[] = function () use ( $context, $oldSkin ) {
1130  // Clear language conversion tables
1131  $wrapper = TestingAccessWrapper::newFromObject(
1132  $context->getLanguage()->getConverter()
1133  );
1134  $wrapper->reloadTables();
1135  // Reset context to the restored globals
1136  $context->setUser( $GLOBALS['wgUser'] );
1137  $context->setLanguage( $GLOBALS['wgContLang'] );
1138  $context->setSkin( $oldSkin );
1139  $context->setOutput( $GLOBALS['wgOut'] );
1140  };
1141 
1142  $teardown[] = $this->executeSetupSnippets( $setup );
1143 
1144  return $this->createTeardownObject( $teardown, $nextTeardown );
1145  }
1146 
1152  private function listTables() {
1153  $tables = [ 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions',
1154  'protected_titles', 'revision', 'ip_changes', 'text', 'pagelinks', 'imagelinks',
1155  'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
1156  'site_stats', 'ipblocks', 'image', 'oldimage',
1157  'recentchanges', 'watchlist', 'interwiki', 'logging', 'log_search',
1158  'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
1159  'archive', 'user_groups', 'page_props', 'category'
1160  ];
1161 
1162  if ( in_array( $this->db->getType(), [ 'mysql', 'sqlite', 'oracle' ] ) ) {
1163  array_push( $tables, 'searchindex' );
1164  }
1165 
1166  // Allow extensions to add to the list of tables to duplicate;
1167  // may be necessary if they hook into page save or other code
1168  // which will require them while running tests.
1169  Hooks::run( 'ParserTestTables', [ &$tables ] );
1170 
1171  return $tables;
1172  }
1173 
1174  public function setDatabase( IDatabase $db ) {
1175  $this->db = $db;
1176  $this->setupDone['setDatabase'] = true;
1177  }
1178 
1196  public function setupDatabase( $nextTeardown = null ) {
1198 
1199  $this->db = wfGetDB( DB_MASTER );
1200  $dbType = $this->db->getType();
1201 
1202  if ( $dbType == 'oracle' ) {
1203  $suspiciousPrefixes = [ 'pt_', MediaWikiTestCase::ORA_DB_PREFIX ];
1204  } else {
1205  $suspiciousPrefixes = [ 'parsertest_', MediaWikiTestCase::DB_PREFIX ];
1206  }
1207  if ( in_array( $wgDBprefix, $suspiciousPrefixes ) ) {
1208  throw new MWException( "\$wgDBprefix=$wgDBprefix suggests DB setup is already done" );
1209  }
1210 
1211  $teardown = [];
1212 
1213  $teardown[] = $this->markSetupDone( 'setupDatabase' );
1214 
1215  # CREATE TEMPORARY TABLE breaks if there is more than one server
1216  if ( wfGetLB()->getServerCount() != 1 ) {
1217  $this->useTemporaryTables = false;
1218  }
1219 
1220  $temporary = $this->useTemporaryTables || $dbType == 'postgres';
1221  $prefix = $dbType != 'oracle' ? 'parsertest_' : 'pt_';
1222 
1223  $this->dbClone = new CloneDatabase( $this->db, $this->listTables(), $prefix );
1224  $this->dbClone->useTemporaryTables( $temporary );
1225  $this->dbClone->cloneTableStructure();
1226 
1227  if ( $dbType == 'oracle' ) {
1228  $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1229  # Insert 0 user to prevent FK violations
1230 
1231  # Anonymous user
1232  $this->db->insert( 'user', [
1233  'user_id' => 0,
1234  'user_name' => 'Anonymous' ] );
1235  }
1236 
1237  $teardown[] = function () {
1238  $this->teardownDatabase();
1239  };
1240 
1241  // Wipe some DB query result caches on setup and teardown
1242  $reset = function () {
1243  LinkCache::singleton()->clear();
1244 
1245  // Clear the message cache
1246  MessageCache::singleton()->clear();
1247  };
1248  $reset();
1249  $teardown[] = $reset;
1250  return $this->createTeardownObject( $teardown, $nextTeardown );
1251  }
1252 
1261  public function setupUploads( $nextTeardown = null ) {
1262  $teardown = [];
1263 
1264  $this->checkSetupDone( 'setupDatabase', 'setDatabase' );
1265  $teardown[] = $this->markSetupDone( 'setupUploads' );
1266 
1267  // Create the files in the upload directory (or pretend to create them
1268  // in a MockFileBackend). Append teardown callback.
1269  $teardown[] = $this->setupUploadBackend();
1270 
1271  // Create a user
1272  $user = User::createNew( 'WikiSysop' );
1273 
1274  // Register the uploads in the database
1275 
1276  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.jpg' ) );
1277  # note that the size/width/height/bits/etc of the file
1278  # are actually set by inspecting the file itself; the arguments
1279  # to recordUpload2 have no effect. That said, we try to make things
1280  # match up so it is less confusing to readers of the code & tests.
1281  $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', [
1282  'size' => 7881,
1283  'width' => 1941,
1284  'height' => 220,
1285  'bits' => 8,
1286  'media_type' => MEDIATYPE_BITMAP,
1287  'mime' => 'image/jpeg',
1288  'metadata' => serialize( [] ),
1289  'sha1' => Wikimedia\base_convert( '1', 16, 36, 31 ),
1290  'fileExists' => true
1291  ], $this->db->timestamp( '20010115123500' ), $user );
1292 
1293  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Thumb.png' ) );
1294  # again, note that size/width/height below are ignored; see above.
1295  $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', [
1296  'size' => 22589,
1297  'width' => 135,
1298  'height' => 135,
1299  'bits' => 8,
1300  'media_type' => MEDIATYPE_BITMAP,
1301  'mime' => 'image/png',
1302  'metadata' => serialize( [] ),
1303  'sha1' => Wikimedia\base_convert( '2', 16, 36, 31 ),
1304  'fileExists' => true
1305  ], $this->db->timestamp( '20130225203040' ), $user );
1306 
1307  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.svg' ) );
1308  $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', [
1309  'size' => 12345,
1310  'width' => 240,
1311  'height' => 180,
1312  'bits' => 0,
1313  'media_type' => MEDIATYPE_DRAWING,
1314  'mime' => 'image/svg+xml',
1315  'metadata' => serialize( [] ),
1316  'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ),
1317  'fileExists' => true
1318  ], $this->db->timestamp( '20010115123500' ), $user );
1319 
1320  # This image will be blacklisted in [[MediaWiki:Bad image list]]
1321  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Bad.jpg' ) );
1322  $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', [
1323  'size' => 12345,
1324  'width' => 320,
1325  'height' => 240,
1326  'bits' => 24,
1327  'media_type' => MEDIATYPE_BITMAP,
1328  'mime' => 'image/jpeg',
1329  'metadata' => serialize( [] ),
1330  'sha1' => Wikimedia\base_convert( '3', 16, 36, 31 ),
1331  'fileExists' => true
1332  ], $this->db->timestamp( '20010115123500' ), $user );
1333 
1334  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Video.ogv' ) );
1335  $image->recordUpload2( '', 'A pretty movie', 'Will it play', [
1336  'size' => 12345,
1337  'width' => 320,
1338  'height' => 240,
1339  'bits' => 0,
1340  'media_type' => MEDIATYPE_VIDEO,
1341  'mime' => 'application/ogg',
1342  'metadata' => serialize( [] ),
1343  'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ),
1344  'fileExists' => true
1345  ], $this->db->timestamp( '20010115123500' ), $user );
1346 
1347  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Audio.oga' ) );
1348  $image->recordUpload2( '', 'An awesome hitsong', 'Will it play', [
1349  'size' => 12345,
1350  'width' => 0,
1351  'height' => 0,
1352  'bits' => 0,
1353  'media_type' => MEDIATYPE_AUDIO,
1354  'mime' => 'application/ogg',
1355  'metadata' => serialize( [] ),
1356  'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ),
1357  'fileExists' => true
1358  ], $this->db->timestamp( '20010115123500' ), $user );
1359 
1360  # A DjVu file
1361  $image = wfLocalFile( Title::makeTitle( NS_FILE, 'LoremIpsum.djvu' ) );
1362  $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', [
1363  'size' => 3249,
1364  'width' => 2480,
1365  'height' => 3508,
1366  'bits' => 0,
1367  'media_type' => MEDIATYPE_BITMAP,
1368  'mime' => 'image/vnd.djvu',
1369  'metadata' => '<?xml version="1.0" ?>
1370 <!DOCTYPE DjVuXML PUBLIC "-//W3C//DTD DjVuXML 1.1//EN" "pubtext/DjVuXML-s.dtd">
1371 <DjVuXML>
1372 <HEAD></HEAD>
1373 <BODY><OBJECT height="3508" width="2480">
1374 <PARAM name="DPI" value="300" />
1375 <PARAM name="GAMMA" value="2.2" />
1376 </OBJECT>
1377 <OBJECT height="3508" width="2480">
1378 <PARAM name="DPI" value="300" />
1379 <PARAM name="GAMMA" value="2.2" />
1380 </OBJECT>
1381 <OBJECT height="3508" width="2480">
1382 <PARAM name="DPI" value="300" />
1383 <PARAM name="GAMMA" value="2.2" />
1384 </OBJECT>
1385 <OBJECT height="3508" width="2480">
1386 <PARAM name="DPI" value="300" />
1387 <PARAM name="GAMMA" value="2.2" />
1388 </OBJECT>
1389 <OBJECT height="3508" width="2480">
1390 <PARAM name="DPI" value="300" />
1391 <PARAM name="GAMMA" value="2.2" />
1392 </OBJECT>
1393 </BODY>
1394 </DjVuXML>',
1395  'sha1' => Wikimedia\base_convert( '', 16, 36, 31 ),
1396  'fileExists' => true
1397  ], $this->db->timestamp( '20010115123600' ), $user );
1398 
1399  return $this->createTeardownObject( $teardown, $nextTeardown );
1400  }
1401 
1408  private function teardownDatabase() {
1409  $this->checkSetupDone( 'setupDatabase' );
1410 
1411  $this->dbClone->destroy();
1412  $this->databaseSetupDone = false;
1413 
1414  if ( $this->useTemporaryTables ) {
1415  if ( $this->db->getType() == 'sqlite' ) {
1416  # Under SQLite the searchindex table is virtual and need
1417  # to be explicitly destroyed. See T31912
1418  # See also MediaWikiTestCase::destroyDB()
1419  wfDebug( __METHOD__ . " explicitly destroying sqlite virtual table parsertest_searchindex\n" );
1420  $this->db->query( "DROP TABLE `parsertest_searchindex`" );
1421  }
1422  # Don't need to do anything
1423  return;
1424  }
1425 
1426  $tables = $this->listTables();
1427 
1428  foreach ( $tables as $table ) {
1429  if ( $this->db->getType() == 'oracle' ) {
1430  $this->db->query( "DROP TABLE pt_$table DROP CONSTRAINTS" );
1431  } else {
1432  $this->db->query( "DROP TABLE `parsertest_$table`" );
1433  }
1434  }
1435 
1436  if ( $this->db->getType() == 'oracle' ) {
1437  $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1438  }
1439  }
1440 
1446  private function setupUploadBackend() {
1447  global $IP;
1448 
1449  $repo = RepoGroup::singleton()->getLocalRepo();
1450  $base = $repo->getZonePath( 'public' );
1451  $backend = $repo->getBackend();
1452  $backend->prepare( [ 'dir' => "$base/3/3a" ] );
1453  $backend->store( [
1454  'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1455  'dst' => "$base/3/3a/Foobar.jpg"
1456  ] );
1457  $backend->prepare( [ 'dir' => "$base/e/ea" ] );
1458  $backend->store( [
1459  'src' => "$IP/tests/phpunit/data/parser/wiki.png",
1460  'dst' => "$base/e/ea/Thumb.png"
1461  ] );
1462  $backend->prepare( [ 'dir' => "$base/0/09" ] );
1463  $backend->store( [
1464  'src' => "$IP/tests/phpunit/data/parser/headbg.jpg",
1465  'dst' => "$base/0/09/Bad.jpg"
1466  ] );
1467  $backend->prepare( [ 'dir' => "$base/5/5f" ] );
1468  $backend->store( [
1469  'src' => "$IP/tests/phpunit/data/parser/LoremIpsum.djvu",
1470  'dst' => "$base/5/5f/LoremIpsum.djvu"
1471  ] );
1472 
1473  // No helpful SVG file to copy, so make one ourselves
1474  $data = '<?xml version="1.0" encoding="utf-8"?>' .
1475  '<svg xmlns="http://www.w3.org/2000/svg"' .
1476  ' version="1.1" width="240" height="180"/>';
1477 
1478  $backend->prepare( [ 'dir' => "$base/f/ff" ] );
1479  $backend->quickCreate( [
1480  'content' => $data, 'dst' => "$base/f/ff/Foobar.svg"
1481  ] );
1482 
1483  return function () use ( $backend ) {
1484  if ( $backend instanceof MockFileBackend ) {
1485  // In memory backend, so dont bother cleaning them up.
1486  return;
1487  }
1488  $this->teardownUploadBackend();
1489  };
1490  }
1491 
1495  private function teardownUploadBackend() {
1496  if ( $this->keepUploads ) {
1497  return;
1498  }
1499 
1500  $repo = RepoGroup::singleton()->getLocalRepo();
1501  $public = $repo->getZonePath( 'public' );
1502 
1503  $this->deleteFiles(
1504  [
1505  "$public/3/3a/Foobar.jpg",
1506  "$public/e/ea/Thumb.png",
1507  "$public/0/09/Bad.jpg",
1508  "$public/5/5f/LoremIpsum.djvu",
1509  "$public/f/ff/Foobar.svg",
1510  "$public/0/00/Video.ogv",
1511  "$public/4/41/Audio.oga",
1512  ]
1513  );
1514  }
1515 
1520  private function deleteFiles( $files ) {
1521  // Delete the files
1522  $backend = RepoGroup::singleton()->getLocalRepo()->getBackend();
1523  foreach ( $files as $file ) {
1524  $backend->delete( [ 'src' => $file ], [ 'force' => 1 ] );
1525  }
1526 
1527  // Delete the parent directories
1528  foreach ( $files as $file ) {
1529  $tmp = FileBackend::parentStoragePath( $file );
1530  while ( $tmp ) {
1531  if ( !$backend->clean( [ 'dir' => $tmp ] )->isOK() ) {
1532  break;
1533  }
1534  $tmp = FileBackend::parentStoragePath( $tmp );
1535  }
1536  }
1537  }
1538 
1544  public function addArticles( $articles ) {
1546  $setup = [];
1547  $teardown = [];
1548 
1549  // Be sure ParserTestRunner::addArticle has correct language set,
1550  // so that system messages get into the right language cache
1551  if ( $wgContLang->getCode() !== 'en' ) {
1552  $setup['wgLanguageCode'] = 'en';
1553  $setup['wgContLang'] = Language::factory( 'en' );
1554  }
1555 
1556  // Add special namespaces, in case that hasn't been done by staticSetup() yet
1557  $this->appendNamespaceSetup( $setup, $teardown );
1558 
1559  // wgCapitalLinks obviously needs initialisation
1560  $setup['wgCapitalLinks'] = true;
1561 
1562  $teardown[] = $this->executeSetupSnippets( $setup );
1563 
1564  foreach ( $articles as $info ) {
1565  $this->addArticle( $info['name'], $info['text'], $info['file'], $info['line'] );
1566  }
1567 
1568  // Wipe WANObjectCache process cache, which is invalidated by article insertion
1569  // due to T144706
1570  ObjectCache::getMainWANInstance()->clearProcessCache();
1571 
1572  $this->executeSetupSnippets( $teardown );
1573  }
1574 
1584  private function addArticle( $name, $text, $file, $line ) {
1585  $text = self::chomp( $text );
1586  $name = self::chomp( $name );
1587 
1589  wfDebug( __METHOD__ . ": adding $name" );
1590 
1591  if ( is_null( $title ) ) {
1592  throw new MWException( "invalid title '$name' at $file:$line\n" );
1593  }
1594 
1595  $page = WikiPage::factory( $title );
1596  $page->loadPageData( 'fromdbmaster' );
1597 
1598  if ( $page->exists() ) {
1599  throw new MWException( "duplicate article '$name' at $file:$line\n" );
1600  }
1601 
1602  // Use mock parser, to make debugging of actual parser tests simpler.
1603  // But initialise the MessageCache clone first, don't let MessageCache
1604  // get a reference to the mock object.
1605  MessageCache::singleton()->getParser();
1606  $restore = $this->executeSetupSnippets( [ 'wgParser' => new ParserTestMockParser ] );
1607  try {
1608  $status = $page->doEditContent(
1610  '',
1612  );
1613  } finally {
1614  $restore();
1615  }
1616 
1617  if ( !$status->isOK() ) {
1618  throw new MWException( $status->getWikiText( false, false, 'en' ) );
1619  }
1620 
1621  // The RepoGroup cache is invalidated by the creation of file redirects
1622  if ( $title->inNamespace( NS_FILE ) ) {
1623  RepoGroup::singleton()->clearCache( $title );
1624  }
1625  }
1626 
1633  public function requireHook( $name ) {
1634  global $wgParser;
1635 
1636  $wgParser->firstCallInit(); // make sure hooks are loaded.
1637  if ( isset( $wgParser->mTagHooks[$name] ) ) {
1638  return true;
1639  } else {
1640  $this->recorder->warning( " This test suite requires the '$name' hook " .
1641  "extension, skipping." );
1642  return false;
1643  }
1644  }
1645 
1652  public function requireFunctionHook( $name ) {
1653  global $wgParser;
1654 
1655  $wgParser->firstCallInit(); // make sure hooks are loaded.
1656 
1657  if ( isset( $wgParser->mFunctionHooks[$name] ) ) {
1658  return true;
1659  } else {
1660  $this->recorder->warning( " This test suite requires the '$name' function " .
1661  "hook extension, skipping." );
1662  return false;
1663  }
1664  }
1665 
1672  public function requireTransparentHook( $name ) {
1673  global $wgParser;
1674 
1675  $wgParser->firstCallInit(); // make sure hooks are loaded.
1676 
1677  if ( isset( $wgParser->mTransparentTagHooks[$name] ) ) {
1678  return true;
1679  } else {
1680  $this->recorder->warning( " This test suite requires the '$name' transparent " .
1681  "hook extension, skipping.\n" );
1682  return false;
1683  }
1684  }
1685 
1693  private function getFakeTimestamp() {
1694  // parsed as '1970-01-01T00:02:03Z'
1695  return 123;
1696  }
1697 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:268
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
MEDIATYPE_AUDIO
const MEDIATYPE_AUDIO
Definition: defines.php:32
MWNamespace\getValidNamespaces
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
Definition: MWNamespace.php:264
$tables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:988
LockManagerGroup\destroySingletons
static destroySingletons()
Destroy the singleton instances.
Definition: LockManagerGroup.php:65
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2581
$wgParser
$wgParser
Definition: Setup.php:824
HashBagOStuff
Simple store for keeping values in an associative array for the current process.
Definition: HashBagOStuff.php:31
ParserTestResult
Represent the result of a parser test.
Definition: ParserTestResult.php:14
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:78
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
$opt
$opt
Definition: postprocess-phan.php:115
EDIT_INTERNAL
const EDIT_INTERNAL
Definition: Defines.php:160
$wgParserConf
$wgParserConf
Parser configuration.
Definition: DefaultSettings.php:4178
captcha-old.count
count
Definition: captcha-old.py:249
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2869
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1963
$status
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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:1245
ParserTestResultNormalizer\normalize
static normalize( $text, $funcs)
Definition: ParserTestResultNormalizer.php:10
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ObjectCache\$instances
static BagOStuff[] $instances
Map of (id => BagOStuff)
Definition: ObjectCache.php:82
MEDIATYPE_DRAWING
const MEDIATYPE_DRAWING
Definition: defines.php:30
TestRecorder\warning
warning( $message)
Show a warning to the user.
Definition: TestRecorder.php:72
NS_FILE
const NS_FILE
Definition: Defines.php:71
serialize
serialize()
Definition: ApiMessage.php:177
MWTidy\factory
static factory(array $config)
Create a new Tidy driver object from configuration.
Definition: MWTidy.php:124
MockFileBackend
Class simulating a backend store.
Definition: MockFileBackend.php:31
$s
$s
Definition: mergeMessageFileList.php:188
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Hooks\clear
static clear( $name)
Clears hooks registered via Hooks::register().
Definition: Hooks.php:66
User
User
Definition: All_system_messages.txt:425
$base
$base
Definition: generateLocalAutoload.php:10
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2198
$wgDBprefix
$wgDBprefix
Table name prefix.
Definition: DefaultSettings.php:1849
php
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
MediaHandlerFactory
Class to construct MediaHandler objects.
Definition: MediaHandlerFactory.php:29
User\createNew
static createNew( $name, $params=[])
Add a user to the database, return the user object.
Definition: User.php:4106
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:40
ExtensionRegistry\getInstance
static getInstance()
Definition: ExtensionRegistry.php:80
TidySupport
Initialize and detect the tidy support.
Definition: TidySupport.php:26
FormatJson\decode
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:121
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
$matches
$matches
Definition: NoLocalSettings.php:24
TestRecorder
Interface to record parser test results.
Definition: TestRecorder.php:35
$IP
$IP
Definition: update.php:3
$wgObjectCaches
$wgObjectCaches
Advanced object cache configuration.
Definition: DefaultSettings.php:2294
$parser
do that in ParserLimitReportFormat instead $parser
Definition: hooks.txt:2572
MEDIATYPE_BITMAP
const MEDIATYPE_BITMAP
Definition: defines.php:28
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:529
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$wgParserTestFiles
$wgParserTestFiles
Parser test suite files to be run by parserTests.php when no specific filename is passed to it.
Definition: DefaultSettings.php:6377
$wgFileBackends
$wgFileBackends
File backend structure configuration.
Definition: DefaultSettings.php:640
$GLOBALS
$GLOBALS['wgAutoloadClasses']['LocalisationUpdate']
Definition: Autoload.php:10
DB_MASTER
const DB_MASTER
Definition: defines.php:26
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:1047
OutputPage
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:44
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$dir
$dir
Definition: Autoload.php:8
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:113
$services
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2198
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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 modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition: hooks.txt:781
MagicWord\clearCache
static clearCache()
Clear the self::$mObjects variable For use in parser tests.
Definition: MagicWord.php:320
MWTidy\setInstance
static setInstance( $instance)
Set the driver to be used.
Definition: MWTidy.php:156
$line
$line
Definition: cdb.php:58
RepoGroup\destroySingleton
static destroySingleton()
Destroy the singleton instance, so that a new one will be created next time singleton() is called.
Definition: RepoGroup.php:73
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2807
ParserTestParserHook\setup
static setup(&$parser)
Definition: ParserTestParserHook.php:30
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
Hooks\register
static register( $name, $callback)
Attach an event handler to a given hook.
Definition: Hooks.php:49
$value
$value
Definition: styleTest.css.php:45
ParserOptions\newFromContext
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
Definition: ParserOptions.php:1005
ParserTestMockParser
A parser used during article insertion which does nothing, to avoid unnecessary log noise and other i...
Definition: ParserTestMockParser.php:7
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:470
Linker\formatComment
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1099
EDIT_NEW
const EDIT_NEW
Definition: Defines.php:153
TestFileReader\read
static read( $file, array $options=[])
Definition: TestFileReader.php:38
MediaWikiTestCase\DB_PREFIX
const DB_PREFIX
Table name prefixes.
Definition: MediaWikiTestCase.php:104
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2107
CloneDatabase
Definition: CloneDatabase.php:29
FSFileBackend
Class for a file system (FS) based file backend.
Definition: FSFileBackend.php:41
MEDIATYPE_VIDEO
const MEDIATYPE_VIDEO
Definition: defines.php:35
$options
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 & $options
Definition: hooks.txt:1965
MediaWikiTestCase\ORA_DB_PREFIX
const ORA_DB_PREFIX
Definition: MediaWikiTestCase.php:105
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:370
LinkCache\singleton
static singleton()
Get an instance of this class.
Definition: LinkCache.php:67
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:2981
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
MWNamespace\getCanonicalNamespaces
static getCanonicalNamespaces( $rebuild=false)
Returns array of all defined namespaces with their canonical (English) names.
Definition: MWNamespace.php:207
$skin
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:1965
Wikimedia
RepoGroup
Prioritized list of file repositories.
Definition: RepoGroup.php:29
true
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 true
Definition: hooks.txt:1965
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:23
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2908
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
MWTidy\destroySingleton
static destroySingleton()
Destroy the current singleton instance.
Definition: MWTidy.php:163
wfGetCaller
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
Definition: GlobalFunctions.php:1607
RepoGroup\setSingleton
static setSingleton( $instance)
Set the singleton instance to a given object Used by extensions which hook into the Repo chain.
Definition: RepoGroup.php:85
CACHE_DB
const CACHE_DB
Definition: Defines.php:104
array
the array() calling protocol came about after MediaWiki 1.4rc1.
FileBackend\parentStoragePath
static parentStoragePath( $storagePath)
Get the parent storage directory of a storage path.
Definition: FileBackend.php:1492
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:781
MessageCache\destroyInstance
static destroyInstance()
Destroy the singleton instance.
Definition: MessageCache.php:135