MediaWiki REL1_39
compressOld.php
Go to the documentation of this file.
1<?php
45
46require_once __DIR__ . '/../Maintenance.php';
47
53class CompressOld extends Maintenance {
54 public function __construct() {
55 parent::__construct();
56 $this->addDescription( 'Compress the text of a wiki' );
57 $this->addOption( 'type', 'Set compression type to either: gzip|concat', false, true, 't' );
58 $this->addOption(
59 'chunksize',
60 'Maximum number of revisions in a concat chunk',
61 false,
62 true,
63 'c'
64 );
65 $this->addOption(
66 'begin-date',
67 'Earliest date to check for uncompressed revisions',
68 false,
69 true,
70 'b'
71 );
72 $this->addOption( 'end-date', 'Latest revision date to compress', false, true, 'e' );
73 $this->addOption(
74 'startid',
75 'The id to start from (gzip -> text table, concat -> page table)',
76 false,
77 true,
78 's'
79 );
80 $this->addOption(
81 'extdb',
82 'Store specified revisions in an external cluster (untested)',
83 false,
84 true
85 );
86 $this->addOption(
87 'endid',
88 'The page_id to stop at (only when using concat compression type)',
89 false,
90 true,
91 'n'
92 );
93 }
94
95 public function execute() {
96 global $wgDBname;
97 if ( !function_exists( "gzdeflate" ) ) {
98 $this->fatalError( "You must enable zlib support in PHP to compress old revisions!\n" .
99 "Please see https://www.php.net/manual/en/ref.zlib.php\n" );
100 }
101
102 $type = $this->getOption( 'type', 'concat' );
103 $chunkSize = $this->getOption( 'chunksize', 20 );
104 $startId = $this->getOption( 'startid', 0 );
105 $beginDate = $this->getOption( 'begin-date', '' );
106 $endDate = $this->getOption( 'end-date', '' );
107 $extDB = $this->getOption( 'extdb', '' );
108 $endId = $this->getOption( 'endid', false );
109
110 if ( $type != 'concat' && $type != 'gzip' ) {
111 $this->error( "Type \"{$type}\" not supported" );
112 }
113
114 if ( $extDB != '' ) {
115 $this->output( "Compressing database {$wgDBname} to external cluster {$extDB}\n"
116 . str_repeat( '-', 76 ) . "\n\n" );
117 } else {
118 $this->output( "Compressing database {$wgDBname}\n"
119 . str_repeat( '-', 76 ) . "\n\n" );
120 }
121
122 $success = true;
123 if ( $type == 'concat' ) {
124 $success = $this->compressWithConcat( $startId, $chunkSize, $beginDate,
125 $endDate, $extDB, $endId );
126 } else {
127 $this->compressOldPages( $startId, $extDB );
128 }
129
130 if ( $success ) {
131 $this->output( "Done.\n" );
132 }
133 }
134
141 private function compressOldPages( $start = 0, $extdb = '' ) {
142 $chunksize = 50;
143 $this->output( "Starting from old_id $start...\n" );
144 $dbw = $this->getDB( DB_PRIMARY );
145 do {
146 $res = $dbw->select(
147 'text',
148 [ 'old_id', 'old_flags', 'old_text' ],
149 "old_id>=$start",
150 __METHOD__,
151 [ 'ORDER BY' => 'old_id', 'LIMIT' => $chunksize, 'FOR UPDATE' ]
152 );
153
154 if ( $res->numRows() == 0 ) {
155 break;
156 }
157
158 $last = $start;
159
160 foreach ( $res as $row ) {
161 # print " {$row->old_id} - {$row->old_namespace}:{$row->old_title}\n";
162 $this->compressPage( $row, $extdb );
163 $last = $row->old_id;
164 }
165
166 $start = $last + 1; # Deletion may leave long empty stretches
167 $this->output( "$start...\n" );
168 } while ( true );
169 }
170
178 private function compressPage( $row, $extdb ) {
179 if ( strpos( $row->old_flags, 'gzip' ) !== false
180 || strpos( $row->old_flags, 'object' ) !== false
181 ) {
182 # print "Already compressed row {$row->old_id}\n";
183 return false;
184 }
185 $dbw = $this->getDB( DB_PRIMARY );
186 $flags = $row->old_flags ? "{$row->old_flags},gzip" : "gzip";
187 $compress = gzdeflate( $row->old_text );
188
189 # Store in external storage if required
190 if ( $extdb !== '' ) {
191 $esFactory = MediaWikiServices::getInstance()->getExternalStoreFactory();
193 $storeObj = $esFactory->getStore( 'DB' );
194 $compress = $storeObj->store( $extdb, $compress );
195 if ( $compress === false ) {
196 $this->error( "Unable to store object" );
197
198 return false;
199 }
200 }
201
202 # Update text row
203 $dbw->update( 'text',
204 [ /* SET */
205 'old_flags' => $flags,
206 'old_text' => $compress
207 ], [ /* WHERE */
208 'old_id' => $row->old_id
209 ], __METHOD__,
210 [ 'LIMIT' => 1 ]
211 );
212
213 return true;
214 }
215
227 private function compressWithConcat( $startId, $maxChunkSize, $beginDate,
228 $endDate, $extdb = "", $maxPageId = false
229 ) {
230 $dbr = $this->getDB( DB_REPLICA );
231 $dbw = $this->getDB( DB_PRIMARY );
232
233 # Set up external storage
234 if ( $extdb != '' ) {
235 $esFactory = MediaWikiServices::getInstance()->getExternalStoreFactory();
237 $storeObj = $esFactory->getStore( 'DB' );
238 }
239
240 $blobStore = MediaWikiServices::getInstance()
241 ->getBlobStoreFactory()
242 ->newSqlBlobStore();
243
244 # Get all articles by page_id
245 if ( !$maxPageId ) {
246 $maxPageId = $dbr->selectField( 'page', 'max(page_id)', '', __METHOD__ );
247 }
248 $this->output( "Starting from $startId of $maxPageId\n" );
249 $pageConds = [];
250
251 /*
252 if ( $exclude_ns0 ) {
253 print "Excluding main namespace\n";
254 $pageConds[] = 'page_namespace<>0';
255 }
256 if ( $queryExtra ) {
257 $pageConds[] = $queryExtra;
258 }
259 */
260
261 # For each article, get a list of revisions which fit the criteria
262
263 # No recompression, use a condition on old_flags
264 # Don't compress object type entities, because that might produce data loss when
265 # overwriting bulk storage concat rows. Don't compress external references, because
266 # the script doesn't yet delete rows from external storage.
267 $conds = [
268 'old_flags NOT ' . $dbr->buildLike( $dbr->anyString(), 'object', $dbr->anyString() )
269 . ' AND old_flags NOT '
270 . $dbr->buildLike( $dbr->anyString(), 'external', $dbr->anyString() )
271 ];
272
273 if ( $beginDate ) {
274 if ( !preg_match( '/^\d{14}$/', $beginDate ) ) {
275 $this->error( "Invalid begin date \"$beginDate\"\n" );
276
277 return false;
278 }
279 $conds[] = "rev_timestamp>'" . $beginDate . "'";
280 }
281 if ( $endDate ) {
282 if ( !preg_match( '/^\d{14}$/', $endDate ) ) {
283 $this->error( "Invalid end date \"$endDate\"\n" );
284
285 return false;
286 }
287 $conds[] = "rev_timestamp<'" . $endDate . "'";
288 }
289
290 $slotRoleStore = MediaWikiServices::getInstance()->getSlotRoleStore();
291 $tables = [ 'revision', 'slots', 'content', 'text' ];
292 $conds = array_merge( [
293 'rev_id=slot_revision_id',
294 'slot_role_id=' . $slotRoleStore->getId( SlotRecord::MAIN ),
295 'content_id=slot_content_id',
296 'SUBSTRING(content_address, 1, 3)=' . $dbr->addQuotes( 'tt:' ),
297 'SUBSTRING(content_address, 4)=old_id',
298 ], $conds );
299
300 $fields = [ 'rev_id', 'old_id', 'old_flags', 'old_text' ];
301 $revLoadOptions = 'FOR UPDATE';
302
303 # Don't work with current revisions
304 # Don't lock the page table for update either -- TS 2006-04-04
305 # $tables[] = 'page';
306 # $conds[] = 'page_id=rev_page AND rev_id != page_latest';
307
308 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
309
310 for ( $pageId = $startId; $pageId <= $maxPageId; $pageId++ ) {
311 $lbFactory->waitForReplication();
312
313 # Wake up
314 $dbr->ping();
315
316 # Get the page row
317 $pageRes = $dbr->select( 'page',
318 [ 'page_id', 'page_namespace', 'page_title', 'page_latest' ],
319 $pageConds + [ 'page_id' => $pageId ], __METHOD__ );
320 if ( $pageRes->numRows() == 0 ) {
321 continue;
322 }
323 $pageRow = $pageRes->fetchObject();
324
325 # Display progress
326 $titleObj = Title::makeTitle( $pageRow->page_namespace, $pageRow->page_title );
327 $this->output( "$pageId\t" . $titleObj->getPrefixedDBkey() . " " );
328
329 # Load revisions
330 $revRes = $dbw->select( $tables, $fields,
331 array_merge( [
332 'rev_page' => $pageRow->page_id,
333 # Don't operate on the current revision
334 # Use < instead of <> in case the current revision has changed
335 # since the page select, which wasn't locking
336 'rev_id < ' . (int)$pageRow->page_latest
337 ], $conds ),
338 __METHOD__,
339 $revLoadOptions
340 );
341 $revs = [];
342 foreach ( $revRes as $revRow ) {
343 $revs[] = $revRow;
344 }
345
346 if ( count( $revs ) < 2 ) {
347 # No revisions matching, no further processing
348 $this->output( "\n" );
349 continue;
350 }
351
352 # For each chunk
353 $i = 0;
354 while ( $i < count( $revs ) ) {
355 if ( $i < count( $revs ) - $maxChunkSize ) {
356 $thisChunkSize = $maxChunkSize;
357 } else {
358 $thisChunkSize = count( $revs ) - $i;
359 }
360
361 $chunk = new ConcatenatedGzipHistoryBlob();
362 $stubs = [];
363 $this->beginTransaction( $dbw, __METHOD__ );
364 $usedChunk = false;
365 $primaryOldid = $revs[$i]->old_id;
366
367 # Get the text of each revision and add it to the object
368 for ( $j = 0; $j < $thisChunkSize && $chunk->isHappy(); $j++ ) {
369 $oldid = $revs[$i + $j]->old_id;
370
371 # Get text. We do not need the full `extractBlob` since the query is built
372 # to fetch non-externalstore blobs.
373 $text = $blobStore->decompressData(
374 $revs[$i + $j]->old_text,
375 explode( ',', $revs[$i + $j]->old_flags )
376 );
377
378 if ( $text === false ) {
379 $this->error( "\nError, unable to get text in old_id $oldid" );
380 # $dbw->delete( 'old', [ 'old_id' => $oldid ] );
381 }
382
383 if ( $extdb == "" && $j == 0 ) {
384 $chunk->setText( $text );
385 $this->output( '.' );
386 } else {
387 # Don't make a stub if it's going to be longer than the article
388 # Stubs are typically about 100 bytes
389 if ( strlen( $text ) < 120 ) {
390 $stub = false;
391 $this->output( 'x' );
392 } else {
393 $stub = new HistoryBlobStub( $chunk->addItem( $text ) );
394 $stub->setLocation( $primaryOldid );
395 $stub->setReferrer( $oldid );
396 $this->output( '.' );
397 $usedChunk = true;
398 }
399 $stubs[$j] = $stub;
400 }
401 }
402 $thisChunkSize = $j;
403
404 # If we couldn't actually use any stubs because the pages were too small, do nothing
405 if ( $usedChunk ) {
406 if ( $extdb != "" ) {
407 # Move blob objects to External Storage
408 // @phan-suppress-next-line PhanPossiblyUndeclaredVariable storeObj is set when used
409 $stored = $storeObj->store( $extdb, serialize( $chunk ) );
410 if ( $stored === false ) {
411 $this->error( "Unable to store object" );
412
413 return false;
414 }
415 # Store External Storage URLs instead of Stub placeholders
416 foreach ( $stubs as $stub ) {
417 if ( $stub === false ) {
418 continue;
419 }
420 # $stored should provide base path to a BLOB
421 $url = $stored . "/" . $stub->getHash();
422 $dbw->update( 'text',
423 [ /* SET */
424 'old_text' => $url,
425 'old_flags' => 'external,utf-8',
426 ], [ /* WHERE */
427 'old_id' => $stub->getReferrer(),
428 ],
429 __METHOD__
430 );
431 }
432 } else {
433 # Store the main object locally
434 $dbw->update( 'text',
435 [ /* SET */
436 'old_text' => serialize( $chunk ),
437 'old_flags' => 'object,utf-8',
438 ], [ /* WHERE */
439 'old_id' => $primaryOldid
440 ],
441 __METHOD__
442 );
443
444 # Store the stub objects
445 for ( $j = 1; $j < $thisChunkSize; $j++ ) {
446 # Skip if not compressing and don't overwrite the first revision
447 if ( $stubs[$j] !== false && $revs[$i + $j]->old_id != $primaryOldid ) {
448 $dbw->update( 'text',
449 [ /* SET */
450 'old_text' => serialize( $stubs[$j] ),
451 'old_flags' => 'object,utf-8',
452 ], [ /* WHERE */
453 'old_id' => $revs[$i + $j]->old_id
454 ],
455 __METHOD__
456 );
457 }
458 }
459 }
460 }
461 # Done, next
462 $this->output( "/" );
463 $this->commitTransaction( $dbw, __METHOD__ );
464 $i += $thisChunkSize;
465 }
466 $this->output( "\n" );
467 }
468
469 return true;
470 }
471}
472
473$maintClass = CompressOld::class;
474require_once RUN_MAINTENANCE_IF_MAIN;
serialize()
getDB()
Maintenance script that compress the text of a wiki.
execute()
Do the actual work.
__construct()
Default constructor.
Concatenated gzip (CGZ) storage Improves compression ratio by concatenating like objects before gzipp...
Pointer object for an item within a CGZ blob stored in the text table.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
beginTransaction(IDatabase $dbw, $fname)
Begin a transaction on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transaction on a DB handle and wait for replica DBs to catch up.
output( $out, $channel=null)
Throw some output to the user.
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.
Service locator for MediaWiki core services.
Value object representing a content slot associated with a page revision.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition Title.php:638
$maintClass
$wgDBname
Config variable stub for the DBname setting, for use by phpdoc and IDEs.
const DB_REPLICA
Definition defines.php:26
const DB_PRIMARY
Definition defines.php:28