3 * @defgroup FileRepo File Repository
5 * @brief This module handles how MediaWiki interacts with filesystems.
10 use MediaWiki\MediaWikiServices
;
13 * Base code for file repositories.
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License along
26 * with this program; if not, write to the Free Software Foundation, Inc.,
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 * http://www.gnu.org/copyleft/gpl.html
35 * Base class for file repositories
40 const DELETE_SOURCE
= 1;
42 const OVERWRITE_SAME
= 4;
43 const SKIP_LOCKING
= 8;
45 const NAME_AND_TIME_ONLY
= 1;
47 /** @var bool Whether to fetch commons image description pages and display
48 * them on the local wiki */
49 public $fetchDescription;
52 public $descriptionCacheExpiry;
55 protected $hasSha1Storage = false;
58 protected $supportsSha1URLs = false;
60 /** @var FileBackend */
63 /** @var array Map of zones to config */
64 protected $zones = [];
66 /** @var string URL of thumb.php */
67 protected $thumbScriptUrl;
69 /** @var bool Whether to skip media file transformation on parse and rely
70 * on a 404 handler instead. */
71 protected $transformVia404;
73 /** @var string URL of image description pages, e.g.
74 * https://en.wikipedia.org/wiki/File:
76 protected $descBaseUrl;
78 /** @var string URL of the MediaWiki installation, equivalent to
79 * $wgScriptPath, e.g. https://en.wikipedia.org/w
81 protected $scriptDirUrl;
83 /** @var string Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1 */
84 protected $articleUrl;
86 /** @var bool Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
87 * determines whether filenames implicitly start with a capital letter.
88 * The current implementation may give incorrect description page links
89 * when the local $wgCapitalLinks and initialCapital are mismatched.
91 protected $initialCapital;
93 /** @var string May be 'paranoid' to remove all parameters from error
94 * messages, 'none' to leave the paths in unchanged, or 'simple' to
95 * replace paths with placeholders. Default for LocalRepo is
98 protected $pathDisclosureProtection = 'simple';
100 /** @var string|false Public zone URL. */
103 /** @var string The base thumbnail URL. Defaults to "<url>/thumb". */
106 /** @var int The number of directory levels for hash-based division of files */
107 protected $hashLevels;
109 /** @var int The number of directory levels for hash-based division of deleted files */
110 protected $deletedHashLevels;
112 /** @var int File names over this size will use the short form of thumbnail
113 * names. Short thumbnail names only have the width, parameters, and the
116 protected $abbrvThreshold;
118 /** @var string The URL of the repo's favicon, if any */
121 /** @var bool Whether all zones should be private (e.g. private wiki repo) */
122 protected $isPrivate;
124 /** @var array callable Override these in the base class */
125 protected $fileFactory = [ UnregisteredLocalFile
::class, 'newFromTitle' ];
126 /** @var array callable|bool Override these in the base class */
127 protected $oldFileFactory = false;
128 /** @var array callable|bool Override these in the base class */
129 protected $fileFactoryKey = false;
130 /** @var array callable|bool Override these in the base class */
131 protected $oldFileFactoryKey = false;
133 /** @var string URL of where to proxy thumb.php requests to.
134 * Example: http://127.0.0.1:8888/wiki/dev/thumb/
136 protected $thumbProxyUrl;
137 /** @var string Secret key to pass as an X-Swift-Secret header to the proxied thumb service */
138 protected $thumbProxySecret;
140 /** @var WANObjectCache */
144 * @param array|null $info
145 * @throws MWException
147 public function __construct( array $info = null ) {
148 // Verify required settings presence
151 ||
!array_key_exists( 'name', $info )
152 ||
!array_key_exists( 'backend', $info )
154 throw new MWException( __CLASS__
.
155 " requires an array of options having both 'name' and 'backend' keys.\n" );
159 $this->name
= $info['name'];
160 if ( $info['backend'] instanceof FileBackend
) {
161 $this->backend
= $info['backend']; // useful for testing
163 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
166 // Optional settings that can have no value
167 $optionalSettings = [
168 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
169 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
170 'favicon', 'thumbProxyUrl', 'thumbProxySecret',
172 foreach ( $optionalSettings as $var ) {
173 if ( isset( $info[$var] ) ) {
174 $this->$var = $info[$var];
178 // Optional settings that have a default
179 $this->initialCapital
= $info['initialCapital'] ?? MWNamespace
::isCapitalized( NS_FILE
);
180 $this->url
= $info['url'] ??
false; // a subclass may set the URL (e.g. ForeignAPIRepo)
181 if ( isset( $info['thumbUrl'] ) ) {
182 $this->thumbUrl
= $info['thumbUrl'];
184 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
186 $this->hashLevels
= $info['hashLevels'] ??
2;
187 $this->deletedHashLevels
= $info['deletedHashLevels'] ??
$this->hashLevels
;
188 $this->transformVia404
= !empty( $info['transformVia404'] );
189 $this->abbrvThreshold
= $info['abbrvThreshold'] ??
255;
190 $this->isPrivate
= !empty( $info['isPrivate'] );
191 // Give defaults for the basic zones...
192 $this->zones
= $info['zones'] ??
[];
193 foreach ( [ 'public', 'thumb', 'transcoded', 'temp', 'deleted' ] as $zone ) {
194 if ( !isset( $this->zones
[$zone]['container'] ) ) {
195 $this->zones
[$zone]['container'] = "{$this->name}-{$zone}";
197 if ( !isset( $this->zones
[$zone]['directory'] ) ) {
198 $this->zones
[$zone]['directory'] = '';
200 if ( !isset( $this->zones
[$zone]['urlsByExt'] ) ) {
201 $this->zones
[$zone]['urlsByExt'] = [];
205 $this->supportsSha1URLs
= !empty( $info['supportsSha1URLs'] );
207 $this->wanCache
= $info['wanCache'] ?? WANObjectCache
::newEmpty();
211 * Get the file backend instance. Use this function wisely.
213 * @return FileBackend
215 public function getBackend() {
216 return $this->backend
;
220 * Get an explanatory message if this repo is read-only.
221 * This checks if an administrator disabled writes to the backend.
223 * @return string|bool Returns false if the repo is not read-only
225 public function getReadOnlyReason() {
226 return $this->backend
->getReadOnlyReason();
230 * Check if a single zone or list of zones is defined for usage
232 * @param array $doZones Only do a particular zones
233 * @throws MWException
236 protected function initZones( $doZones = [] ) {
237 $status = $this->newGood();
238 foreach ( (array)$doZones as $zone ) {
239 $root = $this->getZonePath( $zone );
240 if ( $root === null ) {
241 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
249 * Determine if a string is an mwrepo:// URL
254 public static function isVirtualUrl( $url ) {
255 return substr( $url, 0, 9 ) == 'mwrepo://';
259 * Get a URL referring to this repository, with the private mwrepo protocol.
260 * The suffix, if supplied, is considered to be unencoded, and will be
261 * URL-encoded before being returned.
263 * @param string|bool $suffix
266 public function getVirtualUrl( $suffix = false ) {
267 $path = 'mwrepo://' . $this->name
;
268 if ( $suffix !== false ) {
269 $path .= '/' . rawurlencode( $suffix );
276 * Get the URL corresponding to one of the four basic zones
278 * @param string $zone One of: public, deleted, temp, thumb
279 * @param string|null $ext Optional file extension
280 * @return string|bool
282 public function getZoneUrl( $zone, $ext = null ) {
283 if ( in_array( $zone, [ 'public', 'thumb', 'transcoded' ] ) ) {
284 // standard public zones
285 if ( $ext !== null && isset( $this->zones
[$zone]['urlsByExt'][$ext] ) ) {
286 // custom URL for extension/zone
287 return $this->zones
[$zone]['urlsByExt'][$ext];
288 } elseif ( isset( $this->zones
[$zone]['url'] ) ) {
289 // custom URL for zone
290 return $this->zones
[$zone]['url'];
298 return false; // no public URL
300 return $this->thumbUrl
;
302 return "{$this->url}/transcoded";
309 * @return bool Whether non-ASCII path characters are allowed
311 public function backendSupportsUnicodePaths() {
312 return (bool)( $this->getBackend()->getFeatures() & FileBackend
::ATTR_UNICODE_PATHS
);
316 * Get the backend storage path corresponding to a virtual URL.
317 * Use this function wisely.
320 * @throws MWException
323 public function resolveVirtualUrl( $url ) {
324 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
325 throw new MWException( __METHOD__
. ': unknown protocol' );
327 $bits = explode( '/', substr( $url, 9 ), 3 );
328 if ( count( $bits ) != 3 ) {
329 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
331 list( $repo, $zone, $rel ) = $bits;
332 if ( $repo !== $this->name
) {
333 throw new MWException( __METHOD__
. ": fetching from a foreign repo is not supported" );
335 $base = $this->getZonePath( $zone );
337 throw new MWException( __METHOD__
. ": invalid zone: $zone" );
340 return $base . '/' . rawurldecode( $rel );
344 * The the storage container and base path of a zone
346 * @param string $zone
347 * @return array (container, base path) or (null, null)
349 protected function getZoneLocation( $zone ) {
350 if ( !isset( $this->zones
[$zone] ) ) {
351 return [ null, null ]; // bogus
354 return [ $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] ];
358 * Get the storage path corresponding to one of the zones
360 * @param string $zone
361 * @return string|null Returns null if the zone is not defined
363 public function getZonePath( $zone ) {
364 list( $container, $base ) = $this->getZoneLocation( $zone );
365 if ( $container === null ||
$base === null ) {
368 $backendName = $this->backend
->getName();
369 if ( $base != '' ) { // may not be set
373 return "mwstore://$backendName/{$container}{$base}";
377 * Create a new File object from the local repository
379 * @param Title|string $title Title object or string
380 * @param bool|string $time Time at which the image was uploaded. If this
381 * is specified, the returned object will be an instance of the
382 * repository's old file class instead of a current file. Repositories
383 * not supporting version control should return false if this parameter
385 * @return File|null A File, or null if passed an invalid Title
387 public function newFile( $title, $time = false ) {
388 $title = File
::normalizeTitle( $title );
393 if ( $this->oldFileFactory
) {
394 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
399 return call_user_func( $this->fileFactory
, $title, $this );
404 * Find an instance of the named file created at the specified time
405 * Returns false if the file does not exist. Repositories not supporting
406 * version control should return false if the time is specified.
408 * @param Title|string $title Title object or string
409 * @param array $options Associative array of options:
410 * time: requested time for a specific file version, or false for the
411 * current version. An image object will be returned which was
412 * created at the specified time (which may be archived or current).
413 * ignoreRedirect: If true, do not follow file redirects
414 * private: If true, return restricted (deleted) files if the current
415 * user is allowed to view them. Otherwise, such files will not
416 * be found. If a User object, use that user instead of the current.
417 * latest: If true, load from the latest available data into File objects
418 * @return File|bool False on failure
420 public function findFile( $title, $options = [] ) {
421 $title = File
::normalizeTitle( $title );
425 if ( isset( $options['bypassCache'] ) ) {
426 $options['latest'] = $options['bypassCache']; // b/c
428 $time = $options['time'] ??
false;
429 $flags = !empty( $options['latest'] ) ? File
::READ_LATEST
: 0;
430 # First try the current version of the file to see if it precedes the timestamp
431 $img = $this->newFile( $title );
435 $img->load( $flags );
436 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
439 # Now try an old version of the file
440 if ( $time !== false ) {
441 $img = $this->newFile( $title, $time );
443 $img->load( $flags );
444 if ( $img->exists() ) {
445 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
446 return $img; // always OK
447 } elseif ( !empty( $options['private'] ) &&
448 $img->userCan( File
::DELETED_FILE
,
449 $options['private'] instanceof User ?
$options['private'] : null
459 if ( !empty( $options['ignoreRedirect'] ) ) {
462 $redir = $this->checkRedirect( $title );
463 if ( $redir && $title->getNamespace() == NS_FILE
) {
464 $img = $this->newFile( $redir );
468 $img->load( $flags );
469 if ( $img->exists() ) {
470 $img->redirectedFrom( $title->getDBkey() );
480 * Find many files at once.
482 * @param array $items An array of titles, or an array of findFile() options with
483 * the "title" option giving the title. Example:
485 * $findItem = [ 'title' => $title, 'private' => true ];
486 * $findBatch = [ $findItem ];
487 * $repo->findFiles( $findBatch );
489 * No title should appear in $items twice, as the result use titles as keys
490 * @param int $flags Supports:
491 * - FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map.
492 * The search title uses the input titles; the other is the final post-redirect title.
493 * All titles are returned as string DB keys and the inner array is associative.
494 * @return array Map of (file name => File objects) for matches
496 public function findFiles( array $items, $flags = 0 ) {
498 foreach ( $items as $item ) {
499 if ( is_array( $item ) ) {
500 $title = $item['title'];
502 unset( $options['title'] );
507 $file = $this->findFile( $title, $options );
509 $searchName = File
::normalizeTitle( $title )->getDBkey(); // must be valid
510 if ( $flags & self
::NAME_AND_TIME_ONLY
) {
511 $result[$searchName] = [
512 'title' => $file->getTitle()->getDBkey(),
513 'timestamp' => $file->getTimestamp()
516 $result[$searchName] = $file;
525 * Find an instance of the file with this key, created at the specified time
526 * Returns false if the file does not exist. Repositories not supporting
527 * version control should return false if the time is specified.
529 * @param string $sha1 Base 36 SHA-1 hash
530 * @param array $options Option array, same as findFile().
531 * @return File|bool False on failure
533 public function findFileFromKey( $sha1, $options = [] ) {
534 $time = $options['time'] ??
false;
535 # First try to find a matching current version of a file...
536 if ( !$this->fileFactoryKey
) {
537 return false; // find-by-sha1 not supported
539 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
540 if ( $img && $img->exists() ) {
543 # Now try to find a matching old version of a file...
544 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
545 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
546 if ( $img && $img->exists() ) {
547 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
548 return $img; // always OK
549 } elseif ( !empty( $options['private'] ) &&
550 $img->userCan( File
::DELETED_FILE
,
551 $options['private'] instanceof User ?
$options['private'] : null
563 * Get an array or iterator of file objects for files that have a given
564 * SHA-1 content hash.
567 * @param string $hash SHA-1 hash
570 public function findBySha1( $hash ) {
575 * Get an array of arrays or iterators of file objects for files that
576 * have the given SHA-1 content hashes.
578 * @param string[] $hashes An array of hashes
579 * @return array[] An Array of arrays or iterators of file objects and the hash as key
581 public function findBySha1s( array $hashes ) {
583 foreach ( $hashes as $hash ) {
584 $files = $this->findBySha1( $hash );
585 if ( count( $files ) ) {
586 $result[$hash] = $files;
594 * Return an array of files where the name starts with $prefix.
597 * @param string $prefix The prefix to search for
598 * @param int $limit The maximum amount of files to return
599 * @return LocalFile[]
601 public function findFilesByPrefix( $prefix, $limit ) {
606 * Get the URL of thumb.php
610 public function getThumbScriptUrl() {
611 return $this->thumbScriptUrl
;
615 * Get the URL thumb.php requests are being proxied to
619 public function getThumbProxyUrl() {
620 return $this->thumbProxyUrl
;
624 * Get the secret key for the proxied thumb service
628 public function getThumbProxySecret() {
629 return $this->thumbProxySecret
;
633 * Returns true if the repository can transform files via a 404 handler
637 public function canTransformVia404() {
638 return $this->transformVia404
;
642 * Get the name of a file from its title object
644 * @param Title $title
647 public function getNameFromTitle( Title
$title ) {
648 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
649 $name = $title->getUserCaseDBKey();
650 if ( $this->initialCapital
) {
651 $name = MediaWikiServices
::getInstance()->getContentLanguage()->ucfirst( $name );
654 $name = $title->getDBkey();
661 * Get the public zone root storage directory of the repository
665 public function getRootDirectory() {
666 return $this->getZonePath( 'public' );
670 * Get a relative path including trailing slash, e.g. f/fa/
671 * If the repo is not hashed, returns an empty string
673 * @param string $name Name of file
676 public function getHashPath( $name ) {
677 return self
::getHashPathForLevel( $name, $this->hashLevels
);
681 * Get a relative path including trailing slash, e.g. f/fa/
682 * If the repo is not hashed, returns an empty string
684 * @param string $suffix Basename of file from FileRepo::storeTemp()
687 public function getTempHashPath( $suffix ) {
688 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
689 $name = $parts[1] ??
$suffix; // hash path is not based on timestamp
690 return self
::getHashPathForLevel( $name, $this->hashLevels
);
694 * @param string $name
698 protected static function getHashPathForLevel( $name, $levels ) {
699 if ( $levels == 0 ) {
702 $hash = md5( $name );
704 for ( $i = 1; $i <= $levels; $i++
) {
705 $path .= substr( $hash, 0, $i ) . '/';
713 * Get the number of hash directory levels
717 public function getHashLevels() {
718 return $this->hashLevels
;
722 * Get the name of this repository, as specified by $info['name]' to the constructor
726 public function getName() {
731 * Make an url to this repo
733 * @param string $query Query string to append
734 * @param string $entry Entry point; defaults to index
735 * @return string|bool False on failure
737 public function makeUrl( $query = '', $entry = 'index' ) {
738 if ( isset( $this->scriptDirUrl
) ) {
739 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}.php", $query );
746 * Get the URL of an image description page. May return false if it is
747 * unknown or not applicable. In general this should only be called by the
748 * File class, since it may return invalid results for certain kinds of
749 * repositories. Use File::getDescriptionUrl() in user code.
751 * In particular, it uses the article paths as specified to the repository
752 * constructor, whereas local repositories use the local Title functions.
754 * @param string $name
755 * @return string|false
757 public function getDescriptionUrl( $name ) {
758 $encName = wfUrlencode( $name );
759 if ( !is_null( $this->descBaseUrl
) ) {
760 # "http://example.com/wiki/File:"
761 return $this->descBaseUrl
. $encName;
763 if ( !is_null( $this->articleUrl
) ) {
764 # "http://example.com/wiki/$1"
765 # We use "Image:" as the canonical namespace for
766 # compatibility across all MediaWiki versions.
767 return str_replace( '$1',
768 "Image:$encName", $this->articleUrl
);
770 if ( !is_null( $this->scriptDirUrl
) ) {
771 # "http://example.com/w"
772 # We use "Image:" as the canonical namespace for
773 # compatibility across all MediaWiki versions,
774 # and just sort of hope index.php is right. ;)
775 return $this->makeUrl( "title=Image:$encName" );
782 * Get the URL of the content-only fragment of the description page. For
783 * MediaWiki this means action=render. This should only be called by the
784 * repository's file class, since it may return invalid results. User code
785 * should use File::getDescriptionText().
787 * @param string $name Name of image to fetch
788 * @param string|null $lang Language to fetch it in, if any.
789 * @return string|false
791 public function getDescriptionRenderUrl( $name, $lang = null ) {
792 $query = 'action=render';
793 if ( !is_null( $lang ) ) {
794 $query .= '&uselang=' . urlencode( $lang );
796 if ( isset( $this->scriptDirUrl
) ) {
797 return $this->makeUrl(
799 wfUrlencode( 'Image:' . $name ) .
802 $descUrl = $this->getDescriptionUrl( $name );
804 return wfAppendQuery( $descUrl, $query );
812 * Get the URL of the stylesheet to apply to description pages
814 * @return string|bool False on failure
816 public function getDescriptionStylesheetUrl() {
817 if ( isset( $this->scriptDirUrl
) ) {
818 // Must match canonical query parameter order for optimum caching
819 // See Title::getCdnUrls
820 return $this->makeUrl( 'title=MediaWiki:Filepage.css&action=raw&ctype=text/css' );
827 * Store a file to a given destination.
829 * @param string $srcPath Source file system path, storage path, or virtual URL
830 * @param string $dstZone Destination zone
831 * @param string $dstRel Destination relative path
832 * @param int $flags Bitwise combination of the following flags:
833 * self::OVERWRITE Overwrite an existing destination file instead of failing
834 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
835 * same contents as the source
836 * self::SKIP_LOCKING Skip any file locking when doing the store
839 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
840 $this->assertWritableRepo(); // fail out if read-only
842 $status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
843 if ( $status->successCount
== 0 ) {
844 $status->setOK( false );
851 * Store a batch of files
853 * @param array $triplets (src, dest zone, dest rel) triplets as per store()
854 * @param int $flags Bitwise combination of the following flags:
855 * self::OVERWRITE Overwrite an existing destination file instead of failing
856 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
857 * same contents as the source
858 * self::SKIP_LOCKING Skip any file locking when doing the store
859 * @throws MWException
862 public function storeBatch( array $triplets, $flags = 0 ) {
863 $this->assertWritableRepo(); // fail out if read-only
865 if ( $flags & self
::DELETE_SOURCE
) {
866 throw new InvalidArgumentException( "DELETE_SOURCE not supported in " . __METHOD__
);
869 $status = $this->newGood();
870 $backend = $this->backend
; // convenience
873 // Validate each triplet and get the store operation...
874 foreach ( $triplets as $triplet ) {
875 list( $srcPath, $dstZone, $dstRel ) = $triplet;
877 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
880 // Resolve destination path
881 $root = $this->getZonePath( $dstZone );
883 throw new MWException( "Invalid zone: $dstZone" );
885 if ( !$this->validateFilename( $dstRel ) ) {
886 throw new MWException( 'Validation error in $dstRel' );
888 $dstPath = "$root/$dstRel";
889 $dstDir = dirname( $dstPath );
890 // Create destination directories for this triplet
891 if ( !$this->initDirectory( $dstDir )->isOK() ) {
892 return $this->newFatal( 'directorycreateerror', $dstDir );
895 // Resolve source to a storage path if virtual
896 $srcPath = $this->resolveToStoragePath( $srcPath );
898 // Get the appropriate file operation
899 if ( FileBackend
::isStoragePath( $srcPath ) ) {
908 'overwrite' => $flags & self
::OVERWRITE
,
909 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
913 // Execute the store operation for each triplet
914 $opts = [ 'force' => true ];
915 if ( $flags & self
::SKIP_LOCKING
) {
916 $opts['nonLocking'] = true;
918 $status->merge( $backend->doOperations( $operations, $opts ) );
924 * Deletes a batch of files.
925 * Each file can be a (zone, rel) pair, virtual url, storage path.
926 * It will try to delete each file, but ignores any errors that may occur.
928 * @param string[] $files List of files to delete
929 * @param int $flags Bitwise combination of the following flags:
930 * self::SKIP_LOCKING Skip any file locking when doing the deletions
933 public function cleanupBatch( array $files, $flags = 0 ) {
934 $this->assertWritableRepo(); // fail out if read-only
936 $status = $this->newGood();
939 foreach ( $files as $path ) {
940 if ( is_array( $path ) ) {
941 // This is a pair, extract it
942 list( $zone, $rel ) = $path;
943 $path = $this->getZonePath( $zone ) . "/$rel";
945 // Resolve source to a storage path if virtual
946 $path = $this->resolveToStoragePath( $path );
948 $operations[] = [ 'op' => 'delete', 'src' => $path ];
950 // Actually delete files from storage...
951 $opts = [ 'force' => true ];
952 if ( $flags & self
::SKIP_LOCKING
) {
953 $opts['nonLocking'] = true;
955 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
961 * Import a file from the local file system into the repo.
962 * This does no locking nor journaling and overrides existing files.
963 * This function can be used to write to otherwise read-only foreign repos.
964 * This is intended for copying generated thumbnails into the repo.
966 * @param string|FSFile $src Source file system path, storage path, or virtual URL
967 * @param string $dst Virtual URL or storage path
968 * @param array|string|null $options An array consisting of a key named headers
969 * listing extra headers. If a string, taken as content-disposition header.
970 * (Support for array of options new in 1.23)
973 final public function quickImport( $src, $dst, $options = null ) {
974 return $this->quickImportBatch( [ [ $src, $dst, $options ] ] );
978 * Purge a file from the repo. This does no locking nor journaling.
979 * This function can be used to write to otherwise read-only foreign repos.
980 * This is intended for purging thumbnails.
982 * @param string $path Virtual URL or storage path
985 final public function quickPurge( $path ) {
986 return $this->quickPurgeBatch( [ $path ] );
990 * Deletes a directory if empty.
991 * This function can be used to write to otherwise read-only foreign repos.
993 * @param string $dir Virtual URL (or storage path) of directory to clean
996 public function quickCleanDir( $dir ) {
997 $status = $this->newGood();
998 $status->merge( $this->backend
->clean(
999 [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1005 * Import a batch of files from the local file system into the repo.
1006 * This does no locking nor journaling and overrides existing files.
1007 * This function can be used to write to otherwise read-only foreign repos.
1008 * This is intended for copying generated thumbnails into the repo.
1010 * All path parameters may be a file system path, storage path, or virtual URL.
1011 * When "headers" are given they are used as HTTP headers if supported.
1013 * @param array $triples List of (source path or FSFile, destination path, disposition)
1016 public function quickImportBatch( array $triples ) {
1017 $status = $this->newGood();
1019 foreach ( $triples as $triple ) {
1020 list( $src, $dst ) = $triple;
1021 if ( $src instanceof FSFile
) {
1024 $src = $this->resolveToStoragePath( $src );
1025 $op = FileBackend
::isStoragePath( $src ) ?
'copy' : 'store';
1027 $dst = $this->resolveToStoragePath( $dst );
1029 if ( !isset( $triple[2] ) ) {
1031 } elseif ( is_string( $triple[2] ) ) {
1033 $headers = [ 'Content-Disposition' => $triple[2] ];
1034 } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1035 $headers = $triple[2]['headers'];
1044 'headers' => $headers
1046 $status->merge( $this->initDirectory( dirname( $dst ) ) );
1048 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1054 * Purge a batch of files from the repo.
1055 * This function can be used to write to otherwise read-only foreign repos.
1056 * This does no locking nor journaling and is intended for purging thumbnails.
1058 * @param array $paths List of virtual URLs or storage paths
1061 public function quickPurgeBatch( array $paths ) {
1062 $status = $this->newGood();
1064 foreach ( $paths as $path ) {
1067 'src' => $this->resolveToStoragePath( $path ),
1068 'ignoreMissingSource' => true
1071 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1077 * Pick a random name in the temp zone and store a file to it.
1078 * Returns a Status object with the file Virtual URL in the value,
1079 * file can later be disposed using FileRepo::freeTemp().
1081 * @param string $originalName The base name of the file as specified
1082 * by the user. The file extension will be maintained.
1083 * @param string $srcPath The current location of the file.
1084 * @return Status Object with the URL in the value.
1086 public function storeTemp( $originalName, $srcPath ) {
1087 $this->assertWritableRepo(); // fail out if read-only
1089 $date = MWTimestamp
::getInstance()->format( 'YmdHis' );
1090 $hashPath = $this->getHashPath( $originalName );
1091 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1092 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1094 $result = $this->quickImport( $srcPath, $virtualUrl );
1095 $result->value
= $virtualUrl;
1101 * Remove a temporary file or mark it for garbage collection
1103 * @param string $virtualUrl The virtual URL returned by FileRepo::storeTemp()
1104 * @return bool True on success, false on failure
1106 public function freeTemp( $virtualUrl ) {
1107 $this->assertWritableRepo(); // fail out if read-only
1109 $temp = $this->getVirtualUrl( 'temp' );
1110 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1111 wfDebug( __METHOD__
. ": Invalid temp virtual URL\n" );
1116 return $this->quickPurge( $virtualUrl )->isOK();
1120 * Concatenate a list of temporary files into a target file location.
1122 * @param array $srcPaths Ordered list of source virtual URLs/storage paths
1123 * @param string $dstPath Target file system path
1124 * @param int $flags Bitwise combination of the following flags:
1125 * self::DELETE_SOURCE Delete the source files on success
1128 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1129 $this->assertWritableRepo(); // fail out if read-only
1131 $status = $this->newGood();
1134 foreach ( $srcPaths as $srcPath ) {
1135 // Resolve source to a storage path if virtual
1136 $source = $this->resolveToStoragePath( $srcPath );
1137 $sources[] = $source; // chunk to merge
1140 // Concatenate the chunks into one FS file
1141 $params = [ 'srcs' => $sources, 'dst' => $dstPath ];
1142 $status->merge( $this->backend
->concatenate( $params ) );
1143 if ( !$status->isOK() ) {
1147 // Delete the sources if required
1148 if ( $flags & self
::DELETE_SOURCE
) {
1149 $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1152 // Make sure status is OK, despite any quickPurgeBatch() fatals
1153 $status->setResult( true );
1159 * Copy or move a file either from a storage path, virtual URL,
1160 * or file system path, into this repository at the specified destination location.
1162 * Returns a Status object. On success, the value contains "new" or
1163 * "archived", to indicate whether the file was new with that name.
1165 * Options to $options include:
1166 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1168 * @param string|FSFile $src The source file system path, storage path, or URL
1169 * @param string $dstRel The destination relative path
1170 * @param string $archiveRel The relative path where the existing file is to
1171 * be archived, if there is one. Relative to the public zone root.
1172 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1173 * that the source file should be deleted if possible
1174 * @param array $options Optional additional parameters
1177 public function publish(
1178 $src, $dstRel, $archiveRel, $flags = 0, array $options = []
1180 $this->assertWritableRepo(); // fail out if read-only
1182 $status = $this->publishBatch(
1183 [ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
1184 if ( $status->successCount
== 0 ) {
1185 $status->setOK( false );
1187 $status->value
= $status->value
[0] ??
false;
1193 * Publish a batch of files
1195 * @param array $ntuples (source, dest, archive) triplets or
1196 * (source, dest, archive, options) 4-tuples as per publish().
1197 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1198 * that the source files should be deleted if possible
1199 * @throws MWException
1202 public function publishBatch( array $ntuples, $flags = 0 ) {
1203 $this->assertWritableRepo(); // fail out if read-only
1205 $backend = $this->backend
; // convenience
1206 // Try creating directories
1207 $status = $this->initZones( 'public' );
1208 if ( !$status->isOK() ) {
1212 $status = $this->newGood( [] );
1215 $sourceFSFilesToDelete = []; // cleanup for disk source files
1216 // Validate each triplet and get the store operation...
1217 foreach ( $ntuples as $ntuple ) {
1218 list( $src, $dstRel, $archiveRel ) = $ntuple;
1219 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1221 $options = $ntuple[3] ??
[];
1222 // Resolve source to a storage path if virtual
1223 $srcPath = $this->resolveToStoragePath( $srcPath );
1224 if ( !$this->validateFilename( $dstRel ) ) {
1225 throw new MWException( 'Validation error in $dstRel' );
1227 if ( !$this->validateFilename( $archiveRel ) ) {
1228 throw new MWException( 'Validation error in $archiveRel' );
1231 $publicRoot = $this->getZonePath( 'public' );
1232 $dstPath = "$publicRoot/$dstRel";
1233 $archivePath = "$publicRoot/$archiveRel";
1235 $dstDir = dirname( $dstPath );
1236 $archiveDir = dirname( $archivePath );
1237 // Abort immediately on directory creation errors since they're likely to be repetitive
1238 if ( !$this->initDirectory( $dstDir )->isOK() ) {
1239 return $this->newFatal( 'directorycreateerror', $dstDir );
1241 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1242 return $this->newFatal( 'directorycreateerror', $archiveDir );
1245 // Set any desired headers to be use in GET/HEAD responses
1246 $headers = $options['headers'] ??
[];
1248 // Archive destination file if it exists.
1249 // This will check if the archive file also exists and fail if does.
1250 // This is a sanity check to avoid data loss. On Windows and Linux,
1251 // copy() will overwrite, so the existence check is vulnerable to
1252 // race conditions unless a functioning LockManager is used.
1253 // LocalFile also uses SELECT FOR UPDATE for synchronization.
1257 'dst' => $archivePath,
1258 'ignoreMissingSource' => true
1261 // Copy (or move) the source file to the destination
1262 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1263 if ( $flags & self
::DELETE_SOURCE
) {
1268 'overwrite' => true, // replace current
1269 'headers' => $headers
1276 'overwrite' => true, // replace current
1277 'headers' => $headers
1280 } else { // FS source path
1283 'src' => $src, // prefer FSFile objects
1285 'overwrite' => true, // replace current
1286 'headers' => $headers
1288 if ( $flags & self
::DELETE_SOURCE
) {
1289 $sourceFSFilesToDelete[] = $srcPath;
1294 // Execute the operations for each triplet
1295 $status->merge( $backend->doOperations( $operations ) );
1296 // Find out which files were archived...
1297 foreach ( $ntuples as $i => $ntuple ) {
1298 list( , , $archiveRel ) = $ntuple;
1299 $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1300 if ( $this->fileExists( $archivePath ) ) {
1301 $status->value
[$i] = 'archived';
1303 $status->value
[$i] = 'new';
1306 // Cleanup for disk source files...
1307 foreach ( $sourceFSFilesToDelete as $file ) {
1308 Wikimedia\
suppressWarnings();
1309 unlink( $file ); // FS cleanup
1310 Wikimedia\restoreWarnings
();
1317 * Creates a directory with the appropriate zone permissions.
1318 * Callers are responsible for doing read-only and "writable repo" checks.
1320 * @param string $dir Virtual URL (or storage path) of directory to clean
1323 protected function initDirectory( $dir ) {
1324 $path = $this->resolveToStoragePath( $dir );
1325 list( , $container, ) = FileBackend
::splitStoragePath( $path );
1327 $params = [ 'dir' => $path ];
1328 if ( $this->isPrivate
1329 ||
$container === $this->zones
['deleted']['container']
1330 ||
$container === $this->zones
['temp']['container']
1332 # Take all available measures to prevent web accessibility of new deleted
1333 # directories, in case the user has not configured offline storage
1334 $params = [ 'noAccess' => true, 'noListing' => true ] +
$params;
1337 $status = $this->newGood();
1338 $status->merge( $this->backend
->prepare( $params ) );
1344 * Deletes a directory if empty.
1346 * @param string $dir Virtual URL (or storage path) of directory to clean
1349 public function cleanDir( $dir ) {
1350 $this->assertWritableRepo(); // fail out if read-only
1352 $status = $this->newGood();
1353 $status->merge( $this->backend
->clean(
1354 [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1360 * Checks existence of a file
1362 * @param string $file Virtual URL (or storage path) of file to check
1365 public function fileExists( $file ) {
1366 $result = $this->fileExistsBatch( [ $file ] );
1372 * Checks existence of an array of files.
1374 * @param string[] $files Virtual URLs (or storage paths) of files to check
1375 * @return array Map of files and existence flags, or false
1377 public function fileExistsBatch( array $files ) {
1378 $paths = array_map( [ $this, 'resolveToStoragePath' ], $files );
1379 $this->backend
->preloadFileStat( [ 'srcs' => $paths ] );
1382 foreach ( $files as $key => $file ) {
1383 $path = $this->resolveToStoragePath( $file );
1384 $result[$key] = $this->backend
->fileExists( [ 'src' => $path ] );
1391 * Move a file to the deletion archive.
1392 * If no valid deletion archive exists, this may either delete the file
1393 * or throw an exception, depending on the preference of the repository
1395 * @param mixed $srcRel Relative path for the file to be deleted
1396 * @param mixed $archiveRel Relative path for the archive location.
1397 * Relative to a private archive directory.
1400 public function delete( $srcRel, $archiveRel ) {
1401 $this->assertWritableRepo(); // fail out if read-only
1403 return $this->deleteBatch( [ [ $srcRel, $archiveRel ] ] );
1407 * Move a group of files to the deletion archive.
1409 * If no valid deletion archive is configured, this may either delete the
1410 * file or throw an exception, depending on the preference of the repository.
1412 * The overwrite policy is determined by the repository -- currently LocalRepo
1413 * assumes a naming scheme in the deleted zone based on content hash, as
1414 * opposed to the public zone which is assumed to be unique.
1416 * @param array $sourceDestPairs Array of source/destination pairs. Each element
1417 * is a two-element array containing the source file path relative to the
1418 * public root in the first element, and the archive file path relative
1419 * to the deleted zone root in the second element.
1420 * @throws MWException
1423 public function deleteBatch( array $sourceDestPairs ) {
1424 $this->assertWritableRepo(); // fail out if read-only
1426 // Try creating directories
1427 $status = $this->initZones( [ 'public', 'deleted' ] );
1428 if ( !$status->isOK() ) {
1432 $status = $this->newGood();
1434 $backend = $this->backend
; // convenience
1436 // Validate filenames and create archive directories
1437 foreach ( $sourceDestPairs as $pair ) {
1438 list( $srcRel, $archiveRel ) = $pair;
1439 if ( !$this->validateFilename( $srcRel ) ) {
1440 throw new MWException( __METHOD__
. ':Validation error in $srcRel' );
1441 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1442 throw new MWException( __METHOD__
. ':Validation error in $archiveRel' );
1445 $publicRoot = $this->getZonePath( 'public' );
1446 $srcPath = "{$publicRoot}/$srcRel";
1448 $deletedRoot = $this->getZonePath( 'deleted' );
1449 $archivePath = "{$deletedRoot}/{$archiveRel}";
1450 $archiveDir = dirname( $archivePath ); // does not touch FS
1452 // Create destination directories
1453 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1454 return $this->newFatal( 'directorycreateerror', $archiveDir );
1460 'dst' => $archivePath,
1461 // We may have 2+ identical files being deleted,
1462 // all of which will map to the same destination file
1463 'overwriteSame' => true // also see T33792
1467 // Move the files by execute the operations for each pair.
1468 // We're now committed to returning an OK result, which will
1469 // lead to the files being moved in the DB also.
1470 $opts = [ 'force' => true ];
1471 $status->merge( $backend->doOperations( $operations, $opts ) );
1477 * Delete files in the deleted directory if they are not referenced in the filearchive table
1480 * @param string[] $storageKeys
1482 public function cleanupDeletedBatch( array $storageKeys ) {
1483 $this->assertWritableRepo();
1487 * Get a relative path for a deletion archive key,
1488 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1490 * @param string $key
1491 * @throws MWException
1494 public function getDeletedHashPath( $key ) {
1495 if ( strlen( $key ) < 31 ) {
1496 throw new MWException( "Invalid storage key '$key'." );
1499 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1500 $path .= $key[$i] . '/';
1507 * If a path is a virtual URL, resolve it to a storage path.
1508 * Otherwise, just return the path as it is.
1510 * @param string $path
1512 * @throws MWException
1514 protected function resolveToStoragePath( $path ) {
1515 if ( self
::isVirtualUrl( $path ) ) {
1516 return $this->resolveVirtualUrl( $path );
1523 * Get a local FS copy of a file with a given virtual URL/storage path.
1524 * Temporary files may be purged when the file object falls out of scope.
1526 * @param string $virtualUrl
1527 * @return TempFSFile|null Returns null on failure
1529 public function getLocalCopy( $virtualUrl ) {
1530 $path = $this->resolveToStoragePath( $virtualUrl );
1532 return $this->backend
->getLocalCopy( [ 'src' => $path ] );
1536 * Get a local FS file with a given virtual URL/storage path.
1537 * The file is either an original or a copy. It should not be changed.
1538 * Temporary files may be purged when the file object falls out of scope.
1540 * @param string $virtualUrl
1541 * @return FSFile|null Returns null on failure.
1543 public function getLocalReference( $virtualUrl ) {
1544 $path = $this->resolveToStoragePath( $virtualUrl );
1546 return $this->backend
->getLocalReference( [ 'src' => $path ] );
1550 * Get properties of a file with a given virtual URL/storage path.
1551 * Properties should ultimately be obtained via FSFile::getProps().
1553 * @param string $virtualUrl
1556 public function getFileProps( $virtualUrl ) {
1557 $fsFile = $this->getLocalReference( $virtualUrl );
1558 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices
::getInstance()->getMimeAnalyzer() );
1560 $props = $mwProps->getPropsFromPath( $fsFile->getPath(), true );
1562 $props = $mwProps->newPlaceholderProps();
1569 * Get the timestamp of a file with a given virtual URL/storage path
1571 * @param string $virtualUrl
1572 * @return string|bool False on failure
1574 public function getFileTimestamp( $virtualUrl ) {
1575 $path = $this->resolveToStoragePath( $virtualUrl );
1577 return $this->backend
->getFileTimestamp( [ 'src' => $path ] );
1581 * Get the size of a file with a given virtual URL/storage path
1583 * @param string $virtualUrl
1584 * @return int|bool False on failure
1586 public function getFileSize( $virtualUrl ) {
1587 $path = $this->resolveToStoragePath( $virtualUrl );
1589 return $this->backend
->getFileSize( [ 'src' => $path ] );
1593 * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1595 * @param string $virtualUrl
1596 * @return string|bool
1598 public function getFileSha1( $virtualUrl ) {
1599 $path = $this->resolveToStoragePath( $virtualUrl );
1601 return $this->backend
->getFileSha1Base36( [ 'src' => $path ] );
1605 * Attempt to stream a file with the given virtual URL/storage path
1607 * @param string $virtualUrl
1608 * @param array $headers Additional HTTP headers to send on success
1609 * @param array $optHeaders HTTP request headers (if-modified-since, range, ...)
1613 public function streamFileWithStatus( $virtualUrl, $headers = [], $optHeaders = [] ) {
1614 $path = $this->resolveToStoragePath( $virtualUrl );
1615 $params = [ 'src' => $path, 'headers' => $headers, 'options' => $optHeaders ];
1617 // T172851: HHVM does not flush the output properly, causing OOM
1618 ob_start( null, 1048576 );
1619 ob_implicit_flush( true );
1621 $status = $this->newGood();
1622 $status->merge( $this->backend
->streamFile( $params ) );
1624 // T186565: Close the buffer, unless it has already been closed
1625 // in HTTPFileStreamer::resetOutputBuffers().
1626 if ( ob_get_status() ) {
1634 * Attempt to stream a file with the given virtual URL/storage path
1636 * @deprecated since 1.26, use streamFileWithStatus
1637 * @param string $virtualUrl
1638 * @param array $headers Additional HTTP headers to send on success
1639 * @return bool Success
1641 public function streamFile( $virtualUrl, $headers = [] ) {
1642 return $this->streamFileWithStatus( $virtualUrl, $headers )->isOK();
1646 * Call a callback function for every public regular file in the repository.
1647 * This only acts on the current version of files, not any old versions.
1648 * May use either the database or the filesystem.
1650 * @param callable $callback
1653 public function enumFiles( $callback ) {
1654 $this->enumFilesInStorage( $callback );
1658 * Call a callback function for every public file in the repository.
1659 * May use either the database or the filesystem.
1661 * @param callable $callback
1664 protected function enumFilesInStorage( $callback ) {
1665 $publicRoot = $this->getZonePath( 'public' );
1666 $numDirs = 1 << ( $this->hashLevels
* 4 );
1667 // Use a priori assumptions about directory structure
1668 // to reduce the tree height of the scanning process.
1669 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1670 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1671 $path = $publicRoot;
1672 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1673 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1675 $iterator = $this->backend
->getFileList( [ 'dir' => $path ] );
1676 foreach ( $iterator as $name ) {
1677 // Each item returned is a public file
1678 call_user_func( $callback, "{$path}/{$name}" );
1684 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1686 * @param string $filename
1689 public function validateFilename( $filename ) {
1690 if ( strval( $filename ) == '' ) {
1694 return FileBackend
::isPathTraversalFree( $filename );
1698 * Get a callback function to use for cleaning error message parameters
1702 function getErrorCleanupFunction() {
1703 switch ( $this->pathDisclosureProtection
) {
1705 case 'simple': // b/c
1706 $callback = [ $this, 'passThrough' ];
1708 default: // 'paranoid'
1709 $callback = [ $this, 'paranoidClean' ];
1715 * Path disclosure protection function
1717 * @param string $param
1720 function paranoidClean( $param ) {
1725 * Path disclosure protection function
1727 * @param string $param
1730 function passThrough( $param ) {
1735 * Create a new fatal error
1737 * @param string $message
1740 public function newFatal( $message /*, parameters...*/ ) {
1741 $status = Status
::newFatal( ...func_get_args() );
1742 $status->cleanCallback
= $this->getErrorCleanupFunction();
1748 * Create a new good result
1750 * @param null|string $value
1753 public function newGood( $value = null ) {
1754 $status = Status
::newGood( $value );
1755 $status->cleanCallback
= $this->getErrorCleanupFunction();
1761 * Checks if there is a redirect named as $title. If there is, return the
1762 * title object. If not, return false.
1765 * @param Title $title Title of image
1768 public function checkRedirect( Title
$title ) {
1773 * Invalidates image redirect cache related to that image
1774 * Doesn't do anything for repositories that don't support image redirects.
1777 * @param Title $title Title of image
1779 public function invalidateImageRedirect( Title
$title ) {
1783 * Get the human-readable name of the repo
1787 public function getDisplayName() {
1790 if ( $this->isLocal() ) {
1794 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1795 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1799 * Get the portion of the file that contains the origin file name.
1800 * If that name is too long, then the name "thumbnail.<ext>" will be given.
1802 * @param string $name
1805 public function nameForThumb( $name ) {
1806 if ( strlen( $name ) > $this->abbrvThreshold
) {
1807 $ext = FileBackend
::extensionFromPath( $name );
1808 $name = ( $ext == '' ) ?
'thumbnail' : "thumbnail.$ext";
1815 * Returns true if this the local file repository.
1819 public function isLocal() {
1820 return $this->getName() == 'local';
1824 * Get a key on the primary cache for this repository.
1825 * Returns false if the repository's cache is not accessible at this site.
1826 * The parameters are the parts of the key.
1831 public function getSharedCacheKey( /*...*/ ) {
1836 * Get a key for this repo in the local cache domain. These cache keys are
1837 * not shared with remote instances of the repo.
1838 * The parameters are the parts of the key.
1842 public function getLocalCacheKey( /*...*/ ) {
1843 $args = func_get_args();
1844 array_unshift( $args, 'filerepo', $this->getName() );
1846 return $this->wanCache
->makeKey( ...$args );
1850 * Get a temporary private FileRepo associated with this repo.
1852 * Files will be created in the temp zone of this repo.
1853 * It will have the same backend as this repo.
1855 * @return TempFileRepo
1857 public function getTempRepo() {
1858 return new TempFileRepo( [
1859 'name' => "{$this->name}-temp",
1860 'backend' => $this->backend
,
1863 // Same place storeTemp() uses in the base repo, though
1864 // the path hashing is mismatched, which is annoying.
1865 'container' => $this->zones
['temp']['container'],
1866 'directory' => $this->zones
['temp']['directory']
1869 'container' => $this->zones
['temp']['container'],
1870 'directory' => $this->zones
['temp']['directory'] == ''
1872 : $this->zones
['temp']['directory'] . '/thumb'
1875 'container' => $this->zones
['temp']['container'],
1876 'directory' => $this->zones
['temp']['directory'] == ''
1878 : $this->zones
['temp']['directory'] . '/transcoded'
1881 'hashLevels' => $this->hashLevels
, // performance
1882 'isPrivate' => true // all in temp zone
1887 * Get an UploadStash associated with this repo.
1889 * @param User|null $user
1890 * @return UploadStash
1892 public function getUploadStash( User
$user = null ) {
1893 return new UploadStash( $this, $user );
1897 * Throw an exception if this repo is read-only by design.
1898 * This does not and should not check getReadOnlyReason().
1901 * @throws MWException
1903 protected function assertWritableRepo() {
1907 * Return information about the repository.
1912 public function getInfo() {
1914 'name' => $this->getName(),
1915 'displayname' => $this->getDisplayName(),
1916 'rootUrl' => $this->getZoneUrl( 'public' ),
1917 'local' => $this->isLocal(),
1920 $optionalSettings = [
1921 'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1922 'fetchDescription', 'descriptionCacheExpiry', 'favicon'
1924 foreach ( $optionalSettings as $k ) {
1925 if ( isset( $this->$k ) ) {
1926 $ret[$k] = $this->$k;
1934 * Returns whether or not storage is SHA-1 based
1937 public function hasSha1Storage() {
1938 return $this->hasSha1Storage
;
1942 * Returns whether or not repo supports having originals SHA-1s in the thumb URLs
1945 public function supportsSha1URLs() {
1946 return $this->supportsSha1URLs
;