Scripts and data used for generating ZhConversion.php
[lhc/web/wiklou.git] / includes / Image.php
index eb9dd8e..036c1e7 100644 (file)
@@ -1,8 +1,16 @@
 <?php
-# Class to represent an image
-# Provides methods to retrieve paths (physical, logical, URL),
-# to generate thumbnails or for uploading.
-
+/**
+ * @package MediaWiki
+ * $Id$
+ */
+
+/**
+ * Class to represent an image
+ * 
+ * Provides methods to retrieve paths (physical, logical, URL),
+ * to generate thumbnails or for uploading.
+ * @package MediaWiki
+ */
 class Image
 {
        /* private */
@@ -23,13 +31,18 @@ class Image
 
        function Image( $name )
        {
-               global $wgUploadDirectory;
+               global $wgUploadDirectory,$wgHashedUploadDirectory;
 
                $this->name      = $name;
-               $this->title     = Title::makeTitle( Namespace::getImage(), $this->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}";
+               if ($wgHashedUploadDirectory) {
+                       $hash            = md5( $this->title->getDBkey() );
+                       $this->imagePath = $wgUploadDirectory . '/' . $hash{0} . '/' .
+                                               substr( $hash, 0, 2 ) . "/{$name}";
+               } else {
+                       $this->imagePath = $wgUploadDirectory . '/' . $name;
+               }
 
                $this->url       = $this->wfImageUrl( $name );
 
@@ -41,8 +54,8 @@ class Image
                                $this->height = $gis[1];
                                $this->type = $gis[2];
                                $this->attr = $gis[3];
-                               if ( isset( $gis["bits"] ) )  {
-                                       $this->bits = $gis["bits"];
+                               if ( isset( $gis['bits'] ) )  {
+                                       $this->bits = $gis['bits'];
                                } else {
                                        $this->bits = 0;
                                }
@@ -63,6 +76,11 @@ class Image
                return $this->name;
        }
 
+       function getTitle()
+       {
+               return $this->title;
+       }
+
        function getURL()
        {
                return $this->url;
@@ -83,6 +101,12 @@ class Image
                return $this->height;
        }
 
+       function getSize()
+       {
+               $st = stat( $this->getImagePath() );
+               return $st['size'];
+       }
+
        function getType()
        {
                return $this->type;
@@ -95,26 +119,32 @@ class Image
 
        function wfImageUrl( $name )
        {
-               global $wgUploadPath;
-               $hash = md5( $name );
-
-               $url = "{$wgUploadPath}/" . $hash{0} . "/" .
-               substr( $hash, 0, 2 ) . "/{$name}";
+               global $wgUploadPath,$wgUploadBaseUrl,$wgHashedUploadDirectory;
+               if ($wgHashedUploadDirectory) {
+                       $hash = md5( $name );
+                       $url = "{$wgUploadBaseUrl}{$wgUploadPath}/" . $hash{0} . "/" .
+                       substr( $hash, 0, 2 ) . "/{$name}";
+               } else {
+                       $url = "{$wgUploadBaseUrl}{$wgUploadPath}/{$name}";
+               }
                return wfUrlencode( $url );
        }
 
-
        function exists()
        {
                return $this->fileExists;
        }
 
-       function thumbUrl( $width, $subdir="thumb" ) {
-               global $wgUploadPath;
-
+       function thumbUrl( $width, $subdir='thumb' ) {
+               global $wgUploadPath,$wgHashedUploadDirectory;
                $name = $this->thumbName( $width );
-               $hash = md5( $name );
-               $url = "{$wgUploadPath}/{$subdir}/" . $hash{0} . "/" . substr( $hash, 0, 2 ) . "/{$name}";
+               if ($wgHashedUploadDirectory) {
+                       $hash = md5( $name );
+                       $url = "{$wgUploadPath}/{$subdir}/" . $hash{0} . "/" . 
+                               substr( $hash, 0, 2 ) . "/{$name}";
+               } else {
+                       $url = "{$wgUploadPath}/{$subdir}/{$name}";
+               }
 
                return wfUrlencode($url);
        }
@@ -123,13 +153,33 @@ class Image
                return $width."px-".$this->name;
        }
 
-       //**********************************************************************
-       // 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.
-       function createThumb( $width ) {
+       function createThumb( $width, $height=-1 ) {
+               if ( $height == -1 ) {
+                       return $this->renderThumb( $width );
+               }
+               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;
+               }
+               return $this->renderThumb( $thumbwidth );
+       }
+               
+       /**
+        * 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 the URL.
+        */
+       function /* private */ renderThumb( $width ) {
                global $wgUploadDirectory;
                global $wgImageMagickConvertCommand;
                global $wgUseImageMagick;
@@ -138,19 +188,19 @@ class Image
                $width = IntVal( $width );
 
                $thumbName = $this->thumbName( $width );
-               $thumbPath = wfImageThumbDir( $thumbName )."/".$thumbName;
+               $thumbPath = wfImageThumbDir( $thumbName ).'/'.$thumbName;
                $thumbUrl  = $this->thumbUrl( $width );
 
                if ( ! $this->exists() )
                {
                        # If there is no image, there will be no thumbnail
-                       return "";
+                       return '';
                }
                
                # Sanity check $width
                if( $width <= 0 ) {
                        # BZZZT
-                       return "";
+                       return '';
                }
 
                if( $width > $this->width ) {
@@ -158,20 +208,13 @@ class Image
                        return $this->getURL();
                }
 
-               if (    (! file_exists( $thumbPath ) )
-                    || ( filemtime($thumbPath) < filemtime($this->imagePath) ) ) {
-                       # Squid purging
-                       if ( $wgUseSquid ) {
-                               $urlArr = Array(
-                                       $wgInternalServer.$thumbUrl
-                               );
-                               wfPurgeSquidServers($urlArr);
-                       }
-
+               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 -geometry {$width} ".
+                                       " -quality 85 -background white -geometry {$width} ".
                                        escapeshellarg($this->imagePath) . " " .
                                        escapeshellarg($thumbPath);
                                $conv = shell_exec( $cmd );
@@ -202,7 +245,7 @@ class Image
                                                $src_image = imagecreatefromxbm( $this->imagePath );
                                                break;
                                        default:
-                                               return "Image type not supported";
+                                               return 'Image type not supported';
                                                break;
                                }
                                $height = floor( $this->height * ( $width/$this->width ) );
@@ -242,27 +285,37 @@ class Image
                        # no disk space is available or some other error occurs
                        #
                        $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);
+                       }
                }
                return $thumbUrl;
        } // END OF function createThumb
 
