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;
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;
115 * Factory functions for creating new files
116 * Override these in the base class
118 protected $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
119 protected $oldFileFactory = false;
120 protected $fileFactoryKey = false;
121 protected $oldFileFactoryKey = false;
124 * @param array|null $info
125 * @throws MWException
127 public function __construct( array $info = null ) {
128 // Verify required settings presence
131 ||
!array_key_exists( 'name', $info )
132 ||
!array_key_exists( 'backend', $info )
134 throw new MWException( __CLASS__
.
135 " requires an array of options having both 'name' and 'backend' keys.\n" );
139 $this->name
= $info['name'];
140 if ( $info['backend'] instanceof FileBackend
) {
141 $this->backend
= $info['backend']; // useful for testing
143 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
146 // Optional settings that can have no value
147 $optionalSettings = array(
148 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
149 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
152 foreach ( $optionalSettings as $var ) {
153 if ( isset( $info[$var] ) ) {
154 $this->$var = $info[$var];
158 // Optional settings that have a default
159 $this->initialCapital
= isset( $info['initialCapital'] )
160 ?
$info['initialCapital']
161 : MWNamespace
::isCapitalized( NS_FILE
);
162 $this->url
= isset( $info['url'] )
164 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
165 if ( isset( $info['thumbUrl'] ) ) {
166 $this->thumbUrl
= $info['thumbUrl'];
168 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
170 $this->hashLevels
= isset( $info['hashLevels'] )
171 ?
$info['hashLevels']
173 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
174 ?
$info['deletedHashLevels']
176 $this->transformVia404
= !empty( $info['transformVia404'] );
177 $this->abbrvThreshold
= isset( $info['abbrvThreshold'] )
178 ?
$info['abbrvThreshold']
180 $this->isPrivate
= !empty( $info['isPrivate'] );
181 // Give defaults for the basic zones...
182 $this->zones
= isset( $info['zones'] ) ?
$info['zones'] : array();
183 foreach ( array( 'public', 'thumb', 'transcoded', 'temp', 'deleted' ) as $zone ) {
184 if ( !isset( $this->zones
[$zone]['container'] ) ) {
185 $this->zones
[$zone]['container'] = "{$this->name}-{$zone}";
187 if ( !isset( $this->zones
[$zone]['directory'] ) ) {
188 $this->zones
[$zone]['directory'] = '';
190 if ( !isset( $this->zones
[$zone]['urlsByExt'] ) ) {
191 $this->zones
[$zone]['urlsByExt'] = array();
197 * Get the file backend instance. Use this function wisely.
199 * @return FileBackend
201 public function getBackend() {
202 return $this->backend
;
206 * Get an explanatory message if this repo is read-only.
207 * This checks if an administrator disabled writes to the backend.
209 * @return string|bool Returns false if the repo is not read-only
211 public function getReadOnlyReason() {
212 return $this->backend
->getReadOnlyReason();
216 * Check if a single zone or list of zones is defined for usage
218 * @param array $doZones Only do a particular zones
219 * @throws MWException
222 protected function initZones( $doZones = array() ) {
223 $status = $this->newGood();
224 foreach ( (array)$doZones as $zone ) {
225 $root = $this->getZonePath( $zone );
226 if ( $root === null ) {
227 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
235 * Determine if a string is an mwrepo:// URL
240 public static function isVirtualUrl( $url ) {
241 return substr( $url, 0, 9 ) == 'mwrepo://';
245 * Get a URL referring to this repository, with the private mwrepo protocol.
246 * The suffix, if supplied, is considered to be unencoded, and will be
247 * URL-encoded before being returned.
249 * @param string|bool $suffix
252 public function getVirtualUrl( $suffix = false ) {
253 $path = 'mwrepo://' . $this->name
;
254 if ( $suffix !== false ) {
255 $path .= '/' . rawurlencode( $suffix );
262 * Get the URL corresponding to one of the four basic zones
264 * @param string $zone One of: public, deleted, temp, thumb
265 * @param string|null $ext Optional file extension
266 * @return string|bool
268 public function getZoneUrl( $zone, $ext = null ) {
269 if ( in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) ) ) {
270 // standard public zones
271 if ( $ext !== null && isset( $this->zones
[$zone]['urlsByExt'][$ext] ) ) {
272 // custom URL for extension/zone
273 return $this->zones
[$zone]['urlsByExt'][$ext];
274 } elseif ( isset( $this->zones
[$zone]['url'] ) ) {
275 // custom URL for zone
276 return $this->zones
[$zone]['url'];
283 return "{$this->url}/temp";
285 return false; // no public URL
287 return $this->thumbUrl
;
289 return "{$this->url}/transcoded";
296 * Get the thumb zone URL configured to be handled by scripts like thumb_handler.php.
297 * This is probably only useful for internal requests, such as from a fast frontend server
298 * to a slower backend server.
300 * Large sites may use a different host name for uploads than for wikis. In any case, the
301 * wiki configuration is needed in order to use thumb.php. To avoid extracting the wiki ID
302 * from the URL path, one can configure thumb_handler.php to recognize a special path on the
303 * same host name as the wiki that is used for viewing thumbnails.
305 * @param string $zone one of: public, deleted, temp, thumb
306 * @return string|bool String or false
308 public function getZoneHandlerUrl( $zone ) {
309 if ( isset( $this->zones
[$zone]['handlerUrl'] )
310 && in_array( $zone, array( 'public', 'temp', 'thumb', 'transcoded' ) )
312 return $this->zones
[$zone]['handlerUrl'];
319 * Get the backend storage path corresponding to a virtual URL.
320 * Use this function wisely.
323 * @throws MWException
326 public function resolveVirtualUrl( $url ) {
327 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
328 throw new MWException( __METHOD__
. ': unknown protocol' );
330 $bits = explode( '/', substr( $url, 9 ), 3 );
331 if ( count( $bits ) != 3 ) {
332 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
334 list( $repo, $zone, $rel ) = $bits;
335 if ( $repo !== $this->name
) {
336 throw new MWException( __METHOD__
. ": fetching from a foreign repo is not supported" );
338 $base = $this->getZonePath( $zone );
340 throw new MWException( __METHOD__
. ": invalid zone: $zone" );
343 return $base . '/' . rawurldecode( $rel );
347 * The the storage container and base path of a zone
349 * @param string $zone
350 * @return array (container, base path) or (null, null)
352 protected function getZoneLocation( $zone ) {
353 if ( !isset( $this->zones
[$zone] ) ) {
354 return array( null, null ); // bogus
357 return array( $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] );
361 * Get the storage path corresponding to one of the zones
363 * @param string $zone
364 * @return string|null Returns null if the zone is not defined
366 public function getZonePath( $zone ) {
367 list( $container, $base ) = $this->getZoneLocation( $zone );
368 if ( $container === null ||
$base === null ) {
371 $backendName = $this->backend
->getName();
372 if ( $base != '' ) { // may not be set
376 return "mwstore://$backendName/{$container}{$base}";
380 * Create a new File object from the local repository
382 * @param Title|string $title Title object or string
383 * @param bool|string $time Time at which the image was uploaded. If this
384 * is specified, the returned object will be an instance of the
385 * repository's old file class instead of a current file. Repositories
386 * not supporting version control should return false if this parameter
388 * @return File|null A File, or null if passed an invalid Title
390 public function newFile( $title, $time = false ) {
391 $title = File
::normalizeTitle( $title );
396 if ( $this->oldFileFactory
) {
397 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
402 return call_user_func( $this->fileFactory
, $title, $this );
407 * Find an instance of the named file created at the specified time
408 * Returns false if the file does not exist. Repositories not supporting
409 * version control should return false if the time is specified.
411 * @param Title|string $title Title object or string
412 * @param array $options Associative array of options:
413 * time: requested time for a specific file version, or false for the
414 * current version. An image object will be returned which was
415 * created at the specified time (which may be archived or current).
416 * ignoreRedirect: If true, do not follow file redirects
417 * private: If true, return restricted (deleted) files if the current
418 * user is allowed to view them. Otherwise, such files will not
420 * @return File|bool False on failure
422 public function findFile( $title, $options = array() ) {
423 $title = File
::normalizeTitle( $title );
427 $time = isset( $options['time'] ) ?
$options['time'] : false;
428 # First try the current version of the file to see if it precedes the timestamp
429 $img = $this->newFile( $title );
433 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
436 # Now try an old version of the file
437 if ( $time !== false ) {
438 $img = $this->newFile( $title, $time );
439 if ( $img && $img->exists() ) {
440 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
441 return $img; // always OK
442 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
449 if ( !empty( $options['ignoreRedirect'] ) ) {
452 $redir = $this->checkRedirect( $title );
453 if ( $redir && $title->getNamespace() == NS_FILE
) {
454 $img = $this->newFile( $redir );
458 if ( $img->exists() ) {
459 $img->redirectedFrom( $title->getDBkey() );
469 * Find many files at once.
471 * @param array $items An array of titles, or an array of findFile() options with
472 * the "title" option giving the title. Example:
474 * $findItem = array( 'title' => $title, 'private' => true );
475 * $findBatch = array( $findItem );
476 * $repo->findFiles( $findBatch );
478 * No title should appear in $items twice, as the result use titles as keys
479 * @param int $flags Supports:
480 * - FileRepo::TIME_ONLY : return a (file name => timestamp) map instead
481 * @return array Map of (file name => File objects) for matches
483 public function findFiles( array $items, $flags = 0 ) {
485 foreach ( $items as $item ) {
486 if ( is_array( $item ) ) {
487 $title = $item['title'];
489 unset( $options['title'] );
494 $file = $this->findFile( $title, $options );
496 $result[$title->getDBkey()] =
497 ( $flags & self
::TIME_ONLY
) ?
$file->getTimestamp() : $file;
505 * Find an instance of the file with this key, created at the specified time
506 * Returns false if the file does not exist. Repositories not supporting
507 * version control should return false if the time is specified.
509 * @param string $sha1 Base 36 SHA-1 hash
510 * @param array $options Option array, same as findFile().
511 * @return File|bool False on failure
513 public function findFileFromKey( $sha1, $options = array() ) {
514 $time = isset( $options['time'] ) ?
$options['time'] : false;
515 # First try to find a matching current version of a file...
516 if ( $this->fileFactoryKey
) {
517 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
519 return false; // find-by-sha1 not supported
521 if ( $img && $img->exists() ) {
524 # Now try to find a matching old version of a file...
525 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
526 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
527 if ( $img && $img->exists() ) {
528 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
529 return $img; // always OK
530 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
540 * Get an array or iterator of file objects for files that have a given
541 * SHA-1 content hash.
544 * @param string $hash SHA-1 hash
547 public function findBySha1( $hash ) {
552 * Get an array of arrays or iterators of file objects for files that
553 * have the given SHA-1 content hashes.
555 * @param array $hashes An array of hashes
556 * @return array An Array of arrays or iterators of file objects and the hash as key
558 public function findBySha1s( array $hashes ) {
560 foreach ( $hashes as $hash ) {
561 $files = $this->findBySha1( $hash );
562 if ( count( $files ) ) {
563 $result[$hash] = $files;
571 * Return an array of files where the name starts with $prefix.
574 * @param string $prefix The prefix to search for
575 * @param int $limit The maximum amount of files to return
578 public function findFilesByPrefix( $prefix, $limit ) {
583 * Get the public root URL of the repository
585 * @deprecated since 1.20
588 public function getRootUrl() {
589 return $this->getZoneUrl( 'public' );
593 * Get the URL of thumb.php
597 public function getThumbScriptUrl() {
598 return $this->thumbScriptUrl
;
602 * Returns true if the repository can transform files via a 404 handler
606 public function canTransformVia404() {
607 return $this->transformVia404
;
611 * Get the name of a file from its title object
613 * @param Title $title
616 public function getNameFromTitle( Title
$title ) {
618 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
619 $name = $title->getUserCaseDBKey();
620 if ( $this->initialCapital
) {
621 $name = $wgContLang->ucfirst( $name );
624 $name = $title->getDBkey();
631 * Get the public zone root storage directory of the repository
635 public function getRootDirectory() {
636 return $this->getZonePath( 'public' );
640 * Get a relative path including trailing slash, e.g. f/fa/
641 * If the repo is not hashed, returns an empty string
643 * @param string $name Name of file
646 public function getHashPath( $name ) {
647 return self
::getHashPathForLevel( $name, $this->hashLevels
);
651 * Get a relative path including trailing slash, e.g. f/fa/
652 * If the repo is not hashed, returns an empty string
654 * @param string $suffix Basename of file from FileRepo::storeTemp()
657 public function getTempHashPath( $suffix ) {
658 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
659 $name = isset( $parts[1] ) ?
$parts[1] : $suffix; // hash path is not based on timestamp
660 return self
::getHashPathForLevel( $name, $this->hashLevels
);
664 * @param string $name
668 protected static function getHashPathForLevel( $name, $levels ) {
669 if ( $levels == 0 ) {
672 $hash = md5( $name );
674 for ( $i = 1; $i <= $levels; $i++
) {
675 $path .= substr( $hash, 0, $i ) . '/';
683 * Get the number of hash directory levels
687 public function getHashLevels() {
688 return $this->hashLevels
;
692 * Get the name of this repository, as specified by $info['name]' to the constructor
696 public function getName() {
701 * Make an url to this repo
703 * @param string $query Query string to append
704 * @param string $entry Entry point; defaults to index
705 * @return string|bool False on failure
707 public function makeUrl( $query = '', $entry = 'index' ) {
708 if ( isset( $this->scriptDirUrl
) ) {
709 $ext = isset( $this->scriptExtension
) ?
$this->scriptExtension
: '.php';
711 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
718 * Get the URL of an image description page. May return false if it is
719 * unknown or not applicable. In general this should only be called by the
720 * File class, since it may return invalid results for certain kinds of
721 * repositories. Use File::getDescriptionUrl() in user code.
723 * In particular, it uses the article paths as specified to the repository
724 * constructor, whereas local repositories use the local Title functions.
726 * @param string $name
729 public function getDescriptionUrl( $name ) {
730 $encName = wfUrlencode( $name );
731 if ( !is_null( $this->descBaseUrl
) ) {
732 # "http://example.com/wiki/File:"
733 return $this->descBaseUrl
. $encName;
735 if ( !is_null( $this->articleUrl
) ) {
736 # "http://example.com/wiki/$1"
738 # We use "Image:" as the canonical namespace for
739 # compatibility across all MediaWiki versions.
740 return str_replace( '$1',
741 "Image:$encName", $this->articleUrl
);
743 if ( !is_null( $this->scriptDirUrl
) ) {
744 # "http://example.com/w"
746 # We use "Image:" as the canonical namespace for
747 # compatibility across all MediaWiki versions,
748 # and just sort of hope index.php is right. ;)
749 return $this->makeUrl( "title=Image:$encName" );
756 * Get the URL of the content-only fragment of the description page. For
757 * MediaWiki this means action=render. This should only be called by the
758 * repository's file class, since it may return invalid results. User code
759 * should use File::getDescriptionText().
761 * @param string $name Name of image to fetch
762 * @param string $lang Language to fetch it in, if any.
765 public function getDescriptionRenderUrl( $name, $lang = null ) {
766 $query = 'action=render';
767 if ( !is_null( $lang ) ) {
768 $query .= '&uselang=' . $lang;
770 if ( isset( $this->scriptDirUrl
) ) {
771 return $this->makeUrl(
773 wfUrlencode( 'Image:' . $name ) .
776 $descUrl = $this->getDescriptionUrl( $name );
778 return wfAppendQuery( $descUrl, $query );
786 * Get the URL of the stylesheet to apply to description pages
788 * @return string|bool False on failure
790 public function getDescriptionStylesheetUrl() {
791 if ( isset( $this->scriptDirUrl
) ) {
792 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
793 wfArrayToCgi( Skin
::getDynamicStylesheetQuery() ) );
800 * Store a file to a given destination.
802 * @param string $srcPath Source file system path, storage path, or virtual URL
803 * @param string $dstZone Destination zone
804 * @param string $dstRel Destination relative path
805 * @param int $flags Bitwise combination of the following flags:
806 * self::DELETE_SOURCE Delete the source file after upload
807 * self::OVERWRITE Overwrite an existing destination file instead of failing
808 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
809 * same contents as the source
810 * self::SKIP_LOCKING Skip any file locking when doing the store
811 * @return FileRepoStatus
813 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
814 $this->assertWritableRepo(); // fail out if read-only
816 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
817 if ( $status->successCount
== 0 ) {
825 * Store a batch of files
827 * @param array $triplets (src, dest zone, dest rel) triplets as per store()
828 * @param int $flags Bitwise combination of the following flags:
829 * self::DELETE_SOURCE Delete the source file after upload
830 * self::OVERWRITE Overwrite an existing destination file instead of failing
831 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
832 * same contents as the source
833 * self::SKIP_LOCKING Skip any file locking when doing the store
834 * @throws MWException
835 * @return FileRepoStatus
837 public function storeBatch( array $triplets, $flags = 0 ) {
838 $this->assertWritableRepo(); // fail out if read-only
840 $status = $this->newGood();
841 $backend = $this->backend
; // convenience
843 $operations = array();
844 $sourceFSFilesToDelete = array(); // cleanup for disk source files
845 // Validate each triplet and get the store operation...
846 foreach ( $triplets as $triplet ) {
847 list( $srcPath, $dstZone, $dstRel ) = $triplet;
849 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
852 // Resolve destination path
853 $root = $this->getZonePath( $dstZone );
855 throw new MWException( "Invalid zone: $dstZone" );
857 if ( !$this->validateFilename( $dstRel ) ) {
858 throw new MWException( 'Validation error in $dstRel' );
860 $dstPath = "$root/$dstRel";
861 $dstDir = dirname( $dstPath );
862 // Create destination directories for this triplet
863 if ( !$this->initDirectory( $dstDir )->isOK() ) {
864 return $this->newFatal( 'directorycreateerror', $dstDir );
867 // Resolve source to a storage path if virtual
868 $srcPath = $this->resolveToStoragePath( $srcPath );
870 // Get the appropriate file operation
871 if ( FileBackend
::isStoragePath( $srcPath ) ) {
872 $opName = ( $flags & self
::DELETE_SOURCE
) ?
'move' : 'copy';
875 if ( $flags & self
::DELETE_SOURCE
) {
876 $sourceFSFilesToDelete[] = $srcPath;
879 $operations[] = array(
883 'overwrite' => $flags & self
::OVERWRITE
,
884 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
888 // Execute the store operation for each triplet
889 $opts = array( 'force' => true );
890 if ( $flags & self
::SKIP_LOCKING
) {
891 $opts['nonLocking'] = true;
893 $status->merge( $backend->doOperations( $operations, $opts ) );
894 // Cleanup for disk source files...
895 foreach ( $sourceFSFilesToDelete as $file ) {
896 wfSuppressWarnings();
897 unlink( $file ); // FS cleanup
905 * Deletes a batch of files.
906 * Each file can be a (zone, rel) pair, virtual url, storage path.
907 * It will try to delete each file, but ignores any errors that may occur.
909 * @param array $files List of files to delete
910 * @param int $flags Bitwise combination of the following flags:
911 * self::SKIP_LOCKING Skip any file locking when doing the deletions
912 * @return FileRepoStatus
914 public function cleanupBatch( array $files, $flags = 0 ) {
915 $this->assertWritableRepo(); // fail out if read-only
917 $status = $this->newGood();
919 $operations = array();
920 foreach ( $files as $path ) {
921 if ( is_array( $path ) ) {
922 // This is a pair, extract it
923 list( $zone, $rel ) = $path;
924 $path = $this->getZonePath( $zone ) . "/$rel";
926 // Resolve source to a storage path if virtual
927 $path = $this->resolveToStoragePath( $path );
929 $operations[] = array( 'op' => 'delete', 'src' => $path );
931 // Actually delete files from storage...
932 $opts = array( 'force' => true );
933 if ( $flags & self
::SKIP_LOCKING
) {
934 $opts['nonLocking'] = true;
936 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
942 * Import a file from the local file system into the repo.
943 * This does no locking nor journaling and overrides existing files.
944 * This function can be used to write to otherwise read-only foreign repos.
945 * This is intended for copying generated thumbnails into the repo.
947 * @param string $src Source file system path, storage path, or virtual URL
948 * @param string $dst Virtual URL or storage path
949 * @param string|null $disposition Content-Disposition if given and supported
950 * @return FileRepoStatus
952 final public function quickImport( $src, $dst, $disposition = null ) {
953 return $this->quickImportBatch( array( array( $src, $dst, $disposition ) ) );
957 * Purge a file from the repo. This does no locking nor journaling.
958 * This function can be used to write to otherwise read-only foreign repos.
959 * This is intended for purging thumbnails.
961 * @param string $path Virtual URL or storage path
962 * @return FileRepoStatus
964 final public function quickPurge( $path ) {
965 return $this->quickPurgeBatch( array( $path ) );
969 * Deletes a directory if empty.
970 * This function can be used to write to otherwise read-only foreign repos.
972 * @param string $dir Virtual URL (or storage path) of directory to clean
975 public function quickCleanDir( $dir ) {
976 $status = $this->newGood();
977 $status->merge( $this->backend
->clean(
978 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
984 * Import a batch of files from the local file system into the repo.
985 * This does no locking nor journaling and overrides existing files.
986 * This function can be used to write to otherwise read-only foreign repos.
987 * This is intended for copying generated thumbnails into the repo.
989 * All path parameters may be a file system path, storage path, or virtual URL.
990 * When "dispositions" are given they are used as Content-Disposition if supported.
992 * @param array $triples List of (source path, destination path, disposition)
993 * @return FileRepoStatus
995 public function quickImportBatch( array $triples ) {
996 $status = $this->newGood();
997 $operations = array();
998 foreach ( $triples as $triple ) {
999 list( $src, $dst ) = $triple;
1000 $src = $this->resolveToStoragePath( $src );
1001 $dst = $this->resolveToStoragePath( $dst );
1002 $operations[] = array(
1003 'op' => FileBackend
::isStoragePath( $src ) ?
'copy' : 'store',
1006 'disposition' => isset( $triple[2] ) ?
$triple[2] : null
1008 $status->merge( $this->initDirectory( dirname( $dst ) ) );
1010 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1016 * Purge a batch of files from the repo.
1017 * This function can be used to write to otherwise read-only foreign repos.
1018 * This does no locking nor journaling and is intended for purging thumbnails.
1020 * @param array $paths List of virtual URLs or storage paths
1021 * @return FileRepoStatus
1023 public function quickPurgeBatch( array $paths ) {
1024 $status = $this->newGood();
1025 $operations = array();
1026 foreach ( $paths as $path ) {
1027 $operations[] = array(
1029 'src' => $this->resolveToStoragePath( $path ),
1030 'ignoreMissingSource' => true
1033 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1039 * Pick a random name in the temp zone and store a file to it.
1040 * Returns a FileRepoStatus object with the file Virtual URL in the value,
1041 * file can later be disposed using FileRepo::freeTemp().
1043 * @param string $originalName the base name of the file as specified
1044 * by the user. The file extension will be maintained.
1045 * @param string $srcPath The current location of the file.
1046 * @return FileRepoStatus Object with the URL in the value.
1048 public function storeTemp( $originalName, $srcPath ) {
1049 $this->assertWritableRepo(); // fail out if read-only
1051 $date = MWTimestamp
::getInstance()->format( 'YmdHis' );
1052 $hashPath = $this->getHashPath( $originalName );
1053 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1054 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1056 $result = $this->quickImport( $srcPath, $virtualUrl );
1057 $result->value
= $virtualUrl;
1063 * Remove a temporary file or mark it for garbage collection
1065 * @param string $virtualUrl The virtual URL returned by FileRepo::storeTemp()
1066 * @return bool True on success, false on failure
1068 public function freeTemp( $virtualUrl ) {
1069 $this->assertWritableRepo(); // fail out if read-only
1071 $temp = $this->getVirtualUrl( 'temp' );
1072 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1073 wfDebug( __METHOD__
. ": Invalid temp virtual URL\n" );
1078 return $this->quickPurge( $virtualUrl )->isOK();
1082 * Concatenate a list of temporary files into a target file location.
1084 * @param array $srcPaths Ordered list of source virtual URLs/storage paths
1085 * @param string $dstPath Target file system path
1086 * @param int $flags Bitwise combination of the following flags:
1087 * self::DELETE_SOURCE Delete the source files
1088 * @return FileRepoStatus
1090 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1091 $this->assertWritableRepo(); // fail out if read-only
1093 $status = $this->newGood();
1096 foreach ( $srcPaths as $srcPath ) {
1097 // Resolve source to a storage path if virtual
1098 $source = $this->resolveToStoragePath( $srcPath );
1099 $sources[] = $source; // chunk to merge
1102 // Concatenate the chunks into one FS file
1103 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
1104 $status->merge( $this->backend
->concatenate( $params ) );
1105 if ( !$status->isOK() ) {
1109 // Delete the sources if required
1110 if ( $flags & self
::DELETE_SOURCE
) {
1111 $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1114 // Make sure status is OK, despite any quickPurgeBatch() fatals
1115 $status->setResult( true );
1121 * Copy or move a file either from a storage path, virtual URL,
1122 * or file system path, into this repository at the specified destination location.
1124 * Returns a FileRepoStatus object. On success, the value contains "new" or
1125 * "archived", to indicate whether the file was new with that name.
1127 * Options to $options include:
1128 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1130 * @param string $srcPath The source file system path, storage path, or URL
1131 * @param string $dstRel The destination relative path
1132 * @param string $archiveRel The relative path where the existing file is to
1133 * be archived, if there is one. Relative to the public zone root.
1134 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1135 * that the source file should be deleted if possible
1136 * @param array $options Optional additional parameters
1137 * @return FileRepoStatus
1139 public function publish(
1140 $srcPath, $dstRel, $archiveRel, $flags = 0, array $options = array()
1142 $this->assertWritableRepo(); // fail out if read-only
1144 $status = $this->publishBatch(
1145 array( array( $srcPath, $dstRel, $archiveRel, $options ) ), $flags );
1146 if ( $status->successCount
== 0 ) {
1147 $status->ok
= false;
1149 if ( isset( $status->value
[0] ) ) {
1150 $status->value
= $status->value
[0];
1152 $status->value
= false;
1159 * Publish a batch of files
1161 * @param array $ntuples (source, dest, archive) triplets or
1162 * (source, dest, archive, options) 4-tuples as per publish().
1163 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1164 * that the source files should be deleted if possible
1165 * @throws MWException
1166 * @return FileRepoStatus
1168 public function publishBatch( array $ntuples, $flags = 0 ) {
1169 $this->assertWritableRepo(); // fail out if read-only
1171 $backend = $this->backend
; // convenience
1172 // Try creating directories
1173 $status = $this->initZones( 'public' );
1174 if ( !$status->isOK() ) {
1178 $status = $this->newGood( array() );
1180 $operations = array();
1181 $sourceFSFilesToDelete = array(); // cleanup for disk source files
1182 // Validate each triplet and get the store operation...
1183 foreach ( $ntuples as $ntuple ) {
1184 list( $srcPath, $dstRel, $archiveRel ) = $ntuple;
1185 $options = isset( $ntuple[3] ) ?
$ntuple[3] : array();
1186 // Resolve source to a storage path if virtual
1187 $srcPath = $this->resolveToStoragePath( $srcPath );
1188 if ( !$this->validateFilename( $dstRel ) ) {
1189 throw new MWException( 'Validation error in $dstRel' );
1191 if ( !$this->validateFilename( $archiveRel ) ) {
1192 throw new MWException( 'Validation error in $archiveRel' );
1195 $publicRoot = $this->getZonePath( 'public' );
1196 $dstPath = "$publicRoot/$dstRel";
1197 $archivePath = "$publicRoot/$archiveRel";
1199 $dstDir = dirname( $dstPath );
1200 $archiveDir = dirname( $archivePath );
1201 // Abort immediately on directory creation errors since they're likely to be repetitive
1202 if ( !$this->initDirectory( $dstDir )->isOK() ) {
1203 return $this->newFatal( 'directorycreateerror', $dstDir );
1205 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1206 return $this->newFatal( 'directorycreateerror', $archiveDir );
1209 // Set any desired headers to be use in GET/HEAD responses
1210 $headers = isset( $options['headers'] ) ?
$options['headers'] : array();
1212 // Archive destination file if it exists.
1213 // This will check if the archive file also exists and fail if does.
1214 // This is a sanity check to avoid data loss. On Windows and Linux,
1215 // copy() will overwrite, so the existence check is vulnerable to
1216 // race conditions unless an functioning LockManager is used.
1217 // LocalFile also uses SELECT FOR UPDATE for synchronization.
1218 $operations[] = array(
1221 'dst' => $archivePath,
1222 'ignoreMissingSource' => true
1225 // Copy (or move) the source file to the destination
1226 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1227 if ( $flags & self
::DELETE_SOURCE
) {
1228 $operations[] = array(
1232 'overwrite' => true, // replace current
1233 'headers' => $headers
1236 $operations[] = array(
1240 'overwrite' => true, // replace current
1241 'headers' => $headers
1244 } else { // FS source path
1245 $operations[] = array(
1249 'overwrite' => true, // replace current
1250 'headers' => $headers
1252 if ( $flags & self
::DELETE_SOURCE
) {
1253 $sourceFSFilesToDelete[] = $srcPath;
1258 // Execute the operations for each triplet
1259 $status->merge( $backend->doOperations( $operations ) );
1260 // Find out which files were archived...
1261 foreach ( $ntuples as $i => $ntuple ) {
1262 list( , , $archiveRel ) = $ntuple;
1263 $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1264 if ( $this->fileExists( $archivePath ) ) {
1265 $status->value
[$i] = 'archived';
1267 $status->value
[$i] = 'new';
1270 // Cleanup for disk source files...
1271 foreach ( $sourceFSFilesToDelete as $file ) {
1272 wfSuppressWarnings();
1273 unlink( $file ); // FS cleanup
1274 wfRestoreWarnings();
1281 * Creates a directory with the appropriate zone permissions.
1282 * Callers are responsible for doing read-only and "writable repo" checks.
1284 * @param string $dir Virtual URL (or storage path) of directory to clean
1287 protected function initDirectory( $dir ) {
1288 $path = $this->resolveToStoragePath( $dir );
1289 list( , $container, ) = FileBackend
::splitStoragePath( $path );
1291 $params = array( 'dir' => $path );
1292 if ( $this->isPrivate ||
$container === $this->zones
['deleted']['container'] ) {
1293 # Take all available measures to prevent web accessibility of new deleted
1294 # directories, in case the user has not configured offline storage
1295 $params = array( 'noAccess' => true, 'noListing' => true ) +
$params;
1298 return $this->backend
->prepare( $params );
1302 * Deletes a directory if empty.
1304 * @param string $dir Virtual URL (or storage path) of directory to clean
1307 public function cleanDir( $dir ) {
1308 $this->assertWritableRepo(); // fail out if read-only
1310 $status = $this->newGood();
1311 $status->merge( $this->backend
->clean(
1312 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1318 * Checks existence of a a file
1320 * @param string $file Virtual URL (or storage path) of file to check
1323 public function fileExists( $file ) {
1324 $result = $this->fileExistsBatch( array( $file ) );
1330 * Checks existence of an array of files.
1332 * @param array $files Virtual URLs (or storage paths) of files to check
1333 * @return array|bool Either array of files and existence flags, or false
1335 public function fileExistsBatch( array $files ) {
1337 foreach ( $files as $key => $file ) {
1338 $file = $this->resolveToStoragePath( $file );
1339 $result[$key] = $this->backend
->fileExists( array( 'src' => $file ) );
1346 * Move a file to the deletion archive.
1347 * If no valid deletion archive exists, this may either delete the file
1348 * or throw an exception, depending on the preference of the repository
1350 * @param mixed $srcRel Relative path for the file to be deleted
1351 * @param mixed $archiveRel Relative path for the archive location.
1352 * Relative to a private archive directory.
1353 * @return FileRepoStatus object
1355 public function delete( $srcRel, $archiveRel ) {
1356 $this->assertWritableRepo(); // fail out if read-only
1358 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1362 * Move a group of files to the deletion archive.
1364 * If no valid deletion archive is configured, this may either delete the
1365 * file or throw an exception, depending on the preference of the repository.
1367 * The overwrite policy is determined by the repository -- currently LocalRepo
1368 * assumes a naming scheme in the deleted zone based on content hash, as
1369 * opposed to the public zone which is assumed to be unique.
1371 * @param array $sourceDestPairs Array of source/destination pairs. Each element
1372 * is a two-element array containing the source file path relative to the
1373 * public root in the first element, and the archive file path relative
1374 * to the deleted zone root in the second element.
1375 * @throws MWException
1376 * @return FileRepoStatus
1378 public function deleteBatch( array $sourceDestPairs ) {
1379 $this->assertWritableRepo(); // fail out if read-only
1381 // Try creating directories
1382 $status = $this->initZones( array( 'public', 'deleted' ) );
1383 if ( !$status->isOK() ) {
1387 $status = $this->newGood();
1389 $backend = $this->backend
; // convenience
1390 $operations = array();
1391 // Validate filenames and create archive directories
1392 foreach ( $sourceDestPairs as $pair ) {
1393 list( $srcRel, $archiveRel ) = $pair;
1394 if ( !$this->validateFilename( $srcRel ) ) {
1395 throw new MWException( __METHOD__
. ':Validation error in $srcRel' );
1396 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1397 throw new MWException( __METHOD__
. ':Validation error in $archiveRel' );
1400 $publicRoot = $this->getZonePath( 'public' );
1401 $srcPath = "{$publicRoot}/$srcRel";
1403 $deletedRoot = $this->getZonePath( 'deleted' );
1404 $archivePath = "{$deletedRoot}/{$archiveRel}";
1405 $archiveDir = dirname( $archivePath ); // does not touch FS
1407 // Create destination directories
1408 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1409 return $this->newFatal( 'directorycreateerror', $archiveDir );
1412 $operations[] = array(
1415 'dst' => $archivePath,
1416 // We may have 2+ identical files being deleted,
1417 // all of which will map to the same destination file
1418 'overwriteSame' => true // also see bug 31792
1422 // Move the files by execute the operations for each pair.
1423 // We're now committed to returning an OK result, which will
1424 // lead to the files being moved in the DB also.
1425 $opts = array( 'force' => true );
1426 $status->merge( $backend->doOperations( $operations, $opts ) );
1432 * Delete files in the deleted directory if they are not referenced in the filearchive table
1436 public function cleanupDeletedBatch( array $storageKeys ) {
1437 $this->assertWritableRepo();
1441 * Get a relative path for a deletion archive key,
1442 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1444 * @param string $key
1445 * @throws MWException
1448 public function getDeletedHashPath( $key ) {
1449 if ( strlen( $key ) < 31 ) {
1450 throw new MWException( "Invalid storage key '$key'." );
1453 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1454 $path .= $key[$i] . '/';
1461 * If a path is a virtual URL, resolve it to a storage path.
1462 * Otherwise, just return the path as it is.
1464 * @param string $path
1466 * @throws MWException
1468 protected function resolveToStoragePath( $path ) {
1469 if ( $this->isVirtualUrl( $path ) ) {
1470 return $this->resolveVirtualUrl( $path );
1477 * Get a local FS copy of a file with a given virtual URL/storage path.
1478 * Temporary files may be purged when the file object falls out of scope.
1480 * @param string $virtualUrl
1481 * @return TempFSFile|null Returns null on failure
1483 public function getLocalCopy( $virtualUrl ) {
1484 $path = $this->resolveToStoragePath( $virtualUrl );
1486 return $this->backend
->getLocalCopy( array( 'src' => $path ) );
1490 * Get a local FS file with a given virtual URL/storage path.
1491 * The file is either an original or a copy. It should not be changed.
1492 * Temporary files may be purged when the file object falls out of scope.
1494 * @param string $virtualUrl
1495 * @return FSFile|null Returns null on failure.
1497 public function getLocalReference( $virtualUrl ) {
1498 $path = $this->resolveToStoragePath( $virtualUrl );
1500 return $this->backend
->getLocalReference( array( 'src' => $path ) );
1504 * Get properties of a file with a given virtual URL/storage path.
1505 * Properties should ultimately be obtained via FSFile::getProps().
1507 * @param string $virtualUrl
1510 public function getFileProps( $virtualUrl ) {
1511 $path = $this->resolveToStoragePath( $virtualUrl );
1513 return $this->backend
->getFileProps( array( 'src' => $path ) );
1517 * Get the timestamp of a file with a given virtual URL/storage path
1519 * @param string $virtualUrl
1520 * @return string|bool False on failure
1522 public function getFileTimestamp( $virtualUrl ) {
1523 $path = $this->resolveToStoragePath( $virtualUrl );
1525 return $this->backend
->getFileTimestamp( array( 'src' => $path ) );
1529 * Get the size of a file with a given virtual URL/storage path
1531 * @param string $virtualUrl
1532 * @return integer|bool False on failure
1534 public function getFileSize( $virtualUrl ) {
1535 $path = $this->resolveToStoragePath( $virtualUrl );
1537 return $this->backend
->getFileSize( array( 'src' => $path ) );
1541 * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1543 * @param string $virtualUrl
1544 * @return string|bool
1546 public function getFileSha1( $virtualUrl ) {
1547 $path = $this->resolveToStoragePath( $virtualUrl );
1549 return $this->backend
->getFileSha1Base36( array( 'src' => $path ) );
1553 * Attempt to stream a file with the given virtual URL/storage path
1555 * @param string $virtualUrl
1556 * @param array $headers Additional HTTP headers to send on success
1557 * @return bool Success
1559 public function streamFile( $virtualUrl, $headers = array() ) {
1560 $path = $this->resolveToStoragePath( $virtualUrl );
1561 $params = array( 'src' => $path, 'headers' => $headers );
1563 return $this->backend
->streamFile( $params )->isOK();
1567 * Call a callback function for every public regular file in the repository.
1568 * This only acts on the current version of files, not any old versions.
1569 * May use either the database or the filesystem.
1571 * @param array|string $callback
1574 public function enumFiles( $callback ) {
1575 $this->enumFilesInStorage( $callback );
1579 * Call a callback function for every public file in the repository.
1580 * May use either the database or the filesystem.
1582 * @param array|string $callback
1585 protected function enumFilesInStorage( $callback ) {
1586 $publicRoot = $this->getZonePath( 'public' );
1587 $numDirs = 1 << ( $this->hashLevels
* 4 );
1588 // Use a priori assumptions about directory structure
1589 // to reduce the tree height of the scanning process.
1590 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1591 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1592 $path = $publicRoot;
1593 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1594 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1596 $iterator = $this->backend
->getFileList( array( 'dir' => $path ) );
1597 foreach ( $iterator as $name ) {
1598 // Each item returned is a public file
1599 call_user_func( $callback, "{$path}/{$name}" );
1605 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1607 * @param $filename string
1610 public function validateFilename( $filename ) {
1611 if ( strval( $filename ) == '' ) {
1615 return FileBackend
::isPathTraversalFree( $filename );
1619 * Get a callback function to use for cleaning error message parameters
1623 function getErrorCleanupFunction() {
1624 switch ( $this->pathDisclosureProtection
) {
1626 case 'simple': // b/c
1627 $callback = array( $this, 'passThrough' );
1629 default: // 'paranoid'
1630 $callback = array( $this, 'paranoidClean' );
1636 * Path disclosure protection function
1638 * @param string $param
1641 function paranoidClean( $param ) {
1646 * Path disclosure protection function
1648 * @param string $param
1651 function passThrough( $param ) {
1656 * Create a new fatal error
1659 * @return FileRepoStatus
1661 public function newFatal( $message /*, parameters...*/ ) {
1662 $params = func_get_args();
1663 array_unshift( $params, $this );
1665 return call_user_func_array( array( 'FileRepoStatus', 'newFatal' ), $params );
1669 * Create a new good result
1671 * @param null|string $value
1672 * @return FileRepoStatus
1674 public function newGood( $value = null ) {
1675 return FileRepoStatus
::newGood( $this, $value );
1679 * Checks if there is a redirect named as $title. If there is, return the
1680 * title object. If not, return false.
1683 * @param Title $title Title of image
1686 public function checkRedirect( Title
$title ) {
1691 * Invalidates image redirect cache related to that image
1692 * Doesn't do anything for repositories that don't support image redirects.
1695 * @param Title $title Title of image
1697 public function invalidateImageRedirect( Title
$title ) {
1701 * Get the human-readable name of the repo
1705 public function getDisplayName() {
1706 // We don't name our own repo, return nothing
1707 if ( $this->isLocal() ) {
1711 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1712 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1716 * Get the portion of the file that contains the origin file name.
1717 * If that name is too long, then the name "thumbnail.<ext>" will be given.
1719 * @param $name string
1722 public function nameForThumb( $name ) {
1723 if ( strlen( $name ) > $this->abbrvThreshold
) {
1724 $ext = FileBackend
::extensionFromPath( $name );
1725 $name = ( $ext == '' ) ?
'thumbnail' : "thumbnail.$ext";
1732 * Returns true if this the local file repository.
1736 public function isLocal() {
1737 return $this->getName() == 'local';
1741 * Get a key on the primary cache for this repository.
1742 * Returns false if the repository's cache is not accessible at this site.
1743 * The parameters are the parts of the key, as for wfMemcKey().
1748 public function getSharedCacheKey( /*...*/ ) {
1753 * Get a key for this repo in the local cache domain. These cache keys are
1754 * not shared with remote instances of the repo.
1755 * The parameters are the parts of the key, as for wfMemcKey().
1759 public function getLocalCacheKey( /*...*/ ) {
1760 $args = func_get_args();
1761 array_unshift( $args, 'filerepo', $this->getName() );
1763 return call_user_func_array( 'wfMemcKey', $args );
1767 * Get an temporary FileRepo associated with this repo.
1768 * Files will be created in the temp zone of this repo and
1769 * thumbnails in a /temp subdirectory in thumb zone of this repo.
1770 * It will have the same backend as this repo.
1772 * @return TempFileRepo
1774 public function getTempRepo() {
1775 return new TempFileRepo( array(
1776 'name' => "{$this->name}-temp",
1777 'backend' => $this->backend
,
1780 'container' => $this->zones
['temp']['container'],
1781 'directory' => $this->zones
['temp']['directory']
1784 'container' => $this->zones
['thumb']['container'],
1785 'directory' => $this->zones
['thumb']['directory'] == ''
1787 : $this->zones
['thumb']['directory'] . '/temp'
1789 'transcoded' => array(
1790 'container' => $this->zones
['transcoded']['container'],
1791 'directory' => $this->zones
['transcoded']['directory'] == ''
1793 : $this->zones
['transcoded']['directory'] . '/temp'
1796 'url' => $this->getZoneUrl( 'temp' ),
1797 'thumbUrl' => $this->getZoneUrl( 'thumb' ) . '/temp',
1798 'transcodedUrl' => $this->getZoneUrl( 'transcoded' ) . '/temp',
1799 'hashLevels' => $this->hashLevels
// performance
1804 * Get an UploadStash associated with this repo.
1807 * @return UploadStash
1809 public function getUploadStash( User
$user = null ) {
1810 return new UploadStash( $this, $user );
1814 * Throw an exception if this repo is read-only by design.
1815 * This does not and should not check getReadOnlyReason().
1818 * @throws MWException
1820 protected function assertWritableRepo() {
1824 * Return information about the repository.
1829 public function getInfo() {
1831 'name' => $this->getName(),
1832 'displayname' => $this->getDisplayName(),
1833 'rootUrl' => $this->getZoneUrl( 'public' ),
1834 'local' => $this->isLocal(),
1837 $optionalSettings = array(
1838 'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1839 'fetchDescription', 'descriptionCacheExpiry', 'scriptExtension'
1841 foreach ( $optionalSettings as $k ) {
1842 if ( isset( $this->$k ) ) {
1843 $ret[$k] = $this->$k;
1852 * FileRepo for temporary files created via FileRepo::getTempRepo()
1854 class TempFileRepo
extends FileRepo
{
1855 public function getTempRepo() {
1856 throw new MWException( "Cannot get a temp repo from a temp repo." );