4 * Base class for file repositories
5 * Do not instantiate, use a derived class.
8 abstract class FileRepo
{
9 const DELETE_SOURCE
= 1;
10 const FIND_PRIVATE
= 1;
11 const FIND_IGNORE_REDIRECT
= 2;
13 const OVERWRITE_SAME
= 4;
15 var $thumbScriptUrl, $transformVia404;
16 var $descBaseUrl, $scriptDirUrl, $articleUrl, $fetchDescription, $initialCapital;
17 var $pathDisclosureProtection = 'paranoid';
18 var $descriptionCacheExpiry, $apiThumbCacheExpiry, $hashLevels;
21 * Factory functions for creating new files
22 * Override these in the base class
24 var $fileFactory = false, $oldFileFactory = false;
25 var $fileFactoryKey = false, $oldFileFactoryKey = false;
27 function __construct( $info ) {
29 $this->name
= $info['name'];
32 $this->initialCapital
= true; // by default
33 foreach ( array( 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
34 'thumbScriptUrl', 'initialCapital', 'pathDisclosureProtection',
35 'descriptionCacheExpiry', 'apiThumbCacheExpiry', 'hashLevels' ) as $var )
37 if ( isset( $info[$var] ) ) {
38 $this->$var = $info[$var];
41 $this->transformVia404
= !empty( $info['transformVia404'] );
45 * Determine if a string is an mwrepo:// URL
47 static function isVirtualUrl( $url ) {
48 return substr( $url, 0, 9 ) == 'mwrepo://';
52 * Create a new File object from the local repository
53 * @param mixed $title Title object or string
54 * @param mixed $time Time at which the image was uploaded.
55 * If this is specified, the returned object will be an
56 * instance of the repository's old file class instead of
57 * a current file. Repositories not supporting version
58 * control should return false if this parameter is set.
60 function newFile( $title, $time = false ) {
61 if ( !($title instanceof Title
) ) {
62 $title = Title
::makeTitleSafe( NS_FILE
, $title );
63 if ( !is_object( $title ) ) {
68 if ( $this->oldFileFactory
) {
69 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
74 return call_user_func( $this->fileFactory
, $title, $this );
79 * Find an instance of the named file created at the specified time
80 * Returns false if the file does not exist. Repositories not supporting
81 * version control should return false if the time is specified.
83 * @param mixed $title Title object or string
84 * @param mixed $time 14-character timestamp, or false for the current version
86 function findFile( $title, $time = false, $flags = 0 ) {
87 if ( !($title instanceof Title
) ) {
88 $title = Title
::makeTitleSafe( NS_FILE
, $title );
89 if ( !is_object( $title ) ) {
93 # First try the current version of the file to see if it precedes the timestamp
94 $img = $this->newFile( $title );
98 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
101 # Now try an old version of the file
102 if ( $time !== false ) {
103 $img = $this->newFile( $title, $time );
104 if ( $img && $img->exists() ) {
105 if ( !$img->isDeleted(File
::DELETED_FILE
) ) {
107 } else if ( ($flags & FileRepo
::FIND_PRIVATE
) && $img->userCan(File
::DELETED_FILE
) ) {
114 if ( $flags & FileRepo
::FIND_IGNORE_REDIRECT
) {
117 $redir = $this->checkRedirect( $title );
118 if( $redir && $redir->getNamespace() == NS_FILE
) {
119 $img = $this->newFile( $redir );
123 if( $img->exists() ) {
124 $img->redirectedFrom( $title->getDBkey() );
132 * Find many files at once.
133 * @param array $titles, an array of titles
134 * @todo Think of a good way to optionally pass timestamps to this function.
136 function findFiles( $titles ) {
138 foreach ( $titles as $index => $title ) {
139 $file = $this->findFile( $title );
141 $result[$file->getTitle()->getDBkey()] = $file;
147 * Create a new File object from the local repository
148 * @param mixed $sha1 SHA-1 key
149 * @param mixed $time Time at which the image was uploaded.
150 * If this is specified, the returned object will be an
151 * instance of the repository's old file class instead of
152 * a current file. Repositories not supporting version
153 * control should return false if this parameter is set.
155 function newFileFromKey( $sha1, $time = false ) {
157 if ( $this->oldFileFactoryKey
) {
158 return call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
163 return call_user_func( $this->fileFactoryKey
, $sha1, $this );
168 * Find an instance of the file with this key, created at the specified time
169 * Returns false if the file does not exist. Repositories not supporting
170 * version control should return false if the time is specified.
172 * @param string $sha1 string
173 * @param mixed $time 14-character timestamp, or false for the current version
175 function findFileFromKey( $sha1, $time = false, $flags = 0 ) {
176 # First try the current version of the file to see if it precedes the timestamp
177 $img = $this->newFileFromKey( $sha1 );
181 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
184 # Now try an old version of the file
185 if ( $time !== false ) {
186 $img = $this->newFileFromKey( $sha1, $time );
187 if ( $img->exists() ) {
188 if ( !$img->isDeleted(File
::DELETED_FILE
) ) {
190 } else if ( ($flags & FileRepo
::FIND_PRIVATE
) && $img->userCan(File
::DELETED_FILE
) ) {
199 * Get the URL of thumb.php
201 function getThumbScriptUrl() {
202 return $this->thumbScriptUrl
;
206 * Returns true if the repository can transform files via a 404 handler
208 function canTransformVia404() {
209 return $this->transformVia404
;
213 * Get the name of an image from its title object
215 function getNameFromTitle( $title ) {
216 global $wgCapitalLinks;
217 if ( $this->initialCapital
!= $wgCapitalLinks ) {
219 $name = $title->getUserCaseDBKey();
220 if ( $this->initialCapital
) {
221 $name = $wgContLang->ucfirst( $name );
224 $name = $title->getDBkey();
229 static function getHashPathForLevel( $name, $levels ) {
230 if ( $levels == 0 ) {
233 $hash = md5( $name );
235 for ( $i = 1; $i <= $levels; $i++
) {
236 $path .= substr( $hash, 0, $i ) . '/';
243 * Get a relative path including trailing slash, e.g. f/fa/
244 * If the repo is not hashed, returns an empty string
246 function getHashPath( $name ) {
247 return self
::getHashPathForLevel( $name, $this->hashLevels
);
251 * Get the name of this repository, as specified by $info['name]' to the constructor
258 * Get the URL of an image description page. May return false if it is
259 * unknown or not applicable. In general this should only be called by the
260 * File class, since it may return invalid results for certain kinds of
261 * repositories. Use File::getDescriptionUrl() in user code.
263 * In particular, it uses the article paths as specified to the repository
264 * constructor, whereas local repositories use the local Title functions.
266 function getDescriptionUrl( $name ) {
267 $encName = wfUrlencode( $name );
268 if ( !is_null( $this->descBaseUrl
) ) {
269 # "http://example.com/wiki/Image:"
270 return $this->descBaseUrl
. $encName;
272 if ( !is_null( $this->articleUrl
) ) {
273 # "http://example.com/wiki/$1"
275 # We use "Image:" as the canonical namespace for
276 # compatibility across all MediaWiki versions.
277 return str_replace( '$1',
278 "Image:$encName", $this->articleUrl
);
280 if ( !is_null( $this->scriptDirUrl
) ) {
281 # "http://example.com/w"
283 # We use "Image:" as the canonical namespace for
284 # compatibility across all MediaWiki versions,
285 # and just sort of hope index.php is right. ;)
286 return $this->scriptDirUrl
.
287 "/index.php?title=Image:$encName";
293 * Get the URL of the content-only fragment of the description page. For
294 * MediaWiki this means action=render. This should only be called by the
295 * repository's file class, since it may return invalid results. User code
296 * should use File::getDescriptionText().
297 * @param string $name Name of image to fetch
298 * @param string $lang Language to fetch it in, if any.
300 function getDescriptionRenderUrl( $name, $lang = null ) {
301 $query = 'action=render';
302 if ( !is_null( $lang ) ) {
303 $query .= '&uselang=' . $lang;
305 if ( isset( $this->scriptDirUrl
) ) {
306 return $this->scriptDirUrl
. '/index.php?title=' .
307 wfUrlencode( 'Image:' . $name ) .
310 $descUrl = $this->getDescriptionUrl( $name );
312 return wfAppendQuery( $descUrl, $query );
320 * Store a file to a given destination.
322 * @param string $srcPath Source path or virtual URL
323 * @param string $dstZone Destination zone
324 * @param string $dstRel Destination relative path
325 * @param integer $flags Bitwise combination of the following flags:
326 * self::DELETE_SOURCE Delete the source file after upload
327 * self::OVERWRITE Overwrite an existing destination file instead of failing
328 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
329 * same contents as the source
330 * @return FileRepoStatus
332 function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
333 $status = $this->storeBatch( array( array( $srcPath, $dstZone, $dstRel ) ), $flags );
334 if ( $status->successCount
== 0 ) {
341 * Store a batch of files
343 * @param array $triplets (src,zone,dest) triplets as per store()
344 * @param integer $flags Flags as per store
346 abstract function storeBatch( $triplets, $flags = 0 );
349 * Pick a random name in the temp zone and store a file to it.
350 * Returns a FileRepoStatus object with the URL in the value.
352 * @param string $originalName The base name of the file as specified
353 * by the user. The file extension will be maintained.
354 * @param string $srcPath The current location of the file.
356 abstract function storeTemp( $originalName, $srcPath );
359 * Remove a temporary file or mark it for garbage collection
360 * @param string $virtualUrl The virtual URL returned by storeTemp
361 * @return boolean True on success, false on failure
364 function freeTemp( $virtualUrl ) {
369 * Copy or move a file either from the local filesystem or from an mwrepo://
370 * virtual URL, into this repository at the specified destination location.
372 * Returns a FileRepoStatus object. On success, the value contains "new" or
373 * "archived", to indicate whether the file was new with that name.
375 * @param string $srcPath The source path or URL
376 * @param string $dstRel The destination relative path
377 * @param string $archiveRel The relative path where the existing file is to
378 * be archived, if there is one. Relative to the public zone root.
379 * @param integer $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
380 * that the source file should be deleted if possible
382 function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
383 $status = $this->publishBatch( array( array( $srcPath, $dstRel, $archiveRel ) ), $flags );
384 if ( $status->successCount
== 0 ) {
387 if ( isset( $status->value
[0] ) ) {
388 $status->value
= $status->value
[0];
390 $status->value
= false;
396 * Publish a batch of files
397 * @param array $triplets (source,dest,archive) triplets as per publish()
398 * @param integer $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
399 * that the source files should be deleted if possible
401 abstract function publishBatch( $triplets, $flags = 0 );
404 * Move a group of files to the deletion archive.
406 * If no valid deletion archive is configured, this may either delete the
407 * file or throw an exception, depending on the preference of the repository.
409 * The overwrite policy is determined by the repository -- currently FSRepo
410 * assumes a naming scheme in the deleted zone based on content hash, as
411 * opposed to the public zone which is assumed to be unique.
413 * @param array $sourceDestPairs Array of source/destination pairs. Each element
414 * is a two-element array containing the source file path relative to the
415 * public root in the first element, and the archive file path relative
416 * to the deleted zone root in the second element.
417 * @return FileRepoStatus
419 abstract function deleteBatch( $sourceDestPairs );
422 * Move a file to the deletion archive.
423 * If no valid deletion archive exists, this may either delete the file
424 * or throw an exception, depending on the preference of the repository
425 * @param mixed $srcRel Relative path for the file to be deleted
426 * @param mixed $archiveRel Relative path for the archive location.
427 * Relative to a private archive directory.
428 * @return WikiError object (wikitext-formatted), or true for success
430 function delete( $srcRel, $archiveRel ) {
431 return $this->deleteBatch( array( array( $srcRel, $archiveRel ) ) );
435 * Get properties of a file with a given virtual URL
436 * The virtual URL must refer to this repo
437 * Properties should ultimately be obtained via File::getPropsFromPath()
439 abstract function getFileProps( $virtualUrl );
442 * Call a callback function for every file in the repository
443 * May use either the database or the filesystem
446 function enumFiles( $callback ) {
447 throw new MWException( 'enumFiles is not supported by ' . get_class( $this ) );
451 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
453 function validateFilename( $filename ) {
454 if ( strval( $filename ) == '' ) {
457 if ( wfIsWindows() ) {
458 $filename = strtr( $filename, '\\', '/' );
461 * Use the same traversal protection as Title::secureAndSplit()
463 if ( strpos( $filename, '.' ) !== false &&
464 ( $filename === '.' ||
$filename === '..' ||
465 strpos( $filename, './' ) === 0 ||
466 strpos( $filename, '../' ) === 0 ||
467 strpos( $filename, '/./' ) !== false ||
468 strpos( $filename, '/../' ) !== false ) )
477 * Path disclosure protection functions
479 function paranoidClean( $param ) { return '[hidden]'; }
480 function passThrough( $param ) { return $param; }
483 * Get a callback function to use for cleaning error message parameters
485 function getErrorCleanupFunction() {
486 switch ( $this->pathDisclosureProtection
) {
488 $callback = array( $this, 'passThrough' );
490 default: // 'paranoid'
491 $callback = array( $this, 'paranoidClean' );
498 * Create a new fatal error
500 function newFatal( $message /*, parameters...*/ ) {
501 $params = func_get_args();
502 array_unshift( $params, $this );
503 return call_user_func_array( array( 'FileRepoStatus', 'newFatal' ), $params );
507 * Create a new good result
509 function newGood( $value = null ) {
510 return FileRepoStatus
::newGood( $this, $value );
514 * Delete files in the deleted directory if they are not referenced in the filearchive table
517 function cleanupDeletedBatch( $storageKeys ) {}
520 * Checks if there is a redirect named as $title
523 * @param Title $title Title of image
525 function checkRedirect( $title ) {
530 * Invalidates image redirect cache related to that image
533 * @param Title $title Title of image
535 function invalidateImageRedirect( $title ) {
538 function findBySha1( $hash ) {