xmpp4r 0.3.1 → 0.3.2

data/lib/xmpp4r/connection.rb

@@ -13,13 +13,17 @@ module Jabber
   class Connection  < Stream
     attr_reader :host, :port
 
-    # Allow TLS negotiation? Defaults to true
-    attr_accessor :allow_tls
-
     # How many seconds to wait for <stream:features/>
     # before proceeding
     attr_accessor :features_timeout
 
+    # Keep-alive interval in seconds, defaults to 60
+    # (see private method keepalive_loop for implementation details)
+    attr_accessor :keepalive_interval
+
+    # Allow TLS negotiation? Defaults to true
+    attr_accessor :allow_tls
+
     # Optional CA-Path for TLS-handshake
     attr_accessor :ssl_capath
 
@@ -38,11 +42,14 @@ module Jabber
       @ssl_capath = nil
       @ssl_verifycb = nil
       @features_timeout = 10
+      @keepalive_interval = 60
     end
 
     ##
-    # Connects to the Jabber server through a TCP Socket and
-    # starts the Jabber parser.
+    # Connect to the Jabber server through a TCP Socket,
+    # start the Jabber parser,
+    # invoke to accept_features to wait for TLS,
+    # start the keep-alive thread
     def connect(host, port)
       @host = host
       @port = port
@@ -54,14 +61,26 @@ module Jabber
       start
 
       accept_features
+
+      @keepaliveThread = Thread.new do
+        Thread.current.abort_on_exception = true
+        keepalive_loop
+      end
+    end
+
+    ##
+    # Closing connection:
+    # first kill keepaliveThread, then call Stream#close!
+    def close!
+      @keepaliveThread.kill if @keepaliveThread and @keepaliveThread.alive?
+      super
     end
 
     def accept_features
       begin
         Timeout::timeout(@features_timeout) {
           Jabber::debuglog("FEATURES: waiting...")
-          @features_lock.lock
-          @features_lock.unlock
+          @features_sem.wait
           Jabber::debuglog("FEATURES: waiting finished")
         }
       rescue Timeout::Error
@@ -80,8 +99,6 @@ module Jabber
     ##
     # Start the parser on the previously connected socket
     def start
-      @features_lock.lock
-
       super(@socket)
     end
 
@@ -154,13 +171,33 @@ module Jabber
       stream_start_string += "xmlns='#{xmlns}' " unless xmlns.nil?
       stream_start_string += "to='#{to}' " unless to.nil?
       stream_start_string += "from='#{from}' " unless from.nil?
-      stream_start_string += "id='#{id}' " unless id.nil?      
+      stream_start_string += "id='#{id}' " unless id.nil?
       stream_start_string += "xml:lang='#{xml_lang}' " unless xml_lang.nil?
       stream_start_string += "version='#{version}' " unless version.nil?
       stream_start_string += ">"
       stream_start_string
     end
     private :generate_stream_start
-    
-  end  
+
+    ##
+    # A loop to send "keep alive" data to prevent
+    # the Jabber connection from closing for inactivity.
+    #
+    # This loop sends a single white-space character if
+    # no other data has been sent in the last @keepalive_interval
+    # seconds.
+    def keepalive_loop
+      loop do
+        difference = @last_send + @keepalive_interval - Time.now
+        if difference <= 0
+          send(' ')
+          sleep @keepalive_interval
+        else
+          sleep(difference)
+        end
+      end
+    end
+    private :keepalive_loop
+
+  end
 end

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

@@ -10,27 +10,13 @@ module Jabber
     ##
     # Data Forms (JEP-0004) implementation
     class XData < X
+      name_xmlns 'x', 'jabber:x:data'
+
       def initialize(type=nil)
         super()
-        add_namespace('jabber:x:data')
         self.type = type
       end
 
-      def typed_add(xe)
-        if xe.kind_of?(REXML::Element)
-          case xe.name
-            when 'instructions' then super XDataInstructions.new.import(xe)
-            when 'title' then super XDataTitle.new.import(xe)
-            when 'field' then super XDataField.new.import(xe)
-            when 'reported' then super XDataReported.new.import(xe)
-            #when 'item' then super XDataItem.new.import(xe)
-            else super xe
-          end
-        else
-          super xe
-        end
-      end
-
       ##
       # Search a field by it's var-name
       # var:: [String]
@@ -42,6 +28,16 @@ module Jabber
         nil
       end
 
+      def fields
+        fields = []
+        each_element do |xe|
+          if xe.kind_of?(XDataField) and xe.type != :hidden and xe.type != :fixed
+            fields << xe
+          end
+        end
+        fields
+      end
+
       ##
       # Type of this Data Form
       # result:: * :cancel
