(bug 40829) Show cascading protection info on action=info
[lhc/web/wiklou.git] / maintenance / compareParsers.php
index 9f7ec19..1f3ac1c 100644 (file)
@@ -6,8 +6,9 @@
  *
  * Templates etc are pulled from the local wiki database, not from the dump.
  *
- * Copyright (C) 2011 Platonides - http://www.mediawiki.org/
- * 
+ * Copyright © 2011 Platonides
+ * http://www.mediawiki.org/
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * @file
  * @ingroup Maintenance
  */
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
 
-class CompareParsers extends Maintenance {
+require_once( __DIR__ . '/dumpIterator.php' );
+
+/**
+ * Maintenance script to take page text out of an XML dump file and render
+ * basic HTML out to files.
+ *
+ * @ingroup Maintenance
+ */
+class CompareParsers extends DumpIterator {
 
        private $count = 0;
-       private $outputDirectory, $startTime;
 
        public function __construct() {
                parent::__construct();
@@ -40,9 +46,6 @@ class CompareParsers extends Maintenance {
                $this->mDescription = "Run a file or dump with several parsers";
                $this->addOption( 'parser1', 'The first parser to compare.', true, true );
                $this->addOption( 'parser2', 'The second parser to compare.', true, true );
-               $this->addOption( 'file', 'File with text to run.', false, true );
-               $this->addOption( 'dump', 'XML dump to execute all revisions.', false, true );
-               $this->addOption( 'from', 'Article from XML dump to start from.', false, true );
                $this->addOption( 'tidy', 'Run tidy on the articles.', false, false );
                $this->addOption( 'save-failed', 'Folder in which articles which differ will be stored.', false, true );
                $this->addOption( 'show-diff', 'Show a diff of the two renderings.', false, false );
@@ -51,18 +54,14 @@ class CompareParsers extends Maintenance {
                $this->addOption( 'show-parsed-output', 'Show the parsed html if both Parsers give the same output.', false, false );
        }
 
-       public function execute() {
-               if (! ( $this->hasOption('file') ^ $this->hasOption('dump') ) ) {
-                       $this->error("You must provide file or dump", true);
-               }
-
+       public function checkOptions() {
                if ( $this->hasOption('save-failed') ) {
                        $this->saveFailed = $this->getOption('save-failed');
                }
-               
+
                $this->stripParametersEnabled = $this->hasOption( 'strip-parameters' );
                $this->showParsedOutput = $this->hasOption( 'show-parsed-output' );
-               
+
                $this->showDiff = $this->hasOption( 'show-diff' );
                if ( $this->showDiff ) {
                        $bin = $this->getOption( 'diff-bin', getenv( 'DIFF' ) );
@@ -71,10 +70,10 @@ class CompareParsers extends Maintenance {
                                $wgDiff = $bin;
                        }
                }
-               
-               $user = new User();             
+
+               $user = new User();
                $this->options = ParserOptions::newFromUser( $user );
-               
+
                if ( $this->hasOption( 'tidy' ) ) {
                        global $wgUseTidy;
                        if ( !$wgUseTidy ) {
@@ -82,92 +81,57 @@ class CompareParsers extends Maintenance {
                        }
                        $this->options->setTidy( true );
                }
-               
-               if ( $this->hasOption('file') ) {
-                       $revision = new WikiRevision;
-                       
-                       $revision->setText( file_get_contents( $this->getOption('file') ) );
-                       $revision->setTitle( Title::newFromText( rawurldecode( basename( $this->getOption('file'), '.txt' ) ) ) );
-                       $this->handleRevision( $revision );
-                       return;
-               }
-               
-               $this->startTime = wfTime();
-
-               if ( $this->getOption('dump') == '-' ) {
-                       $source = new ImportStreamSource( $this->getStdin() );
-               } else {
-                       $this->error("Sorry, I don't support dump filenames yet. Use - and provide it on stdin on the meantime.", true);
-               }
-               $importer = new WikiImporter( $source );
 
-               $importer->setRevisionCallback(
-                       array( &$this, 'handleRevision' ) );
-               
-               $this->from = $this->getOption( 'from', null );
-               $this->count = 0;
                $this->failed = 0;
-               $importer->doImport();
-               
+       }
+
+       public function conclusions() {
                $this->error( "{$this->failed} failed revisions out of {$this->count}" );
                if ($this->count > 0)
                        $this->output( " (" . ( $this->failed / $this->count ) . "%)\n" );
-                       
-               $delta = wfTime() - $this->startTime;
-               $this->error( "Compared {$this->count} pages in " . round($delta, 2) . " seconds " );
-               if ($delta > 0)
-                       $this->error( round($this->count / $delta, 2) . " pages/sec" );
-               $this->error( "\n" );
        }
-       
+
        function stripParameters( $text ) {
                if ( !$this->stripParametersEnabled ) {
                        return $text;
                }
                return preg_replace( '/(<a) [^>]+>/', '$1>', $text );
        }
-       
+
        /**
         * Callback function for each revision, parse with both parsers and compare
         * @param $rev Revision
         */
-       public function handleRevision( $rev ) {
+       public function processRevision( $rev ) {
                $title = $rev->getTitle();
-               if ( !$title ) {
-                       $this->error( "Got bogus revision with null title!" );
-                       return;
-               }
-               
-               $this->count++;
-               if ( isset( $this->from ) ) {
-                       if ( $this->from != $title )
-                               return;
-                       $this->output( "Skipped " . ($this->count - 1) . " pages\n" );
-                       
-                       $this->count = 1;
-                       $this->from = null;
-               }
-               
-               
 
                $parser1Name = $this->getOption( 'parser1' );
                $parser2Name = $this->getOption( 'parser2' );
-               
+
                self::checkParserLocally( $parser1Name );
                self::checkParserLocally( $parser2Name );
-               
+
                $parser1 = new $parser1Name();
                $parser2 = new $parser2Name();
-               
-               $output1 = $parser1->parse( $rev->getText(), $title, $this->options );
-               $output2 = $parser2->parse( $rev->getText(), $title, $this->options );
+
+               $content = $rev->getContent();
+
+               if ( $content->getModel() !== CONTENT_MODEL_WIKITEXT ) {
+                       $this->error( "Page {$title->getPrefixedText()} does not contain wikitext but {$content->getModel()}\n" );
+                       return;
+               }
+
+               $text = strval( $content->getNativeData() );
+
+               $output1 = $parser1->parse( $text, $title, $this->options );
+               $output2 = $parser2->parse( $text, $title, $this->options );
 
                if ( $output1->getText() != $output2->getText() ) {
                        $this->failed++;
                        $this->error( "Parsing for {$title->getPrefixedText()} differs\n" );
-                       
-                       if ($this->saveFailed) {
-                               file_put_contents( $this->saveFailed . '/' . rawurlencode( $title->getPrefixedText() ) . ".txt", $rev->getText());
+
+                       if ( $this->saveFailed ) {
+                               file_put_contents( $this->saveFailed . '/' . rawurlencode( $title->getPrefixedText() ) . ".txt", $text );
                        }
                        if ( $this->showDiff ) {
                                $this->output( wfDiff( $this->stripParameters( $output1->getText() ), $this->stripParameters( $output2->getText() ), '' ) );
@@ -179,7 +143,7 @@ class CompareParsers extends Maintenance {
                        }
                }
        }
-       
+
        private static function checkParserLocally( $parserName ) {
                /* Look for the parser in a file appropiately named in the current folder */
                if ( !class_exists( $parserName ) && file_exists( "$parserName.php" ) ) {
@@ -191,4 +155,4 @@ class CompareParsers extends Maintenance {
 }
 
 $maintClass = "CompareParsers";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );