ADDED: logging, logo, rlc l00 and l03

Author: AleixMT

requirements.txt

@@ -1,5 +1,6 @@
-pypdf
+PyPDF2
 pandas
 openpyxl
-
-Office365-REST-Python-Client
+PyCryptodome
+Office365-REST-Python-Client
+pyfiglet

src/NAF.py

@@ -3,6 +3,7 @@
 import pandas as pd
 
 from defines import NAF_DATA_PATH
+from custom_except import ArgumentNafInvalid, ArgumentNafNotPresent
 
 
 class NAF:
@@ -46,15 +47,20 @@ def is_naf_correct(naf):
     return True
 
 
-def validate_naf(value, valid_nafs):
+def validate_parse_naf(value, valid_nafs):
     if not is_naf_correct(value):
-        raise ValueError("Naf " + value + " is not valid.")
+        raise ArgumentNafInvalid("Naf " + value + " is not valid.")
     elif NAF(value) not in valid_nafs:
-        raise ValueError("NAF value " + value + " is not in our NAF database (input/NAF_DNI.xlsx)")
+        raise ArgumentNafNotPresent("NAF value " + value + " is not in our NAF database (input/NAF_DNI.xlsx)")
     else:
         return NAF(value)
 
 
+def clean_naf(naf):
+    "Removes symbols that are not numbers in a SS number"
+    return naf.replace("/", "").replace("-", "")
+
+
 def build_naf_to_dni(path):
     # Read the Excel file, skipping the first 3 rows
     df = pd.read_excel(path, skiprows=3, header=None)

src/arguments.py

@@ -1,9 +1,11 @@
 import argparse
 import datetime
+import sys
 from functools import partial
 
-from NAF import NAF_TO_DNI, validate_naf
+from NAF import NAF_TO_DNI, validate_parse_naf
 from custom_except import *
+from defines import NAF_DATA_PATH
 
 
 def parse_date(value, formatting="%Y_%m"):
@@ -25,9 +27,9 @@ def parse_author(author):
 
 def parse_naf(value):
     try:
-        return validate_naf(value, NAF_TO_DNI.keys())
+        return validate_parse_naf(value, NAF_TO_DNI.keys())
     except ValueError as e:
-        raise ArgumentNafError("NAF is not valid" + e.__str__())
+        raise ArgumentNafNotPresent("NAF is not valid" + e.__str__())
 
 
 def parse_arguments(valid_nafs):
@@ -43,3 +45,36 @@ def parse_arguments(valid_nafs):
     args = parser.parse_args()
 
     return args
+
+
+def process_arguments():
+    common = ("Error parsing arguments. Program aborting. The arguments are: "
+              + str(sys.argv) + "The program is in a uninitialized state and cannot proceed. This error will be "
+                                "notified to the admin via log file. We can't create log file in user author folder "
+                                "because user author could not be parsed.")
+    try:
+        args = parse_arguments(NAF_TO_DNI.keys())
+
+    except ArgumentNafNotPresent as e:
+        print("The NAF provided is valid but is not present in " + NAF_DATA_PATH + ". Internal error is " + e.__str__())
+        print(common)
+        exit(1)
+    except ArgumentNafInvalid as e:
+        print("The NAF provided is invalid. Internal error is " + e.__str__())
+        print(common)
+        exit(2)
+    except ArgumentDateError as e:
+        print("The dates provided are invalid. Internal error is " + e.__str__())
+        print(common)
+        exit(3)
+    except ArgumentAuthorError as e:
+        print("The author is not present in the accepted user list. Internal error is " + e.__str__())
+        print(common)
+        exit(4)
+    except argparse.ArgumentTypeError as e:
+        print("Arguments could not have been parsed. Internal error is " + e.__str__())
+        print(common)
+        exit(5)
+    return args
+
+

src/custom_except.py

@@ -3,9 +3,13 @@ class ArgumentDateError(Exception):
     pass
 
 
-class ArgumentNafError(Exception):
+class ArgumentNafNotPresent(Exception):
     pass
 
 
 class ArgumentAuthorError(Exception):
     pass
+
+
+class ArgumentNafInvalid(Exception):
+    pass

src/defines.py

@@ -11,7 +11,8 @@
 INPUT_FOLDER = os.path.join(ROOT_FOLDER, "input")
 
 # Admin logs
