]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/media.php
Wordpress 3.0-scripts
[autoinstalls/wordpress.git] / wp-includes / media.php
index 8f0bf3aaa1435e034986b2f7c0cf457d5791514f..ee4db93b32817aedb5dfccb4fb0e3dde4c87aa0a 100644 (file)
@@ -64,7 +64,7 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') {
        } elseif ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ) ) ) {
                $max_width = intval( $_wp_additional_image_sizes[$size]['width'] );
                $max_height = intval( $_wp_additional_image_sizes[$size]['height'] );
-               if ( intval($content_width) > 0 )
+               if ( intval($content_width) > 0 && is_admin() ) // Only in admin. Assume that theme authors know what they're doing.
                        $max_width = min( intval($content_width), $max_width );
        }
        // $size == 'full' has no constraint
@@ -230,11 +230,38 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') {
        return $html;
 }
 
+/**
+ * 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;
+}
+
 /**
  * Calculates the new dimentions for a downsampled image.
  *
- * Same as {@link wp_shrink_dimensions()}, except the max parameters are
- * optional. If either width or height are empty, no constraint is applied on
+ * If either width or height are empty, no constraint is applied on
  * that dimension.
  *
  * @since 2.5.0
@@ -250,17 +277,41 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0,
                return array( $current_width, $current_height );
 
        $width_ratio = $height_ratio = 1.0;
+       $did_width = $did_height = false;
 
-       if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width )
+       if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
                $width_ratio = $max_width / $current_width;
+               $did_width = true;
+       }
 
-       if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height )
+       if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
                $height_ratio = $max_height / $current_height;
+               $did_height = true;
+       }
 
-       // the smaller ratio is the one we need to fit it to the constraining box
-       $ratio = min( $width_ratio, $height_ratio );
-
-       return array( intval($current_width * $ratio), intval($current_height * $ratio) );
+       // Calculate the larger/smaller ratios
+       $smaller_ratio = min( $width_ratio, $height_ratio );
+       $larger_ratio  = max( $width_ratio, $height_ratio );
+
+       if ( intval( $current_width * $larger_ratio ) > $max_width || intval( $current_height * $larger_ratio ) > $max_height )
+               // The larger ratio is too big. It would result in an overflow.
+               $ratio = $smaller_ratio;
+       else
+               // The larger ratio fits, and is likely to be a more "snug" fit.
+               $ratio = $larger_ratio;
+
+       $w = intval( $current_width  * $ratio );
+       $h = intval( $current_height * $ratio );
+
+       // Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
+       // We also have issues with recursive calls resulting in an ever-changing result. Contraining to the result of a constraint should yield the original result.
+       // Thus we look for dimensions that are one pixel shy of the max value and bump them up
+       if ( $did_width && $w == $max_width - 1 )
+               $w = $max_width; // Round it up
+       if ( $did_height && $h == $max_height - 1 )
+               $h = $max_height; // Round it up
+
+       return array( $w, $h );
 }
 
 /**
@@ -349,13 +400,13 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal
  * @param string $suffix Optional. File Suffix.
  * @param string $dest_path Optional. New image file path.
  * @param int $jpeg_quality Optional, default is 90. Image quality percentage.
- * @return mixed WP_Error on failure. String with new destination path. Array of dimensions from {@link image_resize_dimensions()}
+ * @return mixed WP_Error on failure. String with new destination path.
  */
 function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) {
 
        $image = wp_load_image( $file );
        if ( !is_resource( $image ) )
-               return new WP_Error('error_loading_image', $image);
+               return new WP_Error( 'error_loading_image', $image, $file );
 
        $size = @getimagesize( $file );
        if ( !$size )
@@ -364,7 +415,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de
 
        $dims = image_resize_dimensions($orig_w, $orig_h, $max_w, $max_h, $crop);
        if ( !$dims )
-               return $dims;
+               return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions') );
        list($dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) = $dims;
 
        $newimage = wp_imagecreatetruecolor( $dst_w, $dst_h );
@@ -372,7 +423,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de
        imagecopyresampled( $newimage, $image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h);
 
        // convert from full colors to index colors, like original PNG.
-       if ( IMAGETYPE_PNG == $orig_type && !imageistruecolor( $image ) )
+       if ( IMAGETYPE_PNG == $orig_type && function_exists('imageistruecolor') && !imageistruecolor( $image ) )
                imagetruecolortopalette( $newimage, false, imagecolorstotal( $image ) );
 
        // we don't need the original in memory anymore
@@ -457,7 +508,13 @@ function image_make_intermediate_size($file, $width, $height, $crop=false) {
  *
  * The url path will be given, when the $size parameter is a string.
  *
+ * If you are passing an array for the $size, you should consider using
+ * add_image_size() so that a cropped version is generated. It's much more
+ * efficient than having to find the closest-sized image and then having the
+ * browser scale down the image.
+ *
  * @since 2.5.0
+ * @see add_image_size()
  *
  * @param int $post_id Attachment ID for image.
  * @param array|string $size Optional, default is 'thumbnail'. Size of image, either array or string.
@@ -485,6 +542,13 @@ function image_get_intermediate_size($post_id, $size='thumbnail') {
                        foreach ( $areas as $_size ) {
                                $data = $imagedata['sizes'][$_size];
                                if ( $data['width'] >= $size[0] || $data['height'] >= $size[1] ) {
+                                       // Skip images with unexpectedly divergent aspect ratios (crops)
+                                       // First, we calculate what size the original image would be if constrained to a box the size of the current image in the loop
+                                       $maybe_cropped = image_resize_dimensions($imagedata['width'], $imagedata['height'], $data['width'], $data['height'], false );
+                                       // If the size doesn't match within one pixel, then it is of a different aspect ratio, so we skip it, unless it's the thumbnail size
+                                       if ( 'thumbnail' != $_size && ( !$maybe_cropped || ( $maybe_cropped[4] != $data['width'] && $maybe_cropped[4] + 1 != $data['width'] ) || ( $maybe_cropped[5] != $data['height'] && $maybe_cropped[5] + 1 != $data['height'] ) ) )
+                                               continue;
+                                       // If we're still here, then we're going to use this size
                                        $file = $data['file'];
                                        list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
                                        return compact( 'file', 'width', 'height' );
@@ -506,6 +570,20 @@ function image_get_intermediate_size($post_id, $size='thumbnail') {
        return $data;
 }
 
+/**
+ * Get the available image sizes
+ * @since 3.0.0
+ * @return array Returns a filtered array of image size strings
+ */
+function get_intermediate_image_sizes() {
+       global $_wp_additional_image_sizes;
+       $image_sizes = array('thumbnail', 'medium', 'large'); // Standard sizes
+       if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) )
+               $image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) );
+
+       return apply_filters( 'intermediate_image_sizes', $image_sizes );
+}
+
 /**
  * Retrieve an image to represent an attachment.
  *
@@ -539,6 +617,12 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon =
 /**
  * Get an HTML img element representing an image attachment
  *
+ * While $size will accept an array, it is better to register a size with
+ * add_image_size() so that a cropped version is generated. It's much more
+ * efficient than having to find the closest-sized image and then having the
+ * browser scale down the image.
+ *
+ * @see add_image_size()
  * @uses apply_filters() Calls 'wp_get_attachment_image_attributes' hook on attributes array
  * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions
  * @since 2.5.0
@@ -561,9 +645,14 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa
                $default_attr = array(
                        'src'   => $src,
                        'class' => "attachment-$size",
-                       'alt'   => trim(strip_tags( $attachment->post_excerpt )),
+                       'alt'   => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first
                        'title' => trim(strip_tags( $attachment->post_title )),
                );
+               if ( empty($default_attr['alt']) )
+                       $default_attr['alt'] = trim(strip_tags( $attachment->post_excerpt )); // If not, Use the Caption
+               if ( empty($default_attr['alt']) )
+                       $default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title
+
                $attr = wp_parse_args($attr, $default_attr);
                $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment );
                $attr = array_map( 'esc_attr', $attr );
@@ -582,7 +671,6 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa
  * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
  * dynamically add/remove itself so as to only filter post thumbnail thumbnails
  *
- * @author Mark Jaquith
  * @since 2.9.0
  * @param array $attr Attributes including src, class, alt, title
  * @return array
@@ -595,7 +683,6 @@ function _wp_post_thumbnail_class_filter( $attr ) {
 /**
  * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter
  *
- * @author Mark Jaquith
  * @since 2.9.0
  */
 function _wp_post_thumbnail_class_filter_add( $attr ) {
@@ -605,7 +692,6 @@ function _wp_post_thumbnail_class_filter_add( $attr ) {
 /**
  * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter
  *
- * @author Mark Jaquith
  * @since 2.9.0
  */
 function _wp_post_thumbnail_class_filter_remove( $attr ) {
@@ -731,8 +817,8 @@ function gallery_shortcode($attr) {
        $captiontag = tag_escape($captiontag);
        $columns = intval($columns);
        $itemwidth = $columns > 0 ? floor(100/$columns) : 100;
-       $float = $wp_locale->text_direction == 'rtl' ? 'right' : 'left'; 
-       
+       $float = is_rtl() ? 'right' : 'left';
+
        $selector = "gallery-{$instance}";
 
        $output = apply_filters('gallery_style', "
@@ -945,6 +1031,9 @@ class WP_Embed {
                // Hack to get the [embed] shortcode to run before wpautop()
                add_filter( 'the_content', array(&$this, 'run_shortcode'), 8 );
 
+               // Shortcode placeholder for strip_shortcodes()
+               add_shortcode( 'embed', '__return_false' );
+
                // Attempts to embed all URLs in a post
                if ( get_option('embed_autourls') )
                        add_filter( 'the_content', array(&$this, 'autoembed'), 8 );
@@ -1099,7 +1188,7 @@ class WP_Embed {
                        }
 
                        // Use oEmbed to get the HTML
-                       $attr['discover'] = ( apply_filters('embed_oembed_discover', false) && author_can( $post_ID, 'unfiltered_html' ) ) ? true : false;
+                       $attr['discover'] = ( apply_filters('embed_oembed_discover', false) && author_can( $post_ID, 'unfiltered_html' ) );
                        $html = wp_oembed_get( $url, $attr );
 
                        // Cache the result
@@ -1232,15 +1321,20 @@ function wp_embed_defaults() {
 
        $width = get_option('embed_size_w');
 
-       if ( !$width && !empty($theme_width) )
+       if ( empty($width) && !empty($theme_width) )
                $width = $theme_width;
 
-       if ( !$width )
+       if ( empty($width) )
                $width = 500;
 
+       $height = get_option('embed_size_h');
+
+       if ( empty($height) )
+               $height = 700;
+
        return apply_filters( 'embed_defaults', array(
-               'width' => $width,
-               'height' => 700,
+               'width'  => $width,
+               'height' => $height,
        ) );
 }
 
@@ -1279,7 +1373,7 @@ function wp_expand_dimensions( $example_width, $example_height, $max_width, $max
  * @return string The original URL on failure or the embed HTML on success.
  */
 function wp_oembed_get( $url, $args = '' ) {
-       require_once( 'class-oembed.php' );
+       require_once( ABSPATH . WPINC . '/class-oembed.php' );
        $oembed = _wp_oembed_get_object();
        return $oembed->get_html( $url, $args );
 }
@@ -1294,10 +1388,10 @@ function wp_oembed_get( $url, $args = '' ) {
  *
  * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
  * @param string $provider The URL to the oEmbed provider.
- * @param boolean $regex Whether the $format parameter is in a regex format or not.
+ * @param boolean $regex Whether the $format parameter is in a regex format.
  */
 function wp_oembed_add_provider( $format, $provider, $regex = false ) {
-       require_once( 'class-oembed.php' );
+       require_once( ABSPATH . WPINC . '/class-oembed.php' );
        $oembed = _wp_oembed_get_object();
        $oembed->providers[$format] = array( $provider, $regex );
 }