photos_organizer.py

import errno
import hashlib
import os
import shutil
import time

"""
Script will:
1 - Open a directory - Path provided by user.
2 - Get a hash list of all files with the allowed extension
3 - Make comparison about files ( use extension hash as parameter to see if is applicable to do a comparison)
4 - If there is duplicate file move to duplicate folder - "01 - Duplicated"
5 - Create a folder for each group of dates - Files will be organized by folders containing the date of their creation,
date and a group per month and year

"""

# get the path of py file - photos organizer
curDir = os.getcwd()  # used for debugging purposes

# variable - name folder to be created with duplicated files
Folder1 = "01 - Duplicated"

# allowed extensions that will be verified
ALLOWED_EXTENSIONS = ['.png', '.jpg', '.jpeg', '.gif']  # to define what type of file will be organized


# verify if the file extension belongs to the allowed extensions
def check_file_extension(file):
    for file_extension in ALLOWED_EXTENSIONS:
        if file.endswith(file_extension):
            return True


# function to return the month based on the number
def return_month(montharg):
    switcher = {
        1: "01_JAN",
        2: "02_FEB",
        3: "03_MAR",
        4: "04_APR",
        5: "05_MAI",
        6: "06_JUN",
        7: "07_JUL",
        8: "08_AUG",
        9: "09_SEP",
        10: "10_OCT",
        11: "11_NOV",
        12: "12_DEC",

    }
    return switcher.get(montharg, "None")


# create folders
# dir is not keyword
def makemydir(filedir, foldername):
    ckdir = os.path.join(filedir, foldername)
    try:
        os.makedirs(ckdir, exist_ok=True)
    except OSError as exception:
        if exception.errno != errno.EEXIST:
            raise


# move files to specific folder, based on the date file was created
def move_files(filesdir, listofdates):
    for item in listofdates:
        makemydir(filesdir, item)  # create folders
        itemdate = item.split()
        getyearfolder = itemdate[0]
        getmonthfolder = itemdate[1]

        for file in os.listdir(filesdir):
            a = os.stat(os.path.join(filesdir, file))
            checkfile = False  # variable to assure it is not a folder, dir, etc
            checkfile = os.path.isfile(os.path.join(filesdir, file))  # check if is a file, and do not count folders, etcs.

            # verify file extension
            ck_file_extension = False
            ck_file_extension = check_file_extension(file)

            if ck_file_extension and checkfile == True:
                datefile = time.localtime(a.st_mtime)
                # print(datefile)
                getmonthfile = datefile.tm_mon
                getmonthfile = return_month(getmonthfile)
                getmonthfile = str(getmonthfile)  # convert to string
                getyearfile = datefile.tm_year
                getyearfile = str(getyearfile)  # convert to string

                if (getyearfolder == getyearfile):

                    if (getmonthfolder == getmonthfile):
                        shutil.move(os.path.join(filesdir,file), os.path.join(filesdir,item))  # move files if their year and month of creation is compatible with the folder


# get info about files.
def get_infodir(filedir):
    file_list = set()
    for file in os.listdir(filedir):
        a = os.stat(os.path.join(filedir, file))
        checkfile = False
        checkfile = os.path.isfile(os.path.join(filedir, file))  # check if is a file, and do not count folders, etcs.

        # verify file extension
        ck_file_extension = False
        ck_file_extension = check_file_extension(file)

        if ck_file_extension and checkfile == True:
            datefile = time.localtime(a.st_mtime)
            getmonth = datefile.tm_mon
            getmonth = return_month(getmonth)
            getyear = datefile.tm_year
            getmonth = str(getmonth)
            getyear = str(getyear)
            dateinfo = getyear + " " + getmonth
            file_list.add(dateinfo)

    file_list = sorted(file_list)
    # get an unique entry for each date

    return file_list


# calculate hash for each file
def hashfile(path, blocksize=65536):
    afile = open(path, 'rb')
    hasher = hashlib.md5()
    buf = afile.read(blocksize)
    while len(buf) > 0:
        hasher.update(buf)
        buf = afile.read(blocksize)
    afile.close()
    return hasher.hexdigest()


# function to create a list with hash of duplicate files
# create folder - duplicate files
# and move the duplicated files to that folder, based on hash and counter of hashes.

def gethashfileslist(filedir):
    dup_hash = {}
    for file in os.listdir(filedir):
        # a = os.stat(os.path.join(filedir,file))#join the dir and filename
        pathfile = os.path.join(filedir, file)  # join the dir and filename
        checkfile = False
        checkfile = os.path.isfile(os.path.join(filedir, file))  # check if is a file, and do not count folders, etcs

        # verify file extension
        ck_file_extension = False
        ck_file_extension = check_file_extension(file)

        if ck_file_extension and checkfile == True:
            hashcalc = hashfile(pathfile)
            counter = 1
            # create dict with hash of files and number of same hashes
            if hashcalc not in dup_hash:
                dup_hash[hashcalc] = counter
            else:
                counter = dup_hash[hashcalc]
                counter = counter + 1
                dup_hash[hashcalc] = counter

    # create folder for duplicated files
    makemydir(filedir, Folder1)

    for file in os.listdir(filedir):
        # a = os.stat(os.path.join(filedir,file))#join the dir and filename
        pathfile = os.path.join(filedir, file)  # join the dir and filename
        pathfolder1 = os.path.join(filedir, Folder1)  # join the dir and filename - dir of duplicated files
        checkfile = False
        checkfile = os.path.isfile(os.path.join(filedir, file))  # check if is a file, and do not count folders, etcs

        # verify file extension
        ck_file_extension = False
        ck_file_extension = check_file_extension(file)

        if ck_file_extension and checkfile == True:
            hashcalc = hashfile(pathfile)
            hashcounter = 0
            hashcounter = dup_hash[hashcalc]

            if hashcounter > 1:
                #os.path.join(filesdir,file)
                path = os.path.join(file,pathfolder1)
                print(pathfolder1)
                shutil.move(pathfile, pathfolder1)
                dup_hash[hashcalc] = hashcounter - 1


# function to get path to dir that contains photos/image file
def get_files_dir():
    print("#-------------------------------------------------- \n"
          "Script to organize pictures \n"
          "1 - Provide a path to the directory that contains pictures to be organized \n"
          "2 - Files will be organized by folders containing the date of their creation,"
          "and duplicated files will be moved to -> "
          "01 - Duplicated - folder that will be created.\n"
          "3 - Important!Create a backup of yours file before run the script! \n"

          "#-------------------------------------------------- \n")

    print("Type: quit, to stop execution anytime!")

    while True:

        files_dir = str(input("Provide a valid file path for pictures to be organize: "))

        if os.path.isdir(files_dir):
            return files_dir
        elif files_dir == "quit":
            print("Quit!")
            break
        else:
            print("Path provided is not valid!")


def main():
    folder_dir = get_files_dir()
    gethashfileslist(folder_dir)
    print("--------------------Starting getting files info--------------------")
    call_file_list = get_infodir(folder_dir)  # getting info regarding files
    print("-------------------- Moving files --------------------")
    move_files(folder_dir, call_file_list)
    print(" Finished !")


if __name__ == '__main__':
    print(curDir)
    main()