cosmos 4.4.0 → 4.5.1

data/lib/cosmos/system/system.rb

@@ -20,6 +20,7 @@ require 'drb/acl'
 require 'zip'
 require 'zip/filesystem'
 require 'bundler'
+require 'thread'
 
 module Cosmos
   # System is the primary entry point into the COSMOS framework. It captures
@@ -75,11 +76,20 @@ module Cosmos
     instance_attr_reader :classificiation_banner
     # @return [String] Which hashing algorithm is in use
     instance_attr_reader :hashing_algorithm
+    # @return [Boolean] Allow router commanding - defaults to false
+    instance_attr_reader :allow_router_commanding
+    # @return [String] API access secret using X-Csrf-Token - defaults to SuperSecret
+    instance_attr_reader :x_csrf_token
+    # @return [Array<String>] Allowed origins in http origin header - defaults to no origin header only
+    instance_attr_reader :allowed_origins
+    # @return [Array<String>] Allowed hosts in http host header - defaults to '127.0.0.1:7777' only
+    instance_attr_reader :allowed_hosts
 
     # Known COSMOS ports
-    KNOWN_PORTS = ['CTS_API', 'TLMVIEWER_API', 'CTS_PREIDENTIFIED', 'CTS_CMD_ROUTER', 'REPLAY_API', 'REPLAY_PREIDENTIFIED', 'REPLAY_CMD_ROUTER', 'DART_STREAM', 'DART_DECOM']
+    KNOWN_PORTS = ['CTS_API', 'TLMVIEWER_API', 'CTS_PREIDENTIFIED', 'CTS_CMD_ROUTER', 'REPLAY_API', 'REPLAY_PREIDENTIFIED', 'REPLAY_CMD_ROUTER', 'DART_STREAM', 'DART_DECOM', 'DART_MASTER']
+    API_PORTS = ['CTS_API', 'TLMVIEWER_API', 'REPLAY_API', 'DART_DECOM', 'DART_MASTER']
     # Known COSMOS hosts
-    KNOWN_HOSTS = ['CTS_API', 'TLMVIEWER_API', 'CTS_PREIDENTIFIED', 'CTS_CMD_ROUTER', 'REPLAY_API', 'REPLAY_PREIDENTIFIED', 'REPLAY_CMD_ROUTER', 'DART_STREAM', 'DART_DECOM']
+    KNOWN_HOSTS = ['CTS_API', 'TLMVIEWER_API', 'CTS_PREIDENTIFIED', 'CTS_CMD_ROUTER', 'REPLAY_API', 'REPLAY_PREIDENTIFIED', 'REPLAY_CMD_ROUTER', 'DART_STREAM', 'DART_DECOM', 'DART_MASTER']
     # Known COSMOS paths
     KNOWN_PATHS = ['LOGS', 'TMP', 'SAVED_CONFIG', 'TABLES', 'HANDBOOKS', 'PROCEDURES', 'SEQUENCES', 'DART_DATA', 'DART_LOGS']
     # Supported hashing algorithms
@@ -87,6 +97,7 @@ module Cosmos
 
     @@instance = nil
     @@instance_mutex = Mutex.new
+    @@instance_filename = nil
 
     # Create a new System object. Note, this should not be called directly but
     # you should instead use System.instance and treat this class as a
@@ -96,6 +107,7 @@ module Cosmos
     #   read. Be default this is <Cosmos::USERPATH>/config/system/system.txt
     def initialize(filename = nil)
       raise "Cosmos::System created twice" unless @@instance.nil?
+      @@instance_filename = filename
       reset_variables(filename)
       @@instance = self
     end
@@ -195,6 +207,7 @@ module Cosmos
       @targets = {}
       # Set config to nil so things will lazy load later
       @config = nil
+      @meta_init_filename = nil
       @use_utc = false
       acl_list = []
       all_allowed = false
@@ -207,7 +220,7 @@ module Cosmos
         # First pass - Everything except targets
         parser.parse_file(filename) do |keyword, parameters|
           case keyword
