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                 if( $payload ) {
 508                         $logger->debug( "Payload is ".$payload->toString, INTERNAL );
 509                 }
 510
 511
 512                 my $msg = OpenSRF::DomainObject::oilsMessage->new();
 513                 $logger->debug( "AppSession after creating oilsMessage $msg", INTERNAL );
 514
 515                 $msg->type($msg_type);
 516                 $logger->debug( "AppSession after adding type" . $msg->toString(), INTERNAL );
 517
 518                 #$msg->userAuth($self->client_auth) if ($self->endpoint == CLIENT && $msg_type eq 'CONNECT');
 519
 520                 no warnings;
 521                 $msg->threadTrace( $tT || int($self->session_threadTrace) || int($self->last_threadTrace) );
 522                 use warnings;
 523
 524                 if ($msg->type eq 'REQUEST') {
 525                         if ( !defined($tT) || $self->last_threadTrace != $tT ) {
 526                                 $msg->update_threadTrace;
 527                                 $self->session_threadTrace( $msg->threadTrace );
 528                                 $tT = $self->session_threadTrace;
 529                                 OpenSRF::AppRequest->new($self, $payload);
 530                         }
 531                 }
 532
 533                 $msg->api_level($self->api_level);
 534                 $msg->payload($payload) if $payload;
 535
 536                 push @doc, $msg;
 537
 538
 539                 $logger->debug( "AppSession sending ".$msg->type." to ".$self->remote_id.
 540                         " with threadTrace [".$msg->threadTrace."]", INFO );
 541
 542         }
 543
 544         if ($self->endpoint == CLIENT and ! $disconnect) {
 545                 $self->queue_wait(0);
 546
 547
 548                 if($self->stateless && $self->state != CONNECTED) {
 549                         $self->reset;
 550                         $logger->debug("AppSession is stateless in send", DEBUG );
 551                 }
 552
 553                 if( !$self->stateless and $self->state != CONNECTED ) {
 554
 555                         $logger->debug( "Sending connect before request 1", INTERNAL );
 556
 557                         unless (($self->state == CONNECTING && $connecting )) {
 558                                 $logger->debug( "Sending connect before request 2", INTERNAL );
 559                                 my $v = $self->connect();
 560                                 if( ! $v ) {
 561                                         $logger->debug( "Unable to connect to remote service in AppSession::send()", ERROR );
 562                                         return undef;
 563                                 }
 564                                 if( ref($v) and $v->can("class") and $v->class->isa( "OpenSRF::EX" ) ) {
 565                                         return $v;
 566                                 }
 567                         }
 568                 }
 569
 570         }
 571         $logger->debug( "AppSession sending doc: " . JSON->perl2JSON(\@doc), INTERNAL );
 572
 573
 574         $self->{peer_handle}->send(
 575                                         to     => $self->remote_id,
 576                                    thread => $self->session_id,
 577                                    body   => JSON->perl2JSON(\@doc) );
 578
 579         if( $disconnect) {
 580                 $self->state( DISCONNECTED );
 581         }
 582
 583         return $self->app_request( $tT );
 584 }
 585
 586 sub app_request {
 587         my $self = shift;
 588         my $tT = shift;
 589
 590         return undef unless (defined $tT);
 591         my ($req) = grep { $_->threadTrace == $tT } @{ $self->{request_queue} };
 592
 593         return $req;
 594 }
 595
 596 sub remove_app_request {
 597         my $self = shift;
 598         my $req = shift;
 599
 600         my @list = grep { $_->threadTrace != $req->threadTrace } @{ $self->{request_queue} };
 601
 602         $self->{request_queue} = \@list;
 603 }
 604
 605 sub endpoint {
 606         return $_[0]->{endpoint};
 607 }
 608
 609
 610 sub session_id {
 611         my $self = shift;
 612         return $self->{session_id};
 613 }
 614
 615 sub push_queue {
 616         my $self = shift;
 617         my $resp = shift;
 618         my $req = $self->app_request($resp->[1]);
 619         return $req->push_queue( $resp->[0] ) if ($req);
 620         push @{ $self->{recv_queue} }, $resp->[0];
 621 }
 622
 623 sub last_threadTrace {
 624         my $self = shift;
 625         my $new_last_threadTrace = shift;
 626
 627         my $old_last_threadTrace = $self->{last_threadTrace};
 628         if (defined $new_last_threadTrace) {
 629                 $self->{last_threadTrace} = $new_last_threadTrace;
 630                 return $new_last_threadTrace unless ($old_last_threadTrace);
 631         }
 632
 633         return $old_last_threadTrace;
 634 }
 635
 636 sub session_threadTrace {
 637         my $self = shift;
 638         my $new_last_threadTrace = shift;
 639
 640         my $old_last_threadTrace = $self->{session_threadTrace};
 641         if (defined $new_last_threadTrace) {
 642                 $self->{session_threadTrace} = $new_last_threadTrace;
 643                 return $new_last_threadTrace unless ($old_last_threadTrace);
 644         }
 645
 646         return $old_last_threadTrace;
 647 }
 648
 649 sub last_message_type {
 650         my $self = shift;
 651         my $new_last_message_type = shift;
 652
 653         my $old_last_message_type = $self->{last_message_type};
 654         if (defined $new_last_message_type) {
 655                 $self->{last_message_type} = $new_last_message_type;
 656                 return $new_last_message_type unless ($old_last_message_type);
 657         }
 658
 659         return $old_last_message_type;
 660 }
 661
 662 sub last_message_api_level {
 663         my $self = shift;
 664         my $new_last_message_api_level = shift;
 665
 666         my $old_last_message_api_level = $self->{last_message_api_level};
 667         if (defined $new_last_message_api_level) {
 668                 $self->{last_message_api_level} = $new_last_message_api_level;
 669                 return $new_last_message_api_level unless ($old_last_message_api_level);
 670         }
 671
 672         return $old_last_message_api_level;
 673 }
 674
 675 sub remote_id {
 676         my $self = shift;
 677         my $new_remote_id = shift;
 678
 679         my $old_remote_id = $self->{remote_id};
 680         if (defined $new_remote_id) {
 681                 $self->{remote_id} = $new_remote_id;
 682                 return $new_remote_id unless ($old_remote_id);
 683         }
 684
 685         return $old_remote_id;
 686 }
 687
 688 sub client_auth {
 689         return undef;
 690         my $self = shift;
 691         my $new_ua = shift;
 692
 693         my $old_ua = $self->{client_auth};
 694         if (defined $new_ua) {
 695                 $self->{client_auth} = $new_ua;
 696                 return $new_ua unless ($old_ua);
 697         }
 698
 699         return $old_ua->cloneNode(1);
 700 }
 701
 702 sub state {
 703         my $self = shift;
 704         my $new_state = shift;
 705
 706         my $old_state = $self->{state};
 707         if (defined $new_state) {
 708                 $self->{state} = $new_state;
 709                 return $new_state unless ($old_state);
 710         }
 711
 712         return $old_state;
 713 }
 714
 715 sub DESTROY {
 716         my $self = shift;
 717         delete $$self{$_} for keys %$self;
 718         return undef;
 719 }
 720
 721 sub recv {
 722         my $self = shift;
 723         my @proto_args = @_;
 724         my %args;
 725
 726         if ( @proto_args ) {
 727                 if ( !(@proto_args % 2) ) {
 728                         %args = @proto_args;
 729                 } elsif (@proto_args == 1) {
 730                         %args = ( timeout => @proto_args );
 731                 }
 732         }
 733
 734         #$logger->debug( ref($self). " recv_queue before wait: " . $self->_print_queue(), INTERNAL );
 735
 736         if( exists( $args{timeout} ) ) {
 737                 $args{timeout} = int($args{timeout});
 738                 $self->{recv_timeout} = $args{timeout};
 739         }
 740
 741         #$args{timeout} = 0 if ($self->complete);
 742
 743         if(defined($args{timeout})) {
 744                 $logger->debug( ref($self) ."->recv with timeout " . $args{timeout}, INTERNAL );
 745         }
 746
 747         $args{count} ||= 1;
 748
 749         my $avail = @{ $self->{recv_queue} };
 750         $self->{remaining_recv_timeout} = $self->{recv_timeout};
 751
 752         while ( $self->{remaining_recv_timeout} > 0 and $avail < $args{count} ) {
 753                 last if $self->complete;
 754                 my $starttime = time;
 755                 $self->queue_wait($self->{remaining_recv_timeout});
 756                 my $endtime = time;
 757                 if ($self->{timeout_reset}) {
 758                         $self->{timeout_reset} = 0;
 759                 } else {
 760                         $self->{remaining_recv_timeout} -= ($endtime - $starttime)
 761                 }
 762                 $avail = @{ $self->{recv_queue} };
 763         }
 764
 765         #$logger->debug( ref($self)." queue after wait: " . $self->_print_queue(), INTERNAL );
 766
 767         my @list;
 768         while ( my $msg = shift @{ $self->{recv_queue} } ) {
 769                 push @list, $msg;
 770                 last if (scalar(@list) >= $args{count});
 771         }
 772
 773 #       $self->{recv_queue} = [@unlist, @{ $self->{recv_queue} }];
 774         $logger->debug( "Number of matched responses: " . @list, DEBUG );
 775
 776         $self->queue_wait(0); # check for statuses
 777
 778         return $list[0] unless (wantarray);
 779         return @list;
 780 }
 781
 782 sub push_resend {
 783         my $self = shift;
 784         push @OpenSRF::AppSession::_RESEND_QUEUE, @_;
 785 }
 786
 787 sub flush_resend {
 788         my $self = shift;
 789         $logger->debug( "Resending..." . @_RESEND_QUEUE, DEBUG );
 790         while ( my $req = shift @OpenSRF::AppSession::_RESEND_QUEUE ) {
 791                 $req->resend unless $req->complete;
 792         }
 793 }
 794
 795
 796 sub queue_wait {
 797         my $self = shift;
 798         if( ! $self->{peer_handle} ) { return 0; }
 799         my $timeout = shift || 0;
 800         $logger->debug( "Calling queue_wait($timeout)" , DEBUG );
 801         $logger->debug( "Timestamp before process($timeout) : " . $logger->format_time(), INTERNAL );
 802         my $o = $self->{peer_handle}->process($timeout);
 803         $logger->debug( "Timestamp after  process($timeout) : " . $logger->format_time(), INTERNAL );
 804         $self->flush_resend;
 805         return $o;
 806 }
 807
 808 sub _print_queue {
 809         my( $self ) = @_;
 810         my $string = "";
 811         foreach my $msg ( @{$self->{recv_queue}} ) {
 812                 $string = $string . $msg->toString(1) . "\n";
 813         }
 814         return $string;
 815 }
 816
 817 sub status {
 818         my $self = shift;
 819         return unless $self;
 820         $self->send( 'STATUS', @_ );
 821 }
 822
 823 sub reset_request_timeout {
 824         my $self = shift;
 825         my $tt = shift;
 826         my $req = $self->app_request($tt);
 827         $req->{remaining_recv_timeout} = $req->{recv_timeout};
 828         $req->{timout_reset} = 1;
 829 }
 830
 831 #-------------------------------------------------------------------------------
 832
 833 package OpenSRF::AppRequest;
 834 use base qw/OpenSRF::AppSession/;
 835 use OpenSRF::Utils::Logger qw/:level/;
 836 use OpenSRF::DomainObject::oilsResponse qw/:status/;
 837
 838 sub new {
 839         my $class = shift;
 840         $class = ref($class) || $class;
 841
 842         my $session = shift;
 843         my $threadTrace = $session->session_threadTrace || $session->last_threadTrace;
 844         my $payload = shift;
 845
 846         my $self = {    session                 => $session,
 847                         threadTrace             => $threadTrace,
 848                         payload                 => $payload,
 849                         complete                => 0,
 850                         timeout_reset           => 0,
 851                         recv_timeout            => 30,
 852                         remaining_recv_timeout  => 30,
 853                         recv_queue              => [],
 854         };
 855
 856         bless $self => $class;
 857
 858         push @{ $self->session->{request_queue} }, $self;
 859
 860         return $self;
 861 }
 862
 863 sub queue_size {
 864         my $size = @{$_[0]->{recv_queue}};
 865         return $size;
 866 }
 867
 868 sub send {
 869         my $self = shift;
 870         return unless ($self and $self->session and !$self->complete);
 871         $self->session->send(@_);
 872 }
 873
 874 sub finish {
 875         my $self = shift;
 876         return unless $self->session;
 877         $self->session->remove_app_request($self);
 878         delete($$self{$_}) for (keys %$self);
 879 }
 880
 881 sub session {
 882         return shift()->{session};
 883 }
 884
 885 sub complete {
 886         my $self = shift;
 887         my $complete = shift;
 888         return $self->{complete} if ($self->{complete});
 889         if (defined $complete) {
 890                 $self->{complete} = $complete;
 891         } else {
 892                 $self->session->queue_wait(0);
 893         }
 894         return $self->{complete};
 895 }
 896
 897 sub wait_complete {
 898         my $self = shift;
 899         my $timeout = shift || 1;
 900         my $time_remaining = $timeout;
 901
 902         while ( ! $self->complete  and $time_remaining > 0 ) {
 903                 my $starttime = time;
 904                 $self->queue_wait($time_remaining);
 905                 my $endtime = time;
 906                 $time_remaining -= ($endtime - $starttime);
 907         }
 908
 909         return $self->complete;
 910 }
 911
 912 sub threadTrace {
 913         return shift()->{threadTrace};
 914 }
 915
 916 sub push_queue {
 917         my $self = shift;
 918         my $resp = shift;
 919         if( !$resp ) { return 0; }
 920         if( UNIVERSAL::isa($resp, "Error")) {
 921                 $self->{failed} = $resp;
 922                 $self->complete(1);
 923                 #return; eventually...
 924         }
 925         push @{ $self->{recv_queue} }, $resp;
 926         OpenSRF::Utils::Logger->debug( "AppRequest pushed ".$resp->toString(), INTERNAL );
 927 }
 928
 929 sub failed {
 930         my $self = shift;
 931         return $self->{failed};
 932 }
 933
 934 sub queue_wait {
 935         my $self = shift;
 936         OpenSRF::Utils::Logger->debug( "Calling queue_wait(@_)", DEBUG );
 937         return $self->session->queue_wait(@_)
 938 }
 939
 940 sub payload { return shift()->{payload}; }
 941
 942 sub resend {
 943         my $self = shift;
 944         return unless ($self and $self->session and !$self->complete);
 945         OpenSRF::Utils::Logger->debug(
 946                 "I'm resending the request for threadTrace ". $self->threadTrace, DEBUG);
 947         if($self->payload) {
 948                 OpenSRF::Utils::Logger->debug($self->payload->toString,INTERNAL);
 949         }
 950         return $self->session->send('REQUEST', $self->payload, $self->threadTrace );
 951 }
 952
 953 sub status {
 954         my $self = shift;
 955         my $msg = shift;
 956         return unless ($self and $self->session and !$self->complete);
 957         $self->session->send( 'STATUS',$msg, $self->threadTrace );
 958 }
 959
 960 sub respond {
 961         my $self = shift;
 962         my $msg = shift;
 963         return unless ($self and $self->session and !$self->complete);
 964
 965         my $response;
 966         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 967                 $response = $msg;
 968         } else {
 969                 $response = new OpenSRF::DomainObject::oilsResult;
 970                 $response->content($msg);
 971         }
 972
 973         $self->session->send('RESULT', $response, $self->threadTrace);
 974 }
 975
 976 sub respond_complete {
 977         my $self = shift;
 978         my $msg = shift;
 979         return unless ($self and $self->session and !$self->complete);
 980
 981         my $response;
 982         if (ref($msg) && UNIVERSAL::can($msg, 'getAttribute') && $msg->getAttribute('name') =~ /oilsResult/) {
 983                 $response = $msg;
 984         } else {
 985                 $response = new OpenSRF::DomainObject::oilsResult;
 986                 $response->content($msg);
 987         }
 988
 989         my $stat = OpenSRF::DomainObject::oilsConnectStatus->new(
 990                 statusCode => STATUS_COMPLETE(),
 991                 status => 'Request Complete' );
 992
 993
 994         $self->session->send( 'RESULT' => $response, 'STATUS' => $stat, $self->threadTrace);
 995         $self->complete(1);
 996 }
 997
 998 sub register_death_callback {
 999         my $self = shift;
1000         my $cb = shift;
1001         $self->session->register_callback( death => $cb );
1002 }
1003
1004
1005 # utility method.  checks to see of the request failed.
1006 # if so, throws an OpenSRF::EX::ERROR. if everything is
1007 # ok, it returns the content of the request
1008 sub gather {
1009         my $self = shift;
1010         my $finish = shift;
1011         $self->wait_complete;
1012         my $resp = $self->recv( timeout => 60 );
1013         if( $self->failed() ) {
1014                 throw OpenSRF::EX::ERROR
1015                         ($self->failed()->stringify());
1016         }
1017         if(!$resp) { return undef; }
1018         my $content = $resp->content;
1019         if($finish) { $self->finish();}
1020         return $content;
1021 }
1022
1023
1024 package OpenSRF::AppSubrequest;
1025
1026 sub respond {
1027         my $self = shift;
1028         my $resp = shift;
1029         push @{$$self{resp}}, $resp if (defined $resp);
1030 }
1031 sub respond_complete { respond(@_); }
1032
1033 sub new {
1034         return bless({resp => []}, 'OpenSRF::AppSubrequest');
1035 }
1036
1037 sub responses { @{$_[0]->{resp}} }
1038
1039 sub status {}
1040
1041
1042 1;
1043