PageRenderTime 109ms CodeModel.GetById 50ms app.highlight 20ms RepoModel.GetById 35ms app.codeStats 0ms

/wp-admin/includes/image.php

https://bitbucket.org/julianelve/vendor-wordpress
PHP | 412 lines | 227 code | 53 blank | 132 comment | 67 complexity | 0e2752bc2952bb0902a0dc6031bb49d0 MD5 | raw file
  1<?php
  2/**
  3 * File contains all the administration image manipulation functions.
  4 *
  5 * @package WordPress
  6 * @subpackage Administration
  7 */
  8
  9/**
 10 * Crop an Image to a given size.
 11 *
 12 * @since 2.1.0
 13 *
 14 * @param string|int $src The source file or Attachment ID.
 15 * @param int $src_x The start x position to crop from.
 16 * @param int $src_y The start y position to crop from.
 17 * @param int $src_w The width to crop.
 18 * @param int $src_h The height to crop.
 19 * @param int $dst_w The destination width.
 20 * @param int $dst_h The destination height.
 21 * @param int $src_abs Optional. If the source crop points are absolute.
 22 * @param string $dst_file Optional. The destination file to write to.
 23 * @return string|WP_Error|false New filepath on success, WP_Error or false on failure.
 24 */
 25function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
 26	$src_file = $src;
 27	if ( is_numeric( $src ) ) { // Handle int as attachment ID
 28		$src_file = get_attached_file( $src );
 29
 30		if ( ! file_exists( $src_file ) ) {
 31			// If the file doesn't exist, attempt a url fopen on the src link.
 32			// This can occur with certain file replication plugins.
 33			$src = _load_image_to_edit_path( $src, 'full' );
 34		} else {
 35			$src = $src_file;
 36		}
 37	}
 38
 39	$editor = wp_get_image_editor( $src );
 40	if ( is_wp_error( $editor ) )
 41		return $editor;
 42
 43	$src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );
 44	if ( is_wp_error( $src ) )
 45		return $src;
 46
 47	if ( ! $dst_file )
 48		$dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );
 49
 50	// The directory containing the original file may no longer exist when
 51	// using a replication plugin.
 52	wp_mkdir_p( dirname( $dst_file ) );
 53
 54	$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
 55
 56	$result = $editor->save( $dst_file );
 57	return $dst_file;
 58}
 59
 60/**
 61 * Generate post thumbnail attachment meta data.
 62 *
 63 * @since 2.1.0
 64 *
 65 * @param int $attachment_id Attachment Id to process.
 66 * @param string $file Filepath of the Attached image.
 67 * @return mixed Metadata for attachment.
 68 */
 69function wp_generate_attachment_metadata( $attachment_id, $file ) {
 70	$attachment = get_post( $attachment_id );
 71
 72	$metadata = array();
 73	if ( preg_match('!^image/!', get_post_mime_type( $attachment )) && file_is_displayable_image($file) ) {
 74		$imagesize = getimagesize( $file );
 75		$metadata['width'] = $imagesize[0];
 76		$metadata['height'] = $imagesize[1];
 77
 78		// Make the file path relative to the upload dir
 79		$metadata['file'] = _wp_relative_upload_path($file);
 80
 81		// make thumbnails and other intermediate sizes
 82		global $_wp_additional_image_sizes;
 83
 84		foreach ( get_intermediate_image_sizes() as $s ) {
 85			$sizes[$s] = array( 'width' => '', 'height' => '', 'crop' => false );
 86			if ( isset( $_wp_additional_image_sizes[$s]['width'] ) )
 87				$sizes[$s]['width'] = intval( $_wp_additional_image_sizes[$s]['width'] ); // For theme-added sizes
 88			else
 89				$sizes[$s]['width'] = get_option( "{$s}_size_w" ); // For default sizes set in options
 90			if ( isset( $_wp_additional_image_sizes[$s]['height'] ) )
 91				$sizes[$s]['height'] = intval( $_wp_additional_image_sizes[$s]['height'] ); // For theme-added sizes
 92			else
 93				$sizes[$s]['height'] = get_option( "{$s}_size_h" ); // For default sizes set in options
 94			if ( isset( $_wp_additional_image_sizes[$s]['crop'] ) )
 95				$sizes[$s]['crop'] = intval( $_wp_additional_image_sizes[$s]['crop'] ); // For theme-added sizes
 96			else
 97				$sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
 98		}
 99
100		$sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );
101
102		if ( $sizes ) {
103			$editor = wp_get_image_editor( $file );
104
105			if ( ! is_wp_error( $editor ) )
106				$metadata['sizes'] = $editor->multi_resize( $sizes );
107		} else {
108			$metadata['sizes'] = array();
109		}
110
111		// fetch additional metadata from exif/iptc
112		$image_meta = wp_read_image_metadata( $file );
113		if ( $image_meta )
114			$metadata['image_meta'] = $image_meta;
115
116	}
117
118	return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
119}
120
121/**
122 * Convert a fraction string to a decimal.
123 *
124 * @since 2.5.0
125 *
126 * @param string $str
127 * @return int|float
128 */
129function wp_exif_frac2dec($str) {
130	@list( $n, $d ) = explode( '/', $str );
131	if ( !empty($d) )
132		return $n / $d;
133	return $str;
134}
135
136/**
137 * Convert the exif date format to a unix timestamp.
138 *
139 * @since 2.5.0
140 *
141 * @param string $str
142 * @return int
143 */
144function wp_exif_date2ts($str) {
145	@list( $date, $time ) = explode( ' ', trim($str) );
146	@list( $y, $m, $d ) = explode( ':', $date );
147
148	return strtotime( "{$y}-{$m}-{$d} {$time}" );
149}
150
151/**
152 * Get extended image metadata, exif or iptc as available.
153 *
154 * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
155 * created_timestamp, focal_length, shutter_speed, and title.
156 *
157 * The IPTC metadata that is retrieved is APP13, credit, byline, created date
158 * and time, caption, copyright, and title. Also includes FNumber, Model,
159 * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.
160 *
161 * @todo Try other exif libraries if available.
162 * @since 2.5.0
163 *
164 * @param string $file
165 * @return bool|array False on failure. Image metadata array on success.
166 */
167function wp_read_image_metadata( $file ) {
168	if ( ! file_exists( $file ) )
169		return false;
170
171	list( , , $sourceImageType ) = getimagesize( $file );
172
173	// exif contains a bunch of data we'll probably never need formatted in ways
174	// that are difficult to use. We'll normalize it and just extract the fields
175	// that are likely to be useful. Fractions and numbers are converted to
176	// floats, dates to unix timestamps, and everything else to strings.
177	$meta = array(
178		'aperture' => 0,
179		'credit' => '',
180		'camera' => '',
181		'caption' => '',
182		'created_timestamp' => 0,
183		'copyright' => '',
184		'focal_length' => 0,
185		'iso' => 0,
186		'shutter_speed' => 0,
187		'title' => '',
188	);
189
190	// read iptc first, since it might contain data not available in exif such
191	// as caption, description etc
192	if ( is_callable( 'iptcparse' ) ) {
193		getimagesize( $file, $info );
194
195		if ( ! empty( $info['APP13'] ) ) {
196			$iptc = iptcparse( $info['APP13'] );
197
198			// headline, "A brief synopsis of the caption."
199			if ( ! empty( $iptc['2#105'][0] ) )
200				$meta['title'] = trim( $iptc['2#105'][0] );
201			// title, "Many use the Title field to store the filename of the image, though the field may be used in many ways."
202			elseif ( ! empty( $iptc['2#005'][0] ) )
203				$meta['title'] = trim( $iptc['2#005'][0] );
204
205			if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
206				$caption = trim( $iptc['2#120'][0] );
207				if ( empty( $meta['title'] ) ) {
208					// Assume the title is stored in 2:120 if it's short.
209					if ( strlen( $caption ) < 80 )
210						$meta['title'] = $caption;
211					else
212						$meta['caption'] = $caption;
213				} elseif ( $caption != $meta['title'] ) {
214					$meta['caption'] = $caption;
215				}
216			}
217
218			if ( ! empty( $iptc['2#110'][0] ) ) // credit
219				$meta['credit'] = trim( $iptc['2#110'][0] );
220			elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline
221				$meta['credit'] = trim( $iptc['2#080'][0] );
222
223			if ( ! empty( $iptc['2#055'][0] ) and ! empty( $iptc['2#060'][0] ) ) // created date and time
224				$meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
225
226			if ( ! empty( $iptc['2#116'][0] ) ) // copyright
227				$meta['copyright'] = trim( $iptc['2#116'][0] );
228		 }
229	}
230
231	// fetch additional info from exif if available
232	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 ) ) ) ) {
233		$exif = @exif_read_data( $file );
234
235		if ( !empty( $exif['Title'] ) )
236			$meta['title'] = trim( $exif['Title'] );
237
238		if ( ! empty( $exif['ImageDescription'] ) ) {
239			if ( empty( $meta['title'] ) && strlen( $exif['ImageDescription'] ) < 80 ) {
240				// Assume the title is stored in ImageDescription
241				$meta['title'] = trim( $exif['ImageDescription'] );
242				if ( ! empty( $exif['COMPUTED']['UserComment'] ) && trim( $exif['COMPUTED']['UserComment'] ) != $meta['title'] )
243					$meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );
244			} elseif ( trim( $exif['ImageDescription'] ) != $meta['title'] ) {
245				$meta['caption'] = trim( $exif['ImageDescription'] );
246			}
247		} elseif ( ! empty( $exif['Comments'] ) && trim( $exif['Comments'] ) != $meta['title'] ) {
248			$meta['caption'] = trim( $exif['Comments'] );
249		}
250
251		if ( ! empty( $exif['Artist'] ) )
252			$meta['credit'] = trim( $exif['Artist'] );
253		elseif ( ! empty($exif['Author'] ) )
254			$meta['credit'] = trim( $exif['Author'] );
255
256		if ( ! empty( $exif['Copyright'] ) )
257			$meta['copyright'] = trim( $exif['Copyright'] );
258		if ( ! empty($exif['FNumber'] ) )
259			$meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );
260		if ( ! empty($exif['Model'] ) )
261			$meta['camera'] = trim( $exif['Model'] );
262		if ( ! empty($exif['DateTimeDigitized'] ) )
263			$meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized'] );
264		if ( ! empty($exif['FocalLength'] ) )
265			$meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );
266		if ( ! empty($exif['ISOSpeedRatings'] ) ) {
267			$meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
268			$meta['iso'] = trim( $meta['iso'] );
269		}
270		if ( ! empty($exif['ExposureTime'] ) )
271			$meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );
272	}
273
274	foreach ( array( 'title', 'caption', 'credit', 'copyright', 'camera', 'iso' ) as $key ) {
275		if ( $meta[ $key ] && ! seems_utf8( $meta[ $key ] ) )
276			$meta[ $key ] = utf8_encode( $meta[ $key ] );
277	}
278
279	return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );
280
281}
282
283/**
284 * Validate that file is an image.
285 *
286 * @since 2.5.0
287 *
288 * @param string $path File path to test if valid image.
289 * @return bool True if valid image, false if not valid image.
290 */
291function file_is_valid_image($path) {
292	$size = @getimagesize($path);
293	return !empty($size);
294}
295
296/**
297 * Validate that file is suitable for displaying within a web page.
298 *
299 * @since 2.5.0
300 * @uses apply_filters() Calls 'file_is_displayable_image' on $result and $path.
301 *
302 * @param string $path File path to test.
303 * @return bool True if suitable, false if not suitable.
304 */
305function file_is_displayable_image($path) {
306	$info = @getimagesize($path);
307	if ( empty($info) )
308		$result = false;
309	elseif ( !in_array($info[2], array(IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG)) )	// only gif, jpeg and png images can reliably be displayed
310		$result = false;
311	else
312		$result = true;
313
314	return apply_filters('file_is_displayable_image', $result, $path);
315}
316
317/**
318 * Load an image resource for editing.
319 *
320 * @since 2.9.0
321 *
322 * @param string $attachment_id Attachment ID.
323 * @param string $mime_type Image mime type.
324 * @param string $size Optional. Image size, defaults to 'full'.
325 * @return resource|false The resulting image resource on success, false on failure.
326 */
327function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
328	$filepath = _load_image_to_edit_path( $attachment_id, $size );
329	if ( empty( $filepath ) )
330		return false;
331
332	switch ( $mime_type ) {
333		case 'image/jpeg':
334			$image = imagecreatefromjpeg($filepath);
335			break;
336		case 'image/png':
337			$image = imagecreatefrompng($filepath);
338			break;
339		case 'image/gif':
340			$image = imagecreatefromgif($filepath);
341			break;
342		default:
343			$image = false;
344			break;
345	}
346	if ( is_resource($image) ) {
347		$image = apply_filters('load_image_to_edit', $image, $attachment_id, $size);
348		if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
349			imagealphablending($image, false);
350			imagesavealpha($image, true);
351		}
352	}
353	return $image;
354}
355
356/**
357 * Retrieve the path or url of an attachment's attached file.
358 *
359 * If the attached file is not present on the local filesystem (usually due to replication plugins),
360 * then the url of the file is returned if url fopen is supported.
361 *
362 * @since 3.4.0
363 * @access private
364 *
365 * @param string $attachment_id Attachment ID.
366 * @param string $size Optional. Image size, defaults to 'full'.
367 * @return string|false File path or url on success, false on failure.
368 */
369function _load_image_to_edit_path( $attachment_id, $size = 'full' ) {
370	$filepath = get_attached_file( $attachment_id );
371
372	if ( $filepath && file_exists( $filepath ) ) {
373		if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
374			$filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
375		}
376	} elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
377		$filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
378	}
379
380	return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
381}
382
383/**
384 * Copy an existing image file.
385 *
386 * @since 3.4.0
387 * @access private
388 *
389 * @param string $attachment_id Attachment ID.
390 * @return string|false New file path on success, false on failure.
391 */
392function _copy_image_file( $attachment_id ) {
393	$dst_file = $src_file = get_attached_file( $attachment_id );
394	if ( ! file_exists( $src_file ) )
395		$src_file = _load_image_to_edit_path( $attachment_id );
396
397	if ( $src_file ) {
398		$dst_file = str_replace( basename( $dst_file ), 'copy-' . basename( $dst_file ), $dst_file );
399		$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
400
401		// The directory containing the original file may no longer exist when
402		// using a replication plugin.
403		wp_mkdir_p( dirname( $dst_file ) );
404
405		if ( ! @copy( $src_file, $dst_file ) )
406			$dst_file = false;
407	} else {
408		$dst_file = false;
409	}
410
411	return $dst_file;
412}