<!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>[59197] trunk/src/js: Customizer: Do not force users to go through the cropping flow if the image is the correct ratio.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59197">59197</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59197","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-08 22:27:44 +0000 (Tue, 08 Oct 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Customizer: Do not force users to go through the cropping flow if the image is the correct ratio.
If a user uploads an 800x800 image and a 512x512 image is required, then they should be allowed to skip cropping. This still creates the correct crop behind the scenes but simplifies the flow a bit for users.
Props nirajgirixd, celloexpressions, westonruter, azaozz, jorbin.
Fixes <a href="https://core.trac.wordpress.org/ticket/36441">#36441</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueswpcustomizecontrolsjs">trunk/src/js/_enqueues/wp/customize/controls.js</a></li>
<li><a href="#trunksrcjsmediacontrollerscropperjs">trunk/src/js/media/controllers/cropper.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueswpcustomizecontrolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/wp/customize/controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/wp/customize/controls.js 2024-10-08 18:37:32 UTC (rev 59196)
+++ trunk/src/js/_enqueues/wp/customize/controls.js 2024-10-08 22:27:44 UTC (rev 59197)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4602,26 +4602,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {Object} Options
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> calculateImageSelectOptions: function( attachment, controller ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var control = controller.get( 'control' ),
- flexWidth = !! parseInt( control.params.flex_width, 10 ),
- flexHeight = !! parseInt( control.params.flex_height, 10 ),
- realWidth = attachment.get( 'width' ),
- realHeight = attachment.get( 'height' ),
- xInit = parseInt( control.params.width, 10 ),
- yInit = parseInt( control.params.height, 10 ),
- ratio = xInit / yInit,
- xImg = xInit,
- yImg = yInit,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var control = controller.get( 'control' ),
+ flexWidth = !! parseInt( control.params.flex_width, 10 ),
+ flexHeight = !! parseInt( control.params.flex_height, 10 ),
+ realWidth = attachment.get( 'width' ),
+ realHeight = attachment.get( 'height' ),
+ xInit = parseInt( control.params.width, 10 ),
+ yInit = parseInt( control.params.height, 10 ),
+ requiredRatio = xInit / yInit,
+ realRatio = realWidth / realHeight,
+ xImg = xInit,
+ yImg = yInit,
</ins><span class="cx" style="display: block; padding: 0 10px"> x1, y1, imgSelectOptions;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ controller.set( 'hasRequiredAspectRatio', control.hasRequiredAspectRatio( requiredRatio, realRatio ) );
+ controller.set( 'suggestedCropSize', { width: realWidth, height: realHeight, x1: 0, y1: 0, x2: xInit, y2: yInit } );
</ins><span class="cx" style="display: block; padding: 0 10px"> controller.set( 'canSkipCrop', ! control.mustBeCropped( flexWidth, flexHeight, xInit, yInit, realWidth, realHeight ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( realWidth / realHeight > ratio ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( realRatio > requiredRatio ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> yInit = realHeight;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- xInit = yInit * ratio;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ xInit = yInit * requiredRatio;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> xInit = realWidth;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- yInit = xInit / ratio;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ yInit = xInit / requiredRatio;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> x1 = ( realWidth - xInit ) / 2;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4662,13 +4665,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Return whether the image must be cropped, based on required dimensions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {boolean} flexW
- * @param {boolean} flexH
- * @param {number} dstW
- * @param {number} dstH
- * @param {number} imgW
- * @param {number} imgH
- * @return {boolean}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param {boolean} flexW Width is flexible.
+ * @param {boolean} flexH Height is flexible.
+ * @param {number} dstW Required width.
+ * @param {number} dstH Required height.
+ * @param {number} imgW Provided image's width.
+ * @param {number} imgH Provided image's height.
+ * @return {boolean} Whether cropping is required.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> mustBeCropped: function( flexW, flexH, dstW, dstH, imgW, imgH ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true === flexW && true === flexH ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4695,6 +4698,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Check if the image's aspect ratio essentially matches the required aspect ratio.
+ *
+ * Floating point precision is low, so this allows a small tolerance. This
+ * tolerance allows for images over 100,000 px on either side to still trigger
+ * the cropping flow.
+ *
+ * @param {number} requiredRatio Required image ratio.
+ * @param {number} realRatio Provided image ratio.
+ * @return {boolean} Whether the image has the required aspect ratio.
+ */
+ hasRequiredAspectRatio: function ( requiredRatio, realRatio ) {
+ if ( Math.abs( requiredRatio - realRatio ) < 0.000001 ) {
+ return true;
+ }
+
+ return false;
+ },
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * If cropping was skipped, apply the image data directly to the setting.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> onSkippedCrop: function() {
</span></span></pre></div>
<a id="trunksrcjsmediacontrollerscropperjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/controllers/cropper.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/controllers/cropper.js 2024-10-08 18:37:32 UTC (rev 59196)
+++ trunk/src/js/media/controllers/cropper.js 2024-10-08 22:27:44 UTC (rev 59197)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,9 +93,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {void}
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> createCropToolbar: function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var canSkipCrop, toolbarOptions;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var canSkipCrop, hasRequiredAspectRatio, suggestedCropSize, toolbarOptions;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- canSkipCrop = this.get('canSkipCrop') || false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ suggestedCropSize = this.get( 'suggestedCropSize' );
+ hasRequiredAspectRatio = this.get( 'hasRequiredAspectRatio' );
+ canSkipCrop = this.get( 'canSkipCrop' ) || false;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> toolbarOptions = {
</span><span class="cx" style="display: block; padding: 0 10px"> controller: this.frame,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,7 +129,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( canSkipCrop ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( canSkipCrop || hasRequiredAspectRatio ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _.extend( toolbarOptions.items, {
</span><span class="cx" style="display: block; padding: 0 10px"> skip: {
</span><span class="cx" style="display: block; padding: 0 10px"> style: 'secondary',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,10 +137,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> priority: 70,
</span><span class="cx" style="display: block; padding: 0 10px"> requires: { library: false, selection: false },
</span><span class="cx" style="display: block; padding: 0 10px"> click: function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var selection = this.controller.state().get('selection').first();
- this.controller.state().cropperView.remove();
- this.controller.trigger('skippedcrop', selection);
- this.controller.close();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var controller = this.controller,
+ selection = controller.state().get( 'selection' ).first();
+
+ controller.state().cropperView.remove();
+
+ // Apply the suggested crop size.
+ if ( hasRequiredAspectRatio && !canSkipCrop ) {
+ selection.set({cropDetails: suggestedCropSize});
+ controller.state().doCrop( selection ).done( function( croppedImage ) {
+ controller.trigger( 'cropped', croppedImage );
+ controller.close();
+ }).fail( function() {
+ controller.trigger( 'content:error:crop' );
+ });
+ return;
+ }
+
+ // Skip the cropping process.
+ controller.trigger( 'skippedcrop', selection );
+ controller.close();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span></span></pre>
</div>
</div>
</body>
</html>