security-c4po/security-c4po-angular/src/shared/modules/finding-dialog/finding-dialog.component.ts

import {ChangeDetectionStrategy, Component, Inject, OnInit} from '@angular/core';
import {UntypedFormBuilder, UntypedFormGroup} from '@angular/forms';
import {GenericDialogData, GenericFormFieldConfig} from '@shared/models/generic-dialog-data';
import {NB_DIALOG_CONFIG, NbDialogRef, NbTagComponent} from '@nebular/theme';
import deepEqual from 'deep-equal';
import {UntilDestroy, untilDestroyed} from '@ngneat/until-destroy';
import {Severity} from '@shared/models/severity.enum';
import * as FA from '@fortawesome/free-solid-svg-icons';
import {Finding, transformFindingToRequestBody} from '@shared/models/finding.model';
import {FindingService} from '@shared/services/api/finding.service';
import {NotificationService, PopupType} from '@shared/services/toaster-service/notification.service';
import {DialogService} from '@shared/services/dialog-service/dialog.service';
import {UpdatePentestFindings} from '@shared/stores/project-state/project-state.actions';
import {Store} from '@ngxs/store';

@UntilDestroy()
@Component({
  selector: 'app-finding-dialog',
  templateUrl: './finding-dialog.component.html',
  styleUrls: ['./finding-dialog.component.scss'],
  changeDetection: ChangeDetectionStrategy.OnPush
})
export class FindingDialogComponent implements OnInit {

  constructor(
    @Inject(NB_DIALOG_CONFIG) private data: GenericDialogData,
    private fb: UntypedFormBuilder,
    protected dialogRef: NbDialogRef<FindingDialogComponent>,
    private findingService: FindingService,
    private readonly notificationService: NotificationService,
    private dialogService: DialogService,
    private store: Store
  ) {
  }
  // form control elements
  findingFormGroup: UntypedFormGroup;
  formArray: GenericFormFieldConfig[];

  dialogData: GenericDialogData;

  // HTML only
  readonly fa = FA;
  readonly getRowsFromString = /\r|\r\n|\n/;
  severity: Severity = Severity.LOW;
  readonly severityTexts: Array<SeverityText> = [
    {value: Severity.LOW, translationText: 'severities.low'},
    {value: Severity.MEDIUM, translationText: 'severities.medium'},
    {value: Severity.HIGH, translationText: 'severities.high'},
    {value: Severity.CRITICAL, translationText: 'severities.critical'}
  ];

  // ToDo: Adjust for edit finding dialog to include existing urls
  affectedUrls: string[] = [];
  initialAffectedUrls: string[] = [];

  ngOnInit(): void {
    this.findingFormGroup = this.generateFormCreationFieldArray();
    this.dialogData = this.data;
    // Resets affected Urls input fields when finding was found in dialog context
    // tslint:disable-next-line:no-string-literal
    this.findingFormGroup.controls['findingAffectedUrls'].reset('');
  }

  generateFormCreationFieldArray(): UntypedFormGroup {
    this.formArray = Object.values(this.data.form);
    const config = this.formArray?.reduce((accumulator: {}, currentValue: GenericFormFieldConfig) => ({
      ...accumulator,
      [currentValue?.fieldName]: currentValue?.controlsConfig
    }), {});
    // tslint:disable-next-line:no-string-literal
    const affectedUrls = this.data.form['findingAffectedUrls'].controlsConfig[0].value;
    if (affectedUrls) {
      this.renderAffectedUrls(affectedUrls);
    }
    return this.fb.group(config);
  }

  renderAffectedUrls(affectedUrls: string[]): void {
    affectedUrls.forEach(url => this.initialAffectedUrls.push(url));
    affectedUrls.forEach(url => this.affectedUrls.push(url));
  }

  onAffectedUrlAdd(): void {
    // tslint:disable-next-line:no-string-literal
    const newUrl = this.findingFormGroup.controls['findingAffectedUrls'].value;
    if (newUrl) {
      this.affectedUrls.push(newUrl);
    }
    // tslint:disable-next-line:no-string-literal
    this.findingFormGroup.controls['findingAffectedUrls'].reset('');
  }

  onAffectedUrlTagRemove(tagToRemove: NbTagComponent): void {
    this.affectedUrls = this.affectedUrls.filter(t => t !== tagToRemove.text);
  }

  onClickSave(value: any): void {
    if (this.dialogData.options[0].headerLabelKey.includes('create')) {
      // Save
      this.saveFinding(value);
    } else {
      // Update
      this.updateFinding(value);
    }
  }

