1 package OpenSRF::Application;
2 use vars qw/$_app $log @_METHODS $thunk $server_class/;
5 use OpenSRF::AppSession;
6 use OpenSRF::DomainObject::oilsMethod;
7 use OpenSRF::DomainObject::oilsResponse qw/:status/;
8 use OpenSRF::Utils::Logger qw/:level/;
10 use Time::HiRes qw/time/;
11 use OpenSRF::EX qw/:try/;
13 #use OpenSRF::UnixServer; # to get the server class from UnixServer::App
20 $log = 'OpenSRF::Utils::Logger';
23 our @pending_requests;
27 return 1 unless ref($self);
28 return $self->{package};
33 return 1 unless ref($self);
34 return $self->{api_name};
39 return 1 unless ref($self);
40 return $self->{api_level};
46 $server_class = $class;
54 $thunk = $flag if (defined $flag);
58 sub application_implementation {
66 $log->error( "Error loading application_implementation: $app -> $@", ERROR);
75 my ($self, $session, $app_msg) = @_;
81 $log->debug( "In Application::handler()", DEBUG );
83 my $app = $self->application_implementation;
86 $log->debug( "Application is $app", DEBUG);
88 $log->debug( "Message is ".$app_msg->toString(1), INTERNAL);
91 if ($session->last_message_type eq 'REQUEST') {
92 $log->debug( "We got a REQUEST: ". $app_msg->method, INFO );
94 my $method_name = $app_msg->method;
95 $log->debug( " * Looking up $method_name inside $app", DEBUG);
97 my $method_proto = $session->last_message_api_level;
98 $log->debug( " * Method API Level [$method_proto]", DEBUG);
100 my $coderef = $app->method_lookup( $method_name, $method_proto, 1, 1 );
103 $session->status( OpenSRF::DomainObject::oilsMethodException->new(
104 status => "Method [$method_name] not found for $app"));
108 $log->debug( " (we got coderef $coderef", DEBUG);
110 unless ($session->continue_request) {
112 OpenSRF::DomainObject::oilsConnectStatus->new(
113 statusCode => STATUS_REDIRECTED(),
114 status => 'Disconnect on max requests' ) );
120 my @args = $app_msg->params;
121 my $appreq = OpenSRF::AppRequest->new( $session );
123 $log->debug( "in_request = $in_request : [" . $appreq->threadTrace."]", DEBUG );
125 $log->debug( "Pushing onto pending requests: " . $appreq->threadTrace, DEBUG );
126 push @pending_requests, [ $appreq, \@args, $coderef ];
133 $log->debug( "Executing coderef for {$method_name -> ".join(', ', @args)."}", INTERNAL );
138 $resp = $coderef->run( $appreq, @args);
139 my $time = sprintf '%.3f', time() - $start;
140 $log->debug( "Method duration for {$method_name -> ".join(', ', @args)."}: ". $time, DEBUG );
141 if( defined( $resp ) ) {
142 #$log->debug( "Calling respond_complete: ". $resp->toString(), INTERNAL );
143 $appreq->respond_complete( $resp );
145 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
146 statusCode => STATUS_COMPLETE(),
147 status => 'Request Complete' ) );
151 if(UNIVERSAL::isa($e,"Error")) {
152 $e = $e->stringify();
154 my $sess_id = $session->session_id;
156 OpenSRF::DomainObject::oilsMethodException->new(
157 statusCode => STATUS_INTERNALSERVERERROR(),
158 status => " *** Call to [$method_name] failed for session ".
159 "[$sess_id], thread trace ".
160 "[".$appreq->threadTrace."]:\n$e\n"
167 # ----------------------------------------------
170 # XXX may need this later
171 # $_->[1] = 1 for (@OpenSRF::AppSession::_CLIENT_CACHE);
175 $log->debug( "Pending Requests: " . scalar(@pending_requests), INTERNAL );
177 # cycle through queued requests
178 while( my $aref = shift @pending_requests ) {
183 my $response = $aref->[2]->run( $aref->[0], @{$aref->[1]} );
184 my $time = sprintf '%.3f', time - $start;
185 $log->debug( "Method duration for {[".$aref->[2]->api_name." -> ".join(', ',@{$aref->[1]}).'}: '.$time, DEBUG );
187 $appreq = $aref->[0];
188 if( ref( $response ) ) {
189 #$log->debug( "Calling respond_complete: ". $response->toString(), INTERNAL );
190 $appreq->respond_complete( $response );
192 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
193 statusCode => STATUS_COMPLETE(),
194 status => 'Request Complete' ) );
196 $log->debug( "Executed: " . $appreq->threadTrace, DEBUG );
199 if(UNIVERSAL::isa($e,"Error")) {
200 $e = $e->stringify();
203 OpenSRF::DomainObject::oilsMethodException->new(
204 statusCode => STATUS_INTERNALSERVERERROR(),
205 status => "Call to [".$aref->[2]->api_name."] faild: $e"
215 my $res = OpenSRF::DomainObject::oilsMethodException->new(
216 status => "Received non-REQUEST message in Application handler");
217 $session->send('ERROR', $res);
222 $log->debug( "Pushing ". $app_msg->toString ." onto queue", INTERNAL );
223 $session->push_queue([ $app_msg, $session->last_threadTrace ]);
226 $session->last_message_type('');
227 $session->last_message_api_level('');
234 my $api_name = shift;
235 my $api_level = shift || 1;
236 return exists($_METHODS[$api_level]{$api_name});
239 sub register_method {
241 my $app = ref($self) || $self;
245 throw OpenSRF::DomainObject::oilsMethodException unless ($args{method});
247 $args{api_level} = 1 unless(defined($args{api_level}));
250 $args{package} ||= $app;
251 $args{server_class} = server_class();
252 $args{api_name} ||= $args{server_class} . '.' . $args{method};
254 unless ($args{object_hint}) {
255 ($args{object_hint} = $args{package}) =~ s/::/_/go;
258 JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
260 $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
262 __PACKAGE__->register_method(
264 api_name => $args{api_name}.'.atomic',
265 method => 'make_stream_atomic'
266 ) if ($args{stream});
269 sub retrieve_remote_apis {
271 my $session = OpenSRF::AppSession->create('router');
273 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
276 $log->debug( "Remote subrequest returned an error:\n". $e );
279 return undef unless ($session->state == $session->CONNECTED);
282 my $req = $session->request( 'opensrf.router.info.class.list' );
283 my $list = $req->recv;
285 if( UNIVERSAL::isa($list,"Error") ) {
289 my $content = $list->content;
293 $session->disconnect;
295 my %u_list = map { ($_ => 1) } @$content;
297 for my $class ( keys %u_list ) {
298 next if($class eq $server_class);
299 populate_remote_method_cache($class, $method);
303 sub populate_remote_method_cache {
307 my $session = OpenSRF::AppSession->create($class);
309 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
311 my $call = 'opensrf.system.method.all' unless (defined $meth);
312 $call = 'opensrf.system.method' if (defined $meth);
314 my $req = $session->request( $call, $meth );
316 while (my $method = $req->recv) {
317 next if (UNIVERSAL::isa($method, 'Error'));
319 $method = $method->content;
320 next if ( exists($_METHODS[$$method{api_level}]) &&
321 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
322 $method->{remote} = 1;
323 bless($method, __PACKAGE__ );
324 $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
329 $session->disconnect;
333 $log->debug( "Remote subrequest returned an error:\n". $e );
341 my $proto = shift || 1;
342 my $no_recurse = shift || 0;
343 my $no_remote = shift || 0;
345 # this instead of " || 1;" above to allow api_level 0
346 $proto = $self->api_level unless (defined $proto);
348 my $class = ref($self) || $self;
350 $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
351 #$log->debug("Available methods\n".Dumper(\@_METHODS), INTERNAL);
354 if (__PACKAGE__->thunk) {
355 for my $p ( reverse(1 .. $proto) ) {
356 if (exists $_METHODS[$p]{$method}) {
357 $meth = $_METHODS[$p]{$method};
361 if (exists $_METHODS[$proto]{$method}) {
362 $meth = $_METHODS[$proto]{$method};
367 $log->debug("Looks like we found [$method]!", DEBUG);
368 $log->debug("Method object is ".Dumper($meth), INTERNAL);
369 if($no_remote and $meth->{remote}) {
370 $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
374 } elsif (!$no_recurse) {
375 retrieve_remote_apis($method);
376 $meth = $self->method_lookup($method,$proto,1);
389 if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
390 $log->debug("Creating a SubRequest object", DEBUG);
391 unshift @params, $req;
392 $req = OpenSRF::AppSubrequest->new;
394 $log->debug("This is a top level request", DEBUG);
397 if (!$self->{remote}) {
398 my $code ||= \&{$self->{package} . '::' . $self->{method}};
399 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
403 $resp = $code->($self, $req, @params);
408 warn "Caught Error in Application: $e\n";
410 if( UNIVERSAL::isa($e,"Error")) {
411 warn "Exception is:\n " . $e->stringify() . "\n";
414 if( ref($self) eq 'HASH') {
416 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
421 if(UNIVERSAL::isa($err,"Error")) {
422 throw $err ($err->stringify);
429 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
431 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
432 $log->debug("A SubRequest object is responding", DEBUG);
433 $req->respond($resp) if (defined $resp);
434 $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
435 return $req->responses;
437 $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
441 my $session = OpenSRF::AppSession->create($self->{server_class});
443 #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
444 my $remote_req = $session->request( $self->{api_name}, @params );
445 while (my $remote_resp = $remote_req->recv) {
446 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
447 if( UNIVERSAL::isa($remote_resp,"Error") ) {
450 $req->respond( $remote_resp->content );
452 $remote_req->finish();
456 $log->debug( "Remote subrequest returned an error:\n". $e );
461 $session->disconnect();
465 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
467 return $req->responses;
469 # huh? how'd we get here...
478 $method = undef if ($self->api_name =~ /all$/o);
480 for my $api_level ( reverse(1 .. $#_METHODS) ) {
481 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
482 if (!$_METHODS[$api_level]{$api_name}{remote}) {
483 if (defined($method)) {
484 if ($api_name =~ $method) {
485 $client->respond( $_METHODS[$api_level]{$api_name} );
488 $log->debug( "Returning definition for method [$api_name]", INTERNAL );
489 $client->respond( $_METHODS[$api_level]{$api_name} );
490 $log->debug( "responed with definition for method [$api_name]", INTERNAL );
498 __PACKAGE__->register_method(
500 method => 'introspect',
501 api_name => 'opensrf.system.method.all'
503 __PACKAGE__->register_method(
505 method => 'introspect',
507 api_name => 'opensrf.system.method'
515 $client->respond( $_ ) for (@args);
518 __PACKAGE__->register_method(
520 method => 'echo_method',
522 api_name => 'opensrf.system.echo'
525 sub make_stream_atomic {
530 (my $m_name = $self->api_name) =~ s/\.atomic$//o;
531 my @results = $self->method_lookup($m_name)->run(@args);