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                 $lastError;     # Error string associated with a thumbnail display error
  53
  54
  55         /**#@-*/
  56
  57         /**
  58          * Create an Image object from an image name
  59          *
  60          * @param string $name name of the image, used to create a title object using Title::makeTitleSafe
  61          * @access public
  62          */
  63         function newFromName( $name ) {
  64                 $title = Title::makeTitleSafe( NS_IMAGE, $name );
  65                 if ( is_object( $title ) ) {
  66                         return new Image( $title );
  67                 } else {
  68                         return NULL;
  69                 }
  70         }
  71
  72         /**
  73          * Obsolete factory function, use constructor
  74          */
  75         function newFromTitle( $title ) {
  76                 return new Image( $title );
  77         }
  78
  79         function Image( $title ) {
  80                 if( !is_object( $title ) ) {
  81                         wfDebugDieBacktrace( 'Image constructor given bogus title.' );
  82                 }
  83                 $this->title =& $title;
  84                 $this->name = $title->getDBkey();
  85                 $this->metadata = serialize ( array() ) ;
  86
  87                 $n = strrpos( $this->name, '.' );
  88                 $this->extension = strtolower( $n ? substr( $this->name, $n + 1 ) : '' );
  89                 $this->historyLine = 0;
  90
  91                 $this->dataLoaded = false;
  92         }
  93
  94         /**
  95          * Get the memcached keys
  96          * Returns an array, first element is the local cache key, second is the shared cache key, if there is one
  97          */
  98         function getCacheKeys( $shared = false ) {
  99                 global $wgDBname, $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
 100
 101                 $foundCached = false;
 102                 $hashedName = md5($this->name);
 103                 $keys = array( "$wgDBname:Image:$hashedName" );
 104                 if ( $wgUseSharedUploads && $wgSharedUploadDBname && $wgCacheSharedUploads ) {
 105                         $keys[] = "$wgSharedUploadDBname:Image:$hashedName";
 106                 }
 107                 return $keys;
 108         }
 109
 110         /**
 111          * Try to load image metadata from memcached. Returns true on success.
 112          */
 113         function loadFromCache() {
 114                 global $wgUseSharedUploads, $wgMemc;
 115                 $fname = 'Image::loadFromMemcached';
 116                 wfProfileIn( $fname );
 117                 $this->dataLoaded = false;
 118                 $keys = $this->getCacheKeys();
 119                 $cachedValues = $wgMemc->get( $keys[0] );
 120
 121                 // Check if the key existed and belongs to this version of MediaWiki
 122                 if (!empty($cachedValues) && is_array($cachedValues)
 123                   && isset($cachedValues['version']) && ( $cachedValues['version'] == MW_IMAGE_VERSION )
 124                   && $cachedValues['fileExists'] && isset( $cachedValues['mime'] ) && isset( $cachedValues['metadata'] ) )
 125                 {
 126                         if ( $wgUseSharedUploads && $cachedValues['fromShared']) {
 127                                 # if this is shared file, we need to check if image
 128                                 # in shared repository has not changed
 129                                 if ( isset( $keys[1] ) ) {
 130                                         $commonsCachedValues = $wgMemc->get( $keys[1] );
 131                                         if (!empty($commonsCachedValues) && is_array($commonsCachedValues)
 132                                           && isset($commonsCachedValues['version'])
 133                                           && ( $commonsCachedValues['version'] == MW_IMAGE_VERSION )
 134                                           && isset($commonsCachedValues['mime'])) {
 135                                                 wfDebug( "Pulling image metadata from shared repository cache\n" );
 136                                                 $this->name = $commonsCachedValues['name'];
 137                                                 $this->imagePath = $commonsCachedValues['imagePath'];
 138                                                 $this->fileExists = $commonsCachedValues['fileExists'];
 139                                                 $this->width = $commonsCachedValues['width'];
 140                                                 $this->height = $commonsCachedValues['height'];
 141                                                 $this->bits = $commonsCachedValues['bits'];
 142                                                 $this->type = $commonsCachedValues['type'];
 143                                                 $this->mime = $commonsCachedValues['mime'];
 144                                                 $this->metadata = $commonsCachedValues['metadata'];
 145                                                 $this->size = $commonsCachedValues['size'];
 146                                                 $this->fromSharedDirectory = true;
 147                                                 $this->dataLoaded = true;
 148                                                 $this->imagePath = $this->getFullPath(true);
 149                                         }
 150                                 }
 151                         } else {
 152                                 wfDebug( "Pulling image metadata from local cache\n" );
 153                                 $this->name = $cachedValues['name'];
 154                                 $this->imagePath = $cachedValues['imagePath'];
 155                                 $this->fileExists = $cachedValues['fileExists'];
 156                                 $this->width = $cachedValues['width'];
 157                                 $this->height = $cachedValues['height'];
 158                                 $this->bits = $cachedValues['bits'];
 159                                 $this->type = $cachedValues['type'];
 160                                 $this->mime = $cachedValues['mime'];
 161                                 $this->metadata = $cachedValues['metadata'];
 162                                 $this->size = $cachedValues['size'];
 163                                 $this->fromSharedDirectory = false;
 164                                 $this->dataLoaded = true;
 165                                 $this->imagePath = $this->getFullPath();
 166                         }
 167                 }
 168                 if ( $this->dataLoaded ) {
 169                         wfIncrStats( 'image_cache_hit' );
 170                 } else {
 171                         wfIncrStats( 'image_cache_miss' );
 172                 }
 173
 174                 wfProfileOut( $fname );
 175                 return $this->dataLoaded;
 176         }
 177
 178         /**
 179          * Save the image metadata to memcached
 180          */
 181         function saveToCache() {
 182                 global $wgMemc;
 183                 $this->load();
 184                 $keys = $this->getCacheKeys();
 185                 if ( $this->fileExists ) {
 186                         // We can't cache negative metadata for non-existent files,
 187                         // because if the file later appears in commons, the local
 188                         // keys won't be purged.
 189                         $cachedValues = array(
 190                                 'version'    => MW_IMAGE_VERSION,
 191                                 'name'       => $this->name,
 192                                 'imagePath'  => $this->imagePath,
 193                                 'fileExists' => $this->fileExists,
 194                                 'fromShared' => $this->fromSharedDirectory,
 195                                 'width'      => $this->width,
 196                                 'height'     => $this->height,
 197                                 'bits'       => $this->bits,
 198                                 'type'       => $this->type,
 199                                 'mime'       => $this->mime,
 200                                 'metadata'   => $this->metadata,
 201                                 'size'       => $this->size );
 202
 203                         $wgMemc->set( $keys[0], $cachedValues, 60 * 60 * 24 * 7 ); // A week
 204                 } else {
 205                         // However we should clear them, so they aren't leftover
 206                         // if we've deleted the file.
 207                         $wgMemc->delete( $keys[0] );
 208                 }
 209         }
 210
 211         /**
 212          * Load metadata from the file itself
 213          */
 214         function loadFromFile() {
 215                 global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgContLang, $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 = wfFitBoxWidth( $this->width, $this->height, $height );
 870                         $thumb = $this->renderThumb( $width );
 871                 }
 872                 else $thumb= NULL; #not a bitmap or renderable image, don't try.
 873
 874                 if( is_null( $thumb ) ) {
 875                         $thumb = $this->iconThumb();
 876                 }
 877                 return $thumb;
 878         }
 879
 880         /**
 881          * @return ThumbnailImage
 882          */
 883         function iconThumb() {
 884                 global $wgStylePath, $wgStyleDirectory;
 885
 886                 $try = array( 'fileicon-' . $this->extension . '.png', 'fileicon.png' );
 887                 foreach( $try as $icon ) {
 888                         $path = '/common/images/icons/' . $icon;
 889                         $filepath = $wgStyleDirectory . $path;
 890                         if( file_exists( $filepath ) ) {
 891                                 return new ThumbnailImage( $wgStylePath . $path, 120, 120 );
 892                         }
 893                 }
 894                 return null;
 895         }
 896
 897         /**
 898          * Create a thumbnail of the image having the specified width.
 899          * The thumbnail will not be created if the width is larger than the
 900          * image's width. Let the browser do the scaling in this case.
 901          * The thumbnail is stored on disk and is only computed if the thumbnail
 902          * file does not exist OR if it is older than the image.
 903          * Returns an object which can return the pathname, URL, and physical
 904          * pixel size of the thumbnail -- or null on failure.
 905          *
 906          * @return ThumbnailImage
 907          * @access private
 908          */
 909         function renderThumb( $width, $useScript = true ) {
 910                 global $wgUseSquid, $wgInternalServer;
 911                 global $wgSVGMaxSize, $wgMaxImageArea, $wgThumbnailEpoch;
 912
 913                 $fname = 'Image::renderThumb';
 914                 wfProfileIn( $fname );
 915
 916                 $width = intval( $width );
 917
 918                 $this->load();
 919                 if ( ! $this->exists() )
 920                 {
 921                         # If there is no image, there will be no thumbnail
 922                         wfProfileOut( $fname );
 923                         return null;
 924                 }
 925
 926                 # Sanity check $width
 927                 if( $width <= 0 || $this->width <= 0) {
 928                         # BZZZT
 929                         wfProfileOut( $fname );
 930                         return null;
 931                 }
 932
 933                 # Don't thumbnail an image so big that it will fill hard drives and send servers into swap
 934                 # JPEG has the handy property of allowing thumbnailing without full decompression, so we make
 935                 # an exception for it.
 936                 if ( $this->getMediaType() == MEDIATYPE_BITMAP &&
 937                         $this->getMimeType() !== 'image/jpeg' &&
 938                         $this->width * $this->height > $wgMaxImageArea )
 939                 {
 940                         wfProfileOut( $fname );
 941                         return null;
 942                 }
 943
 944                 # Don't make an image bigger than the source, or wgMaxSVGSize for SVGs
 945                 if ( $this->mustRender() ) {
 946                         $width = min( $width, $wgSVGMaxSize );
 947                 } elseif ( $width > $this->width - 1 ) {
 948                         $thumb = new ThumbnailImage( $this->getURL(), $this->getWidth(), $this->getHeight() );
 949                         wfProfileOut( $fname );
 950                         return $thumb;
 951                 }
 952
 953                 $height = round( $this->height * $width / $this->width );
 954
 955                 list( $isScriptUrl, $url ) = $this->thumbUrl( $width );
 956                 if ( $isScriptUrl && $useScript ) {
 957                         // Use thumb.php to render the image
 958                         $thumb = new ThumbnailImage( $url, $width, $height );
 959                         wfProfileOut( $fname );
 960                         return $thumb;
 961                 }
 962
 963                 $thumbName = $this->thumbName( $width, $this->fromSharedDirectory );
 964                 $thumbPath = wfImageThumbDir( $this->name, $this->fromSharedDirectory ).'/'.$thumbName;
 965
 966                 if ( is_dir( $thumbPath ) ) {
 967                         // Directory where file should be
 968                         // This happened occasionally due to broken migration code in 1.5
 969                         // Rename to broken-*
 970                         global $wgUploadDirectory;
 971                         for ( $i = 0; $i < 100 ; $i++ ) {
 972                                 $broken = "$wgUploadDirectory/broken-$i-$thumbName";
 973                                 if ( !file_exists( $broken ) ) {
 974                                         rename( $thumbPath, $broken );
 975                                         break;
 976                                 }
 977                         }
 978                         // Code below will ask if it exists, and the answer is now no
 979                         clearstatcache();
 980                 }
 981
 982                 $done = true;
 983                 if ( !file_exists( $thumbPath ) ||
 984                         filemtime( $thumbPath ) < wfTimestamp( TS_UNIX, $wgThumbnailEpoch ) ) {
 985                         $oldThumbPath = wfDeprecatedThumbDir( $thumbName, 'thumb', $this->fromSharedDirectory ).
 986                                 '/'.$thumbName;
 987                         $done = false;
 988
 989                         // Migration from old directory structure
 990                         if ( is_file( $oldThumbPath ) ) {
 991                                 if ( filemtime($oldThumbPath) >= filemtime($this->imagePath) ) {
 992                                         if ( file_exists( $thumbPath ) ) {
 993                                                 if ( !is_dir( $thumbPath ) ) {
 994                                                         // Old image in the way of rename
 995                                                         unlink( $thumbPath );
 996                                                 } else {
 997                                                         // This should have been dealt with already
 998                                                         wfDebugDieBacktrace( "Directory where image should be: $thumbPath" );
 999                                                 }
1000                                         }
1001                                         // Rename the old image into the new location
1002                                         rename( $oldThumbPath, $thumbPath );
1003                                         $done = true;
1004                                 } else {
1005                                         unlink( $oldThumbPath );
1006                                 }
1007                         }
1008                         if ( !$done ) {
1009                                 $this->lastError = $this->reallyRenderThumb( $thumbPath, $width, $height );
1010                                 if ( $this->lastError === true ) {
1011                                         $done = true;
1012                                 }
1013
1014                                 # Purge squid
1015                                 # This has to be done after the image is updated and present for all machines on NFS,
1016                                 # or else the old version might be stored into the squid again
1017                                 if ( $wgUseSquid ) {
1018                                         if ( substr( $url, 0, 4 ) == 'http' ) {
1019                                                 $urlArr = array( $url );
1020                                         } else {
1021                                                 $urlArr = array( $wgInternalServer.$url );
1022                                         }
1023                                         wfPurgeSquidServers($urlArr);
1024                                 }
1025                         }
1026                 }
1027
1028                 if ( $done ) {
1029                         $thumb = new ThumbnailImage( $url, $width, $height, $thumbPath );
1030                 } else {
1031                         $thumb = null;
1032                 }
1033                 wfProfileOut( $fname );
1034                 return $thumb;
1035         } // END OF function renderThumb
1036
1037         /**
1038          * Really render a thumbnail
1039          * Call this only for images for which canRender() returns true.
1040          *
1041          * @param string $thumbPath Path to thumbnail
1042          * @param int $width Desired width in pixels
1043          * @param int $height Desired height in pixels
1044          * @return bool True on error, false or error string on failure.
1045          * @access private
1046          */
1047         function reallyRenderThumb( $thumbPath, $width, $height ) {
1048                 global $wgSVGConverters, $wgSVGConverter;
1049                 global $wgUseImageMagick, $wgImageMagickConvertCommand;
1050                 global $wgCustomConvertCommand;
1051
1052                 $this->load();
1053
1054                 $err = false;
1055                 if( $this->mime === "image/svg" ) {
1056                         #Right now we have only SVG
1057
1058                         global $wgSVGConverters, $wgSVGConverter;
1059                         if( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
1060                                 global $wgSVGConverterPath;
1061                                 $cmd = str_replace(
1062                                         array( '$path/', '$width', '$height', '$input', '$output' ),
1063                                         array( $wgSVGConverterPath ? "$wgSVGConverterPath/" : "",
1064                                                    intval( $width ),
1065                                                    intval( $height ),
1066                                                    wfEscapeShellArg( $this->imagePath ),
1067                                                    wfEscapeShellArg( $thumbPath ) ),
1068                                         $wgSVGConverters[$wgSVGConverter] );
1069                                 wfProfileIn( 'rsvg' );
1070                                 wfDebug( "reallyRenderThumb SVG: $cmd\n" );
1071                                 $err = wfShellExec( $cmd );
1072                                 wfProfileOut( 'rsvg' );
1073                         }
1074                 } elseif ( $wgUseImageMagick ) {
1075                         # use ImageMagick
1076
1077                         if ( $this->mime == 'image/jpeg' ) {
1078                                 $quality = "-quality 80"; // 80%
1079                         } elseif ( $this->mime == 'image/png' ) {
1080                                 $quality = "-quality 95"; // zlib 9, adaptive filtering
1081                         } else {
1082                                 $quality = ''; // default
1083                         }
1084
1085                         # Specify white background color, will be used for transparent images
1086                         # in Internet Explorer/Windows instead of default black.
1087
1088                         # Note, we specify "-size {$width}" and NOT "-size {$width}x{$height}".
1089                         # It seems that ImageMagick has a bug wherein it produces thumbnails of
1090                         # the wrong size in the second case.
1091
1092                         $cmd  =  wfEscapeShellArg($wgImageMagickConvertCommand) .
1093                                 " {$quality} -background white -size {$width} ".
1094                                 wfEscapeShellArg($this->imagePath) .
1095                                 // For the -resize option a "!" is needed to force exact size,
1096                                 // or ImageMagick may decide your ratio is wrong and slice off
1097                                 // a pixel.
1098                                 " -resize " . wfEscapeShellArg( "{$width}x{$height}!" ) .
1099                                 " -depth 8 " .
1100                                 wfEscapeShellArg($thumbPath) . " 2>&1";
1101                         wfDebug("reallyRenderThumb: running ImageMagick: $cmd\n");
1102                         wfProfileIn( 'convert' );
1103                         $err = wfShellExec( $cmd );
1104                         wfProfileOut( 'convert' );
1105                 } elseif( $wgCustomConvertCommand ) {
1106                         # Use a custom convert command
1107                         # Variables: %s %d %w %h
1108                         $src = wfEscapeShellArg( $this->imagePath );
1109                         $dst = wfEscapeShellArg( $thumbPath );
1110                         $cmd = $wgCustomConvertCommand;
1111                         $cmd = str_replace( '%s', $src, str_replace( '%d', $dst, $cmd ) ); # Filenames
1112                         $cmd = str_replace( '%h', $height, str_replace( '%w', $width, $cmd ) ); # Size
1113                         wfDebug( "reallyRenderThumb: Running custom convert command $cmd\n" );
1114                         wfProfileIn( 'convert' );
1115                         $err = wfShellExec( $cmd );
1116                         wfProfileOut( 'convert' );
1117                 } else {
1118                         # Use PHP's builtin GD library functions.
1119                         #
1120                         # First find out what kind of file this is, and select the correct
1121                         # input routine for this.
1122
1123                         $typemap = array(
1124                                 'image/gif'          => array( 'imagecreatefromgif',  'palette',   'imagegif'  ),
1125                                 'image/jpeg'         => array( 'imagecreatefromjpeg', 'truecolor', array( &$this, 'imageJpegWrapper' ) ),
1126                                 'image/png'          => array( 'imagecreatefrompng',  'bits',      'imagepng'  ),
1127                                 'image/vnd.wap.wmbp' => array( 'imagecreatefromwbmp', 'palette',   'imagewbmp'  ),
1128                                 'image/xbm'          => array( 'imagecreatefromxbm',  'palette',   'imagexbm'  ),
1129                         );
1130                         if( !isset( $typemap[$this->mime] ) ) {
1131                                 $err = 'Image type not supported';
1132                                 wfDebug( "$err\n" );
1133                                 return $err;
1134                         }
1135                         list( $loader, $colorStyle, $saveType ) = $typemap[$this->mime];
1136
1137                         if( !function_exists( $loader ) ) {
1138                                 $err = "Incomplete GD library configuration: missing function $loader";
1139                                 wfDebug( "$err\n" );
1140                                 return $err;
1141                         }
1142                         if( $colorStyle == 'palette' ) {
1143                                 $truecolor = false;
1144                         } elseif( $colorStyle == 'truecolor' ) {
1145                                 $truecolor = true;
1146                         } elseif( $colorStyle == 'bits' ) {
1147                                 $truecolor = ( $this->bits > 8 );
1148                         }
1149
1150                         $src_image = call_user_func( $loader, $this->imagePath );
1151                         if ( $truecolor ) {
1152                                 $dst_image = imagecreatetruecolor( $width, $height );
1153                         } else {
1154                                 $dst_image = imagecreate( $width, $height );
1155                         }
1156                         imagecopyresampled( $dst_image, $src_image,
1157                                                 0,0,0,0,
1158                                                 $width, $height, $this->width, $this->height );
1159                         call_user_func( $saveType, $dst_image, $thumbPath );
1160                         imagedestroy( $dst_image );
1161                         imagedestroy( $src_image );
1162                 }
1163
1164                 #
1165                 # Check for zero-sized thumbnails. Those can be generated when
1166                 # no disk space is available or some other error occurs
1167                 #
1168                 if( file_exists( $thumbPath ) ) {
1169                         $thumbstat = stat( $thumbPath );
1170                         if( $thumbstat['size'] == 0 ) {
1171                                 unlink( $thumbPath );
1172                         } else {
1173                                 // All good
1174                                 $err = true;
1175                         }
1176                 }
1177                 if ( $err !== true ) {
1178                         return wfMsg( 'thumbnail_error', $err );
1179                 } else {
1180                         return true;
1181                 }
1182         }
1183
1184         function getLastError() {
1185                 return $this->lastError;
1186         }
1187
1188         function imageJpegWrapper( $dst_image, $thumbPath ) {
1189                 imageinterlace( $dst_image );
1190                 imagejpeg( $dst_image, $thumbPath, 95 );
1191         }
1192
1193         /**
1194          * Get all thumbnail names previously generated for this image
1195          */
1196         function getThumbnails( $shared = false ) {
1197                 if ( Image::isHashed( $shared ) ) {
1198                         $this->load();
1199                         $files = array();
1200                         $dir = wfImageThumbDir( $this->name, $shared );
1201
1202                         // This generates an error on failure, hence the @
1203                         $handle = @opendir( $dir );
1204
1205                         if ( $handle ) {
1206                                 while ( false !== ( $file = readdir($handle) ) ) {
1207                                         if ( $file{0} != '.' ) {
1208                                                 $files[] = $file;
1209                                         }
1210                                 }
1211                                 closedir( $handle );
1212                         }
1213                 } else {
1214                         $files = array();
1215                 }
1216
1217                 return $files;
1218         }
1219
1220         /**
1221          * Refresh metadata in memcached, but don't touch thumbnails or squid
1222          */
1223         function purgeMetadataCache() {
1224                 clearstatcache();
1225                 $this->loadFromFile();
1226                 $this->saveToCache();
1227         }
1228
1229         /**
1230          * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
1231          */
1232         function purgeCache( $archiveFiles = array(), $shared = false ) {
1233                 global $wgInternalServer, $wgUseSquid;
1234
1235                 // Refresh metadata cache
1236                 $this->purgeMetadataCache();
1237
1238                 // Delete thumbnails
1239                 $files = $this->getThumbnails( $shared );
1240                 $dir = wfImageThumbDir( $this->name, $shared );
1241                 $urls = array();
1242                 foreach ( $files as $file ) {
1243                         if ( preg_match( '/^(\d+)px/', $file, $m ) ) {
1244                                 $urls[] = $wgInternalServer . $this->thumbUrl( $m[1], $this->fromSharedDirectory );
1245                                 @unlink( "$dir/$file" );
1246                         }
1247                 }
1248
1249                 // Purge the squid
1250                 if ( $wgUseSquid ) {
1251                         $urls[] = $wgInternalServer . $this->getViewURL();
1252                         foreach ( $archiveFiles as $file ) {
1253                                 $urls[] = $wgInternalServer . wfImageArchiveUrl( $file );
1254                         }
1255                         wfPurgeSquidServers( $urls );
1256                 }
1257         }
1258
1259         function checkDBSchema(&$db) {
1260                 global $wgCheckDBSchema;
1261                 if (!$wgCheckDBSchema) {
1262                         return;
1263                 }
1264                 # img_name must be unique
1265                 if ( !$db->indexUnique( 'image', 'img_name' ) && !$db->indexExists('image','PRIMARY') ) {
1266                         wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
1267                 }
1268
1269                 #new fields must exist
1270                 if ( !$db->fieldExists( 'image', 'img_media_type' )
1271                   || !$db->fieldExists( 'image', 'img_metadata' )
1272                   || !$db->fieldExists( 'image', 'img_width' ) ) {
1273
1274                         wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/update.php' );
1275                 }
1276         }
1277
1278         /**
1279          * Return the image history of this image, line by line.
1280          * starts with current version, then old versions.
1281          * uses $this->historyLine to check which line to return:
1282          *  0      return line for current version
1283          *  1      query for old versions, return first one
1284          *  2, ... return next old version from above query
1285          *
1286          * @access public
1287          */
1288         function nextHistoryLine() {
1289                 $fname = 'Image::nextHistoryLine()';
1290                 $dbr =& wfGetDB( DB_SLAVE );
1291
1292                 $this->checkDBSchema($dbr);
1293
1294                 if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
1295                         $this->historyRes = $dbr->select( 'image',
1296                                 array(
1297                                         'img_size',
1298                                         'img_description',
1299                                         'img_user','img_user_text',
1300                                         'img_timestamp',
1301                                         'img_width',
1302                                         'img_height',
1303                                         "'' AS oi_archive_name"
1304                                 ),
1305                                 array( 'img_name' => $this->title->getDBkey() ),
1306                                 $fname
1307                         );
1308                         if ( 0 == wfNumRows( $this->historyRes ) ) {
1309                                 return FALSE;
1310                         }
1311                 } else if ( $this->historyLine == 1 ) {
1312                         $this->historyRes = $dbr->select( 'oldimage',
1313                                 array(
1314                                         'oi_size AS img_size',
1315                                         'oi_description AS img_description',
1316                                         'oi_user AS img_user',
1317                                         'oi_user_text AS img_user_text',
1318                                         'oi_timestamp AS img_timestamp',
1319                                         'oi_width as img_width',
1320                                         'oi_height as img_height',
1321                                         'oi_archive_name'
1322                                 ),
1323                                 array( 'oi_name' => $this->title->getDBkey() ),
1324                                 $fname,
1325                                 array( 'ORDER BY' => 'oi_timestamp DESC' )
1326                         );
1327                 }
1328                 $this->historyLine ++;
1329
1330                 return $dbr->fetchObject( $this->historyRes );
1331         }
1332
1333         /**
1334          * Reset the history pointer to the first element of the history
1335          * @access public
1336          */
1337         function resetHistory() {
1338                 $this->historyLine = 0;
1339         }
1340
1341         /**
1342         * Return the full filesystem path to the file. Note that this does
1343         * not mean that a file actually exists under that location.
1344         *
1345         * This path depends on whether directory hashing is active or not,
1346         * i.e. whether the images are all found in the same directory,
1347         * or in hashed paths like /images/3/3c.
1348         *
1349         * @access public
1350         * @param boolean $fromSharedDirectory Return the path to the file
1351         *   in a shared repository (see $wgUseSharedRepository and related
1352         *   options in DefaultSettings.php) instead of a local one.
1353         *
1354         */
1355         function getFullPath( $fromSharedRepository = false ) {
1356                 global $wgUploadDirectory, $wgSharedUploadDirectory;
1357
1358                 $dir      = $fromSharedRepository ? $wgSharedUploadDirectory :
1359                                                     $wgUploadDirectory;
1360
1361                 // $wgSharedUploadDirectory may be false, if thumb.php is used
1362                 if ( $dir ) {
1363                         $fullpath = $dir . wfGetHashPath($this->name, $fromSharedRepository) . $this->name;
1364                 } else {
1365                         $fullpath = false;
1366                 }
1367
1368                 return $fullpath;
1369         }
1370
1371         /**
1372          * @return bool
1373          * @static
1374          */
1375         function isHashed( $shared ) {
1376                 global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
1377                 return $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
1378         }
1379
1380         /**
1381          * Record an image upload in the upload log and the image table
1382          */
1383         function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
1384                 global $wgUser, $wgUseCopyrightUpload, $wgUseSquid, $wgPostCommitUpdateList;
1385
1386                 $fname = 'Image::recordUpload';
1387                 $dbw =& wfGetDB( DB_MASTER );
1388
1389                 $this->checkDBSchema($dbw);
1390
1391                 // Delete thumbnails and refresh the metadata cache
1392                 $this->purgeCache();
1393
1394                 // Fail now if the image isn't there
1395                 if ( !$this->fileExists || $this->fromSharedDirectory ) {
1396                         wfDebug( "Image::recordUpload: File ".$this->imagePath." went missing!\n" );
1397                         return false;
1398                 }
1399
1400                 if ( $wgUseCopyrightUpload ) {
1401                         if ( $license != '' ) {
1402                                 $licensetxt = '== ' . wfMsgForContent( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1403                         }
1404                         $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
1405                           '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
1406                           "$licensetxt" .
1407                           '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
1408                 } else {
1409                         if ( $license != '' ) {
1410                                 $filedesc = $desc == '' ? '' : '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n";
1411                                  $textdesc = $filedesc .
1412                                          '== ' . wfMsgForContent ( 'license' ) . " ==\n" . '{{' . $license . '}}' . "\n";
1413                         } else {
1414                                 $textdesc = $desc;
1415                         }
1416                 }
1417
1418                 $now = $dbw->timestamp();
1419
1420                 #split mime type
1421                 if (strpos($this->mime,'/')!==false) {
1422                         list($major,$minor)= explode('/',$this->mime,2);
1423                 }
1424                 else {
1425                         $major= $this->mime;
1426                         $minor= "unknown";
1427                 }
1428
1429                 # Test to see if the row exists using INSERT IGNORE
1430                 # This avoids race conditions by locking the row until the commit, and also
1431                 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1432                 $dbw->insert( 'image',
1433                         array(
1434                                 'img_name' => $this->name,
1435                                 'img_size'=> $this->size,
1436                                 'img_width' => intval( $this->width ),
1437                                 'img_height' => intval( $this->height ),
1438                                 'img_bits' => $this->bits,
1439                                 'img_media_type' => $this->type,
1440                                 'img_major_mime' => $major,
1441                                 'img_minor_mime' => $minor,
1442                                 'img_timestamp' => $now,
1443                                 'img_description' => $desc,
1444                                 'img_user' => $wgUser->getID(),
1445                                 'img_user_text' => $wgUser->getName(),
1446                                 'img_metadata' => $this->metadata,
1447                         ),
1448                         $fname,
1449                         'IGNORE'
1450                 );
1451                 $descTitle = $this->getTitle();
1452                 $purgeURLs = array();
1453
1454                 if( $dbw->affectedRows() == 0 ) {
1455                         # Collision, this is an update of an image
1456                         # Insert previous contents into oldimage
1457                         $dbw->insertSelect( 'oldimage', 'image',
1458                                 array(
1459                                         'oi_name' => 'img_name',
1460                                         'oi_archive_name' => $dbw->addQuotes( $oldver ),
1461                                         'oi_size' => 'img_size',
1462                                         'oi_width' => 'img_width',
1463                                         'oi_height' => 'img_height',
1464                                         'oi_bits' => 'img_bits',
1465                                         'oi_timestamp' => 'img_timestamp',
1466                                         'oi_description' => 'img_description',
1467                                         'oi_user' => 'img_user',
1468                                         'oi_user_text' => 'img_user_text',
1469                                 ), array( 'img_name' => $this->name ), $fname
1470                         );
1471
1472                         # Update the current image row
1473                         $dbw->update( 'image',
1474                                 array( /* SET */
1475                                         'img_size' => $this->size,
1476                                         'img_width' => intval( $this->width ),
1477                                         'img_height' => intval( $this->height ),
1478                                         'img_bits' => $this->bits,
1479                                         'img_media_type' => $this->type,
1480                                         'img_major_mime' => $major,
1481                                         'img_minor_mime' => $minor,
1482                                         'img_timestamp' => $now,
1483                                         'img_description' => $desc,
1484                                         'img_user' => $wgUser->getID(),
1485                                         'img_user_text' => $wgUser->getName(),
1486                                         'img_metadata' => $this->metadata,
1487                                 ), array( /* WHERE */
1488                                         'img_name' => $this->name
1489                                 ), $fname
1490                         );
1491                 } else {
1492                         # This is a new image
1493                         # Update the image count
1494                         $site_stats = $dbw->tableName( 'site_stats' );
1495                         $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", $fname );
1496                 }
1497
1498                 $article = new Article( $descTitle );
1499                 $minor = false;
1500                 $watch = $watch || $wgUser->isWatched( $descTitle );
1501                 $suppressRC = true; // There's already a log entry, so don't double the RC load
1502
1503                 if( $descTitle->exists() ) {
1504                         // TODO: insert a null revision into the page history for this update.
1505                         if( $watch ) {
1506                                 $wgUser->addWatch( $descTitle );
1507                         }
1508
1509                         # Invalidate the cache for the description page
1510                         $descTitle->invalidateCache();
1511                         $purgeURLs[] = $descTitle->getInternalURL();
1512                 } else {
1513                         // New image; create the description page.
1514                         $article->insertNewArticle( $textdesc, $desc, $minor, $watch, $suppressRC );
1515                 }
1516
1517                 # Invalidate cache for all pages using this image
1518                 $linksTo = $this->getLinksTo();
1519
1520                 if ( $wgUseSquid ) {
1521                         $u = SquidUpdate::newFromTitles( $linksTo, $purgeURLs );
1522                         array_push( $wgPostCommitUpdateList, $u );
1523                 }
1524                 Title::touchArray( $linksTo );
1525
1526                 $log = new LogPage( 'upload' );
1527                 $log->addEntry( 'upload', $descTitle, $desc );
1528
1529                 return true;
1530         }
1531
1532         /**
1533          * Get an array of Title objects which are articles which use this image
1534          * Also adds their IDs to the link cache
1535          *
1536          * This is mostly copied from Title::getLinksTo()
1537          */
1538         function getLinksTo( $options = '' ) {
1539                 $fname = 'Image::getLinksTo';
1540                 wfProfileIn( $fname );
1541
1542                 if ( $options ) {
1543                         $db =& wfGetDB( DB_MASTER );
1544                 } else {
1545                         $db =& wfGetDB( DB_SLAVE );
1546                 }
1547                 $linkCache =& LinkCache::singleton();
1548
1549                 extract( $db->tableNames( 'page', 'imagelinks' ) );
1550                 $encName = $db->addQuotes( $this->name );
1551                 $sql = "SELECT page_namespace,page_title,page_id FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
1552                 $res = $db->query( $sql, $fname );
1553
1554                 $retVal = array();
1555                 if ( $db->numRows( $res ) ) {
1556                         while ( $row = $db->fetchObject( $res ) ) {
1557                                 if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
1558                                         $linkCache->addGoodLinkObj( $row->page_id, $titleObj );
1559                                         $retVal[] = $titleObj;
1560                                 }
1561                         }
1562                 }
1563                 $db->freeResult( $res );
1564                 wfProfileOut( $fname );
1565                 return $retVal;
1566         }
1567         /**
1568          * Retrive Exif data from the database
1569          *
1570          * Retrive Exif data from the database and prune unrecognized tags
1571          * and/or tags with invalid contents
1572          *
1573          * @return array
1574          */
1575         function retrieveExifData() {
1576                 if ( $this->getMimeType() !== "image/jpeg" )
1577                         return array();
1578
1579                 $exif = new Exif( $this->imagePath );
1580                 return $exif->getFilteredData();
1581         }
1582
1583         function getExifData() {
1584                 global $wgRequest;
1585                 if ( $this->metadata === '0' )
1586                         return array();
1587
1588                 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1589                 $ret = unserialize( $this->metadata );
1590
1591                 $oldver = isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) ? $ret['MEDIAWIKI_EXIF_VERSION'] : 0;
1592                 $newver = Exif::version();
1593
1594                 if ( !count( $ret ) || $purge || $oldver != $newver ) {
1595                         $this->purgeMetadataCache();
1596                         $this->updateExifData( $newver );
1597                 }
1598                 if ( isset( $ret['MEDIAWIKI_EXIF_VERSION'] ) )
1599                         unset( $ret['MEDIAWIKI_EXIF_VERSION'] );
1600                 $format = new FormatExif( $ret );
1601
1602                 return $format->getFormattedData();
1603         }
1604
1605         function updateExifData( $version ) {
1606                 $fname = 'Image:updateExifData';
1607
1608                 if ( $this->getImagePath() === false ) # Not a local image
1609                         return;
1610
1611                 # Get EXIF data from image
1612                 $exif = $this->retrieveExifData();
1613                 if ( count( $exif ) ) {
1614                         $exif['MEDIAWIKI_EXIF_VERSION'] = $version;
1615                         $this->metadata = serialize( $exif );
1616                 } else {
1617                         $this->metadata = '0';
1618                 }
1619
1620                 # Update EXIF data in database
1621                 $dbw =& wfGetDB( DB_MASTER );
1622
1623                 $this->checkDBSchema($dbw);
1624
1625                 $dbw->update( 'image',
1626                         array( 'img_metadata' => $this->metadata ),
1627                         array( 'img_name' => $this->name ),
1628                         $fname
1629                 );
1630         }
1631
1632         /**
1633          * Returns true if the image does not come from the shared
1634          * image repository.
1635          *
1636          * @return bool
1637          */
1638         function isLocal() {
1639                 return !$this->fromSharedDirectory;
1640         }
1641
1642 } //class
1643
1644
1645 /**
1646  * Returns the image directory of an image
1647  * If the directory does not exist, it is created.
1648  * The result is an absolute path.
1649  *
1650  * This function is called from thumb.php before Setup.php is included
1651  *
1652  * @param string $fname         file name of the image file
1653  * @access public
1654  */
1655 function wfImageDir( $fname ) {
1656         global $wgUploadDirectory, $wgHashedUploadDirectory;
1657
1658         if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
1659
1660         $hash = md5( $fname );
1661         $oldumask = umask(0);
1662         $dest = $wgUploadDirectory . '/' . $hash{0};
1663         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
1664         $dest .= '/' . substr( $hash, 0, 2 );
1665         if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
1666
1667         umask( $oldumask );
1668         return $dest;
1669 }
1670
1671 /**
1672  * Returns the image directory of an image's thubnail
1673  * If the directory does not exist, it is created.
1674  * The result is an absolute path.
1675  *
1676  * This function is called from thumb.php before Setup.php is included
1677  *
1678  * @param string $fname         file name of the original image file
1679  * @param string $subdir        (optional) subdirectory of the image upload directory that should be used for storing the thumbnail. Default is 'thumb'
1680  * @param boolean $shared       (optional) use the shared upload directory
1681  * @access public
1682  */
1683 function wfImageThumbDir( $fname, $shared = false ) {
1684         $base = wfImageArchiveDir( $fname, 'thumb', $shared );
1685         if ( Image::isHashed( $shared ) ) {
1686                 $dir =  "$base/$fname";
1687
1688                 if ( !is_dir( $base ) ) {
1689                         $oldumask = umask(0);
1690                         @mkdir( $base, 0777 );
1691                         umask( $oldumask );
1692                 }
1693
1694                 if ( ! is_dir( $dir ) ) {
1695                         if ( is_file( $dir ) ) {
1696                                 // Old thumbnail in the way of directory creation, kill it
1697                                 unlink( $dir );
1698                         }
1699                         $oldumask = umask(0);
1700                         @mkdir( $dir, 0777 );
1701                         umask( $oldumask );
1702                 }
1703         } else {
1704                 $dir = $base;
1705         }
1706
1707         return $dir;
1708 }
1709
1710 /**
1711  * Old thumbnail directory, kept for conversion
1712  */
1713 function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
1714         return wfImageArchiveDir( $thumbName, $subdir, $shared );
1715 }
1716
1717 /**
1718  * Returns the image directory of an image's old version
1719  * If the directory does not exist, it is created.
1720  * The result is an absolute path.
1721  *
1722  * This function is called from thumb.php before Setup.php is included
1723  *
1724  * @param string $fname         file name of the thumbnail file, including file size prefix
1725  * @param string $subdir        (optional) subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'
1726  * @param boolean $shared       (optional) use the shared upload directory (only relevant for other functions which call this one)
1727  * @access public
1728  */
1729 function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
1730         global $wgUploadDirectory, $wgHashedUploadDirectory;
1731         global $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
1732         $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
1733         $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
1734         if (!$hashdir) { return $dir.'/'.$subdir; }
1735         $hash = md5( $fname );
1736         $oldumask = umask(0);
1737
1738         # Suppress warning messages here; if the file itself can't
1739         # be written we'll worry about it then.
1740         wfSuppressWarnings();
1741
1742         $archive = $dir.'/'.$subdir;
1743         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1744         $archive .= '/' . $hash{0};
1745         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1746         $archive .= '/' . substr( $hash, 0, 2 );
1747         if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
1748
1749         wfRestoreWarnings();
1750         umask( $oldumask );
1751         return $archive;
1752 }
1753
1754
1755 /*
1756  * Return the hash path component of an image path (URL or filesystem),
1757  * e.g. "/3/3c/", or just "/" if hashing is not used.
1758  *
1759  * @param $dbkey The filesystem / database name of the file
1760  * @param $fromSharedDirectory Use the shared file repository? It may
1761  *   use different hash settings from the local one.
1762  */
1763 function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {
1764         if( Image::isHashed( $fromSharedDirectory ) ) {
1765                 $hash = md5($dbkey);
1766                 return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
1767         } else {
1768                 return '/';
1769         }
1770 }
1771
1772 /**
1773  * Returns the image URL of an image's old version
1774  *
1775  * @param string $fname         file name of the image file
1776  * @param string $subdir        (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
1777  * @access public
1778  */
1779 function wfImageArchiveUrl( $name, $subdir='archive' ) {
1780         global $wgUploadPath, $wgHashedUploadDirectory;
1781
1782         if ($wgHashedUploadDirectory) {
1783                 $hash = md5( substr( $name, 15) );
1784                 $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
1785                   substr( $hash, 0, 2 ) . '/'.$name;
1786         } else {
1787                 $url = $wgUploadPath.'/'.$subdir.'/'.$name;
1788         }
1789         return wfUrlencode($url);
1790 }
1791
1792 /**
1793  * Return a rounded pixel equivalent for a labeled CSS/SVG length.
1794  * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
1795  *
1796  * @param string $length
1797  * @return int Length in pixels
1798  */
1799 function wfScaleSVGUnit( $length ) {
1800         static $unitLength = array(
1801                 'px' => 1.0,
1802                 'pt' => 1.25,
1803                 'pc' => 15.0,
1804                 'mm' => 3.543307,
1805                 'cm' => 35.43307,
1806                 'in' => 90.0,
1807                 ''   => 1.0, // "User units" pixels by default
1808                 '%'  => 2.0, // Fake it!
1809                 );
1810         if( preg_match( '/^(\d+(?:\.\d+)?)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
1811                 $length = floatval( $matches[1] );
1812                 $unit = $matches[2];
1813                 return round( $length * $unitLength[$unit] );
1814         } else {
1815                 // Assume pixels
1816                 return round( floatval( $length ) );
1817         }
1818 }
1819
1820 /**
1821  * Compatible with PHP getimagesize()
1822  * @todo support gzipped SVGZ
1823  * @todo check XML more carefully
1824  * @todo sensible defaults
1825  *
1826  * @param string $filename
1827  * @return array
1828  */
1829 function wfGetSVGsize( $filename ) {
1830         $width = 256;
1831         $height = 256;
1832
1833         // Read a chunk of the file
1834         $f = fopen( $filename, "rt" );
1835         if( !$f ) return false;
1836         $chunk = fread( $f, 4096 );
1837         fclose( $f );
1838
1839         // Uber-crappy hack! Run through a real XML parser.
1840         if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
1841                 return false;
1842         }
1843         $tag = $matches[1];
1844         if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
1845                 $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
1846         }
1847         if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
1848                 $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
1849         }
1850
1851         return array( $width, $height, 'SVG',
1852                 "width=\"$width\" height=\"$height\"" );
1853 }
1854
1855 /**
1856  * Determine if an image exists on the 'bad image list'
1857  *
1858  * @param string $name The image to check
1859  * @return bool
1860  */
1861 function wfIsBadImage( $name ) {
1862         global $wgContLang;
1863         static $titleList = false;
1864         if ( $titleList === false ) {
1865                 $titleList = array();
1866
1867                 $lines = explode("\n", wfMsgForContent( 'bad_image_list' ));
1868                 foreach ( $lines as $line ) {
1869                         if ( preg_match( '/^\*\s*\[{2}:(' . $wgContLang->getNsText( NS_IMAGE ) . ':.*?)\]{2}/', $line, $m ) ) {
1870                                 $t = Title::newFromText( $m[1] );
1871                                 $titleList[$t->getDBkey()] = 1;
1872                         }
1873                 }
1874         }
1875
1876         return array_key_exists( $name, $titleList );
1877 }
1878
1879
1880
1881 /**
1882  * Wrapper class for thumbnail images
1883  * @package MediaWiki
1884  */
1885 class ThumbnailImage {
1886         /**
1887          * @param string $path Filesystem path to the thumb
1888          * @param string $url URL path to the thumb
1889          * @access private
1890          */
1891         function ThumbnailImage( $url, $width, $height, $path = false ) {
1892                 $this->url = $url;
1893                 $this->width = round( $width );
1894                 $this->height = round( $height );
1895                         # These should be integers when they get here.
1896                         # If not, there's a bug somewhere.  But let's at
1897                         # least produce valid HTML code regardless.
1898                 $this->path = $path;
1899         }
1900
1901         /**
1902          * @return string The thumbnail URL
1903          */
1904         function getUrl() {
1905                 return $this->url;
1906         }
1907
1908         /**
1909          * Return HTML <img ... /> tag for the thumbnail, will include
1910          * width and height attributes and a blank alt text (as required).
1911          *
1912          * You can set or override additional attributes by passing an
1913          * associative array of name => data pairs. The data will be escaped
1914          * for HTML output, so should be in plaintext.
1915          *
1916          * @param array $attribs
1917          * @return string
1918          * @access public
1919          */
1920         function toHtml( $attribs = array() ) {
1921                 $attribs['src'] = $this->url;
1922                 $attribs['width'] = $this->width;
1923                 $attribs['height'] = $this->height;
1924                 if( !isset( $attribs['alt'] ) ) $attribs['alt'] = '';
1925
1926                 $html = '<img ';
1927                 foreach( $attribs as $name => $data ) {
1928                         $html .= $name . '="' . htmlspecialchars( $data ) . '" ';
1929                 }
1930                 $html .= '/>';
1931                 return $html;
1932         }
1933
1934 }
1935
1936 /**
1937  * Calculate the largest thumbnail width for a given original file size
1938  * such that the thumbnail's height is at most $maxHeight.
1939  * @param int $boxWidth
1940  * @param int $boxHeight
1941  * @param int $maxHeight
1942  * @return int
1943  */
1944 function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
1945         $idealWidth = $boxWidth * $maxHeight / $boxHeight;
1946         $roundedUp = ceil( $idealWidth );
1947         if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )
1948                 return floor( $idealWidth );
1949         else
1950                 return $roundedUp;
1951 }
1952
1953 ?>