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';
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 = MimeMagic
::singleton();
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 * In files that support multiple language, what is the default language
586 * to use if none specified.
588 * @return string|null Lang code, or null if filetype doesn't support multiple languages.
591 public function getDefaultRenderLanguage() {
592 $handler = $this->getHandler();
594 return $handler->getDefaultRenderLanguage( $this );
601 * Will the thumbnail be animated if one would expect it to be.
603 * Currently used to add a warning to the image description page
605 * @return bool False if the main image is both animated
606 * and the thumbnail is not. In all other cases must return
607 * true. If image is not renderable whatsoever, should
610 public function canAnimateThumbIfAppropriate() {
611 $handler = $this->getHandler();
613 // We cannot handle image whatsoever, thus
614 // one would not expect it to be animated
618 if ( $this->allowInlineDisplay()
619 && $handler->isAnimatedImage( $this )
620 && !$handler->canAnimateThumbnail( $this )
622 // Image is animated, but thumbnail isn't.
623 // This is unexpected to the user.
626 // Image is not animated, so one would
627 // not expect thumb to be
634 * Get handler-specific metadata
635 * Overridden by LocalFile, UnregisteredLocalFile
639 public function getMetadata() {
644 * Like getMetadata but returns a handler independent array of common values.
645 * @see MediaHandler::getCommonMetaArray()
646 * @return array|bool Array or false if not supported
649 public function getCommonMetaArray() {
650 $handler = $this->getHandler();
656 return $handler->getCommonMetaArray( $this );
660 * get versioned metadata
662 * @param array|string $metadata Array or string of (serialized) metadata
663 * @param int $version Version number.
664 * @return array Array containing metadata, or what was passed to it on fail
665 * (unserializing if not array)
667 public function convertMetadataVersion( $metadata, $version ) {
668 $handler = $this->getHandler();
669 if ( !is_array( $metadata ) ) {
670 // Just to make the return type consistent
671 $metadata = unserialize( $metadata );
674 return $handler->convertMetadataVersion( $metadata, $version );
681 * Return the bit depth of the file
682 * Overridden by LocalFile
686 public function getBitDepth() {
691 * Return the size of the image file, in bytes
692 * Overridden by LocalFile, UnregisteredLocalFile
696 public function getSize() {
701 * Returns the MIME type of the file.
702 * Overridden by LocalFile, UnregisteredLocalFile
707 function getMimeType() {
708 return 'unknown/unknown';
712 * Return the type of the media in the file.
713 * Use the value returned by this function with the MEDIATYPE_xxx constants.
714 * Overridden by LocalFile,
718 function getMediaType() {
719 return MEDIATYPE_UNKNOWN
;
723 * Checks if the output of transform() for this file is likely
724 * to be valid. If this is false, various user elements will
725 * display a placeholder instead.
727 * Currently, this checks if the file is an image format
728 * that can be converted to a format
729 * supported by all browsers (namely GIF, PNG and JPEG),
730 * or if it is an SVG image and SVG conversion is enabled.
734 function canRender() {
735 if ( !isset( $this->canRender
) ) {
736 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this ) && $this->exists();
739 return $this->canRender
;
743 * Accessor for __get()
746 protected function getCanRender() {
747 return $this->canRender();
751 * Return true if the file is of a type that can't be directly
752 * rendered by typical browsers and needs to be re-rasterized.
754 * This returns true for everything but the bitmap types
755 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
756 * also return true for any non-image formats.
760 function mustRender() {
761 return $this->getHandler() && $this->handler
->mustRender( $this );
765 * Alias for canRender()
769 function allowInlineDisplay() {
770 return $this->canRender();
774 * Determines if this media file is in a format that is unlikely to
775 * contain viruses or malicious content. It uses the global
776 * $wgTrustedMediaFormats list to determine if the file is safe.
778 * This is used to show a warning on the description page of non-safe files.
779 * It may also be used to disallow direct [[media:...]] links to such files.
781 * Note that this function will always return true if allowInlineDisplay()
782 * or isTrustedFile() is true for this file.
786 function isSafeFile() {
787 if ( !isset( $this->isSafeFile
) ) {
788 $this->isSafeFile
= $this->getIsSafeFileUncached();
791 return $this->isSafeFile
;
795 * Accessor for __get()
799 protected function getIsSafeFile() {
800 return $this->isSafeFile();
808 protected function getIsSafeFileUncached() {
809 global $wgTrustedMediaFormats;
811 if ( $this->allowInlineDisplay() ) {
814 if ( $this->isTrustedFile() ) {
818 $type = $this->getMediaType();
819 $mime = $this->getMimeType();
820 # wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
822 if ( !$type ||
$type === MEDIATYPE_UNKNOWN
) {
823 return false; # unknown type, not trusted
825 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
829 if ( $mime === "unknown/unknown" ) {
830 return false; # unknown type, not trusted
832 if ( in_array( $mime, $wgTrustedMediaFormats ) ) {
840 * Returns true if the file is flagged as trusted. Files flagged that way
841 * can be linked to directly, even if that is not allowed for this type of
844 * This is a dummy function right now and always returns false. It could be
845 * implemented to extract a flag from the database. The trusted flag could be
846 * set on upload, if the user has sufficient privileges, to bypass script-
847 * and html-filters. It may even be coupled with cryptographics signatures
852 function isTrustedFile() {
853 # this could be implemented to check a flag in the database,
854 # look for signatures, etc
859 * Load any lazy-loaded file object fields from source
861 * This is only useful when setting $flags
863 * Overridden by LocalFile to actually query the DB
865 * @param int $flags Bitfield of File::READ_* constants
867 public function load( $flags = 0 ) {
871 * Returns true if file exists in the repository.
873 * Overridden by LocalFile to avoid unnecessary stat calls.
875 * @return bool Whether file exists in the repository.
877 public function exists() {
878 return $this->getPath() && $this->repo
->fileExists( $this->path
);
882 * Returns true if file exists in the repository and can be included in a page.
883 * It would be unsafe to include private images, making public thumbnails inadvertently
885 * @return bool Whether file exists in the repository and is includable.
887 public function isVisible() {
888 return $this->exists();
894 function getTransformScript() {
895 if ( !isset( $this->transformScript
) ) {
896 $this->transformScript
= false;
898 $script = $this->repo
->getThumbScriptUrl();
900 $this->transformScript
= wfAppendQuery( $script, [ 'f' => $this->getName() ] );
905 return $this->transformScript
;
909 * Get a ThumbnailImage which is the same size as the source
911 * @param array $handlerParams
913 * @return ThumbnailImage|MediaTransformOutput|bool False on failure
915 function getUnscaledThumb( $handlerParams = [] ) {
916 $hp =& $handlerParams;
917 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
918 $width = $this->getWidth( $page );
920 return $this->iconThumb();
922 $hp['width'] = $width;
923 // be sure to ignore any height specification as well (T64258)
924 unset( $hp['height'] );
926 return $this->transform( $hp );
930 * Return the file name of a thumbnail with the specified parameters.
931 * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
932 * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
934 * @param array $params Handler-specific parameters
935 * @param int $flags Bitfield that supports THUMB_* constants
936 * @return string|null
938 public function thumbName( $params, $flags = 0 ) {
939 $name = ( $this->repo
&& !( $flags & self
::THUMB_FULL_NAME
) )
940 ?
$this->repo
->nameForThumb( $this->getName() )
943 return $this->generateThumbName( $name, $params );
947 * Generate a thumbnail file name from a name and specified parameters
949 * @param string $name
950 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
951 * @return string|null
953 public function generateThumbName( $name, $params ) {
954 if ( !$this->getHandler() ) {
957 $extension = $this->getExtension();
958 list( $thumbExt, ) = $this->getHandler()->getThumbType(
959 $extension, $this->getMimeType(), $params );
960 $thumbName = $this->getHandler()->makeParamString( $params );
962 if ( $this->repo
->supportsSha1URLs() ) {
963 $thumbName .= '-' . $this->getSha1() . '.' . $thumbExt;
965 $thumbName .= '-' . $name;
967 if ( $thumbExt != $extension ) {
968 $thumbName .= ".$thumbExt";
976 * Create a thumbnail of the image having the specified width/height.
977 * The thumbnail will not be created if the width is larger than the
978 * image's width. Let the browser do the scaling in this case.
979 * The thumbnail is stored on disk and is only computed if the thumbnail
980 * file does not exist OR if it is older than the image.
983 * Keeps aspect ratio of original image. If both width and height are
984 * specified, the generated image will be no bigger than width x height,
985 * and will also have correct aspect ratio.
987 * @param int $width Maximum width of the generated thumbnail
988 * @param int $height Maximum height of the image (optional)
992 public function createThumb( $width, $height = -1 ) {
993 $params = [ 'width' => $width ];
994 if ( $height != -1 ) {
995 $params['height'] = $height;
997 $thumb = $this->transform( $params );
998 if ( !$thumb ||
$thumb->isError() ) {
1002 return $thumb->getUrl();
1006 * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
1008 * @param string $thumbPath Thumbnail storage path
1009 * @param string $thumbUrl Thumbnail URL
1010 * @param array $params
1012 * @return MediaTransformOutput
1014 protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
1015 global $wgIgnoreImageErrors;
1017 $handler = $this->getHandler();
1018 if ( $handler && $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1019 return $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1021 return new MediaTransformError( 'thumbnail_error',
1022 $params['width'], 0, wfMessage( 'thumbnail-dest-create' ) );
1027 * Transform a media file
1029 * @param array $params An associative array of handler-specific parameters.
1030 * Typical keys are width, height and page.
1031 * @param int $flags A bitfield, may contain self::RENDER_NOW to force rendering
1032 * @return ThumbnailImage|MediaTransformOutput|bool False on failure
1034 function transform( $params, $flags = 0 ) {
1035 global $wgThumbnailEpoch;
1038 if ( !$this->canRender() ) {
1039 $thumb = $this->iconThumb();
1040 break; // not a bitmap or renderable image, don't try
1043 // Get the descriptionUrl to embed it as comment into the thumbnail. T21791.
1044 $descriptionUrl = $this->getDescriptionUrl();
1045 if ( $descriptionUrl ) {
1046 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL
);
1049 $handler = $this->getHandler();
1050 $script = $this->getTransformScript();
1051 if ( $script && !( $flags & self
::RENDER_NOW
) ) {
1052 // Use a script to transform on client request, if possible
1053 $thumb = $handler->getScriptedTransform( $this, $script, $params );
1059 $normalisedParams = $params;
1060 $handler->normaliseParams( $this, $normalisedParams );
1062 $thumbName = $this->thumbName( $normalisedParams );
1063 $thumbUrl = $this->getThumbUrl( $thumbName );
1064 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1066 if ( $this->repo
) {
1067 // Defer rendering if a 404 handler is set up...
1068 if ( $this->repo
->canTransformVia404() && !( $flags & self
::RENDER_NOW
) ) {
1069 // XXX: Pass in the storage path even though we are not rendering anything
1070 // and the path is supposed to be an FS path. This is due to getScalerType()
1071 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1072 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1075 // Check if an up-to-date thumbnail already exists...
1076 wfDebug( __METHOD__
. ": Doing stat for $thumbPath\n" );
1077 if ( !( $flags & self
::RENDER_FORCE
) && $this->repo
->fileExists( $thumbPath ) ) {
1078 $timestamp = $this->repo
->getFileTimestamp( $thumbPath );
1079 if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
1080 // XXX: Pass in the storage path even though we are not rendering anything
1081 // and the path is supposed to be an FS path. This is due to getScalerType()
1082 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1083 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1084 $thumb->setStoragePath( $thumbPath );
1087 } elseif ( $flags & self
::RENDER_FORCE
) {
1088 wfDebug( __METHOD__
. " forcing rendering per flag File::RENDER_FORCE\n" );
1091 // If the backend is ready-only, don't keep generating thumbnails
1092 // only to return transformation errors, just return the error now.
1093 if ( $this->repo
->getReadOnlyReason() !== false ) {
1094 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1099 $tmpFile = $this->makeTransformTmpFile( $thumbPath );
1102 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1104 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1108 return is_object( $thumb ) ?
$thumb : false;
1112 * Generates a thumbnail according to the given parameters and saves it to storage
1113 * @param TempFSFile $tmpFile Temporary file where the rendered thumbnail will be saved
1114 * @param array $transformParams
1116 * @return bool|MediaTransformOutput
1118 public function generateAndSaveThumb( $tmpFile, $transformParams, $flags ) {
1119 global $wgIgnoreImageErrors;
1121 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1123 $handler = $this->getHandler();
1125 $normalisedParams = $transformParams;
1126 $handler->normaliseParams( $this, $normalisedParams );
1128 $thumbName = $this->thumbName( $normalisedParams );
1129 $thumbUrl = $this->getThumbUrl( $thumbName );
1130 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1132 $tmpThumbPath = $tmpFile->getPath();
1134 if ( $handler->supportsBucketing() ) {
1135 $this->generateBucketsIfNeeded( $normalisedParams, $flags );
1138 $starttime = microtime( true );
1140 // Actually render the thumbnail...
1141 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1142 $tmpFile->bind( $thumb ); // keep alive with $thumb
1144 $statTiming = microtime( true ) - $starttime;
1145 $stats->timing( 'media.thumbnail.generate.transform', 1000 * $statTiming );
1147 if ( !$thumb ) { // bad params?
1149 } elseif ( $thumb->isError() ) { // transform error
1150 /** @var MediaTransformError $thumb */
1151 $this->lastError
= $thumb->toText();
1152 // Ignore errors if requested
1153 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1154 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1156 } elseif ( $this->repo
&& $thumb->hasFile() && !$thumb->fileIsSource() ) {
1157 // Copy the thumbnail from the file system into storage...
1159 $starttime = microtime( true );
1161 $disposition = $this->getThumbDisposition( $thumbName );
1162 $status = $this->repo
->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1163 if ( $status->isOK() ) {
1164 $thumb->setStoragePath( $thumbPath );
1166 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $transformParams, $flags );
1169 $statTiming = microtime( true ) - $starttime;
1170 $stats->timing( 'media.thumbnail.generate.store', 1000 * $statTiming );
1172 // Give extensions a chance to do something with this thumbnail...
1173 Hooks
::run( 'FileTransformed', [ $this, $thumb, $tmpThumbPath, $thumbPath ] );
1180 * Generates chained bucketed thumbnails if needed
1181 * @param array $params
1183 * @return bool Whether at least one bucket was generated
1185 protected function generateBucketsIfNeeded( $params, $flags = 0 ) {
1187 ||
!isset( $params['physicalWidth'] )
1188 ||
!isset( $params['physicalHeight'] )
1193 $bucket = $this->getThumbnailBucket( $params['physicalWidth'] );
1195 if ( !$bucket ||
$bucket == $params['physicalWidth'] ) {
1199 $bucketPath = $this->getBucketThumbPath( $bucket );
1201 if ( $this->repo
->fileExists( $bucketPath ) ) {
1205 $starttime = microtime( true );
1207 $params['physicalWidth'] = $bucket;
1208 $params['width'] = $bucket;
1210 $params = $this->getHandler()->sanitizeParamsForBucketing( $params );
1212 $tmpFile = $this->makeTransformTmpFile( $bucketPath );
1218 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1220 $buckettime = microtime( true ) - $starttime;
1222 if ( !$thumb ||
$thumb->isError() ) {
1226 $this->tmpBucketedThumbCache
[$bucket] = $tmpFile->getPath();
1227 // For the caching to work, we need to make the tmp file survive as long as
1228 // this object exists
1229 $tmpFile->bind( $this );
1231 MediaWikiServices
::getInstance()->getStatsdDataFactory()->timing(
1232 'media.thumbnail.generate.bucket', 1000 * $buckettime );
1238 * Returns the most appropriate source image for the thumbnail, given a target thumbnail size
1239 * @param array $params
1240 * @return array Source path and width/height of the source
1242 public function getThumbnailSource( $params ) {
1244 && $this->getHandler()->supportsBucketing()
1245 && isset( $params['physicalWidth'] )
1246 && $bucket = $this->getThumbnailBucket( $params['physicalWidth'] )
1248 if ( $this->getWidth() != 0 ) {
1249 $bucketHeight = round( $this->getHeight() * ( $bucket / $this->getWidth() ) );
1254 // Try to avoid reading from storage if the file was generated by this script
1255 if ( isset( $this->tmpBucketedThumbCache
[$bucket] ) ) {
1256 $tmpPath = $this->tmpBucketedThumbCache
[$bucket];
1258 if ( file_exists( $tmpPath ) ) {
1262 'height' => $bucketHeight
1267 $bucketPath = $this->getBucketThumbPath( $bucket );
1269 if ( $this->repo
->fileExists( $bucketPath ) ) {
1270 $fsFile = $this->repo
->getLocalReference( $bucketPath );
1274 'path' => $fsFile->getPath(),
1276 'height' => $bucketHeight
1282 // Thumbnailing a very large file could result in network saturation if
1283 // everyone does it at once.
1284 if ( $this->getSize() >= 1e7
) { // 10MB
1285 $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $this->getName() ),
1287 'doWork' => function () {
1288 return $this->getLocalRefPath();
1292 $srcPath = $work->execute();
1294 $srcPath = $this->getLocalRefPath();
1300 'width' => $this->getWidth(),
1301 'height' => $this->getHeight()
1306 * Returns the repo path of the thumb for a given bucket
1307 * @param int $bucket
1310 protected function getBucketThumbPath( $bucket ) {
1311 $thumbName = $this->getBucketThumbName( $bucket );
1312 return $this->getThumbPath( $thumbName );
1316 * Returns the name of the thumb for a given bucket
1317 * @param int $bucket
1320 protected function getBucketThumbName( $bucket ) {
1321 return $this->thumbName( [ 'physicalWidth' => $bucket ] );
1325 * Creates a temp FS file with the same extension and the thumbnail
1326 * @param string $thumbPath Thumbnail path
1327 * @return TempFSFile|null
1329 protected function makeTransformTmpFile( $thumbPath ) {
1330 $thumbExt = FileBackend
::extensionFromPath( $thumbPath );
1331 return TempFSFile
::factory( 'transform_', $thumbExt, wfTempDir() );
1335 * @param string $thumbName Thumbnail name
1336 * @param string $dispositionType Type of disposition (either "attachment" or "inline")
1337 * @return string Content-Disposition header value
1339 function getThumbDisposition( $thumbName, $dispositionType = 'inline' ) {
1340 $fileName = $this->name
; // file name to suggest
1341 $thumbExt = FileBackend
::extensionFromPath( $thumbName );
1342 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1343 $fileName .= ".$thumbExt";
1346 return FileBackend
::makeContentDisposition( $dispositionType, $fileName );
1350 * Hook into transform() to allow migration of thumbnail files
1352 * Overridden by LocalFile
1353 * @param string $thumbName
1355 function migrateThumbFile( $thumbName ) {
1359 * Get a MediaHandler instance for this file
1361 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1362 * or false if none found
1364 function getHandler() {
1365 if ( !isset( $this->handler
) ) {
1366 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
1369 return $this->handler
;
1373 * Get a ThumbnailImage representing a file type icon
1375 * @return ThumbnailImage
1377 function iconThumb() {
1378 global $wgResourceBasePath, $IP;
1379 $assetsPath = "$wgResourceBasePath/resources/assets/file-type-icons/";
1380 $assetsDirectory = "$IP/resources/assets/file-type-icons/";
1382 $try = [ 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' ];
1383 foreach ( $try as $icon ) {
1384 if ( file_exists( $assetsDirectory . $icon ) ) { // always FS
1385 $params = [ 'width' => 120, 'height' => 120 ];
1387 return new ThumbnailImage( $this, $assetsPath . $icon, false, $params );
1395 * Get last thumbnailing error.
1399 function getLastError() {
1400 return $this->lastError
;
1404 * Get all thumbnail names previously generated for this file
1406 * Overridden by LocalFile
1409 function getThumbnails() {
1414 * Purge shared caches such as thumbnails and DB data caching
1416 * Overridden by LocalFile
1417 * @param array $options Options, which include:
1418 * 'forThumbRefresh' : The purging is only to refresh thumbnails
1420 function purgeCache( $options = [] ) {
1424 * Purge the file description page, but don't go after
1425 * pages using the file. Use when modifying file history
1426 * but not the current data.
1428 function purgeDescription() {
1429 $title = $this->getTitle();
1431 $title->invalidateCache();
1432 $title->purgeSquid();
1437 * Purge metadata and all affected pages when the file is created,
1438 * deleted, or majorly updated.
1440 function purgeEverything() {
1441 // Delete thumbnails and refresh file metadata cache
1442 $this->purgeCache();
1443 $this->purgeDescription();
1445 // Purge cache of all pages using this file
1446 $title = $this->getTitle();
1448 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
1453 * Return a fragment of the history of file.
1456 * @param int $limit Limit of rows to return
1457 * @param string $start Only revisions older than $start will be returned
1458 * @param string $end Only revisions newer than $end will be returned
1459 * @param bool $inc Include the endpoints of the time range
1463 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1468 * Return the history of this file, line by line. Starts with current version,
1469 * then old versions. Should return an object similar to an image/oldimage
1473 * Overridden in LocalFile
1476 public function nextHistoryLine() {
1481 * Reset the history pointer to the first element of the history.
1482 * Always call this function after using nextHistoryLine() to free db resources
1484 * Overridden in LocalFile.
1486 public function resetHistory() {
1490 * Get the filename hash component of the directory including trailing slash,
1492 * If the repository is not hashed, returns an empty string.
1496 function getHashPath() {
1497 if ( !isset( $this->hashPath
) ) {
1498 $this->assertRepoDefined();
1499 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
1502 return $this->hashPath
;
1506 * Get the path of the file relative to the public zone root.
1507 * This function is overridden in OldLocalFile to be like getArchiveRel().
1512 return $this->getHashPath() . $this->getName();
1516 * Get the path of an archived file relative to the public zone root
1518 * @param bool|string $suffix If not false, the name of an archived thumbnail file
1522 function getArchiveRel( $suffix = false ) {
1523 $path = 'archive/' . $this->getHashPath();
1524 if ( $suffix === false ) {
1525 $path = substr( $path, 0, -1 );
1534 * Get the path, relative to the thumbnail zone root, of the
1535 * thumbnail directory or a particular file if $suffix is specified
1537 * @param bool|string $suffix If not false, the name of a thumbnail file
1540 function getThumbRel( $suffix = false ) {
1541 $path = $this->getRel();
1542 if ( $suffix !== false ) {
1543 $path .= '/' . $suffix;
1550 * Get urlencoded path of the file relative to the public zone root.
1551 * This function is overridden in OldLocalFile to be like getArchiveUrl().
1555 function getUrlRel() {
1556 return $this->getHashPath() . rawurlencode( $this->getName() );
1560 * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1561 * or a specific thumb if the $suffix is given.
1563 * @param string $archiveName The timestamped name of an archived image
1564 * @param bool|string $suffix If not false, the name of a thumbnail file
1567 function getArchiveThumbRel( $archiveName, $suffix = false ) {
1568 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1569 if ( $suffix === false ) {
1570 $path = substr( $path, 0, -1 );
1579 * Get the path of the archived file.
1581 * @param bool|string $suffix If not false, the name of an archived file.
1584 function getArchivePath( $suffix = false ) {
1585 $this->assertRepoDefined();
1587 return $this->repo
->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1591 * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1593 * @param string $archiveName The timestamped name of an archived image
1594 * @param bool|string $suffix If not false, the name of a thumbnail file
1597 function getArchiveThumbPath( $archiveName, $suffix = false ) {
1598 $this->assertRepoDefined();
1600 return $this->repo
->getZonePath( 'thumb' ) . '/' .
1601 $this->getArchiveThumbRel( $archiveName, $suffix );
1605 * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1607 * @param bool|string $suffix If not false, the name of a thumbnail file
1610 function getThumbPath( $suffix = false ) {
1611 $this->assertRepoDefined();
1613 return $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1617 * Get the path of the transcoded directory, or a particular file if $suffix is specified
1619 * @param bool|string $suffix If not false, the name of a media file
1622 function getTranscodedPath( $suffix = false ) {
1623 $this->assertRepoDefined();
1625 return $this->repo
->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1629 * Get the URL of the archive directory, or a particular file if $suffix is specified
1631 * @param bool|string $suffix If not false, the name of an archived file
1634 function getArchiveUrl( $suffix = false ) {
1635 $this->assertRepoDefined();
1636 $ext = $this->getExtension();
1637 $path = $this->repo
->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1638 if ( $suffix === false ) {
1639 $path = substr( $path, 0, -1 );
1641 $path .= rawurlencode( $suffix );
1648 * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1650 * @param string $archiveName The timestamped name of an archived image
1651 * @param bool|string $suffix If not false, the name of a thumbnail file
1654 function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1655 $this->assertRepoDefined();
1656 $ext = $this->getExtension();
1657 $path = $this->repo
->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1658 $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1659 if ( $suffix === false ) {
1660 $path = substr( $path, 0, -1 );
1662 $path .= rawurlencode( $suffix );
1669 * Get the URL of the zone directory, or a particular file if $suffix is specified
1671 * @param string $zone Name of requested zone
1672 * @param bool|string $suffix If not false, the name of a file in zone
1673 * @return string Path
1675 function getZoneUrl( $zone, $suffix = false ) {
1676 $this->assertRepoDefined();
1677 $ext = $this->getExtension();
1678 $path = $this->repo
->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1679 if ( $suffix !== false ) {
1680 $path .= '/' . rawurlencode( $suffix );
1687 * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1689 * @param bool|string $suffix If not false, the name of a thumbnail file
1690 * @return string Path
1692 function getThumbUrl( $suffix = false ) {
1693 return $this->getZoneUrl( 'thumb', $suffix );
1697 * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1699 * @param bool|string $suffix If not false, the name of a media file
1700 * @return string Path
1702 function getTranscodedUrl( $suffix = false ) {
1703 return $this->getZoneUrl( 'transcoded', $suffix );
1707 * Get the public zone virtual URL for a current version source file
1709 * @param bool|string $suffix If not false, the name of a thumbnail file
1712 function getVirtualUrl( $suffix = false ) {
1713 $this->assertRepoDefined();
1714 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
1715 if ( $suffix !== false ) {
1716 $path .= '/' . rawurlencode( $suffix );
1723 * Get the public zone virtual URL for an archived version source file
1725 * @param bool|string $suffix If not false, the name of a thumbnail file
1728 function getArchiveVirtualUrl( $suffix = false ) {
1729 $this->assertRepoDefined();
1730 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1731 if ( $suffix === false ) {
1732 $path = substr( $path, 0, -1 );
1734 $path .= rawurlencode( $suffix );
1741 * Get the virtual URL for a thumbnail file or directory
1743 * @param bool|string $suffix If not false, the name of a thumbnail file
1746 function getThumbVirtualUrl( $suffix = false ) {
1747 $this->assertRepoDefined();
1748 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1749 if ( $suffix !== false ) {
1750 $path .= '/' . rawurlencode( $suffix );
1759 function isHashed() {
1760 $this->assertRepoDefined();
1762 return (bool)$this->repo
->getHashLevels();
1766 * @throws MWException
1768 function readOnlyError() {
1769 throw new MWException( static::class . ': write operations are not supported' );
1773 * Record a file upload in the upload log and the image table
1775 * Overridden by LocalFile
1776 * @param string $oldver
1777 * @param string $desc
1778 * @param string $license
1779 * @param string $copyStatus
1780 * @param string $source
1781 * @param bool $watch
1782 * @param string|bool $timestamp
1783 * @param null|User $user User object or null to use $wgUser
1785 * @throws MWException
1787 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1788 $watch = false, $timestamp = false, User
$user = null
1790 $this->readOnlyError();
1794 * Move or copy a file to its public location. If a file exists at the
1795 * destination, move it to an archive. Returns a Status object with
1796 * the archive name in the "value" member on success.
1798 * The archive name should be passed through to recordUpload for database
1801 * Options to $options include:
1802 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1804 * @param string|FSFile $src Local filesystem path to the source image
1805 * @param int $flags A bitwise combination of:
1806 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1807 * @param array $options Optional additional parameters
1808 * @return Status On success, the value member contains the
1809 * archive name, or an empty string if it was a new file.
1812 * Overridden by LocalFile
1814 function publish( $src, $flags = 0, array $options = [] ) {
1815 $this->readOnlyError();
1819 * @param bool|IContextSource $context Context to use (optional)
1822 function formatMetadata( $context = false ) {
1823 if ( !$this->getHandler() ) {
1827 return $this->getHandler()->formatMetadata( $this, $context );
1831 * Returns true if the file comes from the local file repository.
1835 function isLocal() {
1836 return $this->repo
&& $this->repo
->isLocal();
1840 * Returns the name of the repository.
1844 function getRepoName() {
1845 return $this->repo ?
$this->repo
->getName() : 'unknown';
1849 * Returns the repository
1851 * @return FileRepo|LocalRepo|bool
1853 function getRepo() {
1858 * Returns true if the image is an old version
1868 * Is this file a "deleted" file in a private archive?
1871 * @param int $field One of DELETED_* bitfield constants
1874 function isDeleted( $field ) {
1879 * Return the deletion bitfield
1883 function getVisibility() {
1888 * Was this file ever deleted from the wiki?
1892 function wasDeleted() {
1893 $title = $this->getTitle();
1895 return $title && $title->isDeletedQuick();
1899 * Move file to the new title
1901 * Move current, old version and all thumbnails
1902 * to the new filename. Old file is deleted.
1904 * Cache purging is done; checks for validity
1905 * and logging are caller's responsibility
1907 * @param Title $target New file name
1910 function move( $target ) {
1911 $this->readOnlyError();
1915 * Delete all versions of the file.
1917 * Moves the files into an archive directory (or deletes them)
1918 * and removes the database rows.
1920 * Cache purging is done; logging is caller's responsibility.
1922 * @param string $reason
1923 * @param bool $suppress Hide content from sysops?
1924 * @param User|null $user
1927 * Overridden by LocalFile
1929 function delete( $reason, $suppress = false, $user = null ) {
1930 $this->readOnlyError();
1934 * Restore all or specified deleted revisions to the given file.
1935 * Permissions and logging are left to the caller.
1937 * May throw database exceptions on error.
1939 * @param array $versions Set of record ids of deleted items to restore,
1940 * or empty to restore all revisions.
1941 * @param bool $unsuppress Remove restrictions on content upon restoration?
1942 * @return int|bool The number of file revisions restored if successful,
1943 * or false on failure
1945 * Overridden by LocalFile
1947 function restore( $versions = [], $unsuppress = false ) {
1948 $this->readOnlyError();
1952 * Returns 'true' if this file is a type which supports multiple pages,
1953 * e.g. DJVU or PDF. Note that this may be true even if the file in
1954 * question only has a single page.
1958 function isMultipage() {
1959 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1963 * Returns the number of pages of a multipage document, or false for
1964 * documents which aren't multipage documents
1966 * @return string|bool|int
1968 function pageCount() {
1969 if ( !isset( $this->pageCount
) ) {
1970 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1971 $this->pageCount
= $this->handler
->pageCount( $this );
1973 $this->pageCount
= false;
1977 return $this->pageCount
;
1981 * Calculate the height of a thumbnail using the source and destination width
1983 * @param int $srcWidth
1984 * @param int $srcHeight
1985 * @param int $dstWidth
1989 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1990 // Exact integer multiply followed by division
1991 if ( $srcWidth == 0 ) {
1994 return (int)round( $srcHeight * $dstWidth / $srcWidth );
1999 * Get an image size array like that returned by getImageSize(), or false if it
2000 * can't be determined. Loads the image size directly from the file ignoring caches.
2002 * @note Use getWidth()/getHeight() instead of this method unless you have a
2003 * a good reason. This method skips all caches.
2005 * @param string $filePath The path to the file (e.g. From getLocalPathRef() )
2006 * @return array|false The width, followed by height, with optionally more things after
2008 function getImageSize( $filePath ) {
2009 if ( !$this->getHandler() ) {
2013 return $this->getHandler()->getImageSize( $this, $filePath );
2017 * Get the URL of the image description page. May return false if it is
2018 * unknown or not applicable.
2022 function getDescriptionUrl() {
2023 if ( $this->repo
) {
2024 return $this->repo
->getDescriptionUrl( $this->getName() );
2031 * Get the HTML text of the description page, if available
2033 * @param bool|Language $lang Optional language to fetch description in
2034 * @return string|false
2036 function getDescriptionText( $lang = false ) {
2039 if ( !$this->repo ||
!$this->repo
->fetchDescription
) {
2043 $lang = $lang ?
: $wgLang;
2045 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
2047 $cache = ObjectCache
::getMainWANInstance();
2048 $key = $this->repo
->getLocalCacheKey(
2049 'RemoteFileDescription',
2055 return $cache->getWithSetCallback(
2057 $this->repo
->descriptionCacheExpiry ?
: $cache::TTL_UNCACHEABLE
,
2058 function ( $oldValue, &$ttl, array &$setOpts ) use ( $renderUrl ) {
2059 wfDebug( "Fetching shared description from $renderUrl\n" );
2060 $res = Http
::get( $renderUrl, [], __METHOD__
);
2062 $ttl = WANObjectCache
::TTL_UNCACHEABLE
;
2074 * Get description of file revision
2077 * @param int $audience One of:
2078 * File::FOR_PUBLIC to be displayed to all users
2079 * File::FOR_THIS_USER to be displayed to the given user
2080 * File::RAW get the description regardless of permissions
2081 * @param User $user User object to check for, only if FOR_THIS_USER is
2082 * passed to the $audience parameter
2085 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
2090 * Get the 14-character timestamp of the file upload
2092 * @return string|bool TS_MW timestamp or false on failure
2094 function getTimestamp() {
2095 $this->assertRepoDefined();
2097 return $this->repo
->getFileTimestamp( $this->getPath() );
2101 * Returns the timestamp (in TS_MW format) of the last change of the description page.
2102 * Returns false if the file does not have a description page, or retrieving the timestamp
2103 * would be expensive.
2105 * @return string|bool
2107 public function getDescriptionTouched() {
2112 * Get the SHA-1 base 36 hash of the file
2116 function getSha1() {
2117 $this->assertRepoDefined();
2119 return $this->repo
->getFileSha1( $this->getPath() );
2123 * Get the deletion archive key, "<sha1>.<ext>"
2125 * @return string|false
2127 function getStorageKey() {
2128 $hash = $this->getSha1();
2132 $ext = $this->getExtension();
2133 $dotExt = $ext === '' ?
'' : ".$ext";
2135 return $hash . $dotExt;
2139 * Determine if the current user is allowed to view a particular
2140 * field of this file, if it's marked as deleted.
2143 * @param User $user User object to check, or null to use $wgUser
2146 function userCan( $field, User
$user = null ) {
2151 * @deprecated since 1.30, use File::getContentHeaders instead
2153 function getStreamHeaders() {
2154 wfDeprecated( __METHOD__
, '1.30' );
2155 return $this->getContentHeaders();
2159 * @return array HTTP header name/value map to use for HEAD/GET request responses
2162 function getContentHeaders() {
2163 $handler = $this->getHandler();
2165 $metadata = $this->getMetadata();
2167 if ( is_string( $metadata ) ) {
2168 $metadata = MediaWiki\
quietCall( 'unserialize', $metadata );
2171 if ( !is_array( $metadata ) ) {
2175 return $handler->getContentHeaders( $metadata );
2184 function getLongDesc() {
2185 $handler = $this->getHandler();
2187 return $handler->getLongDesc( $this );
2189 return MediaHandler
::getGeneralLongDesc( $this );
2196 function getShortDesc() {
2197 $handler = $this->getHandler();
2199 return $handler->getShortDesc( $this );
2201 return MediaHandler
::getGeneralShortDesc( $this );
2208 function getDimensionsString() {
2209 $handler = $this->getHandler();
2211 return $handler->getDimensionsString( $this );
2220 function getRedirected() {
2221 return $this->redirected
;
2225 * @return Title|null
2227 function getRedirectedTitle() {
2228 if ( $this->redirected
) {
2229 if ( !$this->redirectTitle
) {
2230 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
2233 return $this->redirectTitle
;
2240 * @param string $from
2243 function redirectedFrom( $from ) {
2244 $this->redirected
= $from;
2250 function isMissing() {
2255 * Check if this file object is small and can be cached
2258 public function isCacheable() {
2263 * Assert that $this->repo is set to a valid FileRepo instance
2264 * @throws MWException
2266 protected function assertRepoDefined() {
2267 if ( !( $this->repo
instanceof $this->repoClass
) ) {
2268 throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2273 * Assert that $this->title is set to a Title
2274 * @throws MWException
2276 protected function assertTitleDefined() {
2277 if ( !( $this->title
instanceof Title
) ) {
2278 throw new MWException( "A Title object is not set for this File.\n" );
2283 * True if creating thumbnails from the file is large or otherwise resource-intensive.
2286 public function isExpensiveToThumbnail() {
2287 $handler = $this->getHandler();
2288 return $handler ?
$handler->isExpensiveToThumbnail( $this ) : false;
2292 * Whether the thumbnails created on the same server as this code is running.
2296 public function isTransformedLocally() {