code/runserver.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf8 -*-
   3 """ Runs the UDP server for Breadcrumb. """
   4
   5 # Copyright (C) 2008 Laurens Van Houtven <lvh at laurensvh.be>
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 import os
  20 import sys
  21 import logging
  22
  23 import optparse
  24 import ConfigParser
  25
  26 import breadcrumb.server.net as net
  27 import breadcrumb.server.handlers.base as base
  28 import breadcrumb.common.consts as consts
  29
  30 def main():
  31     """ Starts the default Breadcrumb server. """
  32     config = find_configuration()
  33
  34     handler = parse_handlers(config)
  35     serverargs = get_serverargs(config)
  36
  37     set_verbosity(serverargs)
  38
  39     net.start_server(handler = handler, **serverargs)
  40
  41 def find_configuration(filename = None):
  42     """
  43     Tries to find and parse a server configuration file.
  44
  45     Returns a ConfigParser object.
  46     """
  47     config = ConfigParser.ConfigParser()
  48
  49     filenames = filter(None, consts.SERVER_CONFIG_FILENAMES + [filename])
  50     for filename in filenames:
  51         try:
  52             filename = os.path.expanduser(filename)
  53             config.readfp(open(filename))
  54             logging.info("Using config file %s..." % filename)
  55             return config
  56         except NameError:
  57             logging.debug("No config file at %s..." % filename)
  58             continue
  59
  60     logging.warning("No usable config files found!")
  61
  62 def set_verbosity(serverargs):
  63     """Sets the logging level, based on the server's arguments."""
  64     if 'verbosity' in serverargs:
  65         verbosity = serverargs['verbosity'].lower()
  66
  67         if verbosity in ['high', 'loud', 'debug']:
  68             logging.getLogger().setLevel(logging.DEBUG)
  69         elif verbosity in ['low', 'quiet', 'error']:
  70             logging.getLogger().setLevel(logging.ERROR)
  71         elif verbosity in ['verylow', 'veryquiet', 'critical']:
  72             logging.getLogger().setLevel(logging.CRITICAL)
  73         else:
  74             logging.getLogger().setLevel(logging.INFO)
  75
  76         del serverargs['verbosity']
  77
  78     logging.getLogger().setLevel(logging.INFO)
  79
  80 def parse_handlers(config):
  81     """
  82     Parses the handlers described in the configuration file.
  83
  84     Returns a sequential handler with all the (correctly configured) handlers
  85     from the configuration file.
  86     """
  87     seqhandler = base.SequentialHandler()
  88
  89     for name in config.sections():
  90         if name == "server":
  91             continue
  92
  93         data = dict(config.items(name))
  94
  95         if 'class' not in data:
  96             logging.error('No class for %s, skipping...' % name)
  97             continue
  98
  99         splitnames = data['class'].split('.')
 100         del data['class']
 101         modulename, classname = '.'.join(splitnames[:-1]), splitnames[-1]
 102
 103         if 'pythonpath' in data:
 104             sys.path.append(data['pythonpath'])
 105             del data['pythonpath']
 106
 107         try:
 108             __import__(modulename, globals(), locals(), [classname])
 109         except ImportError:
 110             logging.error("Couldn't import %s, skipping..." % modulename)
 111             continue
 112
 113         handlerclass = getattr(sys.modules[modulename], classname)
 114
 115         logging.debug("Creating handler with args: %s" % repr(data))
 116         handler = handlerclass(**data)
 117
 118         seqhandler.addhandler(handler)
 119
 120     return seqhandler
 121
 122 def get_serverargs(config):
 123     """
 124     Gets the server arguments from the ConfigParser object.
 125
 126     Returns a dict.
 127     """
 128     if not config.has_section('server'):
 129         logging.info("Config file doesn't have a [server] section...")
 130         return {}
 131
 132     return dict(config.items('server'))
 133
 134 if __name__ == "__main__":
 135     main()