fargo 0.2.0 → 0.3.0

data/lib/fargo/protocol/{download.rb → peer_download.rb}

@@ -1,32 +1,12 @@
-require 'zlib'
-
 module Fargo
   module Protocol
-    class Download < EventMachine::Connection
-
-      include Fargo::Utils
-      include Fargo::Protocol::DC
-
-      attr_accessor :download, :client
-
-      def post_init
-        super
+    module PeerDownload
 
-        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
+      attr_accessor :download
 
-      def receive_data data
+      def receive_data_chunk data
         # only download if we're at the correct handshake step
-        return super if @handshake_step != 6
+        return super if @handshake_step != 6 || @download.nil?
 
         if @zlib
           @inflator = Zlib::Inflate.new if @inflator.nil?
@@ -55,76 +35,30 @@ module Fargo
 
           download_finished! if @recvd == @length
         end
+
+        true
+      end
+
+      def parse_data?
+        @handshake_step != 6
       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
-
-              if @download.try(:file).nil?
-                error "Nothing to download from:#{@other_nick}!"
-              end
-            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', 'TTHF ADCGet ZLIG'
-              send_message 'Direction', "Download #{@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 && message[:direction] == 'upload'
-              @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]
-
-              FileUtils.mkdir_p File.dirname(download_path), :mode => 0755
-
-              begin_download!
-
-            else
-              error 'Premature disconnect when key received'
-            end
-
-          when :file_length, :adcsnd
+          when :file_length, :adcsnd, :sending
             if @handshake_step == 5
               @recvd          = 0
               @handshake_step = 6
 
-              @zlib   = message[:zlib]
+              @zlib   = message[:zlib] unless @getblock_sent
               @length = message[:size]
 
