node-red-contrib-mobius-flow-base 2.5.90 → 3.0.0-beta.12

package/dist/nodes/common/mobsearch.js

@@ -0,0 +1,576 @@
+/**
+ *
+ * @param mobiusSrvc - Connection to Mobius
+ * @param {object} opts - Options object, field explained below
+
+  OPTS OBJECT (opts.)
+  ALL CASES
+    htmlElementId - The id of the HTML element that mobsearch will inject into
+  NON-LISTED ONLY
+    uriFieldName - The id of the URI HTML field, mobsearch will set the value of this field to be the result
+    inputRowId - The id of the main input, mobsearch will add the search button to this row
+  LISTED ONLY (Uses editable list)
+    list - Array containing current list items in object form
+    containerRowName - The id of the row containing the HTML container
+    containerName - The id of the HTML container
+    containerSecondFieldName - The id of the secondary field (Not URI field) within HTML container
+
+  EXAMPLE OPTS OBJECT - context of getMultiResource (node using editable list)
+  opts = {
+    htmlElementId: 'mobsearch',
+    list: node.resources,
+    containerRowName: 'node-input-resources-container-row',
+    containerName: 'node-input-resources-container',
+    containerSecondFieldName: 'node-input-resources-comment',
+  };
+  EXAMPLE OPTS OBJECT - context of getResource (standard node, not using editable list)
+  opts = {
+    htmlElementId: 'mobsearch',
+    uriFieldName: 'node-input-resource',
+    inputRowId: 'input-row',
+  };
+ * 
+ * 
+ * 
+ */
+
+initMobsearch = {
+  // Standard mobsearch to rid level
+  toRid: (mobiusSrvc, opts) => {
+    getMobsearch(mobiusSrvc, true, false, opts);
+  },
+  // Standard mobsearch to ins level
+  toIns: (mobiusSrvc, opts) => {
+    getMobsearch(mobiusSrvc, false, false, opts);
+  },
+  // Mobsearch to rid level, for nodes using editable list
+  toRid_listed: (mobiusSrvc, opts) => {
+    getMobsearch(mobiusSrvc, true, true, opts);
+  },
+  // Mobsearch to ins level, for nodes using editable list
+  toIns_listed: (mobiusSrvc, opts) => {
+    getMobsearch(mobiusSrvc, false, true, opts);
+  },
+};
+
+// Make / Reset global selectionIndex vairable (variable to allow setting of correct list field)
+if (typeof selectionIndex === undefined) {
+  let selectionIndex = 0;
+}
+
+/**
+ * function to add search button functionality to list rows
+ * @param {object} field - The search field within a given list row
+ * @param {number} rowIndex - The list row index
+ * @param {object} opts - Mobsearch options object
+ */
+function addMobsearchListButton(field, rowIndex, opts) {
+  field.click(function () {
+    selectionIndex = rowIndex;
+    $(`#${opts.containerRowName}`).hide();
+    $('#instance-search-sid').val('');
+    $('#instance-search-pid').val('');
+    $('#instance-search-ins').val('');
+    $('#instance-search-rid').val('');
+    $('#node-search-return').removeClass('disabled');
+    $('#node-search-accept').removeClass('disabled');
+    $('#instance-search-row').show();
+  });
+}
+
+/**
+ *
+ * @param mobiusSrvc - Connection to Mobius
+ * @param {boolean} useRid - Flag for Mobsearch to include rid field
+ * @param {boolean} listed - Flag for Mobsearch work with nodes using editableLists
+ * @param {object} opts - Mobsearhc options object
+ */
+function getMobsearch(mobiusSrvc, useRid, listed, opts) {
+  selectionIndex = 0;
+  // Get current state of input field
+  let uriFieldValue = '';
+  if (!listed) {
+    uriFieldValue = $(`#${opts.uriFieldName}`).val();
+  }
+
+  // * HTML INJECTION * //
+
+  const resourceHtml = `
+  <input type="text" id="instance-search-hid" style="width:13%;" placeholder="HID">
+  <input type="text" id="instance-search-sid" style="width:8%;" placeholder="SID">
+  <input type="text" id="instance-search-pid" style="width:10%;" placeholder="PID">
+  <input type="text" id="instance-search-ins" style="width:10%;" placeholder="INS">
+  <input type="text" id="instance-search-rid" style="width:8%;" placeholder="RID">
+  `;
+
+  const instanceHtml = `
+  <input type="text" id="instance-search-hid" style="width:15%;" placeholder="HID">
+  <input type="text" id="instance-search-sid" style="width:10%;" placeholder="SID">
+  <input type="text" id="instance-search-pid" style="width:10%;" placeholder="PID">
+  <input type="text" id="instance-search-ins" style="width:10%;" placeholder="INS">
+  `;
+
+  //set level dependent html
+  let rows = useRid === true ? resourceHtml : instanceHtml;
+  let alertMsg = useRid === true ? `and/or RID ` : ``;
+
+  //Inject new html
+  document.getElementById(opts.htmlElementId).innerHTML += `
+  <div id="instance-search-row">
+    <div class="form-row">
+      <label for="instance-search-sid"><i class="fa fa-tasks"></i> URI</label>
+      ${rows}
+      <a id="node-search-return" class="searchbutton" style="vertical-align: middle"><i id="node-search-return-icon" class="fa fa-arrow-left"></i></a>
+      <a id="node-search-accept" class="searchbutton" style="vertical-align: middle; color: #CCCCCC"><i id="node-search-accept-icon" class="fa fa-check"></i></a>
+    </div>
+  </div>
+  <div id="wildcard-alert-row" class="form-row hidden" style="color:#555555" align="center">
+  <p>Please note: The selection of wildcard '+'
+    means a search for a specific instance or resource
+    cannot be performed. As such, enter the 
+    INS ${alertMsg}manually.</p>
+  </div>
+  `;
+
+  if (!listed) {
+    //Add search button
+    document.getElementById(opts.inputRowId).innerHTML += `
+    <a id="node-lookup-instance" class="searchbutton" style="margin-left: 13px; vertical-align: middle"><i id="node-lookup-instance-icon" class="fa fa-search"></i></a>
+    `;
+  }
+
+  // * END HTML INJECTION * //
+
+  // * INIT SETUP * //
+
+  $('#instance-search-row').hide();
+  $('#wildcard-alert-row').hide();
+  $('#node-search-return').addClass('disabled');
+  $.getJSON(`mgethid?mobius=${mobiusSrvc}`, function (response) {
+    $('#instance-search-hid').val(response);
+  });
+  let readyToAccept = false;
+
+  let searchObject = {};
+  if (listed) {
+    searchObject = {
+      hid: '',
+      sid: '',
+      pid: '',
+      ins: '',
+      rid: '',
+      objects: [],
+    };
+  } else {
+    searchObject = {
+      hid: $('#instance-search-hid').val(),
+      sid: $('#instance-search-sid').val(),
+      pid: $('#instance-search-pid').val(),
+      ins: $('#instance-search-ins').val(),
+      rid: $('#instance-search-rid').val(),
+      objects: [],
+    };
+  }
+
+  // * END INIT SETUP * //
+
+  /**
+   * Search for INSs present on selected PID
+   * @param {object} objects - Response from call to Mobiu, list of mobius objects
+   * @param {string} pid - The chosen PID
+   */
+  function ridSearch(objects, ins) {
+    $.getJSON(
+      `mdiscover?mobius=${mobiusSrvc}&uri=${searchObject.hid}/${searchObject.sid}/${searchObject.pid}/${searchObject.ins}`,
+      (response) => {
+        resList = response.data[0].resources;
+        ress = ['#'];
+        for (let j = 0; j < resList.length; j++) {
+          ress.push(`${resList[j].rid} - ${resList[j].name}`);
+        }
+        $('#instance-search-rid')
+          .autocomplete({
+            source: ress,
+            minLength: 0,
+            close: function (event, ui) {
+              acceptCheck();
+              $('#instance-search-rid').autocomplete('destroy');
+              $('#instance-search-rid').val($('#instance-search-rid').val().substring(0, 2));
+              searchObject.rid = $('#instance-search-rid').val();
+            },
+          })
+          .autocomplete('search', '');
+      }
+    );
+  }
+
+  /**
+   * Search for INSs present on selected PID
+   * @param {object} objects - Response from call to Mobius, list of mobius objects
+   * @param {string} pid - The chosen PID
+   */
+  function insSearch(objects, pid) {
+    let inss = ['#', '+'];
+    for (let i = 0; i < objects.length; i++) {
+      if (objects[i].pid === pid) {
+        const name = objects[i].resources[1].pv;
+        if (name === '') {
+          inss.push(objects[i].ins);
+        } else {
+          inss.push(`${objects[i].ins} - ${name}`);
+        }
+      }
+    }
+    $('#instance-search-ins')
+      .autocomplete({
+        source: inss,
+        minLength: 0,
+        close: function (event, ui) {
+          acceptCheck();
+          $('#instance-search-ins').autocomplete('destroy');
+          if ($('#instance-search-ins').val().length > 4) {
+            $('#instance-search-ins').val($('#instance-search-ins').val().substring(0, 4));
+          }
+          searchObject.ins = $('#instance-search-ins').val();
+        },
+      })
+      .autocomplete('search', '');
+  }
+
+  /**
+   * Search for PIDs present on selected service
+   * @param {object} objects - Response from call to Mobius, list of mobius objects
+   */
+  function pidsSearch(objects) {
+    searchObject.objects = objects;
+    let pids = ['#', '+'];
+    for (let i = 0; i < objects.length; i++) {
+      pids.push(`${objects[i].pid} - ${objects[i].profileName}`);
+    }
+    pids = [...new Set(pids)];
+    $('#instance-search-pid')
+      .autocomplete({
+        source: pids,
+        minLength: 0,
+        close: function (event, ui) {
+          acceptCheck();
+          $('#instance-search-pid').autocomplete('destroy');
+          if ($('#instance-search-pid').val().length > 4) {
+            $('#instance-search-pid').val($('#instance-search-pid').val().substring(0, 4));
+          }
+          searchObject.pid = $('#instance-search-pid').val();
+        },
+      })
+      .autocomplete('search', '');
+  }
+
+  /**
+   * Search for SIDs, and then fetch child objects based on selection
+   * @param {object} response - Response from call to Mobius
+   */
+  function serviceSearch(response) {
+    let services = ['#', '+'];
+    for (let i = 0; i < response.length; i++) {
+      if (response[i].sid !== '009') {
+        services.push(`${response[i].sid} - ${response[i].name}`);
+      }
+    }
+    $('#instance-search-sid')
+      .autocomplete({
+        source: services,
+        minLength: 0,
+        close: function (event, ui) {
+          acceptCheck();
+          $('#instance-search-sid').autocomplete('destroy');
+          if ($('#instance-search-sid').val().length > 3) {
+            $('#instance-search-sid').val($('#instance-search-sid').val().substring(0, 3));
+          }
+          searchObject.sid = $('#instance-search-sid').val();
+          if (searchObject.sid === '+') {
+            for (let i = 2; i < services.length; i++) {
+              $.getJSON(
+                `mgetobjects?mobius=${mobiusSrvc}&hid=${searchObject.hid}&sid=${services[
+                  i
+                ].substring(0, 3)}`,
+                (objects) => {
+                  searchObject.objects = searchObject.objects.concat(objects);
+                }
+              );
+            }
+          } else {
+            $.getJSON(
+              `mgetobjects?mobius=${mobiusSrvc}&hid=${searchObject.hid}&sid=${searchObject.sid}`,
+              (objects) => {
+                searchObject.objects = objects;
+              }
+            );
+          }
+        },
+      })
+      .autocomplete('search', '');
+  }
+
+  /**
+   * Start mobsearch
+   */
+  function startSearch() {
+    $('#wildcard-alert-row').hide();
+    $('#instance-search-sid').val('');
+    $('#instance-search-pid').val('');
+    $('#instance-search-ins').val('');
+    searchObject.hid = $('#instance-search-hid').val();
+    searchObject.sid = '';
+    searchObject.pid = '';
+    searchObject.ins = '';
+    if (/((^([0-9A-F]){6}$)|^$)/.test(searchObject.hid)) {
+      $.getJSON(`mgetservices?mobius=${mobiusSrvc}&hid=${searchObject.hid}`, serviceSearch).fail(
+        (err) => {
+          console.log('Mobsearch failed to contact Mobius');
+        }
+      );
+    }
+  }
+
+  /**
+   * Finish mobsearch, compile full URI and set value in host node
+   */
+  function finishSearch() {
+    $('#wildcard-alert-row').hide();
+    let uri = `${searchObject.hid}/${searchObject.sid}/${searchObject.pid}/${searchObject.ins}`;
+    if (useRid) {
+      uri = uri + `/${searchObject.rid}`;
+    }
+    if (uri.includes('#')) {
+      uri = uri.substring(0, uri.indexOf('#') + 1);
+    }
+    if (listed) {
+      opts.list[selectionIndex].uri = uri;
+      updateList();
+    } else {
+      $(`#${opts.uriFieldName}`).val(uri);
+    }
+    $('#node-search-accept').css('color', '#CCCCCC');
+    readyToAccept = false;
+    $('#node-search-return').addClass('disabled');
+    $('#node-search-accept').addClass('disabled');
+    $('#node-lookup-instance').removeClass('disabled');
+    $('#instance-search-row').hide();
+    $('#instance-row').show();
+  }
+
+  /**
+   * Update if accept button is grade out and functional, based on conditions of fields
+   */
+  function acceptCheck() {
+    if (useRid) {
+      checkFieldsToRid();
+    } else {
+      checkFieldsToIns();
+    }
+    checkWildcards();
+  }
+
+  /**
+   * Check state of all field to rid level, change state of accept button accordingly
+   */
+  function checkFieldsToRid() {
+    if (
+      ($('#instance-search-hid').val() !== '' &&
+        $('#instance-search-sid').val() !== '' &&
+        $('#instance-search-pid').val() !== '' &&
+        $('#instance-search-ins').val() !== '' &&
+        $('#instance-search-rid').val() !== '') ||
+      $('#instance-search-sid').val() === '#' ||
+      $('#instance-search-pid').val() === '#' ||
+      $('#instance-search-ins').val() === '#' ||
+      $('#instance-search-rid').val() === '#'
+    ) {
+      $('#node-search-accept').css('color', '#555555');
+      readyToAccept = true;
+    } else {
+      $('#node-search-accept').css('color', '#CCCCCC');
+      readyToAccept = false;
+    }
+  }
+
+  /**
+   * Check state of all field to ins level, change state of accept button accordingly
+   */
+  function checkFieldsToIns() {
+    if (
+      ($('#instance-search-hid').val() !== '' &&
+        $('#instance-search-sid').val() !== '' &&
+        $('#instance-search-pid').val() !== '' &&
+        $('#instance-search-ins').val() !== '') ||
+      $('#instance-search-sid').val() === '#' ||
+      $('#instance-search-pid').val() === '#' ||
+      $('#instance-search-ins').val() === '#'
+    ) {
+      $('#node-search-accept').css('color', '#555555');
+      readyToAccept = true;
+    } else {
+      $('#node-search-accept').css('color', '#CCCCCC');
+      readyToAccept = false;
+    }
+  }
+
+  /**
+   * Checks if + wildcard values are present, shows / hides alert message accordingly
+   */
+  function checkWildcards() {
+    if (
+      $('#instance-search-sid').val() !== '+' &&
+      $('#instance-search-pid').val() !== '+' &&
+      $('#instance-search-ins').val() !== '+'
+    ) {
+      $('#wildcard-alert-row').hide();
+    } else {
+      $('#wildcard-alert-row').show();
+    }
+  }
+
+  /**
+   * Update editable list with results from mobsearch
+   */
+  function updateList() {
+    $(`#${opts.containerName}`)
+      .editableList('items')
+      .each(function (i) {
+        let item = $(this);
+        let secondField = item.find(`.${opts.containerSecondFieldName}`).val();
+        opts.list[i][Object.keys(opts.list[i])[1]] = secondField;
+      });
+    $(`#${opts.containerName}`).editableList('empty');
+    for (let i = 0; i < opts.list.length; i++) {
+      let item = opts.list[i];
+      $(`#${opts.containerName}`).editableList('addItem', item);
+    }
+    $(`#${opts.containerRowName}`).show();
+  }
+
+  // * CLICK RESPONSE * //
+
+  $('#node-lookup-instance').click(function () {
+    //When search button is clicked
+    $('#instance-search-sid').val('');
+    $('#instance-search-pid').val('');
+    $('#instance-search-ins').val('');
+    if (useRid) {
+      $('#instance-search-rid').val('');
+    }
+    $('#node-lookup-instance').addClass('disabled');
+    $('#node-search-return').removeClass('disabled');
+    $('#node-search-accept').removeClass('disabled');
+    $('#instance-row').hide();
+    $('#instance-search-row').show();
+  });
+
+  $('#instance-search-sid').click(function () {
+    //SID field clicked
+    $('#instance-search-pid').val('');
+    $('#instance-search-ins').val('');
+    searchObject.pid = '';
+    searchObject.ins = '';
+    if (useRid) {
+      searchObject.rid = '';
+    }
+    searchObject.objects = [];
+    startSearch();
+  });
+  $('#instance-search-pid').click(function () {
+    //PID field clicked
+    $('#instance-search-ins').val('');
+
+    searchObject.ins = '';
+
+    if (useRid) {
+      $('#instance-search-rid').val('');
+      searchObject.rid = '';
+    }
+    if (searchObject.sid !== '') {
+      pidsSearch(searchObject.objects);
+    }
+  });
+  $('#instance-search-ins').click(function () {
+    //INS field clicked
+    if (useRid) {
+      $('#instance-search-rid').val('');
+      searchObject.rid = '';
+    }
+    if (searchObject.pid !== '' && searchObject.pid !== '+' && searchObject.sid !== '+') {
+      insSearch(searchObject.objects, searchObject.pid);
+    }
+  });
+
+  if (useRid) {
+    $('#instance-search-rid').click(function () {
+      //RID clicked
+      if (
+        searchObject.ins !== '' &&
+        searchObject.ins !== '+' &&
+        searchObject.pid !== '+' &&
+        searchObject.sid !== '+'
+      ) {
+        ridSearch(searchObject.objects, searchObject.ins);
+      }
+    });
+  }
+
+  $('#node-search-return').click(function () {
+    //Return/Back button clicked
+    $('#node-search-return').addClass('disabled');
+    $('#node-search-accept').addClass('disabled');
+    $('#node-lookup-instance').removeClass('disabled');
+    $('#instance-search-row').hide();
+    $('#instance-row').show();
+  });
+  $('#node-search-accept').click(function () {
+    //Accept button clicked
+    if (readyToAccept) {
+      finishSearch();
+    }
+  });
+
+  // * END CLICK RESPONSE * //
+
+  // * CHANGE RESPONSE * //
+
+  $('#instance-search-hid').change(function () {
+    acceptCheck();
+    $('#instance-search-sid').val('');
+    $('#instance-search-pid').val('');
+    $('#instance-search-ins').val('');
+    if (useRid) {
+      $('#instance-search-rid').val('');
+    }
+  });
+
+  $('#instance-search-sid').change(function () {
+    searchObject.sid = $('#instance-search-sid').val();
+    acceptCheck();
+  });
+
+  $('#instance-search-pid').change(function () {
+    searchObject.pid = $('#instance-search-pid').val();
+    acceptCheck();
+  });
+
+  $('#instance-search-ins').change(function () {
+    searchObject.ins = $('#instance-search-ins').val();
+    acceptCheck();
+  });
+
+  if (useRid) {
+    $('#instance-search-rid').change(function () {
+      searchObject.rid = $('#instance-search-rid').val();
+      acceptCheck();
+    });
+  }
+
+  // * END CHANGE RESPONSE * //
+
+  // reset input filed after init
+  if (!listed) {
+    $(`#${opts.uriFieldName}`).val(uriFieldValue);
+  }
+}

