cosmos 4.4.2 → 4.5.0

data/lib/cosmos/io/win32_serial_driver.rb

@@ -24,7 +24,8 @@ module Cosmos
                    read_polling_period = 0.01,
                    read_max_length = 1000,
                    flow_control = :NONE,
-                   data_bits = 8)
+                   data_bits = 8,
+                   struct = [])
 
       # Verify Parameters
       port_name = '\\\\.\\' + port_name if port_name =~ /^COM[0-9]{2,3}$/
@@ -78,6 +79,12 @@ module Cosmos
         # 0x03 - RTS_CONTROL_TOGGLE - Specifies that the RTS line will be high if bytes are available for transmission. After all buffered bytes have been sent, the RTS line will be low.
         dcb.write('fRtsControl', 0x03)
       end
+      # Allow the end user to write arbitrary values into the Windows DCB structure
+      unless struct.empty?
+        struct.each do |key, value|
+          dcb.write(key, value.to_i)
+        end
+      end
       Win32.set_comm_state(@handle, dcb)
 
       # Configure Timeouts, the WinAPI structure is COMMTIMEOUTS:

data/lib/cosmos/packets/structure.rb

@@ -464,9 +464,18 @@ module Cosmos
 
     protected
 
+    MUTEX = Mutex.new
+
+    def setup_mutex
+      return if @mutex
+      MUTEX.synchronize do
+        @mutex ||= Mutex.new
+      end
+    end
+
     # Take the structure mutex to ensure the buffer does not change while you perform activities
     def synchronize
-      @mutex ||= Mutex.new
+      setup_mutex()
       @mutex.synchronize {|| yield}
     end
 
@@ -476,7 +485,7 @@ module Cosmos
     #      lower level calls to go forward without getting the mutex
     def synchronize_allow_reads(top = false)
       @mutex_allow_reads ||= false
-      @mutex ||= Mutex.new
+      setup_mutex()
       if top
         @mutex.synchronize do
           @mutex_allow_reads = Thread.current

data/lib/cosmos/script/api_shared.rb

@@ -9,6 +9,13 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
+  # Error raised by the API when a check fails
+  class CheckError < RuntimeError; end
+  # Error raised when a Script should be stopped
+  class StopScript < StandardError; end
+  # Error raised when a TestCase should be skipped by TestRunner
+  class SkipTestCase < StandardError; end
+
   module ApiShared
     DEFAULT_TLM_POLLING_RATE = 0.25
 
@@ -942,7 +949,7 @@ module Cosmos
     end
 
     def run_tlm_viewer(action, display_name = '')
-      tlm_viewer = JsonDRbObject.new System.connect_hosts['TLMVIEWER_API'], System.ports['TLMVIEWER_API']
+      tlm_viewer = JsonDRbObject.new System.connect_hosts['TLMVIEWER_API'], System.ports['TLMVIEWER_API'], 1.0, Cosmos::System.x_csrf_token
       begin
         yield tlm_viewer
         tlm_viewer.disconnect

data/lib/cosmos/script/script.rb

@@ -25,13 +25,6 @@ $disconnect_all_targets = false
 $cmd_tlm_replay_mode = false
 
 module Cosmos
-  # Error raised by the API when a check fails
-  class CheckError < RuntimeError; end
-  # Error raised when a Script should be stopped
-  class StopScript < StandardError; end
-  # Error raised when a TestCase should be skipped by TestRunner
-  class SkipTestCase < StandardError; end
-
   # Provides a proxy to both a disconnected CmdTlmServer instance and the real
   # JsonDRbObject which communicates with the real CmdTlmServer. If targets
   # are disconnected their method calls are forwarded to the disconnected
@@ -49,9 +42,9 @@ module Cosmos
       end
       # Start a Json connect to the real server
       if $cmd_tlm_replay_mode
-        @cmd_tlm_server = JsonDRbObject.new(System.connect_hosts['REPLAY_API'], System.ports['REPLAY_API'])
+        @cmd_tlm_server = JsonDRbObject.new(System.connect_hosts['REPLAY_API'], System.ports['REPLAY_API'], 1.0, Cosmos::System.x_csrf_token)
       else
-        @cmd_tlm_server = JsonDRbObject.new(System.connect_hosts['CTS_API'], System.ports['CTS_API'])
+        @cmd_tlm_server = JsonDRbObject.new(System.connect_hosts['CTS_API'], System.ports['CTS_API'], 1.0, Cosmos::System.x_csrf_token)
       end
     end
 

data/lib/cosmos/streams/serial_stream.rb

@@ -35,8 +35,10 @@ module Cosmos
     #   complete. Pass nil to create no timeout. The {SerialDriver} will
     #   continously try to read data until it has received data or an error
     #   occurs.
