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 if ($wgShowEXIF)
  16         require_once('Exif.php');
  17
  18 /**
  19  * Bump this number when serialized cache records may be incompatible.
  20  */
  21 define( 'MW_IMAGE_VERSION', 1 );
  22
  23 /**
  24  * Class to represent an image
  25  *
  26  * Provides methods to retrieve paths (physical, logical, URL),
  27  * to generate thumbnails or for uploading.
  28  * @package MediaWiki
  29  */
  30 class Image
  31 {
  32         /**#@+
  33          * @access private
  34          */
  35         var     $name,          # name of the image (constructor)
  36                 $imagePath,     # Path of the image (loadFromXxx)
  37                 $url,           # Image URL (accessor)
  38                 $title,         # Title object for this image (constructor)
  39                 $fileExists,    # does the image file exist on disk? (loadFromXxx)
  40                 $fromSharedDirectory, # load this image from $wgSharedUploadDirectory (loadFromXxx)
  41                 $historyLine,   # Number of line to return by nextHistoryLine() (constructor)
  42                 $historyRes,    # result of the query for the image's history (nextHistoryLine)
  43                 $width,         # \
  44                 $height,        #  |
  45                 $bits,          #   --- returned by getimagesize (loadFromXxx)
  46                 $attr,          # /
  47                 $type,          # MEDIATYPE_xxx (bitmap, drawing, audio...)
  48                 $mime,          # MIME type, determined by MimeMagic::guessMimeType
  49                 $size,          # Size in bytes (loadFromXxx)
  50                 $metadata,      # Metadata
  51                 $dataLoaded;    # Whether or not all this has been loaded from the database (loadFromXxx)
  52
  53
  54         /**#@-*/
  55
  56         /**
  57          * Create an Image object from an image name
  58          *
  59          * @param string $name name of the image, used to create a title object using Title::makeTitleSafe
  60          * @access public
  61          */
  62         function newFromName( $name ) {
  63                 $title = Title::makeTitleSafe( NS_IMAGE, $name );
  64                 if ( is_object( $title ) ) {
  65                         return new Image( $title );
  66                 } else {
  67                         return NULL;
  68                 }
  69         }
  70
  71         /**
  72          * Obsolete factory function, use constructor
  73          */
  74         function newFromTitle( $title ) {
  75                 return new Image( $title );
  76         }
  77
  78         function Image( $title ) {
  79                 if( !is_object( $title ) ) {
  80                         wfDebugDieBacktrace( 'Image constructor given bogus title.' );
  81                 }
  82                 $this->title =& $title;
  83                 $this->name = $title->getDBkey();
  84                 $this->metadata = serialize ( array() ) ;
  85
  86                 $n = strrpos( $this->name, '.' );
  87                 $this->extension = strtolower( $n ? substr( $this->name, $n + 1 ) : '' );
  88                 $this->historyLine = 0;
  89
  90                 $this->dataLoaded = false;
  91         }
  92
  93         /**
  94          * Get the memcached keys
  95          * Returns an array, first element is the local cache key, second is the shared cache key, if there is one
  96          */
  97         function getCacheKeys( $shared = false ) {
  98                 global $wgDBname, $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
  99
 100                 $foundCached = false;
 101                 $hashedName = md5($this->name);
 102                 $keys = array( "$wgDBname:Image:$hashedName" );
 103                 if ( $wgUseSharedUploads && $wgSharedUploadDBname && $wgCacheSharedUploads ) {
 104                         $keys[] = "$wgSharedUploadDBname:Image:$hashedName";
 105                 }
 106                 return $keys;
 107         }
 108
 109         /**
 110          * Try to load image metadata from memcached. Returns true on success.
 111          */
 112         function loadFromCache() {
 113                 global $wgUseSharedUploads, $wgMemc;
 114                 $fname = 'Image::loadFromMemcached';
 115                 wfProfileIn( $fname );
 116                 $this->dataLoaded = false;
 117                 $keys = $this->getCacheKeys();
 118                 $cachedValues = $wgMemc->get( $keys[0] );
 119
 120                 // Check if the key existed and belongs to this version of MediaWiki
 121                 if (!empty($cachedValues) && is_array($cachedValues)
 122                   && isset($cachedValues['version']) && ( $cachedValues['version'] == MW_IMAGE_VERSION )
 123                   && $cachedValues['fileExists'] && isset( $cachedValues['mime'] ) && isset( $cachedValues['metadata'] ) )
 124                 {
 125                         if ( $wgUseSharedUploads && $cachedValues['fromShared']) {
 126                                 # if this is shared file, we need to check if image
 127                                 # in shared repository has not changed
 128                                 if ( isset( $keys[1] ) ) {
 129                                         $commonsCachedValues = $wgMemc->get( $keys[1] );
 130                                         if (!empty($commonsCachedValues) && is_array($commonsCachedValues)
 131                                           && isset($commonsCachedValues['version'])
 132                                           && ( $commonsCachedValues['version'] == MW_IMAGE_VERSION )
 133                                           && isset($commonsCachedValues['mime'])) {
 134                                                 wfDebug( "Pulling image metadata from shared repository cache\n" );
 135                                                 $this->name = $commonsCachedValues['name'];
 136                                                 $this->imagePath = $commonsCachedValues['imagePath'];
 137                                                 $this->fileExists = $commonsCachedValues['fileExists'];
 138                                                 $this->width = $commonsCachedValues['width'];
 139                                                 $this->height = $commonsCachedValues['height'];
 140                                                 $this->bits = $commonsCachedValues['bits'];
 141                                                 $this->type = $commonsCachedValues['type'];
 142                                                 $this->mime = $commonsCachedValues['mime'];
 143                                                 $this->metadata = $commonsCachedValues['metadata'];
 144                                                 $this->size = $commonsCachedValues['size'];
 145                                                 $this->fromSharedDirectory = true;
 146                                                 $this->dataLoaded = true;
 147                                                 $this->imagePath = $this->getFullPath(true);
 148                                         }
 149                                 }
 150                         } else {
 151                                 wfDebug( "Pulling image metadata from local cache\n" );
 152                                 $this->name = $cachedValues['name'];
 153                                 $this->imagePath = $cachedValues['imagePath'];
 154                                 $this->fileExists = $cachedValues['fileExists'];
 155                                 $this->width = $cachedValues['width'];
 156                                 $this->height = $cachedValues['height'];
 157                                 $this->bits = $cachedValues['bits'];
 158                                 $this->type = $cachedValues['type'];
 159                                 $this->mime = $cachedValues['mime'];
 160                                 $this->metadata = $cachedValues['metadata'];
 161                                 $this->size = $cachedValues['size'];
 162                                 $this->fromSharedDirectory = false;
 163                                 $this->dataLoaded = true;
 164                                 $this->imagePath = $this->getFullPath();
 165                         }
 166                 }
 167                 if ( $this->dataLoaded ) {
 168                         wfIncrStats( 'image_cache_hit' );
 169                 } else {
 170                         wfIncrStats( 'image_cache_miss' );
 171                 }
 172
 173                 wfProfileOut( $fname );
 174                 return $this->dataLoaded;
 175         }
 176
 177         /**
 178          * Save the image metadata to memcached
 179          */
 180         function saveToCache() {
 181                 global $wgMemc;
 182                 $this->load();
 183                 $keys = $this->getCacheKeys();
 184                 if ( $this->fileExists ) {
 185                         // We can't cache negative metadata for non-existent files,
 186                         // because if the file later appears in commons, the local
 187                         // keys won't be purged.
 188                         $cachedValues = array(
 189                                 'version'    => MW_IMAGE_VERSION,
 190                                 'name'       => $this->name,
 191                                 'imagePath'  => $this->imagePath,
 192                                 'fileExists' => $this->fileExists,
 193                                 'fromShared' => $this->fromSharedDirectory,
 194                                 'width'      => $this->width,
 195                                 'height'     => $this->height,
 196                                 'bits'       => $this->bits,
 197                                 'type'       => $this->type,
 198                                 'mime'       => $this->mime,
 199                                 'metadata'   => $this->metadata,
 200                                 'size'       => $this->size );
 201
 202                         $wgMemc->set( $keys[0], $cachedValues, 60 * 60 * 24 * 7 ); // A week
 203                 } else {
 204                         // However we should clear them, so they aren't leftover
 205                         // if we've deleted the file.
 206                         $wgMemc->delete( $keys[0] );
 207                 }
 208         }
 209
 210         /**
 211          * Load metadata from the file itself
 212          */
 213         function loadFromFile() {
 214                 global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgContLang,
 215                        $wgShowEXIF;
 216                 $fname = 'Image::loadFromFile';
 217                 wfProfileIn( $fname );
 218                 $this->imagePath = $this->getFullPath();
 219                 $this->fileExists = file_exists( $this->imagePath );
 220                 $this->fromSharedDirectory = false;
 221                 $gis = array();
 222
 223                 if (!$this->fileExists) wfDebug("$fname: ".$this->imagePath." not found locally!\n");
 224
 225                 # If the file is not found, and a shared upload directory is used, look for it there.
 226                 if (!$this->fileExists && $wgUseSharedUploads && $wgSharedUploadDirectory) {
 227                         # In case we're on a wgCapitalLinks=false wiki, we
 228                         # capitalize the first letter of the filename before
 229                         # looking it up in the shared repository.
 230                         $sharedImage = Image::newFromName( $wgContLang->ucfirst($this->name) );
 231                         $this->fileExists = $sharedImage && file_exists( $sharedImage->getFullPath(true) );
 232                         if ( $this->fileExists ) {
 233                                 $this->name = $sharedImage->name;
 234                                 $this->imagePath = $this->getFullPath(true);
 235                                 $this->fromSharedDirectory = true;
 236                         }
 237                 }
 238
 239
 240                 if ( $this->fileExists ) {
 241                         $magic=& wfGetMimeMagic();
 242
 243                         $this->mime = $magic->guessMimeType($this->imagePath,true);
 244                         $this->type = $magic->getMediaType($this->imagePath,$this->mime);
 245
 246                         # Get size in bytes
 247                         $this->size = filesize( $this->imagePath );
 248
 249                         $magic=& wfGetMimeMagic();
 250
 251                         # Height and width
 252                         if( $this->mime == 'image/svg' ) {
 253                                 wfSuppressWarnings();
 254                                 $gis = wfGetSVGsize( $this->imagePath );
 255                                 wfRestoreWarnings();
 256                         }
 257                         elseif ( !$magic->isPHPImageType( $this->mime ) ) {
 258                                 # Don't try to get the width and height of sound and video files, that's bad for performance
 259                                 $gis[0]= 0; //width
 260                                 $gis[1]= 0; //height
 261                                 $gis[2]= 0; //unknown
 262                                 $gis[3]= ""; //width height string
 263                         }
 264                         else {
 265                                 wfSuppressWarnings();
 266                                 $gis = getimagesize( $this->imagePath );
 267                                 wfRestoreWarnings();
 268                         }
 269
 270                         wfDebug("$fname: ".$this->imagePath." loaded, ".$this->size." bytes, ".$this->mime.".\n");
 271                 }
 272                 else {
 273                         $gis[0]= 0; //width
 274                         $gis[1]= 0; //height
 275                         $gis[2]= 0; //unknown
 276                         $gis[3]= ""; //width height string
 277
 278                         $this->mime = NULL;
 279                         $this->type = MEDIATYPE_UNKNOWN;
 280                         wfDebug("$fname: ".$this->imagePath." NOT FOUND!\n");
 281                 }
 282
 283                 $this->width = $gis[0];
 284                 $this->height = $gis[1];
 285
 286                 #NOTE: $gis[2] contains a code for the image type. This is no longer used.
 287
 288                 #NOTE: we have to set this flag early to avoid load() to be called
 289                 # be some of the functions below. This may lead to recursion or other bad things!
 290                 # as ther's only one thread of execution, this should be safe anyway.
 291                 $this->dataLoaded = true;
 292
 293
 294                 if ($this->fileExists && $wgShowEXIF) $this->metadata = serialize ( $this->retrieveExifData() ) ;
 295                 else $this->metadata = serialize ( array() ) ;
 296
 297                 if ( isset( $gis['bits'] ) )  $this->bits = $gis['bits'];
 298                 else $this->bits = 0;
 299
 300                 wfProfileOut( $fname );
 301         }
 302
 303         /**
 304          * Load image metadata from the DB
 305          */
 306         function loadFromDB() {
 307                 global $wgUseSharedUploads, $wgSharedUploadDBname, $wgSharedUploadDBprefix, $wgContLang;
 308                 $fname = 'Image::loadFromDB';
 309                 wfProfileIn( $fname );
 310
 311                 $dbr =& wfGetDB( DB_SLAVE );
 312
 313                 $this->checkDBSchema($dbr);
 314
 315                 $row = $dbr->selectRow( 'image',
 316                         array( 'img_size', 'img_width', 'img_height', 'img_bits',
 317                                'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
 318                         array( 'img_name' => $this->name ), $fname );
 319                 if ( $row ) {
 320                         $this->fromSharedDirectory = false;
 321                         $this->fileExists = true;
 322                         $this->loadFromRow( $row );
 323                         $this->imagePath = $this->getFullPath();
 324                         // Check for rows from a previous schema, quietly upgrade them
 325                         if ( is_null($this->type) ) {
 326                                 $this->upgradeRow();
 327                         }
 328                 } elseif ( $wgUseSharedUploads && $wgSharedUploadDBname ) {
 329                         # In case we're on a wgCapitalLinks=false wiki, we
 330                         # capitalize the first letter of the filename before
 331                         # looking it up in the shared repository.
 332                         $name = $wgContLang->ucfirst($this->name);
 333
 334                         $row = $dbr->selectRow( "`$wgSharedUploadDBname`.{$wgSharedUploadDBprefix}image",
 335                                 array(
 336                                         'img_size', 'img_width', 'img_height', 'img_bits',
 337                                         'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
 338                                 array( 'img_name' => $name ), $fname );
 339                         if ( $row ) {
 340                                 $this->fromSharedDirectory = true;
 341                                 $this->fileExists = true;
 342                                 $this->imagePath = $this->getFullPath(true);
 343                                 $this->name = $name;
 344                                 $this->loadFromRow( $row );
 345
 346                                 // Check for rows from a previous schema, quietly upgrade them
 347                                 if ( is_null($this->type) ) {
 348                                         $this->upgradeRow();
 349                                 }
 350                         }
 351                 }
 352
 353                 if ( !$row ) {
 354                         $this->size = 0;
 355                         $this->width = 0;
 356                         $this->height = 0;
 357                         $this->bits = 0;
 358                         $this->type = 0;
 359                         $this->fileExists = false;
 360                         $this->fromSharedDirectory = false;
 361                         $this->metadata = serialize ( array() ) ;
 362                 }
 363
 364                 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
 365                 $this->dataLoaded = true;
 366                 wfProfileOut( $fname );
 367         }
 368
 369         /*
 370          * Load image metadata from a DB result row
 371          */
 372         function loadFromRow( &$row ) {
 373                 $this->size = $row->img_size;
 374                 $this->width = $row->img_width;
 375                 $this->height = $row->img_height;
 376                 $this->bits = $row->img_bits;
 377                 $this->type = $row->img_media_type;
 378
 379                 $major= $row->img_major_mime;
 380                 $minor= $row->img_minor_mime;
 381
 382                 if (!$major) $this->mime = "unknown/unknown";
 383                 else {
 384                         if (!$minor) $minor= "unknown";
 385                         $this->mime = $major.'/'.$minor;
 386                 }
 387
 388                 $this->metadata = $row->img_metadata;
 389                 if ( $this->metadata == "" ) $this->metadata = serialize ( array() ) ;
 390
 391                 $this->dataLoaded = true;
 392         }
 393
 394         /**
 395          * Load image metadata from cache or DB, unless already loaded
 396          */
 397         function load() {
 398                 global $wgSharedUploadDBname, $wgUseSharedUploads;
 399                 if ( !$this->dataLoaded ) {
 400                         if ( !$this->loadFromCache() ) {
 401                                 $this->loadFromDB();
 402                                 if ( !$wgSharedUploadDBname && $wgUseSharedUploads ) {
 403                                         $this->loadFromFile();
 404                                 } elseif ( $this->fileExists ) {
 405                                         $this->saveToCache();
 406                                 }
 407                         }
 408                         $this->dataLoaded = true;
 409                 }
 410         }
 411
 412         /**
 413          * Metadata was loaded from the database, but the row had a marker indicating it needs to be
 414          * upgraded from the 1.4 schema, which had no width, height, bits or type. Upgrade the row.
 415          */
 416         function upgradeRow() {
 417                 global $wgDBname, $wgSharedUploadDBname;
 418                 $fname = 'Image::upgradeRow';
 419                 wfProfileIn( $fname );
 420
 421                 $this->loadFromFile();
 422                 $dbw =& wfGetDB( DB_MASTER );
 423
 424                 if ( $this->fromSharedDirectory ) {
 425                         if ( !$wgSharedUploadDBname ) {
 426                                 wfProfileOut( $fname );
 427                                 return;
 428                         }
 429
 430                         // Write to the other DB using selectDB, not database selectors
 431                         // This avoids breaking replication in MySQL
 432                         $dbw->selectDB( $wgSharedUploadDBname );
 433                 }
 434
 435                 $this->checkDBSchema($dbw);
 436
 437                 if (strpos($this->mime,'/')!==false) {
 438                         list($major,$minor)= explode('/',$this->mime,2);
 439                 }
 440                 else {
 441                         $major= $this->mime;
 442                         $minor= "unknown";
 443                 }
 444
 445                 wfDebug("$fname: upgrading ".$this->name." to 1.5 schema\n");
 446
 447                 $dbw->update( 'image',
 448                         array(
 449                                 'img_width' => $this->width,
 450                                 'img_height' => $this->height,
 451                                 'img_bits' => $this->bits,
 452                                 'img_media_type' => $this->type,
 453                                 'img_major_mime' => $major,
 454                                 'img_minor_mime' => $minor,
 455                                 'img_metadata' => $this->metadata,
 456                         ), array( 'img_name' => $this->name ), $fname
 457                 );
 458                 if ( $this->fromSharedDirectory ) {
 459                         $dbw->selectDB( $wgDBname );
 460                 }
 461                 wfProfileOut( $fname );
 462         }
 463
 464         /**
 465          * Return the name of this image
 466          * @access public
 467          */
 468         function getName() {
 469                 return $this->name;
 470         }
 471
 472         /**
 473          * Return the associated title object
 474          * @access public
 475          */
 476         function getTitle() {
 477                 return $this->title;
 478         }
 479
 480         /**
 481          * Return the URL of the image file
 482          * @access public
 483          */
 484         function getURL() {
 485                 if ( !$this->url ) {
 486                         $this->load();
 487                         if($this->fileExists) {
 488                                 $this->url = Image::imageUrl( $this->name, $this->fromSharedDirectory );
 489                         } else {
 490                                 $this->url = '';
 491                         }
 492                 }
 493                 return $this->url;
 494         }
 495
 496         function getViewURL() {
 497                 if( $this->mustRender()) {
 498                         if( $this->canRender() ) {
 499                                 return $this->createThumb( $this->getWidth() );
 500                         }
 501                         else {
 502                                 wfDebug('Image::getViewURL(): supposed to render '.$this->name.' ('.$this->mime."), but can't!\n");
 503                                 return $this->getURL(); #hm... return NULL?
 504                         }
 505                 } else {
 506                         return $this->getURL();
 507                 }
 508         }
 509
 510         /**
 511          * Return the image path of the image in the
 512          * local file system as an absolute path
 513          * @access public
 514          */
 515         function getImagePath() {
 516                 $this->load();
 517                 return $this->imagePath;
 518         }
 519
 520         /**
 521          * Return the width of the image
 522          *
 523          * Returns -1 if the file specified is not a known image type
 524          * @access public
 525          */
 526         function getWidth() {
 527                 $this->load();
 528                 return $this->width;
 529         }
 530
 531         /**
 532          * Return the height of the image
 533          *
 534          * Returns -1 if the file specified is not a known image type
 535          * @access public
 536          */
 537         function getHeight() {
 538                 $this->load();
 539                 return $this->height;
 540         }
 541
 542         /**
 543          * Return the size of the image file, in bytes
 544          * @access public
 545          */
 546         function getSize() {
 547                 $this->load();
 548                 return $this->size;
 549         }
 550
 551         /**
 552          * Returns the mime type of the file.
 553          */
 554         function getMimeType() {
 555                 $this->load();
 556                 return $this->mime;
 557         }
 558
 559         /**
 560          * Return the type of the media in the file.
 561          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 562          */
 563         function getMediaType() {
 564                 $this->load();
 565                 return $this->type;
 566         }
 567
 568         /**
 569          * Checks if the file can be presented to the browser as a bitmap.
 570          *
 571          * Currently, this checks if the file is an image format
 572          * that can be converted to a format
 573          * supported by all browsers (namely GIF, PNG and JPEG),
 574          * or if it is an SVG image and SVG conversion is enabled.
 575          *
 576          * @todo remember the result of this check.
 577          */
 578         function canRender() {
 579                 global $wgUseImageMagick;
 580
 581                 if( $this->getWidth()<=0 || $this->getHeight()<=0 ) return false;
 582
 583                 $mime= $this->getMimeType();
 584
 585                 if (!$mime || $mime==='unknown' || $mime==='unknown/unknown') return false;
 586
 587                 #if it's SVG, check if there's a converter enabled
 588                 if ($mime === 'image/svg') {
 589                         global $wgSVGConverters, $wgSVGConverter;
 590
 591                         if ($wgSVGConverter && isset( $wgSVGConverters[$wgSVGConverter])) {
 592                                 wfDebug( "Image::canRender: SVG is ready!\n" );
 593                                 return true;
 594                         } else {
 595                                 wfDebug( "Image::canRender: SVG renderer missing\n" );
 596                         }
 597                 }
 598
 599                 #image formats available on ALL browsers
 600                 if (  $mime === 'image/gif'
 601                    || $mime === 'image/png'
 602                    || $mime === 'image/jpeg' ) return true;
 603
 604                 #image formats that can be converted to the above formats
 605                 if ($wgUseImageMagick) {
 606                         #convertable by ImageMagick (there are more...)
 607                         if ( $mime === 'image/vnd.wap.wbmp'
 608                           || $mime === 'image/x-xbitmap'
 609                           || $mime === 'image/x-xpixmap'
 610                           #|| $mime === 'image/x-icon'   #file may be split into multiple parts
 611                           || $mime === 'image/x-portable-anymap'
 612                           || $mime === 'image/x-portable-bitmap'
 613                           || $mime === 'image/x-portable-graymap'
 614                           || $mime === 'image/x-portable-pixmap'
 615                           #|| $mime === 'image/x-photoshop'  #this takes a lot of CPU and RAM!
 616                           || $mime === 'image/x-rgb'
 617                           || $mime === 'image/x-bmp'
 618                           || $mime === 'image/tiff' ) return true;
 619                 }
 620                 else {
 621                         #convertable by the PHP GD image lib
 622                         if ( $mime === 'image/vnd.wap.wbmp'
 623                           || $mime === 'image/x-xbitmap' ) return true;
 624                 }
 625
 626                 return false;
 627         }
 628
 629
 630         /**
 631          * Return true if the file is of a type that can't be directly
 632          * rendered by typical browsers and needs to be re-rasterized.
 633          *
 634          * This returns true for everything but the bitmap types
 635          * supported by all browsers, i.e. JPEG; GIF and PNG. It will
 636          * also return true for any non-image formats.
 637          *
 638          * @return bool
 639          */
 640         function mustRender() {
 641                 $mime= $this->getMimeType();
 642
 643                 if (  $mime === "image/gif"
 644                    || $mime === "image/png"
 645                    || $mime === "image/jpeg" ) return false;
 646
 647                 return true;
 648         }
 649
 650         /**
 651          * Determines if this media file may be shown inline on a page.
 652          *
 653          * This is currently synonymous to canRender(), but this could be
 654          * extended to also allow inline display of other media,
 655          * like flash animations or videos. If you do so, please keep in mind that
 656          * that could be a security risk.
 657          */
 658         function allowInlineDisplay() {
 659                 return $this->canRender();
 660         }
 661
 662         /**
 663          * Determines if this media file is in a format that is unlikely to
 664          * contain viruses or malicious content. It uses the global
 665          * $wgTrustedMediaFormats list to determine if the file is safe.
 666          *
 667          * This is used to show a warning on the description page of non-safe files.
 668          * It may also be used to disallow direct [[media:...]] links to such files.
 669          *
 670          * Note that this function will always return true if allowInlineDisplay()
 671          * or isTrustedFile() is true for this file.
 672          */
 673         function isSafeFile() {
 674                 if ($this->allowInlineDisplay()) return true;
 675                 if ($this->isTrustedFile()) return true;
 676
 677                 global $wgTrustedMediaFormats;
 678
 679                 $type= $this->getMediaType();
 680                 $mime= $this->getMimeType();
 681                 #wfDebug("Image::isSafeFile: type= $type, mime= $mime\n");
 682
 683                 if (!$type || $type===MEDIATYPE_UNKNOWN) return false; #unknown type, not trusted
 684                 if ( in_array( $type, $wgTrustedMediaFormats) ) return true;
 685
 686                 if ($mime==="unknown/unknown") return false; #unknown type, not trusted
 687                 if ( in_array( $mime, $wgTrustedMediaFormats) ) return true;
 688
 689                 return false;
 690         }
 691
 692         /** Returns true if the file is flagged as trusted. Files flagged that way
 693         * can be linked to directly, even if that is not allowed for this type of
 694         * file normally.
 695         *
 696         * This is a dummy function right now and always returns false. It could be
 697         * implemented to extract a flag from the database. The trusted flag could be
 698         * set on upload, if the user has sufficient privileges, to bypass script-
 699         * and html-filters. It may even be coupled with cryptographics signatures
 700         * or such.
 701         */
 702         function isTrustedFile() {
 703                 #this could be implemented to check a flag in the databas,
 704                 #look for signatures, etc
 705                 return false;
 706         }
 707
 708         /**
 709          * Return the escapeLocalURL of this image
 710          * @access public
 711          */
 712         function getEscapeLocalURL() {
 713                 $this->getTitle();
 714                 return $this->title->escapeLocalURL();
 715         }
 716
 717         /**
 718          * Return the escapeFullURL of this image
 719          * @access public
 720          */
 721         function getEscapeFullURL() {
 722                 $this->getTitle();
 723                 return $this->title->escapeFullURL();
 724         }
 725
 726         /**
 727          * Return the URL of an image, provided its name.
 728          *
 729          * @param string $name  Name of the image, without the leading "Image:"
 730          * @param boolean $fromSharedDirectory  Should this be in $wgSharedUploadPath?
 731          * @return string URL of $name image
 732          * @access public
 733          * @static
 734          */
 735         function imageUrl( $name, $fromSharedDirectory = false ) {
 736                 global $wgUploadPath,$wgUploadBaseUrl,$wgSharedUploadPath;
 737                 if($fromSharedDirectory) {
 738                         $base = '';
 739                         $path = $wgSharedUploadPath;
 740                 } else {
 741                         $base = $wgUploadBaseUrl;
 742                         $path = $wgUploadPath;
 743                 }
 744                 $url = "{$base}{$path}" .  wfGetHashPath($name, $fromSharedDirectory) . "{$name}";
 745                 return wfUrlencode( $url );
 746         }
 747
 748         /**
 749          * Returns true if the image file exists on disk.
 750          * @return boolean Whether image file exist on disk.
 751          * @access public
 752          */
 753         function exists() {
 754                 $this->load();
 755                 return $this->fileExists;
 756         }
 757
 758         /**
 759          * @todo document
 760          * @access private
 761          */
 762         function thumbUrl( $width, $subdir='thumb') {
 763                 global $wgUploadPath, $wgUploadBaseUrl, $wgSharedUploadPath;
 764                 global $wgSharedThumbnailScriptPath, $wgThumbnailScriptPath;
 765
 766                 // Generate thumb.php URL if possible
 767                 $script = false;
 768                 $url = false;
 769
 770                 if ( $this->fromSharedDirectory ) {
 771                         if ( $wgSharedThumbnailScriptPath ) {
 772                                 $script = $wgSharedThumbnailScriptPath;
 773                         }
 774                 } else {
 775                         if ( $wgThumbnailScriptPath ) {
 776                                 $script = $wgThumbnailScriptPath;
 777                         }
 778                 }
 779                 if ( $script ) {
 780                         $url = $script . '?f=' . urlencode( $this->name ) . '&w=' . urlencode( $width );
 781                         if( $this->mustRender() ) {
 782                                 $url.= '&r=1';
 783                         }
 784                 } else {
 785                         $name = $this->thumbName( $width );
 786                         if($this->fromSharedDirectory) {
 787                                 $base = '';
 788                                 $path = $wgSharedUploadPath;
 789                         } else {
 790                                 $base = $wgUploadBaseUrl;
 791                                 $path = $wgUploadPath;
 792                         }
 793                         if ( Image::isHashed( $this->fromSharedDirectory ) ) {
 794                                 $url = "{$base}{$path}/{$subdir}" .
 795                                 wfGetHashPath($this->name, $this->fromSharedDirectory)
 796                                 . $this->name.'/'.$name;
 797                                 $url = wfUrlencode( $url );
 798                         } else {
 799                                 $url = "{$base}{$path}/{$subdir}/{$name}";
 800                         }
 801                 }
 802                 return array( $script !== false, $url );
 803         }
 804
 805         /**
 806          * Return the file name of a thumbnail of the specified width
 807          *
 808          * @param integer $width        Width of the thumbnail image
 809          * @param boolean $shared       Does the thumbnail come from the shared repository?
 810          * @access private
 811          */
 812         function thumbName( $width ) {
 813                 $thumb = $width."px-".$this->name;
 814
 815                 if( $this->mustRender() ) {
 816                         if( $this->canRender() ) {
 817                                 # Rasterize to PNG (for SVG vector images, etc)
 818                                 $thumb .= '.png';
 819                         }
 820                         else {
 821                                 #should we use iconThumb here to get a symbolic thumbnail?
 822                                 #or should we fail with an internal error?
 823                                 return NULL; //can't make bitmap
 824                         }
 825                 }
 826                 return $thumb;
 827         }
 828
 829         /**
 830          * Create a thumbnail of the image having the specified width/height.
 831          * The thumbnail will not be created if the width is larger than the
 832          * image's width. Let the browser do the scaling in this case.
 833          * The thumbnail is stored on disk and is only computed if the thumbnail
 834          * file does not exist OR if it is older than the image.
 835          * Returns the URL.
 836          *
 837          * Keeps aspect ratio of original image. If both width and height are
 838          * specified, the generated image will be no bigger than width x height,
 839          * and will also have correct aspect ratio.
 840          *
 841          * @param integer $width        maximum width of the generated thumbnail
 842          * @param integer $height       maximum height of the image (optional)
 843          * @access public
 844          */
 845         function createThumb( $width, $height=-1 ) {
 846                 $thumb = $this->getThumbnail( $width, $height );
 847                 if( is_null( $thumb ) ) return '';
 848                 return $thumb->getUrl();
 849         }
 850
 851         /**
 852          * As createThumb, but returns a ThumbnailImage object. This can
 853          * provide access to the actual file, the real size of the thumb,
 854          * and can produce a convenient <img> tag for you.
 855          *
 856          * @param integer $width        maximum width of the generated thumbnail
 857          * @param integer $height       maximum height of the image (optional)
 858          * @return ThumbnailImage
 859          * @access public
 860          */
 861         function getThumbnail( $width, $height=-1 ) {
 862                 if ( $height <= 0 ) {
 863                         return $this->renderThumb( $width );
 864                 }
 865                 $this->load();
 866
 867                 if ($this->canRender()) {
 868                         if ( $width > $this->width * $height / $this->height )
 869                                 $width = floor( $this->width * $height / $this->height );
 870                                 # Note this is the largest width such that the thumbnail's
 871                                 # height is at most $height.
 872
 873                         $thumb = $this->renderThumb( $width );
 874                 }
 875                 else $thumb= NULL; #not a bitmap or renderable image, don't try.
 876
 877                 if( is_null( $thumb ) ) {
 878                         $thumb = $this->iconThumb();
 879                 }
 880                 return $thumb;
 881         }
 882
 883         /**
 884          * @return ThumbnailImage
 885          */
 886         function iconThumb() {
 887                 global $wgStylePath, $wgStyleDirectory;
 888
 889                 $try = array( 'fileicon-' . $this->extension . '.png', 'fileicon.png' );
 890                 foreach( $try as $icon ) {
 891                         $path = '/common/images/icons/' . $icon;
 892                         $filepath = $wgStyleDirectory . $path;
 893                         if( file_exists( $filepath ) ) {
 894                                 return new ThumbnailImage( $wgStylePath . $path, 120, 120 );
 895                         }
 896                 }
 897                 return null;
 898         }
 899
 900         /**
 901          * Create a thumbnail of the image having the specified width.
 902          * The thumbnail will not be created if the width is larger than the
 903          * image's width. Let the browser do the scaling in this case.
 904          * The thumbnail is stored on disk and is only computed if the thumbnail
 905          * file does not exist OR if it is older than the image.
 906          * Returns an object which can return the pathname, URL, and physical
 907          * pixel size of the thumbnail -- or null on failure.
 908          *
 909          * @return ThumbnailImage
 910          * @access private
 911          */
 912         function renderThumb( $width, $useScript = true ) {
 913                 global $wgUseSquid, $wgInternalServer;
 914                 global $wgThumbnailScriptPath, $wgSharedThumbnailScriptPath;
 915                 global $wgSVGMaxSize, $wgMaxImageArea, $wgThumbnailEpoch;
 916
 917                 $fname = 'Image::renderThumb';
 918                 wfProfileIn( $fname );
 919
 920                 $width = intval( $width );
 921
 922                 $this->load();
 923                 if ( ! $this->exists() )
 924                 {
 925                         # If there is no image, there will be no thumbnail
 926                         wfProfileOut( $fname );
 927                         return null;
 928                 }
 929
 930                 # Sanity check $width
 931                 if( $width <= 0 || $this->width <= 0) {
 932                         # BZZZT
 933                         wfProfileOut( $fname );
 934                         return null;
 935                 }
 936
 937                 # Don't thumbnail an image so big that it will fill hard drives and send servers into swap
 938                 # JPEG has the handy property of allowing thumbnailing without full decompression, so we make
 939                 # an exception for it.
 940                 if ( $this->getMediaType() == MEDIATYPE_BITMAP &&
 941                         $this->getMimeType() !== 'image/jpeg' &&
 942                         $this->width * $this->height > $wgMaxImageArea )
 943                 {
 944                         wfProfileOut( $fname );
 945                         return null;
 946                 }
 947
 948                 # Don't make an image bigger than the source, or wgMaxSVGSize for SVGs
 949                 if ( $this->mustRender() ) {
 950                         $width = min( $width, $wgSVGMaxSize );
 951                 } elseif ( $width > $this->width - 1 ) {
 952                         $thumb = new ThumbnailImage( $this->getURL(), $this->getWidth(), $this->getHeight() );
 953                         wfProfileOut( $fname );
 954                         return $thumb;
 955                 }
 956
 957                 $height = round( $this->height * $width / $this->width );
 958
 959                 list( $isScriptUrl, $url ) = $this->thumbUrl( $width );
 960                 if ( $isScriptUrl && $useScript ) {
 961                         // Use thumb.php to render the image
 962                         $thumb = new ThumbnailImage( $url, $width, $height );
 963                         wfProfileOut( $fname );
 964                         return $thumb;
 965                 }
 966
 967                 $thumbName = $this->thumbName( $width, $this->fromSharedDirectory );
 968                 $thumbPath = wfImageThumbDir( $this->name, $this->fromSharedDirectory ).'/'.$thumbName;
 969
 970                 if ( !file_exists( $thumbPath ) ||
 971                         filemtime( $thumbPath ) < wfTimestamp( TS_UNIX, $wgThumbnailEpoch ) ) {
 972                         $oldThumbPath = wfDeprecatedThumbDir( $thumbName, 'thumb', $this->fromSharedDirectory ).
 973                                 '/'.$thumbName;
 974                         $done = false;
 975                         if ( file_exists( $oldThumbPath ) ) {
 976                                 if ( filemtime($oldThumbPath) >= filemtime($this->imagePath) ) {
 977                                         rename( $oldThumbPath, $thumbPath );
 978                                         $done = true;
 979                                 } else {
 980                                         unlink( $oldThumbPath );
 981                                 }
 982                         }
 983                         if ( !$done ) {
 984                                 $this->reallyRenderThumb( $thumbPath, $width, $height );
 985
 986                                 # Purge squid
 987                                 # This has to be done after the image is updated and present for all machines on NFS,
 988                                 # or else the old version might be stored into the squid again
 989                                 if ( $wgUseSquid ) {
 990                                         if ( substr( $url, 0, 4 ) == 'http' ) {
 991                                                 $urlArr = array( $url );
 992                                         } else {
 993                                                 $urlArr = array( $wgInternalServer.$url );
 994                                         }
 995                                         wfPurgeSquidServers($urlArr);
 996                                 }
 997                         }
 998                 }
 999
1000                 $thumb = new ThumbnailImage( $url, $width, $height, $thumbPath );
1001                 wfProfileOut( $fname );
1002                 return $thumb;
1003         } // END OF function renderThumb
1004
1005         /**
1006          * Really render a thumbnail
1007          * Call this only for images for which canRender() returns true.
1008          *
1009          * @access private
1010          */
1011         function reallyRenderThumb( $thumbPath, $width, $height ) {
1012                 global $wgSVGConverters, $wgSVGConverter,
1013                         $wgUseImageMagick, $wgImageMagickConvertCommand;
1014
1015                 $this->load();
1016
1017                 if( $this->mime === "image/svg" ) {
1018                         #Right now we have only SVG
1019
1020                         global $wgSVGConverters, $wgSVGConverter;
1021                         if( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
1022                                 global $wgSVGConverterPath;
1023                                 $cmd = str_replace(
1024                                         array( '$path/', '$width', '$height', '$input', '$output' ),
1025                                         array( $wgSVGConverterPath ? "$wgSVGConverterPath/" : "",
1026                                                    intval( $width ),
1027                                                    intval( $height ),
1028                                                    wfEscapeShellArg( $this->imagePath ),
1029                                                    wfEscapeShellArg( $thumbPath ) ),
1030                                         $wgSVGConverters[$wgSVGConverter] );
1031                                 wfProfileIn( 'rsvg' );
1032                                 wfDebug( "reallyRenderThumb SVG: $cmd\n" );
1033                                 $conv = wfShellExec( $cmd );
1034                                 wfProfileOut( 'rsvg' );
1035                         } else {
1036                                 $conv = false;
1037                         }
1038                 } elseif ( $wgUseImageMagick ) {
1039                         # use ImageMagick
1040                         # Specify white background color, will be used for transparent images
1041                         # in Internet Explorer/Windows instead of default black.
1042
1043                         # Note, we specify "-size {$width}" and NOT "-size {$width}x{$height}".
1044                         # It seems that ImageMagick has a bug wherein it produces thumbnails of
1045                         # the wrong size in the second case.
1046                         $cmd  =  $wgImageMagickConvertCommand .
1047                                 " -quality 85 -background white -size {$width} ".
1048                                 wfEscapeShellArg($this->imagePath) . " -resize {$width}x{$height} " .
1049                                 wfEscapeShellArg($thumbPath);
1050                         wfDebug("reallyRenderThumb: running ImageMagick: $cmd\n");
1051                         wfProfileIn( 'convert' );
1052                         $conv = wfShellExec( $cmd );
1053                         wfProfileOut( 'convert' );
1054                 } else {
1055                         # Use PHP's builtin GD library functions.
1056                         #
1057                         # First find out what kind of file this is, and select the correct
1058                         # input routine for this.
1059
1060                         $typemap = array(
1061                                 'image/gif'          => array( 'imagecreatefromgif',  'palette',   'imagegif'  ),
1062                                 'image/jpeg'         => array( 'imagecreatefromjpeg', 'truecolor', array( &$this, 'imageJpegWrapper' ) ),
1063                                 'image/png'          => array( 'imagecreatefrompng',  'bits',      'imagepng'  ),
1064                                 'image/vnd.wap.wmbp' => array( 'imagecreatefromwbmp', 'palette',   'imagewbmp'  ),
1065                                 'image/xbm'          => array( 'imagecreatefromxbm',  'palette',   'imagexbm'  ),
1066                         );
1067                         if( !isset( $typemap[$this->mime] ) ) {
1068                                 $err = 'Image type not supported';
1069                                 wfDebug( "$err\n" );
1070                                 return $err;
1071                         }
1072                         list( $loader, $colorStyle, $saveType ) = $typemap[$this->mime];
1073
1074                         if( !function_exists( $loader ) ) {
1075                                 $err = "Incomplete GD library configuration: missing function $loader";
1076                                 wfDebug( "$err\n" );
1077                                 return $err;
1078                         }
1079                         if( $colorStyle == 'palette' ) {
1080                                 $truecolor = false;
1081                         } elseif( $colorStyle == 'truecolor' ) {
1082                                 $truecolor = true;
1083                         } elseif( $colorStyle == 'bits' ) {
1084                                 $truecolor = ( $this->bits > 8 );
1085                         }
1086
1087                         $src_image = call_user_func( $loader, $this->imagePath );
1088                         if ( $truecolor ) {
1089                                 $dst_image = imagecreatetruecolor( $width, $height );
1090                         } else {
1091                                 $dst_image = imagecreate( $width, $height );
1092                         }
1093                         imagecopyresampled( $dst_image, $src_image,
1094                                                 0,0,0,0,
1095                                                 $width, $height, $this->width, $this->height );
1096                         call_user_func( $saveType, $dst_image, $thumbPath );
1097                         imagedestroy( $dst_image );
1098                         imagedestroy( $src_image );
1099                 }
1100
1101                 #
1102                 # Check for zero-sized thumbnails. Those can be generated when
1103                 # no disk space is available or some other error occurs
1104                 #
1105                 if( file_exists( $thumbPath ) ) {
1106                         $thumbstat = stat( $thumbPath );
1107                         if( $thumbstat['size'] == 0 ) {
1108                                 unlink( $thumbPath );
1109                         }
1110                 }
1111         }
1112
1113         function imageJpegWrapper( $dst_image, $thumbPath ) {
1114                 imageinterlace( $dst_image );
1115                 imagejpeg( $dst_image, $thumbPath, 95 );
1116         }
1117
1118         /**
1119          * Get all thumbnail names previously generated for this image
1120          */
1121         function getThumbnails( $shared = false ) {
1122                 if ( Image::isHashed( $shared ) ) {
1123                         $this->load();
1124                         $files = array();
1125                         $dir = wfImageThumbDir( $this->name, $shared );
1126
1127                         // This generates an error on failure, hence the @
1128                         $handle = @opendir( $dir );
1129
1130                         if ( $handle ) {
1131                                 while ( false !== ( $file = readdir($handle) ) ) {
1132                                         if ( $file{0} != '.' ) {
1133                                                 $files[] = $file;
1134                                         }
1135                                 }
1136                                 closedir( $handle );
1137                         }
1138                 } else {
1139                         $files = array();
1140                 }
1141
1142                 return $files;
1143         }
1144
1145         /**
1146          * Refresh metadata in memcached, but don't touch thumbnails or squid
1147          */
1148         function purgeMetadataCache() {
1149                 clearstatcache();
1150                 $this->loadFromFile();
1151                 $this->saveToCache();
1152         }
1153
1154         /**
1155          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
1156          */
1157         function purgeCache( $archiveFiles = array(), $shared = false ) {
1158                 global $wgInternalServer, $wgUseSquid;
1159
1160                 // Refresh metadata cache
1161                 $this->purgeMetadataCache();
1162
1163                 // Delete thumbnails
1164                 $files = $this->getThumbnails( $shared );
1165                 $dir = wfImageThumbDir( $this->name, $shared );
1166                 $urls = array();
1167                 foreach ( $files as $file ) {
1168                         if ( preg_match( '/^(\d+)px/', $file, $m ) ) {
1169                                 $urls[] = $wgInternalServer . $this->thumbUrl( $m[1], $this->fromSharedDirectory );
1170                                 @unlink( "$dir/$file" );
1171                         }
1172                 }
1173
1174                 // Purge the squid
1175                 if ( $wgUseSquid ) {
1176                         $urls[] = $wgInternalServer . $this->getViewURL();
1177                         foreach ( $archiveFiles as $file ) {
1178                                 $urls[] = $wgInternalServer . wfImageArchiveUrl( $file );
1179                         }
1180                         wfPurgeSquidServers( $urls );
1181                 }
1182         }
1183
1184         function checkDBSchema(&$db) {
1185                 # img_name must be unique
1186                 if ( !$db->indexUnique( 'image', 'img_name' ) && !$db->indexExists('image','PRIMARY') ) {
1187                         wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
1188                 }
1189
1190                 #new fields must exist
1191                 if ( !$db->fieldExists( 'image', 'img_media_type' )
1192                   || !$db->fieldExists( 'image', 'img_metadata' )
1193                   || !$db->fieldExists( 'image', 'img_width' ) ) {
1194
1195                         wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/update.php' );
1196                 }
1197         }
1198
1199         /**
1200          * Return the image history of this image, line by line.
1201          * starts with current version, then old versions.
1202          * uses $this->historyLine to check which line to return:
1203          *  0      return line for current version
1204          *  1      query for old versions, return first one
1205          *  2, ... return next old version from above query
1206          *
1207          * @access public
1208          */
1209         function nextHistoryLine() {
1210                 $fname = 'Image::nextHistoryLine()';
1211                 $dbr =& wfGetDB( DB_SLAVE );
1212
1213                 $this->checkDBSchema($dbr);
1214
1215                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
1216                         $this->historyRes = $dbr->select( 'image',
1217                                 array(
1218                                         'img_size',
1219                                         'img_description',
1220                                         'img_user','img_user_text',
1221                                         'img_timestamp',
1222                                         'img_width',
1223                                         'img_height',
1224                                         "'' AS oi_archive_name"
1225                                 ),
1226                                 array( 'img_name' => $this->title->getDBkey() ),
1227                                 $fname
1228                         );
1229                         if ( 0 == wfNumRows( $this->historyRes ) ) {
1230                                 return FALSE;
1231                         }
1232                 } else if ( $this->historyLine == 1 ) {
1233                         $this->historyRes = $dbr->select( 'oldimage',
1234                                 array(
1235                                         'oi_size AS img_size',
1236                                         'oi_description AS img_description',
1237                                         'oi_user AS img_user',
1238                                         'oi_user_text AS img_user_text',
1239                                         'oi_timestamp AS img_timestamp',
1240                                         'oi_width as img_width',
1241                                         'oi_height as img_height',
1242                                         'oi_archive_name'
1243                                 ),
1244                                 array( 'oi_name' => $this->title->getDBkey() ),
1245                                 $fname,
1246                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
1247                         );
1248                 }
1249                 $this->historyLine ++;
1250
1251                 return $dbr->fetchObject( $this->historyRes );
1252         }
1253
1254         /**
1255          * Reset the history pointer to the first element of the history
1256          * @access public
1257          */
1258         function resetHistory() {
1259                 $this->historyLine = 0;
1260         }
1261
1262         /**
1263         * Return the full filesystem path to the file. Note that this does
1264         * not mean that a file actually exists under that location.
1265         *
1266         * This path depends on whether directory hashing is active or not,
1267         * i.e. whether the images are all found in the same directory,
1268         * or in hashed paths like /images/3/3c.
1269         *
1270         * @access public
1271         * @param boolean $fromSharedDirectory Return the path to the file
1272         *   in a shared repository (see $wgUseSharedRepository and related
1273         *   options in DefaultSettings.php) instead of a local one.
1274         *
1275         */
1276         function getFullPath( $fromSharedRepository = false ) {
1277                 global $wgUploadDirectory, $wgSharedUploadDirectory;
1278
1279                 $dir      = $fromSharedRepository ? $wgSharedUploadDirectory :
1280                                                     $wgUploadDirectory;
1281
1282                 // $wgSharedUploadDirectory may be false, if thumb.php is used
1283                 if ( $dir ) {
1284                         $fullpath = $dir . wfGetHashPath($this->name, $fromSharedRepository) . $this->name;
1285                 } else {
1286                         $fullpath = false;
1287                 }
1288
1289                 return $fullpath;
1290         }
1291
1292         /**
1293          * @return bool
1294          * @static
1295          */
1296         function isHashed( $shared ) {
1297                 global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
1298                 return $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
1299         }
1300
1301         /**
1302          * Record an image upload in the upload log and the image table
1303          */
1304         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
1305                 global $wgUser, $wgUseCopyrightUpload, $wgUseSquid, $wgPostCommitUpdateList;
1306
1307                 $fname = 'Image::recordUpload';
1308                 $dbw =& wfGetDB( DB_MASTER );
1309
1310                 $this->checkDBSchema($dbw);
1311
1312                 // Delete thumbnails and refresh the metadata cache
1313                 $this->purgeCache();
1314
1315                 // Fail now if the image isn't there
1316                 if ( !$this->fileExists || $this->fromSharedDirectory ) {
1317                         wfDebug( "Image::recordUpload: File ".$this->imagePath." went missing!\n" );
1318                         return false;
1319                 }
1320
1321                 if ( $wgUseCopyrightUpload ) {
1322                         if ( $license != '' ) {
1323                                 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1324                         }
1325                         $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
1326                           '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1327                           "$licensetxt" .
1328                           '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1329                 } else {
1330                         if ( $license != '' ) {
1331                                 $filedesc = $desc == '' ? '' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n";
1332                                  $textdesc = $filedesc .
1333                                          '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1334                         } else {
1335                                 $textdesc = $desc;
1336                         }
1337                 }
1338
1339                 $now = $dbw->timestamp();
1340
1341                 #split mime type
1342                 if (strpos($this->mime,'/')!==false) {
1343                         list($major,$minor)= explode('/',$this->mime,2);
1344                 }
1345                 else {
1346                         $major= $this->mime;
1347                         $minor= "unknown";
1348                 }
1349
1350                 # Test to see if the row exists using INSERT IGNORE
1351                 # This avoids race conditions by locking the row until the commit, and also
1352                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1353                 $dbw->insert( 'image',
1354                         array(
1355                                 'img_name' => $this->name,
1356                                 'img_size'=> $this->size,
1357                                 'img_width' => intval( $this->width ),
1358                                 'img_height' => intval( $this->height ),
1359                                 'img_bits' => $this->bits,
1360                                 'img_media_type' => $this->type,
1361                                 'img_major_mime' => $major,
1362                                 'img_minor_mime' => $minor,
1363                                 'img_timestamp' => $now,
1364                                 'img_description' => $desc,
1365                                 'img_user' => $wgUser->getID(),
1366                                 'img_user_text' => $wgUser->getName(),
1367                                 'img_metadata' => $this->metadata,
1368                         ),
1369                         $fname,
1370                         'IGNORE'
1371                 );
1372                 $descTitle = $this->getTitle();
1373                 $purgeURLs = array();
1374
1375                 if( $dbw->affectedRows() == 0 ) {
1376                         # Collision, this is an update of an image
1377                         # Insert previous contents into oldimage
1378                         $dbw->insertSelect( 'oldimage', 'image',
1379                                 array(
1380                                         'oi_name' => 'img_name',
1381                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1382                                         'oi_size' => 'img_size',
1383                                         'oi_width' => 'img_width',
1384                                         'oi_height' => 'img_height',
1385                                         'oi_bits' => 'img_bits',
1386                                         'oi_timestamp' => 'img_timestamp',
1387                                         'oi_description' => 'img_description',
1388                                         'oi_user' => 'img_user',
1389                                         'oi_user_text' => 'img_user_text',
1390                                 ), array( 'img_name' => $this->name ), $fname
1391                         );
1392
1393                         # Update the current image row
1394                         $dbw->update( 'image',
1395                                 array( /* SET */
1396                                         'img_size' => $this->size,
1397                                         'img_width' => intval( $this->width ),
1398                                         'img_height' => intval( $this->height ),
1399                                         'img_bits' => $this->bits,
1400                                         'img_media_type' => $this->type,
1401                                         'img_major_mime' => $major,
1402                                         'img_minor_mime' => $minor,
1403                                         'img_timestamp' => $now,
1404                                         'img_description' => $desc,
1405                                         'img_user' => $wgUser->getID(),
1406                                         'img_user_text' => $wgUser->getName(),
1407                                         'img_metadata' => $this->metadata,
1408                                 ), array( /* WHERE */
1409                                         'img_name' => $this->name
1410                                 ), $fname
1411                         );
1412                 }
1413
1414                 $article = new Article( $descTitle );
1415                 $minor = false;
1416                 $watch = $watch || $wgUser->isWatched( $descTitle );
1417                 $suppressRC = true; // There's already a log entry, so don't double the RC load
1418
1419                 if( $descTitle->exists() ) {
1420                         // TODO: insert a null revision into the page history for this update.
1421                         if( $watch ) {
1422                                 $wgUser->addWatch( $descTitle );
1423                         }
1424
1425                         # Invalidate the cache for the description page
1426                         $descTitle->invalidateCache();
1427                         $purgeURLs[] = $descTitle->getInternalURL();
1428                 } else {
1429                         // New image; create the description page.
1430                         $article->insertNewArticle( $textdesc, $desc, $minor, $watch, $suppressRC );
1431                 }
1432
1433                 # Invalidate cache for all pages using this image
1434                 $linksTo = $this->getLinksTo();
1435
1436                 if ( $wgUseSquid ) {
1437                         $u = SquidUpdate::newFromTitles( $linksTo, $purgeURLs );
1438                         array_push( $wgPostCommitUpdateList, $u );
1439                 }
1440                 Title::touchArray( $linksTo );
1441
1442                 $log = new LogPage( 'upload' );
1443                 $log->addEntry( 'upload', $descTitle, $desc );
1444
1445                 return true;
1446         }
1447
1448         /**
1449          * Get an array of Title objects which are articles which use this image
1450          * Also adds their IDs to the link cache
1451          *
1452          * This is mostly copied from Title::getLinksTo()
1453          */
1454         function getLinksTo( $options = '' ) {
1455                 $fname = 'Image::getLinksTo';
1456                 wfProfileIn( $fname );
1457
1458                 if ( $options ) {
1459                         $db =& wfGetDB( DB_MASTER );
1460                 } else {
1461                         $db =& wfGetDB( DB_SLAVE );
1462                 }
1463                 $linkCache =& LinkCache::singleton();
1464
1465                 extract( $db->tableNames( 'page', 'imagelinks' ) );
1466                 $encName = $db->addQuotes( $this->name );
1467                 $sql = "SELECT page_namespace,page_title,page_id FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
1468                 $res = $db->query( $sql, $fname );
1469
1470                 $retVal = array();
1471                 if ( $db->numRows( $res ) ) {
1472                         while ( $row = $db->fetchObject( $res ) ) {
1473                                 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1474                                         $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1475                                         $retVal[] = $titleObj;
1476                                 }
1477                         }
1478                 }
1479                 $db->freeResult( $res );
1480                 wfProfileOut( $fname );
1481                 return $retVal;
1482         }
1483         /**
1484          * Retrive Exif data from the database
1485          *
1486          * Retrive Exif data from the database and prune unrecognized tags
1487          * and/or tags with invalid contents
1488          *
1489          * @return array
1490          */
1491         function retrieveExifData() {
1492                 if ( $this->getMimeType() !== "image/jpeg" )
1493                         return array();
1494
1495                 $exif = new Exif( $this->imagePath );
1496                 return $exif->getFilteredData();
1497         }
1498
1499         function getExifData() {
1500                 global $wgRequest;
1501                 if ( $this->metadata === '0' )
1502                         return array();
1503
1504                 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1505                 $ret = unserialize( $this->metadata );
1506
1507                 $oldver = isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) ? $ret['MEDIAWIKI_EXIF_VERSION'] : 0;
1508                 $newver = Exif::version();
1509
1510                 if ( !count( $ret ) || $purge || $oldver != $newver ) {
1511                         $this->purgeMetadataCache();
1512                         $this->updateExifData( $newver );
1513                 }
1514                 if ( isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) )
1515                         unset( $ret['MEDIAWIKI_EXIF_VERSION'] );
1516                 $format = new FormatExif( $ret );
1517
1518                 return $format->getFormattedData();
1519         }
1520
1521         function updateExifData( $version ) {
1522                 $fname = 'Image:updateExifData';
1523
1524                 if ( $this->getImagePath() === false ) # Not a local image
1525                         return;
1526
1527                 # Get EXIF data from image
1528                 $exif = $this->retrieveExifData();
1529                 if ( count( $exif ) ) {
1530                         $exif['MEDIAWIKI_EXIF_VERSION'] = $version;
1531                         $this->metadata = serialize( $exif );
1532                 } else {
1533                         $this->metadata = '0';
1534                 }
1535
1536                 # Update EXIF data in database
1537                 $dbw =& wfGetDB( DB_MASTER );
1538
1539                 $this->checkDBSchema($dbw);
1540
1541                 $dbw->update( 'image',
1542                         array( 'img_metadata' => $this->metadata ),
1543                         array( 'img_name' => $this->name ),
1544                         $fname
1545                 );
1546         }
1547
1548         /**
1549          * Returns true if the image does not come from the shared
1550          * image repository.
1551          *
1552          * @return bool
1553          */
1554         function isLocal() {
1555                 return !$this->fromSharedDirectory;
1556         }
1557
1558 } //class
1559
1560
1561 /**
1562  * Returns the image directory of an image
1563  * If the directory does not exist, it is created.
1564  * The result is an absolute path.
1565  *
1566  * This function is called from thumb.php before Setup.php is included
1567  *
1568  * @param string $fname         file name of the image file
1569  * @access public
1570  */
1571 function wfImageDir( $fname ) {
1572         global $wgUploadDirectory, $wgHashedUploadDirectory;
1573
1574         if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
1575
1576         $hash = md5( $fname );
1577         $oldumask = umask(0);
1578         $dest = $wgUploadDirectory . '/' . $hash{0};
1579         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
1580         $dest .= '/' . substr( $hash, 0, 2 );
1581         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
1582
1583         umask( $oldumask );
1584         return $dest;
1585 }
1586
1587 /**
1588  * Returns the image directory of an image's thubnail
1589  * If the directory does not exist, it is created.
1590  * The result is an absolute path.
1591  *
1592  * This function is called from thumb.php before Setup.php is included
1593  *
1594  * @param string $fname         file name of the original image file
1595  * @param string $subdir        (optional) subdirectory of the image upload directory that should be used for storing the thumbnail. Default is 'thumb'
1596  * @param boolean $shared       (optional) use the shared upload directory
1597  * @access public
1598  */
1599 function wfImageThumbDir( $fname, $shared = false ) {
1600         $base = wfImageArchiveDir( $fname, 'thumb', $shared );
1601         if ( Image::isHashed( $shared ) ) {
1602                 $dir =  "$base/$fname";
1603
1604                 if ( !is_dir( $base ) ) {
1605                         $oldumask = umask(0);
1606                         @mkdir( $base, 0777 );
1607                         umask( $oldumask );
1608                 }
1609
1610                 if ( ! is_dir( $dir ) ) {
1611                         $oldumask = umask(0);
1612                         @mkdir( $dir, 0777 );
1613                         umask( $oldumask );
1614                 }
1615         } else {
1616                 $dir = $base;
1617         }
1618
1619         return $dir;
1620 }
1621
1622 /**
1623  * Old thumbnail directory, kept for conversion
1624  */
1625 function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
1626         return wfImageArchiveDir( $thumbName, $subdir, $shared );
1627 }
1628
1629 /**
1630  * Returns the image directory of an image's old version
1631  * If the directory does not exist, it is created.
1632  * The result is an absolute path.
1633  *
1634  * This function is called from thumb.php before Setup.php is included
1635  *
1636  * @param string $fname         file name of the thumbnail file, including file size prefix
1637  * @param string $subdir        (optional) subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'
1638  * @param boolean $shared       (optional) use the shared upload directory (only relevant for other functions which call this one)
1639  * @access public
1640  */
1641 function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
1642         global $wgUploadDirectory, $wgHashedUploadDirectory,
1643                $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
1644         $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
1645         $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
1646         if (!$hashdir) { return $dir.'/'.$subdir; }
1647         $hash = md5( $fname );
1648         $oldumask = umask(0);
1649
1650         # Suppress warning messages here; if the file itself can't
1651         # be written we'll worry about it then.
1652         wfSuppressWarnings();
1653
1654         $archive = $dir.'/'.$subdir;
1655         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1656         $archive .= '/' . $hash{0};
1657         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1658         $archive .= '/' . substr( $hash, 0, 2 );
1659         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1660
1661         wfRestoreWarnings();
1662         umask( $oldumask );
1663         return $archive;
1664 }
1665
1666
1667 /*
1668  * Return the hash path component of an image path (URL or filesystem),
1669  * e.g. "/3/3c/", or just "/" if hashing is not used.
1670  *
1671  * @param $dbkey The filesystem / database name of the file
1672  * @param $fromSharedDirectory Use the shared file repository? It may
1673  *   use different hash settings from the local one.
1674  */
1675 function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {
1676         if( Image::isHashed( $fromSharedDirectory ) ) {
1677                 $hash = md5($dbkey);
1678                 return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
1679         } else {
1680                 return '/';
1681         }
1682 }
1683
1684 /**
1685  * Returns the image URL of an image's old version
1686  *
1687  * @param string $fname         file name of the image file
1688  * @param string $subdir        (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
1689  * @access public
1690  */
1691 function wfImageArchiveUrl( $name, $subdir='archive' ) {
1692         global $wgUploadPath, $wgHashedUploadDirectory;
1693
1694         if ($wgHashedUploadDirectory) {
1695                 $hash = md5( substr( $name, 15) );
1696                 $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
1697                   substr( $hash, 0, 2 ) . '/'.$name;
1698         } else {
1699                 $url = $wgUploadPath.'/'.$subdir.'/'.$name;
1700         }
1701         return wfUrlencode($url);
1702 }
1703
1704 /**
1705  * Return a rounded pixel equivalent for a labeled CSS/SVG length.
1706  * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
1707  *
1708  * @param string $length
1709  * @return int Length in pixels
1710  */
1711 function wfScaleSVGUnit( $length ) {
1712         static $unitLength = array(
1713                 'px' => 1.0,
1714                 'pt' => 1.25,
1715                 'pc' => 15.0,
1716                 'mm' => 3.543307,
1717                 'cm' => 35.43307,
1718                 'in' => 90.0,
1719                 ''   => 1.0, // "User units" pixels by default
1720                 '%'  => 2.0, // Fake it!
1721                 );
1722         if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
1723                 $length = floatval( $matches[1] );
1724                 $unit = $matches[2];
1725                 return round( $length * $unitLength[$unit] );
1726         } else {
1727                 // Assume pixels
1728                 return round( floatval( $length ) );
1729         }
1730 }
1731
1732 /**
1733  * Compatible with PHP getimagesize()
1734  * @todo support gzipped SVGZ
1735  * @todo check XML more carefully
1736  * @todo sensible defaults
1737  *
1738  * @param string $filename
1739  * @return array
1740  */
1741 function wfGetSVGsize( $filename ) {
1742         $width = 256;
1743         $height = 256;
1744
1745         // Read a chunk of the file
1746         $f = fopen( $filename, "rt" );
1747         if( !$f ) return false;
1748         $chunk = fread( $f, 4096 );
1749         fclose( $f );
1750
1751         // Uber-crappy hack! Run through a real XML parser.
1752         if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
1753                 return false;
1754         }
1755         $tag = $matches[1];
1756         if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
1757                 $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
1758         }
1759         if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
1760                 $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
1761         }
1762
1763         return array( $width, $height, 'SVG',
1764                 "width=\"$width\" height=\"$height\"" );
1765 }
1766
1767 /**
1768  * Determine if an image exists on the 'bad image list'
1769  *
1770  * @param string $name The image to check
1771  * @return bool
1772  */
1773 function wfIsBadImage( $name ) {
1774         global $wgContLang;
1775         static $titleList = false;
1776         if ( $titleList === false ) {
1777                 $titleList = array();
1778
1779                 $lines = explode("\n", wfMsgForContent( 'bad_image_list' ));
1780                 foreach ( $lines as $line ) {
1781                         if ( preg_match( '/^\*\s*\[{2}:(' . $wgContLang->getNsText( NS_IMAGE ) . ':.*?)\]{2}/', $line, $m ) ) {
1782                                 $t = Title::newFromText( $m[1] );
1783                                 $titleList[$t->getDBkey()] = 1;
1784                         }
1785                 }
1786         }
1787
1788         return array_key_exists( $name, $titleList );
1789 }
1790
1791
1792
1793 /**
1794  * Wrapper class for thumbnail images
1795  * @package MediaWiki
1796  */
1797 class ThumbnailImage {
1798         /**
1799          * @param string $path Filesystem path to the thumb
1800          * @param string $url URL path to the thumb
1801          * @access private
1802          */
1803         function ThumbnailImage( $url, $width, $height, $path = false ) {
1804                 $this->url = $url;
1805                 $this->width = round( $width );
1806                 $this->height = round( $height );
1807                         # These should be integers when they get here.
1808                         # If not, there's a bug somewhere.  But let's at
1809                         # least produce valid HTML code regardless.
1810                 $this->path = $path;
1811         }
1812
1813         /**
1814          * @return string The thumbnail URL
1815          */
1816         function getUrl() {
1817                 return $this->url;
1818         }
1819
1820         /**
1821          * Return HTML <img ... /> tag for the thumbnail, will include
1822          * width and height attributes and a blank alt text (as required).
1823          *
1824          * You can set or override additional attributes by passing an
1825          * associative array of name => data pairs. The data will be escaped
1826          * for HTML output, so should be in plaintext.
1827          *
1828          * @param array $attribs
1829          * @return string
1830          * @access public
1831          */
1832         function toHtml( $attribs = array() ) {
1833                 $attribs['src'] = $this->url;
1834                 $attribs['width'] = $this->width;
1835                 $attribs['height'] = $this->height;
1836                 if( !isset( $attribs['alt'] ) ) $attribs['alt'] = '';
1837
1838                 $html = '<img ';
1839                 foreach( $attribs as $name => $data ) {
1840                         $html .= $name . '="' . htmlspecialchars( $data ) . '" ';
1841                 }
1842                 $html .= '/>';
1843                 return $html;
1844         }
1845
1846 }
1847 ?>