Changeset 182 for cleverbox/trunk

Timestamp:

08/13/07 20:38:39 (5 years ago)

Author:

trivoallan

Message:

cleverbox : refactored projects in their own module.

Location:

cleverbox/trunk/cleverbox

Files:

• client.py (modified) (2 diffs)
• scripts/admin.py (modified) (6 diffs)

cleverbox/trunk/cleverbox/client.py

@@ +1 @@
+"""
+This module regroups all the logic for manipulating client data in a given environment.
+"""
+
+import os
+from cleverbox import project
+from cleverbox.utils import filesystem
+
+client_dir_layout = ('htdocs', 'logs', 'tmp', 'uploads', '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(self, environment, only = False):
+def get(environment, only = False):
     '''
-    Returns a list of clients.
+    Returns a list of clients in supplied environment.
     The "only" parameter is used to restrict returned clients list. Recognized values are "enabled" and "disabled".
     '''
@@ -34 +47 @@
 
     return list_clients
+
+def add(environment, client_name):
+    """
+    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:
+        print "** Client's identifier can not contain the '-' character."
+        return
+
+    # 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)
+
+    # A few checks before effectively creating client
+    # -- homedir
+    parent_dir = os.path.normpath(os.path.join(collected_infos['home_dir'], os.pardir))
+    dir_is_ok = os.access(parent_dir, os.W_OK) and not os.access(collected_infos['home_dir'], os.R_OK)
+    if not dir_is_ok:
+        print "Directory %s is not writable or already exists, aborting." % collected_infos['home_dir']
+        raise os.error
+
+
+    print
+    print "Creating a new client."
+    print "Let's collect some informations about him : "
+    print
+    print "  Please enter client's full name."
+    print "  This will be used in several interface screens and in emails."
+    print
+
+    dfn = client_name.capitalize()
+    collected_infos['full_name'] = raw_input('Full Name [%s]> ' % dfn).strip() or dfn
+
+    print
+    print "Supplied informations verified."
+    print "Let's proceed with client creation :"
+    print
+
+    # 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 "  Directory layout created in %s\n" % collected_infos['home_dir']
+
+    # -- 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()
+
+    print "  Apache configuration written to %s\n" % apache_conf_filepath
+
+    # -- Fix permissions
+    """
+    chown -R dev:dev /$CLIENTSROOT/$CLIENTNAME
+    chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/logs
+    chmod g+w /$CLIENTSROOT/$CLIENTNAME/logs
+    chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/uploads
+    chmod g+w /$CLIENTSROOT/$CLIENTNAME/uploads
+    """
+    filesystem.chowntree(collected_infos['home_dir'],
+                         filesystem.get_uid_from_name(environment.config.get('general', 'ssh_user')),
+                         filesystem.get_gid_from_name(environment.config.get('general', 'ssh_group')))
+    
+    os.chown(os.path.join(collected_infos['home_dir'], 'logs'),
+             filesystem.get_uid_from_name(environment.config.get('general', 'ssh_user')), 
+             filesystem.get_gid_from_name(environment.config.get('general', 'apache_group')) )
+    
+    os.chmod(os.path.join(collected_infos['home_dir'], 'logs'), 0775)
+    
+    os.chown(os.path.join(collected_infos['home_dir'], 'uploads'),
+             filesystem.get_uid_from_name(environment.config.get('general', 'ssh_user')),
+             filesystem.get_gid_from_name(environment.config.get('general', 'apache_group')))
+    
+    os.chmod(os.path.join(collected_infos['home_dir'], 'uploads'), 0775)
+
+    print "  Fixed permissions in %s\n" % collected_infos['home_dir']
+
+    #  Final steps
+    # -- Enable client ?
+    print "Client has been created. Do you want to enable it ?"
+    print
+    enable_client = raw_input('Enable client ? [y/N]> ').strip() or False
+
+    if enable_client == 'y':
+        self._do_client_enable(client_name)
+
+    print
+    print "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
+
+def remove(environment, client_name):
+    """
+    Deletes client from supplied environment.
+    """
+    
+    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 self._get_clients('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 project.get(environment, client_name, 'enabled'):
+        project.disable(environment, (client_name, project_name))
+
+    # Disable client
+    client_apacheconf = os.path.join( self.env.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(self.env.path, 'clients-available', client_name)
+    linkname = os.path.join(self.env.path, 'clients-enabled', client_name)
+    os.symlink(target, linkname)
+
+    print "Client '%s' has been enabled" % client_name
+    print "Apache configuration needs to be reloaded for this to be effective."
+
+def disable(environment, client_name):
+    """
+    Disables a client in supplied environment.
+    TODO : disable client's projects.
+    """
+    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 enabled.' % client_name
+
+    linkname = os.path.join(self.env.path, 'clients-enabled', client_name)
+    os.unlink(linkname)
+    
+    print "Client '%s' has been disabled" % client_name
+    print "Apache configuration needs to be reloaded for this to be effective."

cleverbox/trunk/cleverbox/scripts/admin.py

@@ -9 +9 @@
 from cleverbox.environment import Environment
 from cleverbox import client
-
-_defaults = {
-    'client_dir_layout' : ('htdocs', 'logs', 'tmp', 'uploads',
-                           'var/svn', 'var/trac')
-}
 
 _version = '0.5dev'
@@ -224 +219 @@
                 comp = complete_func.__call__()
 
-        return self.word_complete( text, comp )
+        return self.word_complete(text, comp)
 
 
@@ -231 +226 @@
         Displays enabled and disabled clients.
         '''
-
+        
         print "Enabled :\n" \
               "%s\n\n" \
               "Disabled : \n" \
-              "%s\n" % (self._get_clients('enabled'), self._get_clients('disabled'))
+              "%s\n" % (client.get(self.env, 'enabled'), client.get(self.env, 'disabled'))
 
     def _do_client_add(self, client_name):
-        """
-        Creates a new client.
-          * Checks if client not already exists.
-          * Collects informations about client
-          * Checks informations are correct
-          * Create clients environment directory layout
-          * Creates apache conf for apache
-          * Inserts client into LDAP
-        """
-
-        if not client.exists(self.env, client_name):
-
-            # Client name cannot contain strokes
-            if client_name.count('-') != 0:
-                print "** Client's identifier can not contain the '-' character."
-                return
-
-            # Information collection
-            collected_infos = { 'full_name'    : None,
-                                'home_dir'     : None,
-                                'ftp_password' : None }
-
-            collected_infos['home_dir'] = os.path.join(self.env.config.get('general', 'clients_root'), client_name)
-
-            # A few checks before effectively creating client
-            # -- homedir
-            parent_dir = os.path.normpath(os.path.join(collected_infos['home_dir'], os.pardir))
-            dir_is_ok = os.access(parent_dir, os.W_OK) and not os.access(collected_infos['home_dir'], os.R_OK)
-            if not dir_is_ok:
-                print "Directory %s is not writable or already exists, aborting." % collected_infos['home_dir']
-                raise os.error
-
-
-            print
-            print "Creating a new client."
-            print "Let's collect some informations about him : "
-            print
-            print "  Please enter client's full name."
-            print "  This will be used in several interface screens and in emails."
-            print
-
-            dfn = client_name.capitalize()
-            collected_infos['full_name'] = raw_input('Full Name [%s]> ' % dfn).strip() or dfn
-
-            print
-            print "Supplied informations verified."
-            print "Let's proceed with client creation :"
-            print
-
-            # Client creation
-            # -- Homedir layout
-            homedir_layout = []
-            for d in _defaults['client_dir_layout']:
-                homedir_layout.append( os.path.join(collected_infos['home_dir'], d) )
-            map( os.makedirs, homedir_layout )
-
-            print "  Directory layout created in %s\n" % collected_infos['home_dir']
-
-            # -- 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'     : self.env.path }
-
-            # -- Write conf to filesystem
-            apache_conf_filepath = os.path.join( self.env.path, 'clients-available', client_name )
-            f = file(apache_conf_filepath, 'w+')
-            f.write(apache_conf)
-            f.close()
-
-            print "  Apache configuration written to %s\n" % apache_conf_filepath
-
-            # -- Fix permissions
-            """
-            chown -R dev:dev /$CLIENTSROOT/$CLIENTNAME
-            chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/logs
-            chmod g+w /$CLIENTSROOT/$CLIENTNAME/logs
-            chown dev:www-data /$CLIENTSROOT/$CLIENTNAME/uploads
-            chmod g+w /$CLIENTSROOT/$CLIENTNAME/uploads
-            """
-            self._rchown(collected_infos['home_dir'],
-                         self.get_uid_from_name(username)(self.env.config.get('general', 'ssh_user')),
-                         self.get_gid_from_name(self.env.config.get('general', 'ssh_group')))
-            
-            os.chown(os.path.join(collected_infos['home_dir'], 'logs'),
-                     get_uid_from_name(self.env.config.get('general', 'ssh_user')), 
-                     get_gid_from_name(self.env.config.get('general', 'apache_group')) )
-            
-            os.chmod(os.path.join(collected_infos['home_dir'], 'logs'), 0775)
-            
-            os.chown(os.path.join(collected_infos['home_dir'], 'uploads'),
-                     get_uid_from_name(self.env.config.get('general', 'ssh_user')),
-                     get_gid_from_name(self.env.config.get('general', 'apache_group')))
-            
-            os.chmod(os.path.join(collected_infos['home_dir'], 'uploads'), 0775)
-
-            print "  Fixed permissions in %s\n" % collected_infos['home_dir']
-
-            #  Final steps
-            # -- Enable client ?
-            print "Client has been created. Do you want to enable it ?"
-            print
-            enable_client = raw_input('Enable client ? [y/N]> ').strip() or False
-
-            if enable_client == 'y':
-                self._do_client_enable(client_name)
-
-            print
-            print "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
-
-        else:
-            print "This client already exists !"
+        client.create(self.env, client_name)
 
     def _do_client_remove(self, client_name):
-        """
-        Suppression d'un client.
-        Un client actif ne peut être supprimé.
-        TODO : suppression du répertoire du client. (bof)
-        """
-
-        if self._client_exists(client_name):
-            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 self._get_clients('enabled'):
-                client_disabled = False
-                print "You can not remove an enabled client. Disabling it."
-                try:
-                    self._do_client_disable(client_name)
-                except Exception, e:
-                    print e
-
-            # Disable client's projects
-            for project_name in self._get_projects(client_name, 'enabled'):
-                self._do_project_disable((client_name, project_name))
-
-            # Disable client
-            client_apacheconf = os.path.join( self.env.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."
-        else:
-            print "This client does not exist !"
+        client.remove(self.env, client_name)
 
     def _do_client_enable(self, client_name):
-        enable_client = True
-        if not self._client_exists(client_name):
-            print "This client does not exist !"
-            enable_client = False
-
-        if client_name in self._get_clients('enabled'):
-            print "This client is already enabled !"
-            enable_client = False
-
-        if enable_client:
-            target = os.path.join( self.env.path, 'clients-available', client_name )
-            linkname = os.path.join( self.env.path, 'clients-enabled', client_name )
-            os.symlink( target, linkname )
-            print "Client '%s' has been enabled" % client_name
-            print "Apache configuration needs to be reloaded for this to be effective."
-        else:
-            print "Client '%s' was *not* enabled" % client_name
+        client.enable(self.env, client_name)
 
     def _do_client_disable(self, client_name):
-        """
-        Disables a client.
-        TODO : disable client's projects.
-        """
-        disable_client = True
-        if not self._client_exists(client_name):
-            print "This client does not exist !"
-            disable_client = False
-
-        if client_name in self._get_clients('disabled'):
-            print "This client is already disabled !"
-            disable_client = False
-
-        if disable_client:
-            linkname = os.path.join( self.env.path, 'clients-enabled', client_name )
-            os.unlink( linkname )
-            print "Client '%s' has been disabled" % client_name
-            print "Apache configuration needs to be reloaded for this to be effective."
-        else:
-            print "Client '%s' was *not* disabled" % client_name
-
+        client.disable(self.env, client_name)
 
     def _complete_client_remove(self):
-        return self._get_clients()
+        return client.get(self.env)
 
     def _complete_client_enable(self):
-        return self._get_clients('disabled')
+        return client.get(self.env, 'disabled')
 
     def _complete_client_disable(self):
-        return self._get_clients('enabled')
-
-
-    def _client_exists(self, name):
-        """
-        Tells whether or not a client exists.
-        return bool
-        """
-        return name in self._get_clients()
-
-    def _get_clients(self, only = False):
-        '''
-        Returns a list of clients.
-        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(os.path.join(self.env.path, 'clients-available'))
-
-        # Only enabled clients
-        elif only == 'enabled':
-            list_clients = os.listdir(os.path.join(self.env.path, 'clients-enabled'))
-
-        # Only disabled clients (ie. not enabled)
-        elif only == 'disabled':
-
-            disabled_clients = []
-            available_clients = os.listdir(os.path.join(self.env.path, 'clients-available'))
-            enabled_clients = os.listdir(os.path.join(self.env.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
-
+        return client.get(self.env, 'enabled')
 
     #
@@ -523 +286 @@
         client_projects = {}
 
-        clients = self._get_clients()
+        clients = client.get()
         for client_name in clients:
-            client_projects[client_name] = self._get_projects(client_name)
+            client_projects[client_name] = project.get(environment, client_name)
 
         print client_projects
@@ -1007 +770 @@
         return [a for a in words if a.startswith (text)]
 
-    def _rchown(self, directory, uid, gid):
-        """
-        Recursive chown.
-        """
-        try:
-            if (os.path.isdir(directory)):
-                os.chown(directory, uid, gid)
-                direntries = os.listdir(directory)
-                for direntry in direntries:
-                    direntry = os.path.join(directory, direntry)
-                    if (os.path.isdir(direntry)):
-                        os.chown(direntry, uid, gid)
-                        os.chdir(direntry)
-                        self._rchown(direntry, uid, gid)
-                    else:
-                        os.chown(direntry, uid, gid)
-            else:
-                os.chown(directory, uid, gid)
-        except (IOError, os.error), why:
-            print "rchown %s: %s" % (str(directory), str(why))
-
     def _arg_tokenize (self, argstr):
         """
@@ -1034 +776 @@
         argstr = util.to_utf8(argstr, sys.stdin.encoding)
         return shlex.split(argstr) or ['']
-
-    def get_uid_from_name(self, username):
-        return posix.pwd.getpwnam(username)['pw_uid']
-        
-    def get_gid_from_name(self, groupname):
-        return posix.grp.getgrnam(groupname)['gr_gid']
 
 def run(args):