Merge pull request #1192 from PiranhaCMS/features/image-block-aspect

Added support for setting preferred image aspect on image block. Fixe…

core/Piranha.AspNetCore/Services/ApplicationService.cs

@@ -14,111 +14,12 @@
 using System.Security.Cryptography;
 using System.Text;
 using System.Threading.Tasks;
-using Piranha.Extend.Fields;
 using Piranha.Models;
 
 namespace Piranha.AspNetCore.Services
 {
     public class ApplicationService : IApplicationService
     {
-        public class SiteHelper : ISiteHelper
-        {
-            private readonly IApi _api;
-
-            /// <summary>
-            /// Gets the id of the currently requested site.
-            /// </summary>
-            public Guid Id { get; set; }
-
-            /// <summary>
-            /// Gets/sets the optional culture of the requested site.
-            /// </summary>
-            public string Culture { get; set; }
-
-            /// <summary>
-            /// Gets/set the optional hostname of the requested site.
-            /// </summary>
-            public string Host { get; set; }
-
-            /// <summary>
-            /// Gets/sets the optional site prefic of the requested site
-            /// if it's routed with `host/prefix`.
-            /// </summary>
-            public string SitePrefix { get; set; }
-
-            /// <summary>
-            /// Gets the sitemap of the currently requested site.
-            /// </summary>
-            public Sitemap Sitemap { get; set; }
-
-            /// <summary>
-            /// Default internal constructur.
-            /// </summary>
-            internal SiteHelper(IApi api)
-            {
-                _api = api;
-            }
-
-            /// <summary>
-            /// Gets the site content for the current site.
-            /// </summary>
-            /// <typeparam name="T">The content type</typeparam>
-            /// <returns>The site content model</returns>
-            public Task<T> GetContentAsync<T>() where T : SiteContent<T>
-            {
-                if (Id != Guid.Empty)
-                {
-                    return _api.Sites.GetContentByIdAsync<T>(Id);
-                }
-                return null;
-            }
-        }
-
-        public class MediaHelper : IMediaHelper
-        {
-            private readonly IApi _api;
-
-            /// <summary>
-            /// Default internal constructur.
-            /// </summary>
-            internal MediaHelper(IApi api)
-            {
-                _api = api;
-            }
-
-            /// <summary>
-            /// Resizes the given image to the given dimensions.
-            /// </summary>
-            /// <param name="image"></param>
-            /// <param name="width"></param>
-            /// <param name="height"></param>
-            /// <returns></returns>
-            public string ResizeImage(ImageField image, int width, int? height = null)
-            {
-                if (image.Id.HasValue)
-                {
-                    return _api.Media.EnsureVersion(image.Id.Value, width, height);
-                }
-                return null;
-            }
-
-            /// <summary>
-            /// Resizes the given image to the given dimensions.
-            /// </summary>
-            /// <param name="image"></param>
-            /// <param name="width"></param>
-            /// <param name="height"></param>
-            /// <returns></returns>
-            public string ResizeImage(Media image, int width, int? height = null)
-            {
-                if (image.Id != Guid.Empty && image.Type == MediaType.Image)
-                {
-                    return _api.Media.EnsureVersion(image.Id, width, height);
-                }
-                return null;
-            }
-        }
-
         /// <summary>
         /// Gets the current api.
         /// </summary>

core/Piranha.AspNetCore/Services/IMediaHelper.cs

@@ -8,30 +8,39 @@
  *
  */
 
-using System;
 using Piranha.Extend.Fields;
+using Piranha.Extend.Blocks;
 using Piranha.Models;
 
 namespace Piranha.AspNetCore.Services
 {
     public interface IMediaHelper
     {
-            /// <summary>
-            /// Resizes the given image to the given dimensions.
-            /// </summary>
-            /// <param name="image"></param>
-            /// <param name="width"></param>
-            /// <param name="height"></param>
-            /// <returns></returns>
-            string ResizeImage(ImageField image, int width, int? height = null);
+        /// <summary>
+        /// Resizes the given image to the given dimensions.
+        /// </summary>
+        /// <param name="image">The image field</param>
+        /// <param name="width">The width</param>
+        /// <param name="height">The optional height</param>
+        /// <returns>The public URL of the resized image</returns>
+        string ResizeImage(ImageField image, int width, int? height = null);
 
-            /// <summary>
-            /// Resizes the given image to the given dimensions.
-            /// </summary>
-            /// <param name="image"></param>
-            /// <param name="width"></param>
-            /// <param name="height"></param>
-            /// <returns></returns>
-            string ResizeImage(Media image, int width, int? height = null);
+        /// <summary>
+        /// Resizes the given image to the given dimensions.
+        /// </summary>
+        /// <param name="image">The image</param>
+        /// <param name="width">The width</param>
+        /// <param name="height">The optional width</param>
+        /// <returns>The public URL of the resized image</returns>
+        string ResizeImage(Media image, int width, int? height = null);
+
+        /// <summary>
+        /// Resizes the given image block according to the
+        /// preferred aspect.
+        /// </summary>
+        /// <param name="block">The image block</param>
+        /// <param name="width">The width</param>
+        /// <returns>The public URL of the resized image</returns>
+        string ResizeImage(ImageBlock block, int width);
     }
 }

core/Piranha.AspNetCore/Services/MediaHelper.cs

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) .NET Foundation and Contributors
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license.  See the LICENSE file for details.
+ *
+ * https://github.com/piranhacms/piranha.core
+ *
+ */
+
+using System;
+using Piranha.Extend.Fields;
+using Piranha.Extend.Blocks;
+using Piranha.Models;
+
+namespace Piranha.AspNetCore.Services
+{
+    public class MediaHelper : IMediaHelper
+    {
+        private readonly IApi _api;
+
+        /// <summary>
+        /// Default internal constructur.
+        /// </summary>
+        internal MediaHelper(IApi api)
+        {
+            _api = api;
+        }
+
+        /// <summary>
+        /// Resizes the given image to the given dimensions.
+        /// </summary>
+        /// <param name="image">The image field</param>
+        /// <param name="width">The width</param>
+        /// <param name="height">The optional height</param>
+        /// <returns>The public URL of the resized image</returns>
+        public string ResizeImage(ImageField image, int width, int? height = null)
+        {
+            if (image.Id.HasValue)
+            {
+                return _api.Media.EnsureVersion(image.Id.Value, width, height);
+            }
+            return null;
+        }
+
+        /// <summary>
+        /// Resizes the given image to the given dimensions.
+        /// </summary>
+        /// <param name="image">The image</param>
+        /// <param name="width">The width</param>
+        /// <param name="height">The optional width</param>
+        /// <returns>The public URL of the resized image</returns>
+        public string ResizeImage(Media image, int width, int? height = null)
+        {
+            if (image.Id != Guid.Empty && image.Type == MediaType.Image)
+            {
+                return _api.Media.EnsureVersion(image.Id, width, height);
+            }
+            return null;
+        }
+
+        /// <summary>
+        /// Resizes the given image block according to the
+        /// preferred aspect.
+        /// </summary>
+        /// <param name="block">The image block</param>
+        /// <param name="width">The width</param>
+        /// <returns>The public URL of the resized image</returns>
+        public string ResizeImage(ImageBlock block, int width)
+        {
+            if (block.Body.Media != null)
+            {
+                int? height = null;
+
+                if (block.Aspect.Value == ImageAspect.Landscape)
+                {
+                    height = Convert.ToInt32(width * 10 / 16);
+                }
+                else if (block.Aspect.Value == ImageAspect.Portrait)
+                {
+                    height = Convert.ToInt32(width * 16 / 10);
+                }
+                else if (block.Aspect.Value == ImageAspect.Square)
+                {
+                    height = width;
+                }
+                return _api.Media.EnsureVersion(block.Body.Media.Id, width, height);
+            }
+            return null;
+        }
+    }
+}

core/Piranha.AspNetCore/Services/SiteHelper.cs

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) .NET Foundation and Contributors
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license.  See the LICENSE file for details.
+ *
+ * https://github.com/piranhacms/piranha.core
+ *
+ */
+
+using System;
+using System.Threading.Tasks;
+using Piranha.Models;
+
+namespace Piranha.AspNetCore.Services
+{
+    public class SiteHelper : ISiteHelper
+    {
+        private readonly IApi _api;
+
+        /// <summary>
+        /// Gets the id of the currently requested site.
+        /// </summary>
+        public Guid Id { get; set; }
+
+        /// <summary>
+        /// Gets/sets the optional culture of the requested site.
+        /// </summary>
+        public string Culture { get; set; }
+
+        /// <summary>
+        /// Gets/set the optional hostname of the requested site.
+        /// </summary>
+        public string Host { get; set; }
+
+        /// <summary>
+        /// Gets/sets the optional site prefic of the requested site
+        /// if it's routed with `host/prefix`.
+        /// </summary>
+        public string SitePrefix { get; set; }
+
+        /// <summary>
+        /// Gets the sitemap of the currently requested site.
+        /// </summary>
+        public Sitemap Sitemap { get; set; }
+
+        /// <summary>
+        /// Default internal constructur.
+        /// </summary>
+        internal SiteHelper(IApi api)
+        {
+            _api = api;
+        }
+
+        /// <summary>
+        /// Gets the site content for the current site.
+        /// </summary>
+        /// <typeparam name="T">The content type</typeparam>
+        /// <returns>The site content model</returns>
+        public Task<T> GetContentAsync<T>() where T : SiteContent<T>
+        {
+            if (Id != Guid.Empty)
+            {
+                return _api.Sites.GetContentByIdAsync<T>(Id);
+            }
+            return null;
+        }
+    }
+}