Adds quick filters from document detail

2025-07-28 18:24:38 -05:00 · 2023-05-27 23:16:33 -07:00
parent 5a52957aa9
commit 42a45075db
13 changed files with 2647 additions and 51 deletions
--- a/src-ui/src/app/components/common/input/date/date.component.html
+++ b/src-ui/src/app/components/common/input/date/date.component.html
@@ -9,6 +9,11 @@
        <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
      </svg>
    </button>
+    <button *ngIf="showFilter" class="btn btn-outline-secondary" type="button" (click)="onFilterDocuments()" [disabled]="this.value === null" i18n-title title="Filter documents with this {{title}}">
+      <svg class="buttonicon" fill="currentColor">
+        <use xlink:href="assets/bootstrap-icons.svg#filter" />
+      </svg>
+    </button>
  </div>
  <div class="invalid-feedback" i18n>Invalid date.</div>
  <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
--- a/src-ui/src/app/components/common/input/date/date.component.ts
+++ b/src-ui/src/app/components/common/input/date/date.component.ts
@@ -1,8 +1,16 @@
-import { Component, forwardRef, Input, OnInit } from '@angular/core'
+import {
+  Component,
+  EventEmitter,
+  forwardRef,
+  Input,
+  OnInit,
+  Output,
+} from '@angular/core'
 import { NG_VALUE_ACCESSOR } from '@angular/forms'
 import {
  NgbDateAdapter,
  NgbDateParserFormatter,
+  NgbDateStruct,
 } from '@ng-bootstrap/ng-bootstrap'
 import { SettingsService } from 'src/app/services/settings.service'
 import { AbstractInputComponent } from '../abstract-input'
@@ -34,6 +42,12 @@ export class DateComponent
  @Input()
  suggestions: string[]

+  @Input()
+  showFilter: boolean = false
+
+  @Output()
+  filterDocuments = new EventEmitter<NgbDateStruct[]>()
+
  getSuggestions() {
    return this.suggestions == null
      ? []
@@ -80,4 +94,8 @@ export class DateComponent
      event.preventDefault()
    }
  }
+
+  onFilterDocuments() {
+    this.filterDocuments.emit([this.ngbDateParserFormatter.parse(this.value)])
+  }
 }
--- a/src-ui/src/app/components/common/input/select/select.component.html
+++ b/src-ui/src/app/components/common/input/select/select.component.html
@@ -1,6 +1,6 @@
 <div class="mb-3 paperless-input-select" [class.disabled]="disabled">
  <label *ngIf="title" class="form-label" [for]="inputId">{{title}}</label>
-    <div [class.input-group]="allowCreateNew">
+    <div [class.input-group]="allowCreateNew || showFilter">
      <ng-select name="inputId" [(ngModel)]="value"
        [disabled]="disabled"
        [style.color]="textColor"
@@ -26,6 +26,11 @@
          <use xlink:href="assets/bootstrap-icons.svg#plus" />
        </svg>
      </button>
+      <button *ngIf="showFilter" class="btn btn-outline-secondary" type="button" (click)="onFilterDocuments()" [disabled]="isPrivate || this.value === null" i18n-title title="Filter documents with this {{title}}">
+        <svg class="buttonicon" fill="currentColor">
+          <use xlink:href="assets/bootstrap-icons.svg#filter" />
+        </svg>
+      </button>
    </div>
  <small *ngIf="hint" class="form-text text-muted">{{hint}}</small>
  <small *ngIf="getSuggestions().length > 0">
--- a/src-ui/src/app/components/common/input/select/select.component.ts
+++ b/src-ui/src/app/components/common/input/select/select.component.ts
@@ -85,9 +85,15 @@ export class SelectComponent extends AbstractInputComponent<number> {
  @Input()
  bindLabel: string = 'name'

+  @Input()
+  showFilter: boolean = false
+
  @Output()
  createNew = new EventEmitter<string>()

+  @Output()
+  filterDocuments = new EventEmitter<any[]>()
+
  public addItemRef: (name) => void

  private _lastSearchTerm: string
@@ -134,4 +140,8 @@ export class SelectComponent extends AbstractInputComponent<number> {
      this.clearLastSearchTerm()
    }, 3000)
  }
+
+  onFilterDocuments() {
+    this.filterDocuments.emit([this.items.find((i) => i.id === this.value)])
+  }
 }