package/dist/nodes/mobius-clear-resource.html

@@ -29,10 +29,16 @@ POSSIBILITY OF SUCH DAMAGE.
     <label for="node-input-connection"><i class="fa fa-globe"></i> MOBiUS</label>
     <input type="text" id="node-input-connection">
   </div>
-  <div class="form-row">
-    <label for="node-input-resource"><i class="fa fa-tasks"></i> URI</label>
-    <input type="text" id="node-input-resource" placeholder="Resource URI (hid/sid/pid/ins/rid)">
+  <hr>
+
+  <div id="instance-row">
+    <div class="form-row" id="input-row">
+      <label for="node-input-resource"><i class="fa fa-tasks"></i> URI</label>
+      <input type="text" id="node-input-resource" style="width:61%;" placeholder="Resource URI (hid/sid/pid/ins/rid)">
+    </div>
   </div>
+  <div id="mobsearch"></div>
+
   <div class="form-row">
     <label for="node-input-priority"><i class="fa fa-exclamation-triangle"></i> Priority</label>
     <input type="text" id="node-input-priority" placeholder="Priotity to clear">
@@ -49,6 +55,8 @@ POSSIBILITY OF SUCH DAMAGE.
   </div>
 </script>
 
+<script src="common/mobsearch.js"></script>
+
 <script type="text/javascript">
   RED.nodes.registerType('mobius clear resource',{
     category: 'mobius',
@@ -90,6 +98,17 @@ POSSIBILITY OF SUCH DAMAGE.
     labelStyle: function() {
       return this.name ? "node_label_italic":"";
     },
+    oneditprepare: function () {
+      var node = this;
+      let mobiusSrvc = $("#node-input-connection").val();
+
+      opts = {
+        htmlElementId: 'mobsearch',
+        uriFieldName: 'node-input-resource',
+        inputRowId: 'input-row',
+      };
+      initMobsearch.toRid(mobiusSrvc, opts);
+    },
     oneditsave: function() {
       if($("#node-input-detailedOutput").prop('checked')) {
         this.outputs = 4;

package/dist/nodes/mobius-clear-resource.js

@@ -28,7 +28,7 @@
 'use strict';
 
 module.exports = function (RED) {
-  function MobiusClearResourceNode (n) {
+  function MobiusClearResourceNode(n) {
     RED.nodes.createNode(this, n);
     this.detailedOutput = n.detailedOutput;
     this.resource = n.resource;
@@ -40,7 +40,7 @@ module.exports = function (RED) {
       node.status({
         fill: 'red',
         shape: 'ring',
-        text: 'Disconnected'
+        text: 'Disconnected',
       });
 
       node.on('input', function (msg) {
@@ -57,7 +57,7 @@ module.exports = function (RED) {
           node.status({
             fill: 'green',
             shape: 'ring',
-            text: 'Busy'
+            text: 'Busy',
           });
 
           node.serviceConn.clearResourcePriority(uri, pri, (err, response) => {
@@ -65,29 +65,34 @@ module.exports = function (RED) {
               node.status({
                 fill: 'yellow',
                 shape: 'dot',
-                text: 'Error: ' + JSON.stringify(err.code)
+                text: 'Error: ' + JSON.stringify(err.code),
               });
               node.error('Mobius error clearing resource priority ' + JSON.stringify(err));
               if (node.detailedOutput === true) {
-                node.send([null, null, null, {topic: uri, payload: { error: true, response: err }}]);
+                node.send([
+                  null,
+                  null,
+                  null,
+                  { topic: uri, payload: { error: true, response: err } },
+                ]);
               }
             } else {
               node.status({
                 fill: 'green',
                 shape: 'dot',
-                text: JSON.stringify(response.value.pv)
+                text: JSON.stringify(response.data.pv),
               });
               if (node.detailedOutput === true) {
                 node.send([
-                  { topic: uri, payload: response.value.pv },
-                  { topic: uri, payload: { pv: response.value.pv, name: response.value.name } },
-                  { topic: uri, payload: response.value },
-                  { topic: uri, payload: { error: false, response: response } }
+                  { topic: uri, payload: response.data.pv },
+                  { topic: uri, payload: { pv: response.data.pv, name: response.data.name } },
+                  { topic: uri, payload: response.data },
+                  { topic: uri, payload: { error: false, response: response } },
                 ]);
               } else {
                 node.send([
-                  { topic: uri, payload: response.value.pv },
-                  { topic: uri, payload: { pv: response.value.pv, name: response.value.name } }
+                  { topic: uri, payload: response.data.pv },
+                  { topic: uri, payload: { pv: response.data.pv, name: response.data.name } },
                 ]);
               }
             }