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::Logger qw(:level);
9 use OpenSRF::Utils::SettingsClient;
10 use OpenSRF::Utils::Config;
14 use base qw/Exporter OpenSRF/;
15 use Time::HiRes qw( time usleep );
19 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
20 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
21 endpoint => [ qw/CLIENT SERVER/ ],
24 my $logger = "OpenSRF::Utils::Logger";
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 );
91 $logger->debug( "AppSession returning existing session $sess_id", DEBUG );
94 $logger->debug( "AppSession building new server session $sess_id", DEBUG );
97 if( $service eq "client" ) {
98 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
99 # " Session ID [$sess_id], remote_id [$remote_id]");
101 warn "Attempting to build a client session as ".
102 "a server Session ID [$sess_id], remote_id [$remote_id]";
104 $logger->debug("Attempting to build a client session as ".
105 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
110 my $config_client = OpenSRF::Utils::SettingsClient->new();
111 my $stateless = $config_client->config_value("apps", $service, "stateless");
113 #my $max_requests = $conf->$service->max_requests;
114 my $max_requests = $config_client->config_value("apps",$service,"max_requests");
115 $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
117 $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
119 my $self = bless { recv_queue => [],
126 session_id => $sess_id,
127 remote_id => $remote_id,
128 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
129 max_requests => $max_requests,
130 session_threadTrace => 0,
132 stateless => $stateless,
135 return $_CACHE{$sess_id} = $self;
140 my ($name, $datum) = @_;
142 $self->{session_data}->{$name} = $datum if (defined $datum);
143 return $self->{session_data}->{$name};
146 sub service { return shift()->{service}; }
148 sub continue_request {
150 $self->{'requests'}++;
151 return 1 if (!$self->{'max_requests'});
152 return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
155 sub last_sent_payload {
156 my( $self, $payload ) = @_;
158 return $self->{'last_sent_payload'} = $payload;
160 return $self->{'last_sent_payload'};
164 my( $self, $type ) = @_;
166 return $self->{'last_sent_type'} = $type;
168 return $self->{'last_sent_type'};
171 sub get_app_targets {
174 my $conf = OpenSRF::Utils::Config->current;
175 my $router_name = $conf->bootstrap->router_name || 'router';
176 my $routers = $conf->bootstrap->domains;
178 unless($router_name and $routers) {
179 throw OpenSRF::EX::Config
180 ("Missing router config information 'router_name' and 'routers'");
184 for my $router (@$routers) {
185 push @targets, "$router_name\@$router/$app";
194 $self->{stateless} = $state if (defined $state);
195 return $self->{stateless};
198 # When we're a client and we want to connect to a remote service
199 # create( $app, username => $user, secret => $passwd );
201 # create( $app, sysname => $user, secret => $shared_secret );
204 $class = ref($class) || $class;
207 my $api_level = shift;
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,
236 #client_auth => $auth,
240 state => DISCONNECTED,#since we're init'ing
241 session_id => $sess_id,
243 raise_error => $quiet ? 0 : 1,
244 api_level => $api_level,
245 orig_remote_id => $r_id,
246 peer_handle => $peer_handle,
247 session_threadTrace => 0,
248 stateless => $stateless,
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 );
415 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
420 $method->params( @_ );
422 $self->send('REQUEST',$method);
431 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
436 $method->params( @_ );
438 $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
443 my @payload_list = @_; # this is a Domain Object
445 return unless ($self and $self->{peer_handle});
447 $logger->debug( "In send", INTERNAL );
451 if( @payload_list % 2 ) { $tT = pop @payload_list; }
453 if( ! @payload_list ) {
454 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
460 $logger->debug( "In send2", INTERNAL );
465 while( @payload_list ) {
467 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
469 if ($msg_type eq 'DISCONNECT' ) {
471 if( $self->state == DISCONNECTED && !$connecting) {
476 if( $msg_type eq "CONNECT" ) {
480 my $msg = OpenSRF::DomainObject::oilsMessage->new();
481 $msg->type($msg_type);
484 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
487 if ($msg->type eq 'REQUEST') {
488 if ( !defined($tT) || $self->last_threadTrace != $tT ) {
489 $msg->update_threadTrace;
490 $self->session_threadTrace( $msg->threadTrace );
491 $tT = $self->session_threadTrace;
492 OpenSRF::AppRequest->new($self, $payload);
496 $msg->api_level($self->api_level);
497 $msg->payload($payload) if $payload;
502 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
503 " with threadTrace [".$msg->threadTrace."]" );
507 if ($self->endpoint == CLIENT and ! $disconnect) {
508 $self->queue_wait(0);
511 if($self->stateless && $self->state != CONNECTED) {
513 $logger->debug("AppSession is stateless in send", DEBUG );
516 if( !$self->stateless and $self->state != CONNECTED ) {
518 $logger->debug( "Sending connect before request 1", INTERNAL );
520 unless (($self->state == CONNECTING && $connecting )) {
521 $logger->debug( "Sending connect before request 2", INTERNAL );
522 my $v = $self->connect();
524 $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
527 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
534 $logger->debug( "AppSession sending doc: " . JSON->perl2JSON(\@doc), INTERNAL );
537 $self->{peer_handle}->send(
538 to => $self->remote_id,
539 thread => $self->session_id,
540 body => JSON->perl2JSON(\@doc) );
543 $self->state( DISCONNECTED );
546 my $req = $self->app_request( $tT );
547 $req->{_start} = time;
555 return undef unless (defined $tT);
556 my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
561 sub remove_app_request {
565 my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
567 $self->{request_queue} = \@list;
571 return $_[0]->{endpoint};
577 return $self->{session_id};
583 my $req = $self->app_request($resp->[1]);
584 return $req->push_queue( $resp->[0] ) if ($req);
585 push @{ $self->{recv_queue} }, $resp->[0];
588 sub last_threadTrace {
590 my $new_last_threadTrace = shift;
592 my $old_last_threadTrace = $self->{last_threadTrace};
593 if (defined $new_last_threadTrace) {
594 $self->{last_threadTrace} = $new_last_threadTrace;
595 return $new_last_threadTrace unless ($old_last_threadTrace);
598 return $old_last_threadTrace;
601 sub session_threadTrace {
603 my $new_last_threadTrace = shift;
605 my $old_last_threadTrace = $self->{session_threadTrace};
606 if (defined $new_last_threadTrace) {
607 $self->{session_threadTrace} = $new_last_threadTrace;
608 return $new_last_threadTrace unless ($old_last_threadTrace);
611 return $old_last_threadTrace;
614 sub last_message_type {
616 my $new_last_message_type = shift;
618 my $old_last_message_type = $self->{last_message_type};
619 if (defined $new_last_message_type) {
620 $self->{last_message_type} = $new_last_message_type;
621 return $new_last_message_type unless ($old_last_message_type);
624 return $old_last_message_type;
627 sub last_message_api_level {
629 my $new_last_message_api_level = shift;
631 my $old_last_message_api_level = $self->{last_message_api_level};
632 if (defined $new_last_message_api_level) {
633 $self->{last_message_api_level} = $new_last_message_api_level;
634 return $new_last_message_api_level unless ($old_last_message_api_level);
637 return $old_last_message_api_level;
642 my $new_remote_id = shift;
644 my $old_remote_id = $self->{remote_id};
645 if (defined $new_remote_id) {
646 $self->{remote_id} = $new_remote_id;
647 return $new_remote_id unless ($old_remote_id);
650 return $old_remote_id;
658 my $old_ua = $self->{client_auth};
659 if (defined $new_ua) {
660 $self->{client_auth} = $new_ua;
661 return $new_ua unless ($old_ua);
664 return $old_ua->cloneNode(1);
669 my $new_state = shift;
671 my $old_state = $self->{state};
672 if (defined $new_state) {
673 $self->{state} = $new_state;
674 return $new_state unless ($old_state);
682 delete $$self{$_} for keys %$self;
692 if ( !(@proto_args % 2) ) {
694 } elsif (@proto_args == 1) {
695 %args = ( timeout => @proto_args );
699 #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
701 if( exists( $args{timeout} ) ) {
702 $args{timeout} = int($args{timeout});
703 $self->{recv_timeout} = $args{timeout};
706 #$args{timeout} = 0 if ($self->complete);
708 if(defined($args{timeout})) {
709 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
712 my $avail = @{ $self->{recv_queue} };
713 $self->{remaining_recv_timeout} = $self->{recv_timeout};
717 $args{count} = $avail;
723 while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
724 last if $self->complete;
725 my $starttime = time;
726 $self->queue_wait($self->{remaining_recv_timeout});
728 if ($self->{timeout_reset}) {
729 $self->{timeout_reset} = 0;
731 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
733 $avail = @{ $self->{recv_queue} };
738 while ( my $msg = shift @{ $self->{recv_queue} } ) {
740 last if (scalar(@list) >= $args{count});
743 $logger->debug( "Number of matched responses: " . @list, DEBUG );
744 $self->queue_wait(0); # check for statuses
746 return $list[0] unless (wantarray);
752 push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
757 $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
758 while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
759 $req->resend unless $req->complete;
766 if( ! $self->{peer_handle} ) { return 0; }
767 my $timeout = shift || 0;
768 $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
769 my $o = $self->{peer_handle}->process($timeout);
777 foreach my $msg ( @{$self->{recv_queue}} ) {
778 $string = $string . $msg->toString(1) . "\n";
786 $self->send( 'STATUS', @_ );
789 sub reset_request_timeout {
792 my $req = $self->app_request($tt);
793 $req->{remaining_recv_timeout} = $req->{recv_timeout};
794 $req->{timout_reset} = 1;
797 #-------------------------------------------------------------------------------
799 package OpenSRF::AppRequest;
800 use base qw/OpenSRF::AppSession/;
801 use OpenSRF::Utils::Logger qw/:level/;
802 use OpenSRF::DomainObject::oilsResponse qw/:status/;
803 use Time::HiRes qw/time usleep/;
807 $class = ref($class) || $class;
810 my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
813 my $self = { session => $session,
814 threadTrace => $threadTrace,
819 remaining_recv_timeout => 30,
823 bless $self => $class;
825 push @{ $self->session->{request_queue} }, $self;
831 my $size = @{$_[0]->{recv_queue}};
837 return unless ($self and $self->session and !$self->complete);
838 $self->session->send(@_);
843 return unless $self->session;
844 $self->session->remove_app_request($self);
845 delete($$self{$_}) for (keys %$self);
849 return shift()->{session};
854 my $complete = shift;
855 return $self->{complete} if ($self->{complete});
856 if (defined $complete) {
857 $self->{complete} = $complete;
858 $self->{_duration} = time - $self->{_start} if ($self->{complete});
860 $self->session->queue_wait(0);
862 return $self->{complete};
867 $self->wait_complete;
868 return $self->{_duration};
873 my $timeout = shift || 10;
874 my $time_remaining = $timeout;
876 while ( ! $self->complete and $time_remaining > 0 ) {
877 my $starttime = time;
878 $self->queue_wait($time_remaining);
880 $time_remaining -= ($endtime - $starttime);
883 return $self->complete;
887 return shift()->{threadTrace};
893 if( !$resp ) { return 0; }
894 if( UNIVERSAL::isa($resp, "Error")) {
895 $self->{failed} = $resp;
897 #return; eventually...
899 push @{ $self->{recv_queue} }, $resp;
904 return $self->{failed};
909 OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
910 return $self->session->queue_wait(@_)
913 sub payload { return shift()->{payload}; }
917 return unless ($self and $self->session and !$self->complete);
918 OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
919 return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
925 return unless ($self and $self->session and !$self->complete);
926 $self->session->send( 'STATUS',$msg, $self->threadTrace );
932 return unless ($self and $self->session and !$self->complete);
935 if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
938 $response = new OpenSRF::DomainObject::oilsResult;
939 $response->content($msg);
942 $self->session->send('RESULT', $response, $self->threadTrace);
945 sub respond_complete {
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 my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
959 statusCode => STATUS_COMPLETE(),
960 status => 'Request Complete' );
963 $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
967 sub register_death_callback {
970 $self->session->register_callback( death => $cb );
974 # utility method. checks to see of the request failed.
975 # if so, throws an OpenSRF::EX::ERROR. if everything is
976 # ok, it returns the content of the request
980 $self->wait_complete;
981 my $resp = $self->recv( timeout => 60 );
982 if( $self->failed() ) {
983 throw OpenSRF::EX::ERROR
984 ($self->failed()->stringify());
986 if(!$resp) { return undef; }
987 my $content = $resp->content;
988 if($finish) { $self->finish();}
993 package OpenSRF::AppSubrequest;
998 push @{$$self{resp}}, $resp if (defined $resp);
1000 sub respond_complete { respond(@_); }
1004 $class = ref($class) || $class;
1005 return bless({resp => [], @_}, $class);
1008 sub responses { @{$_[0]->{resp}} }