config.py

Go to the documentation of this file.

#!/usr/bin/python
# -*- coding: utf-8 -*-
# @cond LICENSE
#
# Copyright [2010-2013] Institute of Nuclear Physics PAN, Krakow, Poland
#
# Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
# @endcond LICENSE
##
# @package src.common.tools.config
# @author Maciej Nabozny <mn@mnabozny.pl>
# 
import shutil
import os


##
# 
#     Updates specific key-value pair in config file. It reads config.py file
#     and searches for that key-value pair. If found, it's replaced with new
#     value.
# 
#     @parameter{module,string}
#     @parameter{key,string}
#     @parameter{value,string}
#     
def update(module, key, value):
    try:
        config = open('/etc/cc1/%s/config.py' % module).readlines()
    except:
        raise Exception('config_open')

    new_config = []

    for line in config:
        if line.startswith(key):
            if type(value) == type(""):
                new_config.append('%s="%s"\n' % (key, value))
            else:
                new_config.append('%s=%d\n' % (key, value))
        else:
            new_config.append(line)

    config = open('/etc/cc1/%s/config.py' % module, 'w')
    config.write(''.join(new_config))
    config.close()


##
# 
#     @parameter{config,module} Python module, where configuration constants are stored
#     
def options(config):
    return filter(lambda option: option[0:2] != "__", dir(config))


##
# 
#     @parameter{module,string} module name
#     
def check(module):
    try:
        config = __import__('config')
    except:
        config = __import__('%s.config' % module, fromlist=[module.lower()])

    config_example = __import__('%s.config_example' % module, fromlist=[module.lower()])
    defaults = __import__('%s.defaults' % module, fromlist=[module.lower()])

    missing = 0
    default = 0
    unused = 0
    # invalid = 0  # possible future use

    for option_name in options(config_example):
        value = None
        try:
            value = getattr(config, option_name)
        except AttributeError:
            try:
                value = getattr(defaults, option_name)
                default += 1
                # Print to force logs appear in WSGI log
                print "[info] '%s' configuration option '%s' not present, using default: %s" % (module, option_name, str(value))
            except AttributeError:
                missing += 1
                # Print to force logs appear in WSGI log
                print "[error] '%s' configuration option '%s' missing!" % (module, option_name)
        # if value is invalid, invalid += 1

    for option_name in options(config):
        try:
            getattr(config_example, option_name)
        except AttributeError:
            print "[warning] '%s' configuration option '%s' is not used by CC1 and maybe should be removed" % (module, option_name)
            unused += 1

    if missing > 0:  # if missing + invalid > 0:
        raise Exception("'%s' configuration file is invalid. Please, edit your config.py file!." % module)
    else:
        print "[info] CC1 %s configuration is valid." % module


def configure(site):
    shutil.copyfile('/usr/lib/cc1/%s/config_example.py' % site, '/etc/cc1/%s/config.example' % site)
    if os.path.exists('/etc/cc1/%s/config.py' % site):
        # Create symlink, if not exists
        if not os.path.exists('/usr/lib/cc1/%s/config.py' % site):
                os.symlink('/etc/cc1/%s/config.py' % site, '/usr/lib/cc1/%s/config.py' % site)

        print "WARNING: %s alredy configured" % site
        return 0

    shutil.copyfile('/etc/cc1/%s/config.example' % site, '/etc/cc1/%s/config.py' % site)

    os.symlink('/etc/cc1/%s/config.py' % site, '/usr/lib/cc1/%s/config.py' % site)

    return 0


def remove(site):
    if os.path.exists('/usr/lib/cc1/%s/config.py' % site):
        os.unlink('/usr/lib/cc1/%s/config.py' % site)
    return 0


def purge(site):
    remove(site)
    if os.path.exists('/etc/cc1/%s/config.py' % site):
        os.remove('/etc/cc1/%s/config.py' % site)

    if os.path.exists('/etc/cc1/%s/config.example' % site):
        os.remove('/etc/cc1/%s/config.example' % site)
    return 0