lib/imagefile.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Abstraction for an image file
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Image
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * A wrapper on uploaded files
  37  *
  38  * Makes it slightly easier to accept an image file from upload.
  39  *
  40  * @category Image
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47
  48 class ImageFile
  49 {
  50     var $id;
  51     var $filepath;
  52     var $barename;
  53     var $type;
  54     var $height;
  55     var $width;
  56
  57     function __construct($id=null, $filepath=null, $type=null, $width=null, $height=null)
  58     {
  59         $this->id = $id;
  60         $this->filepath = $filepath;
  61
  62         $info = @getimagesize($this->filepath);
  63
  64         if (!(
  65             ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
  66             ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
  67             $info[2] == IMAGETYPE_BMP ||
  68             ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
  69             ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
  70             ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
  71
  72             throw new Exception(_('Unsupported image file format.'));
  73             return;
  74         }
  75
  76         $this->type = ($info) ? $info[2]:$type;
  77         $this->width = ($info) ? $info[0]:$width;
  78         $this->height = ($info) ? $info[1]:$height;
  79     }
  80
  81     static function fromUpload($param='upload')
  82     {
  83         switch ($_FILES[$param]['error']) {
  84          case UPLOAD_ERR_OK: // success, jump out
  85             break;
  86          case UPLOAD_ERR_INI_SIZE:
  87          case UPLOAD_ERR_FORM_SIZE:
  88             // TRANS: Exception thrown when too large a file is uploaded.
  89             // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
  90             throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'),
  91                 ImageFile::maxFileSize()));
  92             return;
  93          case UPLOAD_ERR_PARTIAL:
  94             @unlink($_FILES[$param]['tmp_name']);
  95             throw new Exception(_('Partial upload.'));
  96             return;
  97          case UPLOAD_ERR_NO_FILE:
  98             // No file; probably just a non-AJAX submission.
  99             return;
 100          default:
 101             common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
 102                 $_FILES[$param]['error']);
 103             throw new Exception(_('System error uploading file.'));
 104             return;
 105         }
 106
 107         $info = @getimagesize($_FILES[$param]['tmp_name']);
 108
 109         if (!$info) {
 110             @unlink($_FILES[$param]['tmp_name']);
 111             throw new Exception(_('Not an image or corrupt file.'));
 112             return;
 113         }
 114
 115         return new ImageFile(null, $_FILES[$param]['tmp_name']);
 116     }
 117
 118     function resize($size, $x = 0, $y = 0, $w = null, $h = null)
 119     {
 120         $w = ($w === null) ? $this->width:$w;
 121         $h = ($h === null) ? $this->height:$h;
 122
 123         if (!file_exists($this->filepath)) {
 124             throw new Exception(_('Lost our file.'));
 125             return;
 126         }
 127
 128         // Don't crop/scale if it isn't necessary
 129         if ($size === $this->width
 130             && $size === $this->height
 131             && $x === 0
 132             && $y === 0
 133             && $w === $this->width
 134             && $h === $this->height) {
 135
 136             $outname = Avatar::filename($this->id,
 137                                         image_type_to_extension($this->type),
 138                                         $size,
 139                                         common_timestamp());
 140             $outpath = Avatar::path($outname);
 141             @copy($this->filepath, $outpath);
 142             return $outname;
 143         }
 144
 145         switch ($this->type) {
 146          case IMAGETYPE_GIF:
 147             $image_src = imagecreatefromgif($this->filepath);
 148             break;
 149          case IMAGETYPE_JPEG:
 150             $image_src = imagecreatefromjpeg($this->filepath);
 151             break;
 152          case IMAGETYPE_PNG:
 153             $image_src = imagecreatefrompng($this->filepath);
 154             break;
 155          case IMAGETYPE_BMP:
 156             $image_src = imagecreatefrombmp($this->filepath);
 157             break;
 158          case IMAGETYPE_WBMP:
 159             $image_src = imagecreatefromwbmp($this->filepath);
 160             break;
 161          case IMAGETYPE_XBM:
 162             $image_src = imagecreatefromxbm($this->filepath);
 163             break;
 164          default:
 165             throw new Exception(_('Unknown file type'));
 166             return;
 167         }
 168
 169         $image_dest = imagecreatetruecolor($size, $size);
 170
 171         if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
 172
 173             $transparent_idx = imagecolortransparent($image_src);
 174
 175             if ($transparent_idx >= 0) {
 176
 177                 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
 178                 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
 179                 imagefill($image_dest, 0, 0, $transparent_idx);
 180                 imagecolortransparent($image_dest, $transparent_idx);
 181
 182             } elseif ($this->type == IMAGETYPE_PNG) {
 183
 184                 imagealphablending($image_dest, false);
 185                 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
 186                 imagefill($image_dest, 0, 0, $transparent);
 187                 imagesavealpha($image_dest, true);
 188
 189             }
 190         }
 191
 192         imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $size, $size, $w, $h);
 193
 194         if($this->type == IMAGETYPE_BMP) {
 195             //we don't want to save BMP... it's an inefficient, rare, antiquated format
 196             //save png instead
 197             $this->type = IMAGETYPE_PNG;
 198         } else if($this->type == IMAGETYPE_WBMP) {
 199             //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
 200             //save png instead
 201             $this->type = IMAGETYPE_PNG;
 202         } else if($this->type == IMAGETYPE_XBM) {
 203             //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
 204             //save png instead
 205             $this->type = IMAGETYPE_PNG;
 206         }
 207
 208         $outname = Avatar::filename($this->id,
 209                                     image_type_to_extension($this->type),
 210                                     $size,
 211                                     common_timestamp());
 212
 213         $outpath = Avatar::path($outname);
 214
 215         switch ($this->type) {
 216          case IMAGETYPE_GIF:
 217             imagegif($image_dest, $outpath);
 218             break;
 219          case IMAGETYPE_JPEG:
 220             imagejpeg($image_dest, $outpath, 100);
 221             break;
 222          case IMAGETYPE_PNG:
 223             imagepng($image_dest, $outpath);
 224             break;
 225          default:
 226             throw new Exception(_('Unknown file type'));
 227             return;
 228         }
 229
 230         imagedestroy($image_src);
 231         imagedestroy($image_dest);
 232
 233         return $outname;
 234     }
 235
 236     function unlink()
 237     {
 238         @unlink($this->filename);
 239     }
 240
 241     static function maxFileSize()
 242     {
 243         $value = ImageFile::maxFileSizeInt();
 244
 245         if ($value > 1024 * 1024) {
 246             $value = $value/(1024*1024);
 247             // TRANS: Number of megabytes. %d is the number.
 248             return sprintf(_m('%dMB','%dMB',$value),$value);
 249         } else if ($value > 1024) {
 250             $value = $value/1024;
 251             // TRANS: Number of kilobytes. %d is the number.
 252             return sprintf(_m('%dkB','%dkB',$value),$value);
 253         } else {
 254             // TRANS: Number of bytes. %d is the number.
 255             return sprintf(_m('%dB','%dB',$value),$value);
 256         }
 257     }
 258
 259     static function maxFileSizeInt()
 260     {
 261         return min(ImageFile::strToInt(ini_get('post_max_size')),
 262                    ImageFile::strToInt(ini_get('upload_max_filesize')),
 263                    ImageFile::strToInt(ini_get('memory_limit')));
 264     }
 265
 266     static function strToInt($str)
 267     {
 268         $unit = substr($str, -1);
 269         $num = substr($str, 0, -1);
 270
 271         switch(strtoupper($unit)){
 272          case 'G':
 273             $num *= 1024;
 274          case 'M':
 275             $num *= 1024;
 276          case 'K':
 277             $num *= 1024;
 278         }
 279
 280         return $num;
 281     }
 282 }
 283
 284 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
 285 if(!function_exists('imagecreatefrombmp')){
 286     //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
 287     function imagecreatefrombmp($p_sFile)
 288     {
 289         //    Load the image into a string
 290         $file    =    fopen($p_sFile,"rb");
 291         $read    =    fread($file,10);
 292         while(!feof($file)&&($read<>""))
 293             $read    .=    fread($file,1024);
 294
 295         $temp    =    unpack("H*",$read);
 296         $hex    =    $temp[1];
 297         $header    =    substr($hex,0,108);
 298
 299         //    Process the header
 300         //    Structure: http://www.fastgraph.com/help/bmp_header_format.html
 301         if (substr($header,0,4)=="424d")
 302         {
 303             //    Cut it in parts of 2 bytes
 304             $header_parts    =    str_split($header,2);
 305
 306             //    Get the width        4 bytes
 307             $width            =    hexdec($header_parts[19].$header_parts[18]);
 308
 309             //    Get the height        4 bytes
 310             $height            =    hexdec($header_parts[23].$header_parts[22]);
 311
 312             //    Unset the header params
 313             unset($header_parts);
 314         }
 315
 316         //    Define starting X and Y
 317         $x                =    0;
 318         $y                =    1;
 319
 320         //    Create newimage
 321         $image            =    imagecreatetruecolor($width,$height);
 322
 323         //    Grab the body from the image
 324         $body            =    substr($hex,108);
 325
 326         //    Calculate if padding at the end-line is needed
 327         //    Divided by two to keep overview.
 328         //    1 byte = 2 HEX-chars
 329         $body_size        =    (strlen($body)/2);
 330         $header_size    =    ($width*$height);
 331
 332         //    Use end-line padding? Only when needed
 333         $usePadding        =    ($body_size>($header_size*3)+4);
 334
 335         //    Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
 336         //    Calculate the next DWORD-position in the body
 337         for ($i=0;$i<$body_size;$i+=3)
 338         {
 339             //    Calculate line-ending and padding
 340             if ($x>=$width)
 341             {
 342                 //    If padding needed, ignore image-padding
 343                 //    Shift i to the ending of the current 32-bit-block
 344                 if ($usePadding)
 345                     $i    +=    $width%4;
 346
 347                 //    Reset horizontal position
 348                 $x    =    0;
 349
 350                 //    Raise the height-position (bottom-up)
 351                 $y++;
 352
 353                 //    Reached the image-height? Break the for-loop
 354                 if ($y>$height)
 355                     break;
 356             }
 357
 358             //    Calculation of the RGB-pixel (defined as BGR in image-data)
 359             //    Define $i_pos as absolute position in the body
 360             $i_pos    =    $i*2;
 361             $r        =    hexdec($body[$i_pos+4].$body[$i_pos+5]);
 362             $g        =    hexdec($body[$i_pos+2].$body[$i_pos+3]);
 363             $b        =    hexdec($body[$i_pos].$body[$i_pos+1]);
 364
 365             //    Calculate and draw the pixel
 366             $color    =    imagecolorallocate($image,$r,$g,$b);
 367             imagesetpixel($image,$x,$height-$y,$color);
 368
 369             //    Raise the horizontal position
 370             $x++;
 371         }
 372
 373         //    Unset the body / free the memory
 374         unset($body);
 375
 376         //    Return image-object
 377         return $image;
 378     }
 379 }