openc3 5.11.2 → 5.12.0

data/lib/openc3/script/script.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 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -24,6 +24,7 @@ require 'openc3'
 require 'openc3/api/api'
 require 'openc3/io/json_drb_object'
 require 'openc3/script/api_shared'
+require 'openc3/script/calendar'
 require 'openc3/script/metadata'
 require 'openc3/script/commands'
 require 'openc3/script/telemetry'
@@ -33,7 +34,7 @@ require 'openc3/script/screen'
 require 'openc3/script/script_runner'
 require 'openc3/script/storage'
 require 'openc3/script/web_socket_api'
-require 'openc3/script/gems'
+require 'openc3/script/packages'
 require 'openc3/script/plugins'
 require 'openc3/utilities/authentication'
 
@@ -92,27 +93,48 @@ module OpenC3
       $script_runner_api_server = nil
     end
 
+    # This isn't part of the public API because users should use wait()
+    def openc3_script_sleep(sleep_time = nil)
+      if sleep_time
+        sleep(sleep_time)
+      else
+        prompt("Press any key to continue...")
+      end
+      return false
+    end
+
+    # Internal method used in scripts when encountering a hazardous command
+    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
+
+    ###########################################################################
+    # START PUBLIC API
+    ###########################################################################
+
     def disconnect_script
       $disconnect = true
     end
 
+    # DEPRECATED
     def play_wav_file(wav_filename)
       # NOOP
     end
 
+    # DEPRECATED
     def status_bar(message)
       # NOOP
     end
 
-    def openc3_script_sleep(sleep_time = nil)
-      if sleep_time
-        sleep(sleep_time)
-      else
-        prompt("Press any key to continue...")
-      end
-      return false
-    end
-
     def ask_string(question, blank_or_default = false, password = false)
       answer = ''
       default = ''
@@ -174,19 +196,6 @@ module OpenC3
       _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
@@ -200,6 +209,10 @@ module OpenC3
     def run_mode
       # NOOP
     end
+
+    ###########################################################################
+    # END PUBLIC API
+    ###########################################################################
   end
 
   # Provides a proxy to the JsonDRbObject which communicates with the API server
@@ -253,18 +266,18 @@ module OpenC3
       when :request
         @json_drb.request(*method_params, **kw_params)
       else
+        # If :disconnect is there delete it and return the value
+        # If it is not there, delete returns nil
+        disconnect = kw_params.delete(:disconnect)
         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)
+          return disconnect if 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 =~ /\w*_get$|^get_\w*|\w*_list$|^list_\w*|^tlm|^limits_enabled$|^subscribe$/
-            result = @json_drb.method_missing(method_name, *method_params, **kw_params)
+            return @json_drb.method_missing(method_name, *method_params, **kw_params)
+          else
+            return nil
           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
@@ -317,14 +330,12 @@ module OpenC3
 
     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 :disconnect is there delete it and return the value
+      # If it is not there, delete returns nil
+      disconnect = kw_params.delete(:disconnect)
+      if $disconnect and disconnect
         # If they overrode the return value using the disconnect keyword then return that
-        return disconnect ? disconnect : result
+        return disconnect
       else
         @json_api.request(*method_params, **kw_params)
       end

data/lib/openc3/system/system.rb

@@ -73,6 +73,8 @@ module OpenC3
     end
 
     def self.setup_targets(target_names, base_dir, scope:)
+      # Nothing to do if there are no targets
+      return if target_names.nil? or target_names.length == 0
       if @@instance.nil?
         FileUtils.mkdir_p("#{base_dir}/targets")
         bucket = Bucket.getClient()

data/lib/openc3/system/target.rb

@@ -32,6 +32,9 @@ module OpenC3
     #   the system processes the target.
     attr_reader :name
 
+    # @return [String] Programming language. Must be 'ruby' or 'python'.
+    attr_reader :language
+
     # @return [Array<String>] List of filenames that must be required by Ruby
     #   before parsing the command and telemetry definitions for this target
     attr_reader :requires
