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 0 unless ref($self);
34 return $self->{signature};
39 return 0 unless ref($self);
45 return 1 unless ref($self);
46 return $self->{api_name};
51 return 1 unless ref($self);
52 return $self->{api_level};
58 $server_class = $class;
66 $thunk = $flag if (defined $flag);
70 sub application_implementation {
78 $log->error( "Error loading application_implementation: $app -> $@", ERROR);
87 my ($self, $session, $app_msg) = @_;
93 $log->debug( "In Application::handler()", DEBUG );
95 my $app = $self->application_implementation;
98 $log->debug( "Application is $app", DEBUG);
101 if ($session->last_message_type eq 'REQUEST') {
102 $log->debug( "We got a REQUEST: ". $app_msg->method);
104 my $method_name = $app_msg->method;
105 $log->debug( " * Looking up $method_name inside $app", DEBUG);
107 my $method_proto = $session->last_message_api_level;
108 $log->debug( " * Method API Level [$method_proto]", DEBUG);
110 my $coderef = $app->method_lookup( $method_name, $method_proto, 1, 1 );
113 $session->status( OpenSRF::DomainObject::oilsMethodException->new(
114 statusCode => STATUS_NOTFOUND(),
115 status => "Method [$method_name] not found for $app"));
119 $log->debug( " (we got coderef $coderef", DEBUG);
121 unless ($session->continue_request) {
123 OpenSRF::DomainObject::oilsConnectStatus->new(
124 statusCode => STATUS_REDIRECTED(),
125 status => 'Disconnect on max requests' ) );
131 my @args = $app_msg->params;
132 my $appreq = OpenSRF::AppRequest->new( $session );
134 $log->debug( "in_request = $in_request : [" . $appreq->threadTrace."]", DEBUG );
136 $log->debug( "Pushing onto pending requests: " . $appreq->threadTrace, DEBUG );
137 push @pending_requests, [ $appreq, \@args, $coderef ];
144 $log->debug( "Executing coderef for {$method_name}", INTERNAL );
148 # un-if(0) this block to enable param checking based on signature and argc
150 if (@args < $coderef->argc) {
151 die "Not enough params passed to ".
152 $coderef->api_name." : requires ". $coderef->argc
155 if (exists $coderef->signature->{params}) {
156 for my $p (0 .. scalar(@{ $coderef->signature->{params} }) - 1 ) {
157 my $s = $coderef->signature->{params}->[$p];
159 if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
160 die "Incorrect param class at position $p : should be a '$$s{class}'";
161 } elsif ($s->{type}) {
162 if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
163 die "Incorrect param type at position $p : should be an 'object'";
164 } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
165 die "Incorrect param type at position $p : should be an 'array'";
166 } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
167 die "Incorrect param type at position $p : should be a 'number'";
168 } elsif (lc($s->{type}) eq 'string' && ref($a)) {
169 die "Incorrect param type at position $p : should be a 'string'";
178 warn "About to run...\n";
179 $resp = $coderef->run( $appreq, @args);
180 warn "Done running...\n";
181 my $time = sprintf '%.3f', time() - $start;
183 $log->debug( "Method duration for {$method_name}: ". $time, INFO );
184 if( defined( $resp ) ) {
185 $appreq->respond_complete( $resp );
187 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
188 statusCode => STATUS_COMPLETE(),
189 status => 'Request Complete' ) );
193 warn "Caught error from 'run' method: $e\n";
195 if(UNIVERSAL::isa($e,"Error")) {
196 $e = $e->stringify();
198 my $sess_id = $session->session_id;
200 OpenSRF::DomainObject::oilsMethodException->new(
201 statusCode => STATUS_INTERNALSERVERERROR(),
202 status => " *** Call to [$method_name] failed for session ".
203 "[$sess_id], thread trace ".
204 "[".$appreq->threadTrace."]:\n$e\n"
211 # ----------------------------------------------
214 # XXX may need this later
215 # $_->[1] = 1 for (@OpenSRF::AppSession::_CLIENT_CACHE);
219 $log->debug( "Pending Requests: " . scalar(@pending_requests), INTERNAL );
221 # cycle through queued requests
222 while( my $aref = shift @pending_requests ) {
226 # un-if(0) this block to enable param checking based on signature and argc
228 if (@args < $aref->[2]->argc) {
229 die "Not enough params passed to ".
230 $aref->[2]->api_name." : requires ". $aref->[2]->argc
233 if (exists $aref->[2]->signature->{params}) {
234 for my $p (0 .. scalar(@{ $aref->[2]->signature->{params} }) - 1 ) {
235 my $s = $aref->[2]->signature->{params}->[$p];
237 if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
238 die "Incorrect param class at position $p : should be a '$$s{class}'";
239 } elsif ($s->{type}) {
240 if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
241 die "Incorrect param type at position $p : should be an 'object'";
242 } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
243 die "Incorrect param type at position $p : should be an 'array'";
244 } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
245 die "Incorrect param type at position $p : should be a 'number'";
246 } elsif (lc($s->{type}) eq 'string' && ref($a)) {
247 die "Incorrect param type at position $p : should be a 'string'";
256 my $response = $aref->[2]->run( $aref->[0], @{$aref->[1]} );
257 my $time = sprintf '%.3f', time - $start;
258 $log->debug( "Method duration for {[".$aref->[2]->api_name." -> ".join(', ',@{$aref->[1]}).'}: '.$time, DEBUG );
260 $appreq = $aref->[0];
261 if( ref( $response ) ) {
262 $appreq->respond_complete( $response );
264 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
265 statusCode => STATUS_COMPLETE(),
266 status => 'Request Complete' ) );
268 $log->debug( "Executed: " . $appreq->threadTrace, DEBUG );
271 if(UNIVERSAL::isa($e,"Error")) {
272 $e = $e->stringify();
275 OpenSRF::DomainObject::oilsMethodException->new(
276 statusCode => STATUS_INTERNALSERVERERROR(),
277 status => "Call to [".$aref->[2]->api_name."] faild: $e"
287 my $res = OpenSRF::DomainObject::oilsMethodException->new(
288 status => "Received non-REQUEST message in Application handler");
289 $session->send('ERROR', $res);
294 $session->push_queue([ $app_msg, $session->last_threadTrace ]);
297 $session->last_message_type('');
298 $session->last_message_api_level('');
305 my $api_name = shift;
306 my $api_level = shift || 1;
307 return exists($_METHODS[$api_level]{$api_name});
311 sub normalize_whitespace {
318 $txt =~ s/\. /\. /gso;
323 sub parse_notes_signature {
325 my @chunks = split(/\@/so, $string);
331 if (/^return (.+)$/so) {
332 $ret = [normalize_whitespace($1)];
333 } elsif (/^param (\w+) \b(.+)$/so) {
334 push @params, [ $1, normalize_whitespace($2) ];
336 $desc .= '@' if $desc;
341 return [normalize_whitespace($desc),\@params, $ret];
344 sub parse_array_signature {
346 my ($d,$p,$r) = @$array;
367 sub register_method {
369 my $app = ref($self) || $self;
373 throw OpenSRF::DomainObject::oilsMethodException unless ($args{method});
375 $args{api_level} = 1 unless(defined($args{api_level}));
379 $args{package} ||= $app;
380 $args{server_class} = server_class();
381 $args{api_name} ||= $args{server_class} . '.' . $args{method};
383 # un-if(0) this block to enable signature parsing
384 if (!$args{signature}) {
385 if ($args{notes} && !ref($args{notes})) {
387 parse_array_signature( parse_notes_signature( $args{notes} ) );
389 } elsif( ref($args{signature}) eq 'ARRAY') {
391 parse_array_signature( $args{signature} );
394 unless ($args{object_hint}) {
395 ($args{object_hint} = $args{package}) =~ s/::/_/go;
398 JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
400 $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
402 __PACKAGE__->register_method(
405 api_name => $args{api_name}.'.atomic',
406 method => 'make_stream_atomic',
407 notes => "This is a system generated method. Please see the definition for $args{api_name}",
408 ) if ($args{stream});
411 sub retrieve_remote_apis {
413 my $session = OpenSRF::AppSession->create('router');
415 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
418 $log->debug( "Remote subrequest returned an error:\n". $e );
421 return undef unless ($session->state == $session->CONNECTED);
424 my $req = $session->request( 'opensrf.router.info.class.list' );
425 my $list = $req->recv;
427 if( UNIVERSAL::isa($list,"Error") ) {
431 my $content = $list->content;
435 $session->disconnect;
437 my %u_list = map { ($_ => 1) } @$content;
439 for my $class ( keys %u_list ) {
440 next if($class eq $server_class);
441 populate_remote_method_cache($class, $method);
445 sub populate_remote_method_cache {
449 my $session = OpenSRF::AppSession->create($class);
451 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
453 my $call = 'opensrf.system.method.all' unless (defined $meth);
454 $call = 'opensrf.system.method' if (defined $meth);
456 my $req = $session->request( $call, $meth );
458 while (my $method = $req->recv) {
459 next if (UNIVERSAL::isa($method, 'Error'));
461 $method = $method->content;
462 next if ( exists($_METHODS[$$method{api_level}]) &&
463 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
464 $method->{remote} = 1;
465 bless($method, __PACKAGE__ );
466 $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
471 $session->disconnect;
475 $log->debug( "Remote subrequest returned an error:\n". $e );
484 my $no_recurse = shift || 0;
485 my $no_remote = shift || 0;
487 # this instead of " || 1;" above to allow api_level 0
488 $proto = $self->api_level unless (defined $proto);
490 my $class = ref($self) || $self;
492 $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
493 $log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);
496 if (__PACKAGE__->thunk) {
497 for my $p ( reverse(1 .. $proto) ) {
498 if (exists $_METHODS[$p]{$method}) {
499 $meth = $_METHODS[$p]{$method};
503 if (exists $_METHODS[$proto]{$method}) {
504 $meth = $_METHODS[$proto]{$method};
509 $log->debug("Looks like we found [$method]!", DEBUG);
510 $log->debug("Method object is ".Dumper($meth), INTERNAL);
511 if($no_remote and $meth->{remote}) {
512 $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
516 } elsif (!$no_recurse) {
517 $log->debug("We didn't find [$method], asking everyone else.", DEBUG);
518 retrieve_remote_apis($method);
519 $meth = $self->method_lookup($method,$proto,1);
532 if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
533 $log->debug("Creating a SubRequest object", DEBUG);
534 unshift @params, $req;
535 $req = OpenSRF::AppSubrequest->new;
537 $log->debug("This is a top level request", DEBUG);
540 if (!$self->{remote}) {
541 my $code ||= \&{$self->{package} . '::' . $self->{method}};
542 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
546 $resp = $code->($self, $req, @params);
551 warn "Method 'run' catching error: $e\n";
553 if( ref($self) eq 'HASH') {
554 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
559 if(UNIVERSAL::isa($err,"Error")) {
560 warn "Throwing from method run:\n$err\n------------------\n";
568 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
570 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
571 $log->debug("A SubRequest object is responding", DEBUG);
572 $req->respond($resp) if (defined $resp);
573 $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
574 return $req->responses;
576 $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
580 my $session = OpenSRF::AppSession->create($self->{server_class});
582 #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
583 my $remote_req = $session->request( $self->{api_name}, @params );
584 while (my $remote_resp = $remote_req->recv) {
585 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
586 if( UNIVERSAL::isa($remote_resp,"Error") ) {
589 $req->respond( $remote_resp->content );
591 $remote_req->finish();
595 $log->debug( "Remote subrequest returned an error:\n". $e );
600 $session->disconnect();
604 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
606 return $req->responses;
608 # huh? how'd we get here...
617 $method = undef if ($self->api_name =~ /all$/o);
619 for my $api_level ( reverse(1 .. $#_METHODS) ) {
620 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
621 if (!$_METHODS[$api_level]{$api_name}{remote}) {
622 if (defined($method)) {
623 if ($api_name =~ $method) {
624 $client->respond( $_METHODS[$api_level]{$api_name} );
627 $log->debug( "Returning definition for method [$api_name]", INTERNAL );
628 $client->respond( $_METHODS[$api_level]{$api_name} );
629 $log->debug( "responed with definition for method [$api_name]", INTERNAL );
637 __PACKAGE__->register_method(
639 method => 'introspect',
640 api_name => 'opensrf.system.method.all',
643 desc => q/This method is used to introspect an entire OpenSRF Application/,
645 desc => q/A stream of objects describing the methods available via this OpenSRF Application/,
650 __PACKAGE__->register_method(
652 method => 'introspect',
654 api_name => 'opensrf.system.method',
657 desc => q/Use this method to get the definition of a single OpenSRF Method/,
659 { desc => q/The method to introspect/,
662 return => { desc => q/An object describing the method requested, or an error if it can't be found/,
672 $client->respond( $_ ) for (@args);
675 __PACKAGE__->register_method(
677 method => 'echo_method',
679 api_name => 'opensrf.system.echo',
681 desc => q/A test method that will echo back it's arguments in a streaming response/,
683 { desc => q/One or more arguments to echo back/ }
685 return => { desc => q/A stream of the arguments passed/ }
689 sub make_stream_atomic {
694 (my $m_name = $self->api_name) =~ s/\.atomic$//o;
695 my @results = $self->method_lookup($m_name)->run(@args);