OpenSRF/src/perlmods/OpenSRF/AppSession.pm

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