Merge pull request #25 from prjseal/feature/add-user-tag-helper

added user tag helper

Author: Warren Buckley

Our.Umbraco.TagHelpers/MemberTagHelper.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Umbraco.Cms.Core.Security;
+using Umbraco.Extensions;
 
 namespace Our.Umbraco.TagHelpers
 {
@@ -17,15 +18,15 @@ public class MemberTagHelper : TagHelper
         private IMemberManager _memberManager;
 
         /// <summary>
-        /// A comma seperated list of Member Groups to exclude
+        /// A comma separated list of Member Groups to exclude
         /// ? = All anonymous users
         /// * = All authenticated users
         /// </summary>
         [HtmlAttributeName("our-member-exclude")]
         public string ExcludeRoles { get; set; }
 
         /// <summary>
-        /// A comma seperated list of Member Groups to include
+        /// A comma separated list of Member Groups to include
         /// ? = All anonymous users
         /// * = All authenticated users
         /// </summary>
@@ -79,7 +80,7 @@ private bool IsUserInRole(string roleString, List<string> currentMemberRoles)
                     return true;
                 }
 
-                if (currentMemberRoles.Contains(role))
+                if (currentMemberRoles.InvariantContains(role))
                 {
                     return true;
                 }

Our.Umbraco.TagHelpers/UserTagHelper.cs

@@ -0,0 +1,94 @@
+using Microsoft.AspNetCore.Razor.TagHelpers;
+using Our.Umbraco.TagHelpers.Extensions;
+using Our.Umbraco.TagHelpers.Services;
+using System.Collections.Generic;
+using System.Linq;
+using System.Security.Claims;
+using Umbraco.Extensions;
+
+namespace Our.Umbraco.TagHelpers
+{
+    /// <summary>
+    /// An attribute TagHelper to help show or hide DOM elements for users
+    /// 
+    /// </summary>
+    [HtmlTargetElement("*", Attributes = "our-user-include")]
+    [HtmlTargetElement("*", Attributes = "our-user-exclude")]
+    public class UserTagHelper : TagHelper
+    {
+        private readonly IBackofficeUserAccessor _backofficeUserAccessor;
+
+        /// <summary>
+        /// A comma separated list of User Groups to exclude
+        /// ? = All anonymous users
+        /// * = All authenticated users
+        /// </summary>
+        [HtmlAttributeName("our-user-exclude")]
+        public string ExcludeGroups { get; set; }
+
+        /// <summary>
+        /// A comma separated list of User Groups to include
+        /// ? = All anonymous users
+        /// * = All authenticated users
+        /// </summary>
+        [HtmlAttributeName("our-user-include")]
+        public string IncludeGroups { get; set; }
+
+        public UserTagHelper(IBackofficeUserAccessor backofficeUserAccessor)
+        {
+            _backofficeUserAccessor = backofficeUserAccessor;
+        }
+
+        public override void Process(TagHelperContext context, TagHelperOutput output)
+        {
+            var currentUser = _backofficeUserAccessor.BackofficeUser;
+            var currentUserGroups = new List<string>();
+            if (currentUser != null)
+            {
+                var groups = currentUser.GetRoles();
+                currentUserGroups.AddRange(groups);
+            }
+
+            // Process excluded roles
+            if (!string.IsNullOrWhiteSpace(this.ExcludeGroups) && IsUserInRole(currentUser, ExcludeGroups, currentUserGroups) == true)
+            {
+                output.SuppressOutput();
+                return;
+            }
+
+            // Process included roles
+            else if (!string.IsNullOrWhiteSpace(this.IncludeGroups) && IsUserInRole(currentUser, IncludeGroups, currentUserGroups) == false)
+            {
+                output.SuppressOutput();
+                return;
+            }
+        }
+
+        private bool IsUserInRole(ClaimsIdentity currentUser, string roleString, List<string> currentMemberRoles)
+        {
+            //roles is a CSV of member groups they need to have access to
+            var roles = roleString.Split(',').Select(x => x.Trim());
+            foreach (var role in roles)
+            {
+                // Role ? == all anonymous users (User not logged in)
+                if (role == "?" && !currentUser.IsLoggedIntoUmbraco())
+                {
+                    return true;
+                }
+
+                // Role * == all authenticated users
+                if (role == "*" && currentUser.IsLoggedIntoUmbraco())
+                {
+                    return true;
+                }
+
+                if (currentMemberRoles.InvariantContains(role))
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+    }
+}

README.md

@@ -227,6 +227,28 @@ There are two special Member Groups you can use:
 <div our-member-exclude="*">Everyone except who is authenticated will see this.</div>
 ```
 
+## `our-user-include` and `our-user-exclude`
+
+This is a tag helper attribute that can be applied to any DOM element in the razor template or partial. It will show or hide its element and children on the page when passing a comma seperated string of user groups that the current logged in Umbraco backoffice user is in, for the exclude or include variants.
+
+There are two special User Groups you can use:
+
+- `*` - All anonymous users
+- `?` - All authenticated users
+
+Use the alias of the User Group
+
+````cshtml
+<div our-user-include="admin">Only users in the Admin group will see this.</div>
+<div our-user-include="admin,editor">Only users in the Admin or Editor user group will see this.</div>
+<div our-user-include="*">Only logged in users will see this.</div>
+<div our-user-include="?">Only anonymous users will see this.</div>
+
+<div our-user-exclude="editor">Only Editor users can't see this (Including anonymous).</div>
+<div our-user-exclude="?">Everyone except Anonymous users will see this.</div>
+<div our-user-exclude="*">Everyone except who is authenticated will see this.</div>
+
+
 ## `<our-edit-link>`
 This is a tag helper element which renders an edit link on the front end only if the current user is logged into umbraco and has access to the content section.