includes/Image.php

   1 <?php
   2 /**
   3  * @package MediaWiki
   4  */
   5
   6 /**
   7  * NOTE FOR WINDOWS USERS:
   8  * To enable EXIF functions, add the folloing lines to the
   9  * "Windows extensions" section of php.ini:
  10  *
  11  * extension=extensions/php_mbstring.dll
  12  * extension=extensions/php_exif.dll
  13  */
  14
  15 /**
  16  * Bump this number when serialized cache records may be incompatible.
  17  */
  18 define( 'MW_IMAGE_VERSION', 1 );
  19
  20 /**
  21  * Class to represent an image
  22  *
  23  * Provides methods to retrieve paths (physical, logical, URL),
  24  * to generate thumbnails or for uploading.
  25  * @package MediaWiki
  26  */
  27 class Image
  28 {
  29         /**#@+
  30          * @private
  31          */
  32         var     $name,          # name of the image (constructor)
  33                 $imagePath,     # Path of the image (loadFromXxx)
  34                 $url,           # Image URL (accessor)
  35                 $title,         # Title object for this image (constructor)
  36                 $fileExists,    # does the image file exist on disk? (loadFromXxx)
  37                 $fromSharedDirectory, # load this image from $wgSharedUploadDirectory (loadFromXxx)
  38                 $historyLine,   # Number of line to return by nextHistoryLine() (constructor)
  39                 $historyRes,    # result of the query for the image's history (nextHistoryLine)
  40                 $width,         # \
  41                 $height,        #  |
  42                 $bits,          #   --- returned by getimagesize (loadFromXxx)
  43                 $attr,          # /
  44                 $type,          # MEDIATYPE_xxx (bitmap, drawing, audio...)
  45                 $mime,          # MIME type, determined by MimeMagic::guessMimeType
  46                 $size,          # Size in bytes (loadFromXxx)
  47                 $metadata,      # Metadata
  48                 $dataLoaded,    # Whether or not all this has been loaded from the database (loadFromXxx)
  49                 $lastError;     # Error string associated with a thumbnail display error
  50
  51
  52         /**#@-*/
  53
  54         /**
  55          * Create an Image object from an image name
  56          *
  57          * @param string $name name of the image, used to create a title object using Title::makeTitleSafe
  58          * @public
  59          */
  60         function newFromName( $name ) {
  61                 $title = Title::makeTitleSafe( NS_IMAGE, $name );
  62                 if ( is_object( $title ) ) {
  63                         return new Image( $title );
  64                 } else {
  65                         return NULL;
  66                 }
  67         }
  68
  69         /**
  70          * Obsolete factory function, use constructor
  71          * @deprecated
  72          */
  73         function newFromTitle( $title ) {
  74                 return new Image( $title );
  75         }
  76
  77         function Image( $title ) {
  78                 if( !is_object( $title ) ) {
  79                         throw new MWException( 'Image constructor given bogus title.' );
  80                 }
  81                 $this->title =& $title;
  82                 $this->name = $title->getDBkey();
  83                 $this->metadata = serialize ( array() ) ;
  84
  85                 $n = strrpos( $this->name, '.' );
  86                 $this->extension = Image::normalizeExtension( $n ?
  87                         substr( $this->name, $n + 1 ) : '' );
  88                 $this->historyLine = 0;
  89
  90                 $this->dataLoaded = false;
  91         }
  92
  93
  94         /**
  95          * Normalize a file extension to the common form, and ensure it's clean.
  96          * Extensions with non-alphanumeric characters will be discarded.
  97          *
  98          * @param $ext string (without the .)
  99          * @return string
 100          */
 101         static function normalizeExtension( $ext ) {
 102                 $lower = strtolower( $ext );
 103                 $squish = array(
 104                         'htm' => 'html',
 105                         'jpeg' => 'jpg',
 106                         'mpeg' => 'mpg',
 107                         'tiff' => 'tif' );
 108                 if( isset( $squish[$lower] ) ) {
 109                         return $squish[$lower];
 110                 } elseif( preg_match( '/^[0-9a-z]+$/', $lower ) ) {
 111                         return $lower;
 112                 } else {
 113                         return '';
 114                 }
 115         }
 116
 117         /**
 118          * Get the memcached keys
 119          * Returns an array, first element is the local cache key, second is the shared cache key, if there is one
 120          */
 121         function getCacheKeys( ) {
 122                 global $wgDBname, $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
 123
 124                 $hashedName = md5($this->name);
 125                 $keys = array( "$wgDBname:Image:$hashedName" );
 126                 if ( $wgUseSharedUploads && $wgSharedUploadDBname && $wgCacheSharedUploads ) {
 127                         $keys[] = "$wgSharedUploadDBname:Image:$hashedName";
 128                 }
 129                 return $keys;
 130         }
 131
 132         /**
 133          * Try to load image metadata from memcached. Returns true on success.
 134          */
 135         function loadFromCache() {
 136                 global $wgUseSharedUploads, $wgMemc;
 137                 $fname = 'Image::loadFromMemcached';
 138                 wfProfileIn( $fname );
 139                 $this->dataLoaded = false;
 140                 $keys = $this->getCacheKeys();
 141                 $cachedValues = $wgMemc->get( $keys[0] );
 142
 143                 // Check if the key existed and belongs to this version of MediaWiki
 144                 if (!empty($cachedValues) && is_array($cachedValues)
 145                   && isset($cachedValues['version']) && ( $cachedValues['version'] == MW_IMAGE_VERSION )
 146                   && $cachedValues['fileExists'] && isset( $cachedValues['mime'] ) && isset( $cachedValues['metadata'] ) )
 147                 {
 148                         if ( $wgUseSharedUploads && $cachedValues['fromShared']) {
 149                                 # if this is shared file, we need to check if image
 150                                 # in shared repository has not changed
 151                                 if ( isset( $keys[1] ) ) {
 152                                         $commonsCachedValues = $wgMemc->get( $keys[1] );
 153                                         if (!empty($commonsCachedValues) && is_array($commonsCachedValues)
 154                                           && isset($commonsCachedValues['version'])
 155                                           && ( $commonsCachedValues['version'] == MW_IMAGE_VERSION )
 156                                           && isset($commonsCachedValues['mime'])) {
 157                                                 wfDebug( "Pulling image metadata from shared repository cache\n" );
 158                                                 $this->name = $commonsCachedValues['name'];
 159                                                 $this->imagePath = $commonsCachedValues['imagePath'];
 160                                                 $this->fileExists = $commonsCachedValues['fileExists'];
 161                                                 $this->width = $commonsCachedValues['width'];
 162                                                 $this->height = $commonsCachedValues['height'];
 163                                                 $this->bits = $commonsCachedValues['bits'];
 164                                                 $this->type = $commonsCachedValues['type'];
 165                                                 $this->mime = $commonsCachedValues['mime'];
 166                                                 $this->metadata = $commonsCachedValues['metadata'];
 167                                                 $this->size = $commonsCachedValues['size'];
 168                                                 $this->fromSharedDirectory = true;
 169                                                 $this->dataLoaded = true;
 170                                                 $this->imagePath = $this->getFullPath(true);
 171                                         }
 172                                 }
 173                         } else {
 174                                 wfDebug( "Pulling image metadata from local cache\n" );
 175                                 $this->name = $cachedValues['name'];
 176                                 $this->imagePath = $cachedValues['imagePath'];
 177                                 $this->fileExists = $cachedValues['fileExists'];
 178                                 $this->width = $cachedValues['width'];
 179                                 $this->height = $cachedValues['height'];
 180                                 $this->bits = $cachedValues['bits'];
 181                                 $this->type = $cachedValues['type'];
 182                                 $this->mime = $cachedValues['mime'];
 183                                 $this->metadata = $cachedValues['metadata'];
 184                                 $this->size = $cachedValues['size'];
 185                                 $this->fromSharedDirectory = false;
 186                                 $this->dataLoaded = true;
 187                                 $this->imagePath = $this->getFullPath();
 188                         }
 189                 }
 190                 if ( $this->dataLoaded ) {
 191                         wfIncrStats( 'image_cache_hit' );
 192                 } else {
 193                         wfIncrStats( 'image_cache_miss' );
 194                 }
 195
 196                 wfProfileOut( $fname );
 197                 return $this->dataLoaded;
 198         }
 199
 200         /**
 201          * Save the image metadata to memcached
 202          */
 203         function saveToCache() {
 204                 global $wgMemc;
 205                 $this->load();
 206                 $keys = $this->getCacheKeys();
 207                 if ( $this->fileExists ) {
 208                         // We can't cache negative metadata for non-existent files,
 209                         // because if the file later appears in commons, the local
 210                         // keys won't be purged.
 211                         $cachedValues = array(
 212                                 'version'    => MW_IMAGE_VERSION,
 213                                 'name'       => $this->name,
 214                                 'imagePath'  => $this->imagePath,
 215                                 'fileExists' => $this->fileExists,
 216                                 'fromShared' => $this->fromSharedDirectory,
 217                                 'width'      => $this->width,
 218                                 'height'     => $this->height,
 219                                 'bits'       => $this->bits,
 220                                 'type'       => $this->type,
 221                                 'mime'       => $this->mime,
 222                                 'metadata'   => $this->metadata,
 223                                 'size'       => $this->size );
 224
 225                         $wgMemc->set( $keys[0], $cachedValues, 60 * 60 * 24 * 7 ); // A week
 226                 } else {
 227                         // However we should clear them, so they aren't leftover
 228                         // if we've deleted the file.
 229                         $wgMemc->delete( $keys[0] );
 230                 }
 231         }
 232
 233         /**
 234          * Load metadata from the file itself
 235          */
 236         function loadFromFile() {
 237                 global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgContLang, $wgShowEXIF;
 238                 $fname = 'Image::loadFromFile';
 239                 wfProfileIn( $fname );
 240                 $this->imagePath = $this->getFullPath();
 241                 $this->fileExists = file_exists( $this->imagePath );
 242                 $this->fromSharedDirectory = false;
 243                 $gis = array();
 244
 245                 if (!$this->fileExists) wfDebug("$fname: ".$this->imagePath." not found locally!\n");
 246
 247                 # If the file is not found, and a shared upload directory is used, look for it there.
 248                 if (!$this->fileExists && $wgUseSharedUploads && $wgSharedUploadDirectory) {
 249                         # In case we're on a wgCapitalLinks=false wiki, we
 250                         # capitalize the first letter of the filename before
 251                         # looking it up in the shared repository.
 252                         $sharedImage = Image::newFromName( $wgContLang->ucfirst($this->name) );
 253                         $this->fileExists = $sharedImage && file_exists( $sharedImage->getFullPath(true) );
 254                         if ( $this->fileExists ) {
 255                                 $this->name = $sharedImage->name;
 256                                 $this->imagePath = $this->getFullPath(true);
 257                                 $this->fromSharedDirectory = true;
 258                         }
 259                 }
 260
 261
 262                 if ( $this->fileExists ) {
 263                         $magic=& wfGetMimeMagic();
 264
 265                         $this->mime = $magic->guessMimeType($this->imagePath,true);
 266                         $this->type = $magic->getMediaType($this->imagePath,$this->mime);
 267
 268                         # Get size in bytes
 269                         $this->size = filesize( $this->imagePath );
 270
 271                         $magic=& wfGetMimeMagic();
 272
 273                         # Height and width
 274                         if( $this->mime == 'image/svg' ) {
 275                                 wfSuppressWarnings();
 276                                 $gis = wfGetSVGsize( $this->imagePath );
 277                                 wfRestoreWarnings();
 278                         }
 279                         elseif ( !$magic->isPHPImageType( $this->mime ) ) {
 280                                 # Don't try to get the width and height of sound and video files, that's bad for performance
 281                                 $gis[0]= 0; //width
 282                                 $gis[1]= 0; //height
 283                                 $gis[2]= 0; //unknown
 284                                 $gis[3]= ""; //width height string
 285                         }
 286                         else {
 287                                 wfSuppressWarnings();
 288                                 $gis = getimagesize( $this->imagePath );
 289                                 wfRestoreWarnings();
 290                         }
 291
 292                         wfDebug("$fname: ".$this->imagePath." loaded, ".$this->size." bytes, ".$this->mime.".\n");
 293                 }
 294                 else {
 295                         $gis[0]= 0; //width
 296                         $gis[1]= 0; //height
 297                         $gis[2]= 0; //unknown
 298                         $gis[3]= ""; //width height string
 299
 300                         $this->mime = NULL;
 301                         $this->type = MEDIATYPE_UNKNOWN;
 302                         wfDebug("$fname: ".$this->imagePath." NOT FOUND!\n");
 303                 }
 304
 305                 $this->width = $gis[0];
 306                 $this->height = $gis[1];
 307
 308                 #NOTE: $gis[2] contains a code for the image type. This is no longer used.
 309
 310                 #NOTE: we have to set this flag early to avoid load() to be called
 311                 # be some of the functions below. This may lead to recursion or other bad things!
 312                 # as ther's only one thread of execution, this should be safe anyway.
 313                 $this->dataLoaded = true;
 314
 315
 316                 $this->metadata = serialize( $this->retrieveExifData( $this->imagePath ) );
 317
 318                 if ( isset( $gis['bits'] ) )  $this->bits = $gis['bits'];
 319                 else $this->bits = 0;
 320
 321                 wfProfileOut( $fname );
 322         }
 323
 324         /**
 325          * Load image metadata from the DB
 326          */
 327         function loadFromDB() {
 328                 global $wgUseSharedUploads, $wgSharedUploadDBname, $wgSharedUploadDBprefix, $wgContLang;
 329                 $fname = 'Image::loadFromDB';
 330                 wfProfileIn( $fname );
 331
 332                 $dbr =& wfGetDB( DB_SLAVE );
 333
 334                 $this->checkDBSchema($dbr);
 335
 336                 $row = $dbr->selectRow( 'image',
 337                         array( 'img_size', 'img_width', 'img_height', 'img_bits',
 338                                'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
 339                         array( 'img_name' => $this->name ), $fname );
 340                 if ( $row ) {
 341                         $this->fromSharedDirectory = false;
 342                         $this->fileExists = true;
 343                         $this->loadFromRow( $row );
 344                         $this->imagePath = $this->getFullPath();
 345                         // Check for rows from a previous schema, quietly upgrade them
 346                         if ( is_null($this->type) ) {
 347                                 $this->upgradeRow();
 348                         }
 349                 } elseif ( $wgUseSharedUploads && $wgSharedUploadDBname ) {
 350                         # In case we're on a wgCapitalLinks=false wiki, we
 351                         # capitalize the first letter of the filename before
 352                         # looking it up in the shared repository.
 353                         $name = $wgContLang->ucfirst($this->name);
 354                         $dbc =& wfGetDB( DB_SLAVE, 'commons' );
 355
 356                         $row = $dbc->selectRow( "`$wgSharedUploadDBname`.{$wgSharedUploadDBprefix}image",
 357                                 array(
 358                                         'img_size', 'img_width', 'img_height', 'img_bits',
 359                                         'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
 360                                 array( 'img_name' => $name ), $fname );
 361                         if ( $row ) {
 362                                 $this->fromSharedDirectory = true;
 363                                 $this->fileExists = true;
 364                                 $this->imagePath = $this->getFullPath(true);
 365                                 $this->name = $name;
 366                                 $this->loadFromRow( $row );
 367
 368                                 // Check for rows from a previous schema, quietly upgrade them
 369                                 if ( is_null($this->type) ) {
 370                                         $this->upgradeRow();
 371                                 }
 372                         }
 373                 }
 374
 375                 if ( !$row ) {
 376                         $this->size = 0;
 377                         $this->width = 0;
 378                         $this->height = 0;
 379                         $this->bits = 0;
 380                         $this->type = 0;
 381                         $this->fileExists = false;
 382                         $this->fromSharedDirectory = false;
 383                         $this->metadata = serialize ( array() ) ;
 384                 }
 385
 386                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 387                 $this->dataLoaded = true;
 388                 wfProfileOut( $fname );
 389         }
 390
 391         /*
 392          * Load image metadata from a DB result row
 393          */
 394         function loadFromRow( &$row ) {
 395                 $this->size = $row->img_size;
 396                 $this->width = $row->img_width;
 397                 $this->height = $row->img_height;
 398                 $this->bits = $row->img_bits;
 399                 $this->type = $row->img_media_type;
 400
 401                 $major= $row->img_major_mime;
 402                 $minor= $row->img_minor_mime;
 403
 404                 if (!$major) $this->mime = "unknown/unknown";
 405                 else {
 406                         if (!$minor) $minor= "unknown";
 407                         $this->mime = $major.'/'.$minor;
 408                 }
 409
 410                 $this->metadata = $row->img_metadata;
 411                 if ( $this->metadata == "" ) $this->metadata = serialize ( array() ) ;
 412
 413                 $this->dataLoaded = true;
 414         }
 415
 416         /**
 417          * Load image metadata from cache or DB, unless already loaded
 418          */
 419         function load() {
 420                 global $wgSharedUploadDBname, $wgUseSharedUploads;
 421                 if ( !$this->dataLoaded ) {
 422                         if ( !$this->loadFromCache() ) {
 423                                 $this->loadFromDB();
 424                                 if ( !$wgSharedUploadDBname && $wgUseSharedUploads ) {
 425                                         $this->loadFromFile();
 426                                 } elseif ( $this->fileExists ) {
 427                                         $this->saveToCache();
 428                                 }
 429                         }
 430                         $this->dataLoaded = true;
 431                 }
 432         }
 433
 434         /**
 435          * Metadata was loaded from the database, but the row had a marker indicating it needs to be
 436          * upgraded from the 1.4 schema, which had no width, height, bits or type. Upgrade the row.
 437          */
 438         function upgradeRow() {
 439                 global $wgDBname, $wgSharedUploadDBname;
 440                 $fname = 'Image::upgradeRow';
 441                 wfProfileIn( $fname );
 442
 443                 $this->loadFromFile();
 444
 445                 if ( $this->fromSharedDirectory ) {
 446                         if ( !$wgSharedUploadDBname ) {
 447                                 wfProfileOut( $fname );
 448                                 return;
 449                         }
 450
 451                         // Write to the other DB using selectDB, not database selectors
 452                         // This avoids breaking replication in MySQL
 453                         $dbw =& wfGetDB( DB_MASTER, 'commons' );
 454                         $dbw->selectDB( $wgSharedUploadDBname );
 455                 } else {
 456                         $dbw =& wfGetDB( DB_MASTER );
 457                 }
 458
 459                 $this->checkDBSchema($dbw);
 460
 461                 list( $major, $minor ) = self::splitMime( $this->mime );
 462
 463                 wfDebug("$fname: upgrading ".$this->name." to 1.5 schema\n");
 464
 465                 $dbw->update( 'image',
 466                         array(
 467                                 'img_width' => $this->width,
 468                                 'img_height' => $this->height,
 469                                 'img_bits' => $this->bits,
 470                                 'img_media_type' => $this->type,
 471                                 'img_major_mime' => $major,
 472                                 'img_minor_mime' => $minor,
 473                                 'img_metadata' => $this->metadata,
 474                         ), array( 'img_name' => $this->name ), $fname
 475                 );
 476                 if ( $this->fromSharedDirectory ) {
 477                         $dbw->selectDB( $wgDBname );
 478                 }
 479                 wfProfileOut( $fname );
 480         }
 481
 482         /**
 483          * Split an internet media type into its two components; if not
 484          * a two-part name, set the minor type to 'unknown'.
 485          *
 486          * @param $mime "text/html" etc
 487          * @return array ("text", "html") etc
 488          */
 489         static function splitMime( $mime ) {
 490                 if( strpos( $mime, '/' ) !== false ) {
 491                         return explode( '/', $mime, 2 );
 492                 } else {
 493                         return array( $mime, 'unknown' );
 494                 }
 495         }
 496
 497         /**
 498          * Return the name of this image
 499          * @public
 500          */
 501         function getName() {
 502                 return $this->name;
 503         }
 504
 505         /**
 506          * Return the associated title object
 507          * @public
 508          */
 509         function getTitle() {
 510                 return $this->title;
 511         }
 512
 513         /**
 514          * Return the URL of the image file
 515          * @public
 516          */
 517         function getURL() {
 518                 if ( !$this->url ) {
 519                         $this->load();
 520                         if($this->fileExists) {
 521                                 $this->url = Image::imageUrl( $this->name, $this->fromSharedDirectory );
 522                         } else {
 523                                 $this->url = '';
 524                         }
 525                 }
 526                 return $this->url;
 527         }
 528
 529         function getViewURL() {
 530                 if( $this->mustRender()) {
 531                         if( $this->canRender() ) {
 532                                 return $this->createThumb( $this->getWidth() );
 533                         }
 534                         else {
 535                                 wfDebug('Image::getViewURL(): supposed to render '.$this->name.' ('.$this->mime."), but can't!\n");
 536                                 return $this->getURL(); #hm... return NULL?
 537                         }
 538                 } else {
 539                         return $this->getURL();
 540                 }
 541         }
 542
 543         /**
 544          * Return the image path of the image in the
 545          * local file system as an absolute path
 546          * @public
 547          */
 548         function getImagePath() {
 549                 $this->load();
 550                 return $this->imagePath;
 551         }
 552
 553         /**
 554          * Return the width of the image
 555          *
 556          * Returns -1 if the file specified is not a known image type
 557          * @public
 558          */
 559         function getWidth() {
 560                 $this->load();
 561                 return $this->width;
 562         }
 563
 564         /**
 565          * Return the height of the image
 566          *
 567          * Returns -1 if the file specified is not a known image type
 568          * @public
 569          */
 570         function getHeight() {
 571                 $this->load();
 572                 return $this->height;
 573         }
 574
 575         /**
 576          * Return the size of the image file, in bytes
 577          * @public
 578          */
 579         function getSize() {
 580                 $this->load();
 581                 return $this->size;
 582         }
 583
 584         /**
 585          * Returns the mime type of the file.
 586          */
 587         function getMimeType() {
 588                 $this->load();
 589                 return $this->mime;
 590         }
 591
 592         /**
 593          * Return the type of the media in the file.
 594          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 595          */
 596         function getMediaType() {
 597                 $this->load();
 598                 return $this->type;
 599         }
 600
 601         /**
 602          * Checks if the file can be presented to the browser as a bitmap.
 603          *
 604          * Currently, this checks if the file is an image format
 605          * that can be converted to a format
 606          * supported by all browsers (namely GIF, PNG and JPEG),
 607          * or if it is an SVG image and SVG conversion is enabled.
 608          *
 609          * @todo remember the result of this check.
 610          */
 611         function canRender() {
 612                 global $wgUseImageMagick;
 613
 614                 if( $this->getWidth()<=0 || $this->getHeight()<=0 ) return false;
 615
 616                 $mime= $this->getMimeType();
 617
 618                 if (!$mime || $mime==='unknown' || $mime==='unknown/unknown') return false;
 619
 620                 #if it's SVG, check if there's a converter enabled
 621                 if ($mime === 'image/svg') {
 622                         global $wgSVGConverters, $wgSVGConverter;
 623
 624                         if ($wgSVGConverter && isset( $wgSVGConverters[$wgSVGConverter])) {
 625                                 wfDebug( "Image::canRender: SVG is ready!\n" );
 626                                 return true;
 627                         } else {
 628                                 wfDebug( "Image::canRender: SVG renderer missing\n" );
 629                         }
 630                 }
 631
 632                 #image formats available on ALL browsers
 633                 if (  $mime === 'image/gif'
 634                    || $mime === 'image/png'
 635                    || $mime === 'image/jpeg' ) return true;
 636
 637                 #image formats that can be converted to the above formats
 638                 if ($wgUseImageMagick) {
 639                         #convertable by ImageMagick (there are more...)
 640                         if ( $mime === 'image/vnd.wap.wbmp'
 641                           || $mime === 'image/x-xbitmap'
 642                           || $mime === 'image/x-xpixmap'
 643                           #|| $mime === 'image/x-icon'   #file may be split into multiple parts
 644                           || $mime === 'image/x-portable-anymap'
 645                           || $mime === 'image/x-portable-bitmap'
 646                           || $mime === 'image/x-portable-graymap'
 647                           || $mime === 'image/x-portable-pixmap'
 648                           #|| $mime === 'image/x-photoshop'  #this takes a lot of CPU and RAM!
 649                           || $mime === 'image/x-rgb'
 650                           || $mime === 'image/x-bmp'
 651                           || $mime === 'image/tiff' ) return true;
 652                 }
 653                 else {
 654                         #convertable by the PHP GD image lib
 655                         if ( $mime === 'image/vnd.wap.wbmp'
 656                           || $mime === 'image/x-xbitmap' ) return true;
 657                 }
 658
 659                 return false;
 660         }
 661
 662
 663         /**
 664          * Return true if the file is of a type that can't be directly
 665          * rendered by typical browsers and needs to be re-rasterized.
 666          *
 667          * This returns true for everything but the bitmap types
 668          * supported by all browsers, i.e. JPEG; GIF and PNG. It will
 669          * also return true for any non-image formats.
 670          *
 671          * @return bool
 672          */
 673         function mustRender() {
 674                 $mime= $this->getMimeType();
 675
 676                 if (  $mime === "image/gif"
 677                    || $mime === "image/png"
 678                    || $mime === "image/jpeg" ) return false;
 679
 680                 return true;
 681         }
 682
 683         /**
 684          * Determines if this media file may be shown inline on a page.
 685          *
 686          * This is currently synonymous to canRender(), but this could be
 687          * extended to also allow inline display of other media,
 688          * like flash animations or videos. If you do so, please keep in mind that
 689          * that could be a security risk.
 690          */
 691         function allowInlineDisplay() {
 692                 return $this->canRender();
 693         }
 694
 695         /**
 696          * Determines if this media file is in a format that is unlikely to
 697          * contain viruses or malicious content. It uses the global
 698          * $wgTrustedMediaFormats list to determine if the file is safe.
 699          *
 700          * This is used to show a warning on the description page of non-safe files.
 701          * It may also be used to disallow direct [[media:...]] links to such files.
 702          *
 703          * Note that this function will always return true if allowInlineDisplay()
 704          * or isTrustedFile() is true for this file.
 705          */
 706         function isSafeFile() {
 707                 if ($this->allowInlineDisplay()) return true;
 708                 if ($this->isTrustedFile()) return true;
 709
 710                 global $wgTrustedMediaFormats;
 711
 712                 $type= $this->getMediaType();
 713                 $mime= $this->getMimeType();
 714                 #wfDebug("Image::isSafeFile: type= $type, mime= $mime\n");
 715
 716                 if (!$type || $type===MEDIATYPE_UNKNOWN) return false; #unknown type, not trusted
 717                 if ( in_array( $type, $wgTrustedMediaFormats) ) return true;
 718
 719                 if ($mime==="unknown/unknown") return false; #unknown type, not trusted
 720                 if ( in_array( $mime, $wgTrustedMediaFormats) ) return true;
 721
 722                 return false;
 723         }
 724
 725         /** Returns true if the file is flagged as trusted. Files flagged that way
 726         * can be linked to directly, even if that is not allowed for this type of
 727         * file normally.
 728         *
 729         * This is a dummy function right now and always returns false. It could be
 730         * implemented to extract a flag from the database. The trusted flag could be
 731         * set on upload, if the user has sufficient privileges, to bypass script-
 732         * and html-filters. It may even be coupled with cryptographics signatures
 733         * or such.
 734         */
 735         function isTrustedFile() {
 736                 #this could be implemented to check a flag in the databas,
 737                 #look for signatures, etc
 738                 return false;
 739         }
 740
 741         /**
 742          * Return the escapeLocalURL of this image
 743          * @public
 744          */
 745         function getEscapeLocalURL() {
 746                 $this->getTitle();
 747                 return $this->title->escapeLocalURL();
 748         }
 749
 750         /**
 751          * Return the escapeFullURL of this image
 752          * @public
 753          */
 754         function getEscapeFullURL() {
 755                 $this->getTitle();
 756                 return $this->title->escapeFullURL();
 757         }
 758
 759         /**
 760          * Return the URL of an image, provided its name.
 761          *
 762          * @param string $name  Name of the image, without the leading "Image:"
 763          * @param boolean $fromSharedDirectory  Should this be in $wgSharedUploadPath?
 764          * @return string URL of $name image
 765          * @public
 766          * @static
 767          */
 768         function imageUrl( $name, $fromSharedDirectory = false ) {
 769                 global $wgUploadPath,$wgUploadBaseUrl,$wgSharedUploadPath;
 770                 if($fromSharedDirectory) {
 771                         $base = '';
 772                         $path = $wgSharedUploadPath;
 773                 } else {
 774                         $base = $wgUploadBaseUrl;
 775                         $path = $wgUploadPath;
 776                 }
 777                 $url = "{$base}{$path}" .  wfGetHashPath($name, $fromSharedDirectory) . "{$name}";
 778                 return wfUrlencode( $url );
 779         }
 780
 781         /**
 782          * Returns true if the image file exists on disk.
 783          * @return boolean Whether image file exist on disk.
 784          * @public
 785          */
 786         function exists() {
 787                 $this->load();
 788                 return $this->fileExists;
 789         }
 790
 791         /**
 792          * @todo document
 793          * @private
 794          */
 795         function thumbUrl( $width, $subdir='thumb') {
 796                 global $wgUploadPath, $wgUploadBaseUrl, $wgSharedUploadPath;
 797                 global $wgSharedThumbnailScriptPath, $wgThumbnailScriptPath;
 798
 799                 // Generate thumb.php URL if possible
 800                 $script = false;
 801                 $url = false;
 802
 803                 if ( $this->fromSharedDirectory ) {
 804                         if ( $wgSharedThumbnailScriptPath ) {
 805                                 $script = $wgSharedThumbnailScriptPath;
 806                         }
 807                 } else {
 808                         if ( $wgThumbnailScriptPath ) {
 809                                 $script = $wgThumbnailScriptPath;
 810                         }
 811                 }
 812                 if ( $script ) {
 813                         $url = $script . '?f=' . urlencode( $this->name ) . '&w=' . urlencode( $width );
 814                         if( $this->mustRender() ) {
 815                                 $url.= '&r=1';
 816                         }
 817                 } else {
 818                         $name = $this->thumbName( $width );
 819                         if($this->fromSharedDirectory) {
 820                                 $base = '';
 821                                 $path = $wgSharedUploadPath;
 822                         } else {
 823                                 $base = $wgUploadBaseUrl;
 824                                 $path = $wgUploadPath;
 825                         }
 826                         if ( Image::isHashed( $this->fromSharedDirectory ) ) {
 827                                 $url = "{$base}{$path}/{$subdir}" .
 828                                 wfGetHashPath($this->name, $this->fromSharedDirectory)
 829                                 . $this->name.'/'.$name;
 830                                 $url = wfUrlencode( $url );
 831                         } else {
 832                                 $url = "{$base}{$path}/{$subdir}/{$name}";
 833                         }
 834                 }
 835                 return array( $script !== false, $url );
 836         }
 837
 838         /**
 839          * Return the file name of a thumbnail of the specified width
 840          *
 841          * @param integer $width        Width of the thumbnail image
 842          * @param boolean $shared       Does the thumbnail come from the shared repository?
 843          * @private
 844          */
 845         function thumbName( $width ) {
 846                 $thumb = $width."px-".$this->name;
 847
 848                 if( $this->mustRender() ) {
 849                         if( $this->canRender() ) {
 850                                 # Rasterize to PNG (for SVG vector images, etc)
 851                                 $thumb .= '.png';
 852                         }
 853                         else {
 854                                 #should we use iconThumb here to get a symbolic thumbnail?
 855                                 #or should we fail with an internal error?
 856                                 return NULL; //can't make bitmap
 857                         }
 858                 }
 859                 return $thumb;
 860         }
 861
 862         /**
 863          * Create a thumbnail of the image having the specified width/height.
 864          * The thumbnail will not be created if the width is larger than the
 865          * image's width. Let the browser do the scaling in this case.
 866          * The thumbnail is stored on disk and is only computed if the thumbnail
 867          * file does not exist OR if it is older than the image.
 868          * Returns the URL.
 869          *
 870          * Keeps aspect ratio of original image. If both width and height are
 871          * specified, the generated image will be no bigger than width x height,
 872          * and will also have correct aspect ratio.
 873          *
 874          * @param integer $width        maximum width of the generated thumbnail
 875          * @param integer $height       maximum height of the image (optional)
 876          * @public
 877          */
 878         function createThumb( $width, $height=-1 ) {
 879                 $thumb = $this->getThumbnail( $width, $height );
 880                 if( is_null( $thumb ) ) return '';
 881                 return $thumb->getUrl();
 882         }
 883
 884         /**
 885          * As createThumb, but returns a ThumbnailImage object. This can
 886          * provide access to the actual file, the real size of the thumb,
 887          * and can produce a convenient <img> tag for you.
 888          *
 889          * @param integer $width        maximum width of the generated thumbnail
 890          * @param integer $height       maximum height of the image (optional)
 891          * @return ThumbnailImage or null on failure
 892          * @public
 893          */
 894         function getThumbnail( $width, $height=-1 ) {
 895                 if ( $height <= 0 ) {
 896                         return $this->renderThumb( $width );
 897                 }
 898                 $this->load();
 899
 900                 if ($this->canRender()) {
 901                         if ( $width > $this->width * $height / $this->height )
 902                                 $width = wfFitBoxWidth( $this->width, $this->height, $height );
 903                         $thumb = $this->renderThumb( $width );
 904                 }
 905                 else $thumb= NULL; #not a bitmap or renderable image, don't try.
 906
 907                 return $thumb;
 908         }
 909
 910         /**
 911          * @return ThumbnailImage
 912          */
 913         function iconThumb() {
 914                 global $wgStylePath, $wgStyleDirectory;
 915
 916                 $try = array( 'fileicon-' . $this->extension . '.png', 'fileicon.png' );
 917                 foreach( $try as $icon ) {
 918                         $path = '/common/images/icons/' . $icon;
 919                         $filepath = $wgStyleDirectory . $path;
 920                         if( file_exists( $filepath ) ) {
 921                                 return new ThumbnailImage( $wgStylePath . $path, 120, 120 );
 922                         }
 923                 }
 924                 return null;
 925         }
 926
 927         /**
 928          * Create a thumbnail of the image having the specified width.
 929          * The thumbnail will not be created if the width is larger than the
 930          * image's width. Let the browser do the scaling in this case.
 931          * The thumbnail is stored on disk and is only computed if the thumbnail
 932          * file does not exist OR if it is older than the image.
 933          * Returns an object which can return the pathname, URL, and physical
 934          * pixel size of the thumbnail -- or null on failure.
 935          *
 936          * @return ThumbnailImage or null on failure
 937          * @private
 938          */
 939         function renderThumb( $width, $useScript = true ) {
 940                 global $wgUseSquid;
 941                 global $wgSVGMaxSize, $wgMaxImageArea, $wgThumbnailEpoch;
 942
 943                 $fname = 'Image::renderThumb';
 944                 wfProfileIn( $fname );
 945
 946                 $width = intval( $width );
 947
 948                 $this->load();
 949                 if ( ! $this->exists() )
 950                 {
 951                         # If there is no image, there will be no thumbnail
 952                         wfProfileOut( $fname );
 953                         return null;
 954                 }
 955
 956                 # Sanity check $width
 957                 if( $width <= 0 || $this->width <= 0) {
 958                         # BZZZT
 959                         wfProfileOut( $fname );
 960                         return null;
 961                 }
 962
 963                 # Don't thumbnail an image so big that it will fill hard drives and send servers into swap
 964                 # JPEG has the handy property of allowing thumbnailing without full decompression, so we make
 965                 # an exception for it.
 966                 if ( $this->getMediaType() == MEDIATYPE_BITMAP &&
 967                         $this->getMimeType() !== 'image/jpeg' &&
 968                         $this->width * $this->height > $wgMaxImageArea )
 969                 {
 970                         wfProfileOut( $fname );
 971                         return null;
 972                 }
 973
 974                 # Don't make an image bigger than the source, or wgMaxSVGSize for SVGs
 975                 if ( $this->mustRender() ) {
 976                         $width = min( $width, $wgSVGMaxSize );
 977                 } elseif ( $width > $this->width - 1 ) {
 978                         $thumb = new ThumbnailImage( $this->getURL(), $this->getWidth(), $this->getHeight() );
 979                         wfProfileOut( $fname );
 980                         return $thumb;
 981                 }
 982
 983                 $height = round( $this->height * $width / $this->width );
 984
 985                 list( $isScriptUrl, $url ) = $this->thumbUrl( $width );
 986                 if ( $isScriptUrl && $useScript ) {
 987                         // Use thumb.php to render the image
 988                         $thumb = new ThumbnailImage( $url, $width, $height );
 989                         wfProfileOut( $fname );
 990                         return $thumb;
 991                 }
 992
 993                 $thumbName = $this->thumbName( $width, $this->fromSharedDirectory );
 994                 $thumbPath = wfImageThumbDir( $this->name, $this->fromSharedDirectory ).'/'.$thumbName;
 995
 996                 if ( is_dir( $thumbPath ) ) {
 997                         // Directory where file should be
 998                         // This happened occasionally due to broken migration code in 1.5
 999                         // Rename to broken-*
1000                         global $wgUploadDirectory;
1001                         for ( $i = 0; $i < 100 ; $i++ ) {
1002                                 $broken = "$wgUploadDirectory/broken-$i-$thumbName";
1003                                 if ( !file_exists( $broken ) ) {
1004                                         rename( $thumbPath, $broken );
1005                                         break;
1006                                 }
1007                         }
1008                         // Code below will ask if it exists, and the answer is now no
1009                         clearstatcache();
1010                 }
1011
1012                 $done = true;
1013                 if ( !file_exists( $thumbPath ) ||
1014                         filemtime( $thumbPath ) < wfTimestamp( TS_UNIX, $wgThumbnailEpoch ) ) {
1015                         $oldThumbPath = wfDeprecatedThumbDir( $thumbName, 'thumb', $this->fromSharedDirectory ).
1016                                 '/'.$thumbName;
1017                         $done = false;
1018
1019                         // Migration from old directory structure
1020                         if ( is_file( $oldThumbPath ) ) {
1021                                 if ( filemtime($oldThumbPath) >= filemtime($this->imagePath) ) {
1022                                         if ( file_exists( $thumbPath ) ) {
1023                                                 if ( !is_dir( $thumbPath ) ) {
1024                                                         // Old image in the way of rename
1025                                                         unlink( $thumbPath );
1026                                                 } else {
1027                                                         // This should have been dealt with already
1028                                                         throw new MWException( "Directory where image should be: $thumbPath" );
1029                                                 }
1030                                         }
1031                                         // Rename the old image into the new location
1032                                         rename( $oldThumbPath, $thumbPath );
1033                                         $done = true;
1034                                 } else {
1035                                         unlink( $oldThumbPath );
1036                                 }
1037                         }
1038                         if ( !$done ) {
1039                                 $this->lastError = $this->reallyRenderThumb( $thumbPath, $width, $height );
1040                                 if ( $this->lastError === true ) {
1041                                         $done = true;
1042                                 } elseif( $GLOBALS['wgIgnoreImageErrors'] ) {
1043                                         // Log the error but output anyway.
1044                                         // With luck it's a transitory error...
1045                                         $done = true;
1046                                 }
1047
1048                                 # Purge squid
1049                                 # This has to be done after the image is updated and present for all machines on NFS,
1050                                 # or else the old version might be stored into the squid again
1051                                 if ( $wgUseSquid ) {
1052                                         $urlArr = array( $url );
1053                                         wfPurgeSquidServers($urlArr);
1054                                 }
1055                         }
1056                 }
1057
1058                 if ( $done ) {
1059                         $thumb = new ThumbnailImage( $url, $width, $height, $thumbPath );
1060                 } else {
1061                         $thumb = null;
1062                 }
1063                 wfProfileOut( $fname );
1064                 return $thumb;
1065         } // END OF function renderThumb
1066
1067         /**
1068          * Really render a thumbnail
1069          * Call this only for images for which canRender() returns true.
1070          *
1071          * @param string $thumbPath Path to thumbnail
1072          * @param int $width Desired width in pixels
1073          * @param int $height Desired height in pixels
1074          * @return bool True on error, false or error string on failure.
1075          * @private
1076          */
1077         function reallyRenderThumb( $thumbPath, $width, $height ) {
1078                 global $wgSVGConverters, $wgSVGConverter;
1079                 global $wgUseImageMagick, $wgImageMagickConvertCommand;
1080                 global $wgCustomConvertCommand;
1081
1082                 $this->load();
1083
1084                 $err = false;
1085                 $cmd = "";
1086                 $retval = 0;
1087
1088                 if( $this->mime === "image/svg" ) {
1089                         #Right now we have only SVG
1090
1091                         global $wgSVGConverters, $wgSVGConverter;
1092                         if( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
1093                                 global $wgSVGConverterPath;
1094                                 $cmd = str_replace(
1095                                         array( '$path/', '$width', '$height', '$input', '$output' ),
1096                                         array( $wgSVGConverterPath ? "$wgSVGConverterPath/" : "",
1097                                                    intval( $width ),
1098                                                    intval( $height ),
1099                                                    wfEscapeShellArg( $this->imagePath ),
1100                                                    wfEscapeShellArg( $thumbPath ) ),
1101                                         $wgSVGConverters[$wgSVGConverter] );
1102                                 wfProfileIn( 'rsvg' );
1103                                 wfDebug( "reallyRenderThumb SVG: $cmd\n" );
1104                                 $err = wfShellExec( $cmd, $retval );
1105                                 wfProfileOut( 'rsvg' );
1106                         }
1107                 } elseif ( $wgUseImageMagick ) {
1108                         # use ImageMagick
1109
1110                         if ( $this->mime == 'image/jpeg' ) {
1111                                 $quality = "-quality 80"; // 80%
1112                         } elseif ( $this->mime == 'image/png' ) {
1113                                 $quality = "-quality 95"; // zlib 9, adaptive filtering
1114                         } else {
1115                                 $quality = ''; // default
1116                         }
1117
1118                         # Specify white background color, will be used for transparent images
1119                         # in Internet Explorer/Windows instead of default black.
1120
1121                         # Note, we specify "-size {$width}" and NOT "-size {$width}x{$height}".
1122                         # It seems that ImageMagick has a bug wherein it produces thumbnails of
1123                         # the wrong size in the second case.
1124
1125                         $cmd  =  wfEscapeShellArg($wgImageMagickConvertCommand) .
1126                                 " {$quality} -background white -size {$width} ".
1127                                 wfEscapeShellArg($this->imagePath) .
1128                                 // Coalesce is needed to scale animated GIFs properly (bug 1017).
1129                                 ' -coalesce ' .
1130                                 // For the -resize option a "!" is needed to force exact size,
1131                                 // or ImageMagick may decide your ratio is wrong and slice off
1132                                 // a pixel.
1133                                 " -resize " . wfEscapeShellArg( "{$width}x{$height}!" ) .
1134                                 " -depth 8 " .
1135                                 wfEscapeShellArg($thumbPath) . " 2>&1";
1136                         wfDebug("reallyRenderThumb: running ImageMagick: $cmd\n");
1137                         wfProfileIn( 'convert' );
1138                         $err = wfShellExec( $cmd, $retval );
1139                         wfProfileOut( 'convert' );
1140                 } elseif( $wgCustomConvertCommand ) {
1141                         # Use a custom convert command
1142                         # Variables: %s %d %w %h
1143                         $src = wfEscapeShellArg( $this->imagePath );
1144                         $dst = wfEscapeShellArg( $thumbPath );
1145                         $cmd = $wgCustomConvertCommand;
1146                         $cmd = str_replace( '%s', $src, str_replace( '%d', $dst, $cmd ) ); # Filenames
1147                         $cmd = str_replace( '%h', $height, str_replace( '%w', $width, $cmd ) ); # Size
1148                         wfDebug( "reallyRenderThumb: Running custom convert command $cmd\n" );
1149                         wfProfileIn( 'convert' );
1150                         $err = wfShellExec( $cmd, $retval );
1151                         wfProfileOut( 'convert' );
1152                 } else {
1153                         # Use PHP's builtin GD library functions.
1154                         #
1155                         # First find out what kind of file this is, and select the correct
1156                         # input routine for this.
1157
1158                         $typemap = array(
1159                                 'image/gif'          => array( 'imagecreatefromgif',  'palette',   'imagegif'  ),
1160                                 'image/jpeg'         => array( 'imagecreatefromjpeg', 'truecolor', array( &$this, 'imageJpegWrapper' ) ),
1161                                 'image/png'          => array( 'imagecreatefrompng',  'bits',      'imagepng'  ),
1162                                 'image/vnd.wap.wmbp' => array( 'imagecreatefromwbmp', 'palette',   'imagewbmp'  ),
1163                                 'image/xbm'          => array( 'imagecreatefromxbm',  'palette',   'imagexbm'  ),
1164                         );
1165                         if( !isset( $typemap[$this->mime] ) ) {
1166                                 $err = 'Image type not supported';
1167                                 wfDebug( "$err\n" );
1168                                 return $err;
1169                         }
1170                         list( $loader, $colorStyle, $saveType ) = $typemap[$this->mime];
1171
1172                         if( !function_exists( $loader ) ) {
1173                                 $err = "Incomplete GD library configuration: missing function $loader";
1174                                 wfDebug( "$err\n" );
1175                                 return $err;
1176                         }
1177                         if( $colorStyle == 'palette' ) {
1178                                 $truecolor = false;
1179                         } elseif( $colorStyle == 'truecolor' ) {
1180                                 $truecolor = true;
1181                         } elseif( $colorStyle == 'bits' ) {
1182                                 $truecolor = ( $this->bits > 8 );
1183                         }
1184
1185                         $src_image = call_user_func( $loader, $this->imagePath );
1186                         if ( $truecolor ) {
1187                                 $dst_image = imagecreatetruecolor( $width, $height );
1188                         } else {
1189                                 $dst_image = imagecreate( $width, $height );
1190                         }
1191                         imagecopyresampled( $dst_image, $src_image,
1192                                                 0,0,0,0,
1193                                                 $width, $height, $this->width, $this->height );
1194                         call_user_func( $saveType, $dst_image, $thumbPath );
1195                         imagedestroy( $dst_image );
1196                         imagedestroy( $src_image );
1197                 }
1198
1199                 #
1200                 # Check for zero-sized thumbnails. Those can be generated when
1201                 # no disk space is available or some other error occurs
1202                 #
1203                 if( file_exists( $thumbPath ) ) {
1204                         $thumbstat = stat( $thumbPath );
1205                         if( $thumbstat['size'] == 0 || $retval != 0 ) {
1206                                 wfDebugLog( 'thumbnail',
1207                                         sprintf( 'Removing bad %d-byte thumbnail "%s"',
1208                                                 $thumbstat['size'], $thumbPath ) );
1209                                 unlink( $thumbPath );
1210                         }
1211                 }
1212                 if ( $retval != 0 ) {
1213                         wfDebugLog( 'thumbnail',
1214                                 sprintf( 'thumbnail failed on %s: error %d "%s" from "%s"',
1215                                         wfHostname(), $retval, trim($err), $cmd ) );
1216                         return wfMsg( 'thumbnail_error', $err );
1217                 } else {
1218                         return true;
1219                 }
1220         }
1221
1222         function getLastError() {
1223                 return $this->lastError;
1224         }
1225
1226         function imageJpegWrapper( $dst_image, $thumbPath ) {
1227                 imageinterlace( $dst_image );
1228                 imagejpeg( $dst_image, $thumbPath, 95 );
1229         }
1230
1231         /**
1232          * Get all thumbnail names previously generated for this image
1233          */
1234         function getThumbnails( $shared = false ) {
1235                 if ( Image::isHashed( $shared ) ) {
1236                         $this->load();
1237                         $files = array();
1238                         $dir = wfImageThumbDir( $this->name, $shared );
1239
1240                         // This generates an error on failure, hence the @
1241                         $handle = @opendir( $dir );
1242
1243                         if ( $handle ) {
1244                                 while ( false !== ( $file = readdir($handle) ) ) {
1245                                         if ( $file{0} != '.' ) {
1246                                                 $files[] = $file;
1247                                         }
1248                                 }
1249                                 closedir( $handle );
1250                         }
1251                 } else {
1252                         $files = array();
1253                 }
1254
1255                 return $files;
1256         }
1257
1258         /**
1259          * Refresh metadata in memcached, but don't touch thumbnails or squid
1260          */
1261         function purgeMetadataCache() {
1262                 clearstatcache();
1263                 $this->loadFromFile();
1264                 $this->saveToCache();
1265         }
1266
1267         /**
1268          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
1269          */
1270         function purgeCache( $archiveFiles = array(), $shared = false ) {
1271                 global $wgUseSquid;
1272
1273                 // Refresh metadata cache
1274                 $this->purgeMetadataCache();
1275
1276                 // Delete thumbnails
1277                 $files = $this->getThumbnails( $shared );
1278                 $dir = wfImageThumbDir( $this->name, $shared );
1279                 $urls = array();
1280                 foreach ( $files as $file ) {
1281                         if ( preg_match( '/^(\d+)px/', $file, $m ) ) {
1282                                 $urls[] = $this->thumbUrl( $m[1], $this->fromSharedDirectory );
1283                                 @unlink( "$dir/$file" );
1284                         }
1285                 }
1286
1287                 // Purge the squid
1288                 if ( $wgUseSquid ) {
1289                         $urls[] = $this->getViewURL();
1290                         foreach ( $archiveFiles as $file ) {
1291                                 $urls[] = wfImageArchiveUrl( $file );
1292                         }
1293                         wfPurgeSquidServers( $urls );
1294                 }
1295         }
1296
1297         /**
1298          * Purge the image description page, but don't go after
1299          * pages using the image. Use when modifying file history
1300          * but not the current data.
1301          */
1302         function purgeDescription() {
1303                 $page = Title::makeTitle( NS_IMAGE, $this->name );
1304                 $page->invalidateCache();
1305         }
1306
1307         /**
1308          * Purge metadata and all affected pages when the image is created,
1309          * deleted, or majorly updated. A set of additional URLs may be
1310          * passed to purge, such as specific image files which have changed.
1311          * @param $urlArray array
1312          */
1313         function purgeEverything( $urlArr=array() ) {
1314                 // Delete thumbnails and refresh image metadata cache
1315                 $this->purgeCache();
1316                 $this->purgeDescription();
1317
1318                 // Purge cache of all pages using this image
1319                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1320                 $update->doUpdate();
1321         }
1322
1323         function checkDBSchema(&$db) {
1324                 global $wgCheckDBSchema;
1325                 if (!$wgCheckDBSchema) {
1326                         return;
1327                 }
1328                 # img_name must be unique
1329                 if ( !$db->indexUnique( 'image', 'img_name' ) && !$db->indexExists('image','PRIMARY') ) {
1330                         throw new MWException( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
1331                 }
1332
1333                 # new fields must exist
1334                 #
1335                 # Not really, there's hundreds of checks like this that we could do and they're all pointless, because
1336                 # if the fields are missing, the database will loudly report a query error, the first time you try to do
1337                 # something. The only reason I put the above schema check in was because the absence of that particular
1338                 # index would lead to an annoying subtle bug. No error message, just some very odd behaviour on duplicate
1339                 # uploads. -- TS
1340                 /*
1341                 if ( !$db->fieldExists( 'image', 'img_media_type' )
1342                   || !$db->fieldExists( 'image', 'img_metadata' )
1343                   || !$db->fieldExists( 'image', 'img_width' ) ) {
1344
1345                         throw new MWException( 'Database schema not up to date, please run maintenance/update.php' );
1346                  }
1347                  */
1348         }
1349
1350         /**
1351          * Return the image history of this image, line by line.
1352          * starts with current version, then old versions.
1353          * uses $this->historyLine to check which line to return:
1354          *  0      return line for current version
1355          *  1      query for old versions, return first one
1356          *  2, ... return next old version from above query
1357          *
1358          * @public
1359          */
1360         function nextHistoryLine() {
1361                 $fname = 'Image::nextHistoryLine()';
1362                 $dbr =& wfGetDB( DB_SLAVE );
1363
1364                 $this->checkDBSchema($dbr);
1365
1366                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
1367                         $this->historyRes = $dbr->select( 'image',
1368                                 array(
1369                                         'img_size',
1370                                         'img_description',
1371                                         'img_user','img_user_text',
1372                                         'img_timestamp',
1373                                         'img_width',
1374                                         'img_height',
1375                                         "'' AS oi_archive_name"
1376                                 ),
1377                                 array( 'img_name' => $this->title->getDBkey() ),
1378                                 $fname
1379                         );
1380                         if ( 0 == wfNumRows( $this->historyRes ) ) {
1381                                 return FALSE;
1382                         }
1383                 } else if ( $this->historyLine == 1 ) {
1384                         $this->historyRes = $dbr->select( 'oldimage',
1385                                 array(
1386                                         'oi_size AS img_size',
1387                                         'oi_description AS img_description',
1388                                         'oi_user AS img_user',
1389                                         'oi_user_text AS img_user_text',
1390                                         'oi_timestamp AS img_timestamp',
1391                                         'oi_width as img_width',
1392                                         'oi_height as img_height',
1393                                         'oi_archive_name'
1394                                 ),
1395                                 array( 'oi_name' => $this->title->getDBkey() ),
1396                                 $fname,
1397                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
1398                         );
1399                 }
1400                 $this->historyLine ++;
1401
1402                 return $dbr->fetchObject( $this->historyRes );
1403         }
1404
1405         /**
1406          * Reset the history pointer to the first element of the history
1407          * @public
1408          */
1409         function resetHistory() {
1410                 $this->historyLine = 0;
1411         }
1412
1413         /**
1414         * Return the full filesystem path to the file. Note that this does
1415         * not mean that a file actually exists under that location.
1416         *
1417         * This path depends on whether directory hashing is active or not,
1418         * i.e. whether the images are all found in the same directory,
1419         * or in hashed paths like /images/3/3c.
1420         *
1421         * @public
1422         * @param boolean $fromSharedDirectory Return the path to the file
1423         *   in a shared repository (see $wgUseSharedRepository and related
1424         *   options in DefaultSettings.php) instead of a local one.
1425         *
1426         */
1427         function getFullPath( $fromSharedRepository = false ) {
1428                 global $wgUploadDirectory, $wgSharedUploadDirectory;
1429
1430                 $dir      = $fromSharedRepository ? $wgSharedUploadDirectory :
1431                                                     $wgUploadDirectory;
1432
1433                 // $wgSharedUploadDirectory may be false, if thumb.php is used
1434                 if ( $dir ) {
1435                         $fullpath = $dir . wfGetHashPath($this->name, $fromSharedRepository) . $this->name;
1436                 } else {
1437                         $fullpath = false;
1438                 }
1439
1440                 return $fullpath;
1441         }
1442
1443         /**
1444          * @return bool
1445          * @static
1446          */
1447         function isHashed( $shared ) {
1448                 global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
1449                 return $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
1450         }
1451
1452         /**
1453          * Record an image upload in the upload log and the image table
1454          */
1455         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
1456                 global $wgUser, $wgUseCopyrightUpload;
1457
1458                 $fname = 'Image::recordUpload';
1459                 $dbw =& wfGetDB( DB_MASTER );
1460
1461                 $this->checkDBSchema($dbw);
1462
1463                 // Delete thumbnails and refresh the metadata cache
1464                 $this->purgeCache();
1465
1466                 // Fail now if the image isn't there
1467                 if ( !$this->fileExists || $this->fromSharedDirectory ) {
1468                         wfDebug( "Image::recordUpload: File ".$this->imagePath." went missing!\n" );
1469                         return false;
1470                 }
1471
1472                 if ( $wgUseCopyrightUpload ) {
1473                         if ( $license != '' ) {
1474                                 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1475                         }
1476                         $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
1477                           '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1478                           "$licensetxt" .
1479                           '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1480                 } else {
1481                         if ( $license != '' ) {
1482                                 $filedesc = $desc == '' ? '' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n";
1483                                  $textdesc = $filedesc .
1484                                          '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1485                         } else {
1486                                 $textdesc = $desc;
1487                         }
1488                 }
1489
1490                 $now = $dbw->timestamp();
1491
1492                 #split mime type
1493                 if (strpos($this->mime,'/')!==false) {
1494                         list($major,$minor)= explode('/',$this->mime,2);
1495                 }
1496                 else {
1497                         $major= $this->mime;
1498                         $minor= "unknown";
1499                 }
1500
1501                 # Test to see if the row exists using INSERT IGNORE
1502                 # This avoids race conditions by locking the row until the commit, and also
1503                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1504                 $dbw->insert( 'image',
1505                         array(
1506                                 'img_name' => $this->name,
1507                                 'img_size'=> $this->size,
1508                                 'img_width' => intval( $this->width ),
1509                                 'img_height' => intval( $this->height ),
1510                                 'img_bits' => $this->bits,
1511                                 'img_media_type' => $this->type,
1512                                 'img_major_mime' => $major,
1513                                 'img_minor_mime' => $minor,
1514                                 'img_timestamp' => $now,
1515                                 'img_description' => $desc,
1516                                 'img_user' => $wgUser->getID(),
1517                                 'img_user_text' => $wgUser->getName(),
1518                                 'img_metadata' => $this->metadata,
1519                         ),
1520                         $fname,
1521                         'IGNORE'
1522                 );
1523
1524                 if( $dbw->affectedRows() == 0 ) {
1525                         # Collision, this is an update of an image
1526                         # Insert previous contents into oldimage
1527                         $dbw->insertSelect( 'oldimage', 'image',
1528                                 array(
1529                                         'oi_name' => 'img_name',
1530                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1531                                         'oi_size' => 'img_size',
1532                                         'oi_width' => 'img_width',
1533                                         'oi_height' => 'img_height',
1534                                         'oi_bits' => 'img_bits',
1535                                         'oi_timestamp' => 'img_timestamp',
1536                                         'oi_description' => 'img_description',
1537                                         'oi_user' => 'img_user',
1538                                         'oi_user_text' => 'img_user_text',
1539                                 ), array( 'img_name' => $this->name ), $fname
1540                         );
1541
1542                         # Update the current image row
1543                         $dbw->update( 'image',
1544                                 array( /* SET */
1545                                         'img_size' => $this->size,
1546                                         'img_width' => intval( $this->width ),
1547                                         'img_height' => intval( $this->height ),
1548                                         'img_bits' => $this->bits,
1549                                         'img_media_type' => $this->type,
1550                                         'img_major_mime' => $major,
1551                                         'img_minor_mime' => $minor,
1552                                         'img_timestamp' => $now,
1553                                         'img_description' => $desc,
1554                                         'img_user' => $wgUser->getID(),
1555                                         'img_user_text' => $wgUser->getName(),
1556                                         'img_metadata' => $this->metadata,
1557                                 ), array( /* WHERE */
1558                                         'img_name' => $this->name
1559                                 ), $fname
1560                         );
1561                 } else {
1562                         # This is a new image
1563                         # Update the image count
1564                         $site_stats = $dbw->tableName( 'site_stats' );
1565                         $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", $fname );
1566                 }
1567
1568                 $descTitle = $this->getTitle();
1569                 $article = new Article( $descTitle );
1570                 $minor = false;
1571                 $watch = $watch || $wgUser->isWatched( $descTitle );
1572                 $suppressRC = true; // There's already a log entry, so don't double the RC load
1573
1574                 if( $descTitle->exists() ) {
1575                         // TODO: insert a null revision into the page history for this update.
1576                         if( $watch ) {
1577                                 $wgUser->addWatch( $descTitle );
1578                         }
1579
1580                         # Invalidate the cache for the description page
1581                         $descTitle->invalidateCache();
1582                         $descTitle->purgeSquid();
1583                 } else {
1584                         // New image; create the description page.
1585                         $article->insertNewArticle( $textdesc, $desc, $minor, $watch, $suppressRC );
1586                 }
1587
1588                 # Add the log entry
1589                 $log = new LogPage( 'upload' );
1590                 $log->addEntry( 'upload', $descTitle, $desc );
1591
1592                 # Commit the transaction now, in case something goes wrong later
1593                 # The most important thing is that images don't get lost, especially archives
1594                 $dbw->immediateCommit();
1595
1596                 # Invalidate cache for all pages using this image
1597                 $update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
1598                 $update->doUpdate();
1599
1600                 return true;
1601         }
1602
1603         /**
1604          * Get an array of Title objects which are articles which use this image
1605          * Also adds their IDs to the link cache
1606          *
1607          * This is mostly copied from Title::getLinksTo()
1608          *
1609          * @deprecated Use HTMLCacheUpdate, this function uses too much memory
1610          */
1611         function getLinksTo( $options = '' ) {
1612                 $fname = 'Image::getLinksTo';
1613                 wfProfileIn( $fname );
1614
1615                 if ( $options ) {
1616                         $db =& wfGetDB( DB_MASTER );
1617                 } else {
1618                         $db =& wfGetDB( DB_SLAVE );
1619                 }
1620                 $linkCache =& LinkCache::singleton();
1621
1622                 extract( $db->tableNames( 'page', 'imagelinks' ) );
1623                 $encName = $db->addQuotes( $this->name );
1624                 $sql = "SELECT page_namespace,page_title,page_id FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
1625                 $res = $db->query( $sql, $fname );
1626
1627                 $retVal = array();
1628                 if ( $db->numRows( $res ) ) {
1629                         while ( $row = $db->fetchObject( $res ) ) {
1630                                 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1631                                         $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1632                                         $retVal[] = $titleObj;
1633                                 }
1634                         }
1635                 }
1636                 $db->freeResult( $res );
1637                 wfProfileOut( $fname );
1638                 return $retVal;
1639         }
1640
1641         /**
1642          * Retrive Exif data from the file and prune unrecognized tags
1643          * and/or tags with invalid contents
1644          *
1645          * @param $filename
1646          * @return array
1647          */
1648         private function retrieveExifData( $filename ) {
1649                 global $wgShowEXIF;
1650
1651                 /*
1652                 if ( $this->getMimeType() !== "image/jpeg" )
1653                         return array();
1654                 */
1655
1656                 if( $wgShowEXIF && file_exists( $filename ) ) {
1657                         $exif = new Exif( $filename );
1658                         return $exif->getFilteredData();
1659                 }
1660
1661                 return array();
1662         }
1663
1664         function getExifData() {
1665                 global $wgRequest;
1666                 if ( $this->metadata === '0' )
1667                         return array();
1668
1669                 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1670                 $ret = unserialize( $this->metadata );
1671
1672                 $oldver = isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) ? $ret['MEDIAWIKI_EXIF_VERSION'] : 0;
1673                 $newver = Exif::version();
1674
1675                 if ( !count( $ret ) || $purge || $oldver != $newver ) {
1676                         $this->purgeMetadataCache();
1677                         $this->updateExifData( $newver );
1678                 }
1679                 if ( isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) )
1680                         unset( $ret['MEDIAWIKI_EXIF_VERSION'] );
1681                 $format = new FormatExif( $ret );
1682
1683                 return $format->getFormattedData();
1684         }
1685
1686         function updateExifData( $version ) {
1687                 $fname = 'Image:updateExifData';
1688
1689                 if ( $this->getImagePath() === false ) # Not a local image
1690                         return;
1691
1692                 # Get EXIF data from image
1693                 $exif = $this->retrieveExifData( $this->imagePath );
1694                 if ( count( $exif ) ) {
1695                         $exif['MEDIAWIKI_EXIF_VERSION'] = $version;
1696                         $this->metadata = serialize( $exif );
1697                 } else {
1698                         $this->metadata = '0';
1699                 }
1700
1701                 # Update EXIF data in database
1702                 $dbw =& wfGetDB( DB_MASTER );
1703
1704                 $this->checkDBSchema($dbw);
1705
1706                 $dbw->update( 'image',
1707                         array( 'img_metadata' => $this->metadata ),
1708                         array( 'img_name' => $this->name ),
1709                         $fname
1710                 );
1711         }
1712
1713         /**
1714          * Returns true if the image does not come from the shared
1715          * image repository.
1716          *
1717          * @return bool
1718          */
1719         function isLocal() {
1720                 return !$this->fromSharedDirectory;
1721         }
1722
1723         /**
1724          * Was this image ever deleted from the wiki?
1725          *
1726          * @return bool
1727          */
1728         function wasDeleted() {
1729                 $title = Title::makeTitle( NS_IMAGE, $this->name );
1730                 return ( $title->isDeleted() > 0 );
1731         }
1732
1733         /**
1734          * Delete all versions of the image.
1735          *
1736          * Moves the files into an archive directory (or deletes them)
1737          * and removes the database rows.
1738          *
1739          * Cache purging is done; logging is caller's responsibility.
1740          *
1741          * @param $reason
1742          * @return true on success, false on some kind of failure
1743          */
1744         function delete( $reason ) {
1745                 $fname = __CLASS__ . '::' . __FUNCTION__;
1746                 $transaction = new FSTransaction();
1747                 $urlArr = array( $this->getURL() );
1748
1749                 if( !FileStore::lock() ) {
1750                         wfDebug( "$fname: failed to acquire file store lock, aborting\n" );
1751                         return false;
1752                 }
1753
1754                 try {
1755                         $dbw = wfGetDB( DB_MASTER );
1756                         $dbw->begin();
1757
1758                         // Delete old versions
1759                         $result = $dbw->select( 'oldimage',
1760                                 array( 'oi_archive_name' ),
1761                                 array( 'oi_name' => $this->name ) );
1762
1763                         while( $row = $dbw->fetchObject( $result ) ) {
1764                                 $oldName = $row->oi_archive_name;
1765
1766                                 $transaction->add( $this->prepareDeleteOld( $oldName, $reason ) );
1767
1768                                 // We'll need to purge this URL from caches...
1769                                 $urlArr[] = wfImageArchiveUrl( $oldName );
1770                         }
1771                         $dbw->freeResult( $result );
1772
1773                         // And the current version...
1774                         $transaction->add( $this->prepareDeleteCurrent( $reason ) );
1775
1776                         $dbw->immediateCommit();
1777                 } catch( MWException $e ) {
1778                         wfDebug( "$fname: db error, rolling back file transactions\n" );
1779                         $transaction->rollback();
1780                         FileStore::unlock();
1781                         throw $e;
1782                 }
1783
1784                 wfDebug( "$fname: deleted db items, applying file transactions\n" );
1785                 $transaction->commit();
1786                 FileStore::unlock();
1787
1788
1789                 // Update site_stats
1790                 $site_stats = $dbw->tableName( 'site_stats' );
1791                 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", $fname );
1792
1793                 $this->purgeEverything( $urlArr );
1794
1795                 return true;
1796         }
1797
1798
1799         /**
1800          * Delete an old version of the image.
1801          *
1802          * Moves the file into an archive directory (or deletes it)
1803          * and removes the database row.
1804          *
1805          * Cache purging is done; logging is caller's responsibility.
1806          *
1807          * @param $reason
1808          * @throws MWException or FSException on database or filestore failure
1809          * @return true on success, false on some kind of failure
1810          */
1811         function deleteOld( $archiveName, $reason ) {
1812                 $fname = __CLASS__ . '::' . __FUNCTION__;
1813                 $transaction = new FSTransaction();
1814                 $urlArr = array();
1815
1816                 if( !FileStore::lock() ) {
1817                         wfDebug( "$fname: failed to acquire file store lock, aborting\n" );
1818                         return false;
1819                 }
1820
1821                 $transaction = new FSTransaction();
1822                 try {
1823                         $dbw = wfGetDB( DB_MASTER );
1824                         $dbw->begin();
1825                         $transaction->add( $this->prepareDeleteOld( $archiveName, $reason ) );
1826                         $dbw->immediateCommit();
1827                 } catch( MWException $e ) {
1828                         wfDebug( "$fname: db error, rolling back file transaction\n" );
1829                         $transaction->rollback();
1830                         FileStore::unlock();
1831                         throw $e;
1832                 }
1833
1834                 wfDebug( "$fname: deleted db items, applying file transaction\n" );
1835                 $transaction->commit();
1836                 FileStore::unlock();
1837
1838                 $this->purgeDescription();
1839
1840                 // Squid purging
1841                 global $wgUseSquid;
1842                 if ( $wgUseSquid ) {
1843                         $urlArr = array(
1844                                 wfImageArchiveUrl( $archiveName ),
1845                                 $page->getInternalURL()
1846                         );
1847                         wfPurgeSquidServers( $urlArr );
1848                 }
1849                 return true;
1850         }
1851
1852         /**
1853          * Delete the current version of a file.
1854          * May throw a database error.
1855          * @return true on success, false on failure
1856          */
1857         private function prepareDeleteCurrent( $reason ) {
1858                 $fname = __CLASS__ . '::' . __FUNCTION__;
1859                 return $this->prepareDeleteVersion(
1860                         $this->getFullPath(),
1861                         $reason,
1862                         'image',
1863                         array(
1864                                 'fa_name'         => 'img_name',
1865                                 'fa_archive_name' => 'NULL',
1866                                 'fa_size'         => 'img_size',
1867                                 'fa_width'        => 'img_width',
1868                                 'fa_height'       => 'img_height',
1869                                 'fa_metadata'     => 'img_metadata',
1870                                 'fa_bits'         => 'img_bits',
1871                                 'fa_media_type'   => 'img_media_type',
1872                                 'fa_major_mime'   => 'img_major_mime',
1873                                 'fa_minor_mime'   => 'img_minor_mime',
1874                                 'fa_description'  => 'img_description',
1875                                 'fa_user'         => 'img_user',
1876                                 'fa_user_text'    => 'img_user_text',
1877                                 'fa_timestamp'    => 'img_timestamp' ),
1878                         array( 'img_name' => $this->name ),
1879                         $fname );
1880         }
1881
1882         /**
1883          * Delete a given older version of a file.
1884          * May throw a database error.
1885          * @return true on success, false on failure
1886          */
1887         private function prepareDeleteOld( $archiveName, $reason ) {
1888                 $fname = __CLASS__ . '::' . __FUNCTION__;
1889                 $oldpath = wfImageArchiveDir( $this->name ) .
1890                         DIRECTORY_SEPARATOR . $archiveName;
1891                 return $this->prepareDeleteVersion(
1892                         $oldpath,
1893                         $reason,
1894                         'oldimage',
1895                         array(
1896                                 'fa_name'         => 'oi_name',
1897                                 'fa_archive_name' => 'oi_archive_name',
1898                                 'fa_size'         => 'oi_size',
1899                                 'fa_width'        => 'oi_width',
1900                                 'fa_height'       => 'oi_height',
1901                                 'fa_metadata'     => 'NULL',
1902                                 'fa_bits'         => 'oi_bits',
1903                                 'fa_media_type'   => 'NULL',
1904                                 'fa_major_mime'   => 'NULL',
1905                                 'fa_minor_mime'   => 'NULL',
1906                                 'fa_description'  => 'oi_description',
1907                                 'fa_user'         => 'oi_user',
1908                                 'fa_user_text'    => 'oi_user_text',
1909                                 'fa_timestamp'    => 'oi_timestamp' ),
1910                         array(
1911                                 'oi_name' => $this->name,
1912                                 'oi_archive_name' => $archiveName ),
1913                         $fname );
1914         }
1915
1916         /**
1917          * Do the dirty work of backing up an image row and its file
1918          * (if $wgSaveDeletedFiles is on) and removing the originals.
1919          *
1920          * Must be run while the file store is locked and a database
1921          * transaction is open to avoid race conditions.
1922          *
1923          * @return FSTransaction
1924          */
1925         private function prepareDeleteVersion( $path, $reason, $table, $fieldMap, $where, $fname ) {
1926                 global $wgUser, $wgSaveDeletedFiles;
1927
1928                 // Dupe the file into the file store
1929                 if( file_exists( $path ) ) {
1930                         if( $wgSaveDeletedFiles ) {
1931                                 $group = 'deleted';
1932
1933                                 $store = FileStore::get( $group );
1934                                 $key = FileStore::calculateKey( $path, $this->extension );
1935                                 $transaction = $store->insert( $key, $path,
1936                                         FileStore::DELETE_ORIGINAL );
1937                         } else {
1938                                 $group = null;
1939                                 $key = null;
1940                                 $transaction = FileStore::deleteFile( $path );
1941                         }
1942                 } else {
1943                         wfDebug( "$fname deleting already-missing '$path'; moving on to database\n" );
1944                         $group = null;
1945                         $key = null;
1946                         $transaction = new FSTransaction(); // empty
1947                 }
1948
1949                 if( $transaction === false ) {
1950                         // Fail to restore?
1951                         wfDebug( "$fname: import to file store failed, aborting\n" );
1952                         throw new MWException( "Could not archive and delete file $path" );
1953                         return false;
1954                 }
1955
1956                 $dbw = wfGetDB( DB_MASTER );
1957                 $storageMap = array(
1958                         'fa_storage_group' => $dbw->addQuotes( $group ),
1959                         'fa_storage_key'   => $dbw->addQuotes( $key ),
1960
1961                         'fa_deleted_user'      => $dbw->addQuotes( $wgUser->getId() ),
1962                         'fa_deleted_timestamp' => $dbw->timestamp(),
1963                         'fa_deleted_reason'    => $dbw->addQuotes( $reason ) );
1964                 $allFields = array_merge( $storageMap, $fieldMap );
1965
1966                 try {
1967                         if( $wgSaveDeletedFiles ) {
1968                                 $dbw->insertSelect( 'filearchive', $table, $allFields, $where, $fname );
1969                         }
1970                         $dbw->delete( $table, $where, $fname );
1971                 } catch( DBQueryError $e ) {
1972                         // Something went horribly wrong!
1973                         // Leave the file as it was...
1974                         wfDebug( "$fname: database error, rolling back file transaction\n" );
1975                         $transaction->rollback();
1976                         throw $e;
1977                 }
1978
1979                 return $transaction;
1980         }
1981
1982         /**
1983          * Restore all or specified deleted revisions to the given file.
1984          * Permissions and logging are left to the caller.
1985          *
1986          * May throw database exceptions on error.
1987          *
1988          * @param $versions set of record ids of deleted items to restore,
1989          *                    or empty to restore all revisions.
1990          * @return the number of file revisions restored if successful,
1991          *         or false on failure
1992          */
1993         function restore( $versions=array() ) {
1994                 $fname = __CLASS__ . '::' . __FUNCTION__;
1995                 if( !FileStore::lock() ) {
1996                         wfDebug( "$fname could not acquire filestore lock\n" );
1997                         return false;
1998                 }
1999
2000                 $transaction = new FSTransaction();
2001                 try {
2002                         $dbw = wfGetDB( DB_MASTER );
2003                         $dbw->begin();
2004
2005                         // Re-confirm whether this image presently exists;
2006                         // if no we'll need to create an image record for the
2007                         // first item we restore.
2008                         $exists = $dbw->selectField( 'image', '1',
2009                                 array( 'img_name' => $this->name ),
2010                                 $fname );
2011
2012                         // Fetch all or selected archived revisions for the file,
2013                         // sorted from the most recent to the oldest.
2014                         $conditions = array( 'fa_name' => $this->name );
2015                         if( $versions ) {
2016                                 $conditions['fa_id'] = $versions;
2017                         }
2018
2019                         $result = $dbw->select( 'filearchive', '*',
2020                                 $conditions,
2021                                 $fname,
2022                                 array( 'ORDER BY' => 'fa_timestamp DESC' ) );
2023
2024                         if( $dbw->numRows( $result ) < count( $versions ) ) {
2025                                 // There's some kind of conflict or confusion;
2026                                 // we can't restore everything we were asked to.
2027                                 wfDebug( "$fname: couldn't find requested items\n" );
2028                                 $dbw->rollback();
2029                                 FileStore::unlock();
2030                                 return false;
2031                         }
2032
2033                         if( $dbw->numRows( $result ) == 0 ) {
2034                                 // Nothing to do.
2035                                 wfDebug( "$fname: nothing to do\n" );
2036                                 $dbw->rollback();
2037                                 FileStore::unlock();
2038                                 return true;
2039                         }
2040
2041                         $revisions = 0;
2042                         while( $row = $dbw->fetchObject( $result ) ) {
2043                                 $revisions++;
2044                                 $store = FileStore::get( $row->fa_storage_group );
2045                                 if( !$store ) {
2046                                         wfDebug( "$fname: skipping row with no file.\n" );
2047                                         continue;
2048                                 }
2049
2050                                 if( $revisions == 1 && !$exists ) {
2051                                         $destPath = wfImageDir( $row->fa_name ) .
2052                                                 DIRECTORY_SEPARATOR .
2053                                                 $row->fa_name;
2054
2055                                         // We may have to fill in data if this was originally
2056                                         // an archived file revision.
2057                                         if( is_null( $row->fa_metadata ) ) {
2058                                                 $tempFile = $store->filePath( $row->fa_storage_key );
2059                                                 $metadata = serialize( $this->retrieveExifData( $tempFile ) );
2060
2061                                                 $magic = wfGetMimeMagic();
2062                                                 $mime = $magic->guessMimeType( $tempFile, true );
2063                                                 $media_type = $magic->getMediaType( $tempFile, $mime );
2064                                                 list( $major_mime, $minor_mime ) = self::splitMime( $mime );
2065                                         } else {
2066                                                 $metadata   = $row->fa_metadata;
2067                                                 $major_mime = $row->fa_major_mime;
2068                                                 $minor_mime = $row->fa_minor_mime;
2069                                                 $media_type = $row->fa_media_type;
2070                                         }
2071
2072                                         $table = 'image';
2073                                         $fields = array(
2074                                                 'img_name'        => $row->fa_name,
2075                                                 'img_size'        => $row->fa_size,
2076                                                 'img_width'       => $row->fa_width,
2077                                                 'img_height'      => $row->fa_height,
2078                                                 'img_metadata'    => $metadata,
2079                                                 'img_bits'        => $row->fa_bits,
2080                                                 'img_media_type'  => $media_type,
2081                                                 'img_major_mime'  => $major_mime,
2082                                                 'img_minor_mime'  => $minor_mime,
2083                                                 'img_description' => $row->fa_description,
2084                                                 'img_user'        => $row->fa_user,
2085                                                 'img_user_text'   => $row->fa_user_text,
2086                                                 'img_timestamp'   => $row->fa_timestamp );
2087                                 } else {
2088                                         $archiveName = $row->fa_archive_name;
2089                                         if( $archiveName == '' ) {
2090                                                 // This was originally a current version; we
2091                                                 // have to devise a new archive name for it.
2092                                                 // Format is <timestamp of archiving>!<name>
2093                                                 $archiveName =
2094                                                         wfTimestamp( TS_MW, $row->fa_deleted_timestamp ) .
2095                                                         '!' . $row->fa_name;
2096                                         }
2097                                         $destPath = wfImageArchiveDir( $row->fa_name ) .
2098                                                 DIRECTORY_SEPARATOR . $archiveName;
2099
2100                                         $table = 'oldimage';
2101                                         $fields = array(
2102                                                 'oi_name'         => $row->fa_name,
2103                                                 'oi_archive_name' => $archiveName,
2104                                                 'oi_size'         => $row->fa_size,
2105                                                 'oi_width'        => $row->fa_width,
2106                                                 'oi_height'       => $row->fa_height,
2107                                                 'oi_bits'         => $row->fa_bits,
2108                                                 'oi_description'  => $row->fa_description,
2109                                                 'oi_user'         => $row->fa_user,
2110                                                 'oi_user_text'    => $row->fa_user_text,
2111                                                 'oi_timestamp'    => $row->fa_timestamp );
2112                                 }
2113
2114                                 $dbw->insert( $table, $fields, $fname );
2115                                 /// @fixme this delete is not totally safe, potentially
2116                                 $dbw->delete( 'filearchive',
2117                                         array( 'fa_id' => $row->fa_id ),
2118                                         $fname );
2119
2120                                 // Check if any other stored revisions use this file;
2121                                 // if so, we shouldn't remove the file from the deletion
2122                                 // archives so they will still work.
2123                                 $useCount = $dbw->selectField( 'filearchive',
2124                                         'COUNT(*)',
2125                                         array(
2126                                                 'fa_storage_group' => $row->fa_storage_group,
2127                                                 'fa_storage_key'   => $row->fa_storage_key ),
2128                                         $fname );
2129                                 if( $useCount == 0 ) {
2130                                         wfDebug( "$fname: nothing else using {$row->fa_storage_key}, will deleting after\n" );
2131                                         $flags = FileStore::DELETE_ORIGINAL;
2132                                 } else {
2133                                         $flags = 0;
2134                                 }
2135
2136                                 $transaction->add( $store->export( $row->fa_storage_key,
2137                                         $destPath, $flags ) );
2138                         }
2139
2140                         $dbw->immediateCommit();
2141                 } catch( MWException $e ) {
2142                         wfDebug( "$fname caught error, aborting\n" );
2143                         $transaction->rollback();
2144                         throw $e;
2145                 }
2146
2147                 $transaction->commit();
2148                 FileStore::unlock();
2149
2150                 if( $revisions > 0 ) {
2151                         if( !$exists ) {
2152                                 wfDebug( "$fname restored $revisions items, creating a new current\n" );
2153
2154                                 // Update site_stats
2155                                 $site_stats = $dbw->tableName( 'site_stats' );
2156                                 $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", $fname );
2157
2158                                 $this->purgeEverything();
2159                         } else {
2160                                 wfDebug( "$fname restored $revisions as archived versions\n" );
2161                                 $this->purgeDescription();
2162                         }
2163                 }
2164
2165                 return $revisions;
2166         }
2167
2168 } //class
2169
2170
2171 /**
2172  * Returns the image directory of an image
2173  * If the directory does not exist, it is created.
2174  * The result is an absolute path.
2175  *
2176  * This function is called from thumb.php before Setup.php is included
2177  *
2178  * @param $fname String: file name of the image file.
2179  * @public
2180  */
2181 function wfImageDir( $fname ) {
2182         global $wgUploadDirectory, $wgHashedUploadDirectory;
2183
2184         if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
2185
2186         $hash = md5( $fname );
2187         $oldumask = umask(0);
2188         $dest = $wgUploadDirectory . '/' . $hash{0};
2189         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
2190         $dest .= '/' . substr( $hash, 0, 2 );
2191         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
2192
2193         umask( $oldumask );
2194         return $dest;
2195 }
2196
2197 /**
2198  * Returns the image directory of an image's thubnail
2199  * If the directory does not exist, it is created.
2200  * The result is an absolute path.
2201  *
2202  * This function is called from thumb.php before Setup.php is included
2203  *
2204  * @param $fname String: file name of the original image file
2205  * @param $shared Boolean: (optional) use the shared upload directory (default: 'false').
2206  * @public
2207  */
2208 function wfImageThumbDir( $fname, $shared = false ) {
2209         $base = wfImageArchiveDir( $fname, 'thumb', $shared );
2210         if ( Image::isHashed( $shared ) ) {
2211                 $dir =  "$base/$fname";
2212
2213                 if ( !is_dir( $base ) ) {
2214                         $oldumask = umask(0);
2215                         @mkdir( $base, 0777 );
2216                         umask( $oldumask );
2217                 }
2218
2219                 if ( ! is_dir( $dir ) ) {
2220                         if ( is_file( $dir ) ) {
2221                                 // Old thumbnail in the way of directory creation, kill it
2222                                 unlink( $dir );
2223                         }
2224                         $oldumask = umask(0);
2225                         @mkdir( $dir, 0777 );
2226                         umask( $oldumask );
2227                 }
2228         } else {
2229                 $dir = $base;
2230         }
2231
2232         return $dir;
2233 }
2234
2235 /**
2236  * Old thumbnail directory, kept for conversion
2237  */
2238 function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
2239         return wfImageArchiveDir( $thumbName, $subdir, $shared );
2240 }
2241
2242 /**
2243  * Returns the image directory of an image's old version
2244  * If the directory does not exist, it is created.
2245  * The result is an absolute path.
2246  *
2247  * This function is called from thumb.php before Setup.php is included
2248  *
2249  * @param $fname String: file name of the thumbnail file, including file size prefix.
2250  * @param $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.
2251  * @param $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.
2252  * @public
2253  */
2254 function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
2255         global $wgUploadDirectory, $wgHashedUploadDirectory;
2256         global $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
2257         $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
2258         $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
2259         if (!$hashdir) { return $dir.'/'.$subdir; }
2260         $hash = md5( $fname );
2261         $oldumask = umask(0);
2262
2263         # Suppress warning messages here; if the file itself can't
2264         # be written we'll worry about it then.
2265         wfSuppressWarnings();
2266
2267         $archive = $dir.'/'.$subdir;
2268         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
2269         $archive .= '/' . $hash{0};
2270         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
2271         $archive .= '/' . substr( $hash, 0, 2 );
2272         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
2273
2274         wfRestoreWarnings();
2275         umask( $oldumask );
2276         return $archive;
2277 }
2278
2279
2280 /*
2281  * Return the hash path component of an image path (URL or filesystem),
2282  * e.g. "/3/3c/", or just "/" if hashing is not used.
2283  *
2284  * @param $dbkey The filesystem / database name of the file
2285  * @param $fromSharedDirectory Use the shared file repository? It may
2286  *   use different hash settings from the local one.
2287  */
2288 function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {
2289         if( Image::isHashed( $fromSharedDirectory ) ) {
2290                 $hash = md5($dbkey);
2291                 return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
2292         } else {
2293                 return '/';
2294         }
2295 }
2296
2297 /**
2298  * Returns the image URL of an image's old version
2299  *
2300  * @param $name String: file name of the image file
2301  * @param $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
2302  * @public
2303  */
2304 function wfImageArchiveUrl( $name, $subdir='archive' ) {
2305         global $wgUploadPath, $wgHashedUploadDirectory;
2306
2307         if ($wgHashedUploadDirectory) {
2308                 $hash = md5( substr( $name, 15) );
2309                 $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
2310                   substr( $hash, 0, 2 ) . '/'.$name;
2311         } else {
2312                 $url = $wgUploadPath.'/'.$subdir.'/'.$name;
2313         }
2314         return wfUrlencode($url);
2315 }
2316
2317 /**
2318  * Return a rounded pixel equivalent for a labeled CSS/SVG length.
2319  * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
2320  *
2321  * @param $length String: CSS/SVG length.
2322  * @return Integer: length in pixels
2323  */
2324 function wfScaleSVGUnit( $length ) {
2325         static $unitLength = array(
2326                 'px' => 1.0,
2327                 'pt' => 1.25,
2328                 'pc' => 15.0,
2329                 'mm' => 3.543307,
2330                 'cm' => 35.43307,
2331                 'in' => 90.0,
2332                 ''   => 1.0, // "User units" pixels by default
2333                 '%'  => 2.0, // Fake it!
2334                 );
2335         if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
2336                 $length = floatval( $matches[1] );
2337                 $unit = $matches[2];
2338                 return round( $length * $unitLength[$unit] );
2339         } else {
2340                 // Assume pixels
2341                 return round( floatval( $length ) );
2342         }
2343 }
2344
2345 /**
2346  * Compatible with PHP getimagesize()
2347  * @todo support gzipped SVGZ
2348  * @todo check XML more carefully
2349  * @todo sensible defaults
2350  *
2351  * @param $filename String: full name of the file (passed to php fopen()).
2352  * @return array
2353  */
2354 function wfGetSVGsize( $filename ) {
2355         $width = 256;
2356         $height = 256;
2357
2358         // Read a chunk of the file
2359         $f = fopen( $filename, "rt" );
2360         if( !$f ) return false;
2361         $chunk = fread( $f, 4096 );
2362         fclose( $f );
2363
2364         // Uber-crappy hack! Run through a real XML parser.
2365         if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
2366                 return false;
2367         }
2368         $tag = $matches[1];
2369         if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
2370                 $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
2371         }
2372         if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
2373                 $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
2374         }
2375
2376         return array( $width, $height, 'SVG',
2377                 "width=\"$width\" height=\"$height\"" );
2378 }
2379
2380 /**
2381  * Determine if an image exists on the 'bad image list'.
2382  *
2383  * @param $name String: the image name to check
2384  * @return bool
2385  */
2386 function wfIsBadImage( $name ) {
2387         static $titleList = false;
2388
2389         if( !$titleList ) {
2390                 # Build the list now
2391                 $titleList = array();
2392                 $lines = explode( "\n", wfMsgForContent( 'bad_image_list' ) );
2393                 foreach( $lines as $line ) {
2394                         if( preg_match( '/^\*\s*\[\[:?(.*?)\]\]/i', $line, $matches ) ) {
2395                                 $title = Title::newFromText( $matches[1] );
2396                                 if( is_object( $title ) && $title->getNamespace() == NS_IMAGE )
2397                                         $titleList[ $title->getDBkey() ] = true;
2398                         }
2399                 }
2400         }
2401         return array_key_exists( $name, $titleList );
2402 }
2403
2404
2405
2406 /**
2407  * Wrapper class for thumbnail images
2408  * @package MediaWiki
2409  */
2410 class ThumbnailImage {
2411         /**
2412          * @param string $path Filesystem path to the thumb
2413          * @param string $url URL path to the thumb
2414          * @private
2415          */
2416         function ThumbnailImage( $url, $width, $height, $path = false ) {
2417                 $this->url = $url;
2418                 $this->width = round( $width );
2419                 $this->height = round( $height );
2420                         # These should be integers when they get here.
2421                         # If not, there's a bug somewhere.  But let's at
2422                         # least produce valid HTML code regardless.
2423                 $this->path = $path;
2424         }
2425
2426         /**
2427          * @return string The thumbnail URL
2428          */
2429         function getUrl() {
2430                 return $this->url;
2431         }
2432
2433         /**
2434          * Return HTML <img ... /> tag for the thumbnail, will include
2435          * width and height attributes and a blank alt text (as required).
2436          *
2437          * You can set or override additional attributes by passing an
2438          * associative array of name => data pairs. The data will be escaped
2439          * for HTML output, so should be in plaintext.
2440          *
2441          * @param array $attribs
2442          * @return string
2443          * @public
2444          */
2445         function toHtml( $attribs = array() ) {
2446                 $attribs['src'] = $this->url;
2447                 $attribs['width'] = $this->width;
2448                 $attribs['height'] = $this->height;
2449                 if( !isset( $attribs['alt'] ) ) $attribs['alt'] = '';
2450
2451                 $html = '<img ';
2452                 foreach( $attribs as $name => $data ) {
2453                         $html .= $name . '="' . htmlspecialchars( $data ) . '" ';
2454                 }
2455                 $html .= '/>';
2456                 return $html;
2457         }
2458
2459 }
2460
2461 /**
2462  * Calculate the largest thumbnail width for a given original file size
2463  * such that the thumbnail's height is at most $maxHeight.
2464  * @param $boxWidth Integer Width of the thumbnail box.
2465  * @param $boxHeight Integer Height of the thumbnail box.
2466  * @param $maxHeight Integer Maximum height expected for the thumbnail.
2467  * @return Integer.
2468  */
2469 function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
2470         $idealWidth = $boxWidth * $maxHeight / $boxHeight;
2471         $roundedUp = ceil( $idealWidth );
2472         if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )
2473                 return floor( $idealWidth );
2474         else
2475                 return $roundedUp;
2476 }
2477
2478 ?>