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 my $config_client = OpenSRF::Utils::SettingsClient->new();
103 if ( my $thingy = $class->find($sess_id) ) {
104 $thingy->remote_id( $remote_id );
105 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
108 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
111 if( $service eq "client" ) {
112 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
113 # " Session ID [$sess_id], remote_id [$remote_id]");
114 $logger->debug("Attempting to build a client session as ".
115 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
119 #my $max_requests = $conf->$service->max_requests;
120 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
121 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
123 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
125 my $self = bless { recv_queue => [],
132 session_id => $sess_id,
133 remote_id => $remote_id,
134 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
135 max_requests => $max_requests,
136 session_threadTrace => 0,
140 return $_CACHE{$sess_id} = $self;
145 my ($name, $datum) = @_;
147 $self->{session_data}->{$name} = $datum if (defined $datum);
148 return $self->{session_data}->{$name};
151 sub service { return shift()->{service}; }
153 sub continue_request {
155 $self->{'requests'}++;
156 return 1 if (!$self->{'max_requests'});
157 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
160 sub last_sent_payload {
161 my( $self, $payload ) = @_;
163 return $self->{'last_sent_payload'} = $payload;
165 return $self->{'last_sent_payload'};
169 my( $self, $type ) = @_;
171 return $self->{'last_sent_type'} = $type;
173 return $self->{'last_sent_type'};
176 sub get_app_targets {
179 # my $config_client = OpenSRF::Utils::SettingsClient->new();
181 my $conf = OpenSRF::Utils::Config->current;
182 my $router_name = $conf->bootstrap->router_name;
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";
198 # When we're a client and we want to connect to a remote service
199 # create( $app, username => $user, secret => $passwd );
201 # create( $app, sysname => $user, secret => $shared_secret );
204 $class = ref($class) || $class;
208 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
209 $logger->debug( "AppSession returning existing client session for $app", DEBUG );
212 $logger->debug( "AppSession creating new client session for $app", DEBUG );
216 my $sess_id = time . rand( $$ );
217 while ( $class->find($sess_id) ) {
218 $sess_id = time . rand( $$ );
221 my ($r_id) = get_app_targets($app);
223 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
224 if( ! $peer_handle ) {
225 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
228 my $self = bless { app_name => $app,
229 #client_auth => $auth,
233 state => DISCONNECTED,#since we're init'ing
234 session_id => $sess_id,
237 orig_remote_id => $r_id,
238 peer_handle => $peer_handle,
239 session_threadTrace => 0,
242 $self->client_cache();
243 $_CACHE{$sess_id} = $self;
244 return $self->find_client( $app );
248 return shift()->{api_level};
252 return shift()->{app_name};
257 $self->remote_id($$self{orig_remote_id});
260 # 'connect' can be used as a constructor if called as a class method,
261 # or used to connect a session that has disconnectd if called against
262 # an existing session that seems to be disconnected, or was just built
263 # using 'create' above.
265 # connect( $app, username => $user, secret => $passwd );
267 # connect( $app, sysname => $user, secret => $shared_secret );
269 # --- Returns undef if the connect attempt times out.
270 # --- Returns the OpenSRF::EX object if one is returned by the server
271 # --- Returns self if connected
274 my $class = ref($self) || $self;
276 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
277 $logger->transport("ABC AppSession already connected", DEBUG );
279 $logger->transport("ABC AppSession not connected, connecting..", DEBUG );
281 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
284 my $api_level = shift;
285 $api_level = 1 unless (defined $api_level);
287 $self = $class->create($app, @_) if (!ref($self));
288 return undef unless ($self);
290 $self->{api_level} = $api_level;
293 $self->state(CONNECTING);
294 $self->send('CONNECT', "");
296 # if we want to connect to settings, we may not have
297 # any data for the settings client to work with...
298 # just using a default for now XXX
300 my $time_remaining = 5;
303 my $client = OpenSRF::Utils::SettingsClient->new();
304 my $trans = $client->config_value("client_connection","transport_host");
307 $time_remaining = $trans->{connect_timeout};
309 # XXX for now, just use the first
310 $time_remaining = $trans->[0]->{connect_timeout};
314 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
315 my $starttime = time;
316 $self->queue_wait($time_remaining);
318 $time_remaining -= ($endtime - $starttime);
321 return undef unless($self->state == CONNECTED);
328 if( ! $self->session_id ) {
331 #$self->disconnect if ($self->endpoint == CLIENT);
332 for my $ses ( @_CLIENT_CACHE ) {
333 if ($ses->[2]->session_id eq $self->session_id) {
339 sub unregister_callback {
343 if (exists $self->{callbacks}{$type}) {
344 delete $self->{callbacks}{$type}{$cb};
350 sub register_callback {
355 $self->{callbacks}{$type}{$cb_key} = $cb;
361 if( ! $self->session_id ) { return 0; }
363 # run each 'death' callback;
364 if (exists $self->{callbacks}{death}) {
365 for my $sub (values %{$self->{callbacks}{death}}) {
371 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
373 for my $ses ( @_CLIENT_CACHE ) {
375 if ($ses->[2]->session_id ne $self->session_id);
378 delete $_CACHE{$self->session_id};
379 delete($$self{$_}) for (keys %$self);
385 unless( $self->state == DISCONNECTED ) {
386 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
387 $self->state( DISCONNECTED );
389 # run each 'disconnect' callback;
390 if (exists $self->{callbacks}{disconnect}) {
391 for my $sub (values %{$self->{callbacks}{disconnect}}) {
406 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
411 $method->params( @_ );
413 $self->send('REQUEST',$method);
419 my @payload_list = @_; # this is a Domain Object
422 return unless ($self and $self->{peer_handle});
424 $logger->debug( "In send", INTERNAL );
428 if( @payload_list % 2 ) { $tT = pop @payload_list; }
430 if( ! @payload_list ) {
431 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
435 my $doc = OpenSRF::DOM->createDocument();
437 $logger->debug( "In send2", INTERNAL );
442 while( @payload_list ) {
444 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
446 if ($msg_type eq 'DISCONNECT' ) {
448 if( $self->state == DISCONNECTED) {
453 if( $msg_type eq "CONNECT" ) { $connecting++; }
457 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
461 my $msg = OpenSRF::DomainObject::oilsMessage->new();
462 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
464 $msg->type($msg_type);
465 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
467 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
470 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
473 if ($msg->type eq 'REQUEST') {
474 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
475 $msg->update_threadTrace;
476 $self->session_threadTrace( $msg->threadTrace );
477 $tT = $self->session_threadTrace;
478 OpenSRF::AppRequest->new($self, $payload);
482 $msg->api_level($self->api_level);
483 $msg->payload($payload) if $payload;
485 $doc->documentElement->appendChild( $msg );
488 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
489 " with threadTrace [".$msg->threadTrace."]", INFO );
493 if ($self->endpoint == CLIENT and ! $disconnect) {
494 $self->queue_wait(0);
495 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
496 my $v = $self->connect();
498 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
501 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
507 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
510 $self->{peer_handle}->send(
511 to => $self->remote_id,
512 thread => $self->session_id,
513 body => $doc->toString );
515 return $self->app_request( $tT );
522 return undef unless (defined $tT);
523 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
528 sub remove_app_request {
532 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
534 $self->{request_queue} = \@list;
538 return $_[0]->{endpoint};
544 return $self->{session_id};
550 my $req = $self->app_request($resp->[1]);
551 return $req->push_queue( $resp->[0] ) if ($req);
552 push @{ $self->{recv_queue} }, $resp->[0];
555 sub last_threadTrace {
557 my $new_last_threadTrace = shift;
559 my $old_last_threadTrace = $self->{last_threadTrace};
560 if (defined $new_last_threadTrace) {
561 $self->{last_threadTrace} = $new_last_threadTrace;
562 return $new_last_threadTrace unless ($old_last_threadTrace);
565 return $old_last_threadTrace;
568 sub session_threadTrace {
570 my $new_last_threadTrace = shift;
572 my $old_last_threadTrace = $self->{session_threadTrace};
573 if (defined $new_last_threadTrace) {
574 $self->{session_threadTrace} = $new_last_threadTrace;
575 return $new_last_threadTrace unless ($old_last_threadTrace);
578 return $old_last_threadTrace;
581 sub last_message_type {
583 my $new_last_message_type = shift;
585 my $old_last_message_type = $self->{last_message_type};
586 if (defined $new_last_message_type) {
587 $self->{last_message_type} = $new_last_message_type;
588 return $new_last_message_type unless ($old_last_message_type);
591 return $old_last_message_type;
594 sub last_message_api_level {
596 my $new_last_message_api_level = shift;
598 my $old_last_message_api_level = $self->{last_message_api_level};
599 if (defined $new_last_message_api_level) {
600 $self->{last_message_api_level} = $new_last_message_api_level;
601 return $new_last_message_api_level unless ($old_last_message_api_level);
604 return $old_last_message_api_level;
609 my $new_remote_id = shift;
611 my $old_remote_id = $self->{remote_id};
612 if (defined $new_remote_id) {
613 $self->{remote_id} = $new_remote_id;
614 return $new_remote_id unless ($old_remote_id);
617 return $old_remote_id;
625 my $old_ua = $self->{client_auth};
626 if (defined $new_ua) {
627 $self->{client_auth} = $new_ua;
628 return $new_ua unless ($old_ua);
631 return $old_ua->cloneNode(1);
636 my $new_state = shift;
638 my $old_state = $self->{state};
639 if (defined $new_state) {
640 $self->{state} = $new_state;
641 return $new_state unless ($old_state);
649 delete $$self{$_} for keys %$self;
659 if ( !(@proto_args % 2) ) {
661 } elsif (@proto_args == 1) {
662 %args = ( timeout => @proto_args );
666 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
668 if( exists( $args{timeout} ) ) {
669 $args{timeout} = int($args{timeout});
674 #$args{timeout} = 0 if ($self->complete);
676 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
680 my $avail = @{ $self->{recv_queue} };
681 my $time_remaining = $args{timeout};
683 while ( $avail < $args{count} and $time_remaining > 0 ) {
684 last if $self->complete;
685 my $starttime = time;
686 $self->queue_wait($time_remaining);
688 $time_remaining -= ($endtime - $starttime);
689 $avail = @{ $self->{recv_queue} };
692 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
695 while ( my $msg = shift @{ $self->{recv_queue} } ) {
697 last if (scalar(@list) >= $args{count});
700 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
701 $logger->debug( "Number of matched responses: " . @list, DEBUG );
703 $self->queue_wait(0); # check for statuses
705 return $list[0] unless (wantarray);
711 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
716 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
717 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
718 $req->resend unless $req->complete;
725 if( ! $self->{peer_handle} ) { return 0; }
726 my $timeout = shift || 0;
727 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
728 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
729 my $o = $self->{peer_handle}->process($timeout);
730 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
738 foreach my $msg ( @{$self->{recv_queue}} ) {
739 $string = $string . $msg->toString(1) . "\n";
747 $self->send( 'STATUS', @_ );
750 #-------------------------------------------------------------------------------
752 package OpenSRF::AppRequest;
753 use base qw/OpenSRF::AppSession/;
754 use OpenSRF::Utils::Logger qw/:level/;
755 use OpenSRF::DomainObject::oilsResponse qw/:status/;
759 $class = ref($class) || $class;
762 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
765 my $self = { session => $session,
766 threadTrace => $threadTrace,
772 bless $self => $class;
774 push @{ $self->session->{request_queue} }, $self;
780 my $size = @{$_[0]->{recv_queue}};
786 return unless ($self and $self->session);
787 $self->session->send(@_);
792 $self->session->remove_app_request($self);
793 delete($$self{$_}) for (keys %$self);
797 return shift()->{session};
802 my $complete = shift;
803 return $self->{complete} if ($self->{complete});
804 if (defined $complete) {
805 $self->{complete} = $complete;
807 $self->session->queue_wait(0);
809 return $self->{complete};
814 my $timeout = shift || 1;
815 my $time_remaining = $timeout;
817 while ( ! $self->complete and $time_remaining > 0 ) {
818 my $starttime = time;
819 $self->queue_wait($time_remaining);
821 $time_remaining -= ($endtime - $starttime);
824 return $self->complete;
828 return shift()->{threadTrace};
834 if( !$resp ) { return 0; }
835 push @{ $self->{recv_queue} }, $resp;
836 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
841 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
842 return $self->session->queue_wait(@_)
845 sub payload { return shift()->{payload}; }
849 return unless ($self and $self->session);
850 OpenSRF::Utils::Logger->debug(
851 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
853 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
855 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
861 return unless ($self and $self->session);
862 $self->session->send( 'STATUS',$msg, $self->threadTrace );
868 return unless ($self and $self->session);
871 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
874 $response = new OpenSRF::DomainObject::oilsResult;
875 $response->content($msg);
878 $self->session->send('RESULT', $response, $self->threadTrace);
881 sub respond_complete {
886 if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
889 $response = new OpenSRF::DomainObject::oilsResult;
890 $response->content($msg);
893 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
894 statusCode => STATUS_COMPLETE(),
895 status => 'Request Complete' );
897 return unless ($self and $self->session);
898 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
902 sub register_death_callback {
905 $self->session->register_callback( death => $cb );
908 package OpenSRF::AppSubrequest;
913 push @{$$self{resp}}, $resp if (defined $resp);
917 return bless({resp => []}, 'OpenSRF::AppSubrequest');
920 sub responses { @{$_[0]->{resp}} }