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';
25 our $current_ingress = 'opensrf';
28 my ($class, $ingress) = @_;
29 $current_ingress = $ingress if $ingress;
30 return $current_ingress;
36 sub CONNECTING { return 3 };
37 sub INIT_CONNECTED { return 4 };
38 sub CONNECTED { return 1 };
39 sub DISCONNECTED { return 2 };
41 sub CLIENT { return 2 };
42 sub SERVER { return 1 };
45 return undef unless (defined $_[1]);
46 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
49 sub transport_connected {
51 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
54 return $self->{peer_handle}->tcp_connected();
59 return $self->state == CONNECTED;
61 # ----------------------------------------------------------------------------
62 # Clears the transport buffers
63 # call this if you are not through with the sesssion, but you want
64 # to have a clean slate. You shouldn't have to call this if
65 # you are correctly 'recv'ing all of the data from a request.
66 # however, if you don't want all of the data, this will
67 # slough off any excess
68 # * * Note: This will delete data for all sessions using this transport
69 # handle. For example, all client sessions use the same handle.
70 # ----------------------------------------------------------------------------
74 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
77 $self->{peer_handle}->buffer_reset();
81 # when any incoming data is received, this method is called.
84 $class = ref($class) || $class;
87 my $remote_id = shift;
90 warn "Missing args to server_build():\n" .
91 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
92 unless ($sess_id and $remote_id and $service);
94 return undef unless ($sess_id and $remote_id and $service);
96 if ( my $thingy = $class->find($sess_id) ) {
97 $thingy->remote_id( $remote_id );
101 if( $service eq "client" ) {
102 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
103 # " Session ID [$sess_id], remote_id [$remote_id]");
105 warn "Attempting to build a client session as ".
106 "a server Session ID [$sess_id], remote_id [$remote_id]";
108 $logger->debug("Attempting to build a client session as ".
109 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
114 my $config_client = OpenSRF::Utils::SettingsClient->new();
115 my $stateless = $config_client->config_value("apps", $service, "stateless");
117 #my $max_requests = $conf->$service->max_requests;
118 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
119 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
121 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
123 my $self = bless { recv_queue => [],
130 session_id => $sess_id,
131 remote_id => $remote_id,
132 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
133 max_requests => $max_requests,
134 session_threadTrace => 0,
136 stateless => $stateless,
139 return $_CACHE{$sess_id} = $self;
144 my ($name, $datum) = @_;
146 $self->{session_data}->{$name} = $datum if (defined $datum);
147 return $self->{session_data}->{$name};
150 sub service { return shift()->{service}; }
152 sub continue_request {
154 $self->{'requests'}++;
155 return 1 if (!$self->{'max_requests'});
156 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
159 sub last_sent_payload {
160 my( $self, $payload ) = @_;
162 return $self->{'last_sent_payload'} = $payload;
164 return $self->{'last_sent_payload'};
168 my( $self, $type ) = @_;
170 $_last_locale = $type if ($self->endpoint == SERVER);
171 return $self->{'session_locale'} = $type;
173 return $self->{'session_locale'};
177 my( $self, $type ) = @_;
179 return $self->{'last_sent_type'} = $type;
181 return $self->{'last_sent_type'};
184 sub get_app_targets {
187 my $conf = OpenSRF::Utils::Config->current;
188 my $router_name = $conf->bootstrap->router_name || 'router';
189 my $domain = $conf->bootstrap->domain;
190 $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
192 unless($router_name and $domain) {
193 throw OpenSRF::EX::Config
194 ("Missing router config information 'router_name' and 'domain'");
197 return ("$router_name\@$domain/$app");
203 $self->{stateless} = $state if (defined $state);
204 return $self->{stateless};
207 # When we're a client and we want to connect to a remote service
210 $class = ref($class) || $class;
213 my $api_level = shift;
215 my $locale = shift || $_last_locale;
217 $api_level = 1 if (!defined($api_level));
219 $logger->debug( "AppSession creating new client session for $app", DEBUG );
222 my $c = OpenSRF::Utils::SettingsClient->new();
223 # we can get an infinite loop if we're grabbing the settings and we
224 # need the settings to grab the settings...
225 if($app ne "opensrf.settings" || $c->has_config()) {
226 $stateless = $c->config_value("apps", $app, "stateless");
229 my $sess_id = time . rand( $$ );
230 while ( $class->find($sess_id) ) {
231 $sess_id = time . rand( $$ );
235 my ($r_id) = get_app_targets($app);
237 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
238 if( ! $peer_handle ) {
239 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
242 my $self = bless { app_name => $app,
245 state => DISCONNECTED,#since we're init'ing
246 session_id => $sess_id,
248 raise_error => $quiet ? 0 : 1,
249 session_locale => $locale,
250 api_level => $api_level,
251 orig_remote_id => $r_id,
252 peer_handle => $peer_handle,
253 session_threadTrace => 0,
254 stateless => $stateless,
257 $logger->debug( "Created new client session $app : $sess_id" );
259 return $_CACHE{$sess_id} = $self;
262 sub raise_remote_errors {
265 $self->{raise_error} = $err if (defined $err);
266 return $self->{raise_error};
270 return shift()->{api_level};
274 return shift()->{app_name};
279 $self->remote_id($$self{orig_remote_id});
282 # 'connect' can be used as a constructor if called as a class method,
283 # or used to connect a session that has disconnectd if called against
284 # an existing session that seems to be disconnected, or was just built
285 # using 'create' above.
287 # connect( $app, username => $user, secret => $passwd );
289 # connect( $app, sysname => $user, secret => $shared_secret );
291 # --- Returns undef if the connect attempt times out.
292 # --- Returns the OpenSRF::EX object if one is returned by the server
293 # --- Returns self if connected
296 my $class = ref($self) || $self;
299 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
300 $logger->transport("AppSession already connected", DEBUG );
302 $logger->transport("AppSession not connected, connecting..", DEBUG );
304 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
308 my $api_level = shift;
309 $api_level = 1 unless (defined $api_level);
311 $self = $class->create($app, @_) if (!ref($self));
313 return undef unless ($self);
315 $self->{api_level} = $api_level;
318 $self->state(CONNECTING);
319 $self->send('CONNECT', "");
322 # if we want to connect to settings, we may not have
323 # any data for the settings client to work with...
324 # just using a default for now XXX
326 my $time_remaining = 5;
329 # my $client = OpenSRF::Utils::SettingsClient->new();
330 # my $trans = $client->config_value("client_connection","transport_host");
333 # $time_remaining = $trans->{connect_timeout};
335 # # XXX for now, just use the first
336 # $time_remaining = $trans->[0]->{connect_timeout};
339 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
340 my $starttime = time;
341 $self->queue_wait($time_remaining);
343 $time_remaining -= ($endtime - $starttime);
346 return undef unless($self->state == CONNECTED);
355 if( ! $self->session_id ) {
360 sub unregister_callback {
364 if (exists $self->{callbacks}{$type}) {
365 delete $self->{callbacks}{$type}{$cb};
371 sub register_callback {
376 $self->{callbacks}{$type}{$cb_key} = $cb;
382 if( ! $self->session_id ) { return 0; }
384 # run each 'death' callback;
385 if (exists $self->{callbacks}{death}) {
386 for my $sub (values %{$self->{callbacks}{death}}) {
392 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
393 delete $_CACHE{$self->session_id};
394 delete($$self{$_}) for (keys %$self);
400 # run each 'disconnect' callback;
401 if (exists $self->{callbacks}{disconnect}) {
402 for my $sub (values %{$self->{callbacks}{disconnect}}) {
407 if ( !$self->stateless and $self->state != DISCONNECTED ) {
408 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
409 $self->state( DISCONNECTED );
420 # tell the logger to create a new xid - the logger will decide if it's really necessary
421 $logger->mk_osrf_xid;
425 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
430 $method->params( @_ );
432 $self->send('REQUEST',$method);
441 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
446 $method->params( @_ );
448 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
453 my @payload_list = @_; # this is a Domain Object
455 return unless ($self and $self->{peer_handle});
457 $logger->debug( "In send", INTERNAL );
461 if( @payload_list % 2 ) { $tT = pop @payload_list; }
463 if( ! @payload_list ) {
464 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
473 while( @payload_list ) {
475 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
477 if ($msg_type eq 'DISCONNECT' ) {
479 if( $self->state == DISCONNECTED && !$connecting) {
484 if( $msg_type eq "CONNECT" ) {
488 my $msg = OpenSRF::DomainObject::oilsMessage->new();
489 $msg->type($msg_type);
492 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
495 if ($msg->type eq 'REQUEST') {
496 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
497 $msg->update_threadTrace;
498 $self->session_threadTrace( $msg->threadTrace );
499 $tT = $self->session_threadTrace;
500 OpenSRF::AppRequest->new($self, $payload);
504 $msg->api_level($self->api_level);
505 $msg->payload($payload) if $payload;
507 my $locale = $self->session_locale;
508 $msg->sender_locale($locale) if ($locale);
510 $msg->sender_ingress($current_ingress);
515 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
516 " with threadTrace [".$msg->threadTrace."]");
520 if ($self->endpoint == CLIENT and ! $disconnect) {
521 $self->queue_wait(0);
524 if($self->stateless && $self->state != CONNECTED) {
526 $logger->debug("AppSession is stateless in send", INTERNAL );
529 if( !$self->stateless and $self->state != CONNECTED ) {
531 $logger->debug( "Sending connect before request 1", INTERNAL );
533 unless (($self->state == CONNECTING && $connecting )) {
534 $logger->debug( "Sending connect before request 2", INTERNAL );
535 my $v = $self->connect();
537 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
540 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
547 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
548 $logger->internal("AppSession sending doc: $json");
550 $self->{peer_handle}->send(
551 to => $self->remote_id,
552 thread => $self->session_id,
556 $self->state( DISCONNECTED );
559 my $req = $self->app_request( $tT );
560 $req->{_start} = time;
568 return undef unless (defined $tT);
569 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
574 sub remove_app_request {
578 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
580 $self->{request_queue} = \@list;
584 return $_[0]->{endpoint};
590 return $self->{session_id};
596 my $req = $self->app_request($resp->[1]);
597 return $req->push_queue( $resp->[0] ) if ($req);
598 push @{ $self->{recv_queue} }, $resp->[0];
601 sub last_threadTrace {
603 my $new_last_threadTrace = shift;
605 my $old_last_threadTrace = $self->{last_threadTrace};
606 if (defined $new_last_threadTrace) {
607 $self->{last_threadTrace} = $new_last_threadTrace;
608 return $new_last_threadTrace unless ($old_last_threadTrace);
611 return $old_last_threadTrace;
614 sub session_threadTrace {
616 my $new_last_threadTrace = shift;
618 my $old_last_threadTrace = $self->{session_threadTrace};
619 if (defined $new_last_threadTrace) {
620 $self->{session_threadTrace} = $new_last_threadTrace;
621 return $new_last_threadTrace unless ($old_last_threadTrace);
624 return $old_last_threadTrace;
627 sub last_message_type {
629 my $new_last_message_type = shift;
631 my $old_last_message_type = $self->{last_message_type};
632 if (defined $new_last_message_type) {
633 $self->{last_message_type} = $new_last_message_type;
634 return $new_last_message_type unless ($old_last_message_type);
637 return $old_last_message_type;
640 sub last_message_api_level {
642 my $new_last_message_api_level = shift;
644 my $old_last_message_api_level = $self->{last_message_api_level};
645 if (defined $new_last_message_api_level) {
646 $self->{last_message_api_level} = $new_last_message_api_level;
647 return $new_last_message_api_level unless ($old_last_message_api_level);
650 return $old_last_message_api_level;
655 my $new_remote_id = shift;
657 my $old_remote_id = $self->{remote_id};
658 if (defined $new_remote_id) {
659 $self->{remote_id} = $new_remote_id;
660 return $new_remote_id unless ($old_remote_id);
663 return $old_remote_id;
671 my $old_ua = $self->{client_auth};
672 if (defined $new_ua) {
673 $self->{client_auth} = $new_ua;
674 return $new_ua unless ($old_ua);
677 return $old_ua->cloneNode(1);
682 my $new_state = shift;
684 my $old_state = $self->{state};
685 if (defined $new_state) {
686 $self->{state} = $new_state;
687 return $new_state unless ($old_state);
695 delete $$self{$_} for keys %$self;
705 if ( !(@proto_args % 2) ) {
707 } elsif (@proto_args == 1) {
708 %args = ( timeout => @proto_args );
712 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
714 if( exists( $args{timeout} ) ) {
715 $args{timeout} = int($args{timeout});
716 $self->{recv_timeout} = $args{timeout};
719 #$args{timeout} = 0 if ($self->complete);
721 if(defined($args{timeout})) {
722 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
725 my $avail = @{ $self->{recv_queue} };
726 $self->{remaining_recv_timeout} = $self->{recv_timeout};
730 $args{count} = $avail;
736 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
737 last if $self->complete;
738 my $starttime = time;
739 $self->queue_wait($self->{remaining_recv_timeout});
741 if ($self->{timeout_reset}) {
742 $self->{timeout_reset} = 0;
744 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
746 $avail = @{ $self->{recv_queue} };
749 $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
752 while ( my $msg = shift @{ $self->{recv_queue} } ) {
754 last if (scalar(@list) >= $args{count});
757 $logger->debug( "Number of matched responses: " . @list, DEBUG );
758 $self->queue_wait(0); # check for statuses
760 return $list[0] if (!wantarray);
767 $self->{timed_out} = $out if (defined $out);
768 return $self->{timed_out};
773 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
778 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
779 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
780 $req->resend unless $req->complete;
787 if( ! $self->{peer_handle} ) { return 0; }
788 my $timeout = shift || 0;
789 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
790 my $o = $self->{peer_handle}->process($timeout);
798 foreach my $msg ( @{$self->{recv_queue}} ) {
799 $string = $string . $msg->toString(1) . "\n";
807 $self->send( 'STATUS', @_ );
810 sub reset_request_timeout {
813 my $req = $self->app_request($tt);
814 $req->{remaining_recv_timeout} = $req->{recv_timeout};
815 $req->{timout_reset} = 1;
818 #-------------------------------------------------------------------------------
820 package OpenSRF::AppRequest;
821 use base qw/OpenSRF::AppSession/;
822 use OpenSRF::Utils::Logger qw/:level/;
823 use OpenSRF::DomainObject::oilsResponse qw/:status/;
824 use Time::HiRes qw/time usleep/;
828 $class = ref($class) || $class;
831 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
834 my $self = { session => $session,
835 threadTrace => $threadTrace,
839 max_chunk_count => 0,
840 current_chunk_count => 0,
842 current_chunk_size => 0,
846 remaining_recv_timeout => 30,
850 bless $self => $class;
852 push @{ $self->session->{request_queue} }, $self;
857 sub max_chunk_count {
860 $self->{max_chunk_count} = $value if (defined($value));
861 return $self->{max_chunk_count};
867 $self->{max_chunk_size} = $value if (defined($value));
868 return $self->{max_chunk_size};
874 if (defined $timeout) {
875 $self->{recv_timeout} = $timeout;
876 $self->{remaining_recv_timeout} = $timeout;
878 return $self->{recv_timeout};
882 my $size = @{$_[0]->{recv_queue}};
888 return unless ($self and $self->session and !$self->complete);
889 $self->session->send(@_);
894 return unless $self->session;
895 $self->session->remove_app_request($self);
896 delete($$self{$_}) for (keys %$self);
900 return shift()->{session};
905 my $complete = shift;
906 return $self->{complete} if ($self->{complete});
907 if (defined $complete) {
908 $self->{complete} = $complete;
909 $self->{_duration} = time - $self->{_start} if ($self->{complete});
911 $self->session->queue_wait(0);
913 return $self->{complete};
918 $self->wait_complete;
919 return $self->{_duration};
924 my $timeout = shift || 10;
925 my $time_remaining = $timeout;
927 while ( ! $self->complete and $time_remaining > 0 ) {
928 my $starttime = time;
929 $self->queue_wait($time_remaining);
931 $time_remaining -= ($endtime - $starttime);
934 return $self->complete;
938 return shift()->{threadTrace};
944 if( !$resp ) { return 0; }
945 if( UNIVERSAL::isa($resp, "Error")) {
946 $self->{failed} = $resp;
948 #return; eventually...
950 push @{ $self->{recv_queue} }, $resp;
955 return $self->{failed};
960 return $self->session->queue_wait(@_)
963 sub payload { return shift()->{payload}; }
967 return unless ($self and $self->session and !$self->complete);
968 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
969 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
975 return unless ($self and $self->session and !$self->complete);
976 $self->session->send( 'STATUS',$msg, $self->threadTrace );
979 # TODO stream_push only works when server sessions can accept RESULT
980 # messages, which is no longer supported. Create a new OpenSRF message
981 # type to support client-to-server streams.
985 # $self->respond( $msg );
991 return unless ($self and $self->session and !$self->complete);
994 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
997 $response = new OpenSRF::DomainObject::oilsResult;
998 $response->content($msg);
1001 if ($self->{max_chunk_count} > 0 or $self->{max_chunk_size} > 0) { # we are chunking, and we need to test the size or count
1003 $self->{current_chunk_size} += length(OpenSRF::Utils::JSON->perl2JSON($response));
1004 push @{$self->{current_chunk}}, $response;
1005 $self->{current_chunk_count}++;
1008 ($self->{max_chunk_size} && $self->{current_chunk_size} >= $self->{max_chunk_size} ) ||
1009 ($self->{max_chunk_count} && $self->{current_chunk_count} >= $self->{max_chunk_count})
1010 ) { # send chunk and reset
1011 my $send_res = $self->session->send(( map { ('RESULT', $_) } @{$self->{current_chunk}} ), $self->threadTrace);
1012 $self->{current_chunk} = [];
1013 $self->{current_chunk_size} = 0;
1014 $self->{current_chunk_count} = 0;
1016 } else { # not at a chunk yet, just queue it up
1017 return $self->session->app_request( $self->threadTrace );
1021 $self->session->send('RESULT', $response, $self->threadTrace);
1024 sub respond_complete {
1027 return unless ($self and $self->session and !$self->complete);
1029 if (defined($msg)) {
1031 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
1034 $response = new OpenSRF::DomainObject::oilsResult;
1035 $response->content($msg);
1038 push @{$self->{current_chunk}}, $response;
1041 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
1042 statusCode => STATUS_COMPLETE(),
1043 status => 'Request Complete' );
1045 $self->session->send( ( map { ('RESULT', $_) } @{$self->{current_chunk}} ), 'STATUS' => $stat, $self->threadTrace);
1049 sub register_death_callback {
1052 $self->session->register_callback( death => $cb );
1056 # utility method. checks to see of the request failed.
1057 # if so, throws an OpenSRF::EX::ERROR. if everything is
1058 # ok, it returns the content of the request
1062 $self->wait_complete;
1063 my $resp = $self->recv( timeout => 60 );
1064 if( $self->failed() ) {
1065 throw OpenSRF::EX::ERROR
1066 ($self->failed()->stringify());
1068 if(!$resp) { return undef; }
1069 my $content = $resp->content;
1070 if($finish) { $self->finish();}
1075 package OpenSRF::AppSubrequest;
1080 push @{$$self{resp}}, $resp if (defined $resp);
1082 sub respond_complete { respond(@_); }
1086 $class = ref($class) || $class;
1087 return bless({resp => [], @_}, $class);
1090 sub responses { @{$_[0]->{resp}} }
1095 $x->{session} = $s if ($s);
1096 return $x->{session};