+ private checks: HTMLElement[] = []
+
+ public get pagesString(): string {
+ return this.pages.join(', ')
+ }
+
+ public get pdfSrc(): string {
+ return this.documentService.getPreviewUrl(this.documentID)
+ }
+
+ constructor(
+ activeModal: NgbActiveModal,
+ private documentService: DocumentService
+ ) {
+ super(activeModal)
+ }
+
+ public pdfPreviewLoaded(pdf: PDFDocumentProxy) {
+ this.totalPages = pdf.numPages
+ }
+
+ pageRendered(event: CustomEvent) {
+ const pageDiv = event.target as HTMLDivElement
+ const check = this.pageCheckOverlay.createEmbeddedView({
+ page: event.detail.pageNumber,
+ })
+ this.checks[event.detail.pageNumber - 1] = check.rootNodes[0]
+ pageDiv?.insertBefore(check.rootNodes[0], pageDiv.firstChild)
+ this.updateChecks()
+ }
+
+ pageCheckChanged(pageNumber: number) {
+ if (!this.pages.includes(pageNumber)) this.pages.push(pageNumber)
+ else if (this.pages.includes(pageNumber))
+ this.pages.splice(this.pages.indexOf(pageNumber), 1)
+ this.updateChecks()
+ }
+
+ private updateChecks() {
+ this.checks.forEach((check, i) => {
+ const input = check.getElementsByTagName('input')[0]
+ input.checked = this.pages.includes(i + 1)
+ })
+ }
+}
diff --git a/src-ui/src/app/components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component.html b/src-ui/src/app/components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component.html
index 00e8996d0..e996ecb44 100644
--- a/src-ui/src/app/components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component.html
+++ b/src-ui/src/app/components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component.html
@@ -21,21 +21,19 @@
-
-
- @if (messageBold) {
-
{{messageBold}}
- }
- @if (message) {
-
- }
-
-
Note that only PDFs will be rotated.
}
-
} @else {
- @switch (contentRenderType) {
+ @switch (archiveContentRenderType) {
@case (ContentRenderType.PDF) {
@if (!useNativePdfViewer) {
diff --git 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
index d27c13ef1..b8a6389f2 100644
--- 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
@@ -81,6 +81,7 @@ import { environment } from 'src/environments/environment'
import { RotateConfirmDialogComponent } from '../common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component'
import { SplitConfirmDialogComponent } from '../common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component'
import { PdfViewerModule } from 'ng2-pdf-viewer'
+import { DeletePagesConfirmDialogComponent } from '../common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component'
const doc: Document = {
id: 3,
@@ -178,6 +179,7 @@ describe('DocumentDetailComponent', () => {
CustomFieldsDropdownComponent,
SplitConfirmDialogComponent,
RotateConfirmDialogComponent,
+ DeletePagesConfirmDialogComponent,
],
providers: [
DocumentTitlePipe,
@@ -1035,7 +1037,9 @@ describe('DocumentDetailComponent', () => {
component.metadata = { has_archive_version: true }
initNormally()
fixture.detectChanges()
- expect(component.contentRenderType).toEqual(component.ContentRenderType.PDF)
+ expect(component.archiveContentRenderType).toEqual(
+ component.ContentRenderType.PDF
+ )
expect(
fixture.debugElement.query(By.css('pdf-viewer-container'))
).not.toBeUndefined()
@@ -1045,7 +1049,7 @@ describe('DocumentDetailComponent', () => {
original_mime_type: 'text/plain',
}
fixture.detectChanges()
- expect(component.contentRenderType).toEqual(
+ expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Text
)
expect(
@@ -1057,7 +1061,7 @@ describe('DocumentDetailComponent', () => {
original_mime_type: 'image/jpg',
}
fixture.detectChanges()
- expect(component.contentRenderType).toEqual(
+ expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Image
)
expect(
@@ -1070,7 +1074,7 @@ describe('DocumentDetailComponent', () => {
'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
}
fixture.detectChanges()
- expect(component.contentRenderType).toEqual(
+ expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Other
)
expect(
@@ -1130,6 +1134,31 @@ describe('DocumentDetailComponent', () => {
req.flush(true)
})
+ it('should support delete pages', () => {
+ let modal: NgbModalRef
+ modalService.activeInstances.subscribe((m) => (modal = m[0]))
+ initNormally()
+ component.deletePages()
+ expect(modal).not.toBeUndefined()
+ modal.componentInstance.documentID = doc.id
+ modal.componentInstance.pages = [1, 2]
+ modal.componentInstance.confirm()
+ let req = httpTestingController.expectOne(
+ `${environment.apiBaseUrl}documents/bulk_edit/`
+ )
+ expect(req.request.body).toEqual({
+ documents: [doc.id],
+ method: 'delete_pages',
+ parameters: { pages: [1, 2] },
+ })
+ req.error(new ProgressEvent('failed'))
+ modal.componentInstance.confirm()
+ req = httpTestingController.expectOne(
+ `${environment.apiBaseUrl}documents/bulk_edit/`
+ )
+ req.flush(true)
+ })
+
it('should support keyboard shortcuts', () => {
initNormally()
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 820d7fbd5..23753f55b 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
@@ -68,6 +68,7 @@ import { CustomFieldInstance } from 'src/app/data/custom-field-instance'
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
import { SplitConfirmDialogComponent } from '../common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component'
import { RotateConfirmDialogComponent } from '../common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component'
+import { DeletePagesConfirmDialogComponent } from '../common/confirm-dialog/delete-pages-confirm-dialog/delete-pages-confirm-dialog.component'
import { HotKeyService } from 'src/app/services/hot-key.service'
import { PDFDocumentProxy } from 'ng2-pdf-viewer'
@@ -216,19 +217,27 @@ export class DocumentDetailComponent
return this.settings.get(SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER)
}
- get contentRenderType(): ContentRenderType {
- if (!this.metadata) return ContentRenderType.Unknown
- const contentType = this.metadata?.has_archive_version
- ? 'application/pdf'
- : this.metadata?.original_mime_type
+ get archiveContentRenderType(): ContentRenderType {
+ return this.getRenderType(
+ this.metadata?.has_archive_version
+ ? 'application/pdf'
+ : this.metadata?.original_mime_type
+ )
+ }
- if (contentType === 'application/pdf') {
+ get originalContentRenderType(): ContentRenderType {
+ return this.getRenderType(this.metadata?.original_mime_type)
+ }
+
+ private getRenderType(mimeType: string): ContentRenderType {
+ if (!mimeType) return ContentRenderType.Unknown
+ if (mimeType === 'application/pdf') {
return ContentRenderType.PDF
} else if (
- ['text/plain', 'application/csv', 'text/csv'].includes(contentType)
+ ['text/plain', 'application/csv', 'text/csv'].includes(mimeType)
) {
return ContentRenderType.Text
- } else if (contentType?.indexOf('image/') === 0) {
+ } else if (mimeType?.indexOf('image/') === 0) {
return ContentRenderType.Image
}
return ContentRenderType.Other
@@ -1138,7 +1147,6 @@ export class DocumentDetailComponent
})
modal.componentInstance.title = $localize`Rotate confirm`
modal.componentInstance.messageBold = $localize`This operation will permanently rotate the original version of the current document.`
- modal.componentInstance.message = $localize`This will alter the original copy.`
modal.componentInstance.btnCaption = $localize`Proceed`
modal.componentInstance.documentID = this.document.id
modal.componentInstance.showPDFNote = false
@@ -1173,4 +1181,41 @@ export class DocumentDetailComponent
})
})
}
+
+ deletePages() {
+ let modal = this.modalService.open(DeletePagesConfirmDialogComponent, {
+ backdrop: 'static',
+ })
+ modal.componentInstance.title = $localize`Delete pages confirm`
+ modal.componentInstance.messageBold = $localize`This operation will permanently delete the selected pages from the original document.`
+ modal.componentInstance.btnCaption = $localize`Proceed`
+ modal.componentInstance.documentID = this.document.id
+ modal.componentInstance.confirmClicked
+ .pipe(takeUntil(this.unsubscribeNotifier))
+ .subscribe(() => {
+ modal.componentInstance.buttonsEnabled = false
+ this.documentsService
+ .bulkEdit([this.document.id], 'delete_pages', {
+ pages: modal.componentInstance.pages,
+ })
+ .pipe(first(), takeUntil(this.unsubscribeNotifier))
+ .subscribe({
+ next: () => {
+ this.toastService.showInfo(
+ $localize`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.`
+ )
+ modal.close()
+ },
+ error: (error) => {
+ if (modal) {
+ modal.componentInstance.buttonsEnabled = true
+ }
+ this.toastService.showError(
+ $localize`Error executing delete pages operation`,
+ error
+ )
+ },
+ })
+ })
+ }
}
diff --git a/src/documents/bulk_edit.py b/src/documents/bulk_edit.py
index f59ef1af3..8dbdbc2dd 100644
--- a/src/documents/bulk_edit.py
+++ b/src/documents/bulk_edit.py
@@ -325,3 +325,29 @@ def split(doc_ids: list[int], pages: list[list[int]]):
logger.exception(f"Error splitting document {doc.id}: {e}")
return "OK"
+
+
+def delete_pages(doc_ids: list[int], pages: list[int]):
+ logger.info(
+ f"Attempting to delete pages {pages} from {len(doc_ids)} documents",
+ )
+ doc = Document.objects.get(id=doc_ids[0])
+ pages = sorted(pages) # sort pages to avoid index issues
+ import pikepdf
+
+ try:
+ with pikepdf.open(doc.source_path, allow_overwriting_input=True) as pdf:
+ offset = 1 # pages are 1-indexed
+ for page_num in pages:
+ pdf.pages.remove(pdf.pages[page_num - offset])
+ offset += 1 # remove() changes the index of the pages
+ pdf.remove_unreferenced_resources()
+ pdf.save()
+ doc.checksum = hashlib.md5(doc.source_path.read_bytes()).hexdigest()
+ doc.save()
+ update_document_archive_file.delay(document_id=doc.id)
+ logger.info(f"Deleted pages {pages} from document {doc.id}")
+ except Exception as e:
+ logger.exception(f"Error deleting pages from document {doc.id}: {e}")
+
+ return "OK"
diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py
index 9d722ca5d..c92765e69 100644
--- a/src/documents/serialisers.py
+++ b/src/documents/serialisers.py
@@ -944,6 +944,7 @@ class BulkEditSerializer(
"rotate",
"merge",
"split",
+ "delete_pages",
],
label="Method",
write_only=True,
@@ -1000,6 +1001,8 @@ class BulkEditSerializer(
return bulk_edit.merge
elif method == "split":
return bulk_edit.split
+ elif method == "delete_pages":
+ return bulk_edit.delete_pages
else:
raise serializers.ValidationError("Unsupported method.")
@@ -1128,6 +1131,14 @@ class BulkEditSerializer(
except ValueError:
raise serializers.ValidationError("invalid pages specified")
+ def _validate_parameters_delete_pages(self, parameters):
+ if "pages" not in parameters:
+ raise serializers.ValidationError("pages not specified")
+ if not isinstance(parameters["pages"], list):
+ raise serializers.ValidationError("pages must be a list")
+ if not all(isinstance(i, int) for i in parameters["pages"]):
+ raise serializers.ValidationError("pages must be a list of integers")
+
def validate(self, attrs):
method = attrs["method"]
parameters = attrs["parameters"]
@@ -1154,6 +1165,12 @@ class BulkEditSerializer(
"Split method only supports one document",
)
self._validate_parameters_split(parameters)
+ elif method == bulk_edit.delete_pages:
+ if len(attrs["documents"]) > 1:
+ raise serializers.ValidationError(
+ "Delete pages method only supports one document",
+ )
+ self._validate_parameters_delete_pages(parameters)
return attrs
diff --git a/src/documents/tests/test_api_bulk_edit.py b/src/documents/tests/test_api_bulk_edit.py
index c38ed8cfd..7078aca12 100644
--- a/src/documents/tests/test_api_bulk_edit.py
+++ b/src/documents/tests/test_api_bulk_edit.py
@@ -1065,3 +1065,95 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
self.assertIn(b"Split method only supports one document", response.content)
+
+ @mock.patch("documents.serialisers.bulk_edit.delete_pages")
+ def test_delete_pages(self, m):
+ m.return_value = "OK"
+
+ response = self.client.post(
+ "/api/documents/bulk_edit/",
+ json.dumps(
+ {
+ "documents": [self.doc2.id],
+ "method": "delete_pages",
+ "parameters": {"pages": [1, 2, 3, 4]},
+ },
+ ),
+ content_type="application/json",
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+ m.assert_called_once()
+ args, kwargs = m.call_args
+ self.assertCountEqual(args[0], [self.doc2.id])
+ self.assertEqual(kwargs["pages"], [1, 2, 3, 4])
+
+ def test_delete_pages_invalid_params(self):
+ response = self.client.post(
+ "/api/documents/bulk_edit/",
+ json.dumps(
+ {
+ "documents": [
+ self.doc1.id,
+ self.doc2.id,
+ ], # only one document supported
+ "method": "delete_pages",
+ "parameters": {
+ "pages": [1, 2, 3, 4],
+ },
+ },
+ ),
+ content_type="application/json",
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertIn(
+ b"Delete pages method only supports one document",
+ response.content,
+ )
+
+ response = self.client.post(
+ "/api/documents/bulk_edit/",
+ json.dumps(
+ {
+ "documents": [self.doc2.id],
+ "method": "delete_pages",
+ "parameters": {}, # pages not specified
+ },
+ ),
+ content_type="application/json",
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertIn(b"pages not specified", response.content)
+
+ response = self.client.post(
+ "/api/documents/bulk_edit/",
+ json.dumps(
+ {
+ "documents": [self.doc2.id],
+ "method": "delete_pages",
+ "parameters": {"pages": "1-3"}, # not a list
+ },
+ ),
+ content_type="application/json",
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertIn(b"pages must be a list", response.content)
+
+ response = self.client.post(
+ "/api/documents/bulk_edit/",
+ json.dumps(
+ {
+ "documents": [self.doc2.id],
+ "method": "delete_pages",
+ "parameters": {"pages": ["1-3"]}, # not ints
+ },
+ ),
+ content_type="application/json",
+ )
+
+ self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+ self.assertIn(b"pages must be a list of integers", response.content)
diff --git a/src/documents/tests/test_bulk_edit.py b/src/documents/tests/test_bulk_edit.py
index 831fa9461..16579c887 100644
--- a/src/documents/tests/test_bulk_edit.py
+++ b/src/documents/tests/test_bulk_edit.py
@@ -585,3 +585,46 @@ class TestPDFActions(DirectoriesMixin, TestCase):
mock_update_documents.assert_called_once()
mock_chord.assert_called_once()
self.assertEqual(result, "OK")
+
+ @mock.patch("documents.tasks.update_document_archive_file.delay")
+ @mock.patch("pikepdf.Pdf.save")
+ def test_delete_pages(self, mock_pdf_save, mock_update_archive_file):
+ """
+ GIVEN:
+ - Existing documents
+ WHEN:
+ - Delete pages action is called with 1 document and 2 pages
+ THEN:
+ - Save should be called once
+ - Archive file should be updated once
+ """
+ doc_ids = [self.doc2.id]
+ pages = [1, 3]
+ result = bulk_edit.delete_pages(doc_ids, pages)
+ mock_pdf_save.assert_called_once()
+ mock_update_archive_file.assert_called_once()
+ self.assertEqual(result, "OK")
+
+ @mock.patch("documents.tasks.update_document_archive_file.delay")
+ @mock.patch("pikepdf.Pdf.save")
+ def test_delete_pages_with_error(self, mock_pdf_save, mock_update_archive_file):
+ """
+ GIVEN:
+ - Existing documents
+ WHEN:
+ - Delete pages action is called with 1 document and 2 pages
+ - PikePDF raises an error
+ THEN:
+ - Save should be called once
+ - Archive file should not be updated
+ """
+ mock_pdf_save.side_effect = Exception("Error saving PDF")
+ doc_ids = [self.doc2.id]
+ pages = [1, 3]
+
+ with self.assertLogs("paperless.bulk_edit", level="ERROR") as cm:
+ bulk_edit.delete_pages(doc_ids, pages)
+ error_str = cm.output[0]
+ expected_str = "Error deleting pages from document"
+ self.assertIn(expected_str, error_str)
+ mock_update_archive_file.assert_not_called()