summaryrefslogtreecommitdiffstats
path: root/ipaserver/rpcserver.py
blob: 8c04158a800d648141c308b46a31200a743d3702 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# 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

"""
RPC server.

Also see the `ipalib.rpc` module.
"""

from xmlrpclib import Fault
from ipalib import Backend
from ipalib.errors2 import PublicError, InternalError, CommandError
from ipalib.rpc import xml_dumps, xml_loads
from ipalib.util import make_repr


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 xmlserver(Backend):
    """
    Execution backend plugin for XML-RPC server.

    Also see the `ipalib.rpc.xmlclient` plugin.
    """

    def dispatch(self, method, params):
        self.debug('Received RPC call to %r', method)
        if method not in self.Command:
            raise CommandError(name=method)
        (args, options) = params_2_args_options(params)
        result = self.Command[method](*args, **options)
        return (result,)  # Must wrap XML-RPC response in a tuple singleton

    def execute(self, data):
        """
        Execute the XML-RPC request in contained in ``data``.
        """
        try:
            (params, method) = xml_loads(data)
            response = self.dispatch(method, params)
            print 'okay'
        except Exception, e:
            if not isinstance(e, PublicError):
                self.exception(
                    '%s: %s', e.__class__.__name__, str(e)
                )
                e = InternalError()
            assert isinstance(e, PublicError)
            self.info('%s: %s', e.__class__.__name__, str(e))
            response = Fault(e.errno, e.strerror)
        return xml_dumps(response, methodresponse=True)