From f461485aa0a06071b31101cfe32cb829f78d5a81 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 13 Nov 2022 22:58:07 -0800 Subject: [PATCH] frontend permissions dialogs --- src-ui/src/app/app-routing.module.ts | 2 +- .../app-frame/app-frame.component.html | 2 +- .../group-edit-dialog.component.html | 2 +- .../group-edit-dialog.component.ts | 2 +- .../user-edit-dialog.component.html | 20 +++--- .../user-edit-dialog.component.ts | 8 +-- .../permissions-select.component.html | 27 ++++--- .../permissions-select.component.ts | 71 ++++++++++++++++--- .../manage/settings/settings.component.ts | 36 ++++++++-- src-ui/src/app/data/paperless-user.ts | 2 +- .../src/app/services/permissions.service.ts | 29 ++++---- src/documents/views.py | 2 +- src/paperless/serialisers.py | 43 +++++------ 13 files changed, 164 insertions(+), 82 deletions(-) diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index 211afc6ac..1627fc72d 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -127,7 +127,7 @@ const routes: Routes = [ data: { requiredPermission: { action: PermissionAction.View, - type: PermissionType.Log, + type: PermissionType.Admin, }, }, }, diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index ab8b7f2a5..55dfc9890 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -163,7 +163,7 @@  File Tasks{{tasksService.failedFileTasks.length}} -
  • +
  • diff --git a/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.html index 610a254b1..97124a05f 100644 --- a/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.html @@ -8,7 +8,7 @@
    - +
    diff --git a/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.ts index 30b1cf684..db58b3930 100644 --- a/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/group-edit-dialog/group-edit-dialog.component.ts @@ -26,7 +26,7 @@ export class GroupEditDialogComponent extends EditDialogComponent -
    - - +
    +
    + + +
    +
    + + +
    -
    - - -
    +
    - - +
    diff --git a/src-ui/src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.ts index c136da2a3..c56002305 100644 --- a/src-ui/src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/user-edit-dialog/user-edit-dialog.component.ts @@ -42,10 +42,10 @@ export class UserEditDialogComponent extends EditDialogComponent username: new FormControl(''), first_name: new FormControl(''), last_name: new FormControl(''), - is_active: new FormControl(''), - is_superuser: new FormControl(''), - groups: new FormControl(''), - permissions: new FormControl(''), + is_active: new FormControl(null), + is_superuser: new FormControl(null), + groups: new FormControl(null), + user_permissions: new FormControl(null), }) } } diff --git a/src-ui/src/app/components/common/permissions-select/permissions-select.component.html b/src-ui/src/app/components/common/permissions-select/permissions-select.component.html index 93c326eae..0261f574c 100644 --- a/src-ui/src/app/components/common/permissions-select/permissions-select.component.html +++ b/src-ui/src/app/components/common/permissions-select/permissions-select.component.html @@ -1,18 +1,27 @@
    - +
      -
    • - {{type.key}}: +
    • +
      Type
      +
      All
      +
      Add
      +
      Change
      +
      Delete
      +
      View
      +
      • +
    • +
      {{type.key}}:
      -
      - - +
      + +
      -
      - - +
      + +
      • +
      {{error}}
    diff --git a/src-ui/src/app/components/common/permissions-select/permissions-select.component.ts b/src-ui/src/app/components/common/permissions-select/permissions-select.component.ts index 1aa9f3f81..9e03bbb5d 100644 --- a/src-ui/src/app/components/common/permissions-select/permissions-select.component.ts +++ b/src-ui/src/app/components/common/permissions-select/permissions-select.component.ts @@ -10,7 +10,6 @@ import { PermissionsService, PermissionType, } from 'src/app/services/permissions.service' -import { AbstractInputComponent } from '../input/abstract-input' @Component({ providers: [ @@ -33,14 +32,18 @@ export class PermissionsSelectComponent @Input() title: string = 'Permissions' + @Input() + error: string + permissions: string[] form = new FormGroup({}) + typesWithAllActions: Set = new Set() + constructor(private readonly permissionsService: PermissionsService) { for (const type in PermissionType) { const control = new FormGroup({}) - control.addControl('all', new FormControl(null)) for (const action in PermissionAction) { control.addControl(action, new FormControl(null)) } @@ -50,7 +53,7 @@ export class PermissionsSelectComponent writeValue(permissions: string[]): void { this.permissions = permissions - this.permissions.forEach((permissionStr) => { + this.permissions?.forEach((permissionStr) => { const { actionKey, typeKey } = this.permissionsService.getPermissionKeys(permissionStr) @@ -60,20 +63,70 @@ export class PermissionsSelectComponent } } }) + Object.keys(PermissionType).forEach((type) => { + if (Object.values(this.form.get(type).value).every((val) => val)) { + this.typesWithAllActions.add(type) + } else { + this.typesWithAllActions.delete(type) + } + }) } + + onChange = (newValue: string[]) => {} + + onTouched = () => {} + + disabled: boolean = false + registerOnChange(fn: any): void { - throw new Error('Method not implemented.') + this.onChange = fn } + registerOnTouched(fn: any): void { - throw new Error('Method not implemented.') + this.onTouched = fn } + setDisabledState?(isDisabled: boolean): void { - throw new Error('Method not implemented.') + this.disabled = isDisabled } - ngOnInit(): void {} + ngOnInit(): void { + this.form.valueChanges.subscribe((newValue) => { + let permissions = [] + Object.entries(newValue).forEach(([typeKey, typeValue]) => { + // e.g. [Document, { Add: true, View: true ... }] + const selectedActions = Object.entries(typeValue).filter( + ([actionKey, actionValue]) => actionValue + ) - isAll(key: string): boolean { - return this.form.get(key).get('all').value == true + selectedActions.forEach(([actionKey, actionValue]) => { + permissions.push( + (PermissionType[typeKey] as string).replace( + '%s', + PermissionAction[actionKey] + ) + ) + }) + + if (selectedActions.length == Object.entries(typeValue).length) { + this.typesWithAllActions.add(typeKey) + } else { + this.typesWithAllActions.delete(typeKey) + } + }) + this.onChange(permissions) + }) + } + + toggleAll(event, type) { + const typeGroup = this.form.get(type) + if (event.target.checked) { + Object.keys(PermissionAction).forEach((action) => { + typeGroup.get(action).patchValue(true) + }) + this.typesWithAllActions.add(type) + } else { + this.typesWithAllActions.delete(type) + } } } diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index b1cb33baf..ee7309121 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -245,7 +245,7 @@ export class SettingsComponent is_active: user.is_active, is_superuser: user.is_superuser, groups: user.groups, - permissions: user.permissions, + user_permissions: user.user_permissions, } this.usersGroup.addControl( user.id.toString(), @@ -257,7 +257,7 @@ export class SettingsComponent is_active: new FormControl(null), is_superuser: new FormControl(null), groups: new FormControl(null), - permissions: new FormControl(null), + user_permissions: new FormControl(null), }) ) } @@ -514,7 +514,21 @@ export class SettingsComponent modal.componentInstance.btnCaption = $localize`Proceed` modal.componentInstance.confirmClicked.subscribe(() => { modal.componentInstance.buttonsEnabled = false - this.usersService.delete(user) + this.usersService.delete(user).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted user`) + this.usersService.listAll().subscribe((r) => { + this.users = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting user: ${e.toString()}.` + ) + }, + }) }) } @@ -554,7 +568,21 @@ export class SettingsComponent modal.componentInstance.btnCaption = $localize`Proceed` modal.componentInstance.confirmClicked.subscribe(() => { modal.componentInstance.buttonsEnabled = false - this.groupsService.delete(group) + this.groupsService.delete(group).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted group`) + this.groupsService.listAll().subscribe((r) => { + this.groups = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting group: ${e.toString()}.` + ) + }, + }) }) } } diff --git a/src-ui/src/app/data/paperless-user.ts b/src-ui/src/app/data/paperless-user.ts index e4d3e86da..125a2f509 100644 --- a/src-ui/src/app/data/paperless-user.ts +++ b/src-ui/src/app/data/paperless-user.ts @@ -10,6 +10,6 @@ export interface PaperlessUser extends ObjectWithId { is_active?: boolean is_superuser?: boolean groups?: PaperlessGroup[] - permissions?: string[] + user_permissions?: string[] inherited_permissions?: string[] } diff --git a/src-ui/src/app/services/permissions.service.ts b/src-ui/src/app/services/permissions.service.ts index 23fbb47ca..9c9b3e73c 100644 --- a/src-ui/src/app/services/permissions.service.ts +++ b/src-ui/src/app/services/permissions.service.ts @@ -8,20 +8,19 @@ export enum PermissionAction { } export enum PermissionType { - Document = 'documents.%s_document', - Tag = 'documents.%s_tag', - Correspondent = 'documents.%s_correspondent', - DocumentType = 'documents.%s_documenttype', - StoragePath = 'documents.%s_storagepath', - SavedView = 'documents.%s_savedview', - PaperlessTask = 'documents.%s_paperlesstask', - UISettings = 'documents.%s_uisettings', - Comment = 'documents.%s_comment', - Log = 'admin.%s_logentry', - MailAccount = 'paperless_mail.%s_mailaccount', - MailRule = 'paperless_mail.%s_mailrule', - User = 'auth.%s_user', - Admin = 'admin.%s_logentry', + Document = '%s_document', + Tag = '%s_tag', + Correspondent = '%s_correspondent', + DocumentType = '%s_documenttype', + StoragePath = '%s_storagepath', + SavedView = '%s_savedview', + PaperlessTask = '%s_paperlesstask', + UISettings = '%s_uisettings', + Comment = '%s_comment', + MailAccount = '%s_mailaccount', + MailRule = '%s_mailrule', + User = '%s_user', + Admin = '%s_logentry', } export interface PaperlessPermission { @@ -51,7 +50,7 @@ export class PermissionsService { actionKey: string typeKey: string } { - const matches = permissionStr.match(/\.(.+)_/) + const matches = permissionStr.match(/(.+)_/) let typeKey let actionKey if (matches?.length > 0) { diff --git a/src/documents/views.py b/src/documents/views.py index a59afadb7..dd960cbcf 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -856,7 +856,7 @@ class UiSettingsView(GenericAPIView): ui_settings["update_checking"] = { "backend_setting": settings.ENABLE_UPDATE_CHECK, } - roles = user.get_all_permissions() + roles = user.user_permissions.values_list("codename", flat=True) return Response( { "user_id": user.id, diff --git a/src/paperless/serialisers.py b/src/paperless/serialisers.py index af0dbe8ad..1e677f6f4 100644 --- a/src/paperless/serialisers.py +++ b/src/paperless/serialisers.py @@ -1,12 +1,21 @@ from django.contrib.auth.models import Group +from django.contrib.auth.models import Permission from django.contrib.auth.models import User from rest_framework import serializers class UserSerializer(serializers.ModelSerializer): - groups = serializers.SerializerMethodField() - permissions = serializers.SerializerMethodField() + groups = serializers.SlugRelatedField( + many=True, + queryset=Group.objects.all(), + slug_field="name", + ) + user_permissions = serializers.SlugRelatedField( + many=True, + queryset=Permission.objects.all(), + slug_field="codename", + ) inherited_permissions = serializers.SerializerMethodField() class Meta: @@ -21,30 +30,21 @@ class UserSerializer(serializers.ModelSerializer): "is_active", "is_superuser", "groups", - "permissions", + "user_permissions", "inherited_permissions", ) - def get_groups(self, obj): - return list(obj.groups.values_list("name", flat=True)) - - def get_permissions(self, obj): - # obj.get_user_permissions() returns more permissions than desired - permission_natural_keys = [] - permissions = obj.user_permissions.all() - for permission in permissions: - permission_natural_keys.append( - permission.natural_key()[1] + "." + permission.natural_key()[0], - ) - return permission_natural_keys - def get_inherited_permissions(self, obj): return obj.get_group_permissions() class GroupSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() + permissions = serializers.SlugRelatedField( + many=True, + queryset=Permission.objects.all(), + slug_field="codename", + ) class Meta: model = Group @@ -53,12 +53,3 @@ class GroupSerializer(serializers.ModelSerializer): "name", "permissions", ) - - def get_permissions(self, obj): - permission_natural_keys = [] - permissions = obj.permissions.all() - for permission in permissions: - permission_natural_keys.append( - permission.natural_key()[1] + "." + permission.natural_key()[0], - ) - return permission_natural_keys