Enhancement: support delete originals after split / merge (#6935)

--------- Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
2025-07-30 18:27:45 -05:00 · 2024-06-08 18:56:25 +02:00
parent 81e4092f53
commit d1ac15baa9
16 changed files with 354 additions and 32 deletions
--- a/src-ui/messages.xlf
+++ b/src-ui/messages.xlf
@@ -2302,11 +2302,11 @@
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1151</context>
+          <context context-type="linenumber">1152</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1192</context>
+          <context context-type="linenumber">1193</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.ts</context>
@@ -2970,11 +2970,18 @@
          <context context-type="linenumber">24</context>
        </context-group>
      </trans-unit>
+      <trans-unit id="5612366187076076264" datatype="html">
+        <source>Delete original documents after successful merge</source>
+        <context-group purpose="location">
+          <context context-type="sourcefile">src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.html</context>
+          <context context-type="linenumber">32</context>
+        </context-group>
+      </trans-unit>
      <trans-unit id="5138283234724909648" datatype="html">
        <source>Note that only PDFs will be included.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.html</context>
-          <context context-type="linenumber">30</context>
+          <context context-type="linenumber">34</context>
        </context-group>
      </trans-unit>
      <trans-unit id="8157388568390631653" datatype="html">
@@ -2991,6 +2998,13 @@
          <context context-type="linenumber">28</context>
        </context-group>
      </trans-unit>
+      <trans-unit id="492847770415850840" datatype="html">
+        <source>Delete original document after successful split</source>
+        <context-group purpose="location">
+          <context context-type="sourcefile">src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.html</context>
+          <context context-type="linenumber">49</context>
+        </context-group>
+      </trans-unit>
      <trans-unit id="2509141182388535183" datatype="html">
        <source>View</source>
        <context-group purpose="location">
@@ -5475,7 +5489,7 @@
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1169</context>
+          <context context-type="linenumber">1170</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/guards/dirty-saved-view.guard.ts</context>
@@ -5957,21 +5971,21 @@
        <source>Split operation will begin in the background.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1128</context>
+          <context context-type="linenumber">1129</context>
        </context-group>
      </trans-unit>
      <trans-unit id="3235014591864339926" datatype="html">
        <source>Error executing split operation</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1137</context>
+          <context context-type="linenumber">1138</context>
        </context-group>
      </trans-unit>
      <trans-unit id="6555329262222566158" datatype="html">
        <source>Rotate confirm</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1149</context>
+          <context context-type="linenumber">1150</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.ts</context>
@@ -5982,49 +5996,49 @@
        <source>This operation will permanently rotate the original version of the current document.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1150</context>
+          <context context-type="linenumber">1151</context>
        </context-group>
      </trans-unit>
      <trans-unit id="4069543875319587651" datatype="html">
        <source>Rotation will begin in the background. Close and re-open the document after the operation has completed to see the changes.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1166</context>
+          <context context-type="linenumber">1167</context>
        </context-group>
      </trans-unit>
      <trans-unit id="2962674215361798818" datatype="html">
        <source>Error executing rotate operation</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1178</context>
+          <context context-type="linenumber">1179</context>
        </context-group>
      </trans-unit>
      <trans-unit id="3539261415918606512" datatype="html">
        <source>Delete pages confirm</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1190</context>
+          <context context-type="linenumber">1191</context>
        </context-group>
      </trans-unit>
      <trans-unit id="5854352498125813866" datatype="html">
        <source>This operation will permanently delete the selected pages from the original document.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1191</context>
+          <context context-type="linenumber">1192</context>
        </context-group>
      </trans-unit>
      <trans-unit id="8617528702531167646" datatype="html">
        <source>Delete pages operation will begin in the background. Close and re-open or reload this document after the operation has completed to see the changes.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1206</context>
+          <context context-type="linenumber">1207</context>
        </context-group>
      </trans-unit>
      <trans-unit id="1249139200486584973" datatype="html">
        <source>Error executing delete pages operation</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
-          <context context-type="linenumber">1215</context>
+          <context context-type="linenumber">1216</context>
        </context-group>
      </trans-unit>
      <trans-unit id="4958946940233632319" datatype="html">
@@ -6417,7 +6431,7 @@
        <source>Merged document will be queued for consumption.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.ts</context>
-          <context context-type="linenumber">819</context>
+          <context context-type="linenumber">822</context>
        </context-group>
      </trans-unit>
      <trans-unit id="2784168796433474565" datatype="html">
--- a/src-ui/src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.html
+++ b/src-ui/src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.html
@@ -27,6 +27,10 @@
            }
        </select>
    </div>
