gmcmillan-xmpp4r 0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (215) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG +91 -0
  3. data/COPYING +340 -0
  4. data/LICENSE +59 -0
  5. data/README.rdoc +122 -0
  6. data/README_ruby19.txt +43 -0
  7. data/Rakefile +258 -0
  8. data/data/doc/xmpp4r/examples/advanced/adventure/README +56 -0
  9. data/data/doc/xmpp4r/examples/advanced/adventure/adventure.rb +23 -0
  10. data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb +136 -0
  11. data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml +15 -0
  12. data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml +69 -0
  13. data/data/doc/xmpp4r/examples/advanced/adventure/world.rb +424 -0
  14. data/data/doc/xmpp4r/examples/advanced/fileserve.conf +11 -0
  15. data/data/doc/xmpp4r/examples/advanced/fileserve.rb +346 -0
  16. data/data/doc/xmpp4r/examples/advanced/getonline.rb +56 -0
  17. data/data/doc/xmpp4r/examples/advanced/gtkmucclient.rb +315 -0
  18. data/data/doc/xmpp4r/examples/advanced/migrate.rb +88 -0
  19. data/data/doc/xmpp4r/examples/advanced/minimuc.rb +266 -0
  20. data/data/doc/xmpp4r/examples/advanced/pep-aggregator/index.xsl +235 -0
  21. data/data/doc/xmpp4r/examples/advanced/pep-aggregator/pep-aggregator.rb +147 -0
  22. data/data/doc/xmpp4r/examples/advanced/recvfile.rb +85 -0
  23. data/data/doc/xmpp4r/examples/advanced/rosterdiscovery.rb +129 -0
  24. data/data/doc/xmpp4r/examples/advanced/sendfile.conf +10 -0
  25. data/data/doc/xmpp4r/examples/advanced/sendfile.rb +72 -0
  26. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr.rb +51 -0
  27. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_jabber.rb +43 -0
  28. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_test.rb +10 -0
  29. data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +109 -0
  30. data/data/doc/xmpp4r/examples/advanced/xmpping.rb +146 -0
  31. data/data/doc/xmpp4r/examples/advanced/xmppingrc.sample +14 -0
  32. data/data/doc/xmpp4r/examples/basic/change_password.rb +41 -0
  33. data/data/doc/xmpp4r/examples/basic/client.rb +70 -0
  34. data/data/doc/xmpp4r/examples/basic/component.rb +11 -0
  35. data/data/doc/xmpp4r/examples/basic/echo.rb +37 -0
  36. data/data/doc/xmpp4r/examples/basic/jabbersend.rb +41 -0
  37. data/data/doc/xmpp4r/examples/basic/mass_sender.rb +68 -0
  38. data/data/doc/xmpp4r/examples/basic/muc_owner_config.rb +12 -0
  39. data/data/doc/xmpp4r/examples/basic/mucinfo.rb +41 -0
  40. data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb +82 -0
  41. data/data/doc/xmpp4r/examples/basic/register.rb +42 -0
  42. data/data/doc/xmpp4r/examples/basic/remove_registration.rb +18 -0
  43. data/data/doc/xmpp4r/examples/basic/roster.rb +44 -0
  44. data/data/doc/xmpp4r/examples/basic/rosterprint.rb +50 -0
  45. data/data/doc/xmpp4r/examples/basic/rosterrename.rb +34 -0
  46. data/data/doc/xmpp4r/examples/basic/rosterwatch.rb +171 -0
  47. data/data/doc/xmpp4r/examples/basic/send_vcard.rb +67 -0
  48. data/data/doc/xmpp4r/examples/basic/tune_client.rb +56 -0
  49. data/data/doc/xmpp4r/examples/basic/tune_server.rb +58 -0
  50. data/data/doc/xmpp4r/examples/basic/versionbot.rb +75 -0
  51. data/lib/xmpp4r.rb +118 -0
  52. data/lib/xmpp4r/base64.rb +32 -0
  53. data/lib/xmpp4r/bytestreams.rb +15 -0
  54. data/lib/xmpp4r/bytestreams/helper/filetransfer.rb +321 -0
  55. data/lib/xmpp4r/bytestreams/helper/ibb/base.rb +257 -0
  56. data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb +31 -0
  57. data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +54 -0
  58. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb +153 -0
  59. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb +86 -0
  60. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb +198 -0
  61. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb +65 -0
  62. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +82 -0
  63. data/lib/xmpp4r/bytestreams/iq/bytestreams.rb +170 -0
  64. data/lib/xmpp4r/bytestreams/iq/si.rb +206 -0
  65. data/lib/xmpp4r/callbacks.rb +133 -0
  66. data/lib/xmpp4r/caps.rb +1 -0
  67. data/lib/xmpp4r/caps/c.rb +67 -0
  68. data/lib/xmpp4r/caps/helper/generator.rb +160 -0
  69. data/lib/xmpp4r/caps/helper/helper.rb +84 -0
  70. data/lib/xmpp4r/client.rb +345 -0
  71. data/lib/xmpp4r/command/helper/responder.rb +53 -0
  72. data/lib/xmpp4r/command/iq/command.rb +154 -0
  73. data/lib/xmpp4r/component.rb +103 -0
  74. data/lib/xmpp4r/connection.rb +231 -0
  75. data/lib/xmpp4r/dataforms.rb +5 -0
  76. data/lib/xmpp4r/dataforms/x/data.rb +297 -0
  77. data/lib/xmpp4r/debuglog.rb +63 -0
  78. data/lib/xmpp4r/delay.rb +5 -0
  79. data/lib/xmpp4r/delay/x/delay.rb +99 -0
  80. data/lib/xmpp4r/discovery.rb +8 -0
  81. data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
  82. data/lib/xmpp4r/discovery/helper/responder.rb +165 -0
  83. data/lib/xmpp4r/discovery/iq/discoinfo.rb +211 -0
  84. data/lib/xmpp4r/discovery/iq/discoitems.rb +147 -0
  85. data/lib/xmpp4r/entity_time.rb +6 -0
  86. data/lib/xmpp4r/entity_time/iq.rb +45 -0
  87. data/lib/xmpp4r/entity_time/responder.rb +57 -0
  88. data/lib/xmpp4r/errors.rb +284 -0
  89. data/lib/xmpp4r/feature_negotiation.rb +5 -0
  90. data/lib/xmpp4r/feature_negotiation/iq/feature.rb +28 -0
  91. data/lib/xmpp4r/framework/base.rb +55 -0
  92. data/lib/xmpp4r/framework/bot.rb +148 -0
  93. data/lib/xmpp4r/httpbinding.rb +5 -0
  94. data/lib/xmpp4r/httpbinding/client.rb +275 -0
  95. data/lib/xmpp4r/idgenerator.rb +37 -0
  96. data/lib/xmpp4r/iq.rb +221 -0
  97. data/lib/xmpp4r/jid.rb +167 -0
  98. data/lib/xmpp4r/last.rb +2 -0
  99. data/lib/xmpp4r/last/helper/helper.rb +37 -0
  100. data/lib/xmpp4r/last/iq/last.rb +67 -0
  101. data/lib/xmpp4r/location.rb +2 -0
  102. data/lib/xmpp4r/location/helper/helper.rb +56 -0
  103. data/lib/xmpp4r/location/location.rb +179 -0
  104. data/lib/xmpp4r/message.rb +226 -0
  105. data/lib/xmpp4r/muc.rb +14 -0
  106. data/lib/xmpp4r/muc/helper/mucbrowser.rb +92 -0
  107. data/lib/xmpp4r/muc/helper/mucclient.rb +469 -0
  108. data/lib/xmpp4r/muc/helper/simplemucclient.rb +332 -0
  109. data/lib/xmpp4r/muc/iq/mucadmin.rb +23 -0
  110. data/lib/xmpp4r/muc/iq/mucadminitem.rb +20 -0
  111. data/lib/xmpp4r/muc/iq/mucowner.rb +15 -0
  112. data/lib/xmpp4r/muc/item.rb +143 -0
  113. data/lib/xmpp4r/muc/x/muc.rb +70 -0
  114. data/lib/xmpp4r/muc/x/mucuserinvite.rb +60 -0
  115. data/lib/xmpp4r/muc/x/mucuseritem.rb +36 -0
  116. data/lib/xmpp4r/presence.rb +232 -0
  117. data/lib/xmpp4r/pubsub.rb +8 -0
  118. data/lib/xmpp4r/pubsub/children/configuration.rb +86 -0
  119. data/lib/xmpp4r/pubsub/children/event.rb +49 -0
  120. data/lib/xmpp4r/pubsub/children/item.rb +35 -0
  121. data/lib/xmpp4r/pubsub/children/items.rb +53 -0
  122. data/lib/xmpp4r/pubsub/children/node_config.rb +48 -0
  123. data/lib/xmpp4r/pubsub/children/publish.rb +38 -0
  124. data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
  125. data/lib/xmpp4r/pubsub/children/subscription.rb +62 -0
  126. data/lib/xmpp4r/pubsub/children/subscription_config.rb +67 -0
  127. data/lib/xmpp4r/pubsub/children/unsubscribe.rb +63 -0
  128. data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +129 -0
  129. data/lib/xmpp4r/pubsub/helper/nodehelper.rb +156 -0
  130. data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +90 -0
  131. data/lib/xmpp4r/pubsub/helper/servicehelper.rb +490 -0
  132. data/lib/xmpp4r/pubsub/iq/pubsub.rb +19 -0
  133. data/lib/xmpp4r/query.rb +15 -0
  134. data/lib/xmpp4r/reliable.rb +168 -0
  135. data/lib/xmpp4r/rexmladdons.rb +197 -0
  136. data/lib/xmpp4r/roster.rb +7 -0
  137. data/lib/xmpp4r/roster/helper/roster.rb +532 -0
  138. data/lib/xmpp4r/roster/iq/roster.rb +215 -0
  139. data/lib/xmpp4r/roster/x/roster.rb +138 -0
  140. data/lib/xmpp4r/rpc.rb +2 -0
  141. data/lib/xmpp4r/rpc/helper/client.rb +123 -0
  142. data/lib/xmpp4r/rpc/helper/server.rb +74 -0
  143. data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb +67 -0
  144. data/lib/xmpp4r/rpc/iq/rpc.rb +23 -0
  145. data/lib/xmpp4r/sasl.rb +259 -0
  146. data/lib/xmpp4r/semaphore.rb +38 -0
  147. data/lib/xmpp4r/stream.rb +611 -0
  148. data/lib/xmpp4r/streamparser.rb +66 -0
  149. data/lib/xmpp4r/test/listener_mocker.rb +118 -0
  150. data/lib/xmpp4r/tune.rb +2 -0
  151. data/lib/xmpp4r/tune/helper/helper.rb +58 -0
  152. data/lib/xmpp4r/tune/tune.rb +113 -0
  153. data/lib/xmpp4r/vcard.rb +6 -0
  154. data/lib/xmpp4r/vcard/helper/vcard.rb +84 -0
  155. data/lib/xmpp4r/vcard/iq/vcard.rb +109 -0
  156. data/lib/xmpp4r/version.rb +7 -0
  157. data/lib/xmpp4r/version/helper/responder.rb +72 -0
  158. data/lib/xmpp4r/version/helper/simpleresponder.rb +44 -0
  159. data/lib/xmpp4r/version/iq/version.rb +105 -0
  160. data/lib/xmpp4r/x.rb +37 -0
  161. data/lib/xmpp4r/xhtml.rb +1 -0
  162. data/lib/xmpp4r/xhtml/html.rb +115 -0
  163. data/lib/xmpp4r/xmpp4r.rb +20 -0
  164. data/lib/xmpp4r/xmppelement.rb +168 -0
  165. data/lib/xmpp4r/xmppstanza.rb +162 -0
  166. data/setup.rb +1586 -0
  167. data/test/bytestreams/tc_ibb.rb +188 -0
  168. data/test/bytestreams/tc_socks5bytestreams.rb +114 -0
  169. data/test/caps/tc_helper.rb +158 -0
  170. data/test/dataforms/tc_data.rb +81 -0
  171. data/test/delay/tc_xdelay.rb +51 -0
  172. data/test/discovery/tc_responder.rb +91 -0
  173. data/test/entity_time/tc_responder.rb +65 -0
  174. data/test/last/tc_helper.rb +75 -0
  175. data/test/lib/assert_equal_xml.rb +14 -0
  176. data/test/lib/clienttester.rb +149 -0
  177. data/test/muc/tc_muc_mucclient.rb +834 -0
  178. data/test/muc/tc_muc_simplemucclient.rb +114 -0
  179. data/test/muc/tc_mucowner.rb +50 -0
  180. data/test/pubsub/tc_helper.rb +785 -0
  181. data/test/pubsub/tc_nodeconfig.rb +61 -0
  182. data/test/pubsub/tc_subscriptionconfig.rb +41 -0
  183. data/test/roster/tc_helper.rb +523 -0
  184. data/test/roster/tc_iqqueryroster.rb +173 -0
  185. data/test/roster/tc_xroster.rb +73 -0
  186. data/test/rpc/tc_helper.rb +96 -0
  187. data/test/tc_callbacks.rb +129 -0
  188. data/test/tc_class_names.rb +146 -0
  189. data/test/tc_client.rb +30 -0
  190. data/test/tc_errors.rb +146 -0
  191. data/test/tc_idgenerator.rb +30 -0
  192. data/test/tc_iq.rb +113 -0
  193. data/test/tc_iqquery.rb +31 -0
  194. data/test/tc_jid.rb +204 -0
  195. data/test/tc_presence.rb +150 -0
  196. data/test/tc_rexml.rb +139 -0
  197. data/test/tc_stream.rb +193 -0
  198. data/test/tc_streamComponent.rb +105 -0
  199. data/test/tc_streamError.rb +129 -0
  200. data/test/tc_streamSend.rb +59 -0
  201. data/test/tc_streamparser.rb +137 -0
  202. data/test/tc_xmppstanza.rb +135 -0
  203. data/test/ts_xmpp4r.rb +44 -0
  204. data/test/tune/tc_helper_recv.rb +82 -0
  205. data/test/tune/tc_helper_send.rb +74 -0
  206. data/test/tune/tc_tune.rb +79 -0
  207. data/test/vcard/tc_helper.rb +49 -0
  208. data/test/vcard/tc_iqvcard.rb +62 -0
  209. data/test/version/tc_helper.rb +60 -0
  210. data/test/version/tc_iqqueryversion.rb +97 -0
  211. data/test/xhtml/tc_html.rb +41 -0
  212. data/tools/gen_requires.bash +31 -0
  213. data/tools/xmpp4r-gemspec-test.rb +11 -0
  214. data/xmpp4r.gemspec +249 -0
  215. metadata +299 -0
