BatchImageManager.py

#    Copyright (C) <2017>  <Akshat Singh>
#    <akshat-pg8@iiitmk.ac.in>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.


import os
import time
import errno
import shutil
import logging
import argparse
import subprocess
from datetime import datetime
from argparse import RawTextHelpFormatter


# Command line argument validation functions...
def is_valid_directory(parser, arg):
    "Function for checking specfied directory exists or not."
    if not os.path.isdir(arg):
        parser.error('The directory {} does not exist!'.format(arg))
    else:
        # File exists so return the directory
        return arg

def is_target_directory(arg):
    "Function for checking specfied directory exists or not."
    if not os.path.isdir(arg):
        print('The directory %s does not exist!, so creating it for you..' % arg)
        try:
        	subprocess.call(['mkdir', '-p', arg])
        	return arg
        except:
        	parser.error('The directory {} does not exist and unable to create for you, please create it manually!'.format(arg))
    else:
        # File exists so return the directory
        return arg

def is_valid_option(parser, arg):
    "Function for checking option is on or off."
    if not (arg == 'on' or arg == 'off'):
        parser.error('{} is not a valid input for turning option on or off! Please specify \"on\" for turning the option on and \"off\" for turning it off.'.format(arg))
    else:
        return arg
    

def is_valid_loggingStatus(parser, arg):
    "Function for checking logging status is valid or not."
    if not (arg == 'on' or arg == 'off'):
        parser.error('{} is not a valid input for turning logging on or off! Please specify \"on\" for turning logging on and \"off\" for turning logging off.'.format(arg))
    else:
        return arg

## =========> Command line arguments parsing -- starts <========= ##
parser = argparse.ArgumentParser(description='[Purpose - This script is useful in a situation where we want to run a compression only on specific camera make but not on others and later want to do some manual image processing using tools like gimp on some camera make images and also at the same time we also want to maintain the sequence of the images based on their capturing time not based on the image modification.]\n\n\n**********************************************************************\nThis script will copy the images from the specified directory and all of its sub-directory to the target directory. The target directory will be the provided on the command line argument; but the final destination will be targetDir/CameraManufacurer__CameraModel/unixTimeStamp_CameraMake.JPG\nn**********************************************************************\nBatch Image Manager is an advaced version of the Batch Image Compression utility. For running this program you need to have exif tool and imagemagick installed on your machine. This program is used for mixing the various images taken from different camera make based on their capturing time in ascending order and rename each image on thir unix timestamp.\n\nIf compression option is selected as OFF then this script wil not create any sub-directories based on camera make just it will arrange the pictures based on their capturing time. \n\n\n\t', formatter_class=RawTextHelpFormatter)
parser.add_argument('-i', '--info', help='Information about the Camera make and Model', metavar='<Camera Information>')
parser.add_argument('-s','--source_directory', help='Directory to read input files.', required=True, metavar='<Source Directory>', type=lambda x: is_valid_directory(parser, x))
parser.add_argument('-t','--target_directory', help='Directory to save output files.', required=True, metavar='<Target Directory>', type=lambda x: is_target_directory(x))
parser.add_argument('-cmp','--compression', help='Compression On/Off', required=True, metavar='<Compression on/off>', type=lambda x: is_valid_option(parser, x))
parser.add_argument('-clq','--compressionQuality', help='Quality of the Image to retain for specific Camera make [Image Quality range is 1-100].', metavar='<CameraMake_#ImageQuality Eg.: Canon100D_#90>')
parser.add_argument('-l','--log_file', help='Path of the log file.', metavar='<Log File>')
parser.add_argument('-ls', '--logging_onoff', help='Logging status On/Off', metavar='<Logging on/off>', type=lambda x: is_valid_loggingStatus(parser, x))
args = parser.parse_args()


## =========> Command line arguments parsing -- ends <========= ##

subprocess.call('clear')

## =========> Logging Configurations -- starts <========= ##
loggerFile = args.log_file
loggingStatus = args.logging_onoff

if not loggerFile:
    Log_File = '/tmp/BatchImageManager.log'
else:
    Log_File = loggerFile + ".log"

# create logger
logger = logging.getLogger('BIMamager')
logger.setLevel(logging.DEBUG)

# Turning logging on or off
if loggingStatus:
    if loggingStatus == 'off':
        logger.disabled = True
    else:
        logger.disabled = False
else:
    logger.disabled = False

# add a file handler
fileHandler = logging.FileHandler(Log_File)
fileHandler.setLevel(logging.DEBUG)

# create console handler and set level to debug
consoleHandler = logging.StreamHandler()
consoleHandler.setLevel(logging.DEBUG)

# create formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')

# add formatter to handlers
fileHandler.setFormatter(formatter)
consoleHandler.setFormatter(formatter)

# add ch to logger
logger.addHandler(fileHandler)
logger.addHandler(consoleHandler)

