ftpd 0.2.0 → 0.2.1

data/lib/ftpd/error.rb

@@ -5,5 +5,21 @@ module Ftpd
       raise CommandError, message
     end
 
+    def transient_error(message)
+      error "450 #{message}"
+    end
+
+    def unrecognized_error(s)
+      error "500 Syntax error, command unrecognized: #{s.chomp}"
+    end
+
+    def unimplemented_error
+      error "502 Command not implemented"
+    end
+
+    def permanent_error(message)
+      error "550 #{message}"
+    end
+
   end
 end

data/lib/ftpd/exception_translator.rb

@@ -23,7 +23,7 @@ module Ftpd
       begin
         return yield
       rescue *@exceptions => e
-        raise FileSystemError, e.message
+        raise PermanentFileSystemError, e.message
       end
     end
 

data/lib/ftpd/exceptions.rb

@@ -11,11 +11,17 @@ module Ftpd
 
   class CommandError < FtpServerError ; end
 
-  # Any errors raised by a file system driver are (or are derived
-  # from) this class.  See the mixin TranslateExceptions for an easy
-  # way to generate FileSystemError exceptions from other types of
-  # exceptions.
+  # A permanent file system error.  Deprecated; use
+  # PermanentFileSystemError instead.
 
   class FileSystemError < FtpServerError ; end
 
+  # A permanent file system error.  The file isn't there, etc.
+
+  class PermanentFileSystemError < FtpServerError ; end
+
+  # A transient file system error.  The file is busy, etc.
+
+  class TransientFileSystemError < FtpServerError ; end
+
 end

data/lib/ftpd/file_system_error_translator.rb

@@ -1,7 +1,7 @@
 module Ftpd
 
-  # This class is a proxy file system driver that sends "450" replies
-  # when the wrapped file system driver raises a FileSystemError.
+  # A proxy file system driver that sends a "450" or "550" error
+  # reply in response to FileSystemError exceptions.
 
   class FileSystemErrorTranslator
 
@@ -12,13 +12,17 @@ module Ftpd
     end
 
     def respond_to?(method)
-      @file_system.respond_to?(method)
+      @file_system.respond_to?(method) || super
     end
 
     def method_missing(method, *args)
       @file_system.send(method, *args)
+    rescue PermanentFileSystemError => e
+      permanent_error e
+    rescue TransientFileSystemError => e
+      transient_error e
     rescue FileSystemError => e
-      error "450 #{e}"
+      permanent_error e
     end
 
   end

data/lib/ftpd/ftp_server.rb

