]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/imagefile.php
Properly unlink all old avatars when deleting/uploading a new
[quix0rs-gnu-social.git] / lib / imagefile.php
index 6bc8e599b3022f7aa29d9c80045157989f627293..ae14654bfbdce81a91ed1c56cc248e047362bdb3 100644 (file)
@@ -60,6 +60,20 @@ class ImageFile
         $this->filepath = $filepath;
 
         $info = @getimagesize($this->filepath);
+
+        if (!(
+            ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
+            ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
+            $info[2] == IMAGETYPE_BMP ||
+            ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
+            ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
+            ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
+
+            // TRANS: Exception thrown when trying to upload an unsupported image file format.
+            throw new Exception(_('Unsupported image file format.'));
+            return;
+        }
+
         $this->type = ($info) ? $info[2]:$type;
         $this->width = ($info) ? $info[0]:$width;
         $this->height = ($info) ? $info[1]:$height;
@@ -72,11 +86,14 @@ class ImageFile
             break;
          case UPLOAD_ERR_INI_SIZE:
          case UPLOAD_ERR_FORM_SIZE:
+            // TRANS: Exception thrown when too large a file is uploaded.
+            // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
             throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'),
                 ImageFile::maxFileSize()));
             return;
          case UPLOAD_ERR_PARTIAL:
             @unlink($_FILES[$param]['tmp_name']);
+            // TRANS: Exception thrown when uploading an image and that action could not be completed.
             throw new Exception(_('Partial upload.'));
             return;
          case UPLOAD_ERR_NO_FILE:
@@ -85,6 +102,7 @@ class ImageFile
          default:
             common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
                 $_FILES[$param]['error']);
+            // TRANS: Exception thrown when uploading an image fails for an unknown reason.
             throw new Exception(_('System error uploading file.'));
             return;
         }
@@ -93,47 +111,85 @@ class ImageFile
 
         if (!$info) {
             @unlink($_FILES[$param]['tmp_name']);
+            // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
             throw new Exception(_('Not an image or corrupt file.'));
             return;
         }
 
-        if ($info[2] !== IMAGETYPE_GIF &&
-            $info[2] !== IMAGETYPE_JPEG &&
-            $info[2] !== IMAGETYPE_PNG) {
-
-            @unlink($_FILES[$param]['tmp_name']);
-            throw new Exception(_('Unsupported image file format.'));
-            return;
-        }
-
         return new ImageFile(null, $_FILES[$param]['tmp_name']);
     }
 
+    /**
+     * Compat interface for old code generating avatar thumbnails...
+     * Saves the scaled file directly into the avatar area.
+     *
+     * @param int $size target width & height -- must be square
+     * @param int $x (default 0) upper-left corner to crop from
+     * @param int $y (default 0) upper-left corner to crop from
+     * @param int $w (default full) width of image area to crop
+     * @param int $h (default full) height of image area to crop
+     * @return string filename
+     */
     function resize($size, $x = 0, $y = 0, $w = null, $h = null)