--- a/src-ui/src/app/components/common/input/tags/tags.component.html
+++ b/src-ui/src/app/components/common/input/tags/tags.component.html
@@ -31,12 +31,16 @@
        </div>
      </ng-template>
    </ng-select>
-
    <button *ngIf="allowCreate" class="btn btn-outline-secondary" type="button" (click)="createTag()" [disabled]="disabled">
      <svg class="buttonicon" fill="currentColor">
        <use xlink:href="assets/bootstrap-icons.svg#plus" />
      </svg>
    </button>
+    <button *ngIf="showFilter" class="btn btn-outline-secondary" type="button" (click)="onFilterDocuments()" [disabled]="hasPrivate || this.value === null" i18n-title title="Filter documents with these Tags">
+      <svg class="buttonicon" fill="currentColor">
+        <use xlink:href="assets/bootstrap-icons.svg#filter" />
+      </svg>
+    </button>
  </div>
  <small class="form-text text-muted" *ngIf="hint">{{hint}}</small>
  <small *ngIf="getSuggestions().length > 0">
--- a/src-ui/src/app/components/common/input/tags/tags.component.ts
+++ b/src-ui/src/app/components/common/input/tags/tags.component.ts
@@ -1,4 +1,11 @@
-import { Component, forwardRef, Input, OnInit } from '@angular/core'
+import {
+  Component,
+  EventEmitter,
+  forwardRef,
+  Input,
+  OnInit,
+  Output,
+} from '@angular/core'
 import { ControlValueAccessor, NG_VALUE_ACCESSOR } from '@angular/forms'
 import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
 import { PaperlessTag } from 'src/app/data/paperless-tag'
@@ -57,6 +64,12 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
  @Input()
  allowCreate: boolean = true

+  @Input()
+  showFilter: boolean = false
+
+  @Output()
+  filterDocuments = new EventEmitter<PaperlessTag[]>()
+
  value: number[]

  tags: PaperlessTag[]
@@ -133,4 +146,16 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
      this.clearLastSearchTerm()
    }, 3000)
  }
+
+  get hasPrivate(): boolean {
+    return this.value.some(
+      (t) => this.tags?.find((t2) => t2.id === t) === undefined
+    )
+  }
+
+  onFilterDocuments() {
+    this.filterDocuments.emit(
+      this.tags.filter((t) => this.value.includes(t.id))
+    )
+  }
 }
--- a/src-ui/src/app/components/document-detail/document-detail.component.html
+++ b/src-ui/src/app/components/document-detail/document-detail.component.html
@@ -74,15 +74,15 @@

                        <app-input-text #inputTitle i18n-title title="Title" formControlName="title" (keyup)="titleKeyUp($event)" [error]="error?.title"></app-input-text>
                        <app-input-number i18n-title title="Archive serial number" [error]="error?.archive_serial_number" formControlName='archive_serial_number'></app-input-number>
-                        <app-input-date i18n-title title="Date created" formControlName="created_date" [suggestions]="suggestions?.dates"
+                        <app-input-date i18n-title title="Date created" formControlName="created_date" [suggestions]="suggestions?.dates" [showFilter]="true" (filterDocuments)="filterDocuments($event)"
                            [error]="error?.created_date"></app-input-date>
-                        <app-input-select [items]="correspondents" i18n-title title="Correspondent" formControlName="correspondent" [allowNull]="true"
+                        <app-input-select [items]="correspondents" i18n-title title="Correspondent" formControlName="correspondent" [allowNull]="true" [showFilter]="true" (filterDocuments)="filterDocuments($event)"
                            (createNew)="createCorrespondent($event)" [suggestions]="suggestions?.correspondents" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.Correspondent }"></app-input-select>
-                        <app-input-select [items]="documentTypes" i18n-title title="Document type" formControlName="document_type" [allowNull]="true"
+                        <app-input-select [items]="documentTypes" i18n-title title="Document type" formControlName="document_type" [allowNull]="true" [showFilter]="true" (filterDocuments)="filterDocuments($event)"
                            (createNew)="createDocumentType($event)" [suggestions]="suggestions?.document_types" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.DocumentType }"></app-input-select>
-                        <app-input-select [items]="storagePaths" i18n-title title="Storage path" formControlName="storage_path" [allowNull]="true"
+                        <app-input-select [items]="storagePaths" i18n-title title="Storage path" formControlName="storage_path" [allowNull]="true" [showFilter]="true" (filterDocuments)="filterDocuments($event)"
                            (createNew)="createStoragePath($event)" [suggestions]="suggestions?.storage_paths" i18n-placeholder placeholder="Default" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.StoragePath }"></app-input-select>
