root/cleverbox/trunk/cleverbox/model/client.py

# This file is part of the "Cleverbox" program.
#
# Cleverbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Cleverbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Cleverbox.  If not, see <http://www.gnu.org/licenses/>.
#
# Copyright 2008, Tristan Rivoallan

"""
This module regroups all the logic for manipulating client data in a given environment.
"""

import logging, os
from cleverbox.utils import filesystem, styles

client_dir_layout = ('htdocs', 'logs', 'tmp', 'var/svn', 'var/trac')

def exists(environment, client_name):
    """
    Returns true if requested client exists in supplied environment.
    """
    return client_name in get(environment)

def get(environment, only = False):
    '''
    Returns a list of clients in supplied environment.
    The "only" parameter is used to restrict returned clients list. Recognized values are "enabled" and "disabled".
    '''

    list_clients = []

    # Each client
    if not only:
        list_clients = os.listdir(environment.get_path('clients-available'))

    # Only enabled clients
    elif only == 'enabled':
        list_clients = os.listdir(environment.get_path('clients-enabled'))

    # Only disabled clients (ie. not enabled)
    elif only == 'disabled':

        disabled_clients = []
        available_clients = os.listdir(environment.get_path('clients-available'))
        enabled_clients = os.listdir(environment.get_path('clients-enabled'))

        # Expect poor performances for this intersection algorithm
        # see http://python.project.cwi.nl/search/hypermail/python-recent/0159.html
        for e in available_clients:
            if e not in enabled_clients:
                disabled_clients.append(e)

        list_clients = disabled_clients

    return list_clients

def add(environment, client_name, parameters = {}):
    """
    Creates a new client in supplied environment.
      * Checks if client not already exists
      * Collects informations about client
      * Checks informations are correct
      * Create clients environment directory layout
      * Creates apache configuration fragment
    """

    if (exists(environment, client_name)):
        raise Exception, 'Client "%s" already exists' % client_name

    # Client name cannot contain strokes
    if client_name.count('-') != 0:
        raise Exception, "Client's identifier can not contain the '-' character."

    # Information collection
    collected_infos = {'full_name' : None,
                       'home_dir'  : None}
    
    collected_infos['home_dir'] = os.path.join(environment.config.get('general', 'clients_root'), client_name)
    client_dir = collected_infos['home_dir']

    # Client creation
    # -- Homedir layout
    homedir_layout = []
    for d in client_dir_layout:
        homedir_layout.append(os.path.join(collected_infos['home_dir'], d))
    map(os.makedirs, homedir_layout)

    print styles.style.SUCCESSNORESET('')
    logging.info("  Directory layout created in %s" % collected_infos['home_dir'])
    print

    # -- Apache configuration
    apache_conf = """
# -- Include enabled projects configuration files
Include %(env_dir)s/projects-enabled/%(client_name)s-*
""" % { 'client_name' : client_name,
'home_dir'    : collected_infos['home_dir'],
'env_dir'     : environment.path }

    # -- Write conf to filesystem
    apache_conf_filepath = os.path.join(environment.path, 'clients-available', client_name)
    f = file(apache_conf_filepath, 'w+')
    f.write(apache_conf)
    f.close()

    logging.info("  Apache configuration written to %s\n" % apache_conf_filepath)

    # -- Set permissions
    user  = environment.config.get('general', 'ssh_user')
    group = environment.config.get('general', 'apache_group')
    
    permissions = {os.path.join(environment.path, 'clients-available', client_name)    : (0640, user, group),
                   os.path.join(client_dir)                                            : (0750, user, group),
                   os.path.join(client_dir, 'htdocs')                                  : (0770, user, group),
                   os.path.join(client_dir, 'logs')                                    : (0770, user, group),
                   os.path.join(client_dir, 'tmp')                                     : (0770, user, group),
                   os.path.join(client_dir, 'var')                                     : (0750, user, group),
                   os.path.join(client_dir, 'var', 'svn')                              : (0750, user, group),
                   os.path.join(client_dir, 'var', 'trac')                             : (0750, user, group)}
    
    filesystem.set_permissions(permissions)
    
    logging.info("  Fixed permissions in %s" % collected_infos['home_dir'])

    #  Final steps
    # -- Enable client ?
    print styles.style.RESET('')
    try:
        enable_client = parameters['enable']
    except KeyError:
        enable_client = raw_input('Enable client ? [y/N]> ').strip() or False

    if str(enable_client).find('y') == 0:
        enable(environment,client_name)

    print styles.style.SUCCESSNORESET('')
    logging.info("  Client %s was successfully created." % collected_infos['full_name'])
    print "  Apache configuration need to be reloaded for this to be effective."
    print
    print "  You may want create some projects now. Try 'help project' for some documentation."
    print styles.style.RESET('')

