All files / src/models/inspect xml-inspection.model.ts

78.95% Statements 75/95
65.22% Branches 45/69
77.78% Functions 7/9
77.03% Lines 57/74

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170                              9x         9x 9x 9x 9x                 9x   9x 5x   9x                               9x 5x       5x 5x               9x                         9x 5x 5x   5x 3x     5x 3x 3x 3x 3x 3x 3x 3x       6x 6x 5x 5x         9x 3x     3x           9x       75x 75x       75x 7x 7x     75x 75x 61x   14x   14x   14x               14x 70x 70x       9x   9x 5x 5x 9x   9x 5x             9x  
/*
    Copyright (C) 2017 Red Hat, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
            http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
import {
  DocumentInspectionModel,
  DocumentInspectionRequestModel,
  DocumentInspectionRequestOptions,
} from './document-inspection.model';
import { EnumValue, Field } from '../field.model';
import { ErrorInfo, ErrorLevel, ErrorScope, ErrorType } from '../error.model';
import { FieldType, IField } from '../../contracts/common';
import {
  IXmlComplexType,
  IXmlDocument,
  IXmlDocumentContainer,
  IXmlField,
  IXmlInspectionResponse,
  IXmlInspectionResponseContainer,
  XML_INSPECTION_REQUEST_JSON_TYPE,
} from '../../contracts/documents/xml';
import { NamespaceModel } from '../document-definition.model';
 
export class XmlInspectionModel extends DocumentInspectionModel {
  request = new XmlInspectionRequestModel(this.cfg, this.doc);
 
  isOnlineInspectionCapable(): boolean {
    if (this.cfg.initCfg.baseXMLInspectionServiceUrl == null) {
      this.cfg.errorService.addError(
        new ErrorInfo({
          message: `XML inspection service is not configured. Document will not be loaded: ${this.doc.name}`,
          level: ErrorLevel.WARN,
          scope: ErrorScope.APPLICATION,
          type: ErrorType.INTERNAL,
          object: this.doc,
        })
      );
      return false;
    }
    return true;
  }
 
  parseResponse(responseJson: any): void {
    Iif (typeof responseJson.XmlInspectionResponse !== 'undefined') {
      this.extractXMLDocumentDefinitionFromInspectionResponse(
        (responseJson as IXmlInspectionResponseContainer).XmlInspectionResponse
      );
    } else Eif (typeof responseJson.XmlDocument !== 'undefined') {
      this.extractXMLDocumentDefinition(
        (responseJson as IXmlDocumentContainer).XmlDocument
      );
    } else {
      throw new Error(`Unknown XML inspection result format: ${responseJson}`);
    }
  }
 
  private extractXMLDocumentDefinitionFromInspectionResponse(
    body: IXmlInspectionResponse
  ): void {
    if (body.errorMessage) {
      this.doc.errorOccurred = true;
      throw new Error(
        `Could not load XML document, error: ${body.errorMessage}`
      );
    }
 
    this.extractXMLDocumentDefinition(body.xmlDocument);
  }
 
  private extractXMLDocumentDefinition(xmlDocument: IXmlDocument): void {
    Eif (!this.doc.description) {
      this.doc.description = this.doc.id;
    }
    if (!this.doc.name) {
      this.doc.name = this.doc.id;
    }
 
    if (xmlDocument?.xmlNamespaces?.xmlNamespace?.length) {
      for (const serviceNS of xmlDocument.xmlNamespaces.xmlNamespace) {
        const ns: NamespaceModel = new NamespaceModel();
        ns.alias = serviceNS.alias;
        ns.uri = serviceNS.uri;
        ns.locationUri = serviceNS.locationUri;
        ns.isTarget = serviceNS.targetNamespace;
        this.doc.namespaces.push(ns);
      }
    }
 
    for (const field of xmlDocument.fields.field) {
      if (!this.doc.selectedRoot || this.isSelectedRootElement(field)) {
        this.parseXMLFieldFromDocument(field, null);
        break;
      }
    }
  }
 
  private isSelectedRootElement(field: IField): boolean {
    Iif (!this.doc.selectedRoot && !field?.name) {
      return false;
    }
    return (
      this.doc.selectedRoot ===
      (field.name!.indexOf(':') !== -1 ? field.name!.split(':')[1] : field.name)
    );
  }
 
  private parseXMLFieldFromDocument(
    field: IXmlField,
    parentField: Field | null
  ): void {
    const parsedField = this.parseFieldFromDocument(field, parentField);
    Iif (parsedField == null) {
      return;
    }
 
    if (field.name!.indexOf(':') !== -1) {
      parsedField.namespaceAlias = field.name!.split(':')[0];
      parsedField.name = field.name!.split(':')[1];
    }
 
    parsedField.isAttribute = parsedField.path.indexOf('@') !== -1;
    if (field.fieldType !== FieldType.COMPLEX) {
      return;
    }
    const complex = field as IXmlComplexType;
 
    parsedField.enumeration = complex.enumeration;
 
    Iif (parsedField.enumeration && complex.xmlEnumFields?.xmlEnumField) {
      for (const enumValue of complex.xmlEnumFields.xmlEnumField) {
        const parsedEnumValue: EnumValue = new EnumValue();
        parsedEnumValue.name = enumValue.name!;
        parsedEnumValue.ordinal = enumValue.ordinal;
        parsedField.enumValues.push(parsedEnumValue);
      }
    }
    Eif (complex.xmlFields?.xmlField.length) {
      for (const childField of complex.xmlFields.xmlField) {
        this.parseXMLFieldFromDocument(childField, parsedField);
      }
    }
  }
}
 
export class XmlInspectionRequestModel extends DocumentInspectionRequestModel {
  url = this.cfg.initCfg.baseXMLInspectionServiceUrl + 'inspect';
  options = new XmlInspectionRequestOptions(this.cfg, this.doc);
}
 
export class XmlInspectionRequestOptions extends DocumentInspectionRequestOptions {
  json = {
    XmlInspectionRequest: {
      jsonType: XML_INSPECTION_REQUEST_JSON_TYPE,
      type: this.doc.inspectionType,
      xmlData: this.doc.inspectionSource,
    },
  };
}