3 * @defgroup FileAbstraction File abstraction
6 * Represents files in a repository.
10 * Base code for files.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup FileAbstraction
32 * Implements some public methods and some protected utility functions which
33 * are required by multiple child classes. Contains stub functionality for
34 * unimplemented public methods.
36 * Stub functions which should be overridden are marked with STUB. Some more
37 * concrete functions are also typically overridden by child classes.
39 * Note that only the repo object knows what its file class is called. You should
40 * never name a file class explictly outside of the repo class. Instead use the
41 * repo's factory functions to generate file objects, for example:
43 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
45 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
48 * @ingroup FileAbstraction
51 // Bitfield values akin to the Revision deletion constants
52 const DELETED_FILE
= 1;
53 const DELETED_COMMENT
= 2;
54 const DELETED_USER
= 4;
55 const DELETED_RESTRICTED
= 8;
57 /** Force rendering in the current process */
60 * Force rendering even if thumbnail already exist and using RENDER_NOW
61 * I.e. you have to pass both flags: File::RENDER_NOW | File::RENDER_FORCE
63 const RENDER_FORCE
= 2;
65 const DELETE_SOURCE
= 1;
67 // Audience options for File::getDescription()
69 const FOR_THIS_USER
= 2;
72 // Options for File::thumbName()
73 const THUMB_FULL_NAME
= 1;
76 * Some member variables can be lazy-initialised using __get(). The
77 * initialisation function for these variables is always a function named
78 * like getVar(), where Var is the variable name with upper-case first
81 * The following variables are initialised in this way in this base class:
82 * name, extension, handler, path, canRender, isSafeFile,
83 * transformScript, hashPath, pageCount, url
85 * Code within this class should generally use the accessor function
86 * directly, since __get() isn't re-entrant and therefore causes bugs that
87 * depend on initialisation order.
91 * The following member variables are not lazy-initialised
94 /** @var FileRepo|LocalRepo|ForeignAPIRepo|bool */
97 /** @var Title|string|bool */
100 /** @var string Text of last error */
101 protected $lastError;
103 /** @var string Main part of the title, with underscores (Title::getDBkey) */
104 protected $redirected;
107 protected $redirectedTitle;
109 /** @var FSFile|bool False if undefined */
112 /** @var MediaHandler */
115 /** @var string The URL corresponding to one of the four basic zones */
118 /** @var string File extension */
119 protected $extension;
121 /** @var string The name of a file from its title object */
124 /** @var string The storage path corresponding to one of the zones */
127 /** @var string Relative path including trailing slash */
130 /** @var string number of pages of a multipage document, or false for
131 * documents which aren't multipage documents
133 protected $pageCount;
135 /** @var string URL of transformscript (for example thumb.php) */
136 protected $transformScript;
139 protected $redirectTitle;
141 /** @var bool Wether the output of transform() for this file is likely to be valid. */
142 protected $canRender;
144 /** @var bool Wether this media file is in a format that is unlikely to
145 * contain viruses or malicious content
147 protected $isSafeFile;
149 /** @var string Required Repository class type */
150 protected $repoClass = 'FileRepo';
153 * Call this constructor from child classes.
155 * Both $title and $repo are optional, though some functions
156 * may return false or throw exceptions if they are not set.
157 * Most subclasses will want to call assertRepoDefined() here.
159 * @param Title|string|bool $title
160 * @param FileRepo|bool $repo
162 function __construct( $title, $repo ) {
163 if ( $title !== false ) { // subclasses may not use MW titles
164 $title = self
::normalizeTitle( $title, 'exception' );
166 $this->title
= $title;
171 * Given a string or Title object return either a
172 * valid Title object with namespace NS_FILE or null
174 * @param Title|string $title
175 * @param string|bool $exception Use 'exception' to throw an error on bad titles
176 * @throws MWException
179 static function normalizeTitle( $title, $exception = false ) {
181 if ( $ret instanceof Title
) {
182 # Normalize NS_MEDIA -> NS_FILE
183 if ( $ret->getNamespace() == NS_MEDIA
) {
184 $ret = Title
::makeTitleSafe( NS_FILE
, $ret->getDBkey() );
185 # Sanity check the title namespace
186 } elseif ( $ret->getNamespace() !== NS_FILE
) {
190 # Convert strings to Title objects
191 $ret = Title
::makeTitleSafe( NS_FILE
, (string)$ret );
193 if ( !$ret && $exception !== false ) {
194 throw new MWException( "`$title` is not a valid file title." );
200 function __get( $name ) {
201 $function = array( $this, 'get' . ucfirst( $name ) );
202 if ( !is_callable( $function ) ) {
205 $this->$name = call_user_func( $function );
212 * Normalize a file extension to the common form, and ensure it's clean.
213 * Extensions with non-alphanumeric characters will be discarded.
215 * @param string $ext (without the .)
218 static function normalizeExtension( $ext ) {
219 $lower = strtolower( $ext );
226 if ( isset( $squish[$lower] ) ) {
227 return $squish[$lower];
228 } elseif ( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
236 * Checks if file extensions are compatible
238 * @param File $old Old file
239 * @param string $new New name
243 static function checkExtensionCompatibility( File
$old, $new ) {
244 $oldMime = $old->getMimeType();
245 $n = strrpos( $new, '.' );
246 $newExt = self
::normalizeExtension( $n ?
substr( $new, $n +
1 ) : '' );
247 $mimeMagic = MimeMagic
::singleton();
249 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
253 * Upgrade the database row if there is one
254 * Called by ImagePage
257 function upgradeRow() {
261 * Split an internet media type into its two components; if not
262 * a two-part name, set the minor type to 'unknown'.
264 * @param string $mime "text/html" etc
265 * @return array ("text", "html") etc
267 public static function splitMime( $mime ) {
268 if ( strpos( $mime, '/' ) !== false ) {
269 return explode( '/', $mime, 2 );
271 return array( $mime, 'unknown' );
276 * Callback for usort() to do file sorts by name
280 * @return int Result of name comparison
282 public static function compare( File
$a, File
$b ) {
283 return strcmp( $a->getName(), $b->getName() );
287 * Return the name of this file
291 public function getName() {
292 if ( !isset( $this->name
) ) {
293 $this->assertRepoDefined();
294 $this->name
= $this->repo
->getNameFromTitle( $this->title
);
301 * Get the file extension, e.g. "svg"
305 function getExtension() {
306 if ( !isset( $this->extension
) ) {
307 $n = strrpos( $this->getName(), '.' );
308 $this->extension
= self
::normalizeExtension(
309 $n ?
substr( $this->getName(), $n +
1 ) : '' );
312 return $this->extension
;
316 * Return the associated title object
320 public function getTitle() {
325 * Return the title used to find this file
329 public function getOriginalTitle() {
330 if ( $this->redirected
) {
331 return $this->getRedirectedTitle();
338 * Return the URL of the file
342 public function getUrl() {
343 if ( !isset( $this->url
) ) {
344 $this->assertRepoDefined();
345 $ext = $this->getExtension();
346 $this->url
= $this->repo
->getZoneUrl( 'public', $ext ) . '/' . $this->getUrlRel();
353 * Return a fully-qualified URL to the file.
354 * Upload URL paths _may or may not_ be fully qualified, so
355 * we check. Local paths are assumed to belong on $wgServer.
359 public function getFullUrl() {
360 return wfExpandUrl( $this->getUrl(), PROTO_RELATIVE
);
366 public function getCanonicalUrl() {
367 return wfExpandUrl( $this->getUrl(), PROTO_CANONICAL
);
373 function getViewURL() {
374 if ( $this->mustRender() ) {
375 if ( $this->canRender() ) {
376 return $this->createThumb( $this->getWidth() );
378 wfDebug( __METHOD__
. ': supposed to render ' . $this->getName() .
379 ' (' . $this->getMimeType() . "), but can't!\n" );
381 return $this->getURL(); #hm... return NULL?
384 return $this->getURL();
389 * Return the storage path to the file. Note that this does
390 * not mean that a file actually exists under that location.
392 * This path depends on whether directory hashing is active or not,
393 * i.e. whether the files are all found in the same directory,
394 * or in hashed paths like /images/3/3c.
396 * Most callers don't check the return value, but ForeignAPIFile::getPath
399 * @return string|bool ForeignAPIFile::getPath can return false
401 public function getPath() {
402 if ( !isset( $this->path
) ) {
403 $this->assertRepoDefined();
404 $this->path
= $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
411 * Get an FS copy or original of this file and return the path.
412 * Returns false on failure. Callers must not alter the file.
413 * Temporary files are cleared automatically.
415 * @return string|bool False on failure
417 public function getLocalRefPath() {
418 $this->assertRepoDefined();
419 if ( !isset( $this->fsFile
) ) {
420 $this->fsFile
= $this->repo
->getLocalReference( $this->getPath() );
421 if ( !$this->fsFile
) {
422 $this->fsFile
= false; // null => false; cache negative hits
426 return ( $this->fsFile
)
427 ?
$this->fsFile
->getPath()
432 * Return the width of the image. Returns false if the width is unknown
436 * Overridden by LocalFile, UnregisteredLocalFile
441 public function getWidth( $page = 1 ) {
446 * Return the height of the image. Returns false if the height is unknown
450 * Overridden by LocalFile, UnregisteredLocalFile
453 * @return bool|int False on failure
455 public function getHeight( $page = 1 ) {
460 * Returns ID or name of user who uploaded the file
463 * @param string $type 'text' or 'id'
466 public function getUser( $type = 'text' ) {
471 * Get the duration of a media file in seconds
475 public function getLength() {
476 $handler = $this->getHandler();
478 return $handler->getLength( $this );
485 * Return true if the file is vectorized
489 public function isVectorized() {
490 $handler = $this->getHandler();
492 return $handler->isVectorized( $this );
499 * Gives a (possibly empty) list of languages to render
502 * If the file doesn't have translations, or if the file
503 * format does not support that sort of thing, returns
509 public function getAvailableLanguages() {
510 $handler = $this->getHandler();
512 return $handler->getAvailableLanguages( $this );
519 * In files that support multiple language, what is the default language
520 * to use if none specified.
522 * @return String lang code, or null if filetype doesn't support multiple languages.
525 public function getDefaultRenderLanguage() {
526 $handler = $this->getHandler();
528 return $handler->getDefaultRenderLanguage( $this );
535 * Will the thumbnail be animated if one would expect it to be.
537 * Currently used to add a warning to the image description page
539 * @return bool false if the main image is both animated
540 * and the thumbnail is not. In all other cases must return
541 * true. If image is not renderable whatsoever, should
544 public function canAnimateThumbIfAppropriate() {
545 $handler = $this->getHandler();
547 // We cannot handle image whatsoever, thus
548 // one would not expect it to be animated
552 if ( $this->allowInlineDisplay()
553 && $handler->isAnimatedImage( $this )
554 && !$handler->canAnimateThumbnail( $this )
556 // Image is animated, but thumbnail isn't.
557 // This is unexpected to the user.
560 // Image is not animated, so one would
561 // not expect thumb to be
568 * Get handler-specific metadata
569 * Overridden by LocalFile, UnregisteredLocalFile
573 public function getMetadata() {
578 * Like getMetadata but returns a handler independent array of common values.
579 * @see MediaHandler::getCommonMetaArray()
580 * @return array|bool Array or false if not supported
583 public function getCommonMetaArray() {
584 $handler = $this->getHandler();
586 return $handler->getCommonMetaArray( $this );
590 * get versioned metadata
592 * @param array|string $metadata Array or string of (serialized) metadata
593 * @param int $version Version number.
594 * @return array Array containing metadata, or what was passed to it on fail
595 * (unserializing if not array)
597 public function convertMetadataVersion( $metadata, $version ) {
598 $handler = $this->getHandler();
599 if ( !is_array( $metadata ) ) {
600 // Just to make the return type consistent
601 $metadata = unserialize( $metadata );
604 return $handler->convertMetadataVersion( $metadata, $version );
611 * Return the bit depth of the file
612 * Overridden by LocalFile
616 public function getBitDepth() {
621 * Return the size of the image file, in bytes
622 * Overridden by LocalFile, UnregisteredLocalFile
626 public function getSize() {
631 * Returns the mime type of the file.
632 * Overridden by LocalFile, UnregisteredLocalFile
637 function getMimeType() {
638 return 'unknown/unknown';
642 * Return the type of the media in the file.
643 * Use the value returned by this function with the MEDIATYPE_xxx constants.
644 * Overridden by LocalFile,
648 function getMediaType() {
649 return MEDIATYPE_UNKNOWN
;
653 * Checks if the output of transform() for this file is likely
654 * to be valid. If this is false, various user elements will
655 * display a placeholder instead.
657 * Currently, this checks if the file is an image format
658 * that can be converted to a format
659 * supported by all browsers (namely GIF, PNG and JPEG),
660 * or if it is an SVG image and SVG conversion is enabled.
664 function canRender() {
665 if ( !isset( $this->canRender
) ) {
666 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this );
669 return $this->canRender
;
673 * Accessor for __get()
676 protected function getCanRender() {
677 return $this->canRender();
681 * Return true if the file is of a type that can't be directly
682 * rendered by typical browsers and needs to be re-rasterized.
684 * This returns true for everything but the bitmap types
685 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
686 * also return true for any non-image formats.
690 function mustRender() {
691 return $this->getHandler() && $this->handler
->mustRender( $this );
695 * Alias for canRender()
699 function allowInlineDisplay() {
700 return $this->canRender();
704 * Determines if this media file is in a format that is unlikely to
705 * contain viruses or malicious content. It uses the global
706 * $wgTrustedMediaFormats list to determine if the file is safe.
708 * This is used to show a warning on the description page of non-safe files.
709 * It may also be used to disallow direct [[media:...]] links to such files.
711 * Note that this function will always return true if allowInlineDisplay()
712 * or isTrustedFile() is true for this file.
716 function isSafeFile() {
717 if ( !isset( $this->isSafeFile
) ) {
718 $this->isSafeFile
= $this->getIsSafeFileUncached();
721 return $this->isSafeFile
;
725 * Accessor for __get()
729 protected function getIsSafeFile() {
730 return $this->isSafeFile();
738 protected function getIsSafeFileUncached() {
739 global $wgTrustedMediaFormats;
741 if ( $this->allowInlineDisplay() ) {
744 if ( $this->isTrustedFile() ) {
748 $type = $this->getMediaType();
749 $mime = $this->getMimeType();
750 #wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
752 if ( !$type ||
$type === MEDIATYPE_UNKNOWN
) {
753 return false; #unknown type, not trusted
755 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
759 if ( $mime === "unknown/unknown" ) {
760 return false; #unknown type, not trusted
762 if ( in_array( $mime, $wgTrustedMediaFormats ) ) {
770 * Returns true if the file is flagged as trusted. Files flagged that way
771 * can be linked to directly, even if that is not allowed for this type of
774 * This is a dummy function right now and always returns false. It could be
775 * implemented to extract a flag from the database. The trusted flag could be
776 * set on upload, if the user has sufficient privileges, to bypass script-
777 * and html-filters. It may even be coupled with cryptographics signatures
782 function isTrustedFile() {
783 #this could be implemented to check a flag in the database,
784 #look for signatures, etc
789 * Returns true if file exists in the repository.
791 * Overridden by LocalFile to avoid unnecessary stat calls.
793 * @return bool Whether file exists in the repository.
795 public function exists() {
796 return $this->getPath() && $this->repo
->fileExists( $this->path
);
800 * Returns true if file exists in the repository and can be included in a page.
801 * It would be unsafe to include private images, making public thumbnails inadvertently
803 * @return bool Whether file exists in the repository and is includable.
805 public function isVisible() {
806 return $this->exists();
812 function getTransformScript() {
813 if ( !isset( $this->transformScript
) ) {
814 $this->transformScript
= false;
816 $script = $this->repo
->getThumbScriptUrl();
818 $this->transformScript
= wfAppendQuery( $script, array( 'f' => $this->getName() ) );
823 return $this->transformScript
;
827 * Get a ThumbnailImage which is the same size as the source
829 * @param array $handlerParams
833 function getUnscaledThumb( $handlerParams = array() ) {
834 $hp =& $handlerParams;
835 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
836 $width = $this->getWidth( $page );
838 return $this->iconThumb();
840 $hp['width'] = $width;
842 return $this->transform( $hp );
846 * Return the file name of a thumbnail with the specified parameters.
847 * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
848 * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
850 * @param array $params handler-specific parameters
851 * @param int $flags Bitfield that supports THUMB_* constants
854 public function thumbName( $params, $flags = 0 ) {
855 $name = ( $this->repo
&& !( $flags & self
::THUMB_FULL_NAME
) )
856 ?
$this->repo
->nameForThumb( $this->getName() )
859 return $this->generateThumbName( $name, $params );
863 * Generate a thumbnail file name from a name and specified parameters
865 * @param string $name
866 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
869 public function generateThumbName( $name, $params ) {
870 if ( !$this->getHandler() ) {
873 $extension = $this->getExtension();
874 list( $thumbExt, ) = $this->handler
->getThumbType(
875 $extension, $this->getMimeType(), $params );
876 $thumbName = $this->handler
->makeParamString( $params ) . '-' . $name;
877 if ( $thumbExt != $extension ) {
878 $thumbName .= ".$thumbExt";
885 * Create a thumbnail of the image having the specified width/height.
886 * The thumbnail will not be created if the width is larger than the
887 * image's width. Let the browser do the scaling in this case.
888 * The thumbnail is stored on disk and is only computed if the thumbnail
889 * file does not exist OR if it is older than the image.
892 * Keeps aspect ratio of original image. If both width and height are
893 * specified, the generated image will be no bigger than width x height,
894 * and will also have correct aspect ratio.
896 * @param int $width Maximum width of the generated thumbnail
897 * @param int $height Maximum height of the image (optional)
901 public function createThumb( $width, $height = -1 ) {
902 $params = array( 'width' => $width );
903 if ( $height != -1 ) {
904 $params['height'] = $height;
906 $thumb = $this->transform( $params );
907 if ( is_null( $thumb ) ||
$thumb->isError() ) {
911 return $thumb->getUrl();
915 * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
917 * @param string $thumbPath Thumbnail storage path
918 * @param string $thumbUrl Thumbnail URL
919 * @param array $params
921 * @return MediaTransformOutput
923 protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
924 global $wgIgnoreImageErrors;
926 $handler = $this->getHandler();
927 if ( $handler && $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
928 return $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
930 return new MediaTransformError( 'thumbnail_error',
931 $params['width'], 0, wfMessage( 'thumbnail-dest-create' )->text() );
936 * Transform a media file
938 * @param array $params an associative array of handler-specific parameters.
939 * Typical keys are width, height and page.
940 * @param int $flags A bitfield, may contain self::RENDER_NOW to force rendering
941 * @return MediaTransformOutput|bool False on failure
943 function transform( $params, $flags = 0 ) {
944 global $wgUseSquid, $wgIgnoreImageErrors, $wgThumbnailEpoch;
946 wfProfileIn( __METHOD__
);
948 if ( !$this->canRender() ) {
949 $thumb = $this->iconThumb();
950 break; // not a bitmap or renderable image, don't try
953 // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
954 $descriptionUrl = $this->getDescriptionUrl();
955 if ( $descriptionUrl ) {
956 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL
);
959 $handler = $this->getHandler();
960 $script = $this->getTransformScript();
961 if ( $script && !( $flags & self
::RENDER_NOW
) ) {
962 // Use a script to transform on client request, if possible
963 $thumb = $handler->getScriptedTransform( $this, $script, $params );
969 $normalisedParams = $params;
970 $handler->normaliseParams( $this, $normalisedParams );
972 $thumbName = $this->thumbName( $normalisedParams );
973 $thumbUrl = $this->getThumbUrl( $thumbName );
974 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
977 // Defer rendering if a 404 handler is set up...
978 if ( $this->repo
->canTransformVia404() && !( $flags & self
::RENDER_NOW
) ) {
979 wfDebug( __METHOD__
. " transformation deferred." );
980 // XXX: Pass in the storage path even though we are not rendering anything
981 // and the path is supposed to be an FS path. This is due to getScalerType()
982 // getting called on the path and clobbering $thumb->getUrl() if it's false.
983 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
986 // Clean up broken thumbnails as needed
987 $this->migrateThumbFile( $thumbName );
988 // Check if an up-to-date thumbnail already exists...
989 wfDebug( __METHOD__
. ": Doing stat for $thumbPath\n" );
990 if ( !( $flags & self
::RENDER_FORCE
) && $this->repo
->fileExists( $thumbPath ) ) {
991 $timestamp = $this->repo
->getFileTimestamp( $thumbPath );
992 if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
993 // XXX: Pass in the storage path even though we are not rendering anything
994 // and the path is supposed to be an FS path. This is due to getScalerType()
995 // getting called on the path and clobbering $thumb->getUrl() if it's false.
996 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
997 $thumb->setStoragePath( $thumbPath );
1000 } elseif ( $flags & self
::RENDER_FORCE
) {
1001 wfDebug( __METHOD__
. " forcing rendering per flag File::RENDER_FORCE\n" );
1005 // If the backend is ready-only, don't keep generating thumbnails
1006 // only to return transformation errors, just return the error now.
1007 if ( $this->repo
->getReadOnlyReason() !== false ) {
1008 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1012 // Create a temp FS file with the same extension and the thumbnail
1013 $thumbExt = FileBackend
::extensionFromPath( $thumbPath );
1014 $tmpFile = TempFSFile
::factory( 'transform_', $thumbExt );
1016 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1019 $tmpThumbPath = $tmpFile->getPath(); // path of 0-byte temp file
1021 // Actually render the thumbnail...
1022 wfProfileIn( __METHOD__
. '-doTransform' );
1023 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $params );
1024 wfProfileOut( __METHOD__
. '-doTransform' );
1025 $tmpFile->bind( $thumb ); // keep alive with $thumb
1027 if ( !$thumb ) { // bad params?
1029 } elseif ( $thumb->isError() ) { // transform error
1030 $this->lastError
= $thumb->toText();
1031 // Ignore errors if requested
1032 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1033 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $params );
1035 } elseif ( $this->repo
&& $thumb->hasFile() && !$thumb->fileIsSource() ) {
1036 // Copy the thumbnail from the file system into storage...
1037 $disposition = $this->getThumbDisposition( $thumbName );
1038 $status = $this->repo
->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1039 if ( $status->isOK() ) {
1040 $thumb->setStoragePath( $thumbPath );
1042 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1044 // Give extensions a chance to do something with this thumbnail...
1045 wfRunHooks( 'FileTransformed', array( $this, $thumb, $tmpThumbPath, $thumbPath ) );
1048 // Purge. Useful in the event of Core -> Squid connection failure or squid
1049 // purge collisions from elsewhere during failure. Don't keep triggering for
1050 // "thumbs" which have the main image URL though (bug 13776)
1051 if ( $wgUseSquid ) {
1052 if ( !$thumb ||
$thumb->isError() ||
$thumb->getUrl() != $this->getURL() ) {
1053 SquidUpdate
::purge( array( $thumbUrl ) );
1058 wfProfileOut( __METHOD__
);
1060 return is_object( $thumb ) ?
$thumb : false;
1064 * @param string $thumbName Thumbnail name
1065 * @return string Content-Disposition header value
1067 function getThumbDisposition( $thumbName ) {
1068 $fileName = $this->name
; // file name to suggest
1069 $thumbExt = FileBackend
::extensionFromPath( $thumbName );
1070 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1071 $fileName .= ".$thumbExt";
1074 return FileBackend
::makeContentDisposition( 'inline', $fileName );
1078 * Hook into transform() to allow migration of thumbnail files
1080 * Overridden by LocalFile
1082 function migrateThumbFile( $thumbName ) {
1086 * Get a MediaHandler instance for this file
1088 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1089 * or false if none found
1091 function getHandler() {
1092 if ( !isset( $this->handler
) ) {
1093 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
1096 return $this->handler
;
1100 * Get a ThumbnailImage representing a file type icon
1102 * @return ThumbnailImage
1104 function iconThumb() {
1105 global $wgStylePath, $wgStyleDirectory;
1107 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
1108 foreach ( $try as $icon ) {
1109 $path = '/common/images/icons/' . $icon;
1110 $filepath = $wgStyleDirectory . $path;
1111 if ( file_exists( $filepath ) ) { // always FS
1112 $params = array( 'width' => 120, 'height' => 120 );
1114 return new ThumbnailImage( $this, $wgStylePath . $path, false, $params );
1122 * Get last thumbnailing error.
1125 function getLastError() {
1126 return $this->lastError
;
1130 * Get all thumbnail names previously generated for this file
1132 * Overridden by LocalFile
1135 function getThumbnails() {
1140 * Purge shared caches such as thumbnails and DB data caching
1142 * Overridden by LocalFile
1143 * @param array $options Options, which include:
1144 * 'forThumbRefresh' : The purging is only to refresh thumbnails
1146 function purgeCache( $options = array() ) {
1150 * Purge the file description page, but don't go after
1151 * pages using the file. Use when modifying file history
1152 * but not the current data.
1154 function purgeDescription() {
1155 $title = $this->getTitle();
1157 $title->invalidateCache();
1158 $title->purgeSquid();
1163 * Purge metadata and all affected pages when the file is created,
1164 * deleted, or majorly updated.
1166 function purgeEverything() {
1167 // Delete thumbnails and refresh file metadata cache
1168 $this->purgeCache();
1169 $this->purgeDescription();
1171 // Purge cache of all pages using this file
1172 $title = $this->getTitle();
1174 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
1175 $update->doUpdate();
1180 * Return a fragment of the history of file.
1183 * @param int $limit Limit of rows to return
1184 * @param string $start timestamp Only revisions older than $start will be returned
1185 * @param string $end timestamp Only revisions newer than $end will be returned
1186 * @param bool $inc Include the endpoints of the time range
1190 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1195 * Return the history of this file, line by line. Starts with current version,
1196 * then old versions. Should return an object similar to an image/oldimage
1200 * Overridden in LocalFile
1203 public function nextHistoryLine() {
1208 * Reset the history pointer to the first element of the history.
1209 * Always call this function after using nextHistoryLine() to free db resources
1211 * Overridden in LocalFile.
1213 public function resetHistory() {
1217 * Get the filename hash component of the directory including trailing slash,
1219 * If the repository is not hashed, returns an empty string.
1223 function getHashPath() {
1224 if ( !isset( $this->hashPath
) ) {
1225 $this->assertRepoDefined();
1226 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
1229 return $this->hashPath
;
1233 * Get the path of the file relative to the public zone root.
1234 * This function is overriden in OldLocalFile to be like getArchiveRel().
1239 return $this->getHashPath() . $this->getName();
1243 * Get the path of an archived file relative to the public zone root
1245 * @param bool|string $suffix if not false, the name of an archived thumbnail file
1249 function getArchiveRel( $suffix = false ) {
1250 $path = 'archive/' . $this->getHashPath();
1251 if ( $suffix === false ) {
1252 $path = substr( $path, 0, -1 );
1261 * Get the path, relative to the thumbnail zone root, of the
1262 * thumbnail directory or a particular file if $suffix is specified
1264 * @param bool|string $suffix if not false, the name of a thumbnail file
1267 function getThumbRel( $suffix = false ) {
1268 $path = $this->getRel();
1269 if ( $suffix !== false ) {
1270 $path .= '/' . $suffix;
1277 * Get urlencoded path of the file relative to the public zone root.
1278 * This function is overriden in OldLocalFile to be like getArchiveUrl().
1282 function getUrlRel() {
1283 return $this->getHashPath() . rawurlencode( $this->getName() );
1287 * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1288 * or a specific thumb if the $suffix is given.
1290 * @param string $archiveName the timestamped name of an archived image
1291 * @param bool|string $suffix if not false, the name of a thumbnail file
1294 function getArchiveThumbRel( $archiveName, $suffix = false ) {
1295 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1296 if ( $suffix === false ) {
1297 $path = substr( $path, 0, -1 );
1306 * Get the path of the archived file.
1308 * @param bool|string $suffix if not false, the name of an archived file.
1311 function getArchivePath( $suffix = false ) {
1312 $this->assertRepoDefined();
1314 return $this->repo
->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1318 * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1320 * @param string $archiveName the timestamped name of an archived image
1321 * @param bool|string $suffix if not false, the name of a thumbnail file
1324 function getArchiveThumbPath( $archiveName, $suffix = false ) {
1325 $this->assertRepoDefined();
1327 return $this->repo
->getZonePath( 'thumb' ) . '/' .
1328 $this->getArchiveThumbRel( $archiveName, $suffix );
1332 * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1334 * @param bool|string $suffix If not false, the name of a thumbnail file
1337 function getThumbPath( $suffix = false ) {
1338 $this->assertRepoDefined();
1340 return $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1344 * Get the path of the transcoded directory, or a particular file if $suffix is specified
1346 * @param bool|string $suffix If not false, the name of a media file
1349 function getTranscodedPath( $suffix = false ) {
1350 $this->assertRepoDefined();
1352 return $this->repo
->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1356 * Get the URL of the archive directory, or a particular file if $suffix is specified
1358 * @param bool|string $suffix If not false, the name of an archived file
1361 function getArchiveUrl( $suffix = false ) {
1362 $this->assertRepoDefined();
1363 $ext = $this->getExtension();
1364 $path = $this->repo
->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1365 if ( $suffix === false ) {
1366 $path = substr( $path, 0, -1 );
1368 $path .= rawurlencode( $suffix );
1375 * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1377 * @param string $archiveName the timestamped name of an archived image
1378 * @param bool|string $suffix If not false, the name of a thumbnail file
1381 function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1382 $this->assertRepoDefined();
1383 $ext = $this->getExtension();
1384 $path = $this->repo
->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1385 $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1386 if ( $suffix === false ) {
1387 $path = substr( $path, 0, -1 );
1389 $path .= rawurlencode( $suffix );
1396 * Get the URL of the zone directory, or a particular file if $suffix is specified
1398 * @param string $zone name of requested zone
1399 * @param bool|string $suffix If not false, the name of a file in zone
1400 * @return string path
1402 function getZoneUrl( $zone, $suffix = false ) {
1403 $this->assertRepoDefined();
1404 $ext = $this->getExtension();
1405 $path = $this->repo
->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1406 if ( $suffix !== false ) {
1407 $path .= '/' . rawurlencode( $suffix );
1414 * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1416 * @param bool|string $suffix if not false, the name of a thumbnail file
1417 * @return string path
1419 function getThumbUrl( $suffix = false ) {
1420 return $this->getZoneUrl( 'thumb', $suffix );
1424 * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1426 * @param bool|string $suffix If not false, the name of a media file
1427 * @return string path
1429 function getTranscodedUrl( $suffix = false ) {
1430 return $this->getZoneUrl( 'transcoded', $suffix );
1434 * Get the public zone virtual URL for a current version source file
1436 * @param bool|string $suffix If not false, the name of a thumbnail file
1439 function getVirtualUrl( $suffix = false ) {
1440 $this->assertRepoDefined();
1441 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
1442 if ( $suffix !== false ) {
1443 $path .= '/' . rawurlencode( $suffix );
1450 * Get the public zone virtual URL for an archived version source file
1452 * @param bool|string $suffix If not false, the name of a thumbnail file
1455 function getArchiveVirtualUrl( $suffix = false ) {
1456 $this->assertRepoDefined();
1457 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1458 if ( $suffix === false ) {
1459 $path = substr( $path, 0, -1 );
1461 $path .= rawurlencode( $suffix );
1468 * Get the virtual URL for a thumbnail file or directory
1470 * @param bool|string $suffix If not false, the name of a thumbnail file
1473 function getThumbVirtualUrl( $suffix = false ) {
1474 $this->assertRepoDefined();
1475 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1476 if ( $suffix !== false ) {
1477 $path .= '/' . rawurlencode( $suffix );
1486 function isHashed() {
1487 $this->assertRepoDefined();
1489 return (bool)$this->repo
->getHashLevels();
1493 * @throws MWException
1495 function readOnlyError() {
1496 throw new MWException( get_class( $this ) . ': write operations are not supported' );
1500 * Record a file upload in the upload log and the image table
1502 * Overridden by LocalFile
1505 * @param string $license
1506 * @param string $copyStatus
1507 * @param string $source
1508 * @param bool $watch
1509 * @param string|bool $timestamp
1510 * @param null|User $user User object or null to use $wgUser
1512 * @throws MWException
1514 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1515 $watch = false, $timestamp = false, User
$user = null
1517 $this->readOnlyError();
1521 * Move or copy a file to its public location. If a file exists at the
1522 * destination, move it to an archive. Returns a FileRepoStatus object with
1523 * the archive name in the "value" member on success.
1525 * The archive name should be passed through to recordUpload for database
1528 * Options to $options include:
1529 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1531 * @param string $srcPath local filesystem path to the source image
1532 * @param int $flags A bitwise combination of:
1533 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1534 * @param array $options Optional additional parameters
1535 * @return FileRepoStatus object. On success, the value member contains the
1536 * archive name, or an empty string if it was a new file.
1539 * Overridden by LocalFile
1541 function publish( $srcPath, $flags = 0, array $options = array() ) {
1542 $this->readOnlyError();
1548 function formatMetadata() {
1549 if ( !$this->getHandler() ) {
1553 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
1557 * Returns true if the file comes from the local file repository.
1561 function isLocal() {
1562 return $this->repo
&& $this->repo
->isLocal();
1566 * Returns the name of the repository.
1570 function getRepoName() {
1571 return $this->repo ?
$this->repo
->getName() : 'unknown';
1575 * Returns the repository
1577 * @return FileRepo|LocalRepo|bool
1579 function getRepo() {
1584 * Returns true if the image is an old version
1594 * Is this file a "deleted" file in a private archive?
1597 * @param int $field one of DELETED_* bitfield constants
1600 function isDeleted( $field ) {
1605 * Return the deletion bitfield
1609 function getVisibility() {
1614 * Was this file ever deleted from the wiki?
1618 function wasDeleted() {
1619 $title = $this->getTitle();
1621 return $title && $title->isDeletedQuick();
1625 * Move file to the new title
1627 * Move current, old version and all thumbnails
1628 * to the new filename. Old file is deleted.
1630 * Cache purging is done; checks for validity
1631 * and logging are caller's responsibility
1633 * @param Title $target New file name
1634 * @return FileRepoStatus object.
1636 function move( $target ) {
1637 $this->readOnlyError();
1641 * Delete all versions of the file.
1643 * Moves the files into an archive directory (or deletes them)
1644 * and removes the database rows.
1646 * Cache purging is done; logging is caller's responsibility.
1648 * @param string $reason
1649 * @param bool $suppress Hide content from sysops?
1650 * @return bool on success, false on some kind of failure
1652 * Overridden by LocalFile
1654 function delete( $reason, $suppress = false ) {
1655 $this->readOnlyError();
1659 * Restore all or specified deleted revisions to the given file.
1660 * Permissions and logging are left to the caller.
1662 * May throw database exceptions on error.
1664 * @param array $versions set of record ids of deleted items to restore,
1665 * or empty to restore all revisions.
1666 * @param bool $unsuppress remove restrictions on content upon restoration?
1667 * @return int|bool the number of file revisions restored if successful,
1668 * or false on failure
1670 * Overridden by LocalFile
1672 function restore( $versions = array(), $unsuppress = false ) {
1673 $this->readOnlyError();
1677 * Returns 'true' if this file is a type which supports multiple pages,
1678 * e.g. DJVU or PDF. Note that this may be true even if the file in
1679 * question only has a single page.
1683 function isMultipage() {
1684 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1688 * Returns the number of pages of a multipage document, or false for
1689 * documents which aren't multipage documents
1693 function pageCount() {
1694 if ( !isset( $this->pageCount
) ) {
1695 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1696 $this->pageCount
= $this->handler
->pageCount( $this );
1698 $this->pageCount
= false;
1702 return $this->pageCount
;
1706 * Calculate the height of a thumbnail using the source and destination width
1708 * @param int $srcWidth
1709 * @param int $srcHeight
1710 * @param int $dstWidth
1714 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1715 // Exact integer multiply followed by division
1716 if ( $srcWidth == 0 ) {
1719 return round( $srcHeight * $dstWidth / $srcWidth );
1724 * Get an image size array like that returned by getImageSize(), or false if it
1725 * can't be determined.
1727 * @param string $fileName The filename
1730 function getImageSize( $fileName ) {
1731 if ( !$this->getHandler() ) {
1735 return $this->handler
->getImageSize( $this, $fileName );
1739 * Get the URL of the image description page. May return false if it is
1740 * unknown or not applicable.
1744 function getDescriptionUrl() {
1745 if ( $this->repo
) {
1746 return $this->repo
->getDescriptionUrl( $this->getName() );
1753 * Get the HTML text of the description page, if available
1755 * @param bool|Language $lang Optional language to fetch description in
1758 function getDescriptionText( $lang = false ) {
1759 global $wgMemc, $wgLang;
1760 if ( !$this->repo ||
!$this->repo
->fetchDescription
) {
1766 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
1768 if ( $this->repo
->descriptionCacheExpiry
> 0 ) {
1769 wfDebug( "Attempting to get the description from cache..." );
1770 $key = $this->repo
->getLocalCacheKey(
1771 'RemoteFileDescription',
1776 $obj = $wgMemc->get( $key );
1778 wfDebug( "success!\n" );
1782 wfDebug( "miss\n" );
1784 wfDebug( "Fetching shared description from $renderUrl\n" );
1785 $res = Http
::get( $renderUrl );
1786 if ( $res && $this->repo
->descriptionCacheExpiry
> 0 ) {
1787 $wgMemc->set( $key, $res, $this->repo
->descriptionCacheExpiry
);
1797 * Get description of file revision
1800 * @param int $audience One of:
1801 * File::FOR_PUBLIC to be displayed to all users
1802 * File::FOR_THIS_USER to be displayed to the given user
1803 * File::RAW get the description regardless of permissions
1804 * @param User $user User object to check for, only if FOR_THIS_USER is
1805 * passed to the $audience parameter
1808 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1813 * Get the 14-character timestamp of the file upload
1815 * @return string|bool TS_MW timestamp or false on failure
1817 function getTimestamp() {
1818 $this->assertRepoDefined();
1820 return $this->repo
->getFileTimestamp( $this->getPath() );
1824 * Get the SHA-1 base 36 hash of the file
1828 function getSha1() {
1829 $this->assertRepoDefined();
1831 return $this->repo
->getFileSha1( $this->getPath() );
1835 * Get the deletion archive key, "<sha1>.<ext>"
1839 function getStorageKey() {
1840 $hash = $this->getSha1();
1844 $ext = $this->getExtension();
1845 $dotExt = $ext === '' ?
'' : ".$ext";
1847 return $hash . $dotExt;
1851 * Determine if the current user is allowed to view a particular
1852 * field of this file, if it's marked as deleted.
1855 * @param User $user User object to check, or null to use $wgUser
1858 function userCan( $field, User
$user = null ) {
1863 * Get an associative array containing information about a file in the local filesystem.
1865 * @param string $path absolute local filesystem path
1866 * @param string|bool $ext The file extension, or true to extract it from
1867 * the filename. Set it to false to ignore the extension.
1870 * @deprecated since 1.19
1872 static function getPropsFromPath( $path, $ext = true ) {
1873 wfDebug( __METHOD__
. ": Getting file info for $path\n" );
1874 wfDeprecated( __METHOD__
, '1.19' );
1876 $fsFile = new FSFile( $path );
1878 return $fsFile->getProps();
1882 * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
1883 * encoding, zero padded to 31 digits.
1885 * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
1888 * @param $path string
1889 * @return bool|string False on failure
1890 * @deprecated since 1.19
1892 static function sha1Base36( $path ) {
1893 wfDeprecated( __METHOD__
, '1.19' );
1895 $fsFile = new FSFile( $path );
1897 return $fsFile->getSha1Base36();
1901 * @return array HTTP header name/value map to use for HEAD/GET request responses
1903 function getStreamHeaders() {
1904 $handler = $this->getHandler();
1906 return $handler->getStreamHeaders( $this->getMetadata() );
1915 function getLongDesc() {
1916 $handler = $this->getHandler();
1918 return $handler->getLongDesc( $this );
1920 return MediaHandler
::getGeneralLongDesc( $this );
1927 function getShortDesc() {
1928 $handler = $this->getHandler();
1930 return $handler->getShortDesc( $this );
1932 return MediaHandler
::getGeneralShortDesc( $this );
1939 function getDimensionsString() {
1940 $handler = $this->getHandler();
1942 return $handler->getDimensionsString( $this );
1951 function getRedirected() {
1952 return $this->redirected
;
1956 * @return Title|null
1958 function getRedirectedTitle() {
1959 if ( $this->redirected
) {
1960 if ( !$this->redirectTitle
) {
1961 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
1964 return $this->redirectTitle
;
1971 * @param string $from
1974 function redirectedFrom( $from ) {
1975 $this->redirected
= $from;
1981 function isMissing() {
1986 * Check if this file object is small and can be cached
1989 public function isCacheable() {
1994 * Assert that $this->repo is set to a valid FileRepo instance
1995 * @throws MWException
1997 protected function assertRepoDefined() {
1998 if ( !( $this->repo
instanceof $this->repoClass
) ) {
1999 throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2004 * Assert that $this->title is set to a Title
2005 * @throws MWException
2007 protected function assertTitleDefined() {
2008 if ( !( $this->title
instanceof Title
) ) {
2009 throw new MWException( "A Title object is not set for this File.\n" );