75 parent::__construct( $config );
77 $this->isWindows = ( strtoupper( substr( PHP_OS, 0, 3 ) ) ===
'WIN' );
79 if ( isset( $config[
'basePath'] ) ) {
80 $this->basePath = rtrim( $config[
'basePath'],
'/' );
82 $this->basePath =
null;
85 if ( isset( $config[
'containerPaths'] ) ) {
86 $this->containerPaths = (
array)$config[
'containerPaths'];
87 foreach ( $this->containerPaths
as &
$path ) {
92 $this->fileMode = isset( $config[
'fileMode'] ) ? $config[
'fileMode'] : 0644;
93 $this->dirMode = isset( $config[
'directoryMode'] ) ? $config[
'directoryMode'] : 0777;
94 if ( isset( $config[
'fileOwner'] ) && function_exists(
'posix_getuid' ) ) {
95 $this->fileOwner = $config[
'fileOwner'];
97 $this->currentUser = posix_getpwuid( posix_getuid() )[
'name'];
107 if ( isset( $this->containerPaths[$container] ) || isset( $this->basePath ) ) {
110 return $relStoragePath;
125 if ( preg_match(
'![^/]{256}!',
$path ) ) {
128 if ( $this->isWindows ) {
129 return !preg_match(
'![:*?"<>|]!',
$path );
144 if ( isset( $this->containerPaths[$shortCont] ) ) {
145 return $this->containerPaths[$shortCont];
146 } elseif ( isset( $this->basePath ) ) {
147 return "{$this->basePath}/{$fullCont}";
161 if ( $relPath ===
null ) {
166 if ( $relPath !=
'' ) {
167 $fsPath .=
"/{$relPath}";
175 if ( $fsPath ===
null ) {
178 $parentDir = dirname( $fsPath );
180 if ( file_exists( $fsPath ) ) {
181 $ok = is_file( $fsPath ) && is_writable( $fsPath );
183 $ok = is_dir( $parentDir ) && is_writable( $parentDir );
186 if ( $this->fileOwner !==
null && $this->currentUser !== $this->fileOwner ) {
188 trigger_error( __METHOD__ .
": PHP process owner is not '{$this->fileOwner}'." );
198 if ( $dest ===
null ) {
204 if ( !empty(
$params[
'async'] ) ) {
212 $bytes = file_put_contents( $tempFile->getPath(),
$params[
'content'] );
214 if ( $bytes ===
false ) {
219 $cmd = implode(
' ', [
220 $this->isWindows ?
'COPY /B /Y' :
'cp',
225 if ( $errors !==
'' && !( $this->isWindows && $errors[0] ===
" " ) ) {
227 trigger_error(
"$cmd\n$errors", E_USER_WARNING );
231 $tempFile->bind(
$status->value );
234 $bytes = file_put_contents( $dest,
$params[
'content'] );
236 if ( $bytes ===
false ) {
241 $this->
chmod( $dest );
251 if ( $dest ===
null ) {
257 if ( !empty(
$params[
'async'] ) ) {
258 $cmd = implode(
' ', [
259 $this->isWindows ?
'COPY /B /Y' :
'cp',
264 if ( $errors !==
'' && !( $this->isWindows && $errors[0] ===
" " ) ) {
266 trigger_error(
"$cmd\n$errors", E_USER_WARNING );
275 if ( !$ok || ( filesize(
$params[
'src'] ) !== filesize( $dest ) ) ) {
278 trigger_error( __METHOD__ .
": copy() failed but returned true." );
284 $this->
chmod( $dest );
301 if ( $dest ===
null ) {
308 if ( empty(
$params[
'ignoreMissingSource'] ) ) {
315 if ( !empty(
$params[
'async'] ) ) {
316 $cmd = implode(
' ', [
317 $this->isWindows ?
'COPY /B /Y' :
'cp',
322 if ( $errors !==
'' && !( $this->isWindows && $errors[0] ===
" " ) ) {
324 trigger_error(
"$cmd\n$errors", E_USER_WARNING );
333 if ( !$ok || ( filesize(
$source ) !== filesize( $dest ) ) ) {
338 trigger_error( __METHOD__ .
": copy() failed but returned true." );
344 $this->
chmod( $dest );
361 if ( $dest ===
null ) {
368 if ( empty(
$params[
'ignoreMissingSource'] ) ) {
375 if ( !empty(
$params[
'async'] ) ) {
376 $cmd = implode(
' ', [
377 $this->isWindows ?
'MOVE /Y' :
'mv',
382 if ( $errors !==
'' && !( $this->isWindows && $errors[0] ===
" " ) ) {
384 trigger_error(
"$cmd\n$errors", E_USER_WARNING );
414 if ( empty(
$params[
'ignoreMissingSource'] ) ) {
421 if ( !empty(
$params[
'async'] ) ) {
422 $cmd = implode(
' ', [
423 $this->isWindows ?
'DEL' :
'unlink',
427 if ( $errors !==
'' && !( $this->isWindows && $errors[0] ===
" " ) ) {
429 trigger_error(
"$cmd\n$errors", E_USER_WARNING );
457 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
458 $existed = is_dir(
$dir );
461 if ( !$existed && !mkdir(
$dir, $this->dirMode,
true ) && !is_dir(
$dir ) ) {
462 $this->logger->error( __METHOD__ .
": cannot create directory $dir" );
464 } elseif ( !is_writable(
$dir ) ) {
465 $this->logger->error( __METHOD__ .
": directory $dir is read-only" );
467 } elseif ( !is_readable(
$dir ) ) {
468 $this->logger->error( __METHOD__ .
": directory $dir is not readable" );
473 if ( is_dir(
$dir ) && !$existed ) {
484 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
486 if ( !empty(
$params[
'noListing'] ) && !file_exists(
"{$dir}/index.html" ) ) {
488 $bytes = file_put_contents(
"{$dir}/index.html", $this->
indexHtmlPrivate() );
490 if ( $bytes ===
false ) {
491 $status->fatal(
'backend-fail-create',
$params[
'dir'] .
'/index.html' );
495 if ( !empty(
$params[
'noAccess'] ) && !file_exists(
"{$contRoot}/.htaccess" ) ) {
497 $bytes = file_put_contents(
"{$contRoot}/.htaccess", $this->
htaccessPrivate() );
499 if ( $bytes ===
false ) {
500 $storeDir =
"mwstore://{$this->name}/{$shortCont}";
501 $status->fatal(
'backend-fail-create',
"{$storeDir}/.htaccess" );
512 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
514 if ( !empty(
$params[
'listing'] ) && is_file(
"{$dir}/index.html" ) ) {
515 $exists = ( file_get_contents(
"{$dir}/index.html" ) === $this->
indexHtmlPrivate() );
517 if ( $exists && !unlink(
"{$dir}/index.html" ) ) {
518 $status->fatal(
'backend-fail-delete',
$params[
'dir'] .
'/index.html' );
523 if ( !empty(
$params[
'access'] ) && is_file(
"{$contRoot}/.htaccess" ) ) {
524 $exists = ( file_get_contents(
"{$contRoot}/.htaccess" ) === $this->
htaccessPrivate() );
526 if ( $exists && !unlink(
"{$contRoot}/.htaccess" ) ) {
527 $storeDir =
"mwstore://{$this->name}/{$shortCont}";
528 $status->fatal(
'backend-fail-delete',
"{$storeDir}/.htaccess" );
540 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
542 if ( is_dir(
$dir ) ) {
564 'mtime' => $ct->getTimestamp(
TS_MW ),
565 'size' => $stat[
'size']
567 } elseif ( !$hadError ) {
581 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
584 $exists = is_dir(
$dir );
587 return $hadError ? null : $exists;
600 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
601 $exists = is_dir(
$dir );
603 $this->logger->warning( __METHOD__ .
"() given directory does not exist: '$dir'\n" );
606 } elseif ( !is_readable(
$dir ) ) {
607 $this->logger->warning( __METHOD__ .
"() given directory is unreadable: '$dir'\n" );
625 $dir = ( $dirRel !=
'' ) ?
"{$contRoot}/{$dirRel}" : $contRoot;
626 $exists = is_dir(
$dir );
628 $this->logger->warning( __METHOD__ .
"() given directory does not exist: '$dir'\n" );
631 } elseif ( !is_readable(
$dir ) ) {
632 $this->logger->warning( __METHOD__ .
"() given directory is unreadable: '$dir'\n" );
646 $fsFiles[$src] =
null;
661 $tmpFiles[$src] =
null;
667 $tmpFiles[$src] =
null;
669 $tmpPath = $tmpFile->getPath();
675 $tmpFiles[$src] =
null;
677 $this->
chmod( $tmpPath );
678 $tmpFiles[$src] = $tmpFile;
700 foreach ( $fileOpHandles
as $index => $fileOpHandle ) {
701 $pipes[$index] = popen(
"{$fileOpHandle->cmd} 2>&1",
'r' );
705 foreach ( $pipes
as $index => $pipe ) {
708 $errs[$index] = stream_get_contents( $pipe );
712 foreach ( $fileOpHandles
as $index => $fileOpHandle ) {
714 $function = $fileOpHandle->call;
715 $function( $errs[$index],
$status, $fileOpHandle->params, $fileOpHandle->cmd );
717 if (
$status->isOK() && $fileOpHandle->chmodPath ) {
718 $this->
chmod( $fileOpHandle->chmodPath );
755 return "Deny from all\n";
765 return $this->isWindows ? strtr(
$path,
'/',
'\\' ) :
$path;
772 $this->hadWarningErrors[] =
false;
773 set_error_handler( [ $this,
'handleWarning' ], E_WARNING );
782 restore_error_handler();
783 return array_pop( $this->hadWarningErrors );
793 $this->logger->error( $errstr );
794 $this->hadWarningErrors[count( $this->hadWarningErrors ) - 1] =
true;
851 if (
$path ===
false ) {
854 $this->suffixStart = strlen(
$path ) + 1;
859 }
catch ( UnexpectedValueException
$e ) {
871 if ( !empty( $this->params[
'topOnly'] ) ) {
872 # Get an iterator that will get direct sub-nodes
873 return new DirectoryIterator(
$dir );
875 # Get an iterator that will return leaf nodes (non-directories)
876 # RecursiveDirectoryIterator extends FilesystemIterator.
877 # FilesystemIterator::SKIP_DOTS default is inconsistent in PHP 5.3.x.
878 $flags = FilesystemIterator::CURRENT_AS_SELF | FilesystemIterator::SKIP_DOTS;
880 return new RecursiveIteratorIterator(
881 new RecursiveDirectoryIterator(
$dir,
$flags ),
882 RecursiveIteratorIterator::CHILD_FIRST
900 return $this->
getRelPath( $this->iter->current()->getPathname() );
911 }
catch ( UnexpectedValueException
$e ) {
912 throw new FileBackendError(
"File iterator gave UnexpectedValueException." );
924 $this->iter->rewind();
926 }
catch ( UnexpectedValueException
$e ) {
927 throw new FileBackendError(
"File iterator gave UnexpectedValueException." );
936 return $this->iter && $this->iter->valid();
954 if (
$path ===
false ) {
958 return strtr( substr(
$path, $this->suffixStart ),
'\\',
'/' );
964 while ( $this->iter->valid() ) {
965 if ( $this->iter->current()->isDot() || !$this->iter->current()->isDir() ) {
976 while ( $this->iter->valid() ) {
977 if ( !$this->iter->current()->isFile() ) {
Library for creating, parsing, and converting timestamps.
filterViaNext()
Filter out items by advancing to the next ones.
filterViaNext()
Filter out items by advancing to the next ones.
Wrapper around RecursiveDirectoryIterator/DirectoryIterator that catches exception or does any custom...
getRelPath( $dir)
Return only the relative path and normalize slashes to FileBackend-style.
__construct( $dir, array $params)
filterViaNext()
Filter out items by advancing to the next ones.
initIterator( $dir)
Return an appropriate iterator object to wrap.
Class for a file system (FS) based file backend.
doCopyInternal(array $params)
string $basePath
Directory holding the container directories.
doDirectoryExists( $fullCont, $dirRel, array $params)
__construct(array $config)
getDirectoryListInternal( $fullCont, $dirRel, array $params)
doDeleteInternal(array $params)
indexHtmlPrivate()
Return the text of an index.html file to hide directory listings.
chmod( $path)
Chmod a file, suppressing the warnings.
doExecuteOpHandlesInternal(array $fileOpHandles)
resolveToFSPath( $storagePath)
Get the absolute file system path for a storage path.
doGetFileStat(array $params)
htaccessPrivate()
Return the text of a .htaccess file to make a directory private.
doGetLocalCopyMulti(array $params)
isLegalRelPath( $path)
Sanity check a relative file system path for validity.
untrapWarnings()
Stop listening for E_WARNING errors and return true if any happened.
string $fileOwner
Required OS username to own files.
cleanPathSlashes( $path)
Clean up directory separators for the given OS.
doPublishInternal( $fullCont, $dirRel, array $params)
resolveContainerPath( $container, $relStoragePath)
Resolve a relative storage path, checking if it's allowed by the backend.
array $containerPaths
Map of container names to root paths for custom container paths.
doCleanInternal( $fullCont, $dirRel, array $params)
directoriesAreVirtual()
Is this a key/value store where directories are just virtual? Virtual directories exists in so much a...
doSecureInternal( $fullCont, $dirRel, array $params)
doMoveInternal(array $params)
doClearCache(array $paths=null)
Clears any additional stat caches for storage paths.
doStoreInternal(array $params)
doPrepareInternal( $fullCont, $dirRel, array $params)
getFeatures()
Get the a bitfield of extra features supported by the backend medium.
containerFSRoot( $shortCont, $fullCont)
Given the short (unresolved) and full (resolved) name of a container, return the file system path of ...
int $fileMode
File permission mode.
isPathUsableInternal( $storagePath)
Check if a file can be created or changed at a given storage path.
doCreateInternal(array $params)
trapWarnings()
Listen for E_WARNING errors and track whether any happen.
doGetLocalReferenceMulti(array $params)
string $currentUser
OS username running this script.
handleWarning( $errno, $errstr)
int $dirMode
File permission mode.
getFileListInternal( $fullCont, $dirRel, array $params)
__construct(FSFileBackend $backend, array $params, $call, $cmd, $chmodPath=null)
Class representing a non-directory file on the file system.
File backend exception for checked exceptions (e.g.
FileBackendStore helper class for performing asynchronous file operations.
FileBackendStore $backend
Base class for all backends using particular storage medium.
resolveStoragePathReal( $storagePath)
Like resolveStoragePath() except null values are returned if the container is sharded and the shard c...
static splitStoragePath( $storagePath)
Split a storage path into a backend name, a container name, and a relative file path.
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
newStatus()
Yields the result of the status wrapper callback on either:
Generic operation result class Has warning/error list, boolean status and arbitrary value.
static factory( $prefix, $extension='', $tmpDirectory=null)
Make a new temporary file on the file system.
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
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
the array() calling protocol came about after MediaWiki 1.4rc1.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
returning false will NOT prevent logging $e
if(count( $args)==0) $dir
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
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)