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