root/install.py

#!/usr/bin/env python
#
# MobilEd install script
#
# This program is free software, distributed under the terms of
# the GNU General Public License Version 2.
# See the COPYING file included in this archive

import os, sys, shutil, compiler
from optparse import OptionParser

DefaultBinDir = '/usr/local/sbin'
DefaultDataDir = '/usr/share/mobiled'
DefaultEtcDir = '/etc/mobiled'
DefaultLogDir = '/var/log/mobiled'
DefaultLibDir = '/usr/lib/mobiled'
DefaultVarLibDir = '/var/lib/mobiled'

class InstallError(Exception):
    """ Simple generic installation error exception """

def doMenu(DirBin, DirData, DirEtc, DirLog, DirLib, DirVarLib):
    
    def getInput(DefaultValue=''):
        line = raw_input('>>').strip()
        if len(line) > 0:
            return line
        else:
            return DefaultValue
    
    print '\n+--------------------+\n|MobilEd installation|\n+--------------------+\n\n'

    questions = (('Directory to place main executable in [%s]:' % DirBin, DirBin),
                 ('Directory to install program data files [%s]:' % DirData, DirData),
                 ('Directory for configuration files [%s]:' % DirEtc, DirEtc),
                 ('Directory for plugin files [%s]:' % DirLib, DirLib),
                 ('Directory for log files [%s]:' % DirLog, DirLog),
                 ('Directory for dynamic application data [%s]:' % DirVarLib, DirVarLib))
    
    done = False
    while not done:
        print questions[0][0]
        _binDir = getInput(questions[0][1])
        print questions[1][0]
        _dataDir = getInput(questions[1][1])
        print questions[2][0]
        _etcDir = getInput(questions[2][1])
        print questions[3][0]
        _libDir = getInput(questions[3][1])
        print questions[4][0]
        _logDir = getInput(questions[4][1])
        print questions[5][0]
        _varLibDir = getInput(questions[4][1])

        print '\nSummary\n-------'
        print 'Install program executable to:', _binDir
        print 'Install program data files to:', _dataDir
        print 'Install configuration files to:', _etcDir
        print 'Directory to place plugins in:', _libDir
        print 'Directory to place log files in:', _logDir
        print 'Directory to use for application-generated data files:', _varLibDir
        print '\nIs this OK? (y/n) [n]'
        if getInput('n').lower() == 'y':
            done = True
        print

    return (_binDir, _dataDir, _etcDir, _libDir, _logDir, _varLibDir)

def createDirs(DirList):
    """ Makes sure all directories in <DirList> exist; creates them if they don't 
    
    Raises InstallError: if directory does not exist, and could not be created
    """
    for directory in DirList:
        try:
            os.makedirs(directory)
        except OSError, (errno, msg):
            if errno == 13:
                raise InstallError, 'You do not have permissions to create directory: '+logDir
            elif errno != 17:
                raise

def getRelPath(Target, LocalDir):
    commonPrefix = os.path.commonprefix((LocalDir, Target))
    commonRelDepth = len(commonPrefix.split('/'))-1
    relDepth = len(LocalDir.split('/'))-commonRelDepth
    return relDepth*'../'+Target[len(commonPrefix):]

def configure(DirBin, DirData, DirEtc, DirPlugins, DirLog, DirVarLib, SettingsFilename='./mobiled/settings.py', BinFilename='./bin/mobiled'):
    """ Modifies the settings.py file in the mobiled root to point to the
    specified dirs, and compiles it to bytecode.
    
    Raises InstallError: if any step could not be accomplished
    """
    #dirData = getRelPath(DirData, DirBin)
    #dirEtc = getRelPath(DirEtc, DirData)
    #dirPlugins = getRelPath(DirPlugins, DirData)
    #dirLog = getRelPath(DirLog, DirData)
       
    try:
        if not os.path.exists(SettingsFilename+'.orig'):
            shutil.copy2(SettingsFilename, SettingsFilename+'.orig')
        f = open(SettingsFilename+'.orig', 'r')
        buff = f.read()
        f.close()
    except:
        raise InstallError, 'Could not open MobilEd settings file for reading: '+SettingsFilename
    buff = buff.replace("DIR_HOME = os.path.abspath(sys.path[0])+'/cache'", "DIR_HOME = '%s'" % DirVarLib)
    buff = buff.replace("DIR_CONFIG = '/../../'.join((DIR_HOME,'etc'))", "DIR_CONFIG = '%s'" % DirEtc)
    buff = buff.replace("DIR_LOG = DIR_HOME", "DIR_LOG = '%s'" % DirLog)
    buff = buff.replace("DIR_PLUGINS = os.path.abspath(sys.path[0])", "DIR_PLUGINS = '%s'" % DirPlugins)
    try:
        f = open(SettingsFilename, 'w')
        f.write(buff)
        f.close()
    except:
        raise InstallError, 'Could not write to MobilEd settings file: '+SettingsFilename
    try:
        compiler.compileFile(SettingsFilename)
    except:
        raise InstallError, 'Could not compile MobilEd settings file: '+SettingsFilename
        
    try:
        if not os.path.exists(BinFilename+'.orig'):
            shutil.copy2(BinFilename, BinFilename+'.orig')
        f = open(BinFilename+'.orig', 'r')
        buff = f.read()
        f.close()
    except:
        raise InstallError, 'Could not open MobilEd executable file for reading: '+BinFilename
    buff = buff.replace("sys.path.insert(0, '../mobiled')", "sys.path.insert(0, '%s')" % DirData)
    try:
        f = open(BinFilename, 'w')
        f.write(buff)
        f.close()
    except:
        raise InstallError, 'Could not write to MobilEd executable file: '+BinFilename
    try:
        compiler.compileFile(BinFilename)
    except:
        raise InstallError, 'Could not compile MobilEd executable: '+BinFilename


