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::JSON;
9 use OpenSRF::Utils::Logger qw(:level);
10 use OpenSRF::Utils::SettingsClient;
11 use OpenSRF::Utils::Config;
15 use base qw/Exporter OpenSRF/;
16 use Time::HiRes qw( time usleep );
20 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
21 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
22 endpoint => [ qw/CLIENT SERVER/ ],
25 my $logger = "OpenSRF::Utils::Logger";
30 sub CONNECTING { return 3 };
31 sub INIT_CONNECTED { return 4 };
32 sub CONNECTED { return 1 };
33 sub DISCONNECTED { return 2 };
35 sub CLIENT { return 2 };
36 sub SERVER { return 1 };
39 return undef unless (defined $_[1]);
40 return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
43 sub transport_connected {
45 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
48 return $self->{peer_handle}->tcp_connected();
53 return $self->state == CONNECTED;
55 # ----------------------------------------------------------------------------
56 # Clears the transport buffers
57 # call this if you are not through with the sesssion, but you want
58 # to have a clean slate. You shouldn't have to call this if
59 # you are correctly 'recv'ing all of the data from a request.
60 # however, if you don't want all of the data, this will
61 # slough off any excess
62 # * * Note: This will delete data for all sessions using this transport
63 # handle. For example, all client sessions use the same handle.
64 # ----------------------------------------------------------------------------
68 if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
71 $self->{peer_handle}->buffer_reset();
75 # when any incoming data is received, this method is called.
78 $class = ref($class) || $class;
81 my $remote_id = shift;
84 warn "Missing args to server_build():\n" .
85 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n"
86 unless ($sess_id and $remote_id and $service);
88 return undef unless ($sess_id and $remote_id and $service);
90 if ( my $thingy = $class->find($sess_id) ) {
91 $thingy->remote_id( $remote_id );
95 if( $service eq "client" ) {
96 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
97 # " Session ID [$sess_id], remote_id [$remote_id]");
99 warn "Attempting to build a client session as ".
100 "a server Session ID [$sess_id], remote_id [$remote_id]";
102 $logger->debug("Attempting to build a client session as ".
103 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
108 my $config_client = OpenSRF::Utils::SettingsClient->new();
109 my $stateless = $config_client->config_value("apps", $service, "stateless");
111 #my $max_requests = $conf->$service->max_requests;
112 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
113 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
115 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
117 my $self = bless { recv_queue => [],
124 session_id => $sess_id,
125 remote_id => $remote_id,
126 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
127 max_requests => $max_requests,
128 session_threadTrace => 0,
130 stateless => $stateless,
133 return $_CACHE{$sess_id} = $self;
138 my ($name, $datum) = @_;
140 $self->{session_data}->{$name} = $datum if (defined $datum);
141 return $self->{session_data}->{$name};
144 sub service { return shift()->{service}; }
146 sub continue_request {
148 $self->{'requests'}++;
149 return 1 if (!$self->{'max_requests'});
150 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
153 sub last_sent_payload {
154 my( $self, $payload ) = @_;
156 return $self->{'last_sent_payload'} = $payload;
158 return $self->{'last_sent_payload'};
162 my( $self, $type ) = @_;
164 return $self->{'last_sent_type'} = $type;
166 return $self->{'last_sent_type'};
169 sub get_app_targets {
172 my $conf = OpenSRF::Utils::Config->current;
173 my $router_name = $conf->bootstrap->router_name || 'router';
174 my $routers = $conf->bootstrap->domains;
176 unless($router_name and $routers) {
177 throw OpenSRF::EX::Config
178 ("Missing router config information 'router_name' and 'routers'");
182 for my $router (@$routers) {
183 push @targets, "$router_name\@$router/$app";
192 $self->{stateless} = $state if (defined $state);
193 return $self->{stateless};
196 # When we're a client and we want to connect to a remote service
197 # create( $app, username => $user, secret => $passwd );
199 # create( $app, sysname => $user, secret => $shared_secret );
202 $class = ref($class) || $class;
205 my $api_level = shift;
208 $api_level = 1 if (!defined($api_level));
210 $logger->debug( "AppSession creating new client session for $app", DEBUG );
213 my $c = OpenSRF::Utils::SettingsClient->new();
214 # we can get an infinite loop if we're grabbing the settings and we
215 # need the settings to grab the settings...
216 if($app ne "opensrf.settings" || $c->has_config()) {
217 $stateless = $c->config_value("apps", $app, "stateless");
220 my $sess_id = time . rand( $$ );
221 while ( $class->find($sess_id) ) {
222 $sess_id = time . rand( $$ );
226 my ($r_id) = get_app_targets($app);
228 my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
229 if( ! $peer_handle ) {
230 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
233 my $self = bless { app_name => $app,
234 #client_auth => $auth,
238 state => DISCONNECTED,#since we're init'ing
239 session_id => $sess_id,
241 raise_error => $quiet ? 0 : 1,
242 api_level => $api_level,
243 orig_remote_id => $r_id,
244 peer_handle => $peer_handle,
245 session_threadTrace => 0,
246 stateless => $stateless,
249 $logger->debug( "Created new client session $app : $sess_id" );
251 return $_CACHE{$sess_id} = $self;
254 sub raise_remote_errors {
257 $self->{raise_error} = $err if (defined $err);
258 return $self->{raise_error};
262 return shift()->{api_level};
266 return shift()->{app_name};
271 $self->remote_id($$self{orig_remote_id});
274 # 'connect' can be used as a constructor if called as a class method,
275 # or used to connect a session that has disconnectd if called against
276 # an existing session that seems to be disconnected, or was just built
277 # using 'create' above.
279 # connect( $app, username => $user, secret => $passwd );
281 # connect( $app, sysname => $user, secret => $shared_secret );
283 # --- Returns undef if the connect attempt times out.
284 # --- Returns the OpenSRF::EX object if one is returned by the server
285 # --- Returns self if connected
288 my $class = ref($self) || $self;
291 if ( ref( $self ) and $self->state && $self->state == CONNECTED ) {
292 $logger->transport("AppSession already connected", DEBUG );
294 $logger->transport("AppSession not connected, connecting..", DEBUG );
296 return $self if ( ref( $self ) and $self->state && $self->state == CONNECTED );
300 my $api_level = shift;
301 $api_level = 1 unless (defined $api_level);
303 $self = $class->create($app, @_) if (!ref($self));
305 return undef unless ($self);
307 $self->{api_level} = $api_level;
310 $self->state(CONNECTING);
311 $self->send('CONNECT', "");
314 # if we want to connect to settings, we may not have
315 # any data for the settings client to work with...
316 # just using a default for now XXX
318 my $time_remaining = 5;
321 my $client = OpenSRF::Utils::SettingsClient->new();
322 my $trans = $client->config_value("client_connection","transport_host");
325 $time_remaining = $trans->{connect_timeout};
327 # XXX for now, just use the first
328 $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;
503 $logger->info( "AppSession sending ".$msg->type." to ".$self->remote_id.
504 " with threadTrace [".$msg->threadTrace."]" );
508 if ($self->endpoint == CLIENT and ! $disconnect) {
509 $self->queue_wait(0);
512 if($self->stateless && $self->state != CONNECTED) {
514 $logger->debug("AppSession is stateless in send", INTERNAL );
517 if( !$self->stateless and $self->state != CONNECTED ) {
519 $logger->debug( "Sending connect before request 1", INTERNAL );
521 unless (($self->state == CONNECTING && $connecting )) {
522 $logger->debug( "Sending connect before request 2", INTERNAL );
523 my $v = $self->connect();
525 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
528 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
535 my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
536 $logger->internal("AppSession sending doc: $json");
538 $self->{peer_handle}->send(
539 to => $self->remote_id,
540 thread => $self->session_id,
544 $self->state( DISCONNECTED );
547 my $req = $self->app_request( $tT );
548 $req->{_start} = time;
556 return undef unless (defined $tT);
557 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
562 sub remove_app_request {
566 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
568 $self->{request_queue} = \@list;
572 return $_[0]->{endpoint};
578 return $self->{session_id};
584 my $req = $self->app_request($resp->[1]);
585 return $req->push_queue( $resp->[0] ) if ($req);
586 push @{ $self->{recv_queue} }, $resp->[0];
589 sub last_threadTrace {
591 my $new_last_threadTrace = shift;
593 my $old_last_threadTrace = $self->{last_threadTrace};
594 if (defined $new_last_threadTrace) {
595 $self->{last_threadTrace} = $new_last_threadTrace;
596 return $new_last_threadTrace unless ($old_last_threadTrace);
599 return $old_last_threadTrace;
602 sub session_threadTrace {
604 my $new_last_threadTrace = shift;
606 my $old_last_threadTrace = $self->{session_threadTrace};
607 if (defined $new_last_threadTrace) {
608 $self->{session_threadTrace} = $new_last_threadTrace;
609 return $new_last_threadTrace unless ($old_last_threadTrace);
612 return $old_last_threadTrace;
615 sub last_message_type {
617 my $new_last_message_type = shift;
619 my $old_last_message_type = $self->{last_message_type};
620 if (defined $new_last_message_type) {
621 $self->{last_message_type} = $new_last_message_type;
622 return $new_last_message_type unless ($old_last_message_type);
625 return $old_last_message_type;
628 sub last_message_api_level {
630 my $new_last_message_api_level = shift;
632 my $old_last_message_api_level = $self->{last_message_api_level};
633 if (defined $new_last_message_api_level) {
634 $self->{last_message_api_level} = $new_last_message_api_level;
635 return $new_last_message_api_level unless ($old_last_message_api_level);
638 return $old_last_message_api_level;
643 my $new_remote_id = shift;
645 my $old_remote_id = $self->{remote_id};
646 if (defined $new_remote_id) {
647 $self->{remote_id} = $new_remote_id;
648 return $new_remote_id unless ($old_remote_id);
651 return $old_remote_id;
659 my $old_ua = $self->{client_auth};
660 if (defined $new_ua) {
661 $self->{client_auth} = $new_ua;
662 return $new_ua unless ($old_ua);
665 return $old_ua->cloneNode(1);
670 my $new_state = shift;
672 my $old_state = $self->{state};
673 if (defined $new_state) {
674 $self->{state} = $new_state;
675 return $new_state unless ($old_state);
683 delete $$self{$_} for keys %$self;
693 if ( !(@proto_args % 2) ) {
695 } elsif (@proto_args == 1) {
696 %args = ( timeout => @proto_args );
700 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
702 if( exists( $args{timeout} ) ) {
703 $args{timeout} = int($args{timeout});
704 $self->{recv_timeout} = $args{timeout};
707 #$args{timeout} = 0 if ($self->complete);
709 if(defined($args{timeout})) {
710 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
713 my $avail = @{ $self->{recv_queue} };
714 $self->{remaining_recv_timeout} = $self->{recv_timeout};
718 $args{count} = $avail;
724 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
725 last if $self->complete;
726 my $starttime = time;
727 $self->queue_wait($self->{remaining_recv_timeout});
729 if ($self->{timeout_reset}) {
730 $self->{timeout_reset} = 0;
732 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
734 $avail = @{ $self->{recv_queue} };
739 while ( my $msg = shift @{ $self->{recv_queue} } ) {
741 last if (scalar(@list) >= $args{count});
744 $logger->debug( "Number of matched responses: " . @list, DEBUG );
745 $self->queue_wait(0); # check for statuses
747 return $list[0] unless (wantarray);
753 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
758 $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
759 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
760 $req->resend unless $req->complete;
767 if( ! $self->{peer_handle} ) { return 0; }
768 my $timeout = shift || 0;
769 $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
770 my $o = $self->{peer_handle}->process($timeout);
778 foreach my $msg ( @{$self->{recv_queue}} ) {
779 $string = $string . $msg->toString(1) . "\n";
787 $self->send( 'STATUS', @_ );
790 sub reset_request_timeout {
793 my $req = $self->app_request($tt);
794 $req->{remaining_recv_timeout} = $req->{recv_timeout};
795 $req->{timout_reset} = 1;
798 #-------------------------------------------------------------------------------
800 package OpenSRF::AppRequest;
801 use base qw/OpenSRF::AppSession/;
802 use OpenSRF::Utils::Logger qw/:level/;
803 use OpenSRF::DomainObject::oilsResponse qw/:status/;
804 use Time::HiRes qw/time usleep/;
808 $class = ref($class) || $class;
811 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
814 my $self = { session => $session,
815 threadTrace => $threadTrace,
820 remaining_recv_timeout => 30,
824 bless $self => $class;
826 push @{ $self->session->{request_queue} }, $self;
834 if (defined $timeout) {
835 $self->{recv_timeout} = $timeout;
836 $self->{remaining_recv_timeout} = $timeout;
838 return $self->{recv_timeout};
842 my $size = @{$_[0]->{recv_queue}};
848 return unless ($self and $self->session and !$self->complete);
849 $self->session->send(@_);
854 return unless $self->session;
855 $self->session->remove_app_request($self);
856 delete($$self{$_}) for (keys %$self);
860 return shift()->{session};
865 my $complete = shift;
866 return $self->{complete} if ($self->{complete});
867 if (defined $complete) {
868 $self->{complete} = $complete;
869 $self->{_duration} = time - $self->{_start} if ($self->{complete});
871 $self->session->queue_wait(0);
873 return $self->{complete};
878 $self->wait_complete;
879 return $self->{_duration};
884 my $timeout = shift || 10;
885 my $time_remaining = $timeout;
887 while ( ! $self->complete and $time_remaining > 0 ) {
888 my $starttime = time;
889 $self->queue_wait($time_remaining);
891 $time_remaining -= ($endtime - $starttime);
894 return $self->complete;
898 return shift()->{threadTrace};
904 if( !$resp ) { return 0; }
905 if( UNIVERSAL::isa($resp, "Error")) {
906 $self->{failed} = $resp;
908 #return; eventually...
910 push @{ $self->{recv_queue} }, $resp;
915 return $self->{failed};
920 return $self->session->queue_wait(@_)
923 sub payload { return shift()->{payload}; }
927 return unless ($self and $self->session and !$self->complete);
928 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
929 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
935 return unless ($self and $self->session and !$self->complete);
936 $self->session->send( 'STATUS',$msg, $self->threadTrace );
942 $self->respond( $msg );
948 return unless ($self and $self->session and !$self->complete);
951 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
954 $response = new OpenSRF::DomainObject::oilsResult;
955 $response->content($msg);
958 $self->session->send('RESULT', $response, $self->threadTrace);
961 sub respond_complete {
964 return unless ($self and $self->session and !$self->complete);
967 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
970 $response = new OpenSRF::DomainObject::oilsResult;
971 $response->content($msg);
974 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
975 statusCode => STATUS_COMPLETE(),
976 status => 'Request Complete' );
979 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
983 sub register_death_callback {
986 $self->session->register_callback( death => $cb );
990 # utility method. checks to see of the request failed.
991 # if so, throws an OpenSRF::EX::ERROR. if everything is
992 # ok, it returns the content of the request
996 $self->wait_complete;
997 my $resp = $self->recv( timeout => 60 );
998 if( $self->failed() ) {
999 throw OpenSRF::EX::ERROR
1000 ($self->failed()->stringify());
1002 if(!$resp) { return undef; }
1003 my $content = $resp->content;
1004 if($finish) { $self->finish();}
1009 package OpenSRF::AppSubrequest;
1014 push @{$$self{resp}}, $resp if (defined $resp);
1016 sub respond_complete { respond(@_); }
1020 $class = ref($class) || $class;
1021 return bless({resp => [], @_}, $class);
1024 sub responses { @{$_[0]->{resp}} }