<?php

/**

 * File contains all the administration image manipulation functions.

 *

 * @package WordPress

 * @subpackage Administration

 */

/**

 * Crop an Image to a given size.

 *

 * @since 2.1.0

 *

 * @param string|int $src The source file or Attachment ID.

 * @param int $src_x The start x position to crop from.

 * @param int $src_y The start y position to crop from.

 * @param int $src_w The width to crop.

 * @param int $src_h The height to crop.

 * @param int $dst_w The destination width.

 * @param int $dst_h The destination height.

 * @param int $src_abs Optional. If the source crop points are absolute.

 * @param string $dst_file Optional. The destination file to write to.

 * @return string|WP_Error New filepath on success, WP_Error on failure.

 */

function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {

	$src_file = $src;

	if ( is_numeric( $src ) ) { // Handle int as attachment ID

		$src_file = get_attached_file( $src );

		if ( ! file_exists( $src_file ) ) {

			// If the file doesn't exist, attempt a url fopen on the src link.

			// This can occur with certain file replication plugins.

			$src = _load_image_to_edit_path( $src, 'full' );

		} else {

			$src = $src_file;

		}

	}

	$editor = wp_get_image_editor( $src );

	if ( is_wp_error( $editor ) )

		return $editor;

	$src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );

	if ( is_wp_error( $src ) )

		return $src;

	if ( ! $dst_file )

		$dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );

	// The directory containing the original file may no longer exist when

	// using a replication plugin.

	wp_mkdir_p( dirname( $dst_file ) );

	$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );

	$result = $editor->save( $dst_file );

	if ( is_wp_error( $result ) )

		return $result;

	return $dst_file;

}

/**

 * Generate post thumbnail attachment meta data.

 *

 * @since 2.1.0

 *

 * @param int $attachment_id Attachment Id to process.

 * @param string $file Filepath of the Attached image.

 * @return mixed Metadata for attachment.

 */

function wp_generate_attachment_metadata( $attachment_id, $file ) {

	$attachment = get_post( $attachment_id );

	$metadata = array();

	$support = false;

	if ( preg_match('!^image/!', get_post_mime_type( $attachment )) && file_is_displayable_image($file) ) {

		$imagesize = getimagesize( $file );

		$metadata['width'] = $imagesize[0];

		$metadata['height'] = $imagesize[1];

		// Make the file path relative to the upload dir

		$metadata['file'] = _wp_relative_upload_path($file);

		// make thumbnails and other intermediate sizes

		global $_wp_additional_image_sizes;

		$sizes = array();

		foreach ( get_intermediate_image_sizes() as $s ) {

			$sizes[$s] = array( 'width' => '', 'height' => '', 'crop' => false );

			if ( isset( $_wp_additional_image_sizes[$s]['width'] ) )

				$sizes[$s]['width'] = intval( $_wp_additional_image_sizes[$s]['width'] ); // For theme-added sizes

			else

				$sizes[$s]['width'] = get_option( "{$s}_size_w" ); // For default sizes set in options

			if ( isset( $_wp_additional_image_sizes[$s]['height'] ) )

				$sizes[$s]['height'] = intval( $_wp_additional_image_sizes[$s]['height'] ); // For theme-added sizes

			else

				$sizes[$s]['height'] = get_option( "{$s}_size_h" ); // For default sizes set in options

			if ( isset( $_wp_additional_image_sizes[$s]['crop'] ) )

				$sizes[$s]['crop'] = intval( $_wp_additional_image_sizes[$s]['crop'] ); // For theme-added sizes

			else

				$sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options

		}

		$sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );

		if ( $sizes ) {

			$editor = wp_get_image_editor( $file );

			if ( ! is_wp_error( $editor ) )

				$metadata['sizes'] = $editor->multi_resize( $sizes );

		} else {

			$metadata['sizes'] = array();

		}

		// fetch additional metadata from exif/iptc

		$image_meta = wp_read_image_metadata( $file );

		if ( $image_meta )

			$metadata['image_meta'] = $image_meta;

	} elseif ( preg_match( '#^video/#', get_post_mime_type( $attachment ) ) ) {

		$metadata = wp_read_video_metadata( $file );

		$support = current_theme_supports( 'post-thumbnails', 'attachment:video' ) && post_type_supports( 'attachment:video', 'thumbnail' );

	} elseif ( preg_match( '#^audio/#', get_post_mime_type( $attachment ) ) ) {

		$metadata = wp_read_audio_metadata( $file );

		$support = current_theme_supports( 'post-thumbnails', 'attachment:audio' ) && post_type_supports( 'attachment:audio', 'thumbnail' );

	}

	if ( $support && ! empty( $metadata['image']['data'] ) ) {

		$ext = '.jpg';

		switch ( $metadata['image']['mime'] ) {

		case 'image/gif':

			$ext = '.gif';

			break;

		case 'image/png':

			$ext = '.png';

			break;

		}

		$basename = str_replace( '.', '-', basename( $file ) ) . '-image' . $ext;

		$uploaded = wp_upload_bits( $basename, '', $metadata['image']['data'] );

		if ( false === $uploaded['error'] ) {

			$attachment = array(

				'post_mime_type' => $metadata['image']['mime'],

				'post_type' => 'attachment',

				'post_content' => '',

			);

			$sub_attachment_id = wp_insert_attachment( $attachment, $uploaded['file'] );

			$attach_data = wp_generate_attachment_metadata( $sub_attachment_id, $uploaded['file'] );

			wp_update_attachment_metadata( $sub_attachment_id, $attach_data );

			update_post_meta( $attachment_id, '_thumbnail_id', $sub_attachment_id );

		}

	}

	// remove the blob of binary data from the array

	unset( $metadata['image']['data'] );

	return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );

}

