#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Routine to fix the data obtained by the FDS plugin, to be useful
for the standalone tool.

Version
-------
V1.0, 23 Feb 2023, dvk - First version, adding space between px size and unit.
V1.1, 09 May 2023, dvk - Write directory name with leading zeros in the event number.
                         This is needed for proper sorting.

"""
# ------------------------------------------------------------------------------------------------
# Import required libraries.
# ------------------------------------------------------------------------------------------------
import glob
import os
import shutil
import sys

# ------------------------------------------------------------------------------------------------
# Define any constants or variables.
# ------------------------------------------------------------------------------------------------
file_name_metadata = "Event_Metadata.txt"  # This should never change.


# ------------------------------------------------------------------------------------------------
# Define actual routine.
# ------------------------------------------------------------------------------------------------
def lif_fds_fix_data(date_path):
    """For one date, go through all events, open metadata file,
    check whether the pixel size unit is given with parentheses,
    replace those.

    !TODO: Rotate images by 90 deg and replace all saturated pixels
    with grey values. This will avoid the localisation tool to just
    detect the terminator (hopefully). 2023-05-09 - Or maybe not?
    I might want to mask away all saturated images in the tools
    themselves.

    Parameters
    ----------
    date_path : string
        Path to all events for one date. Typical value:
        `/Users/dkoschny/Documents/Images/LIF_detections/observations/`

    Returns
    -------
    Fixed metadata file written to output directory. For the test version,
    keep the orignal meta data file with filename *.old.

    !TODO: Rotated and corrected images.

    """
    # Read all event directory names - make sure it is independent
    # of the operating system by using os.path routines. Note that
    # this list is not sorted.
    if os.path.isdir(date_path) == False:
        print(f"The directory {date_path} was not found.")
        sys.exit(0)

    dir_list = glob.glob(os.path.join(date_path, "event_*" + os.path.sep))

    if len(dir_list) == 0:
        print(f"No event directories found in {date_path}.")
        sys.exit(0)

    print()
    print(dir_list)
    print()
    
    for directory in dir_list:
        # First handle the metadata file.
        md_name = os.path.join(directory, file_name_metadata)

        # Once I trust this code, delete the following line.
        shutil.copy(md_name, md_name + ".original")

        # Read the metadata file, find the line with the pixel size,
        # replace '(um)' with ' um'.
        with open(os.path.join(directory, file_name_metadata), "r") as file:
            lines = [line.rstrip() for line in file]

        if len(lines) > 0:
            for i, line in enumerate(lines):
                if "Pixel Size" in line:
                    new_line = line.replace("(um)", " um")
                    counter = i
            lines[counter] = new_line

            # Write file back.
            with open(md_name, "w") as file:
                for line in lines:
                    file.write(line + "\n")

    # Now rename the directories. When splitting, start from the back
    # to avoid wrong results due to underscores in the top path.
    # Note: If it already was changed, this routine doesn't modify
    # anything.
    for i, directory in enumerate(dir_list):
        event_number = int(directory.split("_")[-2])
        event_date_time = directory.split("_")[-1]
        new_dir_name = f"event_{event_number:04d}_{event_date_time}"
        
        print("Old name = ", directory)
        print("New name = ", os.path.join(date_path, new_dir_name))
        
        # Rename the directories.
        os.rename(directory, os.path.join(date_path, new_dir_name))
            
    return lines


# ================================================================================================
# Test routine.
# ================================================================================================
# date_path = "D:\\Lunar Impact Flashes\\LIF_detections\\" + \
#            "observations\\2023.01.31\\"
if len(sys.argv) > 1:
    print(sys.argv[1])
    date_path = sys.argv[1]
    try:
        os.path.exists(date_path)
    except():
        print("Path invalid - please check that you typed it correctly.")

else:
    date_path = "/Users/dkoschny/Documents/Images/LIF_detections/" + \
                "observations/2023.08.13b/"

lines = lif_fds_fix_data(date_path)
# =============================================== eof ============================================