Sidebar
@@ -168,26 +157,42 @@
Update checking
-
-
+
- Update checking works by pinging the public GitHub API for the latest release to determine whether a new version is available.
- Actual updating of the app must still be performed manually.
-
- No tracking data is collected by the app in any way. -
++ Update checking works by pinging the public GitHub API for the latest release to determine whether a new version is available. Actual updating of the app must still be performed manually. +
++ No tracking data is collected by the app in any way. +
+Document editing
+
+
+
+
+
+
+
+
+ Bulk editing
diff --git a/src-ui/src/app/components/admin/settings/settings.component.spec.ts b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
index 98d8e2d72..bd9fe5664 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.spec.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.spec.ts
@@ -315,7 +315,7 @@ describe('SettingsComponent', () => {
expect(toastErrorSpy).toHaveBeenCalled()
expect(storeSpy).toHaveBeenCalled()
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
- expect(setSpy).toHaveBeenCalledTimes(27)
+ expect(setSpy).toHaveBeenCalledTimes(28)
// succeed
storeSpy.mockReturnValueOnce(of(true))
diff --git a/src-ui/src/app/components/admin/settings/settings.component.ts b/src-ui/src/app/components/admin/settings/settings.component.ts
index fcb7d7c65..c08a869e2 100644
--- a/src-ui/src/app/components/admin/settings/settings.component.ts
+++ b/src-ui/src/app/components/admin/settings/settings.component.ts
@@ -88,7 +88,6 @@ export class SettingsComponent
darkModeEnabled: new FormControl(null),
darkModeInvertThumbs: new FormControl(null),
themeColor: new FormControl(null),
- useNativePdfViewer: new FormControl(null),
displayLanguage: new FormControl(null),
dateLocale: new FormControl(null),
dateFormat: new FormControl(null),
@@ -99,7 +98,9 @@ export class SettingsComponent
defaultPermsViewGroups: new FormControl(null),
defaultPermsEditUsers: new FormControl(null),
defaultPermsEditGroups: new FormControl(null),
+ useNativePdfViewer: new FormControl(null),
documentEditingRemoveInboxTags: new FormControl(null),
+ documentEditingOverlayThumbnail: new FormControl(null),
searchDbOnly: new FormControl(null),
searchLink: new FormControl(null),
@@ -308,6 +309,9 @@ export class SettingsComponent
documentEditingRemoveInboxTags: this.settings.get(
SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS
),
+ documentEditingOverlayThumbnail: this.settings.get(
+ SETTINGS_KEYS.DOCUMENT_EDITING_OVERLAY_THUMBNAIL
+ ),
searchDbOnly: this.settings.get(SETTINGS_KEYS.SEARCH_DB_ONLY),
searchLink: this.settings.get(SETTINGS_KEYS.SEARCH_FULL_TYPE),
savedViews: {},
@@ -539,6 +543,10 @@ export class SettingsComponent
SETTINGS_KEYS.DOCUMENT_EDITING_REMOVE_INBOX_TAGS,
this.settingsForm.value.documentEditingRemoveInboxTags
)
+ this.settings.set(
+ SETTINGS_KEYS.DOCUMENT_EDITING_OVERLAY_THUMBNAIL,
+ this.settingsForm.value.documentEditingOverlayThumbnail
+ )
this.settings.set(
SETTINGS_KEYS.SEARCH_DB_ONLY,
this.settingsForm.value.searchDbOnly
diff --git a/src-ui/src/app/components/common/preview-popup/preview-popup.component.html b/src-ui/src/app/components/common/preview-popup/preview-popup.component.html
index 096dcf04d..f9a8b9771 100644
--- a/src-ui/src/app/components/common/preview-popup/preview-popup.component.html
+++ b/src-ui/src/app/components/common/preview-popup/preview-popup.component.html
@@ -5,7 +5,11 @@
} @else {
@if (renderAsObject) {
-
+ @if (previewText) {
+ {{previewText}}
+ } @else {
+
+ }
} @else {
@if (requiresPassword) {
diff --git a/src-ui/src/app/components/common/preview-popup/preview-popup.component.scss b/src-ui/src/app/components/common/preview-popup/preview-popup.component.scss
index 14439b8fb..af8dc565a 100644
--- a/src-ui/src/app/components/common/preview-popup/preview-popup.component.scss
+++ b/src-ui/src/app/components/common/preview-popup/preview-popup.component.scss
@@ -7,33 +7,3 @@
::ng-deep .popover.popover-preview {
max-width: 32rem;
}
-
-// https://github.com/paperless-ngx/paperless-ngx/issues/7920
-// TODO: remove me
-@mixin ff_txt {
- .preview-popup-container {
- width: 30rem !important;
- height: 22rem !important;
- background-color: #e7e7e7;
- }
-
- object:not(.pdf) {
- mix-blend-mode: difference;
- background: white !important;
- &.p-2 {
- padding: 0 !important;
- }
- }
-}
-
-@-moz-document url-prefix() {
- html[data-bs-theme='dark'] {
- @include ff_txt;
- }
- html[data-bs-theme='auto'] {
- @media screen and (prefers-color-scheme: dark) {
- @include ff_txt;
- }
- }
-
-}
diff --git a/src-ui/src/app/components/common/preview-popup/preview-popup.component.spec.ts b/src-ui/src/app/components/common/preview-popup/preview-popup.component.spec.ts
index c23cb6124..2b9f71cef 100644
--- a/src-ui/src/app/components/common/preview-popup/preview-popup.component.spec.ts
+++ b/src-ui/src/app/components/common/preview-popup/preview-popup.component.spec.ts
@@ -9,13 +9,20 @@ import { provideHttpClientTesting } from '@angular/common/http/testing'
import { DocumentService } from 'src/app/services/rest/document.service'
import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
import { PdfViewerModule } from 'ng2-pdf-viewer'
-import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
+import {
+ HttpClient,
+ provideHttpClient,
+ withInterceptorsFromDi,
+} from '@angular/common/http'
+import { of, throwError } from 'rxjs'
const doc = {
id: 10,
title: 'Document 10',
content: 'Cupcake ipsum dolor sit amet ice cream.',
original_file_name: 'sample.pdf',
+ archived_file_name: 'sample.pdf',
+ mime_type: 'application/pdf',
}
describe('PreviewPopupComponent', () => {
@@ -23,6 +30,7 @@ describe('PreviewPopupComponent', () => {
let fixture: ComponentFixture
let settingsService: SettingsService
let documentService: DocumentService
+ let http: HttpClient
beforeEach(() => {
TestBed.configureTestingModule({
@@ -35,23 +43,22 @@ describe('PreviewPopupComponent', () => {
})
settingsService = TestBed.inject(SettingsService)
documentService = TestBed.inject(DocumentService)
+ http = TestBed.inject(HttpClient)
jest
.spyOn(documentService, 'getPreviewUrl')
.mockImplementation((id) => doc.original_file_name)
fixture = TestBed.createComponent(PreviewPopupComponent)
component = fixture.componentInstance
- component.document = doc
+ component.document = { ...doc }
fixture.detectChanges()
})
- it('should guess if file is pdf by file name', () => {
- expect(component.isPdf).toBeTruthy()
- component.document.archived_file_name = 'sample.pdf'
+ it('should correctly report if document is pdf', () => {
expect(component.isPdf).toBeTruthy()
+ component.document.mime_type = 'application/msword'
+ expect(component.isPdf).toBeTruthy() // still has archive file
component.document.archived_file_name = undefined
- component.document.original_file_name = 'sample.txt'
expect(component.isPdf).toBeFalsy()
- component.document.original_file_name = 'sample.pdf'
})
it('should return settings for native PDF viewer', () => {
@@ -84,6 +91,8 @@ describe('PreviewPopupComponent', () => {
it('should fall back to object for non-pdf', () => {
component.document.original_file_name = 'sample.png'
+ component.document.mime_type = 'image/png'
+ component.document.archived_file_name = undefined
fixture.detectChanges()
expect(fixture.debugElement.query(By.css('object'))).not.toBeNull()
})
@@ -95,4 +104,22 @@ describe('PreviewPopupComponent', () => {
'Error loading preview'
)
})
+
+ it('should get text content from http if appropriate', () => {
+ component.document = {
+ ...doc,
+ original_file_name: 'sample.txt',
+ mime_type: 'text/plain',
+ }
+ const httpSpy = jest.spyOn(http, 'get')
+ httpSpy.mockReturnValueOnce(
+ throwError(() => new Error('Error getting preview'))
+ )
+ component.init()
+ expect(httpSpy).toHaveBeenCalled()
+ expect(component.error).toBeTruthy()
+ httpSpy.mockReturnValueOnce(of('Preview text'))
+ component.init()
+ expect(component.previewText).toEqual('Preview text')
+ })
})
diff --git a/src-ui/src/app/components/common/preview-popup/preview-popup.component.ts b/src-ui/src/app/components/common/preview-popup/preview-popup.component.ts
index c3d2987d3..6d2ede266 100644
--- a/src-ui/src/app/components/common/preview-popup/preview-popup.component.ts
+++ b/src-ui/src/app/components/common/preview-popup/preview-popup.component.ts
@@ -1,4 +1,6 @@
-import { Component, Input } from '@angular/core'
+import { HttpClient } from '@angular/common/http'
+import { Component, Input, OnDestroy } from '@angular/core'
+import { first, Subject, takeUntil } from 'rxjs'
import { Document } from 'src/app/data/document'
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
import { DocumentService } from 'src/app/services/rest/document.service'
@@ -9,14 +11,26 @@ import { SettingsService } from 'src/app/services/settings.service'
templateUrl: './preview-popup.component.html',
styleUrls: ['./preview-popup.component.scss'],
})
-export class PreviewPopupComponent {
+export class PreviewPopupComponent implements OnDestroy {
+ private _document: Document
@Input()
- document: Document
+ set document(document: Document) {
+ this._document = document
+ this.init()
+ }
+
+ get document(): Document {
+ return this._document
+ }
+
+ unsubscribeNotifier: Subject = new Subject()
error = false
requiresPassword: boolean = false
+ previewText: string
+
get renderAsObject(): boolean {
return (this.isPdf && this.useNativePdfViewer) || !this.isPdf
}
@@ -30,18 +44,38 @@ export class PreviewPopupComponent {
}
get isPdf(): boolean {
- // We dont have time to retrieve metadata, make a best guess by file name
return (
- this.document?.original_file_name?.endsWith('.pdf') ||
- this.document?.archived_file_name?.endsWith('.pdf')
+ this.document?.archived_file_name?.length > 0 ||
+ this.document?.mime_type?.includes('pdf')
)
}
constructor(
private settingsService: SettingsService,
- private documentService: DocumentService
+ private documentService: DocumentService,
+ private http: HttpClient
) {}
+ ngOnDestroy(): void {
+ this.unsubscribeNotifier.next(this)
+ }
+
+ init() {
+ if (this.document.mime_type?.includes('text')) {
+ this.http
+ .get(this.previewURL, { responseType: 'text' })
+ .pipe(first(), takeUntil(this.unsubscribeNotifier))
+ .subscribe({
+ next: (res) => {
+ this.previewText = res.toString()
+ },
+ error: (err) => {
+ this.error = err
+ },
+ })
+ }
+ }
+
onError(event: any) {
if (event.name == 'PasswordException') {
this.requiresPassword = true
diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html
index 25a512463..6a39b13bd 100644
--- a/src-ui/src/app/components/document-detail/document-detail.component.html
+++ b/src-ui/src/app/components/document-detail/document-detail.component.html
@@ -350,14 +350,16 @@
- @if (!metadata) {
-
+ = new Subject()
previewUrl: string
+ thumbUrl: string
previewText: string
downloadUrl: string
downloadOriginalUrl: string
+ previewLoaded: boolean = false
correspondents: Correspondent[]
documentTypes: DocumentType[]
@@ -221,15 +223,17 @@ export class DocumentDetailComponent
}
get archiveContentRenderType(): ContentRenderType {
- return this.getRenderType(
- this.metadata?.has_archive_version
- ? 'application/pdf'
- : this.metadata?.original_mime_type
- )
+ return this.document?.archived_file_name
+ ? this.getRenderType('application/pdf')
+ : this.getRenderType(this.document?.mime_type)
}
get originalContentRenderType(): ContentRenderType {
- return this.getRenderType(this.metadata?.original_mime_type)
+ return this.getRenderType(this.document?.mime_type)
+ }
+
+ get showThumbnailOverlay(): boolean {
+ return this.settings.get(SETTINGS_KEYS.DOCUMENT_EDITING_OVERLAY_THUMBNAIL)
}
private getRenderType(mimeType: string): ContentRenderType {
@@ -339,6 +343,7 @@ export class DocumentDetailComponent
}`
},
})
+ this.thumbUrl = this.documentsService.getThumbUrl(documentId)
return this.documentsService.get(documentId)
})
)
@@ -537,6 +542,9 @@ export class DocumentDetailComponent
.subscribe({
next: (result) => {
this.metadata = result
+ if (this.archiveContentRenderType !== ContentRenderType.PDF) {
+ this.previewLoaded = true
+ }
},
error: (error) => {
this.metadata = {} // allow display to fallback to
+ ![Document loading...]()
+
Loading...
- } @else {
+
+ @if (document) {
@switch (archiveContentRenderType) {
@case (ContentRenderType.PDF) {
@if (!useNativePdfViewer) {
diff --git a/src-ui/src/app/components/document-detail/document-detail.component.scss b/src-ui/src/app/components/document-detail/document-detail.component.scss
index c6e3b7448..f61e20e83 100644
--- a/src-ui/src/app/components/document-detail/document-detail.component.scss
+++ b/src-ui/src/app/components/document-detail/document-detail.component.scss
@@ -63,6 +63,27 @@ textarea.rtl {
object-fit: contain;
}
-.whitespace-preserve {
- white-space: preserve;
+.thumb-preview {
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: calc(100vh - 160px);
+
+ @media screen and (min-width: 768px) {
+ left: calc(.5 * var(--bs-gutter-x));
+ width: calc(100% - var(--bs-gutter-x));
+ }
+
+ overflow: hidden;
+ background-color: gray;
+ padding: 10px 8px; // border
+ z-index: 1000;
+
+ > div {
+ mix-blend-mode: difference;
+ }
+
+ > img {
+ filter: blur(1px);
+ }
}
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 24ef2ffad..efd7e8191 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
@@ -774,6 +774,15 @@ describe('DocumentDetailComponent', () => {
expect(component.previewNumPages).toEqual(1000)
})
+ it('should include delay of 300ms after previewloaded before showing pdf', fakeAsync(() => {
+ initNormally()
+ expect(component.previewLoaded).toBeFalsy()
+ component.pdfPreviewLoaded({ numPages: 1000 } as any)
+ expect(component.previewNumPages).toEqual(1000)
+ tick(300)
+ expect(component.previewLoaded).toBeTruthy()
+ }))
+
it('should support zoom controls', () => {
initNormally()
component.onZoomSelect({ target: { value: '1' } } as any) // from select
@@ -921,7 +930,7 @@ describe('DocumentDetailComponent', () => {
it('should display built-in pdf viewer if not disabled', () => {
initNormally()
- component.metadata = { has_archive_version: true }
+ component.document.archived_file_name = 'file.pdf'
jest.spyOn(settingsService, 'get').mockReturnValue(false)
expect(component.useNativePdfViewer).toBeFalsy()
fixture.detectChanges()
@@ -930,7 +939,7 @@ describe('DocumentDetailComponent', () => {
it('should display native pdf viewer if enabled', () => {
initNormally()
- component.metadata = { has_archive_version: true }
+ component.document.archived_file_name = 'file.pdf'
jest.spyOn(settingsService, 'get').mockReturnValue(true)
expect(component.useNativePdfViewer).toBeTruthy()
fixture.detectChanges()
@@ -1072,8 +1081,8 @@ describe('DocumentDetailComponent', () => {
})
it('should change preview element by render type', () => {
- component.metadata = { has_archive_version: true }
initNormally()
+ component.document.archived_file_name = 'file.pdf'
fixture.detectChanges()
expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.PDF
@@ -1082,10 +1091,8 @@ describe('DocumentDetailComponent', () => {
fixture.debugElement.query(By.css('pdf-viewer-container'))
).not.toBeUndefined()
- component.metadata = {
- has_archive_version: false,
- original_mime_type: 'text/plain',
- }
+ component.document.archived_file_name = undefined
+ component.document.mime_type = 'text/plain'
fixture.detectChanges()
expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Text
@@ -1094,10 +1101,7 @@ describe('DocumentDetailComponent', () => {
fixture.debugElement.query(By.css('div.preview-sticky'))
).not.toBeUndefined()
- component.metadata = {
- has_archive_version: false,
- original_mime_type: 'image/jpg',
- }
+ component.document.mime_type = 'image/jpeg'
fixture.detectChanges()
expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Image
@@ -1105,13 +1109,9 @@ describe('DocumentDetailComponent', () => {
expect(
fixture.debugElement.query(By.css('.preview-sticky img'))
).not.toBeUndefined()
-
- component.metadata = {
- has_archive_version: false,
- original_mime_type:
- 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
- }
- fixture.detectChanges()
+ ;(component.document.mime_type =
+ 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'),
+ fixture.detectChanges()
expect(component.archiveContentRenderType).toEqual(
component.ContentRenderType.Other
)
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 4fa535ea3..3bd725c45 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
@@ -131,9 +131,11 @@ export class DocumentDetailComponent
title: string
titleSubject: Subject