Added ini config

improved checking for valid configuration

Author: Stephen Hoogendijk

.gitignore

@@ -1 +1,3 @@
+#editor files
 .idea
+.gitignore

create-vhost.ini

@@ -0,0 +1,19 @@
+
+
+# Create vhost configuration file
+
+
+[apache]
+# apache runs on port 80 by default
+port = 80
+
+# full path to the directory containing the vhosts
+vhost_path = /etc/apache2/sites-enabled
+
+# full path to the apache executable
+apache_exec = /etc/init.d/apache2
+
+[git]
+
+# optional: path to your local git installation
+exec = /usr/bin/git

create-vhost.py

@@ -1,108 +1,148 @@
 #!/usr/bin/env python
+from _socket import getservbyport
 
-import optparse, re, os, time, urllib2
+import optparse, re, os, time, urllib2, ConfigParser
 
-apache_port = 80
+domain = None
+www_dir = None
+git_url = None
 
-class vHost:
+cfg = ConfigParser.ConfigParser()
+configfile = 'create-vhost.ini'
 
+print '--- Create vhost script for Apache2 ---'
+print '--- Copyright Stephen Hoogendijk 2013, Licensed under the GPL V2 License ---'
+print
 
-    domain = None
-    www_dir = None
-    use_pub = False
-    git_url = None
+if not os.path.exists(configfile):
+    exit('Cannot find config file %s' % configfile)
 
-    def __init__(self):
+try:
+    cfg.read(configfile)
+except ConfigParser.ParsingError as exc:
+    exit('Parse error: %s' % exc)
 
+try:
+    apache_port = int(cfg.get('apache', 'port'))
+    vhost_path = cfg.get('apache', 'vhost_path')
+    apache_exec = cfg.get('apache', 'vhost_path')
+    git_exec = cfg.get('git', 'exec')
+except Exception as exc:
+    exit('Config file invalid, please check %s' %configfile)
 
-        if domain is None:
-            raise BaseException('Domain not set!')
-
-        if www_dir is None:
-            raise BaseException('WWW root directory not set!')
-
-        # check if the www_dir already exists, i
-        if os.path.exists(www_dir):
-
-
-        if not str(apache_port).isdigit():
-            raise BaseException('The apache port is not valid!')
-
-        # check the git repo if it has been set
-        if git_url is not None:
-            self._check_git(git_url)
-
-
-    def create(self):
-
-        print 'Creating new vhost...'
-        time.sleep(1)
-
-        return True
-
-    # this method checks if the given git repository is valid
-    def _check_git(self, url):
-
-        try:
-            data = urllib2.urlopen(url)
-        except Exception as e:
-            raise BaseException('GIT repo \'%s\' could not be read' % url)
 
 
 def main():
     global use_pub, apache_port, domain, www_dir, git_url
 
     p = optparse.OptionParser()
-    p.add_option('--interactive', '-i', default=False, help="Run this script interactively")
-    p.add_option('--use_public_dir', '-p', default='yes', help="Use the /public directory as the document root")
+    p.add_option('--interactive', '-i',action="store_true", help="Run this script interactively")
     p.add_option('--domain', '-d', default=None, help="Set the domain of this vhost")
     p.add_option('--www_dir', '-w', default=None, help="Set the root directory for this vhost")
     p.add_option('--git_url', '-g', default=None, help="Set the GIT repository URL")
-    p.add_option('--apache_port', '-P', default=80, help="Override the apache port")
     options, arguments = p.parse_args()
 
-    if options.use_public_dir != 'yes' and options.use_public_dir != 'no':
-        print 'Invalid option --use_public_dir', options.use_public_dir
+    if (options.domain is None or options.www_dir is None) and options.interactive is not True:
         p.print_help()
         exit()
-    else:
-        use_pub = True if options.use_public_dir == 'yes' else False
 
-    # validate the given domain name
-    if not re.match("^(([a-zA-Z0-9]+([\-])?[a-zA-Z0-9]+)+(\.)?)+[a-zA-Z]{2,6}$", str(options.domain)):
-        print 'Invalid option --domain', options.domain
-        p.print_help()
-        exit()
+    if options.interactive:
+        interactive()
     else:
+        # set the options
         domain = options.domain
+        www_dir = options.www_dir
+        git_url = options.git_url
 
+        # create the vhost (from options)
+        create_vhost()
 
-    # set the options
-    www_dir = options.www_dir
-    git_url = options.git_url
-    apache_port = options.apache_port
 
-    if options.interactive:
 
-        interactive()
+# run interactive mode
+def interactive():
+    global domain, www_dir, git_url
+
+    domain = raw_input('Please enter the root domain for this vhost: ')
+    www_dir = raw_input('Please enter the www directory: ')
+    git_url = raw_input('(optional) Clone from GIT url: ')
+
+    #create the vhost
+    create_vhost()
+
+# first check the requirements, then create the vhost
+def create_vhost():
+    _check_vhost()
+    _check_apache()
+
+    print 'Creating new vhost...'
+    time.sleep(1)
 
+    return True
+
+# check the vhost requirements
+def _check_vhost():
+    if domain is None or domain == '':
+        exit('Domain not set!')
+
+    if www_dir is None or www_dir == '':
+        exit('WWW root directory not set!')
+
+    if os.path.exists(www_dir):
+        # check if the www_dir already exists, check if the
+        if os.listdir(www_dir) != "" and git_url is not None and git_url != '':
+            exit('Cannot clone git repository in a non-empty directory!')
+
+    if not str(apache_port).isdigit():
+        exit('The apache port is not valid!')
+
+    # validate the given domain name
+    if not re.match("^(([a-zA-Z0-9]+([\-])?[a-zA-Z0-9]+)+(\.)?)+[a-zA-Z]{2,6}$", str(domain)):
+        exit('Domain not valid: %s' % domain)
+
+    # check the git repo if it has been set
+    if git_url is not None and git_url != '':
+        _check_git(git_url)
+
+# check the apache requirements
+def _check_apache():
+    global apache_port
 
-    # try and create the vhost
     try:
-        vHost().create()
+        if getservbyport(apache_port) not in ['http', 'www', 'apache2']:
+            exit('Apache does not seem to be running on port %d' % apache_port)
+    except Exception:
+        exit('Error while trying to poll for apache, please check the config setting apache->port')
 
-    except BaseException as exc:
-        print 'The following error occurred: %s' % exc
+# this method checks if the given git repository is valid
+def _check_git(url):
 
-# run interactive mode
-def interactive():
-    global domain, www_dir, use_pub
+    if not _which(git_exec):
+        exit('Cannot execute local git installation on: %s' % git_exec)
+
+    try:
+        urllib2.urlopen(url)
+    except Exception as e:
+        exit('GIT repo \'%s\' could not be read' % url)
 
-    domain = input('Please enter the root domain for this vhost: ')
-    www_dir = input('Please enter the www directory: ')
-    use_pub = input('Use public dir? [y/N] ')
 
+def _which(program):
+    import os
+    def is_exe(fpath):
+        return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
+
+    fpath, fname = os.path.split(program)
+    if fpath:
+        if is_exe(program):
+            return program
+    else:
+        for path in os.environ["PATH"].split(os.pathsep):
+            path = path.strip('"')
+            exe_file = os.path.join(path, program)
+            if is_exe(exe_file):
+                return exe_file
 
+    return None
 
 if __name__ == '__main__':
     main()