openc3 5.1.1 → 5.2.0

data/lib/openc3/models/interface_model.rb

@@ -17,11 +17,12 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/model'
 require 'openc3/models/microservice_model'
+require 'openc3/models/target_model'
 
 module OpenC3
   class InterfaceModel < Model
@@ -29,7 +30,9 @@ module OpenC3
     ROUTERS_PRIMARY_KEY = 'openc3_routers'
 
     attr_accessor :config_params
-    attr_accessor :target_names
+    attr_accessor :target_names # Redundant superset of cmd_target_names and tlm_target_names for backwards compat
+    attr_accessor :cmd_target_names
+    attr_accessor :tlm_target_names
     attr_accessor :connect_on_startup
     attr_accessor :auto_reconnect
     attr_accessor :reconnect_delay
@@ -91,6 +94,8 @@ module OpenC3
       name:,
       config_params: [],
       target_names: [],
+      cmd_target_names: [],
+      tlm_target_names: [],
       connect_on_startup: true,
       auto_reconnect: true,
       reconnect_delay: 5.0,
@@ -111,6 +116,8 @@ module OpenC3
       end
       @config_params = config_params
       @target_names = target_names
+      @cmd_target_names = cmd_target_names
+      @tlm_target_names = tlm_target_names
       @connect_on_startup = connect_on_startup
       @auto_reconnect = auto_reconnect
       @reconnect_delay = reconnect_delay
@@ -133,6 +140,8 @@ module OpenC3
         interface_or_router = klass.new
       end
       interface_or_router.target_names = @target_names.dup
+      interface_or_router.cmd_target_names = @cmd_target_names.dup
+      interface_or_router.tlm_target_names = @tlm_target_names.dup
       interface_or_router.connect_on_startup = @connect_on_startup
       interface_or_router.auto_reconnect = @auto_reconnect
       interface_or_router.reconnect_delay = @reconnect_delay
@@ -152,6 +161,8 @@ module OpenC3
         'name' => @name,
         'config_params' => @config_params,
         'target_names' => @target_names,
+        'cmd_target_names' => @cmd_target_names,
+        'tlm_target_names' => @tlm_target_names,
         'connect_on_startup' => @connect_on_startup,
         'auto_reconnect' => @auto_reconnect,
         'reconnect_delay' => @reconnect_delay,
@@ -166,25 +177,10 @@ module OpenC3
       }
     end
 
-    # TODO: Not currently used but may be used by a XTCE or other format to OpenC3 conversion
-    def as_config
-      result = "#{self.class._get_type} #{@name} #{@config_params.join(' ')}\n"
-      @target_names.each do |target_name|
-        result << "  MAP_TARGET #{target_name}\n"
-      end
-      result << "  DONT_CONNECT\n" unless @connect_on_startup
-      result << "  DONT_RECONNECT\n" unless @auto_reconnect
-      result << "  RECONNECT_DELAY #{@reconnect_delay}\n"
-      result << "  DISABLE_DISCONNECT\n" if @disable_disconnect
-      @options.each do |option|
-        result << "  OPTION #{option.join(' ')}\n"
-      end
-      @protocols.each do |protocol|
-        result << "  PROTOCOL #{protocol.join(' ')}\n"
-      end
-      result << "  DONT_LOG" unless @log
-      result << "  LOG_RAW" if @log_raw
-      result
+    def ensure_target_exists(target_name)
+      target = TargetModel.get(name: target_name, scope: @scope)
+      raise "Target #{target_name} does not exist" unless target
+      target
     end
 
     # Handles Interface/Router specific configuration keywords
@@ -192,7 +188,22 @@ module OpenC3
       case keyword
       when 'MAP_TARGET'
         parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
