openc3 5.8.1 → 5.9.0

data/templates/tool_svelte/src/services/api.js

@@ -0,0 +1,92 @@
+/*
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+*/
+
+import axios from './axios.js'
+
+const request = async function (
+  method,
+  url,
+  { data, params = {}, headers, noAuth = false, noScope = false } = {}
+) {
+  if (!noAuth) {
+    try {
+      let refreshed = await OpenC3Auth.updateToken(
+        OpenC3Auth.defaultMinValidity
+      )
+      if (refreshed) {
+        OpenC3Auth.setTokens()
+      }
+    } catch (error) {
+      OpenC3Auth.login()
+    }
+    headers['Authorization'] = localStorage.openc3Token
+  }
+  if (!noScope && !params['scope']) {
+    params['scope'] = window.openc3Scope
+  }
+  return axios({
+    method,
+    url,
+    data,
+    params,
+    headers,
+  })
+}
+
+const acceptOnlyDefaultHeaders = {
+  Accept: 'application/json',
+}
+
+const fullDefaultHeaders = {
+  ...acceptOnlyDefaultHeaders,
+  'Content-Type': 'application/json',
+}
+
+export default {
+  get: function (
+    path,
+    { params, headers = acceptOnlyDefaultHeaders, noScope, noAuth } = {}
+  ) {
+    return request('get', path, { params, headers, noScope, noAuth })
+  },
+
+  put: function (
+    path,
+    { data, params, headers = fullDefaultHeaders, noScope, noAuth } = {}
+  ) {
+    return request('put', path, { data, params, headers, noScope, noAuth })
+  },
+
+  post: function (
+    path,
+    { data, params, headers = fullDefaultHeaders, noScope, noAuth } = {}
+  ) {
+    return request('post', path, { data, params, headers, noScope, noAuth })
+  },
+
+  delete: function (
+    path,
+    { params, headers = acceptOnlyDefaultHeaders, noScope, noAuth } = {}
+  ) {
+    return request('delete', path, { params, headers, noScope, noAuth })
+  },
+}

data/templates/tool_svelte/src/services/axios.js

@@ -0,0 +1,85 @@
+/*
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+*/
+
+import axios from 'axios'
+
+const axiosInstance = axios.create({
+  baseURL: location.origin,
+  timeout: 60000,
+  params: {},
+})
+
+axiosInstance.interceptors.response.use(
+  (response) => response,
+  (error) => {
+    if (error.response) {
+      if (error.response.status === 401) {
+        OpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity, true).then(
+          function (refreshed) {
+            if (refreshed) {
+              OpenC3Auth.setTokens()
+            }
+          }
+        )
+      }
+      // Individual tools can set 'Ignore-Errors' to an error code
+      // they potentially expect, e.g. '500', in which case we ignore it
+      // For example in CommandSender.vue:
+      // obs = this.api.cmd(targetName, commandName, paramList, {
+      //   'Ignore-Errors': '500',
+      // })
+      if (
+        error.response.headers['ignore-errors'] &&
+        error.response.headers['ignore-errors'].includes(
+          error.response.status.toString()
+        )
+      ) {
+        return Promise.reject(error)
+      }
+      let body = `HTTP ${error.response.status} - `
+      if (error.response?.statusText) {
+        body += `${error.response.statusText} `
+      }
+      if (error.response?.config?.data) {
+        body += `${error.response.config.data} `
+      }
+      if (error.response?.data?.message) {
+        body += `${error.response.data.message}`
+      } else if (error.response?.data?.exception) {
+        body += `${error.response.data.exception}`
+      } else if (error.response?.data?.error?.message) {
+        if (error.response.data.error.class) {
+          body += `${error.response.data.error.class} `
+        }
+        body += `${error.response.data.error.message}`
+      } else {
+        body += `${error.response?.data}`
+      }
+      alert(`Network error: ${body}`)
+      throw error
+    } else {
+      throw error
+    }
+  }
+)
+
+export default axiosInstance

data/templates/tool_svelte/src/services/cable.js

@@ -0,0 +1,65 @@
+/*
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+*/
+
+import * as ActionCable from '@rails/actioncable'
+//ActionCable.logger.enabled = true
+ActionCable.ConnectionMonitor.staleThreshold = 10
+
+export default class Cable {
+  constructor(url = '/openc3-api/cable') {
+    this._cable = null
+    this._url = url
+  }
+  disconnect() {
+    if (this._cable) {
+      this._cable.disconnect()
+    }
+  }
+  createSubscription(channel, scope, callbacks = {}, additionalOptions = {}) {
+    return OpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(
+      (refreshed) => {
+        if (refreshed) {
+          OpenC3Auth.setTokens()
+        }
+        if (this._cable == null) {
+          let final_url =
+            this._url +
+            '?scope=' +
+            window.openc3Scope +
+            '&authorization=' +
+            localStorage.openc3Token
+          this._cable = ActionCable.createConsumer(final_url)
+        }
+        return this._cable.subscriptions.create(
+          {
+            channel,
+            ...additionalOptions,
+          },
+          callbacks
+        )
+      }
+    )
+  }
+  recordPing() {
+    this._cable.connection.monitor.recordPing()
+  }
+}

