xmpp4r 0.3

data/lib/xmpp4r/bytestreams/helper/filetransfer.rb

@@ -0,0 +1,315 @@
+require 'callbacks'
+
+require 'xmpp4r/bytestreams/iq/si'
+require 'xmpp4r/dataforms/x/data'
+require 'xmpp4r/bytestreams/helper/ibb/base'
+require 'xmpp4r/bytestreams/helper/socks5bytestreams/base'
+
+module Jabber
+  module FileTransfer
+    ##
+    # The TransferSource is an interface (Mix-in)
+    # which sources for FileTransfer#offer should include
+    module TransferSource
+      ##
+      # Filename of the offered file
+      def filename
+      end
+      ##
+      # Mime-type of the offered file, can be nil
+      def mime
+      end
+      ##
+      # Size of the offered file
+      def size
+      end
+      ##
+      # MD5-Sum of the offered file, can be nil
+      def md5
+      end
+      ##
+      # Date of the offered file, can be nil
+      def date
+      end
+      ##
+      # Read a chunk from the source
+      #
+      # If this is a ranged transfer, it should
+      # implement length checking
+      # length:: [Fixnum]
+      def read(length=nil)
+      end
+      ##
+      # Seek in the source for ranged transfers
+      def seek(position)
+      end
+      ##
+      # Set the amount of data to send for ranged transfers
+      def length=(l)
+      end
+      ##
+      # Does implement the methods seek and length= ?
+      #
+      # FileTransfer will only then offer a ranged transfer.
+      # result:: [false] or [true]
+      def can_range?
+        false
+      end
+    end
+
+    ##
+    # Simple implementation of TransferSource
+    # for sending simple files
+    # (supports ranged transfers)
+    class FileSource
+      include TransferSource
+
+      def initialize(filename)
+        @file = File.new(filename)
+        @filename = filename
+        @bytes_read = 0
+        @length = nil
+      end
+
+      def filename
+        File::basename @filename
+      end
+
+      ##
+      # Everything is 'application/octet-stream'
+      def mime
+        'application/octet-stream'
+      end
+
+      def size
+        File.size @filename
+      end
+
+      def date
+        @file.mtime
+      end
+
+      ##
+      # Because it can_range?, this method implements length checking
+      def read(length=512)
+        if @length
+          return nil if @bytes_read >= @length  # Already read everything requested
+          if @bytes_read + length > @length # Will we read more than requested?
+            length = @length - @bytes_read  # Truncate it!
+          end
+        end
+        
+        buf = @file.read(length)
+        @bytes_read += buf.size if buf
+        buf
+      end
+
+      def seek(position)
+        @file.seek(position)
+      end
+
+      def length=(l)
+        @length = l
+      end
+
+      def can_range?
+        true
+      end
+    end
+
+    ##
+    # The FileTransfer helper provides the ability to respond
+    # to incoming and to offer outgoing file-transfers.
+    class Helper
+      ##
+      # Set this if you want to use this helper in a Component
+      attr_accessor :my_jid
+      ##
+      # Set this to false if you don't want to use SOCKS5Bytestreams
+      attr_accessor :allow_bytestreams
+      ##
+      # Set this to false if you don't want to use IBB
+      attr_accessor :allow_ibb
+
+      ##
+      # Create a new FileTransfer instance
+      def initialize(stream)
+        @stream = stream
+        @my_jid = nil
+        @allow_bytestreams = true
+        @allow_ibb = true
+
+        @incoming_cbs = CallbackList.new
+
+        @stream.add_iq_callback(150, self) { |iq|
+          if iq.type == :set
+            file = iq.first_element('si/file')
+            field = nil
+            iq.each_element('si/feature/x') { |e| field = e.field('stream-method') }
+
+            if file and field
+              @incoming_cbs.process(iq, file)
+              true
+            else
+              false
+            end
+          else
+            false
+          end
+        }
+      end
+
+      ##
+      # Add a callback which will be invoked upon an incoming file-transfer
+      #
+      # block takes two arguments:
+      # * Iq
+      # * Bytestreams::IqSiFile in the Iq
+      # You may then invoke accept or decline
+      def add_incoming_callback(priority = 0, ref = nil, &block)
+        @incoming_cbs.add(priority, ref, block)
+      end
+
+      ##
+      # Accept an incoming file-transfer,
+      # to be used in a block given to add_incoming_callback
+      #
+      # offset and length will be ignored if there is no
+      # 'si/file/range' in iq.
+      # iq:: [Iq] of file-transfer we want to accept
+      # offset:: [Fixnum] or [nil]
+      # length:: [Fixnum] or [nil]
+      # result:: [Bytestreams::SOCKS5BytestreamsTarget] or [Bytestreams::IBBTarget] or [nil] if no valid stream-method
+      def accept(iq, offset=nil, length=nil)
+        oldsi = iq.first_element('si')
+
+        answer = iq.answer(false)
+        answer.type = :result
+
+        si = answer.add(Bytestreams::IqSi.new)
+        if (offset or length) and oldsi.file.range
+          si.add(Bytestreams::IqSiFile.new)
+          si.file.add(Bytestreams::IqSiFileRange.new(offset, length))
+        end
+        si.add(FeatureNegotiation::IqFeature.new.import(oldsi.feature))
+        si.feature.x.type = :submit
+        stream_method = si.feature.x.field('stream-method')
+
+        if stream_method.options.keys.include?(Bytestreams::IqQueryBytestreams::NS_BYTESTREAMS) and @allow_bytestreams
+          stream_method.values = [Bytestreams::IqQueryBytestreams::NS_BYTESTREAMS]
+          stream_method.options = []
+          @stream.send(answer)
+
+          Bytestreams::SOCKS5BytestreamsTarget.new(@stream, oldsi.id, iq.from, iq.to)
+        elsif stream_method.options.keys.include?(Bytestreams::IBB::NS_IBB) and @allow_ibb
+          stream_method.values = [Bytestreams::IBB::NS_IBB]
+          stream_method.options = []
+          @stream.send(answer)
+
+          Bytestreams::IBBTarget.new(@stream, oldsi.id, iq.from, iq.to)
+        else
+          eanswer = iq.answer(false)
+          eanswer.type = :error
+          eanswer.add(Error.new('bad-request')).type = :cancel
+          eanswer.error.add(REXML::Element.new('no-valid-streams')).add_namespace('http://jabber.org/protocol/si')
+          @stream.send(eanswer)
+
+          nil
+        end
+      end
+
+      ##
+      # Decline an incoming file-transfer,
+      # to be used in a block given to add_incoming_callback
+      # iq:: [Iq] of file-transfer we want to decline
+      def decline(iq)
+        answer = iq.answer(false)
+        answer.type = :error
+        error = answer.add(Error.new('forbidden', 'Offer declined'))
+        error.type = :cancel
+        @stream.send(answer)
+      end
+
+      ##
+      # Offer a file to somebody
+      #
+      # Will wait for a response from the peer
+      #
+      # The result is a stream which you can configure, or nil
+      # if the peer responded with an invalid stream-method.
+      #
+      # May raise an ErrorException
+      # jid:: [JID] to send the file to
+      # source:: File-transfer source, implementing the FileSource interface
+      # desc:: [String] or [nil] Optional file description
+      # result:: [Bytestreams::SOCKS5BytestreamsInitiator] or [Bytestreams::IBBInitiator] or [nil]
+      def offer(jid, source, desc=nil)
+        session_id = Jabber::IdGenerator.instance.generate_id
+
+        offered_methods = {}
+        if @allow_bytestreams
+          offered_methods[Bytestreams::IqQueryBytestreams::NS_BYTESTREAMS] = nil
+        end
+        if @allow_ibb
+          offered_methods[Bytestreams::IBB::NS_IBB] = nil
+        end
+
+        iq = Iq::new(:set, jid)
+        iq.from = @my_jid
+        si = iq.add(Bytestreams::IqSi.new(session_id, Bytestreams::IqSi::PROFILE_FILETRANSFER, source.mime))
+
+        file = si.add(Bytestreams::IqSiFile.new(source.filename, source.size))
+        file.hash = source.md5
+        file.date = source.date
+        file.description = desc if desc
+        file.add(Bytestreams::IqSiFileRange.new) if source.can_range?
+
+        feature = si.add(REXML::Element.new('feature'))
+        feature.add_namespace 'http://jabber.org/protocol/feature-neg'
+        x = feature.add(Dataforms::XData.new(:form))
+        stream_method_field = x.add(Dataforms::XDataField.new('stream-method', :list_single))
+        stream_method_field.options = offered_methods
+
+        begin
+          stream_method = nil
+          response = nil
+          @stream.send_with_id(iq) { |r|
+            response = r
+            si = response.first_element('si')
+            if response.type == :result and si and si.feature and si.feature.x
+              stream_method = si.feature.x.field('stream-method').values.first
+
+              if si.file and si.file.range
+                if source.can_range?
+                  source.seek(si.file.range.offset) if si.file.range.offset
+                  source.length = si.file.range.length if si.file.range.length
+                else
+                  source.read(si.file.range.offset)
+                end
+              end
+            end
+            true
+          }
+        rescue ErrorException => e
+          if e.error.code == 403  # Declined
+            return false
+          else
+            raise e
+          end
+        end
+
+        if stream_method == Bytestreams::IqQueryBytestreams::NS_BYTESTREAMS and @allow_bytestreams
+          Bytestreams::SOCKS5BytestreamsInitiator.new(@stream, session_id, @my_jid || @stream.jid, jid)
+        elsif stream_method == Bytestreams::IBB::NS_IBB and @allow_ibb
+          Bytestreams::IBBInitiator.new(@stream, session_id, @my_jid || @stream.jid, jid)
+        else  # Target responded with a stream_method we didn't offer
+          eanswer = response.answer
+          eanswer.type = :error
+          eanswer.add Error::new('bad-request')
+          @stream.send(eanswer)
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/ibb/base.rb

