MediaWiki REL1_30
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
70 $importer->doImport();
71
72 $delta = microtime( true ) - $this->startTime;
73 $this->error( "Rendered {$this->count} pages in " . round( $delta, 2 ) . " seconds " );
74 if ( $delta > 0 ) {
75 $this->error( round( $this->count / $delta, 2 ) . " pages/sec" );
76 }
77 $this->error( "\n" );
78 }
79
84 public function handleRevision( $rev ) {
85 $title = $rev->getTitle();
86 if ( !$title ) {
87 $this->error( "Got bogus revision with null title!" );
88
89 return;
90 }
91 $display = $title->getPrefixedText();
92
93 $this->count++;
94
95 $sanitized = rawurlencode( $display );
96 $filename = sprintf( "%s/%s-%07d-%s.html",
97 $this->outputDirectory,
98 $this->prefix,
99 $this->count,
100 $sanitized );
101 $this->output( sprintf( "%s\n", $filename, $display ) );
102
103 $user = new User();
104 $options = ParserOptions::newFromUser( $user );
105
106 $content = $rev->getContent();
107 $output = $content->getParserOutput( $title, null, $options );
108
109 file_put_contents( $filename,
110 "<!DOCTYPE html>\n" .
111 "<html lang=\"en\" dir=\"ltr\">\n" .
112 "<head>\n" .
113 "<meta charset=\"UTF-8\" />\n" .
114 "<title>" . htmlspecialchars( $display ) . "</title>\n" .
115 "</head>\n" .
116 "<body>\n" .
117 $output->getText() .
118 "</body>\n" .
119 "</html>" );
120 }
121}
122
123$maintClass = "DumpRenderer";
124require_once RUN_MAINTENANCE_IF_MAIN;
$wgParserConf
$wgParserConf
Parser configuration.
Definition DefaultSettings.php:4178
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:84
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:346
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition Maintenance.php:236
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition Maintenance.php:287
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:215
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:250
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
WikiImporter
XML file reader for the page data importer.
Definition WikiImporter.php:34
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:2225
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:2581
$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:1971
$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:1760
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:123