MediaWiki  master
preprocessDump.php
Go to the documentation of this file.
1 <?php
29 
30 require_once __DIR__ . '/dumpIterator.php';
31 
39 
40  /* Variables for dressing up as a parser */
41  public $mTitle = 'PreprocessDump';
42  public $mPPNodeCount = 0;
43 
44  public function getStripList() {
45  $parser = MediaWikiServices::getInstance()->getParser();
46 
47  return $parser->getStripList();
48  }
49 
50  public function __construct() {
51  parent::__construct();
52  $this->addOption( 'cache', 'Use and populate the preprocessor cache.', false, false );
53  $this->addOption( 'preprocessor', 'Preprocessor to use.', false, false );
54  }
55 
56  public function getDbType() {
57  return Maintenance::DB_NONE;
58  }
59 
60  public function checkOptions() {
62 
63  if ( !$this->hasOption( 'cache' ) ) {
64  $wgPreprocessorCacheThreshold = false;
65  }
66 
67  if ( $this->hasOption( 'preprocessor' ) ) {
68  $name = $this->getOption( 'preprocessor' );
69  } elseif ( isset( $wgParserConf['preprocessorClass'] ) ) {
70  $name = $wgParserConf['preprocessorClass'];
71  } else {
73  }
74 
75  MediaWikiServices::getInstance()->getParser()->firstCallInit();
76  $this->mPreprocessor = new $name( $this );
77  }
78 
83  public function processRevision( $rev ) {
84  $content = $rev->getContent( Revision::RAW );
85 
86  if ( $content->getModel() !== CONTENT_MODEL_WIKITEXT ) {
87  return;
88  }
89 
90  try {
91  $this->mPreprocessor->preprocessToObj( strval( $content->getText() ), 0 );
92  } catch ( Exception $e ) {
93  $this->error( "Caught exception " . $e->getMessage() . " in "
94  . $rev->getTitle()->getPrefixedText() );
95  }
96  }
97 }
98 
100 require_once RUN_MAINTENANCE_IF_MAIN;
const DB_NONE
Constants for DB access type.
Definition: Maintenance.php:85
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:231
error( $err, $die=0)
Throw an error to the user.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getOption( $name, $default=null)
Get an option, or return the default.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
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 MediaWikiServices
Definition: injection.txt:23
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
$maintClass
$wgPreprocessorCacheThreshold
Preprocessor caching threshold Setting it to &#39;false&#39; will disable the preprocessor cache...
Maintenance script that takes page text out of an XML dump file and preprocesses it to obj...
$wgParserConf
Parser configuration.
Base class for interating over a dump.
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
const RAW
Definition: Revision.php:56
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
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$content
Definition: pageupdater.txt:72
processRevision( $rev)
Callback function for each revision, preprocessToObj()