Merge pull request #957 from paperless-ngx/feature-created-date

Feature: make frontend timezone un-aware

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.

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'
@@ -205,7 +205,7 @@ function initializeApp(settings: SettingsService) {
     },
     FilterPipe,
     DocumentTitlePipe,
-    { provide: NgbDateAdapter, useClass: ISODateTimeAdapter },
+    { provide: NgbDateAdapter, useClass: ISODateAdapter },
     { provide: NgbDateParserFormatter, useClass: LocalizedDateParserFormatter },
   ],
   bootstrap: [AppComponent],

src-ui/src/app/components/dashboard/widgets/saved-view-widget/saved-view-widget.component.html

@@ -12,7 +12,7 @@
     </thead>
     <tbody>
       <tr *ngFor="let doc of documents" (click)="openDocumentsService.openDocument(doc)">
-        <td>{{doc.created | customDate}}</td>
+        <td>{{doc.created_date | customDate}}</td>
         <td>{{doc.title | documentTitle}}<app-tag [tag]="t" *ngFor="let t of doc.tags$ | async" class="ms-1" (click)="clickTag(t); $event.stopPropagation();"></app-tag></td>
       </tr>
     </tbody>

src-ui/src/app/components/document-detail/document-detail.component.html

@@ -68,7 +68,7 @@
 
                         <app-input-text #inputTitle i18n-title title="Title" formControlName="title" (keyup)="titleKeyUp($event)" [error]="error?.title"></app-input-text>
                         <app-input-number i18n-title title="Archive serial number" [error]="error?.archive_serial_number" formControlName='archive_serial_number'></app-input-number>
-                        <app-input-date i18n-title title="Date created" formControlName="created" [error]="error?.created"></app-input-date>
+                        <app-input-date i18n-title title="Date created" formControlName="created_date" [error]="error?.created_date"></app-input-date>
                         <app-input-select [items]="correspondents" i18n-title title="Correspondent" formControlName="correspondent" [allowNull]="true"
                             (createNew)="createCorrespondent($event)" [suggestions]="suggestions?.correspondents"></app-input-select>
                         <app-input-select [items]="documentTypes" i18n-title title="Document type" formControlName="document_type" [allowNull]="true"

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'
@@ -73,7 +72,7 @@ export class DocumentDetailComponent
   documentForm: FormGroup = new FormGroup({
     title: new FormControl(''),
     content: new FormControl(''),
-    created: new FormControl(),
+    created_date: new FormControl(),
     correspondent: new FormControl(),
     document_type: new FormControl(),
     storage_path: new FormControl(),
@@ -139,27 +138,8 @@ export class DocumentDetailComponent
   ngOnInit(): void {
     this.documentForm.valueChanges
       .pipe(takeUntil(this.unsubscribeNotifier))
-      .subscribe((changes) => {
+      .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)
       })
 
@@ -231,13 +211,11 @@ 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,
             storage_path: doc.storage_path,
@@ -245,12 +223,6 @@ export class DocumentDetailComponent
             tags: [...doc.tags],
           })
 