  onClickClose(): void {
    this.dialogRef.close();
  }

  allowSave(): boolean {
    return this.findingFormGroup.valid && this.findingDataChanged();
  }

  /**
   * @return the correct nb-status for current severity
   */
  getSeverityFillStatus(value: number): string {
    let severityFillStatus;
    switch (value) {
      case 0: {
        severityFillStatus = 'success';
        break;
      }
      case 1: {
        severityFillStatus = 'info';
        break;
      }
      case 2: {
        severityFillStatus = 'warning';
        break;
      }
      case 3: {
        severityFillStatus = 'danger';
        break;
      }
      default: {
        severityFillStatus = 'basic';
        break;
      }
    }
    return severityFillStatus;
  }

  /**
   * @return true if finding data is different from initial value
   */
  private findingDataChanged(): boolean {
    const oldFindingData = this.parseInitializedFindingDialogData(this.dialogData);
    const newFindingData = this.findingFormGroup.getRawValue();
    Object.entries(newFindingData).forEach(entry => {
      const [key, value] = entry;
      // Affected Url form field can be ignored since changes here will be recognised inside affectedUrls of tag-list
      if (value === null || key === 'findingAffectedUrls') {
        newFindingData[key] = '';
      }
    });
    const didChange = !deepEqual(oldFindingData, newFindingData) || !deepEqual(this.initialAffectedUrls, this.affectedUrls);
    return didChange;
  }

  /**
   * @param dialogData of type GenericDialogData
   * @return parsed findingData
   */
  private parseInitializedFindingDialogData(dialogData: GenericDialogData): any {
    const findingData = {};
    Object.entries(dialogData.form).forEach(entry => {
      const [key, value] = entry;
      // console.info(key);
      findingData[key] = value.controlsConfig[0] ?
        (value.controlsConfig[0].value ? value.controlsConfig[0].value : value.controlsConfig[0]) : '';
      // Affected Url form field can be ignored since changes here will be recognised inside affectedUrls of tag-list
      if (key === 'findingAffectedUrls') {
        findingData[key] = '';
      }
    });
    return findingData;
  }

  private saveFinding(value): void {
    const dialogRes = {
      title: value.findingTitle,
      severity: this.formArray[1].controlsConfig[0].value,
      description: value.findingDescription,
      impact: value.findingImpact,
      affectedUrls: this.affectedUrls ? this.affectedUrls : [],
      reproduction: value.findingReproduction,
      mitigation: value.findingMitigation
    };

    this.findingService.saveFinding(
      this.dialogData.options[0].additionalData.id,
      transformFindingToRequestBody(dialogRes)
    ).pipe(
      untilDestroyed(this)
    ).subscribe({
      next: (newFinding: Finding) => {
        this.store.dispatch(new UpdatePentestFindings(newFinding.id));
        this.dialogRef.close();
        this.notificationService.showPopup('finding.popup.save.success', PopupType.SUCCESS);
      },
      error: err => {
        console.error(err);
        this.onRequestFailed(value);
        this.notificationService.showPopup('finding.popup.save.failed', PopupType.FAILURE);
      }
    });
  }

  private updateFinding(value): void {
    const dialogRes = {
      title: value.findingTitle,
      severity: this.formArray[1].controlsConfig[0].value,
      description: value.findingDescription,
      impact: value.findingImpact,
      affectedUrls: this.affectedUrls ? this.affectedUrls : [],
      reproduction: value.findingReproduction,
      mitigation: value.findingMitigation
    };

    this.findingService.updateFinding(
      this.dialogData.options[0].additionalData.id,
      transformFindingToRequestBody(dialogRes)
    ).pipe(
      untilDestroyed(this)
    ).subscribe({
      next: (newFinding: Finding) => {
        this.dialogRef.close();
        this.notificationService.showPopup('finding.popup.update.success', PopupType.SUCCESS);
      },
      error: err => {
        console.error(err);
        this.onRequestFailed(value);
        this.notificationService.showPopup('finding.popup.update.failed', PopupType.FAILURE);
      }
    });
  }

  private onRequestFailed(retryParameter: any): void {
    this.dialogService.openRetryDialog({key: 'global.retry.dialog', data: null}).onClose
      .pipe(
        untilDestroyed(this)
      )
      .subscribe((ref) => {
        if (ref.retry) {
          this.onClickSave(retryParameter);
        }
      });
  }
}

interface SeverityText {
  value: Severity;
  translationText: string;
}