Granular permissions: permission name localization (in progress)

mgesing · mgesing · commit fe9e627fa4f4 · 2019-08-13T14:33:41.000+02:00
diff --git a/src/Libraries/SmartStore.Core/Domain/Security/PermissionNode.cs b/src/Libraries/SmartStore.Core/Domain/Security/PermissionNode.cs
@@ -2,10 +2,11 @@
 
 namespace SmartStore.Core.Domain.Security
 {
-    public interface IPermissionNode/* : ILocalizedEntity*/
+    public interface IPermissionNode
     {
         int PermissionRecordId { get; }
         string SystemName { get; }
+        string DisplayName { get; }
         bool? Allow { get; }
     }
 
@@ -14,6 +15,7 @@ public class PermissionNode : IPermissionNode
     {
         public int PermissionRecordId { get; set; }
         public string SystemName { get; set; }
+        public string DisplayName { get; set; }
         public bool? Allow { get; set; }
     }
 }
diff --git a/src/Libraries/SmartStore.Data/Migrations/201907221803421_GranularPermissions.cs b/src/Libraries/SmartStore.Data/Migrations/201907221803421_GranularPermissions.cs
@@ -50,9 +50,12 @@ public void Seed(SmartObjectContext context)
 
         public void MigrateLocaleResources(LocaleResourcesBuilder builder)
         {
-            builder.AddOrUpdate("Admin.Customers.Customers.CustomerRole",
-                "Customer role",
-                "Kundengruppe");
+            builder.AddOrUpdate("Admin.Customers.Customers.CustomerRole", "Customer role", "Kundengruppe");
+
+            builder.AddOrUpdate("Common.Read", "Read", "Lesen");
+            builder.AddOrUpdate("Common.Create", "Create", "Erstellen");
+
+            builder.AddOrUpdate("Permissions.DisplayName.DisplayPrice", "Display prices", "Preise anzeigen");
         }
     }
 }
diff --git a/src/Libraries/SmartStore.Services/Security/PermissionExtensions.cs b/src/Libraries/SmartStore.Services/Security/PermissionExtensions.cs
@@ -0,0 +1,58 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using SmartStore.Collections;
+using SmartStore.Core.Domain.Security;
+using SmartStore.Services.Localization;
+
+namespace SmartStore.Services.Security
+{
+    public static class PermissionExtensions
+    {
+        public static void GetDisplayNames(this TreeNode<IPermissionNode> tree, ILocalizationService localizationService)
+        {
+            Guard.NotNull(localizationService, nameof(localizationService));
+
+            if (tree == null)
+            {
+                return;
+            }
+
+            var tokenSeparator = new char[] { '.' };
+            var names = new Dictionary<string, string>();
+
+            Add("read", "Common.Read");
+            Add("update", "Common.Edit");
+            Add("create", "Common.Create");
+            Add("delete", "Common.Delete");
+            Add("catalog", "Admin.Catalog");
+
+            foreach (PermissionNode node in tree.Flatten())
+            {
+                var tokens = node.SystemName.EmptyNull().ToLower().Split(tokenSeparator, StringSplitOptions.RemoveEmptyEntries);
+                var token = tokens.LastOrDefault();
+                if (token != null)
+                {
+                    // Known token of default permissions.
+                    if (!names.TryGetValue(token, out var name))
+                    {
+                        // Unknown token (e.g. permission added by plugin). Try resource by name convention.
+                        var key = "Permissions.DisplayName." + token.Replace("-", "");
+                        name = localizationService.GetResource(key, defaultValue: token);
+                    }
+
+                    node.DisplayName = string.IsNullOrWhiteSpace(name) ? token : name;
+                }
+                else
+                {
+                    node.DisplayName = node.SystemName;
+                }
+            }
+
+            void Add(string token, string resourceKey)
+            {
+                names.Add(token, localizationService.GetResource(resourceKey, defaultValue: token));
+            }
+        }
+    }
+}
diff --git a/src/Libraries/SmartStore.Services/SmartStore.Services.csproj b/src/Libraries/SmartStore.Services/SmartStore.Services.csproj
@@ -587,6 +587,7 @@
     <Compile Include="Security\IAclService.cs" />
     <Compile Include="Security\IEncryptionService.cs" />
     <Compile Include="Security\IPermissionService2.cs" />
+    <Compile Include="Security\PermissionExtensions.cs" />
     <Compile Include="Security\PermissionService.cs" />
     <Compile Include="Security\IPermissionService.cs" />
     <Compile Include="Security\IPermissionProvider.cs" />
