1 package OpenSRF::Transport::SlimJabber::Client;
2 use strict; use warnings;
4 use base qw( OpenSRF );
5 use OpenSRF::Utils::Logger qw(:level);
6 use OpenSRF::Utils::Config;
7 use Time::HiRes qw(ualarm);
8 use OpenSRF::Utils::Config;
10 use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
16 OpenSRF::Transport::SlimJabber::Client
18 Home-brewed slimmed down jabber connection agent. Supports SSL connections
19 with a config file options:
21 transport->server->sslport # the ssl port
22 transport->server->ssl # is this ssl?
26 my $logger = "OpenSRF::Utils::Logger";
35 my $socket = $self->{_socket};
36 if( $socket and $socket->connected() ) {
37 print $socket "</stream:stream>";
45 Creates a new Client object.
47 debug and log_file are not required if you don't care to log the activity,
48 however all other parameters are.
62 my( $class, %params ) = @_;
64 $class = ref( $class ) || $class;
66 my $port = $params{'port'} || return undef;
67 my $username = $params{'username'} || return undef;
68 my $resource = $params{'resource'} || return undef;
69 my $password = $params{'password'} || return undef;
70 my $host = $params{'host'} || return undef;
72 my $jid = "$username\@$host\/$resource";
74 my $self = bless {} => $class;
79 $self->username( $username );
80 $self->resource( $resource );
81 $self->password( $password );
82 $self->{temp_buffer} = "";
84 $logger->transport( "Creating Client instance: $host:$port, $username, $resource",
90 # clears the tmp buffer as well as the TCP buffer
94 $self->{temp_buffer} = "";
96 my $fh = $self->{_socket};
99 while( sysread( $fh, $t_buf, 4096 ) ) {}
102 # -------------------------------------------------
106 Gathers all Jabber messages sitting in the collection queue
107 and hands them each to their respective callbacks. This call
108 does not block (calls Process(0))
112 sub gather { my $self = shift; $self->process( 0 ); }
114 # -------------------------------------------------
118 Blocks and gathers incoming messages as they arrive. Does not return
119 unless an error occurs.
121 Throws an OpenSRF::EX::JabberException if the call to Process ever fails.
127 my $sock = $self->unix_sock();
128 my $socket = IO::Socket::UNIX->new( Peer => $sock );
129 $logger->transport( "Unix Socket opened by Listener", INTERNAL );
131 throw OpenSRF::EX::Socket( "Unable to connect to UnixServer: socket-file: $sock \n :=> $! " )
132 unless ($socket->connected);
135 my $o = $self->process( -1 );
136 $logger->transport( "Call to process() in listener returned:\n $o", INTERNAL );
137 if( ! defined( $o ) ) {
138 throw OpenSRF::EX::Jabber( "Listen Loop failed at 'process()'" );
143 throw OpenSRF::EX::Socket( "How did we get here?!?!" );
148 my $flags = fcntl($fh, F_GETFL, 0)
149 or die "Can't get flags for the socket: $!\n";
151 $logger->transport( "Setting NONBLOCK: original flags: $flags", INTERNAL );
153 fcntl($fh, F_SETFL, $flags | O_NONBLOCK)
154 or die "Can't set flags for the socket: $!\n";
162 $logger->transport( "Restoring BLOCK: to flags $flags", INTERNAL );
163 fcntl($fh, F_SETFL, $flags) if defined $flags;
169 my $flags = fcntl($fh, F_GETFL, 0)
170 or die "Can't get flags for the socket: $!\n";
172 $flags &= ~O_NONBLOCK;
174 fcntl($fh, F_SETFL, $flags)
175 or die "Can't set flags for the socket: $!\n";
180 my ($self, $timeout) = @_;
182 $logger->transport( "Temp Buffer Contained: \n". $self->{temp_buffer}, INTERNAL) if $self->{temp_buffer};
183 if( $self->can( "app" ) ) {
184 $logger->transport( "timed_read called for ".$self->app.", I am: ".$self->jid, INTERNAL );
187 # See if there is a complete message in the temp_buffer
189 if( $self->{temp_buffer} ) {
190 my $buffer = $self->{temp_buffer};
192 $self->{temp_buffer} = '';
194 my ($tag) = ($buffer =~ /<([^\s\?\>]+)/o);
195 $logger->transport("Using tag: $tag ", INTERNAL);
197 if ( $buffer =~ /^(.*?<\/$tag>)(.*)/s) {
199 $self->{temp_buffer} = $2;
201 $logger->transport( "completed read with $buffer", INTERNAL );
202 } elsif ( $buffer =~ /^<$tag[^>]*?\/>(.*)/) {
203 $self->{temp_buffer} = $1;
205 $logger->transport( "completed read with $buffer", INTERNAL );
207 $self->{temp_buffer} = $buffer;
210 if( $buffer and $complete ) {
217 my $fh = $self->{_socket};
219 unless( $fh and $fh->connected ) {
220 throw OpenSRF::EX::Socket ("Attempted read on closed socket", ERROR );
223 $logger->transport( "Temp Buffer After first attempt: \n ".$self->{temp_buffer}, INTERNAL) if $self->{temp_buffer};
226 if (defined($timeout) && !$timeout) {
227 $flags = set_nonblock( $fh );
231 $logger->transport( "Calling timed_read with timetout $timeout", INTERNAL );
241 local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
243 # alarm needs a number greater => 1.
244 my $alarm_timeout = $timeout;
245 if( $alarm_timeout > 0 and $alarm_timeout < 1 ) {
248 alarm $alarm_timeout;
251 my $buffer = $self->{temp_buffer};
252 $self->{temp_buffer} = '';
255 my $ff = fcntl($fh, F_GETFL, 0);
256 if ($ff == ($ff | O_NONBLOCK) and $timeout > 0 ) {
257 #throw OpenSRF::EX::ERROR ("File flags are set to NONBLOCK but timeout is $timeout", ERROR );
261 my $read_size = 1024; my $f = 0;
262 while( my $n = sysread( $fh, $t_buf, $read_size ) ) {
264 unless( $fh->connected ) {
265 OpenSRF::EX::JabberDisconnected->throw(
266 "Lost jabber client in timed_read()");
270 if( $n < $read_size ) {
271 #reset_fl( $fh, $f ) if $f;
275 # see if there is any more data to grab...
276 $f = set_nonblock( $fh );
279 #sysread($fh, $buffer, 2048, length($buffer) );
280 #sysread( $fh, $t_buf, 2048 );
284 $logger->transport(" Got [$buffer] from the socket", INTERNAL);
287 $logger->transport(" First read Buffer\n [$buffer]", INTERNAL);
288 ($tag) = ($buffer =~ /<([^\s\?\>]+){1}/o);
290 $logger->transport("Using tag: $tag ", INTERNAL);
293 if (!$first_read && $buffer =~ /^(.*?<\/$tag>){1}(.*)/s) {
295 $self->{temp_buffer} = $2;
297 $logger->transport( "completed read with $buffer", INTERNAL );
298 } elsif (!$first_read && $buffer =~ /^<$tag[^>]*?\/>(.*)/) {
299 $self->{temp_buffer} = $1;
301 $logger->transport( "completed read with $buffer", INTERNAL );
306 } while (!$complete && $xml);
312 $logger->transport( "XML Read: $xml", INTERNAL );
313 #reset_fl( $fh, $flags) if defined $flags;
314 set_block( $fh ) if defined $flags;
326 # -------------------------------------------------
331 return 1 if ($self->{_socket} and $self->{_socket}->connected);
336 my( $self, $password ) = @_;
337 $self->{'oils:password'} = $password if $password;
338 return $self->{'oils:password'};
341 # -------------------------------------------------
344 my( $self, $username ) = @_;
345 $self->{'oils:username'} = $username if $username;
346 return $self->{'oils:username'};
349 # -------------------------------------------------
352 my( $self, $resource ) = @_;
353 $self->{'oils:resource'} = $resource if $resource;
354 return $self->{'oils:resource'};
357 # -------------------------------------------------
360 my( $self, $jid ) = @_;
361 $self->{'oils:jid'} = $jid if $jid;
362 return $self->{'oils:jid'};
366 my( $self, $port ) = @_;
367 $self->{'oils:port'} = $port if $port;
368 return $self->{'oils:port'};
372 my( $self, $host ) = @_;
373 $self->{'oils:host'} = $host if $host;
374 return $self->{'oils:host'};
377 # -------------------------------------------------
381 Sends a Jabber message.
384 to - The JID of the recipient
385 thread - The Jabber thread
386 body - The body of the message
394 my $to = $params{'to'} || return undef;
395 my $body = $params{'body'} || return undef;
396 my $thread = $params{'thread'} || "";
397 my $router_command = $params{'router_command'} || "";
398 my $router_class = $params{'router_class'} || "";
400 my $msg = OpenSRF::Transport::SlimJabber::MessageWrapper->new;
403 $msg->setThread( $thread ) if $thread;
404 $msg->setBody( $body );
405 $msg->set_router_command( $router_command );
406 $msg->set_router_class( $router_class );
410 "JabberClient Sending message to $to with thread $thread and body: \n$body", INTERNAL );
412 my $soc = $self->{_socket};
413 unless( $soc and $soc->connected ) {
414 throw OpenSRF::EX::Jabber ("No longer connected to jabber server");
416 print $soc $msg->toString;
419 "JabberClient Sent message to $to with thread $thread and body: \n$body", INTERNAL );
425 Connect to the server and log in.
427 Throws an OpenSRF::EX::JabberException if we cannot connect
428 to the server or if the authentication fails.
432 # --- The logging lines have been commented out until we decide
433 # on which log files we're using.
439 my $jid = $self->jid;
440 my $host = $self->host;
441 my $port = $self->port;
442 my $username = $self->username;
443 my $resource = $self->resource;
444 my $password = $self->password;
446 my $stream = <<" XML";
447 <stream:stream to='$host' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'>
450 my $conf = OpenSRF::Utils::Config->current;
452 if(!$conf->bootstrap->router_name && $username eq "router") {
457 <iq id='123' type='set'>
458 <query xmlns='jabber:iq:auth'>
459 <username>$username</username>
460 <password>$password</password>
461 <resource>${resource}$tail</resource>
466 my $sock_type = 'IO::Socket::INET';
468 # if port is a string, then we're connecting to a UNIX socket
469 unless( $port =~ /^\d+$/ ) {
470 $sock_type = 'IO::Socket::UNIX';
473 # --- 5 tries to connect to the jabber server
476 $socket = $sock_type->new( PeerHost => $host,
480 $logger->debug( "$jid: $_ connect attempt to $host:$port");
481 last if ( $socket and $socket->connected );
482 $logger->warn( "$jid: Failed to connect to server...$host:$port (Try # $_)");
486 unless ( $socket and $socket->connected ) {
487 throw OpenSRF::EX::Jabber( " Could not connect to Jabber server: $!" );
490 $logger->transport( "Logging into jabber as $jid " .
491 "from " . ref( $self ), DEBUG );
493 print $socket $stream;
498 local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required
500 sysread($socket, $buffer, 4096);
501 $logger->transport( "Login buffer 1: $buffer", INTERNAL );
509 if( $socket and $socket->connected() ) {
510 $self->{_socket} = $socket;
512 throw OpenSRF::EX::Jabber( " ** Unable to connect to Jabber server", ERROR );
516 $buffer = $self->timed_read(10);
518 if( $buffer ) {$logger->transport( "Login buffer 2: $buffer", INTERNAL );}
520 if( $buffer and $buffer =~ /type=["\']result["\']/ ) {
521 $logger->transport( " * $jid: Jabber authenticated and connected", DEBUG );
523 if( !$buffer ) { $buffer = " "; }
525 throw OpenSRF::EX::Jabber( " * $jid: Unable to authenticate: $buffer", ERROR );
532 my( $class, $app ) = @_;
533 $logger->transport("Constructing new Jabber connection for $app, my class $class", INTERNAL );
535 $class->new( $app )->initialize() );
540 my( $self, $timeout ) = @_;
543 undef $timeout if ( $timeout == -1 );
545 unless( $self->{_socket}->connected ) {
546 OpenSRF::EX::JabberDisconnected->throw(
547 "This JabberClient instance is no longer connected to the server " .
548 $self->username . " : " . $self->resource, ERROR );
551 my $val = $self->timed_read( $timeout );
553 $timeout = "FOREVER" unless ( defined $timeout );
555 if ( ! defined( $val ) ) {
556 OpenSRF::EX::Jabber->throw(
557 "Call to Client->timed_read( $timeout ) failed", ERROR );
560 "Call to Client->timed_read( $timeout ) returned 0 bytes of data", DEBUG );
563 "Call to Client->timed_read( $timeout ) successfully returned data", INTERNAL );
571 # --------------------------------------------------------------
572 # Sets the socket to O_NONBLOCK, reads all of the data off of
573 # the socket, the restores the sockets flags
574 # Returns 1 on success, 0 if the socket isn't connected
575 # --------------------------------------------------------------
579 my $socket = $self->{_socket};
581 if( $socket and $socket->connected() ) {
584 my $flags = fcntl($socket, F_GETFL, 0);
586 fcntl($socket, F_SETFL, $flags | O_NONBLOCK);
587 while( my $n = sysread( $socket, $buf, 8192 ) ) {
588 $logger->debug("flush_socket dropped $n bytes of data");
590 fcntl($socket, F_SETFL, $flags);