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 warn "Missing args to server_build():\n" .
100 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
101 unless ($sess_id and $remote_id and $service);
103 return undef unless ($sess_id and $remote_id and $service);
105 if ( my $thingy = $class->find($sess_id) ) {
106 $thingy->remote_id( $remote_id );
107 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
110 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
113 if( $service eq "client" ) {
114 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
115 # " Session ID [$sess_id], remote_id [$remote_id]");
117 warn "Attempting to build a client session as ".
118 "a server Session ID [$sess_id], remote_id [$remote_id]";
120 $logger->debug("Attempting to build a client session as ".
121 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
126 my $config_client = OpenSRF::Utils::SettingsClient->new();
127 my $stateless = $config_client->config_value("apps", $service, "stateless");
129 #my $max_requests = $conf->$service->max_requests;
130 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
131 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
133 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
135 my $self = bless { recv_queue => [],
142 session_id => $sess_id,
143 remote_id => $remote_id,
144 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
145 max_requests => $max_requests,
146 session_threadTrace => 0,
148 stateless => $stateless,
151 return $_CACHE{$sess_id} = $self;
156 my ($name, $datum) = @_;
158 $self->{session_data}->{$name} = $datum if (defined $datum);
159 return $self->{session_data}->{$name};
162 sub service { return shift()->{service}; }
164 sub continue_request {
166 $self->{'requests'}++;
167 return 1 if (!$self->{'max_requests'});
168 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
171 sub last_sent_payload {
172 my( $self, $payload ) = @_;
174 return $self->{'last_sent_payload'} = $payload;
176 return $self->{'last_sent_payload'};
180 my( $self, $type ) = @_;
182 return $self->{'last_sent_type'} = $type;
184 return $self->{'last_sent_type'};
187 sub get_app_targets {
190 my $conf = OpenSRF::Utils::Config->current;
191 my $router_name = $conf->bootstrap->router_name || 'router';
192 my $routers = $conf->bootstrap->domains;
194 unless($router_name and $routers) {
195 throw OpenSRF::EX::Config
196 ("Missing router config information 'router_name' and 'routers'");
200 for my $router (@$routers) {
201 push @targets, "$router_name\@$router/$app";
209 if($self) {return $self->{stateless};}
212 # When we're a client and we want to connect to a remote service
213 # create( $app, username => $user, secret => $passwd );
215 # create( $app, sysname => $user, secret => $shared_secret );
218 $class = ref($class) || $class;
224 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
226 "AppSession returning existing client session for $app", DEBUG );
229 $logger->debug( "AppSession creating new client session for $app", DEBUG );
233 my $c = OpenSRF::Utils::SettingsClient->new();
234 # we can get an infinite loop if we're grabbing the settings and we
235 # need the settings to grab the settings...
236 if($app ne "opensrf.settings" || $c->has_config()) {
237 $stateless = $c->config_value("apps", $app, "stateless");
240 my $sess_id = time . rand( $$ );
241 while ( $class->find($sess_id) ) {
242 $sess_id = time . rand( $$ );
246 my ($r_id) = get_app_targets($app);
248 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
249 if( ! $peer_handle ) {
250 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
253 my $self = bless { app_name => $app,
254 #client_auth => $auth,
258 state => DISCONNECTED,#since we're init'ing
259 session_id => $sess_id,
262 orig_remote_id => $r_id,
263 peer_handle => $peer_handle,
264 session_threadTrace => 0,
265 stateless => $stateless,
268 $self->client_cache();
269 $_CACHE{$sess_id} = $self;
270 return $self->find_client( $app );
274 return shift()->{api_level};
278 return shift()->{app_name};
283 $self->remote_id($$self{orig_remote_id});
286 # 'connect' can be used as a constructor if called as a class method,
287 # or used to connect a session that has disconnectd if called against
288 # an existing session that seems to be disconnected, or was just built
289 # using 'create' above.
291 # connect( $app, username => $user, secret => $passwd );
293 # connect( $app, sysname => $user, secret => $shared_secret );
295 # --- Returns undef if the connect attempt times out.
296 # --- Returns the OpenSRF::EX object if one is returned by the server
297 # --- Returns self if connected
300 my $class = ref($self) || $self;
303 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
304 $logger->transport("AppSession already connected", DEBUG );
306 $logger->transport("AppSession not connected, connecting..", DEBUG );
308 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
312 my $api_level = shift;
313 $api_level = 1 unless (defined $api_level);
315 $self = $class->create($app, @_) if (!ref($self));
318 return undef unless ($self);
320 $self->{api_level} = $api_level;
323 $self->state(CONNECTING);
324 $self->send('CONNECT', "");
326 # if we want to connect to settings, we may not have
327 # any data for the settings client to work with...
328 # just using a default for now XXX
330 my $time_remaining = 5;
333 my $client = OpenSRF::Utils::SettingsClient->new();
334 my $trans = $client->config_value("client_connection","transport_host");
337 $time_remaining = $trans->{connect_timeout};
339 # XXX for now, just use the first
340 $time_remaining = $trans->[0]->{connect_timeout};
344 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
345 my $starttime = time;
346 $self->queue_wait($time_remaining);
348 $time_remaining -= ($endtime - $starttime);
351 return undef unless($self->state == CONNECTED);
358 if( ! $self->session_id ) {
361 #$self->disconnect if ($self->endpoint == CLIENT);
362 for my $ses ( @_CLIENT_CACHE ) {
363 if ($ses->[2]->session_id eq $self->session_id) {
369 sub unregister_callback {
373 if (exists $self->{callbacks}{$type}) {
374 delete $self->{callbacks}{$type}{$cb};
380 sub register_callback {
385 $self->{callbacks}{$type}{$cb_key} = $cb;
391 if( ! $self->session_id ) { return 0; }
393 # run each 'death' callback;
394 if (exists $self->{callbacks}{death}) {
395 for my $sub (values %{$self->{callbacks}{death}}) {
401 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
403 for my $ses ( @_CLIENT_CACHE ) {
405 if ($ses->[2]->session_id ne $self->session_id);
408 delete $_CACHE{$self->session_id};
409 delete($$self{$_}) for (keys %$self);
415 # run each 'disconnect' callback;
416 if (exists $self->{callbacks}{disconnect}) {
417 for my $sub (values %{$self->{callbacks}{disconnect}}) {
422 if( $self->stateless and $self->state != CONNECTED ) {
427 unless( $self->state == DISCONNECTED ) {
428 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
429 $self->state( DISCONNECTED );
442 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
447 $method->params( @_ );
449 $self->send('REQUEST',$method);
458 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
463 $method->params( @_ );
465 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
470 my @payload_list = @_; # this is a Domain Object
472 return unless ($self and $self->{peer_handle});
474 $logger->debug( "In send", INTERNAL );
478 if( @payload_list % 2 ) { $tT = pop @payload_list; }
480 if( ! @payload_list ) {
481 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
487 $logger->debug( "In send2", INTERNAL );
492 while( @payload_list ) {
494 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
496 if ($msg_type eq 'DISCONNECT' ) {
498 if( $self->state == DISCONNECTED && !$connecting) {
503 if( $msg_type eq "CONNECT" ) {
507 my $msg = OpenSRF::DomainObject::oilsMessage->new();
508 $msg->type($msg_type);
511 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
514 if ($msg->type eq 'REQUEST') {
515 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
516 $msg->update_threadTrace;
517 $self->session_threadTrace( $msg->threadTrace );
518 $tT = $self->session_threadTrace;
519 OpenSRF::AppRequest->new($self, $payload);
523 $msg->api_level($self->api_level);
524 $msg->payload($payload) if $payload;
529 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
530 " with threadTrace [".$msg->threadTrace."]", INFO );
534 if ($self->endpoint == CLIENT and ! $disconnect) {
535 $self->queue_wait(0);
538 if($self->stateless && $self->state != CONNECTED) {
540 $logger->debug("AppSession is stateless in send", DEBUG );
543 if( !$self->stateless and $self->state != CONNECTED ) {
545 $logger->debug( "Sending connect before request 1", INTERNAL );
547 unless (($self->state == CONNECTING && $connecting )) {
548 $logger->debug( "Sending connect before request 2", INTERNAL );
549 my $v = $self->connect();
551 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
554 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
561 $logger->debug( "AppSession sending doc: " . JSON->perl2JSON(\@doc), INTERNAL );
564 $self->{peer_handle}->send(
565 to => $self->remote_id,
566 thread => $self->session_id,
567 body => JSON->perl2JSON(\@doc) );
570 $self->state( DISCONNECTED );
573 return $self->app_request( $tT );
580 return undef unless (defined $tT);
581 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
586 sub remove_app_request {
590 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
592 $self->{request_queue} = \@list;
596 return $_[0]->{endpoint};
602 return $self->{session_id};
608 my $req = $self->app_request($resp->[1]);
609 return $req->push_queue( $resp->[0] ) if ($req);
610 push @{ $self->{recv_queue} }, $resp->[0];
613 sub last_threadTrace {
615 my $new_last_threadTrace = shift;
617 my $old_last_threadTrace = $self->{last_threadTrace};
618 if (defined $new_last_threadTrace) {
619 $self->{last_threadTrace} = $new_last_threadTrace;
620 return $new_last_threadTrace unless ($old_last_threadTrace);
623 return $old_last_threadTrace;
626 sub session_threadTrace {
628 my $new_last_threadTrace = shift;
630 my $old_last_threadTrace = $self->{session_threadTrace};
631 if (defined $new_last_threadTrace) {
632 $self->{session_threadTrace} = $new_last_threadTrace;
633 return $new_last_threadTrace unless ($old_last_threadTrace);
636 return $old_last_threadTrace;
639 sub last_message_type {
641 my $new_last_message_type = shift;
643 my $old_last_message_type = $self->{last_message_type};
644 if (defined $new_last_message_type) {
645 $self->{last_message_type} = $new_last_message_type;
646 return $new_last_message_type unless ($old_last_message_type);
649 return $old_last_message_type;
652 sub last_message_api_level {
654 my $new_last_message_api_level = shift;
656 my $old_last_message_api_level = $self->{last_message_api_level};
657 if (defined $new_last_message_api_level) {
658 $self->{last_message_api_level} = $new_last_message_api_level;
659 return $new_last_message_api_level unless ($old_last_message_api_level);
662 return $old_last_message_api_level;
667 my $new_remote_id = shift;
669 my $old_remote_id = $self->{remote_id};
670 if (defined $new_remote_id) {
671 $self->{remote_id} = $new_remote_id;
672 return $new_remote_id unless ($old_remote_id);
675 return $old_remote_id;
683 my $old_ua = $self->{client_auth};
684 if (defined $new_ua) {
685 $self->{client_auth} = $new_ua;
686 return $new_ua unless ($old_ua);
689 return $old_ua->cloneNode(1);
694 my $new_state = shift;
696 my $old_state = $self->{state};
697 if (defined $new_state) {
698 $self->{state} = $new_state;
699 return $new_state unless ($old_state);
707 delete $$self{$_} for keys %$self;
717 if ( !(@proto_args % 2) ) {
719 } elsif (@proto_args == 1) {
720 %args = ( timeout => @proto_args );
724 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
726 if( exists( $args{timeout} ) ) {
727 $args{timeout} = int($args{timeout});
728 $self->{recv_timeout} = $args{timeout};
731 #$args{timeout} = 0 if ($self->complete);
733 if(defined($args{timeout})) {
734 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
739 my $avail = @{ $self->{recv_queue} };
740 $self->{remaining_recv_timeout} = $self->{recv_timeout};
742 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
743 last if $self->complete;
744 my $starttime = time;
745 $self->queue_wait($self->{remaining_recv_timeout});
747 if ($self->{timeout_reset}) {
748 $self->{timeout_reset} = 0;
750 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
752 $avail = @{ $self->{recv_queue} };
757 while ( my $msg = shift @{ $self->{recv_queue} } ) {
759 last if (scalar(@list) >= $args{count});
762 $logger->debug( "Number of matched responses: " . @list, DEBUG );
763 $self->queue_wait(0); # check for statuses
765 return $list[0] unless (wantarray);
771 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
776 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
777 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
778 $req->resend unless $req->complete;
785 if( ! $self->{peer_handle} ) { return 0; }
786 my $timeout = shift || 0;
787 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
788 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
789 my $o = $self->{peer_handle}->process($timeout);
790 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
798 foreach my $msg ( @{$self->{recv_queue}} ) {
799 $string = $string . $msg->toString(1) . "\n";
807 $self->send( 'STATUS', @_ );
810 sub reset_request_timeout {
813 my $req = $self->app_request($tt);
814 $req->{remaining_recv_timeout} = $req->{recv_timeout};
815 $req->{timout_reset} = 1;
818 #-------------------------------------------------------------------------------
820 package OpenSRF::AppRequest;
821 use base qw/OpenSRF::AppSession/;
822 use OpenSRF::Utils::Logger qw/:level/;
823 use OpenSRF::DomainObject::oilsResponse qw/:status/;
827 $class = ref($class) || $class;
830 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
833 my $self = { session => $session,
834 threadTrace => $threadTrace,
839 remaining_recv_timeout => 30,
843 bless $self => $class;
845 push @{ $self->session->{request_queue} }, $self;
851 my $size = @{$_[0]->{recv_queue}};
857 return unless ($self and $self->session and !$self->complete);
858 $self->session->send(@_);
863 return unless $self->session;
864 $self->session->remove_app_request($self);
865 delete($$self{$_}) for (keys %$self);
869 return shift()->{session};
874 my $complete = shift;
875 return $self->{complete} if ($self->{complete});
876 if (defined $complete) {
877 $self->{complete} = $complete;
879 $self->session->queue_wait(0);
881 return $self->{complete};
886 my $timeout = shift || 1;
887 my $time_remaining = $timeout;
889 while ( ! $self->complete and $time_remaining > 0 ) {
890 my $starttime = time;
891 $self->queue_wait($time_remaining);
893 $time_remaining -= ($endtime - $starttime);
896 return $self->complete;
900 return shift()->{threadTrace};
906 if( !$resp ) { return 0; }
907 if( UNIVERSAL::isa($resp, "Error")) {
908 $self->{failed} = $resp;
910 #return; eventually...
912 push @{ $self->{recv_queue} }, $resp;
917 return $self->{failed};
922 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
923 return $self->session->queue_wait(@_)
926 sub payload { return shift()->{payload}; }
930 return unless ($self and $self->session and !$self->complete);
931 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
932 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
938 return unless ($self and $self->session and !$self->complete);
939 $self->session->send( 'STATUS',$msg, $self->threadTrace );
945 return unless ($self and $self->session and !$self->complete);
948 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
951 $response = new OpenSRF::DomainObject::oilsResult;
952 $response->content($msg);
955 $self->session->send('RESULT', $response, $self->threadTrace);
958 sub respond_complete {
961 return unless ($self and $self->session and !$self->complete);
964 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
967 $response = new OpenSRF::DomainObject::oilsResult;
968 $response->content($msg);
971 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
972 statusCode => STATUS_COMPLETE(),
973 status => 'Request Complete' );
976 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
980 sub register_death_callback {
983 $self->session->register_callback( death => $cb );
987 # utility method. checks to see of the request failed.
988 # if so, throws an OpenSRF::EX::ERROR. if everything is
989 # ok, it returns the content of the request
993 $self->wait_complete;
994 my $resp = $self->recv( timeout => 60 );
995 if( $self->failed() ) {
996 throw OpenSRF::EX::ERROR
997 ($self->failed()->stringify());
999 if(!$resp) { return undef; }
1000 my $content = $resp->content;
1001 if($finish) { $self->finish();}
1006 package OpenSRF::AppSubrequest;
1011 push @{$$self{resp}}, $resp if (defined $resp);
1013 sub respond_complete { respond(@_); }
1016 return bless({resp => []}, 'OpenSRF::AppSubrequest');
1019 sub responses { @{$_[0]->{resp}} }