projects/cobbler-frontend/src/app/items/management-class/edit/management-class-edit.component.ts

Implements

OnInit OnDestroy

Metadata

Relationships

Used by

No results matching.

Depends on

Index

Properties
Methods

Constructor

constructor()

Methods

cancelEdit
cancelEdit()
Returns : void
copyMgmtClass
copyMgmtClass(uid: string, name: string)
Parameters :
Name Type Optional
uid string No
name string No
Returns : void
editProfile
editProfile()
Returns : void
getInheritObservable
getInheritObservable(valueControl: AbstractControl)
Parameters :
Name Type Optional
valueControl AbstractControl No
Returns : void
ngOnDestroy
ngOnDestroy()
Returns : void
ngOnInit
ngOnInit()
Returns : void
refreshData
refreshData()
Returns : void
removeManagementClass
removeManagementClass()
Returns : void
saveProfile
saveProfile()
Returns : void
showAsRendered
showAsRendered()
Returns : void

Properties

Private Readonly _formBuilder
Type : unknown
Default value : inject(FormBuilder)
Private _snackBar
Type : unknown
Default value : inject(MatSnackBar)
Private cobblerApiService
Type : unknown
Default value : inject(CobblerApiService)
Protected Readonly CobblerInputChoices
Type : unknown
Default value : CobblerInputChoices
Readonly dialog
Type : unknown
Default value : inject<MatDialog>(MatDialog)
isEditMode
Type : boolean
Default value : false
managementClass
Type : Mgmgtclass
managementClassEditableInputData
Type : Array<CobblerInputData>
Default value : [ ...cobblerItemEditableData, { formControlName: 'is_definition', inputType: CobblerInputChoices.CHECKBOX, label: $localize`:@@management-class.edit.label.is_definition:Is Definition`, hint: $localize`:@@management-class.edit.hint.is_definition:When checked, this class is a definition (abstract) and will not be directly applied to systems.`, disabled: true, readonly: false, defaultValue: false, inherited: false, }, { formControlName: 'redhat_management_key', inputType: CobblerInputChoices.TEXT, label: $localize`:@@management-class.edit.label.redhat_management_key:RedHat Management Key`, hint: $localize`:@@management-class.edit.hint.redhat_management_key:Registration key for Red Hat management systems (Spacewalk, Uyuni, SUSE Manager). Supports <<inherit>>.`, disabled: true, readonly: false, defaultValue: '', inherited: false, }, { formControlName: 'class_name', inputType: CobblerInputChoices.TEXT, label: $localize`:@@management-class.edit.label.class_name:Class Name`, hint: $localize`:@@management-class.edit.hint.class_name:The fully qualified class name as used by the configuration management system (e.g. Puppet).`, disabled: true, readonly: false, defaultValue: '', inherited: false, }, { formControlName: 'owners', inputType: CobblerInputChoices.MULTI_SELECT, label: $localize`:@@management-class.edit.label.owners:Owners`, hint: $localize`:@@management-class.edit.hint.owners:Cobbler user accounts allowed to manage this item. Cosmetic only — not validated against real users. Supports <<inherit>>.`, disabled: true, readonly: false, defaultValue: [], inherited: true, }, { formControlName: 'params', inputType: CobblerInputChoices.KEY_VALUE, label: $localize`:@@management-class.edit.label.params:Params`, hint: $localize`:@@management-class.edit.hint.params:Key=value parameters passed to the management class.`, disabled: true, readonly: false, defaultValue: new Map<string, any>(), inherited: true, }, { formControlName: 'files', inputType: CobblerInputChoices.MULTI_SELECT, label: $localize`:@@management-class.edit.label.files:Files`, hint: $localize`:@@management-class.edit.hint.files:File objects managed by this class.`, disabled: true, readonly: false, defaultValue: [], inherited: true, }, { formControlName: 'packages', inputType: CobblerInputChoices.MULTI_SELECT, label: $localize`:@@management-class.edit.label.packages:Packages`, hint: $localize`:@@management-class.edit.hint.packages:Package objects managed by this class.`, disabled: true, readonly: false, defaultValue: [], inherited: true, }, ]
managementClassFormGroup
Type : unknown
Default value : this._formBuilder.group({})
managementClassReadonlyFormGroup
Type : unknown
Default value : this._formBuilder.group({})
managementClassReadonlyInputData
Type : unknown
Default value : cobblerItemReadonlyData
name
Type : string
Private ngUnsubscribe
Type : unknown
Default value : new Subject<void>()
Private route
Type : unknown
Default value : inject(ActivatedRoute)
Private router
Type : unknown
Default value : inject(Router)
Private userService
Type : unknown
Default value : inject(UserService)
import { Component, inject, OnDestroy, OnInit } from '@angular/core';
import {
  AbstractControl,
  FormBuilder,
  FormsModule,
  ReactiveFormsModule,
} from '@angular/forms';
import { MatButton, MatIconButton } from '@angular/material/button';
import { MatCheckbox } from '@angular/material/checkbox';
import { MatDialog } from '@angular/material/dialog';
import {
  MatFormField,
  MatLabel,
  MatSuffix,
} from '@angular/material/form-field';
import { MatIcon } from '@angular/material/icon';
import { MatInput } from '@angular/material/input';
import { MatSnackBar } from '@angular/material/snack-bar';
import { MatTooltip } from '@angular/material/tooltip';
import { ActivatedRoute, Router } from '@angular/router';
import { CobblerApiService, Mgmgtclass } from 'cobbler-api';
import { combineLatest, Observable, Subject } from 'rxjs';
import { takeUntil } from 'rxjs/operators';
import { DialogBoxConfirmCancelEditComponent } from '../../../common/dialog-box-confirm-cancel-edit/dialog-box-confirm-cancel-edit.component';
import { DialogItemCopyComponent } from '../../../common/dialog-item-copy/dialog-item-copy.component';
import { KeyValueEditorComponent } from '../../../common/key-value-editor/key-value-editor.component';
import { MultiSelectComponent } from '../../../common/multi-select/multi-select.component';
import { UserService } from '../../../services/user.service';
import Utils, { CobblerInputChoices, CobblerInputData } from '../../../utils';
import { DialogBoxItemRenderedComponent } from '../../../common/dialog-box-item-rendered/dialog-box-item-rendered.component';
import {
  cobblerItemEditableData,
  cobblerItemReadonlyData,
} from '../../metadata';
import { HelpButtonComponent } from '../../../common/help-button/help-button.component';

