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 */
118 * Factory functions for creating new files
119 * Override these in the base class
121 protected $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
122 protected $oldFileFactory = false;
123 protected $fileFactoryKey = false;
124 protected $oldFileFactoryKey = false;
127 * @param array|null $info
128 * @throws MWException
130 public function __construct( array $info = null ) {
131 // Verify required settings presence
134 ||
!array_key_exists( 'name', $info )
135 ||
!array_key_exists( 'backend', $info )
137 throw new MWException( __CLASS__
.
138 " requires an array of options having both 'name' and 'backend' keys.\n" );
142 $this->name
= $info['name'];
143 if ( $info['backend'] instanceof FileBackend
) {
144 $this->backend
= $info['backend']; // useful for testing
146 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
149 // Optional settings that can have no value
150 $optionalSettings = array(
151 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
152 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
153 'scriptExtension', 'favicon'
155 foreach ( $optionalSettings as $var ) {
156 if ( isset( $info[$var] ) ) {
157 $this->$var = $info[$var];
161 // Optional settings that have a default
162 $this->initialCapital
= isset( $info['initialCapital'] )
163 ?
$info['initialCapital']
164 : MWNamespace
::isCapitalized( NS_FILE
);
165 $this->url
= isset( $info['url'] )
167 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
168 if ( isset( $info['thumbUrl'] ) ) {
169 $this->thumbUrl
= $info['thumbUrl'];
171 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
173 $this->hashLevels
= isset( $info['hashLevels'] )
174 ?
$info['hashLevels']
176 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
177 ?
$info['deletedHashLevels']
179 $this->transformVia404
= !empty( $info['transformVia404'] );
180 $this->abbrvThreshold
= isset( $info['abbrvThreshold'] )
181 ?
$info['abbrvThreshold']
183 $this->isPrivate
= !empty( $info['isPrivate'] );
184 // Give defaults for the basic zones...
185 $this->zones
= isset( $info['zones'] ) ?
$info['zones'] : array();
186 foreach ( array( 'public', 'thumb', 'transcoded', 'temp', 'deleted' ) as $zone ) {
187 if ( !isset( $this->zones
[$zone]['container'] ) ) {
188 $this->zones
[$zone]['container'] = "{$this->name}-{$zone}";
190 if ( !isset( $this->zones
[$zone]['directory'] ) ) {
191 $this->zones
[$zone]['directory'] = '';
193 if ( !isset( $this->zones
[$zone]['urlsByExt'] ) ) {
194 $this->zones
[$zone]['urlsByExt'] = array();
200 * Get the file backend instance. Use this function wisely.
202 * @return FileBackend
204 public function getBackend() {
205 return $this->backend
;
209 * Get an explanatory message if this repo is read-only.
210 * This checks if an administrator disabled writes to the backend.
212 * @return string|bool Returns false if the repo is not read-only
214 public function getReadOnlyReason() {
215 return $this->backend
->getReadOnlyReason();
219 * Check if a single zone or list of zones is defined for usage
221 * @param array $doZones Only do a particular zones
222 * @throws MWException
225 protected function initZones( $doZones = array() ) {
226 $status = $this->newGood();
227 foreach ( (array)$doZones as $zone ) {
228 $root = $this->getZonePath( $zone );
229 if ( $root === null ) {
230 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
238 * Determine if a string is an mwrepo:// URL
243 public static function isVirtualUrl( $url ) {
244 return substr( $url, 0, 9 ) == 'mwrepo://';
248 * Get a URL referring to this repository, with the private mwrepo protocol.
249 * The suffix, if supplied, is considered to be unencoded, and will be
250 * URL-encoded before being returned.
252 * @param string|bool $suffix
255 public function getVirtualUrl( $suffix = false ) {
256 $path = 'mwrepo://' . $this->name
;
257 if ( $suffix !== false ) {
258 $path .= '/' . rawurlencode( $suffix );
265 * Get the URL corresponding to one of the four basic zones
267 * @param string $zone One of: public, deleted, temp, thumb
268 * @param string|null $ext Optional file extension
269 * @return string|bool
271 public function getZoneUrl( $zone, $ext = null ) {
272 if ( in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) ) ) {
273 // standard public zones
274 if ( $ext !== null && isset( $this->zones
[$zone]['urlsByExt'][$ext] ) ) {
275 // custom URL for extension/zone
276 return $this->zones
[$zone]['urlsByExt'][$ext];
277 } elseif ( isset( $this->zones
[$zone]['url'] ) ) {
278 // custom URL for zone
279 return $this->zones
[$zone]['url'];
286 return "{$this->url}/temp";
288 return false; // no public URL
290 return $this->thumbUrl
;
292 return "{$this->url}/transcoded";
299 * Get the thumb zone URL configured to be handled by scripts like thumb_handler.php.
300 * This is probably only useful for internal requests, such as from a fast frontend server
301 * to a slower backend server.
303 * Large sites may use a different host name for uploads than for wikis. In any case, the
304 * wiki configuration is needed in order to use thumb.php. To avoid extracting the wiki ID
305 * from the URL path, one can configure thumb_handler.php to recognize a special path on the
306 * same host name as the wiki that is used for viewing thumbnails.
308 * @param string $zone one of: public, deleted, temp, thumb
309 * @return string|bool String or false
311 public function getZoneHandlerUrl( $zone ) {
312 if ( isset( $this->zones
[$zone]['handlerUrl'] )
313 && in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) )
315 return $this->zones
[$zone]['handlerUrl'];
322 * Get the backend storage path corresponding to a virtual URL.
323 * Use this function wisely.
326 * @throws MWException
329 public function resolveVirtualUrl( $url ) {
330 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
331 throw new MWException( __METHOD__
. ': unknown protocol' );
333 $bits = explode( '/', substr( $url, 9 ), 3 );
334 if ( count( $bits ) != 3 ) {
335 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
337 list( $repo, $zone, $rel ) = $bits;
338 if ( $repo !== $this->name
) {
339 throw new MWException( __METHOD__
. ": fetching from a foreign repo is not supported" );
341 $base = $this->getZonePath( $zone );
343 throw new MWException( __METHOD__
. ": invalid zone: $zone" );
346 return $base . '/' . rawurldecode( $rel );
350 * The the storage container and base path of a zone
352 * @param string $zone
353 * @return array (container, base path) or (null, null)
355 protected function getZoneLocation( $zone ) {
356 if ( !isset( $this->zones
[$zone] ) ) {
357 return array( null, null ); // bogus
360 return array( $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] );
364 * Get the storage path corresponding to one of the zones
366 * @param string $zone
367 * @return string|null Returns null if the zone is not defined
369 public function getZonePath( $zone ) {
370 list( $container, $base ) = $this->getZoneLocation( $zone );
371 if ( $container === null ||
$base === null ) {
374 $backendName = $this->backend
->getName();
375 if ( $base != '' ) { // may not be set
379 return "mwstore://$backendName/{$container}{$base}";
383 * Create a new File object from the local repository
385 * @param Title|string $title Title object or string
386 * @param bool|string $time Time at which the image was uploaded. If this
387 * is specified, the returned object will be an instance of the
388 * repository's old file class instead of a current file. Repositories
389 * not supporting version control should return false if this parameter
391 * @return File|null A File, or null if passed an invalid Title
393 public function newFile( $title, $time = false ) {
394 $title = File
::normalizeTitle( $title );
399 if ( $this->oldFileFactory
) {
400 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
405 return call_user_func( $this->fileFactory
, $title, $this );
410 * Find an instance of the named file created at the specified time
411 * Returns false if the file does not exist. Repositories not supporting
412 * version control should return false if the time is specified.
414 * @param Title|string $title Title object or string
415 * @param array $options Associative array of options:
416 * time: requested time for a specific file version, or false for the
417 * current version. An image object will be returned which was
418 * created at the specified time (which may be archived or current).
419 * ignoreRedirect: If true, do not follow file redirects
420 * private: If true, return restricted (deleted) files if the current
421 * user is allowed to view them. Otherwise, such files will not
422 * be found. If a User object, use that user instead of the current.
423 * @return File|bool False on failure
425 public function findFile( $title, $options = array() ) {
426 $title = File
::normalizeTitle( $title );
430 $time = isset( $options['time'] ) ?
$options['time'] : false;
431 # First try the current version of the file to see if it precedes the timestamp
432 $img = $this->newFile( $title );
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 );
442 if ( $img && $img->exists() ) {
443 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
444 return $img; // always OK
445 } elseif ( !empty( $options['private'] ) &&
446 $img->userCan( File
::DELETED_FILE
,
447 $options['private'] instanceof User ?
$options['private'] : null
456 if ( !empty( $options['ignoreRedirect'] ) ) {
459 $redir = $this->checkRedirect( $title );
460 if ( $redir && $title->getNamespace() == NS_FILE
) {
461 $img = $this->newFile( $redir );
465 if ( $img->exists() ) {
466 $img->redirectedFrom( $title->getDBkey() );
476 * Find many files at once.
478 * @param array $items An array of titles, or an array of findFile() options with
479 * the "title" option giving the title. Example:
481 * $findItem = array( 'title' => $title, 'private' => true );
482 * $findBatch = array( $findItem );
483 * $repo->findFiles( $findBatch );
485 * No title should appear in $items twice, as the result use titles as keys
486 * @param int $flags Supports:
487 * - FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map.
488 * The search title uses the input titles; the other is the final post-redirect title.
489 * All titles are returned as string DB keys and the inner array is associative.
490 * @return array Map of (file name => File objects) for matches
492 public function findFiles( array $items, $flags = 0 ) {
494 foreach ( $items as $item ) {
495 if ( is_array( $item ) ) {
496 $title = $item['title'];
498 unset( $options['title'] );
503 $file = $this->findFile( $title, $options );
505 $searchName = File
::normalizeTitle( $title )->getDBkey(); // must be valid
506 if ( $flags & self
::NAME_AND_TIME_ONLY
) {
507 $result[$searchName] = array(
508 'title' => $file->getTitle()->getDBkey(),
509 'timestamp' => $file->getTimestamp()
512 $result[$searchName] = $file;
521 * Find an instance of the file with this key, created at the specified time
522 * Returns false if the file does not exist. Repositories not supporting
523 * version control should return false if the time is specified.
525 * @param string $sha1 Base 36 SHA-1 hash
526 * @param array $options Option array, same as findFile().
527 * @return File|bool False on failure
529 public function findFileFromKey( $sha1, $options = array() ) {
530 $time = isset( $options['time'] ) ?
$options['time'] : false;
531 # First try to find a matching current version of a file...
532 if ( $this->fileFactoryKey
) {
533 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
535 return false; // find-by-sha1 not supported
537 if ( $img && $img->exists() ) {
540 # Now try to find a matching old version of a file...
541 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
542 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
543 if ( $img && $img->exists() ) {
544 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
545 return $img; // always OK
546 } elseif ( !empty( $options['private'] ) &&
547 $img->userCan( File
::DELETED_FILE
,
548 $options['private'] instanceof User ?
$options['private'] : null
560 * Get an array or iterator of file objects for files that have a given
561 * SHA-1 content hash.
564 * @param string $hash SHA-1 hash
567 public function findBySha1( $hash ) {
572 * Get an array of arrays or iterators of file objects for files that
573 * have the given SHA-1 content hashes.
575 * @param array $hashes An array of hashes
576 * @return array An Array of arrays or iterators of file objects and the hash as key
578 public function findBySha1s( array $hashes ) {
580 foreach ( $hashes as $hash ) {
581 $files = $this->findBySha1( $hash );
582 if ( count( $files ) ) {
583 $result[$hash] = $files;
591 * Return an array of files where the name starts with $prefix.
594 * @param string $prefix The prefix to search for
595 * @param int $limit The maximum amount of files to return
598 public function findFilesByPrefix( $prefix, $limit ) {
603 * Get the public root URL of the repository
605 * @deprecated since 1.20
608 public function getRootUrl() {
609 return $this->getZoneUrl( 'public' );
613 * Get the URL of thumb.php
617 public function getThumbScriptUrl() {
618 return $this->thumbScriptUrl
;
622 * Returns true if the repository can transform files via a 404 handler
626 public function canTransformVia404() {
627 return $this->transformVia404
;
631 * Get the name of a file from its title object
633 * @param Title $title
636 public function getNameFromTitle( Title
$title ) {
638 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
639 $name = $title->getUserCaseDBKey();
640 if ( $this->initialCapital
) {
641 $name = $wgContLang->ucfirst( $name );
644 $name = $title->getDBkey();
651 * Get the public zone root storage directory of the repository
655 public function getRootDirectory() {
656 return $this->getZonePath( 'public' );
660 * Get a relative path including trailing slash, e.g. f/fa/
661 * If the repo is not hashed, returns an empty string
663 * @param string $name Name of file
666 public function getHashPath( $name ) {
667 return self
::getHashPathForLevel( $name, $this->hashLevels
);
671 * Get a relative path including trailing slash, e.g. f/fa/
672 * If the repo is not hashed, returns an empty string
674 * @param string $suffix Basename of file from FileRepo::storeTemp()
677 public function getTempHashPath( $suffix ) {
678 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
679 $name = isset( $parts[1] ) ?
$parts[1] : $suffix; // hash path is not based on timestamp
680 return self
::getHashPathForLevel( $name, $this->hashLevels
);
684 * @param string $name
688 protected static function getHashPathForLevel( $name, $levels ) {
689 if ( $levels == 0 ) {
692 $hash = md5( $name );
694 for ( $i = 1; $i <= $levels; $i++
) {
695 $path .= substr( $hash, 0, $i ) . '/';
703 * Get the number of hash directory levels
707 public function getHashLevels() {
708 return $this->hashLevels
;
712 * Get the name of this repository, as specified by $info['name]' to the constructor
716 public function getName() {
721 * Make an url to this repo
723 * @param string $query Query string to append
724 * @param string $entry Entry point; defaults to index
725 * @return string|bool False on failure
727 public function makeUrl( $query = '', $entry = 'index' ) {
728 if ( isset( $this->scriptDirUrl
) ) {
729 $ext = isset( $this->scriptExtension
) ?
$this->scriptExtension
: '.php';
731 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
738 * Get the URL of an image description page. May return false if it is
739 * unknown or not applicable. In general this should only be called by the
740 * File class, since it may return invalid results for certain kinds of
741 * repositories. Use File::getDescriptionUrl() in user code.
743 * In particular, it uses the article paths as specified to the repository
744 * constructor, whereas local repositories use the local Title functions.
746 * @param string $name
749 public function getDescriptionUrl( $name ) {
750 $encName = wfUrlencode( $name );
751 if ( !is_null( $this->descBaseUrl
) ) {
752 # "http://example.com/wiki/File:"
753 return $this->descBaseUrl
. $encName;
755 if ( !is_null( $this->articleUrl
) ) {
756 # "http://example.com/wiki/$1"
758 # We use "Image:" as the canonical namespace for
759 # compatibility across all MediaWiki versions.
760 return str_replace( '$1',
761 "Image:$encName", $this->articleUrl
);
763 if ( !is_null( $this->scriptDirUrl
) ) {
764 # "http://example.com/w"
766 # We use "Image:" as the canonical namespace for
767 # compatibility across all MediaWiki versions,
768 # and just sort of hope index.php is right. ;)
769 return $this->makeUrl( "title=Image:$encName" );
776 * Get the URL of the content-only fragment of the description page. For
777 * MediaWiki this means action=render. This should only be called by the
778 * repository's file class, since it may return invalid results. User code
779 * should use File::getDescriptionText().
781 * @param string $name Name of image to fetch
782 * @param string $lang Language to fetch it in, if any.
785 public function getDescriptionRenderUrl( $name, $lang = null ) {
786 $query = 'action=render';
787 if ( !is_null( $lang ) ) {
788 $query .= '&uselang=' . $lang;
790 if ( isset( $this->scriptDirUrl
) ) {
791 return $this->makeUrl(
793 wfUrlencode( 'Image:' . $name ) .
796 $descUrl = $this->getDescriptionUrl( $name );
798 return wfAppendQuery( $descUrl, $query );
806 * Get the URL of the stylesheet to apply to description pages
808 * @return string|bool False on failure
810 public function getDescriptionStylesheetUrl() {
811 if ( isset( $this->scriptDirUrl
) ) {
812 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
813 wfArrayToCgi( Skin
::getDynamicStylesheetQuery() ) );
820 * Store a file to a given destination.
822 * @param string $srcPath Source file system path, storage path, or virtual URL
823 * @param string $dstZone Destination zone
824 * @param string $dstRel Destination relative path
825 * @param int $flags Bitwise combination of the following flags:
826 * self::DELETE_SOURCE Delete the source file after upload
827 * self::OVERWRITE Overwrite an existing destination file instead of failing
828 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
829 * same contents as the source
830 * self::SKIP_LOCKING Skip any file locking when doing the store
831 * @return FileRepoStatus
833 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
834 $this->assertWritableRepo(); // fail out if read-only
836 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
837 if ( $status->successCount
== 0 ) {
845 * Store a batch of files
847 * @param array $triplets (src, dest zone, dest rel) triplets as per store()
848 * @param int $flags Bitwise combination of the following flags:
849 * self::DELETE_SOURCE Delete the source file after upload
850 * self::OVERWRITE Overwrite an existing destination file instead of failing
851 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
852 * same contents as the source
853 * self::SKIP_LOCKING Skip any file locking when doing the store
854 * @throws MWException
855 * @return FileRepoStatus
857 public function storeBatch( array $triplets, $flags = 0 ) {
858 $this->assertWritableRepo(); // fail out if read-only
860 $status = $this->newGood();
861 $backend = $this->backend
; // convenience
863 $operations = array();
864 $sourceFSFilesToDelete = array(); // cleanup for disk source files
865 // Validate each triplet and get the store operation...
866 foreach ( $triplets as $triplet ) {
867 list( $srcPath, $dstZone, $dstRel ) = $triplet;
869 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
872 // Resolve destination path
873 $root = $this->getZonePath( $dstZone );
875 throw new MWException( "Invalid zone: $dstZone" );
877 if ( !$this->validateFilename( $dstRel ) ) {
878 throw new MWException( 'Validation error in $dstRel' );
880 $dstPath = "$root/$dstRel";
881 $dstDir = dirname( $dstPath );
882 // Create destination directories for this triplet
883 if ( !$this->initDirectory( $dstDir )->isOK() ) {
884 return $this->newFatal( 'directorycreateerror', $dstDir );
887 // Resolve source to a storage path if virtual
888 $srcPath = $this->resolveToStoragePath( $srcPath );
890 // Get the appropriate file operation
891 if ( FileBackend
::isStoragePath( $srcPath ) ) {
892 $opName = ( $flags & self
::DELETE_SOURCE
) ?
'move' : 'copy';
895 if ( $flags & self
::DELETE_SOURCE
) {
896 $sourceFSFilesToDelete[] = $srcPath;
899 $operations[] = array(
903 'overwrite' => $flags & self
::OVERWRITE
,
904 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
908 // Execute the store operation for each triplet
909 $opts = array( 'force' => true );
910 if ( $flags & self
::SKIP_LOCKING
) {
911 $opts['nonLocking'] = true;
913 $status->merge( $backend->doOperations( $operations, $opts ) );
914 // Cleanup for disk source files...
915 foreach ( $sourceFSFilesToDelete as $file ) {
916 wfSuppressWarnings();
917 unlink( $file ); // FS cleanup
925 * Deletes a batch of files.
926 * Each file can be a (zone, rel) pair, virtual url, storage path.
927 * It will try to delete each file, but ignores any errors that may occur.
929 * @param array $files List of files to delete
930 * @param int $flags Bitwise combination of the following flags:
931 * self::SKIP_LOCKING Skip any file locking when doing the deletions
932 * @return FileRepoStatus
934 public function cleanupBatch( array $files, $flags = 0 ) {
935 $this->assertWritableRepo(); // fail out if read-only
937 $status = $this->newGood();
939 $operations = array();
940 foreach ( $files as $path ) {
941 if ( is_array( $path ) ) {
942 // This is a pair, extract it
943 list( $zone, $rel ) = $path;
944 $path = $this->getZonePath( $zone ) . "/$rel";
946 // Resolve source to a storage path if virtual
947 $path = $this->resolveToStoragePath( $path );
949 $operations[] = array( 'op' => 'delete', 'src' => $path );
951 // Actually delete files from storage...
952 $opts = array( 'force' => true );
953 if ( $flags & self
::SKIP_LOCKING
) {
954 $opts['nonLocking'] = true;
956 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
962 * Import a file from the local file system into the repo.
963 * This does no locking nor journaling and overrides existing files.
964 * This function can be used to write to otherwise read-only foreign repos.
965 * This is intended for copying generated thumbnails into the repo.
967 * @param string $src Source file system path, storage path, or virtual URL
968 * @param string $dst Virtual URL or storage path
969 * @param string|null $disposition Content-Disposition if given and supported
970 * @return FileRepoStatus
972 final public function quickImport( $src, $dst, $disposition = null ) {
973 return $this->quickImportBatch( array( array( $src, $dst, $disposition ) ) );
977 * Purge a file from the repo. This does no locking nor journaling.
978 * This function can be used to write to otherwise read-only foreign repos.
979 * This is intended for purging thumbnails.
981 * @param string $path Virtual URL or storage path
982 * @return FileRepoStatus
984 final public function quickPurge( $path ) {
985 return $this->quickPurgeBatch( array( $path ) );
989 * Deletes a directory if empty.
990 * This function can be used to write to otherwise read-only foreign repos.
992 * @param string $dir Virtual URL (or storage path) of directory to clean
995 public function quickCleanDir( $dir ) {
996 $status = $this->newGood();
997 $status->merge( $this->backend
->clean(
998 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1004 * Import a batch of files from the local file system into the repo.
1005 * This does no locking nor journaling and overrides existing files.
1006 * This function can be used to write to otherwise read-only foreign repos.
1007 * This is intended for copying generated thumbnails into the repo.
1009 * All path parameters may be a file system path, storage path, or virtual URL.
1010 * When "dispositions" are given they are used as Content-Disposition if supported.
1012 * @param array $triples List of (source path, destination path, disposition)
1013 * @return FileRepoStatus
1015 public function quickImportBatch( array $triples ) {
1016 $status = $this->newGood();
1017 $operations = array();
1018 foreach ( $triples as $triple ) {
1019 list( $src, $dst ) = $triple;
1020 $src = $this->resolveToStoragePath( $src );
1021 $dst = $this->resolveToStoragePath( $dst );
1022 $operations[] = array(
1023 'op' => FileBackend
::isStoragePath( $src ) ?
'copy' : 'store',
1026 'disposition' => isset( $triple[2] ) ?
$triple[2] : null
1028 $status->merge( $this->initDirectory( dirname( $dst ) ) );
1030 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1036 * Purge a batch of files from the repo.
1037 * This function can be used to write to otherwise read-only foreign repos.
1038 * This does no locking nor journaling and is intended for purging thumbnails.
1040 * @param array $paths List of virtual URLs or storage paths
1041 * @return FileRepoStatus
1043 public function quickPurgeBatch( array $paths ) {
1044 $status = $this->newGood();
1045 $operations = array();
1046 foreach ( $paths as $path ) {
1047 $operations[] = array(
1049 'src' => $this->resolveToStoragePath( $path ),
1050 'ignoreMissingSource' => true
1053 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1059 * Pick a random name in the temp zone and store a file to it.
1060 * Returns a FileRepoStatus object with the file Virtual URL in the value,
1061 * file can later be disposed using FileRepo::freeTemp().
1063 * @param string $originalName the base name of the file as specified
1064 * by the user. The file extension will be maintained.
1065 * @param string $srcPath The current location of the file.
1066 * @return FileRepoStatus Object with the URL in the value.
1068 public function storeTemp( $originalName, $srcPath ) {
1069 $this->assertWritableRepo(); // fail out if read-only
1071 $date = MWTimestamp
::getInstance()->format( 'YmdHis' );
1072 $hashPath = $this->getHashPath( $originalName );
1073 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1074 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1076 $result = $this->quickImport( $srcPath, $virtualUrl );
1077 $result->value
= $virtualUrl;
1083 * Remove a temporary file or mark it for garbage collection
1085 * @param string $virtualUrl The virtual URL returned by FileRepo::storeTemp()
1086 * @return bool True on success, false on failure
1088 public function freeTemp( $virtualUrl ) {
1089 $this->assertWritableRepo(); // fail out if read-only
1091 $temp = $this->getVirtualUrl( 'temp' );
1092 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1093 wfDebug( __METHOD__
. ": Invalid temp virtual URL\n" );
1098 return $this->quickPurge( $virtualUrl )->isOK();
1102 * Concatenate a list of temporary files into a target file location.
1104 * @param array $srcPaths Ordered list of source virtual URLs/storage paths
1105 * @param string $dstPath Target file system path
1106 * @param int $flags Bitwise combination of the following flags:
1107 * self::DELETE_SOURCE Delete the source files
1108 * @return FileRepoStatus
1110 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1111 $this->assertWritableRepo(); // fail out if read-only
1113 $status = $this->newGood();
1116 foreach ( $srcPaths as $srcPath ) {
1117 // Resolve source to a storage path if virtual
1118 $source = $this->resolveToStoragePath( $srcPath );
1119 $sources[] = $source; // chunk to merge
1122 // Concatenate the chunks into one FS file
1123 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
1124 $status->merge( $this->backend
->concatenate( $params ) );
1125 if ( !$status->isOK() ) {
1129 // Delete the sources if required
1130 if ( $flags & self
::DELETE_SOURCE
) {
1131 $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1134 // Make sure status is OK, despite any quickPurgeBatch() fatals
1135 $status->setResult( true );
1141 * Copy or move a file either from a storage path, virtual URL,
1142 * or file system path, into this repository at the specified destination location.
1144 * Returns a FileRepoStatus object. On success, the value contains "new" or
1145 * "archived", to indicate whether the file was new with that name.
1147 * Options to $options include:
1148 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1150 * @param string $srcPath The source file system path, storage path, or URL
1151 * @param string $dstRel The destination relative path
1152 * @param string $archiveRel The relative path where the existing file is to
1153 * be archived, if there is one. Relative to the public zone root.
1154 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1155 * that the source file should be deleted if possible
1156 * @param array $options Optional additional parameters
1157 * @return FileRepoStatus
1159 public function publish(
1160 $srcPath, $dstRel, $archiveRel, $flags = 0, array $options = array()
1162 $this->assertWritableRepo(); // fail out if read-only
1164 $status = $this->publishBatch(
1165 array( array( $srcPath, $dstRel, $archiveRel, $options ) ), $flags );
1166 if ( $status->successCount
== 0 ) {
1167 $status->ok
= false;
1169 if ( isset( $status->value
[0] ) ) {
1170 $status->value
= $status->value
[0];
1172 $status->value
= false;
1179 * Publish a batch of files
1181 * @param array $ntuples (source, dest, archive) triplets or
1182 * (source, dest, archive, options) 4-tuples as per publish().
1183 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1184 * that the source files should be deleted if possible
1185 * @throws MWException
1186 * @return FileRepoStatus
1188 public function publishBatch( array $ntuples, $flags = 0 ) {
1189 $this->assertWritableRepo(); // fail out if read-only
1191 $backend = $this->backend
; // convenience
1192 // Try creating directories
1193 $status = $this->initZones( 'public' );
1194 if ( !$status->isOK() ) {
1198 $status = $this->newGood( array() );
1200 $operations = array();
1201 $sourceFSFilesToDelete = array(); // cleanup for disk source files
1202 // Validate each triplet and get the store operation...
1203 foreach ( $ntuples as $ntuple ) {
1204 list( $srcPath, $dstRel, $archiveRel ) = $ntuple;
1205 $options = isset( $ntuple[3] ) ?
$ntuple[3] : array();
1206 // Resolve source to a storage path if virtual
1207 $srcPath = $this->resolveToStoragePath( $srcPath );
1208 if ( !$this->validateFilename( $dstRel ) ) {
1209 throw new MWException( 'Validation error in $dstRel' );
1211 if ( !$this->validateFilename( $archiveRel ) ) {
1212 throw new MWException( 'Validation error in $archiveRel' );
1215 $publicRoot = $this->getZonePath( 'public' );
1216 $dstPath = "$publicRoot/$dstRel";
1217 $archivePath = "$publicRoot/$archiveRel";
1219 $dstDir = dirname( $dstPath );
1220 $archiveDir = dirname( $archivePath );
1221 // Abort immediately on directory creation errors since they're likely to be repetitive
1222 if ( !$this->initDirectory( $dstDir )->isOK() ) {
1223 return $this->newFatal( 'directorycreateerror', $dstDir );
1225 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1226 return $this->newFatal( 'directorycreateerror', $archiveDir );
1229 // Set any desired headers to be use in GET/HEAD responses
1230 $headers = isset( $options['headers'] ) ?
$options['headers'] : array();
1232 // Archive destination file if it exists.
1233 // This will check if the archive file also exists and fail if does.
1234 // This is a sanity check to avoid data loss. On Windows and Linux,
1235 // copy() will overwrite, so the existence check is vulnerable to
1236 // race conditions unless an functioning LockManager is used.
1237 // LocalFile also uses SELECT FOR UPDATE for synchronization.
1238 $operations[] = array(
1241 'dst' => $archivePath,
1242 'ignoreMissingSource' => true
1245 // Copy (or move) the source file to the destination
1246 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1247 if ( $flags & self
::DELETE_SOURCE
) {
1248 $operations[] = array(
1252 'overwrite' => true, // replace current
1253 'headers' => $headers
1256 $operations[] = array(
1260 'overwrite' => true, // replace current
1261 'headers' => $headers
1264 } else { // FS source path
1265 $operations[] = array(
1269 'overwrite' => true, // replace current
1270 'headers' => $headers
1272 if ( $flags & self
::DELETE_SOURCE
) {
1273 $sourceFSFilesToDelete[] = $srcPath;
1278 // Execute the operations for each triplet
1279 $status->merge( $backend->doOperations( $operations ) );
1280 // Find out which files were archived...
1281 foreach ( $ntuples as $i => $ntuple ) {
1282 list( , , $archiveRel ) = $ntuple;
1283 $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1284 if ( $this->fileExists( $archivePath ) ) {
1285 $status->value
[$i] = 'archived';
1287 $status->value
[$i] = 'new';
1290 // Cleanup for disk source files...
1291 foreach ( $sourceFSFilesToDelete as $file ) {
1292 wfSuppressWarnings();
1293 unlink( $file ); // FS cleanup
1294 wfRestoreWarnings();
1301 * Creates a directory with the appropriate zone permissions.
1302 * Callers are responsible for doing read-only and "writable repo" checks.
1304 * @param string $dir Virtual URL (or storage path) of directory to clean
1307 protected function initDirectory( $dir ) {
1308 $path = $this->resolveToStoragePath( $dir );
1309 list( , $container, ) = FileBackend
::splitStoragePath( $path );
1311 $params = array( 'dir' => $path );
1312 if ( $this->isPrivate ||
$container === $this->zones
['deleted']['container'] ) {
1313 # Take all available measures to prevent web accessibility of new deleted
1314 # directories, in case the user has not configured offline storage
1315 $params = array( 'noAccess' => true, 'noListing' => true ) +
$params;
1318 return $this->backend
->prepare( $params );
1322 * Deletes a directory if empty.
1324 * @param string $dir Virtual URL (or storage path) of directory to clean
1327 public function cleanDir( $dir ) {
1328 $this->assertWritableRepo(); // fail out if read-only
1330 $status = $this->newGood();
1331 $status->merge( $this->backend
->clean(
1332 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1338 * Checks existence of a a file
1340 * @param string $file Virtual URL (or storage path) of file to check
1343 public function fileExists( $file ) {
1344 $result = $this->fileExistsBatch( array( $file ) );
1350 * Checks existence of an array of files.
1352 * @param array $files Virtual URLs (or storage paths) of files to check
1353 * @return array|bool Either array of files and existence flags, or false
1355 public function fileExistsBatch( array $files ) {
1357 foreach ( $files as $key => $file ) {
1358 $file = $this->resolveToStoragePath( $file );
1359 $result[$key] = $this->backend
->fileExists( array( 'src' => $file ) );
1366 * Move a file to the deletion archive.
1367 * If no valid deletion archive exists, this may either delete the file
1368 * or throw an exception, depending on the preference of the repository
1370 * @param mixed $srcRel Relative path for the file to be deleted
1371 * @param mixed $archiveRel Relative path for the archive location.
1372 * Relative to a private archive directory.
1373 * @return FileRepoStatus object
1375 public function delete( $srcRel, $archiveRel ) {
1376 $this->assertWritableRepo(); // fail out if read-only
1378 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1382 * Move a group of files to the deletion archive.
1384 * If no valid deletion archive is configured, this may either delete the
1385 * file or throw an exception, depending on the preference of the repository.
1387 * The overwrite policy is determined by the repository -- currently LocalRepo
1388 * assumes a naming scheme in the deleted zone based on content hash, as
1389 * opposed to the public zone which is assumed to be unique.
1391 * @param array $sourceDestPairs Array of source/destination pairs. Each element
1392 * is a two-element array containing the source file path relative to the
1393 * public root in the first element, and the archive file path relative
1394 * to the deleted zone root in the second element.
1395 * @throws MWException
1396 * @return FileRepoStatus
1398 public function deleteBatch( array $sourceDestPairs ) {
1399 $this->assertWritableRepo(); // fail out if read-only
1401 // Try creating directories
1402 $status = $this->initZones( array( 'public', 'deleted' ) );
1403 if ( !$status->isOK() ) {
1407 $status = $this->newGood();
1409 $backend = $this->backend
; // convenience
1410 $operations = array();
1411 // Validate filenames and create archive directories
1412 foreach ( $sourceDestPairs as $pair ) {
1413 list( $srcRel, $archiveRel ) = $pair;
1414 if ( !$this->validateFilename( $srcRel ) ) {
1415 throw new MWException( __METHOD__
. ':Validation error in $srcRel' );
1416 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1417 throw new MWException( __METHOD__
. ':Validation error in $archiveRel' );
1420 $publicRoot = $this->getZonePath( 'public' );
1421 $srcPath = "{$publicRoot}/$srcRel";
1423 $deletedRoot = $this->getZonePath( 'deleted' );
1424 $archivePath = "{$deletedRoot}/{$archiveRel}";
1425 $archiveDir = dirname( $archivePath ); // does not touch FS
1427 // Create destination directories
1428 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1429 return $this->newFatal( 'directorycreateerror', $archiveDir );
1432 $operations[] = array(
1435 'dst' => $archivePath,
1436 // We may have 2+ identical files being deleted,
1437 // all of which will map to the same destination file
1438 'overwriteSame' => true // also see bug 31792
1442 // Move the files by execute the operations for each pair.
1443 // We're now committed to returning an OK result, which will
1444 // lead to the files being moved in the DB also.
1445 $opts = array( 'force' => true );
1446 $status->merge( $backend->doOperations( $operations, $opts ) );
1452 * Delete files in the deleted directory if they are not referenced in the filearchive table
1456 public function cleanupDeletedBatch( array $storageKeys ) {
1457 $this->assertWritableRepo();
1461 * Get a relative path for a deletion archive key,
1462 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1464 * @param string $key
1465 * @throws MWException
1468 public function getDeletedHashPath( $key ) {
1469 if ( strlen( $key ) < 31 ) {
1470 throw new MWException( "Invalid storage key '$key'." );
1473 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1474 $path .= $key[$i] . '/';
1481 * If a path is a virtual URL, resolve it to a storage path.
1482 * Otherwise, just return the path as it is.
1484 * @param string $path
1486 * @throws MWException
1488 protected function resolveToStoragePath( $path ) {
1489 if ( $this->isVirtualUrl( $path ) ) {
1490 return $this->resolveVirtualUrl( $path );
1497 * Get a local FS copy of a file with a given virtual URL/storage path.
1498 * Temporary files may be purged when the file object falls out of scope.
1500 * @param string $virtualUrl
1501 * @return TempFSFile|null Returns null on failure
1503 public function getLocalCopy( $virtualUrl ) {
1504 $path = $this->resolveToStoragePath( $virtualUrl );
1506 return $this->backend
->getLocalCopy( array( 'src' => $path ) );
1510 * Get a local FS file with a given virtual URL/storage path.
1511 * The file is either an original or a copy. It should not be changed.
1512 * Temporary files may be purged when the file object falls out of scope.
1514 * @param string $virtualUrl
1515 * @return FSFile|null Returns null on failure.
1517 public function getLocalReference( $virtualUrl ) {
1518 $path = $this->resolveToStoragePath( $virtualUrl );
1520 return $this->backend
->getLocalReference( array( 'src' => $path ) );
1524 * Get properties of a file with a given virtual URL/storage path.
1525 * Properties should ultimately be obtained via FSFile::getProps().
1527 * @param string $virtualUrl
1530 public function getFileProps( $virtualUrl ) {
1531 $path = $this->resolveToStoragePath( $virtualUrl );
1533 return $this->backend
->getFileProps( array( 'src' => $path ) );
1537 * Get the timestamp of a file with a given virtual URL/storage path
1539 * @param string $virtualUrl
1540 * @return string|bool False on failure
1542 public function getFileTimestamp( $virtualUrl ) {
1543 $path = $this->resolveToStoragePath( $virtualUrl );
1545 return $this->backend
->getFileTimestamp( array( 'src' => $path ) );
1549 * Get the size of a file with a given virtual URL/storage path
1551 * @param string $virtualUrl
1552 * @return integer|bool False on failure
1554 public function getFileSize( $virtualUrl ) {
1555 $path = $this->resolveToStoragePath( $virtualUrl );
1557 return $this->backend
->getFileSize( array( 'src' => $path ) );
1561 * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1563 * @param string $virtualUrl
1564 * @return string|bool
1566 public function getFileSha1( $virtualUrl ) {
1567 $path = $this->resolveToStoragePath( $virtualUrl );
1569 return $this->backend
->getFileSha1Base36( array( 'src' => $path ) );
1573 * Attempt to stream a file with the given virtual URL/storage path
1575 * @param string $virtualUrl
1576 * @param array $headers Additional HTTP headers to send on success
1577 * @return bool Success
1579 public function streamFile( $virtualUrl, $headers = array() ) {
1580 $path = $this->resolveToStoragePath( $virtualUrl );
1581 $params = array( 'src' => $path, 'headers' => $headers );
1583 return $this->backend
->streamFile( $params )->isOK();
1587 * Call a callback function for every public regular file in the repository.
1588 * This only acts on the current version of files, not any old versions.
1589 * May use either the database or the filesystem.
1591 * @param array|string $callback
1594 public function enumFiles( $callback ) {
1595 $this->enumFilesInStorage( $callback );
1599 * Call a callback function for every public file in the repository.
1600 * May use either the database or the filesystem.
1602 * @param array|string $callback
1605 protected function enumFilesInStorage( $callback ) {
1606 $publicRoot = $this->getZonePath( 'public' );
1607 $numDirs = 1 << ( $this->hashLevels
* 4 );
1608 // Use a priori assumptions about directory structure
1609 // to reduce the tree height of the scanning process.
1610 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1611 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1612 $path = $publicRoot;
1613 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1614 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1616 $iterator = $this->backend
->getFileList( array( 'dir' => $path ) );
1617 foreach ( $iterator as $name ) {
1618 // Each item returned is a public file
1619 call_user_func( $callback, "{$path}/{$name}" );
1625 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1627 * @param $filename string
1630 public function validateFilename( $filename ) {
1631 if ( strval( $filename ) == '' ) {
1635 return FileBackend
::isPathTraversalFree( $filename );
1639 * Get a callback function to use for cleaning error message parameters
1643 function getErrorCleanupFunction() {
1644 switch ( $this->pathDisclosureProtection
) {
1646 case 'simple': // b/c
1647 $callback = array( $this, 'passThrough' );
1649 default: // 'paranoid'
1650 $callback = array( $this, 'paranoidClean' );
1656 * Path disclosure protection function
1658 * @param string $param
1661 function paranoidClean( $param ) {
1666 * Path disclosure protection function
1668 * @param string $param
1671 function passThrough( $param ) {
1676 * Create a new fatal error
1679 * @return FileRepoStatus
1681 public function newFatal( $message /*, parameters...*/ ) {
1682 $params = func_get_args();
1683 array_unshift( $params, $this );
1685 return call_user_func_array( array( 'FileRepoStatus', 'newFatal' ), $params );
1689 * Create a new good result
1691 * @param null|string $value
1692 * @return FileRepoStatus
1694 public function newGood( $value = null ) {
1695 return FileRepoStatus
::newGood( $this, $value );
1699 * Checks if there is a redirect named as $title. If there is, return the
1700 * title object. If not, return false.
1703 * @param Title $title Title of image
1706 public function checkRedirect( Title
$title ) {
1711 * Invalidates image redirect cache related to that image
1712 * Doesn't do anything for repositories that don't support image redirects.
1715 * @param Title $title Title of image
1717 public function invalidateImageRedirect( Title
$title ) {
1721 * Get the human-readable name of the repo
1725 public function getDisplayName() {
1726 // We don't name our own repo, return nothing
1727 if ( $this->isLocal() ) {
1731 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1732 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1736 * Get the portion of the file that contains the origin file name.
1737 * If that name is too long, then the name "thumbnail.<ext>" will be given.
1739 * @param $name string
1742 public function nameForThumb( $name ) {
1743 if ( strlen( $name ) > $this->abbrvThreshold
) {
1744 $ext = FileBackend
::extensionFromPath( $name );
1745 $name = ( $ext == '' ) ?
'thumbnail' : "thumbnail.$ext";
1752 * Returns true if this the local file repository.
1756 public function isLocal() {
1757 return $this->getName() == 'local';
1761 * Get a key on the primary cache for this repository.
1762 * Returns false if the repository's cache is not accessible at this site.
1763 * The parameters are the parts of the key, as for wfMemcKey().
1768 public function getSharedCacheKey( /*...*/ ) {
1773 * Get a key for this repo in the local cache domain. These cache keys are
1774 * not shared with remote instances of the repo.
1775 * The parameters are the parts of the key, as for wfMemcKey().
1779 public function getLocalCacheKey( /*...*/ ) {
1780 $args = func_get_args();
1781 array_unshift( $args, 'filerepo', $this->getName() );
1783 return call_user_func_array( 'wfMemcKey', $args );
1787 * Get an temporary FileRepo associated with this repo.
1788 * Files will be created in the temp zone of this repo and
1789 * thumbnails in a /temp subdirectory in thumb zone of this repo.
1790 * It will have the same backend as this repo.
1792 * @return TempFileRepo
1794 public function getTempRepo() {
1795 return new TempFileRepo( array(
1796 'name' => "{$this->name}-temp",
1797 'backend' => $this->backend
,
1800 'container' => $this->zones
['temp']['container'],
1801 'directory' => $this->zones
['temp']['directory']
1804 'container' => $this->zones
['thumb']['container'],
1805 'directory' => $this->zones
['thumb']['directory'] == ''
1807 : $this->zones
['thumb']['directory'] . '/temp'
1809 'transcoded' => array(
1810 'container' => $this->zones
['transcoded']['container'],
1811 'directory' => $this->zones
['transcoded']['directory'] == ''
1813 : $this->zones
['transcoded']['directory'] . '/temp'
1816 'url' => $this->getZoneUrl( 'temp' ),
1817 'thumbUrl' => $this->getZoneUrl( 'thumb' ) . '/temp',
1818 'transcodedUrl' => $this->getZoneUrl( 'transcoded' ) . '/temp',
1819 'hashLevels' => $this->hashLevels
// performance
1824 * Get an UploadStash associated with this repo.
1827 * @return UploadStash
1829 public function getUploadStash( User
$user = null ) {
1830 return new UploadStash( $this, $user );
1834 * Throw an exception if this repo is read-only by design.
1835 * This does not and should not check getReadOnlyReason().
1838 * @throws MWException
1840 protected function assertWritableRepo() {
1844 * Return information about the repository.
1849 public function getInfo() {
1851 'name' => $this->getName(),
1852 'displayname' => $this->getDisplayName(),
1853 'rootUrl' => $this->getZoneUrl( 'public' ),
1854 'local' => $this->isLocal(),
1857 $optionalSettings = array(
1858 'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1859 'fetchDescription', 'descriptionCacheExpiry', 'scriptExtension', 'favicon'
1861 foreach ( $optionalSettings as $k ) {
1862 if ( isset( $this->$k ) ) {
1863 $ret[$k] = $this->$k;
1872 * FileRepo for temporary files created via FileRepo::getTempRepo()
1874 class TempFileRepo
extends FileRepo
{
1875 public function getTempRepo() {
1876 throw new MWException( "Cannot get a temp repo from a temp repo." );