openc3 5.0.6

data/lib/openc3/script/script.rb

@@ -0,0 +1,299 @@
+# encoding: ascii-8bit
+
+# 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
+
+require 'openc3'
+require 'openc3/api/api'
+require 'openc3/io/json_drb_object'
+require 'openc3/script/api_shared'
+require 'openc3/script/calendar'
+require 'openc3/script/commands'
+require 'openc3/script/limits'
+require 'openc3/script/exceptions'
+require 'openc3/script/script_runner'
+require 'openc3/script/storage'
+require 'openc3/utilities/authentication'
+
+$api_server = nil
+$disconnect = false
+$openc3_scope = ENV['OPENC3_SCOPE'] || 'DEFAULT'
+$openc3_in_cluster = false
+
+module OpenC3
+  module Script
+    private
+
+    include ApiShared
+
+    # All methods are private so they can only be called by themselves and not
+    # on another object. This is important for the JsonDrbObject class which we
+    # use to communicate with the server. JsonDrbObject implements method_missing
+    # to forward calls to the remote service. If these methods were not private,
+    # they would be included on the $api_server global and would be
+    # called directly instead of being forwarded over the JsonDrb connection to
+    # the real server.
+
+    # For each of the Api methods determine if they haven't previously been defined by
+    # one of the script files. If not define them and proxy to the $api_server.
+    Api::WHITELIST.each do |method|
+      unless private_instance_methods(false).include?(method.intern)
+        define_method(method.intern) do |*args, **kwargs, &block|
+          kwargs[:scope] = $openc3_scope unless kwargs[:scope]
+          $api_server.method_missing(method.intern, *args, **kwargs, &block)
+        end
+      end
+    end
+
+    # Called when this module is mixed in using "include OpenC3::Script"
+    def self.included(base)
+      initialize_script()
+    end
+
+    def initialize_script
+      shutdown_script()
+      $disconnect = false
+      $api_server = ServerProxy.new
+      if $api_server.generate_url =~ /openc3-cmd-tlm-api/
+        $openc3_in_cluster = true
+      else
+        $openc3_in_cluster = false
+      end
+      $script_runner_api_server = ScriptServerProxy.new
+    end
+
+    def shutdown_script
+      $api_server.shutdown if $api_server
+      $api_server = nil
+      $script_runner_api_server.shutdown if $script_runner_api_server
+      $script_runner_api_server = nil
+    end
+
+    def disconnect_script
+      $disconnect = true
+    end
+
+    def play_wav_file(wav_filename)
+      # NOOP
+    end
+
+    def status_bar(message)
+      # NOOP
+    end
+
+    def ask_string(question, blank_or_default = false, password = false)
+      answer = ''
+      default = ''
+      if blank_or_default != true && blank_or_default != false
+        question << " (default = #{blank_or_default})"
+        allow_blank = true
+      else
+        allow_blank = blank_or_default
+      end
+      while answer.empty?
+        print question + " "
+        answer = gets
+        answer.chomp!
+        break if allow_blank
+      end
+      answer = default if answer.empty? and !default.empty?
+      return answer
+    end
+
+    def ask(question, blank_or_default = false, password = false)
+      string = ask_string(question, blank_or_default, password)
+      value = string.convert_to_value
+      return value
+    end
+
+    def message_box(string, *buttons, **options)
+      print "#{string} (#{buttons.join(", ")}): "
+      print "Details: #{details}\n" if details
+      gets.chomp
+    end
+
+    def vertical_message_box(string, *buttons, **options)
+      message_box(string, *buttons, **options)
+    end
+
+    def combo_box(string, *items, **options)
+      message_box(string, *items, **options)
+    end
+
+    def _file_dialog(title, message, filter:)
+      answer = ''
+      path = "./*"
+      path += filter if filter
+      files = Dir[path]
+      files.select! { |f| !File.directory? f }
+      while answer.empty?
+        print "#{title}\n#{message}\n#{files.join("\n")}\n<Type file name>:"
+        answer = gets
+        answer.chomp!
+      end
+      return answer
+    end
+
+    def open_file_dialog(title, message = "Open File", filter:)
+      _file_dialog(title, message, filter)
+    end
+
+    def open_files_dialog(title, message = "Open File(s)", filter:)
+      _file_dialog(title, message, filter)
+    end
+
+    def prompt_for_hazardous(target_name, cmd_name, hazardous_description)
+      loop do
+        message = "Warning: Command #{target_name} #{cmd_name} is Hazardous. "
+        message << "\n#{hazardous_description}\n" if hazardous_description
+        message << "Send? (y): "
+        print message
+        answer = gets.chomp
+        if answer.downcase == 'y'
+          return true
+        end
+      end
+    end
+
+    def prompt(string, text_color: nil, background_color: nil, font_size: nil, font_family: nil, details: nil)
+      print "#{string}: "
+      print "Details: #{details}\n" if details
+      gets.chomp
+    end
+  end
+
+  # Provides a proxy to the JsonDRbObject which communicates with the API server
+  class ServerProxy
+    # pull openc3-cmd-tlm-api url from environment variables
+    def generate_url
+      schema = ENV['OPENC3_API_SCHEMA'] || 'http'
+      hostname = ENV['OPENC3_API_HOSTNAME'] || (ENV['OPENC3_DEVEL'] ? '127.0.0.1' : 'openc3-cmd-tlm-api')
+      port = ENV['OPENC3_API_PORT'] || '2901'
+      port = port.to_i
+      return "#{schema}://#{hostname}:#{port}"
+    end
+
+    # pull openc3-cmd-tlm-api timeout from environment variables
+    def generate_timeout
+      timeout = ENV['OPENC3_API_TIMEOUT'] || '1.0'
+      return timeout.to_f
+    end
+
+    # generate the auth object
+    def generate_auth
+      if ENV['OPENC3_API_USER'].nil?
+        return OpenC3Authentication.new()
+      else
+        return OpenC3KeycloakAuthentication.new(ENV['OPENC3_KEYCLOAK_URL'])
+      end
+    end
+
+    # Create a JsonDRbObject connection to the API server
+    def initialize
+      @json_drb = JsonDRbObject.new(
+        url: generate_url(),
+        timeout: generate_timeout(),
+        authentication: generate_auth()
+      )
+    end
+
+    # Ruby method which captures any method calls on this object. This allows
+    # us to proxy the methods to the API server through the JsonDRbObject.
+    def method_missing(method_name, *method_params, **kw_params)
+      # Must call shutdown and disconnect on the JsonDRbObject itself
+      # to avoid it being sent to the API
+      kw_params[:scope] = $openc3_scope unless kw_params[:scope]
+      case method_name
+      when :shutdown
+        @json_drb.shutdown
+      when :request
+        @json_drb.request(*method_params, **kw_params)
+      else
+        if $disconnect
+          result = nil
+          # If :disconnect is there delete it and return the value
+          # If it is not there, delete returns nil
+          disconnect = kw_params.delete(:disconnect)
+          # The only commands allowed through in disconnect mode are read-only
+          # Thus we allow the get, list, tlm and limits_enabled and subscribe methods
+          if method_name =~ /get_\w*|list_\w*|^tlm|limits_enabled|subscribe/
+            result = @json_drb.method_missing(method_name, *method_params, **kw_params)
+          end
+          # If they overrode the return value using the disconnect keyword then return that
+          return disconnect ? disconnect : result
+        else
+          @json_drb.method_missing(method_name, *method_params, **kw_params)
+        end
+      end
+    end
+  end
+
+  # Provides a proxy to the Script Runner Api which communicates with the API server
+  class ScriptServerProxy
+    # pull openc3-script-runner-api url from environment variables
+    def generate_url
+      schema = ENV['OPENC3_SCRIPT_API_SCHEMA'] || 'http'
+      hostname = ENV['OPENC3_SCRIPT_API_HOSTNAME'] || (ENV['OPENC3_DEVEL'] ? '127.0.0.1' : 'openc3-script-runner-api')
+      port = ENV['OPENC3_SCRIPT_API_PORT'] || '2902'
+      port = port.to_i
+      return "#{schema}://#{hostname}:#{port}"
+    end
+
+    # pull openc3-cmd-tlm-api timeout from environment variables
+    def generate_timeout
+      timeout = ENV['OPENC3_SCRIPT_API_TIMEOUT'] || '5.0'
+      return timeout.to_f
+    end
+
+    # generate the auth object
+    def generate_auth
+      if ENV['OPENC3_API_USER'].nil?
+        return OpenC3Authentication.new()
+      else
+        return OpenC3KeycloakAuthentication.new(ENV['OPENC3_KEYCLOAK_URL'])
+      end
+    end
+
+    # Create a JsonDRbObject connection to the API server
+    def initialize
+      @json_api = JsonApiObject.new(
+        url: generate_url(),
+        timeout: generate_timeout(),
+        authentication: generate_auth()
+      )
+    end
+
+    def shutdown
+      @json_api.shutdown
+    end
+
+    def request(*method_params, **kw_params)
+      kw_params[:scope] = $openc3_scope unless kw_params[:scope]
+      if $disconnect
+        result = nil
+        # If :disconnect is there delete it and return the value
+        # If it is not there, delete returns nil
+        disconnect = kw_params.delete(:disconnect)
+
+        # If they overrode the return value using the disconnect keyword then return that
+        return disconnect ? disconnect : result
+      else
+        @json_api.request(*method_params, **kw_params)
+      end
+    end
+  end
+end