data/templates/tool_svelte/src/services/config-parser.js

@@ -0,0 +1,199 @@
+/*
+# Copyright 2022 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+*/
+
+export class ConfigParserError {
+  constructor(config_parser, message, usage = '', url = '') {
+    this.keyword = config_parser.keyword
+    this.parameters = config_parser.parameters
+    this.filename = config_parser.filename
+    this.line = config_parser.line
+    this.lineNumber = config_parser.lineNumber
+    this.message = message
+    this.usage = usage
+    this.url = url
+  }
+}
+
+export class ConfigParserService {
+  keyword = null
+  parameters = []
+  filename = ''
+  line = ''
+  lineNumber = 0
+  url = 'https://openc3.com/docs/v5'
+
+  constructor() {}
+
+  verify_num_parameters(min_num_params, max_num_params, usage = '') {
+    // This syntax works with 0 because each doesn't return any values
+    // for a backwards range
+    for (let index = 1; index <= min_num_params; index++) {
+      // If the parameter is nil (0 based) then we have a problem
+      if (this.parameters[index - 1] === undefined) {
+        throw new ConfigParserError(
+          this,
+          `Not enough parameters for ${this.keyword}.`,
+          usage,
+          this.url
+        )
+      }
+    }
+    // If they pass null for max_params we don't check for a maximum number
+    if (max_num_params && !this.parameters[max_num_params] === undefined) {
+      throw new ConfigParserError(
+        this,
+        `Too many parameters for ${this.keyword}.`,
+        usage,
+        this.url
+      )
+    }
+  }
+
+  remove_quotes(string) {
+    if (string.length < 2) {
+      return string
+    }
+    let first_char = string.charAt(0)
+    if (first_char !== '"' && first_char !== "'") {
+      return string
+    }
+    let last_char = string.charAt(string.length - 1)
+    if (first_char !== last_char) {
+      return string
+    }
+    return string.substring(1, string.length - 1)
+  }
+
+  scan_string(string, rx) {
+    if (!rx.global) throw "rx must have 'global' flag set"
+    let r = []
+    string.replace(rx, function (match) {
+      r.push(match)
+      return match
+    })
+    return r
+  }
+
+  parse_string(
+    input_string,
+    original_filename,
+    yield_non_keyword_lines,
+    remove_quotes,
+    handler
+  ) {
+    let string_concat = false
+    this.line = ''
+    this.keyword = null
+    this.parameters = []
+    this.filename = original_filename
+
+    // Break string into lines
+    let lines = input_string.split('\n')
+    let numLines = lines.length
+
+    for (let i = 0; i < numLines; i++) {
+      this.lineNumber = i + 1
+      let line = lines[i].trim()
+      // Ensure the line length is not 0
+      if (line.length === 0) {
+        continue
+      }
+
+      if (string_concat === true) {
+        // Skip comment lines after a string concatenation
+        if (line[0] === '#') {
+          continue
+        }
+        // Remove the opening quote if we're continuing the line
+        line = line.substring(1, line.length)
+      }
+
+      // Check for string continuation
+      let last_char = line.charAt(line.length - 1)
+      let newline = false
+      switch (last_char) {
+        case '+': // String concatenation with newlines
+          newline = true
+        // Deliberate fall through
+        case '\\': // String concatenation
+          // Trim off the concat character plus any spaces, e.g. "line" \
+          let trim = line.substring(0, line.length - 1).trim()
+          // Now trim off the last quote so it will flow into the next line
+          this.line += trim.substring(0, trim.length - 1)
+          if (newline) {
+            this.line += '\n'
+          }
+          string_concat = true
+          continue
+        case '&': // Line continuation
+          this.line += line.substring(0, line.length - 1)
+          continue
+        default:
+          this.line += line
+      }
+      string_concat = false
+
+      let rx = /("([^\\"]|\\.)*")|('([^\\']|\\.)*')|\S+/g
+      let data = this.scan_string(this.line, rx)
+      let first_item = ''
+      if (data.length > 0) {
+        first_item = first_item + data[0]
+      }
+
+      if (first_item.length === 0 || first_item.charAt(0) === '#') {
+        this.keyword = null
+      } else {
+        this.keyword = first_item.toUpperCase()
+      }
+      this.parameters = []
+
+      // Ignore lines without keywords: comments and blank lines
+      if (this.keyword === null) {
+        if (yield_non_keyword_lines) {
+          handler(this.keyword, this.parameters, this.line, this.lineNumber)
+        }
+        this.line = ''
+        continue
+      }
+
+      let length = data.length
+      if (length > 1) {
+        for (let index = 1; index < length; index++) {
+          let string = data[index]
+
+          // Don't process trailing comments such as:
+          // KEYWORD PARAM #This is a comment
+          if (string.length > 0 && string.charAt(0) === '#') {
+            break
+          }
+          if (remove_quotes) {
+            this.parameters.push(this.remove_quotes(string))
+          } else {
+            this.parameters.push(string)
+          }
+        }
+      }
+      handler(this.keyword, this.parameters, this.line, this.lineNumber)
+      this.line = ''
+    } // for all the lines
+  } // parse_string
+} // class ConfigParserService