src/perlmods/OpenSRF/AppSession.pm

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