3 * @defgroup FileAbstraction File abstraction
6 * Represents files in a repository.
10 * Base code for files.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup FileAbstraction
32 * Implements some public methods and some protected utility functions which
33 * are required by multiple child classes. Contains stub functionality for
34 * unimplemented public methods.
36 * Stub functions which should be overridden are marked with STUB. Some more
37 * concrete functions are also typically overridden by child classes.
39 * Note that only the repo object knows what its file class is called. You should
40 * never name a file class explictly outside of the repo class. Instead use the
41 * repo's factory functions to generate file objects, for example:
43 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
45 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
48 * @ingroup FileAbstraction
50 abstract class File
implements IDBAccessObject
{
51 // Bitfield values akin to the Revision deletion constants
52 const DELETED_FILE
= 1;
53 const DELETED_COMMENT
= 2;
54 const DELETED_USER
= 4;
55 const DELETED_RESTRICTED
= 8;
57 /** Force rendering in the current process */
60 * Force rendering even if thumbnail already exist and using RENDER_NOW
61 * I.e. you have to pass both flags: File::RENDER_NOW | File::RENDER_FORCE
63 const RENDER_FORCE
= 2;
65 const DELETE_SOURCE
= 1;
67 // Audience options for File::getDescription()
69 const FOR_THIS_USER
= 2;
72 // Options for File::thumbName()
73 const THUMB_FULL_NAME
= 1;
76 * Some member variables can be lazy-initialised using __get(). The
77 * initialisation function for these variables is always a function named
78 * like getVar(), where Var is the variable name with upper-case first
81 * The following variables are initialised in this way in this base class:
82 * name, extension, handler, path, canRender, isSafeFile,
83 * transformScript, hashPath, pageCount, url
85 * Code within this class should generally use the accessor function
86 * directly, since __get() isn't re-entrant and therefore causes bugs that
87 * depend on initialisation order.
91 * The following member variables are not lazy-initialised
94 /** @var FileRepo|LocalRepo|ForeignAPIRepo|bool */
97 /** @var Title|string|bool */
100 /** @var string Text of last error */
101 protected $lastError;
103 /** @var string Main part of the title, with underscores (Title::getDBkey) */
104 protected $redirected;
107 protected $redirectedTitle;
109 /** @var FSFile|bool False if undefined */
112 /** @var MediaHandler */
115 /** @var string The URL corresponding to one of the four basic zones */
118 /** @var string File extension */
119 protected $extension;
121 /** @var string The name of a file from its title object */
124 /** @var string The storage path corresponding to one of the zones */
127 /** @var string Relative path including trailing slash */
130 /** @var string Number of pages of a multipage document, or false for
131 * documents which aren't multipage documents
133 protected $pageCount;
135 /** @var string URL of transformscript (for example thumb.php) */
136 protected $transformScript;
139 protected $redirectTitle;
141 /** @var bool Whether the output of transform() for this file is likely to be valid. */
142 protected $canRender;
144 /** @var bool Whether this media file is in a format that is unlikely to
145 * contain viruses or malicious content
147 protected $isSafeFile;
149 /** @var string Required Repository class type */
150 protected $repoClass = 'FileRepo';
152 /** @var array Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width */
153 protected $tmpBucketedThumbCache = array();
156 * Call this constructor from child classes.
158 * Both $title and $repo are optional, though some functions
159 * may return false or throw exceptions if they are not set.
160 * Most subclasses will want to call assertRepoDefined() here.
162 * @param Title|string|bool $title
163 * @param FileRepo|bool $repo
165 function __construct( $title, $repo ) {
166 if ( $title !== false ) { // subclasses may not use MW titles
167 $title = self
::normalizeTitle( $title, 'exception' );
169 $this->title
= $title;
174 * Given a string or Title object return either a
175 * valid Title object with namespace NS_FILE or null
177 * @param Title|string $title
178 * @param string|bool $exception Use 'exception' to throw an error on bad titles
179 * @throws MWException
182 static function normalizeTitle( $title, $exception = false ) {
184 if ( $ret instanceof Title
) {
185 # Normalize NS_MEDIA -> NS_FILE
186 if ( $ret->getNamespace() == NS_MEDIA
) {
187 $ret = Title
::makeTitleSafe( NS_FILE
, $ret->getDBkey() );
188 # Sanity check the title namespace
189 } elseif ( $ret->getNamespace() !== NS_FILE
) {
193 # Convert strings to Title objects
194 $ret = Title
::makeTitleSafe( NS_FILE
, (string)$ret );
196 if ( !$ret && $exception !== false ) {
197 throw new MWException( "`$title` is not a valid file title." );
203 function __get( $name ) {
204 $function = array( $this, 'get' . ucfirst( $name ) );
205 if ( !is_callable( $function ) ) {
208 $this->$name = call_user_func( $function );
215 * Normalize a file extension to the common form, and ensure it's clean.
216 * Extensions with non-alphanumeric characters will be discarded.
218 * @param string $ext (without the .)
221 static function normalizeExtension( $ext ) {
222 $lower = strtolower( $ext );
229 if ( isset( $squish[$lower] ) ) {
230 return $squish[$lower];
231 } elseif ( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
239 * Checks if file extensions are compatible
241 * @param File $old Old file
242 * @param string $new New name
246 static function checkExtensionCompatibility( File
$old, $new ) {
247 $oldMime = $old->getMimeType();
248 $n = strrpos( $new, '.' );
249 $newExt = self
::normalizeExtension( $n ?
substr( $new, $n +
1 ) : '' );
250 $mimeMagic = MimeMagic
::singleton();
252 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
256 * Upgrade the database row if there is one
257 * Called by ImagePage
260 function upgradeRow() {
264 * Split an internet media type into its two components; if not
265 * a two-part name, set the minor type to 'unknown'.
267 * @param string $mime "text/html" etc
268 * @return array ("text", "html") etc
270 public static function splitMime( $mime ) {
271 if ( strpos( $mime, '/' ) !== false ) {
272 return explode( '/', $mime, 2 );
274 return array( $mime, 'unknown' );
279 * Callback for usort() to do file sorts by name
283 * @return int Result of name comparison
285 public static function compare( File
$a, File
$b ) {
286 return strcmp( $a->getName(), $b->getName() );
290 * Return the name of this file
294 public function getName() {
295 if ( !isset( $this->name
) ) {
296 $this->assertRepoDefined();
297 $this->name
= $this->repo
->getNameFromTitle( $this->title
);
304 * Get the file extension, e.g. "svg"
308 function getExtension() {
309 if ( !isset( $this->extension
) ) {
310 $n = strrpos( $this->getName(), '.' );
311 $this->extension
= self
::normalizeExtension(
312 $n ?
substr( $this->getName(), $n +
1 ) : '' );
315 return $this->extension
;
319 * Return the associated title object
323 public function getTitle() {
328 * Return the title used to find this file
332 public function getOriginalTitle() {
333 if ( $this->redirected
) {
334 return $this->getRedirectedTitle();
341 * Return the URL of the file
345 public function getUrl() {
346 if ( !isset( $this->url
) ) {
347 $this->assertRepoDefined();
348 $ext = $this->getExtension();
349 $this->url
= $this->repo
->getZoneUrl( 'public', $ext ) . '/' . $this->getUrlRel();
356 * Return a fully-qualified URL to the file.
357 * Upload URL paths _may or may not_ be fully qualified, so
358 * we check. Local paths are assumed to belong on $wgServer.
362 public function getFullUrl() {
363 return wfExpandUrl( $this->getUrl(), PROTO_RELATIVE
);
369 public function getCanonicalUrl() {
370 return wfExpandUrl( $this->getUrl(), PROTO_CANONICAL
);
376 function getViewURL() {
377 if ( $this->mustRender() ) {
378 if ( $this->canRender() ) {
379 return $this->createThumb( $this->getWidth() );
381 wfDebug( __METHOD__
. ': supposed to render ' . $this->getName() .
382 ' (' . $this->getMimeType() . "), but can't!\n" );
384 return $this->getURL(); #hm... return NULL?
387 return $this->getURL();
392 * Return the storage path to the file. Note that this does
393 * not mean that a file actually exists under that location.
395 * This path depends on whether directory hashing is active or not,
396 * i.e. whether the files are all found in the same directory,
397 * or in hashed paths like /images/3/3c.
399 * Most callers don't check the return value, but ForeignAPIFile::getPath
402 * @return string|bool ForeignAPIFile::getPath can return false
404 public function getPath() {
405 if ( !isset( $this->path
) ) {
406 $this->assertRepoDefined();
407 $this->path
= $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
414 * Get an FS copy or original of this file and return the path.
415 * Returns false on failure. Callers must not alter the file.
416 * Temporary files are cleared automatically.
418 * @return string|bool False on failure
420 public function getLocalRefPath() {
421 $this->assertRepoDefined();
422 if ( !isset( $this->fsFile
) ) {
423 $this->fsFile
= $this->repo
->getLocalReference( $this->getPath() );
424 if ( !$this->fsFile
) {
425 $this->fsFile
= false; // null => false; cache negative hits
429 return ( $this->fsFile
)
430 ?
$this->fsFile
->getPath()
435 * Return the width of the image. Returns false if the width is unknown
439 * Overridden by LocalFile, UnregisteredLocalFile
444 public function getWidth( $page = 1 ) {
449 * Return the height of the image. Returns false if the height is unknown
453 * Overridden by LocalFile, UnregisteredLocalFile
456 * @return bool|int False on failure
458 public function getHeight( $page = 1 ) {
463 * Return the smallest bucket from $wgThumbnailBuckets which is at least
464 * $wgThumbnailMinimumBucketDistance larger than $desiredWidth. The returned bucket, if any,
465 * will always be bigger than $desiredWidth.
467 * @param int $desiredWidth
471 public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
472 global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
474 $imageWidth = $this->getWidth( $page );
476 if ( $imageWidth === false ) {
480 if ( $desiredWidth > $imageWidth ) {
484 if ( !$wgThumbnailBuckets ) {
488 $sortedBuckets = $wgThumbnailBuckets;
490 sort( $sortedBuckets );
492 foreach ( $sortedBuckets as $bucket ) {
493 if ( $bucket >= $imageWidth ) {
497 if ( $bucket - $wgThumbnailMinimumBucketDistance > $desiredWidth ) {
502 // Image is bigger than any available bucket
507 * Returns ID or name of user who uploaded the file
510 * @param string $type 'text' or 'id'
513 public function getUser( $type = 'text' ) {
518 * Get the duration of a media file in seconds
522 public function getLength() {
523 $handler = $this->getHandler();
525 return $handler->getLength( $this );
532 * Return true if the file is vectorized
536 public function isVectorized() {
537 $handler = $this->getHandler();
539 return $handler->isVectorized( $this );
546 * Gives a (possibly empty) list of languages to render
549 * If the file doesn't have translations, or if the file
550 * format does not support that sort of thing, returns
556 public function getAvailableLanguages() {
557 $handler = $this->getHandler();
559 return $handler->getAvailableLanguages( $this );
566 * In files that support multiple language, what is the default language
567 * to use if none specified.
569 * @return string Lang code, or null if filetype doesn't support multiple languages.
572 public function getDefaultRenderLanguage() {
573 $handler = $this->getHandler();
575 return $handler->getDefaultRenderLanguage( $this );
582 * Will the thumbnail be animated if one would expect it to be.
584 * Currently used to add a warning to the image description page
586 * @return bool False if the main image is both animated
587 * and the thumbnail is not. In all other cases must return
588 * true. If image is not renderable whatsoever, should
591 public function canAnimateThumbIfAppropriate() {
592 $handler = $this->getHandler();
594 // We cannot handle image whatsoever, thus
595 // one would not expect it to be animated
599 if ( $this->allowInlineDisplay()
600 && $handler->isAnimatedImage( $this )
601 && !$handler->canAnimateThumbnail( $this )
603 // Image is animated, but thumbnail isn't.
604 // This is unexpected to the user.
607 // Image is not animated, so one would
608 // not expect thumb to be
615 * Get handler-specific metadata
616 * Overridden by LocalFile, UnregisteredLocalFile
620 public function getMetadata() {
625 * Like getMetadata but returns a handler independent array of common values.
626 * @see MediaHandler::getCommonMetaArray()
627 * @return array|bool Array or false if not supported
630 public function getCommonMetaArray() {
631 $handler = $this->getHandler();
637 return $handler->getCommonMetaArray( $this );
641 * get versioned metadata
643 * @param array|string $metadata Array or string of (serialized) metadata
644 * @param int $version Version number.
645 * @return array Array containing metadata, or what was passed to it on fail
646 * (unserializing if not array)
648 public function convertMetadataVersion( $metadata, $version ) {
649 $handler = $this->getHandler();
650 if ( !is_array( $metadata ) ) {
651 // Just to make the return type consistent
652 $metadata = unserialize( $metadata );
655 return $handler->convertMetadataVersion( $metadata, $version );
662 * Return the bit depth of the file
663 * Overridden by LocalFile
667 public function getBitDepth() {
672 * Return the size of the image file, in bytes
673 * Overridden by LocalFile, UnregisteredLocalFile
677 public function getSize() {
682 * Returns the MIME type of the file.
683 * Overridden by LocalFile, UnregisteredLocalFile
688 function getMimeType() {
689 return 'unknown/unknown';
693 * Return the type of the media in the file.
694 * Use the value returned by this function with the MEDIATYPE_xxx constants.
695 * Overridden by LocalFile,
699 function getMediaType() {
700 return MEDIATYPE_UNKNOWN
;
704 * Checks if the output of transform() for this file is likely
705 * to be valid. If this is false, various user elements will
706 * display a placeholder instead.
708 * Currently, this checks if the file is an image format
709 * that can be converted to a format
710 * supported by all browsers (namely GIF, PNG and JPEG),
711 * or if it is an SVG image and SVG conversion is enabled.
715 function canRender() {
716 if ( !isset( $this->canRender
) ) {
717 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this ) && $this->exists();
720 return $this->canRender
;
724 * Accessor for __get()
727 protected function getCanRender() {
728 return $this->canRender();
732 * Return true if the file is of a type that can't be directly
733 * rendered by typical browsers and needs to be re-rasterized.
735 * This returns true for everything but the bitmap types
736 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
737 * also return true for any non-image formats.
741 function mustRender() {
742 return $this->getHandler() && $this->handler
->mustRender( $this );
746 * Alias for canRender()
750 function allowInlineDisplay() {
751 return $this->canRender();
755 * Determines if this media file is in a format that is unlikely to
756 * contain viruses or malicious content. It uses the global
757 * $wgTrustedMediaFormats list to determine if the file is safe.
759 * This is used to show a warning on the description page of non-safe files.
760 * It may also be used to disallow direct [[media:...]] links to such files.
762 * Note that this function will always return true if allowInlineDisplay()
763 * or isTrustedFile() is true for this file.
767 function isSafeFile() {
768 if ( !isset( $this->isSafeFile
) ) {
769 $this->isSafeFile
= $this->getIsSafeFileUncached();
772 return $this->isSafeFile
;
776 * Accessor for __get()
780 protected function getIsSafeFile() {
781 return $this->isSafeFile();
789 protected function getIsSafeFileUncached() {
790 global $wgTrustedMediaFormats;
792 if ( $this->allowInlineDisplay() ) {
795 if ( $this->isTrustedFile() ) {
799 $type = $this->getMediaType();
800 $mime = $this->getMimeType();
801 #wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
803 if ( !$type ||
$type === MEDIATYPE_UNKNOWN
) {
804 return false; #unknown type, not trusted
806 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
810 if ( $mime === "unknown/unknown" ) {
811 return false; #unknown type, not trusted
813 if ( in_array( $mime, $wgTrustedMediaFormats ) ) {
821 * Returns true if the file is flagged as trusted. Files flagged that way
822 * can be linked to directly, even if that is not allowed for this type of
825 * This is a dummy function right now and always returns false. It could be
826 * implemented to extract a flag from the database. The trusted flag could be
827 * set on upload, if the user has sufficient privileges, to bypass script-
828 * and html-filters. It may even be coupled with cryptographics signatures
833 function isTrustedFile() {
834 #this could be implemented to check a flag in the database,
835 #look for signatures, etc
840 * Load any lazy-loaded file object fields from source
842 * This is only useful when setting $flags
844 * Overridden by LocalFile to actually query the DB
846 * @param integer $flags Bitfield of File::READ_* constants
848 public function load( $flags = 0 ) {
852 * Returns true if file exists in the repository.
854 * Overridden by LocalFile to avoid unnecessary stat calls.
856 * @return bool Whether file exists in the repository.
858 public function exists() {
859 return $this->getPath() && $this->repo
->fileExists( $this->path
);
863 * Returns true if file exists in the repository and can be included in a page.
864 * It would be unsafe to include private images, making public thumbnails inadvertently
866 * @return bool Whether file exists in the repository and is includable.
868 public function isVisible() {
869 return $this->exists();
875 function getTransformScript() {
876 if ( !isset( $this->transformScript
) ) {
877 $this->transformScript
= false;
879 $script = $this->repo
->getThumbScriptUrl();
881 $this->transformScript
= wfAppendQuery( $script, array( 'f' => $this->getName() ) );
886 return $this->transformScript
;
890 * Get a ThumbnailImage which is the same size as the source
892 * @param array $handlerParams
896 function getUnscaledThumb( $handlerParams = array() ) {
897 $hp =& $handlerParams;
898 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
899 $width = $this->getWidth( $page );
901 return $this->iconThumb();
903 $hp['width'] = $width;
904 // be sure to ignore any height specification as well (bug 62258)
905 unset( $hp['height'] );
907 return $this->transform( $hp );
911 * Return the file name of a thumbnail with the specified parameters.
912 * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
913 * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
915 * @param array $params Handler-specific parameters
916 * @param int $flags Bitfield that supports THUMB_* constants
919 public function thumbName( $params, $flags = 0 ) {
920 $name = ( $this->repo
&& !( $flags & self
::THUMB_FULL_NAME
) )
921 ?
$this->repo
->nameForThumb( $this->getName() )
924 return $this->generateThumbName( $name, $params );
928 * Generate a thumbnail file name from a name and specified parameters
930 * @param string $name
931 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
934 public function generateThumbName( $name, $params ) {
935 if ( !$this->getHandler() ) {
938 $extension = $this->getExtension();
939 list( $thumbExt, ) = $this->getHandler()->getThumbType(
940 $extension, $this->getMimeType(), $params );
941 $thumbName = $this->getHandler()->makeParamString( $params ) . '-' . $name;
942 if ( $thumbExt != $extension ) {
943 $thumbName .= ".$thumbExt";
950 * Create a thumbnail of the image having the specified width/height.
951 * The thumbnail will not be created if the width is larger than the
952 * image's width. Let the browser do the scaling in this case.
953 * The thumbnail is stored on disk and is only computed if the thumbnail
954 * file does not exist OR if it is older than the image.
957 * Keeps aspect ratio of original image. If both width and height are
958 * specified, the generated image will be no bigger than width x height,
959 * and will also have correct aspect ratio.
961 * @param int $width Maximum width of the generated thumbnail
962 * @param int $height Maximum height of the image (optional)
966 public function createThumb( $width, $height = -1 ) {
967 $params = array( 'width' => $width );
968 if ( $height != -1 ) {
969 $params['height'] = $height;
971 $thumb = $this->transform( $params );
972 if ( !$thumb ||
$thumb->isError() ) {
976 return $thumb->getUrl();
980 * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
982 * @param string $thumbPath Thumbnail storage path
983 * @param string $thumbUrl Thumbnail URL
984 * @param array $params
986 * @return MediaTransformOutput
988 protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
989 global $wgIgnoreImageErrors;
991 $handler = $this->getHandler();
992 if ( $handler && $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
993 return $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
995 return new MediaTransformError( 'thumbnail_error',
996 $params['width'], 0, wfMessage( 'thumbnail-dest-create' )->text() );
1001 * Transform a media file
1003 * @param array $params An associative array of handler-specific parameters.
1004 * Typical keys are width, height and page.
1005 * @param int $flags A bitfield, may contain self::RENDER_NOW to force rendering
1006 * @return MediaTransformOutput|bool False on failure
1008 function transform( $params, $flags = 0 ) {
1009 global $wgThumbnailEpoch;
1012 if ( !$this->canRender() ) {
1013 $thumb = $this->iconThumb();
1014 break; // not a bitmap or renderable image, don't try
1017 // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
1018 $descriptionUrl = $this->getDescriptionUrl();
1019 if ( $descriptionUrl ) {
1020 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL
);
1023 $handler = $this->getHandler();
1024 $script = $this->getTransformScript();
1025 if ( $script && !( $flags & self
::RENDER_NOW
) ) {
1026 // Use a script to transform on client request, if possible
1027 $thumb = $handler->getScriptedTransform( $this, $script, $params );
1033 $normalisedParams = $params;
1034 $handler->normaliseParams( $this, $normalisedParams );
1036 $thumbName = $this->thumbName( $normalisedParams );
1037 $thumbUrl = $this->getThumbUrl( $thumbName );
1038 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1040 if ( $this->repo
) {
1041 // Defer rendering if a 404 handler is set up...
1042 if ( $this->repo
->canTransformVia404() && !( $flags & self
::RENDER_NOW
) ) {
1043 wfDebug( __METHOD__
. " transformation deferred.\n" );
1044 // XXX: Pass in the storage path even though we are not rendering anything
1045 // and the path is supposed to be an FS path. This is due to getScalerType()
1046 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1047 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1050 // Check if an up-to-date thumbnail already exists...
1051 wfDebug( __METHOD__
. ": Doing stat for $thumbPath\n" );
1052 if ( !( $flags & self
::RENDER_FORCE
) && $this->repo
->fileExists( $thumbPath ) ) {
1053 $timestamp = $this->repo
->getFileTimestamp( $thumbPath );
1054 if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
1055 // XXX: Pass in the storage path even though we are not rendering anything
1056 // and the path is supposed to be an FS path. This is due to getScalerType()
1057 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1058 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1059 $thumb->setStoragePath( $thumbPath );
1062 } elseif ( $flags & self
::RENDER_FORCE
) {
1063 wfDebug( __METHOD__
. " forcing rendering per flag File::RENDER_FORCE\n" );
1066 // If the backend is ready-only, don't keep generating thumbnails
1067 // only to return transformation errors, just return the error now.
1068 if ( $this->repo
->getReadOnlyReason() !== false ) {
1069 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1074 $tmpFile = $this->makeTransformTmpFile( $thumbPath );
1077 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1079 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1083 return is_object( $thumb ) ?
$thumb : false;
1087 * Generates a thumbnail according to the given parameters and saves it to storage
1088 * @param TempFSFile $tmpFile Temporary file where the rendered thumbnail will be saved
1089 * @param array $transformParams
1091 * @return bool|MediaTransformOutput
1093 public function generateAndSaveThumb( $tmpFile, $transformParams, $flags ) {
1094 global $wgUseSquid, $wgIgnoreImageErrors;
1096 $handler = $this->getHandler();
1098 $normalisedParams = $transformParams;
1099 $handler->normaliseParams( $this, $normalisedParams );
1101 $thumbName = $this->thumbName( $normalisedParams );
1102 $thumbUrl = $this->getThumbUrl( $thumbName );
1103 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1105 $tmpThumbPath = $tmpFile->getPath();
1107 if ( $handler->supportsBucketing() ) {
1108 $this->generateBucketsIfNeeded( $normalisedParams, $flags );
1111 // Actually render the thumbnail...
1112 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1113 $tmpFile->bind( $thumb ); // keep alive with $thumb
1115 if ( !$thumb ) { // bad params?
1117 } elseif ( $thumb->isError() ) { // transform error
1118 $this->lastError
= $thumb->toText();
1119 // Ignore errors if requested
1120 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
1121 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1123 } elseif ( $this->repo
&& $thumb->hasFile() && !$thumb->fileIsSource() ) {
1124 // Copy the thumbnail from the file system into storage...
1125 $disposition = $this->getThumbDisposition( $thumbName );
1126 $status = $this->repo
->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1127 if ( $status->isOK() ) {
1128 $thumb->setStoragePath( $thumbPath );
1130 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $transformParams, $flags );
1132 // Give extensions a chance to do something with this thumbnail...
1133 Hooks
::run( 'FileTransformed', array( $this, $thumb, $tmpThumbPath, $thumbPath ) );
1136 // Purge. Useful in the event of Core -> Squid connection failure or squid
1137 // purge collisions from elsewhere during failure. Don't keep triggering for
1138 // "thumbs" which have the main image URL though (bug 13776)
1139 if ( $wgUseSquid ) {
1140 if ( !$thumb ||
$thumb->isError() ||
$thumb->getUrl() != $this->getURL() ) {
1141 SquidUpdate
::purge( array( $thumbUrl ) );
1149 * Generates chained bucketed thumbnails if needed
1150 * @param array $params
1152 * @return bool Whether at least one bucket was generated
1154 protected function generateBucketsIfNeeded( $params, $flags = 0 ) {
1156 ||
!isset( $params['physicalWidth'] )
1157 ||
!isset( $params['physicalHeight'] )
1158 ||
!( $bucket = $this->getThumbnailBucket( $params['physicalWidth'] ) )
1159 ||
$bucket == $params['physicalWidth'] ) {
1163 $bucketPath = $this->getBucketThumbPath( $bucket );
1165 if ( $this->repo
->fileExists( $bucketPath ) ) {
1169 $params['physicalWidth'] = $bucket;
1170 $params['width'] = $bucket;
1172 $params = $this->getHandler()->sanitizeParamsForBucketing( $params );
1174 $bucketName = $this->getBucketThumbName( $bucket );
1176 $tmpFile = $this->makeTransformTmpFile( $bucketPath );
1182 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1184 if ( !$thumb ||
$thumb->isError() ) {
1188 $this->tmpBucketedThumbCache
[$bucket] = $tmpFile->getPath();
1189 // For the caching to work, we need to make the tmp file survive as long as
1190 // this object exists
1191 $tmpFile->bind( $this );
1197 * Returns the most appropriate source image for the thumbnail, given a target thumbnail size
1198 * @param array $params
1199 * @return array Source path and width/height of the source
1201 public function getThumbnailSource( $params ) {
1203 && $this->getHandler()->supportsBucketing()
1204 && isset( $params['physicalWidth'] )
1205 && $bucket = $this->getThumbnailBucket( $params['physicalWidth'] )
1207 if ( $this->getWidth() != 0 ) {
1208 $bucketHeight = round( $this->getHeight() * ( $bucket / $this->getWidth() ) );
1213 // Try to avoid reading from storage if the file was generated by this script
1214 if ( isset( $this->tmpBucketedThumbCache
[$bucket] ) ) {
1215 $tmpPath = $this->tmpBucketedThumbCache
[$bucket];
1217 if ( file_exists( $tmpPath ) ) {
1221 'height' => $bucketHeight
1226 $bucketPath = $this->getBucketThumbPath( $bucket );
1228 if ( $this->repo
->fileExists( $bucketPath ) ) {
1229 $fsFile = $this->repo
->getLocalReference( $bucketPath );
1233 'path' => $fsFile->getPath(),
1235 'height' => $bucketHeight
1241 // Thumbnailing a very large file could result in network saturation if
1242 // everyone does it at once.
1243 if ( $this->getSize() >= 1e7
) { // 10MB
1245 $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $this->getName() ),
1247 'doWork' => function () use ( $that ) {
1248 return $that->getLocalRefPath();
1252 $srcPath = $work->execute();
1254 $srcPath = $this->getLocalRefPath();
1260 'width' => $this->getWidth(),
1261 'height' => $this->getHeight()
1266 * Returns the repo path of the thumb for a given bucket
1267 * @param int $bucket
1270 protected function getBucketThumbPath( $bucket ) {
1271 $thumbName = $this->getBucketThumbName( $bucket );
1272 return $this->getThumbPath( $thumbName );
1276 * Returns the name of the thumb for a given bucket
1277 * @param int $bucket
1280 protected function getBucketThumbName( $bucket ) {
1281 return $this->thumbName( array( 'physicalWidth' => $bucket ) );
1285 * Creates a temp FS file with the same extension and the thumbnail
1286 * @param string $thumbPath Thumbnail path
1287 * @return TempFSFile
1289 protected function makeTransformTmpFile( $thumbPath ) {
1290 $thumbExt = FileBackend
::extensionFromPath( $thumbPath );
1291 return TempFSFile
::factory( 'transform_', $thumbExt );
1295 * @param string $thumbName Thumbnail name
1296 * @param string $dispositionType Type of disposition (either "attachment" or "inline")
1297 * @return string Content-Disposition header value
1299 function getThumbDisposition( $thumbName, $dispositionType = 'inline' ) {
1300 $fileName = $this->name
; // file name to suggest
1301 $thumbExt = FileBackend
::extensionFromPath( $thumbName );
1302 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1303 $fileName .= ".$thumbExt";
1306 return FileBackend
::makeContentDisposition( $dispositionType, $fileName );
1310 * Hook into transform() to allow migration of thumbnail files
1312 * Overridden by LocalFile
1313 * @param string $thumbName
1315 function migrateThumbFile( $thumbName ) {
1319 * Get a MediaHandler instance for this file
1321 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1322 * or false if none found
1324 function getHandler() {
1325 if ( !isset( $this->handler
) ) {
1326 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
1329 return $this->handler
;
1333 * Get a ThumbnailImage representing a file type icon
1335 * @return ThumbnailImage
1337 function iconThumb() {
1338 global $wgResourceBasePath, $IP;
1339 $assetsPath = "$wgResourceBasePath/resources/assets/file-type-icons/";
1340 $assetsDirectory = "$IP/resources/assets/file-type-icons/";
1342 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
1343 foreach ( $try as $icon ) {
1344 if ( file_exists( $assetsDirectory . $icon ) ) { // always FS
1345 $params = array( 'width' => 120, 'height' => 120 );
1347 return new ThumbnailImage( $this, $assetsPath . $icon, false, $params );
1355 * Get last thumbnailing error.
1359 function getLastError() {
1360 return $this->lastError
;
1364 * Get all thumbnail names previously generated for this file
1366 * Overridden by LocalFile
1369 function getThumbnails() {
1374 * Purge shared caches such as thumbnails and DB data caching
1376 * Overridden by LocalFile
1377 * @param array $options Options, which include:
1378 * 'forThumbRefresh' : The purging is only to refresh thumbnails
1380 function purgeCache( $options = array() ) {
1384 * Purge the file description page, but don't go after
1385 * pages using the file. Use when modifying file history
1386 * but not the current data.
1388 function purgeDescription() {
1389 $title = $this->getTitle();
1391 $title->invalidateCache();
1392 $title->purgeSquid();
1397 * Purge metadata and all affected pages when the file is created,
1398 * deleted, or majorly updated.
1400 function purgeEverything() {
1401 // Delete thumbnails and refresh file metadata cache
1402 $this->purgeCache();
1403 $this->purgeDescription();
1405 // Purge cache of all pages using this file
1406 $title = $this->getTitle();
1408 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
1409 $update->doUpdate();
1414 * Return a fragment of the history of file.
1417 * @param int $limit Limit of rows to return
1418 * @param string $start Only revisions older than $start will be returned
1419 * @param string $end Only revisions newer than $end will be returned
1420 * @param bool $inc Include the endpoints of the time range
1424 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1429 * Return the history of this file, line by line. Starts with current version,
1430 * then old versions. Should return an object similar to an image/oldimage
1434 * Overridden in LocalFile
1437 public function nextHistoryLine() {
1442 * Reset the history pointer to the first element of the history.
1443 * Always call this function after using nextHistoryLine() to free db resources
1445 * Overridden in LocalFile.
1447 public function resetHistory() {
1451 * Get the filename hash component of the directory including trailing slash,
1453 * If the repository is not hashed, returns an empty string.
1457 function getHashPath() {
1458 if ( !isset( $this->hashPath
) ) {
1459 $this->assertRepoDefined();
1460 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
1463 return $this->hashPath
;
1467 * Get the path of the file relative to the public zone root.
1468 * This function is overridden in OldLocalFile to be like getArchiveRel().
1473 return $this->getHashPath() . $this->getName();
1477 * Get the path of an archived file relative to the public zone root
1479 * @param bool|string $suffix If not false, the name of an archived thumbnail file
1483 function getArchiveRel( $suffix = false ) {
1484 $path = 'archive/' . $this->getHashPath();
1485 if ( $suffix === false ) {
1486 $path = substr( $path, 0, -1 );
1495 * Get the path, relative to the thumbnail zone root, of the
1496 * thumbnail directory or a particular file if $suffix is specified
1498 * @param bool|string $suffix If not false, the name of a thumbnail file
1501 function getThumbRel( $suffix = false ) {
1502 $path = $this->getRel();
1503 if ( $suffix !== false ) {
1504 $path .= '/' . $suffix;
1511 * Get urlencoded path of the file relative to the public zone root.
1512 * This function is overridden in OldLocalFile to be like getArchiveUrl().
1516 function getUrlRel() {
1517 return $this->getHashPath() . rawurlencode( $this->getName() );
1521 * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1522 * or a specific thumb if the $suffix is given.
1524 * @param string $archiveName The timestamped name of an archived image
1525 * @param bool|string $suffix If not false, the name of a thumbnail file
1528 function getArchiveThumbRel( $archiveName, $suffix = false ) {
1529 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1530 if ( $suffix === false ) {
1531 $path = substr( $path, 0, -1 );
1540 * Get the path of the archived file.
1542 * @param bool|string $suffix If not false, the name of an archived file.
1545 function getArchivePath( $suffix = false ) {
1546 $this->assertRepoDefined();
1548 return $this->repo
->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1552 * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1554 * @param string $archiveName The timestamped name of an archived image
1555 * @param bool|string $suffix If not false, the name of a thumbnail file
1558 function getArchiveThumbPath( $archiveName, $suffix = false ) {
1559 $this->assertRepoDefined();
1561 return $this->repo
->getZonePath( 'thumb' ) . '/' .
1562 $this->getArchiveThumbRel( $archiveName, $suffix );
1566 * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1568 * @param bool|string $suffix If not false, the name of a thumbnail file
1571 function getThumbPath( $suffix = false ) {
1572 $this->assertRepoDefined();
1574 return $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1578 * Get the path of the transcoded directory, or a particular file if $suffix is specified
1580 * @param bool|string $suffix If not false, the name of a media file
1583 function getTranscodedPath( $suffix = false ) {
1584 $this->assertRepoDefined();
1586 return $this->repo
->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1590 * Get the URL of the archive directory, or a particular file if $suffix is specified
1592 * @param bool|string $suffix If not false, the name of an archived file
1595 function getArchiveUrl( $suffix = false ) {
1596 $this->assertRepoDefined();
1597 $ext = $this->getExtension();
1598 $path = $this->repo
->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1599 if ( $suffix === false ) {
1600 $path = substr( $path, 0, -1 );
1602 $path .= rawurlencode( $suffix );
1609 * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1611 * @param string $archiveName The timestamped name of an archived image
1612 * @param bool|string $suffix If not false, the name of a thumbnail file
1615 function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1616 $this->assertRepoDefined();
1617 $ext = $this->getExtension();
1618 $path = $this->repo
->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1619 $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1620 if ( $suffix === false ) {
1621 $path = substr( $path, 0, -1 );
1623 $path .= rawurlencode( $suffix );
1630 * Get the URL of the zone directory, or a particular file if $suffix is specified
1632 * @param string $zone Name of requested zone
1633 * @param bool|string $suffix If not false, the name of a file in zone
1634 * @return string Path
1636 function getZoneUrl( $zone, $suffix = false ) {
1637 $this->assertRepoDefined();
1638 $ext = $this->getExtension();
1639 $path = $this->repo
->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1640 if ( $suffix !== false ) {
1641 $path .= '/' . rawurlencode( $suffix );
1648 * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1650 * @param bool|string $suffix If not false, the name of a thumbnail file
1651 * @return string Path
1653 function getThumbUrl( $suffix = false ) {
1654 return $this->getZoneUrl( 'thumb', $suffix );
1658 * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1660 * @param bool|string $suffix If not false, the name of a media file
1661 * @return string Path
1663 function getTranscodedUrl( $suffix = false ) {
1664 return $this->getZoneUrl( 'transcoded', $suffix );
1668 * Get the public zone virtual URL for a current version source file
1670 * @param bool|string $suffix If not false, the name of a thumbnail file
1673 function getVirtualUrl( $suffix = false ) {
1674 $this->assertRepoDefined();
1675 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
1676 if ( $suffix !== false ) {
1677 $path .= '/' . rawurlencode( $suffix );
1684 * Get the public zone virtual URL for an archived version source file
1686 * @param bool|string $suffix If not false, the name of a thumbnail file
1689 function getArchiveVirtualUrl( $suffix = false ) {
1690 $this->assertRepoDefined();
1691 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1692 if ( $suffix === false ) {
1693 $path = substr( $path, 0, -1 );
1695 $path .= rawurlencode( $suffix );
1702 * Get the virtual URL for a thumbnail file or directory
1704 * @param bool|string $suffix If not false, the name of a thumbnail file
1707 function getThumbVirtualUrl( $suffix = false ) {
1708 $this->assertRepoDefined();
1709 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1710 if ( $suffix !== false ) {
1711 $path .= '/' . rawurlencode( $suffix );
1720 function isHashed() {
1721 $this->assertRepoDefined();
1723 return (bool)$this->repo
->getHashLevels();
1727 * @throws MWException
1729 function readOnlyError() {
1730 throw new MWException( get_class( $this ) . ': write operations are not supported' );
1734 * Record a file upload in the upload log and the image table
1736 * Overridden by LocalFile
1737 * @param string $oldver
1738 * @param string $desc
1739 * @param string $license
1740 * @param string $copyStatus
1741 * @param string $source
1742 * @param bool $watch
1743 * @param string|bool $timestamp
1744 * @param null|User $user User object or null to use $wgUser
1746 * @throws MWException
1748 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1749 $watch = false, $timestamp = false, User
$user = null
1751 $this->readOnlyError();
1755 * Move or copy a file to its public location. If a file exists at the
1756 * destination, move it to an archive. Returns a FileRepoStatus object with
1757 * the archive name in the "value" member on success.
1759 * The archive name should be passed through to recordUpload for database
1762 * Options to $options include:
1763 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1765 * @param string $srcPath Local filesystem path to the source image
1766 * @param int $flags A bitwise combination of:
1767 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1768 * @param array $options Optional additional parameters
1769 * @return FileRepoStatus On success, the value member contains the
1770 * archive name, or an empty string if it was a new file.
1773 * Overridden by LocalFile
1775 function publish( $srcPath, $flags = 0, array $options = array() ) {
1776 $this->readOnlyError();
1782 function formatMetadata() {
1783 if ( !$this->getHandler() ) {
1787 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
1791 * Returns true if the file comes from the local file repository.
1795 function isLocal() {
1796 return $this->repo
&& $this->repo
->isLocal();
1800 * Returns the name of the repository.
1804 function getRepoName() {
1805 return $this->repo ?
$this->repo
->getName() : 'unknown';
1809 * Returns the repository
1811 * @return FileRepo|LocalRepo|bool
1813 function getRepo() {
1818 * Returns true if the image is an old version
1828 * Is this file a "deleted" file in a private archive?
1831 * @param int $field One of DELETED_* bitfield constants
1834 function isDeleted( $field ) {
1839 * Return the deletion bitfield
1843 function getVisibility() {
1848 * Was this file ever deleted from the wiki?
1852 function wasDeleted() {
1853 $title = $this->getTitle();
1855 return $title && $title->isDeletedQuick();
1859 * Move file to the new title
1861 * Move current, old version and all thumbnails
1862 * to the new filename. Old file is deleted.
1864 * Cache purging is done; checks for validity
1865 * and logging are caller's responsibility
1867 * @param Title $target New file name
1868 * @return FileRepoStatus
1870 function move( $target ) {
1871 $this->readOnlyError();
1875 * Delete all versions of the file.
1877 * Moves the files into an archive directory (or deletes them)
1878 * and removes the database rows.
1880 * Cache purging is done; logging is caller's responsibility.
1882 * @param string $reason
1883 * @param bool $suppress Hide content from sysops?
1884 * @param User|null $user
1885 * @return bool Boolean on success, false on some kind of failure
1887 * Overridden by LocalFile
1889 function delete( $reason, $suppress = false, $user = null ) {
1890 $this->readOnlyError();
1894 * Restore all or specified deleted revisions to the given file.
1895 * Permissions and logging are left to the caller.
1897 * May throw database exceptions on error.
1899 * @param array $versions Set of record ids of deleted items to restore,
1900 * or empty to restore all revisions.
1901 * @param bool $unsuppress Remove restrictions on content upon restoration?
1902 * @return int|bool The number of file revisions restored if successful,
1903 * or false on failure
1905 * Overridden by LocalFile
1907 function restore( $versions = array(), $unsuppress = false ) {
1908 $this->readOnlyError();
1912 * Returns 'true' if this file is a type which supports multiple pages,
1913 * e.g. DJVU or PDF. Note that this may be true even if the file in
1914 * question only has a single page.
1918 function isMultipage() {
1919 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1923 * Returns the number of pages of a multipage document, or false for
1924 * documents which aren't multipage documents
1928 function pageCount() {
1929 if ( !isset( $this->pageCount
) ) {
1930 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1931 $this->pageCount
= $this->handler
->pageCount( $this );
1933 $this->pageCount
= false;
1937 return $this->pageCount
;
1941 * Calculate the height of a thumbnail using the source and destination width
1943 * @param int $srcWidth
1944 * @param int $srcHeight
1945 * @param int $dstWidth
1949 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1950 // Exact integer multiply followed by division
1951 if ( $srcWidth == 0 ) {
1954 return round( $srcHeight * $dstWidth / $srcWidth );
1959 * Get an image size array like that returned by getImageSize(), or false if it
1960 * can't be determined. Loads the image size directly from the file ignoring caches.
1962 * @note Use getWidth()/getHeight() instead of this method unless you have a
1963 * a good reason. This method skips all caches.
1965 * @param string $filePath The path to the file (e.g. From getLocalPathRef() )
1966 * @return array The width, followed by height, with optionally more things after
1968 function getImageSize( $filePath ) {
1969 if ( !$this->getHandler() ) {
1973 return $this->getHandler()->getImageSize( $this, $filePath );
1977 * Get the URL of the image description page. May return false if it is
1978 * unknown or not applicable.
1982 function getDescriptionUrl() {
1983 if ( $this->repo
) {
1984 return $this->repo
->getDescriptionUrl( $this->getName() );
1991 * Get the HTML text of the description page, if available
1993 * @param bool|Language $lang Optional language to fetch description in
1996 function getDescriptionText( $lang = false ) {
1997 global $wgMemc, $wgLang;
1998 if ( !$this->repo ||
!$this->repo
->fetchDescription
) {
2004 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
2006 if ( $this->repo
->descriptionCacheExpiry
> 0 ) {
2007 wfDebug( "Attempting to get the description from cache..." );
2008 $key = $this->repo
->getLocalCacheKey(
2009 'RemoteFileDescription',
2014 $obj = $wgMemc->get( $key );
2016 wfDebug( "success!\n" );
2020 wfDebug( "miss\n" );
2022 wfDebug( "Fetching shared description from $renderUrl\n" );
2023 $res = Http
::get( $renderUrl, array(), __METHOD__
);
2024 if ( $res && $this->repo
->descriptionCacheExpiry
> 0 ) {
2025 $wgMemc->set( $key, $res, $this->repo
->descriptionCacheExpiry
);
2035 * Get description of file revision
2038 * @param int $audience One of:
2039 * File::FOR_PUBLIC to be displayed to all users
2040 * File::FOR_THIS_USER to be displayed to the given user
2041 * File::RAW get the description regardless of permissions
2042 * @param User $user User object to check for, only if FOR_THIS_USER is
2043 * passed to the $audience parameter
2046 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
2051 * Get the 14-character timestamp of the file upload
2053 * @return string|bool TS_MW timestamp or false on failure
2055 function getTimestamp() {
2056 $this->assertRepoDefined();
2058 return $this->repo
->getFileTimestamp( $this->getPath() );
2062 * Returns the timestamp (in TS_MW format) of the last change of the description page.
2063 * Returns false if the file does not have a description page, or retrieving the timestamp
2064 * would be expensive.
2066 * @return string|bool
2068 public function getDescriptionTouched() {
2073 * Get the SHA-1 base 36 hash of the file
2077 function getSha1() {
2078 $this->assertRepoDefined();
2080 return $this->repo
->getFileSha1( $this->getPath() );
2084 * Get the deletion archive key, "<sha1>.<ext>"
2088 function getStorageKey() {
2089 $hash = $this->getSha1();
2093 $ext = $this->getExtension();
2094 $dotExt = $ext === '' ?
'' : ".$ext";
2096 return $hash . $dotExt;
2100 * Determine if the current user is allowed to view a particular
2101 * field of this file, if it's marked as deleted.
2104 * @param User $user User object to check, or null to use $wgUser
2107 function userCan( $field, User
$user = null ) {
2112 * @return array HTTP header name/value map to use for HEAD/GET request responses
2114 function getStreamHeaders() {
2115 $handler = $this->getHandler();
2117 return $handler->getStreamHeaders( $this->getMetadata() );
2126 function getLongDesc() {
2127 $handler = $this->getHandler();
2129 return $handler->getLongDesc( $this );
2131 return MediaHandler
::getGeneralLongDesc( $this );
2138 function getShortDesc() {
2139 $handler = $this->getHandler();
2141 return $handler->getShortDesc( $this );
2143 return MediaHandler
::getGeneralShortDesc( $this );
2150 function getDimensionsString() {
2151 $handler = $this->getHandler();
2153 return $handler->getDimensionsString( $this );
2162 function getRedirected() {
2163 return $this->redirected
;
2167 * @return Title|null
2169 function getRedirectedTitle() {
2170 if ( $this->redirected
) {
2171 if ( !$this->redirectTitle
) {
2172 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
2175 return $this->redirectTitle
;
2182 * @param string $from
2185 function redirectedFrom( $from ) {
2186 $this->redirected
= $from;
2192 function isMissing() {
2197 * Check if this file object is small and can be cached
2200 public function isCacheable() {
2205 * Assert that $this->repo is set to a valid FileRepo instance
2206 * @throws MWException
2208 protected function assertRepoDefined() {
2209 if ( !( $this->repo
instanceof $this->repoClass
) ) {
2210 throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2215 * Assert that $this->title is set to a Title
2216 * @throws MWException
2218 protected function assertTitleDefined() {
2219 if ( !( $this->title
instanceof Title
) ) {
2220 throw new MWException( "A Title object is not set for this File.\n" );
2225 * True if creating thumbnails from the file is large or otherwise resource-intensive.
2228 public function isExpensiveToThumbnail() {
2229 $handler = $this->getHandler();
2230 return $handler ?
$handler->isExpensiveToThumbnail( $this ) : false;