MediaWiki  master
FileBackend.php
Go to the documentation of this file.
1 <?php
35 
94 abstract class FileBackend implements LoggerAwareInterface {
96  protected $name;
97 
99  protected $domainId;
100 
102  protected $readOnly;
103 
105  protected $parallelize;
106 
108  protected $concurrency;
109 
111  protected $tmpFileFactory;
112 
114  protected $lockManager;
116  protected $fileJournal;
118  protected $logger;
120  protected $profiler;
121 
123  protected $obResetFunc;
125  protected $streamMimeFunc;
127  protected $statusWrapper;
128 
130  const ATTR_HEADERS = 1; // files can be tagged with standard HTTP headers
131  const ATTR_METADATA = 2; // files can be stored with metadata key/values
132  const ATTR_UNICODE_PATHS = 4; // files can have Unicode paths (not just ASCII)
133 
167  public function __construct( array $config ) {
168  $this->name = $config['name'];
169  $this->domainId = $config['domainId'] // e.g. "my_wiki-en_"
170  ?? $config['wikiId']; // b/c alias
171  if ( !preg_match( '!^[a-zA-Z0-9-_]{1,255}$!', $this->name ) ) {
172  throw new InvalidArgumentException( "Backend name '{$this->name}' is invalid." );
173  } elseif ( !is_string( $this->domainId ) ) {
174  throw new InvalidArgumentException(
175  "Backend domain ID not provided for '{$this->name}'." );
176  }
177  $this->lockManager = $config['lockManager'] ?? new NullLockManager( [] );
178  $this->fileJournal = $config['fileJournal']
179  ?? FileJournal::factory( [ 'class' => NullFileJournal::class ], $this->name );
180  $this->readOnly = isset( $config['readOnly'] )
181  ? (string)$config['readOnly']
182  : '';
183  $this->parallelize = isset( $config['parallelize'] )
184  ? (string)$config['parallelize']
185  : 'off';
186  $this->concurrency = isset( $config['concurrency'] )
187  ? (int)$config['concurrency']
188  : 50;
189  $this->obResetFunc = $config['obResetFunc'] ?? [ $this, 'resetOutputBuffer' ];
190  $this->streamMimeFunc = $config['streamMimeFunc'] ?? null;
191  $this->statusWrapper = $config['statusWrapper'] ?? null;
192 
193  $this->profiler = $config['profiler'] ?? null;
194  if ( !is_callable( $this->profiler ) ) {
195  $this->profiler = null;
196  }
197  $this->logger = $config['logger'] ?? new NullLogger();
198  $this->statusWrapper = $config['statusWrapper'] ?? null;
199  // tmpDirectory gets precedence for backward compatibility
200  if ( isset( $config['tmpDirectory'] ) ) {
201  $this->tmpFileFactory = new TempFSFileFactory( $config['tmpDirectory'] );
202  } else {
203  $this->tmpFileFactory = $config['tmpFileFactory'] ?? new TempFSFileFactory();
204  }
205  }
206 
207  public function setLogger( LoggerInterface $logger ) {
208  $this->logger = $logger;
209  }
210 
218  final public function getName() {
219  return $this->name;
220  }
221 
228  final public function getDomainId() {
229  return $this->domainId;
230  }
231 
238  final public function getWikiId() {
239  return $this->getDomainId();
240  }
241 
247  final public function isReadOnly() {
248  return ( $this->readOnly != '' );
249  }
250 
256  final public function getReadOnlyReason() {
257  return ( $this->readOnly != '' ) ? $this->readOnly : false;
258  }
259 
266  public function getFeatures() {
267  return self::ATTR_UNICODE_PATHS;
268  }
269 
277  final public function hasFeatures( $bitfield ) {
278  return ( $this->getFeatures() & $bitfield ) === $bitfield;
279  }
280 
429  final public function doOperations( array $ops, array $opts = [] ) {
430  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
431  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
432  }
433  if ( $ops === [] ) {
434  return $this->newStatus(); // nothing to do
435  }
436 
437  $ops = $this->resolveFSFileObjects( $ops );
438  if ( empty( $opts['force'] ) ) { // sanity
439  unset( $opts['nonLocking'] );
440  }
441 
443  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
444 
445  return $this->doOperationsInternal( $ops, $opts );
446  }
447 
454  abstract protected function doOperationsInternal( array $ops, array $opts );
455 
467  final public function doOperation( array $op, array $opts = [] ) {
468  return $this->doOperations( [ $op ], $opts );
469  }
470 
481  final public function create( array $params, array $opts = [] ) {
482  return $this->doOperation( [ 'op' => 'create' ] + $params, $opts );
483  }
484 
495  final public function store( array $params, array $opts = [] ) {
496  return $this->doOperation( [ 'op' => 'store' ] + $params, $opts );
497  }
498 
509  final public function copy( array $params, array $opts = [] ) {
510  return $this->doOperation( [ 'op' => 'copy' ] + $params, $opts );
511  }
512 
523  final public function move( array $params, array $opts = [] ) {
524  return $this->doOperation( [ 'op' => 'move' ] + $params, $opts );
525  }
526 
537  final public function delete( array $params, array $opts = [] ) {
538  return $this->doOperation( [ 'op' => 'delete' ] + $params, $opts );
539  }
540 
552  final public function describe( array $params, array $opts = [] ) {
553  return $this->doOperation( [ 'op' => 'describe' ] + $params, $opts );
554  }
555 
668  final public function doQuickOperations( array $ops, array $opts = [] ) {
669  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
670  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
671  }
672  if ( $ops === [] ) {
673  return $this->newStatus(); // nothing to do
674  }
675 
676  $ops = $this->resolveFSFileObjects( $ops );
677  foreach ( $ops as &$op ) {
678  $op['overwrite'] = true; // avoids RTTs in key/value stores
679  }
680 
682  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
683 
684  return $this->doQuickOperationsInternal( $ops );
685  }
686 
693  abstract protected function doQuickOperationsInternal( array $ops );
694 
705  final public function doQuickOperation( array $op ) {
706  return $this->doQuickOperations( [ $op ] );
707  }
708 
719  final public function quickCreate( array $params ) {
720  return $this->doQuickOperation( [ 'op' => 'create' ] + $params );
721  }
722 
733  final public function quickStore( array $params ) {
734  return $this->doQuickOperation( [ 'op' => 'store' ] + $params );
735  }
736 
747  final public function quickCopy( array $params ) {
748  return $this->doQuickOperation( [ 'op' => 'copy' ] + $params );
749  }
750 
761  final public function quickMove( array $params ) {
762  return $this->doQuickOperation( [ 'op' => 'move' ] + $params );
763  }
764 
775  final public function quickDelete( array $params ) {
776  return $this->doQuickOperation( [ 'op' => 'delete' ] + $params );
777  }
778 
789  final public function quickDescribe( array $params ) {
790  return $this->doQuickOperation( [ 'op' => 'describe' ] + $params );
791  }
792 
805  abstract public function concatenate( array $params );
806 
825  final public function prepare( array $params ) {
826  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
827  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
828  }
830  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
831  return $this->doPrepare( $params );
832  }
833 
839  abstract protected function doPrepare( array $params );
840 
857  final public function secure( array $params ) {
858  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
859  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
860  }
862  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
863  return $this->doSecure( $params );
864  }
865 
871  abstract protected function doSecure( array $params );
872 
891  final public function publish( array $params ) {
892  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
893  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
894  }
896  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
897  return $this->doPublish( $params );
898  }
899 
905  abstract protected function doPublish( array $params );
906 
918  final public function clean( array $params ) {
919  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
920  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
921  }
923  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
924  return $this->doClean( $params );
925  }
926 
932  abstract protected function doClean( array $params );
933 
943  abstract public function fileExists( array $params );
944 
953  abstract public function getFileTimestamp( array $params );
954 
964  final public function getFileContents( array $params ) {
965  $contents = $this->getFileContentsMulti(
966  [ 'srcs' => [ $params['src'] ] ] + $params );
967 
968  return $contents[$params['src']];
969  }
970 
985  abstract public function getFileContentsMulti( array $params );
986 
1005  abstract public function getFileXAttributes( array $params );
1006 
1015  abstract public function getFileSize( array $params );
1016 
1030  abstract public function getFileStat( array $params );
1031 
1040  abstract public function getFileSha1Base36( array $params );
1041 
1051  abstract public function getFileProps( array $params );
1052 
1072  abstract public function streamFile( array $params );
1073 
1092  final public function getLocalReference( array $params ) {
1093  $fsFiles = $this->getLocalReferenceMulti(
1094  [ 'srcs' => [ $params['src'] ] ] + $params );
1095 
1096  return $fsFiles[$params['src']];
1097  }
1098 
1113  abstract public function getLocalReferenceMulti( array $params );
1114 
1125  final public function getLocalCopy( array $params ) {
1126  $tmpFiles = $this->getLocalCopyMulti(
1127  [ 'srcs' => [ $params['src'] ] ] + $params );
1128 
1129  return $tmpFiles[$params['src']];
1130  }
1131 
1146  abstract public function getLocalCopyMulti( array $params );
1147 
1164  abstract public function getFileHttpUrl( array $params );
1165 
1178  abstract public function directoryExists( array $params );
1179 
1198  abstract public function getDirectoryList( array $params );
1199 
1213  final public function getTopDirectoryList( array $params ) {
1214  return $this->getDirectoryList( [ 'topOnly' => true ] + $params );
1215  }
1216 
1235  abstract public function getFileList( array $params );
1236 
1251  final public function getTopFileList( array $params ) {
1252  return $this->getFileList( [ 'topOnly' => true ] + $params );
1253  }
1254 
1263  abstract public function preloadCache( array $paths );
1264 
1273  abstract public function clearCache( array $paths = null );
1274 
1289  abstract public function preloadFileStat( array $params );
1290 
1302  final public function lockFiles( array $paths, $type, $timeout = 0 ) {
1303  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1304 
1305  return $this->wrapStatus( $this->lockManager->lock( $paths, $type, $timeout ) );
1306  }
1307 
1315  final public function unlockFiles( array $paths, $type ) {
1316  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1317 
1318  return $this->wrapStatus( $this->lockManager->unlock( $paths, $type ) );
1319  }
1320 
1337  final public function getScopedFileLocks(
1338  array $paths, $type, StatusValue $status, $timeout = 0
1339  ) {
1340  if ( $type === 'mixed' ) {
1341  foreach ( $paths as &$typePaths ) {
1342  $typePaths = array_map( 'FileBackend::normalizeStoragePath', $typePaths );
1343  }
1344  } else {
1345  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1346  }
1347 
1348  return ScopedLock::factory( $this->lockManager, $paths, $type, $status, $timeout );
1349  }
1350 
1367  abstract public function getScopedLocksForOps( array $ops, StatusValue $status );
1368 
1376  final public function getRootStoragePath() {
1377  return "mwstore://{$this->name}";
1378  }
1379 
1387  final public function getContainerStoragePath( $container ) {
1388  return $this->getRootStoragePath() . "/{$container}";
1389  }
1390 
1396  final public function getJournal() {
1397  return $this->fileJournal;
1398  }
1399 
1409  protected function resolveFSFileObjects( array $ops ) {
1410  foreach ( $ops as &$op ) {
1411  $src = $op['src'] ?? null;
1412  if ( $src instanceof FSFile ) {
1413  $op['srcRef'] = $src;
1414  $op['src'] = $src->getPath();
1415  }
1416  }
1417  unset( $op );
1418 
1419  return $ops;
1420  }
1421 
1429  final public static function isStoragePath( $path ) {
1430  return ( strpos( $path, 'mwstore://' ) === 0 );
1431  }
1432 
1441  final public static function splitStoragePath( $storagePath ) {
1442  if ( self::isStoragePath( $storagePath ) ) {
1443  // Remove the "mwstore://" prefix and split the path
1444  $parts = explode( '/', substr( $storagePath, 10 ), 3 );
1445  if ( count( $parts ) >= 2 && $parts[0] != '' && $parts[1] != '' ) {
1446  if ( count( $parts ) == 3 ) {
1447  return $parts; // e.g. "backend/container/path"
1448  } else {
1449  return [ $parts[0], $parts[1], '' ]; // e.g. "backend/container"
1450  }
1451  }
1452  }
1453 
1454  return [ null, null, null ];
1455  }
1456 
1464  final public static function normalizeStoragePath( $storagePath ) {
1465  list( $backend, $container, $relPath ) = self::splitStoragePath( $storagePath );
1466  if ( $relPath !== null ) { // must be for this backend
1467  $relPath = self::normalizeContainerPath( $relPath );
1468  if ( $relPath !== null ) {
1469  return ( $relPath != '' )
1470  ? "mwstore://{$backend}/{$container}/{$relPath}"
1471  : "mwstore://{$backend}/{$container}";
1472  }
1473  }
1474 
1475  return null;
1476  }
1477 
1486  final public static function parentStoragePath( $storagePath ) {
1487  $storagePath = dirname( $storagePath );
1488  list( , , $rel ) = self::splitStoragePath( $storagePath );
1489 
1490  return ( $rel === null ) ? null : $storagePath;
1491  }
1492 
1500  final public static function extensionFromPath( $path, $case = 'lowercase' ) {
1501  $i = strrpos( $path, '.' );
1502  $ext = $i ? substr( $path, $i + 1 ) : '';
1503 
1504  if ( $case === 'lowercase' ) {
1505  $ext = strtolower( $ext );
1506  } elseif ( $case === 'uppercase' ) {
1507  $ext = strtoupper( $ext );
1508  }
1509 
1510  return $ext;
1511  }
1512 
1520  final public static function isPathTraversalFree( $path ) {
1521  return ( self::normalizeContainerPath( $path ) !== null );
1522  }
1523 
1533  final public static function makeContentDisposition( $type, $filename = '' ) {
1534  $parts = [];
1535 
1536  $type = strtolower( $type );
1537  if ( !in_array( $type, [ 'inline', 'attachment' ] ) ) {
1538  throw new InvalidArgumentException( "Invalid Content-Disposition type '$type'." );
1539  }
1540  $parts[] = $type;
1541 
1542  if ( strlen( $filename ) ) {
1543  $parts[] = "filename*=UTF-8''" . rawurlencode( basename( $filename ) );
1544  }
1545 
1546  return implode( ';', $parts );
1547  }
1548 
1559  final protected static function normalizeContainerPath( $path ) {
1560  // Normalize directory separators
1561  $path = strtr( $path, '\\', '/' );
1562  // Collapse any consecutive directory separators
1563  $path = preg_replace( '![/]{2,}!', '/', $path );
1564  // Remove any leading directory separator
1565  $path = ltrim( $path, '/' );
1566  // Use the same traversal protection as Title::secureAndSplit()
1567  if ( strpos( $path, '.' ) !== false ) {
1568  if (
1569  $path === '.' ||
1570  $path === '..' ||
1571  strpos( $path, './' ) === 0 ||
1572  strpos( $path, '../' ) === 0 ||
1573  strpos( $path, '/./' ) !== false ||
1574  strpos( $path, '/../' ) !== false
1575  ) {
1576  return null;
1577  }
1578  }
1579 
1580  return $path;
1581  }
1582 
1591  final protected function newStatus( ...$args ) {
1592  if ( count( $args ) ) {
1593  $sv = StatusValue::newFatal( ...$args );
1594  } else {
1595  $sv = StatusValue::newGood();
1596  }
1597 
1598  return $this->wrapStatus( $sv );
1599  }
1600 
1605  final protected function wrapStatus( StatusValue $sv ) {
1606  return $this->statusWrapper ? call_user_func( $this->statusWrapper, $sv ) : $sv;
1607  }
1608 
1613  protected function scopedProfileSection( $section ) {
1614  return $this->profiler ? ( $this->profiler )( $section ) : null;
1615  }
1616 
1617  protected function resetOutputBuffer() {
1618  while ( ob_get_status() ) {
1619  if ( !ob_end_clean() ) {
1620  // Could not remove output buffer handler; abort now
1621  // to avoid getting in some kind of infinite loop.
1622  break;
1623  }
1624  }
1625  }
1626 }
doQuickOperationsInternal(array $ops)
static isPathTraversalFree( $path)
Check if a relative path has no directory traversals.
FileJournal $fileJournal
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 list
Definition: deferred.txt:11
describe(array $params, array $opts=[])
Performs a single describe operation.
unlockFiles(array $paths, $type)
Unlock the files at the given storage paths in the backend.
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
doOperations(array $ops, array $opts=[])
This is the main entry point into the backend for write operations.
TempFSFileFactory $tmpFileFactory
doPrepare(array $params)
getFileStat(array $params)
Get quick information about a file at a storage path in the backend.
getWikiId()
Alias to getDomainId()
publish(array $params)
Remove measures to block web access to a storage directory and the container it belongs to...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
secure(array $params)
Take measures to block web access to a storage directory and the container it belongs to...
static parentStoragePath( $storagePath)
Get the parent storage directory of a storage path.
setLogger(LoggerInterface $logger)
string $domainId
Unique domain name.
Definition: FileBackend.php:99
scopedProfileSection( $section)
const ATTR_HEADERS
Bitfield flags for supported features.
quickMove(array $params)
Performs a single quick move operation.
getFileHttpUrl(array $params)
Return an HTTP URL to a given file that requires no authentication to use.
quickDelete(array $params)
Performs a single quick delete operation.
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:181
getFileXAttributes(array $params)
Get metadata about a file at a storage path in the backend.
getName()
Get the unique backend name.
static normalizeContainerPath( $path)
Validate and normalize a relative storage path.
getScopedFileLocks(array $paths, $type, StatusValue $status, $timeout=0)
Lock the files at the given storage paths in the backend.
getFileContentsMulti(array $params)
Like getFileContents() except it takes an array of storage paths and returns a map of storage paths t...
getDirectoryList(array $params)
Get an iterator to list all directories under a storage directory.
getDomainId()
Get the domain identifier used for this backend (possibly empty).
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
static factory(LockManager $manager, array $paths, $type, StatusValue $status, $timeout=0)
Get a ScopedLock object representing a lock on resource paths.
Definition: ScopedLock.php:70
doClean(array $params)
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
static normalizeStoragePath( $storagePath)
Normalize a storage path by cleaning up directory separators.
int $concurrency
How many operations can be done in parallel.
getLocalReferenceMulti(array $params)
Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths...
directoryExists(array $params)
Check if a directory exists at a given storage path.
wrapStatus(StatusValue $sv)
callable $statusWrapper
resolveFSFileObjects(array $ops)
Convert FSFile &#39;src&#39; paths to string paths (with an &#39;srcRef&#39; field set to the FSFile) ...
if( $line===false) $args
Definition: cdb.php:64
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
string $readOnly
Read-only explanation message.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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:1250
create(array $params, array $opts=[])
Performs a single create operation.
move(array $params, array $opts=[])
Performs a single move operation.
quickStore(array $params)
Performs a single quick store operation.
getReadOnlyReason()
Get an explanatory message if this backend is read-only.
quickCreate(array $params)
Performs a single quick create operation.
getTopFileList(array $params)
Same as FileBackend::getFileList() except only lists files that are immediately under the given direc...
lockFiles(array $paths, $type, $timeout=0)
Lock the files at the given storage paths in the backend.
__construct(array $config)
Create a new backend instance from configuration.
hasFeatures( $bitfield)
Check if the backend medium supports a field of extra features.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
quickCopy(array $params)
Performs a single quick copy operation.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
getFileSha1Base36(array $params)
Get a SHA-1 hash of the file at a storage path in the backend.
$params
callable $obResetFunc
store(array $params, array $opts=[])
Performs a single store operation.
const ATTR_UNICODE_PATHS
doSecure(array $params)
const ATTR_METADATA
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:773
callable $streamMimeFunc
newStatus(... $args)
Yields the result of the status wrapper callback on either:
getFileSize(array $params)
Get the size (bytes) of a file at a storage path in the backend.
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
doQuickOperations(array $ops, array $opts=[])
Perform a set of independent file operations on some files.
prepare(array $params)
Prepare a storage directory for usage.
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3045
string $name
Unique backend name.
Definition: FileBackend.php:96
getLocalCopy(array $params)
Get a local copy on disk of the file at a storage path in the backend.
LoggerInterface $logger
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
getJournal()
Get the file journal object for this backend.
concatenate(array $params)
Concatenate a list of storage files into a single file system file.
getRootStoragePath()
Get the root storage path of this backend.
Class representing a non-directory file on the file system.
Definition: FSFile.php:29
preloadCache(array $paths)
Preload persistent file stat cache and property cache into in-process cache.
copy(array $params, array $opts=[])
Performs a single copy operation.
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
doOperationsInternal(array $ops, array $opts)
Base class for all file backend classes (including multi-write backends).
Definition: FileBackend.php:94
getFileList(array $params)
Get an iterator to list all stored files under a storage directory.
if(!is_readable( $file)) $ext
Definition: router.php:48
getScopedLocksForOps(array $ops, StatusValue $status)
Get an array of scoped locks needed for a batch of file operations.
getTopDirectoryList(array $params)
Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the ...
getLocalCopyMulti(array $params)
Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to T...
quickDescribe(array $params)
Performs a single quick describe operation.
string $parallelize
When to do operations in parallel.
streamFile(array $params)
Stream the file at a storage path in the backend.
clean(array $params)
Delete a storage directory if it is empty.
getFileProps(array $params)
Get the properties of the file at a storage path in the backend.
clearCache(array $paths=null)
Invalidate any in-process file stat and property cache.
LockManager $lockManager
doQuickOperation(array $op)
Same as doQuickOperations() except it takes a single operation.
callable null $profiler
isReadOnly()
Check if this backend is read-only.
preloadFileStat(array $params)
Preload file stat information (concurrently if possible) into in-process cache.
getLocalReference(array $params)
Returns a file system file, identical to the file at a storage path.
getFeatures()
Get the a bitfield of extra features supported by the backend medium.
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.
static factory(array $config, $backend)
Create an appropriate FileJournal object from config.
Definition: FileJournal.php:63
getContainerStoragePath( $container)
Get the storage path for the given container for this backend.
doPublish(array $params)
getFileContents(array $params)
Get the contents of a file at a storage path in the backend.