web/wp-admin/includes/image.php
changeset 194 32102edaa81b
parent 136 bde1974c263b
child 204 09a1c134465b
--- a/web/wp-admin/includes/image.php	Thu Sep 16 15:45:36 2010 +0000
+++ b/web/wp-admin/includes/image.php	Mon Nov 19 18:26:13 2012 +0100
@@ -17,9 +17,12 @@
  *
  * @param mixed $file Filename of the original image, Or attachment id.
  * @param int $max_side Maximum length of a single side for the thumbnail.
+ * @param mixed $deprecated Never used.
  * @return string Thumbnail path on success, Error string on failure.
  */
 function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
+	if ( !empty( $deprecated ) )
+		_deprecated_argument( __FUNCTION__, '1.2' );
 	$thumbpath = image_resize( $file, $max_side, $max_side );
 	return apply_filters( 'wp_create_thumbnail', $thumbpath );
 }
@@ -29,7 +32,7 @@
  *
  * @since 2.1.0
  *
- * @param string|int $src_file The source file or Attachment ID.
+ * @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.
@@ -38,16 +41,30 @@
  * @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 New filepath on success, String error message on failure.
+ * @return string|WP_Error|false New filepath on success, WP_Error or false on failure.
  */
-function wp_crop_image( $src_file, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
-	if ( is_numeric( $src_file ) ) // Handle int as attachment ID
-		$src_file = get_attached_file( $src_file );
+function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
+	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.
+			$post = get_post( $src );
+			$image_type = $post->post_mime_type;
+			$src = load_image_to_edit( $src, $post->post_mime_type, 'full' );
+		} else {
+			$size = @getimagesize( $src_file );
+			$image_type = ( $size ) ? $size['mime'] : '';
+			$src = wp_load_image( $src_file );
+		}
+	} else {
+		$size = @getimagesize( $src );
+		$image_type = ( $size ) ? $size['mime'] : '';
+		$src = wp_load_image( $src );
+	}
 
-	$src = wp_load_image( $src_file );
-
-	if ( !is_resource( $src ))
-		return $src;
+	if ( ! is_resource( $src ) )
+		return new WP_Error( 'error_loading_image', $src, $src_file );
 
 	$dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
 
@@ -56,7 +73,7 @@
 		$src_h -= $src_y;
 	}
 
-	if (function_exists('imageantialias'))
+	if ( function_exists( 'imageantialias' ) )
 		imageantialias( $dst, true );
 
 	imagecopyresampled( $dst, $src, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
@@ -66,9 +83,18 @@
 	if ( ! $dst_file )
 		$dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );
 
-	$dst_file = preg_replace( '/\\.[^\\.]+$/', '.jpg', $dst_file );
+	if ( 'image/png' != $image_type )
+		$dst_file = preg_replace( '/\\.[^\\.]+$/', '.jpg', $dst_file );
 
-	if ( imagejpeg( $dst, $dst_file, apply_filters( 'jpeg_quality', 90, 'wp_crop_image' ) ) )
+	// 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 ) );
+
+	if ( 'image/png' == $image_type && imagepng( $dst, $dst_file ) )
+		return $dst_file;
+	elseif ( imagejpeg( $dst, $dst_file, apply_filters( 'jpeg_quality', 90, 'wp_crop_image' ) ) )
 		return $dst_file;
 	else
 		return false;
@@ -91,7 +117,7 @@
 		$imagesize = getimagesize( $file );
 		$metadata['width'] = $imagesize[0];
 		$metadata['height'] = $imagesize[1];
-		list($uwidth, $uheight) = wp_shrink_dimensions($metadata['width'], $metadata['height']);
+		list($uwidth, $uheight) = wp_constrain_dimensions($metadata['width'], $metadata['height'], 128, 96);
 		$metadata['hwstring_small'] = "height='$uheight' width='$uwidth'";
 
 		// Make the file path relative to the upload dir
@@ -99,14 +125,9 @@
 
 		// make thumbnails and other intermediate sizes
 		global $_wp_additional_image_sizes;
