1 package OpenSRF::AppSession;
3 #use OpenSRF::DOM::Element::userAuth;
4 use OpenSRF::DomainObject::oilsMessage;
5 use OpenSRF::DomainObject::oilsMethod;
6 use OpenSRF::DomainObject::oilsResponse qw/:status/;
7 use OpenSRF::Transport::PeerHandle;
8 use OpenSRF::Utils::Logger qw(:level);
9 use OpenSRF::Utils::SettingsClient;
10 use OpenSRF::Utils::Config;
14 use base qw/Exporter OpenSRF/;
15 use Time::HiRes qw( time usleep );
19 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
20 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
21 endpoint => [ qw/CLIENT SERVER/ ],
24 my $logger = "OpenSRF::Utils::Logger";
29 sub CONNECTING { return 3 };
30 sub INIT_CONNECTED { return 4 };
31 sub CONNECTED { return 1 };
32 sub DISCONNECTED { return 2 };
34 sub CLIENT { return 2 };
35 sub SERVER { return 1 };
38 return undef unless (defined $_[1]);
39 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
42 sub transport_connected {
44 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
47 return $self->{peer_handle}->tcp_connected();
52 return $self->state == CONNECTED;
54 # ----------------------------------------------------------------------------
55 # Clears the transport buffers
56 # call this if you are not through with the sesssion, but you want
57 # to have a clean slate. You shouldn't have to call this if
58 # you are correctly 'recv'ing all of the data from a request.
59 # however, if you don't want all of the data, this will
60 # slough off any excess
61 # * * Note: This will delete data for all sessions using this transport
62 # handle. For example, all client sessions use the same handle.
63 # ----------------------------------------------------------------------------
67 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
70 $self->{peer_handle}->buffer_reset();
74 # when any incoming data is received, this method is called.
77 $class = ref($class) || $class;
80 my $remote_id = shift;
83 warn "Missing args to server_build():\n" .
84 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
85 unless ($sess_id and $remote_id and $service);
87 return undef unless ($sess_id and $remote_id and $service);
89 if ( my $thingy = $class->find($sess_id) ) {
90 $thingy->remote_id( $remote_id );
94 if( $service eq "client" ) {
95 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
96 # " Session ID [$sess_id], remote_id [$remote_id]");
98 warn "Attempting to build a client session as ".
99 "a server Session ID [$sess_id], remote_id [$remote_id]";
101 $logger->debug("Attempting to build a client session as ".
102 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
107 my $config_client = OpenSRF::Utils::SettingsClient->new();
108 my $stateless = $config_client->config_value("apps", $service, "stateless");
110 #my $max_requests = $conf->$service->max_requests;
111 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
112 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
114 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
116 my $self = bless { recv_queue => [],
123 session_id => $sess_id,
124 remote_id => $remote_id,
125 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
126 max_requests => $max_requests,
127 session_threadTrace => 0,
129 stateless => $stateless,
132 return $_CACHE{$sess_id} = $self;
137 my ($name, $datum) = @_;
139 $self->{session_data}->{$name} = $datum if (defined $datum);
140 return $self->{session_data}->{$name};
143 sub service { return shift()->{service}; }
145 sub continue_request {
147 $self->{'requests'}++;
148 return 1 if (!$self->{'max_requests'});
149 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
152 sub last_sent_payload {
153 my( $self, $payload ) = @_;
155 return $self->{'last_sent_payload'} = $payload;
157 return $self->{'last_sent_payload'};
161 my( $self, $type ) = @_;
163 return $self->{'last_sent_type'} = $type;
165 return $self->{'last_sent_type'};
168 sub get_app_targets {
171 my $conf = OpenSRF::Utils::Config->current;
172 my $router_name = $conf->bootstrap->router_name || 'router';
173 my $routers = $conf->bootstrap->domains;
175 unless($router_name and $routers) {
176 throw OpenSRF::EX::Config
177 ("Missing router config information 'router_name' and 'routers'");
181 for my $router (@$routers) {
182 push @targets, "$router_name\@$router/$app";
191 $self->{stateless} = $state if (defined $state);
192 return $self->{stateless};
195 # When we're a client and we want to connect to a remote service
196 # create( $app, username => $user, secret => $passwd );
198 # create( $app, sysname => $user, secret => $shared_secret );
201 $class = ref($class) || $class;
204 my $api_level = shift;
207 $api_level = 1 if (!defined($api_level));
209 $logger->debug( "AppSession creating new client session for $app", DEBUG );
212 my $c = OpenSRF::Utils::SettingsClient->new();
213 # we can get an infinite loop if we're grabbing the settings and we
214 # need the settings to grab the settings...
215 if($app ne "opensrf.settings" || $c->has_config()) {
216 $stateless = $c->config_value("apps", $app, "stateless");
219 my $sess_id = time . rand( $$ );
220 while ( $class->find($sess_id) ) {
221 $sess_id = time . rand( $$ );
225 my ($r_id) = get_app_targets($app);
227 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
228 if( ! $peer_handle ) {
229 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
232 my $self = bless { app_name => $app,
233 #client_auth => $auth,
237 state => DISCONNECTED,#since we're init'ing
238 session_id => $sess_id,
240 raise_error => $quiet ? 0 : 1,
241 api_level => $api_level,
242 orig_remote_id => $r_id,
243 peer_handle => $peer_handle,
244 session_threadTrace => 0,
245 stateless => $stateless,
248 $logger->debug( "Created new client session $app : $sess_id" );
250 return $_CACHE{$sess_id} = $self;
253 sub raise_remote_errors {
256 $self->{raise_error} = $err if (defined $err);
257 return $self->{raise_error};
261 return shift()->{api_level};
265 return shift()->{app_name};
270 $self->remote_id($$self{orig_remote_id});
273 # 'connect' can be used as a constructor if called as a class method,
274 # or used to connect a session that has disconnectd if called against
275 # an existing session that seems to be disconnected, or was just built
276 # using 'create' above.
278 # connect( $app, username => $user, secret => $passwd );
280 # connect( $app, sysname => $user, secret => $shared_secret );
282 # --- Returns undef if the connect attempt times out.
283 # --- Returns the OpenSRF::EX object if one is returned by the server
284 # --- Returns self if connected
287 my $class = ref($self) || $self;
290 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
291 $logger->transport("AppSession already connected", DEBUG );
293 $logger->transport("AppSession not connected, connecting..", DEBUG );
295 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
299 my $api_level = shift;
300 $api_level = 1 unless (defined $api_level);
302 $self = $class->create($app, @_) if (!ref($self));
304 return undef unless ($self);
306 $self->{api_level} = $api_level;
309 $self->state(CONNECTING);
310 $self->send('CONNECT', "");
313 # if we want to connect to settings, we may not have
314 # any data for the settings client to work with...
315 # just using a default for now XXX
317 my $time_remaining = 5;
320 my $client = OpenSRF::Utils::SettingsClient->new();
321 my $trans = $client->config_value("client_connection","transport_host");
324 $time_remaining = $trans->{connect_timeout};
326 # XXX for now, just use the first
327 $time_remaining = $trans->[0]->{connect_timeout};
331 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
332 my $starttime = time;
333 $self->queue_wait($time_remaining);
335 $time_remaining -= ($endtime - $starttime);
338 return undef unless($self->state == CONNECTED);
347 if( ! $self->session_id ) {
352 sub unregister_callback {
356 if (exists $self->{callbacks}{$type}) {
357 delete $self->{callbacks}{$type}{$cb};
363 sub register_callback {
368 $self->{callbacks}{$type}{$cb_key} = $cb;
374 if( ! $self->session_id ) { return 0; }
376 # run each 'death' callback;
377 if (exists $self->{callbacks}{death}) {
378 for my $sub (values %{$self->{callbacks}{death}}) {
384 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
385 delete $_CACHE{$self->session_id};
386 delete($$self{$_}) for (keys %$self);
392 # run each 'disconnect' callback;
393 if (exists $self->{callbacks}{disconnect}) {
394 for my $sub (values %{$self->{callbacks}{disconnect}}) {
399 if ( !$self->stateless and $self->state != DISCONNECTED ) {
400 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
401 $self->state( DISCONNECTED );
414 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
419 $method->params( @_ );
421 $self->send('REQUEST',$method);
430 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
435 $method->params( @_ );
437 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
442 my @payload_list = @_; # this is a Domain Object
444 return unless ($self and $self->{peer_handle});
446 $logger->debug( "In send", INTERNAL );
450 if( @payload_list % 2 ) { $tT = pop @payload_list; }
452 if( ! @payload_list ) {
453 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
462 while( @payload_list ) {
464 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
466 if ($msg_type eq 'DISCONNECT' ) {
468 if( $self->state == DISCONNECTED && !$connecting) {
473 if( $msg_type eq "CONNECT" ) {
477 my $msg = OpenSRF::DomainObject::oilsMessage->new();
478 $msg->type($msg_type);
481 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
484 if ($msg->type eq 'REQUEST') {
485 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
486 $msg->update_threadTrace;
487 $self->session_threadTrace( $msg->threadTrace );
488 $tT = $self->session_threadTrace;
489 OpenSRF::AppRequest->new($self, $payload);
493 $msg->api_level($self->api_level);
494 $msg->payload($payload) if $payload;
499 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
500 " with threadTrace [".$msg->threadTrace."]" );
504 if ($self->endpoint == CLIENT and ! $disconnect) {
505 $self->queue_wait(0);
508 if($self->stateless && $self->state != CONNECTED) {
510 $logger->debug("AppSession is stateless in send", INTERNAL );
513 if( !$self->stateless and $self->state != CONNECTED ) {
515 $logger->debug( "Sending connect before request 1", INTERNAL );
517 unless (($self->state == CONNECTING && $connecting )) {
518 $logger->debug( "Sending connect before request 2", INTERNAL );
519 my $v = $self->connect();
521 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
524 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
531 $logger->debug( "AppSession sending doc: " . JSON->perl2JSON(\@doc), INTERNAL );
534 $self->{peer_handle}->send(
535 to => $self->remote_id,
536 thread => $self->session_id,
537 body => JSON->perl2JSON(\@doc) );
540 $self->state( DISCONNECTED );
543 my $req = $self->app_request( $tT );
544 $req->{_start} = time;
552 return undef unless (defined $tT);
553 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
558 sub remove_app_request {
562 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
564 $self->{request_queue} = \@list;
568 return $_[0]->{endpoint};
574 return $self->{session_id};
580 my $req = $self->app_request($resp->[1]);
581 return $req->push_queue( $resp->[0] ) if ($req);
582 push @{ $self->{recv_queue} }, $resp->[0];
585 sub last_threadTrace {
587 my $new_last_threadTrace = shift;
589 my $old_last_threadTrace = $self->{last_threadTrace};
590 if (defined $new_last_threadTrace) {
591 $self->{last_threadTrace} = $new_last_threadTrace;
592 return $new_last_threadTrace unless ($old_last_threadTrace);
595 return $old_last_threadTrace;
598 sub session_threadTrace {
600 my $new_last_threadTrace = shift;
602 my $old_last_threadTrace = $self->{session_threadTrace};
603 if (defined $new_last_threadTrace) {
604 $self->{session_threadTrace} = $new_last_threadTrace;
605 return $new_last_threadTrace unless ($old_last_threadTrace);
608 return $old_last_threadTrace;
611 sub last_message_type {
613 my $new_last_message_type = shift;
615 my $old_last_message_type = $self->{last_message_type};
616 if (defined $new_last_message_type) {
617 $self->{last_message_type} = $new_last_message_type;
618 return $new_last_message_type unless ($old_last_message_type);
621 return $old_last_message_type;
624 sub last_message_api_level {
626 my $new_last_message_api_level = shift;
628 my $old_last_message_api_level = $self->{last_message_api_level};
629 if (defined $new_last_message_api_level) {
630 $self->{last_message_api_level} = $new_last_message_api_level;
631 return $new_last_message_api_level unless ($old_last_message_api_level);
634 return $old_last_message_api_level;
639 my $new_remote_id = shift;
641 my $old_remote_id = $self->{remote_id};
642 if (defined $new_remote_id) {
643 $self->{remote_id} = $new_remote_id;
644 return $new_remote_id unless ($old_remote_id);
647 return $old_remote_id;
655 my $old_ua = $self->{client_auth};
656 if (defined $new_ua) {
657 $self->{client_auth} = $new_ua;
658 return $new_ua unless ($old_ua);
661 return $old_ua->cloneNode(1);
666 my $new_state = shift;
668 my $old_state = $self->{state};
669 if (defined $new_state) {
670 $self->{state} = $new_state;
671 return $new_state unless ($old_state);
679 delete $$self{$_} for keys %$self;
689 if ( !(@proto_args % 2) ) {
691 } elsif (@proto_args == 1) {
692 %args = ( timeout => @proto_args );
696 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
698 if( exists( $args{timeout} ) ) {
699 $args{timeout} = int($args{timeout});
700 $self->{recv_timeout} = $args{timeout};
703 #$args{timeout} = 0 if ($self->complete);
705 if(defined($args{timeout})) {
706 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
709 my $avail = @{ $self->{recv_queue} };
710 $self->{remaining_recv_timeout} = $self->{recv_timeout};
714 $args{count} = $avail;
720 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
721 last if $self->complete;
722 my $starttime = time;
723 $self->queue_wait($self->{remaining_recv_timeout});
725 if ($self->{timeout_reset}) {
726 $self->{timeout_reset} = 0;
728 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
730 $avail = @{ $self->{recv_queue} };
735 while ( my $msg = shift @{ $self->{recv_queue} } ) {
737 last if (scalar(@list) >= $args{count});
740 $logger->debug( "Number of matched responses: " . @list, DEBUG );
741 $self->queue_wait(0); # check for statuses
743 return $list[0] unless (wantarray);
749 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
754 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
755 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
756 $req->resend unless $req->complete;
763 if( ! $self->{peer_handle} ) { return 0; }
764 my $timeout = shift || 0;
765 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
766 my $o = $self->{peer_handle}->process($timeout);
774 foreach my $msg ( @{$self->{recv_queue}} ) {
775 $string = $string . $msg->toString(1) . "\n";
783 $self->send( 'STATUS', @_ );
786 sub reset_request_timeout {
789 my $req = $self->app_request($tt);
790 $req->{remaining_recv_timeout} = $req->{recv_timeout};
791 $req->{timout_reset} = 1;
794 #-------------------------------------------------------------------------------
796 package OpenSRF::AppRequest;
797 use base qw/OpenSRF::AppSession/;
798 use OpenSRF::Utils::Logger qw/:level/;
799 use OpenSRF::DomainObject::oilsResponse qw/:status/;
800 use Time::HiRes qw/time usleep/;
804 $class = ref($class) || $class;
807 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
810 my $self = { session => $session,
811 threadTrace => $threadTrace,
816 remaining_recv_timeout => 30,
820 bless $self => $class;
822 push @{ $self->session->{request_queue} }, $self;
830 if (defined $timeout) {
831 $self->{recv_timeout} = $timeout;
832 $self->{remaining_recv_timeout} = $timeout;
834 return $self->{recv_timeout};
838 my $size = @{$_[0]->{recv_queue}};
844 return unless ($self and $self->session and !$self->complete);
845 $self->session->send(@_);
850 return unless $self->session;
851 $self->session->remove_app_request($self);
852 delete($$self{$_}) for (keys %$self);
856 return shift()->{session};
861 my $complete = shift;
862 return $self->{complete} if ($self->{complete});
863 if (defined $complete) {
864 $self->{complete} = $complete;
865 $self->{_duration} = time - $self->{_start} if ($self->{complete});
867 $self->session->queue_wait(0);
869 return $self->{complete};
874 $self->wait_complete;
875 return $self->{_duration};
880 my $timeout = shift || 10;
881 my $time_remaining = $timeout;
883 while ( ! $self->complete and $time_remaining > 0 ) {
884 my $starttime = time;
885 $self->queue_wait($time_remaining);
887 $time_remaining -= ($endtime - $starttime);
890 return $self->complete;
894 return shift()->{threadTrace};
900 if( !$resp ) { return 0; }
901 if( UNIVERSAL::isa($resp, "Error")) {
902 $self->{failed} = $resp;
904 #return; eventually...
906 push @{ $self->{recv_queue} }, $resp;
911 return $self->{failed};
916 return $self->session->queue_wait(@_)
919 sub payload { return shift()->{payload}; }
923 return unless ($self and $self->session and !$self->complete);
924 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
925 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
931 return unless ($self and $self->session and !$self->complete);
932 $self->session->send( 'STATUS',$msg, $self->threadTrace );
938 $self->respond( $msg );
944 return unless ($self and $self->session and !$self->complete);
947 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
950 $response = new OpenSRF::DomainObject::oilsResult;
951 $response->content($msg);
954 $self->session->send('RESULT', $response, $self->threadTrace);
957 sub respond_complete {
960 return unless ($self and $self->session and !$self->complete);
963 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
966 $response = new OpenSRF::DomainObject::oilsResult;
967 $response->content($msg);
970 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
971 statusCode => STATUS_COMPLETE(),
972 status => 'Request Complete' );
975 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
979 sub register_death_callback {
982 $self->session->register_callback( death => $cb );
986 # utility method. checks to see of the request failed.
987 # if so, throws an OpenSRF::EX::ERROR. if everything is
988 # ok, it returns the content of the request
992 $self->wait_complete;
993 my $resp = $self->recv( timeout => 60 );
994 if( $self->failed() ) {
995 throw OpenSRF::EX::ERROR
996 ($self->failed()->stringify());
998 if(!$resp) { return undef; }
999 my $content = $resp->content;
1000 if($finish) { $self->finish();}
1005 package OpenSRF::AppSubrequest;
1010 push @{$$self{resp}}, $resp if (defined $resp);
1012 sub respond_complete { respond(@_); }
1016 $class = ref($class) || $class;
1017 return bless({resp => [], @_}, $class);
1020 sub responses { @{$_[0]->{resp}} }