yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v14] Add missing alias and id to usergroup related api models (#16154)

Browse Source 
* Added missing alias and Id to usergroup models

create/update/response/item

* Changed userGroup IsSystemGroup to more meaningfull fields

Also enforced the AliasCanBeChanged businessrule 🙈

---------

Co-authored-by: Sven Geusens <sge@umbraco.dk>
Co-authored-by: Mads Rasmussen <madsr@hey.com>
This commit is contained in:
Sven Geusens
2024-05-03 10:24:09 +02:00
committed by GitHub
parent 8ad6c36038
commit f9c0235a35
13 changed files with 175 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Umbraco.Cms.Api.Management/Controllers/UserGroup/ByKeyUserGroupController.cs
View File

@@ -3,7 +3,6 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.Security.Authorization.UserGroup;
using Umbraco.Cms.Api.Management.ViewModels.UserGroup;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Security.Authorization;

6
src/Umbraco.Cms.Api.Management/Controllers/UserGroup/UserGroupControllerBase.cs
View File

@@ -29,11 +29,15 @@ public class UserGroupControllerBase : ManagementApiControllerBase
.WithTitle("Duplicate alias")
.WithDetail("A user group already exists with the attempted alias.")
.Build()),
UserGroupOperationStatus.CanNotUpdateAliasIsSystemUserGroup => BadRequest(problemDetailsBuilder
.WithTitle("System user group")
.WithDetail("Changing the alias is not allowed on a system user group.")
.Build()),
UserGroupOperationStatus.MissingUser => Unauthorized(problemDetailsBuilder
.WithTitle("Missing user")
.WithDetail("A performing user was not found when attempting the operation.")
.Build()),
UserGroupOperationStatus.IsSystemUserGroup => BadRequest(problemDetailsBuilder
UserGroupOperationStatus.CanNotDeleteIsSystemUserGroup => BadRequest(problemDetailsBuilder
.WithTitle("System user group")
.WithDetail("The operation is not allowed on a system user group.")
.Build()),

31
src/Umbraco.Cms.Api.Management/Factories/UserGroupPresentationFactory.cs
View File

@@ -51,8 +51,9 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
return new UserGroupResponseModel
{
Name = userGroup.Name ?? string.Empty,
Id = userGroup.Key,
Name = userGroup.Name ?? string.Empty,
Alias = userGroup.Alias,
DocumentStartNode = ReferenceByIdModel.ReferenceOrNull(contentStartNodeKey),
DocumentRootAccess = contentRootAccess,
MediaStartNode = ReferenceByIdModel.ReferenceOrNull(mediaStartNodeKey),
@@ -63,7 +64,8 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
FallbackPermissions = userGroup.Permissions,
Permissions = await _permissionPresentationFactory.CreateAsync(userGroup.GranularPermissions),
Sections = userGroup.AllowedSections.Select(SectionMapper.GetName),
IsSystemGroup = userGroup.IsSystemUserGroup()
IsDeletable = !userGroup.IsSystemUserGroup(),
AliasCanBeChanged = !userGroup.IsSystemUserGroup(),
};
}
@@ -83,8 +85,9 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
return new UserGroupResponseModel
{
Name = userGroup.Name ?? string.Empty,
Id = userGroup.Key,
Name = userGroup.Name ?? string.Empty,
Alias = userGroup.Alias,
DocumentStartNode = ReferenceByIdModel.ReferenceOrNull(contentStartNodeKey),
MediaStartNode = ReferenceByIdModel.ReferenceOrNull(mediaStartNodeKey),
Icon = userGroup.Icon,
@@ -93,6 +96,8 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
FallbackPermissions = userGroup.Permissions,
Permissions = await _permissionPresentationFactory.CreateAsync(userGroup.GranularPermissions),
Sections = userGroup.AllowedSections.Select(SectionMapper.GetName),
IsDeletable = !userGroup.IsSystemUserGroup(),
AliasCanBeChanged = !userGroup.IsSystemUserGroup(),
};
}
@@ -107,6 +112,7 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
return userGroupViewModels;
}
/// <inheritdoc />
public async Task<IEnumerable<UserGroupResponseModel>> CreateMultipleAsync(IEnumerable<IReadOnlyUserGroup> userGroups)
{
@@ -122,18 +128,21 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
/// <inheritdoc />
public async Task<Attempt<IUserGroup, UserGroupOperationStatus>> CreateAsync(CreateUserGroupRequestModel requestModel)
{
var cleanedName = requestModel.Name.CleanForXss('[', ']', '(', ')', ':');
var group = new UserGroup(_shortStringHelper)
{
Name = cleanedName,
Alias = cleanedName,
Name = CleanUserGroupNameOrAliasForXss(requestModel.Name),
Alias = CleanUserGroupNameOrAliasForXss(requestModel.Alias),
Icon = requestModel.Icon,
HasAccessToAllLanguages = requestModel.HasAccessToAllLanguages,
Permissions = requestModel.FallbackPermissions,
GranularPermissions = await _permissionPresentationFactory.CreatePermissionSetsAsync(requestModel.Permissions)
GranularPermissions = await _permissionPresentationFactory.CreatePermissionSetsAsync(requestModel.Permissions),
};
if (requestModel.Id.HasValue)
{
group.Key = requestModel.Id.Value;
}
Attempt<UserGroupOperationStatus> assignmentAttempt = AssignStartNodesToUserGroup(requestModel, group);
if (assignmentAttempt.Success is false)
{
@@ -186,7 +195,8 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
current.AddAllowedSection(SectionMapper.GetAlias(sectionName));
}
current.Name = request.Name.CleanForXss('[', ']', '(', ')', ':');
current.Name = CleanUserGroupNameOrAliasForXss(request.Name);
current.Alias = CleanUserGroupNameOrAliasForXss(request.Alias);
current.Icon = request.Icon;
current.HasAccessToAllLanguages = request.HasAccessToAllLanguages;
@@ -196,6 +206,9 @@ public class UserGroupPresentationFactory : IUserGroupPresentationFactory
return Attempt.SucceedWithStatus(UserGroupOperationStatus.Success, current);
}
private static string CleanUserGroupNameOrAliasForXss(string input)
=> input.CleanForXss('[', ']', '(', ')', ':');
private async Task<Attempt<IEnumerable<string>, UserGroupOperationStatus>> MapLanguageIdsToIsoCodeAsync(IEnumerable<int> ids)
{
IEnumerable<ILanguage> languages = await _languageService.GetAllAsync();

1
src/Umbraco.Cms.Api.Management/Mapping/Item/ItemTypeMapDefinition.cs
View File

@@ -112,6 +112,7 @@ public class ItemTypeMapDefinition : IMapDefinition
target.Id = source.Key;
target.Name = source.Name ?? source.Alias;
target.Icon = source.Icon;
target.Alias = source.Alias;
}
// Umbraco.Code.MapAll

21
src/Umbraco.Cms.Api.Management/OpenApi.json
View File

@@ -34131,6 +34131,7 @@
},
"CreateUserGroupRequestModel": {
"required": [
"alias",
"documentRootAccess",
"fallbackPermissions",
"hasAccessToAllLanguages",
@@ -34145,6 +34146,9 @@
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
@@ -34206,6 +34210,11 @@
}
]
}
},
"id": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
@@ -43105,6 +43114,7 @@
},
"UpdateUserGroupRequestModel": {
"required": [
"alias",
"documentRootAccess",
"fallbackPermissions",
"hasAccessToAllLanguages",
@@ -43119,6 +43129,9 @@
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true
@@ -43432,12 +43445,17 @@
"icon": {
"type": "string",
"nullable": true
},
"alias": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserGroupResponseModel": {
"required": [
"alias",
"documentRootAccess",
"fallbackPermissions",
"hasAccessToAllLanguages",
@@ -43454,6 +43472,9 @@
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"icon": {
"type": "string",
"nullable": true

2
src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/CreateUserGroupRequestModel.cs
View File

@@ -2,5 +2,5 @@
public class CreateUserGroupRequestModel : UserGroupBase
{
public Guid? Id { get; set; }
}

2
src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/Item/UserGroupItemResponseModel.cs
View File

@@ -5,4 +5,6 @@ namespace Umbraco.Cms.Api.Management.ViewModels.UserGroup.Item;
public class UserGroupItemResponseModel : NamedItemResponseModelBase
{
public string? Icon { get; set; }
public string? Alias { get; set; }
}

5
src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/UserGroupBase.cs
View File

@@ -17,6 +17,11 @@ public class UserGroupBase
/// </summary>
public required string Name { get; init; }
/// <summary>
/// The alias of the user groups
/// </summary>
public required string Alias { get; init; }
/// <summary>
/// The Icon for the user group
/// </summary>

7
src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/UserGroupResponseModel.cs
View File

@@ -10,5 +10,10 @@ public class UserGroupResponseModel : UserGroupBase
/// <summary>
/// Whether this user group is required at system level (thus cannot be removed)
/// </summary>
public bool IsSystemGroup { get; set; }
public bool IsDeletable { get; set; }
/// <summary>
/// Whether this user group is required at system level (thus alias needs to be fixed)
/// </summary>
public bool AliasCanBeChanged { get; set; }
}

3
src/Umbraco.Core/Services/OperationStatus/UserGroupOperationStatus.cs
View File

@@ -8,7 +8,8 @@ public enum UserGroupOperationStatus
AlreadyExists,
DuplicateAlias,
MissingUser,
IsSystemUserGroup,
CanNotDeleteIsSystemUserGroup,
CanNotUpdateAliasIsSystemUserGroup,
CancelledByNotification,
MediaStartNodeKeyNotFound,
DocumentStartNodeKeyNotFound,

12
src/Umbraco.Core/Services/UserGroupService.cs
View File

@@ -263,7 +263,7 @@ internal sealed class UserGroupService : RepositoryService, IUserGroupService
if (userGroup.IsSystemUserGroup())
{
return Attempt.Fail(UserGroupOperationStatus.IsSystemUserGroup);
return Attempt.Fail(UserGroupOperationStatus.CanNotDeleteIsSystemUserGroup);
}
return Attempt.Succeed(UserGroupOperationStatus.Success);
@@ -520,12 +520,18 @@ internal sealed class UserGroupService : RepositoryService, IUserGroupService
return UserGroupOperationStatus.NotFound;
}
IUserGroup? existing = _userGroupRepository.Get(userGroup.Alias);
if (existing is not null && existing.Key != userGroup.Key)
IUserGroup? existingByAlias = _userGroupRepository.Get(userGroup.Alias);
if (existingByAlias is not null && existingByAlias.Key != userGroup.Key)
{
return UserGroupOperationStatus.DuplicateAlias;
}
IUserGroup? existingByKey = await GetAsync(userGroup.Key);
if (existingByKey is not null && existingByKey.IsSystemUserGroup() && existingByKey.Alias != userGroup.Alias)
{
return UserGroupOperationStatus.CanNotUpdateAliasIsSystemUserGroup;
}
return UserGroupOperationStatus.Success;
}