From c3331086d55661f9f1a973194cef951d2ccd05d9 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 8 Nov 2022 03:39:54 -0800 Subject: [PATCH 01/26] Basic data retrieval --- .../manage/settings/settings.component.html | 31 +++++ .../manage/settings/settings.component.ts | 116 ++++++++++++++++-- src-ui/src/app/data/paperless-mail-account.ts | 23 ++++ src-ui/src/app/data/paperless-mail-rule.ts | 66 ++++++++++ .../app/services/rest/mail-account.service.ts | 52 ++++++++ .../app/services/rest/mail-rule.service.ts | 50 ++++++++ src/documents/serialisers.py | 60 +++++++++ src/documents/views.py | 38 ++++++ src/paperless/urls.py | 4 + 9 files changed, 431 insertions(+), 9 deletions(-) create mode 100644 src-ui/src/app/data/paperless-mail-account.ts create mode 100644 src-ui/src/app/data/paperless-mail-rule.ts create mode 100644 src-ui/src/app/services/rest/mail-account.service.ts create mode 100644 src-ui/src/app/services/rest/mail-rule.service.ts diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 88bf34d36..9ba010c0e 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -216,6 +216,37 @@ + +
  • + Paperless Mail + + +

    Mail accounts

    +
    + +
    +
    + {{account.name}} +
    +
    + +
    No mail accounts defined.
    +
    + +

    Mail rules

    +
    + +
    +
    + {{rule.name}} +
    +
    + +
    No mail rules defined.
    +
    + +     +
    • diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 51a401e49..c6ffc13db 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -29,6 +29,10 @@ import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' import { ActivatedRoute } from '@angular/router' import { ViewportScroller } from '@angular/common' import { TourService } from 'ngx-ui-tour-ng-bootstrap' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' +import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' +import { MailAccountService as MailAccountService } from 'src/app/services/rest/mail-account.service' +import { MailRuleService } from 'src/app/services/rest/mail-rule.service' @Component({ selector: 'app-settings', @@ -40,6 +44,9 @@ export class SettingsComponent { savedViewGroup = new FormGroup({}) + mailAccountGroup = new FormGroup({}) + mailRuleGroup = new FormGroup({}) + settingsForm = new FormGroup({ bulkEditConfirmationDialogs: new FormControl(null), bulkEditApplyOnClose: new FormControl(null), @@ -50,20 +57,28 @@ export class SettingsComponent darkModeInvertThumbs: new FormControl(null), themeColor: new FormControl(null), useNativePdfViewer: new FormControl(null), - savedViews: this.savedViewGroup, displayLanguage: new FormControl(null), dateLocale: new FormControl(null), dateFormat: new FormControl(null), + commentsEnabled: new FormControl(null), + updateCheckingEnabled: new FormControl(null), + notificationsConsumerNewDocument: new FormControl(null), notificationsConsumerSuccess: new FormControl(null), notificationsConsumerFailed: new FormControl(null), notificationsConsumerSuppressOnDashboard: new FormControl(null), - commentsEnabled: new FormControl(null), - updateCheckingEnabled: new FormControl(null), + + savedViews: this.savedViewGroup, + + mailAccounts: this.mailAccountGroup, + mailRules: this.mailRuleGroup, }) savedViews: PaperlessSavedView[] + mailAccounts: PaperlessMailAccount[] + mailRules: PaperlessMailRule[] + store: BehaviorSubject storeSub: Subscription isDirty$: Observable @@ -81,6 +96,8 @@ export class SettingsComponent constructor( public savedViewService: SavedViewService, + public mailAccountService: MailAccountService, + public mailRuleService: MailRuleService, private documentListViewService: DocumentListViewService, private toastService: ToastService, private settings: SettingsService, @@ -123,10 +140,13 @@ export class SettingsComponent useNativePdfViewer: this.settings.get( SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER ), - savedViews: {}, displayLanguage: this.settings.getLanguage(), dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE), dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT), + commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), + updateCheckingEnabled: this.settings.get( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED + ), notificationsConsumerNewDocument: this.settings.get( SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT ), @@ -139,17 +159,25 @@ export class SettingsComponent notificationsConsumerSuppressOnDashboard: this.settings.get( SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD ), - commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), - updateCheckingEnabled: this.settings.get( - SETTINGS_KEYS.UPDATE_CHECKING_ENABLED - ), + savedViews: {}, + mailAccounts: {}, + mailRules: {}, } } ngOnInit() { this.savedViewService.listAll().subscribe((r) => { this.savedViews = r.results - this.initialize() + + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + + this.initialize() + }) + }) }) } @@ -176,6 +204,76 @@ export class SettingsComponent ) } + for (let account of this.mailAccounts) { + storeData.mailAccounts[account.id.toString()] = { + id: account.id, + name: account.name, + imap_server: account.imap_server, + imap_port: account.imap_port, + imap_security: account.imap_security, + username: account.username, + password: account.password, + character_set: account.character_set, + } + this.mailAccountGroup.addControl( + account.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + imap_server: new FormControl(null), + imap_port: new FormControl(null), + imap_security: new FormControl(null), + username: new FormControl(null), + password: new FormControl(null), + character_set: new FormControl(null), + }) + ) + } + + for (let rule of this.mailRules) { + storeData.mailRules[rule.id.toString()] = { + name: rule.name, + order: rule.order, + account: rule.account, + folder: rule.folder, + filter_from: rule.filter_from, + filter_subject: rule.filter_subject, + filter_body: rule.filter_body, + filter_attachment_filename: rule.filter_attachment_filename, + maximum_age: rule.maximum_age, + attachment_type: rule.attachment_type, + action: rule.action, + action_parameter: rule.action_parameter, + assign_title_from: rule.assign_title_from, + assign_tags: rule.assign_tags, + assign_document_type: rule.assign_document_type, + assign_correspondent_from: rule.assign_correspondent_from, + assign_correspondent: rule.assign_correspondent, + } + this.mailRuleGroup.addControl( + rule.id.toString(), + new FormGroup({ + name: new FormControl(null), + order: new FormControl(null), + account: new FormControl(null), + folder: new FormControl(null), + filter_from: new FormControl(null), + filter_subject: new FormControl(null), + filter_body: new FormControl(null), + filter_attachment_filename: new FormControl(null), + maximum_age: new FormControl(null), + attachment_type: new FormControl(null), + action: new FormControl(null), + action_parameter: new FormControl(null), + assign_title_from: new FormControl(null), + assign_tags: new FormControl(null), + assign_document_type: new FormControl(null), + assign_correspondent_from: new FormControl(null), + assign_correspondent: new FormControl(null), + }) + ) + } + this.store = new BehaviorSubject(storeData) this.storeSub = this.store.asObservable().subscribe((state) => { diff --git a/src-ui/src/app/data/paperless-mail-account.ts b/src-ui/src/app/data/paperless-mail-account.ts new file mode 100644 index 000000000..243caa9bd --- /dev/null +++ b/src-ui/src/app/data/paperless-mail-account.ts @@ -0,0 +1,23 @@ +import { ObjectWithId } from './object-with-id' + +export enum IMAPSecurity { + None = 0, + SSL = 1, + STARTTLS = 2, +} + +export interface PaperlessMailAccount extends ObjectWithId { + name: string + + imap_server: string + + imap_port: number + + imap_security: IMAPSecurity + + username: string + + password: string + + character_set?: string +} diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts new file mode 100644 index 000000000..0b54619a6 --- /dev/null +++ b/src-ui/src/app/data/paperless-mail-rule.ts @@ -0,0 +1,66 @@ +import { ObjectWithId } from './object-with-id' +import { PaperlessCorrespondent } from './paperless-correspondent' +import { PaperlessDocumentType } from './paperless-document-type' +import { PaperlessMailAccount } from './paperless-mail-account' +import { PaperlessTag } from './paperless-tag' + +export enum MailFilterAttachmentType { + Attachments = 1, + Everything = 2, +} + +export enum MailAction { + Delete = 1, + Move = 2, + MarkRead = 3, + Flag = 4, + Tag = 5, +} + +export enum MailMetadataTitleOption { + FromSubject = 1, + FromFilename = 2, +} + +export enum MailMetadataCorrespondentOption { + FromNothing = 1, + FromEmail = 2, + FromName = 3, + FromCustom = 4, +} + +export interface PaperlessMailRule extends ObjectWithId { + name: string + + order: number + + account: PaperlessMailAccount + + folder: string + + filter_from: string + + filter_subject: string + + filter_body: string + + filter_attachment_filename: string + + maximum_age: number + + attachment_type: MailFilterAttachmentType + + action: MailAction + + action_parameter?: string + + assign_title_from: MailMetadataTitleOption + + assign_tags?: PaperlessTag[] + + assign_document_type?: PaperlessDocumentType + + assign_correspondent_from?: MailMetadataCorrespondentOption + + assign_correspondent?: PaperlessCorrespondent +} diff --git a/src-ui/src/app/services/rest/mail-account.service.ts b/src-ui/src/app/services/rest/mail-account.service.ts new file mode 100644 index 000000000..a4db86684 --- /dev/null +++ b/src-ui/src/app/services/rest/mail-account.service.ts @@ -0,0 +1,52 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { combineLatest, Observable } from 'rxjs' +import { tap } from 'rxjs/operators' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' +import { AbstractPaperlessService } from './abstract-paperless-service' + +@Injectable({ + providedIn: 'root', +}) +export class MailAccountService extends AbstractPaperlessService { + loading: boolean + + constructor(http: HttpClient) { + super(http, 'mail_accounts') + this.reload() + } + + private reload() { + this.loading = true + this.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.loading = false + }) + } + + private mailAccounts: PaperlessMailAccount[] = [] + + get allAccounts() { + return this.mailAccounts + } + + create(o: PaperlessMailAccount) { + return super.create(o).pipe(tap(() => this.reload())) + } + + update(o: PaperlessMailAccount) { + return super.update(o).pipe(tap(() => this.reload())) + } + + patchMany( + objects: PaperlessMailAccount[] + ): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + + delete(o: PaperlessMailAccount) { + return super.delete(o).pipe(tap(() => this.reload())) + } +} diff --git a/src-ui/src/app/services/rest/mail-rule.service.ts b/src-ui/src/app/services/rest/mail-rule.service.ts new file mode 100644 index 000000000..4e7148496 --- /dev/null +++ b/src-ui/src/app/services/rest/mail-rule.service.ts @@ -0,0 +1,50 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { combineLatest, Observable } from 'rxjs' +import { tap } from 'rxjs/operators' +import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' +import { AbstractPaperlessService } from './abstract-paperless-service' + +@Injectable({ + providedIn: 'root', +}) +export class MailRuleService extends AbstractPaperlessService { + loading: boolean + + constructor(http: HttpClient) { + super(http, 'mail_rules') + this.reload() + } + + private reload() { + this.loading = true + this.listAll().subscribe((r) => { + this.mailRules = r.results + this.loading = false + }) + } + + private mailRules: PaperlessMailRule[] = [] + + get allRules() { + return this.mailRules + } + + create(o: PaperlessMailRule) { + return super.create(o).pipe(tap(() => this.reload())) + } + + update(o: PaperlessMailRule) { + return super.update(o).pipe(tap(() => this.reload())) + } + + patchMany(objects: PaperlessMailRule[]): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + + delete(o: PaperlessMailRule) { + return super.delete(o).pipe(tap(() => this.reload())) + } +} diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index db282cacd..86e0f4a12 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -28,6 +28,8 @@ from .models import UiSettings from .models import PaperlessTask from .parsers import is_mime_type_supported +from paperless_mail.models import MailAccount, MailRule + # https://www.django-rest-framework.org/api-guide/serializers/#example class DynamicFieldsModelSerializer(serializers.ModelSerializer): @@ -688,3 +690,61 @@ class AcknowledgeTasksViewSerializer(serializers.Serializer): def validate_tasks(self, tasks): self._validate_task_id_list(tasks) return tasks + + +class MailAccountSerializer(serializers.ModelSerializer): + class Meta: + model = MailAccount + depth = 1 + fields = [ + "id", + "name", + "imap_server", + "imap_port", + "imap_security", + "username", + "password", + "character_set", + ] + + def update(self, instance, validated_data): + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + mail_account = MailAccount.objects.create(**validated_data) + return mail_account + + +class MailRuleSerializer(serializers.ModelSerializer): + class Meta: + model = MailRule + depth = 1 + fields = [ + "id", + "name", + "account", + "folder", + "filter_from", + "filter_subject", + "filter_body", + "filter_attachment_filename", + "maximum_age", + "action", + "action_parameter", + "assign_title_from", + "assign_tags", + "assign_correspondent_from", + "assign_correspondent", + "assign_document_type", + "order", + "attachment_type", + ] + + def update(self, instance, validated_data): + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + mail_rule = MailRule.objects.create(**validated_data) + return mail_rule diff --git a/src/documents/views.py b/src/documents/views.py index 10225be6f..f980805f2 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -33,6 +33,8 @@ from packaging import version as packaging_version from paperless import version from paperless.db import GnuPG from paperless.views import StandardPagination +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule from rest_framework import parsers from rest_framework.decorators import action from rest_framework.exceptions import NotFound @@ -81,6 +83,8 @@ from .serialisers import CorrespondentSerializer from .serialisers import DocumentListSerializer from .serialisers import DocumentSerializer from .serialisers import DocumentTypeSerializer +from .serialisers import MailAccountSerializer +from .serialisers import MailRuleSerializer from .serialisers import PostDocumentSerializer from .serialisers import SavedViewSerializer from .serialisers import StoragePathSerializer @@ -910,3 +914,37 @@ class AcknowledgeTasksView(GenericAPIView): return Response({"result": result}) except Exception: return HttpResponseBadRequest() + + +class MailAccountViewSet(ModelViewSet): + model = MailAccount + + queryset = MailAccount.objects.all() + serializer_class = MailAccountSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailAccount.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user) + + +class MailRuleViewSet(ModelViewSet): + model = MailRule + + queryset = MailRule.objects.all() + serializer_class = MailRuleSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailRule.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user) diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 46309e1e6..afad7cb9f 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -14,6 +14,8 @@ from documents.views import CorrespondentViewSet from documents.views import DocumentTypeViewSet from documents.views import IndexView from documents.views import LogViewSet +from documents.views import MailAccountViewSet +from documents.views import MailRuleViewSet from documents.views import PostDocumentView from documents.views import RemoteVersionView from documents.views import SavedViewViewSet @@ -39,6 +41,8 @@ api_router.register(r"tags", TagViewSet) api_router.register(r"saved_views", SavedViewViewSet) api_router.register(r"storage_paths", StoragePathViewSet) api_router.register(r"tasks", TasksViewSet, basename="tasks") +api_router.register(r"mail_accounts", MailAccountViewSet) +api_router.register(r"mail_rules", MailRuleViewSet) urlpatterns = [ From c41d1a78a86d1ac585ac03e424d733087ca3fe09 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 8 Nov 2022 10:53:41 -0800 Subject: [PATCH 02/26] remove unused toastService from edit dialogs and add confirmation --- .../correspondent-edit-dialog.component.ts | 9 ++---- .../document-type-edit-dialog.component.ts | 9 ++---- .../edit-dialog/edit-dialog.component.ts | 5 +-- .../tag-edit-dialog.component.ts | 9 ++---- .../management-list.component.ts | 32 ++++++++++++++++--- 5 files changed, 35 insertions(+), 29 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts index 86be7414d..7361e5e4b 100644 --- a/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' import { CorrespondentService } from 'src/app/services/rest/correspondent.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-correspondent-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./correspondent-edit-dialog.component.scss'], }) export class CorrespondentEditDialogComponent extends EditDialogComponent { - constructor( - service: CorrespondentService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: CorrespondentService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts index bcd2363fd..d565e66e1 100644 --- a/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' import { DocumentTypeService } from 'src/app/services/rest/document-type.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-document-type-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./document-type-edit-dialog.component.scss'], }) export class DocumentTypeEditDialogComponent extends EditDialogComponent { - constructor( - service: DocumentTypeService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: DocumentTypeService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts index 92b16a93d..e87eed438 100644 --- a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts @@ -2,11 +2,9 @@ import { Directive, EventEmitter, Input, OnInit, Output } from '@angular/core' import { FormGroup } from '@angular/forms' import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { Observable } from 'rxjs' -import { map } from 'rxjs/operators' import { MATCHING_ALGORITHMS, MATCH_AUTO } from 'src/app/data/matching-model' import { ObjectWithId } from 'src/app/data/object-with-id' import { AbstractPaperlessService } from 'src/app/services/rest/abstract-paperless-service' -import { ToastService } from 'src/app/services/toast.service' @Directive() export abstract class EditDialogComponent @@ -14,8 +12,7 @@ export abstract class EditDialogComponent { constructor( private service: AbstractPaperlessService, - private activeModal: NgbActiveModal, - private toastService: ToastService + private activeModal: NgbActiveModal ) {} @Input() diff --git a/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts index 18d476dfe..db106d990 100644 --- a/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts @@ -4,7 +4,6 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' import { PaperlessTag } from 'src/app/data/paperless-tag' import { TagService } from 'src/app/services/rest/tag.service' -import { ToastService } from 'src/app/services/toast.service' import { randomColor } from 'src/app/utils/color' import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' @@ -14,12 +13,8 @@ import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' styleUrls: ['./tag-edit-dialog.component.scss'], }) export class TagEditDialogComponent extends EditDialogComponent { - constructor( - service: TagService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: TagService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/manage/management-list/management-list.component.ts b/src-ui/src/app/components/manage/management-list/management-list.component.ts index 317cf6fee..d0864d6f5 100644 --- a/src-ui/src/app/components/manage/management-list/management-list.component.ts +++ b/src-ui/src/app/components/manage/management-list/management-list.component.ts @@ -120,8 +120,20 @@ export abstract class ManagementListComponent backdrop: 'static', }) activeModal.componentInstance.dialogMode = 'create' - activeModal.componentInstance.success.subscribe((o) => { - this.reloadData() + activeModal.componentInstance.success.subscribe({ + next: () => { + this.reloadData() + this.toastService.showInfo( + $localize`Successfully created ${this.typeName}.` + ) + }, + error: (e) => { + this.toastService.showInfo( + $localize`Error occurred while creating ${ + this.typeName + } : ${e.toString()}.` + ) + }, }) } @@ -131,8 +143,20 @@ export abstract class ManagementListComponent }) activeModal.componentInstance.object = object activeModal.componentInstance.dialogMode = 'edit' - activeModal.componentInstance.success.subscribe((o) => { - this.reloadData() + activeModal.componentInstance.success.subscribe({ + next: () => { + this.reloadData() + this.toastService.showInfo( + $localize`Successfully updated ${this.typeName}.` + ) + }, + error: (e) => { + this.toastService.showInfo( + $localize`Error occurred while saving ${ + this.typeName + } : ${e.toString()}.` + ) + }, }) } From 6f25917c86a5152ae1ec3988cd42f4dc7b76df66 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 8 Nov 2022 11:11:35 -0800 Subject: [PATCH 03/26] Mail account edit dialog --- src-ui/src/app/app.module.ts | 4 ++ .../mail-account-edit-dialog.component.html | 26 +++++++++++ .../mail-account-edit-dialog.component.scss | 0 .../mail-account-edit-dialog.component.ts | 45 ++++++++++++++++++ .../storage-path-edit-dialog.component.ts | 9 +--- .../input/password/password.component.html | 8 ++++ .../input/password/password.component.scss | 0 .../input/password/password.component.ts | 21 +++++++++ .../manage/settings/settings.component.html | 46 +++++++++++++------ .../manage/settings/settings.component.ts | 33 ++++++++++++- src-ui/src/app/data/paperless-mail-account.ts | 12 +++-- 11 files changed, 180 insertions(+), 24 deletions(-) create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.scss create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts create mode 100644 src-ui/src/app/components/common/input/password/password.component.html create mode 100644 src-ui/src/app/components/common/input/password/password.component.scss create mode 100644 src-ui/src/app/components/common/input/password/password.component.ts diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index 3d0a7e3c7..4a65209b9 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -39,6 +39,7 @@ import { NgxFileDropModule } from 'ngx-file-drop' import { TextComponent } from './components/common/input/text/text.component' import { SelectComponent } from './components/common/input/select/select.component' import { CheckComponent } from './components/common/input/check/check.component' +import { PasswordComponent } from './components/common/input/password/password.component' import { SaveViewConfigDialogComponent } from './components/document-list/save-view-config-dialog/save-view-config-dialog.component' import { TagsComponent } from './components/common/input/tags/tags.component' import { SortableDirective } from './directives/sortable.directive' @@ -76,6 +77,7 @@ import { StoragePathEditDialogComponent } from './components/common/edit-dialog/ import { SettingsService } from './services/settings.service' import { TasksComponent } from './components/manage/tasks/tasks.component' import { TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap' +import { MailAccountEditDialogComponent } from './components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' import localeBe from '@angular/common/locales/be' import localeCs from '@angular/common/locales/cs' @@ -142,6 +144,7 @@ function initializeApp(settings: SettingsService) { TagEditDialogComponent, DocumentTypeEditDialogComponent, StoragePathEditDialogComponent, + MailAccountEditDialogComponent, TagComponent, ClearableBadge, PageHeaderComponent, @@ -157,6 +160,7 @@ function initializeApp(settings: SettingsService) { TextComponent, SelectComponent, CheckComponent, + PasswordComponent, SaveViewConfigDialogComponent, TagsComponent, SortableDirective, diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html new file mode 100644 index 000000000..807df18c5 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html @@ -0,0 +1,26 @@ +
    +
    + + +
    +
    +
    +
    + + + + +
    +
    + + + +
    +
    +
    +
    + + +
    +
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.scss b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts new file mode 100644 index 000000000..f4d395b03 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts @@ -0,0 +1,45 @@ +import { Component } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' +import { + IMAPSecurity, + IMAPSecurityLabels, + PaperlessMailAccount, +} from 'src/app/data/paperless-mail-account' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' + +@Component({ + selector: 'app-mail-account-edit-dialog', + templateUrl: './mail-account-edit-dialog.component.html', + styleUrls: ['./mail-account-edit-dialog.component.scss'], +}) +export class MailAccountEditDialogComponent extends EditDialogComponent { + constructor(service: MailAccountService, activeModal: NgbActiveModal) { + super(service, activeModal) + } + + getCreateTitle() { + return $localize`Create new mail account` + } + + getEditTitle() { + return $localize`Edit mail account` + } + + getForm(): FormGroup { + return new FormGroup({ + name: new FormControl(null), + imap_server: new FormControl(null), + imap_port: new FormControl(null), + imap_security: new FormControl(IMAPSecurity.SSL), + username: new FormControl(null), + password: new FormControl(null), + character_set: new FormControl('UTF-8'), + }) + } + + get imapSecurityOptions() { + return IMAPSecurityLabels + } +} diff --git a/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts index 011c15e73..1dfef00c5 100644 --- a/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path' import { StoragePathService } from 'src/app/services/rest/storage-path.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-storage-path-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./storage-path-edit-dialog.component.scss'], }) export class StoragePathEditDialogComponent extends EditDialogComponent { - constructor( - service: StoragePathService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: StoragePathService, activeModal: NgbActiveModal) { + super(service, activeModal) } get pathHint() { diff --git a/src-ui/src/app/components/common/input/password/password.component.html b/src-ui/src/app/components/common/input/password/password.component.html new file mode 100644 index 000000000..57cdd6de8 --- /dev/null +++ b/src-ui/src/app/components/common/input/password/password.component.html @@ -0,0 +1,8 @@ +
    + + + +
    + {{error}} +
    +
    diff --git a/src-ui/src/app/components/common/input/password/password.component.scss b/src-ui/src/app/components/common/input/password/password.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/input/password/password.component.ts b/src-ui/src/app/components/common/input/password/password.component.ts new file mode 100644 index 000000000..3216dbed2 --- /dev/null +++ b/src-ui/src/app/components/common/input/password/password.component.ts @@ -0,0 +1,21 @@ +import { Component, forwardRef } from '@angular/core' +import { NG_VALUE_ACCESSOR } from '@angular/forms' +import { AbstractInputComponent } from '../abstract-input' + +@Component({ + providers: [ + { + provide: NG_VALUE_ACCESSOR, + useExisting: forwardRef(() => PasswordComponent), + multi: true, + }, + ], + selector: 'app-input-password', + templateUrl: './password.component.html', + styleUrls: ['./password.component.scss'], +}) +export class PasswordComponent extends AbstractInputComponent { + constructor() { + super() + } +} diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 9ba010c0e..423002e83 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -222,28 +222,48 @@

    Mail accounts

    -
    +
      -
      -
      - {{account.name}} +
    • +
      +
      Name
      +
      Server
      +
       
      -
      • + + +
    • +
      +
      +
      {{account.imap_server}}
      +
      +
      +
      • No mail accounts defined.
      -
      +
    -

    Mail rules

    -
    +

    Mail rules

    +
      -
      -
      - {{rule.name}} +
    • +
      +
      Name
      +
      Account
      +
       
      -
      • + + +
    • +
      +
      +
      {{rule.account.name}}
      +
      +
      +
      • No mail rules defined.
      -
      +
    diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index c6ffc13db..d87ae2137 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -33,6 +33,8 @@ import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' import { MailAccountService as MailAccountService } from 'src/app/services/rest/mail-account.service' import { MailRuleService } from 'src/app/services/rest/mail-rule.service' +import { NgbModal } from '@ng-bootstrap/ng-bootstrap' +import { MailAccountEditDialogComponent } from '../../common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' @Component({ selector: 'app-settings', @@ -104,7 +106,8 @@ export class SettingsComponent @Inject(LOCALE_ID) public currentLocale: string, private viewportScroller: ViewportScroller, private activatedRoute: ActivatedRoute, - public readonly tourService: TourService + public readonly tourService: TourService, + private modalService: NgbModal ) { this.settings.settingsSaved.subscribe(() => { if (!this.savePending) this.initialize() @@ -470,4 +473,32 @@ export class SettingsComponent clearThemeColor() { this.settingsForm.get('themeColor').patchValue('') } + + editMailAccount(account: PaperlessMailAccount) { + console.log(account) + + var modal = this.modalService.open(MailAccountEditDialogComponent, { + backdrop: 'static', + size: 'xl', + }) + modal.componentInstance.dialogMode = 'edit' + modal.componentInstance.object = account + // modal.componentInstance.success + // .pipe( + // switchMap((newStoragePath) => { + // return this.storagePathService + // .listAll() + // .pipe(map((storagePaths) => ({ newStoragePath, storagePaths }))) + // }) + // ) + // .pipe(takeUntil(this.unsubscribeNotifier)) + // .subscribe(({ newStoragePath, storagePaths }) => { + // this.storagePaths = storagePaths.results + // this.documentForm.get('storage_path').setValue(newStoragePath.id) + // }) + } + + editMailRule(rule: PaperlessMailRule) { + console.log(rule) + } } diff --git a/src-ui/src/app/data/paperless-mail-account.ts b/src-ui/src/app/data/paperless-mail-account.ts index 243caa9bd..ea5c17a1b 100644 --- a/src-ui/src/app/data/paperless-mail-account.ts +++ b/src-ui/src/app/data/paperless-mail-account.ts @@ -1,11 +1,17 @@ import { ObjectWithId } from './object-with-id' export enum IMAPSecurity { - None = 0, - SSL = 1, - STARTTLS = 2, + None = 1, + SSL = 2, + STARTTLS = 3, } +export const IMAPSecurityLabels: Array<{ id: number; name: string }> = [ + { id: IMAPSecurity.None, name: $localize`No encryption` }, + { id: IMAPSecurity.SSL, name: $localize`SSL` }, + { id: IMAPSecurity.STARTTLS, name: $localize`STARTTLS` }, +] + export interface PaperlessMailAccount extends ObjectWithId { name: string From 9231df7a4a9e0a4df28b11a5c4bd34fbcf9defe3 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 8 Nov 2022 11:50:57 -0800 Subject: [PATCH 04/26] Mail rule edit dialog --- src-ui/src/app/app.module.ts | 4 +- .../mail-rule-edit-dialog.component.html | 37 +++++++ .../mail-rule-edit-dialog.component.scss | 0 .../mail-rule-edit-dialog.component.ts | 98 +++++++++++++++++++ .../common/input/tags/tags.component.html | 4 +- .../common/input/tags/tags.component.ts | 3 + .../manage/settings/settings.component.ts | 23 +++++ src-ui/src/app/data/paperless-mail-rule.ts | 67 +++++++++++++ src-ui/src/styles.scss | 10 +- 9 files changed, 239 insertions(+), 7 deletions(-) create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.scss create mode 100644 src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index 4a65209b9..ea366b968 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -78,6 +78,7 @@ import { SettingsService } from './services/settings.service' import { TasksComponent } from './components/manage/tasks/tasks.component' import { TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap' import { MailAccountEditDialogComponent } from './components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' +import { MailRuleEditDialogComponent } from './components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component' import localeBe from '@angular/common/locales/be' import localeCs from '@angular/common/locales/cs' @@ -144,7 +145,6 @@ function initializeApp(settings: SettingsService) { TagEditDialogComponent, DocumentTypeEditDialogComponent, StoragePathEditDialogComponent, - MailAccountEditDialogComponent, TagComponent, ClearableBadge, PageHeaderComponent, @@ -184,6 +184,8 @@ function initializeApp(settings: SettingsService) { DocumentAsnComponent, DocumentCommentsComponent, TasksComponent, + MailAccountEditDialogComponent, + MailRuleEditDialogComponent, ], imports: [ BrowserModule, diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html new file mode 100644 index 000000000..0b7891e81 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -0,0 +1,37 @@ +
    +
    + + +
    +
    +
    +
    + + + + + + + +
    +
    + + + + +
    +
    + + + + + +
    +
    +
    +
    + + +
    +
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.scss b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts new file mode 100644 index 000000000..c4faf86ab --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -0,0 +1,98 @@ +import { Component } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { first } from 'rxjs' +import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' +import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' +import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' +import { + MailAction, + MailActionOptions, + MailFilterAttachmentType, + MailFilterAttachmentTypeOptions, + MailMetadataCorrespondentOption, + MailMetadataCorrespondentOptionOptions, + MailMetadataTitleOption, + MailMetadataTitleOptionOptions, + PaperlessMailRule, +} from 'src/app/data/paperless-mail-rule' +import { CorrespondentService } from 'src/app/services/rest/correspondent.service' +import { DocumentTypeService } from 'src/app/services/rest/document-type.service' +import { MailRuleService } from 'src/app/services/rest/mail-rule.service' + +@Component({ + selector: 'app-mail-rule-edit-dialog', + templateUrl: './mail-rule-edit-dialog.component.html', + styleUrls: ['./mail-rule-edit-dialog.component.scss'], +}) +export class MailRuleEditDialogComponent extends EditDialogComponent { + correspondents: PaperlessCorrespondent[] + documentTypes: PaperlessDocumentType[] + + constructor( + service: MailRuleService, + activeModal: NgbActiveModal, + correspondentService: CorrespondentService, + documentTypeService: DocumentTypeService + ) { + super(service, activeModal) + + correspondentService + .listAll() + .pipe(first()) + .subscribe((result) => (this.correspondents = result.results)) + + documentTypeService + .listAll() + .pipe(first()) + .subscribe((result) => (this.documentTypes = result.results)) + } + + getCreateTitle() { + return $localize`Create new mail rule` + } + + getEditTitle() { + return $localize`Edit mail rule` + } + + getForm(): FormGroup { + return new FormGroup({ + name: new FormControl(null), + order: new FormControl(null), + account: new FormControl(null), + folder: new FormControl('INBOX'), + filter_from: new FormControl(null), + filter_subject: new FormControl(null), + filter_body: new FormControl(null), + filter_attachment_filename: new FormControl(null), + maximum_age: new FormControl(null), + attachment_type: new FormControl(MailFilterAttachmentType.Attachments), + action: new FormControl(MailAction.MarkRead), + action_parameter: new FormControl(null), + assign_title_from: new FormControl(MailMetadataTitleOption.FromSubject), + assign_tags: new FormControl(null), + assign_document_type: new FormControl(null), + assign_correspondent_from: new FormControl( + MailMetadataCorrespondentOption.FromNothing + ), + assign_correspondent: new FormControl(null), + }) + } + + get attachmentTypeOptions() { + return MailFilterAttachmentTypeOptions + } + + get actionOptions() { + return MailActionOptions + } + + get metadataTitleOptions() { + return MailMetadataTitleOptionOptions + } + + get metadataCorrespondentOptions() { + return MailMetadataCorrespondentOptionOptions + } +} diff --git a/src-ui/src/app/components/common/input/tags/tags.component.html b/src-ui/src/app/components/common/input/tags/tags.component.html index 77e25d88d..14de0f98a 100644 --- a/src-ui/src/app/components/common/input/tags/tags.component.html +++ b/src-ui/src/app/components/common/input/tags/tags.component.html @@ -7,7 +7,7 @@ [closeOnSelect]="false" [clearSearchOnAdd]="true" [hideSelected]="true" - [addTag]="createTagRef" + [addTag]="allowCreate ? createTagRef : false" addTagText="Add tag" i18n-addTagText (change)="onChange(value)" @@ -31,7 +31,7 @@ -
    {{account.imap_server}}
    -
    +
    +
    + + +
    +
    @@ -244,21 +249,26 @@

    Mail rules

    -
      +
        -
      • +
      • Name
        Account
        -
         
        +
        Actions
        • -
      • +
      • {{rule.account.name}}
        -
        +
        +
        + + +
        +
        • diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 6afc0d9c6..8efbb486e 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -36,6 +36,7 @@ import { MailRuleService } from 'src/app/services/rest/mail-rule.service' import { NgbModal } from '@ng-bootstrap/ng-bootstrap' import { MailAccountEditDialogComponent } from '../../common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' import { MailRuleEditDialogComponent } from '../../common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' @Component({ selector: 'app-settings', @@ -500,6 +501,21 @@ export class SettingsComponent // }) } + deleteMailAccount(account: PaperlessMailAccount) { + let modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete mail account` + modal.componentInstance.messageBold = $localize`This operation will permanently this mail account.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Proceed` + modal.componentInstance.confirmClicked.subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.mailAccountService.delete(account) + }) + } + editMailRule(rule: PaperlessMailRule) { console.log(rule) @@ -524,4 +540,19 @@ export class SettingsComponent // this.documentForm.get('storage_path').setValue(newStoragePath.id) // }) } + + deleteMailRule(rule: PaperlessMailRule) { + let modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete mail rule` + modal.componentInstance.messageBold = $localize`This operation will permanently this mail rule.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Proceed` + modal.componentInstance.confirmClicked.subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.mailRuleService.delete(rule) + }) + } } From 997bff4917d5ef8c9426d3751927b4afcf9d2e6f Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 9 Nov 2022 02:40:45 -0800 Subject: [PATCH 06/26] Update deprecated edit-dialog rxjs --- .../common/edit-dialog/edit-dialog.component.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts index e87eed438..9bf141e78 100644 --- a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts @@ -92,16 +92,16 @@ export abstract class EditDialogComponent break } this.networkActive = true - serverResponse.subscribe( - (result) => { + serverResponse.subscribe({ + next: (result) => { this.activeModal.close() this.success.emit(result) }, - (error) => { + error: (error) => { this.error = error.error this.networkActive = false - } - ) + }, + }) } cancel() { From 18ad9bcbf2865f27ca8a04bc37b210c9c8c3eb86 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 8 Nov 2022 12:18:47 -0800 Subject: [PATCH 07/26] Working mail rule & account edit --- .../mail-rule-edit-dialog.component.html | 13 ++-- .../mail-rule-edit-dialog.component.ts | 9 +++ .../manage/settings/settings.component.html | 8 +-- .../manage/settings/settings.component.ts | 71 ++++++++++--------- src-ui/src/app/data/paperless-mail-rule.ts | 8 +-- src/documents/serialisers.py | 10 +++ 6 files changed, 72 insertions(+), 47 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html index 0b7891e81..876b7b179 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -9,15 +9,16 @@
        - + - - - -
        -
        +
        +
        + + + +
        diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index c4faf86ab..d820e3d5d 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -5,6 +5,7 @@ import { first } from 'rxjs' import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' import { MailAction, MailActionOptions, @@ -18,6 +19,7 @@ import { } from 'src/app/data/paperless-mail-rule' import { CorrespondentService } from 'src/app/services/rest/correspondent.service' import { DocumentTypeService } from 'src/app/services/rest/document-type.service' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' import { MailRuleService } from 'src/app/services/rest/mail-rule.service' @Component({ @@ -26,17 +28,24 @@ import { MailRuleService } from 'src/app/services/rest/mail-rule.service' styleUrls: ['./mail-rule-edit-dialog.component.scss'], }) export class MailRuleEditDialogComponent extends EditDialogComponent { + accounts: PaperlessMailAccount[] correspondents: PaperlessCorrespondent[] documentTypes: PaperlessDocumentType[] constructor( service: MailRuleService, activeModal: NgbActiveModal, + accountService: MailAccountService, correspondentService: CorrespondentService, documentTypeService: DocumentTypeService ) { super(service, activeModal) + accountService + .listAll() + .pipe(first()) + .subscribe((result) => (this.accounts = result.results)) + correspondentService .listAll() .pipe(first()) diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 03cc9f02e..0aec87033 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -234,8 +234,8 @@
      • -
        -
        {{account.imap_server}}
        +
        +
        {{account.imap_server}}
        @@ -261,8 +261,8 @@
      • -
        -
        {{rule.account.name}}
        +
        +
        {{(mailAccountService.getCached(rule.account) | async)?.name}}
        diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 8efbb486e..818ad6b14 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -31,7 +31,7 @@ import { ViewportScroller } from '@angular/common' import { TourService } from 'ngx-ui-tour-ng-bootstrap' import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' -import { MailAccountService as MailAccountService } from 'src/app/services/rest/mail-account.service' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' import { MailRuleService } from 'src/app/services/rest/mail-rule.service' import { NgbModal } from '@ng-bootstrap/ng-bootstrap' import { MailAccountEditDialogComponent } from '../../common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' @@ -477,28 +477,30 @@ export class SettingsComponent } editMailAccount(account: PaperlessMailAccount) { - console.log(account) - var modal = this.modalService.open(MailAccountEditDialogComponent, { backdrop: 'static', size: 'xl', }) modal.componentInstance.dialogMode = 'edit' modal.componentInstance.object = account - // TODO: saving - // modal.componentInstance.success - // .pipe( - // switchMap((newStoragePath) => { - // return this.storagePathService - // .listAll() - // .pipe(map((storagePaths) => ({ newStoragePath, storagePaths }))) - // }) - // ) - // .pipe(takeUntil(this.unsubscribeNotifier)) - // .subscribe(({ newStoragePath, storagePaths }) => { - // this.storagePaths = storagePaths.results - // this.documentForm.get('storage_path').setValue(newStoragePath.id) - // }) + modal.componentInstance.success + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: (newMailAccount) => { + this.toastService.showInfo( + $localize`Saved account "${newMailAccount.name}".` + ) + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error saving account: ${e.toString()}.` + ) + }, + }) } deleteMailAccount(account: PaperlessMailAccount) { @@ -517,28 +519,31 @@ export class SettingsComponent } editMailRule(rule: PaperlessMailRule) { - console.log(rule) - var modal = this.modalService.open(MailRuleEditDialogComponent, { backdrop: 'static', size: 'xl', }) modal.componentInstance.dialogMode = 'edit' modal.componentInstance.object = rule - // TODO: saving - // modal.componentInstance.success - // .pipe( - // switchMap((newStoragePath) => { - // return this.storagePathService - // .listAll() - // .pipe(map((storagePaths) => ({ newStoragePath, storagePaths }))) - // }) - // ) - // .pipe(takeUntil(this.unsubscribeNotifier)) - // .subscribe(({ newStoragePath, storagePaths }) => { - // this.storagePaths = storagePaths.results - // this.documentForm.get('storage_path').setValue(newStoragePath.id) - // }) + modal.componentInstance.success + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: (newMailRule) => { + this.toastService.showInfo( + $localize`Saved rule "${newMailRule.name}".` + ) + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error saving rule: ${e.toString()}.` + ) + }, + }) } deleteMailRule(rule: PaperlessMailRule) { diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts index 31d734739..0f0e417f8 100644 --- a/src-ui/src/app/data/paperless-mail-rule.ts +++ b/src-ui/src/app/data/paperless-mail-rule.ts @@ -101,7 +101,7 @@ export interface PaperlessMailRule extends ObjectWithId { order: number - account: PaperlessMailAccount + account: number // PaperlessMailAccount.id folder: string @@ -123,11 +123,11 @@ export interface PaperlessMailRule extends ObjectWithId { assign_title_from: MailMetadataTitleOption - assign_tags?: PaperlessTag[] + assign_tags?: number[] // PaperlessTag.id - assign_document_type?: PaperlessDocumentType + assign_document_type?: number // PaperlessDocumentType.id assign_correspondent_from?: MailMetadataCorrespondentOption - assign_correspondent?: PaperlessCorrespondent + assign_correspondent?: number // PaperlessCorrespondent.id } diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 86e0f4a12..d2fa10af9 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -716,7 +716,17 @@ class MailAccountSerializer(serializers.ModelSerializer): return mail_account +class AccountField(serializers.PrimaryKeyRelatedField): + def get_queryset(self): + return MailAccount.objects.all() + + class MailRuleSerializer(serializers.ModelSerializer): + account = AccountField(allow_null=True) + assign_correspondent = CorrespondentField(allow_null=True) + assign_tags = TagsField(many=True) + assign_document_type = DocumentTypeField(allow_null=True) + class Meta: model = MailRule depth = 1 From 2eb2d99a913f4b1dcb8a2d55393e5e96794cb17b Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 9 Nov 2022 03:43:57 -0800 Subject: [PATCH 08/26] Update frontend fixtures & tests for compatibility --- src-ui/cypress/e2e/settings/settings.cy.ts | 16 +++++-- .../fixtures/mail_accounts/mail_accounts.json | 27 +++++++++++ .../fixtures/mail_rules/mail_rules.json | 29 ++++++++++++ .../fixtures/saved_views/savedviews.json | 45 ++++++++++++++++++- 4 files changed, 113 insertions(+), 4 deletions(-) create mode 100644 src-ui/cypress/fixtures/mail_accounts/mail_accounts.json create mode 100644 src-ui/cypress/fixtures/mail_rules/mail_rules.json diff --git a/src-ui/cypress/e2e/settings/settings.cy.ts b/src-ui/cypress/e2e/settings/settings.cy.ts index 0480e39ce..7752fdf61 100644 --- a/src-ui/cypress/e2e/settings/settings.cy.ts +++ b/src-ui/cypress/e2e/settings/settings.cy.ts @@ -35,6 +35,16 @@ describe('settings', () => { req.reply(response) } ).as('savedViews') + + cy.intercept('http://localhost:8000/api/mail_accounts/*', { + fixture: 'mail_accounts/mail_accounts.json', + }) + cy.intercept('http://localhost:8000/api/mail_rules/*', { + fixture: 'mail_rules/mail_rules.json', + }).as('mailRules') + cy.intercept('http://localhost:8000/api/tasks/', { + fixture: 'tasks/tasks.json', + }) }) cy.fixture('documents/documents.json').then((documentsJson) => { @@ -48,7 +58,7 @@ describe('settings', () => { cy.viewport(1024, 1600) cy.visit('/settings') - cy.wait('@savedViews') + cy.wait('@mailRules') }) it('should activate / deactivate save button when settings change and are saved', () => { @@ -64,7 +74,7 @@ describe('settings', () => { cy.contains('a', 'Dashboard').click() cy.contains('You have unsaved changes') cy.contains('button', 'Cancel').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.contains('a', 'Dashboard').click() cy.contains('You have unsaved changes').should('not.exist') }) @@ -77,7 +87,7 @@ describe('settings', () => { }) it('should remove saved view from sidebar when unset', () => { - cy.contains('a', 'Saved views').click() + cy.contains('a', 'Saved views').click().wait(2000) cy.get('#show_in_sidebar_1').click() cy.contains('button', 'Save').click().wait('@savedViews') cy.contains('li', 'Inbox').should('not.exist') diff --git a/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json b/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json new file mode 100644 index 000000000..19c45b15a --- /dev/null +++ b/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json @@ -0,0 +1,27 @@ +{ + "count": 2, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "IMAP Server", + "imap_server": "imap.example.com", + "imap_port": 993, + "imap_security": 2, + "username": "inbox@example.com", + "password": "pass", + "character_set": "UTF-8" + }, + { + "id": 2, + "name": "Gmail", + "imap_server": "imap.gmail.com", + "imap_port": 993, + "imap_security": 2, + "username": "user@gmail.com", + "password": "pass", + "character_set": "UTF-8" + } + ] +} diff --git a/src-ui/cypress/fixtures/mail_rules/mail_rules.json b/src-ui/cypress/fixtures/mail_rules/mail_rules.json new file mode 100644 index 000000000..a2c59c5c6 --- /dev/null +++ b/src-ui/cypress/fixtures/mail_rules/mail_rules.json @@ -0,0 +1,29 @@ +{ + "count": 1, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "Gmail", + "account": 2, + "folder": "INBOX", + "filter_from": null, + "filter_subject": "[paperless]", + "filter_body": null, + "filter_attachment_filename": null, + "maximum_age": 30, + "action": 3, + "action_parameter": null, + "assign_title_from": 1, + "assign_tags": [ + 9 + ], + "assign_correspondent_from": 1, + "assign_correspondent": 2, + "assign_document_type": null, + "order": 0, + "attachment_type": 2 + } + ] +} diff --git a/src-ui/cypress/fixtures/saved_views/savedviews.json b/src-ui/cypress/fixtures/saved_views/savedviews.json index 003bd900a..64afcf3dc 100644 --- a/src-ui/cypress/fixtures/saved_views/savedviews.json +++ b/src-ui/cypress/fixtures/saved_views/savedviews.json @@ -1 +1,44 @@ -{"count":3,"next":null,"previous":null,"results":[{"id":1,"name":"Inbox","show_on_dashboard":true,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"18"}]},{"id":2,"name":"Recently Added","show_on_dashboard":true,"show_in_sidebar":false,"sort_field":"created","sort_reverse":true,"filter_rules":[]},{"id":11,"name":"Taxes","show_on_dashboard":false,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"39"}]}]} +{ + "count": 3, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "Inbox", + "show_on_dashboard": true, + "show_in_sidebar": true, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [ + { + "rule_type": 6, + "value": "18" + } + ] + }, + { + "id": 2, + "name": "Recently Added", + "show_on_dashboard": true, + "show_in_sidebar": false, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [] + }, + { + "id": 11, + "name": "Taxes", + "show_on_dashboard": false, + "show_in_sidebar": true, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [ + { + "rule_type": 6, + "value": "39" + } + ] + } + ] +} From 98cdf614a576618a96035ff7dcc93849199ea52d Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 9 Nov 2022 19:59:35 -0800 Subject: [PATCH 09/26] Mail form tweaks Include add button Include add button --- .../mail-account-edit-dialog.component.ts | 7 +- .../mail-rule-edit-dialog.component.html | 15 ++-- .../mail-rule-edit-dialog.component.ts | 75 +++++++++++++++++-- .../common/input/number/number.component.html | 2 +- .../common/input/number/number.component.ts | 5 +- .../manage/settings/settings.component.html | 49 +++++++----- .../manage/settings/settings.component.ts | 4 +- src-ui/src/app/data/paperless-mail-account.ts | 6 -- src-ui/src/app/data/paperless-mail-rule.ts | 71 ------------------ 9 files changed, 116 insertions(+), 118 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts index f4d395b03..98c897c89 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts @@ -4,7 +4,6 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' import { IMAPSecurity, - IMAPSecurityLabels, PaperlessMailAccount, } from 'src/app/data/paperless-mail-account' import { MailAccountService } from 'src/app/services/rest/mail-account.service' @@ -40,6 +39,10 @@ export class MailAccountEditDialogComponent extends EditDialogComponent - - + +
        +

        Paperless will only process mails that match all of the filters specified below.

        - - - +
        + + - + - +
        diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index d820e3d5d..b2d84d642 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -8,13 +8,9 @@ import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' import { MailAction, - MailActionOptions, MailFilterAttachmentType, - MailFilterAttachmentTypeOptions, MailMetadataCorrespondentOption, - MailMetadataCorrespondentOptionOptions, MailMetadataTitleOption, - MailMetadataTitleOptionOptions, PaperlessMailRule, } from 'src/app/data/paperless-mail-rule' import { CorrespondentService } from 'src/app/services/rest/correspondent.service' @@ -89,19 +85,82 @@ export class MailRuleEditDialogComponent extends EditDialogComponent{{title}}
        - +
        {{error}} diff --git a/src-ui/src/app/components/common/input/number/number.component.ts b/src-ui/src/app/components/common/input/number/number.component.ts index cb29ff5e5..5ed861b5a 100644 --- a/src-ui/src/app/components/common/input/number/number.component.ts +++ b/src-ui/src/app/components/common/input/number/number.component.ts @@ -1,4 +1,4 @@ -import { Component, forwardRef } from '@angular/core' +import { Component, forwardRef, Input } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' import { FILTER_ASN_ISNULL } from 'src/app/data/filter-rule-type' import { DocumentService } from 'src/app/services/rest/document.service' @@ -17,6 +17,9 @@ import { AbstractInputComponent } from '../abstract-input' styleUrls: ['./number.component.scss'], }) export class NumberComponent extends AbstractInputComponent { + @Input() + showAdd: boolean = true + constructor(private documentService: DocumentService) { super() } diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 0aec87033..1f0ada8ab 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -221,8 +221,12 @@ Paperless Mail -

        Mail accounts

        -
          + +

          + Mail accounts + +

          +
          • @@ -232,14 +236,15 @@
            • -
          • -
            -
            -
            {{account.imap_server}}
            -
            -
            - - +
          • +
            +
            +
            {{account.imap_server}}
            +
            +
            + + +
        @@ -248,8 +253,11 @@
        No mail accounts defined.
      -

      Mail rules

      -
        +

        + Mail rules + +

        +
        • @@ -259,14 +267,15 @@
          • -
        • -
          -
          -
          {{(mailAccountService.getCached(rule.account) | async)?.name}}
          -
          -
          - - +
        • +
          +
          +
          {{(mailAccountService.getCached(rule.account) | async)?.name}}
          +
          +
          + + +
          diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 818ad6b14..6f68f04df 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -481,7 +481,7 @@ export class SettingsComponent backdrop: 'static', size: 'xl', }) - modal.componentInstance.dialogMode = 'edit' + modal.componentInstance.dialogMode = account ? 'edit' : 'create' modal.componentInstance.object = account modal.componentInstance.success .pipe(takeUntil(this.unsubscribeNotifier)) @@ -523,7 +523,7 @@ export class SettingsComponent backdrop: 'static', size: 'xl', }) - modal.componentInstance.dialogMode = 'edit' + modal.componentInstance.dialogMode = rule ? 'edit' : 'create' modal.componentInstance.object = rule modal.componentInstance.success .pipe(takeUntil(this.unsubscribeNotifier)) diff --git a/src-ui/src/app/data/paperless-mail-account.ts b/src-ui/src/app/data/paperless-mail-account.ts index ea5c17a1b..9f875e783 100644 --- a/src-ui/src/app/data/paperless-mail-account.ts +++ b/src-ui/src/app/data/paperless-mail-account.ts @@ -6,12 +6,6 @@ export enum IMAPSecurity { STARTTLS = 3, } -export const IMAPSecurityLabels: Array<{ id: number; name: string }> = [ - { id: IMAPSecurity.None, name: $localize`No encryption` }, - { id: IMAPSecurity.SSL, name: $localize`SSL` }, - { id: IMAPSecurity.STARTTLS, name: $localize`STARTTLS` }, -] - export interface PaperlessMailAccount extends ObjectWithId { name: string diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts index 0f0e417f8..ff6654a0b 100644 --- a/src-ui/src/app/data/paperless-mail-rule.ts +++ b/src-ui/src/app/data/paperless-mail-rule.ts @@ -1,28 +1,10 @@ import { ObjectWithId } from './object-with-id' -import { PaperlessCorrespondent } from './paperless-correspondent' -import { PaperlessDocumentType } from './paperless-document-type' -import { PaperlessMailAccount } from './paperless-mail-account' -import { PaperlessTag } from './paperless-tag' export enum MailFilterAttachmentType { Attachments = 1, Everything = 2, } -export const MailFilterAttachmentTypeOptions: Array<{ - id: number - name: string -}> = [ - { - id: MailFilterAttachmentType.Attachments, - name: $localize`Only process attachments.`, - }, - { - id: MailFilterAttachmentType.Everything, - name: $localize`Process all files, including 'inline' attachments.`, - }, -] - export enum MailAction { Delete = 1, Move = 2, @@ -31,42 +13,11 @@ export enum MailAction { Tag = 5, } -export const MailActionOptions: Array<{ id: number; name: string }> = [ - { id: MailAction.Delete, name: $localize`Delete` }, - { id: MailAction.Move, name: $localize`Move to specified folder` }, - { - id: MailAction.MarkRead, - name: $localize`Mark as read, don't process read mails`, - }, - { - id: MailAction.Flag, - name: $localize`Flag the mail, don't process flagged mails`, - }, - { - id: MailAction.Tag, - name: $localize`Tag the mail with specified tag, don't process tagged mails`, - }, -] - export enum MailMetadataTitleOption { FromSubject = 1, FromFilename = 2, } -export const MailMetadataTitleOptionOptions: Array<{ - id: number - name: string -}> = [ - { - id: MailMetadataTitleOption.FromSubject, - name: $localize`Use subject as title`, - }, - { - id: MailMetadataTitleOption.FromFilename, - name: $localize`Use attachment filename as title`, - }, -] - export enum MailMetadataCorrespondentOption { FromNothing = 1, FromEmail = 2, @@ -74,28 +25,6 @@ export enum MailMetadataCorrespondentOption { FromCustom = 4, } -export const MailMetadataCorrespondentOptionOptions: Array<{ - id: number - name: string -}> = [ - { - id: MailMetadataCorrespondentOption.FromNothing, - name: $localize`Do not assign a correspondent`, - }, - { - id: MailMetadataCorrespondentOption.FromEmail, - name: $localize`Use mail address`, - }, - { - id: MailMetadataCorrespondentOption.FromName, - name: $localize`Use name (or mail address if not available)`, - }, - { - id: MailMetadataCorrespondentOption.FromCustom, - name: $localize`Use correspondent selected below`, - }, -] - export interface PaperlessMailRule extends ObjectWithId { name: string From 40c8629aef6f0b971d17a190ad48e6c6680e4d30 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 10 Nov 2022 21:04:29 -0800 Subject: [PATCH 10/26] Update welcome tour, move admin button --- src-ui/src/app/app.component.ts | 10 +--------- .../app/components/app-frame/app-frame.component.html | 7 ------- .../components/manage/settings/settings.component.html | 9 +++++++-- 3 files changed, 8 insertions(+), 18 deletions(-) diff --git a/src-ui/src/app/app.component.ts b/src-ui/src/app/app.component.ts index b385498fb..9a6962ccf 100644 --- a/src-ui/src/app/app.component.ts +++ b/src-ui/src/app/app.component.ts @@ -191,21 +191,13 @@ export class AppComponent implements OnInit, OnDestroy { }, { anchorId: 'tour.settings', - content: $localize`Check out the settings for various tweaks to the web app or to toggle settings for saved views.`, + content: $localize`Check out the settings for various tweaks to the web app, toggle settings for saved views or setup e-mail checking.`, route: '/settings', enableBackdrop: true, prevBtnTitle, nextBtnTitle, endBtnTitle, }, - { - anchorId: 'tour.admin', - content: $localize`The Admin area contains more advanced controls as well as the settings for automatic e-mail fetching.`, - enableBackdrop: true, - prevBtnTitle, - nextBtnTitle, - endBtnTitle, - }, { anchorId: 'tour.outro', title: $localize`Thank you! 🙏`, diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index 589b95f4f..5115303d7 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -174,13 +174,6 @@  Settings
          • -
        • - - - -  Admin - -
        diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 1f0ada8ab..9fb301828 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -1,8 +1,13 @@ + + Open Django Admin + + + + -
          @@ -218,7 +223,7 @@
        • - Paperless Mail + Mail From 24444237f2216ce42e1b2484de7e56296fe62a63 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 12 Nov 2022 14:46:57 -0800 Subject: [PATCH 11/26] dynamic loading of settings tab contents --- .../manage/settings/settings.component.html | 15 +++-- .../manage/settings/settings.component.ts | 67 ++++++++++++------- 2 files changed, 51 insertions(+), 31 deletions(-) diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 9fb301828..ca7c0e9f2 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -10,8 +10,8 @@ -
            -
          • +
              +
            • General @@ -167,7 +167,7 @@
              • -
            • +
            • Notifications @@ -185,7 +185,7 @@
              • -
            • +
            • Saved views @@ -215,7 +215,12 @@ -
              No saved views defined.
              +
              No saved views defined.
              + +
              + + +
              diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 6f68f04df..7fed7561e 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -37,6 +37,15 @@ import { NgbModal } from '@ng-bootstrap/ng-bootstrap' import { MailAccountEditDialogComponent } from '../../common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' import { MailRuleEditDialogComponent } from '../../common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component' import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { NgbNavChangeEvent } from '@ng-bootstrap/ng-bootstrap' + +enum SettingsNavIDs { + General = 1, + Notifications = 2, + SavedViews = 3, + Mail = 4, + UsersGroups = 5, +} @Component({ selector: 'app-settings', @@ -46,6 +55,9 @@ import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dial export class SettingsComponent implements OnInit, AfterViewInit, OnDestroy, DirtyComponent { + SettingsNavIDs = SettingsNavIDs + activeNavID: number + savedViewGroup = new FormGroup({}) mailAccountGroup = new FormGroup({}) @@ -171,19 +183,20 @@ export class SettingsComponent } ngOnInit() { - this.savedViewService.listAll().subscribe((r) => { - this.savedViews = r.results + this.initialize() + } - this.mailAccountService.listAll().subscribe((r) => { - this.mailAccounts = r.results - - this.mailRuleService.listAll().subscribe((r) => { - this.mailRules = r.results - - this.initialize() - }) + // Load tab contents 'on demand', either on mouseover or focusin (i.e. before click) or on nav change event + maybeInitializeTab(navIDorEvent: number | NgbNavChangeEvent): void { + const navID = + typeof navIDorEvent == 'number' ? navIDorEvent : navIDorEvent.nextId + // initialize saved views + if (navID == SettingsNavIDs.SavedViews && !this.savedViews) { + this.savedViewService.listAll().subscribe((r) => { + this.savedViews = r.results + this.initialize() }) - }) + } } initialize() { @@ -191,22 +204,24 @@ export class SettingsComponent let storeData = this.getCurrentSettings() - for (let view of this.savedViews) { - storeData.savedViews[view.id.toString()] = { - id: view.id, - name: view.name, - show_on_dashboard: view.show_on_dashboard, - show_in_sidebar: view.show_in_sidebar, + if (this.savedViews) { + for (let view of this.savedViews) { + storeData.savedViews[view.id.toString()] = { + id: view.id, + name: view.name, + show_on_dashboard: view.show_on_dashboard, + show_in_sidebar: view.show_in_sidebar, + } + this.savedViewGroup.addControl( + view.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + show_on_dashboard: new FormControl(null), + show_in_sidebar: new FormControl(null), + }) + ) } - this.savedViewGroup.addControl( - view.id.toString(), - new FormGroup({ - id: new FormControl(null), - name: new FormControl(null), - show_on_dashboard: new FormControl(null), - show_in_sidebar: new FormControl(null), - }) - ) } for (let account of this.mailAccounts) { From 4cb4d6adcd33c917c370fd480687fdcecf09230b Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 12 Nov 2022 15:15:59 -0800 Subject: [PATCH 12/26] update settings tests to not wait on data which is now on-demand --- src-ui/cypress/e2e/settings/settings.cy.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src-ui/cypress/e2e/settings/settings.cy.ts b/src-ui/cypress/e2e/settings/settings.cy.ts index 7752fdf61..aa59997d4 100644 --- a/src-ui/cypress/e2e/settings/settings.cy.ts +++ b/src-ui/cypress/e2e/settings/settings.cy.ts @@ -58,7 +58,6 @@ describe('settings', () => { cy.viewport(1024, 1600) cy.visit('/settings') - cy.wait('@mailRules') }) it('should activate / deactivate save button when settings change and are saved', () => { @@ -89,14 +88,14 @@ describe('settings', () => { it('should remove saved view from sidebar when unset', () => { cy.contains('a', 'Saved views').click().wait(2000) cy.get('#show_in_sidebar_1').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.contains('li', 'Inbox').should('not.exist') }) it('should remove saved view from dashboard when unset', () => { cy.contains('a', 'Saved views').click() cy.get('#show_on_dashboard_1').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.visit('/dashboard') cy.get('app-saved-view-widget').contains('Inbox').should('not.exist') }) From 52d3a8703c383d414298f8814a1bc3957ce89ec5 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 12 Nov 2022 15:14:58 -0800 Subject: [PATCH 13/26] Dynamically load mail rules / accounts settings --- .../manage/settings/settings.component.html | 50 +++--- .../manage/settings/settings.component.ts | 144 ++++++++++-------- .../app/services/rest/mail-account.service.ts | 1 - .../app/services/rest/mail-rule.service.ts | 1 - 4 files changed, 106 insertions(+), 90 deletions(-) diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index ca7c0e9f2..61aaf15d8 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -227,7 +227,7 @@
              • -
            • +
            • Mail @@ -238,13 +238,13 @@
          -
        • -
          -
          Name
          -
          Server
          -
          Actions
          -
          -
          • +
        • +
          +
          Name
          +
          Server
          +
          Actions
          +
          +
        • @@ -257,11 +257,10 @@
          - -
          • + -
          No mail accounts defined.
          -
        +
        No mail accounts defined.
        +

      Mail rules @@ -269,13 +268,13 @@

        -
      • -
        -
        Name
        -
        Account
        -
        Actions
        -
        -
        • +
      • +
        +
        Name
        +
        Account
        +
        Actions
        +
        +
      • @@ -288,11 +287,16 @@
        - -
        • + -
        No mail rules defined.
        -
      +
      No mail rules defined.
      +
    + + +
    + + +
    diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 7fed7561e..fc072aeee 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -196,6 +196,18 @@ export class SettingsComponent this.savedViews = r.results this.initialize() }) + } else if ( + (navID == SettingsNavIDs.Mail && !this.mailAccounts) || + !this.mailRules + ) { + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + this.initialize() + }) + }) } } @@ -224,74 +236,76 @@ export class SettingsComponent } } - for (let account of this.mailAccounts) { - storeData.mailAccounts[account.id.toString()] = { - id: account.id, - name: account.name, - imap_server: account.imap_server, - imap_port: account.imap_port, - imap_security: account.imap_security, - username: account.username, - password: account.password, - character_set: account.character_set, + if (this.mailAccounts && this.mailRules) { + for (let account of this.mailAccounts) { + storeData.mailAccounts[account.id.toString()] = { + id: account.id, + name: account.name, + imap_server: account.imap_server, + imap_port: account.imap_port, + imap_security: account.imap_security, + username: account.username, + password: account.password, + character_set: account.character_set, + } + this.mailAccountGroup.addControl( + account.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + imap_server: new FormControl(null), + imap_port: new FormControl(null), + imap_security: new FormControl(null), + username: new FormControl(null), + password: new FormControl(null), + character_set: new FormControl(null), + }) + ) } - this.mailAccountGroup.addControl( - account.id.toString(), - new FormGroup({ - id: new FormControl(null), - name: new FormControl(null), - imap_server: new FormControl(null), - imap_port: new FormControl(null), - imap_security: new FormControl(null), - username: new FormControl(null), - password: new FormControl(null), - character_set: new FormControl(null), - }) - ) - } - for (let rule of this.mailRules) { - storeData.mailRules[rule.id.toString()] = { - name: rule.name, - order: rule.order, - account: rule.account, - folder: rule.folder, - filter_from: rule.filter_from, - filter_subject: rule.filter_subject, - filter_body: rule.filter_body, - filter_attachment_filename: rule.filter_attachment_filename, - maximum_age: rule.maximum_age, - attachment_type: rule.attachment_type, - action: rule.action, - action_parameter: rule.action_parameter, - assign_title_from: rule.assign_title_from, - assign_tags: rule.assign_tags, - assign_document_type: rule.assign_document_type, - assign_correspondent_from: rule.assign_correspondent_from, - assign_correspondent: rule.assign_correspondent, + for (let rule of this.mailRules) { + storeData.mailRules[rule.id.toString()] = { + name: rule.name, + order: rule.order, + account: rule.account, + folder: rule.folder, + filter_from: rule.filter_from, + filter_subject: rule.filter_subject, + filter_body: rule.filter_body, + filter_attachment_filename: rule.filter_attachment_filename, + maximum_age: rule.maximum_age, + attachment_type: rule.attachment_type, + action: rule.action, + action_parameter: rule.action_parameter, + assign_title_from: rule.assign_title_from, + assign_tags: rule.assign_tags, + assign_document_type: rule.assign_document_type, + assign_correspondent_from: rule.assign_correspondent_from, + assign_correspondent: rule.assign_correspondent, + } + this.mailRuleGroup.addControl( + rule.id.toString(), + new FormGroup({ + name: new FormControl(null), + order: new FormControl(null), + account: new FormControl(null), + folder: new FormControl(null), + filter_from: new FormControl(null), + filter_subject: new FormControl(null), + filter_body: new FormControl(null), + filter_attachment_filename: new FormControl(null), + maximum_age: new FormControl(null), + attachment_type: new FormControl(null), + action: new FormControl(null), + action_parameter: new FormControl(null), + assign_title_from: new FormControl(null), + assign_tags: new FormControl(null), + assign_document_type: new FormControl(null), + assign_correspondent_from: new FormControl(null), + assign_correspondent: new FormControl(null), + }) + ) } - this.mailRuleGroup.addControl( - rule.id.toString(), - new FormGroup({ - name: new FormControl(null), - order: new FormControl(null), - account: new FormControl(null), - folder: new FormControl(null), - filter_from: new FormControl(null), - filter_subject: new FormControl(null), - filter_body: new FormControl(null), - filter_attachment_filename: new FormControl(null), - maximum_age: new FormControl(null), - attachment_type: new FormControl(null), - action: new FormControl(null), - action_parameter: new FormControl(null), - assign_title_from: new FormControl(null), - assign_tags: new FormControl(null), - assign_document_type: new FormControl(null), - assign_correspondent_from: new FormControl(null), - assign_correspondent: new FormControl(null), - }) - ) } this.store = new BehaviorSubject(storeData) diff --git a/src-ui/src/app/services/rest/mail-account.service.ts b/src-ui/src/app/services/rest/mail-account.service.ts index a4db86684..438aa8c90 100644 --- a/src-ui/src/app/services/rest/mail-account.service.ts +++ b/src-ui/src/app/services/rest/mail-account.service.ts @@ -13,7 +13,6 @@ export class MailAccountService extends AbstractPaperlessService constructor(http: HttpClient) { super(http, 'mail_rules') - this.reload() } private reload() { From ea1ea0816fbd4d17d9c62fe21e983f1fa62ca4d9 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 18 Nov 2022 14:10:17 -0800 Subject: [PATCH 14/26] Fix mail account / rule delete --- .../manage/settings/settings.component.ts | 34 +++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index fc072aeee..fbb41b972 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -543,7 +543,22 @@ export class SettingsComponent modal.componentInstance.btnCaption = $localize`Proceed` modal.componentInstance.confirmClicked.subscribe(() => { modal.componentInstance.buttonsEnabled = false - this.mailAccountService.delete(account) + this.mailAccountService.delete(account).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted mail account`) + this.mailAccountService.clearCache() + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting mail account: ${e.toString()}.` + ) + }, + }) }) } @@ -586,7 +601,22 @@ export class SettingsComponent modal.componentInstance.btnCaption = $localize`Proceed` modal.componentInstance.confirmClicked.subscribe(() => { modal.componentInstance.buttonsEnabled = false - this.mailRuleService.delete(rule) + this.mailRuleService.delete(rule).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted mail rule`) + this.mailRuleService.clearCache() + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting mail rule: ${e.toString()}.` + ) + }, + }) }) } } From 284941444519e44b2d4322e0af2c9edd408d2b7a Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 18 Nov 2022 14:21:31 -0800 Subject: [PATCH 15/26] one-way imap password setting via API, ObfuscatedPasswordField --- src/documents/serialisers.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index d2fa10af9..cede116fe 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -692,7 +692,21 @@ class AcknowledgeTasksViewSerializer(serializers.Serializer): return tasks +class ObfuscatedPasswordField(serializers.Field): + """ + Sends *** string instead of password in the clear + """ + + def to_representation(self, value): + return re.sub(".", "*", value) + + def to_internal_value(self, data): + return data + + class MailAccountSerializer(serializers.ModelSerializer): + password = ObfuscatedPasswordField() + class Meta: model = MailAccount depth = 1 @@ -708,6 +722,9 @@ class MailAccountSerializer(serializers.ModelSerializer): ] def update(self, instance, validated_data): + if "password" in validated_data: + if len(validated_data.get("password").replace("*", "")) == 0: + validated_data.pop("password") super().update(instance, validated_data) return instance From 8c4f486fe984e1b5ebd19e314c49ae7277ae7178 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 18 Nov 2022 14:22:07 -0800 Subject: [PATCH 16/26] API mail rule & account tests and fix use of assign_tags --- .../mail-rule-edit-dialog.component.ts | 2 +- src/documents/serialisers.py | 17 +- src/documents/tests/test_api.py | 440 ++++++++++++++++++ 3 files changed, 454 insertions(+), 5 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index b2d84d642..22b5df542 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -76,7 +76,7 @@ export class MailRuleEditDialogComponent extends EditDialogComponent Date: Fri, 18 Nov 2022 17:11:15 -0800 Subject: [PATCH 17/26] Hide order parameter, fix imap port --- .../mail-account-edit-dialog.component.html | 2 +- .../mail-rule-edit-dialog.component.html | 1 - .../mail-rule-edit-dialog.component.ts | 1 - .../manage/settings/settings.component.html | 14 ++++++++++++-- .../manage/settings/settings.component.ts | 4 ++-- src-ui/src/app/data/paperless-mail-rule.ts | 2 -- src/documents/serialisers.py | 1 + 7 files changed, 16 insertions(+), 9 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html index 807df18c5..8164fca9a 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html @@ -9,7 +9,7 @@
    - +
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html index 3eb793ae2..dc4260ffd 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -8,7 +8,6 @@
    - diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index 22b5df542..7644ed353 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -64,7 +64,6 @@ export class MailRuleEditDialogComponent extends EditDialogComponent

    Mail accounts - +

      @@ -264,7 +269,12 @@

      Mail rules - +

        diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index fbb41b972..3a146fb36 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -266,7 +266,6 @@ export class SettingsComponent for (let rule of this.mailRules) { storeData.mailRules[rule.id.toString()] = { name: rule.name, - order: rule.order, account: rule.account, folder: rule.folder, filter_from: rule.filter_from, @@ -287,7 +286,6 @@ export class SettingsComponent rule.id.toString(), new FormGroup({ name: new FormControl(null), - order: new FormControl(null), account: new FormControl(null), folder: new FormControl(null), filter_from: new FormControl(null), @@ -519,6 +517,7 @@ export class SettingsComponent this.toastService.showInfo( $localize`Saved account "${newMailAccount.name}".` ) + this.mailAccountService.clearCache() this.mailAccountService.listAll().subscribe((r) => { this.mailAccounts = r.results this.initialize() @@ -576,6 +575,7 @@ export class SettingsComponent this.toastService.showInfo( $localize`Saved rule "${newMailRule.name}".` ) + this.mailRuleService.clearCache() this.mailRuleService.listAll().subscribe((r) => { this.mailRules = r.results diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts index ff6654a0b..9ff133dab 100644 --- a/src-ui/src/app/data/paperless-mail-rule.ts +++ b/src-ui/src/app/data/paperless-mail-rule.ts @@ -28,8 +28,6 @@ export enum MailMetadataCorrespondentOption { export interface PaperlessMailRule extends ObjectWithId { name: string - order: number - account: number // PaperlessMailAccount.id folder: string diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 6b78d1f89..44572e8fb 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -748,6 +748,7 @@ class MailRuleSerializer(serializers.ModelSerializer): assign_correspondent = CorrespondentField(allow_null=True, required=False) assign_tags = TagsField(many=True, allow_null=True, required=False) assign_document_type = DocumentTypeField(allow_null=True, required=False) + order = serializers.IntegerField(required=False) class Meta: model = MailRule From 14cf4f709521123fcb8c9472c5f6b3c663ffc5c8 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 18 Nov 2022 19:38:49 -0800 Subject: [PATCH 18/26] Update frontend strings --- src-ui/messages.xlf | 868 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 707 insertions(+), 161 deletions(-) diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index 5e451935a..da0fb042c 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -370,46 +370,39 @@ 185 - - Check out the settings for various tweaks to the web app or to toggle settings for saved views. + + Check out the settings for various tweaks to the web app, toggle settings for saved views or setup e-mail checking. src/app/app.component.ts 194 - - The Admin area contains more advanced controls as well as the settings for automatic e-mail fetching. - - src/app/app.component.ts - 203 - - Thank you! 🙏 src/app/app.component.ts - 211 + 203 There are <em>tons</em> more features and info we didn't cover here, but this should get you started. Check out the documentation or visit the project on GitHub to learn more or to report issues. src/app/app.component.ts - 213 + 205 Lastly, on behalf of every contributor to this community-supported project, thank you for using Paperless-ngx! src/app/app.component.ts - 215 + 207 Initiating upload... src/app/app.component.ts - 264 + 256 @@ -514,7 +507,7 @@ src/app/components/manage/settings/settings.component.html - 184 + 189 @@ -631,22 +624,11 @@ 1 - - Admin - - src/app/components/app-frame/app-frame.component.html - 178 - - - src/app/components/app-frame/app-frame.component.html - 181 - - Info src/app/components/app-frame/app-frame.component.html - 187 + 180 src/app/components/manage/tasks/tasks.component.html @@ -657,68 +639,68 @@ Documentation src/app/components/app-frame/app-frame.component.html - 191 + 184 src/app/components/app-frame/app-frame.component.html - 194 + 187 GitHub src/app/components/app-frame/app-frame.component.html - 199 + 192 src/app/components/app-frame/app-frame.component.html - 202 + 195 Suggest an idea src/app/components/app-frame/app-frame.component.html - 204 + 197 src/app/components/app-frame/app-frame.component.html - 208 + 201 is available. src/app/components/app-frame/app-frame.component.html - 217 + 210 Click to view. src/app/components/app-frame/app-frame.component.html - 217 + 210 Paperless-ngx can automatically check for updates src/app/components/app-frame/app-frame.component.html - 221 + 214 How does this work? src/app/components/app-frame/app-frame.component.html - 228,230 + 221,223 Update available src/app/components/app-frame/app-frame.component.html - 239 + 232 @@ -729,7 +711,7 @@ src/app/components/manage/settings/settings.component.ts - 326 + 476 @@ -843,6 +825,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 9 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 10 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 10 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 13 @@ -889,7 +879,15 @@ src/app/components/manage/settings/settings.component.html - 191 + 196 + + + src/app/components/manage/settings/settings.component.html + 248 + + + src/app/components/manage/settings/settings.component.html + 283 src/app/components/manage/tasks/tasks.component.html @@ -963,6 +961,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 16 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 23 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 35 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 21 @@ -994,6 +1000,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 17 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 24 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 36 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 22 @@ -1012,56 +1026,424 @@ src/app/components/manage/settings/settings.component.html - 223 + 317 Create new correspondent src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts - 25 + 20 Edit correspondent src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts - 29 + 24 Create new document type src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts - 25 + 20 Edit document type src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts - 29 + 24 Create new item src/app/components/common/edit-dialog/edit-dialog.component.ts - 52 + 49 Edit item src/app/components/common/edit-dialog/edit-dialog.component.ts - 56 + 53 Could not save element: src/app/components/common/edit-dialog/edit-dialog.component.ts - 60 + 57 + + + + IMAP Server + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 11 + + + + IMAP Port + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 12 + + + + IMAP Security + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 13 + + + + Username + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 16 + + + + Password + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 17 + + + + Character Set + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 18 + + + + Create new mail account + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 22 + + + + Edit mail account + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 26 + + + + No encryption + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 43 + + + + SSL + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 44 + + + + STARTTLS + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 45 + + + + Account + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 11 + + + src/app/components/manage/settings/settings.component.html + 284 + + + + Folder + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 12 + + + + Subfolders must be separated by a delimiter, often a dot ('.') or slash ('/'), but it varies by mail server. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 12 + + + + Maximum age (days) + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 13 + + + + Attachment type + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 14 + + + + Paperless will only process mails that match all of the filters specified below. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 17 + + + + Filter from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 18 + + + + Filter subject + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 19 + + + + Filter body + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 20 + + + + Filter attachment filename + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 21 + + + + Only consume documents which entirely match this filename if specified. Wildcards such as *.pdf or *invoice* are allowed. Case insensitive. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 21 + + + + Action + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 24 + + + + Action is only performed when documents are consumed from the mail. Mails without attachments remain entirely untouched. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 24 + + + + Action parameter + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 25 + + + + Assign title from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 26 + + + + Assign document type + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 28 + + + + Assign correspondent from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 29 + + + + Assign correspondent + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 30 + + + + Create new mail rule + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 57 + + + + Edit mail rule + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 61 + + + + Only process attachments. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 98 + + + + Process all files, including 'inline' attachments. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 102 + + + + Delete + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 111 + + + src/app/components/document-detail/document-detail.component.html + 11 + + + src/app/components/document-list/bulk-editor/bulk-editor.component.html + 97 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.ts + 181 + + + src/app/components/manage/settings/settings.component.html + 214 + + + src/app/components/manage/settings/settings.component.html + 261 + + + src/app/components/manage/settings/settings.component.html + 296 + + + + Move to specified folder + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 115 + + + + Mark as read, don't process read mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 119 + + + + Flag the mail, don't process flagged mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 123 + + + + Tag the mail with specified tag, don't process tagged mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 127 + + + + Use subject as title + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 136 + + + + Use attachment filename as title + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 140 + + + + Do not assign a correspondent + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 149 + + + + Use mail address + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 153 + + + + Use name (or mail address if not available) + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 157 + + + + Use correspondent selected below + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 161 @@ -1086,35 +1468,35 @@ e.g. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 26 + 21 or use slashes to add directories e.g. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 28 + 23 See <a target="_blank" href="https://docs.paperless-ngx.com/advanced_usage/#file-name-handling">documentation</a> for full list. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 30 + 25 Create new storage path src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 35 + 30 Edit storage path src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 39 + 34 @@ -1146,14 +1528,14 @@ Create new tag src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts - 26 + 21 Edit tag src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts - 30 + 25 @@ -1269,6 +1651,14 @@ src/app/components/document-list/document-list.component.html 93 + + src/app/components/manage/settings/settings.component.html + 222 + + + src/app/components/manage/settings/settings.component.html + 308 + src/app/components/manage/tasks/tasks.component.html 19 @@ -1535,57 +1925,6 @@ 5 - - Delete - - src/app/components/document-detail/document-detail.component.html - 11 - - - src/app/components/document-list/bulk-editor/bulk-editor.component.html - 97 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.ts - 157 - - - src/app/components/manage/settings/settings.component.html - 209 - - Download @@ -1855,7 +2194,7 @@ src/app/components/manage/settings/settings.component.html - 154 + 159 @@ -1880,7 +2219,7 @@ src/app/components/manage/management-list/management-list.component.ts - 153 + 177 @@ -1943,6 +2282,14 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts 389 + + src/app/components/manage/settings/settings.component.ts + 560 + + + src/app/components/manage/settings/settings.component.ts + 619 + Proceed @@ -1954,6 +2301,14 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts 391 + + src/app/components/manage/settings/settings.component.ts + 562 + + + src/app/components/manage/settings/settings.component.ts + 621 + Redo OCR operation will begin in the background. Close and re-open or reload this document after the operation has completed to see new content. @@ -2053,7 +2408,15 @@ src/app/components/manage/settings/settings.component.html - 208 + 213 + + + src/app/components/manage/settings/settings.component.html + 250 + + + src/app/components/manage/settings/settings.component.html + 285 src/app/components/manage/tasks/tasks.component.html @@ -2315,6 +2678,14 @@ src/app/components/manage/management-list/management-list.component.html 59 + + src/app/components/manage/settings/settings.component.html + 260 + + + src/app/components/manage/settings/settings.component.html + 295 + View @@ -2675,7 +3046,7 @@ src/app/components/manage/settings/settings.component.html - 203 + 208 @@ -2686,7 +3057,7 @@ src/app/components/manage/settings/settings.component.html - 199 + 204 @@ -2877,18 +3248,46 @@ 39 + + Successfully created . + + src/app/components/manage/management-list/management-list.component.ts + 127 + + + + Error occurred while creating : . + + src/app/components/manage/management-list/management-list.component.ts + 132,134 + + + + Successfully updated . + + src/app/components/manage/management-list/management-list.component.ts + 150 + + + + Error occurred while saving : . + + src/app/components/manage/management-list/management-list.component.ts + 155,157 + + Do you really want to delete the ? src/app/components/manage/management-list/management-list.component.ts - 140 + 164 Associated documents will not be deleted. src/app/components/manage/management-list/management-list.component.ts - 155 + 179 @@ -2897,7 +3296,7 @@ )"/> src/app/components/manage/management-list/management-list.component.ts - 168,170 + 192,194 @@ -2907,333 +3306,396 @@ 2 + + Open Django Admin + + src/app/components/manage/settings/settings.component.html + 4 + + General src/app/components/manage/settings/settings.component.html - 10 + 15 Appearance src/app/components/manage/settings/settings.component.html - 13 + 18 Display language src/app/components/manage/settings/settings.component.html - 17 + 22 You need to reload the page after applying a new language. src/app/components/manage/settings/settings.component.html - 25 + 30 Date display src/app/components/manage/settings/settings.component.html - 32 + 37 Date format src/app/components/manage/settings/settings.component.html - 45 + 50 Short: src/app/components/manage/settings/settings.component.html - 51 + 56 Medium: src/app/components/manage/settings/settings.component.html - 55 + 60 Long: src/app/components/manage/settings/settings.component.html - 59 + 64 Items per page src/app/components/manage/settings/settings.component.html - 67 + 72 Document editor src/app/components/manage/settings/settings.component.html - 83 + 88 Use PDF viewer provided by the browser src/app/components/manage/settings/settings.component.html - 87 + 92 This is usually faster for displaying large PDF documents, but it might not work on some browsers. src/app/components/manage/settings/settings.component.html - 87 + 92 Sidebar src/app/components/manage/settings/settings.component.html - 94 + 99 Use 'slim' sidebar (icons only) src/app/components/manage/settings/settings.component.html - 98 + 103 Dark mode src/app/components/manage/settings/settings.component.html - 105 + 110 Use system settings src/app/components/manage/settings/settings.component.html - 108 + 113 Enable dark mode src/app/components/manage/settings/settings.component.html - 109 + 114 Invert thumbnails in dark mode src/app/components/manage/settings/settings.component.html - 110 + 115 Theme Color src/app/components/manage/settings/settings.component.html - 116 + 121 Reset src/app/components/manage/settings/settings.component.html - 125 + 130 Update checking src/app/components/manage/settings/settings.component.html - 130 + 135 Update checking works by pinging the the public Github API for the latest release to determine whether a new version is available. Actual updating of the app must still be performed manually. src/app/components/manage/settings/settings.component.html - 134,137 + 139,142 No tracking data is collected by the app in any way. src/app/components/manage/settings/settings.component.html - 139 + 144 Enable update checking src/app/components/manage/settings/settings.component.html - 141 + 146 Note that for users of thirdy-party containers e.g. linuxserver.io this notification may be 'ahead' of the current third-party release. src/app/components/manage/settings/settings.component.html - 141 + 146 Bulk editing src/app/components/manage/settings/settings.component.html - 145 + 150 Show confirmation dialogs src/app/components/manage/settings/settings.component.html - 149 + 154 Deleting documents will always ask for confirmation. src/app/components/manage/settings/settings.component.html - 149 + 154 Apply on close src/app/components/manage/settings/settings.component.html - 150 + 155 Enable comments src/app/components/manage/settings/settings.component.html - 158 + 163 Notifications src/app/components/manage/settings/settings.component.html - 166 + 171 Document processing src/app/components/manage/settings/settings.component.html - 169 + 174 Show notifications when new documents are detected src/app/components/manage/settings/settings.component.html - 173 + 178 Show notifications when document processing completes successfully src/app/components/manage/settings/settings.component.html - 174 + 179 Show notifications when document processing fails src/app/components/manage/settings/settings.component.html - 175 + 180 Suppress notifications on dashboard src/app/components/manage/settings/settings.component.html - 176 + 181 This will suppress all messages about document processing status on the dashboard. src/app/components/manage/settings/settings.component.html - 176 + 181 Appears on src/app/components/manage/settings/settings.component.html - 196 + 201 No saved views defined. src/app/components/manage/settings/settings.component.html - 213 + 218 + + + + Mail + + src/app/components/manage/settings/settings.component.html + 231 + + + + Mail accounts + + src/app/components/manage/settings/settings.component.html + 236 + + + + Add Account + + src/app/components/manage/settings/settings.component.html + 241 + + + + Server + + src/app/components/manage/settings/settings.component.html + 249 + + + + No mail accounts defined. + + src/app/components/manage/settings/settings.component.html + 267 + + + + Mail rules + + src/app/components/manage/settings/settings.component.html + 271 + + + + Add Rule + + src/app/components/manage/settings/settings.component.html + 276 + + + + No mail rules defined. + + src/app/components/manage/settings/settings.component.html + 302 Saved view "" deleted. src/app/components/manage/settings/settings.component.ts - 217 + 367 Settings saved src/app/components/manage/settings/settings.component.ts - 310 + 460 Settings were saved successfully. src/app/components/manage/settings/settings.component.ts - 311 + 461 Settings were saved successfully. Reload is required to apply some changes. src/app/components/manage/settings/settings.component.ts - 315 + 465 Reload now src/app/components/manage/settings/settings.component.ts - 316 + 466 Use system language src/app/components/manage/settings/settings.component.ts - 334 + 484 Use date format of display language src/app/components/manage/settings/settings.component.ts - 341 + 491 @@ -3242,7 +3704,91 @@ )"/> src/app/components/manage/settings/settings.component.ts - 361,363 + 511,513 + + + + Saved account "". + + src/app/components/manage/settings/settings.component.ts + 538 + + + + Error saving account: . + + src/app/components/manage/settings/settings.component.ts + 548 + + + + Confirm delete mail account + + src/app/components/manage/settings/settings.component.ts + 558 + + + + This operation will permanently this mail account. + + src/app/components/manage/settings/settings.component.ts + 559 + + + + Deleted mail account + + src/app/components/manage/settings/settings.component.ts + 568 + + + + Error deleting mail account: . + + src/app/components/manage/settings/settings.component.ts + 577 + + + + Saved rule "". + + src/app/components/manage/settings/settings.component.ts + 596 + + + + Error saving rule: . + + src/app/components/manage/settings/settings.component.ts + 607 + + + + Confirm delete mail rule + + src/app/components/manage/settings/settings.component.ts + 617 + + + + This operation will permanently this mail rule. + + src/app/components/manage/settings/settings.component.ts + 618 + + + + Deleted mail rule + + src/app/components/manage/settings/settings.component.ts + 627 + + + + Error deleting mail rule: . + + src/app/components/manage/settings/settings.component.ts + 636 From 4f9a31244b3916b7205388fcae46b2d59cca10f7 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 18 Nov 2022 20:23:40 -0800 Subject: [PATCH 19/26] Add settings routing --- src-ui/src/app/app-routing.module.ts | 5 +++ .../manage/settings/settings.component.html | 2 +- .../manage/settings/settings.component.ts | 40 ++++++++++++++----- 3 files changed, 36 insertions(+), 11 deletions(-) diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index 4dad24c51..084bc4a0b 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -47,6 +47,11 @@ const routes: Routes = [ component: SettingsComponent, canDeactivate: [DirtyFormGuard], }, + { + path: 'settings/:section', + component: SettingsComponent, + canDeactivate: [DirtyFormGuard], + }, { path: 'tasks', component: TasksComponent }, ], }, diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 138899713..0286e3561 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -10,7 +10,7 @@ -
          +
          • General diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 3a146fb36..b461e90b7 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -26,7 +26,7 @@ import { Subject, } from 'rxjs' import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' -import { ActivatedRoute } from '@angular/router' +import { ActivatedRoute, Router } from '@angular/router' import { ViewportScroller } from '@angular/common' import { TourService } from 'ngx-ui-tour-ng-bootstrap' import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' @@ -120,6 +120,7 @@ export class SettingsComponent @Inject(LOCALE_ID) public currentLocale: string, private viewportScroller: ViewportScroller, private activatedRoute: ActivatedRoute, + private router: Router, public readonly tourService: TourService, private modalService: NgbModal ) { @@ -128,6 +129,23 @@ export class SettingsComponent }) } + ngOnInit() { + this.initialize() + + this.activatedRoute.paramMap.subscribe((paramMap) => { + const section = paramMap.get('section') + if (section) { + const navIDKey: string = Object.keys(SettingsNavIDs).find( + (navID) => navID.toLowerCase() == section + ) + if (navIDKey) { + this.activeNavID = SettingsNavIDs[navIDKey] + this.maybeInitializeTab(this.activeNavID) + } + } + }) + } + ngAfterViewInit(): void { if (this.activatedRoute.snapshot.fragment) { this.viewportScroller.scrollToAnchor( @@ -182,23 +200,25 @@ export class SettingsComponent } } - ngOnInit() { - this.initialize() + onNavChange(navChangeEvent: NgbNavChangeEvent) { + this.maybeInitializeTab(navChangeEvent.nextId) + const [foundNavIDkey, foundNavIDValue] = Object.entries( + SettingsNavIDs + ).find(([navIDkey, navIDValue]) => navIDValue == navChangeEvent.nextId) + if (foundNavIDkey) + this.router.navigate(['settings', foundNavIDkey.toLowerCase()]) } - // Load tab contents 'on demand', either on mouseover or focusin (i.e. before click) or on nav change event - maybeInitializeTab(navIDorEvent: number | NgbNavChangeEvent): void { - const navID = - typeof navIDorEvent == 'number' ? navIDorEvent : navIDorEvent.nextId - // initialize saved views + // Load tab contents 'on demand', either on mouseover or focusin (i.e. before click) or called from nav change event + maybeInitializeTab(navID: number): void { if (navID == SettingsNavIDs.SavedViews && !this.savedViews) { this.savedViewService.listAll().subscribe((r) => { this.savedViews = r.results this.initialize() }) } else if ( - (navID == SettingsNavIDs.Mail && !this.mailAccounts) || - !this.mailRules + navID == SettingsNavIDs.Mail && + (!this.mailAccounts || !this.mailRules) ) { this.mailAccountService.listAll().subscribe((r) => { this.mailAccounts = r.results From 7ace66d7fd9f75ed1b66d7242622b8dee478534c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 28 Nov 2022 13:58:37 -0800 Subject: [PATCH 20/26] fix edit dialog getters --- .../mail-account-edit-dialog.component.ts | 12 +- .../mail-rule-edit-dialog.component.html | 2 +- .../mail-rule-edit-dialog.component.ts | 128 ++++++++++-------- .../manage/settings/settings.component.ts | 8 +- 4 files changed, 80 insertions(+), 70 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts index 98c897c89..b2edb9219 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts @@ -8,6 +8,12 @@ import { } from 'src/app/data/paperless-mail-account' import { MailAccountService } from 'src/app/services/rest/mail-account.service' +const IMAP_SECURITY_OPTIONS = [ + { id: IMAPSecurity.None, name: $localize`No encryption` }, + { id: IMAPSecurity.SSL, name: $localize`SSL` }, + { id: IMAPSecurity.STARTTLS, name: $localize`STARTTLS` }, +] + @Component({ selector: 'app-mail-account-edit-dialog', templateUrl: './mail-account-edit-dialog.component.html', @@ -39,10 +45,6 @@ export class MailAccountEditDialogComponent extends EditDialogComponent
    - + diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index 7644ed353..3dcd7ce01 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -18,6 +18,70 @@ import { DocumentTypeService } from 'src/app/services/rest/document-type.service import { MailAccountService } from 'src/app/services/rest/mail-account.service' import { MailRuleService } from 'src/app/services/rest/mail-rule.service' +const ATTACHMENT_TYPE_OPTIONS = [ + { + id: MailFilterAttachmentType.Attachments, + name: $localize`Only process attachments.`, + }, + { + id: MailFilterAttachmentType.Everything, + name: $localize`Process all files, including 'inline' attachments.`, + }, +] + +const ACTION_OPTIONS = [ + { + id: MailAction.Delete, + name: $localize`Delete`, + }, + { + id: MailAction.Move, + name: $localize`Move to specified folder`, + }, + { + id: MailAction.MarkRead, + name: $localize`Mark as read, don't process read mails`, + }, + { + id: MailAction.Flag, + name: $localize`Flag the mail, don't process flagged mails`, + }, + { + id: MailAction.Tag, + name: $localize`Tag the mail with specified tag, don't process tagged mails`, + }, +] + +const METADATA_TITLE_OPTIONS = [ + { + id: MailMetadataTitleOption.FromSubject, + name: $localize`Use subject as title`, + }, + { + id: MailMetadataTitleOption.FromFilename, + name: $localize`Use attachment filename as title`, + }, +] + +const METADATA_CORRESPONDENT_OPTIONS = [ + { + id: MailMetadataCorrespondentOption.FromNothing, + name: $localize`Do not assign a correspondent`, + }, + { + id: MailMetadataCorrespondentOption.FromEmail, + name: $localize`Use mail address`, + }, + { + id: MailMetadataCorrespondentOption.FromName, + name: $localize`Use name (or mail address if not available)`, + }, + { + id: MailMetadataCorrespondentOption.FromCustom, + name: $localize`Use correspondent selected below`, + }, +] + @Component({ selector: 'app-mail-rule-edit-dialog', templateUrl: './mail-rule-edit-dialog.component.html', @@ -92,74 +156,18 @@ export class MailRuleEditDialogComponent extends EditDialogComponent Date: Mon, 28 Nov 2022 15:51:39 -0800 Subject: [PATCH 21/26] frontend mail rule validation Display non-field validation errors, hide action param field if not needed --- .../mail-rule-edit-dialog.component.html | 3 ++- .../mail-rule-edit-dialog.component.ts | 7 +++++++ src/documents/serialisers.py | 9 +++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html index ef9a5bc47..a8a476c28 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -22,7 +22,7 @@
    - + @@ -32,6 +32,7 @@
    + Error: {{error.non_field_errors}}
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts index 3dcd7ce01..126c4968f 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -155,6 +155,13 @@ export class MailRuleEditDialogComponent extends EditDialogComponent Date: Mon, 28 Nov 2022 12:53:20 -0800 Subject: [PATCH 22/26] Apply code suggestions from @stumpylog --- src/documents/serialisers.py | 2 +- src/documents/tests/test_api.py | 18 +----------------- 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 11a9cba39..2d1119dfb 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -735,7 +735,7 @@ class MailAccountSerializer(serializers.ModelSerializer): class AccountField(serializers.PrimaryKeyRelatedField): def get_queryset(self): - return MailAccount.objects.all() + return MailAccount.objects.all().order_by("-id") class MailRuleSerializer(serializers.ModelSerializer): diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index 2c777f516..bdc729a36 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -2968,15 +2968,11 @@ class TestAPIMailAccounts(APITestCase): self.assertEqual(response.data["count"], 1) returned_account1 = response.data["results"][0] - from pprint import pprint - - pprint(returned_account1) - self.assertEqual(returned_account1["name"], account1.name) self.assertEqual(returned_account1["username"], account1.username) self.assertEqual( returned_account1["password"], - re.sub(".", "*", account1.password), + "*" * len(account1.password), ) self.assertEqual(returned_account1["imap_server"], account1.imap_server) self.assertEqual(returned_account1["imap_port"], account1.imap_port) @@ -3010,10 +3006,6 @@ class TestAPIMailAccounts(APITestCase): returned_account1 = MailAccount.objects.get(name="Email1") - from pprint import pprint - - pprint(returned_account1) - self.assertEqual(returned_account1.name, account1["name"]) self.assertEqual(returned_account1.username, account1["username"]) self.assertEqual(returned_account1.password, account1["password"]) @@ -3150,10 +3142,6 @@ class TestAPIMailRules(APITestCase): self.assertEqual(response.data["count"], 1) returned_rule1 = response.data["results"][0] - from pprint import pprint - - pprint(returned_rule1) - self.assertEqual(returned_rule1["name"], rule1.name) self.assertEqual(returned_rule1["account"], account1.pk) self.assertEqual(returned_rule1["folder"], rule1.folder) @@ -3239,10 +3227,6 @@ class TestAPIMailRules(APITestCase): self.assertEqual(response.data["count"], 1) returned_rule1 = response.data["results"][0] - from pprint import pprint - - pprint(returned_rule1) - self.assertEqual(returned_rule1["name"], rule1["name"]) self.assertEqual(returned_rule1["account"], account1.pk) self.assertEqual(returned_rule1["folder"], rule1["folder"]) From 5e5f56dc67c0ba6b516a9ec7e27ca3bf653df548 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 28 Nov 2022 20:39:03 -0800 Subject: [PATCH 23/26] Re-org where some of the new classes are found --- src/documents/serialisers.py | 106 ------- src/documents/tests/test_api.py | 424 -------------------------- src/documents/views.py | 4 +- src/paperless/urls.py | 4 +- src/paperless_mail/serialisers.py | 110 +++++++ src/paperless_mail/tests/test_api.py | 429 +++++++++++++++++++++++++++ src/paperless_mail/views.py | 41 +++ 7 files changed, 584 insertions(+), 534 deletions(-) create mode 100644 src/paperless_mail/serialisers.py create mode 100644 src/paperless_mail/tests/test_api.py create mode 100644 src/paperless_mail/views.py diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 2d1119dfb..db282cacd 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -28,8 +28,6 @@ from .models import UiSettings from .models import PaperlessTask from .parsers import is_mime_type_supported -from paperless_mail.models import MailAccount, MailRule - # https://www.django-rest-framework.org/api-guide/serializers/#example class DynamicFieldsModelSerializer(serializers.ModelSerializer): @@ -690,107 +688,3 @@ class AcknowledgeTasksViewSerializer(serializers.Serializer): def validate_tasks(self, tasks): self._validate_task_id_list(tasks) return tasks - - -class ObfuscatedPasswordField(serializers.Field): - """ - Sends *** string instead of password in the clear - """ - - def to_representation(self, value): - return re.sub(".", "*", value) - - def to_internal_value(self, data): - return data - - -class MailAccountSerializer(serializers.ModelSerializer): - password = ObfuscatedPasswordField() - - class Meta: - model = MailAccount - depth = 1 - fields = [ - "id", - "name", - "imap_server", - "imap_port", - "imap_security", - "username", - "password", - "character_set", - ] - - def update(self, instance, validated_data): - if "password" in validated_data: - if len(validated_data.get("password").replace("*", "")) == 0: - validated_data.pop("password") - super().update(instance, validated_data) - return instance - - def create(self, validated_data): - mail_account = MailAccount.objects.create(**validated_data) - return mail_account - - -class AccountField(serializers.PrimaryKeyRelatedField): - def get_queryset(self): - return MailAccount.objects.all().order_by("-id") - - -class MailRuleSerializer(serializers.ModelSerializer): - account = AccountField(required=True) - action_parameter = serializers.CharField( - allow_null=True, - required=False, - default="", - ) - assign_correspondent = CorrespondentField(allow_null=True, required=False) - assign_tags = TagsField(many=True, allow_null=True, required=False) - assign_document_type = DocumentTypeField(allow_null=True, required=False) - order = serializers.IntegerField(required=False) - - class Meta: - model = MailRule - depth = 1 - fields = [ - "id", - "name", - "account", - "folder", - "filter_from", - "filter_subject", - "filter_body", - "filter_attachment_filename", - "maximum_age", - "action", - "action_parameter", - "assign_title_from", - "assign_tags", - "assign_correspondent_from", - "assign_correspondent", - "assign_document_type", - "order", - "attachment_type", - ] - - def update(self, instance, validated_data): - super().update(instance, validated_data) - return instance - - def create(self, validated_data): - if "assign_tags" in validated_data: - assign_tags = validated_data.pop("assign_tags") - mail_rule = MailRule.objects.create(**validated_data) - if assign_tags: - mail_rule.assign_tags.set(assign_tags) - return mail_rule - - def validate(self, attrs): - if ( - attrs["action"] == MailRule.MailAction.TAG - or attrs["action"] == MailRule.MailAction.MOVE - ) and attrs["action_parameter"] is None: - raise serializers.ValidationError("An action parameter is required.") - - return attrs diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index bdc729a36..d876984bd 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -2,7 +2,6 @@ import datetime import io import json import os -import re import shutil import tempfile import urllib.request @@ -37,7 +36,6 @@ from documents.models import Comment from documents.models import StoragePath from documents.tests.utils import DirectoriesMixin from paperless import version -from paperless_mail.models import MailAccount, MailRule from rest_framework.test import APITestCase from whoosh.writing import AsyncWriter @@ -2931,425 +2929,3 @@ class TestTasks(APITestCase): returned_data = response.data[0] self.assertEqual(returned_data["task_file_name"], "anothertest.pdf") - - -class TestAPIMailAccounts(APITestCase): - ENDPOINT = "/api/mail_accounts/" - - def setUp(self): - super().setUp() - - self.user = User.objects.create_superuser(username="temp_admin") - self.client.force_authenticate(user=self.user) - - def test_get_mail_accounts(self): - """ - GIVEN: - - Configured mail accounts - WHEN: - - API call is made to get mail accounts - THEN: - - Configured mail accounts are provided - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - response = self.client.get(self.ENDPOINT) - - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data["count"], 1) - returned_account1 = response.data["results"][0] - - self.assertEqual(returned_account1["name"], account1.name) - self.assertEqual(returned_account1["username"], account1.username) - self.assertEqual( - returned_account1["password"], - "*" * len(account1.password), - ) - self.assertEqual(returned_account1["imap_server"], account1.imap_server) - self.assertEqual(returned_account1["imap_port"], account1.imap_port) - self.assertEqual(returned_account1["imap_security"], account1.imap_security) - self.assertEqual(returned_account1["character_set"], account1.character_set) - - def test_create_mail_account(self): - """ - WHEN: - - API request is made to add a mail account - THEN: - - A new mail account is created - """ - - account1 = { - "name": "Email1", - "username": "username1", - "password": "password1", - "imap_server": "server.example.com", - "imap_port": 443, - "imap_security": MailAccount.ImapSecurity.SSL, - "character_set": "UTF-8", - } - - response = self.client.post( - self.ENDPOINT, - data=account1, - ) - - self.assertEqual(response.status_code, 201) - - returned_account1 = MailAccount.objects.get(name="Email1") - - self.assertEqual(returned_account1.name, account1["name"]) - self.assertEqual(returned_account1.username, account1["username"]) - self.assertEqual(returned_account1.password, account1["password"]) - self.assertEqual(returned_account1.imap_server, account1["imap_server"]) - self.assertEqual(returned_account1.imap_port, account1["imap_port"]) - self.assertEqual(returned_account1.imap_security, account1["imap_security"]) - self.assertEqual(returned_account1.character_set, account1["character_set"]) - - def test_delete_mail_account(self): - """ - GIVEN: - - Existing mail account - WHEN: - - API request is made to delete a mail account - THEN: - - Account is deleted - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - response = self.client.delete( - f"{self.ENDPOINT}{account1.pk}/", - ) - - self.assertEqual(response.status_code, 204) - - self.assertEqual(len(MailAccount.objects.all()), 0) - - def test_update_mail_account(self): - """ - GIVEN: - - Existing mail accounts - WHEN: - - API request is made to update mail account - THEN: - - The mail account is updated, password only updated if not '****' - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - response = self.client.patch( - f"{self.ENDPOINT}{account1.pk}/", - data={ - "name": "Updated Name 1", - "password": "******", - }, - ) - - self.assertEqual(response.status_code, 200) - - returned_account1 = MailAccount.objects.get(pk=account1.pk) - self.assertEqual(returned_account1.name, "Updated Name 1") - self.assertEqual(returned_account1.password, account1.password) - - response = self.client.patch( - f"{self.ENDPOINT}{account1.pk}/", - data={ - "name": "Updated Name 2", - "password": "123xyz", - }, - ) - - self.assertEqual(response.status_code, 200) - - returned_account2 = MailAccount.objects.get(pk=account1.pk) - self.assertEqual(returned_account2.name, "Updated Name 2") - self.assertEqual(returned_account2.password, "123xyz") - - -class TestAPIMailRules(APITestCase): - ENDPOINT = "/api/mail_rules/" - - def setUp(self): - super().setUp() - - self.user = User.objects.create_superuser(username="temp_admin") - self.client.force_authenticate(user=self.user) - - def test_get_mail_rules(self): - """ - GIVEN: - - Configured mail accounts and rules - WHEN: - - API call is made to get mail rules - THEN: - - Configured mail rules are provided - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - rule1 = MailRule.objects.create( - name="Rule1", - account=account1, - folder="INBOX", - filter_from="from@example.com", - filter_subject="subject", - filter_body="body", - filter_attachment_filename="file.pdf", - maximum_age=30, - action=MailRule.MailAction.MARK_READ, - assign_title_from=MailRule.TitleSource.FROM_SUBJECT, - assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, - order=0, - attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, - ) - - response = self.client.get(self.ENDPOINT) - - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data["count"], 1) - returned_rule1 = response.data["results"][0] - - self.assertEqual(returned_rule1["name"], rule1.name) - self.assertEqual(returned_rule1["account"], account1.pk) - self.assertEqual(returned_rule1["folder"], rule1.folder) - self.assertEqual(returned_rule1["filter_from"], rule1.filter_from) - self.assertEqual(returned_rule1["filter_subject"], rule1.filter_subject) - self.assertEqual(returned_rule1["filter_body"], rule1.filter_body) - self.assertEqual( - returned_rule1["filter_attachment_filename"], - rule1.filter_attachment_filename, - ) - self.assertEqual(returned_rule1["maximum_age"], rule1.maximum_age) - self.assertEqual(returned_rule1["action"], rule1.action) - self.assertEqual(returned_rule1["assign_title_from"], rule1.assign_title_from) - self.assertEqual( - returned_rule1["assign_correspondent_from"], - rule1.assign_correspondent_from, - ) - self.assertEqual(returned_rule1["order"], rule1.order) - self.assertEqual(returned_rule1["attachment_type"], rule1.attachment_type) - - def test_create_mail_rule(self): - """ - GIVEN: - - Configured mail account exists - WHEN: - - API request is made to add a mail rule - THEN: - - A new mail rule is created - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - tag = Tag.objects.create( - name="t", - ) - - correspondent = Correspondent.objects.create( - name="c", - ) - - document_type = DocumentType.objects.create( - name="dt", - ) - - rule1 = { - "name": "Rule1", - "account": account1.pk, - "folder": "INBOX", - "filter_from": "from@example.com", - "filter_subject": "subject", - "filter_body": "body", - "filter_attachment_filename": "file.pdf", - "maximum_age": 30, - "action": MailRule.MailAction.MARK_READ, - "assign_title_from": MailRule.TitleSource.FROM_SUBJECT, - "assign_correspondent_from": MailRule.CorrespondentSource.FROM_NOTHING, - "order": 0, - "attachment_type": MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, - "action_parameter": "parameter", - "assign_tags": [tag.pk], - "assign_correspondent": correspondent.pk, - "assign_document_type": document_type.pk, - } - - response = self.client.post( - self.ENDPOINT, - data=rule1, - ) - - self.assertEqual(response.status_code, 201) - - response = self.client.get(self.ENDPOINT) - - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data["count"], 1) - returned_rule1 = response.data["results"][0] - - self.assertEqual(returned_rule1["name"], rule1["name"]) - self.assertEqual(returned_rule1["account"], account1.pk) - self.assertEqual(returned_rule1["folder"], rule1["folder"]) - self.assertEqual(returned_rule1["filter_from"], rule1["filter_from"]) - self.assertEqual(returned_rule1["filter_subject"], rule1["filter_subject"]) - self.assertEqual(returned_rule1["filter_body"], rule1["filter_body"]) - self.assertEqual( - returned_rule1["filter_attachment_filename"], - rule1["filter_attachment_filename"], - ) - self.assertEqual(returned_rule1["maximum_age"], rule1["maximum_age"]) - self.assertEqual(returned_rule1["action"], rule1["action"]) - self.assertEqual( - returned_rule1["assign_title_from"], - rule1["assign_title_from"], - ) - self.assertEqual( - returned_rule1["assign_correspondent_from"], - rule1["assign_correspondent_from"], - ) - self.assertEqual(returned_rule1["order"], rule1["order"]) - self.assertEqual(returned_rule1["attachment_type"], rule1["attachment_type"]) - self.assertEqual(returned_rule1["action_parameter"], rule1["action_parameter"]) - self.assertEqual( - returned_rule1["assign_correspondent"], - rule1["assign_correspondent"], - ) - self.assertEqual( - returned_rule1["assign_document_type"], - rule1["assign_document_type"], - ) - self.assertEqual(returned_rule1["assign_tags"], rule1["assign_tags"]) - - def test_delete_mail_rule(self): - """ - GIVEN: - - Existing mail rule - WHEN: - - API request is made to delete a mail rule - THEN: - - Rule is deleted - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - rule1 = MailRule.objects.create( - name="Rule1", - account=account1, - folder="INBOX", - filter_from="from@example.com", - filter_subject="subject", - filter_body="body", - filter_attachment_filename="file.pdf", - maximum_age=30, - action=MailRule.MailAction.MARK_READ, - assign_title_from=MailRule.TitleSource.FROM_SUBJECT, - assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, - order=0, - attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, - ) - - response = self.client.delete( - f"{self.ENDPOINT}{rule1.pk}/", - ) - - self.assertEqual(response.status_code, 204) - - self.assertEqual(len(MailRule.objects.all()), 0) - - def test_update_mail_rule(self): - """ - GIVEN: - - Existing mail rule - WHEN: - - API request is made to update mail rule - THEN: - - The mail rule is updated - """ - - account1 = MailAccount.objects.create( - name="Email1", - username="username1", - password="password1", - imap_server="server.example.com", - imap_port=443, - imap_security=MailAccount.ImapSecurity.SSL, - character_set="UTF-8", - ) - - rule1 = MailRule.objects.create( - name="Rule1", - account=account1, - folder="INBOX", - filter_from="from@example.com", - filter_subject="subject", - filter_body="body", - filter_attachment_filename="file.pdf", - maximum_age=30, - action=MailRule.MailAction.MARK_READ, - assign_title_from=MailRule.TitleSource.FROM_SUBJECT, - assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, - order=0, - attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, - ) - - response = self.client.patch( - f"{self.ENDPOINT}{rule1.pk}/", - data={ - "name": "Updated Name 1", - "action": MailRule.MailAction.DELETE, - }, - ) - - self.assertEqual(response.status_code, 200) - - returned_rule1 = MailRule.objects.get(pk=rule1.pk) - self.assertEqual(returned_rule1.name, "Updated Name 1") - self.assertEqual(returned_rule1.action, MailRule.MailAction.DELETE) diff --git a/src/documents/views.py b/src/documents/views.py index f980805f2..b0999ad37 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -35,6 +35,8 @@ from paperless.db import GnuPG from paperless.views import StandardPagination from paperless_mail.models import MailAccount from paperless_mail.models import MailRule +from paperless_mail.serialisers import MailAccountSerializer +from paperless_mail.serialisers import MailRuleSerializer from rest_framework import parsers from rest_framework.decorators import action from rest_framework.exceptions import NotFound @@ -83,8 +85,6 @@ from .serialisers import CorrespondentSerializer from .serialisers import DocumentListSerializer from .serialisers import DocumentSerializer from .serialisers import DocumentTypeSerializer -from .serialisers import MailAccountSerializer -from .serialisers import MailRuleSerializer from .serialisers import PostDocumentSerializer from .serialisers import SavedViewSerializer from .serialisers import StoragePathSerializer diff --git a/src/paperless/urls.py b/src/paperless/urls.py index afad7cb9f..8e8f4b404 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -14,8 +14,6 @@ from documents.views import CorrespondentViewSet from documents.views import DocumentTypeViewSet from documents.views import IndexView from documents.views import LogViewSet -from documents.views import MailAccountViewSet -from documents.views import MailRuleViewSet from documents.views import PostDocumentView from documents.views import RemoteVersionView from documents.views import SavedViewViewSet @@ -29,6 +27,8 @@ from documents.views import UiSettingsView from documents.views import UnifiedSearchViewSet from paperless.consumers import StatusConsumer from paperless.views import FaviconView +from paperless_mail.views import MailAccountViewSet +from paperless_mail.views import MailRuleViewSet from rest_framework.authtoken import views from rest_framework.routers import DefaultRouter diff --git a/src/paperless_mail/serialisers.py b/src/paperless_mail/serialisers.py new file mode 100644 index 000000000..5944656a7 --- /dev/null +++ b/src/paperless_mail/serialisers.py @@ -0,0 +1,110 @@ +from documents.serialisers import CorrespondentField +from documents.serialisers import DocumentTypeField +from documents.serialisers import TagsField +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from rest_framework import serializers + + +class ObfuscatedPasswordField(serializers.Field): + """ + Sends *** string instead of password in the clear + """ + + def to_representation(self, value): + return "*" * len(value) + + def to_internal_value(self, data): + return data + + +class MailAccountSerializer(serializers.ModelSerializer): + password = ObfuscatedPasswordField() + + class Meta: + model = MailAccount + depth = 1 + fields = [ + "id", + "name", + "imap_server", + "imap_port", + "imap_security", + "username", + "password", + "character_set", + ] + + def update(self, instance, validated_data): + if "password" in validated_data: + if len(validated_data.get("password").replace("*", "")) == 0: + validated_data.pop("password") + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + mail_account = MailAccount.objects.create(**validated_data) + return mail_account + + +class AccountField(serializers.PrimaryKeyRelatedField): + def get_queryset(self): + return MailAccount.objects.all().order_by("-id") + + +class MailRuleSerializer(serializers.ModelSerializer): + account = AccountField(required=True) + action_parameter = serializers.CharField( + allow_null=True, + required=False, + default="", + ) + assign_correspondent = CorrespondentField(allow_null=True, required=False) + assign_tags = TagsField(many=True, allow_null=True, required=False) + assign_document_type = DocumentTypeField(allow_null=True, required=False) + order = serializers.IntegerField(required=False) + + class Meta: + model = MailRule + depth = 1 + fields = [ + "id", + "name", + "account", + "folder", + "filter_from", + "filter_subject", + "filter_body", + "filter_attachment_filename", + "maximum_age", + "action", + "action_parameter", + "assign_title_from", + "assign_tags", + "assign_correspondent_from", + "assign_correspondent", + "assign_document_type", + "order", + "attachment_type", + ] + + def update(self, instance, validated_data): + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + if "assign_tags" in validated_data: + assign_tags = validated_data.pop("assign_tags") + mail_rule = MailRule.objects.create(**validated_data) + if assign_tags: + mail_rule.assign_tags.set(assign_tags) + return mail_rule + + def validate(self, attrs): + if ( + attrs["action"] == MailRule.MailAction.TAG + or attrs["action"] == MailRule.MailAction.MOVE + ) and attrs["action_parameter"] is None: + raise serializers.ValidationError("An action parameter is required.") + + return attrs diff --git a/src/paperless_mail/tests/test_api.py b/src/paperless_mail/tests/test_api.py new file mode 100644 index 000000000..d20ab5c9a --- /dev/null +++ b/src/paperless_mail/tests/test_api.py @@ -0,0 +1,429 @@ +from django.contrib.auth.models import User +from documents.models import Correspondent +from documents.models import DocumentType +from documents.models import Tag +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from rest_framework.test import APITestCase + + +class TestAPIMailAccounts(APITestCase): + ENDPOINT = "/api/mail_accounts/" + + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_authenticate(user=self.user) + + def test_get_mail_accounts(self): + """ + GIVEN: + - Configured mail accounts + WHEN: + - API call is made to get mail accounts + THEN: + - Configured mail accounts are provided + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_account1 = response.data["results"][0] + + self.assertEqual(returned_account1["name"], account1.name) + self.assertEqual(returned_account1["username"], account1.username) + self.assertEqual( + returned_account1["password"], + "*" * len(account1.password), + ) + self.assertEqual(returned_account1["imap_server"], account1.imap_server) + self.assertEqual(returned_account1["imap_port"], account1.imap_port) + self.assertEqual(returned_account1["imap_security"], account1.imap_security) + self.assertEqual(returned_account1["character_set"], account1.character_set) + + def test_create_mail_account(self): + """ + WHEN: + - API request is made to add a mail account + THEN: + - A new mail account is created + """ + + account1 = { + "name": "Email1", + "username": "username1", + "password": "password1", + "imap_server": "server.example.com", + "imap_port": 443, + "imap_security": MailAccount.ImapSecurity.SSL, + "character_set": "UTF-8", + } + + response = self.client.post( + self.ENDPOINT, + data=account1, + ) + + self.assertEqual(response.status_code, 201) + + returned_account1 = MailAccount.objects.get(name="Email1") + + self.assertEqual(returned_account1.name, account1["name"]) + self.assertEqual(returned_account1.username, account1["username"]) + self.assertEqual(returned_account1.password, account1["password"]) + self.assertEqual(returned_account1.imap_server, account1["imap_server"]) + self.assertEqual(returned_account1.imap_port, account1["imap_port"]) + self.assertEqual(returned_account1.imap_security, account1["imap_security"]) + self.assertEqual(returned_account1.character_set, account1["character_set"]) + + def test_delete_mail_account(self): + """ + GIVEN: + - Existing mail account + WHEN: + - API request is made to delete a mail account + THEN: + - Account is deleted + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.delete( + f"{self.ENDPOINT}{account1.pk}/", + ) + + self.assertEqual(response.status_code, 204) + + self.assertEqual(len(MailAccount.objects.all()), 0) + + def test_update_mail_account(self): + """ + GIVEN: + - Existing mail accounts + WHEN: + - API request is made to update mail account + THEN: + - The mail account is updated, password only updated if not '****' + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.patch( + f"{self.ENDPOINT}{account1.pk}/", + data={ + "name": "Updated Name 1", + "password": "******", + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_account1 = MailAccount.objects.get(pk=account1.pk) + self.assertEqual(returned_account1.name, "Updated Name 1") + self.assertEqual(returned_account1.password, account1.password) + + response = self.client.patch( + f"{self.ENDPOINT}{account1.pk}/", + data={ + "name": "Updated Name 2", + "password": "123xyz", + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_account2 = MailAccount.objects.get(pk=account1.pk) + self.assertEqual(returned_account2.name, "Updated Name 2") + self.assertEqual(returned_account2.password, "123xyz") + + +class TestAPIMailRules(APITestCase): + ENDPOINT = "/api/mail_rules/" + + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_authenticate(user=self.user) + + def test_get_mail_rules(self): + """ + GIVEN: + - Configured mail accounts and rules + WHEN: + - API call is made to get mail rules + THEN: + - Configured mail rules are provided + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_rule1 = response.data["results"][0] + + self.assertEqual(returned_rule1["name"], rule1.name) + self.assertEqual(returned_rule1["account"], account1.pk) + self.assertEqual(returned_rule1["folder"], rule1.folder) + self.assertEqual(returned_rule1["filter_from"], rule1.filter_from) + self.assertEqual(returned_rule1["filter_subject"], rule1.filter_subject) + self.assertEqual(returned_rule1["filter_body"], rule1.filter_body) + self.assertEqual( + returned_rule1["filter_attachment_filename"], + rule1.filter_attachment_filename, + ) + self.assertEqual(returned_rule1["maximum_age"], rule1.maximum_age) + self.assertEqual(returned_rule1["action"], rule1.action) + self.assertEqual(returned_rule1["assign_title_from"], rule1.assign_title_from) + self.assertEqual( + returned_rule1["assign_correspondent_from"], + rule1.assign_correspondent_from, + ) + self.assertEqual(returned_rule1["order"], rule1.order) + self.assertEqual(returned_rule1["attachment_type"], rule1.attachment_type) + + def test_create_mail_rule(self): + """ + GIVEN: + - Configured mail account exists + WHEN: + - API request is made to add a mail rule + THEN: + - A new mail rule is created + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + tag = Tag.objects.create( + name="t", + ) + + correspondent = Correspondent.objects.create( + name="c", + ) + + document_type = DocumentType.objects.create( + name="dt", + ) + + rule1 = { + "name": "Rule1", + "account": account1.pk, + "folder": "INBOX", + "filter_from": "from@example.com", + "filter_subject": "subject", + "filter_body": "body", + "filter_attachment_filename": "file.pdf", + "maximum_age": 30, + "action": MailRule.MailAction.MARK_READ, + "assign_title_from": MailRule.TitleSource.FROM_SUBJECT, + "assign_correspondent_from": MailRule.CorrespondentSource.FROM_NOTHING, + "order": 0, + "attachment_type": MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + "action_parameter": "parameter", + "assign_tags": [tag.pk], + "assign_correspondent": correspondent.pk, + "assign_document_type": document_type.pk, + } + + response = self.client.post( + self.ENDPOINT, + data=rule1, + ) + + self.assertEqual(response.status_code, 201) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_rule1 = response.data["results"][0] + + self.assertEqual(returned_rule1["name"], rule1["name"]) + self.assertEqual(returned_rule1["account"], account1.pk) + self.assertEqual(returned_rule1["folder"], rule1["folder"]) + self.assertEqual(returned_rule1["filter_from"], rule1["filter_from"]) + self.assertEqual(returned_rule1["filter_subject"], rule1["filter_subject"]) + self.assertEqual(returned_rule1["filter_body"], rule1["filter_body"]) + self.assertEqual( + returned_rule1["filter_attachment_filename"], + rule1["filter_attachment_filename"], + ) + self.assertEqual(returned_rule1["maximum_age"], rule1["maximum_age"]) + self.assertEqual(returned_rule1["action"], rule1["action"]) + self.assertEqual( + returned_rule1["assign_title_from"], + rule1["assign_title_from"], + ) + self.assertEqual( + returned_rule1["assign_correspondent_from"], + rule1["assign_correspondent_from"], + ) + self.assertEqual(returned_rule1["order"], rule1["order"]) + self.assertEqual(returned_rule1["attachment_type"], rule1["attachment_type"]) + self.assertEqual(returned_rule1["action_parameter"], rule1["action_parameter"]) + self.assertEqual( + returned_rule1["assign_correspondent"], + rule1["assign_correspondent"], + ) + self.assertEqual( + returned_rule1["assign_document_type"], + rule1["assign_document_type"], + ) + self.assertEqual(returned_rule1["assign_tags"], rule1["assign_tags"]) + + def test_delete_mail_rule(self): + """ + GIVEN: + - Existing mail rule + WHEN: + - API request is made to delete a mail rule + THEN: + - Rule is deleted + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.delete( + f"{self.ENDPOINT}{rule1.pk}/", + ) + + self.assertEqual(response.status_code, 204) + + self.assertEqual(len(MailRule.objects.all()), 0) + + def test_update_mail_rule(self): + """ + GIVEN: + - Existing mail rule + WHEN: + - API request is made to update mail rule + THEN: + - The mail rule is updated + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.patch( + f"{self.ENDPOINT}{rule1.pk}/", + data={ + "name": "Updated Name 1", + "action": MailRule.MailAction.DELETE, + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_rule1 = MailRule.objects.get(pk=rule1.pk) + self.assertEqual(returned_rule1.name, "Updated Name 1") + self.assertEqual(returned_rule1.action, MailRule.MailAction.DELETE) diff --git a/src/paperless_mail/views.py b/src/paperless_mail/views.py new file mode 100644 index 000000000..b91487f1f --- /dev/null +++ b/src/paperless_mail/views.py @@ -0,0 +1,41 @@ +from paperless.views import StandardPagination +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from paperless_mail.serialisers import MailAccountSerializer +from paperless_mail.serialisers import MailRuleSerializer +from rest_framework.permissions import IsAuthenticated +from rest_framework.viewsets import ModelViewSet + + +class MailAccountViewSet(ModelViewSet): + model = MailAccount + + queryset = MailAccount.objects.all() + serializer_class = MailAccountSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailAccount.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user) + + +class MailRuleViewSet(ModelViewSet): + model = MailRule + + queryset = MailRule.objects.all() + serializer_class = MailRuleSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailRule.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user) From 4f876db5d1d1407a8660aa1c58322fc8e36701e2 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 28 Nov 2022 21:38:52 -0800 Subject: [PATCH 24/26] prevent loss of unsaved changes to settings on tab nav --- .../manage/settings/settings.component.ts | 24 +++++++++++++++---- src-ui/src/app/guards/dirty-form.guard.ts | 1 - 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 1c51c90b2..2d23874fd 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -206,7 +206,16 @@ export class SettingsComponent SettingsNavIDs ).find(([navIDkey, navIDValue]) => navIDValue == navChangeEvent.nextId) if (foundNavIDkey) - this.router.navigate(['settings', foundNavIDkey.toLowerCase()]) + // if its dirty we need to wait for confirmation + this.router + .navigate(['settings', foundNavIDkey.toLowerCase()]) + .then((navigated) => { + if (!navigated && this.isDirty) { + this.activeNavID = navChangeEvent.activeId + } else if (navigated && this.isDirty) { + this.initialize() + } + }) } // Load tab contents 'on demand', either on mouseover or focusin (i.e. before click) or called from nav change event @@ -214,7 +223,7 @@ export class SettingsComponent if (navID == SettingsNavIDs.SavedViews && !this.savedViews) { this.savedViewService.listAll().subscribe((r) => { this.savedViews = r.results - this.initialize() + this.initialize(false) }) } else if ( navID == SettingsNavIDs.Mail && @@ -225,15 +234,17 @@ export class SettingsComponent this.mailRuleService.listAll().subscribe((r) => { this.mailRules = r.results - this.initialize() + this.initialize(false) }) }) } } - initialize() { + initialize(resetSettings: boolean = true) { this.unsubscribeNotifier.next(true) + const currentFormValue = this.settingsForm.value + let storeData = this.getCurrentSettings() if (this.savedViews) { @@ -352,6 +363,11 @@ export class SettingsComponent this.settingsForm.get('themeColor').value ) }) + + if (!resetSettings && currentFormValue) { + // prevents loss of unsaved changes + this.settingsForm.patchValue(currentFormValue) + } } ngOnDestroy() { diff --git a/src-ui/src/app/guards/dirty-form.guard.ts b/src-ui/src/app/guards/dirty-form.guard.ts index 1205f3b0e..e20f1a848 100644 --- a/src-ui/src/app/guards/dirty-form.guard.ts +++ b/src-ui/src/app/guards/dirty-form.guard.ts @@ -1,7 +1,6 @@ import { Injectable } from '@angular/core' import { DirtyCheckGuard } from '@ngneat/dirty-check-forms' import { Observable, Subject } from 'rxjs' -import { map } from 'rxjs/operators' import { NgbModal } from '@ng-bootstrap/ng-bootstrap' import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component' From ce9f604d81820a4fba83ec38e5f58e6317165814 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 3 Dec 2022 09:29:34 -0800 Subject: [PATCH 25/26] Explicit default ordering for rule / account views --- src/documents/views.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/documents/views.py b/src/documents/views.py index b0999ad37..3b2075e25 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -919,7 +919,7 @@ class AcknowledgeTasksView(GenericAPIView): class MailAccountViewSet(ModelViewSet): model = MailAccount - queryset = MailAccount.objects.all() + queryset = MailAccount.objects.all().order_by("pk") serializer_class = MailAccountSerializer pagination_class = StandardPagination permission_classes = (IsAuthenticated,) @@ -936,7 +936,7 @@ class MailAccountViewSet(ModelViewSet): class MailRuleViewSet(ModelViewSet): model = MailRule - queryset = MailRule.objects.all() + queryset = MailRule.objects.all().order_by("pk") serializer_class = MailRuleSerializer pagination_class = StandardPagination permission_classes = (IsAuthenticated,) From 049dc17902c11456323e3a68327963dfd3cd5f1c Mon Sep 17 00:00:00 2001 From: Trenton Holmes <797416+stumpylog@users.noreply.github.com> Date: Sun, 4 Dec 2022 16:33:07 -0800 Subject: [PATCH 26/26] Moves where the mail views live and puts the ordering on those --- src/documents/views.py | 38 ------------------------------------- src/paperless_mail/views.py | 4 ++-- 2 files changed, 2 insertions(+), 40 deletions(-) diff --git a/src/documents/views.py b/src/documents/views.py index 3b2075e25..10225be6f 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -33,10 +33,6 @@ from packaging import version as packaging_version from paperless import version from paperless.db import GnuPG from paperless.views import StandardPagination -from paperless_mail.models import MailAccount -from paperless_mail.models import MailRule -from paperless_mail.serialisers import MailAccountSerializer -from paperless_mail.serialisers import MailRuleSerializer from rest_framework import parsers from rest_framework.decorators import action from rest_framework.exceptions import NotFound @@ -914,37 +910,3 @@ class AcknowledgeTasksView(GenericAPIView): return Response({"result": result}) except Exception: return HttpResponseBadRequest() - - -class MailAccountViewSet(ModelViewSet): - model = MailAccount - - queryset = MailAccount.objects.all().order_by("pk") - serializer_class = MailAccountSerializer - pagination_class = StandardPagination - permission_classes = (IsAuthenticated,) - - # TODO: user-scoped - # def get_queryset(self): - # user = self.request.user - # return MailAccount.objects.filter(user=user) - - # def perform_create(self, serializer): - # serializer.save(user=self.request.user) - - -class MailRuleViewSet(ModelViewSet): - model = MailRule - - queryset = MailRule.objects.all().order_by("pk") - serializer_class = MailRuleSerializer - pagination_class = StandardPagination - permission_classes = (IsAuthenticated,) - - # TODO: user-scoped - # def get_queryset(self): - # user = self.request.user - # return MailRule.objects.filter(user=user) - - # def perform_create(self, serializer): - # serializer.save(user=self.request.user) diff --git a/src/paperless_mail/views.py b/src/paperless_mail/views.py index b91487f1f..d86240c7c 100644 --- a/src/paperless_mail/views.py +++ b/src/paperless_mail/views.py @@ -10,7 +10,7 @@ from rest_framework.viewsets import ModelViewSet class MailAccountViewSet(ModelViewSet): model = MailAccount - queryset = MailAccount.objects.all() + queryset = MailAccount.objects.all().order_by("pk") serializer_class = MailAccountSerializer pagination_class = StandardPagination permission_classes = (IsAuthenticated,) @@ -27,7 +27,7 @@ class MailAccountViewSet(ModelViewSet): class MailRuleViewSet(ModelViewSet): model = MailRule - queryset = MailRule.objects.all() + queryset = MailRule.objects.all().order_by("pk") serializer_class = MailRuleSerializer pagination_class = StandardPagination permission_classes = (IsAuthenticated,)