deadbok/ssg

'''
Assorted tools used in multiply places.

:since: 27/04/2014
:author: oblivion
'''
import os
from fnmatch import fnmatch
from datetime import datetime
from ssg.log import logger
from ssg.settings import SETTINGS


def get_files(path, extension):
    '''Get a list of files with extension from path an subdirectories.

    :param path: Path to look for files
    :type path: string
    :param extension: extension to look for
    :type extension: string
    '''
    filelist = list()

    logger.debug('Looking in "' + path + '" for files with extension "'
                 + extension + '"')
    for entry in os.listdir(path):
        # Ignore . and ..
        if not (entry.find('.') == 0):
            filename = path + "/" + entry
            # Process subdirectories
            if os.path.isdir(filename):
                filelist.extend(get_files(filename, extension))
            else:
                if fnmatch(filename, '*' + extension):
                    logger.debug("Found: " + filename)
                    filelist.append(filename)
    return(filelist)


def get_dirs(root_dir):
    '''
    Get a list of all directories and subdirectories of these, from a given
    path.

    :type root_dir: str
    :param root_dir: Root directory to start searching from.
    :return: List of all directories.
    :rtype: list
    '''
    dirs = list()
    # Run through all entried in the root dir
    logger.debug('Getting directories at: ' + root_dir)
    for entry in os.listdir(root_dir):
        # If not . or ..
        if not ((entry.find(".") == 0)):
            filename = os.path.join(root_dir, entry)
            # Is it a directory
            if os.path.isdir(filename):
                logger.debug("Adding: " + filename)
                dirs.append(filename)
                dirs.extend(get_dirs(filename))
    return(dirs)


def get_datetime(datetime_str):
    '''Get datetime object from a date, time string, formatted according to the
    DATEFORMAT configuration variable.

    :param datatime_str: String containing date and time.
    :type datatime_str: string
    '''
    logger.debug('Generating datetime object from: ' + datetime_str)
    try:
        ret = datetime.strptime(datetime_str, SETTINGS['DATEFORMAT'])
    except ValueError as exception:
        logger.error('Metadata syntax error:')
        logger.error('Cannot convert date: ' + datetime_str);
        raise exception
    
    logger.debug('datetime object: ' + str(ret))
    return(ret)


def die():
    '''Kill it. Kill it with fire!'''
    logger.error('Dying...')
    exit(1)