<?php
/**
- * @package MediaWiki
*/
/**
*
* Provides methods to retrieve paths (physical, logical, URL),
* to generate thumbnails or for uploading.
- * @package MediaWiki
*/
class Image
{
+ const DELETED_FILE = 1;
+ const DELETED_COMMENT = 2;
+ const DELETED_USER = 4;
+ const DELETED_RESTRICTED = 8;
+
/**#@+
* @private
*/
$attr, # /
$type, # MEDIATYPE_xxx (bitmap, drawing, audio...)
$mime, # MIME type, determined by MimeMagic::guessMimeType
+ $extension, # The file extension (constructor)
$size, # Size in bytes (loadFromXxx)
$metadata, # Metadata
$dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
+ $page, # Page to render when creating thumbnails
$lastError; # Error string associated with a thumbnail display error
* @param string $name name of the image, used to create a title object using Title::makeTitleSafe
* @public
*/
- function newFromName( $name ) {
+ public static function newFromName( $name ) {
$title = Title::makeTitleSafe( NS_IMAGE, $name );
if ( is_object( $title ) ) {
return new Image( $title );
$this->extension = Image::normalizeExtension( $n ?
substr( $this->name, $n + 1 ) : '' );
$this->historyLine = 0;
+ $this->page = 1;
$this->dataLoaded = false;
}
-
/**
* Normalize a file extension to the common form, and ensure it's clean.
* Extensions with non-alphanumeric characters will be discarded.
return '';
}
}
-
+
/**
* 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( ) {
- global $wgDBname, $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
+ global $wgUseSharedUploads, $wgSharedUploadDBname, $wgCacheSharedUploads;
$hashedName = md5($this->name);
- $keys = array( "$wgDBname:Image:$hashedName" );
+ $keys = array( wfMemcKey( 'Image', $hashedName ) );
if ( $wgUseSharedUploads && $wgSharedUploadDBname && $wgCacheSharedUploads ) {
- $keys[] = "$wgSharedUploadDBname:Image:$hashedName";
+ $keys[] = wfForeignMemcKey( $wgSharedUploadDBname, false, 'Image', $hashedName );
}
return $keys;
}
*/
function loadFromCache() {
global $wgUseSharedUploads, $wgMemc;
- $fname = 'Image::loadFromMemcached';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$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['version']) && ( $cachedValues['version'] == MW_IMAGE_VERSION )
- && $cachedValues['fileExists'] && isset( $cachedValues['mime'] ) && isset( $cachedValues['metadata'] ) )
+ && isset( $cachedValues['mime'] ) && isset( $cachedValues['metadata'] ) )
{
if ( $wgUseSharedUploads && $cachedValues['fromShared']) {
# if this is shared file, we need to check if image
wfIncrStats( 'image_cache_miss' );
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $this->dataLoaded;
}
* Save the image metadata to memcached
*/
function saveToCache() {
- global $wgMemc;
+ global $wgMemc, $wgUseSharedUploads;
$this->load();
$keys = $this->getCacheKeys();
- if ( $this->fileExists ) {
- // We can't cache negative metadata for non-existent files,
- // because if the file later appears in commons, the local
- // keys won't be purged.
+ // We can't cache negative metadata for non-existent files,
+ // because if the file later appears in commons, the local
+ // keys won't be purged.
+ if ( $this->fileExists || !$wgUseSharedUploads ) {
$cachedValues = array(
'version' => MW_IMAGE_VERSION,
'name' => $this->name,
* Load metadata from the file itself
*/
function loadFromFile() {
- global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgContLang, $wgShowEXIF;
- $fname = 'Image::loadFromFile';
- wfProfileIn( $fname );
+ global $wgUseSharedUploads, $wgSharedUploadDirectory, $wgContLang;
+ wfProfileIn( __METHOD__ );
$this->imagePath = $this->getFullPath();
$this->fileExists = file_exists( $this->imagePath );
$this->fromSharedDirectory = false;
$gis = array();
+ $deja = false;
- if (!$this->fileExists) wfDebug("$fname: ".$this->imagePath." not found locally!\n");
+ if (!$this->fileExists) wfDebug(__METHOD__.': '.$this->imagePath." not found locally!\n");
# If the file is not found, and a shared upload directory is used, look for it there.
if (!$this->fileExists && $wgUseSharedUploads && $wgSharedUploadDirectory) {
if ( $this->fileExists ) {
- $magic=& wfGetMimeMagic();
+ $magic=& MimeMagic::singleton();
$this->mime = $magic->guessMimeType($this->imagePath,true);
$this->type = $magic->getMediaType($this->imagePath,$this->mime);
# Get size in bytes
$this->size = filesize( $this->imagePath );
- $magic=& wfGetMimeMagic();
-
# Height and width
- wfSuppressWarnings();
- if( $this->mime == 'image/svg' ) {
- $gis = wfGetSVGsize( $this->imagePath );
- } elseif( $this->mime == 'image/vnd.djvu' ) {
- $deja = new DjVuImage( $this->imagePath );
- $gis = $deja->getImageSize();
- } elseif ( !$magic->isPHPImageType( $this->mime ) ) {
- # Don't try to get the width and height of sound and video files, that's bad for performance
- $gis = false;
- } else {
- $gis = getimagesize( $this->imagePath );
- }
- wfRestoreWarnings();
+ $gis = self::getImageSize( $this->imagePath, $this->mime, $deja );
- wfDebug("$fname: ".$this->imagePath." loaded, ".$this->size." bytes, ".$this->mime.".\n");
+ wfDebug(__METHOD__.': '.$this->imagePath." loaded, ".$this->size." bytes, ".$this->mime.".\n");
}
else {
$this->mime = NULL;
$this->type = MEDIATYPE_UNKNOWN;
- wfDebug("$fname: ".$this->imagePath." NOT FOUND!\n");
+ wfDebug(__METHOD__.': '.$this->imagePath." NOT FOUND!\n");
}
if( $gis ) {
$this->dataLoaded = true;
- $this->metadata = serialize( $this->retrieveExifData( $this->imagePath ) );
+ if ( $deja ) {
+ $this->metadata = $deja->retrieveMetaData();
+ } else {
+ $this->metadata = serialize( $this->retrieveExifData( $this->imagePath ) );
+ }
if ( isset( $gis['bits'] ) ) $this->bits = $gis['bits'];
else $this->bits = 0;
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
/**
*/
function loadFromDB() {
global $wgUseSharedUploads, $wgSharedUploadDBname, $wgSharedUploadDBprefix, $wgContLang;
- $fname = 'Image::loadFromDB';
- wfProfileIn( $fname );
-
- $dbr =& wfGetDB( DB_SLAVE );
+ wfProfileIn( __METHOD__ );
+ $dbr = wfGetDB( DB_SLAVE );
$this->checkDBSchema($dbr);
$row = $dbr->selectRow( 'image',
array( 'img_size', 'img_width', 'img_height', 'img_bits',
'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
- array( 'img_name' => $this->name ), $fname );
+ array( 'img_name' => $this->name ), __METHOD__ );
if ( $row ) {
$this->fromSharedDirectory = false;
$this->fileExists = true;
# capitalize the first letter of the filename before
# looking it up in the shared repository.
$name = $wgContLang->ucfirst($this->name);
- $dbc =& wfGetDB( DB_SLAVE, 'commons' );
+ $dbc = Image::getCommonsDB();
$row = $dbc->selectRow( "`$wgSharedUploadDBname`.{$wgSharedUploadDBprefix}image",
array(
'img_size', 'img_width', 'img_height', 'img_bits',
'img_media_type', 'img_major_mime', 'img_minor_mime', 'img_metadata' ),
- array( 'img_name' => $name ), $fname );
+ array( 'img_name' => $name ), __METHOD__ );
if ( $row ) {
$this->fromSharedDirectory = true;
$this->fileExists = true;
$this->fileExists = false;
$this->fromSharedDirectory = false;
$this->metadata = serialize ( array() ) ;
+ $this->mime = false;
}
# Unconditionally set loaded=true, we don't want the accessors constantly rechecking
$this->dataLoaded = true;
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
/*
$this->loadFromDB();
if ( !$wgSharedUploadDBname && $wgUseSharedUploads ) {
$this->loadFromFile();
- } elseif ( $this->fileExists ) {
+ } elseif ( $this->fileExists || !$wgUseSharedUploads ) {
+ // We can do negative caching for local images, because the cache
+ // will be purged on upload. But we can't do it when shared images
+ // are enabled, since updates to that won't purge foreign caches.
$this->saveToCache();
- }
+ }
}
$this->dataLoaded = true;
}
*/
function upgradeRow() {
global $wgDBname, $wgSharedUploadDBname;
- $fname = 'Image::upgradeRow';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
$this->loadFromFile();
if ( $this->fromSharedDirectory ) {
if ( !$wgSharedUploadDBname ) {
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return;
}
// Write to the other DB using selectDB, not database selectors
// This avoids breaking replication in MySQL
- $dbw =& wfGetDB( DB_MASTER, 'commons' );
- $dbw->selectDB( $wgSharedUploadDBname );
+ $dbw = Image::getCommonsDB();
} else {
- $dbw =& wfGetDB( DB_MASTER );
+ $dbw = wfGetDB( DB_MASTER );
}
$this->checkDBSchema($dbw);
list( $major, $minor ) = self::splitMime( $this->mime );
- wfDebug("$fname: upgrading ".$this->name." to 1.5 schema\n");
+ wfDebug(__METHOD__.': upgrading '.$this->name." to 1.5 schema\n");
$dbw->update( 'image',
array(
'img_major_mime' => $major,
'img_minor_mime' => $minor,
'img_metadata' => $this->metadata,
- ), array( 'img_name' => $this->name ), $fname
+ ), array( 'img_name' => $this->name ), __METHOD__
);
if ( $this->fromSharedDirectory ) {
$dbw->selectDB( $wgDBname );
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
-
+
/**
* Split an internet media type into its two components; if not
* a two-part name, set the minor type to 'unknown'.
* @todo remember the result of this check.
*/
function canRender() {
- global $wgUseImageMagick;
+ global $wgUseImageMagick, $wgDjvuRenderer;
if( $this->getWidth()<=0 || $this->getHeight()<=0 ) return false;
if (!$mime || $mime==='unknown' || $mime==='unknown/unknown') return false;
#if it's SVG, check if there's a converter enabled
- if ($mime === 'image/svg') {
+ if ($mime === 'image/svg' || $mime == 'image/svg+xml' ) {
global $wgSVGConverters, $wgSVGConverter;
if ($wgSVGConverter && isset( $wgSVGConverters[$wgSVGConverter])) {
if ( $mime === 'image/vnd.wap.wbmp'
|| $mime === 'image/x-xbitmap' ) return true;
}
+ if ( $mime === 'image/vnd.djvu' && isset( $wgDjvuRenderer ) && $wgDjvuRenderer ) return true;
return false;
}
* Return the escapeLocalURL of this image
* @public
*/
- function getEscapeLocalURL() {
+ function getEscapeLocalURL( $query=false) {
$this->getTitle();
- return $this->title->escapeLocalURL();
+ if ( $query === false ) {
+ if ( $this->page != 1 ) {
+ $query = 'page=' . $this->page;
+ } else {
+ $query = '';
+ }
+ }
+ return $this->title->escapeLocalURL( $query );
}
/**
* @private
*/
function thumbName( $width ) {
+ global $wgDjvuOutputExtension;
$thumb = $width."px-".$this->name;
+ if ( $this->page != 1 ) {
+ $thumb = "page{$this->page}-$thumb";
+ }
if( $this->mustRender() ) {
if( $this->canRender() ) {
- # Rasterize to PNG (for SVG vector images, etc)
- $thumb .= '.png';
+ list( $ext, $mime ) = self::getThumbType( $this->extension, $this->mime );
+ if ( $ext != $this->extension ) {
+ $thumb .= ".$ext";
+ }
}
else {
#should we use iconThumb here to get a symbolic thumbnail?
* provide access to the actual file, the real size of the thumb,
* and can produce a convenient <img> tag for you.
*
+ * For non-image formats, this may return a filetype-specific icon.
+ *
* @param integer $width maximum width of the generated thumbnail
* @param integer $height maximum height of the image (optional)
+ * @param boolean $render True to render the thumbnail if it doesn't exist,
+ * false to just return the URL
+ *
* @return ThumbnailImage or null on failure
* @public
*/
- function getThumbnail( $width, $height=-1 ) {
- if ( $height <= 0 ) {
- return $this->renderThumb( $width );
- }
- $this->load();
-
+ function getThumbnail( $width, $height=-1, $render = true ) {
+ wfProfileIn( __METHOD__ );
if ($this->canRender()) {
- if ( $width > $this->width * $height / $this->height )
- $width = wfFitBoxWidth( $this->width, $this->height, $height );
- $thumb = $this->renderThumb( $width );
+ if ( $height > 0 ) {
+ $this->load();
+ if ( $width > $this->width * $height / $this->height ) {
+ $width = wfFitBoxWidth( $this->width, $this->height, $height );
+ }
+ }
+ if ( $render ) {
+ $thumb = $this->renderThumb( $width );
+ } else {
+ // Don't render, just return the URL
+ if ( $this->validateThumbParams( $width, $height ) ) {
+ if ( !$this->mustRender() && $width == $this->width && $height == $this->height ) {
+ $url = $this->getURL();
+ } else {
+ list( /* $isScriptUrl */, $url ) = $this->thumbUrl( $width );
+ }
+ $thumb = new ThumbnailImage( $url, $width, $height );
+ } else {
+ $thumb = null;
+ }
+ }
+ } else {
+ // not a bitmap or renderable image, don't try.
+ $thumb = $this->iconThumb();
}
- else $thumb= NULL; #not a bitmap or renderable image, don't try.
-
+ wfProfileOut( __METHOD__ );
return $thumb;
}
}
/**
- * 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.
+ * Validate thumbnail parameters and fill in the correct height
*
- * @return ThumbnailImage or null on failure
- * @private
+ * @param integer &$width Specified width (input/output)
+ * @param integer &$height Height (output only)
+ * @return false to indicate that an error should be returned to the user.
*/
- function renderThumb( $width, $useScript = true ) {
- global $wgUseSquid;
- global $wgSVGMaxSize, $wgMaxImageArea, $wgThumbnailEpoch;
-
- $fname = 'Image::renderThumb';
- wfProfileIn( $fname );
-
- $width = intval( $width );
+ function validateThumbParams( &$width, &$height ) {
+ global $wgSVGMaxSize, $wgMaxImageArea;
$this->load();
+
if ( ! $this->exists() )
{
# If there is no image, there will be no thumbnail
- wfProfileOut( $fname );
- return null;
+ return false;
}
+ $width = intval( $width );
+
# Sanity check $width
if( $width <= 0 || $this->width <= 0) {
# BZZZT
- wfProfileOut( $fname );
- return null;
+ return false;
}
# Don't thumbnail an image so big that it will fill hard drives and send servers into swap
$this->getMimeType() !== 'image/jpeg' &&
$this->width * $this->height > $wgMaxImageArea )
{
- wfProfileOut( $fname );
- return null;
+ return false;
}
# Don't make an image bigger than the source, or wgMaxSVGSize for SVGs
if ( $this->mustRender() ) {
$width = min( $width, $wgSVGMaxSize );
} elseif ( $width > $this->width - 1 ) {
- $thumb = new ThumbnailImage( $this->getURL(), $this->getWidth(), $this->getHeight() );
- wfProfileOut( $fname );
- return $thumb;
+ $width = $this->width;
+ $height = $this->height;
+ return true;
+ }
+
+ $height = self::scaleHeight( $this->width, $this->height, $width );
+ return true;
+ }
+
+ /**
+ * 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 or null on failure
+ * @private
+ */
+ function renderThumb( $width, $useScript = true ) {
+ global $wgUseSquid, $wgThumbnailEpoch;
+
+ wfProfileIn( __METHOD__ );
+
+ $this->load();
+ $height = -1;
+ if ( !$this->validateThumbParams( $width, $height ) ) {
+ # Validation error
+ wfProfileOut( __METHOD__ );
+ return null;
}
- $height = round( $this->height * $width / $this->width );
+ if ( !$this->mustRender() && $width == $this->width && $height == $this->height ) {
+ # validateThumbParams (or the user) wants us to return the unscaled image
+ $thumb = new ThumbnailImage( $this->getURL(), $width, $height );
+ wfProfileOut( __METHOD__ );
+ return $thumb;
+ }
list( $isScriptUrl, $url ) = $this->thumbUrl( $width );
if ( $isScriptUrl && $useScript ) {
// Use thumb.php to render the image
$thumb = new ThumbnailImage( $url, $width, $height );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $thumb;
}
$thumbName = $this->thumbName( $width, $this->fromSharedDirectory );
- $thumbPath = wfImageThumbDir( $this->name, $this->fromSharedDirectory ).'/'.$thumbName;
+ $thumbDir = wfImageThumbDir( $this->name, $this->fromSharedDirectory );
+ $thumbPath = $thumbDir.'/'.$thumbName;
if ( is_dir( $thumbPath ) ) {
// Directory where file should be
$done = true;
if ( !file_exists( $thumbPath ) ||
- filemtime( $thumbPath ) < wfTimestamp( TS_UNIX, $wgThumbnailEpoch ) ) {
+ filemtime( $thumbPath ) < wfTimestamp( TS_UNIX, $wgThumbnailEpoch ) )
+ {
+ // Create the directory if it doesn't exist
+ if ( is_file( $thumbDir ) ) {
+ // File where thumb directory should be, destroy if possible
+ @unlink( $thumbDir );
+ }
+ wfMkdirParents( $thumbDir );
+
$oldThumbPath = wfDeprecatedThumbDir( $thumbName, 'thumb', $this->fromSharedDirectory ).
'/'.$thumbName;
$done = false;
}
}
if ( !$done ) {
- $this->lastError = $this->reallyRenderThumb( $thumbPath, $width, $height );
+ $this->lastError = self::reallyRenderThumb( $this->imagePath, $thumbPath, $this->mime,
+ $width, $height, $this->page );
if ( $this->lastError === true ) {
$done = true;
} elseif( $GLOBALS['wgIgnoreImageErrors'] ) {
} else {
$thumb = null;
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $thumb;
} // END OF function renderThumb
/**
* Really render a thumbnail
* Call this only for images for which canRender() returns true.
- *
- * @param string $thumbPath Path to thumbnail
- * @param int $width Desired width in pixels
- * @param int $height Desired height in pixels
- * @return bool True on error, false or error string on failure.
- * @private
+ *
+ * @param string $source Source filename
+ * @param string $destination Destination filename
+ * @param string $mime MIME type of source
+ * @param integer $width Destination width in pixels
+ * @param integer $height Destination height in pixels
+ * @param integer $page Which page of a multi-page document to display. Ignored
+ * for source MIME types which do not support multiple pages.
*/
- function reallyRenderThumb( $thumbPath, $width, $height ) {
+ static function reallyRenderThumb( $source, $destination, $mime, $width, $height, $page = false ) {
global $wgSVGConverters, $wgSVGConverter;
global $wgUseImageMagick, $wgImageMagickConvertCommand;
global $wgCustomConvertCommand;
-
- $this->load();
+ global $wgDjvuRenderer, $wgDjvuPostProcessor;
$err = false;
$cmd = "";
$retval = 0;
-
- if( $this->mime === "image/svg" ) {
+
+ if( $mime == "image/svg" || $mime == 'image/svg+xml' ) {
#Right now we have only SVG
global $wgSVGConverters, $wgSVGConverter;
global $wgSVGConverterPath;
$cmd = str_replace(
array( '$path/', '$width', '$height', '$input', '$output' ),
- array( $wgSVGConverterPath ? "$wgSVGConverterPath/" : "",
+ array( $wgSVGConverterPath ? wfEscapeShellArg( "$wgSVGConverterPath/" ) : "",
intval( $width ),
intval( $height ),
- wfEscapeShellArg( $this->imagePath ),
- wfEscapeShellArg( $thumbPath ) ),
- $wgSVGConverters[$wgSVGConverter] );
+ wfEscapeShellArg( $source ),
+ wfEscapeShellArg( $destination ) ),
+ $wgSVGConverters[$wgSVGConverter] ) . " 2>&1";
wfProfileIn( 'rsvg' );
wfDebug( "reallyRenderThumb SVG: $cmd\n" );
$err = wfShellExec( $cmd, $retval );
wfProfileOut( 'rsvg' );
}
+ } elseif ( $mime === "image/vnd.djvu" && $wgDjvuRenderer ) {
+ // DJVU image
+ // The file contains several images. First, extract the
+ // page in hi-res, if it doesn't yet exist. Then, thumbnail
+ // it.
+
+ $cmd = wfEscapeShellArg( $wgDjvuRenderer ) . " -format=ppm -page={$page} -size=${width}x${height} " .
+ wfEscapeShellArg( $source );
+ if ( $wgDjvuPostProcessor ) {
+ $cmd .= " | {$wgDjvuPostProcessor}";
+ }
+ $cmd .= ' > ' . wfEscapeShellArg($destination);
+ wfProfileIn( 'ddjvu' );
+ wfDebug( "reallyRenderThumb DJVU: $cmd\n" );
+ $err = wfShellExec( $cmd, $retval );
+ wfProfileOut( 'ddjvu' );
+
} elseif ( $wgUseImageMagick ) {
# use ImageMagick
-
- if ( $this->mime == 'image/jpeg' ) {
+
+ if ( $mime == 'image/jpeg' ) {
$quality = "-quality 80"; // 80%
- } elseif ( $this->mime == 'image/png' ) {
+ } elseif ( $mime == 'image/png' ) {
$quality = "-quality 95"; // zlib 9, adaptive filtering
} else {
$quality = ''; // default
# Note, we specify "-size {$width}" and NOT "-size {$width}x{$height}".
# It seems that ImageMagick has a bug wherein it produces thumbnails of
# the wrong size in the second case.
-
+
$cmd = wfEscapeShellArg($wgImageMagickConvertCommand) .
" {$quality} -background white -size {$width} ".
- wfEscapeShellArg($this->imagePath) .
+ wfEscapeShellArg($source) .
// Coalesce is needed to scale animated GIFs properly (bug 1017).
' -coalesce ' .
// For the -resize option a "!" is needed to force exact size,
// or ImageMagick may decide your ratio is wrong and slice off
// a pixel.
- " -resize " . wfEscapeShellArg( "{$width}x{$height}!" ) .
+ " -thumbnail " . wfEscapeShellArg( "{$width}x{$height}!" ) .
" -depth 8 " .
- wfEscapeShellArg($thumbPath) . " 2>&1";
+ wfEscapeShellArg($destination) . " 2>&1";
wfDebug("reallyRenderThumb: running ImageMagick: $cmd\n");
wfProfileIn( 'convert' );
$err = wfShellExec( $cmd, $retval );
} elseif( $wgCustomConvertCommand ) {
# Use a custom convert command
# Variables: %s %d %w %h
- $src = wfEscapeShellArg( $this->imagePath );
- $dst = wfEscapeShellArg( $thumbPath );
+ $src = wfEscapeShellArg( $source );
+ $dst = wfEscapeShellArg( $destination );
$cmd = $wgCustomConvertCommand;
$cmd = str_replace( '%s', $src, str_replace( '%d', $dst, $cmd ) ); # Filenames
$cmd = str_replace( '%h', $height, str_replace( '%w', $width, $cmd ) ); # Size
$typemap = array(
'image/gif' => array( 'imagecreatefromgif', 'palette', 'imagegif' ),
- 'image/jpeg' => array( 'imagecreatefromjpeg', 'truecolor', array( &$this, 'imageJpegWrapper' ) ),
+ 'image/jpeg' => array( 'imagecreatefromjpeg', 'truecolor', array( __CLASS__, 'imageJpegWrapper' ) ),
'image/png' => array( 'imagecreatefrompng', 'bits', 'imagepng' ),
'image/vnd.wap.wmbp' => array( 'imagecreatefromwbmp', 'palette', 'imagewbmp' ),
'image/xbm' => array( 'imagecreatefromxbm', 'palette', 'imagexbm' ),
);
- if( !isset( $typemap[$this->mime] ) ) {
+ if( !isset( $typemap[$mime] ) ) {
$err = 'Image type not supported';
wfDebug( "$err\n" );
return $err;
}
- list( $loader, $colorStyle, $saveType ) = $typemap[$this->mime];
+ list( $loader, $colorStyle, $saveType ) = $typemap[$mime];
if( !function_exists( $loader ) ) {
$err = "Incomplete GD library configuration: missing function $loader";
wfDebug( "$err\n" );
return $err;
}
- if( $colorStyle == 'palette' ) {
- $truecolor = false;
- } elseif( $colorStyle == 'truecolor' ) {
- $truecolor = true;
- } elseif( $colorStyle == 'bits' ) {
- $truecolor = ( $this->bits > 8 );
- }
- $src_image = call_user_func( $loader, $this->imagePath );
- if ( $truecolor ) {
- $dst_image = imagecreatetruecolor( $width, $height );
- } else {
- $dst_image = imagecreate( $width, $height );
- }
+ $src_image = call_user_func( $loader, $source );
+ $dst_image = imagecreatetruecolor( $width, $height );
imagecopyresampled( $dst_image, $src_image,
0,0,0,0,
- $width, $height, $this->width, $this->height );
- call_user_func( $saveType, $dst_image, $thumbPath );
+ $width, $height, imagesx( $src_image ), imagesy( $src_image ) );
+ call_user_func( $saveType, $dst_image, $destination );
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 );
+ $removed = false;
+ if( file_exists( $destination ) ) {
+ $thumbstat = stat( $destination );
if( $thumbstat['size'] == 0 || $retval != 0 ) {
wfDebugLog( 'thumbnail',
sprintf( 'Removing bad %d-byte thumbnail "%s"',
- $thumbstat['size'], $thumbPath ) );
- unlink( $thumbPath );
+ $thumbstat['size'], $destination ) );
+ unlink( $destination );
+ $removed = true;
}
}
- if ( $retval != 0 ) {
+ if ( $retval != 0 || $removed ) {
wfDebugLog( 'thumbnail',
sprintf( 'thumbnail failed on %s: error %d "%s" from "%s"',
wfHostname(), $retval, trim($err), $cmd ) );
return $this->lastError;
}
- function imageJpegWrapper( $dst_image, $thumbPath ) {
+ static function imageJpegWrapper( $dst_image, $thumbPath ) {
imageinterlace( $dst_image );
imagejpeg( $dst_image, $thumbPath, 95 );
}
$files = array();
$dir = wfImageThumbDir( $this->name, $shared );
- // This generates an error on failure, hence the @
- $handle = @opendir( $dir );
+ if ( is_dir( $dir ) ) {
+ $handle = opendir( $dir );
- if ( $handle ) {
- while ( false !== ( $file = readdir($handle) ) ) {
- if ( $file{0} != '.' ) {
- $files[] = $file;
+ if ( $handle ) {
+ while ( false !== ( $file = readdir($handle) ) ) {
+ if ( $file{0} != '.' ) {
+ $files[] = $file;
+ }
}
+ closedir( $handle );
}
- closedir( $handle );
}
} else {
$files = array();
$dir = wfImageThumbDir( $this->name, $shared );
$urls = array();
foreach ( $files as $file ) {
+ $m = array();
if ( preg_match( '/^(\d+)px/', $file, $m ) ) {
- $urls[] = $this->thumbUrl( $m[1], $this->fromSharedDirectory );
+ list( /* $isScriptUrl */, $url ) = $this->thumbUrl( $m[1] );
+ $urls[] = $url;
@unlink( "$dir/$file" );
}
}
// Purge the squid
if ( $wgUseSquid ) {
- $urls[] = $this->getViewURL();
+ $urls[] = $this->getURL();
foreach ( $archiveFiles as $file ) {
$urls[] = wfImageArchiveUrl( $file );
}
wfPurgeSquidServers( $urls );
}
}
-
+
/**
* Purge the image description page, but don't go after
* pages using the image. Use when modifying file history
function purgeDescription() {
$page = Title::makeTitle( NS_IMAGE, $this->name );
$page->invalidateCache();
+ $page->purgeSquid();
}
-
+
/**
* Purge metadata and all affected pages when the image is created,
* deleted, or majorly updated. A set of additional URLs may be
// Delete thumbnails and refresh image metadata cache
$this->purgeCache();
$this->purgeDescription();
-
+
// Purge cache of all pages using this image
$update = new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' );
$update->doUpdate();
}
function checkDBSchema(&$db) {
+ static $checkDone = false;
global $wgCheckDBSchema;
- if (!$wgCheckDBSchema) {
+ if (!$wgCheckDBSchema || $checkDone) {
return;
}
# img_name must be unique
if ( !$db->indexUnique( 'image', 'img_name' ) && !$db->indexExists('image','PRIMARY') ) {
throw new MWException( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
}
+ $checkDone = true;
# new fields must exist
#
* @public
*/
function nextHistoryLine() {
- $fname = 'Image::nextHistoryLine()';
- $dbr =& wfGetDB( DB_SLAVE );
+ $dbr = wfGetDB( DB_SLAVE );
$this->checkDBSchema($dbr);
"'' AS oi_archive_name"
),
array( 'img_name' => $this->title->getDBkey() ),
- $fname
+ __METHOD__
);
- if ( 0 == wfNumRows( $this->historyRes ) ) {
+ if ( 0 == $dbr->numRows( $this->historyRes ) ) {
return FALSE;
}
} else if ( $this->historyLine == 1 ) {
'oi_archive_name'
),
array( 'oi_name' => $this->title->getDBkey() ),
- $fname,
+ __METHOD__,
array( 'ORDER BY' => 'oi_timestamp DESC' )
);
}
* @return bool
* @static
*/
- function isHashed( $shared ) {
+ public static function isHashed( $shared ) {
global $wgHashedUploadDirectory, $wgHashedSharedUploadDirectory;
return $shared ? $wgHashedSharedUploadDirectory : $wgHashedUploadDirectory;
}
function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '', $watch = false ) {
global $wgUser, $wgUseCopyrightUpload;
- $fname = 'Image::recordUpload';
- $dbw =& wfGetDB( DB_MASTER );
+ $dbw = wfGetDB( DB_MASTER );
$this->checkDBSchema($dbw);
'img_user_text' => $wgUser->getName(),
'img_metadata' => $this->metadata,
),
- $fname,
+ __METHOD__,
'IGNORE'
);
'oi_description' => 'img_description',
'oi_user' => 'img_user',
'oi_user_text' => 'img_user_text',
- ), array( 'img_name' => $this->name ), $fname
+ ), array( 'img_name' => $this->name ), __METHOD__
);
# Update the current image row
'img_metadata' => $this->metadata,
), array( /* WHERE */
'img_name' => $this->name
- ), $fname
+ ), __METHOD__
);
} else {
# This is a new image
# Update the image count
$site_stats = $dbw->tableName( 'site_stats' );
- $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", $fname );
+ $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
}
$descTitle = $this->getTitle();
$article->insertNewArticle( $textdesc, $desc, $minor, $watch, $suppressRC );
}
+ # Hooks, hooks, the magic of hooks...
+ wfRunHooks( 'FileUpload', array( $this ) );
+
# Add the log entry
$log = new LogPage( 'upload' );
$log->addEntry( 'upload', $descTitle, $desc );
* @deprecated Use HTMLCacheUpdate, this function uses too much memory
*/
function getLinksTo( $options = '' ) {
- $fname = 'Image::getLinksTo';
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
if ( $options ) {
- $db =& wfGetDB( DB_MASTER );
+ $db = wfGetDB( DB_MASTER );
} else {
- $db =& wfGetDB( DB_SLAVE );
+ $db = wfGetDB( DB_SLAVE );
}
$linkCache =& LinkCache::singleton();
- extract( $db->tableNames( 'page', 'imagelinks' ) );
+ list( $page, $imagelinks ) = $db->tableNamesN( '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 );
+ $res = $db->query( $sql, __METHOD__ );
$retVal = array();
if ( $db->numRows( $res ) ) {
}
}
$db->freeResult( $res );
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $retVal;
}
-
+
/**
* Retrive Exif data from the file and prune unrecognized tags
* and/or tags with invalid contents
*/
private function retrieveExifData( $filename ) {
global $wgShowEXIF;
-
+
/*
if ( $this->getMimeType() !== "image/jpeg" )
return array();
$exif = new Exif( $filename );
return $exif->getFilteredData();
}
-
+
return array();
}
function getExifData() {
global $wgRequest;
- if ( $this->metadata === '0' )
+ if ( $this->metadata === '0' || $this->mime == 'image/vnd.djvu' )
return array();
$purge = $wgRequest->getVal( 'action' ) == 'purge';
}
function updateExifData( $version ) {
- $fname = 'Image:updateExifData';
-
if ( $this->getImagePath() === false ) # Not a local image
return;
}
# Update EXIF data in database
- $dbw =& wfGetDB( DB_MASTER );
+ $dbw = wfGetDB( DB_MASTER );
$this->checkDBSchema($dbw);
$dbw->update( 'image',
array( 'img_metadata' => $this->metadata ),
array( 'img_name' => $this->name ),
- $fname
+ __METHOD__
);
}
function isLocal() {
return !$this->fromSharedDirectory;
}
-
+
/**
* Was this image ever deleted from the wiki?
*
$title = Title::makeTitle( NS_IMAGE, $this->name );
return ( $title->isDeleted() > 0 );
}
-
+
/**
* Delete all versions of the image.
*
* @param $reason
* @return true on success, false on some kind of failure
*/
- function delete( $reason ) {
- $fname = __CLASS__ . '::' . __FUNCTION__;
+ function delete( $reason, $suppress=false ) {
$transaction = new FSTransaction();
$urlArr = array( $this->getURL() );
-
+
if( !FileStore::lock() ) {
- wfDebug( "$fname: failed to acquire file store lock, aborting\n" );
+ wfDebug( __METHOD__.": failed to acquire file store lock, aborting\n" );
return false;
}
-
+
try {
$dbw = wfGetDB( DB_MASTER );
$dbw->begin();
-
+
// Delete old versions
$result = $dbw->select( 'oldimage',
array( 'oi_archive_name' ),
array( 'oi_name' => $this->name ) );
-
+
while( $row = $dbw->fetchObject( $result ) ) {
$oldName = $row->oi_archive_name;
-
- $transaction->add( $this->prepareDeleteOld( $oldName, $reason ) );
-
+
+ $transaction->add( $this->prepareDeleteOld( $oldName, $reason, $suppress ) );
+
// We'll need to purge this URL from caches...
$urlArr[] = wfImageArchiveUrl( $oldName );
}
$dbw->freeResult( $result );
-
+
// And the current version...
- $transaction->add( $this->prepareDeleteCurrent( $reason ) );
-
+ $transaction->add( $this->prepareDeleteCurrent( $reason, $suppress ) );
+
$dbw->immediateCommit();
} catch( MWException $e ) {
- wfDebug( "$fname: db error, rolling back file transactions\n" );
+ wfDebug( __METHOD__.": db error, rolling back file transactions\n" );
$transaction->rollback();
FileStore::unlock();
throw $e;
}
-
- wfDebug( "$fname: deleted db items, applying file transactions\n" );
+
+ wfDebug( __METHOD__.": deleted db items, applying file transactions\n" );
$transaction->commit();
FileStore::unlock();
-
+
// Update site_stats
$site_stats = $dbw->tableName( 'site_stats' );
- $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", $fname );
-
+ $dbw->query( "UPDATE $site_stats SET ss_images=ss_images-1", __METHOD__ );
+
$this->purgeEverything( $urlArr );
-
+
return true;
}
-
-
+
+
/**
* Delete an old version of the image.
*
* @throws MWException or FSException on database or filestore failure
* @return true on success, false on some kind of failure
*/
- function deleteOld( $archiveName, $reason ) {
- $fname = __CLASS__ . '::' . __FUNCTION__;
+ function deleteOld( $archiveName, $reason, $suppress=false ) {
$transaction = new FSTransaction();
$urlArr = array();
-
+
if( !FileStore::lock() ) {
- wfDebug( "$fname: failed to acquire file store lock, aborting\n" );
+ wfDebug( __METHOD__.": failed to acquire file store lock, aborting\n" );
return false;
}
-
+
$transaction = new FSTransaction();
try {
$dbw = wfGetDB( DB_MASTER );
$dbw->begin();
- $transaction->add( $this->prepareDeleteOld( $archiveName, $reason ) );
+ $transaction->add( $this->prepareDeleteOld( $archiveName, $reason, $suppress ) );
$dbw->immediateCommit();
} catch( MWException $e ) {
- wfDebug( "$fname: db error, rolling back file transaction\n" );
+ wfDebug( __METHOD__.": db error, rolling back file transaction\n" );
$transaction->rollback();
FileStore::unlock();
throw $e;
}
-
- wfDebug( "$fname: deleted db items, applying file transaction\n" );
+
+ wfDebug( __METHOD__.": deleted db items, applying file transaction\n" );
$transaction->commit();
FileStore::unlock();
-
+
$this->purgeDescription();
// Squid purging
if ( $wgUseSquid ) {
$urlArr = array(
wfImageArchiveUrl( $archiveName ),
- $page->getInternalURL()
);
wfPurgeSquidServers( $urlArr );
}
return true;
}
-
+
/**
* Delete the current version of a file.
* May throw a database error.
* @return true on success, false on failure
*/
- private function prepareDeleteCurrent( $reason ) {
- $fname = __CLASS__ . '::' . __FUNCTION__;
+ private function prepareDeleteCurrent( $reason, $suppress=false ) {
return $this->prepareDeleteVersion(
$this->getFullPath(),
$reason,
'fa_user_text' => 'img_user_text',
'fa_timestamp' => 'img_timestamp' ),
array( 'img_name' => $this->name ),
- $fname );
+ $suppress,
+ __METHOD__ );
}
/**
* May throw a database error.
* @return true on success, false on failure
*/
- private function prepareDeleteOld( $archiveName, $reason ) {
- $fname = __CLASS__ . '::' . __FUNCTION__;
+ private function prepareDeleteOld( $archiveName, $reason, $suppress=false ) {
$oldpath = wfImageArchiveDir( $this->name ) .
DIRECTORY_SEPARATOR . $archiveName;
return $this->prepareDeleteVersion(
array(
'oi_name' => $this->name,
'oi_archive_name' => $archiveName ),
- $fname );
+ $suppress,
+ __METHOD__ );
}
/**
*
* @return FSTransaction
*/
- private function prepareDeleteVersion( $path, $reason, $table, $fieldMap, $where, $fname ) {
+ private function prepareDeleteVersion( $path, $reason, $table, $fieldMap, $where, $suppress=false, $fname ) {
global $wgUser, $wgSaveDeletedFiles;
-
+
// Dupe the file into the file store
if( file_exists( $path ) ) {
if( $wgSaveDeletedFiles ) {
$group = 'deleted';
-
+
$store = FileStore::get( $group );
$key = FileStore::calculateKey( $path, $this->extension );
$transaction = $store->insert( $key, $path,
$transaction = FileStore::deleteFile( $path );
}
} else {
- wfDebug( "$fname deleting already-missing '$path'; moving on to database\n" );
+ wfDebug( __METHOD__." deleting already-missing '$path'; moving on to database\n" );
$group = null;
$key = null;
$transaction = new FSTransaction(); // empty
}
-
+
if( $transaction === false ) {
// Fail to restore?
- wfDebug( "$fname: import to file store failed, aborting\n" );
+ wfDebug( __METHOD__.": import to file store failed, aborting\n" );
throw new MWException( "Could not archive and delete file $path" );
return false;
}
+ // Bitfields to further supress the image content
+ // Note that currently, live images are stored elsewhere
+ // and cannot be partially deleted
+ $bitfield = 0;
+ if ( $suppress ) {
+ $bitfield |= self::DELETED_FILE;
+ $bitfield |= self::DELETED_COMMENT;
+ $bitfield |= self::DELETED_USER;
+ $bitfield |= self::DELETED_RESTRICTED;
+ }
+
$dbw = wfGetDB( DB_MASTER );
$storageMap = array(
'fa_storage_group' => $dbw->addQuotes( $group ),
'fa_storage_key' => $dbw->addQuotes( $key ),
-
+
'fa_deleted_user' => $dbw->addQuotes( $wgUser->getId() ),
'fa_deleted_timestamp' => $dbw->timestamp(),
- 'fa_deleted_reason' => $dbw->addQuotes( $reason ) );
+ 'fa_deleted_reason' => $dbw->addQuotes( $reason ),
+ 'fa_deleted' => $bitfield);
$allFields = array_merge( $storageMap, $fieldMap );
-
+
try {
if( $wgSaveDeletedFiles ) {
$dbw->insertSelect( 'filearchive', $table, $allFields, $where, $fname );
} catch( DBQueryError $e ) {
// Something went horribly wrong!
// Leave the file as it was...
- wfDebug( "$fname: database error, rolling back file transaction\n" );
+ wfDebug( __METHOD__.": database error, rolling back file transaction\n" );
$transaction->rollback();
throw $e;
}
-
+
return $transaction;
}
-
+
/**
* Restore all or specified deleted revisions to the given file.
* Permissions and logging are left to the caller.
* @return the number of file revisions restored if successful,
* or false on failure
*/
- function restore( $versions=array() ) {
- $fname = __CLASS__ . '::' . __FUNCTION__;
+ function restore( $versions=array(), $Unsuppress=false ) {
+ global $wgUser;
+
if( !FileStore::lock() ) {
- wfDebug( "$fname could not acquire filestore lock\n" );
+ wfDebug( __METHOD__." could not acquire filestore lock\n" );
return false;
}
-
+
$transaction = new FSTransaction();
try {
$dbw = wfGetDB( DB_MASTER );
$dbw->begin();
-
+
// Re-confirm whether this image presently exists;
// if no we'll need to create an image record for the
// first item we restore.
$exists = $dbw->selectField( 'image', '1',
array( 'img_name' => $this->name ),
- $fname );
-
+ __METHOD__ );
+
// Fetch all or selected archived revisions for the file,
// sorted from the most recent to the oldest.
$conditions = array( 'fa_name' => $this->name );
if( $versions ) {
$conditions['fa_id'] = $versions;
}
-
+
$result = $dbw->select( 'filearchive', '*',
$conditions,
- $fname,
+ __METHOD__,
array( 'ORDER BY' => 'fa_timestamp DESC' ) );
-
+
if( $dbw->numRows( $result ) < count( $versions ) ) {
// There's some kind of conflict or confusion;
// we can't restore everything we were asked to.
- wfDebug( "$fname: couldn't find requested items\n" );
+ wfDebug( __METHOD__.": couldn't find requested items\n" );
$dbw->rollback();
FileStore::unlock();
return false;
if( $dbw->numRows( $result ) == 0 ) {
// Nothing to do.
- wfDebug( "$fname: nothing to do\n" );
+ wfDebug( __METHOD__.": nothing to do\n" );
$dbw->rollback();
FileStore::unlock();
return true;
}
-
+
$revisions = 0;
while( $row = $dbw->fetchObject( $result ) ) {
+ if ( $Unsuppress ) {
+ // Currently, fa_deleted flags fall off upon restore, lets be careful about this
+ } else if ( ($row->fa_deleted & Revision::DELETED_RESTRICTED) && !$wgUser->isAllowed('hiderevision') ) {
+ // Skip restoring file revisions that the user cannot restore
+ continue;
+ }
$revisions++;
$store = FileStore::get( $row->fa_storage_group );
if( !$store ) {
- wfDebug( "$fname: skipping row with no file.\n" );
+ wfDebug( __METHOD__.": skipping row with no file.\n" );
continue;
}
-
+
if( $revisions == 1 && !$exists ) {
- $destPath = wfImageDir( $row->fa_name ) .
- DIRECTORY_SEPARATOR .
- $row->fa_name;
-
+ $destDir = wfImageDir( $row->fa_name );
+ if ( !is_dir( $destDir ) ) {
+ wfMkdirParents( $destDir );
+ }
+ $destPath = $destDir . DIRECTORY_SEPARATOR . $row->fa_name;
+
// We may have to fill in data if this was originally
// an archived file revision.
if( is_null( $row->fa_metadata ) ) {
$tempFile = $store->filePath( $row->fa_storage_key );
$metadata = serialize( $this->retrieveExifData( $tempFile ) );
-
- $magic = wfGetMimeMagic();
+
+ $magic = MimeMagic::singleton();
$mime = $magic->guessMimeType( $tempFile, true );
$media_type = $magic->getMediaType( $tempFile, $mime );
list( $major_mime, $minor_mime ) = self::splitMime( $mime );
$minor_mime = $row->fa_minor_mime;
$media_type = $row->fa_media_type;
}
-
+
$table = 'image';
$fields = array(
'img_name' => $row->fa_name,
wfTimestamp( TS_MW, $row->fa_deleted_timestamp ) .
'!' . $row->fa_name;
}
- $destPath = wfImageArchiveDir( $row->fa_name ) .
- DIRECTORY_SEPARATOR . $archiveName;
-
+ $destDir = wfImageArchiveDir( $row->fa_name );
+ if ( !is_dir( $destDir ) ) {
+ wfMkdirParents( $destDir );
+ }
+ $destPath = $destDir . DIRECTORY_SEPARATOR . $archiveName;
+
$table = 'oldimage';
$fields = array(
'oi_name' => $row->fa_name,
'oi_user_text' => $row->fa_user_text,
'oi_timestamp' => $row->fa_timestamp );
}
-
- $dbw->insert( $table, $fields, $fname );
- /// @fixme this delete is not totally safe, potentially
+
+ $dbw->insert( $table, $fields, __METHOD__ );
+ // @todo this delete is not totally safe, potentially
$dbw->delete( 'filearchive',
array( 'fa_id' => $row->fa_id ),
- $fname );
-
+ __METHOD__ );
+
// Check if any other stored revisions use this file;
// if so, we shouldn't remove the file from the deletion
// archives so they will still work.
array(
'fa_storage_group' => $row->fa_storage_group,
'fa_storage_key' => $row->fa_storage_key ),
- $fname );
+ __METHOD__ );
if( $useCount == 0 ) {
- wfDebug( "$fname: nothing else using {$row->fa_storage_key}, will deleting after\n" );
+ wfDebug( __METHOD__.": nothing else using {$row->fa_storage_key}, will deleting after\n" );
$flags = FileStore::DELETE_ORIGINAL;
} else {
$flags = 0;
}
-
+
$transaction->add( $store->export( $row->fa_storage_key,
$destPath, $flags ) );
}
-
+
$dbw->immediateCommit();
} catch( MWException $e ) {
- wfDebug( "$fname caught error, aborting\n" );
+ wfDebug( __METHOD__." caught error, aborting\n" );
$transaction->rollback();
throw $e;
}
-
+
$transaction->commit();
FileStore::unlock();
-
+
if( $revisions > 0 ) {
if( !$exists ) {
- wfDebug( "$fname restored $revisions items, creating a new current\n" );
-
+ wfDebug( __METHOD__." restored $revisions items, creating a new current\n" );
+
// Update site_stats
$site_stats = $dbw->tableName( 'site_stats' );
- $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", $fname );
-
+ $dbw->query( "UPDATE $site_stats SET ss_images=ss_images+1", __METHOD__ );
+
$this->purgeEverything();
} else {
- wfDebug( "$fname restored $revisions as archived versions\n" );
+ wfDebug( __METHOD__." restored $revisions as archived versions\n" );
$this->purgeDescription();
}
}
-
+
return $revisions;
}
-
-} //class
-
-/**
- * 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 $fname String: file name of the image file.
- * @public
- */
-function wfImageDir( $fname ) {
- global $wgUploadDirectory, $wgHashedUploadDirectory;
+ /**
+ * Select a page from a multipage document. Determines the page used for
+ * rendering thumbnails.
+ *
+ * @param $page Integer: page number, starting with 1
+ */
+ function selectPage( $page ) {
+ if( $this->initializeMultiPageXML() ) {
+ wfDebug( __METHOD__." selecting page $page \n" );
+ $this->page = $page;
+ $o = $this->multiPageXML->BODY[0]->OBJECT[$page-1];
+ $this->height = intval( $o['height'] );
+ $this->width = intval( $o['width'] );
+ } else {
+ wfDebug( __METHOD__." selectPage($page) for bogus multipage xml on '$this->name'\n" );
+ return;
+ }
+ }
- if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
+ /**
+ * Lazy-initialize multipage XML metadata for DjVu files.
+ * @return bool true if $this->multiPageXML is set up and ready;
+ * false if corrupt or otherwise failing
+ */
+ function initializeMultiPageXML() {
+ $this->load();
+ if ( isset( $this->multiPageXML ) ) {
+ return true;
+ }
- $hash = md5( $fname );
- $oldumask = umask(0);
- $dest = $wgUploadDirectory . '/' . $hash{0};
- if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
- $dest .= '/' . substr( $hash, 0, 2 );
- if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
+ #
+ # Check for files uploaded prior to DJVU support activation,
+ # or damaged.
+ #
+ if( empty( $this->metadata ) || $this->metadata == serialize( array() ) ) {
+ $deja = new DjVuImage( $this->imagePath );
+ $this->metadata = $deja->retrieveMetaData();
+ $this->purgeMetadataCache();
- umask( $oldumask );
- return $dest;
-}
+ # Update metadata in the database
+ $dbw = wfGetDB( DB_MASTER );
+ $dbw->update( 'image',
+ array( 'img_metadata' => $this->metadata ),
+ array( 'img_name' => $this->name ),
+ __METHOD__
+ );
+ }
+ wfSuppressWarnings();
+ try {
+ $this->multiPageXML = new SimpleXMLElement( $this->metadata );
+ } catch( Exception $e ) {
+ wfDebug( "Bogus multipage XML metadata on '$this->name'\n" );
+ $this->multiPageXML = null;
+ }
+ wfRestoreWarnings();
+ return isset( $this->multiPageXML );
+ }
-/**
- * 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 $fname String: file name of the original image file
- * @param $shared Boolean: (optional) use the shared upload directory (default: 'false').
- * @public
- */
-function wfImageThumbDir( $fname, $shared = false ) {
- $base = wfImageArchiveDir( $fname, 'thumb', $shared );
- if ( Image::isHashed( $shared ) ) {
- $dir = "$base/$fname";
+ /**
+ * Returns 'true' if this image is a multipage document, e.g. a DJVU
+ * document.
+ *
+ * @return Bool
+ */
+ function isMultipage() {
+ return ( $this->mime == 'image/vnd.djvu' );
+ }
- if ( !is_dir( $base ) ) {
- $oldumask = umask(0);
- @mkdir( $base, 0777 );
- umask( $oldumask );
+ /**
+ * Returns the number of pages of a multipage document, or NULL for
+ * documents which aren't multipage documents
+ */
+ function pageCount() {
+ if ( ! $this->isMultipage() ) {
+ return null;
}
-
- if ( ! is_dir( $dir ) ) {
- if ( is_file( $dir ) ) {
- // Old thumbnail in the way of directory creation, kill it
- unlink( $dir );
- }
- $oldumask = umask(0);
- @mkdir( $dir, 0777 );
- umask( $oldumask );
+ if( $this->initializeMultiPageXML() ) {
+ return count( $this->multiPageXML->xpath( '//OBJECT' ) );
+ } else {
+ wfDebug( "Requested pageCount() for bogus multi-page metadata for '$this->name'\n" );
+ return null;
}
- } else {
- $dir = $base;
}
- return $dir;
-}
-
-/**
- * Old thumbnail directory, kept for conversion
- */
-function wfDeprecatedThumbDir( $thumbName , $subdir='thumb', $shared=false) {
- return wfImageArchiveDir( $thumbName, $subdir, $shared );
-}
+ static function getCommonsDB() {
+ static $dbc;
+ global $wgLoadBalancer, $wgSharedUploadDBname;
+ if ( !isset( $dbc ) ) {
+ $i = $wgLoadBalancer->getGroupIndex( 'commons' );
+ $dbinfo = $wgLoadBalancer->mServers[$i];
+ $dbc = new Database( $dbinfo['host'], $dbinfo['user'],
+ $dbinfo['password'], $wgSharedUploadDBname );
+ }
+ return $dbc;
+ }
-/**
- * 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 $fname String: file name of the thumbnail file, including file size prefix.
- * @param $subdir String: subdirectory of the image upload directory that should be used for storing the old version. Default is 'archive'.
- * @param $shared Boolean use the shared upload directory (only relevant for other functions which call this one). Default is 'false'.
- * @public
- */
-function wfImageArchiveDir( $fname , $subdir='archive', $shared=false ) {
- global $wgUploadDirectory, $wgHashedUploadDirectory;
- global $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.
- wfSuppressWarnings();
-
- $archive = $dir.'/'.$subdir;
- if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
- $archive .= '/' . $hash{0};
- if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
- $archive .= '/' . substr( $hash, 0, 2 );
- if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
-
- wfRestoreWarnings();
- umask( $oldumask );
- return $archive;
-}
+ /**
+ * Calculate the height of a thumbnail using the source and destination width
+ */
+ static function scaleHeight( $srcWidth, $srcHeight, $dstWidth ) {
+ // Exact integer multiply followed by division
+ return round( $srcHeight * $dstWidth / $srcWidth );
+ }
+ /**
+ * Get an image size array like that returned by getimagesize(), or false if it
+ * can't be determined.
+ *
+ * @param string $fileName The filename
+ * @param string $mimeType The MIME type of the file
+ * @param object $deja Filled with a DjVu object if the mime type is image/vnd.djvu
+ * @return array
+ */
+ static function getImageSize( $fileName, $mimeType, &$deja ) {
+ $magic =& MimeMagic::singleton();
+ if( $mimeType == 'image/svg' || $mimeType == 'image/svg+xml' ) {
+ $gis = wfGetSVGsize( $fileName );
+ } elseif( $mimeType == 'image/vnd.djvu' ) {
+ wfSuppressWarnings();
+ $deja = new DjVuImage( $fileName );
+ $gis = $deja->getImageSize();
+ wfRestoreWarnings();
+ } elseif ( !$magic->isPHPImageType( $mimeType ) ) {
+ # Don't try to get the width and height of sound and video files, that's bad for performance
+ $gis = false;
+ } else {
+ wfSuppressWarnings();
+ $gis = getimagesize( $fileName );
+ wfRestoreWarnings();
+ }
+ return $gis;
+ }
-/*
- * 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 ) {
- if( Image::isHashed( $fromSharedDirectory ) ) {
- $hash = md5($dbkey);
- return '/' . $hash{0} . '/' . substr( $hash, 0, 2 ) . '/';
- } else {
- return '/';
+ /**
+ * Get the thumbnail extension and MIME type for a given source MIME type
+ * @return array thumbnail extension and MIME type
+ */
+ static function getThumbType( $ext, $mime ) {
+ switch ( $mime ) {
+ case 'image/svg':
+ case 'image/svg+xml':
+ $ext = 'png';
+ $mime = 'image/png';
+ break;
+ case 'image/vnd.djvu':
+ $ext = $GLOBALS['wgDjvuOutputExtension'];
+ $magic = MimeMagic::singleton();
+ $mime = $magic->guessTypesForExtension( $ext );
+ break;
+ }
+ return array( $ext, $mime );
}
-}
-/**
- * Returns the image URL of an image's old version
- *
- * @param $name String: file name of the image file
- * @param $subdir String: (optional) subdirectory of the image upload directory that is used by the old version. Default is 'archive'
- * @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 {
- $url = $wgUploadPath.'/'.$subdir.'/'.$name;
- }
- return wfUrlencode($url);
-}
+} //class
-/**
- * Return a rounded pixel equivalent for a labeled CSS/SVG length.
- * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
- *
- * @param $length String: CSS/SVG length.
- * @return Integer: 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+(?:\.\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 ) );
+class ArchivedFile
+{
+ /**
+ * Returns a file object from the filearchive table
+ * In the future, all current and old image storage
+ * may use FileStore. There will be a "old" storage
+ * for current and previous file revisions as well as
+ * the "deleted" group for archived revisions
+ * @param $title, the corresponding image page title
+ * @param $id, the image id, a unique key
+ * @param $key, optional storage key
+ * @return ResultWrapper
+ */
+ function ArchivedFile( $title, $id=0, $key='' ) {
+ if( !is_object( $title ) ) {
+ throw new MWException( 'Image constructor given bogus title.' );
+ }
+ $conds = ($id) ? "fa_id = $id" : "fa_storage_key = '$key'";
+ if( $title->getNamespace() == NS_IMAGE ) {
+ $dbr = wfGetDB( DB_SLAVE );
+ $res = $dbr->select( 'filearchive',
+ array(
+ 'fa_id',
+ 'fa_name',
+ 'fa_storage_key',
+ 'fa_storage_group',
+ 'fa_size',
+ 'fa_bits',
+ 'fa_width',
+ 'fa_height',
+ 'fa_metadata',
+ 'fa_media_type',
+ 'fa_major_mime',
+ 'fa_minor_mime',
+ 'fa_description',
+ 'fa_user',
+ 'fa_user_text',
+ 'fa_timestamp',
+ 'fa_deleted' ),
+ array(
+ 'fa_name' => $title->getDbKey(),
+ $conds ),
+ __METHOD__,
+ array( 'ORDER BY' => 'fa_timestamp DESC' ) );
+
+ if ( $dbr->numRows( $res ) == 0 ) {
+ // this revision does not exist?
+ return;
+ }
+ $ret = $dbr->resultObject( $res );
+ $row = $ret->fetchObject();
+
+ // initialize fields for filestore image object
+ $this->mId = intval($row->fa_id);
+ $this->mName = $row->fa_name;
+ $this->mGroup = $row->fa_storage_group;
+ $this->mKey = $row->fa_storage_key;
+ $this->mSize = $row->fa_size;
+ $this->mBits = $row->fa_bits;
+ $this->mWidth = $row->fa_width;
+ $this->mHeight = $row->fa_height;
+ $this->mMetaData = $row->fa_metadata;
+ $this->mMime = "$row->fa_major_mime/$row->fa_minor_mime";
+ $this->mType = $row->fa_media_type;
+ $this->mDescription = $row->fa_description;
+ $this->mUser = $row->fa_user;
+ $this->mUserText = $row->fa_user_text;
+ $this->mTimestamp = $row->fa_timestamp;
+ $this->mDeleted = $row->fa_deleted;
+ } else {
+ throw new MWException( 'This title does not correspond to an image page.' );
+ return;
+ }
+ return true;
}
-}
-/**
- * Compatible with PHP getimagesize()
- * @todo support gzipped SVGZ
- * @todo check XML more carefully
- * @todo sensible defaults
- *
- * @param $filename String: full name of the file (passed to php fopen()).
- * @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 ) ) );
+ /**
+ * int $field one of DELETED_* bitfield constants
+ * for file or revision rows
+ * @return bool
+ */
+ function isDeleted( $field ) {
+ return ($this->mDeleted & $field) == $field;
}
-
- return array( $width, $height, 'SVG',
- "width=\"$width\" height=\"$height\"" );
-}
-
-/**
- * Determine if an image exists on the 'bad image list'.
- *
- * @param $name String: the image name to check
- * @return bool
- */
-function wfIsBadImage( $name ) {
- static $titleList = false;
- if( !$titleList ) {
- # Build the list now
- $titleList = array();
- $lines = explode( "\n", wfMsgForContent( 'bad_image_list' ) );
- foreach( $lines as $line ) {
- if( preg_match( '/^\*\s*\[\[:?(.*?)\]\]/i', $line, $matches ) ) {
- $title = Title::newFromText( $matches[1] );
- if( is_object( $title ) && $title->getNamespace() == NS_IMAGE )
- $titleList[ $title->getDBkey() ] = true;
- }
+ /**
+ * Determine if the current user is allowed to view a particular
+ * field of this FileStore image file, if it's marked as deleted.
+ * @param int $field
+ * @return bool
+ */
+ function userCan( $field ) {
+ if( isset($this->mDeleted) && ($this->mDeleted & $field) == $field ) {
+ // images
+ global $wgUser;
+ $permission = ( $this->mDeleted & Revision::DELETED_RESTRICTED ) == Revision::DELETED_RESTRICTED
+ ? 'hiderevision'
+ : 'deleterevision';
+ wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
+ return $wgUser->isAllowed( $permission );
+ } else {
+ return true;
}
}
- return array_key_exists( $name, $titleList );
}
-
-
/**
* Wrapper class for thumbnail images
- * @package MediaWiki
*/
class ThumbnailImage {
/**
}
/**
- * Calculate the largest thumbnail width for a given original file size
- * such that the thumbnail's height is at most $maxHeight.
- * @param $boxWidth Integer Width of the thumbnail box.
- * @param $boxHeight Integer Height of the thumbnail box.
- * @param $maxHeight Integer Maximum height expected for the thumbnail.
- * @return Integer.
+ * Aliases for backwards compatibility with 1.6
*/
-function wfFitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
- $idealWidth = $boxWidth * $maxHeight / $boxHeight;
- $roundedUp = ceil( $idealWidth );
- if( round( $roundedUp * $boxHeight / $boxWidth ) > $maxHeight )
- return floor( $idealWidth );
- else
- return $roundedUp;
-}
+define( 'MW_IMG_DELETED_FILE', Image::DELETED_FILE );
+define( 'MW_IMG_DELETED_COMMENT', Image::DELETED_COMMENT );
+define( 'MW_IMG_DELETED_USER', Image::DELETED_USER );
+define( 'MW_IMG_DELETED_RESTRICTED', Image::DELETED_RESTRICTED );
?>
dépôts / lhc / web / wiklou.git / blobdiff