-                        <app-input-tags formControlName="tags" [suggestions]="suggestions?.tags" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.Tag }"></app-input-tags>
+                        <app-input-tags formControlName="tags" [suggestions]="suggestions?.tags" [showFilter]="true" (filterDocuments)="filterDocuments($event)" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.Tag }"></app-input-tags>

                    </ng-template>
                </li>
--- a/src-ui/src/app/components/document-detail/document-detail.component.ts
+++ b/src-ui/src/app/components/document-detail/document-detail.component.ts
@@ -1,11 +1,17 @@
 import { Component, OnInit, OnDestroy, ViewChild } from '@angular/core'
 import { FormControl, FormGroup } from '@angular/forms'
 import { ActivatedRoute, Router } from '@angular/router'
-import { NgbModal, NgbNav, NgbNavChangeEvent } from '@ng-bootstrap/ng-bootstrap'
+import {
+  NgbDateStruct,
+  NgbModal,
+  NgbNav,
+  NgbNavChangeEvent,
+} from '@ng-bootstrap/ng-bootstrap'
 import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent'
 import { PaperlessDocument } from 'src/app/data/paperless-document'
 import { PaperlessDocumentMetadata } from 'src/app/data/paperless-document-metadata'
 import { PaperlessDocumentType } from 'src/app/data/paperless-document-type'
+import { PaperlessTag } from 'src/app/data/paperless-tag'
 import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
 import { DocumentListViewService } from 'src/app/services/document-list-view.service'
 import { OpenDocumentsService } from 'src/app/services/open-documents.service'
@@ -30,7 +36,18 @@ import {
  distinctUntilChanged,
 } from 'rxjs/operators'
 import { PaperlessDocumentSuggestions } from 'src/app/data/paperless-document-suggestions'
-import { FILTER_FULLTEXT_MORELIKE } from 'src/app/data/filter-rule-type'
+import {
+  FILTER_CORRESPONDENT,
+  FILTER_CREATED_AFTER,
+  FILTER_CREATED_BEFORE,
+  FILTER_CREATED_DAY,
+  FILTER_CREATED_MONTH,
+  FILTER_CREATED_YEAR,
+  FILTER_DOCUMENT_TYPE,
+  FILTER_FULLTEXT_MORELIKE,
+  FILTER_HAS_TAGS_ALL,
+  FILTER_STORAGE_PATH,
+} from 'src/app/data/filter-rule-type'
 import { StoragePathService } from 'src/app/services/rest/storage-path.service'
 import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path'
 import { StoragePathEditDialogComponent } from '../common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component'
@@ -45,6 +62,9 @@ import { UserService } from 'src/app/services/rest/user.service'
 import { PaperlessDocumentNote } from 'src/app/data/paperless-document-note'
 import { HttpClient } from '@angular/common/http'
 import { ComponentWithPermissions } from '../with-permissions/with-permissions.component'
+import { FilterRule } from 'src/app/data/filter-rule'
+import { ObjectWithId } from 'src/app/data/object-with-id'
+import { ISODateAdapter } from 'src/app/utils/ngb-iso-date-adapter'

 enum DocumentDetailNavIDs {
  Details = 1,
@@ -762,4 +782,53 @@ export class DocumentDetailComponent
      )
    )
  }
