c323182aae959e3f4b81c40f3f32658fb8bbd0b2
[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 (1) {
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 (1) {
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_notes_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_notes_signature( $args{notes} ) );
390                 }
391         } elsif( ref($args{signature}) eq 'ARRAY') {
392                 $args{signature} =
393                         parse_array_signature( $args{signature} );
394         }
395         
396         unless ($args{object_hint}) {
397                 ($args{object_hint} = $args{package}) =~ s/::/_/go;
398         }
399
400         JSON->register_class_hint( name => $args{package}, hint => $args{object_hint}, type => "hash" );
401
402         $_METHODS[$args{api_level}]{$args{api_name}} = bless \%args => $app;
403
404         __PACKAGE__->register_method(
405                 stream => 0,
406                 argc => $args{argc},
407                 api_name => $args{api_name}.'.atomic',
408                 method => 'make_stream_atomic',
409                 notes => "This is a system generated method.  Please see the definition for $args{api_name}",
410         ) if ($args{stream});
411 }
412
413 sub retrieve_remote_apis {
414         my $method = shift;
415         my $session = OpenSRF::AppSession->create('router');
416         try {
417                 $session->connect or OpenSRF::EX::WARN->throw("Connection to router timed out");
418         } catch Error with {
419                 my $e = shift;
420                 $log->debug( "Remote subrequest returned an error:\n". $e );
421                 return undef;
422         } finally {
423                 return undef unless ($session->state == $session->CONNECTED);
424         };
425
426         my $req = $session->request( 'opensrf.router.info.class.list' );
427         my $list = $req->recv;
428
429         if( UNIVERSAL::isa($list,"Error") ) {
430                 throw $list;
431         }
432
433         my $content = $list->content;
434
435         $req->finish;
436         $session->finish;
437         $session->disconnect;
438
439         my %u_list = map { ($_ => 1) } @$content;
440
441         for my $class ( keys %u_list ) {
442                 next if($class eq $server_class);
443                 populate_remote_method_cache($class, $method);
444         }
445 }
446
447 sub populate_remote_method_cache {
448         my $class = shift;
449         my $meth = shift;
450
451         my $session = OpenSRF::AppSession->create($class);
452         try {
453                 $session->connect or OpenSRF::EX::WARN->throw("Connection to $class timed out");
454
455                 my $call = 'opensrf.system.method.all' unless (defined $meth);
456                 $call = 'opensrf.system.method' if (defined $meth);
457
458                 my $req = $session->request( $call, $meth );
459
460                 while (my $method = $req->recv) {
461                         next if (UNIVERSAL::isa($method, 'Error'));
462
463                         $method = $method->content;
464                         next if ( exists($_METHODS[$$method{api_level}]) &&
465                                 exists($_METHODS[$$method{api_level}]{$$method{api_name}}) );
466                         $method->{remote} = 1;
467                         bless($method, __PACKAGE__ );
468                         $_METHODS[$$method{api_level}]{$$method{api_name}} = $method;
469                 }
470
471                 $req->finish;
472                 $session->finish;
473                 $session->disconnect;
474
475         } catch Error with {
476                 my $e = shift;
477                 $log->debug( "Remote subrequest returned an error:\n". $e );
478                 return undef;
479         };
480 }
481
482 sub method_lookup {             
483         my $self = shift;
484         my $method = shift;
485         my $proto = shift;
486         my $no_recurse = shift || 0;
487         my $no_remote = shift || 0;
488
489         # this instead of " || 1;" above to allow api_level 0
490         $proto = $self->api_level unless (defined $proto);
491
492         my $class = ref($self) || $self;
493
494         $log->debug("Lookup of [$method] by [$class] in api_level [$proto]", DEBUG);
495         $log->debug("Available methods\n\t".join("\n\t", keys %{ $_METHODS[$proto] }), INTERNAL);
496
497         my $meth;
498         if (__PACKAGE__->thunk) {
499                 for my $p ( reverse(1 .. $proto) ) {
500                         if (exists $_METHODS[$p]{$method}) {
501                                 $meth = $_METHODS[$p]{$method};
502                         }
503                 }
504         } else {
505                 if (exists $_METHODS[$proto]{$method}) {
506                         $meth = $_METHODS[$proto]{$method};
507                 }
508         }
509
510         if (defined $meth) {
511                 $log->debug("Looks like we found [$method]!", DEBUG);
512                 $log->debug("Method object is ".Dumper($meth), INTERNAL);
513                 if($no_remote and $meth->{remote}) {
514                         $log->debug("OH CRAP We're not supposed to return remote methods", WARN);
515                         return undef;
516                 }
517
518         } elsif (!$no_recurse) {
519                 $log->debug("We didn't find [$method], asking everyone else.", DEBUG);
520                 retrieve_remote_apis($method);
521                 $meth = $self->method_lookup($method,$proto,1);
522         }
523
524         return $meth;
525 }
526
527 sub run {
528         my $self = shift;
529         my $req = shift;
530
531         my $resp;
532         my @params = @_;
533
534         if ( !UNIVERSAL::isa($req, 'OpenSRF::AppRequest') ) {
535                 $log->debug("Creating a SubRequest object", DEBUG);
536                 unshift @params, $req;
537                 $req = OpenSRF::AppSubrequest->new;
538         } else {
539                 $log->debug("This is a top level request", DEBUG);
540         }
541
542         if (!$self->{remote}) {
543                 my $code ||= \&{$self->{package} . '::' . $self->{method}};
544                 $log->debug("Created coderef [$code] for $$self{package}::$$self{method}",DEBUG);
545                 my $err = undef;
546
547                 try {
548                         $resp = $code->($self, $req, @params);
549
550                 } catch Error with {
551                         my $e = shift;
552                         $err = $e;
553                         warn "Method 'run' catching error: $e\n";
554
555                         if( ref($self) eq 'HASH') {
556                                 $log->error("Sub $$self{package}::$$self{method} DIED!!!\n\t$e\n", ERROR);
557                         }
558                 };
559
560                 if($err) {
561                         if(UNIVERSAL::isa($err,"Error")) { 
562                                 warn "Throwing from method run:\n$err\n------------------\n";
563                                 throw $err;
564                         } else {
565                                 die $err->stringify; 
566                         }
567                 }
568
569
570                 $log->debug("Coderef for [$$self{package}::$$self{method}] has been run", DEBUG);
571
572                 if ( ref($req) and UNIVERSAL::isa($req, 'OpenSRF::AppSubrequest') ) {
573                         $log->debug("A SubRequest object is responding", DEBUG);
574                         $req->respond($resp) if (defined $resp);
575                         $log->debug("... Responding with : " . join(" ",$req->responses), DEBUG);
576                         return $req->responses;
577                 } else {
578                         $log->debug("A top level Request object is responding $resp", DEBUG) if (defined $resp);
579                         return $resp;
580                 }
581         } else {
582                 my $session = OpenSRF::AppSession->create($self->{server_class});
583                 try {
584                         #$session->connect or OpenSRF::EX::WARN->throw("Connection to [$$self{server_class}] timed out");
585                         my $remote_req = $session->request( $self->{api_name}, @params );
586                         while (my $remote_resp = $remote_req->recv) {
587                                 OpenSRF::Utils::Logger->debug("Remote Subrequest Received " . $remote_resp, INTERNAL );
588                                 if( UNIVERSAL::isa($remote_resp,"Error") ) {
589                                         throw $remote_resp;
590                                 }
591                                 $req->respond( $remote_resp->content );
592                         }
593                         $remote_req->finish();
594
595                 } catch Error with {
596                         my $e = shift;
597                         $log->debug( "Remote subrequest returned an error:\n". $e );
598                         return undef;
599                 };
600
601                 if ($session) {
602                         $session->disconnect();
603                         $session->finish();
604                 }
605
606                 $log->debug( "Remote Subrequest Responses " . join(" ", $req->responses), INTERNAL );
607
608                 return $req->responses;
609         }
610         # huh? how'd we get here...
611         return undef;
612 }
613
614 sub introspect {
615         my $self = shift;
616         my $client = shift;
617         my $method = shift;
618
619         $method = undef if ($self->api_name =~ /all$/o);
620
621         for my $api_level ( reverse(1 .. $#_METHODS) ) {
622                 for my $api_name ( sort keys %{$_METHODS[$api_level]} ) {
623                         if (!$_METHODS[$api_level]{$api_name}{remote}) {
624                                 if (defined($method)) {
625                                         if ($api_name =~ $method) {
626                                                 $client->respond( $_METHODS[$api_level]{$api_name} );
627                                         }
628                                 } else {
629                                         $log->debug( "Returning definition for method [$api_name]", INTERNAL );
630                                         $client->respond( $_METHODS[$api_level]{$api_name} );
631                                         $log->debug( "responed with definition for method [$api_name]", INTERNAL );
632                                 }
633                         }
634                 }
635         }
636
637         return undef;
638 }
639 __PACKAGE__->register_method(
640         stream => 1,
641         method => 'introspect',
642         api_name => 'opensrf.system.method.all',
643         argc => 0,
644         signature => {
645                 desc => q/This method is used to introspect an entire OpenSRF Application/,
646                 return => {
647                         desc => q/A stream of objects describing the methods available via this OpenSRF Application/,
648                         type => 'object'
649                 }
650         },
651 );
652 __PACKAGE__->register_method(
653         stream => 1,
654         method => 'introspect',
655         argc => 1,
656         api_name => 'opensrf.system.method',
657         argc => 1,
658         signature => {
659                 desc => q/Use this method to get the definition of a single OpenSRF Method/,
660                 params => [
661                         { desc => q/The method to introspect/,
662                           type => 'string' },
663                 ],
664                 return => { desc => q/An object describing the method requested, or an error if it can't be found/,
665                             type => 'object' }
666         },
667 );
668
669 sub echo_method {
670         my $self = shift;
671         my $client = shift;
672         my @args = @_;
673
674         $client->respond( $_ ) for (@args);
675         return undef;
676 }
677 __PACKAGE__->register_method(
678         stream => 1,
679         method => 'echo_method',
680         argc => 1,
681         api_name => 'opensrf.system.echo',
682         signature => {
683                 desc => q/A test method that will echo back it's arguments in a streaming response/,
684                 params => [
685                         { desc => q/One or more arguments to echo back/ }
686                 ],
687                 return => { desc => q/A stream of the arguments passed/ }
688         },
689 );
690
691 sub make_stream_atomic {
692         my $self = shift;
693         my $req = shift;
694         my @args = @_;
695
696         (my $m_name = $self->api_name) =~ s/\.atomic$//o;
697         my @results = $self->method_lookup($m_name)->run(@args);
698
699         return \@results;
700 }
701
702
703 1;
704
705