From a04857a23947d5a520204480ed344e69d0c8cf6a Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 16 Jan 2009 00:00:15 -0700 Subject: Renamed ipaserver.rpc to ipaserver.rpcserver --- ipaserver/rpcserver.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 ipaserver/rpcserver.py (limited to 'ipaserver/rpcserver.py') diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py new file mode 100644 index 00000000..c2cb0bd5 --- /dev/null +++ b/ipaserver/rpcserver.py @@ -0,0 +1,60 @@ +# Authors: +# Jason Gerard DeRose +# +# Copyright (C) 2008 Red Hat +# see file 'COPYING' for use and warranty information +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; version 2 only +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +""" +Execute an RPC request. +""" + +from xmlrpclib import dumps, loads, Fault +from ipalib import Backend +from ipalib.errors import HandledError, CommandError +from ipalib.rpc import xml_wrap, xml_unwrap + + +def params_2_args_options(params): + assert type(params) is tuple + if len(params) == 0: + return (tuple(), dict()) + if type(params[-1]) is dict: + return (params[:-1], params[-1]) + return (params, dict()) + + +class xmlrpc(Backend): + + def dispatch(self, method, params): + assert type(method) is str + assert type(params) is tuple + self.info('Received RPC call to %r', method) + if method not in self.Command: + raise CommandError(name=method) + (args, options) = params_2_args_options(xml_unwrap(params)) + result = self.Command[method](*args, **options) + return (xml_wrap(result),) + + def execute(self, data, ccache=None, client_ip=None, locale=None): + try: + (params, method) = loads(data) + response = self.dispatch(method, params) + except Exception, e: + if not isinstance(e, HandledError): + e = UnknownError() + assert isinstance(e, HandledError) + response = Fault(e.code, e.message) + return dumps(response) -- cgit From f2e479c33e84367f29d5063dc00c80c49f25f3c9 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 16 Jan 2009 01:47:03 -0700 Subject: rpcserver now uses xml_dumps() and xml_loads() functions --- ipaserver/rpcserver.py | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) (limited to 'ipaserver/rpcserver.py') diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py index c2cb0bd5..55d6f216 100644 --- a/ipaserver/rpcserver.py +++ b/ipaserver/rpcserver.py @@ -18,13 +18,13 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -Execute an RPC request. +RPC server. """ -from xmlrpclib import dumps, loads, Fault +from xmlrpclib import Fault from ipalib import Backend -from ipalib.errors import HandledError, CommandError -from ipalib.rpc import xml_wrap, xml_unwrap +from ipalib.errors2 import PublicError, InternalError, CommandError +from ipalib.rpc import xml_dumps, xml_loads def params_2_args_options(params): @@ -36,25 +36,28 @@ def params_2_args_options(params): return (params, dict()) -class xmlrpc(Backend): +class xmlserver(Backend): + """ + Execution backend for XML-RPC server. + """ def dispatch(self, method, params): assert type(method) is str assert type(params) is tuple - self.info('Received RPC call to %r', method) + self.debug('Received RPC call to %r', method) if method not in self.Command: raise CommandError(name=method) - (args, options) = params_2_args_options(xml_unwrap(params)) + (args, options) = params_2_args_options(params) result = self.Command[method](*args, **options) - return (xml_wrap(result),) + return (result,) # Must wrap XML-RPC response in a tuple singleton - def execute(self, data, ccache=None, client_ip=None, locale=None): + def execute(self, data, ccache=None, client_ip=None, languages=None): try: - (params, method) = loads(data) + (params, method) = xml_loads(data) response = self.dispatch(method, params) except Exception, e: - if not isinstance(e, HandledError): - e = UnknownError() - assert isinstance(e, HandledError) - response = Fault(e.code, e.message) + if not isinstance(e, PublicError): + e = InternalError() + assert isinstance(e, PublicError) + response = Fault(e.errno, e.strerror) return dumps(response) -- cgit From 462bac3c13de92511085b080ee5b9999f275a1e3 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 16 Jan 2009 01:56:39 -0700 Subject: Added docstring cross-references between rpc and rpcserver modules --- ipaserver/rpcserver.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'ipaserver/rpcserver.py') diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py index 55d6f216..d7f2ee1a 100644 --- a/ipaserver/rpcserver.py +++ b/ipaserver/rpcserver.py @@ -19,6 +19,8 @@ """ RPC server. + +Also see the `ipalib.rpc` module. """ from xmlrpclib import Fault -- cgit From 7514f96173575c42c2f5592034211d19ff711a02 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 16 Jan 2009 11:07:21 -0700 Subject: New Param: fixed metavar bug in cli.py --- ipaserver/rpcserver.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'ipaserver/rpcserver.py') diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py index d7f2ee1a..8b16eda9 100644 --- a/ipaserver/rpcserver.py +++ b/ipaserver/rpcserver.py @@ -53,7 +53,11 @@ class xmlserver(Backend): result = self.Command[method](*args, **options) return (result,) # Must wrap XML-RPC response in a tuple singleton - def execute(self, data, ccache=None, client_ip=None, languages=None): + def execute(self, data, ccache=None, client_version=None, + client_ip=None, languages=None): + """ + Execute the XML-RPC request in contained in ``data``. + """ try: (params, method) = xml_loads(data) response = self.dispatch(method, params) -- cgit From 55fba5420d8ea57931937728102094492ca73d86 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Mon, 19 Jan 2009 21:10:42 -0700 Subject: Added rpc.xmlclient backend plugin for forwarding; added corresponding unit tests --- ipaserver/rpcserver.py | 2 -- 1 file changed, 2 deletions(-) (limited to 'ipaserver/rpcserver.py') diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py index 8b16eda9..22517367 100644 --- a/ipaserver/rpcserver.py +++ b/ipaserver/rpcserver.py @@ -44,8 +44,6 @@ class xmlserver(Backend): """ def dispatch(self, method, params): - assert type(method) is str - assert type(params) is tuple self.debug('Received RPC call to %r', method) if method not in self.Command: raise CommandError(name=method) -- cgit