def remove(environment, client_name):
    """
    Deletes client from supplied environment.
    
    TODO : turn that into an "archive" command to avoid complete loss of data
    """
    
    raise NotImplementedError, "More work needed on this"
    
    if not exists(environment, client_name):
        raise Exception, 'Client "%s" does not exists.'

    continue_removal = False
    print "You are about to remove client '%s'." % client_name
    confirm_removal = raw_input('Remove client ? [y/N]> ').strip() or False
    if confirm_removal == 'y':
        continue_removal = True

    if not continue_removal:
        print "Client '%s' was *not* removed" % client_name
        return

    # Client is enabled, propose disabling it
    client_disabled = True
    if client_name in get(environment, 'enabled'):
        client_disabled = False
        print "You can not remove an enabled client. Disabling it."
        try:
            disable(environment, client_name)
        except Exception, e:
            print e

    # Disable client's projects
    for project_name in get_projects(environment, client_name, 'enabled'):
        project.disable(environment, (client_name, project_name))

    # Disable client
    client_apacheconf = os.path.join(environment.path, 'clients-available', client_name)
    os.unlink(client_apacheconf)
    
    print "Client '%s' has been removed." % client_name
    print "Apache configuration needs to be reloaded for this to be effective."

def enable(environment, client_name):
    """
    Enables client in supplied environment.
    """
    
    if not exists(environment, client_name):
        raise Exception, 'Client "%s" does not exist.' % client_name

    if client_name in get(environment, 'enabled'):
        raise Exception, 'Client "%s" is already enabled.' % client_name

    target = os.path.join(environment.path, 'clients-available', client_name)
    linkname = os.path.join(environment.path, 'clients-enabled', client_name)
    os.symlink(target, linkname)

    print styles.style.SUCCESSNORESET('')
    logging.info("  Client '%s' has been enabled" % client_name)
    print "  Apache configuration needs to be reloaded for this to be effective."
    print styles.style.RESET('')

def disable(environment, client_name):
    """
    Disables a client in supplied environment.
    """
    if not exists(environment, client_name):
        raise Exception, 'Client "%s" does not exist.' % client_name

    if client_name in get(environment, 'disabled'):
        raise Exception, 'Client "%s" is already disabled.' % client_name

    from cleverbox.model import project
    client_projects = get_projects(environment, client_name, 'enabled')
    if len(client_projects):
        print
        for project_name in client_projects:
            project.disable(environment, client_name, project_name)

    linkname = os.path.join(environment.path, 'clients-enabled', client_name)
    os.unlink(linkname)
    
    print styles.style.SUCCESSNORESET('')
    logging.info("  Client '%s' has been disabled" % client_name)
    print "  Apache configuration needs to be reloaded for this to be effective."
    print styles.style.RESET('')

def get_projects(environment, client_name, status=None):
    """
    Returns client's projects in environment.
    If "status" parameter is supplied, returned list is limited to projects with this status.
    """

    # Having the import here avoids a circular import problem with project.py
    from cleverbox.model import project
    return project.get(environment, client_name, status)