-          when 'AUTO_DECLARE_TARGETS', 'DECLARE_TARGET', 'DECLARE_GEM_TARGET'
+          when 'AUTO_DECLARE_TARGETS', 'DECLARE_TARGET', 'DECLARE_GEM_TARGET', 'DECLARE_GEM_MULTI_TARGET'
             # Will be handled by second pass
 
           when 'PORT'
@@ -215,6 +228,7 @@ module Cosmos
             parser.verify_num_parameters(2, 2, usage)
             port_name = parameters[0].to_s.upcase
             @ports[port_name] = Integer(parameters[1])
+            @allowed_hosts << "127.0.0.1:#{parameters[1]}" if API_PORTS.include?(port_name)
             Logger.warn("Unknown port name given: #{port_name}") unless KNOWN_PORTS.include?(port_name)
 
           when 'LISTEN_HOST', 'CONNECT_HOST'
@@ -371,6 +385,22 @@ module Cosmos
             @classificiation_banner = {'display_text' => parameters[0],
                                        'color'        => color}
 
+          when 'ALLOW_ROUTER_COMMANDING'
+            parser.verify_num_parameters(0, 0, "#{keyword}")
+            @allow_router_commanding = true
+
+          when 'X_CSRF_TOKEN'
+            parser.verify_num_parameters(1, 1, "#{keyword} <Token>")
+            @x_csrf_token = ConfigParser.handle_nil(parameters[0])
+
+          when 'ALLOW_ORIGIN'
+            parser.verify_num_parameters(1, 1, "#{keyword} <Origin>")
+            @allowed_origins << parameters[0]
+
+          when 'ALLOW_HOST'
+            parser.verify_num_parameters(1, 1, "#{keyword} <Host:Port>")
+            @allowed_hosts << parameters[0]
+
           else
             # blank lines will have a nil keyword and should not raise an exception
             raise parser.error("Unknown keyword '#{keyword}'") if keyword
@@ -458,6 +488,19 @@ module Cosmos
           target = Target.new(target_name, substitute_name, configuration_directory, ConfigParser.handle_nil(parameters[2]), gem_dir)
           @targets[target.name] = target
 
+        when 'DECLARE_GEM_MULTI_TARGET'
+          usage = "#{keyword} <GEM NAME> <TARGET NAME> <SUBSTITUTE TARGET NAME (Optional)> <TARGET FILENAME (Optional - defaults to target.txt)>"
+          parser.verify_num_parameters(2, 4, usage)
+
+          target_name = parameters[1].to_s.upcase
+          substitute_name = nil
+          substitute_name = ConfigParser.handle_nil(parameters[2])
+          substitute_name.to_s.upcase if substitute_name
+          gem_dir = Gem::Specification.find_by_name(parameters[0]).gem_dir
+          gem_dir = File.join(gem_dir, target_name)
+          target = Target.new(target_name, substitute_name, configuration_directory, ConfigParser.handle_nil(parameters[3]), gem_dir)
+          @targets[target.name] = target
+
         end # case keyword
       end # parser.parse_file
 
@@ -476,48 +519,65 @@ module Cosmos
     #   configuration. Pass nil to load the default configuration.
     # @return [String, Exception/nil] The actual configuration loaded
     def load_configuration(name = nil)
-      unless @config
-        # Ensure packets have been lazy loaded
-        System.commands
-      end
+      # Ensure packets have been lazy loaded
+      load_packets() unless @config
 
