bryanl-xmpp4r 0.3.2

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

@@ -0,0 +1,206 @@
+# =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'
+
+module Jabber
+  module Bytestreams
+    PROFILE_FILETRANSFER = 'http://jabber.org/protocol/si/profile/file-transfer'
+
+    ##
+    # Iq child 'si' for Stream-Initiation
+    class IqSi < XMPPElement
+      name_xmlns 'si', 'http://jabber.org/protocol/si'
+      force_xmlns true
+
+      def initialize(id=nil, profile=nil, mime_type=nil)
+        super()
+
+        self.id = id
+        self.profile = profile
+        self.mime_type = mime_type
+      end
+
+      ##
+      # Session ID of this stream
+      def id
+        attributes['id']
+      end
+
+      ##
+      # Set Session ID of this stream
+      def id=(s)
+        attributes['id'] = s
+      end
+
+      ##
+      # MIME type of this stream
+      def mime_type
+        attributes['mime-type']
+      end
+
+      ##
+      # Set MIME type of this stream
+      def mime_type=(s)
+        attributes['mime-type'] = s
+      end
+
+      ##
+      # Stream profile, can indicate file-transfer
+      def profile
+        attributes['profile']
+      end
+
+      ##
+      # Set stream profile
+      def profile=(s)
+        attributes['profile'] = s
+      end
+
+      ##
+      # <file/> child
+      # result:: [IqSiFile]
+      def file
+        first_element('file')
+      end
+
+      ##
+      # <feature/> child
+      # result:: [IqFeature]
+      def feature
+        first_element('feature')
+      end
+    end
+
+
+    ##
+    # File-transfer meta-information,
+    # may appear as <file/> in IqSi
+    class IqSiFile < XMPPElement
+      name_xmlns 'file', PROFILE_FILETRANSFER
+
+      def initialize(fname=nil, size=nil)
+        super()
+        self.fname = fname
+        self.size = size
+      end
+
+      ##
+      # Get filename (attribute 'name')
+      def fname
+        attributes['name']
+      end
+
+      ##
+      # Set filename (attribute 'name')
+      def fname=(s)
+        attributes['name'] = s
+      end
+
+      ##
+      # Get MD5 hash
+      def hash
+        attributes['hash']
+      end
+
+      ##
+      # Set MD5 hash
+      def hash=(s)
+        attributes['hash'] = s
+      end
+
+      ##
+      # Get file date
+      # result:: [Time] or nil
+      def date
+        begin
+          Time.xmlschema(attributes['date'])
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      ##
+      # Set file date
+      # d:: [Time] or nil
+      def date=(d)
+        attributes['date'] = (d ? d.xmlschema : nil)
+      end
+
+      ##
+      # File size in bytes
+      # result:: [Fixnum]
+      def size
+        (attributes['size'] =~ /^\d+$/) ? attributes['size'].to_i : nil
+      end
+
+      ##
+      # Set file size
+      def size=(s)
+        attributes['size'] = s ? s.to_s : nil
+      end
+
+      ##
+      # File description
+      def description
+        first_element_text('desc')
+      end
+
+      ##
+      # Set file description
+      def description=(s)
+        replace_element_text('desc', s)
+      end
+
+      ##
+      # <range/> child
+      #
+      # A file-transfer offer may contain this with
+      # no attributes set, indicating the ability to
+      # do ranged transfers.
+      # result:: [IqSiFileRange]
+      def range
+        first_element('range')
+      end
+    end
+
+    ##
+    # Information for ranged transfers
+    class IqSiFileRange < XMPPElement
+      name_xmlns 'range', PROFILE_FILETRANSFER
+      def initialize(offset=nil, length=nil)
+        super()
+
+        self.offset = offset
+        self.length = length
+      end
+
+      ##
+      # File offset (for continuing an interrupted transfer)
+      def offset
+        (attributes['offset'] =~ /^\d+$/) ? attributes['offset'].to_i : nil
+      end
+
+      ##
+      # Set file offset
+      def offset=(o)
+        attributes['offset'] = (o ? o.to_s : nil)
+      end
+
+      ##
+      # File length (if not to transfer whole file)
+      def length
+        (attributes['length'] =~ /^\d+$/) ? attributes['length'].to_i : nil
+      end
+
+      ##
+      # Set file length
+      def length=(o)
+        attributes['length'] = (o ? o.to_s : nil)
+      end
+    end
+  end
+end

data/lib/xmpp4r/callbacks.rb

