using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Umbraco.Core; using Umbraco.Core.Models; using Umbraco.Web.Models; using Umbraco.Web.PropertyEditors; namespace Umbraco.Web { using System.Globalization; /// /// Provides extension methods for getting ImageProcessor Url from the core Image Cropper property editor /// public static class ImageCropperTemplateExtensions { /// /// Gets the ImageProcessor Url by the crop alias (from the "umbracoFile" property alias) on the IPublishedContent item /// /// /// The IPublishedContent item. /// /// /// The crop alias e.g. thumbnail /// /// /// The ImageProcessor.Web Url. /// public static string GetCropUrl(this IPublishedContent mediaItem, string cropAlias) { return mediaItem.GetCropUrl(cropAlias: cropAlias, useCropDimensions: true); } /// /// Gets the ImageProcessor Url by the crop alias using the specified property containing the image cropper Json data on the IPublishedContent item. /// /// /// The IPublishedContent item. /// /// /// The property alias of the property containing the Json data e.g. umbracoFile /// /// /// The crop alias e.g. thumbnail /// /// /// The ImageProcessor.Web Url. /// public static string GetCropUrl(this IPublishedContent mediaItem, string propertyAlias, string cropAlias) { return mediaItem.GetCropUrl(propertyAlias: propertyAlias, cropAlias: cropAlias, useCropDimensions: true); } /// /// Gets the ImageProcessor Url from the IPublishedContent item. /// /// /// The IPublishedContent item. /// /// /// The width of the output image. /// /// /// The height of the output image. /// /// /// Property alias of the property containing the Json data. /// /// /// The crop alias. /// /// /// Quality percentage of the output image. /// /// /// The image crop mode. /// /// /// The image crop anchor. /// /// /// Use focal point, to generate an output image using the focal point instead of the predefined crop /// /// /// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters>. /// /// /// Add a serialised date of the last edit of the item to ensure client cache refresh when updated /// /// /// The further options. /// /// /// Use a dimension as a ratio /// /// /// If the image should be upscaled to requested dimensions /// /// /// The . /// public static string GetCropUrl( this IPublishedContent mediaItem, 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 ) { string imageCropperValue = null; string mediaItemUrl; if (mediaItem.HasProperty(propertyAlias) && mediaItem.HasValue(propertyAlias)) { imageCropperValue = mediaItem.GetPropertyValue(propertyAlias); // get the raw value (this will be json) var urlValue = mediaItem.GetPropertyValue(propertyAlias); mediaItemUrl = urlValue.DetectIsJson() ? urlValue.SerializeToCropDataSet().Src : urlValue; } else { mediaItemUrl = mediaItem.Url; } var cacheBusterValue = cacheBuster ? mediaItem.UpdateDate.ToFileTimeUtc().ToString(CultureInfo.InvariantCulture) : null; return mediaItemUrl != null ? GetCropUrl(mediaItemUrl, width, height, imageCropperValue, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale) : string.Empty; } /// /// Gets the ImageProcessor Url from the image path. /// /// /// The image url. /// /// /// The width of the output image. /// /// /// The height of the output image. /// /// /// Quality percentage of the output image. /// /// /// The image crop mode. /// /// /// The image crop anchor. /// /// /// The Json data from the Umbraco Core Image Cropper property editor /// /// /// The crop alias. /// /// /// Use focal point to generate an output image using the focal point instead of the predefined crop if there is one /// /// /// Use crop dimensions to have the output image sized according to the predefined crop sizes, this will override the width and height parameters>. /// /// /// Add a serialised date of the last edit of the item to ensure client cache refresh when updated /// /// /// The further options. /// /// /// Use a dimension as a ratio /// /// /// If the image should be upscaled to requested dimensions /// /// /// The . /// public static string GetCropUrl( this string imageUrl, int? width = null, int? height = null, string imageCropperValue = null, string cropAlias = null, int? quality = null, ImageCropMode? imageCropMode = null, ImageCropAnchor? imageCropAnchor = null, bool preferFocalPoint = false, bool useCropDimensions = false, string cacheBusterValue = null, string furtherOptions = null, ImageCropRatioMode? ratioMode = null, bool upScale = true ) { if (string.IsNullOrEmpty(imageUrl) == false) { var imageResizerUrl = new StringBuilder(); if (string.IsNullOrEmpty(imageCropperValue) == false && imageCropperValue.DetectIsJson() && (imageCropMode == ImageCropMode.Crop || imageCropMode == null)) { var cropDataSet = imageCropperValue.SerializeToCropDataSet(); if (cropDataSet != null) { var crop = cropDataSet.GetCrop(cropAlias); imageResizerUrl.Append(cropDataSet.Src); var cropBaseUrl = cropDataSet.GetCropBaseUrl(cropAlias, preferFocalPoint); if (cropBaseUrl != null) { imageResizerUrl.Append(cropBaseUrl); } else { return null; } if (crop!= null & useCropDimensions) { width = crop.Width; height = crop.Height; } } } else { imageResizerUrl.Append(imageUrl); if (imageCropMode == null) { imageCropMode = ImageCropMode.Pad; } imageResizerUrl.Append("?mode=" + imageCropMode.ToString().ToLower()); if (imageCropAnchor != null) { imageResizerUrl.Append("&anchor=" + imageCropAnchor.ToString().ToLower()); } } if (quality != null) { imageResizerUrl.Append("&quality=" + quality); } if (width != null && ratioMode != ImageCropRatioMode.Width) { imageResizerUrl.Append("&width=" + width); } if (height != null && ratioMode != ImageCropRatioMode.Height) { imageResizerUrl.Append("&height=" + height); } if (ratioMode == ImageCropRatioMode.Width && height != null) { //if only height specified then assume a sqaure if (width == null) { width = height; } var widthRatio = (decimal)width/(decimal)height; imageResizerUrl.Append("&widthratio=" + widthRatio.ToString(CultureInfo.InvariantCulture)); } if (ratioMode == ImageCropRatioMode.Height && width != null) { //if only width specified then assume a sqaure if (height == null) { height = width; } var heightRatio = (decimal)height/(decimal)width; imageResizerUrl.Append("&heightratio=" + heightRatio.ToString(CultureInfo.InvariantCulture)); } if (upScale == false) { imageResizerUrl.Append("&upscale=false"); } if (furtherOptions != null) { imageResizerUrl.Append(furtherOptions); } if (cacheBusterValue != null) { imageResizerUrl.Append("&rnd=").Append(cacheBusterValue); } return imageResizerUrl.ToString(); } return string.Empty; } } }