From 2ca691d3b8ec2129a6d29f3b9b3203c2288216d1 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 15 May 2022 21:09:42 -0700 Subject: [PATCH 1/9] use created_date --- .../saved-view-widget.component.html | 2 +- .../document-detail.component.html | 2 +- .../document-detail.component.ts | 34 ++----------------- src-ui/src/app/data/paperless-document.ts | 4 +++ src-ui/src/app/pipes/custom-date.pipe.ts | 2 -- src-ui/src/app/utils/date.ts | 5 --- .../app/utils/ngb-iso-date-time-adapter.ts | 23 ++++++++----- src/documents/models.py | 4 +++ src/documents/serialisers.py | 15 ++++++++ 9 files changed, 43 insertions(+), 48 deletions(-) delete mode 100644 src-ui/src/app/utils/date.ts diff --git a/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html b/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html index 50d064c37..84ee1aabe 100644 --- a/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html +++ b/src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html @@ -12,7 +12,7 @@ - {{doc.created | customDate}} + {{doc.created_date | customDate}} {{doc.title | documentTitle}} diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html index a4203473f..ca4fb4275 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.html +++ b/src-ui/src/app/components/document-detail/document-detail.component.html @@ -68,7 +68,7 @@ - + { + .subscribe(() => { this.error = null - if (this.ogDate) { - try { - let newDate = new Date(normalizeDateStr(changes['created'])) - newDate.setHours( - this.ogDate.getHours(), - this.ogDate.getMinutes(), - this.ogDate.getSeconds(), - this.ogDate.getMilliseconds() - ) - this.documentForm.patchValue( - { created: newDate.toISOString() }, - { emitEvent: false } - ) - } catch (e) { - // catch this before we try to save and simulate an api error - this.error = { created: e.message } - } - } - Object.assign(this.document, this.documentForm.value) }) @@ -223,25 +203,17 @@ export class DocumentDetailComponent }, }) - this.ogDate = new Date(normalizeDateStr(doc.created.toString())) - // Initialize dirtyCheck this.store = new BehaviorSubject({ title: doc.title, content: doc.content, - created: this.ogDate.toISOString(), + created_date: doc.created_date, correspondent: doc.correspondent, document_type: doc.document_type, archive_serial_number: doc.archive_serial_number, tags: [...doc.tags], }) - // start with ISO8601 string - this.documentForm.patchValue( - { created: this.ogDate.toISOString() }, - { emitEvent: false } - ) - this.isDirty$ = dirtyCheck( this.documentForm, this.store.asObservable() diff --git a/src-ui/src/app/data/paperless-document.ts b/src-ui/src/app/data/paperless-document.ts index 92a5aee45..051fa0aaa 100644 --- a/src-ui/src/app/data/paperless-document.ts +++ b/src-ui/src/app/data/paperless-document.ts @@ -32,8 +32,12 @@ export interface PaperlessDocument extends ObjectWithId { checksum?: string + // UTC created?: Date + // localized date + created_date?: Date + modified?: Date added?: Date diff --git a/src-ui/src/app/pipes/custom-date.pipe.ts b/src-ui/src/app/pipes/custom-date.pipe.ts index bd4833d04..bf5ab1457 100644 --- a/src-ui/src/app/pipes/custom-date.pipe.ts +++ b/src-ui/src/app/pipes/custom-date.pipe.ts @@ -1,7 +1,6 @@ import { DatePipe } from '@angular/common' import { Inject, LOCALE_ID, Pipe, PipeTransform } from '@angular/core' import { SettingsService, SETTINGS_KEYS } from '../services/settings.service' -import { normalizeDateStr } from '../utils/date' const FORMAT_TO_ISO_FORMAT = { longDate: 'y-MM-dd', @@ -34,7 +33,6 @@ export class CustomDatePipe implements PipeTransform { this.settings.get(SETTINGS_KEYS.DATE_LOCALE) || this.defaultLocale let f = format || this.settings.get(SETTINGS_KEYS.DATE_FORMAT) - if (typeof value == 'string') value = normalizeDateStr(value) if (l == 'iso-8601') { return this.datePipe.transform(value, FORMAT_TO_ISO_FORMAT[f], timezone) } else { diff --git a/src-ui/src/app/utils/date.ts b/src-ui/src/app/utils/date.ts deleted file mode 100644 index b62ffc939..000000000 --- a/src-ui/src/app/utils/date.ts +++ /dev/null @@ -1,5 +0,0 @@ -// see https://github.com/dateutil/dateutil/issues/878 , JS Date does not -// seem to accept these strings as valid dates so we must normalize offset -export function normalizeDateStr(dateStr: string): string { - return dateStr.replace(/[\+-](\d\d):\d\d:\d\d/gm, `-$1:00`) -} diff --git a/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts b/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts index b9acc38ec..9d0ea4de6 100644 --- a/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts +++ b/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts @@ -5,11 +5,20 @@ import { NgbDateAdapter, NgbDateStruct } from '@ng-bootstrap/ng-bootstrap' export class ISODateTimeAdapter extends NgbDateAdapter { fromModel(value: string | null): NgbDateStruct | null { if (value) { - let date = new Date(value) - return { - day: date.getDate(), - month: date.getMonth() + 1, - year: date.getFullYear(), + if (value.match(/\d\d\d\d\-\d\d\-\d\d/g)) { + const segs = value.split('-') + return { + year: parseInt(segs[0]), + month: parseInt(segs[1]), + day: parseInt(segs[2]), + } + } else { + let date = new Date(value) + return { + day: date.getDate(), + month: date.getMonth() + 1, + year: date.getFullYear(), + } } } else { return null @@ -17,8 +26,6 @@ export class ISODateTimeAdapter extends NgbDateAdapter { } toModel(date: NgbDateStruct | null): string | null { - return date - ? new Date(date.year, date.month - 1, date.day).toISOString() - : null + return date ? [date.year, date.month, date.day].join('-') : null } } diff --git a/src/documents/models.py b/src/documents/models.py index 206df4e8a..cc4cd0613 100644 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -279,6 +279,10 @@ class Document(models.Model): def thumbnail_file(self): return open(self.thumbnail_path, "rb") + @property + def created_date(self): + return timezone.localdate(self.created) + class Log(models.Model): diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 1bdcbab9e..564c0aae5 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -1,7 +1,10 @@ +import datetime import math import re import magic +from dateutil import tz +from django.conf import settings from django.utils.text import slugify from django.utils.translation import gettext as _ from rest_framework import serializers @@ -206,6 +209,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer): original_file_name = SerializerMethodField() archived_file_name = SerializerMethodField() + created_date = serializers.DateField() def get_original_file_name(self, obj): return obj.get_public_filename() @@ -216,6 +220,16 @@ class DocumentSerializer(DynamicFieldsModelSerializer): else: return None + def update(self, instance, validated_data): + if "created_date" in validated_data and "created" not in validated_data: + new_datetime = datetime.datetime.combine( + validated_data.get("created_date"), + datetime.time(0, 0, 0, 0, tz.gettz(settings.TIME_ZONE)), + ) + instance.created = new_datetime + instance.save() + return instance + class Meta: model = Document depth = 1 @@ -227,6 +241,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer): "content", "tags", "created", + "created_date", "modified", "added", "archive_serial_number", From 063f6c1d5a4b7d3cc7e7bbac2cafd28db6be6a29 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 00:01:57 -0700 Subject: [PATCH 2/9] only pass created_date from frontend --- src-ui/src/app/services/rest/document.service.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src-ui/src/app/services/rest/document.service.ts b/src-ui/src/app/services/rest/document.service.ts index 3b242543e..880d119dc 100644 --- a/src-ui/src/app/services/rest/document.service.ts +++ b/src-ui/src/app/services/rest/document.service.ts @@ -121,6 +121,12 @@ export class DocumentService extends AbstractPaperlessService return url } + update(o: PaperlessDocument): Observable { + // we want to only set created_date + o.created = undefined + return super.update(o) + } + uploadDocument(formData) { return this.http.post( this.getResourceUrl(null, 'post_document'), From c398f22e76ac9e096da84638cb3be58ba3f8321f Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 00:13:25 -0700 Subject: [PATCH 3/9] fix docs update endpoint --- src/documents/serialisers.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 564c0aae5..eee4f0f9c 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -209,7 +209,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer): original_file_name = SerializerMethodField() archived_file_name = SerializerMethodField() - created_date = serializers.DateField() + created_date = serializers.DateField(required=False) def get_original_file_name(self, obj): return obj.get_public_filename() @@ -228,6 +228,8 @@ class DocumentSerializer(DynamicFieldsModelSerializer): ) instance.created = new_datetime instance.save() + validated_data.pop("created_date") + super().update(instance, validated_data) return instance class Meta: From b2911b2eba9e293b7f7e8d36f610cc709285aa73 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 00:30:21 -0700 Subject: [PATCH 4/9] use created_date in all of frontend --- .../document-card-large/document-card-large.component.html | 2 +- .../document-card-small/document-card-small.component.html | 2 +- .../app/components/document-list/document-list.component.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html index 5eb4a97dd..43e5ad2a8 100644 --- a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html +++ b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html @@ -78,7 +78,7 @@ - {{document.created | customDate:'mediumDate'}} + {{document.created_date | customDate:'mediumDate'}}
diff --git a/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html b/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html index 6c68cc26f..2697a9425 100644 --- a/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html +++ b/src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html @@ -51,7 +51,7 @@ - {{document.created | customDate:'mediumDate'}} + {{document.created_date | customDate:'mediumDate'}}
diff --git a/src-ui/src/app/components/document-list/document-list.component.html b/src-ui/src/app/components/document-list/document-list.component.html index aa43243fc..80ccdf01b 100644 --- a/src-ui/src/app/components/document-list/document-list.component.html +++ b/src-ui/src/app/components/document-list/document-list.component.html @@ -177,7 +177,7 @@ - {{d.created | customDate}} + {{d.created_date | customDate}} {{d.added | customDate}} From 94954eeba3e93d10c1423260561b5ef0858f7730 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 00:31:33 -0700 Subject: [PATCH 5/9] created_date error display --- .../components/document-detail/document-detail.component.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html index ca4fb4275..2225afa31 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.html +++ b/src-ui/src/app/components/document-detail/document-detail.component.html @@ -68,7 +68,7 @@ - + Date: Mon, 16 May 2022 00:29:49 -0700 Subject: [PATCH 6/9] Consolidate date adapter --- src-ui/src/app/app.module.ts | 4 +-- src-ui/src/app/utils/ngb-iso-date-adapter.ts | 19 +++++++++--- .../app/utils/ngb-iso-date-time-adapter.ts | 31 ------------------- 3 files changed, 16 insertions(+), 38 deletions(-) delete mode 100644 src-ui/src/app/utils/ngb-iso-date-time-adapter.ts diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index e891d217d..a705c83ec 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -61,7 +61,7 @@ import { SafeUrlPipe } from './pipes/safeurl.pipe' import { SafeHtmlPipe } from './pipes/safehtml.pipe' import { CustomDatePipe } from './pipes/custom-date.pipe' import { DateComponent } from './components/common/input/date/date.component' -import { ISODateTimeAdapter } from './utils/ngb-iso-date-time-adapter' +import { ISODateAdapter } from './utils/ngb-iso-date-adapter' import { LocalizedDateParserFormatter } from './utils/ngb-date-parser-formatter' import { ApiVersionInterceptor } from './interceptors/api-version.interceptor' import { ColorSliderModule } from 'ngx-color/slider' @@ -188,7 +188,7 @@ registerLocaleData(localeZh) }, FilterPipe, DocumentTitlePipe, - { provide: NgbDateAdapter, useClass: ISODateTimeAdapter }, + { provide: NgbDateAdapter, useClass: ISODateAdapter }, { provide: NgbDateParserFormatter, useClass: LocalizedDateParserFormatter }, ], bootstrap: [AppComponent], diff --git a/src-ui/src/app/utils/ngb-iso-date-adapter.ts b/src-ui/src/app/utils/ngb-iso-date-adapter.ts index 7aa2214b5..af2fff3f3 100644 --- a/src-ui/src/app/utils/ngb-iso-date-adapter.ts +++ b/src-ui/src/app/utils/ngb-iso-date-adapter.ts @@ -5,11 +5,20 @@ import { NgbDateAdapter, NgbDateStruct } from '@ng-bootstrap/ng-bootstrap' export class ISODateAdapter extends NgbDateAdapter { fromModel(value: string | null): NgbDateStruct | null { if (value) { - let date = new Date(value) - return { - day: date.getDate(), - month: date.getMonth() + 1, - year: date.getFullYear(), + if (value.match(/\d\d\d\d\-\d\d\-\d\d/g)) { + const segs = value.split('-') + return { + year: parseInt(segs[0]), + month: parseInt(segs[1]), + day: parseInt(segs[2]), + } + } else { + let date = new Date(value) + return { + day: date.getDate(), + month: date.getMonth() + 1, + year: date.getFullYear(), + } } } else { return null diff --git a/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts b/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts deleted file mode 100644 index 9d0ea4de6..000000000 --- a/src-ui/src/app/utils/ngb-iso-date-time-adapter.ts +++ /dev/null @@ -1,31 +0,0 @@ -import { Injectable } from '@angular/core' -import { NgbDateAdapter, NgbDateStruct } from '@ng-bootstrap/ng-bootstrap' - -@Injectable() -export class ISODateTimeAdapter extends NgbDateAdapter { - fromModel(value: string | null): NgbDateStruct | null { - if (value) { - if (value.match(/\d\d\d\d\-\d\d\-\d\d/g)) { - const segs = value.split('-') - return { - year: parseInt(segs[0]), - month: parseInt(segs[1]), - day: parseInt(segs[2]), - } - } else { - let date = new Date(value) - return { - day: date.getDate(), - month: date.getMonth() + 1, - year: date.getFullYear(), - } - } - } else { - return null - } - } - - toModel(date: NgbDateStruct | null): string | null { - return date ? [date.year, date.month, date.day].join('-') : null - } -} From 6fbe4404f5e491bf4827111e6f826f3d909572b4 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 11:34:30 -0700 Subject: [PATCH 7/9] Update api.rst --- docs/api.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index c23866b60..1e70b19fa 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -31,7 +31,8 @@ The objects served by the document endpoint contain the following fields: * ``tags``: List of IDs of tags assigned to this document, or empty list. * ``document_type``: Document type of this document, or null. * ``correspondent``: Correspondent of this document or null. -* ``created``: The date at which this document was created. +* ``created``: The date time at which this document was created. +* ``created_date``: The date (YYYY-MM-DD) at which this document was created. Optional. If also passed with created, this is ignored. * ``modified``: The date at which this document was last edited in paperless. Read-only. * ``added``: The date at which this document was added to paperless. Read-only. * ``archive_serial_number``: The identifier of this document in a physical document archive. From 88b7f8ac1e2c9c3f157be91b1b9b7c22a40d2a98 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 16 May 2022 21:39:10 -0700 Subject: [PATCH 8/9] Use zoneinfo instead of tz Co-Authored-By: Trenton Holmes <797416+stumpylog@users.noreply.github.com> --- src/documents/serialisers.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index eee4f0f9c..db55226e2 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -2,8 +2,11 @@ import datetime import math import re +try: + import zoneinfo +except ImportError: + import backports.zoneinfo as zoneinfo import magic -from dateutil import tz from django.conf import settings from django.utils.text import slugify from django.utils.translation import gettext as _ @@ -224,7 +227,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer): if "created_date" in validated_data and "created" not in validated_data: new_datetime = datetime.datetime.combine( validated_data.get("created_date"), - datetime.time(0, 0, 0, 0, tz.gettz(settings.TIME_ZONE)), + datetime.time(0, 0, 0, 0, zoneinfo.ZoneInfo(settings.TIME_ZONE)), ) instance.created = new_datetime instance.save() From 97bbca3aef463ba81808883c9570139735b7635e Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 1 Jun 2022 09:28:26 -0700 Subject: [PATCH 9/9] fix merge conflict --- .../app/components/document-detail/document-detail.component.ts | 1 - src-ui/src/app/pipes/custom-date.pipe.ts | 1 - 2 files changed, 2 deletions(-) diff --git a/src-ui/src/app/components/document-detail/document-detail.component.ts b/src-ui/src/app/components/document-detail/document-detail.component.ts index 2abc06193..2792b6395 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.ts +++ b/src-ui/src/app/components/document-detail/document-detail.component.ts @@ -31,7 +31,6 @@ import { } from 'rxjs/operators' import { PaperlessDocumentSuggestions } from 'src/app/data/paperless-document-suggestions' import { FILTER_FULLTEXT_MORELIKE } from 'src/app/data/filter-rule-type' -import { normalizeDateStr } from 'src/app/utils/date' import { StoragePathService } from 'src/app/services/rest/storage-path.service' import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path' import { StoragePathEditDialogComponent } from '../common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component' diff --git a/src-ui/src/app/pipes/custom-date.pipe.ts b/src-ui/src/app/pipes/custom-date.pipe.ts index 46b1036cd..4a0bb3463 100644 --- a/src-ui/src/app/pipes/custom-date.pipe.ts +++ b/src-ui/src/app/pipes/custom-date.pipe.ts @@ -2,7 +2,6 @@ import { DatePipe } from '@angular/common' import { Inject, LOCALE_ID, Pipe, PipeTransform } from '@angular/core' import { SETTINGS_KEYS } from '../data/paperless-uisettings' import { SettingsService } from '../services/settings.service' -import { normalizeDateStr } from '../utils/date' const FORMAT_TO_ISO_FORMAT = { longDate: 'y-MM-dd',