@@ -0,0 +1,257 @@
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 'xmpp4r/base64'
6
+
7
+ module Jabber
8
+ module Bytestreams
9
+ ##
10
+ # In-Band Bytestreams (JEP-0047) implementation
11
+ #
12
+ # Don't use directly, use IBBInitiator and IBBTarget
13
+ #
14
+ # In-Band Bytestreams should only be used when transferring
15
+ # very small amounts of binary data, because it is slow and
16
+ # increases server load drastically.
17
+ #
18
+ # Note that the constructor takes a lot of arguments. In-Band
19
+ # Bytestreams do not specify a way to initiate the stream,
20
+ # this should be done via Stream Initiation.
21
+ class IBB
22
+ NS_IBB = 'http://jabber.org/protocol/ibb'
23
+
24
+ ##
25
+ # Create a new bytestream
26
+ #
27
+ # Will register a <message/> callback to intercept data
28
+ # of this stream. This data will be buffered, you can retrieve
29
+ # it with receive
30
+ def initialize(stream, session_id, my_jid, peer_jid)
31
+ @stream = stream
32
+ @session_id = session_id
33
+ @my_jid = (my_jid.kind_of?(String) ? JID.new(my_jid) : my_jid)
34
+ @peer_jid = (peer_jid.kind_of?(String) ? JID.new(peer_jid) : peer_jid)
35
+
36
+ @active = false
37
+ @seq_send = 0
38
+ @seq_recv = 0
39
+ @queue = []
40
+ @queue_lock = Mutex.new
41
+ @pending = Semaphore.new
42
+ @sendbuf = ''
43
+ @sendbuf_lock = Mutex.new
44
+
45
+ @block_size = 4096 # Recommended by JEP0047
46
+ end
47
+
48
+ def active?
49
+ @active
50
+ end
51
+
52
+ ##
53
+ # Send data
54
+ #
55
+ # Data is buffered to match block_size in each packet.
56
+ # If you need the data to be sent immediately, use
57
+ # flush afterwards.
58
+ # buf:: [String]
59
+ def write(buf)
60
+ @sendbuf_lock.synchronize {
61
+ @sendbuf += buf
62
+
63
+ while @sendbuf.size >= @block_size
64
+ send_data(@sendbuf[0..@block_size-1])
65
+ @sendbuf = @sendbuf[@block_size..-1].to_s
66
+ end
67
+ }
68
+ end
69
+
70
+ ##
71
+ # Empty the send-buffer by sending remaining data
72
+ def flush
73
+ @sendbuf_lock.synchronize {
74
+ while @sendbuf.size > 0
75
+ send_data(@sendbuf[0..@block_size-1])
76
+ @sendbuf = @sendbuf[@block_size..-1].to_s
77
+ end
78
+ }
79
+ end
80
+
81
+ ##
82
+ # Receive data
83
+ #
84
+ # Will wait until the Message with the next sequence number
85
+ # is in the stanza queue.
86
+ def read
87
+ if active?
88
+ res = nil
89
+
90
+ while res.nil?
91
+ @queue_lock.synchronize {
92
+ @queue.each { |item|
93
+ # Find next data
94
+ if item.type == :data and item.seq == @seq_recv.to_s
95
+ res = item
96
+ break
97
+ # No data? Find close
98
+ elsif item.type == :close and res.nil?
99
+ res = item
100
+ end
101
+ }
102
+
103
+ @queue.delete_if { |item| item == res }
104
+ }
105
+
106
+ # No data? Wait for next to arrive...
107
+ @pending.wait unless res
108
+ end
109
+
110
+ if res.type == :data
111
+ @seq_recv += 1
112
+ @seq_recv = 0 if @seq_recv > 65535
113
+ res.data
114
+ elsif res.type == :close
115
+ deactivate
116
+ nil # Closed
117
+ end
118
+ else
119
+ nil
120
+ end
121
+ end
122
+
123
+ ##
124
+ # Close the stream
125
+ #
126
+ # Waits for acknowledge from peer,
127
+ # may throw ServerError
128
+ def close
129
+ if active?
130
+ flush
131
+ deactivate
132
+
133
+ iq = Iq.new(:set, @peer_jid)
134
+ close = iq.add REXML::Element.new('close')
135
+ close.add_namespace IBB::NS_IBB
136
+ close.attributes['sid'] = @session_id
137
+
138
+ @stream.send_with_id(iq)
139
+ end
140
+ end
141
+
142
+ private
143
+
144
+ ##
145
+ # Send data directly
146
+ # data:: [String]
147
+ def send_data(databuf)
148
+ if active?
149
+ msg = Message.new
150
+ msg.from = @my_jid
151
+ msg.to = @peer_jid
152
+
153
+ data = msg.add REXML::Element.new('data')
154
+ data.add_namespace NS_IBB
155
+ data.attributes['sid'] = @session_id
156
+ data.attributes['seq'] = @seq_send.to_s
157
+ data.text = Base64::encode64(databuf)
158
+
159
+ # TODO: Implement AMP correctly
160
+ amp = msg.add REXML::Element.new('amp')
161
+ amp.add_namespace 'http://jabber.org/protocol/amp'
162
+ deliver_at = amp.add REXML::Element.new('rule')
163
+ deliver_at.attributes['condition'] = 'deliver-at'
164
+ deliver_at.attributes['value'] = 'stored'
165
+ deliver_at.attributes['action'] = 'error'
166
+ match_resource = amp.add REXML::Element.new('rule')
167
+ match_resource.attributes['condition'] = 'match-resource'
168
+ match_resource.attributes['value'] = 'exact'
169
+ match_resource.attributes['action'] = 'error'
170
+
171
+ @stream.send(msg)
172
+
173
+ @seq_send += 1
174
+ @seq_send = 0 if @seq_send > 65535
175
+ else
176
+ raise 'Attempt to send data when not activated'
177
+ end
178
+ end
179
+
180
+ def activate
181
+ unless active?
182
+ @stream.add_message_callback(200, self) { |msg|
183
+ data = msg.first_element('data')
184
+ if msg.from == @peer_jid and msg.to == @my_jid and data and data.attributes['sid'] == @session_id
185
+ if msg.type == nil
186
+ @queue_lock.synchronize {
187
+ @queue.push IBBQueueItem.new(:data, data.attributes['seq'], data.text.to_s)
188
+ @pending.run
189
+ }
190
+ elsif msg.type == :error
191
+ @queue_lock.synchronize {
192
+ @queue << IBBQueueItem.new(:close)
193
+ @pending.run
194
+ }
195
+ end
196
+ true
197
+ else
198
+ false
199
+ end
200
+ }
201
+
202
+ @stream.add_iq_callback(200, self) { |iq|
203
+ close = iq.first_element('close')
204
+ if iq.type == :set and close and close.attributes['sid'] == @session_id
205
+ answer = iq.answer(false)
206
+ answer.type = :result
207
+ @stream.send(answer)
208
+
209
+ @queue_lock.synchronize {
210
+ @queue << IBBQueueItem.new(:close)
211
+ @pending.run
212
+ }
213
+ true
214
+ else
215
+ false
216
+ end
217
+ }
218
+
219
+ @active = true
220
+ end
221
+ end
222
+
223
+ def deactivate
224
+ if active?
225
+ @stream.delete_message_callback(self)
226
+ @stream.delete_iq_callback(self)
227
+
228
+ @active = false
229
+ end
230
+ end
231
+ end
232
+
233
+ ##
234
+ # Represents an item in the internal data queue
235
+ class IBBQueueItem
236
+ attr_reader :type, :seq
237
+ def initialize(type, seq=nil, data_text='')
238
+ unless [:data, :close].include? type
239
+ raise "Unknown IBBQueueItem type: #{type}"
240
+ end
241
+
242
+ @type = type
243
+ @seq = seq
244
+ @data = data_text
245
+ end
246
+
247
+ ##
248
+ # Return the Base64-*decoded* data
249
+ #
250
+ # There's no need to catch Exceptions here,
251
+ # as none are thrown.
252
+ def data
253
+ Base64::decode64(@data)
254
+ end
255
+ end
256
+ end
257
+ end
@@ -0,0 +1,31 @@
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
+ module Jabber
6
+ module Bytestreams
7
+ ##
8
+ # Implementation of IBB at the initiator side
9
+ class IBBInitiator < IBB
10
+ # You may set the block-size before open
11
+ attr_accessor :block_size
12
+
13
+ ##
14
+ # Open the stream to the peer,
15
+ # waits for successful result
16
+ #
17
+ # May throw ServerError
18
+ def open
19
+ iq = Iq.new(:set, @peer_jid)
20
+ open = iq.add REXML::Element.new('open')
21
+ open.add_namespace IBB::NS_IBB
22
+ open.attributes['sid'] = @session_id
23
+ open.attributes['block-size'] = @block_size.to_s
24
+
25
+ @stream.send_with_id(iq)
26
+
27
+ activate
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,54 @@
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
+ module Jabber
6
+ module Bytestreams
7
+ ##
8
+ # Implementation of IBB at the target side
9
+ class IBBTarget < IBB
10
+ # You may read the block-size after accept
11
+ attr_reader :block_size
12
+
13
+ def initialize(stream, session_id, initiator_jid, target_jid)
14
+ # Target and Initiator are swapped here, because we're the target
15
+ super(stream, session_id, target_jid, initiator_jid)
16
+ @accept_ready = Semaphore::new
17
+ end
18
+
19
+ def accept_wait
20
+ @accept_ready.wait
21
+ end
22
+
23
+ ##
24
+ # Wait for the initiator side to start
25
+ # the stream.
26
+ def accept
27
+ connect_sem = Semaphore.new
28
+
29
+ @stream.add_iq_callback(200, self) { |iq|
30
+ open = iq.first_element('open')
31
+ if iq.type == :set and iq.from == @peer_jid and iq.to == @my_jid and open and open.attributes['sid'] == @session_id
32
+ @stream.delete_iq_callback(self)
33
+ activate
34
+ @block_size = (open.attributes['block-size'] || 4096).to_i
35
+
36
+ reply = iq.answer(false)
37
+ reply.type = :result
38
+ @stream.send(reply)
39
+
40
+ connect_sem.run
41
+ true
42
+ else
43
+ false
44
+ end
45
+ }
46
+
47
+ @accept_ready.run
48
+
49
+ connect_sem.wait
50
+ true
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,153 @@
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 'socket'
6
+ require 'thread'
7
+ require 'timeout'
8
+ require 'digest/sha1'
9
+
10
+ require 'xmpp4r/callbacks'
11
+ require 'xmpp4r/bytestreams/helper/socks5bytestreams/socks5'
12
+
13
+ module Jabber
14
+ module Bytestreams
15
+ ##
16
+ # SOCKS5 Bytestreams (JEP-0065) implementation
17
+ #
18
+ # Don't use directly, use SOCKS5BytestreamsInitiator
19
+ # and SOCKS5BytestreamsTarget
20
+ class SOCKS5Bytestreams
21
+ ##
22
+ # [StreamHost] the SOCKS connection is using
23
+ attr_reader :streamhost_used
24
+
25
+ ##
26
+ # SOCKS connection timeout (for trying multiple streamhosts)
27
+ #
28
+ # default: nil, use the OS' default timeout
29
+ attr_accessor :connect_timeout
30
+
31
+ def initialize(stream, session_id, initiator_jid, target_jid)
32
+ @stream = stream
33
+ @session_id = session_id
34
+ @initiator_jid = (initiator_jid.kind_of?(String) ? JID.new(initiator_jid) : initiator_jid)
35
+ @target_jid = (target_jid.kind_of?(String) ? JID.new(target_jid) : target_jid)
36
+ @socks = nil
37
+ @connect_timeout = nil
38
+ @streamhost_used = nil
39
+ @streamhost_cbs = CallbackList.new
40
+ end
41
+
42
+ ##
43
+ # Add a callback that will be called when there is action regarding
44
+ # SOCKS stream-hosts
45
+ #
46
+ # Usage of this callback is optional and serves informational purposes only.
47
+ #
48
+ # block takes three arguments:
49
+ # * The StreamHost instance that is currently being tried
50
+ # * State information (is either :connecting, :authenticating, :success or :failure)
51
+ # * The exception value for the state :failure, else nil
52
+ def add_streamhost_callback(priority = 0, ref = nil, &block)
53
+ @streamhost_cbs.add(priority, ref, block)
54
+ end
55
+
56
+ ##
57
+ # Receive from the stream-host
58
+ # length:: [Fixnum] Amount of bytes (Will be passed to TCPSocket#read for the underlying SOCKS5 connection)
59
+ # result:: [String] (or [nil] if finished)
60
+ def read(length=nil)
61
+ @socks.read(length)
62
+ end
63
+
64
+ ##
65
+ # Flush the SOCKS5 socket
66
+ def flush
67
+ @socks.flush
68
+ end
69
+
70
+ ##
71
+ # Send to the stream-host
72
+ # buf:: [String] Data
73
+ # result:: [Fixnum] Amount of bytes sent
74
+ def write(buf)
75
+ @socks.write(buf)
76
+ # FIXME: On FreeBSD this throws Errno::EPERM after it has already written a few
77
+ # kilobytes, and when there are multiple sockets. ktrace told, that this originates
78
+ # from the syscall, not ruby.
79
+ end
80
+
81
+ ##
82
+ # Close the stream-host connection
83
+ def close
84
+ @socks.close
85
+ end
86
+
87
+ ##
88
+ # Query a JID for its stream-host information
89
+ #
90
+ # SOCKS5BytestreamsInitiator#add_streamhost can do this for you.
91
+ # Use this method if you plan to do multiple transfers, so
92
+ # you can cache the result.
93
+ # stream:: [Stream] to operate on
94
+ # streamhost:: [JID] of the proxy
95
+ # my_jid:: [JID] Optional sender JID for Component operation
96
+ def self.query_streamhost(stream, streamhost, my_jid=nil)
97
+ res = nil
98
+
99
+ iq = Iq.new(:get, streamhost)
100
+ iq.from = my_jid
101
+ iq.add(IqQueryBytestreams.new)
102
+ stream.send_with_id(iq) { |reply|
103
+ reply.query.each_element { |e|
104
+ if e.kind_of?(StreamHost)
105
+ e.jid = reply.from # Help misconfigured proxys
106
+ res = e
107
+ end
108
+ }
109
+ }
110
+
111
+ if res and res.jid and res.host and res.port
112
+ res
113
+ else
114
+ nil
115
+ end
116
+ end
117
+
118
+ private
119
+
120
+ ##
121
+ # The address the stream-host expects from us.
122
+ # According to JEP-0096 this is the SHA1 hash
123
+ # of the concatenation of session_id,
124
+ # initiator_jid and target_jid.
125
+ # result:: [String] SHA1 hash
126
+ def stream_address
127
+ Digest::SHA1.hexdigest("#{@session_id}#{@initiator_jid}#{@target_jid}")
128
+ end
129
+
130
+ ##
131
+ # Try a streamhost
132
+ # result:: [SOCKS5Socket]
133
+ def connect_socks(streamhost)
134
+ Timeout::timeout(@connect_timeout, Errno::ETIMEDOUT) {
135
+ Jabber::debuglog("SOCKS5 Bytestreams: connecting to proxy #{streamhost.jid} (#{streamhost.host}:#{streamhost.port})")
136
+ @streamhost_cbs.process(streamhost, :connecting, nil)
137
+ socks = SOCKS5Socket.new(streamhost.host, streamhost.port)
138
+
139
+ Jabber::debuglog("SOCKS5 Bytestreams: connected, authenticating")
140
+ @streamhost_cbs.process(streamhost, :authenticating, nil)
141
+ socks.auth
142
+
143
+ socks.connect_domain(stream_address, 0)
144
+
145
+ Jabber::debuglog("SOCKS5 Bytestreams: connected")
146
+ @streamhost_cbs.process(streamhost, :success, nil)
147
+
148
+ socks
149
+ }
150
+ end
151
+ end
152
+ end
153
+ end