-      if name && @config
-        # Make sure they're requesting something other than the current
-        # configuration.
-        if name != @config.name
-          # If they want the initial configuration we can just swap out the
-          # current configuration without doing any file processing
-          if name == @initial_config.name
-            update_config(@initial_config)
-          else
-            # Look for the requested configuration in the saved configurations
-            configuration = find_configuration(name)
-            if configuration
-              # We found the configuration requested. Reprocess the system.txt
-              # and reload the packets
-              begin
-                unless File.directory?(configuration)
-                  # Zip file configuration so unzip and reset configuration path
-                  configuration = unzip(configuration)
+      @@instance_mutex.synchronize do
+        if @config_blacklist[name]
+          Logger.warn "Ignoring failed config #{name}"
+          update_config(@initial_config)
+          return @config.name, RuntimeError.new("Ignoring failed config #{name}")
+        end
+
+        if name && @config
+          # Make sure they're requesting something other than the current
+          # configuration.
+          if name != @config.name
+            # If they want the initial configuration we can just swap out the
+            # current configuration without doing any file processing
+            if name == @initial_config.name
+              Logger.info "Switching to initial configuration: #{name}"
+              update_config(@initial_config)
+            else
+              # Look for the requested configuration in the saved configurations
+              configuration = find_configuration(name)
+              if configuration
+                # We found the configuration requested. Reprocess the system.txt
+                # and reload the packets
+                begin
+                  unless File.directory?(configuration)
+                    # Zip file configuration so unzip and reset configuration path
+                    configuration = unzip(configuration)
+                  end
+
+                  Logger.info "Switching to configuration: #{name}"
+                  process_file(File.join(configuration, 'system.txt'), configuration)
+                  load_packets(name, false)
+                rescue Exception => error
+                  # Failed to load - Restore initial
+                  @config_blacklist[name] = true # Prevent wasting time trying to load the bad configuration again
+                  Logger.error "Problem loading configuration from #{configuration}: #{error.class}:#{error.message}\n#{error.backtrace.join("\n")}\n"
+                  Logger.info "Switching to initial configuration: #{@initial_config.name}"
+                  update_config(@initial_config)
+                  return @config.name, error
                 end
-                process_file(File.join(configuration, 'system.txt'), configuration)
-                load_packets(name)
-              rescue Exception => error
-                # Failed to load - Restore initial
+              else
+                # We couldn't find the configuration request. Reload the
+                # initial configuration
+                Logger.error "Unable to find configuration: #{name}"
+                Logger.info "Switching to initial configuration: #{@initial_config.name}"
                 update_config(@initial_config)
-                return @config.name, error
+                return @config.name, RuntimeError.new("Unable to find configuration: #{name}")
               end
-            else
-              # We couldn't find the configuration request. Reload the
-              # initial configuration
-              update_config(@initial_config)
             end
           end
+        else
+          Logger.info "Switching to initial configuration: #{@initial_config.name}"
+          update_config(@initial_config)
         end
-      else
-        update_config(@initial_config)
+
+        return @config.name, nil
       end
-      return @config.name, nil
     end
 
     # (see #load_configuration)
@@ -530,7 +590,6 @@ module Cosmos
     # @param filename [String] Path to system.txt config file to process. Defaults to config/system/system.txt
     def reset_variables(filename = nil)
       @targets = {}
-      @targets['UNKNOWN'] = Target.new('UNKNOWN')
       @config = nil
       @commands = nil
       @telemetry = nil
@@ -557,21 +616,22 @@ module Cosmos
       @ports['REPLAY_API'] = 7877
       @ports['REPLAY_PREIDENTIFIED'] = 7879
       @ports['REPLAY_CMD_ROUTER'] = 7880
-      @ports['DART_DECOM'] = 8777
-      @ports['DART_STREAM'] = 8779
+
+      @ports['DART_STREAM'] = 8777
+      @ports['DART_DECOM'] = 8779
+      @ports['DART_MASTER'] = 8780
 
       @listen_hosts = {}
       @listen_hosts['CTS_API'] = '127.0.0.1'
       @listen_hosts['TLMVIEWER_API'] = '127.0.0.1'
-      # Localhost would be more secure but historically these are open to allow for chaining servers by default
-      @listen_hosts['CTS_PREIDENTIFIED'] = '0.0.0.0'
-      @listen_hosts['CTS_CMD_ROUTER'] = '0.0.0.0'
+      @listen_hosts['CTS_PREIDENTIFIED'] = '127.0.0.1'
+      @listen_hosts['CTS_CMD_ROUTER'] = '127.0.0.1'
       @listen_hosts['REPLAY_API'] = '127.0.0.1'
