MediaWiki REL1_30
FileBackend.php
Go to the documentation of this file.
1<?php
30use Psr\Log\LoggerAwareInterface;
31use Psr\Log\LoggerInterface;
32use Wikimedia\ScopedCallback;
33
92abstract 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;
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 = isset( $config['lockManager'] )
174 ? $config['lockManager']
175 : new NullLockManager( [] );
176 $this->fileJournal = isset( $config['fileJournal'] )
177 ? $config['fileJournal']
178 : FileJournal::factory( [ 'class' => 'NullFileJournal' ], $this->name );
179 $this->readOnly = isset( $config['readOnly'] )
180 ? (string)$config['readOnly']
181 : '';
182 $this->parallelize = isset( $config['parallelize'] )
183 ? (string)$config['parallelize']
184 : 'off';
185 $this->concurrency = isset( $config['concurrency'] )
186 ? (int)$config['concurrency']
187 : 50;
188 $this->obResetFunc = isset( $config['obResetFunc'] )
189 ? $config['obResetFunc']
190 : [ $this, 'resetOutputBuffer' ];
191 $this->streamMimeFunc = isset( $config['streamMimeFunc'] )
192 ? $config['streamMimeFunc']
193 : null;
194 $this->statusWrapper = isset( $config['statusWrapper'] ) ? $config['statusWrapper'] : null;
195
196 $this->profiler = isset( $config['profiler'] ) ? $config['profiler'] : null;
197 $this->logger = isset( $config['logger'] ) ? $config['logger'] : new \Psr\Log\NullLogger();
198 $this->statusWrapper = isset( $config['statusWrapper'] ) ? $config['statusWrapper'] : null;
199 $this->tmpDirectory = isset( $config['tmpDirectory'] ) ? $config['tmpDirectory'] : null;
200 }
201
202 public function setLogger( LoggerInterface $logger ) {
203 $this->logger = $logger;
204 }
205
213 final public function getName() {
214 return $this->name;
215 }
216
223 final public function getDomainId() {
224 return $this->domainId;
225 }
226
232 final public function getWikiId() {
233 return $this->getDomainId();
234 }
235
241 final public function isReadOnly() {
242 return ( $this->readOnly != '' );
243 }
244
250 final public function getReadOnlyReason() {
251 return ( $this->readOnly != '' ) ? $this->readOnly : false;
252 }
253
260 public function getFeatures() {
262 }
263
271 final public function hasFeatures( $bitfield ) {
272 return ( $this->getFeatures() & $bitfield ) === $bitfield;
273 }
274
423 final public function doOperations( array $ops, array $opts = [] ) {
424 if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
425 return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
426 }
427 if ( !count( $ops ) ) {
428 return $this->newStatus(); // nothing to do
429 }
430
431 $ops = $this->resolveFSFileObjects( $ops );
432 if ( empty( $opts['force'] ) ) { // sanity
433 unset( $opts['nonLocking'] );
434 }
435
437 $scope = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
438
439 return $this->doOperationsInternal( $ops, $opts );
440 }
441
447 abstract protected function doOperationsInternal( array $ops, array $opts );
448
460 final public function doOperation( array $op, array $opts = [] ) {
461 return $this->doOperations( [ $op ], $opts );
462 }
463
474 final public function create( array $params, array $opts = [] ) {
475 return $this->doOperation( [ 'op' => 'create' ] + $params, $opts );
476 }
477
488 final public function store( array $params, array $opts = [] ) {
489 return $this->doOperation( [ 'op' => 'store' ] + $params, $opts );
490 }
491
502 final public function copy( array $params, array $opts = [] ) {
503 return $this->doOperation( [ 'op' => 'copy' ] + $params, $opts );
504 }
505
516 final public function move( array $params, array $opts = [] ) {
517 return $this->doOperation( [ 'op' => 'move' ] + $params, $opts );
518 }
519
530 final public function delete( array $params, array $opts = [] ) {
531 return $this->doOperation( [ 'op' => 'delete' ] + $params, $opts );
532 }
533
545 final public function describe( array $params, array $opts = [] ) {
546 return $this->doOperation( [ 'op' => 'describe' ] + $params, $opts );
547 }
548
661 final public function doQuickOperations( array $ops, array $opts = [] ) {
662 if ( empty( $opts['bypassReadOnly'] ) && $this->isReadOnly() ) {
663 return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
664 }
665 if ( !count( $ops ) ) {
666 return $this->newStatus(); // nothing to do
667 }
668
669 $ops = $this->resolveFSFileObjects( $ops );
670 foreach ( $ops as &$op ) {
671 $op['overwrite'] = true; // avoids RTTs in key/value stores
672 }
673
675 $scope = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
676
677 return $this->doQuickOperationsInternal( $ops );
678 }
679
685 abstract protected function doQuickOperationsInternal( array $ops );
686
697 final public function doQuickOperation( array $op ) {
698 return $this->doQuickOperations( [ $op ] );
699 }
700
711 final public function quickCreate( array $params ) {
712 return $this->doQuickOperation( [ 'op' => 'create' ] + $params );
713 }
714
725 final public function quickStore( array $params ) {
726 return $this->doQuickOperation( [ 'op' => 'store' ] + $params );
727 }
728
739 final public function quickCopy( array $params ) {
740 return $this->doQuickOperation( [ 'op' => 'copy' ] + $params );
741 }
742
753 final public function quickMove( array $params ) {
754 return $this->doQuickOperation( [ 'op' => 'move' ] + $params );
755 }
756
767 final public function quickDelete( array $params ) {
768 return $this->doQuickOperation( [ 'op' => 'delete' ] + $params );
769 }
770
781 final public function quickDescribe( array $params ) {
782 return $this->doQuickOperation( [ 'op' => 'describe' ] + $params );
783 }
784
797 abstract public function concatenate( array $params );
798
817 final public function prepare( array $params ) {
818 if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
819 return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
820 }
822 $scope = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
823 return $this->doPrepare( $params );
824 }
825
830 abstract protected function doPrepare( array $params );
831
848 final public function secure( array $params ) {
849 if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
850 return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
851 }
853 $scope = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
854 return $this->doSecure( $params );
855 }
856
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 = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
887 return $this->doPublish( $params );
888 }
889
894 abstract protected function doPublish( array $params );
895
907 final public function clean( array $params ) {
908 if ( empty( $params['bypassReadOnly'] ) && $this->isReadOnly() ) {
909 return $this->newStatus( 'backend-fail-readonly', $this->name, $this->readOnly );
910 }
912 $scope = $this->getScopedPHPBehaviorForOps(); // try to ignore client aborts
913 return $this->doClean( $params );
914 }
915
920 abstract protected function doClean( array $params );
921
929 final protected function getScopedPHPBehaviorForOps() {
930 if ( PHP_SAPI != 'cli' ) { // https://bugs.php.net/bug.php?id=47540
931 $old = ignore_user_abort( true ); // avoid half-finished operations
932 return new ScopedCallback( function () use ( $old ) {
933 ignore_user_abort( $old );
934 } );
935 }
936
937 return null;
938 }
939
949 abstract public function fileExists( array $params );
950
959 abstract public function getFileTimestamp( array $params );
960
970 final public function getFileContents( array $params ) {
971 $contents = $this->getFileContentsMulti(
972 [ 'srcs' => [ $params['src'] ] ] + $params );
973
974 return $contents[$params['src']];
975 }
976
991 abstract public function getFileContentsMulti( array $params );
992
1011 abstract public function getFileXAttributes( array $params );
1012
1021 abstract public function getFileSize( array $params );
1022
1036 abstract public function getFileStat( array $params );
1037
1046 abstract public function getFileSha1Base36( array $params );
1047
1057 abstract public function getFileProps( array $params );
1058
1078 abstract public function streamFile( array $params );
1079
1098 final public function getLocalReference( array $params ) {
1099 $fsFiles = $this->getLocalReferenceMulti(
1100 [ 'srcs' => [ $params['src'] ] ] + $params );
1101
1102 return $fsFiles[$params['src']];
1103 }
1104
1119 abstract public function getLocalReferenceMulti( array $params );
1120
1131 final public function getLocalCopy( array $params ) {
1132 $tmpFiles = $this->getLocalCopyMulti(
1133 [ 'srcs' => [ $params['src'] ] ] + $params );
1134
1135 return $tmpFiles[$params['src']];
1136 }
1137
1152 abstract public function getLocalCopyMulti( array $params );
1153
1170 abstract public function getFileHttpUrl( array $params );
1171
1184 abstract public function directoryExists( array $params );
1185
1204 abstract public function getDirectoryList( array $params );
1205
1219 final public function getTopDirectoryList( array $params ) {
1220 return $this->getDirectoryList( [ 'topOnly' => true ] + $params );
1221 }
1222
1241 abstract public function getFileList( array $params );
1242
1257 final public function getTopFileList( array $params ) {
1258 return $this->getFileList( [ 'topOnly' => true ] + $params );
1259 }
1260
1269 abstract public function preloadCache( array $paths );
1270
1279 abstract public function clearCache( array $paths = null );
1280
1295 abstract public function preloadFileStat( array $params );
1296
1308 final public function lockFiles( array $paths, $type, $timeout = 0 ) {
1309 $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1310
1311 return $this->wrapStatus( $this->lockManager->lock( $paths, $type, $timeout ) );
1312 }
1313
1321 final public function unlockFiles( array $paths, $type ) {
1322 $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1323
1324 return $this->wrapStatus( $this->lockManager->unlock( $paths, $type ) );
1325 }
1326
1343 final public function getScopedFileLocks(
1344 array $paths, $type, StatusValue $status, $timeout = 0
1345 ) {
1346 if ( $type === 'mixed' ) {
1347 foreach ( $paths as &$typePaths ) {
1348 $typePaths = array_map( 'FileBackend::normalizeStoragePath', $typePaths );
1349 }
1350 } else {
1351 $paths = array_map( 'FileBackend::normalizeStoragePath', $paths );
1352 }
1353
1354 return ScopedLock::factory( $this->lockManager, $paths, $type, $status, $timeout );
1355 }
1356
1373 abstract public function getScopedLocksForOps( array $ops, StatusValue $status );
1374
1382 final public function getRootStoragePath() {
1383 return "mwstore://{$this->name}";
1384 }
1385
1393 final public function getContainerStoragePath( $container ) {
1394 return $this->getRootStoragePath() . "/{$container}";
1395 }
1396
1402 final public function getJournal() {
1403 return $this->fileJournal;
1404 }
1405
1415 protected function resolveFSFileObjects( array $ops ) {
1416 foreach ( $ops as &$op ) {
1417 $src = isset( $op['src'] ) ? $op['src'] : null;
1418 if ( $src instanceof FSFile ) {
1419 $op['srcRef'] = $src;
1420 $op['src'] = $src->getPath();
1421 }
1422 }
1423 unset( $op );
1424
1425 return $ops;
1426 }
1427
1435 final public static function isStoragePath( $path ) {
1436 return ( strpos( $path, 'mwstore://' ) === 0 );
1437 }
1438
1447 final public static function splitStoragePath( $storagePath ) {
1448 if ( self::isStoragePath( $storagePath ) ) {
1449 // Remove the "mwstore://" prefix and split the path
1450 $parts = explode( '/', substr( $storagePath, 10 ), 3 );
1451 if ( count( $parts ) >= 2 && $parts[0] != '' && $parts[1] != '' ) {
1452 if ( count( $parts ) == 3 ) {
1453 return $parts; // e.g. "backend/container/path"
1454 } else {
1455 return [ $parts[0], $parts[1], '' ]; // e.g. "backend/container"
1456 }
1457 }
1458 }
1459
1460 return [ null, null, null ];
1461 }
1462
1470 final public static function normalizeStoragePath( $storagePath ) {
1471 list( $backend, $container, $relPath ) = self::splitStoragePath( $storagePath );
1472 if ( $relPath !== null ) { // must be for this backend
1473 $relPath = self::normalizeContainerPath( $relPath );
1474 if ( $relPath !== null ) {
1475 return ( $relPath != '' )
1476 ? "mwstore://{$backend}/{$container}/{$relPath}"
1477 : "mwstore://{$backend}/{$container}";
1478 }
1479 }
1480
1481 return null;
1482 }
1483
1492 final public static function parentStoragePath( $storagePath ) {
1493 $storagePath = dirname( $storagePath );
1494 list( , , $rel ) = self::splitStoragePath( $storagePath );
1495
1496 return ( $rel === null ) ? null : $storagePath;
1497 }
1498
1506 final public static function extensionFromPath( $path, $case = 'lowercase' ) {
1507 $i = strrpos( $path, '.' );
1508 $ext = $i ? substr( $path, $i + 1 ) : '';
1509
1510 if ( $case === 'lowercase' ) {
1511 $ext = strtolower( $ext );
1512 } elseif ( $case === 'uppercase' ) {
1513 $ext = strtoupper( $ext );
1514 }
1515
1516 return $ext;
1517 }
1518
1526 final public static function isPathTraversalFree( $path ) {
1527 return ( self::normalizeContainerPath( $path ) !== null );
1528 }
1529
1539 final public static function makeContentDisposition( $type, $filename = '' ) {
1540 $parts = [];
1541
1542 $type = strtolower( $type );
1543 if ( !in_array( $type, [ 'inline', 'attachment' ] ) ) {
1544 throw new InvalidArgumentException( "Invalid Content-Disposition type '$type'." );
1545 }
1546 $parts[] = $type;
1547
1548 if ( strlen( $filename ) ) {
1549 $parts[] = "filename*=UTF-8''" . rawurlencode( basename( $filename ) );
1550 }
1551
1552 return implode( ';', $parts );
1553 }
1554
1565 final protected static function normalizeContainerPath( $path ) {
1566 // Normalize directory separators
1567 $path = strtr( $path, '\\', '/' );
1568 // Collapse any consecutive directory separators
1569 $path = preg_replace( '![/]{2,}!', '/', $path );
1570 // Remove any leading directory separator
1571 $path = ltrim( $path, '/' );
1572 // Use the same traversal protection as Title::secureAndSplit()
1573 if ( strpos( $path, '.' ) !== false ) {
1574 if (
1575 $path === '.' ||
1576 $path === '..' ||
1577 strpos( $path, './' ) === 0 ||
1578 strpos( $path, '../' ) === 0 ||
1579 strpos( $path, '/./' ) !== false ||
1580 strpos( $path, '/../' ) !== false
1581 ) {
1582 return null;
1583 }
1584 }
1585
1586 return $path;
1587 }
1588
1597 final protected function newStatus() {
1598 $args = func_get_args();
1599 if ( count( $args ) ) {
1600 $sv = call_user_func_array( [ 'StatusValue', 'newFatal' ], $args );
1601 } else {
1602 $sv = StatusValue::newGood();
1603 }
1604
1605 return $this->wrapStatus( $sv );
1606 }
1607
1612 final protected function wrapStatus( StatusValue $sv ) {
1613 return $this->statusWrapper ? call_user_func( $this->statusWrapper, $sv ) : $sv;
1614 }
1615
1620 protected function scopedProfileSection( $section ) {
1621 if ( $this->profiler ) {
1622 call_user_func( [ $this->profiler, 'profileIn' ], $section );
1623 return new ScopedCallback( [ $this->profiler, 'profileOut' ], [ $section ] );
1624 }
1625
1626 return null;
1627 }
1628
1629 protected function resetOutputBuffer() {
1630 while ( ob_get_status() ) {
1631 if ( !ob_end_clean() ) {
1632 // Could not remove output buffer handler; abort now
1633 // to avoid getting in some kind of infinite loop.
1634 break;
1635 }
1636 }
1637 }
1638}
if( $line===false) $args
Definition cdb.php:63
Class representing a non-directory file on the file system.
Definition FSFile.php:29
Base class for all file backend classes (including multi-write backends).
getScopedLocksForOps(array $ops, StatusValue $status)
Get an array of scoped locks needed for a batch of file operations.
concatenate(array $params)
Concatenate a list of storage files into a single file system file.
static parentStoragePath( $storagePath)
Get the parent storage directory of a storage path.
string $tmpDirectory
Temporary file directory.
doOperation(array $op, array $opts=[])
Same as doOperations() except it takes a single operation.
quickDelete(array $params)
Performs a single quick delete operation.
create(array $params, array $opts=[])
Performs a single create operation.
wrapStatus(StatusValue $sv)
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
hasFeatures( $bitfield)
Check if the backend medium supports a field of extra features.
quickMove(array $params)
Performs a single quick move operation.
getFileXAttributes(array $params)
Get metadata about a file at a storage path in the backend.
getLocalCopy(array $params)
Get a local copy on disk of the file at a storage path in the backend.
clean(array $params)
Delete a storage directory if it is empty.
string $name
Unique backend name.
move(array $params, array $opts=[])
Performs a single move operation.
object string $profiler
Class name or object With profileIn/profileOut methods.
getDirectoryList(array $params)
Get an iterator to list all directories under a storage directory.
getFileList(array $params)
Get an iterator to list all stored files under a storage directory.
lockFiles(array $paths, $type, $timeout=0)
Lock the files at the given storage paths in the backend.
preloadFileStat(array $params)
Preload file stat information (concurrently if possible) into in-process cache.
describe(array $params, array $opts=[])
Performs a single describe operation.
getDomainId()
Get the domain identifier used for this backend (possibly empty).
getFeatures()
Get the a bitfield of extra features supported by the backend medium.
streamFile(array $params)
Stream the file 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.
getReadOnlyReason()
Get an explanatory message if this backend is read-only.
doClean(array $params)
publish(array $params)
Remove measures to block web access to a storage directory and the container it belongs to.
const ATTR_UNICODE_PATHS
callable $obResetFunc
clearCache(array $paths=null)
Invalidate any in-process file stat and property cache.
getFileStat(array $params)
Get quick information about a file at a storage path in the backend.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
getFileTimestamp(array $params)
Get the last-modified timestamp of the file at a storage path.
LoggerInterface $logger
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.
static normalizeContainerPath( $path)
Validate and normalize a relative storage path.
doQuickOperationsInternal(array $ops)
string $readOnly
Read-only explanation message.
preloadCache(array $paths)
Preload persistent file stat cache and property cache into in-process cache.
string $domainId
Unique domain name.
getScopedFileLocks(array $paths, $type, StatusValue $status, $timeout=0)
Lock the files at the given storage paths in the backend.
store(array $params, array $opts=[])
Performs a single store operation.
isReadOnly()
Check if this backend is read-only.
getRootStoragePath()
Get the root storage path of this backend.
getTopDirectoryList(array $params)
Same as FileBackend::getDirectoryList() except only lists directories that are immediately under the ...
getFileProps(array $params)
Get the properties of the file at a storage path in the backend.
getFileSize(array $params)
Get the size (bytes) of a file at a storage path in the backend.
getWikiId()
Alias to getDomainId()
quickStore(array $params)
Performs a single quick store operation.
prepare(array $params)
Prepare a storage directory for usage.
getFileContentsMulti(array $params)
Like getFileContents() except it takes an array of storage paths and returns a map of storage paths t...
doQuickOperations(array $ops, array $opts=[])
Perform a set of independent file operations on some files.
unlockFiles(array $paths, $type)
Unlock the files at the given storage paths in the backend.
getContainerStoragePath( $container)
Get the storage path for the given container for this backend.
newStatus()
Yields the result of the status wrapper callback on either:
scopedProfileSection( $section)
const ATTR_METADATA
doOperations(array $ops, array $opts=[])
This is the main entry point into the backend for write operations.
static normalizeStoragePath( $storagePath)
Normalize a storage path by cleaning up directory separators.
directoryExists(array $params)
Check if a directory exists at a given storage path.
callable $streamMimeFunc
resolveFSFileObjects(array $ops)
Convert FSFile 'src' paths to string paths (with an 'srcRef' field set to the FSFile)
string $parallelize
When to do operations in parallel.
doPublish(array $params)
LockManager $lockManager
getLocalCopyMulti(array $params)
Like getLocalCopy() except it takes an array of storage paths and returns a map of storage paths to T...
int $concurrency
How many operations can be done in parallel.
getTopFileList(array $params)
Same as FileBackend::getFileList() except only lists files that are immediately under the given direc...
const ATTR_HEADERS
Bitfield flags for supported features.
doPrepare(array $params)
__construct(array $config)
Create a new backend instance from configuration.
static isPathTraversalFree( $path)
Check if a relative path has no directory traversals.
callable $statusWrapper
doQuickOperation(array $op)
Same as doQuickOperations() except it takes a single operation.
doSecure(array $params)
setLogger(LoggerInterface $logger)
getLocalReferenceMulti(array $params)
Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths...
quickDescribe(array $params)
Performs a single quick describe operation.
copy(array $params, array $opts=[])
Performs a single copy operation.
FileJournal $fileJournal
getFileContents(array $params)
Get the contents of a file at a storage path in the backend.
getLocalReference(array $params)
Returns a file system file, identical to the file at a storage path.
getName()
Get the unique backend name.
quickCreate(array $params)
Performs a single quick create operation.
quickCopy(array $params)
Performs a single quick copy operation.
getJournal()
Get the file journal object for this backend.
getFileHttpUrl(array $params)
Return an HTTP URL to a given file that requires no authentication to use.
doOperationsInternal(array $ops, array $opts)
secure(array $params)
Take measures to block web access to a storage directory and the container it belongs to.
getScopedPHPBehaviorForOps()
Enter file operation scope.
Class for handling file operation journaling.
static factory(array $config, $backend)
Create an appropriate FileJournal object from config.
Class for handling resource locking.
Simple version of LockManager that does nothing.
static factory(LockManager $manager, array $paths, $type, StatusValue $status, $timeout=0)
Get a ScopedLock object representing a lock on resource paths.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
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
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
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). '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:1049
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:2990
$params