using System; using Newtonsoft.Json.Linq; using System.Globalization; using System.Text; using Umbraco.Core; using Umbraco.Core.Models; using Umbraco.Core.Models.PublishedContent; using Umbraco.Web.Models; namespace Umbraco.Web { /// /// 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 /// /// /// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example: /// /// /// /// /// /// 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) { if (mediaItem == null) throw new ArgumentNullException("mediaItem"); var cacheBusterValue = cacheBuster ? mediaItem.UpdateDate.ToFileTimeUtc().ToString(CultureInfo.InvariantCulture) : null; if (mediaItem.HasProperty(propertyAlias) == false || mediaItem.HasValue(propertyAlias) == false) return string.Empty; //get the default obj from the value converter var cropperValue = mediaItem.Value(propertyAlias); //is it strongly typed? var stronglyTyped = cropperValue as ImageCropDataSet; string mediaItemUrl; if (stronglyTyped != null) { mediaItemUrl = stronglyTyped.Src; return GetCropUrl( mediaItemUrl, stronglyTyped, width, height, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale); } //this shouldn't be the case but we'll check var jobj = cropperValue as JObject; if (jobj != null) { stronglyTyped = jobj.ToObject(); mediaItemUrl = stronglyTyped.Src; return GetCropUrl( mediaItemUrl, stronglyTyped, width, height, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale); } //it's a single string mediaItemUrl = cropperValue.ToString(); return GetCropUrl( mediaItemUrl, width, height, mediaItemUrl, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale); } /// /// Gets the ImageProcessor Url from the image path. /// /// /// The image url. /// /// /// The width of the output image. /// /// /// The height of the output image. /// /// /// The Json data from the Umbraco Core Image Cropper property editor /// /// /// 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 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 /// /// /// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example: /// /// /// /// /// /// 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)) return string.Empty; ImageCropDataSet cropDataSet = null; if (string.IsNullOrEmpty(imageCropperValue) == false && imageCropperValue.DetectIsJson() && (imageCropMode == ImageCropMode.Crop || imageCropMode == null)) { cropDataSet = imageCropperValue.SerializeToCropDataSet(); } return GetCropUrl( imageUrl, cropDataSet, width, height, cropAlias, quality, imageCropMode, imageCropAnchor, preferFocalPoint, useCropDimensions, cacheBusterValue, furtherOptions, ratioMode, upScale); } /// /// Gets the ImageProcessor Url from the image path. /// /// /// The image url. /// /// /// /// The width of the output image. /// /// /// The height of the output image. /// /// /// 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 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 /// /// /// These are any query string parameters (formatted as query strings) that ImageProcessor supports. For example: /// /// /// /// /// /// Use a dimension as a ratio /// /// /// If the image should be upscaled to requested dimensions /// /// /// The . /// public static string GetCropUrl( this string imageUrl, ImageCropDataSet cropDataSet, int? width = null, int? height = 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 imageProcessorUrl = new StringBuilder(); if (cropDataSet != null && (imageCropMode == ImageCropMode.Crop || imageCropMode == null)) { var crop = cropDataSet.GetCrop(cropAlias); imageProcessorUrl.Append(cropDataSet.Src); var cropBaseUrl = cropDataSet.GetCropBaseUrl(cropAlias, preferFocalPoint); if (cropBaseUrl != null) { imageProcessorUrl.Append(cropBaseUrl); } else { return null; } if (crop != null & useCropDimensions) { width = crop.Width; height = crop.Height; } // If a predefined crop has been specified & there are no coordinates & no ratio mode, but a width parameter has been passed we can get the crop ratio for the height if (crop != null && string.IsNullOrEmpty(cropAlias) == false && crop.Coordinates == null && ratioMode == null && width != null && height == null) { var heightRatio = (decimal)crop.Height / (decimal)crop.Width; imageProcessorUrl.Append("&heightratio=" + heightRatio.ToString(CultureInfo.InvariantCulture)); } // If a predefined crop has been specified & there are no coordinates & no ratio mode, but a height parameter has been passed we can get the crop ratio for the width if (crop != null && string.IsNullOrEmpty(cropAlias) == false && crop.Coordinates == null && ratioMode == null && width == null && height != null) { var widthRatio = (decimal)crop.Width / (decimal)crop.Height; imageProcessorUrl.Append("&widthratio=" + widthRatio.ToString(CultureInfo.InvariantCulture)); } } else { imageProcessorUrl.Append(imageUrl); if (imageCropMode == null) { imageCropMode = ImageCropMode.Pad; } imageProcessorUrl.Append("?mode=" + imageCropMode.ToString().ToLower()); if (imageCropAnchor != null) { imageProcessorUrl.Append("&anchor=" + imageCropAnchor.ToString().ToLower()); } } var hasFormat = furtherOptions != null && furtherOptions.InvariantContains("&format="); //Only put quality here, if we don't have a format specified. //Otherwise we need to put quality at the end to avoid it being overridden by the format. if (quality != null && hasFormat == false) { imageProcessorUrl.Append("&quality=" + quality); } if (width != null && ratioMode != ImageCropRatioMode.Width) { imageProcessorUrl.Append("&width=" + width); } if (height != null && ratioMode != ImageCropRatioMode.Height) { imageProcessorUrl.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; imageProcessorUrl.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; imageProcessorUrl.Append("&heightratio=" + heightRatio.ToString(CultureInfo.InvariantCulture)); } if (upScale == false) { imageProcessorUrl.Append("&upscale=false"); } if (furtherOptions != null) { imageProcessorUrl.Append(furtherOptions); } //If furtherOptions contains a format, we need to put the quality after the format. if (quality != null && hasFormat) { imageProcessorUrl.Append("&quality=" + quality); } if (cacheBusterValue != null) { imageProcessorUrl.Append("&rnd=").Append(cacheBusterValue); } return imageProcessorUrl.ToString(); } return string.Empty; } } }