openc3 5.0.9 → 5.0.11

data/lib/openc3/accessors/cbor_accessor.rb

@@ -0,0 +1,83 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+require 'cbor'
+require 'openc3/accessors/json_accessor'
+
+module OpenC3
+  class CborAccessor < JsonAccessor
+    def self.read_item(item, buffer)
+      return nil if item.data_type == :DERIVED
+      if String === buffer
+        parsed = CBOR.decode(buffer)
+      else
+        parsed = buffer
+      end
+      return super(item, parsed)
+    end
+
+    def self.write_item(item, value, buffer)
+      return nil if item.data_type == :DERIVED
+
+      # Convert to ruby objects
+      if String === buffer
+        decoded = CBOR.decode(buffer)
+      else
+        decoded = buffer
+      end
+
+      # Write the value
+      write_item_internal(item, value, decoded)
+
+      # Update buffer
+      if String === buffer
+        buffer.replace(decoded.to_cbor)
+      end
+
+      return buffer
+    end
+
+    def self.read_items(items, buffer)
+      # Prevent JsonPath from decoding every call
+      if String === buffer
+        decoded = CBOR.decode(buffer)
+      else
+        decoded = buffer
+      end
+      super(items, decoded)
+    end
+
+    def self.write_items(items, values, buffer)
+      # Convert to ruby objects
+      if String === buffer
+        decoded = CBOR.decode(buffer)
+      else
+        decoded = buffer
+      end
+
+      items.each_with_index do |item, index|
+        write_item_internal(item, values[index], decoded)
+      end
+
+      # Update buffer
+      if String === buffer
+        buffer.replace(decoded.to_cbor)
+      end
+
+      return buffer
+    end
+
+  end
+end

data/lib/openc3/accessors/html_accessor.rb

@@ -0,0 +1,28 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+require 'openc3/accessors/xml_accessor'
+
+module OpenC3
+  class HtmlAccessor < XmlAccessor
+    def self.buffer_to_doc(buffer)
+      Nokogiri.HTML(buffer)
+    end
+
+    def self.doc_to_buffer(doc)
+      doc.to_html
+    end
+  end
+end

data/lib/openc3/accessors/json_accessor.rb

@@ -0,0 +1,131 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+require 'json'
+require 'jsonpath'
+require 'openc3/accessors/accessor'
+
+module OpenC3
+  class JsonAccessor < Accessor
+    def self.read_item(item, buffer)
+      return nil if item.data_type == :DERIVED
+      return JsonPath.on(buffer, item.key).first
+    end
+
+    def self.write_item(item, value, buffer)
+      return nil if item.data_type == :DERIVED
+
+      # Convert to ruby objects
+      if String === buffer
+        decoded = JSON.parse(buffer, :allow_nan => true)
+      else
+        decoded = buffer
+      end
+
+      # Write the value
+      write_item_internal(item, value, decoded)
+
+      # Update buffer
+      if String === buffer
+        buffer.replace(JSON.generate(decoded, :allow_nan => true))
+      end
+
+      return buffer
+    end
+
+    def self.read_items(items, buffer)
+      # Prevent JsonPath from decoding every call
+      if String === buffer
+        decoded = JSON.parse(buffer)
+      else
+        decoded = buffer
+      end
+      super(items, decoded)
+    end
+
+    def self.write_items(items, values, buffer)
+      # Start with an empty object if no buffer
+      buffer.replace("{}") if buffer.length == 0 or buffer[0] == "\x00"
+
+      # Convert to ruby objects
+      if String === buffer
+        decoded = JSON.parse(buffer, :allow_nan => true)
+      else
+        decoded = buffer
+      end
+
+      items.each_with_index do |item, index|
+        write_item_internal(item, values[index], decoded)
+      end
+
+      # Update buffer
+      if String === buffer
+        buffer.replace(JSON.generate(decoded, :allow_nan => true))
+      end
+
+      return buffer
+    end
+
+    def self.write_item_internal(item, value, decoded)
+      return nil if item.data_type == :DERIVED
+
+      # Save traversal state
+      parent_node = nil
+      parent_key = nil
+      node = decoded
+
+      # Parse the JsonPath
+      json_path = JsonPath.new(item.key)
+
+      # Handle each token
+      json_path.path.each do |token|
+        case token
+        when '$'
+          # Ignore start - it is implied
+          next
+        when /\[.*\]/
+          # Array or Hash Index
+          if token.index("'") # Hash index
+            key = token[2..-3]
+            if not (Hash === node)
+              node = {}
+              parent_node[parent_key] = node
+            end
+            parent_node = node
+            parent_key = key
+            node = node[key]
+          else # Array index
+            key = token[1..-2].to_i
+            if not (Array === node)
+              node = []
+              parent_node[parent_key] = node
+            end
+            parent_node = node
+            parent_key = key
+            node = node[key]
+          end
+        else
+          raise "Unsupported key/token: #{item.key} - #{token}"
+        end
+      end
+      if parent_node
+        parent_node[parent_key] = value
+      else
+        decoded.replace(value)
+      end
+      return decoded
+    end
+  end
+end

