ftpd 0.2.2 → 0.3.1

data/lib/ftpd/file_info.rb

@@ -0,0 +1,115 @@
+module Ftpd
+
+  # Information about a file object (file, directory, symlink, etc.)
+
+  class FileInfo
+
+    # @return [String] The file's type, as returned by File.lstat
+    # One of:
+    # * 'file'
+    # * 'directory'
+    # * 'characterSpecial'
+    # * 'blockSpecial'
+    # * 'fifo'
+    # * 'link'
+    # * 'socket'
+    # * 'unknown'
+
+    attr_reader :ftype
+
+    # @return [String] The group name
+
+    attr_reader :group
+
+    # @return [Integer] The mode bits, as returned by File::Stat#mode
+    # The bits are:
+    #   * 0 - others have execute permission
+    #   * 1 - others have write permission
+    #   * 2 - others have read permission
+    #   * 3 - group has execute permission
+    #   * 4 - group has write permission
+    #   * 5 - group has read permission
+    #   * 6 - owner has execute permission
+    #   * 7 - owner has write permission
+    #   * 8 - owner has read permission
+    #   * 9 - sticky bit
+    #   * 10 - set-group-ID bit
+    #   * 11 - set UID bit
+    # Other bits may be present; they are ignored
+
+    attr_reader :mode
+
+    # @return [Time] The modification time
+
+    attr_reader :mtime
+
+    # @return [Integer] The number of hard links
+
+    attr_reader :nlink
+
+    # @return [String] The owner name
+
+    attr_reader :owner
+
+    # @return [Integer] The size, in bytes
+
+    attr_reader :size
+
+    # @return [String] The object's path
+
+    attr_reader :path
+
+    # @return [String] The object's identifier
+    #
+    # This uniquely identifies the file: Two objects with the same
+    # identifier are expected to refer to the same file or directory.
+    #
+    # On a disk file system, might be _dev_._inode_,
+    # e.g. "8388621.48598"
+    #
+    # This is optional and does not have to be set.  If set, it is
+    # used in EPLF output.
+
+    attr_reader :identifier
+
+    # Create a new instance.  See the various attributes for argument
+    # details.
+    #
+    # @param opts [Hash] The file attributes
+    # @option opts [String] :ftype The file type
+    # @option opts [String] :group The group name
+    # @option opts [String] :identifier The object's identifier
+    # @option opts [Integer] :mode The mode bits
+    # @option opts [Time] :mtime The modification time
+    # @option opts [Integer] :nlink The number of hard links
+    # @option opts [String] :owner The owner name
+    # @option opts [Integer] :size The size
+    # @option opts [String] :path The object's path
+
+    def initialize(opts)
+      @ftype = opts[:ftype]
+      @group = opts[:group]
+      @identifier = opts[:identifier]
+      @mode = opts[:mode]
+      @mtime = opts[:mtime]
+      @nlink = opts[:nlink]
+      @owner = opts[:owner]
+      @path = opts[:path]
+      @size = opts[:size]
+    end
+
+    # @return true if the object is a file
+
+    def file?
+      @ftype == 'file'
+    end
+
+    # @return true if the object is a directory
+
+    def directory?
+      @ftype == 'directory'
+    end
+
+  end
+
+end

data/lib/ftpd/ftp_server.rb

@@ -25,6 +25,12 @@ module Ftpd
 
     attr_accessor :response_delay
 
+    # The class for formatting for LIST output.  Defaults to
+    # {Ftpd::ListFormat::Ls}.  Changes to this attribute only take
+    # effect for new sessions.
+
+    attr_accessor :list_formatter
+
     # Create a new FTP server.  The server won't start until the
     # #start method is called.
     #
@@ -48,6 +54,7 @@ module Ftpd
       @debug_path = '/dev/stdout'
       @debug = false
       @response_delay = 0
+      @list_formatter = ListFormat::Ls
     end
 
     private
