openc3 5.17.1 → 5.19.0

data/lib/openc3/models/scope_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -26,6 +26,18 @@ require 'openc3/models/plugin_model'
 require 'openc3/models/microservice_model'
 require 'openc3/models/setting_model'
 require 'openc3/models/trigger_group_model'
+require 'openc3/topics/system_events_topic'
+
+begin
+  require 'openc3-enterprise/models/cmd_authority_model'
+rescue LoadError
+  # Stub out the Enterprise CmdAuthorityModel to do nothing
+  class CmdAuthorityModel
+    def self.names(scope:)
+      []
+    end
+  end
+end
 
 module OpenC3
   class ScopeModel < Model
@@ -37,9 +49,13 @@ module OpenC3
     attr_accessor :text_log_retain_time
     attr_accessor :tool_log_retain_time
     attr_accessor :cleanup_poll_time
+    attr_accessor :command_authority
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
+    #
+    # The scope keyword is given to support the ModelController method signature
+    # even though it is not used
     def self.get(name:, scope: nil)
       super(PRIMARY_KEY, name: name)
     end
@@ -52,13 +68,13 @@ module OpenC3
       super(PRIMARY_KEY)
     end
 
-    def self.from_json(json, scope: nil)
+    def self.from_json(json)
       json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
       raise "json data is nil" if json.nil?
-      self.new(**json.transform_keys(&:to_sym), scope: scope)
+      self.new(**json.transform_keys(&:to_sym))
     end
 
-    def self.get_model(name:, scope: nil)
+    def self.get_model(name:)
       json = get(name: name)
       if json
         return from_json(json)
@@ -73,18 +89,15 @@ module OpenC3
       text_log_retain_time: nil,
       tool_log_retain_time: nil,
       cleanup_poll_time: 900,
-      updated_at: nil,
-      scope: nil
+      command_authority: false,
+      updated_at: nil
     )
       super(
         PRIMARY_KEY,
         name: name,
-        text_log_cycle_time: text_log_cycle_time,
-        text_log_cycle_size: text_log_cycle_size,
-        text_log_retain_time: text_log_retain_time,
-        tool_log_retain_time: tool_log_retain_time,
-        cleanup_poll_time: cleanup_poll_time,
         updated_at: updated_at,
+        # This sets the @scope variable which is sort of redundant for the ScopeModel
+        # (since its the same as @name) but every model has a @scope
         scope: name
       )
       @text_log_cycle_time = text_log_cycle_time
@@ -92,21 +105,34 @@ module OpenC3
       @text_log_retain_time = text_log_retain_time
       @tool_log_retain_time = tool_log_retain_time
       @cleanup_poll_time = cleanup_poll_time
+      @command_authority = command_authority
       @children = []
     end
 
     def create(update: false, force: false, queued: false)
-      # Ensure there are no "." in the scope name - prevents gems accidently becoming scope names
+      # Ensure there are no "." in the scope name - prevents gems accidentally becoming scope names
       raise "Invalid scope name: #{@name}" if @name !~ /^[a-zA-Z0-9_-]+$/
       @name = @name.upcase
+      @scope = @name # Ensure @scope matches @name
       super(update: update, force: force, queued: queued)
+
+      # If we're updating the scope and disabling command_authority
+      # then we clear out all the existing values so it comes up fresh
+      if update and @command_authority == false
+        CmdAuthorityModel.names(scope: @name).each do |auth_name|
+          model = CmdAuthorityModel.get_model(name: auth_name, scope: @name)
+          model.destroy if model
+        end
+      end
+
+      SystemEventsTopic.write(:scope, as_json())
     end
 
     def destroy
       if @name != 'DEFAULT'
         # Remove all the plugins for this scope
         plugins = PluginModel.get_all_models(scope: @name)
-        plugins.each do |plugin_name, plugin|
+        plugins.each do |_plugin_name, plugin|
           plugin.destroy
         end
         super()