@Component({
  selector: 'cobbler-management-class-edit',
  imports: [
    FormsModule,
    MatButton,
    MatCheckbox,
    MatFormField,
    MatIcon,
    MatIconButton,
    MatInput,
    MatLabel,
    MatSuffix,
    MatTooltip,
    ReactiveFormsModule,
    MultiSelectComponent,
    KeyValueEditorComponent,
    HelpButtonComponent,
  ],
  templateUrl: './management-class-edit.component.html',
  styleUrl: './management-class-edit.component.scss',
})
export class ManagementClassEditComponent implements OnInit, OnDestroy {
  private route = inject(ActivatedRoute);
  private userService = inject(UserService);
  private cobblerApiService = inject(CobblerApiService);
  private _snackBar = inject(MatSnackBar);
  private router = inject(Router);
  readonly dialog = inject<MatDialog>(MatDialog);

  // Bring Enum to HTML scope
  protected readonly CobblerInputChoices = CobblerInputChoices;

  // Unsubscribe
  private ngUnsubscribe = new Subject<void>();

  // Form data
  managementClassReadonlyInputData = cobblerItemReadonlyData;
  managementClassEditableInputData: Array<CobblerInputData> = [
    ...cobblerItemEditableData,
    {
      formControlName: 'is_definition',
      inputType: CobblerInputChoices.CHECKBOX,
      label: $localize`:@@management-class.edit.label.is_definition:Is Definition`,
      hint: $localize`:@@management-class.edit.hint.is_definition:When checked, this class is a definition (abstract) and will not be directly applied to systems.`,
      disabled: true,
      readonly: false,
      defaultValue: false,
      inherited: false,
    },
    {
      formControlName: 'redhat_management_key',
      inputType: CobblerInputChoices.TEXT,
      label: $localize`:@@management-class.edit.label.redhat_management_key:RedHat Management Key`,
      hint: $localize`:@@management-class.edit.hint.redhat_management_key:Registration key for Red Hat management systems (Spacewalk, Uyuni, SUSE Manager). Supports <<inherit>>.`,
      disabled: true,
      readonly: false,
      defaultValue: '',
      inherited: false,
    },
    {
      formControlName: 'class_name',
      inputType: CobblerInputChoices.TEXT,
      label: $localize`:@@management-class.edit.label.class_name:Class Name`,
      hint: $localize`:@@management-class.edit.hint.class_name:The fully qualified class name as used by the configuration management system (e.g. Puppet).`,
      disabled: true,
      readonly: false,
      defaultValue: '',
      inherited: false,
    },
    {
      formControlName: 'owners',
      inputType: CobblerInputChoices.MULTI_SELECT,
      label: $localize`:@@management-class.edit.label.owners:Owners`,
      hint: $localize`:@@management-class.edit.hint.owners:Cobbler user accounts allowed to manage this item. Cosmetic only — not validated against real users. Supports <<inherit>>.`,
      disabled: true,
      readonly: false,
      defaultValue: [],
      inherited: true,
    },
    {
      formControlName: 'params',
      inputType: CobblerInputChoices.KEY_VALUE,
      label: $localize`:@@management-class.edit.label.params:Params`,
      hint: $localize`:@@management-class.edit.hint.params:Key=value parameters passed to the management class.`,
      disabled: true,
      readonly: false,
      defaultValue: new Map<string, any>(),
      inherited: true,
    },
    {
      formControlName: 'files',
      inputType: CobblerInputChoices.MULTI_SELECT,
      label: $localize`:@@management-class.edit.label.files:Files`,
      hint: $localize`:@@management-class.edit.hint.files:File objects managed by this class.`,
      disabled: true,
      readonly: false,
      defaultValue: [],
      inherited: true,
    },
    {
      formControlName: 'packages',
      inputType: CobblerInputChoices.MULTI_SELECT,
      label: $localize`:@@management-class.edit.label.packages:Packages`,
      hint: $localize`:@@management-class.edit.hint.packages:Package objects managed by this class.`,
      disabled: true,
      readonly: false,
      defaultValue: [],
      inherited: true,
    },
  ];

