From 1e8fc7086b1d977fbecc69873f266a8e396c8d47 Mon Sep 17 00:00:00 2001
From: Igor Kulikov <ikulikov@thingsboard.io>
Date: Fri, 19 Mar 2021 10:07:26 +0200
Subject: [PATCH] Device profile import/export support

---
 .../import-export/import-export.service.ts    | 51 +++++++++++++++++
 .../profile/device-profile.component.html     |  6 ++
 .../device-profiles-table-config.resolver.ts  | 56 +++++++++++++++++--
 .../assets/locale/locale.constant-en_US.json  |  8 ++-
 4 files changed, 116 insertions(+), 5 deletions(-)

diff --git a/ui-ngx/src/app/modules/home/components/import-export/import-export.service.ts b/ui-ngx/src/app/modules/home/components/import-export/import-export.service.ts
index 48324dcbfe..2169f46d71 100644
--- a/ui-ngx/src/app/modules/home/components/import-export/import-export.service.ts
+++ b/ui-ngx/src/app/modules/home/components/import-export/import-export.service.ts
@@ -55,6 +55,8 @@ import { RequestConfig } from '@core/http/http-utils';
 import { RuleChain, RuleChainImport, RuleChainMetaData } from '@shared/models/rule-chain.models';
 import { RuleChainService } from '@core/http/rule-chain.service';
 import { FiltersInfo } from '@shared/models/query/query.models';
+import { DeviceProfileService } from '@core/http/device-profile.service';
+import { DeviceProfile } from '@shared/models/device.models';
 
 // @dynamic
 @Injectable()
@@ -67,6 +69,7 @@ export class ImportExportService {
               private dashboardService: DashboardService,
               private dashboardUtils: DashboardUtilsService,
               private widgetService: WidgetService,
+              private deviceProfileService: DeviceProfileService,
               private entityService: EntityService,
               private ruleChainService: RuleChainService,
               private utils: UtilsService,
@@ -420,6 +423,37 @@ export class ImportExportService {
     );
   }
 