+    <div class="form-check form-switch mt-4">
+      <input class="form-check-input" type="checkbox" role="switch" id="deleteOriginalsSwitch" [(ngModel)]="deleteOriginals" [disabled]="!userOwnsAllDocuments">
+      <label class="form-check-label" for="deleteOriginalsSwitch" i18n>Delete original documents after successful merge</label>
+    </div>
    <p class="small text-muted fst-italic mt-4" i18n>Note that only PDFs will be included.</p>
 </div>
 <div class="modal-footer">
--- a/src-ui/src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.ts
+++ b/src-ui/src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.ts
@@ -2,6 +2,7 @@ import { Component, OnInit } from '@angular/core'
 import { ConfirmDialogComponent } from '../confirm-dialog.component'
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { DocumentService } from 'src/app/services/rest/document.service'
+import { PermissionsService } from 'src/app/services/permissions.service'
 import { CdkDragDrop, moveItemInArray } from '@angular/cdk/drag-drop'
 import { Subject, takeUntil } from 'rxjs'
 import { Document } from 'src/app/data/document'
@@ -16,6 +17,7 @@ export class MergeConfirmDialogComponent
  implements OnInit
 {
  public documentIDs: number[] = []
+  public deleteOriginals: boolean = false
  private _documents: Document[] = []
  get documents(): Document[] {
    return this._documents
@@ -27,7 +29,8 @@ export class MergeConfirmDialogComponent

  constructor(
    activeModal: NgbActiveModal,
-    private documentService: DocumentService
+    private documentService: DocumentService,
+    private permissionService: PermissionsService
  ) {
    super(activeModal)
  }
@@ -48,4 +51,10 @@ export class MergeConfirmDialogComponent
  getDocument(documentID: number): Document {
    return this.documents.find((d) => d.id === documentID)
  }
+
+  get userOwnsAllDocuments(): boolean {
+    return this.documents.every((d) =>
+      this.permissionService.currentUserOwnsObject(d)
+    )
+  }
 }
--- a/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.html
+++ b/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.html
@@ -44,6 +44,10 @@
            </ul>
        </div>
    </div>
+    <div class="form-check form-switch mt-4">
+       <input class="form-check-input" type="checkbox" role="switch" id="deleteOriginalSwitch" [(ngModel)]="deleteOriginal" [disabled]="!userOwnsDocument">
+       <label class="form-check-label" for="deleteOriginalSwitch" i18n>Delete original document after successful split</label>
+     </div>
 </div>
 <div class="modal-footer">
    <button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
--- a/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.spec.ts
+++ b/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.spec.ts
@@ -7,6 +7,7 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 import { DocumentService } from 'src/app/services/rest/document.service'
 import { PdfViewerModule } from 'ng2-pdf-viewer'
+import { of } from 'rxjs'

 describe('SplitConfirmDialogComponent', () => {
  let component: SplitConfirmDialogComponent
@@ -32,6 +33,14 @@ describe('SplitConfirmDialogComponent', () => {
    fixture.detectChanges()
  })

+  it('should load document on init', () => {
+    const getSpy = jest.spyOn(documentService, 'get')
+    component.documentID = 1
+    getSpy.mockReturnValue(of({ id: 1 } as any))
+    component.ngOnInit()
+    expect(documentService.get).toHaveBeenCalledWith(1)
+  })
+
  it('should update pagesString when pages are added', () => {
    component.totalPages = 5
    component.page = 2
--- a/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.ts
+++ b/src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.ts
@@ -1,7 +1,9 @@
-import { Component } from '@angular/core'
+import { Component, OnInit } from '@angular/core'
 import { ConfirmDialogComponent } from '../confirm-dialog.component'
+import { Document } from 'src/app/data/document'
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { DocumentService } from 'src/app/services/rest/document.service'
+import { PermissionsService } from 'src/app/services/permissions.service'
 import { PDFDocumentProxy } from 'ng2-pdf-viewer'

@Component({
@@ -9,7 +11,10 @@ import { PDFDocumentProxy } from 'ng2-pdf-viewer'
  templateUrl: './split-confirm-dialog.component.html',
  styleUrl: './split-confirm-dialog.component.scss',
 })
-export class SplitConfirmDialogComponent extends ConfirmDialogComponent {
+export class SplitConfirmDialogComponent
+  extends ConfirmDialogComponent
+  implements OnInit
+{
  public get pagesString(): string {
    let pagesStr = ''

@@ -32,8 +37,10 @@ export class SplitConfirmDialogComponent extends ConfirmDialogComponent {
  private pages: Set<number> = new Set()

  public documentID: number
+  private document: Document
  public page: number = 1
  public totalPages: number
+  public deleteOriginal: boolean = false

  public get pdfSrc(): string {
    return this.documentService.getPreviewUrl(this.documentID)
@@ -41,12 +48,19 @@ export class SplitConfirmDialogComponent extends ConfirmDialogComponent {

  constructor(
    activeModal: NgbActiveModal,
-    private documentService: DocumentService
+    private documentService: DocumentService,
+    private permissionService: PermissionsService
  ) {
    super(activeModal)
    this.confirmButtonEnabled = this.pages.size > 0
  }

+  ngOnInit(): void {
+    this.documentService.get(this.documentID).subscribe((r) => {
+      this.document = r
+    })
+  }
+
  pdfPreviewLoaded(pdf: PDFDocumentProxy) {
    this.totalPages = pdf.numPages
  }
@@ -63,4 +77,8 @@ export class SplitConfirmDialogComponent extends ConfirmDialogComponent {
    this.pages.delete(page)
    this.confirmButtonEnabled = this.pages.size > 0
  }
+
+  get userOwnsDocument(): boolean {
+    return this.permissionService.currentUserOwnsObject(this.document)
+  }
 }
--- a/src-ui/src/app/components/document-detail/document-detail.component.spec.ts
+++ b/src-ui/src/app/components/document-detail/document-detail.component.spec.ts
@@ -1099,7 +1099,7 @@ describe('DocumentDetailComponent', () => {
    expect(req.request.body).toEqual({
      documents: [doc.id],
      method: 'split',
-      parameters: { pages: '1-2,3-5' },
+      parameters: { pages: '1-2,3-5', delete_originals: false },
    })
    req.error(new ProgressEvent('failed'))
    modal.componentInstance.confirm()
--- a/src-ui/src/app/components/document-detail/document-detail.component.ts
+++ b/src-ui/src/app/components/document-detail/document-detail.component.ts
@@ -1120,6 +1120,7 @@ export class DocumentDetailComponent
        this.documentsService
          .bulkEdit([this.document.id], 'split', {
            pages: modal.componentInstance.pagesString,
+            delete_originals: modal.componentInstance.deleteOriginal,
          })
          .pipe(first(), takeUntil(this.unsubscribeNotifier))
          .subscribe({
--- 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
@@ -1056,6 +1056,25 @@ describe('BulkEditorComponent', () => {
    httpTestingController.match(
      `${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
    ) // listAllFilteredIds
+
+    // Test with Delete Originals enabled
+    modal.componentInstance.deleteOriginals = true
+    modal.componentInstance.confirm()
+    req = httpTestingController.expectOne(
+      `${environment.apiBaseUrl}documents/bulk_edit/`
+    )
+    req.flush(true)
+    expect(req.request.body).toEqual({
+      documents: [3, 4],
+      method: 'merge',
+      parameters: { metadata_document_id: 3, delete_originals: true },
+    })
+    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
  })

  it('should support bulk download with archive, originals or both and file formatting', () => {
--- 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
@@ -813,6 +813,9 @@ export class BulkEditorComponent
        if (mergeDialog.metadataDocumentID > -1) {
          args['metadata_document_id'] = mergeDialog.metadataDocumentID
        }
+        if (mergeDialog.deleteOriginals) {
+          args['delete_originals'] = true
+        }
        mergeDialog.buttonsEnabled = false
        this.executeBulkOperation(modal, 'merge', args, mergeDialog.documentIDs)
        this.toastService.showInfo(