src/perlmods/OpenSRF/AppSession.pm

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