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";
30 sub kill_client_session_cache {
31 for my $session ( @_CLIENT_CACHE ) {
36 sub CONNECTING { return 3 };
37 sub INIT_CONNECTED { return 4 };
38 sub CONNECTED { return 1 };
39 sub DISCONNECTED { return 2 };
41 sub CLIENT { return 2 };
42 sub SERVER { return 1 };
45 return undef unless (defined $_[1]);
46 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
50 my( $self, $app ) = @_;
51 $logger->debug( "Client Cache contains: " .scalar(@_CLIENT_CACHE), INTERNAL );
52 my ($client) = grep { $_->[0] eq $app and $_->[1] == 1 } @_CLIENT_CACHE;
57 sub transport_connected {
59 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
62 return $self->{peer_handle}->tcp_connected();
65 # ----------------------------------------------------------------------------
66 # Clears the transport buffers
67 # call this if you are not through with the sesssion, but you want
68 # to have a clean slate. You shouldn't have to call this if
69 # you are correctly 'recv'ing all of the data from a request.
70 # however, if you don't want all of the data, this will
71 # slough off any excess
72 # * * Note: This will delete data for all sessions using this transport
73 # handle. For example, all client sessions use the same handle.
74 # ----------------------------------------------------------------------------
78 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
81 $self->{peer_handle}->buffer_reset();
87 push @_CLIENT_CACHE, [ $self->app, 1, $self ];
90 # when any incoming data is received, this method is called.
93 $class = ref($class) || $class;
96 my $remote_id = shift;
99 return undef unless ($sess_id and $remote_id and $service);
101 if ( my $thingy = $class->find($sess_id) ) {
102 $thingy->remote_id( $remote_id );
103 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
106 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
109 if( $service eq "client" ) {
110 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
111 # " Session ID [$sess_id], remote_id [$remote_id]");
112 $logger->debug("Attempting to build a client session as ".
113 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
117 my $config_client = OpenSRF::Utils::SettingsClient->new();
118 my $stateless = $config_client->config_value("apps", $service, "stateless");
120 #my $max_requests = $conf->$service->max_requests;
121 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
122 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
124 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
126 my $self = bless { recv_queue => [],
133 session_id => $sess_id,
134 remote_id => $remote_id,
135 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
136 max_requests => $max_requests,
137 session_threadTrace => 0,
139 stateless => $stateless,
142 return $_CACHE{$sess_id} = $self;
147 my ($name, $datum) = @_;
149 $self->{session_data}->{$name} = $datum if (defined $datum);
150 return $self->{session_data}->{$name};
153 sub service { return shift()->{service}; }
155 sub continue_request {
157 $self->{'requests'}++;
158 return 1 if (!$self->{'max_requests'});
159 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
162 sub last_sent_payload {
163 my( $self, $payload ) = @_;
165 return $self->{'last_sent_payload'} = $payload;
167 return $self->{'last_sent_payload'};
171 my( $self, $type ) = @_;
173 return $self->{'last_sent_type'} = $type;
175 return $self->{'last_sent_type'};
178 sub get_app_targets {
181 my $conf = OpenSRF::Utils::Config->current;
182 my $router_name = $conf->bootstrap->router_name || 'router';
183 my $routers = $conf->bootstrap->domains;
185 unless($router_name and $routers) {
186 throw OpenSRF::EX::Config
187 ("Missing router config information 'router_name' and 'routers'");
191 for my $router (@$routers) {
192 push @targets, "$router_name\@$router/$app";
200 if($self) {return $self->{stateless};}
203 # When we're a client and we want to connect to a remote service
204 # create( $app, username => $user, secret => $passwd );
206 # create( $app, sysname => $user, secret => $shared_secret );
209 $class = ref($class) || $class;
215 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
217 "AppSession returning existing client session for $app", DEBUG );
220 $logger->debug( "AppSession creating new client session for $app", DEBUG );
224 my $c = OpenSRF::Utils::SettingsClient->new();
225 # we can get an infinite loop if we're grabbing the settings and we
226 # need the settings to grab the settings...
227 if($app ne "opensrf.settings" || $c->has_config()) {
228 $stateless = $c->config_value("apps", $app, "stateless");
231 my $sess_id = time . rand( $$ );
232 while ( $class->find($sess_id) ) {
233 $sess_id = time . rand( $$ );
237 my ($r_id) = get_app_targets($app);
239 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
240 if( ! $peer_handle ) {
241 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
244 my $self = bless { app_name => $app,
245 #client_auth => $auth,
249 state => DISCONNECTED,#since we're init'ing
250 session_id => $sess_id,
253 orig_remote_id => $r_id,
254 peer_handle => $peer_handle,
255 session_threadTrace => 0,
256 stateless => $stateless,
259 $self->client_cache();
260 $_CACHE{$sess_id} = $self;
261 return $self->find_client( $app );
265 return shift()->{api_level};
269 return shift()->{app_name};
274 $self->remote_id($$self{orig_remote_id});
277 # 'connect' can be used as a constructor if called as a class method,
278 # or used to connect a session that has disconnectd if called against
279 # an existing session that seems to be disconnected, or was just built
280 # using 'create' above.
282 # connect( $app, username => $user, secret => $passwd );
284 # connect( $app, sysname => $user, secret => $shared_secret );
286 # --- Returns undef if the connect attempt times out.
287 # --- Returns the OpenSRF::EX object if one is returned by the server
288 # --- Returns self if connected
291 my $class = ref($self) || $self;
294 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
295 $logger->transport("AppSession already connected", DEBUG );
297 $logger->transport("AppSession not connected, connecting..", DEBUG );
299 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
303 my $api_level = shift;
304 $api_level = 1 unless (defined $api_level);
306 $self = $class->create($app, @_) if (!ref($self));
309 return undef unless ($self);
311 $self->{api_level} = $api_level;
314 $self->state(CONNECTING);
315 $self->send('CONNECT', "");
317 # if we want to connect to settings, we may not have
318 # any data for the settings client to work with...
319 # just using a default for now XXX
321 my $time_remaining = 5;
324 my $client = OpenSRF::Utils::SettingsClient->new();
325 my $trans = $client->config_value("client_connection","transport_host");
328 $time_remaining = $trans->{connect_timeout};
330 # XXX for now, just use the first
331 $time_remaining = $trans->[0]->{connect_timeout};
335 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
336 my $starttime = time;
337 $self->queue_wait($time_remaining);
339 $time_remaining -= ($endtime - $starttime);
342 return undef unless($self->state == CONNECTED);
349 if( ! $self->session_id ) {
352 #$self->disconnect if ($self->endpoint == CLIENT);
353 for my $ses ( @_CLIENT_CACHE ) {
354 if ($ses->[2]->session_id eq $self->session_id) {
360 sub unregister_callback {
364 if (exists $self->{callbacks}{$type}) {
365 delete $self->{callbacks}{$type}{$cb};
371 sub register_callback {
376 $self->{callbacks}{$type}{$cb_key} = $cb;
382 if( ! $self->session_id ) { return 0; }
384 # run each 'death' callback;
385 if (exists $self->{callbacks}{death}) {
386 for my $sub (values %{$self->{callbacks}{death}}) {
392 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
394 for my $ses ( @_CLIENT_CACHE ) {
396 if ($ses->[2]->session_id ne $self->session_id);
399 delete $_CACHE{$self->session_id};
400 delete($$self{$_}) for (keys %$self);
406 # run each 'disconnect' callback;
407 if (exists $self->{callbacks}{disconnect}) {
408 for my $sub (values %{$self->{callbacks}{disconnect}}) {
413 if( $self->stateless and $self->state != CONNECTED ) {
418 unless( $self->state == DISCONNECTED ) {
419 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
420 $self->state( DISCONNECTED );
433 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
438 $method->params( @_ );
440 $self->send('REQUEST',$method);
449 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
454 $method->params( @_ );
456 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
461 my @payload_list = @_; # this is a Domain Object
463 return unless ($self and $self->{peer_handle});
465 $logger->debug( "In send", INTERNAL );
469 if( @payload_list % 2 ) { $tT = pop @payload_list; }
471 if( ! @payload_list ) {
472 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
476 my $doc = OpenSRF::DOM->createDocument();
478 $logger->debug( "In send2", INTERNAL );
483 while( @payload_list ) {
485 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
487 if ($msg_type eq 'DISCONNECT' ) {
489 if( $self->state == DISCONNECTED && !$connecting) {
494 if( $msg_type eq "CONNECT" ) {
499 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
503 my $msg = OpenSRF::DomainObject::oilsMessage->new();
504 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
506 $msg->type($msg_type);
507 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
509 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
512 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
515 if ($msg->type eq 'REQUEST') {
516 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
517 $msg->update_threadTrace;
518 $self->session_threadTrace( $msg->threadTrace );
519 $tT = $self->session_threadTrace;
520 OpenSRF::AppRequest->new($self, $payload);
524 $msg->api_level($self->api_level);
525 $msg->payload($payload) if $payload;
527 $doc->documentElement->appendChild( $msg );
530 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
531 " with threadTrace [".$msg->threadTrace."]", INFO );
535 if ($self->endpoint == CLIENT and ! $disconnect) {
536 $self->queue_wait(0);
539 if($self->stateless && $self->state != CONNECTED) {
541 $logger->debug("AppSession is stateless in send", DEBUG );
544 if( !$self->stateless and $self->state != CONNECTED ) {
546 $logger->debug( "Sending connect before request 1", INTERNAL );
548 unless (($self->state == CONNECTING && $connecting )) {
549 $logger->debug( "Sending connect before request 2", INTERNAL );
550 my $v = $self->connect();
552 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
555 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
562 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
565 $self->{peer_handle}->send(
566 to => $self->remote_id,
567 thread => $self->session_id,
568 body => $doc->toString );
571 $self->state( DISCONNECTED );
574 return $self->app_request( $tT );
581 return undef unless (defined $tT);
582 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
587 sub remove_app_request {
591 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
593 $self->{request_queue} = \@list;
597 return $_[0]->{endpoint};
603 return $self->{session_id};
609 my $req = $self->app_request($resp->[1]);
610 return $req->push_queue( $resp->[0] ) if ($req);
611 push @{ $self->{recv_queue} }, $resp->[0];
614 sub last_threadTrace {
616 my $new_last_threadTrace = shift;
618 my $old_last_threadTrace = $self->{last_threadTrace};
619 if (defined $new_last_threadTrace) {
620 $self->{last_threadTrace} = $new_last_threadTrace;
621 return $new_last_threadTrace unless ($old_last_threadTrace);
624 return $old_last_threadTrace;
627 sub session_threadTrace {
629 my $new_last_threadTrace = shift;
631 my $old_last_threadTrace = $self->{session_threadTrace};
632 if (defined $new_last_threadTrace) {
633 $self->{session_threadTrace} = $new_last_threadTrace;
634 return $new_last_threadTrace unless ($old_last_threadTrace);
637 return $old_last_threadTrace;
640 sub last_message_type {
642 my $new_last_message_type = shift;
644 my $old_last_message_type = $self->{last_message_type};
645 if (defined $new_last_message_type) {
646 $self->{last_message_type} = $new_last_message_type;
647 return $new_last_message_type unless ($old_last_message_type);
650 return $old_last_message_type;
653 sub last_message_api_level {
655 my $new_last_message_api_level = shift;
657 my $old_last_message_api_level = $self->{last_message_api_level};
658 if (defined $new_last_message_api_level) {
659 $self->{last_message_api_level} = $new_last_message_api_level;
660 return $new_last_message_api_level unless ($old_last_message_api_level);
663 return $old_last_message_api_level;
668 my $new_remote_id = shift;
670 my $old_remote_id = $self->{remote_id};
671 if (defined $new_remote_id) {
672 $self->{remote_id} = $new_remote_id;
673 return $new_remote_id unless ($old_remote_id);
676 return $old_remote_id;
684 my $old_ua = $self->{client_auth};
685 if (defined $new_ua) {
686 $self->{client_auth} = $new_ua;
687 return $new_ua unless ($old_ua);
690 return $old_ua->cloneNode(1);
695 my $new_state = shift;
697 my $old_state = $self->{state};
698 if (defined $new_state) {
699 $self->{state} = $new_state;
700 return $new_state unless ($old_state);
708 delete $$self{$_} for keys %$self;
718 if ( !(@proto_args % 2) ) {
720 } elsif (@proto_args == 1) {
721 %args = ( timeout => @proto_args );
725 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
727 if( exists( $args{timeout} ) ) {
728 $args{timeout} = int($args{timeout});
733 #$args{timeout} = 0 if ($self->complete);
735 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
739 my $avail = @{ $self->{recv_queue} };
740 my $time_remaining = $args{timeout};
742 while ( $avail < $args{count} and $time_remaining > 0 ) {
743 last if $self->complete;
744 my $starttime = time;
745 $self->queue_wait($time_remaining);
747 $time_remaining -= ($endtime - $starttime);
748 $avail = @{ $self->{recv_queue} };
751 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
754 while ( my $msg = shift @{ $self->{recv_queue} } ) {
756 last if (scalar(@list) >= $args{count});
759 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
760 $logger->debug( "Number of matched responses: " . @list, DEBUG );
762 $self->queue_wait(0); # check for statuses
764 return $list[0] unless (wantarray);
770 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
775 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
776 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
777 $req->resend unless $req->complete;
784 if( ! $self->{peer_handle} ) { return 0; }
785 my $timeout = shift || 0;
786 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
787 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
788 my $o = $self->{peer_handle}->process($timeout);
789 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
797 foreach my $msg ( @{$self->{recv_queue}} ) {
798 $string = $string . $msg->toString(1) . "\n";
806 $self->send( 'STATUS', @_ );
809 #-------------------------------------------------------------------------------
811 package OpenSRF::AppRequest;
812 use base qw/OpenSRF::AppSession/;
813 use OpenSRF::Utils::Logger qw/:level/;
814 use OpenSRF::DomainObject::oilsResponse qw/:status/;
818 $class = ref($class) || $class;
821 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
824 my $self = { session => $session,
825 threadTrace => $threadTrace,
831 bless $self => $class;
833 push @{ $self->session->{request_queue} }, $self;
839 my $size = @{$_[0]->{recv_queue}};
845 return unless ($self and $self->session);
846 $self->session->send(@_);
851 return unless $self->session;
852 $self->session->remove_app_request($self);
853 delete($$self{$_}) for (keys %$self);
857 return shift()->{session};
862 my $complete = shift;
863 return $self->{complete} if ($self->{complete});
864 if (defined $complete) {
865 $self->{complete} = $complete;
867 $self->session->queue_wait(0);
869 return $self->{complete};
874 my $timeout = shift || 1;
875 my $time_remaining = $timeout;
877 while ( ! $self->complete and $time_remaining > 0 ) {
878 my $starttime = time;
879 $self->queue_wait($time_remaining);
881 $time_remaining -= ($endtime - $starttime);
884 return $self->complete;
888 return shift()->{threadTrace};
894 if( !$resp ) { return 0; }
895 if( UNIVERSAL::isa($resp, "Error")) {
896 $self->{failed} = $resp;
898 #return; eventually...
900 push @{ $self->{recv_queue} }, $resp;
901 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
906 return $self->{failed};
911 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
912 return $self->session->queue_wait(@_)
915 sub payload { return shift()->{payload}; }
919 return unless ($self and $self->session);
920 return if $self->complete;
921 OpenSRF::Utils::Logger->debug(
922 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
924 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
926 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
932 return unless ($self and $self->session);
933 $self->session->send( 'STATUS',$msg, $self->threadTrace );
939 return unless ($self and $self->session);
942 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
945 $response = new OpenSRF::DomainObject::oilsResult;
946 $response->content($msg);
949 $self->session->send('RESULT', $response, $self->threadTrace);
952 sub respond_complete {
957 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
960 $response = new OpenSRF::DomainObject::oilsResult;
961 $response->content($msg);
964 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
965 statusCode => STATUS_COMPLETE(),
966 status => 'Request Complete' );
968 return unless ($self and $self->session);
969 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
973 sub register_death_callback {
976 $self->session->register_callback( death => $cb );
980 # utility method. checks to see of the request failed.
981 # if so, throws an OpenSRF::EX::ERROR. if everything is
982 # ok, it returns the content of the request
986 $self->wait_complete;
987 my $resp = $self->recv( timeout => 60 );
988 if( $self->failed() ) {
989 throw OpenSRF::EX::ERROR
990 ($self->failed()->stringify());
992 if(!$resp) { return undef; }
993 my $content = $resp->content;
994 if($finish) { $self->finish();}
999 package OpenSRF::AppSubrequest;
1004 push @{$$self{resp}}, $resp if (defined $resp);
1006 sub respond_complete { respond(@_); }
1009 return bless({resp => []}, 'OpenSRF::AppSubrequest');
1012 sub responses { @{$_[0]->{resp}} }