3 * @defgroup FileAbstraction File abstraction
6 * Represents files in a repository.
10 * Base code for files.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup FileAbstraction
32 * Implements some public methods and some protected utility functions which
33 * are required by multiple child classes. Contains stub functionality for
34 * unimplemented public methods.
36 * Stub functions which should be overridden are marked with STUB. Some more
37 * concrete functions are also typically overridden by child classes.
39 * Note that only the repo object knows what its file class is called. You should
40 * never name a file class explictly outside of the repo class. Instead use the
41 * repo's factory functions to generate file objects, for example:
43 * RepoGroup::singleton()->getLocalRepo()->newFile($title);
45 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
48 * @ingroup FileAbstraction
51 const DELETED_FILE
= 1;
52 const DELETED_COMMENT
= 2;
53 const DELETED_USER
= 4;
54 const DELETED_RESTRICTED
= 8;
56 /** Force rendering in the current process */
59 * Force rendering even if thumbnail already exist and using RENDER_NOW
60 * I.e. you have to pass both flags: File::RENDER_NOW | File::RENDER_FORCE
62 const RENDER_FORCE
= 2;
64 const DELETE_SOURCE
= 1;
66 // Audience options for File::getDescription()
68 const FOR_THIS_USER
= 2;
71 // Options for File::thumbName()
72 const THUMB_FULL_NAME
= 1;
75 * Some member variables can be lazy-initialised using __get(). The
76 * initialisation function for these variables is always a function named
77 * like getVar(), where Var is the variable name with upper-case first
80 * The following variables are initialised in this way in this base class:
81 * name, extension, handler, path, canRender, isSafeFile,
82 * transformScript, hashPath, pageCount, url
84 * Code within this class should generally use the accessor function
85 * directly, since __get() isn't re-entrant and therefore causes bugs that
86 * depend on initialisation order.
90 * The following member variables are not lazy-initialised
103 var $lastError, $redirected, $redirectedTitle;
106 * @var FSFile|bool False if undefined
118 protected $url, $extension, $name, $path, $hashPath, $pageCount, $transformScript;
120 protected $redirectTitle;
125 protected $canRender, $isSafeFile;
128 * @var string Required Repository class type
130 protected $repoClass = 'FileRepo';
133 * Call this constructor from child classes.
135 * Both $title and $repo are optional, though some functions
136 * may return false or throw exceptions if they are not set.
137 * Most subclasses will want to call assertRepoDefined() here.
139 * @param $title Title|string|bool
140 * @param $repo FileRepo|bool
142 function __construct( $title, $repo ) {
143 if ( $title !== false ) { // subclasses may not use MW titles
144 $title = self
::normalizeTitle( $title, 'exception' );
146 $this->title
= $title;
151 * Given a string or Title object return either a
152 * valid Title object with namespace NS_FILE or null
154 * @param $title Title|string
155 * @param $exception string|bool Use 'exception' to throw an error on bad titles
156 * @throws MWException
159 static function normalizeTitle( $title, $exception = false ) {
161 if ( $ret instanceof Title
) {
162 # Normalize NS_MEDIA -> NS_FILE
163 if ( $ret->getNamespace() == NS_MEDIA
) {
164 $ret = Title
::makeTitleSafe( NS_FILE
, $ret->getDBkey() );
165 # Sanity check the title namespace
166 } elseif ( $ret->getNamespace() !== NS_FILE
) {
170 # Convert strings to Title objects
171 $ret = Title
::makeTitleSafe( NS_FILE
, (string)$ret );
173 if ( !$ret && $exception !== false ) {
174 throw new MWException( "`$title` is not a valid file title." );
179 function __get( $name ) {
180 $function = array( $this, 'get' . ucfirst( $name ) );
181 if ( !is_callable( $function ) ) {
184 $this->$name = call_user_func( $function );
190 * Normalize a file extension to the common form, and ensure it's clean.
191 * Extensions with non-alphanumeric characters will be discarded.
193 * @param $ext string (without the .)
196 static function normalizeExtension( $ext ) {
197 $lower = strtolower( $ext );
204 if( isset( $squish[$lower] ) ) {
205 return $squish[$lower];
206 } elseif( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
214 * Checks if file extensions are compatible
216 * @param $old File Old file
217 * @param $new string New name
221 static function checkExtensionCompatibility( File
$old, $new ) {
222 $oldMime = $old->getMimeType();
223 $n = strrpos( $new, '.' );
224 $newExt = self
::normalizeExtension( $n ?
substr( $new, $n +
1 ) : '' );
225 $mimeMagic = MimeMagic
::singleton();
226 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
230 * Upgrade the database row if there is one
231 * Called by ImagePage
234 function upgradeRow() {}
237 * Split an internet media type into its two components; if not
238 * a two-part name, set the minor type to 'unknown'.
240 * @param string $mime "text/html" etc
241 * @return array ("text", "html") etc
243 public static function splitMime( $mime ) {
244 if( strpos( $mime, '/' ) !== false ) {
245 return explode( '/', $mime, 2 );
247 return array( $mime, 'unknown' );
252 * Callback for usort() to do file sorts by name
257 * @return Integer: result of name comparison
259 public static function compare( File
$a, File
$b ) {
260 return strcmp( $a->getName(), $b->getName() );
264 * Return the name of this file
268 public function getName() {
269 if ( !isset( $this->name
) ) {
270 $this->assertRepoDefined();
271 $this->name
= $this->repo
->getNameFromTitle( $this->title
);
277 * Get the file extension, e.g. "svg"
281 function getExtension() {
282 if ( !isset( $this->extension
) ) {
283 $n = strrpos( $this->getName(), '.' );
284 $this->extension
= self
::normalizeExtension(
285 $n ?
substr( $this->getName(), $n +
1 ) : '' );
287 return $this->extension
;
291 * Return the associated title object
295 public function getTitle() {
300 * Return the title used to find this file
304 public function getOriginalTitle() {
305 if ( $this->redirected
) {
306 return $this->getRedirectedTitle();
312 * Return the URL of the file
316 public function getUrl() {
317 if ( !isset( $this->url
) ) {
318 $this->assertRepoDefined();
319 $this->url
= $this->repo
->getZoneUrl( 'public' ) . '/' . $this->getUrlRel();
325 * Return a fully-qualified URL to the file.
326 * Upload URL paths _may or may not_ be fully qualified, so
327 * we check. Local paths are assumed to belong on $wgServer.
331 public function getFullUrl() {
332 return wfExpandUrl( $this->getUrl(), PROTO_RELATIVE
);
338 public function getCanonicalUrl() {
339 return wfExpandUrl( $this->getUrl(), PROTO_CANONICAL
);
345 function getViewURL() {
346 if ( $this->mustRender() ) {
347 if ( $this->canRender() ) {
348 return $this->createThumb( $this->getWidth() );
350 wfDebug( __METHOD__
.': supposed to render ' . $this->getName() .
351 ' (' . $this->getMimeType() . "), but can't!\n" );
352 return $this->getURL(); #hm... return NULL?
355 return $this->getURL();
360 * Return the storage path to the file. Note that this does
361 * not mean that a file actually exists under that location.
363 * This path depends on whether directory hashing is active or not,
364 * i.e. whether the files are all found in the same directory,
365 * or in hashed paths like /images/3/3c.
367 * Most callers don't check the return value, but ForeignAPIFile::getPath
370 * @return string|bool ForeignAPIFile::getPath can return false
372 public function getPath() {
373 if ( !isset( $this->path
) ) {
374 $this->assertRepoDefined();
375 $this->path
= $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
381 * Get an FS copy or original of this file and return the path.
382 * Returns false on failure. Callers must not alter the file.
383 * Temporary files are cleared automatically.
385 * @return string|bool False on failure
387 public function getLocalRefPath() {
388 $this->assertRepoDefined();
389 if ( !isset( $this->fsFile
) ) {
390 $this->fsFile
= $this->repo
->getLocalReference( $this->getPath() );
391 if ( !$this->fsFile
) {
392 $this->fsFile
= false; // null => false; cache negative hits
395 return ( $this->fsFile
)
396 ?
$this->fsFile
->getPath()
401 * Return the width of the image. Returns false if the width is unknown
405 * Overridden by LocalFile, UnregisteredLocalFile
411 public function getWidth( $page = 1 ) {
416 * Return the height of the image. Returns false if the height is unknown
420 * Overridden by LocalFile, UnregisteredLocalFile
424 * @return bool|number False on failure
426 public function getHeight( $page = 1 ) {
431 * Returns ID or name of user who uploaded the file
434 * @param $type string 'text' or 'id'
438 public function getUser( $type = 'text' ) {
443 * Get the duration of a media file in seconds
447 public function getLength() {
448 $handler = $this->getHandler();
450 return $handler->getLength( $this );
457 * Return true if the file is vectorized
461 public function isVectorized() {
462 $handler = $this->getHandler();
464 return $handler->isVectorized( $this );
471 * Will the thumbnail be animated if one would expect it to be.
473 * Currently used to add a warning to the image description page
475 * @return bool false if the main image is both animated
476 * and the thumbnail is not. In all other cases must return
477 * true. If image is not renderable whatsoever, should
480 public function canAnimateThumbIfAppropriate() {
481 $handler = $this->getHandler();
483 // We cannot handle image whatsoever, thus
484 // one would not expect it to be animated
488 if ( $this->allowInlineDisplay()
489 && $handler->isAnimatedImage( $this )
490 && !$handler->canAnimateThumbnail( $this )
492 // Image is animated, but thumbnail isn't.
493 // This is unexpected to the user.
496 // Image is not animated, so one would
497 // not expect thumb to be
504 * Get handler-specific metadata
505 * Overridden by LocalFile, UnregisteredLocalFile
509 public function getMetadata() {
514 * get versioned metadata
516 * @param $metadata Mixed Array or String of (serialized) metadata
517 * @param $version integer version number.
518 * @return Array containing metadata, or what was passed to it on fail (unserializing if not array)
520 public function convertMetadataVersion($metadata, $version) {
521 $handler = $this->getHandler();
522 if ( !is_array( $metadata ) ) {
523 // Just to make the return type consistent
524 $metadata = unserialize( $metadata );
527 return $handler->convertMetadataVersion( $metadata, $version );
534 * Return the bit depth of the file
535 * Overridden by LocalFile
539 public function getBitDepth() {
544 * Return the size of the image file, in bytes
545 * Overridden by LocalFile, UnregisteredLocalFile
549 public function getSize() {
554 * Returns the mime type of the file.
555 * Overridden by LocalFile, UnregisteredLocalFile
560 function getMimeType() {
561 return 'unknown/unknown';
565 * Return the type of the media in the file.
566 * Use the value returned by this function with the MEDIATYPE_xxx constants.
567 * Overridden by LocalFile,
571 function getMediaType() {
572 return MEDIATYPE_UNKNOWN
;
576 * Checks if the output of transform() for this file is likely
577 * to be valid. If this is false, various user elements will
578 * display a placeholder instead.
580 * Currently, this checks if the file is an image format
581 * that can be converted to a format
582 * supported by all browsers (namely GIF, PNG and JPEG),
583 * or if it is an SVG image and SVG conversion is enabled.
587 function canRender() {
588 if ( !isset( $this->canRender
) ) {
589 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this );
591 return $this->canRender
;
595 * Accessor for __get()
598 protected function getCanRender() {
599 return $this->canRender();
603 * Return true if the file is of a type that can't be directly
604 * rendered by typical browsers and needs to be re-rasterized.
606 * This returns true for everything but the bitmap types
607 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
608 * also return true for any non-image formats.
612 function mustRender() {
613 return $this->getHandler() && $this->handler
->mustRender( $this );
617 * Alias for canRender()
621 function allowInlineDisplay() {
622 return $this->canRender();
626 * Determines if this media file is in a format that is unlikely to
627 * contain viruses or malicious content. It uses the global
628 * $wgTrustedMediaFormats list to determine if the file is safe.
630 * This is used to show a warning on the description page of non-safe files.
631 * It may also be used to disallow direct [[media:...]] links to such files.
633 * Note that this function will always return true if allowInlineDisplay()
634 * or isTrustedFile() is true for this file.
638 function isSafeFile() {
639 if ( !isset( $this->isSafeFile
) ) {
640 $this->isSafeFile
= $this->_getIsSafeFile();
642 return $this->isSafeFile
;
646 * Accessor for __get()
650 protected function getIsSafeFile() {
651 return $this->isSafeFile();
659 protected function _getIsSafeFile() {
660 global $wgTrustedMediaFormats;
662 if ( $this->allowInlineDisplay() ) {
665 if ($this->isTrustedFile()) {
669 $type = $this->getMediaType();
670 $mime = $this->getMimeType();
671 #wfDebug("LocalFile::isSafeFile: type= $type, mime= $mime\n");
673 if ( !$type ||
$type === MEDIATYPE_UNKNOWN
) {
674 return false; #unknown type, not trusted
676 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
680 if ( $mime === "unknown/unknown" ) {
681 return false; #unknown type, not trusted
683 if ( in_array( $mime, $wgTrustedMediaFormats) ) {
691 * Returns true if the file is flagged as trusted. Files flagged that way
692 * can be linked to directly, even if that is not allowed for this type of
695 * This is a dummy function right now and always returns false. It could be
696 * implemented to extract a flag from the database. The trusted flag could be
697 * set on upload, if the user has sufficient privileges, to bypass script-
698 * and html-filters. It may even be coupled with cryptographics signatures
703 function isTrustedFile() {
704 #this could be implemented to check a flag in the database,
705 #look for signatures, etc
710 * Returns true if file exists in the repository.
712 * Overridden by LocalFile to avoid unnecessary stat calls.
714 * @return boolean Whether file exists in the repository.
716 public function exists() {
717 return $this->getPath() && $this->repo
->fileExists( $this->path
);
721 * Returns true if file exists in the repository and can be included in a page.
722 * It would be unsafe to include private images, making public thumbnails inadvertently
724 * @return boolean Whether file exists in the repository and is includable.
726 public function isVisible() {
727 return $this->exists();
733 function getTransformScript() {
734 if ( !isset( $this->transformScript
) ) {
735 $this->transformScript
= false;
737 $script = $this->repo
->getThumbScriptUrl();
739 $this->transformScript
= "$script?f=" . urlencode( $this->getName() );
743 return $this->transformScript
;
747 * Get a ThumbnailImage which is the same size as the source
749 * @param $handlerParams array
753 function getUnscaledThumb( $handlerParams = array() ) {
754 $hp =& $handlerParams;
755 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
756 $width = $this->getWidth( $page );
758 return $this->iconThumb();
760 $hp['width'] = $width;
761 return $this->transform( $hp );
765 * Return the file name of a thumbnail with the specified parameters.
766 * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
767 * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
769 * @param $params Array: handler-specific parameters
770 * @param $flags integer Bitfield that supports THUMB_* constants
773 public function thumbName( $params, $flags = 0 ) {
774 $name = ( $this->repo
&& !( $flags & self
::THUMB_FULL_NAME
) )
775 ?
$this->repo
->nameForThumb( $this->getName() )
777 return $this->generateThumbName( $name, $params );
781 * Generate a thumbnail file name from a name and specified parameters
783 * @param string $name
784 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
788 public function generateThumbName( $name, $params ) {
789 if ( !$this->getHandler() ) {
792 $extension = $this->getExtension();
793 list( $thumbExt, $thumbMime ) = $this->handler
->getThumbType(
794 $extension, $this->getMimeType(), $params );
795 $thumbName = $this->handler
->makeParamString( $params ) . '-' . $name;
796 if ( $thumbExt != $extension ) {
797 $thumbName .= ".$thumbExt";
803 * Create a thumbnail of the image having the specified width/height.
804 * The thumbnail will not be created if the width is larger than the
805 * image's width. Let the browser do the scaling in this case.
806 * The thumbnail is stored on disk and is only computed if the thumbnail
807 * file does not exist OR if it is older than the image.
810 * Keeps aspect ratio of original image. If both width and height are
811 * specified, the generated image will be no bigger than width x height,
812 * and will also have correct aspect ratio.
814 * @param $width Integer: maximum width of the generated thumbnail
815 * @param $height Integer: maximum height of the image (optional)
819 public function createThumb( $width, $height = -1 ) {
820 $params = array( 'width' => $width );
821 if ( $height != -1 ) {
822 $params['height'] = $height;
824 $thumb = $this->transform( $params );
825 if ( is_null( $thumb ) ||
$thumb->isError() ) {
828 return $thumb->getUrl();
832 * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
834 * @param $thumbPath string Thumbnail storage path
835 * @param $thumbUrl string Thumbnail URL
836 * @param $params Array
837 * @param $flags integer
838 * @return MediaTransformOutput
840 protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
841 global $wgIgnoreImageErrors;
843 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
844 return $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
846 return new MediaTransformError( 'thumbnail_error',
847 $params['width'], 0, wfMessage( 'thumbnail-dest-create' )->text() );
852 * Transform a media file
854 * @param $params Array: an associative array of handler-specific parameters.
855 * Typical keys are width, height and page.
856 * @param $flags Integer: a bitfield, may contain self::RENDER_NOW to force rendering
857 * @return MediaTransformOutput|bool False on failure
859 function transform( $params, $flags = 0 ) {
860 global $wgUseSquid, $wgIgnoreImageErrors, $wgThumbnailEpoch;
862 wfProfileIn( __METHOD__
);
864 if ( !$this->canRender() ) {
865 $thumb = $this->iconThumb();
866 break; // not a bitmap or renderable image, don't try
869 // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
870 $descriptionUrl = $this->getDescriptionUrl();
871 if ( $descriptionUrl ) {
872 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL
);
875 $script = $this->getTransformScript();
876 if ( $script && !( $flags & self
::RENDER_NOW
) ) {
877 // Use a script to transform on client request, if possible
878 $thumb = $this->handler
->getScriptedTransform( $this, $script, $params );
884 $normalisedParams = $params;
885 $this->handler
->normaliseParams( $this, $normalisedParams );
887 $thumbName = $this->thumbName( $normalisedParams );
888 $thumbUrl = $this->getThumbUrl( $thumbName );
889 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
892 // Defer rendering if a 404 handler is set up...
893 if ( $this->repo
->canTransformVia404() && !( $flags & self
::RENDER_NOW
) ) {
894 wfDebug( __METHOD__
. " transformation deferred." );
895 // XXX: Pass in the storage path even though we are not rendering anything
896 // and the path is supposed to be an FS path. This is due to getScalerType()
897 // getting called on the path and clobbering $thumb->getUrl() if it's false.
898 $thumb = $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
901 // Clean up broken thumbnails as needed
902 $this->migrateThumbFile( $thumbName );
903 // Check if an up-to-date thumbnail already exists...
904 wfDebug( __METHOD__
.": Doing stat for $thumbPath\n" );
905 if ( $this->repo
->fileExists( $thumbPath ) && !( $flags & self
::RENDER_FORCE
) ) {
906 $timestamp = $this->repo
->getFileTimestamp( $thumbPath );
907 if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
908 // XXX: Pass in the storage path even though we are not rendering anything
909 // and the path is supposed to be an FS path. This is due to getScalerType()
910 // getting called on the path and clobbering $thumb->getUrl() if it's false.
911 $thumb = $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
912 $thumb->setStoragePath( $thumbPath );
915 } elseif ( $flags & self
::RENDER_FORCE
) {
916 wfDebug( __METHOD__
. " forcing rendering per flag File::RENDER_FORCE\n" );
920 // If the backend is ready-only, don't keep generating thumbnails
921 // only to return transformation errors, just return the error now.
922 if ( $this->repo
->getReadOnlyReason() !== false ) {
923 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
927 // Create a temp FS file with the same extension and the thumbnail
928 $thumbExt = FileBackend
::extensionFromPath( $thumbPath );
929 $tmpFile = TempFSFile
::factory( 'transform_', $thumbExt );
931 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
934 $tmpThumbPath = $tmpFile->getPath(); // path of 0-byte temp file
936 // Actually render the thumbnail...
937 wfProfileIn( __METHOD__
. '-doTransform' );
938 $thumb = $this->handler
->doTransform( $this, $tmpThumbPath, $thumbUrl, $params );
939 wfProfileOut( __METHOD__
. '-doTransform' );
940 $tmpFile->bind( $thumb ); // keep alive with $thumb
942 if ( !$thumb ) { // bad params?
944 } elseif ( $thumb->isError() ) { // transform error
945 $this->lastError
= $thumb->toText();
946 // Ignore errors if requested
947 if ( $wgIgnoreImageErrors && !( $flags & self
::RENDER_NOW
) ) {
948 $thumb = $this->handler
->getTransform( $this, $tmpThumbPath, $thumbUrl, $params );
950 } elseif ( $this->repo
&& $thumb->hasFile() && !$thumb->fileIsSource() ) {
951 // Copy the thumbnail from the file system into storage...
952 $disposition = $this->getThumbDisposition( $thumbName );
953 $status = $this->repo
->quickImport( $tmpThumbPath, $thumbPath, $disposition );
954 if ( $status->isOK() ) {
955 $thumb->setStoragePath( $thumbPath );
957 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
959 // Give extensions a chance to do something with this thumbnail...
960 wfRunHooks( 'FileTransformed', array( $this, $thumb, $tmpThumbPath, $thumbPath ) );
963 // Purge. Useful in the event of Core -> Squid connection failure or squid
964 // purge collisions from elsewhere during failure. Don't keep triggering for
965 // "thumbs" which have the main image URL though (bug 13776)
967 if ( !$thumb ||
$thumb->isError() ||
$thumb->getUrl() != $this->getURL() ) {
968 SquidUpdate
::purge( array( $thumbUrl ) );
973 wfProfileOut( __METHOD__
);
974 return is_object( $thumb ) ?
$thumb : false;
978 * @param $thumbName string Thumbnail name
979 * @return string Content-Disposition header value
981 function getThumbDisposition( $thumbName ) {
982 $fileName = $this->name
; // file name to suggest
983 $thumbExt = FileBackend
::extensionFromPath( $thumbName );
984 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
985 $fileName .= ".$thumbExt";
987 return FileBackend
::makeContentDisposition( 'inline', $fileName );
991 * Hook into transform() to allow migration of thumbnail files
993 * Overridden by LocalFile
995 function migrateThumbFile( $thumbName ) {}
998 * Get a MediaHandler instance for this file
1000 * @return MediaHandler
1002 function getHandler() {
1003 if ( !isset( $this->handler
) ) {
1004 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
1006 return $this->handler
;
1010 * Get a ThumbnailImage representing a file type icon
1012 * @return ThumbnailImage
1014 function iconThumb() {
1015 global $wgStylePath, $wgStyleDirectory;
1017 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
1018 foreach ( $try as $icon ) {
1019 $path = '/common/images/icons/' . $icon;
1020 $filepath = $wgStyleDirectory . $path;
1021 if ( file_exists( $filepath ) ) { // always FS
1022 $params = array( 'width' => 120, 'height' => 120 );
1023 return new ThumbnailImage( $this, $wgStylePath . $path, false, $params );
1030 * Get last thumbnailing error.
1033 function getLastError() {
1034 return $this->lastError
;
1038 * Get all thumbnail names previously generated for this file
1040 * Overridden by LocalFile
1043 function getThumbnails() {
1048 * Purge shared caches such as thumbnails and DB data caching
1050 * Overridden by LocalFile
1051 * @param $options Array Options, which include:
1052 * 'forThumbRefresh' : The purging is only to refresh thumbnails
1054 function purgeCache( $options = array() ) {}
1057 * Purge the file description page, but don't go after
1058 * pages using the file. Use when modifying file history
1059 * but not the current data.
1061 function purgeDescription() {
1062 $title = $this->getTitle();
1064 $title->invalidateCache();
1065 $title->purgeSquid();
1070 * Purge metadata and all affected pages when the file is created,
1071 * deleted, or majorly updated.
1073 function purgeEverything() {
1074 // Delete thumbnails and refresh file metadata cache
1075 $this->purgeCache();
1076 $this->purgeDescription();
1078 // Purge cache of all pages using this file
1079 $title = $this->getTitle();
1081 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
1082 $update->doUpdate();
1087 * Return a fragment of the history of file.
1090 * @param $limit integer Limit of rows to return
1091 * @param $start string timestamp Only revisions older than $start will be returned
1092 * @param $end string timestamp Only revisions newer than $end will be returned
1093 * @param $inc bool Include the endpoints of the time range
1097 function getHistory( $limit = null, $start = null, $end = null, $inc=true ) {
1102 * Return the history of this file, line by line. Starts with current version,
1103 * then old versions. Should return an object similar to an image/oldimage
1107 * Overridden in LocalFile
1110 public function nextHistoryLine() {
1115 * Reset the history pointer to the first element of the history.
1116 * Always call this function after using nextHistoryLine() to free db resources
1118 * Overridden in LocalFile.
1120 public function resetHistory() {}
1123 * Get the filename hash component of the directory including trailing slash,
1125 * If the repository is not hashed, returns an empty string.
1129 function getHashPath() {
1130 if ( !isset( $this->hashPath
) ) {
1131 $this->assertRepoDefined();
1132 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
1134 return $this->hashPath
;
1138 * Get the path of the file relative to the public zone root.
1139 * This function is overriden in OldLocalFile to be like getArchiveRel().
1144 return $this->getHashPath() . $this->getName();
1148 * Get the path of an archived file relative to the public zone root
1150 * @param $suffix bool|string if not false, the name of an archived thumbnail file
1154 function getArchiveRel( $suffix = false ) {
1155 $path = 'archive/' . $this->getHashPath();
1156 if ( $suffix === false ) {
1157 $path = substr( $path, 0, -1 );
1165 * Get the path, relative to the thumbnail zone root, of the
1166 * thumbnail directory or a particular file if $suffix is specified
1168 * @param $suffix bool|string if not false, the name of a thumbnail file
1172 function getThumbRel( $suffix = false ) {
1173 $path = $this->getRel();
1174 if ( $suffix !== false ) {
1175 $path .= '/' . $suffix;
1181 * Get urlencoded path of the file relative to the public zone root.
1182 * This function is overriden in OldLocalFile to be like getArchiveUrl().
1186 function getUrlRel() {
1187 return $this->getHashPath() . rawurlencode( $this->getName() );
1191 * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1192 * or a specific thumb if the $suffix is given.
1194 * @param $archiveName string the timestamped name of an archived image
1195 * @param $suffix bool|string if not false, the name of a thumbnail file
1199 function getArchiveThumbRel( $archiveName, $suffix = false ) {
1200 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1201 if ( $suffix === false ) {
1202 $path = substr( $path, 0, -1 );
1210 * Get the path of the archived file.
1212 * @param $suffix bool|string if not false, the name of an archived file.
1216 function getArchivePath( $suffix = false ) {
1217 $this->assertRepoDefined();
1218 return $this->repo
->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1222 * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1224 * @param $archiveName string the timestamped name of an archived image
1225 * @param $suffix bool|string if not false, the name of a thumbnail file
1229 function getArchiveThumbPath( $archiveName, $suffix = false ) {
1230 $this->assertRepoDefined();
1231 return $this->repo
->getZonePath( 'thumb' ) . '/' .
1232 $this->getArchiveThumbRel( $archiveName, $suffix );
1236 * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1238 * @param $suffix bool|string if not false, the name of a thumbnail file
1242 function getThumbPath( $suffix = false ) {
1243 $this->assertRepoDefined();
1244 return $this->repo
->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1248 * Get the URL of the archive directory, or a particular file if $suffix is specified
1250 * @param $suffix bool|string if not false, the name of an archived file
1254 function getArchiveUrl( $suffix = false ) {
1255 $this->assertRepoDefined();
1256 $path = $this->repo
->getZoneUrl( 'public' ) . '/archive/' . $this->getHashPath();
1257 if ( $suffix === false ) {
1258 $path = substr( $path, 0, -1 );
1260 $path .= rawurlencode( $suffix );
1266 * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1268 * @param $archiveName string the timestamped name of an archived image
1269 * @param $suffix bool|string if not false, the name of a thumbnail file
1273 function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1274 $this->assertRepoDefined();
1275 $path = $this->repo
->getZoneUrl( 'thumb' ) . '/archive/' .
1276 $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1277 if ( $suffix === false ) {
1278 $path = substr( $path, 0, -1 );
1280 $path .= rawurlencode( $suffix );
1286 * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1288 * @param $suffix bool|string if not false, the name of a thumbnail file
1290 * @return string path
1292 function getThumbUrl( $suffix = false ) {
1293 $this->assertRepoDefined();
1294 $path = $this->repo
->getZoneUrl( 'thumb' ) . '/' . $this->getUrlRel();
1295 if ( $suffix !== false ) {
1296 $path .= '/' . rawurlencode( $suffix );
1302 * Get the public zone virtual URL for a current version source file
1304 * @param $suffix bool|string if not false, the name of a thumbnail file
1308 function getVirtualUrl( $suffix = false ) {
1309 $this->assertRepoDefined();
1310 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
1311 if ( $suffix !== false ) {
1312 $path .= '/' . rawurlencode( $suffix );
1318 * Get the public zone virtual URL for an archived version source file
1320 * @param $suffix bool|string if not false, the name of a thumbnail file
1324 function getArchiveVirtualUrl( $suffix = false ) {
1325 $this->assertRepoDefined();
1326 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1327 if ( $suffix === false ) {
1328 $path = substr( $path, 0, -1 );
1330 $path .= rawurlencode( $suffix );
1336 * Get the virtual URL for a thumbnail file or directory
1338 * @param $suffix bool|string if not false, the name of a thumbnail file
1342 function getThumbVirtualUrl( $suffix = false ) {
1343 $this->assertRepoDefined();
1344 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1345 if ( $suffix !== false ) {
1346 $path .= '/' . rawurlencode( $suffix );
1354 function isHashed() {
1355 $this->assertRepoDefined();
1356 return (bool)$this->repo
->getHashLevels();
1360 * @throws MWException
1362 function readOnlyError() {
1363 throw new MWException( get_class($this) . ': write operations are not supported' );
1367 * Record a file upload in the upload log and the image table
1369 * Overridden by LocalFile
1372 * @param $license string
1373 * @param $copyStatus string
1374 * @param $source string
1375 * @param $watch bool
1377 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
1378 $this->readOnlyError();
1382 * Move or copy a file to its public location. If a file exists at the
1383 * destination, move it to an archive. Returns a FileRepoStatus object with
1384 * the archive name in the "value" member on success.
1386 * The archive name should be passed through to recordUpload for database
1389 * @param $srcPath String: local filesystem path to the source image
1390 * @param $flags Integer: a bitwise combination of:
1391 * File::DELETE_SOURCE Delete the source file, i.e. move
1393 * @return FileRepoStatus object. On success, the value member contains the
1394 * archive name, or an empty string if it was a new file.
1397 * Overridden by LocalFile
1399 function publish( $srcPath, $flags = 0 ) {
1400 $this->readOnlyError();
1406 function formatMetadata() {
1407 if ( !$this->getHandler() ) {
1410 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
1414 * Returns true if the file comes from the local file repository.
1418 function isLocal() {
1419 return $this->repo
&& $this->repo
->isLocal();
1423 * Returns the name of the repository.
1427 function getRepoName() {
1428 return $this->repo ?
$this->repo
->getName() : 'unknown';
1432 * Returns the repository
1434 * @return FileRepo|bool
1436 function getRepo() {
1441 * Returns true if the image is an old version
1451 * Is this file a "deleted" file in a private archive?
1458 function isDeleted( $field ) {
1463 * Return the deletion bitfield
1467 function getVisibility() {
1472 * Was this file ever deleted from the wiki?
1476 function wasDeleted() {
1477 $title = $this->getTitle();
1478 return $title && $title->isDeletedQuick();
1482 * Move file to the new title
1484 * Move current, old version and all thumbnails
1485 * to the new filename. Old file is deleted.
1487 * Cache purging is done; checks for validity
1488 * and logging are caller's responsibility
1490 * @param $target Title New file name
1491 * @return FileRepoStatus object.
1493 function move( $target ) {
1494 $this->readOnlyError();
1498 * Delete all versions of the file.
1500 * Moves the files into an archive directory (or deletes them)
1501 * and removes the database rows.
1503 * Cache purging is done; logging is caller's responsibility.
1505 * @param $reason String
1506 * @param $suppress Boolean: hide content from sysops?
1507 * @return bool on success, false on some kind of failure
1509 * Overridden by LocalFile
1511 function delete( $reason, $suppress = false ) {
1512 $this->readOnlyError();
1516 * Restore all or specified deleted revisions to the given file.
1517 * Permissions and logging are left to the caller.
1519 * May throw database exceptions on error.
1521 * @param $versions array set of record ids of deleted items to restore,
1522 * or empty to restore all revisions.
1523 * @param $unsuppress bool remove restrictions on content upon restoration?
1524 * @return int|bool the number of file revisions restored if successful,
1525 * or false on failure
1527 * Overridden by LocalFile
1529 function restore( $versions = array(), $unsuppress = false ) {
1530 $this->readOnlyError();
1534 * Returns 'true' if this file is a type which supports multiple pages,
1535 * e.g. DJVU or PDF. Note that this may be true even if the file in
1536 * question only has a single page.
1540 function isMultipage() {
1541 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1545 * Returns the number of pages of a multipage document, or false for
1546 * documents which aren't multipage documents
1550 function pageCount() {
1551 if ( !isset( $this->pageCount
) ) {
1552 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1553 $this->pageCount
= $this->handler
->pageCount( $this );
1555 $this->pageCount
= false;
1558 return $this->pageCount
;
1562 * Calculate the height of a thumbnail using the source and destination width
1570 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1571 // Exact integer multiply followed by division
1572 if ( $srcWidth == 0 ) {
1575 return round( $srcHeight * $dstWidth / $srcWidth );
1580 * Get an image size array like that returned by getImageSize(), or false if it
1581 * can't be determined.
1583 * @param $fileName String: The filename
1586 function getImageSize( $fileName ) {
1587 if ( !$this->getHandler() ) {
1590 return $this->handler
->getImageSize( $this, $fileName );
1594 * Get the URL of the image description page. May return false if it is
1595 * unknown or not applicable.
1599 function getDescriptionUrl() {
1600 if ( $this->repo
) {
1601 return $this->repo
->getDescriptionUrl( $this->getName() );
1608 * Get the HTML text of the description page, if available
1612 function getDescriptionText() {
1613 global $wgMemc, $wgLang;
1614 if ( !$this->repo ||
!$this->repo
->fetchDescription
) {
1617 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $wgLang->getCode() );
1619 if ( $this->repo
->descriptionCacheExpiry
> 0 ) {
1620 wfDebug("Attempting to get the description from cache...");
1621 $key = $this->repo
->getLocalCacheKey( 'RemoteFileDescription', 'url', $wgLang->getCode(),
1623 $obj = $wgMemc->get($key);
1625 wfDebug("success!\n");
1630 wfDebug( "Fetching shared description from $renderUrl\n" );
1631 $res = Http
::get( $renderUrl );
1632 if ( $res && $this->repo
->descriptionCacheExpiry
> 0 ) {
1633 $wgMemc->set( $key, $res, $this->repo
->descriptionCacheExpiry
);
1642 * Get description of file revision
1645 * @param $audience Integer: one of:
1646 * File::FOR_PUBLIC to be displayed to all users
1647 * File::FOR_THIS_USER to be displayed to the given user
1648 * File::RAW get the description regardless of permissions
1649 * @param $user User object to check for, only if FOR_THIS_USER is passed
1650 * to the $audience parameter
1653 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1658 * Get the 14-character timestamp of the file upload
1660 * @return string|bool TS_MW timestamp or false on failure
1662 function getTimestamp() {
1663 $this->assertRepoDefined();
1664 return $this->repo
->getFileTimestamp( $this->getPath() );
1668 * Get the SHA-1 base 36 hash of the file
1672 function getSha1() {
1673 $this->assertRepoDefined();
1674 return $this->repo
->getFileSha1( $this->getPath() );
1678 * Get the deletion archive key, "<sha1>.<ext>"
1682 function getStorageKey() {
1683 $hash = $this->getSha1();
1687 $ext = $this->getExtension();
1688 $dotExt = $ext === '' ?
'' : ".$ext";
1689 return $hash . $dotExt;
1693 * Determine if the current user is allowed to view a particular
1694 * field of this file, if it's marked as deleted.
1696 * @param $field Integer
1697 * @param $user User object to check, or null to use $wgUser
1700 function userCan( $field, User
$user = null ) {
1705 * Get an associative array containing information about a file in the local filesystem.
1707 * @param $path String: absolute local filesystem path
1708 * @param $ext Mixed: the file extension, or true to extract it from the filename.
1709 * Set it to false to ignore the extension.
1713 static function getPropsFromPath( $path, $ext = true ) {
1714 wfDebug( __METHOD__
.": Getting file info for $path\n" );
1715 wfDeprecated( __METHOD__
, '1.19' );
1717 $fsFile = new FSFile( $path );
1718 return $fsFile->getProps();
1722 * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
1723 * encoding, zero padded to 31 digits.
1725 * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
1728 * @param $path string
1730 * @return bool|string False on failure
1732 static function sha1Base36( $path ) {
1733 wfDeprecated( __METHOD__
, '1.19' );
1735 $fsFile = new FSFile( $path );
1736 return $fsFile->getSha1Base36();
1742 function getLongDesc() {
1743 $handler = $this->getHandler();
1745 return $handler->getLongDesc( $this );
1747 return MediaHandler
::getGeneralLongDesc( $this );
1754 function getShortDesc() {
1755 $handler = $this->getHandler();
1757 return $handler->getShortDesc( $this );
1759 return MediaHandler
::getGeneralShortDesc( $this );
1766 function getDimensionsString() {
1767 $handler = $this->getHandler();
1769 return $handler->getDimensionsString( $this );
1778 function getRedirected() {
1779 return $this->redirected
;
1785 function getRedirectedTitle() {
1786 if ( $this->redirected
) {
1787 if ( !$this->redirectTitle
) {
1788 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
1790 return $this->redirectTitle
;
1798 function redirectedFrom( $from ) {
1799 $this->redirected
= $from;
1805 function isMissing() {
1810 * Check if this file object is small and can be cached
1813 public function isCacheable() {
1818 * Assert that $this->repo is set to a valid FileRepo instance
1819 * @throws MWException
1821 protected function assertRepoDefined() {
1822 if ( !( $this->repo
instanceof $this->repoClass
) ) {
1823 throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
1828 * Assert that $this->title is set to a Title
1829 * @throws MWException
1831 protected function assertTitleDefined() {
1832 if ( !( $this->title
instanceof Title
) ) {
1833 throw new MWException( "A Title object is not set for this File.\n" );