lib/imagefile.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Zach Copley <zach@controlyourself.ca>
  26  * @copyright 2008-2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!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  Laconica
  42  * @author   Evan Prodromou <evan@controlyourself.ca>
  43  * @author   Zach Copley <zach@controlyourself.ca>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://laconi.ca/
  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         $this->type = ($info) ? $info[2]:$type;
  64         $this->width = ($info) ? $info[0]:$width;
  65         $this->height = ($info) ? $info[1]:$height;
  66     }
  67
  68     static function fromUpload($param='upload')
  69     {
  70         switch ($_FILES[$param]['error']) {
  71          case UPLOAD_ERR_OK: // success, jump out
  72             break;
  73          case UPLOAD_ERR_INI_SIZE:
  74          case UPLOAD_ERR_FORM_SIZE:
  75             throw new Exception(sprintf(_('That file is too big. The maximum file size is %d.'), $this->maxFileSize()));
  76             return;
  77          case UPLOAD_ERR_PARTIAL:
  78             @unlink($_FILES[$param]['tmp_name']);
  79             throw new Exception(_('Partial upload.'));
  80             return;
  81          default:
  82             throw new Exception(_('System error uploading file.'));
  83             return;
  84         }
  85
  86         $info = @getimagesize($_FILES[$param]['tmp_name']);
  87
  88         if (!$info) {
  89             @unlink($_FILES[$param]['tmp_name']);
  90             throw new Exception(_('Not an image or corrupt file.'));
  91             return;
  92         }
  93
  94         if ($info[2] !== IMAGETYPE_GIF &&
  95             $info[2] !== IMAGETYPE_JPEG &&
  96             $info[2] !== IMAGETYPE_PNG) {
  97
  98             @unlink($_FILES[$param]['tmp_name']);
  99             throw new Exception(_('Unsupported image file format.'));
 100             return;
 101         }
 102
 103         return new ImageFile(null, $_FILES[$param]['tmp_name']);
 104     }
 105
 106     function resize($size, $x = 0, $y = 0, $w = null, $h = null)
 107     {
 108         $w = ($w === null) ? $this->width:$w;
 109         $h = ($h === null) ? $this->height:$h;
 110
 111         if (!file_exists($this->filepath)) {
 112             throw new Exception(_('Lost our file.'));
 113             return;
 114         }
 115
 116         // Don't crop/scale if it isn't necessary
 117         if ($size === $this->width
 118             && $size === $this->height
 119             && $x === 0
 120             && $y === 0
 121             && $w === $this->width
 122             && $h === $this->height) {
 123
 124             $outname = Avatar::filename($this->id,
 125                                         image_type_to_extension($this->type),
 126                                         $size,
 127                                         common_timestamp());
 128             $outpath = Avatar::path($outname);
 129             @copy($this->filepath, $outpath);
 130             return $outname;
 131         }
 132
 133         switch ($this->type) {
 134          case IMAGETYPE_GIF:
 135             $image_src = imagecreatefromgif($this->filepath);
 136             break;
 137          case IMAGETYPE_JPEG:
 138             $image_src = imagecreatefromjpeg($this->filepath);
 139             break;
 140          case IMAGETYPE_PNG:
 141             $image_src = imagecreatefrompng($this->filepath);
 142             break;
 143          default:
 144             throw new Exception(_('Unknown file type'));
 145             return;
 146         }
 147
 148         $image_dest = imagecreatetruecolor($size, $size);
 149
 150         if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG) {
 151
 152             $transparent_idx = imagecolortransparent($image_src);
 153
 154             if ($transparent_idx >= 0) {
 155
 156                 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
 157                 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
 158                 imagefill($image_dest, 0, 0, $transparent_idx);
 159                 imagecolortransparent($image_dest, $transparent_idx);
 160
 161             } elseif ($this->type == IMAGETYPE_PNG) {
 162
 163                 imagealphablending($image_dest, false);
 164                 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
 165                 imagefill($image_dest, 0, 0, $transparent);
 166                 imagesavealpha($image_dest, true);
 167
 168             }
 169         }
 170
 171         imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $size, $size, $w, $h);
 172
 173         $outname = Avatar::filename($this->id,
 174                                     image_type_to_extension($this->type),
 175                                     $size,
 176                                     common_timestamp());
 177
 178         $outpath = Avatar::path($outname);
 179
 180         switch ($this->type) {
 181          case IMAGETYPE_GIF:
 182             imagegif($image_dest, $outpath);
 183             break;
 184          case IMAGETYPE_JPEG:
 185             imagejpeg($image_dest, $outpath, 100);
 186             break;
 187          case IMAGETYPE_PNG:
 188             imagepng($image_dest, $outpath);
 189             break;
 190          default:
 191             throw new Exception(_('Unknown file type'));
 192             return;
 193         }
 194
 195         imagedestroy($image_src);
 196         imagedestroy($image_dest);
 197
 198         return $outname;
 199     }
 200
 201     function unlink()
 202     {
 203         @unlink($this->filename);
 204     }
 205
 206     static function maxFileSize()
 207     {
 208         $value = ImageFile::maxFileSizeInt();
 209
 210         if ($value > 1024 * 1024) {
 211             return ($value/(1024*1024)).'Mb';
 212         } else if ($value > 1024) {
 213             return ($value/(1024)).'kB';
 214         } else {
 215             return $value;
 216         }
 217     }
 218
 219     static function maxFileSizeInt()
 220     {
 221         return min(ImageFile::strToInt(ini_get('post_max_size')),
 222                    ImageFile::strToInt(ini_get('upload_max_filesize')),
 223                    ImageFile::strToInt(ini_get('memory_limit')));
 224     }
 225
 226     static function strToInt($str)
 227     {
 228         $unit = substr($str, -1);
 229         $num = substr($str, 0, -1);
 230
 231         switch(strtoupper($unit)){
 232          case 'G':
 233             $num *= 1024;
 234          case 'M':
 235             $num *= 1024;
 236          case 'K':
 237             $num *= 1024;
 238         }
 239
 240         return $num;
 241     }
 242 }