Add File Interface in Ruby

openc3/lib/openc3/interfaces/file_interface.rb

@@ -0,0 +1,191 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 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.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/interfaces/interface'
+require 'openc3/config/config_parser'
+require 'thread'
+require 'listen'
+require 'fileutils'
+
+module OpenC3
+  class FileInterface < Interface
+    # @param command_write_folder [String] Folder to write command files to
+    # @param telemetry_read_folder [String] Folder to read telemetry files from
+    # @param telemetry_archive_folder [String] Folder to move read telemetry files to
+    # @param file_read_size [Integer] Number of bytes to read from the file at a time
+    # @param stored [Boolean] Whether to set stored flag on read telemetry
+    # @param protocol_type [String] Name of the protocol to use
+    #   with this interface
+    # @param protocol_args [Array<String>] Arguments to pass to the protocol
+    def initialize(
+      command_write_folder,
+      telemetry_read_folder,
+      telemetry_archive_folder,
+      file_read_size = 65536,
+      stored = true,
+      protocol_type = nil,
+      *protocol_args
+    )
+      super()
+
+      @protocol_type = ConfigParser.handle_nil(protocol_type)
+      @protocol_args = protocol_args
+      if @protocol_type
+        protocol_class_name = protocol_type.to_s.capitalize << 'Protocol'
+        klass = OpenC3.require_class(protocol_class_name.class_name_to_filename)
+        add_protocol(klass, protocol_args, :PARAMS)
+      end
+
+      @command_write_folder = ConfigParser.handle_nil(command_write_folder)
+      @telemetry_read_folder = ConfigParser.handle_nil(telemetry_read_folder)
+      @telemetry_archive_folder = ConfigParser.handle_nil(telemetry_archive_folder)
+      @file_read_size = Integer(file_read_size)
+      @stored = ConfigParser.handle_true_false(stored)
+
+      @read_allowed = false unless @telemetry_read_folder
+      @write_allowed = false unless @command_write_folder
+      @write_raw_allowed = false unless @command_write_folder
+
+      @file = nil
+      @listener = nil
+      @connected = false
+      @extension = ".bin"
+      @label = "command"
+      @queue = Queue.new
+      @polling = false
+    end
+
+    def connect
+      super()
+
+      if @telemetry_read_folder
+        @listener = Listen.to(@telemetry_read_folder, force_polling: @polling) do |modified, added, removed|
+          @queue << added if added
+        end
+        @listener.start # starts a listener thread--does not block
+      end
+
+      @connected = true
+    end
+
+    def connected?
+      return @connected
+    end
+
+    def disconnect
+      @file.close if @file and not @file.closed?
+      @file = nil
+      @listener.stop if @listener
+      @listener = nil
+      @queue << nil
+      super()
+      @connected = false
+    end
+
+    def read_interface
+      while true
+        if @filef
+          # Read more data from existing file
+          data = @file.read(@file_read_size)
+          if data and data.length > 0
+            read_interface_base(data, nil)
+            return data, nil
+          else
+            finish_file()
+          end
+        end
+
+        # Find the next file to read
+        file = get_next_telemetry_file()
+        if file
+          @file = File.open(file, 'rb')
+          next
+        end
+
+        # Wait for a file to read
+        result = @queue.pop
+        break unless result
+      end
+    end
+
+    def write_interface(data, extra = nil)
+      # Write this data into its own file
+      File.open(create_unique_filename(), 'wb') do |file|
+        file.write(data)
+      end
+
+      write_interface_base(data, extra)
+      return data, extra
+    end
+
+    def convert_data_to_packet(data, extra = nil)
+      packet = super(data, extra)
+      if packet and @stored
+        packet.stored = true
+      end
+      return packet
+    end
+
+    # Supported Options
+    # LABEL - Label to add to written files
+    # EXTENSION - Extension to add to written files
+    # (see Interface#set_option)
+    def set_option(option_name, option_values)
+      super(option_name, option_values)
+      case option_name.upcase
+      when 'LABEL'
+        @label = option_values[0]
+      when 'EXTENSION'
+        @extension = option_values[0]
+      when 'POLLING'
+        @polling = ConfigParser.handle_true_false(option_values[0])
+      end
+    end
+
+    def finish_file
+      path = @file.path
+      @file.close
+      @file = nil
+
+      # Archive (or DELETE) complete file
+      if @telemetry_archive_folder == "DELETE"
+        FileUtils.rm(path)
+      else
+        FileUtils.mv(path, @telemetry_archive_folder)
+      end
+    end
+
+    def get_next_telemetry_file
+      Dir.glob("#{@telemetry_read_folder}/*").sort[0]
+    end
+
+    def create_unique_filename
+      # Create a filename that doesn't exist
+      attempt = nil
+      while true
+        filename = File.join(@command_write_folder, File.build_timestamped_filename([@label, attempt], @extension))
+        if File.exist?(filename)
+          attempt ||= 0
+          attempt += 1
+        else
+          return filename
+        end
+      end
+    end
+  end
+end