3 * @defgroup FileRepo File Repository
5 * @brief This module handles how MediaWiki interacts with filesystems.
11 * Base code for file repositories.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * http://www.gnu.org/copyleft/gpl.html
33 * Base class for file repositories
38 const DELETE_SOURCE
= 1;
40 const OVERWRITE_SAME
= 4;
41 const SKIP_LOCKING
= 8;
43 const NAME_AND_TIME_ONLY
= 1;
45 /** @var bool Whether to fetch commons image description pages and display
46 * them on the local wiki */
47 public $fetchDescription;
50 public $descriptionCacheExpiry;
52 /** @var FileBackend */
55 /** @var array Map of zones to config */
56 protected $zones = array();
58 /** @var string URL of thumb.php */
59 protected $thumbScriptUrl;
61 /** @var bool Whether to skip media file transformation on parse and rely
62 * on a 404 handler instead. */
63 protected $transformVia404;
65 /** @var string URL of image description pages, e.g.
66 * http://en.wikipedia.org/wiki/File:
68 protected $descBaseUrl;
70 /** @var string URL of the MediaWiki installation, equivalent to
71 * $wgScriptPath, e.g. https://en.wikipedia.org/w
73 protected $scriptDirUrl;
75 /** @var string Script extension of the MediaWiki installation, equivalent
76 * to $wgScriptExtension, e.g. .php5 defaults to .php */
77 protected $scriptExtension;
79 /** @var string Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1 */
80 protected $articleUrl;
82 /** @var bool Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
83 * determines whether filenames implicitly start with a capital letter.
84 * The current implementation may give incorrect description page links
85 * when the local $wgCapitalLinks and initialCapital are mismatched.
87 protected $initialCapital;
89 /** @var string May be 'paranoid' to remove all parameters from error
90 * messages, 'none' to leave the paths in unchanged, or 'simple' to
91 * replace paths with placeholders. Default for LocalRepo is
94 protected $pathDisclosureProtection = 'simple';
96 /** @var bool Public zone URL. */
99 /** @var string The base thumbnail URL. Defaults to "<url>/thumb". */
102 /** @var int The number of directory levels for hash-based division of files */
103 protected $hashLevels;
105 /** @var int The number of directory levels for hash-based division of deleted files */
106 protected $deletedHashLevels;
108 /** @var int File names over this size will use the short form of thumbnail
109 * names. Short thumbnail names only have the width, parameters, and the
112 protected $abbrvThreshold;
114 /** @var string The URL of the repo's favicon, if any */
117 /** @var bool Whether all zones should be private (e.g. private wiki repo) */
118 protected $isPrivate;
121 * Factory functions for creating new files
122 * Override these in the base class
124 protected $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
125 protected $oldFileFactory = false;
126 protected $fileFactoryKey = false;
127 protected $oldFileFactoryKey = false;
130 * @param array|null $info
131 * @throws MWException
133 public function __construct( array $info = null ) {
134 // Verify required settings presence
137 ||
!array_key_exists( 'name', $info )
138 ||
!array_key_exists( 'backend', $info )
140 throw new MWException( __CLASS__
.
141 " requires an array of options having both 'name' and 'backend' keys.\n" );
145 $this->name
= $info['name'];
146 if ( $info['backend'] instanceof FileBackend
) {
147 $this->backend
= $info['backend']; // useful for testing
149 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
152 // Optional settings that can have no value
153 $optionalSettings = array(
154 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
155 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
156 'scriptExtension', 'favicon'
158 foreach ( $optionalSettings as $var ) {
159 if ( isset( $info[$var] ) ) {
160 $this->$var = $info[$var];
164 // Optional settings that have a default
165 $this->initialCapital
= isset( $info['initialCapital'] )
166 ?
$info['initialCapital']
167 : MWNamespace
::isCapitalized( NS_FILE
);
168 $this->url
= isset( $info['url'] )
170 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
171 if ( isset( $info['thumbUrl'] ) ) {
172 $this->thumbUrl
= $info['thumbUrl'];
174 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
176 $this->hashLevels
= isset( $info['hashLevels'] )
177 ?
$info['hashLevels']
179 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
180 ?
$info['deletedHashLevels']
182 $this->transformVia404
= !empty( $info['transformVia404'] );
183 $this->abbrvThreshold
= isset( $info['abbrvThreshold'] )
184 ?
$info['abbrvThreshold']
186 $this->isPrivate
= !empty( $info['isPrivate'] );
187 // Give defaults for the basic zones...
188 $this->zones
= isset( $info['zones'] ) ?
$info['zones'] : array();
189 foreach ( array( 'public', 'thumb', 'transcoded', 'temp', 'deleted' ) as $zone ) {
190 if ( !isset( $this->zones
[$zone]['container'] ) ) {
191 $this->zones
[$zone]['container'] = "{$this->name}-{$zone}";
193 if ( !isset( $this->zones
[$zone]['directory'] ) ) {
194 $this->zones
[$zone]['directory'] = '';
196 if ( !isset( $this->zones
[$zone]['urlsByExt'] ) ) {
197 $this->zones
[$zone]['urlsByExt'] = array();
203 * Get the file backend instance. Use this function wisely.
205 * @return FileBackend
207 public function getBackend() {
208 return $this->backend
;
212 * Get an explanatory message if this repo is read-only.
213 * This checks if an administrator disabled writes to the backend.
215 * @return string|bool Returns false if the repo is not read-only
217 public function getReadOnlyReason() {
218 return $this->backend
->getReadOnlyReason();
222 * Check if a single zone or list of zones is defined for usage
224 * @param array $doZones Only do a particular zones
225 * @throws MWException
228 protected function initZones( $doZones = array() ) {
229 $status = $this->newGood();
230 foreach ( (array)$doZones as $zone ) {
231 $root = $this->getZonePath( $zone );
232 if ( $root === null ) {
233 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
241 * Determine if a string is an mwrepo:// URL
246 public static function isVirtualUrl( $url ) {
247 return substr( $url, 0, 9 ) == 'mwrepo://';
251 * Get a URL referring to this repository, with the private mwrepo protocol.
252 * The suffix, if supplied, is considered to be unencoded, and will be
253 * URL-encoded before being returned.
255 * @param string|bool $suffix
258 public function getVirtualUrl( $suffix = false ) {
259 $path = 'mwrepo://' . $this->name
;
260 if ( $suffix !== false ) {
261 $path .= '/' . rawurlencode( $suffix );
268 * Get the URL corresponding to one of the four basic zones
270 * @param string $zone One of: public, deleted, temp, thumb
271 * @param string|null $ext Optional file extension
272 * @return string|bool
274 public function getZoneUrl( $zone, $ext = null ) {
275 if ( in_array( $zone, array( 'public', 'thumb', 'transcoded' ) ) ) {
276 // standard public zones
277 if ( $ext !== null && isset( $this->zones
[$zone]['urlsByExt'][$ext] ) ) {
278 // custom URL for extension/zone
279 return $this->zones
[$zone]['urlsByExt'][$ext];
280 } elseif ( isset( $this->zones
[$zone]['url'] ) ) {
281 // custom URL for zone
282 return $this->zones
[$zone]['url'];
290 return false; // no public URL
292 return $this->thumbUrl
;
294 return "{$this->url}/transcoded";
301 * @return bool Whether non-ASCII path characters are allowed
303 public function backendSupportsUnicodePaths() {
304 return ( $this->getBackend()->getFeatures() & FileBackend
::ATTR_UNICODE_PATHS
);
308 * Get the backend storage path corresponding to a virtual URL.
309 * Use this function wisely.
312 * @throws MWException
315 public function resolveVirtualUrl( $url ) {
316 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
317 throw new MWException( __METHOD__
. ': unknown protocol' );
319 $bits = explode( '/', substr( $url, 9 ), 3 );
320 if ( count( $bits ) != 3 ) {
321 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
323 list( $repo, $zone, $rel ) = $bits;
324 if ( $repo !== $this->name
) {
325 throw new MWException( __METHOD__
. ": fetching from a foreign repo is not supported" );
327 $base = $this->getZonePath( $zone );
329 throw new MWException( __METHOD__
. ": invalid zone: $zone" );
332 return $base . '/' . rawurldecode( $rel );
336 * The the storage container and base path of a zone
338 * @param string $zone
339 * @return array (container, base path) or (null, null)
341 protected function getZoneLocation( $zone ) {
342 if ( !isset( $this->zones
[$zone] ) ) {
343 return array( null, null ); // bogus
346 return array( $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] );
350 * Get the storage path corresponding to one of the zones
352 * @param string $zone
353 * @return string|null Returns null if the zone is not defined
355 public function getZonePath( $zone ) {
356 list( $container, $base ) = $this->getZoneLocation( $zone );
357 if ( $container === null ||
$base === null ) {
360 $backendName = $this->backend
->getName();
361 if ( $base != '' ) { // may not be set
365 return "mwstore://$backendName/{$container}{$base}";
369 * Create a new File object from the local repository
371 * @param Title|string $title Title object or string
372 * @param bool|string $time Time at which the image was uploaded. If this
373 * is specified, the returned object will be an instance of the
374 * repository's old file class instead of a current file. Repositories
375 * not supporting version control should return false if this parameter
377 * @return File|null A File, or null if passed an invalid Title
379 public function newFile( $title, $time = false ) {
380 $title = File
::normalizeTitle( $title );
385 if ( $this->oldFileFactory
) {
386 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
391 return call_user_func( $this->fileFactory
, $title, $this );
396 * Find an instance of the named file created at the specified time
397 * Returns false if the file does not exist. Repositories not supporting
398 * version control should return false if the time is specified.
400 * @param Title|string $title Title object or string
401 * @param array $options Associative array of options:
402 * time: requested time for a specific file version, or false for the
403 * current version. An image object will be returned which was
404 * created at the specified time (which may be archived or current).
405 * ignoreRedirect: If true, do not follow file redirects
406 * private: If true, return restricted (deleted) files if the current
407 * user is allowed to view them. Otherwise, such files will not
408 * be found. If a User object, use that user instead of the current.
409 * latest: If true, load from the latest available data into File objects
410 * @return File|bool False on failure
412 public function findFile( $title, $options = array() ) {
413 $title = File
::normalizeTitle( $title );
417 if ( isset( $options['bypassCache'] ) ) {
418 $options['latest'] = $options['bypassCache']; // b/c
420 $time = isset( $options['time'] ) ?
$options['time'] : false;
421 $flags = !empty( $options['latest'] ) ? File
::READ_LATEST
: 0;
422 # First try the current version of the file to see if it precedes the timestamp
423 $img = $this->newFile( $title );
427 $img->load( $flags );
428 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
431 # Now try an old version of the file
432 if ( $time !== false ) {
433 $img = $this->newFile( $title, $time );
434 $img->load( $flags );
435 if ( $img && $img->exists() ) {
436 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
437 return $img; // always OK
438 } elseif ( !empty( $options['private'] ) &&
439 $img->userCan( File
::DELETED_FILE
,
440 $options['private'] instanceof User ?
$options['private'] : null
449 if ( !empty( $options['ignoreRedirect'] ) ) {
452 $redir = $this->checkRedirect( $title );
453 if ( $redir && $title->getNamespace() == NS_FILE
) {
454 $img = $this->newFile( $redir );
455 $img->load( $flags );
459 if ( $img->exists() ) {
460 $img->redirectedFrom( $title->getDBkey() );
470 * Find many files at once.
472 * @param array $items An array of titles, or an array of findFile() options with
473 * the "title" option giving the title. Example:
475 * $findItem = array( 'title' => $title, 'private' => true );
476 * $findBatch = array( $findItem );
477 * $repo->findFiles( $findBatch );
479 * No title should appear in $items twice, as the result use titles as keys
480 * @param int $flags Supports:
481 * - FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map.
482 * The search title uses the input titles; the other is the final post-redirect title.
483 * All titles are returned as string DB keys and the inner array is associative.
484 * @return array Map of (file name => File objects) for matches
486 public function findFiles( array $items, $flags = 0 ) {
488 foreach ( $items as $item ) {
489 if ( is_array( $item ) ) {
490 $title = $item['title'];
492 unset( $options['title'] );
497 $file = $this->findFile( $title, $options );
499 $searchName = File
::normalizeTitle( $title )->getDBkey(); // must be valid
500 if ( $flags & self
::NAME_AND_TIME_ONLY
) {
501 $result[$searchName] = array(
502 'title' => $file->getTitle()->getDBkey(),
503 'timestamp' => $file->getTimestamp()
506 $result[$searchName] = $file;
515 * Find an instance of the file with this key, created at the specified time
516 * Returns false if the file does not exist. Repositories not supporting
517 * version control should return false if the time is specified.
519 * @param string $sha1 Base 36 SHA-1 hash
520 * @param array $options Option array, same as findFile().
521 * @return File|bool False on failure
523 public function findFileFromKey( $sha1, $options = array() ) {
524 $time = isset( $options['time'] ) ?
$options['time'] : false;
525 # First try to find a matching current version of a file...
526 if ( $this->fileFactoryKey
) {
527 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
529 return false; // find-by-sha1 not supported
531 if ( $img && $img->exists() ) {
534 # Now try to find a matching old version of a file...
535 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
536 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
537 if ( $img && $img->exists() ) {
538 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
539 return $img; // always OK
540 } elseif ( !empty( $options['private'] ) &&
541 $img->userCan( File
::DELETED_FILE
,
542 $options['private'] instanceof User ?
$options['private'] : null
554 * Get an array or iterator of file objects for files that have a given
555 * SHA-1 content hash.
558 * @param string $hash SHA-1 hash
561 public function findBySha1( $hash ) {
566 * Get an array of arrays or iterators of file objects for files that
567 * have the given SHA-1 content hashes.
569 * @param array $hashes An array of hashes
570 * @return array An Array of arrays or iterators of file objects and the hash as key
572 public function findBySha1s( array $hashes ) {
574 foreach ( $hashes as $hash ) {
575 $files = $this->findBySha1( $hash );
576 if ( count( $files ) ) {
577 $result[$hash] = $files;
585 * Return an array of files where the name starts with $prefix.
588 * @param string $prefix The prefix to search for
589 * @param int $limit The maximum amount of files to return
592 public function findFilesByPrefix( $prefix, $limit ) {
597 * Get the public root URL of the repository
599 * @deprecated since 1.20
602 public function getRootUrl() {
603 return $this->getZoneUrl( 'public' );
607 * Get the URL of thumb.php
611 public function getThumbScriptUrl() {
612 return $this->thumbScriptUrl
;
616 * Returns true if the repository can transform files via a 404 handler
620 public function canTransformVia404() {
621 return $this->transformVia404
;
625 * Get the name of a file from its title object
627 * @param Title $title
630 public function getNameFromTitle( Title
$title ) {
632 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
633 $name = $title->getUserCaseDBKey();
634 if ( $this->initialCapital
) {
635 $name = $wgContLang->ucfirst( $name );
638 $name = $title->getDBkey();
645 * Get the public zone root storage directory of the repository
649 public function getRootDirectory() {
650 return $this->getZonePath( 'public' );
654 * Get a relative path including trailing slash, e.g. f/fa/
655 * If the repo is not hashed, returns an empty string
657 * @param string $name Name of file
660 public function getHashPath( $name ) {
661 return self
::getHashPathForLevel( $name, $this->hashLevels
);
665 * Get a relative path including trailing slash, e.g. f/fa/
666 * If the repo is not hashed, returns an empty string
668 * @param string $suffix Basename of file from FileRepo::storeTemp()
671 public function getTempHashPath( $suffix ) {
672 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
673 $name = isset( $parts[1] ) ?
$parts[1] : $suffix; // hash path is not based on timestamp
674 return self
::getHashPathForLevel( $name, $this->hashLevels
);
678 * @param string $name
682 protected static function getHashPathForLevel( $name, $levels ) {
683 if ( $levels == 0 ) {
686 $hash = md5( $name );
688 for ( $i = 1; $i <= $levels; $i++
) {
689 $path .= substr( $hash, 0, $i ) . '/';
697 * Get the number of hash directory levels
701 public function getHashLevels() {
702 return $this->hashLevels
;
706 * Get the name of this repository, as specified by $info['name]' to the constructor
710 public function getName() {
715 * Make an url to this repo
717 * @param string $query Query string to append
718 * @param string $entry Entry point; defaults to index
719 * @return string|bool False on failure
721 public function makeUrl( $query = '', $entry = 'index' ) {
722 if ( isset( $this->scriptDirUrl
) ) {
723 $ext = isset( $this->scriptExtension
) ?
$this->scriptExtension
: '.php';
725 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
732 * Get the URL of an image description page. May return false if it is
733 * unknown or not applicable. In general this should only be called by the
734 * File class, since it may return invalid results for certain kinds of
735 * repositories. Use File::getDescriptionUrl() in user code.
737 * In particular, it uses the article paths as specified to the repository
738 * constructor, whereas local repositories use the local Title functions.
740 * @param string $name
743 public function getDescriptionUrl( $name ) {
744 $encName = wfUrlencode( $name );
745 if ( !is_null( $this->descBaseUrl
) ) {
746 # "http://example.com/wiki/File:"
747 return $this->descBaseUrl
. $encName;
749 if ( !is_null( $this->articleUrl
) ) {
750 # "http://example.com/wiki/$1"
752 # We use "Image:" as the canonical namespace for
753 # compatibility across all MediaWiki versions.
754 return str_replace( '$1',
755 "Image:$encName", $this->articleUrl
);
757 if ( !is_null( $this->scriptDirUrl
) ) {
758 # "http://example.com/w"
760 # We use "Image:" as the canonical namespace for
761 # compatibility across all MediaWiki versions,
762 # and just sort of hope index.php is right. ;)
763 return $this->makeUrl( "title=Image:$encName" );
770 * Get the URL of the content-only fragment of the description page. For
771 * MediaWiki this means action=render. This should only be called by the
772 * repository's file class, since it may return invalid results. User code
773 * should use File::getDescriptionText().
775 * @param string $name Name of image to fetch
776 * @param string $lang Language to fetch it in, if any.
779 public function getDescriptionRenderUrl( $name, $lang = null ) {
780 $query = 'action=render';
781 if ( !is_null( $lang ) ) {
782 $query .= '&uselang=' . $lang;
784 if ( isset( $this->scriptDirUrl
) ) {
785 return $this->makeUrl(
787 wfUrlencode( 'Image:' . $name ) .
790 $descUrl = $this->getDescriptionUrl( $name );
792 return wfAppendQuery( $descUrl, $query );
800 * Get the URL of the stylesheet to apply to description pages
802 * @return string|bool False on failure
804 public function getDescriptionStylesheetUrl() {
805 if ( isset( $this->scriptDirUrl
) ) {
806 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
807 wfArrayToCgi( Skin
::getDynamicStylesheetQuery() ) );
814 * Store a file to a given destination.
816 * @param string $srcPath Source file system path, storage path, or virtual URL
817 * @param string $dstZone Destination zone
818 * @param string $dstRel Destination relative path
819 * @param int $flags Bitwise combination of the following flags:
820 * self::DELETE_SOURCE Delete the source file after upload
821 * self::OVERWRITE Overwrite an existing destination file instead of failing
822 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
823 * same contents as the source
824 * self::SKIP_LOCKING Skip any file locking when doing the store
825 * @return FileRepoStatus
827 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
828 $this->assertWritableRepo(); // fail out if read-only
830 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
831 if ( $status->successCount
== 0 ) {
839 * Store a batch of files
841 * @param array $triplets (src, dest zone, dest rel) triplets as per store()
842 * @param int $flags Bitwise combination of the following flags:
843 * self::DELETE_SOURCE Delete the source file after upload
844 * self::OVERWRITE Overwrite an existing destination file instead of failing
845 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
846 * same contents as the source
847 * self::SKIP_LOCKING Skip any file locking when doing the store
848 * @throws MWException
849 * @return FileRepoStatus
851 public function storeBatch( array $triplets, $flags = 0 ) {
852 $this->assertWritableRepo(); // fail out if read-only
854 $status = $this->newGood();
855 $backend = $this->backend
; // convenience
857 $operations = array();
858 $sourceFSFilesToDelete = array(); // cleanup for disk source files
859 // Validate each triplet and get the store operation...
860 foreach ( $triplets as $triplet ) {
861 list( $srcPath, $dstZone, $dstRel ) = $triplet;
863 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
866 // Resolve destination path
867 $root = $this->getZonePath( $dstZone );
869 throw new MWException( "Invalid zone: $dstZone" );
871 if ( !$this->validateFilename( $dstRel ) ) {
872 throw new MWException( 'Validation error in $dstRel' );
874 $dstPath = "$root/$dstRel";
875 $dstDir = dirname( $dstPath );
876 // Create destination directories for this triplet
877 if ( !$this->initDirectory( $dstDir )->isOK() ) {
878 return $this->newFatal( 'directorycreateerror', $dstDir );
881 // Resolve source to a storage path if virtual
882 $srcPath = $this->resolveToStoragePath( $srcPath );
884 // Get the appropriate file operation
885 if ( FileBackend
::isStoragePath( $srcPath ) ) {
886 $opName = ( $flags & self
::DELETE_SOURCE
) ?
'move' : 'copy';
889 if ( $flags & self
::DELETE_SOURCE
) {
890 $sourceFSFilesToDelete[] = $srcPath;
893 $operations[] = array(
897 'overwrite' => $flags & self
::OVERWRITE
,
898 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
902 // Execute the store operation for each triplet
903 $opts = array( 'force' => true );
904 if ( $flags & self
::SKIP_LOCKING
) {
905 $opts['nonLocking'] = true;
907 $status->merge( $backend->doOperations( $operations, $opts ) );
908 // Cleanup for disk source files...
909 foreach ( $sourceFSFilesToDelete as $file ) {
910 MediaWiki\
suppressWarnings();
911 unlink( $file ); // FS cleanup
912 MediaWiki\restoreWarnings
();
919 * Deletes a batch of files.
920 * Each file can be a (zone, rel) pair, virtual url, storage path.
921 * It will try to delete each file, but ignores any errors that may occur.
923 * @param array $files List of files to delete
924 * @param int $flags Bitwise combination of the following flags:
925 * self::SKIP_LOCKING Skip any file locking when doing the deletions
926 * @return FileRepoStatus
928 public function cleanupBatch( array $files, $flags = 0 ) {
929 $this->assertWritableRepo(); // fail out if read-only
931 $status = $this->newGood();
933 $operations = array();
934 foreach ( $files as $path ) {
935 if ( is_array( $path ) ) {
936 // This is a pair, extract it
937 list( $zone, $rel ) = $path;
938 $path = $this->getZonePath( $zone ) . "/$rel";
940 // Resolve source to a storage path if virtual
941 $path = $this->resolveToStoragePath( $path );
943 $operations[] = array( 'op' => 'delete', 'src' => $path );
945 // Actually delete files from storage...
946 $opts = array( 'force' => true );
947 if ( $flags & self
::SKIP_LOCKING
) {
948 $opts['nonLocking'] = true;
950 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
956 * Import a file from the local file system into the repo.
957 * This does no locking nor journaling and overrides existing files.
958 * This function can be used to write to otherwise read-only foreign repos.
959 * This is intended for copying generated thumbnails into the repo.
961 * @param string $src Source file system path, storage path, or virtual URL
962 * @param string $dst Virtual URL or storage path
963 * @param array|string|null $options An array consisting of a key named headers
964 * listing extra headers. If a string, taken as content-disposition header.
965 * (Support for array of options new in 1.23)
966 * @return FileRepoStatus
968 final public function quickImport( $src, $dst, $options = null ) {
969 return $this->quickImportBatch( array( array( $src, $dst, $options ) ) );
973 * Purge a file from the repo. This does no locking nor journaling.
974 * This function can be used to write to otherwise read-only foreign repos.
975 * This is intended for purging thumbnails.
977 * @param string $path Virtual URL or storage path
978 * @return FileRepoStatus
980 final public function quickPurge( $path ) {
981 return $this->quickPurgeBatch( array( $path ) );
985 * Deletes a directory if empty.
986 * This function can be used to write to otherwise read-only foreign repos.
988 * @param string $dir Virtual URL (or storage path) of directory to clean
991 public function quickCleanDir( $dir ) {
992 $status = $this->newGood();
993 $status->merge( $this->backend
->clean(
994 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1000 * Import a batch of files from the local file system into the repo.
1001 * This does no locking nor journaling and overrides existing files.
1002 * This function can be used to write to otherwise read-only foreign repos.
1003 * This is intended for copying generated thumbnails into the repo.
1005 * All path parameters may be a file system path, storage path, or virtual URL.
1006 * When "headers" are given they are used as HTTP headers if supported.
1008 * @param array $triples List of (source path, destination path, disposition)
1009 * @return FileRepoStatus
1011 public function quickImportBatch( array $triples ) {
1012 $status = $this->newGood();
1013 $operations = array();
1014 foreach ( $triples as $triple ) {
1015 list( $src, $dst ) = $triple;
1016 $src = $this->resolveToStoragePath( $src );
1017 $dst = $this->resolveToStoragePath( $dst );
1019 if ( !isset( $triple[2] ) ) {
1021 } elseif ( is_string( $triple[2] ) ) {
1023 $headers = array( 'Content-Disposition' => $triple[2] );
1024 } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1025 $headers = $triple[2]['headers'];
1027 // @fixme: $headers might not be defined
1028 $operations[] = array(
1029 'op' => FileBackend
::isStoragePath( $src ) ?
'copy' : 'store',
1032 'headers' => $headers
1034 $status->merge( $this->initDirectory( dirname( $dst ) ) );
1036 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1042 * Purge a batch of files from the repo.
1043 * This function can be used to write to otherwise read-only foreign repos.
1044 * This does no locking nor journaling and is intended for purging thumbnails.
1046 * @param array $paths List of virtual URLs or storage paths
1047 * @return FileRepoStatus
1049 public function quickPurgeBatch( array $paths ) {
1050 $status = $this->newGood();
1051 $operations = array();
1052 foreach ( $paths as $path ) {
1053 $operations[] = array(
1055 'src' => $this->resolveToStoragePath( $path ),
1056 'ignoreMissingSource' => true
1059 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1065 * Pick a random name in the temp zone and store a file to it.
1066 * Returns a FileRepoStatus object with the file Virtual URL in the value,
1067 * file can later be disposed using FileRepo::freeTemp().
1069 * @param string $originalName The base name of the file as specified
1070 * by the user. The file extension will be maintained.
1071 * @param string $srcPath The current location of the file.
1072 * @return FileRepoStatus Object with the URL in the value.
1074 public function storeTemp( $originalName, $srcPath ) {
1075 $this->assertWritableRepo(); // fail out if read-only
1077 $date = MWTimestamp
::getInstance()->format( 'YmdHis' );
1078 $hashPath = $this->getHashPath( $originalName );
1079 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1080 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1082 $result = $this->quickImport( $srcPath, $virtualUrl );
1083 $result->value
= $virtualUrl;
1089 * Remove a temporary file or mark it for garbage collection
1091 * @param string $virtualUrl The virtual URL returned by FileRepo::storeTemp()
1092 * @return bool True on success, false on failure
1094 public function freeTemp( $virtualUrl ) {
1095 $this->assertWritableRepo(); // fail out if read-only
1097 $temp = $this->getVirtualUrl( 'temp' );
1098 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1099 wfDebug( __METHOD__
. ": Invalid temp virtual URL\n" );
1104 return $this->quickPurge( $virtualUrl )->isOK();
1108 * Concatenate a list of temporary files into a target file location.
1110 * @param array $srcPaths Ordered list of source virtual URLs/storage paths
1111 * @param string $dstPath Target file system path
1112 * @param int $flags Bitwise combination of the following flags:
1113 * self::DELETE_SOURCE Delete the source files
1114 * @return FileRepoStatus
1116 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1117 $this->assertWritableRepo(); // fail out if read-only
1119 $status = $this->newGood();
1122 foreach ( $srcPaths as $srcPath ) {
1123 // Resolve source to a storage path if virtual
1124 $source = $this->resolveToStoragePath( $srcPath );
1125 $sources[] = $source; // chunk to merge
1128 // Concatenate the chunks into one FS file
1129 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
1130 $status->merge( $this->backend
->concatenate( $params ) );
1131 if ( !$status->isOK() ) {
1135 // Delete the sources if required
1136 if ( $flags & self
::DELETE_SOURCE
) {
1137 $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1140 // Make sure status is OK, despite any quickPurgeBatch() fatals
1141 $status->setResult( true );
1147 * Copy or move a file either from a storage path, virtual URL,
1148 * or file system path, into this repository at the specified destination location.
1150 * Returns a FileRepoStatus object. On success, the value contains "new" or
1151 * "archived", to indicate whether the file was new with that name.
1153 * Options to $options include:
1154 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1156 * @param string $srcPath The source file system path, storage path, or URL
1157 * @param string $dstRel The destination relative path
1158 * @param string $archiveRel The relative path where the existing file is to
1159 * be archived, if there is one. Relative to the public zone root.
1160 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1161 * that the source file should be deleted if possible
1162 * @param array $options Optional additional parameters
1163 * @return FileRepoStatus
1165 public function publish(
1166 $srcPath, $dstRel, $archiveRel, $flags = 0, array $options = array()
1168 $this->assertWritableRepo(); // fail out if read-only
1170 $status = $this->publishBatch(
1171 array( array( $srcPath, $dstRel, $archiveRel, $options ) ), $flags );
1172 if ( $status->successCount
== 0 ) {
1173 $status->ok
= false;
1175 if ( isset( $status->value
[0] ) ) {
1176 $status->value
= $status->value
[0];
1178 $status->value
= false;
1185 * Publish a batch of files
1187 * @param array $ntuples (source, dest, archive) triplets or
1188 * (source, dest, archive, options) 4-tuples as per publish().
1189 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1190 * that the source files should be deleted if possible
1191 * @throws MWException
1192 * @return FileRepoStatus
1194 public function publishBatch( array $ntuples, $flags = 0 ) {
1195 $this->assertWritableRepo(); // fail out if read-only
1197 $backend = $this->backend
; // convenience
1198 // Try creating directories
1199 $status = $this->initZones( 'public' );
1200 if ( !$status->isOK() ) {
1204 $status = $this->newGood( array() );
1206 $operations = array();
1207 $sourceFSFilesToDelete = array(); // cleanup for disk source files
1208 // Validate each triplet and get the store operation...
1209 foreach ( $ntuples as $ntuple ) {
1210 list( $srcPath, $dstRel, $archiveRel ) = $ntuple;
1211 $options = isset( $ntuple[3] ) ?
$ntuple[3] : array();
1212 // Resolve source to a storage path if virtual
1213 $srcPath = $this->resolveToStoragePath( $srcPath );
1214 if ( !$this->validateFilename( $dstRel ) ) {
1215 throw new MWException( 'Validation error in $dstRel' );
1217 if ( !$this->validateFilename( $archiveRel ) ) {
1218 throw new MWException( 'Validation error in $archiveRel' );
1221 $publicRoot = $this->getZonePath( 'public' );
1222 $dstPath = "$publicRoot/$dstRel";
1223 $archivePath = "$publicRoot/$archiveRel";
1225 $dstDir = dirname( $dstPath );
1226 $archiveDir = dirname( $archivePath );
1227 // Abort immediately on directory creation errors since they're likely to be repetitive
1228 if ( !$this->initDirectory( $dstDir )->isOK() ) {
1229 return $this->newFatal( 'directorycreateerror', $dstDir );
1231 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1232 return $this->newFatal( 'directorycreateerror', $archiveDir );
1235 // Set any desired headers to be use in GET/HEAD responses
1236 $headers = isset( $options['headers'] ) ?
$options['headers'] : array();
1238 // Archive destination file if it exists.
1239 // This will check if the archive file also exists and fail if does.
1240 // This is a sanity check to avoid data loss. On Windows and Linux,
1241 // copy() will overwrite, so the existence check is vulnerable to
1242 // race conditions unless a functioning LockManager is used.
1243 // LocalFile also uses SELECT FOR UPDATE for synchronization.
1244 $operations[] = array(
1247 'dst' => $archivePath,
1248 'ignoreMissingSource' => true
1251 // Copy (or move) the source file to the destination
1252 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1253 if ( $flags & self
::DELETE_SOURCE
) {
1254 $operations[] = array(
1258 'overwrite' => true, // replace current
1259 'headers' => $headers
1262 $operations[] = array(
1266 'overwrite' => true, // replace current
1267 'headers' => $headers
1270 } else { // FS source path
1271 $operations[] = array(
1275 'overwrite' => true, // replace current
1276 'headers' => $headers
1278 if ( $flags & self
::DELETE_SOURCE
) {
1279 $sourceFSFilesToDelete[] = $srcPath;
1284 // Execute the operations for each triplet
1285 $status->merge( $backend->doOperations( $operations ) );
1286 // Find out which files were archived...
1287 foreach ( $ntuples as $i => $ntuple ) {
1288 list( , , $archiveRel ) = $ntuple;
1289 $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1290 if ( $this->fileExists( $archivePath ) ) {
1291 $status->value
[$i] = 'archived';
1293 $status->value
[$i] = 'new';
1296 // Cleanup for disk source files...
1297 foreach ( $sourceFSFilesToDelete as $file ) {
1298 MediaWiki\
suppressWarnings();
1299 unlink( $file ); // FS cleanup
1300 MediaWiki\restoreWarnings
();
1307 * Creates a directory with the appropriate zone permissions.
1308 * Callers are responsible for doing read-only and "writable repo" checks.
1310 * @param string $dir Virtual URL (or storage path) of directory to clean
1313 protected function initDirectory( $dir ) {
1314 $path = $this->resolveToStoragePath( $dir );
1315 list( , $container, ) = FileBackend
::splitStoragePath( $path );
1317 $params = array( 'dir' => $path );
1318 if ( $this->isPrivate
1319 ||
$container === $this->zones
['deleted']['container']
1320 ||
$container === $this->zones
['temp']['container']
1322 # Take all available measures to prevent web accessibility of new deleted
1323 # directories, in case the user has not configured offline storage
1324 $params = array( 'noAccess' => true, 'noListing' => true ) +
$params;
1327 return $this->backend
->prepare( $params );
1331 * Deletes a directory if empty.
1333 * @param string $dir Virtual URL (or storage path) of directory to clean
1336 public function cleanDir( $dir ) {
1337 $this->assertWritableRepo(); // fail out if read-only
1339 $status = $this->newGood();
1340 $status->merge( $this->backend
->clean(
1341 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1347 * Checks existence of a a file
1349 * @param string $file Virtual URL (or storage path) of file to check
1352 public function fileExists( $file ) {
1353 $result = $this->fileExistsBatch( array( $file ) );
1359 * Checks existence of an array of files.
1361 * @param array $files Virtual URLs (or storage paths) of files to check
1362 * @return array Map of files and existence flags, or false
1364 public function fileExistsBatch( array $files ) {
1365 $paths = array_map( array( $this, 'resolveToStoragePath' ), $files );
1366 $this->backend
->preloadFileStat( array( 'srcs' => $paths ) );
1369 foreach ( $files as $key => $file ) {
1370 $path = $this->resolveToStoragePath( $file );
1371 $result[$key] = $this->backend
->fileExists( array( 'src' => $path ) );
1378 * Move a file to the deletion archive.
1379 * If no valid deletion archive exists, this may either delete the file
1380 * or throw an exception, depending on the preference of the repository
1382 * @param mixed $srcRel Relative path for the file to be deleted
1383 * @param mixed $archiveRel Relative path for the archive location.
1384 * Relative to a private archive directory.
1385 * @return FileRepoStatus
1387 public function delete( $srcRel, $archiveRel ) {
1388 $this->assertWritableRepo(); // fail out if read-only
1390 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1394 * Move a group of files to the deletion archive.
1396 * If no valid deletion archive is configured, this may either delete the
1397 * file or throw an exception, depending on the preference of the repository.
1399 * The overwrite policy is determined by the repository -- currently LocalRepo
1400 * assumes a naming scheme in the deleted zone based on content hash, as
1401 * opposed to the public zone which is assumed to be unique.
1403 * @param array $sourceDestPairs Array of source/destination pairs. Each element
1404 * is a two-element array containing the source file path relative to the
1405 * public root in the first element, and the archive file path relative
1406 * to the deleted zone root in the second element.
1407 * @throws MWException
1408 * @return FileRepoStatus
1410 public function deleteBatch( array $sourceDestPairs ) {
1411 $this->assertWritableRepo(); // fail out if read-only
1413 // Try creating directories
1414 $status = $this->initZones( array( 'public', 'deleted' ) );
1415 if ( !$status->isOK() ) {
1419 $status = $this->newGood();
1421 $backend = $this->backend
; // convenience
1422 $operations = array();
1423 // Validate filenames and create archive directories
1424 foreach ( $sourceDestPairs as $pair ) {
1425 list( $srcRel, $archiveRel ) = $pair;
1426 if ( !$this->validateFilename( $srcRel ) ) {
1427 throw new MWException( __METHOD__
. ':Validation error in $srcRel' );
1428 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1429 throw new MWException( __METHOD__
. ':Validation error in $archiveRel' );
1432 $publicRoot = $this->getZonePath( 'public' );
1433 $srcPath = "{$publicRoot}/$srcRel";
1435 $deletedRoot = $this->getZonePath( 'deleted' );
1436 $archivePath = "{$deletedRoot}/{$archiveRel}";
1437 $archiveDir = dirname( $archivePath ); // does not touch FS
1439 // Create destination directories
1440 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1441 return $this->newFatal( 'directorycreateerror', $archiveDir );
1444 $operations[] = array(
1447 'dst' => $archivePath,
1448 // We may have 2+ identical files being deleted,
1449 // all of which will map to the same destination file
1450 'overwriteSame' => true // also see bug 31792
1454 // Move the files by execute the operations for each pair.
1455 // We're now committed to returning an OK result, which will
1456 // lead to the files being moved in the DB also.
1457 $opts = array( 'force' => true );
1458 $status->merge( $backend->doOperations( $operations, $opts ) );
1464 * Delete files in the deleted directory if they are not referenced in the filearchive table
1467 * @param array $storageKeys
1469 public function cleanupDeletedBatch( array $storageKeys ) {
1470 $this->assertWritableRepo();
1474 * Get a relative path for a deletion archive key,
1475 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1477 * @param string $key
1478 * @throws MWException
1481 public function getDeletedHashPath( $key ) {
1482 if ( strlen( $key ) < 31 ) {
1483 throw new MWException( "Invalid storage key '$key'." );
1486 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1487 $path .= $key[$i] . '/';
1494 * If a path is a virtual URL, resolve it to a storage path.
1495 * Otherwise, just return the path as it is.
1497 * @param string $path
1499 * @throws MWException
1501 protected function resolveToStoragePath( $path ) {
1502 if ( $this->isVirtualUrl( $path ) ) {
1503 return $this->resolveVirtualUrl( $path );
1510 * Get a local FS copy of a file with a given virtual URL/storage path.
1511 * Temporary files may be purged when the file object falls out of scope.
1513 * @param string $virtualUrl
1514 * @return TempFSFile|null Returns null on failure
1516 public function getLocalCopy( $virtualUrl ) {
1517 $path = $this->resolveToStoragePath( $virtualUrl );
1519 return $this->backend
->getLocalCopy( array( 'src' => $path ) );
1523 * Get a local FS file with a given virtual URL/storage path.
1524 * The file is either an original or a copy. It should not be changed.
1525 * Temporary files may be purged when the file object falls out of scope.
1527 * @param string $virtualUrl
1528 * @return FSFile|null Returns null on failure.
1530 public function getLocalReference( $virtualUrl ) {
1531 $path = $this->resolveToStoragePath( $virtualUrl );
1533 return $this->backend
->getLocalReference( array( 'src' => $path ) );
1537 * Get properties of a file with a given virtual URL/storage path.
1538 * Properties should ultimately be obtained via FSFile::getProps().
1540 * @param string $virtualUrl
1543 public function getFileProps( $virtualUrl ) {
1544 $path = $this->resolveToStoragePath( $virtualUrl );
1546 return $this->backend
->getFileProps( array( 'src' => $path ) );
1550 * Get the timestamp of a file with a given virtual URL/storage path
1552 * @param string $virtualUrl
1553 * @return string|bool False on failure
1555 public function getFileTimestamp( $virtualUrl ) {
1556 $path = $this->resolveToStoragePath( $virtualUrl );
1558 return $this->backend
->getFileTimestamp( array( 'src' => $path ) );
1562 * Get the size of a file with a given virtual URL/storage path
1564 * @param string $virtualUrl
1565 * @return int|bool False on failure
1567 public function getFileSize( $virtualUrl ) {
1568 $path = $this->resolveToStoragePath( $virtualUrl );
1570 return $this->backend
->getFileSize( array( 'src' => $path ) );
1574 * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1576 * @param string $virtualUrl
1577 * @return string|bool
1579 public function getFileSha1( $virtualUrl ) {
1580 $path = $this->resolveToStoragePath( $virtualUrl );
1582 return $this->backend
->getFileSha1Base36( array( 'src' => $path ) );
1586 * Attempt to stream a file with the given virtual URL/storage path
1588 * @param string $virtualUrl
1589 * @param array $headers Additional HTTP headers to send on success
1590 * @return bool Success
1592 public function streamFile( $virtualUrl, $headers = array() ) {
1593 $path = $this->resolveToStoragePath( $virtualUrl );
1594 $params = array( 'src' => $path, 'headers' => $headers );
1596 return $this->backend
->streamFile( $params )->isOK();
1600 * Call a callback function for every public regular file in the repository.
1601 * This only acts on the current version of files, not any old versions.
1602 * May use either the database or the filesystem.
1604 * @param callable $callback
1607 public function enumFiles( $callback ) {
1608 $this->enumFilesInStorage( $callback );
1612 * Call a callback function for every public file in the repository.
1613 * May use either the database or the filesystem.
1615 * @param callable $callback
1618 protected function enumFilesInStorage( $callback ) {
1619 $publicRoot = $this->getZonePath( 'public' );
1620 $numDirs = 1 << ( $this->hashLevels
* 4 );
1621 // Use a priori assumptions about directory structure
1622 // to reduce the tree height of the scanning process.
1623 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1624 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1625 $path = $publicRoot;
1626 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1627 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1629 $iterator = $this->backend
->getFileList( array( 'dir' => $path ) );
1630 foreach ( $iterator as $name ) {
1631 // Each item returned is a public file
1632 call_user_func( $callback, "{$path}/{$name}" );
1638 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1640 * @param string $filename
1643 public function validateFilename( $filename ) {
1644 if ( strval( $filename ) == '' ) {
1648 return FileBackend
::isPathTraversalFree( $filename );
1652 * Get a callback function to use for cleaning error message parameters
1656 function getErrorCleanupFunction() {
1657 switch ( $this->pathDisclosureProtection
) {
1659 case 'simple': // b/c
1660 $callback = array( $this, 'passThrough' );
1662 default: // 'paranoid'
1663 $callback = array( $this, 'paranoidClean' );
1669 * Path disclosure protection function
1671 * @param string $param
1674 function paranoidClean( $param ) {
1679 * Path disclosure protection function
1681 * @param string $param
1684 function passThrough( $param ) {
1689 * Create a new fatal error
1691 * @param string $message
1694 public function newFatal( $message /*, parameters...*/ ) {
1695 $status = call_user_func_array( array( 'Status', 'newFatal' ), func_get_args() );
1696 $status->cleanCallback
= $this->getErrorCleanupFunction();
1702 * Create a new good result
1704 * @param null|string $value
1707 public function newGood( $value = null ) {
1708 $status = Status
::newGood( $value );
1709 $status->cleanCallback
= $this->getErrorCleanupFunction();
1715 * Checks if there is a redirect named as $title. If there is, return the
1716 * title object. If not, return false.
1719 * @param Title $title Title of image
1722 public function checkRedirect( Title
$title ) {
1727 * Invalidates image redirect cache related to that image
1728 * Doesn't do anything for repositories that don't support image redirects.
1731 * @param Title $title Title of image
1733 public function invalidateImageRedirect( Title
$title ) {
1737 * Get the human-readable name of the repo
1741 public function getDisplayName() {
1744 if ( $this->isLocal() ) {
1748 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1749 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1753 * Get the portion of the file that contains the origin file name.
1754 * If that name is too long, then the name "thumbnail.<ext>" will be given.
1756 * @param string $name
1759 public function nameForThumb( $name ) {
1760 if ( strlen( $name ) > $this->abbrvThreshold
) {
1761 $ext = FileBackend
::extensionFromPath( $name );
1762 $name = ( $ext == '' ) ?
'thumbnail' : "thumbnail.$ext";
1769 * Returns true if this the local file repository.
1773 public function isLocal() {
1774 return $this->getName() == 'local';
1778 * Get a key on the primary cache for this repository.
1779 * Returns false if the repository's cache is not accessible at this site.
1780 * The parameters are the parts of the key, as for wfMemcKey().
1785 public function getSharedCacheKey( /*...*/ ) {
1790 * Get a key for this repo in the local cache domain. These cache keys are
1791 * not shared with remote instances of the repo.
1792 * The parameters are the parts of the key, as for wfMemcKey().
1796 public function getLocalCacheKey( /*...*/ ) {
1797 $args = func_get_args();
1798 array_unshift( $args, 'filerepo', $this->getName() );
1800 return call_user_func_array( 'wfMemcKey', $args );
1804 * Get a temporary private FileRepo associated with this repo.
1806 * Files will be created in the temp zone of this repo.
1807 * It will have the same backend as this repo.
1809 * @return TempFileRepo
1811 public function getTempRepo() {
1812 return new TempFileRepo( array(
1813 'name' => "{$this->name}-temp",
1814 'backend' => $this->backend
,
1817 // Same place storeTemp() uses in the base repo, though
1818 // the path hashing is mismatched, which is annoying.
1819 'container' => $this->zones
['temp']['container'],
1820 'directory' => $this->zones
['temp']['directory']
1823 'container' => $this->zones
['temp']['container'],
1824 'directory' => $this->zones
['temp']['directory'] == ''
1826 : $this->zones
['temp']['directory'] . '/thumb'
1828 'transcoded' => array(
1829 'container' => $this->zones
['temp']['container'],
1830 'directory' => $this->zones
['temp']['directory'] == ''
1832 : $this->zones
['temp']['directory'] . '/transcoded'
1835 'hashLevels' => $this->hashLevels
, // performance
1836 'isPrivate' => true // all in temp zone
1841 * Get an UploadStash associated with this repo.
1844 * @return UploadStash
1846 public function getUploadStash( User
$user = null ) {
1847 return new UploadStash( $this, $user );
1851 * Throw an exception if this repo is read-only by design.
1852 * This does not and should not check getReadOnlyReason().
1855 * @throws MWException
1857 protected function assertWritableRepo() {
1861 * Return information about the repository.
1866 public function getInfo() {
1868 'name' => $this->getName(),
1869 'displayname' => $this->getDisplayName(),
1870 'rootUrl' => $this->getZoneUrl( 'public' ),
1871 'local' => $this->isLocal(),
1874 $optionalSettings = array(
1875 'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1876 'fetchDescription', 'descriptionCacheExpiry', 'scriptExtension', 'favicon'
1878 foreach ( $optionalSettings as $k ) {
1879 if ( isset( $this->$k ) ) {
1880 $ret[$k] = $this->$k;
1889 * FileRepo for temporary files created via FileRepo::getTempRepo()
1891 class TempFileRepo
extends FileRepo
{
1892 public function getTempRepo() {
1893 throw new MWException( "Cannot get a temp repo from a temp repo." );