36require_once __DIR__ .
'/Maintenance.php';
52 parent::__construct();
54 $this->
addOption(
'file',
'File with text to run.',
false,
true );
55 $this->
addOption(
'dump',
'XML dump to execute all revisions.',
false,
true );
56 $this->
addOption(
'from',
'Article from XML dump to start from.',
false,
true );
61 $this->
fatalError(
"You must provide a file or dump" );
69 $text = file_get_contents( $file );
70 $title = Title::newFromText( rawurldecode( basename( $file,
'.txt' ) ) );
71 $revision->setTitle( $title );
72 $content = ContentHandler::makeContent( $text, $title );
73 $revision->setContent( SlotRecord::MAIN, $content );
81 $this->startTime = microtime(
true );
83 if ( $this->
getOption(
'dump' ) ==
'-' ) {
86 $this->
fatalError(
"Sorry, I don't support dump filenames yet. "
87 .
"Use - and provide it on stdin on the meantime." );
90 $user = User::newSystemUser( User::MAINTENANCE_SCRIPT_USER, [
'steal' =>
true ] );
93 ->getWikiImporterFactory()
96 $importer->setRevisionCallback(
97 [ $this,
'handleRevision' ] );
98 $importer->setNoticeCallback(
static function ( $msg,
$params ) {
102 $this->from = $this->
getOption(
'from',
null );
104 $importer->doImport();
108 $delta = microtime(
true ) - $this->startTime;
109 $this->
error(
"Done {$this->count} revisions in " . round( $delta, 2 ) .
" seconds " );
111 $this->
error( round( $this->count / $delta, 2 ) .
" pages/sec" );
114 # Perform the memory_get_peak_usage() when all the other data has been
115 # output so there's no damage if it dies. It is only available since
116 # 5.2.0 (since 5.2.1 if you haven't compiled with --enable-memory-limit)
117 $this->
error(
"Memory peak usage of " . memory_get_peak_usage() .
" bytes\n" );
121 parent::finalSetup( $settingsBuilder );
128 $wgHooks[
'InterwikiLoadPrefix'][] =
'DumpIterator::disableInterwikis';
131 MainConfigNames::UseDatabaseMessages =>
false,
132 MainConfigNames::LocalisationCacheConf => [
'storeClass' => LCStoreNull::class ],
138 # Title::newFromText will check on each namespaced article if it's an interwiki.
139 # We always answer that it is not.
150 $title = $rev->getTitle();
152 $this->
error(
"Got bogus revision with null title!" );
158 if ( $this->from !==
false ) {
159 if ( $this->from != $title ) {
162 $this->
output(
"Skipped " . ( $this->count - 1 ) .
" pages\n" );
199 parent::__construct();
200 $this->
addDescription(
'Runs a regex in the revisions from a dump' );
201 $this->
addOption(
'regex',
'Searching regex',
true,
true );
212 if ( preg_match( $this->
getOption(
'regex' ), $rev->
getContent()->getTextForSearchIndex() ) ) {
219require_once RUN_MAINTENANCE_IF_MAIN;
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
array $params
The job parameters.
Base class for iterating over a dump.
static disableInterwikis( $prefix, &$data)
__construct()
Default constructor.
execute()
Do the actual work.
processRevision(WikiRevision $rev)
Core function which does whatever the maintenance script is designed to do.
conclusions()
Stub function for giving data about what was computed.
checkOptions()
Stub function for processing additional options.
handleRevision( $rev)
Callback function for each revision, child classes should override processRevision instead.
finalSetup(SettingsBuilder $settingsBuilder)
Handle some last-minute setup here.
Imports a XML dump from a file (either from file upload, files on disk, or HTTP)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
const DB_NONE
Constants for DB access type.
output( $out, $channel=null)
Throw some output to the user.
getStdin( $len=null)
Return input from stdin.
hasOption( $name)
Checks to see if a particular option was set.
getServiceContainer()
Returns the main service container.
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
A class containing constants representing the names of configuration variables.
Maintenance script that runs a regex in the revisions from a dump.
__construct()
Default constructor.
processRevision(WikiRevision $rev)
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
Represents a revision, log entry or upload during the import process.
getContent( $role=SlotRecord::MAIN)
$wgHooks
Config variable stub for the Hooks setting, for use by phpdoc and IDEs.