From e4f69dc9456c419f659c5813fc4e9436578f3a88 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 9 Dec 2024 09:35:49 -0800 Subject: [PATCH] Feature: bulk edit custom field values (#8428) --- docs/api.md | 5 + src-ui/messages.xlf | 192 +++++++++++------- src-ui/src/app/app.module.ts | 2 + .../filterable-dropdown.component.html | 8 +- .../filterable-dropdown.component.spec.ts | 20 ++ .../filterable-dropdown.component.ts | 45 ++-- .../dashboard/dashboard.component.html | 2 +- .../bulk-editor/bulk-editor.component.html | 3 + .../bulk-editor/bulk-editor.component.spec.ts | 51 +++++ .../bulk-editor/bulk-editor.component.ts | 35 ++++ ...tom-fields-bulk-edit-dialog.component.html | 81 ++++++++ ...tom-fields-bulk-edit-dialog.component.scss | 0 ...-fields-bulk-edit-dialog.component.spec.ts | 89 ++++++++ ...ustom-fields-bulk-edit-dialog.component.ts | 90 ++++++++ src/documents/bulk_edit.py | 26 ++- src/documents/serialisers.py | 38 +++- src/documents/tests/test_api_bulk_edit.py | 46 ++++- src/documents/tests/test_bulk_edit.py | 81 ++++++++ 18 files changed, 709 insertions(+), 105 deletions(-) create mode 100644 src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html create mode 100644 src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.scss create mode 100644 src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.spec.ts create mode 100644 src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.ts diff --git a/docs/api.md b/docs/api.md index c5f20edd1..8b755b11d 100644 --- a/docs/api.md +++ b/docs/api.md @@ -473,6 +473,11 @@ The following methods are supported: - Requires `parameters`: - `"pages": [..]` The list should be a list of integers e.g. `"[2,3,4]"` - The delete_pages operation only accepts a single document. +- `modify_custom_fields` + - Requires `parameters`: + - `"add_custom_fields": { CUSTOM_FIELD_ID: VALUE }`: JSON object consisting of custom field id:value pairs to add to the document, can also be a list of custom field IDs + to add with empty values. + - `"remove_custom_fields": [CUSTOM_FIELD_ID]`: custom field ids to remove from the document. ### Objects diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index be1b9d7f2..e19a67b28 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -594,6 +594,10 @@ src/app/components/document-detail/document-detail.component.html 341 + + src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html + 79 + src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html 21 @@ -1161,7 +1165,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 101 + 104 src/app/components/document-list/filter-editor/filter-editor.component.html @@ -1450,6 +1454,10 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html 4 + + src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html + 77 + src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html 20 @@ -1756,7 +1764,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 107 + 110 src/app/components/manage/custom-fields/custom-fields.component.html @@ -2049,7 +2057,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 161 + 164 src/app/components/manage/custom-fields/custom-fields.component.html @@ -2520,15 +2528,15 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 758 + 759 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 791 + 792 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 810 + 811 src/app/components/manage/custom-fields/custom-fields.component.ts @@ -2927,7 +2935,7 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 143 + 147 @@ -2953,7 +2961,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 133 + 136 src/app/components/document-list/document-card-large/document-card-large.component.html @@ -2961,7 +2969,7 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 149 + 153 @@ -3114,27 +3122,27 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 401 + 402 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 441 + 442 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 479 + 480 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 517 + 518 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 579 + 580 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 712 + 713 @@ -4947,7 +4955,7 @@ Click again to exclude items. src/app/components/common/filterable-dropdown/filterable-dropdown.component.html - 71 + 77 @@ -4962,7 +4970,7 @@ Open filter src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts - 488 + 494 @@ -6096,7 +6104,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 346 + 347 this string is used to separate processing, failed and added on the file upload widget @@ -6171,7 +6179,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 111 + 114 @@ -6200,7 +6208,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.html - 114 + 117 @@ -6626,7 +6634,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 714 + 715 @@ -6637,7 +6645,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 716 + 717 @@ -6648,7 +6656,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 754 + 755 @@ -6722,7 +6730,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 788 + 789 @@ -6872,64 +6880,75 @@ 83 + + Set values + + src/app/components/document-list/bulk-editor/bulk-editor.component.html + 93 + + Merge src/app/components/document-list/bulk-editor/bulk-editor.component.html - 117 + 120 Include: src/app/components/document-list/bulk-editor/bulk-editor.component.html - 139 + 142 Archived files src/app/components/document-list/bulk-editor/bulk-editor.component.html - 143 + 146 Original files src/app/components/document-list/bulk-editor/bulk-editor.component.html - 147 + 150 Use formatted filename src/app/components/document-list/bulk-editor/bulk-editor.component.html - 152 + 155 Error executing bulk operation src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 250 + 251 + + + src/app/components/document-list/bulk-editor/bulk-editor.component.ts + 859 "" src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 338 + 339 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 344 + 345 "" and "" src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 340 + 341 This is for messages like 'modify "tag1" and "tag2"' @@ -6937,7 +6956,7 @@ and "" src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 348,350 + 349,351 this is for messages like 'modify "tag1", "tag2" and "tag3"' @@ -6945,14 +6964,14 @@ Confirm tags assignment src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 365 + 366 This operation will add the tag "" to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 371 + 372 @@ -6961,14 +6980,14 @@ )"/> to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 376,378 + 377,379 This operation will remove the tag "" from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 384 + 385 @@ -6977,7 +6996,7 @@ )"/> from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 389,391 + 390,392 @@ -6988,84 +7007,84 @@ )"/> on selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 393,397 + 394,398 Confirm correspondent assignment src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 434 + 435 This operation will assign the correspondent "" to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 436 + 437 This operation will remove the correspondent from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 438 + 439 Confirm document type assignment src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 472 + 473 This operation will assign the document type "" to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 474 + 475 This operation will remove the document type from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 476 + 477 Confirm storage path assignment src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 510 + 511 This operation will assign the storage path "" to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 512 + 513 This operation will remove the storage path from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 514 + 515 Confirm custom field assignment src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 543 + 544 This operation will assign the custom field "" to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 549 + 550 @@ -7074,14 +7093,14 @@ )"/> to selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 554,556 + 555,557 This operation will remove the custom field "" from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 562 + 563 @@ -7090,7 +7109,7 @@ )"/> from selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 567,569 + 568,570 @@ -7101,56 +7120,85 @@ )"/> on selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 571,575 + 572,576 Move selected document(s) to the trash? src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 713 + 714 This operation will permanently recreate the archive files for selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 755 + 756 The archive files will be re-generated with the current settings. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 756 + 757 This operation will permanently rotate the original version of document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 789 + 790 Merge confirm src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 808 + 809 This operation will merge selected documents into a new document. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 809 + 810 Merged document will be queued for consumption. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 825 + 826 + + + + Bulk operation executed successfully + + src/app/components/document-list/bulk-editor/bulk-editor.component.ts + 849 + + + + {VAR_PLURAL, plural, =1 {Set custom fields for 1 document} other {Set custom fields for documents}} + + src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html + 3,7 + + + + Select custom fields + + src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html + 13 + + + + {VAR_PLURAL, plural, =1 {This operation will also remove 1 custom field from the selected documents.} other {This operation will also + remove custom fields from the selected documents.}} + + src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html + 69,74 @@ -7179,11 +7227,11 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 76,77 + 80,81 src/app/components/document-list/document-card-small/document-card-small.component.html - 91,92 + 95,96 @@ -7194,11 +7242,11 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 77,78 + 81,82 src/app/components/document-list/document-card-small/document-card-small.component.html - 92,93 + 96,97 @@ -7209,11 +7257,11 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 78,79 + 82,83 src/app/components/document-list/document-card-small/document-card-small.component.html - 93,94 + 97,98 @@ -7224,7 +7272,7 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 106 + 110 @@ -7235,7 +7283,7 @@ src/app/components/document-list/document-card-small/document-card-small.component.html - 125 + 129 src/app/data/document.ts @@ -7271,14 +7319,14 @@ Toggle document type filter src/app/components/document-list/document-card-small/document-card-small.component.html - 59 + 63 Toggle storage path filter src/app/components/document-list/document-card-small/document-card-small.component.html - 66 + 70 diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index 68124d541..79880c75b 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -133,6 +133,7 @@ import { DeletePagesConfirmDialogComponent } from './components/common/confirm-d import { TrashComponent } from './components/admin/trash/trash.component' import { EntriesComponent } from './components/common/input/entries/entries.component' import { SavedViewsComponent } from './components/manage/saved-views/saved-views.component' +import { CustomFieldsBulkEditDialogComponent } from './components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component' import { airplane, archive, @@ -528,6 +529,7 @@ function initializeApp(settings: SettingsService) { TrashComponent, EntriesComponent, SavedViewsComponent, + CustomFieldsBulkEditDialogComponent, ], bootstrap: [AppComponent], imports: [ diff --git a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.html b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.html index 28ce03ad6..f6888488d 100644 --- a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.html +++ b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.html @@ -60,12 +60,18 @@ } @if ((selectionModel.items | filter: filterText:'name').length > 0) { - } } + @if (extraButtonTitle) { + + } @if (!editing && manyToOne) {
Click again to exclude items. diff --git a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.spec.ts b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.spec.ts index 78af75607..2a4cce8d6 100644 --- a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.spec.ts +++ b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.spec.ts @@ -616,4 +616,24 @@ describe('FilterableDropdownComponent & FilterableDropdownSelectionModel', () => document.dispatchEvent(new KeyboardEvent('keydown', { key: 't' })) expect(openSpy).toHaveBeenCalled() }) + + it('should support an extra button and not apply changes when clicked', () => { + component.items = items + component.icon = 'tag-fill' + component.extraButtonTitle = 'Extra' + component.selectionModel = selectionModel + component.applyOnClose = true + let extraButtonClicked, + applied = false + component.extraButton.subscribe(() => (extraButtonClicked = true)) + component.apply.subscribe(() => (applied = true)) + fixture.nativeElement + .querySelector('button') + .dispatchEvent(new MouseEvent('click')) // open + fixture.detectChanges() + expect(fixture.debugElement.nativeElement.textContent).toContain('Extra') + component.extraButtonClicked() + expect(extraButtonClicked).toBeTruthy() + expect(applied).toBeFalsy() + }) }) diff --git a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts index 925e4f319..df225c7d9 100644 --- a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts +++ b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.ts @@ -437,21 +437,6 @@ export class FilterableDropdownComponent @Input() createRef: (name) => void - creating: boolean = false - - @Output() - apply = new EventEmitter() - - @Output() - opened = new EventEmitter() - - get modifierToggleEnabled(): boolean { - return this.manyToOne - ? this.selectionModel.selectionSize() > 1 && - this.selectionModel.getExcludedItems().length == 0 - : !this.selectionModel.isNoneSelected() - } - @Input() set documentCounts(counts: SelectionDataItem[]) { if (counts) { @@ -462,6 +447,27 @@ export class FilterableDropdownComponent @Input() shortcutKey: string + @Input() + extraButtonTitle: string + + creating: boolean = false + + @Output() + apply = new EventEmitter() + + @Output() + opened = new EventEmitter() + + @Output() + extraButton = new EventEmitter() + + get modifierToggleEnabled(): boolean { + return this.manyToOne + ? this.selectionModel.selectionSize() > 1 && + this.selectionModel.getExcludedItems().length == 0 + : !this.selectionModel.isNoneSelected() + } + get name(): string { return this.title ? this.title.replace(/\s/g, '_').toLowerCase() : null } @@ -641,4 +647,13 @@ export class FilterableDropdownComponent this.selectionModel.get(item.id) !== ToggleableItemState.Selected ) } + + extraButtonClicked() { + // don't apply changes when clicking the extra button + const applyOnClose = this.applyOnClose + this.applyOnClose = false + this.dropdown.close() + this.extraButton.emit(this.selectionModel.diff()) + this.applyOnClose = applyOnClose + } } diff --git a/src-ui/src/app/components/dashboard/dashboard.component.html b/src-ui/src/app/components/dashboard/dashboard.component.html index 27f19475c..5e0db4b2f 100644 --- a/src-ui/src/app/components/dashboard/dashboard.component.html +++ b/src-ui/src/app/components/dashboard/dashboard.component.html @@ -18,7 +18,7 @@
-
+
diff --git a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.html b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.html index 2b9a20f7e..242e8abab 100644 --- a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.html +++ b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.html @@ -90,6 +90,9 @@ (opened)="openCustomFieldsDropdown()" [(selectionModel)]="customFieldsSelectionModel" [documentCounts]="customFieldDocumentCounts" + extraButtonTitle="Set values" + i18n-extraButtonTitle + (extraButton)="setCustomFieldValues($event)" (apply)="setCustomFields($event)"> } diff --git a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts index 0dd056cfd..c0db41512 100644 --- a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts +++ b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts @@ -1416,4 +1416,55 @@ describe('BulkEditorComponent', () => { ) expect(component.customFields).toEqual(customFields.results) }) + + it('should open the bulk edit custom field values dialog with correct parameters', () => { + let modal: NgbModalRef + modalService.activeInstances.subscribe((m) => (modal = m[0])) + jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true) + jest + .spyOn(documentListViewService, 'documents', 'get') + .mockReturnValue([{ id: 3 }, { id: 4 }]) + jest.spyOn(documentService, 'getFew').mockReturnValue( + of({ + all: [3, 4], + count: 2, + results: [{ id: 3 }, { id: 4 }], + }) + ) + jest + .spyOn(documentListViewService, 'selected', 'get') + .mockReturnValue(new Set([3, 4])) + fixture.detectChanges() + const toastServiceShowInfoSpy = jest.spyOn(toastService, 'showInfo') + const toastServiceShowErrorSpy = jest.spyOn(toastService, 'showError') + const listReloadSpy = jest.spyOn(documentListViewService, 'reload') + + component.customFields = [ + { id: 1, name: 'Custom Field 1', data_type: CustomFieldDataType.String }, + { id: 2, name: 'Custom Field 2', data_type: CustomFieldDataType.String }, + ] + + component.setCustomFieldValues({ + itemsToAdd: [{ id: 1 }, { id: 2 }], + itemsToRemove: [1], + } as any) + + expect(modal.componentInstance.customFields).toEqual(component.customFields) + expect(modal.componentInstance.fieldsToAddIds).toEqual([1, 2]) + expect(modal.componentInstance.documents).toEqual([3, 4]) + + modal.componentInstance.failed.emit() + expect(toastServiceShowErrorSpy).toHaveBeenCalled() + expect(listReloadSpy).not.toHaveBeenCalled() + + modal.componentInstance.succeeded.emit() + expect(toastServiceShowInfoSpy).toHaveBeenCalled() + expect(listReloadSpy).toHaveBeenCalled() + httpTestingController.match( + `${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true` + ) // list reload + httpTestingController.match( + `${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id` + ) // listAllFilteredIds + }) }) diff --git a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts index 6892cc823..499f52f03 100644 --- a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts +++ b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts @@ -44,6 +44,7 @@ import { MergeConfirmDialogComponent } from '../../common/confirm-dialog/merge-c import { CustomField } from 'src/app/data/custom-field' import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service' import { CustomFieldEditDialogComponent } from '../../common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component' +import { CustomFieldsBulkEditDialogComponent } from './custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component' @Component({ selector: 'pngx-bulk-editor', @@ -826,4 +827,38 @@ export class BulkEditorComponent ) }) } + + public setCustomFieldValues(changedCustomFields: ChangedItems) { + const modal = this.modalService.open(CustomFieldsBulkEditDialogComponent, { + backdrop: 'static', + size: 'lg', + }) + const dialog = + modal.componentInstance as CustomFieldsBulkEditDialogComponent + dialog.customFields = this.customFields + dialog.fieldsToAddIds = changedCustomFields.itemsToAdd.map( + (item) => item.id + ) + dialog.fieldsToRemoveIds = changedCustomFields.itemsToRemove.map( + (item) => item.id + ) + + dialog.documents = Array.from(this.list.selected) + dialog.succeeded.subscribe((result) => { + this.toastService.showInfo( + $localize`Bulk operation executed successfully` + ) + this.list.reload() + this.list.reduceSelectionToFilter() + this.list.selected.forEach((id) => { + this.openDocumentService.refreshDocument(id) + }) + }) + dialog.failed.subscribe((error) => { + this.toastService.showError( + $localize`Error executing bulk operation`, + error + ) + }) + } } diff --git a/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html new file mode 100644 index 000000000..637832a01 --- /dev/null +++ b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html @@ -0,0 +1,81 @@ +
+
+ + +
+
+ + +
+ @for (field of fieldsToAdd; track field.id) { +
+ @switch (field.data_type) { + @case (CustomFieldDataType.String) { + + + } + @case (CustomFieldDataType.Date) { + + + } + @case (CustomFieldDataType.Integer) { + + + } + @case (CustomFieldDataType.Float) { + + + } + @case (CustomFieldDataType.Monetary) { + + + } + @case (CustomFieldDataType.Boolean) { + + + } + @case (CustomFieldDataType.Url) { + + + } + @case (CustomFieldDataType.DocumentLink) { + + + } + @case (CustomFieldDataType.Select) { + + + } + } + +
+ } +
+
+
+ @if (fieldsToRemoveIds.length) { +

{ + fieldsToRemoveIds.length, + plural, + =1 {This operation will also remove 1 custom field from the selected documents.} other {This operation will also + remove {{fieldsToRemoveIds.length}} custom fields from the selected documents.} + }

+ } + + +
+
diff --git a/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.scss b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.spec.ts b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.spec.ts new file mode 100644 index 000000000..a5c76d5bc --- /dev/null +++ b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.spec.ts @@ -0,0 +1,89 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing' + +import { CustomFieldsBulkEditDialogComponent } from './custom-fields-bulk-edit-dialog.component' +import { FormsModule, ReactiveFormsModule } from '@angular/forms' +import { NgbActiveModal, NgbModule } from '@ng-bootstrap/ng-bootstrap' +import { of, throwError } from 'rxjs' +import { DocumentService } from 'src/app/services/rest/document.service' +import { SelectComponent } from 'src/app/components/common/input/select/select.component' +import { CustomFieldDataType } from 'src/app/data/custom-field' +import { NgSelectModule } from '@ng-select/ng-select' +import { provideHttpClientTesting } from '@angular/common/http/testing' +import { provideHttpClient } from '@angular/common/http' + +describe('CustomFieldsBulkEditDialogComponent', () => { + let component: CustomFieldsBulkEditDialogComponent + let fixture: ComponentFixture + let documentService: DocumentService + let activeModal: NgbActiveModal + + beforeEach(async () => { + TestBed.configureTestingModule({ + declarations: [CustomFieldsBulkEditDialogComponent, SelectComponent], + imports: [FormsModule, ReactiveFormsModule, NgbModule, NgSelectModule], + providers: [ + NgbActiveModal, + provideHttpClient(), + provideHttpClientTesting(), + ], + }).compileComponents() + + fixture = TestBed.createComponent(CustomFieldsBulkEditDialogComponent) + component = fixture.componentInstance + documentService = TestBed.inject(DocumentService) + activeModal = TestBed.inject(NgbActiveModal) + fixture.detectChanges() + }) + + it('should initialize form controls based on selected field ids', () => { + component.customFields = [ + { id: 1, name: 'Field 1', data_type: CustomFieldDataType.String }, + { id: 2, name: 'Field 2', data_type: CustomFieldDataType.Integer }, + ] + component.fieldsToAddIds = [1, 2] + expect(component.form.contains('1')).toBeTruthy() + expect(component.form.contains('2')).toBeTruthy() + }) + + it('should emit succeeded event and close modal on successful save', () => { + const editSpy = jest + .spyOn(documentService, 'bulkEdit') + .mockReturnValue(of('Success')) + const successSpy = jest.spyOn(component.succeeded, 'emit') + + component.documents = [1, 2] + component.fieldsToAddIds = [1] + component.form.controls['1'].setValue('Value 1') + component.save() + + expect(editSpy).toHaveBeenCalled() + expect(successSpy).toHaveBeenCalled() + }) + + it('should emit failed event on save error', () => { + const editSpy = jest + .spyOn(documentService, 'bulkEdit') + .mockReturnValue(throwError(new Error('Error'))) + const failSpy = jest.spyOn(component.failed, 'emit') + + component.documents = [1, 2] + component.fieldsToAddIds = [1] + component.form.controls['1'].setValue('Value 1') + component.save() + + expect(editSpy).toHaveBeenCalled() + expect(failSpy).toHaveBeenCalled() + }) + + it('should close modal on cancel', () => { + const activeModalSpy = jest.spyOn(activeModal, 'close') + component.cancel() + expect(activeModalSpy).toHaveBeenCalled() + }) + + it('should remove field from selected fields', () => { + component.fieldsToAddIds = [1, 2] + component.removeField(1) + expect(component.fieldsToAddIds).toEqual([2]) + }) +}) diff --git a/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.ts b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.ts new file mode 100644 index 000000000..9a253f488 --- /dev/null +++ b/src-ui/src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.ts @@ -0,0 +1,90 @@ +import { Component, EventEmitter, Output } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { first } from 'rxjs' +import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field' +import { DocumentService } from 'src/app/services/rest/document.service' + +@Component({ + selector: 'pngx-custom-fields-bulk-edit-dialog', + templateUrl: './custom-fields-bulk-edit-dialog.component.html', + styleUrl: './custom-fields-bulk-edit-dialog.component.scss', +}) +export class CustomFieldsBulkEditDialogComponent { + CustomFieldDataType = CustomFieldDataType + + @Output() + succeeded = new EventEmitter() + + @Output() + failed = new EventEmitter() + + public networkActive = false + + public customFields: CustomField[] = [] + + private _fieldsToAdd: CustomField[] = [] // static object for change detection + public get fieldsToAdd() { + return this._fieldsToAdd + } + + private _fieldsToAddIds: number[] = [] + public get fieldsToAddIds() { + return this._fieldsToAddIds + } + public set fieldsToAddIds(ids: number[]) { + this._fieldsToAddIds = ids + this._fieldsToAdd = this.customFields.filter((field) => + this._fieldsToAddIds.includes(field.id) + ) + this.initForm() + } + + public fieldsToRemoveIds: number[] = [] + + public form: FormGroup = new FormGroup({}) + + public documents: number[] = [] + + constructor( + private activeModal: NgbActiveModal, + private documentService: DocumentService + ) {} + + initForm() { + Object.keys(this.form.controls).forEach((key) => { + if (!this._fieldsToAddIds.includes(parseInt(key))) { + this.form.removeControl(key) + } + }) + this._fieldsToAddIds.forEach((field_id) => { + this.form.addControl(field_id.toString(), new FormControl(null)) + }) + } + + public save() { + this.documentService + .bulkEdit(this.documents, 'modify_custom_fields', { + add_custom_fields: this.form.value, + remove_custom_fields: this.fieldsToRemoveIds, + }) + .pipe(first()) + .subscribe({ + next: () => { + this.activeModal.close() + this.succeeded.emit() + }, + error: (error) => { + this.failed.emit(error) + }, + }) + } + + public cancel() { + this.activeModal.close() + } + + public removeField(fieldId: number) { + this.fieldsToAddIds = this._fieldsToAddIds.filter((id) => id !== fieldId) + } +} diff --git a/src/documents/bulk_edit.py b/src/documents/bulk_edit.py index 83be5eea9..9698f65cf 100644 --- a/src/documents/bulk_edit.py +++ b/src/documents/bulk_edit.py @@ -17,6 +17,7 @@ from documents.data_models import ConsumableDocument from documents.data_models import DocumentMetadataOverrides from documents.data_models import DocumentSource from documents.models import Correspondent +from documents.models import CustomField from documents.models import CustomFieldInstance from documents.models import Document from documents.models import DocumentType @@ -147,17 +148,34 @@ def modify_tags( def modify_custom_fields( doc_ids: list[int], - add_custom_fields, - remove_custom_fields, + add_custom_fields: list[int] | dict, + remove_custom_fields: list[int], ) -> Literal["OK"]: qs = Document.objects.filter(id__in=doc_ids).only("pk") affected_docs = list(qs.values_list("pk", flat=True)) + # Ensure add_custom_fields is a list of tuples, supports old API + add_custom_fields = ( + add_custom_fields.items() + if isinstance(add_custom_fields, dict) + else [(field, None) for field in add_custom_fields] + ) - for field in add_custom_fields: + custom_fields = CustomField.objects.filter( + id__in=[int(field) for field, _ in add_custom_fields], + ).distinct() + for field_id, value in add_custom_fields: for doc_id in affected_docs: + defaults = {} + custom_field = custom_fields.get(id=field_id) + if custom_field: + value_field = CustomFieldInstance.TYPE_TO_DATA_STORE_NAME_MAP[ + custom_field.data_type + ] + defaults[value_field] = value CustomFieldInstance.objects.update_or_create( document_id=doc_id, - field_id=field, + field_id=field_id, + defaults=defaults, ) CustomFieldInstance.objects.filter( document_id__in=affected_docs, diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 91e291c21..31871a3ad 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -638,7 +638,10 @@ class CustomFieldInstanceSerializer(serializers.ModelSerializer): uri_validator(data["value"]) elif field.data_type == CustomField.FieldDataType.INT: integer_validator(data["value"]) - elif field.data_type == CustomField.FieldDataType.MONETARY: + elif ( + field.data_type == CustomField.FieldDataType.MONETARY + and data["value"] != "" + ): try: # First try to validate as a number from legacy format DecimalValidator(max_digits=12, decimal_places=2)( @@ -1140,13 +1143,28 @@ class BulkEditSerializer( f"Some tags in {name} don't exist or were specified twice.", ) - def _validate_custom_field_id_list(self, custom_fields, name="custom_fields"): - if not isinstance(custom_fields, list): - raise serializers.ValidationError(f"{name} must be a list") - if not all(isinstance(i, int) for i in custom_fields): - raise serializers.ValidationError(f"{name} must be a list of integers") - count = CustomField.objects.filter(id__in=custom_fields).count() - if not count == len(custom_fields): + def _validate_custom_field_id_list_or_dict( + self, + custom_fields, + name="custom_fields", + ): + ids = custom_fields + if isinstance(custom_fields, dict): + try: + ids = [int(i[0]) for i in custom_fields.items()] + except Exception as e: + logger.exception(f"Error validating custom fields: {e}") + raise serializers.ValidationError( + f"{name} must be a list of integers or a dict of id:value pairs, see the log for details", + ) + elif not isinstance(custom_fields, list) or not all( + isinstance(i, int) for i in ids + ): + raise serializers.ValidationError( + f"{name} must be a list of integers or a dict of id:value pairs", + ) + count = CustomField.objects.filter(id__in=ids).count() + if not count == len(ids): raise serializers.ValidationError( f"Some custom fields in {name} don't exist or were specified twice.", ) @@ -1245,7 +1263,7 @@ class BulkEditSerializer( def _validate_parameters_modify_custom_fields(self, parameters): if "add_custom_fields" in parameters: - self._validate_custom_field_id_list( + self._validate_custom_field_id_list_or_dict( parameters["add_custom_fields"], "add_custom_fields", ) @@ -1253,7 +1271,7 @@ class BulkEditSerializer( raise serializers.ValidationError("add_custom_fields not specified") if "remove_custom_fields" in parameters: - self._validate_custom_field_id_list( + self._validate_custom_field_id_list_or_dict( parameters["remove_custom_fields"], "remove_custom_fields", ) diff --git a/src/documents/tests/test_api_bulk_edit.py b/src/documents/tests/test_api_bulk_edit.py index 075bbfd6a..ff0b367d1 100644 --- a/src/documents/tests/test_api_bulk_edit.py +++ b/src/documents/tests/test_api_bulk_edit.py @@ -244,7 +244,9 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): "documents": [self.doc1.id, self.doc3.id], "method": "modify_custom_fields", "parameters": { - "add_custom_fields": [self.cf1.id], + "add_custom_fields": [ + self.cf1.id, + ], # old format accepts list of IDs "remove_custom_fields": [self.cf2.id], }, }, @@ -258,6 +260,30 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): self.assertEqual(kwargs["add_custom_fields"], [self.cf1.id]) self.assertEqual(kwargs["remove_custom_fields"], [self.cf2.id]) + @mock.patch("documents.serialisers.bulk_edit.modify_custom_fields") + def test_api_modify_custom_fields_with_values(self, m): + self.setup_mock(m, "modify_custom_fields") + response = self.client.post( + "/api/documents/bulk_edit/", + json.dumps( + { + "documents": [self.doc1.id, self.doc3.id], + "method": "modify_custom_fields", + "parameters": { + "add_custom_fields": {self.cf1.id: "foo"}, + "remove_custom_fields": [self.cf2.id], + }, + }, + ), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_200_OK) + m.assert_called_once() + args, kwargs = m.call_args + self.assertListEqual(args[0], [self.doc1.id, self.doc3.id]) + self.assertEqual(kwargs["add_custom_fields"], {str(self.cf1.id): "foo"}) + self.assertEqual(kwargs["remove_custom_fields"], [self.cf2.id]) + @mock.patch("documents.serialisers.bulk_edit.modify_custom_fields") def test_api_modify_custom_fields_invalid_params(self, m): """ @@ -322,7 +348,23 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) m.assert_not_called() - # Not a list of integers + # Invalid dict + response = self.client.post( + "/api/documents/bulk_edit/", + json.dumps( + { + "documents": [self.doc1.id, self.doc3.id], + "method": "modify_custom_fields", + "parameters": { + "add_custom_fields": {"foo": 99}, + "remove_custom_fields": [self.cf2.id], + }, + }, + ), + content_type="application/json", + ) + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) + m.assert_not_called() # Missing remove_custom_fields response = self.client.post( diff --git a/src/documents/tests/test_bulk_edit.py b/src/documents/tests/test_bulk_edit.py index bb5ebf04d..03c177343 100644 --- a/src/documents/tests/test_bulk_edit.py +++ b/src/documents/tests/test_bulk_edit.py @@ -189,6 +189,15 @@ class TestBulkEdit(DirectoriesMixin, TestCase): self.assertCountEqual(kwargs["document_ids"], [self.doc2.id, self.doc3.id]) def test_modify_custom_fields(self): + """ + GIVEN: + - 2 documents with custom fields + - 3 custom fields + WHEN: + - Custom fields are modified using old format (list of ids) + THEN: + - Custom fields are modified for the documents + """ cf = CustomField.objects.create( name="cf1", data_type=CustomField.FieldDataType.STRING, @@ -235,6 +244,78 @@ class TestBulkEdit(DirectoriesMixin, TestCase): args, kwargs = self.async_task.call_args self.assertCountEqual(kwargs["document_ids"], [self.doc1.id, self.doc2.id]) + def test_modify_custom_fields_with_values(self): + """ + GIVEN: + - 2 documents with custom fields + - 3 custom fields + WHEN: + - Custom fields are modified using new format (dict) + THEN: + - Custom fields are modified for the documents + """ + cf = CustomField.objects.create( + name="cf", + data_type=CustomField.FieldDataType.STRING, + ) + cf1 = CustomField.objects.create( + name="cf1", + data_type=CustomField.FieldDataType.STRING, + ) + cf2 = CustomField.objects.create( + name="cf2", + data_type=CustomField.FieldDataType.MONETARY, + ) + cf3 = CustomField.objects.create( + name="cf3", + data_type=CustomField.FieldDataType.STRING, + ) + CustomFieldInstance.objects.create( + document=self.doc2, + field=cf, + ) + CustomFieldInstance.objects.create( + document=self.doc2, + field=cf1, + ) + CustomFieldInstance.objects.create( + document=self.doc2, + field=cf3, + ) + bulk_edit.modify_custom_fields( + [self.doc1.id, self.doc2.id], + add_custom_fields={cf2.id: None, cf3.id: "value"}, + remove_custom_fields=[cf.id], + ) + + self.doc1.refresh_from_db() + self.doc2.refresh_from_db() + + self.assertEqual( + self.doc1.custom_fields.count(), + 2, + ) + self.assertEqual( + self.doc1.custom_fields.get(field=cf2).value, + None, + ) + self.assertEqual( + self.doc1.custom_fields.get(field=cf3).value, + "value", + ) + self.assertEqual( + self.doc2.custom_fields.count(), + 3, + ) + self.assertEqual( + self.doc2.custom_fields.get(field=cf3).value, + "value", + ) + + self.async_task.assert_called_once() + args, kwargs = self.async_task.call_args + self.assertCountEqual(kwargs["document_ids"], [self.doc1.id, self.doc2.id]) + def test_delete(self): self.assertEqual(Document.objects.count(), 5) bulk_edit.delete([self.doc1.id, self.doc2.id])