def cpPythonFile(Src, Dest):
    for ext in ('.py', '.pyc', '.pyo'):
        try:
            shutil.copy2(Src+ext, Dest)
            print 'copying:',Src+ext
        except IOError, (errno, msg):
            if errno != 2:
                raise

def copyFiles(DirBin, DirData, DirEtc, DirLib, SrcDir='./mobiled', SrcExec='./bin/mobiled', SrcEtc='./etc'):
    # Main data files
    for filename in ('/mobiled', '/settings'):
        cpPythonFile(SrcDir+filename, DirData)
    for dataSubDir in ('/lib',):
        shutil.copytree(SrcDir+dataSubDir, DirData+dataSubDir, symlinks=True)
    
    # Configuration files
    for filename in os.listdir(SrcEtc):
        # Skip subversion data
        if filename == '.svn':
            continue
        filename = SrcEtc+'/'+filename
        if os.path.isfile(filename):
            print 'copying:',filename
            shutil.copy2(filename, DirEtc)
        else:
            print 'copying tree:',filename
            shutil.copytree(filename, DirEtc+'/'+os.path.basename(filename), symlinks=True)
    
    # Plugins
    for pluginDir in ('/channels', '/datasources', '/requestinputs'):
        print 'copying tree:',SrcDir+pluginDir
        shutil.copytree(SrcDir+pluginDir, DirLib+pluginDir, symlinks=True)
    
    # MobilEd wrapper executable file
    print 'copying:', SrcExec
    shutil.copy2(SrcExec, DirBin)
    
    #shutil.copytree('./mobiled', DirBin+'/mobiled', symlinks=True)

def doInstall(DirBin, DirData, DirEtc, DirLib, DirLog, DirVarLib, CopyPrefix=''):
    """ Wrapper 'make install'-type function """
    try:
        print 'Configuring...'
        configure(DirBin, DirData, DirEtc, DirLib, DirLog, DirVarLib)
        print 'Creating directories...'
        createDirs((CopyPrefix+DirBin, CopyPrefix+DirData, CopyPrefix+DirEtc, CopyPrefix+DirLib, CopyPrefix+DirLog, CopyPrefix+DirVarLib))
        print 'Copying files...'
        copyFiles(CopyPrefix+DirBin, CopyPrefix+DirData, CopyPrefix+DirEtc, CopyPrefix+DirLib)
    except InstallError, msg:
        print 'Error:',msg
        print 'Installation aborted.'
        sys.exit(1)
    print 'Done!'


if __name__ == '__main__':
    parser = OptionParser()
    parser.add_option('-a', action="store_true", dest='autoInstall', help='automatic install; do not ask questions')
    parser.add_option('--no-destdir-config', action='store_true', dest='noDestdirConfig', help='use DESTDIR prefix (if given) for file copying only, not for configuration (useful for packaging)')
    parser.add_option('--DESTDIR', dest='rootDir', help='specify a root directory prefix; defaults to /')
    parser.add_option('--BINDIR', dest='binDir', help='directory to place main executable program in; defaults to %s' % DefaultBinDir)
    parser.add_option('--DATADIR', dest='dataDir', help='directory to install program data files; defaults to %s' % DefaultDataDir)
    parser.add_option('--LOGDIR', dest='logDir', help='directory for log files; defaults to %s' % DefaultLogDir)
    parser.add_option('--CONFDIR', dest='etcDir', help='directory for configuration files; defaults to %s' % DefaultEtcDir)
    parser.add_option('--PLUGINDIR', dest='libDir', help='directory for plugins; defaults to %s' % DefaultLibDir)
    parser.add_option('--VARLIBDIR', dest='varLibDir', help='directory for dynamic application-generated data files; defaults to %s' % DefaultVarLibDir)
    parser.parse_args()
    
    if parser.values.rootDir == None:
        parser.values.rootDir = ''
    if parser.values.binDir == None:
        parser.values.binDir = DefaultBinDir
    if parser.values.dataDir == None:
        parser.values.dataDir = DefaultDataDir
    if parser.values.etcDir == None:
        parser.values.etcDir = DefaultEtcDir
    if parser.values.logDir == None:
        parser.values.logDir = DefaultLogDir
    if parser.values.libDir == None:
        parser.values.libDir = DefaultLibDir
    if parser.values.varLibDir == None:
        parser.values.varLibDir = DefaultVarLibDir

    if not parser.values.noDestdirConfig:
        binDir = parser.values.rootDir+parser.values.binDir
        dataDir = parser.values.rootDir+parser.values.dataDir
        etcDir = parser.values.rootDir+parser.values.etcDir
        logDir = parser.values.rootDir+parser.values.logDir
        libDir = parser.values.rootDir+parser.values.libDir
        varLibDir = parser.values.rootDir+parser.values.varLibDir
        cpPrefix = ''
    else:
        binDir = parser.values.binDir
        dataDir = parser.values.dataDir
        etcDir = parser.values.etcDir
        logDir = parser.values.logDir
        libDir = parser.values.libDir
        varLibDir = parser.values.varLibDir
        cpPrefix = parser.values.rootDir
    
    try:
        if not parser.values.autoInstall:
            binDir, dataDir, etcDir, libDir, logDir, varLibDir = doMenu(binDir, dataDir, etcDir, logDir, libDir, varLibDir)

        doInstall(binDir, dataDir, etcDir, libDir, logDir, varLibDir, cpPrefix) 
    except KeyboardInterrupt:
        print '\nUser cancelled, aborting installation...'
else:
    print 'This install script should be called directly.'
    sys.exit(1)