From faa6a229e6f7be2ed1b12d13623feea364d490fc Mon Sep 17 00:00:00 2001 From: Shannon Date: Mon, 15 May 2017 20:27:40 +1000 Subject: [PATCH] Updates UserGroupRepository to ensure that it persists things int he correct order and inside of a transaction, removes new code that is already obsolete, fixes tests --- .../Interfaces/IUserGroupRepository.cs | 14 +- .../Repositories/UserGroupRepository.cs | 142 ++++++-- src/Umbraco.Core/Services/IUserService.cs | 12 +- src/Umbraco.Core/Services/UserService.cs | 16 +- .../Repositories/UserRepositoryTest.cs | 11 +- .../Services/SectionServiceTests.cs | 5 +- .../Services/UserServiceTests.cs | 22 +- .../umbraco/config/create/UI.Release.xml | 8 - .../umbraco/config/create/UI.xml | 10 +- src/Umbraco.Web/Umbraco.Web.csproj | 1 - .../umbraco/Trees/UserGroups.cs | 6 +- .../umbraco/users/EditUserGroup.aspx.cs | 27 +- .../umbraco/users/UserGroupTasks.cs | 42 --- src/umbraco.businesslogic/UserGroup.cs | 309 ------------------ .../umbraco.businesslogic.csproj | 1 - 15 files changed, 176 insertions(+), 450 deletions(-) delete mode 100644 src/Umbraco.Web/umbraco.presentation/umbraco/users/UserGroupTasks.cs delete mode 100644 src/umbraco.businesslogic/UserGroup.cs diff --git a/src/Umbraco.Core/Persistence/Repositories/Interfaces/IUserGroupRepository.cs b/src/Umbraco.Core/Persistence/Repositories/Interfaces/IUserGroupRepository.cs index a26833a4ce..3aca34c5bd 100644 --- a/src/Umbraco.Core/Persistence/Repositories/Interfaces/IUserGroupRepository.cs +++ b/src/Umbraco.Core/Persistence/Repositories/Interfaces/IUserGroupRepository.cs @@ -19,17 +19,11 @@ namespace Umbraco.Core.Persistence.Repositories IEnumerable GetGroupsAssignedToSection(string sectionAlias); /// - /// Removes all users from a group + /// Used to add or update a user group and assign users to it /// - /// Id of group - void RemoveAllUsersFromGroup(int groupId); - - /// - /// Adds a set of users to a group - /// - /// Id of group - /// Ids of users - void AddUsersToGroup(int groupId, int[] userIds); + /// + /// + void AddOrUpdateGroupWithUsers(IUserGroup userGroup, int[] userIds); /// /// Gets the group permissions for the specified entities diff --git a/src/Umbraco.Core/Persistence/Repositories/UserGroupRepository.cs b/src/Umbraco.Core/Persistence/Repositories/UserGroupRepository.cs index d4476bd3c8..2cc8819da0 100644 --- a/src/Umbraco.Core/Persistence/Repositories/UserGroupRepository.cs +++ b/src/Umbraco.Core/Persistence/Repositories/UserGroupRepository.cs @@ -4,6 +4,7 @@ using System.Linq; using Umbraco.Core.Logging; using Umbraco.Core.Models; using Umbraco.Core.Cache; +using Umbraco.Core.Models.EntityBase; using Umbraco.Core.Models.Membership; using Umbraco.Core.Models.Rdbms; using Umbraco.Core.Persistence.Factories; @@ -20,11 +21,13 @@ namespace Umbraco.Core.Persistence.Repositories internal class UserGroupRepository : PetaPocoRepositoryBase, IUserGroupRepository { private readonly CacheHelper _cacheHelper; + private readonly UserGroupWithUsersRepository _userGroupWithUsersRepository; public UserGroupRepository(IScopeUnitOfWork work, CacheHelper cacheHelper, ILogger logger, ISqlSyntaxProvider sqlSyntax) : base(work, cacheHelper, logger, sqlSyntax) { _cacheHelper = cacheHelper; + _userGroupWithUsersRepository = new UserGroupWithUsersRepository(this, work, cacheHelper, logger, sqlSyntax); } public const string GetByAliasCacheKeyPrefix = "UserGroupRepository_GetByAlias_"; @@ -80,32 +83,11 @@ namespace Umbraco.Core.Persistence.Repositories return ConvertFromDtos(Database.Fetch(new UserGroupSectionRelator().Map, sql)); } - /// - /// Removes all users from a group - /// - /// Id of group - public void RemoveAllUsersFromGroup(int groupId) + public void AddOrUpdateGroupWithUsers(IUserGroup userGroup, int[] userIds) { - Database.Delete("WHERE userGroupId = @GroupId", new { GroupId = groupId }); + _userGroupWithUsersRepository.AddOrUpdate(new UserGroupWithUsers(userGroup, userIds)); } - /// - /// Adds a set of users to a group - /// - /// Id of group - /// Ids of users - public void AddUsersToGroup(int groupId, int[] userIds) - { - foreach (var userId in userIds) - { - var dto = new User2UserGroupDto - { - UserGroupId = groupId, - UserId = userId, - }; - Database.Insert(dto); - } - } /// /// Gets the group permissions for the specified entities @@ -287,5 +269,119 @@ namespace Umbraco.Core.Persistence.Repositories { return dtos.Select(UserGroupFactory.BuildEntity); } + + /// + /// used to persist a user group with associated users at once + /// + private class UserGroupWithUsers : Entity, IAggregateRoot + { + public UserGroupWithUsers(IUserGroup userGroup, int[] userIds) + { + UserGroup = userGroup; + UserIds = userIds; + } + + public IUserGroup UserGroup { get; private set; } + public int[] UserIds { get; private set; } + + } + + /// + /// used to persist a user group with associated users at once + /// + private class UserGroupWithUsersRepository : PetaPocoRepositoryBase + { + private readonly UserGroupRepository _userGroupRepo; + + public UserGroupWithUsersRepository(UserGroupRepository userGroupRepo, IScopeUnitOfWork work, CacheHelper cache, ILogger logger, ISqlSyntaxProvider sqlSyntax) + : base(work, cache, logger, sqlSyntax) + { + _userGroupRepo = userGroupRepo; + } + + #region Not implemented (don't need to for the purposes of this repo) + protected override UserGroupWithUsers PerformGet(int id) + { + throw new NotImplementedException(); + } + protected override IEnumerable PerformGetAll(params int[] ids) + { + throw new NotImplementedException(); + } + protected override IEnumerable PerformGetByQuery(IQuery query) + { + throw new NotImplementedException(); + } + protected override Sql GetBaseQuery(bool isCount) + { + throw new NotImplementedException(); + } + protected override string GetBaseWhereClause() + { + throw new NotImplementedException(); + } + protected override IEnumerable GetDeleteClauses() + { + throw new NotImplementedException(); + } + protected override Guid NodeObjectTypeId + { + get { throw new NotImplementedException(); } + } + #endregion + + protected override void PersistNewItem(UserGroupWithUsers entity) + { + //save the user group + _userGroupRepo.PersistNewItem(entity.UserGroup); + if (entity.UserIds != null) + { + //now the user association + RemoveAllUsersFromGroup(entity.UserGroup.Id); + AddUsersToGroup(entity.UserGroup.Id, entity.UserIds); + } + + } + + protected override void PersistUpdatedItem(UserGroupWithUsers entity) + { + //save the user group + _userGroupRepo.PersistUpdatedItem(entity.UserGroup); + if (entity.UserIds != null) + { + //now the user association + RemoveAllUsersFromGroup(entity.UserGroup.Id); + AddUsersToGroup(entity.UserGroup.Id, entity.UserIds); + } + } + + /// + /// Removes all users from a group + /// + /// Id of group + private void RemoveAllUsersFromGroup(int groupId) + { + Database.Delete("WHERE userGroupId = @GroupId", new { GroupId = groupId }); + } + + /// + /// Adds a set of users to a group + /// + /// Id of group + /// Ids of users + private void AddUsersToGroup(int groupId, int[] userIds) + { + //TODO: Check if the user exists? + foreach (var userId in userIds) + { + var dto = new User2UserGroupDto + { + UserGroupId = groupId, + UserId = userId, + }; + Database.Insert(dto); + } + } + } } } \ No newline at end of file diff --git a/src/Umbraco.Core/Services/IUserService.cs b/src/Umbraco.Core/Services/IUserService.cs index bba95792ee..d0d2abfe72 100644 --- a/src/Umbraco.Core/Services/IUserService.cs +++ b/src/Umbraco.Core/Services/IUserService.cs @@ -189,17 +189,19 @@ namespace Umbraco.Core.Services /// /// Id of the UserGroup to retrieve /// - IUserGroup GetUserGroupById(int id); - + IUserGroup GetUserGroupById(int id); + /// /// Saves a UserGroup /// /// UserGroup to save - /// Flag for whether to update the list of users in the group - /// List of user Ids + /// + /// If null than no changes are made to the users who are assigned to this group, however if a value is passed in + /// than all users will be removed from this group and only these users will be added + /// /// Optional parameter to raise events. /// Default is True otherwise set to False to not raise events - void SaveUserGroup(IUserGroup userGroup, bool updateUsers = false, int[] userIds = null, bool raiseEvents = true); + void Save(IUserGroup userGroup, int[] userIds = null, bool raiseEvents = true); /// /// Deletes a UserGroup diff --git a/src/Umbraco.Core/Services/UserService.cs b/src/Umbraco.Core/Services/UserService.cs index 07c0ad4e5b..8206ab4bca 100644 --- a/src/Umbraco.Core/Services/UserService.cs +++ b/src/Umbraco.Core/Services/UserService.cs @@ -682,11 +682,13 @@ namespace Umbraco.Core.Services /// Saves a UserGroup /// /// UserGroup to save - /// Flag for whether to update the list of users in the group - /// List of user Ids + /// + /// If null than no changes are made to the users who are assigned to this group, however if a value is passed in + /// than all users will be removed from this group and only these users will be added + /// /// Optional parameter to raise events. /// Default is True otherwise set to False to not raise events - public void SaveUserGroup(IUserGroup userGroup, bool updateUsers = false, int[] userIds = null, bool raiseEvents = true) + public void Save(IUserGroup userGroup, int[] userIds = null, bool raiseEvents = true) { using (var uow = UowProvider.GetUnitOfWork()) { @@ -697,14 +699,8 @@ namespace Umbraco.Core.Services } var repository = RepositoryFactory.CreateUserGroupRepository(uow); - repository.AddOrUpdate(userGroup); + repository.AddOrUpdateGroupWithUsers(userGroup, userIds); - - if (updateUsers) - { - repository.RemoveAllUsersFromGroup(userGroup.Id); - repository.AddUsersToGroup(userGroup.Id, userIds); - } uow.Commit(); if (raiseEvents) diff --git a/src/Umbraco.Tests/Persistence/Repositories/UserRepositoryTest.cs b/src/Umbraco.Tests/Persistence/Repositories/UserRepositoryTest.cs index 62b22f681a..fc2b870eef 100644 --- a/src/Umbraco.Tests/Persistence/Repositories/UserRepositoryTest.cs +++ b/src/Umbraco.Tests/Persistence/Repositories/UserRepositoryTest.cs @@ -339,16 +339,15 @@ namespace Umbraco.Tests.Persistence.Repositories private static User CreateAndCommitUserWithGroup(IUserRepository repository, IUserGroupRepository userGroupRepository, IDatabaseUnitOfWork unitOfWork) { - var group = MockedUserGroup.CreateUserGroup(); - userGroupRepository.AddOrUpdate(@group); - unitOfWork.Commit(); - + var user = MockedUser.CreateUser(); repository.AddOrUpdate(user); unitOfWork.Commit(); - userGroupRepository.AddUsersToGroup(@group.Id, new[] { user.Id }); - unitOfWork.Commit(); + var group = MockedUserGroup.CreateUserGroup(); + userGroupRepository.AddOrUpdateGroupWithUsers(@group, new[] {user.Id}); + unitOfWork.Commit(); + return user; } diff --git a/src/Umbraco.Tests/Services/SectionServiceTests.cs b/src/Umbraco.Tests/Services/SectionServiceTests.cs index 556203bb61..0d95cfc56d 100644 --- a/src/Umbraco.Tests/Services/SectionServiceTests.cs +++ b/src/Umbraco.Tests/Services/SectionServiceTests.cs @@ -60,7 +60,8 @@ namespace Umbraco.Tests.Services }; userGroupA.AddAllowedSection("media"); userGroupA.AddAllowedSection("settings"); - ServiceContext.UserService.SaveUserGroup(userGroupA, true, new[] { user.Id }, false); + //TODO: This is failing the test + ServiceContext.UserService.Save(userGroupA, new[] { user.Id }, false); var userGroupB = new UserGroup { @@ -69,7 +70,7 @@ namespace Umbraco.Tests.Services }; userGroupB.AddAllowedSection("settings"); userGroupB.AddAllowedSection("developer"); - ServiceContext.UserService.SaveUserGroup(userGroupB, true, new[] { user.Id }, false); + ServiceContext.UserService.Save(userGroupB, new[] { user.Id }, false); return ServiceContext.UserService.GetUserById(user.Id); } diff --git a/src/Umbraco.Tests/Services/UserServiceTests.cs b/src/Umbraco.Tests/Services/UserServiceTests.cs index f5b9389939..02a4f335cc 100644 --- a/src/Umbraco.Tests/Services/UserServiceTests.cs +++ b/src/Umbraco.Tests/Services/UserServiceTests.cs @@ -415,7 +415,7 @@ namespace Umbraco.Tests.Services }; userGroup.AddAllowedSection("content"); userGroup.AddAllowedSection("mediat"); - ServiceContext.UserService.SaveUserGroup(userGroup); + ServiceContext.UserService.Save(userGroup); var result1 = ServiceContext.UserService.GetUserGroupById(userGroup.Id); @@ -426,7 +426,7 @@ namespace Umbraco.Tests.Services userGroup.AddAllowedSection("test2"); userGroup.AddAllowedSection("test3"); userGroup.AddAllowedSection("test4"); - ServiceContext.UserService.SaveUserGroup(userGroup); + ServiceContext.UserService.Save(userGroup); result1 = ServiceContext.UserService.GetUserGroupById(userGroup.Id); @@ -441,7 +441,7 @@ namespace Umbraco.Tests.Services //now just re-add a couple result1.AddAllowedSection("test3"); result1.AddAllowedSection("test4"); - ServiceContext.UserService.SaveUserGroup(result1); + ServiceContext.UserService.Save(result1); //assert //re-get @@ -464,14 +464,14 @@ namespace Umbraco.Tests.Services Alias = "Group2", Name = "Group 2" }; - ServiceContext.UserService.SaveUserGroup(userGroup1); - ServiceContext.UserService.SaveUserGroup(userGroup2); + ServiceContext.UserService.Save(userGroup1); + ServiceContext.UserService.Save(userGroup2); //adds some allowed sections userGroup1.AddAllowedSection("test"); userGroup2.AddAllowedSection("test"); - ServiceContext.UserService.SaveUserGroup(userGroup1); - ServiceContext.UserService.SaveUserGroup(userGroup2); + ServiceContext.UserService.Save(userGroup1); + ServiceContext.UserService.Save(userGroup2); //now clear the section from all users ServiceContext.UserService.DeleteSectionFromAllUserGroups("test"); @@ -504,9 +504,9 @@ namespace Umbraco.Tests.Services Alias = "Group3", Name = "Group 3" }; - ServiceContext.UserService.SaveUserGroup(userGroup1); - ServiceContext.UserService.SaveUserGroup(userGroup2); - ServiceContext.UserService.SaveUserGroup(userGroup3); + ServiceContext.UserService.Save(userGroup1); + ServiceContext.UserService.Save(userGroup2); + ServiceContext.UserService.Save(userGroup3); //now add the section to specific groups ServiceContext.UserService.AddSectionToAllUserGroups("test", userGroup1.Id, userGroup2.Id); @@ -641,7 +641,7 @@ namespace Umbraco.Tests.Services Name = "Test Group", Permissions = "ABCDEFGHIJ1234567".ToCharArray().Select(x => x.ToString()) }; - ServiceContext.UserService.SaveUserGroup(userGroup); + ServiceContext.UserService.Save(userGroup); ServiceContext.UserService.AddSectionToAllUserGroups("content", 1); ServiceContext.UserService.AddSectionToAllUserGroups("media", 1); return userGroup; diff --git a/src/Umbraco.Web.UI/umbraco/config/create/UI.Release.xml b/src/Umbraco.Web.UI/umbraco/config/create/UI.Release.xml index 7af0512ed7..1cb5e32201 100644 --- a/src/Umbraco.Web.UI/umbraco/config/create/UI.Release.xml +++ b/src/Umbraco.Web.UI/umbraco/config/create/UI.Release.xml @@ -235,14 +235,6 @@ - -
User Groups
- /create/simple.ascx - - - - -
Macro
/Create/PartialView.ascx diff --git a/src/Umbraco.Web.UI/umbraco/config/create/UI.xml b/src/Umbraco.Web.UI/umbraco/config/create/UI.xml index 3edb5fcedc..af2eece2ab 100644 --- a/src/Umbraco.Web.UI/umbraco/config/create/UI.xml +++ b/src/Umbraco.Web.UI/umbraco/config/create/UI.xml @@ -212,15 +212,7 @@ - - -
User Groups
- /create/simple.ascx - - - - - +
Macro
/Create/PartialView.ascx diff --git a/src/Umbraco.Web/Umbraco.Web.csproj b/src/Umbraco.Web/Umbraco.Web.csproj index e8c92893fa..b6a5d30f49 100644 --- a/src/Umbraco.Web/Umbraco.Web.csproj +++ b/src/Umbraco.Web/Umbraco.Web.csproj @@ -456,7 +456,6 @@ ASPXCodeBehind - diff --git a/src/Umbraco.Web/umbraco.presentation/umbraco/Trees/UserGroups.cs b/src/Umbraco.Web/umbraco.presentation/umbraco/Trees/UserGroups.cs index 98e87ce34b..8c96b2069c 100644 --- a/src/Umbraco.Web/umbraco.presentation/umbraco/Trees/UserGroups.cs +++ b/src/Umbraco.Web/umbraco.presentation/umbraco/Trees/UserGroups.cs @@ -24,12 +24,12 @@ function openUserGroups(id) { public override void Render(ref XmlTree tree) { - List userGroups = UserGroup.GetAllUserGroups(); - foreach (UserGroup userGroup in userGroups) + var userGroups = ApplicationContext.Current.Services.UserService.GetAllUserGroups(); + foreach (var userGroup in userGroups) { XmlTreeNode node = XmlTreeNode.Create(this); node.NodeID = userGroup.Id.ToString(); - node.Action = string.Format("javascript:openUserGroups({0})", userGroup.Id.ToString()); + node.Action = string.Format("javascript:openUserGroups({0})", userGroup.Id); node.Icon = "icon-users"; node.Text = userGroup.Name; diff --git a/src/Umbraco.Web/umbraco.presentation/umbraco/users/EditUserGroup.aspx.cs b/src/Umbraco.Web/umbraco.presentation/umbraco/users/EditUserGroup.aspx.cs index 9b929bd931..a992c4d77e 100644 --- a/src/Umbraco.Web/umbraco.presentation/umbraco/users/EditUserGroup.aspx.cs +++ b/src/Umbraco.Web/umbraco.presentation/umbraco/users/EditUserGroup.aspx.cs @@ -1,11 +1,14 @@ using System; using System.Collections.Generic; +using System.Globalization; +using System.Linq; using System.Web.UI.WebControls; using umbraco.BasePages; using umbraco.BusinessLogic; using umbraco.cms.presentation.Trees; using umbraco.interfaces; using Umbraco.Core; +using Umbraco.Core.Models.Membership; namespace umbraco.cms.presentation.user { @@ -65,7 +68,7 @@ namespace umbraco.cms.presentation.user actions += li.Value; } - userGroup.DefaultPermissions = actions; + userGroup.Permissions = actions.ToCharArray().Select(x => x.ToString(CultureInfo.InvariantCulture)); ; var userIds = new List(); foreach (ListItem li in lstUsersInGroup.Items) @@ -73,13 +76,13 @@ namespace umbraco.cms.presentation.user userIds.Add(int.Parse(li.Value)); } - userGroup.ClearApplications(); + userGroup.ClearAllowedSections(); foreach (ListItem li in cbl_sections.Items) { - if (li.Selected) userGroup.AddApplication(li.Value); + if (li.Selected) userGroup.AddAllowedSection(li.Value); } - userGroup.SaveWithUsers(userIds.ToArray()); + Services.UserService.Save(userGroup, userIds.ToArray()); ClientTools.ShowSpeechBubble(speechBubbleIcon.save, ui.Text("speechBubbles", "editUserGroupSaved", base.getUser()), ""); } @@ -89,22 +92,22 @@ namespace umbraco.cms.presentation.user get { if (m_userGroupActions == null) - m_userGroupActions = umbraco.BusinessLogic.Actions.Action.FromString(CurrentUserGroup.DefaultPermissions); + m_userGroupActions = umbraco.BusinessLogic.Actions.Action.FromString(string.Join("", CurrentUserGroup.Permissions)); return m_userGroupActions; } } - protected UserGroup CurrentUserGroup + protected IUserGroup CurrentUserGroup { get { if (m_userGroup == null) - m_userGroup = UserGroup.GetUserGroup(m_userGroupID); + m_userGroup = ApplicationContext.Current.Services.UserService.GetUserGroupById(m_userGroupID); return m_userGroup; } } - private UserGroup m_userGroup; + private IUserGroup m_userGroup; private List m_userGroupActions; private int m_userGroupID; @@ -135,13 +138,17 @@ namespace umbraco.cms.presentation.user foreach (Application a in CurrentUser.Applications) currentUserApps += a.alias + ";"; - Application[] gapps = CurrentUserGroup.Applications; + var gapps = CurrentUserGroup.AllowedSections; foreach (Application app in BusinessLogic.Application.getAll()) { if (CurrentUser.IsAdmin() || currentUserApps.Contains(";" + app.alias + ";")) { ListItem li = new ListItem(ui.Text("sections", app.alias), app.alias); - foreach (Application tmp in gapps) if (app.alias == tmp.alias) li.Selected = true; + foreach (var tmp in gapps) + { + if (app.alias == tmp) + li.Selected = true; + } cbl_sections.Items.Add(li); } } diff --git a/src/Umbraco.Web/umbraco.presentation/umbraco/users/UserGroupTasks.cs b/src/Umbraco.Web/umbraco.presentation/umbraco/users/UserGroupTasks.cs deleted file mode 100644 index 0aae75d278..0000000000 --- a/src/Umbraco.Web/umbraco.presentation/umbraco/users/UserGroupTasks.cs +++ /dev/null @@ -1,42 +0,0 @@ -using Umbraco.Web.UI; -using umbraco.BusinessLogic; - -namespace umbraco.cms.presentation.user -{ - public class UserGroupTasks : LegacyDialogTask - { - public override bool PerformSave() - { - try - { - var u = UserGroup.MakeNew(Alias, "", Alias); - _returnUrl = string.Format("users/EditUserGroup.aspx?id={0}", u.Id); - return true; - } - catch - { - return false; - } - } - - public override bool PerformDelete() - { - var userGroup = UserGroup.GetUserGroup(ParentID); - if (userGroup == null) - return false; - userGroup.Delete(); - return true; - } - - private string _returnUrl = ""; - public override string ReturnUrl - { - get { return _returnUrl; } - } - - public override string AssignedApp - { - get { return DefaultApps.users.ToString(); } - } - } -} \ No newline at end of file diff --git a/src/umbraco.businesslogic/UserGroup.cs b/src/umbraco.businesslogic/UserGroup.cs deleted file mode 100644 index 4a18a95c33..0000000000 --- a/src/umbraco.businesslogic/UserGroup.cs +++ /dev/null @@ -1,309 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using Umbraco.Core; -using Umbraco.Core.Events; - -namespace umbraco.BusinessLogic -{ - /// - /// Represents a umbraco Usergroup - /// - [Obsolete("Use the UserService instead")] - public class UserGroup - { - internal Umbraco.Core.Models.Membership.IUserGroup UserGroupItem; - - /// - /// Creates a new empty instance of a UserGroup - /// - public UserGroup() - { - UserGroupItem = new Umbraco.Core.Models.Membership.UserGroup(); - } - - internal UserGroup(Umbraco.Core.Models.Membership.IUserGroup userGroup) - { - UserGroupItem = userGroup; - } - - /// - /// Creates a new instance of a UserGroup and attempts to - /// load it's values from the database cache. - /// - /// - /// If the UserGroup is not found in the existing ID list, then this object - /// will remain an empty object - /// - /// The UserGroup id to find - public UserGroup(int id) - { - this.LoadByPrimaryKey(id); - } - - /// - /// Initializes a new instance of the class. - /// - /// The user type id. - /// The name. - public UserGroup(int id, string name) - { - UserGroupItem = new Umbraco.Core.Models.Membership.UserGroup(); - UserGroupItem.Id = id; - UserGroupItem.Name = name; - } - - /// - /// Creates a new instance of UserGroup with all parameters - /// - /// - /// - /// - /// - public UserGroup(int id, string name, string defaultPermissions, string alias) - { - UserGroupItem = new Umbraco.Core.Models.Membership.UserGroup(); - UserGroupItem.Id = id; - UserGroupItem.Name = name; - UserGroupItem.Alias = alias; - UserGroupItem.Permissions = defaultPermissions.ToCharArray().Select(x => x.ToString(CultureInfo.InvariantCulture)); - } - - /// - /// The cache storage for all user groups - /// - private static List UserGroups - { - get - { - return ApplicationContext.Current.Services.UserService.GetAllUserGroups() - .Select(x => new UserGroup(x)) - .ToList(); - } - } - - #region Public Properties - /// - /// Gets or sets the user type alias. - /// - public string Alias - { - get { return UserGroupItem.Alias; } - set { UserGroupItem.Alias = value; } - } - - /// - /// Gets the name of the user type. - /// - public string Name - { - get { return UserGroupItem.Name; } - set { UserGroupItem.Name = value; } - } - - /// - /// Gets the id the user group - /// - public int Id - { - get { return UserGroupItem.Id; } - } - - /// - /// Gets the default permissions of the user group - /// - public string DefaultPermissions - { - get { return UserGroupItem.Permissions == null ? string.Empty : string.Join("", UserGroupItem.Permissions); } - set { UserGroupItem.Permissions = value.ToCharArray().Select(x => x.ToString(CultureInfo.InvariantCulture)); } - } - - /// - /// Gets the applications which the group has access to. - /// - /// The users applications. - public Application[] Applications - { - get - { - return GetApplications().ToArray(); - } - } - - /// - /// Get the application which the group has access to as a List - /// - /// - public List GetApplications() - { - var allApps = Application.getAll(); - var apps = new List(); - - var sections = UserGroupItem.AllowedSections; - - foreach (var s in sections) - { - var app = allApps.SingleOrDefault(x => x.alias == s); - if (app != null) - apps.Add(app); - } - - return apps; - } - - /// - /// Clears the list of applications the user has access to, ensure to call Save afterwords - /// - public void ClearApplications() - { - foreach (var s in UserGroupItem.AllowedSections.ToArray()) - { - UserGroupItem.RemoveAllowedSection(s); - } - } - - /// - /// Adds a application to the list of allowed applications, ensure to call Save() afterwords - /// - /// - public void AddApplication(string appAlias) - { - UserGroupItem.AddAllowedSection(appAlias); - } - - #endregion - - /// - /// Saves this instance - /// - public void Save() - { - PerformSave(); - } - - /// - /// Saves this instance (along with the list of users in the group if provided) - /// - public void SaveWithUsers(int[] userIds) - { - PerformSave(true, userIds); - } - - private void PerformSave(bool updateUsers = false, int[] userIds = null) - { - //ensure that this object has an ID specified (it exists in the database) - if (UserGroupItem.HasIdentity == false) - throw new Exception("The current UserGroup object does not exist in the database. New UserGroups should be created with the MakeNew method"); - - ApplicationContext.Current.Services.UserService.SaveUserGroup(UserGroupItem, updateUsers, userIds); - - //raise event - OnUpdated(this, new EventArgs()); - } - - /// - /// Deletes this instance. - /// - public void Delete() - { - //ensure that this object has an ID specified (it exists in the database) - if (UserGroupItem.HasIdentity == false) - throw new Exception("The current UserGroup object does not exist in the database. New UserGroups should be created with the MakeNew method"); - - ApplicationContext.Current.Services.UserService.DeleteUserGroup(UserGroupItem); - - //raise event - OnDeleted(this, new EventArgs()); - } - - /// - /// Load the data for the current UserGroup by it's id - /// - /// - /// Returns true if the UserGroup id was found - /// and the data was loaded, false if it wasn't - public bool LoadByPrimaryKey(int id) - { - UserGroupItem = ApplicationContext.Current.Services.UserService.GetUserGroupById(id); - return UserGroupItem != null; - } - - /// - /// Creates a new user group - /// - /// - /// - /// - public static UserGroup MakeNew(string name, string defaultPermissions, string alias) - { - //ensure that the current alias does not exist - //get the id for the new user group - var existing = UserGroups.Find(ut => (ut.Alias == alias)); - - if (existing != null) - throw new Exception("The UserGroup alias specified already exists"); - - var userType = new Umbraco.Core.Models.Membership.UserGroup - { - Alias = alias, - Name = name, - Permissions = defaultPermissions.ToCharArray().Select(x => x.ToString(CultureInfo.InvariantCulture)) - }; - ApplicationContext.Current.Services.UserService.SaveUserGroup(userType); - - var legacy = new UserGroup(userType); - - //raise event - OnNew(legacy, new EventArgs()); - - return legacy; - } - - /// - /// Gets the user group with the specfied ID - /// - /// The id. - /// - public static UserGroup GetUserGroup(int id) - { - return UserGroups.Find(ut => (ut.Id == id)); - } - - /// - /// Returns all user groups - /// - /// - public static List GetAllUserGroups() - { - return UserGroups; - } - - internal static event TypedEventHandler New; - private static void OnNew(UserGroup userType, EventArgs args) - { - if (New != null) - { - New(userType, args); - } - } - - internal static event TypedEventHandler Deleted; - private static void OnDeleted(UserGroup userType, EventArgs args) - { - if (Deleted != null) - { - Deleted(userType, args); - } - } - - internal static event TypedEventHandler Updated; - private static void OnUpdated(UserGroup userType, EventArgs args) - { - if (Updated != null) - { - Updated(userType, args); - } - } - } -} \ No newline at end of file diff --git a/src/umbraco.businesslogic/umbraco.businesslogic.csproj b/src/umbraco.businesslogic/umbraco.businesslogic.csproj index 299742b1fc..8e2d3f4dd6 100644 --- a/src/umbraco.businesslogic/umbraco.businesslogic.csproj +++ b/src/umbraco.businesslogic/umbraco.businesslogic.csproj @@ -242,7 +242,6 @@ Code - Code