mojodna-xmpp4r 0.4.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +83 -0
- data/COPYING +340 -0
- data/LICENSE +59 -0
- data/README.rdoc +133 -0
- data/README_ruby19.txt +43 -0
- data/Rakefile +252 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/README +56 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/adventure.rb +23 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb +136 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml +15 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml +69 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/world.rb +424 -0
- data/data/doc/xmpp4r/examples/advanced/fileserve.conf +11 -0
- data/data/doc/xmpp4r/examples/advanced/fileserve.rb +346 -0
- data/data/doc/xmpp4r/examples/advanced/getonline.rb +56 -0
- data/data/doc/xmpp4r/examples/advanced/gtkmucclient.rb +315 -0
- data/data/doc/xmpp4r/examples/advanced/migrate.rb +88 -0
- data/data/doc/xmpp4r/examples/advanced/minimuc.rb +266 -0
- data/data/doc/xmpp4r/examples/advanced/pep-aggregator/index.xsl +235 -0
- data/data/doc/xmpp4r/examples/advanced/pep-aggregator/pep-aggregator.rb +147 -0
- data/data/doc/xmpp4r/examples/advanced/recvfile.rb +84 -0
- data/data/doc/xmpp4r/examples/advanced/rosterdiscovery.rb +129 -0
- data/data/doc/xmpp4r/examples/advanced/sendfile.conf +10 -0
- data/data/doc/xmpp4r/examples/advanced/sendfile.rb +72 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr.rb +51 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_jabber.rb +43 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_test.rb +10 -0
- data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +109 -0
- data/data/doc/xmpp4r/examples/advanced/xmpping.rb +146 -0
- data/data/doc/xmpp4r/examples/advanced/xmppingrc.sample +14 -0
- data/data/doc/xmpp4r/examples/basic/change_password.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/client.rb +70 -0
- data/data/doc/xmpp4r/examples/basic/component.rb +11 -0
- data/data/doc/xmpp4r/examples/basic/echo.rb +37 -0
- data/data/doc/xmpp4r/examples/basic/jabbersend.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/mass_sender.rb +68 -0
- data/data/doc/xmpp4r/examples/basic/muc_owner_config.rb +12 -0
- data/data/doc/xmpp4r/examples/basic/mucinfo.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb +82 -0
- data/data/doc/xmpp4r/examples/basic/register.rb +42 -0
- data/data/doc/xmpp4r/examples/basic/remove_registration.rb +18 -0
- data/data/doc/xmpp4r/examples/basic/roster.rb +44 -0
- data/data/doc/xmpp4r/examples/basic/rosterprint.rb +50 -0
- data/data/doc/xmpp4r/examples/basic/rosterrename.rb +34 -0
- data/data/doc/xmpp4r/examples/basic/rosterwatch.rb +171 -0
- data/data/doc/xmpp4r/examples/basic/send_vcard.rb +67 -0
- data/data/doc/xmpp4r/examples/basic/tune_client.rb +56 -0
- data/data/doc/xmpp4r/examples/basic/tune_server.rb +58 -0
- data/data/doc/xmpp4r/examples/basic/versionbot.rb +75 -0
- data/lib/xmpp4r/base64.rb +32 -0
- data/lib/xmpp4r/bytestreams/helper/filetransfer.rb +319 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/base.rb +257 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb +31 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +47 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb +152 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb +86 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb +198 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb +65 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +73 -0
- data/lib/xmpp4r/bytestreams/iq/bytestreams.rb +170 -0
- data/lib/xmpp4r/bytestreams/iq/si.rb +206 -0
- data/lib/xmpp4r/bytestreams.rb +15 -0
- data/lib/xmpp4r/callbacks.rb +133 -0
- data/lib/xmpp4r/caps/c.rb +67 -0
- data/lib/xmpp4r/caps/helper/generator.rb +160 -0
- data/lib/xmpp4r/caps/helper/helper.rb +87 -0
- data/lib/xmpp4r/caps.rb +1 -0
- data/lib/xmpp4r/client.rb +344 -0
- data/lib/xmpp4r/command/helper/responder.rb +53 -0
- data/lib/xmpp4r/command/iq/command.rb +154 -0
- data/lib/xmpp4r/component.rb +103 -0
- data/lib/xmpp4r/connection.rb +219 -0
- data/lib/xmpp4r/dataforms/x/data.rb +297 -0
- data/lib/xmpp4r/dataforms.rb +5 -0
- data/lib/xmpp4r/debuglog.rb +42 -0
- data/lib/xmpp4r/delay/x/delay.rb +99 -0
- data/lib/xmpp4r/delay.rb +5 -0
- data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
- data/lib/xmpp4r/discovery/helper/responder.rb +165 -0
- data/lib/xmpp4r/discovery/iq/discoinfo.rb +211 -0
- data/lib/xmpp4r/discovery/iq/discoitems.rb +147 -0
- data/lib/xmpp4r/discovery.rb +8 -0
- data/lib/xmpp4r/errors.rb +283 -0
- data/lib/xmpp4r/feature_negotiation/iq/feature.rb +28 -0
- data/lib/xmpp4r/feature_negotiation.rb +5 -0
- data/lib/xmpp4r/framework/base.rb +55 -0
- data/lib/xmpp4r/framework/bot.rb +148 -0
- data/lib/xmpp4r/httpbinding/client.rb +275 -0
- data/lib/xmpp4r/httpbinding.rb +5 -0
- data/lib/xmpp4r/idgenerator.rb +37 -0
- data/lib/xmpp4r/iq.rb +221 -0
- data/lib/xmpp4r/jid.rb +167 -0
- data/lib/xmpp4r/last/helper/helper.rb +37 -0
- data/lib/xmpp4r/last/iq/last.rb +67 -0
- data/lib/xmpp4r/last.rb +2 -0
- data/lib/xmpp4r/location/helper/helper.rb +56 -0
- data/lib/xmpp4r/location/location.rb +179 -0
- data/lib/xmpp4r/location.rb +2 -0
- data/lib/xmpp4r/message.rb +181 -0
- data/lib/xmpp4r/muc/helper/mucbrowser.rb +92 -0
- data/lib/xmpp4r/muc/helper/mucclient.rb +462 -0
- data/lib/xmpp4r/muc/helper/simplemucclient.rb +332 -0
- data/lib/xmpp4r/muc/iq/mucadmin.rb +23 -0
- data/lib/xmpp4r/muc/iq/mucadminitem.rb +20 -0
- data/lib/xmpp4r/muc/iq/mucowner.rb +15 -0
- data/lib/xmpp4r/muc/item.rb +143 -0
- data/lib/xmpp4r/muc/x/muc.rb +70 -0
- data/lib/xmpp4r/muc/x/mucuserinvite.rb +60 -0
- data/lib/xmpp4r/muc/x/mucuseritem.rb +36 -0
- data/lib/xmpp4r/muc.rb +14 -0
- data/lib/xmpp4r/presence.rb +232 -0
- data/lib/xmpp4r/pubsub/children/configuration.rb +86 -0
- data/lib/xmpp4r/pubsub/children/event.rb +49 -0
- data/lib/xmpp4r/pubsub/children/item.rb +35 -0
- data/lib/xmpp4r/pubsub/children/items.rb +53 -0
- data/lib/xmpp4r/pubsub/children/node_config.rb +48 -0
- data/lib/xmpp4r/pubsub/children/publish.rb +38 -0
- data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
- data/lib/xmpp4r/pubsub/children/subscription.rb +62 -0
- data/lib/xmpp4r/pubsub/children/subscription_config.rb +67 -0
- data/lib/xmpp4r/pubsub/children/unsubscribe.rb +48 -0
- data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +130 -0
- data/lib/xmpp4r/pubsub/helper/nodehelper.rb +156 -0
- data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +107 -0
- data/lib/xmpp4r/pubsub/helper/servicehelper.rb +456 -0
- data/lib/xmpp4r/pubsub/iq/pubsub.rb +19 -0
- data/lib/xmpp4r/pubsub.rb +8 -0
- data/lib/xmpp4r/query.rb +15 -0
- data/lib/xmpp4r/rexmladdons.rb +157 -0
- data/lib/xmpp4r/roster/helper/roster.rb +519 -0
- data/lib/xmpp4r/roster/iq/roster.rb +215 -0
- data/lib/xmpp4r/roster/x/roster.rb +138 -0
- data/lib/xmpp4r/roster.rb +7 -0
- data/lib/xmpp4r/rpc/helper/client.rb +123 -0
- data/lib/xmpp4r/rpc/helper/server.rb +74 -0
- data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb +67 -0
- data/lib/xmpp4r/rpc/iq/rpc.rb +23 -0
- data/lib/xmpp4r/rpc.rb +2 -0
- data/lib/xmpp4r/sasl.rb +243 -0
- data/lib/xmpp4r/semaphore.rb +38 -0
- data/lib/xmpp4r/stream.rb +531 -0
- data/lib/xmpp4r/streamparser.rb +81 -0
- data/lib/xmpp4r/tune/helper/helper.rb +58 -0
- data/lib/xmpp4r/tune/tune.rb +113 -0
- data/lib/xmpp4r/tune.rb +2 -0
- data/lib/xmpp4r/vcard/helper/vcard.rb +84 -0
- data/lib/xmpp4r/vcard/iq/vcard.rb +109 -0
- data/lib/xmpp4r/vcard.rb +6 -0
- data/lib/xmpp4r/version/helper/responder.rb +72 -0
- data/lib/xmpp4r/version/helper/simpleresponder.rb +44 -0
- data/lib/xmpp4r/version/iq/version.rb +105 -0
- data/lib/xmpp4r/version.rb +7 -0
- data/lib/xmpp4r/x.rb +37 -0
- data/lib/xmpp4r/xhtml/html.rb +115 -0
- data/lib/xmpp4r/xhtml.rb +1 -0
- data/lib/xmpp4r/xmpp4r.rb +18 -0
- data/lib/xmpp4r/xmppelement.rb +168 -0
- data/lib/xmpp4r/xmppstanza.rb +162 -0
- data/lib/xmpp4r.rb +116 -0
- data/setup.rb +1586 -0
- data/test/bytestreams/tc_ibb.rb +186 -0
- data/test/bytestreams/tc_socks5bytestreams.rb +113 -0
- data/test/caps/tc_helper.rb +156 -0
- data/test/dataforms/tc_data.rb +81 -0
- data/test/delay/tc_xdelay.rb +51 -0
- data/test/discovery/tc_responder.rb +91 -0
- data/test/lib/assert_equal_xml.rb +14 -0
- data/test/lib/clienttester.rb +120 -0
- data/test/muc/tc_muc_mucclient.rb +830 -0
- data/test/muc/tc_muc_simplemucclient.rb +114 -0
- data/test/muc/tc_mucowner.rb +50 -0
- data/test/pubsub/tc_helper.rb +722 -0
- data/test/pubsub/tc_nodeconfig.rb +54 -0
- data/test/pubsub/tc_subscriptionconfig.rb +41 -0
- data/test/roster/tc_helper.rb +514 -0
- data/test/roster/tc_iqqueryroster.rb +173 -0
- data/test/roster/tc_xroster.rb +73 -0
- data/test/rpc/tc_helper.rb +96 -0
- data/test/tc_callbacks.rb +129 -0
- data/test/tc_class_names.rb +146 -0
- data/test/tc_client.rb +30 -0
- data/test/tc_errors.rb +146 -0
- data/test/tc_idgenerator.rb +30 -0
- data/test/tc_iq.rb +113 -0
- data/test/tc_iqquery.rb +31 -0
- data/test/tc_jid.rb +204 -0
- data/test/tc_message.rb +132 -0
- data/test/tc_presence.rb +150 -0
- data/test/tc_rexml.rb +139 -0
- data/test/tc_stream.rb +229 -0
- data/test/tc_streamComponent.rb +95 -0
- data/test/tc_streamError.rb +131 -0
- data/test/tc_streamSend.rb +59 -0
- data/test/tc_streamparser.rb +120 -0
- data/test/tc_xmppstanza.rb +135 -0
- data/test/ts_xmpp4r.rb +53 -0
- data/test/tune/tc_helper_recv.rb +84 -0
- data/test/tune/tc_helper_send.rb +74 -0
- data/test/tune/tc_tune.rb +79 -0
- data/test/vcard/tc_helper.rb +49 -0
- data/test/vcard/tc_iqvcard.rb +62 -0
- data/test/version/tc_helper.rb +60 -0
- data/test/version/tc_iqqueryversion.rb +97 -0
- data/test/xhtml/tc_html.rb +41 -0
- data/tools/gen_requires.bash +31 -0
- data/tools/xmpp4r-gemspec-test.rb +11 -0
- data/xmpp4r.gemspec +304 -0
- metadata +346 -0
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'thread'
|
2
|
+
|
3
|
+
module Jabber
|
4
|
+
module Framework
|
5
|
+
class Base
|
6
|
+
|
7
|
+
def self.helper(name, klass=nil, &factory)
|
8
|
+
if klass.nil? and factory.nil?
|
9
|
+
raise "helper #{name} needs a class or factory"
|
10
|
+
end
|
11
|
+
|
12
|
+
define_method(name) do
|
13
|
+
@helpers_lock.synchronize do
|
14
|
+
if @helpers[name]
|
15
|
+
@helpers[name]
|
16
|
+
else
|
17
|
+
if factory
|
18
|
+
@helpers[name] = instance_eval { factory.call(@stream) }
|
19
|
+
elsif klass
|
20
|
+
@helpers[name] = klass.new(@stream)
|
21
|
+
else
|
22
|
+
raise
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
attr_accessor :stream
|
30
|
+
|
31
|
+
def initialize(stream)
|
32
|
+
@stream = stream
|
33
|
+
@helpers = {}
|
34
|
+
@helpers_lock = Mutex.new
|
35
|
+
|
36
|
+
# Catch all unhandled iq stanzas (lowest priority)
|
37
|
+
@stream.add_iq_callback(-1000, self, &method(:on_unhandled_iq))
|
38
|
+
end
|
39
|
+
|
40
|
+
def on_unhandled_iq(iq)
|
41
|
+
if iq.type == :get or iq.type == :set
|
42
|
+
answer = iq.answer(true)
|
43
|
+
answer.type = :error
|
44
|
+
answer.add(ErrorResponse.new('feature-not-implemented'))
|
45
|
+
@stream.send(answer)
|
46
|
+
|
47
|
+
true
|
48
|
+
else
|
49
|
+
false
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,148 @@
|
|
1
|
+
require 'xmpp4r/framework/base'
|
2
|
+
|
3
|
+
require 'xmpp4r'
|
4
|
+
require 'xmpp4r/roster'
|
5
|
+
require 'xmpp4r/caps/c'
|
6
|
+
require 'xmpp4r/discovery'
|
7
|
+
require 'xmpp4r/xhtml'
|
8
|
+
|
9
|
+
module Jabber
|
10
|
+
module Framework
|
11
|
+
##
|
12
|
+
# Abstract handler methods that *may* be implemented by a deriving class:
|
13
|
+
# * on_message(text)
|
14
|
+
# * on_message_xhtml(html_body, text)
|
15
|
+
class Bot < Base
|
16
|
+
helper :roster, Roster::Helper
|
17
|
+
helper(:disco_default) { |cl|
|
18
|
+
Discovery::Responder.new(cl,
|
19
|
+
nil,
|
20
|
+
[Jabber::Discovery::Identity.new('client', 'XMPP4R Bot', 'bot')]
|
21
|
+
)
|
22
|
+
}
|
23
|
+
helper(:disco_caps) { |cl|
|
24
|
+
Discovery::Responder.new(cl,
|
25
|
+
"http://home.gna.org/xmpp4r/#{Jabber::XMPP4R_VERSION}",
|
26
|
+
[Jabber::Discovery::Identity.new('client', 'XMPP4R Bot', 'bot')]
|
27
|
+
)
|
28
|
+
}
|
29
|
+
|
30
|
+
def initialize(jid, password)
|
31
|
+
cl = Jabber::Client.new(jid)
|
32
|
+
cl.connect
|
33
|
+
cl.auth(password)
|
34
|
+
|
35
|
+
super(cl)
|
36
|
+
|
37
|
+
roster.add_subscription_request_callback do |item,presence|
|
38
|
+
if accept_subscription_from?(presence.from.strip)
|
39
|
+
roster.accept_subscription(presence.from.strip)
|
40
|
+
else
|
41
|
+
roster.decline_subscription(presence.from.strip)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
@pep_notifications = []
|
46
|
+
cl.add_message_callback do |msg|
|
47
|
+
if msg.type != :error and msg.body
|
48
|
+
if (html = msg.first_element('html')) and respond_to? :on_message_xhtml
|
49
|
+
on_message_xhtml(html.body, msg.body)
|
50
|
+
elsif respond_to? :on_message
|
51
|
+
on_message(msg.body)
|
52
|
+
end
|
53
|
+
elsif msg.type != :error and (event = msg.first_element('event'))
|
54
|
+
event.each_element('items') do |items|
|
55
|
+
node = items.attributes['node']
|
56
|
+
items.each_element('item') do |item|
|
57
|
+
@pep_notifications.each { |notification_node,callback|
|
58
|
+
if node == notification_node
|
59
|
+
callback.call(msg.from, item)
|
60
|
+
end
|
61
|
+
}
|
62
|
+
end
|
63
|
+
end
|
64
|
+
else
|
65
|
+
false
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
add_cap('presence')
|
70
|
+
add_cap(Caps::NS_CAPS)
|
71
|
+
add_cap('message') if respond_to? :on_message
|
72
|
+
add_cap(XHTML::NS_XHTML_IM) if respond_to? :on_message_xhtml
|
73
|
+
|
74
|
+
@presence_show = nil
|
75
|
+
@presence_status = nil
|
76
|
+
end
|
77
|
+
|
78
|
+
##
|
79
|
+
# Add feature namespace to Capabilities Discovery
|
80
|
+
def add_cap(capability)
|
81
|
+
disco_default.add_feature(capability)
|
82
|
+
disco_caps.add_feature(capability)
|
83
|
+
end
|
84
|
+
|
85
|
+
##
|
86
|
+
# Front-end for Roster::Helper#add_subscription_request_callback
|
87
|
+
#
|
88
|
+
# Can be overwritten, must return true or false
|
89
|
+
def accept_subscription_from?(jid)
|
90
|
+
true
|
91
|
+
end
|
92
|
+
|
93
|
+
##
|
94
|
+
# Send a simple text chat message
|
95
|
+
def send_message(to, text)
|
96
|
+
msg = Message.new
|
97
|
+
msg.type = :chat
|
98
|
+
msg.to = to
|
99
|
+
msg.body = text
|
100
|
+
@stream.send(msg)
|
101
|
+
end
|
102
|
+
|
103
|
+
##
|
104
|
+
# Send an XHTML chat message
|
105
|
+
# text:: [String] alternate plain text body, generated from xhtml_contents if nil
|
106
|
+
def send_message_xhtml(to, xhtml_contents, text=nil)
|
107
|
+
msg = Message.new
|
108
|
+
msg.type = :chat
|
109
|
+
msg.to = to
|
110
|
+
html = msg.add(XHTML::HTML.new(xhtml_contents))
|
111
|
+
msg.body = text ? text : html.to_text
|
112
|
+
@stream.send(msg)
|
113
|
+
end
|
114
|
+
|
115
|
+
##
|
116
|
+
# Set and send a Presence
|
117
|
+
def set_presence(show=nil, status=nil)
|
118
|
+
@presence_show = show
|
119
|
+
@presence_status = status
|
120
|
+
send_presence
|
121
|
+
end
|
122
|
+
|
123
|
+
private
|
124
|
+
|
125
|
+
def send_presence
|
126
|
+
roster.wait_for_roster
|
127
|
+
|
128
|
+
# TODO: vcard photo hash
|
129
|
+
if @presence_show == :unavailable
|
130
|
+
presence = Presence.new(nil, @presence_status)
|
131
|
+
presence.type = :unavailable
|
132
|
+
else
|
133
|
+
presence = Presence.new(@presence_show, @presence_status)
|
134
|
+
end
|
135
|
+
presence.add(disco_caps.generate_caps)
|
136
|
+
@stream.send(presence)
|
137
|
+
end
|
138
|
+
|
139
|
+
public
|
140
|
+
|
141
|
+
def add_pep_notification(node, &callback)
|
142
|
+
add_cap("#{node}+notify")
|
143
|
+
@pep_notifications << [node, callback]
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
end
|
148
|
+
end
|
@@ -0,0 +1,275 @@
|
|
1
|
+
# =XMPP4R - XMPP Library for Ruby
|
2
|
+
# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
|
3
|
+
# Website::http://home.gna.org/xmpp4r/
|
4
|
+
|
5
|
+
# TODO: eval <body type='terminate' condition=
|
6
|
+
|
7
|
+
require 'xmpp4r/client'
|
8
|
+
require 'xmpp4r/semaphore'
|
9
|
+
require 'net/http'
|
10
|
+
|
11
|
+
module Jabber
|
12
|
+
module HTTPBinding
|
13
|
+
##
|
14
|
+
# This class implements an alternative Client
|
15
|
+
# using HTTP Binding (JEP0124).
|
16
|
+
#
|
17
|
+
# This class is designed to be a drop-in replacement
|
18
|
+
# for Jabber::Client, except for the
|
19
|
+
# Jabber::HTTP::Client#connect method which takes an URI
|
20
|
+
# as argument.
|
21
|
+
#
|
22
|
+
# HTTP requests are buffered to not exceed the negotiated
|
23
|
+
# 'polling' and 'requests' parameters.
|
24
|
+
#
|
25
|
+
# Stanzas in HTTP resonses may be delayed to arrive in the
|
26
|
+
# order defined by 'rid' parameters.
|
27
|
+
#
|
28
|
+
# =Debugging
|
29
|
+
# Turning Jabber::debug to true will make debug output
|
30
|
+
# not only spit out stanzas but HTTP request/response
|
31
|
+
# bodies, too.
|
32
|
+
class Client < Jabber::Client
|
33
|
+
|
34
|
+
# Content-Type to be used for communication
|
35
|
+
# (you can set this to "text/html")
|
36
|
+
attr_accessor :http_content_type
|
37
|
+
# The server should wait this value seconds if
|
38
|
+
# there is no stanza to be received
|
39
|
+
attr_accessor :http_wait
|
40
|
+
# The server may hold this amount of stanzas
|
41
|
+
# to reduce number of HTTP requests
|
42
|
+
attr_accessor :http_hold
|
43
|
+
|
44
|
+
##
|
45
|
+
# Initialize
|
46
|
+
# jid:: [JID or String]
|
47
|
+
def initialize(jid)
|
48
|
+
super
|
49
|
+
|
50
|
+
@lock = Mutex.new
|
51
|
+
@pending_requests = 0
|
52
|
+
@last_send = Time.at(0)
|
53
|
+
@send_buffer = ''
|
54
|
+
|
55
|
+
@http_requests = 1
|
56
|
+
@http_wait = 20
|
57
|
+
@http_hold = 1
|
58
|
+
@http_content_type = 'text/xml; charset=utf-8'
|
59
|
+
end
|
60
|
+
|
61
|
+
##
|
62
|
+
# Set up the stream using uri as the HTTP Binding URI
|
63
|
+
#
|
64
|
+
# You may optionally pass host and port parameters
|
65
|
+
# to make use of the JEP0124 'route' feature.
|
66
|
+
#
|
67
|
+
# uri:: [URI::Generic or String]
|
68
|
+
# host:: [String] Optional host to route to
|
69
|
+
# port:: [Fixnum] Port for route feature
|
70
|
+
def connect(uri, host=nil, port=5222)
|
71
|
+
uri = URI::parse(uri) unless uri.kind_of? URI::Generic
|
72
|
+
@uri = uri
|
73
|
+
|
74
|
+
@allow_tls = false # Shall be done at HTTP level
|
75
|
+
@stream_mechanisms = []
|
76
|
+
@stream_features = {}
|
77
|
+
@http_rid = IdGenerator.generate_id.to_i
|
78
|
+
@pending_rid = @http_rid
|
79
|
+
@pending_rid_lock = Semaphore.new
|
80
|
+
|
81
|
+
req_body = REXML::Element.new('body')
|
82
|
+
req_body.attributes['rid'] = @http_rid
|
83
|
+
req_body.attributes['content'] = @http_content_type
|
84
|
+
req_body.attributes['hold'] = @http_hold.to_s
|
85
|
+
req_body.attributes['wait'] = @http_wait.to_s
|
86
|
+
req_body.attributes['to'] = @jid.domain
|
87
|
+
if host
|
88
|
+
req_body.attributes['route'] = "xmpp:#{host}:#{port}"
|
89
|
+
end
|
90
|
+
req_body.attributes['secure'] = 'true'
|
91
|
+
req_body.attributes['xmlns'] = 'http://jabber.org/protocol/httpbind'
|
92
|
+
res_body = post(req_body)
|
93
|
+
unless res_body.name == 'body'
|
94
|
+
raise 'Response body is no <body/> element'
|
95
|
+
end
|
96
|
+
|
97
|
+
@streamid = res_body.attributes['authid']
|
98
|
+
@status = CONNECTED
|
99
|
+
@http_sid = res_body.attributes['sid']
|
100
|
+
@http_wait = res_body.attributes['wait'].to_i if res_body.attributes['wait']
|
101
|
+
@http_hold = res_body.attributes['hold'].to_i if res_body.attributes['hold']
|
102
|
+
@http_inactivity = res_body.attributes['inactivity'].to_i
|
103
|
+
@http_polling = res_body.attributes['polling'].to_i
|
104
|
+
@http_polling = 5 if @http_polling == 0
|
105
|
+
@http_requests = res_body.attributes['requests'].to_i
|
106
|
+
@http_requests = 1 if @http_requests == 0
|
107
|
+
|
108
|
+
receive_elements_with_rid(@http_rid, res_body.children)
|
109
|
+
|
110
|
+
@features_sem.run
|
111
|
+
end
|
112
|
+
|
113
|
+
##
|
114
|
+
# Ensure that there is one pending request
|
115
|
+
#
|
116
|
+
# Will be automatically called if you've sent
|
117
|
+
# a stanza.
|
118
|
+
def ensure_one_pending_request
|
119
|
+
return if is_disconnected?
|
120
|
+
|
121
|
+
if @lock.synchronize { @pending_requests } < 1
|
122
|
+
send_data('')
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
##
|
127
|
+
# Close the session by sending
|
128
|
+
# <presence type='unavailable'/>
|
129
|
+
def close
|
130
|
+
@status = DISCONNECTED
|
131
|
+
send(Jabber::Presence.new.set_type(:unavailable))
|
132
|
+
end
|
133
|
+
|
134
|
+
private
|
135
|
+
|
136
|
+
##
|
137
|
+
# Receive stanzas ensuring that the 'rid' order is kept
|
138
|
+
# result:: [REXML::Element]
|
139
|
+
def receive_elements_with_rid(rid, elements)
|
140
|
+
while rid > @pending_rid
|
141
|
+
@pending_rid_lock.wait
|
142
|
+
end
|
143
|
+
@pending_rid = rid + 1
|
144
|
+
|
145
|
+
elements.each { |e|
|
146
|
+
receive(e)
|
147
|
+
}
|
148
|
+
|
149
|
+
@pending_rid_lock.run
|
150
|
+
end
|
151
|
+
|
152
|
+
##
|
153
|
+
# Do a POST request
|
154
|
+
def post(body)
|
155
|
+
body = body.to_s
|
156
|
+
request = Net::HTTP::Post.new(@uri.path)
|
157
|
+
request.content_length = body.size
|
158
|
+
request.body = body
|
159
|
+
request['Content-Type'] = @http_content_type
|
160
|
+
Jabber::debuglog("HTTP REQUEST (#{@pending_requests + 1}/#{@http_requests}):\n#{request.body}")
|
161
|
+
response = Net::HTTP.start(@uri.host, @uri.port) { |http|
|
162
|
+
http.use_ssl = true if @uri.kind_of? URI::HTTPS
|
163
|
+
http.request(request)
|
164
|
+
}
|
165
|
+
Jabber::debuglog("HTTP RESPONSE (#{@pending_requests + 1}/#{@http_requests}): #{response.class}\n#{response.body}")
|
166
|
+
|
167
|
+
unless response.kind_of? Net::HTTPSuccess
|
168
|
+
# Unfortunately, HTTPResponses aren't exceptions
|
169
|
+
# TODO: rescue'ing code should be able to distinguish
|
170
|
+
raise Net::HTTPBadResponse, "#{response.class}"
|
171
|
+
end
|
172
|
+
|
173
|
+
body = REXML::Document.new(response.body).root
|
174
|
+
if body.name != 'body' and body.namespace != 'http://jabber.org/protocol/httpbind'
|
175
|
+
raise REXML::ParseException.new('Malformed body')
|
176
|
+
end
|
177
|
+
body
|
178
|
+
end
|
179
|
+
|
180
|
+
##
|
181
|
+
# Prepare data to POST and
|
182
|
+
# handle the result
|
183
|
+
def post_data(data)
|
184
|
+
req_body = nil
|
185
|
+
current_rid = nil
|
186
|
+
|
187
|
+
begin
|
188
|
+
begin
|
189
|
+
@lock.synchronize {
|
190
|
+
# Do not send unneeded requests
|
191
|
+
if data.size < 1 and @pending_requests > 0
|
192
|
+
return
|
193
|
+
end
|
194
|
+
|
195
|
+
req_body = "<body"
|
196
|
+
req_body += " rid='#{@http_rid += 1}'"
|
197
|
+
req_body += " sid='#{@http_sid}'"
|
198
|
+
req_body += " xmlns='http://jabber.org/protocol/httpbind'"
|
199
|
+
req_body += ">"
|
200
|
+
req_body += data
|
201
|
+
req_body += "</body>"
|
202
|
+
current_rid = @http_rid
|
203
|
+
|
204
|
+
@pending_requests += 1
|
205
|
+
@last_send = Time.now
|
206
|
+
}
|
207
|
+
|
208
|
+
res_body = post(req_body)
|
209
|
+
|
210
|
+
ensure
|
211
|
+
@lock.synchronize { @pending_requests -= 1 }
|
212
|
+
end
|
213
|
+
|
214
|
+
receive_elements_with_rid(current_rid, res_body.children)
|
215
|
+
ensure_one_pending_request
|
216
|
+
|
217
|
+
rescue REXML::ParseException
|
218
|
+
if @exception_block
|
219
|
+
Thread.new do
|
220
|
+
Thread.current.abort_on_exception = true
|
221
|
+
close; @exception_block.call(e, self, :parser)
|
222
|
+
end
|
223
|
+
else
|
224
|
+
Jabber::debuglog "Exception caught when parsing HTTP response!"
|
225
|
+
close
|
226
|
+
raise
|
227
|
+
end
|
228
|
+
|
229
|
+
rescue StandardError => e
|
230
|
+
Jabber::debuglog("POST error (will retry): #{e.class}: #{e}")
|
231
|
+
receive_elements_with_rid(current_rid, [])
|
232
|
+
# It's not good to resend on *any* exception,
|
233
|
+
# but there are too many cases (Timeout, 404, 502)
|
234
|
+
# where resending is appropriate
|
235
|
+
# TODO: recognize these conditions and act appropriate
|
236
|
+
send_data(data)
|
237
|
+
end
|
238
|
+
end
|
239
|
+
|
240
|
+
##
|
241
|
+
# Send data,
|
242
|
+
# buffered and obeying 'polling' and 'requests' limits
|
243
|
+
def send_data(data)
|
244
|
+
@lock.synchronize do
|
245
|
+
|
246
|
+
@send_buffer += data
|
247
|
+
limited_by_polling = (@last_send + @http_polling >= Time.now)
|
248
|
+
limited_by_requests = (@pending_requests + 1 > @http_requests)
|
249
|
+
|
250
|
+
# Can we send?
|
251
|
+
if !limited_by_polling and !limited_by_requests
|
252
|
+
data = @send_buffer
|
253
|
+
@send_buffer = ''
|
254
|
+
|
255
|
+
Thread.new do
|
256
|
+
Thread.current.abort_on_exception = true
|
257
|
+
post_data(data)
|
258
|
+
end
|
259
|
+
|
260
|
+
elsif !limited_by_requests
|
261
|
+
Thread.new do
|
262
|
+
Thread.current.abort_on_exception = true
|
263
|
+
# Defer until @http_polling has expired
|
264
|
+
wait = @last_send + @http_polling - Time.now
|
265
|
+
sleep(wait) if wait > 0
|
266
|
+
# Ignore locking, it's already threaded ;-)
|
267
|
+
send_data('')
|
268
|
+
end
|
269
|
+
end
|
270
|
+
|
271
|
+
end
|
272
|
+
end
|
273
|
+
end
|
274
|
+
end
|
275
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# =XMPP4R - XMPP Library for Ruby
|
2
|
+
# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
|
3
|
+
# Website::http://home.gna.org/xmpp4r/
|
4
|
+
|
5
|
+
require 'singleton'
|
6
|
+
|
7
|
+
module Jabber
|
8
|
+
##
|
9
|
+
# The Jabber::IdGenerator class generates unique IDs for use
|
10
|
+
# in XMMP stanzas. Jabber::IdGenerator includes the Singleton
|
11
|
+
# Mixin, usage as following:
|
12
|
+
# Jabber::IdGenerator.generate_id
|
13
|
+
# => "23"
|
14
|
+
class IdGenerator
|
15
|
+
include Singleton
|
16
|
+
|
17
|
+
def initialize
|
18
|
+
@last_id = 0
|
19
|
+
end
|
20
|
+
|
21
|
+
##
|
22
|
+
# Generate an unique ID.
|
23
|
+
#
|
24
|
+
# This is kind of boring this way, as it just counts up
|
25
|
+
# a number. Maybe something more random somewhen...
|
26
|
+
def IdGenerator.generate_id
|
27
|
+
IdGenerator.instance.generate_id
|
28
|
+
end
|
29
|
+
|
30
|
+
def generate_id
|
31
|
+
@last_id += 1
|
32
|
+
timefrac = Time.new.to_f.to_s.split(/\./, 2).last[-3..-1]
|
33
|
+
|
34
|
+
"#{@last_id}#{timefrac}"
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|