turn of signature checking for now
[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 < $coderef->argc) {
151                                                 die     "Not enough params passed to ".
152                                                         $coderef->api_name." : requires ". $coderef->argc
153                                         }
154                                         if (@args) {
155                                                 my $sig = $coderef->signature;
156                                                 if ($sig && exists $sig->{params}) {
157                                                         for my $p (0 .. scalar(@{ $sig->{params} }) - 1 ) {
158                                                                 my $s = $sig->{params}->[$p];
159                                                                 my $a = $args[$p];
160                                                                 if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
161                                                                         die "Incorrect param class at position $p : should be a '$$s{class}'";
162                                                                 } elsif ($s->{type}) {
163                                                                         if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
164                                                                                 die "Incorrect param type at position $p : should be an 'object'";
165                                                                         } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
166                                                                                 die "Incorrect param type at position $p : should be an 'array'";
167                                                                         } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
168                                                                                 die "Incorrect param type at position $p : should be a 'number'";
169                                                                         } elsif (lc($s->{type}) eq 'string' && ref($a)) {
170                                                                                 die "Incorrect param type at position $p : should be a 'string'";
171                                                                         }
172                                                                 }
173                                                         }
174                                                 }
175                                         }
176                                 }
177
178                                 my $start = time();
179                                 warn "About to run...\n";
180                                 $resp = $coderef->run( $appreq, @args); 
181                                 warn "Done running...\n";
182                                 my $time = sprintf '%.3f', time() - $start;
183
184                                 $log->debug( "Method duration for {$method_name}:  ". $time, INFO );
185                                 if( defined( $resp ) ) {
186                                         $appreq->respond_complete( $resp );
187                                 } else {
188                                         $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
189                                                                 statusCode => STATUS_COMPLETE(),
190                                                                 status => 'Request Complete' ) );
191                                 }
192                         } catch Error with {
193                                 my $e = shift;
194                                 warn "Caught error from 'run' method: $e\n";
195
196                                 if(UNIVERSAL::isa($e,"Error")) {
197                                         $e = $e->stringify();
198                                 } 
199                                 my $sess_id = $session->session_id;
200                                 $session->status(
201                                         OpenSRF::DomainObject::oilsMethodException->new(
202                                                         statusCode      => STATUS_INTERNALSERVERERROR(),
203                                                         status          => " *** Call to [$method_name] failed for session ".
204                                                                            "[$sess_id], thread trace ".
205                                                                            "[".$appreq->threadTrace."]:\n$e\n"
206                                         )
207                                 );
208                         };
209
210
211
212                         # ----------------------------------------------
213
214
215                         # XXX may need this later
216                         # $_->[1] = 1 for (@OpenSRF::AppSession::_CLIENT_CACHE);
217
218                         $in_request--;
219
220                         $log->debug( "Pending Requests: " . scalar(@pending_requests), INTERNAL );
221
222                         # cycle through queued requests
223                         while( my $aref = shift @pending_requests ) {
224                                 $in_request++;
225                                 my $resp;
226                                 try {
227                                         # un-if(0) this block to enable param checking based on signature and argc
228                                         if (0) {
229                                                 if (@args < $aref->[2]->argc) {
230                                                         die     "Not enough params passed to ".
231                                                                 $aref->[2]->api_name." : requires ". $aref->[2]->argc
232                                                 }
233                                                 if (@args) {
234                                                         my $sig = $aref->[2]->signature;
235                                                         if ($sig && exists $sig->{params}) {
236                                                                 for my $p (0 .. scalar(@{ $sig->{params} }) - 1 ) {
237                                                                         my $s = $sig->{params}->[$p];
238                                                                         my $a = $args[$p];
239                                                                         if ($s->{class} && JSON->lookup_hint(ref $a) ne $s->{class}) {
240                                                                                 die "Incorrect param class at position $p : should be a '$$s{class}'";
241                                                                         } elsif ($s->{type}) {
242                                                                                 if (lc($s->{type}) eq 'object' && $a !~ /HASH/o) {
243                                                                                         die "Incorrect param type at position $p : should be an 'object'";
244                                                                                 } elsif (lc($s->{type}) eq 'array' && $a !~ /ARRAY/o) {
245                                                                                         die "Incorrect param type at position $p : should be an 'array'";
246                                                                                 } elsif (lc($s->{type}) eq 'number' && (ref($a) || $a !~ /^-?\d+(?:\.\d+)?$/o)) {
247                                                                                         die "Incorrect param type at position $p : should be a 'number'";
248                                                                                 } elsif (lc($s->{type}) eq 'string' && ref($a)) {
249                                                                                         die "Incorrect param type at position $p : should be a 'string'";
250                                                                                 }
251                                                                         }
252                                                                 }
253                                                         }
254                                                 }
255                                         }
256
257                                         my $start = time;
258                                         my $response = $aref->[2]->run( $aref->[0], @{$aref->[1]} );
259                                         my $time = sprintf '%.3f', time - $start;
260                                         $log->debug( "Method duration for {[".$aref->[2]->api_name." -> ".join(', ',@{$aref->[1]}).'}:  '.$time, DEBUG );
261
262                                         $appreq = $aref->[0];   
263                                         if( ref( $response ) ) {
264                                                 $appreq->respond_complete( $response );
265                                         } else {
266                                                 $appreq->status( OpenSRF::DomainObject::oilsConnectStatus->new(
267                                                                         statusCode => STATUS_COMPLETE(),
268                                                                         status => 'Request Complete' ) );
269                                         }
270                                         $log->debug( "Executed: " . $appreq->threadTrace, DEBUG );
271                                 } catch Error with {
272                                         my $e = shift;
273                                         if(UNIVERSAL::isa($e,"Error")) {
274                                                 $e = $e->stringify();
275                                         }
276                                         $session->status(
277                                                 OpenSRF::DomainObject::oilsMethodException->new(
278                                                                 statusCode => STATUS_INTERNALSERVERERROR(),
279                                                                 status => "Call to [".$aref->[2]->api_name."] faild:  $e"
280                                                 )
281                                         );
282                                 };
283                                 $in_request--;
284                         }
285
286                         return 1;
287                 } 
288
289                 my $res = OpenSRF::DomainObject::oilsMethodException->new( 
290                                 status => "Received non-REQUEST message in Application handler");
291                 $session->send('ERROR', $res);
292                 $session->kill_me;
293                 return 1;
294
295         } else {
296                 $session->push_queue([ $app_msg, $session->last_threadTrace ]);
297         }
298
299         $session->last_message_type('');
300         $session->last_message_api_level('');
301
302         return 1;
303 }
304
305 sub is_registered {
306         my $self = shift;
307         my $api_name = shift;
308         my $api_level = shift || 1;
309         return exists($_METHODS[$api_level]{$api_name});
310 }
311
312
313 sub normalize_whitespace {
314         my $txt = shift;
315
316         $txt =~ s/^\s+//gso;
317         $txt =~ s/\s+$//gso;
318         $txt =~ s/\s+/ /gso;
319         $txt =~ s/\n//gso;
320         $txt =~ s/\. /\.  /gso;
321
322         return $txt;
323 }
324
325 sub parse_string_signature {
326         my $string = shift;
327         my @chunks = split(/\@/so, $string);
328
329         my @params;
330         my $ret;
331         my $desc = '';
332         for (@chunks) {
333                 if (/^return (.+)$/so) {
334                         $ret = [normalize_whitespace($1)];
335                 } elsif (/^param (\w+) \b(.+)$/so) {
336                         push @params, [ $1, normalize_whitespace($2) ];
337                 } else {
338                         $desc .= '@' if $desc;
339                         $desc .= $_;
340                 }
341         }
342
343         return [normalize_whitespace($desc),\@params, $ret];
344 }
345
346 sub parse_array_signature {
347         my $array = shift;
348         my ($d,$p,$r) = @$array;
349
350         return {
351                 desc    => $d,
352                 params  => [
353                         map { 
354                                 { name  => $$_[0],
355                                   desc  => $$_[1],
356                                   type  => $$_[2],
357                                   class => $$_[3],
358                                 }
359                         } @$p
360                 ],
361                 'return'=>
362                         { desc  => $$r[0],
363                           type  => $$r[1],
364                           class => $$r[2],
365                         }
366         };
367 }
368
369 sub register_method {
370         my $self = shift;
371         my $app = ref($self) || $self;
372         my %args = @_;
373
374
375         throw OpenSRF::DomainObject::oilsMethodException unless ($args{method});
376
377         $args{api_level} = 1 unless(defined($args{api_level}));
378         $args{stream} ||= 0;
379         $args{remote} ||= 0;
380         $args{argc} ||= 0;
381         $args{package} ||= $app;                
382         $args{server_class} = server_class();
383         $args{api_name} ||= $args{server_class} . '.' . $args{method};
384
385         # un-if(0) this block to enable signature parsing
386         if (!$args{signature}) {
387                 if ($args{notes} && !ref($args{notes})) {
388                         $args{signature} =
389                                 parse_array_signature( parse_string_signature( $args{notes} ) );
390                 }
391         } elsif( !ref($args{signature}) ) {
392                 $args{signature} =
393                         parse_array_signature( parse_string_signature( $args{notes} ) );
394         } elsif( ref($args{signature}) eq 'ARRAY') {
395                 $args{signature} =
396                         parse_array_signature( $args{signature} );
397         }
398         
399         unless ($args{object_hint}) {
400                 ($args{object_hint} = $args{package}) =~ s/::/_/go;
401         }
402
403         JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
404
405         $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
406
407         __PACKAGE__->register_method(
408                 stream => 0,
409                 argc => $args{argc},
410                 api_name => $args{api_name}.'.atomic',
411                 method => 'make_stream_atomic',
412                 notes => "This is a system generated method.  Please see the definition for $args{api_name}",
413         ) if ($args{stream});
414 }
415
416 sub retrieve_remote_apis {
417         my $method = shift;
418         my $session = OpenSRF::AppSession->create('router');
419         try {
420                 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
421         } catch Error with {
422                 my $e = shift;
423                 $log->debug( "Remote subrequest returned an error:\n". $e );
424                 return undef;
425         } finally {
426                 return undef unless ($session->state == $session->CONNECTED);
427         };
428
429         my $req = $session->request( 'opensrf.router.info.class.list' );
430         my $list = $req->recv;
431
432         if( UNIVERSAL::isa($list,"Error") ) {
433                 throw $list;
434         }
435
436         my $content = $list->content;
437
438         $req->finish;
439         $session->finish;
440         $session->disconnect;
441
442         my %u_list = map { ($_ => 1) } @$content;
443
444         for my $class ( keys %u_list ) {
445                 next if($class eq $server_class);
446                 populate_remote_method_cache($class, $method);
447         }
448 }
449
450 sub populate_remote_method_cache {
451         my $class = shift;
452         my $meth = shift;
453
454         my $session = OpenSRF::AppSession->create($class);
455         try {
456                 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
457
458                 my $call = 'opensrf.system.method.all' unless (defined $meth);
459                 $call = 'opensrf.system.method' if (defined $meth);
460
461                 my $req = $session->request( $call, $meth );
462
463                 while (my $method = $req->recv) {
464                         next if (UNIVERSAL::isa($method, 'Error'));
465
466                         $method = $method->content;
467                         next if ( exists($_METHODS[$$method{api_level}]) &&
468                                 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
469                         $method->{remote} = 1;
470                         bless($method, __PACKAGE__ );
471                         $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
472                 }
473
474                 $req->finish;
475                 $session->finish;
476                 $session->disconnect;
477
478         } catch Error with {
479                 my $e = shift;
480                 $log->debug( "Remote subrequest returned an error:\n". $e );
481                 return undef;
482         };
483 }
484
485 sub method_lookup {             
486         my $self = shift;
487         my $method = shift;
488         my $proto = shift;
489         my $no_recurse = shift || 0;
490         my $no_remote = shift || 0;
491
492         # this instead of " || 1;" above to allow api_level 0
493         $proto = $self->api_level unless (defined $proto);
494
495         my $class = ref($self) || $self;
496
497         $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
498         $log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);
499
500         my $meth;
501         if (__PACKAGE__->thunk) {
502                 for my $p ( reverse(1 .. $proto) ) {
503                         if (exists $_METHODS[$p]{$method}) {
504                                 $meth = $_METHODS[$p]{$method};
505                         }
506                 }
507         } else {
508                 if (exists $_METHODS[$proto]{$method}) {
509                         $meth = $_METHODS[$proto]{$method};
510                 }
511         }
512
513         if (defined $meth) {
514                 $log->debug("Looks like we found [$method]!", DEBUG);
515                 $log->debug("Method object is ".Dumper($meth), INTERNAL);
516                 if($no_remote and $meth->{remote}) {
517                         $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
518                         return undef;
519                 }
520
521         } elsif (!$no_recurse) {
522                 $log->debug("We didn't find [$method], asking everyone else.", DEBUG);
523                 retrieve_remote_apis($method);
524                 $meth = $self->method_lookup($method,$proto,1);
525         }
526
527         return $meth;
528 }
529
530 sub run {
531         my $self = shift;
532         my $req = shift;
533
534         my $resp;
535         my @params = @_;
536
537         if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
538                 $log->debug("Creating a SubRequest object", DEBUG);
539                 unshift @params, $req;
540                 $req = OpenSRF::AppSubrequest->new;
541         } else {
542                 $log->debug("This is a top level request", DEBUG);
543         }
544
545         if (!$self->{remote}) {
546                 my $code ||= \&{$self->{package} . '::' . $self->{method}};
547                 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
548                 my $err = undef;
549
550                 try {
551                         $resp = $code->($self, $req, @params);
552
553                 } catch Error with {
554                         my $e = shift;
555                         $err = $e;
556                         warn "Method 'run' catching error: $e\n";
557
558                         if( ref($self) eq 'HASH') {
559                                 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
560                         }
561                 };
562
563                 if($err) {
564                         if(UNIVERSAL::isa($err,"Error")) { 
565                                 warn "Throwing from method run:\n$err\n------------------\n";
566                                 throw $err;
567                         } else {
568                                 die $err->stringify; 
569                         }
570                 }
571
572
573                 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
574
575                 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
576                         $log->debug("A SubRequest object is responding", DEBUG);
577                         $req->respond($resp) if (defined $resp);
578                         $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
579                         return $req->responses;
580                 } else {
581                         $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
582                         return $resp;
583                 }
584         } else {
585                 my $session = OpenSRF::AppSession->create($self->{server_class});
586                 try {
587                         #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
588                         my $remote_req = $session->request( $self->{api_name}, @params );
589                         while (my $remote_resp = $remote_req->recv) {
590                                 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
591                                 if( UNIVERSAL::isa($remote_resp,"Error") ) {
592                                         throw $remote_resp;
593                                 }
594                                 $req->respond( $remote_resp->content );
595                         }
596                         $remote_req->finish();
597
598                 } catch Error with {
599                         my $e = shift;
600                         $log->debug( "Remote subrequest returned an error:\n". $e );
601                         return undef;
602                 };
603
604                 if ($session) {
605                         $session->disconnect();
606                         $session->finish();
607                 }
608
609                 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
610
611                 return $req->responses;
612         }
613         # huh? how'd we get here...
614         return undef;
615 }
616
617 sub introspect {
618         my $self = shift;
619         my $client = shift;
620         my $method = shift;
621
622         $method = undef if ($self->api_name =~ /all$/o);
623
624         for my $api_level ( reverse(1 .. $#_METHODS) ) {
625                 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
626                         if (!$_METHODS[$api_level]{$api_name}{remote}) {
627                                 if (defined($method)) {
628                                         if ($api_name =~ $method) {
629                                                 $client->respond( $_METHODS[$api_level]{$api_name} );
630                                         }
631                                 } else {
632                                         $log->debug( "Returning definition for method [$api_name]", INTERNAL );
633                                         $client->respond( $_METHODS[$api_level]{$api_name} );
634                                         $log->debug( "responed with definition for method [$api_name]", INTERNAL );
635                                 }
636                         }
637                 }
638         }
639
640         return undef;
641 }
642 __PACKAGE__->register_method(
643         stream => 1,
644         method => 'introspect',
645         api_name => 'opensrf.system.method.all',
646         argc => 0,
647         signature => {
648                 desc => q/This method is used to introspect an entire OpenSRF Application/,
649                 return => {
650                         desc => q/A stream of objects describing the methods available via this OpenSRF Application/,
651                         type => 'object'
652                 }
653         },
654 );
655 __PACKAGE__->register_method(
656         stream => 1,
657         method => 'introspect',
658         argc => 1,
659         api_name => 'opensrf.system.method',
660         argc => 1,
661         signature => {
662                 desc => q/Use this method to get the definition of a single OpenSRF Method/,
663                 params => [
664                         { desc => q/The method to introspect/,
665                           type => 'string' },
666                 ],
667                 return => { desc => q/An object describing the method requested, or an error if it can't be found/,
668                             type => 'object' }
669         },
670 );
671
672 sub echo_method {
673         my $self = shift;
674         my $client = shift;
675         my @args = @_;
676
677         $client->respond( $_ ) for (@args);
678         return undef;
679 }
680 __PACKAGE__->register_method(
681         stream => 1,
682         method => 'echo_method',
683         argc => 1,
684         api_name => 'opensrf.system.echo',
685         signature => {
686                 desc => q/A test method that will echo back it's arguments in a streaming response/,
687                 params => [
688                         { desc => q/One or more arguments to echo back/ }
689                 ],
690                 return => { desc => q/A stream of the arguments passed/ }
691         },
692 );
693
694 sub make_stream_atomic {
695         my $self = shift;
696         my $req = shift;
697         my @args = @_;
698
699         (my $m_name = $self->api_name) =~ s/\.atomic$//o;
700         my @results = $self->method_lookup($m_name)->run(@args);
701
702         return \@results;
703 }
704
705
706 1;
707
708