pymindaemon.py

   1 # vim: set encoding=utf-8 et sw=4 sts=4 :
   2
   3 r"""
   4 Python Administration Daemon.
   5
   6 Python Administration Daemon is an modular, extensible administration tool
   7 to administrate a set of services remotely (or localy) throw a simple
   8 command-line.
   9 """
  10
  11 import signal
  12 import socket
  13 from dispatcher import Dispatcher
  14 from eventloop import EventLoop, LoopInterruptedError
  15
  16 class PyminDaemon(EventLoop):
  17     r"""PyminDaemon(bind_addr, routes) -> PyminDaemon instance
  18
  19     This class is well suited to run as a single process. It handles
  20     signals for controlled termination (SIGINT and SIGTERM), as well as
  21     a user signal to reload the configuration files (SIGUSR1).
  22
  23     bind_addr - is a tuple of (ip, port) where to bind the UDP socket to.
  24
  25     routes - is a dictionary where the key is a command string and the value
  26              is the command handler. This is passed directly to the Dispatcher.
  27
  28     Here is a simple usage example:
  29
  30     >>> def test_handler(*args): print 'test:', args
  31     >>> PyminDaemon(('', 9999), dict(test=test_handler)).run()
  32     """
  33
  34     def __init__(self, bind_addr, routes):
  35         r"""Initialize the PyminDaemon object.
  36
  37         See PyminDaemon class documentation for more info.
  38         """
  39         # Create and bind socket
  40         sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  41         sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
  42         sock.bind(bind_addr)
  43         # Create EventLoop
  44         EventLoop.__init__(self, sock)
  45         # Create Dispatcher
  46         self.dispatcher = Dispatcher(routes)
  47         # Signal handling
  48         def quit(signum, frame):
  49             print "Shuting down ..."
  50             self.stop() # tell main event loop to stop
  51         def reload_config(signum, frame):
  52             print "Reloading configuration..."
  53             # TODO iterate handlers list propagating reload action
  54         signal.signal(signal.SIGINT, quit)
  55         signal.signal(signal.SIGTERM, quit)
  56         signal.signal(signal.SIGUSR1, reload_config)
  57
  58     def handle(self):
  59         r"handle() -> None :: Handle incoming events using the dispatcher."
  60         (msg, addr) = self.file.recvfrom(65535)
  61         try:
  62             result = self.dispatcher.dispatch(msg)
  63             response = 'OK '
  64         except Exception, e:
  65             result = str(e)
  66             response = 'ERROR '
  67         if result is None:
  68             response += '0'
  69         else:
  70             response += '%d\n%s' % (len(str(result)), result)
  71         self.file.sendto(response, addr)
  72
  73     def run(self):
  74         r"run() -> None :: Run the event loop (shortcut to loop())"
  75         try:
  76             return self.loop()
  77         except LoopInterruptedError, e:
  78             pass
  79
  80 if __name__ == '__main__':
  81
  82     @handler
  83     def test_handler(*args):
  84         print 'test:', args
  85
  86     PyminDaemon(('', 9999), dict(test=test_handler)).run()
  87