xmpp4r 0.3.2 → 0.4

data/lib/xmpp4r/client.rb

@@ -3,9 +3,7 @@
 # Website::http://home.gna.org/xmpp4r/
 
 require 'resolv'
-
 require 'xmpp4r/connection'
-require 'xmpp4r/authenticationfailure'
 require 'xmpp4r/sasl'
 
 module Jabber
@@ -26,8 +24,8 @@ module Jabber
     # Create a new Client.
     #
     # Remember to *always* put a resource in your JID unless the server can do SASL.
-    def initialize(jid, threaded = true)
-      super(threaded)
+    def initialize(jid)
+      super()
       @jid = (jid.kind_of?(JID) ? jid : JID.new(jid.to_s))
     end
 
@@ -39,6 +37,7 @@ module Jabber
     # be resolved. If none works, fallback is connecting to the domain part
     # of the jid.
     # host:: [String] Optional c2s host, will be extracted from jid if nil
+    # use_ssl:: [Boolean] Optional. Use (old, deprecated) SSL when connecting.
     # return:: self
     def connect(host = nil, port = 5222)
       if host.nil?
@@ -46,7 +45,7 @@ module Jabber
           srv = []
           Resolv::DNS.open { |dns|
             # If ruby version is too old and SRV is unknown, this will raise a NameError
-            # which is catched below
+            # which is caught below
             Jabber::debuglog("RESOLVING:\n_xmpp-client._tcp.#{@jid.domain} (SRV)")
             srv = dns.getresources("_xmpp-client._tcp.#{@jid.domain}", Resolv::DNS::Resource::IN::SRV)
           }
@@ -58,16 +57,16 @@ module Jabber
               connect(record.target.to_s, record.port)
               # Success
               return self
-            rescue SocketError
+            rescue SocketError, Errno::ECONNREFUSED
               # Try next SRV record
             end
           }
         rescue NameError
-          $stderr.puts "Resolv::DNS does not support SRV records. Please upgrade to ruby-1.8.3 or later!"
+          Jabber::debuglog "Resolv::DNS does not support SRV records. Please upgrade to ruby-1.8.3 or later!"
         end
         # Fallback to normal connect method
       end
-      
+
       super(host.nil? ? jid.domain : host, port)
       self
     end
@@ -96,7 +95,7 @@ module Jabber
     ##
     # Authenticate with the server
     #
-    # Throws AuthenticationFailure
+    # Throws ClientAuthenticationFailure
     #
     # Authentication mechanisms are used in the following preference:
     # * SASL DIGEST-MD5
@@ -114,7 +113,7 @@ module Jabber
         end
       rescue
         Jabber::debuglog("#{$!.class}: #{$!}\n#{$!.backtrace.join("\n")}")
-        raise AuthenticationFailure.new, $!.to_s
+        raise ClientAuthenticationFailure.new, $!.to_s
       end
     end
 
@@ -147,14 +146,12 @@ module Jabber
           resource.text = jid.resource
         end
 
-        send_with_id(iq) { |reply|
+        send_with_id(iq) do |reply|
           reported_jid = reply.first_element('jid')
-          if reply.type == :result and reported_jid and reported_jid.text
+          if reported_jid and reported_jid.text
             @jid = JID.new(reported_jid.text)
           end
-
-          true
-        }
+        end
       end
 
       # Session starting
@@ -163,44 +160,127 @@ module Jabber
         session = iq.add REXML::Element.new('session')
         session.add_namespace @stream_features['session']
 
-        send_with_id(iq) { true }
+        send_with_id(iq)
+      end
+    end
+
+    ##
+    # See Client#auth_anonymous_sasl
+    def auth_anonymous
+      auth_anonymous_sasl
+    end
+
+
+    ##
+    # Shortcut for anonymous connection to server
+    #
+    # Throws ClientAuthenticationFailure
+    def auth_anonymous_sasl
+      if self.supports_anonymous?
+        begin
+          auth_sasl SASL.new(self, 'ANONYMOUS'), ""
+        rescue
+          Jabber::debuglog("#{$!.class}: #{$!}\n#{$!.backtrace.join("\n")}")
+          raise ClientAuthenticationFailure, $!.to_s
+        end
+      else
+        raise ClientAuthenticationFailure, 'Anonymous authentication unsupported'
       end
     end
 
+    ##
+    # Reports whether or not anonymous authentication is reported
+    # by the client.
+    #
+    # Returns true or false
+    def supports_anonymous?
+      @stream_mechanisms.include? 'ANONYMOUS'
+    end
+
     ##
     # Send auth with given password and wait for result
     # (non-SASL)
     #
-    # Throws ErrorException
+    # Throws ServerError
     # password:: [String] the password
     # digest:: [Boolean] use Digest authentication
     def auth_nonsasl(password, digest=true)
       authset = nil
       if digest
-        authset = Iq::new_authset_digest(@jid, @streamid.to_s, password)
+        authset = Iq.new_authset_digest(@jid, @streamid.to_s, password)
       else
