mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
Merge branch 'dev' into feature-bulk-edit
This commit is contained in:
jonaswinkler
commit
38156123d4
@ -5,85 +5,6 @@ Advanced topics
|
|||||||
Paperless offers a couple features that automate certain tasks and make your life
|
Paperless offers a couple features that automate certain tasks and make your life
|
||||||
easier.
|
easier.
|
||||||
|
|
||||||
Guesswork
|
|
||||||
#########
|
|
||||||
|
|
||||||
|
|
||||||
Any document you put into the consumption directory will be consumed, but if
|
|
||||||
you name the file right, it'll automatically set some values in the database
|
|
||||||
for you. This is is the logic the consumer follows:
|
|
||||||
|
|
||||||
1. Try to find the correspondent, title, and tags in the file name following
|
|
||||||
the pattern: ``Date - Correspondent - Title - tag,tag,tag.pdf``. Note that
|
|
||||||
the format of the date is **rigidly defined** as ``YYYYMMDDHHMMSSZ`` or
|
|
||||||
``YYYYMMDDZ``. The ``Z`` refers "Zulu time" AKA "UTC".
|
|
||||||
The tags are optional, so the format ``Date - Correspondent - Title.pdf``
|
|
||||||
works as well.
|
|
||||||
2. If that doesn't work, we skip the date and try this pattern:
|
|
||||||
``Correspondent - Title - tag,tag,tag.pdf``.
|
|
||||||
3. If that doesn't work, we try to find the correspondent and title in the file
|
|
||||||
name following the pattern: ``Correspondent - Title.pdf``.
|
|
||||||
4. If that doesn't work, just assume that the name of the file is the title.
|
|
||||||
|
|
||||||
So given the above, the following examples would work as you'd expect:
|
|
||||||
|
|
||||||
* ``20150314000700Z - Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
|
|
||||||
* ``20150314Z - Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
|
|
||||||
* ``Some Company Name - Invoice 2016-01-01 - money,invoices.pdf``
|
|
||||||
* ``Another Company - Letter of Reference.jpg``
|
|
||||||
* ``Dad's Recipe for Pancakes.png``
|
|
||||||
|
|
||||||
These however wouldn't work:
|
|
||||||
|
|
||||||
* ``2015-03-14 00:07:00 UTC - Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
|
|
||||||
* ``2015-03-14 - Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
|
|
||||||
* ``Some Company Name, Invoice 2016-01-01, money, invoices.pdf``
|
|
||||||
* ``Another Company- Letter of Reference.jpg``
|
|
||||||
|
|
||||||
Do I have to be so strict about naming?
|
|
||||||
=======================================
|
|
||||||
|
|
||||||
Rather than using the strict document naming rules, one can also set the option
|
|
||||||
``PAPERLESS_FILENAME_DATE_ORDER`` in ``paperless.conf`` to any date order
|
|
||||||
that is accepted by dateparser_. Doing so will cause ``paperless`` to default
|
|
||||||
to any date format that is found in the title, instead of a date pulled from
|
|
||||||
the document's text, without requiring the strict formatting of the document
|
|
||||||
filename as described above.
|
|
||||||
|
|
||||||
.. _dateparser: https://github.com/scrapinghub/dateparser/blob/v0.7.0/docs/usage.rst#settings
|
|
||||||
|
|
||||||
.. _advanced-transforming_filenames:
|
|
||||||
|
|
||||||
Transforming filenames for parsing
|
|
||||||
==================================
|
|
||||||
|
|
||||||
Some devices can't produce filenames that can be parsed by the default
|
|
||||||
parser. By configuring the option ``PAPERLESS_FILENAME_PARSE_TRANSFORMS`` in
|
|
||||||
``paperless.conf`` one can add transformations that are applied to the filename
|
|
||||||
before it's parsed.
|
|
||||||
|
|
||||||
The option contains a list of dictionaries of regular expressions (key:
|
|
||||||
``pattern``) and replacements (key: ``repl``) in JSON format, which are
|
|
||||||
applied in order by passing them to ``re.subn``. Transformation stops
|
|
||||||
after the first match, so at most one transformation is applied. The general
|
|
||||||
syntax is
|
|
||||||
|
|
||||||
.. code:: python
|
|
||||||
|
|
||||||
[{"pattern":"pattern1", "repl":"repl1"}, {"pattern":"pattern2", "repl":"repl2"}, ..., {"pattern":"patternN", "repl":"replN"}]
|
|
||||||
|
|
||||||
The example below is for a Brother ADS-2400N, a scanner that allows
|
|
||||||
different names to different hardware buttons (useful for handling
|
|
||||||
multiple entities in one instance), but insists on adding ``_<count>``
|
|
||||||
to the filename.
|
|
||||||
|
|
||||||
.. code:: python
|
|
||||||
|
|
||||||
# Brother profile configuration, support "Name_Date_Count" (the default
|
|
||||||
# setting) and "Name_Count" (use "Name" as tag and "Count" as title).
|
|
||||||
PAPERLESS_FILENAME_PARSE_TRANSFORMS=[{"pattern":"^([a-z]+)_(\\d{8})_(\\d{6})_([0-9]+)\\.", "repl":"\\2\\3Z - \\4 - \\1."}, {"pattern":"^([a-z]+)_([0-9]+)\\.", "repl":" - \\2 - \\1."}]
|
|
||||||
|
|
||||||
|
|
||||||
.. _advanced-matching:
|
.. _advanced-matching:
|
||||||
|
|
||||||
Matching tags, correspondents and document types
|
Matching tags, correspondents and document types
|
||||||
|
|||||||
15
docs/api.rst
15
docs/api.rst
@ -221,21 +221,16 @@ Each fragment contains a list of strings, and some of them are marked as a highl
|
|||||||
|
|
||||||
[
|
[
|
||||||
[
|
[
|
||||||
{"text": "This is a sample text with a "},
|
{"text": "This is a sample text with a ", "highlight": false},
|
||||||
{"text": "highlighted", "term": 0},
|
{"text": "highlighted", "highlight": true},
|
||||||
{"text": " word."}
|
{"text": " word.", "highlight": false}
|
||||||
],
|
],
|
||||||
[
|
[
|
||||||
{"text": "Another", "term": 1},
|
{"text": "Another", "highlight": true},
|
||||||
{"text": " fragment with a highlight."}
|
{"text": " fragment with a highlight.", "highlight": false}
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
When ``term`` is present within a string, the word within ``text`` should be highlighted.
|
|
||||||
The term index groups multiple matches together and words with the same index
|
|
||||||
should get identical highlighting.
|
|
||||||
A client may use this example to produce the following output:
|
A client may use this example to produce the following output:
|
||||||
|
|
||||||
... This is a sample text with a **highlighted** word. ... **Another** fragment with a highlight. ...
|
... This is a sample text with a **highlighted** word. ... **Another** fragment with a highlight. ...
|
||||||
|
|||||||
@ -400,11 +400,6 @@ PAPERLESS_FILENAME_DATE_ORDER=<format>
|
|||||||
|
|
||||||
Defaults to none, which disables this feature.
|
Defaults to none, which disables this feature.
|
||||||
|
|
||||||
PAPERLESS_FILENAME_PARSE_TRANSFORMS
|
|
||||||
Transforms filenames before they are processed by paperless. See
|
|
||||||
:ref:`advanced-transforming_filenames` for details.
|
|
||||||
|
|
||||||
Defaults to none, which disables this feature.
|
|
||||||
|
|
||||||
Binaries
|
Binaries
|
||||||
########
|
########
|
||||||
|
|||||||
8
src-ui/package-lock.json
generated
8
src-ui/package-lock.json
generated
@ -2056,6 +2056,14 @@
|
|||||||
"tslib": "^2.0.0"
|
"tslib": "^2.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"@ng-select/ng-select": {
|
||||||
|
"version": "5.0.9",
|
||||||
|
"resolved": "https://registry.npmjs.org/@ng-select/ng-select/-/ng-select-5.0.9.tgz",
|
||||||
|
"integrity": "sha512-YZeSAiS8/Nx/eHZJPmOOYL8YmcvSq+dr1P8WIrsKmRA7mueorBpPc5xlUj+nLQbpLtsiQvdWDQspf/ykOvD/lA==",
|
||||||
|
"requires": {
|
||||||
|
"tslib": "^2.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"@ngtools/webpack": {
|
"@ngtools/webpack": {
|
||||||
"version": "10.2.0",
|
"version": "10.2.0",
|
||||||
"resolved": "https://registry.npmjs.org/@ngtools/webpack/-/webpack-10.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/@ngtools/webpack/-/webpack-10.2.0.tgz",
|
||||||
|
|||||||
@ -21,6 +21,7 @@
|
|||||||
"@angular/platform-browser-dynamic": "~10.1.5",
|
"@angular/platform-browser-dynamic": "~10.1.5",
|
||||||
"@angular/router": "~10.1.5",
|
"@angular/router": "~10.1.5",
|
||||||
"@ng-bootstrap/ng-bootstrap": "^8.0.0",
|
"@ng-bootstrap/ng-bootstrap": "^8.0.0",
|
||||||
|
"@ng-select/ng-select": "^5.0.9",
|
||||||
"bootstrap": "^4.5.0",
|
"bootstrap": "^4.5.0",
|
||||||
"ng-bootstrap": "^1.6.3",
|
"ng-bootstrap": "^1.6.3",
|
||||||
"ng2-pdf-viewer": "^6.3.2",
|
"ng2-pdf-viewer": "^6.3.2",
|
||||||
|
|||||||
@ -54,6 +54,7 @@ import { FileSizePipe } from './pipes/file-size.pipe';
|
|||||||
import { FilterPipe } from './pipes/filter.pipe';
|
import { FilterPipe } from './pipes/filter.pipe';
|
||||||
import { DocumentTitlePipe } from './pipes/document-title.pipe';
|
import { DocumentTitlePipe } from './pipes/document-title.pipe';
|
||||||
import { MetadataCollapseComponent } from './components/document-detail/metadata-collapse/metadata-collapse.component';
|
import { MetadataCollapseComponent } from './components/document-detail/metadata-collapse/metadata-collapse.component';
|
||||||
|
import { NgSelectModule } from '@ng-select/ng-select';
|
||||||
import { SelectDialogComponent } from './components/common/select-dialog/select-dialog.component';
|
import { SelectDialogComponent } from './components/common/select-dialog/select-dialog.component';
|
||||||
|
|
||||||
@NgModule({
|
@NgModule({
|
||||||
@ -112,7 +113,8 @@ import { SelectDialogComponent } from './components/common/select-dialog/select-
|
|||||||
ReactiveFormsModule,
|
ReactiveFormsModule,
|
||||||
NgxFileDropModule,
|
NgxFileDropModule,
|
||||||
InfiniteScrollModule,
|
InfiniteScrollModule,
|
||||||
PdfViewerModule
|
PdfViewerModule,
|
||||||
|
NgSelectModule
|
||||||
],
|
],
|
||||||
providers: [
|
providers: [
|
||||||
DatePipe,
|
DatePipe,
|
||||||
|
|||||||
@ -1,11 +1,15 @@
|
|||||||
<div class="form-group">
|
<div class="form-group paperless-input-select">
|
||||||
<label [for]="inputId">{{title}}</label>
|
<label [for]="inputId">{{title}}</label>
|
||||||
<div [class.input-group]="showPlusButton()">
|
<div [class.input-group]="showPlusButton()">
|
||||||
<select class="form-control" [id]="inputId" [(ngModel)]="value" (change)="onChange(value)" (blur)="onTouched()"
|
<ng-select name="inputId" [(ngModel)]="value"
|
||||||
[disabled]="disabled" [style.color]="textColor" [style.background]="backgroundColor">
|
[disabled]="disabled"
|
||||||
<option *ngIf="allowNull" [ngValue]="null" class="form-control">---</option>
|
[style.color]="textColor"
|
||||||
<option *ngFor="let i of items" [ngValue]="i.id" class="form-control">{{i.name}}</option>
|
[style.background]="backgroundColor"
|
||||||
</select>
|
(change)="onChange(value)"
|
||||||
|
(blur)="onTouched()">
|
||||||
|
<ng-option *ngFor="let i of items" [value]="i.id">{{i.name}}</ng-option>
|
||||||
|
</ng-select>
|
||||||
|
|
||||||
<div *ngIf="showPlusButton()" class="input-group-append">
|
<div *ngIf="showPlusButton()" class="input-group-append">
|
||||||
<button class="btn btn-outline-secondary" type="button" (click)="createNew.emit()">
|
<button class="btn btn-outline-secondary" type="button" (click)="createNew.emit()">
|
||||||
<svg class="buttonicon" fill="currentColor">
|
<svg class="buttonicon" fill="currentColor">
|
||||||
|
|||||||
@ -0,0 +1 @@
|
|||||||
|
// styles for ng-select child are in styles.scss
|
||||||
@ -1,29 +1,40 @@
|
|||||||
<div class="form-group">
|
<div class="form-group paperless-input-select paperless-input-tags">
|
||||||
<label for="exampleFormControlTextarea1">Tags</label>
|
<label for="tags">Tags</label>
|
||||||
|
|
||||||
<div class="input-group">
|
<div class="input-group flex-nowrap">
|
||||||
<div class="form-control tags-form-control" id="tags">
|
<ng-select name="tags" [items]="tags" bindLabel="name" bindValue="id" [(ngModel)]="displayValue"
|
||||||
<app-tag class="mr-2" *ngFor="let id of displayValue" [tag]="getTag(id)" (click)="removeTag(id)"></app-tag>
|
[multiple]="true"
|
||||||
</div>
|
[closeOnSelect]="false"
|
||||||
|
[disabled]="disabled"
|
||||||
|
(change)="ngSelectChange()">
|
||||||
|
|
||||||
<div class="input-group-append" ngbDropdown placement="top-right">
|
<ng-template ng-label-tmp let-item="item">
|
||||||
<button class="btn btn-outline-secondary" type="button" ngbDropdownToggle></button>
|
<span class="tag-wrap tag-wrap-delete" (click)="removeTag(item.id)">
|
||||||
<div ngbDropdownMenu class="scrollable-menu shadow">
|
<svg width="1.2em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||||
<button type="button" *ngFor="let tag of tags" ngbDropdownItem (click)="addTag(tag.id)">
|
<use xlink:href="assets/bootstrap-icons.svg#x"/>
|
||||||
<app-tag [tag]="tag"></app-tag>
|
</svg>
|
||||||
</button>
|
<app-tag style="background-color: none;" [tag]="getTag(item.id)"></app-tag>
|
||||||
</div>
|
</span>
|
||||||
</div>
|
</ng-template>
|
||||||
|
<ng-template ng-option-tmp let-item="item" let-index="index" let-search="searchTerm">
|
||||||
|
<div class="tag-wrap">
|
||||||
|
<div class="selected-icon d-inline-block mr-1">
|
||||||
|
<svg *ngIf="displayValue.includes(item.id)" width="1em" height="1em" viewBox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<use xlink:href="assets/bootstrap-icons.svg#check"/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
<app-tag class="mr-2" [tag]="getTag(item.id)"></app-tag>
|
||||||
|
</div>
|
||||||
|
</ng-template>
|
||||||
|
</ng-select>
|
||||||
|
|
||||||
<div class="input-group-append">
|
<div class="input-group-append">
|
||||||
|
|
||||||
<button class="btn btn-outline-secondary" type="button" (click)="createTag()">
|
<button class="btn btn-outline-secondary" type="button" (click)="createTag()">
|
||||||
<svg class="buttonicon" fill="currentColor">
|
<svg class="buttonicon" fill="currentColor">
|
||||||
<use xlink:href="assets/bootstrap-icons.svg#plus" />
|
<use xlink:href="assets/bootstrap-icons.svg#plus" />
|
||||||
</svg>
|
</svg>
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<small class="form-text text-muted" *ngIf="hint">{{hint}}</small>
|
<small class="form-text text-muted" *ngIf="hint">{{hint}}</small>
|
||||||
|
|
||||||
|
|||||||
@ -1,10 +1,12 @@
|
|||||||
.tags-form-control {
|
.selected-icon {
|
||||||
height: auto;
|
min-width: 1em;
|
||||||
|
min-height: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.tag-wrap {
|
||||||
.scrollable-menu {
|
font-size: 1rem;
|
||||||
height: auto;
|
}
|
||||||
max-height: 300px;
|
|
||||||
overflow-x: hidden;
|
.tag-wrap-delete {
|
||||||
|
cursor: pointer;
|
||||||
}
|
}
|
||||||
@ -66,29 +66,28 @@ export class TagsComponent implements OnInit, ControlValueAccessor {
|
|||||||
removeTag(id) {
|
removeTag(id) {
|
||||||
let index = this.displayValue.indexOf(id)
|
let index = this.displayValue.indexOf(id)
|
||||||
if (index > -1) {
|
if (index > -1) {
|
||||||
this.displayValue.splice(index, 1)
|
let oldValue = this.displayValue
|
||||||
|
oldValue.splice(index, 1)
|
||||||
|
this.displayValue = [...oldValue]
|
||||||
this.onChange(this.displayValue)
|
this.onChange(this.displayValue)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
addTag(id) {
|
|
||||||
let index = this.displayValue.indexOf(id)
|
|
||||||
if (index == -1) {
|
|
||||||
this.displayValue.push(id)
|
|
||||||
this.onChange(this.displayValue)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
createTag() {
|
createTag() {
|
||||||
var modal = this.modalService.open(TagEditDialogComponent, {backdrop: 'static'})
|
var modal = this.modalService.open(TagEditDialogComponent, {backdrop: 'static'})
|
||||||
modal.componentInstance.dialogMode = 'create'
|
modal.componentInstance.dialogMode = 'create'
|
||||||
modal.componentInstance.success.subscribe(newTag => {
|
modal.componentInstance.success.subscribe(newTag => {
|
||||||
this.tagService.listAll().subscribe(tags => {
|
this.tagService.listAll().subscribe(tags => {
|
||||||
this.tags = tags.results
|
this.tags = tags.results
|
||||||
this.addTag(newTag.id)
|
this.displayValue = [...this.displayValue, newTag.id]
|
||||||
|
this.onChange(this.displayValue)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ngSelectChange() {
|
||||||
|
this.value = this.displayValue
|
||||||
|
this.onChange(this.displayValue)
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
<app-page-header title="Dashboard" subTitle="Welcome to paperless-ng!">
|
<app-page-header title="Dashboard" [subTitle]="subtitle">
|
||||||
<img src="assets/logo.svg" height="80" class="m-2 d-none d-md-block">
|
<img src="assets/logo.svg" height="80" class="m-2 d-none d-md-block">
|
||||||
</app-page-header>
|
</app-page-header>
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
import { Component, OnInit } from '@angular/core';
|
import { Component, OnInit } from '@angular/core';
|
||||||
|
import { Meta } from '@angular/platform-browser';
|
||||||
import { PaperlessSavedView } from 'src/app/data/paperless-saved-view';
|
import { PaperlessSavedView } from 'src/app/data/paperless-saved-view';
|
||||||
import { SavedViewService } from 'src/app/services/rest/saved-view.service';
|
import { SavedViewService } from 'src/app/services/rest/saved-view.service';
|
||||||
|
|
||||||
@ -11,8 +12,29 @@ import { SavedViewService } from 'src/app/services/rest/saved-view.service';
|
|||||||
export class DashboardComponent implements OnInit {
|
export class DashboardComponent implements OnInit {
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
private savedViewService: SavedViewService) { }
|
private savedViewService: SavedViewService,
|
||||||
|
private meta: Meta
|
||||||
|
) { }
|
||||||
|
|
||||||
|
get displayName() {
|
||||||
|
let tagFullName = this.meta.getTag('name=full_name')
|
||||||
|
let tagUsername = this.meta.getTag('name=username')
|
||||||
|
if (tagFullName && tagFullName.content) {
|
||||||
|
return tagFullName.content
|
||||||
|
} else if (tagUsername && tagUsername.content) {
|
||||||
|
return tagUsername.content
|
||||||
|
} else {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
get subtitle() {
|
||||||
|
if (this.displayName) {
|
||||||
|
return `Hello ${this.displayName}, welcome to Paperless-ng!`
|
||||||
|
} else {
|
||||||
|
return `Welcome to Paperless-ng!`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
savedViews: PaperlessSavedView[] = []
|
savedViews: PaperlessSavedView[] = []
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,14 @@
|
|||||||
<app-page-header [(title)]="title">
|
<app-page-header [(title)]="title">
|
||||||
|
<div class="input-group input-group-sm mr-5" *ngIf="getContentType() == 'application/pdf'">
|
||||||
|
<div class="input-group-prepend">
|
||||||
|
<div class="input-group-text">Page </div>
|
||||||
|
</div>
|
||||||
|
<input class="form-control flex-grow-0 w-auto" type="number" min="1" [max]="previewNumPages" [(ngModel)]="previewCurrentPage" />
|
||||||
|
<div class="input-group-append">
|
||||||
|
<div class="input-group-text">of {{previewNumPages}}</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
<button type="button" class="btn btn-sm btn-outline-danger mr-2" (click)="delete()">
|
<button type="button" class="btn btn-sm btn-outline-danger mr-2" (click)="delete()">
|
||||||
<svg class="buttonicon" fill="currentColor">
|
<svg class="buttonicon" fill="currentColor">
|
||||||
<use xlink:href="assets/bootstrap-icons.svg#trash" />
|
<use xlink:href="assets/bootstrap-icons.svg#trash" />
|
||||||
@ -24,6 +34,12 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-primary mr-2" (click)="moreLike()">
|
||||||
|
<svg class="buttonicon" fill="currentColor">
|
||||||
|
<use xlink:href="assets/bootstrap-icons.svg#three-dots" />
|
||||||
|
</svg>
|
||||||
|
<span class="d-none d-lg-inline"> More like this</span>
|
||||||
|
</button>
|
||||||
|
|
||||||
<button type="button" class="btn btn-sm btn-outline-primary" (click)="close()">
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="close()">
|
||||||
<svg class="buttonicon" fill="currentColor">
|
<svg class="buttonicon" fill="currentColor">
|
||||||
@ -52,9 +68,9 @@
|
|||||||
</div>
|
</div>
|
||||||
<app-input-date-time titleDate="Date created" formControlName="created"></app-input-date-time>
|
<app-input-date-time titleDate="Date created" formControlName="created"></app-input-date-time>
|
||||||
<app-input-select [items]="correspondents" title="Correspondent" formControlName="correspondent"
|
<app-input-select [items]="correspondents" title="Correspondent" formControlName="correspondent"
|
||||||
allowNull="true" (createNew)="createCorrespondent()"></app-input-select>
|
(createNew)="createCorrespondent()"></app-input-select>
|
||||||
<app-input-select [items]="documentTypes" title="Document type" formControlName="document_type"
|
<app-input-select [items]="documentTypes" title="Document type" formControlName="document_type"
|
||||||
allowNull="true" (createNew)="createDocumentType()"></app-input-select>
|
(createNew)="createDocumentType()"></app-input-select>
|
||||||
<app-input-tags formControlName="tags" title="Tags"></app-input-tags>
|
<app-input-tags formControlName="tags" title="Tags"></app-input-tags>
|
||||||
|
|
||||||
</ng-template>
|
</ng-template>
|
||||||
@ -128,7 +144,7 @@
|
|||||||
|
|
||||||
<div class="col-md-6 col-xl-8 mb-3">
|
<div class="col-md-6 col-xl-8 mb-3">
|
||||||
<div class="pdf-viewer-container" *ngIf="getContentType() == 'application/pdf'">
|
<div class="pdf-viewer-container" *ngIf="getContentType() == 'application/pdf'">
|
||||||
<pdf-viewer [src]="previewUrl" [original-size]="false" [show-borders]="true"></pdf-viewer>
|
<pdf-viewer [src]="previewUrl" [original-size]="false" [show-borders]="true" [show-all]="true" [(page)]="previewCurrentPage" (after-load-complete)="pdfPreviewLoaded($event)"></pdf-viewer>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -15,6 +15,7 @@ import { DocumentService } from 'src/app/services/rest/document.service';
|
|||||||
import { ConfirmDialogComponent } from '../common/confirm-dialog/confirm-dialog.component';
|
import { ConfirmDialogComponent } from '../common/confirm-dialog/confirm-dialog.component';
|
||||||
import { CorrespondentEditDialogComponent } from '../manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component';
|
import { CorrespondentEditDialogComponent } from '../manage/correspondent-list/correspondent-edit-dialog/correspondent-edit-dialog.component';
|
||||||
import { DocumentTypeEditDialogComponent } from '../manage/document-type-list/document-type-edit-dialog/document-type-edit-dialog.component';
|
import { DocumentTypeEditDialogComponent } from '../manage/document-type-list/document-type-edit-dialog/document-type-edit-dialog.component';
|
||||||
|
import { PDFDocumentProxy } from 'ng2-pdf-viewer';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'app-document-detail',
|
selector: 'app-document-detail',
|
||||||
@ -47,6 +48,9 @@ export class DocumentDetailComponent implements OnInit {
|
|||||||
tags: new FormControl([])
|
tags: new FormControl([])
|
||||||
})
|
})
|
||||||
|
|
||||||
|
previewCurrentPage: number = 1
|
||||||
|
previewNumPages: number = 1
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
private documentsService: DocumentService,
|
private documentsService: DocumentService,
|
||||||
private route: ActivatedRoute,
|
private route: ActivatedRoute,
|
||||||
@ -168,7 +172,16 @@ export class DocumentDetailComponent implements OnInit {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
moreLike() {
|
||||||
|
this.router.navigate(["search"], {queryParams: {more_like:this.document.id}})
|
||||||
|
}
|
||||||
|
|
||||||
hasNext() {
|
hasNext() {
|
||||||
return this.documentListViewService.hasNext(this.documentId)
|
return this.documentListViewService.hasNext(this.documentId)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pdfPreviewLoaded(pdf: PDFDocumentProxy) {
|
||||||
|
this.previewNumPages = pdf.numPages
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -23,8 +23,14 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<div class="d-flex justify-content-between align-items-center">
|
<div class="d-flex align-items-center">
|
||||||
<div class="btn-group">
|
<div class="btn-group">
|
||||||
|
<a routerLink="/search" [queryParams]="{'more_like': document.id}" class="btn btn-sm btn-outline-secondary" *ngIf="moreLikeThis">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-three-dots" viewBox="0 0 16 16">
|
||||||
|
<path fill-rule="evenodd" d="M3 9.5a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3zm5 0a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3zm5 0a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3z"/>
|
||||||
|
</svg>
|
||||||
|
More like this
|
||||||
|
</a>
|
||||||
<a routerLink="/documents/{{document.id}}" class="btn btn-sm btn-outline-secondary">
|
<a routerLink="/documents/{{document.id}}" class="btn btn-sm btn-outline-secondary">
|
||||||
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-pencil" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-pencil" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||||
<path fill-rule="evenodd" d="M12.146.146a.5.5 0 0 1 .708 0l3 3a.5.5 0 0 1 0 .708l-10 10a.5.5 0 0 1-.168.11l-5 2a.5.5 0 0 1-.65-.65l2-5a.5.5 0 0 1 .11-.168l10-10zM11.207 2.5L13.5 4.793 14.793 3.5 12.5 1.207 11.207 2.5zm1.586 3L10.5 3.207 4 9.707V10h.5a.5.5 0 0 1 .5.5v.5h.5a.5.5 0 0 1 .5.5v.5h.293l6.5-6.5zm-9.761 5.175l-.106.106-1.528 3.821 3.821-1.528.106-.106A.5.5 0 0 1 5 12.5V12h-.5a.5.5 0 0 1-.5-.5V11h-.5a.5.5 0 0 1-.468-.325z"/>
|
<path fill-rule="evenodd" d="M12.146.146a.5.5 0 0 1 .708 0l3 3a.5.5 0 0 1 0 .708l-10 10a.5.5 0 0 1-.168.11l-5 2a.5.5 0 0 1-.65-.65l2-5a.5.5 0 0 1 .11-.168l10-10zM11.207 2.5L13.5 4.793 14.793 3.5 12.5 1.207 11.207 2.5zm1.586 3L10.5 3.207 4 9.707V10h.5a.5.5 0 0 1 .5.5v.5h.5a.5.5 0 0 1 .5.5v.5h.293l6.5-6.5zm-9.761 5.175l-.106.106-1.528 3.821 3.821-1.528.106-.106A.5.5 0 0 1 5 12.5V12h-.5a.5.5 0 0 1-.5-.5V11h-.5a.5.5 0 0 1-.468-.325z"/>
|
||||||
@ -45,7 +51,13 @@
|
|||||||
</svg>
|
</svg>
|
||||||
Download
|
Download
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<small class="text-muted ml-auto">Score:</small>
|
||||||
|
|
||||||
|
<ngb-progressbar *ngIf="searchScore" [type]="searchScoreClass" [value]="searchScore" class="search-score-bar mx-2" [max]="1"></ngb-progressbar>
|
||||||
|
|
||||||
<small class="text-muted">Created: {{document.created | date}}</small>
|
<small class="text-muted">Created: {{document.created | date}}</small>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
@ -10,3 +10,9 @@
|
|||||||
position: absolute;
|
position: absolute;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.search-score-bar {
|
||||||
|
width: 100px;
|
||||||
|
height: 5px;
|
||||||
|
margin-top: 2px;
|
||||||
|
}
|
||||||
@ -12,6 +12,9 @@ export class DocumentCardLargeComponent implements OnInit {
|
|||||||
|
|
||||||
constructor(private documentService: DocumentService, private sanitizer: DomSanitizer) { }
|
constructor(private documentService: DocumentService, private sanitizer: DomSanitizer) { }
|
||||||
|
|
||||||
|
@Input()
|
||||||
|
moreLikeThis: boolean = false
|
||||||
|
|
||||||
@Input()
|
@Input()
|
||||||
document: PaperlessDocument
|
document: PaperlessDocument
|
||||||
|
|
||||||
@ -24,6 +27,19 @@ export class DocumentCardLargeComponent implements OnInit {
|
|||||||
@Output()
|
@Output()
|
||||||
clickCorrespondent = new EventEmitter<number>()
|
clickCorrespondent = new EventEmitter<number>()
|
||||||
|
|
||||||
|
@Input()
|
||||||
|
searchScore: number
|
||||||
|
|
||||||
|
get searchScoreClass() {
|
||||||
|
if (this.searchScore > 0.7) {
|
||||||
|
return "success"
|
||||||
|
} else if (this.searchScore > 0.3) {
|
||||||
|
return "warning"
|
||||||
|
} else {
|
||||||
|
return "danger"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
ngOnInit(): void {
|
ngOnInit(): void {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -4,38 +4,39 @@
|
|||||||
</button>
|
</button>
|
||||||
<div class="dropdown-menu date-filter shadow pt-0" ngbDropdownMenu attr.aria-labelledby="dropdown{{title}}">
|
<div class="dropdown-menu date-filter shadow pt-0" ngbDropdownMenu attr.aria-labelledby="dropdown{{title}}">
|
||||||
<div class="list-group list-group-flush">
|
<div class="list-group list-group-flush">
|
||||||
<button class="list-group-item small list-goup list-group-item-action d-flex p-2 pl-3" (click)="clear()">Clear</button>
|
<button *ngFor="let qf of quickFilters" class="list-group-item small list-goup list-group-item-action d-flex p-2 pl-3" role="menuitem" (click)="setDateQuickFilter(qf.id)">
|
||||||
<button *ngFor="let range of [7, 30, 'month', 'year']" class="list-group-item small list-goup list-group-item-action d-flex p-2 pl-3" role="menuitem" (click)="setDateQuickFilter(range)">
|
{{qf.name}}
|
||||||
<ng-container *ngIf="isStringRange(range)">This </ng-container>
|
|
||||||
{{ range }}
|
|
||||||
<ng-container *ngIf="!isStringRange(range)"> days</ng-container>
|
|
||||||
</button>
|
</button>
|
||||||
<div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
|
<div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
|
||||||
<div>Before</div>
|
|
||||||
|
<div class="mb-2 d-flex flex-row w-100 justify-content-between small">
|
||||||
|
<div>After</div>
|
||||||
|
<a *ngIf="dateAfter" class="btn btn-link p-0 m-0" (click)="clearAfter()">
|
||||||
|
<svg width="0.8em" height="0.8em" viewBox="0 0 16 16" class="bi bi-x" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<path fill-rule="evenodd" d="M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z" />
|
||||||
|
</svg>
|
||||||
|
<small>Clear</small>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div class="input-group input-group-sm">
|
<div class="input-group input-group-sm">
|
||||||
<input class="form-control" type="text" placeholder="yyyy-mm-dd" name="before" [(ngModel)]="_dateBefore" [maxDate]="this._maxDate" ngbDatepicker (dateSelect)="onBeforeSelected($event)" #dpBefore="ngbDatepicker">
|
<input type="date" class="form-control" id="date_after" [(ngModel)]="dateAfter" (change)="onChangeDebounce()">
|
||||||
<div class="input-group-append">
|
|
||||||
<button class="btn btn-outline-secondary btn-sm" (click)="dpBefore.toggle()" type="button">
|
|
||||||
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-calendar-date" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<path fill-rule="evenodd" d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
|
|
||||||
<path d="M6.445 11.688V6.354h-.633A12.6 12.6 0 0 0 4.5 7.16v.695c.375-.257.969-.62 1.258-.777h.012v4.61h.675zm1.188-1.305c.047.64.594 1.406 1.703 1.406 1.258 0 2-1.066 2-2.871 0-1.934-.781-2.668-1.953-2.668-.926 0-1.797.672-1.797 1.809 0 1.16.824 1.77 1.676 1.77.746 0 1.23-.376 1.383-.79h.027c-.004 1.316-.461 2.164-1.305 2.164-.664 0-1.008-.45-1.05-.82h-.684zm2.953-2.317c0 .696-.559 1.18-1.184 1.18-.601 0-1.144-.383-1.144-1.2 0-.823.582-1.21 1.168-1.21.633 0 1.16.398 1.16 1.23z"/>
|
|
||||||
</svg>
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
|
<div class="list-group-item d-flex flex-column align-items-start" role="menuitem">
|
||||||
<div>After</div>
|
|
||||||
|
<div class="mb-2 d-flex flex-row w-100 justify-content-between small">
|
||||||
|
<div>Before</div>
|
||||||
|
<a *ngIf="dateBefore" class="btn btn-link p-0 m-0" (click)="clearBefore()">
|
||||||
|
<svg width="0.8em" height="0.8em" viewBox="0 0 16 16" class="bi bi-x" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<path fill-rule="evenodd" d="M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z" />
|
||||||
|
</svg>
|
||||||
|
<small>Clear</small>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div class="input-group input-group-sm">
|
<div class="input-group input-group-sm">
|
||||||
<input class="form-control form-control-sm" type="text" placeholder="yyyy-mm-dd" name="after" [(ngModel)]="_dateAfter" [maxDate]="this._maxDate" ngbDatepicker (dateSelect)="onAfterSelected($event)" #dpAfter="ngbDatepicker">
|
<input type="date" class="form-control" id="date_before" [(ngModel)]="dateBefore" (change)="onChangeDebounce()">
|
||||||
<div class="input-group-append">
|
|
||||||
<button class="btn btn-outline-secondary btn-sm" (click)="dpAfter.toggle()" type="button">
|
|
||||||
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-calendar-date" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
|
|
||||||
<path fill-rule="evenodd" d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
|
|
||||||
<path d="M6.445 11.688V6.354h-.633A12.6 12.6 0 0 0 4.5 7.16v.695c.375-.257.969-.62 1.258-.777h.012v4.61h.675zm1.188-1.305c.047.64.594 1.406 1.703 1.406 1.258 0 2-1.066 2-2.871 0-1.934-.781-2.668-1.953-2.668-.926 0-1.797.672-1.797 1.809 0 1.16.824 1.77 1.676 1.77.746 0 1.23-.376 1.383-.79h.027c-.004 1.316-.461 2.164-1.305 2.164-.664 0-1.008-.45-1.05-.82h-.684zm2.953-2.317c0 .696-.559 1.18-1.184 1.18-.601 0-1.144-.383-1.144-1.2 0-.823.582-1.21 1.168-1.21.633 0 1.16.398 1.16 1.23z"/>
|
|
||||||
</svg>
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -1,24 +1,37 @@
|
|||||||
import { Component, EventEmitter, Input, Output, ElementRef, ViewChild, SimpleChange } from '@angular/core';
|
import { formatDate } from '@angular/common';
|
||||||
import { NgbDate, NgbDateStruct, NgbDatepicker } from '@ng-bootstrap/ng-bootstrap';
|
import { Component, EventEmitter, Input, Output, OnInit, OnDestroy } from '@angular/core';
|
||||||
|
import { Subject, Subscription } from 'rxjs';
|
||||||
|
import { debounceTime, distinctUntilChanged } from 'rxjs/operators';
|
||||||
|
|
||||||
export interface DateSelection {
|
export interface DateSelection {
|
||||||
before?: NgbDateStruct
|
before?: string
|
||||||
after?: NgbDateStruct
|
after?: string
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const FILTER_LAST_7_DAYS = 0
|
||||||
|
const FILTER_LAST_MONTH = 1
|
||||||
|
const FILTER_LAST_3_MONTHS = 2
|
||||||
|
const FILTER_LAST_YEAR = 3
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'app-filter-dropdown-date',
|
selector: 'app-filter-dropdown-date',
|
||||||
templateUrl: './filter-dropdown-date.component.html',
|
templateUrl: './filter-dropdown-date.component.html',
|
||||||
styleUrls: ['./filter-dropdown-date.component.scss']
|
styleUrls: ['./filter-dropdown-date.component.scss']
|
||||||
})
|
})
|
||||||
export class FilterDropdownDateComponent {
|
export class FilterDropdownDateComponent implements OnInit, OnDestroy {
|
||||||
|
|
||||||
|
quickFilters = [
|
||||||
|
{id: FILTER_LAST_7_DAYS, name: "Last 7 days"},
|
||||||
|
{id: FILTER_LAST_MONTH, name: "Last month"},
|
||||||
|
{id: FILTER_LAST_3_MONTHS, name: "Last 3 months"},
|
||||||
|
{id: FILTER_LAST_YEAR, name: "Last year"}
|
||||||
|
]
|
||||||
|
|
||||||
@Input()
|
@Input()
|
||||||
dateBefore: NgbDateStruct
|
dateBefore: string
|
||||||
|
|
||||||
@Input()
|
@Input()
|
||||||
dateAfter: NgbDateStruct
|
dateAfter: string
|
||||||
|
|
||||||
@Input()
|
@Input()
|
||||||
title: string
|
title: string
|
||||||
@ -26,87 +39,65 @@ export class FilterDropdownDateComponent {
|
|||||||
@Output()
|
@Output()
|
||||||
datesSet = new EventEmitter<DateSelection>()
|
datesSet = new EventEmitter<DateSelection>()
|
||||||
|
|
||||||
@ViewChild('dpAfter') dpAfter: NgbDatepicker
|
private datesSetDebounce$ = new Subject()
|
||||||
@ViewChild('dpBefore') dpBefore: NgbDatepicker
|
|
||||||
|
|
||||||
_dateBefore: NgbDateStruct
|
private sub: Subscription
|
||||||
_dateAfter: NgbDateStruct
|
|
||||||
|
|
||||||
get _maxDate(): NgbDate {
|
ngOnInit() {
|
||||||
let date = new Date()
|
this.sub = this.datesSetDebounce$.pipe(
|
||||||
return NgbDate.from({year: date.getFullYear(), month: date.getMonth() + 1, day: date.getDate()})
|
debounceTime(400)
|
||||||
|
).subscribe(() => {
|
||||||
|
this.onChange()
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
isStringRange(range: any) {
|
ngOnDestroy() {
|
||||||
return typeof range == 'string'
|
if (this.sub) {
|
||||||
}
|
this.sub.unsubscribe()
|
||||||
|
|
||||||
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) {
|
setDateQuickFilter(qf: number) {
|
||||||
let dpAfterElRef: ElementRef = this.dpAfter['_elRef']
|
this.dateBefore = null
|
||||||
let dpBeforeElRef: ElementRef = this.dpBefore['_elRef']
|
let date = new Date()
|
||||||
|
switch (qf) {
|
||||||
|
case FILTER_LAST_7_DAYS:
|
||||||
|
date.setDate(date.getDate() - 7)
|
||||||
|
break;
|
||||||
|
|
||||||
|
case FILTER_LAST_MONTH:
|
||||||
|
date.setMonth(date.getMonth() - 1)
|
||||||
|
break;
|
||||||
|
|
||||||
|
case FILTER_LAST_3_MONTHS:
|
||||||
|
date.setMonth(date.getMonth() - 3)
|
||||||
|
break
|
||||||
|
|
||||||
|
case FILTER_LAST_YEAR:
|
||||||
|
date.setFullYear(date.getFullYear() - 1)
|
||||||
|
break
|
||||||
|
|
||||||
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
|
|
||||||
}
|
}
|
||||||
}
|
this.dateAfter = formatDate(date, 'yyyy-MM-dd', "en-us", "UTC")
|
||||||
|
this.onChange()
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateQuickFilter(range: any) {
|
onChange() {
|
||||||
let date = new Date()
|
this.datesSet.emit({after: this.dateAfter, before: this.dateBefore})
|
||||||
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) {
|
onChangeDebounce() {
|
||||||
this._dateBefore = date
|
this.datesSetDebounce$.next({after: this.dateAfter, before: this.dateBefore})
|
||||||
this.datesSet.emit({after: this._dateAfter, before: date})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
onAfterSelected(date: NgbDateStruct) {
|
clearBefore() {
|
||||||
this._dateAfter = date
|
this.dateBefore = null;
|
||||||
this.datesSet.emit({after: date, before: this._dateBefore})
|
this.onChange()
|
||||||
}
|
}
|
||||||
|
|
||||||
clear() {
|
clearAfter() {
|
||||||
this._dateBefore = null
|
this.dateAfter = null;
|
||||||
this._dateAfter = null
|
this.onChange()
|
||||||
this.datesSet.emit({after: null, before: null})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -179,54 +179,53 @@ export class FilterEditorComponent implements OnInit, OnDestroy {
|
|||||||
this.applyFilters()
|
this.applyFilters()
|
||||||
}
|
}
|
||||||
|
|
||||||
get dateCreatedBefore(): NgbDateStruct {
|
get dateCreatedBefore(): string {
|
||||||
let createdBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_BEFORE)
|
let createdBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_BEFORE)
|
||||||
return createdBeforeRule ? this.dateParser.parse(createdBeforeRule.value) : null
|
return createdBeforeRule ? createdBeforeRule.value : null
|
||||||
}
|
}
|
||||||
|
|
||||||
get dateCreatedAfter(): NgbDateStruct {
|
get dateCreatedAfter(): string {
|
||||||
let createdAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_AFTER)
|
let createdAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_CREATED_AFTER)
|
||||||
return createdAfterRule ? this.dateParser.parse(createdAfterRule.value) : null
|
return createdAfterRule ? createdAfterRule.value : null
|
||||||
}
|
}
|
||||||
|
|
||||||
get dateAddedBefore(): NgbDateStruct {
|
get dateAddedBefore(): string {
|
||||||
let addedBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_BEFORE)
|
let addedBeforeRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_BEFORE)
|
||||||
return addedBeforeRule ? this.dateParser.parse(addedBeforeRule.value) : null
|
return addedBeforeRule ? addedBeforeRule.value : null
|
||||||
}
|
}
|
||||||
|
|
||||||
get dateAddedAfter(): NgbDateStruct {
|
get dateAddedAfter(): string {
|
||||||
let addedAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_AFTER)
|
let addedAfterRule: FilterRule = this.filterRules.find(fr => fr.rule_type == FILTER_ADDED_AFTER)
|
||||||
return addedAfterRule ? this.dateParser.parse(addedAfterRule.value) : null
|
return addedAfterRule ? addedAfterRule.value : null
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateCreatedBefore(date?: NgbDateStruct) {
|
setDateCreatedBefore(date?: string) {
|
||||||
if (date) this.setDateFilter(date, FILTER_CREATED_BEFORE)
|
if (date) this.setDateFilter(date, FILTER_CREATED_BEFORE)
|
||||||
else this.clearDateFilter(FILTER_CREATED_BEFORE)
|
else this.clearDateFilter(FILTER_CREATED_BEFORE)
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateCreatedAfter(date?: NgbDateStruct) {
|
setDateCreatedAfter(date?: string) {
|
||||||
if (date) this.setDateFilter(date, FILTER_CREATED_AFTER)
|
if (date) this.setDateFilter(date, FILTER_CREATED_AFTER)
|
||||||
else this.clearDateFilter(FILTER_CREATED_AFTER)
|
else this.clearDateFilter(FILTER_CREATED_AFTER)
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateAddedBefore(date?: NgbDateStruct) {
|
setDateAddedBefore(date?: string) {
|
||||||
if (date) this.setDateFilter(date, FILTER_ADDED_BEFORE)
|
if (date) this.setDateFilter(date, FILTER_ADDED_BEFORE)
|
||||||
else this.clearDateFilter(FILTER_ADDED_BEFORE)
|
else this.clearDateFilter(FILTER_ADDED_BEFORE)
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateAddedAfter(date?: NgbDateStruct) {
|
setDateAddedAfter(date?: string) {
|
||||||
if (date) this.setDateFilter(date, FILTER_ADDED_AFTER)
|
if (date) this.setDateFilter(date, FILTER_ADDED_AFTER)
|
||||||
else this.clearDateFilter(FILTER_ADDED_AFTER)
|
else this.clearDateFilter(FILTER_ADDED_AFTER)
|
||||||
}
|
}
|
||||||
|
|
||||||
setDateFilter(date: NgbDateStruct, dateRuleTypeID: number) {
|
setDateFilter(date: string, dateRuleTypeID: number) {
|
||||||
let existingRule = this.filterRules.find(rule => rule.rule_type == dateRuleTypeID)
|
let existingRule = this.filterRules.find(rule => rule.rule_type == dateRuleTypeID)
|
||||||
let newValue = this.dateParser.format(date)
|
|
||||||
|
|
||||||
if (existingRule) {
|
if (existingRule) {
|
||||||
existingRule.value = newValue
|
existingRule.value = date
|
||||||
} else {
|
} else {
|
||||||
this.filterRules.push({rule_type: dateRuleTypeID, value: newValue})
|
this.filterRules.push({rule_type: dateRuleTypeID, value: date})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -8,10 +8,9 @@
|
|||||||
<div class="modal-body">
|
<div class="modal-body">
|
||||||
|
|
||||||
<app-input-text title="Name" formControlName="name"></app-input-text>
|
<app-input-text title="Name" formControlName="name"></app-input-text>
|
||||||
<app-input-text title="Match" formControlName="match"></app-input-text>
|
|
||||||
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
||||||
<app-input-check title="Case insensitive" formControlName="is_insensitive"></app-input-check>
|
<app-input-text title="Match" formControlName="match" hint="Auto matching does not require you to fill in this field."></app-input-text>
|
||||||
|
<app-input-check title="Case insensitive" formControlName="is_insensitive" hint="Auto matching ignores this option."></app-input-check>
|
||||||
</div>
|
</div>
|
||||||
<div class="modal-footer">
|
<div class="modal-footer">
|
||||||
<button type="button" class="btn btn-outline-dark" (click)="cancel()">Cancel</button>
|
<button type="button" class="btn btn-outline-dark" (click)="cancel()">Cancel</button>
|
||||||
|
|||||||
@ -8,9 +8,9 @@
|
|||||||
<div class="modal-body">
|
<div class="modal-body">
|
||||||
|
|
||||||
<app-input-text title="Name" formControlName="name"></app-input-text>
|
<app-input-text title="Name" formControlName="name"></app-input-text>
|
||||||
<app-input-text title="Match" formControlName="match"></app-input-text>
|
|
||||||
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
||||||
<app-input-check title="Case insensitive" formControlName="is_insensitive"></app-input-check>
|
<app-input-text title="Match" formControlName="match" hint="Auto matching does not require you to fill in this field."></app-input-text>
|
||||||
|
<app-input-check title="Case insensitive" formControlName="is_insensitive" hint="Auto matching ignores this option."></app-input-check>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div class="modal-footer">
|
<div class="modal-footer">
|
||||||
|
|||||||
@ -7,11 +7,21 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="modal-body">
|
<div class="modal-body">
|
||||||
<app-input-text title="Name" formControlName="name"></app-input-text>
|
<app-input-text title="Name" formControlName="name"></app-input-text>
|
||||||
<app-input-select title="Colour" [items]="getColours()" formControlName="colour" [textColor]="getColor(objectForm.value.colour).textColor" [backgroundColor]="getColor(objectForm.value.colour).value"></app-input-select>
|
|
||||||
|
|
||||||
|
<div class="form-group paperless-input-select">
|
||||||
|
<label for="colour">Colour</label>
|
||||||
|
<ng-select name="colour" formControlName="colour" [items]="getColours()" bindValue="id" bindLabel="name" [clearable]="false">
|
||||||
|
<ng-template ng-option-tmp ng-label-tmp let-item="item">
|
||||||
|
<span class="badge" [style.background]="item.value" [style.color]="item.textColor">{{item.name}}</span>
|
||||||
|
</ng-template>
|
||||||
|
</ng-select>
|
||||||
|
</div>
|
||||||
|
|
||||||
<app-input-check title="Inbox tag" formControlName="is_inbox_tag" hint="Inbox tags are automatically assigned to all consumed documents."></app-input-check>
|
<app-input-check title="Inbox tag" formControlName="is_inbox_tag" hint="Inbox tags are automatically assigned to all consumed documents."></app-input-check>
|
||||||
<app-input-text title="Match" formControlName="match"></app-input-text>
|
|
||||||
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
<app-input-select title="Matching algorithm" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></app-input-select>
|
||||||
<app-input-check title="Case insensitive" formControlName="is_insensitive"></app-input-check>
|
<app-input-text title="Match" formControlName="match" hint="Auto matching does not require you to fill in this field."></app-input-text>
|
||||||
|
<app-input-check title="Case insensitive" formControlName="is_insensitive" hint="Auto matching ignores this option."></app-input-check>
|
||||||
</div>
|
</div>
|
||||||
<div class="modal-footer">
|
<div class="modal-footer">
|
||||||
<button type="button" class="btn btn-outline-dark" (click)="cancel()">Cancel</button>
|
<button type="button" class="btn btn-outline-dark" (click)="cancel()">Cancel</button>
|
||||||
|
|||||||
@ -1,3 +1,3 @@
|
|||||||
... <span *ngFor="let fragment of highlights">
|
... <span *ngFor="let fragment of highlights">
|
||||||
<span *ngFor="let token of fragment" [ngClass]="token.term != null ? 'match term'+ token.term : ''">{{token.text}}</span> ...
|
<span *ngFor="let token of fragment" [class.match]="token.highlight">{{token.text}}</span> ...
|
||||||
</span>
|
</span>
|
||||||
@ -1,4 +1,4 @@
|
|||||||
.match {
|
.match {
|
||||||
color: black;
|
color: black;
|
||||||
background-color: orange;
|
background-color: rgb(255, 211, 66);
|
||||||
}
|
}
|
||||||
@ -3,7 +3,12 @@
|
|||||||
|
|
||||||
<div *ngIf="errorMessage" class="alert alert-danger">Invalid search query: {{errorMessage}}</div>
|
<div *ngIf="errorMessage" class="alert alert-danger">Invalid search query: {{errorMessage}}</div>
|
||||||
|
|
||||||
<p>
|
<p *ngIf="more_like">
|
||||||
|
Showing documents similar to
|
||||||
|
<a routerLink="/documents/{{more_like}}">{{more_like_doc?.original_file_name}}</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p *ngIf="query">
|
||||||
Search string: <i>{{query}}</i>
|
Search string: <i>{{query}}</i>
|
||||||
<ng-container *ngIf="correctedQuery">
|
<ng-container *ngIf="correctedQuery">
|
||||||
- Did you mean "<a [routerLink]="" (click)="searchCorrectedQuery()">{{correctedQuery}}</a>"?
|
- Did you mean "<a [routerLink]="" (click)="searchCorrectedQuery()">{{correctedQuery}}</a>"?
|
||||||
@ -15,7 +20,9 @@
|
|||||||
<p>{{resultCount}} result(s)</p>
|
<p>{{resultCount}} result(s)</p>
|
||||||
<app-document-card-large *ngFor="let result of results"
|
<app-document-card-large *ngFor="let result of results"
|
||||||
[document]="result.document"
|
[document]="result.document"
|
||||||
[details]="result.highlights">
|
[details]="result.highlights"
|
||||||
|
[searchScore]="result.score / maxScore"
|
||||||
|
[moreLikeThis]="true">
|
||||||
|
|
||||||
</app-document-card-large>
|
</app-document-card-large>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@ -1,6 +1,9 @@
|
|||||||
import { Component, OnInit } from '@angular/core';
|
import { Component, OnInit } from '@angular/core';
|
||||||
import { ActivatedRoute, Router } from '@angular/router';
|
import { ActivatedRoute, Router } from '@angular/router';
|
||||||
|
import { PaperlessDocument } from 'src/app/data/paperless-document';
|
||||||
|
import { PaperlessDocumentType } from 'src/app/data/paperless-document-type';
|
||||||
import { SearchHit } from 'src/app/data/search-result';
|
import { SearchHit } from 'src/app/data/search-result';
|
||||||
|
import { DocumentService } from 'src/app/services/rest/document.service';
|
||||||
import { SearchService } from 'src/app/services/rest/search.service';
|
import { SearchService } from 'src/app/services/rest/search.service';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
@ -14,6 +17,10 @@ export class SearchComponent implements OnInit {
|
|||||||
|
|
||||||
query: string = ""
|
query: string = ""
|
||||||
|
|
||||||
|
more_like: number
|
||||||
|
|
||||||
|
more_like_doc: PaperlessDocument
|
||||||
|
|
||||||
searching = false
|
searching = false
|
||||||
|
|
||||||
currentPage = 1
|
currentPage = 1
|
||||||
@ -26,11 +33,24 @@ export class SearchComponent implements OnInit {
|
|||||||
|
|
||||||
errorMessage: string
|
errorMessage: string
|
||||||
|
|
||||||
constructor(private searchService: SearchService, private route: ActivatedRoute, private router: Router) { }
|
get maxScore() {
|
||||||
|
return this.results?.length > 0 ? this.results[0].score : 100
|
||||||
|
}
|
||||||
|
|
||||||
|
constructor(private searchService: SearchService, private route: ActivatedRoute, private router: Router, private documentService: DocumentService) { }
|
||||||
|
|
||||||
ngOnInit(): void {
|
ngOnInit(): void {
|
||||||
this.route.queryParamMap.subscribe(paramMap => {
|
this.route.queryParamMap.subscribe(paramMap => {
|
||||||
|
window.scrollTo(0, 0)
|
||||||
this.query = paramMap.get('query')
|
this.query = paramMap.get('query')
|
||||||
|
this.more_like = paramMap.has('more_like') ? +paramMap.get('more_like') : null
|
||||||
|
if (this.more_like) {
|
||||||
|
this.documentService.get(this.more_like).subscribe(r => {
|
||||||
|
this.more_like_doc = r
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
this.more_like_doc = null
|
||||||
|
}
|
||||||
this.searching = true
|
this.searching = true
|
||||||
this.currentPage = 1
|
this.currentPage = 1
|
||||||
this.loadPage()
|
this.loadPage()
|
||||||
@ -39,13 +59,14 @@ export class SearchComponent implements OnInit {
|
|||||||
}
|
}
|
||||||
|
|
||||||
searchCorrectedQuery() {
|
searchCorrectedQuery() {
|
||||||
this.router.navigate(["search"], {queryParams: {query: this.correctedQuery}})
|
this.router.navigate(["search"], {queryParams: {query: this.correctedQuery, more_like: this.more_like}})
|
||||||
}
|
}
|
||||||
|
|
||||||
loadPage(append: boolean = false) {
|
loadPage(append: boolean = false) {
|
||||||
this.errorMessage = null
|
this.errorMessage = null
|
||||||
this.correctedQuery = null
|
this.correctedQuery = null
|
||||||
this.searchService.search(this.query, this.currentPage).subscribe(result => {
|
|
||||||
|
this.searchService.search(this.query, this.currentPage, this.more_like).subscribe(result => {
|
||||||
if (append) {
|
if (append) {
|
||||||
this.results.push(...result.results)
|
this.results.push(...result.results)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@ -6,14 +6,14 @@ export const TAG_COLOURS = [
|
|||||||
{id: 1, value: "#a6cee3", name: "Light Blue", textColor: "#000000"},
|
{id: 1, value: "#a6cee3", name: "Light Blue", textColor: "#000000"},
|
||||||
{id: 2, value: "#1f78b4", name: "Blue", textColor: "#ffffff"},
|
{id: 2, value: "#1f78b4", name: "Blue", textColor: "#ffffff"},
|
||||||
{id: 3, value: "#b2df8a", name: "Light Green", textColor: "#000000"},
|
{id: 3, value: "#b2df8a", name: "Light Green", textColor: "#000000"},
|
||||||
{id: 4, value: "#33a02c", name: "Green", textColor: "#000000"},
|
{id: 4, value: "#33a02c", name: "Green", textColor: "#ffffff"},
|
||||||
{id: 5, value: "#fb9a99", name: "Light Red", textColor: "#000000"},
|
{id: 5, value: "#fb9a99", name: "Light Red", textColor: "#000000"},
|
||||||
{id: 6, value: "#e31a1c", name: "Red ", textColor: "#ffffff"},
|
{id: 6, value: "#e31a1c", name: "Red ", textColor: "#ffffff"},
|
||||||
{id: 7, value: "#fdbf6f", name: "Light Orange", textColor: "#000000"},
|
{id: 7, value: "#fdbf6f", name: "Light Orange", textColor: "#000000"},
|
||||||
{id: 8, value: "#ff7f00", name: "Orange", textColor: "#000000"},
|
{id: 8, value: "#ff7f00", name: "Orange", textColor: "#000000"},
|
||||||
{id: 9, value: "#cab2d6", name: "Light Violet", textColor: "#000000"},
|
{id: 9, value: "#cab2d6", name: "Light Violet", textColor: "#000000"},
|
||||||
{id: 10, value: "#6a3d9a", name: "Violet", textColor: "#ffffff"},
|
{id: 10, value: "#6a3d9a", name: "Violet", textColor: "#ffffff"},
|
||||||
{id: 11, value: "#b15928", name: "Brown", textColor: "#000000"},
|
{id: 11, value: "#b15928", name: "Brown", textColor: "#ffffff"},
|
||||||
{id: 12, value: "#000000", name: "Black", textColor: "#ffffff"},
|
{id: 12, value: "#000000", name: "Black", textColor: "#ffffff"},
|
||||||
{id: 13, value: "#cccccc", name: "Light Grey", textColor: "#000000"}
|
{id: 13, value: "#cccccc", name: "Light Grey", textColor: "#000000"}
|
||||||
]
|
]
|
||||||
|
|||||||
@ -15,11 +15,17 @@ export class SearchService {
|
|||||||
|
|
||||||
constructor(private http: HttpClient, private documentService: DocumentService) { }
|
constructor(private http: HttpClient, private documentService: DocumentService) { }
|
||||||
|
|
||||||
search(query: string, page?: number): Observable<SearchResult> {
|
search(query: string, page?: number, more_like?: number): Observable<SearchResult> {
|
||||||
let httpParams = new HttpParams().set('query', query)
|
let httpParams = new HttpParams()
|
||||||
|
if (query) {
|
||||||
|
httpParams = httpParams.set('query', query)
|
||||||
|
}
|
||||||
if (page) {
|
if (page) {
|
||||||
httpParams = httpParams.set('page', page.toString())
|
httpParams = httpParams.set('page', page.toString())
|
||||||
}
|
}
|
||||||
|
if (more_like) {
|
||||||
|
httpParams = httpParams.set('more_like', more_like.toString())
|
||||||
|
}
|
||||||
return this.http.get<SearchResult>(`${environment.apiBaseUrl}search/`, {params: httpParams}).pipe(
|
return this.http.get<SearchResult>(`${environment.apiBaseUrl}search/`, {params: httpParams}).pipe(
|
||||||
map(result => {
|
map(result => {
|
||||||
result.results.forEach(hit => this.documentService.addObservablesToDocument(hit.document))
|
result.results.forEach(hit => this.documentService.addObservablesToDocument(hit.document))
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
@import "theme";
|
@import "theme";
|
||||||
|
|
||||||
@import "node_modules/bootstrap/scss/bootstrap";
|
@import "node_modules/bootstrap/scss/bootstrap";
|
||||||
|
@import "~@ng-select/ng-select/themes/default.theme.css";
|
||||||
|
|
||||||
.toolbaricon {
|
.toolbaricon {
|
||||||
width: 1.2em;
|
width: 1.2em;
|
||||||
@ -20,7 +19,7 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
font-size: .875rem;
|
font-size: 0.875rem;
|
||||||
}
|
}
|
||||||
|
|
||||||
.form-control-dark {
|
.form-control-dark {
|
||||||
@ -66,3 +65,38 @@ body {
|
|||||||
background-size: 1rem;
|
background-size: 1rem;
|
||||||
float: right;
|
float: right;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.paperless-input-select {
|
||||||
|
.ng-select {
|
||||||
|
position: relative;
|
||||||
|
flex: 1 1 auto;
|
||||||
|
margin-bottom: 0;
|
||||||
|
min-height: calc(1.5em + 0.75rem + 5px);
|
||||||
|
line-height: 1.5;
|
||||||
|
|
||||||
|
.ng-select-container {
|
||||||
|
height: 100%;
|
||||||
|
border-top-right-radius: 0;
|
||||||
|
border-bottom-right-radius: 0;
|
||||||
|
|
||||||
|
.ng-value-container .ng-input {
|
||||||
|
top: 10px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.ng-dropdown-panel .ng-dropdown-panel-items .ng-option.ng-option-selected,
|
||||||
|
.ng-dropdown-panel .ng-dropdown-panel-items .ng-option.ng-option-selected.ng-option-marked {
|
||||||
|
background: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.paperless-input-tags {
|
||||||
|
.ng-select.ng-select-multiple .ng-select-container .ng-value-container .ng-value {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ng-select.ng-select-multiple .ng-select-container .ng-value-container {
|
||||||
|
padding-top: 1px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@ -247,7 +247,6 @@ class Consumer(LoggingMixin):
|
|||||||
|
|
||||||
with open(self.path, "rb") as f:
|
with open(self.path, "rb") as f:
|
||||||
document = Document.objects.create(
|
document = Document.objects.create(
|
||||||
correspondent=file_info.correspondent,
|
|
||||||
title=(self.override_title or file_info.title)[:127],
|
title=(self.override_title or file_info.title)[:127],
|
||||||
content=text,
|
content=text,
|
||||||
mime_type=mime_type,
|
mime_type=mime_type,
|
||||||
@ -257,12 +256,6 @@ class Consumer(LoggingMixin):
|
|||||||
storage_type=storage_type
|
storage_type=storage_type
|
||||||
)
|
)
|
||||||
|
|
||||||
relevant_tags = set(file_info.tags)
|
|
||||||
if relevant_tags:
|
|
||||||
tag_names = ", ".join([t.name for t in relevant_tags])
|
|
||||||
self.log("debug", "Tagging with {}".format(tag_names))
|
|
||||||
document.tags.add(*relevant_tags)
|
|
||||||
|
|
||||||
self.apply_overrides(document)
|
self.apply_overrides(document)
|
||||||
|
|
||||||
document.save()
|
document.save()
|
||||||
|
|||||||
@ -3,7 +3,7 @@ import os
|
|||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from whoosh import highlight
|
from whoosh import highlight, classify, query
|
||||||
from whoosh.fields import Schema, TEXT, NUMERIC, KEYWORD, DATETIME
|
from whoosh.fields import Schema, TEXT, NUMERIC, KEYWORD, DATETIME
|
||||||
from whoosh.highlight import Formatter, get_text
|
from whoosh.highlight import Formatter, get_text
|
||||||
from whoosh.index import create_in, exists_in, open_dir
|
from whoosh.index import create_in, exists_in, open_dir
|
||||||
@ -20,32 +20,37 @@ class JsonFormatter(Formatter):
|
|||||||
self.seen = {}
|
self.seen = {}
|
||||||
|
|
||||||
def format_token(self, text, token, replace=False):
|
def format_token(self, text, token, replace=False):
|
||||||
seen = self.seen
|
|
||||||
ttext = self._text(get_text(text, token, replace))
|
ttext = self._text(get_text(text, token, replace))
|
||||||
if ttext in seen:
|
return {'text': ttext, 'highlight': 'true'}
|
||||||
termnum = seen[ttext]
|
|
||||||
else:
|
|
||||||
termnum = len(seen)
|
|
||||||
seen[ttext] = termnum
|
|
||||||
|
|
||||||
return {'text': ttext, 'term': termnum}
|
|
||||||
|
|
||||||
def format_fragment(self, fragment, replace=False):
|
def format_fragment(self, fragment, replace=False):
|
||||||
output = []
|
output = []
|
||||||
index = fragment.startchar
|
index = fragment.startchar
|
||||||
text = fragment.text
|
text = fragment.text
|
||||||
|
amend_token = None
|
||||||
for t in fragment.matches:
|
for t in fragment.matches:
|
||||||
if t.startchar is None:
|
if t.startchar is None:
|
||||||
continue
|
continue
|
||||||
if t.startchar < index:
|
if t.startchar < index:
|
||||||
continue
|
continue
|
||||||
if t.startchar > index:
|
if t.startchar > index:
|
||||||
output.append({'text': text[index:t.startchar]})
|
text_inbetween = text[index:t.startchar]
|
||||||
output.append(self.format_token(text, t, replace))
|
if amend_token and t.startchar - index < 10:
|
||||||
|
amend_token['text'] += text_inbetween
|
||||||
|
else:
|
||||||
|
output.append({'text': text_inbetween,
|
||||||
|
'highlight': False})
|
||||||
|
amend_token = None
|
||||||
|
token = self.format_token(text, t, replace)
|
||||||
|
if amend_token:
|
||||||
|
amend_token['text'] += token['text']
|
||||||
|
else:
|
||||||
|
output.append(token)
|
||||||
|
amend_token = token
|
||||||
index = t.endchar
|
index = t.endchar
|
||||||
if index < fragment.endchar:
|
if index < fragment.endchar:
|
||||||
output.append({'text': text[index:fragment.endchar]})
|
output.append({'text': text[index:fragment.endchar],
|
||||||
|
'highlight': False})
|
||||||
return output
|
return output
|
||||||
|
|
||||||
def format(self, fragments, replace=False):
|
def format(self, fragments, replace=False):
|
||||||
@ -120,22 +125,42 @@ def remove_document_from_index(document):
|
|||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def query_page(ix, querystring, page):
|
def query_page(ix, page, querystring, more_like_doc_id, more_like_doc_content):
|
||||||
searcher = ix.searcher()
|
searcher = ix.searcher()
|
||||||
try:
|
try:
|
||||||
qp = MultifieldParser(
|
if querystring:
|
||||||
["content", "title", "correspondent", "tag", "type"],
|
qp = MultifieldParser(
|
||||||
ix.schema)
|
["content", "title", "correspondent", "tag", "type"],
|
||||||
qp.add_plugin(DateParserPlugin())
|
ix.schema)
|
||||||
|
qp.add_plugin(DateParserPlugin())
|
||||||
|
str_q = qp.parse(querystring)
|
||||||
|
corrected = searcher.correct_query(str_q, querystring)
|
||||||
|
else:
|
||||||
|
str_q = None
|
||||||
|
corrected = None
|
||||||
|
|
||||||
|
if more_like_doc_id:
|
||||||
|
docnum = searcher.document_number(id=more_like_doc_id)
|
||||||
|
kts = searcher.key_terms_from_text(
|
||||||
|
'content', more_like_doc_content, numterms=20,
|
||||||
|
model=classify.Bo1Model, normalize=False)
|
||||||
|
more_like_q = query.Or(
|
||||||
|
[query.Term('content', word, boost=weight)
|
||||||
|
for word, weight in kts])
|
||||||
|
result_page = searcher.search_page(
|
||||||
|
more_like_q, page, filter=str_q, mask={docnum})
|
||||||
|
elif str_q:
|
||||||
|
result_page = searcher.search_page(str_q, page)
|
||||||
|
else:
|
||||||
|
raise ValueError(
|
||||||
|
"Either querystring or more_like_doc_id is required."
|
||||||
|
)
|
||||||
|
|
||||||
q = qp.parse(querystring)
|
|
||||||
result_page = searcher.search_page(q, page)
|
|
||||||
result_page.results.fragmenter = highlight.ContextFragmenter(
|
result_page.results.fragmenter = highlight.ContextFragmenter(
|
||||||
surround=50)
|
surround=50)
|
||||||
result_page.results.formatter = JsonFormatter()
|
result_page.results.formatter = JsonFormatter()
|
||||||
|
|
||||||
corrected = searcher.correct_query(q, querystring)
|
if corrected and corrected.query != str_q:
|
||||||
if corrected.query != q:
|
|
||||||
corrected_query = corrected.string
|
corrected_query = corrected.string
|
||||||
else:
|
else:
|
||||||
corrected_query = None
|
corrected_query = None
|
||||||
|
|||||||
@ -1,18 +1,29 @@
|
|||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
|
from contextlib import contextmanager
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.core.management import call_command
|
from django.core.management import call_command
|
||||||
from django.core.management.base import BaseCommand, CommandError
|
from django.core.management.base import BaseCommand, CommandError
|
||||||
|
from django.db.models.signals import post_save, m2m_changed
|
||||||
from filelock import FileLock
|
from filelock import FileLock
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.settings import EXPORTER_FILE_NAME, EXPORTER_THUMBNAIL_NAME, \
|
from documents.settings import EXPORTER_FILE_NAME, EXPORTER_THUMBNAIL_NAME, \
|
||||||
EXPORTER_ARCHIVE_NAME
|
EXPORTER_ARCHIVE_NAME
|
||||||
from ...file_handling import create_source_path_directory, \
|
from ...file_handling import create_source_path_directory
|
||||||
generate_unique_filename
|
|
||||||
from ...mixins import Renderable
|
from ...mixins import Renderable
|
||||||
|
from ...signals.handlers import update_filename_and_move_files
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def disable_signal(sig, receiver, sender):
|
||||||
|
try:
|
||||||
|
sig.disconnect(receiver=receiver, sender=sender)
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
sig.connect(receiver=receiver, sender=sender)
|
||||||
|
|
||||||
|
|
||||||
class Command(Renderable, BaseCommand):
|
class Command(Renderable, BaseCommand):
|
||||||
@ -47,11 +58,16 @@ class Command(Renderable, BaseCommand):
|
|||||||
self.manifest = json.load(f)
|
self.manifest = json.load(f)
|
||||||
|
|
||||||
self._check_manifest()
|
self._check_manifest()
|
||||||
|
with disable_signal(post_save,
|
||||||
|
receiver=update_filename_and_move_files,
|
||||||
|
sender=Document):
|
||||||
|
with disable_signal(m2m_changed,
|
||||||
|
receiver=update_filename_and_move_files,
|
||||||
|
sender=Document.tags.through):
|
||||||
|
# Fill up the database with whatever is in the manifest
|
||||||
|
call_command("loaddata", manifest_path)
|
||||||
|
|
||||||
# Fill up the database with whatever is in the manifest
|
self._import_files_from_manifest()
|
||||||
call_command("loaddata", manifest_path)
|
|
||||||
|
|
||||||
self._import_files_from_manifest()
|
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _check_manifest_exists(path):
|
def _check_manifest_exists(path):
|
||||||
@ -117,9 +133,6 @@ class Command(Renderable, BaseCommand):
|
|||||||
document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
|
document.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
|
||||||
|
|
||||||
with FileLock(settings.MEDIA_LOCK):
|
with FileLock(settings.MEDIA_LOCK):
|
||||||
document.filename = generate_unique_filename(
|
|
||||||
document, settings.ORIGINALS_DIR)
|
|
||||||
|
|
||||||
if os.path.isfile(document.source_path):
|
if os.path.isfile(document.source_path):
|
||||||
raise FileExistsError(document.source_path)
|
raise FileExistsError(document.source_path)
|
||||||
|
|
||||||
|
|||||||
@ -11,6 +11,7 @@ from paperless.db import GnuPG
|
|||||||
STORAGE_TYPE_UNENCRYPTED = "unencrypted"
|
STORAGE_TYPE_UNENCRYPTED = "unencrypted"
|
||||||
STORAGE_TYPE_GPG = "gpg"
|
STORAGE_TYPE_GPG = "gpg"
|
||||||
|
|
||||||
|
|
||||||
def source_path(self):
|
def source_path(self):
|
||||||
if self.filename:
|
if self.filename:
|
||||||
fname = str(self.filename)
|
fname = str(self.filename)
|
||||||
|
|||||||
@ -357,54 +357,12 @@ class SavedViewFilterRule(models.Model):
|
|||||||
# TODO: why is this in the models file?
|
# TODO: why is this in the models file?
|
||||||
class FileInfo:
|
class FileInfo:
|
||||||
|
|
||||||
# This epic regex *almost* worked for our needs, so I'm keeping it here for
|
|
||||||
# posterity, in the hopes that we might find a way to make it work one day.
|
|
||||||
ALMOST_REGEX = re.compile(
|
|
||||||
r"^((?P<date>\d\d\d\d\d\d\d\d\d\d\d\d\d\dZ){separator})?"
|
|
||||||
r"((?P<correspondent>{non_separated_word}+){separator})??"
|
|
||||||
r"(?P<title>{non_separated_word}+)"
|
|
||||||
r"({separator}(?P<tags>[a-z,0-9-]+))?"
|
|
||||||
r"\.(?P<extension>[a-zA-Z.-]+)$".format(
|
|
||||||
separator=r"\s+-\s+",
|
|
||||||
non_separated_word=r"([\w,. ]|([^\s]-))"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
REGEXES = OrderedDict([
|
REGEXES = OrderedDict([
|
||||||
("created-correspondent-title-tags", re.compile(
|
|
||||||
r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
|
|
||||||
r"(?P<correspondent>.*) - "
|
|
||||||
r"(?P<title>.*) - "
|
|
||||||
r"(?P<tags>[a-z0-9\-,]*)$",
|
|
||||||
flags=re.IGNORECASE
|
|
||||||
)),
|
|
||||||
("created-title-tags", re.compile(
|
|
||||||
r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
|
|
||||||
r"(?P<title>.*) - "
|
|
||||||
r"(?P<tags>[a-z0-9\-,]*)$",
|
|
||||||
flags=re.IGNORECASE
|
|
||||||
)),
|
|
||||||
("created-correspondent-title", re.compile(
|
|
||||||
r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
|
|
||||||
r"(?P<correspondent>.*) - "
|
|
||||||
r"(?P<title>.*)$",
|
|
||||||
flags=re.IGNORECASE
|
|
||||||
)),
|
|
||||||
("created-title", re.compile(
|
("created-title", re.compile(
|
||||||
r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
|
r"^(?P<created>\d\d\d\d\d\d\d\d(\d\d\d\d\d\d)?Z) - "
|
||||||
r"(?P<title>.*)$",
|
r"(?P<title>.*)$",
|
||||||
flags=re.IGNORECASE
|
flags=re.IGNORECASE
|
||||||
)),
|
)),
|
||||||
("correspondent-title-tags", re.compile(
|
|
||||||
r"(?P<correspondent>.*) - "
|
|
||||||
r"(?P<title>.*) - "
|
|
||||||
r"(?P<tags>[a-z0-9\-,]*)$",
|
|
||||||
flags=re.IGNORECASE
|
|
||||||
)),
|
|
||||||
("correspondent-title", re.compile(
|
|
||||||
r"(?P<correspondent>.*) - "
|
|
||||||
r"(?P<title>.*)?$",
|
|
||||||
flags=re.IGNORECASE
|
|
||||||
)),
|
|
||||||
("title", re.compile(
|
("title", re.compile(
|
||||||
r"(?P<title>.*)$",
|
r"(?P<title>.*)$",
|
||||||
flags=re.IGNORECASE
|
flags=re.IGNORECASE
|
||||||
@ -427,23 +385,10 @@ class FileInfo:
|
|||||||
except ValueError:
|
except ValueError:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def _get_correspondent(cls, name):
|
|
||||||
if not name:
|
|
||||||
return None
|
|
||||||
return Correspondent.objects.get_or_create(name=name)[0]
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _get_title(cls, title):
|
def _get_title(cls, title):
|
||||||
return title
|
return title
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def _get_tags(cls, tags):
|
|
||||||
r = []
|
|
||||||
for t in tags.split(","):
|
|
||||||
r.append(Tag.objects.get_or_create(name=t)[0])
|
|
||||||
return tuple(r)
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _mangle_property(cls, properties, name):
|
def _mangle_property(cls, properties, name):
|
||||||
if name in properties:
|
if name in properties:
|
||||||
@ -453,15 +398,6 @@ class FileInfo:
|
|||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def from_filename(cls, filename):
|
def from_filename(cls, filename):
|
||||||
"""
|
|
||||||
We use a crude naming convention to make handling the correspondent,
|
|
||||||
title, and tags easier:
|
|
||||||
"<date> - <correspondent> - <title> - <tags>"
|
|
||||||
"<correspondent> - <title> - <tags>"
|
|
||||||
"<correspondent> - <title>"
|
|
||||||
"<title>"
|
|
||||||
"""
|
|
||||||
|
|
||||||
# Mutate filename in-place before parsing its components
|
# Mutate filename in-place before parsing its components
|
||||||
# by applying at most one of the configured transformations.
|
# by applying at most one of the configured transformations.
|
||||||
for (pattern, repl) in settings.FILENAME_PARSE_TRANSFORMS:
|
for (pattern, repl) in settings.FILENAME_PARSE_TRANSFORMS:
|
||||||
@ -492,7 +428,5 @@ class FileInfo:
|
|||||||
if m:
|
if m:
|
||||||
properties = m.groupdict()
|
properties = m.groupdict()
|
||||||
cls._mangle_property(properties, "created")
|
cls._mangle_property(properties, "created")
|
||||||
cls._mangle_property(properties, "correspondent")
|
|
||||||
cls._mangle_property(properties, "title")
|
cls._mangle_property(properties, "title")
|
||||||
cls._mangle_property(properties, "tags")
|
|
||||||
return cls(**properties)
|
return cls(**properties)
|
||||||
|
|||||||
@ -5,9 +5,11 @@
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<title>PaperlessUi</title>
|
<title>Paperless-ng</title>
|
||||||
<base href="/">
|
<base href="/">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<meta name="username" content="{{username}}">
|
||||||
|
<meta name="full_name" content="{{full_name}}">
|
||||||
<meta name="cookie_prefix" content="{{cookie_prefix}}">
|
<meta name="cookie_prefix" content="{{cookie_prefix}}">
|
||||||
<link rel="icon" type="image/x-icon" href="favicon.ico">
|
<link rel="icon" type="image/x-icon" href="favicon.ico">
|
||||||
<link rel="stylesheet" href="{% static 'frontend/styles.css' %}"></head>
|
<link rel="stylesheet" href="{% static 'frontend/styles.css' %}"></head>
|
||||||
|
|||||||
57
src/documents/tests/test_admin.py
Normal file
57
src/documents/tests/test_admin.py
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
from django.contrib.admin.sites import AdminSite
|
||||||
|
from django.test import TestCase
|
||||||
|
from django.utils import timezone
|
||||||
|
|
||||||
|
from documents.admin import DocumentAdmin
|
||||||
|
from documents.models import Document, Tag
|
||||||
|
|
||||||
|
|
||||||
|
class TestDocumentAdmin(TestCase):
|
||||||
|
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self.doc_admin = DocumentAdmin(model=Document, admin_site=AdminSite())
|
||||||
|
|
||||||
|
@mock.patch("documents.admin.index.add_or_update_document")
|
||||||
|
def test_save_model(self, m):
|
||||||
|
doc = Document.objects.create(title="test")
|
||||||
|
doc.title = "new title"
|
||||||
|
self.doc_admin.save_model(None, doc, None, None)
|
||||||
|
self.assertEqual(Document.objects.get(id=doc.id).title, "new title")
|
||||||
|
m.assert_called_once()
|
||||||
|
|
||||||
|
def test_tags(self):
|
||||||
|
doc = Document.objects.create(title="test")
|
||||||
|
doc.tags.create(name="t1")
|
||||||
|
doc.tags.create(name="t2")
|
||||||
|
|
||||||
|
self.assertEqual(self.doc_admin.tags_(doc), "<span >t1, </span><span >t2, </span>")
|
||||||
|
|
||||||
|
def test_tags_empty(self):
|
||||||
|
doc = Document.objects.create(title="test")
|
||||||
|
|
||||||
|
self.assertEqual(self.doc_admin.tags_(doc), "")
|
||||||
|
|
||||||
|
@mock.patch("documents.admin.index.remove_document")
|
||||||
|
def test_delete_model(self, m):
|
||||||
|
doc = Document.objects.create(title="test")
|
||||||
|
self.doc_admin.delete_model(None, doc)
|
||||||
|
self.assertRaises(Document.DoesNotExist, Document.objects.get, id=doc.id)
|
||||||
|
m.assert_called_once()
|
||||||
|
|
||||||
|
@mock.patch("documents.admin.index.remove_document")
|
||||||
|
def test_delete_queryset(self, m):
|
||||||
|
for i in range(42):
|
||||||
|
Document.objects.create(title="Many documents with the same title", checksum=f"{i:02}")
|
||||||
|
|
||||||
|
self.assertEqual(Document.objects.count(), 42)
|
||||||
|
|
||||||
|
self.doc_admin.delete_queryset(None, Document.objects.all())
|
||||||
|
|
||||||
|
self.assertEqual(m.call_count, 42)
|
||||||
|
self.assertEqual(Document.objects.count(), 0)
|
||||||
|
|
||||||
|
def test_created(self):
|
||||||
|
doc = Document.objects.create(title="test", created=timezone.datetime(2020, 4, 12))
|
||||||
|
self.assertEqual(self.doc_admin.created_(doc), "2020-04-12")
|
||||||
@ -352,6 +352,25 @@ class TestDocumentApi(DirectoriesMixin, APITestCase):
|
|||||||
|
|
||||||
self.assertEqual(correction, None)
|
self.assertEqual(correction, None)
|
||||||
|
|
||||||
|
def test_search_more_like(self):
|
||||||
|
d1=Document.objects.create(title="invoice", content="the thing i bought at a shop and paid with bank account", checksum="A", pk=1)
|
||||||
|
d2=Document.objects.create(title="bank statement 1", content="things i paid for in august", pk=2, checksum="B")
|
||||||
|
d3=Document.objects.create(title="bank statement 3", content="things i paid for in september", pk=3, checksum="C")
|
||||||
|
with AsyncWriter(index.open_index()) as writer:
|
||||||
|
index.update_document(writer, d1)
|
||||||
|
index.update_document(writer, d2)
|
||||||
|
index.update_document(writer, d3)
|
||||||
|
|
||||||
|
response = self.client.get(f"/api/search/?more_like={d2.id}")
|
||||||
|
|
||||||
|
self.assertEqual(response.status_code, 200)
|
||||||
|
|
||||||
|
results = response.data['results']
|
||||||
|
|
||||||
|
self.assertEqual(len(results), 2)
|
||||||
|
self.assertEqual(results[0]['id'], d3.id)
|
||||||
|
self.assertEqual(results[1]['id'], d1.id)
|
||||||
|
|
||||||
def test_statistics(self):
|
def test_statistics(self):
|
||||||
|
|
||||||
doc1 = Document.objects.create(title="none1", checksum="A")
|
doc1 = Document.objects.create(title="none1", checksum="A")
|
||||||
|
|||||||
@ -29,81 +29,6 @@ class TestAttributes(TestCase):
|
|||||||
|
|
||||||
self.assertEqual(tuple([t.name for t in file_info.tags]), tags, filename)
|
self.assertEqual(tuple([t.name for t in file_info.tags]), tags, filename)
|
||||||
|
|
||||||
def test_guess_attributes_from_name0(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Title.pdf", "Sender", "Title", ())
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name1(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Spaced Sender - Title.pdf", "Spaced Sender", "Title", ())
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name2(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Spaced Title.pdf", "Sender", "Spaced Title", ())
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name3(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Dashed-Sender - Title.pdf", "Dashed-Sender", "Title", ())
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name4(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Dashed-Title.pdf", "Sender", "Dashed-Title", ())
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name5(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Title - tag1,tag2,tag3.pdf",
|
|
||||||
"Sender",
|
|
||||||
"Title",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name6(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Spaced Sender - Title - tag1,tag2,tag3.pdf",
|
|
||||||
"Spaced Sender",
|
|
||||||
"Title",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name7(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Spaced Title - tag1,tag2,tag3.pdf",
|
|
||||||
"Sender",
|
|
||||||
"Spaced Title",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name8(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Dashed-Sender - Title - tag1,tag2,tag3.pdf",
|
|
||||||
"Dashed-Sender",
|
|
||||||
"Title",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name9(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Sender - Dashed-Title - tag1,tag2,tag3.pdf",
|
|
||||||
"Sender",
|
|
||||||
"Dashed-Title",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name10(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
"Σενδερ - Τιτλε - tag1,tag2,tag3.pdf",
|
|
||||||
"Σενδερ",
|
|
||||||
"Τιτλε",
|
|
||||||
self.TAGS
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name_when_correspondent_empty(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
' - weird empty correspondent but should not break.pdf',
|
|
||||||
None,
|
|
||||||
'weird empty correspondent but should not break',
|
|
||||||
()
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_guess_attributes_from_name_when_title_starts_with_dash(self):
|
def test_guess_attributes_from_name_when_title_starts_with_dash(self):
|
||||||
self._test_guess_attributes_from_name(
|
self._test_guess_attributes_from_name(
|
||||||
@ -121,28 +46,6 @@ class TestAttributes(TestCase):
|
|||||||
()
|
()
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_guess_attributes_from_name_when_title_is_empty(self):
|
|
||||||
self._test_guess_attributes_from_name(
|
|
||||||
'weird correspondent but should not break - .pdf',
|
|
||||||
'weird correspondent but should not break',
|
|
||||||
'',
|
|
||||||
()
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_case_insensitive_tag_creation(self):
|
|
||||||
"""
|
|
||||||
Tags should be detected and created as lower case.
|
|
||||||
:return:
|
|
||||||
"""
|
|
||||||
|
|
||||||
filename = "Title - Correspondent - tAg1,TAG2.pdf"
|
|
||||||
self.assertEqual(len(FileInfo.from_filename(filename).tags), 2)
|
|
||||||
|
|
||||||
path = "Title - Correspondent - tag1,tag2.pdf"
|
|
||||||
self.assertEqual(len(FileInfo.from_filename(filename).tags), 2)
|
|
||||||
|
|
||||||
self.assertEqual(Tag.objects.all().count(), 2)
|
|
||||||
|
|
||||||
|
|
||||||
class TestFieldPermutations(TestCase):
|
class TestFieldPermutations(TestCase):
|
||||||
|
|
||||||
@ -199,69 +102,7 @@ class TestFieldPermutations(TestCase):
|
|||||||
filename = template.format(**spec)
|
filename = template.format(**spec)
|
||||||
self._test_guessed_attributes(filename, **spec)
|
self._test_guessed_attributes(filename, **spec)
|
||||||
|
|
||||||
def test_title_and_correspondent(self):
|
|
||||||
template = '{correspondent} - {title}.pdf'
|
|
||||||
for correspondent in self.valid_correspondents:
|
|
||||||
for title in self.valid_titles:
|
|
||||||
spec = dict(correspondent=correspondent, title=title)
|
|
||||||
filename = template.format(**spec)
|
|
||||||
self._test_guessed_attributes(filename, **spec)
|
|
||||||
|
|
||||||
def test_title_and_correspondent_and_tags(self):
|
|
||||||
template = '{correspondent} - {title} - {tags}.pdf'
|
|
||||||
for correspondent in self.valid_correspondents:
|
|
||||||
for title in self.valid_titles:
|
|
||||||
for tags in self.valid_tags:
|
|
||||||
spec = dict(correspondent=correspondent, title=title,
|
|
||||||
tags=tags)
|
|
||||||
filename = template.format(**spec)
|
|
||||||
self._test_guessed_attributes(filename, **spec)
|
|
||||||
|
|
||||||
def test_created_and_correspondent_and_title_and_tags(self):
|
|
||||||
|
|
||||||
template = (
|
|
||||||
"{created} - "
|
|
||||||
"{correspondent} - "
|
|
||||||
"{title} - "
|
|
||||||
"{tags}.pdf"
|
|
||||||
)
|
|
||||||
|
|
||||||
for created in self.valid_dates:
|
|
||||||
for correspondent in self.valid_correspondents:
|
|
||||||
for title in self.valid_titles:
|
|
||||||
for tags in self.valid_tags:
|
|
||||||
spec = {
|
|
||||||
"created": created,
|
|
||||||
"correspondent": correspondent,
|
|
||||||
"title": title,
|
|
||||||
"tags": tags,
|
|
||||||
}
|
|
||||||
self._test_guessed_attributes(
|
|
||||||
template.format(**spec), **spec)
|
|
||||||
|
|
||||||
def test_created_and_correspondent_and_title(self):
|
|
||||||
|
|
||||||
template = "{created} - {correspondent} - {title}.pdf"
|
|
||||||
|
|
||||||
for created in self.valid_dates:
|
|
||||||
for correspondent in self.valid_correspondents:
|
|
||||||
for title in self.valid_titles:
|
|
||||||
|
|
||||||
# Skip cases where title looks like a tag as we can't
|
|
||||||
# accommodate such cases.
|
|
||||||
if title.lower() == title:
|
|
||||||
continue
|
|
||||||
|
|
||||||
spec = {
|
|
||||||
"created": created,
|
|
||||||
"correspondent": correspondent,
|
|
||||||
"title": title
|
|
||||||
}
|
|
||||||
self._test_guessed_attributes(
|
|
||||||
template.format(**spec), **spec)
|
|
||||||
|
|
||||||
def test_created_and_title(self):
|
def test_created_and_title(self):
|
||||||
|
|
||||||
template = "{created} - {title}.pdf"
|
template = "{created} - {title}.pdf"
|
||||||
|
|
||||||
for created in self.valid_dates:
|
for created in self.valid_dates:
|
||||||
@ -273,21 +114,6 @@ class TestFieldPermutations(TestCase):
|
|||||||
self._test_guessed_attributes(
|
self._test_guessed_attributes(
|
||||||
template.format(**spec), **spec)
|
template.format(**spec), **spec)
|
||||||
|
|
||||||
def test_created_and_title_and_tags(self):
|
|
||||||
|
|
||||||
template = "{created} - {title} - {tags}.pdf"
|
|
||||||
|
|
||||||
for created in self.valid_dates:
|
|
||||||
for title in self.valid_titles:
|
|
||||||
for tags in self.valid_tags:
|
|
||||||
spec = {
|
|
||||||
"created": created,
|
|
||||||
"title": title,
|
|
||||||
"tags": tags
|
|
||||||
}
|
|
||||||
self._test_guessed_attributes(
|
|
||||||
template.format(**spec), **spec)
|
|
||||||
|
|
||||||
def test_invalid_date_format(self):
|
def test_invalid_date_format(self):
|
||||||
info = FileInfo.from_filename("06112017Z - title.pdf")
|
info = FileInfo.from_filename("06112017Z - title.pdf")
|
||||||
self.assertEqual(info.title, "title")
|
self.assertEqual(info.title, "title")
|
||||||
@ -336,32 +162,6 @@ class TestFieldPermutations(TestCase):
|
|||||||
info = FileInfo.from_filename(filename)
|
info = FileInfo.from_filename(filename)
|
||||||
self.assertEqual(info.title, "anotherall")
|
self.assertEqual(info.title, "anotherall")
|
||||||
|
|
||||||
# Complex transformation without date in replacement string
|
|
||||||
with self.settings(
|
|
||||||
FILENAME_PARSE_TRANSFORMS=[(exact_patt, repl1)]):
|
|
||||||
info = FileInfo.from_filename(filename)
|
|
||||||
self.assertEqual(info.title, "0001")
|
|
||||||
self.assertEqual(len(info.tags), 2)
|
|
||||||
self.assertEqual(info.tags[0].name, "tag1")
|
|
||||||
self.assertEqual(info.tags[1].name, "tag2")
|
|
||||||
self.assertIsNone(info.created)
|
|
||||||
|
|
||||||
# Complex transformation with date in replacement string
|
|
||||||
with self.settings(
|
|
||||||
FILENAME_PARSE_TRANSFORMS=[
|
|
||||||
(none_patt, "none.gif"),
|
|
||||||
(exact_patt, repl2), # <-- matches
|
|
||||||
(exact_patt, repl1),
|
|
||||||
(all_patt, "all.gif")]):
|
|
||||||
info = FileInfo.from_filename(filename)
|
|
||||||
self.assertEqual(info.title, "0001")
|
|
||||||
self.assertEqual(len(info.tags), 2)
|
|
||||||
self.assertEqual(info.tags[0].name, "tag1")
|
|
||||||
self.assertEqual(info.tags[1].name, "tag2")
|
|
||||||
self.assertEqual(info.created.year, 2019)
|
|
||||||
self.assertEqual(info.created.month, 9)
|
|
||||||
self.assertEqual(info.created.day, 8)
|
|
||||||
|
|
||||||
|
|
||||||
class DummyParser(DocumentParser):
|
class DummyParser(DocumentParser):
|
||||||
|
|
||||||
@ -476,15 +276,13 @@ class TestConsumer(DirectoriesMixin, TestCase):
|
|||||||
|
|
||||||
def testOverrideFilename(self):
|
def testOverrideFilename(self):
|
||||||
filename = self.get_test_file()
|
filename = self.get_test_file()
|
||||||
override_filename = "My Bank - Statement for November.pdf"
|
override_filename = "Statement for November.pdf"
|
||||||
|
|
||||||
document = self.consumer.try_consume_file(filename, override_filename=override_filename)
|
document = self.consumer.try_consume_file(filename, override_filename=override_filename)
|
||||||
|
|
||||||
self.assertEqual(document.correspondent.name, "My Bank")
|
|
||||||
self.assertEqual(document.title, "Statement for November")
|
self.assertEqual(document.title, "Statement for November")
|
||||||
|
|
||||||
def testOverrideTitle(self):
|
def testOverrideTitle(self):
|
||||||
|
|
||||||
document = self.consumer.try_consume_file(self.get_test_file(), override_title="Override Title")
|
document = self.consumer.try_consume_file(self.get_test_file(), override_title="Override Title")
|
||||||
self.assertEqual(document.title, "Override Title")
|
self.assertEqual(document.title, "Override Title")
|
||||||
|
|
||||||
@ -594,11 +392,10 @@ class TestConsumer(DirectoriesMixin, TestCase):
|
|||||||
def testFilenameHandling(self):
|
def testFilenameHandling(self):
|
||||||
filename = self.get_test_file()
|
filename = self.get_test_file()
|
||||||
|
|
||||||
document = self.consumer.try_consume_file(filename, override_filename="Bank - Test.pdf", override_title="new docs")
|
document = self.consumer.try_consume_file(filename, override_title="new docs")
|
||||||
|
|
||||||
self.assertEqual(document.title, "new docs")
|
self.assertEqual(document.title, "new docs")
|
||||||
self.assertEqual(document.correspondent.name, "Bank")
|
self.assertEqual(document.filename, "none/new docs.pdf")
|
||||||
self.assertEqual(document.filename, "Bank/new docs.pdf")
|
|
||||||
|
|
||||||
@override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}/{title}")
|
@override_settings(PAPERLESS_FILENAME_FORMAT="{correspondent}/{title}")
|
||||||
@mock.patch("documents.signals.handlers.generate_unique_filename")
|
@mock.patch("documents.signals.handlers.generate_unique_filename")
|
||||||
@ -617,10 +414,9 @@ class TestConsumer(DirectoriesMixin, TestCase):
|
|||||||
|
|
||||||
Tag.objects.create(name="test", is_inbox_tag=True)
|
Tag.objects.create(name="test", is_inbox_tag=True)
|
||||||
|
|
||||||
document = self.consumer.try_consume_file(filename, override_filename="Bank - Test.pdf", override_title="new docs")
|
document = self.consumer.try_consume_file(filename, override_title="new docs")
|
||||||
|
|
||||||
self.assertEqual(document.title, "new docs")
|
self.assertEqual(document.title, "new docs")
|
||||||
self.assertEqual(document.correspondent.name, "Bank")
|
|
||||||
self.assertIsNotNone(os.path.isfile(document.title))
|
self.assertIsNotNone(os.path.isfile(document.title))
|
||||||
self.assertTrue(os.path.isfile(document.source_path))
|
self.assertTrue(os.path.isfile(document.source_path))
|
||||||
|
|
||||||
@ -642,3 +438,31 @@ class TestConsumer(DirectoriesMixin, TestCase):
|
|||||||
self.assertEqual(document.document_type, dtype)
|
self.assertEqual(document.document_type, dtype)
|
||||||
self.assertIn(t1, document.tags.all())
|
self.assertIn(t1, document.tags.all())
|
||||||
self.assertNotIn(t2, document.tags.all())
|
self.assertNotIn(t2, document.tags.all())
|
||||||
|
|
||||||
|
@override_settings(CONSUMER_DELETE_DUPLICATES=True)
|
||||||
|
def test_delete_duplicate(self):
|
||||||
|
dst = self.get_test_file()
|
||||||
|
self.assertTrue(os.path.isfile(dst))
|
||||||
|
doc = self.consumer.try_consume_file(dst)
|
||||||
|
|
||||||
|
self.assertFalse(os.path.isfile(dst))
|
||||||
|
self.assertIsNotNone(doc)
|
||||||
|
|
||||||
|
dst = self.get_test_file()
|
||||||
|
self.assertTrue(os.path.isfile(dst))
|
||||||
|
self.assertRaises(ConsumerError, self.consumer.try_consume_file, dst)
|
||||||
|
self.assertFalse(os.path.isfile(dst))
|
||||||
|
|
||||||
|
@override_settings(CONSUMER_DELETE_DUPLICATES=False)
|
||||||
|
def test_no_delete_duplicate(self):
|
||||||
|
dst = self.get_test_file()
|
||||||
|
self.assertTrue(os.path.isfile(dst))
|
||||||
|
doc = self.consumer.try_consume_file(dst)
|
||||||
|
|
||||||
|
self.assertFalse(os.path.isfile(dst))
|
||||||
|
self.assertIsNotNone(doc)
|
||||||
|
|
||||||
|
dst = self.get_test_file()
|
||||||
|
self.assertTrue(os.path.isfile(dst))
|
||||||
|
self.assertRaises(ConsumerError, self.consumer.try_consume_file, dst)
|
||||||
|
self.assertTrue(os.path.isfile(dst))
|
||||||
|
|||||||
@ -14,7 +14,7 @@ from django.utils import timezone
|
|||||||
from .utils import DirectoriesMixin
|
from .utils import DirectoriesMixin
|
||||||
from ..file_handling import generate_filename, create_source_path_directory, delete_empty_directories, \
|
from ..file_handling import generate_filename, create_source_path_directory, delete_empty_directories, \
|
||||||
generate_unique_filename
|
generate_unique_filename
|
||||||
from ..models import Document, Correspondent, Tag
|
from ..models import Document, Correspondent, Tag, DocumentType
|
||||||
|
|
||||||
|
|
||||||
class TestFileHandling(DirectoriesMixin, TestCase):
|
class TestFileHandling(DirectoriesMixin, TestCase):
|
||||||
@ -190,6 +190,17 @@ class TestFileHandling(DirectoriesMixin, TestCase):
|
|||||||
self.assertEqual(os.path.isdir(settings.ORIGINALS_DIR + "/none"), True)
|
self.assertEqual(os.path.isdir(settings.ORIGINALS_DIR + "/none"), True)
|
||||||
self.assertTrue(os.path.isfile(important_file))
|
self.assertTrue(os.path.isfile(important_file))
|
||||||
|
|
||||||
|
@override_settings(PAPERLESS_FILENAME_FORMAT="{document_type} - {title}")
|
||||||
|
def test_document_type(self):
|
||||||
|
dt = DocumentType.objects.create(name="my_doc_type")
|
||||||
|
d = Document.objects.create(title="the_doc", mime_type="application/pdf")
|
||||||
|
|
||||||
|
self.assertEqual(generate_filename(d), "none - the_doc.pdf")
|
||||||
|
|
||||||
|
d.document_type = dt
|
||||||
|
|
||||||
|
self.assertEqual(generate_filename(d), "my_doc_type - the_doc.pdf")
|
||||||
|
|
||||||
@override_settings(PAPERLESS_FILENAME_FORMAT="{tags[type]}")
|
@override_settings(PAPERLESS_FILENAME_FORMAT="{tags[type]}")
|
||||||
def test_tags_with_underscore(self):
|
def test_tags_with_underscore(self):
|
||||||
document = Document()
|
document = Document()
|
||||||
|
|||||||
135
src/documents/tests/test_management.py
Normal file
135
src/documents/tests/test_management.py
Normal file
@ -0,0 +1,135 @@
|
|||||||
|
import hashlib
|
||||||
|
import tempfile
|
||||||
|
import filecmp
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
from django.test import TestCase, override_settings
|
||||||
|
|
||||||
|
|
||||||
|
from django.core.management import call_command
|
||||||
|
|
||||||
|
from documents.file_handling import generate_filename
|
||||||
|
from documents.management.commands.document_archiver import handle_document
|
||||||
|
from documents.models import Document
|
||||||
|
from documents.tests.utils import DirectoriesMixin
|
||||||
|
|
||||||
|
|
||||||
|
sample_file = os.path.join(os.path.dirname(__file__), "samples", "simple.pdf")
|
||||||
|
|
||||||
|
|
||||||
|
class TestArchiver(DirectoriesMixin, TestCase):
|
||||||
|
|
||||||
|
def make_models(self):
|
||||||
|
return Document.objects.create(checksum="A", title="A", content="first document", mime_type="application/pdf")
|
||||||
|
|
||||||
|
def test_archiver(self):
|
||||||
|
|
||||||
|
doc = self.make_models()
|
||||||
|
shutil.copy(sample_file, os.path.join(self.dirs.originals_dir, f"{doc.id:07}.pdf"))
|
||||||
|
|
||||||
|
call_command('document_archiver')
|
||||||
|
|
||||||
|
def test_handle_document(self):
|
||||||
|
|
||||||
|
doc = self.make_models()
|
||||||
|
shutil.copy(sample_file, os.path.join(self.dirs.originals_dir, f"{doc.id:07}.pdf"))
|
||||||
|
|
||||||
|
handle_document(doc.pk)
|
||||||
|
|
||||||
|
doc = Document.objects.get(id=doc.id)
|
||||||
|
|
||||||
|
self.assertIsNotNone(doc.checksum)
|
||||||
|
self.assertTrue(os.path.isfile(doc.archive_path))
|
||||||
|
self.assertTrue(os.path.isfile(doc.source_path))
|
||||||
|
self.assertTrue(filecmp.cmp(sample_file, doc.source_path))
|
||||||
|
|
||||||
|
|
||||||
|
class TestDecryptDocuments(TestCase):
|
||||||
|
|
||||||
|
@override_settings(
|
||||||
|
ORIGINALS_DIR=os.path.join(os.path.dirname(__file__), "samples", "originals"),
|
||||||
|
THUMBNAIL_DIR=os.path.join(os.path.dirname(__file__), "samples", "thumb"),
|
||||||
|
PASSPHRASE="test",
|
||||||
|
PAPERLESS_FILENAME_FORMAT=None
|
||||||
|
)
|
||||||
|
@mock.patch("documents.management.commands.decrypt_documents.input")
|
||||||
|
def test_decrypt(self, m):
|
||||||
|
|
||||||
|
media_dir = tempfile.mkdtemp()
|
||||||
|
originals_dir = os.path.join(media_dir, "documents", "originals")
|
||||||
|
thumb_dir = os.path.join(media_dir, "documents", "thumbnails")
|
||||||
|
os.makedirs(originals_dir, exist_ok=True)
|
||||||
|
os.makedirs(thumb_dir, exist_ok=True)
|
||||||
|
|
||||||
|
override_settings(
|
||||||
|
ORIGINALS_DIR=originals_dir,
|
||||||
|
THUMBNAIL_DIR=thumb_dir,
|
||||||
|
PASSPHRASE="test"
|
||||||
|
).enable()
|
||||||
|
|
||||||
|
doc = Document.objects.create(checksum="9c9691e51741c1f4f41a20896af31770", title="wow", filename="0000002.pdf.gpg", mime_type="application/pdf", storage_type=Document.STORAGE_TYPE_GPG)
|
||||||
|
|
||||||
|
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "originals", "0000002.pdf.gpg"), os.path.join(originals_dir, "0000002.pdf.gpg"))
|
||||||
|
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "thumbnails", f"0000002.png.gpg"), os.path.join(thumb_dir, f"{doc.id:07}.png.gpg"))
|
||||||
|
|
||||||
|
call_command('decrypt_documents')
|
||||||
|
|
||||||
|
doc.refresh_from_db()
|
||||||
|
|
||||||
|
self.assertEqual(doc.storage_type, Document.STORAGE_TYPE_UNENCRYPTED)
|
||||||
|
self.assertEqual(doc.filename, "0000002.pdf")
|
||||||
|
self.assertTrue(os.path.isfile(os.path.join(originals_dir, "0000002.pdf")))
|
||||||
|
self.assertTrue(os.path.isfile(doc.source_path))
|
||||||
|
self.assertTrue(os.path.isfile(os.path.join(thumb_dir, f"{doc.id:07}.png")))
|
||||||
|
self.assertTrue(os.path.isfile(doc.thumbnail_path))
|
||||||
|
|
||||||
|
with doc.source_file as f:
|
||||||
|
checksum = hashlib.md5(f.read()).hexdigest()
|
||||||
|
self.assertEqual(checksum, doc.checksum)
|
||||||
|
|
||||||
|
|
||||||
|
class TestMakeIndex(TestCase):
|
||||||
|
|
||||||
|
@mock.patch("documents.management.commands.document_index.index_reindex")
|
||||||
|
def test_reindex(self, m):
|
||||||
|
call_command("document_index", "reindex")
|
||||||
|
m.assert_called_once()
|
||||||
|
|
||||||
|
@mock.patch("documents.management.commands.document_index.index_optimize")
|
||||||
|
def test_optimize(self, m):
|
||||||
|
call_command("document_index", "optimize")
|
||||||
|
m.assert_called_once()
|
||||||
|
|
||||||
|
|
||||||
|
class TestRenamer(DirectoriesMixin, TestCase):
|
||||||
|
|
||||||
|
def test_rename(self):
|
||||||
|
doc = Document.objects.create(title="test", mime_type="application/pdf")
|
||||||
|
doc.filename = generate_filename(doc)
|
||||||
|
doc.save()
|
||||||
|
|
||||||
|
Path(doc.source_path).touch()
|
||||||
|
|
||||||
|
old_source_path = doc.source_path
|
||||||
|
|
||||||
|
with override_settings(PAPERLESS_FILENAME_FORMAT="{title}"):
|
||||||
|
call_command("document_renamer")
|
||||||
|
|
||||||
|
doc2 = Document.objects.get(id=doc.id)
|
||||||
|
|
||||||
|
self.assertEqual(doc2.filename, "test.pdf")
|
||||||
|
self.assertFalse(os.path.isfile(old_source_path))
|
||||||
|
self.assertFalse(os.path.isfile(doc.source_path))
|
||||||
|
self.assertTrue(os.path.isfile(doc2.source_path))
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreateClassifier(TestCase):
|
||||||
|
|
||||||
|
@mock.patch("documents.management.commands.document_create_classifier.train_classifier")
|
||||||
|
def test_create_classifier(self, m):
|
||||||
|
call_command("document_create_classifier")
|
||||||
|
|
||||||
|
m.assert_called_once()
|
||||||
@ -1,40 +0,0 @@
|
|||||||
import filecmp
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
|
|
||||||
from django.core.management import call_command
|
|
||||||
from django.test import TestCase
|
|
||||||
|
|
||||||
from documents.management.commands.document_archiver import handle_document
|
|
||||||
from documents.models import Document
|
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
|
|
||||||
|
|
||||||
sample_file = os.path.join(os.path.dirname(__file__), "samples", "simple.pdf")
|
|
||||||
|
|
||||||
|
|
||||||
class TestArchiver(DirectoriesMixin, TestCase):
|
|
||||||
|
|
||||||
def make_models(self):
|
|
||||||
return Document.objects.create(checksum="A", title="A", content="first document", mime_type="application/pdf")
|
|
||||||
|
|
||||||
def test_archiver(self):
|
|
||||||
|
|
||||||
doc = self.make_models()
|
|
||||||
shutil.copy(sample_file, os.path.join(self.dirs.originals_dir, f"{doc.id:07}.pdf"))
|
|
||||||
|
|
||||||
call_command('document_archiver')
|
|
||||||
|
|
||||||
def test_handle_document(self):
|
|
||||||
|
|
||||||
doc = self.make_models()
|
|
||||||
shutil.copy(sample_file, os.path.join(self.dirs.originals_dir, f"{doc.id:07}.pdf"))
|
|
||||||
|
|
||||||
handle_document(doc.pk)
|
|
||||||
|
|
||||||
doc = Document.objects.get(id=doc.id)
|
|
||||||
|
|
||||||
self.assertIsNotNone(doc.checksum)
|
|
||||||
self.assertTrue(os.path.isfile(doc.archive_path))
|
|
||||||
self.assertTrue(os.path.isfile(doc.source_path))
|
|
||||||
self.assertTrue(filecmp.cmp(sample_file, doc.source_path))
|
|
||||||
@ -1,57 +0,0 @@
|
|||||||
import hashlib
|
|
||||||
import json
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import tempfile
|
|
||||||
from unittest import mock
|
|
||||||
|
|
||||||
from django.core.management import call_command
|
|
||||||
from django.test import TestCase, override_settings
|
|
||||||
|
|
||||||
from documents.management.commands import document_exporter
|
|
||||||
from documents.models import Document, Tag, DocumentType, Correspondent
|
|
||||||
|
|
||||||
|
|
||||||
class TestDecryptDocuments(TestCase):
|
|
||||||
|
|
||||||
@override_settings(
|
|
||||||
ORIGINALS_DIR=os.path.join(os.path.dirname(__file__), "samples", "originals"),
|
|
||||||
THUMBNAIL_DIR=os.path.join(os.path.dirname(__file__), "samples", "thumb"),
|
|
||||||
PASSPHRASE="test",
|
|
||||||
PAPERLESS_FILENAME_FORMAT=None
|
|
||||||
)
|
|
||||||
@mock.patch("documents.management.commands.decrypt_documents.input")
|
|
||||||
def test_decrypt(self, m):
|
|
||||||
|
|
||||||
media_dir = tempfile.mkdtemp()
|
|
||||||
originals_dir = os.path.join(media_dir, "documents", "originals")
|
|
||||||
thumb_dir = os.path.join(media_dir, "documents", "thumbnails")
|
|
||||||
os.makedirs(originals_dir, exist_ok=True)
|
|
||||||
os.makedirs(thumb_dir, exist_ok=True)
|
|
||||||
|
|
||||||
override_settings(
|
|
||||||
ORIGINALS_DIR=originals_dir,
|
|
||||||
THUMBNAIL_DIR=thumb_dir,
|
|
||||||
PASSPHRASE="test"
|
|
||||||
).enable()
|
|
||||||
|
|
||||||
doc = Document.objects.create(checksum="9c9691e51741c1f4f41a20896af31770", title="wow", filename="0000002.pdf.gpg", mime_type="application/pdf", storage_type=Document.STORAGE_TYPE_GPG)
|
|
||||||
|
|
||||||
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "originals", "0000002.pdf.gpg"), os.path.join(originals_dir, "0000002.pdf.gpg"))
|
|
||||||
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "thumbnails", f"0000002.png.gpg"), os.path.join(thumb_dir, f"{doc.id:07}.png.gpg"))
|
|
||||||
|
|
||||||
call_command('decrypt_documents')
|
|
||||||
|
|
||||||
doc.refresh_from_db()
|
|
||||||
|
|
||||||
self.assertEqual(doc.storage_type, Document.STORAGE_TYPE_UNENCRYPTED)
|
|
||||||
self.assertEqual(doc.filename, "0000002.pdf")
|
|
||||||
self.assertTrue(os.path.isfile(os.path.join(originals_dir, "0000002.pdf")))
|
|
||||||
self.assertTrue(os.path.isfile(doc.source_path))
|
|
||||||
self.assertTrue(os.path.isfile(os.path.join(thumb_dir, f"{doc.id:07}.png")))
|
|
||||||
self.assertTrue(os.path.isfile(doc.thumbnail_path))
|
|
||||||
|
|
||||||
with doc.source_file as f:
|
|
||||||
checksum = hashlib.md5(f.read()).hexdigest()
|
|
||||||
self.assertEqual(checksum, doc.checksum)
|
|
||||||
|
|
||||||
@ -24,11 +24,17 @@ class TestExportImport(DirectoriesMixin, TestCase):
|
|||||||
|
|
||||||
file = os.path.join(self.dirs.originals_dir, "0000001.pdf")
|
file = os.path.join(self.dirs.originals_dir, "0000001.pdf")
|
||||||
|
|
||||||
Document.objects.create(content="Content", checksum="42995833e01aea9b3edee44bbfdd7ce1", archive_checksum="62acb0bcbfbcaa62ca6ad3668e4e404b", title="wow", filename="0000001.pdf", mime_type="application/pdf")
|
d1 = Document.objects.create(content="Content", checksum="42995833e01aea9b3edee44bbfdd7ce1", archive_checksum="62acb0bcbfbcaa62ca6ad3668e4e404b", title="wow", filename="0000001.pdf", mime_type="application/pdf")
|
||||||
Document.objects.create(content="Content", checksum="9c9691e51741c1f4f41a20896af31770", title="wow", filename="0000002.pdf.gpg", mime_type="application/pdf", storage_type=Document.STORAGE_TYPE_GPG)
|
d2 = Document.objects.create(content="Content", checksum="9c9691e51741c1f4f41a20896af31770", title="wow", filename="0000002.pdf.gpg", mime_type="application/pdf", storage_type=Document.STORAGE_TYPE_GPG)
|
||||||
Tag.objects.create(name="t")
|
t1 = Tag.objects.create(name="t")
|
||||||
DocumentType.objects.create(name="dt")
|
dt1 = DocumentType.objects.create(name="dt")
|
||||||
Correspondent.objects.create(name="c")
|
c1 = Correspondent.objects.create(name="c")
|
||||||
|
|
||||||
|
d1.tags.add(t1)
|
||||||
|
d1.correspondents = c1
|
||||||
|
d1.document_type = dt1
|
||||||
|
d1.save()
|
||||||
|
d2.save()
|
||||||
|
|
||||||
target = tempfile.mkdtemp()
|
target = tempfile.mkdtemp()
|
||||||
self.addCleanup(shutil.rmtree, target)
|
self.addCleanup(shutil.rmtree, target)
|
||||||
@ -59,11 +65,25 @@ class TestExportImport(DirectoriesMixin, TestCase):
|
|||||||
self.assertEqual(checksum, element['fields']['archive_checksum'])
|
self.assertEqual(checksum, element['fields']['archive_checksum'])
|
||||||
|
|
||||||
with paperless_environment() as dirs:
|
with paperless_environment() as dirs:
|
||||||
|
self.assertEqual(Document.objects.count(), 2)
|
||||||
|
Document.objects.all().delete()
|
||||||
|
Correspondent.objects.all().delete()
|
||||||
|
DocumentType.objects.all().delete()
|
||||||
|
Tag.objects.all().delete()
|
||||||
|
self.assertEqual(Document.objects.count(), 0)
|
||||||
|
|
||||||
call_command('document_importer', target)
|
call_command('document_importer', target)
|
||||||
|
self.assertEqual(Document.objects.count(), 2)
|
||||||
messages = check_sanity()
|
messages = check_sanity()
|
||||||
# everything is alright after the test
|
# everything is alright after the test
|
||||||
self.assertEqual(len(messages), 0, str([str(m) for m in messages]))
|
self.assertEqual(len(messages), 0, str([str(m) for m in messages]))
|
||||||
|
|
||||||
|
@override_settings(
|
||||||
|
PAPERLESS_FILENAME_FORMAT="{title}"
|
||||||
|
)
|
||||||
|
def test_exporter_with_filename_format(self):
|
||||||
|
self.test_exporter()
|
||||||
|
|
||||||
def test_export_missing_files(self):
|
def test_export_missing_files(self):
|
||||||
|
|
||||||
target = tempfile.mkdtemp()
|
target = tempfile.mkdtemp()
|
||||||
|
|||||||
129
src/documents/tests/test_migrations.py
Normal file
129
src/documents/tests/test_migrations.py
Normal file
@ -0,0 +1,129 @@
|
|||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from django.apps import apps
|
||||||
|
from django.conf import settings
|
||||||
|
from django.db import connection
|
||||||
|
from django.db.migrations.executor import MigrationExecutor
|
||||||
|
from django.test import TestCase, TransactionTestCase, override_settings
|
||||||
|
|
||||||
|
from documents.models import Document
|
||||||
|
from documents.parsers import get_default_file_extension
|
||||||
|
from documents.tests.utils import DirectoriesMixin
|
||||||
|
|
||||||
|
|
||||||
|
class TestMigrations(TransactionTestCase):
|
||||||
|
|
||||||
|
@property
|
||||||
|
def app(self):
|
||||||
|
return apps.get_containing_app_config(type(self).__module__).name
|
||||||
|
|
||||||
|
migrate_from = None
|
||||||
|
migrate_to = None
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
super(TestMigrations, self).setUp()
|
||||||
|
|
||||||
|
assert self.migrate_from and self.migrate_to, \
|
||||||
|
"TestCase '{}' must define migrate_from and migrate_to properties".format(type(self).__name__)
|
||||||
|
self.migrate_from = [(self.app, self.migrate_from)]
|
||||||
|
self.migrate_to = [(self.app, self.migrate_to)]
|
||||||
|
executor = MigrationExecutor(connection)
|
||||||
|
old_apps = executor.loader.project_state(self.migrate_from).apps
|
||||||
|
|
||||||
|
# Reverse to the original migration
|
||||||
|
executor.migrate(self.migrate_from)
|
||||||
|
|
||||||
|
self.setUpBeforeMigration(old_apps)
|
||||||
|
|
||||||
|
# Run the migration to test
|
||||||
|
executor = MigrationExecutor(connection)
|
||||||
|
executor.loader.build_graph() # reload.
|
||||||
|
executor.migrate(self.migrate_to)
|
||||||
|
|
||||||
|
self.apps = executor.loader.project_state(self.migrate_to).apps
|
||||||
|
|
||||||
|
def setUpBeforeMigration(self, apps):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
STORAGE_TYPE_UNENCRYPTED = "unencrypted"
|
||||||
|
STORAGE_TYPE_GPG = "gpg"
|
||||||
|
|
||||||
|
|
||||||
|
def source_path_before(self):
|
||||||
|
if self.filename:
|
||||||
|
fname = str(self.filename)
|
||||||
|
else:
|
||||||
|
fname = "{:07}.{}".format(self.pk, self.file_type)
|
||||||
|
if self.storage_type == STORAGE_TYPE_GPG:
|
||||||
|
fname += ".gpg"
|
||||||
|
|
||||||
|
return os.path.join(
|
||||||
|
settings.ORIGINALS_DIR,
|
||||||
|
fname
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def file_type_after(self):
|
||||||
|
return get_default_file_extension(self.mime_type)
|
||||||
|
|
||||||
|
|
||||||
|
def source_path_after(doc):
|
||||||
|
if doc.filename:
|
||||||
|
fname = str(doc.filename)
|
||||||
|
else:
|
||||||
|
fname = "{:07}{}".format(doc.pk, file_type_after(doc))
|
||||||
|
if doc.storage_type == STORAGE_TYPE_GPG:
|
||||||
|
fname += ".gpg" # pragma: no cover
|
||||||
|
|
||||||
|
return os.path.join(
|
||||||
|
settings.ORIGINALS_DIR,
|
||||||
|
fname
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@override_settings(PASSPHRASE="test")
|
||||||
|
class TestMigrateMimeType(DirectoriesMixin, TestMigrations):
|
||||||
|
|
||||||
|
migrate_from = '1002_auto_20201111_1105'
|
||||||
|
migrate_to = '1003_mime_types'
|
||||||
|
|
||||||
|
def setUpBeforeMigration(self, apps):
|
||||||
|
Document = apps.get_model("documents", "Document")
|
||||||
|
doc = Document.objects.create(title="test", file_type="pdf", filename="file1.pdf")
|
||||||
|
self.doc_id = doc.id
|
||||||
|
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "simple.pdf"), source_path_before(doc))
|
||||||
|
|
||||||
|
doc2 = Document.objects.create(checksum="B", file_type="pdf", storage_type=STORAGE_TYPE_GPG)
|
||||||
|
self.doc2_id = doc2.id
|
||||||
|
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "documents", "originals", "0000002.pdf.gpg"), source_path_before(doc2))
|
||||||
|
|
||||||
|
def testMimeTypesMigrated(self):
|
||||||
|
Document = self.apps.get_model('documents', 'Document')
|
||||||
|
|
||||||
|
doc = Document.objects.get(id=self.doc_id)
|
||||||
|
self.assertEqual(doc.mime_type, "application/pdf")
|
||||||
|
|
||||||
|
doc2 = Document.objects.get(id=self.doc2_id)
|
||||||
|
self.assertEqual(doc2.mime_type, "application/pdf")
|
||||||
|
|
||||||
|
|
||||||
|
@override_settings(PASSPHRASE="test")
|
||||||
|
class TestMigrateMimeTypeBackwards(DirectoriesMixin, TestMigrations):
|
||||||
|
|
||||||
|
migrate_from = '1003_mime_types'
|
||||||
|
migrate_to = '1002_auto_20201111_1105'
|
||||||
|
|
||||||
|
def setUpBeforeMigration(self, apps):
|
||||||
|
Document = apps.get_model("documents", "Document")
|
||||||
|
doc = Document.objects.create(title="test", mime_type="application/pdf", filename="file1.pdf")
|
||||||
|
self.doc_id = doc.id
|
||||||
|
shutil.copy(os.path.join(os.path.dirname(__file__), "samples", "simple.pdf"), source_path_after(doc))
|
||||||
|
|
||||||
|
def testMimeTypesReverted(self):
|
||||||
|
Document = self.apps.get_model('documents', 'Document')
|
||||||
|
|
||||||
|
doc = Document.objects.get(id=self.doc_id)
|
||||||
|
self.assertEqual(doc.file_type, "pdf")
|
||||||
@ -58,6 +58,8 @@ class IndexView(TemplateView):
|
|||||||
def get_context_data(self, **kwargs):
|
def get_context_data(self, **kwargs):
|
||||||
context = super().get_context_data(**kwargs)
|
context = super().get_context_data(**kwargs)
|
||||||
context['cookie_prefix'] = settings.COOKIE_PREFIX
|
context['cookie_prefix'] = settings.COOKIE_PREFIX
|
||||||
|
context['username'] = self.request.user.username
|
||||||
|
context['full_name'] = self.request.user.get_full_name()
|
||||||
return context
|
return context
|
||||||
|
|
||||||
|
|
||||||
@ -389,14 +391,27 @@ class SearchView(APIView):
|
|||||||
}
|
}
|
||||||
|
|
||||||
def get(self, request, format=None):
|
def get(self, request, format=None):
|
||||||
if 'query' not in request.query_params:
|
|
||||||
|
if 'query' in request.query_params:
|
||||||
|
query = request.query_params['query']
|
||||||
|
else:
|
||||||
|
query = None
|
||||||
|
|
||||||
|
if 'more_like' in request.query_params:
|
||||||
|
more_like_id = request.query_params['more_like']
|
||||||
|
more_like_content = Document.objects.get(id=more_like_id).content
|
||||||
|
else:
|
||||||
|
more_like_id = None
|
||||||
|
more_like_content = None
|
||||||
|
|
||||||
|
if not query and not more_like_id:
|
||||||
return Response({
|
return Response({
|
||||||
'count': 0,
|
'count': 0,
|
||||||
'page': 0,
|
'page': 0,
|
||||||
'page_count': 0,
|
'page_count': 0,
|
||||||
|
'corrected_query': None,
|
||||||
'results': []})
|
'results': []})
|
||||||
|
|
||||||
query = request.query_params['query']
|
|
||||||
try:
|
try:
|
||||||
page = int(request.query_params.get('page', 1))
|
page = int(request.query_params.get('page', 1))
|
||||||
except (ValueError, TypeError):
|
except (ValueError, TypeError):
|
||||||
@ -406,8 +421,7 @@ class SearchView(APIView):
|
|||||||
page = 1
|
page = 1
|
||||||
|
|
||||||
try:
|
try:
|
||||||
with index.query_page(self.ix, query, page) as (result_page,
|
with index.query_page(self.ix, page, query, more_like_id, more_like_content) as (result_page, corrected_query): # NOQA: E501
|
||||||
corrected_query):
|
|
||||||
return Response(
|
return Response(
|
||||||
{'count': len(result_page),
|
{'count': len(result_page),
|
||||||
'page': result_page.pagenum,
|
'page': result_page.pagenum,
|
||||||
|
|||||||
@ -13,18 +13,17 @@ writeable_hint = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def path_check(env_var):
|
def path_check(var, directory):
|
||||||
messages = []
|
messages = []
|
||||||
directory = os.getenv(env_var)
|
|
||||||
if directory:
|
if directory:
|
||||||
if not os.path.exists(directory):
|
if not os.path.exists(directory):
|
||||||
messages.append(Error(
|
messages.append(Error(
|
||||||
exists_message.format(env_var),
|
exists_message.format(var),
|
||||||
exists_hint.format(directory)
|
exists_hint.format(directory)
|
||||||
))
|
))
|
||||||
elif not os.access(directory, os.W_OK | os.X_OK):
|
elif not os.access(directory, os.W_OK | os.X_OK):
|
||||||
messages.append(Error(
|
messages.append(Error(
|
||||||
writeable_message.format(env_var),
|
writeable_message.format(var),
|
||||||
writeable_hint.format(directory)
|
writeable_hint.format(directory)
|
||||||
))
|
))
|
||||||
return messages
|
return messages
|
||||||
@ -36,12 +35,9 @@ def paths_check(app_configs, **kwargs):
|
|||||||
Check the various paths for existence, readability and writeability
|
Check the various paths for existence, readability and writeability
|
||||||
"""
|
"""
|
||||||
|
|
||||||
check_messages = path_check("PAPERLESS_DATA_DIR") + \
|
return path_check("PAPERLESS_DATA_DIR", settings.DATA_DIR) + \
|
||||||
path_check("PAPERLESS_MEDIA_ROOT") + \
|
path_check("PAPERLESS_MEDIA_ROOT", settings.MEDIA_ROOT) + \
|
||||||
path_check("PAPERLESS_CONSUMPTION_DIR") + \
|
path_check("PAPERLESS_CONSUMPTION_DIR", settings.CONSUMPTION_DIR)
|
||||||
path_check("PAPERLESS_STATICDIR")
|
|
||||||
|
|
||||||
return check_messages
|
|
||||||
|
|
||||||
|
|
||||||
@register()
|
@register()
|
||||||
|
|||||||
@ -160,13 +160,6 @@ if AUTO_LOGIN_USERNAME:
|
|||||||
MIDDLEWARE.insert(_index+1, 'paperless.auth.AutoLoginMiddleware')
|
MIDDLEWARE.insert(_index+1, 'paperless.auth.AutoLoginMiddleware')
|
||||||
|
|
||||||
|
|
||||||
if DEBUG:
|
|
||||||
X_FRAME_OPTIONS = ''
|
|
||||||
# this should really be 'allow-from uri' but its not supported in any mayor
|
|
||||||
# browser.
|
|
||||||
else:
|
|
||||||
X_FRAME_OPTIONS = 'SAMEORIGIN'
|
|
||||||
|
|
||||||
# We allow CORS from localhost:8080
|
# We allow CORS from localhost:8080
|
||||||
CORS_ALLOWED_ORIGINS = tuple(os.getenv("PAPERLESS_CORS_ALLOWED_HOSTS", "http://localhost:8000").split(","))
|
CORS_ALLOWED_ORIGINS = tuple(os.getenv("PAPERLESS_CORS_ALLOWED_HOSTS", "http://localhost:8000").split(","))
|
||||||
|
|
||||||
|
|||||||
54
src/paperless/tests/test_checks.py
Normal file
54
src/paperless/tests/test_checks.py
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
|
||||||
|
from django.test import TestCase, override_settings
|
||||||
|
|
||||||
|
from documents.tests.utils import DirectoriesMixin
|
||||||
|
from paperless import binaries_check, paths_check
|
||||||
|
from paperless.checks import debug_mode_check
|
||||||
|
|
||||||
|
|
||||||
|
class TestChecks(DirectoriesMixin, TestCase):
|
||||||
|
|
||||||
|
def test_binaries(self):
|
||||||
|
self.assertEqual(binaries_check(None), [])
|
||||||
|
|
||||||
|
@override_settings(CONVERT_BINARY="uuuhh", OPTIPNG_BINARY="forgot")
|
||||||
|
def test_binaries_fail(self):
|
||||||
|
self.assertEqual(len(binaries_check(None)), 2)
|
||||||
|
|
||||||
|
def test_paths_check(self):
|
||||||
|
self.assertEqual(paths_check(None), [])
|
||||||
|
|
||||||
|
@override_settings(MEDIA_ROOT="uuh",
|
||||||
|
DATA_DIR="whatever",
|
||||||
|
CONSUMPTION_DIR="idontcare")
|
||||||
|
def test_paths_check_dont_exist(self):
|
||||||
|
msgs = paths_check(None)
|
||||||
|
self.assertEqual(len(msgs), 3, str(msgs))
|
||||||
|
|
||||||
|
for msg in msgs:
|
||||||
|
self.assertTrue(msg.msg.endswith("is set but doesn't exist."))
|
||||||
|
|
||||||
|
def test_paths_check_no_access(self):
|
||||||
|
os.chmod(self.dirs.data_dir, 0o000)
|
||||||
|
os.chmod(self.dirs.media_dir, 0o000)
|
||||||
|
os.chmod(self.dirs.consumption_dir, 0o000)
|
||||||
|
|
||||||
|
self.addCleanup(os.chmod, self.dirs.data_dir, 0o777)
|
||||||
|
self.addCleanup(os.chmod, self.dirs.media_dir, 0o777)
|
||||||
|
self.addCleanup(os.chmod, self.dirs.consumption_dir, 0o777)
|
||||||
|
|
||||||
|
msgs = paths_check(None)
|
||||||
|
self.assertEqual(len(msgs), 3)
|
||||||
|
|
||||||
|
for msg in msgs:
|
||||||
|
self.assertTrue(msg.msg.endswith("is not writeable"))
|
||||||
|
|
||||||
|
@override_settings(DEBUG=False)
|
||||||
|
def test_debug_disabled(self):
|
||||||
|
self.assertEqual(debug_mode_check(None), [])
|
||||||
|
|
||||||
|
@override_settings(DEBUG=True)
|
||||||
|
def test_debug_enabled(self):
|
||||||
|
self.assertEqual(len(debug_mode_check(None)), 1)
|
||||||
@ -1,7 +1,7 @@
|
|||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.core.checks import Error, register
|
from django.core.checks import Error, Warning, register
|
||||||
|
|
||||||
|
|
||||||
def get_tesseract_langs():
|
def get_tesseract_langs():
|
||||||
|
|||||||
@ -1,194 +0,0 @@
|
|||||||
# Thanks to the Library of Congress and some creative use of sed and awk:
|
|
||||||
# http://www.loc.gov/standards/iso639-2/php/English_list.php
|
|
||||||
|
|
||||||
ISO639 = {
|
|
||||||
|
|
||||||
"aa": "aar",
|
|
||||||
"ab": "abk",
|
|
||||||
"ae": "ave",
|
|
||||||
"af": "afr",
|
|
||||||
"ak": "aka",
|
|
||||||
"am": "amh",
|
|
||||||
"an": "arg",
|
|
||||||
"ar": "ara",
|
|
||||||
"as": "asm",
|
|
||||||
"av": "ava",
|
|
||||||
"ay": "aym",
|
|
||||||
"az": "aze",
|
|
||||||
"ba": "bak",
|
|
||||||
"be": "bel",
|
|
||||||
"bg": "bul",
|
|
||||||
"bh": "bih",
|
|
||||||
"bi": "bis",
|
|
||||||
"bm": "bam",
|
|
||||||
"bn": "ben",
|
|
||||||
"bo": "bod",
|
|
||||||
"br": "bre",
|
|
||||||
"bs": "bos",
|
|
||||||
"ca": "cat",
|
|
||||||
"ce": "che",
|
|
||||||
"ch": "cha",
|
|
||||||
"co": "cos",
|
|
||||||
"cr": "cre",
|
|
||||||
"cs": "ces",
|
|
||||||
"cu": "chu",
|
|
||||||
"cv": "chv",
|
|
||||||
"cy": "cym",
|
|
||||||
"da": "dan",
|
|
||||||
"de": "deu",
|
|
||||||
"dv": "div",
|
|
||||||
"dz": "dzo",
|
|
||||||
"ee": "ewe",
|
|
||||||
"el": "ell",
|
|
||||||
"en": "eng",
|
|
||||||
"eo": "epo",
|
|
||||||
"es": "spa",
|
|
||||||
"et": "est",
|
|
||||||
"eu": "eus",
|
|
||||||
"fa": "fas",
|
|
||||||
"ff": "ful",
|
|
||||||
"fi": "fin",
|
|
||||||
"fj": "fij",
|
|
||||||
"fo": "fao",
|
|
||||||
"fr": "fra",
|
|
||||||
"fy": "fry",
|
|
||||||
"ga": "gle",
|
|
||||||
"gd": "gla",
|
|
||||||
"gl": "glg",
|
|
||||||
"gn": "grn",
|
|
||||||
"gu": "guj",
|
|
||||||
"gv": "glv",
|
|
||||||
"ha": "hau",
|
|
||||||
"he": "heb",
|
|
||||||
"hi": "hin",
|
|
||||||
"ho": "hmo",
|
|
||||||
"hr": "hrv",
|
|
||||||
"ht": "hat",
|
|
||||||
"hu": "hun",
|
|
||||||
"hy": "hye",
|
|
||||||
"hz": "her",
|
|
||||||
"ia": "ina",
|
|
||||||
"id": "ind",
|
|
||||||
"ie": "ile",
|
|
||||||
"ig": "ibo",
|
|
||||||
"ii": "iii",
|
|
||||||
"ik": "ipk",
|
|
||||||
"io": "ido",
|
|
||||||
"is": "isl",
|
|
||||||
"it": "ita",
|
|
||||||
"iu": "iku",
|
|
||||||
"ja": "jpn",
|
|
||||||
"jv": "jav",
|
|
||||||
"ka": "kat",
|
|
||||||
"kg": "kon",
|
|
||||||
"ki": "kik",
|
|
||||||
"kj": "kua",
|
|
||||||
"kk": "kaz",
|
|
||||||
"kl": "kal",
|
|
||||||
"km": "khm",
|
|
||||||
"kn": "kan",
|
|
||||||
"ko": "kor",
|
|
||||||
"kr": "kau",
|
|
||||||
"ks": "kas",
|
|
||||||
"ku": "kur",
|
|
||||||
"kv": "kom",
|
|
||||||
"kw": "cor",
|
|
||||||
"ky": "kir",
|
|
||||||
"la": "lat",
|
|
||||||
"lb": "ltz",
|
|
||||||
"lg": "lug",
|
|
||||||
"li": "lim",
|
|
||||||
"ln": "lin",
|
|
||||||
"lo": "lao",
|
|
||||||
"lt": "lit",
|
|
||||||
"lu": "lub",
|
|
||||||
"lv": "lav",
|
|
||||||
"mg": "mlg",
|
|
||||||
"mh": "mah",
|
|
||||||
"mi": "mri",
|
|
||||||
"mk": "mkd",
|
|
||||||
"ml": "mal",
|
|
||||||
"mn": "mon",
|
|
||||||
"mr": "mar",
|
|
||||||
"ms": "msa",
|
|
||||||
"mt": "mlt",
|
|
||||||
"my": "mya",
|
|
||||||
"na": "nau",
|
|
||||||
"nb": "nob",
|
|
||||||
"nd": "nde",
|
|
||||||
"ne": "nep",
|
|
||||||
"ng": "ndo",
|
|
||||||
"nl": "nld",
|
|
||||||
"no": "nor",
|
|
||||||
"nr": "nbl",
|
|
||||||
"nv": "nav",
|
|
||||||
"ny": "nya",
|
|
||||||
"oc": "oci",
|
|
||||||
"oj": "oji",
|
|
||||||
"om": "orm",
|
|
||||||
"or": "ori",
|
|
||||||
"os": "oss",
|
|
||||||
"pa": "pan",
|
|
||||||
"pi": "pli",
|
|
||||||
"pl": "pol",
|
|
||||||
"ps": "pus",
|
|
||||||
"pt": "por",
|
|
||||||
"qu": "que",
|
|
||||||
"rm": "roh",
|
|
||||||
"rn": "run",
|
|
||||||
"ro": "ron",
|
|
||||||
"ru": "rus",
|
|
||||||
"rw": "kin",
|
|
||||||
"sa": "san",
|
|
||||||
"sc": "srd",
|
|
||||||
"sd": "snd",
|
|
||||||
"se": "sme",
|
|
||||||
"sg": "sag",
|
|
||||||
"si": "sin",
|
|
||||||
"sk": "slk",
|
|
||||||
"sl": "slv",
|
|
||||||
"sm": "smo",
|
|
||||||
"sn": "sna",
|
|
||||||
"so": "som",
|
|
||||||
"sq": "sqi",
|
|
||||||
"sr": "srp",
|
|
||||||
"ss": "ssw",
|
|
||||||
"st": "sot",
|
|
||||||
"su": "sun",
|
|
||||||
"sv": "swe",
|
|
||||||
"sw": "swa",
|
|
||||||
"ta": "tam",
|
|
||||||
"te": "tel",
|
|
||||||
"tg": "tgk",
|
|
||||||
"th": "tha",
|
|
||||||
"ti": "tir",
|
|
||||||
"tk": "tuk",
|
|
||||||
"tl": "tgl",
|
|
||||||
"tn": "tsn",
|
|
||||||
"to": "ton",
|
|
||||||
"tr": "tur",
|
|
||||||
"ts": "tso",
|
|
||||||
"tt": "tat",
|
|
||||||
"tw": "twi",
|
|
||||||
"ty": "tah",
|
|
||||||
"ug": "uig",
|
|
||||||
"uk": "ukr",
|
|
||||||
"ur": "urd",
|
|
||||||
"uz": "uzb",
|
|
||||||
"ve": "ven",
|
|
||||||
"vi": "vie",
|
|
||||||
"vo": "vol",
|
|
||||||
"wa": "wln",
|
|
||||||
"wo": "wol",
|
|
||||||
"xh": "xho",
|
|
||||||
"yi": "yid",
|
|
||||||
"yo": "yor",
|
|
||||||
"za": "zha",
|
|
||||||
|
|
||||||
# Tessdata contains two values for Chinese, "chi_sim" and "chi_tra". I
|
|
||||||
# have no idea which one is better, so I just picked the bigger file.
|
|
||||||
"zh": "chi_tra",
|
|
||||||
|
|
||||||
"zu": "zul"
|
|
||||||
|
|
||||||
}
|
|
||||||
26
src/paperless_tesseract/tests/test_checks.py
Normal file
26
src/paperless_tesseract/tests/test_checks.py
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
from django.core.checks import ERROR
|
||||||
|
from django.test import TestCase, override_settings
|
||||||
|
|
||||||
|
from paperless_tesseract import check_default_language_available
|
||||||
|
|
||||||
|
|
||||||
|
class TestChecks(TestCase):
|
||||||
|
|
||||||
|
def test_default_language(self):
|
||||||
|
msgs = check_default_language_available(None)
|
||||||
|
|
||||||
|
@override_settings(OCR_LANGUAGE="")
|
||||||
|
def test_no_language(self):
|
||||||
|
msgs = check_default_language_available(None)
|
||||||
|
self.assertEqual(len(msgs), 1)
|
||||||
|
self.assertTrue(msgs[0].msg.startswith("No OCR language has been specified with PAPERLESS_OCR_LANGUAGE"))
|
||||||
|
|
||||||
|
@override_settings(OCR_LANGUAGE="ita")
|
||||||
|
@mock.patch("paperless_tesseract.checks.get_tesseract_langs")
|
||||||
|
def test_invalid_language(self, m):
|
||||||
|
m.return_value = ["deu", "eng"]
|
||||||
|
msgs = check_default_language_available(None)
|
||||||
|
self.assertEqual(len(msgs), 1)
|
||||||
|
self.assertEqual(msgs[0].level, ERROR)
|
||||||
@ -35,15 +35,3 @@ class TextDocumentParser(DocumentParser):
|
|||||||
def parse(self, document_path, mime_type):
|
def parse(self, document_path, mime_type):
|
||||||
with open(document_path, 'r') as f:
|
with open(document_path, 'r') as f:
|
||||||
self.text = f.read()
|
self.text = f.read()
|
||||||
|
|
||||||
|
|
||||||
def run_command(*args):
|
|
||||||
environment = os.environ.copy()
|
|
||||||
if settings.CONVERT_MEMORY_LIMIT:
|
|
||||||
environment["MAGICK_MEMORY_LIMIT"] = settings.CONVERT_MEMORY_LIMIT
|
|
||||||
if settings.CONVERT_TMPDIR:
|
|
||||||
environment["MAGICK_TMPDIR"] = settings.CONVERT_TMPDIR
|
|
||||||
|
|
||||||
if not subprocess.Popen(' '.join(args), env=environment,
|
|
||||||
shell=True).wait() == 0:
|
|
||||||
raise ParseError("Convert failed at {}".format(args))
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user