+  public exportDeviceProfile(deviceProfileId: string) {
+    this.deviceProfileService.getDeviceProfile(deviceProfileId).subscribe(
+      (deviceProfile) => {
+          let name = deviceProfile.name;
+          name = name.toLowerCase().replace(/\W/g, '_');
+          this.exportToPc(this.prepareDeviceProfileExport(deviceProfile), name);
+        },
+        (e) => {
+          this.handleExportError(e, 'device-profile.export-failed-error');
+        }
+      );
+  }
+
+  public importDeviceProfile(): Observable<DeviceProfile> {
+    return this.openImportDialog('device-profile.import', 'device-profile.device-profile-file').pipe(
+      mergeMap((deviceProfile: DeviceProfile) => {
+        if (!this.validateImportedDeviceProfile(deviceProfile)) {
+          this.store.dispatch(new ActionNotificationShow(
+            {message: this.translate.instant('device-profile.invalid-device-profile-file-error'),
+              type: 'error'}));
+          throw new Error('Invalid device profile file');
+        } else {
+            return this.deviceProfileService.saveDeviceProfile(deviceProfile);
+        }
+      }),
+      catchError((err) => {
+        return of(null);
+      })
+    );
+  }
+
   public exportJSZip(data: object, filename: string) {
     import('jszip').then((JSZip) => {
       const jsZip = new JSZip.default();
@@ -463,6 +497,17 @@ export class ImportExportService {
     return true;
   }
 
+  private validateImportedDeviceProfile(deviceProfile: DeviceProfile): boolean {
+    if (isUndefined(deviceProfile.name)
+      || isUndefined(deviceProfile.type)
+      || isUndefined(deviceProfile.transportType)
+      || isUndefined(deviceProfile.provisionType)
+      || isUndefined(deviceProfile.profileData)) {
+      return false;
+    }
+    return true;
+  }
+
   private sumObject(obj1: any, obj2: any): any {
     Object.keys(obj2).map((key) => {
       if (isObject(obj2[key])) {
@@ -740,6 +785,12 @@ export class ImportExportService {
     return dashboard;
   }
 
+  private prepareDeviceProfileExport(deviceProfile: DeviceProfile): DeviceProfile {
+    deviceProfile = this.prepareExport(deviceProfile);
+    deviceProfile.default = false;
+    return deviceProfile;
+  }
+
   private prepareExport(data: any): any {
     const exportedData = deepClone(data);
     if (isDefined(exportedData.id)) {
diff --git a/ui-ngx/src/app/modules/home/components/profile/device-profile.component.html b/ui-ngx/src/app/modules/home/components/profile/device-profile.component.html
index 0d1efcbe04..9ee6201db6 100644
--- a/ui-ngx/src/app/modules/home/components/profile/device-profile.component.html
+++ b/ui-ngx/src/app/modules/home/components/profile/device-profile.component.html
@@ -16,6 +16,12 @@
 
 -->
 <div class="tb-details-buttons" fxLayout.xs="column" *ngIf="!standalone">
+  <button mat-raised-button color="primary"
+          [disabled]="(isLoading$ | async)"
+          (click)="onEntityAction($event, 'export')"
+          [fxShow]="!isEdit">
+    {{'device-profile.export' | translate }}
+  </button>
   <button mat-raised-button color="primary"
           [disabled]="(isLoading$ | async)"
           (click)="onEntityAction($event, 'setDefault')"
diff --git a/ui-ngx/src/app/modules/home/pages/device-profile/device-profiles-table-config.resolver.ts b/ui-ngx/src/app/modules/home/pages/device-profile/device-profiles-table-config.resolver.ts
index 299c1e4015..3a6862b422 100644
--- a/ui-ngx/src/app/modules/home/pages/device-profile/device-profiles-table-config.resolver.ts
+++ b/ui-ngx/src/app/modules/home/pages/device-profile/device-profiles-table-config.resolver.ts
@@ -20,7 +20,8 @@ import {
   checkBoxCell,
   DateEntityTableColumn,
   EntityTableColumn,
-  EntityTableConfig
+  EntityTableConfig,
+  HeaderActionDescriptor
 } from '@home/models/entity/entities-table-config.models';
 import { TranslateService } from '@ngx-translate/core';
 import { DatePipe } from '@angular/common';
@@ -33,14 +34,15 @@ import {
   deviceTransportTypeTranslationMap
 } from '@shared/models/device.models';
 import { DeviceProfileService } from '@core/http/device-profile.service';
-import { DeviceProfileComponent } from '../../components/profile/device-profile.component';
+import { DeviceProfileComponent } from '@home/components/profile/device-profile.component';
 import { DeviceProfileTabsComponent } from './device-profile-tabs.component';
 import { Observable } from 'rxjs';
 import { MatDialog } from '@angular/material/dialog';
 import {
   AddDeviceProfileDialogComponent,
   AddDeviceProfileDialogData
-} from '../../components/profile/add-device-profile-dialog.component';
+} from '@home/components/profile/add-device-profile-dialog.component';
+import { ImportExportService } from '@home/components/import-export/import-export.service';
 
 @Injectable()
 export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableConfig<DeviceProfile>> {
@@ -48,6 +50,7 @@ export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableCon
   private readonly config: EntityTableConfig<DeviceProfile> = new EntityTableConfig<DeviceProfile>();
 
   constructor(private deviceProfileService: DeviceProfileService,
+              private importExport: ImportExportService,
               private translate: TranslateService,
               private datePipe: DatePipe,
               private dialogService: DialogService,
@@ -80,6 +83,12 @@ export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableCon
     );
 
     this.config.cellActionDescriptors.push(
+      {
+        name: this.translate.instant('device-profile.export'),
+        icon: 'file_download',
+        isEnabled: () => true,
+        onAction: ($event, entity) => this.exportDeviceProfile($event, entity)
+      },
       {
         name: this.translate.instant('device-profile.set-default'),
         icon: 'flag',
@@ -101,7 +110,7 @@ export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableCon
     this.config.onEntityAction = action => this.onDeviceProfileAction(action);
     this.config.deleteEnabled = (deviceProfile) => deviceProfile && !deviceProfile.default;
     this.config.entitySelectionEnabled = (deviceProfile) => deviceProfile && !deviceProfile.default;
-    this.config.addEntity = () => this.addDeviceProfile();
+    this.config.addActionDescriptors = this.configureAddActions();
   }
 
   resolve(): EntityTableConfig<DeviceProfile> {
@@ -110,6 +119,25 @@ export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableCon
     return this.config;
   }
 
+  configureAddActions(): Array<HeaderActionDescriptor> {
+    const actions: Array<HeaderActionDescriptor> = [];
+    actions.push(
+      {
+        name: this.translate.instant('device-profile.create-device-profile'),
+        icon: 'insert_drive_file',
+        isEnabled: () => true,
+        onAction: () => this.addDeviceProfile()
+      },
+      {
+        name: this.translate.instant('device-profile.import'),
+        icon: 'file_upload',
+        isEnabled: () => true,
+        onAction: ($event) => this.importDeviceProfile($event)
+      }
+    );
+    return actions;
+  }
+
   addDeviceProfile(): Observable<DeviceProfile> {
     return this.dialog.open<AddDeviceProfileDialogComponent, AddDeviceProfileDialogData,
       DeviceProfile>(AddDeviceProfileDialogComponent, {
@@ -144,11 +172,31 @@ export class DeviceProfilesTableConfigResolver implements Resolve<EntityTableCon
     );
   }
 
+  importDeviceProfile($event: Event) {
+    this.importExport.importDeviceProfile().subscribe(
+      (deviceProfile) => {
+        if (deviceProfile) {
+          this.config.table.updateData();
+        }
+      }
+    );
+  }
+
+  exportDeviceProfile($event: Event, deviceProfile: DeviceProfile) {
+    if ($event) {
+      $event.stopPropagation();
+    }
+    this.importExport.exportDeviceProfile(deviceProfile.id.id);
+  }
+
   onDeviceProfileAction(action: EntityAction<DeviceProfile>): boolean {
     switch (action.action) {
       case 'setDefault':
         this.setDefaultDeviceProfile(action.event, action.entity);
         return true;
+      case 'export':
+        this.exportDeviceProfile(action.event, action.entity);
+        return true;
     }
     return false;
   }
diff --git a/ui-ngx/src/assets/locale/locale.constant-en_US.json b/ui-ngx/src/assets/locale/locale.constant-en_US.json
index 5edf291838..832980aaf6 100644
--- a/ui-ngx/src/assets/locale/locale.constant-en_US.json
+++ b/ui-ngx/src/assets/locale/locale.constant-en_US.json
@@ -1091,7 +1091,13 @@
         "schedule-time": "Time",
         "schedule-time-from": "From",
         "schedule-time-to": "To",
-        "schedule-days-of-week-required": "At least one day of week should be selected."
+        "schedule-days-of-week-required": "At least one day of week should be selected.",
+        "create-device-profile": "Create new device profile",
+        "import": "Import device profile",
+        "export": "Export device profile",
+        "export-failed-error": "Unable to export device profile: {{error}}",
+        "device-profile-file": "Device profile file",
+        "invalid-device-profile-file-error": "Unable to import device profile: Invalid device profile data structure."
     },
     "dialog": {
         "close": "Close dialog"