diff --git a/Pipfile b/Pipfile index da26987cf..948e22273 100644 --- a/Pipfile +++ b/Pipfile @@ -17,6 +17,7 @@ django-extensions = "*" django-filter = "~=24.2" django-guardian = "*" django-multiselectfield = "*" +django-soft-delete = "*" djangorestframework = "==3.14.0" djangorestframework-guardian = "*" drf-writable-nested = "*" diff --git a/Pipfile.lock b/Pipfile.lock index f3753a0cd..e011e1c60 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -540,6 +540,15 @@ "index": "pypi", "version": "==0.1.12" }, + "django-soft-delete": { + "hashes": [ + "sha256:443c00a54c06d236ff8806c3260243d775cc536581d7377c2785080b1041ce1d", + "sha256:7cb4524231763a70ad79cfccd49d001b7e5fa666ec897cc044d897dd73e0146e" + ], + "index": "pypi", + "markers": "python_version >= '3.6'", + "version": "==1.0.13" + }, "djangorestframework": { "hashes": [ "sha256:579a333e6256b09489cbe0a067e66abe55c6595d8926be6b99423786334350c8", diff --git a/docs/configuration.md b/docs/configuration.md index f4c271ce1..0c3345145 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -219,10 +219,10 @@ database, classification model, etc). Defaults to "../data/", relative to the "src" directory. -#### [`PAPERLESS_TRASH_DIR=`](#PAPERLESS_TRASH_DIR) {#PAPERLESS_TRASH_DIR} +#### [`PAPERLESS_EMPTY_TRASH_DIR=`](#PAPERLESS_EMPTY_TRASH_DIR) {#PAPERLESS_EMPTY_TRASH_DIR} -: Instead of removing deleted documents, they are moved to this -directory. +: When documents are deleted (e.g. after emptying the trash) the original files will be moved here +instead of being removed from the filesystem. Only the original version is kept. This must be writeable by the user running paperless. When running inside docker, ensure that this path is within a permanent volume @@ -230,7 +230,9 @@ directory. Note that the directory must exist prior to using this setting. - Defaults to empty (i.e. really delete documents). + Defaults to empty (i.e. really delete files). + + This setting was previously named PAPERLESS_TRASH_DIR. #### [`PAPERLESS_MEDIA_ROOT=`](#PAPERLESS_MEDIA_ROOT) {#PAPERLESS_MEDIA_ROOT} @@ -1362,6 +1364,20 @@ processing. This only has an effect if Defaults to false. +## Trash + +#### [`EMPTY_TRASH_DELAY=`](#EMPTY_TRASH_DELAY) {#EMPTY_TRASH_DELAY} + +: Sets how long in days documents remain in the 'trash' before they are permanently deleted. + + Defaults to 30 days, minimum of 1 day. + +#### [`PAPERLESS_EMPTY_TRASH_TASK_CRON=`](#PAPERLESS_EMPTY_TRASH_TASK_CRON) {#PAPERLESS_EMPTY_TRASH_TASK_CRON} + +: Configures the schedule to empty the trash of expired deleted documents. + + Defaults to `0 1 * * *`, once per day. + ## Binaries There are a few external software packages that Paperless expects to diff --git a/docs/usage.md b/docs/usage.md index 5705be3da..034447d6e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -478,6 +478,15 @@ As of version 2.7, Paperless-ngx automatically records all changes to a document Changes to documents are visible under the "History" tab. Note that certain changes such as those made by workflows, record the 'actor' as "System". +## Document Trash + +When you first delete a document it is moved to the 'trash' until either it is explicitly deleted or it is automatically removed after a set amount of time has passed. +You can set how long documents remain in the trash before being automatically deleted with [`EMPTY_TRASH_DELAY`](configuration.md#EMPTY_TRASH_DELAY), which defaults +to 30 days. Until the file is actually deleted (e.g. the trash is emptied), all files and database content remains intact and can be restored at any point up until that time. + +Additionally you may configure a directory where deleted files are moved to when they the trash is emptied with [`PAPERLESS_EMPTY_TRASH_DIR`](configuration.md#PAPERLESS_EMPTY_TRASH_DIR). +Note that the empty trash directory only stores the original file, the archive file and all database information is permanently removed once a document is fully deleted. + ## Best practices {#basic-searching} Paperless offers a couple tools that help you organize your document diff --git a/paperless.conf.example b/paperless.conf.example index db557a7b6..63ee7be22 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -19,7 +19,7 @@ #PAPERLESS_CONSUMPTION_DIR=../consume #PAPERLESS_DATA_DIR=../data -#PAPERLESS_TRASH_DIR= +#PAPERLESS_EMPTY_TRASH_DIR= #PAPERLESS_MEDIA_ROOT=../media #PAPERLESS_STATICDIR=../static #PAPERLESS_FILENAME_FORMAT= diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index 56cfa9ae4..492c160c9 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -240,18 +240,18 @@ Document was added to Paperless-ngx. src/app/app.component.ts - 83 + 85 src/app/app.component.ts - 92 + 94 Open document src/app/app.component.ts - 85 + 87 src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html @@ -274,21 +274,21 @@ Could not add : src/app/app.component.ts - 107 + 109 Document is being processed by Paperless-ngx. src/app/app.component.ts - 122 + 124 Dashboard src/app/app.component.ts - 129 + 131 src/app/components/app-frame/app-frame.component.html @@ -307,7 +307,7 @@ Documents src/app/app.component.ts - 140 + 142 src/app/components/app-frame/app-frame.component.html @@ -342,7 +342,7 @@ Settings src/app/app.component.ts - 152 + 154 src/app/components/admin/settings/settings.component.html @@ -369,14 +369,14 @@ Prev src/app/app.component.ts - 158 + 160 Next src/app/app.component.ts - 159 + 161 src/app/components/document-detail/document-detail.component.html @@ -387,56 +387,56 @@ End src/app/app.component.ts - 160 + 162 The dashboard can be used to show saved views, such as an 'Inbox'. Those settings are found under Settings > Saved Views once you have created some. src/app/app.component.ts - 166 + 168 Drag-and-drop documents here to start uploading or place them in the consume folder. You can also drag-and-drop documents anywhere on all other pages of the web app. Once you do, Paperless-ngx will start training its machine learning algorithms. src/app/app.component.ts - 173 + 175 The documents list shows all of your documents and allows for filtering as well as bulk-editing. There are three different view styles: list, small cards and large cards. A list of documents currently opened for editing is shown in the sidebar. src/app/app.component.ts - 178 + 180 The filtering tools allow you to quickly find documents using various searches, dates, tags, etc. src/app/app.component.ts - 185 + 187 Any combination of filters can be saved as a 'view' which can then be displayed on the dashboard and / or sidebar. src/app/app.component.ts - 191 + 193 Tags, correspondents, document types and storage paths can all be managed using these pages. They can also be created from the document edit view. src/app/app.component.ts - 196 + 198 Manage e-mail accounts and rules for automatically importing documents. src/app/app.component.ts - 204 + 206 src/app/components/manage/mail/mail.component.html @@ -447,14 +447,14 @@ Workflows give you more control over the document pipeline. src/app/app.component.ts - 212 + 214 File Tasks shows you documents that have been consumed, are waiting to be, or may have failed during the process. src/app/app.component.ts - 220 + 222 src/app/components/admin/tasks/tasks.component.html @@ -465,28 +465,28 @@ Check out the settings for various tweaks to the web app and toggle settings for saved views. src/app/app.component.ts - 228 + 230 Thank you! 🙏 src/app/app.component.ts - 236 + 238 There are <em>tons</em> more features and info we didn't cover here, but this should get you started. Check out the documentation or visit the project on GitHub to learn more or to report issues. src/app/app.component.ts - 238 + 240 Lastly, on behalf of every contributor to this community-supported project, thank you for using Paperless-ngx! src/app/app.component.ts - 240 + 242 @@ -684,6 +684,10 @@ src/app/components/admin/tasks/tasks.component.html 23 + + src/app/components/admin/trash/trash.component.html + 45 + src/app/components/admin/users-groups/users-groups.component.html 92 @@ -976,13 +980,6 @@ 195 - - Deleting documents will always ask for confirmation. - - src/app/components/admin/settings/settings.component.html - 195 - - Apply on close @@ -1363,6 +1360,10 @@ src/app/components/admin/tasks/tasks.component.html 42 + + src/app/components/admin/trash/trash.component.html + 37 + src/app/components/admin/users-groups/users-groups.component.html 23 @@ -1422,6 +1423,22 @@ src/app/components/admin/settings/settings.component.html 369 + + src/app/components/admin/trash/trash.component.html + 67 + + + src/app/components/admin/trash/trash.component.html + 76 + + + src/app/components/admin/trash/trash.component.ts + 57 + + + src/app/components/admin/trash/trash.component.ts + 80 + src/app/components/admin/users-groups/users-groups.component.html 38 @@ -1765,6 +1782,10 @@ src/app/components/admin/tasks/tasks.component.html 9 + + src/app/components/admin/trash/trash.component.html + 8 + src/app/components/manage/management-list/management-list.component.html 3 @@ -1788,6 +1809,10 @@ src/app/components/admin/tasks/tasks.component.html 36 + + src/app/components/admin/trash/trash.component.html + 35 + src/app/components/admin/users-groups/users-groups.component.html 21 @@ -2045,6 +2070,188 @@ 141 + + Trash + + src/app/components/admin/trash/trash.component.html + 2 + + + src/app/components/app-frame/app-frame.component.html + 271 + + + src/app/components/app-frame/app-frame.component.html + 274 + + + + Manage trashed documents that are pending deletion. + + src/app/components/admin/trash/trash.component.html + 4 + + + + Restore selected + + src/app/components/admin/trash/trash.component.html + 11 + + + + Delete selected + + src/app/components/admin/trash/trash.component.html + 14 + + + + Empty trash + + src/app/components/admin/trash/trash.component.html + 17 + + + + Remaining + + src/app/components/admin/trash/trash.component.html + 36 + + + + days + + src/app/components/admin/trash/trash.component.html + 58 + + + + Restore + + src/app/components/admin/trash/trash.component.html + 66 + + + src/app/components/admin/trash/trash.component.html + 73 + + + + {VAR_PLURAL, plural, =1 {One document in trash} other { total documents in trash}} + + src/app/components/admin/trash/trash.component.html + 89 + + + + Confirm delete + + src/app/components/admin/trash/trash.component.ts + 53 + + + src/app/components/admin/trash/trash.component.ts + 74 + + + src/app/components/manage/management-list/management-list.component.ts + 203 + + + src/app/components/manage/management-list/management-list.component.ts + 320 + + + + This operation will permanently delete this document. + + src/app/components/admin/trash/trash.component.ts + 54 + + + + This operation cannot be undone. + + src/app/components/admin/trash/trash.component.ts + 55 + + + src/app/components/admin/trash/trash.component.ts + 78 + + + src/app/components/admin/users-groups/users-groups.component.ts + 116 + + + src/app/components/admin/users-groups/users-groups.component.ts + 166 + + + src/app/components/manage/custom-fields/custom-fields.component.ts + 73 + + + src/app/components/manage/mail/mail.component.ts + 114 + + + src/app/components/manage/mail/mail.component.ts + 173 + + + src/app/components/manage/management-list/management-list.component.ts + 322 + + + src/app/components/manage/workflows/workflows.component.ts + 97 + + + + Document deleted + + src/app/components/admin/trash/trash.component.ts + 63 + + + + This operation will permanently delete the selected documents. + + src/app/components/admin/trash/trash.component.ts + 76 + + + + This operation will permanently delete all documents in the trash. + + src/app/components/admin/trash/trash.component.ts + 77 + + + + Document(s) deleted + + src/app/components/admin/trash/trash.component.ts + 87 + + + + Document restored + + src/app/components/admin/trash/trash.component.ts + 97 + + + + Document(s) restored + + src/app/components/admin/trash/trash.component.ts + 106 + + Users & Groups @@ -2247,41 +2454,6 @@ 115 - - This operation cannot be undone. - - src/app/components/admin/users-groups/users-groups.component.ts - 116 - - - src/app/components/admin/users-groups/users-groups.component.ts - 166 - - - src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 714 - - - src/app/components/manage/custom-fields/custom-fields.component.ts - 73 - - - src/app/components/manage/mail/mail.component.ts - 114 - - - src/app/components/manage/mail/mail.component.ts - 173 - - - src/app/components/manage/management-list/management-list.component.ts - 322 - - - src/app/components/manage/workflows/workflows.component.ts - 97 - - Proceed @@ -2310,15 +2482,15 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 755 + 758 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 788 + 791 src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 807 + 810 src/app/components/manage/custom-fields/custom-fields.component.ts @@ -2433,11 +2605,11 @@ src/app/components/app-frame/app-frame.component.html - 272 + 279 src/app/components/app-frame/app-frame.component.html - 275 + 282 @@ -2612,42 +2784,42 @@ GitHub src/app/components/app-frame/app-frame.component.html - 282 + 289 is available. src/app/components/app-frame/app-frame.component.html - 291,292 + 298,299 Click to view. src/app/components/app-frame/app-frame.component.html - 292 + 299 Paperless-ngx can automatically check for updates src/app/components/app-frame/app-frame.component.html - 296 + 303 How does this work? src/app/components/app-frame/app-frame.component.html - 303,305 + 310,312 Update available src/app/components/app-frame/app-frame.component.html - 316 + 323 @@ -2887,6 +3059,10 @@ src/app/components/common/permissions-dialog/permissions-dialog.component.html 26 + + src/app/components/document-detail/document-detail.component.ts + 776 + src/app/components/document-list/bulk-editor/bulk-editor.component.ts 401 @@ -2907,6 +3083,10 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts 579 + + src/app/components/document-list/bulk-editor/bulk-editor.component.ts + 712 + Page @@ -5864,41 +6044,34 @@ 749 - - Confirm delete - - src/app/components/document-detail/document-detail.component.ts - 776 - - - src/app/components/manage/management-list/management-list.component.ts - 203 - - - src/app/components/manage/management-list/management-list.component.ts - 320 - - - - Do you really want to delete document ""? + + Do you really want to move the document "" to the trash? src/app/components/document-detail/document-detail.component.ts 777 - - The files for this document will be deleted permanently. This operation cannot be undone. + + Documents can be restored prior to permanent deletion. src/app/components/document-detail/document-detail.component.ts 778 + + src/app/components/document-list/bulk-editor/bulk-editor.component.ts + 714 + - - Delete document + + Move to trash src/app/components/document-detail/document-detail.component.ts 780 + + src/app/components/document-list/bulk-editor/bulk-editor.component.ts + 716 + Error deleting document @@ -5915,7 +6088,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 751 + 754 @@ -5989,7 +6162,7 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 784 + 787 @@ -6364,74 +6537,60 @@ 571,575 - - Delete confirm - - src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 712 - - - - This operation will permanently delete selected document(s). + + Move selected document(s) to the trash? src/app/components/document-list/bulk-editor/bulk-editor.component.ts 713 - - Delete document(s) - - src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 716 - - This operation will permanently recreate the archive files for selected document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 752 + 755 The archive files will be re-generated with the current settings. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 753 + 756 This operation will permanently rotate the original version of document(s). src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 785 + 788 This will alter the original copy. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 786 + 789 Merge confirm src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 805 + 808 This operation will merge selected documents into a new document. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 806 + 809 Merged document will be queued for consumption. src/app/components/document-list/bulk-editor/bulk-editor.component.ts - 822 + 825 diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index 12b412f67..bbeba9e8a 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -26,6 +26,7 @@ import { MailComponent } from './components/manage/mail/mail.component' import { UsersAndGroupsComponent } from './components/admin/users-groups/users-groups.component' import { CustomFieldsComponent } from './components/manage/custom-fields/custom-fields.component' import { ConfigComponent } from './components/admin/config/config.component' +import { TrashComponent } from './components/admin/trash/trash.component' export const routes: Routes = [ { path: '', redirectTo: 'dashboard', pathMatch: 'full' }, @@ -144,6 +145,14 @@ export const routes: Routes = [ requireAdmin: true, }, }, + { + path: 'trash', + component: TrashComponent, + canActivate: [PermissionsGuard], + data: { + requireAdmin: true, + }, + }, // redirect old paths { path: 'settings/mail', diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index f9e04b069..2232dad19 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -125,6 +125,7 @@ import { CustomFieldDisplayComponent } from './components/common/custom-field-di import { GlobalSearchComponent } from './components/app-frame/global-search/global-search.component' import { HotkeyDialogComponent } from './components/common/hotkey-dialog/hotkey-dialog.component' import { DeletePagesConfirmDialogComponent } from './components/common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component' +import { TrashComponent } from './components/admin/trash/trash.component' import { airplane, archive, @@ -497,6 +498,7 @@ function initializeApp(settings: SettingsService) { GlobalSearchComponent, HotkeyDialogComponent, DeletePagesConfirmDialogComponent, + TrashComponent, ], imports: [ BrowserModule, diff --git a/src-ui/src/app/components/admin/settings/settings.component.html b/src-ui/src/app/components/admin/settings/settings.component.html index bcab7de33..285599639 100644 --- a/src-ui/src/app/components/admin/settings/settings.component.html +++ b/src-ui/src/app/components/admin/settings/settings.component.html @@ -192,7 +192,7 @@
- +
diff --git a/src-ui/src/app/components/admin/trash/trash.component.html b/src-ui/src/app/components/admin/trash/trash.component.html new file mode 100644 index 000000000..1c66bdd44 --- /dev/null +++ b/src-ui/src/app/components/admin/trash/trash.component.html @@ -0,0 +1,98 @@ + + + + + + + +
+ +
+ +
+ + + + + + + + + + + @if (isLoading) { + + + + } + @for (document of documentsInTrash; track document.id) { + + + + + + + } + +
+
+ + +
+ 		NameRemainingActions
+ + Loading... +
+
+ + +
+ 		{{ document.title }}{{ getDaysRemaining(document) }} days +
+
+ +
+ + +
+
+
+
+ + +
+
+
+ +@if (!isLoading) { +
+
+ {totalDocuments, plural, =1 {One document in trash} other {{{totalDocuments || 0}} total documents in trash}} + @if (selectedDocuments.size > 0) { +  ({{selectedDocuments.size}} selected) + } +
+ @if (documentsInTrash.length > 20) { + + } +
+} diff --git a/src-ui/src/app/components/admin/trash/trash.component.scss b/src-ui/src/app/components/admin/trash/trash.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/admin/trash/trash.component.spec.ts b/src-ui/src/app/components/admin/trash/trash.component.spec.ts new file mode 100644 index 000000000..063d4bb8f --- /dev/null +++ b/src-ui/src/app/components/admin/trash/trash.component.spec.ts @@ -0,0 +1,163 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing' + +import { TrashComponent } from './trash.component' +import { HttpClientTestingModule } from '@angular/common/http/testing' +import { PageHeaderComponent } from '../../common/page-header/page-header.component' +import { + NgbModal, + NgbPaginationModule, + NgbPopoverModule, +} from '@ng-bootstrap/ng-bootstrap' +import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' +import { FormsModule, ReactiveFormsModule } from '@angular/forms' +import { TrashService } from 'src/app/services/trash.service' +import { of } from 'rxjs' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { By } from '@angular/platform-browser' + +const documentsInTrash = [ + { + id: 1, + name: 'test1', + created: new Date('2023-03-01T10:26:03.093116Z'), + deleted_at: new Date('2023-03-01T10:26:03.093116Z'), + }, + { + id: 2, + name: 'test2', + created: new Date('2023-03-01T10:26:03.093116Z'), + deleted_at: new Date('2023-03-01T10:26:03.093116Z'), + }, +] + +describe('TrashComponent', () => { + let component: TrashComponent + let fixture: ComponentFixture + let trashService: TrashService + let modalService: NgbModal + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ + TrashComponent, + PageHeaderComponent, + ConfirmDialogComponent, + ], + imports: [ + HttpClientTestingModule, + FormsModule, + ReactiveFormsModule, + NgbPopoverModule, + NgbPaginationModule, + NgxBootstrapIconsModule.pick(allIcons), + ], + }).compileComponents() + + fixture = TestBed.createComponent(TrashComponent) + trashService = TestBed.inject(TrashService) + modalService = TestBed.inject(NgbModal) + component = fixture.componentInstance + fixture.detectChanges() + }) + + it('should call correct service method on reload', () => { + const trashSpy = jest.spyOn(trashService, 'getTrash') + trashSpy.mockReturnValue( + of({ + count: 2, + all: documentsInTrash.map((d) => d.id), + results: documentsInTrash, + }) + ) + component.reload() + expect(trashSpy).toHaveBeenCalled() + expect(component.documentsInTrash).toEqual(documentsInTrash) + }) + + it('should support delete document', () => { + const trashSpy = jest.spyOn(trashService, 'emptyTrash') + let modal + modalService.activeInstances.subscribe((instances) => { + modal = instances[0] + }) + trashSpy.mockReturnValue(of('OK')) + component.delete(documentsInTrash[0]) + expect(modal).toBeDefined() + modal.componentInstance.confirmClicked.next() + expect(trashSpy).toHaveBeenCalled() + }) + + it('should support empty trash', () => { + const trashSpy = jest.spyOn(trashService, 'emptyTrash') + let modal + modalService.activeInstances.subscribe((instances) => { + modal = instances[instances.length - 1] + }) + trashSpy.mockReturnValue(of('OK')) + component.emptyTrash() + expect(modal).toBeDefined() + modal.componentInstance.confirmClicked.next() + expect(trashSpy).toHaveBeenCalled() + modal.close() + component.emptyTrash(new Set([1, 2])) + modal.componentInstance.confirmClicked.next() + expect(trashSpy).toHaveBeenCalledWith([1, 2]) + }) + + it('should support restore document', () => { + const restoreSpy = jest.spyOn(trashService, 'restoreDocuments') + const reloadSpy = jest.spyOn(component, 'reload') + restoreSpy.mockReturnValue(of('OK')) + component.restore(documentsInTrash[0]) + expect(restoreSpy).toHaveBeenCalledWith([documentsInTrash[0].id]) + expect(reloadSpy).toHaveBeenCalled() + }) + + it('should support restore all documents', () => { + const restoreSpy = jest.spyOn(trashService, 'restoreDocuments') + const reloadSpy = jest.spyOn(component, 'reload') + restoreSpy.mockReturnValue(of('OK')) + component.restoreAll() + expect(restoreSpy).toHaveBeenCalled() + expect(reloadSpy).toHaveBeenCalled() + component.restoreAll(new Set([1, 2])) + expect(restoreSpy).toHaveBeenCalledWith([1, 2]) + }) + + it('should support toggle all items in view', () => { + component.documentsInTrash = documentsInTrash + expect(component.selectedDocuments.size).toEqual(0) + const toggleAllSpy = jest.spyOn(component, 'toggleAll') + const checkButton = fixture.debugElement.queryAll( + By.css('input.form-check-input') + )[0] + checkButton.nativeElement.dispatchEvent(new Event('click')) + checkButton.nativeElement.checked = true + checkButton.nativeElement.dispatchEvent(new Event('click')) + expect(toggleAllSpy).toHaveBeenCalled() + expect(component.selectedDocuments.size).toEqual(documentsInTrash.length) + }) + + it('should support toggle item', () => { + component.selectedDocuments = new Set([1]) + component.toggleSelected(documentsInTrash[0]) + expect(component.selectedDocuments.size).toEqual(0) + component.toggleSelected(documentsInTrash[0]) + expect(component.selectedDocuments.size).toEqual(1) + }) + + it('should support clear selection', () => { + component.selectedDocuments = new Set([1]) + component.clearSelection() + expect(component.selectedDocuments.size).toEqual(0) + }) + + it('should correctly display days remaining', () => { + expect(component.getDaysRemaining(documentsInTrash[0])).toBeLessThan(0) + const tenDaysAgo = new Date() + tenDaysAgo.setDate(tenDaysAgo.getDate() - 10) + expect( + component.getDaysRemaining({ deleted_at: tenDaysAgo }) + ).toBeGreaterThan(0) // 10 days ago but depends on month + }) +}) diff --git a/src-ui/src/app/components/admin/trash/trash.component.ts b/src-ui/src/app/components/admin/trash/trash.component.ts new file mode 100644 index 000000000..b867f1706 --- /dev/null +++ b/src-ui/src/app/components/admin/trash/trash.component.ts @@ -0,0 +1,137 @@ +import { Component, OnDestroy } from '@angular/core' +import { NgbModal } from '@ng-bootstrap/ng-bootstrap' +import { Document } from 'src/app/data/document' +import { ToastService } from 'src/app/services/toast.service' +import { TrashService } from 'src/app/services/trash.service' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { Subject, takeUntil } from 'rxjs' +import { SettingsService } from 'src/app/services/settings.service' +import { SETTINGS_KEYS } from 'src/app/data/ui-settings' + +@Component({ + selector: 'pngx-trash', + templateUrl: './trash.component.html', + styleUrl: './trash.component.scss', +}) +export class TrashComponent implements OnDestroy { + public documentsInTrash: Document[] = [] + public selectedDocuments: Set = new Set() + public allToggled: boolean = false + public page: number = 1 + public totalDocuments: number + public isLoading: boolean = false + unsubscribeNotifier: Subject = new Subject() + + constructor( + private trashService: TrashService, + private toastService: ToastService, + private modalService: NgbModal, + private settingsService: SettingsService + ) { + this.reload() + } + + ngOnDestroy() { + this.unsubscribeNotifier.next() + this.unsubscribeNotifier.complete() + } + + reload() { + this.isLoading = true + this.trashService.getTrash(this.page).subscribe((r) => { + this.documentsInTrash = r.results + this.totalDocuments = r.count + this.isLoading = false + this.selectedDocuments.clear() + }) + } + + delete(document: Document) { + let modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete` + modal.componentInstance.messageBold = $localize`This operation will permanently delete this document.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Delete` + modal.componentInstance.confirmClicked + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.trashService.emptyTrash([document.id]).subscribe(() => { + this.toastService.showInfo($localize`Document deleted`) + modal.close() + this.reload() + }) + }) + } + + emptyTrash(documents?: Set) { + let modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete` + modal.componentInstance.messageBold = documents + ? $localize`This operation will permanently delete the selected documents.` + : $localize`This operation will permanently delete all documents in the trash.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Delete` + modal.componentInstance.confirmClicked + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe(() => { + this.trashService + .emptyTrash(documents ? Array.from(documents) : null) + .subscribe(() => { + this.toastService.showInfo($localize`Document(s) deleted`) + this.allToggled = false + modal.close() + this.reload() + }) + }) + } + + restore(document: Document) { + this.trashService.restoreDocuments([document.id]).subscribe(() => { + this.toastService.showInfo($localize`Document restored`) + this.reload() + }) + } + + restoreAll(documents: Set = null) { + this.trashService + .restoreDocuments(documents ? Array.from(documents) : null) + .subscribe(() => { + this.toastService.showInfo($localize`Document(s) restored`) + this.allToggled = false + this.reload() + }) + } + + toggleAll(event: PointerEvent) { + if ((event.target as HTMLInputElement).checked) { + this.selectedDocuments = new Set(this.documentsInTrash.map((t) => t.id)) + } else { + this.clearSelection() + } + } + + toggleSelected(object: Document) { + this.selectedDocuments.has(object.id) + ? this.selectedDocuments.delete(object.id) + : this.selectedDocuments.add(object.id) + } + + clearSelection() { + this.allToggled = false + this.selectedDocuments.clear() + } + + getDaysRemaining(document: Document): number { + const delay = this.settingsService.get(SETTINGS_KEYS.EMPTY_TRASH_DELAY) + const diff = new Date().getTime() - new Date(document.deleted_at).getTime() + const days = Math.ceil(diff / (1000 * 3600 * 24)) + return delay - days + } +} 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 ab5759ec0..20c90b402 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 @@ -267,6 +267,13 @@ } +
  • + +  Trash + +
  • { expect(closeModalSpy).toHaveBeenCalled() expect(confirmSubjectResult).toBeFalsy() }) - - it('should support delay confirm', fakeAsync(() => { - component.confirmButtonEnabled = false - component.delayConfirm(1) - expect(component.confirmButtonEnabled).toBeFalsy() - tick(1500) - fixture.detectChanges() - expect(component.confirmButtonEnabled).toBeTruthy() - discardPeriodicTasks() - })) }) diff --git a/src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts b/src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts index 9c627ead0..2dfb6a15d 100644 --- a/src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts +++ b/src-ui/src/app/components/common/confirm-dialog/confirm-dialog.component.ts @@ -54,26 +54,6 @@ export class ConfirmDialogComponent { confirmSubject: Subject alternativeSubject: Subject - delayConfirm(seconds: number) { - const refreshInterval = 0.15 // s - - this.secondsTotal = seconds - this.seconds = seconds - - interval(refreshInterval * 1000) - .pipe( - take(this.secondsTotal / refreshInterval + 2) // need 2 more for animation to complete after 0 - ) - .subscribe((count) => { - this.seconds = Math.max( - 0, - this.secondsTotal - refreshInterval * (count + 1) - ) - this.confirmButtonEnabled = - this.secondsTotal - refreshInterval * count < 0 - }) - } - cancel() { this.confirmSubject?.next(false) this.confirmSubject?.complete() diff --git a/src-ui/src/app/components/document-detail/document-detail.component.ts b/src-ui/src/app/components/document-detail/document-detail.component.ts index 339d35587..d6cbdd57e 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.ts +++ b/src-ui/src/app/components/document-detail/document-detail.component.ts @@ -773,11 +773,11 @@ export class DocumentDetailComponent let modal = this.modalService.open(ConfirmDialogComponent, { backdrop: 'static', }) - modal.componentInstance.title = $localize`Confirm delete` - modal.componentInstance.messageBold = $localize`Do you really want to delete document "${this.document.title}"?` - modal.componentInstance.message = $localize`The files for this document will be deleted permanently. This operation cannot be undone.` + modal.componentInstance.title = $localize`Confirm` + modal.componentInstance.messageBold = $localize`Do you really want to move the document "${this.document.title}" to the trash?` + modal.componentInstance.message = $localize`Documents can be restored prior to permanent deletion.` modal.componentInstance.btnClass = 'btn-danger' - modal.componentInstance.btnCaption = $localize`Delete document` + modal.componentInstance.btnCaption = $localize`Move to trash` this.subscribeModalDelete(modal) // so can be re-subscribed if error } 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 cbc8cc4bf..6a58abf1e 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 @@ -858,7 +858,7 @@ describe('BulkEditorComponent', () => { ) }) - it('should support bulk delete with confirmation', () => { + it('should support bulk delete with confirmation or without', () => { let modal: NgbModalRef modalService.activeInstances.subscribe((m) => (modal = m[0])) jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true) @@ -891,6 +891,13 @@ describe('BulkEditorComponent', () => { httpTestingController.match( `${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id` ) // listAllFilteredIds + + component.showConfirmationDialogs = false + fixture.detectChanges() + component.applyDelete() + req = httpTestingController.expectOne( + `${environment.apiBaseUrl}documents/bulk_edit/` + ) }) it('should not be accessible with insufficient global permissions', () => { 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 a03e27549..f823fe2bb 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 @@ -705,21 +705,24 @@ export class BulkEditorComponent } applyDelete() { - let modal = this.modalService.open(ConfirmDialogComponent, { - backdrop: 'static', - }) - modal.componentInstance.delayConfirm(5) - modal.componentInstance.title = $localize`Delete confirm` - modal.componentInstance.messageBold = $localize`This operation will permanently delete ${this.list.selected.size} selected document(s).` - modal.componentInstance.message = $localize`This operation cannot be undone.` - modal.componentInstance.btnClass = 'btn-danger' - modal.componentInstance.btnCaption = $localize`Delete document(s)` - modal.componentInstance.confirmClicked - .pipe(takeUntil(this.unsubscribeNotifier)) - .subscribe(() => { - modal.componentInstance.buttonsEnabled = false - this.executeBulkOperation(modal, 'delete', {}) + if (this.showConfirmationDialogs) { + let modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', }) + modal.componentInstance.title = $localize`Confirm` + modal.componentInstance.messageBold = $localize`Move ${this.list.selected.size} selected document(s) to the trash?` + modal.componentInstance.message = $localize`Documents can be restored prior to permanent deletion.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Move to trash` + modal.componentInstance.confirmClicked + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.executeBulkOperation(modal, 'delete', {}) + }) + } else { + this.executeBulkOperation(null, 'delete', {}) + } } downloadSelected() { diff --git a/src-ui/src/app/data/document.ts b/src-ui/src/app/data/document.ts index 7b7c6f786..1571d2a53 100644 --- a/src-ui/src/app/data/document.ts +++ b/src-ui/src/app/data/document.ts @@ -144,6 +144,8 @@ export interface Document extends ObjectWithPermissions { added?: Date + deleted_at?: Date + original_file_name?: string archived_file_name?: string diff --git a/src-ui/src/app/data/ui-settings.ts b/src-ui/src/app/data/ui-settings.ts index 29ea08786..e22d33a83 100644 --- a/src-ui/src/app/data/ui-settings.ts +++ b/src-ui/src/app/data/ui-settings.ts @@ -63,6 +63,7 @@ export const SETTINGS_KEYS = { 'general-settings:document-editing:remove-inbox-tags', SEARCH_DB_ONLY: 'general-settings:search:db-only', SEARCH_FULL_TYPE: 'general-settings:search:more-link', + EMPTY_TRASH_DELAY: 'general-settings:trash:empty-trash-delay', } export const SETTINGS: UiSetting[] = [ @@ -236,4 +237,9 @@ export const SETTINGS: UiSetting[] = [ type: 'string', default: GlobalSearchType.TITLE_CONTENT, }, + { + key: SETTINGS_KEYS.EMPTY_TRASH_DELAY, + type: 'number', + default: 30, + }, ] diff --git a/src-ui/src/app/services/trash.service.spec.ts b/src-ui/src/app/services/trash.service.spec.ts new file mode 100644 index 000000000..7457960e5 --- /dev/null +++ b/src-ui/src/app/services/trash.service.spec.ts @@ -0,0 +1,59 @@ +import { TestBed } from '@angular/core/testing' + +import { TrashService } from './trash.service' +import { + HttpClientTestingModule, + HttpTestingController, +} from '@angular/common/http/testing' +import { environment } from 'src/environments/environment' + +describe('TrashService', () => { + let service: TrashService + let httpTestingController: HttpTestingController + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [HttpClientTestingModule], + }) + service = TestBed.inject(TrashService) + httpTestingController = TestBed.inject(HttpTestingController) + }) + + it('should call correct endpoint for getTrash', () => { + service.getTrash().subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}trash/?page=1` + ) + expect(req.request.method).toEqual('GET') + }) + + it('should call correct endpoint for emptyTrash', () => { + service.emptyTrash().subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}trash/` + ) + expect(req.request.method).toEqual('POST') + expect(req.request.body).toEqual({ action: 'empty' }) + + service.emptyTrash([1, 2, 3]).subscribe() + const req2 = httpTestingController.expectOne( + `${environment.apiBaseUrl}trash/` + ) + expect(req2.request.body).toEqual({ + action: 'empty', + documents: [1, 2, 3], + }) + }) + + it('should call correct endpoint for restoreDocuments', () => { + service.restoreDocuments([1, 2, 3]).subscribe() + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}trash/` + ) + expect(req.request.method).toEqual('POST') + expect(req.request.body).toEqual({ + action: 'restore', + documents: [1, 2, 3], + }) + }) +}) diff --git a/src-ui/src/app/services/trash.service.ts b/src-ui/src/app/services/trash.service.ts new file mode 100644 index 000000000..6a8bbf1f0 --- /dev/null +++ b/src-ui/src/app/services/trash.service.ts @@ -0,0 +1,37 @@ +import { HttpClient, HttpParams } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { Observable } from 'rxjs' +import { environment } from 'src/environments/environment' +import { Document } from '../data/document' +import { Results } from '../data/results' + +@Injectable({ + providedIn: 'root', +}) +export class TrashService { + constructor(private http: HttpClient) {} + + public getTrash(page: number = 1): Observable> { + const httpParams = new HttpParams().set('page', page.toString()) + return this.http.get>(`${environment.apiBaseUrl}trash/`, { + params: httpParams, + }) + } + + public emptyTrash(documents?: number[]): Observable { + const data = { + action: 'empty', + } + if (documents?.length) { + data['documents'] = documents + } + return this.http.post(`${environment.apiBaseUrl}trash/`, data) + } + + public restoreDocuments(documents: number[]): Observable { + return this.http.post(`${environment.apiBaseUrl}trash/`, { + action: 'restore', + documents, + }) + } +} diff --git a/src/documents/migrations/1049_document_deleted_at_document_restored_at.py b/src/documents/migrations/1049_document_deleted_at_document_restored_at.py new file mode 100644 index 000000000..39fb41353 --- /dev/null +++ b/src/documents/migrations/1049_document_deleted_at_document_restored_at.py @@ -0,0 +1,23 @@ +# Generated by Django 4.2.11 on 2024-04-23 07:56 + +from django.db import migrations +from django.db import models + + +class Migration(migrations.Migration): + dependencies = [ + ("documents", "1048_alter_savedviewfilterrule_rule_type"), + ] + + operations = [ + migrations.AddField( + model_name="document", + name="deleted_at", + field=models.DateTimeField(blank=True, null=True), + ), + migrations.AddField( + model_name="document", + name="restored_at", + field=models.DateTimeField(blank=True, null=True), + ), + ] diff --git a/src/documents/models.py b/src/documents/models.py index 12fd6f63d..8ce038600 100644 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -23,6 +23,8 @@ from multiselectfield import MultiSelectField if settings.AUDIT_LOG_ENABLED: from auditlog.registry import auditlog +from django_softdelete.models import SoftDeleteModel + from documents.data_models import DocumentSource from documents.parsers import get_default_file_extension @@ -130,7 +132,7 @@ class StoragePath(MatchingModel): verbose_name_plural = _("storage paths") -class Document(ModelWithOwner): +class Document(SoftDeleteModel, ModelWithOwner): STORAGE_TYPE_UNENCRYPTED = "unencrypted" STORAGE_TYPE_GPG = "gpg" STORAGE_TYPES = ( diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 426527183..48e26dea3 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -786,6 +786,7 @@ class DocumentSerializer( "created_date", "modified", "added", + "deleted_at", "archive_serial_number", "original_file_name", "archived_file_name", @@ -1863,3 +1864,26 @@ class WorkflowSerializer(serializers.ModelSerializer): self.prune_triggers_and_actions() return instance + + +class TrashSerializer(SerializerWithPerms): + documents = serializers.ListField( + required=False, + label="Documents", + write_only=True, + child=serializers.IntegerField(), + ) + + action = serializers.ChoiceField( + choices=["restore", "empty"], + label="Action", + write_only=True, + ) + + def validate_documents(self, documents): + count = Document.deleted_objects.filter(id__in=documents).count() + if not count == len(documents): + raise serializers.ValidationError( + "Some documents in the list have not yet been deleted.", + ) + return documents diff --git a/src/documents/signals/handlers.py b/src/documents/signals/handlers.py index 68f366f44..02f08ab31 100644 --- a/src/documents/signals/handlers.py +++ b/src/documents/signals/handlers.py @@ -301,10 +301,10 @@ def set_storage_path( document.save(update_fields=("storage_path",)) -@receiver(models.signals.post_delete, sender=Document) -def cleanup_document_deletion(sender, instance, using, **kwargs): +# see empty_trash in documents/tasks.py for signal handling +def cleanup_document_deletion(sender, instance, **kwargs): with FileLock(settings.MEDIA_LOCK): - if settings.TRASH_DIR: + if settings.EMPTY_TRASH_DIR: # Find a non-conflicting filename in case a document with the same # name was moved to trash earlier counter = 0 @@ -313,7 +313,7 @@ def cleanup_document_deletion(sender, instance, using, **kwargs): while True: new_file_path = os.path.join( - settings.TRASH_DIR, + settings.EMPTY_TRASH_DIR, old_filebase + (f"_{counter:02}" if counter else "") + old_fileext, ) diff --git a/src/documents/tasks.py b/src/documents/tasks.py index e3b2df990..5dd5c5e0f 100644 --- a/src/documents/tasks.py +++ b/src/documents/tasks.py @@ -2,6 +2,7 @@ import hashlib import logging import shutil import uuid +from datetime import timedelta from pathlib import Path from tempfile import TemporaryDirectory from typing import Optional @@ -10,8 +11,10 @@ import tqdm from celery import Task from celery import shared_task from django.conf import settings +from django.db import models from django.db import transaction from django.db.models.signals import post_save +from django.utils import timezone from filelock import FileLock from whoosh.writing import AsyncWriter @@ -41,6 +44,7 @@ from documents.plugins.base import StopConsumeTaskError from documents.plugins.helpers import ProgressStatusOptions from documents.sanity_checker import SanityCheckFailedException from documents.signals import document_updated +from documents.signals.handlers import cleanup_document_deletion if settings.AUDIT_LOG_ENABLED: import json @@ -292,3 +296,29 @@ def update_document_archive_file(document_id): ) finally: parser.cleanup() + + +@shared_task +def empty_trash(doc_ids=None): + documents = ( + Document.deleted_objects.filter(id__in=doc_ids) + if doc_ids is not None + else Document.deleted_objects.filter( + deleted_at__lt=timezone.localtime(timezone.now()) + - timedelta( + days=settings.EMPTY_TRASH_DELAY, + ), + ) + ) + + try: + # Temporarily connect the cleanup handler + models.signals.post_delete.connect(cleanup_document_deletion, sender=Document) + documents.delete() # this is effectively a hard delete + except Exception as e: # pragma: no cover + logger.exception(f"Error while emptying trash: {e}") + finally: + models.signals.post_delete.disconnect( + cleanup_document_deletion, + sender=Document, + ) diff --git a/src/documents/tests/test_api_trash.py b/src/documents/tests/test_api_trash.py new file mode 100644 index 000000000..90d78610f --- /dev/null +++ b/src/documents/tests/test_api_trash.py @@ -0,0 +1,155 @@ +from django.contrib.auth.models import User +from django.core.cache import cache +from rest_framework import status +from rest_framework.test import APITestCase + +from documents.models import Document + + +class TestTrashAPI(APITestCase): + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_authenticate(user=self.user) + cache.clear() + + def test_api_trash(self): + """ + GIVEN: + - Existing document + WHEN: + - API request to delete document + - API request to restore document + - API request to empty trash + THEN: + - Document is moved to trash + - Document is restored from trash + - Trash is emptied + """ + + document = Document.objects.create( + title="Title", + content="content", + checksum="checksum", + mime_type="application/pdf", + ) + + self.client.force_login(user=self.user) + self.client.delete(f"/api/documents/{document.pk}/") + self.assertEqual(Document.objects.count(), 0) + self.assertEqual(Document.global_objects.count(), 1) + self.assertEqual(Document.deleted_objects.count(), 1) + + resp = self.client.get("/api/trash/") + self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.data["count"], 1) + + resp = self.client.post( + "/api/trash/", + {"action": "restore", "documents": [document.pk]}, + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(Document.objects.count(), 1) + + resp = self.client.get("/api/trash/") + self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(resp.data["count"], 0) + + self.client.delete(f"/api/documents/{document.pk}/") + resp = self.client.post( + "/api/trash/", + {"action": "empty", "documents": [document.pk]}, + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(Document.global_objects.count(), 0) + + def test_trash_api_empty_all(self): + """ + GIVEN: + - Existing documents in trash + WHEN: + - API request to empty trash + THEN: + - Trash is emptied + """ + + document = Document.objects.create( + title="Title", + content="content", + checksum="checksum", + mime_type="application/pdf", + ) + document.delete() + document2 = Document.objects.create( + title="Title2", + content="content2", + checksum="checksum2", + mime_type="application/pdf", + ) + document2.delete() + + self.client.force_login(user=self.user) + resp = self.client.post( + "/api/trash/", + {"action": "empty", "documents": []}, + ) + self.assertEqual(resp.status_code, status.HTTP_200_OK) + self.assertEqual(Document.global_objects.count(), 0) + + def test_api_trash_insufficient_permissions(self): + """ + GIVEN: + - Existing document with owner = user2 in trash + WHEN: + - user 1 makes API request to empty document from trash + THEN: + - 403 Forbidden + """ + + user1 = User.objects.create_user(username="user1") + self.client.force_authenticate(user=user1) + self.client.force_login(user=user1) + user2 = User.objects.create_user(username="user2") + document = Document.objects.create( + title="Title", + content="content", + checksum="checksum", + mime_type="application/pdf", + owner=user2, + ) + document.delete() + + resp = self.client.post( + "/api/trash/", + {"action": "empty", "documents": [document.pk]}, + ) + self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN) + self.assertEqual(Document.global_objects.count(), 1) + + def test_api_trash_invalid_params(self): + """ + GIVEN: + - Existing documents + WHEN: + - API request to trash with invalid params + THEN: + - 400 Bad Request + """ + + document = Document.objects.create( + title="Title", + content="content", + checksum="checksum", + mime_type="application/pdf", + ) + + self.client.force_login(user=self.user) + + # document isn't in trash + resp = self.client.post( + "/api/trash/", + {"action": "restore", "documents": [document.pk]}, + ) + self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) + self.assertIn("have not yet been deleted", resp.data["documents"][0]) diff --git a/src/documents/tests/test_api_uisettings.py b/src/documents/tests/test_api_uisettings.py index 0a52ea41c..65dee7d6d 100644 --- a/src/documents/tests/test_api_uisettings.py +++ b/src/documents/tests/test_api_uisettings.py @@ -40,6 +40,7 @@ class TestApiUiSettings(DirectoriesMixin, APITestCase): "app_title": None, "app_logo": None, "auditlog_enabled": True, + "trash_delay": 30, "update_checking": { "backend_setting": "default", }, diff --git a/src/documents/tests/test_document_model.py b/src/documents/tests/test_document_model.py index 68539e5dd..eca08f82a 100644 --- a/src/documents/tests/test_document_model.py +++ b/src/documents/tests/test_document_model.py @@ -10,6 +10,7 @@ from django.utils import timezone from documents.models import Correspondent from documents.models import Document +from documents.tasks import empty_trash class TestDocument(TestCase): @@ -43,10 +44,39 @@ class TestDocument(TestCase): with mock.patch("documents.signals.handlers.os.unlink") as mock_unlink: document.delete() + empty_trash([document.pk]) mock_unlink.assert_any_call(file_path) mock_unlink.assert_any_call(thumb_path) self.assertEqual(mock_unlink.call_count, 2) + def test_document_soft_delete(self): + document = Document.objects.create( + correspondent=Correspondent.objects.create(name="Test0"), + title="Title", + content="content", + checksum="checksum", + mime_type="application/pdf", + ) + + file_path = document.source_path + thumb_path = document.thumbnail_path + + Path(file_path).touch() + Path(thumb_path).touch() + + with mock.patch("documents.signals.handlers.os.unlink") as mock_unlink: + document.delete() + self.assertEqual(mock_unlink.call_count, 0) + + self.assertEqual(Document.objects.count(), 0) + + document.restore(strict=False) + self.assertEqual(Document.objects.count(), 1) + + document.delete() + empty_trash([document.pk]) + self.assertEqual(mock_unlink.call_count, 2) + def test_file_name(self): doc = Document( mime_type="application/pdf", diff --git a/src/documents/tests/test_file_handling.py b/src/documents/tests/test_file_handling.py index 2f085f2ce..dd2c59f07 100644 --- a/src/documents/tests/test_file_handling.py +++ b/src/documents/tests/test_file_handling.py @@ -19,6 +19,7 @@ from documents.models import Correspondent from documents.models import Document from documents.models import DocumentType from documents.models import StoragePath +from documents.tasks import empty_trash from documents.tests.utils import DirectoriesMixin from documents.tests.utils import FileSystemAssertsMixin @@ -169,6 +170,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): # Ensure that filename is properly generated document.filename = generate_filename(document) + document.save() self.assertEqual(document.filename, "none/none.pdf") create_source_path_directory(document.source_path) @@ -176,6 +178,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): # Ensure file deletion after delete document.delete() + empty_trash([document.pk]) self.assertIsNotFile( os.path.join(settings.ORIGINALS_DIR, "none", "none.pdf"), ) @@ -183,9 +186,9 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): @override_settings( FILENAME_FORMAT="{correspondent}/{correspondent}", - TRASH_DIR=tempfile.mkdtemp(), + EMPTY_TRASH_DIR=tempfile.mkdtemp(), ) - def test_document_delete_trash(self): + def test_document_delete_trash_dir(self): document = Document() document.mime_type = "application/pdf" document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED @@ -193,20 +196,22 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): # Ensure that filename is properly generated document.filename = generate_filename(document) + document.save() self.assertEqual(document.filename, "none/none.pdf") create_source_path_directory(document.source_path) Path(document.source_path).touch() # Ensure file was moved to trash after delete - self.assertIsNotFile(os.path.join(settings.TRASH_DIR, "none", "none.pdf")) + self.assertIsNotFile(os.path.join(settings.EMPTY_TRASH_DIR, "none", "none.pdf")) document.delete() + empty_trash([document.pk]) self.assertIsNotFile( os.path.join(settings.ORIGINALS_DIR, "none", "none.pdf"), ) self.assertIsNotDir(os.path.join(settings.ORIGINALS_DIR, "none")) - self.assertIsFile(os.path.join(settings.TRASH_DIR, "none.pdf")) - self.assertIsNotFile(os.path.join(settings.TRASH_DIR, "none_01.pdf")) + self.assertIsFile(os.path.join(settings.EMPTY_TRASH_DIR, "none.pdf")) + self.assertIsNotFile(os.path.join(settings.EMPTY_TRASH_DIR, "none_01.pdf")) # Create an identical document and ensure it is trashed under a new name document = Document() @@ -214,10 +219,12 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED document.save() document.filename = generate_filename(document) + document.save() create_source_path_directory(document.source_path) Path(document.source_path).touch() document.delete() - self.assertIsFile(os.path.join(settings.TRASH_DIR, "none_01.pdf")) + empty_trash([document.pk]) + self.assertIsFile(os.path.join(settings.EMPTY_TRASH_DIR, "none_01.pdf")) @override_settings(FILENAME_FORMAT="{correspondent}/{correspondent}") def test_document_delete_nofile(self): @@ -227,6 +234,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): document.save() document.delete() + empty_trash([document.pk]) @override_settings(FILENAME_FORMAT="{correspondent}/{correspondent}") def test_directory_not_empty(self): @@ -436,6 +444,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): # Ensure that filename is properly generated document.filename = generate_filename(document) + document.save() self.assertEqual(document.filename, "none/none/none.pdf") create_source_path_directory(document.source_path) Path(document.source_path).touch() @@ -444,6 +453,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): self.assertIsDir(os.path.join(settings.ORIGINALS_DIR, "none/none")) document.delete() + empty_trash([document.pk]) self.assertIsNotFile( os.path.join(settings.ORIGINALS_DIR, "none/none/none.pdf"), @@ -550,6 +560,7 @@ class TestFileHandling(DirectoriesMixin, FileSystemAssertsMixin, TestCase): self.assertEqual(document2.filename, "qwe_01.pdf") document.delete() + empty_trash([document.pk]) self.assertIsNotFile(document.source_path) @@ -819,6 +830,7 @@ class TestFileHandlingWithArchive(DirectoriesMixin, FileSystemAssertsMixin, Test self.assertIsFile(doc.archive_path) doc.delete() + empty_trash([doc.pk]) self.assertIsNotFile(original) self.assertIsNotFile(archive) @@ -854,6 +866,7 @@ class TestFileHandlingWithArchive(DirectoriesMixin, FileSystemAssertsMixin, Test self.assertIsFile(doc2.source_path) doc2.delete() + empty_trash([doc2.pk]) self.assertIsFile(doc1.source_path) self.assertIsFile(doc1.archive_path) diff --git a/src/documents/tests/test_tasks.py b/src/documents/tests/test_tasks.py index 334345b6a..a1d21b532 100644 --- a/src/documents/tests/test_tasks.py +++ b/src/documents/tests/test_tasks.py @@ -1,4 +1,5 @@ import os +from datetime import timedelta from unittest import mock from django.conf import settings @@ -150,3 +151,36 @@ class TestBulkUpdate(DirectoriesMixin, TestCase): ) tasks.bulk_update_documents([doc1.pk]) + + +class TestEmptyTrashTask(DirectoriesMixin, FileSystemAssertsMixin, TestCase): + """ + GIVEN: + - Existing document in trash + WHEN: + - Empty trash task is called without doc_ids + THEN: + - Document is only deleted if it has been in trash for more than delay (default 30 days) + """ + + def test_empty_trash(self): + doc = Document.objects.create( + title="test", + content="my document", + checksum="wow", + added=timezone.now(), + created=timezone.now(), + modified=timezone.now(), + ) + + doc.delete() + self.assertEqual(Document.global_objects.count(), 1) + self.assertEqual(Document.objects.count(), 0) + tasks.empty_trash() + self.assertEqual(Document.global_objects.count(), 1) + + doc.deleted_at = timezone.now() - timedelta(days=31) + doc.save() + + tasks.empty_trash() + self.assertEqual(Document.global_objects.count(), 0) diff --git a/src/documents/views.py b/src/documents/views.py index 72414d4f0..affda436c 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -142,12 +142,14 @@ from documents.serialisers import StoragePathSerializer from documents.serialisers import TagSerializer from documents.serialisers import TagSerializerVersion1 from documents.serialisers import TasksViewSerializer +from documents.serialisers import TrashSerializer from documents.serialisers import UiSettingsViewSerializer from documents.serialisers import WorkflowActionSerializer from documents.serialisers import WorkflowSerializer from documents.serialisers import WorkflowTriggerSerializer from documents.signals import document_updated from documents.tasks import consume_file +from documents.tasks import empty_trash from paperless import version from paperless.celery import app as celery_app from paperless.config import GeneralConfig @@ -1557,6 +1559,8 @@ class UiSettingsView(GenericAPIView): "backend_setting": settings.ENABLE_UPDATE_CHECK, } + ui_settings["trash_delay"] = settings.EMPTY_TRASH_DELAY + general_config = GeneralConfig() ui_settings["app_title"] = settings.APP_TITLE @@ -2050,3 +2054,41 @@ class SystemStatusView(PassUserMixin): }, }, ) + + +class TrashView(ListModelMixin, PassUserMixin): + permission_classes = (IsAuthenticated,) + serializer_class = TrashSerializer + filter_backends = (ObjectOwnedOrGrantedPermissionsFilter,) + pagination_class = StandardPagination + + model = Document + + queryset = Document.deleted_objects.all() + + def get(self, request, format=None): + self.serializer_class = DocumentSerializer + return self.list(request, format) + + def post(self, request, *args, **kwargs): + serializer = self.get_serializer(data=request.data) + serializer.is_valid(raise_exception=True) + + doc_ids = serializer.validated_data.get("documents") + docs = ( + Document.global_objects.filter(id__in=doc_ids) + if doc_ids is not None + else Document.deleted_objects.all() + ) + for doc in docs: + if not has_perms_owner_aware(request.user, "delete_document", doc): + return HttpResponseForbidden("Insufficient permissions") + action = serializer.validated_data.get("action") + if action == "restore": + for doc in Document.deleted_objects.filter(id__in=doc_ids).all(): + doc.restore(strict=False) + elif action == "empty": + if doc_ids is None: + doc_ids = [doc.id for doc in docs] + empty_trash(doc_ids=doc_ids) + return Response({"result": "OK", "doc_ids": doc_ids}) diff --git a/src/paperless/checks.py b/src/paperless/checks.py index cbc8da5cf..4ba322666 100644 --- a/src/paperless/checks.py +++ b/src/paperless/checks.py @@ -62,7 +62,7 @@ def paths_check(app_configs, **kwargs): return ( path_check("PAPERLESS_DATA_DIR", settings.DATA_DIR) - + path_check("PAPERLESS_TRASH_DIR", settings.TRASH_DIR) + + path_check("PAPERLESS_EMPTY_TRASH_DIR", settings.EMPTY_TRASH_DIR) + path_check("PAPERLESS_MEDIA_ROOT", settings.MEDIA_ROOT) + path_check("PAPERLESS_CONSUMPTION_DIR", settings.CONSUMPTION_DIR) ) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index c4e70f68a..d941b7572 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -207,6 +207,17 @@ def _parse_beat_schedule() -> dict: "expires": ((7.0 * 24.0) - 1.0) * 60.0 * 60.0, }, }, + { + "name": "Empty trash", + "env_key": "PAPERLESS_EMPTY_TRASH_TASK_CRON", + # Default daily at 01:00 + "env_default": "0 1 * * *", + "task": "documents.tasks.empty_trash", + "options": { + # 1 hour before default schedule sends again + "expires": 23.0 * 60.0 * 60.0, + }, + }, ] for task in tasks: # Either get the environment setting or use the default @@ -250,7 +261,11 @@ DATA_DIR = __get_path("PAPERLESS_DATA_DIR", BASE_DIR.parent / "data") NLTK_DIR = __get_path("PAPERLESS_NLTK_DIR", "/usr/share/nltk_data") -TRASH_DIR = os.getenv("PAPERLESS_TRASH_DIR") +# Check deprecated setting first +EMPTY_TRASH_DIR = os.getenv( + "PAPERLESS_TRASH_DIR", + os.getenv("PAPERLESS_EMPTY_TRASH_DIR"), +) # Lock file for synchronizing changes to the MEDIA directory across multiple # threads. @@ -1148,3 +1163,9 @@ EMAIL_SUBJECT_PREFIX: Final[str] = "[Paperless-ngx] " if DEBUG: # pragma: no cover EMAIL_BACKEND = "django.core.mail.backends.filebased.EmailBackend" EMAIL_FILE_PATH = BASE_DIR / "sent_emails" + + +############################################################################### +# Soft Delete +############################################################################### +EMPTY_TRASH_DELAY = max(__get_int("PAPERLESS_EMPTY_TRASH_DELAY", 30), 1) diff --git a/src/paperless/tests/test_settings.py b/src/paperless/tests/test_settings.py index 0051d40e7..511148523 100644 --- a/src/paperless/tests/test_settings.py +++ b/src/paperless/tests/test_settings.py @@ -156,6 +156,7 @@ class TestCeleryScheduleParsing(TestCase): CLASSIFIER_EXPIRE_TIME = 59.0 * 60.0 INDEX_EXPIRE_TIME = 23.0 * 60.0 * 60.0 SANITY_EXPIRE_TIME = ((7.0 * 24.0) - 1.0) * 60.0 * 60.0 + EMPTY_TRASH_EXPIRE_TIME = 23.0 * 60.0 * 60.0 def test_schedule_configuration_default(self): """ @@ -190,6 +191,11 @@ class TestCeleryScheduleParsing(TestCase): "schedule": crontab(minute=30, hour=0, day_of_week="sun"), "options": {"expires": self.SANITY_EXPIRE_TIME}, }, + "Empty trash": { + "task": "documents.tasks.empty_trash", + "schedule": crontab(minute=0, hour="1"), + "options": {"expires": self.EMPTY_TRASH_EXPIRE_TIME}, + }, }, schedule, ) @@ -232,6 +238,11 @@ class TestCeleryScheduleParsing(TestCase): "schedule": crontab(minute=30, hour=0, day_of_week="sun"), "options": {"expires": self.SANITY_EXPIRE_TIME}, }, + "Empty trash": { + "task": "documents.tasks.empty_trash", + "schedule": crontab(minute=0, hour="1"), + "options": {"expires": self.EMPTY_TRASH_EXPIRE_TIME}, + }, }, schedule, ) @@ -266,6 +277,11 @@ class TestCeleryScheduleParsing(TestCase): "schedule": crontab(minute=30, hour=0, day_of_week="sun"), "options": {"expires": self.SANITY_EXPIRE_TIME}, }, + "Empty trash": { + "task": "documents.tasks.empty_trash", + "schedule": crontab(minute=0, hour="1"), + "options": {"expires": self.EMPTY_TRASH_EXPIRE_TIME}, + }, }, schedule, ) @@ -286,6 +302,7 @@ class TestCeleryScheduleParsing(TestCase): "PAPERLESS_TRAIN_TASK_CRON": "disable", "PAPERLESS_SANITY_TASK_CRON": "disable", "PAPERLESS_INDEX_TASK_CRON": "disable", + "PAPERLESS_EMPTY_TRASH_TASK_CRON": "disable", }, ): schedule = _parse_beat_schedule() diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 8626cc8b1..4de9f3662 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -36,6 +36,7 @@ from documents.views import StoragePathViewSet from documents.views import SystemStatusView from documents.views import TagViewSet from documents.views import TasksViewSet +from documents.views import TrashView from documents.views import UiSettingsView from documents.views import UnifiedSearchViewSet from documents.views import WorkflowActionViewSet @@ -159,6 +160,11 @@ urlpatterns = [ SystemStatusView.as_view(), name="system_status", ), + re_path( + "^trash/", + TrashView.as_view(), + name="trash", + ), *api_router.urls, ], ),