10 * Implements some public methods and some protected utility functions which
11 * are required by multiple child classes. Contains stub functionality for
12 * unimplemented public methods.
14 * Stub functions which should be overridden are marked with STUB. Some more
15 * concrete functions are also typically overridden by child classes.
17 * Note that only the repo object knows what its file class is called. You should
18 * never name a file class explictly outside of the repo class. Instead use the
19 * repo's factory functions to generate file objects, for example:
21 * RepoGroup::singleton()->getLocalRepo()->newFile($title);
23 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
29 const DELETED_FILE
= 1;
30 const DELETED_COMMENT
= 2;
31 const DELETED_USER
= 4;
32 const DELETED_RESTRICTED
= 8;
35 const DELETE_SOURCE
= 1;
38 * Some member variables can be lazy-initialised using __get(). The
39 * initialisation function for these variables is always a function named
40 * like getVar(), where Var is the variable name with upper-case first
43 * The following variables are initialised in this way in this base class:
44 * name, extension, handler, path, canRender, isSafeFile,
45 * transformScript, hashPath, pageCount, url
47 * Code within this class should generally use the accessor function
48 * directly, since __get() isn't re-entrant and therefore causes bugs that
49 * depend on initialisation order.
53 * The following member variables are not lazy-initialised
66 var $lastError, $redirected, $redirectedTitle;
74 * Call this constructor from child classes
76 function __construct( $title, $repo ) {
77 $this->title
= $title;
81 function __get( $name ) {
82 $function = array( $this, 'get' . ucfirst( $name ) );
83 if ( !is_callable( $function ) ) {
86 $this->$name = call_user_func( $function );
92 * Normalize a file extension to the common form, and ensure it's clean.
93 * Extensions with non-alphanumeric characters will be discarded.
95 * @param $ext string (without the .)
98 static function normalizeExtension( $ext ) {
99 $lower = strtolower( $ext );
106 if( isset( $squish[$lower] ) ) {
107 return $squish[$lower];
108 } elseif( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
116 * Checks if file extensions are compatible
118 * @param $old File Old file
119 * @param $new string New name
121 static function checkExtensionCompatibility( File
$old, $new ) {
122 $oldMime = $old->getMimeType();
123 $n = strrpos( $new, '.' );
124 $newExt = self
::normalizeExtension(
125 $n ?
substr( $new, $n +
1 ) : '' );
126 $mimeMagic = MimeMagic
::singleton();
127 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
131 * Upgrade the database row if there is one
132 * Called by ImagePage
135 function upgradeRow() {}
138 * Split an internet media type into its two components; if not
139 * a two-part name, set the minor type to 'unknown'.
141 * @param string $mime "text/html" etc
142 * @return array ("text", "html") etc
144 public static function splitMime( $mime ) {
145 if( strpos( $mime, '/' ) !== false ) {
146 return explode( '/', $mime, 2 );
148 return array( $mime, 'unknown' );
153 * Return the name of this file
155 public function getName() {
156 if ( !isset( $this->name
) ) {
157 $this->name
= $this->repo
->getNameFromTitle( $this->title
);
163 * Get the file extension, e.g. "svg"
165 function getExtension() {
166 if ( !isset( $this->extension
) ) {
167 $n = strrpos( $this->getName(), '.' );
168 $this->extension
= self
::normalizeExtension(
169 $n ?
substr( $this->getName(), $n +
1 ) : '' );
171 return $this->extension
;
175 * Return the associated title object
178 public function getTitle() { return $this->title
; }
181 * Return the title used to find this file
183 public function getOriginalTitle() {
184 if ( $this->redirected
)
185 return $this->getRedirectedTitle();
190 * Return the URL of the file
192 public function getUrl() {
193 if ( !isset( $this->url
) ) {
194 $this->url
= $this->repo
->getZoneUrl( 'public' ) . '/' . $this->getUrlRel();
200 * Return a fully-qualified URL to the file.
201 * Upload URL paths _may or may not_ be fully qualified, so
202 * we check. Local paths are assumed to belong on $wgServer.
206 public function getFullUrl() {
207 return wfExpandUrl( $this->getUrl() );
210 function getViewURL() {
211 if( $this->mustRender()) {
212 if( $this->canRender() ) {
213 return $this->createThumb( $this->getWidth() );
216 wfDebug(__METHOD__
.': supposed to render '.$this->getName().' ('.$this->getMimeType()."), but can't!\n");
217 return $this->getURL(); #hm... return NULL?
220 return $this->getURL();
225 * Return the full filesystem path to the file. Note that this does
226 * not mean that a file actually exists under that location.
228 * This path depends on whether directory hashing is active or not,
229 * i.e. whether the files are all found in the same directory,
230 * or in hashed paths like /images/3/3c.
232 * Most callers don't check the return value, but ForeignAPIFile::getPath
235 public function getPath() {
236 if ( !isset( $this->path
) ) {
237 $this->path
= $this->repo
->getZonePath('public') . '/' . $this->getRel();
243 * Alias for getPath()
245 * @deprecated Use getPath().
247 public function getFullPath() {
248 wfDeprecated( __METHOD__
);
249 return $this->getPath();
253 * Return the width of the image. Returns false if the width is unknown
257 * Overridden by LocalFile, UnregisteredLocalFile
259 public function getWidth( $page = 1 ) { return false; }
262 * Return the height of the image. Returns false if the height is unknown
266 * Overridden by LocalFile, UnregisteredLocalFile
268 public function getHeight( $page = 1 ) { return false; }
271 * Returns ID or name of user who uploaded the file
274 * @param $type string 'text' or 'id'
276 public function getUser( $type='text' ) { return null; }
279 * Get the duration of a media file in seconds
281 public function getLength() {
282 $handler = $this->getHandler();
284 return $handler->getLength( $this );
291 * Return true if the file is vectorized
293 public function isVectorized() {
294 $handler = $this->getHandler();
296 return $handler->isVectorized( $this );
304 * Get handler-specific metadata
305 * Overridden by LocalFile, UnregisteredLocalFile
308 public function getMetadata() { return false; }
311 * get versioned metadata
313 * @param $metadata Mixed Array or String of (serialized) metadata
314 * @param $version integer version number.
315 * @return Array containing metadata, or what was passed to it on fail (unserializing if not array)
317 public function convertMetadataVersion($metadata, $version) {
318 $handler = $this->getHandler();
319 if ( !is_array( $metadata ) ) {
320 //just to make the return type consistant
321 $metadata = unserialize( $metadata );
324 return $handler->convertMetadataVersion( $metadata, $version );
331 * Return the bit depth of the file
332 * Overridden by LocalFile
335 public function getBitDepth() { return 0; }
338 * Return the size of the image file, in bytes
339 * Overridden by LocalFile, UnregisteredLocalFile
342 public function getSize() { return false; }
345 * Returns the mime type of the file.
346 * Overridden by LocalFile, UnregisteredLocalFile
349 function getMimeType() { return 'unknown/unknown'; }
352 * Return the type of the media in the file.
353 * Use the value returned by this function with the MEDIATYPE_xxx constants.
354 * Overridden by LocalFile,
357 function getMediaType() { return MEDIATYPE_UNKNOWN
; }
360 * Checks if the output of transform() for this file is likely
361 * to be valid. If this is false, various user elements will
362 * display a placeholder instead.
364 * Currently, this checks if the file is an image format
365 * that can be converted to a format
366 * supported by all browsers (namely GIF, PNG and JPEG),
367 * or if it is an SVG image and SVG conversion is enabled.
369 function canRender() {
370 if ( !isset( $this->canRender
) ) {
371 $this->canRender
= $this->getHandler() && $this->handler
->canRender( $this );
373 return $this->canRender
;
377 * Accessor for __get()
379 protected function getCanRender() {
380 return $this->canRender();
384 * Return true if the file is of a type that can't be directly
385 * rendered by typical browsers and needs to be re-rasterized.
387 * This returns true for everything but the bitmap types
388 * supported by all browsers, i.e. JPEG; GIF and PNG. It will
389 * also return true for any non-image formats.
393 function mustRender() {
394 return $this->getHandler() && $this->handler
->mustRender( $this );
398 * Alias for canRender()
400 function allowInlineDisplay() {
401 return $this->canRender();
405 * Determines if this media file is in a format that is unlikely to
406 * contain viruses or malicious content. It uses the global
407 * $wgTrustedMediaFormats list to determine if the file is safe.
409 * This is used to show a warning on the description page of non-safe files.
410 * It may also be used to disallow direct [[media:...]] links to such files.
412 * Note that this function will always return true if allowInlineDisplay()
413 * or isTrustedFile() is true for this file.
415 function isSafeFile() {
416 if ( !isset( $this->isSafeFile
) ) {
417 $this->isSafeFile
= $this->_getIsSafeFile();
419 return $this->isSafeFile
;
422 /** Accessor for __get() */
423 protected function getIsSafeFile() {
424 return $this->isSafeFile();
427 /** Uncached accessor */
428 protected function _getIsSafeFile() {
429 if ($this->allowInlineDisplay()) return true;
430 if ($this->isTrustedFile()) return true;
432 global $wgTrustedMediaFormats;
434 $type= $this->getMediaType();
435 $mime= $this->getMimeType();
436 #wfDebug("LocalFile::isSafeFile: type= $type, mime= $mime\n");
438 if (!$type ||
$type===MEDIATYPE_UNKNOWN
) return false; #unknown type, not trusted
439 if ( in_array( $type, $wgTrustedMediaFormats) ) return true;
441 if ($mime==="unknown/unknown") return false; #unknown type, not trusted
442 if ( in_array( $mime, $wgTrustedMediaFormats) ) return true;
447 /** Returns true if the file is flagged as trusted. Files flagged that way
448 * can be linked to directly, even if that is not allowed for this type of
451 * This is a dummy function right now and always returns false. It could be
452 * implemented to extract a flag from the database. The trusted flag could be
453 * set on upload, if the user has sufficient privileges, to bypass script-
454 * and html-filters. It may even be coupled with cryptographics signatures
457 function isTrustedFile() {
458 #this could be implemented to check a flag in the databas,
459 #look for signatures, etc
464 * Returns true if file exists in the repository.
466 * Overridden by LocalFile to avoid unnecessary stat calls.
468 * @return boolean Whether file exists in the repository.
470 public function exists() {
471 return $this->getPath() && file_exists( $this->path
);
475 * Returns true if file exists in the repository and can be included in a page.
476 * It would be unsafe to include private images, making public thumbnails inadvertently
478 * @return boolean Whether file exists in the repository and is includable.
480 public function isVisible() {
481 return $this->exists();
484 function getTransformScript() {
485 if ( !isset( $this->transformScript
) ) {
486 $this->transformScript
= false;
488 $script = $this->repo
->getThumbScriptUrl();
490 $this->transformScript
= "$script?f=" . urlencode( $this->getName() );
494 return $this->transformScript
;
498 * Get a ThumbnailImage which is the same size as the source
500 function getUnscaledThumb( $handlerParams = array() ) {
501 $hp =& $handlerParams;
502 $page = isset( $hp['page'] ) ?
$hp['page'] : false;
503 $width = $this->getWidth( $page );
505 return $this->iconThumb();
507 $hp['width'] = $width;
508 return $this->transform( $hp );
512 * Return the file name of a thumbnail with the specified parameters
514 * @param $params Array: handler-specific parameters
517 function thumbName( $params ) {
518 return $this->generateThumbName( $this->getName(), $params );
522 * Generate a thumbnail file name from a name and specified parameters
524 * @param string $name
525 * @param array $params Parameters which will be passed to MediaHandler::makeParamString
527 function generateThumbName( $name, $params ) {
528 if ( !$this->getHandler() ) {
531 $extension = $this->getExtension();
532 list( $thumbExt, $thumbMime ) = $this->handler
->getThumbType( $extension, $this->getMimeType(), $params );
533 $thumbName = $this->handler
->makeParamString( $params ) . '-' . $name;
534 if ( $thumbExt != $extension ) {
535 $thumbName .= ".$thumbExt";
541 * Create a thumbnail of the image having the specified width/height.
542 * The thumbnail will not be created if the width is larger than the
543 * image's width. Let the browser do the scaling in this case.
544 * The thumbnail is stored on disk and is only computed if the thumbnail
545 * file does not exist OR if it is older than the image.
548 * Keeps aspect ratio of original image. If both width and height are
549 * specified, the generated image will be no bigger than width x height,
550 * and will also have correct aspect ratio.
552 * @param $width Integer: maximum width of the generated thumbnail
553 * @param $height Integer: maximum height of the image (optional)
555 public function createThumb( $width, $height = -1 ) {
556 $params = array( 'width' => $width );
557 if ( $height != -1 ) {
558 $params['height'] = $height;
560 $thumb = $this->transform( $params );
561 if( is_null( $thumb ) ||
$thumb->isError() ) return '';
562 return $thumb->getUrl();
566 * Transform a media file
568 * @param $params Array: an associative array of handler-specific parameters.
569 * Typical keys are width, height and page.
570 * @param $flags Integer: a bitfield, may contain self::RENDER_NOW to force rendering
571 * @return MediaTransformOutput | false
573 function transform( $params, $flags = 0 ) {
574 global $wgUseSquid, $wgIgnoreImageErrors, $wgThumbnailEpoch, $wgServer;
576 wfProfileIn( __METHOD__
);
578 if ( !$this->canRender() ) {
579 // not a bitmap or renderable image, don't try.
580 $thumb = $this->iconThumb();
584 // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
585 $descriptionUrl = $this->getDescriptionUrl();
586 if ( $descriptionUrl ) {
587 $params['descriptionUrl'] = $wgServer . $descriptionUrl;
590 $script = $this->getTransformScript();
591 if ( $script && !($flags & self
::RENDER_NOW
) ) {
592 // Use a script to transform on client request, if possible
593 $thumb = $this->handler
->getScriptedTransform( $this, $script, $params );
599 $normalisedParams = $params;
600 $this->handler
->normaliseParams( $this, $normalisedParams );
601 $thumbName = $this->thumbName( $normalisedParams );
602 $thumbPath = $this->getThumbPath( $thumbName );
603 $thumbUrl = $this->getThumbUrl( $thumbName );
605 if ( $this->repo
&& $this->repo
->canTransformVia404() && !($flags & self
::RENDER_NOW
) ) {
606 $thumb = $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
610 wfDebug( __METHOD__
.": Doing stat for $thumbPath\n" );
611 $this->migrateThumbFile( $thumbName );
612 if ( file_exists( $thumbPath )) {
613 $thumbTime = filemtime( $thumbPath );
614 if ( $thumbTime !== FALSE &&
615 gmdate( 'YmdHis', $thumbTime ) >= $wgThumbnailEpoch ) {
617 $thumb = $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
621 $thumb = $this->handler
->doTransform( $this, $thumbPath, $thumbUrl, $params );
623 // Ignore errors if requested
626 } elseif ( $thumb->isError() ) {
627 $this->lastError
= $thumb->toText();
628 if ( $wgIgnoreImageErrors && !($flags & self
::RENDER_NOW
) ) {
629 $thumb = $this->handler
->getTransform( $this, $thumbPath, $thumbUrl, $params );
633 // Purge. Useful in the event of Core -> Squid connection failure or squid
634 // purge collisions from elsewhere during failure. Don't keep triggering for
635 // "thumbs" which have the main image URL though (bug 13776)
636 if ( $wgUseSquid && ( !$thumb ||
$thumb->isError() ||
$thumb->getUrl() != $this->getURL()) ) {
637 SquidUpdate
::purge( array( $thumbUrl ) );
641 wfProfileOut( __METHOD__
);
642 return is_object( $thumb ) ?
$thumb : false;
646 * Hook into transform() to allow migration of thumbnail files
648 * Overridden by LocalFile
650 function migrateThumbFile( $thumbName ) {}
653 * Get a MediaHandler instance for this file
654 * @return MediaHandler
656 function getHandler() {
657 if ( !isset( $this->handler
) ) {
658 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
660 return $this->handler
;
664 * Get a ThumbnailImage representing a file type icon
665 * @return ThumbnailImage
667 function iconThumb() {
668 global $wgStylePath, $wgStyleDirectory;
670 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
671 foreach( $try as $icon ) {
672 $path = '/common/images/icons/' . $icon;
673 $filepath = $wgStyleDirectory . $path;
674 if( file_exists( $filepath ) ) {
675 return new ThumbnailImage( $this, $wgStylePath . $path, 120, 120 );
682 * Get last thumbnailing error.
685 function getLastError() {
686 return $this->lastError
;
690 * Get all thumbnail names previously generated for this file
692 * Overridden by LocalFile
694 function getThumbnails() { return array(); }
697 * Purge shared caches such as thumbnails and DB data caching
699 * Overridden by LocalFile
701 function purgeCache() {}
704 * Purge the file description page, but don't go after
705 * pages using the file. Use when modifying file history
706 * but not the current data.
708 function purgeDescription() {
709 $title = $this->getTitle();
711 $title->invalidateCache();
712 $title->purgeSquid();
717 * Purge metadata and all affected pages when the file is created,
718 * deleted, or majorly updated.
720 function purgeEverything() {
721 // Delete thumbnails and refresh file metadata cache
723 $this->purgeDescription();
725 // Purge cache of all pages using this file
726 $title = $this->getTitle();
728 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
734 * Return a fragment of the history of file.
737 * @param $limit integer Limit of rows to return
738 * @param $start timestamp Only revisions older than $start will be returned
739 * @param $end timestamp Only revisions newer than $end will be returned
740 * @param $inc bool Include the endpoints of the time range
742 function getHistory($limit = null, $start = null, $end = null, $inc=true) {
747 * Return the history of this file, line by line. Starts with current version,
748 * then old versions. Should return an object similar to an image/oldimage
752 * Overridden in LocalFile
754 public function nextHistoryLine() {
759 * Reset the history pointer to the first element of the history.
760 * Always call this function after using nextHistoryLine() to free db resources
762 * Overridden in LocalFile.
764 public function resetHistory() {}
767 * Get the filename hash component of the directory including trailing slash,
769 * If the repository is not hashed, returns an empty string.
771 function getHashPath() {
772 if ( !isset( $this->hashPath
) ) {
773 $this->hashPath
= $this->repo
->getHashPath( $this->getName() );
775 return $this->hashPath
;
779 * Get the path of the file relative to the public zone root
782 return $this->getHashPath() . $this->getName();
786 * Get urlencoded relative path of the file
788 function getUrlRel() {
789 return $this->getHashPath() . rawurlencode( $this->getName() );
792 /** Get the relative path for an archive file */
793 function getArchiveRel( $suffix = false ) {
794 $path = 'archive/' . $this->getHashPath();
795 if ( $suffix === false ) {
796 $path = substr( $path, 0, -1 );
803 /** Get the path of the archive directory, or a particular file if $suffix is specified */
804 function getArchivePath( $suffix = false ) {
805 return $this->repo
->getZonePath('public') . '/' . $this->getArchiveRel( $suffix );
808 /** Get the path of the thumbnail directory, or a particular file if $suffix is specified */
809 function getThumbPath( $suffix = false ) {
810 $path = $this->repo
->getZonePath('thumb') . '/' . $this->getRel();
811 if ( $suffix !== false ) {
812 $path .= '/' . $suffix;
817 /** Get the URL of the archive directory, or a particular file if $suffix is specified */
818 function getArchiveUrl( $suffix = false ) {
819 $path = $this->repo
->getZoneUrl('public') . '/archive/' . $this->getHashPath();
820 if ( $suffix === false ) {
821 $path = substr( $path, 0, -1 );
823 $path .= rawurlencode( $suffix );
828 /** Get the URL of the thumbnail directory, or a particular file if $suffix is specified */
829 function getThumbUrl( $suffix = false ) {
830 $path = $this->repo
->getZoneUrl('thumb') . '/' . $this->getUrlRel();
831 if ( $suffix !== false ) {
832 $path .= '/' . rawurlencode( $suffix );
837 /** Get the virtual URL for an archive file or directory */
838 function getArchiveVirtualUrl( $suffix = false ) {
839 $path = $this->repo
->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
840 if ( $suffix === false ) {
841 $path = substr( $path, 0, -1 );
843 $path .= rawurlencode( $suffix );
848 /** Get the virtual URL for a thumbnail file or directory */
849 function getThumbVirtualUrl( $suffix = false ) {
850 $path = $this->repo
->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
851 if ( $suffix !== false ) {
852 $path .= '/' . rawurlencode( $suffix );
857 /** Get the virtual URL for the file itself */
858 function getVirtualUrl( $suffix = false ) {
859 $path = $this->repo
->getVirtualUrl() . '/public/' . $this->getUrlRel();
860 if ( $suffix !== false ) {
861 $path .= '/' . rawurlencode( $suffix );
869 function isHashed() {
870 return $this->repo
->isHashed();
873 function readOnlyError() {
874 throw new MWException( get_class($this) . ': write operations are not supported' );
878 * Record a file upload in the upload log and the image table
880 * Overridden by LocalFile
882 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
883 $this->readOnlyError();
887 * Move or copy a file to its public location. If a file exists at the
888 * destination, move it to an archive. Returns a FileRepoStatus object with
889 * the archive name in the "value" member on success.
891 * The archive name should be passed through to recordUpload for database
894 * @param $srcPath String: local filesystem path to the source image
895 * @param $flags Integer: a bitwise combination of:
896 * File::DELETE_SOURCE Delete the source file, i.e. move
898 * @return FileRepoStatus object. On success, the value member contains the
899 * archive name, or an empty string if it was a new file.
902 * Overridden by LocalFile
904 function publish( $srcPath, $flags = 0 ) {
905 $this->readOnlyError();
909 * Get an array of Title objects which are articles which use this file
910 * Also adds their IDs to the link cache
912 * This is mostly copied from Title::getLinksTo()
914 * @deprecated Use HTMLCacheUpdate, this function uses too much memory
916 function getLinksTo( $options = array() ) {
917 wfDeprecated( __METHOD__
);
918 wfProfileIn( __METHOD__
);
920 // Note: use local DB not repo DB, we want to know local links
921 if ( count( $options ) > 0 ) {
922 $db = wfGetDB( DB_MASTER
);
924 $db = wfGetDB( DB_SLAVE
);
926 $linkCache = LinkCache
::singleton();
928 $encName = $db->addQuotes( $this->getName() );
929 $res = $db->select( array( 'page', 'imagelinks'),
930 array( 'page_namespace', 'page_title', 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
931 array( 'page_id=il_from', 'il_to' => $encName ),
936 if ( $db->numRows( $res ) ) {
937 foreach ( $res as $row ) {
938 $titleObj = Title
::newFromRow( $row );
940 $linkCache->addGoodLinkObj( $row->page_id
, $titleObj, $row->page_len
, $row->page_is_redirect
, $row->page_latest
);
941 $retVal[] = $titleObj;
945 wfProfileOut( __METHOD__
);
949 function formatMetadata() {
950 if ( !$this->getHandler() ) {
953 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
957 * Returns true if the file comes from the local file repository.
962 $repo = $this->getRepo();
963 return $repo && $repo->isLocal();
967 * Returns the name of the repository.
971 function getRepoName() {
972 return $this->repo ?
$this->repo
->getName() : 'unknown';
975 * Returns the repository
982 * Returns true if the image is an old version
990 * Is this file a "deleted" file in a private archive?
993 function isDeleted( $field ) {
998 * Return the deletion bitfield
1001 function getVisibility() {
1006 * Was this file ever deleted from the wiki?
1010 function wasDeleted() {
1011 $title = $this->getTitle();
1012 return $title && $title->isDeletedQuick();
1016 * Move file to the new title
1018 * Move current, old version and all thumbnails
1019 * to the new filename. Old file is deleted.
1021 * Cache purging is done; checks for validity
1022 * and logging are caller's responsibility
1024 * @param $target Title New file name
1025 * @return FileRepoStatus object.
1027 function move( $target ) {
1028 $this->readOnlyError();
1032 * Delete all versions of the file.
1034 * Moves the files into an archive directory (or deletes them)
1035 * and removes the database rows.
1037 * Cache purging is done; logging is caller's responsibility.
1039 * @param $reason String
1040 * @param $suppress Boolean: hide content from sysops?
1041 * @return true on success, false on some kind of failure
1043 * Overridden by LocalFile
1045 function delete( $reason, $suppress = false ) {
1046 $this->readOnlyError();
1050 * Restore all or specified deleted revisions to the given file.
1051 * Permissions and logging are left to the caller.
1053 * May throw database exceptions on error.
1055 * @param $versions set of record ids of deleted items to restore,
1056 * or empty to restore all revisions.
1057 * @param $unsuppress remove restrictions on content upon restoration?
1058 * @return the number of file revisions restored if successful,
1059 * or false on failure
1061 * Overridden by LocalFile
1063 function restore( $versions=array(), $unsuppress=false ) {
1064 $this->readOnlyError();
1068 * Returns 'true' if this file is a type which supports multiple pages,
1069 * e.g. DJVU or PDF. Note that this may be true even if the file in
1070 * question only has a single page.
1074 function isMultipage() {
1075 return $this->getHandler() && $this->handler
->isMultiPage( $this );
1079 * Returns the number of pages of a multipage document, or false for
1080 * documents which aren't multipage documents
1082 function pageCount() {
1083 if ( !isset( $this->pageCount
) ) {
1084 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
1085 $this->pageCount
= $this->handler
->pageCount( $this );
1087 $this->pageCount
= false;
1090 return $this->pageCount
;
1094 * Calculate the height of a thumbnail using the source and destination width
1096 static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1097 // Exact integer multiply followed by division
1098 if ( $srcWidth == 0 ) {
1101 return round( $srcHeight * $dstWidth / $srcWidth );
1106 * Get an image size array like that returned by getImageSize(), or false if it
1107 * can't be determined.
1109 * @param $fileName String: The filename
1112 function getImageSize( $fileName ) {
1113 if ( !$this->getHandler() ) {
1116 return $this->handler
->getImageSize( $this, $fileName );
1120 * Get the URL of the image description page. May return false if it is
1121 * unknown or not applicable.
1123 function getDescriptionUrl() {
1124 return $this->repo
->getDescriptionUrl( $this->getName() );
1128 * Get the HTML text of the description page, if available
1130 function getDescriptionText() {
1131 global $wgMemc, $wgLang;
1132 if ( !$this->repo
->fetchDescription
) {
1135 $renderUrl = $this->repo
->getDescriptionRenderUrl( $this->getName(), $wgLang->getCode() );
1137 if ( $this->repo
->descriptionCacheExpiry
> 0 ) {
1138 wfDebug("Attempting to get the description from cache...");
1139 $key = $this->repo
->getLocalCacheKey( 'RemoteFileDescription', 'url', $wgLang->getCode(),
1141 $obj = $wgMemc->get($key);
1143 wfDebug("success!\n");
1148 wfDebug( "Fetching shared description from $renderUrl\n" );
1149 $res = Http
::get( $renderUrl );
1150 if ( $res && $this->repo
->descriptionCacheExpiry
> 0 ) {
1151 $wgMemc->set( $key, $res, $this->repo
->descriptionCacheExpiry
);
1160 * Get discription of file revision
1163 function getDescription() {
1168 * Get the 14-character timestamp of the file upload, or false if
1171 function getTimestamp() {
1172 $path = $this->getPath();
1173 if ( !file_exists( $path ) ) {
1176 return wfTimestamp( TS_MW
, filemtime( $path ) );
1180 * Get the SHA-1 base 36 hash of the file
1182 function getSha1() {
1183 return self
::sha1Base36( $this->getPath() );
1187 * Get the deletion archive key, <sha1>.<ext>
1189 function getStorageKey() {
1190 $hash = $this->getSha1();
1194 $ext = $this->getExtension();
1195 $dotExt = $ext === '' ?
'' : ".$ext";
1196 return $hash . $dotExt;
1200 * Determine if the current user is allowed to view a particular
1201 * field of this file, if it's marked as deleted.
1203 * @param $field Integer
1206 function userCan( $field ) {
1211 * Get an associative array containing information about a file in the local filesystem.
1213 * @param $path String: absolute local filesystem path
1214 * @param $ext Mixed: the file extension, or true to extract it from the filename.
1215 * Set it to false to ignore the extension.
1217 static function getPropsFromPath( $path, $ext = true ) {
1218 wfProfileIn( __METHOD__
);
1219 wfDebug( __METHOD__
.": Getting file info for $path\n" );
1221 'fileExists' => file_exists( $path ) && !is_dir( $path )
1224 if ( $info['fileExists'] ) {
1225 $magic = MimeMagic
::singleton();
1227 if ( $ext === true ) {
1228 $i = strrpos( $path, '.' );
1229 $ext = strtolower( $i ?
substr( $path, $i +
1 ) : '' );
1232 # mime type according to file contents
1233 $info['file-mime'] = $magic->guessMimeType( $path, false );
1235 $info['mime'] = $magic->improveTypeFromExtension( $info['file-mime'], $ext );
1237 list( $info['major_mime'], $info['minor_mime'] ) = self
::splitMime( $info['mime'] );
1238 $info['media_type'] = $magic->getMediaType( $path, $info['mime'] );
1241 $info['size'] = filesize( $path );
1243 # Height, width and metadata
1244 $handler = MediaHandler
::getHandler( $info['mime'] );
1246 $tempImage = (object)array();
1247 $info['metadata'] = $handler->getMetadata( $tempImage, $path );
1248 $gis = $handler->getImageSize( $tempImage, $path, $info['metadata'] );
1251 $info['metadata'] = '';
1253 $info['sha1'] = self
::sha1Base36( $path );
1255 wfDebug(__METHOD__
.": $path loaded, {$info['size']} bytes, {$info['mime']}.\n");
1257 $info['mime'] = null;
1258 $info['media_type'] = MEDIATYPE_UNKNOWN
;
1259 $info['metadata'] = '';
1261 wfDebug(__METHOD__
.": $path NOT FOUND!\n");
1264 # NOTE: $gis[2] contains a code for the image type. This is no longer used.
1265 $info['width'] = $gis[0];
1266 $info['height'] = $gis[1];
1267 if ( isset( $gis['bits'] ) ) {
1268 $info['bits'] = $gis['bits'];
1274 $info['height'] = 0;
1277 wfProfileOut( __METHOD__
);
1282 * Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case
1283 * encoding, zero padded to 31 digits.
1285 * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36
1288 * Returns false on failure
1290 static function sha1Base36( $path ) {
1291 wfSuppressWarnings();
1292 $hash = sha1_file( $path );
1293 wfRestoreWarnings();
1294 if ( $hash === false ) {
1297 return wfBaseConvert( $hash, 16, 36, 31 );
1301 function getLongDesc() {
1302 $handler = $this->getHandler();
1304 return $handler->getLongDesc( $this );
1306 return MediaHandler
::getGeneralLongDesc( $this );
1310 function getShortDesc() {
1311 $handler = $this->getHandler();
1313 return $handler->getShortDesc( $this );
1315 return MediaHandler
::getGeneralShortDesc( $this );
1319 function getDimensionsString() {
1320 $handler = $this->getHandler();
1322 return $handler->getDimensionsString( $this );
1328 function getRedirected() {
1329 return $this->redirected
;
1332 function getRedirectedTitle() {
1333 if ( $this->redirected
) {
1334 if ( !$this->redirectTitle
) {
1335 $this->redirectTitle
= Title
::makeTitle( NS_FILE
, $this->redirected
);
1337 return $this->redirectTitle
;
1341 function redirectedFrom( $from ) {
1342 $this->redirected
= $from;
1345 function isMissing() {
1350 * Aliases for backwards compatibility with 1.6
1352 define( 'MW_IMG_DELETED_FILE', File
::DELETED_FILE
);
1353 define( 'MW_IMG_DELETED_COMMENT', File
::DELETED_COMMENT
);
1354 define( 'MW_IMG_DELETED_USER', File
::DELETED_USER
);
1355 define( 'MW_IMG_DELETED_RESTRICTED', File
::DELETED_RESTRICTED
);