MediaWiki  master
FileBackend.php
Go to the documentation of this file.
1 <?php
33 
92 abstract class FileBackend implements LoggerAwareInterface {
94  protected $name;
95 
97  protected $domainId;
98 
100  protected $readOnly;
101 
103  protected $parallelize;
104 
106  protected $concurrency;
107 
109  protected $tmpDirectory;
110 
112  protected $lockManager;
114  protected $fileJournal;
116  protected $logger;
118  protected $profiler;
119 
121  protected $obResetFunc;
123  protected $streamMimeFunc;
125  protected $statusWrapper;
126 
128  const ATTR_HEADERS = 1; // files can be tagged with standard HTTP headers
129  const ATTR_METADATA = 2; // files can be stored with metadata key/values
130  const ATTR_UNICODE_PATHS = 4; // files can have Unicode paths (not just ASCII)
131 
163  public function __construct( array $config ) {
164  $this->name = $config['name'];
165  $this->domainId = $config['domainId'] // e.g. "my_wiki-en_"
166  ?? $config['wikiId']; // b/c alias
167  if ( !preg_match( '!^[a-zA-Z0-9-_]{1,255}$!', $this->name ) ) {
168  throw new InvalidArgumentException( "Backend name '{$this->name}' is invalid." );
169  } elseif ( !is_string( $this->domainId ) ) {
170  throw new InvalidArgumentException(
171  "Backend domain ID not provided for '{$this->name}'." );
172  }
173  $this->lockManager = $config['lockManager'] ?? new NullLockManager( [] );
174  $this->fileJournal = $config['fileJournal']
175  ?? FileJournal::factory( [ 'class' => NullFileJournal::class ], $this->name );
176  $this->readOnly = isset( $config['readOnly'] )
177  ? (string)$config['readOnly']
178  : '';
179  $this->parallelize = isset( $config['parallelize'] )
180  ? (string)$config['parallelize']
181  : 'off';
182  $this->concurrency = isset( $config['concurrency'] )
183  ? (int)$config['concurrency']
184  : 50;
185  $this->obResetFunc = $config['obResetFunc'] ?? [ $this, 'resetOutputBuffer' ];
186  $this->streamMimeFunc = $config['streamMimeFunc'] ?? null;
187  $this->statusWrapper = $config['statusWrapper'] ?? null;
188 
189  $this->profiler = $config['profiler'] ?? null;
190  if ( !is_callable( $this->profiler ) ) {
191  $this->profiler = null;
192  }
193  $this->logger = $config['logger'] ?? new \Psr\Log\NullLogger();
194  $this->statusWrapper = $config['statusWrapper'] ?? null;
195  $this->tmpDirectory = $config['tmpDirectory'] ?? null;
196  }
197 
198  public function setLogger( LoggerInterface $logger ) {
199  $this->logger = $logger;
200  }
201 
209  final public function getName() {
210  return $this->name;
211  }
212 
219  final public function getDomainId() {
220  return $this->domainId;
221  }
222 
228  final public function getWikiId() {
229  return $this->getDomainId();
230  }
231 
237  final public function isReadOnly() {
238  return ( $this->readOnly != '' );
239  }
240 
246  final public function getReadOnlyReason() {
247  return ( $this->readOnly != '' ) ? $this->readOnly : false;
248  }
249 
256  public function getFeatures() {
257  return self::ATTR_UNICODE_PATHS;
258  }
259 
267  final public function hasFeatures( $bitfield ) {
268  return ( $this->getFeatures() & $bitfield ) === $bitfield;
269  }
270 
419  final public function doOperations( array $ops, array $opts = [] ) {
420  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
421  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
422  }
423  if ( $ops === [] ) {
424  return $this->newStatus(); // nothing to do
425  }
426 
427  $ops = $this->resolveFSFileObjects( $ops );
428  if ( empty( $opts['force'] ) ) { // sanity
429  unset( $opts['nonLocking'] );
430  }
431 
433  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
434 
435  return $this->doOperationsInternal( $ops, $opts );
436  }
437 
444  abstract protected function doOperationsInternal( array $ops, array $opts );
445 
457  final public function doOperation( array $op, array $opts = [] ) {
458  return $this->doOperations( [ $op ], $opts );
459  }
460 
471  final public function create( array $params, array $opts = [] ) {
472  return $this->doOperation( [ 'op' => 'create' ] + $params, $opts );
473  }
474 
485  final public function store( array $params, array $opts = [] ) {
486  return $this->doOperation( [ 'op' => 'store' ] + $params, $opts );
487  }
488 
499  final public function copy( array $params, array $opts = [] ) {
500  return $this->doOperation( [ 'op' => 'copy' ] + $params, $opts );
501  }
502 
513  final public function move( array $params, array $opts = [] ) {
514  return $this->doOperation( [ 'op' => 'move' ] + $params, $opts );
515  }
516 
527  final public function delete( array $params, array $opts = [] ) {
528  return $this->doOperation( [ 'op' => 'delete' ] + $params, $opts );
529  }
530 
542  final public function describe( array $params, array $opts = [] ) {
543  return $this->doOperation( [ 'op' => 'describe' ] + $params, $opts );
544  }
545 
658  final public function doQuickOperations( array $ops, array $opts = [] ) {
659  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
660  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
661  }
662  if ( $ops === [] ) {
663  return $this->newStatus(); // nothing to do
664  }
665 
666  $ops = $this->resolveFSFileObjects( $ops );
667  foreach ( $ops as &$op ) {
668  $op['overwrite'] = true; // avoids RTTs in key/value stores
669  }
670 
672  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
673 
674  return $this->doQuickOperationsInternal( $ops );
675  }
676 
683  abstract protected function doQuickOperationsInternal( array $ops );
684 
695  final public function doQuickOperation( array $op ) {
696  return $this->doQuickOperations( [ $op ] );
697  }
698 
709  final public function quickCreate( array $params ) {
710  return $this->doQuickOperation( [ 'op' => 'create' ] + $params );
711  }
712 
723  final public function quickStore( array $params ) {
724  return $this->doQuickOperation( [ 'op' => 'store' ] + $params );
725  }
726 
737  final public function quickCopy( array $params ) {
738  return $this->doQuickOperation( [ 'op' => 'copy' ] + $params );
739  }
740 
751  final public function quickMove( array $params ) {
752  return $this->doQuickOperation( [ 'op' => 'move' ] + $params );
753  }
754 
765  final public function quickDelete( array $params ) {
766  return $this->doQuickOperation( [ 'op' => 'delete' ] + $params );
767  }
768 
779  final public function quickDescribe( array $params ) {
780  return $this->doQuickOperation( [ 'op' => 'describe' ] + $params );
781  }
782 
795  abstract public function concatenate( array $params );
796 
815  final public function prepare( array $params ) {
816  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
817  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
818  }
820  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
821  return $this->doPrepare( $params );
822  }
823 
829  abstract protected function doPrepare( array $params );
830 
847  final public function secure( array $params ) {
848  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
849  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
850  }
852  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
853  return $this->doSecure( $params );
854  }
855 
861  abstract protected function doSecure( array $params );
862 
881  final public function publish( array $params ) {
882  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
883  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
884  }
886  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
887  return $this->doPublish( $params );
888  }
889 
895  abstract protected function doPublish( array $params );
896 
908  final public function clean( array $params ) {
909  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
910  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
911  }
913  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
914  return $this->doClean( $params );
915  }
916 
922  abstract protected function doClean( array $params );
923 
933  abstract public function fileExists( array $params );
934 
943  abstract public function getFileTimestamp( array $params );
944 
954  final public function getFileContents( array $params ) {
955  $contents = $this->getFileContentsMulti(
956  [ 'srcs' => [ $params['src'] ] ] + $params );
957 
958  return $contents[$params['src']];
959  }
960 
975  abstract public function getFileContentsMulti( array $params );
976 
995  abstract public function getFileXAttributes( array $params );
996 
1005  abstract public function getFileSize( array $params );
1006 
1020  abstract public function getFileStat( array $params );
1021 
1030  abstract public function getFileSha1Base36( array $params );
1031 
1041  abstract public function getFileProps( array $params );
1042 
1062  abstract public function streamFile( array $params );
1063 
1082  final public function getLocalReference( array $params ) {
1083  $fsFiles = $this->getLocalReferenceMulti(
1084  [ 'srcs' => [ $params['src'] ] ] + $params );
1085 
1086  return $fsFiles[$params['src']];
1087  }
1088 
1103  abstract public function getLocalReferenceMulti( array $params );
1104 
1115  final public function getLocalCopy( array $params ) {
1116  $tmpFiles = $this->getLocalCopyMulti(
1117  [ 'srcs' => [ $params['src'] ] ] + $params );
1118 
1119  return $tmpFiles[$params['src']];
1120  }
1121 
1136  abstract public function getLocalCopyMulti( array $params );
1137 
1154  abstract public function getFileHttpUrl( array $params );
1155 
1168  abstract public function directoryExists( array $params );
1169 
1188  abstract public function getDirectoryList( array $params );
1189 
1203  final public function getTopDirectoryList( array $params ) {
1204  return $this->getDirectoryList( [ 'topOnly' => true ] + $params );
1205  }
1206 
1225  abstract public function getFileList( array $params );
1226 
1241  final public function getTopFileList( array $params ) {
1242  return $this->getFileList( [ 'topOnly' => true ] + $params );
1243  }
1244 
1253  abstract public function preloadCache( array $paths );
1254 
1263  abstract public function clearCache( array $paths = null );
1264 
1279  abstract public function preloadFileStat( array $params );
1280 
1292  final public function lockFiles( array $paths, $type, $timeout = 0 ) {
1293  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1294 
1295  return $this->wrapStatus( $this->lockManager->lock( $paths, $type, $timeout ) );
1296  }
1297 
1305  final public function unlockFiles( array $paths, $type ) {
1306  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1307 
1308  return $this->wrapStatus( $this->lockManager->unlock( $paths, $type ) );
1309  }
1310 
1327  final public function getScopedFileLocks(
1328  array $paths, $type, StatusValue $status, $timeout = 0
1329  ) {
1330  if ( $type === 'mixed' ) {
1331  foreach ( $paths as &$typePaths ) {
1332  $typePaths = array_map( 'FileBackend::normalizeStoragePath', $typePaths );
1333  }
1334  } else {
1335  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1336  }
1337 
1338  return ScopedLock::factory( $this->lockManager, $paths, $type, $status, $timeout );
1339  }
1340 
1357  abstract public function getScopedLocksForOps( array $ops, StatusValue $status );
1358 
1366  final public function getRootStoragePath() {
1367  return "mwstore://{$this->name}";
1368  }
1369 
1377  final public function getContainerStoragePath( $container ) {
1378  return $this->getRootStoragePath() . "/{$container}";
1379  }
1380 
1386  final public function getJournal() {
1387  return $this->fileJournal;
1388  }
1389 
1399  protected function resolveFSFileObjects( array $ops ) {
1400  foreach ( $ops as &$op ) {
1401  $src = $op['src'] ?? null;
1402  if ( $src instanceof FSFile ) {
1403  $op['srcRef'] = $src;
1404  $op['src'] = $src->getPath();
1405  }
1406  }
1407  unset( $op );
1408 
1409  return $ops;
1410  }
1411 
1419  final public static function isStoragePath( $path ) {
1420  return ( strpos( $path, 'mwstore://' ) === 0 );
1421  }
1422 
1431  final public static function splitStoragePath( $storagePath ) {
1432  if ( self::isStoragePath( $storagePath ) ) {
1433  // Remove the "mwstore://" prefix and split the path
1434  $parts = explode( '/', substr( $storagePath, 10 ), 3 );
1435  if ( count( $parts ) >= 2 && $parts[0] != '' && $parts[1] != '' ) {
1436  if ( count( $parts ) == 3 ) {
1437  return $parts; // e.g. "backend/container/path"
1438  } else {
1439  return [ $parts[0], $parts[1], '' ]; // e.g. "backend/container"
1440  }
1441  }
1442  }
1443 
1444  return [ null, null, null ];
1445  }
1446 
1454  final public static function normalizeStoragePath( $storagePath ) {
1455  list( $backend, $container, $relPath ) = self::splitStoragePath( $storagePath );
1456  if ( $relPath !== null ) { // must be for this backend
1457  $relPath = self::normalizeContainerPath( $relPath );
1458  if ( $relPath !== null ) {
1459  return ( $relPath != '' )
1460  ? "mwstore://{$backend}/{$container}/{$relPath}"
1461  : "mwstore://{$backend}/{$container}";
1462  }
1463  }
1464 
1465  return null;
1466  }
1467 
1476  final public static function parentStoragePath( $storagePath ) {
1477  $storagePath = dirname( $storagePath );
1478  list( , , $rel ) = self::splitStoragePath( $storagePath );
1479 
1480  return ( $rel === null ) ? null : $storagePath;
1481  }
1482 
1490  final public static function extensionFromPath( $path, $case = 'lowercase' ) {
1491  $i = strrpos( $path, '.' );
1492  $ext = $i ? substr( $path, $i + 1 ) : '';
1493 
1494  if ( $case === 'lowercase' ) {
1495  $ext = strtolower( $ext );
1496  } elseif ( $case === 'uppercase' ) {
1497  $ext = strtoupper( $ext );
1498  }
1499 
1500  return $ext;
1501  }
1502 
1510  final public static function isPathTraversalFree( $path ) {
1511  return ( self::normalizeContainerPath( $path ) !== null );
1512  }
1513 
1523  final public static function makeContentDisposition( $type, $filename = '' ) {
1524  $parts = [];
1525 
1526  $type = strtolower( $type );
1527  if ( !in_array( $type, [ 'inline', 'attachment' ] ) ) {
1528  throw new InvalidArgumentException( "Invalid Content-Disposition type '$type'." );
1529  }
1530  $parts[] = $type;
1531 
1532  if ( strlen( $filename ) ) {
1533  $parts[] = "filename*=UTF-8''" . rawurlencode( basename( $filename ) );
1534  }
1535 
1536  return implode( ';', $parts );
1537  }
1538 
1549  final protected static function normalizeContainerPath( $path ) {
1550  // Normalize directory separators
1551  $path = strtr( $path, '\\', '/' );
1552  // Collapse any consecutive directory separators
1553  $path = preg_replace( '![/]{2,}!', '/', $path );
1554  // Remove any leading directory separator
1555  $path = ltrim( $path, '/' );
1556  // Use the same traversal protection as Title::secureAndSplit()
1557  if ( strpos( $path, '.' ) !== false ) {
1558  if (
1559  $path === '.' ||
1560  $path === '..' ||
1561  strpos( $path, './' ) === 0 ||
1562  strpos( $path, '../' ) === 0 ||
1563  strpos( $path, '/./' ) !== false ||
1564  strpos( $path, '/../' ) !== false
1565  ) {
1566  return null;
1567  }
1568  }
1569 
1570  return $path;
1571  }
1572 
1581  final protected function newStatus( ...$args ) {
1582  if ( count( $args ) ) {
1583  $sv = StatusValue::newFatal( ...$args );
1584  } else {
1585  $sv = StatusValue::newGood();
1586  }
1587 
1588  return $this->wrapStatus( $sv );
1589  }
1590 
1595  final protected function wrapStatus( StatusValue $sv ) {
1596  return $this->statusWrapper ? call_user_func( $this->statusWrapper, $sv ) : $sv;
1597  }
1598 
1603  protected function scopedProfileSection( $section ) {
1604  return $this->profiler ? ( $this->profiler )( $section ) : null;
1605  }
1606 
1607  protected function resetOutputBuffer() {
1608  while ( ob_get_status() ) {
1609  if ( !ob_end_clean() ) {
1610  // Could not remove output buffer handler; abort now
1611  // to avoid getting in some kind of infinite loop.
1612  break;
1613  }
1614  }
1615  }
1616 }
doQuickOperationsInternal(array $ops)
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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.
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:97
scopedProfileSection( $section)
Simple version of LockManager that does nothing.
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:175
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:1263
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
string $tmpDirectory
Temporary file directory.
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:780
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:3050
string $name
Unique backend name.
Definition: FileBackend.php:94
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:92
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:62
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.