## =========> Logging Configurations -- ends <========= ##

info = args.info
sourceDir = args.source_directory
targetDir = args.target_directory
compression = args.compression
compQuality = args.compressionQuality
tmpFile = '/tmp/batchIMv2.txt'
devnull = open('/dev/null', 'w')

                

def timestampQuery(imageName):
    '''Function for returning the Image capturing time unix timestamp'''
    exifCmd = subprocess.Popen(['exif', '-x', imageName],stdout=subprocess.PIPE)
    grepCmd = subprocess.Popen(['grep', 'Date_and_Time__Original'], stdin=exifCmd.stdout, stdout=subprocess.PIPE)
    cutCmd1 = subprocess.Popen(['cut', '-d', '>', '-f2'], stdin=grepCmd.stdout, stdout=subprocess.PIPE)
    cutCmd2 = subprocess.Popen(['cut', '-d', '<', '-f1'], stdin=cutCmd1.stdout, stdout=subprocess.PIPE)
    cutCmd1.stdout.close()
    captureTime = cutCmd2.communicate()[0].split("\n")[0]
    #print captureTime
    formatTime = datetime.strptime(captureTime, "%Y:%m:%d %H:%M:%S")
    return int(time.mktime(formatTime.timetuple()))


def camMakeQuery(imageName):
    '''Function for returning the camera Make and Model'''
    exifCmd = subprocess.Popen(['exif', '-x', imageName],stdout=subprocess.PIPE)
    grepCmd = subprocess.Popen(['grep', 'Manufacturer'], stdin=exifCmd.stdout, stdout=subprocess.PIPE)
    cutCmd1 = subprocess.Popen(['cut', '-d', '>', '-f2'], stdin=grepCmd.stdout, stdout=subprocess.PIPE)
    cutCmd2 = subprocess.Popen(['cut', '-d', '<', '-f1'], stdin=cutCmd1.stdout, stdout=subprocess.PIPE)
    cutCmd1.stdout.close()
    camManufacturer = cutCmd2.communicate()[0].split("\n")[0]
    exifCmdModel = subprocess.Popen(['exif', '-x', imageName],stdout=subprocess.PIPE)
    grepCmdModel = subprocess.Popen(['grep', 'Model'], stdin=exifCmdModel.stdout, stdout=subprocess.PIPE)
    cutCmd1Model = subprocess.Popen(['cut', '-d', '>', '-f2'], stdin=grepCmdModel.stdout, stdout=subprocess.PIPE)
    cutCmd2Model = subprocess.Popen(['cut', '-d', '<', '-f1'], stdin=cutCmd1Model.stdout, stdout=subprocess.PIPE)
    cutCmd1Model.stdout.close()
    camModel = cutCmd2Model.communicate()[0].split("\n")[0]
    camDir = camManufacturer + "__" + camModel
    return camDir



def copyAllImages(srcDir):
    '''Function for copying all the files from the source directory and sub-directories to target directory.'''
    for dirnames, subdirnames, filenames in os.walk(srcDir):
        # Copy all files.
        for filename in filenames:
            imageName = os.path.join(dirnames, filename)
            #print imageName
            unixTimeStamp = timestampQuery(imageName)
            camera = camMakeQuery(imageName)
            imgDestination = targetDir + "/" + camera
            ## Create destination directory if not present
            try:
                os.makedirs(imgDestination)
            except OSError as e:
                if e.errno != errno.EEXIST:
                    raise
            ## Start copying and renaming
            finalImage = imgDestination + "/" + str(unixTimeStamp) + "_" + camera + ".JPG"
            logger.info("Copying and Renaming Image : %s to %s" % (imageName, finalImage))
            shutil.copy2(imageName, finalImage)

            

imputCompString = "\n================================================================================================================\nPlease enter which directory images needs to be compressed and the quality level in the following format:\n\n\t\t\t\t*********************************\n\t\t\t\t  <DirectoyName_#qQualityLevel>\n\t\t\t\t*********************************\nEg.: Canon__Canon EOS 100D_#q90\n\nIn case you want to run compression on multiple directories please enter in csv format\nEg.: Canon__Canon EOS 100D_#q90, SAMSUNG__GT-I9100_q81\n\n================================================================================================================\n\nEnter your input: "


def validateUserCompressionInput():
    '''Function for validating user input for compressing images inside specific directories.'''
    while True:
        try:
            compInput = raw_input(imputCompString)
            if not compInput:
                raise ValueError("There wasn't any input!")
            else:
                print "You have entered: ", compInput
                break
        except ValueError as e:
            print(e)

    

def main():
    ## Start execution of the main program
    if compression == 'off':
        copyAllImages(sourceDir)
    else:
        copyAllImages(sourceDir)
        validateUserCompressionInput()
        
    

# Executing the script. 
if __name__ == "__main__":
    main()