MediaWiki  REL1_31
preprocessDump.php
Go to the documentation of this file.
1 <?php
28 require_once __DIR__ . '/dumpIterator.php';
29 
37 
38  /* Variables for dressing up as a parser */
39  public $mTitle = 'PreprocessDump';
40  public $mPPNodeCount = 0;
41 
42  public function getStripList() {
44 
45  return $wgParser->getStripList();
46  }
47 
48  public function __construct() {
49  parent::__construct();
50  $this->addOption( 'cache', 'Use and populate the preprocessor cache.', false, false );
51  $this->addOption( 'preprocessor', 'Preprocessor to use.', false, false );
52  }
53 
54  public function getDbType() {
55  return Maintenance::DB_NONE;
56  }
57 
58  public function checkOptions() {
60 
61  if ( !$this->hasOption( 'cache' ) ) {
62  $wgPreprocessorCacheThreshold = false;
63  }
64 
65  if ( $this->hasOption( 'preprocessor' ) ) {
66  $name = $this->getOption( 'preprocessor' );
67  } elseif ( isset( $wgParserConf['preprocessorClass'] ) ) {
68  $name = $wgParserConf['preprocessorClass'];
69  } else {
71  }
72 
73  $wgParser->firstCallInit();
74  $this->mPreprocessor = new $name( $this );
75  }
76 
81  public function processRevision( $rev ) {
82  $content = $rev->getContent( Revision::RAW );
83 
84  if ( $content->getModel() !== CONTENT_MODEL_WIKITEXT ) {
85  return;
86  }
87 
88  try {
89  $this->mPreprocessor->preprocessToObj( strval( $content->getNativeData() ), 0 );
90  } catch ( Exception $e ) {
91  $this->error( "Caught exception " . $e->getMessage() . " in "
92  . $rev->getTitle()->getPrefixedText() );
93  }
94  }
95 }
96 
98 require_once RUN_MAINTENANCE_IF_MAIN;
PreprocessDump
Maintenance script that takes page text out of an XML dump file and preprocesses it to obj.
Definition: preprocessDump.php:36
$wgParser
$wgParser
Definition: Setup.php:917
$wgParserConf
$wgParserConf
Parser configuration.
Definition: DefaultSettings.php:4170
PreprocessDump\$mPPNodeCount
$mPPNodeCount
Definition: preprocessDump.php:40
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
PreprocessDump\__construct
__construct()
Default constructor.
Definition: preprocessDump.php:48
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
PreprocessDump\getStripList
getStripList()
Definition: preprocessDump.php:42
$wgPreprocessorCacheThreshold
$wgPreprocessorCacheThreshold
Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache.
Definition: DefaultSettings.php:4404
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
PreprocessDump\checkOptions
checkOptions()
Definition: preprocessDump.php:58
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
PreprocessDump\getDbType
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
Definition: preprocessDump.php:54
$maintClass
$maintClass
Definition: preprocessDump.php:97
PreprocessDump\$mTitle
$mTitle
Definition: preprocessDump.php:39
Revision\RAW
const RAW
Definition: Revision.php:57
Maintenance\DB_NONE
const DB_NONE
Constants for DB access type.
Definition: Maintenance.php:66
DumpIterator
Base class for interating over a dump.
Definition: dumpIterator.php:36
$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
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
PreprocessDump\processRevision
processRevision( $rev)
Callback function for each revision, preprocessToObj()
Definition: preprocessDump.php:81
class
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:56
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171