added (disabled) signature parsing and (disabled) param count, type, and class checking
[Evergreen.git] / OpenSRF / src / perlmods / OpenSRF / Application.pm
1 package OpenSRF::Application;
2 use vars qw/$_app $log @_METHODS $thunk $server_class/;
3
4 use base qw/OpenSRF/;
5 use OpenSRF::AppSession;
6 use OpenSRF::DomainObject::oilsMethod;
7 use OpenSRF::DomainObject::oilsResponse qw/:status/;
8 use OpenSRF::Utils::Logger qw/:level/;
9 use Data::Dumper;
10 use Time::HiRes qw/time/;
11 use OpenSRF::EX qw/:try/;
12 use Carp;
13 #use OpenSRF::UnixServer;  # to get the server class from UnixServer::App
14
15 sub DESTROY{};
16
17 use strict;
18 use warnings;
19
20 $log = 'OpenSRF::Utils::Logger';
21
22 our $in_request = 0;
23 our @pending_requests;
24
25 sub package {
26         my $self = shift;
27         return 1 unless ref($self);
28         return $self->{package};
29 }
30
31 sub signature {
32         my $self = shift;
33         return 0 unless ref($self);
34         return $self->{signature};
35 }
36
37 sub argc {
38         my $self = shift;
39         return 0 unless ref($self);
40         return $self->{argc};
41 }
42
43 sub api_name {
44         my $self = shift;
45         return 1 unless ref($self);
46         return $self->{api_name};
47 }
48
49 sub api_level {
50         my $self = shift;
51         return 1 unless ref($self);
52         return $self->{api_level};
53 }
54
55 sub server_class {
56         my $class = shift;
57         if($class) {
58                 $server_class = $class;
59         }
60         return $server_class;
61 }
62
63 sub thunk {
64         my $self = shift;
65         my $flag = shift;
66         $thunk = $flag if (defined $flag);
67         return $thunk;
68 }
69
70 sub application_implementation {
71         my $self = shift;
72         my $app = shift;
73
74         if (defined $app) {
75                 $_app = $app;
76                 eval "use $_app;";
77                 if( $@ ) {
78                         $log->error( "Error loading application_implementation: $app -> $@", ERROR);
79                 }
80
81         }
82
83         return $_app;
84 }
85
86 sub handler {
87         my ($self, $session, $app_msg) = @_;
88
89         if( ! $app_msg ) {
90                 return 1;  # error?
91         }
92
93         $log->debug( "In Application::handler()", DEBUG );
94
95         my $app = $self->application_implementation;
96
97         if( $app ) {
98                 $log->debug( "Application is $app", DEBUG);
99         }
100
101         if ($session->last_message_type eq 'REQUEST') {
102                 $log->debug( "We got a REQUEST: ". $app_msg->method);
103
104                 my $method_name = $app_msg->method;
105                 $log->debug( " * Looking up $method_name inside $app", DEBUG);
106
107                 my $method_proto = $session->last_message_api_level;
108                 $log->debug( " * Method API Level [$method_proto]", DEBUG);
109
110                 my $coderef = $app->method_lookup( $method_name, $method_proto, 1, 1 );
111
112                 unless ($coderef) {
113                         $session->status( OpenSRF::DomainObject::oilsMethodException->new( 
114                                                 statusCode => STATUS_NOTFOUND(),
115                                                 status => "Method [$method_name] not found for $app"));
116                         return 1;
117                 }
118
119                 $log->debug( " (we got coderef $coderef", DEBUG);
120
121                 unless ($session->continue_request) {
122                         $session->status(
123                                 OpenSRF::DomainObject::oilsConnectStatus->new(
124                                                 statusCode => STATUS_REDIRECTED(),
125                                                 status => 'Disconnect on max requests' ) );
126                         $session->kill_me;
127                         return 1;
128                 }
129
130                 if (ref $coderef) {
131                         my @args = $app_msg->params;
132                         my $appreq = OpenSRF::AppRequest->new( $session );
133
134                         $log->debug( "in_request = $in_request : [" . $appreq->threadTrace."]", DEBUG );
135                         if( $in_request ) {
136                                 $log->debug( "Pushing onto pending requests: " . $appreq->threadTrace, DEBUG );
137                                 push @pending_requests, [ $appreq, \@args, $coderef ]; 
138                                 return 1;
139                         }
140
141
142                         $in_request++;
143
144                         $log->debug( "Executing coderef for {$method_name}", INTERNAL );
145
146                         my $resp;
147                         try {
148                                 # un-if(0) this block to enable param checking based on signature and argc
149                                 if (0) {
150                                         if (@args <= $self->argc) {
151                                                 die     "Not enough params passed to ".
152                                                         $self->api_name." : requires ". $self->argc
153                                         }
154                                         if (@args) {
155                                                 if (exists $self->signature->{params}) {
156                                                         for my $p (0 .. scalar(@{ $self->signature->{params} }) - 1 ) {
157                                                                 my $s = $self->signature->{params}->[$p];
158                                                                 my $a = $args[$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'";
170                                                                         }
171                                                                 }
172                                                         }
173                                                 }
174                                         }
175                                 }
176
177                                 my $start = time();
178                                 warn "About to run...\n";
179                                 $resp = $coderef->run( $appreq, @args); 
180                                 warn "Done running...\n";
181                                 my $time = sprintf '%.3f', time() - $start;
182
183                                 $log->debug( "Method duration for {$method_name}:  ". $time, INFO );
184                                 if( defined( $resp ) ) {
185                                         $appreq->respond_complete( $resp );
186                                 } else {
187                                         $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
188                                                                 statusCode => STATUS_COMPLETE(),
189                                                                 status => 'Request Complete' ) );
190                                 }
191                         } catch Error with {
192                                 my $e = shift;
193                                 warn "Caught error from 'run' method: $e\n";
194
195                                 if(UNIVERSAL::isa($e,"Error")) {
196                                         $e = $e->stringify();
197                                 } 
198                                 my $sess_id = $session->session_id;
199                                 $session->status(
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"
205                                         )
206                                 );
207                         };
208
209
210
211                         # ----------------------------------------------
212
213
214                         # XXX may need this later
215                         # $_->[1] = 1 for (@OpenSRF::AppSession::_CLIENT_CACHE);
216
217                         $in_request--;
218
219                         $log->debug( "Pending Requests: " . scalar(@pending_requests), INTERNAL );
220
221                         # cycle through queued requests
222                         while( my $aref = shift @pending_requests ) {
223                                 $in_request++;
224                                 my $resp;
225                                 try {
226                                         my $start = time;
227                                         my $response = $aref->[2]->run( $aref->[0], @{$aref->[1]} );
228                                         my $time = sprintf '%.3f', time - $start;
229                                         $log->debug( "Method duration for {[".$aref->[2]->api_name." -> ".join(', ',@{$aref->[1]}).'}:  '.$time, DEBUG );
230
231                                         $appreq = $aref->[0];   
232                                         if( ref( $response ) ) {
233                                                 $appreq->respond_complete( $response );
234                                         } else {
235                                                 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
236                                                                         statusCode => STATUS_COMPLETE(),
237                                                                         status => 'Request Complete' ) );
238                                         }
239                                         $log->debug( "Executed: " . $appreq->threadTrace, DEBUG );
240                                 } catch Error with {
241                                         my $e = shift;
242                                         if(UNIVERSAL::isa($e,"Error")) {
243                                                 $e = $e->stringify();
244                                         }
245                                         $session->status(
246                                                 OpenSRF::DomainObject::oilsMethodException->new(
247                                                                 statusCode => STATUS_INTERNALSERVERERROR(),
248                                                                 status => "Call to [".$aref->[2]->api_name."] faild:  $e"
249                                                 )
250                                         );
251                                 };
252                                 $in_request--;
253                         }
254
255                         return 1;
256                 } 
257
258                 my $res = OpenSRF::DomainObject::oilsMethodException->new( 
259                                 status => "Received non-REQUEST message in Application handler");
260                 $session->send('ERROR', $res);
261                 $session->kill_me;
262                 return 1;
263
264         } else {
265                 $session->push_queue([ $app_msg, $session->last_threadTrace ]);
266         }
267
268         $session->last_message_type('');
269         $session->last_message_api_level('');
270
271         return 1;
272 }
273
274 sub is_registered {
275         my $self = shift;
276         my $api_name = shift;
277         my $api_level = shift || 1;
278         return exists($_METHODS[$api_level]{$api_name});
279 }
280
281 sub parse_notes_signature {
282         my $string = shift;
283         my @lines = split(/\n/so, $string);
284
285         my @params;
286         my $ret;
287         my $desc = '';
288         for (@lines) {
289                 if (/^\s*\@return (.+)$/) {
290                         $ret = [$1];
291                 } elsif (/^\s*\@param (\w+) \b(.+)$/) {
292                         push @params, [ $1, $2 ];
293                 } else {
294                         $desc .= $_;
295                 }
296         }
297
298         return [$desc,\@params, $ret];
299 }
300
301 sub parse_array_signature {
302         my $array = shift;
303         my ($d,$p,$r) = @$array;
304
305         return {
306                 desc    => $d,
307                 params  => [
308                         map { 
309                                 { name  => $$_[0],
310                                   desc  => $$_[1],
311                                   type  => $$_[2],
312                                   class => $$_[3],
313                                 }
314                         } @$p
315                 ],
316                 'return'=>
317                         { desc  => $$r[0],
318                           type  => $$r[1],
319                           class => $$r[2],
320                         }
321         };
322 }
323
324 sub register_method {
325         my $self = shift;
326         my $app = ref($self) || $self;
327         my %args = @_;
328
329
330         throw OpenSRF::DomainObject::oilsMethodException unless ($args{method});
331
332         $args{api_level} = 1 unless(defined($args{api_level}));
333         $args{stream} ||= 0;
334         $args{remote} ||= 0;
335         $args{argc} ||= 0;
336         $args{package} ||= $app;                
337         $args{server_class} = server_class();
338         $args{api_name} ||= $args{server_class} . '.' . $args{method};
339
340         # un-if(0) this block to enable signature parsing
341         if (0) {
342                 if (!$args{signature}) {
343                         if ($args{notes} && !ref($args{notes})) {
344                                 $args{signature} =
345                                         parse_array_signature( parse_notes_signature( $args{notes} ) );
346                         }
347                 } elsif( ref($args{signature}) eq 'ARRAY') {
348                         $args{signature} =
349                                 parse_array_signature( $args{signature} );
350                 }
351         }
352         
353         unless ($args{object_hint}) {
354                 ($args{object_hint} = $args{package}) =~ s/::/_/go;
355         }
356
357         JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
358
359         $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
360
361         __PACKAGE__->register_method(
362                 stream => 0,
363                 api_name => $args{api_name}.'.atomic',
364                 method => 'make_stream_atomic'
365         ) if ($args{stream});
366 }
367
368 sub retrieve_remote_apis {
369         my $method = shift;
370         my $session = OpenSRF::AppSession->create('router');
371         try {
372                 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
373         } catch Error with {
374                 my $e = shift;
375                 $log->debug( "Remote subrequest returned an error:\n". $e );
376                 return undef;
377         } finally {
378                 return undef unless ($session->state == $session->CONNECTED);
379         };
380
381         my $req = $session->request( 'opensrf.router.info.class.list' );
382         my $list = $req->recv;
383
384         if( UNIVERSAL::isa($list,"Error") ) {
385                 throw $list;
386         }
387
388         my $content = $list->content;
389
390         $req->finish;
391         $session->finish;
392         $session->disconnect;
393
394         my %u_list = map { ($_ => 1) } @$content;
395
396         for my $class ( keys %u_list ) {
397                 next if($class eq $server_class);
398                 populate_remote_method_cache($class, $method);
399         }
400 }
401
402 sub populate_remote_method_cache {
403         my $class = shift;
404         my $meth = shift;
405
406         my $session = OpenSRF::AppSession->create($class);
407         try {
408                 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
409
410                 my $call = 'opensrf.system.method.all' unless (defined $meth);
411                 $call = 'opensrf.system.method' if (defined $meth);
412
413                 my $req = $session->request( $call, $meth );
414
415                 while (my $method = $req->recv) {
416                         next if (UNIVERSAL::isa($method, 'Error'));
417
418                         $method = $method->content;
419                         next if ( exists($_METHODS[$$method{api_level}]) &&
420                                 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
421                         $method->{remote} = 1;
422                         bless($method, __PACKAGE__ );
423                         $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
424                 }
425
426                 $req->finish;
427                 $session->finish;
428                 $session->disconnect;
429
430         } catch Error with {
431                 my $e = shift;
432                 $log->debug( "Remote subrequest returned an error:\n". $e );
433                 return undef;
434         };
435 }
436
437 sub method_lookup {             
438         my $self = shift;
439         my $method = shift;
440         my $proto = shift;
441         my $no_recurse = shift || 0;
442         my $no_remote = shift || 0;
443
444         # this instead of " || 1;" above to allow api_level 0
445         $proto = $self->api_level unless (defined $proto);
446
447         my $class = ref($self) || $self;
448
449         $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
450         $log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);
451
452         my $meth;
453         if (__PACKAGE__->thunk) {
454                 for my $p ( reverse(1 .. $proto) ) {
455                         if (exists $_METHODS[$p]{$method}) {
456                                 $meth = $_METHODS[$p]{$method};
457                         }
458                 }
459         } else {
460                 if (exists $_METHODS[$proto]{$method}) {
461                         $meth = $_METHODS[$proto]{$method};
462                 }
463         }
464
465         if (defined $meth) {
466                 $log->debug("Looks like we found [$method]!", DEBUG);
467                 $log->debug("Method object is ".Dumper($meth), INTERNAL);
468                 if($no_remote and $meth->{remote}) {
469                         $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
470                         return undef;
471                 }
472
473         } elsif (!$no_recurse) {
474                 $log->debug("We didn't find [$method], asking everyone else.", DEBUG);
475                 retrieve_remote_apis($method);
476                 $meth = $self->method_lookup($method,$proto,1);
477         }
478
479         return $meth;
480 }
481
482 sub run {
483         my $self = shift;
484         my $req = shift;
485
486         my $resp;
487         my @params = @_;
488
489         if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
490                 $log->debug("Creating a SubRequest object", DEBUG);
491                 unshift @params, $req;
492                 $req = OpenSRF::AppSubrequest->new;
493         } else {
494                 $log->debug("This is a top level request", DEBUG);
495         }
496
497         if (!$self->{remote}) {
498                 my $code ||= \&{$self->{package} . '::' . $self->{method}};
499                 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
500                 my $err = undef;
501
502                 try {
503                         $resp = $code->($self, $req, @params);
504
505                 } catch Error with {
506                         my $e = shift;
507                         $err = $e;
508                         warn "Method 'run' catching error: $e\n";
509
510                         if( ref($self) eq 'HASH') {
511                                 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
512                         }
513                 };
514
515                 if($err) {
516                         if(UNIVERSAL::isa($err,"Error")) { 
517                                 warn "Throwing from method run:\n$err\n------------------\n";
518                                 throw $err;
519                         } else {
520                                 die $err->stringify; 
521                         }
522                 }
523
524
525                 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
526
527                 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
528                         $log->debug("A SubRequest object is responding", DEBUG);
529                         $req->respond($resp) if (defined $resp);
530                         $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
531                         return $req->responses;
532                 } else {
533                         $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
534                         return $resp;
535                 }
536         } else {
537                 my $session = OpenSRF::AppSession->create($self->{server_class});
538                 try {
539                         #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
540                         my $remote_req = $session->request( $self->{api_name}, @params );
541                         while (my $remote_resp = $remote_req->recv) {
542                                 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
543                                 if( UNIVERSAL::isa($remote_resp,"Error") ) {
544                                         throw $remote_resp;
545                                 }
546                                 $req->respond( $remote_resp->content );
547                         }
548                         $remote_req->finish();
549
550                 } catch Error with {
551                         my $e = shift;
552                         $log->debug( "Remote subrequest returned an error:\n". $e );
553                         return undef;
554                 };
555
556                 if ($session) {
557                         $session->disconnect();
558                         $session->finish();
559                 }
560
561                 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
562
563                 return $req->responses;
564         }
565         # huh? how'd we get here...
566         return undef;
567 }
568
569 sub introspect {
570         my $self = shift;
571         my $client = shift;
572         my $method = shift;
573
574         $method = undef if ($self->api_name =~ /all$/o);
575
576         for my $api_level ( reverse(1 .. $#_METHODS) ) {
577                 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
578                         if (!$_METHODS[$api_level]{$api_name}{remote}) {
579                                 if (defined($method)) {
580                                         if ($api_name =~ $method) {
581                                                 $client->respond( $_METHODS[$api_level]{$api_name} );
582                                         }
583                                 } else {
584                                         $log->debug( "Returning definition for method [$api_name]", INTERNAL );
585                                         $client->respond( $_METHODS[$api_level]{$api_name} );
586                                         $log->debug( "responed with definition for method [$api_name]", INTERNAL );
587                                 }
588                         }
589                 }
590         }
591
592         return undef;
593 }
594 __PACKAGE__->register_method(
595         stream => 1,
596         method => 'introspect',
597         api_name => 'opensrf.system.method.all'
598 );
599 __PACKAGE__->register_method(
600         stream => 1,
601         method => 'introspect',
602         argc => 1,
603         api_name => 'opensrf.system.method'
604 );
605
606 sub echo_method {
607         my $self = shift;
608         my $client = shift;
609         my @args = @_;
610
611         $client->respond( $_ ) for (@args);
612         return undef;
613 }
614 __PACKAGE__->register_method(
615         stream => 1,
616         method => 'echo_method',
617         argc => 1,
618         api_name => 'opensrf.system.echo'
619 );
620
621 sub make_stream_atomic {
622         my $self = shift;
623         my $req = shift;
624         my @args = @_;
625
626         (my $m_name = $self->api_name) =~ s/\.atomic$//o;
627         my @results = $self->method_lookup($m_name)->run(@args);
628
629         return \@results;
630 }
631
632
633 1;
634
635