]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/image.php
WordPress 3.8.2
[autoinstalls/wordpress.git] / wp-admin / includes / image.php
index 903bd5fe17fc72eca02e02ebb1c2ff5cf4a2f757..61f527a569581cbe99fe3ac254f8d590e8d2b82e 100644 (file)
@@ -6,30 +6,12 @@
  * @subpackage Administration
  */
 
-/**
- * Create a thumbnail from an Image given a maximum side size.
- *
- * This function can handle most image file formats which PHP supports. If PHP
- * does not have the functionality to save in a file of the same format, the
- * thumbnail will be created as a jpeg.
- *
- * @since 1.2.0
- *
- * @param mixed $file Filename of the original image, Or attachment id.
- * @param int $max_side Maximum length of a single side for the thumbnail.
- * @return string Thumbnail path on success, Error string on failure.
- */
-function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
-       $thumbpath = image_resize( $file, $max_side, $max_side );
-       return apply_filters( 'wp_create_thumbnail', $thumbpath );
-}
-
 /**
  * Crop an Image to a given size.
  *
  * @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,40 +20,44 @@ function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
  * @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 New filepath on success, WP_Error 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 );
-
-       $src = wp_load_image( $src_file );
-
-       if ( !is_resource( $src ))
-               return $src;
-
-       $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
-
-       if ( $src_abs ) {
-               $src_w -= $src_x;
-               $src_h -= $src_y;
+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;
+               }
        }
 
-       if (function_exists('imageantialias'))
-               imageantialias( $dst, true );
-
-       imagecopyresampled( $dst, $src, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
+       $editor = wp_get_image_editor( $src );
+       if ( is_wp_error( $editor ) )
+               return $editor;
 
-       imagedestroy( $src ); // Free up memory
+       $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 );
 
-       $dst_file = preg_replace( '/\\.[^\\.]+$/', '.jpg', $dst_file );
+       // The directory containing the original file may no longer exist when
+       // using a replication plugin.
+       wp_mkdir_p( dirname( $dst_file ) );
 
-       if ( imagejpeg( $dst, $dst_file, apply_filters( 'jpeg_quality', 90, 'wp_crop_image' ) ) )
-               return $dst_file;
-       else
-               return false;
+       $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;
 }
 
 /**
@@ -87,26 +73,21 @@ 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];
-               list($uwidth, $uheight) = wp_shrink_dimensions($metadata['width'], $metadata['height']);
-               $metadata['hwstring_small'] = "height='$uheight' width='$uwidth'";
 
                // 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;
-               $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 );
+               $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
@@ -123,10 +104,13 @@ function wp_generate_attachment_metadata( $attachment_id, $file ) {
 
                $sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );
 
-               foreach ($sizes as $size => $size_data ) {
-                       $resized = image_make_intermediate_size( $file, $size_data['width'], $size_data['height'], $size_data['crop'] );
-                       if ( $resized )
-                               $metadata['sizes'][$size] = $resized;
+               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
@@ -134,67 +118,44 @@ function wp_generate_attachment_metadata( $attachment_id, $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' );
        }
 
-       return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
-}
-
-/**
- * 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;
-}
+       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 );
+               }
+       }
 
-/**
- * Calculated the new dimentions for a downsampled image.
- *
- * @since 2.0.0
- * @see wp_shrink_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 );
-}
+       // remove the blob of binary data from the array
+       if ( isset( $metadata['image']['data'] ) )
+               unset( $metadata['image']['data'] );
 
-/**
- * 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 apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
 }
 
 /**
@@ -244,14 +205,14 @@ function wp_exif_date2ts($str) {
  * @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,40 +229,91 @@ function wp_read_image_metadata( $file ) {
 
        // 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
-                               $meta['credit'] = utf8_encode(trim($iptc['2#110'][0]));
-                       elseif ( !empty($iptc['2#080'][0]) ) // 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 ( 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)) ) ) {
+       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'] = 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']))
+               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'] = wp_exif_frac2dec( $exif['FocalLength'] );
-               if (!empty($exif['ISOSpeedRatings']))
-                       $meta['iso'] = $exif['ISOSpeedRatings'];
-               if (!empty($exif['ExposureTime']))
-                       $meta['shutter_speed'] = wp_exif_frac2dec( $exif['ExposureTime'] );
+               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 );
@@ -341,3 +353,100 @@ function file_is_displayable_image($path) {
 
        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;
+}