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