Add GetCropUrl overloads to better handle local crops only, improve null checks

Author: ronaldbarendse

src/Umbraco.Web/ImageCropperTemplateCoreExtensions.cs

@@ -33,10 +33,25 @@ public static string GetCropUrl(this MediaWithCrops mediaWithCrops, string cropA
             return mediaWithCrops.GetCropUrl(imageUrlGenerator, cropAlias: cropAlias, useCropDimensions: true);
         }
 
-        [Obsolete("This method does not get the crops or cache buster value from the media item.")]
+        [Obsolete("Use the GetCropUrl overload with the updated parameter order and note this implementation has changed to get the URL from the media item.")]
         public static string GetCropUrl(this IPublishedContent mediaItem, string cropAlias, IImageUrlGenerator imageUrlGenerator, ImageCropperValue imageCropperValue)
         {
-            return mediaItem.Url().GetCropUrl(imageUrlGenerator, imageCropperValue, cropAlias: cropAlias, useCropDimensions: true);
+            return mediaItem.GetCropUrl(imageCropperValue, cropAlias, imageUrlGenerator);
+        }
+
+        /// <summary>
+        /// Gets the crop URL by using only the specified <paramref name="imageCropperValue" />.
+        /// </summary>
+        /// <param name="mediaItem">The media item.</param>
+        /// <param name="imageCropperValue">The image cropper value.</param>
+        /// <param name="cropAlias">The crop alias.</param>
+        /// <param name="imageUrlGenerator">The image URL generator.</param>
+        /// <returns>
+        /// The image crop URL.
+        /// </returns>
+        public static string GetCropUrl(this IPublishedContent mediaItem, ImageCropperValue imageCropperValue, string cropAlias,  IImageUrlGenerator imageUrlGenerator)
+        {
+            return mediaItem.GetCropUrl(imageUrlGenerator, imageCropperValue, true, cropAlias: cropAlias, useCropDimensions: true);
         }
 
         /// <summary>
