source: TI01-discovery/branches/ingestAutomation-upgrade/OAIBatch/FileUtilities.py @ 3912

import os, sys, logging
from os import makedirs
from os.path import normpath,dirname,exists,abspath

class FileUtilities:
    '''
        Various helper methods for setting up and cleaning filesystems 
    C Byrom Apr 08
    '''
    def __init__(self):
        '''
        Constructor
        '''

    def createFile(self, fileName, content):
        '''
        Create a file with the specified name and content
        @param fileName: name of file to create
        @param content: content of file to create  
        '''
        try:
            f = open(fileName,'w')
            f.write(content)
            f.close()
        except:
            raise SystemError, "ERROR: Problem encountered when creating file, %s" %fileName


    def makepath(self, path):
        ''' creates missing directories for the given path and
            returns a normalized absolute version of the path.
    
        - if the given path already exists in the filesystem
          the filesystem is not modified.
    
        - otherwise makepath creates directories along the given path
          using the dirname() of the path. You may append
          a '/' to the path if you want it to be a directory path.
    
        from holger@trillke.net 2002/03/18
        '''
        logging.info("Creating dir: " + path) 
        dpath = normpath(dirname(path))
        if not exists(dpath):
            makedirs(dpath)
        status = normpath(abspath(path))
        
        if status == 0:
            logging.info("Directory created successfully")
        return status

    
    def setUpDir(self, dir):
        '''
        Clean out specified directory - or create this, if it doesn't already exist
        @param dir: directory to set up/clean
        '''
        logging.info("Setting up directory, " + dir)
        if os.path.isdir(dir):
            self.cleanDir(dir)
        else:
            try:
                self.makepath(dir)
            except:
                sys.exit("Failed at setting up directory, %s" %dir)

        logging.info("Directory set up successfully")

    def cleanDir(self, dir):
        '''
        Remove all files from the specified directory
        @param dir: directory to clean 
        '''
        logging.info("Cleaning dir " + dir)
        commandline = "find " + dir + "  -type f -print | xargs -i rm \{\}"
        logging.debug("Executing : " + commandline)

        status = os.system(commandline)
        if status != 0:
            sys.exit("Failed at cleaning out directory, %s" %dir)
        
        logging.info("Directory cleaned successfully")

        
    def makeBackUp(self, original_dir, backup_dir):
        '''
        Copy contents of original dir into backup dir
        @param original_dir: dir to backup
        @param backup_dir: dir to backup to  
        '''
        logging.info("Creating backup directory (" + original_dir + \
                                " --> " + backup_dir + ")")
        self.makepath(backup_dir)
    
        commandline = "find " + original_dir + " -type f -print | xargs -i cp \{\} " + backup_dir
        logging.info("Executing : " + commandline)
        status = os.system(commandline)
        if status !=0:
            sys.exit("Failed at copying to backup directory %s" %backup_dir)
            
        logging.info("Backup completed successfully")