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();
67 return $self->state == CONNECTED;
69 # ----------------------------------------------------------------------------
70 # Clears the transport buffers
71 # call this if you are not through with the sesssion, but you want
72 # to have a clean slate. You shouldn't have to call this if
73 # you are correctly 'recv'ing all of the data from a request.
74 # however, if you don't want all of the data, this will
75 # slough off any excess
76 # * * Note: This will delete data for all sessions using this transport
77 # handle. For example, all client sessions use the same handle.
78 # ----------------------------------------------------------------------------
82 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
85 $self->{peer_handle}->buffer_reset();
91 push @_CLIENT_CACHE, [ $self->app, 1, $self ];
94 # when any incoming data is received, this method is called.
97 $class = ref($class) || $class;
100 my $remote_id = shift;
103 warn "Missing args to server_build():\n" .
104 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
105 unless ($sess_id and $remote_id and $service);
107 return undef unless ($sess_id and $remote_id and $service);
109 if ( my $thingy = $class->find($sess_id) ) {
110 $thingy->remote_id( $remote_id );
111 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
114 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
117 if( $service eq "client" ) {
118 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
119 # " Session ID [$sess_id], remote_id [$remote_id]");
121 warn "Attempting to build a client session as ".
122 "a server Session ID [$sess_id], remote_id [$remote_id]";
124 $logger->debug("Attempting to build a client session as ".
125 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
130 my $config_client = OpenSRF::Utils::SettingsClient->new();
131 my $stateless = $config_client->config_value("apps", $service, "stateless");
133 #my $max_requests = $conf->$service->max_requests;
134 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
135 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
137 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
139 my $self = bless { recv_queue => [],
146 session_id => $sess_id,
147 remote_id => $remote_id,
148 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
149 max_requests => $max_requests,
150 session_threadTrace => 0,
152 stateless => $stateless,
155 return $_CACHE{$sess_id} = $self;
160 my ($name, $datum) = @_;
162 $self->{session_data}->{$name} = $datum if (defined $datum);
163 return $self->{session_data}->{$name};
166 sub service { return shift()->{service}; }
168 sub continue_request {
170 $self->{'requests'}++;
171 return 1 if (!$self->{'max_requests'});
172 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
175 sub last_sent_payload {
176 my( $self, $payload ) = @_;
178 return $self->{'last_sent_payload'} = $payload;
180 return $self->{'last_sent_payload'};
184 my( $self, $type ) = @_;
186 return $self->{'last_sent_type'} = $type;
188 return $self->{'last_sent_type'};
191 sub get_app_targets {
194 my $conf = OpenSRF::Utils::Config->current;
195 my $router_name = $conf->bootstrap->router_name || 'router';
196 my $routers = $conf->bootstrap->domains;
198 unless($router_name and $routers) {
199 throw OpenSRF::EX::Config
200 ("Missing router config information 'router_name' and 'routers'");
204 for my $router (@$routers) {
205 push @targets, "$router_name\@$router/$app";
213 if($self) {return $self->{stateless};}
216 # When we're a client and we want to connect to a remote service
217 # create( $app, username => $user, secret => $passwd );
219 # create( $app, sysname => $user, secret => $shared_secret );
222 $class = ref($class) || $class;
228 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
230 "AppSession returning existing client session for $app", DEBUG );
233 $logger->debug( "AppSession creating new client session for $app", DEBUG );
237 my $c = OpenSRF::Utils::SettingsClient->new();
238 # we can get an infinite loop if we're grabbing the settings and we
239 # need the settings to grab the settings...
240 if($app ne "opensrf.settings" || $c->has_config()) {
241 $stateless = $c->config_value("apps", $app, "stateless");
244 my $sess_id = time . rand( $$ );
245 while ( $class->find($sess_id) ) {
246 $sess_id = time . rand( $$ );
250 my ($r_id) = get_app_targets($app);
252 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
253 if( ! $peer_handle ) {
254 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
257 my $self = bless { app_name => $app,
258 #client_auth => $auth,
262 state => DISCONNECTED,#since we're init'ing
263 session_id => $sess_id,
266 orig_remote_id => $r_id,
267 peer_handle => $peer_handle,
268 session_threadTrace => 0,
269 stateless => $stateless,
272 $self->client_cache();
273 $_CACHE{$sess_id} = $self;
274 return $self->find_client( $app );
278 return shift()->{api_level};
282 return shift()->{app_name};
287 $self->remote_id($$self{orig_remote_id});
290 # 'connect' can be used as a constructor if called as a class method,
291 # or used to connect a session that has disconnectd if called against
292 # an existing session that seems to be disconnected, or was just built
293 # using 'create' above.
295 # connect( $app, username => $user, secret => $passwd );
297 # connect( $app, sysname => $user, secret => $shared_secret );
299 # --- Returns undef if the connect attempt times out.
300 # --- Returns the OpenSRF::EX object if one is returned by the server
301 # --- Returns self if connected
304 my $class = ref($self) || $self;
307 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
308 $logger->transport("AppSession already connected", DEBUG );
310 $logger->transport("AppSession not connected, connecting..", DEBUG );
312 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
316 my $api_level = shift;
317 $api_level = 1 unless (defined $api_level);
319 $self = $class->create($app, @_) if (!ref($self));
322 return undef unless ($self);
324 $self->{api_level} = $api_level;
327 $self->state(CONNECTING);
328 $self->send('CONNECT', "");
330 # if we want to connect to settings, we may not have
331 # any data for the settings client to work with...
332 # just using a default for now XXX
334 my $time_remaining = 5;
337 my $client = OpenSRF::Utils::SettingsClient->new();
338 my $trans = $client->config_value("client_connection","transport_host");
341 $time_remaining = $trans->{connect_timeout};
343 # XXX for now, just use the first
344 $time_remaining = $trans->[0]->{connect_timeout};
348 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
349 my $starttime = time;
350 $self->queue_wait($time_remaining);
352 $time_remaining -= ($endtime - $starttime);
355 return undef unless($self->state == CONNECTED);
362 if( ! $self->session_id ) {
365 #$self->disconnect if ($self->endpoint == CLIENT);
366 for my $ses ( @_CLIENT_CACHE ) {
367 if ($ses->[2]->session_id eq $self->session_id) {
373 sub unregister_callback {
377 if (exists $self->{callbacks}{$type}) {
378 delete $self->{callbacks}{$type}{$cb};
384 sub register_callback {
389 $self->{callbacks}{$type}{$cb_key} = $cb;
395 if( ! $self->session_id ) { return 0; }
397 # run each 'death' callback;
398 if (exists $self->{callbacks}{death}) {
399 for my $sub (values %{$self->{callbacks}{death}}) {
405 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
407 for my $ses ( @_CLIENT_CACHE ) {
409 if ($ses->[2]->session_id ne $self->session_id);
412 delete $_CACHE{$self->session_id};
413 delete($$self{$_}) for (keys %$self);
419 # run each 'disconnect' callback;
420 if (exists $self->{callbacks}{disconnect}) {
421 for my $sub (values %{$self->{callbacks}{disconnect}}) {
426 if( $self->stateless and $self->state != CONNECTED ) {
431 unless( $self->state == DISCONNECTED ) {
432 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
433 $self->state( DISCONNECTED );
446 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
451 $method->params( @_ );
453 $self->send('REQUEST',$method);
462 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
467 $method->params( @_ );
469 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
474 my @payload_list = @_; # this is a Domain Object
476 return unless ($self and $self->{peer_handle});
478 $logger->debug( "In send", INTERNAL );
482 if( @payload_list % 2 ) { $tT = pop @payload_list; }
484 if( ! @payload_list ) {
485 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
491 $logger->debug( "In send2", INTERNAL );
496 while( @payload_list ) {
498 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
500 if ($msg_type eq 'DISCONNECT' ) {
502 if( $self->state == DISCONNECTED && !$connecting) {
507 if( $msg_type eq "CONNECT" ) {
511 my $msg = OpenSRF::DomainObject::oilsMessage->new();
512 $msg->type($msg_type);
515 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
518 if ($msg->type eq 'REQUEST') {
519 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
520 $msg->update_threadTrace;
521 $self->session_threadTrace( $msg->threadTrace );
522 $tT = $self->session_threadTrace;
523 OpenSRF::AppRequest->new($self, $payload);
527 $msg->api_level($self->api_level);
528 $msg->payload($payload) if $payload;
533 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
534 " with threadTrace [".$msg->threadTrace."]", INFO );
538 if ($self->endpoint == CLIENT and ! $disconnect) {
539 $self->queue_wait(0);
542 if($self->stateless && $self->state != CONNECTED) {
544 $logger->debug("AppSession is stateless in send", DEBUG );
547 if( !$self->stateless and $self->state != CONNECTED ) {
549 $logger->debug( "Sending connect before request 1", INTERNAL );
551 unless (($self->state == CONNECTING && $connecting )) {
552 $logger->debug( "Sending connect before request 2", INTERNAL );
553 my $v = $self->connect();
555 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
558 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
565 $logger->debug( "AppSession sending doc: " . JSON->perl2JSON(\@doc), INTERNAL );
568 $self->{peer_handle}->send(
569 to => $self->remote_id,
570 thread => $self->session_id,
571 body => JSON->perl2JSON(\@doc) );
574 $self->state( DISCONNECTED );
577 return $self->app_request( $tT );
584 return undef unless (defined $tT);
585 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
590 sub remove_app_request {
594 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
596 $self->{request_queue} = \@list;
600 return $_[0]->{endpoint};
606 return $self->{session_id};
612 my $req = $self->app_request($resp->[1]);
613 return $req->push_queue( $resp->[0] ) if ($req);
614 push @{ $self->{recv_queue} }, $resp->[0];
617 sub last_threadTrace {
619 my $new_last_threadTrace = shift;
621 my $old_last_threadTrace = $self->{last_threadTrace};
622 if (defined $new_last_threadTrace) {
623 $self->{last_threadTrace} = $new_last_threadTrace;
624 return $new_last_threadTrace unless ($old_last_threadTrace);
627 return $old_last_threadTrace;
630 sub session_threadTrace {
632 my $new_last_threadTrace = shift;
634 my $old_last_threadTrace = $self->{session_threadTrace};
635 if (defined $new_last_threadTrace) {
636 $self->{session_threadTrace} = $new_last_threadTrace;
637 return $new_last_threadTrace unless ($old_last_threadTrace);
640 return $old_last_threadTrace;
643 sub last_message_type {
645 my $new_last_message_type = shift;
647 my $old_last_message_type = $self->{last_message_type};
648 if (defined $new_last_message_type) {
649 $self->{last_message_type} = $new_last_message_type;
650 return $new_last_message_type unless ($old_last_message_type);
653 return $old_last_message_type;
656 sub last_message_api_level {
658 my $new_last_message_api_level = shift;
660 my $old_last_message_api_level = $self->{last_message_api_level};
661 if (defined $new_last_message_api_level) {
662 $self->{last_message_api_level} = $new_last_message_api_level;
663 return $new_last_message_api_level unless ($old_last_message_api_level);
666 return $old_last_message_api_level;
671 my $new_remote_id = shift;
673 my $old_remote_id = $self->{remote_id};
674 if (defined $new_remote_id) {
675 $self->{remote_id} = $new_remote_id;
676 return $new_remote_id unless ($old_remote_id);
679 return $old_remote_id;
687 my $old_ua = $self->{client_auth};
688 if (defined $new_ua) {
689 $self->{client_auth} = $new_ua;
690 return $new_ua unless ($old_ua);
693 return $old_ua->cloneNode(1);
698 my $new_state = shift;
700 my $old_state = $self->{state};
701 if (defined $new_state) {
702 $self->{state} = $new_state;
703 return $new_state unless ($old_state);
711 delete $$self{$_} for keys %$self;
721 if ( !(@proto_args % 2) ) {
723 } elsif (@proto_args == 1) {
724 %args = ( timeout => @proto_args );
728 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
730 if( exists( $args{timeout} ) ) {
731 $args{timeout} = int($args{timeout});
732 $self->{recv_timeout} = $args{timeout};
735 #$args{timeout} = 0 if ($self->complete);
737 if(defined($args{timeout})) {
738 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
743 my $avail = @{ $self->{recv_queue} };
744 $self->{remaining_recv_timeout} = $self->{recv_timeout};
746 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
747 last if $self->complete;
748 my $starttime = time;
749 $self->queue_wait($self->{remaining_recv_timeout});
751 if ($self->{timeout_reset}) {
752 $self->{timeout_reset} = 0;
754 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
756 $avail = @{ $self->{recv_queue} };
761 while ( my $msg = shift @{ $self->{recv_queue} } ) {
763 last if (scalar(@list) >= $args{count});
766 $logger->debug( "Number of matched responses: " . @list, DEBUG );
767 $self->queue_wait(0); # check for statuses
769 return $list[0] unless (wantarray);
775 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
780 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
781 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
782 $req->resend unless $req->complete;
789 if( ! $self->{peer_handle} ) { return 0; }
790 my $timeout = shift || 0;
791 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
792 my $o = $self->{peer_handle}->process($timeout);
800 foreach my $msg ( @{$self->{recv_queue}} ) {
801 $string = $string . $msg->toString(1) . "\n";
809 $self->send( 'STATUS', @_ );
812 sub reset_request_timeout {
815 my $req = $self->app_request($tt);
816 $req->{remaining_recv_timeout} = $req->{recv_timeout};
817 $req->{timout_reset} = 1;
820 #-------------------------------------------------------------------------------
822 package OpenSRF::AppRequest;
823 use base qw/OpenSRF::AppSession/;
824 use OpenSRF::Utils::Logger qw/:level/;
825 use OpenSRF::DomainObject::oilsResponse qw/:status/;
829 $class = ref($class) || $class;
832 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
835 my $self = { session => $session,
836 threadTrace => $threadTrace,
841 remaining_recv_timeout => 30,
845 bless $self => $class;
847 push @{ $self->session->{request_queue} }, $self;
853 my $size = @{$_[0]->{recv_queue}};
859 return unless ($self and $self->session and !$self->complete);
860 $self->session->send(@_);
865 return unless $self->session;
866 $self->session->remove_app_request($self);
867 delete($$self{$_}) for (keys %$self);
871 return shift()->{session};
876 my $complete = shift;
877 return $self->{complete} if ($self->{complete});
878 if (defined $complete) {
879 $self->{complete} = $complete;
881 $self->session->queue_wait(0);
883 return $self->{complete};
888 my $timeout = shift || 1;
889 my $time_remaining = $timeout;
891 while ( ! $self->complete and $time_remaining > 0 ) {
892 my $starttime = time;
893 $self->queue_wait($time_remaining);
895 $time_remaining -= ($endtime - $starttime);
898 return $self->complete;
902 return shift()->{threadTrace};
908 if( !$resp ) { return 0; }
909 if( UNIVERSAL::isa($resp, "Error")) {
910 $self->{failed} = $resp;
912 #return; eventually...
914 push @{ $self->{recv_queue} }, $resp;
919 return $self->{failed};
924 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
925 return $self->session->queue_wait(@_)
928 sub payload { return shift()->{payload}; }
932 return unless ($self and $self->session and !$self->complete);
933 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
934 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
940 return unless ($self and $self->session and !$self->complete);
941 $self->session->send( 'STATUS',$msg, $self->threadTrace );
947 return unless ($self and $self->session and !$self->complete);
950 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
953 $response = new OpenSRF::DomainObject::oilsResult;
954 $response->content($msg);
957 $self->session->send('RESULT', $response, $self->threadTrace);
960 sub respond_complete {
963 return unless ($self and $self->session and !$self->complete);
966 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
969 $response = new OpenSRF::DomainObject::oilsResult;
970 $response->content($msg);
973 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
974 statusCode => STATUS_COMPLETE(),
975 status => 'Request Complete' );
978 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
982 sub register_death_callback {
985 $self->session->register_callback( death => $cb );
989 # utility method. checks to see of the request failed.
990 # if so, throws an OpenSRF::EX::ERROR. if everything is
991 # ok, it returns the content of the request
995 $self->wait_complete;
996 my $resp = $self->recv( timeout => 60 );
997 if( $self->failed() ) {
998 throw OpenSRF::EX::ERROR
999 ($self->failed()->stringify());
1001 if(!$resp) { return undef; }
1002 my $content = $resp->content;
1003 if($finish) { $self->finish();}
1008 package OpenSRF::AppSubrequest;
1013 push @{$$self{resp}}, $resp if (defined $resp);
1015 sub respond_complete { respond(@_); }
1018 return bless({resp => []}, 'OpenSRF::AppSubrequest');
1021 sub responses { @{$_[0]->{resp}} }