tests/parser/parserTest.inc

   1 <?php
   2 /**
   3  * Helper code for the MediaWiki parser test suite. Some code is duplicated
   4  * in PHPUnit's NewParserTests.php, so you'll probably want to update both
   5  * at the same time.
   6  *
   7  * Copyright © 2004, 2010 Brion Vibber <brion@pobox.com>
   8  * https://www.mediawiki.org/
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @todo Make this more independent of the configuration (and if possible the database)
  26  * @todo document
  27  * @file
  28  * @ingroup Testing
  29  */
  30
  31 /**
  32  * @ingroup Testing
  33  */
  34 class ParserTest {
  35         /**
  36          * @var bool $color whereas output should be colorized
  37          */
  38         private $color;
  39
  40         /**
  41          * @var bool $showOutput Show test output
  42          */
  43         private $showOutput;
  44
  45         /**
  46          * @var bool $useTemporaryTables Use temporary tables for the temporary database
  47          */
  48         private $useTemporaryTables = true;
  49
  50         /**
  51          * @var bool $databaseSetupDone True if the database has been set up
  52          */
  53         private $databaseSetupDone = false;
  54
  55         /**
  56          * Our connection to the database
  57          * @var DatabaseBase
  58          */
  59         private $db;
  60
  61         /**
  62          * Database clone helper
  63          * @var CloneDatabase
  64          */
  65         private $dbClone;
  66
  67         /**
  68          * @var DjVuSupport
  69          */
  70         private $djVuSupport;
  71
  72         /**
  73          * @var TidySupport
  74          */
  75         private $tidySupport;
  76
  77         private $maxFuzzTestLength = 300;
  78         private $fuzzSeed = 0;
  79         private $memoryLimit = 50;
  80         private $uploadDir = null;
  81
  82         public $regex = "";
  83         private $savedGlobals = array();
  84
  85         /**
  86          * Sets terminal colorization and diff/quick modes depending on OS and
  87          * command-line options (--color and --quick).
  88          * @param array $options
  89          */
  90         public function __construct( $options = array() ) {
  91                 # Only colorize output if stdout is a terminal.
  92                 $this->color = !wfIsWindows() && Maintenance::posix_isatty( 1 );
  93
  94                 if ( isset( $options['color'] ) ) {
  95                         switch ( $options['color'] ) {
  96                                 case 'no':
  97                                         $this->color = false;
  98                                         break;
  99                                 case 'yes':
 100                                 default:
 101                                         $this->color = true;
 102                                         break;
 103                         }
 104                 }
 105
 106                 $this->term = $this->color
 107                         ? new AnsiTermColorer()
 108                         : new DummyTermColorer();
 109
 110                 $this->showDiffs = !isset( $options['quick'] );
 111                 $this->showProgress = !isset( $options['quiet'] );
 112                 $this->showFailure = !(
 113                         isset( $options['quiet'] )
 114                                 && ( isset( $options['record'] )
 115                                 || isset( $options['compare'] ) ) ); // redundant output
 116
 117                 $this->showOutput = isset( $options['show-output'] );
 118
 119                 if ( isset( $options['filter'] ) ) {
 120                         $options['regex'] = $options['filter'];
 121                 }
 122
 123                 if ( isset( $options['regex'] ) ) {
 124                         if ( isset( $options['record'] ) ) {
 125                                 echo "Warning: --record cannot be used with --regex, disabling --record\n";
 126                                 unset( $options['record'] );
 127                         }
 128                         $this->regex = $options['regex'];
 129                 } else {
 130                         # Matches anything
 131                         $this->regex = '';
 132                 }
 133
 134                 $this->setupRecorder( $options );
 135                 $this->keepUploads = isset( $options['keep-uploads'] );
 136
 137                 if ( isset( $options['seed'] ) ) {
 138                         $this->fuzzSeed = intval( $options['seed'] ) - 1;
 139                 }
 140
 141                 $this->runDisabled = isset( $options['run-disabled'] );
 142                 $this->runParsoid = isset( $options['run-parsoid'] );
 143
 144                 $this->djVuSupport = new DjVuSupport();
 145                 $this->tidySupport = new TidySupport();
 146                 if ( !$this->tidySupport->isEnabled() ) {
 147                         echo "Warning: tidy is not installed, skipping some tests\n";
 148                 }
 149
 150                 $this->hooks = array();
 151                 $this->functionHooks = array();
 152                 $this->transparentHooks = array();
 153                 self::setUp();
 154         }
 155
 156         static function setUp() {
 157                 global $wgParser, $wgParserConf, $IP, $messageMemc, $wgMemc,
 158                         $wgUser, $wgLang, $wgOut, $wgRequest, $wgStyleDirectory, $wgEnableParserCache,
 159                         $wgExtraNamespaces, $wgNamespaceAliases, $wgNamespaceProtection, $wgLocalFileRepo,
 160                         $wgExtraInterlanguageLinkPrefixes, $wgLocalInterwikis,
 161                         $parserMemc, $wgThumbnailScriptPath, $wgScriptPath,
 162                         $wgArticlePath, $wgScript, $wgStylePath, $wgExtensionAssetsPath,
 163                         $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, $wgLockManagers;
 164
 165                 $wgScript = '/index.php';
 166                 $wgScriptPath = '/';
 167                 $wgArticlePath = '/wiki/$1';
 168                 $wgStylePath = '/skins';
 169                 $wgExtensionAssetsPath = '/extensions';
 170                 $wgThumbnailScriptPath = false;
 171                 $wgLockManagers = array( array(
 172                         'name' => 'fsLockManager',
 173                         'class' => 'FSLockManager',
 174                         'lockDirectory' => wfTempDir() . '/test-repo/lockdir',
 175                 ), array(
 176                         'name' => 'nullLockManager',
 177                         'class' => 'NullLockManager',
 178                 ) );
 179                 $wgLocalFileRepo = array(
 180                         'class' => 'LocalRepo',
 181                         'name' => 'local',
 182                         'url' => 'http://example.com/images',
 183                         'hashLevels' => 2,
 184                         'transformVia404' => false,
 185                         'backend' => new FSFileBackend( array(
 186                                 'name' => 'local-backend',
 187                                 'wikiId' => wfWikiId(),
 188                                 'containerPaths' => array(
 189                                         'local-public' => wfTempDir() . '/test-repo/public',
 190                                         'local-thumb' => wfTempDir() . '/test-repo/thumb',
 191                                         'local-temp' => wfTempDir() . '/test-repo/temp',
 192                                         'local-deleted' => wfTempDir() . '/test-repo/deleted',
 193                                 )
 194                         ) )
 195                 );
 196                 $wgNamespaceProtection[NS_MEDIAWIKI] = 'editinterface';
 197                 $wgNamespaceAliases['Image'] = NS_FILE;
 198                 $wgNamespaceAliases['Image_talk'] = NS_FILE_TALK;
 199                 # add a namespace shadowing a interwiki link, to test
 200                 # proper precedence when resolving links. (bug 51680)
 201                 $wgExtraNamespaces[100] = 'MemoryAlpha';
 202
 203                 // XXX: tests won't run without this (for CACHE_DB)
 204                 if ( $wgMainCacheType === CACHE_DB ) {
 205                         $wgMainCacheType = CACHE_NONE;
 206                 }
 207                 if ( $wgMessageCacheType === CACHE_DB ) {
 208                         $wgMessageCacheType = CACHE_NONE;
 209                 }
 210                 if ( $wgParserCacheType === CACHE_DB ) {
 211                         $wgParserCacheType = CACHE_NONE;
 212                 }
 213
 214                 $wgEnableParserCache = false;
 215                 DeferredUpdates::clearPendingUpdates();
 216                 $wgMemc = wfGetMainCache(); // checks $wgMainCacheType
 217                 $messageMemc = wfGetMessageCacheStorage();
 218                 $parserMemc = wfGetParserCacheStorage();
 219
 220                 $wgUser = new User;
 221                 $context = new RequestContext;
 222                 $wgLang = $context->getLanguage();
 223                 $wgOut = $context->getOutput();
 224                 $wgParser = new StubObject( 'wgParser', $wgParserConf['class'], array( $wgParserConf ) );
 225                 $wgRequest = $context->getRequest();
 226
 227                 if ( $wgStyleDirectory === false ) {
 228                         $wgStyleDirectory = "$IP/skins";
 229                 }
 230
 231                 self::setupInterwikis();
 232                 $wgLocalInterwikis = array( 'local', 'mi' );
 233                 // "extra language links"
 234                 // see https://gerrit.wikimedia.org/r/111390
 235                 array_push( $wgExtraInterlanguageLinkPrefixes, 'mul' );
 236         }
 237
 238         /**
 239          * Insert hardcoded interwiki in the lookup table.
 240          *
 241          * This function insert a set of well known interwikis that are used in
 242          * the parser tests. They can be considered has fixtures are injected in
 243          * the interwiki cache by using the 'InterwikiLoadPrefix' hook.
 244          * Since we are not interested in looking up interwikis in the database,
 245          * the hook completely replace the existing mechanism (hook returns false).
 246          */
 247         public static function setupInterwikis() {
 248                 # Hack: insert a few Wikipedia in-project interwiki prefixes,
 249                 # for testing inter-language links
 250                 Hooks::register( 'InterwikiLoadPrefix', function ( $prefix, &$iwData ) {
 251                         static $testInterwikis = array(
 252                                 'local' => array(
 253                                         'iw_url' => 'http://doesnt.matter.org/$1',
 254                                         'iw_api' => '',
 255                                         'iw_wikiid' => '',
 256                                         'iw_local' => 0 ),
 257                                 'wikipedia' => array(
 258                                         'iw_url' => 'http://en.wikipedia.org/wiki/$1',
 259                                         'iw_api' => '',
 260                                         'iw_wikiid' => '',
 261                                         'iw_local' => 0 ),
 262                                 'meatball' => array(
 263                                         'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 264                                         'iw_api' => '',
 265                                         'iw_wikiid' => '',
 266                                         'iw_local' => 0 ),
 267                                 'memoryalpha' => array(
 268                                         'iw_url' => 'http://www.memory-alpha.org/en/index.php/$1',
 269                                         'iw_api' => '',
 270                                         'iw_wikiid' => '',
 271                                         'iw_local' => 0 ),
 272                                 'zh' => array(
 273                                         'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
 274                                         'iw_api' => '',
 275                                         'iw_wikiid' => '',
 276                                         'iw_local' => 1 ),
 277                                 'es' => array(
 278                                         'iw_url' => 'http://es.wikipedia.org/wiki/$1',
 279                                         'iw_api' => '',
 280                                         'iw_wikiid' => '',
 281                                         'iw_local' => 1 ),
 282                                 'fr' => array(
 283                                         'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
 284                                         'iw_api' => '',
 285                                         'iw_wikiid' => '',
 286                                         'iw_local' => 1 ),
 287                                 'ru' => array(
 288                                         'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
 289                                         'iw_api' => '',
 290                                         'iw_wikiid' => '',
 291                                         'iw_local' => 1 ),
 292                                 'mi' => array(
 293                                         'iw_url' => 'http://mi.wikipedia.org/wiki/$1',
 294                                         'iw_api' => '',
 295                                         'iw_wikiid' => '',
 296                                         'iw_local' => 1 ),
 297                                 'mul' => array(
 298                                         'iw_url' => 'http://wikisource.org/wiki/$1',
 299                                         'iw_api' => '',
 300                                         'iw_wikiid' => '',
 301                                         'iw_local' => 1 ),
 302                         );
 303                         if ( array_key_exists( $prefix, $testInterwikis ) ) {
 304                                 $iwData = $testInterwikis[$prefix];
 305                         }
 306
 307                         // We only want to rely on the above fixtures
 308                         return false;
 309                 } );// hooks::register
 310         }
 311
 312         /**
 313          * Remove the hardcoded interwiki lookup table.
 314          */
 315         public static function tearDownInterwikis() {
 316                 Hooks::clear( 'InterwikiLoadPrefix' );
 317         }
 318
 319         public function setupRecorder( $options ) {
 320                 if ( isset( $options['record'] ) ) {
 321                         $this->recorder = new DbTestRecorder( $this );
 322                         $this->recorder->version = isset( $options['setversion'] ) ?
 323                                 $options['setversion'] : SpecialVersion::getVersion();
 324                 } elseif ( isset( $options['compare'] ) ) {
 325                         $this->recorder = new DbTestPreviewer( $this );
 326                 } else {
 327                         $this->recorder = new TestRecorder( $this );
 328                 }
 329         }
 330
 331         /**
 332          * Remove last character if it is a newline
 333          * @group utility
 334          * @param string $s
 335          * @return string
 336          */
 337         public static function chomp( $s ) {
 338                 if ( substr( $s, -1 ) === "\n" ) {
 339                         return substr( $s, 0, -1 );
 340                 } else {
 341                         return $s;
 342                 }
 343         }
 344
 345         /**
 346          * Run a fuzz test series
 347          * Draw input from a set of test files
 348          * @param array $filenames
 349          */
 350         function fuzzTest( $filenames ) {
 351                 $GLOBALS['wgContLang'] = Language::factory( 'en' );
 352                 $dict = $this->getFuzzInput( $filenames );
 353                 $dictSize = strlen( $dict );
 354                 $logMaxLength = log( $this->maxFuzzTestLength );
 355                 $this->setupDatabase();
 356                 ini_set( 'memory_limit', $this->memoryLimit * 1048576 );
 357
 358                 $numTotal = 0;
 359                 $numSuccess = 0;
 360                 $user = new User;
 361                 $opts = ParserOptions::newFromUser( $user );
 362                 $title = Title::makeTitle( NS_MAIN, 'Parser_test' );
 363
 364                 while ( true ) {
 365                         // Generate test input
 366                         mt_srand( ++$this->fuzzSeed );
 367                         $totalLength = mt_rand( 1, $this->maxFuzzTestLength );
 368                         $input = '';
 369
 370                         while ( strlen( $input ) < $totalLength ) {
 371                                 $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength;
 372                                 $hairLength = min( intval( exp( $logHairLength ) ), $dictSize );
 373                                 $offset = mt_rand( 0, $dictSize - $hairLength );
 374                                 $input .= substr( $dict, $offset, $hairLength );
 375                         }
 376
 377                         $this->setupGlobals();
 378                         $parser = $this->getParser();
 379
 380                         // Run the test
 381                         try {
 382                                 $parser->parse( $input, $title, $opts );
 383                                 $fail = false;
 384                         } catch ( Exception $exception ) {
 385                                 $fail = true;
 386                         }
 387
 388                         if ( $fail ) {
 389                                 echo "Test failed with seed {$this->fuzzSeed}\n";
 390                                 echo "Input:\n";
 391                                 printf( "string(%d) \"%s\"\n\n", strlen( $input ), $input );
 392                                 echo "$exception\n";
 393                         } else {
 394                                 $numSuccess++;
 395                         }
 396
 397                         $numTotal++;
 398                         $this->teardownGlobals();
 399                         $parser->__destruct();
 400
 401                         if ( $numTotal % 100 == 0 ) {
 402                                 $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 );
 403                                 echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n";
 404                                 if ( $usage > 90 ) {
 405                                         echo "Out of memory:\n";
 406                                         $memStats = $this->getMemoryBreakdown();
 407
 408                                         foreach ( $memStats as $name => $usage ) {
 409                                                 echo "$name: $usage\n";
 410                                         }
 411                                         $this->abort();
 412                                 }
 413                         }
 414                 }
 415         }
 416
 417         /**
 418          * Get an input dictionary from a set of parser test files
 419          * @param array $filenames
 420          * @return string
 421          */
 422         function getFuzzInput( $filenames ) {
 423                 $dict = '';
 424
 425                 foreach ( $filenames as $filename ) {
 426                         $contents = file_get_contents( $filename );
 427                         preg_match_all(
 428                                 '/!!\s*(input|wikitext)\n(.*?)\n!!\s*(result|html|html\/\*|html\/php)/s',
 429                                 $contents,
 430                                 $matches
 431                         );
 432
 433                         foreach ( $matches[1] as $match ) {
 434                                 $dict .= $match . "\n";
 435                         }
 436                 }
 437
 438                 return $dict;
 439         }
 440
 441         /**
 442          * Get a memory usage breakdown
 443          * @return array
 444          */
 445         function getMemoryBreakdown() {
 446                 $memStats = array();
 447
 448                 foreach ( $GLOBALS as $name => $value ) {
 449                         $memStats['$' . $name] = strlen( serialize( $value ) );
 450                 }
 451
 452                 $classes = get_declared_classes();
 453
 454                 foreach ( $classes as $class ) {
 455                         $rc = new ReflectionClass( $class );
 456                         $props = $rc->getStaticProperties();
 457                         $memStats[$class] = strlen( serialize( $props ) );
 458                         $methods = $rc->getMethods();
 459
 460                         foreach ( $methods as $method ) {
 461                                 $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) );
 462                         }
 463                 }
 464
 465                 $functions = get_defined_functions();
 466
 467                 foreach ( $functions['user'] as $function ) {
 468                         $rf = new ReflectionFunction( $function );
 469                         $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) );
 470                 }
 471
 472                 asort( $memStats );
 473
 474                 return $memStats;
 475         }
 476
 477         function abort() {
 478                 $this->abort();
 479         }
 480
 481         /**
 482          * Run a series of tests listed in the given text files.
 483          * Each test consists of a brief description, wikitext input,
 484          * and the expected HTML output.
 485          *
 486          * Prints status updates on stdout and counts up the total
 487          * number and percentage of passed tests.
 488          *
 489          * @param array $filenames Array of strings
 490          * @return bool True if passed all tests, false if any tests failed.
 491          */
 492         public function runTestsFromFiles( $filenames ) {
 493                 $ok = false;
 494
 495                 // be sure, ParserTest::addArticle has correct language set,
 496                 // so that system messages gets into the right language cache
 497                 $GLOBALS['wgLanguageCode'] = 'en';
 498                 $GLOBALS['wgContLang'] = Language::factory( 'en' );
 499
 500                 $this->recorder->start();
 501                 try {
 502                         $this->setupDatabase();
 503                         $ok = true;
 504
 505                         foreach ( $filenames as $filename ) {
 506                                 $tests = new TestFileIterator( $filename, $this );
 507                                 $ok = $this->runTests( $tests ) && $ok;
 508                         }
 509
 510                         $this->teardownDatabase();
 511                         $this->recorder->report();
 512                 } catch ( DBError $e ) {
 513                         echo $e->getMessage();
 514                 }
 515                 $this->recorder->end();
 516
 517                 return $ok;
 518         }
 519
 520         function runTests( $tests ) {
 521                 $ok = true;
 522
 523                 foreach ( $tests as $t ) {
 524                         $result =
 525                                 $this->runTest( $t['test'], $t['input'], $t['result'], $t['options'], $t['config'] );
 526                         $ok = $ok && $result;
 527                         $this->recorder->record( $t['test'], $result );
 528                 }
 529
 530                 if ( $this->showProgress ) {
 531                         print "\n";
 532                 }
 533
 534                 return $ok;
 535         }
 536
 537         /**
 538          * Get a Parser object
 539          *
 540          * @param string $preprocessor
 541          * @return Parser
 542          */
 543         function getParser( $preprocessor = null ) {
 544                 global $wgParserConf;
 545
 546                 $class = $wgParserConf['class'];
 547                 $parser = new $class( array( 'preprocessorClass' => $preprocessor ) + $wgParserConf );
 548
 549                 foreach ( $this->hooks as $tag => $callback ) {
 550                         $parser->setHook( $tag, $callback );
 551                 }
 552
 553                 foreach ( $this->functionHooks as $tag => $bits ) {
 554                         list( $callback, $flags ) = $bits;
 555                         $parser->setFunctionHook( $tag, $callback, $flags );
 556                 }
 557
 558                 foreach ( $this->transparentHooks as $tag => $callback ) {
 559                         $parser->setTransparentTagHook( $tag, $callback );
 560                 }
 561
 562                 Hooks::run( 'ParserTestParser', array( &$parser ) );
 563
 564                 return $parser;
 565         }
 566
 567         /**
 568          * Run a given wikitext input through a freshly-constructed wiki parser,
 569          * and compare the output against the expected results.
 570          * Prints status and explanatory messages to stdout.
 571          *
 572          * @param string $desc Test's description
 573          * @param string $input Wikitext to try rendering
 574          * @param string $result Result to output
 575          * @param array $opts Test's options
 576          * @param string $config Overrides for global variables, one per line
 577          * @return bool
 578          */
 579         public function runTest( $desc, $input, $result, $opts, $config ) {
 580                 if ( $this->showProgress ) {
 581                         $this->showTesting( $desc );
 582                 }
 583
 584                 $opts = $this->parseOptions( $opts );
 585                 $context = $this->setupGlobals( $opts, $config );
 586
 587                 $user = $context->getUser();
 588                 $options = ParserOptions::newFromContext( $context );
 589
 590                 if ( isset( $opts['djvu'] ) ) {
 591                         if ( !$this->djVuSupport->isEnabled() ) {
 592                                 return $this->showSkipped();
 593                         }
 594                 }
 595
 596                 if ( isset( $opts['tidy'] ) ) {
 597                         if ( !$this->tidySupport->isEnabled() ) {
 598                                 return $this->showSkipped();
 599                         } else {
 600                                 $options->setTidy( true );
 601                         }
 602                 }
 603
 604                 if ( isset( $opts['title'] ) ) {
 605                         $titleText = $opts['title'];
 606                 } else {
 607                         $titleText = 'Parser test';
 608                 }
 609
 610                 $local = isset( $opts['local'] );
 611                 $preprocessor = isset( $opts['preprocessor'] ) ? $opts['preprocessor'] : null;
 612                 $parser = $this->getParser( $preprocessor );
 613                 $title = Title::newFromText( $titleText );
 614
 615                 if ( isset( $opts['pst'] ) ) {
 616                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 617                 } elseif ( isset( $opts['msg'] ) ) {
 618                         $out = $parser->transformMsg( $input, $options, $title );
 619                 } elseif ( isset( $opts['section'] ) ) {
 620                         $section = $opts['section'];
 621                         $out = $parser->getSection( $input, $section );
 622                 } elseif ( isset( $opts['replace'] ) ) {
 623                         $section = $opts['replace'][0];
 624                         $replace = $opts['replace'][1];
 625                         $out = $parser->replaceSection( $input, $section, $replace );
 626                 } elseif ( isset( $opts['comment'] ) ) {
 627                         $out = Linker::formatComment( $input, $title, $local );
 628                 } elseif ( isset( $opts['preload'] ) ) {
 629                         $out = $parser->getPreloadText( $input, $title, $options );
 630                 } else {
 631                         $output = $parser->parse( $input, $title, $options, true, true, 1337 );
 632                         $output->setTOCEnabled( !isset( $opts['notoc'] ) );
 633                         $out = $output->getText();
 634                         if ( isset( $opts['tidy'] ) ) {
 635                                 $out = preg_replace( '/\s+$/', '', $out );
 636                         }
 637
 638                         if ( isset( $opts['showtitle'] ) ) {
 639                                 if ( $output->getTitleText() ) {
 640                                         $title = $output->getTitleText();
 641                                 }
 642
 643                                 $out = "$title\n$out";
 644                         }
 645
 646                         if ( isset( $opts['ill'] ) ) {
 647                                 $out = implode( ' ', $output->getLanguageLinks() );
 648                         } elseif ( isset( $opts['cat'] ) ) {
 649                                 $outputPage = $context->getOutput();
 650                                 $outputPage->addCategoryLinks( $output->getCategories() );
 651                                 $cats = $outputPage->getCategoryLinks();
 652
 653                                 if ( isset( $cats['normal'] ) ) {
 654                                         $out = implode( ' ', $cats['normal'] );
 655                                 } else {
 656                                         $out = '';
 657                                 }
 658                         }
 659                 }
 660
 661                 $this->teardownGlobals();
 662
 663                 $testResult = new ParserTestResult( $desc );
 664                 $testResult->expected = $result;
 665                 $testResult->actual = $out;
 666
 667                 return $this->showTestResult( $testResult );
 668         }
 669
 670         /**
 671          * Refactored in 1.22 to use ParserTestResult
 672          * @param ParserTestResult $testResult
 673          * @return bool
 674          */
 675         function showTestResult( ParserTestResult $testResult ) {
 676                 if ( $testResult->isSuccess() ) {
 677                         $this->showSuccess( $testResult );
 678                         return true;
 679                 } else {
 680                         $this->showFailure( $testResult );
 681                         return false;
 682                 }
 683         }
 684
 685         /**
 686          * Use a regex to find out the value of an option
 687          * @param string $key Name of option val to retrieve
 688          * @param array $opts Options array to look in
 689          * @param mixed $default Default value returned if not found
 690          * @return mixed
 691          */
 692         private static function getOptionValue( $key, $opts, $default ) {
 693                 $key = strtolower( $key );
 694
 695                 if ( isset( $opts[$key] ) ) {
 696                         return $opts[$key];
 697                 } else {
 698                         return $default;
 699                 }
 700         }
 701
 702         private function parseOptions( $instring ) {
 703                 $opts = array();
 704                 // foo
 705                 // foo=bar
 706                 // foo="bar baz"
 707                 // foo=[[bar baz]]
 708                 // foo=bar,"baz quux"
 709                 // foo={...json...}
 710                 $defs = '(?(DEFINE)
 711                         (?<qstr>                                        # Quoted string
 712                                 "
 713                                 (?:[^\\\\"] | \\\\.)*
 714                                 "
 715                         )
 716                         (?<json>
 717                                 \{              # Open bracket
 718                                 (?:
 719                                         [^"{}] |                                # Not a quoted string or object, or
 720                                         (?&qstr) |                              # A quoted string, or
 721                                         (?&json)                                # A json object (recursively)
 722                                 )*
 723                                 \}              # Close bracket
 724                         )
 725             (?<value>
 726                                 (?:
 727                                         (?&qstr)                        # Quoted val
 728                                 |
 729                                         \[\[
 730                                                 [^]]*                   # Link target
 731                                         \]\]
 732                                 |
 733                                         [\w-]+                          # Plain word
 734                                 |
 735                                         (?&json)                        # JSON object
 736                                 )
 737                         )
 738                 )';
 739                 $regex = '/' . $defs . '\b
 740                         (?<k>[\w-]+)                            # Key
 741                         \b
 742                         (?:\s*
 743                                 =                                               # First sub-value
 744                                 \s*
 745                                 (?<v>
 746                                         (?&value)
 747                                         (?:\s*
 748                                                 ,                               # Sub-vals 1..N
 749                                                 \s*
 750                                                 (?&value)
 751                                         )*
 752                                 )
 753                         )?
 754                         /x';
 755                 $valueregex = '/' . $defs . '(?&value)/x';
 756
 757                 if ( preg_match_all( $regex, $instring, $matches, PREG_SET_ORDER ) ) {
 758                         foreach ( $matches as $bits ) {
 759                                 $key = strtolower( $bits['k'] );
 760                                 if ( !isset( $bits['v'] ) ) {
 761                                         $opts[$key] = true;
 762                                 } else {
 763                                         preg_match_all( $valueregex, $bits['v'], $vmatches );
 764                                         $opts[$key] = array_map( array( $this, 'cleanupOption' ), $vmatches[0] );
 765                                         if ( count( $opts[$key] ) == 1 ) {
 766                                                 $opts[$key] = $opts[$key][0];
 767                                         }
 768                                 }
 769                         }
 770                 }
 771                 return $opts;
 772         }
 773
 774         private function cleanupOption( $opt ) {
 775                 if ( substr( $opt, 0, 1 ) == '"' ) {
 776                         return stripcslashes( substr( $opt, 1, -1 ) );
 777                 }
 778
 779                 if ( substr( $opt, 0, 2 ) == '[[' ) {
 780                         return substr( $opt, 2, -2 );
 781                 }
 782
 783                 if ( substr( $opt, 0, 1 ) == '{' ) {
 784                         return FormatJson::decode( $opt, true );
 785                 }
 786                 return $opt;
 787         }
 788
 789         /**
 790          * Set up the global variables for a consistent environment for each test.
 791          * Ideally this should replace the global configuration entirely.
 792          * @param string $opts
 793          * @param string $config
 794          * @return RequestContext
 795          */
 796         private function setupGlobals( $opts = '', $config = '' ) {
 797                 global $IP;
 798
 799                 # Find out values for some special options.
 800                 $lang =
 801                         self::getOptionValue( 'language', $opts, 'en' );
 802                 $variant =
 803                         self::getOptionValue( 'variant', $opts, false );
 804                 $maxtoclevel =
 805                         self::getOptionValue( 'wgMaxTocLevel', $opts, 999 );
 806                 $linkHolderBatchSize =
 807                         self::getOptionValue( 'wgLinkHolderBatchSize', $opts, 1000 );
 808
 809                 $settings = array(
 810                         'wgServer' => 'http://example.org',
 811                         'wgServerName' => 'example.org',
 812                         'wgScript' => '/index.php',
 813                         'wgScriptPath' => '/',
 814                         'wgArticlePath' => '/wiki/$1',
 815                         'wgActionPaths' => array(),
 816                         'wgLockManagers' => array( array(
 817                                 'name' => 'fsLockManager',
 818                                 'class' => 'FSLockManager',
 819                                 'lockDirectory' => $this->uploadDir . '/lockdir',
 820                         ), array(
 821                                 'name' => 'nullLockManager',
 822                                 'class' => 'NullLockManager',
 823                         ) ),
 824                         'wgLocalFileRepo' => array(
 825                                 'class' => 'LocalRepo',
 826                                 'name' => 'local',
 827                                 'url' => 'http://example.com/images',
 828                                 'hashLevels' => 2,
 829                                 'transformVia404' => false,
 830                                 'backend' => new FSFileBackend( array(
 831                                         'name' => 'local-backend',
 832                                         'wikiId' => wfWikiId(),
 833                                         'containerPaths' => array(
 834                                                 'local-public' => $this->uploadDir,
 835                                                 'local-thumb' => $this->uploadDir . '/thumb',
 836                                                 'local-temp' => $this->uploadDir . '/temp',
 837                                                 'local-deleted' => $this->uploadDir . '/delete',
 838                                         )
 839                                 ) )
 840                         ),
 841                         'wgEnableUploads' => self::getOptionValue( 'wgEnableUploads', $opts, true ),
 842                         'wgUploadNavigationUrl' => false,
 843                         'wgStylePath' => '/skins',
 844                         'wgSitename' => 'MediaWiki',
 845                         'wgLanguageCode' => $lang,
 846                         'wgDBprefix' => $this->db->getType() != 'oracle' ? 'parsertest_' : 'pt_',
 847                         'wgRawHtml' => self::getOptionValue( 'wgRawHtml', $opts, false ),
 848                         'wgLang' => null,
 849                         'wgContLang' => null,
 850                         'wgNamespacesWithSubpages' => array( 0 => isset( $opts['subpage'] ) ),
 851                         'wgMaxTocLevel' => $maxtoclevel,
 852                         'wgCapitalLinks' => true,
 853                         'wgNoFollowLinks' => true,
 854                         'wgNoFollowDomainExceptions' => array(),
 855                         'wgThumbnailScriptPath' => false,
 856                         'wgUseImageResize' => true,
 857                         'wgSVGConverter' => 'null',
 858                         'wgSVGConverters' => array( 'null' => 'echo "1">$output' ),
 859                         'wgLocaltimezone' => 'UTC',
 860                         'wgAllowExternalImages' => self::getOptionValue( 'wgAllowExternalImages', $opts, true ),
 861                         'wgThumbLimits' => array( self::getOptionValue( 'thumbsize', $opts, 180 ) ),
 862                         'wgDefaultLanguageVariant' => $variant,
 863                         'wgVariantArticlePath' => false,
 864                         'wgGroupPermissions' => array( '*' => array(
 865                                 'createaccount' => true,
 866                                 'read' => true,
 867                                 'edit' => true,
 868                                 'createpage' => true,
 869                                 'createtalk' => true,
 870                         ) ),
 871                         'wgNamespaceProtection' => array( NS_MEDIAWIKI => 'editinterface' ),
 872                         'wgDefaultExternalStore' => array(),
 873                         'wgForeignFileRepos' => array(),
 874                         'wgLinkHolderBatchSize' => $linkHolderBatchSize,
 875                         'wgExperimentalHtmlIds' => false,
 876                         'wgExternalLinkTarget' => false,
 877                         'wgHtml5' => true,
 878                         'wgWellFormedXml' => true,
 879                         'wgAllowMicrodataAttributes' => true,
 880                         'wgAdaptiveMessageCache' => true,
 881                         'wgDisableLangConversion' => false,
 882                         'wgDisableTitleConversion' => false,
 883                         // Tidy options.
 884                         'wgUseTidy' => isset( $opts['tidy'] ),
 885                         'wgAlwaysUseTidy' => false,
 886                         'wgDebugTidy' => false,
 887                         'wgTidyConf' => $IP . '/includes/tidy.conf',
 888                         'wgTidyOpts' => '',
 889                         'wgTidyInternal' => $this->tidySupport->isInternal(),
 890                 );
 891
 892                 if ( $config ) {
 893                         $configLines = explode( "\n", $config );
 894
 895                         foreach ( $configLines as $line ) {
 896                                 list( $var, $value ) = explode( '=', $line, 2 );
 897
 898                                 $settings[$var] = eval( "return $value;" );
 899                         }
 900                 }
 901
 902                 $this->savedGlobals = array();
 903
 904                 /** @since 1.20 */
 905                 Hooks::run( 'ParserTestGlobals', array( &$settings ) );
 906
 907                 foreach ( $settings as $var => $val ) {
 908                         if ( array_key_exists( $var, $GLOBALS ) ) {
 909                                 $this->savedGlobals[$var] = $GLOBALS[$var];
 910                         }
 911
 912                         $GLOBALS[$var] = $val;
 913                 }
 914
 915                 $GLOBALS['wgContLang'] = Language::factory( $lang );
 916                 $GLOBALS['wgMemc'] = new EmptyBagOStuff;
 917
 918                 $context = new RequestContext();
 919                 $GLOBALS['wgLang'] = $context->getLanguage();
 920                 $GLOBALS['wgOut'] = $context->getOutput();
 921                 $GLOBALS['wgUser'] = $context->getUser();
 922
 923                 // We (re)set $wgThumbLimits to a single-element array above.
 924                 $context->getUser()->setOption( 'thumbsize', 0 );
 925
 926                 global $wgHooks;
 927
 928                 $wgHooks['ParserTestParser'][] = 'ParserTestParserHook::setup';
 929                 $wgHooks['ParserGetVariableValueTs'][] = 'ParserTest::getFakeTimestamp';
 930
 931                 MagicWord::clearCache();
 932
 933                 return $context;
 934         }
 935
 936         /**
 937          * List of temporary tables to create, without prefix.
 938          * Some of these probably aren't necessary.
 939          * @return array
 940          */
 941         private function listTables() {
 942                 $tables = array( 'user', 'user_properties', 'user_former_groups', 'page', 'page_restrictions',
 943                         'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
 944                         'categorylinks', 'templatelinks', 'externallinks', 'langlinks', 'iwlinks',
 945                         'site_stats', 'ipblocks', 'image', 'oldimage',
 946                         'recentchanges', 'watchlist', 'interwiki', 'logging',
 947                         'querycache', 'objectcache', 'job', 'l10n_cache', 'redirect', 'querycachetwo',
 948                         'archive', 'user_groups', 'page_props', 'category', 'msg_resource', 'msg_resource_links'
 949                 );
 950
 951                 if ( in_array( $this->db->getType(), array( 'mysql', 'sqlite', 'oracle' ) ) ) {
 952                         array_push( $tables, 'searchindex' );
 953                 }
 954
 955                 // Allow extensions to add to the list of tables to duplicate;
 956                 // may be necessary if they hook into page save or other code
 957                 // which will require them while running tests.
 958                 Hooks::run( 'ParserTestTables', array( &$tables ) );
 959
 960                 return $tables;
 961         }
 962
 963         /**
 964          * Set up a temporary set of wiki tables to work with for the tests.
 965          * Currently this will only be done once per run, and any changes to
 966          * the db will be visible to later tests in the run.
 967          */
 968         public function setupDatabase() {
 969                 global $wgDBprefix;
 970
 971                 if ( $this->databaseSetupDone ) {
 972                         return;
 973                 }
 974
 975                 $this->db = wfGetDB( DB_MASTER );
 976                 $dbType = $this->db->getType();
 977
 978                 if ( $wgDBprefix === 'parsertest_' || ( $dbType == 'oracle' && $wgDBprefix === 'pt_' ) ) {
 979                         throw new MWException( 'setupDatabase should be called before setupGlobals' );
 980                 }
 981
 982                 $this->databaseSetupDone = true;
 983
 984                 # SqlBagOStuff broke when using temporary tables on r40209 (bug 15892).
 985                 # It seems to have been fixed since (r55079?), but regressed at some point before r85701.
 986                 # This works around it for now...
 987                 ObjectCache::$instances[CACHE_DB] = new HashBagOStuff;
 988
 989                 # CREATE TEMPORARY TABLE breaks if there is more than one server
 990                 if ( wfGetLB()->getServerCount() != 1 ) {
 991                         $this->useTemporaryTables = false;
 992                 }
 993
 994                 $temporary = $this->useTemporaryTables || $dbType == 'postgres';
 995                 $prefix = $dbType != 'oracle' ? 'parsertest_' : 'pt_';
 996
 997                 $this->dbClone = new CloneDatabase( $this->db, $this->listTables(), $prefix );
 998                 $this->dbClone->useTemporaryTables( $temporary );
 999                 $this->dbClone->cloneTableStructure();
1000
1001                 if ( $dbType == 'oracle' ) {
1002                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1003                         # Insert 0 user to prevent FK violations
1004
1005                         # Anonymous user
1006                         $this->db->insert( 'user', array(
1007                                 'user_id' => 0,
1008                                 'user_name' => 'Anonymous' ) );
1009                 }
1010
1011                 # Update certain things in site_stats
1012                 $this->db->insert( 'site_stats',
1013                         array( 'ss_row_id' => 1, 'ss_images' => 2, 'ss_good_articles' => 1 ) );
1014
1015                 # Reinitialise the LocalisationCache to match the database state
1016                 Language::getLocalisationCache()->unloadAll();
1017
1018                 # Clear the message cache
1019                 MessageCache::singleton()->clear();
1020
1021                 // Remember to update newParserTests.php after changing the below
1022                 // (and it uses a slightly different syntax just for teh lulz)
1023                 $this->uploadDir = $this->setupUploadDir();
1024                 $user = User::createNew( 'WikiSysop' );
1025                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.jpg' ) );
1026                 # note that the size/width/height/bits/etc of the file
1027                 # are actually set by inspecting the file itself; the arguments
1028                 # to recordUpload2 have no effect.  That said, we try to make things
1029                 # match up so it is less confusing to readers of the code & tests.
1030                 $image->recordUpload2( '', 'Upload of some lame file', 'Some lame file', array(
1031                         'size' => 7881,
1032                         'width' => 1941,
1033                         'height' => 220,
1034                         'bits' => 8,
1035                         'media_type' => MEDIATYPE_BITMAP,
1036                         'mime' => 'image/jpeg',
1037                         'metadata' => serialize( array() ),
1038                         'sha1' => wfBaseConvert( '1', 16, 36, 31 ),
1039                         'fileExists' => true
1040                 ), $this->db->timestamp( '20010115123500' ), $user );
1041
1042                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Thumb.png' ) );
1043                 # again, note that size/width/height below are ignored; see above.
1044                 $image->recordUpload2( '', 'Upload of some lame thumbnail', 'Some lame thumbnail', array(
1045                         'size' => 22589,
1046                         'width' => 135,
1047                         'height' => 135,
1048                         'bits' => 8,
1049                         'media_type' => MEDIATYPE_BITMAP,
1050                         'mime' => 'image/png',
1051                         'metadata' => serialize( array() ),
1052                         'sha1' => wfBaseConvert( '2', 16, 36, 31 ),
1053                         'fileExists' => true
1054                 ), $this->db->timestamp( '20130225203040' ), $user );
1055
1056                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Foobar.svg' ) );
1057                 $image->recordUpload2( '', 'Upload of some lame SVG', 'Some lame SVG', array(
1058                                 'size'        => 12345,
1059                                 'width'       => 240,
1060                                 'height'      => 180,
1061                                 'bits'        => 0,
1062                                 'media_type'  => MEDIATYPE_DRAWING,
1063                                 'mime'        => 'image/svg+xml',
1064                                 'metadata'    => serialize( array() ),
1065                                 'sha1'        => wfBaseConvert( '', 16, 36, 31 ),
1066                                 'fileExists'  => true
1067                 ), $this->db->timestamp( '20010115123500' ), $user );
1068
1069                 # This image will be blacklisted in [[MediaWiki:Bad image list]]
1070                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'Bad.jpg' ) );
1071                 $image->recordUpload2( '', 'zomgnotcensored', 'Borderline image', array(
1072                         'size' => 12345,
1073                         'width' => 320,
1074                         'height' => 240,
1075                         'bits' => 24,
1076                         'media_type' => MEDIATYPE_BITMAP,
1077                         'mime' => 'image/jpeg',
1078                         'metadata' => serialize( array() ),
1079                         'sha1' => wfBaseConvert( '3', 16, 36, 31 ),
1080                         'fileExists' => true
1081                 ), $this->db->timestamp( '20010115123500' ), $user );
1082
1083                 # A DjVu file
1084                 $image = wfLocalFile( Title::makeTitle( NS_FILE, 'LoremIpsum.djvu' ) );
1085                 $image->recordUpload2( '', 'Upload a DjVu', 'A DjVu', array(
1086                         'size' => 3249,
1087                         'width' => 2480,
1088                         'height' => 3508,
1089                         'bits' => 0,
1090                         'media_type' => MEDIATYPE_BITMAP,
1091                         'mime' => 'image/vnd.djvu',
1092                         'metadata' => '<?xml version="1.0" ?>
1093 <!DOCTYPE DjVuXML PUBLIC "-//W3C//DTD DjVuXML 1.1//EN" "pubtext/DjVuXML-s.dtd">
1094 <DjVuXML>
1095 <HEAD></HEAD>
1096 <BODY><OBJECT height="3508" width="2480">
1097 <PARAM name="DPI" value="300" />
1098 <PARAM name="GAMMA" value="2.2" />
1099 </OBJECT>
1100 <OBJECT height="3508" width="2480">
1101 <PARAM name="DPI" value="300" />
1102 <PARAM name="GAMMA" value="2.2" />
1103 </OBJECT>
1104 <OBJECT height="3508" width="2480">
1105 <PARAM name="DPI" value="300" />
1106 <PARAM name="GAMMA" value="2.2" />
1107 </OBJECT>
1108 <OBJECT height="3508" width="2480">
1109 <PARAM name="DPI" value="300" />
1110 <PARAM name="GAMMA" value="2.2" />
1111 </OBJECT>
1112 <OBJECT height="3508" width="2480">
1113 <PARAM name="DPI" value="300" />
1114 <PARAM name="GAMMA" value="2.2" />
1115 </OBJECT>
1116 </BODY>
1117 </DjVuXML>',
1118                         'sha1' => wfBaseConvert( '', 16, 36, 31 ),
1119                         'fileExists' => true
1120                 ), $this->db->timestamp( '20010115123600' ), $user );
1121         }
1122
1123         public function teardownDatabase() {
1124                 if ( !$this->databaseSetupDone ) {
1125                         $this->teardownGlobals();
1126                         return;
1127                 }
1128                 $this->teardownUploadDir( $this->uploadDir );
1129
1130                 $this->dbClone->destroy();
1131                 $this->databaseSetupDone = false;
1132
1133                 if ( $this->useTemporaryTables ) {
1134                         if ( $this->db->getType() == 'sqlite' ) {
1135                                 # Under SQLite the searchindex table is virtual and need
1136                                 # to be explicitly destroyed. See bug 29912
1137                                 # See also MediaWikiTestCase::destroyDB()
1138                                 wfDebug( __METHOD__ . " explicitly destroying sqlite virtual table parsertest_searchindex\n" );
1139                                 $this->db->query( "DROP TABLE `parsertest_searchindex`" );
1140                         }
1141                         # Don't need to do anything
1142                         $this->teardownGlobals();
1143                         return;
1144                 }
1145
1146                 $tables = $this->listTables();
1147
1148                 foreach ( $tables as $table ) {
1149                         if ( $this->db->getType() == 'oracle' ) {
1150                                 $this->db->query( "DROP TABLE pt_$table DROP CONSTRAINTS" );
1151                         } else {
1152                                 $this->db->query( "DROP TABLE `parsertest_$table`" );
1153                         }
1154                 }
1155
1156                 if ( $this->db->getType() == 'oracle' ) {
1157                         $this->db->query( 'BEGIN FILL_WIKI_INFO; END;' );
1158                 }
1159
1160                 $this->teardownGlobals();
1161         }
1162
1163         /**
1164          * Create a dummy uploads directory which will contain a couple
1165          * of files in order to pass existence tests.
1166          *
1167          * @return string The directory
1168          */
1169         private function setupUploadDir() {
1170                 global $IP;
1171
1172                 if ( $this->keepUploads ) {
1173                         $dir = wfTempDir() . '/mwParser-images';
1174
1175                         if ( is_dir( $dir ) ) {
1176                                 return $dir;
1177                         }
1178                 } else {
1179                         $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
1180                 }
1181
1182                 // wfDebug( "Creating upload directory $dir\n" );
1183                 if ( file_exists( $dir ) ) {
1184                         wfDebug( "Already exists!\n" );
1185                         return $dir;
1186                 }
1187
1188                 wfMkdirParents( $dir . '/3/3a', null, __METHOD__ );
1189                 copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
1190                 wfMkdirParents( $dir . '/e/ea', null, __METHOD__ );
1191                 copy( "$IP/tests/phpunit/data/parser/wiki.png", "$dir/e/ea/Thumb.png" );
1192                 wfMkdirParents( $dir . '/0/09', null, __METHOD__ );
1193                 copy( "$IP/tests/phpunit/data/parser/headbg.jpg", "$dir/0/09/Bad.jpg" );
1194                 wfMkdirParents( $dir . '/f/ff', null, __METHOD__ );
1195                 file_put_contents( "$dir/f/ff/Foobar.svg",
1196                         '<?xml version="1.0" encoding="utf-8"?>' .
1197                         '<svg xmlns="http://www.w3.org/2000/svg"' .
1198                         ' version="1.1" width="240" height="180"/>' );
1199                 wfMkdirParents( $dir . '/5/5f', null, __METHOD__ );
1200                 copy( "$IP/tests/phpunit/data/parser/LoremIpsum.djvu", "$dir/5/5f/LoremIpsum.djvu" );
1201
1202                 return $dir;
1203         }
1204
1205         /**
1206          * Restore default values and perform any necessary clean-up
1207          * after each test runs.
1208          */
1209         private function teardownGlobals() {
1210                 RepoGroup::destroySingleton();
1211                 FileBackendGroup::destroySingleton();
1212                 LockManagerGroup::destroySingletons();
1213                 LinkCache::singleton()->clear();
1214
1215                 foreach ( $this->savedGlobals as $var => $val ) {
1216                         $GLOBALS[$var] = $val;
1217                 }
1218         }
1219
1220         /**
1221          * Remove the dummy uploads directory
1222          * @param string $dir
1223          */
1224         private function teardownUploadDir( $dir ) {
1225                 if ( $this->keepUploads ) {
1226                         return;
1227                 }
1228
1229                 // delete the files first, then the dirs.
1230                 self::deleteFiles(
1231                         array(
1232                                 "$dir/3/3a/Foobar.jpg",
1233                                 "$dir/thumb/3/3a/Foobar.jpg/1000px-Foobar.jpg",
1234                                 "$dir/thumb/3/3a/Foobar.jpg/100px-Foobar.jpg",
1235                                 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
1236                                 "$dir/thumb/3/3a/Foobar.jpg/1280px-Foobar.jpg",
1237                                 "$dir/thumb/3/3a/Foobar.jpg/137px-Foobar.jpg",
1238                                 "$dir/thumb/3/3a/Foobar.jpg/1500px-Foobar.jpg",
1239                                 "$dir/thumb/3/3a/Foobar.jpg/177px-Foobar.jpg",
1240                                 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
1241                                 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
1242                                 "$dir/thumb/3/3a/Foobar.jpg/206px-Foobar.jpg",
1243                                 "$dir/thumb/3/3a/Foobar.jpg/20px-Foobar.jpg",
1244                                 "$dir/thumb/3/3a/Foobar.jpg/220px-Foobar.jpg",
1245                                 "$dir/thumb/3/3a/Foobar.jpg/265px-Foobar.jpg",
1246                                 "$dir/thumb/3/3a/Foobar.jpg/270px-Foobar.jpg",
1247                                 "$dir/thumb/3/3a/Foobar.jpg/274px-Foobar.jpg",
1248                                 "$dir/thumb/3/3a/Foobar.jpg/300px-Foobar.jpg",
1249                                 "$dir/thumb/3/3a/Foobar.jpg/30px-Foobar.jpg",
1250                                 "$dir/thumb/3/3a/Foobar.jpg/330px-Foobar.jpg",
1251                                 "$dir/thumb/3/3a/Foobar.jpg/353px-Foobar.jpg",
1252                                 "$dir/thumb/3/3a/Foobar.jpg/360px-Foobar.jpg",
1253                                 "$dir/thumb/3/3a/Foobar.jpg/400px-Foobar.jpg",
1254                                 "$dir/thumb/3/3a/Foobar.jpg/40px-Foobar.jpg",
1255                                 "$dir/thumb/3/3a/Foobar.jpg/440px-Foobar.jpg",
1256                                 "$dir/thumb/3/3a/Foobar.jpg/442px-Foobar.jpg",
1257                                 "$dir/thumb/3/3a/Foobar.jpg/450px-Foobar.jpg",
1258                                 "$dir/thumb/3/3a/Foobar.jpg/50px-Foobar.jpg",
1259                                 "$dir/thumb/3/3a/Foobar.jpg/600px-Foobar.jpg",
1260                                 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
1261                                 "$dir/thumb/3/3a/Foobar.jpg/70px-Foobar.jpg",
1262                                 "$dir/thumb/3/3a/Foobar.jpg/75px-Foobar.jpg",
1263                                 "$dir/thumb/3/3a/Foobar.jpg/960px-Foobar.jpg",
1264
1265                                 "$dir/e/ea/Thumb.png",
1266
1267                                 "$dir/0/09/Bad.jpg",
1268
1269                                 "$dir/5/5f/LoremIpsum.djvu",
1270                                 "$dir/thumb/5/5f/LoremIpsum.djvu/page2-2480px-LoremIpsum.djvu.jpg",
1271                                 "$dir/thumb/5/5f/LoremIpsum.djvu/page2-3720px-LoremIpsum.djvu.jpg",
1272                                 "$dir/thumb/5/5f/LoremIpsum.djvu/page2-4960px-LoremIpsum.djvu.jpg",
1273
1274                                 "$dir/f/ff/Foobar.svg",
1275                                 "$dir/thumb/f/ff/Foobar.svg/180px-Foobar.svg.png",
1276                                 "$dir/thumb/f/ff/Foobar.svg/2000px-Foobar.svg.png",
1277                                 "$dir/thumb/f/ff/Foobar.svg/270px-Foobar.svg.png",
1278                                 "$dir/thumb/f/ff/Foobar.svg/3000px-Foobar.svg.png",
1279                                 "$dir/thumb/f/ff/Foobar.svg/360px-Foobar.svg.png",
1280                                 "$dir/thumb/f/ff/Foobar.svg/4000px-Foobar.svg.png",
1281                                 "$dir/thumb/f/ff/Foobar.svg/langde-180px-Foobar.svg.png",
1282                                 "$dir/thumb/f/ff/Foobar.svg/langde-270px-Foobar.svg.png",
1283                                 "$dir/thumb/f/ff/Foobar.svg/langde-360px-Foobar.svg.png",
1284
1285                                 "$dir/math/f/a/5/fa50b8b616463173474302ca3e63586b.png",
1286                         )
1287                 );
1288
1289                 self::deleteDirs(
1290                         array(
1291                                 "$dir/3/3a",
1292                                 "$dir/3",
1293                                 "$dir/thumb/3/3a/Foobar.jpg",
1294                                 "$dir/thumb/3/3a",
1295                                 "$dir/thumb/3",
1296                                 "$dir/e/ea",
1297                                 "$dir/e",
1298                                 "$dir/f/ff/",
1299                                 "$dir/f/",
1300                                 "$dir/thumb/f/ff/Foobar.svg",
1301                                 "$dir/thumb/f/ff/",
1302                                 "$dir/thumb/f/",
1303                                 "$dir/0/09/",
1304                                 "$dir/0/",
1305                                 "$dir/5/5f",
1306                                 "$dir/5",
1307                                 "$dir/thumb/5/5f/LoremIpsum.djvu",
1308                                 "$dir/thumb/5/5f",
1309                                 "$dir/thumb/5",
1310                                 "$dir/thumb",
1311                                 "$dir/math/f/a/5",
1312                                 "$dir/math/f/a",
1313                                 "$dir/math/f",
1314                                 "$dir/math",
1315                                 "$dir",
1316                         )
1317                 );
1318         }
1319
1320         /**
1321          * Delete the specified files, if they exist.
1322          * @param array $files Full paths to files to delete.
1323          */
1324         private static function deleteFiles( $files ) {
1325                 foreach ( $files as $file ) {
1326                         if ( file_exists( $file ) ) {
1327                                 unlink( $file );
1328                         }
1329                 }
1330         }
1331
1332         /**
1333          * Delete the specified directories, if they exist. Must be empty.
1334          * @param array $dirs Full paths to directories to delete.
1335          */
1336         private static function deleteDirs( $dirs ) {
1337                 foreach ( $dirs as $dir ) {
1338                         if ( is_dir( $dir ) ) {
1339                                 rmdir( $dir );
1340                         }
1341                 }
1342         }
1343
1344         /**
1345          * "Running test $desc..."
1346          * @param string $desc
1347          */
1348         protected function showTesting( $desc ) {
1349                 print "Running test $desc... ";
1350         }
1351
1352         /**
1353          * Print a happy success message.
1354          *
1355          * Refactored in 1.22 to use ParserTestResult
1356          *
1357          * @param ParserTestResult $testResult
1358          * @return bool
1359          */
1360         protected function showSuccess( ParserTestResult $testResult ) {
1361                 if ( $this->showProgress ) {
1362                         print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
1363                 }
1364
1365                 return true;
1366         }
1367
1368         /**
1369          * Print a failure message and provide some explanatory output
1370          * about what went wrong if so configured.
1371          *
1372          * Refactored in 1.22 to use ParserTestResult
1373          *
1374          * @param ParserTestResult $testResult
1375          * @return bool
1376          */
1377         protected function showFailure( ParserTestResult $testResult ) {
1378                 if ( $this->showFailure ) {
1379                         if ( !$this->showProgress ) {
1380                                 # In quiet mode we didn't show the 'Testing' message before the
1381                                 # test, in case it succeeded. Show it now:
1382                                 $this->showTesting( $testResult->description );
1383                         }
1384
1385                         print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
1386
1387                         if ( $this->showOutput ) {
1388                                 print "--- Expected ---\n{$testResult->expected}\n";
1389                                 print "--- Actual ---\n{$testResult->actual}\n";
1390                         }
1391
1392                         if ( $this->showDiffs ) {
1393                                 print $this->quickDiff( $testResult->expected, $testResult->actual );
1394                                 if ( !$this->wellFormed( $testResult->actual ) ) {
1395                                         print "XML error: $this->mXmlError\n";
1396                                 }
1397                         }
1398                 }
1399
1400                 return false;
1401         }
1402
1403         /**
1404          * Print a skipped message.
1405          *
1406          * @return bool
1407          */
1408         protected function showSkipped() {
1409                 if ( $this->showProgress ) {
1410                         print $this->term->color( '1;33' ) . 'SKIPPED' . $this->term->reset() . "\n";
1411                 }
1412
1413                 return true;
1414         }
1415
1416         /**
1417          * Run given strings through a diff and return the (colorized) output.
1418          * Requires writable /tmp directory and a 'diff' command in the PATH.
1419          *
1420          * @param string $input
1421          * @param string $output
1422          * @param string $inFileTail Tailing for the input file name
1423          * @param string $outFileTail Tailing for the output file name
1424          * @return string
1425          */
1426         protected function quickDiff( $input, $output,
1427                 $inFileTail = 'expected', $outFileTail = 'actual'
1428         ) {
1429                 # Windows, or at least the fc utility, is retarded
1430                 $slash = wfIsWindows() ? '\\' : '/';
1431                 $prefix = wfTempDir() . "{$slash}mwParser-" . mt_rand();
1432
1433                 $infile = "$prefix-$inFileTail";
1434                 $this->dumpToFile( $input, $infile );
1435
1436                 $outfile = "$prefix-$outFileTail";
1437                 $this->dumpToFile( $output, $outfile );
1438
1439                 $shellInfile = wfEscapeShellArg( $infile );
1440                 $shellOutfile = wfEscapeShellArg( $outfile );
1441
1442                 global $wgDiff3;
1443                 // we assume that people with diff3 also have usual diff
1444                 $shellCommand = ( wfIsWindows() && !$wgDiff3 ) ? 'fc' : 'diff -au';
1445
1446                 $diff = wfShellExec( "$shellCommand $shellInfile $shellOutfile" );
1447
1448                 unlink( $infile );
1449                 unlink( $outfile );
1450
1451                 return $this->colorDiff( $diff );
1452         }
1453
1454         /**
1455          * Write the given string to a file, adding a final newline.
1456          *
1457          * @param string $data
1458          * @param string $filename
1459          */
1460         private function dumpToFile( $data, $filename ) {
1461                 $file = fopen( $filename, "wt" );
1462                 fwrite( $file, $data . "\n" );
1463                 fclose( $file );
1464         }
1465
1466         /**
1467          * Colorize unified diff output if set for ANSI color output.
1468          * Subtractions are colored blue, additions red.
1469          *
1470          * @param string $text
1471          * @return string
1472          */
1473         protected function colorDiff( $text ) {
1474                 return preg_replace(
1475                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
1476                         array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
1477                                 $this->term->color( 31 ) . '$1' . $this->term->reset() ),
1478                         $text );
1479         }
1480
1481         /**
1482          * Show "Reading tests from ..."
1483          *
1484          * @param string $path
1485          */
1486         public function showRunFile( $path ) {
1487                 print $this->term->color( 1 ) .
1488                         "Reading tests from \"$path\"..." .
1489                         $this->term->reset() .
1490                         "\n";
1491         }
1492
1493         /**
1494          * Insert a temporary test article
1495          * @param string $name The title, including any prefix
1496          * @param string $text The article text
1497          * @param int|string $line The input line number, for reporting errors
1498          * @param bool|string $ignoreDuplicate Whether to silently ignore duplicate pages
1499          * @throws Exception
1500          * @throws MWException
1501          */
1502         public static function addArticle( $name, $text, $line = 'unknown', $ignoreDuplicate = '' ) {
1503                 global $wgCapitalLinks;
1504
1505                 $oldCapitalLinks = $wgCapitalLinks;
1506                 $wgCapitalLinks = true; // We only need this from SetupGlobals() See r70917#c8637
1507
1508                 $text = self::chomp( $text );
1509                 $name = self::chomp( $name );
1510
1511                 $title = Title::newFromText( $name );
1512
1513                 if ( is_null( $title ) ) {
1514                         throw new MWException( "invalid title '$name' at line $line\n" );
1515                 }
1516
1517                 $page = WikiPage::factory( $title );
1518                 $page->loadPageData( 'fromdbmaster' );
1519
1520                 if ( $page->exists() ) {
1521                         if ( $ignoreDuplicate == 'ignoreduplicate' ) {
1522                                 return;
1523                         } else {
1524                                 throw new MWException( "duplicate article '$name' at line $line\n" );
1525                         }
1526                 }
1527
1528                 $page->doEditContent( ContentHandler::makeContent( $text, $title ), '', EDIT_NEW );
1529
1530                 $wgCapitalLinks = $oldCapitalLinks;
1531         }
1532
1533         /**
1534          * Steal a callback function from the primary parser, save it for
1535          * application to our scary parser. If the hook is not installed,
1536          * abort processing of this file.
1537          *
1538          * @param string $name
1539          * @return bool True if tag hook is present
1540          */
1541         public function requireHook( $name ) {
1542                 global $wgParser;
1543
1544                 $wgParser->firstCallInit(); // make sure hooks are loaded.
1545
1546                 if ( isset( $wgParser->mTagHooks[$name] ) ) {
1547                         $this->hooks[$name] = $wgParser->mTagHooks[$name];
1548                 } else {
1549                         echo "   This test suite requires the '$name' hook extension, skipping.\n";
1550                         return false;
1551                 }
1552
1553                 return true;
1554         }
1555
1556         /**
1557          * Steal a callback function from the primary parser, save it for
1558          * application to our scary parser. If the hook is not installed,
1559          * abort processing of this file.
1560          *
1561          * @param string $name
1562          * @return bool True if function hook is present
1563          */
1564         public function requireFunctionHook( $name ) {
1565                 global $wgParser;
1566
1567                 $wgParser->firstCallInit(); // make sure hooks are loaded.
1568
1569                 if ( isset( $wgParser->mFunctionHooks[$name] ) ) {
1570                         $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
1571                 } else {
1572                         echo "   This test suite requires the '$name' function hook extension, skipping.\n";
1573                         return false;
1574                 }
1575
1576                 return true;
1577         }
1578
1579         /**
1580          * Steal a callback function from the primary parser, save it for
1581          * application to our scary parser. If the hook is not installed,
1582          * abort processing of this file.
1583          *
1584          * @param string $name
1585          * @return bool True if function hook is present
1586          */
1587         public function requireTransparentHook( $name ) {
1588                 global $wgParser;
1589
1590                 $wgParser->firstCallInit(); // make sure hooks are loaded.
1591
1592                 if ( isset( $wgParser->mTransparentTagHooks[$name] ) ) {
1593                         $this->transparentHooks[$name] = $wgParser->mTransparentTagHooks[$name];
1594                 } else {
1595                         echo "   This test suite requires the '$name' transparent hook extension, skipping.\n";
1596                         return false;
1597                 }
1598
1599                 return true;
1600         }
1601
1602         private function wellFormed( $text ) {
1603                 $html =
1604                         Sanitizer::hackDocType() .
1605                                 '<html>' .
1606                                 $text .
1607                                 '</html>';
1608
1609                 $parser = xml_parser_create( "UTF-8" );
1610
1611                 # case folding violates XML standard, turn it off
1612                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
1613
1614                 if ( !xml_parse( $parser, $html, true ) ) {
1615                         $err = xml_error_string( xml_get_error_code( $parser ) );
1616                         $position = xml_get_current_byte_index( $parser );
1617                         $fragment = $this->extractFragment( $html, $position );
1618                         $this->mXmlError = "$err at byte $position:\n$fragment";
1619                         xml_parser_free( $parser );
1620
1621                         return false;
1622                 }
1623
1624                 xml_parser_free( $parser );
1625
1626                 return true;
1627         }
1628
1629         private function extractFragment( $text, $position ) {
1630                 $start = max( 0, $position - 10 );
1631                 $before = $position - $start;
1632                 $fragment = '...' .
1633                         $this->term->color( 34 ) .
1634                         substr( $text, $start, $before ) .
1635                         $this->term->color( 0 ) .
1636                         $this->term->color( 31 ) .
1637                         $this->term->color( 1 ) .
1638                         substr( $text, $position, 1 ) .
1639                         $this->term->color( 0 ) .
1640                         $this->term->color( 34 ) .
1641                         substr( $text, $position + 1, 9 ) .
1642                         $this->term->color( 0 ) .
1643                         '...';
1644                 $display = str_replace( "\n", ' ', $fragment );
1645                 $caret = '   ' .
1646                         str_repeat( ' ', $before ) .
1647                         $this->term->color( 31 ) .
1648                         '^' .
1649                         $this->term->color( 0 );
1650
1651                 return "$display\n$caret";
1652         }
1653
1654         static function getFakeTimestamp( &$parser, &$ts ) {
1655                 $ts = 123; //parsed as '1970-01-01T00:02:03Z'
1656                 return true;
1657         }
1658 }