Browse Source

UI: Add copy button checksum

pull/4695/head
Vladyslav_Prykhodko 5 years ago
parent
commit
195ed51afa
  1. 2
      ui-ngx/src/app/core/http/ota-package.service.ts
  2. 28
      ui-ngx/src/app/modules/home/components/entity/entities-table.component.html
  3. 4
      ui-ngx/src/app/modules/home/components/entity/entities-table.component.ts
  4. 13
      ui-ngx/src/app/modules/home/models/entity/entities-table-config.models.ts
  5. 66
      ui-ngx/src/app/modules/home/pages/ota-update/ota-update-table-config.resolve.ts
  6. 8
      ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.html
  7. 11
      ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.ts
  8. 29
      ui-ngx/src/app/shared/components/button/copy-button.component.html
  9. 30
      ui-ngx/src/app/shared/components/button/copy-button.component.scss
  10. 95
      ui-ngx/src/app/shared/components/button/copy-button.component.ts
  11. 2
      ui-ngx/src/app/shared/components/ota-package/ota-package-autocomplete.component.ts
  12. 7
      ui-ngx/src/app/shared/shared.module.ts
  13. 1
      ui-ngx/src/assets/locale/locale.constant-en_US.json

2
ui-ngx/src/app/core/http/ota-package.service.ts

@ -39,7 +39,7 @@ export class OtaPackageService {
} }
public getOtaPackagesInfoByDeviceProfileId(pageLink: PageLink, deviceProfileId: string, type: OtaUpdateType, public getOtaPackagesInfoByDeviceProfileId(pageLink: PageLink, deviceProfileId: string, type: OtaUpdateType,
hasData = true, config?: RequestConfig): Observable<PageData<OtaPackageInfo>> { config?: RequestConfig): Observable<PageData<OtaPackageInfo>> {
const url = `/api/otaPackages/${deviceProfileId}/${type}${pageLink.toQuery()}`; const url = `/api/otaPackages/${deviceProfileId}/${type}${pageLink.toQuery()}`;
return this.http.get<PageData<OtaPackageInfo>>(url, defaultHttpOptionsFromConfig(config)); return this.http.get<PageData<OtaPackageInfo>>(url, defaultHttpOptionsFromConfig(config));
} }

28
ui-ngx/src/app/modules/home/components/entity/entities-table.component.html

@ -163,8 +163,34 @@
*matCellDef="let entity; let row = index" *matCellDef="let entity; let row = index"
[matTooltip]="cellTooltip(entity, column, row)" [matTooltip]="cellTooltip(entity, column, row)"
matTooltipPosition="above" matTooltipPosition="above"
[innerHTML]="cellContent(entity, column, row)"
[ngStyle]="cellStyle(entity, column, row)"> [ngStyle]="cellStyle(entity, column, row)">
<span [innerHTML]="cellContent(entity, column, row)"></span>
<ng-template [ngIf]="column.actionCell.name">
<ng-container [ngSwitch]="column.actionCell.type">
<ng-template [ngSwitchCase]="cellActionType.COPY_BUTTON">
<tb-copy-button
[disabled]="isLoading$ | async"
[fxShow]="column.actionCell.isEnabled(entity)"
[copyText]="column.actionCell.onAction(null, entity)"
tooltipText="{{ column.actionCell.nameFunction ? column.actionCell.nameFunction(entity) : column.actionCell.name }}"
tooltipPosition="above"
[icon]="column.actionCell.icon"
[mdiIcon]="column.actionCell.mdiIcon" [style]="column.actionCell.style">
</tb-copy-button>
</ng-template>
<ng-template ngSwitchDefault>
<button mat-icon-button [disabled]="isLoading$ | async"
[fxShow]="column.actionCell.isEnabled(entity)"
matTooltip="{{ column.actionCell.nameFunction ? column.actionCell.nameFunction(entity) : column.actionCell.name }}"
matTooltipPosition="above"
(click)="column.actionCell.onAction($event, entity)">
<mat-icon [svgIcon]="column.actionCell.mdiIcon" [ngStyle]="column.actionCell.style">
{{column.actionCell.icon}}
</mat-icon>
</button>
</ng-template>
</ng-container>
</ng-template>
</mat-cell> </mat-cell>
</ng-container> </ng-container>
<ng-container [matColumnDef]="column.key" *ngFor="let column of actionColumns; trackBy: trackByColumnKey;"> <ng-container [matColumnDef]="column.key" *ngFor="let column of actionColumns; trackBy: trackByColumnKey;">

4
ui-ngx/src/app/modules/home/components/entity/entities-table.component.ts