@@ -0,0 +1,124 @@
+# =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
+  ##
+  # This class manages a list of callbacks.
+  #
+  # ==Callbacks management and priority
+  #
+  # Callbacks are managed by the class CallbackList. When they are added, a
+  # priority (just a number or anything Comparable with other priorities) is
+  # specified. The biggest the priority is, the earliest the callback will be
+  # considered.
+  #
+  # Callbacks are processed for a given set of objects as long as they return
+  # false. If you want to stop processing, you must return true. Example :
+  #  cbl = CallbackList.new
+  #  c1 = false
+  #  c2 = false
+  #  c3 = false
+  #  cbl.add(10) { c1 = true; 1 }
+  #  cbl.add(5) { c2 = true; true }
+  #  cbl.add(0) { c3 = true }
+  #  cbl.process('aa')
+  #  puts "#{c1} #{c2} #{c3}"
+  # This example would display "true true false" as callbacks processing was
+  # stopped after the second callback returned true.
+  #
+  # In XMPP4R, callbacks' priorities are quite normalized since we want to be
+  # able to "cascade" callbacks in a clean way. Here are values your code should
+  # take into account :
+  #
+  # >= 200::  logging & debugging callbacks. Those callbacks should not consume
+  #           elements.
+  # 100-199:: Where Helpers register their callbacks. The normal value is 100,
+  #           and Helpers shouldn't register something else unless there's a
+  #           very good reason to.
+  # < 100::   all those numbers are normally available for your application.
+  #           That's enough, don't you think ?
+  class CallbackList
+
+    # Create a new list of callbacks
+    def initialize
+      @list = []
+    end
+
+    ##
+    # Add a callback to the list
+    #
+    # List will be sorted afterwards
+    #
+    # prio:: [Integer] the callback's priority, the higher, the sooner.
+    # ref:: [String] the callback's reference
+    # block:: [Block] a block to execute
+    # return:: [Jabber::CallbackList] The list, for chaining
+    def add(prio = 0, ref = nil, proc = nil, &block)
+      block = proc if proc
+      @list.push(Callback.new(prio, ref, block))
+      @list.sort! { |a, b| b.priority <=> a.priority }
+      self
+    end
+
+    ##
+    # Delete a callback by reference
+    # ref:: [String] the reference of the callback to delete
+    # return:: [CallBackList] The list, for chaining
+    def delete(ref)
+      @list.delete_if { |item| item.ref == ref }
+      self
+    end
+
+    ##
+    # Number of elements in the list
+    # return:: [Integer] The number of elements
+    def length
+      @list.length
+    end
+
+    ##
+    # Process an element through all my callbacks. returns e.consumed?
+    # e:: [Object] The elements to pass to the callback. You can pass
+    # several, but of course, you block must know how to handle them.
+    # return:: [Boolean] true if the element has been consumed
+    def process(*e)
+      # If somebody adds a new callback the list will get modified
+      # and sorted(!) while still iterating through it. So we use a
+      # local copy of @list. Any freshly added callback will receive
+      # the next stanzas, not the current.
+      list = @list.dup
+
+      # process through callbacks
+      list.each do |item|
+        return true if item.block.call(*e) == true
+      end
+      false
+    end
+  end
+
+  # This class is used to store callbacks inside CallbackList. See the
+  # CallbackList class for more detailed explanations.
+  class Callback
+
+    # The Callback's priority
+    attr_reader :priority
+
+    # The Callback's reference, using for deleting purposes
+    attr_reader :ref
+
+    # The Callback's block to execute
+    attr_reader :block
+
+    ##
+    # Create a new callback
+    # priority:: [Integer] the callback's priority. The higher, the sooner it
+    # will be executed
+    # ref:: [String] The callback's reference
+    def initialize(priority = 0, ref = nil, block = Proc.new {})
+      @priority = priority
+      @ref = ref
+      @block = block
+    end
+  end
+end

data/lib/xmpp4r/caps.rb

@@ -0,0 +1,2 @@
+require 'xmpp4r/caps/helper/helper'
+require 'xmpp4r/caps/helper/caps'

data/lib/xmpp4r/caps/c.rb

@@ -0,0 +1,53 @@
+# =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/xmppelement'
+
+module Jabber
+  module Caps
+    NS_CAPS='http://jabber.org/protocol/caps'
+
+    ##
+    # The <c/> XMPP element, used to advertise entity capabilities.
+    #
+    # See http://www.xmpp.org/extensions/xep-0115.html#protocol.
+    #
+    # You should not need to construct this element directly, see
+    # Jabber::Caps::Helper.
+    class C < XMPPElement
+      name_xmlns 'c', NS_CAPS
+      force_xmlns true
+
+      def initialize(node = nil, ver = nil)
+        super()
+        add_attribute('node', node) if node
+        if ver
+          add_attribute('ver', ver)
+          add_attribute('hash', 'sha-1')
+        end
+      end
+
+      ##
+      # Get the value of this element's 'ver' attribute,
+      # an opaque hash representing this entity's capabilities.
+      def ver
+        attributes['ver']
+      end
+
+      ##
+      # Get the value of this element's 'node' attribute,
+      # a 'unique identifier for the software underlying the entity'
+      def node
+        attributes['node']
+      end
+
+      ##
+      # Get the value of this element's 'hash' attribute,
+      # the algorithm used in generating the 'ver' attribute
+      def hash
+        attributes['hash']
+      end
+    end
+  end
+end

data/lib/xmpp4r/caps/helper/generator.rb

