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