@@ -57,6 +64,7 @@ module Ftpd
                   :driver => @driver,
                   :debug => @debug,
                   :debug_path => debug_path,
+                  :list_formatter => @list_formatter,
                   :response_delay => response_delay,
                   :tls => @tls).run
     end

data/lib/ftpd/list_format/eplf.rb

@@ -0,0 +1,74 @@
+module Ftpd
+  module ListFormat
+
+    # Easily Parsed LIST Format (EPLF) Directory formatter
+    # See: {http://cr.yp.to/ftp/list/eplf.html}
+
+    class Eplf
+
+      extend Forwardable
+
+      # Create a new formatter for a file object
+      # @param file_info [FileInfo]
+
+      def initialize(file_info)
+        @file_info = file_info
+      end
+
+      # Return the formatted directory entry.
+      # For example:
+      #   +i8388621.48598,m824253270,r,s612, 514.html
+      # Note: The calling code adds the \r\n
+
+      def to_s
+        "+%s\t%s" % [facts, filename]
+      end
+
+      private
+
+      def facts
+        [
+          retrievable_fact,
+          cwd_target_fact,
+          size_fact,
+          mtime_fact,
+          identifier_fact,
+        ].compact.join(',')
+      end
+
+      def retrievable_fact
+        'r' if retrievable?
+      end
+
+      def cwd_target_fact
+        '/' if cwd_target?
+      end
+
+      def size_fact
+        "s#{@file_info.size}" if retrievable?
+      end
+
+      def mtime_fact
+        "m#{@file_info.mtime.to_i}"
+      end
+
+      def identifier_fact
+        "i#{@file_info.identifier}" if @file_info.identifier
+      end
+
+      def filename
+        File.basename(@file_info.path)
+      end
+
+      def retrievable?
+        @file_info.file?
+      end
+
+      def cwd_target?
+        @file_info.directory?
+      end
+
+    end
+
+  end
+end

data/lib/ftpd/list_format/ls.rb

