MediaWiki  master
renderDump.php
Go to the documentation of this file.
1 <?php
31 require_once __DIR__ . '/Maintenance.php';
32 
39 class DumpRenderer extends Maintenance {
40 
41  private $count = 0;
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();
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 
127 require_once RUN_MAINTENANCE_IF_MAIN;
handleRevision( $rev)
Callback function for each revision, turn into HTML and save.
Definition: renderDump.php:87
error( $err, $die=0)
Throw an error to the user.
XML file reader for the page data importer.
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$source
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
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 use $formDescriptor instead 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
addDescription( $text)
Set the description text.
$params
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:1982
Imports a XML dump from a file (either from file upload, files on disk, or HTTP)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
$wgParserConf
Parser configuration.
output( $out, $channel=null)
Throw some output to the user.
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:1766
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:35
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static newFromUser( $user)
Get a ParserOptions object from a given user.
Maintenance script that takes page text out of an XML dump file and render basic HTML out to files...
Definition: renderDump.php:39
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getStdin( $len=null)
Return input from stdin.
$maintClass
Definition: renderDump.php:126
$content
Definition: pageupdater.txt:72
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473