MediaWiki REL1_28
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:4114
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:31
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition maintenance.txt:39
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition Maintenance.php:387
Maintenance\getStdin
getStdin( $len=null)
Return input from stdin.
Definition Maintenance.php:341
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition Maintenance.php:231
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition Maintenance.php:282
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:210
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:245
ParserOptions\newFromUser
static newFromUser( $user)
Get a ParserOptions object from a given user.
Definition ParserOptions.php:705
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
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
global
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
$output
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition hooks.txt:1102
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1096
$content
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition hooks.txt:1094
$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:1734
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition maintenance.txt:50
$source
$source
Definition mwdoc-filter.php:45
$maintClass
$maintClass
Definition renderDump.php:123