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 base qw/Exporter OpenSRF/;
  14 use Time::HiRes qw( time usleep );
  15 use warnings;
  16 use strict;
  17
  18 our @EXPORT_OK = qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED CLIENT SERVER/;
  19 our %EXPORT_TAGS = ( state => [ qw/CONNECTING INIT_CONNECTED CONNECTED DISCONNECTED/ ],
  20                  endpoint => [ qw/CLIENT SERVER/ ],
  21 );
  22
  23 my $logger = "OpenSRF::Utils::Logger";
  24 my $_last_locale = 'en-US';
  25
  26 our %_CACHE;
  27 our @_RESEND_QUEUE;
  28
  29 sub CONNECTING { return 3 };
  30 sub INIT_CONNECTED { return 4 };
  31 sub CONNECTED { return 1 };
  32 sub DISCONNECTED { return 2 };
  33
  34 sub CLIENT { return 2 };
  35 sub SERVER { return 1 };
  36
  37 sub find {
  38         return undef unless (defined $_[1]);
  39         return $_CACHE{$_[1]} if (exists($_CACHE{$_[1]}));
  40 }
  41
  42 sub transport_connected {
  43         my $self = shift;
  44         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
  45                 return 0;
  46         }
  47         return $self->{peer_handle}->tcp_connected();
  48 }
  49
  50 sub connected {
  51         my $self = shift;
  52         return $self->state == CONNECTED;
  53 }
  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 # ----------------------------------------------------------------------------
  64 sub buffer_reset {
  65
  66         my $self = shift;
  67         if( ! exists $self->{peer_handle} || ! $self->{peer_handle} ) {
  68                 return 0;
  69         }
  70         $self->{peer_handle}->buffer_reset();
  71 }
  72
  73
  74 # when any incoming data is received, this method is called.
  75 sub server_build {
  76         my $class = shift;
  77         $class = ref($class) || $class;
  78
  79         my $sess_id = shift;
  80         my $remote_id = shift;
  81         my $service = shift;
  82
  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);
  86
  87         return undef unless ($sess_id and $remote_id and $service);
  88
  89         if ( my $thingy = $class->find($sess_id) ) {
  90                 $thingy->remote_id( $remote_id );
  91                 return $thingy;
  92         }
  93
  94         if( $service eq "client" ) {
  95                 #throw OpenSRF::EX::PANIC ("Attempting to build a client session as a server" .
  96                 #       " Session ID [$sess_id], remote_id [$remote_id]");
  97
  98                 warn "Attempting to build a client session as ".
  99                                 "a server Session ID [$sess_id], remote_id [$remote_id]";
 100
 101                 $logger->debug("Attempting to build a client session as ".
 102                                 "a server Session ID [$sess_id], remote_id [$remote_id]", ERROR );
 103
 104                 return undef;
 105         }
 106
 107         my $config_client = OpenSRF::Utils::SettingsClient->new();
 108         my $stateless = $config_client->config_value("apps", $service, "stateless");
 109
 110         #my $max_requests = $conf->$service->max_requests;
 111         my $max_requests        = $config_client->config_value("apps",$service,"max_requests");
 112         $logger->debug( "Max Requests for $service is $max_requests", INTERNAL ) if (defined $max_requests);
 113
 114         $logger->transport( "AppSession creating new session: $sess_id", INTERNAL );
 115
 116         my $self = bless { recv_queue  => [],
 117                            request_queue  => [],
 118                            requests  => 0,
 119                            session_data  => {},
 120                            callbacks  => {},
 121                            endpoint    => SERVER,
 122                            state       => CONNECTING,
 123                            session_id  => $sess_id,
 124                            remote_id    => $remote_id,
 125                                 peer_handle => OpenSRF::Transport::PeerHandle->retrieve($service),
 126                                 max_requests => $max_requests,
 127                                 session_threadTrace => 0,
 128                                 service => $service,
 129                                 stateless => $stateless,
 130                          } => $class;
 131
 132         return $_CACHE{$sess_id} = $self;
 133 }
 134
 135 sub session_data {
 136         my $self = shift;
 137         my ($name, $datum) = @_;
 138
 139         $self->{session_data}->{$name} = $datum if (defined $datum);
 140         return $self->{session_data}->{$name};
 141 }
 142
 143 sub service { return shift()->{service}; }
 144
 145 sub continue_request {
 146         my $self = shift;
 147         $self->{'requests'}++;
 148         return 1 if (!$self->{'max_requests'});
 149         return $self->{'requests'} <= $self->{'max_requests'} ? 1 : 0;
 150 }
 151
 152 sub last_sent_payload {
 153         my( $self, $payload ) = @_;
 154         if( $payload ) {
 155                 return $self->{'last_sent_payload'} = $payload;
 156         }
 157         return $self->{'last_sent_payload'};
 158 }
 159
 160 sub session_locale {
 161         my( $self, $type ) = @_;
 162         if( $type ) {
 163         $_last_locale = $type if ($self->endpoint == SERVER);
 164                 return $self->{'session_locale'} = $type;
 165         }
 166         return $self->{'session_locale'};
 167 }
 168
 169 sub last_sent_type {
 170         my( $self, $type ) = @_;
 171         if( $type ) {
 172                 return $self->{'last_sent_type'} = $type;
 173         }
 174         return $self->{'last_sent_type'};
 175 }
 176
 177 sub get_app_targets {
 178         my $app = shift;
 179
 180         my $conf = OpenSRF::Utils::Config->current;
 181         my $router_name = $conf->bootstrap->router_name || 'router';
 182         my $domain = $conf->bootstrap->domain;
 183         $logger->error("use of <domains/> is deprecated") if $conf->bootstrap->domains;
 184
 185         unless($router_name and $domain) {
 186                 throw OpenSRF::EX::Config
 187                         ("Missing router config information 'router_name' and 'domain'");
 188         }
 189
 190     return ("$router_name\@$domain/$app");
 191 }
 192
 193 sub stateless {
 194         my $self = shift;
 195         my $state = shift;
 196         $self->{stateless} = $state if (defined $state);
 197         return $self->{stateless};
 198 }
 199
 200 # When we're a client and we want to connect to a remote service
 201 sub create {
 202         my $class = shift;
 203         $class = ref($class) || $class;
 204
 205         my $app = shift;
 206         my $api_level = shift;
 207         my $quiet = shift;
 208         my $locale = shift || $_last_locale;
 209
 210         $api_level = 1 if (!defined($api_level));
 211
 212         $logger->debug( "AppSession creating new client session for $app", DEBUG );
 213
 214         my $stateless = 0;
 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");
 220         }
 221
 222         my $sess_id = time . rand( $$ );
 223         while ( $class->find($sess_id) ) {
 224                 $sess_id = time . rand( $$ );
 225         }
 226
 227
 228         my ($r_id) = get_app_targets($app);
 229
 230         my $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("client");
 231         if( ! $peer_handle ) {
 232                 $peer_handle = OpenSRF::Transport::PeerHandle->retrieve("system_client");
 233         }
 234
 235         my $self = bless { app_name    => $app,
 236                            request_queue  => [],
 237                            endpoint    => CLIENT,
 238                            state       => DISCONNECTED,#since we're init'ing
 239                            session_id  => $sess_id,
 240                            remote_id   => $r_id,
 241                            raise_error   => $quiet ? 0 : 1,
 242                            session_locale   => $locale,
 243                            api_level   => $api_level,
 244                            orig_remote_id   => $r_id,
 245                                 peer_handle => $peer_handle,
 246                                 session_threadTrace => 0,
 247                                 stateless               => $stateless,
 248                          } => $class;
 249
 250         $logger->debug( "Created new client session $app : $sess_id" );
 251
 252         return $_CACHE{$sess_id} = $self;
 253 }
 254
 255 sub raise_remote_errors {
 256         my $self = shift;
 257         my $err = shift;
 258         $self->{raise_error} = $err if (defined $err);
 259         return $self->{raise_error};
 260 }
 261
 262 sub api_level {
 263         return shift()->{api_level};
 264 }
 265
 266 sub app {
 267         return shift()->{app_name};
 268 }
 269
 270 sub reset {
 271         my $self = shift;
 272         $self->remote_id($$self{orig_remote_id});
 273 }
 274
 275 # 'connect' can be used as a constructor if called as a class method,
 276 # or used to connect a session that has disconnectd if called against
 277 # an existing session that seems to be disconnected, or was just built
 278 # using 'create' above.
 279
 280 # connect( $app, username => $user, secret => $passwd );
 281 #    OR
 282 # connect( $app, sysname => $user, secret => $shared_secret );
 283
 284 # --- Returns undef if the connect attempt times out.
 285 # --- Returns the OpenSRF::EX object if one is returned by the server
 286 # --- Returns self if connected
 287 sub connect {
 288         my $self = shift;
 289         my $class = ref($self) || $self;
 290
 291
 292         if ( ref( $self ) and  $self->state && $self->state == CONNECTED  ) {
 293                 $logger->transport("AppSession already connected", DEBUG );
 294         } else {
 295                 $logger->transport("AppSession not connected, connecting..", DEBUG );
 296         }
 297         return $self if ( ref( $self ) and  $self->state && $self->state == CONNECTED  );
 298
 299
 300         my $app = shift;
 301         my $api_level = shift;
 302         $api_level = 1 unless (defined $api_level);
 303
 304         $self = $class->create($app, @_) if (!ref($self));
 305
 306         return undef unless ($self);
 307
 308         $self->{api_level} = $api_level;
 309
 310         $self->reset;
 311         $self->state(CONNECTING);
 312         $self->send('CONNECT', "");
 313
 314
 315         # if we want to connect to settings, we may not have
 316         # any data for the settings client to work with...
 317         # just using a default for now XXX
 318
 319         my $time_remaining = 5;
 320
 321
 322 #       my $client = OpenSRF::Utils::SettingsClient->new();
 323 #       my $trans = $client->config_value("client_connection","transport_host");
 324 #
 325 #       if(!ref($trans)) {
 326 #               $time_remaining = $trans->{connect_timeout};
 327 #       } else {
 328 #               # XXX for now, just use the first
 329 #               $time_remaining = $trans->[0]->{connect_timeout};
 330 #       }
 331
 332         while ( $self->state != CONNECTED  and $time_remaining > 0 ) {
 333                 my $starttime = time;
 334                 $self->queue_wait($time_remaining);
 335                 my $endtime = time;
 336                 $time_remaining -= ($endtime - $starttime);
 337         }
 338
 339         return undef unless($self->state == CONNECTED);
 340
 341         $self->stateless(0);
 342
 343         return $self;
 344 }
 345
 346 sub finish {
 347         my $self = shift;
 348         if( ! $self->session_id ) {
 349                 return 0;
 350         }
 351 }
 352
 353 sub unregister_callback {
 354         my $self = shift;
 355         my $type = shift;
 356         my $cb = shift;
 357         if (exists $self->{callbacks}{$type}) {
 358                 delete $self->{callbacks}{$type}{$cb};
 359                 return $cb;
 360         }
 361         return undef;
 362 }
 363
 364 sub register_callback {
 365         my $self = shift;
 366         my $type = shift;
 367         my $cb = shift;
 368         my $cb_key = "$cb";
 369         $self->{callbacks}{$type}{$cb_key} = $cb;
 370         return $cb_key;
 371 }
 372
 373 sub kill_me {
 374         my $self = shift;
 375         if( ! $self->session_id ) { return 0; }
 376
 377         # run each 'death' callback;
 378         if (exists $self->{callbacks}{death}) {
 379                 for my $sub (values %{$self->{callbacks}{death}}) {
 380                         $sub->($self);
 381                 }
 382         }
 383
 384         $self->disconnect;
 385         $logger->transport( "AppSession killing self: " . $self->session_id(), DEBUG );
 386         delete $_CACHE{$self->session_id};
 387         delete($$self{$_}) for (keys %$self);
 388 }
 389
 390 sub disconnect {
 391         my $self = shift;
 392
 393         # run each 'disconnect' callback;
 394         if (exists $self->{callbacks}{disconnect}) {
 395                 for my $sub (values %{$self->{callbacks}{disconnect}}) {
 396                         $sub->($self);
 397                 }
 398         }
 399
 400         if ( !$self->stateless and $self->state != DISCONNECTED ) {
 401                 $self->send('DISCONNECT', "") if ($self->endpoint == CLIENT);
 402                 $self->state( DISCONNECTED );
 403         }
 404
 405         $self->reset;
 406 }
 407
 408 sub request {
 409         my $self = shift;
 410         my $meth = shift;
 411         return unless $self;
 412
 413    # tell the logger to create a new xid - the logger will decide if it's really necessary
 414    $logger->mk_osrf_xid;
 415
 416         my $method;
 417         if (!ref $meth) {
 418                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
 419         } else {
 420                 $method = $meth;
 421         }
 422
 423         $method->params( @_ );
 424
 425         $self->send('REQUEST',$method);
 426 }
 427
 428 sub full_request {
 429         my $self = shift;
 430         my $meth = shift;
 431
 432         my $method;
 433         if (!ref $meth) {
 434                 $method = new OpenSRF::DomainObject::oilsMethod ( method => $meth );
 435         } else {
 436                 $method = $meth;
 437         }
 438
 439         $method->params( @_ );
 440
 441         $self->send(CONNECT => '', REQUEST => $method, DISCONNECT => '');
 442 }
 443
 444 sub send {
 445         my $self = shift;
 446         my @payload_list = @_; # this is a Domain Object
 447
 448         return unless ($self and $self->{peer_handle});
 449
 450         $logger->debug( "In send", INTERNAL );
 451
 452         my $tT;
 453
 454         if( @payload_list % 2 ) { $tT = pop @payload_list; }
 455
 456         if( ! @payload_list ) {
 457                 $logger->debug( "payload_list param is incomplete in AppSession::send()", ERROR );
 458                 return undef;
 459         }
 460
 461         my @doc = ();
 462
 463         my $disconnect = 0;
 464         my $connecting = 0;
 465
 466         while( @payload_list ) {
 467
 468                 my ($msg_type, $payload) = ( shift(@payload_list), shift(@payload_list) );
 469
 470                 if ($msg_type eq 'DISCONNECT' ) {
 471                         $disconnect++;
 472                         if( $self->state == DISCONNECTED && !$connecting) {
 473                                 next;
 474                         }
 475                 }
 476
 477                 if( $msg_type eq "CONNECT" ) {
 478                         $connecting++;
 479                 }
 480
 481                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
 482                 $msg->type($msg_type);
 483
 484                 no warnings;
 485                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
 486                 use warnings;
 487
 488                 if ($msg->type eq 'REQUEST') {
 489                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
 490                                 $msg->update_threadTrace;
 491                                 $self->session_threadTrace( $msg->threadTrace );
 492                                 $tT = $self->session_threadTrace;
 493                                 OpenSRF::AppRequest->new($self, $payload);
 494                         }
 495                 }
 496
 497                 $msg->api_level($self->api_level);
 498                 $msg->payload($payload) if $payload;
 499
 500         my $locale = $self->session_locale;
 501                 $msg->sender_locale($locale) if ($locale);
 502
 503                 push @doc, $msg;
 504
 505
 506                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
 507                         " with threadTrace [".$msg->threadTrace."]");
 508
 509         }
 510
 511         if ($self->endpoint == CLIENT and ! $disconnect) {
 512                 $self->queue_wait(0);
 513
 514
 515                 if($self->stateless && $self->state != CONNECTED) {
 516                         $self->reset;
 517                         $logger->debug("AppSession is stateless in send", INTERNAL );
 518                 }
 519
 520                 if( !$self->stateless and $self->state != CONNECTED ) {
 521
 522                         $logger->debug( "Sending connect before request 1", INTERNAL );
 523
 524                         unless (($self->state == CONNECTING && $connecting )) {
 525                                 $logger->debug( "Sending connect before request 2", INTERNAL );
 526                                 my $v = $self->connect();
 527                                 if( ! $v ) {
 528                                         $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
 529                                         return undef;
 530                                 }
 531                                 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
 532                                         return $v;
 533                                 }
 534                         }
 535                 }
 536
 537         }
 538         my $json = OpenSRF::Utils::JSON->perl2JSON(\@doc);
 539         $logger->internal("AppSession sending doc: $json");
 540
 541         $self->{peer_handle}->send(
 542                                         to     => $self->remote_id,
 543                                    thread => $self->session_id,
 544                                    body   => $json );
 545
 546         if( $disconnect) {
 547                 $self->state( DISCONNECTED );
 548         }
 549
 550         my $req = $self->app_request( $tT );
 551         $req->{_start} = time;
 552         return $req
 553 }
 554
 555 sub app_request {
 556         my $self = shift;
 557         my $tT = shift;
 558
 559         return undef unless (defined $tT);
 560         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
 561
 562         return $req;
 563 }
 564
 565 sub remove_app_request {
 566         my $self = shift;
 567         my $req = shift;
 568
 569         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
 570
 571         $self->{request_queue} = \@list;
 572 }
 573
 574 sub endpoint {
 575         return $_[0]->{endpoint};
 576 }
 577
 578
 579 sub session_id {
 580         my $self = shift;
 581         return $self->{session_id};
 582 }
 583
 584 sub push_queue {
 585         my $self = shift;
 586         my $resp = shift;
 587         my $req = $self->app_request($resp->[1]);
 588         return $req->push_queue( $resp->[0] ) if ($req);
 589         push @{ $self->{recv_queue} }, $resp->[0];
 590 }
 591
 592 sub last_threadTrace {
 593         my $self = shift;
 594         my $new_last_threadTrace = shift;
 595
 596         my $old_last_threadTrace = $self->{last_threadTrace};
 597         if (defined $new_last_threadTrace) {
 598                 $self->{last_threadTrace} = $new_last_threadTrace;
 599                 return $new_last_threadTrace unless ($old_last_threadTrace);
 600         }
 601
 602         return $old_last_threadTrace;
 603 }
 604
 605 sub session_threadTrace {
 606         my $self = shift;
 607         my $new_last_threadTrace = shift;
 608
 609         my $old_last_threadTrace = $self->{session_threadTrace};
 610         if (defined $new_last_threadTrace) {
 611                 $self->{session_threadTrace} = $new_last_threadTrace;
 612                 return $new_last_threadTrace unless ($old_last_threadTrace);
 613         }
 614
 615         return $old_last_threadTrace;
 616 }
 617
 618 sub last_message_type {
 619         my $self = shift;
 620         my $new_last_message_type = shift;
 621
 622         my $old_last_message_type = $self->{last_message_type};
 623         if (defined $new_last_message_type) {
 624                 $self->{last_message_type} = $new_last_message_type;
 625                 return $new_last_message_type unless ($old_last_message_type);
 626         }
 627
 628         return $old_last_message_type;
 629 }
 630
 631 sub last_message_api_level {
 632         my $self = shift;
 633         my $new_last_message_api_level = shift;
 634
 635         my $old_last_message_api_level = $self->{last_message_api_level};
 636         if (defined $new_last_message_api_level) {
 637                 $self->{last_message_api_level} = $new_last_message_api_level;
 638                 return $new_last_message_api_level unless ($old_last_message_api_level);
 639         }
 640
 641         return $old_last_message_api_level;
 642 }
 643
 644 sub remote_id {
 645         my $self = shift;
 646         my $new_remote_id = shift;
 647
 648         my $old_remote_id = $self->{remote_id};
 649         if (defined $new_remote_id) {
 650                 $self->{remote_id} = $new_remote_id;
 651                 return $new_remote_id unless ($old_remote_id);
 652         }
 653
 654         return $old_remote_id;
 655 }
 656
 657 sub client_auth {
 658         return undef;
 659         my $self = shift;
 660         my $new_ua = shift;
 661
 662         my $old_ua = $self->{client_auth};
 663         if (defined $new_ua) {
 664                 $self->{client_auth} = $new_ua;
 665                 return $new_ua unless ($old_ua);
 666         }
 667
 668         return $old_ua->cloneNode(1);
 669 }
 670
 671 sub state {
 672         my $self = shift;
 673         my $new_state = shift;
 674
 675         my $old_state = $self->{state};
 676         if (defined $new_state) {
 677                 $self->{state} = $new_state;
 678                 return $new_state unless ($old_state);
 679         }
 680
 681         return $old_state;
 682 }
 683
 684 sub DESTROY {
 685         my $self = shift;
 686         delete $$self{$_} for keys %$self;
 687         return undef;
 688 }
 689
 690 sub recv {
 691         my $self = shift;
 692         my @proto_args = @_;
 693         my %args;
 694
 695         if ( @proto_args ) {
 696                 if ( !(@proto_args % 2) ) {
 697                         %args = @proto_args;
 698                 } elsif (@proto_args == 1) {
 699                         %args = ( timeout => @proto_args );
 700                 }
 701         }
 702
 703         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
 704
 705         if( exists( $args{timeout} ) ) {
 706                 $args{timeout} = int($args{timeout});
 707                 $self->{recv_timeout} = $args{timeout};
 708         }
 709
 710         #$args{timeout} = 0 if ($self->complete);
 711
 712         if(defined($args{timeout})) {
 713                 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
 714         }
 715
 716         my $avail = @{ $self->{recv_queue} };
 717         $self->{remaining_recv_timeout} = $self->{recv_timeout};
 718
 719         if (!$args{count}) {
 720                 if (wantarray) {
 721                         $args{count} = $avail;
 722                 } else {
 723                         $args{count} = 1;
 724                 }
 725         }
 726
 727         while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
 728                         last if $self->complete;
 729                         my $starttime = time;
 730                         $self->queue_wait($self->{remaining_recv_timeout});
 731                         my $endtime = time;
 732                         if ($self->{timeout_reset}) {
 733                                 $self->{timeout_reset} = 0;
 734                         } else {
 735                                 $self->{remaining_recv_timeout} -= ($endtime - $starttime)
 736                         }
 737                         $avail = @{ $self->{recv_queue} };
 738         }
 739
 740     $self->timed_out(1) if ( $self->{remaining_recv_timeout} <= 0 );
 741
 742         my @list;
 743         while ( my $msg = shift @{ $self->{recv_queue} } ) {
 744                 push @list, $msg;
 745                 last if (scalar(@list) >= $args{count});
 746         }
 747
 748         $logger->debug( "Number of matched responses: " . @list, DEBUG );
 749         $self->queue_wait(0); # check for statuses
 750
 751         return $list[0] if (!wantarray);
 752         return @list;
 753 }
 754
 755 sub timed_out {
 756     my $self = shift;
 757     my $out = shift;
 758     $self->{timed_out} = $out if (defined $out);
 759     return $self->{timed_out};
 760 }
 761
 762 sub push_resend {
 763         my $self = shift;
 764         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
 765 }
 766
 767 sub flush_resend {
 768         my $self = shift;
 769         $logger->debug( "Resending..." . @_RESEND_QUEUE, INTERNAL );
 770         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
 771                 $req->resend unless $req->complete;
 772         }
 773 }
 774
 775
 776 sub queue_wait {
 777         my $self = shift;
 778         if( ! $self->{peer_handle} ) { return 0; }
 779         my $timeout = shift || 0;
 780         $logger->debug( "Calling queue_wait($timeout)" , INTERNAL );
 781         my $o = $self->{peer_handle}->process($timeout);
 782         $self->flush_resend;
 783         return $o;
 784 }
 785
 786 sub _print_queue {
 787         my( $self ) = @_;
 788         my $string = "";
 789         foreach my $msg ( @{$self->{recv_queue}} ) {
 790                 $string = $string . $msg->toString(1) . "\n";
 791         }
 792         return $string;
 793 }
 794
 795 sub status {
 796         my $self = shift;
 797         return unless $self;
 798         $self->send( 'STATUS', @_ );
 799 }
 800
 801 sub reset_request_timeout {
 802         my $self = shift;
 803         my $tt = shift;
 804         my $req = $self->app_request($tt);
 805         $req->{remaining_recv_timeout} = $req->{recv_timeout};
 806         $req->{timout_reset} = 1;
 807 }
 808
 809 #-------------------------------------------------------------------------------
 810
 811 package OpenSRF::AppRequest;
 812 use base qw/OpenSRF::AppSession/;
 813 use OpenSRF::Utils::Logger qw/:level/;
 814 use OpenSRF::DomainObject::oilsResponse qw/:status/;
 815 use Time::HiRes qw/time usleep/;
 816
 817 sub new {
 818         my $class = shift;
 819         $class = ref($class) || $class;
 820
 821         my $session = shift;
 822         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
 823         my $payload = shift;
 824
 825         my $self = {    session                 => $session,
 826                         threadTrace             => $threadTrace,
 827                         payload                 => $payload,
 828                         complete                => 0,
 829                         timeout_reset           => 0,
 830                         recv_timeout            => 30,
 831                         remaining_recv_timeout  => 30,
 832                         recv_queue              => [],
 833         };
 834
 835         bless $self => $class;
 836
 837         push @{ $self->session->{request_queue} }, $self;
 838
 839         return $self;
 840 }
 841
 842 sub recv_timeout {
 843         my $self = shift;
 844         my $timeout = shift;
 845         if (defined $timeout) {
 846                 $self->{recv_timeout} = $timeout;
 847                 $self->{remaining_recv_timeout} = $timeout;
 848         }
 849         return $self->{recv_timeout};
 850 }
 851
 852 sub queue_size {
 853         my $size = @{$_[0]->{recv_queue}};
 854         return $size;
 855 }
 856
 857 sub send {
 858         my $self = shift;
 859         return unless ($self and $self->session and !$self->complete);
 860         $self->session->send(@_);
 861 }
 862
 863 sub finish {
 864         my $self = shift;
 865         return unless $self->session;
 866         $self->session->remove_app_request($self);
 867         delete($$self{$_}) for (keys %$self);
 868 }
 869
 870 sub session {
 871         return shift()->{session};
 872 }
 873
 874 sub complete {
 875         my $self = shift;
 876         my $complete = shift;
 877         return $self->{complete} if ($self->{complete});
 878         if (defined $complete) {
 879                 $self->{complete} = $complete;
 880                 $self->{_duration} = time - $self->{_start} if ($self->{complete});
 881         } else {
 882                 $self->session->queue_wait(0);
 883         }
 884         return $self->{complete};
 885 }
 886
 887 sub duration {
 888         my $self = shift;
 889         $self->wait_complete;
 890         return $self->{_duration};
 891 }
 892
 893 sub wait_complete {
 894         my $self = shift;
 895         my $timeout = shift || 10;
 896         my $time_remaining = $timeout;
 897
 898         while ( ! $self->complete  and $time_remaining > 0 ) {
 899                 my $starttime = time;
 900                 $self->queue_wait($time_remaining);
 901                 my $endtime = time;
 902                 $time_remaining -= ($endtime - $starttime);
 903         }
 904
 905         return $self->complete;
 906 }
 907
 908 sub threadTrace {
 909         return shift()->{threadTrace};
 910 }
 911
 912 sub push_queue {
 913         my $self = shift;
 914         my $resp = shift;
 915         if( !$resp ) { return 0; }
 916         if( UNIVERSAL::isa($resp, "Error")) {
 917                 $self->{failed} = $resp;
 918                 $self->complete(1);
 919                 #return; eventually...
 920         }
 921         push @{ $self->{recv_queue} }, $resp;
 922 }
 923
 924 sub failed {
 925         my $self = shift;
 926         return $self->{failed};
 927 }
 928
 929 sub queue_wait {
 930         my $self = shift;
 931         return $self->session->queue_wait(@_)
 932 }
 933
 934 sub payload { return shift()->{payload}; }
 935
 936 sub resend {
 937         my $self = shift;
 938         return unless ($self and $self->session and !$self->complete);
 939         OpenSRF::Utils::Logger->debug( "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
 940         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
 941 }
 942
 943 sub status {
 944         my $self = shift;
 945         my $msg = shift;
 946         return unless ($self and $self->session and !$self->complete);
 947         $self->session->send( 'STATUS',$msg, $self->threadTrace );
 948 }
 949
 950 sub stream_push {
 951         my $self = shift;
 952         my $msg = shift;
 953         $self->respond( $msg );
 954 }
 955
 956 sub respond {
 957         my $self = shift;
 958         my $msg = shift;
 959         return unless ($self and $self->session and !$self->complete);
 960
 961         my $response;
 962         if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
 963                 $response = $msg;
 964         } else {
 965                 $response = new OpenSRF::DomainObject::oilsResult;
 966                 $response->content($msg);
 967         }
 968
 969         $self->session->send('RESULT', $response, $self->threadTrace);
 970 }
 971
 972 sub respond_complete {
 973         my $self = shift;
 974         my $msg = shift;
 975         return unless ($self and $self->session and !$self->complete);
 976
 977         my $response;
 978         if (ref($msg) && UNIVERSAL::isa($msg, 'OpenSRF::DomainObject::oilsResult')) {
 979                 $response = $msg;
 980         } else {
 981                 $response = new OpenSRF::DomainObject::oilsResult;
 982                 $response->content($msg);
 983         }
 984
 985         my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
 986                 statusCode => STATUS_COMPLETE(),
 987                 status => 'Request Complete' );
 988
 989
 990         $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
 991         $self->complete(1);
 992 }
 993
 994 sub register_death_callback {
 995         my $self = shift;
 996         my $cb = shift;
 997         $self->session->register_callback( death => $cb );
 998 }
 999
