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