@@ -54,6 +54,7 @@ module Ftpd
 
     def session(socket)
       Session.new(:socket => socket,
+                  :interface => interface,
                   :driver => @driver,
                   :debug => @debug,
                   :debug_path => debug_path,

data/lib/ftpd/session.rb

@@ -8,6 +8,7 @@ module Ftpd
     def initialize(opts)
       @driver = opts[:driver]
       @socket = opts[:socket]
+      @interface = opts[:interface]
       @tls = opts[:tls]
       if @tls == :implicit
         @socket.encrypt
@@ -32,12 +33,9 @@ module Ftpd
             s = get_command
             syntax_error unless s =~ /^(\w+)(?: (.*))?$/
             command, argument = $1.downcase, $2
-            unless VALID_COMMANDS.include?(command)
-              error "500 Syntax error, command unrecognized: #{s}"
-            end
             method = 'cmd_' + command
-            unless self.class.private_method_defined?(method)
-              unimplemented
+            unless respond_to?(method, true)
+              unrecognized_error s
             end
             send(method, argument)
           rescue CommandError => e
@@ -50,45 +48,6 @@ module Ftpd
 
     private
 
-    VALID_COMMANDS = [
-      "abor",
-      "acct",
-      "allo",
-      "appe",
-      "auth",
-      "pbsz",
-      "cdup",
-      "cwd",
-      "dele",
-      "help",
-      "list",
-      "mkd",
-      "mode",
-      "nlst",
-      "noop",
-      "pass",
-      "pasv",
-      "port",
-      "prot",
-      "pwd",
-      "quit",
-      "rein",
-      "rest",
-      "retr",
-      "rmd",
-      "rnfr",
-      "rnto",
-      "site",
-      "smnt",
-      "stat",
-      "stor",
-      "stou",
-      "stru",
-      "syst",
-      "type",
-      "user",
-    ]
-
     def cmd_allo(argument)
       ensure_logged_in
       syntax_error unless argument =~ /^\d+( R \d+)?$/
@@ -102,23 +61,19 @@ module Ftpd
 
     def cmd_user(argument)
       syntax_error unless argument
-      bad_sequence unless @state == :user
+      sequence_error unless @state == :user
       @user = argument
       @state = :password
       reply "331 Password required"
     end
 
-    def bad_sequence
+    def sequence_error
       error "503 Bad sequence of commands"
     end
 
-    def unimplemented
-      error "502 Command not implemented"
-    end
-
     def cmd_pass(argument)
       syntax_error unless argument
-      bad_sequence unless @state == :password
+      sequence_error unless @state == :password
       password = argument
       unless @driver.authenticate(@user, password)
         @state = :user
@@ -158,7 +113,7 @@ module Ftpd
     def cmd_stor(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_write_supported
+        ensure_file_system_supports :write
         path = argument
         syntax_error unless path
         path = File.expand_path(path, @name_prefix)
@@ -173,7 +128,7 @@ module Ftpd
     def cmd_retr(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_read_supported
+        ensure_file_system_supports :read
         path = argument
         syntax_error unless path
         path = File.expand_path(path, @name_prefix)
@@ -186,7 +141,7 @@ module Ftpd
 
     def cmd_dele(argument)
       ensure_logged_in
-      ensure_delete_supported
+      ensure_file_system_supports :delete
       path = argument
       error "501 Path required" unless path
       path = File.expand_path(path, @name_prefix)
@@ -199,7 +154,7 @@ module Ftpd
     def cmd_list(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_list_supported
+        ensure_file_system_supports :list
         path = argument
         path ||= '.'
         path = File.expand_path(path, @name_prefix)
@@ -211,7 +166,7 @@ module Ftpd
     def cmd_nlst(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
-        ensure_name_list_supported
+        ensure_file_system_supports :name_list
         path = argument
         path ||= '.'
         path = File.expand_path(path, @name_prefix)
@@ -275,7 +230,7 @@ module Ftpd
       if @data_server
         reply "200 Already in passive mode"
       else
-        @data_server = TCPServer.new('localhost', 0)
+        @data_server = TCPServer.new(@interface, 0)
         ip = @data_server.addr[3]
         port = @data_server.addr[1]
         quads = [
@@ -296,6 +251,40 @@ module Ftpd
       @name_prefix = path
       pwd
     end
+    alias cmd_xcwd :cmd_cwd
+
+    def cmd_mkd(argument)
+      syntax_error unless argument
+      ensure_logged_in
+      ensure_file_system_supports :mkdir
+      path = File.expand_path(argument, @name_prefix)
+      ensure_accessible path
+      ensure_exists File.dirname(path)
+      ensure_directory File.dirname(path)
+      ensure_does_not_exist path
+      @file_system.mkdir path
+      reply %Q'257 "#{path}" created'
+    end
+    alias cmd_xmkd :cmd_mkd
+
+    def cmd_rmd(argument)
+      syntax_error unless argument
+      ensure_logged_in
+      ensure_file_system_supports :rmdir
+      path = File.expand_path(argument, @name_prefix)
+      ensure_accessible path
+      ensure_exists path
+      ensure_directory path
+      @file_system.rmdir path
+      reply '250 RMD command successful'
+    end
+    alias cmd_xrmd :cmd_rmd
+
+    def ensure_file_system_supports(method)
+      unless @file_system.respond_to?(method)
+        unimplemented_error
+      end
+    end
 
     def ensure_logged_in
       return if @state == :logged_in
@@ -314,6 +303,12 @@ module Ftpd
       end
     end
 
+    def ensure_does_not_exist(path)
+      if @file_system.exists?(path)
+        error '550 Already exists'
+      end
+    end
+
     def ensure_directory(path)
       unless @file_system.directory?(path)
         error '550 Not a directory'
@@ -326,49 +321,22 @@ module Ftpd
       end
     end
 
-    def ensure_write_supported
-      unless @file_system.respond_to?(:write)
-        unimplemented
-      end
-    end
-
-    def ensure_read_supported
-      unless @file_system.respond_to?(:read)
-        unimplemented
-      end
-    end
-
-    def ensure_delete_supported
-      unless @file_system.respond_to?(:delete)
-        unimplemented
-      end
-    end
-
-    def ensure_list_supported
-      unless @file_system.respond_to?(:list)
-        unimplemented
-      end
-    end
-
-    def ensure_name_list_supported
-      unless @file_system.respond_to?(:name_list)
-        unimplemented
-      end
-    end
-
     def tls_enabled?
       @tls != :off
     end
 
     def cmd_cdup(argument)
+      syntax_error if argument
       ensure_logged_in
       cmd_cwd('..')
     end
+    alias cmd_xcup :cmd_cdup
 
     def cmd_pwd(argument)
       ensure_logged_in
       pwd
     end
+    alias cmd_xpwd :cmd_pwd
 
     def cmd_auth(security_scheme)
       ensure_tls_supported
@@ -412,6 +380,49 @@ module Ftpd
       reply "200 Data protection level #{level_code}"
     end
 
+    def cmd_rnfr(argument)
+      ensure_logged_in
+      ensure_file_system_supports :rename
+      syntax_error unless argument
+      from_path = File.expand_path(argument, @name_prefix)
+      ensure_accessible from_path
+      ensure_exists from_path
+      @rename_from_path = from_path
+      reply '350 RNFR accepted; ready for destination'
+    end
+
+    def cmd_rnto(argument)
+      sequence_error unless @rename_from_path
+      ensure_logged_in
+      ensure_file_system_supports :rename
+      syntax_error unless argument
+      to_path = File.expand_path(argument, @name_prefix)
+      ensure_accessible to_path
+      ensure_does_not_exist to_path
+      @file_system.rename(@rename_from_path, to_path)
+      reply '250 Rename successful'
+      @rename_from_path = nil
+    end
+
+    def self.unimplemented(command)
+      method_name = "cmd_#{command}"
+      define_method method_name do |arguments|
+        unimplemented_error
+      end
+      private method_name
+    end
+
+    unimplemented :abor
+    unimplemented :acct
+    unimplemented :appe
+    unimplemented :help
+    unimplemented :rein
+    unimplemented :rest
+    unimplemented :site
+    unimplemented :smnt
+    unimplemented :stat
+    unimplemented :stou
+
     def pwd
       reply %Q(257 "#{@name_prefix}" is current directory)
     end

data/rake_tasks/yard.rake

@@ -1,3 +1,4 @@
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
+  t.options += ['-o', 'doc-api']
 end

data/spec/disk_file_system_spec.rb

@@ -6,10 +6,10 @@ module Ftpd
     let(:data_dir) {Ftpd::TempDir.make}
     let(:disk_file_system) {DiskFileSystem.new(data_dir)}
     let(:missing_file_error) do
-      [Ftpd::FileSystemError, /No such file or directory/]
+      [Ftpd::PermanentFileSystemError, /No such file or directory/]
     end
     let(:is_a_directory_error) do
-      [Ftpd::FileSystemError, /Is a directory/]
+      [Ftpd::PermanentFileSystemError, /Is a directory/]
     end
     let(:missing_path) {'missing_path'}
 
@@ -31,6 +31,10 @@ module Ftpd
       File.open(data_path(path), 'rb', &:read)
     end
 
+    def directory?(path)
+      File.directory?(data_path(path))
+    end
+
     def exists?(path)
       File.exists?(data_path(path))
     end
@@ -97,14 +101,14 @@ module Ftpd
 
     describe '#delete' do
 
-      context '(normal)' do
+      context '(success)' do
         specify do
           disk_file_system.delete('file')
           exists?('file').should be_false
         end
       end
 
-      context '(file system error)' do
+      context '(error)' do
         specify do
           expect {
             disk_file_system.delete(missing_path)
@@ -116,14 +120,14 @@ module Ftpd
 
     describe '#read' do
 
-      context '(normal)' do
+      context '(success)' do
         let(:path) {'file'}
         specify do
           disk_file_system.read(path).should == canned_contents(path)
         end
       end
 
-      context '(file system error)' do
+      context '(error)' do
         specify do
           expect {
             disk_file_system.read(missing_path)
@@ -137,7 +141,7 @@ module Ftpd
 
       let(:contents) {'file contents'}
 
-      context '(normal)' do
+      context '(success)' do
         let(:path) {'file_path'}
         specify do
           disk_file_system.write(path, contents)
@@ -145,7 +149,7 @@ module Ftpd
         end
       end
 
-      context '(file system error)' do
+      context '(error)' do
         specify do
           expect {
             disk_file_system.write('dir', contents)
@@ -155,6 +159,26 @@ module Ftpd
 
     end
 
+    describe '#mkdir' do
+
+      context '(success)' do
+        let(:path) {'another_subdir'}
+        specify do
+          disk_file_system.mkdir(path)
+          directory?(path).should be_true
+        end
+      end
+
+      context '(error)' do
+        specify do
+          expect {
+            disk_file_system.mkdir('file')
+          }.to raise_error PermanentFileSystemError, /^File exists/
+        end
+      end
+
+    end
+
     describe '#name_list' do
 
       subject do
@@ -235,5 +259,28 @@ module Ftpd
 
     end
 
+    describe '#rename' do
+
+      let(:from_path) {'file'}
+      let(:to_path) {'renamed_file'}
+
+      context '(success)' do
+        specify do
+          disk_file_system.rename(from_path, to_path)
+          exists?(from_path).should be_false
+          exists?(to_path).should be_true
+        end
+      end
+
+      context '(error)' do
+        specify do
+          expect {
+            disk_file_system.rename(missing_path, to_path)
+          }.to raise_error *missing_file_error
+        end
+      end
+
+    end
+
   end
 end