diff --git a/src/Presentation/SmartStore.Web/Administration/Controllers/CustomerRoleController.cs b/src/Presentation/SmartStore.Web/Administration/Controllers/CustomerRoleController.cs
@@ -165,6 +165,8 @@ public ActionResult Edit(int id)
             model.TaxDisplayTypes = GetTaxDisplayTypesList(model);
             model.PermissionTree = _permissionService2.GetPermissionTree(customerRole);
 
+            model.PermissionTree.GetDisplayNames(Services.Localization);
+
             return View(model);
 		}
 
diff --git a/src/Presentation/SmartStore.Web/Administration/Views/CustomerRole/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/CustomerRole/_CreateOrUpdate.cshtml
@@ -126,7 +126,7 @@
         @foreach (var child in node.Children)
         {
             var value = child.Value.Allow.HasValue ? (child.Value.Allow.Value ? 2 : 1) : 0;
-            <li data-name="permission-@child.Value.PermissionRecordId" data-value="@value" data-label="@child.Value.SystemName">
+            <li data-name="permission-@child.Value.PermissionRecordId" data-value="@value" data-label="@child.Value.DisplayName">
                 @if (child.HasChildren)
                 {
                     @PermissionNode(child)

Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,11 @@`
`2`	`2`
`3`	`3`	`namespace SmartStore.Core.Domain.Security`
`4`	`4`	`{`
`5`		`- public interface IPermissionNode/* : ILocalizedEntity*/`
	`5`	`+ public interface IPermissionNode`
`6`	`6`	`{`
`7`	`7`	`int PermissionRecordId { get; }`
`8`	`8`	`string SystemName { get; }`
	`9`	`+ string DisplayName { get; }`
`9`	`10`	`bool? Allow { get; }`
`10`	`11`	`}`
`11`	`12`
`@@ -14,6 +15,7 @@ public class PermissionNode : IPermissionNode`
`14`	`15`	`{`
`15`	`16`	`public int PermissionRecordId { get; set; }`
`16`	`17`	`public string SystemName { get; set; }`
	`18`	`+ public string DisplayName { get; set; }`
`17`	`19`	`public bool? Allow { get; set; }`
`18`	`20`	`}`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,9 +50,12 @@ public void Seed(SmartObjectContext context)`
`50`	`50`
`51`	`51`	`public void MigrateLocaleResources(LocaleResourcesBuilder builder)`
`52`	`52`	`{`
`53`		`- builder.AddOrUpdate("Admin.Customers.Customers.CustomerRole",`
`54`		`- "Customer role",`
`55`		`- "Kundengruppe");`
	`53`	`+ builder.AddOrUpdate("Admin.Customers.Customers.CustomerRole", "Customer role", "Kundengruppe");`
	`54`	`+`
	`55`	`+ builder.AddOrUpdate("Common.Read", "Read", "Lesen");`
	`56`	`+ builder.AddOrUpdate("Common.Create", "Create", "Erstellen");`
	`57`	`+`
	`58`	`+ builder.AddOrUpdate("Permissions.DisplayName.DisplayPrice", "Display prices", "Preise anzeigen");`
`56`	`59`	`}`
`57`	`60`	`}`
`58`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,8 @@ public ActionResult Edit(int id)`
`165`	`165`	`model.TaxDisplayTypes = GetTaxDisplayTypesList(model);`
`166`	`166`	`model.PermissionTree = _permissionService2.GetPermissionTree(customerRole);`
`167`	`167`
	`168`	`+ model.PermissionTree.GetDisplayNames(Services.Localization);`
	`169`	`+`
`168`	`170`	`return View(model);`
`169`	`171`	`}`
`170`	`172`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@`
`126`	`126`	`@foreach (var child in node.Children)`
`127`	`127`	`{`
`128`	`128`	`var value = child.Value.Allow.HasValue ? (child.Value.Allow.Value ? 2 : 1) : 0;`
`129`		`- <li data-name="permission-@child.Value.PermissionRecordId" data-value="@value" data-label="@child.Value.SystemName">`
	`129`	`+ <li data-name="permission-@child.Value.PermissionRecordId" data-value="@value" data-label="@child.Value.DisplayName">`
`130`	`130`	`@if (child.HasChildren)`
`131`	`131`	`{`
`132`	`132`	`@PermissionNode(child)`