-        @target_names << parameters[0].upcase
+        target_name = parameters[0].upcase
+        @target_names << target_name unless @target_names.include?(target_name)
+        @cmd_target_names << target_name unless @cmd_target_names.include?(target_name)
+        @tlm_target_names << target_name unless @tlm_target_names.include?(target_name)
+
+      when 'MAP_CMD_TARGET'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
+        target_name = parameters[0].upcase
+        @target_names << target_name unless @target_names.include?(target_name)
+        @cmd_target_names << target_name unless @cmd_target_names.include?(target_name)
+
+      when 'MAP_TLM_TARGET'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
+        target_name = parameters[0].upcase
+        @target_names << target_name unless @target_names.include?(target_name)
+        @tlm_target_names << target_name unless @tlm_target_names.include?(target_name)
 
       when 'DONT_CONNECT'
         parser.verify_num_parameters(0, 0, "#{keyword}")
@@ -253,6 +264,7 @@ module OpenC3
         scope: @scope
       )
       unless validate_only
+        @target_names.each { |target_name| ensure_target_exists(target_name) }
         microservice.create
         microservice.deploy(gem_path, variables)
         ConfigTopic.write({ kind: 'created', type: type.downcase, name: @name, plugin: @plugin }, scope: @scope)
@@ -281,37 +293,59 @@ module OpenC3
       status_model.destroy if status_model
     end
 
-    def unmap_target(target_name)
+    def unmap_target(target_name, cmd_only: false, tlm_only: false)
+      if cmd_only and tlm_only
+        cmd_only = false
+        tlm_only = false
+      end
       target_name = target_name.to_s.upcase
 
       # Remove from this interface
-      @target_names.delete(target_name)
+      if cmd_only
+        @cmd_target_names.delete(target_name)
+        @target_names.delete(target_name) unless @tlm_target_names.include?(target_name)
+      elsif tlm_only
+        @tlm_target_names.delete(target_name)
+        @target_names.delete(target_name) unless @cmd_target_names.include?(target_name)
+      else
+        @cmd_target_names.delete(target_name)
+        @tlm_target_names.delete(target_name)
+        @target_names.delete(target_name)
+      end
       update()
 
       # Respawn the microservice
       type = self.class._get_type
       microservice_name = "#{@scope}__#{type}__#{@name}"
       microservice = MicroserviceModel.get_model(name: microservice_name, scope: scope)
-      microservice.target_names.delete(target_name)
+      microservice.target_names.delete(target_name) unless @target_names.include?(target_name)
       microservice.update
     end
 
-    def map_target(target_name)
+    def map_target(target_name, cmd_only: false, tlm_only: false, unmap_old: true)
+      if cmd_only and tlm_only
+        cmd_only = false
+        tlm_only = false
+      end
       target_name = target_name.to_s.upcase
-
-      # Remove from old interface
-      all_interfaces = InterfaceModel.all(scope: scope)
-      old_interface = nil
-      all_interfaces.each do |old_interface_name, old_interface_details|
-        if old_interface_details['target_names'].include?(target_name)
-          old_interface = InterfaceModel.from_json(old_interface_details, scope: scope)
-          break
+      ensure_target_exists(target_name)
+
+      if unmap_old
+        # Remove from old interface
+        all_interfaces = InterfaceModel.all(scope: scope)
+        old_interface = nil
+        all_interfaces.each do |old_interface_name, old_interface_details|
+          if old_interface_details['target_names'].include?(target_name)
+            old_interface = InterfaceModel.from_json(old_interface_details, scope: scope)
+            old_interface.unmap_target(target_name, cmd_only: cmd_only, tlm_only: tlm_only) if old_interface
+          end
         end
       end
-      old_interface.unmap_target(target_name) if old_interface
 
       # Add to this interface
       @target_names << target_name unless @target_names.include?(target_name)
+      @cmd_target_names << target_name unless @cmd_target_names.include?(target_name) or tlm_only
+      @tlm_target_names << target_name unless @tlm_target_names.include?(target_name) or cmd_only
       update()
 
       # Respawn the microservice

data/lib/openc3/models/metadata_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 # https://www.rubydoc.info/gems/redis/Redis/Commands/SortedSets