  // Form
  name: string;
  managementClass: Mgmgtclass;
  private readonly _formBuilder = inject(FormBuilder);
  managementClassReadonlyFormGroup = this._formBuilder.group({});
  managementClassFormGroup = this._formBuilder.group({});
  isEditMode: boolean = false;

  constructor() {
    this.name = this.route.snapshot.paramMap.get('name');
    Utils.fillupItemFormGroup(
      this.managementClassReadonlyFormGroup,
      this.managementClassFormGroup,
      this.managementClassReadonlyInputData,
      this.managementClassEditableInputData,
    );
  }

  ngOnInit(): void {
    this.refreshData();
    // Observables for inherited properties
    this.managementClassFormGroup
      .get('owners_inherited')
      .valueChanges.subscribe(
        this.getInheritObservable(this.managementClassFormGroup.get('owners')),
      );
  }

  ngOnDestroy(): void {
    this.ngUnsubscribe.next();
    this.ngUnsubscribe.complete();
  }

  getInheritObservable(
    valueControl: AbstractControl,
  ): (value: boolean) => void {
    return (value: boolean): void => {
      if (!this.isEditMode) {
        // If we are not in edit-mode we want to discard processing the event
        return;
      }
      if (value) {
        valueControl.disable();
      } else {
        valueControl.enable();
      }
    };
  }

