3 * @defgroup FileRepo File Repository
5 * @brief This module handles how MediaWiki interacts with filesystems.
11 * Base code for file repositories.
18 * Base class for file repositories
23 const DELETE_SOURCE
= 1;
25 const OVERWRITE_SAME
= 4;
26 const SKIP_LOCKING
= 8;
28 /** @var FileBackend */
30 /** @var Array Map of zones to config */
31 protected $zones = array();
33 var $thumbScriptUrl, $transformVia404;
34 var $descBaseUrl, $scriptDirUrl, $scriptExtension, $articleUrl;
35 var $fetchDescription, $initialCapital;
36 var $pathDisclosureProtection = 'simple'; // 'paranoid'
37 var $descriptionCacheExpiry, $url, $thumbUrl;
38 var $hashLevels, $deletedHashLevels;
41 * Factory functions for creating new files
42 * Override these in the base class
44 var $fileFactory = array( 'UnregisteredLocalFile', 'newFromTitle' );
45 var $oldFileFactory = false;
46 var $fileFactoryKey = false, $oldFileFactoryKey = false;
48 function __construct( array $info = null ) {
49 // Verify required settings presence
52 ||
!array_key_exists( 'name', $info )
53 ||
!array_key_exists( 'backend', $info )
55 throw new MWException( __CLASS__
. " requires an array of options having both 'name' and 'backend' keys.\n" );
59 $this->name
= $info['name'];
60 if ( $info['backend'] instanceof FileBackend
) {
61 $this->backend
= $info['backend']; // useful for testing
63 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
66 // Optional settings that can have no value
67 $optionalSettings = array(
68 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
69 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
72 foreach ( $optionalSettings as $var ) {
73 if ( isset( $info[$var] ) ) {
74 $this->$var = $info[$var];
78 // Optional settings that have a default
79 $this->initialCapital
= isset( $info['initialCapital'] )
80 ?
$info['initialCapital']
81 : MWNamespace
::isCapitalized( NS_FILE
);
82 $this->url
= isset( $info['url'] )
84 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
85 if ( isset( $info['thumbUrl'] ) ) {
86 $this->thumbUrl
= $info['thumbUrl'];
88 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
90 $this->hashLevels
= isset( $info['hashLevels'] )
93 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
94 ?
$info['deletedHashLevels']
96 $this->transformVia404
= !empty( $info['transformVia404'] );
97 $this->zones
= isset( $info['zones'] )
100 // Give defaults for the basic zones...
101 foreach ( array( 'public', 'thumb', 'temp', 'deleted' ) as $zone ) {
102 if ( !isset( $this->zones
[$zone] ) ) {
103 $this->zones
[$zone] = array(
104 'container' => "{$this->name}-{$zone}",
105 'directory' => '' // container root
112 * Get the file backend instance. Use this function wisely.
114 * @return FileBackend
116 public function getBackend() {
117 return $this->backend
;
121 * Get an explanatory message if this repo is read-only.
122 * This checks if an administrator disabled writes to the backend.
124 * @return string|bool Returns false if the repo is not read-only
126 public function getReadOnlyReason() {
127 return $this->backend
->getReadOnlyReason();
131 * Check if a single zone or list of zones is defined for usage
133 * @param $doZones Array Only do a particular zones
136 protected function initZones( $doZones = array() ) {
137 $status = $this->newGood();
138 foreach ( (array)$doZones as $zone ) {
139 $root = $this->getZonePath( $zone );
140 if ( $root === null ) {
141 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
148 * Take all available measures to prevent web accessibility of new deleted
149 * directories, in case the user has not configured offline storage
154 protected function initDeletedDir( $dir ) {
155 $this->backend
->secure( // prevent web access & dir listings
156 array( 'dir' => $dir, 'noAccess' => true, 'noListing' => true ) );
160 * Determine if a string is an mwrepo:// URL
165 public static function isVirtualUrl( $url ) {
166 return substr( $url, 0, 9 ) == 'mwrepo://';
170 * Get a URL referring to this repository, with the private mwrepo protocol.
171 * The suffix, if supplied, is considered to be unencoded, and will be
172 * URL-encoded before being returned.
174 * @param $suffix string
177 public function getVirtualUrl( $suffix = false ) {
178 $path = 'mwrepo://' . $this->name
;
179 if ( $suffix !== false ) {
180 $path .= '/' . rawurlencode( $suffix );
186 * Get the URL corresponding to one of the four basic zones
188 * @param $zone String: one of: public, deleted, temp, thumb
189 * @return String or false
191 public function getZoneUrl( $zone ) {
196 return "{$this->url}/temp";
198 return false; // no public URL
200 return $this->thumbUrl
;
207 * Get the backend storage path corresponding to a virtual URL.
208 * Use this function wisely.
213 public function resolveVirtualUrl( $url ) {
214 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
215 throw new MWException( __METHOD__
.': unknown protocol' );
217 $bits = explode( '/', substr( $url, 9 ), 3 );
218 if ( count( $bits ) != 3 ) {
219 throw new MWException( __METHOD__
.": invalid mwrepo URL: $url" );
221 list( $repo, $zone, $rel ) = $bits;
222 if ( $repo !== $this->name
) {
223 throw new MWException( __METHOD__
.": fetching from a foreign repo is not supported" );
225 $base = $this->getZonePath( $zone );
227 throw new MWException( __METHOD__
.": invalid zone: $zone" );
229 return $base . '/' . rawurldecode( $rel );
233 * The the storage container and base path of a zone
235 * @param $zone string
236 * @return Array (container, base path) or (null, null)
238 protected function getZoneLocation( $zone ) {
239 if ( !isset( $this->zones
[$zone] ) ) {
240 return array( null, null ); // bogus
242 return array( $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] );
246 * Get the storage path corresponding to one of the zones
248 * @param $zone string
249 * @return string|null Returns null if the zone is not defined
251 public function getZonePath( $zone ) {
252 list( $container, $base ) = $this->getZoneLocation( $zone );
253 if ( $container === null ||
$base === null ) {
256 $backendName = $this->backend
->getName();
257 if ( $base != '' ) { // may not be set
260 return "mwstore://$backendName/{$container}{$base}";
264 * Create a new File object from the local repository
266 * @param $title Mixed: Title object or string
267 * @param $time Mixed: Time at which the image was uploaded.
268 * If this is specified, the returned object will be an
269 * instance of the repository's old file class instead of a
270 * current file. Repositories not supporting version control
271 * should return false if this parameter is set.
272 * @return File|null A File, or null if passed an invalid Title
274 public function newFile( $title, $time = false ) {
275 $title = File
::normalizeTitle( $title );
280 if ( $this->oldFileFactory
) {
281 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
286 return call_user_func( $this->fileFactory
, $title, $this );
291 * Find an instance of the named file created at the specified time
292 * Returns false if the file does not exist. Repositories not supporting
293 * version control should return false if the time is specified.
295 * @param $title Mixed: Title object or string
296 * @param $options array Associative array of options:
297 * time: requested time for a specific file version, or false for the
298 * current version. An image object will be returned which was
299 * created at the specified time (which may be archived or current).
301 * ignoreRedirect: If true, do not follow file redirects
303 * private: If true, return restricted (deleted) files if the current
304 * user is allowed to view them. Otherwise, such files will not
306 * @return File|bool False on failure
308 public function findFile( $title, $options = array() ) {
309 $title = File
::normalizeTitle( $title );
313 $time = isset( $options['time'] ) ?
$options['time'] : false;
314 # First try the current version of the file to see if it precedes the timestamp
315 $img = $this->newFile( $title );
319 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
322 # Now try an old version of the file
323 if ( $time !== false ) {
324 $img = $this->newFile( $title, $time );
325 if ( $img && $img->exists() ) {
326 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
327 return $img; // always OK
328 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
335 if ( !empty( $options['ignoreRedirect'] ) ) {
338 $redir = $this->checkRedirect( $title );
339 if ( $redir && $title->getNamespace() == NS_FILE
) {
340 $img = $this->newFile( $redir );
344 if ( $img->exists() ) {
345 $img->redirectedFrom( $title->getDBkey() );
353 * Find many files at once.
355 * @param $items array An array of titles, or an array of findFile() options with
356 * the "title" option giving the title. Example:
358 * $findItem = array( 'title' => $title, 'private' => true );
359 * $findBatch = array( $findItem );
360 * $repo->findFiles( $findBatch );
363 public function findFiles( array $items ) {
365 foreach ( $items as $item ) {
366 if ( is_array( $item ) ) {
367 $title = $item['title'];
369 unset( $options['title'] );
374 $file = $this->findFile( $title, $options );
376 $result[$file->getTitle()->getDBkey()] = $file;
383 * Find an instance of the file with this key, created at the specified time
384 * Returns false if the file does not exist. Repositories not supporting
385 * version control should return false if the time is specified.
387 * @param $sha1 String base 36 SHA-1 hash
388 * @param $options array Option array, same as findFile().
389 * @return File|bool False on failure
391 public function findFileFromKey( $sha1, $options = array() ) {
392 $time = isset( $options['time'] ) ?
$options['time'] : false;
393 # First try to find a matching current version of a file...
394 if ( $this->fileFactoryKey
) {
395 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
397 return false; // find-by-sha1 not supported
399 if ( $img && $img->exists() ) {
402 # Now try to find a matching old version of a file...
403 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
404 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
405 if ( $img && $img->exists() ) {
406 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
407 return $img; // always OK
408 } elseif ( !empty( $options['private'] ) && $img->userCan( File
::DELETED_FILE
) ) {
417 * Get an array or iterator of file objects for files that have a given
418 * SHA-1 content hash.
423 public function findBySha1( $hash ) {
428 * Get the public root URL of the repository
432 public function getRootUrl() {
437 * Get the URL of thumb.php
441 public function getThumbScriptUrl() {
442 return $this->thumbScriptUrl
;
446 * Returns true if the repository can transform files via a 404 handler
450 public function canTransformVia404() {
451 return $this->transformVia404
;
455 * Get the name of an image from its title object
457 * @param $title Title
460 public function getNameFromTitle( Title
$title ) {
462 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
463 $name = $title->getUserCaseDBKey();
464 if ( $this->initialCapital
) {
465 $name = $wgContLang->ucfirst( $name );
468 $name = $title->getDBkey();
474 * Get the public zone root storage directory of the repository
478 public function getRootDirectory() {
479 return $this->getZonePath( 'public' );
483 * Get a relative path including trailing slash, e.g. f/fa/
484 * If the repo is not hashed, returns an empty string
486 * @param $name string Name of file
489 public function getHashPath( $name ) {
490 return self
::getHashPathForLevel( $name, $this->hashLevels
);
494 * Get a relative path including trailing slash, e.g. f/fa/
495 * If the repo is not hashed, returns an empty string
497 * @param $suffix string Basename of file from FileRepo::storeTemp()
500 public function getTempHashPath( $suffix ) {
501 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
502 $name = isset( $parts[1] ) ?
$parts[1] : $suffix; // hash path is not based on timestamp
503 return self
::getHashPathForLevel( $name, $this->hashLevels
);
511 protected static function getHashPathForLevel( $name, $levels ) {
512 if ( $levels == 0 ) {
515 $hash = md5( $name );
517 for ( $i = 1; $i <= $levels; $i++
) {
518 $path .= substr( $hash, 0, $i ) . '/';
525 * Get the number of hash directory levels
529 public function getHashLevels() {
530 return $this->hashLevels
;
534 * Get the name of this repository, as specified by $info['name]' to the constructor
538 public function getName() {
543 * Make an url to this repo
545 * @param $query mixed Query string to append
546 * @param $entry string Entry point; defaults to index
547 * @return string|bool False on failure
549 public function makeUrl( $query = '', $entry = 'index' ) {
550 if ( isset( $this->scriptDirUrl
) ) {
551 $ext = isset( $this->scriptExtension
) ?
$this->scriptExtension
: '.php';
552 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}{$ext}", $query );
558 * Get the URL of an image description page. May return false if it is
559 * unknown or not applicable. In general this should only be called by the
560 * File class, since it may return invalid results for certain kinds of
561 * repositories. Use File::getDescriptionUrl() in user code.
563 * In particular, it uses the article paths as specified to the repository
564 * constructor, whereas local repositories use the local Title functions.
566 * @param $name string
569 public function getDescriptionUrl( $name ) {
570 $encName = wfUrlencode( $name );
571 if ( !is_null( $this->descBaseUrl
) ) {
572 # "http://example.com/wiki/Image:"
573 return $this->descBaseUrl
. $encName;
575 if ( !is_null( $this->articleUrl
) ) {
576 # "http://example.com/wiki/$1"
578 # We use "Image:" as the canonical namespace for
579 # compatibility across all MediaWiki versions.
580 return str_replace( '$1',
581 "Image:$encName", $this->articleUrl
);
583 if ( !is_null( $this->scriptDirUrl
) ) {
584 # "http://example.com/w"
586 # We use "Image:" as the canonical namespace for
587 # compatibility across all MediaWiki versions,
588 # and just sort of hope index.php is right. ;)
589 return $this->makeUrl( "title=Image:$encName" );
595 * Get the URL of the content-only fragment of the description page. For
596 * MediaWiki this means action=render. This should only be called by the
597 * repository's file class, since it may return invalid results. User code
598 * should use File::getDescriptionText().
600 * @param $name String: name of image to fetch
601 * @param $lang String: language to fetch it in, if any.
604 public function getDescriptionRenderUrl( $name, $lang = null ) {
605 $query = 'action=render';
606 if ( !is_null( $lang ) ) {
607 $query .= '&uselang=' . $lang;
609 if ( isset( $this->scriptDirUrl
) ) {
610 return $this->makeUrl(
612 wfUrlencode( 'Image:' . $name ) .
615 $descUrl = $this->getDescriptionUrl( $name );
617 return wfAppendQuery( $descUrl, $query );
625 * Get the URL of the stylesheet to apply to description pages
627 * @return string|bool False on failure
629 public function getDescriptionStylesheetUrl() {
630 if ( isset( $this->scriptDirUrl
) ) {
631 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
632 wfArrayToCGI( Skin
::getDynamicStylesheetQuery() ) );
638 * Store a file to a given destination.
640 * @param $srcPath String: source FS path, storage path, or virtual URL
641 * @param $dstZone String: destination zone
642 * @param $dstRel String: destination relative path
643 * @param $flags Integer: bitwise combination of the following flags:
644 * self::DELETE_SOURCE Delete the source file after upload
645 * self::OVERWRITE Overwrite an existing destination file instead of failing
646 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
647 * same contents as the source
648 * self::SKIP_LOCKING Skip any file locking when doing the store
649 * @return FileRepoStatus
651 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
652 $this->assertWritableRepo(); // fail out if read-only
654 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
655 if ( $status->successCount
== 0 ) {
663 * Store a batch of files
665 * @param $triplets Array: (src, dest zone, dest rel) triplets as per store()
666 * @param $flags Integer: bitwise combination of the following flags:
667 * self::DELETE_SOURCE Delete the source file after upload
668 * self::OVERWRITE Overwrite an existing destination file instead of failing
669 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
670 * same contents as the source
671 * self::SKIP_LOCKING Skip any file locking when doing the store
672 * @return FileRepoStatus
674 public function storeBatch( array $triplets, $flags = 0 ) {
675 $this->assertWritableRepo(); // fail out if read-only
677 $status = $this->newGood();
678 $backend = $this->backend
; // convenience
680 $operations = array();
681 $sourceFSFilesToDelete = array(); // cleanup for disk source files
682 // Validate each triplet and get the store operation...
683 foreach ( $triplets as $triplet ) {
684 list( $srcPath, $dstZone, $dstRel ) = $triplet;
686 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
689 // Resolve destination path
690 $root = $this->getZonePath( $dstZone );
692 throw new MWException( "Invalid zone: $dstZone" );
694 if ( !$this->validateFilename( $dstRel ) ) {
695 throw new MWException( 'Validation error in $dstRel' );
697 $dstPath = "$root/$dstRel";
698 $dstDir = dirname( $dstPath );
699 // Create destination directories for this triplet
700 if ( !$backend->prepare( array( 'dir' => $dstDir ) )->isOK() ) {
701 return $this->newFatal( 'directorycreateerror', $dstDir );
704 if ( $dstZone == 'deleted' ) {
705 $this->initDeletedDir( $dstDir );
708 // Resolve source to a storage path if virtual
709 $srcPath = $this->resolveToStoragePath( $srcPath );
711 // Get the appropriate file operation
712 if ( FileBackend
::isStoragePath( $srcPath ) ) {
713 $opName = ( $flags & self
::DELETE_SOURCE
) ?
'move' : 'copy';
716 if ( $flags & self
::DELETE_SOURCE
) {
717 $sourceFSFilesToDelete[] = $srcPath;
720 $operations[] = array(
724 'overwrite' => $flags & self
::OVERWRITE
,
725 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
729 // Execute the store operation for each triplet
730 $opts = array( 'force' => true );
731 if ( $flags & self
::SKIP_LOCKING
) {
732 $opts['nonLocking'] = true;
734 $status->merge( $backend->doOperations( $operations, $opts ) );
735 // Cleanup for disk source files...
736 foreach ( $sourceFSFilesToDelete as $file ) {
737 wfSuppressWarnings();
738 unlink( $file ); // FS cleanup
746 * Deletes a batch of files.
747 * Each file can be a (zone, rel) pair, virtual url, storage path.
748 * It will try to delete each file, but ignores any errors that may occur.
750 * @param $pairs array List of files to delete
751 * @param $flags Integer: bitwise combination of the following flags:
752 * self::SKIP_LOCKING Skip any file locking when doing the deletions
753 * @return FileRepoStatus
755 public function cleanupBatch( array $files, $flags = 0 ) {
756 $this->assertWritableRepo(); // fail out if read-only
758 $status = $this->newGood();
760 $operations = array();
761 foreach ( $files as $path ) {
762 if ( is_array( $path ) ) {
763 // This is a pair, extract it
764 list( $zone, $rel ) = $path;
765 $path = $this->getZonePath( $zone ) . "/$rel";
767 // Resolve source to a storage path if virtual
768 $path = $this->resolveToStoragePath( $path );
770 $operations[] = array( 'op' => 'delete', 'src' => $path );
772 // Actually delete files from storage...
773 $opts = array( 'force' => true );
774 if ( $flags & self
::SKIP_LOCKING
) {
775 $opts['nonLocking'] = true;
777 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
783 * Import a file from the local file system into the repo.
784 * This does no locking nor journaling and overrides existing files.
785 * This function can be used to write to otherwise read-only foreign repos.
786 * This is intended for copying generated thumbnails into the repo.
788 * @param $src string File system path
789 * @param $dst string Virtual URL or storage path
790 * @return FileRepoStatus
792 final public function quickImport( $src, $dst ) {
793 return $this->quickImportBatch( array( array( $src, $dst ) ) );
797 * Purge a file from the repo. This does no locking nor journaling.
798 * This function can be used to write to otherwise read-only foreign repos.
799 * This is intended for purging thumbnails.
801 * @param $path string Virtual URL or storage path
802 * @return FileRepoStatus
804 final public function quickPurge( $path ) {
805 return $this->quickPurgeBatch( array( $path ) );
809 * Deletes a directory if empty.
810 * This function can be used to write to otherwise read-only foreign repos.
812 * @param $dir string Virtual URL (or storage path) of directory to clean
815 public function quickCleanDir( $dir ) {
816 $status = $this->newGood();
817 $status->merge( $this->backend
->clean(
818 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
824 * Import a batch of files from the local file system into the repo.
825 * This does no locking nor journaling and overrides existing files.
826 * This function can be used to write to otherwise read-only foreign repos.
827 * This is intended for copying generated thumbnails into the repo.
829 * @param $src Array List of tuples (file system path, virtual URL or storage path)
830 * @return FileRepoStatus
832 public function quickImportBatch( array $pairs ) {
833 $status = $this->newGood();
834 $operations = array();
835 foreach ( $pairs as $pair ) {
836 list ( $src, $dst ) = $pair;
837 $operations[] = array(
840 'dst' => $this->resolveToStoragePath( $dst ),
843 $this->backend
->prepare( array( 'dir' => dirname( $dst ) ) );
845 $status->merge( $this->backend
->doOperations( $operations,
846 array( 'force' => 1, 'nonLocking' => 1, 'allowStale' => 1, 'nonJournaled' => 1 )
853 * Purge a batch of files from the repo.
854 * This function can be used to write to otherwise read-only foreign repos.
855 * This does no locking nor journaling and is intended for purging thumbnails.
857 * @param $path Array List of virtual URLs or storage paths
858 * @return FileRepoStatus
860 public function quickPurgeBatch( array $paths ) {
861 $status = $this->newGood();
862 $operations = array();
863 foreach ( $paths as $path ) {
864 $operations[] = array(
866 'src' => $this->resolveToStoragePath( $path ),
867 'ignoreMissingSource' => true
870 $status->merge( $this->backend
->doOperations( $operations,
871 array( 'force' => 1, 'nonLocking' => 1, 'allowStale' => 1, 'nonJournaled' => 1 )
878 * Pick a random name in the temp zone and store a file to it.
879 * Returns a FileRepoStatus object with the file Virtual URL in the value,
880 * file can later be disposed using FileRepo::freeTemp().
882 * @param $originalName String: the base name of the file as specified
883 * by the user. The file extension will be maintained.
884 * @param $srcPath String: the current location of the file.
885 * @return FileRepoStatus object with the URL in the value.
887 public function storeTemp( $originalName, $srcPath ) {
888 $this->assertWritableRepo(); // fail out if read-only
890 $date = gmdate( "YmdHis" );
891 $hashPath = $this->getHashPath( $originalName );
892 $dstRel = "{$hashPath}{$date}!{$originalName}";
893 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
895 $result = $this->store( $srcPath, 'temp', $dstRel, self
::SKIP_LOCKING
);
896 $result->value
= $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
902 * Concatenate a list of files into a target file location.
904 * @param $srcPaths Array Ordered list of source virtual URLs/storage paths
905 * @param $dstPath String Target file system path
906 * @param $flags Integer: bitwise combination of the following flags:
907 * self::DELETE_SOURCE Delete the source files
908 * @return FileRepoStatus
910 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
911 $this->assertWritableRepo(); // fail out if read-only
913 $status = $this->newGood();
916 $deleteOperations = array(); // post-concatenate ops
917 foreach ( $srcPaths as $srcPath ) {
918 // Resolve source to a storage path if virtual
919 $source = $this->resolveToStoragePath( $srcPath );
920 $sources[] = $source; // chunk to merge
921 if ( $flags & self
::DELETE_SOURCE
) {
922 $deleteOperations[] = array( 'op' => 'delete', 'src' => $source );
926 // Concatenate the chunks into one FS file
927 $params = array( 'srcs' => $sources, 'dst' => $dstPath );
928 $status->merge( $this->backend
->concatenate( $params ) );
929 if ( !$status->isOK() ) {
933 // Delete the sources if required
934 if ( $deleteOperations ) {
935 $opts = array( 'force' => true );
936 $status->merge( $this->backend
->doOperations( $deleteOperations, $opts ) );
939 // Make sure status is OK, despite any $deleteOperations fatals
940 $status->setResult( true );
946 * Remove a temporary file or mark it for garbage collection
948 * @param $virtualUrl String: the virtual URL returned by FileRepo::storeTemp()
949 * @return Boolean: true on success, false on failure
951 public function freeTemp( $virtualUrl ) {
952 $this->assertWritableRepo(); // fail out if read-only
954 $temp = "mwrepo://{$this->name}/temp";
955 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
956 wfDebug( __METHOD__
.": Invalid temp virtual URL\n" );
959 $path = $this->resolveVirtualUrl( $virtualUrl );
961 return $this->cleanupBatch( array( $path ), self
::SKIP_LOCKING
)->isOK();
965 * Copy or move a file either from a storage path, virtual URL,
966 * or FS path, into this repository at the specified destination location.
968 * Returns a FileRepoStatus object. On success, the value contains "new" or
969 * "archived", to indicate whether the file was new with that name.
971 * @param $srcPath String: the source FS path, storage path, or URL
972 * @param $dstRel String: the destination relative path
973 * @param $archiveRel String: the relative path where the existing file is to
974 * be archived, if there is one. Relative to the public zone root.
975 * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
976 * that the source file should be deleted if possible
977 * @return FileRepoStatus
979 public function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
980 $this->assertWritableRepo(); // fail out if read-only
982 $status = $this->publishBatch( array( array( $srcPath, $dstRel, $archiveRel ) ), $flags );
983 if ( $status->successCount
== 0 ) {
986 if ( isset( $status->value
[0] ) ) {
987 $status->value
= $status->value
[0];
989 $status->value
= false;
996 * Publish a batch of files
998 * @param $triplets Array: (source, dest, archive) triplets as per publish()
999 * @param $flags Integer: bitfield, may be FileRepo::DELETE_SOURCE to indicate
1000 * that the source files should be deleted if possible
1001 * @return FileRepoStatus
1003 public function publishBatch( array $triplets, $flags = 0 ) {
1004 $this->assertWritableRepo(); // fail out if read-only
1006 $backend = $this->backend
; // convenience
1007 // Try creating directories
1008 $status = $this->initZones( 'public' );
1009 if ( !$status->isOK() ) {
1013 $status = $this->newGood( array() );
1015 $operations = array();
1016 $sourceFSFilesToDelete = array(); // cleanup for disk source files
1017 // Validate each triplet and get the store operation...
1018 foreach ( $triplets as $i => $triplet ) {
1019 list( $srcPath, $dstRel, $archiveRel ) = $triplet;
1020 // Resolve source to a storage path if virtual
1021 $srcPath = $this->resolveToStoragePath( $srcPath );
1022 if ( !$this->validateFilename( $dstRel ) ) {
1023 throw new MWException( 'Validation error in $dstRel' );
1025 if ( !$this->validateFilename( $archiveRel ) ) {
1026 throw new MWException( 'Validation error in $archiveRel' );
1029 $publicRoot = $this->getZonePath( 'public' );
1030 $dstPath = "$publicRoot/$dstRel";
1031 $archivePath = "$publicRoot/$archiveRel";
1033 $dstDir = dirname( $dstPath );
1034 $archiveDir = dirname( $archivePath );
1035 // Abort immediately on directory creation errors since they're likely to be repetitive
1036 if ( !$backend->prepare( array( 'dir' => $dstDir ) )->isOK() ) {
1037 return $this->newFatal( 'directorycreateerror', $dstDir );
1039 if ( !$backend->prepare( array( 'dir' => $archiveDir ) )->isOK() ) {
1040 return $this->newFatal( 'directorycreateerror', $archiveDir );
1043 // Archive destination file if it exists
1044 if ( $backend->fileExists( array( 'src' => $dstPath ) ) ) {
1045 // Check if the archive file exists
1046 // This is a sanity check to avoid data loss. In UNIX, the rename primitive
1047 // unlinks the destination file if it exists. DB-based synchronisation in
1048 // publishBatch's caller should prevent races. In Windows there's no
1049 // problem because the rename primitive fails if the destination exists.
1050 if ( $backend->fileExists( array( 'src' => $archivePath ) ) ) {
1051 $operations[] = array( 'op' => 'null' );
1054 $operations[] = array(
1057 'dst' => $archivePath
1060 $status->value
[$i] = 'archived';
1062 $status->value
[$i] = 'new';
1064 // Copy (or move) the source file to the destination
1065 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1066 if ( $flags & self
::DELETE_SOURCE
) {
1067 $operations[] = array(
1073 $operations[] = array(
1079 } else { // FS source path
1080 $operations[] = array(
1085 if ( $flags & self
::DELETE_SOURCE
) {
1086 $sourceFSFilesToDelete[] = $srcPath;
1091 // Execute the operations for each triplet
1092 $opts = array( 'force' => true );
1093 $status->merge( $backend->doOperations( $operations, $opts ) );
1094 // Cleanup for disk source files...
1095 foreach ( $sourceFSFilesToDelete as $file ) {
1096 wfSuppressWarnings();
1097 unlink( $file ); // FS cleanup
1098 wfRestoreWarnings();
1105 * Deletes a directory if empty.
1107 * @param $dir string Virtual URL (or storage path) of directory to clean
1110 public function cleanDir( $dir ) {
1111 $this->assertWritableRepo(); // fail out if read-only
1113 $status = $this->newGood();
1114 $status->merge( $this->backend
->clean(
1115 array( 'dir' => $this->resolveToStoragePath( $dir ) ) ) );
1121 * Checks existence of a a file
1123 * @param $file string Virtual URL (or storage path) of file to check
1126 public function fileExists( $file ) {
1127 $result = $this->fileExistsBatch( array( $file ) );
1132 * Checks existence of an array of files.
1134 * @param $files Array: Virtual URLs (or storage paths) of files to check
1135 * @return array|bool Either array of files and existence flags, or false
1137 public function fileExistsBatch( array $files ) {
1139 foreach ( $files as $key => $file ) {
1140 $file = $this->resolveToStoragePath( $file );
1141 $result[$key] = $this->backend
->fileExists( array( 'src' => $file ) );
1147 * Move a file to the deletion archive.
1148 * If no valid deletion archive exists, this may either delete the file
1149 * or throw an exception, depending on the preference of the repository
1151 * @param $srcRel Mixed: relative path for the file to be deleted
1152 * @param $archiveRel Mixed: relative path for the archive location.
1153 * Relative to a private archive directory.
1154 * @return FileRepoStatus object
1156 public function delete( $srcRel, $archiveRel ) {
1157 $this->assertWritableRepo(); // fail out if read-only
1159 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
1163 * Move a group of files to the deletion archive.
1165 * If no valid deletion archive is configured, this may either delete the
1166 * file or throw an exception, depending on the preference of the repository.
1168 * The overwrite policy is determined by the repository -- currently LocalRepo
1169 * assumes a naming scheme in the deleted zone based on content hash, as
1170 * opposed to the public zone which is assumed to be unique.
1172 * @param $sourceDestPairs Array of source/destination pairs. Each element
1173 * is a two-element array containing the source file path relative to the
1174 * public root in the first element, and the archive file path relative
1175 * to the deleted zone root in the second element.
1176 * @return FileRepoStatus
1178 public function deleteBatch( array $sourceDestPairs ) {
1179 $this->assertWritableRepo(); // fail out if read-only
1181 // Try creating directories
1182 $status = $this->initZones( array( 'public', 'deleted' ) );
1183 if ( !$status->isOK() ) {
1187 $status = $this->newGood();
1189 $backend = $this->backend
; // convenience
1190 $operations = array();
1191 // Validate filenames and create archive directories
1192 foreach ( $sourceDestPairs as $pair ) {
1193 list( $srcRel, $archiveRel ) = $pair;
1194 if ( !$this->validateFilename( $srcRel ) ) {
1195 throw new MWException( __METHOD__
.':Validation error in $srcRel' );
1196 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1197 throw new MWException( __METHOD__
.':Validation error in $archiveRel' );
1200 $publicRoot = $this->getZonePath( 'public' );
1201 $srcPath = "{$publicRoot}/$srcRel";
1203 $deletedRoot = $this->getZonePath( 'deleted' );
1204 $archivePath = "{$deletedRoot}/{$archiveRel}";
1205 $archiveDir = dirname( $archivePath ); // does not touch FS
1207 // Create destination directories
1208 if ( !$backend->prepare( array( 'dir' => $archiveDir ) )->isOK() ) {
1209 return $this->newFatal( 'directorycreateerror', $archiveDir );
1211 $this->initDeletedDir( $archiveDir );
1213 $operations[] = array(
1216 'dst' => $archivePath,
1217 // We may have 2+ identical files being deleted,
1218 // all of which will map to the same destination file
1219 'overwriteSame' => true // also see bug 31792
1223 // Move the files by execute the operations for each pair.
1224 // We're now committed to returning an OK result, which will
1225 // lead to the files being moved in the DB also.
1226 $opts = array( 'force' => true );
1227 $status->merge( $backend->doOperations( $operations, $opts ) );
1233 * Delete files in the deleted directory if they are not referenced in the filearchive table
1237 public function cleanupDeletedBatch( array $storageKeys ) {
1238 $this->assertWritableRepo();
1242 * Get a relative path for a deletion archive key,
1243 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1247 public function getDeletedHashPath( $key ) {
1249 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1250 $path .= $key[$i] . '/';
1256 * If a path is a virtual URL, resolve it to a storage path.
1257 * Otherwise, just return the path as it is.
1259 * @param $path string
1261 * @throws MWException
1263 protected function resolveToStoragePath( $path ) {
1264 if ( $this->isVirtualUrl( $path ) ) {
1265 return $this->resolveVirtualUrl( $path );
1271 * Get a local FS copy of a file with a given virtual URL/storage path.
1272 * Temporary files may be purged when the file object falls out of scope.
1274 * @param $virtualUrl string
1275 * @return TempFSFile|null Returns null on failure
1277 public function getLocalCopy( $virtualUrl ) {
1278 $path = $this->resolveToStoragePath( $virtualUrl );
1279 return $this->backend
->getLocalCopy( array( 'src' => $path ) );
1283 * Get a local FS file with a given virtual URL/storage path.
1284 * The file is either an original or a copy. It should not be changed.
1285 * Temporary files may be purged when the file object falls out of scope.
1287 * @param $virtualUrl string
1288 * @return FSFile|null Returns null on failure.
1290 public function getLocalReference( $virtualUrl ) {
1291 $path = $this->resolveToStoragePath( $virtualUrl );
1292 return $this->backend
->getLocalReference( array( 'src' => $path ) );
1296 * Get properties of a file with a given virtual URL/storage path.
1297 * Properties should ultimately be obtained via FSFile::getProps().
1299 * @param $virtualUrl string
1302 public function getFileProps( $virtualUrl ) {
1303 $path = $this->resolveToStoragePath( $virtualUrl );
1304 return $this->backend
->getFileProps( array( 'src' => $path ) );
1308 * Get the timestamp of a file with a given virtual URL/storage path
1310 * @param $virtualUrl string
1311 * @return string|bool False on failure
1313 public function getFileTimestamp( $virtualUrl ) {
1314 $path = $this->resolveToStoragePath( $virtualUrl );
1315 return $this->backend
->getFileTimestamp( array( 'src' => $path ) );
1319 * Get the sha1 of a file with a given virtual URL/storage path
1321 * @param $virtualUrl string
1322 * @return string|bool
1324 public function getFileSha1( $virtualUrl ) {
1325 $path = $this->resolveToStoragePath( $virtualUrl );
1326 $tmpFile = $this->backend
->getLocalReference( array( 'src' => $path ) );
1330 return $tmpFile->getSha1Base36();
1334 * Attempt to stream a file with the given virtual URL/storage path
1336 * @param $virtualUrl string
1337 * @param $headers Array Additional HTTP headers to send on success
1338 * @return bool Success
1340 public function streamFile( $virtualUrl, $headers = array() ) {
1341 $path = $this->resolveToStoragePath( $virtualUrl );
1342 $params = array( 'src' => $path, 'headers' => $headers );
1343 return $this->backend
->streamFile( $params )->isOK();
1347 * Call a callback function for every public regular file in the repository.
1348 * This only acts on the current version of files, not any old versions.
1349 * May use either the database or the filesystem.
1351 * @param $callback Array|string
1354 public function enumFiles( $callback ) {
1355 $this->enumFilesInStorage( $callback );
1359 * Call a callback function for every public file in the repository.
1360 * May use either the database or the filesystem.
1362 * @param $callback Array|string
1365 protected function enumFilesInStorage( $callback ) {
1366 $publicRoot = $this->getZonePath( 'public' );
1367 $numDirs = 1 << ( $this->hashLevels
* 4 );
1368 // Use a priori assumptions about directory structure
1369 // to reduce the tree height of the scanning process.
1370 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1371 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1372 $path = $publicRoot;
1373 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1374 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1376 $iterator = $this->backend
->getFileList( array( 'dir' => $path ) );
1377 foreach ( $iterator as $name ) {
1378 // Each item returned is a public file
1379 call_user_func( $callback, "{$path}/{$name}" );
1385 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1387 * @param $filename string
1390 public function validateFilename( $filename ) {
1391 if ( strval( $filename ) == '' ) {
1394 return FileBackend
::isPathTraversalFree( $filename );
1398 * Get a callback function to use for cleaning error message parameters
1402 function getErrorCleanupFunction() {
1403 switch ( $this->pathDisclosureProtection
) {
1405 case 'simple': // b/c
1406 $callback = array( $this, 'passThrough' );
1408 default: // 'paranoid'
1409 $callback = array( $this, 'paranoidClean' );
1415 * Path disclosure protection function
1417 * @param $param string
1420 function paranoidClean( $param ) {
1425 * Path disclosure protection function
1427 * @param $param string
1430 function passThrough( $param ) {
1435 * Create a new fatal error
1437 * @return FileRepoStatus
1439 public function newFatal( $message /*, parameters...*/ ) {
1440 $params = func_get_args();
1441 array_unshift( $params, $this );
1442 return MWInit
::callStaticMethod( 'FileRepoStatus', 'newFatal', $params );
1446 * Create a new good result
1448 * @return FileRepoStatus
1450 public function newGood( $value = null ) {
1451 return FileRepoStatus
::newGood( $this, $value );
1455 * Checks if there is a redirect named as $title. If there is, return the
1456 * title object. If not, return false.
1459 * @param $title Title of image
1462 public function checkRedirect( Title
$title ) {
1467 * Invalidates image redirect cache related to that image
1468 * Doesn't do anything for repositories that don't support image redirects.
1471 * @param $title Title of image
1473 public function invalidateImageRedirect( Title
$title ) {}
1476 * Get the human-readable name of the repo
1480 public function getDisplayName() {
1481 // We don't name our own repo, return nothing
1482 if ( $this->isLocal() ) {
1485 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1486 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1490 * Returns true if this the local file repository.
1494 public function isLocal() {
1495 return $this->getName() == 'local';
1499 * Get a key on the primary cache for this repository.
1500 * Returns false if the repository's cache is not accessible at this site.
1501 * The parameters are the parts of the key, as for wfMemcKey().
1506 public function getSharedCacheKey( /*...*/ ) {
1511 * Get a key for this repo in the local cache domain. These cache keys are
1512 * not shared with remote instances of the repo.
1513 * The parameters are the parts of the key, as for wfMemcKey().
1517 public function getLocalCacheKey( /*...*/ ) {
1518 $args = func_get_args();
1519 array_unshift( $args, 'filerepo', $this->getName() );
1520 return call_user_func_array( 'wfMemcKey', $args );
1524 * Get an temporary FileRepo associated with this repo.
1525 * Files will be created in the temp zone of this repo and
1526 * thumbnails in a /temp subdirectory in thumb zone of this repo.
1527 * It will have the same backend as this repo.
1529 * @return TempFileRepo
1531 public function getTempRepo() {
1532 return new TempFileRepo( array(
1533 'name' => "{$this->name}-temp",
1534 'backend' => $this->backend
,
1537 'container' => $this->zones
['temp']['container'],
1538 'directory' => $this->zones
['temp']['directory']
1541 'container' => $this->zones
['thumb']['container'],
1542 'directory' => ( $this->zones
['thumb']['directory'] == '' )
1544 : $this->zones
['thumb']['directory'] . '/temp'
1547 'url' => $this->getZoneUrl( 'temp' ),
1548 'thumbUrl' => $this->getZoneUrl( 'thumb' ) . '/temp',
1549 'hashLevels' => $this->hashLevels
// performance
1554 * Get an UploadStash associated with this repo.
1556 * @return UploadStash
1558 public function getUploadStash() {
1559 return new UploadStash( $this );
1563 * Throw an exception if this repo is read-only by design.
1564 * This does not and should not check getReadOnlyReason().
1567 * @throws MWException
1569 protected function assertWritableRepo() {}
1573 * FileRepo for temporary files created via FileRepo::getTempRepo()
1575 class TempFileRepo
extends FileRepo
{
1576 public function getTempRepo() {
1577 throw new MWException( "Cannot get a temp repo from a temp repo." );