From 205106b566d48da12c81d9f5cd975a32d8ddcafa Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 22 Sep 2023 01:01:35 -0700 Subject: [PATCH] Support edit permissions for mail rules and accounts --- src-ui/messages.xlf | 184 ++++++++++-------- .../mail-rule-edit-dialog.component.html | 6 +- .../permissions-dialog.component.html | 2 +- .../permissions-dialog.component.spec.ts | 18 +- .../permissions-dialog.component.ts | 22 ++- .../manage/settings/settings.component.html | 2 + .../settings/settings.component.spec.ts | 75 ++++++- .../manage/settings/settings.component.ts | 72 +++++-- 8 files changed, 273 insertions(+), 108 deletions(-) diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index 17261149c..198c2c9c1 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -723,7 +723,7 @@ src/app/components/manage/settings/settings.component.ts - 691 + 696 @@ -914,15 +914,15 @@ src/app/components/manage/settings/settings.component.html - 370 + 371 src/app/components/manage/settings/settings.component.html - 421 + 423 src/app/components/manage/settings/settings.component.html - 455 + 457 src/app/components/manage/tasks/tasks.component.html @@ -1081,7 +1081,7 @@ src/app/components/manage/settings/settings.component.html - 491 + 493 @@ -1116,14 +1116,14 @@ Create new item src/app/components/common/edit-dialog/edit-dialog.component.ts - 101 + 109 Edit item src/app/components/common/edit-dialog/edit-dialog.component.ts - 105 + 113 @@ -1172,6 +1172,14 @@ src/app/components/manage/settings/settings.component.html 135 + + src/app/components/manage/settings/settings.component.html + 346 + + + src/app/components/manage/settings/settings.component.html + 384 + Create new user group @@ -1220,7 +1228,7 @@ src/app/components/manage/settings/settings.component.html - 420 + 422 @@ -1307,11 +1315,11 @@ src/app/components/manage/settings/settings.component.html - 396 + 398 src/app/components/manage/settings/settings.component.html - 482 + 484 src/app/components/manage/tasks/tasks.component.html @@ -1386,7 +1394,7 @@ src/app/components/manage/settings/settings.component.html - 371 + 372 @@ -1647,19 +1655,19 @@ src/app/components/manage/settings/settings.component.html - 346 + 347 src/app/components/manage/settings/settings.component.html - 383 + 385 src/app/components/manage/settings/settings.component.html - 435 + 437 src/app/components/manage/settings/settings.component.html - 470 + 472 @@ -1881,11 +1889,11 @@ src/app/components/manage/settings/settings.component.html - 422 + 424 src/app/components/manage/settings/settings.component.html - 443 + 445 @@ -2135,15 +2143,15 @@ src/app/components/manage/settings/settings.component.html - 382 + 383 src/app/components/manage/settings/settings.component.html - 434 + 436 src/app/components/manage/settings/settings.component.html - 469 + 471 @@ -2198,18 +2206,25 @@ 35 - - Set Permissions + + Set permissions src/app/components/common/permissions-dialog/permissions-dialog.component.ts 26 + + Edit permissions for + + src/app/components/common/permissions-dialog/permissions-dialog.component.ts + 30 + + Note that permissions set here will override any existing permissions src/app/components/common/permissions-dialog/permissions-dialog.component.ts - 43 + 55 @@ -2241,7 +2256,7 @@ src/app/components/manage/settings/settings.component.html - 408 + 410 @@ -2778,15 +2793,15 @@ src/app/components/manage/settings/settings.component.html - 372 + 373 src/app/components/manage/settings/settings.component.html - 423 + 425 src/app/components/manage/settings/settings.component.html - 458 + 460 src/app/components/manage/tasks/tasks.component.html @@ -3183,19 +3198,19 @@ src/app/components/manage/settings/settings.component.ts - 796 + 801 src/app/components/manage/settings/settings.component.ts - 848 + 853 src/app/components/manage/settings/settings.component.ts - 907 + 912 src/app/components/manage/settings/settings.component.ts - 965 + 970 @@ -3210,19 +3225,19 @@ src/app/components/manage/settings/settings.component.ts - 798 + 803 src/app/components/manage/settings/settings.component.ts - 850 + 855 src/app/components/manage/settings/settings.component.ts - 909 + 914 src/app/components/manage/settings/settings.component.ts - 967 + 972 @@ -4345,6 +4360,10 @@ src/app/components/manage/management-list/management-list.component.ts 300 + + src/app/components/manage/settings/settings.component.ts + 1010 + Start tour @@ -4707,308 +4726,315 @@ No mail accounts defined. src/app/components/manage/settings/settings.component.html - 352 + 353 Mail rules src/app/components/manage/settings/settings.component.html - 358 + 359 Add Rule src/app/components/manage/settings/settings.component.html - 363 + 364 No mail rules defined. src/app/components/manage/settings/settings.component.html - 389 + 391 Users & Groups src/app/components/manage/settings/settings.component.html - 403 + 405 Add User src/app/components/manage/settings/settings.component.html - 413 + 415 Add Group src/app/components/manage/settings/settings.component.html - 448 + 450 Error retrieving groups src/app/components/manage/settings/settings.component.ts - 299 + 304 Error retrieving mail rules src/app/components/manage/settings/settings.component.ts - 325 + 328 Error retrieving mail accounts src/app/components/manage/settings/settings.component.ts - 333 + 336 Error retrieving users src/app/components/manage/settings/settings.component.ts - 350 + 354 Saved view "" deleted. src/app/components/manage/settings/settings.component.ts - 553 + 558 Settings saved src/app/components/manage/settings/settings.component.ts - 675 + 680 Settings were saved successfully. src/app/components/manage/settings/settings.component.ts - 676 + 681 Settings were saved successfully. Reload is required to apply some changes. src/app/components/manage/settings/settings.component.ts - 680 + 685 Reload now src/app/components/manage/settings/settings.component.ts - 681 + 686 Use system language src/app/components/manage/settings/settings.component.ts - 699 + 704 Use date format of display language src/app/components/manage/settings/settings.component.ts - 706 + 711 Error while storing settings on server. src/app/components/manage/settings/settings.component.ts - 726 + 731 Password has been changed, you will be logged out momentarily. src/app/components/manage/settings/settings.component.ts - 768 + 773 Saved user "". src/app/components/manage/settings/settings.component.ts - 775 + 780 Error saving user. src/app/components/manage/settings/settings.component.ts - 786 + 791 Confirm delete user account src/app/components/manage/settings/settings.component.ts - 794 + 799 This operation will permanently delete this user account. src/app/components/manage/settings/settings.component.ts - 795 + 800 Deleted user src/app/components/manage/settings/settings.component.ts - 804 + 809 Error deleting user. src/app/components/manage/settings/settings.component.ts - 811 + 816 Saved group "". src/app/components/manage/settings/settings.component.ts - 829 + 834 Error saving group. src/app/components/manage/settings/settings.component.ts - 838 + 843 Confirm delete user group src/app/components/manage/settings/settings.component.ts - 846 + 851 This operation will permanently delete this user group. src/app/components/manage/settings/settings.component.ts - 847 + 852 Deleted group src/app/components/manage/settings/settings.component.ts - 856 + 861 Error deleting group. src/app/components/manage/settings/settings.component.ts - 863 + 868 Saved account "". src/app/components/manage/settings/settings.component.ts - 886 + 891 Error saving account. src/app/components/manage/settings/settings.component.ts - 897 + 902 Confirm delete mail account src/app/components/manage/settings/settings.component.ts - 905 + 910 This operation will permanently delete this mail account. src/app/components/manage/settings/settings.component.ts - 906 + 911 Deleted mail account src/app/components/manage/settings/settings.component.ts - 915 + 920 Error deleting mail account. src/app/components/manage/settings/settings.component.ts - 924 + 929 Saved rule "". src/app/components/manage/settings/settings.component.ts - 944 + 949 Error saving rule. src/app/components/manage/settings/settings.component.ts - 955 + 960 Confirm delete mail rule src/app/components/manage/settings/settings.component.ts - 963 + 968 This operation will permanently delete this mail rule. src/app/components/manage/settings/settings.component.ts - 964 + 969 Deleted mail rule src/app/components/manage/settings/settings.component.ts - 973 + 978 Error deleting mail rule. src/app/components/manage/settings/settings.component.ts - 981 + 986 + + + + Permissions updated + + src/app/components/manage/settings/settings.component.ts + 1006 diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html index 9dcefa064..a899ac1ad 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -6,7 +6,7 @@
-
+
@@ -15,7 +15,7 @@
-
+

