diff options
Diffstat (limited to 'src/lib/Bcfg2/Server')
| -rw-r--r-- | src/lib/Bcfg2/Server/BuiltinCore.py | 40 | ||||
| -rw-r--r-- | src/lib/Bcfg2/Server/CherryPyCore.py | 41 |
2 files changed, 63 insertions, 18 deletions
diff --git a/src/lib/Bcfg2/Server/BuiltinCore.py b/src/lib/Bcfg2/Server/BuiltinCore.py index 5b9c3302c..889e4d4d6 100644 --- a/src/lib/Bcfg2/Server/BuiltinCore.py +++ b/src/lib/Bcfg2/Server/BuiltinCore.py @@ -1,4 +1,4 @@ -""" the core of the builtin bcfg2 server """ +""" The core of the builtin Bcfg2 server. """ import os import sys @@ -12,8 +12,15 @@ from Bcfg2.SSLServer import XMLRPCServer class PidFile(object): - """ context handler to write the pid file """ + """ Context handler used by :class:`daemon.DaemonContext` to write + the PID file. """ + def __init__(self, pidfile): + """ + :param pidfile: The full path to the PID file to write on + entering the context handler + :type pidfile: string + """ self.pidfile = pidfile def __enter__(self): @@ -29,18 +36,32 @@ class Core(BaseCore): def __init__(self, setup): BaseCore.__init__(self, setup) + + #: The :class:`Bcfg2.SSLServer.XMLRPCServer` instance powering + #: this server core self.server = None + + #: The :class:`daemon.DaemonContext` used to drop privileges, + #: write the PID file (with :class:`PidFile`), and daemonize + #: this core. self.context = \ daemon.DaemonContext(uid=self.setup['daemon_uid'], gid=self.setup['daemon_gid'], pidfile=PidFile(self.setup['daemon'])) + __init__.__doc__ = BaseCore.__init__.__doc__.split('.. -----')[0] def _dispatch(self, method, args, dispatch_dict): - """Custom XML-RPC dispatcher for components. - - method -- XML-RPC method name - args -- tuple of paramaters to method + """ Dispatch XML-RPC method calls + :param method: XML-RPC method name + :type method: string + :param args: Paramaters to pass to the method + :type args: tuple + :param dispatch_dict: A dict of method name -> function that + can be used to provide custom mappings + :type dispatch_dict: dict + :returns: The return value of the method call + :raises: :exc:`xmlrpclib.Fault` """ if method in dispatch_dict: method_func = dispatch_dict[method] @@ -55,7 +76,7 @@ class Core(BaseCore): try: method_start = time.time() try: - result = method_func(*args) + return method_func(*args) finally: Bcfg2.Statistics.stats.add_value(method, time.time() - method_start) @@ -66,13 +87,15 @@ class Core(BaseCore): if getattr(err, "log", True): self.logger.error(err, exc_info=True) raise xmlrpclib.Fault(getattr(err, "fault_code", 1), str(err)) - return result def _daemonize(self): + """ Open :attr:`context` to drop privileges, write the PID + file, and daemonize the server core. """ self.context.open() self.logger.info("%s daemonized" % self.name) def _run(self): + """ Create :attr:`server` to start the server listening. """ hostname, port = urlparse(self.setup['location'])[1].split(':') server_address = socket.getaddrinfo(hostname, port, @@ -96,6 +119,7 @@ class Core(BaseCore): return True def _block(self): + """ Enter the blocking infinite loop. """ try: self.server.serve_forever() finally: diff --git a/src/lib/Bcfg2/Server/CherryPyCore.py b/src/lib/Bcfg2/Server/CherryPyCore.py index 53f3de018..1735fa5c7 100644 --- a/src/lib/Bcfg2/Server/CherryPyCore.py +++ b/src/lib/Bcfg2/Server/CherryPyCore.py @@ -1,4 +1,5 @@ -""" the core of the CherryPy-powered server """ +""" The core of the `CherryPy <http://www.cherrypy.org/>`_-powered +server. """ import sys import time @@ -12,10 +13,12 @@ from cherrypy.process.plugins import Daemonizer, DropPrivileges, PIDFile def on_error(*args, **kwargs): # pylint: disable=W0613 - """ define our own error handler that handles xmlrpclib.Fault + """ CherryPy error handler that handles :class:`xmlrpclib.Fault` objects and so allows for the possibility of returning proper - error codes. this obviates the need to use the builtin CherryPy - xmlrpc tool """ + error codes. This obviates the need to use + :func:`cherrypy.lib.xmlrpc.on_error`, the builtin CherryPy xmlrpc + tool, which does not handle xmlrpclib.Fault objects and returns + the same error code for every error.""" err = sys.exc_info()[1] if not isinstance(err, xmlrpclib.Fault): err = xmlrpclib.Fault(xmlrpclib.INTERNAL_ERROR, str(err)) @@ -25,8 +28,11 @@ cherrypy.tools.xmlrpc_error = ErrorTool(on_error) class Core(BaseCore): - """ The CherryPy-based server core """ + """ The CherryPy-based server core. """ + #: Base CherryPy config for this class. We enable the + #: ``xmlrpc_error`` tool created from :func:`on_error` and the + #: ``bcfg2_authn`` tool created from :func:`do_authn`. _cp_config = {'tools.xmlrpc_error.on': True, 'tools.bcfg2_authn.on': True} @@ -36,11 +42,15 @@ class Core(BaseCore): cherrypy.tools.bcfg2_authn = cherrypy.Tool('on_start_resource', self.do_authn) + #: List of exposed plugin RMI self.rmi = self._get_rmi() cherrypy.engine.subscribe('stop', self.shutdown) + __init__.__doc__ = BaseCore.__init__.__doc__.split('.. -----')[0] def do_authn(self): - """ perform authentication """ + """ Perform authentication by calling + :func:`Bcfg2.Server.Core.BaseCore.authenticate`. This is + implemented as a CherryPy tool.""" try: header = cherrypy.request.headers['Authorization'] except KeyError: @@ -60,10 +70,11 @@ class Core(BaseCore): @cherrypy.expose def default(self, *args, **params): # pylint: disable=W0613 - """ needed to make enough changes to the stock - XMLRPCController to support plugin.__rmi__ and prepending - client address that we just rewrote. it clearly wasn't - written with inheritance in mind :( """ + """ Handle all XML-RPC calls. It was necessary to make enough + changes to the stock CherryPy + :class:`cherrypy._cptools.XMLRPCController` to support plugin + RMI and prepending the client address that we just rewrote it. + It clearly wasn't written with inheritance in mind.""" rpcparams, rpcmethod = xmlrpcutil.process_body() if rpcmethod == 'ERRORMETHOD': raise Exception("Unknown error processing XML-RPC request body") @@ -92,12 +103,17 @@ class Core(BaseCore): return cherrypy.serving.response.body def _daemonize(self): + """ Drop privileges with + :class:`cherrypy.process.plugins.DropPrivileges`, daemonize + with :class:`cherrypy.process.plugins.Daemonizer`, and write a + PID file with :class:`cherrypy.process.plugins.PIDFile`. """ DropPrivileges(cherrypy.engine, uid=self.setup['daemon_uid'], gid=self.setup['daemon_gid']).subscribe() Daemonizer(cherrypy.engine).subscribe() PIDFile(cherrypy.engine, self.setup['daemon']).subscribe() def _run(self): + """ Start the server listening. """ hostname, port = urlparse(self.setup['location'])[1].split(':') if self.setup['listen_all']: hostname = '0.0.0.0' @@ -117,4 +133,9 @@ class Core(BaseCore): return True def _block(self): + """ Enter the blocking infinite server + loop. :func:`Bcfg2.Server.Core.BaseCore.shutdown` is called on + exit by a :meth:`subscription + <cherrypy.process.wspbus.Bus.subscribe>` on the top-level + CherryPy engine.""" cherrypy.engine.block() |