MediaWiki  master
FileBackendMultiWrite.php
Go to the documentation of this file.
1 <?php
45  protected $backends = [];
46 
48  protected $masterIndex = -1;
50  protected $readIndex = -1;
51 
53  protected $syncChecks = 0;
55  protected $autoResync = false;
56 
58  protected $asyncWrites = false;
59 
60  /* Possible internal backend consistency checks */
61  const CHECK_SIZE = 1;
62  const CHECK_TIME = 2;
63  const CHECK_SHA1 = 4;
64 
93  public function __construct( array $config ) {
94  parent::__construct( $config );
95  $this->syncChecks = $config['syncChecks'] ?? self::CHECK_SIZE;
96  $this->autoResync = $config['autoResync'] ?? false;
97  $this->asyncWrites = isset( $config['replication'] ) && $config['replication'] === 'async';
98  // Construct backends here rather than via registration
99  // to keep these backends hidden from outside the proxy.
100  $namesUsed = [];
101  foreach ( $config['backends'] as $index => $config ) {
102  $name = $config['name'];
103  if ( isset( $namesUsed[$name] ) ) { // don't break FileOp predicates
104  throw new LogicException( "Two or more backends defined with the name $name." );
105  }
106  $namesUsed[$name] = 1;
107  // Alter certain sub-backend settings for sanity
108  unset( $config['readOnly'] ); // use proxy backend setting
109  unset( $config['fileJournal'] ); // use proxy backend journal
110  unset( $config['lockManager'] ); // lock under proxy backend
111  $config['domainId'] = $this->domainId; // use the proxy backend wiki ID
112  if ( !empty( $config['isMultiMaster'] ) ) {
113  if ( $this->masterIndex >= 0 ) {
114  throw new LogicException( 'More than one master backend defined.' );
115  }
116  $this->masterIndex = $index; // this is the "master"
117  $config['fileJournal'] = $this->fileJournal; // log under proxy backend
118  }
119  if ( !empty( $config['readAffinity'] ) ) {
120  $this->readIndex = $index; // prefer this for reads
121  }
122  // Create sub-backend object
123  if ( !isset( $config['class'] ) ) {
124  throw new InvalidArgumentException( 'No class given for a backend config.' );
125  }
126  $class = $config['class'];
127  $this->backends[$index] = new $class( $config );
128  }
129  if ( $this->masterIndex < 0 ) { // need backends and must have a master
130  throw new LogicException( 'No master backend defined.' );
131  }
132  if ( $this->readIndex < 0 ) {
133  $this->readIndex = $this->masterIndex; // default
134  }
135  }
136 
137  final protected function doOperationsInternal( array $ops, array $opts ) {
138  $status = $this->newStatus();
139 
140  $mbe = $this->backends[$this->masterIndex]; // convenience
141 
142  // Try to lock those files for the scope of this function...
143  $scopeLock = null;
144  if ( empty( $opts['nonLocking'] ) ) {
145  // Try to lock those files for the scope of this function...
147  $scopeLock = $this->getScopedLocksForOps( $ops, $status );
148  if ( !$status->isOK() ) {
149  return $status; // abort
150  }
151  }
152  // Clear any cache entries (after locks acquired)
153  $this->clearCache();
154  $opts['preserveCache'] = true; // only locked files are cached
155  // Get the list of paths to read/write...
156  $relevantPaths = $this->fileStoragePathsForOps( $ops );
157  // Check if the paths are valid and accessible on all backends...
158  $status->merge( $this->accessibilityCheck( $relevantPaths ) );
159  if ( !$status->isOK() ) {
160  return $status; // abort
161  }
162  // Do a consistency check to see if the backends are consistent...
163  $syncStatus = $this->consistencyCheck( $relevantPaths );
164  if ( !$syncStatus->isOK() ) {
165  wfDebugLog( 'FileOperation', static::class .
166  " failed sync check: " . FormatJson::encode( $relevantPaths ) );
167  // Try to resync the clone backends to the master on the spot...
168  if ( $this->autoResync === false
169  || !$this->resyncFiles( $relevantPaths, $this->autoResync )->isOK()
170  ) {
171  $status->merge( $syncStatus );
172 
173  return $status; // abort
174  }
175  }
176  // Actually attempt the operation batch on the master backend...
177  $realOps = $this->substOpBatchPaths( $ops, $mbe );
178  $masterStatus = $mbe->doOperations( $realOps, $opts );
179  $status->merge( $masterStatus );
180  // Propagate the operations to the clone backends if there were no unexpected errors
181  // and if there were either no expected errors or if the 'force' option was used.
182  // However, if nothing succeeded at all, then don't replicate any of the operations.
183  // If $ops only had one operation, this might avoid backend sync inconsistencies.
184  if ( $masterStatus->isOK() && $masterStatus->successCount > 0 ) {
185  foreach ( $this->backends as $index => $backend ) {
186  if ( $index === $this->masterIndex ) {
187  continue; // done already
188  }
189 
190  $realOps = $this->substOpBatchPaths( $ops, $backend );
191  if ( $this->asyncWrites && !$this->hasVolatileSources( $ops ) ) {
192  // Bind $scopeLock to the callback to preserve locks
194  function () use ( $backend, $realOps, $opts, $scopeLock, $relevantPaths ) {
195  wfDebugLog( 'FileOperationReplication',
196  "'{$backend->getName()}' async replication; paths: " .
197  FormatJson::encode( $relevantPaths ) );
198  $backend->doOperations( $realOps, $opts );
199  }
200  );
201  } else {
202  wfDebugLog( 'FileOperationReplication',
203  "'{$backend->getName()}' sync replication; paths: " .
204  FormatJson::encode( $relevantPaths ) );
205  $status->merge( $backend->doOperations( $realOps, $opts ) );
206  }
207  }
208  }
209  // Make 'success', 'successCount', and 'failCount' fields reflect
210  // the overall operation, rather than all the batches for each backend.
211  // Do this by only using success values from the master backend's batch.
212  $status->success = $masterStatus->success;
213  $status->successCount = $masterStatus->successCount;
214  $status->failCount = $masterStatus->failCount;
215 
216  return $status;
217  }
218 
225  public function consistencyCheck( array $paths ) {
226  $status = $this->newStatus();
227  if ( $this->syncChecks == 0 || count( $this->backends ) <= 1 ) {
228  return $status; // skip checks
229  }
230 
231  // Preload all of the stat info in as few round trips as possible...
232  foreach ( $this->backends as $backend ) {
233  $realPaths = $this->substPaths( $paths, $backend );
234  $backend->preloadFileStat( [ 'srcs' => $realPaths, 'latest' => true ] );
235  }
236 
237  $mBackend = $this->backends[$this->masterIndex];
238  foreach ( $paths as $path ) {
239  $params = [ 'src' => $path, 'latest' => true ];
240  $mParams = $this->substOpPaths( $params, $mBackend );
241  // Stat the file on the 'master' backend
242  $mStat = $mBackend->getFileStat( $mParams );
243  if ( $this->syncChecks & self::CHECK_SHA1 ) {
244  $mSha1 = $mBackend->getFileSha1Base36( $mParams );
245  } else {
246  $mSha1 = false;
247  }
248  // Check if all clone backends agree with the master...
249  foreach ( $this->backends as $index => $cBackend ) {
250  if ( $index === $this->masterIndex ) {
251  continue; // master
252  }
253  $cParams = $this->substOpPaths( $params, $cBackend );
254  $cStat = $cBackend->getFileStat( $cParams );
255  if ( $mStat ) { // file is in master
256  if ( !$cStat ) { // file should exist
257  $status->fatal( 'backend-fail-synced', $path );
258  continue;
259  }
260  if ( ( $this->syncChecks & self::CHECK_SIZE )
261  && $cStat['size'] != $mStat['size']
262  ) { // wrong size
263  $status->fatal( 'backend-fail-synced', $path );
264  continue;
265  }
266  if ( $this->syncChecks & self::CHECK_TIME ) {
267  $mTs = wfTimestamp( TS_UNIX, $mStat['mtime'] );
268  $cTs = wfTimestamp( TS_UNIX, $cStat['mtime'] );
269  if ( abs( $mTs - $cTs ) > 30 ) { // outdated file somewhere
270  $status->fatal( 'backend-fail-synced', $path );
271  continue;
272  }
273  }
274  if ( ( $this->syncChecks & self::CHECK_SHA1 ) && $cBackend->getFileSha1Base36( $cParams ) !== $mSha1 ) { // wrong SHA1
275  $status->fatal( 'backend-fail-synced', $path );
276  continue;
277  }
278  } elseif ( $cStat ) { // file is not in master; file should not exist
279  $status->fatal( 'backend-fail-synced', $path );
280  }
281  }
282  }
283 
284  return $status;
285  }
286 
293  public function accessibilityCheck( array $paths ) {
294  $status = $this->newStatus();
295  if ( count( $this->backends ) <= 1 ) {
296  return $status; // skip checks
297  }
298 
299  foreach ( $paths as $path ) {
300  foreach ( $this->backends as $backend ) {
301  $realPath = $this->substPaths( $path, $backend );
302  if ( !$backend->isPathUsableInternal( $realPath ) ) {
303  $status->fatal( 'backend-fail-usable', $path );
304  }
305  }
306  }
307 
308  return $status;
309  }
310 
319  public function resyncFiles( array $paths, $resyncMode = true ) {
320  $status = $this->newStatus();
321 
322  $mBackend = $this->backends[$this->masterIndex];
323  foreach ( $paths as $path ) {
324  $mPath = $this->substPaths( $path, $mBackend );
325  $mSha1 = $mBackend->getFileSha1Base36( [ 'src' => $mPath, 'latest' => true ] );
326  $mStat = $mBackend->getFileStat( [ 'src' => $mPath, 'latest' => true ] );
327  if ( $mStat === null || ( $mSha1 !== false && !$mStat ) ) { // sanity
328  $status->fatal( 'backend-fail-internal', $this->name );
329  wfDebugLog( 'FileOperation', __METHOD__
330  . ': File is not available on the master backend' );
331  continue; // file is not available on the master backend...
332  }
333  // Check of all clone backends agree with the master...
334  foreach ( $this->backends as $index => $cBackend ) {
335  if ( $index === $this->masterIndex ) {
336  continue; // master
337  }
338  $cPath = $this->substPaths( $path, $cBackend );
339  $cSha1 = $cBackend->getFileSha1Base36( [ 'src' => $cPath, 'latest' => true ] );
340  $cStat = $cBackend->getFileStat( [ 'src' => $cPath, 'latest' => true ] );
341  if ( $cStat === null || ( $cSha1 !== false && !$cStat ) ) { // sanity
342  $status->fatal( 'backend-fail-internal', $cBackend->getName() );
343  wfDebugLog( 'FileOperation', __METHOD__ .
344  ': File is not available on the clone backend' );
345  continue; // file is not available on the clone backend...
346  }
347  if ( $mSha1 === $cSha1 ) {
348  // already synced; nothing to do
349  } elseif ( $mSha1 !== false ) { // file is in master
350  if ( $resyncMode === 'conservative'
351  && $cStat && $cStat['mtime'] > $mStat['mtime']
352  ) {
353  $status->fatal( 'backend-fail-synced', $path );
354  continue; // don't rollback data
355  }
356  $fsFile = $mBackend->getLocalReference(
357  [ 'src' => $mPath, 'latest' => true ] );
358  $status->merge( $cBackend->quickStore(
359  [ 'src' => $fsFile->getPath(), 'dst' => $cPath ]
360  ) );
361  } elseif ( $mStat === false ) { // file is not in master
362  if ( $resyncMode === 'conservative' ) {
363  $status->fatal( 'backend-fail-synced', $path );
364  continue; // don't delete data
365  }
366  $status->merge( $cBackend->quickDelete( [ 'src' => $cPath ] ) );
367  }
368  }
369  }
370 
371  if ( !$status->isOK() ) {
372  wfDebugLog( 'FileOperation', static::class .
373  " failed to resync: " . FormatJson::encode( $paths ) );
374  }
375 
376  return $status;
377  }
378 
385  protected function fileStoragePathsForOps( array $ops ) {
386  $paths = [];
387  foreach ( $ops as $op ) {
388  if ( isset( $op['src'] ) ) {
389  // For things like copy/move/delete with "ignoreMissingSource" and there
390  // is no source file, nothing should happen and there should be no errors.
391  if ( empty( $op['ignoreMissingSource'] )
392  || $this->fileExists( [ 'src' => $op['src'] ] )
393  ) {
394  $paths[] = $op['src'];
395  }
396  }
397  if ( isset( $op['srcs'] ) ) {
398  $paths = array_merge( $paths, $op['srcs'] );
399  }
400  if ( isset( $op['dst'] ) ) {
401  $paths[] = $op['dst'];
402  }
403  }
404 
405  return array_values( array_unique( array_filter( $paths, 'FileBackend::isStoragePath' ) ) );
406  }
407 
416  protected function substOpBatchPaths( array $ops, FileBackendStore $backend ) {
417  $newOps = []; // operations
418  foreach ( $ops as $op ) {
419  $newOp = $op; // operation
420  foreach ( [ 'src', 'srcs', 'dst', 'dir' ] as $par ) {
421  if ( isset( $newOp[$par] ) ) { // string or array
422  $newOp[$par] = $this->substPaths( $newOp[$par], $backend );
423  }
424  }
425  $newOps[] = $newOp;
426  }
427 
428  return $newOps;
429  }
430 
438  protected function substOpPaths( array $ops, FileBackendStore $backend ) {
439  $newOps = $this->substOpBatchPaths( [ $ops ], $backend );
440 
441  return $newOps[0];
442  }
443 
451  protected function substPaths( $paths, FileBackendStore $backend ) {
452  return preg_replace(
453  '!^mwstore://' . preg_quote( $this->name, '!' ) . '/!',
454  StringUtils::escapeRegexReplacement( "mwstore://{$backend->getName()}/" ),
455  $paths // string or array
456  );
457  }
458 
465  protected function unsubstPaths( $paths ) {
466  return preg_replace(
467  '!^mwstore://([^/]+)!',
468  StringUtils::escapeRegexReplacement( "mwstore://{$this->name}" ),
469  $paths // string or array
470  );
471  }
472 
477  protected function hasVolatileSources( array $ops ) {
478  foreach ( $ops as $op ) {
479  if ( $op['op'] === 'store' && !isset( $op['srcRef'] ) ) {
480  return true; // source file might be deleted anytime after do*Operations()
481  }
482  }
483 
484  return false;
485  }
486 
487  protected function doQuickOperationsInternal( array $ops ) {
488  $status = $this->newStatus();
489  // Do the operations on the master backend; setting StatusValue fields...
490  $realOps = $this->substOpBatchPaths( $ops, $this->backends[$this->masterIndex] );
491  $masterStatus = $this->backends[$this->masterIndex]->doQuickOperations( $realOps );
492  $status->merge( $masterStatus );
493  // Propagate the operations to the clone backends...
494  foreach ( $this->backends as $index => $backend ) {
495  if ( $index === $this->masterIndex ) {
496  continue; // done already
497  }
498 
499  $realOps = $this->substOpBatchPaths( $ops, $backend );
500  if ( $this->asyncWrites && !$this->hasVolatileSources( $ops ) ) {
502  function () use ( $backend, $realOps ) {
503  $backend->doQuickOperations( $realOps );
504  }
505  );
506  } else {
507  $status->merge( $backend->doQuickOperations( $realOps ) );
508  }
509  }
510  // Make 'success', 'successCount', and 'failCount' fields reflect
511  // the overall operation, rather than all the batches for each backend.
512  // Do this by only using success values from the master backend's batch.
513  $status->success = $masterStatus->success;
514  $status->successCount = $masterStatus->successCount;
515  $status->failCount = $masterStatus->failCount;
516 
517  return $status;
518  }
519 
520  protected function doPrepare( array $params ) {
521  return $this->doDirectoryOp( 'prepare', $params );
522  }
523 
524  protected function doSecure( array $params ) {
525  return $this->doDirectoryOp( 'secure', $params );
526  }
527 
528  protected function doPublish( array $params ) {
529  return $this->doDirectoryOp( 'publish', $params );
530  }
531 
532  protected function doClean( array $params ) {
533  return $this->doDirectoryOp( 'clean', $params );
534  }
535 
541  protected function doDirectoryOp( $method, array $params ) {
542  $status = $this->newStatus();
543 
544  $realParams = $this->substOpPaths( $params, $this->backends[$this->masterIndex] );
545  $masterStatus = $this->backends[$this->masterIndex]->$method( $realParams );
546  $status->merge( $masterStatus );
547 
548  foreach ( $this->backends as $index => $backend ) {
549  if ( $index === $this->masterIndex ) {
550  continue; // already done
551  }
552 
553  $realParams = $this->substOpPaths( $params, $backend );
554  if ( $this->asyncWrites ) {
556  function () use ( $backend, $method, $realParams ) {
557  $backend->$method( $realParams );
558  }
559  );
560  } else {
561  $status->merge( $backend->$method( $realParams ) );
562  }
563  }
564 
565  return $status;
566  }
567 
568  public function concatenate( array $params ) {
569  $status = $this->newStatus();
570  // We are writing to an FS file, so we don't need to do this per-backend
571  $index = $this->getReadIndexFromParams( $params );
572  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
573 
574  $status->merge( $this->backends[$index]->concatenate( $realParams ) );
575 
576  return $status;
577  }
578 
579  public function fileExists( array $params ) {
580  $index = $this->getReadIndexFromParams( $params );
581  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
582 
583  return $this->backends[$index]->fileExists( $realParams );
584  }
585 
586  public function getFileTimestamp( array $params ) {
587  $index = $this->getReadIndexFromParams( $params );
588  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
589 
590  return $this->backends[$index]->getFileTimestamp( $realParams );
591  }
592 
593  public function getFileSize( array $params ) {
594  $index = $this->getReadIndexFromParams( $params );
595  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
596 
597  return $this->backends[$index]->getFileSize( $realParams );
598  }
599 
600  public function getFileStat( array $params ) {
601  $index = $this->getReadIndexFromParams( $params );
602  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
603 
604  return $this->backends[$index]->getFileStat( $realParams );
605  }
606 
607  public function getFileXAttributes( array $params ) {
608  $index = $this->getReadIndexFromParams( $params );
609  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
610 
611  return $this->backends[$index]->getFileXAttributes( $realParams );
612  }
613 
614  public function getFileContentsMulti( array $params ) {
615  $index = $this->getReadIndexFromParams( $params );
616  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
617 
618  $contentsM = $this->backends[$index]->getFileContentsMulti( $realParams );
619 
620  $contents = []; // (path => FSFile) mapping using the proxy backend's name
621  foreach ( $contentsM as $path => $data ) {
622  $contents[$this->unsubstPaths( $path )] = $data;
623  }
624 
625  return $contents;
626  }
627 
628  public function getFileSha1Base36( array $params ) {
629  $index = $this->getReadIndexFromParams( $params );
630  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
631 
632  return $this->backends[$index]->getFileSha1Base36( $realParams );
633  }
634 
635  public function getFileProps( array $params ) {
636  $index = $this->getReadIndexFromParams( $params );
637  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
638 
639  return $this->backends[$index]->getFileProps( $realParams );
640  }
641 
642  public function streamFile( array $params ) {
643  $index = $this->getReadIndexFromParams( $params );
644  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
645 
646  return $this->backends[$index]->streamFile( $realParams );
647  }
648 
649  public function getLocalReferenceMulti( array $params ) {
650  $index = $this->getReadIndexFromParams( $params );
651  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
652 
653  $fsFilesM = $this->backends[$index]->getLocalReferenceMulti( $realParams );
654 
655  $fsFiles = []; // (path => FSFile) mapping using the proxy backend's name
656  foreach ( $fsFilesM as $path => $fsFile ) {
657  $fsFiles[$this->unsubstPaths( $path )] = $fsFile;
658  }
659 
660  return $fsFiles;
661  }
662 
663  public function getLocalCopyMulti( array $params ) {
664  $index = $this->getReadIndexFromParams( $params );
665  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
666 
667  $tempFilesM = $this->backends[$index]->getLocalCopyMulti( $realParams );
668 
669  $tempFiles = []; // (path => TempFSFile) mapping using the proxy backend's name
670  foreach ( $tempFilesM as $path => $tempFile ) {
671  $tempFiles[$this->unsubstPaths( $path )] = $tempFile;
672  }
673 
674  return $tempFiles;
675  }
676 
677  public function getFileHttpUrl( array $params ) {
678  $index = $this->getReadIndexFromParams( $params );
679  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
680 
681  return $this->backends[$index]->getFileHttpUrl( $realParams );
682  }
683 
684  public function directoryExists( array $params ) {
685  $realParams = $this->substOpPaths( $params, $this->backends[$this->masterIndex] );
686 
687  return $this->backends[$this->masterIndex]->directoryExists( $realParams );
688  }
689 
690  public function getDirectoryList( array $params ) {
691  $realParams = $this->substOpPaths( $params, $this->backends[$this->masterIndex] );
692 
693  return $this->backends[$this->masterIndex]->getDirectoryList( $realParams );
694  }
695 
696  public function getFileList( array $params ) {
697  $realParams = $this->substOpPaths( $params, $this->backends[$this->masterIndex] );
698 
699  return $this->backends[$this->masterIndex]->getFileList( $realParams );
700  }
701 
702  public function getFeatures() {
703  return $this->backends[$this->masterIndex]->getFeatures();
704  }
705 
706  public function clearCache( array $paths = null ) {
707  foreach ( $this->backends as $backend ) {
708  $realPaths = is_array( $paths ) ? $this->substPaths( $paths, $backend ) : null;
709  $backend->clearCache( $realPaths );
710  }
711  }
712 
713  public function preloadCache( array $paths ) {
714  $realPaths = $this->substPaths( $paths, $this->backends[$this->readIndex] );
715  $this->backends[$this->readIndex]->preloadCache( $realPaths );
716  }
717 
718  public function preloadFileStat( array $params ) {
719  $index = $this->getReadIndexFromParams( $params );
720  $realParams = $this->substOpPaths( $params, $this->backends[$index] );
721 
722  return $this->backends[$index]->preloadFileStat( $realParams );
723  }
724 
725  public function getScopedLocksForOps( array $ops, StatusValue $status ) {
726  $realOps = $this->substOpBatchPaths( $ops, $this->backends[$this->masterIndex] );
727  $fileOps = $this->backends[$this->masterIndex]->getOperationsInternal( $realOps );
728  // Get the paths to lock from the master backend
729  $paths = $this->backends[$this->masterIndex]->getPathsToLockForOpsInternal( $fileOps );
730  // Get the paths under the proxy backend's name
731  $pbPaths = [
734  ];
735 
736  // Actually acquire the locks
737  return $this->getScopedFileLocks( $pbPaths, 'mixed', $status );
738  }
739 
744  protected function getReadIndexFromParams( array $params ) {
745  return !empty( $params['latest'] ) ? $this->masterIndex : $this->readIndex;
746  }
747 }
FileJournal $fileJournal
FileBackendStore [] $backends
Prioritized list of FileBackendStore objects.
substPaths( $paths, FileBackendStore $backend)
Substitute the backend of storage paths with an internal backend&#39;s name.
substOpPaths(array $ops, FileBackendStore $backend)
Same as substOpBatchPaths() but for a single operation.
substOpBatchPaths(array $ops, FileBackendStore $backend)
Substitute the backend name in storage path parameters for a set of operations with that of a given i...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
string $domainId
Unique domain name.
Definition: FileBackend.php:97
static escapeRegexReplacement( $string)
Escape a string to make it suitable for inclusion in a preg_replace() replacement parameter...
doDirectoryOp( $method, array $params)
accessibilityCheck(array $paths)
Check that a set of file paths are usable across all internal backends.
clearCache(array $paths=null)
getScopedFileLocks(array $paths, $type, StatusValue $status, $timeout=0)
Lock the files at the given storage paths in the backend.
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
fileStoragePathsForOps(array $ops)
Get a list of file storage paths to read or write for a list of operations.
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
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 noclasses just before the function returns a value If you return true
Definition: hooks.txt:1982
consistencyCheck(array $paths)
Check that a set of files are consistent across all internal backends.
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
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
const LOCK_UW
Definition: LockManager.php:68
const LOCK_EX
Definition: LockManager.php:69
int $readIndex
Index of read affinity backend.
getLocalReferenceMulti(array $params)
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
newStatus(... $args)
Yields the result of the status wrapper callback on either:
doOperationsInternal(array $ops, array $opts)
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
getReadIndexFromParams(array $params)
string $name
Unique backend name.
Definition: FileBackend.php:94
Base class for all backends using particular storage medium.
resyncFiles(array $paths, $resyncMode=true)
Check that a set of files are consistent across all internal backends and re-synchronize those files ...
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
unsubstPaths( $paths)
Substitute the backend of internal storage paths with the proxy backend&#39;s name.
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
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
Proxy backend that mirrors writes to several internal backends.
Base class for all file backend classes (including multi-write backends).
Definition: FileBackend.php:92
__construct(array $config)
Construct a proxy backend that consists of several internal backends.
int $masterIndex
Index of master backend.
getScopedLocksForOps(array $ops, StatusValue $status)