+
+  filterDocuments(items: ObjectWithId[] | NgbDateStruct[]) {
+    const filterRules: FilterRule[] = items.flatMap((i) => {
+      if (i.hasOwnProperty('year')) {
+        const isoDateAdapter = new ISODateAdapter()
+        const dateAfter: Date = new Date(isoDateAdapter.toModel(i))
+        dateAfter.setDate(dateAfter.getDate() - 1)
+        const dateBefore: Date = new Date(isoDateAdapter.toModel(i))
+        dateBefore.setDate(dateBefore.getDate() + 1)
+        // Created Date
+        return [
+          {
+            rule_type: FILTER_CREATED_AFTER,
+            value: dateAfter.toISOString().substring(0, 10),
+          },
+          {
+            rule_type: FILTER_CREATED_BEFORE,
+            value: dateBefore.toISOString().substring(0, 10),
+          },
+        ]
+      } else if (i.hasOwnProperty('last_correspondence')) {
+        // Correspondent
+        return {
+          rule_type: FILTER_CORRESPONDENT,
+          value: (i as PaperlessCorrespondent).id.toString(),
+        }
+      } else if (i.hasOwnProperty('path')) {
+        // Storage Path
+        return {
+          rule_type: FILTER_STORAGE_PATH,
+          value: (i as PaperlessStoragePath).id.toString(),
+        }
+      } else if (i.hasOwnProperty('is_inbox_tag')) {
+        // Tag
+        return {
+          rule_type: FILTER_HAS_TAGS_ALL,
+          value: (i as PaperlessTag).id.toString(),
+        }
+      } else {
+        // Document Type, has no specific props
+        return {
+          rule_type: FILTER_DOCUMENT_TYPE,
+          value: (i as PaperlessDocumentType).id.toString(),
+        }
+      }
+    })
+
+    this.documentListViewService.quickFilter(filterRules)
+  }
 }
--- a/src-ui/src/app/components/manage/management-list/management-list.component.html
+++ b/src-ui/src/app/components/manage/management-list/management-list.component.html
@@ -49,19 +49,18 @@
        </div>
        <div class="btn-group d-none d-sm-block">
          <button class="btn btn-sm btn-outline-secondary" (click)="filterDocuments(object)" *appIfPermissions="{ action: PermissionAction.View, type: PermissionType.Document }">
-            <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-funnel" viewBox="0 0 16 16">
-              <path fill-rule="evenodd" d="M1.5 1.5A.5.5 0 0 1 2 1h12a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-.128.334L10 8.692V13.5a.5.5 0 0 1-.342.474l-3 1A.5.5 0 0 1 6 14.5V8.692L1.628 3.834A.5.5 0 0 1 1.5 3.5v-2zm1 .5v1.308l4.372 4.858A.5.5 0 0 1 7 8.5v5.306l2-.666V8.5a.5.5 0 0 1 .128-.334L13.5 3.308V2h-11z"/>
+            <svg class="buttonicon-sm" fill="currentColor">
+              <use xlink:href="assets/bootstrap-icons.svg#filter" />
            </svg>&nbsp;<ng-container i18n>Documents</ng-container>
          </button>
          <button class="btn btn-sm btn-outline-secondary" (click)="openEditDialog(object)" *appIfPermissions="{ action: PermissionAction.Change, type: permissionType }" [disabled]="!userCanEdit(object)">
-            <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 class="buttonicon-sm" fill="currentColor">
+              <use xlink:href="assets/bootstrap-icons.svg#pencil" />
            </svg>&nbsp;<ng-container i18n>Edit</ng-container>
          </button>
          <button class="btn btn-sm btn-outline-danger" (click)="openDeleteDialog(object)" *appIfPermissions="{ action: PermissionAction.Delete, type: permissionType }" [disabled]="!userCanDelete(object)">
-            <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-trash" viewBox="0 0 16 16">
-              <path d="M5.5 5.5A.5.5 0 0 1 6 6v6a.5.5 0 0 1-1 0V6a.5.5 0 0 1 .5-.5zm2.5 0a.5.5 0 0 1 .5.5v6a.5.5 0 0 1-1 0V6a.5.5 0 0 1 .5-.5zm3 .5a.5.5 0 0 0-1 0v6a.5.5 0 0 0 1 0V6z"/>
-              <path fill-rule="evenodd" d="M14.5 3a1 1 0 0 1-1 1H13v9a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V4h-.5a1 1 0 0 1-1-1V2a1 1 0 0 1 1-1H6a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1h3.5a1 1 0 0 1 1 1v1zM4.118 4L4 4.059V13a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1V4.059L11.882 4H4.118zM2.5 3V2h11v1h-11z"/>
+            <svg class="buttonicon-sm" fill="currentColor">
+              <use xlink:href="assets/bootstrap-icons.svg#trash" />
            </svg>&nbsp;<ng-container i18n>Delete</ng-container>
          </button>
        </div>
--- a/src-ui/src/app/services/document-list-view.service.ts
+++ b/src-ui/src/app/services/document-list-view.service.ts
@@ -376,6 +376,7 @@ export class DocumentListViewService {
  quickFilter(filterRules: FilterRule[]) {
    this._activeSavedViewId = null
    this.filterRules = filterRules
+    this.router.navigate(['documents'])
  }

  getLastPage(): number {