-          // start with ISO8601 string
-          this.documentForm.patchValue(
-            { created: this.ogDate.toISOString() },
-            { emitEvent: false }
-          )
-
           this.isDirty$ = dirtyCheck(
             this.documentForm,
             this.store.asObservable()

src-ui/src/app/components/document-list/document-card-large/document-card-large.component.html

@@ -92,7 +92,7 @@
                 <path d="M11 6.5a.5.5 0 0 1 .5-.5h1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-1a.5.5 0 0 1-.5-.5v-1z"/>
                 <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
               </svg>
-              <small>{{document.created | customDate:'mediumDate'}}</small>
+              <small>{{document.created_date | customDate:'mediumDate'}}</small>
             </div>
             <div *ngIf="document.__search_hit__?.score" class="list-group-item bg-light text-dark border-0 d-flex p-0 ps-4 search-score">
               <small class="text-muted" i18n>Score:</small>

src-ui/src/app/components/document-list/document-card-small/document-card-small.component.html

@@ -55,7 +55,7 @@
               <path d="M11 6.5a.5.5 0 0 1 .5-.5h1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-1a.5.5 0 0 1-.5-.5v-1z"/>
               <path d="M3.5 0a.5.5 0 0 1 .5.5V1h8V.5a.5.5 0 0 1 1 0V1h1a2 2 0 0 1 2 2v11a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V3a2 2 0 0 1 2-2h1V.5a.5.5 0 0 1 .5-.5zM1 4v10a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1V4H1z"/>
             </svg>
-            <small>{{document.created | customDate:'mediumDate'}}</small>
+            <small>{{document.created_date | customDate:'mediumDate'}}</small>
           </div>
           <div *ngIf="document.archive_serial_number" class="ps-0 p-1">
             <svg class="metadata-icon me-2 text-muted bi bi-upc-scan" viewBox="0 0 16 16" fill="currentColor">

src-ui/src/app/components/document-list/document-list.component.html

@@ -186,7 +186,7 @@
           </ng-container>
         </td>
         <td>
-          {{d.created | customDate}}
+          {{d.created_date | customDate}}
         </td>
         <td class="d-none d-xl-table-cell">
           {{d.added | customDate}}

src-ui/src/app/data/paperless-document.ts

@@ -37,8 +37,12 @@ export interface PaperlessDocument extends ObjectWithId {
 
   checksum?: string
 
+  // UTC
   created?: Date
 
+  // localized date
+  created_date?: Date
+
   modified?: Date
 
   added?: Date

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',
@@ -35,7 +34,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 {

src-ui/src/app/services/rest/document.service.ts

@@ -133,6 +133,12 @@ export class DocumentService extends AbstractPaperlessService<PaperlessDocument>
     return url
   }
 
+  update(o: PaperlessDocument): Observable<PaperlessDocument> {
+    // 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'),

src-ui/src/app/utils/date.ts

@@ -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`)
-}

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<string> {
   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

src-ui/src/app/utils/ngb-iso-date-time-adapter.ts

@@ -1,24 +0,0 @@
-import { Injectable } from '@angular/core'
-import { NgbDateAdapter, NgbDateStruct } from '@ng-bootstrap/ng-bootstrap'
-
-@Injectable()
-export class ISODateTimeAdapter extends NgbDateAdapter<string> {
-  fromModel(value: string | null): NgbDateStruct | null {
-    if (value) {
-      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
-      ? new Date(date.year, date.month - 1, date.day).toISOString()
-      : null
-  }
-}

src/documents/models.py

@@ -306,6 +306,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):
 

src/documents/serialisers.py

@@ -1,7 +1,13 @@
+import datetime
 import math
 import re
 
+try:
+    import zoneinfo
+except ImportError:
+    import backports.zoneinfo as zoneinfo
 import magic
+from django.conf import settings
 from django.utils.text import slugify
 from django.utils.translation import gettext as _
 from rest_framework import serializers
@@ -214,6 +220,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer):
 
     original_file_name = SerializerMethodField()
     archived_file_name = SerializerMethodField()
+    created_date = serializers.DateField(required=False)
 
     def get_original_file_name(self, obj):
         return obj.get_public_filename()
@@ -224,6 +231,18 @@ 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, zoneinfo.ZoneInfo(settings.TIME_ZONE)),
+            )
+            instance.created = new_datetime
+            instance.save()
+        validated_data.pop("created_date")
+        super().update(instance, validated_data)
+        return instance
+
     class Meta:
         model = Document
         depth = 1
@@ -236,6 +255,7 @@ class DocumentSerializer(DynamicFieldsModelSerializer):
             "content",
             "tags",
             "created",
+            "created_date",
             "modified",
             "added",
             "archive_serial_number",