1000
1001 # utility method.  checks to see of the request failed.
1002 # if so, throws an OpenSRF::EX::ERROR. if everything is
1003 # ok, it returns the content of the request
1004 sub gather {
1005         my $self = shift;
1006         my $finish = shift;
1007         $self->wait_complete;
1008         my $resp = $self->recv( timeout => 60 );
1009         if( $self->failed() ) {
1010                 throw OpenSRF::EX::ERROR
1011                         ($self->failed()->stringify());
1012         }
1013         if(!$resp) { return undef; }
1014         my $content = $resp->content;
1015         if($finish) { $self->finish();}
1016         return $content;
1017 }
1018
1019
1020 package OpenSRF::AppSubrequest;
1021
1022 sub respond {
1023         my $self = shift;
1024         my $resp = shift;
1025         push @{$$self{resp}}, $resp if (defined $resp);
1026 }
1027 sub respond_complete { respond(@_); }
1028
1029 sub new {
1030         my $class = shift;
1031         $class = ref($class) || $class;
1032         return bless({resp => [], @_}, $class);
1033 }
1034
1035 sub responses { @{$_[0]->{resp}} }
1036
1037 sub session {
1038         my $x = shift;
1039         my $s = shift;
1040         $x->{session} = $s if ($s);
1041         return $x->{session};
1042 }
1043
1044 sub status {}
1045
1046
1047 1;
1048