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