ftpd 0.16.0 → 0.17.0

data/lib/ftpd/cmd_stor.rb

@@ -13,8 +13,9 @@ module Ftpd
         path = File.expand_path(path, name_prefix)
         ensure_accessible path
         ensure_exists File.dirname(path)
-        contents = receive_file
-        file_system.write path, contents
+        receive_file do |data_socket|
+          file_system.write path, data_socket
+        end
         reply "226 Transfer complete"
       end
     end

data/lib/ftpd/cmd_stou.rb

@@ -13,8 +13,9 @@ module Ftpd
         path = unique_path(path)
         ensure_accessible path
         ensure_exists File.dirname(path)
-        contents = receive_file(File.basename(path))
-        file_system.write path, contents
+        receive_file(File.basename(path)) do |data_socket|
+          file_system.write path, data_socket
+        end
         reply "226 Transfer complete"
       end
     end

data/lib/ftpd/cmd_stru.rb

@@ -8,8 +8,8 @@ module Ftpd
       syntax_error unless argument
       ensure_logged_in
       name, implemented = FILE_STRUCTURES[argument]
-      error "504 Invalid structure code" unless name
-      error "504 Structure not implemented" unless implemented
+      error "Invalid structure code", 504 unless name
+      error "Structure not implemented", 504 unless implemented
       self.structure = argument
       reply "200 File structure set to #{name}"
     end

data/lib/ftpd/cmd_type.rb

@@ -10,7 +10,7 @@ module Ftpd
       type_code = $1
       format_code = $2
       unless argument =~ /^([AEI]( [NTC])?|L .*)$/
-        error '504 Invalid type code'
+        error 'Invalid type code', 504
       end
       case argument
       when /^A( [NT])?$/
@@ -18,7 +18,7 @@ module Ftpd
       when /^(I|L 8)$/
         self.data_type = 'I'
       else
-        error '504 Type not implemented'
+        error 'Type not implemented', 504
       end
       reply "200 Type set to #{data_type}"
     end

data/lib/ftpd/command_handler.rb

@@ -10,7 +10,6 @@ module Ftpd
 
     extend Forwardable
 
-    include AsciiHelper
     include DataConnectionHelper
     include Error
     include FileSystemHelper

data/lib/ftpd/command_loop.rb

@@ -21,12 +21,12 @@ module Ftpd
               syntax_error unless s =~ /^(\w+)(?: (.*))?$/
               command, argument = $1.downcase, $2
               unless valid_command?(command)
-                unrecognized_error s
+                error "Syntax error, command unrecognized: #{s.chomp}", 500
               end
               command_sequence_checker.check command
               execute_command command, argument
-            rescue CommandError => e
-              reply e.message
+            rescue FtpServerError => e
+              reply e.message_with_code
             end
           end
         rescue Errno::ECONNRESET, Errno::EPIPE

data/lib/ftpd/command_sequence_checker.rb

@@ -40,7 +40,7 @@ module Ftpd
     # {#expect} is called again.
     #
     # @param command [String] The command.  Must be lowercase.
-    # @raise [CommandError] A "503 Bad sequence" error
+    # @raise [FtpServerError] A "503 Bad sequence" error
 
     def check(command)
       if @expected_command

data/lib/ftpd/data_connection_helper.rb

@@ -4,25 +4,24 @@ module Ftpd
 
   module DataConnectionHelper
 
-    def transmit_file(contents, data_type = session.data_type)
+    def transmit_file(io, data_type = session.data_type)
       open_data_connection do |data_socket|
-        contents = unix_to_nvt_ascii(contents) if data_type == 'A'
+        socket = Ftpd::Stream.new(data_socket, data_type)
         handle_data_disconnect do
-          data_socket.write(contents)
+          socket.write(io)
         end
-        config.log.debug "Sent #{contents.size} bytes"
+        config.log.debug "Sent #{socket.byte_count} bytes"
         reply "226 Transfer complete"
       end
     end
 
-    def receive_file(path_to_advertise = nil)
+    def receive_file(path_to_advertise = nil, &block)
       open_data_connection(path_to_advertise) do |data_socket|
-        contents = handle_data_disconnect do
-          data_socket.read
+        socket = Ftpd::Stream.new(data_socket, data_type)
+        handle_data_disconnect do
+          yield socket
         end
-        contents = nvt_ascii_to_unix(contents) if data_type == 'A'
-        config.log.debug "Received #{contents.size} bytes"
-        contents
+        config.log.debug "Received #{socket.byte_count} bytes"
       end
     end
 

data/lib/ftpd/disk_file_system.rb

@@ -75,9 +75,11 @@ module Ftpd
 
     module FileWriting
 
-      def write_file(ftp_path, contents, mode)
+      def write_file(ftp_path, stream, mode)
         File.open(expand_ftp_path(ftp_path), mode) do |file|
-          file.write contents
+          while line = stream.read
+            file.write line
+          end
         end
       end
 
@@ -117,16 +119,22 @@ module Ftpd
 
       include TranslateExceptions
 
