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