UPDATING lib/xmpp4r/bytestreams.rb lib/xmpp4r/bytestreams/helper/filetransfer.rb lib/xmpp4r/bytestreams/helper/ibb/base.rb lib/xmpp4r/bytestreams/helper/ibb/initiator.rb lib/xmpp4r/bytestreams/helper/ibb/target.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb lib/xmpp4r/bytestreams/iq/bytestreams.rb lib/xmpp4r/bytestreams/iq/si.rb lib/xmpp4r/dataforms.rb lib/xmpp4r/dataforms/x/data.rb lib/xmpp4r/delay.rb lib/xmpp4r/delay/x/delay.rb lib/xmpp4r/discovery.rb lib/xmpp4r/discovery/iq/discoinfo.rb lib/xmpp4r/discovery/iq/discoitems.rb lib/xmpp4r/feature_negotiation.rb lib/xmpp4r/feature_negotiation/iq/feature.rb lib/xmpp4r/muc.rb lib/xmpp4r/muc/helper/mucbrowser.rb lib/xmpp4r/muc/helper/mucclient.rb lib/xmpp4r/muc/helper/simplemucclient.rb lib/xmpp4r/muc/x/muc.rb lib/xmpp4r/muc/x/mucuserinvite.rb lib/xmpp4r/muc/x/mucuseritem.rb lib/xmpp4r/query.rb lib/xmpp4r/roster.rb lib/xmpp4r/roster/helper/roster.rb lib/xmpp4r/roster/iq/roster.rb lib/xmpp4r/roster/x/roster.rb lib/xmpp4r/vcard.rb lib/xmpp4r/vcard/helper/vcard.rb lib/xmpp4r/vcard/iq/vcard.rb lib/xmpp4r/version.rb lib/xmpp4r/version/helper/responder.rb lib/xmpp4r/version/helper/simpleresponder.rb lib/xmpp4r/version/iq/version.rb test/bytestreams/tc_ibb.rb test/bytestreams/tc_socks5bytestreams.rb test/delay/tc_xdelay.rb test/lib/clienttester.rb test/muc/tc_muc_mucclient.rb test/muc/tc_muc_simplemucclient.rb test/roster/tc_helper.rb test/roster/tc_iqqueryroster.rb test/roster/tc_xroster.rb test/tc_class_names.rb test/vcard/tc_iqvcard.rb test/version/tc_helper.rb test/version/tc_iqqueryversion.rb @@ -2,10 +2,12 @@ XMPP4R 0.3 (**/**/****) ======================= * SRV lookup capability in Client#connect * Stringprep support for JIDs +* TLS & SASL support +* Basic Dataforms support * Multi-User Chat Helpers * Helpers for File-Transfer, SOCKS5 Bytestreams, In-Band Bytestreams -* Helpers::Version moved to Helpers::SimpleVersion -* Helpers::Roster has modified subscription-request semantics (see Roster#add_subscription_request_callback) +* Roster helper has modified subscription-request semantics (see Roster#add_subscription_request_callback) +* A lot of features have renamed namespaces (see UPDATING file) XMPP4R 0.2 (20/10/2005) ======================= ChangeLog @@ -4,6 +4,15 @@ require 'rake/rdoctask' require 'rake' require 'find' +begin + require 'rubygems' + require 'rcov/rcovtask' + RCOV = true +rescue LoadError + RCOV = false +end + + # Globals PKG_NAME = 'xmpp4r' @@ -63,6 +72,13 @@ Rake::PackageTask.new(PKG_NAME, PKG_VERSION) do |p| p p.package_files end +if RCOV + Rcov::RcovTask.new do |t| + #t.test_files = FileList['test/tc_*.rb'] + FileList['test/*/tc_*.rb'] - ['test/tc_streamError.rb'] + t.test_files = ['test/ts_xmpp4r.rb'] + end +end + # "Gem" part of the Rakefile begin require 'rake/gempackagetask' Rakefile @@ -3,9 +3,8 @@ $:.unshift '../../lib' require 'xmpp4r' -require 'xmpp4r/iq/query/discoinfo' -require 'xmpp4r/iq/query/discoitems' -require 'xmpp4r/x/muc' +require 'xmpp4r/discovery' +require 'xmpp4r/muc/x/muc' require 'adventuremuc' data/doc/xmpp4r/examples/advanced/adventure/adventure.rb @@ -4,9 +4,12 @@ class AdventureMUC def initialize(jid, secret, addr, port=5347) @worlds = {} - @component = Jabber::Component::new(jid, addr, port) - @component.connect + @component = Jabber::Component::new(jid) + @component.connect(addr, port) @component.auth(secret) + @component.on_exception { |e,| + puts "#{e.class}: #{e}\n#{e.backtrace.join("\n")}" + } @component.add_iq_callback { |iq| handle_iq(iq) @@ -41,10 +44,10 @@ class AdventureMUC def handle_iq(iq) puts "iq: from #{iq.from} type #{iq.type} to #{iq.to}: #{iq.queryns}" - if iq.query.kind_of?(Jabber::IqQueryDiscoInfo) + if iq.query.kind_of?(Jabber::Discovery::IqQueryDiscoInfo) handle_disco_info(iq) true - elsif iq.query.kind_of?(Jabber::IqQueryDiscoItems) + elsif iq.query.kind_of?(Jabber::Discovery::IqQueryDiscoItems) handle_disco_items(iq) true else @@ -63,20 +66,20 @@ class AdventureMUC answer = Jabber::XMLStanza.answer(iq) answer.type = :result if iq.to.node == nil - answer.query.add(Jabber::DiscoIdentity.new('conference', 'Adventure component', 'text')) - answer.query.add(Jabber::DiscoFeature.new(Jabber::IqQueryDiscoInfo.new.namespace)) - answer.query.add(Jabber::DiscoFeature.new(Jabber::IqQueryDiscoItems.new.namespace)) + answer.query.add(Jabber::Discovery::Identity.new('conference', 'Adventure component', 'text')) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoInfo.new.namespace)) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoItems.new.namespace)) else world = @worlds[iq.to.node] if world.nil? answer.type = :error answer.query.add(Jabber::Error.new('item-not-found', 'The world you are trying to reach is currently unavailable.')) else - answer.query.add(Jabber::DiscoIdentity.new('conference', world.iname, 'text')) - answer.query.add(Jabber::DiscoFeature.new(Jabber::IqQueryDiscoInfo.new.namespace)) - answer.query.add(Jabber::DiscoFeature.new(Jabber::IqQueryDiscoItems.new.namespace)) - answer.query.add(Jabber::DiscoFeature.new(Jabber::XMuc.new.namespace)) - answer.query.add(Jabber::DiscoFeature.new(Jabber::XMucUser.new.namespace)) + answer.query.add(Jabber::Discovery::Identity.new('conference', world.iname, 'text')) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoInfo.new.namespace)) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::Discovery::IqQueryDiscoItems.new.namespace)) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::MUC::XMUC.new.namespace)) + answer.query.add(Jabber::Discovery::Feature.new(Jabber::MUC::XMUCUser.new.namespace)) end end @component.send(answer) @@ -93,7 +96,7 @@ class AdventureMUC answer.type = :result if iq.to.node == nil @worlds.each { |node,world| - answer.query.add(Jabber::DiscoItem.new(Jabber::JID::new(node, @component.jid.domain), world.iname)) + answer.query.add(Jabber::Discovery::Item.new(Jabber::JID::new(node, @component.jid.domain), world.iname)) } end @component.send(answer) data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb @@ -2,7 +2,7 @@ <place name='the garden'> You are in a beautiful garden. - There's an impressive tower beneath. It's door is open. + There's an impressive tower beneath. Its door is open. <go spec='door' place='lower room'/> <go spec='east' place='the well'/> </place> data/doc/xmpp4r/examples/advanced/adventure/tower.xml @@ -311,9 +311,9 @@ class Thing < REXML::Element xe = Jabber::Presence.import(pres) } if self.kind_of?(Player) - xe.add(Jabber::XMucUser.new).add(Jabber::XMucUserItem.new(:none, :participant)) + xe.add(Jabber::MUC::XMUCUser.new).add(Jabber::MUC::XMUCUserItem.new(:none, :participant)) else - xe.add(Jabber::XMucUser.new).add(Jabber::XMucUserItem.new(:owner, :moderator)) + xe.add(Jabber::MUC::XMUCUser.new).add(Jabber::MUC::XMUCUserItem.new(:owner, :moderator)) end xe end data/doc/xmpp4r/examples/advanced/adventure/world.rb @@ -1,10 +1,10 @@ require 'yaml' require 'xmpp4r' -require 'xmpp4r/helpers/filetransfer' -require 'xmpp4r/helpers/roster' -require 'xmpp4r/helpers/simpleversion' +require 'xmpp4r/bytestreams' +require 'xmpp4r/roster' +require 'xmpp4r/version' -#Jabber::debug = true +Jabber::debug = true def human_readable(num) unit = '' @@ -75,7 +75,7 @@ class Transfer end def transfer(from, to) - while buf = from.read(512) + while buf = from.read @bytes += to.write buf end end @@ -107,15 +107,15 @@ class Upload < Transfer Thread.new { begin stream = filetransfer.accept(iq, offset) - if stream.kind_of?(Jabber::Helpers::SOCKS5Bytestreams) + if stream.kind_of?(Jabber::Bytestreams::SOCKS5Bytestreams) stream.connect_timeout = 5 - stream.add_streamhost_callback(nil, nil, @streamhost_cb) + stream.add_streamhost_callback(nil, nil, &@streamhost_cb) end if stream.accept outfile = File.new(filename, (offset ? 'a' : 'w')) - transfer stream, outfile + transfer(stream, outfile) outfile.close stream.close @@ -125,6 +125,7 @@ class Upload < Transfer @done = true end rescue + puts $!.backtrace.first say "Error: #{$!}" @done = true end @@ -140,26 +141,26 @@ class Download < Transfer filesize = 0 end - super filetransfer, peer, filename, filesize, msgblock + super(filetransfer, peer, filename, filesize, msgblock) Thread.new { begin - raise "No regular file" unless File.file? filename + raise "No regular file" unless File.file?(filename) - source = Jabber::Helpers::FileSource.new filename - stream = filetransfer.offer peer, source + source = Jabber::FileTransfer::FileSource.new(filename) + stream = filetransfer.offer(peer, source) unless stream raise "Well, you should accept what you request..." @done = true end - if stream.kind_of? Jabber::Helpers::SOCKS5Bytestreams - socksconf.call stream - stream.add_streamhost_callback(nil, nil, @streamhost_cb) + if stream.kind_of?(Jabber::Bytestreams::SOCKS5Bytestreams) + socksconf.call(stream) + stream.add_streamhost_callback(nil, nil, &@streamhost_cb) end stream.open - transfer source, stream + transfer(source, stream) stream.close @done = true rescue @@ -172,47 +173,45 @@ end class FileServe def initialize(conf) + @uploads = 0 + @downloads = 0 + @transfers = [] @transfers_lock = Mutex.new @client = Jabber::Client.new Jabber::JID.new(conf['jabber']['jid']) @client.connect - @client.auth conf['jabber']['password'] + @client.auth(conf['jabber']['password']) - @ft = Jabber::Helpers::FileTransfer.new @client - Jabber::Helpers::SimpleVersion.new(@client, + @ft = Jabber::FileTransfer::Helper.new(@client) + Jabber::Version::SimpleResponder.new(@client, "XMPP4R FileServe example", Jabber::XMPP4R_VERSION, IO.popen('uname -sr').readlines.to_s.strip) register_handlers @directory = conf['directory'] - @directory.gsub! /\/+$/, '' + @directory.gsub!(/\/+$/, '') - @socksserver = Jabber::Helpers::SOCKS5BytestreamsServer.new(conf['socks']['port']) - conf['socks']['addresses'].each { |addr| - @socksserver.add_address addr - } + @socksserver = Jabber::Bytestreams::SOCKS5BytestreamsServer.new(conf['socks']['port']) + + conf['socks']['addresses'].each { |addr| @socksserver.add_address(addr) } + @proxies = [] conf['socks']['proxies'].collect { |jid| puts "Querying proxy #{jid}..." begin - @proxies.push Jabber::Helpers::SOCKS5Bytestreams::query_streamhost(@client, jid) + @proxies.push(Jabber::Bytestreams::SOCKS5Bytestreams::query_streamhost(@client, jid)) rescue puts "Error: #{$!}" end - } + } - @uploads = 0 - @downloads = 0 Thread.new { presence } - Thread.new { cleaner } # Panic reboot ;-) - @client.on_exception { - initialize(conf) - } + @client.on_exception { initialize(conf) } end def presence @@ -237,6 +236,7 @@ class FileServe old_status = status sleep 1 + } end @@ -251,53 +251,59 @@ class FileServe } @ft.add_incoming_callback { |iq,file| + say = lambda { |text| - say iq.from, text + say(iq.from, text) } puts "Incoming file transfer from #{iq.from}: #{file.fname} (#{file.size / 1024} KB)" filename = file.fname.split(/\//).last - filename.gsub! /^\.+/, '' + filename.gsub!(/^\.+/, '') + puts "Range: #{file.range != nil}" transfer = Upload.new(@ft, iq, "#{@directory}/#{filename}", file.size, file.range != nil, say) @uploads += 1 + @transfers_lock.synchronize { - @transfers.push transfer + @transfers.push(transfer) } + } - roster = Jabber::Helpers::Roster.new(@client) + roster = Jabber::Roster::Helper.new(@client) + roster.add_subscription_request_callback { |item,presence| roster.accept_subscription(presence.from) } + end def command(from, cmd, arg) say = lambda { |text| - say from, text + say(from, text) } socksconf = lambda { |stream| - stream.add_streamhost @socksserver + stream.add_streamhost(@socksserver) @proxies.each { |sh| - stream.add_streamhost sh + stream.add_streamhost(sh) } } case cmd when 'get' - arg.gsub! /\//, '' - arg.gsub! /^\.+/, '' + arg.gsub!(/\//, '') + arg.gsub!(/^\.+/, '') transfer = Download.new(@ft, from, "#{@directory}/#{arg}", say, socksconf) @downloads += 1 @transfers_lock.synchronize { - @transfers.push transfer + @transfers.push(transfer) } when 'ls' text = "" Dir.foreach(@directory) { |file| next if file =~ /^\./ path = "#{@directory}/#{file}" - text += "#{file} (#{human_readable File.size(path)})\n" if File.file? path + text += "#{file} (#{human_readable File.size(path)})\n" if File.file?(path) } say.call(text.strip) when 'stat' @@ -317,14 +323,16 @@ class FileServe def say(to, text) puts ">#{to}< #{text.strip}" - @client.send Jabber::Message.new(to, text).set_type(:chat) + @client.send(Jabber::Message.new(to, text).set_type(:chat)) end def cleaner loop { + @transfers_lock.synchronize { @transfers.delete_if { |t| t.done? } } + sleep 1 } end data/doc/xmpp4r/examples/advanced/fileserve.rb @@ -4,8 +4,8 @@ require 'gtk2' $:.unshift '../../../../../lib' require 'xmpp4r' -require 'xmpp4r/helpers/simplemucclient' -require 'xmpp4r/helpers/simpleversion' +require 'xmpp4r/muc/helper/simplemucclient' +require 'xmpp4r/version/helper/simpleresponder' #Jabber::debug = true @@ -198,7 +198,7 @@ class ChatWindow < Gtk::Window print_buffer "Commands start with a slash, type \"/help\" for a list" @client = Jabber::Client.new(jid) - Jabber::Helpers::SimpleVersion.new(@client, "XMPP4R example: GtkMUCClient", Jabber::XMPP4R_VERSION, IO.popen("uname -sr").readlines.to_s.strip) + Jabber::Version::SimpleResponder.new(@client, "XMPP4R example: GtkMUCClient", Jabber::XMPP4R_VERSION, IO.popen("uname -sr").readlines.to_s.strip) Thread.new { begin print_buffer "Connecting for domain #{jid.domain}..." @@ -206,7 +206,7 @@ class ChatWindow < Gtk::Window print_buffer "Authenticating for #{jid.strip}..." @client.auth(password) print_buffer "Attempting to join #{mucjid.strip} as #{mucjid.resource}..." - @muc = Jabber::Helpers::SimpleMUCClient.new(@client) + @muc = Jabber::MUC::SimpleMUCClient.new(@client) register_handlers @muc.join(mucjid) rescue Exception => e data/doc/xmpp4r/examples/advanced/gtkmucclient.rb @@ -1,8 +1,8 @@ require 'xmpp4r' -require 'xmpp4r/helpers/filetransfer' +require 'xmpp4r/bytestreams' require 'yaml' -#Jabber::debug = true +Jabber::debug = true if ARGV.size != 3 puts "Usage: #{$0} <jid> <description> <file>" @@ -18,20 +18,20 @@ puts "Authenticating..." cl.auth conf['jabber']['password'] puts "Starting local Bytestreams server" -bss = Jabber::Helpers::SOCKS5BytestreamsServer.new(conf['local']['port']) +bss = Jabber::Bytestreams::SOCKS5BytestreamsServer.new(conf['local']['port']) conf['local']['addresses'].each { |address| bss.add_address(address) } -ft = Jabber::Helpers::FileTransfer.new(cl) +ft = Jabber::FileTransfer::Helper.new(cl) #ft.allow_bytestreams = false -source = Jabber::Helpers::FileSource.new(ARGV[2]) +source = Jabber::FileTransfer::FileSource.new(ARGV[2]) puts "Offering #{source.filename} to #{ARGV[0]}" stream = ft.offer(Jabber::JID.new(ARGV[0]), source, ARGV[1]) if stream puts "Starting stream initialization (#{stream.class})" - if stream.kind_of? Jabber::Helpers::SOCKS5BytestreamsInitiator + if stream.kind_of? Jabber::Bytestreams::SOCKS5BytestreamsInitiator stream.add_streamhost(bss) (conf['proxies'] || []).each { |proxy| puts "Querying proxy #{proxy}" @@ -52,7 +52,7 @@ if stream end stream.open - if stream.kind_of? Jabber::Helpers::SOCKS5BytestreamsInitiator + if stream.kind_of? Jabber::Bytestreams::SOCKS5BytestreamsInitiator puts "Using streamhost #{stream.streamhost_used.jid} (#{stream.streamhost_used.host}:#{stream.streamhost_used.port})" end @@ -60,6 +60,7 @@ if stream print "." $stdout.flush stream.write buf + stream.flush end puts "!" stream.close data/doc/xmpp4r/examples/advanced/sendfile.rb @@ -7,7 +7,7 @@ $:.unshift '../lib' require 'optparse' require 'xmpp4r/client' -require 'xmpp4r/iq/query/version' +require 'xmpp4r/version/iq/version' include Jabber #Jabber::debug = true @@ -60,7 +60,7 @@ cl.add_iq_callback do |i| if a.value == 'client' activity = true iq = Iq::new(:get) - iq.query = IqQueryVersion::new + iq.query = Version::IqQueryVersion::new iq.set_to(JID::new(e.attribute('jid').to_s)) cl.send(iq) end @@ -70,7 +70,7 @@ cl.add_iq_callback do |i| end end cl.add_iq_callback do |iq| - if iq.type == :result and iq.query.class == IqQueryVersion + if iq.type == :result and iq.query.class == Version::IqQueryVersion activity = true r = [ iq.from.to_s, iq.query.iname, iq.query.version, iq.query.os ] puts r.inspect data/doc/xmpp4r/examples/advanced/versionpoll.rb @@ -6,8 +6,8 @@ require 'xmpp4r' -require 'xmpp4r/iq/query/version' -require 'xmpp4r/iq/query/discoinfo' +require 'xmpp4r/version/iq/version' +require 'xmpp4r/discovery/iq/discoinfo' require 'optparse' require 'yaml' require 'thread' @@ -81,11 +81,11 @@ def print_reply(iq, roundtrip) roundtrip_s = ((roundtrip * 100).round / 100.0).to_s + " sec" output = "Received a #{iq.query.namespace} #{iq.type} from #{iq.from} (#{roundtrip_s}): " - if iq.query.kind_of?(Jabber::IqQueryVersion) + if iq.query.kind_of?(Jabber::Version::IqQueryVersion) output += "#{iq.query.iname}-#{iq.query.version} #{iq.query.os}" elsif iq.query.namespace == 'jabber:iq:time' output += "#{iq.query.first_element_text('display')} (#{iq.query.first_element_text('tz')})" - elsif iq.query.kind_of?(Jabber::IqQueryDiscoInfo) + elsif iq.query.kind_of?(Jabber::Discovery::IqQueryDiscoInfo) identity = iq.query.identity if identity output += "#{identity.iname} (#{identity.category} #{identity.type})" data/doc/xmpp4r/examples/advanced/xmpping.rb @@ -24,7 +24,7 @@ end # settings if ARGV.length != 3 - puts "Run with ./change_password.rb user@server oldpassword newpassword" + puts "Run with ./change_password.rb user@server/resource oldpassword newpassword" exit 1 end my_jid = JID::new(ARGV[0]) data/doc/xmpp4r/examples/basic/change_password.rb @@ -1,15 +1,20 @@ #!/usr/bin/env ruby require 'xmpp4r' -require 'xmpp4r/helpers/mucbrowser' +require 'xmpp4r/muc/helper/mucbrowser' -muc_jid = Jabber::JID.new(ARGV.shift) +if ARGV.size != 3 + puts "Usage: #{$0} <jid> <password> <muc-jid>" + exit +end + +jid, password, muc_jid = Jabber::JID.new(ARGV.shift), ARGV.shift, Jabber::JID.new(ARGV.shift) -cl = Jabber::Client.new(Jabber::JID.new('collector@jabber.ccc.de/mucbrowser')) +cl = Jabber::Client.new(jid) cl.connect -cl.auth('traversal') +cl.auth(password) -browser = Jabber::Helpers::MUCBrowser.new(cl) +browser = Jabber::MUC::MUCBrowser.new(cl) print "Querying #{muc_jid} for identity..."; $stdout.flush name = browser.muc_name(muc_jid) data/doc/xmpp4r/examples/basic/mucinfo.rb @@ -1,7 +1,7 @@ #!/usr/bin/env ruby $:.unshift '../../../../../lib/' require 'xmpp4r' -require 'xmpp4r/helpers/simplemucclient' +require 'xmpp4r/muc/helper/simplemucclient' if ARGV.size != 3 @@ -19,7 +19,7 @@ def print_line(time, line) end -Jabber::debug = true +#Jabber::debug = true cl = Jabber::Client.new(Jabber::JID.new(ARGV[0])) cl.connect cl.auth(ARGV[1]) @@ -28,7 +28,7 @@ cl.auth(ARGV[1]) mainthread = Thread.current # This is the SimpleMUCClient helper! -m = Jabber::Helpers::SimpleMUCClient.new(cl) +m = Jabber::MUC::SimpleMUCClient.new(cl) # SimpleMUCClient callback-blocks data/doc/xmpp4r/examples/basic/mucsimplebot.rb @@ -4,7 +4,7 @@ require 'optparse' require 'xmpp4r' -require 'xmpp4r/iq/query/roster' +require 'xmpp4r/roster/iq/roster' include Jabber jid = JID::new('lucastest@linux.ensimag.fr/rosterget') @@ -28,7 +28,7 @@ cl.auth(password) cl.send(Iq::new_rosterget) exit = false cl.add_iq_callback { |i| - if i.type == :result and i.query.kind_of?(IqQueryRoster) + if i.type == :result and i.query.kind_of?(Roster::IqQueryRoster) i.query.each_element { |e| e.text = '' puts e.to_s data/doc/xmpp4r/examples/basic/roster.rb @@ -3,7 +3,7 @@ $:.unshift '../../../../../lib/' require 'xmpp4r' -require 'xmpp4r/helpers/roster' +require 'xmpp4r/roster/helper/roster' # Command line argument checking @@ -23,7 +23,7 @@ cl.connect cl.auth(ARGV[1]) # The roster instance -roster = Jabber::Helpers::Roster.new(cl) +roster = Jabber::Roster::Helper.new(cl) mainthread = Thread.current data/doc/xmpp4r/examples/basic/rosterprint.rb @@ -3,7 +3,7 @@ $:.unshift '../../../../../lib' require 'xmpp4r' -require 'xmpp4r/iq/query/roster' +require 'xmpp4r/roster/iq/roster' # Command line argument checking @@ -25,7 +25,7 @@ cl.auth(ARGV[1]) # The iq stanza iq = Jabber::Iq::new(:set) # The new roster instance and item element -iq.add(Jabber::IqQueryRoster.new).add(Jabber::RosterItem.new(ARGV[2], ARGV[3])).groups = ARGV[4..ARGV.size] +iq.add(Jabber::Roster::IqQueryRoster.new).add(Jabber::Roster::RosterItem.new(ARGV[2], ARGV[3])).groups = ARGV[4..ARGV.size] # Sending the stanza cl.send(iq) data/doc/xmpp4r/examples/basic/rosterrename.rb @@ -32,8 +32,8 @@ $:.unshift '../../../../../lib/' require 'xmpp4r' -require 'xmpp4r/helpers/roster' -require 'xmpp4r/helpers/vcard' +require 'xmpp4r/roster/helper/roster' +require 'xmpp4r/vcard/helper/vcard' # Command line argument checking @@ -53,7 +53,7 @@ cl.connect cl.auth(ARGV[1]) # The roster instance -roster = Jabber::Helpers::Roster.new(cl) +roster = Jabber::Roster::Helper.new(cl) # Callback to handle updated roster items roster.add_update_callback { |olditem,item| @@ -77,7 +77,7 @@ roster.add_update_callback { |olditem,item| puts("#{item.jid} has no nickname... getting vCard") begin # ...get a vCard - vcard = Jabber::Helpers::Vcard.new(cl).get(item.jid.strip) + vcard = Jabber::Vcard::Helper.new(cl).get(item.jid.strip) unless vcard.nil? # Rename him to vCard's <NICKNAME/> field @@ -97,7 +97,7 @@ roster.add_update_callback { |olditem,item| end rescue Exception => e - # This will be (mostly) thrown by Jabber::Helpers::Vcard#get + # This will be (mostly) thrown by Jabber::Vcard::Helper#get puts("Error getting vCard for #{item.jid}: #{e.to_s}") end end @@ -158,8 +158,8 @@ subscription_callback = lambda { |item,pres| else raise "The Roster Helper is buggy!!! subscription callback with type=#{pres.type}" end } -roster.add_subscription_callback(0, nil, subscription_callback) -roster.add_subscription_request_callback(0, nil, subscription_callback) +roster.add_subscription_callback(0, nil, &subscription_callback) +roster.add_subscription_request_callback(0, nil, &subscription_callback) # Send initial presence # this is important for receiving presence of subscribed users data/doc/xmpp4r/examples/basic/rosterwatch.rb @@ -10,7 +10,7 @@ $:.unshift('../../../../../lib') require 'xmpp4r' -require 'xmpp4r/helpers/vcard' +require 'xmpp4r/vcard/helper/vcard' include Jabber @@ -29,7 +29,7 @@ cl.connect cl.auth(myPassword) # The Vcard helper -vcard_helper = Helpers::Vcard.new(cl) +vcard_helper = Vcard::Helper.new(cl) begin puts "Retrieving vCard information for #{cl.jid.strip}" data/doc/xmpp4r/examples/basic/send_vcard.rb @@ -3,8 +3,8 @@ $:.unshift '../../../../../lib' require 'xmpp4r' -require 'xmpp4r/iq/query/version' -require 'xmpp4r/helpers/simpleversion' +require 'xmpp4r/version/iq/version' +require 'xmpp4r/version/helper/simpleresponder' # A Hash containing all Version Query answers with their JIDs as keys: @@ -27,14 +27,19 @@ cl = Jabber::Client.new(jid, false) cl.connect cl.auth(ARGV[1]) +cl.on_exception { |*a| + p a[0].backtrace + exit! +} + # I'm not sure about the portability of 'uname -sr' here ;-) # but that's all needed to answer version queries: -Jabber::Helpers::SimpleVersion.new(cl, 'xmpp4r Versionbot example', Jabber::XMPP4R_VERSION, IO.popen('uname -sr').readlines.to_s.strip) +Jabber::Version::SimpleResponder.new(cl, 'xmpp4r Versionbot example', Jabber::XMPP4R_VERSION, IO.popen('uname -sr').readlines.to_s.strip) cl.add_iq_callback { |iq| # Filter for version query results - if (iq.type == :result) && iq.query.kind_of?(Jabber::IqQueryVersion) + if (iq.type == :result) && iq.query.kind_of?(Jabber::Version::IqQueryVersion) puts "Version query result from #{iq.from}" # Keep track of results per JID versions[iq.from] = iq.query @@ -51,7 +56,7 @@ cl.add_presence_callback { |pres| # Construct a new query iq = Jabber::Iq.new(:get, pres.from) # and ask for the version - iq.query = Jabber::IqQueryVersion.new + iq.query = Jabber::Version::IqQueryVersion.new puts "Asking #{iq.to} for his/her/its version" versions[pres.from] = :asking cl.send(iq) data/doc/xmpp4r/examples/basic/versionbot.rb @@ -82,8 +82,14 @@ class CallbackList # 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| + list.each do |item| return true if item.block.call(*e) == true end false lib/callbacks.rb @@ -36,22 +36,22 @@ # # The following conversion facilities are only executed if the respective # library parts are loaded. See below for more details on Non-basic features. -# * Jabber::IqQuery elements are converted to Jabber::IqQueryRoster if their +# * Jabber::IqQuery elements are converted to Jabber::Roster::IqQueryRoster if their # namespace is 'jabber:iq:roster' -# * Jabber::IqQuery elements are converted to Jabber::IqQueryVersion if their +# * Jabber::IqQuery elements are converted to Jabber::Version::IqQueryVersion if their # namespace is 'jabber:iq:version' -# * Jabber::IqQuery elements are converted to Jabber::IqQueryDiscoInfo if their +# * Jabber::IqQuery elements are converted to Jabber::Discovery::IqQueryDiscoInfo if their # namespace is 'http://jabber.org/protocol/disco#info' -# * Jabber::IqQuery elements are converted to Jabber::IqQueryDiscoItems if their +# * Jabber::IqQuery elements are converted to Jabber::Discovery::IqQueryDiscoItems if their # namespace is 'http://jabber.org/protocol/disco#items' -# * <tt><item/></tt> children elements of Jabber::IqQueryRoster are converted -# to Jabber::RosterItem +# * <tt><item/></tt> children elements of Jabber::Roster::IqQueryRoster are converted +# to Jabber::Roster::RosterItem # * <tt><identity/></tt> children elements of Jabber::IqQueryDiscoInfo are converted -# to Jabber::DiscoIdentity +# to Jabber::Discovery::DiscoIdentity # * <tt><feature/></tt> children elements of Jabber::IqQueryDiscoInfo are converted -# to Jabber::DiscoFeature +# to Jabber::Discovery::DiscoFeature # * <tt><item/></tt> children elements of Jabber::IqQueryDiscoItems are converted -# to Jabber::DiscoItem +# to Jabber::Discovery::DiscoItem # # To use this, don't check for: # <tt>iq.queryns == 'http://jabber.org/protocol/disco#info'</tt> @@ -92,15 +92,15 @@ # use them. The benefit will be that you'll understand the protocols and be # going to be more efficient when programming with them. # -# * Jabber::IqQueryDiscoInfo, Jabber::DiscoIdentity, Jabber::DiscoFeature: <tt>require 'xmpp4r/iq/query/discoinfo'</tt> -# * Jabber::IqQueryDiscoItems, Jabber::DiscoItem: <tt>require 'xmpp4r/iq/query/discoitems'</tt> -# * Jabber::IqQueryRoster, Jabber::RosterItem: <tt>require 'xmpp4r/iq/query/roster'</tt> -# * Jabber::IqQueryVersion: <tt>require 'xmpp4r/iq/query/version'</tt> -# * Jabber::XDelay: <tt>require 'xmpp4r/x/delay'</tt> -# * Jabber::XRoster, Jabber::XRosterItem: <tt>require 'xmpp4r/x/roster'</tt> -# * Jabber::XMuc, Jabber::XMucUser: <tt>require 'xmpp4r/x/muc'</tt> -# * Jabber::XMucUserItem: <tt>require 'xmpp4r/x/mucuseritem'</tt> -# * Jabber::XMucUserInvite: <tt>require 'xmpp4r/x/mucuserinvite'</tt> +# * Jabber::Bytestreams, Jabber::FileTransfer: <tt>require 'xmpp4r/bytestreams'</tt> +# * Jabber::Dataforms: <tt>require 'xmpp4r/dataforms'</tt> +# * Jabber::Delay: <tt>require 'xmpp4r/delay'</tt> +# * Jabber::Discovery: <tt>require 'xmpp4r/discovery'</tt> +# * Jabber::FeatureNegotiation: <tt>require 'xmpp4r/feature_negotiation'</tt> +# * Jabber::MUC: <tt>require 'xmpp4r/muc'</tt> +# * Jabber::Roster: <tt>require 'xmpp4r/roster'</tt> +# * Jabber::Vcard: <tt>require 'xmpp4r/vcard'</tt> +# * Jabber::Version: <tt>require 'xmpp4r/version'</tt> # # ===Helpers # @@ -108,15 +108,15 @@ # of Jabber clients at the cost of flexibility. But you won't need that # order of flexibility for the most things. # -# * Jabber::Helpers::Version: <tt>require 'xmpp4r/helpers/version'</tt> -# * Jabber::Helpers::Roster: <tt>require 'xmpp4r/helpers/roster'</tt> -# * Jabber::Helpers::Vcard: <tt>require 'xmpp4r/helpers/vcard'</tt> -# * Jabber::Helpers::FileTransfer: <tt>require 'xmpp4r/helpers/filetransfer'</tt> +# * Jabber::Roster::Helper: <tt>require 'xmpp4r/roster'</tt> +# * Jabber::MUC::MUCBrowser, Jabber::MUC::MUCClient, Jabber::MUC::SimpleMUCClient: <tt>require 'xmpp4r/muc'</tt> +# * Jabber::Version::SimpleResponder, Jabber::Version::Responder: <tt>require 'xmpp4r/version'</tt> +# * Jabber::Vcard::Helper: <tt>require 'xmpp4r/vcard'</tt> +# * Jabber::FileTransfer::Helper, Jabber::Bytestreams::SOCKS5BytestreamsServer: <tt>require 'xmpp4r/bytestreams'</tt> # -# Helpers for Multi-User Chat: -# -# * Jabber::Helpers::MUCBrowser: <tt>require 'xmpp4r/helpers/mucbrowser'</tt> -# * Jabber::Helpers::MUCClient: <tt>require 'xmpp4r/helpers/mucclient'</tt> -# * Jabber::Helpers::SimpleMUCClient: <tt>require 'xmpp4r/helpers/simplemucclient'</tt> +# ==Debugging +# +# Dumping your Jabber stream can be enabled this way: +# Jabber::debug = true require 'xmpp4r/xmpp4r' lib/xmpp4r.rb @@ -10,7 +10,13 @@ require 'xmpp4r/sasl' module Jabber - # The client class provides everything needed to build a basic XMPP Client. + # The client class provides everything needed to build a basic XMPP + # Client. + # + # If you want your connection to survive disconnects and timeouts, + # catch exception in Stream#on_exception and re-call Client#connect + # and Client#auth. Don't forget to re-send initial Presence and + # everything else you need to setup your session. class Client < Connection # The client's JID @@ -23,13 +29,8 @@ module Jabber # # Remember to *always* put a resource in your JID unless the server can do SASL. def initialize(jid, threaded = true) - unless threaded - puts "Non-threaded mode is currently broken, re-enabling threaded" - threaded = true - end - super(threaded) - @jid = jid + @jid = (jid.kind_of?(JID) ? jid : JID.new(jid.to_s)) end ## @@ -64,7 +65,7 @@ module Jabber end } rescue NameError - puts "Resolv::DNS does not support SRV records. Please upgrade to ruby-1.8.3 or later!" + $stderr.puts "Resolv::DNS does not support SRV records. Please upgrade to ruby-1.8.3 or later!" end # Fallback to normal connect method end lib/xmpp4r/client.rb @@ -23,20 +23,31 @@ module Jabber # Create a new Component # jid:: [JID] - # server_address:: [String] Hostname - # server_port:: [Integer] TCP port (5347) - def initialize(jid, server_address, server_port=5347, threaded = true) + def initialize(jid, server_address=nil, server_port=5347, threaded = true) super(threaded) - @jid = jid - @server_address = server_address - @server_port = server_port + @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 " + + "obsolete and will vanish in some later XMPP4R release. " + + "Please use these arguments when calling " + + "Jabber::Client#connect" + @server_address = server_address + @server_port = server_port + end end # Connect to the server # (chaining-friendly) + # server:: [String] Hostname + # port:: [Integer] TCP port (5347) # return:: self - def connect - super(@server_address, @server_port) + def connect(server=nil, port=5347) + if server + super(server, port) + else + super(@server_address, @server_port) + end self end @@ -77,7 +88,7 @@ module Jabber send("<handshake>#{hash}</handshake>") { |r| if r.prefix == 'stream' and r.name == 'error' true - elsif r.name == 'handshake' and r.namespace == 'jabber:component:accept' + elsif r.name == 'handshake' authenticated = true true else lib/xmpp4r/component.rb @@ -46,6 +46,8 @@ module Jabber def connect(host, port) @host = host @port = port + # Reset is_tls?, so that it works when reconnecting + @tls = false Jabber::debuglog("CONNECTING:\n#{@host}:#{@port}") @socket = TCPSocket.new(@host, @port) lib/xmpp4r/connection.rb @@ -209,15 +209,6 @@ module Jabber end ## - # Create a new Iq stanza with a vCard child - # type:: [String] or "get" if omitted - def Iq.new_vcard(type = :get, to = nil) - iq = Iq::new(type, to) - iq.add(IqVcard::new) - iq - end - - ## # Add a class by name. # Elements with this name will be automatically converted # to the specific class. @@ -234,5 +225,5 @@ end # but then they would be unable to call Iq.add_elementclass # because it hasn't just been defined. -require 'xmpp4r/iq/query' -require 'xmpp4r/iq/vcard' +require 'xmpp4r/query' +require 'xmpp4r/vcard/iq/vcard' lib/xmpp4r/iq.rb @@ -41,7 +41,7 @@ module Jabber end raise ArgumentError, 'Node too long' if (@node || '').length > 1023 - raise ArgumentError, 'Domain too long' if @domain.length > 1023 + raise ArgumentError, 'Domain too long' if (@domain || '').length > 1023 raise ArgumentError, 'Resource too long' if (@resource || '').length > 1023 end @@ -92,6 +92,14 @@ module Jabber end ## + # Ccompare to another JID + # + # String representations are compared, see JID#to_s + def ==(o) + to_s == o.to_s + end + + ## # Compare two JIDs, # helpful for sorting etc. # lib/xmpp4r/jid.rb @@ -184,7 +184,7 @@ module Jabber # Get presence priority, or nil if absent # result:: [Integer] def priority - e = first_element_text('priority') + e = first_element_text('priority') if e return e.to_i else @@ -215,25 +215,26 @@ module Jabber end ## - # Compare two presences using priority. + # Compare two presences using priority + # (with cmp_interest as fall-back). def <=>(o) - if priority.nil? - if o.priority.nil? - return 0 - else - return 1 - end - elsif o.priority.nil? - return -1 + if priority.to_i == o.priority.to_i + cmp_interest(o) else - return priority <=> o.priority + priority.to_i <=> o.priority.to_i end end ## # Compare two presences. The most suitable to talk with is the # biggest. - PRESENCE_STATUS = { :chat => 4, nil => 3, :dnd => 2, :away => 1, :xa => 0 } + PRESENCE_STATUS = { :chat => 4, + nil => 3, + :dnd => 2, + :away => 1, + :xa => 0, + :unavailable => -1, + :error => -2 } def cmp_interest(o) if type.nil? if o.type.nil? lib/xmpp4r/presence.rb @@ -6,6 +6,10 @@ require 'rexml/document' require 'rexml/parsers/xpathparser' require 'rexml/source' +# Turn $VERBOSE off to suppress warnings about redefinition +oldverbose = $VERBOSE +$VERBOSE = false + # REXML module. This file only adds a few methods to the REXML module, to # ease the coding. module REXML @@ -817,4 +821,6 @@ module REXML ############################################################################ end +# Restore the old $VERBOSE setting +$VERBOSE = oldverbose lib/xmpp4r/rexmladdons.rb @@ -39,11 +39,15 @@ module Jabber @messagecbs = CallbackList::new @iqcbs = CallbackList::new @presencecbs = CallbackList::new + unless threaded + $stderr.puts "Non-threaded mode is currently broken, re-enabling threaded" + threaded = true + end @threaded = threaded @stanzaqueue = [] @stanzaqueue_lock = Mutex::new @exception_block = nil - @threadblocks = {} + @threadblocks = [] # @pollCounter = 10 @waiting_thread = nil @wakeup_thread = nil @@ -62,11 +66,14 @@ module Jabber @parserThread = Thread.new do begin @parser.parse - rescue + rescue Exception => e + Jabber::debuglog("EXCEPTION:\n#{e.class}\n#{e.message}\n#{e.backtrace.join("\n")}") + if @exception_block - Thread.new { @exception_block.call($!, self, :start) } + Thread.new { close; @exception_block.call(e, self, :start) } else puts "Exception caught in Parser thread!" + close raise end end @@ -97,28 +104,47 @@ module Jabber # The block has to take three arguments: # * the Exception # * the Jabber::Stream object (self) - # * a symbol where it happened, namely :start, :parser and :sending + # * a symbol where it happened, namely :start, :parser, :sending and :end def on_exception(&block) @exception_block = block end ## # This method is called by the parser when a failure occurs - def parse_failure + def parse_failure(e) + Jabber::debuglog("EXCEPTION:\n#{e.class}\n#{e.message}\n#{e.backtrace.join("\n")}") + # A new thread has to be created because close will cause the thread - # to commit suicide + # to commit suicide(???) if @exception_block - Thread.new { @exception_block.call($!, self, :parser) } + # New thread, because close will kill the current thread + Thread.new { + close + @exception_block.call(e, self, :parser) + } else puts "Stream#parse_failure was called by XML parser. Dumping " + - "backtrace...\n" + $!.exception + "\n" - puts $!.backtrace + "backtrace...\n" + e.exception + "\n" + puts e.backtrace close raise end end ## + # This method is called by the parser upon receiving <tt></stream:stream></tt> + def parser_end + if @exception_block + Thread.new { + close + @exception_block.call(nil, self, :close) + } + else + close + end + end + + ## # Returns if this connection is connected to a Jabber service # return:: [Boolean] Connection status def is_connected? @@ -137,8 +163,20 @@ module Jabber # Processes a received REXML::Element and executes # registered thread blocks and filters against it. # + # If in threaded mode, a new thread will be spawned + # for the call to receive_nonthreaded. # element:: [REXML::Element] The received element def receive(element) + if @threaded + # Don't spawn a new thread here. An implicit feature + # of XMPP is constant order of stanzas. + receive_nonthreaded(element) + else + receive_nonthreaded(element) + end + end + + def receive_nonthreaded(element) Jabber::debuglog("RECEIVED:\n#{element.to_s}") case element.prefix when 'stream' @@ -179,13 +217,29 @@ module Jabber end end - # Iterate through blocked theads (= waiting for an answer) - @threadblocks.each { |thread, proc| - r = proc.call(stanza) + # Iterate through blocked threads (= waiting for an answer) + # + # We're dup'ping the @threadblocks here, so that we won't end up in an + # endless loop if Stream#send is being nested. That means, the nested + # threadblock won't receive the stanza currently processed, but the next + # one. + threadblocks = @threadblocks.dup + threadblocks.each { |threadblock| + exception = nil + r = false + begin + r = threadblock.call(stanza) + rescue Exception => e + exception = e + end + if r == true - @threadblocks.delete(thread) - thread.wakeup if thread.alive? + @threadblocks.delete(threadblock) + threadblock.wakeup return + elsif exception + @threadblocks.delete(threadblock) + threadblock.raise(exception) end } @@ -199,6 +253,7 @@ module Jabber @waiting_thread.wakeup if @waiting_thread end end + private :receive_nonthreaded ## # Process |element| until it is consumed. Returns element.consumed? @@ -273,31 +328,47 @@ module Jabber end ## + # This is used by Jabber::Stream internally to + # keep track of any blocks which were passed to + # Stream#send. + class ThreadBlock + def initialize(block) + @thread = Thread.current + @block = block + end + def call(*args) + @block.call(*args) + end + def wakeup + # TODO: Handle threadblock removal if !alive? + @thread.wakeup if @thread.alive? + end + def raise(exception) + @thread.raise(exception) if @thread.alive? + end + end + + ## # Sends XML data to the socket and (optionally) waits # to process received data. # - # If you invoke this method again in &block, you cannot - # define a second block. It will return immediately. - # If you need this, move your second Stream#send outside - # the &block. - # # xml:: [String] The xml data to send - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def send(xml, proc=nil, &block) - Jabber::debuglog("SENDING:\n#{ xml.kind_of?(String) ? xml : xml.to_s }") - xml = xml.to_s if not xml.kind_of? String - block = proc if proc - @threadblocks[Thread.current]=block if block + def send(xml, &block) + Jabber::debuglog("SENDING:\n#{xml}") + @threadblocks.unshift(ThreadBlock.new(block)) if block Thread.critical = true # we don't want to be interupted before we stop! begin - @fd << xml + @fd << xml.to_s @fd.flush - rescue + rescue Exception => e + Jabber::debuglog("EXCEPTION:\n#{e.class}\n#{e.message}\n#{e.backtrace.join("\n")}") + if @exception_block - @exception_block.call($!, self, :sending) + Thread.new { close!; @exception_block.call(e, self, :sending) } else puts "Exception caught while sending!" + close! raise end end @@ -328,9 +399,9 @@ module Jabber error = nil send(xml) do |received| - if received.id == xml.id + if received.kind_of? XMLStanza and received.id == xml.id if received.type == :error - error = received.error + error = (received.error ? received.error : Error.new) true else yield(received) @@ -367,14 +438,12 @@ module Jabber end ## - # Adds a callback block/proc to process received XML messages + # Adds a callback block to process received XML messages # # priority:: [Integer] The callback's priority, the higher, the sooner # ref:: [String] The callback's reference - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def add_xml_callback(priority = 0, ref = nil, proc=nil, &block) - block = proc if proc + def add_xml_callback(priority = 0, ref = nil, &block) @xmlcbs.add(priority, ref, block) end @@ -387,14 +456,12 @@ module Jabber end ## - # Adds a callback block/proc to process received Messages + # Adds a callback block to process received Messages # # priority:: [Integer] The callback's priority, the higher, the sooner # ref:: [String] The callback's reference - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def add_message_callback(priority = 0, ref = nil, proc=nil, &block) - block = proc if proc + def add_message_callback(priority = 0, ref = nil, &block) @messagecbs.add(priority, ref, block) end @@ -407,14 +474,12 @@ module Jabber end ## - # Adds a callback block/proc to process received Stanzas + # Adds a callback block to process received Stanzas # # priority:: [Integer] The callback's priority, the higher, the sooner # ref:: [String] The callback's reference - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def add_stanza_callback(priority = 0, ref = nil, proc=nil, &block) - block = proc if proc + def add_stanza_callback(priority = 0, ref = nil, &block) @stanzacbs.add(priority, ref, block) end @@ -427,14 +492,12 @@ module Jabber end ## - # Adds a callback block/proc to process received Presences + # Adds a callback block to process received Presences # # priority:: [Integer] The callback's priority, the higher, the sooner # ref:: [String] The callback's reference - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def add_presence_callback(priority = 0, ref = nil, proc=nil, &block) - block = proc if proc + def add_presence_callback(priority = 0, ref = nil, &block) @presencecbs.add(priority, ref, block) end @@ -447,14 +510,12 @@ module Jabber end ## - # Adds a callback block/proc to process received Iqs + # Adds a callback block to process received Iqs # # priority:: [Integer] The callback's priority, the higher, the sooner # ref:: [String] The callback's reference - # proc:: [Proc = nil] The optional proc # &block:: [Block] The optional block - def add_iq_callback(priority = 0, ref = nil, proc=nil, &block) - block = proc if proc + def add_iq_callback(priority = 0, ref = nil, &block) @iqcbs.add(priority, ref, block) end @@ -469,9 +530,13 @@ module Jabber ## # Closes the connection to the Jabber service def close + close! + end + + def close! @parserThread.kill if @parserThread # @pollThread.kill - @fd.close if @fd + @fd.close if @fd and !@fd.closed? @status = DISCONNECTED end end lib/xmpp4r/stream.rb @@ -21,7 +21,7 @@ module Jabber # Constructs a parser for the supplied stream (socket input) # # stream:: [IO] Socket input stream - # listener:: [Object.receive(XMLStanza)] The listener (usually a Jabber::Protocol::Connection instance + # listener:: [Object.receive(XMLStanza)] The listener (usually a Jabber::Protocol::Connection instance) # def initialize(stream, listener) @stream = stream @@ -43,23 +43,25 @@ module Jabber e.add_attributes attributes @current = @current.nil? ? e : @current.add_element(e) - if @current.name == 'stream' - @listener.receive(@current) + if @current.name == 'stream' and !@started @started = true + @listener.receive(@current) + @current = nil end end parser.listen( :end_element ) do |uri, localname, qname| - if qname == "stream:stream" + if qname == 'stream:stream' and @current.nil? @started = false + @listener.parser_end else - @listener.receive(@current) if @current.parent.name == 'stream' + @listener.receive(@current) unless @current.parent @current = @current.parent end end parser.listen( :characters ) do | text | - @current.text = @current.text.to_s + text + @current.text = @current.text.to_s + text if @current end parser.listen( :cdata ) do | text | @@ -67,8 +69,8 @@ module Jabber end parser.parse - rescue REXML::ParseException - @listener.parse_failure + rescue REXML::ParseException => e + @listener.parse_failure(e) end end end lib/xmpp4r/streamparser.rb @@ -2,6 +2,8 @@ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option. # Website::http://home.gna.org/xmpp4r/ +require 'xmpp4r/rexmladdons' + module Jabber ## # A class used to build/parse <x/> elements lib/xmpp4r/x.rb @@ -8,7 +8,7 @@ # a simple debug logging support. module Jabber # XMPP4R Version number - XMPP4R_VERSION = '0.3-pre' + XMPP4R_VERSION = '0.3' end require 'xmpp4r/client' lib/xmpp4r/xmpp4r.rb @@ -1,4 +1,4 @@ -#!/usr/bin/ruby +#!/usr/bin/env ruby # setup.rb # # Copyright (c) 2000-2004 Minero Aoki setup.rb @@ -96,4 +96,33 @@ class CallbacksTest < Test::Unit::TestCase assert(called3) assert(!called4) end + + def test_nested + cbl = CallbackList.new + called_outer = 0 + called_inner = 0 + + cbl.add(100, nil) { + called_outer += 1 + + if called_outer == 1 + cbl.add(200, nil) { + called_inner += 1 + } + end + } + + assert_equal(0, called_inner) + assert_equal(0, called_outer) + + cbl.process + + assert_equal(0, called_inner) + assert_equal(1, called_outer) + + cbl.process + + assert_equal(1, called_inner) + assert_equal(2, called_outer) + end end test/tc_callbacks.rb @@ -8,10 +8,23 @@ include Jabber class ClientTest < Test::Unit::TestCase def test_client1 - assert_nothing_raised("Couldn't connect") do - c = Client::new(JID::new('client1@localhost/res')) +=begin + c = Client::new(JID::new('client1@localhost/res')) + assert_nothing_raised("Couldn't connect") { c.connect - assert(c.auth('pw'), "Auth failed") - end + } + assert_nothing_raised("Couldn't authenticate") { + c.auth('pw') + } +=end + end + + def test_jid_is_jid + c1 = Client::new(JID::new('user@host/resource')) + assert_kind_of(JID, c1.jid) + assert_equal('user@host/resource', c1.jid.to_s) + c2 = Client::new('user@host/resource') + assert_kind_of(JID, c2.jid) + assert_equal('user@host/resource', c2.jid.to_s) end end test/tc_client.rb @@ -33,6 +33,49 @@ class ErrorTest < Test::Unit::TestCase assert_equal('User moved to afterlife.gov', e.text) end + def test_create_invalid + assert_raise(RuntimeError) { + e = Error::new('invalid error') + } + end + + def test_type + e = Error::new + assert_nil(e.type) + e.type = :auth + assert_equal(:auth, e.type) + e.type = :cancel + assert_equal(:cancel, e.type) + e.type = :continue + assert_equal(:continue, e.type) + e.type = :modify + assert_equal(:modify, e.type) + e.type = :wait + assert_equal(:wait, e.type) + e.type = nil + assert_nil(e.type) + end + + def test_code + e = Error::new + assert_nil(e.code) + e.code = 404 + assert_equal(404, e.code) + assert_equal("<error code='404'/>", e.to_s) + e.code = nil + assert_nil(e.code) + end + + def test_error + e = Error::new + assert_nil(e.error) + e.error = 'gone' + assert_equal('gone', e.error) + assert_raise(RuntimeError) { + e.error = nil + } + end + def test_stanzas m = Message.new assert_equal(nil, m.error) test/tc_error.rb @@ -20,13 +20,72 @@ class IqTest < Test::Unit::TestCase assert_equal("<iq type='set'><query xmlns='jabber:iq:auth'><username>node</username><password>password</password><resource>resource</resource></query></iq>", x.to_s) end + def test_iqauth_digest + x = Iq::new_authset_digest(JID::new('node@domain/resource'), '', 'password') + assert_equal("<iq type='set'><query xmlns='jabber:iq:auth'><username>node</username><digest>#{Digest::SHA1.new('password').hexdigest}</digest><resource>resource</resource></query></iq>", x.to_s) + end + + def test_register + x1 = Iq::new_register + assert_equal("<iq type='set'><query xmlns='jabber:iq:register'/></iq>", x1.to_s) + x2 = Iq::new_register('node') + assert_equal("<iq type='set'><query xmlns='jabber:iq:register'><username>node</username></query></iq>", x2.to_s) + x3 = Iq::new_register('node', 'password') + assert_equal("<iq type='set'><query xmlns='jabber:iq:register'><username>node</username><password>password</password></query></iq>", x3.to_s) + end + + def test_rosterget + x = Iq::new_rosterget + assert_equal("<iq type='get'><query xmlns='jabber:iq:roster'/></iq>", x.to_s) + end + + def test_rosterset + x = Iq::new_rosterset + assert_equal("<iq type='set'><query xmlns='jabber:iq:roster'/></iq>", x.to_s) + end + + def test_browseget + x = Iq::new_browseget + assert_equal("<iq type='get'><query xmlns='jabber:iq:browse'/></iq>", x.to_s) + end + + def test_types + iq = Iq::new + assert_equal(nil, iq.type) + iq.type = :get + assert_equal(:get, iq.type) + iq.type = :set + assert_equal(:set, iq.type) + iq.type = :result + assert_equal(:result, iq.type) + iq.type = :error + assert_equal(:error, iq.type) + iq.type = :invalid + assert_equal(nil, iq.type) + end + def test_query x = Iq::new(:set) + assert_equal(nil, x.queryns) query = REXML::Element::new('query') - query.add_namespace('jabber:iq:auth') x.add(query) + assert_equal('', x.queryns) + query.add_namespace('jabber:iq:auth') assert_equal(query.to_s, x.query.to_s) assert_equal('jabber:iq:auth', x.queryns) + + query2 = REXML::Element::new('query') + x.query = query2 + assert_equal('', x.queryns) + query2.add_namespace('jabber:iq:register') + assert_equal('jabber:iq:register', x.queryns) + end + + def test_vcard + x = Iq::new + assert_equal(nil, x.vcard) + x.add(vcard = REXML::Element.new('vCard')) + assert_equal(vcard, x.vcard) end def test_error @@ -38,4 +97,13 @@ class IqTest < Test::Unit::TestCase x2 = Iq::new.import(x) assert_equal(Error, x2.first_element('error').class) end + + def test_new_query + x = Iq::new_query(:get, JID.new('a@b/c')) + assert_equal(:get, x.type) + assert_equal(nil, x.from) + assert_equal(JID.new('a@b/c'), x.to) + assert_kind_of(IqQuery, x.query) + assert_equal('', x.queryns) + end end test/tc_iq.rb @@ -4,7 +4,7 @@ $:.unshift '../lib' require 'test/unit' require 'xmpp4r/rexmladdons' -require 'xmpp4r/iq/query' +require 'xmpp4r/query' include Jabber class IqQueryTest < Test::Unit::TestCase test/tc_iqquery.rb @@ -189,4 +189,14 @@ end assert(JID.new("node@domain").bared?) assert(!JID.new("node@domain/res").bared?) end + + def test_sort + assert_equal(-1, JID.new('a@b') <=> JID.new('b@b')) + assert_equal(0, JID.new('a@b') <=> JID.new('a@b')) + assert_equal(1, JID.new('a@b/r') <=> JID.new('a@b')) + + jids = [JID.new('b@b'), JID.new('a@b/r'), JID.new('a@b')] + jids.sort! + assert_equal([JID.new('a@b'), JID.new('a@b/r'), JID.new('b@b')], jids) + end end test/tc_jid.rb @@ -21,6 +21,30 @@ class MessageTest < Test::Unit::TestCase assert_equal("coucou", x.body) end + def test_import + x = Message::new + assert_kind_of(REXML::Element, x.typed_add(REXML::Element.new('thread'))) + assert_kind_of(X, x.typed_add(REXML::Element.new('x'))) + assert_kind_of(X, x.x) + end + + def test_type + x = Message.new + assert_equal(nil, x.type) + x.type = :chat + assert_equal(:chat, x.type) + assert_equal(x, x.set_type(:error)) + assert_equal(:error, x.type) + x.type = :groupchat + assert_equal(:groupchat, x.type) + x.type = :headline + assert_equal(:headline, x.type) + x.type = :normal + assert_equal(:normal, x.type) + x.type = :invalid + assert_equal(nil, x.type) + end + def test_body x = Message::new() assert_equal(nil, x.body) @@ -30,6 +54,34 @@ class MessageTest < Test::Unit::TestCase assert_equal("2", x.body) end + def test_subject + x = Message::new + assert_equal(nil, x.subject) + subject = REXML::Element.new('subject') + subject.text = 'A' + x.add(subject) + assert_equal('A', x.subject) + x.subject = 'Test message' + assert_equal('Test message', x.subject) + x.each_element('subject') { |s| assert_equal('Test message', s.text) } + assert_equal(x, x.set_subject('Breaking news')) + assert_equal('Breaking news', x.subject) + end + + def test_thread + x = Message::new + assert_equal(nil, x.thread) + thread = REXML::Element.new('thread') + thread.text = '123' + x.add(thread) + assert_equal('123', x.thread) + x.thread = '321' + assert_equal('321', x.thread) + x.each_element('thread') { |s| assert_equal('321', s.text) } + assert_equal(x, x.set_thread('abc')) + assert_equal('abc', x.thread) + end + def test_error x = Message::new() assert_equal(nil, x.error) @@ -40,4 +92,23 @@ class MessageTest < Test::Unit::TestCase x2 = Message::new.import(x) assert_equal(Error, x2.first_element('error').class) end + + def test_answer + orig = Message::new + orig.from = 'a@b' + orig.to = 'b@a' + orig.id = '123' + orig.type = :chat + orig.add(REXML::Element.new('x')) + + answer = orig.answer + assert_equal(JID.new('b@a'), answer.from) + assert_equal(JID.new('a@b'), answer.to) + assert_equal('123', answer.id) + assert_equal(:chat, answer.type) + answer.each_element { |e| + assert_equal('x', e.name) + assert_kind_of(X, e) + } + end end test/tc_message.rb @@ -131,8 +131,8 @@ class PresenceTest < Test::Unit::TestCase assert_equal(0, Presence::new(:chat, '', 5) <=> Presence::new(:chat, '', 5)) assert_equal(-1, Presence::new(:chat, '', 4) <=> Presence::new(:chat, '', 5)) assert_equal(1, Presence::new(:chat, '', 4) <=> Presence::new(:chat, '', 3)) - assert_equal(1, Presence::new(:chat, '', nil) <=> Presence::new(:chat, '', 3)) - assert_equal(-1, Presence::new(:chat, '', 10) <=> Presence::new(:chat, '', nil)) + assert_equal(-1, Presence::new(:chat, '', nil) <=> Presence::new(:chat, '', 3)) + assert_equal(1, Presence::new(:chat, '', 10) <=> Presence::new(:chat, '', nil)) assert_equal(0, Presence::new(:chat, '', nil) <=> Presence::new(:chat, '', nil)) end test/tc_presence.rb @@ -8,6 +8,7 @@ require 'socket' require 'xmpp4r/stream' include Jabber + class StreamTest < Test::Unit::TestCase def setup @tmpfile = Tempfile::new("StreamSendTest") @@ -35,6 +36,9 @@ class StreamTest < Test::Unit::TestCase # tests that stream really waits the call to process() to dispatch # stanzas to filters def test_process +=begin +Disabled, because non-threaded mode is broken + called = false @stream.add_xml_callback { called = true } assert(!called) @@ -44,11 +48,15 @@ class StreamTest < Test::Unit::TestCase assert(!called) @stream.process assert(called) +=end end ## # tests that you can select how many messages you want to get with process def test_process_multi +=begin +Disabled, because non-threaded mode is broken + nbcalls = 0 called = false @stream.add_xml_callback { |element| @@ -81,10 +89,14 @@ class StreamTest < Test::Unit::TestCase @stream.process(1) assert_equal(12, nbcalls) assert(called) +=end end # tests that you can get all waiting messages if you don't use a parameter def test_process_multi2 +=begin +Disabled, because non-threaded mode is broken + @called = false @nbcalls = 0 @stream.add_xml_callback { |element| @@ -111,5 +123,60 @@ class StreamTest < Test::Unit::TestCase @stream.process assert_equal(22, @nbcalls) assert(@called) +=end + end + + # Check that <message><message/></message> is recognized as one Message + def test_similar_children + n = 0 + @stream.add_message_callback { n += 1 } + assert_equal(0, n) + @server.puts('<stream:stream><message/>') + @server.flush + @stream.process + assert_equal(1, n) + @server.puts('<message>') + @server.flush + @stream.process + assert_equal(1, n) + @server.puts('<message/>') + @server.flush + @stream.process + assert_equal(1, n) + @server.puts('</message>') + @server.flush + @stream.process + assert_equal(2, n) + @server.puts('<message><stream:stream><message/></stream:stream>') + @server.flush + @stream.process + assert_equal(2, n) + @server.puts('</message>') + @server.flush + @stream.process + assert_equal(3, n) + end + + def test_send + @server.puts('<stream:stream>') + @server.flush + @stream.process + + Thread.new { + assert_equal(Iq.new(:get).to_s, @server.gets('>')) + @stream.receive(Iq.new(:result)) + } + + called = 0 + @stream.send(Iq.new(:get)) { |reply| + called += 1 + if reply.kind_of? Iq and reply.type == :result + true + else + false + end + } + + assert_equal(1, called) end end test/tc_stream.rb @@ -40,7 +40,9 @@ class ConnectionErrorTest < Test::Unit::TestCase @server.puts('<stream:stream>') @server.flush assert(!error) - @server.puts('</blop>') + assert_raise(Errno::EPIPE) { + @server.puts('</blop>') + } @server.flush sleep 0.2 assert(error) test/tc_streamError.rb @@ -41,4 +41,128 @@ class StreamThreadedTest < Test::Unit::TestCase @server.flush assert(called) end + + def test_process100 + @server.puts('<stream:stream>') + @server.flush + + n = 0 + @stream.add_message_callback { n += 1 } + + 100.times { + @server.puts('<message/>') + @server.flush + } + + assert_equal(100, n) + + @server.puts('<message/>' * 100) + @server.flush + sleep 0.1 + + assert_equal(200, n) + end + + def test_send + @server.puts('<stream:stream>') + @server.flush + + Thread.new { + assert_equal(Iq.new(:get).to_s, @server.gets('>')) + @stream.receive(Iq.new(:result)) + } + + called = 0 + @stream.send(Iq.new(:get)) { |reply| + called += 1 + if reply.kind_of? Iq and reply.type == :result + true + else + false + end + } + + assert_equal(1, called) + end + + def test_send_nested + @server.puts('<stream:stream>') + @server.flush + finished = Mutex.new + finished.lock + + Thread.new { + assert_equal(Iq.new(:get).to_s, @server.gets('>')) + @server.puts(Iq.new(:result).set_id('1').to_s) + @server.flush + assert_equal(Iq.new(:set).to_s, @server.gets('>')) + @server.puts(Iq.new(:result).set_id('2').to_s) + @server.flush + assert_equal(Iq.new(:get).to_s, @server.gets('>')) + @server.puts(Iq.new(:result).set_id('3').to_s) + @server.flush + + finished.unlock + } + + called_outer = 0 + called_inner = 0 + + @stream.send(Iq.new(:get)) { |reply| + called_outer += 1 + assert_kind_of(Iq, reply) + assert_equal(:result, reply.type) + + if reply.id == '1' + @stream.send(Iq.new(:set)) { |reply| + called_inner += 1 + assert_kind_of(Iq, reply) + assert_equal(:result, reply.type) + assert_equal('2', reply.id) + + @stream.send(Iq.new(:get)) + + true + } + false + elsif reply.id == '3' + true + else + false + end + } + + assert_equal(2, called_outer) + assert_equal(1, called_inner) + + finished.lock + end + + def test_bidi + @server.puts('<stream:stream>') + @server.flush + finished = Mutex.new + ok = true + + Thread.new { + 100.times { |i| + ok &&= (Iq.new(:get).set_id(i).to_s == @server.gets('>')) + @server.puts(Iq.new(:result).set_id(i).to_s) + @server.flush + } + finished.unlock + } + + 100.times { |i| + @stream.send(Iq.new(:get).set_id(i)) { |reply| + ok &&= reply.kind_of? Iq + ok &&= (:result == reply.type) + ok &&= (i.to_s == reply.id) + true + } + } + + assert(ok) + 2.times { finished.lock } + end end test/tc_streamThreaded.rb @@ -1,24 +1,34 @@ #!/usr/bin/ruby -w + $:.unshift File.join(File.dirname(__FILE__), '..', 'lib') $:.unshift File.join(File.dirname(__FILE__), '..', 'test') $:.unshift File.join(File.dirname(__FILE__), 'lib') $:.unshift File.join(File.dirname(__FILE__), 'test') -require 'tc_callbacks' -require 'tc_client' +require 'tc_streamThreaded' +require 'bytestreams/tc_ibb' +require 'bytestreams/tc_socks5bytestreams' +require 'delay/tc_xdelay' +require 'muc/tc_muc_simplemucclient' +require 'muc/tc_muc_mucclient' require 'tc_error' +require 'tc_stream' +require 'tc_idgenerator' require 'tc_iqquery' -require 'tc_iqqueryroster' -require 'tc_iqqueryversion' -require 'tc_iq' -require 'tc_iqvcard' -require 'tc_jid' -require 'tc_message' +#require 'tc_streamError' require 'tc_presence' -require 'tc_streamError' -require 'tc_stream' +require 'vcard/tc_iqvcard' +require 'roster/tc_iqqueryroster' +require 'roster/tc_xroster' +require 'roster/tc_helper' +require 'version/tc_iqqueryversion' +require 'version/tc_helper' require 'tc_streamSend' -require 'tc_streamThreaded' -require 'tc_xdelay' +require 'tc_jid' +require 'tc_iq' +require 'tc_client' +require 'tc_callbacks' require 'tc_xmlstanza' +require 'tc_message' +require 'tc_class_names' test/ts_xmpp4r.rb lib/xmpp4r/helpers/filetransfer.rb lib/xmpp4r/helpers/ibb.rb lib/xmpp4r/helpers/ibb/base.rb lib/xmpp4r/helpers/ibb/initiator.rb lib/xmpp4r/helpers/ibb/target.rb lib/xmpp4r/helpers/mucbrowser.rb lib/xmpp4r/helpers/mucclient.rb lib/xmpp4r/helpers/roster.rb lib/xmpp4r/helpers/simplemucclient.rb lib/xmpp4r/helpers/simpleversion.rb lib/xmpp4r/helpers/socks5bytestreams.rb lib/xmpp4r/helpers/socks5bytestreams/base.rb lib/xmpp4r/helpers/socks5bytestreams/initiator.rb lib/xmpp4r/helpers/socks5bytestreams/server.rb lib/xmpp4r/helpers/socks5bytestreams/socks5.rb lib/xmpp4r/helpers/socks5bytestreams/target.rb lib/xmpp4r/helpers/socks5bytestreamsserver.rb lib/xmpp4r/helpers/vcard.rb lib/xmpp4r/helpers/version.rb lib/xmpp4r/iq/feature.rb lib/xmpp4r/iq/query.rb lib/xmpp4r/iq/query/bytestreams.rb lib/xmpp4r/iq/query/discoinfo.rb lib/xmpp4r/iq/query/discoitems.rb lib/xmpp4r/iq/query/roster.rb lib/xmpp4r/iq/query/version.rb lib/xmpp4r/iq/si.rb lib/xmpp4r/iq/vcard.rb lib/xmpp4r/x/data.rb lib/xmpp4r/x/delay.rb lib/xmpp4r/x/muc.rb lib/xmpp4r/x/mucuserinvite.rb lib/xmpp4r/x/mucuseritem.rb lib/xmpp4r/x/roster.rb test/tc_iqqueryroster.rb test/tc_iqqueryversion.rb test/tc_iqvcard.rb test/tc_xdelay.rb test/tc_xroster.rb 569db0a4a21af617441af7a37022405ec1f4975f Stephan M astro@gna.org http://github.com/ln/xmpp4r/commit/cb4efb7e387997c2617a0f82476d6ef313ea15b5 cb4efb7e387997c2617a0f82476d6ef313ea15b5 2006-07-19T14:52:23-07:00 2006-07-19T14:52:23-07:00 Tagged xmpp4r-0.3 git-svn-id: svn://svn.gna.org/svn/xmpp4r/tags/xmpp4r-0.3@262 fc81a325-65fc-0310-ab21-b05fd605316e 008c7390c9a18ef20036bda828d5870f3b7ef4d2 Stephan M astro@gna.org