<?php
/**
* @package MediaWiki
- * $Id$
*/
+# NOTE FOR WINDOWS USERS:
+# To enable EXIF functions, add the folloing lines to the
+# "Windows extensions" section of php.ini:
+#
+# extension=extensions/php_mbstring.dll
+# extension=extensions/php_exif.dll
+
+
/**
* Class to represent an image
*
*/
class Image
{
- /* private */
- var $name, # name of the image
- $imagePath, # Path of the image
- $url, # Image URL
- $title, # Title object for this image. Initialized when needed.
- $fileExists, # does the image file exist on disk?
- $historyLine, # Number of line to return by nextHistoryLine()
- $historyRes, # result of the query for the image's history
- $width, # \
- $height, # |
- $bits, # --- returned by getimagesize, see http://de3.php.net/manual/en/function.getimagesize.php
- $type, # |
- $attr; # /
-
-
-
- function Image( $name )
- {
- global $wgUploadDirectory;
-
- $this->name = $name;
- $this->title = Title::makeTitleSafe( NS_IMAGE, $this->name );
- //$this->imagePath = wfImagePath( $name );
- $hash = md5( $this->title->getDBkey() );
- $this->imagePath = $wgUploadDirectory . '/' . $hash{0} . '/' .substr( $hash, 0, 2 ) . "/{$name}";
-
- $this->url = $this->wfImageUrl( $name );
-
- if ( $this->fileExists = file_exists( $this->imagePath ) ) // Sic!, "=" is intended
- {
- @$gis = getimagesize( $this->imagePath );
- if( $gis !== false ) {
- $this->width = $gis[0];
- $this->height = $gis[1];
- $this->type = $gis[2];
- $this->attr = $gis[3];
- if ( isset( $gis['bits'] ) ) {
- $this->bits = $gis['bits'];
- } else {
- $this->bits = 0;
+ /**#@+
+ * @access private
+ */
+ var $name, # name of the image (constructor)
+ $imagePath, # Path of the image (loadFromXxx)
+ $url, # Image URL (accessor)
+ $title, # Title object for this image (constructor)
+ $fileExists, # does the image file exist on disk? (loadFromXxx)
+ $fromSharedDirectory, # load this image from $wgSharedUploadDirectory (loadFromXxx)
+ $historyLine, # Number of line to return by nextHistoryLine() (constructor)
+ $historyRes, # result of the query for the image's history (nextHistoryLine)
+ $width, # \
+ $height, # |
+ $bits, # --- returned by getimagesize (loadFromXxx)
+ $type, # |
+ $attr, # /
+ $size, # Size in bytes (loadFromXxx)
+ $exif, # EXIF data
+ $dataLoaded; # Whether or not all this has been loaded from the database (loadFromXxx)
+
+
+ /**#@-*/
+
+ /**
+ * Create an Image object from an image name
+ *
+ * @param string $name name of the image, used to create a title object using Title::makeTitleSafe
+ * @access public
+ */
+ function newFromName( $name ) {
+ $title = Title::makeTitleSafe( NS_IMAGE, $name );
+ return new Image( $title );
+ }
+
+ /**
+ * Obsolete factory function, use constructor
+ */
+ function newFromTitle( $title ) {
+ return new Image( $title );
+ }
+
+ function Image( $title ) {
+ $this->title =& $title;
+ $this->name = $title->getDBkey();
+ $this->exif = serialize ( array() ) ;
+
+ $n = strrpos( $this->name, '.' );
+ $this->extension = strtolower( $n ? substr( $this->name, $n + 1 ) : '' );
+ $this->historyLine = 0;
+
+ $this->dataLoaded = false;
+ }
+
+ /**
+ * Get the memcached keys
+ * Returns an array, first element is the local cache key, second is the shared cache key, if there is one
+ */
+ function getCacheKeys( $shared = false ) {
+ global $wgDBname, $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
+
+ $foundCached = false;
+ $hashedName = md5($this->name);
+ $keys = array( "$wgDBname:Image:$hashedName" );
+ if ( $wgUseSharedUploads && $wgSharedUploadDBname && $wgCacheSharedUploads ) {
+ $keys[] = "$wgSharedUploadDBname:Image:$hashedName";
+ }
+ return $keys;
+ }
+
+ /**
+ * Try to load image metadata from memcached. Returns true on success.
+ */
+ function loadFromCache() {
+ global $wgUseSharedUploads, $wgMemc;
+ $fname = 'Image::loadFromMemcached';
+ wfProfileIn( $fname );
+ $this->dataLoaded = false;
+ $keys = $this->getCacheKeys();
+ $cachedValues = $wgMemc->get( $keys[0] );
+
+ // Check if the key existed and belongs to this version of MediaWiki
+ if (!empty($cachedValues) && is_array($cachedValues) && isset($cachedValues['width']) && $cachedValues['fileExists']) {
+ if ( $wgUseSharedUploads && $cachedValues['fromShared']) {
+ # if this is shared file, we need to check if image
+ # in shared repository has not changed
+ if ( isset( $keys[1] ) ) {
+ $commonsCachedValues = $wgMemc->get( $keys[1] );
+ if (!empty($commonsCachedValues) && is_array($commonsCachedValues) && isset($commonsCachedValues['width'])) {
+ $this->name = $commonsCachedValues['name'];
+ $this->imagePath = $commonsCachedValues['imagePath'];
+ $this->fileExists = $commonsCachedValues['fileExists'];
+ $this->width = $commonsCachedValues['width'];
+ $this->height = $commonsCachedValues['height'];
+ $this->bits = $commonsCachedValues['bits'];
+ $this->type = $commonsCachedValues['type'];
+ $this->exif = $commonsCachedValues['exif'];
+ $this->size = $commonsCachedValues['size'];
+ $this->fromSharedDirectory = true;
+ $this->dataLoaded = true;
+ $this->imagePath = $this->getFullPath(true);
+ }
}
}
+ else {
+ $this->name = $cachedValues['name'];
+ $this->imagePath = $cachedValues['imagePath'];
+ $this->fileExists = $cachedValues['fileExists'];
+ $this->width = $cachedValues['width'];
+ $this->height = $cachedValues['height'];
+ $this->bits = $cachedValues['bits'];
+ $this->type = $cachedValues['type'];
+ $this->exif = $cachedValues['exif'];
+ $this->size = $cachedValues['size'];
+ $this->fromSharedDirectory = false;
+ $this->dataLoaded = true;
+ $this->imagePath = $this->getFullPath();
+ }
}
- $this->historyLine = 0;
+
+ wfProfileOut( $fname );
+ return $this->dataLoaded;
+ }
+
+ /**
+ * Save the image metadata to memcached
+ */
+ function saveToCache() {
+ global $wgMemc;
+ $this->load();
+ // We can't cache metadata for non-existent files, because if the file later appears
+ // in commons, the local keys won't be purged.
+ if ( $this->fileExists ) {
+ $keys = $this->getCacheKeys();
+
+ $cachedValues = array('name' => $this->name,
+ 'imagePath' => $this->imagePath,
+ 'fileExists' => $this->fileExists,
+ 'fromShared' => $this->fromSharedDirectory,
+ 'width' => $this->width,
+ 'height' => $this->height,
+ 'bits' => $this->bits,
+ 'type' => $this->type,
+ 'exif' => $this->exif,
+ 'size' => $this->size);
+
+ $wgMemc->set( $keys[0], $cachedValues );
+ }
+ }
+
+ /**
+ * Load metadata from the file itself
+ */
+ function loadFromFile() {
+ global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgLang;
+ $fname = 'Image::loadFromFile';
+ wfProfileIn( $fname );
+ $this->imagePath = $this->getFullPath();
+ $this->fileExists = file_exists( $this->imagePath );
+ $this->fromSharedDirectory = false;
+ $gis = false;
+
+ # If the file is not found, and a shared upload directory is used, look for it there.
+ if (!$this->fileExists && $wgUseSharedUploads && $wgSharedUploadDirectory) {
+ # In case we're on a wgCapitalLinks=false wiki, we
+ # capitalize the first letter of the filename before
+ # looking it up in the shared repository.
+ $sharedImage = Image::newFromName( $wgLang->ucfirst($this->name) );
+ $this->fileExists = file_exists( $sharedImage->getFullPath(true) );
+ if ( $this->fileExists ) {
+ $this->name = $sharedImage->name;
+ $this->imagePath = $this->getFullPath(true);
+ $this->fromSharedDirectory = true;
+ }
+ }
+
+ if ( $this->fileExists ) {
+ # Get size in bytes
+ $this->size = filesize( $this->imagePath );
+
+ # Height and width
+ # Don't try to get the width and height of sound and video files, that's bad for performance
+ if ( !Image::isKnownImageExtension( $this->extension ) ) {
+ $gis = false;
+ } elseif( $this->extension == 'svg' ) {
+ wfSuppressWarnings();
+ $gis = wfGetSVGsize( $this->imagePath );
+ wfRestoreWarnings();
+ } else {
+ wfSuppressWarnings();
+ $gis = getimagesize( $this->imagePath );
+ wfRestoreWarnings();
+ }
+ }
+ if( $gis === false ) {
+ $this->width = 0;
+ $this->height = 0;
+ $this->bits = 0;
+ $this->type = 0;
+ $this->exif = serialize ( array() ) ;
+ } else {
+ $this->width = $gis[0];
+ $this->height = $gis[1];
+ $this->type = $gis[2];
+ $this->exif = serialize ( $this->retrieveExifData() ) ;
+ if ( isset( $gis['bits'] ) ) {
+ $this->bits = $gis['bits'];
+ } else {
+ $this->bits = 0;
+ }
+ }
+ $this->dataLoaded = true;
+ wfProfileOut( $fname );
+ }
+
+ /**
+ * Load image metadata from the DB
+ */
+ function loadFromDB() {
+ global $wgUseSharedUploads, $wgSharedUploadDBname, $wgLang;
+ $fname = 'Image::loadFromDB';
+ wfProfileIn( $fname );
+
+ $dbr =& wfGetDB( DB_SLAVE );
+ $row = $dbr->selectRow( 'image',
+ array( 'img_size', 'img_width', 'img_height', 'img_bits', 'img_type' , 'img_metadata' ),
+ array( 'img_name' => $this->name ), $fname );
+ if ( $row ) {
+ $this->fromSharedDirectory = false;
+ $this->fileExists = true;
+ $this->loadFromRow( $row );
+ $this->imagePath = $this->getFullPath();
+ // Check for rows from a previous schema, quietly upgrade them
+ if ( $this->type == -1 ) {
+ $this->upgradeRow();
+ }
+ } elseif ( $wgUseSharedUploads && $wgSharedUploadDBname ) {
+ # In case we're on a wgCapitalLinks=false wiki, we
+ # capitalize the first letter of the filename before
+ # looking it up in the shared repository.
+ $name = $wgLang->ucfirst($this->name);
+
+ $row = $dbr->selectRow( "`$wgSharedUploadDBname`.image",
+ array( 'img_size', 'img_width', 'img_height', 'img_bits', 'img_type' ),
+ array( 'img_name' => $name ), $fname );
+ if ( $row ) {
+ $this->fromSharedDirectory = true;
+ $this->fileExists = true;
+ $this->imagePath = $this->getFullPath(true);
+ $this->name = $name;
+ $this->loadFromRow( $row );
+
+ // Check for rows from a previous schema, quietly upgrade them
+ if ( $this->type == -1 ) {
+ $this->upgradeRow();
+ }
+ }
+ }
+
+ if ( !$row ) {
+ $this->size = 0;
+ $this->width = 0;
+ $this->height = 0;
+ $this->bits = 0;
+ $this->type = 0;
+ $this->fileExists = false;
+ $this->fromSharedDirectory = false;
+ $this->exif = serialize ( array() ) ;
+ }
+
+ # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
+ $this->dataLoaded = true;
+ }
+
+ /*
+ * Load image metadata from a DB result row
+ */
+ function loadFromRow( &$row ) {
+ $this->size = $row->img_size;
+ $this->width = $row->img_width;
+ $this->height = $row->img_height;
+ $this->bits = $row->img_bits;
+ $this->type = $row->img_type;
+ $this->exif = $row->img_metadata;
+ if ( $this->exif == "" ) $this->exif = serialize ( array() ) ;
+ $this->dataLoaded = true;
}
- function newFromTitle( $nt )
- {
- $img = new Image( $nt->getDBKey() );
- $img->title = $nt;
- return $img;
+ /**
+ * Load image metadata from cache or DB, unless already loaded
+ */
+ function load() {
+ global $wgSharedUploadDBname, $wgUseSharedUploads;
+ if ( !$this->dataLoaded ) {
+ if ( !$this->loadFromCache() ) {
+ $this->loadFromDB();
+ if ( !$wgSharedUploadDBname && $wgUseSharedUploads ) {
+ $this->loadFromFile();
+ } elseif ( $this->fileExists ) {
+ $this->saveToCache();
+ }
+ }
+ $this->dataLoaded = true;
+ }
}
- function getName()
- {
+ /**
+ * Metadata was loaded from the database, but the row had a marker indicating it needs to be
+ * upgraded from the 1.4 schema, which had no width, height, bits or type. Upgrade the row.
+ */
+ function upgradeRow() {
+ global $wgDBname, $wgSharedUploadDBname;
+ $fname = 'Image::upgradeRow';
+ $this->loadFromFile();
+ $dbw =& wfGetDB( DB_MASTER );
+
+ if ( $this->fromSharedDirectory ) {
+ if ( !$wgSharedUploadDBname ) {
+ return;
+ }
+
+ // Write to the other DB using selectDB, not database selectors
+ // This avoids breaking replication in MySQL
+ $dbw->selectDB( $wgSharedUploadDBname );
+ }
+ $dbw->update( 'image',
+ array(
+ 'img_width' => $this->width,
+ 'img_height' => $this->height,
+ 'img_bits' => $this->bits,
+ 'img_type' => $this->type,
+ 'img_metadata' => $this->exif,
+ ), array( 'img_name' => $this->name ), $fname
+ );
+ if ( $this->fromSharedDirectory ) {
+ $dbw->selectDB( $wgDBname );
+ }
+ }
+
+ /**
+ * Return the name of this image
+ * @access public
+ */
+ function getName() {
return $this->name;
}
- function getURL()
- {
+ /**
+ * Return the associated title object
+ * @access public
+ */
+ function getTitle() {
+ return $this->title;
+ }
+
+ /**
+ * Return the URL of the image file
+ * @access public
+ */
+ function getURL() {
+ if ( !$this->url ) {
+ $this->load();
+ if($this->fileExists) {
+ $this->url = Image::imageUrl( $this->name, $this->fromSharedDirectory );
+ } else {
+ $this->url = '';
+ }
+ }
return $this->url;
}
+
+ function getViewURL() {
+ if( $this->mustRender() ) {
+ return $this->createThumb( $this->getWidth() );
+ } else {
+ return $this->getURL();
+ }
+ }
- function getImagePath()
- {
+ /**
+ * Return the image path of the image in the
+ * local file system as an absolute path
+ * @access public
+ */
+ function getImagePath() {
+ $this->load();
return $this->imagePath;
}
- function getWidth()
- {
+ /**
+ * Return the width of the image
+ *
+ * Returns -1 if the file specified is not a known image type
+ * @access public
+ */
+ function getWidth() {
+ $this->load();
return $this->width;
}
- function getHeight()
- {
+ /**
+ * Return the height of the image
+ *
+ * Returns -1 if the file specified is not a known image type
+ * @access public
+ */
+ function getHeight() {
+ $this->load();
return $this->height;
}
- function getType()
- {
+ /**
+ * Return the size of the image file, in bytes
+ * @access public
+ */
+ function getSize() {
+ $this->load();
+ return $this->size;
+ }
+
+ /**
+ * Return the type of the image
+ *
+ * - 1 GIF
+ * - 2 JPG
+ * - 3 PNG
+ * - 15 WBMP
+ * - 16 XBM
+ */
+ function getType() {
+ $this->load();
return $this->type;
}
- function getEscapeLocalURL()
- {
+ /**
+ * Return the escapeLocalURL of this image
+ * @access public
+ */
+ function getEscapeLocalURL() {
+ $this->getTitle();
return $this->title->escapeLocalURL();
}
- function wfImageUrl( $name )
- {
- global $wgUploadPath;
- $hash = md5( $name );
+ /**
+ * Return the escapeFullURL of this image
+ * @access public
+ */
+ function getEscapeFullURL() {
+ $this->getTitle();
+ return $this->title->escapeFullURL();
+ }
- $url = "{$wgUploadPath}/" . $hash{0} . "/" .
- substr( $hash, 0, 2 ) . "/{$name}";
+ /**
+ * Return the URL of an image, provided its name.
+ *
+ * @param string $name Name of the image, without the leading "Image:"
+ * @param boolean $fromSharedDirectory Should this be in $wgSharedUploadPath?
+ * @access public
+ * @static
+ */
+ function imageUrl( $name, $fromSharedDirectory = false ) {
+ global $wgUploadPath,$wgUploadBaseUrl,$wgSharedUploadPath;
+ if($fromSharedDirectory) {
+ $base = '';
+ $path = $wgSharedUploadPath;
+ } else {
+ $base = $wgUploadBaseUrl;
+ $path = $wgUploadPath;
+ }
+ $url = "{$base}{$path}" . wfGetHashPath($name, $fromSharedDirectory) . "{$name}";
return wfUrlencode( $url );
}
-
- function exists()
- {
+ /**
+ * Returns true if the image file exists on disk.
+ *
+ * @access public
+ */
+ function exists() {
+ $this->load();
return $this->fileExists;
}
- function thumbUrl( $width, $subdir='thumb' ) {
- global $wgUploadPath;
-
- $name = $this->thumbName( $width );
- $hash = md5( $name );
- $url = "{$wgUploadPath}/{$subdir}/" . $hash{0} . "/" . substr( $hash, 0, 2 ) . "/{$name}";
-
- return wfUrlencode($url);
+ /**
+ *
+ * @access private
+ */
+ function thumbUrl( $width, $subdir='thumb') {
+ global $wgUploadPath, $wgUploadBaseUrl,
+ $wgSharedUploadPath,$wgSharedUploadDirectory,
+ $wgSharedThumbnailScriptPath, $wgThumbnailScriptPath;
+
+ // Generate thumb.php URL if possible
+ $script = false;
+ $url = false;
+
+ if ( $this->fromSharedDirectory ) {
+ if ( $wgSharedThumbnailScriptPath ) {
+ $script = $wgSharedThumbnailScriptPath;
+ }
+ } else {
+ if ( $wgThumbnailScriptPath ) {
+ $script = $wgThumbnailScriptPath;
+ }
+ }
+ if ( $script ) {
+ $url = $script . '?f=' . urlencode( $this->name ) . '&w=' . urlencode( $width );
+ } else {
+ $name = $this->thumbName( $width );
+ if($this->fromSharedDirectory) {
+ $base = '';
+ $path = $wgSharedUploadPath;
+ } else {
+ $base = $wgUploadBaseUrl;
+ $path = $wgUploadPath;
+ }
+ if ( Image::isHashed( $this->fromSharedDirectory ) ) {
+ $url = "{$base}{$path}/{$subdir}" .
+ wfGetHashPath($this->name, $this->fromSharedDirectory)
+ . $this->name.'/'.$name;
+ $url = wfUrlencode( $url );
+ } else {
+ $url = "{$base}{$path}/{$subdir}/{$name}";
+ }
+ }
+ return array( $script !== false, $url );
}
+ /**
+ * Return the file name of a thumbnail of the specified width
+ *
+ * @param integer $width Width of the thumbnail image
+ * @param boolean $shared Does the thumbnail come from the shared repository?
+ * @access private
+ */
function thumbName( $width ) {
- return $width."px-".$this->name;
+ $thumb = $width."px-".$this->name;
+ if( $this->extension == 'svg' ) {
+ # Rasterize SVG vector images to PNG
+ $thumb .= '.png';
+ }
+ return $thumb;
}
/**
- * Create a thumbnail of the image having the specified width.
+ * Create a thumbnail of the image having the specified width/height.
* The thumbnail will not be created if the width is larger than the
* image's width. Let the browser do the scaling in this case.
* The thumbnail is stored on disk and is only computed if the thumbnail
* file does not exist OR if it is older than the image.
* Returns the URL.
+ *
+ * Keeps aspect ratio of original image. If both width and height are
+ * specified, the generated image will be no bigger than width x height,
+ * and will also have correct aspect ratio.
+ *
+ * @param integer $width maximum width of the generated thumbnail
+ * @param integer $height maximum height of the image (optional)
+ * @access public
+ */
+ function createThumb( $width, $height=-1 ) {
+ $thumb = $this->getThumbnail( $width, $height );
+ if( is_null( $thumb ) ) return '';
+ return $thumb->getUrl();
+ }
+
+ /**
+ * As createThumb, but returns a ThumbnailImage object. This can
+ * provide access to the actual file, the real size of the thumb,
+ * and can produce a convenient <img> tag for you.
+ *
+ * @param integer $width maximum width of the generated thumbnail
+ * @param integer $height maximum height of the image (optional)
+ * @return ThumbnailImage
+ * @access public
+ */
+ function &getThumbnail( $width, $height=-1 ) {
+ if ( $height == -1 ) {
+ return $this->renderThumb( $width );
+ }
+ $this->load();
+ if ( $width < $this->width ) {
+ $thumbheight = $this->height * $width / $this->width;
+ $thumbwidth = $width;
+ } else {
+ $thumbheight = $this->height;
+ $thumbwidth = $this->width;
+ }
+ if ( $thumbheight > $height ) {
+ $thumbwidth = $thumbwidth * $height / $thumbheight;
+ $thumbheight = $height;
+ }
+ $thumb = $this->renderThumb( $thumbwidth );
+ if( is_null( $thumb ) ) {
+ $thumb = $this->iconThumb();
+ }
+ return $thumb;
+ }
+
+ /**
+ * @return ThumbnailImage
*/
- function createThumb( $width ) {
- global $wgUploadDirectory;
- global $wgImageMagickConvertCommand;
- global $wgUseImageMagick;
+ function iconThumb() {
+ global $wgStylePath, $wgStyleDirectory;
+
+ $try = array( 'fileicon-' . $this->extension . '.png', 'fileicon.png' );
+ foreach( $try as $icon ) {
+ $path = '/common/images/' . $icon;
+ $filepath = $wgStyleDirectory . $path;
+ if( file_exists( $filepath ) ) {
+ return new ThumbnailImage( $wgStylePath . $path, 120, 120 );
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Create a thumbnail of the image having the specified width.
+ * The thumbnail will not be created if the width is larger than the
+ * image's width. Let the browser do the scaling in this case.
+ * The thumbnail is stored on disk and is only computed if the thumbnail
+ * file does not exist OR if it is older than the image.
+ * Returns an object which can return the pathname, URL, and physical
+ * pixel size of the thumbnail -- or null on failure.
+ *
+ * @return ThumbnailImage
+ * @access private
+ */
+ function /* private */ renderThumb( $width, $useScript = true ) {
global $wgUseSquid, $wgInternalServer;
-
+ global $wgThumbnailScriptPath, $wgSharedThumbnailScriptPath;
+
$width = IntVal( $width );
- $thumbName = $this->thumbName( $width );
- $thumbPath = wfImageThumbDir( $thumbName ).'/'.$thumbName;
- $thumbUrl = $this->thumbUrl( $width );
-
+ $this->load();
if ( ! $this->exists() )
{
# If there is no image, there will be no thumbnail
- return '';
+ return null;
}
# Sanity check $width
if( $width <= 0 ) {
# BZZZT
- return '';
+ return null;
}
- if( $width > $this->width ) {
+ if( $width > $this->width && !$this->mustRender() ) {
# Don't make an image bigger than the source
- return $this->getURL();
+ return new ThumbnailImage( $this->getViewURL(), $this->getWidth(), $this->getHeight() );
+ }
+
+ $height = floor( $this->height * ( $width/$this->width ) );
+
+ list( $isScriptUrl, $url ) = $this->thumbUrl( $width );
+ if ( $isScriptUrl && $useScript ) {
+ // Use thumb.php to render the image
+ return new ThumbnailImage( $url, $width, $height );
}
- if ( (! file_exists( $thumbPath ) ) || ( filemtime($thumbPath) < filemtime($this->imagePath) ) ) {
- if ( $wgUseImageMagick ) {
- # use ImageMagick
- # Specify white background color, will be used for transparent images
- # in Internet Explorer/Windows instead of default black.
- $cmd = $wgImageMagickConvertCommand .
- " -quality 85 -background white -geometry {$width} ".
- escapeshellarg($this->imagePath) . " " .
- escapeshellarg($thumbPath);
- $conv = shell_exec( $cmd );
- } else {
- # Use PHP's builtin GD library functions.
- #
- # First find out what kind of file this is, and select the correct
- # input routine for this.
-
- $truecolor = false;
-
- switch( $this->type ) {
- case 1: # GIF
- $src_image = imagecreatefromgif( $this->imagePath );
- break;
- case 2: # JPG
- $src_image = imagecreatefromjpeg( $this->imagePath );
- $truecolor = true;
- break;
- case 3: # PNG
- $src_image = imagecreatefrompng( $this->imagePath );
- $truecolor = ( $this->bits > 8 );
- break;
- case 15: # WBMP for WML
- $src_image = imagecreatefromwbmp( $this->imagePath );
- break;
- case 16: # XBM
- $src_image = imagecreatefromxbm( $this->imagePath );
- break;
- default:
- return 'Image type not supported';
- break;
- }
- $height = floor( $this->height * ( $width/$this->width ) );
- if ( $truecolor ) {
- $dst_image = imagecreatetruecolor( $width, $height );
+ $thumbName = $this->thumbName( $width, $this->fromSharedDirectory );
+ $thumbPath = wfImageThumbDir( $this->name, $this->fromSharedDirectory ).'/'.$thumbName;
+
+ if ( !file_exists( $thumbPath ) ) {
+ $oldThumbPath = wfDeprecatedThumbDir( $thumbName, 'thumb', $this->fromSharedDirectory ).
+ '/'.$thumbName;
+ $done = false;
+ if ( file_exists( $oldThumbPath ) ) {
+ if ( filemtime($oldThumbPath) >= filemtime($this->imagePath) ) {
+ rename( $oldThumbPath, $thumbPath );
+ $done = true;
} else {
- $dst_image = imagecreate( $width, $height );
+ unlink( $oldThumbPath );
}
- imagecopyresampled( $dst_image, $src_image,
- 0,0,0,0,
- $width, $height, $this->width, $this->height );
- switch( $this->type ) {
- case 1: # GIF
- case 3: # PNG
- case 15: # WBMP
- case 16: # XBM
- #$thumbUrl .= ".png";
- #$thumbPath .= ".png";
- imagepng( $dst_image, $thumbPath );
- break;
- case 2: # JPEG
- #$thumbUrl .= ".jpg";
- #$thumbPath .= ".jpg";
- imageinterlace( $dst_image );
- imagejpeg( $dst_image, $thumbPath, 95 );
- break;
- default:
- break;
+ }
+ if ( !$done ) {
+ $this->reallyRenderThumb( $thumbPath, $width, $height );
+
+ # Purge squid
+ # This has to be done after the image is updated and present for all machines on NFS,
+ # or else the old version might be stored into the squid again
+ if ( $wgUseSquid ) {
+ if ( substr( $url, 0, 4 ) == 'http' ) {
+ $urlArr = array( $url );
+ } else {
+ $urlArr = array( $wgInternalServer.$url );
+ }
+ wfPurgeSquidServers($urlArr);
}
- imagedestroy( $dst_image );
- imagedestroy( $src_image );
-
+ }
+ }
+ return new ThumbnailImage( $url, $width, $height, $thumbPath );
+ } // END OF function renderThumb
+ /**
+ * Really render a thumbnail
+ *
+ * @access private
+ */
+ function /*private*/ reallyRenderThumb( $thumbPath, $width, $height ) {
+ global $wgSVGConverters, $wgSVGConverter,
+ $wgUseImageMagick, $wgImageMagickConvertCommand;
+
+ $this->load();
+
+ if( $this->extension == 'svg' ) {
+ global $wgSVGConverters, $wgSVGConverter;
+ if( isset( $wgSVGConverters[$wgSVGConverter] ) ) {
+ global $wgSVGConverterPath;
+ $cmd = str_replace(
+ array( '$path/', '$width', '$input', '$output' ),
+ array( $wgSVGConverterPath,
+ $width,
+ escapeshellarg( $this->imagePath ),
+ escapeshellarg( $thumbPath ) ),
+ $wgSVGConverters[$wgSVGConverter] );
+ $conv = shell_exec( $cmd );
+ } else {
+ $conv = false;
}
+ } elseif ( $wgUseImageMagick ) {
+ # use ImageMagick
+ # Specify white background color, will be used for transparent images
+ # in Internet Explorer/Windows instead of default black.
+ $cmd = $wgImageMagickConvertCommand .
+ " -quality 85 -background white -geometry {$width} ".
+ escapeshellarg($this->imagePath) . " " .
+ escapeshellarg($thumbPath);
+ $conv = shell_exec( $cmd );
+ } else {
+ # Use PHP's builtin GD library functions.
#
- # Check for zero-sized thumbnails. Those can be generated when
- # no disk space is available or some other error occurs
- #
+ # First find out what kind of file this is, and select the correct
+ # input routine for this.
+
+ $truecolor = false;
+
+ switch( $this->type ) {
+ case 1: # GIF
+ $src_image = imagecreatefromgif( $this->imagePath );
+ break;
+ case 2: # JPG
+ $src_image = imagecreatefromjpeg( $this->imagePath );
+ $truecolor = true;
+ break;
+ case 3: # PNG
+ $src_image = imagecreatefrompng( $this->imagePath );
+ $truecolor = ( $this->bits > 8 );
+ break;
+ case 15: # WBMP for WML
+ $src_image = imagecreatefromwbmp( $this->imagePath );
+ break;
+ case 16: # XBM
+ $src_image = imagecreatefromxbm( $this->imagePath );
+ break;
+ default:
+ return 'Image type not supported';
+ break;
+ }
+ if ( $truecolor ) {
+ $dst_image = imagecreatetruecolor( $width, $height );
+ } else {
+ $dst_image = imagecreate( $width, $height );
+ }
+ imagecopyresampled( $dst_image, $src_image,
+ 0,0,0,0,
+ $width, $height, $this->width, $this->height );
+ switch( $this->type ) {
+ case 1: # GIF
+ case 3: # PNG
+ case 15: # WBMP
+ case 16: # XBM
+ imagepng( $dst_image, $thumbPath );
+ break;
+ case 2: # JPEG
+ imageinterlace( $dst_image );
+ imagejpeg( $dst_image, $thumbPath, 95 );
+ break;
+ default:
+ break;
+ }
+ imagedestroy( $dst_image );
+ imagedestroy( $src_image );
+ }
+ #
+ # Check for zero-sized thumbnails. Those can be generated when
+ # no disk space is available or some other error occurs
+ #
+ if( file_exists( $thumbPath ) ) {
$thumbstat = stat( $thumbPath );
- if( $thumbstat['size'] == 0 )
- {
+ if( $thumbstat['size'] == 0 ) {
unlink( $thumbPath );
}
+ }
+ }
- # Purge squid
- # This has to be done after the image is updated and present for all machines on NFS,
- # or else the old version might be stored into the squid again
- if ( $wgUseSquid ) {
- $urlArr = Array(
- $wgInternalServer.$thumbUrl
- );
- wfPurgeSquidServers($urlArr);
+ /**
+ * Get all thumbnail names previously generated for this image
+ */
+ function getThumbnails( $shared = false ) {
+ if ( Image::isHashed( $shared ) ) {
+ $this->load();
+ $files = array();
+ $dir = wfImageThumbDir( $this->name, $shared );
+
+ // This generates an error on failure, hence the @
+ $handle = @opendir( $dir );
+
+ if ( $handle ) {
+ while ( false !== ( $file = readdir($handle) ) ) {
+ if ( $file{0} != '.' ) {
+ $files[] = $file;
+ }
+ }
+ closedir( $handle );
+ }
+ } else {
+ $files = array();
+ }
+
+ return $files;
+ }
+
+ /**
+ * Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid
+ */
+ function purgeCache( $archiveFiles = array(), $shared = false ) {
+ global $wgInternalServer, $wgUseSquid;
+
+ // Refresh metadata cache
+ clearstatcache();
+ $this->loadFromFile();
+ $this->saveToCache();
+
+ // Delete thumbnails
+ $files = $this->getThumbnails( $shared );
+ $dir = wfImageThumbDir( $this->name, $shared );
+ $urls = array();
+ foreach ( $files as $file ) {
+ if ( preg_match( '/^(\d+)px/', $file, $m ) ) {
+ $urls[] = $wgInternalServer . $this->thumbUrl( $m[1], $this->fromSharedDirectory );
+ @unlink( "$dir/$file" );
+ }
+ }
+
+ // Purge the squid
+ if ( $wgUseSquid ) {
+ $urls[] = $wgInternalServer . $this->getViewURL();
+ foreach ( $archiveFiles as $file ) {
+ $urls[] = $wgInternalServer . wfImageArchiveUrl( $file );
}
+ wfPurgeSquidServers( $urls );
}
- return $thumbUrl;
- } // END OF function createThumb
+ }
/**
* Return the image history of this image, line by line.
* 0 return line for current version
* 1 query for old versions, return first one
* 2, ... return next old version from above query
+ *
+ * @access public
*/
- function nextHistoryLine()
- {
+ function nextHistoryLine() {
$fname = 'Image::nextHistoryLine()';
$dbr =& wfGetDB( DB_SLAVE );
if ( $this->historyLine == 0 ) {// called for the first time, return line from cur
return $dbr->fetchObject( $this->historyRes );
}
- function resetHistory()
- {
+ /**
+ * Reset the history pointer to the first element of the history
+ * @access public
+ */
+ function resetHistory() {
$this->historyLine = 0;
}
+ /**
+ * Return true if the file is of a type that can't be directly
+ * rendered by typical browsers and needs to be re-rasterized.
+ * @return bool
+ */
+ function mustRender() {
+ $this->load();
+ return ( $this->extension == 'svg' );
+ }
+
+ /**
+ * Return the full filesystem path to the file. Note that this does
+ * not mean that a file actually exists under that location.
+ *
+ * This path depends on whether directory hashing is active or not,
+ * i.e. whether the images are all found in the same directory,
+ * or in hashed paths like /images/3/3c.
+ *
+ * @access public
+ * @param boolean $fromSharedDirectory Return the path to the file
+ * in a shared repository (see $wgUseSharedRepository and related
+ * options in DefaultSettings.php) instead of a local one.
+ *
+ */
+ function getFullPath( $fromSharedRepository = false ) {
+ global $wgUploadDirectory, $wgSharedUploadDirectory;
+ global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
+
+ $dir = $fromSharedRepository ? $wgSharedUploadDirectory :
+ $wgUploadDirectory;
+
+ // $wgSharedUploadDirectory may be false, if thumb.php is used
+ if ( $dir ) {
+ $fullpath = $dir . wfGetHashPath($this->name, $fromSharedRepository) . $this->name;
+ } else {
+ $fullpath = false;
+ }
+
+ return $fullpath;
+ }
+
+ /**
+ * @return bool
+ * @static
+ */
+ function isHashed( $shared ) {
+ global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
+ return $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
+ }
+
+ /**
+ * @return bool
+ * @static
+ */
+ function isKnownImageExtension( $ext ) {
+ static $extensions = array( 'svg', 'png', 'jpg', 'jpeg', 'gif', 'bmp', 'xbm' );
+ return in_array( $ext, $extensions );
+ }
+
+ /**
+ * Record an image upload in the upload log and the image table
+ */
+ function recordUpload( $oldver, $desc, $copyStatus = '', $source = '' ) {
+ global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
+ global $wgUseCopyrightUpload, $wgUseSquid, $wgPostCommitUpdateList;
+
+ $fname = 'Image::recordUpload';
+ $dbw =& wfGetDB( DB_MASTER );
+
+ # img_name must be unique
+ if ( !$dbw->indexUnique( 'image', 'img_name' ) && !$dbw->indexExists('image','PRIMARY') ) {
+ wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
+ }
+
+ // Delete thumbnails and refresh the metadata cache
+ $this->purgeCache();
+
+ // Fail now if the image isn't there
+ if ( !$this->fileExists || $this->fromSharedDirectory ) {
+ return false;
+ }
+
+ if ( $wgUseCopyrightUpload ) {
+ $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
+ '== ' . wfMsg ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
+ '== ' . wfMsg ( 'filesource' ) . " ==\n" . $source ;
+ } else {
+ $textdesc = $desc;
+ }
+
+ $now = $dbw->timestamp();
+
+ # Test to see if the row exists using INSERT IGNORE
+ # This avoids race conditions by locking the row until the commit, and also
+ # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
+ $dbw->insert( 'image',
+ array(
+ 'img_name' => $this->name,
+ 'img_size'=> $this->size,
+ 'img_width' => $this->width,
+ 'img_height' => $this->height,
+ 'img_bits' => $this->bits,
+ 'img_type' => $this->type,
+ 'img_timestamp' => $now,
+ 'img_description' => $desc,
+ 'img_user' => $wgUser->getID(),
+ 'img_user_text' => $wgUser->getName(),
+ 'img_metadata' => $this->exif,
+ ), $fname, 'IGNORE'
+ );
+ $descTitle = $this->getTitle();
+ $purgeURLs = array();
+
+ if ( $dbw->affectedRows() ) {
+ # Successfully inserted, this is a new image
+ $id = $descTitle->getArticleID();
+
+ if ( $id == 0 ) {
+ $article = new Article( $descTitle );
+ $article->insertNewArticle( $textdesc, $desc, false, false, true );
+ }
+ } else {
+ # Collision, this is an update of an image
+ # Insert previous contents into oldimage
+ $dbw->insertSelect( 'oldimage', 'image',
+ array(
+ 'oi_name' => 'img_name',
+ 'oi_archive_name' => $dbw->addQuotes( $oldver ),
+ 'oi_size' => 'img_size',
+ 'oi_width' => 'img_width',
+ 'oi_height' => 'img_height',
+ 'oi_bits' => 'img_bits',
+ 'oi_type' => 'img_type',
+ 'oi_timestamp' => 'img_timestamp',
+ 'oi_description' => 'img_description',
+ 'oi_user' => 'img_user',
+ 'oi_user_text' => 'img_user_text',
+ ), array( 'img_name' => $this->name ), $fname
+ );
+
+ # Update the current image row
+ $dbw->update( 'image',
+ array( /* SET */
+ 'img_size' => $this->size,
+ 'img_width' => $this->width,
+ 'img_height' => $this->height,
+ 'img_bits' => $this->bits,
+ 'img_type' => $this->type,
+ 'img_timestamp' => $now,
+ 'img_user' => $wgUser->getID(),
+ 'img_user_text' => $wgUser->getName(),
+ 'img_description' => $desc,
+ 'img_metadata' => $this->exif,
+ ), array( /* WHERE */
+ 'img_name' => $this->name
+ ), $fname
+ );
+
+ # Invalidate the cache for the description page
+ $descTitle->invalidateCache();
+ $purgeURLs[] = $descTitle->getInternalURL();
+ }
+
+ # Invalidate cache for all pages using this image
+ $linksTo = $this->getLinksTo();
+
+ if ( $wgUseSquid ) {
+ $u = SquidUpdate::newFromTitles( $linksTo, $purgeURLs );
+ array_push( $wgPostCommitUpdateList, $u );
+ }
+ Title::touchArray( $linksTo );
+
+ $log = new LogPage( 'upload' );
+ $log->addEntry( 'upload', $descTitle, $desc );
+
+ return true;
+ }
+
+ /**
+ * Get an array of Title objects which are articles which use this image
+ * Also adds their IDs to the link cache
+ *
+ * This is mostly copied from Title::getLinksTo()
+ */
+ function getLinksTo( $options = '' ) {
+ global $wgLinkCache;
+ $fname = 'Image::getLinksTo';
+ wfProfileIn( $fname );
+
+ if ( $options ) {
+ $db =& wfGetDB( DB_MASTER );
+ } else {
+ $db =& wfGetDB( DB_SLAVE );
+ }
+
+ extract( $db->tableNames( 'page', 'imagelinks' ) );
+ $encName = $db->addQuotes( $this->name );
+ $sql = "SELECT page_namespace,page_title,page_id FROM $page,$imagelinks WHERE page_id=il_from AND il_to=$encName $options";
+ $res = $db->query( $sql, $fname );
+
+ $retVal = array();
+ if ( $db->numRows( $res ) ) {
+ while ( $row = $db->fetchObject( $res ) ) {
+ if ( $titleObj = Title::makeTitle( $row->page_namespace, $row->page_title ) ) {
+ $wgLinkCache->addGoodLink( $row->page_id, $titleObj->getPrefixedDBkey() );
+ $retVal[] = $titleObj;
+ }
+ }
+ }
+ $db->freeResult( $res );
+ return $retVal;
+ }
+
+ function retrieveExifData () {
+ global $wgShowEXIF ;
+ if ( ! $wgShowEXIF ) return array ();
+ if ( $this->type !== '2' ) return array ();
+
+ $exif = exif_read_data( $this->imagePath );
+ $exif = $this->stripExifData( $exif );
+ return $exif ;
+ }
+
+ function getExifData () {
+ global $wgRequest, $wgShowEXIF;
+
+ if ( ! $wgShowEXIF ) return array ();
+
+ $action = $wgRequest->getVal( 'action' ); # Allow forced updates
+
+ $ret = unserialize ( $this->exif );
+
+ if ( count( $ret) == 0 || $action == 'purge' ) { # No EXIF data was stored for this image
+ $this->updateExifData() ;
+ $ret = unserialize ( $this->exif ) ;
+ }
+
+ return $ret ;
+ }
+
+ function updateExifData () {
+ global $wgShowEXIF ;
+ if ( ! $wgShowEXIF ) return ;
+ if ( false === $this->getImagePath() ) return ; # Not a local image
+
+ $fname = "Image:updateExifData" ;
+
+ # Get EXIF data from image
+ $exif = $this->retrieveExifData () ;
+ $this->exif = serialize ( $exif ) ;
+
+ # Update EXIF data in database
+ $dbw =& wfGetDB( DB_MASTER );
+ $dbw->update( 'image',
+ array( 'img_metadata' => $this->exif ),
+ array( 'img_name' => $this->name ),
+ $fname
+ );
+ }
+
+ /**
+ * Strip out potentially nasty exif data such as raw binaries
+ * (thumbnails), these values are from version 2.2 of the EXIF
+ * specification, note that I've commented some of them out, this is
+ * because their Type is "UNDEFINED", meaning that they potentially
+ * contain binary data.
+ *
+ * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
+ * @link http://exif.org/specifications.html
+ * @link http://exif.org/Exif2-2.PDF (see page 22 and 30)
+ *
+ * @param array $exif
+ * @return array
+ */
+ function stripExifData( $exif = array() ) {
+ $whitelist = array(
+ # Other tags
+ 'Make', # Image input equipment manufacturer
+ 'Model', # Image input equipment model
+ 'Software', # Software used
+ 'Artist', # Person who created the image
+ 'Copyright', # Copyright holder
+
+ # Tags relating to image structure
+ 'ImageWidth', # Image width
+ 'ImageLength', # Image height
+ 'Orientation', # Orientation of image
+ 'SamplesPerPixel', # Number of components
+ 'PlanarConfiguration', # Image data arrangement
+ 'YCbCrSubSampling', # Subsampling ratio of Y to C
+ 'YCbCrPositioning', # Y and C positioning
+ 'XResolution', # Image resolution in width direction
+ 'YResolution', # Image resolution in height direction
+ 'ResolutionUnit', # Unit of X and Y resolution
+
+ # Tags relating to recording offset
+ 'StripOffsets', # Image data location
+ 'RowsPerStrip', # Number of rows per strip
+ 'StripByteCounts', # Bytes per compressed strip
+ 'JPEGInterchangeFormat', # Offset to JPEG SOI
+ 'JPEGInterchangeFormatLength', # Bytes of JPEG data
+
+ # Tags relating to image data characteristics
+ 'TransferFunction', # Transfer function
+ 'WhitePoint', # White point chromaticity
+ 'PrimaryChromaticities', # Chromaticities of primarities
+ 'YCbCrCoefficients', # Color space transformation matrix coefficients
+ 'ReferenceBlackWhite', # Pair of black and white reference values
+
+ # Tags relating to version
+ #'ExifVersion', # Exif version
+ #'FlashpixVersion', # Supported Flashpix version
+
+ # Tags relating to Image Data Characteristics
+ 'ColorSpace', # Color space information
+ #'ComponentsConfiguration', # Meaning of each component
+ 'CompressedBitsPerPixel', # Image compression mode
+ 'PixelYDimension', # Valid image width
+ 'PixelXDimension', # Valind image height
+
+ # Tags relating to User Information
+ #'MakerNote', # Manufacturer notes
+ #'UserComment', # User commentss
+
+ # Tag relating to related file information
+ #'RelatedSoundFile', # Related audio file
+
+ # Other tags
+ 'ImageUniqueID', # Unique image ID
+
+ # Tags relating to picture-taking conditions
+ 'ExposureTime', # Exposure time
+ 'FNumber', # F Number
+ 'ExposureProgram', # Exposure Program
+ 'SpectralSensitivity', # Spectral sensitivity
+ 'ISOSpeedRatings', # ISO speed rating
+ #'OECF', # Optoelectronic conversion factor
+ 'ShutterSpeedValue', # Shutter speed
+ 'ApertureValue', # Aperture
+ 'BrightnessValue', # Brightness
+ 'ExposureBiasValue', # Exposure bias
+ 'MaxApertureValue', # Maximum land aperture
+ 'SubjectDistance', # Subject distance
+ 'MeteringMode', # Metering mode
+ 'LightSource', # Light source
+ 'Flash', # Flash
+ 'FocalLength', # Lens focal length
+ 'SubjectArea', # Subject area
+ 'FlashEnergy', # Flash energy
+ #'SpartialFrequencyResponse', # Spartial frequency response
+ 'FocalPlaneXRessolution', # Focal plane X resolution
+ 'FocalPlaneYRessolution', # Focal plane Y resolution
+ 'FocalPlaneResolutionUnit', # Focal plane resolution unit
+ 'SubjectLocation', # Subject location
+ 'ExposureIndex', # Exposure index
+ 'SensingMethod', # Sensing method
+ #'FileSource', # File source
+ #'SceneType', # Scene type
+ #'CFAPattern', # CFA pattern
+ 'CustomRendered', # Custom image processing
+ 'ExposureMode', # Exposure mode
+ 'WhiteBalance', # White Balance
+ 'DigitalZoomRatio', # Digital zoom ration
+ 'FocalLengthIn35mmFilm', # Focal length in 35 mm film
+ 'SceneCaptureType', # Scene capture type
+ 'GainControl', # Scene control
+ 'Contrast', # Contrast
+ 'Saturation', # Saturation
+ 'Sharpness', # Sharpness
+ #'DeviceSettingDescription', # Desice settings description
+ 'SubjectDistanceRange', # Subject distance range
+
+ # TODO: GPS attribute information on page 52 of the spec
+ );
+
+ $new = array();
+ foreach ($whitelist as $tag) {
+ if ( array_key_exists($tag, $exif) ) {
+ $new[$tag] = $exif[$tag];
+ }
+ }
+ unset($exif);
+ return $new;
+ }
+
} //class
-function wfImageDir( $fname )
-{
- global $wgUploadDirectory;
+/**
+ * Returns the image directory of an image
+ * If the directory does not exist, it is created.
+ * The result is an absolute path.
+ *
+ * This function is called from thumb.php before Setup.php is included
+ *
+ * @param string $fname file name of the image file
+ * @access public
+ */
+function wfImageDir( $fname ) {
+ global $wgUploadDirectory, $wgHashedUploadDirectory;
+
+ if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
$hash = md5( $fname );
$oldumask = umask(0);
return $dest;
}
-function wfImageThumbDir( $fname , $subdir='thumb')
-{
- return wfImageArchiveDir( $fname, $subdir );
+/**
+ * Returns the image directory of an image's thubnail
+ * If the directory does not exist, it is created.
+ * The result is an absolute path.
+ *
+ * This function is called from thumb.php before Setup.php is included
+ *
+ * @param string $fname file name of the original image file
+ * @param string $subdir (optional) subdirectory of the image upload directory that should be used for storing the thumbnail. Default is 'thumb'
+ * @param boolean $shared (optional) use the shared upload directory
+ * @access public
+ */
+function wfImageThumbDir( $fname, $shared = false ) {
+ $base = wfImageArchiveDir( $fname, 'thumb', $shared );
+ if ( Image::isHashed( $shared ) ) {
+ $dir = "$base/$fname";
+
+ if ( !is_dir( $base ) ) {
+ $oldumask = umask(0);
+ @mkdir( $base, 0777 );
+ umask( $oldumask );
+ }
+
+ if ( ! is_dir( $dir ) ) {
+ $oldumask = umask(0);
+ @mkdir( $dir, 0777 );
+ umask( $oldumask );
+ }
+ } else {
+ $dir = $base;
+ }
+
+ return $dir;
}
-function wfImageArchiveDir( $fname , $subdir='archive')
-{
- global $wgUploadDirectory;
+/**
+ * Old thumbnail directory, kept for conversion
+ */
+function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
+ return wfImageArchiveDir( $thumbName, $subdir, $shared );
+}
+/**
+ * Returns the image directory of an image's old version
+ * If the directory does not exist, it is created.
+ * The result is an absolute path.
+ *
+ * This function is called from thumb.php before Setup.php is included
+ *
+ * @param string $fname file name of the thumbnail file, including file size prefix
+ * @param string $subdir (optional) subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'
+ * @param boolean $shared (optional) use the shared upload directory (only relevant for other functions which call this one)
+ * @access public
+ */
+function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
+ global $wgUploadDirectory, $wgHashedUploadDirectory,
+ $wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
+ $dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
+ $hashdir = $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
+ if (!$hashdir) { return $dir.'/'.$subdir; }
$hash = md5( $fname );
$oldumask = umask(0);
-
+
# Suppress warning messages here; if the file itself can't
# be written we'll worry about it then.
- $archive = $wgUploadDirectory.'/'.$subdir;
- if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
+ wfSuppressWarnings();
+
+ $archive = $dir.'/'.$subdir;
+ if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
$archive .= '/' . $hash{0};
- if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
+ if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
$archive .= '/' . substr( $hash, 0, 2 );
- if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
+ if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
+ wfRestoreWarnings();
umask( $oldumask );
return $archive;
}
-function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
-{
- global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
- global $wgUseCopyrightUpload;
-
- $fname = 'wfRecordUpload';
- $dbw =& wfGetDB( DB_MASTER );
-
- # img_name must be unique
- if ( !$dbw->indexUnique( 'image', 'img_name' ) ) {
- wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
- }
-
-
- $now = wfTimestampNow();
- $won = wfInvertTimestamp( $now );
- $size = IntVal( $size );
-
- if ( $wgUseCopyrightUpload )
- {
- $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
- '== ' . wfMsg ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
- '== ' . wfMsg ( 'filesource' ) . " ==\n" . $source ;
- }
- else $textdesc = $desc ;
-
- $now = wfTimestampNow();
- $won = wfInvertTimestamp( $now );
-
- # Test to see if the row exists using INSERT IGNORE
- # This avoids race conditions by locking the row until the commit, and also
- # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
- $dbw->insertArray( 'image',
- array(
- 'img_name' => $name,
- 'img_size'=> $size,
- 'img_timestamp' => $dbw->timestamp($now),
- 'img_description' => $desc,
- 'img_user' => $wgUser->getID(),
- 'img_user_text' => $wgUser->getName(),
- ), $fname, 'IGNORE'
- );
- $descTitle = Title::makeTitleSafe( NS_IMAGE, $name );
-
- if ( $dbw->affectedRows() ) {
- # Successfully inserted, this is a new image
- $id = $descTitle->getArticleID();
-
- if ( $id == 0 ) {
- $seqVal = $dbw->nextSequenceValue( 'cur_cur_id_seq' );
- $dbw->insertArray( 'cur',
- array(
- 'cur_id' => $seqVal,
- 'cur_namespace' => NS_IMAGE,
- 'cur_title' => $name,
- 'cur_comment' => $desc,
- 'cur_user' => $wgUser->getID(),
- 'cur_user_text' => $wgUser->getName(),
- 'cur_timestamp' => $dbw->timestamp($now),
- 'cur_is_new' => 1,
- 'cur_text' => $textdesc,
- 'inverse_timestamp' => $won,
- 'cur_touched' => $dbw->timestamp($now)
- ), $fname
- );
- $id = $dbw->insertId() or 0; # We should throw an error instead
- RecentChange::notifyNew( $now, $descTitle, 0, $wgUser, $desc );
+/*
+ * Return the hash path component of an image path (URL or filesystem),
+ * e.g. "/3/3c/", or just "/" if hashing is not used.
+ *
+ * @param $dbkey The filesystem / database name of the file
+ * @param $fromSharedDirectory Use the shared file repository? It may
+ * use different hash settings from the local one.
+ */
+function wfGetHashPath ( $dbkey, $fromSharedDirectory = false ) {
+ global $wgHashedSharedUploadDirectory, $wgSharedUploadDirectory;
+ global $wgHashedUploadDirectory;
+
+ if( Image::isHashed( $fromSharedDirectory ) ) {
+ $hash = md5($dbkey);
+ return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
+ } else {
+ return '/';
+ }
+}
- $u = new SearchUpdate( $id, $name, $desc );
- $u->doUpdate();
- }
+/**
+ * Returns the image URL of an image's old version
+ *
+ * @param string $fname file name of the image file
+ * @param string $subdir (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
+ * @access public
+ */
+function wfImageArchiveUrl( $name, $subdir='archive' ) {
+ global $wgUploadPath, $wgHashedUploadDirectory;
+
+ if ($wgHashedUploadDirectory) {
+ $hash = md5( substr( $name, 15) );
+ $url = $wgUploadPath.'/'.$subdir.'/' . $hash{0} . '/' .
+ substr( $hash, 0, 2 ) . '/'.$name;
} else {
- # Collision, this is an update of an image
- # Get current image row for update
- $s = $dbw->getArray( 'image', array( 'img_name','img_size','img_timestamp','img_description',
- 'img_user','img_user_text' ), array( 'img_name' => $name ), $fname, 'FOR UPDATE' );
+ $url = $wgUploadPath.'/'.$subdir.'/'.$name;
+ }
+ return wfUrlencode($url);
+}
- # Insert it into oldimage
- $dbw->insertArray( 'oldimage',
- array(
- 'oi_name' => $s->img_name,
- 'oi_archive_name' => $oldver,
- 'oi_size' => $s->img_size,
- 'oi_timestamp' => $dbw->timestamp($s->img_timestamp),
- 'oi_description' => $s->img_description,
- 'oi_user' => $s->img_user,
- 'oi_user_text' => $s->img_user_text
- ), $fname
+/**
+ * Return a rounded pixel equivalent for a labeled CSS/SVG length.
+ * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
+ *
+ * @param string $length
+ * @return int Length in pixels
+ */
+function wfScaleSVGUnit( $length ) {
+ static $unitLength = array(
+ 'px' => 1.0,
+ 'pt' => 1.25,
+ 'pc' => 15.0,
+ 'mm' => 3.543307,
+ 'cm' => 35.43307,
+ 'in' => 90.0,
+ '' => 1.0, // "User units" pixels by default
+ '%' => 2.0, // Fake it!
);
+ if( preg_match( '/^(\d+)(em|ex|px|pt|pc|cm|mm|in|%|)$/', $length, $matches ) ) {
+ $length = FloatVal( $matches[1] );
+ $unit = $matches[2];
+ return round( $length * $unitLength[$unit] );
+ } else {
+ // Assume pixels
+ return round( FloatVal( $length ) );
+ }
+}
- # Update the current image row
- $dbw->updateArray( 'image',
- array( /* SET */
- 'img_size' => $size,
- 'img_timestamp' => $dbw->timestamp(),
- 'img_user' => $wgUser->getID(),
- 'img_user_text' => $wgUser->getName(),
- 'img_description' => $desc,
- ), array( /* WHERE */
- 'img_name' => $name
- ), $fname
- );
+/**
+ * Compatible with PHP getimagesize()
+ * @todo support gzipped SVGZ
+ * @todo check XML more carefully
+ * @todo sensible defaults
+ *
+ * @param string $filename
+ * @return array
+ */
+function wfGetSVGsize( $filename ) {
+ $width = 256;
+ $height = 256;
+
+ // Read a chunk of the file
+ $f = fopen( $filename, "rt" );
+ if( !$f ) return false;
+ $chunk = fread( $f, 4096 );
+ fclose( $f );
+
+ // Uber-crappy hack! Run through a real XML parser.
+ if( !preg_match( '/<svg\s*([^>]*)\s*>/s', $chunk, $matches ) ) {
+ return false;
+ }
+ $tag = $matches[1];
+ if( preg_match( '/\bwidth\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
+ $width = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
+ }
+ if( preg_match( '/\bheight\s*=\s*("[^"]+"|\'[^\']+\')/s', $tag, $matches ) ) {
+ $height = wfScaleSVGUnit( trim( substr( $matches[1], 1, -1 ) ) );
+ }
+
+ return array( $width, $height, 'SVG',
+ "width=\"$width\" height=\"$height\"" );
+}
- # Invalidate the cache for the description page
- $descTitle->invalidateCache();
+/**
+ * Determine if an image exists on the 'bad image list'
+ *
+ * @param string $name The image to check
+ * @return bool
+ */
+function wfIsBadImage( $name ) {
+ global $wgContLang;
+ static $titleList = false;
+ if ( $titleList === false ) {
+ $titleList = array();
+
+ $lines = explode("\n", wfMsgForContent( 'bad_image_list' ));
+ foreach ( $lines as $line ) {
+ if ( preg_match( '/^\*\s*\[{2}:(' . $wgContLang->getNsText( NS_IMAGE ) . ':.*?)\]{2}/', $line, $m ) ) {
+ $t = Title::newFromText( $m[1] );
+ $titleList[$t->getDBkey()] = 1;
+ }
+ }
}
- $log = new LogPage( 'upload' );
- $log->addEntry( 'upload', $descTitle, $desc );
+ return array_key_exists( $name, $titleList );
}
+
-function wfImageArchiveUrl( $name )
-{
- global $wgUploadPath;
- $hash = md5( substr( $name, 15) );
- $url = $wgUploadPath.'/archive/' . $hash{0} . '/' .
- substr( $hash, 0, 2 ) . '/'.$name;
- return wfUrlencode($url);
-}
+/**
+ * Wrapper class for thumbnail images
+ * @package MediaWiki
+ */
+class ThumbnailImage {
+ /**
+ * @param string $path Filesystem path to the thumb
+ * @param string $url URL path to the thumb
+ * @access private
+ */
+ function ThumbnailImage( $url, $width, $height, $path = false ) {
+ $this->url = $url;
+ $this->width = $width;
+ $this->height = $height;
+ $this->path = $path;
+ }
+
+ /**
+ * @return string The thumbnail URL
+ */
+ function getUrl() {
+ return $this->url;
+ }
+
+ /**
+ * Return HTML <img ... /> tag for the thumbnail, will include
+ * width and height attributes and a blank alt text (as required).
+ *
+ * You can set or override additional attributes by passing an
+ * associative array of name => data pairs. The data will be escaped
+ * for HTML output, so should be in plaintext.
+ *
+ * @param array $attribs
+ * @return string
+ * @access public
+ */
+ function toHtml( $attribs = array() ) {
+ $attribs['src'] = $this->url;
+ $attribs['width'] = $this->width;
+ $attribs['height'] = $this->height;
+ if( !isset( $attribs['alt'] ) ) $attribs['alt'] = '';
+
+ $html = '<img ';
+ foreach( $attribs as $name => $data ) {
+ $html .= $name . '="' . htmlspecialchars( $data ) . '" ';
+ }
+ $html .= '/>';
+ return $html;
+ }
+}
?>
dépôts / lhc / web / wiklou.git / blobdiff