-      # Localhost would be more secure but historically these are open to allow for chaining servers by default
-      @listen_hosts['REPLAY_PREIDENTIFIED'] = '0.0.0.0'
-      @listen_hosts['REPLAY_CMD_ROUTER'] = '0.0.0.0'
-      @listen_hosts['DART_STREAM'] = '0.0.0.0'
-      @listen_hosts['DART_DECOM'] = '0.0.0.0'
+      @listen_hosts['REPLAY_PREIDENTIFIED'] = '127.0.0.1'
+      @listen_hosts['REPLAY_CMD_ROUTER'] = '127.0.0.1'
+      @listen_hosts['DART_STREAM'] = '127.0.0.1'
+      @listen_hosts['DART_DECOM'] = '127.0.0.1'
+      @listen_hosts['DART_MASTER'] = '127.0.0.1'
 
       @connect_hosts = {}
       @connect_hosts['CTS_API'] = '127.0.0.1'
@@ -583,6 +643,7 @@ module Cosmos
       @connect_hosts['REPLAY_CMD_ROUTER'] = '127.0.0.1'
       @connect_hosts['DART_STREAM'] = '127.0.0.1'
       @connect_hosts['DART_DECOM'] = '127.0.0.1'
+      @connect_hosts['DART_MASTER'] = '127.0.0.1'
 
       @paths = {}
       @paths['LOGS'] = File.join(USERPATH, 'outputs', 'logs')
@@ -595,6 +656,11 @@ module Cosmos
       @paths['DART_DATA'] = File.join(USERPATH, 'outputs', 'dart', 'data')
       @paths['DART_LOGS'] = File.join(USERPATH, 'outputs', 'dart', 'logs')
 
+      @allow_router_commanding = false
+      @x_csrf_token = 'SuperSecret'
+      @allowed_origins = []
+      @allowed_hosts = ['127.0.0.1:7777', '127.0.0.1:7778', '127.0.0.1:7877', '127.0.0.1:8779', '127.0.0.1:8780']
+
       unless filename
         system_arg = false
         ARGV.each do |arg|
@@ -611,10 +677,11 @@ module Cosmos
 
       @initial_filename = filename
       @initial_config = nil
+      @config_blacklist = {}
     end
 
     # Reset variables and load packets
-    def reset(filename = nil)
+    def reset(filename = @@instance_filename)
       reset_variables(filename)
       load_packets()
     end
@@ -689,11 +756,31 @@ module Cosmos
       Bundler.load.specs.each do |spec|
         spec_name_split = spec.name.split('-')
         if spec_name_split.length > 1 && (spec_name_split[0] == 'cosmos')
-          # Filter to just targets and not tools and other extensions
-          if File.exist?(File.join(spec.gem_dir, 'cmd_tlm'))
-            target_name = spec_name_split[1..-1].join('-').to_s.upcase
-            target = Target.new(target_name, nil, nil, nil, spec.gem_dir)
-            @targets[target.name] = target
+          # search for multiple targets packaged in a single gem
+          dirs = []
+          Dir.foreach(spec.gem_dir) { |dir_filename| dirs << dir_filename }
+          dirs.sort!
+          dirs.each do |dir_filename|
+            if dir_filename == "."
+              # check the base directory
+              curr_dir = spec.gem_dir
+              target_name = spec_name_split[1..-1].join('-').to_s.upcase
+            else
+              #check for targets in other directories 1 level deep
+              next if dir_filename[0] == '.'               #skip dot directories and ".."
+              next if dir_filename != dir_filename.upcase  #skip non uppercase directories
+              curr_dir = File.join(spec.gem_dir, dir_filename)
+              target_name = dir_filename
+            end
+            # check for the cmd_tlm directory - if it has it, then we have found a target
+            if File.directory?(File.join(curr_dir,'cmd_tlm'))
+              # If any of the targets original directory name matches the
+              # current directory then it must have been already processed by
+              # DECLARE_TARGET so we skip it.
+              next if @targets.select {|name, target| target.original_name == target_name }.length > 0
+              target = Target.new(target_name,nil, nil, nil, spec.gem_dir)
+              @targets[target.name] = target
+           end
           end
         end
       end