@ -43,7 +43,7 @@ import { TranslateService } from '@ngx-translate/core';
import { BaseData, HasId } from '@shared/models/base-data'; import { BaseData, HasId } from '@shared/models/base-data';
import { ActivatedRoute } from '@angular/router'; import { ActivatedRoute } from '@angular/router';
import { import {
CellActionDescriptor, CellActionDescriptor, CellActionDescriptorType,
EntityActionTableColumn, EntityActionTableColumn,
EntityColumn, EntityColumn,
EntityTableColumn, EntityTableColumn,
@ -104,6 +104,8 @@ export class EntitiesTableComponent extends PageComponent implements AfterViewIn
timewindow: Timewindow; timewindow: Timewindow;
dataSource: EntitiesDataSource<BaseData<HasId>>; dataSource: EntitiesDataSource<BaseData<HasId>>;
cellActionType = CellActionDescriptorType;
isDetailsOpen = false; isDetailsOpen = false;
detailsPanelOpened = new EventEmitter<boolean>(); detailsPanelOpened = new EventEmitter<boolean>();

13
ui-ngx/src/app/modules/home/models/entity/entities-table-config.models.ts

@ -48,6 +48,9 @@ export type CellContentFunction<T extends BaseData<HasId>> = (entity: T, key: st
export type CellTooltipFunction<T extends BaseData<HasId>> = (entity: T, key: string) => string | undefined; export type CellTooltipFunction<T extends BaseData<HasId>> = (entity: T, key: string) => string | undefined;
export type HeaderCellStyleFunction<T extends BaseData<HasId>> = (key: string) => object; export type HeaderCellStyleFunction<T extends BaseData<HasId>> = (key: string) => object;
export type CellStyleFunction<T extends BaseData<HasId>> = (entity: T, key: string) => object; export type CellStyleFunction<T extends BaseData<HasId>> = (entity: T, key: string) => object;
export type CopyCellContent<T extends BaseData<HasId>> = (entity: T, key: string, length: number) => object;
export enum CellActionDescriptorType { 'DEFAULT', 'COPY_BUTTON'}
export interface CellActionDescriptor<T extends BaseData<HasId>> { export interface CellActionDescriptor<T extends BaseData<HasId>> {
name: string; name: string;
@ -56,7 +59,8 @@ export interface CellActionDescriptor<T extends BaseData<HasId>> {
mdiIcon?: string; mdiIcon?: string;
style?: any; style?: any;
isEnabled: (entity: T) => boolean; isEnabled: (entity: T) => boolean;
onAction: ($event: MouseEvent, entity: T) => void; onAction: ($event: MouseEvent, entity: T) => any;
type?: CellActionDescriptorType;
} }
export interface GroupActionDescriptor<T extends BaseData<HasId>> { export interface GroupActionDescriptor<T extends BaseData<HasId>> {
@ -95,7 +99,8 @@ export class EntityTableColumn<T extends BaseData<HasId>> extends BaseEntityTabl
public sortable: boolean = true, public sortable: boolean = true,
public headerCellStyleFunction: HeaderCellStyleFunction<T> = () => ({}), public headerCellStyleFunction: HeaderCellStyleFunction<T> = () => ({}),
public cellTooltipFunction: CellTooltipFunction<T> = () => undefined, public cellTooltipFunction: CellTooltipFunction<T> = () => undefined,
public isNumberColumn: boolean = false) { public isNumberColumn: boolean = false,
public actionCell: CellActionDescriptor<T> = {isEnabled: () => false, name: null, onAction: () => ({})}) {
super('content', key, title, width, sortable); super('content', key, title, width, sortable);
} }
} }
@ -187,3 +192,7 @@ export class EntityTableConfig<T extends BaseData<HasId>, P extends PageLink = P
export function checkBoxCell(value: boolean): string { export function checkBoxCell(value: boolean): string {
return `<mat-icon class="material-icons mat-icon">${value ? 'check_box' : 'check_box_outline_blank'}</mat-icon>`; return `<mat-icon class="material-icons mat-icon">${value ? 'check_box' : 'check_box_outline_blank'}</mat-icon>`;
} }
export function copyCellContent(value: string): string {
return `<mat-icon class="material-icons mat-icon">${value ? 'check_box' : 'check_box_outline_blank'}</mat-icon>`;
}

66
ui-ngx/src/app/modules/home/pages/ota-update/ota-update-table-config.resolve.ts

@ -17,6 +17,7 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Resolve } from '@angular/router'; import { Resolve } from '@angular/router';
import { import {
CellActionDescriptorType,
DateEntityTableColumn, DateEntityTableColumn,
EntityTableColumn, EntityTableColumn,
EntityTableConfig EntityTableConfig
@ -61,27 +62,46 @@ export class OtaUpdateTableConfigResolve implements Resolve<EntityTableConfig<Ot
this.config.columns.push( this.config.columns.push(
new DateEntityTableColumn<OtaPackageInfo>('createdTime', 'common.created-time', this.datePipe, '150px'), new DateEntityTableColumn<OtaPackageInfo>('createdTime', 'common.created-time', this.datePipe, '150px'),
new EntityTableColumn<OtaPackageInfo>('title', 'ota-update.title', '25%'), new EntityTableColumn<OtaPackageInfo>('title', 'ota-update.title', '20%'),
new EntityTableColumn<OtaPackageInfo>('version', 'ota-update.version', '25%'), new EntityTableColumn<OtaPackageInfo>('version', 'ota-update.version', '20%'),
new EntityTableColumn<OtaPackageInfo>('type', 'ota-update.package-type', '25%', entity => { new EntityTableColumn<OtaPackageInfo>('type', 'ota-update.package-type', '20%', entity => {
return this.translate.instant(OtaUpdateTypeTranslationMap.get(entity.type)); return this.translate.instant(OtaUpdateTypeTranslationMap.get(entity.type));
}), }),
new EntityTableColumn<OtaPackageInfo>('fileName', 'ota-update.file-name', '25%'), new EntityTableColumn<OtaPackageInfo>('url', 'ota-update.url', '20%', entity => {
return entity.url && entity.url.length > 20 ? `${entity.url.slice(0, 20)}…` : '';
}, () => ({}), true, () => ({}), () => undefined, false,
{
name: this.translate.instant('ota-update.copy-checksum'),
icon: 'content_paste',
style: {
'font-size': '16px',
color: 'rgba(0,0,0,.87)'
},
isEnabled: (otaPackage) => !!otaPackage.url,
onAction: ($event, entity) => entity.url,
type: CellActionDescriptorType.COPY_BUTTON
}),
new EntityTableColumn<OtaPackageInfo>('fileName', 'ota-update.file-name', '20%'),
new EntityTableColumn<OtaPackageInfo>('dataSize', 'ota-update.file-size', '70px', entity => { new EntityTableColumn<OtaPackageInfo>('dataSize', 'ota-update.file-size', '70px', entity => {
return entity.dataSize ? this.fileSize.transform(entity.dataSize) : ''; return entity.dataSize ? this.fileSize.transform(entity.dataSize) : '';
}), }),
new EntityTableColumn<OtaPackageInfo>('checksum', 'ota-update.checksum', '540px', entity => { new EntityTableColumn<OtaPackageInfo>('checksum', 'ota-update.checksum', '220px', entity => {
return entity.checksum ? `${ChecksumAlgorithmTranslationMap.get(entity.checksumAlgorithm)}: ${entity.checksum}` : ''; return entity.checksum ? this.checksumText(entity) : '';
}, () => ({}), false) }, () => ({}), true, () => ({}), () => undefined, false,
);
this.config.cellActionDescriptors.push(
{ {
name: this.translate.instant('ota-update.copy-checksum'), name: this.translate.instant('ota-update.copy-checksum'),
icon: 'content_copy', icon: 'content_paste',
style: {
'font-size': '16px',
color: 'rgba(0,0,0,.87)'
},
isEnabled: (otaPackage) => !!otaPackage.checksum, isEnabled: (otaPackage) => !!otaPackage.checksum,
onAction: ($event, entity) => this.copyPackageChecksum($event, entity) onAction: ($event, entity) => entity.checksum,
}, type: CellActionDescriptorType.COPY_BUTTON
})
);
this.config.cellActionDescriptors.push(
{ {
name: this.translate.instant('ota-update.download'), name: this.translate.instant('ota-update.download'),
icon: 'file_download', icon: 'file_download',
@ -120,19 +140,12 @@ export class OtaUpdateTableConfigResolve implements Resolve<EntityTableConfig<Ot
} }
} }
copyPackageChecksum($event: Event, otaPackageInfo: OtaPackageInfo) { checksumText(entity): string {
if ($event) { let text = `${ChecksumAlgorithmTranslationMap.get(entity.checksumAlgorithm)}: ${entity.checksum}`;
$event.stopPropagation(); if (text.length > 20) {
text = `${text.slice(0, 20)}…`;
} }
this.clipboardService.copy(otaPackageInfo?.checksum); return text;
this.store.dispatch(new ActionNotificationShow(
{
message: this.translate.instant('ota-update.checksum-copied-message'),
type: 'success',
duration: 750,
verticalPosition: 'bottom',
horizontalPosition: 'right'
}));
} }
onPackageAction(action: EntityAction<OtaPackageInfo>): boolean { onPackageAction(action: EntityAction<OtaPackageInfo>): boolean {
@ -140,9 +153,6 @@ export class OtaUpdateTableConfigResolve implements Resolve<EntityTableConfig<Ot
case 'uploadPackage': case 'uploadPackage':
this.exportPackage(action.event, action.entity); this.exportPackage(action.event, action.entity);
return true; return true;
case 'copyChecksum':
this.copyPackageChecksum(action.event, action.entity);
return true;
} }
return false; return false;
} }

8
ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.html

@ -31,7 +31,6 @@
<div fxLayout="row" fxLayout.xs="column"> <div fxLayout="row" fxLayout.xs="column">
<button mat-raised-button <button mat-raised-button
ngxClipboard ngxClipboard
[disabled]="(isLoading$ | async)"
(cbOnSuccess)="onPackageIdCopied()" (cbOnSuccess)="onPackageIdCopied()"
[cbContent]="entity?.id?.id" [cbContent]="entity?.id?.id"
[fxShow]="!isEdit"> [fxShow]="!isEdit">
@ -39,9 +38,10 @@
<span translate>ota-update.copyId</span> <span translate>ota-update.copyId</span>
</button> </button>
<button mat-raised-button <button mat-raised-button
[disabled]="(isLoading$ | async)" ngxClipboard
(click)="onEntityAction($event, 'copyChecksum')" (cbOnSuccess)="onPackageChecksumCopied()"
[fxShow]="!isEdit && entity?.checksum"> [cbContent]="entity?.checksum"
[fxShow]="!isEdit">
<mat-icon svgIcon="mdi:clipboard-arrow-left"></mat-icon> <mat-icon svgIcon="mdi:clipboard-arrow-left"></mat-icon>
<span translate>ota-update.copy-checksum</span> <span translate>ota-update.copy-checksum</span>
</button> </button>

11
ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.ts

@ -149,6 +149,17 @@ export class OtaUpdateComponent extends EntityComponent<OtaPackage> implements O
})); }));
} }
onPackageChecksumCopied() {
this.store.dispatch(new ActionNotificationShow(
{
message: this.translate.instant('ota-update.checksum-copied-message'),
type: 'success',
duration: 750,
verticalPosition: 'bottom',
horizontalPosition: 'right'
}));
}
prepareFormValue(formValue: any): any { prepareFormValue(formValue: any): any {
delete formValue.resource; delete formValue.resource;
delete formValue.generateChecksum; delete formValue.generateChecksum;

29
ui-ngx/src/app/shared/components/button/copy-button.component.html

@ -0,0 +1,29 @@
<!--
Copyright © 2016-2021 The Thingsboard Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<button mat-icon-button
#tooltip
[disabled]="disabled"
[matTooltip]="matTooltipText"
[matTooltipPosition]="matTooltipPosition"
(mouseenter)="copied ? $event.stopImmediatePropagation():''"
(mouseleave)="copied ? $event.stopImmediatePropagation():''"
(click)="copy($event)">
<mat-icon [svgIcon]="mdiIconSymbol" [ngStyle]="style" [ngClass]="{'copied': copied}">
{{ iconSymbol }}
</mat-icon>
</button>

30
ui-ngx/src/app/shared/components/button/copy-button.component.scss

@ -0,0 +1,30 @@
/**
* Copyright © 2016-2021 The Thingsboard Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
:host {
.mat-icon-button{
height: 32px;
width: 32px;
line-height: 32px;
.mat-icon.copied{
color: #00C851!important;
}
}
&:hover{
.mat-icon{
color: #28567E !important;
}
}
}

95
ui-ngx/src/app/shared/components/button/copy-button.component.ts

@ -0,0 +1,95 @@
///
/// Copyright © 2016-2021 The Thingsboard Authors
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
import { ChangeDetectorRef, Component, Input, ViewChild } from '@angular/core';
import { ClipboardService } from 'ngx-clipboard';
import { MatTooltip, TooltipPosition } from '@angular/material/tooltip/tooltip';
import { TranslateService } from '@ngx-translate/core';
@Component({
selector: 'tb-copy-button',
styleUrls: ['copy-button.component.scss'],
templateUrl: './copy-button.component.html'
})
export class CopyButtonComponent {
private copedIcon = '';
private timer;
copied = false;
@Input()
copyText: string;
@Input()
disabled = false;
@Input()
mdiIcon: string;
@Input()
icon: string;
@Input()
tooltipText: string;
@Input()
tooltipPosition: TooltipPosition;
@Input()
style: {[key: string]: any} = {};
constructor(private clipboardService: ClipboardService,
private translate: TranslateService,
private cd: ChangeDetectorRef) {
}
@ViewChild('tooltip', {static: true}) tooltip: MatTooltip;
copy($event: Event): void {
$event.stopPropagation();
$event.preventDefault();
if (this.timer) {
clearTimeout(this.timer);
}
this.clipboardService.copy(this.copyText);
this.copedIcon = 'done';
this.copied = true;
this.tooltip.show();
this.timer = setTimeout(() => {
this.copedIcon = null;
this.copied = false;
this.tooltip.hide();
this.cd.detectChanges();
}, 1500);
}
get iconSymbol(): string {
return this.copedIcon || this.icon;
}
get mdiIconSymbol(): string {
return this.copedIcon ? '' : this.mdiIcon;
}
get matTooltipText(): string {
return this.copied ? this.translate.instant('ota-update.copied') : this.tooltipText;
}
get matTooltipPosition(): TooltipPosition {
return this.copied ? 'below' : this.tooltipPosition;
}
}

2
ui-ngx/src/app/shared/components/ota-package/ota-package-autocomplete.component.ts

@ -216,7 +216,7 @@ export class OtaPackageAutocompleteComponent implements ControlValueAccessor, On
direction: Direction.ASC direction: Direction.ASC
}); });
return this.otaPackageService.getOtaPackagesInfoByDeviceProfileId(pageLink, this.deviceProfileId, this.type, return this.otaPackageService.getOtaPackagesInfoByDeviceProfileId(pageLink, this.deviceProfileId, this.type,
true, {ignoreLoading: true}).pipe( {ignoreLoading: true}).pipe(
map((data) => data && data.data.length ? data.data : null) map((data) => data && data.data.length ? data.data : null)
); );
} }

7
ui-ngx/src/app/shared/shared.module.ts

@ -143,6 +143,7 @@ import { SelectableColumnsPipe } from '@shared/pipe/selectable-columns.pipe';
import { QuickTimeIntervalComponent } from '@shared/components/time/quick-time-interval.component'; import { QuickTimeIntervalComponent } from '@shared/components/time/quick-time-interval.component';
import { OtaPackageAutocompleteComponent } from '@shared/components/ota-package/ota-package-autocomplete.component'; import { OtaPackageAutocompleteComponent } from '@shared/components/ota-package/ota-package-autocomplete.component';
import { MAT_DATE_LOCALE } from '@angular/material/core'; import { MAT_DATE_LOCALE } from '@angular/material/core';
import { CopyButtonComponent } from '@shared/components/button/copy-button.component';
@NgModule({ @NgModule({
providers: [ providers: [
@ -240,7 +241,8 @@ import { MAT_DATE_LOCALE } from '@angular/material/core';
EntityGatewaySelectComponent, EntityGatewaySelectComponent,
ContactComponent, ContactComponent,
OtaPackageAutocompleteComponent, OtaPackageAutocompleteComponent,
WidgetsBundleSearchComponent WidgetsBundleSearchComponent,
CopyButtonComponent
], ],
imports: [ imports: [
CommonModule, CommonModule,
@ -412,7 +414,8 @@ import { MAT_DATE_LOCALE } from '@angular/material/core';
EntityGatewaySelectComponent, EntityGatewaySelectComponent,
ContactComponent, ContactComponent,
OtaPackageAutocompleteComponent, OtaPackageAutocompleteComponent,
WidgetsBundleSearchComponent WidgetsBundleSearchComponent,
CopyButtonComponent
] ]
}) })
export class SharedModule { } export class SharedModule { }

1
ui-ngx/src/assets/locale/locale.constant-en_US.json

@ -2166,6 +2166,7 @@
"content-type": "Content type", "content-type": "Content type",
"copy-checksum": "Copy checksum", "copy-checksum": "Copy checksum",
"copyId": "Copy package Id", "copyId": "Copy package Id",
"copied": "Copied!",
"delete": "Delete package", "delete": "Delete package",
"delete-ota-update-text": "Be careful, after the confirmation the OTA update will become unrecoverable.", "delete-ota-update-text": "Be careful, after the confirmation the OTA update will become unrecoverable.",
"delete-ota-update-title": "Are you sure you want to delete the OTA update '{{title}}'?", "delete-ota-update-title": "Are you sure you want to delete the OTA update '{{title}}'?",

Loading…
Cancel
Save