xmpp4r 0.3 → 0.3.1

data/ChangeLog

@@ -1,3 +1,13 @@
+XMPP4R 0.3.1 (23/04/2007)
+=========================
+* SASL fixes
+* Message#x and Presence#x support element selection by namespace
+* Proper XML entity escaping for REXML text nodes
+* Improvements to FileTransfer::Helper and SOCKS5BytestreamsServer
+* Vcard::Helper fixes
+* Update Digest module usage to reflect recent Ruby versions
+* More documentation
+
 XMPP4R 0.3 (20/07/2006)
 =======================
 * SRV lookup capability in Client#connect

data/README

@@ -1,8 +1,14 @@
   XMPP4R
 ----------
-by Lucas Nussbaum <lucas@lucas-nussbaum.net>,
-Stephan Maka <stephan@spaceboyz.net> and
-Kirill A. Shutemov <k.shutemov@gmail.com>
+by:
+  Lucas Nussbaum <lucas@lucas-nussbaum.net>
+  Stephan Maka <stephan@spaceboyz.net>
+  Kirill A. Shutemov <k.shutemov@gmail.com>
+  Yuki Mitsui
+  Peter Schrammel
+  Olli
+  Vojtech Vobr
+  Andreas Wiese
 
 Currently, all the information is provided on
 
@@ -13,7 +19,9 @@ The integrated HTML documentation can be built with
        rake rdoc
 
 If you need to ask questions, feel free to ask them on the
-xmpp4r-devel@gna.org mailing list.
+xmpp4r-devel@gna.org mailing list. When reporting problems,
+please include a protocol dump which can be enabled with:
+  Jabber::debug = true
 
 XMPP4R is released under the Ruby license (see the LICENSE file), which is
 compatible with the GNU GPL (see the COPYING file) via an explicit

data/Rakefile

@@ -16,7 +16,7 @@ end
 # Globals
 
 PKG_NAME = 'xmpp4r'
-PKG_VERSION = '0.3'
+PKG_VERSION = '0.3.1'
 
 PKG_FILES = ['ChangeLog', 'README', 'COPYING', 'LICENSE', 'setup.rb', 'Rakefile', 'UPDATING']
 Find.find('lib/', 'data/', 'test/', 'tools/') do |f|

data/data/doc/xmpp4r/examples/advanced/fileserve.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'yaml'
 require 'xmpp4r'
 require 'xmpp4r/bytestreams'

data/data/doc/xmpp4r/examples/advanced/recvfile.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'xmpp4r'
 require 'xmpp4r/helpers/filetransfer'
 

data/data/doc/xmpp4r/examples/basic/client.rb

@@ -22,7 +22,7 @@ class BasicClient
       quit = true if line.nil?
       if not quit
         command, args = line.split(' ', 2)
-        args.chomp!
+        args = args.to_s.chomp
         # main case
         case command
         when 'exit'
@@ -52,7 +52,7 @@ class BasicClient
   ##
   # connect <jid> <password>
   def do_connect(args)
-    @jid, @password = args.split(' ', 3)
+    @jid, @password = args.split(' ', 2)
     @jid = JID::new(@jid)
     @cl = Client::new(@jid)
     @cl.connect

data/data/doc/xmpp4r/examples/basic/mass_sender.rb

@@ -56,6 +56,7 @@ cl.add_message_callback do |m|
 end
 cl.send(Presence::new)
 m = Message::new(nil, body)