/**

 * Convert a fraction string to a decimal.

 *

 * @since 2.5.0

 *

 * @param string $str

 * @return int|float

 */

function wp_exif_frac2dec($str) {

	@list( $n, $d ) = explode( '/', $str );

	if ( !empty($d) )

		return $n / $d;

	return $str;

}

/**

 * Convert the exif date format to a unix timestamp.

 *

 * @since 2.5.0

 *

 * @param string $str

 * @return int

 */

function wp_exif_date2ts($str) {

	@list( $date, $time ) = explode( ' ', trim($str) );

	@list( $y, $m, $d ) = explode( ':', $date );

	return strtotime( "{$y}-{$m}-{$d} {$time}" );

}

/**

 * Get extended image metadata, exif or iptc as available.

 *

 * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso

 * created_timestamp, focal_length, shutter_speed, and title.

 *

 * The IPTC metadata that is retrieved is APP13, credit, byline, created date

 * and time, caption, copyright, and title. Also includes FNumber, Model,

 * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.

 *

 * @todo Try other exif libraries if available.

 * @since 2.5.0

 *

 * @param string $file

 * @return bool|array False on failure. Image metadata array on success.

 */

function wp_read_image_metadata( $file ) {

	if ( ! file_exists( $file ) )

		return false;

	list( , , $sourceImageType ) = getimagesize( $file );

	// exif contains a bunch of data we'll probably never need formatted in ways

	// that are difficult to use. We'll normalize it and just extract the fields

	// that are likely to be useful. Fractions and numbers are converted to

	// floats, dates to unix timestamps, and everything else to strings.

	$meta = array(

		'aperture' => 0,

		'credit' => '',

		'camera' => '',

		'caption' => '',

		'created_timestamp' => 0,

		'copyright' => '',

		'focal_length' => 0,

		'iso' => 0,

		'shutter_speed' => 0,

		'title' => '',

	);

	// read iptc first, since it might contain data not available in exif such

	// as caption, description etc

	if ( is_callable( 'iptcparse' ) ) {

		getimagesize( $file, $info );

		if ( ! empty( $info['APP13'] ) ) {

			$iptc = iptcparse( $info['APP13'] );

			// headline, "A brief synopsis of the caption."

			if ( ! empty( $iptc['2#105'][0] ) )

				$meta['title'] = trim( $iptc['2#105'][0] );

			// title, "Many use the Title field to store the filename of the image, though the field may be used in many ways."

			elseif ( ! empty( $iptc['2#005'][0] ) )

				$meta['title'] = trim( $iptc['2#005'][0] );

			if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption

				$caption = trim( $iptc['2#120'][0] );

				if ( empty( $meta['title'] ) ) {

					// Assume the title is stored in 2:120 if it's short.

					if ( strlen( $caption ) < 80 )

						$meta['title'] = $caption;

					else

						$meta['caption'] = $caption;

				} elseif ( $caption != $meta['title'] ) {

					$meta['caption'] = $caption;

				}

			}

			if ( ! empty( $iptc['2#110'][0] ) ) // credit

				$meta['credit'] = trim( $iptc['2#110'][0] );

			elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline

				$meta['credit'] = trim( $iptc['2#080'][0] );

			if ( ! empty( $iptc['2#055'][0] ) and ! empty( $iptc['2#060'][0] ) ) // created date and time

				$meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );

			if ( ! empty( $iptc['2#116'][0] ) ) // copyright

				$meta['copyright'] = trim( $iptc['2#116'][0] );

		 }

	}

	// fetch additional info from exif if available

	if ( is_callable( 'exif_read_data' ) && in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) ) ) {

		$exif = @exif_read_data( $file );

		if ( !empty( $exif['Title'] ) )

			$meta['title'] = trim( $exif['Title'] );

		if ( ! empty( $exif['ImageDescription'] ) ) {

			if ( empty( $meta['title'] ) && strlen( $exif['ImageDescription'] ) < 80 ) {

				// Assume the title is stored in ImageDescription

				$meta['title'] = trim( $exif['ImageDescription'] );

				if ( ! empty( $exif['COMPUTED']['UserComment'] ) && trim( $exif['COMPUTED']['UserComment'] ) != $meta['title'] )

					$meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );

			} elseif ( trim( $exif['ImageDescription'] ) != $meta['title'] ) {

				$meta['caption'] = trim( $exif['ImageDescription'] );

			}

		} elseif ( ! empty( $exif['Comments'] ) && trim( $exif['Comments'] ) != $meta['title'] ) {

			$meta['caption'] = trim( $exif['Comments'] );

		}

		if ( ! empty( $exif['Artist'] ) )

			$meta['credit'] = trim( $exif['Artist'] );

		elseif ( ! empty($exif['Author'] ) )

			$meta['credit'] = trim( $exif['Author'] );

		if ( ! empty( $exif['Copyright'] ) )

			$meta['copyright'] = trim( $exif['Copyright'] );

		if ( ! empty($exif['FNumber'] ) )

			$meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );

		if ( ! empty($exif['Model'] ) )

			$meta['camera'] = trim( $exif['Model'] );

		if ( ! empty($exif['DateTimeDigitized'] ) )

			$meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized'] );

		if ( ! empty($exif['FocalLength'] ) )

			$meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );

		if ( ! empty($exif['ISOSpeedRatings'] ) ) {

			$meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];

			$meta['iso'] = trim( $meta['iso'] );

		}

		if ( ! empty($exif['ExposureTime'] ) )

			$meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );

	}

	foreach ( array( 'title', 'caption', 'credit', 'copyright', 'camera', 'iso' ) as $key ) {

		if ( $meta[ $key ] && ! seems_utf8( $meta[ $key ] ) )

			$meta[ $key ] = utf8_encode( $meta[ $key ] );

	}

	return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );

}