-		$temp_sizes = array('thumbnail', 'medium', 'large'); // Standard sizes
-		if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) )
-			$temp_sizes = array_merge( $temp_sizes, array_keys( $_wp_additional_image_sizes ) );
 
-		$temp_sizes = apply_filters( 'intermediate_image_sizes', $temp_sizes );
-
-		foreach ( $temp_sizes as $s ) {
-			$sizes[$s] = array( 'width' => '', 'height' => '', 'crop' => FALSE );
+		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
@@ -140,61 +161,17 @@
 }
 
 /**
- * Load an image from a string, if PHP supports it.
- *
- * @since 2.1.0
- *
- * @param string $file Filename of the image to load.
- * @return resource The resulting image resource on success, Error string on failure.
- */
-function wp_load_image( $file ) {
-	if ( is_numeric( $file ) )
-		$file = get_attached_file( $file );
-
-	if ( ! file_exists( $file ) )
-		return sprintf(__('File “%s” doesn’t exist?'), $file);
-
-	if ( ! function_exists('imagecreatefromstring') )
-		return __('The GD image library is not installed.');
-
-	// Set artificially high because GD uses uncompressed images in memory
-	@ini_set('memory_limit', '256M');
-	$image = imagecreatefromstring( file_get_contents( $file ) );
-
-	if ( !is_resource( $image ) )
-		return sprintf(__('File “%s” is not an image.'), $file);
-
-	return $image;
-}
-
-/**
- * Calculated the new dimentions for a downsampled image.
+ * Calculated the new dimensions for a downsampled image.
  *
  * @since 2.0.0
- * @see wp_shrink_dimensions()
+ * @see wp_constrain_dimensions()
  *
  * @param int $width Current width of the image
  * @param int $height Current height of the image
  * @return mixed Array(height,width) of shrunk dimensions.
  */
 function get_udims( $width, $height) {
-	return wp_shrink_dimensions( $width, $height );
-}
-
-/**
- * Calculates the new dimentions for a downsampled image.
- *
- * @since 2.0.0
- * @see wp_constrain_dimensions()
- *
- * @param int $width Current width of the image
- * @param int $height Current height of the image
- * @param int $wmax Maximum wanted width
- * @param int $hmax Maximum wanted height
- * @return mixed Array(height,width) of shrunk dimensions.
- */
-function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) {
-	return wp_constrain_dimensions( $width, $height, $wmax, $hmax );
+	return wp_constrain_dimensions( $width, $height, 128, 96 );
 }
 
 /**
@@ -244,14 +221,14 @@
  * @return bool|array False on failure. Image metadata array on success.
  */
 function wp_read_image_metadata( $file ) {
-	if ( !file_exists( $file ) )
+	if ( ! file_exists( $file ) )
 		return false;
 
-	list(,,$sourceImageType) = getimagesize( $file );
+	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
+	// 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,
@@ -268,39 +245,85 @@
 
 	// 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']);
-			if ( !empty($iptc['2#110'][0]) ) // credit
+	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'] = utf8_encode( 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'] = utf8_encode( trim( $iptc['2#005'][0] ) );
+
+			if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
+				$caption = utf8_encode( 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'] = utf8_encode(trim($iptc['2#110'][0]));
-			elseif ( !empty($iptc['2#080'][0]) ) // byline
+			elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline
 				$meta['credit'] = utf8_encode(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#120'][0]) ) // caption
-				$meta['caption'] = utf8_encode(trim($iptc['2#120'][0]));
-			if ( !empty($iptc['2#116'][0]) ) // copyright
-				$meta['copyright'] = utf8_encode(trim($iptc['2#116'][0]));
-			if ( !empty($iptc['2#005'][0]) ) // title
-				$meta['title'] = utf8_encode(trim($iptc['2#005'][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'] = utf8_encode( 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)) ) ) {
+	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['FNumber']))
+
+		if ( !empty( $exif['Title'] ) )
+			$meta['title'] = utf8_encode( trim( $exif['Title'] ) );
+
+		if ( ! empty( $exif['ImageDescription'] ) ) {
+			if ( empty( $meta['title'] ) && strlen( $exif['ImageDescription'] ) < 80 ) {
+				// Assume the title is stored in ImageDescription
+				$meta['title'] = utf8_encode( trim( $exif['ImageDescription'] ) );
+				if ( ! empty( $exif['COMPUTED']['UserComment'] ) && trim( $exif['COMPUTED']['UserComment'] ) != $meta['title'] )
+					$meta['caption'] = utf8_encode( trim( $exif['COMPUTED']['UserComment'] ) );
+			} elseif ( trim( $exif['ImageDescription'] ) != $meta['title'] ) {
+				$meta['caption'] = utf8_encode( trim( $exif['ImageDescription'] ) );
+			}
+		} elseif ( ! empty( $exif['Comments'] ) && trim( $exif['Comments'] ) != $meta['title'] ) {
+			$meta['caption'] = utf8_encode( trim( $exif['Comments'] ) );
+		}
+
+		if ( ! empty( $exif['Artist'] ) )
+			$meta['credit'] = utf8_encode( trim( $exif['Artist'] ) );
+		elseif ( ! empty($exif['Author'] ) )
+			$meta['credit'] = utf8_encode( trim( $exif['Author'] ) );
+
+		if ( ! empty( $exif['Copyright'] ) )
+			$meta['copyright'] = utf8_encode( 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']))
+		if ( ! empty($exif['Model'] ) )
+			$meta['camera'] = utf8_encode( trim( $exif['Model'] ) );
+		if ( ! empty($exif['DateTimeDigitized'] ) )
+			$meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized'] );
+		if ( ! empty($exif['FocalLength'] ) )
 			$meta['focal_length'] = wp_exif_frac2dec( $exif['FocalLength'] );
-		if (!empty($exif['ISOSpeedRatings']))
-			$meta['iso'] = $exif['ISOSpeedRatings'];
-		if (!empty($exif['ExposureTime']))
+		if ( ! empty($exif['ISOSpeedRatings'] ) ) {
+			$meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
+			$meta['iso'] = utf8_encode( trim( $meta['iso'] ) );
+		}
+		if ( ! empty($exif['ExposureTime'] ) )
 			$meta['shutter_speed'] = wp_exif_frac2dec( $exif['ExposureTime'] );
 	}
 
@@ -341,3 +364,100 @@
 
 	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;
+}
+
+/**
+ * Retrieve the path or url of an attachment's attached file.
+ *
+ * If the attached file is not present on the local filesystem (usually due to replication plugins),
+ * then the url of the file is returned if url fopen is supported.
+ *
+ * @since 3.4.0
+ * @access private
+ *
+ * @param string $attachment_id Attachment ID.
+ * @param string $size Optional. Image size, defaults to 'full'.
+ * @return string|false File path or url on success, false on failure.
+ */
+function _load_image_to_edit_path( $attachment_id, $size = 'full' ) {
+	$filepath = get_attached_file( $attachment_id );
+
+	if ( $filepath && file_exists( $filepath ) ) {
+		if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
+			$filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
+		}
+	} elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
+		$filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
+	}
+
+	return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
+}
+
+/**
+ * Copy an existing image file.
+ *
+ * @since 3.4.0
+ * @access private
+ *
+ * @param string $attachment_id Attachment ID.
+ * @return string|false New file path on success, false on failure.
+ */
+function _copy_image_file( $attachment_id ) {
+	$dst_file = $src_file = get_attached_file( $attachment_id );
+	if ( ! file_exists( $src_file ) )
+		$src_file = _load_image_to_edit_path( $attachment_id );
+
+	if ( $src_file ) {
+		$dst_file = str_replace( basename( $dst_file ), 'copy-' . basename( $dst_file ), $dst_file );
+		$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
+
+		// The directory containing the original file may no longer exist when
+		// using a replication plugin.
+		wp_mkdir_p( dirname( $dst_file ) );
+
+		if ( ! @copy( $src_file, $dst_file ) )
+			$dst_file = false;
+	} else {
+		$dst_file = false;
+	}
+
+	return $dst_file;
+}