thingsboard/ui-ngx/src/app/shared/components/image/scada-symbol-input.component.ts

///
/// Copyright © 2016-2025 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, forwardRef, Input, OnDestroy, OnInit } from '@angular/core';
import { PageComponent } from '@shared/components/page.component';
import { Store } from '@ngrx/store';
import { AppState } from '@core/core.state';
import { ControlValueAccessor, NG_VALUE_ACCESSOR, } from '@angular/forms';
import { coerceBoolean } from '@shared/decorators/coercion';
import {
  extractParamsFromImageResourceUrl,
  IMAGE_BASE64_URL_PREFIX,
  ImageResourceInfo,
  prependTbImagePrefix,
  removeTbImagePrefix,
  ResourceSubType
} from '@shared/models/resource.models';
import { ImageService } from '@core/http/image.service';
import { MatDialog } from '@angular/material/dialog';
import {
  ImageGalleryDialogComponent,
  ImageGalleryDialogData
} from '@shared/components/image/image-gallery-dialog.component';
import { ScadaSymbolMetadata } from '@home/components/widget/lib/scada/scada-symbol.models';
import { stringToBase64 } from '@core/utils';

export enum ScadaSymbolLinkType {
  none = 'none',
  content = 'content',
  resource = 'resource'
}

@Component({
  selector: 'tb-scada-symbol-input',
  templateUrl: './scada-symbol-input.component.html',
  styleUrls: ['./scada-symbol-input.component.scss'],
  providers: [
    {
      provide: NG_VALUE_ACCESSOR,
      useExisting: forwardRef(() => ScadaSymbolInputComponent),
      multi: true
    }
  ]
})
export class ScadaSymbolInputComponent extends PageComponent implements OnInit, OnDestroy, ControlValueAccessor {

  @Input()
  label: string;

  @Input()
  @coerceBoolean()
  required = false;

  @Input()
  disabled: boolean;

  @Input()
  scadaSymbolContent: string;

  @Input()
  scadaSymbolMetadata: ScadaSymbolMetadata;

  scadaSymbolUrl: string;

  imageResource: ImageResourceInfo;

  loadingImageResource = false;

  ScadaSymbolLinkType = ScadaSymbolLinkType;

  linkType: ScadaSymbolLinkType = ScadaSymbolLinkType.none;

  private propagateChange = null;

  constructor(protected store: Store<AppState>,
              private imageService: ImageService,
              private dialog: MatDialog,
              private cd: ChangeDetectorRef) {
    super(store);
  }

  ngOnInit() {
    if (this.scadaSymbolContent && this.scadaSymbolMetadata) {
      this.scadaSymbolUrl = IMAGE_BASE64_URL_PREFIX + 'svg+xml;base64,' + stringToBase64(this.scadaSymbolContent);
      this.linkType = ScadaSymbolLinkType.content;
    }
  }

  ngOnDestroy() {
  }

  registerOnChange(fn: any): void {
    this.propagateChange = fn;
  }

  registerOnTouched(_fn: any): void {
  }

  setDisabledState(isDisabled: boolean): void {
    this.disabled = isDisabled;
    if (this.disabled) {
      this.detectLinkType();
    }
  }

  writeValue(value: string): void {
    value = removeTbImagePrefix(value);
    if (this.scadaSymbolUrl !== value) {
      this.reset();
      this.scadaSymbolUrl = value;
      this.detectLinkType();
      if (this.linkType === ScadaSymbolLinkType.resource) {
        const params = extractParamsFromImageResourceUrl(this.scadaSymbolUrl);
        if (params) {
          this.loadingImageResource = true;
          this.imageService.getImageInfo(params.type, params.key, {ignoreLoading: true, ignoreErrors: true}).subscribe(
            {
              next: (res) => {
                this.imageResource = res;
                this.loadingImageResource = false;
                this.cd.markForCheck();
              },
              error: () => {
                this.reset();
                this.loadingImageResource = false;
                this.cd.markForCheck();
              }
            }
          );
        } else {
          this.reset();
          this.cd.markForCheck();
        }
      }
    }
  }

  private detectLinkType() {
    if (this.scadaSymbolUrl) {
      this.linkType = ScadaSymbolLinkType.resource;
    } else {
      this.linkType = ScadaSymbolLinkType.none;
    }
  }

  private updateModel(value: string) {
    this.cd.markForCheck();
    if (this.scadaSymbolUrl !== value) {
      this.scadaSymbolUrl = value;
      this.propagateChange(prependTbImagePrefix(this.scadaSymbolUrl));
    }
  }

  private reset() {
    this.linkType = ScadaSymbolLinkType.none;
    this.imageResource = null;
  }

  clearSymbol() {
    this.reset();
    this.updateModel(null);
  }

  openGallery($event: Event): void {
    if ($event) {
      $event.stopPropagation();
    }
    this.dialog.open<ImageGalleryDialogComponent, ImageGalleryDialogData,
      ImageResourceInfo>(ImageGalleryDialogComponent, {
      autoFocus: false,
      disableClose: false,
      panelClass: ['tb-dialog', 'tb-fullscreen-dialog'],
      data: {
        imageSubType: ResourceSubType.SCADA_SYMBOL
      }
    }).afterClosed().subscribe((image) => {
      if (image) {
        this.linkType = ScadaSymbolLinkType.resource;
        this.imageResource = image;
        this.updateModel(image.link);
      }
    });
  }

}