-              send_message 'Send' unless @client_extensions.include? 'ADCGet'
+              send_message 'Send' if @get_sent
+
+              if @zlib
+                Fargo.logger.debug(
+                  "Enabling zlib compression on: #{@download.file}")
+              end
 
               @client.channel << [:download_started, {:file => download_path,
                                          :download  => @download,
@@ -147,11 +81,11 @@ module Fargo
           # This wasn't handled by us, proxy it on up to the client
           else
             super
-
         end
       end
 
       def begin_download!
+        FileUtils.mkdir_p File.dirname(download_path), :mode => 0755
         @file = File.open download_path, 'wb'
 
         @file.seek @download.offset
@@ -174,20 +108,45 @@ module Fargo
             download_query = 'TTH/' + @download.tth
           end
 
-          zlig = ''
-          if @client_extensions.include? 'ZLIG'
-            zlig = 'ZL1'
-            Fargo.logger.debug "Enabling zlib compression on: #{@download.file}"
-          end
+          zlig = @client_extensions.include?('ZLIG') ? ' ZL1' : ''
+
+          send_message 'ADCGET', "file #{download_query} #{@download.offset} #{@download.size}#{zlig}"
+
+        # See http://www.teamfair.info/wiki/index.php?title=XmlBZList for
+        # what the $Supports extensions mean for the U?GetZ?Block commands
+        elsif @client_extensions.include? 'GetZBlock'
+          @getblock_sent = true
+          @zlib          = true
+          send_message 'UGetZBlock',
+            "#{@download.offset} #{@download.size} #{@download.file}"
+        elsif @client_extensions.include? 'XmlBZList'
+          @getblock_sent = true
+          @zlib          = false
+          send_message 'UGetBlock',
+            "#{@download.offset} #{@download.size} #{@download.file}"
 
-          send_message 'ADCGET', "file #{download_query} #{@download.offset} #{@download.size} #{zlig}"
         else
+          @get_sent = true
           send_message 'Get', "#{@download.file}$#{@download.offset + 1}"
         end
 
         Fargo.logger.debug "#{self}: Beginning download of #{@download}"
       end
 
+      def unbind
+        super
+
+        Fargo.logger.debug "#{self} Disconnected from: #{@other_nick}"
+
+        if @download
+          download_failed! @last_error, :recvd => @recvd, :length => @length
+        end
+
+        reset_download
+      end
+
+      protected
+
       def download_failed! msg, opts = {}
         Fargo.logger.debug "#{self}: #{msg} #{@download}"
 
@@ -218,24 +177,6 @@ module Fargo
         close_connection_after_writing if download.file_list?
       end
 
-      def publish_args
-        {:nick => @other_nick}
-      end
-
-      def unbind
-        super
-
-        Fargo.logger.debug "#{self} Disconnected from: #{@other_nick}"
-
-        if @download
-          download_failed! @last_error, :recvd => @recvd, :length => @length
-        end
-
-        reset_download
-      end
-
-      private
-
       def reset_download
         @file.close unless @file.nil? || @file.closed?
 
@@ -245,6 +186,7 @@ module Fargo
 
         # clear out these variables
         @inflator = @file_path = @zlib = @download = @length = @recvd = nil
+        @get_sent = @getblock_sent = false
 
         # Go back to the get step
         @handshake_step = 5
@@ -270,12 +212,6 @@ module Fargo
         end
       end
 
-      def error message
-        Fargo.logger.warn @last_error = message
-
-        close_connection
-      end
-
     end
   end
 end

data/lib/fargo/protocol/peer_upload.rb

@@ -0,0 +1,160 @@
+module Fargo
+  module Protocol
+    module PeerUpload
+
+      CHUNKSIZE = 16 * 1024
+
+      def receive_message type, message
+        case type
+          when :adcget, :getblock, :get
+            if @handshake_step == 5
+              if message[:file] == 'files.xml.bz2'
+                @listing = 'filelist'
+              else
+                @listing = @client.listing_for message[:file].gsub("\\", '/')
+              end
+
+              if message[:size] == -1
+                if @listing == 'filelist'
+                  @size = File.size @client.local_file_list_path
+                else
+                  @size = @listing.try :size
+                end
+              else
+                @size = message[:size]
+              end
+
+              @offset = message[:offset]
+              @zlib   = message[:zlib]
+
+              if @listing.nil?
+                if type == :getblock
+                  send_message 'Failed', 'File Not Available'
+                else
+                  send_message 'Error', 'File Not Available'
+                end
+              elsif @client.open_upload_slots == 0 && @listing != 'filelist'
+                send_message 'MaxedOut'
+              elsif type == :adcget
+                zl = @zlib ? ' ZL1' : ''
+                send_message 'ADCSND',
+                  "#{message[:kind]} #{message[:file]} #{@offset} #{@size}#{zl}"
+
+                begin_streaming
+              elsif type == :getblock
+                if message[:size] == -1
+                  send_message 'Sending'
+                else
+                  send_message 'Sending', @size
+                end
+
+                begin_streaming
+              else
+                @handshake_step = 10
+
+                send_message 'FileLength', @size
+              end
+            else
+              error "Premature disconnect when #{type} received"
+            end
+
+          when :send
+            if @handshake_step == 10
+              begin_streaming
+            else
+              error "Premature disconnect when #{type} received"
+            end
+
+          when :cancel
+            if @handshake_step == 11
+              cancel_streaming
+            else
+              error "Premature disconnect when cancel received"
+            end
+
+          else
+            super
+        end
+      end
+
+      def unbind
+        super
+
+        if @listing
+          Fargo.logger.debug "Upload disconnected"
+          finish_streaming
+        end
+      end
+
+      protected
+
+      def begin_streaming
+        @handshake_step = 11
+
+        if @listing == 'filelist'
+          @file = File.open @client.local_file_list_path, 'rb'
+        else
+          @client.take_slot!
+          @file = File.open File.join(@listing.root, @listing.name), 'rb'
+        end
+
+        @file.seek @offset
+        @deflator = Zlib::Deflate.new if @zlib
+        @sent     = 0
+        @looping  = true
+
+        stream_file
+      end
+
+      def finish_streaming
+        @file.try :close
+
+        if @listing == 'filelist'
+          close_connection_after_writing
+        else
+          @client.release_slot!
+        end
+
+        @deflator = @file = @sent = @size = @offset = @listing = @zlib = nil
+        @looping = @canceled = false
+        @handshake_step = 5
+      end
+
+      def cancel_streaming
+        @looping = false
+        @canceled = true
+      end
+
+      def stream_file
+        while @looping do
+          if @sent < @size
+            if get_outbound_data_size > 4 * CHUNKSIZE
+              EventMachine.next_tick{ stream_file }
+              break
+            else
+              to_send = [CHUNKSIZE, @size - @sent].min
+              @sent += to_send
+
+              data = @file.read to_send
+              if @zlib
+                flush_flag = (@sent == @size ? Zlib::FINISH : Zlib::NO_FLUSH)
+                data = @deflator.deflate data, flush_flag
+              end
+
+              send_data data
+            end
+          else
+            finish_streaming
+            break
+          end
+        end
+
+        if @canceled
+          send_message 'Canceled'
+          finish_streaming
+        end
+      end
+
+    end
+  end
+end

data/lib/fargo/search.rb

@@ -6,8 +6,21 @@ module Fargo
     COMPRESSED = 3
     DOCUMENT   = 4
     EXECUTABLE = 5
+    PICTURE    = 6
     VIDEO      = 7
     FOLDER     = 8
+    TTH        = 9
+
+    # See http://www.teamfair.info/wiki/index.php?title=$Search for the
+    # extensions
+    EXTENSIONS = {
+      AUDIO       => [/mp(2|3)/, 'wav', 'au', /(r|s)m/, 'mid', 'flac', 'm4a'],
+      COMPRESSED  => ['zip', 'arj', 'rar', 'lzh', 'gz', 'z', 'arc', 'pak'],
+      DOCUMENT    => [/docx?/, 'txt', 'wri', 'pdf', 'ps', 'tex'],
+      EXECUTABLE  => ['pm', 'exe', 'bat', 'com'],
+      PICTURE     => ['gif', /jpe?g/, 'bmp', 'pcx', 'png', 'wmf', 'psd'],
+      VIDEO       => [/mpe?g/, 'avi', 'asf', 'mov', 'mkv']
+    }
 
     attr_accessor :size_restricted, :is_minimum_size, :size, :filetype, :pattern
 
@@ -36,14 +49,34 @@ module Fargo
       pattern.gsub('$', ' ')
     end
 
-    def matches_result? map
-      file = map[:file].downcase
+    def matches? map
+      if map.is_a?(Listing)
+        listing = map
+        map     = {
+          :file => listing.name,
+          :size => listing.size,
+          :tth  => listing.tth
+        }
+      end
+
+      file = map[:file].try(:downcase) || ''
 
-      matches_query = queries.inject(true) do |last, word|
-        last && file.index(word.downcase)
+      if @filetype == TTH
+        matches_query = (@pattern =~ /^TTH:(\w+)$/ && map[:tth] == $1)
+      else
+        matches_query = queries.inject(true) do |last, word|
+          last && file.index(word.downcase)
+        end
+
+        patterns = EXTENSIONS[@filetype]
+
+        if patterns && matches_query
+          ext = File.extname file
+          matches_query = patterns.any?{ |p| ext =~ /^\.#{p}$/i }
+        end
       end
 
-      if size_restricted == 'T'
+      if size_restricted
         if is_minimum_size
           matches_query && map[:size] > size
         else

data/lib/fargo/supports/downloads.rb

@@ -1,16 +1,16 @@
 module Fargo
+  class Download < Struct.new(:nick, :file, :tth, :size, :offset)
+    attr_accessor :percent, :status
+
+    def file_list?
+      file == 'files.xml.bz2'
+    end
+  end
+
   module Supports
     module Downloads
       extend ActiveSupport::Concern
 
-      class Download < Struct.new(:nick, :file, :tth, :size, :offset)
-        attr_accessor :percent, :status
-
-        def file_list?
-          file == 'files.xml.bz2'
-        end
-      end
-
       included do
         set_callback :initialization, :after, :initialize_download_lists
       end
@@ -30,22 +30,22 @@ module Fargo
         finished_downloads.clear
       end
 
-      def download nick, file=nil, tth=nil, size=-1, offset=0
+      def download nick, file = nil, tth = nil, size = -1, offset = 0
         raise ConnectionException.new 'Not connected yet!' unless hub
 
-        if nick.is_a?(Supports::FileList::Listing)
-          listing = nick
-          nick    = listing.nick
-          file    = listing.name
-          tth     = listing.tth
-          size    = listing.size
-        elsif nick.is_a?(Download)
+        if nick.is_a?(Download)
           dl     = nick
           nick   = dl.nick
           file   = dl.file
           tth    = dl.tth
           size   = dl.size || -1
           offset = dl.offset || 0
+        elsif nick.is_a?(Listing) # i.e. a listing
+          listing = nick
+          nick    = listing.nick
+          file    = listing.name
+          tth     = listing.tth
+          size    = listing.size
         end
 
         raise 'File must not be nil!' if file.nil?
@@ -177,7 +177,7 @@ module Fargo
               download.percent = 1
               download.status  = 'finished'
               download_finished! user, false
-            elsif type == :download_failed || type == :download_disconnected
+            elsif type == :download_failed || type == :peer_disconnected
               channel.unsubscribe subscribed_id
               download.status = 'failed'
               download_finished! user, true

data/lib/fargo/supports/local_file_list.rb

@@ -0,0 +1,164 @@
+require 'bzip2'
+require 'libxml'
+require 'active_support/core_ext/module/synchronization'
+
+module Fargo
+  module Supports
+    module LocalFileList
+      extend ActiveSupport::Concern
+      include TTH
+
+      attr_reader :local_file_list
+
+      included do
+        set_callback :initialization, :after, :initialize_upload_lists
+        set_callback :connect, :after, :schedule_update
+      end
+
+      def share_directory dir
+        @shared_directories << dir unless @shared_directories.include? dir
+
+        if connected?
+          EventMachine.defer {
+            update_tth dir
+            write_file_list
+          }
+        else
+          update_tth dir
+          write_file_list
+        end
+      end
+
+      def share_size
+        config.override_share_size || @share_size
+      end
+
+      def local_file_list_path
+        File.join config.config_dir, 'files.xml.bz2'
+      end
+
+      def local_listings
+        collect_local_listings @local_file_list, [], nil
+      end
+
+      def search_local_listings search
+        collect_local_listings @local_file_list, [], search
+      end
+
+      def listing_for query
+        if query =~ /^TTH\/(\w+)$/
+          tth = $1
+          local_listings.detect{ |l| l.tth = tth }
+        else
+          local_listings.detect{ |l| l.name == query }
+        end
+      end
+
+      protected
+
+      def collect_local_listings hash, arr, search
+        hash.each_pair do |k, v|
+          if v.is_a?(Listing)
+            arr << v if search.nil? || search.matches?(v)
+          else
+            collect_local_listings v, arr, search
+          end
+        end
+
+        arr
+      end
+
+      def write_file_list
+        doc      = LibXML::XML::Document.new
+        doc.root = LibXML::XML::Node.new 'FileListing'
+        doc.root['Version']   = '1'
+        doc.root['Base']      = '/'
+        doc.root['Generator'] = "fargo #{VERSION}"
+
+        create_entities @local_file_list, doc.root
+
+        FileUtils.mkdir_p config.config_dir
+        Bzip2::Writer.open(local_file_list_path, 'w') do |f|
+          f << doc.to_s(:indent => false)
+        end
+      end
+
+      def update_tth root, directory = nil, hash = nil
+        if directory.nil?
+          directory = root
+          root      = File.dirname(root)
+        end
+
+        hash ||= (@local_file_list[File.basename(directory)] ||= {})
+
+        Pathname.glob(directory + '/*').each do |path|
+          if path.directory?
+            update_tth_without_synchronization root, path.to_s,
+              hash[path.basename.to_s] ||= {}
+          elsif hash[path.basename.to_s].nil? ||
+              path.mtime > hash[path.basename.to_s].mtime
+            hash[path.basename.to_s] = Listing.new(
+                file_tth(path.to_s),
+                path.size,
+                path.to_s.gsub(root + '/', ''),
+                config.nick,
+                path.mtime,
+                root
+            )
+
+            @share_size += path.size
+          end
+        end
+
+        to_remove = []
+
+        hash.each_pair do |k, v|
+          file = directory + '/' + k
+          unless File.exists?(file)
+            to_remove << k
+            @share_size -= File.size file if File.file?(file)
+          end
+        end
+
+        to_remove.each{ |k| hash.delete k }
+      end
+
+      synchronize :update_tth, :with => :@update_lock
+
+      def create_entities entity, node
+        entity.each_pair do |k, v|
+          if v.is_a? Hash
+            dir = LibXML::XML::Node.new 'Directory'
+            dir['Name'] = k
+            create_entities v, dir
+            node << dir
+          else
+            file = LibXML::XML::Node.new 'File'
+            file['Name'] = k
+            file['Size'] = v.size.to_s
+            file['TTH']  = v.tth
+
+            node << file
+          end
+        end
+      end
+
+      def schedule_update
+        EventMachine::Timer.new(60) do
+          @shared_directories.each{ |d| update_tth d }
+
+          write_file_list
+          schedule_update
+        end
+      end
+
+      def initialize_upload_lists
+        @shared_directories = []
+        @local_file_list    = {}
+        @share_size         = 0
+        @update_lock        = Mutex.new
+      end
+
+    end
+  end
+end