@@ -115,7 +141,7 @@ module OpenC3
       end
     end
 
-    def as_json(*a)
+    def as_json(*_a)
       { 'name' => @name,
         'updated_at' => @updated_at,
         'text_log_cycle_time' => @text_log_cycle_time,
@@ -123,6 +149,7 @@ module OpenC3
         'text_log_retain_time' => @text_log_retain_time,
         'tool_log_retain_time' => @tool_log_retain_time,
         'cleanup_poll_time' => @cleanup_poll_time,
+        'command_authority' => @command_authority,
        }
     end
 
@@ -276,6 +303,10 @@ module OpenC3
     end
 
     def undeploy
+      # Delete UNKNOWN target
+      target = TargetModel.get_model(name: "UNKNOWN", scope: @scope)
+      target.destroy
+
       model = MicroserviceModel.get_model(name: "#{@scope}__SCOPEMULTI__#{@scope}", scope: @scope)
       model.destroy if model
       model = MicroserviceModel.get_model(name: "#{@scope}__SCOPECLEANUP__#{@scope}", scope: @scope)

data/lib/openc3/models/sorted_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -34,15 +34,15 @@ module OpenC3
   class SortedOverlapError < SortedError; end
 
   class SortedModel < Model
-    SORTED_TYPE = 'sorted'.freeze # To be overriden by base class
-    PRIMARY_KEY = '__SORTED'.freeze # To be overriden by base class
+    SORTED_TYPE = 'sorted'.freeze # To be overridden by base class
+    PRIMARY_KEY = '__SORTED'.freeze # To be overridden by base class
 
-    # MUST be overriden by any subclasses
+    # MUST be overridden by any subclasses
     def self.pk(scope)
       return "#{scope}#{PRIMARY_KEY}"
     end
 
-    # MUST be overriden by any subclasses
+    # MUST be overridden by any subclasses
     def self.notify(scope:, kind:, start:, stop: nil)
       # Do nothing by default
     end

data/lib/openc3/models/target_model.rb

@@ -109,7 +109,7 @@ module OpenC3
         modified_targets = Bucket.getClient().list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: "DEFAULT/targets_modified/", only_directories: true)
         modified_targets.each do |target_name|
           # A target could have been deleted without removing the modified files
-          # Thus we have to check for the existance of the target_name key
+          # Thus we have to check for the existence of the target_name key
           if targets.has_key?(target_name)
             targets[target_name]['modified'] = true
           end
@@ -250,7 +250,7 @@ module OpenC3
         (items - found_items).each do |item|
           not_found << "'#{target_name} #{packet_name} #{item}'"
         end
-        # 'does not exist' not gramatically correct but we use it in every other exception
+        # 'does not exist' not grammatically correct but we use it in every other exception
         raise "Item(s) #{not_found.join(', ')} does not exist"
       end
       found
@@ -660,7 +660,10 @@ module OpenC3
       Store.del(item_map_key)
       @@item_map_cache[@name] = nil
 
-      ConfigTopic.write({ kind: 'deleted', type: 'target', name: @name, plugin: @plugin }, scope: @scope)
+      topic = { kind: 'deleted', type: 'target', name: @name }
+      # The UNKNOWN target doesn't have an associated plugin
+      topic[:plugin] = @plugin if @plugin
+      ConfigTopic.write(topic, scope: @scope)
     rescue Exception => e
       Logger.error("Error undeploying target model #{@name} in scope #{@scope} due to #{e}")
     end
@@ -1118,7 +1121,7 @@ module OpenC3
             end
           end
           # If there are any topics (packets) left over that haven't been
-          # explictly handled above, spawn another microservice
+          # explicitly handled above, spawn another microservice
           if all_topics.length > 0
             instance = nil
             instance = deploy_count unless deploy_count == 0

data/lib/openc3/models/tool_config_model.rb

