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                 return is_object( $thumb ) ? $thumb : false;
1074         }
1075
1076         /**
1077          * Generates a thumbnail according to the given parameters and saves it to storage
1078          * @param TempFSFile $tmpFile Temporary file where the rendered thumbnail will be saved
1079          * @param array $transformParams
1080          * @param int $flags
1081          * @return bool|MediaTransformOutput
1082          */
1083         public function generateAndSaveThumb( $tmpFile, $transformParams, $flags ) {
1084                 global $wgUseSquid, $wgIgnoreImageErrors;
1085
1086                 $handler = $this->getHandler();
1087
1088                 $normalisedParams = $transformParams;
1089                 $handler->normaliseParams( $this, $normalisedParams );
1090
1091                 $thumbName = $this->thumbName( $normalisedParams );
1092                 $thumbUrl = $this->getThumbUrl( $thumbName );
1093                 $thumbPath = $this->getThumbPath( $thumbName ); // final thumb path
1094
1095                 $tmpThumbPath = $tmpFile->getPath();
1096
1097                 if ( $handler->supportsBucketing() ) {
1098                         $this->generateBucketsIfNeeded( $normalisedParams, $flags );
1099                 }
1100
1101                 // Actually render the thumbnail...
1102                 $thumb = $handler->doTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1103                 $tmpFile->bind( $thumb ); // keep alive with $thumb
1104
1105                 if ( !$thumb ) { // bad params?
1106                         $thumb = false;
1107                 } elseif ( $thumb->isError() ) { // transform error
1108                         $this->lastError = $thumb->toText();
1109                         // Ignore errors if requested
1110                         if ( $wgIgnoreImageErrors && !( $flags & self::RENDER_NOW ) ) {
1111                                 $thumb = $handler->getTransform( $this, $tmpThumbPath, $thumbUrl, $transformParams );
1112                         }
1113                 } elseif ( $this->repo && $thumb->hasFile() && !$thumb->fileIsSource() ) {
1114                         // Copy the thumbnail from the file system into storage...
1115                         $disposition = $this->getThumbDisposition( $thumbName );
1116                         $status = $this->repo->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1117                         if ( $status->isOK() ) {
1118                                 $thumb->setStoragePath( $thumbPath );
1119                         } else {
1120                                 $thumb = $this->transformErrorOutput( $thumbPath, $thumbUrl, $transformParams, $flags );
1121                         }
1122                         // Give extensions a chance to do something with this thumbnail...
1123                         Hooks::run( 'FileTransformed', array( $this, $thumb, $tmpThumbPath, $thumbPath ) );
1124                 }
1125
1126                 // Purge. Useful in the event of Core -> Squid connection failure or squid
1127                 // purge collisions from elsewhere during failure. Don't keep triggering for
1128                 // "thumbs" which have the main image URL though (bug 13776)
1129                 if ( $wgUseSquid ) {
1130                         if ( !$thumb || $thumb->isError() || $thumb->getUrl() != $this->getURL() ) {
1131                                 SquidUpdate::purge( array( $thumbUrl ) );
1132                         }
1133                 }
1134
1135                 return $thumb;
1136         }
1137
1138         /**
1139          * Generates chained bucketed thumbnails if needed
1140          * @param array $params
1141          * @param int $flags
1142          * @return bool Whether at least one bucket was generated
1143          */
1144         protected function generateBucketsIfNeeded( $params, $flags = 0 ) {
1145                 if ( !$this->repo
1146                         || !isset( $params['physicalWidth'] )
1147                         || !isset( $params['physicalHeight'] )
1148                         || !( $bucket = $this->getThumbnailBucket( $params['physicalWidth'] ) )
1149                         || $bucket == $params['physicalWidth'] ) {
1150                         return false;
1151                 }
1152
1153                 $bucketPath = $this->getBucketThumbPath( $bucket );
1154
1155                 if ( $this->repo->fileExists( $bucketPath ) ) {
1156                         return false;
1157                 }
1158
1159                 $params['physicalWidth'] = $bucket;
1160                 $params['width'] = $bucket;
1161
1162                 $params = $this->getHandler()->sanitizeParamsForBucketing( $params );
1163
1164                 $bucketName = $this->getBucketThumbName( $bucket );
1165
1166                 $tmpFile = $this->makeTransformTmpFile( $bucketPath );
1167
1168                 if ( !$tmpFile ) {
1169                         return false;
1170                 }
1171
1172                 $thumb = $this->generateAndSaveThumb( $tmpFile, $params, $flags );
1173
1174                 if ( !$thumb || $thumb->isError() ) {
1175                         return false;
1176                 }
1177
1178                 $this->tmpBucketedThumbCache[$bucket] = $tmpFile->getPath();
1179                 // For the caching to work, we need to make the tmp file survive as long as
1180                 // this object exists
1181                 $tmpFile->bind( $this );
1182
1183                 return true;
1184         }
1185
1186         /**
1187          * Returns the most appropriate source image for the thumbnail, given a target thumbnail size
1188          * @param array $params
1189          * @return array Source path and width/height of the source
1190          */
1191         public function getThumbnailSource( $params ) {
1192                 if ( $this->repo
1193                         && $this->getHandler()->supportsBucketing()
1194                         && isset( $params['physicalWidth'] )
1195                         && $bucket = $this->getThumbnailBucket( $params['physicalWidth'] )
1196                 ) {
1197                         if ( $this->getWidth() != 0 ) {
1198                                 $bucketHeight = round( $this->getHeight() * ( $bucket / $this->getWidth() ) );
1199                         } else {
1200                                 $bucketHeight = 0;
1201                         }
1202
1203                         // Try to avoid reading from storage if the file was generated by this script
1204                         if ( isset( $this->tmpBucketedThumbCache[$bucket] ) ) {
1205                                 $tmpPath = $this->tmpBucketedThumbCache[$bucket];
1206
1207                                 if ( file_exists( $tmpPath ) ) {
1208                                         return array(
1209                                                 'path' => $tmpPath,
1210                                                 'width' => $bucket,
1211                                                 'height' => $bucketHeight
1212                                         );
1213                                 }
1214                         }
1215
1216                         $bucketPath = $this->getBucketThumbPath( $bucket );
1217
1218                         if ( $this->repo->fileExists( $bucketPath ) ) {
1219                                 $fsFile = $this->repo->getLocalReference( $bucketPath );
1220
1221                                 if ( $fsFile ) {
1222                                         return array(
1223                                                 'path' => $fsFile->getPath(),
1224                                                 'width' => $bucket,
1225                                                 'height' => $bucketHeight
1226                                         );
1227                                 }
1228                         }
1229                 }
1230
1231                 // Thumbnailing a very large file could result in network saturation if
1232                 // everyone does it at once.
1233                 if ( $this->getSize() >= 1e7 ) { // 10MB
1234                         $that = $this;
1235                         $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $this->getName() ),
1236                                 array(
1237                                         'doWork' => function () use ( $that ) {
1238                                                 return $that->getLocalRefPath();
1239                                         }
1240                                 )
1241                         );
1242                         $srcPath = $work->execute();
1243                 } else {
1244                         $srcPath = $this->getLocalRefPath();
1245                 }
1246
1247                 // Original file
1248                 return array(
1249                         'path' => $srcPath,
1250                         'width' => $this->getWidth(),
1251                         'height' => $this->getHeight()
1252                 );
1253         }
1254
1255         /**
1256          * Returns the repo path of the thumb for a given bucket
1257          * @param int $bucket
1258          * @return string
1259          */
1260         protected function getBucketThumbPath( $bucket ) {
1261                 $thumbName = $this->getBucketThumbName( $bucket );
1262                 return $this->getThumbPath( $thumbName );
1263         }
1264
1265         /**
1266          * Returns the name of the thumb for a given bucket
1267          * @param int $bucket
1268          * @return string
1269          */
1270         protected function getBucketThumbName( $bucket ) {
1271                 return $this->thumbName( array( 'physicalWidth' => $bucket ) );
1272         }
1273
1274         /**
1275          * Creates a temp FS file with the same extension and the thumbnail
1276          * @param string $thumbPath Thumbnail path
1277          * @return TempFSFile
1278          */
1279         protected function makeTransformTmpFile( $thumbPath ) {
1280                 $thumbExt = FileBackend::extensionFromPath( $thumbPath );
1281                 return TempFSFile::factory( 'transform_', $thumbExt );
1282         }
1283
1284         /**
1285          * @param string $thumbName Thumbnail name
1286          * @param string $dispositionType Type of disposition (either "attachment" or "inline")
1287          * @return string Content-Disposition header value
1288          */
1289         function getThumbDisposition( $thumbName, $dispositionType = 'inline' ) {
1290                 $fileName = $this->name; // file name to suggest
1291                 $thumbExt = FileBackend::extensionFromPath( $thumbName );
1292                 if ( $thumbExt != '' && $thumbExt !== $this->getExtension() ) {
1293                         $fileName .= ".$thumbExt";
1294                 }
1295
1296                 return FileBackend::makeContentDisposition( $dispositionType, $fileName );
1297         }
1298
1299         /**
1300          * Hook into transform() to allow migration of thumbnail files
1301          * STUB
1302          * Overridden by LocalFile
1303          * @param string $thumbName
1304          */
1305         function migrateThumbFile( $thumbName ) {
1306         }
1307
1308         /**
1309          * Get a MediaHandler instance for this file
1310          *
1311          * @return MediaHandler|bool Registered MediaHandler for file's MIME type
1312          *   or false if none found
1313          */
1314         function getHandler() {
1315                 if ( !isset( $this->handler ) ) {
1316                         $this->handler = MediaHandler::getHandler( $this->getMimeType() );
1317                 }
1318
1319                 return $this->handler;
1320         }
1321
1322         /**
1323          * Get a ThumbnailImage representing a file type icon
1324          *
1325          * @return ThumbnailImage
1326          */
1327         function iconThumb() {
1328                 global $wgResourceBasePath, $IP;
1329                 $assetsPath = "$wgResourceBasePath/resources/assets/file-type-icons/";
1330                 $assetsDirectory = "$IP/resources/assets/file-type-icons/";
1331
1332                 $try = array( 'fileicon-' . $this->getExtension() . '.png', 'fileicon.png' );
1333                 foreach ( $try as $icon ) {
1334                         if ( file_exists( $assetsDirectory . $icon ) ) { // always FS
1335                                 $params = array( 'width' => 120, 'height' => 120 );
1336
1337                                 return new ThumbnailImage( $this, $assetsPath . $icon, false, $params );
1338                         }
1339                 }
1340
1341                 return null;
1342         }
1343
1344         /**
1345          * Get last thumbnailing error.
1346          * Largely obsolete.
1347          * @return string
1348          */
1349         function getLastError() {
1350                 return $this->lastError;
1351         }
1352
1353         /**
1354          * Get all thumbnail names previously generated for this file
1355          * STUB
1356          * Overridden by LocalFile
1357          * @return array
1358          */
1359         function getThumbnails() {
1360                 return array();
1361         }
1362
1363         /**
1364          * Purge shared caches such as thumbnails and DB data caching
1365          * STUB
1366          * Overridden by LocalFile
1367          * @param array $options Options, which include:
1368          *   'forThumbRefresh' : The purging is only to refresh thumbnails
1369          */
1370         function purgeCache( $options = array() ) {
1371         }
1372
1373         /**
1374          * Purge the file description page, but don't go after
1375          * pages using the file. Use when modifying file history
1376          * but not the current data.
1377          */
1378         function purgeDescription() {
1379                 $title = $this->getTitle();
1380                 if ( $title ) {
1381                         $title->invalidateCache();
1382                         $title->purgeSquid();
1383                 }
1384         }
1385
1386         /**
1387          * Purge metadata and all affected pages when the file is created,
1388          * deleted, or majorly updated.
1389          */
1390         function purgeEverything() {
1391                 // Delete thumbnails and refresh file metadata cache
1392                 $this->purgeCache();
1393                 $this->purgeDescription();
1394
1395                 // Purge cache of all pages using this file
1396                 $title = $this->getTitle();
1397                 if ( $title ) {
1398                         $update = new HTMLCacheUpdate( $title, 'imagelinks' );
1399                         $update->doUpdate();
1400                 }
1401         }
1402
1403         /**
1404          * Return a fragment of the history of file.
1405          *
1406          * STUB
1407          * @param int $limit Limit of rows to return
1408          * @param string $start Only revisions older than $start will be returned
1409          * @param string $end Only revisions newer than $end will be returned
1410          * @param bool $inc Include the endpoints of the time range
1411          *
1412          * @return array
1413          */
1414         function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1415                 return array();
1416         }
1417
1418         /**
1419          * Return the history of this file, line by line. Starts with current version,
1420          * then old versions. Should return an object similar to an image/oldimage
1421          * database row.
1422          *
1423          * STUB
1424          * Overridden in LocalFile
1425          * @return bool
1426          */
1427         public function nextHistoryLine() {
1428                 return false;
1429         }
1430
1431         /**
1432          * Reset the history pointer to the first element of the history.
1433          * Always call this function after using nextHistoryLine() to free db resources
1434          * STUB
1435          * Overridden in LocalFile.
1436          */
1437         public function resetHistory() {
1438         }
1439
1440         /**
1441          * Get the filename hash component of the directory including trailing slash,
1442          * e.g. f/fa/
1443          * If the repository is not hashed, returns an empty string.
1444          *
1445          * @return string
1446          */
1447         function getHashPath() {
1448                 if ( !isset( $this->hashPath ) ) {
1449                         $this->assertRepoDefined();
1450                         $this->hashPath = $this->repo->getHashPath( $this->getName() );
1451                 }
1452
1453                 return $this->hashPath;
1454         }
1455
1456         /**
1457          * Get the path of the file relative to the public zone root.
1458          * This function is overridden in OldLocalFile to be like getArchiveRel().
1459          *
1460          * @return string
1461          */
1462         function getRel() {
1463                 return $this->getHashPath() . $this->getName();
1464         }
1465
1466         /**
1467          * Get the path of an archived file relative to the public zone root
1468          *
1469          * @param bool|string $suffix If not false, the name of an archived thumbnail file
1470          *
1471          * @return string
1472          */
1473         function getArchiveRel( $suffix = false ) {
1474                 $path = 'archive/' . $this->getHashPath();
1475                 if ( $suffix === false ) {
1476                         $path = substr( $path, 0, -1 );
1477                 } else {
1478                         $path .= $suffix;
1479                 }
1480
1481                 return $path;
1482         }
1483
1484         /**
1485          * Get the path, relative to the thumbnail zone root, of the
1486          * thumbnail directory or a particular file if $suffix is specified
1487          *
1488          * @param bool|string $suffix If not false, the name of a thumbnail file
1489          * @return string
1490          */
1491         function getThumbRel( $suffix = false ) {
1492                 $path = $this->getRel();
1493                 if ( $suffix !== false ) {
1494                         $path .= '/' . $suffix;
1495                 }
1496
1497                 return $path;
1498         }
1499
1500         /**
1501          * Get urlencoded path of the file relative to the public zone root.
1502          * This function is overridden in OldLocalFile to be like getArchiveUrl().
1503          *
1504          * @return string
1505          */
1506         function getUrlRel() {
1507                 return $this->getHashPath() . rawurlencode( $this->getName() );
1508         }
1509
1510         /**
1511          * Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory
1512          * or a specific thumb if the $suffix is given.
1513          *
1514          * @param string $archiveName The timestamped name of an archived image
1515          * @param bool|string $suffix If not false, the name of a thumbnail file
1516          * @return string
1517          */
1518         function getArchiveThumbRel( $archiveName, $suffix = false ) {
1519                 $path = 'archive/' . $this->getHashPath() . $archiveName . "/";
1520                 if ( $suffix === false ) {
1521                         $path = substr( $path, 0, -1 );
1522                 } else {
1523                         $path .= $suffix;
1524                 }
1525
1526                 return $path;
1527         }
1528
1529         /**
1530          * Get the path of the archived file.
1531          *
1532          * @param bool|string $suffix If not false, the name of an archived file.
1533          * @return string
1534          */
1535         function getArchivePath( $suffix = false ) {
1536                 $this->assertRepoDefined();
1537
1538                 return $this->repo->getZonePath( 'public' ) . '/' . $this->getArchiveRel( $suffix );
1539         }
1540
1541         /**
1542          * Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified
1543          *
1544          * @param string $archiveName The timestamped name of an archived image
1545          * @param bool|string $suffix If not false, the name of a thumbnail file
1546          * @return string
1547          */
1548         function getArchiveThumbPath( $archiveName, $suffix = false ) {
1549                 $this->assertRepoDefined();
1550
1551                 return $this->repo->getZonePath( 'thumb' ) . '/' .
1552                 $this->getArchiveThumbRel( $archiveName, $suffix );
1553         }
1554
1555         /**
1556          * Get the path of the thumbnail directory, or a particular file if $suffix is specified
1557          *
1558          * @param bool|string $suffix If not false, the name of a thumbnail file
1559          * @return string
1560          */
1561         function getThumbPath( $suffix = false ) {
1562                 $this->assertRepoDefined();
1563
1564                 return $this->repo->getZonePath( 'thumb' ) . '/' . $this->getThumbRel( $suffix );
1565         }
1566
1567         /**
1568          * Get the path of the transcoded directory, or a particular file if $suffix is specified
1569          *
1570          * @param bool|string $suffix If not false, the name of a media file
1571          * @return string
1572          */
1573         function getTranscodedPath( $suffix = false ) {
1574                 $this->assertRepoDefined();
1575
1576                 return $this->repo->getZonePath( 'transcoded' ) . '/' . $this->getThumbRel( $suffix );
1577         }
1578
1579         /**
1580          * Get the URL of the archive directory, or a particular file if $suffix is specified
1581          *
1582          * @param bool|string $suffix If not false, the name of an archived file
1583          * @return string
1584          */
1585         function getArchiveUrl( $suffix = false ) {
1586                 $this->assertRepoDefined();
1587                 $ext = $this->getExtension();
1588                 $path = $this->repo->getZoneUrl( 'public', $ext ) . '/archive/' . $this->getHashPath();
1589                 if ( $suffix === false ) {
1590                         $path = substr( $path, 0, -1 );
1591                 } else {
1592                         $path .= rawurlencode( $suffix );
1593                 }
1594
1595                 return $path;
1596         }
1597
1598         /**
1599          * Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified
1600          *
1601          * @param string $archiveName The timestamped name of an archived image
1602          * @param bool|string $suffix If not false, the name of a thumbnail file
1603          * @return string
1604          */
1605         function getArchiveThumbUrl( $archiveName, $suffix = false ) {
1606                 $this->assertRepoDefined();
1607                 $ext = $this->getExtension();
1608                 $path = $this->repo->getZoneUrl( 'thumb', $ext ) . '/archive/' .
1609                         $this->getHashPath() . rawurlencode( $archiveName ) . "/";
1610                 if ( $suffix === false ) {
1611                         $path = substr( $path, 0, -1 );
1612                 } else {
1613                         $path .= rawurlencode( $suffix );
1614                 }
1615
1616                 return $path;
1617         }
1618
1619         /**
1620          * Get the URL of the zone directory, or a particular file if $suffix is specified
1621          *
1622          * @param string $zone Name of requested zone
1623          * @param bool|string $suffix If not false, the name of a file in zone
1624          * @return string Path
1625          */
1626         function getZoneUrl( $zone, $suffix = false ) {
1627                 $this->assertRepoDefined();
1628                 $ext = $this->getExtension();
1629                 $path = $this->repo->getZoneUrl( $zone, $ext ) . '/' . $this->getUrlRel();
1630                 if ( $suffix !== false ) {
1631                         $path .= '/' . rawurlencode( $suffix );
1632                 }
1633
1634                 return $path;
1635         }
1636
1637         /**
1638          * Get the URL of the thumbnail directory, or a particular file if $suffix is specified
1639          *
1640          * @param bool|string $suffix If not false, the name of a thumbnail file
1641          * @return string Path
1642          */
1643         function getThumbUrl( $suffix = false ) {
1644                 return $this->getZoneUrl( 'thumb', $suffix );
1645         }
1646
1647         /**
1648          * Get the URL of the transcoded directory, or a particular file if $suffix is specified
1649          *
1650          * @param bool|string $suffix If not false, the name of a media file
1651          * @return string Path
1652          */
1653         function getTranscodedUrl( $suffix = false ) {
1654                 return $this->getZoneUrl( 'transcoded', $suffix );
1655         }
1656
1657         /**
1658          * Get the public zone virtual URL for a current version source file
1659          *
1660          * @param bool|string $suffix If not false, the name of a thumbnail file
1661          * @return string
1662          */
1663         function getVirtualUrl( $suffix = false ) {
1664                 $this->assertRepoDefined();
1665                 $path = $this->repo->getVirtualUrl() . '/public/' . $this->getUrlRel();
1666                 if ( $suffix !== false ) {
1667                         $path .= '/' . rawurlencode( $suffix );
1668                 }
1669
1670                 return $path;
1671         }
1672
1673         /**
1674          * Get the public zone virtual URL for an archived version source file
1675          *
1676          * @param bool|string $suffix If not false, the name of a thumbnail file
1677          * @return string
1678          */
1679         function getArchiveVirtualUrl( $suffix = false ) {
1680                 $this->assertRepoDefined();
1681                 $path = $this->repo->getVirtualUrl() . '/public/archive/' . $this->getHashPath();
1682                 if ( $suffix === false ) {
1683                         $path = substr( $path, 0, -1 );
1684                 } else {
1685                         $path .= rawurlencode( $suffix );
1686                 }
1687
1688                 return $path;
1689         }
1690
1691         /**
1692          * Get the virtual URL for a thumbnail file or directory
1693          *
1694          * @param bool|string $suffix If not false, the name of a thumbnail file
1695          * @return string
1696          */
1697         function getThumbVirtualUrl( $suffix = false ) {
1698                 $this->assertRepoDefined();
1699                 $path = $this->repo->getVirtualUrl() . '/thumb/' . $this->getUrlRel();
1700                 if ( $suffix !== false ) {
1701                         $path .= '/' . rawurlencode( $suffix );
1702                 }
1703
1704                 return $path;
1705         }
1706
1707         /**
1708          * @return bool
1709          */
1710         function isHashed() {
1711                 $this->assertRepoDefined();
1712
1713                 return (bool)$this->repo->getHashLevels();
1714         }
1715
1716         /**
1717          * @throws MWException
1718          */
1719         function readOnlyError() {
1720                 throw new MWException( get_class( $this ) . ': write operations are not supported' );
1721         }
1722
1723         /**
1724          * Record a file upload in the upload log and the image table
1725          * STUB
1726          * Overridden by LocalFile
1727          * @param string $oldver
1728          * @param string $desc
1729          * @param string $license
1730          * @param string $copyStatus
1731          * @param string $source
1732          * @param bool $watch
1733          * @param string|bool $timestamp
1734          * @param null|User $user User object or null to use $wgUser
1735          * @return bool
1736          * @throws MWException
1737          */
1738         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1739                 $watch = false, $timestamp = false, User $user = null
1740         ) {
1741                 $this->readOnlyError();
1742         }
1743
1744         /**
1745          * Move or copy a file to its public location. If a file exists at the
1746          * destination, move it to an archive. Returns a FileRepoStatus object with
1747          * the archive name in the "value" member on success.
1748          *
1749          * The archive name should be passed through to recordUpload for database
1750          * registration.
1751          *
1752          * Options to $options include:
1753          *   - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1754          *
1755          * @param string $srcPath Local filesystem path to the source image
1756          * @param int $flags A bitwise combination of:
1757          *   File::DELETE_SOURCE    Delete the source file, i.e. move rather than copy
1758          * @param array $options Optional additional parameters
1759          * @return FileRepoStatus On success, the value member contains the
1760          *   archive name, or an empty string if it was a new file.
1761          *
1762          * STUB
1763          * Overridden by LocalFile
1764          */
1765         function publish( $srcPath, $flags = 0, array $options = array() ) {
1766                 $this->readOnlyError();
1767         }
1768
1769         /**
1770          * @return bool
1771          */
1772         function formatMetadata() {
1773                 if ( !$this->getHandler() ) {
1774                         return false;
1775                 }
1776
1777                 return $this->getHandler()->formatMetadata( $this, $this->getMetadata() );
1778         }
1779
1780         /**
1781          * Returns true if the file comes from the local file repository.
1782          *
1783          * @return bool
1784          */
1785         function isLocal() {
1786                 return $this->repo && $this->repo->isLocal();
1787         }
1788
1789         /**
1790          * Returns the name of the repository.
1791          *
1792          * @return string
1793          */
1794         function getRepoName() {
1795                 return $this->repo ? $this->repo->getName() : 'unknown';
1796         }
1797
1798         /**
1799          * Returns the repository
1800          *
1801          * @return FileRepo|LocalRepo|bool
1802          */
1803         function getRepo() {
1804                 return $this->repo;
1805         }
1806
1807         /**
1808          * Returns true if the image is an old version
1809          * STUB
1810          *
1811          * @return bool
1812          */
1813         function isOld() {
1814                 return false;
1815         }
1816
1817         /**
1818          * Is this file a "deleted" file in a private archive?
1819          * STUB
1820          *
1821          * @param int $field One of DELETED_* bitfield constants
1822          * @return bool
1823          */
1824         function isDeleted( $field ) {
1825                 return false;
1826         }
1827
1828         /**
1829          * Return the deletion bitfield
1830          * STUB
1831          * @return int
1832          */
1833         function getVisibility() {
1834                 return 0;
1835         }
1836
1837         /**
1838          * Was this file ever deleted from the wiki?
1839          *
1840          * @return bool
1841          */
1842         function wasDeleted() {
1843                 $title = $this->getTitle();
1844
1845                 return $title && $title->isDeletedQuick();
1846         }
1847
1848         /**
1849          * Move file to the new title
1850          *
1851          * Move current, old version and all thumbnails
1852          * to the new filename. Old file is deleted.
1853          *
1854          * Cache purging is done; checks for validity
1855          * and logging are caller's responsibility
1856          *
1857          * @param Title $target New file name
1858          * @return FileRepoStatus
1859          */
1860         function move( $target ) {
1861                 $this->readOnlyError();
1862         }
1863
1864         /**
1865          * Delete all versions of the file.
1866          *
1867          * Moves the files into an archive directory (or deletes them)
1868          * and removes the database rows.
1869          *
1870          * Cache purging is done; logging is caller's responsibility.
1871          *
1872          * @param string $reason
1873          * @param bool $suppress Hide content from sysops?
1874          * @param User|null $user
1875          * @return bool Boolean on success, false on some kind of failure
1876          * STUB
1877          * Overridden by LocalFile
1878          */
1879         function delete( $reason, $suppress = false, $user = null ) {
1880                 $this->readOnlyError();
1881         }
1882
1883         /**
1884          * Restore all or specified deleted revisions to the given file.
1885          * Permissions and logging are left to the caller.
1886          *
1887          * May throw database exceptions on error.
1888          *
1889          * @param array $versions Set of record ids of deleted items to restore,
1890          *   or empty to restore all revisions.
1891          * @param bool $unsuppress Remove restrictions on content upon restoration?
1892          * @return int|bool The number of file revisions restored if successful,
1893          *   or false on failure
1894          * STUB
1895          * Overridden by LocalFile
1896          */
1897         function restore( $versions = array(), $unsuppress = false ) {
1898                 $this->readOnlyError();
1899         }
1900
1901         /**
1902          * Returns 'true' if this file is a type which supports multiple pages,
1903          * e.g. DJVU or PDF. Note that this may be true even if the file in
1904          * question only has a single page.
1905          *
1906          * @return bool
1907          */
1908         function isMultipage() {
1909                 return $this->getHandler() && $this->handler->isMultiPage( $this );
1910         }
1911
1912         /**
1913          * Returns the number of pages of a multipage document, or false for
1914          * documents which aren't multipage documents
1915          *
1916          * @return bool|int
1917          */
1918         function pageCount() {
1919                 if ( !isset( $this->pageCount ) ) {
1920                         if ( $this->getHandler() && $this->handler->isMultiPage( $this ) ) {
1921                                 $this->pageCount = $this->handler->pageCount( $this );
1922                         } else {
1923                                 $this->pageCount = false;
1924                         }
1925                 }
1926
1927                 return $this->pageCount;
1928         }
1929
1930         /**
1931          * Calculate the height of a thumbnail using the source and destination width
1932          *
1933          * @param int $srcWidth
1934          * @param int $srcHeight
1935          * @param int $dstWidth
1936          *
1937          * @return int
1938          */
1939         static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
1940                 // Exact integer multiply followed by division
1941                 if ( $srcWidth == 0 ) {
1942                         return 0;
1943                 } else {
1944                         return round( $srcHeight * $dstWidth / $srcWidth );
1945                 }
1946         }
1947
1948         /**
1949          * Get an image size array like that returned by getImageSize(), or false if it
1950          * can't be determined. Loads the image size directly from the file ignoring caches.
1951          *
1952          * @note Use getWidth()/getHeight() instead of this method unless you have a
1953          *  a good reason. This method skips all caches.
1954          *
1955          * @param string $filePath The path to the file (e.g. From getLocalPathRef() )
1956          * @return array The width, followed by height, with optionally more things after
1957          */
1958         function getImageSize( $filePath ) {
1959                 if ( !$this->getHandler() ) {
1960                         return false;
1961                 }
1962
1963                 return $this->getHandler()->getImageSize( $this, $filePath );
1964         }
1965
1966         /**
1967          * Get the URL of the image description page. May return false if it is
1968          * unknown or not applicable.
1969          *
1970          * @return string
1971          */
1972         function getDescriptionUrl() {
1973                 if ( $this->repo ) {
1974                         return $this->repo->getDescriptionUrl( $this->getName() );
1975                 } else {
1976                         return false;
1977                 }
1978         }
1979
1980         /**
1981          * Get the HTML text of the description page, if available
1982          *
1983          * @param bool|Language $lang Optional language to fetch description in
1984          * @return string
1985          */
1986         function getDescriptionText( $lang = false ) {
1987                 global $wgMemc, $wgLang;
1988                 if ( !$this->repo || !$this->repo->fetchDescription ) {
1989                         return false;
1990                 }
1991                 if ( !$lang ) {
1992                         $lang = $wgLang;
1993                 }
1994                 $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
1995                 if ( $renderUrl ) {
1996                         if ( $this->repo->descriptionCacheExpiry > 0 ) {
1997                                 wfDebug( "Attempting to get the description from cache..." );
1998                                 $key = $this->repo->getLocalCacheKey(
1999                                         'RemoteFileDescription',
2000                                         'url',
2001                                         $lang->getCode(),
2002                                         $this->getName()
2003                                 );
2004                                 $obj = $wgMemc->get( $key );
2005                                 if ( $obj ) {
2006                                         wfDebug( "success!\n" );
2007
2008                                         return $obj;
2009                                 }
2010                                 wfDebug( "miss\n" );
2011                         }
2012                         wfDebug( "Fetching shared description from $renderUrl\n" );
2013                         $res = Http::get( $renderUrl );
2014                         if ( $res && $this->repo->descriptionCacheExpiry > 0 ) {
2015                                 $wgMemc->set( $key, $res, $this->repo->descriptionCacheExpiry );
2016                         }
2017
2018                         return $res;
2019                 } else {
2020                         return false;
2021                 }
2022         }
2023
2024         /**
2025          * Get description of file revision
2026          * STUB
2027          *
2028          * @param int $audience One of:
2029          *   File::FOR_PUBLIC       to be displayed to all users
2030          *   File::FOR_THIS_USER    to be displayed to the given user
2031          *   File::RAW              get the description regardless of permissions
2032          * @param User $user User object to check for, only if FOR_THIS_USER is
2033          *   passed to the $audience parameter
2034          * @return string
2035          */
2036         function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
2037                 return null;
2038         }
2039
2040         /**
2041          * Get the 14-character timestamp of the file upload
2042          *
2043          * @return string|bool TS_MW timestamp or false on failure
2044          */
2045         function getTimestamp() {
2046                 $this->assertRepoDefined();
2047
2048                 return $this->repo->getFileTimestamp( $this->getPath() );
2049         }
2050
2051         /**
2052          * Get the SHA-1 base 36 hash of the file
2053          *
2054          * @return string
2055          */
2056         function getSha1() {
2057                 $this->assertRepoDefined();
2058
2059                 return $this->repo->getFileSha1( $this->getPath() );
2060         }
2061
2062         /**
2063          * Get the deletion archive key, "<sha1>.<ext>"
2064          *
2065          * @return string
2066          */
2067         function getStorageKey() {
2068                 $hash = $this->getSha1();
2069                 if ( !$hash ) {
2070                         return false;
2071                 }
2072                 $ext = $this->getExtension();
2073                 $dotExt = $ext === '' ? '' : ".$ext";
2074
2075                 return $hash . $dotExt;
2076         }
2077
2078         /**
2079          * Determine if the current user is allowed to view a particular
2080          * field of this file, if it's marked as deleted.
2081          * STUB
2082          * @param int $field
2083          * @param User $user User object to check, or null to use $wgUser
2084          * @return bool
2085          */
2086         function userCan( $field, User $user = null ) {
2087                 return true;
2088         }
2089
2090         /**
2091          * @return array HTTP header name/value map to use for HEAD/GET request responses
2092          */
2093         function getStreamHeaders() {
2094                 $handler = $this->getHandler();
2095                 if ( $handler ) {
2096                         return $handler->getStreamHeaders( $this->getMetadata() );
2097                 } else {
2098                         return array();
2099                 }
2100         }
2101
2102         /**
2103          * @return string
2104          */
2105         function getLongDesc() {
2106                 $handler = $this->getHandler();
2107                 if ( $handler ) {
2108                         return $handler->getLongDesc( $this );
2109                 } else {
2110                         return MediaHandler::getGeneralLongDesc( $this );
2111                 }
2112         }
2113
2114         /**
2115          * @return string
2116          */
2117         function getShortDesc() {
2118                 $handler = $this->getHandler();
2119                 if ( $handler ) {
2120                         return $handler->getShortDesc( $this );
2121                 } else {
2122                         return MediaHandler::getGeneralShortDesc( $this );
2123                 }
2124         }
2125
2126         /**
2127          * @return string
2128          */
2129         function getDimensionsString() {
2130                 $handler = $this->getHandler();
2131                 if ( $handler ) {
2132                         return $handler->getDimensionsString( $this );
2133                 } else {
2134                         return '';
2135                 }
2136         }
2137
2138         /**
2139          * @return string
2140          */
2141         function getRedirected() {
2142                 return $this->redirected;
2143         }
2144
2145         /**
2146          * @return Title|null
2147          */
2148         function getRedirectedTitle() {
2149                 if ( $this->redirected ) {
2150                         if ( !$this->redirectTitle ) {
2151                                 $this->redirectTitle = Title::makeTitle( NS_FILE, $this->redirected );
2152                         }
2153
2154                         return $this->redirectTitle;
2155                 }
2156
2157                 return null;
2158         }
2159
2160         /**
2161          * @param string $from
2162          * @return void
2163          */
2164         function redirectedFrom( $from ) {
2165                 $this->redirected = $from;
2166         }
2167
2168         /**
2169          * @return bool
2170          */
2171         function isMissing() {
2172                 return false;
2173         }
2174
2175         /**
2176          * Check if this file object is small and can be cached
2177          * @return bool
2178          */
2179         public function isCacheable() {
2180                 return true;
2181         }
2182
2183         /**
2184          * Assert that $this->repo is set to a valid FileRepo instance
2185          * @throws MWException
2186          */
2187         protected function assertRepoDefined() {
2188                 if ( !( $this->repo instanceof $this->repoClass ) ) {
2189                         throw new MWException( "A {$this->repoClass} object is not set for this File.\n" );
2190                 }
2191         }
2192
2193         /**
2194          * Assert that $this->title is set to a Title
2195          * @throws MWException
2196          */
2197         protected function assertTitleDefined() {
2198                 if ( !( $this->title instanceof Title ) ) {
2199                         throw new MWException( "A Title object is not set for this File.\n" );
2200                 }
2201         }
2202
2203         /**
2204          * True if creating thumbnails from the file is large or otherwise resource-intensive.
2205          * @return bool
2206          */
2207         public function isExpensiveToThumbnail() {
2208                 $handler = $this->getHandler();
2209                 return $handler ? $handler->isExpensiveToThumbnail( $this ) : false;
2210         }
2211 }