  refreshData(): void {
    this.cobblerApiService
      .get_mgmtclass(this.name, false, false, this.userService.token)
      .pipe(takeUntil(this.ngUnsubscribe))
      .subscribe({
        next: (value) => {
          this.managementClass = value;
          this.managementClassReadonlyFormGroup.patchValue({
            name: this.managementClass.name,
            uid: this.managementClass.uid,
            mtime: Utils.floatToDate(this.managementClass.mtime).toString(),
            ctime: Utils.floatToDate(this.managementClass.ctime).toString(),
            depth: this.managementClass.depth,
            is_subobject: this.managementClass.is_subobject,
          });
          this.managementClassFormGroup.patchValue({
            is_definition: this.managementClass.is_definition,
            comment: this.managementClass.comment,
            class_name: this.managementClass.class_name,
            params: this.managementClass.params,
            files: this.managementClass.files,
            packages: this.managementClass.packages,
          });
          Utils.patchFormGroupInherited(
            this.managementClassFormGroup,
            this.managementClass.owners,
            'owners',
            [],
          );
        },
        error: (error) => {
          // HTML encode the error message since it originates from XML
          this._snackBar.open(
            Utils.toHTML(error.message),
            $localize`:@@snackbar.action.close:Close`,
          );
        },
      });
  }

  removeManagementClass(): void {
    this.cobblerApiService
      .remove_mgmtclass(this.name, this.userService.token, false)
      .pipe(takeUntil(this.ngUnsubscribe))
      .subscribe({
        next: (value) => {
          if (value) {
            this.router.navigate(['/items', 'profile']);
          }
          // HTML encode the error message since it originates from XML
          this._snackBar.open(
            $localize`:@@error.delete-failed:Delete failed! Check server logs for more information.`,
            $localize`:@@snackbar.action.close:Close`,
          );
        },
        error: (error) => {
          // HTML encode the error message since it originates from XML
          this._snackBar.open(
            Utils.toHTML(error.message),
            $localize`:@@snackbar.action.close:Close`,
          );
        },
      });
  }

  editProfile(): void {
    this.isEditMode = true;
    this.managementClassFormGroup.enable();
    // Inherit inputs
    if (typeof this.managementClass.owners === 'string') {
      this.managementClassFormGroup.get('owners').disable();
    }
  }

  cancelEdit(): void {
    const dialogRef = this.dialog.open(DialogBoxConfirmCancelEditComponent, {
      data: {
        name: this.managementClass.name,
      },
    });

    dialogRef.afterClosed().subscribe((dialogResult) => {
      if (dialogResult === false) {
        // False means the user want's to continue
        return;
      }
      this.isEditMode = false;
      this.managementClassFormGroup.disable();
      this.refreshData();
    });
  }

  showAsRendered(): void {
    this.cobblerApiService
      .get_mgmtclass_as_rendered(
        this.managementClass.name,
        this.userService.token,
      )
      .subscribe((value) => {
        this.dialog.open(DialogBoxItemRenderedComponent, {
          data: {
            itemType: 'Management Class',
            uid: this.managementClass.uid,
            name: this.managementClass.name,
            renderedData: value,
          },
        });
      });
  }

  copyMgmtClass(uid: string, name: string): void {
    const dialogRef = this.dialog.open(DialogItemCopyComponent, {
      data: {
        itemType: 'Management Class',
        itemName: name,
        itemUid: uid,
      },
    });

    dialogRef.afterClosed().subscribe((newItemName) => {
      if (newItemName === undefined) {
        // Cancel means we don't need to rename the management class
        return;
      }
      this.cobblerApiService
        .get_mgmtclass_handle(name, this.userService.token)
        .pipe(takeUntil(this.ngUnsubscribe))
        .subscribe({
          next: (mgmtClassHandle) => {
            this.cobblerApiService
              .copy_mgmtclass(
                mgmtClassHandle,
                newItemName,
                this.userService.token,
              )
              .pipe(takeUntil(this.ngUnsubscribe))
              .subscribe({
                next: () => {
                  this.router.navigate([
                    '/manage',
                    'items',
                    'management-class',
                    newItemName,
                  ]);
                },
                error: (error) => {
                  // HTML encode the error message since it originates from XML
                  this._snackBar.open(
                    Utils.toHTML(error.message),
                    $localize`:@@snackbar.action.close:Close`,
                  );
                },
              });
          },
          error: (error) => {
            // HTML encode the error message since it originates from XML
            this._snackBar.open(
              Utils.toHTML(error.message),
              $localize`:@@snackbar.action.close:Close`,
            );
          },
        });
    });
  }

