feat(wizards/reportcontrol): add copy to other IEDs (openscd#632)

* feat(foundation/scl): add existFcdaReference

* feat(wizards/reportcontrol): add copy menu action

* test(wizards/reportcontrol): adopt snapshots

* git commit -m"feat(wizards/reportcontrol): add translation"

* git commit -m"test(wizards/reportcontrol): add first integration tests"

* test(wizards/reportcontrol): add another integration test

* test(wizards/reportcontrol): fix snapshots

Author: JakobVogelsang

src/foundation/scl.ts

@@ -0,0 +1,89 @@
+import { crossProduct } from '../foundation.js';
+
+function getDataModelChildren(parent: Element): Element[] {
+  if (['LDevice', 'Server'].includes(parent.tagName))
+    return Array.from(parent.children).filter(
+      child =>
+        child.tagName === 'LDevice' ||
+        child.tagName === 'LN0' ||
+        child.tagName === 'LN'
+    );
+
+  const id =
+    parent.tagName === 'LN' || parent.tagName === 'LN0'
+      ? parent.getAttribute('lnType')
+      : parent.getAttribute('type');
+
+  return Array.from(
+    parent.ownerDocument.querySelectorAll(
+      `LNodeType[id="${id}"] > DO, DOType[id="${id}"] > SDO, DOType[id="${id}"] > DA, DAType[id="${id}"] > BDA`
+    )
+  );
+}
+
+export function existFcdaReference(fcda: Element, ied: Element): boolean {
+  const [ldInst, prefix, lnClass, lnInst, doName, daName, fc] = [
+    'ldInst',
+    'prefix',
+    'lnClass',
+    'lnInst',
+    'doName',
+    'daName',
+    'fc',
+  ].map(attr => fcda.getAttribute(attr));
+
+  const sinkLdInst = ied.querySelector(`LDevice[inst="${ldInst}"]`);
+  if (!sinkLdInst) return false;
+
+  const prefixSelctors = prefix
+    ? [`[prefix="${prefix}"]`]
+    : ['[prefix=""]', ':not([prefix])'];
+  const lnInstSelectors = lnInst
+    ? [`[inst="${lnInst}"]`]
+    : ['[inst=""]', ':not([inst])'];
+
+  const anyLnSelector = crossProduct(
+    ['LN0', 'LN'],
+    prefixSelctors,
+    [`[lnClass="${lnClass}"]`],
+    lnInstSelectors
+  )
+    .map(strings => strings.join(''))
+    .join(',');
+
+  const sinkAnyLn = ied.querySelector(anyLnSelector);
+  if (!sinkAnyLn) return false;
+
+  const doNames = doName?.split('.');
+  if (!doNames) return false;
+
+  let parent: Element | undefined = sinkAnyLn;
+  for (const doNameAttr of doNames) {
+    parent = getDataModelChildren(parent).find(
+      child => child.getAttribute('name') === doNameAttr
+    );
+    if (!parent) return false;
+  }
+
+  const daNames = daName?.split('.');
+  const someFcInSink = getDataModelChildren(parent).some(
+    da => da.getAttribute('fc') === fc
+  );
+  if (!daNames && someFcInSink) return true;
+  if (!daNames) return false;
+
+  let sinkFc = '';
+  for (const daNameAttr of daNames) {
+    parent = getDataModelChildren(parent).find(
+      child => child.getAttribute('name') === daNameAttr
+    );
+
+    if (parent?.getAttribute('fc')) sinkFc = parent.getAttribute('fc')!;
+
+    if (!parent) return false;
+  }
+
+  if (sinkFc !== fc) return false;
+
+  return true;
+}

src/translations/de.ts

@@ -526,6 +526,16 @@ export const de: Translations = {
       remove:
         '{{type}} "{{name}}" and referenzierte Element von IED {{iedName}} entfernt',
     },
+    hints: {
+      source: 'Quell-IED',
+      missingServer: 'Kein Server vorhanden',
+      exist: '{{type}} mit dem Namen {{name}} existiert',
+      noMatchingData: 'Keine Datenübereinstimmung',
+      valid: 'Kann kopiert werden',
+    },
+    label: {
+      copy: 'Kopie in anderen IEDs ertellen',
+    },
   },
   add: 'Hinzufügen',
   new: 'Neu',