@@ -722,9 +809,10 @@ module Cosmos
         configuration = find_configuration(@config.name)
         configuration = File.join(@paths['SAVED_CONFIG'], File.build_timestamped_filename([@config.name], '.zip')) unless configuration
         unless File.exist?(configuration)
+          configuration_tmp = File.join(@paths['SAVED_CONFIG'], File.build_timestamped_filename(['tmp_' + @config.name], '.zip.tmp'))
           begin
             Zip.continue_on_exists_proc = true
-            Zip::File.open(configuration, Zip::File::CREATE) do |zipfile|
+            Zip::File.open(configuration_tmp, Zip::File::CREATE) do |zipfile|
               zip_file_path = File.basename(configuration, ".zip")
               zipfile.mkdir zip_file_path
 
@@ -756,6 +844,7 @@ module Cosmos
                 end
               end
             end
+            File.rename(configuration_tmp, configuration)
             File.chmod(0444, configuration) # Mark readonly
           rescue Exception => error
             Logger.error "Problem saving configuration to #{configuration}: #{error.class}:#{error.message}\n#{error.backtrace.join("\n")}\n"
@@ -764,7 +853,7 @@ module Cosmos
       end
     end
 
-    def load_packets(configuration_name = nil)
+    def load_packets_internal(configuration_name = nil)
       # Determine hashing over all targets cmd_tlm files
       cmd_tlm_files = []
       additional_data = ''
@@ -785,7 +874,6 @@ module Cosmos
       # Only use at most, 32 characters of the hex
       hash_string = hash_string[-32..-1] if hash_string.length >= 32
 
-
       # Build filename for marshal file
       marshal_filename = File.join(@paths['TMP'], 'marshal_' << hash_string << '.bin')
 
@@ -831,6 +919,16 @@ module Cosmos
       save_configuration()
     end
 
+    def load_packets(configuration_name = nil, take_mutex = true)
+      if take_mutex
+        @@instance_mutex.synchronize do
+          load_packets_internal(configuration_name)
+        end
+      else
+        load_packets_internal(configuration_name)
+      end
+    end
+
     def setup_system_meta
       # Ensure SYSTEM META is defined and defined correctly
       begin

data/lib/cosmos/tools/cmd_sender/cmd_param_table_item_delegate.rb

@@ -42,6 +42,9 @@ module Cosmos
     def paint(painter, option, index)
       packet_item, _, _ = @widgets[index.row]
       if index.column == 1 and packet_item and packet_item.states
+        painter.save
+        option = Qt::StyleOptionViewItemV4.new(option)
+        initStyleOption(option, index)
         # This code simply draws the current combo box text inside a button to
         # give the user an idea that they have to click it to activate it
         opt = Qt::StyleOptionButton.new
@@ -49,6 +52,18 @@ module Cosmos
         opt.text = @table.item(index.row, index.column).text.to_s
         Qt::Application.style.drawControl(Qt::Style::CE_PushButton, opt, painter)
         opt.dispose
+        painter.restore
+      # Not sure why but once we re-implement paint() the word wrapping
+      # doesn't work when we simply call super(painter, option, index)
+      # Thus we implement this to support word wrapping on the description
+      elsif index.column == 4
+        painter.save
+        option = Qt::StyleOptionViewItemV4.new(option)
+        initStyleOption(option, index)
+        option.text = index.data().toString()
+        option.features = Qt::StyleOptionViewItemV2::WrapText
+        self.parent().style().drawControl(Qt::Style.CE_ItemViewItem, option, painter)
+        painter.restore
       else
         super(painter, option, index)
       end