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 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
213 if( ! $peer_handle ) {
214 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
217 my $self = bless { app_name => $app,
218 #client_auth => $auth,
222 state => DISCONNECTED,#since we're init'ing
223 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()->{app_name};
241 $self->remote_id($$self{orig_remote_id});
244 # 'connect' can be used as a constructor if called as a class method,
245 # or used to connect a session that has disconnectd if called against
246 # an existing session that seems to be disconnected, or was just built
247 # using 'create' above.
249 # connect( $app, username => $user, secret => $passwd );
251 # connect( $app, sysname => $user, secret => $shared_secret );
253 # --- Returns undef if the connect attempt times out.
254 # --- Returns the OpenSRF::EX object if one is returned by the server
255 # --- Returns self if connected
258 my $class = ref($self) || $self;
260 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
261 $logger->transport("ABC AppSession already connected", DEBUG );
263 $logger->transport("ABC AppSession not connected, connecting..", DEBUG );
265 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
269 $self = $class->create($app, @_) if (!ref($self));
270 return undef unless ($self);
274 $self->state(CONNECTING);
275 $self->send('CONNECT', "");
277 my $time_remaining = OpenSRF::Utils::Config->current->client->connect_timeout;
279 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
280 my $starttime = time;
281 $self->queue_wait($time_remaining);
283 $time_remaining -= ($endtime - $starttime);
286 return undef unless($self->state == CONNECTED);
293 if( ! $self->session_id ) {
296 #$self->disconnect if ($self->endpoint == CLIENT);
297 for my $ses ( @_CLIENT_CACHE ) {
298 if ($ses->[2]->session_id eq $self->session_id) {
306 if( ! $self->session_id ) { return 0; }
308 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
310 for my $ses ( @_CLIENT_CACHE ) {
312 if ($ses->[2]->session_id ne $self->session_id);
315 delete $_CACHE{$self->session_id};
316 delete($$self{$_}) for (keys %$self);
321 unless( $self->state == DISCONNECTED ) {
322 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);;
323 $self->state( DISCONNECTED );
334 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
339 $method->params( @_ );
341 $self->send('REQUEST',$method);
347 my @payload_list = @_; # this is a Domain Object
350 $logger->debug( "In send", INTERNAL );
354 if( @payload_list % 2 ) { $tT = pop @payload_list; }
356 if( ! @payload_list ) {
357 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
361 my $doc = OpenSRF::DOM->createDocument();
363 $logger->debug( "In send2", INTERNAL );
368 while( @payload_list ) {
370 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
372 if ($msg_type eq 'DISCONNECT' ) {
374 if( $self->state == DISCONNECTED) {
379 if( $msg_type eq "CONNECT" ) { $connecting++; }
383 $logger->debug( "Payload is ".$payload->toString, INTERNAL );
387 my $msg = OpenSRF::DomainObject::oilsMessage->new();
388 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
390 $msg->type($msg_type);
391 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
393 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
396 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
399 if ($msg->type eq 'REQUEST') {
400 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
401 $msg->update_threadTrace;
402 $self->session_threadTrace( $msg->threadTrace );
403 $tT = $self->session_threadTrace;
404 OpenSRF::AppRequest->new($self, $payload);
409 $msg->payload($payload) if $payload;
411 $doc->documentElement->appendChild( $msg );
414 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
415 " with threadTrace [".$msg->threadTrace."]", INFO );
419 if ($self->endpoint == CLIENT and ! $disconnect) {
420 $self->queue_wait(0);
421 unless ($self->state == CONNECTED || ($self->state == CONNECTING && $connecting )) {
422 my $v = $self->connect();
424 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
427 if( $v and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
433 $logger->debug( "AppSession sending doc: " . $doc->toString(), INTERNAL );
436 $self->{peer_handle}->send(
437 to => $self->remote_id,
438 thread => $self->session_id,
439 body => $doc->toString );
441 return $self->app_request( $tT );
448 return undef unless (defined $tT);
449 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
454 sub remove_app_request {
458 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
460 $self->{request_queue} = \@list;
464 return $_[0]->{endpoint};
470 return $self->{session_id};
476 my $req = $self->app_request($resp->[1]);
477 return $req->push_queue( $resp->[0] ) if ($req);
478 push @{ $self->{recv_queue} }, $resp->[0];
481 sub last_threadTrace {
483 my $new_last_threadTrace = shift;
485 my $old_last_threadTrace = $self->{last_threadTrace};
486 if (defined $new_last_threadTrace) {
487 $self->{last_threadTrace} = $new_last_threadTrace;
488 return $new_last_threadTrace unless ($old_last_threadTrace);
491 return $old_last_threadTrace;
494 sub session_threadTrace {
496 my $new_last_threadTrace = shift;
498 my $old_last_threadTrace = $self->{session_threadTrace};
499 if (defined $new_last_threadTrace) {
500 $self->{session_threadTrace} = $new_last_threadTrace;
501 return $new_last_threadTrace unless ($old_last_threadTrace);
504 return $old_last_threadTrace;
507 sub last_message_type {
509 my $new_last_message_type = shift;
511 my $old_last_message_type = $self->{last_message_type};
512 if (defined $new_last_message_type) {
513 $self->{last_message_type} = $new_last_message_type;
514 return $new_last_message_type unless ($old_last_message_type);
517 return $old_last_message_type;
520 sub last_message_protocol {
522 my $new_last_message_protocol = shift;
524 my $old_last_message_protocol = $self->{last_message_protocol};
525 if (defined $new_last_message_protocol) {
526 $self->{last_message_protocol} = $new_last_message_protocol;
527 return $new_last_message_protocol unless ($old_last_message_protocol);
530 return $old_last_message_protocol;
535 my $new_remote_id = shift;
537 my $old_remote_id = $self->{remote_id};
538 if (defined $new_remote_id) {
539 $self->{remote_id} = $new_remote_id;
540 return $new_remote_id unless ($old_remote_id);
543 return $old_remote_id;
551 my $old_ua = $self->{client_auth};
552 if (defined $new_ua) {
553 $self->{client_auth} = $new_ua;
554 return $new_ua unless ($old_ua);
557 return $old_ua->cloneNode(1);
562 my $new_state = shift;
564 my $old_state = $self->{state};
565 if (defined $new_state) {
566 $self->{state} = $new_state;
567 return $new_state unless ($old_state);
575 delete $$self{$_} for keys %$self;
585 if ( !(@proto_args % 2) ) {
587 } elsif (@proto_args == 1) {
588 %args = ( timeout => @proto_args );
592 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
594 if( exists( $args{timeout} ) ) {
595 $args{timeout} = int($args{timeout});
600 #$args{timeout} = 0 if ($self->complete);
602 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
606 my $avail = @{ $self->{recv_queue} };
607 my $time_remaining = $args{timeout};
609 while ( $avail < $args{count} and $time_remaining > 0 ) {
610 last if $self->complete;
611 my $starttime = time;
612 $self->queue_wait($time_remaining);
614 $time_remaining -= ($endtime - $starttime);
615 $avail = @{ $self->{recv_queue} };
618 #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
621 while ( my $msg = shift @{ $self->{recv_queue} } ) {
623 last if (scalar(@list) >= $args{count});
626 # $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
627 $logger->debug( "Number of matched responses: " . @list, DEBUG );
629 $self->queue_wait(0); # check for statuses
631 return $list[0] unless (wantarray);
637 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
642 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
643 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
651 if( ! $self->{peer_handle} ) { return 0; }
652 my $timeout = shift || 0;
653 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
654 $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
655 my $o = $self->{peer_handle}->process($timeout);
656 $logger->debug( "Timestamp after process($timeout) : " . $logger->format_time(), INTERNAL );
664 foreach my $msg ( @{$self->{recv_queue}} ) {
665 $string = $string . $msg->toString(1) . "\n";
672 $self->send( 'STATUS', @_ );
675 #-------------------------------------------------------------------------------
677 package OpenSRF::AppRequest;
678 use base qw/OpenSRF::AppSession/;
679 use OpenSRF::Utils::Logger qw/:level/;
680 use OpenSRF::DomainObject::oilsResponse qw/:status/;
684 $class = ref($class) || $class;
687 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
690 my $self = { session => $session,
691 threadTrace => $threadTrace,
697 bless $self => $class;
699 push @{ $self->session->{request_queue} }, $self;
705 my $size = @{$_[0]->{recv_queue}};
710 shift()->session->send(@_);
715 $self->session->remove_app_request($self);
716 delete($$self{$_}) for (keys %$self);
720 return shift()->{session};
725 my $complete = shift;
726 return $self->{complete} if ($self->{complete});
727 if (defined $complete) {
728 $self->{complete} = $complete;
730 $self->session->queue_wait(0);
732 return $self->{complete};
737 my $timeout = shift || 1;
738 my $time_remaining = $timeout;
740 while ( ! $self->complete and $time_remaining > 0 ) {
741 my $starttime = time;
742 $self->queue_wait($time_remaining);
744 $time_remaining -= ($endtime - $starttime);
747 return $self->complete;
751 return shift()->{threadTrace};
757 push @{ $self->{recv_queue} }, $resp;
758 OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
763 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
764 return $self->session->queue_wait(@_)
767 sub payload { return shift()->{payload}; }
771 OpenSRF::Utils::Logger->debug(
772 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
774 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
776 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
782 $self->session->send( 'STATUS',$msg, $self->threadTrace );
790 if (ref($msg) && $msg->can('getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
793 $response = new OpenSRF::DomainObject::oilsResult;
794 $response->content($msg);
797 $self->session->send('RESULT', $response, $self->threadTrace);
800 sub respond_complete {
805 if (ref($msg) && $msg->can('getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
808 $response = new OpenSRF::DomainObject::oilsResult;
809 $response->content($msg);
812 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
813 statusCode => STATUS_COMPLETE(),
814 status => 'Request Complete' );
816 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
827 interval:connect_timeout = 2 seconds
830 subsection:StorageServer = Storage_config
834 #transport_target = http://open-ils.org/RPC2/services/Storage
837 transport_target = Storage@open-ils.org/SERVICE_RECEIVER
838 method_class = OpenSRF::App::Storage::PGStore;