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";
24 my $_last_locale = 'en-US';
29 sub CONNECTING { return 3 };
30 sub INIT_CONNECTED { return 4 };
31 sub CONNECTED { return 1 };
32 sub DISCONNECTED { return 2 };
34 sub CLIENT { return 2 };
35 sub SERVER { return 1 };
38 return undef unless (defined $_[1]);
39 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
42 sub transport_connected {
44 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
47 return $self->{peer_handle}->tcp_connected();
52 return $self->state == CONNECTED;
54 # ----------------------------------------------------------------------------
55 # Clears the transport buffers
56 # call this if you are not through with the sesssion, but you want
57 # to have a clean slate. You shouldn't have to call this if
58 # you are correctly 'recv'ing all of the data from a request.
59 # however, if you don't want all of the data, this will
60 # slough off any excess
61 # * * Note: This will delete data for all sessions using this transport
62 # handle. For example, all client sessions use the same handle.
63 # ----------------------------------------------------------------------------
67 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
70 $self->{peer_handle}->buffer_reset();
74 # when any incoming data is received, this method is called.
77 $class = ref($class) || $class;
80 my $remote_id = shift;
83 warn "Missing args to server_build():\n" .
84 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
85 unless ($sess_id and $remote_id and $service);
87 return undef unless ($sess_id and $remote_id and $service);
89 if ( my $thingy = $class->find($sess_id) ) {
90 $thingy->remote_id( $remote_id );
94 if( $service eq "client" ) {
95 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
96 # " Session ID [$sess_id], remote_id [$remote_id]");
98 warn "Attempting to build a client session as ".
99 "a server Session ID [$sess_id], remote_id [$remote_id]";
101 $logger->debug("Attempting to build a client session as ".
102 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
107 my $config_client = OpenSRF::Utils::SettingsClient->new();
108 my $stateless = $config_client->config_value("apps", $service, "stateless");
110 #my $max_requests = $conf->$service->max_requests;
111 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
112 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
114 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
116 my $self = bless { recv_queue => [],
123 session_id => $sess_id,
124 remote_id => $remote_id,
125 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
126 max_requests => $max_requests,
127 session_threadTrace => 0,
129 stateless => $stateless,
132 return $_CACHE{$sess_id} = $self;
137 my ($name, $datum) = @_;
139 $self->{session_data}->{$name} = $datum if (defined $datum);
140 return $self->{session_data}->{$name};
143 sub service { return shift()->{service}; }
145 sub continue_request {
147 $self->{'requests'}++;
148 return 1 if (!$self->{'max_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 $_last_locale = $type if ($self->endpoint == SERVER);
164 return $self->{'session_locale'} = $type;
166 return $self->{'session_locale'};
170 my( $self, $type ) = @_;
172 return $self->{'last_sent_type'} = $type;
174 return $self->{'last_sent_type'};
177 sub get_app_targets {
180 my $conf = OpenSRF::Utils::Config->current;
181 my $router_name = $conf->bootstrap->router_name || 'router';
182 my $domain = $conf->bootstrap->domain;
183 $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
185 unless($router_name and $domain) {
186 throw OpenSRF::EX::Config
187 ("Missing router config information 'router_name' and 'domain'");
190 return ("$router_name\@$domain/$app");
196 $self->{stateless} = $state if (defined $state);
197 return $self->{stateless};
200 # When we're a client and we want to connect to a remote service
203 $class = ref($class) || $class;
206 my $api_level = shift;
208 my $locale = shift || $_last_locale;
210 $api_level = 1 if (!defined($api_level));
212 $logger->debug( "AppSession creating new client session for $app", DEBUG );
215 my $c = OpenSRF::Utils::SettingsClient->new();
216 # we can get an infinite loop if we're grabbing the settings and we
217 # need the settings to grab the settings...
218 if($app ne "opensrf.settings" || $c->has_config()) {
219 $stateless = $c->config_value("apps", $app, "stateless");
222 my $sess_id = time . rand( $$ );
223 while ( $class->find($sess_id) ) {
224 $sess_id = time . rand( $$ );
228 my ($r_id) = get_app_targets($app);
230 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
231 if( ! $peer_handle ) {
232 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
235 my $self = bless { app_name => $app,
238 state => DISCONNECTED,#since we're init'ing
239 session_id => $sess_id,
241 raise_error => $quiet ? 0 : 1,
242 session_locale => $locale,
243 api_level => $api_level,
244 orig_remote_id => $r_id,
245 peer_handle => $peer_handle,
246 session_threadTrace => 0,
247 stateless => $stateless,
250 $logger->debug( "Created new client session $app : $sess_id" );
252 return $_CACHE{$sess_id} = $self;
255 sub raise_remote_errors {
258 $self->{raise_error} = $err if (defined $err);
259 return $self->{raise_error};
263 return shift()->{api_level};
267 return shift()->{app_name};
272 $self->remote_id($$self{orig_remote_id});
275 # 'connect' can be used as a constructor if called as a class method,
276 # or used to connect a session that has disconnectd if called against
277 # an existing session that seems to be disconnected, or was just built
278 # using 'create' above.
280 # connect( $app, username => $user, secret => $passwd );
282 # connect( $app, sysname => $user, secret => $shared_secret );
284 # --- Returns undef if the connect attempt times out.
285 # --- Returns the OpenSRF::EX object if one is returned by the server
286 # --- Returns self if connected
289 my $class = ref($self) || $self;
292 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
293 $logger->transport("AppSession already connected", DEBUG );
295 $logger->transport("AppSession not connected, connecting..", DEBUG );
297 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
301 my $api_level = shift;
302 $api_level = 1 unless (defined $api_level);
304 $self = $class->create($app, @_) if (!ref($self));
306 return undef unless ($self);
308 $self->{api_level} = $api_level;
311 $self->state(CONNECTING);
312 $self->send('CONNECT', "");
315 # if we want to connect to settings, we may not have
316 # any data for the settings client to work with...
317 # just using a default for now XXX
319 my $time_remaining = 5;
322 my $client = OpenSRF::Utils::SettingsClient->new();
323 my $trans = $client->config_value("client_connection","transport_host");
326 $time_remaining = $trans->{connect_timeout};
328 # XXX for now, just use the first
329 $time_remaining = $trans->[0]->{connect_timeout};
333 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
334 my $starttime = time;
335 $self->queue_wait($time_remaining);
337 $time_remaining -= ($endtime - $starttime);
340 return undef unless($self->state == CONNECTED);
349 if( ! $self->session_id ) {
354 sub unregister_callback {
358 if (exists $self->{callbacks}{$type}) {
359 delete $self->{callbacks}{$type}{$cb};
365 sub register_callback {
370 $self->{callbacks}{$type}{$cb_key} = $cb;
376 if( ! $self->session_id ) { return 0; }
378 # run each 'death' callback;
379 if (exists $self->{callbacks}{death}) {
380 for my $sub (values %{$self->{callbacks}{death}}) {
386 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
387 delete $_CACHE{$self->session_id};
388 delete($$self{$_}) for (keys %$self);
394 # run each 'disconnect' callback;
395 if (exists $self->{callbacks}{disconnect}) {
396 for my $sub (values %{$self->{callbacks}{disconnect}}) {
401 if ( !$self->stateless and $self->state != DISCONNECTED ) {
402 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
403 $self->state( DISCONNECTED );
414 # tell the logger to create a new xid - the logger will decide if it's really necessary
415 $logger->mk_osrf_xid;
419 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
424 $method->params( @_ );
426 $self->send('REQUEST',$method);
435 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
440 $method->params( @_ );
442 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
447 my @payload_list = @_; # this is a Domain Object
449 return unless ($self and $self->{peer_handle});
451 $logger->debug( "In send", INTERNAL );
455 if( @payload_list % 2 ) { $tT = pop @payload_list; }
457 if( ! @payload_list ) {
458 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
467 while( @payload_list ) {
469 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
471 if ($msg_type eq 'DISCONNECT' ) {
473 if( $self->state == DISCONNECTED && !$connecting) {
478 if( $msg_type eq "CONNECT" ) {
482 my $msg = OpenSRF::DomainObject::oilsMessage->new();
483 $msg->type($msg_type);
486 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
489 if ($msg->type eq 'REQUEST') {
490 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
491 $msg->update_threadTrace;
492 $self->session_threadTrace( $msg->threadTrace );
493 $tT = $self->session_threadTrace;
494 OpenSRF::AppRequest->new($self, $payload);
498 $msg->api_level($self->api_level);
499 $msg->payload($payload) if $payload;
501 my $locale = $self->session_locale;
502 $msg->sender_locale($locale) if ($locale);
507 $logger->info( "AppSession sending ".$msg->type." to ".$self->remote_id.
508 " with threadTrace [".$msg->threadTrace."]");
512 if ($self->endpoint == CLIENT and ! $disconnect) {
513 $self->queue_wait(0);
516 if($self->stateless && $self->state != CONNECTED) {
518 $logger->debug("AppSession is stateless in send", INTERNAL );
521 if( !$self->stateless and $self->state != CONNECTED ) {
523 $logger->debug( "Sending connect before request 1", INTERNAL );
525 unless (($self->state == CONNECTING && $connecting )) {
526 $logger->debug( "Sending connect before request 2", INTERNAL );
527 my $v = $self->connect();
529 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
532 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
539 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
540 $logger->internal("AppSession sending doc: $json");
542 $self->{peer_handle}->send(
543 to => $self->remote_id,
544 thread => $self->session_id,
548 $self->state( DISCONNECTED );
551 my $req = $self->app_request( $tT );
552 $req->{_start} = time;
560 return undef unless (defined $tT);
561 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
566 sub remove_app_request {
570 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
572 $self->{request_queue} = \@list;
576 return $_[0]->{endpoint};
582 return $self->{session_id};
588 my $req = $self->app_request($resp->[1]);
589 return $req->push_queue( $resp->[0] ) if ($req);
590 push @{ $self->{recv_queue} }, $resp->[0];
593 sub last_threadTrace {
595 my $new_last_threadTrace = shift;
597 my $old_last_threadTrace = $self->{last_threadTrace};
598 if (defined $new_last_threadTrace) {
599 $self->{last_threadTrace} = $new_last_threadTrace;
600 return $new_last_threadTrace unless ($old_last_threadTrace);
603 return $old_last_threadTrace;
606 sub session_threadTrace {
608 my $new_last_threadTrace = shift;
610 my $old_last_threadTrace = $self->{session_threadTrace};
611 if (defined $new_last_threadTrace) {
612 $self->{session_threadTrace} = $new_last_threadTrace;
613 return $new_last_threadTrace unless ($old_last_threadTrace);
616 return $old_last_threadTrace;
619 sub last_message_type {
621 my $new_last_message_type = shift;
623 my $old_last_message_type = $self->{last_message_type};
624 if (defined $new_last_message_type) {
625 $self->{last_message_type} = $new_last_message_type;
626 return $new_last_message_type unless ($old_last_message_type);
629 return $old_last_message_type;
632 sub last_message_api_level {
634 my $new_last_message_api_level = shift;
636 my $old_last_message_api_level = $self->{last_message_api_level};
637 if (defined $new_last_message_api_level) {
638 $self->{last_message_api_level} = $new_last_message_api_level;
639 return $new_last_message_api_level unless ($old_last_message_api_level);
642 return $old_last_message_api_level;
647 my $new_remote_id = shift;
649 my $old_remote_id = $self->{remote_id};
650 if (defined $new_remote_id) {
651 $self->{remote_id} = $new_remote_id;
652 return $new_remote_id unless ($old_remote_id);
655 return $old_remote_id;
663 my $old_ua = $self->{client_auth};
664 if (defined $new_ua) {
665 $self->{client_auth} = $new_ua;
666 return $new_ua unless ($old_ua);
669 return $old_ua->cloneNode(1);
674 my $new_state = shift;
676 my $old_state = $self->{state};
677 if (defined $new_state) {
678 $self->{state} = $new_state;
679 return $new_state unless ($old_state);
687 delete $$self{$_} for keys %$self;
697 if ( !(@proto_args % 2) ) {
699 } elsif (@proto_args == 1) {
700 %args = ( timeout => @proto_args );
704 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
706 if( exists( $args{timeout} ) ) {
707 $args{timeout} = int($args{timeout});
708 $self->{recv_timeout} = $args{timeout};
711 #$args{timeout} = 0 if ($self->complete);
713 if(defined($args{timeout})) {
714 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
717 my $avail = @{ $self->{recv_queue} };
718 $self->{remaining_recv_timeout} = $self->{recv_timeout};
722 $args{count} = $avail;
728 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
729 last if $self->complete;
730 my $starttime = time;
731 $self->queue_wait($self->{remaining_recv_timeout});
733 if ($self->{timeout_reset}) {
734 $self->{timeout_reset} = 0;
736 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
738 $avail = @{ $self->{recv_queue} };
743 while ( my $msg = shift @{ $self->{recv_queue} } ) {
745 last if (scalar(@list) >= $args{count});
748 $logger->debug( "Number of matched responses: " . @list, DEBUG );
749 $self->queue_wait(0); # check for statuses
751 return $list[0] if (!wantarray);
757 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
762 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
763 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
764 $req->resend unless $req->complete;
771 if( ! $self->{peer_handle} ) { return 0; }
772 my $timeout = shift || 0;
773 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
774 my $o = $self->{peer_handle}->process($timeout);
782 foreach my $msg ( @{$self->{recv_queue}} ) {
783 $string = $string . $msg->toString(1) . "\n";
791 $self->send( 'STATUS', @_ );
794 sub reset_request_timeout {
797 my $req = $self->app_request($tt);
798 $req->{remaining_recv_timeout} = $req->{recv_timeout};
799 $req->{timout_reset} = 1;
802 #-------------------------------------------------------------------------------
804 package OpenSRF::AppRequest;
805 use base qw/OpenSRF::AppSession/;
806 use OpenSRF::Utils::Logger qw/:level/;
807 use OpenSRF::DomainObject::oilsResponse qw/:status/;
808 use Time::HiRes qw/time usleep/;
812 $class = ref($class) || $class;
815 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
818 my $self = { session => $session,
819 threadTrace => $threadTrace,
824 remaining_recv_timeout => 30,
828 bless $self => $class;
830 push @{ $self->session->{request_queue} }, $self;
838 if (defined $timeout) {
839 $self->{recv_timeout} = $timeout;
840 $self->{remaining_recv_timeout} = $timeout;
842 return $self->{recv_timeout};
846 my $size = @{$_[0]->{recv_queue}};
852 return unless ($self and $self->session and !$self->complete);
853 $self->session->send(@_);
858 return unless $self->session;
859 $self->session->remove_app_request($self);
860 delete($$self{$_}) for (keys %$self);
864 return shift()->{session};
869 my $complete = shift;
870 return $self->{complete} if ($self->{complete});
871 if (defined $complete) {
872 $self->{complete} = $complete;
873 $self->{_duration} = time - $self->{_start} if ($self->{complete});
875 $self->session->queue_wait(0);
877 return $self->{complete};
882 $self->wait_complete;
883 return $self->{_duration};
888 my $timeout = shift || 10;
889 my $time_remaining = $timeout;
891 while ( ! $self->complete and $time_remaining > 0 ) {
892 my $starttime = time;
893 $self->queue_wait($time_remaining);
895 $time_remaining -= ($endtime - $starttime);
898 return $self->complete;
902 return shift()->{threadTrace};
908 if( !$resp ) { return 0; }
909 if( UNIVERSAL::isa($resp, "Error")) {
910 $self->{failed} = $resp;
912 #return; eventually...
914 push @{ $self->{recv_queue} }, $resp;
919 return $self->{failed};
924 return $self->session->queue_wait(@_)
927 sub payload { return shift()->{payload}; }
931 return unless ($self and $self->session and !$self->complete);
932 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
933 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
939 return unless ($self and $self->session and !$self->complete);
940 $self->session->send( 'STATUS',$msg, $self->threadTrace );
946 $self->respond( $msg );
952 return unless ($self and $self->session and !$self->complete);
955 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
958 $response = new OpenSRF::DomainObject::oilsResult;
959 $response->content($msg);
962 $self->session->send('RESULT', $response, $self->threadTrace);
965 sub respond_complete {
968 return unless ($self and $self->session and !$self->complete);
971 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
974 $response = new OpenSRF::DomainObject::oilsResult;
975 $response->content($msg);
978 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
979 statusCode => STATUS_COMPLETE(),
980 status => 'Request Complete' );
983 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
987 sub register_death_callback {
990 $self->session->register_callback( death => $cb );
994 # utility method. checks to see of the request failed.
995 # if so, throws an OpenSRF::EX::ERROR. if everything is
996 # ok, it returns the content of the request
1000 $self->wait_complete;
1001 my $resp = $self->recv( timeout => 60 );
1002 if( $self->failed() ) {
1003 throw OpenSRF::EX::ERROR
1004 ($self->failed()->stringify());
1006 if(!$resp) { return undef; }
1007 my $content = $resp->content;
1008 if($finish) { $self->finish();}
1013 package OpenSRF::AppSubrequest;
1018 push @{$$self{resp}}, $resp if (defined $resp);
1020 sub respond_complete { respond(@_); }
1024 $class = ref($class) || $class;
1025 return bless({resp => [], @_}, $class);
1028 sub responses { @{$_[0]->{resp}} }