em-ftpd 0.0.1

data/lib/em-ftpd/authentication.rb

@@ -0,0 +1,48 @@
+module EM::FTPD
+  module Authentication
+
+    def initialize
+      @user = nil
+      @requested_user = nil
+      super
+    end
+
+    def logged_in?
+      @user.nil? ? false : true
+    end
+
+    # handle the USER FTP command. This is a user attempting to login.
+    # we simply store the requested user name as an instance variable
+    # and wait for the password to be submitted before doing anything
+    def cmd_user(param)
+      send_param_required and return if param.nil?
+      send_response("500 Already logged in") and return unless @user.nil?
+      @requested_user = param
+      send_response "331 OK, password required"
+    end
+
+    # handle the PASS FTP command. This is the second stage of a user logging in
+    def cmd_pass(param)
+      send_response "202 User already logged in" and return unless @user.nil?
+      send_param_required and return if param.nil?
+      send_response "530 password with no username" and return if @requested_user.nil?
+
+      # return an error message if:
+      #  - the specified username isn't in our system
+      #  - the password is wrong
+
+      @driver.authenticate(@requested_user, param) do |result|
+        if result
+          @name_prefix = "/"
+          @user = @requested_user
+          @requested_user = nil
+          send_response "230 OK, password correct"
+        else
+          @user = nil
+          send_response "530 incorrect login. not logged in."
+        end
+      end
+    end
+
+  end
+end

data/lib/em-ftpd/base_socket.rb

@@ -0,0 +1,47 @@
+module BaseSocket
+
+  attr_reader :aborted
+
+  def initialize
+    @on_stream = nil
+    @aborted = false
+  end
+
+  def on_stream &blk
+    @on_stream = blk if block_given?
+    unless data.empty?
+      @on_stream.call(data) # send all data that was collected before the stream hanlder was set
+      @data = ""
+    end
+    @on_stream
+  end
+
+  def data
+    @data ||= ""
+  end
+
+  def receive_data(chunk)
+    if @on_stream
+      @on_stream.call(chunk)
+    else
+      data << chunk
+    end
+  end
+
+  def unbind
+    if @aborted
+      fail
+    else
+      if @on_stream
+        succeed
+      else
+        succeed data
+      end
+    end
+  end
+
+  def abort
+    @aborted = true
+    close_connection_after_writing
+  end
+end

data/lib/em-ftpd/configurator.rb

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+module EM::FTPD
+
+  class Configurator
+
+    def initialize
+      @user      = nil
+      @group     = nil
+      @daemonise = false
+      @name      = nil
+      @pid_file  = nil
+      @port      = 21
+
+      @driver    = nil
+      @driver_args = []
+    end
+
+    def user(val = nil)
+      if val
+        @user = val.to_s
+      else
+        @user
+      end
+    end
+
+    def uid
+      return nil if @user.nil?
+
+      begin
+        detail = Etc.getpwnam(@user)
+        return detail.uid
+      rescue
+        $stderr.puts "user must be nil or a real account" if detail.nil?
+      end
+    end
+
+    def group(val = nil)
+      if val
+        @group = val.to_s
+      else
+        @group
+      end
+    end
+
+    def gid
+      return nil if @group.nil?
+
+      begin
+        detail = Etc.getpwnam(@group)
+        return detail.gid
+      rescue
+        $stderr.puts "group must be nil or a real group" if detail.nil?
+      end
+    end
+
+
+    def daemonise(val = nil)
+      if val
+        @daemonise = val
+      else
+        @daemonise
+      end
+    end
+
+    def driver(klass = nil)
+      if klass
+        @driver = klass
+      else
+        @driver
+      end
+    end
+
+    def driver_args(*args)
+      if args.empty?
+        @driver_args
+      else
+        @driver_args = args
+      end
+    end
+
+    def name(val = nil)
+      if val
+        @name = val.to_s
+      else
+        @name
+      end
+    end
+
+    def pid_file(val = nil)
+      if val
+        @pid_file = val.to_s
+      else
+        @pid_file
+      end
+    end
+
+    def port(val = nil)
+      if val
+        @port = val.to_i
+      else
+        @port
+      end
+    end
+
+    def check!
+      if @driver.nil?
+        die("driver MUST be specified in the config file")
+      end
+    end
+
+    private
+
+    def die(msg)
+      $stderr.puts msg
+      exit 1
+    end
+  end
+
+end

data/lib/em-ftpd/directories.rb