  saveProfile(): void {
    let dirtyValues = Utils.deduplicateDirtyValues(
      this.managementClassFormGroup,
      Utils.getDirtyValues(this.managementClassFormGroup),
    );
    this.cobblerApiService
      .get_mgmtclass_handle(this.name, this.userService.token)
      .pipe(takeUntil(this.ngUnsubscribe))
      .subscribe({
        next: (managementClassHandle) => {
          let modifyObservables: Observable<boolean>[] = [];
          dirtyValues.forEach((value, key) => {
            modifyObservables.push(
              this.cobblerApiService.modify_mgmtclass(
                managementClassHandle,
                key,
                value,
                this.userService.token,
              ),
            );
          });
          combineLatest(modifyObservables).subscribe({
            next: () => {
              this.cobblerApiService
                .save_mgmtclass(managementClassHandle, this.userService.token)
                .subscribe({
                  next: () => {
                    this.isEditMode = false;
                    this.managementClassFormGroup.disable();
                    this.refreshData();
                  },
                  error: (error) => {
                    this._snackBar.open(
                      Utils.toHTML(error.message),
                      $localize`:@@snackbar.action.close:Close`,
                    );
                  },
                });
            },
            error: (error) => {
              this._snackBar.open(
                Utils.toHTML(error.message),
                $localize`:@@snackbar.action.close:Close`,
              );
            },
          });
        },
        error: (error) => {
          this._snackBar.open(
            Utils.toHTML(error.message),
            $localize`:@@snackbar.action.close:Close`,
          );
        },
      });
  }
}
<div class="title-table">
  <div class="title-row">
    <h1 class="title title-cell-text" i18n="@@item.header.name">
      Name: {{ name }}
    </h1>
    <span class="title-cell-button">
      <button
        mat-icon-button
        [disabled]="isEditMode"
        (click)="this.refreshData()"
        matTooltip="Refresh data"
        i18n-matTooltip="@@button.refresh.tooltip"
      >
        <mat-icon>refresh</mat-icon>
      </button>
    </span>
    <span class="title-cell-button">
      <button
        mat-icon-button
        [disabled]="isEditMode"
        (click)="
          this.copyMgmtClass(
            this.managementClass.uid,
            this.managementClass.name
          )
        "
        matTooltip="Copy"
        i18n-matTooltip="@@button.copy.tooltip"
      >
        <mat-icon>content_copy</mat-icon>
      </button>
    </span>
    <span class="title-cell-button">
      <button
        mat-icon-button
        [disabled]="isEditMode"
        (click)="this.showAsRendered()"
        matTooltip="Show rendered data"
        i18n-matTooltip="@@button.show-rendered.tooltip"
      >
        <mat-icon>info</mat-icon>
      </button>
    </span>
    <span class="title-cell-button">
      <button
        mat-icon-button
        data-testid="item-edit-toggle"
        [disabled]="isEditMode"
        (click)="this.editProfile()"
        matTooltip="Edit"
        i18n-matTooltip="@@button.edit.tooltip"
      >
        <mat-icon>edit</mat-icon>
      </button>
    </span>
    <span class="title-cell-button">
      <button
        mat-icon-button
        [disabled]="isEditMode"
        (click)="this.removeManagementClass()"
        matTooltip="Delete"
        i18n-matTooltip="@@button.delete.tooltip"
      >
        <mat-icon>delete</mat-icon>
      </button>
    </span>
    @if (isEditMode) {
      <span class="title-cell-button">
        <button
          mat-icon-button
          (click)="this.cancelEdit()"
          matTooltip="Cancel edit"
          i18n-matTooltip="@@button.cancel-edit.tooltip"
        >
          <mat-icon>cancel</mat-icon>
        </button>
      </span>
    }
  </div>
</div>

