MediaWiki REL1_31
renderDump.php
Go to the documentation of this file.
1<?php
31require_once __DIR__ . '/Maintenance.php';
32
39class DumpRenderer extends Maintenance {
40
41 private $count = 0;
42 private $outputDirectory, $startTime;
43
44 public function __construct() {
45 parent::__construct();
46 $this->addDescription(
47 'Take page text out of an XML dump file and render basic HTML out to files' );
48 $this->addOption( 'output-dir', 'The directory to output the HTML files to', true, true );
49 $this->addOption( 'prefix', 'Prefix for the rendered files (defaults to wiki)', false, true );
50 $this->addOption( 'parser', 'Use an alternative parser class', false, true );
51 }
52
53 public function execute() {
54 $this->outputDirectory = $this->getOption( 'output-dir' );
55 $this->prefix = $this->getOption( 'prefix', 'wiki' );
56 $this->startTime = microtime( true );
57
58 if ( $this->hasOption( 'parser' ) ) {
59 global $wgParserConf;
60 $wgParserConf['class'] = $this->getOption( 'parser' );
61 $this->prefix .= "-{$wgParserConf['class']}";
62 }
63
64 $source = new ImportStreamSource( $this->getStdin() );
65 $importer = new WikiImporter( $source, $this->getConfig() );
66
67 $importer->setRevisionCallback(
68 [ $this, 'handleRevision' ] );
69 $importer->setNoticeCallback( function ( $msg, $params ) {
70 echo wfMessage( $msg, $params )->text() . "\n";
71 } );
72
73 $importer->doImport();
74
75 $delta = microtime( true ) - $this->startTime;
76 $this->error( "Rendered {$this->count} pages in " . round( $delta, 2 ) . " seconds " );
77 if ( $delta > 0 ) {
78 $this->error( round( $this->count / $delta, 2 ) . " pages/sec" );
79 }
80 $this->error( "\n" );
81 }
82
87 public function handleRevision( $rev ) {
88 $title = $rev->getTitle();
89 if ( !$title ) {
90 $this->error( "Got bogus revision with null title!" );
91
92 return;
93 }
94 $display = $title->getPrefixedText();
95
96 $this->count++;
97
98 $sanitized = rawurlencode( $display );
99 $filename = sprintf( "%s/%s-%07d-%s.html",
100 $this->outputDirectory,
101 $this->prefix,
102 $this->count,
103 $sanitized );
104 $this->output( sprintf( "%s\n", $filename, $display ) );
105
106 $user = new User();
107 $options = ParserOptions::newFromUser( $user );
108
109 $content = $rev->getContent();
110 $output = $content->getParserOutput( $title, null, $options );
111
112 file_put_contents( $filename,
113 "<!DOCTYPE html>\n" .
114 "<html lang=\"en\" dir=\"ltr\">\n" .
115 "<head>\n" .
116 "<meta charset=\"UTF-8\" />\n" .
117 "<title>" . htmlspecialchars( $display ) . "</title>\n" .
118 "</head>\n" .
119 "<body>\n" .
120 $output->getText() .
121 "</body>\n" .
122 "</html>" );
123 }
124}
125
126$maintClass = DumpRenderer::class;
127require_once RUN_MAINTENANCE_IF_MAIN;
$wgParserConf
$wgParserConf
Parser configuration.
Definition DefaultSettings.php:4170
DumpRenderer
Maintenance script that takes page text out of an XML dump file and render basic HTML out to files.
Definition renderDump.php:39
DumpRenderer\handleRevision
handleRevision( $rev)
Callback function for each revision, turn into HTML and save.
Definition renderDump.php:87
DumpRenderer\__construct
__construct()
Default constructor.
Definition renderDump.php:44
DumpRenderer\execute
execute()
Do the actual work.
Definition renderDump.php:53
ImportStreamSource
Imports a XML dump from a file (either from file upload, files on disk, or HTTP)
Definition ImportStreamSource.php:32
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition maintenance.txt:39
Maintenance\getStdin
getStdin( $len=null)
Return input from stdin.
Definition Maintenance.php:361
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition Maintenance.php:240
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition Maintenance.php:291
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:219
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:254
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
WikiImporter
XML file reader for the page data importer.
Definition WikiImporter.php:33
output
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2255
error
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2612
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2001
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
$rev
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1777
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition maintenance.txt:50
$source
$source
Definition mwdoc-filter.php:46
$maintClass
$maintClass
Definition renderDump.php:126
$params
$params
Definition styleTest.css.php:40