@@ -70,16 +66,53 @@ module Jabber
           else attributes['type'] = nil
         end
       end
+
+      ##
+      # Get the Data Form title
+      # return:: [XDataTitle] or nil
+      def title
+        first_element('title')
+      end
+
+      ##
+      # Set the Data Form title
+      # title:: [String]
+      def title=(title)
+        delete_elements('title')
+        add_element(XDataTitle.new(title))
+      end
+
+      ##
+      # Get the Data Form instructions
+      # return:: [Array] of [XDataInstructions] or nil
+      def instructions
+        fields = []
+        each_element('instructions') do |xe|
+          fields << xe
+        end
+        fields        
+      end
+  
+      ##
+      # Add Data Form instructions
+      # i:: [String]
+      def instructions=(i)
+        add(XDataInstructions.new(i))
+      end
+
     end
 
-    X.add_namespaceclass('jabber:x:data', XData)
 
     ##
     # Child of XData, contains the title of this Data Form
-    class XDataTitle < REXML::Element
-      def initialize
-        super('title')
+    class XDataTitle < XMPPElement
+      name_xmlns 'title', 'jabber:x:data'
+
+      def initialize(title=nil)
+        super()
+        add_text(title)
       end
+
       def to_s
         text.to_s
       end
@@ -90,13 +123,18 @@ module Jabber
 
     ##
     # Child of XData, contains the instructions of this Data Form
-    class XDataInstructions < REXML::Element
-      def initialize
-        super('instructions')
+    class XDataInstructions < XMPPElement
+      name_xmlns 'instructions', 'jabber:x:data'
+
+      def initialize(instructions=nil)
+        super()
+        add_text(instructions)
       end
+
       def to_s
         text.to_s
       end
+
       def instructions
         text
       end
@@ -104,9 +142,10 @@ module Jabber
 
     ##
     # Child of XData, contains configurable/configured options of this Data Form
-    class XDataField < REXML::Element
+    class XDataField < XMPPElement
+      name_xmlns 'field', 'jabber:x:data'
       def initialize(var=nil, type=nil)
-        super('field')
+        super()
         self.var = var
         self.type = type
       end
@@ -238,10 +277,8 @@ module Jabber
 
     ##
     # The <reported/> element, can contain XDataField elements
-    class XDataReported < REXML::Element
-      def initialize
-        super('reported')
-      end
+    class XDataReported < XMPPElement
+      name_xmlns 'reported', 'jabber:x:data'
     end
   end
 end

data/lib/xmpp4r/delay/x/delay.rb

@@ -21,13 +21,14 @@ module Jabber
     # <x/> elements with the specific namespace will then be
     # converted to XDelay automatically.
     class XDelay < X
+      name_xmlns 'x', 'jabber:x:delay'
+
       ##
       # Initialize a new XDelay element
       #
       # insertnow:: [Boolean] Set the stamp to [Time::now]
       def initialize(insertnow=true)
         super()
-        add_namespace('jabber:x:delay')
 
         if insertnow
           set_stamp(Time.now)
@@ -94,7 +95,5 @@ module Jabber
         self
       end
     end
-
-    X.add_namespaceclass('jabber:x:delay', XDelay)
   end
 end

data/lib/xmpp4r/discovery/iq/discoinfo.rb

@@ -15,34 +15,7 @@ module Jabber
     # elements, describing the type and the supported namespaces of
     # the service.
     class IqQueryDiscoInfo < IqQuery
-      ##
-      # Create a new query
-      # with namespace http://jabber.org/protocol/disco#info
-      def initialize
-        super
-        add_namespace('http://jabber.org/protocol/disco#info')
-      end
-
-      ##
-      # Add a children element
-      #
-      # Converts <identity/> elements to [Identity]
-      # and <feature/> elements to [Feature]
-      def typed_add(element)
-        if element.kind_of?(REXML::Element)
-
-          if element.name == 'identity'
-            super(Identity::new.import(element))
-          elsif element.name == 'feature'
-            super(Feature::new.import(element))
-          else
-            super(element)
-          end
-
-        else
-          super(element)
-        end
-      end
+      name_xmlns 'query', 'http://jabber.org/protocol/disco#info'
 
       ##
       # Get the queried Service Discovery node or nil
@@ -76,6 +49,17 @@ module Jabber
         first_element('identity')
       end
 
