common_functions.py

# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above
# copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

import re
import os

import defines
import pygame
import debug_functions

flags_dict = {}
tags_dict = {}


def return_ordinal_number(number: str) -> str:
    # Converts a number to its ordinal form
    ordinal_dict = {'1': "st", '2': "nd", '3': "rd"}
    if number == "11" or number == "12" or number == "13":
        return number + "th"
    if number[-1] in ordinal_dict.keys():
        return number + ordinal_dict[number[-1]]
    return number + "th"


def break_up_large_numbers(number: str) -> str:
    number = str(number)
    # Adds a comma every three digits
    new_text = ""
    for i in range(len(number)):
        new_text += number[i]
        if (len(number) - (i + 1)) % 3 == 0 and i != len(number) - 1:
            new_text += ","
    return new_text


def is_created_nation(tag: str) -> bool:
    # Returns True if the tag is dynamically generated (client state (K), colonial nation (C),
    # trade city (T), federation (F), or custom nation (D)). False if it is anything else.
    if re.fullmatch(r"([CDFKT])\d\d", tag) is not None:
        return True
    return False


def get_full_country_name(tag: str) -> str:
    global tags_dict
    # Takes a three-character tag and returns the full name
    # Case-insensitive
    # KER (Zia) has an incorrect number of spaces in its filename which is why I have to use .split('-')
    name = None
    try:
        if len(tags_dict) == 0:
            tags_countries_file = open(defines.PATH_TO_COUNTRIES_FILE, 'r')
            tc_lines = tags_countries_file.readlines()
            tags_countries_file.close()
            for line in tc_lines:
                if line[0] != '#' and line[0] != '\n':
                    try:
                        new_line = line.strip().split(" = ")[-1]
                        new_line = new_line.replace("\"", '')
                        new_line = new_line.split('/')[1]
                        new_line = new_line.split('.')[0]
                        tags_dict[line[:3]] = new_line
                    except:
                        continue
            name = tags_dict[tag]
        else:
            if tag in tags_dict.keys():
                name = tags_dict[tag]
        if name is None:  # Fallback
            debug_functions.debug_out(
                f"Unable to find full country name for tag {tag} in [{defines.PATH_TO_COUNTRIES_FILE}]. Using fallback source.",
                event_type="WARN")
            for files in os.walk(defines.PATH_TO_BACKUP_COUNTRIES_FOLDER):
                for filename in files[-1]:
                    if filename[:3] == tag.upper():
                        name = filename[:-4].split('-')[1]
                        if name[0] == ' ':
                            return name[1:]
                        if name.lower() in defines.ALT_NAMES:
                            return defines.ALT_NAMES[name.lower()]
                        return name
        else:
            if name.lower() in defines.ALT_NAMES:
                return defines.ALT_NAMES[name.lower()]
            return name
    except:
        debug_functions.debug_out(f"Unable to find full country name at all for tag {tag}.", event_type="WARN")
        return tag
    return tag


def get_all_country_names(countries_folder=defines.PATH_TO_COUNTRIES_FILE[:-16]) -> list:
    all_countries = []
    for file in os.listdir(countries_folder):
        if os.path.isfile(countries_folder + file):
            try:
                tags_countries_file = open(countries_folder + file, 'r')
                debug_functions.debug_out(countries_folder + file)
                tc_lines = tags_countries_file.readlines()
                tags_countries_file.close()
                for line in tc_lines:
                    if line[0] != '#' and line[0] != '\n':
                        try:
                            new_line = line.strip().split(" = ")[-1]
                            new_line = new_line.replace("\"", '')
                            new_line = new_line.split('/')[1]
                            new_line = new_line.split('.')[0]
                            if new_line.lower() in defines.ALT_NAMES:
                                new_line = defines.ALT_NAMES[new_line.lower()]
                            all_countries.append((line[:3], new_line))
                        except:
                            pass
            except:
                continue

    if len(all_countries) == 0:  # Fallback
        debug_functions.debug_out(
            f"Unable to compile countries names dict from [{countries_folder}]. Using fallback source.",
            event_type="WARN")
        for files in os.walk(defines.PATH_TO_BACKUP_COUNTRIES_FOLDER):
            for filename in files[-1]:
                if filename[:3] == filename[
                                   :3].upper():  # Only filenames starting with three uppercase letters (or numbers)
                    tag = filename[:3]
                    name = filename[:-4].split('-')[1]
                    if name[0] == ' ':
                        name = name[1:]
                    if name.lower() in defines.ALT_NAMES:
                        name = defines.ALT_NAMES[name.lower()]
                    all_countries.append((tag, name))
    return all_countries


def date_conversion(date: str) -> str:
    # Takes a normally-formatted date string and turns it into
    # DD Month YYYY
    if date == "annexed" or date == "unknown":
        return date
    month_list = ["January", "February", "March", "April", "May", "June", "July", "August",
                  "September", "October", "November", "December"]
    date = date.split('.')
    year = date[0]
    month = month_list[int(date[1]) - 1]
    day = date[2]
    return day + " " + month + " " + year


def lookup_outcome(code) -> str:
    # Returns a description of the war's outcome when given the outcome code
    # OUTCOMES:
    # 1 - draw
    # 2 - victory for attackers
    # 3 - victory for defenders
    if code is not None:
        outcome_list = ["White Peace", "Attacker Won", "Defender Won"]
        return outcome_list[int(code) - 1]
    return "Outcome Unknown"


def date_to_days(date: str) -> int:
    if type(date) == type(None):
        return 0
    elif date == "annexed" or date == "unknown":
        return 0
    # Takes in a date (string) formatted like XXXX.XX.XX and converts it to an integer representing the number of
    # days since January 1, AD 1
    try:
        months = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31,
                  30]  # January-November, don't need to add December because it's the last month
        date = date.split('.')
        year, month, day = int(date[0]), int(date[1]), int(date[2])
        return (year - 1) * 365 + sum(months[:month]) + day - 1
    except:
        return 0


def load_flag(tag: str, war):
    global flags_dict
    flag_tag = None
    if tag in flags_dict.keys():
        flag = pygame.image.load(flags_dict[tag])
    else:
        flag_tag = war.participants[tag].flag_tag
        if flag_tag is not None and flag_tag in flags_dict.keys():
            flag = pygame.image.load(flags_dict[flag_tag])
        else:
            try:
                flag = pygame.image.load(war.participants[tag].flag_path)
            except:
                if is_created_nation(tag):
                    flag = pygame.image.load(defines.PATH_TO_BACKUP_FLAG)
                    pygame.draw.rect(flag, war.participants[tag].country_color, (0, 0, flag.get_width(), flag.get_height()))
                else:
                    flag = pygame.image.load(defines.PATH_TO_BACKUP_FLAG)
                    debug_functions.debug_out(f"Failed to open flag for tag {tag}", event_type="WARN")
    if flag_tag is not None:
        colors = war.participants[tag].country_color
        pygame.draw.rect(flag, colors, (int(flag.get_width() / 2), 0, int(flag.get_width() / 2), flag.get_height()))
    return flag


def load_modded_flags(mod_folder) -> None:
    global flags_dict
    flag_directory = f"{mod_folder}/gfx/flags"
    for files in os.walk(flag_directory):
        for filename in files[-1]:
            flags_dict[filename[:3]] = flag_directory + f"/{filename}"