Merge pull request #956 from paperless-ngx/fix-warn-max-open-docs

Fix: warn when closing a document with unsaved changes due to max open docs
2025-04-02 13:45:10 -05:00 · 2022-05-17 10:43:10 -07:00 · 2022-05-17 10:43:10 -07:00 · abc5bd98b4
commit abc5bd98b4
parent 9ae20a6bec 2f739ff0b3
12 changed files with 74 additions and 39 deletions
--- a/src-ui/messages.xlf
+++ b/src-ui/messages.xlf
@ -368,7 +368,7 @@
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/document-list.component.ts</context>
-          <context context-type="linenumber">69</context>
+          <context context-type="linenumber">68</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/manage/management-list/management-list.component.html</context>
@ -1913,14 +1913,14 @@
        <source>View &quot;<x id="PH" equiv-text="this.list.activeSavedViewTitle"/>&quot; saved successfully.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/document-list.component.ts</context>
-          <context context-type="linenumber">198</context>
+          <context context-type="linenumber">197</context>
        </context-group>
      </trans-unit>
      <trans-unit id="6837554170707123455" datatype="html">
        <source>View &quot;<x id="PH" equiv-text="savedView.name"/>&quot; created successfully.</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/components/document-list/document-list.component.ts</context>
-          <context context-type="linenumber">228</context>
+          <context context-type="linenumber">227</context>
        </context-group>
      </trans-unit>
      <trans-unit id="6849725902312323996" datatype="html">
@ -2651,11 +2651,11 @@
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">84</context>
+          <context context-type="linenumber">111</context>
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">107</context>
+          <context context-type="linenumber">138</context>
        </context-group>
      </trans-unit>
      <trans-unit id="2573823578527613511" datatype="html">
@ -2666,11 +2666,7 @@
        </context-group>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">85</context>
-        </context-group>
-        <context-group purpose="location">
-          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">108</context>
+          <context context-type="linenumber">139</context>
        </context-group>
      </trans-unit>
      <trans-unit id="3305084982600522070" datatype="html">
@ -2803,32 +2799,39 @@
          <context context-type="linenumber">27</context>
        </context-group>
      </trans-unit>
+      <trans-unit id="5523607037798226031" datatype="html">
+        <source>You have unsaved changes to the document</source>
+        <context-group purpose="location">
+          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
+          <context context-type="linenumber">113</context>
+        </context-group>
+      </trans-unit>
      <trans-unit id="2089045849587358256" datatype="html">
        <source>Are you sure you want to close this document?</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">86</context>
+          <context context-type="linenumber">117</context>
        </context-group>
      </trans-unit>
      <trans-unit id="2885986061416655600" datatype="html">
        <source>Close document</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">88</context>
+          <context context-type="linenumber">119</context>
        </context-group>
      </trans-unit>
      <trans-unit id="6755718693176327396" datatype="html">
        <source>Are you sure you want to close all documents?</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">109</context>
+          <context context-type="linenumber">140</context>
        </context-group>
      </trans-unit>
      <trans-unit id="4215561719980781894" datatype="html">
        <source>Close documents</source>
        <context-group purpose="location">
          <context context-type="sourcefile">src/app/services/open-documents.service.ts</context>
-          <context context-type="linenumber">111</context>
+          <context context-type="linenumber">142</context>
        </context-group>
      </trans-unit>
      <trans-unit id="3553216189604488439" datatype="html">
--- a/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html
+++ b/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html
@ -11,7 +11,7 @@
      </tr>
    </thead>
    <tbody>
-      <tr *ngFor="let doc of documents" [routerLink]="['/', 'documents', doc.id]">
+      <tr *ngFor="let doc of documents" (click)="openDocumentsService.openDocument(doc)">
        <td>{{doc.created | customDate}}</td>
        <td>{{doc.title | documentTitle}}<app-tag [tag]="t" *ngFor="let t of doc.tags$ | async" class="ms-1" (click)="clickTag(t); $event.stopPropagation();"></app-tag></td>
      </tr>
--- a/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.ts
+++ b/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.ts
@ -8,6 +8,7 @@ import { DocumentService } from 'src/app/services/rest/document.service'
 import { PaperlessTag } from 'src/app/data/paperless-tag'
 import { FILTER_HAS_TAGS_ALL } from 'src/app/data/filter-rule-type'
 import { QueryParamsService } from 'src/app/services/query-params.service'
+import { OpenDocumentsService } from 'src/app/services/open-documents.service'

@Component({
  selector: 'app-saved-view-widget',
@ -21,7 +22,8 @@ export class SavedViewWidgetComponent implements OnInit, OnDestroy {
    private documentService: DocumentService,
    private router: Router,
    private queryParamsService: QueryParamsService,
-    private consumerStatusService: ConsumerStatusService
+    private consumerStatusService: ConsumerStatusService,
+    public openDocumentsService: OpenDocumentsService
  ) {}

  @Input()
--- a/src-ui/src/app/components/document-detail/document-detail.component.ts
+++ b/src-ui/src/app/components/document-detail/document-detail.component.ts
@ -204,7 +204,7 @@ export class DocumentDetailComponent
              this.openDocumentService.getOpenDocument(this.documentId)
            )
          } else {
-            this.openDocumentService.openDocument(doc)
+            this.openDocumentService.openDocument(doc, false)
            this.updateComponent(doc)
          }

