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