User activity tracking: ingress, auth.verify, and login agent
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / WWW / XMLRPCGateway.pm
1 package OpenILS::WWW::XMLRPCGateway;
2 use strict; use warnings;
3
4 use CGI;
5 use Apache2::Log;
6 use Apache2::Const -compile => qw(OK REDIRECT DECLINED NOT_FOUND :log);
7 use APR::Const    -compile => qw(:error SUCCESS);
8 use Apache2::RequestRec ();
9 use Apache2::RequestIO ();
10 use Apache2::RequestUtil;
11 use Data::Dumper;
12 use UNIVERSAL::require;
13
14 use XML::LibXML;
15 use OpenSRF::EX qw(:try);
16 use OpenSRF::System;
17 use OpenSRF::Utils::Cache;
18 use OpenSRF::Utils::Logger qw/$logger/;
19 use OpenSRF::Utils::SettingsClient;
20
21 use RPC::XML qw/smart_encode/;
22 use RPC::XML::Parser;
23 use RPC::XML::Function;
24 use RPC::XML::Method;
25 use RPC::XML::Procedure;
26
27 $RPC::XML::ENCODING = 'utf-8';
28
29 my $services;                                           # allowed services
30 my $CLASS_KEY = '__class__';    # object wrapper class key
31 my $PAYLOAD_KEY = '__data__';   # object wrapper payload key
32 my $bs_config;                                  # bootstrap config
33 my $__inited = 0;                               # has child_init run?
34
35
36 # set the bootstrap config when this module is loaded
37 sub import { $bs_config = $_[1]; }
38
39
40 # Bootstrap and load config settings
41 sub child_init {
42         $__inited = 1;
43         OpenSRF::AppSession->ingress('xmlrpc');
44         OpenSRF::System->bootstrap_client( config_file => $bs_config );
45         my $sclient     = OpenSRF::Utils::SettingsClient->new();
46         my $idl = $sclient->config_value("IDL");
47         $services = $sclient->config_value("xml-rpc", "allowed_services", "service");
48         $services = ref $services ? $services : [ $services ];
49         $logger->debug("XML-RPC: allowed services @$services");
50         OpenILS::Utils::Fieldmapper->require;
51         Fieldmapper->import(IDL => $idl);
52         OpenSRF::AppSession->ingress('apache');
53 }
54
55
56 sub handler {
57
58         my $r           = shift;
59         my $cgi = CGI->new;
60         my $service = $r->path_info;
61         $service =~ s#^/##;
62
63         child_init() unless $__inited; # ?
64
65         return Apache2::Const::NOT_FOUND unless grep { $_ eq $service } @$services;
66
67         my $request = RPC::XML::Parser->new->parse($cgi->param('POSTDATA'));
68
69         my @args;
70         push( @args, unwrap_perl($_->value) ) for @{$request->args};
71         my $method = $request->name;
72
73         warn "XML-RPC: service=$service, method=$method, args=@args\n";
74         $logger->debug("XML-RPC: service=$service, method=$method, args=@args");
75
76         my $perl = run_request( $service, $method, @args );
77         my $resp = RPC::XML::response->new(smart_encode($perl));
78
79         print "Content-type: application/xml; charset=utf-8\n\n";
80         print $resp->as_string;
81         return Apache2::Const::OK;
82 }
83
84
85 sub run_request {
86     my( $service, $method, @args ) = @_;
87
88     # since multiple Perl clients run within mod_perl, 
89     # we must set our ingress before each request.
90     OpenSRF::AppSession->ingress('xmlrpc');
91
92     my $ses = OpenSRF::AppSession->create( $service );
93
94     my $data = [];
95     my $req = $ses->request($method, @args);
96     while( my $resp = $req->recv( timeout => 600 ) ) {
97         if( $req->failed ) {
98             push( @$data, $req->failed );
99             last;
100         }
101         push( @$data, $resp->content );
102     }
103
104     # recover the default Apache/http ingress to avoid 
105     # polluting other mod_perl clients w/ our ingress value.
106     OpenSRF::AppSession->ingress('apache');
107
108     return [] if scalar(@$data) == 0;
109     return wrap_perl($$data[0]) 
110         if scalar(@$data) == 1 and $method !~ /.atomic$/og;
111     return wrap_perl($data);
112 }
113
114 # These should probably be moved out to a library somewhere
115
116 sub wrap_perl {
117    my $obj = shift;
118    my $ref = ref($obj);
119
120    if ($ref =~ /^Fieldmapper/o) {
121       $ref = $obj->json_hint;
122       $obj = $obj->to_bare_hash;
123    }
124
125    if( $ref eq 'HASH' ) {
126       $obj->{$_} = wrap_perl( $obj->{$_} ) for (keys %$obj);
127    } elsif( $ref eq 'ARRAY' ) {
128       $obj->[$_] = wrap_perl( $obj->[$_] ) for(0..scalar(@$obj) - 1 );
129    } elsif( $ref ) {
130       if(UNIVERSAL::isa($obj, 'HASH')) {
131          $obj->{$_} = wrap_perl( $obj->{$_} ) for (keys %$obj);
132          bless($obj, 'HASH'); # so our parser won't add the hints
133       } elsif(UNIVERSAL::isa($obj, 'ARRAY')) {
134          $obj->[$_] = wrap_perl( $obj->[$_] ) for(0..scalar(@$obj) - 1);
135          bless($obj, 'ARRAY'); # so our parser won't add the hints
136       }
137       $obj = { $CLASS_KEY => $ref, $PAYLOAD_KEY => $obj };
138    }
139    return $obj;
140 }
141
142
143
144 sub unwrap_perl {
145    my $obj = shift;
146    my $ref = ref($obj);
147    if( $ref eq 'HASH' ) {
148       if( defined($obj->{$CLASS_KEY})) {
149          my $class = $obj->{$CLASS_KEY};
150          if( $obj = unwrap_perl($obj->{$PAYLOAD_KEY}) ) {
151             return bless(\$obj, $class) unless ref($obj);
152             return bless( $obj, $class );
153          }
154          return undef;
155       }
156       $obj->{$_} = unwrap_perl( $obj->{$_} ) for (keys %$obj);
157    } elsif( $ref eq 'ARRAY' ) {
158       $obj->[$_] = unwrap_perl($obj->[$_]) for(0..scalar(@$obj) - 1);
159    }
160    return $obj;
161 }
162
163
164
165
166 1;