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