@@ -83,6 +86,7 @@ module OpenC3
     # @param path [String] Path to the target directory
     # @param gem_path [String] Path to the gem file or nil if there is no gem
     def initialize(target_name, path, gem_path = nil)
+      @language = 'ruby'
       @requires = []
       @ignored_parameters = []
       @ignored_items = []
@@ -110,10 +114,15 @@ module OpenC3
     #
     # @param filename [String] The target configuration file to parse
     def process_file(filename)
-      Logger.instance.info "Processing target definition in file '#{filename}'"
+      Logger.instance.info "Processing ruby target definition in file '#{filename}'"
       parser = ConfigParser.new("https://openc3.com/docs/v5/target")
       parser.parse_file(filename) do |keyword, parameters|
         case keyword
+        when 'LANGUAGE'
+          usage = "#{keyword} <ruby | python>"
+          parser.verify_num_parameters(1, 1, usage)
+          @language = parameters[0].downcase
+
         when 'REQUIRE'
           usage = "#{keyword} <FILENAME>"
           parser.verify_num_parameters(1, 1, usage)

data/lib/openc3/top_level.rb

@@ -232,8 +232,7 @@ module OpenC3
   def self.create_log_file(filename, log_dir = nil)
     log_file = nil
     begin
-      # The following code goes inside a begin rescue because it reads the
-      # system.txt configuration file. If this has an error we won't be able
+      # If this has an error we won't be able
       # to determine the log path but we still want to write the log.
       log_dir = System.instance.paths['LOGS'] unless log_dir
       # Make sure the log directory exists
@@ -310,6 +309,7 @@ module OpenC3
       file.puts "GEMRC: #{ENV['GEMRC']}"
       file.puts "RI_DEVKIT: #{ENV['RI_DEVKIT']}"
       file.puts "GEM_HOME: #{ENV['GEM_HOME']}"
+      file.puts "PYTHONUSERBASE: #{ENV['PYTHONUSERBASE']}"
       file.puts "PATH: #{ENV['PATH']}"
       file.puts ""
       file.puts "Ruby Path:\n  #{$:.join("\n  ")}\n\n"

data/lib/openc3/utilities/aws_bucket.rb

@@ -81,7 +81,7 @@ module OpenC3
           ]
         }
         EOL
-        @client.put_bucket_policy({ bucket: bucket, policy: policy })
+        @client.put_bucket_policy({ bucket: bucket, policy: policy, checksum_algorithm: "SHA256" })
       end
     end
 
@@ -193,7 +193,8 @@ module OpenC3
     # put_object fires off the request to store but does not confirm
     def put_object(bucket:, key:, body:, content_type: nil, cache_control: nil, metadata: nil)
       @client.put_object(bucket: bucket, key: key, body: body,
-        content_type: content_type, cache_control: cache_control, metadata: metadata)
+        content_type: content_type, cache_control: cache_control, metadata: metadata,
+        checksum_algorithm: "SHA256")
     end
 
     # @returns [Boolean] Whether the file exists

data/lib/openc3/utilities/bucket_file_cache.rb

@@ -87,7 +87,7 @@ class BucketFile
           # Try to retrieve the file three times
           retry_count += 1
           raise err if retry_count >= 3
-          Logger.warn("Error retrieving log file from bucket - retry #{retry_count}: #{@bucket_path}\n#{err.formatted}")
+          OpenC3::Logger.warn("Error retrieving log file from bucket - retry #{retry_count}: #{@bucket_path}\n#{err.formatted}")
           sleep(1)
           retry
         end

data/lib/openc3/utilities/local_mode.rb

@@ -26,7 +26,7 @@ require 'openc3/utilities/bucket'
 module OpenC3
   module LocalMode
     OPENC3_LOCAL_MODE_PATH = ENV['OPENC3_LOCAL_MODE_PATH'] || "/plugins"