@@ -134,7 +149,7 @@ public static string GetCropUrl(
              ImageCropRatioMode? ratioMode = null,
              bool upScale = true)
         {
-            return mediaItem.GetCropUrl(imageUrlGenerator, null, width, height, propertyAlias, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode, upScale);
+            return mediaItem.GetCropUrl(imageUrlGenerator, null, false, width, height, propertyAlias, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode, upScale);
         }
 
         public static string GetCropUrl(
@@ -154,28 +169,31 @@ public static string GetCropUrl(
              ImageCropRatioMode? ratioMode = null,
              bool upScale = true)
         {
-            return mediaWithCrops.MediaItem.GetCropUrl(imageUrlGenerator, mediaWithCrops.LocalCrops, width, height, propertyAlias, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode, upScale);
+            if (mediaWithCrops == null) throw new ArgumentNullException(nameof(mediaWithCrops));
+
+            return mediaWithCrops.Content.GetCropUrl(imageUrlGenerator, mediaWithCrops.LocalCrops, false, width, height, propertyAlias, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBuster, furtherOptions, ratioMode, upScale);
         }
 
         private static string GetCropUrl(
              this IPublishedContent mediaItem,
              IImageUrlGenerator imageUrlGenerator,
              ImageCropperValue localCrops,
-             int? width,
-             int? height,
-             string propertyAlias,
-             string cropAlias,
-             int? quality,
-             ImageCropMode? imageCropMode,
-             ImageCropAnchor? imageCropAnchor,
-             bool preferFocalPoint,
-             bool useCropDimensions,
-             bool cacheBuster,
-             string furtherOptions,
-             ImageCropRatioMode? ratioMode,
-             bool upScale)
+             bool localCropsOnly,
+             int? width = null,
+             int? height = null,
+             string propertyAlias = Constants.Conventions.Media.File,
+             string cropAlias = null,
+             int? quality = null,
+             ImageCropMode? imageCropMode = null,
+             ImageCropAnchor? imageCropAnchor = null,
+             bool preferFocalPoint = false,
+             bool useCropDimensions = false,
+             bool cacheBuster = true,
+             string furtherOptions = null,
+             ImageCropRatioMode? ratioMode = null,
+             bool upScale = true)
         {
-            if (mediaItem == null) throw new ArgumentNullException("mediaItem");
+            if (mediaItem == null) throw new ArgumentNullException(nameof(mediaItem));
 
             var cacheBusterValue = cacheBuster ? mediaItem.UpdateDate.ToFileTimeUtc().ToString(CultureInfo.InvariantCulture) : null;
 
@@ -184,8 +202,8 @@ private static string GetCropUrl(
 
             var mediaItemUrl = mediaItem.MediaUrl(propertyAlias: propertyAlias);
 
-            // Only get crops when used
-            if (imageCropMode == ImageCropMode.Crop || imageCropMode == null)
+            // Only get crops from media when required and used
+            if (localCropsOnly == false && (imageCropMode == ImageCropMode.Crop || imageCropMode == null))
             {
                 // Get the default cropper value from the value converter
                 var cropperValue = mediaItem.Value(propertyAlias);

src/Umbraco.Web/ImageCropperTemplateExtensions.cs

@@ -32,8 +32,19 @@ public static class ImageCropperTemplateExtensions
 
         public static string GetCropUrl(this MediaWithCrops mediaWithCrops, string cropAlias) => ImageCropperTemplateCoreExtensions.GetCropUrl(mediaWithCrops, cropAlias, Current.ImageUrlGenerator);
 
-        [Obsolete("This method does not get the crops or cache buster value from the media item.")]
-        public static string GetCropUrl(this IPublishedContent mediaItem, string cropAlias, ImageCropperValue imageCropperValue) => ImageCropperTemplateCoreExtensions.GetCropUrl(mediaItem, cropAlias, Current.ImageUrlGenerator, imageCropperValue);
+        [Obsolete("Use the GetCropUrl overload with the updated parameter order and note this implementation has changed to get the URL from the media item.")]
+        public static string GetCropUrl(this IPublishedContent mediaItem, string cropAlias, ImageCropperValue imageCropperValue) => mediaItem.GetCropUrl(imageCropperValue, cropAlias);
+
+        /// <summary>
+        /// Gets the crop URL by using only the specified <paramref name="imageCropperValue" />.
+        /// </summary>
+        /// <param name="mediaItem">The media item.</param>
+        /// <param name="imageCropperValue">The image cropper value.</param>
+        /// <param name="cropAlias">The crop alias.</param>
+        /// <returns>
+        /// The image crop URL.
+        /// </returns>
+        public static string GetCropUrl(this IPublishedContent mediaItem, ImageCropperValue imageCropperValue, string cropAlias) => ImageCropperTemplateCoreExtensions.GetCropUrl(mediaItem, imageCropperValue, cropAlias, Current.ImageUrlGenerator);
 
         /// <summary>
         /// Gets the ImageProcessor URL by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item.

src/Umbraco.Web/UrlHelperRenderExtensions.cs

@@ -283,7 +283,7 @@ public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
 
         public static IHtmlString GetCropUrl(this UrlHelper urlHelper, ImageCropperValue imageCropperValue, string cropAlias, bool htmlEncode = true)
         {
-            if (imageCropperValue == null) return EmptyHtmlString;
+            if (imageCropperValue == null || string.IsNullOrEmpty(imageCropperValue.Src)) return EmptyHtmlString;
 
             var url = imageCropperValue.Src.GetCropUrl(imageCropperValue, cropAlias: cropAlias, useCropDimensions: true);
 
@@ -306,7 +306,7 @@ public static IHtmlString GetCropUrl(this UrlHelper urlHelper,
             bool upScale = true,
             bool htmlEncode = true)
         {
-            if (imageCropperValue == null) return EmptyHtmlString;
+            if (imageCropperValue == null || string.IsNullOrEmpty(imageCropperValue.Src)) return EmptyHtmlString;
 
             var url = imageCropperValue.Src.GetCropUrl(imageCropperValue, width, height, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale);