MediaWiki REL1_32
cleanupTable.inc
Go to the documentation of this file.
1<?php
24require_once __DIR__ . '/Maintenance.php';
25
32 protected $defaultParams = [
33 'table' => 'page',
34 'conds' => [],
35 'index' => 'page_id',
36 'callback' => 'processRow',
37 ];
38
39 protected $dryrun = false;
40 public $batchSize = 100;
41 public $reportInterval = 100;
42
44
45 public function __construct() {
46 parent::__construct();
47 $this->addOption( 'dry-run', 'Perform a dry run' );
48 }
49
50 public function execute() {
51 global $wgUser;
52 $this->dryrun = $this->hasOption( 'dry-run' );
53 if ( $this->dryrun ) {
54 $wgUser = User::newFromName( 'Conversion script' );
55 $this->output( "Checking for bad titles...\n" );
56 } else {
57 $wgUser = User::newSystemUser( 'Conversion script', [ 'steal' => true ] );
58 $this->output( "Checking and fixing bad titles...\n" );
59 }
60 $this->runTable( $this->defaultParams );
61 }
62
63 protected function init( $count, $table ) {
64 $this->processed = 0;
65 $this->updated = 0;
66 $this->count = $count;
67 $this->startTime = microtime( true );
68 $this->table = $table;
69 }
70
74 protected function progress( $updated ) {
75 $this->updated += $updated;
76 $this->processed++;
77 if ( $this->processed % $this->reportInterval != 0 ) {
78 return;
79 }
80 $portion = $this->processed / $this->count;
81 $updateRate = $this->updated / $this->processed;
82
83 $now = microtime( true );
84 $delta = $now - $this->startTime;
85 $estimatedTotalTime = $delta / $portion;
86 $eta = $this->startTime + $estimatedTotalTime;
87
88 $this->output(
89 sprintf( "%s %s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
90 wfWikiID(),
91 wfTimestamp( TS_DB, intval( $now ) ),
92 $portion * 100.0,
93 $this->table,
94 wfTimestamp( TS_DB, intval( $eta ) ),
95 $this->processed,
96 $this->count,
97 $this->processed / $delta,
98 $updateRate * 100.0
99 )
100 );
101 flush();
102 }
103
108 public function runTable( $params ) {
109 $dbr = $this->getDB( DB_REPLICA );
110
111 if ( array_diff( array_keys( $params ),
112 [ 'table', 'conds', 'index', 'callback' ] )
113 ) {
114 throw new MWException( __METHOD__ . ': Missing parameter ' . implode( ', ', $params ) );
115 }
116
117 $table = $params['table'];
118 // count(*) would melt the DB for huge tables, we can estimate here
119 $count = $dbr->estimateRowCount( $table, '*', '', __METHOD__ );
120 $this->init( $count, $table );
121 $this->output( "Processing $table...\n" );
122
123 $index = (array)$params['index'];
124 $indexConds = [];
125 $options = [
126 'ORDER BY' => implode( ',', $index ),
127 'LIMIT' => $this->batchSize
128 ];
129 $callback = [ $this, $params['callback'] ];
130
131 while ( true ) {
132 $conds = array_merge( $params['conds'], $indexConds );
133 $res = $dbr->select( $table, '*', $conds, __METHOD__, $options );
134 if ( !$res->numRows() ) {
135 // Done
136 break;
137 }
138
139 foreach ( $res as $row ) {
140 call_user_func( $callback, $row );
141 }
142
143 if ( $res->numRows() < $this->batchSize ) {
144 // Done
145 break;
146 }
147
148 // Update the conditions to select the next batch.
149 // Construct a condition string by starting with the least significant part
150 // of the index, and adding more significant parts progressively to the left
151 // of the string.
152 $nextCond = '';
153 foreach ( array_reverse( $index ) as $field ) {
154 $encValue = $dbr->addQuotes( $row->$field );
155 if ( $nextCond === '' ) {
156 $nextCond = "$field > $encValue";
157 } else {
158 $nextCond = "$field > $encValue OR ($field = $encValue AND ($nextCond))";
159 }
160 }
161 $indexConds = [ $nextCond ];
162 }
163
164 $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
165 }
166
171 protected function hexChar( $matches ) {
172 return sprintf( "\\x%02x", ord( $matches[1] ) );
173 }
174}
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
MediaWiki exception.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
output( $out, $channel=null)
Throw some output to the user.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular option exists.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Generic class to cleanup a database table.
progress( $updated)
init( $count, $table)
execute()
Do the actual work.
hexChar( $matches)
runTable( $params)
__construct()
Default constructor.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition User.php:819
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition deferred.txt:16
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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:2050
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
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
const DB_REPLICA
Definition defines.php:25
$params