FaultTolerantGraphMLIOHandler.js

/****************************************************************************
 ** @license
 ** This demo file is part of yFiles for HTML 2.6.
 ** Copyright (c) 2000-2024 by yWorks GmbH, Vor dem Kreuzberg 28,
 ** 72070 Tuebingen, Germany. All rights reserved.
 **
 ** yFiles demo files exhibit yFiles for HTML functionalities. Any redistribution
 ** of demo files in source code or binary form, with or without
 ** modification, is not permitted.
 **
 ** Owners of a valid software license for a yFiles for HTML version that this
 ** demo is shipped with are allowed to use the demo source code as basis
 ** for their own yFiles for HTML powered applications. Use of such programs is
 ** governed by the rights and conditions as set out in the yFiles for HTML
 ** license agreement.
 **
 ** THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY EXPRESS OR IMPLIED
 ** WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 ** MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 ** NO EVENT SHALL yWorks BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 ** TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 ** PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 ** LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 ** NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 ** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 **
 ***************************************************************************/
import {
  DefaultLabelStyle,
  GraphComponent,
  GraphItemTypes,
  GraphMLIOHandler,
  GraphMLParser,
  IEdge,
  IGraph,
  INode,
  Mapper,
  SerializationProperties,
  ShapeNodeStyle,
  StripeTypes,
  YBoolean
} from 'yfiles'

/**
 * This GraphML IO Handler can read graphs with unknown styles.
 *
 * First, it reads with default settings. If this fails, reading styles is disabled for the next
 * try.
 */
class FaultTolerantGraphMLIOHandler extends GraphMLIOHandler {
  disableStyles = false
  onRetry = null

  /**
   * @param {!GraphMLParser} parser
   * @param {!IGraph} graph
   */
  configureGraphMLParser(parser, graph) {
    super.configureGraphMLParser(parser, graph)
    parser.setDeserializationProperty(
      SerializationProperties.DISABLE_STYLES,
      this.disableStyles ? GraphItemTypes.ALL : GraphItemTypes.NONE
    )
    parser.setDeserializationProperty(
      SerializationProperties.DISABLE_STRIPE_STYLES,
      this.disableStyles ? StripeTypes.ALL : StripeTypes.NONE
    )
  }

  /**
   * @param {!IGraph} graph
   * @param {!Document} document
   * @returns {!Promise.<IGraph>}
   */
  async readFromDocument(graph, document) {
    return this.retry(() => super.readFromDocument(graph, document))
  }

  /**
   * @param {!IGraph} graph
   * @param {!string} url
   * @returns {!Promise.<IGraph>}
   */
  async readFromURL(graph, url) {
    return this.retry(() => super.readFromURL(graph, url))
  }

  /**
   * @param {!function} read
   * @returns {!Promise.<IGraph>}
   */
  async retry(read) {
    try {
      this.disableStyles = false
      return await read()
    } catch (err) {
      if (
        !(err instanceof Error) ||
        err.message == null ||
        err.message.indexOf('Unable to map XML element') === -1
      ) {
        throw err
      }
      if (typeof this.onRetry === 'function') {
        this.onRetry(err)
      }

      // retry with styles disabled
      this.disableStyles = true
      return await read()
    }
  }
}

/**
 * Creates a preconfigured GraphMLIOHandler that supports all styles that are used in this demo.
 * @param {!GraphComponent} [graphComponent]
 * @returns {!GraphMLIOHandler}
 */
export function createConfiguredGraphMLIOHandler(graphComponent) {
  const graphMLIOHandler = new FaultTolerantGraphMLIOHandler()
  if (graphComponent) {
    const selectedEdges = new Mapper()
    const selectedNodes = new Mapper()

    // read selection state for edges ...
    graphMLIOHandler.addInputMapper(IEdge.$class, YBoolean.$class, 'SelectedEdges', selectedEdges)
    // ... and nodes.
    graphMLIOHandler.addInputMapper(INode.$class, YBoolean.$class, 'SelectedNodes', selectedNodes)

    // set selection state for edges and nodes once parsing is finished
    graphMLIOHandler.addParsedListener((_, evt) => {
      const selection = graphComponent.selection
      selection.clear()

      const graph = graphComponent.graph
      for (const node of graph.nodes) {
        if (selectedNodes.get(node)) {
          selection.setSelected(node, true)
        }
      }
      for (const edge of graph.edges) {
        if (selectedEdges.get(edge)) {
          selection.setSelected(edge, true)
        }
      }
    })
  }

  // ignore or replace some unknown bpmn styles to avoid exceptions
  graphMLIOHandler.addHandleDeserializationListener((_, evt) => {
    if (evt.xmlNode instanceof Element) {
      const element = evt.xmlNode
      if (
        element.localName === 'Label' &&
        element.hasAttribute('LayoutParameter') &&
        element.getAttribute('LayoutParameter').toString().includes('PoolHeaderLabelModel')
      ) {
        evt.result = null
      } else if (element.localName === 'PoolNodeStyle') {
        evt.result = new ShapeNodeStyle()
      } else if (element.localName === 'AnnotationLabelStyle') {
        evt.result = new DefaultLabelStyle()
      }
    }
  })

  return graphMLIOHandler
}