+m.subject = subject
 STDIN.each_line { |l|
   l.chomp!
   m.set_to(JID::new(l).to_s)

data/data/doc/xmpp4r/examples/buggy/miniedgarr_cgi.rb

@@ -34,7 +34,7 @@ doc.root.each_element { |e|
   elsif e.name == 'presence'
     pres = Jabber::Presence.new.import(e)
 
-    if (pres.from.strip == jid) || (Digest::MD5.new(pres.from.strip.to_s).to_s == jidhash)
+    if (pres.from.strip == jid) || (Digest::MD5.hexdigest(pres.from.strip.to_s) == jidhash)
       if (jid == '') && !jidhash.nil?
         jid = pres.from.strip
       end

data/lib/xmpp4r/bytestreams.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/bytestreams/iq/si.rb'
 require 'xmpp4r/bytestreams/iq/bytestreams.rb'
 require 'xmpp4r/bytestreams/helper/ibb/base.rb'

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'callbacks'
 
 require 'xmpp4r/bytestreams/iq/si'
@@ -242,8 +246,10 @@ module Jabber
       # jid:: [JID] to send the file to
       # source:: File-transfer source, implementing the FileSource interface
       # desc:: [String] or [nil] Optional file description
+      # from:: [String] or [nil] Optional jid for components
       # result:: [Bytestreams::SOCKS5BytestreamsInitiator] or [Bytestreams::IBBInitiator] or [nil]
-      def offer(jid, source, desc=nil)
+      def offer(jid, source, desc=nil, from=nil)
+        from = from || @my_jid || @stream.jid
         session_id = Jabber::IdGenerator.instance.generate_id
 
         offered_methods = {}
@@ -255,7 +261,7 @@ module Jabber
         end
 
         iq = Iq::new(:set, jid)
-        iq.from = @my_jid
+        iq.from = from
         si = iq.add(Bytestreams::IqSi.new(session_id, Bytestreams::IqSi::PROFILE_FILETRANSFER, source.mime))
 
         file = si.add(Bytestreams::IqSiFile.new(source.filename, source.size))
@@ -299,9 +305,9 @@ module Jabber
         end
 
         if stream_method == Bytestreams::IqQueryBytestreams::NS_BYTESTREAMS and @allow_bytestreams
-          Bytestreams::SOCKS5BytestreamsInitiator.new(@stream, session_id, @my_jid || @stream.jid, jid)
+          Bytestreams::SOCKS5BytestreamsInitiator.new(@stream, session_id, from, jid)
         elsif stream_method == Bytestreams::IBB::NS_IBB and @allow_ibb
-          Bytestreams::IBBInitiator.new(@stream, session_id, @my_jid || @stream.jid, jid)
+          Bytestreams::IBBInitiator.new(@stream, session_id, from, jid)
         else  # Target responded with a stream_method we didn't offer
           eanswer = response.answer
           eanswer.type = :error

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'base64'
 
 module Jabber

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 module Jabber
   module Bytestreams
     ##
@@ -5,7 +9,7 @@ module Jabber
     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

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 module Jabber
   module Bytestreams
     ##
@@ -28,7 +32,7 @@ module Jabber
             reply = iq.answer(false)
             reply.type = :result
             @stream.send(reply)
-              
+
             connect_lock.unlock
             true
           else

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'socket'
 require 'thread'
 require 'timeout'
@@ -122,7 +126,7 @@ module Jabber
       # initiator_jid and target_jid.
       # result:: [String] SHA1 hash
       def stream_address
-        Digest::SHA1.new("#{@session_id}#{@initiator_jid}#{@target_jid}").hexdigest
+        Digest::SHA1.hexdigest("#{@session_id}#{@initiator_jid}#{@target_jid}")
       end
 
       ##

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 module Jabber
   module Bytestreams
     ##

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 module Jabber
   module Bytestreams
     ##
@@ -19,12 +23,17 @@ module Jabber
       # Will start to listen on the given TCP port and
       # accept new peers
       # port:: [Fixnum] TCP port to listen on
-      def initialize(port)
+      # listen_on:: [String] Optional address for the server socket to listen on (i.e. '0.0.0.0' or '::')
+      def initialize(port, listen_on=nil)
         @port = port
         @addresses = []
         @peers = []
         @peers_lock = Mutex.new
-        socket = TCPServer.new(port)
+        if listen_on
+          socket = TCPServer.new(listen_on, port)
+        else
+          socket = TCPServer.new(port)
+        end
 
         Thread.new {
           loop {
@@ -45,6 +54,9 @@ module Jabber
 
       ##
       # Find the socket a peer is associated to
+      #
+      # This method also performs some housekeeping, ie. removing
+      # peers with closed sockets.
       # addr:: [String] Address like SOCKS5Bytestreams#stream_address
       # result:: [TCPSocker] or [nil]
       def peer_sock(addr)
@@ -58,11 +70,13 @@ module Jabber
               removes << peer
             elsif peer.address == addr and res.nil?
               res = peer.socket
-            else
-              # If we sent multiple addresses of our own, clients may
-              # connect multiple times. Close these connections here.
-              removes << peer
             end
+
+            # If we sent multiple addresses of our own, clients may
+            # connect multiple times. DO NOT close any other connections
+            # here. These may belong to other concurrent bytestreams,
+            # believe that the peer will close any unneeded sockets
+            # which will then be picked up by the next call to peer_sock.
           }
 
           # If we sent multiple addresses of our own, clients may

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'socket'
 
 module Jabber

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

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 module Jabber
   module Bytestreams
     ##

data/lib/xmpp4r/bytestreams/iq/si.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'time'  # For Time#xmlschema
 
 require 'xmpp4r/feature_negotiation/iq/feature'

data/lib/xmpp4r/component.rb

@@ -83,7 +83,7 @@ module Jabber
     # Throws AuthenticationFailure
     # secret:: [String] the shared secret 
     def auth(secret)
-      hash = Digest::SHA1::new(@streamid.to_s + secret).to_s
+      hash = Digest::SHA1::hexdigest(@streamid.to_s + secret)
       authenticated = false
       send("<handshake>#{hash}</handshake>") { |r|
         if r.prefix == 'stream' and r.name == 'error'

data/lib/xmpp4r/dataforms.rb

@@ -1 +1,5 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/dataforms/x/data.rb'

data/lib/xmpp4r/delay.rb

@@ -1 +1,5 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/delay/x/delay.rb'

data/lib/xmpp4r/discovery.rb

@@ -1,2 +1,6 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/discovery/iq/discoinfo.rb'
 require 'xmpp4r/discovery/iq/discoitems.rb'

data/lib/xmpp4r/feature_negotiation.rb

@@ -1 +1,5 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/feature_negotiation/iq/feature.rb'

data/lib/xmpp4r/feature_negotiation/iq/feature.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/iq'
 require 'xmpp4r/dataforms/x/data'
 

data/lib/xmpp4r/iq.rb

@@ -156,7 +156,7 @@ module Jabber
       query = IqQuery::new
       query.add_namespace('jabber:iq:auth')
       query.add(REXML::Element::new('username').add_text(jid.node))
-      query.add(REXML::Element::new('digest').add_text(Digest::SHA1.new(session_id + password).hexdigest))
+      query.add(REXML::Element::new('digest').add_text(Digest::SHA1.hexdigest(session_id + password)))
       query.add(REXML::Element::new('resource').add_text(jid.resource)) if not jid.resource.nil?
       iq.add(query)
       iq

data/lib/xmpp4r/message.rb

@@ -82,9 +82,16 @@ module Jabber
     end
 
     ##
-    # Get the first <x/> element of this stanza, or nil if none found.
-    def x
-      first_element('x')
+    # Get the first <x/> element in this stanza, or nil if none found.
+    # namespace:: [String] Optional, find the first <x/> element having this xmlns
+    # result:: [REXML::Element] or nil
+    def x(namespace=nil)
+      each_element('x') { |x|
+        if namespace.nil? or namespace == x.namespace
+          return x
+        end
+      }
+      nil
     end
 
     ##

data/lib/xmpp4r/muc.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/muc/x/muc'
 require 'xmpp4r/muc/x/mucuserinvite'
 require 'xmpp4r/muc/x/mucuseritem'

data/lib/xmpp4r/muc/helper/simplemucclient.rb

@@ -1,3 +1,7 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
 require 'xmpp4r/delay/x/delay'
 require 'xmpp4r/muc/helper/mucclient'
 

data/lib/xmpp4r/presence.rb

@@ -94,12 +94,16 @@ module Jabber
     end
 
     ##
-    # Get the first <x/> element of this stanza
+    # Get the first <x/> element in this stanza, or nil if none found.
+    # namespace:: [String] Optional, find the first <x/> element having this xmlns
     # result:: [REXML::Element] or nil
-    def x
-      xe = nil
-      each_element('x') { |e| xe = e }
-      xe
+    def x(namespace=nil)
+      each_element('x') { |x|
+        if namespace.nil? or namespace == x.namespace
+          return x
+        end
+      }
+      nil
     end
 
     ##

data/lib/xmpp4r/rexmladdons.rb

@@ -10,8 +10,23 @@ require 'rexml/source'
 oldverbose = $VERBOSE
 $VERBOSE = false
 
-# REXML module. This file only adds a few methods to the REXML module, to
-# ease the coding.
+# REXML module. This file only adds the following methods to the REXML module, to
+# ease the coding:
+# * replace_element_text
+# * first_element
+# * first_element_text
+# * typed_add
+# * import
+# * self.import
+# * delete_elements
+#
+# Further definitions are just copied from REXML out of Ruby-1.8.4 to solve issues
+# with REXML in Ruby-1.8.2.
+#
+# The redefinitions of Text::normalize and Attribute#initialize address an issue
+# where entities in element texts and attributes were not escaped. This modifies
+# the behavious of REXML a bit but Sean Russell intends a similar behaviour for
+# the future of REXML.
 module REXML
   # this class adds a few helper methods to REXML::Element
   class Element
@@ -116,7 +131,8 @@ module REXML
       @variables = {}
     end
 
-    def namespaces=( namespaces={} )
+    def namespaces=( namespaces )
+      namespaces ||= {}
       Functions::namespace_context = namespaces
       @namespaces = namespaces
     end
@@ -819,6 +835,52 @@ module REXML
 
 
 ############################################################################
+ 
+  class Text
+    # Escapes all possible entities
+    def Text::normalize( input, doctype=nil, entity_filter=nil )
+      copy = input
+      # Doing it like this rather than in a loop improves the speed
+      if doctype
+        # Replace all ampersands that aren't part of an entity
+        copy = copy.gsub( EREFERENCE, '&' )
+        doctype.entities.each_value do |entity|
+          copy = copy.gsub( entity.value, 
+            "&#{entity.name};" ) if entity.value and 
+              not( entity_filter and entity_filter.include?(entity) )
+        end
+      else
+        # Replace all ampersands
+        copy = copy.gsub( '&', '&' )
+        DocType::DEFAULT_ENTITIES.each_value do |entity|
+          copy = copy.gsub(entity.value, "&#{entity.name};" )
+        end
+      end
+      copy
+    end
+  end
+
+	class Attribute
+		def initialize( first, second=nil, parent=nil )
+			@normalized = @unnormalized = @element = nil
+			if first.kind_of? Attribute
+				self.name = first.expanded_name
+				@value = first.value
+				if second.kind_of? Element
+					@element = second
+				else
+					@element = first.element
+				end
+			elsif first.kind_of? String
+				@element = parent if parent.kind_of? Element
+				self.name = first
+				@value = Text::normalize(second.to_s)
+			else
+				raise "illegal argument #{first.class.name} to Attribute constructor"
+			end
+		end
+  end
+
 end
 
 # Restore the old $VERBOSE setting