+    {
+        $targetType = $this->preferredType();
+        $outname = Avatar::filename($this->id,
+                                    image_type_to_extension($targetType),
+                                    $size,
+                                    common_timestamp());
+        $outpath = Avatar::path($outname);
+        $this->resizeTo($outpath, $size, $size, $x, $y, $w, $h);
+        return $outname;
+    }
+
+    /**
+     * Copy the image file to the given destination.
+     * For obscure formats, this will automatically convert to PNG;
+     * otherwise the original file will be copied as-is.
+     *
+     * @param string $outpath
+     * @return string filename
+     */
+    function copyTo($outpath)
+    {
+        return $this->resizeTo($outpath, $this->width, $this->height);
+    }
+
+    /**
+     * Create and save a thumbnail image.
+     *
+     * @param string $outpath
+     * @param int $width target width
+     * @param int $height target height
+     * @param int $x (default 0) upper-left corner to crop from
+     * @param int $y (default 0) upper-left corner to crop from
+     * @param int $w (default full) width of image area to crop
+     * @param int $h (default full) height of image area to crop
+     * @return string full local filesystem filename
+     */
+    function resizeTo($outpath, $width, $height, $x=0, $y=0, $w=null, $h=null)
     {
         $w = ($w === null) ? $this->width:$w;
         $h = ($h === null) ? $this->height:$h;
+        $targetType = $this->preferredType();
 
         if (!file_exists($this->filepath)) {
+            // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
             throw new Exception(_('Lost our file.'));
             return;
         }
 
         // Don't crop/scale if it isn't necessary
-        if ($size === $this->width
-            && $size === $this->height
+        if ($width === $this->width
+            && $height === $this->height
             && $x === 0
             && $y === 0
             && $w === $this->width
-            && $h === $this->height) {
+            && $h === $this->height
+            && $this->type == $targetType) {
 
-            $outname = Avatar::filename($this->id,
-                                        image_type_to_extension($this->type),
-                                        $size,
-                                        common_timestamp());
-            $outpath = Avatar::path($outname);
             @copy($this->filepath, $outpath);
-            return $outname;
+            return $outpath;
         }
 
         switch ($this->type) {
@@ -146,14 +202,24 @@ class ImageFile
          case IMAGETYPE_PNG:
             $image_src = imagecreatefrompng($this->filepath);
             break;
+         case IMAGETYPE_BMP:
+            $image_src = imagecreatefrombmp($this->filepath);
+            break;
+         case IMAGETYPE_WBMP:
+            $image_src = imagecreatefromwbmp($this->filepath);
+            break;
+         case IMAGETYPE_XBM:
+            $image_src = imagecreatefromxbm($this->filepath);
+            break;
          default:
+            // TRANS: Exception thrown when trying to resize an unknown file type.
             throw new Exception(_('Unknown file type'));
             return;
         }
 
-        $image_dest = imagecreatetruecolor($size, $size);
+        $image_dest = imagecreatetruecolor($width, $height);
 
-        if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG) {
+        if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
 
             $transparent_idx = imagecolortransparent($image_src);
 
@@ -174,26 +240,20 @@ class ImageFile
             }
         }
 
-        imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $size, $size, $w, $h);
+        imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $width, $height, $w, $h);
 
-        $outname = Avatar::filename($this->id,
-                                    image_type_to_extension($this->type),
-                                    $size,
-                                    common_timestamp());
-
-        $outpath = Avatar::path($outname);
-
-        switch ($this->type) {
+        switch ($targetType) {
          case IMAGETYPE_GIF:
             imagegif($image_dest, $outpath);
             break;
          case IMAGETYPE_JPEG:
-            imagejpeg($image_dest, $outpath, 100);
+            imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
             break;
          case IMAGETYPE_PNG:
             imagepng($image_dest, $outpath);
             break;
          default:
+            // TRANS: Exception thrown when trying resize an unknown file type.
             throw new Exception(_('Unknown file type'));
             return;
         }
@@ -201,7 +261,31 @@ class ImageFile
         imagedestroy($image_src);
         imagedestroy($image_dest);
 
-        return $outname;
+        return $outpath;
+    }
+
+    /**
+     * Several obscure file types should be normalized to PNG on resize.
+     *
+     * @fixme consider flattening anything not GIF or JPEG to PNG
+     * @return int
+     */
+    function preferredType()
+    {
+        if($this->type == IMAGETYPE_BMP) {
+            //we don't want to save BMP... it's an inefficient, rare, antiquated format
+            //save png instead
+            return IMAGETYPE_PNG;
+        } else if($this->type == IMAGETYPE_WBMP) {
+            //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
+            //save png instead
+            return IMAGETYPE_PNG;
+        } else if($this->type == IMAGETYPE_XBM) {
+            //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
+            //save png instead
+            return IMAGETYPE_PNG;
+        }
+        return $this->type;
     }
 
     function unlink()