@@ -25,7 +25,7 @@ require 'openc3/utilities/local_mode'
 module OpenC3
   class ToolConfigModel
     def self.config_tool_names(scope: $openc3_scope)
-      cursor, keys = Store.scan(0, match: "#{scope}__config__*", type: 'hash', count: 100)
+      _, keys = Store.scan(0, match: "#{scope}__config__*", type: 'hash', count: 100)
       # Just return the tool name that is used in the other APIs
       return keys.map! { |key| key.split('__')[2] }.sort
     end

data/lib/openc3/models/tool_model.rb

@@ -96,7 +96,7 @@ module OpenC3
     def self.set_position(name:, position:, scope:)
       moving = from_json(get(name: name, scope: scope), scope: scope)
       old_pos = moving.position
-      new_pos = Integer(position)
+      new_pos = position
       direction = :down
       if (old_pos == new_pos)
         return # we're not doing anything
@@ -225,7 +225,7 @@ module OpenC3
         @shown = ConfigParser.handle_true_false(parameters[0])
       when 'POSITION'
         parser.verify_num_parameters(1, 1, "POSITION <value>")
-        @position = parameters[0].to_i
+        @position = parameters[0].to_f
       when 'DISABLE_ERB'
         # 0 to unlimited parameters
         @disable_erb ||= []
@@ -274,8 +274,8 @@ module OpenC3
           ConfigTopic.write({ kind: 'deleted', type: 'tool', name: @folder_name, plugin: @plugin }, scope: @scope)
         end
       end
-    rescue Exception => error
-      Logger.error("Error undeploying tool model #{@name} in scope #{@scope} due to #{error}")
+    rescue Exception => e
+      Logger.error("Error undeploying tool model #{@name} in scope #{@scope} due to #{e}")
     end
 
     ##################################################

data/lib/openc3/models/widget_model.rb

@@ -73,9 +73,11 @@ module OpenC3
     def self.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:)
       case keyword
       when 'WIDGET'
-        parser.verify_num_parameters(1, 2, "WIDGET <Name> <Label>")
+        parser.verify_num_parameters(1, 3, "WIDGET <Name> <Label> <Select Items (true/false)>")
         # Label is optional and if it doesn't exist nil is fine
-        return self.new(name: parameters[0], plugin: plugin, label: parameters[1], needs_dependencies: needs_dependencies, scope: scope)
+        # Select Items is optional and if it doesn't exist nil is fine
+        items = ConfigParser.handle_true_false_nil(parameters[2])
+        return self.new(name: parameters[0], plugin: plugin, label: parameters[1], items: items, needs_dependencies: needs_dependencies, scope: scope)
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Widget: #{keyword} #{parameters.join(" ")}")
       end
@@ -87,6 +89,7 @@ module OpenC3
       updated_at: nil,
       plugin: nil,
       label: nil,
+      items: false,
       needs_dependencies: false,
       disable_erb: nil,
       scope:
@@ -96,6 +99,8 @@ module OpenC3
       @filename = @full_name + '.umd.min.js'
       @bucket_key = 'widgets/' + @full_name + '/' + @filename
       @label = label
+      # Ensure items is a boolean because it could be nil
+      @items = items ? true : false
       @needs_dependencies = needs_dependencies
       @disable_erb = disable_erb
     end
@@ -106,8 +111,9 @@ module OpenC3
         'updated_at' => @updated_at,
         'plugin' => @plugin,
         'label' => @label,
+        'items' => @items,
         'needs_dependencies' => @needs_dependencies,
-        'disable_erb' => @disable_erb
+        'disable_erb' => @disable_erb,
       }
     end
 
@@ -155,8 +161,8 @@ module OpenC3
       bucket = Bucket.getClient()
       bucket.delete_object(bucket: ENV['OPENC3_TOOLS_BUCKET'], key: @bucket_key)
       bucket.delete_object(bucket: ENV['OPENC3_TOOLS_BUCKET'], key: @bucket_key + '.map')
