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} ||
59 ! $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 $conf = OpenSRF::Utils::Config->current;
104 OpenSRF::EX::Config->throw( "No suitable config found" );
107 if ( my $thingy = $class->find($sess_id) ) {
108 $thingy->remote_id( $remote_id );
109 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
112 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
115 if( $service eq "client" ) {
116 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
117 # " Session ID [$sess_id], remote_id [$remote_id]");
118 $logger->debug("Attempting to build a client session as ".
119 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
123 my $max_requests = $conf->$service->max_requests;
124 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL );# if $max_requests;
126 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
128 my $self = bless { recv_queue => [],
133 session_id => $sess_id,
134 remote_id => $remote_id,
135 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
136 max_requests => $max_requests,
137 session_threadTrace => 0,
141 return $_CACHE{$sess_id} = $self;
144 sub service { return shift()->{service}; }
146 sub continue_request {
148 $self->{'requests'}++;
149 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
152 sub last_sent_payload {
153 my( $self, $payload ) = @_;
155 return $self->{'last_sent_payload'} = $payload;
157 return $self->{'last_sent_payload'};
161 my( $self, $type ) = @_;
163 return $self->{'last_sent_type'} = $type;
165 return $self->{'last_sent_type'};
168 # When we're a client and we want to connect to a remote service
169 # create( $app, username => $user, secret => $passwd );
171 # create( $app, sysname => $user, secret => $shared_secret );
174 $class = ref($class) || $class;
181 exists($auth_args{secret}) &&
182 ( exists($auth_args{username}) ||
183 exists($auth_args{sysname}) ) ) {
184 throw OpenSRF::EX::User ( 'Insufficient authentication information for session creation');
187 if( my $thingy = OpenSRF::AppSession->find_client( $app ) ) {
188 $logger->debug( "AppSession returning existing client session for $app", DEBUG );
191 $logger->debug( "AppSession creating new client session for $app", DEBUG );
196 my $auth = OpenSRF::DOM::Element::userAuth->new( %auth_args );
198 my $conf = OpenSRF::Utils::Config->current;
201 OpenSRF::EX::Config->throw( "No suitable config found" );
204 my $sess_id = time . rand( $$ );
205 while ( $class->find($sess_id) ) {
206 $sess_id = time . rand( $$ );
209 my $r_id = $conf->$app->transport_target ||
210 die("No remote id for $app!");
212 my $self = bless { app_name => $app,
213 client_auth => $auth,
217 state => DISCONNECTED,#since we're init'ing
218 session_id => $sess_id,
220 orig_remote_id => $r_id,
221 # peer_handle => OpenSRF::Transport::PeerHandle->retrieve($app),
222 peer_handle => OpenSRF::Transport::PeerHandle->retrieve("client"),
223 session_threadTrace => 0,
226 $self->client_cache();
227 $_CACHE{$sess_id} = $self;
228 return $self->find_client( $app );
232 return shift()->{app_name};
237 $self->remote_id($$self{orig_remote_id});
240 # 'connect' can be used as a constructor if called as a class method,
241 # or used to connect a session that has disconnectd if called against
242 # an existing session that seems to be disconnected, or was just built
243 # using 'create' above.
245 # connect( $app, username => $user, secret => $passwd );
247 # connect( $app, sysname => $user, secret => $shared_secret );
249 # --- Returns undef if the connect attempt times out.
250 # --- Returns the OpenSRF::EX object if one is returned by the server
251 # --- Returns self if connected
254 my $class = ref($self) || $self;
256 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
260 $self = $class->create($app, @_) if (!ref($self));
261 return undef unless ($self);
265 $self->state(CONNECTING);
266 $self->send('CONNECT', "");
268 my $time_remaining = OpenSRF::Utils::Config->current->client->connect_timeout;
270 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
271 my $starttime = time;
272 $self->queue_wait($time_remaining);
274 $time_remaining -= ($endtime - $starttime);
277 return undef unless($self->state == CONNECTED);
284 #$self->disconnect if ($self->endpoint == CLIENT);
285 for my $ses ( @_CLIENT_CACHE ) {
286 if ($ses->[2]->session_id eq $self->session_id) {
294 if( ! $self->session_id ) { return 0; }
296 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
298 for my $ses ( @_CLIENT_CACHE ) {
300 if ($ses->[2]->session_id ne $self->session_id);
303 delete $_CACHE{$self->session_id};
304 delete($$self{$_}) for (keys %$self);
309 unless( $self->state == DISCONNECTED ) {
310 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
311 $self->state( DISCONNECTED );
322 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
327 $method->params( @_ );
329 $self->send('REQUEST',$method);
335 my @payload_list = @_; # this is a Domain Object
337 $logger->debug( "In send", INTERNAL );
341 if( @payload_list % 2 ) { $tT = pop @payload_list; }
343 if( ! @payload_list ) {
344 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
348 my $doc = OpenSRF::DOM->createDocument();
350 $logger->debug( "In send2", INTERNAL );
355 while( @payload_list ) {
357 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
359 if ($msg_type eq 'DISCONNECT' ) {
361 if( $self->state == DISCONNECTED) {
366 if( $msg_type eq "CONNECT" ) { $connecting++; }
370 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
374 my $msg = OpenSRF::DomainObject::oilsMessage->new();
375 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
377 $msg->type($msg_type);
378 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
380 $msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
383 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
386 if ($msg->type eq 'REQUEST') {
387 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
388 $msg->update_threadTrace;
389 $self->session_threadTrace( $msg->threadTrace );
390 $tT = $self->session_threadTrace;
391 OpenSRF::AppRequest->new($self, $payload);
396 $msg->payload($payload) if $payload;
398 $doc->documentElement->appendChild( $msg );
401 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
402 " with threadTrace [".$msg->threadTrace."]", INFO );
406 if ($self->endpoint == CLIENT and ! $disconnect) {
407 $self->queue_wait(0);
408 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
409 my $v = $self->connect();
411 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
414 if( $v and $v->class->isa( "OpenSRF::EX" ) ) {
420 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
423 $self->{peer_handle}->send(
424 to => $self->remote_id,
425 thread => $self->session_id,
426 body => $doc->toString );
428 return $self->app_request( $tT );
435 return undef unless (defined $tT);
436 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
441 sub remove_app_request {
445 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
447 $self->{request_queue} = \@list;
451 return $_[0]->{endpoint};
457 return $self->{session_id};
463 my $req = $self->app_request($resp->[1]);
464 return $req->push_queue( $resp->[0] ) if ($req);
465 push @{ $self->{recv_queue} }, $resp->[0];
468 sub last_threadTrace {
470 my $new_last_threadTrace = shift;
472 my $old_last_threadTrace = $self->{last_threadTrace};
473 if (defined $new_last_threadTrace) {
474 $self->{last_threadTrace} = $new_last_threadTrace;
475 return $new_last_threadTrace unless ($old_last_threadTrace);
478 return $old_last_threadTrace;
481 sub session_threadTrace {
483 my $new_last_threadTrace = shift;
485 my $old_last_threadTrace = $self->{session_threadTrace};
486 if (defined $new_last_threadTrace) {
487 $self->{session_threadTrace} = $new_last_threadTrace;
488 return $new_last_threadTrace unless ($old_last_threadTrace);
491 return $old_last_threadTrace;
494 sub last_message_type {
496 my $new_last_message_type = shift;
498 my $old_last_message_type = $self->{last_message_type};
499 if (defined $new_last_message_type) {
500 $self->{last_message_type} = $new_last_message_type;
501 return $new_last_message_type unless ($old_last_message_type);
504 return $old_last_message_type;
507 sub last_message_protocol {
509 my $new_last_message_protocol = shift;
511 my $old_last_message_protocol = $self->{last_message_protocol};
512 if (defined $new_last_message_protocol) {
513 $self->{last_message_protocol} = $new_last_message_protocol;
514 return $new_last_message_protocol unless ($old_last_message_protocol);
517 return $old_last_message_protocol;
522 my $new_remote_id = shift;
524 my $old_remote_id = $self->{remote_id};
525 if (defined $new_remote_id) {
526 $self->{remote_id} = $new_remote_id;
527 return $new_remote_id unless ($old_remote_id);
530 return $old_remote_id;
537 my $old_ua = $self->{client_auth};
538 if (defined $new_ua) {
539 $self->{client_auth} = $new_ua;
540 return $new_ua unless ($old_ua);
543 return $old_ua->cloneNode(1);
548 my $new_state = shift;
550 my $old_state = $self->{state};
551 if (defined $new_state) {
552 $self->{state} = $new_state;
553 return $new_state unless ($old_state);
561 delete $$self{$_} for keys %$self;
571 if ( !(@proto_args % 2) ) {
573 } elsif (@proto_args == 1) {
574 %args = ( timeout => @proto_args );
578 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
580 if( exists( $args{timeout} ) ) {
581 $args{timeout} = int($args{timeout});
586 #$args{timeout} = 0 if ($self->complete);
588 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
592 my $avail = @{ $self->{recv_queue} };
593 my $time_remaining = $args{timeout};
595 while ( $avail < $args{count} and $time_remaining > 0 ) {
596 last if $self->complete;
597 my $starttime = time;
598 $self->queue_wait($time_remaining);
600 $time_remaining -= ($endtime - $starttime);
601 $avail = @{ $self->{recv_queue} };
604 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
607 while ( my $msg = shift @{ $self->{recv_queue} } ) {
609 last if (scalar(@list) >= $args{count});
612 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
613 $logger->debug( "Number of matched responses: " . @list, DEBUG );
615 $self->queue_wait(0); # check for statuses
617 return $list[0] unless (wantarray);
623 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
628 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
629 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
637 if( ! $self->{peer_handle} ) { return 0; }
638 my $timeout = shift || 0;
639 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
640 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
641 my $o = $self->{peer_handle}->process($timeout);
642 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
650 foreach my $msg ( @{$self->{recv_queue}} ) {
651 $string = $string . $msg->toString(1) . "\n";
658 $self->send( 'STATUS', @_ );
661 #-------------------------------------------------------------------------------
663 package OpenSRF::AppRequest;
664 use base qw/OpenSRF::AppSession/;
665 use OpenSRF::Utils::Logger qw/:level/;
666 use OpenSRF::DomainObject::oilsResponse qw/:status/;
670 $class = ref($class) || $class;
673 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
676 my $self = { session => $session,
677 threadTrace => $threadTrace,
683 bless $self => $class;
685 push @{ $self->session->{request_queue} }, $self;
691 my $size = @{$_[0]->{recv_queue}};
696 shift()->session->send(@_);
701 $self->session->remove_app_request($self);
702 delete($$self{$_}) for (keys %$self);
706 return shift()->{session};
711 my $complete = shift;
712 return $self->{complete} if ($self->{complete});
713 if (defined $complete) {
714 $self->{complete} = $complete;
716 $self->session->queue_wait(0);
718 return $self->{complete};
723 my $timeout = shift || 1;
724 my $time_remaining = $timeout;
726 while ( ! $self->complete and $time_remaining > 0 ) {
727 my $starttime = time;
728 $self->queue_wait($time_remaining);
730 $time_remaining -= ($endtime - $starttime);
733 return $self->complete;
737 return shift()->{threadTrace};
743 push @{ $self->{recv_queue} }, $resp;
744 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
749 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
750 return $self->session->queue_wait(@_)
753 sub payload { return shift()->{payload}; }
757 OpenSRF::Utils::Logger->debug(
758 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
759 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
760 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
766 $self->session->send( 'STATUS',$msg, $self->threadTrace );
774 if (!ref($msg) || ($msg->can('getAttribute') && $msg->getAttribute('name') !~ /oilsResult/)) {
775 $response = new OpenSRF::DomainObject::oilsResult;
776 $response->content($msg);
781 $self->session->send('RESULT', $response, $self->threadTrace);
784 sub respond_complete {
789 if (!ref($msg) || ($msg->can('getAttribute') && $msg->getAttribute('name') !~ /oilsResult/)) {
790 $response = new OpenSRF::DomainObject::oilsResult;
791 $response->content($msg);
796 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
797 statusCode => STATUS_COMPLETE(),
798 status => 'Request Complete' );
800 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
811 interval:connect_timeout = 2 seconds
814 subsection:StorageServer = Storage_config
818 #transport_target = http://open-ils.org/RPC2/services/Storage
821 transport_target = Storage@open-ils.org/SERVICE_RECEIVER
822 method_class = OpenSRF::App::Storage::PGStore;