Merge pull request openscd#817 from openscd/104-subnetwork-redundancy

feat(104/Subnetworks): Show/edit subnetworks with redundancy

Author: Dennis Labordus

src/editors/protocol104/connectedap-editor.ts

@@ -10,7 +10,7 @@ import '@material/mwc-fab';
 
 import '../../action-icon.js';
 import { newWizardEvent, newActionEvent } from '../../foundation.js';
-import { editConnectedAp104Wizard } from './wizards/connectedap.js';
+import { editConnectedApWizard } from './wizards/connectedap.js';
 
 /** [[`104`]] subeditor for a `ConnectedAP` element. */
 @customElement('connectedap-104-editor')
@@ -20,7 +20,14 @@ export class ConnectedAP104Editor extends LitElement {
   element!: Element;
 
   private openEditWizard(): void {
-    this.dispatchEvent(newWizardEvent(editConnectedAp104Wizard(this.element)));
+    this.dispatchEvent(
+      newWizardEvent(() =>
+        editConnectedApWizard(
+          this.element,
+          this.element.querySelectorAll('Address > P[type^="RG"]').length > 0
+        )
+      )
+    );
   }
 
   remove(): void {

src/editors/protocol104/foundation/foundation.ts

@@ -1,11 +1,16 @@
+import { html, TemplateResult } from "lit-element";
+import { ifDefined } from "lit-html/directives/if-defined.js";
+import { translate } from "lit-translate";
 import {
   Create,
   getInstanceAttribute,
   getNameAttribute,
   newWizardEvent
 } from "../../../foundation.js";
+import { typeMaxLength } from "../../../wizards/foundation/p-types.js";
 import { editAddressWizard } from "../wizards/address.js";
 import { TiInformation } from "./cdc.js";
+import { typeDescriptiveNameKeys, typePattern } from "./p-types.js";
 
 export const PRIVATE_TYPE_104 = "IEC_60870_5_104";
 
@@ -241,6 +246,22 @@ export function createCheckActions(
   return actions;
 }
 
+/**
+ * Create a wizard-textfield element for the wizards within the Network part of the 104 plugin.
+ * @param pType - The type of P a Text Field has to be created for.
+ * @returns - A Text Field created for a specific type for the Create wizard.
+ */
+export function createNetworkTextField(pType: string, maybeValue?: string): TemplateResult {
+  return html`<wizard-textfield
+    required
+    label="${pType}"
+    pattern="${ifDefined(typePattern[pType])}"
+    .maybeValue=${maybeValue ?? null}
+    maxLength="${ifDefined(typeMaxLength[pType])}"
+    helper="${translate(typeDescriptiveNameKeys[pType])}"
+  ></wizard-textfield>`
+}
+
 /**
  * Enumeration stating the active view of the 104 plugin.
  */

src/editors/protocol104/foundation/p-types.ts

@@ -9,6 +9,20 @@ export const pTypes104: string[] = [
   'TIMEOUT-3'
 ];
 
+export const pTypesRedundancyGroup104: string[] = [
+  'W-FACTOR',
+  'K-FACTOR',
+  'TIMEOUT-0',
+  'TIMEOUT-1',
+  'TIMEOUT-2',
+  'TIMEOUT-3'
+];
+
+export const pTypesLogicLink104: string[] = [
+  'IP',
+  'IP-SUBNET'
+];
+
 const typeBase = {
   IP: '([0-9]{1,2}|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]([0-9]{1,2}|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]([0-9]{1,2}|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]([0-9]{1,2}|1[0-9]{2}|2[0-4][0-9]|25[0-5])',
   factor: '[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[1-3][0-2][0-7][0-6][0-7]',
@@ -32,15 +46,14 @@ export const stationTypeOptions: string[] = [
   'controlled-station'
 ]
 
-/** Max length definition for all `P` element */
 export const typeDescriptiveNameKeys: Record<string, string> = {
-  'StationType': 'protocol104.network.connectedap.stationType',
-  'IP': 'protocol104.network.connectedap.ip',
-  'IP-SUBNET': 'protocol104.network.connectedap.ipSubnet',
-  'W-FACTOR': 'protocol104.network.connectedap.wFactor',
-  'K-FACTOR': 'protocol104.network.connectedap.kFactor',
-  'TIMEOUT-0': 'protocol104.network.connectedap.timeout0',
-  'TIMEOUT-1': 'protocol104.network.connectedap.timeout1',
-  'TIMEOUT-2': 'protocol104.network.connectedap.timeout2',
-  'TIMEOUT-3': 'protocol104.network.connectedap.timeout3',
+  'StationType': 'protocol104.network.connectedAp.wizard.stationTypeHelper',
+  'IP': 'protocol104.network.connectedAp.wizard.ipHelper',
+  'IP-SUBNET': 'protocol104.network.connectedAp.wizard.ipSubnetHelper',
+  'W-FACTOR': 'protocol104.network.connectedAp.wizard.wFactorHelper',
+  'K-FACTOR': 'protocol104.network.connectedAp.wizard.kFactorHelper',
+  'TIMEOUT-0': 'protocol104.network.connectedAp.wizard.timeout0Helper',
+  'TIMEOUT-1': 'protocol104.network.connectedAp.wizard.timeout1Helper',
+  'TIMEOUT-2': 'protocol104.network.connectedAp.wizard.timeout2Helper',
+  'TIMEOUT-3': 'protocol104.network.connectedAp.wizard.timeout3Helper',
 };

src/editors/protocol104/wizards/connectedap.ts

@@ -1,7 +1,8 @@
-import { html } from 'lit-element';
+import { html, TemplateResult } from 'lit-element';
 import { translate, get } from 'lit-translate';
 
 import '@material/mwc-checkbox';
+import '@material/mwc-switch';
 import '@material/mwc-formfield';
 import '@material/mwc-list/mwc-list-item';
 import '@material/mwc-list/mwc-check-list-item';
@@ -15,24 +16,32 @@ import '../../../filtered-list.js';
 import {
   pTypes104,
   stationTypeOptions,
-  typeDescriptiveNameKeys
+  typeDescriptiveNameKeys,
+  typePattern
 } from '../foundation/p-types.js';
 import {
+  cloneElement,
   compareNames,
   ComplexAction,
   createElement,
   EditorAction,
   getValue,
   identity,
   isPublic,
+  newSubWizardEvent,
+  newWizardEvent,
   Wizard,
   WizardActor,
-  WizardInputElement
+  WizardInputElement,
+  WizardMenuActor
 } from '../../../foundation.js';
 import {
-  createPTextField,
   createTypeRestrictionCheckbox
 } from '../../../wizards/connectedap.js';
+import { SingleSelectedEvent } from '@material/mwc-list/mwc-list-foundation';
+import { ifDefined } from 'lit-html/directives/if-defined';
+import { typeMaxLength } from '../../../wizards/foundation/p-types.js';
+import { createRedundancyGroupWizard, editRedundancyGroupWizard } from './redundancygroup.js';
 
 interface AccessPointDescription {
   element: Element;
@@ -164,7 +173,85 @@ function createAddressElement(
   return element;
 }
 
-export function updateConnectedApAction(parent: Element): WizardActor {
+/** @returns single page [[`Wizard`]] to edit SCL element ConnectedAP for the 104 plugin. */
+export function editConnectedApWizard(parent: Element, redundancy?: boolean): Wizard {
+  const redundancyGroupNumbers = getRedundancyGroupNumbers(parent);
+  return [
+    {
+      title: get('protocol104.network.connectedAp.wizard.title.edit'),
+      element: parent,
+      menuActions: redundancy
+      ? [{
+          icon: 'playlist_add',
+          label: get('protocol104.network.connectedAp.wizard.addRedundancyGroup'),
+          action: openRedundancyGroupWizard(parent, redundancyGroupNumbers),
+        }]
+      : undefined,
+      primary: {
+        icon: 'save',
+        label: get('save'), 
+        action: editConnectedApAction(parent, redundancy),
+      },
+      content: [
+        html`<mwc-formfield label="${get('protocol104.network.connectedAp.wizard.redundancySwitchLabel')}">
+          <mwc-switch
+            id="redundancy"
+            ?checked=${redundancy}
+            @change=${(event: Event) => {
+              event.target!.dispatchEvent(newWizardEvent());
+              event.target!.dispatchEvent(
+                newSubWizardEvent(() =>
+                  editConnectedApWizard(
+                    parent,
+                    !redundancy
+                  )
+                )
+              );
+            }}
+          ></mwc-switch>
+        </mwc-formfield>
+        <wizard-divider></wizard-divider>
+        ${createTypeRestrictionCheckbox(parent)}
+        <wizard-select
+          label="StationType"
+          .maybeValue=${parent.querySelector(
+            `Address > P[type="StationType"]`
+          )?.innerHTML ?? null}
+          required
+          fixedMenuPosition
+          helper="${translate(typeDescriptiveNameKeys["StationType"])}"
+        >
+          ${stationTypeOptions.map(
+            option => html`<mwc-list-item value="${option}">${option}</mwc-list-item>`
+          )}
+        </wizard-select>
+        ${redundancy
+          ? html`<h3>${get('protocol104.network.connectedAp.wizard.redundancyGroupTitle')}</h3>
+            <mwc-list
+              @selected=${(e: SingleSelectedEvent) => {
+                e.target!.dispatchEvent(
+                  newSubWizardEvent(() =>
+                    editRedundancyGroupWizard(
+                      parent,
+                      redundancyGroupNumbers[e.detail.index]
+                    )
+                  )
+                );
+              }}>
+              ${redundancyGroupNumbers.length != 0
+                ? redundancyGroupNumbers.map(number => html`<mwc-list-item>Redundancy Group ${number}</mwc-list-item>`)
+                : html`<p>${get('protocol104.network.connectedAp.wizard.noRedundancyGroupsAvailable')}</p>`}
+            </mwc-list>`
+          : html`${pTypes104.map(
+            pType => html`${createEditTextField(parent, pType)}`
+          )}`}
+        `,
+      ],
+    },
+  ];
+}
+
+function editConnectedApAction(parent: Element, redundancy?: boolean): WizardActor {
   return (inputs: WizardInputElement[], wizard: Element): EditorAction[] => {
     const typeRestriction: boolean =
       (<Checkbox>wizard.shadowRoot?.querySelector('#typeRestriction'))
@@ -180,7 +267,24 @@ export function updateConnectedApAction(parent: Element): WizardActor {
         apName: parent.getAttribute('apName') ?? '',
       }),
     };
-    if (oldAddress !== null && !isEqualAddress(oldAddress, newAddress)) {
+    // When we have a redundanct ConnectedAP, we are only interested in the StationType value.
+    // All redundancy group actions are done in those wizards itself.
+    if (redundancy) {
+      const stationTypeValue = getValue(inputs.find(i => i.label === 'StationType')!)!;
+      const originalElement = oldAddress?.querySelector('P[type="StationType"]');
+
+      const elementClone = cloneElement(originalElement!, {});
+      elementClone!.textContent = stationTypeValue;
+
+      complexAction.actions.push({
+        old: {
+          element: originalElement!
+        },
+        new: {
+          element: elementClone
+        }
+      });
+    } else if (oldAddress !== null && !isEqualAddress(oldAddress, newAddress)) {
       //address & child elements P are changed: cannot use replace editor action
       complexAction.actions.push({
         old: {
@@ -206,35 +310,44 @@ export function updateConnectedApAction(parent: Element): WizardActor {
   };
 }
 
-/** @returns single page [[`Wizard`]] to edit SCL element ConnectedAP for the 104 plugin. */
-export function editConnectedAp104Wizard(element: Element): Wizard {
-  return [
-    {
-      title: get('wizard.title.edit', { tagName: element.tagName }),
-      element,
-      primary: {
-        icon: 'save',
-        label: get('save'),
-        action: updateConnectedApAction(element),
-      },
-      content: [
-        html`${createTypeRestrictionCheckbox(element)}
-          <wizard-select
-            label="StationType"
-            .maybeValue=${element.querySelector(
-          `Address > P[type="StationType"]`
-        )?.innerHTML ?? null}
-            required
-            helper="${translate(typeDescriptiveNameKeys["StationType"])}"
-          >${stationTypeOptions.map(
-          option =>
-            html`<mwc-list-item value="${option}">${option}</mwc-list-item>`
-        )}</wizard-select>
-          ${pTypes104.map(
-          pType =>
-            html`${createPTextField(element, pType)}`
-        )}`,
-      ],
-    },
-  ];
+function openRedundancyGroupWizard(element: Element, rGNumbers: number[]): WizardMenuActor {
+  return (wizard: Element): void => {
+    wizard.dispatchEvent(newSubWizardEvent(createRedundancyGroupWizard(element, rGNumbers)));
+  };
 }
+
+/**
+ * Get all the current used Redundancy Group numbers.
+ * @param parent - The parent element of all the P elements.
+ * @returns An array with all the Redundancy Group numbers.
+ */
+function getRedundancyGroupNumbers(parent: Element): number[] {
+  const groupNumbers: number[] = [];
+
+  parent.querySelectorAll(`Address > P[type^="RG"]`).forEach(p => {
+    const redundancyGroupPart = p.getAttribute('type')?.split('-')[0];
+    const number = Number(redundancyGroupPart?.substring(2));
+    
+    if (!groupNumbers.includes(number)) groupNumbers.push(number)
+  })
+
+  return groupNumbers.sort();
+}
+
+/**
+ * Create a wizard-textfield element for the Edit wizard.
+ * @param parent - The parent element of the P to create. 
+ * @param pType - The type of P a Text Field has to be created for.
+ * @returns - A Text Field created for a specific type for the Edit wizard.
+ */
+function createEditTextField(parent: Element, pType: string): TemplateResult {
+  return html`<wizard-textfield
+    required
+    label="${pType}"
+    pattern="${ifDefined(typePattern[pType])}"
+    .maybeValue=${parent.querySelector(
+      `Address > P[type="${pType}"]`
+    )?.innerHTML ?? null}
+    maxLength="${ifDefined(typeMaxLength[pType])}"
+  ></wizard-textfield>`
+}