@@ -0,0 +1,160 @@
+# =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'
+require 'xmpp4r/discovery'
+require 'xmpp4r/dataforms'
+require 'xmpp4r/caps/c'
+require 'digest'
+require 'xmpp4r/base64'
+
+module Jabber
+  module Caps
+    def self.generate_ver_str(identities, features, forms=[])
+      # 1.  Initialize an empty string S.
+      s = ''
+
+      # 2. Sort the service discovery identities [14] by category and
+      # then by type (if it exists) and then by xml:lang (if it
+      # exists), formatted as CATEGORY '/' [TYPE] '/' [LANG] '/'
+      # [NAME]. Note that each slash is included even if the TYPE,
+      # LANG, or NAME is not included.
+      identities.sort! do |identity1,identity2|
+        cmp_result = nil
+        [:category, :type, :xml_lang, :iname].each do |field|
+          value1 = identity1.send(field)
+          value2 = identity2.send(field)
+
+          if value1 != value2
+            cmp_result = value1 <=> value2
+            break
+          end
+        end
+
+
+        cmp_result
+      end
+
+      # 3. For each identity, append the 'category/type/lang/name' to
+      # S, followed by the '<' character.
+      s += identities.collect do |identity|
+        [:category, :type, :xml_lang, :iname].collect do |field|
+          identity.send(field).to_s
+        end.join('/') + '<'
+      end.join
+
+      # 4. Sort the supported service discovery features. [15]
+      features.sort! do |feature1,feature2|
+        feature1.var <=> feature2.var
+      end
+
+      # 5. For each feature, append the feature to S, followed by the
+      # '<' character.
+      s += features.collect do |feature|
+        feature.var.to_s + '<'
+      end.join
+
+      # 6. If the service discovery information response includes
+      # XEP-0128 data forms, sort the forms by the FORM_TYPE (i.e., by
+      # the XML character data of the <value/> element).
+      forms.sort! do |form1,form2|
+        fform_type1 = form1.field('FORM_TYPE')
+        fform_type2 = form2.field('FORM_TYPE')
+        form_type1 = fform_type1 ? fform_type1.values.to_s : nil
+        form_type2 = fform_type2 ? fform_type2.values.to_s : nil
+        form_type1 <=> form_type2
+      end
+
+      # 7. For each extended service discovery information form:
+      forms.each do |form|
+        # 7.1. Append the XML character data of the FORM_TYPE field's
+        # <value/> element, followed by the '<' character.
+        fform_type = form.field('FORM_TYPE')
+        form_type = fform_type ? fform_type.values.to_s : nil
+        s += "#{form_type}<"
+
+        # 7.2. Sort the fields by the value of the "var" attribute.
+        fields = form.fields(false).sort do |field1,field2|
+          field1.var <=> field2.var
+        end
+
+        # 7.3. For each field:
+
+        fields.each do |field|
+          # 7.3.1. Append the value of the "var" attribute, followed by
+          # the '<' character.
+          s += "#{field.var}<"
+
+          # 7.3.2. Sort values by the XML character data of the <value/>
+          # element.
+          values = field.values.sort do |value1,value2|
+            value1 <=> value2
+          end
+
+          # 7.3.3. For each <value/> element, append the XML character
+          # data, followed by the '<' character.
+          s += values.collect do |value|
+            "#{value}<"
+          end.join
+        end
+      end
+
+      # 8. Ensure that S is encoded according to the UTF-8 encoding
+      # (RFC 3269 [16]).
+
+      # (given in XMPP4R)
+
+      s
+    end
+
+    ##
+    # Implementation of the algorithm defined at:
+    # http://www.xmpp.org/extensions/xep-0115.html#ver-gen
+    def self.generate_ver(identities, features, forms=[], hash='sha-1')
+      s = generate_ver_str(identities, features, forms)
+
+      # 9. Compute the verification string by hashing S using the
+      # algorithm specified in the 'hash' attribute (e.g., SHA-1 as
+      # defined in RFC 3174 [17]). The hashed data MUST be generated
+      # with binary output and encoded using Base64 as specified in
+      # Section 4 of RFC 4648 [18] (note: the Base64 output MUST NOT
+      # include whitespace and MUST set padding bits to zero). [19]
+
+      # See http://www.iana.org/assignments/hash-function-text-names
+      hash_klass = case hash
+                     when 'md2' then nil
+                     when 'md5' then Digest::MD5
+                     when 'sha-1' then Digest::SHA1
+                     when 'sha-224' then nil
+                     when 'sha-256' then Digest::SHA256
+                     when 'sha-384' then Digest::SHA384
+                     when 'sha-512' then Digest::SHA512
+                   end
+      if hash_klass
+        Base64::encode64(hash_klass::digest(s)).strip
+      else
+        nil
+      end
+    end
+
+    ##
+    # Generate a ver hash from a Jabber::Discovery::IqQueryDiscoInfo result
+    # query:: [Jabber::Discovery::IqQueryDiscoInfo]
+    def self.generate_ver_from_discoinfo(query, hash='sha-1')
+      identities = []
+      features = []
+      forms = []
+      query.each_element do |element|
+        if element.kind_of? Discovery::Identity
+          identities << element
+        elsif element.kind_of? Discovery::Feature
+          features << element
+        elsif element.kind_of? Dataforms::XData
+          forms << element
+        end
+      end
+      generate_ver(identities, features, forms, hash)
+    end
+  end
+end