-ADMIN_LOG_FOLDER = os.path.join(GENERAL_OUTPUT_FOLDER, "_logs")
+ADMIN_LOG_FOLDER = os.path.join(GENERAL_OUTPUT_FOLDER, "_admin_logs")
+SUPERVISOR_LOG_FOLDER = os.path.join(GENERAL_OUTPUT_FOLDER, "_supervisor_logs")
 
 # Obtain absolute paths for each input directory
 SALARIES_FOLDER = os.path.join(INPUT_FOLDER, "_salaries")

src/filesystem.py

@@ -1,4 +1,17 @@
 import os
+from datetime import datetime
+
+from NAF import NAF_TO_NAME
+from defines import GENERAL_OUTPUT_FOLDER, ADMIN_LOG_FOLDER, SUPERVISOR_LOG_FOLDER, SALARIES_OUTPUT_NAME, \
+    PROOFS_OUTPUT_NAME, CONTRACTS_OUTPUT_NAME, RNTS_OUTPUT_NAME, RLCS_OUTPUT_NAME
+
+
+def ensure_output_gitignore():
+    # Ensure existence of .gitignore
+    gitignore_path = os.path.join(GENERAL_OUTPUT_FOLDER, '.gitignore')
+    gitignore_content = "*\n!.gitignore\n"
+    with open(gitignore_path, 'w+') as f:
+        f.write(gitignore_content)
 
 
 def list_dir(input_folder):
@@ -11,3 +24,46 @@ def list_dir(input_folder):
     file_names = [os.path.basename(file) for file in os.listdir(input_folder)]
 
     return file_names
+
+
+def compute_paths(args):
+    NOW = datetime.now().strftime("%Y-%m-%d_%H:%M:%S")
+
+    id_str = (NOW + "_" + args.author + "_" + args.naf.__str__() + "_" + NAF_TO_NAME[args.naf] + "_" +
+              args.begin.strftime("%Y-%m") + "-" + args.end.strftime("%Y-%m") + ".log.txt")
+    # Admin logs
+    ADMIN_LOG_PATH = os.path.join(ADMIN_LOG_FOLDER, id_str)
+    SUPERVISOR_LOG_PATH = os.path.join(SUPERVISOR_LOG_FOLDER, id_str)
+
+    # Home folder of the user
+    CURRENT_USER_FOLDER: str = os.path.join(GENERAL_OUTPUT_FOLDER, args.author)
+
+    # Folder for the current justification
+    justification_name = (NOW + " " + str(args.naf) + " " + NAF_TO_NAME[args.naf] + " from " +
+                          str(args.begin.strftime("%Y-%m")) + " to " +
+                          str(args.end.strftime("%Y-%m")))
+    CURRENT_JUSTIFICATION_FOLDER = os.path.join(CURRENT_USER_FOLDER, justification_name)
+
+    USER_REPORT_FILE = os.path.join(CURRENT_JUSTIFICATION_FOLDER, NOW + "_" +
+                                    args.naf.__str__()
+                                    + "_" + NAF_TO_NAME[args.naf] + "_" +
+                                    args.begin.strftime("%Y-%m") + "-" + args.end.strftime("%Y-%m") + ".log.txt")
+    return CURRENT_USER_FOLDER, CURRENT_JUSTIFICATION_FOLDER, USER_REPORT_FILE, ADMIN_LOG_PATH, SUPERVISOR_LOG_PATH
+
+
+def ensure_file_structure(CURRENT_USER_FOLDER, CURRENT_JUSTIFICATION_FOLDER):
+    os.makedirs(GENERAL_OUTPUT_FOLDER, exist_ok=True)
+    ensure_output_gitignore()
+
+    os.makedirs(ADMIN_LOG_FOLDER, exist_ok=True)
+    os.makedirs(SUPERVISOR_LOG_FOLDER, exist_ok=True)
+    os.makedirs(CURRENT_USER_FOLDER, exist_ok=True)
+
+    os.makedirs(CURRENT_JUSTIFICATION_FOLDER, exist_ok=True)
+
+    os.makedirs(os.path.join(CURRENT_JUSTIFICATION_FOLDER, SALARIES_OUTPUT_NAME), exist_ok=True)
+    os.makedirs(os.path.join(CURRENT_JUSTIFICATION_FOLDER, PROOFS_OUTPUT_NAME), exist_ok=True)
+    os.makedirs(os.path.join(CURRENT_JUSTIFICATION_FOLDER, CONTRACTS_OUTPUT_NAME), exist_ok=True)
+    os.makedirs(os.path.join(CURRENT_JUSTIFICATION_FOLDER, RNTS_OUTPUT_NAME), exist_ok=True)
+    os.makedirs(os.path.join(CURRENT_JUSTIFICATION_FOLDER, RLCS_OUTPUT_NAME), exist_ok=True)
+

