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::Config;
9 use OpenSRF::Utils::Logger qw(:level);
13 use base qw/Exporter OpenSRF/;
14 use Time::HiRes qw( time usleep );
18 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
19 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
20 endpoint => [ qw/CLIENT SERVER/ ],
23 my $logger = "OpenSRF::Utils::Logger";
29 sub kill_client_session_cache {
30 for my $session ( @_CLIENT_CACHE ) {
35 sub CONNECTING { return 3 };
36 sub INIT_CONNECTED { return 4 };
37 sub CONNECTED { return 1 };
38 sub DISCONNECTED { return 2 };
40 sub CLIENT { return 2 };
41 sub SERVER { return 1 };
44 return undef unless (defined $_[1]);
45 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
49 my( $self, $app ) = @_;
50 $logger->debug( "Client Cache contains: " .scalar(@_CLIENT_CACHE), INTERNAL );
51 my ($client) = grep { $_->[0] eq $app and $_->[1] == 1 } @_CLIENT_CACHE;
56 sub transport_connected {
58 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
61 return $self->{peer_handle}->tcp_connected();
64 # ----------------------------------------------------------------------------
65 # Clears the transport buffers
66 # call this if you are not through with the sesssion, but you want
67 # to have a clean slate. You shouldn't have to call this if
68 # you are correctly 'recv'ing all of the data from a request.
69 # however, if you don't want all of the data, this will
70 # slough off any excess
71 # * * Note: This will delete data for all sessions using this transport
72 # handle. For example, all client sessions use the same handle.
73 # ----------------------------------------------------------------------------
77 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
80 $self->{peer_handle}->buffer_reset();
86 push @_CLIENT_CACHE, [ $self->app, 1, $self ];
89 # when any incoming data is received, this method is called.
92 $class = ref($class) || $class;
95 my $remote_id = shift;
98 return undef unless ($sess_id and $remote_id and $service);
100 my $conf = OpenSRF::Utils::Config->current;
103 OpenSRF::EX::Config->throw( "No suitable config found" );
106 if ( my $thingy = $class->find($sess_id) ) {
107 $thingy->remote_id( $remote_id );
108 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
111 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
114 if( $service eq "client" ) {
115 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
116 # " Session ID [$sess_id], remote_id [$remote_id]");
117 $logger->debug("Attempting to build a client session as ".
118 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
122 my $max_requests = $conf->$service->max_requests;
123 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL );# if $max_requests;
125 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
127 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;
143 sub service { return shift()->{service}; }
145 sub continue_request {
147 $self->{'requests'}++;
148 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
151 sub last_sent_payload {
152 my( $self, $payload ) = @_;
154 return $self->{'last_sent_payload'} = $payload;
156 return $self->{'last_sent_payload'};
160 my( $self, $type ) = @_;
162 return $self->{'last_sent_type'} = $type;
164 return $self->{'last_sent_type'};
167 # When we're a client and we want to connect to a remote service
168 # create( $app, username => $user, secret => $passwd );
170 # create( $app, sysname => $user, secret => $shared_secret );
173 $class = ref($class) || $class;
180 # exists($auth_args{secret}) &&
181 # ( exists($auth_args{username}) ||
182 # exists($auth_args{sysname}) ) ) {
183 # throw OpenSRF::EX::User ( 'Insufficient authentication information for session creation');
186 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
187 $logger->debug( "AppSession returning existing client session for $app", DEBUG );
190 $logger->debug( "AppSession creating new client session for $app", DEBUG );
195 #my $auth = OpenSRF::DOM::Element::userAuth->new( %auth_args );
197 my $conf = OpenSRF::Utils::Config->current;
200 OpenSRF::EX::Config->throw( "No suitable config found" );
203 my $sess_id = time . rand( $$ );
204 while ( $class->find($sess_id) ) {
205 $sess_id = time . rand( $$ );
208 my $r_id = $conf->$app->transport_target ||
209 die("No remote id for $app!");
211 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
212 if( ! $peer_handle ) {
213 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
216 my $self = bless { app_name => $app,
217 #client_auth => $auth,
221 state => DISCONNECTED,#since we're init'ing
222 session_id => $sess_id,
225 orig_remote_id => $r_id,
226 peer_handle => $peer_handle,
227 session_threadTrace => 0,
230 $self->client_cache();
231 $_CACHE{$sess_id} = $self;
232 return $self->find_client( $app );
236 return shift()->{api_level};
240 return shift()->{app_name};
245 $self->remote_id($$self{orig_remote_id});
248 # 'connect' can be used as a constructor if called as a class method,
249 # or used to connect a session that has disconnectd if called against
250 # an existing session that seems to be disconnected, or was just built
251 # using 'create' above.
253 # connect( $app, username => $user, secret => $passwd );
255 # connect( $app, sysname => $user, secret => $shared_secret );
257 # --- Returns undef if the connect attempt times out.
258 # --- Returns the OpenSRF::EX object if one is returned by the server
259 # --- Returns self if connected
262 my $class = ref($self) || $self;
264 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
265 $logger->transport("ABC AppSession already connected", DEBUG );
267 $logger->transport("ABC AppSession not connected, connecting..", DEBUG );
269 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
272 my $api_level = shift;
273 $api_level = 1 unless (defined $api_level)
275 $self = $class->create($app, @_) if (!ref($self));
276 return undef unless ($self);
278 $self->{api_level} = $api_level
281 $self->state(CONNECTING);
282 $self->send('CONNECT', "");
284 my $time_remaining = OpenSRF::Utils::Config->current->client->connect_timeout;
286 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
287 my $starttime = time;
288 $self->queue_wait($time_remaining);
290 $time_remaining -= ($endtime - $starttime);
293 return undef unless($self->state == CONNECTED);
300 if( ! $self->session_id ) {
303 #$self->disconnect if ($self->endpoint == CLIENT);
304 for my $ses ( @_CLIENT_CACHE ) {
305 if ($ses->[2]->session_id eq $self->session_id) {
313 if( ! $self->session_id ) { return 0; }
315 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
317 for my $ses ( @_CLIENT_CACHE ) {
319 if ($ses->[2]->session_id ne $self->session_id);
322 delete $_CACHE{$self->session_id};
323 delete($$self{$_}) for (keys %$self);
328 unless( $self->state == DISCONNECTED ) {
329 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
330 $self->state( DISCONNECTED );
341 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
346 $method->params( @_ );
348 $self->send('REQUEST',$method);
354 my @payload_list = @_; # this is a Domain Object
357 $logger->debug( "In send", INTERNAL );
361 if( @payload_list % 2 ) { $tT = pop @payload_list; }
363 if( ! @payload_list ) {
364 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
368 my $doc = OpenSRF::DOM->createDocument();
370 $logger->debug( "In send2", INTERNAL );
375 while( @payload_list ) {
377 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
379 if ($msg_type eq 'DISCONNECT' ) {
381 if( $self->state == DISCONNECTED) {
386 if( $msg_type eq "CONNECT" ) { $connecting++; }
390 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
394 my $msg = OpenSRF::DomainObject::oilsMessage->new();
395 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
397 $msg->type($msg_type);
398 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
400 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
403 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
406 if ($msg->type eq 'REQUEST') {
407 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
408 $msg->update_threadTrace;
409 $self->session_threadTrace( $msg->threadTrace );
410 $tT = $self->session_threadTrace;
411 OpenSRF::AppRequest->new($self, $payload);
415 $msg->api_level($self->api_level);
416 $msg->payload($payload) if $payload;
418 $doc->documentElement->appendChild( $msg );
421 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
422 " with threadTrace [".$msg->threadTrace."]", INFO );
426 if ($self->endpoint == CLIENT and ! $disconnect) {
427 $self->queue_wait(0);
428 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
429 my $v = $self->connect();
431 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
434 if( $v and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
440 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
443 $self->{peer_handle}->send(
444 to => $self->remote_id,
445 thread => $self->session_id,
446 body => $doc->toString );
448 return $self->app_request( $tT );
455 return undef unless (defined $tT);
456 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
461 sub remove_app_request {
465 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
467 $self->{request_queue} = \@list;
471 return $_[0]->{endpoint};
477 return $self->{session_id};
483 my $req = $self->app_request($resp->[1]);
484 return $req->push_queue( $resp->[0] ) if ($req);
485 push @{ $self->{recv_queue} }, $resp->[0];
488 sub last_threadTrace {
490 my $new_last_threadTrace = shift;
492 my $old_last_threadTrace = $self->{last_threadTrace};
493 if (defined $new_last_threadTrace) {
494 $self->{last_threadTrace} = $new_last_threadTrace;
495 return $new_last_threadTrace unless ($old_last_threadTrace);
498 return $old_last_threadTrace;
501 sub session_threadTrace {
503 my $new_last_threadTrace = shift;
505 my $old_last_threadTrace = $self->{session_threadTrace};
506 if (defined $new_last_threadTrace) {
507 $self->{session_threadTrace} = $new_last_threadTrace;
508 return $new_last_threadTrace unless ($old_last_threadTrace);
511 return $old_last_threadTrace;
514 sub last_message_type {
516 my $new_last_message_type = shift;
518 my $old_last_message_type = $self->{last_message_type};
519 if (defined $new_last_message_type) {
520 $self->{last_message_type} = $new_last_message_type;
521 return $new_last_message_type unless ($old_last_message_type);
524 return $old_last_message_type;
527 sub last_message_api_level {
529 my $new_last_message_api_level = shift;
531 my $old_last_message_api_level = $self->{last_message_api_level};
532 if (defined $new_last_message_api_level) {
533 $self->{last_message_api_level} = $new_last_message_api_level;
534 return $new_last_message_api_level unless ($old_last_message_api_level);
537 return $old_last_message_api_level;
542 my $new_remote_id = shift;
544 my $old_remote_id = $self->{remote_id};
545 if (defined $new_remote_id) {
546 $self->{remote_id} = $new_remote_id;
547 return $new_remote_id unless ($old_remote_id);
550 return $old_remote_id;
558 my $old_ua = $self->{client_auth};
559 if (defined $new_ua) {
560 $self->{client_auth} = $new_ua;
561 return $new_ua unless ($old_ua);
564 return $old_ua->cloneNode(1);
569 my $new_state = shift;
571 my $old_state = $self->{state};
572 if (defined $new_state) {
573 $self->{state} = $new_state;
574 return $new_state unless ($old_state);
582 delete $$self{$_} for keys %$self;
592 if ( !(@proto_args % 2) ) {
594 } elsif (@proto_args == 1) {
595 %args = ( timeout => @proto_args );
599 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
601 if( exists( $args{timeout} ) ) {
602 $args{timeout} = int($args{timeout});
607 #$args{timeout} = 0 if ($self->complete);
609 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
613 my $avail = @{ $self->{recv_queue} };
614 my $time_remaining = $args{timeout};
616 while ( $avail < $args{count} and $time_remaining > 0 ) {
617 last if $self->complete;
618 my $starttime = time;
619 $self->queue_wait($time_remaining);
621 $time_remaining -= ($endtime - $starttime);
622 $avail = @{ $self->{recv_queue} };
625 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
628 while ( my $msg = shift @{ $self->{recv_queue} } ) {
630 last if (scalar(@list) >= $args{count});
633 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
634 $logger->debug( "Number of matched responses: " . @list, DEBUG );
636 $self->queue_wait(0); # check for statuses
638 return $list[0] unless (wantarray);
644 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
649 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
650 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
658 if( ! $self->{peer_handle} ) { return 0; }
659 my $timeout = shift || 0;
660 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
661 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
662 my $o = $self->{peer_handle}->process($timeout);
663 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
671 foreach my $msg ( @{$self->{recv_queue}} ) {
672 $string = $string . $msg->toString(1) . "\n";
679 $self->send( 'STATUS', @_ );
682 #-------------------------------------------------------------------------------
684 package OpenSRF::AppRequest;
685 use base qw/OpenSRF::AppSession/;
686 use OpenSRF::Utils::Logger qw/:level/;
687 use OpenSRF::DomainObject::oilsResponse qw/:status/;
691 $class = ref($class) || $class;
694 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
697 my $self = { session => $session,
698 threadTrace => $threadTrace,
704 bless $self => $class;
706 push @{ $self->session->{request_queue} }, $self;
712 my $size = @{$_[0]->{recv_queue}};
717 shift()->session->send(@_);
722 $self->session->remove_app_request($self);
723 delete($$self{$_}) for (keys %$self);
727 return shift()->{session};
732 my $complete = shift;
733 return $self->{complete} if ($self->{complete});
734 if (defined $complete) {
735 $self->{complete} = $complete;
737 $self->session->queue_wait(0);
739 return $self->{complete};
744 my $timeout = shift || 1;
745 my $time_remaining = $timeout;
747 while ( ! $self->complete and $time_remaining > 0 ) {
748 my $starttime = time;
749 $self->queue_wait($time_remaining);
751 $time_remaining -= ($endtime - $starttime);
754 return $self->complete;
758 return shift()->{threadTrace};
764 if( !$resp ) { return 0; }
765 push @{ $self->{recv_queue} }, $resp;
766 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
771 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
772 return $self->session->queue_wait(@_)
775 sub payload { return shift()->{payload}; }
779 OpenSRF::Utils::Logger->debug(
780 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
782 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
784 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
790 $self->session->send( 'STATUS',$msg, $self->threadTrace );
798 if (ref($msg) && $msg->can('getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
801 $response = new OpenSRF::DomainObject::oilsResult;
802 $response->content($msg);
805 $self->session->send('RESULT', $response, $self->threadTrace);
808 sub respond_complete {
813 if (ref($msg) && $msg->can('getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
816 $response = new OpenSRF::DomainObject::oilsResult;
817 $response->content($msg);
820 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
821 statusCode => STATUS_COMPLETE(),
822 status => 'Request Complete' );
824 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
829 package OpenSRF::AppSubrequest;
834 push @{$$self{resp}}, $resp;
838 return bless({resp => []}, 'OpenSRF::AppSubrequest');
841 sub responses { @{$_[0]->{resp}} }