src/perlmods/OpenSRF/AppSession.pm

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