-       //**********************************************************************
-       // Return the image history of this image, line by line.
-       // starts with current version, then old versions.
-       // uses $this->historyLine to check which line to return:
-       //  0      return line for current version
-       //  1      query for old versions, return first one
-       //  2, ... return next old version from above query
+       /**
+        * Return the image history of this image, line by line.
+        * starts with current version, then old versions.
+        * uses $this->historyLine to check which line to return:
+        *  0      return line for current version
+        *  1      query for old versions, return first one
+        *  2, ... return next old version from above query
+        */
        function nextHistoryLine()
        {
-               $fname = "Image::nextHistoryLine()";
+               $fname = 'Image::nextHistoryLine()';
+               $dbr =& wfGetDB( DB_SLAVE );
                if ( $this->historyLine == 0 ) {// called for the first time, return line from cur 
-                       $dbr =& wfGetDB( DB_READ );
                        $this->historyRes = $dbr->select( 'image', 
                                array( 'img_size','img_description','img_user','img_user_text','img_timestamp', "'' AS oi_archive_name" ), 
                                array( 'img_name' => $this->title->getDBkey() ),
@@ -272,7 +325,6 @@ class Image
                                return FALSE; 
                        }
                } else if ( $this->historyLine == 1 ) {
-                       $dbr =& wfGetDB( DB_READ );
                        $this->historyRes = $dbr->select( 'oldimage', 
                                array( 'oi_size AS img_size', 'oi_description AS img_description', 'oi_user AS img_user',
                                        'oi_user_text AS img_user_text', 'oi_timestamp AS img_timestamp', 'oi_archive_name'
@@ -281,7 +333,7 @@ class Image
                }
                $this->historyLine ++;
 
-               return wfFetchObject( $this->historyRes );
+               return $dbr->fetchObject( $this->historyRes );
        }
 
        function resetHistory()
@@ -292,3 +344,175 @@ class Image
 
 } //class
 
+
+function wfImageDir( $fname )
+{
+       global $wgUploadDirectory, $wgHashedUploadDirectory;
+       
+       if (!$wgHashedUploadDirectory) { return $wgUploadDirectory; }
+
+       $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 ); }
+
+       umask( $oldumask );
+       return $dest;
+}
+
+function wfImageThumbDir( $fname , $subdir='thumb')
+{
+       return wfImageArchiveDir( $fname, $subdir );
+}
+
+function wfImageArchiveDir( $fname , $subdir='archive')
+{
+       global $wgUploadDirectory, $wgHashedUploadDirectory;
+
+       if (!$wgHashedUploadDirectory) { return $wgUploadDirectory.'/'.$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 ); }
+       $archive .= '/' . $hash{0};
+       if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
+       $archive .= '/' . substr( $hash, 0, 2 );
+       if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
+
+       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 );
+
+                       $u = new SearchUpdate( $id, $name, $desc );
+                       $u->doUpdate();
+               }
+       } 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' );
+
+               # 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
+               );
+
+               # 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
+               );
+
+               # Invalidate the cache for the description page
+               $descTitle->invalidateCache();
+       }
+
+       $log = new LogPage( 'upload' );
+       $log->addEntry( 'upload', $descTitle, $desc );
+}
+
+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);
+}
+
+?>