WIP on enabling/disabling automatic analysis process for a document

2022-02-02 22:07:29 +02:00 · 2022-02-02 22:07:29 +02:00 · 698e0c1a3b
commit 698e0c1a3b
parent 60acd1abc1
15 changed files with 140 additions and 7 deletions
--- a/apps/red-ui/src/app/modules/dossier/screens/dossier-overview/components/bulk-actions/dossier-overview-bulk-actions.component.ts
+++ b/apps/red-ui/src/app/modules/dossier/screens/dossier-overview/components/bulk-actions/dossier-overview-bulk-actions.component.ts
@ -25,6 +25,8 @@ export class DossierOverviewBulkActionsComponent implements OnChanges {
    canAssign: boolean;
    canDelete: boolean;
    canReanalyse: boolean;
+    canDisableAutoAnalysis: boolean;
+    canEnableAutoAnalysis: boolean;
    canOcr: boolean;
    canSetToUnderReview: boolean;
    canSetToUnderApproval: boolean;
@ -114,6 +116,20 @@ export class DossierOverviewBulkActionsComponent implements OnChanges {
                icon: 'iqser:refresh',
                show: this.canReanalyse && this.analysisForced,
            },
+            {
+                type: ActionTypes.circleBtn,
+                action: $event => this._bulkActionsService.toggleAutomaticAnalysis(this.selectedFiles, true),
+                tooltip: _('dossier-overview.disable-auto-analysis'),
+                icon: 'red:stop',
+                show: this.canDisableAutoAnalysis,
+            },
+            {
+                type: ActionTypes.circleBtn,
+                action: $event => this._bulkActionsService.toggleAutomaticAnalysis(this.selectedFiles),
+                tooltip: _('dossier-overview.enable-auto-analysis'),
+                icon: 'red:play',
+                show: this.canEnableAutoAnalysis,
+            },
        ].filter(btn => btn.show);
    }