@@ -0,0 +1,256 @@
+require 'base64'
+
+module Jabber
+  module Bytestreams
+    ##
+    # In-Band Bytestreams (JEP-0047) implementation
+    #
+    # Don't use directly, use IBBInitiator and IBBTarget
+    #
+    # In-Band Bytestreams should only be used when transferring
+    # very small amounts of binary data, because it is slow and
+    # increases server load drastically.
+    #
+    # Note that the constructor takes a lot of arguments. In-Band
+    # Bytestreams do not specify a way to initiate the stream,
+    # this should be done via Stream Initiation.
+    class IBB
+      NS_IBB = 'http://jabber.org/protocol/ibb'
+
+      ##
+      # Create a new bytestream
+      #
+      # Will register a <message/> callback to intercept data
+      # of this stream. This data will be buffered, you can retrieve
+      # it with receive
+      def initialize(stream, session_id, my_jid, peer_jid)
+        @stream = stream
+        @session_id = session_id
+        @my_jid = (my_jid.kind_of?(String) ? JID.new(my_jid) : my_jid)
+        @peer_jid = (peer_jid.kind_of?(String) ? JID.new(peer_jid) : peer_jid)
+
+        @active = false
+        @seq_send = 0
+        @seq_recv = 0
+        @queue = []
+        @queue_lock = Mutex.new
+        @pending = Mutex.new
+        @pending.lock
+        @sendbuf = ''
+        @sendbuf_lock = Mutex.new
+
+        @block_size = 4096  # Recommended by JEP0047
+      end
+
+      def active?
+        @active
+      end
+
+      ##
+      # Send data
+      #
+      # Data is buffered to match block_size in each packet.
+      # If you need the data to be sent immediately, use
+      # flush afterwards.
+      # buf:: [String]
+      def write(buf)
+        @sendbuf_lock.synchronize {
+          @sendbuf += buf
+
+          while @sendbuf.size >= @block_size
+            send_data(@sendbuf[0..@block_size-1])
+            @sendbuf = @sendbuf[@block_size..-1].to_s
+          end
+        }
+      end
+
+      ##
+      # Empty the send-buffer by sending remaining data
+      def flush
+        @sendbuf_lock.synchronize {
+          while @sendbuf.size > 0
+            send_data(@sendbuf[0..@block_size-1])
+            @sendbuf = @sendbuf[@block_size..-1].to_s
+          end
+        }
+      end
+
+      ##
+      # Receive data
+      #
+      # Will wait until the Message with the next sequence number
+      # is in the stanza queue.
+      def read
+        if active?
+          res = nil
+
+          while res.nil?
+            @queue_lock.synchronize {
+              @queue.each { |item|
+                # Find next data
+                if item.type == :data and item.seq == @seq_recv.to_s
+                  res = item
+                  break
+                # No data? Find close
+                elsif item.type == :close and res.nil?
+                  res = item
+                end
+              }
+
+              @queue.delete_if { |item| item == res }
+            }
+
+            # No data? Wait for next to arrive...
+            @pending.lock unless res
+          end
+
+          if res.type == :data
+            @seq_recv += 1
+            @seq_recv = 0 if @seq_recv > 65535
+            res.data
+          elsif res.type == :close
+            deactivate
+            nil # Closed
+          end
+        else
+          nil
+        end
+      end
+
+      ##
+      # Close the stream
+      #
+      # Waits for acknowledge from peer,
+      # may throw ErrorException
+      def close
+        if active?
+          flush
+          deactivate
+
+          iq = Iq.new(:set, @peer_jid)
+          close = iq.add REXML::Element.new('close')
+          close.add_namespace IBB::NS_IBB
+          close.attributes['sid'] = @session_id
+
+          @stream.send_with_id(iq) { |answer|
+            answer.type == :result
+          }
+        end
+      end
+
+      private
+
+      ##
+      # Send data directly
+      # data:: [String]
+      def send_data(databuf)
+        if active?
+          msg = Message.new
+          msg.from = @my_jid
+          msg.to = @peer_jid
+          
+          data = msg.add REXML::Element.new('data')
+          data.add_namespace NS_IBB
+          data.attributes['sid'] = @session_id
+          data.attributes['seq'] = @seq_send.to_s
+          data.text = Base64::encode64 databuf
+
+          # TODO: Implement AMP correctly
+          amp = msg.add REXML::Element.new('amp')
+          amp.add_namespace 'http://jabber.org/protocol/amp'
+          deliver_at = amp.add REXML::Element.new('rule')
+          deliver_at.attributes['condition'] = 'deliver-at'
+          deliver_at.attributes['value'] = 'stored'
+          deliver_at.attributes['action'] = 'error'
+          match_resource = amp.add REXML::Element.new('rule')
+          match_resource.attributes['condition'] = 'match-resource'
+          match_resource.attributes['value'] = 'exact'
+          match_resource.attributes['action'] = 'error'
+   
+          @stream.send(msg)
+
+          @seq_send += 1
+          @seq_send = 0 if @seq_send > 65535
+        else
+          raise 'Attempt to send data when not activated'
+        end
+      end
+
+      def activate
+        unless active?
+          @stream.add_message_callback(200, self) { |msg|
+            data = msg.first_element('data')
+            if msg.from == @peer_jid and msg.to == @my_jid and data and data.attributes['sid'] == @session_id
+              if msg.type == nil
+                @queue_lock.synchronize {
+                  @queue.push IBBQueueItem.new(:data, data.attributes['seq'], data.text.to_s)
+                  @pending.unlock
+                }
+              elsif msg.type == :error
+                @queue_lock.synchronize {
+                  @queue << IBBQueueItem.new(:close)
+                  @pending.unlock
+                }
+              end
+              true
+            else
+              false
+            end
+          }
+
+          @stream.add_iq_callback(200, self) { |iq|
+            close = iq.first_element('close')
+            if iq.type == :set and close and close.attributes['sid'] == @session_id
+              answer = iq.answer(false)
+              answer.type = :result
+              @stream.send(answer)
+
+              @queue_lock.synchronize {
+                @queue << IBBQueueItem.new(:close)
+                @pending.unlock
+              }
+              true
+            else
+              false
+            end
+          }
+
+          @active = true
+        end
+      end
+
+      def deactivate
+        if active?
+          @stream.delete_message_callback(self)
+          @stream.delete_iq_callback(self)
+
+          @active = false
+        end
+      end
+    end
+
+    ##
+    # Represents an item in the internal data queue
+    class IBBQueueItem
+      attr_reader :type, :seq
+      def initialize(type, seq=nil, data_text='')
+        unless [:data, :close].include? type
+          raise "Unknown IBBQueueItem type: #{type}"
+        end
+
+        @type = type
+        @seq = seq
+        @data = data_text
+      end
+
+      ##
+      # Return the Base64-*decoded* data
+      #
+      # There's no need to catch Exceptions here,
+      # as none are thrown.
+      def data
+        Base64::decode64(@data)
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb

@@ -0,0 +1,30 @@
+module Jabber
+  module Bytestreams
+    ##
+    # Implementation of IBB at the initiator side
+    class IBBInitiator < IBB
+      # You may set the block-size before open
+      attr_accessor :block_size
+      
+      ##
+      # Open the stream to the peer,
+      # waits for successful result
+      #
+      # May throw ErrorException
+      def open
+        iq = Iq.new(:set, @peer_jid)
+        open = iq.add REXML::Element.new('open')
+        open.add_namespace IBB::NS_IBB
+        open.attributes['sid'] = @session_id
+        open.attributes['block-size'] = @block_size
+
+        @stream.send_with_id(iq) { |answer|
+          answer.type == :result
+        }
+
+        activate
+      end
+    end
+  end
+end
+

data/lib/xmpp4r/bytestreams/helper/ibb/target.rb

@@ -0,0 +1,46 @@
+module Jabber
+  module Bytestreams
+    ##
+    # Implementation of IBB at the target side
+    class IBBTarget < IBB
+      # You may read the block-size after accept
+      attr_reader :block_size
+
+      def initialize(stream, session_id, initiator_jid, target_jid)
+        # Target and Initiator are swapped here, because we're the target
+        super(stream, session_id, target_jid, initiator_jid)
+      end
+
+      ##
+      # Wait for the initiator side to start
+      # the stream.
+      def accept
+        connect_lock = Mutex.new
+        connect_lock.lock
+
+        @stream.add_iq_callback(200, self) { |iq|
+          open = iq.first_element('open')
+          if iq.type == :set and iq.from == @peer_jid and iq.to == @my_jid and open and open.attributes['sid'] == @session_id
+            @stream.delete_iq_callback(self)
+            activate
+            @block_size = (open.attributes['block-size'] || 4096).to_i
+
+            reply = iq.answer(false)
+            reply.type = :result
+            @stream.send(reply)
+              
+            connect_lock.unlock
+            true
+          else
+            false
+          end
+        }
+
+        connect_lock.lock
+        connect_lock.unlock
+        true
+      end
+    end
+  end
+end
+