fargo 0.2.0 → 0.3.0

data/README.md

@@ -0,0 +1,61 @@
+# Fargo
+
+This gem is an implementation of the [Direct Connect (DC) protocol](http://en.wikipedia.org/wiki/Direct_Connect_\(file_sharing\)) in ruby.
+
+## Installation
+
+`gem install fargo`
+
+## Usage
+
+<pre>
+require 'fargo'
+
+client = Fargo::Client.new
+
+client.configure do |config|
+  config.hub_address = [address of the hub]   # Defaults to 127.0.0.1
+  config.hub_port    = [port of the hub]      # Defaults to 7314
+  config.passive     = true                   # Defaults to false
+  config.address     = '1.2.3.4'              # Defaults to machine IP
+  config.active_port = [port to listen on]    # Defaults to 7315
+  config.search_port = [port to listen on]    # Defaults to 7316
+end
+
+EventMachine.run {
+  client.connect
+
+  client.nicks                # list of nicks registered
+  client.download nick, file  # download a file from a user
+  client.file_list nick       # get a list of files from a user
+
+  client.channel.subscribe do |type, message|
+    # type is the type of message
+    # message is a hash of what was received
+  end
+}
+</pre>
+
+See `lib/fargo/client.rb` for a full list of configuration options
+
+## MIT License
+
+Copyright (c) 2010 Alex Crichton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/ext/fargo/extconf.rb

@@ -1,7 +1,7 @@
 # This uses mkmf
 require 'mkmf'
 
-if RUBY_VERSION =~ /1.9/
+if RUBY_VERSION =~ /1\.9/
   $CFLAGS << ' -DRUBY_19'
 end
 

data/ext/fargo/fargo_tth.c

@@ -5,8 +5,6 @@
 #ifndef RUBY_19
 # define RSTRING_LEN(s) (RSTRING(s)->len)
 # define RSTRING_PTR(s) (RSTRING(s)->ptr)
-# define RARRAY_LEN(s) (RARRAY(s)->len)
-# define RARRAY_PTR(s) (RARRAY(s)->ptr)
 #endif
 
 VALUE rb_tth_file(VALUE self, VALUE filename) {

data/lib/fargo/client.rb

@@ -8,19 +8,21 @@ module Fargo
     include ActiveSupport::Configurable
     include ActiveSupport::Callbacks
 
-    define_callbacks :initialization
-
-    include Fargo::Supports::Chat
-    include Fargo::Supports::Uploads
-    include Fargo::Supports::NickList
-    include Fargo::Supports::Searches
-    include Fargo::Supports::Downloads
-    include Fargo::Supports::Persistence
-    include Fargo::Supports::Timeout
-    include Fargo::Supports::FileList
+    define_callbacks :initialization, :connect
+
+    include Supports::Chat
+    include Supports::Uploads
+    include Supports::NickList
+    include Supports::Searches
+    include Supports::Downloads
+    include Supports::Persistence
+    include Supports::Timeout
+    include Supports::RemoteFileList
+    include Supports::LocalFileList
 
     configure do |config|
       config.download_dir   = '/tmp/fargo/downloads'
+      config.config_dir     = '/tmp/fargo/config'
       config.address        = IPSocket.getaddress(Socket.gethostname)
       config.passive        = false
       config.nick           = 'fargo'
@@ -33,6 +35,8 @@ module Fargo
       config.password       = ''
       config.speed          = 'DSL'
       config.email          = nil
+
+      config.override_share_size = 5368709121 # 5 GB + 1 byte
     end
 
     attr_reader :hub, :channel
@@ -54,21 +58,23 @@ module Fargo
         Fargo.logger.debug e.backtrace.join("\n")
       }
 
-      EventMachine.connect config.hub_address, config.hub_port,
-          Fargo::Protocol::Hub do |conn|
-        @hub        = conn
-        @hub.client = self
-      end
-
-      unless config.passive
-        EventMachine.start_server '0.0.0.0', config.active_port,
-            Fargo::Protocol::Download do |conn|
-          conn.client = self
+      run_callbacks :connect do
+        EventMachine.connect config.hub_address, config.hub_port,
+            Protocol::Hub do |conn|
+          @hub        = conn
+          @hub.client = self
         end
 
-        EventMachine.open_datagram_socket '0.0.0.0', config.search_port,
-            Fargo::Protocol::DC do |conn|
-          conn.client = self
+        unless config.passive
+          EventMachine.start_server '0.0.0.0', config.active_port,
+              Protocol::Peer do |conn|
+            conn.client = self
+          end
+
+          EventMachine.open_datagram_socket '0.0.0.0', config.search_port,
+              Protocol::DC do |conn|
+            conn.client = self
+          end
         end
       end
     end
@@ -83,7 +89,7 @@ module Fargo
     end
 
     def description
-      "<fargo V:#{Fargo::VERSION},M:#{config.passive ? 'P' : 'A'},H:1/0/0,S:#{open_slots},Dt:1.2.6/W>"
+      "<fargo V:#{VERSION},M:#{config.passive ? 'P' : 'A'},H:1/0/0,S:#{open_upload_slots},Dt:1.2.6/W>"
     end
 
   end

data/lib/fargo/parser.rb

@@ -1,12 +1,12 @@
 module Fargo
   module Parser
-  
+
     #
     # See <http://www.teamfair.info/DC-Protocol.htm> for more information
     #
-    @@commandmatch    = /\$(.*)$/
+    @@commandmatch    = /^\$(.*)$/
     @@messagematch    = /^<(.*?)> (.*)$/
-  
+
     # TODO: Supports, UserIP, ops command
     # Client - hub commands
     @@validatedenied  = /^ValidateDenide/
@@ -24,35 +24,39 @@ module Fargo
     @@hubto           = /^To: (.*?) From: Hub \$(.*)$/
     @@ctm             = /^ConnectToMe (.*?) (.*?):(.*?)$/
     @@nicklist        = /^NickList (.*?)$/
-    @@psr             = /^SR (.*?) (.*?)\005(.*?) (.*?)\/(.*?)\005(.*?) \((.*?):(.*?)\)$/
+    @@psr             = /^SR (.*?) (.*?)\005(.*?) (.*?)\/(.*?)\005(.*?) \((.*?):(.*?)\)(?:\005.*)?$/
+    @@psrd            = /^SR (.*?) (.*?) (.*?)\/(.*?)\005(.*?) \((.*?):(.*?)\)(?:\005.*)?$/
     @@psearch         = /^Search Hub:(.*) (.)\?(.)\?(.*)\?(.)\?(.*)$/
     @@search          = /^Search (.*):(.*) (.)\?(.)\?(.*)\?(.)\?(.*)$/
     @@oplist          = /^OpList (.*?)$/
     @@botlist         = /^BotList (.*?)$/
     @@quit            = /^Quit (.*)$/
-    @@sr              = /^SR (.*?) (.*?)\005(.*?) (.*?)\/(.*?)\005(.*?) (.*?):(.*?)$/
     @@rctm            = /^RevConnectToMe (.*?) (.*?)$/
-  
+
     # Client to client commands
-    @@mynick        = /^MyNick (.*)$/
-    @@key           = /^Key (.*)$/
-    @@direction     = /^Direction (Download|Upload) (\d+)$/
-    @@get           = /^Get (.*)\$(\d+)$/
-    @@send          = /^Send$/
-    @@filelength    = /^FileLength (.*?)$/
-    @@getlistlen    = /^GetListLen$/
-    @@maxedout      = /^MaxedOut$/
-    @@supports      = /^Supports (.*)$/
-    @@error         = /^Error (.*)$/
-    @@ugetblock     = /^UGetBlock (.*?) (.*?) (.*)$/
-    @@adcsnd        = /^ADCSND (.*?) (.*?) (.*?) (.*?)$/
-    @@adcsnd_zl1    = /^ADCSND (.*?) (.*?) (.*?) (.*?) ZL1$/
-  
+    @@mynick     = /^MyNick (.*)$/
+    @@key        = /^Key (.*)$/
+    @@direction  = /^Direction (Download|Upload) (\d+)$/
+    @@get        = /^Get (.*)\$(\d+)$/
+    @@getzblock  = /^U?GetZBlock (.*?) (.*?) (.*?)$/
+    @@send       = /^Send$/
+    @@filelength = /^FileLength (.*?)$/
+    @@getlistlen = /^GetListLen$/
+    @@maxedout   = /^MaxedOut$/
+    @@supports   = /^Supports (.*)$/
+    @@error      = /^Error (.*)$/
+    @@cancel     = /^Cancel$/
+    @@canceled   = /^Canceled$/
+    @@failed     = /^Failed (.*)$/
+    @@sending    = /^Sending (.*)$/
+    @@getblock   = /^U?GetBlock (.*?) (.*?) (.*)$/
+    @@adcsnd     = /^ADCSND (.*?) (.*?) (.*?) (.*?)( ZL1)?$/
+    @@adcget     = /^ADCGET (.*?) (.*?) (.*?) (.*?)( ZL1)?$/
+
     def parse_message text
       case text
         when @@commandmatch then parse_command_message $1
         when @@messagematch then {:type => :chat, :from => $1, :text => $2}
-        when ''             then {:type => :garbage}
         else                     {:type => :mystery, :text => text}
       end
     end
@@ -64,58 +68,85 @@ module Fargo
         when @@badpass        then {:type => :badpass}
         when @@lock           then {:type => :lock, :lock => $1}
         when @@hubname        then {:type => :hubname, :name => $1}
-        when @@hubname        then {:type => :hubfull}
+        when @@hubfull        then {:type => :hubfull}
         when @@hubtopic       then {:type => :hubtopic, :topic => $1}
-        when @@hello          then {:type => :hello, :who  => $1}
-        when @@myinfo         then {:type => :myinfo, :nick => $1, :interest => $2, :speed => $3,
+        when @@hello          then {:type => :hello, :nick  => $1}
+        when @@myinfo         then {:type => :myinfo, :nick => $1,
+                                    :interest => $2, :speed => $3,
                                     :email => $4, :sharesize => $5.to_i}
-        when @@myinfo2        then {:type => :myinfo, :nick=> $1, :interest => $2, :sharesize=> 0}
-        when @@to             then {:type => :privmsg, :to => $1, :from => $2, :text => $3}
-        when @@hubto          then {:type => :privmsg, :to => $1, :from => "Hub", :text => $2}
-        when @@ctm            then {:type => :connect_to_me, :nick => $1, :address => $2, 
-                                    :port => $3.to_i}
-        when @@nicklist       then {:type => :nick_list, :nicks => $1.split(/\$\$/)}
-        when @@psr            then {:type => :search_result, :nick => $1, :file => $2, 
-                                    :size => $3.to_i, :open_slots => $4.to_i, :slots => $5.to_i, 
-                                    :hub => $6, :address => $7, 
+        when @@myinfo2        then {:type => :myinfo, :nick=> $1,
+                                    :interest => $2, :sharesize => 0}
+        when @@to             then {:type => :privmsg, :to => $1, :from => $2,
+                                    :text => $3}
+        when @@hubto          then {:type => :privmsg, :to => $1,
+                                    :from => 'Hub', :text => $2}
+        when @@ctm            then {:type => :connect_to_me, :nick => $1,
+                                    :address => $2, :port => $3.to_i}
+        when @@nicklist       then {:type => :nick_list,
+                                    :nicks => $1.split('$$')}
+        when @@psr            then {:type => :search_result, :nick => $1,
+                                    :file => $2, :size => $3.to_i,
+                                    :open_slots => $4.to_i, :slots => $5.to_i,
+                                    :hub => $6, :address => $7,
                                     :port => $8.to_i}
-        when @@psearch        then {:type => :search, :searcher => $1, :restrict_size => $2,
-                                    :min_size => $3.to_i, :size => $4.to_i, :filetype => $5, 
+        when @@psrd           then {:type => :search_result, :nick => $1,
+                                    :dir => $2,
+                                    :open_slots => $3.to_i, :slots => $4.to_i,
+                                    :hub => $5, :address => $6,
+                                    :port => $7.to_i}
+        when @@psearch        then {:type => :search, :searcher => $1,
+                                    :restrict_size => $2 == 'T',
+                                    :is_minimum_size => $3 == 'F',
+                                    :size => $4.to_i, :filetype => $5.to_i,
                                     :pattern => $6}
-        when @@search         then {:type => :search, :address => $1, :port => $2.to_i, 
-                                    :restrict_size => $3,
-                                    :min_size => $4.to_i, :size => $5.to_i, :filetype => $6, 
-                                    :pattern => $7}
-        when @@oplist         then {:type => :op_list, :nicks => $1.split(/\$\$/)}
-        when @@oplist         then {:type => :bot_list, :nicks => $1.split(/\$\$/)}
-        when @@quit           then {:type => :quit, :who => $1}
-        when @@sr             then {:type => :search_result, :nick => $2, :file => $3, 
-                                    :size => $4.to_i, :open_slots => $5.to_i, :slots => $6.to_i, 
-                                    :hubname => $7}
+        when @@search         then {:type => :search, :address => $1,
+                                    :port => $2.to_i,
+                                    :restrict_size => $3 == 'T',
+                                    :is_minimum_size => $4 == 'F',
+                                    :size => $5.to_i,
+                                    :filetype => $6.to_i, :pattern => $7}
+        when @@oplist         then {:type => :op_list,
+                                    :nicks => $1.split('$$')}
+        when @@oplist         then {:type => :bot_list,
+                                    :nicks => $1.split('$$')}
+        when @@quit           then {:type => :quit, :nick => $1}
         when @@rctm           then {:type => :revconnect, :who => $1}
-        
+
         when @@mynick         then {:type => :mynick, :nick => $1}
         when @@key            then {:type => :key, :key => $1}
-        when @@direction      then {:type => :direction, :direction => $1.downcase, :number => $3.to_i}
-        when @@get            then {:type => :get, :path => $1, :offset => $2.to_i - 1}
+        when @@direction      then {:type => :direction,
+                                    :direction => $1.downcase,
+                                    :number => $3.to_i}
+        when @@get            then {:type => :get, :file => $1,
+                                    :offset => $2.to_i - 1, :size => -1}
         when @@send           then {:type => :send}
         when @@filelength     then {:type => :file_length, :size => $1.to_i}
         when @@getlistlen     then {:type => :getlistlen}
         when @@maxedout       then {:type => :noslots}
-        when @@supports       then {:type => :supports, :extensions => $1.split(' ')}
+        when @@supports       then {:type => :supports,
+                                    :extensions => $1.split(' ')}
         when @@error          then {:type => :error, :message => $1}
-        when @@adcsnd_zl1      then {:type => :adcsnd, :kind => $1, :tth => $2, :offset => $3.to_i, 
-                                    :size => $4.to_i, :zlib => true}
-        when @@adcsnd         then {:type => :adcsnd, :kind => $1, :tth => $2, :offset => $3.to_i, 
-                                                              :size => $4.to_i}
-        when @@ugetblock      then {:type => :ugetblock, :start => $1.to_i, :finish => $2.to_i,
-                                    :path => $3}
-        when @@userip         then 
+        when @@failed         then {:type => :error, :message => $1}
+        when @@cancel         then {:type => :cancel}
+        when @@canceled       then {:type => :canceled}
+        when @@sending        then {:type => :sending, :size => $1.to_i}
+        when @@adcsnd         then {:type => :adcsnd, :kind => $1, :file => $2,
+                                    :offset => $3.to_i, :size => $4.to_i,
+                                    :zlib => !$5.nil?}
+        when @@adcget         then {:type => :adcget, :kind => $1, :file => $2,
+                                    :offset => $3.to_i, :size => $4.to_i,
+                                    :zlib => !$5.nil?}
+        when @@getzblock      then {:type => :getblock, :file => $3,
+                                    :size => $2.to_i, :offset => $1.to_i,
+                                    :zlib => true}
+        when @@getblock       then {:type => :getblock, :start => $1.to_i,
+                                    :size => $2.to_i, :file => $3}
+        when @@userip         then
           h = {:type => :userip, :users => {}}
-          $1.split("$$").map{ |s| h[:users][s.split(' ')[0]] = s.split(' ')[1]}
+          $1.split('$$').map{ |s| h[:users][s.split(' ')[0]] = s.split(' ')[1]}
           h
-        else                       {:type => :mystery, :text => text}
+        else                       {:type => :mystery, :text => '$' + text}
       end
     end
   end
-end
+end

data/lib/fargo/protocol/dc.rb

@@ -2,7 +2,7 @@ module Fargo
   module Protocol
     module DC
 
-      include Fargo::Parser
+      include Parser
       attr_accessor :client
 
       def post_init
@@ -24,14 +24,27 @@ module Fargo
         send_data data
       end
 
+      def receive_data_chunk chunk
+        chunk.chomp! '|'
+        Fargo.logger.debug "#{self}: Received: #{chunk.inspect}"
+        hash = parse_message chunk
+        receive_message hash[:type], hash
+      end
+
+      def parse_data?
+        true
+      end
+
       def receive_data data
-        @received_data << data
+        if parse_data?
+          @received_data << data
 
-        while message = @received_data.slice!(/[^\|]+\|/)
-          message.chomp! '|'
-          Fargo.logger.debug "#{self}: Received: #{message.inspect}"
-          hash = parse_message message
-          receive_message hash[:type], hash
+          while parse_data? && chunk = @received_data.slice!(/[^\|]+\|/)
+            receive_data_chunk chunk
+          end
+        else
+          receive_data_chunk @received_data + data
+          @received_data = ''
         end
       end
 
@@ -39,9 +52,12 @@ module Fargo
         {}
       end
 
+      def connection_type
+        :dc
+      end
+
       def unbind
         if client
-          connection_type = self.class.name.split('::').last.downcase
           args = [:"#{connection_type}_disconnected", publish_args]
           client.channel << args
         end

data/lib/fargo/protocol/hub.rb

@@ -1,12 +1,16 @@
 module Fargo
   module Protocol
-    class Hub < EventMachine::Connection
+    module Hub
 
-      include Fargo::Protocol::DC
-      include Fargo::Utils
+      include Utils
+      include Protocol::DC
 
       attr_reader :hubname
 
+      def connection_type
+        :hub
+      end
+
       # See <http://www.teamfair.info/DC-Protocol.htm> for specifics on
       # the DC protocol
       def receive_message type, message
@@ -20,10 +24,10 @@ module Fargo
           when :getpass
             send_message 'MyPass', @client.config.password
           when :badpass, :hubfull
-            Fargo.logger.warn "Disconnecting because of: #{message.inspect}"
+            Fargo.logger.info "Disconnecting because of: #{message.inspect}"
             close_connection_after_writing
           when :hello
-            if message[:who] == @client.config.nick
+            if message[:nick] == @client.config.nick
               Fargo.logger.info "Connected to DC Hub #{@hubname}"
               @validated = true
 
@@ -36,37 +40,54 @@ module Fargo
             end
 
           when :connect_to_me
-            if !@client.nicks.include?(message[:nick])
-              Fargo.logger.info "Invalid connect_to_me request from: #{message[:nick]}"
-              return
-            end
-
             EventMachine.connect message[:address], message[:port],
-                Fargo::Protocol::Download do |conn|
+                Protocol::Peer do |conn|
               conn.client     = @client
               conn.send_lock # We connect first, we send lock first
             end
 
           when :search
             # Let the client handle the results
-            @results = @client.search_files message
+            search = Search.new message
+            @listings = @client.search_local_listings search
 
-            # Send all the results to the peer. Take care of active/passive
-            # connections
-            @results.each { |r|
-              if message[:address]
-                r.active_send @client.config.nick, message[:ip], message[:port]
+            @results = @listings.map do |l|
+              file = l.name.gsub '/', "\\"
+              if File.directory? l.name
+                s = file
               else
-                send_message 'SR', "#{@client.config.nick} #{r}"
+                s = "#{file}\005#{l.size}"
               end
-            }
+
+              s + sprintf(" %d/%d\005%s (%s:%d)", @client.open_upload_slots,
+                                                  @client.config.upload_slots,
+                                                  'TTH:' + l.tth,
+                                                  @client.config.hub_address,
+                                                  @client.config.hub_port)
+            end
+
+            # Send all the results to the peer. Take care of active/passive
+            # connections
+            if message[:address]
+              socket = EventMachine.open_datagram_socket '0.0.0.0', 0
+              @results.each{ |r|
+                socket.send_datagram "$SR #{@client.config.nick} #{r}|",
+                  message[:address], message[:port]
+              }
+              socket.close_connection_after_writing
+            else
+              @results.each{ |r|
+                send_message 'SR',
+                  "#{@client.config.nick} #{r}\005#{message[:searcher]}"
+              }
+            end
 
           when :revconnect
             if @client.config.passive
               send_message 'RevConnectToMe',
                   "#{@client.config.nick} #{message[:who]}"
             else
-              send_message 'ConnectToMe', "#{@client.config.nick} #{@client.config.address}:#{@client.config.extport}"
+              send_message 'ConnectToMe', "#{message[:who]} #{@client.config.address}:#{@client.config.active_port}"
             end
 
           # proxy this message on up the stack if we don't handle it

data/lib/fargo/protocol/peer.rb

@@ -0,0 +1,114 @@
+require 'zlib'
+
+module Fargo
+  module Protocol
+    module Peer
+
+      include Utils
+      include Protocol::DC
+      include PeerDownload
+      include PeerUpload
+
+      attr_accessor :client
+
+      def connection_type
+        :peer
+      end
+
+      def post_init
+        super
+
+        set_comm_inactivity_timeout 20
+
+        @lock, @pk      = generate_lock
+        @handshake_step = 0
+      end
+
+      def send_lock
+        @lock_sent = true
+        send_message 'MyNick', @client.config.nick
+        send_message 'Lock', "#{@lock} Pk=#{@pk}"
+      end
+
+      def supports
+        'MiniSlots XmlBZList ADCGet TTHF ZLIG GetZBlock'
+      end
+
+      def receive_message type, message
+        case type
+          when :mynick
+            if @handshake_step == 0
+              @handshake_step  = 1
+              @other_nick      = message[:nick]
+
+              client.channel << [:download_opened,
+                  publish_args.merge(:connection => self)]
+              @download = @client.lock_next_download! @other_nick, self
+
+              @direction = @download.nil? ? 'Upload' : 'Download'
+            else
+              error 'Premature disconnect when mynick received'
+            end
+
+          when :lock
+            if @handshake_step == 1
+              @remote_lock    = message[:lock]
+              @handshake_step = 2
+
+              send_lock unless @lock_sent
+
+              send_message 'Supports', supports
+              send_message 'Direction', "#{@direction} #{@my_num = rand(10000)}"
+              send_message 'Key', generate_key(@remote_lock)
+            else
+              error 'Premature disconnect when lock received'
+            end
+
+          when :supports
+            if @handshake_step == 2
+              @client_extensions = message[:extensions]
+              @handshake_step    = 3
+            else
+              error 'Premature disconnect when supports received'
+            end
+
+          when :direction
+            if @handshake_step == 3
+              @client_num     = message[:number]
+              @handshake_step = 4
+            else
+              error 'Premature disconnect when direction received'
+            end
+
+          when :key
+            if @handshake_step == 4 && generate_key(@lock) == message[:key]
+              @handshake_step = 5
+
+              begin_download! if @direction == 'Download'
+
+            else
+              error 'Premature disconnect when key received'
+            end
+
+          # This wasn't handled by us, proxy it on up to the client
+          else
+            super
+
+        end
+      end
+
+      def publish_args
+        {:nick => @other_nick}
+      end
+
+      protected
+
+      def error message
+        Fargo.logger.warn @last_error = message
+
+        close_connection
+      end
+
+    end
+  end
+end