-        authset = Iq::new_authset(@jid, password)
-      end
-      send_with_id(authset) do |r|
-        true
+        authset = Iq.new_authset(@jid, password)
       end
+      send_with_id(authset)
       $defout.flush
 
       true
     end
 
+    ##
+    # Get instructions and available fields for registration
+    # return:: [instructions, fields] Where instructions is a String and fields is an Array of Strings
+    def register_info
+      instructions = nil
+      fields = []
+
+      reg = Iq.new_registerget
+      reg.to = jid.domain
+      send_with_id(reg) do |answer|
+        if answer.query
+          answer.query.each_element { |e|
+            if e.namespace == 'jabber:iq:register'
+              if e.name == 'instructions'
+                instructions = e.text.strip
+              else
+                fields << e.name
+              end
+            end
+          }
+        end
+
+        true
+      end
+
+      [instructions, fields]
+    end
+
     ##
     # Register a new user account
     # (may be used instead of Client#auth)
     #
-    # This method may raise ErrorException if the registration was
+    # This method may raise ServerError if the registration was
     # not successful.
-    def register(password)
+    #
+    # password:: String
+    # fields:: {String=>String} additional registration information
+    #
+    # XEP-0077 Defines the following fields for registration information:
+    # http://www.xmpp.org/extensions/xep-0077.html
+    #
+    # 'username'    => 'Account name associated with the user'
+    # 'nick'        => 'Familiar name of the user'
+    # 'password'    => 'Password or secret for the user'
+    # 'name'        => 'Full name of the user'
+    # 'first'       => 'First name or given name of the user'
+    # 'last'        => 'Last name, surname, or family name of the user'
+    # 'email'       => 'Email address of the user'
+    # 'address'     => 'Street portion of a physical or mailing address'
+    # 'city'        => 'Locality portion of a physical or mailing address'
+    # 'state'       => 'Region portion of a physical or mailing address'
+    # 'zip'         => 'Postal code portion of a physical or mailing address'
+    # 'phone'       => 'Telephone number of the user'
+    # 'url'         => 'URL to web page describing the user'
+    # 'date'        => 'Some date (e.g., birth date, hire date, sign-up date)'
+    #
+    def register(password, fields={})
       reg = Iq.new_register(jid.node, password)
       reg.to = jid.domain
-      send_with_id(reg) { |answer|
-        true
+      fields.each { |name,value|
+        reg.query.add(REXML::Element.new(name)).text = value
       }
+
+      send_with_id(reg)
     end
 
     ##
@@ -212,10 +292,7 @@ module Jabber
       reg = Iq.new_register
       reg.to = jid.domain
       reg.query.add(REXML::Element.new('remove'))
-      send_with_id(reg) { |answer|
-        p answer.to_s
-        true
-      }
+      send_with_id(reg)
     end
 
     ##
@@ -224,23 +301,17 @@ module Jabber
     # Threading is suggested, as this code waits
     # for an answer.
     #
-    # Raises an exception upon error response (ErrorException from
+    # Raises an exception upon error response (ServerError from
     # Stream#send_with_id).
     # new_password:: [String] New password
     def password=(new_password)
-      iq = Iq::new_query(:set, @jid.domain)
+      iq = Iq.new_query(:set, @jid.domain)
       iq.query.add_namespace('jabber:iq:register')
       iq.query.add(REXML::Element.new('username')).text = @jid.node
       iq.query.add(REXML::Element.new('password')).text = new_password
 
       err = nil
-      send_with_id(iq) { |answer|
-        if answer.type == :result
-          true
-        else
-          false
-        end
-      }
+      send_with_id(iq)
     end
-  end  
+  end
 end

data/lib/xmpp4r/command/iq/command.rb

@@ -1,7 +1,7 @@
 require 'xmpp4r/iq'
 
 module Jabber
-  
+
   module Command
 
     ##

data/lib/xmpp4r/component.rb

@@ -23,12 +23,12 @@ module Jabber
 
     # Create a new Component
     # jid:: [JID]
-    def initialize(jid, server_address=nil, server_port=5347, threaded = true)
-      super(threaded)
+    def initialize(jid, server_address=nil, server_port=5347)
+      super()
       @jid = (jid.kind_of?(JID) ? jid : JID.new(jid.to_s))
 
       if server_address
-        $stderr.puts "Passing server and port to Jabber::Component::new is " +
+        $stderr.puts "Passing server and port to Jabber::Component.new is " +
                      "obsolete and will vanish in some later XMPP4R release. " +
                      "Please use these arguments when calling " +
                      "Jabber::Client#connect"
@@ -36,7 +36,7 @@ module Jabber
         @server_port = server_port
       end
     end
-    
+
     # Connect to the server
     # (chaining-friendly)
     # server:: [String] Hostname
@@ -80,8 +80,8 @@ module Jabber
     ##
     # Send auth with given secret and wait for result
     #
-    # Throws AuthenticationFailure
-    # secret:: [String] the shared secret 
+    # Throws ComponentAuthenticationFailure
+    # secret:: [String] the shared secret
     def auth(secret)
       hash = Digest::SHA1::hexdigest(@streamid.to_s + secret)
       authenticated = false
@@ -96,8 +96,8 @@ module Jabber
         end
       }
       unless authenticated