-    # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
+    # @param flow_control [Symbol] Currently supported :NONE, :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
+    # @param struct [Array] Array of arrays of fields and values to set in the
+    #   Windows DCB or POSIX structure
     def initialize(write_port_name,
                    read_port_name,
                    baud_rate,
@@ -45,7 +47,8 @@ module Cosmos
                    write_timeout,
                    read_timeout,
                    flow_control = :NONE,
-                   data_bits = 8)
+                   data_bits = 8,
+                   struct = [])
       super()
 
       # The SerialDriver class will validate the parameters
@@ -69,7 +72,8 @@ module Cosmos
                                               @write_timeout,
                                               @read_timeout,
                                               @flow_control,
-                                              @data_bits)
+                                              @data_bits,
+                                              struct)
       else
         @write_serial_port = nil
       end
@@ -84,7 +88,8 @@ module Cosmos
                                                @write_timeout,
                                                @read_timeout,
                                                @flow_control,
-                                               @data_bits)
+                                               @data_bits,
+                                               struct)
         end
       else
         @read_serial_port = nil
@@ -151,5 +156,5 @@ module Cosmos
         @connected = false
       end
     end
-  end # class SerialStream
-end # module Cosmos
+  end
+end

data/lib/cosmos/system/system.rb

@@ -76,9 +76,18 @@ 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', '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', 'DART_MASTER']
     # Known COSMOS paths
@@ -88,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
@@ -97,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
@@ -217,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'
@@ -373,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
@@ -521,7 +549,7 @@ module Cosmos
                     # 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)
@@ -547,7 +575,7 @@ module Cosmos
           Logger.info "Switching to initial configuration: #{@initial_config.name}"
           update_config(@initial_config)
         end
-        
+
         return @config.name, nil
       end
     end
@@ -596,16 +624,14 @@ module Cosmos
       @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['DART_MASTER'] = '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'
@@ -630,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|
@@ -650,7 +681,7 @@ module Cosmos
     end
 
     # Reset variables and load packets
-    def reset(filename = nil)
+    def reset(filename = @@instance_filename)
       reset_variables(filename)
       load_packets()
     end

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

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

@@ -67,7 +67,7 @@ module Cosmos
     # @return [Hash] Hash keyed by parameter name with String formatted value
     def params_text(raw = false)
       params = {}
-      Qt.execute_in_main_thread do 
+      Qt.execute_in_main_thread do
         @param_widgets.each do |packet_item, value_item, state_value_item|
           text = value_item.text
           text = state_value_item.text if state_value_item && (text == MANUALLY or raw)
@@ -197,7 +197,7 @@ module Cosmos
       end
     end
 
-    private 
+    private
 
     def get_params(show_ignored)
       params = {}
@@ -322,7 +322,7 @@ module Cosmos
         value_text = "0x" + value_text.simple_formatted
       # Add quotes around STRING or BLOCK defaults so they are interpreted correctly
       elsif (packet_item.data_type == :STRING or packet_item.data_type == :BLOCK)
-        value_text = "'#{packet_item.default}'"
+        value_text = "'#{value_text}'"
       end
       value_item = Qt::TableWidgetItem.new(value_text)
       value_item.setTextAlignment(Qt::AlignRight | Qt::AlignVCenter)
@@ -338,6 +338,14 @@ module Cosmos
         if item.column == 1
           if packet_item.states
             value = packet_item.states[value_item.text]
+            if packet_item.hazardous && packet_item.hazardous.key?(value_item.text)
+              desc = packet_item.hazardous[value]
+              # Hazardous states aren't required to have a description so use the item description
+              desc = packet_item.description unless desc
+              @table.item(item.row, 4).setText("(Hazardous) #{desc}")
+            else
+              @table.item(item.row, 4).setText(packet_item.description)
+            end
             @table.blockSignals(true)
             if CmdParams.states_in_hex && value.kind_of?(Integer)
               state_value_item.setText(sprintf("0x%X", value))
@@ -351,10 +359,24 @@ module Cosmos
           @table.item(item.row, 1).setText(MANUALLY)
           @table.blockSignals(false)
         end
+        calculate_height()
         emit modified()
       end
+      calculate_height()
+    end
+
+    def calculate_height
       @table.resizeColumnsToContents()
       @table.resizeRowsToContents()
+      height = @table.horizontalHeader.height + 2 # 2 = Header frame?
+      @table.rowCount.times do |i|
+        # TODO: rowHeight does not reflect word wrapping ... it's always 37
+        height += @table.rowHeight(i)
+        # NOTE: Checking the fontMetrics boundingRect also does not refect word wrapping
+        #   e.g. Cosmos.getFontMetrics(@table.font).boundingRect(@table.item(x,y).text).height
+      end
+      @table.setMaximumHeight(height)
+      @table.setMinimumHeight(height)
     end
   end
 end

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

