2 # Class to represent an image
3 # Provides methods to retrieve paths (physical, logical, URL),
4 # to generate thumbnails or for uploading.
9 var $name, # name of the image
10 $imagePath, # Path of the image
12 $title, # Title object for this image. Initialized when needed.
13 $fileExists, # does the image file exist on disk?
14 $historyLine, # Number of line to return by nextHistoryLine()
15 $historyRes, # result of the query for the image's history
18 $bits, # --- returned by getimagesize, see http://de3.php.net/manual/en/function.getimagesize.php
24 function Image( $name )
26 global $wgUploadDirectory;
29 $this->title
= Title
::makeTitle( Namespace::getImage(), $this->name
);
30 //$this->imagePath = wfImagePath( $name );
31 $hash = md5( $this->title
->getDBkey() );
32 $this->imagePath
= $wgUploadDirectory . "/" . $hash{0} . "/" .substr( $hash, 0, 2 ) . "/{$name}";
34 $this->url
= $this->wfImageUrl( $name );
36 if ( $this->fileExists
= file_exists( $this->imagePath
) ) // Sic!, "=" is intended
38 @$gis = getimagesize( $this->imagePath
);
39 if( $gis !== false ) {
40 $this->width
= $gis[0];
41 $this->height
= $gis[1];
42 $this->type
= $gis[2];
43 $this->attr
= $gis[3];
44 if ( isset( $gis["bits"] ) ) {
45 $this->bits
= $gis["bits"];
51 $this->historyLine
= 0;
54 function newFromTitle( $nt )
56 $img = new Image( $nt->getDBKey() );
71 function getImagePath()
73 return $this->imagePath
;
91 function getEscapeLocalURL()
93 return $this->title
->escapeLocalURL();
96 function wfImageUrl( $name )
101 $url = "{$wgUploadPath}/" . $hash{0} . "/" .
102 substr( $hash, 0, 2 ) . "/{$name}";
103 return wfUrlencode( $url );
109 return $this->fileExists
;
112 function thumbUrl( $width, $subdir="thumb" ) {
113 global $wgUploadPath;
115 $name = $this->thumbName( $width );
116 $hash = md5( $name );
117 $url = "{$wgUploadPath}/{$subdir}/" . $hash{0} . "/" . substr( $hash, 0, 2 ) . "/{$name}";
119 return wfUrlencode($url);
122 function thumbName( $width ) {
123 return $width."px-".$this->name
;
126 //**********************************************************************
127 // Create a thumbnail of the image having the specified width.
128 // The thumbnail will not be created if the width is larger than the
129 // image's width. Let the browser do the scaling in this case.
130 // The thumbnail is stored on disk and is only computed if the thumbnail
131 // file does not exist OR if it is older than the image.
133 function createThumb( $width ) {
134 global $wgUploadDirectory;
135 global $wgImageMagickConvertCommand;
136 global $wgUseImageMagick;
137 global $wgUseSquid, $wgInternalServer;
139 $width = IntVal( $width );
141 $thumbName = $this->thumbName( $width );
142 $thumbPath = wfImageThumbDir( $thumbName )."/".$thumbName;
143 $thumbUrl = $this->thumbUrl( $width );
145 if ( ! $this->exists() )
147 # If there is no image, there will be no thumbnail
151 # Sanity check $width
157 if( $width > $this->width
) {
158 # Don't make an image bigger than the source
159 return $this->getURL();
162 if ( (! file_exists( $thumbPath ) ) ||
( filemtime($thumbPath) < filemtime($this->imagePath
) ) ) {
163 if ( $wgUseImageMagick ) {
165 # Specify white background color, will be used for transparent images
166 # in Internet Explorer/Windows instead of default black.
167 $cmd = $wgImageMagickConvertCommand .
168 " -quality 85 -background white -geometry {$width} ".
169 escapeshellarg($this->imagePath
) . " " .
170 escapeshellarg($thumbPath);
171 $conv = shell_exec( $cmd );
173 # Use PHP's builtin GD library functions.
175 # First find out what kind of file this is, and select the correct
176 # input routine for this.
180 switch( $this->type
) {
182 $src_image = imagecreatefromgif( $this->imagePath
);
185 $src_image = imagecreatefromjpeg( $this->imagePath
);
189 $src_image = imagecreatefrompng( $this->imagePath
);
190 $truecolor = ( $this->bits
> 8 );
192 case 15: # WBMP for WML
193 $src_image = imagecreatefromwbmp( $this->imagePath
);
196 $src_image = imagecreatefromxbm( $this->imagePath
);
199 return "Image type not supported";
202 $height = floor( $this->height
* ( $width/$this->width
) );
204 $dst_image = imagecreatetruecolor( $width, $height );
206 $dst_image = imagecreate( $width, $height );
208 imagecopyresampled( $dst_image, $src_image,
210 $width, $height, $this->width
, $this->height
);
211 switch( $this->type
) {
216 #$thumbUrl .= ".png";
217 #$thumbPath .= ".png";
218 imagepng( $dst_image, $thumbPath );
221 #$thumbUrl .= ".jpg";
222 #$thumbPath .= ".jpg";
223 imageinterlace( $dst_image );
224 imagejpeg( $dst_image, $thumbPath, 95 );
229 imagedestroy( $dst_image );
230 imagedestroy( $src_image );
235 # Check for zero-sized thumbnails. Those can be generated when
236 # no disk space is available or some other error occurs
238 $thumbstat = stat( $thumbPath );
239 if( $thumbstat["size"] == 0 )
241 unlink( $thumbPath );
245 # This has to be done after the image is updated and present for all machines on NFS,
246 # or else the old version might be stored into the squid again
249 $wgInternalServer.$thumbUrl
251 wfPurgeSquidServers($urlArr);
255 } // END OF function createThumb
257 //**********************************************************************
258 // Return the image history of this image, line by line.
259 // starts with current version, then old versions.
260 // uses $this->historyLine to check which line to return:
261 // 0 return line for current version
262 // 1 query for old versions, return first one
263 // 2, ... return next old version from above query
264 function nextHistoryLine()
266 $fname = "Image::nextHistoryLine()";
267 $dbr =& wfGetDB( DB_SLAVE
);
268 if ( $this->historyLine
== 0 ) {// called for the first time, return line from cur
269 $this->historyRes
= $dbr->select( 'image',
270 array( 'img_size','img_description','img_user','img_user_text','img_timestamp', "'' AS oi_archive_name" ),
271 array( 'img_name' => $this->title
->getDBkey() ),
274 if ( 0 == wfNumRows( $this->historyRes
) ) {
277 } else if ( $this->historyLine
== 1 ) {
278 $this->historyRes
= $dbr->select( 'oldimage',
279 array( 'oi_size AS img_size', 'oi_description AS img_description', 'oi_user AS img_user',
280 'oi_user_text AS img_user_text', 'oi_timestamp AS img_timestamp', 'oi_archive_name'
281 ), array( 'oi_name' => $this->title
->getDBkey() ), $fname, array( 'ORDER BY' => 'oi_timestamp DESC' )
284 $this->historyLine ++
;
286 return $dbr->fetchObject( $this->historyRes
);
289 function resetHistory()
291 $this->historyLine
= 0;
298 function wfImageDir( $fname )
300 global $wgUploadDirectory;
302 $hash = md5( $fname );
303 $oldumask = umask(0);
304 $dest = $wgUploadDirectory . '/' . $hash{0};
305 if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
306 $dest .= '/' . substr( $hash, 0, 2 );
307 if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
313 function wfImageThumbDir( $fname , $subdir='thumb')
315 return wfImageArchiveDir( $fname, $subdir );
318 function wfImageArchiveDir( $fname , $subdir='archive')
320 global $wgUploadDirectory;
322 $hash = md5( $fname );
323 $oldumask = umask(0);
325 # Suppress warning messages here; if the file itself can't
326 # be written we'll worry about it then.
327 $archive = "{$wgUploadDirectory}/{$subdir}";
328 if ( ! is_dir( $archive ) ) { @mkdir
( $archive, 0777 ); }
329 $archive .= '/' . $hash{0};
330 if ( ! is_dir( $archive ) ) { @mkdir
( $archive, 0777 ); }
331 $archive .= '/' . substr( $hash, 0, 2 );
332 if ( ! is_dir( $archive ) ) { @mkdir
( $archive, 0777 ); }
338 function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
340 global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
341 global $wgUseCopyrightUpload;
343 $fname = 'wfRecordUpload';
344 $dbw =& wfGetDB( DB_MASTER
);
346 # img_name must be unique
347 if ( !$dbw->indexUnique( 'image', 'img_name' ) ) {
348 wfDebugDieBacktrace( 'Database schema not up to date, please run maintenance/archives/patch-image_name_unique.sql' );
352 $now = wfTimestampNow();
353 $won = wfInvertTimestamp( $now );
354 $size = IntVal( $size );
356 if ( $wgUseCopyrightUpload )
358 $textdesc = '== ' . wfMsg ( 'filedesc' ) . " ==\n" . $desc . "\n" .
359 '== ' . wfMsg ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
360 '== ' . wfMsg ( 'filesource' ) . " ==\n" . $source ;
362 else $textdesc = $desc ;
364 $now = wfTimestampNow();
365 $won = wfInvertTimestamp( $now );
367 # Test to see if the row exists using INSERT IGNORE
368 # This avoids race conditions by locking the row until the commit, and also
369 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
370 $dbw->insert( 'image',
374 'img_timestamp' => $now,
375 'img_description' => $desc,
376 'img_user' => $wgUser->getID(),
377 'img_user_text' => $wgUser->getName(),
380 $descTitle = Title
::makeTitle( NS_IMAGE
, $name );
382 if ( $dbw->affectedRows() ) {
383 # Successfully inserted, this is a new image
384 $id = $descTitle->getArticleID();
387 $seqVal = $dbw->nextSequenceValue( 'cur_cur_id_seq' );
388 $dbw->insertArray( 'cur',
391 'cur_namespace' => NS_IMAGE
,
392 'cur_title' => $name,
393 'cur_comment' => $desc,
394 'cur_user' => $wgUser->getID(),
395 'cur_user_text' => $wgUser->getName(),
396 'cur_timestamp' => $now,
398 'cur_text' => $textdesc,
399 'inverse_timestamp' => $won,
400 'cur_touched' => $now
403 $id = $dbw->insertId() or 0; # We should throw an error instead
405 RecentChange
::notifyNew( $now, $descTitle, 0, $wgUser, $desc );
407 $u = new SearchUpdate( $id, $name, $desc );
411 # Collision, this is an update of an image
412 # Get current image row for update
413 $s = $dbw->getArray( 'image', array( 'img_name','img_size','img_timestamp','img_description',
414 'img_user','img_user_text' ), array( 'img_name' => $name ), $fname, 'FOR UPDATE' );
416 # Insert it into oldimage
417 $dbw->insertArray( 'oldimage',
419 'oi_name' => $s->img_name
,
420 'oi_archive_name' => $oldver,
421 'oi_size' => $s->img_size
,
422 'oi_timestamp' => $s->img_timestamp
,
423 'oi_description' => $s->img_description
,
424 'oi_user' => $s->img_user
,
425 'oi_user_text' => $s->img_user_text
429 # Update the current image row
430 $dbw->updateArray( 'image',
433 'img_timestamp' => wfTimestampNow(),
434 'img_user' => $wgUser->getID(),
435 'img_user_text' => $wgUser->getName(),
436 'img_description' => $desc,
437 ), array( /* WHERE */
442 # Invalidate the cache for the description page
443 $descTitle->invalidateCache();
446 $log = new LogPage( wfMsg( 'uploadlogpage' ), wfMsg( 'uploadlogpagetext' ) );
447 $da = wfMsg( 'uploadedimage', '[[:' . $wgLang->getNsText(
448 Namespace::getImage() ) . ":{$name}|{$name}]]" );
449 $ta = wfMsg( 'uploadedimage', $name );
450 $log->addEntry( $da, $desc, $ta );
453 function wfImageArchiveUrl( $name )
455 global $wgUploadPath;
457 $hash = md5( substr( $name, 15) );
458 $url = "{$wgUploadPath}/archive/" . $hash{0} . "/" .
459 substr( $hash, 0, 2 ) . "/{$name}";
460 return wfUrlencode($url);