src/logger.py

@@ -1,6 +1,7 @@
 import logging
 import os
 import sys
+from contextlib import contextmanager
 
 # ANSI escape codes for colors
 COLOR_CODES = {
@@ -20,19 +21,16 @@ def format(self, record):
         return f"{color}{message}{RESET_CODE}"
 
 
-def get_logger(user_report_file, admin_log_file, name="justicier", debug_mode=False):
-    os.makedirs(os.path.dirname(user_report_file), exist_ok=True)
-    os.makedirs(os.path.dirname(admin_log_file), exist_ok=True)
-
+def get_logger(user_report_file, admin_log_file, supervisor_log_file, name="justicier", debug_mode=False):
     logger = logging.getLogger(name)
     logger.setLevel(logging.DEBUG)
 
     if logger.handlers:
         return logger  # Prevent re-adding handlers
 
     # Formatters
-    plain_formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
-    color_formatter = ColorFormatter('%(asctime)s - %(levelname)s - %(message)s')
+    plain_formatter = logging.Formatter('%(asctime)s - %(process_name)s - %(levelname)s - %(message)s')
+    color_formatter = ColorFormatter('%(asctime)s - %(process_name)s - %(levelname)s - %(message)s')
 
     # User log (INFO+)
     user_handler = logging.FileHandler(user_report_file)
@@ -49,7 +47,57 @@ def get_logger(user_report_file, admin_log_file, name="justicier", debug_mode=Fa
     console_handler.setLevel(logging.DEBUG if debug_mode else logging.WARNING)
     console_handler.setFormatter(color_formatter)
 
-    for handler in [user_handler, admin_handler, console_handler]:
+    # Supervisor log
+    supervisor_handler = logging.FileHandler(supervisor_log_file)
+    supervisor_handler.setLevel(logging.INFO)
+    supervisor_handler.setFormatter(color_formatter)
+
+    for handler in [user_handler, admin_handler, console_handler, supervisor_handler]:
         logger.addHandler(handler)
 
     return logger
+
+
+def get_raw_logger(user_report_file, admin_log_file, supervisor_log_file, name="raw", debug_mode=False):
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+
+    if logger.handlers:
+        return logger  # Prevent re-adding handlers
+
+    # User log (INFO+)
+    user_handler = logging.FileHandler(user_report_file)
+    user_handler.setLevel(logging.INFO)
+    user_handler.setFormatter(None)
+
+    # Admin/system log (DEBUG+ if debug_mode, else ERROR+)
+    admin_handler = logging.FileHandler(admin_log_file)
+    admin_handler.setLevel(logging.DEBUG if debug_mode else logging.ERROR)
+    admin_handler.setFormatter(None)
+
+    # Console log (DEBUG+ if debug_mode, else WARNING+), with colors
+    console_handler = logging.StreamHandler(sys.stdout)
+    console_handler.setLevel(logging.DEBUG if debug_mode else logging.WARNING)
+    console_handler.setFormatter(None)
+
+    # Supervisor log
+    supervisor_handler = logging.FileHandler(supervisor_log_file)
+    supervisor_handler.setLevel(logging.INFO)
+    supervisor_handler.setFormatter(None)
+
+    for handler in [user_handler, admin_handler, console_handler, supervisor_handler]:
+        logger.addHandler(handler)
+
+    return logger
+
+
+def get_process_logger(base_logger, process_name):
+    return logging.LoggerAdapter(base_logger, {'process_name': process_name})
+
+
+def unformatted_logger(logger):
+    for h in logger.handlers:
+        h.setFormatter(None)
+    return logger
+
+