#!/usr/bin/python
# This script cleans up log files
# Author: Don Magee
# Date: 2012-01-23
# Version: 1.0
# License: MIT http://www.opensource.org/licenses/mit-license.php
 
import os
import re
import optparse
import glob
import tarfile
import time
from datetime import date
 
def main():
    usage = "usage: %prog [options]"
    parser = optparse.OptionParser(usage)
    parser.add_option("-y", "--year", action="store", type="int", dest="filterYear", default=False, help="Enter the year.")
    parser.add_option("-m", "--month", action="store", type="int", dest="filterMonth", default=False, help="Enter the Month.")
    parser.add_option("-d", "--day", action="store", type="int", dest="filterDay", default=False, help="Enter the Day.")
    parser.add_option("-p", "--path", action="store", type="string", dest="filterPath", default=False, help="Enter the path")
    parser.add_option("-a", "--archive", action="store", type="string", dest="filterArchive", default=False, help="Enter the path to store the archive file (if using the -t or --tar option)")
    parser.add_option("-r", "--remove", action="store_true", dest="removeFiles", default=False, help="Delete original files.")
    parser.add_option("-t", "--tar", action="store_true", dest="tarFiles", default=False, help="Tar all files using bzip2 compression as a default. If --gizp or --no-compression are used then tar will be automatically used.")
    parser.add_option('-g', "--gzip", action="store_true", dest="gzipFiles", default=False, help="Use GZIP compression instead of bzip2")
    parser.add_option("-n", "--no-compression", action="store_true", dest="noCompression", default=False, help="Do not use any compression for tar.")
    parser.add_option("-l", "--list", action="store_true", dest="listFiles", default=True, help="List all files that would be affected. This is the default option.")
    options, args = parser.parse_args()
 
    if not options.filterPath:
        parser.error('You must enter a path to clean (try --path)')
    if options.gzipFiles and options.noCompression:
        parser.error('You can not use both gzip compression and no compression. Please choose one or the other.')
 
    if options.listFiles and (options.tarFiles or options.removeFiles):
        options.listFiles = False
 
    # setup compression type
    tarType = "w:bz2"
    tarExt = 'tar.bz2'
    if options.gzipFiles:
        options.tarFiles = True
        tarType = "w:gz"
        tarExt = '.tar.gz'
    if options.noCompression:
        options.tarFiles = True
        tarType = "w"
        tarExt = '.tar'
 
    archiveName = '' #Base name for archive
    today = date.today()
    day = today.day
    month = today.month
    year = today.year
    if(options.filterYear):
        year = options.filterYear
 
    if(options.filterMonth):
        month = options.filterMonth
 
    if(options.filterDay):
        day = options.filterDay
 
    filterDate = str(year) + '-' + str(month) + '-' + str(day)
 
    #create a tar file and open it with bzip2 compression
    if options.tarFiles:
        if options.filterArchive:
            archiveName = options.filterArchive
        archiveName += filterDate + '_archive' + tarExt
        archive = tarfile.open(archiveName, tarType)
 
    print '-'*50
    fileCount = 0
    for folder in glob.glob(options.filterPath):
        print 'Looking for old log files in: %s' % folder
        for logFile in glob.glob(folder + '/*.log'):
            stats = os.stat(logFile)  
            lastmodDate = time.localtime(stats[8])
            expDate = time.strptime(filterDate, '%Y-%m-%d')
            if  expDate > lastmodDate:
                if options.listFiles:
                    print 'The following files will be affected:'
                    print logFile, time.strftime("%m/%d/%y", lastmodDate)
 
                if options.tarFiles:
                    try:
                        print 'Compressing', logFile, time.strftime("(older than %m/%d/%y)", expDate)
                        fileCount += 1
                        archive.add(logFile)
                    except OSError:
                        print 'Could not compress', logfile
 
                if options.removeFiles:
                    try:
                        print 'Removing', logFile, time.strftime("(older than %m/%d/%y)", expDate)
                        os.remove(logFile)  # commented out for testing
                    except OSError:
                        print 'Could not remove', logFile
 
    if options.tarFiles:
        archive.close()
        if fileCount == 0:
            os.remove(archiveName)
 
if __name__ == "__main__":
    main()