-        raise AuthenticationFailure.new, "Component authentication failed"
+        raise ComponentAuthenticationFailure.new, "Component authentication failed"
       end
     end
-  end  
+  end
 end

data/lib/xmpp4r/connection.rb

@@ -2,9 +2,11 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
 
-require 'openssl'
+begin
+  require 'openssl'
+rescue LoadError
+end
 require 'xmpp4r/stream'
-require 'xmpp4r/errorexception'
 
 module Jabber
   ##
@@ -30,19 +32,23 @@ module Jabber
     # Optional callback for verification of SSL peer
     attr_accessor :ssl_verifycb
 
+    #whether to use the old and deprecated SSL protocol
+    #Defaults to false
+    attr_accessor :use_ssl
+
     ##
-    # Create a new connection to the given host and port, using threaded mode
-    # or not.
-    def initialize(threaded = true)
-      super(threaded)
+    # Create a new connection to the given host and port
+    def initialize
+      super()
       @host = nil
       @port = nil
-      @allow_tls = true
+      @allow_tls = defined? OpenSSL
       @tls = false
       @ssl_capath = nil
       @ssl_verifycb = nil
       @features_timeout = 10
       @keepalive_interval = 60
+      @use_ssl = false
     end
 
     ##
@@ -58,6 +64,16 @@ module Jabber
 
       Jabber::debuglog("CONNECTING:\n#{@host}:#{@port}")
       @socket = TCPSocket.new(@host, @port)
+
+      # We want to use the old and deprecated SSL protocol (usually on port 5223)
+      if @use_ssl
+        ssl = OpenSSL::SSL::SSLSocket.new(@socket)
+        ssl.connect # start SSL session
+        ssl.sync_close = true
+        Jabber::debuglog("SSL connection established.")
+        @socket = ssl
+      end
+
       start
 
       accept_features
@@ -115,7 +131,7 @@ module Jabber
         true
       }
       if reply.name != 'proceed'
-        raise ErrorException(reply.first_element('error'))
+        raise ServerError(reply.first_element('error'))
       end
       # Don't be interrupted
       stop
@@ -124,7 +140,7 @@ module Jabber
         error = nil
 
         # Context/user set-able stuff
-        ctx = OpenSSL::SSL::SSLContext.new('TLSv1')
+        ctx = OpenSSL::SSL::SSLContext.new
         if @ssl_capath
           ctx.verify_mode = OpenSSL::SSL::VERIFY_PEER
           ctx.ca_path = @ssl_capath

data/lib/xmpp4r/dataforms/x/data.rb

@@ -28,10 +28,11 @@ module Jabber
         nil
       end
 
-      def fields
+      def fields(including_hidden=false)
         fields = []
         each_element do |xe|
-          if xe.kind_of?(XDataField) and xe.type != :hidden and xe.type != :fixed
+          if xe.kind_of?(XDataField) and (including_hidden or
+                                          (xe.type != :hidden and xe.type != :fixed))
             fields << xe
           end
         end
@@ -90,9 +91,9 @@ module Jabber
         each_element('instructions') do |xe|
           fields << xe
         end
-        fields        
+        fields
       end
-  
+
       ##
       # Add Data Form instructions
       # i:: [String]
@@ -251,6 +252,18 @@ module Jabber
         }
       end
 
+      ##
+      # Get the first value
+      def value
+        values.first
+      end
+
+      ##
+      # Remove all and set one value
+      def value=(val)
+        self.values = [val]
+      end
+
       ##
       # Get the options (in a Data Form with type='form')
       def options
@@ -282,4 +295,3 @@ module Jabber
     end
   end
 end
-

data/lib/xmpp4r/debuglog.rb

@@ -2,7 +2,17 @@
 # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
 # Website::http://home.gna.org/xmpp4r/
 
+require 'logger'
+
 module Jabber
+  def Jabber::logger
+    @@logger ||= Logger.new($stderr)
+  end
+
+  def Jabber::logger=(logger)
+    @@logger = logger
+  end
+
   # Is debugging mode enabled ?
   @@debug = false
 
@@ -21,14 +31,12 @@ module Jabber
   def Jabber::debug
     @@debug
   end
-    
+
   # Outputs a string only if debugging mode is enabled. If the string includes
-  # several lines, 4 spaces are added at the begginning of each line but the
+  # several lines, 4 spaces are added at the beginning of each line but the
   # first one. Time is prepended to the string.
   def Jabber::debuglog(string)
     return if not @@debug
-    s = string.chomp.gsub("\n", "\n    ")
-    t = Time::new.strftime('%H:%M:%S')
-    puts "#{t} #{s}"
+    logger.debug string.chomp.gsub("\n", "\n    ")
   end
 end