data/lib/openc3/models/microservice_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/top_level'
@@ -38,6 +38,7 @@ module OpenC3
     attr_accessor :topics
     attr_accessor :work_dir
     attr_accessor :ports
+    attr_accessor :parent
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -90,6 +91,7 @@ module OpenC3
       topics: [],
       target_names: [],
       options: [],
+      parent: nil,
       container: nil,
       updated_at: nil,
       plugin: nil,
@@ -113,6 +115,7 @@ module OpenC3
       @topics = topics
       @target_names = target_names
       @options = options
+      @parent = parent
       @container = container
       @needs_dependencies = needs_dependencies
       @bucket = Bucket.getClient()
@@ -129,6 +132,7 @@ module OpenC3
         'topics' => @topics,
         'target_names' => @target_names,
         'options' => @options,
+        'parent' => @parent,
         'container' => @container,
         'updated_at' => @updated_at,
         'plugin' => @plugin,
@@ -136,29 +140,6 @@ module OpenC3
       }
     end
 
-    def as_config
-      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
-      @target_names.each do |target_name|
-        result << "  TARGET_NAME #{target_name}\n"
-      end
-      @env.each do |key, value|
-        result << "  ENV #{key} \"#{value}\"\n"
-      end
-      @options.each do |option|
-        result << "  OPTION #{option.join(" ")}\n"
-      end
-      result << "  CONTAINER #{@container}\n" if @container != 'openc3-base'
-      result
-    end
-
     def handle_config(parser, keyword, parameters)
       case keyword
       when 'ENV'
@@ -236,6 +217,8 @@ module OpenC3
         @bucket.delete_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: object.key)
       end
       ConfigTopic.write({ kind: 'deleted', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
+    rescue Exception => error
+      Logger.error("Error undeploying microservice model #{@name} in scope #{@scope} due to #{error}")
     end
   end
 end

data/lib/openc3/models/migration_model.rb

@@ -0,0 +1,52 @@
+# 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.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/models/model'
+
+module OpenC3
+  class MigrationModel < Model
+    PRIMARY_KEY = 'openc3__migrations'
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope: nil)
+      super(PRIMARY_KEY, name: name)
+    end
+
+    def self.names(scope: nil)
+      super(PRIMARY_KEY)
+    end
+
+    def self.all(scope: nil)
+      super(PRIMARY_KEY)
+    end
+    # END NOTE
+
+    def initialize(name:)
+      super(PRIMARY_KEY, name: name)
+    end
+
+    # @return [Hash] JSON encoding of this model
+    def as_json(*a)
+      {
+        'name' => @name,
+        'updated_at' => @updated_at
+      }
+    end
+  end
+end

data/lib/openc3/models/model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/utilities/store'
@@ -128,7 +128,7 @@ module OpenC3
       result
     end
 
-    def self.handle_config(parser, model, keyword, parameters)
+    def self.handle_config(parser, keyword, parameters)
       raise "must be implemented by subclass"
     end
 
@@ -192,11 +192,6 @@ module OpenC3
         'plugin' => @plugin,
         'scope' => @scope }
     end
-
-    # TODO: Not currently used but may be used by a XTCE or other format to OpenC3 conversion
-    def as_config
-      ""
-    end
   end
 
   class EphemeralModel < Model

data/lib/openc3/models/note_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 # https://www.rubydoc.info/gems/redis/Redis/Commands/SortedSets

data/lib/openc3/models/offline_access_model.rb

@@ -0,0 +1,55 @@
+# 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.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/models/model'
+
+module OpenC3
+  class OfflineAccessModel < Model
+    PRIMARY_KEY = 'openc3__offline_access'
+
+    attr_accessor :offline_access_token
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope:)
+      super("#{scope}__#{PRIMARY_KEY}", name: name)
+    end
+
+    def self.names(scope:)
+      super("#{scope}__#{PRIMARY_KEY}")
+    end
+
+    def self.all(scope:)
+      super("#{scope}__#{PRIMARY_KEY}")
+    end
+    # END NOTE
+
+    def initialize(name:, offline_access_token: nil, updated_at: nil, scope:)
+      super("#{scope}__#{PRIMARY_KEY}", name: name, scope: scope)
+      @offline_access_token = offline_access_token
+    end
+
+    # @return [Hash] JSON encoding of this model
+    def as_json(*a)
+      { 'name' => @name,
+        'updated_at' => @updated_at,
+        'offline_access_token' => @offline_access_token,
+        'scope' => @scope }
+    end
+  end
+end

