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