-    rescue Exception => error
-      Logger.error("Error undeploying widget model #{@name} in scope #{@scope} due to #{error}")
+    rescue Exception => e
+      Logger.error("Error undeploying widget model #{@name} in scope #{@scope} due to #{e}")
     end
   end
 end

data/lib/openc3/operators/microservice_operator.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -186,7 +186,7 @@ module OpenC3
           end
         end
 
-        @removed_microservices.each do |microservice_name, microservice_config|
+        @removed_microservices.each do |microservice_name, _microservice_config|
           process = @processes[microservice_name]
           @processes.delete(microservice_name)
           @removed_processes[microservice_name] = process

data/lib/openc3/operators/operator.rb

@@ -105,7 +105,7 @@ module OpenC3
     def cmd_line
       # In ProcessManager processes, the process_definition is the actual thing run
       # e.g. OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "load", ...])
-      # However, if the MicroserviceOperator is spawning the proceses it sets
+      # However, if the MicroserviceOperator is spawning the processes it sets
       # process_definition = ["ruby", "plugin_microservice.rb"]
       # which then calls exec(*@config["cmd"]) to actually run
       # So check if the @config['cmd'] is defined to give the user more info in the log
@@ -127,7 +127,7 @@ module OpenC3
       # @process.io.inherit!
       @process.cwd = @work_dir
       # Spawned process should not be controlled by same Bundler constraints as spawning process
-      ENV.each do |key, value|
+      ENV.each do |key, _value|
         if key =~ /^BUNDLER/
           @process.environment[key] = nil
         end
@@ -195,12 +195,14 @@ module OpenC3
       if @process
         stdout = @process.io.stdout.extract
         if stdout.length > 0
-          STDOUT.puts "STDOUT #{stdout.length} bytes from #{cmd_line()}:"
+          message = "STDOUT #{stdout.length} bytes from #{cmd_line()}:"
+          STDOUT.puts Logger.build_log_data(Logger::INFO_LEVEL, message, user: nil, type: OpenC3::Logger::LOG, url: nil).as_json(:allow_nan => true).to_json(:allow_nan => true)
           STDOUT.puts stdout
         end
         stderr = @process.io.stderr.extract
         if stderr.length > 0
-          STDERR.puts "STDERR #{stderr.length} bytes from #{cmd_line()}:"
+          message = "STDERR #{stderr.length} bytes from #{cmd_line()}:"
+          STDERR.puts Logger.build_log_data(Logger::ERROR_LEVEL, message, user: nil, type: OpenC3::Logger::LOG, url: nil).as_json(:allow_nan => true).to_json(:allow_nan => true)
           STDERR.puts stderr
         end
       end
@@ -265,7 +267,7 @@ module OpenC3
         if @new_processes.length > 0
           # Start all the processes
           Logger.info("#{self.class} starting each new process...")
-          @new_processes.each { |name, p| p.start }
+          @new_processes.each { |_name, p| p.start }
           @new_processes = {}
         end
       end
@@ -278,7 +280,7 @@ module OpenC3
           shutdown_processes(@changed_processes)
           break if @shutdown
 
-          @changed_processes.each { |name, p| p.start }
+          @changed_processes.each { |_name, p| p.start }
           @changed_processes = {}
         end
       end
@@ -296,7 +298,7 @@ module OpenC3
 
     def respawn_dead
       @mutex.synchronize do
-        @processes.each do |name, p|
+        @processes.each do |_name, p|
           break if @shutdown
           p.output_increment
           unless p.alive?
@@ -314,7 +316,7 @@ module OpenC3
       processes = processes.dup
 
       Logger.info("Commanding soft stops...")
-      processes.each { |name, p| p.soft_stop }
+      processes.each { |_name, p| p.soft_stop }
       start_time = Time.now
       # Allow sufficient time for processes to shutdown cleanly
       while (Time.now - start_time) < PROCESS_SHUTDOWN_SECONDS
