analytics/webcontent/bi/js/admin/globalparameters/helpers/SoapHelper.js

"use strict";

/**
 * Licensed Materials - Property of IBM
 * IBM Cognos Products: Cognos Analytics
 * Copyright IBM Corp. 2015, 2019
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */
define(['underscore'], function (_) {
  var xmlKnownEntities = '<!ENTITY nbsp   "&#160;">\r\n' + '<!ENTITY iexcl  "&#161;">\r\n' + '<!ENTITY cent   "&#162;">\r\n' + '<!ENTITY pound  "&#163;">\r\n' + '<!ENTITY curren "&#164;">\r\n' + '<!ENTITY yen    "&#165;">\r\n' + '<!ENTITY brvbar "&#166;">\r\n' + '<!ENTITY sect   "&#167;">\r\n' + '<!ENTITY uml    "&#168;">\r\n' + '<!ENTITY copy   "&#169;">\r\n' + '<!ENTITY ordf   "&#170;">\r\n' + '<!ENTITY laquo  "&#171;">\r\n' + '<!ENTITY not    "&#172;">\r\n' + '<!ENTITY shy    "&#173;">\r\n' + '<!ENTITY reg    "&#174;">\r\n' + '<!ENTITY macr   "&#175;">\r\n' + '<!ENTITY deg    "&#176;">\r\n' + '<!ENTITY plusmn "&#177;">\r\n' + '<!ENTITY sup2   "&#178;">\r\n' + '<!ENTITY sup3   "&#179;">\r\n' + '<!ENTITY acute  "&#180;">\r\n' + '<!ENTITY micro  "&#181;">\r\n' + '<!ENTITY para   "&#182;">\r\n' + '<!ENTITY middot "&#183;">\r\n' + '<!ENTITY cedil  "&#184;">\r\n' + '<!ENTITY sup1   "&#185;">\r\n' + '<!ENTITY ordm   "&#186;">\r\n' + '<!ENTITY raquo  "&#187;">\r\n' + '<!ENTITY frac14 "&#188;">\r\n' + '<!ENTITY frac12 "&#189;">\r\n' + '<!ENTITY frac34 "&#190;">\r\n' + '<!ENTITY iquest "&#191;">\r\n' + '<!ENTITY Agrave "&#192;">\r\n' + '<!ENTITY Aacute "&#193;">\r\n' + '<!ENTITY Acirc  "&#194;">\r\n' + '<!ENTITY Atilde "&#195;">\r\n' + '<!ENTITY Auml   "&#196;">\r\n' + '<!ENTITY Aring  "&#197;">\r\n' + '<!ENTITY AElig  "&#198;">\r\n' + '<!ENTITY Ccedil "&#199;">\r\n' + '<!ENTITY Egrave "&#200;">\r\n' + '<!ENTITY Eacute "&#201;">\r\n' + '<!ENTITY Ecirc  "&#202;">\r\n' + '<!ENTITY Euml   "&#203;">\r\n' + '<!ENTITY Igrave "&#204;">\r\n' + '<!ENTITY Iacute "&#205;">\r\n' + '<!ENTITY Icirc  "&#206;">\r\n' + '<!ENTITY Iuml   "&#207;">\r\n' + '<!ENTITY ETH    "&#208;">\r\n' + '<!ENTITY Ntilde "&#209;">\r\n' + '<!ENTITY Ograve "&#210;">\r\n' + '<!ENTITY Oacute "&#211;">\r\n' + '<!ENTITY Ocirc  "&#212;">\r\n' + '<!ENTITY Otilde "&#213;">\r\n' + '<!ENTITY Ouml   "&#214;">\r\n' + '<!ENTITY times  "&#215;">\r\n' + '<!ENTITY Oslash "&#216;">\r\n' + '<!ENTITY Ugrave "&#217;">\r\n' + '<!ENTITY Uacute "&#218;">\r\n' + '<!ENTITY Ucirc  "&#219;">\r\n' + '<!ENTITY Uuml   "&#220;">\r\n' + '<!ENTITY Yacute "&#221;">\r\n' + '<!ENTITY THORN  "&#222;">\r\n' + '<!ENTITY szlig  "&#223;">\r\n' + '<!ENTITY agrave "&#224;">\r\n' + '<!ENTITY aacute "&#225;">\r\n' + '<!ENTITY acirc  "&#226;">\r\n' + '<!ENTITY atilde "&#227;">\r\n' + '<!ENTITY auml   "&#228;">\r\n' + '<!ENTITY aring  "&#229;">\r\n' + '<!ENTITY aelig  "&#230;">\r\n' + '<!ENTITY ccedil "&#231;">\r\n' + '<!ENTITY egrave "&#232;">\r\n' + '<!ENTITY eacute "&#233;">\r\n' + '<!ENTITY ecirc  "&#234;">\r\n' + '<!ENTITY euml   "&#235;">\r\n' + '<!ENTITY igrave "&#236;">\r\n' + '<!ENTITY iacute "&#237;">\r\n' + '<!ENTITY icirc  "&#238;">\r\n' + '<!ENTITY iuml   "&#239;">\r\n' + '<!ENTITY eth    "&#240;">\r\n' + '<!ENTITY ntilde "&#241;">\r\n' + '<!ENTITY ograve "&#242;">\r\n' + '<!ENTITY oacute "&#243;">\r\n' + '<!ENTITY ocirc  "&#244;">\r\n' + '<!ENTITY otilde "&#245;">\r\n' + '<!ENTITY ouml   "&#246;">\r\n' + '<!ENTITY divide "&#247;">\r\n' + '<!ENTITY oslash "&#248;">\r\n' + '<!ENTITY ugrave "&#249;">\r\n' + '<!ENTITY uacute "&#250;">\r\n' + '<!ENTITY ucirc  "&#251;">\r\n' + '<!ENTITY uuml   "&#252;">\r\n' + '<!ENTITY yacute "&#253;">\r\n' + '<!ENTITY thorn  "&#254;">\r\n' + '<!ENTITY yuml   "&#255;">\r\n' + // HTMLsymbol.ent
  '<!ENTITY fnof     "&#402;">\r\n' + '<!ENTITY Alpha    "&#913;">\r\n' + '<!ENTITY Beta     "&#914;">\r\n' + '<!ENTITY Gamma    "&#915;">\r\n' + '<!ENTITY Delta    "&#916;">\r\n' + '<!ENTITY Epsilon  "&#917;">\r\n' + '<!ENTITY Zeta     "&#918;">\r\n' + '<!ENTITY Eta      "&#919;">\r\n' + '<!ENTITY Theta    "&#920;">\r\n' + '<!ENTITY Iota     "&#921;">\r\n' + '<!ENTITY Kappa    "&#922;">\r\n' + '<!ENTITY Lambda   "&#923;">\r\n' + '<!ENTITY Mu       "&#924;">\r\n' + '<!ENTITY Nu       "&#925;">\r\n' + '<!ENTITY Xi       "&#926;">\r\n' + '<!ENTITY Omicron  "&#927;">\r\n' + '<!ENTITY Pi       "&#928;">\r\n' + '<!ENTITY Rho      "&#929;">\r\n' + '<!ENTITY Sigma    "&#931;">\r\n' + '<!ENTITY Tau      "&#932;">\r\n' + '<!ENTITY Upsilon  "&#933;">\r\n' + '<!ENTITY Phi      "&#934;">\r\n' + '<!ENTITY Chi      "&#935;">\r\n' + '<!ENTITY Psi      "&#936;">\r\n' + '<!ENTITY Omega    "&#937;">\r\n' + '<!ENTITY alpha    "&#945;">\r\n' + '<!ENTITY beta     "&#946;">\r\n' + '<!ENTITY gamma    "&#947;">\r\n' + '<!ENTITY delta    "&#948;">\r\n' + '<!ENTITY epsilon  "&#949;">\r\n' + '<!ENTITY zeta     "&#950;">\r\n' + '<!ENTITY eta      "&#951;">\r\n' + '<!ENTITY theta    "&#952;">\r\n' + '<!ENTITY iota     "&#953;">\r\n' + '<!ENTITY kappa    "&#954;">\r\n' + '<!ENTITY lambda   "&#955;">\r\n' + '<!ENTITY mu       "&#956;">\r\n' + '<!ENTITY nu       "&#957;">\r\n' + '<!ENTITY xi       "&#958;">\r\n' + '<!ENTITY omicron  "&#959;">\r\n' + '<!ENTITY pi       "&#960;">\r\n' + '<!ENTITY rho      "&#961;">\r\n' + '<!ENTITY sigmaf   "&#962;">\r\n' + '<!ENTITY sigma    "&#963;">\r\n' + '<!ENTITY tau      "&#964;">\r\n' + '<!ENTITY upsilon  "&#965;">\r\n' + '<!ENTITY phi      "&#966;">\r\n' + '<!ENTITY chi      "&#967;">\r\n' + '<!ENTITY psi      "&#968;">\r\n' + '<!ENTITY omega    "&#969;">\r\n' + '<!ENTITY thetasym "&#977;">\r\n' + '<!ENTITY upsih    "&#978;">\r\n' + '<!ENTITY piv      "&#982;">\r\n' + '<!ENTITY bull     "&#8226;">\r\n' + '<!ENTITY hellip   "&#8230;">\r\n' + '<!ENTITY prime    "&#8242;">\r\n' + '<!ENTITY Prime    "&#8243;">\r\n' + '<!ENTITY oline    "&#8254;">\r\n' + '<!ENTITY frasl    "&#8260;">\r\n' + '<!ENTITY weierp   "&#8472;">\r\n' + '<!ENTITY image    "&#8465;">\r\n' + '<!ENTITY real     "&#8476;">\r\n' + '<!ENTITY trade    "&#8482;">\r\n' + '<!ENTITY alefsym  "&#8501;">\r\n' + '<!ENTITY larr     "&#8592;">\r\n' + '<!ENTITY uarr     "&#8593;">\r\n' + '<!ENTITY rarr     "&#8594;">\r\n' + '<!ENTITY darr     "&#8595;">\r\n' + '<!ENTITY harr     "&#8596;">\r\n' + '<!ENTITY crarr    "&#8629;">\r\n' + '<!ENTITY lArr     "&#8656;">\r\n' + '<!ENTITY uArr     "&#8657;">\r\n' + '<!ENTITY rArr     "&#8658;">\r\n' + '<!ENTITY dArr     "&#8659;">\r\n' + '<!ENTITY hArr     "&#8660;">\r\n' + '<!ENTITY forall   "&#8704;">\r\n' + '<!ENTITY part     "&#8706;">\r\n' + '<!ENTITY exist    "&#8707;">\r\n' + '<!ENTITY empty    "&#8709;">\r\n' + '<!ENTITY nabla    "&#8711;">\r\n' + '<!ENTITY isin     "&#8712;">\r\n' + '<!ENTITY notin    "&#8713;">\r\n' + '<!ENTITY ni       "&#8715;">\r\n' + '<!ENTITY prod     "&#8719;">\r\n' + '<!ENTITY sum      "&#8721;">\r\n' + '<!ENTITY minus    "&#8722;">\r\n' + '<!ENTITY lowast   "&#8727;">\r\n' + '<!ENTITY radic    "&#8730;">\r\n' + '<!ENTITY prop     "&#8733;">\r\n' + '<!ENTITY infin    "&#8734;">\r\n' + '<!ENTITY ang      "&#8736;">\r\n' + '<!ENTITY and      "&#8743;">\r\n' + '<!ENTITY or       "&#8744;">\r\n' + '<!ENTITY cap      "&#8745;">\r\n' + '<!ENTITY cup      "&#8746;">\r\n' + '<!ENTITY int      "&#8747;">\r\n' + '<!ENTITY there4   "&#8756;">\r\n' + '<!ENTITY sim      "&#8764;">\r\n' + '<!ENTITY cong     "&#8773;">\r\n' + '<!ENTITY asymp    "&#8776;">\r\n' + '<!ENTITY ne       "&#8800;">\r\n' + '<!ENTITY equiv    "&#8801;">\r\n' + '<!ENTITY le       "&#8804;">\r\n' + '<!ENTITY ge       "&#8805;">\r\n' + '<!ENTITY sub      "&#8834;">\r\n' + '<!ENTITY sup      "&#8835;">\r\n' + '<!ENTITY nsub     "&#8836;">\r\n' + '<!ENTITY sube     "&#8838;">\r\n' + '<!ENTITY supe     "&#8839;">\r\n' + '<!ENTITY oplus    "&#8853;">\r\n' + '<!ENTITY otimes   "&#8855;">\r\n' + '<!ENTITY perp     "&#8869;">\r\n' + '<!ENTITY sdot     "&#8901;">\r\n' + '<!ENTITY lceil    "&#8968;">\r\n' + '<!ENTITY rceil    "&#8969;">\r\n' + '<!ENTITY lfloor   "&#8970;">\r\n' + '<!ENTITY rfloor   "&#8971;">\r\n' + '<!ENTITY lang     "&#9001;">\r\n' + '<!ENTITY rang     "&#9002;">\r\n' + '<!ENTITY loz      "&#9674;">\r\n' + '<!ENTITY spades   "&#9824;">\r\n' + '<!ENTITY clubs    "&#9827;">\r\n' + '<!ENTITY hearts   "&#9829;">\r\n' + '<!ENTITY diams    "&#9830;">\r\n' + // HTMLspecial.ent
  '<!ENTITY OElig   "&#338;">\r\n' + '<!ENTITY oelig   "&#339;">\r\n' + '<!ENTITY Scaron  "&#352;">\r\n' + '<!ENTITY scaron  "&#353;">\r\n' + '<!ENTITY Yuml    "&#376;">\r\n' + '<!ENTITY circ    "&#710;">\r\n' + '<!ENTITY tilde   "&#732;">\r\n' + '<!ENTITY ensp    "&#8194;">\r\n' + '<!ENTITY emsp    "&#8195;">\r\n' + '<!ENTITY thinsp  "&#8201;">\r\n' + '<!ENTITY zwnj    "&#8204;">\r\n' + '<!ENTITY zwj     "&#8205;">\r\n' + '<!ENTITY lrm     "&#8206;">\r\n' + '<!ENTITY rlm     "&#8207;">\r\n' + '<!ENTITY ndash   "&#8211;">\r\n' + '<!ENTITY mdash   "&#8212;">\r\n' + '<!ENTITY lsquo   "&#8216;">\r\n' + '<!ENTITY rsquo   "&#8217;">\r\n' + '<!ENTITY sbquo   "&#8218;">\r\n' + '<!ENTITY ldquo   "&#8220;">\r\n' + '<!ENTITY rdquo   "&#8221;">\r\n' + '<!ENTITY bdquo   "&#8222;">\r\n' + '<!ENTITY dagger  "&#8224;">\r\n' + '<!ENTITY Dagger  "&#8225;">\r\n' + '<!ENTITY permil  "&#8240;">\r\n' + '<!ENTITY lsaquo  "&#8249;">\r\n' + '<!ENTITY rsaquo  "&#8250;">\r\n' + '<!ENTITY euro    "&#8364;">\r\n';
  return {
    _createDTD: function _createDTD() {
      return "<!DOCTYPE " + 'Document' + " [\r\n" + xmlKnownEntities + "\r\n]>\r\n";
    },
    processResponse: function processResponse(report, response) {
      var parameters = [];
      var $status = $(response).selectNode('Envelope').selectNode('Body').find('> *').selectNode('result').selectNode('details').selectNode('item').byAttributeValue('xsi:type', 'bus:asynchDetailReportStatus').selectNode('status');

      if ($status.text() === '') {
        $status = $(response).selectNode('Envelope').selectNode('Body').find('> *').selectNode('result').selectNode('status');
      }

      if ($status.text() !== 'prompting') {
        var $responseNode = $(response).selectNode('Envelope').selectNode('Body').find('> *');
        parameters = this._extractParametersFromResponse(report, $responseNode);
      } else {
        parameters.push({
          name: 'credential:',
          'report_id': report.id,
          'type': 'credential'
        });
      }

      var $outputPage = $(response).selectNode('Envelope').selectNode('Body').find('> *').find('> *').selectNode('details').selectNode('item').byAttributeValue('xsi:type', 'bus:asynchDetailReportOutput').selectNode('outputPages').selectNode('item');
      var promptControlOutput;
      var promptControls = [];
      var xmlText = $outputPage.text();

      if (xmlText !== '') {
        xmlText = this._createDTD() + xmlText;
        promptControlOutput = $.parseXML(xmlText);
        var promptControlNodes = $(promptControlOutput).find('*[parameter]');

        _.each(promptControlNodes, function (promptControlNode) {
          promptControls.push($(promptControlNode).attr('parameter'));
        });
      } else {
        promptControlOutput = null;
      }

      return {
        parameters: parameters,
        promptControls: promptControls,
        status: $status.text(),
        type: 'xml',
        report: report.defaultName,
        report_id: report.id,
        $conversation: $(response).selectNode('Envelope').selectNode('Body').find('> *').selectNode('result').selectNode('primaryRequest'),
        $tracking: $(response).selectNode('Envelope').selectNode('Header').selectNode('biBusHeader').selectNode('tracking').selectNode('conversationContext'),
        xml: promptControlOutput
      };
    },
    _extractParametersFromResponse: function _extractParametersFromResponse(report, $responseNode) {
      var parameters = [];
      var $parameterNodes = $responseNode.selectNode('result').selectNode('details').selectNode('item').byAttributeValue('xsi:type', 'bus:asynchDetailParameters').selectNode('parameters').selectNode('item').byAttributeValue('xsi:type', 'bus:parameter');

      for (var i = 0; i < $parameterNodes.length; ++i) {
        var parameter = $parameterNodes[i];
        var $parameterType = $(parameter).selectNode('type'); //interval prompts not currently supported

        if ($parameterType.text() === 'xsdDuration') {
          continue;
        }

        var multiSelect = false;
        var type = 'simpleParmValue';
        var capabilities = $(parameter).selectNode('capabilities');
        var items = $(capabilities).selectNode('item');

        _.each(items, function (item) {
          //NOSONAR
          var capability = $(item).text();

          switch (capability) {
            case 'multivalued':
              {
                multiSelect = true;
                break;
              }

            case 'boundRange':
              {
                type = 'boundRange';
                break;
              }

            default:
              {
                break;
              }
          }
        });

        var name = $(parameter).selectNode('name').text();
        var newParameter = {
          'name': name,
          'description': '',
          'multilingualDisplay': {},
          'source': 'report',
          'report': report.defaultName,
          'report_id': report.id,
          'report_path': report.searchPath,
          'type': type,
          'multiSelect': multiSelect,
          'disabled': false,
          'accessibleAtSystemOrTenantLevel': false
        };

        var existingParameter = _.find(parameters, function (paramNameValue) {
          return paramNameValue.name === newParameter.name;
        }); //NOSONAR


        if (!existingParameter) {
          parameters.push(newParameter);
        }
      }

      return parameters;
    },
    xml_encode: function xml_encode(input) {
      var output = "" + input;

      if (output === '0' || input !== null && input !== false) {
        //&amp;
        output = output.replace(/&/g, "&amp;"); //&lt;

        output = output.replace(/</g, "&lt;"); //&gt;

        output = output.replace(/>/g, "&gt;"); //&quot;

        output = output.replace(/"/g, "&quot;"); //&apos;

        output = output.replace(/'/g, "&apos;");
      }

      return output;
    }
  };
});