diff --git a/docker/hub/docker-compose.postgres.yml b/docker/hub/docker-compose.postgres.yml index 24f0e118f..6ab4b94a6 100644 --- a/docker/hub/docker-compose.postgres.yml +++ b/docker/hub/docker-compose.postgres.yml @@ -15,7 +15,7 @@ services: POSTGRES_PASSWORD: paperless webserver: - image: jonaswinkler/paperless-ng:0.9.6 + image: jonaswinkler/paperless-ng:0.9.7 restart: always depends_on: - db diff --git a/docker/hub/docker-compose.sqlite.yml b/docker/hub/docker-compose.sqlite.yml index 6ae619fd6..4e1da3e10 100644 --- a/docker/hub/docker-compose.sqlite.yml +++ b/docker/hub/docker-compose.sqlite.yml @@ -5,7 +5,7 @@ services: restart: always webserver: - image: jonaswinkler/paperless-ng:0.9.6 + image: jonaswinkler/paperless-ng:0.9.7 restart: always depends_on: - broker diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index b5ae254b3..48a86384c 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -263,10 +263,10 @@ using the identifier which it has assigned to each document. You will end up get files like ``0000123.pdf`` in your media directory. This isn't necessarily a bad thing, because you normally don't have to access these files manually. However, if you wish to name your files differently, you can do that by adjusting the -``PAPERLESS_FILENAME_FORMAT`` settings variable. +``PAPERLESS_FILENAME_FORMAT`` configuration option. -This variable allows you to configure the filename (folders are allowed!) using -placeholders. For example, setting +This variable allows you to configure the filename (folders are allowed) using +placeholders. For example, configuring this to .. code:: bash @@ -277,17 +277,16 @@ will create a directory structure as follows: .. code:: 2019/ - my_bank/ - statement-january-0000001.pdf - statement-february-0000002.pdf + My bank/ + Statement January.pdf + Statement February.pdf 2020/ - my_bank/ - statement-january-0000003.pdf - shoe_store/ - my_new_shoes-0000004.pdf - -Paperless appends the unique identifier of each document to the filename. This -avoids filename clashes. + My bank/ + Statement January.pdf + Letter.pdf + Letter_01.pdf + Shoe store/ + My new shoes.pdf .. danger:: @@ -299,6 +298,7 @@ Paperless provides the following placeholders withing filenames: * ``{correspondent}``: The name of the correspondent, or "none". * ``{document_type}``: The name of the document type, or "none". +* ``{tag_list}``: A comma separated list of all tags assigned to the document. * ``{title}``: The title of the document. * ``{created}``: The full date and time the document was created. * ``{created_year}``: Year created only. @@ -309,8 +309,14 @@ Paperless provides the following placeholders withing filenames: * ``{added_month}``: Month added only (number 1-12). * ``{added_day}``: Day added only (number 1-31). -Paperless will convert all values for the placeholders into values which are safe -for use in filenames. + +Paperless will try to conserve the information from your database as much as possible. +However, some characters that you can use in document titles and correspondent names (such +as ``: \ /`` and a couple more) are not allowed in filenames and will be replaced with dashes. + +If paperless detects that two documents share the same filename, paperless will automatically +append ``_01``, ``_02``, etc to the filename. This happens if all the placeholders in a filename +evaluate to the same value. .. hint:: diff --git a/docs/changelog.rst b/docs/changelog.rst index a50fc31d5..330dd4cc9 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -5,6 +5,49 @@ Changelog ********* + +paperless-ng 0.9.7 +################## + + +* Front end + + * Thanks to the hard work of `Michael Shamoon`_, paperless now comes with a much more streamlined UI for + filtering documents. + + * `Michael Shamoon`_ replaced the document preview with another component. This should fix compatibility with Safari browsers. + + * Added buttons to the management pages to quickly show all documents with one specific tag, correspondent, or title. + + * Paperless now stores your saved views on the server and associates them with your user account. + This means that you can access your views on multiple devices and have separate views for different users. + You will have to recreate your views. + + * The GitHub and documentation links now open in new tabs/windows. Thanks to `rYR79435`_. + + * Paperless now generates default saved view names when saving views with certain filter rules. + + * Added a small version indicator to the front end. + +* Other additions and changes + + * The new filename format field ``{tag_list}`` inserts a list of tags into the filename, separated by comma. + * The ``document_retagger`` no longer removes inbox tags or tags without matching rules. + * The new configuration option ``PAPERLESS_COOKIE_PREFIX`` allows you to run multiple instances of paperless on different ports. + This option enables you to be logged in into multiple instances by specifying different cookie names for each instance. + +* Fixes + + * Sometimes paperless would assign dates in the future to newly consumed documents. + * The filename format fields ``{created_month}`` and ``{created_day}`` now use a leading zero for single digit values. + * The filename format field ``{tags}`` can no longer be used without arguments. + * Paperless was not able to consume many images (especially images from mobile scanners) due to missing DPI information. + Paperless now assumes A4 paper size for PDF generation if no DPI information is present. + * Documents with empty titles could not be opened from the table view due to the link being empty. + * Fixed an issue with filenames containing special characters such as ``:`` not being accepted for upload. + * Fixed issues with thumbnail generation for plain text files. + + paperless-ng 0.9.6 ################## @@ -841,6 +884,8 @@ bulk of the work on this big change. * Initial release +.. _rYR79435: https://github.com/rYR79435 +.. _Michael Shamoon: https://github.com/shamoon .. _jayme-github: http://github.com/jayme-github .. _Brian Conn: https://github.com/TheConnMan .. _Christopher Luu: https://github.com/nuudles diff --git a/docs/configuration.rst b/docs/configuration.rst index 2ec34f803..d3f47215b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -152,6 +152,16 @@ PAPERLESS_AUTO_LOGIN_USERNAME= Defaults to none, which disables this feature. + +PAPERLESS_COOKIE_PREFIX= + Specify a prefix that is added to the cookies used by paperless to identify + the currently logged in user. This is useful for when you're running two + instances of paperless on the same host. + + After changing this, you will have to login again. + + Defaults to ``""``, which does not alter the cookie names. + .. _configuration-ocr: OCR settings diff --git a/docs/faq.rst b/docs/faq.rst index 6eac18617..d9efddd0f 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -78,6 +78,12 @@ that automatically, I'm all ears. For now, you have to grab the latest release archive from the project page and build the image yourself. The release comes with the front end already compiled, so you don't have to do this on the Pi. +**Q:** *How do I run this on unRaid?* + +**A:** Head over to ``_, +`Uli Fahrer `_ created a container template for that. +I don't exactly know how to use that though, since I don't use unRaid. + **Q:** *How do I run this on my toaster?* **A:** I honestly don't know! As for all other devices that might be able diff --git a/docs/usage_overview.rst b/docs/usage_overview.rst index bb9ecd452..7a4fd7740 100644 --- a/docs/usage_overview.rst +++ b/docs/usage_overview.rst @@ -57,9 +57,6 @@ Adding documents to paperless ############################# Once you've got Paperless setup, you need to start feeding documents into it. -Currently, there are four options: the consumption directory, the dashboard, IMAP (email), and -HTTP POST. - When adding documents to paperless, it will perform the following operations on your documents: @@ -112,6 +109,17 @@ Dashboard upload The dashboard has a file drop field to upload documents to paperless. Simply drag a file onto this field or select a file with the file dialog. Multiple files are supported. + +Mobile upload +============= + +The mobile app over at ``_ allows Android users +to share any documents with paperless. This can be combined with any of the mobile +scanning apps out there, such as Office Lens. + +Furthermore, there is the `Paperless App `_ as well, +which no only has document upload, but also document editing and browsing. + .. _usage-email: IMAP (Email) diff --git a/paperless.conf.example b/paperless.conf.example index 32c0e56b4..910fc22a0 100644 --- a/paperless.conf.example +++ b/paperless.conf.example @@ -30,6 +30,7 @@ #PAPERLESS_FORCE_SCRIPT_NAME= #PAPERLESS_STATIC_URL=/static/ #PAPERLESS_AUTO_LOGIN_USERNAME= +#PAPERLESS_COOKIE_PREFIX= # OCR settings diff --git a/scripts/make-release.sh b/scripts/make-release.sh index 0a7bc7a9b..f5c9028fa 100755 --- a/scripts/make-release.sh +++ b/scripts/make-release.sh @@ -5,6 +5,7 @@ # adjust src/paperless/version.py # changelog in the documentation # adjust versions in docker/hub/* +# adjust version in src-ui/src/environments/prod # If docker-compose was modified: all compose files are the same. # Steps: diff --git a/src-ui/package-lock.json b/src-ui/package-lock.json index b6b66e1c6..5eca0b3c0 100644 --- a/src-ui/package-lock.json +++ b/src-ui/package-lock.json @@ -2215,6 +2215,11 @@ "integrity": "sha512-UV1/ZJMC+HcP902wWdpC43cAcGu0IQk/I5bXjP2aSuCjsk3cE74mDvFrLKga7oDC170ugOAYBwfT4DSQW3akDA==", "dev": true }, + "@types/pdfjs-dist": { + "version": "2.1.7", + "resolved": "https://registry.npmjs.org/@types/pdfjs-dist/-/pdfjs-dist-2.1.7.tgz", + "integrity": "sha512-nQIwcPUhkAIyn7x9NS0lR/qxYfd5unRtfGkMjvpgF4Sh28IXftRymaNmFKTTdejDNY25NDGSIyjwj/BRwAPexg==" + }, "@types/q": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", @@ -3023,6 +3028,16 @@ "integrity": "sha512-1Yj8h9Q+QDF5FzhMs/c9+6UntbD5MkRfRwac8DoEm9ZfUBZ7tZ55YcGVAzEe4bXsdQHEk+s9S5wsOKVdZrw0tQ==", "dev": true }, + "bindings": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.5.0.tgz", + "integrity": "sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==", + "dev": true, + "optional": true, + "requires": { + "file-uri-to-path": "1.0.0" + } + }, "blob": { "version": "0.0.5", "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.5.tgz", @@ -5508,6 +5523,13 @@ "schema-utils": "^2.6.5" } }, + "file-uri-to-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", + "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", + "dev": true, + "optional": true + }, "fill-range": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", @@ -8208,6 +8230,13 @@ "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", "dev": true }, + "nan": { + "version": "2.14.2", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.14.2.tgz", + "integrity": "sha512-M2ufzIiINKCuDfBSAUr1vWQ+vuVcA9kqx8JJUsbQi6yf1uGRyb7HfpdfUr5qLXf3B/t8dPvcjhKMmlfnP47EzQ==", + "dev": true, + "optional": true + }, "nanomatch": { "version": "1.2.13", "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz", @@ -8260,6 +8289,23 @@ "moment": "2.18.1" } }, + "ng2-pdf-viewer": { + "version": "6.3.2", + "resolved": "https://registry.npmjs.org/ng2-pdf-viewer/-/ng2-pdf-viewer-6.3.2.tgz", + "integrity": "sha512-H2tBhDd+Lq6CUzK2g54HsCcZDR2wTn1sDjYqKY3yF0Ydasl2R5ppCKynZBU/zge4EKvmHglJI120FbQMpJKDYQ==", + "requires": { + "@types/pdfjs-dist": "^2.1.4", + "pdfjs-dist": "^2.4.456", + "tslib": "^1.10.0" + }, + "dependencies": { + "tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==" + } + } + }, "ngx-cookie-service": { "version": "10.1.1", "resolved": "https://registry.npmjs.org/ngx-cookie-service/-/ngx-cookie-service-10.1.1.tgz", @@ -9270,6 +9316,11 @@ "sha.js": "^2.4.8" } }, + "pdfjs-dist": { + "version": "2.5.207", + "resolved": "https://registry.npmjs.org/pdfjs-dist/-/pdfjs-dist-2.5.207.tgz", + "integrity": "sha512-xGDUhnCYPfHy+unMXCLCJtlpZaaZ17Ew3WIL0tnSgKFUZXHAPD49GO9xScyszSsQMoutNDgRb+rfBXIaX/lJbw==" + }, "performance-now": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", @@ -13228,7 +13279,11 @@ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.13.tgz", "integrity": "sha512-oWb1Z6mkHIskLzEJ/XWX0srkpkTQ7vaopMQkyaEIoq0fmtFVxOthb8cCxeT+p3ynTdkk/RZwbgG4brR5BeWECw==", "dev": true, - "optional": true + "optional": true, + "requires": { + "bindings": "^1.5.0", + "nan": "^2.12.1" + } }, "glob-parent": { "version": "3.1.0", @@ -13832,7 +13887,11 @@ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.13.tgz", "integrity": "sha512-oWb1Z6mkHIskLzEJ/XWX0srkpkTQ7vaopMQkyaEIoq0fmtFVxOthb8cCxeT+p3ynTdkk/RZwbgG4brR5BeWECw==", "dev": true, - "optional": true + "optional": true, + "requires": { + "bindings": "^1.5.0", + "nan": "^2.12.1" + } }, "glob-parent": { "version": "3.1.0", diff --git a/src-ui/package.json b/src-ui/package.json index af3334db9..6293f2672 100644 --- a/src-ui/package.json +++ b/src-ui/package.json @@ -23,6 +23,7 @@ "@ng-bootstrap/ng-bootstrap": "^8.0.0", "bootstrap": "^4.5.0", "ng-bootstrap": "^1.6.3", + "ng2-pdf-viewer": "^6.3.2", "ngx-cookie-service": "^10.1.1", "ngx-file-drop": "^10.0.0", "ngx-infinite-scroll": "^9.1.0", diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index ad12c9c47..3c00cd0b7 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -14,10 +14,9 @@ import { LogsComponent } from './components/manage/logs/logs.component'; import { SettingsComponent } from './components/manage/settings/settings.component'; import { FormsModule, ReactiveFormsModule } from '@angular/forms'; import { DatePipe } from '@angular/common'; -import { SafePipe } from './pipes/safe.pipe'; import { NotFoundComponent } from './components/not-found/not-found.component'; import { CorrespondentListComponent } from './components/manage/correspondent-list/correspondent-list.component'; -import { DeleteDialogComponent } from './components/common/delete-dialog/delete-dialog.component'; +import { ConfirmDialogComponent } from './components/common/confirm-dialog/confirm-dialog.component'; import { CorrespondentEditDialogComponent } from './components/manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component'; import { TagEditDialogComponent } from './components/manage/tag-list/tag-edit-dialog/tag-edit-dialog.component'; import { DocumentTypeEditDialogComponent } from './components/manage/document-type-list/document-type-edit-dialog/document-type-edit-dialog.component'; @@ -28,6 +27,9 @@ import { PageHeaderComponent } from './components/common/page-header/page-header import { AppFrameComponent } from './components/app-frame/app-frame.component'; import { ToastsComponent } from './components/common/toasts/toasts.component'; import { FilterEditorComponent } from './components/filter-editor/filter-editor.component'; +import { FilterDropdownComponent } from './components/filter-editor/filter-dropdown/filter-dropdown.component'; +import { FilterDropdownButtonComponent } from './components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component'; +import { FilterDropdownDateComponent } from './components/filter-editor/filter-dropdown-date/filter-dropdown-date.component'; import { DocumentCardLargeComponent } from './components/document-list/document-card-large/document-card-large.component'; import { DocumentCardSmallComponent } from './components/document-list/document-card-small/document-card-small.component'; import { NgxFileDropModule } from 'ngx-file-drop'; @@ -45,9 +47,13 @@ import { SavedViewWidgetComponent } from './components/dashboard/widgets/saved-v import { StatisticsWidgetComponent } from './components/dashboard/widgets/statistics-widget/statistics-widget.component'; import { UploadFileWidgetComponent } from './components/dashboard/widgets/upload-file-widget/upload-file-widget.component'; import { WidgetFrameComponent } from './components/dashboard/widgets/widget-frame/widget-frame.component'; +import { PdfViewerModule } from 'ng2-pdf-viewer'; import { WelcomeWidgetComponent } from './components/dashboard/widgets/welcome-widget/welcome-widget.component'; import { YesNoPipe } from './pipes/yes-no.pipe'; import { FileSizePipe } from './pipes/file-size.pipe'; +import { FilterPipe } from './pipes/filter.pipe'; +import { DocumentTitlePipe } from './pipes/document-title.pipe'; +import { MetadataCollapseComponent } from './components/document-detail/metadata-collapse/metadata-collapse.component'; @NgModule({ declarations: [ @@ -60,10 +66,9 @@ import { FileSizePipe } from './pipes/file-size.pipe'; DocumentTypeListComponent, LogsComponent, SettingsComponent, - SafePipe, NotFoundComponent, CorrespondentEditDialogComponent, - DeleteDialogComponent, + ConfirmDialogComponent, TagEditDialogComponent, DocumentTypeEditDialogComponent, TagComponent, @@ -73,6 +78,9 @@ import { FileSizePipe } from './pipes/file-size.pipe'; AppFrameComponent, ToastsComponent, FilterEditorComponent, + FilterDropdownComponent, + FilterDropdownButtonComponent, + FilterDropdownDateComponent, DocumentCardLargeComponent, DocumentCardSmallComponent, TextComponent, @@ -88,7 +96,10 @@ import { FileSizePipe } from './pipes/file-size.pipe'; WidgetFrameComponent, WelcomeWidgetComponent, YesNoPipe, - FileSizePipe + FileSizePipe, + FilterPipe, + DocumentTitlePipe, + MetadataCollapseComponent ], imports: [ BrowserModule, @@ -98,7 +109,8 @@ import { FileSizePipe } from './pipes/file-size.pipe'; FormsModule, ReactiveFormsModule, NgxFileDropModule, - InfiniteScrollModule + InfiniteScrollModule, + PdfViewerModule ], providers: [ DatePipe, @@ -106,7 +118,9 @@ import { FileSizePipe } from './pipes/file-size.pipe'; provide: HTTP_INTERCEPTORS, useClass: CsrfInterceptor, multi: true - } + }, + FilterPipe, + DocumentTitlePipe ], bootstrap: [AppComponent] }) diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index 3f326afdd..2458005f4 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -17,6 +17,11 @@
\ No newline at end of file +
diff --git a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.scss b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.scss index d6be8837e..11fb10562 100644 --- a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.scss +++ b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.scss @@ -1,5 +1,6 @@ .result-content { color: darkgray; + overflow-wrap: anywhere; } .doc-img { diff --git 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 index ac2fdba27..2e056cc70 100644 --- 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 @@ -1,7 +1,6 @@ import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; import { DomSanitizer } from '@angular/platform-browser'; import { PaperlessDocument } from 'src/app/data/paperless-document'; -import { PaperlessTag } from 'src/app/data/paperless-tag'; import { DocumentService } from 'src/app/services/rest/document.service'; @Component({ diff --git 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 index da469ebc4..2647e702c 100644 --- 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 @@ -11,13 +11,13 @@ - +

{{(document.correspondent$ | async)?.name}}: - {{document.title}} + {{document.title | documentTitle}}

@@ -44,7 +44,7 @@
{{document.created | date}} - + - - \ No newline at end of file + + diff --git 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 index d60552d4f..d87eb4331 100644 --- 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 @@ -1,7 +1,6 @@ import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; import { map } from 'rxjs/operators'; import { PaperlessDocument } from 'src/app/data/paperless-document'; -import { PaperlessTag } from 'src/app/data/paperless-tag'; import { DocumentService } from 'src/app/services/rest/document.service'; @Component({ diff --git a/src-ui/src/app/components/document-list/document-list.component.html b/src-ui/src/app/components/document-list/document-list.component.html index 1a8c7a781..5c09f6c13 100644 --- a/src-ui/src/app/components/document-list/document-list.component.html +++ b/src-ui/src/app/components/document-list/document-list.component.html @@ -1,5 +1,4 @@ -
-
+ +
@@ -30,48 +30,40 @@
+
- -
- -
- - -
+ +
+ + +
- +
+ -
-
-
Filter
- -
+
+
@@ -81,7 +73,7 @@
- +
@@ -101,16 +93,16 @@ - {{(d.correspondent$ | async)?.name}} + {{(d.correspondent$ | async)?.name}} - {{d.title}} - + {{d.title | documentTitle}} + - {{(d.document_type$ | async)?.name}} + {{(d.document_type$ | async)?.name}} @@ -125,5 +117,5 @@
- +
diff --git a/src-ui/src/app/components/document-list/document-list.component.ts b/src-ui/src/app/components/document-list/document-list.component.ts index 09e73dd96..25d92e9db 100644 --- a/src-ui/src/app/components/document-list/document-list.component.ts +++ b/src-ui/src/app/components/document-list/document-list.component.ts @@ -1,15 +1,13 @@ -import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; -import { ActivatedRoute } from '@angular/router'; +import { Component, OnInit, ViewChild } from '@angular/core'; +import { ActivatedRoute, Router } from '@angular/router'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; -import { cloneFilterRules, FilterRule } from 'src/app/data/filter-rule'; -import { FILTER_CORRESPONDENT, FILTER_DOCUMENT_TYPE, FILTER_HAS_TAG, FILTER_RULE_TYPES } from 'src/app/data/filter-rule-type'; -import { SavedViewConfig } from 'src/app/data/saved-view-config'; +import { FILTER_CORRESPONDENT } from 'src/app/data/filter-rule-type'; +import { PaperlessSavedView } from 'src/app/data/paperless-saved-view'; import { DocumentListViewService } from 'src/app/services/document-list-view.service'; import { DOCUMENT_SORT_FIELDS } from 'src/app/services/rest/document.service'; -import { SavedViewConfigService } from 'src/app/services/saved-view-config.service'; +import { SavedViewService } from 'src/app/services/rest/saved-view.service'; import { Toast, ToastService } from 'src/app/services/toast.service'; -import { environment } from 'src/environments/environment'; +import { FilterEditorComponent } from '../filter-editor/filter-editor.component'; import { SaveViewConfigDialogComponent } from './save-view-config-dialog/save-view-config-dialog.component'; @Component({ @@ -21,17 +19,17 @@ export class DocumentListComponent implements OnInit { constructor( public list: DocumentListViewService, - public savedViewConfigService: SavedViewConfigService, + public savedViewService: SavedViewService, public route: ActivatedRoute, + private router: Router, private toastService: ToastService, - public modalService: NgbModal, - private titleService: Title) { } + public modalService: NgbModal) { } + + @ViewChild("filterEditor") + private filterEditor: FilterEditorComponent displayMode = 'smallCards' // largeCards, smallCards, details - filterRules: FilterRule[] = [] - showFilter = false - get isFiltered() { return this.list.filterRules?.length > 0 } @@ -53,93 +51,66 @@ export class DocumentListComponent implements OnInit { this.displayMode = localStorage.getItem('document-list:displayMode') } this.route.paramMap.subscribe(params => { + this.list.clear() if (params.has('id')) { - this.list.savedView = this.savedViewConfigService.getConfig(params.get('id')) - this.filterRules = this.list.filterRules - this.showFilter = false - this.titleService.setTitle(`${this.list.savedView.title} - ${environment.appTitle}`) + this.savedViewService.getCached(+params.get('id')).subscribe(view => { + if (!view) { + this.router.navigate(["404"]) + return + } + + this.list.savedView = view + this.list.reload() + }) } else { this.list.savedView = null - this.filterRules = this.list.filterRules - this.showFilter = this.filterRules.length > 0 - this.titleService.setTitle(`Documents - ${environment.appTitle}`) + this.list.reload() } - this.list.clear() - this.list.reload() }) } - applyFilterRules() { - this.list.filterRules = this.filterRules - } - clearFilterRules() { - this.list.filterRules = this.filterRules - this.showFilter = false - } - - loadViewConfig(config: SavedViewConfig) { - this.filterRules = cloneFilterRules(config.filterRules) - this.list.load(config) + loadViewConfig(view: PaperlessSavedView) { + this.list.load(view) + this.list.reload() } saveViewConfig() { - this.savedViewConfigService.updateConfig(this.list.savedView) - this.toastService.showToast(Toast.make("Information", `View "${this.list.savedView.title}" saved successfully.`)) + this.savedViewService.update(this.list.savedView).subscribe(result => { + this.toastService.showToast(Toast.make("Information", `View "${this.list.savedView.name}" saved successfully.`)) + }) + } saveViewConfigAs() { let modal = this.modalService.open(SaveViewConfigDialogComponent, {backdrop: 'static'}) + modal.componentInstance.defaultName = this.filterEditor.generateFilterName() modal.componentInstance.saveClicked.subscribe(formValue => { - this.savedViewConfigService.newConfig({ - title: formValue.title, - showInDashboard: formValue.showInDashboard, - showInSideBar: formValue.showInSideBar, - filterRules: this.list.filterRules, - sortDirection: this.list.sortDirection, - sortField: this.list.sortField + let savedView = { + name: formValue.name, + show_on_dashboard: formValue.showOnDashboard, + show_in_sidebar: formValue.showInSideBar, + filter_rules: this.list.filterRules, + sort_reverse: this.list.sortReverse, + sort_field: this.list.sortField + } + this.savedViewService.create(savedView).subscribe(() => { + modal.close() + this.toastService.showToast(Toast.make("Information", `View "${savedView.name}" created successfully.`)) }) - modal.close() }) } - filterByTag(tag_id: number) { - let filterRules = this.list.filterRules - if (filterRules.find(rule => rule.type.id == FILTER_HAS_TAG && rule.value == tag_id)) { - return - } - - filterRules.push({type: FILTER_RULE_TYPES.find(t => t.id == FILTER_HAS_TAG), value: tag_id}) - this.filterRules = filterRules - this.applyFilterRules() + clickTag(tagID: number) { + this.filterEditor.toggleTag(tagID) } - filterByCorrespondent(correspondent_id: number) { - let filterRules = this.list.filterRules - let existing_rule = filterRules.find(rule => rule.type.id == FILTER_CORRESPONDENT) - if (existing_rule && existing_rule.value == correspondent_id) { - return - } else if (existing_rule) { - existing_rule.value = correspondent_id - } else { - filterRules.push({type: FILTER_RULE_TYPES.find(t => t.id == FILTER_CORRESPONDENT), value: correspondent_id}) - } - this.filterRules = filterRules - this.applyFilterRules() + clickCorrespondent(correspondentID: number) { + this.filterEditor.toggleCorrespondent(correspondentID) } - filterByDocumentType(document_type_id: number) { - let filterRules = this.list.filterRules - let existing_rule = filterRules.find(rule => rule.type.id == FILTER_DOCUMENT_TYPE) - if (existing_rule && existing_rule.value == document_type_id) { - return - } else if (existing_rule) { - existing_rule.value = document_type_id - } else { - filterRules.push({type: FILTER_RULE_TYPES.find(t => t.id == FILTER_DOCUMENT_TYPE), value: document_type_id}) - } - this.filterRules = filterRules - this.applyFilterRules() + clickDocumentType(documentTypeID: number) { + this.filterEditor.toggleDocumentType(documentTypeID) } } diff --git a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html index 870431096..8819aa313 100644 --- a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html +++ b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html @@ -6,9 +6,9 @@
- + - +
diff --git a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts index 0dd351770..8f0eb26f2 100644 --- a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts +++ b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts @@ -1,4 +1,4 @@ -import { Component, EventEmitter, OnInit, Output } from '@angular/core'; +import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; import { FormControl, FormGroup } from '@angular/forms'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; @@ -14,10 +14,23 @@ export class SaveViewConfigDialogComponent implements OnInit { @Output() public saveClicked = new EventEmitter() + _defaultName = "" + + get defaultName() { + return this._defaultName + } + + @Input() + set defaultName(value: string) { + this._defaultName = value + this.saveViewConfigForm.patchValue({name: value}) + } + + saveViewConfigForm = new FormGroup({ - title: new FormControl(''), + name: new FormControl(''), showInSideBar: new FormControl(false), - showInDashboard: new FormControl(false), + showOnDashboard: new FormControl(false), }) ngOnInit(): void { diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.html b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.html new file mode 100644 index 000000000..6f6a42fe2 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.html @@ -0,0 +1,43 @@ +
+ +
+
+ + + + +
+
+
diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.scss b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.scss new file mode 100644 index 000000000..3bdedd8a0 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.scss @@ -0,0 +1,7 @@ +.date-filter { + min-width: 250px; + + .btn-link { + line-height: 1; + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.spec.ts b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.spec.ts new file mode 100644 index 000000000..6bf59e2e7 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.spec.ts @@ -0,0 +1,25 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; + +import { FilterDropdownDateComponent } from './filter-dropdown-date.component'; + +describe('FilterDropdownDateComponent', () => { + let component: FilterDropdownDateComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ FilterDropdownDateComponent ] + }) + .compileComponents(); + }); + + beforeEach(() => { + fixture = TestBed.createComponent(FilterDropdownDateComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.ts b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.ts new file mode 100644 index 000000000..91402d084 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown-date/filter-dropdown-date.component.ts @@ -0,0 +1,112 @@ +import { Component, EventEmitter, Input, Output, ElementRef, ViewChild, SimpleChange } from '@angular/core'; +import { NgbDate, NgbDateStruct, NgbDatepicker } from '@ng-bootstrap/ng-bootstrap'; + +export interface DateSelection { + before?: NgbDateStruct + after?: NgbDateStruct +} + + +@Component({ + selector: 'app-filter-dropdown-date', + templateUrl: './filter-dropdown-date.component.html', + styleUrls: ['./filter-dropdown-date.component.scss'] +}) +export class FilterDropdownDateComponent { + + @Input() + dateBefore: NgbDateStruct + + @Input() + dateAfter: NgbDateStruct + + @Input() + title: string + + @Output() + datesSet = new EventEmitter() + + @ViewChild('dpAfter') dpAfter: NgbDatepicker + @ViewChild('dpBefore') dpBefore: NgbDatepicker + + _dateBefore: NgbDateStruct + _dateAfter: NgbDateStruct + + get _maxDate(): NgbDate { + let date = new Date() + return NgbDate.from({year: date.getFullYear(), month: date.getMonth() + 1, day: date.getDate()}) + } + + isStringRange(range: any) { + return typeof range == 'string' + } + + ngOnChanges(changes: SimpleChange) { + // this is a hacky workaround perhaps because of https://github.com/angular/angular/issues/11097 + let dateString: string = '' + let dateAfterChange: SimpleChange + let dateBeforeChange: SimpleChange + if (changes) { + dateAfterChange = changes['dateAfter'] + dateBeforeChange = changes['dateBefore'] + } + + if (this.dpBefore && this.dpAfter) { + let dpAfterElRef: ElementRef = this.dpAfter['_elRef'] + let dpBeforeElRef: ElementRef = this.dpBefore['_elRef'] + + if (dateAfterChange && dateAfterChange.currentValue) { + let dateAfterDate = dateAfterChange.currentValue as NgbDateStruct + dateString = `${dateAfterDate.year}-${dateAfterDate.month.toString().padStart(2,'0')}-${dateAfterDate.day.toString().padStart(2,'0')}` + dpAfterElRef.nativeElement.value = dateString + } else if (dateBeforeChange && dateBeforeChange.currentValue) { + let dateBeforeDate = dateBeforeChange.currentValue as NgbDateStruct + dateString = `${dateBeforeDate.year}-${dateBeforeDate.month.toString().padStart(2,'0')}-${dateBeforeDate.day.toString().padStart(2,'0')}` + dpBeforeElRef.nativeElement.value = dateString + } else { + dpAfterElRef.nativeElement.value = dateString + dpBeforeElRef.nativeElement.value = dateString + } + } + } + + setDateQuickFilter(range: any) { + let date = new Date() + let newDate: NgbDateStruct = { year: date.getFullYear(), month: date.getMonth() + 1, day: date.getDate() } + switch (typeof range) { + case 'number': + date.setDate(date.getDate() - range) + newDate.year = date.getFullYear() + newDate.month = date.getMonth() + 1 + newDate.day = date.getDate() + break + + case 'string': + newDate.day = 1 + if (range == 'year') newDate.month = 1 + break + + default: + break + } + this._dateAfter = newDate + this._dateBefore = null + this.datesSet.emit({after: newDate, before: null}) + } + + onBeforeSelected(date: NgbDateStruct) { + this._dateBefore = date + this.datesSet.emit({after: this._dateAfter, before: date}) + } + + onAfterSelected(date: NgbDateStruct) { + this._dateAfter = date + this.datesSet.emit({after: date, before: this._dateBefore}) + } + + clear() { + this._dateBefore = null + this._dateAfter = null + this.datesSet.emit({after: null, before: null}) + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.html b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.html new file mode 100644 index 000000000..8dff12a33 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.html @@ -0,0 +1,12 @@ + diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.scss b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.scss new file mode 100644 index 000000000..41fc6acc4 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.scss @@ -0,0 +1,4 @@ +.selected-icon { + min-width: 1em; + min-height: 1em; +} diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.spec.ts b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.spec.ts new file mode 100644 index 000000000..5cf1fefa2 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.spec.ts @@ -0,0 +1,25 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; + +import { FilterDropodownButtonComponent } from './filter-dropdown-button.component'; + +describe('FilterDropodownButtonComponent', () => { + let component: FilterDropodownButtonComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ FilterDropodownButtonComponent ] + }) + .compileComponents(); + }); + + beforeEach(() => { + fixture = TestBed.createComponent(FilterDropodownButtonComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.ts b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.ts new file mode 100644 index 000000000..d3ddd3cbf --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component.ts @@ -0,0 +1,32 @@ +import { Component, EventEmitter, Input, Output, OnInit } from '@angular/core'; +import { PaperlessTag } from 'src/app/data/paperless-tag'; +import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent'; +import { PaperlessDocumentType } from 'src/app/data/paperless-document-type'; + +@Component({ + selector: 'app-filter-dropdown-button', + templateUrl: './filter-dropdown-button.component.html', + styleUrls: ['./filter-dropdown-button.component.scss'] +}) +export class FilterDropdownButtonComponent implements OnInit { + + @Input() + item: PaperlessTag | PaperlessDocumentType | PaperlessCorrespondent + + @Input() + selected: boolean + + @Output() + toggle = new EventEmitter() + + isTag: boolean + + ngOnInit() { + this.isTag = 'is_inbox_tag' in this.item // ~ this.item instanceof PaperlessTag + } + + toggleItem(): void { + this.selected = !this.selected + this.toggle.emit(this.item) + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.html b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.html new file mode 100644 index 000000000..d0cbfc3c9 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.html @@ -0,0 +1,29 @@ +
+ +
+
+
+
+ +
+
+
+ + + +
+
+
+
diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.scss b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.scss new file mode 100644 index 000000000..40c93838f --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.scss @@ -0,0 +1,14 @@ +.badge-corner { + position: absolute; + top: -8px; + right: -8px; +} + +.dropdown-menu { + min-width: 250px; + + .items { + max-height: 400px; + overflow-y: scroll; + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.spec.ts b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.spec.ts new file mode 100644 index 000000000..29edd7c45 --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.spec.ts @@ -0,0 +1,25 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; + +import { FilterDropodownComponent } from './filter-dropdown.component'; + +describe('FilterDropodownComponent', () => { + let component: FilterDropodownComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + declarations: [ FilterDropodownComponent ] + }) + .compileComponents(); + }); + + beforeEach(() => { + fixture = TestBed.createComponent(FilterDropodownComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.ts b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.ts new file mode 100644 index 000000000..b9d3fca6f --- /dev/null +++ b/src-ui/src/app/components/filter-editor/filter-dropdown/filter-dropdown.component.ts @@ -0,0 +1,58 @@ +import { Component, EventEmitter, Input, Output, ElementRef, ViewChild } from '@angular/core'; +import { ObjectWithId } from 'src/app/data/object-with-id'; +import { FilterPipe } from 'src/app/pipes/filter.pipe'; +import { NgbDropdown } from '@ng-bootstrap/ng-bootstrap' + +@Component({ + selector: 'app-filter-dropdown', + templateUrl: './filter-dropdown.component.html', + styleUrls: ['./filter-dropdown.component.scss'] +}) +export class FilterDropdownComponent { + + constructor(private filterPipe: FilterPipe) { } + + @Input() + items: ObjectWithId[] + + @Input() + itemsSelected: ObjectWithId[] + + @Input() + title: string + + @Input() + icon: string + + @Output() + toggle = new EventEmitter() + + @ViewChild('listFilterTextInput') listFilterTextInput: ElementRef + @ViewChild('filterDropdown') filterDropdown: NgbDropdown + + filterText: string + + toggleItem(item: ObjectWithId): void { + this.toggle.emit(item) + } + + isItemSelected(item: ObjectWithId): boolean { + return this.itemsSelected?.find(i => i.id == item.id) !== undefined + } + + dropdownOpenChange(open: boolean): void { + if (open) { + setTimeout(() => { + this.listFilterTextInput.nativeElement.focus(); + }, 0); + } else { + this.filterText = '' + } + } + + listFilterEnter(): void { + let filtered = this.filterPipe.transform(this.items, this.filterText) + if (filtered.length == 1) this.toggleItem(filtered.shift()) + this.filterDropdown.close() + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-editor.component.html b/src-ui/src/app/components/filter-editor/filter-editor.component.html index 48780e950..6847a2902 100644 --- a/src-ui/src/app/components/filter-editor/filter-editor.component.html +++ b/src-ui/src/app/components/filter-editor/filter-editor.component.html @@ -1,52 +1,27 @@ -
-
- {{rule.type.name}} -
-
- - - - - - - - - - - - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- +
+
+
+ + +
+
+
+
+ + + + + +
+
+
+
+ +
diff --git a/src-ui/src/app/components/filter-editor/filter-editor.component.scss b/src-ui/src/app/components/filter-editor/filter-editor.component.scss index e69de29bb..05df7b213 100644 --- a/src-ui/src/app/components/filter-editor/filter-editor.component.scss +++ b/src-ui/src/app/components/filter-editor/filter-editor.component.scss @@ -0,0 +1,10 @@ +.quick-filter { + min-width: 250px; + max-height: 400px; + overflow-y: scroll; + + .selected-icon { + min-width: 1em; + min-height: 1em; + } +} diff --git a/src-ui/src/app/components/filter-editor/filter-editor.component.ts b/src-ui/src/app/components/filter-editor/filter-editor.component.ts index b04127287..f762c6138 100644 --- a/src-ui/src/app/components/filter-editor/filter-editor.component.ts +++ b/src-ui/src/app/components/filter-editor/filter-editor.component.ts @@ -1,67 +1,240 @@ -import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; -import { FilterRule } from 'src/app/data/filter-rule'; -import { FilterRuleType, FILTER_RULE_TYPES } from 'src/app/data/filter-rule-type'; +import { Component, EventEmitter, Input, Output, OnInit, OnDestroy } from '@angular/core'; +import { PaperlessTag } from 'src/app/data/paperless-tag'; import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent'; import { PaperlessDocumentType } from 'src/app/data/paperless-document-type'; -import { PaperlessTag } from 'src/app/data/paperless-tag'; -import { CorrespondentService } from 'src/app/services/rest/correspondent.service'; +import { Subject, Subscription } from 'rxjs'; +import { debounceTime, distinctUntilChanged } from 'rxjs/operators'; +import { NgbDateParserFormatter, NgbDateStruct } from '@ng-bootstrap/ng-bootstrap'; import { DocumentTypeService } from 'src/app/services/rest/document-type.service'; import { TagService } from 'src/app/services/rest/tag.service'; - +import { CorrespondentService } from 'src/app/services/rest/correspondent.service'; +import { FilterRule } from 'src/app/data/filter-rule'; +import { FILTER_ADDED_AFTER, FILTER_ADDED_BEFORE, FILTER_CORRESPONDENT, FILTER_CREATED_AFTER, FILTER_CREATED_BEFORE, FILTER_DOCUMENT_TYPE, FILTER_HAS_TAG, FILTER_RULE_TYPES, FILTER_TITLE } from 'src/app/data/filter-rule-type'; +import { DateSelection } from './filter-dropdown-date/filter-dropdown-date.component'; @Component({ selector: 'app-filter-editor', templateUrl: './filter-editor.component.html', styleUrls: ['./filter-editor.component.scss'] }) -export class FilterEditorComponent implements OnInit { +export class FilterEditorComponent implements OnInit, OnDestroy { - constructor(private documentTypeService: DocumentTypeService, private tagService: TagService, private correspondentService: CorrespondentService) { } + generateFilterName() { + if (this.filterRules.length == 1) { + let rule = this.filterRules[0] + switch(this.filterRules[0].rule_type) { + + case FILTER_CORRESPONDENT: + return `Correspondent: ${this.correspondents.find(c => c.id == +rule.value)?.name}` - @Output() - clear = new EventEmitter() + case FILTER_DOCUMENT_TYPE: + return `Type: ${this.documentTypes.find(dt => dt.id == +rule.value)?.name}` - @Input() - filterRules: FilterRule[] = [] + case FILTER_HAS_TAG: + return `Tag: ${this.tags.find(t => t.id == +rule.value)?.name}` - @Output() - apply = new EventEmitter() + } + } - selectedRuleType: FilterRuleType = FILTER_RULE_TYPES[0] - - correspondents: PaperlessCorrespondent[] = [] - tags: PaperlessTag[] = [] - documentTypes: PaperlessDocumentType[] = [] - - newRuleClicked() { - this.filterRules.push({type: this.selectedRuleType, value: this.selectedRuleType.default}) - this.selectedRuleType = this.getRuleTypes().length > 0 ? this.getRuleTypes()[0] : null + return "" } - removeRuleClicked(rule) { - let index = this.filterRules.findIndex(r => r == rule) - if (index > -1) { - this.filterRules.splice(index, 1) + constructor( + private documentTypeService: DocumentTypeService, + private tagService: TagService, + private correspondentService: CorrespondentService, + private dateParser: NgbDateParserFormatter + ) { } + + tags: PaperlessTag[] = [] + correspondents: PaperlessCorrespondent[] + documentTypes: PaperlessDocumentType[] = [] + + @Input() + filterRules: FilterRule[] + + @Output() + filterRulesChange = new EventEmitter() + + hasFilters() { + return this.filterRules.length > 0 + } + + get selectedTags(): PaperlessTag[] { + let tagRules: FilterRule[] = this.filterRules.filter(fr => fr.rule_type == FILTER_HAS_TAG) + return this.tags?.filter(t => tagRules.find(tr => +tr.value == t.id)) + } + + get selectedCorrespondents(): PaperlessCorrespondent[] { + let correspondentRules: FilterRule[] = this.filterRules.filter(fr => fr.rule_type == FILTER_CORRESPONDENT) + return this.correspondents?.filter(c => correspondentRules.find(cr => +cr.value == c.id)) + } + + get selectedDocumentTypes(): PaperlessDocumentType[] { + let documentTypeRules: FilterRule[] = this.filterRules.filter(fr => fr.rule_type == FILTER_DOCUMENT_TYPE) + return this.documentTypes?.filter(dt => documentTypeRules.find(dtr => +dtr.value == dt.id)) + } + + get titleFilter() { + let existingRule = this.filterRules.find(rule => rule.rule_type == FILTER_TITLE) + return existingRule ? existingRule.value : '' + } + + set titleFilter(value) { + this.titleFilterDebounce.next(value) + } + + titleFilterDebounce: Subject + subscription: Subscription + + ngOnInit() { + this.tagService.listAll().subscribe(result => this.tags = result.results) + this.correspondentService.listAll().subscribe(result => this.correspondents = result.results) + this.documentTypeService.listAll().subscribe(result => this.documentTypes = result.results) + + this.titleFilterDebounce = new Subject() + + this.subscription = this.titleFilterDebounce.pipe( + debounceTime(400), + distinctUntilChanged() + ).subscribe(title => { + this.setTitleRule(title) + }) + } + + ngOnDestroy() { + this.titleFilterDebounce.complete() + // TODO: not sure if both is necessary + this.subscription.unsubscribe() + } + + applyFilters() { + this.filterRulesChange.next(this.filterRules) + } + + clearSelected() { + this.filterRules = [] + this.applyFilters() + } + + private toggleFilterRule(filterRuleTypeID: number, value: number) { + + let filterRuleType = FILTER_RULE_TYPES.find(t => t.id == filterRuleTypeID) + + let existingRule = this.filterRules.find(rule => rule.rule_type == filterRuleTypeID && rule.value == value?.toString()) + let existingRuleOfSameType = this.filterRules.find(rule => rule.rule_type == filterRuleTypeID) + + if (existingRule) { + // if this exact rule already exists, remove it in all cases. + this.filterRules.splice(this.filterRules.indexOf(existingRule), 1) + } else if (filterRuleType.multi || !existingRuleOfSameType) { + // if we allow multiple rules per type, or no rule of this type already exists, push a new rule. + this.filterRules.push({rule_type: filterRuleTypeID, value: value?.toString()}) + } else { + // otherwise (i.e., no multi support AND there's already a rule of this type), update the rule. + existingRuleOfSameType.value = value?.toString() + } + this.applyFilters() + } + + private setTitleRule(title: string) { + let existingRule = this.filterRules.find(rule => rule.rule_type == FILTER_TITLE) + + if (!existingRule && title) { + this.filterRules.push({rule_type: FILTER_TITLE, value: title}) + } else if (existingRule && !title) { + this.filterRules.splice(this.filterRules.findIndex(rule => rule.rule_type == FILTER_TITLE), 1) + } else if (existingRule && title) { + existingRule.value = title + } + this.applyFilters() + } + + toggleTag(tagId: number) { + this.toggleFilterRule(FILTER_HAS_TAG, tagId) + } + + toggleCorrespondent(correspondentId: number) { + this.toggleFilterRule(FILTER_CORRESPONDENT, correspondentId) + } + + toggleDocumentType(documentTypeId: number) { + this.toggleFilterRule(FILTER_DOCUMENT_TYPE, documentTypeId) + } + + + + // Date handling + + + onDatesCreatedSet(dates: DateSelection) { + this.setDateCreatedBefore(dates.before) + this.setDateCreatedAfter(dates.after) + this.applyFilters() + } + + onDatesAddedSet(dates: DateSelection) { + this.setDateAddedBefore(dates.before) + this.setDateAddedAfter(dates.after) + this.applyFilters() + } + + get dateCreatedBefore(): NgbDateStruct { + let createdBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_BEFORE) + return createdBeforeRule ? this.dateParser.parse(createdBeforeRule.value) : null + } + + get dateCreatedAfter(): NgbDateStruct { + let createdAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_AFTER) + return createdAfterRule ? this.dateParser.parse(createdAfterRule.value) : null + } + + get dateAddedBefore(): NgbDateStruct { + let addedBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_BEFORE) + return addedBeforeRule ? this.dateParser.parse(addedBeforeRule.value) : null + } + + get dateAddedAfter(): NgbDateStruct { + let addedAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_AFTER) + return addedAfterRule ? this.dateParser.parse(addedAfterRule.value) : null + } + + setDateCreatedBefore(date?: NgbDateStruct) { + if (date) this.setDateFilter(date, FILTER_CREATED_BEFORE) + else this.clearDateFilter(FILTER_CREATED_BEFORE) + } + + setDateCreatedAfter(date?: NgbDateStruct) { + if (date) this.setDateFilter(date, FILTER_CREATED_AFTER) + else this.clearDateFilter(FILTER_CREATED_AFTER) + } + + setDateAddedBefore(date?: NgbDateStruct) { + if (date) this.setDateFilter(date, FILTER_ADDED_BEFORE) + else this.clearDateFilter(FILTER_ADDED_BEFORE) + } + + setDateAddedAfter(date?: NgbDateStruct) { + if (date) this.setDateFilter(date, FILTER_ADDED_AFTER) + else this.clearDateFilter(FILTER_ADDED_AFTER) + } + + setDateFilter(date: NgbDateStruct, dateRuleTypeID: number) { + let existingRule = this.filterRules.find(rule => rule.rule_type == dateRuleTypeID) + let newValue = this.dateParser.format(date) + + if (existingRule) { + existingRule.value = newValue + } else { + this.filterRules.push({rule_type: dateRuleTypeID, value: newValue}) } } - applyClicked() { - this.apply.next() - } - - clearClicked() { - this.filterRules.splice(0,this.filterRules.length) - this.clear.next() - } - - ngOnInit(): void { - this.correspondentService.listAll().subscribe(result => {this.correspondents = result.results}) - this.tagService.listAll().subscribe(result => this.tags = result.results) - this.documentTypeService.listAll().subscribe(result => this.documentTypes = result.results) - } - - getRuleTypes() { - return FILTER_RULE_TYPES.filter(rt => rt.multi || !this.filterRules.find(r => r.type == rt)) + clearDateFilter(dateRuleTypeID: number) { + let ruleIndex = this.filterRules.findIndex(rule => rule.rule_type == dateRuleTypeID) + if (ruleIndex != -1) { + this.filterRules.splice(ruleIndex, 1) + } } } diff --git a/src-ui/src/app/components/manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component.ts b/src-ui/src/app/components/manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component.ts index 855fc159c..bc6b2a823 100644 --- a/src-ui/src/app/components/manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component.ts +++ b/src-ui/src/app/components/manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component.ts @@ -1,4 +1,4 @@ -import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; +import { Component } from '@angular/core'; import { FormControl, FormGroup } from '@angular/forms'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component'; diff --git a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.html b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.html index 27aa4d366..2efd1c58d 100644 --- a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.html +++ b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.html @@ -26,9 +26,26 @@ {{ correspondent.last_correspondence | date }}
- - -
+ + + +
diff --git a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.ts b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.ts index 11027c60f..a128340b9 100644 --- a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.ts +++ b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.ts @@ -1,9 +1,10 @@ import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; +import { Router } from '@angular/router'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { FILTER_CORRESPONDENT } from 'src/app/data/filter-rule-type'; import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent'; +import { DocumentListViewService } from 'src/app/services/document-list-view.service'; import { CorrespondentService } from 'src/app/services/rest/correspondent.service'; -import { environment } from 'src/environments/environment'; import { GenericListComponent } from '../generic-list/generic-list.component'; import { CorrespondentEditDialogComponent } from './correspondent-edit-dialog/correspondent-edit-dialog.component'; @@ -12,9 +13,12 @@ import { CorrespondentEditDialogComponent } from './correspondent-edit-dialog/co templateUrl: './correspondent-list.component.html', styleUrls: ['./correspondent-list.component.scss'] }) -export class CorrespondentListComponent extends GenericListComponent implements OnInit { +export class CorrespondentListComponent extends GenericListComponent { - constructor(correspondentsService: CorrespondentService, modalService: NgbModal, private titleService: Title) { + constructor(correspondentsService: CorrespondentService, modalService: NgbModal, + private router: Router, + private list: DocumentListViewService + ) { super(correspondentsService,modalService,CorrespondentEditDialogComponent) } @@ -22,9 +26,10 @@ export class CorrespondentListComponent extends GenericListComponent{{ document_type.document_count }}
- - + + +
diff --git a/src-ui/src/app/components/manage/document-type-list/document-type-list.component.ts b/src-ui/src/app/components/manage/document-type-list/document-type-list.component.ts index 316024514..d18a19226 100644 --- a/src-ui/src/app/components/manage/document-type-list/document-type-list.component.ts +++ b/src-ui/src/app/components/manage/document-type-list/document-type-list.component.ts @@ -1,9 +1,10 @@ -import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; +import { Component } from '@angular/core'; +import { Router } from '@angular/router'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { FILTER_DOCUMENT_TYPE } from 'src/app/data/filter-rule-type'; import { PaperlessDocumentType } from 'src/app/data/paperless-document-type'; +import { DocumentListViewService } from 'src/app/services/document-list-view.service'; import { DocumentTypeService } from 'src/app/services/rest/document-type.service'; -import { environment } from 'src/environments/environment'; import { GenericListComponent } from '../generic-list/generic-list.component'; import { DocumentTypeEditDialogComponent } from './document-type-edit-dialog/document-type-edit-dialog.component'; @@ -12,9 +13,12 @@ import { DocumentTypeEditDialogComponent } from './document-type-edit-dialog/doc templateUrl: './document-type-list.component.html', styleUrls: ['./document-type-list.component.scss'] }) -export class DocumentTypeListComponent extends GenericListComponent implements OnInit { +export class DocumentTypeListComponent extends GenericListComponent { - constructor(service: DocumentTypeService, modalService: NgbModal, private titleService: Title) { + constructor(service: DocumentTypeService, modalService: NgbModal, + private router: Router, + private list: DocumentListViewService + ) { super(service, modalService, DocumentTypeEditDialogComponent) } @@ -22,8 +26,10 @@ export class DocumentTypeListComponent extends GenericListComponent implements OnInit { - + constructor( - private service: AbstractPaperlessService, + private service: AbstractPaperlessService, private modalService: NgbModal, private editDialogComponent: any) { } @@ -60,7 +60,8 @@ export abstract class GenericListComponent implements On } reloadData() { - this.service.list(this.page, null, this.sortField, this.sortDirection).subscribe(c => { + // TODO: this is a hack + this.service.list(this.page, null, this.sortField, this.sortDirection == 'des').subscribe(c => { this.data = c.results this.collectionSize = c.count }); @@ -88,10 +89,13 @@ export abstract class GenericListComponent implements On } openDeleteDialog(object: T) { - var activeModal = this.modalService.open(DeleteDialogComponent, {backdrop: 'static'}) - activeModal.componentInstance.message = `Do you really want to delete ${this.getObjectName(object)}?` - activeModal.componentInstance.message2 = "Associated documents will not be deleted." - activeModal.componentInstance.deleteClicked.subscribe(() => { + var activeModal = this.modalService.open(ConfirmDialogComponent, {backdrop: 'static'}) + activeModal.componentInstance.title = "Confirm delete" + activeModal.componentInstance.messageBold = `Do you really want to delete ${this.getObjectName(object)}?` + activeModal.componentInstance.message = "Associated documents will not be deleted." + activeModal.componentInstance.btnClass = "btn-danger" + activeModal.componentInstance.btnCaption = "Delete" + activeModal.componentInstance.confirmPressed.subscribe(() => { this.service.delete(object).subscribe(_ => { activeModal.close() this.reloadData() diff --git a/src-ui/src/app/components/manage/logs/logs.component.ts b/src-ui/src/app/components/manage/logs/logs.component.ts index 44d0fa24d..b131796ee 100644 --- a/src-ui/src/app/components/manage/logs/logs.component.ts +++ b/src-ui/src/app/components/manage/logs/logs.component.ts @@ -1,8 +1,6 @@ import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; import { LOG_LEVELS, LOG_LEVEL_INFO, PaperlessLog } from 'src/app/data/paperless-log'; import { LogService } from 'src/app/services/rest/log.service'; -import { environment } from 'src/environments/environment'; @Component({ selector: 'app-logs', @@ -11,18 +9,17 @@ import { environment } from 'src/environments/environment'; }) export class LogsComponent implements OnInit { - constructor(private logService: LogService, private titleService: Title) { } + constructor(private logService: LogService) { } logs: PaperlessLog[] = [] level: number = LOG_LEVEL_INFO ngOnInit(): void { this.reload() - this.titleService.setTitle(`Logs - ${environment.appTitle}`) } reload() { - this.logService.list(1, 50, 'created', 'des', {'level__gte': this.level}).subscribe(result => this.logs = result.results) + this.logService.list(1, 50, 'created', true, {'level__gte': this.level}).subscribe(result => this.logs = result.results) } getLevelText(level: number) { @@ -34,7 +31,7 @@ export class LogsComponent implements OnInit { if (this.logs.length > 0) { lastCreated = new Date(this.logs[this.logs.length-1].created).toISOString() } - this.logService.list(1, 25, 'created', 'des', {'created__lt': lastCreated, 'level__gte': this.level}).subscribe(result => { + this.logService.list(1, 25, 'created', true, {'created__lt': lastCreated, 'level__gte': this.level}).subscribe(result => { this.logs.push(...result.results) }) } diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 7a500e6eb..f71f12238 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -34,24 +34,35 @@ Saved views - - - - - - - - - - - - - - - - - -
TitleShow in dashboardShow in sidebarActions
{{ config.title }}{{ config.showInDashboard | yesno }}{{ config.showInSideBar | yesno }}
+
+ +
+
+ + +
+ +
+ +
+ + +
+
+ + +
+
+ +
+ + +
+
+ +
No saved views defined.
+ +
diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index c7b976c65..f839010b1 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -1,11 +1,10 @@ import { Component, OnInit } from '@angular/core'; import { FormControl, FormGroup } from '@angular/forms'; -import { Title } from '@angular/platform-browser'; -import { SavedViewConfig } from 'src/app/data/saved-view-config'; +import { PaperlessSavedView } from 'src/app/data/paperless-saved-view'; import { GENERAL_SETTINGS } from 'src/app/data/storage-keys'; import { DocumentListViewService } from 'src/app/services/document-list-view.service'; -import { SavedViewConfigService } from 'src/app/services/saved-view-config.service'; -import { environment } from 'src/environments/environment'; +import { SavedViewService } from 'src/app/services/rest/saved-view.service'; +import { Toast, ToastService } from 'src/app/services/toast.service'; @Component({ selector: 'app-settings', @@ -14,26 +13,63 @@ import { environment } from 'src/environments/environment'; }) export class SettingsComponent implements OnInit { + savedViewGroup = new FormGroup({}) + settingsForm = new FormGroup({ - 'documentListItemPerPage': new FormControl(+localStorage.getItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE) || GENERAL_SETTINGS.DOCUMENT_LIST_SIZE_DEFAULT) + 'documentListItemPerPage': new FormControl(+localStorage.getItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE) || GENERAL_SETTINGS.DOCUMENT_LIST_SIZE_DEFAULT), + 'savedViews': this.savedViewGroup }) constructor( - private savedViewConfigService: SavedViewConfigService, + public savedViewService: SavedViewService, private documentListViewService: DocumentListViewService, - private titleService: Title + private toastService: ToastService ) { } - ngOnInit(): void { - this.titleService.setTitle(`Settings - ${environment.appTitle}`) + savedViews: PaperlessSavedView[] + + ngOnInit() { + this.savedViewService.listAll().subscribe(r => { + this.savedViews = r.results + for (let view of this.savedViews) { + this.savedViewGroup.addControl(view.id.toString(), new FormGroup({ + "id": new FormControl(view.id), + "name": new FormControl(view.name), + "show_on_dashboard": new FormControl(view.show_on_dashboard), + "show_in_sidebar": new FormControl(view.show_in_sidebar) + })) + } + }) } - deleteViewConfig(config: SavedViewConfig) { - this.savedViewConfigService.deleteConfig(config) + deleteSavedView(savedView: PaperlessSavedView) { + this.savedViewService.delete(savedView).subscribe(() => { + this.savedViewGroup.removeControl(savedView.id.toString()) + this.savedViews.splice(this.savedViews.indexOf(savedView), 1) + this.toastService.showToast(Toast.make("Information", `Saved view "${savedView.name} deleted.`)) + }) + } + + private saveLocalSettings() { + localStorage.setItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE, this.settingsForm.value.documentListItemPerPage) + this.documentListViewService.updatePageSize() + this.toastService.showToast(Toast.make("Information", "Settings saved successfully.")) } saveSettings() { - localStorage.setItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE, this.settingsForm.value.documentListItemPerPage) - this.documentListViewService.updatePageSize() + let x = [] + for (let id in this.savedViewGroup.value) { + x.push(this.savedViewGroup.value[id]) + } + if (x.length > 0) { + this.savedViewService.patchMany(x).subscribe(s => { + this.saveLocalSettings() + }, error => { + this.toastService.showToast(Toast.makeError(`Error while storing settings on server: ${JSON.stringify(error.error)}`)) + }) + } else { + this.saveLocalSettings() + } + } } diff --git a/src-ui/src/app/components/manage/tag-list/tag-list.component.html b/src-ui/src/app/components/manage/tag-list/tag-list.component.html index e68b997d1..bbe2c6dd2 100644 --- a/src-ui/src/app/components/manage/tag-list/tag-list.component.html +++ b/src-ui/src/app/components/manage/tag-list/tag-list.component.html @@ -9,7 +9,7 @@ aria-label="Default pagination">
- +
@@ -28,8 +28,25 @@ diff --git a/src-ui/src/app/components/manage/tag-list/tag-list.component.ts b/src-ui/src/app/components/manage/tag-list/tag-list.component.ts index efbe11321..e3f151550 100644 --- a/src-ui/src/app/components/manage/tag-list/tag-list.component.ts +++ b/src-ui/src/app/components/manage/tag-list/tag-list.component.ts @@ -1,9 +1,10 @@ -import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; +import { Component } from '@angular/core'; +import { Router } from '@angular/router'; import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { FILTER_HAS_TAG } from 'src/app/data/filter-rule-type'; import { TAG_COLOURS, PaperlessTag } from 'src/app/data/paperless-tag'; +import { DocumentListViewService } from 'src/app/services/document-list-view.service'; import { TagService } from 'src/app/services/rest/tag.service'; -import { environment } from 'src/environments/environment'; import { GenericListComponent } from '../generic-list/generic-list.component'; import { TagEditDialogComponent } from './tag-edit-dialog/tag-edit-dialog.component'; @@ -12,18 +13,15 @@ import { TagEditDialogComponent } from './tag-edit-dialog/tag-edit-dialog.compon templateUrl: './tag-list.component.html', styleUrls: ['./tag-list.component.scss'] }) -export class TagListComponent extends GenericListComponent implements OnInit { +export class TagListComponent extends GenericListComponent { - constructor(tagService: TagService, modalService: NgbModal, private titleService: Title) { + constructor(tagService: TagService, modalService: NgbModal, + private router: Router, + private list: DocumentListViewService + ) { super(tagService, modalService, TagEditDialogComponent) } - - ngOnInit(): void { - super.ngOnInit() - this.titleService.setTitle(`Tags - ${environment.appTitle}`) - } - getColor(id) { return TAG_COLOURS.find(c => c.id == id) } @@ -31,4 +29,11 @@ export class TagListComponent extends GenericListComponent impleme getObjectName(object: PaperlessTag) { return `tag '${object.name}'` } + + filterDocuments(object: PaperlessTag) { + this.list.documentListView.filter_rules = [ + {rule_type: FILTER_HAS_TAG, value: object.id.toString()} + ] + this.router.navigate(["documents"]) + } } diff --git a/src-ui/src/app/components/search/search.component.ts b/src-ui/src/app/components/search/search.component.ts index 3371debd2..de8b4652f 100644 --- a/src-ui/src/app/components/search/search.component.ts +++ b/src-ui/src/app/components/search/search.component.ts @@ -1,9 +1,7 @@ import { Component, OnInit } from '@angular/core'; -import { Title } from '@angular/platform-browser'; import { ActivatedRoute, Router } from '@angular/router'; import { SearchHit } from 'src/app/data/search-result'; import { SearchService } from 'src/app/services/rest/search.service'; -import { environment } from 'src/environments/environment'; @Component({ selector: 'app-search', @@ -28,7 +26,7 @@ export class SearchComponent implements OnInit { errorMessage: string - constructor(private searchService: SearchService, private route: ActivatedRoute, private router: Router, private titleService: Title) { } + constructor(private searchService: SearchService, private route: ActivatedRoute, private router: Router) { } ngOnInit(): void { this.route.queryParamMap.subscribe(paramMap => { @@ -36,7 +34,6 @@ export class SearchComponent implements OnInit { this.searching = true this.currentPage = 1 this.loadPage() - this.titleService.setTitle(`Search: ${this.query} - ${environment.appTitle}`) }) } diff --git a/src-ui/src/app/data/filter-rule-type.ts b/src-ui/src/app/data/filter-rule-type.ts index a35759f69..ea8e60eee 100644 --- a/src-ui/src/app/data/filter-rule-type.ts +++ b/src-ui/src/app/data/filter-rule-type.ts @@ -22,15 +22,15 @@ export const FILTER_RULE_TYPES: FilterRuleType[] = [ {id: FILTER_TITLE, name: "Title contains", filtervar: "title__icontains", datatype: "string", multi: false, default: ""}, {id: FILTER_CONTENT, name: "Content contains", filtervar: "content__icontains", datatype: "string", multi: false, default: ""}, - + {id: FILTER_ASN, name: "ASN is", filtervar: "archive_serial_number", datatype: "number", multi: false}, - + {id: FILTER_CORRESPONDENT, name: "Correspondent is", filtervar: "correspondent__id", datatype: "correspondent", multi: false}, {id: FILTER_DOCUMENT_TYPE, name: "Document type is", filtervar: "document_type__id", datatype: "document_type", multi: false}, - {id: FILTER_IS_IN_INBOX, name: "Is in Inbox", filtervar: "is_in_inbox", datatype: "boolean", multi: false, default: true}, - {id: FILTER_HAS_TAG, name: "Has tag", filtervar: "tags__id__all", datatype: "tag", multi: true}, - {id: FILTER_DOES_NOT_HAVE_TAG, name: "Does not have tag", filtervar: "tags__id__none", datatype: "tag", multi: true}, + {id: FILTER_IS_IN_INBOX, name: "Is in Inbox", filtervar: "is_in_inbox", datatype: "boolean", multi: false, default: true}, + {id: FILTER_HAS_TAG, name: "Has tag", filtervar: "tags__id__all", datatype: "tag", multi: true}, + {id: FILTER_DOES_NOT_HAVE_TAG, name: "Does not have tag", filtervar: "tags__id__none", datatype: "tag", multi: true}, {id: FILTER_HAS_ANY_TAG, name: "Has any tag", filtervar: "is_tagged", datatype: "boolean", multi: false, default: true}, {id: FILTER_CREATED_BEFORE, name: "Created before", filtervar: "created__date__lt", datatype: "date", multi: false}, @@ -42,7 +42,7 @@ export const FILTER_RULE_TYPES: FilterRuleType[] = [ {id: FILTER_ADDED_BEFORE, name: "Added before", filtervar: "added__date__lt", datatype: "date", multi: false}, {id: FILTER_ADDED_AFTER, name: "Added after", filtervar: "added__date__gt", datatype: "date", multi: false}, - + {id: FILTER_MODIFIED_BEFORE, name: "Modified before", filtervar: "modified__date__lt", datatype: "date", multi: false}, {id: FILTER_MODIFIED_AFTER, name: "Modified after", filtervar: "modified__date__gt", datatype: "date", multi: false}, ] @@ -54,4 +54,4 @@ export interface FilterRuleType { datatype: string //number, string, boolean, date multi: boolean default?: any -} \ No newline at end of file +} diff --git a/src-ui/src/app/data/filter-rule.ts b/src-ui/src/app/data/filter-rule.ts index 2dc632d9c..82d8498f3 100644 --- a/src-ui/src/app/data/filter-rule.ts +++ b/src-ui/src/app/data/filter-rule.ts @@ -1,10 +1,8 @@ -import { FilterRuleType } from './filter-rule-type'; - export function cloneFilterRules(filterRules: FilterRule[]): FilterRule[] { if (filterRules) { let newRules: FilterRule[] = [] for (let rule of filterRules) { - newRules.push({type: rule.type, value: rule.value}) + newRules.push({rule_type: rule.rule_type, value: rule.value}) } return newRules } else { @@ -13,6 +11,6 @@ export function cloneFilterRules(filterRules: FilterRule[]): FilterRule[] { } export interface FilterRule { - type: FilterRuleType - value: any + rule_type: number + value: string } \ No newline at end of file diff --git a/src-ui/src/app/data/paperless-saved-view.ts b/src-ui/src/app/data/paperless-saved-view.ts new file mode 100644 index 000000000..fbc2f5d5e --- /dev/null +++ b/src-ui/src/app/data/paperless-saved-view.ts @@ -0,0 +1,18 @@ +import { FilterRule } from './filter-rule'; +import { ObjectWithId } from './object-with-id'; + +export interface PaperlessSavedView extends ObjectWithId { + + name?: string + + show_on_dashboard?: boolean + + show_in_sidebar?: boolean + + sort_field: string + + sort_reverse: boolean + + filter_rules: FilterRule[] + +} \ No newline at end of file diff --git a/src-ui/src/app/data/saved-view-config.ts b/src-ui/src/app/data/saved-view-config.ts deleted file mode 100644 index 9d7076215..000000000 --- a/src-ui/src/app/data/saved-view-config.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { FilterRule } from './filter-rule'; - -export interface SavedViewConfig { - - id?: string - - filterRules: FilterRule[] - - sortField: string - - sortDirection: string - - title?: string - - showInSideBar?: boolean - - showInDashboard?: boolean - -} \ No newline at end of file diff --git a/src-ui/src/app/pipes/document-title.pipe.spec.ts b/src-ui/src/app/pipes/document-title.pipe.spec.ts new file mode 100644 index 000000000..29835abd6 --- /dev/null +++ b/src-ui/src/app/pipes/document-title.pipe.spec.ts @@ -0,0 +1,8 @@ +import { DocumentTitlePipe } from './document-title.pipe'; + +describe('DocumentTitlePipe', () => { + it('create an instance', () => { + const pipe = new DocumentTitlePipe(); + expect(pipe).toBeTruthy(); + }); +}); diff --git a/src-ui/src/app/pipes/document-title.pipe.ts b/src-ui/src/app/pipes/document-title.pipe.ts new file mode 100644 index 000000000..621562d39 --- /dev/null +++ b/src-ui/src/app/pipes/document-title.pipe.ts @@ -0,0 +1,16 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ + name: 'documentTitle' +}) +export class DocumentTitlePipe implements PipeTransform { + + transform(value: string): string { + if (value) { + return value + } else { + return "(no title)" + } + } + +} diff --git a/src-ui/src/app/pipes/filter.pipe.ts b/src-ui/src/app/pipes/filter.pipe.ts new file mode 100644 index 000000000..f799f40cc --- /dev/null +++ b/src-ui/src/app/pipes/filter.pipe.ts @@ -0,0 +1,17 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ + name: 'filter' +}) +export class FilterPipe implements PipeTransform { + transform(items: any[], searchText: string): any[] { + if (!items) return []; + if (!searchText) return items; + + return items.filter(item => { + return Object.keys(item).some(key => { + return String(item[key]).toLowerCase().includes(searchText.toLowerCase()); + }); + }); + } +} diff --git a/src-ui/src/app/pipes/safe.pipe.spec.ts b/src-ui/src/app/pipes/safe.pipe.spec.ts deleted file mode 100644 index 49ee0ad14..000000000 --- a/src-ui/src/app/pipes/safe.pipe.spec.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { SafePipe } from './safe.pipe'; - -describe('SafePipe', () => { - it('create an instance', () => { - const pipe = new SafePipe(); - expect(pipe).toBeTruthy(); - }); -}); diff --git a/src-ui/src/app/pipes/safe.pipe.ts b/src-ui/src/app/pipes/safe.pipe.ts deleted file mode 100644 index f2d77a72d..000000000 --- a/src-ui/src/app/pipes/safe.pipe.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { Pipe, PipeTransform } from '@angular/core'; -import { DomSanitizer } from '@angular/platform-browser'; - -@Pipe({ - name: 'safe' -}) -export class SafePipe implements PipeTransform { - - constructor(private sanitizer: DomSanitizer) { } - - transform(url) { - if (url == null) { - return this.sanitizer.bypassSecurityTrustResourceUrl("") - } else { - return this.sanitizer.bypassSecurityTrustResourceUrl(url); - } - } - -} \ No newline at end of file diff --git a/src-ui/src/app/services/document-list-view.service.ts b/src-ui/src/app/services/document-list-view.service.ts index 811ac3c4b..57d0a3f0e 100644 --- a/src-ui/src/app/services/document-list-view.service.ts +++ b/src-ui/src/app/services/document-list-view.service.ts @@ -2,14 +2,14 @@ import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; import { cloneFilterRules, FilterRule } from '../data/filter-rule'; import { PaperlessDocument } from '../data/paperless-document'; -import { SavedViewConfig } from '../data/saved-view-config'; +import { PaperlessSavedView } from '../data/paperless-saved-view'; import { DOCUMENT_LIST_SERVICE, GENERAL_SETTINGS } from '../data/storage-keys'; import { DocumentService } from './rest/document.service'; /** * This service manages the document list which is displayed using the document list view. - * + * * This service also serves saved views by transparently switching between the document list * and saved views on request. See below. */ @@ -25,21 +25,21 @@ export class DocumentListViewService { currentPage = 1 currentPageSize: number = +localStorage.getItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE) || GENERAL_SETTINGS.DOCUMENT_LIST_SIZE_DEFAULT collectionSize: number - + /** * This is the current config for the document list. The service will always remember the last settings used for the document list. */ - private _documentListViewConfig: SavedViewConfig + private _documentListViewConfig: PaperlessSavedView /** * Optionally, this is the currently selected saved view, which might be null. */ - private _savedViewConfig: SavedViewConfig + private _savedViewConfig: PaperlessSavedView - get savedView() { + get savedView(): PaperlessSavedView { return this._savedViewConfig } - set savedView(value) { + set savedView(value: PaperlessSavedView) { if (value) { //this is here so that we don't modify value, which might be the actual instance of the saved view. this._savedViewConfig = Object.assign({}, value) @@ -53,7 +53,7 @@ export class DocumentListViewService { } get savedViewTitle() { - return this.savedView?.title + return this.savedView?.name } get documentListView() { @@ -75,11 +75,11 @@ export class DocumentListViewService { return this.savedView || this.documentListView } - load(config: SavedViewConfig) { - this.view.filterRules = cloneFilterRules(config.filterRules) - this.view.sortDirection = config.sortDirection - this.view.sortField = config.sortField - this.reload() + load(view: PaperlessSavedView) { + this.documentListView.filter_rules = cloneFilterRules(view.filter_rules) + this.documentListView.sort_reverse = view.sort_reverse + this.documentListView.sort_field = view.sort_field + this.saveDocumentListView() } clear() { @@ -93,9 +93,9 @@ export class DocumentListViewService { this.documentService.list( this.currentPage, this.currentPageSize, - this.view.sortField, - this.view.sortDirection, - this.view.filterRules).subscribe( + this.view.sort_field, + this.view.sort_reverse, + this.view.filter_rules).subscribe( result => { this.collectionSize = result.count this.documents = result.results @@ -116,33 +116,33 @@ export class DocumentListViewService { set filterRules(filterRules: FilterRule[]) { //we're going to clone the filterRules object, since we don't //want changes in the filter editor to propagate into here right away. - this.view.filterRules = cloneFilterRules(filterRules) + this.view.filter_rules = filterRules this.reload() this.saveDocumentListView() } get filterRules(): FilterRule[] { - return cloneFilterRules(this.view.filterRules) + return this.view.filter_rules } set sortField(field: string) { - this.view.sortField = field + this.view.sort_field = field this.saveDocumentListView() this.reload() } get sortField(): string { - return this.view.sortField + return this.view.sort_field } - set sortDirection(direction: string) { - this.view.sortDirection = direction + set sortReverse(reverse: boolean) { + this.view.sort_reverse = reverse this.saveDocumentListView() this.reload() } - get sortDirection(): string { - return this.view.sortDirection + get sortReverse(): boolean { + return this.view.sort_reverse } private saveDocumentListView() { @@ -188,11 +188,10 @@ export class DocumentListViewService { let newPageSize = +localStorage.getItem(GENERAL_SETTINGS.DOCUMENT_LIST_SIZE) || GENERAL_SETTINGS.DOCUMENT_LIST_SIZE_DEFAULT if (newPageSize != this.currentPageSize) { this.currentPageSize = newPageSize - //this.reload() } } - constructor(private documentService: DocumentService) { + constructor(private documentService: DocumentService) { let documentListViewConfigJson = sessionStorage.getItem(DOCUMENT_LIST_SERVICE.CURRENT_VIEW_CONFIG) if (documentListViewConfigJson) { try { @@ -202,11 +201,11 @@ export class DocumentListViewService { this.documentListView = null } } - if (!this.documentListView) { + if (!this.documentListView || !this.documentListView.filter_rules || !this.documentListView.sort_reverse || !this.documentListView.sort_field) { this.documentListView = { - filterRules: [], - sortDirection: 'des', - sortField: 'created' + filter_rules: [], + sort_reverse: true, + sort_field: 'created' } } } diff --git a/src-ui/src/app/services/rest/abstract-paperless-service.ts b/src-ui/src/app/services/rest/abstract-paperless-service.ts index 3feed320e..93e1a0c85 100644 --- a/src-ui/src/app/services/rest/abstract-paperless-service.ts +++ b/src-ui/src/app/services/rest/abstract-paperless-service.ts @@ -1,5 +1,5 @@ import { HttpClient, HttpParams } from '@angular/common/http' -import { Observable, of, Subject } from 'rxjs' +import { Observable } from 'rxjs' import { map, publishReplay, refCount } from 'rxjs/operators' import { ObjectWithId } from 'src/app/data/object-with-id' import { Results } from 'src/app/data/results' @@ -22,17 +22,15 @@ export abstract class AbstractPaperlessService { return url } - private getOrderingQueryParam(sortField: string, sortDirection: string) { - if (sortField && sortDirection) { - return (sortDirection == 'des' ? '-' : '') + sortField - } else if (sortField) { - return sortField + private getOrderingQueryParam(sortField: string, sortReverse: boolean) { + if (sortField) { + return (sortReverse ? '-' : '') + sortField } else { return null } } - list(page?: number, pageSize?: number, sortField?: string, sortDirection?: string, extraParams?): Observable> { + list(page?: number, pageSize?: number, sortField?: string, sortReverse?: boolean, extraParams?): Observable> { let httpParams = new HttpParams() if (page) { httpParams = httpParams.set('page', page.toString()) @@ -40,7 +38,7 @@ export abstract class AbstractPaperlessService { if (pageSize) { httpParams = httpParams.set('page_size', pageSize.toString()) } - let ordering = this.getOrderingQueryParam(sortField, sortDirection) + let ordering = this.getOrderingQueryParam(sortField, sortReverse) if (ordering) { httpParams = httpParams.set('ordering', ordering) } @@ -94,4 +92,10 @@ export abstract class AbstractPaperlessService { this._listAll = null return this.http.put(this.getResourceUrl(o.id), o) } -} \ No newline at end of file + + patch(o: T): Observable { + this._listAll = null + return this.http.patch(this.getResourceUrl(o.id), o) + } + +} diff --git a/src-ui/src/app/services/rest/document.service.ts b/src-ui/src/app/services/rest/document.service.ts index 81693ec68..f50620d23 100644 --- a/src-ui/src/app/services/rest/document.service.ts +++ b/src-ui/src/app/services/rest/document.service.ts @@ -10,7 +10,7 @@ import { map } from 'rxjs/operators'; import { CorrespondentService } from './correspondent.service'; import { DocumentTypeService } from './document-type.service'; import { TagService } from './tag.service'; - +import { FILTER_RULE_TYPES } from 'src/app/data/filter-rule-type'; export const DOCUMENT_SORT_FIELDS = [ { field: "correspondent__name", name: "Correspondent" }, @@ -22,10 +22,6 @@ export const DOCUMENT_SORT_FIELDS = [ { field: 'modified', name: 'Modified' } ] -export const SORT_DIRECTION_ASCENDING = "asc" -export const SORT_DIRECTION_DESCENDING = "des" - - @Injectable({ providedIn: 'root' }) @@ -39,10 +35,11 @@ export class DocumentService extends AbstractPaperlessService if (filterRules) { let params = {} for (let rule of filterRules) { - if (rule.type.multi) { - params[rule.type.filtervar] = params[rule.type.filtervar] ? params[rule.type.filtervar] + "," + rule.value : rule.value + let ruleType = FILTER_RULE_TYPES.find(t => t.id == rule.rule_type) + if (ruleType.multi) { + params[ruleType.filtervar] = params[ruleType.filtervar] ? params[ruleType.filtervar] + "," + rule.value : rule.value } else { - params[rule.type.filtervar] = rule.value + params[ruleType.filtervar] = rule.value } } return params @@ -64,8 +61,8 @@ export class DocumentService extends AbstractPaperlessService return doc } - list(page?: number, pageSize?: number, sortField?: string, sortDirection?: string, filterRules?: FilterRule[]): Observable> { - return super.list(page, pageSize, sortField, sortDirection, this.filterRulesToQueryParams(filterRules)).pipe( + list(page?: number, pageSize?: number, sortField?: string, sortReverse?: boolean, filterRules?: FilterRule[]): Observable> { + return super.list(page, pageSize, sortField, sortReverse, this.filterRulesToQueryParams(filterRules)).pipe( map(results => { results.results.forEach(doc => this.addObservablesToDocument(doc)) return results diff --git a/src-ui/src/app/services/rest/saved-view.service.spec.ts b/src-ui/src/app/services/rest/saved-view.service.spec.ts new file mode 100644 index 000000000..588cf6347 --- /dev/null +++ b/src-ui/src/app/services/rest/saved-view.service.spec.ts @@ -0,0 +1,16 @@ +import { TestBed } from '@angular/core/testing'; + +import { SavedViewService } from './saved-view.service'; + +describe('SavedViewService', () => { + let service: SavedViewService; + + beforeEach(() => { + TestBed.configureTestingModule({}); + service = TestBed.inject(SavedViewService); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); +}); diff --git a/src-ui/src/app/services/rest/saved-view.service.ts b/src-ui/src/app/services/rest/saved-view.service.ts new file mode 100644 index 000000000..9a81e01e5 --- /dev/null +++ b/src-ui/src/app/services/rest/saved-view.service.ts @@ -0,0 +1,59 @@ +import { HttpClient } from '@angular/common/http'; +import { Injectable } from '@angular/core'; +import { combineLatest, Observable } from 'rxjs'; +import { tap } from 'rxjs/operators'; +import { PaperlessSavedView } from 'src/app/data/paperless-saved-view'; +import { AbstractPaperlessService } from './abstract-paperless-service'; + +@Injectable({ + providedIn: 'root' +}) +export class SavedViewService extends AbstractPaperlessService { + + constructor(http: HttpClient) { + super(http, 'saved_views') + this.reload() + } + + private reload() { + this.listAll().subscribe(r => this.savedViews = r.results) + } + + private savedViews: PaperlessSavedView[] = [] + + get allViews() { + return this.savedViews + } + + get sidebarViews() { + return this.savedViews.filter(v => v.show_in_sidebar) + } + + get dashboardViews() { + return this.savedViews.filter(v => v.show_on_dashboard) + } + + create(o: PaperlessSavedView) { + return super.create(o).pipe( + tap(() => this.reload()) + ) + } + + update(o: PaperlessSavedView) { + return super.update(o).pipe( + tap(() => this.reload()) + ) + } + + patchMany(objects: PaperlessSavedView[]): Observable { + return combineLatest(objects.map(o => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + + delete(o: PaperlessSavedView) { + return super.delete(o).pipe( + tap(() => this.reload()) + ) + } +} diff --git a/src-ui/src/app/services/saved-view-config.service.spec.ts b/src-ui/src/app/services/saved-view-config.service.spec.ts deleted file mode 100644 index c67affead..000000000 --- a/src-ui/src/app/services/saved-view-config.service.spec.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { TestBed } from '@angular/core/testing'; - -import { SavedViewConfigService } from './saved-view-config.service'; - -describe('SavedViewConfigService', () => { - let service: SavedViewConfigService; - - beforeEach(() => { - TestBed.configureTestingModule({}); - service = TestBed.inject(SavedViewConfigService); - }); - - it('should be created', () => { - expect(service).toBeTruthy(); - }); -}); diff --git a/src-ui/src/app/services/saved-view-config.service.ts b/src-ui/src/app/services/saved-view-config.service.ts deleted file mode 100644 index 41c28216b..000000000 --- a/src-ui/src/app/services/saved-view-config.service.ts +++ /dev/null @@ -1,66 +0,0 @@ -import { Injectable } from '@angular/core'; -import { v4 as uuidv4 } from 'uuid'; -import { SavedViewConfig } from '../data/saved-view-config'; - -@Injectable({ - providedIn: 'root' -}) -export class SavedViewConfigService { - - constructor() { - let savedConfigs = localStorage.getItem('saved-view-config-service:savedConfigs') - if (savedConfigs) { - try { - this.configs = JSON.parse(savedConfigs) - } catch (e) { - this.configs = [] - } - } - } - - private configs: SavedViewConfig[] = [] - - getConfigs(): SavedViewConfig[] { - return this.configs - } - - getDashboardConfigs(): SavedViewConfig[] { - return this.configs.filter(sf => sf.showInDashboard) - } - - getSideBarConfigs(): SavedViewConfig[] { - return this.configs.filter(sf => sf.showInSideBar) - } - - getConfig(id: string): SavedViewConfig { - return this.configs.find(sf => sf.id == id) - } - - newConfig(config: SavedViewConfig) { - config.id = uuidv4() - this.configs.push(config) - - this.save() - } - - updateConfig(config: SavedViewConfig) { - let savedConfig = this.configs.find(c => c.id == config.id) - if (savedConfig) { - Object.assign(savedConfig, config) - this.save() - } - } - - private save() { - localStorage.setItem('saved-view-config-service:savedConfigs', JSON.stringify(this.configs)) - } - - deleteConfig(config: SavedViewConfig) { - let index = this.configs.findIndex(vc => vc.id == config.id) - if (index != -1) { - this.configs.splice(index, 1) - this.save() - } - - } -} diff --git a/src-ui/src/assets/save-filter.png b/src-ui/src/assets/save-filter.png index dcaa41714..0f011f812 100644 Binary files a/src-ui/src/assets/save-filter.png and b/src-ui/src/assets/save-filter.png differ diff --git a/src-ui/src/environments/environment.prod.ts b/src-ui/src/environments/environment.prod.ts index 09154dfca..38699670e 100644 --- a/src-ui/src/environments/environment.prod.ts +++ b/src-ui/src/environments/environment.prod.ts @@ -1,5 +1,6 @@ export const environment = { production: true, apiBaseUrl: "/api/", - appTitle: "Paperless-ng" + appTitle: "Paperless-ng", + version: "0.9.7" }; diff --git a/src-ui/src/environments/environment.ts b/src-ui/src/environments/environment.ts index 5e4b148dc..29a8f3af6 100644 --- a/src-ui/src/environments/environment.ts +++ b/src-ui/src/environments/environment.ts @@ -5,7 +5,8 @@ export const environment = { production: false, apiBaseUrl: "http://localhost:8000/api/", - appTitle: "DEVELOPMENT P-NG" + appTitle: "Paperless-ng", + version: "DEVELOPMENT" }; /* diff --git a/src/documents/admin.py b/src/documents/admin.py index 055a6fd93..6ec3b736e 100755 --- a/src/documents/admin.py +++ b/src/documents/admin.py @@ -4,7 +4,8 @@ from django.utils.safestring import mark_safe from whoosh.writing import AsyncWriter from . import index -from .models import Correspondent, Document, DocumentType, Log, Tag +from .models import Correspondent, Document, DocumentType, Log, Tag, \ + SavedView, SavedViewFilterRule class CorrespondentAdmin(admin.ModelAdmin): @@ -131,8 +132,22 @@ class LogAdmin(admin.ModelAdmin): list_display_links = ("created", "message") +class RuleInline(admin.TabularInline): + model = SavedViewFilterRule + + +class SavedViewAdmin(admin.ModelAdmin): + + list_display = ("name", "user") + + inlines = [ + RuleInline + ] + + admin.site.register(Correspondent, CorrespondentAdmin) admin.site.register(Tag, TagAdmin) admin.site.register(DocumentType, DocumentTypeAdmin) admin.site.register(Document, DocumentAdmin) admin.site.register(Log, LogAdmin) +admin.site.register(SavedView, SavedViewAdmin) diff --git a/src/documents/checks.py b/src/documents/checks.py index 3e3ddb1fb..b6da5bfc9 100644 --- a/src/documents/checks.py +++ b/src/documents/checks.py @@ -2,6 +2,7 @@ import textwrap from django.conf import settings from django.core.checks import Error, register +from django.core.exceptions import FieldError from django.db.utils import OperationalError, ProgrammingError from documents.signals import document_consumer_declaration @@ -16,7 +17,7 @@ def changed_password_check(app_configs, **kwargs): try: encrypted_doc = Document.objects.filter( storage_type=Document.STORAGE_TYPE_GPG).first() - except (OperationalError, ProgrammingError): + except (OperationalError, ProgrammingError, FieldError): return [] # No documents table yet if encrypted_doc: diff --git a/src/documents/file_handling.py b/src/documents/file_handling.py index c5efc33e4..5643756ac 100644 --- a/src/documents/file_handling.py +++ b/src/documents/file_handling.py @@ -8,6 +8,12 @@ from django.conf import settings from django.template.defaultfilters import slugify +class defaultdictNoStr(defaultdict): + + def __str__(self): + raise ValueError("Don't use {tags} directly.") + + def create_source_path_directory(source_path): os.makedirs(os.path.dirname(source_path), exist_ok=True) @@ -90,8 +96,13 @@ def generate_filename(doc, counter=0): try: if settings.PAPERLESS_FILENAME_FORMAT is not None: - tags = defaultdict(lambda: slugify(None), - many_to_dictionary(doc.tags)) + tags = defaultdictNoStr(lambda: slugify(None), + many_to_dictionary(doc.tags)) + + tag_list = pathvalidate.sanitize_filename( + ",".join([tag.name for tag in doc.tags.all()]), + replacement_text="-" + ) if doc.correspondent: correspondent = pathvalidate.sanitize_filename( @@ -114,14 +125,18 @@ def generate_filename(doc, counter=0): document_type=document_type, created=datetime.date.isoformat(doc.created), created_year=doc.created.year if doc.created else "none", - created_month=doc.created.month if doc.created else "none", - created_day=doc.created.day if doc.created else "none", + created_month=f"{doc.created.month:02}" if doc.created else "none", # NOQA: E501 + created_day=f"{doc.created.day:02}" if doc.created else "none", added=datetime.date.isoformat(doc.added), added_year=doc.added.year if doc.added else "none", - added_month=doc.added.month if doc.added else "none", - added_day=doc.added.day if doc.added else "none", + added_month=f"{doc.added.month:02}" if doc.added else "none", + added_day=f"{doc.added.day:02}" if doc.added else "none", tags=tags, - ) + tag_list=tag_list + ).strip() + + path = path.strip(os.sep) + except (ValueError, KeyError, IndexError): logging.getLogger(__name__).warning( f"Invalid PAPERLESS_FILENAME_FORMAT: " diff --git a/src/documents/management/commands/document_renamer.py b/src/documents/management/commands/document_renamer.py index 5d7d0d90c..745d2d03d 100644 --- a/src/documents/management/commands/document_renamer.py +++ b/src/documents/management/commands/document_renamer.py @@ -2,6 +2,7 @@ import logging import tqdm from django.core.management.base import BaseCommand +from django.db.models.signals import post_save from documents.models import Document from ...mixins import Renderable @@ -24,5 +25,4 @@ class Command(Renderable, BaseCommand): logging.getLogger().handlers[0].level = logging.ERROR for document in tqdm.tqdm(Document.objects.all()): - # Saving the document again will generate a new filename and rename - document.save() + post_save.send(Document, instance=document) diff --git a/src/documents/migrations/1007_savedview_savedviewfilterrule.py b/src/documents/migrations/1007_savedview_savedviewfilterrule.py new file mode 100644 index 000000000..664def5f1 --- /dev/null +++ b/src/documents/migrations/1007_savedview_savedviewfilterrule.py @@ -0,0 +1,37 @@ +# Generated by Django 3.1.4 on 2020-12-12 14:41 + +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('documents', '1006_auto_20201208_2209'), + ] + + operations = [ + migrations.CreateModel( + name='SavedView', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=128)), + ('show_on_dashboard', models.BooleanField()), + ('show_in_sidebar', models.BooleanField()), + ('sort_field', models.CharField(max_length=128)), + ('sort_reverse', models.BooleanField(default=False)), + ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), + ], + ), + migrations.CreateModel( + name='SavedViewFilterRule', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('rule_type', models.PositiveIntegerField(choices=[(0, 'Title contains'), (1, 'Content contains'), (2, 'ASN is'), (3, 'Correspondent is'), (4, 'Document type is'), (5, 'Is in inbox'), (6, 'Has tag'), (7, 'Has any tag'), (8, 'Created before'), (9, 'Created after'), (10, 'Created year is'), (11, 'Created month is'), (12, 'Created day is'), (13, 'Added before'), (14, 'Added after'), (15, 'Modified before'), (16, 'Modified after'), (17, 'Does not have tag')])), + ('value', models.CharField(max_length=128)), + ('saved_view', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='filter_rules', to='documents.savedview')), + ], + ), + ] diff --git a/src/documents/migrations/1008_auto_20201216_1736.py b/src/documents/migrations/1008_auto_20201216_1736.py new file mode 100644 index 000000000..d94f4767f --- /dev/null +++ b/src/documents/migrations/1008_auto_20201216_1736.py @@ -0,0 +1,34 @@ +# Generated by Django 3.1.4 on 2020-12-16 17:36 + +from django.db import migrations +import django.db.models.functions.text + + +class Migration(migrations.Migration): + + dependencies = [ + ('documents', '1007_savedview_savedviewfilterrule'), + ] + + operations = [ + migrations.AlterModelOptions( + name='correspondent', + options={'ordering': (django.db.models.functions.text.Lower('name'),)}, + ), + migrations.AlterModelOptions( + name='document', + options={'ordering': ('-created',)}, + ), + migrations.AlterModelOptions( + name='documenttype', + options={'ordering': (django.db.models.functions.text.Lower('name'),)}, + ), + migrations.AlterModelOptions( + name='savedview', + options={'ordering': (django.db.models.functions.text.Lower('name'),)}, + ), + migrations.AlterModelOptions( + name='tag', + options={'ordering': (django.db.models.functions.text.Lower('name'),)}, + ), + ] diff --git a/src/documents/models.py b/src/documents/models.py index f0678a843..02a293eeb 100755 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -9,9 +9,10 @@ import pathvalidate import dateutil.parser from django.conf import settings +from django.contrib.auth.models import User from django.db import models +from django.db.models.functions import Lower from django.utils import timezone -from django.utils.text import slugify from documents.file_handling import archive_name_from_filename from documents.parsers import get_default_file_extension @@ -60,7 +61,7 @@ class MatchingModel(models.Model): class Meta: abstract = True - ordering = ("name",) + ordering = (Lower("name"),) def __str__(self): return self.name @@ -78,9 +79,6 @@ class Correspondent(MatchingModel): # better safe than sorry. SAFE_REGEX = re.compile(r"^[\w\- ,.']+$") - class Meta: - ordering = ("name",) - class Tag(MatchingModel): @@ -204,7 +202,7 @@ class Document(models.Model): ) class Meta: - ordering = ("correspondent", "title") + ordering = ("-created",) def __str__(self): created = datetime.date.isoformat(self.created) @@ -220,7 +218,7 @@ class Document(models.Model): else: fname = "{:07}{}".format(self.pk, self.file_type) if self.storage_type == self.STORAGE_TYPE_GPG: - fname += ".gpg" + fname += ".gpg" # pragma: no cover return os.path.join( settings.ORIGINALS_DIR, @@ -305,6 +303,55 @@ class Log(models.Model): return self.message +class SavedView(models.Model): + + class Meta: + + ordering = (Lower("name"),) + + user = models.ForeignKey(User, on_delete=models.CASCADE) + name = models.CharField(max_length=128) + + show_on_dashboard = models.BooleanField() + show_in_sidebar = models.BooleanField() + + sort_field = models.CharField(max_length=128) + sort_reverse = models.BooleanField(default=False) + + +class SavedViewFilterRule(models.Model): + RULE_TYPES = [ + (0, "Title contains"), + (1, "Content contains"), + (2, "ASN is"), + (3, "Correspondent is"), + (4, "Document type is"), + (5, "Is in inbox"), + (6, "Has tag"), + (7, "Has any tag"), + (8, "Created before"), + (9, "Created after"), + (10, "Created year is"), + (11, "Created month is"), + (12, "Created day is"), + (13, "Added before"), + (14, "Added after"), + (15, "Modified before"), + (16, "Modified after"), + (17, "Does not have tag"), + ] + + saved_view = models.ForeignKey( + SavedView, + on_delete=models.CASCADE, + related_name="filter_rules" + ) + + rule_type = models.PositiveIntegerField(choices=RULE_TYPES) + + value = models.CharField(max_length=128) + + # TODO: why is this in the models file? class FileInfo: diff --git a/src/documents/parsers.py b/src/documents/parsers.py index 36ede3cce..cbbb912de 100644 --- a/src/documents/parsers.py +++ b/src/documents/parsers.py @@ -163,8 +163,6 @@ def parse_date(filename, text): date = None - next_year = timezone.now().year + 5 # Arbitrary 5 year future limit - # if filename date parsing is enabled, search there first: if settings.FILENAME_DATE_ORDER: for m in re.finditer(DATE_REGEX, filename): @@ -176,7 +174,7 @@ def parse_date(filename, text): # Skip all matches that do not parse to a proper date continue - if date is not None and next_year > date.year > 1900: + if date and date.year > 1900 and date <= timezone.now(): return date # Iterate through all regex matches in text and try to parse the date @@ -189,7 +187,7 @@ def parse_date(filename, text): # Skip all matches that do not parse to a proper date continue - if date is not None and next_year > date.year > 1900: + if date and date.year > 1900 and date <= timezone.now(): break else: date = None @@ -210,6 +208,7 @@ class DocumentParser(LoggingMixin): def __init__(self, logging_group): super().__init__() self.logging_group = logging_group + os.makedirs(settings.SCRATCH_DIR, exist_ok=True) self.tempdir = tempfile.mkdtemp( prefix="paperless-", dir=settings.SCRATCH_DIR) @@ -217,6 +216,9 @@ class DocumentParser(LoggingMixin): self.text = None self.date = None + def extract_metadata(self, document_path, mime_type): + return [] + def parse(self, document_path, mime_type): raise NotImplementedError() diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 600645061..ee0a42384 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -1,10 +1,10 @@ import magic from django.utils.text import slugify -from pathvalidate import validate_filename, ValidationError from rest_framework import serializers from rest_framework.fields import SerializerMethodField -from .models import Correspondent, Tag, Document, Log, DocumentType +from .models import Correspondent, Tag, Document, Log, DocumentType, \ + SavedView, SavedViewFilterRule from .parsers import is_mime_type_supported @@ -141,6 +141,45 @@ class LogSerializer(serializers.ModelSerializer): ) +class SavedViewFilterRuleSerializer(serializers.ModelSerializer): + + class Meta: + model = SavedViewFilterRule + fields = ["rule_type", "value"] + + +class SavedViewSerializer(serializers.ModelSerializer): + + filter_rules = SavedViewFilterRuleSerializer(many=True) + + class Meta: + model = SavedView + depth = 1 + fields = ["id", "name", "show_on_dashboard", "show_in_sidebar", + "sort_field", "sort_reverse", "filter_rules"] + + def update(self, instance, validated_data): + if 'filter_rules' in validated_data: + rules_data = validated_data.pop('filter_rules') + else: + rules_data = None + super(SavedViewSerializer, self).update(instance, validated_data) + if rules_data is not None: + SavedViewFilterRule.objects.filter(saved_view=instance).delete() + for rule_data in rules_data: + SavedViewFilterRule.objects.create( + saved_view=instance, **rule_data) + return instance + + def create(self, validated_data): + rules_data = validated_data.pop('filter_rules') + saved_view = SavedView.objects.create(**validated_data) + for rule_data in rules_data: + SavedViewFilterRule.objects.create( + saved_view=saved_view, **rule_data) + return saved_view + + class PostDocumentSerializer(serializers.Serializer): document = serializers.FileField( @@ -179,12 +218,6 @@ class PostDocumentSerializer(serializers.Serializer): ) def validate_document(self, document): - - try: - validate_filename(document.name) - except ValidationError: - raise serializers.ValidationError("Invalid filename.") - document_data = document.file.read() mime_type = magic.from_buffer(document_data, mime=True) diff --git a/src/documents/signals/handlers.py b/src/documents/signals/handlers.py index 4fbbe8f8a..586897585 100755 --- a/src/documents/signals/handlers.py +++ b/src/documents/signals/handlers.py @@ -7,6 +7,7 @@ from django.contrib.admin.models import ADDITION, LogEntry from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from django.db import models, DatabaseError +from django.db.models import Q from django.dispatch import receiver from django.utils import timezone from filelock import FileLock @@ -121,11 +122,14 @@ def set_tags(sender, classifier=None, replace=False, **kwargs): + if replace: - document.tags.clear() - current_tags = set([]) - else: - current_tags = set(document.tags.all()) + Document.tags.through.objects.filter(document=document).exclude( + Q(tag__is_inbox_tag=True)).exclude( + Q(tag__match="") & ~Q(tag__matching_algorithm=Tag.MATCH_AUTO) + ).delete() + + current_tags = set(document.tags.all()) matched_tags = matching.match_tags(document.content, classifier) diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index 572667406..49dddee87 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -4,12 +4,11 @@ import tempfile from unittest import mock from django.contrib.auth.models import User -from pathvalidate import ValidationError from rest_framework.test import APITestCase from whoosh.writing import AsyncWriter from documents import index -from documents.models import Document, Correspondent, DocumentType, Tag +from documents.models import Document, Correspondent, DocumentType, Tag, SavedView from documents.tests.utils import DirectoriesMixin @@ -18,8 +17,8 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): def setUp(self): super(TestDocumentApi, self).setUp() - user = User.objects.create_superuser(username="temp_admin") - self.client.force_login(user=user) + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_login(user=self.user) def testDocuments(self): @@ -170,15 +169,13 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, 200) results = response.data['results'] self.assertEqual(len(results), 2) - self.assertEqual(results[0]['id'], doc2.id) - self.assertEqual(results[1]['id'], doc3.id) + self.assertCountEqual([results[0]['id'], results[1]['id']], [doc2.id, doc3.id]) response = self.client.get("/api/documents/?tags__id__in={},{}".format(tag_inbox.id, tag_3.id)) self.assertEqual(response.status_code, 200) results = response.data['results'] self.assertEqual(len(results), 2) - self.assertEqual(results[0]['id'], doc1.id) - self.assertEqual(results[1]['id'], doc3.id) + self.assertCountEqual([results[0]['id'], results[1]['id']], [doc1.id, doc3.id]) response = self.client.get("/api/documents/?tags__id__all={},{}".format(tag_2.id, tag_3.id)) self.assertEqual(response.status_code, 200) @@ -200,8 +197,7 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, 200) results = response.data['results'] self.assertEqual(len(results), 2) - self.assertEqual(results[0]['id'], doc1.id) - self.assertEqual(results[1]['id'], doc2.id) + self.assertCountEqual([results[0]['id'], results[1]['id']], [doc1.id, doc2.id]) response = self.client.get("/api/documents/?tags__id__none={},{}".format(tag_3.id, tag_2.id)) self.assertEqual(response.status_code, 200) @@ -403,16 +399,6 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, 400) m.assert_not_called() - @mock.patch("documents.views.async_task") - @mock.patch("documents.serialisers.validate_filename") - def test_upload_invalid_filename(self, validate_filename, async_task): - validate_filename.side_effect = ValidationError() - with open(os.path.join(os.path.dirname(__file__), "samples", "simple.pdf"), "rb") as f: - response = self.client.post("/api/documents/post_document/", {"document": f}) - self.assertEqual(response.status_code, 400) - - async_task.assert_not_called() - @mock.patch("documents.views.async_task") def test_upload_with_title(self, async_task): with open(os.path.join(os.path.dirname(__file__), "samples", "simple.pdf"), "rb") as f: @@ -525,3 +511,87 @@ class TestDocumentApi(DirectoriesMixin, APITestCase): self.assertFalse(meta['has_archive_version']) self.assertGreater(len(meta['original_metadata']), 0) self.assertIsNone(meta['archive_metadata']) + + def test_saved_views(self): + u1 = User.objects.create_user("user1") + u2 = User.objects.create_user("user2") + + v1 = SavedView.objects.create(user=u1, name="test1", sort_field="", show_on_dashboard=False, show_in_sidebar=False) + v2 = SavedView.objects.create(user=u2, name="test2", sort_field="", show_on_dashboard=False, show_in_sidebar=False) + v3 = SavedView.objects.create(user=u2, name="test3", sort_field="", show_on_dashboard=False, show_in_sidebar=False) + + response = self.client.get("/api/saved_views/") + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data['count'], 0) + + self.assertEqual(self.client.get(f"/api/saved_views/{v1.id}/").status_code, 404) + + self.client.force_login(user=u1) + + response = self.client.get("/api/saved_views/") + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data['count'], 1) + + self.assertEqual(self.client.get(f"/api/saved_views/{v1.id}/").status_code, 200) + + self.client.force_login(user=u2) + + response = self.client.get("/api/saved_views/") + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data['count'], 2) + + self.assertEqual(self.client.get(f"/api/saved_views/{v1.id}/").status_code, 404) + + def test_create_update_patch(self): + + u1 = User.objects.create_user("user1") + + view = { + "name": "test", + "show_on_dashboard": True, + "show_in_sidebar": True, + "sort_field": "created2", + "filter_rules": [ + { + "rule_type": 4, + "value": "test" + } + ] + } + + response = self.client.post("/api/saved_views/", view, format='json') + self.assertEqual(response.status_code, 201) + + v1 = SavedView.objects.get(name="test") + self.assertEqual(v1.sort_field, "created2") + self.assertEqual(v1.filter_rules.count(), 1) + self.assertEqual(v1.user, self.user) + + response = self.client.patch(f"/api/saved_views/{v1.id}/", { + "show_in_sidebar": False + }, format='json') + + v1 = SavedView.objects.get(id=v1.id) + self.assertEqual(response.status_code, 200) + self.assertFalse(v1.show_in_sidebar) + self.assertEqual(v1.filter_rules.count(), 1) + + view['filter_rules'] = [{ + "rule_type": 12, + "value": "secret" + }] + + response = self.client.put(f"/api/saved_views/{v1.id}/", view, format='json') + self.assertEqual(response.status_code, 200) + + v1 = SavedView.objects.get(id=v1.id) + self.assertEqual(v1.filter_rules.count(), 1) + self.assertEqual(v1.filter_rules.first().value, "secret") + + view['filter_rules'] = [] + + response = self.client.put(f"/api/saved_views/{v1.id}/", view, format='json') + self.assertEqual(response.status_code, 200) + + v1 = SavedView.objects.get(id=v1.id) + self.assertEqual(v1.filter_rules.count(), 0) diff --git a/src/documents/tests/test_file_handling.py b/src/documents/tests/test_file_handling.py index 719b0078a..2e60065f1 100644 --- a/src/documents/tests/test_file_handling.py +++ b/src/documents/tests/test_file_handling.py @@ -9,11 +9,12 @@ from unittest import mock from django.conf import settings from django.db import DatabaseError from django.test import TestCase, override_settings +from django.utils import timezone from .utils import DirectoriesMixin from ..file_handling import generate_filename, create_source_path_directory, delete_empty_directories, \ generate_unique_filename -from ..models import Document, Correspondent +from ..models import Document, Correspondent, Tag class TestFileHandling(DirectoriesMixin, TestCase): @@ -267,6 +268,57 @@ class TestFileHandling(DirectoriesMixin, TestCase): self.assertEqual(generate_filename(document), "none.pdf") + @override_settings(PAPERLESS_FILENAME_FORMAT="{tags}") + def test_tags_without_args(self): + document = Document() + document.mime_type = "application/pdf" + document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED + document.save() + + self.assertEqual(generate_filename(document), f"{document.pk:07}.pdf") + + @override_settings(PAPERLESS_FILENAME_FORMAT="{title} {tag_list}") + def test_tag_list(self): + doc = Document.objects.create(title="doc1", mime_type="application/pdf") + doc.tags.create(name="tag2") + doc.tags.create(name="tag1") + + self.assertEqual(generate_filename(doc), "doc1 tag1,tag2.pdf") + + doc = Document.objects.create(title="doc2", checksum="B", mime_type="application/pdf") + + self.assertEqual(generate_filename(doc), "doc2.pdf") + + @override_settings(PAPERLESS_FILENAME_FORMAT="//etc/something/{title}") + def test_filename_relative(self): + doc = Document.objects.create(title="doc1", mime_type="application/pdf") + doc.filename = generate_filename(doc) + doc.save() + + self.assertEqual(doc.source_path, os.path.join(settings.ORIGINALS_DIR, "etc", "something", "doc1.pdf")) + + @override_settings(PAPERLESS_FILENAME_FORMAT="{created_year}-{created_month}-{created_day}") + def test_created_year_month_day(self): + d1 = timezone.make_aware(datetime.datetime(2020, 3, 6, 1, 1, 1)) + doc1 = Document.objects.create(title="doc1", mime_type="application/pdf", created=d1) + + self.assertEqual(generate_filename(doc1), "2020-03-06.pdf") + + doc1.created = timezone.make_aware(datetime.datetime(2020, 11, 16, 1, 1, 1)) + + self.assertEqual(generate_filename(doc1), "2020-11-16.pdf") + + @override_settings(PAPERLESS_FILENAME_FORMAT="{added_year}-{added_month}-{added_day}") + def test_added_year_month_day(self): + d1 = timezone.make_aware(datetime.datetime(232, 1, 9, 1, 1, 1)) + doc1 = Document.objects.create(title="doc1", mime_type="application/pdf", added=d1) + + self.assertEqual(generate_filename(doc1), "232-01-09.pdf") + + doc1.added = timezone.make_aware(datetime.datetime(2020, 11, 16, 1, 1, 1)) + + self.assertEqual(generate_filename(doc1), "2020-11-16.pdf") + @override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}/{correspondent}/{correspondent}") def test_nested_directory_cleanup(self): document = Document() @@ -548,7 +600,7 @@ class TestFilenameGeneration(TestCase): PAPERLESS_FILENAME_FORMAT="{created}" ) def test_date(self): - doc = Document.objects.create(title="does not matter", created=datetime.datetime(2020,5,21, 7,36,51, 153), mime_type="application/pdf", pk=2, checksum="2") + doc = Document.objects.create(title="does not matter", created=timezone.make_aware(datetime.datetime(2020,5,21, 7,36,51, 153)), mime_type="application/pdf", pk=2, checksum="2") self.assertEqual(generate_filename(doc), "2020-05-21.pdf") diff --git a/src/documents/tests/test_index.py b/src/documents/tests/test_index.py index 830fca0e0..2baa9621d 100644 --- a/src/documents/tests/test_index.py +++ b/src/documents/tests/test_index.py @@ -1,6 +1,9 @@ from django.test import TestCase +from documents import index from documents.index import JsonFormatter +from documents.models import Document +from documents.tests.utils import DirectoriesMixin class JsonFormatterTest(TestCase): @@ -12,3 +15,21 @@ class JsonFormatterTest(TestCase): self.assertListEqual(self.formatter.format([]), []) +class TestAutoComplete(DirectoriesMixin, TestCase): + + def test_auto_complete(self): + + doc1 = Document.objects.create(title="doc1", checksum="A", content="test test2 test3") + doc2 = Document.objects.create(title="doc2", checksum="B", content="test test2") + doc3 = Document.objects.create(title="doc3", checksum="C", content="test2") + + index.add_or_update_document(doc1) + index.add_or_update_document(doc2) + index.add_or_update_document(doc3) + + ix = index.open_index() + + self.assertListEqual(index.autocomplete(ix, "tes"), [b"test3", b"test", b"test2"]) + self.assertListEqual(index.autocomplete(ix, "tes", limit=3), [b"test3", b"test", b"test2"]) + self.assertListEqual(index.autocomplete(ix, "tes", limit=1), [b"test3"]) + self.assertListEqual(index.autocomplete(ix, "tes", limit=0), []) diff --git a/src/documents/tests/test_management_retagger.py b/src/documents/tests/test_management_retagger.py index 2346b6527..907a23d09 100644 --- a/src/documents/tests/test_management_retagger.py +++ b/src/documents/tests/test_management_retagger.py @@ -14,6 +14,12 @@ class TestRetagger(DirectoriesMixin, TestCase): self.tag_first = Tag.objects.create(name="tag1", match="first", matching_algorithm=Tag.MATCH_ANY) self.tag_second = Tag.objects.create(name="tag2", match="second", matching_algorithm=Tag.MATCH_ANY) + self.tag_inbox = Tag.objects.create(name="test", is_inbox_tag=True) + self.tag_no_match = Tag.objects.create(name="test2") + + self.d3.tags.add(self.tag_inbox) + self.d3.tags.add(self.tag_no_match) + self.correspondent_first = Correspondent.objects.create( name="c1", match="first", matching_algorithm=Correspondent.MATCH_ANY) @@ -38,7 +44,7 @@ class TestRetagger(DirectoriesMixin, TestCase): self.assertEqual(d_first.tags.count(), 1) self.assertEqual(d_second.tags.count(), 1) - self.assertEqual(d_unrelated.tags.count(), 0) + self.assertEqual(d_unrelated.tags.count(), 2) self.assertEqual(d_first.tags.first(), self.tag_first) self.assertEqual(d_second.tags.first(), self.tag_second) @@ -56,3 +62,17 @@ class TestRetagger(DirectoriesMixin, TestCase): self.assertEqual(d_first.correspondent, self.correspondent_first) self.assertEqual(d_second.correspondent, self.correspondent_second) + + def test_overwrite_preserve_inbox(self): + self.d1.tags.add(self.tag_second) + + call_command('document_retagger', '--tags', '--overwrite') + + d_first, d_second, d_unrelated = self.get_updated_docs() + + self.assertIsNotNone(Tag.objects.get(id=self.tag_second.id)) + + self.assertCountEqual([tag.id for tag in d_first.tags.all()], [self.tag_first.id]) + self.assertCountEqual([tag.id for tag in d_second.tags.all()], [self.tag_second.id]) + self.assertCountEqual([tag.id for tag in d_unrelated.tags.all()], [self.tag_inbox.id, self.tag_no_match.id]) + diff --git a/src/documents/tests/test_sanity_check.py b/src/documents/tests/test_sanity_check.py index 725e87617..0554cd7cd 100644 --- a/src/documents/tests/test_sanity_check.py +++ b/src/documents/tests/test_sanity_check.py @@ -2,6 +2,8 @@ import os import shutil from pathlib import Path +import filelock +from django.conf import settings from django.test import TestCase from documents.models import Document @@ -13,9 +15,11 @@ class TestSanityCheck(DirectoriesMixin, TestCase): def make_test_data(self): - shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "originals", "0000001.pdf"), os.path.join(self.dirs.originals_dir, "0000001.pdf")) - shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "archive", "0000001.pdf"), os.path.join(self.dirs.archive_dir, "0000001.pdf")) - shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "thumbnails", "0000001.png"), os.path.join(self.dirs.thumbnail_dir, "0000001.png")) + with filelock.FileLock(settings.MEDIA_LOCK): + # just make sure that the lockfile is present. + shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "originals", "0000001.pdf"), os.path.join(self.dirs.originals_dir, "0000001.pdf")) + shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "archive", "0000001.pdf"), os.path.join(self.dirs.archive_dir, "0000001.pdf")) + shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "thumbnails", "0000001.png"), os.path.join(self.dirs.thumbnail_dir, "0000001.png")) return Document.objects.create(title="test", checksum="42995833e01aea9b3edee44bbfdd7ce1", archive_checksum="62acb0bcbfbcaa62ca6ad3668e4e404b", content="test", pk=1, filename="0000001.pdf", mime_type="application/pdf") diff --git a/src/documents/tests/utils.py b/src/documents/tests/utils.py index 7f9d50ed5..dfefc4061 100644 --- a/src/documents/tests/utils.py +++ b/src/documents/tests/utils.py @@ -34,7 +34,8 @@ def setup_directories(): ARCHIVE_DIR=dirs.archive_dir, CONSUMPTION_DIR=dirs.consumption_dir, INDEX_DIR=dirs.index_dir, - MODEL_FILE=os.path.join(dirs.data_dir, "classification_model.pickle") + MODEL_FILE=os.path.join(dirs.data_dir, "classification_model.pickle"), + MEDIA_LOCK=os.path.join(dirs.media_dir, "media.lock") ) dirs.settings_override.enable() diff --git a/src/documents/views.py b/src/documents/views.py index 8dbb61dc7..36d3445c4 100755 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -1,11 +1,8 @@ -import logging import os -import re import tempfile from datetime import datetime from time import mktime -import pikepdf from django.conf import settings from django.db.models import Count, Max from django.http import HttpResponse, HttpResponseBadRequest, Http404 @@ -41,14 +38,16 @@ from .filters import ( DocumentTypeFilterSet, LogFilterSet ) -from .models import Correspondent, Document, Log, Tag, DocumentType +from .models import Correspondent, Document, Log, Tag, DocumentType, SavedView +from .parsers import get_parser_class_for_mime_type from .serialisers import ( CorrespondentSerializer, DocumentSerializer, LogSerializer, TagSerializer, DocumentTypeSerializer, - PostDocumentSerializer + PostDocumentSerializer, + SavedViewSerializer ) @@ -163,34 +162,16 @@ class DocumentViewSet(RetrieveModelMixin, disposition, filename) return response - def get_metadata(self, file, type): + def get_metadata(self, file, mime_type): if not os.path.isfile(file): return None - namespace_pattern = re.compile(r"\{(.*)\}(.*)") - - result = [] - if type == 'application/pdf': - pdf = pikepdf.open(file) - meta = pdf.open_metadata() - for key, value in meta.items(): - if isinstance(value, list): - value = " ".join([str(e) for e in value]) - value = str(value) - try: - m = namespace_pattern.match(key) - result.append({ - "namespace": m.group(1), - "prefix": meta.REVERSE_NS[m.group(1)], - "key": m.group(2), - "value": value - }) - except Exception as e: - logging.getLogger(__name__).warning( - f"Error while reading metadata {key}: {value}. Error: " - f"{e}" - ) - return result + parser_class = get_parser_class_for_mime_type(mime_type) + if parser_class: + parser = parser_class(logging_group=None) + return parser.extract_metadata(file, mime_type) + else: + return [] @action(methods=['get'], detail=True) def metadata(self, request, pk=None): @@ -260,6 +241,22 @@ class LogViewSet(ReadOnlyModelViewSet): ordering_fields = ("created",) +class SavedViewViewSet(ModelViewSet): + model = SavedView + + queryset = SavedView.objects.all() + serializer_class = SavedViewSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + def get_queryset(self): + user = self.request.user + return SavedView.objects.filter(user=user) + + def perform_create(self, serializer): + serializer.save(user=self.request.user) + + class PostDocumentView(APIView): permission_classes = (IsAuthenticated,) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index cf0c3e28d..1a6b80a0c 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -210,6 +210,12 @@ AUTH_PASSWORD_VALIDATORS = [ DATA_UPLOAD_MAX_NUMBER_FIELDS = None +COOKIE_PREFIX = os.getenv("PAPERLESS_COOKIE_PREFIX", "") + +CSRF_COOKIE_NAME = f"{COOKIE_PREFIX}csrftoken" +SESSION_COOKIE_NAME = f"{COOKIE_PREFIX}sessionid" +LANGUAGE_COOKIE_NAME = f"{COOKIE_PREFIX}django_language" + ############################################################################### # Database # ############################################################################### diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 9b390b139..079971bb3 100755 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -17,7 +17,8 @@ from documents.views import ( IndexView, SearchAutoCompleteView, StatisticsView, - PostDocumentView + PostDocumentView, + SavedViewViewSet ) from paperless.views import FaviconView @@ -27,6 +28,7 @@ api_router.register(r"document_types", DocumentTypeViewSet) api_router.register(r"documents", DocumentViewSet) api_router.register(r"logs", LogViewSet) api_router.register(r"tags", TagViewSet) +api_router.register(r"saved_views", SavedViewViewSet) urlpatterns = [ diff --git a/src/paperless/version.py b/src/paperless/version.py index 527e0668d..3c8636a10 100644 --- a/src/paperless/version.py +++ b/src/paperless/version.py @@ -1 +1 @@ -__version__ = (0, 9, 6) +__version__ = (0, 9, 7) diff --git a/src/paperless_mail/mail.py b/src/paperless_mail/mail.py index a82c34f15..3c200362d 100644 --- a/src/paperless_mail/mail.py +++ b/src/paperless_mail/mail.py @@ -26,7 +26,7 @@ class BaseMailAction: return {} def post_consume(self, M, message_uids, parameter): - pass + pass # pragma: nocover class DeleteMailAction(BaseMailAction): @@ -69,7 +69,7 @@ def get_rule_action(rule): elif rule.action == MailRule.ACTION_MARK_READ: return MarkReadMailAction() else: - raise ValueError("Unknown action.") + raise NotImplementedError("Unknown action.") # pragma: nocover def make_criterias(rule): @@ -95,7 +95,7 @@ def get_mailbox(server, port, security): elif security == MailAccount.IMAP_SECURITY_SSL: mailbox = MailBox(server, port) else: - raise ValueError("Unknown IMAP security") + raise NotImplementedError("Unknown IMAP security") # pragma: nocover return mailbox @@ -119,7 +119,7 @@ class MailAccountHandler(LoggingMixin): return os.path.splitext(os.path.basename(att.filename))[0] else: - raise ValueError("Unknown title selector.") + raise NotImplementedError("Unknown title selector.") # pragma: nocover # NOQA: E501 def get_correspondent(self, message, rule): c_from = rule.assign_correspondent_from @@ -141,7 +141,7 @@ class MailAccountHandler(LoggingMixin): return rule.assign_correspondent else: - raise ValueError("Unknwown correspondent selector") + raise NotImplementedError("Unknwown correspondent selector") # pragma: nocover # NOQA: E501 def handle_mail_account(self, account): diff --git a/src/paperless_mail/tests/test_mail.py b/src/paperless_mail/tests/test_mail.py index 2a391a268..9c0f52c53 100644 --- a/src/paperless_mail/tests/test_mail.py +++ b/src/paperless_mail/tests/test_mail.py @@ -399,7 +399,7 @@ class TestMail(TestCase): c = Correspondent.objects.get(name="amazon@amazon.de") # should work - self.assertEquals(kwargs['override_correspondent_id'], c.id) + self.assertEqual(kwargs['override_correspondent_id'], c.id) self.async_task.reset_mock() self.reset_bogus_mailbox() @@ -411,7 +411,7 @@ class TestMail(TestCase): args, kwargs = self.async_task.call_args self.async_task.assert_called_once() - self.assertEquals(kwargs['override_correspondent_id'], None) + self.assertEqual(kwargs['override_correspondent_id'], None) def test_filters(self): diff --git a/src/paperless_tesseract/parsers.py b/src/paperless_tesseract/parsers.py index ebd706cdd..80e200f27 100644 --- a/src/paperless_tesseract/parsers.py +++ b/src/paperless_tesseract/parsers.py @@ -5,6 +5,7 @@ import subprocess import ocrmypdf import pdftotext +import pikepdf from PIL import Image from django.conf import settings from ocrmypdf import InputFileError, EncryptedPdfError @@ -18,6 +19,33 @@ class RasterisedDocumentParser(DocumentParser): image, whether it's a PDF, or other graphical format (JPEG, TIFF, etc.) """ + def extract_metadata(self, document_path, mime_type): + namespace_pattern = re.compile(r"\{(.*)\}(.*)") + + result = [] + if mime_type == 'application/pdf': + pdf = pikepdf.open(document_path) + meta = pdf.open_metadata() + for key, value in meta.items(): + if isinstance(value, list): + value = " ".join([str(e) for e in value]) + value = str(value) + try: + m = namespace_pattern.match(key) + result.append({ + "namespace": m.group(1), + "prefix": meta.REVERSE_NS[m.group(1)], + "key": m.group(2), + "value": value + }) + except Exception as e: + self.log( + "warning", + f"Error while reading metadata {key}: {value}. Error: " + f"{e}" + ) + return result + def get_thumbnail(self, document_path, mime_type): """ The thumbnail of a PDF is just a 500px wide image of the first page. @@ -82,6 +110,24 @@ class RasterisedDocumentParser(DocumentParser): f"Error while getting DPI from image {image}: {e}") return None + def calculate_a4_dpi(self, image): + try: + with Image.open(image) as im: + width, height = im.size + # divide image width by A4 width (210mm) in inches. + dpi = int(width / (21 / 2.54)) + self.log( + 'debug', + f"Estimated DPI {dpi} based on image width {width}" + ) + return dpi + + except Exception as e: + self.log( + 'warning', + f"Error while calculating DPI for image {image}: {e}") + return None + def parse(self, document_path, mime_type): mode = settings.OCR_MODE @@ -134,6 +180,7 @@ class RasterisedDocumentParser(DocumentParser): if self.is_image(mime_type): dpi = self.get_dpi(document_path) + a4_dpi = self.calculate_a4_dpi(document_path) if dpi: self.log( "debug", @@ -142,6 +189,8 @@ class RasterisedDocumentParser(DocumentParser): ocr_args['image_dpi'] = dpi elif settings.OCR_IMAGE_DPI: ocr_args['image_dpi'] = settings.OCR_IMAGE_DPI + elif a4_dpi: + ocr_args['image_dpi'] = a4_dpi else: raise ParseError( f"Cannot produce archive PDF for image {document_path}, " @@ -213,6 +262,9 @@ def strip_excess_whitespace(text): def get_text_from_pdf(pdf_file): + if not os.path.isfile(pdf_file): + return None + with open(pdf_file, "rb") as f: try: pdf = pdftotext.PDF(f) diff --git a/src/paperless_tesseract/tests/test_parser.py b/src/paperless_tesseract/tests/test_parser.py index 8834ec755..7be176663 100644 --- a/src/paperless_tesseract/tests/test_parser.py +++ b/src/paperless_tesseract/tests/test_parser.py @@ -164,8 +164,21 @@ class TestParser(DirectoriesMixin, TestCase): self.assertRaises(ParseError, f) + @mock.patch("paperless_tesseract.parsers.ocrmypdf.ocr") + def test_image_calc_a4_dpi(self, m): + parser = RasterisedDocumentParser(None) - def test_image_no_dpi_fail(self): + parser.parse(os.path.join(self.SAMPLE_FILES, "simple-no-dpi.png"), "image/png") + + m.assert_called_once() + + args, kwargs = m.call_args + + self.assertEqual(kwargs['image_dpi'], 62) + + @mock.patch("paperless_tesseract.parsers.RasterisedDocumentParser.calculate_a4_dpi") + def test_image_dpi_fail(self, m): + m.return_value = None parser = RasterisedDocumentParser(None) def f(): diff --git a/src/paperless_text/parsers.py b/src/paperless_text/parsers.py index f8f369ab0..7e488ca37 100644 --- a/src/paperless_text/parsers.py +++ b/src/paperless_text/parsers.py @@ -1,6 +1,7 @@ import os import subprocess +from PIL import ImageDraw, ImageFont, Image from django.conf import settings from documents.parsers import DocumentParser, ParseError @@ -12,63 +13,22 @@ class TextDocumentParser(DocumentParser): """ def get_thumbnail(self, document_path, mime_type): - """ - The thumbnail of a text file is just a 500px wide image of the text - rendered onto a letter-sized page. - """ - # The below is heavily cribbed from https://askubuntu.com/a/590951 - - bg_color = "white" # bg color - text_color = "black" # text color - psize = [500, 647] # icon size - n_lines = 50 # number of lines to show - out_path = os.path.join(self.tempdir, "convert.png") - - temp_bg = os.path.join(self.tempdir, "bg.png") - temp_txlayer = os.path.join(self.tempdir, "tx.png") - picsize = "x".join([str(n) for n in psize]) - txsize = "x".join([str(n - 8) for n in psize]) - - def create_bg(): - work_size = ",".join([str(n - 1) for n in psize]) - r = str(round(psize[0] / 10)) - rounded = ",".join([r, r]) - run_command( - settings.CONVERT_BINARY, - "-size ", picsize, - ' xc:none -draw ', - '"fill ', bg_color, ' roundrectangle 0,0,', work_size, ",", rounded, '" ', # NOQA: E501 - temp_bg - ) def read_text(): with open(document_path, 'r') as src: lines = [line.strip() for line in src.readlines()] - text = "\n".join([line for line in lines[:n_lines]]) - return text.replace('"', "'") + text = "\n".join(lines[:50]) + return text - def create_txlayer(): - run_command( - settings.CONVERT_BINARY, - "-background none", - "-fill", - text_color, - "-pointsize", "12", - "-border 4 -bordercolor none", - "-size ", txsize, - ' caption:"', read_text(), '" ', - temp_txlayer - ) + img = Image.new("RGB", (500, 700), color="white") + draw = ImageDraw.Draw(img) + font = ImageFont.truetype( + "/usr/share/fonts/liberation/LiberationSerif-Regular.ttf", 20, + layout_engine=ImageFont.LAYOUT_BASIC) + draw.text((5, 5), read_text(), font=font, fill="black") - create_txlayer() - create_bg() - run_command( - settings.CONVERT_BINARY, - temp_bg, - temp_txlayer, - "-background None -layers merge ", - out_path - ) + out_path = os.path.join(self.tempdir, "thumb.png") + img.save(out_path) return out_path diff --git a/src/paperless_text/tests/samples/test.txt b/src/paperless_text/tests/samples/test.txt new file mode 100644 index 000000000..6de7b8c69 --- /dev/null +++ b/src/paperless_text/tests/samples/test.txt @@ -0,0 +1 @@ +This is a test file. diff --git a/src/paperless_text/tests/test_parser.py b/src/paperless_text/tests/test_parser.py new file mode 100644 index 000000000..413aa91cf --- /dev/null +++ b/src/paperless_text/tests/test_parser.py @@ -0,0 +1,26 @@ +import os + +from django.test import TestCase + +from documents.tests.utils import DirectoriesMixin +from paperless_text.parsers import TextDocumentParser + + +class TestTextParser(DirectoriesMixin, TestCase): + + def test_thumbnail(self): + + parser = TextDocumentParser(None) + + # just make sure that it does not crash + f = parser.get_thumbnail(os.path.join(os.path.dirname(__file__), "samples", "test.txt"), "text/plain") + self.assertTrue(os.path.isfile(f)) + + def test_parse(self): + + parser = TextDocumentParser(None) + + parser.parse(os.path.join(os.path.dirname(__file__), "samples", "test.txt"), "text/plain") + + self.assertEqual(parser.get_text(), "This is a test file.\n") + self.assertIsNone(parser.get_archive_path())
Name{{ tag.document_count }}
- - + + +