@@ -322,21 +324,21 @@ module OpenC3
         processes.each do |name, p|
           unless p.alive?
             processes_to_remove << name
-            Logger.info("Soft stop process successful: #{p.cmd_line}", scope: p.scope)
+            Logger.debug("Soft stop process successful: #{p.cmd_line}", scope: p.scope)
           end
         end
         processes_to_remove.each do |name|
           processes.delete(name)
         end
         if processes.length <= 0
-          Logger.info("Soft stop all successful")
+          Logger.debug("Soft stop all successful")
           break
         end
         sleep(0.1)
       end
       if processes.length > 0
-        Logger.info("Commanding hard stops...")
-        processes.each { |name, p| p.hard_stop }
+        Logger.debug("Commanding hard stops...")
+        processes.each { |_name, p| p.hard_stop }
       end
     end
 

data/lib/openc3/packets/command_validator.rb

@@ -0,0 +1,48 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 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.
+
+# This file implements a class to handle command validation
+
+require 'openc3/api/api'
+
+module OpenC3
+  # This class defines methods which are called when a command is sent.
+  # This class must be subclassed and the pre_check or
+  # post_check methods implemented. Do NOT use this class directly.
+  class CommandValidator
+    attr_reader :args
+    include Api
+
+    def initialize(command = nil)
+      @command = command
+      @args = []
+    end
+
+    def pre_check(command)
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+
+    def post_check(command)
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+  end
+end

data/lib/openc3/packets/commands.rb

@@ -30,7 +30,7 @@ module OpenC3
   #
   # This should not be confused with the Api module which implements the JSON
   # API that is used by tools when accessing the Server. The Api module always
-  # provides Ruby primatives where the PacketConfig class can return actual
+  # provides Ruby primitives where the PacketConfig class can return actual
   # Packet or PacketItem objects. While there are some overlapping methods between
   # the two, these are separate interfaces into the system.
   class Commands
@@ -115,7 +115,7 @@ module OpenC3
         target = System.targets[target_name]
         if target and target.cmd_unique_id_mode
           # Iterate through the packets and see if any represent the buffer
-          target_packets.each do |packet_name, packet|
+          target_packets.each do |_packet_name, packet|
             if packet.identify?(packet_data)
               identified_packet = packet
               break
@@ -147,7 +147,7 @@ module OpenC3
     end
 
     # Returns a copy of the specified command packet with the parameters
-    # initialzed to the given params values.
+    # initialized to the given params values.
     #
     # @param target_name (see #packet)
     # @param packet_name (see #packet)
@@ -195,7 +195,7 @@ module OpenC3
         items = packet.read_all(:FORMATTED)
         raw = false
       end
-      items.delete_if { |item_name, item_value| ignored_parameters.include?(item_name) }
+      items.delete_if { |item_name, _item_value| ignored_parameters.include?(item_name) }
       return build_cmd_output_string(packet.target_name, packet.packet_name, items, raw)
     end
 
@@ -207,7 +207,7 @@ module OpenC3
       end
       target_name = 'UNKNOWN' unless target_name
       cmd_name = 'UNKNOWN' unless cmd_name
-      output_string << target_name + ' ' + cmd_name
+      output_string << (target_name + ' ' + cmd_name)
       if cmd_params.nil? or cmd_params.empty?
         output_string << '")'
       else
@@ -247,7 +247,7 @@ module OpenC3
           params << "#{key} #{value}"
         end
         params = params.join(", ")
-        output_string << ' with ' + params + '")'
+        output_string << (' with ' + params + '")')
       end
       return output_string
     end
@@ -291,14 +291,6 @@ module OpenC3
       cmd_pkt_hazardous?(build_cmd(target_name, packet_name, params, false, false, false))
     end
 
-    def clear_counters
-      @config.commands.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
-          packet.received_count = 0
-        end
-      end
-    end
-
     def all
       @config.commands
     end