<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26645] trunk/src/wp-includes: Improvements to image quality handling in the image editor classes.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26645">26645</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-12-04 22:48:45 +0000 (Wed, 04 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improvements to image quality handling in the image editor classes.
props markoheijnen, DH-Shredder.
fixes <a href="http://core.trac.wordpress.org/ticket/25721">#25721</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpimageeditorgdphp">trunk/src/wp-includes/class-wp-image-editor-gd.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorimagickphp">trunk/src/wp-includes/class-wp-image-editor-imagick.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpimageeditorgdphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor-gd.php (26644 => 26645)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor-gd.php 2013-12-04 22:23:02 UTC (rev 26644)
+++ trunk/src/wp-includes/class-wp-image-editor-gd.php 2013-12-04 22:48:45 UTC (rev 26645)
</span><span class="lines">@@ -77,7 +77,7 @@
</span><span class="cx"> * @since 3.5.0
</span><span class="cx"> * @access protected
</span><span class="cx"> *
</span><del>- * @return boolean|\WP_Error
</del><ins>+ * @return boolean|WP_Error True if loaded successfully; WP_Error on failure.
</ins><span class="cx"> */
</span><span class="cx"> public function load() {
</span><span class="cx"> if ( $this->image )
</span><span class="lines">@@ -86,8 +86,16 @@
</span><span class="cx"> if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
</span><span class="cx"> return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the memory limit allocated for image manipulation.
+ *
+ * @since 3.5.0
+ *
+ * @param int Maximum memory limit to allocate (default is WP_MAX_MEMORY_LIMIT)
+ */
</ins><span class="cx"> // Set artificially high because GD uses uncompressed images in memory
</span><span class="cx"> @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
</span><ins>+
</ins><span class="cx"> $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
</span><span class="cx">
</span><span class="cx"> if ( ! is_resource( $this->image ) )
</span><span class="lines">@@ -105,7 +113,7 @@
</span><span class="cx"> $this->update_size( $size[0], $size[1] );
</span><span class="cx"> $this->mime_type = $size['mime'];
</span><span class="cx">
</span><del>- return true;
</del><ins>+ return $this->set_quality( $this->quality );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -361,7 +369,7 @@
</span><span class="cx"> return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
</span><span class="cx"> }
</span><span class="cx"> elseif ( 'image/jpeg' == $mime_type ) {
</span><del>- if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, apply_filters( 'jpeg_quality', $this->quality, 'image_resize' ) ) ) )
</del><ins>+ if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->quality ) ) )
</ins><span class="cx"> return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
</span><span class="cx"> }
</span><span class="cx"> else {
</span><span class="lines">@@ -373,12 +381,19 @@
</span><span class="cx"> $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
</span><span class="cx"> @ chmod( $filename, $perms );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the name of the saved image file.
+ *
+ * @since 2.6.0
+ *
+ * @param string $filename Name of the file.
+ */
</ins><span class="cx"> return array(
</span><del>- 'path' => $filename,
- 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
- 'width' => $this->size['width'],
- 'height' => $this->size['height'],
- 'mime-type'=> $mime_type,
</del><ins>+ 'path' => $filename,
+ 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+ 'width' => $this->size['width'],
+ 'height' => $this->size['height'],
+ 'mime-type' => $mime_type,
</ins><span class="cx"> );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorimagickphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor-imagick.php (26644 => 26645)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor-imagick.php 2013-12-04 22:23:02 UTC (rev 26644)
+++ trunk/src/wp-includes/class-wp-image-editor-imagick.php 2013-12-04 22:48:45 UTC (rev 26645)
</span><span class="lines">@@ -119,6 +119,7 @@
</span><span class="cx"> if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
</span><span class="cx"> return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
</ins><span class="cx"> // Even though Imagick uses less PHP memory than GD, set higher limit for users that have low PHP.ini limits
</span><span class="cx"> @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
</span><span class="cx">
</span><span class="lines">@@ -142,7 +143,7 @@
</span><span class="cx"> if ( is_wp_error( $updated_size ) )
</span><span class="cx"> return $updated_size;
</span><span class="cx">
</span><del>- return $this->set_quality();
</del><ins>+ return $this->set_quality( $this->quality );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -152,15 +153,19 @@
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><span class="cx"> * @param int $quality Compression Quality. Range: [1,100]
</span><del>- * @return boolean|WP_Error
</del><ins>+ * @return boolean|WP_Error True if set successfully; WP_Error on failure.
</ins><span class="cx"> */
</span><span class="cx"> public function set_quality( $quality = null ) {
</span><del>- if ( !$quality )
</del><ins>+ $quality_result = parent::set_quality( $quality );
+ if ( is_wp_error( $quality_result ) ) {
+ return $quality_result;
+ } else {
</ins><span class="cx"> $quality = $this->quality;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> try {
</span><del>- if( 'image/jpeg' == $this->mime_type ) {
- $this->image->setImageCompressionQuality( apply_filters( 'jpeg_quality', $quality, 'image_resize' ) );
</del><ins>+ if ( 'image/jpeg' == $this->mime_type ) {
+ $this->image->setImageCompressionQuality( $quality );
</ins><span class="cx"> $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
</span><span class="cx"> }
</span><span class="cx"> else {
</span><span class="lines">@@ -171,7 +176,7 @@
</span><span class="cx"> return new WP_Error( 'image_quality_error', $e->getMessage() );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return parent::set_quality( $quality );
</del><ins>+ return true;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -447,11 +452,12 @@
</span><span class="cx"> $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
</span><span class="cx"> @ chmod( $filename, $perms );
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
</ins><span class="cx"> return array(
</span><del>- 'path' => $filename,
- 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
- 'width' => $this->size['width'],
- 'height' => $this->size['height'],
</del><ins>+ 'path' => $filename,
+ 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+ 'width' => $this->size['width'],
+ 'height' => $this->size['height'],
</ins><span class="cx"> 'mime-type' => $mime_type,
</span><span class="cx"> );
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor.php (26644 => 26645)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor.php 2013-12-04 22:23:02 UTC (rev 26644)
+++ trunk/src/wp-includes/class-wp-image-editor.php 2013-12-04 22:48:45 UTC (rev 26645)
</span><span class="lines">@@ -205,19 +205,45 @@
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><span class="cx"> * @param int $quality Compression Quality. Range: [1,100]
</span><del>- * @return boolean
</del><ins>+ * @return boolean|WP_Error True if set successfully; WP_Error on failure.
</ins><span class="cx"> */
</span><del>- public function set_quality( $quality ) {
</del><ins>+ public function set_quality( $quality = null ) {
+ if ( $quality == null ) {
+ $quality = $this->quality;
+ }
+
</ins><span class="cx"> /**
</span><span class="cx"> * Filter the default quality setting.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.5.0
</span><span class="cx"> *
</span><del>- * @param int $quality Quality level between 0 (low) and 100 (high).
</del><ins>+ * @param int $quality Quality level between 1 (low) and 100 (high).
</ins><span class="cx"> */
</span><del>- $this->quality = apply_filters( 'wp_editor_set_quality', $quality );
</del><ins>+ $quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
</ins><span class="cx">
</span><del>- return ( (bool) $this->quality );
</del><ins>+ /**
+ * Filter the JPEG quality for backwards compatibilty.
+ *
+ * @since 2.5.0
+ *
+ * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
+ * @param string The context of the filter.
+ */
+ if ( 'image/jpeg' == $this->mime_type ) {
+ $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
+
+ // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
+ if ( $quality == 0 ) {
+ $quality = 1;
+ }
+ }
+
+ if ( ( $quality >= 1 ) && ( $quality <= 100 ) ){
+ $this->quality = $quality;
+ return true;
+ } else {
+ return new WP_Error( 'invalid_image_quality', __('Attempted to set image quality outside of the range [1,100].') );
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>