+      ##
+      # Get list of identities
+      # result:: [Array] of [Identity]
+      def identities
+        res = []
+        each_element('identity') { |id|
+          res.push(id)
+        }
+        res        
+      end
+
       ##
       # Get list of features
       # result:: [Array] of [String]
@@ -88,20 +72,21 @@ module Jabber
       end
     end
 
-    IqQuery.add_namespaceclass('http://jabber.org/protocol/disco#info', IqQueryDiscoInfo)
 
     ##
     # Service Discovery identity to add() to IqQueryDiscoInfo
     #
     # Please note that JEP 0030 requires both category and type to occur
-    class Identity < REXML::Element
+    class Identity < XMPPElement
+      name_xmlns 'identity', 'http://jabber.org/protocol/disco#info'
+
       ##
       # Initialize a new Identity
       # category:: [String] Initial category or nil
       # iname:: [String] Initial identity name or nil
       # type:: [String] Initial type or nil
       def initialize(category=nil, iname=nil, type=nil)
-        super('identity')
+        super()
         set_category(category)
         set_iname(iname)
         set_type(type)
@@ -187,12 +172,14 @@ module Jabber
     # Service Discovery feature to add() to IqQueryDiscoInfo
     #
     # Please note that JEP 0030 requires var to be set
-    class Feature < REXML::Element
+    class Feature < XMPPElement
+      name_xmlns 'feature', 'http://jabber.org/protocol/disco#info'
+
       ##
       # Create a new <feature/> element
       # var:: [String] New var
       def initialize(var=nil)
-        super('feature')
+        super()
         set_var(var)
       end
 

data/lib/xmpp4r/discovery/iq/discoitems.rb

@@ -17,31 +17,7 @@ module Jabber
     # querying IqQueryDiscoInfo and further sub-items by querying
     # IqQueryDiscoItems.
     class IqQueryDiscoItems < IqQuery
-      ##
-      # Create a new query
-      # with namespace http://jabber.org/protocol/disco#items
-      def initialize
-        super
-        add_namespace('http://jabber.org/protocol/disco#items')
-      end
-
-      ##
-      # Add a children element
-      #
-      # Converts <item/> elements to [Item]
-      def typed_add(element)
-        if element.kind_of?(REXML::Element)
-
-          if element.name == 'item'
-            super(Item::new.import(element))
-          else
-            super(element)
-          end
-
-        else
-          super(element)
-        end
-      end
+      name_xmlns 'query', 'http://jabber.org/protocol/disco#items'
 
       ##
       # Get the queried Service Discovery node or nil
@@ -68,13 +44,14 @@ module Jabber
       end
     end
 
-    IqQuery.add_namespaceclass('http://jabber.org/protocol/disco#items', IqQueryDiscoItems)
 
     ##
     # Service Discovery item to add() to IqQueryDiscoItems
     #
     # Please note that JEP 0030 requires the jid to occur
-    class Item < REXML::Element
+    class Item < XMPPElement
+      name_xmlns 'item', 'http://jabber.org/protocol/disco#items'
+
       ##
       # Initialize a new Service Discovery <item/>
       # to be added to IqQueryDiscoItems
@@ -82,7 +59,7 @@ module Jabber
       # iname:: [String] Item name
       # node:: [String] Service Discovery node (_not_ JID#node)
       def initialize(jid=nil, iname=nil, node=nil)
-        super('item')
+        super()
         set_jid(jid)
         set_iname(iname)
         set_node(node)

data/lib/xmpp4r/error.rb

@@ -6,7 +6,9 @@ module Jabber
   ##
   # A class used to build/parse <error/> elements.
   # Look at JEP 0086 for explanation.
-  class Error < REXML::Element
+  class Error < XMPPElement
+    name_xmlns 'error'
+
     ##
     # errorcondition:: [nil] or [String] of the following:
     # * "bad-request"
@@ -38,7 +40,7 @@ module Jabber
     # text: [nil] or [String] Error text
     def initialize(errorcondition=nil, text=nil)
       if errorcondition.nil?
-        super('error')
+        super()
         set_text(text) unless text.nil?
       else
         errortype = nil
@@ -54,7 +56,7 @@ module Jabber
           raise("Unknown error condition when initializing Error")
         end
         
-        super("error")
+        super()
         set_error(errorcondition)
         set_type(errortype)
         set_code(errorcode)
@@ -62,13 +64,6 @@ module Jabber
       end
     end
 
-    ##
-    # Create a new <error/> element and import from existing
-    # element:: [REXML::Element] to import
-    def Error.import(element)
-      Error::new.import(element)
-    end
-    
     ##
     # Get the 'Legacy error code' or nil
     # result:: [Integer] Error code