@ -149,6 +165,10 @@ export class DossierOverviewBulkActionsComponent implements OnChanges {

            this.canReanalyse = this._permissionsService.canReanalyseFile(this.selectedFiles);

+            this.canDisableAutoAnalysis = this._permissionsService.canDisableAutoAnalysis(this.selectedFiles);
+
+            this.canEnableAutoAnalysis = this._permissionsService.canEnableAutoAnalysis(this.selectedFiles);
+
            this.canOcr = this.selectedFiles.reduce((acc, file) => acc && file.canBeOCRed, true);

            this.canSetToUnderReview = this._permissionsService.canSetUnderReview(this.selectedFiles) && !isWorkflow;
--- a/apps/red-ui/src/app/modules/dossier/screens/dossier-overview/services/bulk-actions.service.ts
+++ b/apps/red-ui/src/app/modules/dossier/screens/dossier-overview/services/bulk-actions.service.ts
@ -83,6 +83,13 @@ export class BulkActionsService {
        this._loadingService.stop();
    }

+    async toggleAutomaticAnalysis(files: File[], excluded?: boolean) {
+        this._loadingService.start();
+        const fileIds = files.map(file => file.fileId);
+        await firstValueFrom(this._reanalysisService.toggleAutomaticAnalysis(files[0].dossierId, fileIds, excluded));
+        this._loadingService.stop();
+    }
+
    async backToUnderReview(files: File[]): Promise<void> {
        this._loadingService.start();
        await firstValueFrom(
--- a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/file-workload/file-workload.component.html
+++ b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/file-workload/file-workload.component.html
@ -31,12 +31,18 @@
 </ng-template>

 <div class="right-content">
-    <div *ngIf="isReadOnly" class="justify-center read-only d-flex">
+    <div *ngIf="isReadOnly" class="justify-center banner read-only d-flex">
        <div class="flex-center">
            <mat-icon class="primary-white" svgIcon="red:read-only"></mat-icon>
            <span class="read-only-text" translate="readonly"></span>
        </div>
    </div>
+    <div *ngIf="file.excludedFromAutomaticAnalysis" class="justify-center banner disabled-auto-analysis d-flex">
+        <div class="flex-center">
+            <mat-icon class="primary-white" svgIcon="red:denied"></mat-icon>
+            <span class="disabled-auto-analysis-text" translate="disabled-auto-analysis"></span>
+        </div>
+    </div>

    <div *ngIf="multiSelectActive$ | async" class="multi-select">
        <div class="selected-wrapper">
--- a/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/file-workload/file-workload.component.scss
+++ b/apps/red-ui/src/app/modules/dossier/screens/file-preview-screen/components/file-workload/file-workload.component.scss
@ -1,13 +1,13 @@
@use 'apps/red-ui/src/assets/styles/variables';
@use 'libs/common-ui/src/assets/styles/common-mixins';

-.read-only {
+.banner {
    padding: 13px 16px;
-    background-color: variables.$primary;
    color: variables.$white;
    justify-content: space-between;

-    .read-only-text {
+    .read-only-text,
+    .disabled-auto-analysis-text {
        font-size: 11px;
        font-weight: 600;
        line-height: 14px;
@ -33,8 +33,17 @@
    }
 }

+.read-only {
+    background-color: variables.$primary;
+}
+
+.disabled-auto-analysis {
+    background-color: variables.$yellow-2;
+}
+
 .right-content {
    flex-direction: column;
+    overflow: hidden;

    .no-annotations-buttons-container {
        display: flex;
--- a/apps/red-ui/src/app/modules/dossier/shared/components/file-actions/file-actions.component.ts
+++ b/apps/red-ui/src/app/modules/dossier/shared/components/file-actions/file-actions.component.ts
@ -62,6 +62,8 @@ export class FileActionsComponent extends AutoUnsubscribe implements OnDestroy,
    showDelete = false;
    showOCR = false;
    canReanalyse = false;
+    canDisableAutoAnalysis = false;
+    canEnableAutoAnalysis = false;
    showUnderReview = false;
    showUnderApproval = false;
    showApprove = false;
@ -182,6 +184,20 @@ export class FileActionsComponent extends AutoUnsubscribe implements OnDestroy,
                disabled: !this.file.canBeApproved,
                show: this.showApprove,
            },
+            {
+                type: ActionTypes.circleBtn,
+                action: $event => this.toggleAutomaticAnalysis($event),
+                tooltip: _('dossier-overview.disable-auto-analysis'),
+                icon: 'red:stop',
+                show: this.canDisableAutoAnalysis,
+            },
+            {
+                type: ActionTypes.circleBtn,
+                action: $event => this.toggleAutomaticAnalysis($event),
+                tooltip: _('dossier-overview.enable-auto-analysis'),
+                icon: 'red:play',
+                show: this.canEnableAutoAnalysis,
+            },
            {
                type: ActionTypes.circleBtn,
                action: $event => this._setFileUnderApproval($event),
@ -296,12 +312,23 @@ export class FileActionsComponent extends AutoUnsubscribe implements OnDestroy,
    }

    private async _reanalyseFile($event?: MouseEvent) {
-        if ($event) {
-            $event.stopPropagation();
-        }
+        $event?.stopPropagation();
        await firstValueFrom(this._reanalysisService.reanalyzeFilesForDossier([this.file.fileId], this.file.dossierId, true));
    }

+    private async toggleAutomaticAnalysis($event: MouseEvent) {
+        $event.stopPropagation();
+        this._loadingService.start();
+        await firstValueFrom(
+            this._reanalysisService.toggleAutomaticAnalysis(
+                this.file.dossierId,
+                [this.file.fileId],
+                !this.file.excludedFromAutomaticAnalysis,
+            ),
+        );
+        this._loadingService.stop();
+    }
+
    private async _setFileUnderApproval($event: MouseEvent) {
        $event.stopPropagation();
        await this._fileAssignService.assignApprover($event, this.file, true);
@ -345,6 +372,8 @@ export class FileActionsComponent extends AutoUnsubscribe implements OnDestroy,
        this.showDelete = this._permissionsService.canDeleteFile(this.file);
        this.showOCR = this.file.canBeOCRed;
        this.canReanalyse = this._permissionsService.canReanalyseFile(this.file);
+        this.canDisableAutoAnalysis = this._permissionsService.canDisableAutoAnalysis(this.file);
+        this.canEnableAutoAnalysis = this._permissionsService.canEnableAutoAnalysis(this.file);

        this.showStatusBar = !this.file.isError && !this.file.isPending && this.isDossierOverviewList;

--- a/apps/red-ui/src/app/modules/icons/icons.module.ts
+++ b/apps/red-ui/src/app/modules/icons/icons.module.ts
@ -24,6 +24,7 @@ export class IconsModule {
            'comment-fill',
            'csv',
            'dictionary',
+            'denied',
            'double-chevron-right',
            'enter',
            'entries',
@ -44,6 +45,7 @@ export class IconsModule {
            'new-tab',
            'notification',
            'page',
+            'play',
            'preview',
            'put-back',
            'read-only',
@ -59,6 +61,7 @@ export class IconsModule {
            'secret',
            'status',
            'status-info',
+            'stop',
            'template',
            'thumb-down',
            'thumb-up',
--- a/apps/red-ui/src/app/services/permissions.service.ts
+++ b/apps/red-ui/src/app/services/permissions.service.ts
@ -32,6 +32,16 @@ export class PermissionsService {
        return files.reduce((acc, _file) => this._canReanalyseFile(_file) && acc, true);
    }

+    canDisableAutoAnalysis(file: File | File[]): boolean {
+        const files = file instanceof File ? [file] : file;
+        return files.reduce((acc, _file) => this._canDisableAutoAnalysis(_file) && acc, true);
+    }
+
+    canEnableAutoAnalysis(file: File | File[]): boolean {
+        const files = file instanceof File ? [file] : file;
+        return files.reduce((acc, _file) => this._canEnableAutoAnalysis(_file) && acc, true);
+    }
+
    isFileAssignee(file: File): boolean {
        return file.assignee === this._userService.currentUser.id;
    }
@ -158,6 +168,14 @@ export class PermissionsService {
        return this.isReviewerOrApprover(file) || file.isNew || (file.isError && file.isNew);
    }

+    private _canDisableAutoAnalysis(file: File): boolean {
+        return !file.excludedFromAutomaticAnalysis && file.assignee === this._userService.currentUser.id;
+    }
+
+    private _canEnableAutoAnalysis(file: File): boolean {
+        return file.excludedFromAutomaticAnalysis && file.assignee === this._userService.currentUser.id;
+    }
+
    private _canAssignToSelf(file: File, dossier: Dossier): boolean {
        const precondition = this.isDossierMember(dossier) && !this.isFileAssignee(file) && !file.isError && !file.isProcessing;
        return precondition && (file.isNew || file.isUnderReview || (file.isUnderApproval && this.isApprover(dossier)));
--- a/apps/red-ui/src/app/services/reanalysis.service.ts
+++ b/apps/red-ui/src/app/services/reanalysis.service.ts
@ -44,6 +44,16 @@ export class ReanalysisService extends GenericService<unknown> {
        );
    }

+    @Validate()
+    toggleAutomaticAnalysis(@RequiredParam() dossierId: string, @RequiredParam() fileIds: string[], excluded?: boolean) {
+        const queryParams: QueryParam[] = [{ key: 'excluded', value: !!excluded }];
+        return this._post(
+            fileIds.length > 1 ? fileIds : {},
+            `toggle-automatic-analysis/${dossierId}/${fileIds.length > 1 ? 'bulk' : fileIds[0]}`,
+            queryParams,
+        ).pipe(switchMap(() => this._filesService.loadAll(dossierId)));
+    }
+
    @Validate()
    ocrFiles(@RequiredParam() fileIds: List, @RequiredParam() dossierId: string) {
        return this._post(fileIds, `ocr/reanalyze/${dossierId}/bulk`).pipe(switchMap(() => this._filesService.loadAll(dossierId)));
--- a/apps/red-ui/src/assets/i18n/de.json
+++ b/apps/red-ui/src/assets/i18n/de.json
@ -608,6 +608,7 @@
      "placeholder": "Begründung"
    }
  },
+  "disabled-auto-analysis": "",
  "document-info": {
    "save": "Dokumenteninformation speichern",
    "title": "Datei-Attribute anlegen"
@ -719,6 +720,7 @@
    "delete": {
      "action": "Datei löschen"
    },
+    "disable-auto-analysis": "",
    "dossier-details": {
      "attributes": {
        "expand": "{count} {count, plural, one{benutzerdefiniertes Attribut} other{benutzerdefinierte Attribute}}",
@ -742,6 +744,7 @@
    },
    "download-file": "Herunterladen",
    "download-file-disabled": "Nur genehmigte Dateien können heruntergeladen werden",
+    "enable-auto-analysis": "",
    "file-listing": {
      "file-entry": {
        "file-error": "Reanalyse erforderlich",
--- a/apps/red-ui/src/assets/i18n/en.json
+++ b/apps/red-ui/src/assets/i18n/en.json
@ -608,6 +608,7 @@
      "placeholder": "Reason"
    }
  },
+  "disabled-auto-analysis": "Automatic analysys is disabled",
  "document-info": {
    "save": "Save Document Info",
    "title": "Introduce File Attributes"
@ -719,6 +720,7 @@
    "delete": {
      "action": "Delete File"
    },
+    "disable-auto-analysis": "Disable auto-analysis",
    "dossier-details": {
      "attributes": {
        "expand": "{count} custom {count, plural, one{attribute} other{attributes}}",
@ -742,6 +744,7 @@
    },
    "download-file": "Download",
    "download-file-disabled": "You need to be approver in the dossier and the {count, plural, one{file needs} other{files need}} to be approved in order to download.",
+    "enable-auto-analysis": "Enable auto-analysis",
    "file-listing": {
      "file-entry": {
        "file-error": "Re-processing required",
--- a/apps/red-ui/src/assets/icons/general/denied.svg
+++ b/apps/red-ui/src/assets/icons/general/denied.svg
@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Svg Vector Icons : http://www.onlinewebfonts.com/icon -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<metadata> Svg Vector Icons : http://www.onlinewebfonts.com/icon </metadata>
+<g><path d="M500,10C229.4,10,10,229.4,10,500c0,270.6,219.4,490,490,490c270.6,0,490-219.4,490-490C990,229.4,770.6,10,500,10z M500,876.9c-208.2,0-376.9-168.8-376.9-376.9c0-83.3,27.3-160.1,73.2-222.6l526.3,526.3C660.1,849.6,583.3,876.9,500,876.9z M802.6,724L276,197.3c62.6-46.5,140-74.2,224-74.2c208.2,0,376.9,168.7,376.9,376.9C876.9,584,849.1,661.3,802.6,724z"/></g>
+</svg>
--- a/apps/red-ui/src/assets/icons/general/play.svg
+++ b/apps/red-ui/src/assets/icons/general/play.svg
@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Svg Vector Icons : http://www.onlinewebfonts.com/icon -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve">
+<metadata> Svg Vector Icons : http://www.onlinewebfonts.com/icon </metadata>
+<g><path d="M990,56c0-25.4-20.6-46-46-46H56c-25.4,0-46,20.6-46,46V944c0,25.4,20.6,46,46,46H944c25.4,0,46-20.6,46-46L990,56L990,56z M898.2,882.8c0,8.5-6.9,15.3-15.3,15.3H117.2c-8.5,0-15.3-6.9-15.3-15.3V117.2c0-8.5,6.9-15.3,15.3-15.3h765.7c8.5,0,15.3,6.9,15.3,15.3V882.8z"/><path d="M362.8,662.5c0,5.6,2.8,11.1,8,14.3c5.1,3.2,11.3,3.3,16.3,0.7l313.3-156.6c5.5-2.8,9.3-8.4,9.3-15c0-6.6-3.8-12.3-9.3-15L387.1,334.2c-5-2.5-11.2-2.4-16.3,0.7c-5.1,3.2-8,8.7-8,14.3L362.8,662.5L362.8,662.5z"/></g>
+</svg>
--- a/apps/red-ui/src/assets/icons/general/stop.svg
+++ b/apps/red-ui/src/assets/icons/general/stop.svg
@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M504 256C504 119 393 8 256 8S8 119 8 256s111 248 248 248 248-111 248-248zm-448 0c0-110.5 89.5-200 200-200s200 89.5 200 200-89.5 200-200 200S56 366.5 56 256zm296-80v160c0 8.8-7.2 16-16 16H176c-8.8 0-16-7.2-16-16V176c0-8.8 7.2-16 16-16h160c8.8 0 16 7.2 16 16z"/></svg>
+<!--
+Font Awesome Free 5.2.0 by @fontawesome - https://fontawesome.com
+License - https://fontawesome.com/license (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
+-->
--- a/libs/red-domain/src/lib/files/file.model.ts
+++ b/libs/red-domain/src/lib/files/file.model.ts
@ -16,6 +16,7 @@ export class File extends Entity<IFile> implements IFile {
    readonly dossierDictionaryVersion?: number;
    readonly dossierId: string;
    readonly excluded: boolean;
+    readonly excludedFromAutomaticAnalysis: boolean;
    readonly fileAttributes?: FileAttributes;
    readonly fileId: string;
    readonly filename: string;
@ -68,6 +69,7 @@ export class File extends Entity<IFile> implements IFile {
        this.dossierDictionaryVersion = file.dossierDictionaryVersion;
        this.dossierId = file.dossierId;
        this.excluded = !!file.excluded;
+        this.excludedFromAutomaticAnalysis = Math.random() < 0.5; //!!file.excludedFromAutomaticAnalysis;
        this.fileAttributes = file.fileAttributes;
        this.fileId = file.fileId;
        this.filename = file.filename;
--- a/libs/red-domain/src/lib/files/file.ts
+++ b/libs/red-domain/src/lib/files/file.ts
@ -46,6 +46,10 @@ export interface IFile {
     * Shows if the file was excluded from analysis.
     */
    readonly excluded?: boolean;
+    /**
+     * Shows if the file was excluded from automatic analysis.
+     */
+    readonly excludedFromAutomaticAnalysis?: boolean;
    /**
     * Set of excluded pages for this file.
     */