data/lib/openc3/accessors/xml_accessor.rb

@@ -0,0 +1,67 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+require 'nokogiri'
+require 'openc3/accessors/accessor'
+
+module OpenC3
+  class XmlAccessor < Accessor
+    def self.read_item(item, buffer)
+      return nil if item.data_type == :DERIVED
+      doc = buffer_to_doc(buffer)
+      return convert_to_type(doc.xpath(item.key).first.to_s, item)
+    end
+
+    def self.write_item(item, value, buffer)
+      return nil if item.data_type == :DERIVED
+      doc = buffer_to_doc(buffer)
+      node = doc.xpath(item.key).first
+      node.content = value.to_s
+      buffer.replace(doc_to_buffer(doc))
+    end
+
+    def self.read_items(items, buffer)
+      doc = buffer_to_doc(buffer)
+      result = {}
+      items.each do |item|
+        if item.data_type == :DERIVED
+          result[item.name] = nil
+        else
+          result[item.name] = convert_to_type(doc.xpath(item.key).first.to_s, item)
+        end
+      end
+      return result
+    end
+
+    def self.write_items(items, values, buffer)
+      doc = buffer_to_doc(buffer)
+      items.each_with_index do |item, index|
+        next if item.data_type == :DERIVED
+        node = doc.xpath(item.key).first
+        node.content = values[index].to_s
+      end
+      buffer.replace(doc_to_buffer(doc))
+    end
+
+    def self.buffer_to_doc(buffer)
+      Nokogiri.XML(buffer)
+    end
+
+    def self.doc_to_buffer(doc)
+      doc.to_xml
+    end
+
+  end
+end

data/lib/openc3/accessors.rb

@@ -0,0 +1,23 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+module OpenC3
+  autoload(:Accessor, 'openc3/accessors/accessor.rb')
+  autoload(:BinaryAccessor, 'openc3/accessors/binary_accessor.rb')
+  autoload(:CborAccessor, 'openc3/accessors/cbor_accessor.rb')
+  autoload(:HtmlAccessor, 'openc3/accessors/html_accessor.rb')
+  autoload(:JsonAccessor, 'openc3/accessors/json_accessor.rb')
+  autoload(:XmlAccessor, 'openc3/accessors/xml_accessor.rb')
+end

data/lib/openc3/api/interface_api.rb

@@ -119,13 +119,20 @@ module OpenC3
     # interface. All the commands will go out over and telemetry be received
     # from that interface.
     #
