includes/filerepo/file/File.php

   1 <?php
   2 /**
   3  * @defgroup FileAbstraction File abstraction
   4  * @ingroup FileRepo
   5  *
   6  * Represents files in a repository.
   7  */
   8
   9 /**
  10  * Base code for files.
  11  *
  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.
  16  *
  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.
  21  *
  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
  26  *
  27  * @file
  28  * @ingroup FileAbstraction
  29  */
  30
  31 /**
  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.
  35  *
  36  * Stub functions which should be overridden are marked with STUB. Some more
  37  * concrete functions are also typically overridden by child classes.
  38  *
  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:
  42  *
  43  * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
  44  *
  45  * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
  46  * in most cases.
  47  *
  48  * @ingroup FileAbstraction
  49  */
  50 abstract class File {
  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;
  56
  57         /** Force rendering in the current process */
  58         const RENDER_NOW = 1;
  59         /**
  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
  62          */
  63         const RENDER_FORCE = 2;
  64
  65         const DELETE_SOURCE = 1;
  66
  67         // Audience options for File::getDescription()
  68         const FOR_PUBLIC = 1;
  69         const FOR_THIS_USER = 2;
  70         const RAW = 3;
  71
  72         // Options for File::thumbName()
  73         const THUMB_FULL_NAME = 1;
  74
  75         /**
  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
  79          * letter.
  80          *
  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
  84          *
  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.
  88          */
  89
  90         /**
  91          * The following member variables are not lazy-initialised
  92          */
  93
  94         /** @var FileRepo|LocalRepo|ForeignAPIRepo|bool */
  95         public $repo;
  96
  97         /** @var Title|string|bool */
  98         protected $title;
  99
 100         /** @var string Text of last error */
 101         protected $lastError;
 102
 103         /** @var string Main part of the title, with underscores (Title::getDBkey) */
 104         protected $redirected;
 105
 106         /** @var Title */
 107         protected $redirectedTitle;
 108
 109         /** @var FSFile|bool False if undefined */
 110         protected $fsFile;
 111
 112         /** @var MediaHandler */
 113         protected $handler;
 114
 115         /** @var string The URL corresponding to one of the four basic zones */
 116         protected $url;
 117
 118         /** @var string File extension */
 119         protected $extension;
 120
 121         /** @var string The name of a file from its title object */
 122         protected $name;
 123
 124         /** @var string The storage path corresponding to one of the zones */
 125         protected $path;
 126
 127         /** @var string Relative path including trailing slash */
 128         protected $hashPath;
 129
 130         /** @var string Number of pages of a multipage document, or false for
 131          *    documents which aren't multipage documents
 132          */
 133         protected $pageCount;
 134
 135         /** @var string URL of transformscript (for example thumb.php) */
 136         protected $transformScript;
 137
 138         /** @var Title */
 139         protected $redirectTitle;
 140
 141         /** @var bool Whether the output of transform() for this file is likely to be valid. */
 142         protected $canRender;
 143
 144         /** @var bool Whether this media file is in a format that is unlikely to
 145          *    contain viruses or malicious content
 146          */
 147         protected $isSafeFile;
 148
 149         /** @var string Required Repository class type */
 150         protected $repoClass = 'FileRepo';
 151
 152         /** @var array Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width */
 153         protected $tmpBucketedThumbCache = array();
 154
 155         /**
 156          * Call this constructor from child classes.
 157          *
 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.
 161          *
 162          * @param Title|string|bool $title
 163          * @param FileRepo|bool $repo
 164          */
 165         function __construct( $title, $repo ) {
 166                 if ( $title !== false ) { // subclasses may not use MW titles
 167                         $title = self::normalizeTitle( $title, 'exception' );
 168                 }
 169                 $this->title = $title;
 170                 $this->repo = $repo;
 171         }
 172
 173         /**
 174          * Given a string or Title object return either a
 175          * valid Title object with namespace NS_FILE or null
 176          *
 177          * @param Title|string $title
 178          * @param string|bool $exception Use 'exception' to throw an error on bad titles
 179          * @throws MWException
 180          * @return Title|null
 181          */
 182         static function normalizeTitle( $title, $exception = false ) {
 183                 $ret = $title;
 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 ) {
 190                                 $ret = null;
 191                         }
 192                 } else {
 193                         # Convert strings to Title objects
 194                         $ret = Title::makeTitleSafe( NS_FILE, (string)$ret );
 195                 }
 196                 if ( !$ret && $exception !== false ) {
 197                         throw new MWException( "`$title` is not a valid file title." );
 198                 }
 199
 200                 return $ret;
 201         }
 202
 203         function __get( $name ) {
 204                 $function = array( $this, 'get' . ucfirst( $name ) );
 205                 if ( !is_callable( $function ) ) {
 206                         return null;
 207                 } else {
 208                         $this->$name = call_user_func( $function );
 209
 210                         return $this->$name;
 211                 }
 212         }
 213
 214         /**
 215          * Normalize a file extension to the common form, and ensure it's clean.
 216          * Extensions with non-alphanumeric characters will be discarded.
 217          *
 218          * @param string $ext (without the .)
 219          * @return string
 220          */
 221         static function normalizeExtension( $ext ) {
 222                 $lower = strtolower( $ext );
 223                 $squish = array(
 224                         'htm' => 'html',
 225                         'jpeg' => 'jpg',
 226                         'mpeg' => 'mpg',
 227                         'tiff' => 'tif',
 228                         'ogv' => 'ogg' );
 229                 if ( isset( $squish[$lower] ) ) {
 230                         return $squish[$lower];
 231                 } elseif ( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
 232                         return $lower;
 233                 } else {
 234                         return '';
 235                 }
 236         }
 237
 238         /**
 239          * Checks if file extensions are compatible
 240          *
 241          * @param File $old Old file
 242          * @param string $new New name
 243          *
 244          * @return bool|null
 245          */
 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();
 251
 252                 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
 253         }
 254
 255         /**
 256          * Upgrade the database row if there is one
 257          * Called by ImagePage
 258          * STUB
 259          */
 260         function upgradeRow() {
 261         }
 262
 263         /**
 264          * Split an internet media type into its two components; if not
 265          * a two-part name, set the minor type to 'unknown'.
 266          *
 267          * @param string $mime "text/html" etc
 268          * @return array ("text", "html") etc
 269          */
 270         public static function splitMime( $mime ) {
 271                 if ( strpos( $mime, '/' ) !== false ) {
 272                         return explode( '/', $mime, 2 );
 273                 } else {
 274                         return array( $mime, 'unknown' );
 275                 }
 276         }
 277
 278         /**
 279          * Callback for usort() to do file sorts by name
 280          *
 281          * @param File $a
 282          * @param File $b
 283          * @return int Result of name comparison
 284          */
 285         public static function compare( File $a, File $b ) {
 286                 return strcmp( $a->getName(), $b->getName() );
 287         }
 288
 289         /**
 290          * Return the name of this file
 291          *
 292          * @return string
 293          */
 294         public function getName() {
 295                 if ( !isset( $this->name ) ) {
 296                         $this->assertRepoDefined();
 297                         $this->name = $this->repo->getNameFromTitle( $this->title );
 298                 }
 299
 300                 return $this->name;
 301         }
 302
 303         /**
 304          * Get the file extension, e.g. "svg"
 305          *
 306          * @return string
 307          */
 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 ) : '' );
 313                 }
 314
 315                 return $this->extension;
 316         }
 317
 318         /**
 319          * Return the associated title object
 320          *
 321          * @return Title
 322          */
 323         public function getTitle() {
 324                 return $this->title;
 325         }
 326
 327         /**
 328          * Return the title used to find this file
 329          *
 330          * @return Title
 331          */
 332         public function getOriginalTitle() {
 333                 if ( $this->redirected ) {
 334                         return $this->getRedirectedTitle();
 335                 }
 336
 337                 return $this->title;
 338         }
 339
 340         /**
 341          * Return the URL of the file
 342          *
 343          * @return string
 344          */
 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();
 350                 }
 351
 352                 return $this->url;
 353         }
 354
 355         /**
 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.
 359          *
 360          * @return string
 361          */
 362         public function getFullUrl() {
 363                 return wfExpandUrl( $this->getUrl(), PROTO_RELATIVE );
 364         }
 365
 366         /**
 367          * @return string
 368          */
 369         public function getCanonicalUrl() {
 370                 return wfExpandUrl( $this->getUrl(), PROTO_CANONICAL );
 371         }
 372
 373         /**
 374          * @return string
 375          */
 376         function getViewURL() {
 377                 if ( $this->mustRender() ) {
 378                         if ( $this->canRender() ) {
 379                                 return $this->createThumb( $this->getWidth() );
 380                         } else {
 381                                 wfDebug( __METHOD__ . ': supposed to render ' . $this->getName() .
 382                                         ' (' . $this->getMimeType() . "), but can't!\n" );
 383
 384                                 return $this->getURL(); #hm... return NULL?
 385                         }
 386                 } else {
 387                         return $this->getURL();
 388                 }
 389         }
 390
 391         /**
 392          * Return the storage path to the file. Note that this does
 393          * not mean that a file actually exists under that location.
 394          *
 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.
 398          *
 399          * Most callers don't check the return value, but ForeignAPIFile::getPath
 400          * returns false.
 401          *
 402          * @return string|bool ForeignAPIFile::getPath can return false
 403          */
 404         public function getPath() {
 405                 if ( !isset( $this->path ) ) {
 406                         $this->assertRepoDefined();
 407                         $this->path = $this->repo->getZonePath( 'public' ) . '/' . $this->getRel();
 408                 }
 409
 410                 return $this->path;
 411         }
 412
 413         /**
 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.
 417          *
 418          * @return string|bool False on failure
 419          */
 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
 426                         }
 427                 }
 428
 429                 return ( $this->fsFile )
 430                         ? $this->fsFile->getPath()
 431                         : false;
 432         }
 433
 434         /**
 435          * Return the width of the image. Returns false if the width is unknown
 436          * or undefined.
 437          *
 438          * STUB
 439          * Overridden by LocalFile, UnregisteredLocalFile
 440          *
 441          * @param int $page
 442          * @return int|bool
 443          */
 444         public function getWidth( $page = 1 ) {
 445                 return false;
 446         }
 447
 448         /**
 449          * Return the height of the image. Returns false if the height is unknown
 450          * or undefined
 451          *
 452          * STUB
 453          * Overridden by LocalFile, UnregisteredLocalFile
 454          *
 455          * @param int $page
 456          * @return bool|int False on failure
 457          */
 458         public function getHeight( $page = 1 ) {
 459                 return false;
 460         }
 461
 462         /**
 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.
 466          *
 467          * @param int $desiredWidth
 468          * @param int $page
 469          * @return bool|int
 470          */
 471         public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
 472                 global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
 473
 474                 wfDebugLog( 'thumbnail', 'thumbnail buckets ' . json_encode( $wgThumbnailBuckets ) );
 475
 476                 $imageWidth = $this->getWidth( $page );
 477
 478                 if ( $imageWidth === false ) {
 479                         return false;
 480                 }
 481
 482                 if ( $desiredWidth > $imageWidth ) {
 483                         return false;
 484                 }
 485
 486                 if ( !$wgThumbnailBuckets ) {
 487                         return false;
 488                 }
 489
 490                 $sortedBuckets = $wgThumbnailBuckets;
 491
 492                 sort( $sortedBuckets );
 493
 494                 foreach ( $sortedBuckets as $bucket ) {
 495                         if ( $bucket >= $imageWidth ) {
 496                                 return false;
 497                         }
 498
 499                         if ( $bucket - $wgThumbnailMinimumBucketDistance > $desiredWidth ) {
 500                                 return $bucket;
 501                         }
 502                 }
 503
 504                 // Image is bigger than any available bucket
 505                 return false;
 506         }
 507
 508         /**
 509          * Returns ID or name of user who uploaded the file
 510          * STUB
 511          *
 512          * @param string $type 'text' or 'id'
 513          * @return string|int
 514          */
 515         public function getUser( $type = 'text' ) {
 516                 return null;
 517         }
 518
 519         /**
 520          * Get the duration of a media file in seconds
 521          *
 522          * @return int
 523          */
 524         public function getLength() {
 525                 $handler = $this->getHandler();
 526                 if ( $handler ) {
 527                         return $handler->getLength( $this );
 528                 } else {
 529                         return 0;
 530                 }
 531         }
 532
 533         /**
 534          * Return true if the file is vectorized
 535          *
 536          * @return bool
 537          */
 538         public function isVectorized() {
 539                 $handler = $this->getHandler();
 540                 if ( $handler ) {
 541                         return $handler->isVectorized( $this );
 542                 } else {
 543                         return false;
 544                 }
 545         }
 546
 547         /**
 548          * Gives a (possibly empty) list of languages to render
 549          * the file in.
 550          *
 551          * If the file doesn't have translations, or if the file
 552          * format does not support that sort of thing, returns
 553          * an empty array.
 554          *
 555          * @return array
 556          * @since 1.23
 557          */
 558         public function getAvailableLanguages() {
 559                 $handler = $this->getHandler();
 560                 if ( $handler ) {
 561                         return $handler->getAvailableLanguages( $this );
 562                 } else {
 563                         return array();
 564                 }
 565         }
 566
 567         /**
 568          * In files that support multiple language, what is the default language
 569          * to use if none specified.
 570          *
 571          * @return string Lang code, or null if filetype doesn't support multiple languages.
 572          * @since 1.23
 573          */
 574         public function getDefaultRenderLanguage() {
 575                 $handler = $this->getHandler();
 576                 if ( $handler ) {
 577                         return $handler->getDefaultRenderLanguage( $this );
 578                 } else {
 579                         return null;
 580                 }
 581         }
 582
 583         /**
 584          * Will the thumbnail be animated if one would expect it to be.
 585          *
 586          * Currently used to add a warning to the image description page
 587          *
 588          * @return bool False if the main image is both animated
 589          *   and the thumbnail is not. In all other cases must return
 590          *   true. If image is not renderable whatsoever, should
 591          *   return true.
 592          */
 593         public function canAnimateThumbIfAppropriate() {
 594                 $handler = $this->getHandler();
 595                 if ( !$handler ) {
 596                         // We cannot handle image whatsoever, thus
 597                         // one would not expect it to be animated
 598                         // so true.
 599                         return true;
 600                 } else {
 601                         if ( $this->allowInlineDisplay()
 602                                 && $handler->isAnimatedImage( $this )
 603                                 && !$handler->canAnimateThumbnail( $this )
 604                         ) {
 605                                 // Image is animated, but thumbnail isn't.
 606                                 // This is unexpected to the user.
 607                                 return false;
 608                         } else {
 609                                 // Image is not animated, so one would
 610                                 // not expect thumb to be
 611                                 return true;
 612                         }
 613                 }
 614         }
 615
 616         /**
 617          * Get handler-specific metadata
 618          * Overridden by LocalFile, UnregisteredLocalFile
 619          * STUB
 620          * @return bool|array
 621          */
 622         public function getMetadata() {
 623                 return false;
 624         }
 625
 626         /**
 627          * Like getMetadata but returns a handler independent array of common values.
 628          * @see MediaHandler::getCommonMetaArray()
 629          * @return array|bool Array or false if not supported
 630          * @since 1.23
 631          */
 632         public function getCommonMetaArray() {
 633                 $handler = $this->getHandler();
 634
 635                 if ( !$handler ) {
 636                         return false;
 637                 }
 638
 639                 return $handler->getCommonMetaArray( $this );
 640         }
 641
 642         /**
 643          * get versioned metadata
 644          *
 645          * @param array|string $metadata Array or string of (serialized) metadata
 646          * @param int $version Version number.
 647          * @return array Array containing metadata, or what was passed to it on fail
 648          *   (unserializing if not array)
 649          */
 650         public function convertMetadataVersion( $metadata, $version ) {
 651                 $handler = $this->getHandler();
 652                 if ( !is_array( $metadata ) ) {
 653                         // Just to make the return type consistent
 654                         $metadata = unserialize( $metadata );
 655                 }
 656                 if ( $handler ) {
 657                         return $handler->convertMetadataVersion( $metadata, $version );
 658                 } else {
 659                         return $metadata;
 660                 }
 661         }
 662
 663         /**
 664          * Return the bit depth of the file
 665          * Overridden by LocalFile
 666          * STUB
 667          * @return int
 668          */
 669         public function getBitDepth() {
 670                 return 0;
 671         }
 672
 673         /**
 674          * Return the size of the image file, in bytes
 675          * Overridden by LocalFile, UnregisteredLocalFile
 676          * STUB
 677          * @return bool
 678          */
 679         public function getSize() {
 680                 return false;
 681         }
 682
 683         /**
 684          * Returns the MIME type of the file.
 685          * Overridden by LocalFile, UnregisteredLocalFile
 686          * STUB
 687          *
 688          * @return string
 689          */
 690         function getMimeType() {
 691                 return 'unknown/unknown';
 692         }
 693
 694         /**
 695          * Return the type of the media in the file.
 696          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 697          * Overridden by LocalFile,
 698          * STUB
 699          * @return string
 700          */
 701         function getMediaType() {
 702                 return MEDIATYPE_UNKNOWN;
 703         }
 704
 705         /**
 706          * Checks if the output of transform() for this file is likely
 707          * to be valid. If this is false, various user elements will
 708          * display a placeholder instead.
 709          *
 710          * Currently, this checks if the file is an image format
 711          * that can be converted to a format
 712          * supported by all browsers (namely GIF, PNG and JPEG),
 713          * or if it is an SVG image and SVG conversion is enabled.
 714          *
 715          * @return bool
 716          */
 717         function canRender() {
 718                 if ( !isset( $this->canRender ) ) {
 719                         $this->canRender = $this->getHandler() && $this->handler->canRender( $this ) && $this->exists();
 720                 }
 721
 722                 return $this->canRender;
 723         }
 724
 725         /**
 726          * Accessor for __get()
 727          * @return bool
 728          */
 729         protected function getCanRender() {
 730                 return $this->canRender();
 731         }
 732
 733         /**
 734          * Return true if the file is of a type that can't be directly
 735          * rendered by typical browsers and needs to be re-rasterized.
 736          *
 737          * This returns true for everything but the bitmap types
 738          * supported by all browsers, i.e. JPEG; GIF and PNG. It will
 739          * also return true for any non-image formats.
 740          *
 741          * @return bool
 742          */
 743         function mustRender() {
 744                 return $this->getHandler() && $this->handler->mustRender( $this );
 745         }
 746
 747         /**
 748          * Alias for canRender()
 749          *
 750          * @return bool
 751          */
 752         function allowInlineDisplay() {
 753                 return $this->canRender();
 754         }
 755
 756         /**
 757          * Determines if this media file is in a format that is unlikely to
 758          * contain viruses or malicious content. It uses the global
 759          * $wgTrustedMediaFormats list to determine if the file is safe.
 760          *
 761          * This is used to show a warning on the description page of non-safe files.
 762          * It may also be used to disallow direct [[media:...]] links to such files.
 763          *
 764          * Note that this function will always return true if allowInlineDisplay()
 765          * or isTrustedFile() is true for this file.
 766          *
 767          * @return bool
 768          */
 769         function isSafeFile() {
 770                 if ( !isset( $this->isSafeFile ) ) {
 771                         $this->isSafeFile = $this->getIsSafeFileUncached();
 772                 }
 773
 774                 return $this->isSafeFile;
 775         }
 776
 777         /**
 778          * Accessor for __get()
 779          *
 780          * @return bool
 781          */
 782         protected function getIsSafeFile() {
 783                 return $this->isSafeFile();
 784         }
 785
 786         /**
 787          * Uncached accessor
 788          *
 789          * @return bool
 790          */
 791         protected function getIsSafeFileUncached() {
 792                 global $wgTrustedMediaFormats;
 793
 794                 if ( $this->allowInlineDisplay() ) {
 795                         return true;
 796                 }
 797                 if ( $this->isTrustedFile() ) {
 798                         return true;
 799                 }
 800
 801                 $type = $this->getMediaType();
 802                 $mime = $this->getMimeType();
 803                 #wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
 804
 805                 if ( !$type || $type === MEDIATYPE_UNKNOWN ) {
 806                         return false; #unknown type, not trusted
 807                 }
 808                 if ( in_array( $type, $wgTrustedMediaFormats ) ) {
 809                         return true;
 810                 }
 811
 812                 if ( $mime === "unknown/unknown" ) {
 813                         return false; #unknown type, not trusted
 814                 }
 815                 if ( in_array( $mime, $wgTrustedMediaFormats ) ) {
 816                         return true;
 817                 }
 818
 819                 return false;
 820         }
 821
 822         /**
 823          * Returns true if the file is flagged as trusted. Files flagged that way
 824          * can be linked to directly, even if that is not allowed for this type of
 825          * file normally.
 826          *
 827          * This is a dummy function right now and always returns false. It could be
 828          * implemented to extract a flag from the database. The trusted flag could be
 829          * set on upload, if the user has sufficient privileges, to bypass script-
 830          * and html-filters. It may even be coupled with cryptographics signatures
 831          * or such.
 832          *
 833          * @return bool
 834          */
 835         function isTrustedFile() {
 836                 #this could be implemented to check a flag in the database,
 837                 #look for signatures, etc
 838                 return false;
 839         }
 840
 841         /**
 842          * Returns true if file exists in the repository.
 843          *
 844          * Overridden by LocalFile to avoid unnecessary stat calls.
 845          *
 846          * @return bool Whether file exists in the repository.
 847          */
 848         public function exists() {
 849                 return $this->getPath() && $this->repo->fileExists( $this->path );
 850         }
 851
 852         /**
 853          * Returns true if file exists in the repository and can be included in a page.
 854          * It would be unsafe to include private images, making public thumbnails inadvertently
 855          *
 856          * @return bool Whether file exists in the repository and is includable.
 857          */
 858         public function isVisible() {
 859                 return $this->exists();
 860         }
 861
 862         /**
 863          * @return string
 864          */
 865         function getTransformScript() {
 866                 if ( !isset( $this->transformScript ) ) {
 867                         $this->transformScript = false;
 868                         if ( $this->repo ) {
 869                                 $script = $this->repo->getThumbScriptUrl();
 870                                 if ( $script ) {
 871                                         $this->transformScript = wfAppendQuery( $script, array( 'f' => $this->getName() ) );
 872                                 }
 873                         }
 874                 }
 875
 876                 return $this->transformScript;
 877         }
 878
 879         /**
 880          * Get a ThumbnailImage which is the same size as the source
 881          *
 882          * @param array $handlerParams
 883          *
 884          * @return string
 885          */
 886         function getUnscaledThumb( $handlerParams = array() ) {
 887                 $hp =& $handlerParams;
 888                 $page = isset( $hp['page'] ) ? $hp['page'] : false;
 889                 $width = $this->getWidth( $page );
 890                 if ( !$width ) {
 891                         return $this->iconThumb();
 892                 }
 893                 $hp['width'] = $width;
 894                 // be sure to ignore any height specification as well (bug 62258)
 895                 unset( $hp['height'] );
 896
 897                 return $this->transform( $hp );
 898         }
 899
 900         /**
 901          * Return the file name of a thumbnail with the specified parameters.
 902          * Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>".
 903          * Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
 904          *
 905          * @param array $params Handler-specific parameters
 906          * @param int $flags Bitfield that supports THUMB_* constants
 907          * @return string
 908          */
 909         public function thumbName( $params, $flags = 0 ) {
 910                 $name = ( $this->repo && !( $flags & self::THUMB_FULL_NAME ) )
 911                         ? $this->repo->nameForThumb( $this->getName() )
 912                         : $this->getName();
 913
 914                 return $this->generateThumbName( $name, $params );
 915         }
 916
 917         /**
 918          * Generate a thumbnail file name from a name and specified parameters
 919          *
 920          * @param string $name
 921          * @param array $params Parameters which will be passed to MediaHandler::makeParamString
 922          * @return string
 923          */
 924         public function generateThumbName( $name, $params ) {
 925                 if ( !$this->getHandler() ) {
 926                         return null;
 927                 }
 928                 $extension = $this->getExtension();
 929                 list( $thumbExt, ) = $this->getHandler()->getThumbType(
 930                         $extension, $this->getMimeType(), $params );
 931                 $thumbName = $this->getHandler()->makeParamString( $params ) . '-' . $name;
 932                 if ( $thumbExt != $extension ) {
 933                         $thumbName .= ".$thumbExt";
 934                 }
 935
 936                 return $thumbName;
 937         }
 938
 939         /**
 940          * Create a thumbnail of the image having the specified width/height.
 941          * The thumbnail will not be created if the width is larger than the
 942          * image's width. Let the browser do the scaling in this case.
 943          * The thumbnail is stored on disk and is only computed if the thumbnail
 944          * file does not exist OR if it is older than the image.
 945          * Returns the URL.
 946          *
 947          * Keeps aspect ratio of original image. If both width and height are
 948          * specified, the generated image will be no bigger than width x height,
 949          * and will also have correct aspect ratio.
 950          *
 951          * @param int $width Maximum width of the generated thumbnail
 952          * @param int $height Maximum height of the image (optional)
 953          *
 954          * @return string
 955          */
 956         public function createThumb( $width, $height = -1 ) {
 957                 $params = array( 'width' => $width );
 958                 if ( $height != -1 ) {
 959                         $params['height'] = $height;
 960                 }
 961                 $thumb = $this->transform( $params );
 962                 if ( !$thumb || $thumb->isError() ) {
 963                         return '';
 964                 }
 965
 966                 return $thumb->getUrl();
 967         }
 968
 969         /**
 970          * Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
 971          *
 972          * @param string $thumbPath Thumbnail storage path
 973          * @param string $thumbUrl Thumbnail URL
 974          * @param array $params
 975          * @param int $flags
 976          * @return MediaTransformOutput
 977          */
 978         protected function transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags ) {
 979                 global $wgIgnoreImageErrors;
 980
 981                 $handler = $this->getHandler();
 982                 if ( $handler && $wgIgnoreImageErrors && !( $flags & self::RENDER_NOW ) ) {
 983                         return $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
 984                 } else {
 985                         return new MediaTransformError( 'thumbnail_error',
 986                                 $params['width'], 0, wfMessage( 'thumbnail-dest-create' )->text() );
 987                 }
 988         }
 989
 990         /**
 991          * Transform a media file
 992          *
 993          * @param array $params An associative array of handler-specific parameters.
 994          *   Typical keys are width, height and page.
 995          * @param int $flags A bitfield, may contain self::RENDER_NOW to force rendering
 996          * @return MediaTransformOutput|bool False on failure
 997          */
 998         function transform( $params, $flags = 0 ) {
 999                 global $wgThumbnailEpoch;
1000
1001                 do {
1002                         if ( !$this->canRender() ) {
1003                                 $thumb = $this->iconThumb();
1004                                 break; // not a bitmap or renderable image, don't try
1005                         }
1006
1007                         // Get the descriptionUrl to embed it as comment into the thumbnail. Bug 19791.
1008                         $descriptionUrl = $this->getDescriptionUrl();
1009                         if ( $descriptionUrl ) {
1010                                 $params['descriptionUrl'] = wfExpandUrl( $descriptionUrl, PROTO_CANONICAL );
1011                         }
1012
1013                         $handler = $this->getHandler();
1014                         $script = $this->getTransformScript();
1015                         if ( $script && !( $flags & self::RENDER_NOW ) ) {
1016                                 // Use a script to transform on client request, if possible
1017                                 $thumb = $handler->getScriptedTransform( $this, $script, $params );
1018                                 if ( $thumb ) {
1019                                         break;
1020                                 }
1021                         }
1022
1023                         $normalisedParams = $params;
1024                         $handler->normaliseParams( $this, $normalisedParams );
1025
1026                         $thumbName = $this->thumbName( $normalisedParams );
1027                         $thumbUrl = $this->getThumbUrl( $thumbName );
1028                         $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1029
1030                         if ( $this->repo ) {
1031                                 // Defer rendering if a 404 handler is set up...
1032                                 if ( $this->repo->canTransformVia404() && !( $flags & self::RENDER_NOW ) ) {
1033                                         wfDebug( __METHOD__ . " transformation deferred.\n" );
1034                                         // XXX: Pass in the storage path even though we are not rendering anything
1035                                         // and the path is supposed to be an FS path. This is due to getScalerType()
1036                                         // getting called on the path and clobbering $thumb->getUrl() if it's false.
1037                                         $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1038                                         break;
1039                                 }
1040                                 // Check if an up-to-date thumbnail already exists...
1041                                 wfDebug( __METHOD__ . ": Doing stat for $thumbPath\n" );
1042                                 if ( !( $flags & self::RENDER_FORCE ) && $this->repo->fileExists( $thumbPath ) ) {
1043                                         $timestamp = $this->repo->getFileTimestamp( $thumbPath );
1044                                         if ( $timestamp !== false && $timestamp >= $wgThumbnailEpoch ) {
1045                                                 // XXX: Pass in the storage path even though we are not rendering anything
1046                                                 // and the path is supposed to be an FS path. This is due to getScalerType()
1047                                                 // getting called on the path and clobbering $thumb->getUrl() if it's false.
1048                                                 $thumb = $handler->getTransform( $this, $thumbPath, $thumbUrl, $params );
1049                                                 $thumb->setStoragePath( $thumbPath );
1050                                                 break;
1051                                         }
1052                                 } elseif ( $flags & self::RENDER_FORCE ) {
1053                                         wfDebug( __METHOD__ . " forcing rendering per flag File::RENDER_FORCE\n" );
1054                                 }
1055
1056                                 // If the backend is ready-only, don't keep generating thumbnails
1057                                 // only to return transformation errors, just return the error now.
1058                                 if ( $this->repo->getReadOnlyReason() !== false ) {
1059                                         $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1060                                         break;
1061                                 }
1062                         }
1063
1064                         $tmpFile = $this->makeTransformTmpFile( $thumbPath );
1065
1066                         if ( !$tmpFile ) {
1067                                 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags );
1068                         } else {
1069                                 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1070                         }
1071                 } while ( false );
1072
1073
1074                 return is_object( $thumb ) ? $thumb : false;
1075         }
1076
1077         /**
1078          * Generates a thumbnail according to the given parameters and saves it to storage
1079          * @param TempFSFile $tmpFile Temporary file where the rendered thumbnail will be saved
1080          * @param array $transformParams
1081          * @param int $flags
1082          * @return bool|MediaTransformOutput
1083          */
1084         public function generateAndSaveThumb( $tmpFile, $transformParams, $flags ) {
1085                 global $wgUseSquid, $wgIgnoreImageErrors;
1086
1087                 $handler = $this->getHandler();
1088
1089                 $normalisedParams = $transformParams;
1090                 $handler->normaliseParams( $this, $normalisedParams );
1091
1092                 $thumbName = $this->thumbName( $normalisedParams );
1093                 $thumbUrl = $this->getThumbUrl( $thumbName );
1094                 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1095
1096                 $tmpThumbPath = $tmpFile->getPath();
1097
1098                 if ( $handler->supportsBucketing() ) {
1099                         $this->generateBucketsIfNeeded( $normalisedParams, $flags );
1100                 }
1101
1102                 // Actually render the thumbnail...
1103                 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1104                 $tmpFile->bind( $thumb ); // keep alive with $thumb
1105
1106                 if ( !$thumb ) { // bad params?
1107                         $thumb = false;
1108                 } elseif ( $thumb->isError() ) { // transform error
1109                         $this->lastError = $thumb->toText();
1110                         // Ignore errors if requested
1111                         if ( $wgIgnoreImageErrors && !( $flags & self::RENDER_NOW ) ) {
1112                                 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1113                         }
1114                 } elseif ( $this->repo && $thumb->hasFile() && !$thumb->fileIsSource() ) {
1115                         // Copy the thumbnail from the file system into storage...
1116                         $disposition = $this->getThumbDisposition( $thumbName );
1117                         $status = $this->repo->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1118                         if ( $status->isOK() ) {
1119                                 $thumb->setStoragePath( $thumbPath );
1120                         } else {
1121                                 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $transformParams, $flags );
1122                         }
1123                         // Give extensions a chance to do something with this thumbnail...
1124                         Hooks::run( 'FileTransformed', array( $this, $thumb, $tmpThumbPath, $thumbPath ) );
1125                 }
1126
1127                 // Purge. Useful in the event of Core -> Squid connection failure or squid
1128                 // purge collisions from elsewhere during failure. Don't keep triggering for
1129                 // "thumbs" which have the main image URL though (bug 13776)
1130                 if ( $wgUseSquid ) {
1131                         if ( !$thumb || $thumb->isError() || $thumb->getUrl() != $this->getURL() ) {
1132                                 SquidUpdate::purge( array( $thumbUrl ) );
1133                         }
1134                 }
1135
1136                 return $thumb;
1137         }
1138
1139         /**
1140          * Generates chained bucketed thumbnails if needed
1141          * @param array $params
1142          * @param int $flags
1143          * @return bool Whether at least one bucket was generated
1144          */
1145         protected function generateBucketsIfNeeded( $params, $flags = 0 ) {
1146                 if ( !$this->repo
1147                         || !isset( $params['physicalWidth'] )
1148                         || !isset( $params['physicalHeight'] )
1149                         || !( $bucket = $this->getThumbnailBucket( $params['physicalWidth'] ) )
1150                         || $bucket == $params['physicalWidth'] ) {
1151                         return false;
1152                 }
1153
1154                 $bucketPath = $this->getBucketThumbPath( $bucket );
1155
1156                 if ( $this->repo->fileExists( $bucketPath ) ) {
1157                         return false;
1158                 }
1159
1160                 $params['physicalWidth'] = $bucket;
1161                 $params['width'] = $bucket;
1162
1163                 $params = $this->getHandler()->sanitizeParamsForBucketing( $params );
1164
1165                 $bucketName = $this->getBucketThumbName( $bucket );
1166
1167                 $tmpFile = $this->makeTransformTmpFile( $bucketPath );
1168
1169                 if ( !$tmpFile ) {
1170                         return false;
1171                 }
1172
1173                 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1174
1175                 if ( !$thumb || $thumb->isError() ) {
1176                         return false;
1177                 }
1178
1179                 $this->tmpBucketedThumbCache[$bucket] = $tmpFile->getPath();
1180                 // For the caching to work, we need to make the tmp file survive as long as
1181                 // this object exists
1182                 $tmpFile->bind( $this );
1183
1184                 return true;
1185         }
1186
1187         /**
1188          * Returns the most appropriate source image for the thumbnail, given a target thumbnail size
1189          * @param array $params
1190          * @return array Source path and width/height of the source
1191          */
1192         public function getThumbnailSource( $params ) {
1193                 if ( $this->repo
1194                         && $this->getHandler()->supportsBucketing()
1195                         && isset( $params['physicalWidth'] )
1196                         && $bucket = $this->getThumbnailBucket( $params['physicalWidth'] )
1197                 ) {
1198                         if ( $this->getWidth() != 0 ) {
1199                                 $bucketHeight = round( $this->getHeight() * ( $bucket / $this->getWidth() ) );
1200                         } else {
1201                                 $bucketHeight = 0;
1202                         }
1203
1204                         // Try to avoid reading from storage if the file was generated by this script
1205                         if ( isset( $this->tmpBucketedThumbCache[$bucket] ) ) {
1206                                 $tmpPath = $this->tmpBucketedThumbCache[$bucket];
1207
1208                                 if ( file_exists( $tmpPath ) ) {
1209                                         return array(
1210                                                 'path' => $tmpPath,
1211                                                 'width' => $bucket,
1212                                                 'height' => $bucketHeight
1213                                         );
1214                                 }
1215                         }
1216
1217                         $bucketPath = $this->getBucketThumbPath( $bucket );
1218
1219                         if ( $this->repo->fileExists( $bucketPath ) ) {
1220                                 $fsFile = $this->repo->getLocalReference( $bucketPath );
1221
1222                                 if ( $fsFile ) {
1223                                         return array(
1224                                                 'path' => $fsFile->getPath(),
1225                                                 'width' => $bucket,
1226                                                 'height' => $bucketHeight
1227                                         );
1228                                 }
1229                         }
1230                 }
1231
1232                 // Thumbnailing a very large file could result in network saturation if
1233                 // everyone does it at once.
1234                 if ( $this->getSize() >= 1e7 ) { // 10MB
1235                         $that = $this;
1236                         $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $this->getName() ),
1237                                 array(
1238                                         'doWork' => function () use ( $that ) {
1239                                                 return $that->getLocalRefPath();
1240                                         }
1241                                 )
1242                         );
1243                         $srcPath = $work->execute();
1244                 } else {
1245                         $srcPath = $this->getLocalRefPath();
1246                 }
1247
1248                 // Original file
1249                 return array(
1250                         'path' => $srcPath,
1251                         'width' => $this->getWidth(),
1252                         'height' => $this->getHeight()
1253                 );
1254         }
1255
1256         /**
1257          * Returns the repo path of the thumb for a given bucket
1258          * @param int $bucket
1259          * @return string
1260          */
1261         protected function getBucketThumbPath( $bucket ) {
1262                 $thumbName = $this->getBucketThumbName( $bucket );
1263                 return $this->getThumbPath( $thumbName );
1264         }
1265
1266         /**
1267          * Returns the name of the thumb for a given bucket
1268          * @param int $bucket
1269          * @return string
1270          */
1271         protected function getBucketThumbName( $bucket ) {
1272                 return $this->thumbName( array( 'physicalWidth' => $bucket ) );
1273         }
1274
1275         /**
1276          * Creates a temp FS file with the same extension and the thumbnail
1277          * @param string $thumbPath Thumbnail path
1278          * @return TempFSFile
1279          */
1280         protected function makeTransformTmpFile( $thumbPath ) {
1281                 $thumbExt = FileBackend::extensionFromPath( $thumbPath );
1282                 return TempFSFile::factory( 'transform_', $thumbExt );
1283         }
1284
1285         /**
1286          * @param string $thumbName Thumbnail name
1287          * @param string $dispositionType Type of disposition (either "attachment" or "inline")
1288          * @return string Content-Disposition header value
1289          */
1290         function getThumbDisposition( $thumbName, $dispositionType = 'inline' ) {
1291                 $fileName = $this->name; // file name to suggest
1292                 $thumbExt = FileBackend::extensionFromPath( $thumbName );
1293                 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1294                         $fileName .= ".$thumbExt";
1295                 }
1296
1297                 return FileBackend::makeContentDisposition( $dispositionType, $fileName );
1298         }
1299
1300         /**
1301          * Hook into transform() to allow migration of thumbnail files
1302          * STUB
1303          * Overridden by LocalFile
1304          * @param string $thumbName
1305          */
1306         function migrateThumbFile( $thumbName ) {
1307         }
1308
1309         /**
1310          * Get a MediaHandler instance for this file
1311          *
1312          * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1313          *   or false if none found
1314          */
1315         function getHandler() {
1316                 if ( !isset( $this->handler ) ) {
1317                         $this->handler = MediaHandler::getHandler( $this->getMimeType() );
1318                 }
1319
1320                 return $this->handler;
1321         }
1322
1323         /**
1324          * Get a ThumbnailImage representing a file type icon
1325          *
1326          * @return ThumbnailImage
1327          */
1328         function iconThumb() {
1329                 global $wgResourceBasePath, $IP;
1330                 $assetsPath = "$wgResourceBasePath/resources/assets/file-type-icons/";
1331                 $assetsDirectory = "$IP/resources/assets/file-type-icons/";
1332
1333                 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
1334                 foreach ( $try as $icon ) {
1335                         if ( file_exists( $assetsDirectory . $icon ) ) { // always FS
1336                                 $params = array( 'width' => 120, 'height' => 120 );
1337
1338                                 return new ThumbnailImage( $this, $assetsPath . $icon, false, $params );
1339                         }
1340                 }
1341
1342                 return null;
1343         }
1344
1345         /**
1346          * Get last thumbnailing error.
1347          * Largely obsolete.
1348          * @return string
1349          */
1350         function getLastError() {
1351                 return $this->lastError;
1352         }
1353
1354         /**
1355          * Get all thumbnail names previously generated for this file
1356          * STUB
1357          * Overridden by LocalFile
1358          * @return array
1359          */
1360         function getThumbnails() {
1361                 return array();
1362         }
1363
1364         /**
1365          * Purge shared caches such as thumbnails and DB data caching
1366          * STUB
1367          * Overridden by LocalFile
1368          * @param array $options Options, which include:
1369          *   'forThumbRefresh' : The purging is only to refresh thumbnails
1370          */
1371         function purgeCache( $options = array() ) {
1372         }
1373
1374         /**
1375          * Purge the file description page, but don't go after
1376          * pages using the file. Use when modifying file history
1377          * but not the current data.
1378          */
1379         function purgeDescription() {
1380                 $title = $this->getTitle();
1381                 if ( $title ) {
1382                         $title->invalidateCache();
1383                         $title->purgeSquid();
1384                 }
1385         }
1386
1387         /**
1388          * Purge metadata and all affected pages when the file is created,
1389          * deleted, or majorly updated.
1390          */
1391         function purgeEverything() {
1392                 // Delete thumbnails and refresh file metadata cache
1393                 $this->purgeCache();
1394                 $this->purgeDescription();
1395
1396                 // Purge cache of all pages using this file
1397                 $title = $this->getTitle();
1398                 if ( $title ) {
1399                         $update = new HTMLCacheUpdate( $title, 'imagelinks' );
1400                         $update->doUpdate();
1401                 }
1402         }
1403
1404         /**
1405          * Return a fragment of the history of file.
1406          *
1407          * STUB
1408          * @param int $limit Limit of rows to return
1409          * @param string $start Only revisions older than $start will be returned
1410          * @param string $end Only revisions newer than $end will be returned
1411          * @param bool $inc Include the endpoints of the time range
1412          *
1413          * @return array
1414          */
1415         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1416                 return array();
1417         }
1418
1419         /**
1420          * Return the history of this file, line by line. Starts with current version,
1421          * then old versions. Should return an object similar to an image/oldimage
1422          * database row.
1423          *
1424          * STUB
1425          * Overridden in LocalFile
1426          * @return bool
1427          */
1428         public function nextHistoryLine() {
1429                 return false;
1430         }
1431
1432         /**
1433          * Reset the history pointer to the first element of the history.
1434          * Always call this function after using nextHistoryLine() to free db resources
1435          * STUB
1436          * Overridden in LocalFile.
1437          */
1438         public function resetHistory() {
1439         }
1440
1441         /**
1442          * Get the filename hash component of the directory including trailing slash,
1443          * e.g. f/fa/
1444          * If the repository is not hashed, returns an empty string.
1445          *
1446          * @return string
1447          */
1448         function getHashPath() {
1449                 if ( !isset( $this->hashPath ) ) {
1450                         $this->assertRepoDefined();
1451                         $this->hashPath = $this->repo->getHashPath( $this->getName() );
1452                 }
1453
1454                 return $this->hashPath;
1455         }
1456
1457         /**
1458          * Get the path of the file relative to the public zone root.
1459          * This function is overridden in OldLocalFile to be like getArchiveRel().
1460          *
1461          * @return string
1462          */
1463         function getRel() {
1464                 return $this->getHashPath() . $this->getName();
1465         }
1466
1467         /**
1468          * Get the path of an archived file relative to the public zone root
1469          *
1470          * @param bool|string $suffix If not false, the name of an archived thumbnail file
1471          *
1472          * @return string
1473          */
1474         function getArchiveRel( $suffix = false ) {
1475                 $path = 'archive/' . $this->getHashPath();
1476                 if ( $suffix === false ) {
1477                         $path = substr( $path, 0, -1 );
1478                 } else {
1479                         $path .= $suffix;
1480                 }
1481
1482                 return $path;
1483         }
1484
1485         /**
1486          * Get the path, relative to the thumbnail zone root, of the
1487          * thumbnail directory or a particular file if $suffix is specified
1488          *
1489          * @param bool|string $suffix If not false, the name of a thumbnail file
1490          * @return string
1491          */
1492         function getThumbRel( $suffix = false ) {
1493                 $path = $this->getRel();
1494                 if ( $suffix !== false ) {
1495                         $path .= '/' . $suffix;
1496                 }
1497
1498                 return $path;
1499         }
1500
1501         /**
1502          * Get urlencoded path of the file relative to the public zone root.
1503          * This function is overridden in OldLocalFile to be like getArchiveUrl().
1504          *
1505          * @return string
1506          */
1507         function getUrlRel() {
1508                 return $this->getHashPath() . rawurlencode( $this->getName() );
1509         }
1510
1511         /**
1512          * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1513          * or a specific thumb if the $suffix is given.
1514          *
1515          * @param string $archiveName The timestamped name of an archived image
1516          * @param bool|string $suffix If not false, the name of a thumbnail file
1517          * @return string
1518          */
1519         function getArchiveThumbRel( $archiveName, $suffix = false ) {
1520                 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1521                 if ( $suffix === false ) {
1522                         $path = substr( $path, 0, -1 );
1523                 } else {
1524                         $path .= $suffix;
1525                 }
1526
1527                 return $path;
1528         }
1529
1530         /**
1531          * Get the path of the archived file.
1532          *
1533          * @param bool|string $suffix If not false, the name of an archived file.
1534          * @return string
1535          */
1536         function getArchivePath( $suffix = false ) {
1537                 $this->assertRepoDefined();
1538
1539                 return $this->repo->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1540         }
1541
1542         /**
1543          * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1544          *
1545          * @param string $archiveName The timestamped name of an archived image
1546          * @param bool|string $suffix If not false, the name of a thumbnail file
1547          * @return string
1548          */
1549         function getArchiveThumbPath( $archiveName, $suffix = false ) {
1550                 $this->assertRepoDefined();
1551
1552                 return $this->repo->getZonePath( 'thumb' ) . '/' .
1553                 $this->getArchiveThumbRel( $archiveName, $suffix );
1554         }
1555
1556         /**
1557          * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1558          *
1559          * @param bool|string $suffix If not false, the name of a thumbnail file
1560          * @return string
1561          */
1562         function getThumbPath( $suffix = false ) {
1563                 $this->assertRepoDefined();
1564
1565                 return $this->repo->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1566         }
1567
1568         /**
1569          * Get the path of the transcoded directory, or a particular file if $suffix is specified
1570          *
1571          * @param bool|string $suffix If not false, the name of a media file
1572          * @return string
1573          */
1574         function getTranscodedPath( $suffix = false ) {
1575                 $this->assertRepoDefined();
1576
1577                 return $this->repo->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1578         }
1579
1580         /**
1581          * Get the URL of the archive directory, or a particular file if $suffix is specified
1582          *
1583          * @param bool|string $suffix If not false, the name of an archived file
1584          * @return string
1585          */
1586         function getArchiveUrl( $suffix = false ) {
1587                 $this->assertRepoDefined();
1588                 $ext = $this->getExtension();
1589                 $path = $this->repo->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1590                 if ( $suffix === false ) {
1591                         $path = substr( $path, 0, -1 );
1592                 } else {
1593                         $path .= rawurlencode( $suffix );
1594                 }
1595
1596                 return $path;
1597         }
1598
1599         /**
1600          * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1601          *
1602          * @param string $archiveName The timestamped name of an archived image
1603          * @param bool|string $suffix If not false, the name of a thumbnail file
1604          * @return string
1605          */
1606         function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1607                 $this->assertRepoDefined();
1608                 $ext = $this->getExtension();
1609                 $path = $this->repo->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1610                         $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1611                 if ( $suffix === false ) {
1612                         $path = substr( $path, 0, -1 );
1613                 } else {
1614                         $path .= rawurlencode( $suffix );
1615                 }
1616
1617                 return $path;
1618         }
1619
1620         /**
1621          * Get the URL of the zone directory, or a particular file if $suffix is specified
1622          *
1623          * @param string $zone Name of requested zone
1624          * @param bool|string $suffix If not false, the name of a file in zone
1625          * @return string Path
1626          */
1627         function getZoneUrl( $zone, $suffix = false ) {
1628                 $this->assertRepoDefined();
1629                 $ext = $this->getExtension();
1630                 $path = $this->repo->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1631                 if ( $suffix !== false ) {
1632                         $path .= '/' . rawurlencode( $suffix );
1633                 }
1634
1635                 return $path;
1636         }
1637
1638         /**
1639          * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1640          *
1641          * @param bool|string $suffix If not false, the name of a thumbnail file
1642          * @return string Path
1643          */
1644         function getThumbUrl( $suffix = false ) {
1645                 return $this->getZoneUrl( 'thumb', $suffix );
1646         }
1647
1648         /**
1649          * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1650          *
1651          * @param bool|string $suffix If not false, the name of a media file
1652          * @return string Path
1653          */
1654         function getTranscodedUrl( $suffix = false ) {
1655                 return $this->getZoneUrl( 'transcoded', $suffix );
1656         }
1657
1658         /**
1659          * Get the public zone virtual URL for a current version source file
1660          *
1661          * @param bool|string $suffix If not false, the name of a thumbnail file
1662          * @return string
1663          */
1664         function getVirtualUrl( $suffix = false ) {
1665                 $this->assertRepoDefined();
1666                 $path = $this->repo->getVirtualUrl() . '/public/' . $this->getUrlRel();
1667                 if ( $suffix !== false ) {
1668                         $path .= '/' . rawurlencode( $suffix );
1669                 }
1670
1671                 return $path;
1672         }
1673
1674         /**
1675          * Get the public zone virtual URL for an archived version source file
1676          *
1677          * @param bool|string $suffix If not false, the name of a thumbnail file
1678          * @return string
1679          */
1680         function getArchiveVirtualUrl( $suffix = false ) {
1681                 $this->assertRepoDefined();
1682                 $path = $this->repo->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1683                 if ( $suffix === false ) {
1684                         $path = substr( $path, 0, -1 );
1685                 } else {
1686                         $path .= rawurlencode( $suffix );
1687                 }
1688
1689                 return $path;
1690         }
1691
1692         /**
1693          * Get the virtual URL for a thumbnail file or directory
1694          *
1695          * @param bool|string $suffix If not false, the name of a thumbnail file
1696          * @return string
1697          */
1698         function getThumbVirtualUrl( $suffix = false ) {
1699                 $this->assertRepoDefined();
1700                 $path = $this->repo->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1701                 if ( $suffix !== false ) {
1702                         $path .= '/' . rawurlencode( $suffix );
1703                 }
1704
1705                 return $path;
1706         }
1707
1708         /**
1709          * @return bool
1710          */
1711         function isHashed() {
1712                 $this->assertRepoDefined();
1713
1714                 return (bool)$this->repo->getHashLevels();
1715         }
1716
1717         /**
1718          * @throws MWException
1719          */
1720         function readOnlyError() {
1721                 throw new MWException( get_class( $this ) . ': write operations are not supported' );
1722         }
1723
1724         /**
1725          * Record a file upload in the upload log and the image table
1726          * STUB
1727          * Overridden by LocalFile
1728          * @param string $oldver
1729          * @param string $desc
1730          * @param string $license
1731          * @param string $copyStatus
1732          * @param string $source
1733          * @param bool $watch
1734          * @param string|bool $timestamp
1735          * @param null|User $user User object or null to use $wgUser
1736          * @return bool
1737          * @throws MWException
1738          */
1739         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1740                 $watch = false, $timestamp = false, User $user = null
1741         ) {
1742                 $this->readOnlyError();
1743         }
1744
1745         /**
1746          * Move or copy a file to its public location. If a file exists at the
1747          * destination, move it to an archive. Returns a FileRepoStatus object with
1748          * the archive name in the "value" member on success.
1749          *
1750          * The archive name should be passed through to recordUpload for database
1751          * registration.
1752          *
1753          * Options to $options include:
1754          *   - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1755          *
1756          * @param string $srcPath Local filesystem path to the source image
1757          * @param int $flags A bitwise combination of:
1758          *   File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1759          * @param array $options Optional additional parameters
1760          * @return FileRepoStatus On success, the value member contains the
1761          *   archive name, or an empty string if it was a new file.
1762          *
1763          * STUB
1764          * Overridden by LocalFile
1765          */
1766         function publish( $srcPath, $flags = 0, array $options = array() ) {
1767                 $this->readOnlyError();
1768         }
1769
1770         /**
1771          * @return bool
1772          */
1773         function formatMetadata() {
1774                 if ( !$this->getHandler() ) {
1775                         return false;
1776                 }
1777
1778                 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
1779         }
1780
1781         /**
1782          * Returns true if the file comes from the local file repository.
1783          *
1784          * @return bool
1785          */
1786         function isLocal() {
1787                 return $this->repo && $this->repo->isLocal();
1788         }
1789
1790         /**
1791          * Returns the name of the repository.
1792          *
1793          * @return string
1794          */
1795         function getRepoName() {
1796                 return $this->repo ? $this->repo->getName() : 'unknown';
1797         }
1798
1799         /**
1800          * Returns the repository
1801          *
1802          * @return FileRepo|LocalRepo|bool
1803          */
1804         function getRepo() {
1805                 return $this->repo;
1806         }
1807
1808         /**
1809          * Returns true if the image is an old version
1810          * STUB
1811          *
1812          * @return bool
1813          */
1814         function isOld() {
1815                 return false;
1816         }
1817
1818         /**
1819          * Is this file a "deleted" file in a private archive?
1820          * STUB
1821          *
1822          * @param int $field One of DELETED_* bitfield constants
1823          * @return bool
1824          */
1825         function isDeleted( $field ) {
1826                 return false;
1827         }
1828
1829         /**
1830          * Return the deletion bitfield
1831          * STUB
1832          * @return int
1833          */
1834         function getVisibility() {
1835                 return 0;
1836         }
1837
1838         /**
1839          * Was this file ever deleted from the wiki?
1840          *
1841          * @return bool
1842          */
1843         function wasDeleted() {
1844                 $title = $this->getTitle();
1845
1846                 return $title && $title->isDeletedQuick();
1847         }
1848
1849         /**
1850          * Move file to the new title
1851          *
1852          * Move current, old version and all thumbnails
1853          * to the new filename. Old file is deleted.
1854          *
1855          * Cache purging is done; checks for validity
1856          * and logging are caller's responsibility
1857          *
1858          * @param Title $target New file name
1859          * @return FileRepoStatus
1860          */
1861         function move( $target ) {
1862                 $this->readOnlyError();
1863         }
1864
1865         /**
1866          * Delete all versions of the file.
1867          *
1868          * Moves the files into an archive directory (or deletes them)
1869          * and removes the database rows.
1870          *
1871          * Cache purging is done; logging is caller's responsibility.
1872          *
1873          * @param string $reason
1874          * @param bool $suppress Hide content from sysops?
1875          * @param User|null $user
1876          * @return bool Boolean on success, false on some kind of failure
1877          * STUB
1878          * Overridden by LocalFile
1879          */
1880         function delete( $reason, $suppress = false, $user = null ) {
1881                 $this->readOnlyError();
1882         }
1883
1884         /**
1885          * Restore all or specified deleted revisions to the given file.
1886          * Permissions and logging are left to the caller.
1887          *
1888          * May throw database exceptions on error.
1889          *
1890          * @param array $versions Set of record ids of deleted items to restore,
1891          *   or empty to restore all revisions.
1892          * @param bool $unsuppress Remove restrictions on content upon restoration?
1893          * @return int|bool The number of file revisions restored if successful,
1894          *   or false on failure
1895          * STUB
1896          * Overridden by LocalFile
1897          */
1898         function restore( $versions = array(), $unsuppress = false ) {
1899                 $this->readOnlyError();
1900         }
1901
1902         /**
1903          * Returns 'true' if this file is a type which supports multiple pages,
1904          * e.g. DJVU or PDF. Note that this may be true even if the file in
1905          * question only has a single page.
1906          *
1907          * @return bool
1908          */
1909         function isMultipage() {
1910                 return $this->getHandler() && $this->handler->isMultiPage( $this );
1911         }
1912
1913         /**
1914          * Returns the number of pages of a multipage document, or false for
1915          * documents which aren't multipage documents
1916          *
1917          * @return bool|int
1918          */
1919         function pageCount() {
1920                 if ( !isset( $this->pageCount ) ) {
1921                         if ( $this->getHandler() && $this->handler->isMultiPage( $this ) ) {
1922                                 $this->pageCount = $this->handler->pageCount( $this );
1923                         } else {
1924                                 $this->pageCount = false;
1925                         }
1926                 }
1927
1928                 return $this->pageCount;
1929         }
1930
1931         /**
1932          * Calculate the height of a thumbnail using the source and destination width
1933          *
1934          * @param int $srcWidth
1935          * @param int $srcHeight
1936          * @param int $dstWidth
1937          *
1938          * @return int
1939          */
1940         static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1941                 // Exact integer multiply followed by division
1942                 if ( $srcWidth == 0 ) {
1943                         return 0;
1944                 } else {
1945                         return round( $srcHeight * $dstWidth / $srcWidth );
1946                 }
1947         }
1948
1949         /**
1950          * Get an image size array like that returned by getImageSize(), or false if it
1951          * can't be determined. Loads the image size directly from the file ignoring caches.
1952          *
1953          * @note Use getWidth()/getHeight() instead of this method unless you have a
1954          *  a good reason. This method skips all caches.
1955          *
1956          * @param string $filePath The path to the file (e.g. From getLocalPathRef() )
1957          * @return array The width, followed by height, with optionally more things after
1958          */
1959         function getImageSize( $filePath ) {
1960                 if ( !$this->getHandler() ) {
1961                         return false;
1962                 }
1963
1964                 return $this->getHandler()->getImageSize( $this, $filePath );
1965         }
1966
1967         /**
1968          * Get the URL of the image description page. May return false if it is
1969          * unknown or not applicable.
1970          *
1971          * @return string
1972          */
1973         function getDescriptionUrl() {
1974                 if ( $this->repo ) {
1975                         return $this->repo->getDescriptionUrl( $this->getName() );
1976                 } else {
1977                         return false;
1978                 }
1979         }
1980
1981         /**
1982          * Get the HTML text of the description page, if available
1983          *
1984          * @param bool|Language $lang Optional language to fetch description in
1985          * @return string
1986          */
1987         function getDescriptionText( $lang = false ) {
1988                 global $wgMemc, $wgLang;
1989                 if ( !$this->repo || !$this->repo->fetchDescription ) {
1990                         return false;
1991                 }
1992                 if ( !$lang ) {
1993                         $lang = $wgLang;
1994                 }
1995                 $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
1996                 if ( $renderUrl ) {
1997                         if ( $this->repo->descriptionCacheExpiry > 0 ) {
1998                                 wfDebug( "Attempting to get the description from cache..." );
1999                                 $key = $this->repo->getLocalCacheKey(
2000                                         'RemoteFileDescription',
2001                                         'url',
2002                                         $lang->getCode(),
2003                                         $this->getName()
2004                                 );
2005                                 $obj = $wgMemc->get( $key );
2006                                 if ( $obj ) {
2007                                         wfDebug( "success!\n" );
2008
2009                                         return $obj;
2010                                 }
2011                                 wfDebug( "miss\n" );
2012                         }
2013                         wfDebug( "Fetching shared description from $renderUrl\n" );
2014                         $res = Http::get( $renderUrl );
2015                         if ( $res && $this->repo->descriptionCacheExpiry > 0 ) {
2016                                 $wgMemc->set( $key, $res, $this->repo->descriptionCacheExpiry );
2017                         }
2018
2019                         return $res;
2020                 } else {
2021                         return false;
2022                 }
2023         }
2024
2025         /**
2026          * Get description of file revision
2027          * STUB
2028          *
2029          * @param int $audience One of:
2030          *   File::FOR_PUBLIC       to be displayed to all users
2031          *   File::FOR_THIS_USER    to be displayed to the given user
2032          *   File::RAW              get the description regardless of permissions
2033          * @param User $user User object to check for, only if FOR_THIS_USER is
2034          *   passed to the $audience parameter
2035          * @return string
2036          */
2037         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
2038                 return null;
2039         }
2040
2041         /**
2042          * Get the 14-character timestamp of the file upload
2043          *
2044          * @return string|bool TS_MW timestamp or false on failure
2045          */
2046         function getTimestamp() {
2047                 $this->assertRepoDefined();
2048
2049                 return $this->repo->getFileTimestamp( $this->getPath() );
2050         }
2051
2052         /**
2053          * Get the SHA-1 base 36 hash of the file
2054          *
2055          * @return string
2056          */
2057         function getSha1() {
2058                 $this->assertRepoDefined();
2059
2060                 return $this->repo->getFileSha1( $this->getPath() );
2061         }
2062
2063         /**
2064          * Get the deletion archive key, "<sha1>.<ext>"
2065          *
2066          * @return string
2067          */
2068         function getStorageKey() {
2069                 $hash = $this->getSha1();
2070                 if ( !$hash ) {
2071                         return false;
2072                 }
2073                 $ext = $this->getExtension();
2074                 $dotExt = $ext === '' ? '' : ".$ext";
2075
2076                 return $hash . $dotExt;
2077         }
2078
2079         /**
2080          * Determine if the current user is allowed to view a particular
2081          * field of this file, if it's marked as deleted.
2082          * STUB
2083          * @param int $field
2084          * @param User $user User object to check, or null to use $wgUser
2085          * @return bool
2086          */
2087         function userCan( $field, User $user = null ) {
2088                 return true;
2089         }
2090
2091         /**
2092          * @return array HTTP header name/value map to use for HEAD/GET request responses
2093          */
2094         function getStreamHeaders() {
2095                 $handler = $this->getHandler();
2096                 if ( $handler ) {
2097                         return $handler->getStreamHeaders( $this->getMetadata() );
2098                 } else {
2099                         return array();
2100                 }
2101         }
2102
2103         /**
2104          * @return string
2105          */
2106         function getLongDesc() {
2107                 $handler = $this->getHandler();
2108                 if ( $handler ) {
2109                         return $handler->getLongDesc( $this );
2110                 } else {
2111                         return MediaHandler::getGeneralLongDesc( $this );
2112                 }
2113         }
2114
2115         /**
2116          * @return string
2117          */
2118         function getShortDesc() {
2119                 $handler = $this->getHandler();
2120                 if ( $handler ) {
2121                         return $handler->getShortDesc( $this );
2122                 } else {
2123                         return MediaHandler::getGeneralShortDesc( $this );
2124                 }
2125         }
2126
2127         /**
2128          * @return string
2129          */
2130         function getDimensionsString() {
2131                 $handler = $this->getHandler();
2132                 if ( $handler ) {
2133                         return $handler->getDimensionsString( $this );
2134                 } else {
2135                         return '';
2136                 }
2137         }
2138
2139         /**
2140          * @return string
2141          */
2142         function getRedirected() {
2143                 return $this->redirected;
2144         }
2145
2146         /**
2147          * @return Title|null
2148          */
2149         function getRedirectedTitle() {
2150                 if ( $this->redirected ) {
2151                         if ( !$this->redirectTitle ) {
2152                                 $this->redirectTitle = Title::makeTitle( NS_FILE, $this->redirected );
2153                         }
2154
2155                         return $this->redirectTitle;
2156                 }
2157
2158                 return null;
2159         }
2160
2161         /**
2162          * @param string $from
2163          * @return void
2164          */
2165         function redirectedFrom( $from ) {
2166                 $this->redirected = $from;
2167         }
2168
2169         /**
2170          * @return bool
2171          */
2172         function isMissing() {
2173                 return false;
2174         }
2175
2176         /**
2177          * Check if this file object is small and can be cached
2178          * @return bool
2179          */
2180         public function isCacheable() {
2181                 return true;
2182         }
2183
2184         /**
2185          * Assert that $this->repo is set to a valid FileRepo instance
2186          * @throws MWException
2187          */
2188         protected function assertRepoDefined() {
2189                 if ( !( $this->repo instanceof $this->repoClass ) ) {
2190                         throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2191                 }
2192         }
2193
2194         /**
2195          * Assert that $this->title is set to a Title
2196          * @throws MWException
2197          */
2198         protected function assertTitleDefined() {
2199                 if ( !( $this->title instanceof Title ) ) {
2200                         throw new MWException( "A Title object is not set for this File.\n" );
2201                 }
2202         }
2203
2204         /**
2205          * True if creating thumbnails from the file is large or otherwise resource-intensive.
2206          * @return bool
2207          */
2208         public function isExpensiveToThumbnail() {
2209                 $handler = $this->getHandler();
2210                 return $handler ? $handler->isExpensiveToThumbnail( $this ) : false;
2211         }
2212 }