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 );
485 my $doc = OpenSRF::DOM->createDocument();
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" ) {
508 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
512 my $msg = OpenSRF::DomainObject::oilsMessage->new();
513 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
515 $msg->type($msg_type);
516 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
518 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
521 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
524 if ($msg->type eq 'REQUEST') {
525 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
526 $msg->update_threadTrace;
527 $self->session_threadTrace( $msg->threadTrace );
528 $tT = $self->session_threadTrace;
529 OpenSRF::AppRequest->new($self, $payload);
533 $msg->api_level($self->api_level);
534 $msg->payload($payload) if $payload;
536 $doc->documentElement->appendChild( $msg );
539 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
540 " with threadTrace [".$msg->threadTrace."]", INFO );
544 if ($self->endpoint == CLIENT and ! $disconnect) {
545 $self->queue_wait(0);
548 if($self->stateless && $self->state != CONNECTED) {
550 $logger->debug("AppSession is stateless in send", DEBUG );
553 if( !$self->stateless and $self->state != CONNECTED ) {
555 $logger->debug( "Sending connect before request 1", INTERNAL );
557 unless (($self->state == CONNECTING && $connecting )) {
558 $logger->debug( "Sending connect before request 2", INTERNAL );
559 my $v = $self->connect();
561 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
564 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
571 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
574 $self->{peer_handle}->send(
575 to => $self->remote_id,
576 thread => $self->session_id,
577 body => $doc->toString );
580 $self->state( DISCONNECTED );
583 return $self->app_request( $tT );
590 return undef unless (defined $tT);
591 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
596 sub remove_app_request {
600 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
602 $self->{request_queue} = \@list;
606 return $_[0]->{endpoint};
612 return $self->{session_id};
618 my $req = $self->app_request($resp->[1]);
619 return $req->push_queue( $resp->[0] ) if ($req);
620 push @{ $self->{recv_queue} }, $resp->[0];
623 sub last_threadTrace {
625 my $new_last_threadTrace = shift;
627 my $old_last_threadTrace = $self->{last_threadTrace};
628 if (defined $new_last_threadTrace) {
629 $self->{last_threadTrace} = $new_last_threadTrace;
630 return $new_last_threadTrace unless ($old_last_threadTrace);
633 return $old_last_threadTrace;
636 sub session_threadTrace {
638 my $new_last_threadTrace = shift;
640 my $old_last_threadTrace = $self->{session_threadTrace};
641 if (defined $new_last_threadTrace) {
642 $self->{session_threadTrace} = $new_last_threadTrace;
643 return $new_last_threadTrace unless ($old_last_threadTrace);
646 return $old_last_threadTrace;
649 sub last_message_type {
651 my $new_last_message_type = shift;
653 my $old_last_message_type = $self->{last_message_type};
654 if (defined $new_last_message_type) {
655 $self->{last_message_type} = $new_last_message_type;
656 return $new_last_message_type unless ($old_last_message_type);
659 return $old_last_message_type;
662 sub last_message_api_level {
664 my $new_last_message_api_level = shift;
666 my $old_last_message_api_level = $self->{last_message_api_level};
667 if (defined $new_last_message_api_level) {
668 $self->{last_message_api_level} = $new_last_message_api_level;
669 return $new_last_message_api_level unless ($old_last_message_api_level);
672 return $old_last_message_api_level;
677 my $new_remote_id = shift;
679 my $old_remote_id = $self->{remote_id};
680 if (defined $new_remote_id) {
681 $self->{remote_id} = $new_remote_id;
682 return $new_remote_id unless ($old_remote_id);
685 return $old_remote_id;
693 my $old_ua = $self->{client_auth};
694 if (defined $new_ua) {
695 $self->{client_auth} = $new_ua;
696 return $new_ua unless ($old_ua);
699 return $old_ua->cloneNode(1);
704 my $new_state = shift;
706 my $old_state = $self->{state};
707 if (defined $new_state) {
708 $self->{state} = $new_state;
709 return $new_state unless ($old_state);
717 delete $$self{$_} for keys %$self;
727 if ( !(@proto_args % 2) ) {
729 } elsif (@proto_args == 1) {
730 %args = ( timeout => @proto_args );
734 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
736 if( exists( $args{timeout} ) ) {
737 $args{timeout} = int($args{timeout});
738 $self->{recv_timeout} = $args{timeout};
741 #$args{timeout} = 0 if ($self->complete);
743 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
747 my $avail = @{ $self->{recv_queue} };
748 $self->{remaining_recv_timeout} = $self->{recv_timeout};
750 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
751 last if $self->complete;
752 my $starttime = time;
753 $self->queue_wait($self->{remaining_recv_timeout});
755 if ($self->{timeout_reset}) {
756 $self->{timeout_reset} = 0;
758 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
760 $avail = @{ $self->{recv_queue} };
763 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
766 while ( my $msg = shift @{ $self->{recv_queue} } ) {
768 last if (scalar(@list) >= $args{count});
771 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
772 $logger->debug( "Number of matched responses: " . @list, DEBUG );
774 $self->queue_wait(0); # check for statuses
776 return $list[0] unless (wantarray);
782 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
787 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
788 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
789 $req->resend unless $req->complete;
796 if( ! $self->{peer_handle} ) { return 0; }
797 my $timeout = shift || 0;
798 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
799 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
800 my $o = $self->{peer_handle}->process($timeout);
801 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
809 foreach my $msg ( @{$self->{recv_queue}} ) {
810 $string = $string . $msg->toString(1) . "\n";
818 $self->send( 'STATUS', @_ );
821 sub reset_request_timeout {
824 my $req = $self->app_request($tt);
825 $req->{remaining_recv_timeout} = $req->{recv_timeout};
826 $req->{timout_reset} = 1;
829 #-------------------------------------------------------------------------------
831 package OpenSRF::AppRequest;
832 use base qw/OpenSRF::AppSession/;
833 use OpenSRF::Utils::Logger qw/:level/;
834 use OpenSRF::DomainObject::oilsResponse qw/:status/;
838 $class = ref($class) || $class;
841 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
844 my $self = { session => $session,
845 threadTrace => $threadTrace,
850 remaining_recv_timeout => 30,
854 bless $self => $class;
856 push @{ $self->session->{request_queue} }, $self;
862 my $size = @{$_[0]->{recv_queue}};
868 return unless ($self and $self->session and !$self->complete);
869 $self->session->send(@_);
874 return unless $self->session;
875 $self->session->remove_app_request($self);
876 delete($$self{$_}) for (keys %$self);
880 return shift()->{session};
885 my $complete = shift;
886 return $self->{complete} if ($self->{complete});
887 if (defined $complete) {
888 $self->{complete} = $complete;
890 $self->session->queue_wait(0);
892 return $self->{complete};
897 my $timeout = shift || 1;
898 my $time_remaining = $timeout;
900 while ( ! $self->complete and $time_remaining > 0 ) {
901 my $starttime = time;
902 $self->queue_wait($time_remaining);
904 $time_remaining -= ($endtime - $starttime);
907 return $self->complete;
911 return shift()->{threadTrace};
917 if( !$resp ) { return 0; }
918 if( UNIVERSAL::isa($resp, "Error")) {
919 $self->{failed} = $resp;
921 #return; eventually...
923 push @{ $self->{recv_queue} }, $resp;
924 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
929 return $self->{failed};
934 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
935 return $self->session->queue_wait(@_)
938 sub payload { return shift()->{payload}; }
942 return unless ($self and $self->session and !$self->complete);
943 OpenSRF::Utils::Logger->debug(
944 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
946 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
948 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
954 return unless ($self and $self->session and !$self->complete);
955 $self->session->send( 'STATUS',$msg, $self->threadTrace );
961 return unless ($self and $self->session and !$self->complete);
964 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
967 $response = new OpenSRF::DomainObject::oilsResult;
968 $response->content($msg);
971 $self->session->send('RESULT', $response, $self->threadTrace);
974 sub respond_complete {
977 return unless ($self and $self->session and !$self->complete);
980 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
983 $response = new OpenSRF::DomainObject::oilsResult;
984 $response->content($msg);
987 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
988 statusCode => STATUS_COMPLETE(),
989 status => 'Request Complete' );
992 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
996 sub register_death_callback {
999 $self->session->register_callback( death => $cb );
1003 # utility method. checks to see of the request failed.
1004 # if so, throws an OpenSRF::EX::ERROR. if everything is
1005 # ok, it returns the content of the request
1009 $self->wait_complete;
1010 my $resp = $self->recv( timeout => 60 );
1011 if( $self->failed() ) {
1012 throw OpenSRF::EX::ERROR
1013 ($self->failed()->stringify());
1015 if(!$resp) { return undef; }
1016 my $content = $resp->content;
1017 if($finish) { $self->finish();}
1022 package OpenSRF::AppSubrequest;
1027 push @{$$self{resp}}, $resp if (defined $resp);
1029 sub respond_complete { respond(@_); }
1032 return bless({resp => []}, 'OpenSRF::AppSubrequest');
1035 sub responses { @{$_[0]->{resp}} }