src/perl/lib/OpenSRF/Transport/SlimJabber/XMPPReader.pm

   1 package OpenSRF::Transport::SlimJabber::XMPPReader;
   2 use strict; use warnings;
   3 use XML::Parser;
   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/;
   8 use OpenSRF::EX;
   9
  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'>";
  15
  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>";
  19
  20 use constant JABBER_DISCONNECT => "</stream:stream>";
  21
  22
  23 # -----------------------------------------------------------
  24 # XMPP Stream states
  25 # -----------------------------------------------------------
  26 use constant DISCONNECTED   => 1;
  27 use constant CONNECT_RECV   => 2;
  28 use constant CONNECTED      => 3;
  29
  30
  31 # -----------------------------------------------------------
  32 # XMPP Message states
  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;
  38
  39
  40 # -----------------------------------------------------------
  41 # Constructor, getter/setters
  42 # -----------------------------------------------------------
  43 sub new {
  44     my $class = shift;
  45     my $socket = shift;
  46
  47     my $self = bless({}, $class);
  48
  49     $self->{queue} = [];
  50     $self->{stream_state} = DISCONNECTED;
  51     $self->{xml_state} = IN_NOTHING;
  52     $self->socket($socket);
  53
  54     my $p = new XML::Parser(Handlers => {
  55         Start => \&start_element,
  56         End   => \&end_element,
  57         Char  => \&characters,
  58     });
  59
  60     $self->parser($p->parse_start); # create a push parser
  61     $self->parser->{_parent_} = $self;
  62     $self->{message} = OpenSRF::Transport::SlimJabber::XMPPMessage->new;
  63     return $self;
  64 }
  65
  66 sub push_msg {
  67     my($self, $msg) = @_;
  68     push(@{$self->{queue}}, $msg) if $msg;
  69 }
  70
  71 sub next_msg {
  72     my $self = shift;
  73     return shift @{$self->{queue}};
  74 }
  75
  76 sub peek_msg {
  77     my $self = shift;
  78     return (@{$self->{queue}} > 0);
  79 }
  80
  81 sub parser {
  82     my($self, $parser) = @_;
  83     $self->{parser} = $parser if $parser;
  84     return $self->{parser};
  85 }
  86
  87 sub socket {
  88     my($self, $socket) = @_;
  89     $self->{socket} = $socket if $socket;
  90     return $self->{socket};
  91 }
  92
  93 sub stream_state {
  94     my($self, $stream_state) = @_;
  95     $self->{stream_state} = $stream_state if $stream_state;
  96     return $self->{stream_state};
  97 }
  98
  99 sub xml_state {
 100     my($self, $xml_state) = @_;
 101     $self->{xml_state} = $xml_state if $xml_state;
 102     return $self->{xml_state};
 103 }
 104
 105 sub message {
 106     my($self, $message) = @_;
 107     $self->{message} = $message if $message;
 108     return $self->{message};
 109 }
 110
 111
 112 # -----------------------------------------------------------
 113 # Stream and connection handling methods
 114 # -----------------------------------------------------------
 115
 116 sub connect {
 117     my($self, $domain, $username, $password, $resource) = @_;
 118
 119     $self->send(sprintf(JABBER_CONNECT, $domain));
 120     $self->wait(10);
 121
 122     unless($self->{stream_state} == CONNECT_RECV) {
 123         $logger->error("No initial XMPP response from server");
 124         return 0;
 125     }
 126
 127     $self->send(sprintf(JABBER_BASIC_AUTH, $username, $password, $resource));
 128     $self->wait(10);
 129
 130     unless($self->connected) {
 131         $logger->error('XMPP connect failed');
 132         return 0;
 133     }
 134
 135     return 1;
 136 }
 137
 138 sub disconnect {
 139     my $self = shift;
 140     return unless $self->socket;
 141     if($self->tcp_connected) {
 142         $self->send(JABBER_DISCONNECT);
 143         shutdown($self->socket, 2);
 144     }
 145     close($self->socket);
 146 }
 147
 148 # -----------------------------------------------------------
 149 # returns true if this stream is connected to the server
 150 # -----------------------------------------------------------
 151 sub connected {
 152     my $self = shift;
 153     return ($self->tcp_connected and $self->{stream_state} == CONNECTED);
 154 }
 155
 156 # -----------------------------------------------------------
 157 # returns true if the socket is connected
 158 # -----------------------------------------------------------
 159 sub tcp_connected {
 160     my $self = shift;
 161     return ($self->socket and $self->socket->connected);
 162 }
 163
 164 # -----------------------------------------------------------
 165 # sends pre-formated XML
 166 # -----------------------------------------------------------
 167 sub send {
 168     my($self, $xml) = @_;
 169
 170     local $SIG{'PIPE'} = sub {
 171         $logger->error("Disconnected from Jabber server, exiting immediately");
 172         exit(99);
 173     };
 174     $self->{socket}->print($xml);
 175 }
 176
 177 # -----------------------------------------------------------
 178 # Puts a file handle into blocking mode
 179 # -----------------------------------------------------------
 180 sub set_block {
 181     my $fh = shift;
 182     my  $flags = fcntl($fh, F_GETFL, 0);
 183     $flags &= ~O_NONBLOCK;
 184     fcntl($fh, F_SETFL, $flags);
 185 }
 186
 187
 188 # -----------------------------------------------------------
 189 # Puts a file handle into non-blocking mode
 190 # -----------------------------------------------------------
 191 sub set_nonblock {
 192     my $fh = shift;
 193     my  $flags = fcntl($fh, F_GETFL, 0);
 194     fcntl($fh, F_SETFL, $flags | O_NONBLOCK);
 195 }
 196
 197
 198 sub wait {
 199     my($self, $timeout) = @_;
 200
 201     return $self->next_msg if $self->peek_msg;
 202
 203     $timeout ||= 0;
 204     $timeout = undef if $timeout < 0;
 205     my $socket = $self->{socket};
 206
 207     set_block($socket);
 208
 209     # build the select readset
 210     my $infile = '';
 211     vec($infile, $socket->fileno, 1) = 1;
 212
 213     my $nfound = select($infile, undef, undef, $timeout);
 214     return undef if !$nfound or $nfound == -1;
 215
 216     # now slurp the data off the socket
 217     my $buf;
 218     my $read_size = 1024;
 219     my $nonblock = 0;
 220     my $nbytes;
 221     my $first_read = 1;
 222
 223     while($nbytes = sysread($socket, $buf, $read_size)) {
 224         $self->{parser}->parse_more($buf) if $buf;
 225         if($nbytes < $read_size or $self->peek_msg) {
 226             set_block($socket) if $nonblock;
 227             last;
 228         }
 229         set_nonblock($socket) unless $nonblock;
 230         $nonblock = 1;
 231         $first_read = 0;
 232     }
 233
 234     if ($first_read and defined $nbytes and $nbytes == 0) {
 235         # if the first read on an active socket is 0 bytes,
 236         # the socket has been disconnected from the remote end.
 237         $self->{stream_state} = DISCONNECTED;
 238         $logger->error("Disconnected from Jabber server");
 239         throw OpenSRF::EX::Jabber("Disconnected from Jabber server");
 240     }
 241
 242     return $self->next_msg;
 243 }
 244
 245 # -----------------------------------------------------------
 246 # Waits up to timeout seconds for a fully-formed XMPP
 247 # message to arrive.  If timeout is < 0, waits indefinitely
 248 # -----------------------------------------------------------
 249 sub wait_msg {
 250     my($self, $timeout) = @_;
 251     my $xml;
 252
 253     $timeout = 0 unless defined $timeout;
 254
 255     if($timeout < 0) {
 256         while(1) {
 257             return $xml if $xml = $self->wait($timeout);
 258         }
 259
 260     } else {
 261         while($timeout >= 0) {
 262             my $start = time;
 263             return $xml if $xml = $self->wait($timeout);
 264             $timeout -= time - $start;
 265         }
 266     }
 267
 268     return undef;
 269 }
 270
 271
 272 # -----------------------------------------------------------
 273 # SAX Handlers
 274 # -----------------------------------------------------------
 275
 276
 277 sub start_element {
 278     my($parser, $name, %attrs) = @_;
 279     my $self = $parser->{_parent_};
 280
 281     if($name eq 'message') {
 282
 283         my $msg = $self->{message};
 284         $msg->{to} = $attrs{'to'};
 285         $msg->{from} = $attrs{router_from} if $attrs{router_from};
 286         $msg->{from} = $attrs{from} unless $msg->{from};
 287         $msg->{osrf_xid} = $attrs{'osrf_xid'};
 288         $msg->{type} = $attrs{type};
 289
 290     } elsif($name eq 'body') {
 291         $self->{xml_state} = IN_BODY;
 292
 293     } elsif($name eq 'thread') {
 294         $self->{xml_state} = IN_THREAD;
 295
 296     } elsif($name eq 'stream:stream') {
 297         $self->{stream_state} = CONNECT_RECV;
 298
 299     } elsif($name eq 'iq') {
 300         if($attrs{type} and $attrs{type} eq 'result') {
 301             $self->{stream_state} = CONNECTED;
 302         }
 303
 304     } elsif($name eq 'status') {
 305         $self->{xml_state } = IN_STATUS;
 306
 307     } elsif($name eq 'stream:error') {
 308         $self->{stream_state} = DISCONNECTED;
 309
 310     } elsif($name eq 'error') {
 311         $self->{message}->{err_type} = $attrs{'type'};
 312         $self->{message}->{err_code} = $attrs{'code'};
 313     }
 314 }
 315
 316 sub characters {
 317     my($parser, $chars) = @_;
 318     my $self = $parser->{_parent_};
 319     my $state = $self->{xml_state};
 320
 321     if($state == IN_BODY) {
 322         $self->{message}->{body} .= $chars;
 323
 324     } elsif($state == IN_THREAD) {
 325         $self->{message}->{thread} .= $chars;
 326
 327     } elsif($state == IN_STATUS) {
 328         $self->{message}->{status} .= $chars;
 329     }
 330 }
 331
 332 sub end_element {
 333     my($parser, $name) = @_;
 334     my $self = $parser->{_parent_};
 335     $self->{xml_state} = IN_NOTHING;
 336
 337     if($name eq 'message') {
 338         $self->push_msg($self->{message});
 339         $self->{message} = OpenSRF::Transport::SlimJabber::XMPPMessage->new;
 340
 341     } elsif($name eq 'stream:stream') {
 342         $self->{stream_state} = DISCONNECTED;
 343     }
 344 }
 345
 346
 347 # read all the data on the jabber socket through the
 348 # parser and drop the resulting message
 349 sub flush_socket {
 350         my $self = shift;
 351     return 0 unless $self->connected;
 352
 353     while ($self->wait(0)) {
 354         # TODO remove this log line
 355         $logger->info("flushing data from socket...");
 356     }
 357
 358     return $self->connected;
 359 }
 360
 361
 362
 363 1;
 364