<?php
/**
* @package MediaWiki
- * $Id$
*/
/**
* Create an Image object from an image name
*
* @param string $name name of the image, used to create a title object using Title::makeTitleSafe
+ * @param bool $recache if true, ignores anything in memcached and sets the updated metadata
* @access public
*/
- function Image( $name )
- {
- global $wgUploadDirectory,$wgHashedUploadDirectory,
- $wgUseSharedUploads, $wgSharedUploadDirectory,
- $wgHashedSharedUploadDirectory,$wgUseLatin1,
- $wgSharedLatin1,$wgLang;
+ function Image( $name, $recache = false ) {
+
+ global $wgUseSharedUploads, $wgUseLatin1, $wgSharedLatin1, $wgLang, $wgMemc, $wgDBname;
$this->name = $name;
$this->title = Title::makeTitleSafe( NS_IMAGE, $this->name );
- $this->fromSharedDirectory = false;
- if ($wgHashedUploadDirectory) {
- $hash = md5( $this->title->getDBkey() );
- $this->imagePath = $wgUploadDirectory . '/' . $hash{0} . '/' .
- substr( $hash, 0, 2 ) . "/{$name}";
- } else {
- $this->imagePath = $wgUploadDirectory . '/' . $name;
- }
- $this->fileExists = file_exists( $this->imagePath);
+ $this->fromSharedDirectory = false;
+ $this->imagePath = $this->getFullPath();
+
+ $n = strrpos( $name, '.' );
+ $this->extension = strtolower( $n ? substr( $name, $n + 1 ) : '' );
+ $gis = false;
+ $hashedName = md5($this->name);
+ $cacheKey = "$wgDBname:Image:".$hashedName;
+ $foundCached = false;
- # If the file is not found, and a shared upload directory
- # like the Wikimedia Commons is used, look for it there.
- if (!$this->fileExists && $wgUseSharedUploads) {
- # in case we're running a capitallinks=false wiki
- $sharedname=$wgLang->ucfirst($name);
- $sharedtitle=$wgLang->ucfirst($this->title->getDBkey());
- if($wgUseLatin1 && !$wgSharedLatin1) {
- $sharedname=utf8_encode($sharedname);
- $sharedtitle=utf8_encode($sharedtitle);
+ if ( !$recache ) {
+ $cachedValues = $wgMemc->get( $cacheKey );
+
+ if (!empty($cachedValues) && is_array($cachedValues)) {
+ if ($wgUseSharedUploads && $cachedValues['fromShared']) {
+ # if this is shared file, we need to check if image
+ # in shared repository has not changed
+ $commonsCachedValues = $wgMemc->get( "$wgSharedUploadDBname:Image:".$hashedName );
+ if (!empty($commonsCachedValues) && is_array($commonsCachedValues)) {
+ $this->name = $commonsCachedValues['name'];
+ $this->imagePath = $commonsCachedValues['imagePath'];
+ $this->fileExists = $commonsCachedValues['fileExists'];
+ $this->fromSharedDirectory = true;
+ $gis = $commonsCachedValues['gis'];
+ $foundCached = true;
+ }
+ }
+ else {
+ $this->name = $cachedValues['name'];
+ $this->imagePath = $cachedValues['imagePath'];
+ $this->fileExists = $cachedValues['fileExists'];
+ $this->fromSharedDirectory = false;
+ $gis = $cachedValues['gis'];
+ $foundCached = true;
+ }
}
-
- if($wgHashedSharedUploadDirectory) {
- $hash = md5( $sharedtitle );
- $this->imagePath = $wgSharedUploadDirectory . '/' . $hash{0} . '/' .
- substr( $hash, 0, 2 ) . "/".$sharedname;
- } else {
- $this->imagePath = $wgSharedUploadDirectory . '/' . $sharedname;
- }
- $this->fileExists = file_exists( $this->imagePath);
- $this->fromSharedDirectory = true;
- }
- if($this->fileExists) {
- $this->url = $this->wfImageUrl( $sharedname, $this->fromSharedDirectory );
- } else {
- $this->url='';
}
-
- $n = strrpos( $name, '.' );
- $this->extension = strtolower( $n ? substr( $name, $n + 1 ) : '' );
-
- if ( $this->fileExists )
- {
- if( $this->extension == 'svg' ) {
- @$gis = getSVGsize( $this->imagePath );
- } else {
- @$gis = getimagesize( $this->imagePath );
+ if (!$foundCached) {
+ $this->fileExists = file_exists( $this->imagePath);
+
+ # If the file is not found, and a shared upload directory
+ # like the Wikimedia Commons is used, look for it there.
+ if (!$this->fileExists && $wgUseSharedUploads) {
+
+ # 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.
+ $this->name= $wgLang->ucfirst($name);
+
+ # Encode the filename if we're on a Latin1 wiki and the
+ # shared repository is UTF-8
+ if($wgUseLatin1 && !$wgSharedLatin1) {
+ $this->name = utf8_encode($name);
+ }
+
+ $this->imagePath = $this->getFullPath(true);
+ $this->fileExists = file_exists( $this->imagePath);
+ $this->fromSharedDirectory = true;
+ $name=$this->name;
}
- 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'];
+
+ if ( $this->fileExists ) {
+ # Don't try to get the size of sound and video files, that's bad for performance
+ if ( !Image::isKnownImageExtension( $this->extension ) ) {
+ $gis = false;
+ } elseif( $this->extension == 'svg' ) {
+ wfSuppressWarnings();
+ $gis = getSVGsize( $this->imagePath );
+ wfRestoreWarnings();
} else {
- $this->bits = 0;
+ wfSuppressWarnings();
+ $gis = getimagesize( $this->imagePath );
+ wfRestoreWarnings();
}
}
+
+ $cachedValues = array('name' => $this->name,
+ 'imagePath' => $this->imagePath,
+ 'fileExists' => $this->fileExists,
+ 'fromShared' => $this->fromSharedDirectory,
+ 'gis' => $gis);
+
+ $wgMemc->set( $cacheKey, $cachedValues );
+
+ if ($wgUseSharedUploads && $this->fromSharedDirectory) {
+ $cachedValues['fromShared'] = false;
+ $wgMemc->set( "$wgSharedUploadDBname:Image:".$hashedName, $cachedValues );
+ }
+ }
+
+ 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;
+ }
+ }
+
+ if($this->fileExists) {
+ $this->url = $this->wfImageUrl( $this->name, $this->fromSharedDirectory );
+ } else {
+ $this->url='';
}
$this->historyLine = 0;
}
+ /**
+ * Remove image metadata from cache if any
+ *
+ * Don't call this, use the $recache parameter of Image::Image() instead
+ *
+ * @param string $name the title of an image
+ * @static
+ */
+ function invalidateMetadataCache( $name ) {
+ global $wgMemc, $wgDBname;
+ $wgMemc->delete("$wgDBname:Image:".md5($name));
+ }
+
/**
* Factory function
*
* @param Title $nt Title object. Must be from namespace "image"
* @access public
*/
- function newFromTitle( $nt )
- {
+ function newFromTitle( $nt ) {
$img = new Image( $nt->getDBKey() );
$img->title = $nt;
return $img;
* Return the name of this image
* @access public
*/
- function getName()
- {
+ function getName() {
return $this->name;
}
* Return the associated title object
* @access public
*/
- function getTitle()
- {
+ function getTitle() {
return $this->title;
}
* Return the URL of the image file
* @access public
*/
- function getURL()
- {
+ function getURL() {
return $this->url;
}
* Returns -1 if the file specified is not a known image type
* @access public
*/
- function getWidth()
- {
+ function getWidth() {
return $this->width;
}
* Returns -1 if the file specified is not a known image type
* @access public
*/
- function getHeight()
- {
+ function getHeight() {
return $this->height;
}
* Return the size of the image file, in bytes
* @access public
*/
- function getSize()
- {
+ function getSize() {
$st = stat( $this->getImagePath() );
- return $st['size'];
+ if( $st ) {
+ return $st['size'];
+ } else {
+ return false;
+ }
}
/**
* - 15 WBMP
* - 16 XBM
*/
- function getType()
- {
+ function getType() {
return $this->type;
}
* Return the escapeLocalURL of this image
* @access public
*/
- function getEscapeLocalURL()
- {
+ function getEscapeLocalURL() {
return $this->title->escapeLocalURL();
}
* Return the escapeFullURL of this image
* @access public
*/
- function getEscapeFullURL()
- {
+ function getEscapeFullURL() {
return $this->title->escapeFullURL();
}
* @param boolean $fromSharedDirectory Should this be in $wgSharedUploadPath?
* @access public
*/
- function wfImageUrl( $name, $fromSharedDirectory = false )
- {
- global $wgUploadPath,$wgUploadBaseUrl,$wgHashedUploadDirectory,
- $wgHashedSharedUploadDirectory,$wgSharedUploadPath,
- $wgUseLatin1, $wgSharedLatin1;
+ function wfImageUrl( $name, $fromSharedDirectory = false ) {
+ global $wgUploadPath,$wgUploadBaseUrl,$wgSharedUploadPath;
if($fromSharedDirectory) {
- $hash = $wgHashedSharedUploadDirectory;
$base = '';
$path = $wgSharedUploadPath;
- if($wgUseLatin1 && !$wgSharedLatin1) {
- $name=utf8_encode($name);
- }
} else {
- $hash = $wgHashedUploadDirectory;
$base = $wgUploadBaseUrl;
$path = $wgUploadPath;
}
- if ( $hash ) {
- $hash = md5( $name );
- $url = "{$base}{$path}/" . $hash{0} . "/" .
- substr( $hash, 0, 2 ) . "/{$name}";
- } else {
- $url = "{$base}{$path}/{$name}";
- }
+ $url = "{$base}{$path}" . wfGetHashPath($name, $fromSharedDirectory) . "{$name}";
return wfUrlencode( $url );
}
*
* @access public
*/
- function exists()
- {
+ function exists() {
return $this->fileExists;
}
* @access private
*/
function thumbUrl( $width, $subdir='thumb') {
- global $wgUploadPath,$wgHashedUploadDirectory, $wgUploadBaseUrl,
+ global $wgUploadPath, $wgUploadBaseUrl,
$wgSharedUploadPath,$wgSharedUploadDirectory,
- $wgHashedSharedUploadDirectory,$wgUseLatin1,$wgSharedLatin1;
+ $wgUseLatin1,$wgSharedLatin1;
$name = $this->thumbName( $width );
if($this->fromSharedDirectory) {
- $hashdir = $wgHashedSharedUploadDirectory;
$base = '';
$path = $wgSharedUploadPath;
if($wgUseLatin1 && !$wgSharedLatin1) {
$name=utf8_encode($name);
}
} else {
- $hashdir = $wgHashedUploadDirectory;
$base = $wgUploadBaseUrl;
$path = $wgUploadPath;
}
- if ($hashdir) {
- $hash = md5( $name );
- $url = "{$base}{$path}/{$subdir}/" . $hash{0} . "/" .
- substr( $hash, 0, 2 ) . "/{$name}";
- } else {
- $url = "{$base}{$path}/{$subdir}/{$name}";
- }
-
+ $url = "{$base}{$path}/{$subdir}" .
+ wfGetHashPath($name, $this->fromSharedDirectory)
+ . "{$name}";
return wfUrlencode($url);
}
* @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 );
}
$thumbwidth = $thumbwidth * $height / $thumbheight;
$thumbheight = $height;
}
- return $this->renderThumb( $thumbwidth );
+ $thumb = $this->renderThumb( $thumbwidth );
+ if( is_null( $thumb ) ) {
+ $thumb = $this->iconThumb();
+ }
+ return $thumb;
+ }
+
+ /**
+ * @return ThumbnailImage
+ */
+ 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( $filepath, $wgStylePath . $path );
+ }
+ }
+ return null;
}
/**
* 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.
+ * 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 ) {
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 && !$this->mustRender() ) {
# Don't make an image bigger than the source
- return $this->getViewURL();
+ return new ThumbnailImage( $this->getImagePath(), $this->getViewURL() );
}
if ( (! file_exists( $thumbPath ) ) || ( filemtime($thumbPath) < filemtime($this->imagePath) ) ) {
}
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
#
- $thumbstat = stat( $thumbPath );
- if( $thumbstat['size'] == 0 )
- {
- unlink( $thumbPath );
+ if( file_exists( $thumbPath ) ) {
+ $thumbstat = stat( $thumbPath );
+ if( $thumbstat['size'] == 0 ) {
+ unlink( $thumbPath );
+ }
}
# Purge squid
wfPurgeSquidServers($urlArr);
}
}
- return $thumbUrl;
+ return new ThumbnailImage( $thumbPath, $thumbUrl );
} // END OF function createThumb
/**
*
* @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
* Reset the history pointer to the first element of the history
* @access public
*/
- function resetHistory()
- {
+ function resetHistory() {
$this->historyLine = 0;
}
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;
+ $name = $this->name;
+ $fullpath = $dir . wfGetHashPath($name, $fromSharedRepository) . $name;
+ return $fullpath;
+ }
+
+ /**
+ * @return bool
+ * @static
+ */
+ function isKnownImageExtension( $ext ) {
+ static $extensions = array( 'svg', 'png', 'jpg', 'jpeg', 'gif', 'bmp', 'xbm' );
+ return in_array( $ext, $extensions );
+ }
+
} //class
* @param string $fname file name of the image file
* @access public
*/
-function wfImageDir( $fname )
-{
+function wfImageDir( $fname ) {
global $wgUploadDirectory, $wgHashedUploadDirectory;
if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
* @param boolean $shared (optional) use the shared upload directory
* @access public
*/
-function wfImageThumbDir( $fname , $subdir='thumb', $shared=false)
-{
+function wfImageThumbDir( $fname , $subdir='thumb', $shared=false) {
return wfImageArchiveDir( $fname, $subdir, $shared );
}
* @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 )
-{
+function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
global $wgUploadDirectory, $wgHashedUploadDirectory,
$wgSharedUploadDirectory, $wgHashedSharedUploadDirectory;
$dir = $shared ? $wgSharedUploadDirectory : $wgUploadDirectory;
return $archive;
}
+
+/*
+ * 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;
+
+ $ishashed = $fromSharedDirectory ? $wgHashedSharedUploadDirectory :
+ $wgHashedUploadDirectory;
+ if($ishashed) {
+ $hash = md5($dbkey);
+ return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
+ } else {
+ return '/';
+ }
+}
+
+
/**
* Record an image upload in the upload log.
*/
-function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
-{
+function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = '', $source = '' ) {
global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
global $wgUseCopyrightUpload;
$now = wfTimestampNow();
- $won = wfInvertTimestamp( $now );
$size = IntVal( $size );
- if ( $wgUseCopyrightUpload )
- {
+ 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
'img_description' => $desc,
'img_user' => $wgUser->getID(),
'img_user_text' => $wgUser->getName(),
- ), $fname, 'IGNORE'
+ ), $fname, 'IGNORE'
);
$descTitle = Title::makeTitleSafe( NS_IMAGE, $name );
$id = $descTitle->getArticleID();
if ( $id == 0 ) {
- $seqVal = $dbw->nextSequenceValue( 'cur_cur_id_seq' );
- $dbw->insert( '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 );
-
- $u = new SearchUpdate( $id, $name, $desc );
- $u->doUpdate();
+ $article = new Article( $descTitle );
+ $article->insertNewArticle( $textdesc, $desc, false, false );
}
} else {
# Collision, this is an update of an image
* @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' )
-{
+function wfImageArchiveUrl( $name, $subdir='archive' ) {
global $wgUploadPath, $wgHashedUploadDirectory;
if ($wgHashedUploadDirectory) {
"width=\"$width\" height=\"$height\"" );
}
+
+/**
+ * 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( $path, $url ) {
+ $this->url = $url;
+ $this->path = $path;
+ $size = @getimagesize( $this->path );
+ if( $size ) {
+ $this->width = $size[0];
+ $this->height = $size[1];
+ } else {
+ $this->width = 0;
+ $this->height = 0;
+ }
+ }
+
+ /**
+ * @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;
+ }
+
+ /**
+ * Return the size of the thumbnail file, in bytes or false if the file
+ * can't be stat().
+ * @access public
+ */
+ function getSize() {
+ $st = stat( $this->path );
+ if( $st ) {
+ return $st['size'];
+ } else {
+ return false;
+ }
+ }
+}
?>