3 * @defgroup FileAbstraction File abstraction
6 * Represents files in a repository.
8 use MediaWiki\MediaWikiServices
;
11 * Base code for files.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * http://www.gnu.org/copyleft/gpl.html
29 * @ingroup FileAbstraction
33 * Implements some public methods and some protected utility functions which
34 * are required by multiple child classes. Contains stub functionality for
35 * unimplemented public methods.
37 * Stub functions which should be overridden are marked with STUB. Some more
38 * concrete functions are also typically overridden by child classes.
40 * Note that only the repo object knows what its file class is called. You should
41 * never name a file class explictly outside of the repo class. Instead use the
42 * repo's factory functions to generate file objects, for example:
44 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
46 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
49 * @ingroup FileAbstraction
51 abstract class File
implements IDBAccessObject
{
52 // Bitfield values akin to the Revision deletion constants
53 const DELETED_FILE
= 1;
54 const DELETED_COMMENT
= 2;
55 const DELETED_USER
= 4;
56 const DELETED_RESTRICTED
= 8;
58 /** Force rendering in the current process */
61 * Force rendering even if thumbnail already exist and using RENDER_NOW
62 * I.e. you have to pass both flags: File::RENDER_NOW | File::RENDER_FORCE
64 const RENDER_FORCE
= 2;
66 const DELETE_SOURCE
= 1;
68 // Audience options for File::getDescription()
70 const FOR_THIS_USER
= 2;
73 // Options for File::thumbName()
74 const THUMB_FULL_NAME
= 1;
77 * Some member variables can be lazy-initialised using __get(). The
78 * initialisation function for these variables is always a function named
79 * like getVar(), where Var is the variable name with upper-case first
82 * The following variables are initialised in this way in this base class:
83 * name, extension, handler, path, canRender, isSafeFile,
84 * transformScript, hashPath, pageCount, url
86 * Code within this class should generally use the accessor function
87 * directly, since __get() isn't re-entrant and therefore causes bugs that
88 * depend on initialisation order.
92 * The following member variables are not lazy-initialised
95 /** @var FileRepo|LocalRepo|ForeignAPIRepo|bool */
98 /** @var Title|string|bool */
101 /** @var string Text of last error */
102 protected $lastError;
104 /** @var string Main part of the title, with underscores (Title::getDBkey) */
105 protected $redirected;
108 protected $redirectedTitle;
110 /** @var FSFile|bool False if undefined */
113 /** @var MediaHandler */
116 /** @var string The URL corresponding to one of the four basic zones */
119 /** @var string File extension */
120 protected $extension;
122 /** @var string The name of a file from its title object */
125 /** @var string The storage path corresponding to one of the zones */
128 /** @var string Relative path including trailing slash */
131 /** @var string|false Number of pages of a multipage document, or false for
132 * documents which aren't multipage documents
134 protected $pageCount;
136 /** @var string URL of transformscript (for example thumb.php) */
137 protected $transformScript;
140 protected $redirectTitle;
142 /** @var bool Whether the output of transform() for this file is likely to be valid. */
143 protected $canRender;
145 /** @var bool Whether this media file is in a format that is unlikely to
146 * contain viruses or malicious content
148 protected $isSafeFile;
150 /** @var string Required Repository class type */
151 protected $repoClass = FileRepo
::class;
153 /** @var array Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width */
154 protected $tmpBucketedThumbCache = [];
157 * Call this constructor from child classes.
159 * Both $title and $repo are optional, though some functions
160 * may return false or throw exceptions if they are not set.
161 * Most subclasses will want to call assertRepoDefined() here.
163 * @param Title|string|bool $title
164 * @param FileRepo|bool $repo
166 function __construct( $title, $repo ) {
167 // Some subclasses do not use $title, but set name/title some other way
168 if ( $title !== false ) {
169 $title = self
::normalizeTitle( $title, 'exception' );
171 $this->title
= $title;
176 * Given a string or Title object return either a
177 * valid Title object with namespace NS_FILE or null
179 * @param Title|string $title
180 * @param string|bool $exception Use 'exception' to throw an error on bad titles
181 * @throws MWException
184 static function normalizeTitle( $title, $exception = false ) {
186 if ( $ret instanceof Title
) {
187 # Normalize NS_MEDIA -> NS_FILE
188 if ( $ret->getNamespace() == NS_MEDIA
) {
189 $ret = Title
::makeTitleSafe( NS_FILE
, $ret->getDBkey() );
190 # Sanity check the title namespace
191 } elseif ( $ret->getNamespace() !== NS_FILE
) {
195 # Convert strings to Title objects
196 $ret = Title
::makeTitleSafe( NS_FILE
, (string)$ret );
198 if ( !$ret && $exception !== false ) {
199 throw new MWException( "`$title` is not a valid file title." );
205 function __get( $name ) {
206 $function = [ $this, 'get' . ucfirst( $name ) ];
207 if ( !is_callable( $function ) ) {
210 $this->$name = call_user_func( $function );
217 * Normalize a file extension to the common form, making it lowercase and checking some synonyms,
218 * and ensure it's clean. Extensions with non-alphanumeric characters will be discarded.
219 * Keep in sync with mw.Title.normalizeExtension() in JS.
221 * @param string $extension File extension (without the leading dot)
222 * @return string File extension in canonical form
224 static function normalizeExtension( $extension ) {
225 $lower = strtolower( $extension );
232 if ( isset( $squish[$lower] ) ) {
233 return $squish[$lower];
234 } elseif ( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
242 * Checks if file extensions are compatible
244 * @param File $old Old file
245 * @param string $new New name
249 static function checkExtensionCompatibility( File
$old, $new ) {
250 $oldMime = $old->getMimeType();
251 $n = strrpos( $new, '.' );
252 $newExt = self
::normalizeExtension( $n ?
substr( $new, $n +
1 ) : '' );
253 $mimeMagic = MediaWiki\MediaWikiServices
::getInstance()->getMimeAnalyzer();
255 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
259 * Upgrade the database row if there is one
260 * Called by ImagePage
263 function upgradeRow() {
267 * Split an internet media type into its two components; if not
268 * a two-part name, set the minor type to 'unknown'.
270 * @param string $mime "text/html" etc
271 * @return array ("text", "html") etc
273 public static function splitMime( $mime ) {
274 if ( strpos( $mime, '/' ) !== false ) {
275 return explode( '/', $mime, 2 );
277 return [ $mime, 'unknown' ];
282 * Callback for usort() to do file sorts by name
286 * @return int Result of name comparison
288 public static function compare( File
$a, File
$b ) {
289 return strcmp( $a->getName(), $b->getName() );
293 * Return the name of this file
297 public function getName() {
298 if ( !isset( $this->name
) ) {
299 $this->assertRepoDefined();
300 $this->name
= $this->repo
->getNameFromTitle( $this->title
);
307 * Get the file extension, e.g. "svg"
311 function getExtension() {
312 if ( !isset( $this->extension
) ) {
313 $n = strrpos( $this->getName(), '.' );
314 $this->extension
= self
::normalizeExtension(
315 $n ?
substr( $this->getName(), $n +
1 ) : '' );
318 return $this->extension
;
322 * Return the associated title object
326 public function getTitle() {
331 * Return the title used to find this file
335 public function getOriginalTitle() {
336 if ( $this->redirected
) {
337 return $this->getRedirectedTitle();
344 * Return the URL of the file
348 public function getUrl() {
349 if ( !isset( $this->url
) ) {
350 $this->assertRepoDefined();
351 $ext = $this->getExtension();
352 $this->url
= $this->repo
->getZoneUrl( 'public', $ext ) . '/' . $this->getUrlRel();
359 * Get short description URL for a files based on the page ID
361 * @return string|null
364 public function getDescriptionShortUrl() {
369 * Return a fully-qualified URL to the file.
370 * Upload URL paths _may or may not_ be fully qualified, so
371 * we check. Local paths are assumed to belong on $wgServer.
375 public function getFullUrl() {
376 return wfExpandUrl( $this->getUrl(), PROTO_RELATIVE
);
382 public function getCanonicalUrl() {
383 return wfExpandUrl( $this->getUrl(), PROTO_CANONICAL
);
389 function getViewURL() {
390 if ( $this->mustRender() ) {
391 if ( $this->canRender() ) {
392 return $this->createThumb( $this->getWidth() );
394 wfDebug( __METHOD__
. ': supposed to render ' . $this->getName() .
395 ' (' . $this->getMimeType() . "), but can't!\n" );
397 return $this->getUrl(); # hm... return NULL?
400 return $this->getUrl();
405 * Return the storage path to the file. Note that this does
406 * not mean that a file actually exists under that location.
408 * This path depends on whether directory hashing is active or not,
409 * i.e. whether the files are all found in the same directory,
410 * or in hashed paths like /images/3/3c.
412 * Most callers don't check the return value, but ForeignAPIFile::getPath
415 * @return string|bool ForeignAPIFile::getPath can return false
417 public function getPath() {
418 if ( !isset( $this->path
) ) {
419 $this->assertRepoDefined();
420 $this->path
= $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
427 * Get an FS copy or original of this file and return the path.
428 * Returns false on failure. Callers must not alter the file.
429 * Temporary files are cleared automatically.
431 * @return string|bool False on failure
433 public function getLocalRefPath() {
434 $this->assertRepoDefined();
435 if ( !isset( $this->fsFile
) ) {
436 $starttime = microtime( true );
437 $this->fsFile
= $this->repo
->getLocalReference( $this->getPath() );
439 $statTiming = microtime( true ) - $starttime;
440 MediaWikiServices
::getInstance()->getStatsdDataFactory()->timing(
441 'media.thumbnail.generate.fetchoriginal', 1000 * $statTiming );
443 if ( !$this->fsFile
) {
444 $this->fsFile
= false; // null => false; cache negative hits
448 return ( $this->fsFile
)
449 ?
$this->fsFile
->getPath()
454 * Return the width of the image. Returns false if the width is unknown
458 * Overridden by LocalFile, UnregisteredLocalFile
463 public function getWidth( $page = 1 ) {
468 * Return the height of the image. Returns false if the height is unknown
472 * Overridden by LocalFile, UnregisteredLocalFile
475 * @return bool|int False on failure
477 public function getHeight( $page = 1 ) {
482 * Return the smallest bucket from $wgThumbnailBuckets which is at least
483 * $wgThumbnailMinimumBucketDistance larger than $desiredWidth. The returned bucket, if any,
484 * will always be bigger than $desiredWidth.
486 * @param int $desiredWidth
490 public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
491 global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
493 $imageWidth = $this->getWidth( $page );
495 if ( $imageWidth === false ) {
499 if ( $desiredWidth > $imageWidth ) {
503 if ( !$wgThumbnailBuckets ) {
507 $sortedBuckets = $wgThumbnailBuckets;
509 sort( $sortedBuckets );
511 foreach ( $sortedBuckets as $bucket ) {
512 if ( $bucket >= $imageWidth ) {
516 if ( $bucket - $wgThumbnailMinimumBucketDistance > $desiredWidth ) {
521 // Image is bigger than any available bucket
526 * Returns ID or name of user who uploaded the file
529 * @param string $type 'text' or 'id'
532 public function getUser( $type = 'text' ) {
537 * Get the duration of a media file in seconds
541 public function getLength() {
542 $handler = $this->getHandler();
544 return $handler->getLength( $this );
551 * Return true if the file is vectorized
555 public function isVectorized() {
556 $handler = $this->getHandler();
558 return $handler->isVectorized( $this );
565 * Gives a (possibly empty) list of languages to render
568 * If the file doesn't have translations, or if the file
569 * format does not support that sort of thing, returns
575 public function getAvailableLanguages() {
576 $handler = $this->getHandler();
578 return $handler->getAvailableLanguages( $this );
585 * Get the language code from the available languages for this file that matches the language
586 * requested by the user
588 * @param string $userPreferredLanguage
589 * @return string|null
591 public function getMatchedLanguage( $userPreferredLanguage ) {
592 $handler = $this->getHandler();
593 if ( $handler && method_exists( $handler, 'getMatchedLanguage' ) ) {
594 return $handler->getMatchedLanguage(
595 $userPreferredLanguage,
596 $handler->getAvailableLanguages( $this )
604 * In files that support multiple language, what is the default language
605 * to use if none specified.
607 * @return string|null Lang code, or null if filetype doesn't support multiple languages.
610 public function getDefaultRenderLanguage() {
611 $handler = $this->getHandler();
613 return $handler->getDefaultRenderLanguage( $this );
620 * Will the thumbnail be animated if one would expect it to be.
622 * Currently used to add a warning to the image description page
624 * @return bool False if the main image is both animated
625 * and the thumbnail is not. In all other cases must return
626 * true. If image is not renderable whatsoever, should
629 public function canAnimateThumbIfAppropriate() {
630 $handler = $this->getHandler();
632 // We cannot handle image whatsoever, thus
633 // one would not expect it to be animated
637 if ( $this->allowInlineDisplay()
638 && $handler->isAnimatedImage( $this )
639 && !$handler->canAnimateThumbnail( $this )
641 // Image is animated, but thumbnail isn't.
642 // This is unexpected to the user.
645 // Image is not animated, so one would
646 // not expect thumb to be
653 * Get handler-specific metadata
654 * Overridden by LocalFile, UnregisteredLocalFile
658 public function getMetadata() {
663 * Like getMetadata but returns a handler independent array of common values.
664 * @see MediaHandler::getCommonMetaArray()
665 * @return array|bool Array or false if not supported
668 public function getCommonMetaArray() {
669 $handler = $this->getHandler();
675 return $handler->getCommonMetaArray( $this );
679 * get versioned metadata
681 * @param array|string $metadata Array or string of (serialized) metadata
682 * @param int $version Version number.
683 * @return array Array containing metadata, or what was passed to it on fail
684 * (unserializing if not array)
686 public function convertMetadataVersion( $metadata, $version ) {
687 $handler = $this->getHandler();
688 if ( !is_array( $metadata ) ) {
689 // Just to make the return type consistent
690 $metadata = unserialize( $metadata );
693 return $handler->convertMetadataVersion( $metadata, $version );
700 * Return the bit depth of the file
701 * Overridden by LocalFile
705 public function getBitDepth() {
710 * Return the size of the image file, in bytes
711 * Overridden by LocalFile, UnregisteredLocalFile
715 public function getSize() {
720 * Returns the MIME type of the file.
721 * Overridden by LocalFile, UnregisteredLocalFile
726 function getMimeType() {
727 return 'unknown/unknown';
731 * Return the type of the media in the file.
732 * Use the value returned by this function with the MEDIATYPE_xxx constants.
733 * Overridden by LocalFile,
737 function getMediaType() {
738 return MEDIATYPE_UNKNOWN
;
742 * Checks if the output of transform() for this file is likely
743 * to be valid. If this is false, various user elements will
744 * display a placeholder instead.
746 * Currently, this checks if the file is an image format
747 * that can be converted to a format
748 * supported by all browsers (namely GIF, PNG and JPEG),
749 * or if it is an SVG image and SVG conversion is enabled.
753 function canRender() {
754 if ( !isset( $this->canRender
) ) {
755 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this ) && $this->exists();
758 return $this->canRender
;
762 * Accessor for __get()
765 protected function getCanRender() {
766 return $this->canRender();
770 * Return true if the file is of a type that can't be directly
771 * rendered by typical browsers and needs to be re-rasterized.
773 * This returns true for everything but the bitmap types
774 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
775 * also return true for any non-image formats.
779 function mustRender() {
780 return $this->getHandler() && $this->handler
->mustRender( $this );
784 * Alias for canRender()
788 function allowInlineDisplay() {
789 return $this->canRender();
793 * Determines if this media file is in a format that is unlikely to
794 * contain viruses or malicious content. It uses the global
795 * $wgTrustedMediaFormats list to determine if the file is safe.
797 * This is used to show a warning on the description page of non-safe files.
798 * It may also be used to disallow direct [[media:...]] links to such files.
800 * Note that this function will always return true if allowInlineDisplay()
801 * or isTrustedFile() is true for this file.
805 function isSafeFile() {
806 if ( !isset( $this->isSafeFile
) ) {
807 $this->isSafeFile
= $this->getIsSafeFileUncached();
810 return $this->isSafeFile
;
814 * Accessor for __get()
818 protected function getIsSafeFile() {
819 return $this->isSafeFile();
827 protected function getIsSafeFileUncached() {
828 global $wgTrustedMediaFormats;
830 if ( $this->allowInlineDisplay() ) {
833 if ( $this->isTrustedFile() ) {
837 $type = $this->getMediaType();
838 $mime = $this->getMimeType();
839 # wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
841 if ( !$type ||
$type === MEDIATYPE_UNKNOWN
) {
842 return false; # unknown type, not trusted
844 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
848 if ( $mime === "unknown/unknown" ) {
849 return false; # unknown type, not trusted
851 if ( in_array( $mime, $wgTrustedMediaFormats ) ) {
859 * Returns true if the file is flagged as trusted. Files flagged that way
860 * can be linked to directly, even if that is not allowed for this type of
863 * This is a dummy function right now and always returns false. It could be
864 * implemented to extract a flag from the database. The trusted flag could be
865 * set on upload, if the user has sufficient privileges, to bypass script-
866 * and html-filters. It may even be coupled with cryptographics signatures
871 function isTrustedFile() {
872 # this could be implemented to check a flag in the database,
873 # look for signatures, etc
878 * Load any lazy-loaded file object fields from source
880 * This is only useful when setting $flags
882 * Overridden by LocalFile to actually query the DB
884 * @param int $flags Bitfield of File::READ_* constants
886 public function load( $flags = 0 ) {
890 * Returns true if file exists in the repository.
892 * Overridden by LocalFile to avoid unnecessary stat calls.
894 * @return bool Whether file exists in the repository.
896 public function exists() {
897 return $this->getPath() && $this->repo
->fileExists( $this->path
);
901 * Returns true if file exists in the repository and can be included in a page.
902 * It would be unsafe to include private images, making public thumbnails inadvertently
904 * @return bool Whether file exists in the repository and is includable.
906 public function isVisible() {
907 return $this->exists();
913 function getTransformScript() {
914 if ( !isset( $this->transformScript
) ) {
915 $this->transformScript
= false;
917 $script = $this->repo
->getThumbScriptUrl();
919 $this->transformScript
= wfAppendQuery( $script, [ 'f' => $this->getName() ] );
924 return $this->transformScript
;
928 * Get a ThumbnailImage which is the same size as the source
930 * @param array $handlerParams
932 * @return ThumbnailImage|MediaTransformOutput|bool False on failure
934 function getUnscaledThumb( $handlerParams = [] ) {
935 $hp =& $handlerParams;
936 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
937 $width = $this->getWidth( $page );
939 return $this->iconThumb();
941 $hp['width'] = $width;
942 // be sure to ignore any height specification as well (T64258)
943 unset( $hp['height'] );
945 return $this->transform( $hp );
949 * Return the file name of a thumbnail with the specified parameters.
950 * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
951 * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
953 * @param array $params Handler-specific parameters
954 * @param int $flags Bitfield that supports THUMB_* constants
955 * @return string|null
957 public function thumbName( $params, $flags = 0 ) {
958 $name = ( $this->repo
&& !( $flags & self
::THUMB_FULL_NAME
) )
959 ?
$this->repo
->nameForThumb( $this->getName() )
962 return $this->generateThumbName( $name, $params );
966 * Generate a thumbnail file name from a name and specified parameters
968 * @param string $name
969 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
970 * @return string|null
972 public function generateThumbName( $name, $params ) {
973 if ( !$this->getHandler() ) {
976 $extension = $this->getExtension();
977 list( $thumbExt, ) = $this->getHandler()->getThumbType(
978 $extension, $this->getMimeType(), $params );
979 $thumbName = $this->getHandler()->makeParamString( $params );
981 if ( $this->repo
->supportsSha1URLs() ) {
982 $thumbName .= '-' . $this->getSha1() . '.' . $thumbExt;
984 $thumbName .= '-' . $name;
986 if ( $thumbExt != $extension ) {
987 $thumbName .= ".$thumbExt";
995 * Create a thumbnail of the image having the specified width/height.
996 * The thumbnail will not be created if the width is larger than the
997 * image's width. Let the browser do the scaling in this case.
998 * The thumbnail is stored on disk and is only computed if the thumbnail
999 * file does not exist OR if it is older than the image.
1002 * Keeps aspect ratio of original image. If both width and height are
1003 * specified, the generated image will be no bigger than width x height,
1004 * and will also have correct aspect ratio.
1006 * @param int $width Maximum width of the generated thumbnail
1007 * @param int $height Maximum height of the image (optional)
1011 public function createThumb( $width, $height = -1 ) {
1012 $params = [ 'width' => $width ];
1013 if ( $height != -1 ) {
1014 $params['height'] = $height;
1016 $thumb = $this->transform( $params );
1017 if ( !$thumb ||
$thumb->isError() ) {
1021 return $thumb->getUrl();
1025 * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
1027 * @param string $thumbPath Thumbnail storage path
1028 * @param string $thumbUrl Thumbnail URL
1029 * @param array $params
1031 * @return MediaTransformOutput
1033 protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
1034 global $wgIgnoreImageErrors;
1036 $handler = $this->getHandler();
1037 if ( $handler && $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1038 return $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1040 return new MediaTransformError( 'thumbnail_error',
1041 $params['width'], 0, wfMessage( 'thumbnail-dest-create' ) );
1046 * Transform a media file
1048 * @param array $params An associative array of handler-specific parameters.
1049 * Typical keys are width, height and page.
1050 * @param int $flags A bitfield, may contain self::RENDER_NOW to force rendering
1051 * @return ThumbnailImage|MediaTransformOutput|bool False on failure
1053 function transform( $params, $flags = 0 ) {
1054 global $wgThumbnailEpoch;
1057 if ( !$this->canRender() ) {
1058 $thumb = $this->iconThumb();
1059 break; // not a bitmap or renderable image, don't try
1062 // Get the descriptionUrl to embed it as comment into the thumbnail. T21791.
1063 $descriptionUrl = $this->getDescriptionUrl();
1064 if ( $descriptionUrl ) {
1065 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL
);
1068 $handler = $this->getHandler();
1069 $script = $this->getTransformScript();
1070 if ( $script && !( $flags & self
::RENDER_NOW
) ) {
1071 // Use a script to transform on client request, if possible
1072 $thumb = $handler->getScriptedTransform( $this, $script, $params );
1078 $normalisedParams = $params;
1079 $handler->normaliseParams( $this, $normalisedParams );
1081 $thumbName = $this->thumbName( $normalisedParams );
1082 $thumbUrl = $this->getThumbUrl( $thumbName );
1083 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1085 if ( $this->repo
) {
1086 // Defer rendering if a 404 handler is set up...
1087 if ( $this->repo
->canTransformVia404() && !( $flags & self
::RENDER_NOW
) ) {
1088 // XXX: Pass in the storage path even though we are not rendering anything
1089 // and the path is supposed to be an FS path. This is due to getScalerType()
1090 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1091 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1094 // Check if an up-to-date thumbnail already exists...
1095 wfDebug( __METHOD__
. ": Doing stat for $thumbPath\n" );
1096 if ( !( $flags & self
::RENDER_FORCE
) && $this->repo
->fileExists( $thumbPath ) ) {
1097 $timestamp = $this->repo
->getFileTimestamp( $thumbPath );
1098 if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
1099 // XXX: Pass in the storage path even though we are not rendering anything
1100 // and the path is supposed to be an FS path. This is due to getScalerType()
1101 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1102 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1103 $thumb->setStoragePath( $thumbPath );
1106 } elseif ( $flags & self
::RENDER_FORCE
) {
1107 wfDebug( __METHOD__
. " forcing rendering per flag File::RENDER_FORCE\n" );
1110 // If the backend is ready-only, don't keep generating thumbnails
1111 // only to return transformation errors, just return the error now.
1112 if ( $this->repo
->getReadOnlyReason() !== false ) {
1113 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1118 $tmpFile = $this->makeTransformTmpFile( $thumbPath );
1121 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1123 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1127 return is_object( $thumb ) ?
$thumb : false;
1131 * Generates a thumbnail according to the given parameters and saves it to storage
1132 * @param TempFSFile $tmpFile Temporary file where the rendered thumbnail will be saved
1133 * @param array $transformParams
1135 * @return bool|MediaTransformOutput
1137 public function generateAndSaveThumb( $tmpFile, $transformParams, $flags ) {
1138 global $wgIgnoreImageErrors;
1140 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1142 $handler = $this->getHandler();
1144 $normalisedParams = $transformParams;
1145 $handler->normaliseParams( $this, $normalisedParams );
1147 $thumbName = $this->thumbName( $normalisedParams );
1148 $thumbUrl = $this->getThumbUrl( $thumbName );
1149 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1151 $tmpThumbPath = $tmpFile->getPath();
1153 if ( $handler->supportsBucketing() ) {
1154 $this->generateBucketsIfNeeded( $normalisedParams, $flags );
1157 $starttime = microtime( true );
1159 // Actually render the thumbnail...
1160 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1161 $tmpFile->bind( $thumb ); // keep alive with $thumb
1163 $statTiming = microtime( true ) - $starttime;
1164 $stats->timing( 'media.thumbnail.generate.transform', 1000 * $statTiming );
1166 if ( !$thumb ) { // bad params?
1168 } elseif ( $thumb->isError() ) { // transform error
1169 /** @var MediaTransformError $thumb */
1170 $this->lastError
= $thumb->toText();
1171 // Ignore errors if requested
1172 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1173 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1175 } elseif ( $this->repo
&& $thumb->hasFile() && !$thumb->fileIsSource() ) {
1176 // Copy the thumbnail from the file system into storage...
1178 $starttime = microtime( true );
1180 $disposition = $this->getThumbDisposition( $thumbName );
1181 $status = $this->repo
->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1182 if ( $status->isOK() ) {
1183 $thumb->setStoragePath( $thumbPath );
1185 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $transformParams, $flags );
1188 $statTiming = microtime( true ) - $starttime;
1189 $stats->timing( 'media.thumbnail.generate.store', 1000 * $statTiming );
1191 // Give extensions a chance to do something with this thumbnail...
1192 Hooks
::run( 'FileTransformed', [ $this, $thumb, $tmpThumbPath, $thumbPath ] );
1199 * Generates chained bucketed thumbnails if needed
1200 * @param array $params
1202 * @return bool Whether at least one bucket was generated
1204 protected function generateBucketsIfNeeded( $params, $flags = 0 ) {
1206 ||
!isset( $params['physicalWidth'] )
1207 ||
!isset( $params['physicalHeight'] )
1212 $bucket = $this->getThumbnailBucket( $params['physicalWidth'] );
1214 if ( !$bucket ||
$bucket == $params['physicalWidth'] ) {
1218 $bucketPath = $this->getBucketThumbPath( $bucket );
1220 if ( $this->repo
->fileExists( $bucketPath ) ) {
1224 $starttime = microtime( true );
1226 $params['physicalWidth'] = $bucket;
1227 $params['width'] = $bucket;
1229 $params = $this->getHandler()->sanitizeParamsForBucketing( $params );
1231 $tmpFile = $this->makeTransformTmpFile( $bucketPath );
1237 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1239 $buckettime = microtime( true ) - $starttime;
1241 if ( !$thumb ||
$thumb->isError() ) {
1245 $this->tmpBucketedThumbCache
[$bucket] = $tmpFile->getPath();
1246 // For the caching to work, we need to make the tmp file survive as long as
1247 // this object exists
1248 $tmpFile->bind( $this );
1250 MediaWikiServices
::getInstance()->getStatsdDataFactory()->timing(
1251 'media.thumbnail.generate.bucket', 1000 * $buckettime );
1257 * Returns the most appropriate source image for the thumbnail, given a target thumbnail size
1258 * @param array $params
1259 * @return array Source path and width/height of the source
1261 public function getThumbnailSource( $params ) {
1263 && $this->getHandler()->supportsBucketing()
1264 && isset( $params['physicalWidth'] )
1265 && $bucket = $this->getThumbnailBucket( $params['physicalWidth'] )
1267 if ( $this->getWidth() != 0 ) {
1268 $bucketHeight = round( $this->getHeight() * ( $bucket / $this->getWidth() ) );
1273 // Try to avoid reading from storage if the file was generated by this script
1274 if ( isset( $this->tmpBucketedThumbCache
[$bucket] ) ) {
1275 $tmpPath = $this->tmpBucketedThumbCache
[$bucket];
1277 if ( file_exists( $tmpPath ) ) {
1281 'height' => $bucketHeight
1286 $bucketPath = $this->getBucketThumbPath( $bucket );
1288 if ( $this->repo
->fileExists( $bucketPath ) ) {
1289 $fsFile = $this->repo
->getLocalReference( $bucketPath );
1293 'path' => $fsFile->getPath(),
1295 'height' => $bucketHeight
1301 // Thumbnailing a very large file could result in network saturation if
1302 // everyone does it at once.
1303 if ( $this->getSize() >= 1e7
) { // 10MB
1304 $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $this->getName() ),
1306 'doWork' => function () {
1307 return $this->getLocalRefPath();
1311 $srcPath = $work->execute();
1313 $srcPath = $this->getLocalRefPath();
1319 'width' => $this->getWidth(),
1320 'height' => $this->getHeight()
1325 * Returns the repo path of the thumb for a given bucket
1326 * @param int $bucket
1329 protected function getBucketThumbPath( $bucket ) {
1330 $thumbName = $this->getBucketThumbName( $bucket );
1331 return $this->getThumbPath( $thumbName );
1335 * Returns the name of the thumb for a given bucket
1336 * @param int $bucket
1339 protected function getBucketThumbName( $bucket ) {
1340 return $this->thumbName( [ 'physicalWidth' => $bucket ] );
1344 * Creates a temp FS file with the same extension and the thumbnail
1345 * @param string $thumbPath Thumbnail path
1346 * @return TempFSFile|null
1348 protected function makeTransformTmpFile( $thumbPath ) {
1349 $thumbExt = FileBackend
::extensionFromPath( $thumbPath );
1350 return TempFSFile
::factory( 'transform_', $thumbExt, wfTempDir() );
1354 * @param string $thumbName Thumbnail name
1355 * @param string $dispositionType Type of disposition (either "attachment" or "inline")
1356 * @return string Content-Disposition header value
1358 function getThumbDisposition( $thumbName, $dispositionType = 'inline' ) {
1359 $fileName = $this->name
; // file name to suggest
1360 $thumbExt = FileBackend
::extensionFromPath( $thumbName );
1361 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1362 $fileName .= ".$thumbExt";
1365 return FileBackend
::makeContentDisposition( $dispositionType, $fileName );
1369 * Hook into transform() to allow migration of thumbnail files
1371 * Overridden by LocalFile
1372 * @param string $thumbName
1374 function migrateThumbFile( $thumbName ) {
1378 * Get a MediaHandler instance for this file
1380 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1381 * or false if none found
1383 function getHandler() {
1384 if ( !isset( $this->handler
) ) {
1385 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
1388 return $this->handler
;
1392 * Get a ThumbnailImage representing a file type icon
1394 * @return ThumbnailImage
1396 function iconThumb() {
1397 global $wgResourceBasePath, $IP;
1398 $assetsPath = "$wgResourceBasePath/resources/assets/file-type-icons/";
1399 $assetsDirectory = "$IP/resources/assets/file-type-icons/";
1401 $try = [ 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' ];
1402 foreach ( $try as $icon ) {
1403 if ( file_exists( $assetsDirectory . $icon ) ) { // always FS
1404 $params = [ 'width' => 120, 'height' => 120 ];
1406 return new ThumbnailImage( $this, $assetsPath . $icon, false, $params );
1414 * Get last thumbnailing error.
1418 function getLastError() {
1419 return $this->lastError
;
1423 * Get all thumbnail names previously generated for this file
1425 * Overridden by LocalFile
1428 function getThumbnails() {
1433 * Purge shared caches such as thumbnails and DB data caching
1435 * Overridden by LocalFile
1436 * @param array $options Options, which include:
1437 * 'forThumbRefresh' : The purging is only to refresh thumbnails
1439 function purgeCache( $options = [] ) {
1443 * Purge the file description page, but don't go after
1444 * pages using the file. Use when modifying file history
1445 * but not the current data.
1447 function purgeDescription() {
1448 $title = $this->getTitle();
1450 $title->invalidateCache();
1451 $title->purgeSquid();
1456 * Purge metadata and all affected pages when the file is created,
1457 * deleted, or majorly updated.
1459 function purgeEverything() {
1460 // Delete thumbnails and refresh file metadata cache
1461 $this->purgeCache();
1462 $this->purgeDescription();
1464 // Purge cache of all pages using this file
1465 $title = $this->getTitle();
1467 DeferredUpdates
::addUpdate(
1468 new HTMLCacheUpdate( $title, 'imagelinks', 'file-purge' )
1474 * Return a fragment of the history of file.
1477 * @param int $limit Limit of rows to return
1478 * @param string $start Only revisions older than $start will be returned
1479 * @param string $end Only revisions newer than $end will be returned
1480 * @param bool $inc Include the endpoints of the time range
1484 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1489 * Return the history of this file, line by line. Starts with current version,
1490 * then old versions. Should return an object similar to an image/oldimage
1494 * Overridden in LocalFile
1497 public function nextHistoryLine() {
1502 * Reset the history pointer to the first element of the history.
1503 * Always call this function after using nextHistoryLine() to free db resources
1505 * Overridden in LocalFile.
1507 public function resetHistory() {
1511 * Get the filename hash component of the directory including trailing slash,
1513 * If the repository is not hashed, returns an empty string.
1517 function getHashPath() {
1518 if ( !isset( $this->hashPath
) ) {
1519 $this->assertRepoDefined();
1520 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
1523 return $this->hashPath
;
1527 * Get the path of the file relative to the public zone root.
1528 * This function is overridden in OldLocalFile to be like getArchiveRel().
1533 return $this->getHashPath() . $this->getName();
1537 * Get the path of an archived file relative to the public zone root
1539 * @param bool|string $suffix If not false, the name of an archived thumbnail file
1543 function getArchiveRel( $suffix = false ) {
1544 $path = 'archive/' . $this->getHashPath();
1545 if ( $suffix === false ) {
1546 $path = substr( $path, 0, -1 );
1555 * Get the path, relative to the thumbnail zone root, of the
1556 * thumbnail directory or a particular file if $suffix is specified
1558 * @param bool|string $suffix If not false, the name of a thumbnail file
1561 function getThumbRel( $suffix = false ) {
1562 $path = $this->getRel();
1563 if ( $suffix !== false ) {
1564 $path .= '/' . $suffix;
1571 * Get urlencoded path of the file relative to the public zone root.
1572 * This function is overridden in OldLocalFile to be like getArchiveUrl().
1576 function getUrlRel() {
1577 return $this->getHashPath() . rawurlencode( $this->getName() );
1581 * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1582 * or a specific thumb if the $suffix is given.
1584 * @param string $archiveName The timestamped name of an archived image
1585 * @param bool|string $suffix If not false, the name of a thumbnail file
1588 function getArchiveThumbRel( $archiveName, $suffix = false ) {
1589 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1590 if ( $suffix === false ) {
1591 $path = substr( $path, 0, -1 );
1600 * Get the path of the archived file.
1602 * @param bool|string $suffix If not false, the name of an archived file.
1605 function getArchivePath( $suffix = false ) {
1606 $this->assertRepoDefined();
1608 return $this->repo
->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1612 * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1614 * @param string $archiveName The timestamped name of an archived image
1615 * @param bool|string $suffix If not false, the name of a thumbnail file
1618 function getArchiveThumbPath( $archiveName, $suffix = false ) {
1619 $this->assertRepoDefined();
1621 return $this->repo
->getZonePath( 'thumb' ) . '/' .
1622 $this->getArchiveThumbRel( $archiveName, $suffix );
1626 * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1628 * @param bool|string $suffix If not false, the name of a thumbnail file
1631 function getThumbPath( $suffix = false ) {
1632 $this->assertRepoDefined();
1634 return $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1638 * Get the path of the transcoded directory, or a particular file if $suffix is specified
1640 * @param bool|string $suffix If not false, the name of a media file
1643 function getTranscodedPath( $suffix = false ) {
1644 $this->assertRepoDefined();
1646 return $this->repo
->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1650 * Get the URL of the archive directory, or a particular file if $suffix is specified
1652 * @param bool|string $suffix If not false, the name of an archived file
1655 function getArchiveUrl( $suffix = false ) {
1656 $this->assertRepoDefined();
1657 $ext = $this->getExtension();
1658 $path = $this->repo
->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1659 if ( $suffix === false ) {
1660 $path = substr( $path, 0, -1 );
1662 $path .= rawurlencode( $suffix );
1669 * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1671 * @param string $archiveName The timestamped name of an archived image
1672 * @param bool|string $suffix If not false, the name of a thumbnail file
1675 function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1676 $this->assertRepoDefined();
1677 $ext = $this->getExtension();
1678 $path = $this->repo
->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1679 $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1680 if ( $suffix === false ) {
1681 $path = substr( $path, 0, -1 );
1683 $path .= rawurlencode( $suffix );
1690 * Get the URL of the zone directory, or a particular file if $suffix is specified
1692 * @param string $zone Name of requested zone
1693 * @param bool|string $suffix If not false, the name of a file in zone
1694 * @return string Path
1696 function getZoneUrl( $zone, $suffix = false ) {
1697 $this->assertRepoDefined();
1698 $ext = $this->getExtension();
1699 $path = $this->repo
->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1700 if ( $suffix !== false ) {
1701 $path .= '/' . rawurlencode( $suffix );
1708 * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1710 * @param bool|string $suffix If not false, the name of a thumbnail file
1711 * @return string Path
1713 function getThumbUrl( $suffix = false ) {
1714 return $this->getZoneUrl( 'thumb', $suffix );
1718 * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1720 * @param bool|string $suffix If not false, the name of a media file
1721 * @return string Path
1723 function getTranscodedUrl( $suffix = false ) {
1724 return $this->getZoneUrl( 'transcoded', $suffix );
1728 * Get the public zone virtual URL for a current version source file
1730 * @param bool|string $suffix If not false, the name of a thumbnail file
1733 function getVirtualUrl( $suffix = false ) {
1734 $this->assertRepoDefined();
1735 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
1736 if ( $suffix !== false ) {
1737 $path .= '/' . rawurlencode( $suffix );
1744 * Get the public zone virtual URL for an archived version source file
1746 * @param bool|string $suffix If not false, the name of a thumbnail file
1749 function getArchiveVirtualUrl( $suffix = false ) {
1750 $this->assertRepoDefined();
1751 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1752 if ( $suffix === false ) {
1753 $path = substr( $path, 0, -1 );
1755 $path .= rawurlencode( $suffix );
1762 * Get the virtual URL for a thumbnail file or directory
1764 * @param bool|string $suffix If not false, the name of a thumbnail file
1767 function getThumbVirtualUrl( $suffix = false ) {
1768 $this->assertRepoDefined();
1769 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1770 if ( $suffix !== false ) {
1771 $path .= '/' . rawurlencode( $suffix );
1780 function isHashed() {
1781 $this->assertRepoDefined();
1783 return (bool)$this->repo
->getHashLevels();
1787 * @throws MWException
1789 function readOnlyError() {
1790 throw new MWException( static::class . ': write operations are not supported' );
1794 * Record a file upload in the upload log and the image table
1796 * Overridden by LocalFile
1797 * @param string $oldver
1798 * @param string $desc
1799 * @param string $license
1800 * @param string $copyStatus
1801 * @param string $source
1802 * @param bool $watch
1803 * @param string|bool $timestamp
1804 * @param null|User $user User object or null to use $wgUser
1806 * @throws MWException
1808 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1809 $watch = false, $timestamp = false, User
$user = null
1811 $this->readOnlyError();
1815 * Move or copy a file to its public location. If a file exists at the
1816 * destination, move it to an archive. Returns a Status object with
1817 * the archive name in the "value" member on success.
1819 * The archive name should be passed through to recordUpload for database
1822 * Options to $options include:
1823 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1825 * @param string|FSFile $src Local filesystem path to the source image
1826 * @param int $flags A bitwise combination of:
1827 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1828 * @param array $options Optional additional parameters
1829 * @return Status On success, the value member contains the
1830 * archive name, or an empty string if it was a new file.
1833 * Overridden by LocalFile
1835 function publish( $src, $flags = 0, array $options = [] ) {
1836 $this->readOnlyError();
1840 * @param bool|IContextSource $context Context to use (optional)
1843 function formatMetadata( $context = false ) {
1844 if ( !$this->getHandler() ) {
1848 return $this->getHandler()->formatMetadata( $this, $context );
1852 * Returns true if the file comes from the local file repository.
1856 function isLocal() {
1857 return $this->repo
&& $this->repo
->isLocal();
1861 * Returns the name of the repository.
1865 function getRepoName() {
1866 return $this->repo ?
$this->repo
->getName() : 'unknown';
1870 * Returns the repository
1872 * @return FileRepo|LocalRepo|bool
1874 function getRepo() {
1879 * Returns true if the image is an old version
1889 * Is this file a "deleted" file in a private archive?
1892 * @param int $field One of DELETED_* bitfield constants
1895 function isDeleted( $field ) {
1900 * Return the deletion bitfield
1904 function getVisibility() {
1909 * Was this file ever deleted from the wiki?
1913 function wasDeleted() {
1914 $title = $this->getTitle();
1916 return $title && $title->isDeletedQuick();
1920 * Move file to the new title
1922 * Move current, old version and all thumbnails
1923 * to the new filename. Old file is deleted.
1925 * Cache purging is done; checks for validity
1926 * and logging are caller's responsibility
1928 * @param Title $target New file name
1931 function move( $target ) {
1932 $this->readOnlyError();
1936 * Delete all versions of the file.
1938 * Moves the files into an archive directory (or deletes them)
1939 * and removes the database rows.
1941 * Cache purging is done; logging is caller's responsibility.
1943 * @param string $reason
1944 * @param bool $suppress Hide content from sysops?
1945 * @param User|null $user
1948 * Overridden by LocalFile
1950 function delete( $reason, $suppress = false, $user = null ) {
1951 $this->readOnlyError();
1955 * Restore all or specified deleted revisions to the given file.
1956 * Permissions and logging are left to the caller.
1958 * May throw database exceptions on error.
1960 * @param array $versions Set of record ids of deleted items to restore,
1961 * or empty to restore all revisions.
1962 * @param bool $unsuppress Remove restrictions on content upon restoration?
1963 * @return int|bool The number of file revisions restored if successful,
1964 * or false on failure
1966 * Overridden by LocalFile
1968 function restore( $versions = [], $unsuppress = false ) {
1969 $this->readOnlyError();
1973 * Returns 'true' if this file is a type which supports multiple pages,
1974 * e.g. DJVU or PDF. Note that this may be true even if the file in
1975 * question only has a single page.
1979 function isMultipage() {
1980 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1984 * Returns the number of pages of a multipage document, or false for
1985 * documents which aren't multipage documents
1987 * @return string|bool|int
1989 function pageCount() {
1990 if ( !isset( $this->pageCount
) ) {
1991 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1992 $this->pageCount
= $this->handler
->pageCount( $this );
1994 $this->pageCount
= false;
1998 return $this->pageCount
;
2002 * Calculate the height of a thumbnail using the source and destination width
2004 * @param int $srcWidth
2005 * @param int $srcHeight
2006 * @param int $dstWidth
2010 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
2011 // Exact integer multiply followed by division
2012 if ( $srcWidth == 0 ) {
2015 return (int)round( $srcHeight * $dstWidth / $srcWidth );
2020 * Get an image size array like that returned by getImageSize(), or false if it
2021 * can't be determined. Loads the image size directly from the file ignoring caches.
2023 * @note Use getWidth()/getHeight() instead of this method unless you have a
2024 * a good reason. This method skips all caches.
2026 * @param string $filePath The path to the file (e.g. From getLocalPathRef() )
2027 * @return array|false The width, followed by height, with optionally more things after
2029 function getImageSize( $filePath ) {
2030 if ( !$this->getHandler() ) {
2034 return $this->getHandler()->getImageSize( $this, $filePath );
2038 * Get the URL of the image description page. May return false if it is
2039 * unknown or not applicable.
2043 function getDescriptionUrl() {
2044 if ( $this->repo
) {
2045 return $this->repo
->getDescriptionUrl( $this->getName() );
2052 * Get the HTML text of the description page, if available
2054 * @param bool|Language $lang Optional language to fetch description in
2055 * @return string|false
2057 function getDescriptionText( $lang = false ) {
2060 if ( !$this->repo ||
!$this->repo
->fetchDescription
) {
2064 $lang = $lang ?
: $wgLang;
2066 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
2068 $cache = ObjectCache
::getMainWANInstance();
2069 $key = $this->repo
->getLocalCacheKey(
2070 'RemoteFileDescription',
2076 return $cache->getWithSetCallback(
2078 $this->repo
->descriptionCacheExpiry ?
: $cache::TTL_UNCACHEABLE
,
2079 function ( $oldValue, &$ttl, array &$setOpts ) use ( $renderUrl ) {
2080 wfDebug( "Fetching shared description from $renderUrl\n" );
2081 $res = Http
::get( $renderUrl, [], __METHOD__
);
2083 $ttl = WANObjectCache
::TTL_UNCACHEABLE
;
2095 * Get description of file revision
2098 * @param int $audience One of:
2099 * File::FOR_PUBLIC to be displayed to all users
2100 * File::FOR_THIS_USER to be displayed to the given user
2101 * File::RAW get the description regardless of permissions
2102 * @param User $user User object to check for, only if FOR_THIS_USER is
2103 * passed to the $audience parameter
2106 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
2111 * Get the 14-character timestamp of the file upload
2113 * @return string|bool TS_MW timestamp or false on failure
2115 function getTimestamp() {
2116 $this->assertRepoDefined();
2118 return $this->repo
->getFileTimestamp( $this->getPath() );
2122 * Returns the timestamp (in TS_MW format) of the last change of the description page.
2123 * Returns false if the file does not have a description page, or retrieving the timestamp
2124 * would be expensive.
2126 * @return string|bool
2128 public function getDescriptionTouched() {
2133 * Get the SHA-1 base 36 hash of the file
2137 function getSha1() {
2138 $this->assertRepoDefined();
2140 return $this->repo
->getFileSha1( $this->getPath() );
2144 * Get the deletion archive key, "<sha1>.<ext>"
2146 * @return string|false
2148 function getStorageKey() {
2149 $hash = $this->getSha1();
2153 $ext = $this->getExtension();
2154 $dotExt = $ext === '' ?
'' : ".$ext";
2156 return $hash . $dotExt;
2160 * Determine if the current user is allowed to view a particular
2161 * field of this file, if it's marked as deleted.
2164 * @param User $user User object to check, or null to use $wgUser
2167 function userCan( $field, User
$user = null ) {
2172 * @deprecated since 1.30, use File::getContentHeaders instead
2174 function getStreamHeaders() {
2175 wfDeprecated( __METHOD__
, '1.30' );
2176 return $this->getContentHeaders();
2180 * @return array HTTP header name/value map to use for HEAD/GET request responses
2183 function getContentHeaders() {
2184 $handler = $this->getHandler();
2186 $metadata = $this->getMetadata();
2188 if ( is_string( $metadata ) ) {
2189 $metadata = Wikimedia\
quietCall( 'unserialize', $metadata );
2192 if ( !is_array( $metadata ) ) {
2196 return $handler->getContentHeaders( $metadata );
2205 function getLongDesc() {
2206 $handler = $this->getHandler();
2208 return $handler->getLongDesc( $this );
2210 return MediaHandler
::getGeneralLongDesc( $this );
2217 function getShortDesc() {
2218 $handler = $this->getHandler();
2220 return $handler->getShortDesc( $this );
2222 return MediaHandler
::getGeneralShortDesc( $this );
2229 function getDimensionsString() {
2230 $handler = $this->getHandler();
2232 return $handler->getDimensionsString( $this );
2241 function getRedirected() {
2242 return $this->redirected
;
2246 * @return Title|null
2248 function getRedirectedTitle() {
2249 if ( $this->redirected
) {
2250 if ( !$this->redirectTitle
) {
2251 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
2254 return $this->redirectTitle
;
2261 * @param string $from
2264 function redirectedFrom( $from ) {
2265 $this->redirected
= $from;
2271 function isMissing() {
2276 * Check if this file object is small and can be cached
2279 public function isCacheable() {
2284 * Assert that $this->repo is set to a valid FileRepo instance
2285 * @throws MWException
2287 protected function assertRepoDefined() {
2288 if ( !( $this->repo
instanceof $this->repoClass
) ) {
2289 throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2294 * Assert that $this->title is set to a Title
2295 * @throws MWException
2297 protected function assertTitleDefined() {
2298 if ( !( $this->title
instanceof Title
) ) {
2299 throw new MWException( "A Title object is not set for this File.\n" );
2304 * True if creating thumbnails from the file is large or otherwise resource-intensive.
2307 public function isExpensiveToThumbnail() {
2308 $handler = $this->getHandler();
2309 return $handler ?
$handler->isExpensiveToThumbnail( $this ) : false;
2313 * Whether the thumbnails created on the same server as this code is running.
2317 public function isTransformedLocally() {