-      # Read a file into memory.
+      # Read a file from disk.
       # @param ftp_path [String] The virtual path
+      # @yield [io] Passes an IO object to the block
       #
       # Called for:
       # * RETR
       #
       # If missing, then these commands are not supported.
 
-      def read(ftp_path)
-        File.open(expand_ftp_path(ftp_path), 'rb', &:read)
+      def read(ftp_path, &block)
+        io = File.open(expand_ftp_path(ftp_path), 'rb')
+        begin
+          yield(io)
+        ensure
+          io.close
+        end
       end
       translate_exceptions :read
 
@@ -144,7 +152,7 @@ module Ftpd
 
       # Write a file to disk.
       # @param ftp_path [String] The virtual path
-      # @param contents [String] The file's contents
+      # @param stream [Ftpd::Stream] Stream that contains the data to write
       #
       # Called for:
       # * STOR
@@ -152,8 +160,8 @@ module Ftpd
       #
       # If missing, then these commands are not supported.
 
-      def write(ftp_path, contents)
-        write_file ftp_path, contents, 'wb'
+      def write(ftp_path, stream)
+        write_file ftp_path, stream, 'wb'
       end
       translate_exceptions :write
 
@@ -171,15 +179,15 @@ module Ftpd
 
       # Append to a file.  If the file does not exist, create it.
       # @param ftp_path [String] The virtual path
-      # @param contents [String] The file's contents
+      # @param stream [Ftpd::Stream] Stream that contains the data to write
       #
       # Called for:
       # * APPE
       #
       # If missing, then these commands are not supported.
 
-      def append(ftp_path, contents)
-        write_file ftp_path, contents, 'ab'
+      def append(ftp_path, stream)
+        write_file ftp_path, stream, 'ab'
       end
       translate_exceptions :append
 
@@ -368,7 +376,8 @@ module Ftpd
   # found") or TransientFileSystemError (e.g. "file busy").  A
   # PermanentFileSystemError will cause a "550" error response to be
   # sent; a TransientFileSystemError will cause a "450" error response
-  # to be sent.
+  # to be sent. Methods may also raise an FtpServerError with any
+  # desired error code.
   #
   # The class is divided into modules that may be included piecemeal.
   # By including some mixins and not others, you can compose a disk

data/lib/ftpd/error.rb

@@ -1,32 +1,20 @@
 module Ftpd
   module Error
 
-    def error(message)
-      raise CommandError, message
-    end
-
-    def transient_error(message)
-      error "450 #{message}"
-    end
-
-    def unrecognized_error(s)
-      error "500 Syntax error, command unrecognized: #{s.chomp}"
+    def error(message, code)
+      raise FtpServerError.new(message, code)
     end
 
     def unimplemented_error
-      error "502 Command not implemented"
+      error "Command not implemented", 502
     end
 
     def sequence_error
-      error "503 Bad sequence of commands"
-    end
-
-    def permanent_error(message)
-      error "550 #{message}"
+      error "Bad sequence of commands", 503
     end
 
     def syntax_error
-      error "501 Syntax error"
+      error "Syntax error", 501
     end
 
   end

data/lib/ftpd/exceptions.rb

@@ -3,25 +3,60 @@ module Ftpd
   # All errors (purposefully) generated by this library driver from
   # this class.
 
-  class FtpServerError < StandardError ; end
+  # Any error that send a reply to the client raises a FtpServerError.
+  # The message is the text to send (e.g. "Syntax error") and the code
+  # is the FTP response code to send (e.g. "502"). This is typically not
+  # raised directly, but using the Error mixin.
 
-  # Any error that send a reply to the client raises a CommandError.
-  # The message is the text to send (e.g. "501 Syntax error").  This
-  # is typically not raised directly, but using the Error mixin.
+  class FtpServerError < StandardError
+    attr_reader :code
 
-  class CommandError < FtpServerError ; end
+    def initialize(message, code)
+      @code = code
+      raise ArgumentError, "Invalid response code" unless valid_response_code?
 
-  # A permanent file system error.  Deprecated; use
-  # PermanentFileSystemError instead.
+      super(message)
+    end
+
+    def message_with_code
+      "#{code} #{message}"
+    end
 
-  class FileSystemError < FtpServerError ; end
+    private
+    def valid_response_code?
+      (400..599).cover?(code)
+    end
+  end
 
   # A permanent file system error.  The file isn't there, etc.
 
-  class PermanentFileSystemError < FtpServerError ; end
+  class PermanentFileSystemError < FtpServerError
+    def initialize(message, code = 550)
+      super
+    end
+
+    private
+    def valid_response_code?
+      (550..559).cover?(code)
+    end
+  end
 
   # A transient file system error.  The file is busy, etc.
 
-  class TransientFileSystemError < FtpServerError ; end
+  class TransientFileSystemError < FtpServerError
+    def initialize(message, code = 450)
+      super
+    end
+
+    private
+    def valid_response_code?
+      (450..459).cover?(code)
+    end
+  end
+
+  # A permanent file system error.  Deprecated; use
+  # PermanentFileSystemError instead.
+
+  class FileSystemError < PermanentFileSystemError ; end
 
 end

