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 
162  public function __construct( array $config ) {
163  $this->name = $config['name'];
164  $this->domainId = isset( $config['domainId'] )
165  ? $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  $this->logger = $config['logger'] ?? new \Psr\Log\NullLogger();
191  $this->statusWrapper = $config['statusWrapper'] ?? null;
192  $this->tmpDirectory = $config['tmpDirectory'] ?? null;
193  }
194 
195  public function setLogger( LoggerInterface $logger ) {
196  $this->logger = $logger;
197  }
198 
206  final public function getName() {
207  return $this->name;
208  }
209 
216  final public function getDomainId() {
217  return $this->domainId;
218  }
219 
225  final public function getWikiId() {
226  return $this->getDomainId();
227  }
228 
234  final public function isReadOnly() {
235  return ( $this->readOnly != '' );
236  }
237 
243  final public function getReadOnlyReason() {
244  return ( $this->readOnly != '' ) ? $this->readOnly : false;
245  }
246 
253  public function getFeatures() {
254  return self::ATTR_UNICODE_PATHS;
255  }
256 
264  final public function hasFeatures( $bitfield ) {
265  return ( $this->getFeatures() & $bitfield ) === $bitfield;
266  }
267 
416  final public function doOperations( array $ops, array $opts = [] ) {
417  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
418  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
419  }
420  if ( !count( $ops ) ) {
421  return $this->newStatus(); // nothing to do
422  }
423 
424  $ops = $this->resolveFSFileObjects( $ops );
425  if ( empty( $opts['force'] ) ) { // sanity
426  unset( $opts['nonLocking'] );
427  }
428 
430  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
431 
432  return $this->doOperationsInternal( $ops, $opts );
433  }
434 
440  abstract protected function doOperationsInternal( array $ops, array $opts );
441 
453  final public function doOperation( array $op, array $opts = [] ) {
454  return $this->doOperations( [ $op ], $opts );
455  }
456 
467  final public function create( array $params, array $opts = [] ) {
468  return $this->doOperation( [ 'op' => 'create' ] + $params, $opts );
469  }
470 
481  final public function store( array $params, array $opts = [] ) {
482  return $this->doOperation( [ 'op' => 'store' ] + $params, $opts );
483  }
484 
495  final public function copy( array $params, array $opts = [] ) {
496  return $this->doOperation( [ 'op' => 'copy' ] + $params, $opts );
497  }
498 
509  final public function move( array $params, array $opts = [] ) {
510  return $this->doOperation( [ 'op' => 'move' ] + $params, $opts );
511  }
512 
523  final public function delete( array $params, array $opts = [] ) {
524  return $this->doOperation( [ 'op' => 'delete' ] + $params, $opts );
525  }
526 
538  final public function describe( array $params, array $opts = [] ) {
539  return $this->doOperation( [ 'op' => 'describe' ] + $params, $opts );
540  }
541 
654  final public function doQuickOperations( array $ops, array $opts = [] ) {
655  if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
656  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
657  }
658  if ( !count( $ops ) ) {
659  return $this->newStatus(); // nothing to do
660  }
661 
662  $ops = $this->resolveFSFileObjects( $ops );
663  foreach ( $ops as &$op ) {
664  $op['overwrite'] = true; // avoids RTTs in key/value stores
665  }
666 
668  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
669 
670  return $this->doQuickOperationsInternal( $ops );
671  }
672 
678  abstract protected function doQuickOperationsInternal( array $ops );
679 
690  final public function doQuickOperation( array $op ) {
691  return $this->doQuickOperations( [ $op ] );
692  }
693 
704  final public function quickCreate( array $params ) {
705  return $this->doQuickOperation( [ 'op' => 'create' ] + $params );
706  }
707 
718  final public function quickStore( array $params ) {
719  return $this->doQuickOperation( [ 'op' => 'store' ] + $params );
720  }
721 
732  final public function quickCopy( array $params ) {
733  return $this->doQuickOperation( [ 'op' => 'copy' ] + $params );
734  }
735 
746  final public function quickMove( array $params ) {
747  return $this->doQuickOperation( [ 'op' => 'move' ] + $params );
748  }
749 
760  final public function quickDelete( array $params ) {
761  return $this->doQuickOperation( [ 'op' => 'delete' ] + $params );
762  }
763 
774  final public function quickDescribe( array $params ) {
775  return $this->doQuickOperation( [ 'op' => 'describe' ] + $params );
776  }
777 
790  abstract public function concatenate( array $params );
791 
810  final public function prepare( array $params ) {
811  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
812  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
813  }
815  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
816  return $this->doPrepare( $params );
817  }
818 
823  abstract protected function doPrepare( array $params );
824 
841  final public function secure( array $params ) {
842  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
843  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
844  }
846  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
847  return $this->doSecure( $params );
848  }
849 
854  abstract protected function doSecure( array $params );
855 
874  final public function publish( array $params ) {
875  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
876  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
877  }
879  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
880  return $this->doPublish( $params );
881  }
882 
887  abstract protected function doPublish( array $params );
888 
900  final public function clean( array $params ) {
901  if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
902  return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
903  }
905  $scope = ScopedCallback::newScopedIgnoreUserAbort(); // try to ignore client aborts
906  return $this->doClean( $params );
907  }
908 
913  abstract protected function doClean( array $params );
914 
924  abstract public function fileExists( array $params );
925 
934  abstract public function getFileTimestamp( array $params );
935 
945  final public function getFileContents( array $params ) {
946  $contents = $this->getFileContentsMulti(
947  [ 'srcs' => [ $params['src'] ] ] + $params );
948 
949  return $contents[$params['src']];
950  }
951 
966  abstract public function getFileContentsMulti( array $params );
967 
986  abstract public function getFileXAttributes( array $params );
987 
996  abstract public function getFileSize( array $params );
997 
1011  abstract public function getFileStat( array $params );
1012 
1021  abstract public function getFileSha1Base36( array $params );
1022 
1032  abstract public function getFileProps( array $params );
1033 
1053  abstract public function streamFile( array $params );
1054 
1073  final public function getLocalReference( array $params ) {
1074  $fsFiles = $this->getLocalReferenceMulti(
1075  [ 'srcs' => [ $params['src'] ] ] + $params );
1076 
1077  return $fsFiles[$params['src']];
1078  }
1079 
1094  abstract public function getLocalReferenceMulti( array $params );
1095 
1106  final public function getLocalCopy( array $params ) {
1107  $tmpFiles = $this->getLocalCopyMulti(
1108  [ 'srcs' => [ $params['src'] ] ] + $params );
1109 
1110  return $tmpFiles[$params['src']];
1111  }
1112 
1127  abstract public function getLocalCopyMulti( array $params );
1128 
1145  abstract public function getFileHttpUrl( array $params );
1146 
1159  abstract public function directoryExists( array $params );
1160 
1179  abstract public function getDirectoryList( array $params );
1180 
1194  final public function getTopDirectoryList( array $params ) {
1195  return $this->getDirectoryList( [ 'topOnly' => true ] + $params );
1196  }
1197 
1216  abstract public function getFileList( array $params );
1217 
1232  final public function getTopFileList( array $params ) {
1233  return $this->getFileList( [ 'topOnly' => true ] + $params );
1234  }
1235 
1244  abstract public function preloadCache( array $paths );
1245 
1254  abstract public function clearCache( array $paths = null );
1255 
1270  abstract public function preloadFileStat( array $params );
1271 
1283  final public function lockFiles( array $paths, $type, $timeout = 0 ) {
1284  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1285 
1286  return $this->wrapStatus( $this->lockManager->lock( $paths, $type, $timeout ) );
1287  }
1288 
1296  final public function unlockFiles( array $paths, $type ) {
1297  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1298 
1299  return $this->wrapStatus( $this->lockManager->unlock( $paths, $type ) );
1300  }
1301 
1318  final public function getScopedFileLocks(
1319  array $paths, $type, StatusValue $status, $timeout = 0
1320  ) {
1321  if ( $type === 'mixed' ) {
1322  foreach ( $paths as &$typePaths ) {
1323  $typePaths = array_map( 'FileBackend::normalizeStoragePath', $typePaths );
1324  }
1325  } else {
1326  $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1327  }
1328 
1329  return ScopedLock::factory( $this->lockManager, $paths, $type, $status, $timeout );
1330  }
1331 
1348  abstract public function getScopedLocksForOps( array $ops, StatusValue $status );
1349 
1357  final public function getRootStoragePath() {
1358  return "mwstore://{$this->name}";
1359  }
1360 
1368  final public function getContainerStoragePath( $container ) {
1369  return $this->getRootStoragePath() . "/{$container}";
1370  }
1371 
1377  final public function getJournal() {
1378  return $this->fileJournal;
1379  }
1380 
1390  protected function resolveFSFileObjects( array $ops ) {
1391  foreach ( $ops as &$op ) {
1392  $src = $op['src'] ?? null;
1393  if ( $src instanceof FSFile ) {
1394  $op['srcRef'] = $src;
1395  $op['src'] = $src->getPath();
1396  }
1397  }
1398  unset( $op );
1399 
1400  return $ops;
1401  }
1402 
1410  final public static function isStoragePath( $path ) {
1411  return ( strpos( $path, 'mwstore://' ) === 0 );
1412  }
1413 
1422  final public static function splitStoragePath( $storagePath ) {
1423  if ( self::isStoragePath( $storagePath ) ) {
1424  // Remove the "mwstore://" prefix and split the path
1425  $parts = explode( '/', substr( $storagePath, 10 ), 3 );
1426  if ( count( $parts ) >= 2 && $parts[0] != '' && $parts[1] != '' ) {
1427  if ( count( $parts ) == 3 ) {
1428  return $parts; // e.g. "backend/container/path"
1429  } else {
1430  return [ $parts[0], $parts[1], '' ]; // e.g. "backend/container"
1431  }
1432  }
1433  }
1434 
1435  return [ null, null, null ];
1436  }
1437 
1445  final public static function normalizeStoragePath( $storagePath ) {
1446  list( $backend, $container, $relPath ) = self::splitStoragePath( $storagePath );
1447  if ( $relPath !== null ) { // must be for this backend
1448  $relPath = self::normalizeContainerPath( $relPath );
1449  if ( $relPath !== null ) {
1450  return ( $relPath != '' )
1451  ? "mwstore://{$backend}/{$container}/{$relPath}"
1452  : "mwstore://{$backend}/{$container}";
1453  }
1454  }
1455 
1456  return null;
1457  }
1458 
1467  final public static function parentStoragePath( $storagePath ) {
1468  $storagePath = dirname( $storagePath );
1469  list( , , $rel ) = self::splitStoragePath( $storagePath );
1470 
1471  return ( $rel === null ) ? null : $storagePath;
1472  }
1473 
1481  final public static function extensionFromPath( $path, $case = 'lowercase' ) {
1482  $i = strrpos( $path, '.' );
1483  $ext = $i ? substr( $path, $i + 1 ) : '';
1484 
1485  if ( $case === 'lowercase' ) {
1486  $ext = strtolower( $ext );
1487  } elseif ( $case === 'uppercase' ) {
1488  $ext = strtoupper( $ext );
1489  }
1490 
1491  return $ext;
1492  }
1493 
1501  final public static function isPathTraversalFree( $path ) {
1502  return ( self::normalizeContainerPath( $path ) !== null );
1503  }
1504 
1514  final public static function makeContentDisposition( $type, $filename = '' ) {
1515  $parts = [];
1516 
1517  $type = strtolower( $type );
1518  if ( !in_array( $type, [ 'inline', 'attachment' ] ) ) {
1519  throw new InvalidArgumentException( "Invalid Content-Disposition type '$type'." );
1520  }
1521  $parts[] = $type;
1522 
1523  if ( strlen( $filename ) ) {
1524  $parts[] = "filename*=UTF-8''" . rawurlencode( basename( $filename ) );
1525  }
1526 
1527  return implode( ';', $parts );
1528  }
1529 
1540  final protected static function normalizeContainerPath( $path ) {
1541  // Normalize directory separators
1542  $path = strtr( $path, '\\', '/' );
1543  // Collapse any consecutive directory separators
1544  $path = preg_replace( '![/]{2,}!', '/', $path );
1545  // Remove any leading directory separator
1546  $path = ltrim( $path, '/' );
1547  // Use the same traversal protection as Title::secureAndSplit()
1548  if ( strpos( $path, '.' ) !== false ) {
1549  if (
1550  $path === '.' ||
1551  $path === '..' ||
1552  strpos( $path, './' ) === 0 ||
1553  strpos( $path, '../' ) === 0 ||
1554  strpos( $path, '/./' ) !== false ||
1555  strpos( $path, '/../' ) !== false
1556  ) {
1557  return null;
1558  }
1559  }
1560 
1561  return $path;
1562  }
1563 
1572  final protected function newStatus() {
1573  $args = func_get_args();
1574  if ( count( $args ) ) {
1575  $sv = StatusValue::newFatal( ...$args );
1576  } else {
1577  $sv = StatusValue::newGood();
1578  }
1579 
1580  return $this->wrapStatus( $sv );
1581  }
1582 
1587  final protected function wrapStatus( StatusValue $sv ) {
1588  return $this->statusWrapper ? call_user_func( $this->statusWrapper, $sv ) : $sv;
1589  }
1590 
1595  protected function scopedProfileSection( $section ) {
1596  if ( $this->profiler ) {
1597  call_user_func( [ $this->profiler, 'profileIn' ], $section );
1598  return new ScopedCallback( [ $this->profiler, 'profileOut' ], [ $section ] );
1599  }
1600 
1601  return null;
1602  }
1603 
1604  protected function resetOutputBuffer() {
1605  while ( ob_get_status() ) {
1606  if ( !ob_end_clean() ) {
1607  // Could not remove output buffer handler; abort now
1608  // to avoid getting in some kind of infinite loop.
1609  break;
1610  }
1611  }
1612  }
1613 }
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.
newStatus()
Yields the result of the status wrapper callback on either:
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.
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 '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:1277
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
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
callable $streamMimeFunc
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:3043
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.
object string $profiler
Class name or object With profileIn/profileOut methods.
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.
$ext
Definition: router.php:55
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.