@@ -0,0 +1,110 @@
+module EM::FTPD
+  module Directories
+    # go up a directory, really just an alias
+    def cmd_cdup(param)
+      send_unauthorised and return unless logged_in?
+      cmd_cwd("..")
+    end
+
+    # As per RFC1123, XCUP is a synonym for CDUP
+    alias cmd_xcup cmd_cdup
+
+
+    # change directory
+    def cmd_cwd(param)
+      send_unauthorised and return unless logged_in?
+      path = build_path(param)
+
+      @driver.change_dir(path) do |result|
+        if result
+          @name_prefix = path
+          send_response "250 Directory changed to #{path}"
+        else
+          send_permission_denied
+        end
+      end
+    end
+
+    # As per RFC1123, XCWD is a synonym for CWD
+    alias cmd_xcwd cmd_cwd
+
+    # make directory
+    def cmd_mkd(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      @driver.make_dir(build_path(param)) do |result|
+        if result
+          send_response "257 Directory created"
+        else
+          send_action_not_taken
+        end
+      end
+    end
+
+    # return a listing of the current directory, one per line, each line
+    # separated by the standard FTP EOL sequence. The listing is returned
+    # to the client over a data socket.
+    #
+    def cmd_nlst(param)
+      send_unauthorised and return unless logged_in?
+      send_response "150 Opening ASCII mode data connection for file list"
+
+      @driver.dir_contents(build_path(param)) do |files|
+        send_outofband_data(files.map(&:name))
+      end
+    end
+
+
+    def default_files(dir)
+      [
+        DirectoryItem.new(:name => '.', :permissions => 'rwxrwxrwx', :directory => true),
+        DirectoryItem.new(:name => '..', :permissions => 'rwxrwxrwx', :directory => true),
+      ]
+    end
+
+    # return a detailed list of files and directories
+    def cmd_list(param)
+      send_unauthorised and return unless logged_in?
+      send_response "150 Opening ASCII mode data connection for file list"
+
+      param = '' if param.to_s == '-a'
+
+      @driver.dir_contents(build_path(param)) do |files|
+        now = Time.now
+        lines = files.map { |item|
+          sizestr = (item.size || 0).to_s.rjust(12)
+          "#{item.directory ? 'd' : '-'}#{item.permissions || 'rwxrwxrwx'} 1 #{item.owner || 'owner'}  #{item.group || 'group'} #{sizestr} #{(item.time || now).strftime("%b %d %H:%M")} #{item.name}"
+        }
+        send_outofband_data(lines)
+      end
+    end
+
+    # return the current directory
+    def cmd_pwd(param)
+      send_unauthorised and return unless logged_in?
+      send_response "257 \"#{@name_prefix}\" is the current directory"
+    end
+
+    # As per RFC1123, XPWD is a synonym for PWD
+    alias cmd_xpwd cmd_pwd
+
+    # delete a directory
+    def cmd_rmd(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      @driver.delete_dir(build_path(param)) do |result|
+        if result
+          send_response "250 Directory deleted."
+        else
+          send_action_not_taken
+        end
+      end
+    end
+
+    # As per RFC1123, XRMD is a synonym for RMD
+    alias cmd_xrmd cmd_rmd
+
+  end
+end

data/lib/em-ftpd/directory_item.rb

@@ -0,0 +1,12 @@
+module EM::FTPD
+  class DirectoryItem
+    ATTRS = [:name, :owner, :group, :size, :time, :permissions, :directory]
+    attr_accessor(*ATTRS)
+
+    def initialize(options)
+      options.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
+    end
+  end
+end

data/lib/em-ftpd/files.rb

@@ -0,0 +1,141 @@
+require 'tempfile'
+
+module EM::FTPD
+  module Files
+
+    # delete a file
+    def cmd_dele(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      path = build_path(param)
+
+      @driver.delete_file(path) do |result|
+        if result
+          send_response "250 File deleted"
+        else
+          send_action_not_taken
+        end
+      end
+    end
+
+    # resume downloads
+    def cmd_rest(param)
+      send_response "500 Feature not implemented"
+    end
+
+    # send a file to the client
+    def cmd_retr(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      path = build_path(param)
+
+      @driver.get_file(path) do |data|
+        if data
+          send_response "150 Data transfer starting #{data.size} bytes"
+          send_outofband_data(data)
+        else
+          send_response "551 file not available"
+        end
+      end
+    end
+
+    # rename a file
+    def cmd_rnfr(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      @from_filename = build_path(param)
+      send_response "350 Requested file action pending further information."
+    end
+
+    # rename a file
+    def cmd_rnto(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      @driver.rename(@from_filename, build_path(param)) do |result|
+        if result
+          send_response "250 File renamed."
+        else
+          send_action_not_taken
+        end
+      end
+    end
+
+    # return the size of a file in bytes
+    def cmd_size(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      @driver.bytes(build_path(param)) do |bytes|
+        if bytes
+          send_response "213 #{bytes}"
+        else
+          send_response "450 file not available"
+        end
+      end
+    end
+
+    # save a file from a client
+    def cmd_stor(param)
+      send_unauthorised and return unless logged_in?
+      send_param_required and return if param.nil?
+
+      path = build_path(param)
+
+      if @driver.respond_to?(:put_file_streamed)
+        cmd_stor_streamed(path)
+      elsif @driver.respond_to?(:put_file)
+        cmd_stor_tempfile(path)
+      else
+        raise "driver MUST respond to put_file OR put_file_streamed"
+      end
+    end
+
+    def cmd_stor_streamed(target_path)
+      wait_for_datasocket do |datasocket|
+        if datasocket
+          send_response "150 Data transfer starting"
+          @driver.put_file_streamed(target_path, datasocket) do |bytes|
+            if bytes
+              send_response "200 OK, received #{bytes} bytes"
+            else
+              send_action_not_taken
+            end
+          end
+        else
+          send_response "425 Error establishing connection"
+        end
+      end
+    end
+
+    def cmd_stor_tempfile(target_path)
+      tmpfile = Tempfile.new("em-ftp")
+
+      wait_for_datasocket do |datasocket|
+        datasocket.on_stream { |chunk|
+          tmpfile.write chunk
+        }
+        send_response "150 Data transfer starting"
+        datasocket.callback {
+          puts "data transfer finished"
+          tmpfile.flush
+          @driver.put_file(target_path, tmpfile.path) do |bytes|
+            if bytes
+              send_response "200 OK, received #{bytes} bytes"
+            else
+              send_action_not_taken
+            end
+          end
+          tmpfile.unlink
+        }
+        datasocket.errback {
+          tmpfile.unlink
+        }
+      end
+    end
+
+  end
+end