Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 66
0.00% covered (danger)
0.00%
0 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
DumpRenderer
0.00% covered (danger)
0.00%
0 / 63
0.00% covered (danger)
0.00%
0 / 3
42
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 execute
0.00% covered (danger)
0.00%
0 / 22
0.00% covered (danger)
0.00%
0 / 1
12
 handleRevision
0.00% covered (danger)
0.00%
0 / 35
0.00% covered (danger)
0.00%
0 / 1
6
1<?php
2/**
3 * Take page text out of an XML dump file and render basic HTML out to files.
4 * This is *NOT* suitable for publishing or offline use; it's intended for
5 * running comparative tests of parsing behavior using real-world data.
6 *
7 * Templates etc are pulled from the local wiki database, not from the dump.
8 *
9 * Copyright (C) 2006 Brooke Vibber <bvibber@wikimedia.org>
10 * https://www.mediawiki.org/
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
26 *
27 * @file
28 * @ingroup Maintenance
29 */
30
31use MediaWiki\Permissions\UltimateAuthority;
32use MediaWiki\Revision\MutableRevisionRecord;
33use MediaWiki\User\User;
34
35require_once __DIR__ . '/Maintenance.php';
36
37/**
38 * Maintenance script that takes page text out of an XML dump file
39 * and render basic HTML out to files.
40 *
41 * @ingroup Maintenance
42 */
43class DumpRenderer extends Maintenance {
44
45    private $count = 0;
46    private string $outputDirectory;
47    private float $startTime;
48    /** @var string */
49    private $prefix;
50
51    public function __construct() {
52        parent::__construct();
53        $this->addDescription(
54            'Take page text out of an XML dump file and render basic HTML out to files' );
55        $this->addOption( 'output-dir', 'The directory to output the HTML files to', true, true );
56        $this->addOption( 'prefix', 'Prefix for the rendered files (defaults to wiki)', false, true );
57        $this->addOption( 'parser', 'Use an alternative parser class', false, true );
58    }
59
60    public function execute() {
61        $this->outputDirectory = $this->getOption( 'output-dir' );
62        $this->prefix = $this->getOption( 'prefix', 'wiki' );
63        $this->startTime = microtime( true );
64
65        if ( $this->hasOption( 'parser' ) ) {
66            $this->prefix .= '-' . $this->getOption( 'parser' );
67            // T236809: We'll need to provide an alternate ParserFactory
68            // service to make this work.
69            $this->fatalError( 'Parser class configuration temporarily disabled.' );
70        }
71
72        $user = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [ 'steal' => true ] );
73
74        $source = new ImportStreamSource( $this->getStdin() );
75        $importer = $this->getServiceContainer()
76            ->getWikiImporterFactory()
77            ->getWikiImporter( $source, new UltimateAuthority( $user ) );
78
79        $importer->setRevisionCallback(
80            [ $this, 'handleRevision' ] );
81        $importer->setNoticeCallback( static function ( $msg, $params ) {
82            echo wfMessage( $msg, $params )->text() . "\n";
83        } );
84
85        $importer->doImport();
86
87        $delta = microtime( true ) - $this->startTime;
88        $this->error( "Rendered {$this->count} pages in " . round( $delta, 2 ) . " seconds " );
89        if ( $delta > 0 ) {
90            $this->error( round( $this->count / $delta, 2 ) . " pages/sec" );
91        }
92        $this->error( "\n" );
93    }
94
95    /**
96     * Callback function for each revision, turn into HTML and save
97     * @param WikiRevision $rev
98     */
99    public function handleRevision( WikiRevision $rev ) {
100        $title = $rev->getTitle();
101        if ( !$title ) {
102            $this->error( "Got bogus revision with null title!" );
103
104            return;
105        }
106        $display = $title->getPrefixedText();
107
108        $this->count++;
109
110        $sanitized = rawurlencode( $display );
111        $filename = sprintf( "%s/%s-%07d-%s.html",
112            $this->outputDirectory,
113            $this->prefix,
114            $this->count,
115            $sanitized );
116        $this->output( sprintf( "%s\t%s\n", $filename, $display ) );
117
118        $user = new User();
119        $options = ParserOptions::newFromUser( $user );
120
121        $content = $rev->getContent();
122        $contentRenderer = $this->getServiceContainer()->getContentRenderer();
123        // ContentRenderer expects a RevisionRecord, and all we have is a
124        // WikiRevision from the dump.  Make a fake MutableRevisionRecord to
125        // satisfy it -- the only thing ::getParserOutput actually needs is
126        // the revision ID and revision timestamp.
127        $mutableRev = new MutableRevisionRecord( $rev->getTitle() );
128        $mutableRev->setId( $rev->getID() );
129        $mutableRev->setTimestamp( $rev->getTimestamp() );
130        $output = $contentRenderer->getParserOutput(
131            $content, $title, $mutableRev, $options
132        );
133
134        file_put_contents( $filename,
135            "<!DOCTYPE html>\n" .
136            "<html lang=\"en\" dir=\"ltr\">\n" .
137            "<head>\n" .
138            "<meta charset=\"UTF-8\" />\n" .
139            "<meta name=\"color-scheme\" content=\"light dark\">" .
140            "<title>" . htmlspecialchars( $display, ENT_COMPAT ) . "</title>\n" .
141            "</head>\n" .
142            "<body>\n" .
143            $output->getText() .
144            "</body>\n" .
145            "</html>" );
146    }
147}
148
149$maintClass = DumpRenderer::class;
150require_once RUN_MAINTENANCE_IF_MAIN;