root/StormSiren/Config.py

#!/usr/bin/env python

"""
StormSiren
Copyright (C) 2008  Chris Freeze <cfreeze/cfreeze_com\>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""

"""
This is StormSiren a program inspired by the StormSiren application
written by Roy McManus <slorf/users_sourceforge_net>.  Much like the
original StormSiren written by Roy McManus <slorf/users_sourceforge_net>,
this program is a simple script capable of scanning and providing
notifications of weather bulletins issued by the National
Weather Service.  StormSiren supports a wide range of paging devices
and filtering of alert types per alert device.  While inspired by
StormSiren, StormSiren is a complete rewrite that is capable of using
the new CAP/XML feeds provided at http://www.weather.gov/alerts/.

For more information there is see the README.TXT file located in the root
of this directory.
"""

import sys
import os
from ConfigParser import NoOptionError, NoSectionError, MissingSectionHeaderError, SafeConfigParser
import logging.config


class Config(object):

        DEFAULT_MAX_BYTES = 100000
        DEFAULT_MAX_LOGS = 3

        def __init__(self, appname, config_file = None):
                self.__appname            = appname
                self.__config_file        = ''
                self.__configParser       = SafeConfigParser()
                self.__config_dir         = self.___getConfigDir()
                self.__config_file        = self.__config_dir + '/' + appname + '.conf'
                self.log                  = logging.getLogger('Config')

                self.log.setLevel(logging.INFO)

                if(config_file):
                        self.__config_file = config_file

                if(os.path.exists(self.__config_file)):
                        self.log.debug("Using configuration file with %s" % self.__config_file)
                else:
                        self.log.error("Configuration file [%s] not found" % self.__config_file)
                        self.log.error("See the example StormSiren.conf file in the examples directory")
                        sys.exit(1)

        def ___getConfigDir(self):
                config_dir = ""
                if(os.name == 'posix'):
                        home_dir                 = os.environ.get('HOME')
                        config_dir       = home_dir + '/.' + self.__appname
                elif(os.name == 'os2'):
                        home_dir                 = os.environ.get('HOME')
                        config_dir       = home_dir + '/' + self.__appname
                elif(os.name == 'nt'):
                        home_dir                 = os.environ.get('USERPROFILE') # NT/2K/XP
                        if(home_dir == None):
                                home_dir = os.environ.get('WINDIR') # 95/98/ME
                        config_dir       = home_dir + '/Application Data/' + self.__appname
                return config_dir

        def getRequired(self,section,key):
                        val = self.get(section,key)
                        if(not val):
                                self.log.error("Required key not found in configuration file")
                                self.log.error("Section [" + section + "] key [" + key + "=SOMEVALUE] Not Present")
                                sys.exit(2)
                        else:
                                return val

        def get(self,section,key,default=None):
                try:
                        return self.__configParser.get(section,key)
                except NoSectionError,e:
                        self.log.debug("Configuration File Error: Could not find section %s." % e)
                        return default
                except NoOptionError:
                        self.log.debug("Configuration File Error: Could not find %s in section %s." % (key, section))
                        return default

        def _load(self):
                self.log.debug("Loading Configuration File")
                self.__configParser.read(self.__config_file)
                self.__load_logging_settings()

        def __load_logging_settings(self):
                logger = logging.getLogger() #Get the root logger
                shouldLogToDisk = self.get('main','logging',"False")
                if(shouldLogToDisk == "True"):
                        self.log.debug("User requesting logging to disk")
                        logFile = self.get('log','file',None)
                        if(not logFile):
                                self.log.debug("No log file specified, using default")
                                logFile = self.__config_dir + '/' + self.__appname + '.log'
                        maxBytes = self.get('log','max_bytes',None)
                        if(not maxBytes):
                                self.log.debug("Max bytes per log file not specified, using default (%i bytes)", Config.DEFAULT_MAX_BYTES)
                                maxBytes = Config.DEFAULT_MAX_BYTES
                        maxLogs = self.get('log','max_logs',None)
                        if(not maxLogs):
                                self.log.debug("Max log files not specified, using default (%i log files)", Config.DEFAULT_MAX_LOGS)
                                maxLogs = Config.DEFAULT_MAX_LOGS

                        logFormat = self.get('log','log_format',None)
                        if(not logFormat):
                                self.log.debug("Log format not specified, using default")
                                logFormat = logging.Formatter("%(asctime)s - %(name)s:%(lineno)d - %(levelname)s - %(message)s")
                        else:
                                logFormat = logging.Formatter(logFormat)

                        handler = logging.handlers.RotatingFileHandler(logFile,"a",maxBytes,maxLogs)
                        handler.setFormatter(logFormat)
                        logger.addHandler(handler)

        def __str__(self):
                return "Config File: " + self.__config_file

        def display(self):
                print self.__str__()

        def getConfigFile(self):
                return self.__config_file

        config_file = property(getConfigFile,None,None)

        def getConfigDir(self):
                return self.__config_dir

        config_dir = property(getConfigDir,None,None)