path: root/include/Photo.php

<?php

if(! class_exists("Photo")) {
class Photo {

    private $image;

    /**
     * Put back gd stuff, not everybody have Imagick
     */
    private $imagick;
    private $width;
    private $height;
    private $valid;
    private $type;
    private $types;

    /**
     * supported mimetypes and corresponding file extensions
     */
    static function supportedTypes() {
        if(class_exists('Imagick')) {
            /**
             * Imagick::queryFormats won't help us a lot there...
             * At least, not yet, other parts of friendica uses this array
             */
            $t = array(
                'image/jpeg' => 'jpg',
                'image/png' => 'png',
                'image/gif' => 'gif'
            );
        } else {
            $t = array();
            $t['image/jpeg'] ='jpg';
            if (imagetypes() & IMG_PNG) $t['image/png'] = 'png';
        }

        return $t;
    }

    public function __construct($data, $type=null) {
        $this->imagick = class_exists('Imagick');
        $this->types = $this->supportedTypes();
        if (!array_key_exists($type,$this->types)){
            $type='image/jpeg';
        }
        $this->type = $type;

        if($this->is_imagick()) {
            $this->image = new Imagick();
            $this->image->readImageBlob($data);

            /**
             * Setup the image to the format it will be saved to
             */
            $map = $this->get_FormatsMap();
            $format = $map[$type];
            $this->image->setFormat($format);

            // Always coalesce, if it is not a multi-frame image it won't hurt anyway
            $this->image = $this->image->coalesceImages();

            /**
             * setup the compression here, so we'll do it only once
             */
            switch($this->getType()){
                case "image/png":
                    $quality = get_config('system','png_quality');
                    if((! $quality) || ($quality > 9))
                        $quality = PNG_QUALITY;
                    /**
                     * From http://www.imagemagick.org/script/command-line-options.php#quality:
                     *
                     * 'For the MNG and PNG image formats, the quality value sets
                     * the zlib compression level (quality / 10) and filter-type (quality % 10).
                     * The default PNG "quality" is 75, which means compression level 7 with adaptive PNG filtering,
                     * unless the image has a color map, in which case it means compression level 7 with no PNG filtering'
                     */
                    $quality = $quality * 10;
                    $this->image->setCompressionQuality($quality);
                    break;
                case "image/jpeg":
                    $quality = get_config('system','jpeg_quality');
                    if((! $quality) || ($quality > 100))
                        $quality = JPEG_QUALITY;
                    $this->image->setCompressionQuality($quality);
            }
        } else {
            $this->valid = false;
            $this->image = @imagecreatefromstring($data);
            if($this->image !== FALSE) {
                $this->width  = imagesx($this->image);
                $this->height = imagesy($this->image);
                $this->valid  = true;
                imagealphablending($this->image, false);
                imagesavealpha($this->image, true);
            }
        }
    }

    public function __destruct() {
        if($this->image) {
            if($this->is_imagick()) {
                $this->image->clear();
                $this->image->destroy();
                return;
            }
            imagedestroy($this->image);
        }
    }

    public function is_imagick() {
        return $this->imagick;
    }

    /**
     * Maps Mime types to Imagick formats
     */
    public function get_FormatsMap() {
        $m = array(
            'image/jpeg' => 'JPG',
            'image/png' => 'PNG',
            'image/gif' => 'GIF'
        );
        return $m;
    }

    public function is_valid() {
        if($this->is_imagick())
            return ($this->image !== FALSE);
        return $this->valid;
    }

    public function getWidth() {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick())
            return $this->image->getImageWidth();
        return $this->width;
    }

    public function getHeight() {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick())
            return $this->image->getImageHeight();
        return $this->height;
    }

    public function getImage() {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            /* Clean it */
            $this->image = $this->image->deconstructImages();
            return $this->image;
        }
        return $this->image;
    }

    public function getType() {
        if(!$this->is_valid())
            return FALSE;

        return $this->type;
    }

    public function getExt() {
        if(!$this->is_valid())
            return FALSE;

        return $this->types[$this->getType()];
    }

    public function scaleImage($max) {
        if(!$this->is_valid())
            return FALSE;

        $width = $this->width;
        $height = $this->height;

        $dest_width = $dest_height = 0;

        if((! $width)|| (! $height))
            return FALSE;

        if($width > $max && $height > $max) {

			// very tall image (greater than 16:9)
			// constrain the width - let the height float.

			if((($height * 9) / 16) > $width) {
				$dest_width = $max;
     	        $dest_height = intval(( $height * $max ) / $width);
			}

			// else constrain both dimensions

			elseif($width > $height) {
                $dest_width = $max;
                $dest_height = intval(( $height * $max ) / $width);
            }
            else {
                $dest_width = intval(( $width * $max ) / $height);
                $dest_height = $max;
            }
        }
        else {
            if( $width > $max ) {
                $dest_width = $max;
                $dest_height = intval(( $height * $max ) / $width);
            }
            else {
                if( $height > $max ) {

					// very tall image (greater than 16:9)
					// but width is OK - don't do anything

					if((($height * 9) / 16) > $width) {
						$dest_width = $width;
     	        		$dest_height = $height;
					}
					else {
	                    $dest_width = intval(( $width * $max ) / $height);
    	                $dest_height = $max;
					}
                }
                else {
                    $dest_width = $width;
                    $dest_height = $height;
                }
            }
        }


        if($this->is_imagick()) {
            /**
             * If it is not animated, there will be only one iteration here,
             * so don't bother checking
             */
            // Don't forget to go back to the first frame
            $this->image->setFirstIterator();
            do {

				// FIXME - implement horizantal bias for scaling as in followin GD functions
				// to allow very tall images to be constrained only horizontally. 

                $this->image->scaleImage($dest_width, $dest_height);
            } while ($this->image->nextImage());

			// FIXME - also we need to copy the new dimensions to $this->height, $this->width as other functions
			// may rely on it.

            return;
        }


        $dest = imagecreatetruecolor( $dest_width, $dest_height );
        imagealphablending($dest, false);
        imagesavealpha($dest, true);
        if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
        imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dest_width, $dest_height, $width, $height);
        if($this->image)
            imagedestroy($this->image);
        $this->image = $dest;
        $this->width  = imagesx($this->image);
        $this->height = imagesy($this->image);
    }

    public function rotate($degrees) {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            $this->image->setFirstIterator();
            do {
                $this->image->rotateImage(new ImagickPixel(), -$degrees); // ImageMagick rotates in the opposite direction of imagerotate()
            } while ($this->image->nextImage());
            return;
        }

        $this->image  = imagerotate($this->image,$degrees,0);
        $this->width  = imagesx($this->image);
        $this->height = imagesy($this->image);
    }

    public function flip($horiz = true, $vert = false) {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            $this->image->setFirstIterator();
            do {
                if($horiz) $this->image->flipImage();
                if($vert) $this->image->flopImage();
            } while ($this->image->nextImage());
            return;
        }

        $w = imagesx($this->image);
        $h = imagesy($this->image);
        $flipped = imagecreate($w, $h);
        if($horiz) {
            for ($x = 0; $x < $w; $x++) {
                imagecopy($flipped, $this->image, $x, 0, $w - $x - 1, 0, 1, $h);
            }
        }
        if($vert) {
            for ($y = 0; $y < $h; $y++) {
                imagecopy($flipped, $this->image, 0, $y, 0, $h - $y - 1, $w, 1);
            }
        }
        $this->image = $flipped;
    }

    public function orient($filename) {
        // based off comment on http://php.net/manual/en/function.imagerotate.php

        if(!$this->is_valid())
            return FALSE;

        if( (! function_exists('exif_read_data')) || ($this->getType() !== 'image/jpeg') )
            return;

        $exif = exif_read_data($filename);
        $ort = $exif['Orientation'];

        switch($ort)
        {
            case 1: // nothing
                break;

            case 2: // horizontal flip
                $this->flip();
                break;

            case 3: // 180 rotate left
                $this->rotate(180);
                break;

            case 4: // vertical flip
                $this->flip(false, true);
                break;

            case 5: // vertical flip + 90 rotate right
                $this->flip(false, true);
                $this->rotate(-90);
                break;

            case 6: // 90 rotate right
                $this->rotate(-90);
                break;

            case 7: // horizontal flip + 90 rotate right
                $this->flip();
                $this->rotate(-90);
                break;

            case 8:    // 90 rotate left
                $this->rotate(90);
                break;
        }
    }



    public function scaleImageUp($min) {
        if(!$this->is_valid())
            return FALSE;


        $width = $this->width;
        $height = $this->height;

        $dest_width = $dest_height = 0;

        if((! $width)|| (! $height))
            return FALSE;

        if($width < $min && $height < $min) {
            if($width > $height) {
                $dest_width = $min;
                $dest_height = intval(( $height * $min ) / $width);
            }
            else {
                $dest_width = intval(( $width * $min ) / $height);
                $dest_height = $min;
            }
        }
        else {
            if( $width < $min ) {
                $dest_width = $min;
                $dest_height = intval(( $height * $min ) / $width);
            }
            else {
                if( $height < $min ) {
                    $dest_width = intval(( $width * $min ) / $height);
                    $dest_height = $min;
                }
                else {
                    $dest_width = $width;
                    $dest_height = $height;
                }
            }
        }

        if($this->is_imagick())
            return $this->scaleImage($dest_width,$dest_height);

        $dest = imagecreatetruecolor( $dest_width, $dest_height );
        imagealphablending($dest, false);
        imagesavealpha($dest, true);
        if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
        imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dest_width, $dest_height, $width, $height);
        if($this->image)
            imagedestroy($this->image);
        $this->image = $dest;
        $this->width  = imagesx($this->image);
        $this->height = imagesy($this->image);
    }



    public function scaleImageSquare($dim) {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            $this->image->setFirstIterator();
            do {
                $this->image->scaleImage($dim, $dim);
            } while ($this->image->nextImage());
            return;
        }

        $dest = imagecreatetruecolor( $dim, $dim );
        imagealphablending($dest, false);
        imagesavealpha($dest, true);
        if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
        imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dim, $dim, $this->width, $this->height);
        if($this->image)
            imagedestroy($this->image);
        $this->image = $dest;
        $this->width  = imagesx($this->image);
        $this->height = imagesy($this->image);
    }


    public function cropImage($max,$x,$y,$w,$h) {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            $this->image->setFirstIterator();
            do {
                $this->image->cropImage($w, $h, $x, $y);
                /**
                 * We need to remove the canva,
                 * or the image is not resized to the crop:
                 * http://php.net/manual/en/imagick.cropimage.php#97232
                 */
                $this->image->setImagePage(0, 0, 0, 0);
            } while ($this->image->nextImage());
            return $this->scaleImage($max);
        }

        $dest = imagecreatetruecolor( $max, $max );
        imagealphablending($dest, false);
        imagesavealpha($dest, true);
        if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
        imagecopyresampled($dest, $this->image, 0, 0, $x, $y, $max, $max, $w, $h);
        if($this->image)
            imagedestroy($this->image);
        $this->image = $dest;
        $this->width  = imagesx($this->image);
        $this->height = imagesy($this->image);
    }

    public function saveImage($path) {
        if(!$this->is_valid())
            return FALSE;

        $string = $this->imageString();
        file_put_contents($path, $string);
    }

    public function imageString() {
        if(!$this->is_valid())
            return FALSE;

        if($this->is_imagick()) {
            /* Clean it */
            $this->image = $this->image->deconstructImages();
            $string = $this->image->getImagesBlob();
            return $string;
        }

        $quality = FALSE;

        ob_start();

        switch($this->getType()){
            case "image/png":
                $quality = get_config('system','png_quality');
                if((! $quality) || ($quality > 9))
                    $quality = PNG_QUALITY;
                imagepng($this->image,NULL, $quality);
                break;
            case "image/jpeg":
                $quality = get_config('system','jpeg_quality');
                if((! $quality) || ($quality > 100))
                    $quality = JPEG_QUALITY;
                imagejpeg($this->image,NULL,$quality);
        }
        $string = ob_get_contents();
        ob_end_clean();

        return $string;
    }



    public function store($aid, $uid, $xchan, $rid, $filename, $album, $scale, $profile = 0, $allow_cid = '', $allow_gid = '', $deny_cid = '', $deny_gid = '') {

        $x = q("select id from photo where `resource_id` = '%s' and uid = %d and `xchan` = '%s' and `scale` = %d limit 1",
                dbesc($rid),
                intval($uid),
                dbesc($xchan),
                intval($scale)
        );
        if(count($x)) {
            $r = q("UPDATE `photo`
				set `aid` = %d,
                set `uid` = %d,
                `xchan` = '%s',
                `resource_id` = '%s',
                `created` = '%s',
                `edited` = '%s',
                `filename` = '%s',
                `type` = '%s',
                `album` = '%s',
                `height` = %d,
                `width` = %d,
                `data` = '%s',
				`size` = %d,
                `scale` = %d,
                `profile` = %d,
                `allow_cid` = '%s',
                `allow_gid` = '%s',
                `deny_cid` = '%s',
                `deny_gid` = '%s'
                where id = %d limit 1",

				intval($aid),
                intval($uid),
                dbesc($xchan),
                dbesc($rid),
                dbesc(datetime_convert()),
                dbesc(datetime_convert()),
                dbesc(basename($filename)),
                dbesc($this->getType()),
                dbesc($album),
                intval($this->getHeight()),
                intval($this->getWidth()),
                dbesc($this->imageString()),
				intval(strlen($this->imageString())),
                intval($scale),
                intval($profile),
                dbesc($allow_cid),
                dbesc($allow_gid),
                dbesc($deny_cid),
                dbesc($deny_gid),
                intval($x[0]['id'])
            );
        }
        else {
            $r = q("INSERT INTO `photo`
                ( `aid`, `uid`, `xchan`, `resource_id`, `created`, `edited`, `filename`, type, `album`, `height`, `width`, `data`, `size`, `scale`, `profile`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid` )
                VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', %d, %d, %d, '%s', '%s', '%s', '%s' )",
				intval($aid),
                intval($uid),
                dbesc($xchan),
                dbesc($rid),
                dbesc(datetime_convert()),
                dbesc(datetime_convert()),
                dbesc(basename($filename)),
                dbesc($this->getType()),
                dbesc($album),
                intval($this->getHeight()),
                intval($this->getWidth()),
                dbesc($this->imageString()),
				intval(strlen($this->imageString())),
                intval($scale),
                intval($profile),
                dbesc($allow_cid),
                dbesc($allow_gid),
                dbesc($deny_cid),
                dbesc($deny_gid)
            );
        }
        return $r;
    }
}}


/**
 * Guess image mimetype from filename or from Content-Type header
 *
 * @arg $filename string Image filename
 * @arg $fromcurl boolean Check Content-Type header from curl request
 */
function guess_image_type($filename, $fromcurl=false) {
    logger('Photo: guess_image_type: '.$filename . ($fromcurl?' from curl headers':''), LOGGER_DEBUG);
    $type = null;
    if ($fromcurl) {
        $a = get_app();
        $headers=array();
        $h = explode("\n",$a->get_curl_headers());
        foreach ($h as $l) {
            list($k,$v) = array_map("trim", explode(":", trim($l), 2));
            $headers[$k] = $v;
        }
        if (array_key_exists('Content-Type', $headers))
            $type = $headers['Content-Type'];
    }
    if (is_null($type)){
        // Guessing from extension? Isn't that... dangerous?
        if(class_exists('Imagick') && file_exists($filename) && is_readable($filename)) {
            /**
             * Well, this not much better,
             * but at least it comes from the data inside the image,
             * we won't be tricked by a manipulated extension
             */
            $image = new Imagick($filename);
            $type = $image->getImageMimeType();
        } else {
            $ext = pathinfo($filename, PATHINFO_EXTENSION);
            $types = Photo::supportedTypes();
            $type = "image/jpeg";
            foreach ($types as $m=>$e){
                if ($ext==$e) $type = $m;
            }
        }
    }
    logger('Photo: guess_image_type: type='.$type, LOGGER_DEBUG);
    return $type;

}

function import_profile_photo($photo,$xchan) {

    $a = get_app();

    $r = q("select `resource_id` from photo where xchan = '%s' and `scale` = 4 limit 1",
        dbesc($xchan)
    );
    if($r) {
        $hash = $r[0]['resource_id'];
    }
    else {
        $hash = photo_new_resource();
    }

    $photo_failure = false;

    $filename = basename($photo);
    $img_str = fetch_url($photo,true);

    $type = guess_image_type($photo,true);
    $img = new Photo($img_str, $type);
    if($img->is_valid()) {

        $img->scaleImageSquare(175);

        $r = $img->store(0, 0, $xchan, $hash, $filename, 'Contact Photos', 4 );

        if($r === false)
            $photo_failure = true;

        $img->scaleImage(80);

        $r = $img->store(0, 0, $xchan, $hash, $filename, 'Contact Photos', 5 );

        if($r === false)
            $photo_failure = true;

        $img->scaleImage(48);

        $r = $img->store(0, 0, $xchan, $hash, $filename, 'Contact Photos', 6 );

        if($r === false)
            $photo_failure = true;

        $photo = $a->get_baseurl() . '/photo/' . $hash . '-4';
        $thumb = $a->get_baseurl() . '/photo/' . $hash . '-5';
        $micro = $a->get_baseurl() . '/photo/' . $hash . '-6';
    }
    else
        $photo_failure = true;

    if($photo_failure) {
        $photo = $a->get_baseurl() . '/images/person-175.jpg';
        $thumb = $a->get_baseurl() . '/images/person-80.jpg';
        $micro = $a->get_baseurl() . '/images/person-48.jpg';
		$type = 'image/jpeg';
    }

    return(array($photo,$thumb,$micro,$type));

}