Paperless will only process mails that match all of the filters specified below.

@@ -23,7 +23,7 @@
-
+
diff --git a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.html b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.html index 2ed42fd62..863c9ecee 100644 --- a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.html +++ b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.html @@ -5,7 +5,7 @@
-

+

diff --git a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.spec.ts b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.spec.ts index bf9b55c95..47f245d0a 100644 --- a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.spec.ts +++ b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.spec.ts @@ -19,7 +19,7 @@ const set_permissions = { users: [1], groups: [], }, - edit: { + change: { users: [1], groups: [], }, @@ -78,6 +78,10 @@ describe('PermissionsDialogComponent', () => { }) it('should return permissions', () => { + expect(component.permissions).toEqual({ + owner: null, + set_permissions: null, + }) component.form.get('permissions_form').setValue(set_permissions) expect(component.permissions).toEqual(set_permissions) }) @@ -87,4 +91,16 @@ describe('PermissionsDialogComponent', () => { component.cancelClicked() expect(closeSpy).toHaveBeenCalled() }) + + it('should support edit permissions on object', () => { + let obj = { + id: 1, + name: 'account1', + owner: set_permissions.owner, + permissions: set_permissions.set_permissions, + } + component.object = obj + expect(component.title).toEqual(`Edit permissions for ${obj.name}`) + expect(component.permissions).toEqual(set_permissions) + }) }) diff --git a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.ts b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.ts index f1b922175..2bdc8d49d 100644 --- a/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.ts +++ b/src-ui/src/app/components/common/permissions-dialog/permissions-dialog.component.ts @@ -1,6 +1,7 @@ import { Component, EventEmitter, Input, Output } from '@angular/core' import { FormControl, FormGroup } from '@angular/forms' import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { ObjectWithPermissions } from 'src/app/data/object-with-permissions' import { PaperlessUser } from 'src/app/data/paperless-user' import { UserService } from 'src/app/services/rest/user.service' @@ -11,6 +12,7 @@ import { UserService } from 'src/app/services/rest/user.service' }) export class PermissionsDialogComponent { users: PaperlessUser[] + private o: ObjectWithPermissions = undefined constructor( public activeModal: NgbActiveModal, @@ -19,11 +21,24 @@ export class PermissionsDialogComponent { this.userService.listAll().subscribe((r) => (this.users = r.results)) } - @Output() public confirmClicked = new EventEmitter() - @Input() - title = $localize`Set Permissions` + title = $localize`Set permissions` + + set object(o: ObjectWithPermissions) { + this.o = o + this.title = $localize`Edit permissions for ` + o['name'] + this.form.patchValue({ + permissions_form: { + owner: o.owner, + set_permissions: o.permissions, + }, + }) + } + + get object(): ObjectWithPermissions { + return this.o + } form = new FormGroup({ permissions_form: new FormControl(), @@ -39,7 +54,6 @@ export class PermissionsDialogComponent { } } - @Input() message = $localize`Note that permissions set here will override any existing permissions` cancelClicked() { diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index cc5e7a15e..bdf30f8d9 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -343,6 +343,7 @@
+
@@ -380,6 +381,7 @@
+
diff --git a/src-ui/src/app/components/manage/settings/settings.component.spec.ts b/src-ui/src/app/components/manage/settings/settings.component.spec.ts index 1bcbe37f8..929182da8 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.spec.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.spec.ts @@ -52,6 +52,9 @@ import { TagsComponent } from '../../common/input/tags/tags.component' import { TextComponent } from '../../common/input/text/text.component' import { PageHeaderComponent } from '../../common/page-header/page-header.component' import { SettingsComponent } from './settings.component' +import { PermissionsDialogComponent } from '../../common/permissions-dialog/permissions-dialog.component' +import { PermissionsFormComponent } from '../../common/input/permissions/permissions-form/permissions-form.component' +import { IfOwnerDirective } from 'src/app/directives/if-owner.directive' const savedViews = [ { id: 1, name: 'view1' }, @@ -70,8 +73,8 @@ const mailAccounts = [ { id: 2, name: 'account2' }, ] const mailRules = [ - { id: 1, name: 'rule1', owner: 1 }, - { id: 2, name: 'rule2', owner: 2 }, + { id: 1, name: 'rule1', owner: 1, account: 1 }, + { id: 2, name: 'rule2', owner: 2, account: 2 }, ] describe('SettingsComponent', () => { @@ -110,6 +113,9 @@ describe('SettingsComponent', () => { MailRuleEditDialogComponent, PermissionsUserComponent, PermissionsGroupComponent, + IfOwnerDirective, + PermissionsDialogComponent, + PermissionsFormComponent, ], providers: [CustomDatePipe, DatePipe, PermissionsGuard], imports: [ @@ -591,4 +597,69 @@ describe('SettingsComponent', () => { expect(listAllSpy).toHaveBeenCalled() expect(toastInfoSpy).toHaveBeenCalledWith('Deleted mail rule') }) + + it('should support edit permissions on mail rule objects', () => { + completeSetup() + const perms = { + owner: 99, + set_permissions: { + view: { + users: [1], + groups: [2], + }, + change: { + users: [3], + groups: [4], + }, + }, + } + let modal: NgbModalRef + modalService.activeInstances.subscribe((refs) => (modal = refs[0])) + const toastErrorSpy = jest.spyOn(toastService, 'showError') + const toastInfoSpy = jest.spyOn(toastService, 'showInfo') + const rulePatchSpy = jest.spyOn(mailRuleService, 'patch') + component.editPermissions(mailRules[0] as PaperlessMailRule) + expect(modal).not.toBeUndefined() + let dialog = modal.componentInstance as PermissionsDialogComponent + expect(dialog.object).toEqual(mailRules[0]) + + rulePatchSpy.mockReturnValueOnce( + throwError(() => new Error('error saving perms')) + ) + dialog.confirmClicked.emit(perms) + expect(rulePatchSpy).toHaveBeenCalled() + expect(toastErrorSpy).toHaveBeenCalled() + rulePatchSpy.mockReturnValueOnce(of(mailRules[0] as PaperlessMailRule)) + dialog.confirmClicked.emit(perms) + expect(toastInfoSpy).toHaveBeenCalledWith('Permissions updated') + + modalService.dismissAll() + }) + + it('should support edit permissions on mail account objects', () => { + completeSetup() + const perms = { + owner: 99, + set_permissions: { + view: { + users: [1], + groups: [2], + }, + change: { + users: [3], + groups: [4], + }, + }, + } + let modal: NgbModalRef + modalService.activeInstances.subscribe((refs) => (modal = refs[0])) + const accountPatchSpy = jest.spyOn(mailAccountService, 'patch') + component.editPermissions(mailAccounts[0] as PaperlessMailAccount) + expect(modal).not.toBeUndefined() + let dialog = modal.componentInstance as PermissionsDialogComponent + expect(dialog.object).toEqual(mailAccounts[0]) + dialog = modal.componentInstance as PermissionsDialogComponent + dialog.confirmClicked.emit(perms) + expect(accountPatchSpy).toHaveBeenCalled() + }) }) 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 daf4a6665..9c7586007 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -51,6 +51,8 @@ import { PermissionType, PermissionsService, } from 'src/app/services/permissions.service' +import { PermissionsDialogComponent } from '../../common/permissions-dialog/permissions-dialog.component' +import { AbstractPaperlessService } from 'src/app/services/rest/abstract-paperless-service' enum SettingsNavIDs { General = 1, @@ -307,14 +309,14 @@ export class SettingsComponent (!this.mailAccounts || !this.mailRules) ) { this.mailAccountService - .listAll() + .listAll(null, null, { full_perms: true }) .pipe(first()) .subscribe({ next: (r) => { this.mailAccounts = r.results this.mailRuleService - .listAll() + .listAll(null, null, { full_perms: true }) .pipe(first()) .subscribe({ next: (r) => { @@ -889,10 +891,12 @@ export class SettingsComponent $localize`Saved account "${newMailAccount.name}".` ) this.mailAccountService.clearCache() - this.mailAccountService.listAll().subscribe((r) => { - this.mailAccounts = r.results - this.initialize() - }) + this.mailAccountService + .listAll(null, null, { full_perms: true }) + .subscribe((r) => { + this.mailAccounts = r.results + this.initialize() + }) }) modal.componentInstance.failed .pipe(takeUntil(this.unsubscribeNotifier)) @@ -917,10 +921,12 @@ export class SettingsComponent modal.close() this.toastService.showInfo($localize`Deleted mail account`) this.mailAccountService.clearCache() - this.mailAccountService.listAll().subscribe((r) => { - this.mailAccounts = r.results - this.initialize(true) - }) + this.mailAccountService + .listAll(null, null, { full_perms: true }) + .subscribe((r) => { + this.mailAccounts = r.results + this.initialize(true) + }) }, error: (e) => { this.toastService.showError( @@ -946,11 +952,13 @@ export class SettingsComponent .subscribe((newMailRule) => { this.toastService.showInfo($localize`Saved rule "${newMailRule.name}".`) this.mailRuleService.clearCache() - this.mailRuleService.listAll().subscribe((r) => { - this.mailRules = r.results + this.mailRuleService + .listAll(null, null, { full_perms: true }) + .subscribe((r) => { + this.mailRules = r.results - this.initialize(true) - }) + this.initialize(true) + }) }) modal.componentInstance.failed .pipe(takeUntil(this.unsubscribeNotifier)) @@ -975,10 +983,12 @@ export class SettingsComponent modal.close() this.toastService.showInfo($localize`Deleted mail rule`) this.mailRuleService.clearCache() - this.mailRuleService.listAll().subscribe((r) => { - this.mailRules = r.results - this.initialize(true) - }) + this.mailRuleService + .listAll(null, null, { full_perms: true }) + .subscribe((r) => { + this.mailRules = r.results + this.initialize(true) + }) }, error: (e) => { this.toastService.showError($localize`Error deleting mail rule.`, e) @@ -986,4 +996,30 @@ export class SettingsComponent }) }) } + + editPermissions(object: PaperlessMailRule | PaperlessMailAccount) { + const modal = this.modalService.open(PermissionsDialogComponent, { + backdrop: 'static', + }) + const dialog: PermissionsDialogComponent = + modal.componentInstance as PermissionsDialogComponent + dialog.object = object + modal.componentInstance.confirmClicked.subscribe((permissions) => { + modal.componentInstance.buttonsEnabled = false + const service: AbstractPaperlessService< + PaperlessMailRule | PaperlessMailAccount + > = 'account' in object ? this.mailRuleService : this.mailAccountService + object.owner = permissions['owner'] + object['set_permissions'] = permissions['set_permissions'] + service.patch(object).subscribe({ + next: () => { + this.toastService.showInfo($localize`Permissions updated`) + modal.close() + }, + error: (e) => { + this.toastService.showError($localize`Error updating permissions`, e) + }, + }) + }) + } }