Merge pull request #1138 from OpenC3/disabled

Implement DISABLED for commands

Author: jmthomas

openc3-cosmos-cmd-tlm-api/app/controllers/auth_controller.rb

@@ -25,7 +25,7 @@
 
 class AuthController < ApplicationController
   def token_exists
-    result = OpenC3::AuthModel.is_set?
+    result = OpenC3::AuthModel.set?
     render :json => {
       result: result
     }

openc3/lib/openc3/api/cmd_api.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
@@ -41,6 +41,8 @@ module Api
                        'cmd_raw_no_checks',
                        'build_cmd',
                        'build_command', # DEPRECATED
+                       'enable_cmd',
+                       'disable_cmd',
                        'send_raw',
                        'get_all_cmds',
                        'get_all_commands', # DEPRECATED
@@ -131,6 +133,30 @@ def build_cmd(*args, range_check: true, raw: false, scope: $openc3_scope, token:
     # build_command is DEPRECATED
     alias build_command build_cmd
 
+    # Helper method for disable_cmd / enable_cmd
+    def _get_and_set_cmd(method, *args, scope: $openc3_scope, token: $openc3_token)
+      target_name, command_name = _extract_target_command_names(method, *args)
+      authorize(permission: 'admin', target_name: target_name, packet_name: command_name, scope: scope, token: token)
+      command = yield TargetModel.packet(target_name, command_name, type: :CMD, scope: scope)
+      TargetModel.set_packet(target_name, command_name, command, type: :CMD, scope: scope)
+    end
+
+    # @since 5.15.1
+    def enable_cmd(*args, scope: $openc3_scope, token: $openc3_token)
+      _get_and_set_cmd('enable_cmd', *args, scope: scope, token: token) do |command|
+        command['disabled'] = false
+        command
+      end
+    end
+
+    # @since 5.15.1
+    def disable_cmd(*args, scope: $openc3_scope, token: $openc3_token)
+      _get_and_set_cmd('disable_cmd', *args, scope: scope, token: token) do |command|
+        command['disabled'] = true
+        command
+      end
+    end
+
     # Send a raw binary string to the specified interface.
     #
     # @param interface_name [String] The interface to send the raw binary
@@ -456,6 +482,12 @@ def _cmd_implementation(method_name, *args, range_check:, hazardous_check:, raw:
       cmd_params = cmd_params.transform_keys(&:upcase)
       authorize(permission: 'cmd', target_name: target_name, packet_name: cmd_name, scope: scope, token: token)
       packet = TargetModel.packet(target_name, cmd_name, type: :CMD, scope: scope)
+      if packet['disabled']
+        error = DisabledError.new
+        error.target_name = target_name
+        error.cmd_name = cmd_name
+        raise error
+      end
 
       command = {
         'target_name' => target_name,

openc3/lib/openc3/logs/packet_log_reader.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
@@ -96,9 +96,9 @@ def open(filename)
       @max_read_size = @file.size
       @max_read_size = MAX_READ_SIZE if @max_read_size > MAX_READ_SIZE
       return read_file_header()
-    rescue => err
+    rescue => e
       close()
-      raise err
+      raise e
     end
 
     # Closes the current log file
@@ -134,9 +134,8 @@ def read(identify_and_define = true)
 
       if flags & OPENC3_ENTRY_TYPE_MASK == OPENC3_JSON_PACKET_ENTRY_TYPE_MASK
         packet_index, time_nsec_since_epoch = entry[2..11].unpack('nQ>')
-        next_offset = 12
         received_time_nsec_since_epoch, extra, json_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
-        lookup_cmd_or_tlm, target_name, packet_name, id, key_map = @packets[packet_index]
+        lookup_cmd_or_tlm, target_name, packet_name, _id, key_map = @packets[packet_index]
         if cmd_or_tlm != lookup_cmd_or_tlm
           raise "Packet type mismatch, packet:#{cmd_or_tlm}, lookup:#{lookup_cmd_or_tlm}"
         end
@@ -148,8 +147,8 @@ def read(identify_and_define = true)
         end
       elsif flags & OPENC3_ENTRY_TYPE_MASK == OPENC3_RAW_PACKET_ENTRY_TYPE_MASK
         packet_index, time_nsec_since_epoch = entry[2..11].unpack('nQ>')
-        received_time_nsec_since_epoch, extra, packet_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
-        lookup_cmd_or_tlm, target_name, packet_name, id = @packets[packet_index]
+        received_time_nsec_since_epoch, _extra, packet_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
+        lookup_cmd_or_tlm, target_name, packet_name, _id = @packets[packet_index]
         if cmd_or_tlm != lookup_cmd_or_tlm
           raise "Packet type mismatch, packet:#{cmd_or_tlm}, lookup:#{lookup_cmd_or_tlm}"
         end
@@ -220,9 +219,9 @@ def read(identify_and_define = true)
       else
         raise "Invalid Entry Flags: #{flags}"
       end
-    rescue => err
+    rescue => e
       close()
-      raise err
+      raise e
     end
 
     # @return [Integer] The size of the log file being processed

openc3/lib/openc3/microservices/trigger_group_microservice.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
@@ -418,7 +418,7 @@ def evaluate(name:, left:, operator:, right:)
         when 'OR'
           return left || right ? 1 : 0
         end
-      rescue ArgumentError => error
+      rescue ArgumentError
         message = "invalid evaluate: (#{left} #{operator} #{right})"
         notify(name: name, severity: 'error', message: message)
         return -1
@@ -447,15 +447,15 @@ def evaluate_trigger(head:, trigger:, visited:, triggers:)
       if visited["#{head.name}__P"][trigger.name]
         # Not sure if this is posible as on create it validates that the dependents are already created
         message = "loop detected from #{head.name} -> #{trigger.name} path: #{visited["#{head.name}__P"]}"
-        notify(name: trigger.name, severity: 'error', message: error.message)
+        notify(name: trigger.name, severity: 'error', message: message)
         return visited["#{trigger.name}__R"] = -1
       end
       trigger.roots.each do | root_trigger_name |
         next if visited["#{root_trigger_name}__R"]
         root_trigger = triggers[root_trigger_name]
         if head.name == root_trigger.name
           message = "loop detected from #{head.name} -> #{root_trigger_name} path: #{visited["#{head.name}__P"]}"
-          notify(name: trigger.name, severity: 'error', message: error.message)
+          notify(name: trigger.name, severity: 'error', message: message)
           return visited["#{trigger.name}__R"] = -1
         end
         result = evaluate_trigger(
@@ -474,9 +474,9 @@ def evaluate_trigger(head:, trigger:, visited:, triggers:)
         else
           right = operand_value(operand: trigger.right, other: trigger.left, visited: visited)
         end
-      rescue => error
+      rescue => e
         # This will primarily happen when the user inputs a bad Regexp
-        notify(name: trigger.name, severity: 'error', message: error.message)
+        notify(name: trigger.name, severity: 'error', message: e.message)
         return visited["#{trigger.name}__R"] = -1
       end
       # Convert the standard '==' and '!=' into Ruby Regexp operators
@@ -560,7 +560,7 @@ def block_for_updates
       while @read_topic
         begin
           Topic.read_topics(@topics) do |topic, _msg_id, msg_hash, _redis|
-            @logger.debug "TriggerGroupManager block_for_updates: #{topic} #{msg_hash.to_s}"
+            @logger.debug "TriggerGroupManager block_for_updates: #{topic} #{msg_hash}"
             if topic != @share.trigger_base.autonomic_topic
               packet = JsonPacket.new(:TLM, msg_hash['target_name'], msg_hash['packet_name'], msg_hash['time'].to_i, false, msg_hash["json_data"])
               @share.packet_base.add(topic: topic, packet: packet)
@@ -580,7 +580,7 @@ def refresh
     def shutdown
       @read_topic = false
       @cancel_thread = true
-      @worker_count.times do | i |
+      @worker_count.times do | _i |
         @queue << nil
       end
     end
@@ -635,7 +635,7 @@ def block_for_updates
         begin
           AutonomicTopic.read_topics(@topics) do |_topic, _msg_id, msg_hash, _redis|
             break if @cancel_thread
-            @logger.debug "TriggerGroupMicroservice block_for_updates: #{msg_hash.to_s}"
+            @logger.debug "TriggerGroupMicroservice block_for_updates: #{msg_hash}"
             # Process trigger notifications created by TriggerModel notify
             if msg_hash['type'] == 'trigger'
               data = JSON.parse(msg_hash['data'], :allow_nan => true, :create_additions => true)

openc3/lib/openc3/models/auth_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
@@ -31,11 +31,11 @@ class AuthModel
     @@token_cache = nil
     @@token_cache_time = nil
 
-    def self.is_set?(key = PRIMARY_KEY)
+    def self.set?(key = PRIMARY_KEY)
       Store.exists(key) == 1
     end
 
-    def self.verify(token, permission: nil)
+    def self.verify(token)
       return false if token.nil? or token.empty?
 
       token_hash = hash(token)
@@ -47,23 +47,21 @@ def self.verify(token, permission: nil)
 
       # Handle a service password - Generally only used by ScriptRunner
       service_password = ENV['OPENC3_SERVICE_PASSWORD']
-      return true if service_password and service_password == token and permission != 'admin'
+      return true if service_password and service_password == token
 
       return false
     end
 
     def self.set(token, old_token, key = PRIMARY_KEY)
       raise "token must not be nil or empty" if token.nil? or token.empty?
 
-      if is_set?(key)
+      if set?(key)
         raise "old_token must not be nil or empty" if old_token.nil? or old_token.empty?
         raise "old_token incorrect" unless verify(old_token)
       end
       Store.set(key, hash(token))
     end
 
-    private
-
     def self.hash(token)
       Digest::SHA2.hexdigest token
     end

openc3/lib/openc3/script/commands.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
@@ -96,7 +96,7 @@ def _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args, scope: $openc3_scop
 
       # Get the command and validate the parameters
       command = $api_server.get_cmd(target_name, cmd_name, scope: scope)
-      cmd_params.each do |param_name, param_value|
+      cmd_params.each do |param_name, _param_value|
         param = command['items'].find { |item| item['name'] == param_name }
         unless param
           raise "Packet item '#{target_name} #{cmd_name} #{param_name}' does not exist"

openc3/lib/openc3/system/system.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
@@ -31,7 +31,6 @@
 require 'openc3/utilities/bucket'
 require 'openc3/utilities/zip'
 require 'openc3/topics/limits_event_topic'
-require 'thread'
 require 'fileutils'
 
 module OpenC3
@@ -109,7 +108,7 @@ def self.setup_targets(target_names, base_dir, scope:)
           # target.txt must be configured to either use all files in cmd_tlm folder (default)
           # or have a predetermined empty file like dynamic_tlm.txt
           bucket_path = "#{scope}/targets_modified/#{target_name}/cmd_tlm"
-          dirs, files = bucket.list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: bucket_path)
+          _, files = bucket.list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: bucket_path)
           files.each do |file|
             bucket_key = File.join(bucket_path, file['name'])
             local_path = "#{base_dir}/targets/#{target_name}/cmd_tlm/#{file['name']}"
@@ -180,8 +179,8 @@ def add_target(target_name, target_config_dir)
       errors = [] # Store all errors processing the cmd_tlm files
       target.cmd_tlm_files.each do |cmd_tlm_file|
         @packet_config.process_file(cmd_tlm_file, target.name, target.language)
-      rescue Exception => error
-        errors << "Error processing #{cmd_tlm_file}:\n#{error.message}"
+      rescue Exception => e
+        errors << "Error processing #{cmd_tlm_file}:\n#{e.message}"
       end
       unless errors.empty?
         raise errors.join("\n")