Merge branch 'v8/8.10' into v8/8.11

Author: nul800sebastiaan

build/NuSpecs/UmbracoCms.Web.nuspec

@@ -42,7 +42,7 @@
                 <dependency id="Microsoft.Owin.Security.Cookies" version="[4.0.1,4.999999)" />
                 <dependency id="Microsoft.Owin.Security.OAuth" version="[4.0.1,4.999999)" />
                 <dependency id="System.Threading.Tasks.Dataflow" version="[4.9.0,4.999999)" />
-                <dependency id="HtmlSanitizer" version="[4.0.217,4.999999)" />
+                <dependency id="HtmlSanitizer" version="[5.0.376,5.999999)" />
 
             </group>
 

src/Umbraco.Core/IO/SystemDirectories.cs

@@ -25,6 +25,8 @@ public class SystemDirectories
 
         public static string AppPlugins => "~/App_Plugins";
 
+        public static string AppPluginIcons => "/Backoffice/Icons";
+
         public static string MvcViews => "~/Views";
 
         public static string PartialViews => MvcViews + "/Partials/";

src/Umbraco.Core/Services/IIconService.cs

@@ -1,12 +1,14 @@
+using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using Umbraco.Core.Models;
 
 namespace Umbraco.Core.Services
 {
     public interface IIconService
     {
         /// <summary>
-        /// Gets an IconModel containing the icon name and SvgString according to an icon name found at the global icons path
+        /// Gets the svg string for the icon name found at the global icons path
         /// </summary>
         /// <param name="iconName"></param>
         /// <returns></returns>
@@ -15,7 +17,15 @@ public interface IIconService
         /// <summary>
         /// Gets a list of all svg icons found at at the global icons path.
         /// </summary>
-        /// <returns></returns>
+        /// <returns>A list of <see cref="IconModel"/></returns>
+        [Obsolete("This method should not be used - use GetIcons instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         IList<IconModel> GetAllIcons();
+
+        /// <summary>
+        /// Gets a list of all svg icons found at at the global icons path.
+        /// </summary>
+        /// <returns></returns>
+        IReadOnlyDictionary<string, string> GetIcons();
     }
 }

src/Umbraco.Web.UI.Client/src/common/directives/components/umbicon.directive.js

@@ -75,9 +75,8 @@ Icon with additional attribute. It can be treated like any other dom element
 
                     iconHelper.getIcon(icon)
                         .then(data => {
-                            if (data !== null && data.svgString !== undefined) {
+                            if (data && data.svgString) {
                                 // Watch source SVG string
-                                //icon.svgString.$$unwrapTrustedValue();
                                 scope.svgString = data.svgString;
                             }
                         });

src/Umbraco.Web.UI.Client/src/common/services/iconhelper.service.js

@@ -3,9 +3,9 @@
 * @name umbraco.services.iconHelper
 * @description A helper service for dealing with icons, mostly dealing with legacy tree icons
 **/
-function iconHelper($http, $q, $sce, $timeout, umbRequestHelper) {
+function iconHelper($http, $q, $sce, $timeout) {
 
-    var converter = [
+    const converter = [
         { oldIcon: ".sprNew", newIcon: "add" },
         { oldIcon: ".sprDelete", newIcon: "remove" },
         { oldIcon: ".sprMove", newIcon: "enter" },
@@ -85,15 +85,61 @@ function iconHelper($http, $q, $sce, $timeout, umbRequestHelper) {
         { oldIcon: ".sprTreeDeveloperPython", newIcon: "icon-linux" }
     ];
 
-    var collectedIcons;
+    let collectedIcons;
 
-    var imageConverter = [
-            {oldImage: "contour.png", newIcon: "icon-umb-contour"}
-            ];
+    let imageConverter = [
+        {oldImage: "contour.png", newIcon: "icon-umb-contour"}
+    ];
+
+    const iconCache = [];
+    const promiseQueue = [];
+    let resourceLoadStatus = "none";
+
+    /**
+     * This is the same approach as use for loading the localized text json 
+     * We don't want multiple requests for the icon collection, so need to track
+     * the current request state, and resolve the queued requests once the icons arrive
+     * Subsequent requests are returned immediately as the icons are cached into 
+     */
+    function init() {       
+        const deferred = $q.defer();
+
+        if (resourceLoadStatus === "loaded") {
+            deferred.resolve(iconCache);
+            return deferred.promise;
+        }
+
+        if (resourceLoadStatus === "loading") {
+            promiseQueue.push(deferred);
+            return deferred.promise;
+        }
 
-    var iconCache = [];
-    var liveRequests = [];
-    var allIconsRequested = false;
+        resourceLoadStatus = "loading";
+
+        $http({ method: "GET", url: Umbraco.Sys.ServerVariables.umbracoUrls.iconApiBaseUrl + 'GetIcons' })
+            .then(function (response) {
+                resourceLoadStatus = "loaded";
+
+                for (const [key, value] of Object.entries(response.data.Data)) {
+                    iconCache.push({name: key, svgString: $sce.trustAsHtml(value)})
+                }
+
+                deferred.resolve(iconCache);
+
+                //ensure all other queued promises are resolved
+                for (let p in promiseQueue) {
+                    promiseQueue[p].resolve(iconCache);
+                }
+            }, function (err) {
+                deferred.reject("Something broke");
+                //ensure all other queued promises are resolved
+                for (let p in promiseQueue) {
+                    promiseQueue[p].reject("Something broke");
+                }
+            });
+
+        return deferred.promise;    
+    }
 
     return {
 
@@ -187,67 +233,12 @@ function iconHelper($http, $q, $sce, $timeout, umbRequestHelper) {
 
         /** Gets a single IconModel */
         getIcon: function(iconName) {
-            return $q((resolve, reject) => {
-                var icon = this._getIconFromCache(iconName);
-
-                 if(icon !== undefined) {
-                    resolve(icon);
-                } else {
-                    var iconRequestPath = Umbraco.Sys.ServerVariables.umbracoUrls.iconApiBaseUrl +  'GetIcon?iconName=' + iconName;
-
-                     // If the current icon is being requested, wait a bit so that we don't have to make another http request and can instead get the icon from the cache.
-                    // This is a bit rough and ready and could probably be improved used an event based system
-                    if(liveRequests.indexOf(iconRequestPath) >= 0) {
-                        setTimeout(() => {
-                            resolve(this.getIcon(iconName));
-                        }, 10);
-                    } else {
-                        liveRequests.push(iconRequestPath);
-                        // TODO - fix bug where Umbraco.Sys.ServerVariables.umbracoUrls.iconApiBaseUrl is undefinied when help icon
-                        umbRequestHelper.resourcePromise(
-                            $http.get(iconRequestPath)
-                            ,'Failed to retrieve icon: ' + iconName)
-                        .then(icon => {
-                            if(icon) {
-                                var trustedIcon = this.defineIcon(icon.Name, icon.SvgString);
-
-                                liveRequests = _.filter(liveRequests, iconRequestPath);
-
-                                resolve(trustedIcon);
-                            }
-                        })
-                        .catch(err => {
-                            console.warn(err);
-                        });
-                    };
-
-                 }
-            });
+            return init().then(icons => icons.find(i => i.name === iconName));
         },
 
         /** Gets all the available icons in the backoffice icon folder and returns them as an array of IconModels */
          getAllIcons: function() {
-            return $q((resolve, reject) => {
-                if(allIconsRequested === false) {
-                    allIconsRequested = true;
-
-                     umbRequestHelper.resourcePromise(
-                        $http.get(Umbraco.Sys.ServerVariables.umbracoUrls.iconApiBaseUrl + 'GetAllIcons')
-                        ,'Failed to retrieve icons')
-                    .then(icons => {
-                        icons.forEach(icon => {
-                            this.defineIcon(icon.Name, icon.SvgString);
-                        });
-
-                        resolve(iconCache);
-                    })
-                    .catch(err => {
-                        console.warn(err);
-                    });;
-                } else {
-                    resolve(iconCache);
-                }
-            });
+            return init().then(icons => icons);
         },
 
         /** LEGACY - Return a list of icons from icon fonts, optionally filter them */
@@ -312,9 +303,8 @@ function iconHelper($http, $q, $sce, $timeout, umbRequestHelper) {
         },
 
          /** Returns the cached icon or undefined */
-        _getIconFromCache: function(iconName) {
-            return _.find(iconCache, {name: iconName});
-        }
+        _getIconFromCache: iconName => iconCache.find(icon => icon.name === iconName)
+        
     };
 }
 angular.module('umbraco.services').factory('iconHelper', iconHelper);

src/Umbraco.Web.UI/Umbraco/Views/Default.cshtml

@@ -121,12 +121,6 @@
             @Html.AngularValueResetPasswordCodeInfoScript(ViewData["PasswordResetCode"])
             @Html.AngularValueTinyMceAssets()
 
-            app.run(["iconHelper", function (iconHelper) {
-                @* We inject icons to the icon helper(service), since icons can only be loaded if user is authorized. By injecting these to the service they will not be requested as they will become cached. *@
-                iconHelper.defineIcon("icon-check", '@Html.Raw(Model.IconCheckData)');
-                iconHelper.defineIcon("icon-delete", '@Html.Raw(Model.IconDeleteData)');
-            }]);
-
             //required for the noscript trick
             document.getElementById("mainwrapper").style.display = "inherit";
 

src/Umbraco.Web/Editors/BackOfficeController.cs

@@ -1,29 +1,28 @@
-using System;
+using Microsoft.AspNet.Identity;
+using Microsoft.AspNet.Identity.Owin;
+using Microsoft.Owin.Security;
+using Newtonsoft.Json;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using System.Web.Mvc;
 using System.Web.UI;
-using Microsoft.AspNet.Identity;
-using Microsoft.AspNet.Identity.Owin;
-using Microsoft.Owin.Security;
-using Newtonsoft.Json;
 using Umbraco.Core;
 using Umbraco.Core.Cache;
 using Umbraco.Core.Configuration;
 using Umbraco.Core.Logging;
 using Umbraco.Core.Manifest;
 using Umbraco.Core.Models.Identity;
-using Umbraco.Web.Models;
-using Umbraco.Web.Mvc;
 using Umbraco.Core.Services;
 using Umbraco.Web.Composing;
 using Umbraco.Web.Features;
 using Umbraco.Web.JavaScript;
+using Umbraco.Web.Models;
+using Umbraco.Web.Mvc;
 using Umbraco.Web.Security;
-using Umbraco.Web.Services;
 using Constants = Umbraco.Core.Constants;
 using JArray = Newtonsoft.Json.Linq.JArray;
 
@@ -40,11 +39,9 @@ public class BackOfficeController : UmbracoController
         private readonly ManifestParser _manifestParser;
         private readonly UmbracoFeatures _features;
         private readonly IRuntimeState _runtimeState;
-        private readonly IIconService _iconService;
         private BackOfficeUserManager<BackOfficeIdentityUser> _userManager;
         private BackOfficeSignInManager _signInManager;
 
-        [Obsolete("Use the constructor that injects IIconService.")]
         public BackOfficeController(
             ManifestParser manifestParser,
             UmbracoFeatures features,
@@ -55,37 +52,11 @@ public BackOfficeController(
             IProfilingLogger profilingLogger,
             IRuntimeState runtimeState,
             UmbracoHelper umbracoHelper)
-            : this(manifestParser,
-                features,
-                globalSettings,
-                umbracoContextAccessor,
-                services,
-                appCaches,
-                profilingLogger,
-                runtimeState,
-                umbracoHelper,
-                Current.IconService)
-        {
-
-        }
-
-        public BackOfficeController(
-            ManifestParser manifestParser,
-            UmbracoFeatures features,
-            IGlobalSettings globalSettings,
-            IUmbracoContextAccessor umbracoContextAccessor,
-            ServiceContext services,
-            AppCaches appCaches,
-            IProfilingLogger profilingLogger,
-            IRuntimeState runtimeState,
-            UmbracoHelper umbracoHelper,
-            IIconService iconService)
             : base(globalSettings, umbracoContextAccessor, services, appCaches, profilingLogger, umbracoHelper)
         {
             _manifestParser = manifestParser;
             _features = features;
             _runtimeState = runtimeState;
-            _iconService = iconService;
         }
 
         protected BackOfficeSignInManager SignInManager => _signInManager ?? (_signInManager = OwinContext.GetBackOfficeSignInManager());
@@ -100,7 +71,7 @@ public BackOfficeController(
         /// <returns></returns>
         public async Task<ActionResult> Default()
         {
-            var backofficeModel = new BackOfficeModel(_features, GlobalSettings, _iconService);
+            var backofficeModel = new BackOfficeModel(_features, GlobalSettings);
             return await RenderDefaultOrProcessExternalLoginAsync(
                 () => View(GlobalSettings.Path.EnsureEndsWith('/') + "Views/Default.cshtml", backofficeModel),
                 () => View(GlobalSettings.Path.EnsureEndsWith('/') + "Views/Default.cshtml", backofficeModel));
@@ -186,7 +157,7 @@ public async Task<ActionResult> AuthorizeUpgrade()
         {
             return await RenderDefaultOrProcessExternalLoginAsync(
                 //The default view to render when there is no external login info or errors
-                () => View(GlobalSettings.Path.EnsureEndsWith('/') + "Views/AuthorizeUpgrade.cshtml", new BackOfficeModel(_features, GlobalSettings, _iconService)),
+                () => View(GlobalSettings.Path.EnsureEndsWith('/') + "Views/AuthorizeUpgrade.cshtml", new BackOfficeModel(_features, GlobalSettings)),
                 //The ActionResult to perform if external login is successful
                 () => Redirect("/"));
         }

src/Umbraco.Web/Editors/BackOfficeModel.cs

@@ -1,32 +1,19 @@
 using System;
 using Umbraco.Core.Configuration;
-using Umbraco.Core.Services;
-using Umbraco.Web.Composing;
 using Umbraco.Web.Features;
 
 namespace Umbraco.Web.Editors
 {
-
     public class BackOfficeModel
     {
 
-
-        [Obsolete("Use the overload that injects IIconService.")]
-        public BackOfficeModel(UmbracoFeatures features, IGlobalSettings globalSettings) : this(features, globalSettings, Current.IconService)
-        {
-
-        }
-        public BackOfficeModel(UmbracoFeatures features, IGlobalSettings globalSettings, IIconService iconService)
+        public BackOfficeModel(UmbracoFeatures features, IGlobalSettings globalSettings)
         {
             Features = features;
             GlobalSettings = globalSettings;
-            IconCheckData = iconService.GetIcon("icon-check")?.SvgString;
-            IconDeleteData = iconService.GetIcon("icon-delete")?.SvgString;
         }
 
         public UmbracoFeatures Features { get; }
         public IGlobalSettings GlobalSettings { get; }
-        public string IconCheckData { get; }
-        public string IconDeleteData { get; }
     }
 }