3 * Take page text out of an XML dump file and perform some operation on it.
4 * Used as a base class for CompareParsers and PreprocessDump.
5 * We implement below the simple task of searching inside a dump.
7 * Copyright © 2011 Platonides
8 * https://www.mediawiki.org/
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 * @ingroup Maintenance
29 require_once __DIR__
. '/Maintenance.php';
32 * Base class for interating over a dump.
34 * @ingroup Maintenance
36 abstract class DumpIterator
extends Maintenance
{
41 public function __construct() {
42 parent
::__construct();
43 $this->addDescription( 'Does something with a dump' );
44 $this->addOption( 'file', 'File with text to run.', false, true );
45 $this->addOption( 'dump', 'XML dump to execute all revisions.', false, true );
46 $this->addOption( 'from', 'Article from XML dump to start from.', false, true );
49 public function execute() {
50 if ( !( $this->hasOption( 'file' ) ^
$this->hasOption( 'dump' ) ) ) {
51 $this->fatalError( "You must provide a file or dump" );
54 $this->checkOptions();
56 if ( $this->hasOption( 'file' ) ) {
57 $revision = new WikiRevision( $this->getConfig() );
59 $revision->setText( file_get_contents( $this->getOption( 'file' ) ) );
60 $revision->setTitle( Title
::newFromText(
61 rawurldecode( basename( $this->getOption( 'file' ), '.txt' ) )
63 $this->handleRevision( $revision );
68 $this->startTime
= microtime( true );
70 if ( $this->getOption( 'dump' ) == '-' ) {
71 $source = new ImportStreamSource( $this->getStdin() );
73 $this->fatalError( "Sorry, I don't support dump filenames yet. "
74 . "Use - and provide it on stdin on the meantime." );
76 $importer = new WikiImporter( $source, $this->getConfig() );
78 $importer->setRevisionCallback(
79 [ $this, 'handleRevision' ] );
80 $importer->setNoticeCallback( function ( $msg, $params ) {
81 echo wfMessage( $msg, $params )->text() . "\n";
84 $this->from
= $this->getOption( 'from', null );
86 $importer->doImport();
90 $delta = microtime( true ) - $this->startTime
;
91 $this->error( "Done {$this->count} revisions in " . round( $delta, 2 ) . " seconds " );
93 $this->error( round( $this->count
/ $delta, 2 ) . " pages/sec" );
96 # Perform the memory_get_peak_usage() when all the other data has been
97 # output so there's no damage if it dies. It is only available since
98 # 5.2.0 (since 5.2.1 if you haven't compiled with --enable-memory-limit)
99 $this->error( "Memory peak usage of " . memory_get_peak_usage() . " bytes\n" );
102 public function finalSetup() {
103 parent
::finalSetup();
105 if ( $this->getDbType() == Maintenance
::DB_NONE
) {
106 global $wgUseDatabaseMessages, $wgLocalisationCacheConf, $wgHooks;
107 $wgUseDatabaseMessages = false;
108 $wgLocalisationCacheConf['storeClass'] = LCStoreNull
::class;
109 $wgHooks['InterwikiLoadPrefix'][] = 'DumpIterator::disableInterwikis';
113 static function disableInterwikis( $prefix, &$data ) {
114 # Title::newFromText will check on each namespaced article if it's an interwiki.
115 # We always answer that it is not.
121 * Callback function for each revision, child classes should override
122 * processRevision instead.
123 * @param WikiRevision $rev
125 public function handleRevision( $rev ) {
126 $title = $rev->getTitle();
128 $this->error( "Got bogus revision with null title!" );
134 if ( isset( $this->from
) ) {
135 if ( $this->from
!= $title ) {
138 $this->output( "Skipped " . ( $this->count
- 1 ) . " pages\n" );
144 $this->processRevision( $rev );
147 /* Stub function for processing additional options */
148 public function checkOptions() {
152 /* Stub function for giving data about what was computed */
153 public function conclusions() {
157 /* Core function which does whatever the maintenance script is designed to do */
158 abstract public function processRevision( $rev );
162 * Maintenance script that runs a regex in the revisions from a dump.
164 * @ingroup Maintenance
166 class SearchDump
extends DumpIterator
{
168 public function __construct() {
169 parent
::__construct();
170 $this->addDescription( 'Runs a regex in the revisions from a dump' );
171 $this->addOption( 'regex', 'Searching regex', true, true );
174 public function getDbType() {
175 return Maintenance
::DB_NONE
;
179 * @param Revision $rev
181 public function processRevision( $rev ) {
182 if ( preg_match( $this->getOption( 'regex' ), $rev->getContent()->getTextForSearchIndex() ) ) {
183 $this->output( $rev->getTitle() . " matches at edit from " . $rev->getTimestamp() . "\n" );
188 $maintClass = SearchDump
::class;
189 require_once RUN_MAINTENANCE_IF_MAIN
;