<form class="form-replicate" [formGroup]="managementClassReadonlyFormGroup">
  @for (input of managementClassReadonlyInputData; track input) {
    @switch (input.inputType) {
      @case (CobblerInputChoices.TEXT) {
        <mat-form-field class="form-field-full-width">
          <mat-label>{{ input.label }}</mat-label>
          <input
            matInput
            type="{{ input.inputType }}"
            formControlName="{{ input.formControlName }}"
            readonly="{{ input.readonly }}"
          />
        </mat-form-field>
      }
      @case (CobblerInputChoices.NUMBER) {
        <mat-form-field class="form-field-full-width">
          <mat-label>{{ input.label }}</mat-label>
          <input
            matInput
            type="{{ input.inputType }}"
            formControlName="{{ input.formControlName }}"
            readonly="{{ input.readonly }}"
          />
        </mat-form-field>
      }
      @case (CobblerInputChoices.CHECKBOX) {
        <mat-checkbox
          class="form-field-full-width"
          formControlName="{{ input.formControlName }}"
          [disableRipple]="true"
          (click)="$event.preventDefault()"
        >
          {{ input.label }}
        </mat-checkbox>
      }
    }
  }
</form>

<form class="form-replicate" [formGroup]="managementClassFormGroup">
  @for (input of managementClassEditableInputData; track input) {
    @switch (input.inputType) {
      @case (CobblerInputChoices.TEXT) {
        <mat-form-field class="form-field-full-width">
          <mat-label>{{ input.label }}</mat-label>
          <input
            matInput
            type="{{ input.inputType }}"
            formControlName="{{ input.formControlName }}"
            readonly="{{ input.readonly }}"
          />
          @if (input.hint) {
            <cobbler-help-button matSuffix [hint]="input.hint" />
          }
        </mat-form-field>
      }
      @case (CobblerInputChoices.NUMBER) {
        <mat-form-field class="form-field-full-width">
          <mat-label>{{ input.label }}</mat-label>
          <input
            matInput
            type="{{ input.inputType }}"
            formControlName="{{ input.formControlName }}"
            readonly="{{ input.readonly }}"
          />
          @if (input.hint) {
            <cobbler-help-button matSuffix [hint]="input.hint" />
          }
        </mat-form-field>
      }
      @case (CobblerInputChoices.CHECKBOX) {
        <div class="cobbler-field-row">
          <mat-checkbox
            class="form-field-full-width"
            formControlName="{{ input.formControlName }}"
            [disableRipple]="true"
            (click)="$event.preventDefault()"
          >
            {{ input.label }}
          </mat-checkbox>
          @if (input.hint) {
            <cobbler-help-button [hint]="input.hint" />
          }
        </div>
      }
      @case (CobblerInputChoices.MULTI_SELECT) {
        <ng-container class="form-field-full-width">
          <cobbler-multi-select
            label="{{ input.label }}"
            formControlName="{{ input.formControlName }}"
          ></cobbler-multi-select>
          @if (input.hint) {
            <cobbler-help-button [hint]="input.hint" />
          }
          @if (input.inherited) {
            <mat-checkbox
              formControlName="{{ input.formControlName }}_inherited"
              i18n
              >Inherited</mat-checkbox
            >
          }
        </ng-container>
      }
      @case (CobblerInputChoices.KEY_VALUE) {
        <ng-container class="form-field-full-width">
          <cobbler-key-value-editor
            label="{{ input.label }}"
            formControlName="{{ input.formControlName }}"
            [hint]="input.hint"
          ></cobbler-key-value-editor>
          @if (input.inherited) {
            <mat-checkbox
              formControlName="{{ input.formControlName }}_inherited"
              i18n
              >Inherited</mat-checkbox
            >
          }
        </ng-container>
      }
    }
  }
  @if (isEditMode) {
    <div>
      <button
        mat-button
        data-testid="item-save-button"
        (click)="saveProfile()"
        i18n="@@management-class.edit.button.save"
      >
        Save Management Class
      </button>
    </div>
  }
</form>

./management-class-edit.component.scss

.title-table {
  display: table;
  width: 100%;
}

.title-row {
  display: table-cell;
  width: 100%;
}

.title-cell-text {
  display: table-cell;
  width: 100%;
  vertical-align: middle;
}

.title-cell-button {
  display: table-cell;
}

.form-replicate {
  min-width: 150px;
  max-width: 600px;
  width: 100%;
}

.form-field-full-width {
  width: 100%;
}
Legend
Html element
Component
Html element with directive

results matching ""

    No results matching ""