--- a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html
+++ b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html
@ -37,7 +37,7 @@
                <use xlink:href="assets/bootstrap-icons.svg#diagram-3"/>
              </svg>&nbsp;<span class="d-none d-md-inline" i18n>More like this</span>
            </a>
-            <a routerLink="/documents/{{document.id}}" class="btn btn-sm btn-outline-secondary">
+            <a (click)="openDocumentsService.openDocument(document)" class="btn btn-sm btn-outline-secondary">
              <svg class="sidebaricon" fill="currentColor" class="sidebaricon">
                <use xlink:href="assets/bootstrap-icons.svg#pencil"/>
              </svg>&nbsp;<span class="d-none d-md-inline" i18n>Edit</span>
--- a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts
+++ b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts
@ -6,7 +6,6 @@ import {
  Output,
  ViewChild,
 } from '@angular/core'
-import { DomSanitizer } from '@angular/platform-browser'
 import { PaperlessDocument } from 'src/app/data/paperless-document'
 import { DocumentService } from 'src/app/services/rest/document.service'
 import {
@ -14,8 +13,7 @@ import {
  SETTINGS_KEYS,
 } from 'src/app/services/settings.service'
 import { NgbPopover } from '@ng-bootstrap/ng-bootstrap'
-import { DocumentListViewService } from 'src/app/services/document-list-view.service'
-import { FILTER_FULLTEXT_MORELIKE } from 'src/app/data/filter-rule-type'
+import { OpenDocumentsService } from 'src/app/services/open-documents.service'

@Component({
  selector: 'app-document-card-large',
@ -28,8 +26,8 @@ import { FILTER_FULLTEXT_MORELIKE } from 'src/app/data/filter-rule-type'
 export class DocumentCardLargeComponent implements OnInit {
  constructor(
    private documentService: DocumentService,
-    private sanitizer: DomSanitizer,
-    private settingsService: SettingsService
+    private settingsService: SettingsService,
+    public openDocumentsService: OpenDocumentsService
  ) {}

  @Input()
--- a/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html
+++ b/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html
@ -63,7 +63,7 @@
      </div>
      <div class="d-flex justify-content-between align-items-center">
        <div class="btn-group w-100">
-          <a routerLink="/documents/{{document.id}}" class="btn btn-sm btn-outline-secondary" title="Edit" i18n-title>
+          <a (click)="openDocumentsService.openDocument(document)" class="btn btn-sm btn-outline-secondary" title="Edit" i18n-title>
            <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-pencil" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
              <path fill-rule="evenodd" d="M12.146.146a.5.5 0 0 1 .708 0l3 3a.5.5 0 0 1 0 .708l-10 10a.5.5 0 0 1-.168.11l-5 2a.5.5 0 0 1-.65-.65l2-5a.5.5 0 0 1 .11-.168l10-10zM11.207 2.5L13.5 4.793 14.793 3.5 12.5 1.207 11.207 2.5zm1.586 3L10.5 3.207 4 9.707V10h.5a.5.5 0 0 1 .5.5v.5h.5a.5.5 0 0 1 .5.5v.5h.293l6.5-6.5zm-9.761 5.175l-.106.106-1.528 3.821 3.821-1.528.106-.106A.5.5 0 0 1 5 12.5V12h-.5a.5.5 0 0 1-.5-.5V11h-.5a.5.5 0 0 1-.468-.325z"/>
            </svg>
--- a/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.ts
+++ b/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.ts
@ -14,6 +14,7 @@ import {
  SETTINGS_KEYS,
 } from 'src/app/services/settings.service'
 import { NgbPopover } from '@ng-bootstrap/ng-bootstrap'
+import { OpenDocumentsService } from 'src/app/services/open-documents.service'

@Component({
  selector: 'app-document-card-small',
@ -26,7 +27,8 @@ import { NgbPopover } from '@ng-bootstrap/ng-bootstrap'
 export class DocumentCardSmallComponent implements OnInit {
  constructor(
    private documentService: DocumentService,
-    private settingsService: SettingsService
+    private settingsService: SettingsService,
+    public openDocumentsService: OpenDocumentsService
  ) {}

  @Input()
--- a/src-ui/src/app/components/document-list/document-list.component.html
+++ b/src-ui/src/app/components/document-list/document-list.component.html
@ -168,7 +168,7 @@
          </ng-container>
        </td>
        <td>
-          <a routerLink="/documents/{{d.id}}" title="Edit document" style="overflow-wrap: anywhere;">{{d.title | documentTitle}}</a>
+          <a (click)="openDocumentsService.openDocument(d)" title="Edit document" style="overflow-wrap: anywhere;">{{d.title | documentTitle}}</a>
          <app-tag [tag]="t" *ngFor="let t of d.tags$ | async" class="ms-1" clickable="true" linkTitle="Filter by tag" (click)="clickTag(t.id);$event.stopPropagation()"></app-tag>
        </td>
        <td class="d-none d-xl-table-cell">
--- a/src-ui/src/app/components/document-list/document-list.component.ts
+++ b/src-ui/src/app/components/document-list/document-list.component.ts
@ -20,10 +20,8 @@ import {
 } from 'src/app/directives/sortable.directive'
 import { ConsumerStatusService } from 'src/app/services/consumer-status.service'
 import { DocumentListViewService } from 'src/app/services/document-list-view.service'
-import {
-  filterRulesFromQueryParams,
-  QueryParamsService,
-} from 'src/app/services/query-params.service'
+import { OpenDocumentsService } from 'src/app/services/open-documents.service'
+import { QueryParamsService } from 'src/app/services/query-params.service'
 import {
  DOCUMENT_SORT_FIELDS,
  DOCUMENT_SORT_FIELDS_FULLTEXT,
@ -47,7 +45,8 @@ export class DocumentListComponent implements OnInit, OnDestroy, AfterViewInit {
    private toastService: ToastService,
    private modalService: NgbModal,
    private consumerStatusService: ConsumerStatusService,
-    private queryParamsService: QueryParamsService
+    private queryParamsService: QueryParamsService,
+    public openDocumentsService: OpenDocumentsService
  ) {}

  @ViewChild('filterEditor')
--- a/src-ui/src/app/services/open-documents.service.ts
+++ b/src-ui/src/app/services/open-documents.service.ts
@ -6,6 +6,7 @@ import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
 import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component'
 import { Observable, Subject, of } from 'rxjs'
 import { first } from 'rxjs/operators'
+import { Router } from '@angular/router'

@Injectable({
  providedIn: 'root',
@ -15,7 +16,8 @@ export class OpenDocumentsService {

  constructor(
    private documentService: DocumentService,
-    private modalService: NgbModal
+    private modalService: NgbModal,
+    private router: Router
  ) {
    if (sessionStorage.getItem(OPEN_DOCUMENT_SERVICE.DOCUMENTS)) {
      try {
@ -55,13 +57,38 @@ export class OpenDocumentsService {
    return this.openDocuments.find((d) => d.id == id)
  }

-  openDocument(doc: PaperlessDocument) {
+  openDocument(
+    doc: PaperlessDocument,
+    navigate: boolean = true
+  ): Observable<boolean> {
    if (this.openDocuments.find((d) => d.id == doc.id) == null) {
-      this.openDocuments.unshift(doc)
-      if (this.openDocuments.length > this.MAX_OPEN_DOCUMENTS) {
-        this.openDocuments.pop()
+      if (this.openDocuments.length == this.MAX_OPEN_DOCUMENTS) {
+        // at max, ensure changes arent lost
+        const docToRemove = this.openDocuments[this.MAX_OPEN_DOCUMENTS - 1]
+        const closeObservable = this.closeDocument(docToRemove)
+        closeObservable.pipe(first()).subscribe((closed) => {
+          if (closed) this.finishOpenDocument(doc, navigate)
+        })
+        return closeObservable
+      } else {
+        // not at max
+        this.finishOpenDocument(doc, navigate)
      }
+    } else {
+      // doc is open, just maybe navigate
+      if (navigate) {
+        this.router.navigate(['documents', doc.id])
+      }
+    }
+    return of(true)
+  }
+
+  private finishOpenDocument(doc: PaperlessDocument, navigate: boolean) {
+    this.openDocuments.unshift(doc)
+    this.dirtyDocuments.delete(doc.id)
    this.save()
+    if (navigate) {
+      this.router.navigate(['documents', doc.id])
    }
  }

@ -82,7 +109,11 @@ export class OpenDocumentsService {
        backdrop: 'static',
      })
      modal.componentInstance.title = $localize`Unsaved Changes`
-      modal.componentInstance.messageBold = $localize`You have unsaved changes.`
+      modal.componentInstance.messageBold =
+        $localize`You have unsaved changes to the document` +
+        ' "' +
+        doc.title +
+        '".'
      modal.componentInstance.message = $localize`Are you sure you want to close this document?`
      modal.componentInstance.btnClass = 'btn-warning'
      modal.componentInstance.btnCaption = $localize`Close document`
--- a/src-ui/src/theme.scss
+++ b/src-ui/src/theme.scss
@ -39,7 +39,7 @@ $form-check-radio-checked-bg-image-dark: url("data:image/svg+xml,<svg xmlns='htt
    background-image: escape-svg($form-check-radio-checked-bg-image-dark);
  }

-  .btn-close {
+  .toast .btn-close {
    filter: none !important;
  }
 }