LP#1717350: fix chunking messages sent from Perl services
[OpenSRF.git] / src / perl / lib / OpenSRF / AppSession.pm
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;
10 use OpenSRF::EX;
11 use OpenSRF;
12 use Exporter;
13 use Encode;
14 use base qw/Exporter OpenSRF/;
15 use Time::HiRes qw( time usleep );
16 use POSIX ();
17 use warnings;
18 use strict;
19
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/ ],
23 );
24
25 my $logger = "OpenSRF::Utils::Logger";
26 my $_last_locale = 'en-US';
27 our $current_ingress = 'opensrf';
28
29 # Get/set the locale used by all new client sessions 
30 # for the current process.  This is primarily useful 
31 # for clients that wish to make a series of opensrf 
32 # calls and don't wish to set the locale for each new 
33 # AppSession object.
34 #
35 # The caller should reset the locale when done using 
36 # reset_locale(), as the locale will otherwise persist 
37 # for the current process until set/reset again.
38 #
39 # This is not for SERVER processes, since they 
40 # adopt the locale of their respective callers.
41 sub default_locale {
42     my ($class, $locale) = @_;
43     $_last_locale = $locale if $locale;
44     return $_last_locale;
45 }
46 sub reset_locale {
47     my ($class) = @_;
48     return $_last_locale = 'en-US';
49 }
50
51 sub ingress {
52     my ($class, $ingress) = @_;
53     $current_ingress = $ingress if $ingress;
54     return $current_ingress;
55 }
56
57 our %_CACHE;
58 our @_RESEND_QUEUE;
59
60 sub CONNECTING { return 3 };
61 sub INIT_CONNECTED { return 4 };
62 sub CONNECTED { return 1 };
63 sub DISCONNECTED { return 2 };
64
65 sub CLIENT { return 2 };
66 sub SERVER { return 1 };
67
68 sub find {
69         return undef unless (defined $_[1]);
70         return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
71 }
72
73 sub transport_connected {
74         my $self = shift;
75         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
76                 return 0;
77         }
78         return $self->{peer_handle}->tcp_connected();
79 }
80
81 sub connected {
82         my $self = shift;
83         return $self->state == CONNECTED;
84 }
85 # ----------------------------------------------------------------------------
86 # Clears the transport buffers
87 # call this if you are not through with the sesssion, but you want 
88 # to have a clean slate.  You shouldn't have to call this if
89 # you are correctly 'recv'ing all of the data from a request.
90 # however, if you don't want all of the data, this will
91 # slough off any excess
92 #  * * Note: This will delete data for all sessions using this transport
93 # handle.  For example, all client sessions use the same handle.
94 # ----------------------------------------------------------------------------
95 sub buffer_reset {
96
97         my $self = shift;
98         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) { 
99                 return 0;
100         }
101         $self->{peer_handle}->buffer_reset();
102 }
103
104
105 # when any incoming data is received, this method is called.
106 sub server_build {
107         my $class = shift;
108         $class = ref($class) || $class;
109
110         my $sess_id = shift;
111         my $remote_id = shift;
112         my $service = shift;
113
114         warn "Missing args to server_build():\n" .
115                 "sess_id: $sess_id, remote_id: $remote_id, service: $service\n" 
116                 unless ($sess_id and $remote_id and $service);
117
118         return undef unless ($sess_id and $remote_id and $service);
119
120         if ( my $thingy = $class->find($sess_id) ) {
121                 $thingy->remote_id( $remote_id );
122                 return $thingy;
123         }
124
125         if( $service eq "client" ) {
126                 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
127                 #       " Session ID [$sess_id], remote_id [$remote_id]");
128
129                 warn "Attempting to build a client session as ".
130                                 "a server Session ID [$sess_id], remote_id [$remote_id]";
131
132                 $logger->debug("Attempting to build a client session as ".
133                                 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
134
135                 return undef;
136         }
137
138         my $config_client = OpenSRF::Utils::SettingsClient->new();
139         my $stateless = $config_client->config_value("apps", $service, "stateless");
140
141         #my $max_requests = $conf->$service->max_requests;
142         my $max_requests        = $config_client->config_value("apps",$service,"max_requests");
143         $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
144
145         $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
146
147         my $self = bless { recv_queue  => [],
148                            request_queue  => [],
149                            requests  => 0,
150                            session_data  => {},
151                            callbacks  => {},
152                            endpoint    => SERVER,
153                            state       => CONNECTING, 
154                            session_id  => $sess_id,
155                            remote_id    => $remote_id,
156                                 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
157                                 max_requests => $max_requests,
158                                 session_threadTrace => 0,
159                                 service => $service,
160                                 stateless => $stateless,
161                          } => $class;
162
163         return $_CACHE{$sess_id} = $self;
164 }
165
166 sub session_data {
167         my $self = shift;
168         my ($name, $datum) = @_;
169
170         $self->{session_data}->{$name} = $datum if (defined $datum);
171         return $self->{session_data}->{$name};
172 }
173
174 sub service { return shift()->{service}; }
175
176 sub continue_request {
177         my $self = shift;
178         $self->{'requests'}++;
179         return 1 if (!$self->{'max_requests'});
180         return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
181 }
182
183 sub last_sent_payload {
184         my( $self, $payload ) = @_;
185         if( $payload ) {
186                 return $self->{'last_sent_payload'} = $payload;
187         }
188         return $self->{'last_sent_payload'};
189 }
190
191 sub session_locale {
192         my( $self, $type ) = @_;
193         if( $type ) {
194         $_last_locale = $type if ($self->endpoint == SERVER);
195                 return $self->{'session_locale'} = $type;
196         }
197         return $self->{'session_locale'};
198 }
199
200 sub last_sent_type {
201         my( $self, $type ) = @_;
202         if( $type ) {
203                 return $self->{'last_sent_type'} = $type;
204         }
205         return $self->{'last_sent_type'};
206 }
207
208 sub get_app_targets {
209         my $app = shift;
210
211         my $conf = OpenSRF::Utils::Config->current;
212         my $router_name = $conf->bootstrap->router_name || 'router';
213         my $domain = $conf->bootstrap->domain;
214         $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
215
216         unless($router_name and $domain) {
217                 throw OpenSRF::EX::Config 
218                         ("Missing router config information 'router_name' and 'domain'");
219         }
220
221     return ("$router_name\@$domain/$app");
222 }
223
224 sub stateless {
225         my $self = shift;
226         my $state = shift;
227         $self->{stateless} = $state if (defined $state);
228         return $self->{stateless};
229 }
230
231 # When we're a client and we want to connect to a remote service
232 sub create {
233         my $class = shift;
234         $class = ref($class) || $class;
235
236         my $app = shift;
237         my $api_level = shift;
238         my $quiet = shift;
239         my $locale = shift || $_last_locale;
240
241         $api_level = 1 if (!defined($api_level));
242                                 
243         $logger->debug( "AppSession creating new client session for $app", DEBUG );
244
245         my $stateless = 0;
246         my $c = OpenSRF::Utils::SettingsClient->new();
247         # we can get an infinite loop if we're grabbing the settings and we
248         # need the settings to grab the settings...
249         if($app ne "opensrf.settings" || $c->has_config()) { 
250                 $stateless = $c->config_value("apps", $app, "stateless");
251         }
252
253         my $sess_id = time . rand( $$ );
254         while ( $class->find($sess_id) ) {
255                 $sess_id = time . rand( $$ );
256         }
257
258         
259         my ($r_id) = get_app_targets($app);
260
261         my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client"); 
262         if( ! $peer_handle ) {
263                 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
264         }
265
266         my $self = bless { app_name    => $app,
267                            request_queue  => [],
268                            endpoint    => CLIENT,
269                            state       => DISCONNECTED,#since we're init'ing
270                            session_id  => $sess_id,
271                            remote_id   => $r_id,
272                            raise_error   => $quiet ? 0 : 1,
273                            session_locale   => $locale,
274                            api_level   => $api_level,
275                            orig_remote_id   => $r_id,
276                                 peer_handle => $peer_handle,
277                                 session_threadTrace => 0,
278                                 stateless               => $stateless,
279                          } => $class;
280
281         $logger->debug( "Created new client session $app : $sess_id" );
282
283         return $_CACHE{$sess_id} = $self;
284 }
285
286 sub raise_remote_errors {
287         my $self = shift;
288         my $err = shift;
289         $self->{raise_error} = $err if (defined $err);
290         return $self->{raise_error};
291 }
292
293 sub api_level {
294         return shift()->{api_level};
295 }
296
297 sub app {
298         return shift()->{app_name};
299 }
300
301 sub reset {
302         my $self = shift;
303         $self->remote_id($$self{orig_remote_id});
304 }
305
306 # 'connect' can be used as a constructor if called as a class method,
307 # or used to connect a session that has disconnectd if called against
308 # an existing session that seems to be disconnected, or was just built
309 # using 'create' above.
310
311 # connect( $app, username => $user, secret => $passwd );
312 #    OR
313 # connect( $app, sysname => $user, secret => $shared_secret );
314
315 # --- Returns undef if the connect attempt times out.
316 # --- Returns the OpenSRF::EX object if one is returned by the server
317 # --- Returns self if connected
318 sub connect {
319         my $self = shift;
320         my $class = ref($self) || $self;
321
322
323         if ( ref( $self ) and  $self->state && $self->state == CONNECTED  ) {
324                 $logger->transport("AppSession already connected", DEBUG );
325         } else {
326                 $logger->transport("AppSession not connected, connecting..", DEBUG );
327         }
328         return $self if ( ref( $self ) and  $self->state && $self->state == CONNECTED  );
329
330
331         my $app = shift;
332         my $api_level = shift;
333         $api_level = 1 unless (defined $api_level);
334
335         $self = $class->create($app, @_) if (!ref($self));
336
337         return undef unless ($self);
338
339         $self->{api_level} = $api_level;
340
341         $self->reset;
342         $self->state(CONNECTING);
343         $self->send('CONNECT', "");
344
345
346         # if we want to connect to settings, we may not have 
347         # any data for the settings client to work with...
348         # just using a default for now XXX
349
350         my $time_remaining = 5;
351
352
353 #       my $client = OpenSRF::Utils::SettingsClient->new();
354 #       my $trans = $client->config_value("client_connection","transport_host");
355 #
356 #       if(!ref($trans)) {
357 #               $time_remaining = $trans->{connect_timeout};
358 #       } else {
359 #               # XXX for now, just use the first
360 #               $time_remaining = $trans->[0]->{connect_timeout};
361 #       }
362
363         while ( $self->state != CONNECTED  and $time_remaining > 0 ) {
364                 my $starttime = time;
365                 $self->queue_wait($time_remaining);
366                 my $endtime = time;
367                 $time_remaining -= ($endtime - $starttime);
368         }
369
370         return undef unless($self->state == CONNECTED);
371
372         $self->stateless(0);
373
374         return $self;
375 }
376
377 sub finish {
378         my $self = shift;
379         if( ! $self->session_id ) {
380                 return 0;
381         }
382 }
383
384 sub unregister_callback {
385         my $self = shift;
386         my $type = shift;
387         my $cb = shift;
388         if (exists $self->{callbacks}{$type}) {
389                 delete $self->{callbacks}{$type}{$cb};
390                 return $cb;
391         }
392         return undef;
393 }
394
395 sub register_callback {
396         my $self = shift;
397         my $type = shift;
398         my $cb = shift;
399         my $cb_key = "$cb";
400         $self->{callbacks}{$type}{$cb_key} = $cb;
401         return $cb_key;
402 }
403
404 sub kill_me {
405         my $self = shift;
406         if( ! $self->session_id ) { return 0; }
407
408         # run each 'death' callback;
409         if (exists $self->{callbacks}{death}) {
410                 for my $sub (values %{$self->{callbacks}{death}}) {
411                         $sub->($self);
412                 }
413         }
414
415         $self->disconnect;
416         $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
417         delete $_CACHE{$self->session_id};
418         delete($$self{$_}) for (keys %$self);
419 }
420
421 sub disconnect {
422         my $self = shift;
423
424         # run each 'disconnect' callback;
425         if (exists $self->{callbacks}{disconnect}) {
426                 for my $sub (values %{$self->{callbacks}{disconnect}}) {
427                         $sub->($self);
428                 }
429         }
430
431         if ( !$self->stateless and $self->state != DISCONNECTED ) {
432                 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
433                 $self->state( DISCONNECTED ); 
434         }
435
436         $self->reset;
437 }
438
439 sub request {
440         my $self = shift;
441         my $meth = shift;
442         return unless $self;
443
444    # tell the logger to create a new xid - the logger will decide if it's really necessary
445    $logger->mk_osrf_xid;
446
447         my $method;
448         if (!ref $meth) {
449                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
450         } else {
451                 $method = $meth;
452         }
453         
454         $method->params( @_ );
455
456         $self->send('REQUEST',$method);
457 }
458
459 sub full_request {
460         my $self = shift;
461         my $meth = shift;
462
463         my $method;
464         if (!ref $meth) {
465                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
466         } else {
467                 $method = $meth;
468         }
469         
470         $method->params( @_ );
471
472         $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
473 }
474
475 sub send {
476         my $self = shift;
477         my @payload_list = @_; # this is a Domain Object
478
479         return unless ($self and $self->{peer_handle});
480
481         $logger->debug( "In send", INTERNAL );
482         
483         my $tT;
484
485         if( @payload_list % 2 ) { $tT = pop @payload_list; }
486
487         if( ! @payload_list ) {
488                 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
489                 return undef; 
490         }
491
492         my @doc = ();
493
494         my $disconnect = 0;
495         my $connecting = 0;
496
497         while( @payload_list ) {
498
499                 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) ); 
500
501                 if ($msg_type eq 'DISCONNECT' ) {
502                         $disconnect++;
503                         if( $self->state == DISCONNECTED && !$connecting) {
504                                 next;
505                         }
506                 }
507
508                 if( $msg_type eq "CONNECT" ) { 
509                         $connecting++; 
510                 }
511
512                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
513                 $msg->type($msg_type);
514         
515                 no warnings;
516                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
517                 use warnings;
518         
519                 if ($msg->type eq 'REQUEST') {
520                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
521                                 $msg->update_threadTrace;
522                                 $self->session_threadTrace( $msg->threadTrace );
523                                 $tT = $self->session_threadTrace;
524                                 OpenSRF::AppRequest->new($self, $payload);
525                         }
526                 }
527         
528                 $msg->api_level($self->api_level);
529                 $msg->payload($payload) if $payload;
530
531         my $locale = $self->session_locale;
532                 $msg->sender_locale($locale) if ($locale);
533
534                 $msg->sender_ingress($current_ingress);
535         
536                 push @doc, $msg;
537
538         
539                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
540                         " with threadTrace [".$msg->threadTrace."]");
541
542         }
543         
544         if ($self->endpoint == CLIENT and ! $disconnect) {
545                 $self->queue_wait(0);
546
547
548                 if($self->stateless && $self->state != CONNECTED) {
549                         $self->reset;
550                         $logger->debug("AppSession is stateless in send", INTERNAL );
551                 }
552
553                 if( !$self->stateless and $self->state != CONNECTED ) {
554
555                         $logger->debug( "Sending connect before request 1", INTERNAL );
556
557                         unless (($self->state == CONNECTING && $connecting )) {
558                                 $logger->debug( "Sending connect before request 2", INTERNAL );
559                                 my $v = $self->connect();
560                                 if( ! $v ) {
561                                         $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
562                                         return undef;
563                                 }
564                                 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
565                                         return $v;
566                                 }
567                         }
568                 }
569
570         } 
571         my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
572         $logger->internal("AppSession sending doc: $json");
573
574         $self->{peer_handle}->send( 
575                                         to     => $self->remote_id,
576                                    thread => $self->session_id,
577                                    body   => $json );
578
579         if( $disconnect) {
580                 $self->state( DISCONNECTED );
581         }
582
583         my $req = $self->app_request( $tT );
584         $req->{_start} = time;
585         return $req
586 }
587
588 sub app_request {
589         my $self = shift;
590         my $tT = shift;
591         
592         return undef unless (defined $tT);
593         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
594
595         return $req;
596 }
597
598 sub remove_app_request {
599         my $self = shift;
600         my $req = shift;
601         
602         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
603
604         $self->{request_queue} = \@list;
605 }
606
607 sub endpoint {
608         return $_[0]->{endpoint};
609 }
610
611
612 sub session_id {
613         my $self = shift;
614         return $self->{session_id};
615 }
616
617 sub push_queue {
618         my $self = shift;
619         my $resp = shift;
620         my $req = $self->app_request($resp->[1]);
621         return $req->push_queue( $resp->[0] ) if ($req);
622         push @{ $self->{recv_queue} }, $resp->[0];
623 }
624
625 sub last_threadTrace {
626         my $self = shift;
627         my $new_last_threadTrace = shift;
628
629         my $old_last_threadTrace = $self->{last_threadTrace};
630         if (defined $new_last_threadTrace) {
631                 $self->{last_threadTrace} = $new_last_threadTrace;
632                 return $new_last_threadTrace unless ($old_last_threadTrace);
633         }
634
635         return $old_last_threadTrace;
636 }
637
638 sub session_threadTrace {
639         my $self = shift;
640         my $new_last_threadTrace = shift;
641
642         my $old_last_threadTrace = $self->{session_threadTrace};
643         if (defined $new_last_threadTrace) {
644                 $self->{session_threadTrace} = $new_last_threadTrace;
645                 return $new_last_threadTrace unless ($old_last_threadTrace);
646         }
647
648         return $old_last_threadTrace;
649 }
650
651 sub last_message_type {
652         my $self = shift;
653         my $new_last_message_type = shift;
654
655         my $old_last_message_type = $self->{last_message_type};
656         if (defined $new_last_message_type) {
657                 $self->{last_message_type} = $new_last_message_type;
658                 return $new_last_message_type unless ($old_last_message_type);
659         }
660
661         return $old_last_message_type;
662 }
663
664 sub last_message_api_level {
665         my $self = shift;
666         my $new_last_message_api_level = shift;
667
668         my $old_last_message_api_level = $self->{last_message_api_level};
669         if (defined $new_last_message_api_level) {
670                 $self->{last_message_api_level} = $new_last_message_api_level;
671                 return $new_last_message_api_level unless ($old_last_message_api_level);
672         }
673
674         return $old_last_message_api_level;
675 }
676
677 sub remote_id {
678         my $self = shift;
679         my $new_remote_id = shift;
680
681         my $old_remote_id = $self->{remote_id};
682         if (defined $new_remote_id) {
683                 $self->{remote_id} = $new_remote_id;
684                 return $new_remote_id unless ($old_remote_id);
685         }
686
687         return $old_remote_id;
688 }
689
690 sub client_auth {
691         return undef;
692         my $self = shift;
693         my $new_ua = shift;
694
695         my $old_ua = $self->{client_auth};
696         if (defined $new_ua) {
697                 $self->{client_auth} = $new_ua;
698                 return $new_ua unless ($old_ua);
699         }
700
701         return $old_ua->cloneNode(1);
702 }
703
704 sub state {
705         my $self = shift;
706         my $new_state = shift;
707
708         my $old_state = $self->{state};
709         if (defined $new_state) {
710                 $self->{state} = $new_state;
711                 return $new_state unless ($old_state);
712         }
713
714         return $old_state;
715 }
716
717 sub DESTROY {
718         my $self = shift;
719         delete $$self{$_} for keys %$self;
720         return undef;
721 }
722
723 sub recv {
724         my $self = shift;
725         my @proto_args = @_;
726         my %args;
727
728         if ( @proto_args ) {
729                 if ( !(@proto_args % 2) ) {
730                         %args = @proto_args;
731                 } elsif (@proto_args == 1) {
732                         %args = ( timeout => @proto_args );
733                 }
734         }
735
736         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
737
738         if( exists( $args{timeout} ) ) {
739                 $args{timeout} = int($args{timeout});
740                 $self->{recv_timeout} = $args{timeout};
741         }
742
743         #$args{timeout} = 0 if ($self->complete);
744
745         if(defined($args{timeout})) {
746                 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
747         }
748
749         my $avail = @{ $self->{recv_queue} };
750         $self->{remaining_recv_timeout} = $self->{recv_timeout};
751
752         if (!$args{count}) {
753                 if (wantarray) {
754                         $args{count} = $avail;
755                 } else {
756                         $args{count} = 1;
757                 }
758         }
759
760         while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
761                         last if $self->complete;
762                         my $starttime = time;
763                         $self->queue_wait($self->{remaining_recv_timeout});
764                         my $endtime = time;
765                         if ($self->{timeout_reset}) {
766                                 $self->{timeout_reset} = 0;
767                         } else {
768                                 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
769                         }
770                         $avail = @{ $self->{recv_queue} };
771         }
772
773     $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
774
775         my @list;
776         while ( my $msg = shift @{ $self->{recv_queue} } ) {
777                 push @list, $msg;
778                 last if (scalar(@list) >= $args{count});
779         }
780
781         $logger->debug( "Number of matched responses: " . @list, DEBUG );
782         $self->queue_wait(0); # check for statuses
783         
784         return $list[0] if (!wantarray);
785         return @list;
786 }
787
788 sub timed_out {
789     my $self = shift;
790     my $out = shift;
791     $self->{timed_out} = $out if (defined $out);
792     return $self->{timed_out};
793 }
794
795 sub push_resend {
796         my $self = shift;
797         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
798 }
799
800 sub flush_resend {
801         my $self = shift;
802         $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
803         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
804                 $req->resend unless $req->complete;
805         }
806 }
807
808
809 sub queue_wait {
810         my $self = shift;
811         if( ! $self->{peer_handle} ) { return 0; }
812         my $timeout = shift || 0;
813         $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
814         my $o = $self->{peer_handle}->process($timeout);
815         $self->flush_resend;
816         return $o;
817 }
818
819 sub _print_queue {
820         my( $self ) = @_;
821         my $string = "";
822         foreach my $msg ( @{$self->{recv_queue}} ) {
823                 $string = $string . $msg->toString(1) . "\n";
824         }
825         return $string;
826 }
827
828 sub status {
829         my $self = shift;
830         return unless $self;
831         $self->send( 'STATUS', @_ );
832 }
833
834 sub reset_request_timeout {
835         my $self = shift;
836         my $tt = shift;
837         my $req = $self->app_request($tt);
838         $req->{remaining_recv_timeout} = $req->{recv_timeout};
839         $req->{timout_reset} = 1;
840 }
841
842 #-------------------------------------------------------------------------------
843
844 package OpenSRF::AppRequest;
845 use base qw/OpenSRF::AppSession/;
846 use OpenSRF::Utils::Logger qw/:level/;
847 use OpenSRF::DomainObject::oilsResponse qw/:status/;
848 use Time::HiRes qw/time usleep/;
849
850 sub new {
851         my $class = shift;
852         $class = ref($class) || $class;
853
854         my $session = shift;
855         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
856         my $payload = shift;
857         
858         my $self = {    session                 => $session,
859                         threadTrace             => $threadTrace,
860                         payload                 => $payload,
861                         complete                => 0,
862                         resp_count              => 0,
863                         max_bundle_count        => 0,
864                         current_bundle_count=> 0,
865                         max_chunk_size          => 0,
866                         max_bundle_size         => 0,
867                         current_bundle_size     => 0,
868                         current_bundle          => [],
869                         timeout_reset           => 0,
870                         recv_timeout            => 30,
871                         remaining_recv_timeout  => 30,
872                         recv_queue              => [],
873                         part_recv_buffer=> '',
874         };
875
876         bless $self => $class;
877
878         push @{ $self->session->{request_queue} }, $self;
879
880         return $self;
881 }
882
883 sub max_bundle_count {
884         my $self = shift;
885         my $value = shift;
886         $self->{max_bundle_count} = $value if (defined($value));
887         return $self->{max_bundle_count};
888 }
889
890 sub max_bundle_size {
891         my $self = shift;
892         my $value = shift;
893         $self->{max_bundle_size} = $value if (defined($value));
894         return $self->{max_bundle_size};
895 }
896
897 sub max_chunk_size {
898         my $self = shift;
899         my $value = shift;
900         $self->{max_chunk_size} = $value if (defined($value));
901         return $self->{max_chunk_size};
902 }
903
904 sub recv_timeout {
905         my $self = shift;
906         my $timeout = shift;
907         if (defined $timeout) {
908                 $self->{recv_timeout} = $timeout;
909                 $self->{remaining_recv_timeout} = $timeout;
910         }
911         return $self->{recv_timeout};
912 }
913
914 sub queue_size {
915         my $size = @{$_[0]->{recv_queue}};
916         return $size;
917 }
918         
919 sub send {
920         my $self = shift;
921         return unless ($self and $self->session and !$self->complete);
922         $self->session->send(@_);
923 }
924
925 sub finish {
926         my $self = shift;
927         return unless $self->session;
928         $self->session->remove_app_request($self);
929         delete($$self{$_}) for (keys %$self);
930 }
931
932 sub session {
933         return shift()->{session};
934 }
935
936 sub complete {
937         my $self = shift;
938         my $complete = shift;
939         return $self->{complete} if ($self->{complete});
940         if (defined $complete) {
941                 $self->{complete} = $complete;
942                 $self->{_duration} = time - $self->{_start} if ($self->{complete});
943         } else {
944                 $self->session->queue_wait(0);
945         }
946     $self->completing(0) if ($self->{complete});
947         return $self->{complete};
948 }
949
950 sub completing {
951         my $self = shift;
952         my $value = shift;
953         $self->{_completing} = $value if (defined($value));
954         return $self->{_completing};
955 }
956
957 sub duration {
958         my $self = shift;
959         $self->wait_complete;
960         return $self->{_duration};
961 }
962
963 sub wait_complete {
964         my $self = shift;
965         my $timeout = shift || 10;
966         my $time_remaining = $timeout;
967
968         while ( ! $self->complete  and $time_remaining > 0 ) {
969                 my $starttime = time;
970                 $self->queue_wait($time_remaining);
971                 my $endtime = time;
972                 $time_remaining -= ($endtime - $starttime);
973         }
974
975         return $self->complete;
976 }
977
978 sub threadTrace {
979         return shift()->{threadTrace};
980 }
981
982 sub push_queue {
983         my $self = shift;
984         my $resp = shift;
985         if( !$resp ) { return 0; }
986         if( UNIVERSAL::isa($resp, "Error")) {
987                 $self->{failed} = $resp;
988                 $self->complete(1);
989                 #return; eventually...
990         }
991
992         if( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::Partial")) {
993                 $self->{part_recv_buffer} .= $resp->content;
994                 return 1;
995         } elsif( UNIVERSAL::isa($resp, "OpenSRF::DomainObject::oilsResult::PartialComplete")) {
996                 if ($self->{part_recv_buffer}) {
997                         $resp = new OpenSRF::DomainObject::oilsResult;
998                         $resp->content( OpenSRF::Utils::JSON->JSON2perl( $self->{part_recv_buffer} ) );
999                         $self->{part_recv_buffer} = '';
1000                 } 
1001         }
1002
1003         push @{ $self->{recv_queue} }, $resp;
1004 }
1005
1006 sub failed {
1007         my $self = shift;
1008         return $self->{failed};
1009 }
1010
1011 sub queue_wait {
1012         my $self = shift;
1013         return $self->session->queue_wait(@_)
1014 }
1015
1016 sub payload { return shift()->{payload}; }
1017
1018 sub resend {
1019         my $self = shift;
1020         return unless ($self and $self->session and !$self->complete);
1021         OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
1022         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
1023 }
1024
1025 sub status {
1026         my $self = shift;
1027         my $msg = shift;
1028         return unless ($self and $self->session and !$self->complete);
1029         $self->session->send( 'STATUS',$msg, $self->threadTrace );
1030 }
1031
1032 # TODO stream_push only works when server sessions can accept RESULT 
1033 # messages, which is no longer supported.  Create a new OpenSRF message
1034 # type to support client-to-server streams.
1035 #sub stream_push {
1036 #       my $self = shift;
1037 #       my $msg = shift;
1038 #       $self->respond( $msg );
1039 #}
1040
1041 sub respond {
1042         my $self = shift;
1043         my $msg = shift;
1044         return unless ($self and $self->session and !$self->complete);
1045
1046     my $type = 'RESULT';
1047         my $response;
1048         if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResponse')) {
1049                 $response = $msg;
1050         $type = 'STATUS' if UNIVERSAL::isa($response, 'OpenSRF::DomainObject::oilsStatus');
1051
1052         } else {
1053
1054         if ($self->max_chunk_size > 0) { # we might need to chunk
1055             my $str = OpenSRF::Utils::JSON->perl2JSON($msg);
1056
1057             # XML can add a lot of length to a chunk due to escaping, so we
1058             # calculate chunk size based on an XML-escaped version of the message.
1059             # Example: If escaping doubles the length of the string then $ratio
1060             # will be 0.5 and we'll cut the chunk size for this message in half.
1061
1062             my $raw_length = length(Encode::encode_utf8($str)); # count bytes
1063             my $escaped_length = $raw_length;
1064             $escaped_length += 11 * (() = ( $str =~ /"/g)); # 7 \s and &quot;
1065             $escaped_length += 4 * (() = ( $str =~ /&/g)); # &amp;
1066             $escaped_length += 3 * (() = ( $str =~ /[<>]/g)); # &lt; / &gt;
1067
1068             my $chunk_size = $self->max_chunk_size;
1069
1070             if ($escaped_length > $self->max_chunk_size) {
1071                 $chunk_size = POSIX::floor(($raw_length / $escaped_length) * $self->max_chunk_size);
1072             }
1073
1074             if ($raw_length > $chunk_size) { # send partials ("chunking")
1075                 my $num_bytes = length(Encode::encode_utf8($str));
1076                 for (my $i = 0; $i < $num_bytes; $i += $chunk_size) {
1077                     $response = new OpenSRF::DomainObject::oilsResult::Partial;
1078                     $response->content( substr($str, $i, $chunk_size) );
1079                     $self->session->send($type, $response, $self->threadTrace);
1080                 }
1081                 # This triggers reconstruction on the remote end
1082                 $response = new OpenSRF::DomainObject::oilsResult::PartialComplete;
1083                 return $self->session->send($type, $response, $self->threadTrace);
1084             }
1085         }
1086
1087         # message failed to exceed max chunk size OR chunking disabled
1088         $response = new OpenSRF::DomainObject::oilsResult;
1089         $response->content($msg);
1090     }
1091
1092     if ($self->{max_bundle_count} > 0 or $self->{max_bundle_size} > 0) { # we are bundling, and we need to test the size or count
1093
1094         $self->{current_bundle_size} += length(
1095             Encode::encode_utf8(OpenSRF::Utils::JSON->perl2JSON($response)));
1096         push @{$self->{current_bundle}}, $type, $response;  
1097         $self->{current_bundle_count}++;
1098
1099         if ( $self->completing ||
1100                 ($self->{max_bundle_size}  && $self->{current_bundle_size}  >= $self->{max_bundle_size} ) ||
1101                 ($self->{max_bundle_count} && $self->{current_bundle_count} >= $self->{max_bundle_count})
1102         ) { # send chunk and reset
1103             my $send_res = $self->session->send( @{$self->{current_bundle}}, $self->threadTrace);
1104             $self->{current_bundle} = [];
1105             $self->{current_bundle_size} = 0;
1106             $self->{current_bundle_count} = 0;
1107             return $send_res;
1108         } else { # not at a chunk yet, just queue it up
1109             return $self->session->app_request( $self->threadTrace );
1110         }
1111     }
1112
1113         $self->session->send($type, $response, $self->threadTrace);
1114 }
1115
1116 sub respond_complete {
1117         my $self = shift;
1118         my $msg = shift;
1119         return unless ($self and $self->session and !$self->complete);
1120
1121     $self->respond($msg) if (defined($msg));
1122
1123     $self->completing(1);
1124     $self->respond(
1125         OpenSRF::DomainObject::oilsConnectStatus->new(
1126             statusCode => STATUS_COMPLETE(),
1127             status => 'Request Complete'
1128         )
1129     );
1130         $self->complete(1);
1131 }
1132
1133 sub register_death_callback {
1134         my $self = shift;
1135         my $cb = shift;
1136         $self->session->register_callback( death => $cb );
1137 }
1138
1139
1140 # utility method.  checks to see of the request failed.
1141 # if so, throws an OpenSRF::EX::ERROR. if everything is
1142 # ok, it returns the content of the request
1143 sub gather {
1144         my $self = shift;
1145         my $finish = shift;
1146         $self->wait_complete;
1147         my $resp = $self->recv( timeout => 60 );
1148         if( $self->failed() ) { 
1149                 throw OpenSRF::EX::ERROR
1150                         ($self->failed()->stringify());
1151         }
1152         if(!$resp) { return undef; }
1153         my $content = $resp->content;
1154         if($finish) { $self->finish();}
1155         return $content;
1156 }
1157
1158
1159 package OpenSRF::AppSubrequest;
1160 use base 'OpenSRF::AppRequest';
1161
1162 sub respond {
1163         my $self = shift;
1164         return if $self->complete;
1165
1166         my $resp = shift;
1167     return $self->SUPER::respond($resp) if $self->respond_directly;
1168
1169         push @{$$self{resp}}, $resp if (defined $resp);
1170 }
1171
1172 sub respond_complete {
1173         my $self = shift;
1174     return $self->SUPER::respond_complete(@_) if $self->respond_directly;
1175         $self->respond(@_);
1176         $self->complete(1);
1177 }
1178
1179 sub new {
1180     my $class = shift;
1181     $class = ref($class) || $class;
1182     my $self = bless({
1183         complete        => 0,
1184         respond_directly=> 0,  # use the passed session directly (RD mode)
1185         resp            => [],
1186         threadTrace     => 0,  # needed for respond in RD mode
1187         max_chunk_count => 0,  # needed for respond in RD mode
1188         max_chunk_size  => 0,  # needed for respond in RD mode
1189         max_bundle_size => 0,
1190         current_bundle  => [], # needed for respond_complete in RD mode
1191         current_bundle_count=> 0,
1192         current_bundle_size     => 0,
1193         max_bundle_count        => 0,
1194         @_
1195     }, $class);
1196     if ($self->session) {
1197         # steal the thread trace from the parent session for RD mode
1198         $self->{threadTrace} = $self->session->session_threadTrace || $self->session->last_threadTrace;
1199     }
1200     return $self;
1201 }
1202
1203 sub responses { @{$_[0]->{resp}} }
1204
1205 sub respond_directly {
1206         my $x = shift;
1207         my $s = shift;
1208         $x->{respond_directly} = $s if (defined $s);
1209         return $x->session && $x->{respond_directly};
1210 }
1211
1212 sub session {
1213         my $x = shift;
1214         my $s = shift;
1215         $x->{session} = $s if ($s);
1216         return $x->{session};
1217 }
1218
1219 sub complete {
1220         my $x = shift;
1221         my $c = shift;
1222         $x->{complete} = $c if ($c);
1223     $x->completing(0) if ($c);
1224         return $x->{complete};
1225 }
1226
1227 sub completing {
1228         my $self = shift;
1229         my $value = shift;
1230         $self->{_completing} = $value if (defined($value));
1231         return $self->{_completing};
1232 }
1233
1234 sub status {}
1235
1236
1237 1;
1238