1 package OpenSRF::Transport::SlimJabber::XMPPReader;
2 use strict; use warnings;
4 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
5 use Time::HiRes qw/time/;
6 use OpenSRF::Transport::SlimJabber::XMPPMessage;
7 use OpenSRF::Utils::Logger qw/$logger/;
10 # -----------------------------------------------------------
11 # Connect, disconnect, and authentication messsage templates
12 # -----------------------------------------------------------
13 use constant JABBER_CONNECT =>
14 "<stream:stream to='%s' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>";
16 use constant JABBER_BASIC_AUTH =>
17 "<iq id='123' type='set'><query xmlns='jabber:iq:auth'>" .
18 "<username>%s</username><password>%s</password><resource>%s</resource></query></iq>";
20 use constant JABBER_DISCONNECT => "</stream:stream>";
23 # -----------------------------------------------------------
25 # -----------------------------------------------------------
26 use constant DISCONNECTED => 1;
27 use constant CONNECT_RECV => 2;
28 use constant CONNECTED => 3;
31 # -----------------------------------------------------------
33 # -----------------------------------------------------------
34 use constant IN_NOTHING => 1;
35 use constant IN_BODY => 2;
36 use constant IN_THREAD => 3;
37 use constant IN_STATUS => 4;
40 # -----------------------------------------------------------
41 # Constructor, getter/setters
42 # -----------------------------------------------------------
47 my $self = bless({}, $class);
50 $self->{stream_state} = DISCONNECTED;
51 $self->{xml_state} = IN_NOTHING;
52 $self->socket($socket);
54 my $p = new XML::Parser(Handlers => {
55 Start => \&start_element,
60 $self->parser($p->parse_start); # create a push parser
61 $self->parser->{_parent_} = $self;
62 $self->{message} = OpenSRF::Transport::SlimJabber::XMPPMessage->new;
68 push(@{$self->{queue}}, $msg) if $msg;
73 return shift @{$self->{queue}};
78 return (@{$self->{queue}} > 0);
82 my($self, $parser) = @_;
83 $self->{parser} = $parser if $parser;
84 return $self->{parser};
88 my($self, $socket) = @_;
89 $self->{socket} = $socket if $socket;
90 return $self->{socket};
94 my($self, $stream_state) = @_;
95 $self->{stream_state} = $stream_state if $stream_state;
96 return $self->{stream_state};
100 my($self, $xml_state) = @_;
101 $self->{xml_state} = $xml_state if $xml_state;
102 return $self->{xml_state};
106 my($self, $message) = @_;
107 $self->{message} = $message if $message;
108 return $self->{message};
112 # -----------------------------------------------------------
113 # Stream and connection handling methods
114 # -----------------------------------------------------------
117 my($self, $domain, $username, $password, $resource) = @_;
119 $self->send(sprintf(JABBER_CONNECT, $domain));
122 unless($self->{stream_state} == CONNECT_RECV) {
123 $logger->error("No initial XMPP response from server");
127 $self->send(sprintf(JABBER_BASIC_AUTH, $username, $password, $resource));
130 unless($self->connected) {
131 $logger->error('XMPP connect failed');
140 return unless $self->socket;
141 if($self->tcp_connected) {
142 $self->send(JABBER_DISCONNECT);
143 shutdown($self->socket, 2);
145 close($self->socket);
148 # -----------------------------------------------------------
149 # returns true if this stream is connected to the server
150 # -----------------------------------------------------------
153 return ($self->tcp_connected and $self->{stream_state} == CONNECTED);
156 # -----------------------------------------------------------
157 # returns true if the socket is connected
158 # -----------------------------------------------------------
161 return ($self->socket and $self->socket->connected);
164 # -----------------------------------------------------------
165 # sends pre-formated XML
166 # -----------------------------------------------------------
168 my($self, $xml) = @_;
169 $self->{socket}->print($xml);
172 # -----------------------------------------------------------
173 # Puts a file handle into blocking mode
174 # -----------------------------------------------------------
177 my $flags = fcntl($fh, F_GETFL, 0);
178 $flags &= ~O_NONBLOCK;
179 fcntl($fh, F_SETFL, $flags);
183 # -----------------------------------------------------------
184 # Puts a file handle into non-blocking mode
185 # -----------------------------------------------------------
188 my $flags = fcntl($fh, F_GETFL, 0);
189 fcntl($fh, F_SETFL, $flags | O_NONBLOCK);
194 my($self, $timeout) = @_;
196 return $self->next_msg if $self->peek_msg;
199 $timeout = undef if $timeout < 0;
200 my $socket = $self->{socket};
204 # build the select readset
206 vec($infile, $socket->fileno, 1) = 1;
208 my $nfound = select($infile, undef, undef, $timeout);
209 return undef if !$nfound or $nfound == -1;
211 # now slurp the data off the socket
213 my $read_size = 1024;
218 while($nbytes = sysread($socket, $buf, $read_size)) {
219 $self->{parser}->parse_more($buf) if $buf;
220 if($nbytes < $read_size or $self->peek_msg) {
221 set_block($socket) if $nonblock;
224 set_nonblock($socket) unless $nonblock;
229 if ($first_read and defined $nbytes and $nbytes == 0) {
230 # if the first read on an active socket is 0 bytes,
231 # the socket has been disconnected from the remote end.
232 $self->{stream_state} = DISCONNECTED;
233 $logger->error("Disconnected from Jabber server");
234 throw OpenSRF::EX::Jabber("Disconnected from Jabber server");
237 return $self->next_msg;
240 # -----------------------------------------------------------
241 # Waits up to timeout seconds for a fully-formed XMPP
242 # message to arrive. If timeout is < 0, waits indefinitely
243 # -----------------------------------------------------------
245 my($self, $timeout) = @_;
248 $timeout = 0 unless defined $timeout;
252 return $xml if $xml = $self->wait($timeout);
256 while($timeout >= 0) {
258 return $xml if $xml = $self->wait($timeout);
259 $timeout -= time - $start;
267 # -----------------------------------------------------------
269 # -----------------------------------------------------------
273 my($parser, $name, %attrs) = @_;
274 my $self = $parser->{_parent_};
276 if($name eq 'message') {
278 my $msg = $self->{message};
279 $msg->{to} = $attrs{'to'};
280 $msg->{from} = $attrs{router_from} if $attrs{router_from};
281 $msg->{from} = $attrs{from} unless $msg->{from};
282 $msg->{osrf_xid} = $attrs{'osrf_xid'};
283 $msg->{type} = $attrs{type};
285 } elsif($name eq 'body') {
286 $self->{xml_state} = IN_BODY;
288 } elsif($name eq 'thread') {
289 $self->{xml_state} = IN_THREAD;
291 } elsif($name eq 'stream:stream') {
292 $self->{stream_state} = CONNECT_RECV;
294 } elsif($name eq 'iq') {
295 if($attrs{type} and $attrs{type} eq 'result') {
296 $self->{stream_state} = CONNECTED;
299 } elsif($name eq 'status') {
300 $self->{xml_state } = IN_STATUS;
302 } elsif($name eq 'stream:error') {
303 $self->{stream_state} = DISCONNECTED;
305 } elsif($name eq 'error') {
306 $self->{message}->{err_type} = $attrs{'type'};
307 $self->{message}->{err_code} = $attrs{'code'};
312 my($parser, $chars) = @_;
313 my $self = $parser->{_parent_};
314 my $state = $self->{xml_state};
316 if($state == IN_BODY) {
317 $self->{message}->{body} .= $chars;
319 } elsif($state == IN_THREAD) {
320 $self->{message}->{thread} .= $chars;
322 } elsif($state == IN_STATUS) {
323 $self->{message}->{status} .= $chars;
328 my($parser, $name) = @_;
329 my $self = $parser->{_parent_};
330 $self->{xml_state} = IN_NOTHING;
332 if($name eq 'message') {
333 $self->push_msg($self->{message});
334 $self->{message} = OpenSRF::Transport::SlimJabber::XMPPMessage->new;
336 } elsif($name eq 'stream:stream') {
337 $self->{stream_state} = DISCONNECTED;
342 # read all the data on the jabber socket through the
343 # parser and drop the resulting message
346 return 0 unless $self->connected;
348 while ($self->wait(0)) {
349 # TODO remove this log line
350 $logger->info("flushing data from socket...");
353 return $self->connected;