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