-    # @param target_name [String] The name of the target
+    # @param target_name [String/Array] The name of the target(s)
     # @param interface_name (see #connect_interface)
     def map_target_to_interface(target_name, interface_name, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system_set', interface_name: interface_name, scope: scope, token: token)
       new_interface = InterfaceModel.get_model(name: interface_name, scope: scope)
-      new_interface.map_target(target_name)
-      Logger.info("Target #{target_name} mapped to Interface #{interface_name}", scope: scope)
+      if Array === target_name
+        target_names = target_name
+      else
+        target_names = [target_name]
+      end
+      target_names.each do |name|
+        new_interface.map_target(name)
+        Logger.info("Target #{name} mapped to Interface #{interface_name}", scope: scope)
+      end
       nil
     end
   end

data/lib/openc3/config/config_parser.rb

@@ -161,14 +161,20 @@ module OpenC3
       if options[:locals]
         options[:locals].each { |key, value| b.local_variable_set(key, value) }
       end
+
+      return ERB.new(read_file(template_name), trim_mode: "-").result(b)
+    end
+
+    # Can be called during parsing to read a referenced file
+    def read_file(filename)
       # Assume the file is there. If not we raise a pretty obvious error
-      if File.expand_path(template_name) == template_name # absolute path
-        path = template_name
+      if File.expand_path(filename) == filename # absolute path
+        path = filename
       else # relative to the current @filename
-        path = File.join(File.dirname(@filename), template_name)
+        path = File.join(File.dirname(@filename), filename)
       end
       OpenC3.set_working_dir(File.dirname(path)) do
-        return ERB.new(File.read(path), trim_mode: "-").result(b)
+        return File.read(path)
       end
     end
 

data/lib/openc3/core_ext/tempfile.rb

@@ -0,0 +1,20 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# 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.
+
+require 'tempfile'
+
+class Tempfile
+  attr_accessor :filename
+end

data/lib/openc3/core_ext.rb

@@ -32,5 +32,6 @@ require 'openc3/core_ext/range'
 require 'openc3/core_ext/socket'
 require 'openc3/core_ext/string'
 require 'openc3/core_ext/stringio'
+require 'openc3/core_ext/tempfile'
 require 'openc3/core_ext/time'
 require 'openc3/core_ext/objectspace'

data/lib/openc3/interfaces/interface.rb

@@ -328,7 +328,7 @@ module OpenC3
       config = {}
       config['name'] = @name
       config['state'] = @state
-      config['clients'] = @num_clients
+      config['clients'] = self.num_clients
       config['txsize'] = @write_queue_size
       config['rxsize'] = @read_queue_size
       config['txbytes'] = @bytes_written

data/lib/openc3/models/auth_model.rb

@@ -42,7 +42,6 @@ module OpenC3
         service_hash = set_hash
       end
       return true if service_hash == token_hash and permission != 'admin'
-
       return false
     end
 

data/lib/openc3/models/cvt_model.rb

@@ -26,16 +26,7 @@ module OpenC3
     @overrides = {}
 
     def self.build_json_from_packet(packet)
-      json_hash = {}
-      packet.sorted_items.each do |item|
-        json_hash[item.name] = packet.read_item(item, :RAW)
-        json_hash["#{item.name}__C"] = packet.read_item(item, :CONVERTED) if item.read_conversion or item.states
-        json_hash["#{item.name}__F"] = packet.read_item(item, :FORMATTED) if item.format_string
-        json_hash["#{item.name}__U"] = packet.read_item(item, :WITH_UNITS) if item.units
-        limits_state = item.limits.state
-        json_hash["#{item.name}__L"] = limits_state if limits_state
-      end
-      json_hash
+      packet.decom
     end
 
     # Delete the current value table for a target

data/lib/openc3/models/microservice_model.rb

@@ -34,6 +34,7 @@ module OpenC3
     attr_accessor :target_names
     attr_accessor :topics
     attr_accessor :work_dir
+    attr_accessor :ports
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -81,6 +82,7 @@ module OpenC3
       folder_name: nil,
       cmd: [],
       work_dir: '.',
+      ports: [],
       env: {},
       topics: [],
       target_names: [],
@@ -103,6 +105,7 @@ module OpenC3
       @folder_name = folder_name
       @cmd = cmd
       @work_dir = work_dir
+      @ports = ports
       @env = env
       @topics = topics
       @target_names = target_names
@@ -117,6 +120,7 @@ module OpenC3
         'folder_name' => @folder_name,
         'cmd' => @cmd,
         'work_dir' => @work_dir,
+        'ports' => @ports,
         'env' => @env,
         'topics' => @topics,
         'target_names' => @target_names,
@@ -132,6 +136,9 @@ module OpenC3
       result = "MICROSERVICE #{@folder_name ? @folder_name : 'nil'} #{@name.split("__")[-1]}\n"
       result << "  CMD #{@cmd.join(' ')}\n"
       result << "  WORK_DIR \"#{@work_dir}\"\n"
+      @ports.each do |port|
+        result << "  PORT #{port}\n"
+      end
       @topics.each do |topic_name|
         result << "  TOPIC #{topic_name}\n"
       end
@@ -156,6 +163,25 @@ module OpenC3
       when 'WORK_DIR'
         parser.verify_num_parameters(1, 1, "#{keyword} <Dir>")
         @work_dir = parameters[0]
+      when 'PORT'
+        usage = "PORT <Number> <Protocol (Optional)"
+        parser.verify_num_parameters(1, 2, usage)
+        begin
+          @ports << [Integer(parameters[0])]
+        rescue => err # In case Integer fails
+          raise ConfigParser::Error.new(parser, "Port must be an integer: #{parameters[0]}", usage)
+        end
+        protocol = ConfigParser.handle_nil(parameters[1])
+        if protocol
+          # Per https://kubernetes.io/docs/concepts/services-networking/service/#protocol-support
+          if %w(TCP UDP SCTP HTTP SCTP).include?(protocol.upcase)
+            @ports[-1] << protocol.upcase
+          else
+            raise ConfigParser::Error.new(parser, "Unknown port protocol: #{parameters[1]}", usage)
+          end
+        else
+          @ports[-1] << 'TCP'
+        end
       when 'TOPIC'
         parser.verify_num_parameters(1, 1, "#{keyword} <Topic Name>")
         @topics << parameters[0]

data/lib/openc3/models/note_model.rb

@@ -96,12 +96,12 @@ module OpenC3
     end
 
     # Update the Redis hash at primary_key
-    def update(start:, stop:, color:, description:)
+    def update(start: nil, stop: nil, color: nil, description: nil)
       orig_start = @start
-      @start = start
-      @stop = stop
-      @color = color
-      @description = description
+      @start = start if start
+      @stop = stop if stop
+      @color = color if color
+      @description = description if description
       create(update: orig_start)
     end