data/lib/openc3/models/plugin_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'rubygems'
@@ -43,6 +43,8 @@ module OpenC3
   # as destroys them all when the plugin is removed.
   class PluginModel < Model
     PRIMARY_KEY = 'openc3_plugins'
+    # Reserved VARIABLE names. See local_mode.rb: update_local_plugin()
+    RESERVED_VARIABLE_NAMES = ['target_name', 'microservice_name']
 
     attr_accessor :variables
     attr_accessor :plugin_txt_lines
@@ -112,6 +114,9 @@ module OpenC3
             usage = "#{keyword} <Variable Name> <Default Value>"
             parser.verify_num_parameters(2, nil, usage)
             variable_name = params[0]
+            if RESERVED_VARIABLE_NAMES.include?(variable_name)
+              raise "VARIABLE name '#{variable_name}' is reserved"
+            end
             value = params[1..-1].join(" ")
             variables[variable_name] = value
             if existing_variables && existing_variables.key?(variable_name)
@@ -159,10 +164,15 @@ module OpenC3
         pkg = Gem::Package.new(gem_file_path)
         needs_dependencies = pkg.spec.runtime_dependencies.length > 0
         pkg.extract_files(gem_path)
+        Dir[File.join(gem_path, '**/screens/*.txt')].each do |filename|
+          if File.basename(filename) != File.basename(filename).downcase
+            raise "Invalid screen name: #{filename}. Screen names must be lowercase."
+          end
+        end
         needs_dependencies = true if Dir.exist?(File.join(gem_path, 'lib'))
         if needs_dependencies
           plugin_model.needs_dependencies = true
-          plugin_model.update
+          plugin_model.update unless validate_only
         end
 
         # Temporarily add all lib folders from the gem to the end of the load path
@@ -224,7 +234,6 @@ module OpenC3
         FileUtils.remove_entry(temp_dir) if temp_dir and File.exist?(temp_dir)
         tf.unlink if tf
       end
-
       return plugin_model.as_json(:allow_nan => true)
     end
 

data/lib/openc3/models/reaction_model.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/models/model'
@@ -54,7 +54,7 @@ module OpenC3
 
     def self.create_mini_id
       time = (Time.now.to_f * 10_000_000).to_i
-      jitter = rand(10_000_000) 
+      jitter = rand(10_000_000)
       key = "#{jitter}#{time}".to_i.to_s(36)
       return "RV0-#{key}"
     end
@@ -160,6 +160,7 @@ module OpenC3
     end
 
     attr_reader :name, :scope, :description, :snooze, :triggers, :actions, :active, :review, :snoozed_until
+    attr_accessor :username
 
     def initialize(
       name:,
@@ -171,6 +172,7 @@ module OpenC3
       active: true,
       review: true,
       snoozed_until: nil,
+      username: nil,
       updated_at: nil
     )
       if name.nil? || scope.nil? || description.nil? || snooze.nil? || triggers.nil? || actions.nil?
@@ -185,6 +187,7 @@ module OpenC3
       @snooze = validate_snooze(snooze: snooze)
       @actions = validate_actions(actions: actions)
       @triggers = validate_triggers(triggers: triggers)
+      @username = username
       @updated_at = updated_at
     end
 
@@ -269,6 +272,7 @@ module OpenC3
         'snoozed_until' => @snoozed_until,
         'triggers' => @triggers,
         'actions' => @actions,
+        'username' => @username,
         'updated_at' => @updated_at
       }
     end