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};
332 while ( $self->state != CONNECTED and $time_remaining > 0 ) {
333 my $starttime = time;
334 $self->queue_wait($time_remaining);
336 $time_remaining -= ($endtime - $starttime);
339 return undef unless($self->state == CONNECTED);
348 if( ! $self->session_id ) {
353 sub unregister_callback {
357 if (exists $self->{callbacks}{$type}) {
358 delete $self->{callbacks}{$type}{$cb};
364 sub register_callback {
369 $self->{callbacks}{$type}{$cb_key} = $cb;
375 if( ! $self->session_id ) { return 0; }
377 # run each 'death' callback;
378 if (exists $self->{callbacks}{death}) {
379 for my $sub (values %{$self->{callbacks}{death}}) {
385 $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
386 delete $_CACHE{$self->session_id};
387 delete($$self{$_}) for (keys %$self);
393 # run each 'disconnect' callback;
394 if (exists $self->{callbacks}{disconnect}) {
395 for my $sub (values %{$self->{callbacks}{disconnect}}) {
400 if ( !$self->stateless and $self->state != DISCONNECTED ) {
401 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
402 $self->state( DISCONNECTED );
413 # tell the logger to create a new xid - the logger will decide if it's really necessary
414 $logger->mk_osrf_xid;
418 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
423 $method->params( @_ );
425 $self->send('REQUEST',$method);
434 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
439 $method->params( @_ );
441 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
446 my @payload_list = @_; # this is a Domain Object
448 return unless ($self and $self->{peer_handle});
450 $logger->debug( "In send", INTERNAL );
454 if( @payload_list % 2 ) { $tT = pop @payload_list; }
456 if( ! @payload_list ) {
457 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
466 while( @payload_list ) {
468 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
470 if ($msg_type eq 'DISCONNECT' ) {
472 if( $self->state == DISCONNECTED && !$connecting) {
477 if( $msg_type eq "CONNECT" ) {
481 my $msg = OpenSRF::DomainObject::oilsMessage->new();
482 $msg->type($msg_type);
485 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
488 if ($msg->type eq 'REQUEST') {
489 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
490 $msg->update_threadTrace;
491 $self->session_threadTrace( $msg->threadTrace );
492 $tT = $self->session_threadTrace;
493 OpenSRF::AppRequest->new($self, $payload);
497 $msg->api_level($self->api_level);
498 $msg->payload($payload) if $payload;
500 my $locale = $self->session_locale;
501 $msg->sender_locale($locale) if ($locale);
506 $logger->info( "AppSession sending ".$msg->type." to ".$self->remote_id.
507 " with threadTrace [".$msg->threadTrace."]");
511 if ($self->endpoint == CLIENT and ! $disconnect) {
512 $self->queue_wait(0);
515 if($self->stateless && $self->state != CONNECTED) {
517 $logger->debug("AppSession is stateless in send", INTERNAL );
520 if( !$self->stateless and $self->state != CONNECTED ) {
522 $logger->debug( "Sending connect before request 1", INTERNAL );
524 unless (($self->state == CONNECTING && $connecting )) {
525 $logger->debug( "Sending connect before request 2", INTERNAL );
526 my $v = $self->connect();
528 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
531 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
538 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
539 $logger->internal("AppSession sending doc: $json");
541 $self->{peer_handle}->send(
542 to => $self->remote_id,
543 thread => $self->session_id,
547 $self->state( DISCONNECTED );
550 my $req = $self->app_request( $tT );
551 $req->{_start} = time;
559 return undef unless (defined $tT);
560 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
565 sub remove_app_request {
569 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
571 $self->{request_queue} = \@list;
575 return $_[0]->{endpoint};
581 return $self->{session_id};
587 my $req = $self->app_request($resp->[1]);
588 return $req->push_queue( $resp->[0] ) if ($req);
589 push @{ $self->{recv_queue} }, $resp->[0];
592 sub last_threadTrace {
594 my $new_last_threadTrace = shift;
596 my $old_last_threadTrace = $self->{last_threadTrace};
597 if (defined $new_last_threadTrace) {
598 $self->{last_threadTrace} = $new_last_threadTrace;
599 return $new_last_threadTrace unless ($old_last_threadTrace);
602 return $old_last_threadTrace;
605 sub session_threadTrace {
607 my $new_last_threadTrace = shift;
609 my $old_last_threadTrace = $self->{session_threadTrace};
610 if (defined $new_last_threadTrace) {
611 $self->{session_threadTrace} = $new_last_threadTrace;
612 return $new_last_threadTrace unless ($old_last_threadTrace);
615 return $old_last_threadTrace;
618 sub last_message_type {
620 my $new_last_message_type = shift;
622 my $old_last_message_type = $self->{last_message_type};
623 if (defined $new_last_message_type) {
624 $self->{last_message_type} = $new_last_message_type;
625 return $new_last_message_type unless ($old_last_message_type);
628 return $old_last_message_type;
631 sub last_message_api_level {
633 my $new_last_message_api_level = shift;
635 my $old_last_message_api_level = $self->{last_message_api_level};
636 if (defined $new_last_message_api_level) {
637 $self->{last_message_api_level} = $new_last_message_api_level;
638 return $new_last_message_api_level unless ($old_last_message_api_level);
641 return $old_last_message_api_level;
646 my $new_remote_id = shift;
648 my $old_remote_id = $self->{remote_id};
649 if (defined $new_remote_id) {
650 $self->{remote_id} = $new_remote_id;
651 return $new_remote_id unless ($old_remote_id);
654 return $old_remote_id;
662 my $old_ua = $self->{client_auth};
663 if (defined $new_ua) {
664 $self->{client_auth} = $new_ua;
665 return $new_ua unless ($old_ua);
668 return $old_ua->cloneNode(1);
673 my $new_state = shift;
675 my $old_state = $self->{state};
676 if (defined $new_state) {
677 $self->{state} = $new_state;
678 return $new_state unless ($old_state);
686 delete $$self{$_} for keys %$self;
696 if ( !(@proto_args % 2) ) {
698 } elsif (@proto_args == 1) {
699 %args = ( timeout => @proto_args );
703 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
705 if( exists( $args{timeout} ) ) {
706 $args{timeout} = int($args{timeout});
707 $self->{recv_timeout} = $args{timeout};
710 #$args{timeout} = 0 if ($self->complete);
712 if(defined($args{timeout})) {
713 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
716 my $avail = @{ $self->{recv_queue} };
717 $self->{remaining_recv_timeout} = $self->{recv_timeout};
721 $args{count} = $avail;
727 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
728 last if $self->complete;
729 my $starttime = time;
730 $self->queue_wait($self->{remaining_recv_timeout});
732 if ($self->{timeout_reset}) {
733 $self->{timeout_reset} = 0;
735 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
737 $avail = @{ $self->{recv_queue} };
742 while ( my $msg = shift @{ $self->{recv_queue} } ) {
744 last if (scalar(@list) >= $args{count});
747 $logger->debug( "Number of matched responses: " . @list, DEBUG );
748 $self->queue_wait(0); # check for statuses
750 return $list[0] if (!wantarray);
756 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
761 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
762 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
763 $req->resend unless $req->complete;
770 if( ! $self->{peer_handle} ) { return 0; }
771 my $timeout = shift || 0;
772 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
773 my $o = $self->{peer_handle}->process($timeout);
781 foreach my $msg ( @{$self->{recv_queue}} ) {
782 $string = $string . $msg->toString(1) . "\n";
790 $self->send( 'STATUS', @_ );
793 sub reset_request_timeout {
796 my $req = $self->app_request($tt);
797 $req->{remaining_recv_timeout} = $req->{recv_timeout};
798 $req->{timout_reset} = 1;
801 #-------------------------------------------------------------------------------
803 package OpenSRF::AppRequest;
804 use base qw/OpenSRF::AppSession/;
805 use OpenSRF::Utils::Logger qw/:level/;
806 use OpenSRF::DomainObject::oilsResponse qw/:status/;
807 use Time::HiRes qw/time usleep/;
811 $class = ref($class) || $class;
814 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
817 my $self = { session => $session,
818 threadTrace => $threadTrace,
823 remaining_recv_timeout => 30,
827 bless $self => $class;
829 push @{ $self->session->{request_queue} }, $self;
837 if (defined $timeout) {
838 $self->{recv_timeout} = $timeout;
839 $self->{remaining_recv_timeout} = $timeout;
841 return $self->{recv_timeout};
845 my $size = @{$_[0]->{recv_queue}};
851 return unless ($self and $self->session and !$self->complete);
852 $self->session->send(@_);
857 return unless $self->session;
858 $self->session->remove_app_request($self);
859 delete($$self{$_}) for (keys %$self);
863 return shift()->{session};
868 my $complete = shift;
869 return $self->{complete} if ($self->{complete});
870 if (defined $complete) {
871 $self->{complete} = $complete;
872 $self->{_duration} = time - $self->{_start} if ($self->{complete});
874 $self->session->queue_wait(0);
876 return $self->{complete};
881 $self->wait_complete;
882 return $self->{_duration};
887 my $timeout = shift || 10;
888 my $time_remaining = $timeout;
890 while ( ! $self->complete and $time_remaining > 0 ) {
891 my $starttime = time;
892 $self->queue_wait($time_remaining);
894 $time_remaining -= ($endtime - $starttime);
897 return $self->complete;
901 return shift()->{threadTrace};
907 if( !$resp ) { return 0; }
908 if( UNIVERSAL::isa($resp, "Error")) {
909 $self->{failed} = $resp;
911 #return; eventually...
913 push @{ $self->{recv_queue} }, $resp;
918 return $self->{failed};
923 return $self->session->queue_wait(@_)
926 sub payload { return shift()->{payload}; }
930 return unless ($self and $self->session and !$self->complete);
931 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
932 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
938 return unless ($self and $self->session and !$self->complete);
939 $self->session->send( 'STATUS',$msg, $self->threadTrace );
945 $self->respond( $msg );
951 return unless ($self and $self->session and !$self->complete);
954 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
957 $response = new OpenSRF::DomainObject::oilsResult;
958 $response->content($msg);
961 $self->session->send('RESULT', $response, $self->threadTrace);
964 sub respond_complete {
967 return unless ($self and $self->session and !$self->complete);
970 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
973 $response = new OpenSRF::DomainObject::oilsResult;
974 $response->content($msg);
977 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
978 statusCode => STATUS_COMPLETE(),
979 status => 'Request Complete' );
982 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
986 sub register_death_callback {
989 $self->session->register_callback( death => $cb );
993 # utility method. checks to see of the request failed.
994 # if so, throws an OpenSRF::EX::ERROR. if everything is
995 # ok, it returns the content of the request
999 $self->wait_complete;
1000 my $resp = $self->recv( timeout => 60 );
1001 if( $self->failed() ) {
1002 throw OpenSRF::EX::ERROR
1003 ($self->failed()->stringify());
1005 if(!$resp) { return undef; }
1006 my $content = $resp->content;
1007 if($finish) { $self->finish();}
1012 package OpenSRF::AppSubrequest;
1017 push @{$$self{resp}}, $resp if (defined $resp);
1019 sub respond_complete { respond(@_); }
1023 $class = ref($class) || $class;
1024 return bless({resp => [], @_}, $class);
1027 sub responses { @{$_[0]->{resp}} }
1032 $x->{session} = $s if ($s);
1033 return $x->{session};