@@ -0,0 +1,154 @@
+module Ftpd
+  module ListFormat
+
+    # Directory formatter that approximates the output of "ls -l"
+
+    class Ls
+
+      extend Forwardable
+
+      # Create a new formatter for a file object
+      # @param file_info [FileInfo]
+
+      def initialize(file_info)
+        @file_info = file_info
+      end
+
+      # Return the formatted directory entry, for example:
+      #   -rw-r--r-- 1 user     group    Mar  3 08:38 foo
+
+      def to_s
+        '%s%s %d %-8s %-8s %8d %s %s' % [
+          file_type,
+          file_mode_letters,
+          @file_info.nlink,
+          @file_info.owner,
+          @file_info.group,
+          @file_info.size,
+          format_time(@file_info.mtime),
+          filename,
+        ]
+      end
+
+      private
+
+      SIX_MONTHS = 180 * 24 * 60 * 60
+
+      def filename
+        File.basename(@file_info.path)
+      end
+
+      def file_type
+        FileType.letter(@file_info.ftype)
+      end
+
+      def file_mode_letters
+        FileMode.new(@file_info.mode).letters
+      end
+
+      def self.format_time(mtime)
+        age = Time.now - mtime
+        format = '%b %e ' + if age < 0 || age > SIX_MONTHS
+                              ' %Y'
+                            else
+                              '%H:%M'
+                            end
+        mtime.strftime(format)
+      end
+      def_delegator self, :format_time
+
+      # Map file type strings to ls file type letters
+
+      class FileType
+
+        # Map a file type string to a file type letter.
+        # @param ftype [String] file type as returned by File::Stat#ftype
+        # @return [String] File type letter
+
+        def self.letter(ftype)
+          case ftype
+          when 'file'
+            '-'
+          when 'directory'
+            'd'
+          when 'characterSpecial'
+            'c'
+          when 'blockSpecial'
+            'b'
+          when 'fifo'
+            'p'
+          when 'link'
+            'l'
+          when 'socket'
+            's'
+          else  # 'unknown', etc.
+            '?'
+          end
+        end
+
+      end
+
+      # Map file mode bits into ls style file mode letters
+
+      class FileMode
+
+        # @param mode [Integer] File mode bits, as returned by
+        #   File::Stat#mode
+
+        def initialize(mode)
+          @mode = mode
+        end
+
+        # Return the mode bits as ls style letters.
+        # For example, "-rw-r--r--"
+
+        def letters
+          [
+            triad(OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, SET_UID, 'Ss'),
+            triad(GROUP_READ, GROUP_WRITE, GROUP_EXECUTE, SET_GID, 'Ss'),
+            triad(OTHER_READ, OTHER_WRITE, OTHER_EXECUTE, STICKY, 'Tt'),
+          ].join
+        end
+
+        private
+
+        def bit(bit_number)
+          @mode >> bit_number & 1
+        end
+
+        def triad(read_bit, write_bit, execute_bit, special_bit, special_letters)
+          execute_chars = if bit(special_bit) != 0
+                            special_letters
+                          else
+                            '-x'
+                          end
+          [
+            pick_char('-r', read_bit),
+            pick_char('-w', write_bit),
+            pick_char(execute_chars, execute_bit),
+          ]
+        end
+
+        def pick_char(s, bit_number)
+          s[bit(bit_number), 1]
+        end
+
+        OTHER_EXECUTE = 0
+        OTHER_WRITE = 1
+        OTHER_READ = 2
+        GROUP_EXECUTE = 3
+        GROUP_WRITE = 4
+        GROUP_READ = 5
+        OWNER_EXECUTE = 6
+        OWNER_WRITE = 7
+        OWNER_READ = 8
+        STICKY = 9
+        SET_GID = 10
+        SET_UID = 11
+
+      end
+
+    end
+
+  end
+end

data/lib/ftpd/session.rb

@@ -15,6 +15,7 @@ module Ftpd
       @name_prefix = '/'
       @debug_path = opts[:debug_path]
       @debug = opts[:debug]
+      @list_formatter = opts[:list_formatter]
       @data_type = 'A'
       @mode = 'S'
       @format = 'N'
@@ -164,24 +165,23 @@ module Ftpd
     def cmd_list(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_file_system_supports :list
+        ensure_file_system_supports :dir
+        ensure_file_system_supports :file_info
         path = argument
         path ||= '.'
         path = File.expand_path(path, @name_prefix)
-        list = @file_system.list(path)
-        transmit_file(list, 'A')
+        transmit_file(list(path), 'A')
       end
     end
 
     def cmd_nlst(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_file_system_supports :name_list
+        ensure_file_system_supports :dir
         path = argument
         path ||= '.'
         path = File.expand_path(path, @name_prefix)
-        list = @file_system.name_list(path)
-        transmit_file(list, 'A')
+        transmit_file(name_list(path), 'A')
       end
     end
 
@@ -657,7 +657,7 @@ module Ftpd
     def generate_suffix
       set = ('a'..'z').to_a
       8.times.map do
-        set.sample
+        set[rand(set.size)]
       end.join
     end
 
@@ -679,5 +679,29 @@ module Ftpd
       checker
     end
 
+    def list(path)
+      format_list(path_list(path))
+    end
+
+    def format_list(paths)
+      paths.map do |path|
+        file_info = @file_system.file_info(path)
+        @list_formatter.new(file_info).to_s + "\n"
+      end.join
+    end
+
+    def name_list(path)
+      path_list(path).map do |path|
+        File.basename(path) + "\n"
+      end.join
+    end
+
+    def path_list(path)
+      if @file_system.directory?(path)
+        path = File.join(path, '*')
+      end
+      @file_system.dir(path).sort
+    end
+
   end
 end