1 package OpenSRF::AppSession;
2 use OpenSRF::DomainObject::oilsMessage;
3 use OpenSRF::DomainObject::oilsMethod;
4 use OpenSRF::DomainObject::oilsResponse qw/:status/;
5 use OpenSRF::Transport::PeerHandle;
6 use OpenSRF::Utils::JSON;
7 use OpenSRF::Utils::Logger qw(:level);
8 use OpenSRF::Utils::SettingsClient;
9 use OpenSRF::Utils::Config;
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";
28 sub CONNECTING { return 3 };
29 sub INIT_CONNECTED { return 4 };
30 sub CONNECTED { return 1 };
31 sub DISCONNECTED { return 2 };
33 sub CLIENT { return 2 };
34 sub SERVER { return 1 };
37 return undef unless (defined $_[1]);
38 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
41 sub transport_connected {
43 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
46 return $self->{peer_handle}->tcp_connected();
51 return $self->state == CONNECTED;
53 # ----------------------------------------------------------------------------
54 # Clears the transport buffers
55 # call this if you are not through with the sesssion, but you want
56 # to have a clean slate. You shouldn't have to call this if
57 # you are correctly 'recv'ing all of the data from a request.
58 # however, if you don't want all of the data, this will
59 # slough off any excess
60 # * * Note: This will delete data for all sessions using this transport
61 # handle. For example, all client sessions use the same handle.
62 # ----------------------------------------------------------------------------
66 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
69 $self->{peer_handle}->buffer_reset();
73 # when any incoming data is received, this method is called.
76 $class = ref($class) || $class;
79 my $remote_id = shift;
82 warn "Missing args to server_build():\n" .
83 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
84 unless ($sess_id and $remote_id and $service);
86 return undef unless ($sess_id and $remote_id and $service);
88 if ( my $thingy = $class->find($sess_id) ) {
89 $thingy->remote_id( $remote_id );
93 if( $service eq "client" ) {
94 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
95 # " Session ID [$sess_id], remote_id [$remote_id]");
97 warn "Attempting to build a client session as ".
98 "a server Session ID [$sess_id], remote_id [$remote_id]";
100 $logger->debug("Attempting to build a client session as ".
101 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
106 my $config_client = OpenSRF::Utils::SettingsClient->new();
107 my $stateless = $config_client->config_value("apps", $service, "stateless");
109 #my $max_requests = $conf->$service->max_requests;
110 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
111 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
113 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
115 my $self = bless { recv_queue => [],
122 session_id => $sess_id,
123 remote_id => $remote_id,
124 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
125 max_requests => $max_requests,
126 session_threadTrace => 0,
128 stateless => $stateless,
131 return $_CACHE{$sess_id} = $self;
136 my ($name, $datum) = @_;
138 $self->{session_data}->{$name} = $datum if (defined $datum);
139 return $self->{session_data}->{$name};
142 sub service { return shift()->{service}; }
144 sub continue_request {
146 $self->{'requests'}++;
147 return 1 if (!$self->{'max_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 sub get_app_targets {
170 my $conf = OpenSRF::Utils::Config->current;
171 my $router_name = $conf->bootstrap->router_name || 'router';
172 my $routers = $conf->bootstrap->domains;
174 unless($router_name and $routers) {
175 throw OpenSRF::EX::Config
176 ("Missing router config information 'router_name' and 'routers'");
180 for my $router (@$routers) {
181 push @targets, "$router_name\@$router/$app";
190 $self->{stateless} = $state if (defined $state);
191 return $self->{stateless};
194 # When we're a client and we want to connect to a remote service
195 # create( $app, username => $user, secret => $passwd );
197 # create( $app, sysname => $user, secret => $shared_secret );
200 $class = ref($class) || $class;
203 my $api_level = shift;
206 $api_level = 1 if (!defined($api_level));
208 $logger->debug( "AppSession creating new client session for $app", DEBUG );
211 my $c = OpenSRF::Utils::SettingsClient->new();
212 # we can get an infinite loop if we're grabbing the settings and we
213 # need the settings to grab the settings...
214 if($app ne "opensrf.settings" || $c->has_config()) {
215 $stateless = $c->config_value("apps", $app, "stateless");
218 my $sess_id = time . rand( $$ );
219 while ( $class->find($sess_id) ) {
220 $sess_id = time . rand( $$ );
224 my ($r_id) = get_app_targets($app);
226 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
227 if( ! $peer_handle ) {
228 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
231 my $self = bless { app_name => $app,
232 #client_auth => $auth,
236 state => DISCONNECTED,#since we're init'ing
237 session_id => $sess_id,
239 raise_error => $quiet ? 0 : 1,
240 api_level => $api_level,
241 orig_remote_id => $r_id,
242 peer_handle => $peer_handle,
243 session_threadTrace => 0,
244 stateless => $stateless,
247 $logger->debug( "Created new client session $app : $sess_id" );
249 return $_CACHE{$sess_id} = $self;
252 sub raise_remote_errors {
255 $self->{raise_error} = $err if (defined $err);
256 return $self->{raise_error};
260 return shift()->{api_level};
264 return shift()->{app_name};
269 $self->remote_id($$self{orig_remote_id});
272 # 'connect' can be used as a constructor if called as a class method,
273 # or used to connect a session that has disconnectd if called against
274 # an existing session that seems to be disconnected, or was just built
275 # using 'create' above.
277 # connect( $app, username => $user, secret => $passwd );
279 # connect( $app, sysname => $user, secret => $shared_secret );
281 # --- Returns undef if the connect attempt times out.
282 # --- Returns the OpenSRF::EX object if one is returned by the server
283 # --- Returns self if connected
286 my $class = ref($self) || $self;
289 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
290 $logger->transport("AppSession already connected", DEBUG );
292 $logger->transport("AppSession not connected, connecting..", DEBUG );
294 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
298 my $api_level = shift;
299 $api_level = 1 unless (defined $api_level);
301 $self = $class->create($app, @_) if (!ref($self));
303 return undef unless ($self);
305 $self->{api_level} = $api_level;
308 $self->state(CONNECTING);
309 $self->send('CONNECT', "");
312 # if we want to connect to settings, we may not have
313 # any data for the settings client to work with...
314 # just using a default for now XXX
316 my $time_remaining = 5;
319 my $client = OpenSRF::Utils::SettingsClient->new();
320 my $trans = $client->config_value("client_connection","transport_host");
323 $time_remaining = $trans->{connect_timeout};
325 # XXX for now, just use the first
326 $time_remaining = $trans->[0]->{connect_timeout};
330 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
331 my $starttime = time;
332 $self->queue_wait($time_remaining);
334 $time_remaining -= ($endtime - $starttime);
337 return undef unless($self->state == CONNECTED);
346 if( ! $self->session_id ) {
351 sub unregister_callback {
355 if (exists $self->{callbacks}{$type}) {
356 delete $self->{callbacks}{$type}{$cb};
362 sub register_callback {
367 $self->{callbacks}{$type}{$cb_key} = $cb;
373 if( ! $self->session_id ) { return 0; }
375 # run each 'death' callback;
376 if (exists $self->{callbacks}{death}) {
377 for my $sub (values %{$self->{callbacks}{death}}) {
383 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
384 delete $_CACHE{$self->session_id};
385 delete($$self{$_}) for (keys %$self);
391 # run each 'disconnect' callback;
392 if (exists $self->{callbacks}{disconnect}) {
393 for my $sub (values %{$self->{callbacks}{disconnect}}) {
398 if ( !$self->stateless and $self->state != DISCONNECTED ) {
399 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
400 $self->state( DISCONNECTED );
411 # tell the logger to create a new xid - the logger will decide if it's really necessary
412 $logger->mk_osrf_xid;
416 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
421 $method->params( @_ );
423 $self->send('REQUEST',$method);
432 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
437 $method->params( @_ );
439 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
444 my @payload_list = @_; # this is a Domain Object
446 return unless ($self and $self->{peer_handle});
448 $logger->debug( "In send", INTERNAL );
452 if( @payload_list % 2 ) { $tT = pop @payload_list; }
454 if( ! @payload_list ) {
455 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
464 while( @payload_list ) {
466 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
468 if ($msg_type eq 'DISCONNECT' ) {
470 if( $self->state == DISCONNECTED && !$connecting) {
475 if( $msg_type eq "CONNECT" ) {
479 my $msg = OpenSRF::DomainObject::oilsMessage->new();
480 $msg->type($msg_type);
483 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
486 if ($msg->type eq 'REQUEST') {
487 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
488 $msg->update_threadTrace;
489 $self->session_threadTrace( $msg->threadTrace );
490 $tT = $self->session_threadTrace;
491 OpenSRF::AppRequest->new($self, $payload);
495 $msg->api_level($self->api_level);
496 $msg->payload($payload) if $payload;
501 $logger->info( "AppSession sending ".$msg->type." to ".$self->remote_id.
502 " with threadTrace [".$msg->threadTrace."]" );
506 if ($self->endpoint == CLIENT and ! $disconnect) {
507 $self->queue_wait(0);
510 if($self->stateless && $self->state != CONNECTED) {
512 $logger->debug("AppSession is stateless in send", INTERNAL );
515 if( !$self->stateless and $self->state != CONNECTED ) {
517 $logger->debug( "Sending connect before request 1", INTERNAL );
519 unless (($self->state == CONNECTING && $connecting )) {
520 $logger->debug( "Sending connect before request 2", INTERNAL );
521 my $v = $self->connect();
523 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
526 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
533 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
534 $logger->internal("AppSession sending doc: $json");
536 $self->{peer_handle}->send(
537 to => $self->remote_id,
538 thread => $self->session_id,
542 $self->state( DISCONNECTED );
545 my $req = $self->app_request( $tT );
546 $req->{_start} = time;
554 return undef unless (defined $tT);
555 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
560 sub remove_app_request {
564 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
566 $self->{request_queue} = \@list;
570 return $_[0]->{endpoint};
576 return $self->{session_id};
582 my $req = $self->app_request($resp->[1]);
583 return $req->push_queue( $resp->[0] ) if ($req);
584 push @{ $self->{recv_queue} }, $resp->[0];
587 sub last_threadTrace {
589 my $new_last_threadTrace = shift;
591 my $old_last_threadTrace = $self->{last_threadTrace};
592 if (defined $new_last_threadTrace) {
593 $self->{last_threadTrace} = $new_last_threadTrace;
594 return $new_last_threadTrace unless ($old_last_threadTrace);
597 return $old_last_threadTrace;
600 sub session_threadTrace {
602 my $new_last_threadTrace = shift;
604 my $old_last_threadTrace = $self->{session_threadTrace};
605 if (defined $new_last_threadTrace) {
606 $self->{session_threadTrace} = $new_last_threadTrace;
607 return $new_last_threadTrace unless ($old_last_threadTrace);
610 return $old_last_threadTrace;
613 sub last_message_type {
615 my $new_last_message_type = shift;
617 my $old_last_message_type = $self->{last_message_type};
618 if (defined $new_last_message_type) {
619 $self->{last_message_type} = $new_last_message_type;
620 return $new_last_message_type unless ($old_last_message_type);
623 return $old_last_message_type;
626 sub last_message_api_level {
628 my $new_last_message_api_level = shift;
630 my $old_last_message_api_level = $self->{last_message_api_level};
631 if (defined $new_last_message_api_level) {
632 $self->{last_message_api_level} = $new_last_message_api_level;
633 return $new_last_message_api_level unless ($old_last_message_api_level);
636 return $old_last_message_api_level;
641 my $new_remote_id = shift;
643 my $old_remote_id = $self->{remote_id};
644 if (defined $new_remote_id) {
645 $self->{remote_id} = $new_remote_id;
646 return $new_remote_id unless ($old_remote_id);
649 return $old_remote_id;
657 my $old_ua = $self->{client_auth};
658 if (defined $new_ua) {
659 $self->{client_auth} = $new_ua;
660 return $new_ua unless ($old_ua);
663 return $old_ua->cloneNode(1);
668 my $new_state = shift;
670 my $old_state = $self->{state};
671 if (defined $new_state) {
672 $self->{state} = $new_state;
673 return $new_state unless ($old_state);
681 delete $$self{$_} for keys %$self;
691 if ( !(@proto_args % 2) ) {
693 } elsif (@proto_args == 1) {
694 %args = ( timeout => @proto_args );
698 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
700 if( exists( $args{timeout} ) ) {
701 $args{timeout} = int($args{timeout});
702 $self->{recv_timeout} = $args{timeout};
705 #$args{timeout} = 0 if ($self->complete);
707 if(defined($args{timeout})) {
708 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
711 my $avail = @{ $self->{recv_queue} };
712 $self->{remaining_recv_timeout} = $self->{recv_timeout};
716 $args{count} = $avail;
722 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
723 last if $self->complete;
724 my $starttime = time;
725 $self->queue_wait($self->{remaining_recv_timeout});
727 if ($self->{timeout_reset}) {
728 $self->{timeout_reset} = 0;
730 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
732 $avail = @{ $self->{recv_queue} };
737 while ( my $msg = shift @{ $self->{recv_queue} } ) {
739 last if (scalar(@list) >= $args{count});
742 $logger->debug( "Number of matched responses: " . @list, DEBUG );
743 $self->queue_wait(0); # check for statuses
745 return $list[0] unless (wantarray);
751 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
756 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
757 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
758 $req->resend unless $req->complete;
765 if( ! $self->{peer_handle} ) { return 0; }
766 my $timeout = shift || 0;
767 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
768 my $o = $self->{peer_handle}->process($timeout);
776 foreach my $msg ( @{$self->{recv_queue}} ) {
777 $string = $string . $msg->toString(1) . "\n";
785 $self->send( 'STATUS', @_ );
788 sub reset_request_timeout {
791 my $req = $self->app_request($tt);
792 $req->{remaining_recv_timeout} = $req->{recv_timeout};
793 $req->{timout_reset} = 1;
796 #-------------------------------------------------------------------------------
798 package OpenSRF::AppRequest;
799 use base qw/OpenSRF::AppSession/;
800 use OpenSRF::Utils::Logger qw/:level/;
801 use OpenSRF::DomainObject::oilsResponse qw/:status/;
802 use Time::HiRes qw/time usleep/;
806 $class = ref($class) || $class;
809 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
812 my $self = { session => $session,
813 threadTrace => $threadTrace,
818 remaining_recv_timeout => 30,
822 bless $self => $class;
824 push @{ $self->session->{request_queue} }, $self;
832 if (defined $timeout) {
833 $self->{recv_timeout} = $timeout;
834 $self->{remaining_recv_timeout} = $timeout;
836 return $self->{recv_timeout};
840 my $size = @{$_[0]->{recv_queue}};
846 return unless ($self and $self->session and !$self->complete);
847 $self->session->send(@_);
852 return unless $self->session;
853 $self->session->remove_app_request($self);
854 delete($$self{$_}) for (keys %$self);
858 return shift()->{session};
863 my $complete = shift;
864 return $self->{complete} if ($self->{complete});
865 if (defined $complete) {
866 $self->{complete} = $complete;
867 $self->{_duration} = time - $self->{_start} if ($self->{complete});
869 $self->session->queue_wait(0);
871 return $self->{complete};
876 $self->wait_complete;
877 return $self->{_duration};
882 my $timeout = shift || 10;
883 my $time_remaining = $timeout;
885 while ( ! $self->complete and $time_remaining > 0 ) {
886 my $starttime = time;
887 $self->queue_wait($time_remaining);
889 $time_remaining -= ($endtime - $starttime);
892 return $self->complete;
896 return shift()->{threadTrace};
902 if( !$resp ) { return 0; }
903 if( UNIVERSAL::isa($resp, "Error")) {
904 $self->{failed} = $resp;
906 #return; eventually...
908 push @{ $self->{recv_queue} }, $resp;
913 return $self->{failed};
918 return $self->session->queue_wait(@_)
921 sub payload { return shift()->{payload}; }
925 return unless ($self and $self->session and !$self->complete);
926 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
927 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
933 return unless ($self and $self->session and !$self->complete);
934 $self->session->send( 'STATUS',$msg, $self->threadTrace );
940 $self->respond( $msg );
946 return unless ($self and $self->session and !$self->complete);
949 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
952 $response = new OpenSRF::DomainObject::oilsResult;
953 $response->content($msg);
956 $self->session->send('RESULT', $response, $self->threadTrace);
959 sub respond_complete {
962 return unless ($self and $self->session and !$self->complete);
965 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
968 $response = new OpenSRF::DomainObject::oilsResult;
969 $response->content($msg);
972 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
973 statusCode => STATUS_COMPLETE(),
974 status => 'Request Complete' );
977 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
981 sub register_death_callback {
984 $self->session->register_callback( death => $cb );
988 # utility method. checks to see of the request failed.
989 # if so, throws an OpenSRF::EX::ERROR. if everything is
990 # ok, it returns the content of the request
994 $self->wait_complete;
995 my $resp = $self->recv( timeout => 60 );
996 if( $self->failed() ) {
997 throw OpenSRF::EX::ERROR
998 ($self->failed()->stringify());
1000 if(!$resp) { return undef; }
1001 my $content = $resp->content;
1002 if($finish) { $self->finish();}
1007 package OpenSRF::AppSubrequest;
1012 push @{$$self{resp}}, $resp if (defined $resp);
1014 sub respond_complete { respond(@_); }
1018 $class = ref($class) || $class;
1019 return bless({resp => [], @_}, $class);
1022 sub responses { @{$_[0]->{resp}} }