MediaWiki  master
recompressTracked.php
Go to the documentation of this file.
1 <?php
29 
31 require __DIR__ . '/../commandLine.inc';
32 
33 if ( count( $args ) < 1 ) {
34  echo "Usage: php recompressTracked.php [options] <cluster> [... <cluster>...]
35 Moves blobs indexed by trackBlobs.php to a specified list of destination clusters,
36 and recompresses them in the process. Restartable.
37 
38 Options:
39  --procs <procs> Set the number of child processes (default 1)
40  --copy-only Copy only, do not update the text table. Restart
41  without this option to complete.
42  --debug-log <file> Log debugging data to the specified file
43  --info-log <file> Log progress messages to the specified file
44  --critical-log <file> Log error messages to the specified file
45 ";
46  exit( 1 );
47 }
48 
50 $job->execute();
51 
59  public $destClusters;
60  public $batchSize = 1000;
61  public $orphanBatchSize = 1000;
62  public $reportingInterval = 10;
63  public $numProcs = 1;
64  public $numBatches = 0;
67  public $copyOnly = false;
68  public $isChild = false;
69  public $replicaId = false;
70  public $noCount = false;
72  public $store;
73 
74  private static $optionsWithArgs = [
75  'procs',
76  'replica-id',
77  'debug-log',
78  'info-log',
79  'critical-log'
80  ];
81 
82  private static $cmdLineOptionMap = [
83  'no-count' => 'noCount',
84  'procs' => 'numProcs',
85  'copy-only' => 'copyOnly',
86  'child' => 'isChild',
87  'replica-id' => 'replicaId',
88  'debug-log' => 'debugLog',
89  'info-log' => 'infoLog',
90  'critical-log' => 'criticalLog',
91  ];
92 
93  static function getOptionsWithArgs() {
95  }
96 
97  static function newFromCommandLine( $args, $options ) {
98  $jobOptions = [ 'destClusters' => $args ];
99  foreach ( self::$cmdLineOptionMap as $cmdOption => $classOption ) {
100  if ( isset( $options[$cmdOption] ) ) {
101  $jobOptions[$classOption] = $options[$cmdOption];
102  }
103  }
104 
105  return new self( $jobOptions );
106  }
107 
108  function __construct( $options ) {
109  foreach ( $options as $name => $value ) {
110  $this->$name = $value;
111  }
112  $this->store = new ExternalStoreDB;
113  if ( !$this->isChild ) {
114  $GLOBALS['wgDebugLogPrefix'] = "RCT M: ";
115  } elseif ( $this->replicaId !== false ) {
116  $GLOBALS['wgDebugLogPrefix'] = "RCT {$this->replicaId}: ";
117  }
118  $this->pageBlobClass = function_exists( 'xdiff_string_bdiff' ) ?
120  $this->orphanBlobClass = ConcatenatedGzipHistoryBlob::class;
121  }
122 
123  function debug( $msg ) {
124  wfDebug( "$msg\n" );
125  if ( $this->debugLog ) {
126  $this->logToFile( $msg, $this->debugLog );
127  }
128  }
129 
130  function info( $msg ) {
131  echo "$msg\n";
132  if ( $this->infoLog ) {
133  $this->logToFile( $msg, $this->infoLog );
134  }
135  }
136 
137  function critical( $msg ) {
138  echo "$msg\n";
139  if ( $this->criticalLog ) {
140  $this->logToFile( $msg, $this->criticalLog );
141  }
142  }
143 
144  function logToFile( $msg, $file ) {
145  $header = '[' . date( 'd\TH:i:s' ) . '] ' . wfHostname() . ' ' . posix_getpid();
146  if ( $this->replicaId !== false ) {
147  $header .= "({$this->replicaId})";
148  }
149  $header .= ' ' . wfWikiID();
150  LegacyLogger::emit( sprintf( "%-50s %s\n", $header, $msg ), $file );
151  }
152 
158  function syncDBs() {
159  $dbw = wfGetDB( DB_MASTER );
160  $dbr = wfGetDB( DB_REPLICA );
161  $pos = $dbw->getMasterPos();
162  $dbr->masterPosWait( $pos, 100000 );
163  }
164 
168  function execute() {
169  if ( $this->isChild ) {
170  $this->executeChild();
171  } else {
172  $this->executeParent();
173  }
174  }
175 
179  function executeParent() {
180  if ( !$this->checkTrackingTable() ) {
181  return;
182  }
183 
184  $this->syncDBs();
185  $this->startReplicaProcs();
186  $this->doAllPages();
187  $this->doAllOrphans();
188  $this->killReplicaProcs();
189  }
190 
195  function checkTrackingTable() {
196  $dbr = wfGetDB( DB_REPLICA );
197  if ( !$dbr->tableExists( 'blob_tracking' ) ) {
198  $this->critical( "Error: blob_tracking table does not exist" );
199 
200  return false;
201  }
202  $row = $dbr->selectRow( 'blob_tracking', '*', '', __METHOD__ );
203  if ( !$row ) {
204  $this->info( "Warning: blob_tracking table contains no rows, skipping this wiki." );
205 
206  return false;
207  }
208 
209  return true;
210  }
211 
218  function startReplicaProcs() {
219  $cmd = 'php ' . Shell::escape( __FILE__ );
220  foreach ( self::$cmdLineOptionMap as $cmdOption => $classOption ) {
221  if ( $cmdOption == 'replica-id' ) {
222  continue;
223  } elseif ( in_array( $cmdOption, self::$optionsWithArgs ) && isset( $this->$classOption ) ) {
224  $cmd .= " --$cmdOption " . Shell::escape( $this->$classOption );
225  } elseif ( $this->$classOption ) {
226  $cmd .= " --$cmdOption";
227  }
228  }
229  $cmd .= ' --child' .
230  ' --wiki ' . Shell::escape( wfWikiID() ) .
231  ' ' . Shell::escape( ...$this->destClusters );
232 
233  $this->replicaPipes = $this->replicaProcs = [];
234  for ( $i = 0; $i < $this->numProcs; $i++ ) {
235  $pipes = [];
236  $spec = [
237  [ 'pipe', 'r' ],
238  [ 'file', 'php://stdout', 'w' ],
239  [ 'file', 'php://stderr', 'w' ]
240  ];
241  Wikimedia\suppressWarnings();
242  $proc = proc_open( "$cmd --replica-id $i", $spec, $pipes );
243  Wikimedia\restoreWarnings();
244  if ( !$proc ) {
245  $this->critical( "Error opening replica DB process: $cmd" );
246  exit( 1 );
247  }
248  $this->replicaProcs[$i] = $proc;
249  $this->replicaPipes[$i] = $pipes[0];
250  }
251  $this->prevReplicaId = -1;
252  }
253 
257  function killReplicaProcs() {
258  $this->info( "Waiting for replica DB processes to finish..." );
259  for ( $i = 0; $i < $this->numProcs; $i++ ) {
260  $this->dispatchToReplica( $i, 'quit' );
261  }
262  for ( $i = 0; $i < $this->numProcs; $i++ ) {
263  $status = proc_close( $this->replicaProcs[$i] );
264  if ( $status ) {
265  $this->critical( "Warning: child #$i exited with status $status" );
266  }
267  }
268  $this->info( "Done." );
269  }
270 
275  function dispatch( ...$args ) {
276  $pipes = $this->replicaPipes;
277  $x = [];
278  $y = [];
279  $numPipes = stream_select( $x, $pipes, $y, 3600 );
280  if ( !$numPipes ) {
281  $this->critical( "Error waiting to write to replica DBs. Aborting" );
282  exit( 1 );
283  }
284  for ( $i = 0; $i < $this->numProcs; $i++ ) {
285  $replicaId = ( $i + $this->prevReplicaId + 1 ) % $this->numProcs;
286  if ( isset( $pipes[$replicaId] ) ) {
287  $this->prevReplicaId = $replicaId;
288  $this->dispatchToReplica( $replicaId, $args );
289 
290  return;
291  }
292  }
293  $this->critical( "Unreachable" );
294  exit( 1 );
295  }
296 
303  $args = (array)$args;
304  $cmd = implode( ' ', $args );
305  fwrite( $this->replicaPipes[$replicaId], "$cmd\n" );
306  }
307 
311  function doAllPages() {
312  $dbr = wfGetDB( DB_REPLICA );
313  $i = 0;
314  $startId = 0;
315  if ( $this->noCount ) {
316  $numPages = '[unknown]';
317  } else {
318  $numPages = $dbr->selectField( 'blob_tracking',
319  'COUNT(DISTINCT bt_page)',
320  # A condition is required so that this query uses the index
321  [ 'bt_moved' => 0 ],
322  __METHOD__
323  );
324  }
325  if ( $this->copyOnly ) {
326  $this->info( "Copying pages..." );
327  } else {
328  $this->info( "Moving pages..." );
329  }
330  while ( true ) {
331  $res = $dbr->select( 'blob_tracking',
332  [ 'bt_page' ],
333  [
334  'bt_moved' => 0,
335  'bt_page > ' . $dbr->addQuotes( $startId )
336  ],
337  __METHOD__,
338  [
339  'DISTINCT',
340  'ORDER BY' => 'bt_page',
341  'LIMIT' => $this->batchSize,
342  ]
343  );
344  if ( !$res->numRows() ) {
345  break;
346  }
347  foreach ( $res as $row ) {
348  $startId = $row->bt_page;
349  $this->dispatch( 'doPage', $row->bt_page );
350  $i++;
351  }
352  $this->report( 'pages', $i, $numPages );
353  }
354  $this->report( 'pages', $i, $numPages );
355  if ( $this->copyOnly ) {
356  $this->info( "All page copies queued." );
357  } else {
358  $this->info( "All page moves queued." );
359  }
360  }
361 
368  function report( $label, $current, $end ) {
369  $this->numBatches++;
370  if ( $current == $end || $this->numBatches >= $this->reportingInterval ) {
371  $this->numBatches = 0;
372  $this->info( "$label: $current / $end" );
373  MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->waitForReplication();
374  }
375  }
376 
380  function doAllOrphans() {
381  $dbr = wfGetDB( DB_REPLICA );
382  $startId = 0;
383  $i = 0;
384  if ( $this->noCount ) {
385  $numOrphans = '[unknown]';
386  } else {
387  $numOrphans = $dbr->selectField( 'blob_tracking',
388  'COUNT(DISTINCT bt_text_id)',
389  [ 'bt_moved' => 0, 'bt_page' => 0 ],
390  __METHOD__ );
391  if ( !$numOrphans ) {
392  return;
393  }
394  }
395  if ( $this->copyOnly ) {
396  $this->info( "Copying orphans..." );
397  } else {
398  $this->info( "Moving orphans..." );
399  }
400 
401  while ( true ) {
402  $res = $dbr->select( 'blob_tracking',
403  [ 'bt_text_id' ],
404  [
405  'bt_moved' => 0,
406  'bt_page' => 0,
407  'bt_text_id > ' . $dbr->addQuotes( $startId )
408  ],
409  __METHOD__,
410  [
411  'DISTINCT',
412  'ORDER BY' => 'bt_text_id',
413  'LIMIT' => $this->batchSize
414  ]
415  );
416  if ( !$res->numRows() ) {
417  break;
418  }
419  $ids = [];
420  foreach ( $res as $row ) {
421  $startId = $row->bt_text_id;
422  $ids[] = $row->bt_text_id;
423  $i++;
424  }
425  // Need to send enough orphan IDs to the child at a time to fill a blob,
426  // so orphanBatchSize needs to be at least ~100.
427  // batchSize can be smaller or larger.
428  while ( count( $ids ) > $this->orphanBatchSize ) {
429  $args = array_slice( $ids, 0, $this->orphanBatchSize );
430  $ids = array_slice( $ids, $this->orphanBatchSize );
431  array_unshift( $args, 'doOrphanList' );
432  $this->dispatch( ...$args );
433  }
434  if ( count( $ids ) ) {
435  $args = $ids;
436  array_unshift( $args, 'doOrphanList' );
437  $this->dispatch( ...$args );
438  }
439 
440  $this->report( 'orphans', $i, $numOrphans );
441  }
442  $this->report( 'orphans', $i, $numOrphans );
443  $this->info( "All orphans queued." );
444  }
445 
449  function executeChild() {
450  $this->debug( 'starting' );
451  $this->syncDBs();
452 
453  while ( !feof( STDIN ) ) {
454  $line = rtrim( fgets( STDIN ) );
455  if ( $line == '' ) {
456  continue;
457  }
458  $this->debug( $line );
459  $args = explode( ' ', $line );
460  $cmd = array_shift( $args );
461  switch ( $cmd ) {
462  case 'doPage':
463  $this->doPage( intval( $args[0] ) );
464  break;
465  case 'doOrphanList':
466  $this->doOrphanList( array_map( 'intval', $args ) );
467  break;
468  case 'quit':
469  return;
470  }
471  MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->waitForReplication();
472  }
473  }
474 
480  function doPage( $pageId ) {
481  $title = Title::newFromID( $pageId );
482  if ( $title ) {
483  $titleText = $title->getPrefixedText();
484  } else {
485  $titleText = '[deleted]';
486  }
487  $dbr = wfGetDB( DB_REPLICA );
488 
489  // Finish any incomplete transactions
490  if ( !$this->copyOnly ) {
491  $this->finishIncompleteMoves( [ 'bt_page' => $pageId ] );
492  $this->syncDBs();
493  }
494 
495  $startId = 0;
496  $trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
497 
498  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
499  while ( true ) {
500  $res = $dbr->select(
501  [ 'blob_tracking', 'text' ],
502  '*',
503  [
504  'bt_page' => $pageId,
505  'bt_text_id > ' . $dbr->addQuotes( $startId ),
506  'bt_moved' => 0,
507  'bt_new_url IS NULL',
508  'bt_text_id=old_id',
509  ],
510  __METHOD__,
511  [
512  'ORDER BY' => 'bt_text_id',
513  'LIMIT' => $this->batchSize
514  ]
515  );
516  if ( !$res->numRows() ) {
517  break;
518  }
519 
520  $lastTextId = 0;
521  foreach ( $res as $row ) {
522  $startId = $row->bt_text_id;
523  if ( $lastTextId == $row->bt_text_id ) {
524  // Duplicate (null edit)
525  continue;
526  }
527  $lastTextId = $row->bt_text_id;
528  // Load the text
529  $text = Revision::getRevisionText( $row );
530  if ( $text === false ) {
531  $this->critical( "Error loading {$row->bt_rev_id}/{$row->bt_text_id}" );
532  continue;
533  }
534 
535  // Queue it
536  if ( !$trx->addItem( $text, $row->bt_text_id ) ) {
537  $this->debug( "$titleText: committing blob with " . $trx->getSize() . " items" );
538  $trx->commit();
539  $trx = new CgzCopyTransaction( $this, $this->pageBlobClass );
540  $lbFactory->waitForReplication();
541  }
542  }
543  }
544 
545  $this->debug( "$titleText: committing blob with " . $trx->getSize() . " items" );
546  $trx->commit();
547  }
548 
562  function moveTextRow( $textId, $url ) {
563  if ( $this->copyOnly ) {
564  $this->critical( "Internal error: can't call moveTextRow() in --copy-only mode" );
565  exit( 1 );
566  }
567  $dbw = wfGetDB( DB_MASTER );
568  $dbw->begin( __METHOD__ );
569  $dbw->update( 'text',
570  [ // set
571  'old_text' => $url,
572  'old_flags' => 'external,utf-8',
573  ],
574  [ // where
575  'old_id' => $textId
576  ],
577  __METHOD__
578  );
579  $dbw->update( 'blob_tracking',
580  [ 'bt_moved' => 1 ],
581  [ 'bt_text_id' => $textId ],
582  __METHOD__
583  );
584  $dbw->commit( __METHOD__ );
585  }
586 
597  function finishIncompleteMoves( $conds ) {
598  $dbr = wfGetDB( DB_REPLICA );
599  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
600 
601  $startId = 0;
602  $conds = array_merge( $conds, [
603  'bt_moved' => 0,
604  'bt_new_url IS NOT NULL'
605  ] );
606  while ( true ) {
607  $res = $dbr->select( 'blob_tracking',
608  '*',
609  array_merge( $conds, [ 'bt_text_id > ' . $dbr->addQuotes( $startId ) ] ),
610  __METHOD__,
611  [
612  'ORDER BY' => 'bt_text_id',
613  'LIMIT' => $this->batchSize,
614  ]
615  );
616  if ( !$res->numRows() ) {
617  break;
618  }
619  $this->debug( 'Incomplete: ' . $res->numRows() . ' rows' );
620  foreach ( $res as $row ) {
621  $startId = $row->bt_text_id;
622  $this->moveTextRow( $row->bt_text_id, $row->bt_new_url );
623  if ( $row->bt_text_id % 10 == 0 ) {
624  $lbFactory->waitForReplication();
625  }
626  }
627  }
628  }
629 
634  function getTargetCluster() {
635  $cluster = next( $this->destClusters );
636  if ( $cluster === false ) {
637  $cluster = reset( $this->destClusters );
638  }
639 
640  return $cluster;
641  }
642 
648  function getExtDB( $cluster ) {
649  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
650  $lb = $lbFactory->getExternalLB( $cluster );
651 
652  return $lb->getConnection( DB_MASTER );
653  }
654 
660  function doOrphanList( $textIds ) {
661  // Finish incomplete moves
662  if ( !$this->copyOnly ) {
663  $this->finishIncompleteMoves( [ 'bt_text_id' => $textIds ] );
664  $this->syncDBs();
665  }
666 
667  $trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
668 
669  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
670  $res = wfGetDB( DB_REPLICA )->select(
671  [ 'text', 'blob_tracking' ],
672  [ 'old_id', 'old_text', 'old_flags' ],
673  [
674  'old_id' => $textIds,
675  'bt_text_id=old_id',
676  'bt_moved' => 0,
677  ],
678  __METHOD__,
679  [ 'DISTINCT' ]
680  );
681 
682  foreach ( $res as $row ) {
683  $text = Revision::getRevisionText( $row );
684  if ( $text === false ) {
685  $this->critical( "Error: cannot load revision text for old_id={$row->old_id}" );
686  continue;
687  }
688 
689  if ( !$trx->addItem( $text, $row->old_id ) ) {
690  $this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
691  $trx->commit();
692  $trx = new CgzCopyTransaction( $this, $this->orphanBlobClass );
693  $lbFactory->waitForReplication();
694  }
695  }
696  $this->debug( "[orphan]: committing blob with " . $trx->getSize() . " rows" );
697  $trx->commit();
698  }
699 }
700 
706  public $parent;
707  public $blobClass;
709  public $cgz;
710  public $referrers;
711 
717  function __construct( $parent, $blobClass ) {
718  $this->blobClass = $blobClass;
719  $this->cgz = false;
720  $this->texts = [];
721  $this->parent = $parent;
722  }
723 
731  function addItem( $text, $textId ) {
732  if ( !$this->cgz ) {
733  $class = $this->blobClass;
734  $this->cgz = new $class;
735  }
736  $hash = $this->cgz->addItem( $text );
737  $this->referrers[$textId] = $hash;
738  $this->texts[$textId] = $text;
739 
740  return $this->cgz->isHappy();
741  }
742 
743  function getSize() {
744  return count( $this->texts );
745  }
746 
750  function recompress() {
751  $class = $this->blobClass;
752  $this->cgz = new $class;
753  $this->referrers = [];
754  foreach ( $this->texts as $textId => $text ) {
755  $hash = $this->cgz->addItem( $text );
756  $this->referrers[$textId] = $hash;
757  }
758  }
759 
765  function commit() {
766  $originalCount = count( $this->texts );
767  if ( !$originalCount ) {
768  return;
769  }
770 
771  /* Check to see if the target text_ids have been moved already.
772  *
773  * We originally read from the replica DB, so this can happen when a single
774  * text_id is shared between multiple pages. It's rare, but possible
775  * if a delete/move/undelete cycle splits up a null edit.
776  *
777  * We do a locking read to prevent closer-run race conditions.
778  */
779  $dbw = wfGetDB( DB_MASTER );
780  $dbw->begin( __METHOD__ );
781  $res = $dbw->select( 'blob_tracking',
782  [ 'bt_text_id', 'bt_moved' ],
783  [ 'bt_text_id' => array_keys( $this->referrers ) ],
784  __METHOD__, [ 'FOR UPDATE' ] );
785  $dirty = false;
786  foreach ( $res as $row ) {
787  if ( $row->bt_moved ) {
788  # This row has already been moved, remove it
789  $this->parent->debug( "TRX: conflict detected in old_id={$row->bt_text_id}" );
790  unset( $this->texts[$row->bt_text_id] );
791  $dirty = true;
792  }
793  }
794 
795  // Recompress the blob if necessary
796  if ( $dirty ) {
797  if ( !count( $this->texts ) ) {
798  // All have been moved already
799  if ( $originalCount > 1 ) {
800  // This is suspcious, make noise
801  $this->parent->critical(
802  "Warning: concurrent operation detected, are there two conflicting " .
803  "processes running, doing the same job?" );
804  }
805 
806  return;
807  }
808  $this->recompress();
809  }
810 
811  // Insert the data into the destination cluster
812  $targetCluster = $this->parent->getTargetCluster();
813  $store = $this->parent->store;
814  $targetDB = $store->getMaster( $targetCluster );
815  $targetDB->clearFlag( DBO_TRX ); // we manage the transactions
816  $targetDB->begin( __METHOD__ );
817  $baseUrl = $this->parent->store->store( $targetCluster, serialize( $this->cgz ) );
818 
819  // Write the new URLs to the blob_tracking table
820  foreach ( $this->referrers as $textId => $hash ) {
821  $url = $baseUrl . '/' . $hash;
822  $dbw->update( 'blob_tracking',
823  [ 'bt_new_url' => $url ],
824  [
825  'bt_text_id' => $textId,
826  'bt_moved' => 0, # Check for concurrent conflicting update
827  ],
828  __METHOD__
829  );
830  }
831 
832  $targetDB->commit( __METHOD__ );
833  // Critical section here: interruption at this point causes blob duplication
834  // Reversing the order of the commits would cause data loss instead
835  $dbw->commit( __METHOD__ );
836 
837  // Write the new URLs to the text table and set the moved flag
838  if ( !$this->parent->copyOnly ) {
839  foreach ( $this->referrers as $textId => $hash ) {
840  $url = $baseUrl . '/' . $hash;
841  $this->parent->moveTextRow( $textId, $url );
842  }
843  }
844  }
845 }
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))
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 that
Definition: deferred.txt:11
MediaWiki Logger LegacyLogger
Definition: logger.txt:54
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:470
serialize()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
wfHostname()
Fetch server name for use in error reporting etc.
logToFile( $msg, $file)
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
$value
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 MediaWikiServices
Definition: injection.txt:23
getTargetCluster()
Returns the name of the next target cluster.
RecompressTracked $parent
const DB_MASTER
Definition: defines.php:26
commit()
Commit the blob.
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Definition: Revision.php:1048
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
if( $line===false) $args
Definition: cdb.php:64
executeParent()
Execute the parent process.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
ConcatenatedGzipHistoryBlob $cgz
doAllOrphans()
Move all orphan text to the new clusters.
doPage( $pageId)
Move tracked text in a given page.
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getExtDB( $cluster)
Gets a DB master connection for the given external cluster name.
moveTextRow( $textId, $url)
Atomic move operation.
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:1982
__construct( $parent, $blobClass)
Create a transaction from a RecompressTracked object.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to and or sell copies of the and to permit persons to whom the Software is furnished to do so
Definition: LICENSE.txt:10
addItem( $text, $textId)
Add text.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
$optionsWithArgs
Maintenance script that moves blobs indexed by trackBlobs.php to a specified list of destination clus...
executeChild()
Main entry point for worker processes.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
$GLOBALS['IP']
$header
static newFromCommandLine( $args, $options)
dispatchToReplica( $replicaId, $args)
Dispatch a command to a specified replica DB.
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
Definition: distributors.txt:9
finishIncompleteMoves( $conds)
Moves are done in two phases: bt_new_url and then bt_moved.
Class to represent a recompression operation for a single CGZ blob.
checkTrackingTable()
Make sure the tracking table exists and isn&#39;t empty.
const DBO_TRX
Definition: defines.php:12
killReplicaProcs()
Gracefully terminate the child processes.
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:35
doAllPages()
Move all tracked pages to the new clusters.
$parent
Definition: pageupdater.txt:71
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:52
dispatch(... $args)
Dispatch a command to the next available replica DB.
if(count( $args)< 1) $job
$line
Definition: cdb.php:59
recompress()
Recompress text after some aberrant modification.
static static getOptionsWithArgs()
report( $label, $current, $end)
Display a progress report.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
doOrphanList( $textIds)
Move an orphan text_id to the new cluster.
execute()
Execute parent or child depending on the isChild option.
const DB_REPLICA
Definition: defines.php:25
startReplicaProcs()
Start the worker processes.
DB accessible external objects.
syncDBs()
Wait until the selected replica DB has caught up to the master.
For a write query
Definition: database.txt:26