data/lib/openc3/script/script_runner.rb

@@ -0,0 +1,238 @@
+# 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
+  module Script
+    private
+
+    def _script_response_error(response, message, scope: $openc3_scope)
+      if response
+        raise "#{message} (#{response.code}): #{response.body}"
+      else
+        raise "#{message}: No Response"
+      end
+    end
+
+    def script_list(scope: $openc3_scope)
+      endpoint = "/script-api/scripts"
+      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Script list request failed", scope: scope)
+      else
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+      end
+    end
+
+    def script_syntax_check(script, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/syntax"
+      response = $script_runner_api_server.request('post', endpoint, :data => script, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Script syntax check request failed", scope: scope)
+      else
+        result = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        if result['title'] == "Syntax Check Successful"
+          return true
+        else
+          raise result.inspect
+        end
+      end
+    end
+
+    def script_body(filename, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}"
+      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Failed to get #{filename}", scope: scope)
+      else
+        script = response.body
+        return script
+      end
+    end
+
+    def script_run(filename, disconnect: false, scope: $openc3_scope)
+      if disconnect
+        endpoint = "/script-api/scripts/#{filename}/run/disconnect"
+      else
+        endpoint = "/script-api/scripts/#{filename}/run"
+      end
+      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Failed to run #{filename}", scope: scope)
+      else
+        script_id = Integer(response.body)
+        return script_id
+      end
+    end
+
+    def script_delete(filename, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}/delete"
+      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Failed to delete #{filename}", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def script_lock(filename, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}/lock"
+      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Failed to lock #{filename}", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def script_unlock(filename, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}/unlock"
+      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Failed to unlock #{filename}", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def script_instrumented(filename, script, scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}/instrumented"
+      response = $script_runner_api_server.request('post', endpoint, :data => script, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Script instrumented request failed", scope: scope)
+      else
+        result = JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        if result['title'] == "Instrumented Script"
+          parsed = JSON.parse(result['description'], :allow_nan => true, :create_additions => true)
+          return parsed.join("\n")
+        else
+          raise result.inspect
+        end
+      end
+    end
+
+    def script_create(filename, script, breakpoints = [], scope: $openc3_scope)
+      endpoint = "/script-api/scripts/#{filename}"
+      response = $script_runner_api_server.request('post', endpoint, :data => {text: script, breakpoints: breakpoints}, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Script create request failed", scope: scope)
+      else
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+      end
+    end
+
+    def script_delete_all_breakpoints(scope: $openc3_scope)
+      endpoint = "/script-api/breakpoints/delete/all"
+      response = $script_runner_api_server.request('delete', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Script delete all breakpoints failed", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def running_script_list(scope: $openc3_scope)
+      endpoint = "/script-api/running-script"
+      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Running script list request failed", scope: scope)
+      else
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+      end
+    end
+
+    def running_script_get(id, scope: $openc3_scope)
+      endpoint = "/script-api/running-script/#{id}"
+      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Running script show request failed", scope: scope)
+      else
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+      end
+    end
+
+    def _running_script_action(id, action_name, scope: $openc3_scope)
+      endpoint = "/script-api/running-script/#{id}/#{action_name}"
+      response = $script_runner_api_server.request('post', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Running script #{action_name} request failed", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def running_script_stop(id, scope: $openc3_scope)
+      _running_script_action(id, 'stop', scope: scope)
+    end
+
+    def running_script_pause(id, scope: $openc3_scope)
+      _running_script_action(id, 'pause', scope: scope)
+    end
+
+    def running_script_retry(id, scope: $openc3_scope)
+      _running_script_action(id, 'retry', scope: scope)
+    end
+
+    def running_script_go(id, scope: $openc3_scope)
+      _running_script_action(id, 'go', scope: scope)
+    end
+
+    def running_script_step(id, scope: $openc3_scope)
+      _running_script_action(id, 'step', scope: scope)
+    end
+
+    def running_script_delete(id, scope: $openc3_scope)
+      _running_script_action(id, 'delete', scope: scope)
+    end
+
+    def running_script_backtrace(id, scope: $openc3_scope)
+      _running_script_action(id, 'backtrace', scope: scope)
+    end
+
+    def running_script_debug(id, debug_code, scope: $openc3_scope)
+      endpoint = "/script-api/running-script/#{id}/debug"
+      response = $script_runner_api_server.request('post', endpoint, data: {'args' => debug_code}, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Running script debug request failed", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def running_script_prompt(id, method_name, answer, prompt_id, password: nil, scope: $openc3_scope)
+      endpoint = "/script-api/running-script/#{id}/prompt"
+      if password
+        response = $script_runner_api_server.request('post', endpoint, data: {'method' => method_name, 'answer' => answer, 'prompt_id' => prompt_id, 'password' => password}, scope: scope)
+      else
+        response = $script_runner_api_server.request('post', endpoint, data: {'method' => method_name, 'answer' => answer, 'prompt_id' => prompt_id}, scope: scope)
+      end
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Running script prompt request failed", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def completed_script_list(scope: $openc3_scope)
+      endpoint = "/script-api/completed-scripts"
+      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      if response.nil? || response.code != 200
+        _script_response_error(response, "Completed script list request failed", scope: scope)
+      else
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+      end
+    end
+
+  end
+end

data/lib/openc3/script/storage.rb

@@ -0,0 +1,146 @@
+# encoding: ascii-8bit
+
+# 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
+
+require 'net/http'
+
+module OpenC3
+  module Script
+    private
+
+    # Delete a file on a target
+    #
+    # @param [String] Path to a file in a target directory
+    def delete_target_file(path, scope: $openc3_scope)
+      begin
+        # Only delete from the targets_modified
+        delete_path = "#{scope}/targets_modified/#{path}"
+        endpoint = "/openc3-api/storage/delete/#{delete_path}"
+        OpenC3::Logger.info "Deleting #{delete_path}"
+        response = $api_server.request('delete', endpoint, query: {bucket: 'config'}, scope: scope)
+        if response.nil? || response.code != 200
+          raise "Failed to delete #{delete_path}. Note: #{scope}/targets is read-only."
+        end
+      rescue => error
+        raise "Failed deleting #{path} due to #{error.message}"
+      end
+      nil
+    end
+
+    # Get a handle to write a target file
+    #
+    # @param path [String] Path to a file in a target directory
+    # @param io_or_string [Io or String] IO object
+    def put_target_file(path, io_or_string, scope: $openc3_scope)
+      raise "Disallowed path modifier '..' found in #{path}" if path.include?('..')
+      upload_path = "#{scope}/targets_modified/#{path}"
+      endpoint = "/openc3-api/storage/upload/#{upload_path}"
+      OpenC3::Logger.info "Writing #{upload_path}"
+      result = _get_presigned_request(endpoint, scope: scope)
+
+      # Try to put the file
+      success = false
+      begin
+        uri = _get_uri(result['url'])
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          request = Net::HTTP::Put.new(uri, {'Content-Length' => io_or_string.length.to_s})
+          if String === io_or_string
+            request.body = io_or_string
+          else
+            request.body_stream = io_or_string
+          end
+          result = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+            http.request(request)
+          end
+          return result
+        end
+      rescue => error
+        raise "Failed to write #{upload_path}"
+      end
+      nil
+    end
+
+    # Get a handle to access a target file
+    #
+    # @param path [String] Path to a file in a target directory, e.g. "INST/procedures/test.rb"
+    # @param original [Boolean] Whether to get the original or modified file
+    # @return [File|nil]
+    def get_target_file(path, original: false, scope: $openc3_scope)
+      part = "targets"
+      part += "_modified" unless original
+      # Loop to allow redo when switching from modified to original
+      loop do
+        begin
+          return _get_storage_file("#{part}/#{path}", scope: scope)
+        rescue => error
+          if part == "targets_modified"
+            part = "targets"
+            redo
+          else
+            raise error
+          end
+        end
+        break
+      end
+    end
+
+    # These are helper methods ... should not be used directly
+
+    def _get_storage_file(path, scope: $openc3_scope)
+      # Create Tempfile to store data
+      file = Tempfile.new('target', binmode: true)
+
+      endpoint = "/openc3-api/storage/download/#{scope}/#{path}"
+      OpenC3::Logger.info "Reading #{scope}/#{path}"
+      result = _get_presigned_request(endpoint, scope: scope)
+
+      # Try to get the file
+      uri = _get_uri(result['url'])
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Get.new uri
+        http.request request do |response|
+          response.read_body do |chunk|
+            file.write chunk
+          end
+        end
+        file.rewind
+      end
+      return file
+    end
+
+    def _get_uri(url)
+      if $openc3_in_cluster
+        uri = URI.parse("http://openc3-minio:9000" + url)
+      else
+        uri = URI.parse($api_server.generate_url + url)
+      end
+    end
+
+    def _get_presigned_request(endpoint, scope: $openc3_scope)
+      if $openc3_in_cluster
+        response = $api_server.request('get', endpoint, query: { bucket: 'config', internal: true }, scope: scope)
+      else
+        response = $api_server.request('get', endpoint, query: { bucket: 'config' }, scope: scope)
+      end
+      if response.nil? || response.code != 201
+        raise "Failed to get presigned URL for #{endpoint}"
+      end
+      JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+    end
+  end
+end