@@ -214,11 +298,16 @@ class ImageFile
         $value = ImageFile::maxFileSizeInt();
 
         if ($value > 1024 * 1024) {
-            return ($value/(1024*1024)) . _('MB');
+            $value = $value/(1024*1024);
+            // TRANS: Number of megabytes. %d is the number.
+            return sprintf(_m('%dMB','%dMB',$value),$value);
         } else if ($value > 1024) {
-            return ($value/(1024)) . _('kB');
+            $value = $value/1024;
+            // TRANS: Number of kilobytes. %d is the number.
+            return sprintf(_m('%dkB','%dkB',$value),$value);
         } else {
-            return $value;
+            // TRANS: Number of bytes. %d is the number.
+            return sprintf(_m('%dB','%dB',$value),$value);
         }
     }
 
@@ -245,4 +334,101 @@ class ImageFile
 
         return $num;
     }
-}
\ No newline at end of file
+}
+
+//PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
+if(!function_exists('imagecreatefrombmp')){
+    //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
+    function imagecreatefrombmp($p_sFile)
+    {
+        //    Load the image into a string
+        $file    =    fopen($p_sFile,"rb");
+        $read    =    fread($file,10);
+        while(!feof($file)&&($read<>""))
+            $read    .=    fread($file,1024);
+
+        $temp    =    unpack("H*",$read);
+        $hex    =    $temp[1];
+        $header    =    substr($hex,0,108);
+
+        //    Process the header
+        //    Structure: http://www.fastgraph.com/help/bmp_header_format.html
+        if (substr($header,0,4)=="424d")
+        {
+            //    Cut it in parts of 2 bytes
+            $header_parts    =    str_split($header,2);
+
+            //    Get the width        4 bytes
+            $width            =    hexdec($header_parts[19].$header_parts[18]);
+
+            //    Get the height        4 bytes
+            $height            =    hexdec($header_parts[23].$header_parts[22]);
+
+            //    Unset the header params
+            unset($header_parts);
+        }
+
+        //    Define starting X and Y
+        $x                =    0;
+        $y                =    1;
+
+        //    Create newimage
+        $image            =    imagecreatetruecolor($width,$height);
+
+        //    Grab the body from the image
+        $body            =    substr($hex,108);
+
+        //    Calculate if padding at the end-line is needed
+        //    Divided by two to keep overview.
+        //    1 byte = 2 HEX-chars
+        $body_size        =    (strlen($body)/2);
+        $header_size    =    ($width*$height);
+
+        //    Use end-line padding? Only when needed
+        $usePadding        =    ($body_size>($header_size*3)+4);
+
+        //    Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
+        //    Calculate the next DWORD-position in the body
+        for ($i=0;$i<$body_size;$i+=3)
+        {
+            //    Calculate line-ending and padding
+            if ($x>=$width)
+            {
+                //    If padding needed, ignore image-padding
+                //    Shift i to the ending of the current 32-bit-block
+                if ($usePadding)
+                    $i    +=    $width%4;
+
+                //    Reset horizontal position
+                $x    =    0;
+
+                //    Raise the height-position (bottom-up)
+                $y++;
+
+                //    Reached the image-height? Break the for-loop
+                if ($y>$height)
+                    break;
+            }
+
+            //    Calculation of the RGB-pixel (defined as BGR in image-data)
+            //    Define $i_pos as absolute position in the body
+            $i_pos    =    $i*2;
+            $r        =    hexdec($body[$i_pos+4].$body[$i_pos+5]);
+            $g        =    hexdec($body[$i_pos+2].$body[$i_pos+3]);
+            $b        =    hexdec($body[$i_pos].$body[$i_pos+1]);
+
+            //    Calculate and draw the pixel
+            $color    =    imagecolorallocate($image,$r,$g,$b);
+            imagesetpixel($image,$x,$height-$y,$color);
+
+            //    Raise the horizontal position
+            $x++;
+        }
+
+        //    Unset the body / free the memory
+        unset($body);
+
+        //    Return image-object
+        return $image;
+    }
+}