src/translations/en.ts

@@ -523,6 +523,14 @@ export const en = {
       remove:
         'Removed {{type}} "{{name}}" and its referenced elements from IED {{iedName}}',
     },
+    hints: {
+      source: 'Source IED',
+      missingServer: 'Not A Server',
+      exist: '{{type}} with name {{name}} already exist',
+      noMatchingData: 'No matching data',
+      valid: 'Can be copied',
+    },
+    label: { copy: 'Copy to other IEDs' },
   },
   add: 'Add',
   new: 'New',

src/wizards/foundation/finder.ts

@@ -48,6 +48,16 @@ export function iEDPicker(doc: XMLDocument): TemplateResult {
   ></finder-list>`;
 }
 
+export function iEDsPicker(doc: XMLDocument): TemplateResult {
+  return html`<finder-list
+    multi
+    path="${JSON.stringify(['SCL: '])}"
+    .read=${getReader(doc.querySelector('SCL')!, getIED)}
+    .getDisplayString=${getDisplayString}
+    .getTitle=${(path: string[]) => path[path.length - 1]}
+  ></finder-list>`;
+}
+
 export function getDataModelChildren(parent: Element): Element[] {
   if (['LDevice', 'Server'].includes(parent.tagName))
     return Array.from(parent.children).filter(

src/wizards/reportcontrol.ts

@@ -3,6 +3,7 @@ import { get, translate } from 'lit-translate';
 
 import '@material/mwc-button';
 import '@material/mwc-list/mwc-list-item';
+import '@material/mwc-list/mwc-check-list-item';
 import { List } from '@material/mwc-list';
 import { ListItemBase } from '@material/mwc-list/mwc-list-item-base';
 import { SingleSelectedEvent } from '@material/mwc-list/mwc-list-foundation';
@@ -32,13 +33,15 @@ import {
   WizardAction,
   MenuAction,
 } from '../foundation.js';
+import { FilteredList } from '../filtered-list.js';
 import { FinderList } from '../finder-list.js';
 import { dataAttributePicker, iEDPicker } from './foundation/finder.js';
 import { maxLength, patterns } from './foundation/limits.js';
 import { editDataSetWizard } from './dataset.js';
 import { newFCDA } from './fcda.js';
 import { contentOptFieldsWizard, editOptFieldsWizard } from './optfields.js';
 import { contentTrgOpsWizard, editTrgOpsWizard } from './trgops.js';
+import { existFcdaReference } from '../foundation/scl.js';
 
 interface ContentOptions {
   name: string | null;
@@ -407,6 +410,147 @@ function getRptEnabledAction(
   };
 }
 
+function copyReportControlActions(element: Element): WizardActor {
+  return (_: WizardInputElement[], wizard: Element) => {
+    const doc = element.ownerDocument;
+
+    const iedItems = <ListItemBase[]>(
+      wizard.shadowRoot?.querySelector<FilteredList>('filtered-list')?.selected
+    );
+
+    const complexActions: ComplexAction[] = [];
+    iedItems.forEach(iedItem => {
+      const ied = doc.querySelector(selector('IED', iedItem.value));
+      if (!ied) return;
+
+      const sinkLn0 = ied.querySelector('LN0');
+      if (!sinkLn0) return [];
+
+      const sourceDataSet = element.parentElement?.querySelector(
+        `DataSet[name="${element.getAttribute('datSet')}"]`
+      );
+      if (
+        sourceDataSet &&
+        sinkLn0.querySelector(
+          `DataSet[name="${sourceDataSet!.getAttribute('name')}"]`
+        )
+      )
+        return [];
+
+      if (
+        sinkLn0.querySelector(
+          `ReportControl[name="${element.getAttribute('name')}"]`
+        )
+      )
+        return [];
+
+      // clone DataSet and make sure that FCDA is valid in ied
+      const sinkDataSet = <Element>sourceDataSet?.cloneNode(true);
+      Array.from(sinkDataSet.querySelectorAll('FCDA')).forEach(fcda => {
+        if (!existFcdaReference(fcda, ied)) sinkDataSet.removeChild(fcda);
+      });
+      if (sinkDataSet.children.length === 0) return []; // when no data left no copy needed
+
+      const sinkReportControl = <Element>element.cloneNode(true);
+
+      const source = element.closest('IED')?.getAttribute('name');
+      const sink = ied.getAttribute('name');
+
+      complexActions.push({
+        title: `ReportControl copied from ${source} to ${sink}`,
+        actions: [
+          { new: { parent: sinkLn0, element: sinkDataSet } },
+          { new: { parent: sinkLn0, element: sinkReportControl } },
+        ],
+      });
+    });
+
+    return complexActions;
+  };
+}
+
+function renderIedListItem(sourceCb: Element, ied: Element): TemplateResult {
+  const sourceDataSet = sourceCb.parentElement?.querySelector(
+    `DataSet[name="${sourceCb.getAttribute('datSet')}"]`
+  );
+
+  const isSourceIed =
+    sourceCb.closest('IED')?.getAttribute('name') === ied.getAttribute('name');
+  const ln0 = ied.querySelector('AccessPoint > Server > LDevice > LN0');
+  const hasCbNameConflict = ln0?.querySelector(
+    `ReportControl[name="${sourceCb.getAttribute('name')}"]`
+  )
+    ? true
+    : false;
+  const hasDataSetConflict = ln0?.querySelector(
+    `DataSet[name="${sourceDataSet?.getAttribute('name')}"]`
+  )
+    ? true
+    : false;
+
+  // clone DataSet and make sure that FCDA is valid in ied
+  const sinkDataSet = <Element>sourceDataSet?.cloneNode(true);
+  Array.from(sinkDataSet.querySelectorAll('FCDA')).forEach(fcda => {
+    if (!existFcdaReference(fcda, ied)) sinkDataSet.removeChild(fcda);
+  });
+  const hasDataMatch = sinkDataSet.children.length > 0;
+
+  const primSpan = ied.getAttribute('name');
+  let secondSpan = '';
+  if (isSourceIed) secondSpan = get('controlblock.hints.source');
+  else if (!ln0) secondSpan = get('controlblock.hints.missingServer');
+  else if (hasDataSetConflict && !isSourceIed)
+    secondSpan = get('controlblock.hints.exist', {
+      type: 'RerportControl',
+      name: sourceCb.getAttribute('name')!,
+    });
+  else if (hasCbNameConflict && !isSourceIed)
+    secondSpan = get('controlblock.hints.exist', {
+      type: 'DataSet',
+      name: sourceCb.getAttribute('name')!,
+    });
+  else if (!hasDataMatch) secondSpan = get('controlblock.hints.noMatchingData');
+  else secondSpan = get('controlBlock.hints.valid');
+
+  return html`<mwc-check-list-item
+    twoline
+    value="${identity(ied)}"
+    ?disabled=${isSourceIed ||
+    !ln0 ||
+    hasCbNameConflict ||
+    hasDataSetConflict ||
+    !hasDataMatch}
+    ><span>${primSpan}</span
+    ><span slot="secondary">${secondSpan}</span></mwc-check-list-item
+  >`;
+}
+
+export function reportControlCopyToIedSelector(element: Element): Wizard {
+  return [
+    {
+      title: get('report.wizard.location'),
+      primary: {
+        icon: 'save',
+        label: get('save'),
+        action: copyReportControlActions(element),
+      },
+      content: [
+        html`<filtered-list multi
+          >${Array.from(element.ownerDocument.querySelectorAll('IED')).map(
+            ied => renderIedListItem(element, ied)
+          )}</filtered-list
+        >`,
+      ],
+    },
+  ];
+}
+
+function openIedsSelector(element: Element): WizardMenuActor {
+  return (): WizardAction[] => {
+    return [() => reportControlCopyToIedSelector(element)];
+  };
+}
+
 export function removeReportControl(element: Element): WizardMenuActor {
   return (): WizardAction[] => {
     const complexAction = removeReportControlAction(element);
@@ -538,6 +682,12 @@ export function editReportControlWizard(element: Element): Wizard {
       action: openOptFieldsWizard(optFields),
     });
 
+  menuActions.push({
+    icon: 'copy',
+    label: get('controlblock.label.copy'),
+    action: openIedsSelector(element),
+  });
+
   return [
     {
       title: get('wizard.title.edit', { tagName: element.tagName }),