/**

 * Validate that file is an image.

 *

 * @since 2.5.0

 *

 * @param string $path File path to test if valid image.

 * @return bool True if valid image, false if not valid image.

 */

function file_is_valid_image($path) {

	$size = @getimagesize($path);

	return !empty($size);

}

/**

 * Validate that file is suitable for displaying within a web page.

 *

 * @since 2.5.0

 * @uses apply_filters() Calls 'file_is_displayable_image' on $result and $path.

 *

 * @param string $path File path to test.

 * @return bool True if suitable, false if not suitable.

 */

function file_is_displayable_image($path) {

	$info = @getimagesize($path);

	if ( empty($info) )

		$result = false;

	elseif ( !in_array($info[2], array(IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG)) )	// only gif, jpeg and png images can reliably be displayed

		$result = false;

	else

		$result = true;

	return apply_filters('file_is_displayable_image', $result, $path);

}

/**

 * Load an image resource for editing.

 *

 * @since 2.9.0

 *

 * @param string $attachment_id Attachment ID.

 * @param string $mime_type Image mime type.

 * @param string $size Optional. Image size, defaults to 'full'.

 * @return resource|false The resulting image resource on success, false on failure.

 */

function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {

	$filepath = _load_image_to_edit_path( $attachment_id, $size );

	if ( empty( $filepath ) )

		return false;

	switch ( $mime_type ) {

		case 'image/jpeg':

			$image = imagecreatefromjpeg($filepath);

			break;

		case 'image/png':

			$image = imagecreatefrompng($filepath);

			break;

		case 'image/gif':

			$image = imagecreatefromgif($filepath);

			break;

		default:

			$image = false;

			break;

	}

	if ( is_resource($image) ) {

		$image = apply_filters('load_image_to_edit', $image, $attachment_id, $size);

		if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {

			imagealphablending($image, false);

			imagesavealpha($image, true);

		}

	}

	return $image;

}