maintenance/parserTests.inc

   1 <?php
   2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
   3 # http://www.mediawiki.org/
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  * @todo Make this more independent of the configuration (and if possible the database)
  22  * @todo document
  23  * @package MediaWiki
  24  * @subpackage Maintenance
  25  */
  26
  27 /** */
  28 $options = array( 'quick', 'color', 'quiet', 'help' );
  29 $optionsWithArgs = array( 'regex' );
  30
  31 require_once( 'commandLine.inc' );
  32 require_once( "$IP/includes/ObjectCache.php" );
  33 require_once( "$IP/includes/BagOStuff.php" );
  34 require_once( "$IP/languages/LanguageUtf8.php" );
  35 require_once( "$IP/includes/Hooks.php" );
  36 require_once( "$IP/maintenance/parserTestsParserHook.php" );
  37 require_once( "$IP/maintenance/parserTestsParserTime.php" );
  38
  39 /**
  40  * @package MediaWiki
  41  * @subpackage Maintenance
  42  */
  43 class ParserTest {
  44         /**
  45          * boolean $color whereas output should be colorized
  46          * @access private
  47          */
  48         var $color;
  49
  50         /**
  51          * boolean $lightcolor whereas output should use light colors
  52          * @access private
  53          */
  54         var $lightcolor;
  55
  56         /**
  57          * Sets terminal colorization and diff/quick modes depending on OS and
  58          * command-line options (--color and --quick).
  59          *
  60          * @access public
  61          */
  62         function ParserTest() {
  63                 global $options;
  64
  65                 # Only colorize output if stdout is a terminal.
  66                 $this->lightcolor = false;
  67                 $this->color = !wfIsWindows() && posix_isatty(1);
  68
  69                 if( isset( $options['color'] ) ) {
  70                         switch( $options['color'] ) {
  71                         case 'no':
  72                                 $this->color = false;
  73                                 break;
  74                         case 'light':
  75                                 $this->lightcolor = true;
  76                                 # Fall through
  77                         case 'yes':
  78                         default:
  79                                 $this->color = true;
  80                                 break;
  81                         }
  82                 }
  83
  84                 $this->showDiffs = !isset( $options['quick'] );
  85
  86                 $this->quiet = isset( $options['quiet'] );
  87
  88                 if (isset($options['regex'])) {
  89                         $this->regex = $options['regex'];
  90                 } else {
  91                         # Matches anything
  92                         $this->regex = '';
  93                 }
  94         }
  95
  96         /**
  97          * Remove last character if it is a newline
  98          * @access private
  99          */
 100         function chomp($s) {
 101                 if (substr($s, -1) === "\n") {
 102                         return substr($s, 0, -1);
 103                 }
 104                 else {
 105                         return $s;
 106                 }
 107         }
 108
 109         /**
 110          * Run a series of tests listed in the given text file.
 111          * Each test consists of a brief description, wikitext input,
 112          * and the expected HTML output.
 113          *
 114          * Prints status updates on stdout and counts up the total
 115          * number and percentage of passed tests.
 116          *
 117          * @param string $filename
 118          * @return bool True if passed all tests, false if any tests failed.
 119          * @access public
 120          */
 121         function runTestsFromFile( $filename ) {
 122                 $infile = fopen( $filename, 'rt' );
 123                 if( !$infile ) {
 124                         wfDie( "Couldn't open parserTests.txt\n" );
 125                 }
 126
 127                 $data = array();
 128                 $section = null;
 129                 $success = 0;
 130                 $total = 0;
 131                 $n = 0;
 132                 while( false !== ($line = fgets( $infile ) ) ) {
 133                         $n++;
 134                         if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
 135                                 $section = strtolower( $matches[1] );
 136                                 if( $section == 'endarticle') {
 137                                         if( !isset( $data['text'] ) ) {
 138                                                 wfDie( "'endarticle' without 'text' at line $n\n" );
 139                                         }
 140                                         if( !isset( $data['article'] ) ) {
 141                                                 wfDie( "'endarticle' without 'article' at line $n\n" );
 142                                         }
 143                                         $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
 144                                         $data = array();
 145                                         $section = null;
 146                                         continue;
 147                                 }
 148                                 if( $section == 'end' ) {
 149                                         if( !isset( $data['test'] ) ) {
 150                                                 wfDie( "'end' without 'test' at line $n\n" );
 151                                         }
 152                                         if( !isset( $data['input'] ) ) {
 153                                                 wfDie( "'end' without 'input' at line $n\n" );
 154                                         }
 155                                         if( !isset( $data['result'] ) ) {
 156                                                 wfDie( "'end' without 'result' at line $n\n" );
 157                                         }
 158                                         if( !isset( $data['options'] ) ) {
 159                                                 $data['options'] = '';
 160                                         }
 161                                         else {
 162                                                 $data['options'] = $this->chomp( $data['options'] );
 163                                         }
 164                                         if (preg_match('/\\bdisabled\\b/i', $data['options'])
 165                                                 || !preg_match("/{$this->regex}/i", $data['test'])) {
 166                                                 # disabled test
 167                                                 $data = array();
 168                                                 $section = null;
 169                                                 continue;
 170                                         }
 171                                         if( $this->runTest(
 172                                                 $this->chomp( $data['test'] ),
 173                                                 $this->chomp( $data['input'] ),
 174                                                 $this->chomp( $data['result'] ),
 175                                                 $this->chomp( $data['options'] ) ) ) {
 176                                                 $success++;
 177                                         }
 178                                         $total++;
 179                                         $data = array();
 180                                         $section = null;
 181                                         continue;
 182                                 }
 183                                 if ( isset ($data[$section] ) ) {
 184                                         wfDie( "duplicate section '$section' at line $n\n" );
 185                                 }
 186                                 $data[$section] = '';
 187                                 continue;
 188                         }
 189                         if( $section ) {
 190                                 $data[$section] .= $line;
 191                         }
 192                 }
 193                 if( $total > 0 ) {
 194                         $ratio = wfPercent( 100 * $success / $total );
 195                         print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio) ";
 196                         if( $success == $total ) {
 197                                 print $this->termColor( 32 ) . "PASSED!";
 198                         } else {
 199                                 print $this->termColor( 31 ) . "FAILED!";
 200                         }
 201                         print $this->termReset() . "\n";
 202                         return ($success == $total);
 203                 } else {
 204                         wfDie( "No tests found.\n" );
 205                 }
 206         }
 207
 208         /**
 209          * Run a given wikitext input through a freshly-constructed wiki parser,
 210          * and compare the output against the expected results.
 211          * Prints status and explanatory messages to stdout.
 212          *
 213          * @param string $input Wikitext to try rendering
 214          * @param string $result Result to output
 215          * @return bool
 216          */
 217         function runTest( $desc, $input, $result, $opts ) {
 218                 if( !$this->quiet ) {
 219                         $this->showTesting( $desc );
 220                 }
 221
 222                 $this->setupGlobals($opts);
 223
 224                 $user =& new User();
 225                 $options = ParserOptions::newFromUser( $user );
 226
 227                 if (preg_match('/\\bmath\\b/i', $opts)) {
 228                         # XXX this should probably be done by the ParserOptions
 229                         require_once('Math.php');
 230
 231                         $options->setUseTex(true);
 232                 }
 233
 234                 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
 235                         $titleText = $m[1];
 236                 }
 237                 else {
 238                         $titleText = 'Parser test';
 239                 }
 240
 241                 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
 242
 243                 $parser =& new Parser();
 244                 wfRunHooks( 'ParserTestParser', array( &$parser ) );
 245
 246                 $title =& Title::makeTitle( NS_MAIN, $titleText );
 247
 248                 if (preg_match('/\\bpst\\b/i', $opts)) {
 249                         $out = $parser->preSaveTransform( $input, $title, $user, $options );
 250                 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
 251                         $out = $parser->transformMsg( $input, $options );
 252                 } else {
 253                         $output = $parser->parse( $input, $title, $options, true, true, 1337 );
 254                         $out = $output->getText();
 255
 256                         if (preg_match('/\\bill\\b/i', $opts)) {
 257                                 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
 258                         } else if (preg_match('/\\bcat\\b/i', $opts)) {
 259                                 $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
 260                         }
 261
 262                         $result = $this->tidy($result);
 263                 }
 264
 265                 $this->teardownGlobals();
 266
 267                 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
 268                         return $this->showSuccess( $desc );
 269                 } else {
 270                         return $this->showFailure( $desc, $result, $out );
 271                 }
 272         }
 273
 274         /**
 275          * Set up the global variables for a consistent environment for each test.
 276          * Ideally this should replace the global configuration entirely.
 277          *
 278          * @access private
 279          */
 280         function setupGlobals($opts = '') {
 281                 # Save the prefixed / quoted table names for later use when we make the temporaries.
 282                 $db =& wfGetDB( DB_READ );
 283                 $this->oldTableNames = array();
 284                 foreach( $this->listTables() as $table ) {
 285                         $this->oldTableNames[$table] = $db->tableName( $table );
 286                 }
 287                 if( !isset( $this->uploadDir ) ) {
 288                         $this->uploadDir = $this->setupUploadDir();
 289                 }
 290
 291                 $settings = array(
 292                         'wgServer' => 'http://localhost',
 293                         'wgScript' => '/index.php',
 294                         'wgScriptPath' => '/',
 295                         'wgArticlePath' => '/wiki/$1',
 296                         'wgUploadPath' => 'http://example.com/images',
 297                         'wgUploadDirectory' => $this->uploadDir,
 298                         'wgStyleSheetPath' => '/skins',
 299                         'wgSitename' => 'MediaWiki',
 300                         'wgServerName' => 'Britney Spears',
 301                         'wgLanguageCode' => 'en',
 302                         'wgContLanguageCode' => 'en',
 303                         'wgDBprefix' => 'parsertest',
 304                         'wgDefaultUserOptions' => array(),
 305
 306                         'wgLang' => new LanguageUtf8(),
 307                         'wgContLang' => new LanguageUtf8(),
 308                         'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
 309                         'wgMaxTocLevel' => 999,
 310                         'wgCapitalLinks' => true,
 311                         'wgDefaultUserOptions' => array(),
 312                         'wgNoFollowLinks' => true,
 313                         'wgThumbnailScriptPath' => false,
 314                         'wgUseTeX' => false,
 315                         'wgLocaltimezone' => 'UTC',
 316                         );
 317                 $this->savedGlobals = array();
 318                 foreach( $settings as $var => $val ) {
 319                         $this->savedGlobals[$var] = $GLOBALS[$var];
 320                         $GLOBALS[$var] = $val;
 321                 }
 322                 $GLOBALS['wgLoadBalancer']->loadMasterPos();
 323                 $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
 324                 $this->setupDatabase();
 325
 326                 global $wgUser;
 327                 $wgUser = new User();
 328         }
 329
 330         # List of temporary tables to create, without prefix
 331         # Some of these probably aren't necessary
 332         function listTables() {
 333                 return array('user', 'page', 'revision', 'text',
 334                         'pagelinks', 'imagelinks', 'categorylinks', 'templatelinks',
 335                         'site_stats', 'hitcounter',
 336                         'ipblocks', 'image', 'oldimage',
 337                         'recentchanges',
 338                         'watchlist', 'math', 'searchindex',
 339                         'interwiki', 'querycache',
 340                         'objectcache'
 341                 );
 342         }
 343
 344         /**
 345          * Set up a temporary set of wiki tables to work with for the tests.
 346          * Currently this will only be done once per run, and any changes to
 347          * the db will be visible to later tests in the run.
 348          *
 349          * @access private
 350          */
 351         function setupDatabase() {
 352                 static $setupDB = false;
 353                 global $wgDBprefix;
 354
 355                 # Make sure we don't mess with the live DB
 356                 if (!$setupDB && $wgDBprefix === 'parsertest') {
 357                         # oh teh horror
 358                         $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
 359                         $db =& wfGetDB( DB_MASTER );
 360
 361                         $tables = $this->listTables();
 362
 363                         if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
 364                                 # Database that supports CREATE TABLE ... LIKE
 365                                 global $wgDBtype;
 366                                 if( $wgDBtype == 'PostgreSQL' ) {
 367                                         $def = 'INCLUDING DEFAULTS';
 368                                 } else {
 369                                         $def = '';
 370                                 }
 371                                 foreach ($tables as $tbl) {
 372                                         $newTableName = $db->tableName( $tbl );
 373                                         $tableName = $this->oldTableNames[$tbl];
 374                                         $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
 375                                 }
 376                         } else {
 377                                 # Hack for MySQL versions < 4.1, which don't support
 378                                 # "CREATE TABLE ... LIKE". Note that
 379                                 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
 380                                 # would not create the indexes we need....
 381                                 foreach ($tables as $tbl) {
 382                                         $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
 383                                         $row = $db->fetchRow($res);
 384                                         $create = $row[1];
 385                                         $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
 386                                                 . $wgDBprefix . $tbl .'`', $create);
 387                                         if ($create === $create_tmp) {
 388                                                 # Couldn't do replacement
 389                                                 wfDie("could not create temporary table $tbl");
 390                                         }
 391                                         $db->query($create_tmp);
 392                                 }
 393
 394                         }
 395
 396                         # Hack: insert a few Wikipedia in-project interwiki prefixes,
 397                         # for testing inter-language links
 398                         $db->insert( 'interwiki', array(
 399                                 array( 'iw_prefix' => 'Wikipedia',
 400                                        'iw_url'    => 'http://en.wikipedia.org/wiki/$1',
 401                                        'iw_local'  => 0 ),
 402                                 array( 'iw_prefix' => 'MeatBall',
 403                                        'iw_url'    => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
 404                                        'iw_local'  => 0 ),
 405                                 array( 'iw_prefix' => 'zh',
 406                                        'iw_url'    => 'http://zh.wikipedia.org/wiki/$1',
 407                                        'iw_local'  => 1 ),
 408                                 array( 'iw_prefix' => 'es',
 409                                        'iw_url'    => 'http://es.wikipedia.org/wiki/$1',
 410                                        'iw_local'  => 1 ),
 411                                 array( 'iw_prefix' => 'fr',
 412                                        'iw_url'    => 'http://fr.wikipedia.org/wiki/$1',
 413                                        'iw_local'  => 1 ),
 414                                 array( 'iw_prefix' => 'ru',
 415                                        'iw_url'    => 'http://ru.wikipedia.org/wiki/$1',
 416                                        'iw_local'  => 1 ),
 417                                 ) );
 418
 419                         # Hack: Insert an image to work with
 420                         $db->insert( 'image', array(
 421                                 'img_name'        => 'Foobar.jpg',
 422                                 'img_size'        => 12345,
 423                                 'img_description' => 'Some lame file',
 424                                 'img_user'        => 1,
 425                                 'img_user_text'   => 'WikiSysop',
 426                                 'img_timestamp'   => $db->timestamp( '20010115123500' ),
 427                                 'img_width'       => 1941,
 428                                 'img_height'      => 220,
 429                                 'img_bits'        => 24,
 430                                 'img_media_type'  => MEDIATYPE_BITMAP,
 431                                 'img_major_mime'  => "image",
 432                                 'img_minor_mime'  => "jpeg",
 433                                 ) );
 434
 435                         $setupDB = true;
 436                 }
 437         }
 438
 439         /**
 440          * Create a dummy uploads directory which will contain a couple
 441          * of files in order to pass existence tests.
 442          * @return string The directory
 443          * @access private
 444          */
 445         function setupUploadDir() {
 446                 global $IP;
 447
 448                 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
 449                 mkdir( $dir );
 450                 mkdir( $dir . '/3' );
 451                 mkdir( $dir . '/3/3a' );
 452
 453                 $img = "$IP/skins/monobook/headbg.jpg";
 454                 $h = fopen($img, 'r');
 455                 $c = fread($h, filesize($img));
 456                 fclose($h);
 457
 458                 $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
 459                 fwrite( $f, $c );
 460                 fclose( $f );
 461                 return $dir;
 462         }
 463
 464         /**
 465          * Restore default values and perform any necessary clean-up
 466          * after each test runs.
 467          *
 468          * @access private
 469          */
 470         function teardownGlobals() {
 471                 foreach( $this->savedGlobals as $var => $val ) {
 472                         $GLOBALS[$var] = $val;
 473                 }
 474                 if( isset( $this->uploadDir ) ) {
 475                         $this->teardownUploadDir( $this->uploadDir );
 476                         unset( $this->uploadDir );
 477                 }
 478         }
 479
 480         /**
 481          * Remove the dummy uploads directory
 482          * @access private
 483          */
 484         function teardownUploadDir( $dir ) {
 485                 unlink( "$dir/3/3a/Foobar.jpg" );
 486                 rmdir( "$dir/3/3a" );
 487                 rmdir( "$dir/3" );
 488
 489                 @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
 490                 @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
 491                 @rmdir( "$dir/thumb/3/3a" );
 492                 @rmdir( "$dir/thumb/3/39" ); # wtf?
 493                 @rmdir( "$dir/thumb/3" );
 494                 @rmdir( "$dir/thumb" );
 495                 rmdir( "$dir" );
 496         }
 497
 498         /**
 499          * "Running test $desc..."
 500          * @access private
 501          */
 502         function showTesting( $desc ) {
 503                 print "Running test $desc... ";
 504         }
 505
 506         /**
 507          * Print a happy success message.
 508          *
 509          * @param string $desc The test name
 510          * @return bool
 511          * @access private
 512          */
 513         function showSuccess( $desc ) {
 514                 if( !$this->quiet ) {
 515                         print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
 516                 }
 517                 return true;
 518         }
 519
 520         /**
 521          * Print a failure message and provide some explanatory output
 522          * about what went wrong if so configured.
 523          *
 524          * @param string $desc The test name
 525          * @param string $result Expected HTML output
 526          * @param string $html Actual HTML output
 527          * @return bool
 528          * @access private
 529          */
 530         function showFailure( $desc, $result, $html ) {
 531                 if( $this->quiet ) {
 532                         # In quiet mode we didn't show the 'Testing' message before the
 533                         # test, in case it succeeded. Show it now:
 534                         $this->showTesting( $desc );
 535                 }
 536                 print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
 537                 if( $this->showDiffs ) {
 538                         print $this->quickDiff( $result, $html );
 539                 }
 540                 if( !$this->wellFormed( $html ) ) {
 541                         print "XML error: $this->mXmlError\n";
 542                 }
 543                 return false;
 544         }
 545
 546         /**
 547          * Run given strings through a diff and return the (colorized) output.
 548          * Requires writable /tmp directory and a 'diff' command in the PATH.
 549          *
 550          * @param string $input
 551          * @param string $output
 552          * @param string $inFileTail Tailing for the input file name
 553          * @param string $outFileTail Tailing for the output file name
 554          * @return string
 555          * @access private
 556          */
 557         function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
 558                 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
 559
 560                 $infile = "$prefix-$inFileTail";
 561                 $this->dumpToFile( $input, $infile );
 562
 563                 $outfile = "$prefix-$outFileTail";
 564                 $this->dumpToFile( $output, $outfile );
 565
 566                 $diff = `diff -au $infile $outfile`;
 567                 unlink( $infile );
 568                 unlink( $outfile );
 569
 570                 return $this->colorDiff( $diff );
 571         }
 572
 573         /**
 574          * Write the given string to a file, adding a final newline.
 575          *
 576          * @param string $data
 577          * @param string $filename
 578          * @access private
 579          */
 580         function dumpToFile( $data, $filename ) {
 581                 $file = fopen( $filename, "wt" );
 582                 fwrite( $file, $data . "\n" );
 583                 fclose( $file );
 584         }
 585
 586         /**
 587          * Return ANSI terminal escape code for changing text attribs/color,
 588          * or empty string if color output is disabled.
 589          *
 590          * @param string $color Semicolon-separated list of attribute/color codes
 591          * @return string
 592          * @access private
 593          */
 594         function termColor( $color ) {
 595                 if($this->lightcolor) {
 596                         return $this->color ? "\x1b[1;{$color}m" : '';
 597                 } else {
 598                         return $this->color ? "\x1b[{$color}m" : '';
 599                 }
 600         }
 601
 602         /**
 603          * Return ANSI terminal escape code for restoring default text attributes,
 604          * or empty string if color output is disabled.
 605          *
 606          * @return string
 607          * @access private
 608          */
 609         function termReset() {
 610                 return $this->color ? "\x1b[0m" : '';
 611         }
 612
 613         /**
 614          * Colorize unified diff output if set for ANSI color output.
 615          * Subtractions are colored blue, additions red.
 616          *
 617          * @param string $text
 618          * @return string
 619          * @access private
 620          */
 621         function colorDiff( $text ) {
 622                 return preg_replace(
 623                         array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
 624                         array( $this->termColor( 34 ) . '$1' . $this->termReset(),
 625                                $this->termColor( 31 ) . '$1' . $this->termReset() ),
 626                         $text );
 627         }
 628
 629         /**
 630          * Insert a temporary test article
 631          * @param string $name the title, including any prefix
 632          * @param string $text the article text
 633          * @param int $line the input line number, for reporting errors
 634          * @static
 635          * @access private
 636          */
 637         function addArticle($name, $text, $line) {
 638                 $this->setupGlobals();
 639                 $title = Title::newFromText( $name );
 640                 if ( is_null($title) ) {
 641                         wfDie( "invalid title at line $line\n" );
 642                 }
 643
 644                 $aid = $title->getArticleID( GAID_FOR_UPDATE );
 645                 if ($aid != 0) {
 646                         wfDie( "duplicate article at line $line\n" );
 647                 }
 648
 649                 $art = new Article($title);
 650                 $art->insertNewArticle($text, '', false, false );
 651                 $this->teardownGlobals();
 652         }
 653
 654         /*
 655          * Run the "tidy" command on text if the $wgUseTidy
 656          * global is true
 657          *
 658          * @param string $text the text to tidy
 659          * @return string
 660          * @static
 661          * @access private
 662          */
 663         function tidy( $text ) {
 664                 global $wgUseTidy;
 665                 if ($wgUseTidy) {
 666                         $text = Parser::tidy($text);
 667                 }
 668                 return $text;
 669         }
 670
 671         /**
 672          * Hack up a private DOCTYPE with HTML's standard entity declarations.
 673          * PHP 4 seemed to know these if you gave it an HTML doctype, but
 674          * PHP 5.1 doesn't.
 675          * @return string
 676          * @access private
 677          */
 678         function hackDocType() {
 679                 global $wgHtmlEntities;
 680                 $out = "<!DOCTYPE html [\n";
 681                 foreach( $wgHtmlEntities as $entity => $codepoint ) {
 682                         $out .= "<!ENTITY $entity \"&#$codepoint;\">";
 683                 }
 684                 $out .= "]>\n";
 685                 return $out;
 686         }
 687
 688         function wellFormed( $text ) {
 689                 $html =
 690                         $this->hackDocType() .
 691                         '<html>' .
 692                         $text .
 693                         '</html>';
 694
 695                 $parser = xml_parser_create( "UTF-8" );
 696
 697                 # case folding violates XML standard, turn it off
 698                 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
 699
 700                 if( !xml_parse( $parser, $html, true ) ) {
 701                         $err = xml_error_string( xml_get_error_code( $parser ) );
 702                         $position = xml_get_current_byte_index( $parser );
 703                         $fragment = $this->extractFragment( $html, $position );
 704                         $this->mXmlError = "$err at byte $position:\n$fragment";
 705                         xml_parser_free( $parser );
 706                         return false;
 707                 }
 708                 xml_parser_free( $parser );
 709                 return true;
 710         }
 711
 712         function extractFragment( $text, $position ) {
 713                 $start = max( 0, $position - 10 );
 714                 $before = $position - $start;
 715                 $fragment = '...' .
 716                         $this->termColor( 34 ) .
 717                         substr( $text, $start, $before ) .
 718                         $this->termColor( 0 ) .
 719                         $this->termColor( 31 ) .
 720                         $this->termColor( 1 ) .
 721                         substr( $text, $position, 1 ) .
 722                         $this->termColor( 0 ) .
 723                         $this->termColor( 34 ) .
 724                         substr( $text, $position + 1, 9 ) .
 725                         $this->termColor( 0 ) .
 726                         '...';
 727                 $display = str_replace( "\n", ' ', $fragment );
 728                 $caret = '   ' .
 729                         str_repeat( ' ', $before ) .
 730                         $this->termColor( 31 ) .
 731                         '^' .
 732                         $this->termColor( 0 );
 733                 return "$display\n$caret";
 734         }
 735
 736 }
 737
 738 ?>