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         return Apache2::Const::OK;
  54 }
  55
  56
  57 sub handler {
  58
  59         my $r           = shift;
  60         my $cgi = CGI->new;
  61         my $service = $r->path_info;
  62         $service =~ s#^/##;
  63
  64         child_init() unless $__inited; # ?
  65
  66         return Apache2::Const::NOT_FOUND unless grep { $_ eq $service } @$services;
  67
  68         my $request = RPC::XML::Parser->new->parse($cgi->param('POSTDATA'));
  69
  70         my @args;
  71         push( @args, unwrap_perl($_->value) ) for @{$request->args};
  72         my $method = $request->name;
  73
  74         warn "XML-RPC: service=$service, method=$method, args=@args\n";
  75         $logger->debug("XML-RPC: service=$service, method=$method, args=@args");
  76
  77         my $perl = run_request( $service, $method, @args );
  78         my $resp = RPC::XML::response->new(smart_encode($perl));
  79
  80         print "Content-type: application/xml; charset=utf-8\n\n";
  81         print $resp->as_string;
  82         return Apache2::Const::OK;
  83 }
  84
  85
  86 sub run_request {
  87     my( $service, $method, @args ) = @_;
  88
  89     # since multiple Perl clients run within mod_perl,
  90     # we must set our ingress before each request.
  91     OpenSRF::AppSession->ingress('xmlrpc');
  92
  93     my $ses = OpenSRF::AppSession->create( $service );
  94
  95     my $data = [];
  96     my $req = $ses->request($method, @args);
  97     while( my $resp = $req->recv( timeout => 600 ) ) {
  98         if( $req->failed ) {
  99             push( @$data, $req->failed );
 100             last;
 101         }
 102         push( @$data, $resp->content );
 103     }
 104
 105     # recover the default Apache/http ingress to avoid
 106     # polluting other mod_perl clients w/ our ingress value.
 107     OpenSRF::AppSession->ingress('apache');
 108
 109     return [] if scalar(@$data) == 0;
 110     return wrap_perl($$data[0])
 111         if scalar(@$data) == 1 and $method !~ /.atomic$/og;
 112     return wrap_perl($data);
 113 }
 114
 115 # These should probably be moved out to a library somewhere
 116
 117 sub wrap_perl {
 118    my $obj = shift;
 119    my $ref = ref($obj);
 120
 121    if ($ref =~ /^Fieldmapper/o) {
 122       $ref = $obj->json_hint;
 123       $obj = $obj->to_bare_hash;
 124    }
 125
 126    if( $ref eq 'HASH' ) {
 127       $obj->{$_} = wrap_perl( $obj->{$_} ) for (keys %$obj);
 128    } elsif( $ref eq 'ARRAY' ) {
 129       $obj->[$_] = wrap_perl( $obj->[$_] ) for(0..scalar(@$obj) - 1 );
 130    } elsif( $ref ) {
 131       if(UNIVERSAL::isa($obj, 'HASH')) {
 132          $obj->{$_} = wrap_perl( $obj->{$_} ) for (keys %$obj);
 133          bless($obj, 'HASH'); # so our parser won't add the hints
 134       } elsif(UNIVERSAL::isa($obj, 'ARRAY')) {
 135          $obj->[$_] = wrap_perl( $obj->[$_] ) for(0..scalar(@$obj) - 1);
 136          bless($obj, 'ARRAY'); # so our parser won't add the hints
 137       }
 138       $obj = { $CLASS_KEY => $ref, $PAYLOAD_KEY => $obj };
 139    }
 140    return $obj;
 141 }
 142
 143
 144
 145 sub unwrap_perl {
 146    my $obj = shift;
 147    my $ref = ref($obj);
 148    if( $ref eq 'HASH' ) {
 149       if( defined($obj->{$CLASS_KEY})) {
 150          my $class = $obj->{$CLASS_KEY};
 151          if( $obj = unwrap_perl($obj->{$PAYLOAD_KEY}) ) {
 152             return bless(\$obj, $class) unless ref($obj);
 153             return bless( $obj, $class );
 154          }
 155          return undef;
 156       }
 157       $obj->{$_} = unwrap_perl( $obj->{$_} ) for (keys %$obj);
 158    } elsif( $ref eq 'ARRAY' ) {
 159       $obj->[$_] = unwrap_perl($obj->[$_]) for(0..scalar(@$obj) - 1);
 160    }
 161    return $obj;
 162 }
 163
 164
 165
 166
 167 1;