@@ -491,6 +491,13 @@ module Cosmos
       packet_name = @cmd_select.text
       if target_name && packet_name
         packet = System.commands.packet(target_name, packet_name)
+        # Directly update packet description ... safe because always in GUI thread
+        hazardous, _ = System.commands.cmd_hazardous?(target_name, packet_name)
+        if hazardous
+          @description.text = "(Hazardous) #{packet.description}"
+        else
+          @description.text = packet.description
+        end
         table = @cmd_params.update_cmd_params(packet, show_ignored: checked)
         @table_layout.addWidget(table, 500) if table
       end

data/lib/cosmos/tools/cmd_sequence/sequence_item.rb

@@ -56,11 +56,6 @@ module Cosmos
 
     def add_table(table)
       return unless table
-      table.setSizePolicy(Qt::SizePolicy.Minimum, Qt::SizePolicy.Minimum)
-      table.setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff)
-      table.setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff)
-      table.setFixedSize(table.horizontalHeader.length + table.verticalHeader.width,
-                         2 + table.verticalHeader.length + table.horizontalHeader.height)
       @table_layout.addWidget(table) 
     end
       

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server.rb

@@ -201,9 +201,9 @@ module Cosmos
         @json_drb.method_whitelist = @api_whitelist
         begin
           if @mode == :CMD_TLM_SERVER
-            @json_drb.start_service(System.listen_hosts['CTS_API'], System.ports['CTS_API'], self)
+            @json_drb.start_service(System.listen_hosts['CTS_API'], System.ports['CTS_API'], self, 1000, System)
           else
-            @json_drb.start_service(System.listen_hosts['REPLAY_API'], System.ports['REPLAY_API'], self)
+            @json_drb.start_service(System.listen_hosts['REPLAY_API'], System.ports['REPLAY_API'], self, 1000, System)
           end
         rescue Exception
           # Call packet_logging shutdown here to explicitly kill the logging

data/lib/cosmos/tools/cmd_tlm_server/router_thread.rb

@@ -19,6 +19,11 @@ module Cosmos
     protected
 
     def handle_packet(packet)
+      unless System.allow_router_commanding
+        Logger.error "Router received command with router commanding disabled"
+        return
+      end
+
       # Start out assuming we will route to all associated interfaces
       interfaces = @interface.interfaces
 

data/lib/cosmos/tools/config_editor/config_editor.rb

@@ -653,7 +653,7 @@ module Cosmos
       end
       File.open(File.join(target_folder, 'procedures', "#{target.downcase}_noop.rb"), 'w') do |file|
         file.puts "require 'cosmos'"
-        file.puts "require '#{File.basename(lib_filename)}'"
+        file.puts "load_utility '#{File.basename(lib_filename)}'"
         file.puts "\n"
         file.puts "#{target.downcase} = #{lib_filename.filename_to_class_name}.new"
         file.puts "#{target.downcase}.noop"

data/lib/cosmos/tools/handbook_creator/handbook_creator_config.rb

@@ -115,7 +115,7 @@ module Cosmos
         cover, cover_file = make_pdf_detail('cover', @pdf_cover_filename, @pdf_cover_title, target_name)
         header, header_file = make_pdf_detail('--header-spacing 3 --header-html', @pdf_header_filename, @pdf_header_title, target_name)
         footer, footer_file = make_pdf_detail('--footer-spacing 3 --footer-html', @pdf_footer_filename, @pdf_footer_title, target_name)
-        system_call = "wkhtmltopdf -L #{@pdf_side_margin} -R #{@pdf_side_margin} -T #{@pdf_top_margin} -B #{@pdf_bottom_margin} -s Letter #{header} #{footer} #{cover} #{@pdf_toc} \"#{tmp_html_file.path}\" \"#{File.dirname(filename)}/#{File.basename(filename, '.*')}.pdf\""
+        system_call = "wkhtmltopdf --enable-local-file-access -L #{@pdf_side_margin} -R #{@pdf_side_margin} -T #{@pdf_top_margin} -B #{@pdf_bottom_margin} -s Letter #{header} #{footer} #{cover} #{@pdf_toc} \"#{tmp_html_file.path}\" \"#{File.dirname(filename)}/#{File.basename(filename, '.*')}.pdf\""
         status = nil
         begin
           Cosmos.set_working_dir(System.paths['HANDBOOKS']) do

data/lib/cosmos/tools/tlm_extractor/tlm_extractor_config.rb

@@ -385,10 +385,7 @@ module Cosmos
 
       # Print column headings to output file
       @output_file.print "%" if @matlab_header
-      column_names().each do |column_name|
-        @output_file.print column_name
-        @output_file.print @delimiter
-      end
+      @output_file.print column_names.join(@delimiter)
       @output_file.puts ""
       @row_index += 1
     end