-
+    # When updating update local_mode.py, PluginsTab.vue, plugins.spec.ts
     DEFAULT_PLUGINS = [
       'openc3-cosmos-tool-admin',
       'openc3-cosmos-tool-autonomic',
@@ -36,7 +36,9 @@ module OpenC3
       'openc3-cosmos-tool-cmdtlmserver',
       'openc3-cosmos-tool-dataextractor',
       'openc3-cosmos-tool-dataviewer',
+      'openc3-cosmos-tool-docs',
       'openc3-cosmos-tool-handbooks',
+      'openc3-cosmos-tool-iframe',
       'openc3-cosmos-tool-limitsmonitor',
       'openc3-cosmos-tool-packetviewer',
       'openc3-cosmos-tool-scriptrunner',

data/lib/openc3/utilities/logger.rb

@@ -180,7 +180,7 @@ module OpenC3
         data = { time: time.to_nsec_from_epoch, '@timestamp' => time.xmlschema(3), severity: severity_string }
         data[:microservice_name] = @microservice_name if @microservice_name
         data[:detail] = @detail_string if @detail_string
-        data[:user] = user['username'] || 'Unknown' if user # EE: If a user is passed, put its name ('Unknown' if it doesn't have a name). Don't include user data if no user was passed
+        data[:user] = user if user # EE: If a user is passed, put its name. Don't include user data if no user was passed.
         if block_given?
           message = yield
         end

data/lib/openc3/utilities/ruby_lex_utils.rb

@@ -41,14 +41,6 @@ class RubyLex
     @prompt = nil
     initialize_input()
   end
-
-  major, minor, _ = RUBY_VERSION.split('.')
-  if major == '3' and minor.to_i < 2
-    alias orig_lex lex
-    def lex(context)
-      orig_lex()
-    end
-  end
 end
 $VERBOSE = old_verbose
 

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.11.2'
+OPENC3_VERSION = '5.12.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '11'
-    PATCH = '2'
+    MINOR = '12'
+    PATCH = '0'
     OTHER = ''
-    BUILD = '88e94fd126464b6e8f8bdbda57b0e41d5577f5b5'
+    BUILD = '8f36977eacfebdcdae21f02223be66e69feaa2bf'
   end
-  VERSION = '5.11.2'
-  GEM_VERSION = '5.11.2'
+  VERSION = '5.12.0'
+  GEM_VERSION = '5.12.0'
 end

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.11.2",
+  "version": "5.12.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,22 +12,22 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.11.2",
-    "@angular/animations": "^16.2.4",
-    "@angular/cdk": "^16.2.3",
-    "@angular/common": "^16.2.4",
-    "@angular/compiler": "^16.2.4",
-    "@angular/core": "^16.2.4",
-    "@angular/forms": "^16.2.4",
-    "@angular/material": "16.2.3",
-    "@angular/platform-browser": "^16.2.4",
-    "@angular/platform-browser-dynamic": "^16.2.4",
-    "@angular/router": "^16.2.4",
+    "@openc3/tool-common": "5.12.0",
+    "@angular/animations": "^16.2.12",
+    "@angular/cdk": "^16.2.11",
+    "@angular/common": "^16.2.12",
+    "@angular/compiler": "^16.2.12",
+    "@angular/core": "^16.2.12",
+    "@angular/forms": "^16.2.12",
+    "@angular/material": "16.2.11",
+    "@angular/platform-browser": "^16.2.12",
+    "@angular/platform-browser-dynamic": "^16.2.12",
+    "@angular/router": "^16.2.12",
     "rxjs": "~7.8.0",
     "single-spa": ">=5.9.5",
-    "single-spa-angular": "^8.1.0",
+    "single-spa-angular": "^9.0.1",
     "tslib": "^2.6.2",
-    "zone.js": "~0.13.3"
+    "zone.js": "~0.14.2"
   },
   "devDependencies": {
     "@angular-builders/custom-webpack": "16.0.1",