Resolves #417 Restrict forum groups to specific customer roles

Author: mgesing

changelog.md

@@ -15,7 +15,9 @@
 * Added option to display preview pictures in product lists
 * Added option to add multiple file versions to product download section
 * Added options for alternating price display (in badges)
-* Added option to display a captcha on forum pages when creating or replying to a topic.
+* **Forum**:
+	* Added option to display a captcha on forum pages when creating or replying to a topic.
+	* #417 Restrict forum groups to specific customer roles.
 * **MegaSearch**:
 	* Supports searching for forum posts.
 	* #1172 Option to display related search terms on search page.

src/Libraries/SmartStore.Core/Domain/Forums/ForumGroup.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using SmartStore.Core.Domain.Localization;
+using SmartStore.Core.Domain.Security;
 using SmartStore.Core.Domain.Seo;
 using SmartStore.Core.Domain.Stores;
 
@@ -9,7 +10,7 @@ namespace SmartStore.Core.Domain.Forums
     /// <summary>
     /// Represents a forum group
     /// </summary>
-	public partial class ForumGroup : BaseEntity, IAuditable, IStoreMappingSupported, ILocalizedEntity, ISlugSupported
+	public partial class ForumGroup : BaseEntity, IAuditable, IStoreMappingSupported, IAclSupported, ILocalizedEntity, ISlugSupported
     {
         private ICollection<Forum> _forums;
 
@@ -43,6 +44,11 @@ public partial class ForumGroup : BaseEntity, IAuditable, IStoreMappingSupported
 		/// </summary>
 		public bool LimitedToStores { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether the entity is subject to ACL
+        /// </summary>
+        public bool SubjectToAcl { get; set; }
+
         /// <summary>
         /// Gets or sets the collection of Forums
         /// </summary>

src/Libraries/SmartStore.Data/Migrations/201809241947314_ForumGroupAcl.Designer.cs

@@ -0,0 +1,18 @@
+namespace SmartStore.Data.Migrations
+{
+    using System;
+    using System.Data.Entity.Migrations;
+    
+    public partial class ForumGroupAcl : DbMigration
+    {
+        public override void Up()
+        {
+            AddColumn("dbo.Forums_Group", "SubjectToAcl", c => c.Boolean(nullable: false));
+        }
+        
+        public override void Down()
+        {
+            DropColumn("dbo.Forums_Group", "SubjectToAcl");
+        }
+    }
+}

src/Libraries/SmartStore.Data/Migrations/201809241947314_ForumGroupAcl.cs

@@ -623,6 +623,10 @@
     <Compile Include="Migrations\201809171309522_NewsletterSubscriptionLanguage.Designer.cs">
       <DependentUpon>201809171309522_NewsletterSubscriptionLanguage.cs</DependentUpon>
     </Compile>
+    <Compile Include="Migrations\201809241947314_ForumGroupAcl.cs" />
+    <Compile Include="Migrations\201809241947314_ForumGroupAcl.Designer.cs">
+      <DependentUpon>201809241947314_ForumGroupAcl.cs</DependentUpon>
+    </Compile>
     <Compile Include="ObjectContextBase.SaveChanges.cs" />
     <Compile Include="Setup\Builder\ActivityLogTypeMigrator.cs" />
     <Compile Include="Setup\Builder\PermissionMigrator.cs" />
@@ -1120,6 +1124,9 @@
     <EmbeddedResource Include="Migrations\201809171309522_NewsletterSubscriptionLanguage.resx">
       <DependentUpon>201809171309522_NewsletterSubscriptionLanguage.cs</DependentUpon>
     </EmbeddedResource>
+    <EmbeddedResource Include="Migrations\201809241947314_ForumGroupAcl.resx">
+      <DependentUpon>201809241947314_ForumGroupAcl.cs</DependentUpon>
+    </EmbeddedResource>
     <EmbeddedResource Include="Sql\Indexes.sql" />
     <EmbeddedResource Include="Sql\StoredProcedures.sql" />
   </ItemGroup>

src/Libraries/SmartStore.Data/Migrations/201809241947314_ForumGroupAcl.resx

@@ -4,6 +4,7 @@
 using SmartStore.Core.Data;
 using SmartStore.Core.Domain.Customers;
 using SmartStore.Core.Domain.Forums;
+using SmartStore.Core.Domain.Security;
 using SmartStore.Core.Domain.Stores;
 using SmartStore.Data.Caching;
 using SmartStore.Services.Common;
@@ -19,6 +20,7 @@ public partial class ForumService : IForumService
         private readonly IRepository<ForumPost> _forumPostRepository;
         private readonly IRepository<PrivateMessage> _forumPrivateMessageRepository;
         private readonly IRepository<ForumSubscription> _forumSubscriptionRepository;
+        private readonly IRepository<AclRecord> _aclRepository;
         private readonly ForumSettings _forumSettings;
         private readonly IRepository<Customer> _customerRepository;
         private readonly IGenericAttributeService _genericAttributeService;
@@ -33,6 +35,7 @@ public ForumService(
             IRepository<ForumPost> forumPostRepository,
             IRepository<PrivateMessage> forumPrivateMessageRepository,
             IRepository<ForumSubscription> forumSubscriptionRepository,
+            IRepository<AclRecord> aclRepository,
             ForumSettings forumSettings,
             IRepository<Customer> customerRepository,
             IGenericAttributeService genericAttributeService,
@@ -46,6 +49,7 @@ public ForumService(
             _forumPostRepository = forumPostRepository;
             _forumPrivateMessageRepository = forumPrivateMessageRepository;
             _forumSubscriptionRepository = forumSubscriptionRepository;
+            _aclRepository = aclRepository;
             _forumSettings = forumSettings;
             _customerRepository = customerRepository;
             _genericAttributeService = genericAttributeService;
@@ -146,8 +150,9 @@ public virtual ForumGroup GetForumGroupById(int forumGroupId)
             return _forumGroupRepository.GetById(forumGroupId);
         }
 
-        public virtual IList<ForumGroup> GetAllForumGroups(int storeId = 0)
+        public virtual IList<ForumGroup> GetAllForumGroups(int storeId = 0, bool showHidden = false)
         {
+            var joinApplied = false;
             var query = _forumGroupRepository.Table.Expand(x => x.Forums);
 
             if (!QuerySettings.IgnoreMultiStore && storeId > 0)
@@ -159,6 +164,25 @@ from sm in fg_sm.DefaultIfEmpty()
                     where !fg.LimitedToStores || storeId == sm.StoreId
                     select fg;
 
+                joinApplied = true;
+            }
+
+            if (!showHidden && !QuerySettings.IgnoreAcl)
+            {
+                var allowedCustomerRolesIds = _services.WorkContext.CurrentCustomer.CustomerRoles.Where(x => x.Active).Select(x => x.Id).ToList();
+
+                query = 
+                    from fg in query
+                    join a in _aclRepository.Table on new { a1 = fg.Id, a2 = "ForumGroup" } equals new { a1 = a.EntityId, a2 = a.EntityName } into fg_acl
+                    from a in fg_acl.DefaultIfEmpty()
+                    where !fg.SubjectToAcl || allowedCustomerRolesIds.Contains(a.CustomerRoleId)
+                    select fg;
+
+                joinApplied = true;
+            }
+
+            if (joinApplied)
+            {
                 query =
                     from fg in query
                     group fg by fg.Id into fgGroup
@@ -317,8 +341,9 @@ public virtual IPagedList<ForumTopic> GetAllTopics(int forumId, int pageIndex, i
             return topics;
         }
 
-        public virtual IList<ForumTopic> GetActiveTopics(int forumId, int count)
+        public virtual IList<ForumTopic> GetActiveTopics(int forumId, int count, bool showHidden = false)
         {
+            var joinApplied = false;
             var query =
 				from ft in _forumTopicRepository.Table
 				where (forumId == 0 || ft.ForumId == forumId) && (ft.LastPostTime.HasValue)
@@ -337,14 +362,35 @@ from sm in fg_sm.DefaultIfEmpty()
 					where !fg.LimitedToStores || currentStoreId == sm.StoreId
 					select ft;
 
-				query =
-					from ft in query
-					group ft by ft.Id into ftGroup
-					orderby ftGroup.Key
-					select ftGroup.FirstOrDefault();
+                joinApplied = true;
 			}
 
-			query = query.OrderByDescending(x => x.LastPostTime);
+            if (!showHidden && !QuerySettings.IgnoreAcl)
+            {
+                var allowedCustomerRolesIds = _services.WorkContext.CurrentCustomer.CustomerRoles.Where(x => x.Active).Select(x => x.Id).ToList();
+
+                query =
+                    from ft in query
+                    join ff in _forumRepository.Table on ft.ForumId equals ff.Id
+                    join fg in _forumGroupRepository.Table on ff.ForumGroupId equals fg.Id
+                    join a in _aclRepository.Table on new { a1 = fg.Id, a2 = "ForumGroup" } equals new { a1 = a.EntityId, a2 = a.EntityName } into fg_acl
+                    from a in fg_acl.DefaultIfEmpty()
+                    where !fg.SubjectToAcl || allowedCustomerRolesIds.Contains(a.CustomerRoleId)
+                    select ft;
+
+                joinApplied = true;
+            }
+
+            if (joinApplied)
+            {
+                query =
+                    from ft in query
+                    group ft by ft.Id into ftGroup
+                    orderby ftGroup.Key
+                    select ftGroup.FirstOrDefault();
+            }
+
+            query = query.OrderByDescending(x => x.LastPostTime);
 
             var forumTopics = query.Take(count).ToList();
             return forumTopics;

src/Libraries/SmartStore.Data/SmartStore.Data.csproj

@@ -23,8 +23,9 @@ public partial interface IForumService
         /// Gets all forum groups
         /// </summary>
         /// <param name="storeId">Store identifier</param>
+        /// <param name="showHidden">Whether to load hidden records</param>
         /// <returns>Forum groups</returns>
-		IList<ForumGroup> GetAllForumGroups(int storeId = 0);
+		IList<ForumGroup> GetAllForumGroups(int storeId = 0, bool showHidden = false);
 
         /// <summary>
         /// Deletes a forum group
@@ -112,8 +113,9 @@ public partial interface IForumService
         /// </summary>
         /// <param name="forumId">The forum identifier</param>
         /// <param name="topicCount">Count of forum topics to return</param>
+        /// <param name="showHidden">Whether to load hidden records</param>
         /// <returns>Forum Topics</returns>
-        IList<ForumTopic> GetActiveTopics(int forumId, int topicCount);
+        IList<ForumTopic> GetActiveTopics(int forumId, int topicCount, bool showHidden = false);
 
         /// <summary>
         /// Deletes a forum topic