4 use vars qw( @ISA $DEBUG );
7 # Instead of 'use'ing freeside modules on the fly below, just preload them now.
20 FS::XMLRPC - Object methods for handling XMLRPC requests
26 $xmlrpc = new FS::XMLRPC;
28 ($error, $response_xml) = $xmlrpc->serve($request_xml);
32 The FS::XMLRPC object is a mechanisim to access read-only data from freeside's subroutines. It does not, at least not at this point, give you the ability to access methods of freeside objects remotely. It can, however, be used to call subroutines such as FS::cust_main::smart_search and FS::Record::qsearch.
34 See the serve method below for calling syntax.
42 Provides a FS::XMLRPC object used to handle incoming XMLRPC requests.
52 $self->{_coder} = new Frontier::RPC2;
58 =item serve REQUEST_XML_SCALAR
60 The serve method takes a scalar containg an XMLRPC request for one of freeside's subroutines (not object methods). Parameters passed in the 'methodCall' will be passed as a list to the subroutine untouched. The return value of the called subroutine _must_ be a freeside object reference (eg. qsearchs) or a list of freeside object references (eg. qsearch, smart_search), _and_, the object(s) returned must support the hashref method. This will be checked first by calling UNIVERSAL::can('FS::class::subroutine', 'hashref').
62 Return value is an XMLRPC methodResponse containing the results of the call. The result of the subroutine call itself will be coded in the methodResponse as an array of structs, regardless of whether there was many or a single object returned. In other words, after you decode the response, you'll always have an array.
68 my ($self, $request_xml) = (shift, shift);
71 my $coder = $self->{_coder};
72 my $call = $coder->decode($request_xml);
74 warn "Got methodCall with method_name='" . $call->{method_name} . "'"
77 $response_xml = $coder->encode_response(&_serve($call->{method_name}, $call->{value}));
79 return ('', $response_xml);
83 sub _serve { #Subroutine, not method
85 my ($method_name, $params) = (shift, shift);
89 #die 'Called _serve without parameters' unless ref($params) eq 'ARRAY';
90 $params = [] unless (ref($params) eq 'ARRAY');
92 if ($method_name =~ /^(\w+)\.(\w+)/) {
94 #my ($class, $sub) = split(/\./, $method_name);
95 my ($class, $sub) = ($1, $2);
96 my $fssub = "FS::${class}::${sub}";
97 warn "fssub: ${fssub}" if $DEBUG;
98 warn "params: " . Dumper($params) if $DEBUG;
102 if ($class eq 'Conf') { #Special case for FS::Conf because we need an obj.
104 if ($sub eq 'config') {
105 my $conf = new FS::Conf;
106 @result = ($conf->config(@$params));
108 warn "FS::XMLRPC: Can't call undefined subroutine '${fssub}'";
113 unless (UNIVERSAL::can("FS::${class}", $sub)) {
114 warn "FS::XMLRPC: Can't call undefined subroutine '${fssub}'";
115 # Should we encode an error in the response,
116 # or just break silently to the remote caller and complain locally?
122 my $fssub = "FS::${class}::${sub}";
123 @result = (&$fssub(@$params));
127 warn "FS::XMLRPC: Error while calling '${fssub}': $@";
133 warn Dumper(@result);
135 if (grep { UNIVERSAL::can($_, 'hashref') ? 0 : 1 } @result) {
136 #warn "FS::XMLRPC: One or more objects returned from '${fssub}' doesn't " .
137 # "support the 'hashref' method.";
139 # If they're not FS::Record decendants, just return the results unmap'd?
140 # This is more flexible, but possibly more error-prone.
143 return [ map { $_->hashref } @result ];
145 } elsif ($method_name eq 'version') {
146 return [ $FS::VERSION ];
149 warn "Unhandle XMLRPC request '${method_name}'";