includes/filerepo/file/File.php

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