src/perlmods/OpenSRF/AppSession.pm

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