data/lib/ftpd/file_system_helper.rb

@@ -19,25 +19,25 @@ module Ftpd
 
     def ensure_accessible(path)
       unless file_system.accessible?(path)
-        error '550 Access denied'
+        error 'Access denied', 550
       end
     end
 
     def ensure_exists(path)
       unless file_system.exists?(path)
-        error '550 No such file or directory'
+        error 'No such file or directory', 550
       end
     end
 
     def ensure_does_not_exist(path)
       if file_system.exists?(path)
-        error '550 Already exists'
+        error 'Already exists', 550
       end
     end
 
     def ensure_directory(path)
       unless file_system.directory?(path)
-        error '550 Not a directory'
+        error 'Not a directory', 550
       end
     end
 

data/lib/ftpd/session.rb

@@ -61,18 +61,18 @@ module Ftpd
 
     def ensure_logged_in
       return if @logged_in
-      error "530 Not logged in"
+      error "Not logged in", 530
     end
 
     def ensure_tls_supported
       unless tls_enabled?
-        error "534 TLS not enabled"
+        error "TLS not enabled", 534
       end
     end
 
     def ensure_not_epsv_all
       if @epsv_all
-        error "501 Not allowed after EPSV ALL"
+        error "Not allowed after EPSV ALL", 501
       end
     end
 
@@ -83,8 +83,8 @@ module Ftpd
     def ensure_protocol_supported(protocol_code)
       unless @protocols.supports_protocol?(protocol_code)
         protocol_list = @protocols.protocol_codes.join(',')
-        error("522 Network protocol #{protocol_code} not supported, "\
-              "use (#{protocol_list})")
+        error("Network protocol #{protocol_code} not supported, "\
+              "use (#{protocol_list})", 522)
       end
     end
 
@@ -114,7 +114,7 @@ module Ftpd
     end
 
     def set_file_system(file_system)
-      @file_system = FileSystemErrorTranslator.new(file_system)
+      @file_system = file_system
     end
 
     def command_not_needed
@@ -155,7 +155,7 @@ module Ftpd
       user = auth_tokens.first
       unless authenticate(*auth_tokens)
         failed_auth
-        error "530 Login incorrect"
+        error "Login incorrect", 530
       end
       reply "230 Logged in"
       set_file_system @config.driver.file_system(user)
@@ -191,7 +191,7 @@ module Ftpd
 
     def set_active_mode_address(address, port)
       if port > 0xffff || port < 1024 && !@config.allow_low_data_ports
-        error "504 Command not implemented for that parameter"
+        error "Command not implemented for that parameter", 504
       end
       @data_hostname = address
       @data_port = port

data/lib/ftpd/stream.rb

@@ -0,0 +1,80 @@
+module Ftpd
+
+  class Stream
+
+    CHUNK_SIZE = 1024 * 100 # 100kb
+
+    attr_reader :data_type
+    attr_reader :byte_count
+
+    # @param io [IO] The stream to read from or write to
+    # @param data_type [String] The FTP data type of the stream
+
+    def initialize(io, data_type)
+      @io, @data_type = io, data_type
+      @byte_count = 0
+    end
+
+    # Read and convert a chunk of up to CHUNK_SIZE from the stream
+    # @return [String] if any bytes remain to read from the stream
+    # @return [NilClass] if no bytes remain
+
+    def read
+      chunk = converted_chunk(@io)
+      return unless chunk
+      chunk = nvt_ascii_to_unix(chunk) if data_type == 'A'
+      record_bytes(chunk)
+      chunk
+    end
+
+    # Convert and write a chunk of up to CHUNK_SIZE to the stream from the
+    # provided IO object
+    #
+    # @param io [IO] The data to be written to the stream
+
+    def write(io)
+      while chunk = converted_chunk(io)
+        chunk = unix_to_nvt_ascii(chunk) if data_type == 'A'
+        result = @io.write(chunk)
+        record_bytes(chunk)
+        result
+      end
+    end
+
+    private
+
+    # We never want to break up any \r\n sequences in the file. To avoid
+    # this in an efficient way, we always pull an "extra" character from the
+    # stream and add it to the buffer. If the character is a \r, then we put
+    # it back onto the stream instead of adding it to the buffer.
+
+    def converted_chunk(io)
+      chunk = io.read(CHUNK_SIZE)
+      return unless chunk
+      if data_type == 'A'
+        next_char = io.getc
+        if next_char == "\r"
+          io.ungetc(next_char)
+        elsif next_char
+          chunk += next_char
+        end
+      end
+      chunk
+    end
+
+    def unix_to_nvt_ascii(s)
+      return s if s =~ /\r\n/
+      s.gsub(/\n/, "\r\n")
+    end
+
+    def nvt_ascii_to_unix(s)
+      s.gsub(/\r\n/, "\n")
+    end
+
+    def record_bytes(chunk)
+      @byte_count += chunk.size if chunk
+    end
+
+  end
+
+end