#!/usr/bin/env python
"""
This is a self-generating script that contains all of the iso3166-1 data.

To regenerate, a CSV file must be created that contains the latest data. Here's
how to do that:

1. Visit https://www.iso.org/obp
2. Click the "Country Codes" radio option and click the search button
3. Change the results per page to 300
4. Copy the html table and paste into Libreoffice Calc / Excel
5. Delete the French short name column
6. Delete the heading row.
7. Save as a CSV file in django_countries/iso3166-1.csv
8. Run this script from the command line
"""
import glob
import os
from typing import TYPE_CHECKING, Dict
from xml.dom.minidom import parse

from django_countries.base import CountriesBase

if TYPE_CHECKING:
    from django_stubs_ext import StrPromise

try:
    from django.utils.translation import gettext_lazy as _
except ImportError:  # pragma: no cover
    # Allows this module to be executed without Django installed.
    def _(message: str) -> "StrPromise":
        return message  # type: ignore

ISO_XML_PATH = '/usr/share/xml/iso-codes/iso_3166.xml'

try:
    from django.conf import settings
except ImportError:
    # Django is not installed, so keep the default path.
    pass
else:
    if hasattr(settings, 'COUNTRIES_ISO_XML'):
        ISO_XML_PATH = settings.COUNTRIES_ISO_XML

# If the ISO-3166 XML file is available, use it to generate a list of country
# codes and names.
if os.path.isfile(ISO_XML_PATH):
    COUNTRIES = {}
    ALT_CODES = {}
    entries = parse(ISO_XML_PATH).getElementsByTagName('iso_3166_entry')
    for node in sorted(entries, key=lambda node: node.getAttribute('name')):
        # Get all required attributes
        alpha_2_code = node.getAttribute('alpha_2_code')
        alpha_3_code = node.getAttribute('alpha_3_code')
        name = node.getAttribute('name')
        numeric_code = int(node.getAttribute('numeric_code'))
        # Fill the dictionary
        COUNTRIES[alpha_2_code] = _(name)
        ALT_CODES[alpha_2_code] = (alpha_3_code, numeric_code)
else:
    # Nicely titled (and translatable) country names.
    COUNTRIES: "Dict[str, StrPromise]" = {
        "AF": _("Afghanistan"),
        "AX": _("Åland Islands"),
        "AL": _("Albania"),
        "DZ": _("Algeria"),
        "AS": _("American Samoa"),
        "AD": _("Andorra"),
        "AO": _("Angola"),
        "AI": _("Anguilla"),
        "AQ": _("Antarctica"),
        "AG": _("Antigua and Barbuda"),
        "AR": _("Argentina"),
        "AM": _("Armenia"),
        "AW": _("Aruba"),
        "AU": _("Australia"),
        "AT": _("Austria"),
        "AZ": _("Azerbaijan"),
        "BS": _("Bahamas"),
        "BH": _("Bahrain"),
        "BD": _("Bangladesh"),
        "BB": _("Barbados"),
        "BY": _("Belarus"),
        "BE": _("Belgium"),
        "BZ": _("Belize"),
        "BJ": _("Benin"),
        "BM": _("Bermuda"),
        "BT": _("Bhutan"),
        "BO": _("Bolivia (Plurinational State of)"),
        "BQ": _("Bonaire, Sint Eustatius and Saba"),
        "BA": _("Bosnia and Herzegovina"),
        "BW": _("Botswana"),
        "BV": _("Bouvet Island"),
        "BR": _("Brazil"),
        "IO": _("British Indian Ocean Territory"),
        "BN": _("Brunei Darussalam"),
        "BG": _("Bulgaria"),
        "BF": _("Burkina Faso"),
        "BI": _("Burundi"),
        "CV": _("Cabo Verde"),
        "KH": _("Cambodia"),
        "CM": _("Cameroon"),
        "CA": _("Canada"),
        "KY": _("Cayman Islands"),
        "CF": _("Central African Republic"),
        "TD": _("Chad"),
        "CL": _("Chile"),
        "CN": _("China"),
        "CX": _("Christmas Island"),
        "CC": _("Cocos (Keeling) Islands"),
        "CO": _("Colombia"),
        "KM": _("Comoros"),
        "CG": _("Congo"),
        "CD": _("Congo (the Democratic Republic of the)"),
        "CK": _("Cook Islands"),
        "CR": _("Costa Rica"),
        "CI": _("Côte d'Ivoire"),
        "HR": _("Croatia"),
        "CU": _("Cuba"),
        "CW": _("Curaçao"),
        "CY": _("Cyprus"),
        "CZ": _("Czechia"),
        "DK": _("Denmark"),
        "DJ": _("Djibouti"),
        "DM": _("Dominica"),
        "DO": _("Dominican Republic"),
        "EC": _("Ecuador"),
        "EG": _("Egypt"),
        "SV": _("El Salvador"),
        "GQ": _("Equatorial Guinea"),
        "ER": _("Eritrea"),
        "EE": _("Estonia"),
        "SZ": _("Eswatini"),
        "ET": _("Ethiopia"),
        "FK": _("Falkland Islands (Malvinas)"),
        "FO": _("Faroe Islands"),
        "FJ": _("Fiji"),
        "FI": _("Finland"),
        "FR": _("France"),
        "GF": _("French Guiana"),
        "PF": _("French Polynesia"),
        "TF": _("French Southern Territories"),
        "GA": _("Gabon"),
        "GM": _("Gambia"),
        "GE": _("Georgia"),
        "DE": _("Germany"),
        "GH": _("Ghana"),
        "GI": _("Gibraltar"),
        "GR": _("Greece"),
        "GL": _("Greenland"),
        "GD": _("Grenada"),
        "GP": _("Guadeloupe"),
        "GU": _("Guam"),
        "GT": _("Guatemala"),
        "GG": _("Guernsey"),
        "GN": _("Guinea"),
        "GW": _("Guinea-Bissau"),
        "GY": _("Guyana"),
        "HT": _("Haiti"),
        "HM": _("Heard Island and McDonald Islands"),
        "VA": _("Holy See"),
        "HN": _("Honduras"),
        "HK": _("Hong Kong"),
        "HU": _("Hungary"),
        "IS": _("Iceland"),
        "IN": _("India"),
        "ID": _("Indonesia"),
        "IR": _("Iran (Islamic Republic of)"),
        "IQ": _("Iraq"),
        "IE": _("Ireland"),
        "IM": _("Isle of Man"),
        "IL": _("Israel"),
        "IT": _("Italy"),
        "JM": _("Jamaica"),
        "JP": _("Japan"),
        "JE": _("Jersey"),
        "JO": _("Jordan"),
        "KZ": _("Kazakhstan"),
        "KE": _("Kenya"),
        "KI": _("Kiribati"),
        "KP": _("Korea (the Democratic People's Republic of)"),
        "KR": _("Korea (the Republic of)"),
        "KW": _("Kuwait"),
        "KG": _("Kyrgyzstan"),
        "LA": _("Lao People's Democratic Republic"),
        "LV": _("Latvia"),
        "LB": _("Lebanon"),
        "LS": _("Lesotho"),
        "LR": _("Liberia"),
        "LY": _("Libya"),
        "LI": _("Liechtenstein"),
        "LT": _("Lithuania"),
        "LU": _("Luxembourg"),
        "MO": _("Macao"),
        "MG": _("Madagascar"),
        "MW": _("Malawi"),
        "MY": _("Malaysia"),
        "MV": _("Maldives"),
        "ML": _("Mali"),
        "MT": _("Malta"),
        "MH": _("Marshall Islands"),
        "MQ": _("Martinique"),
        "MR": _("Mauritania"),
        "MU": _("Mauritius"),
        "YT": _("Mayotte"),
        "MX": _("Mexico"),
        "FM": _("Micronesia (Federated States of)"),
        "MD": _("Moldova (the Republic of)"),
        "MC": _("Monaco"),
        "MN": _("Mongolia"),
        "ME": _("Montenegro"),
        "MS": _("Montserrat"),
        "MA": _("Morocco"),
        "MZ": _("Mozambique"),
        "MM": _("Myanmar"),
        "NA": _("Namibia"),
        "NR": _("Nauru"),
        "NP": _("Nepal"),
        "NL": _("Netherlands"),
        "NC": _("New Caledonia"),
        "NZ": _("New Zealand"),
        "NI": _("Nicaragua"),
        "NE": _("Niger"),
        "NG": _("Nigeria"),
        "NU": _("Niue"),
        "NF": _("Norfolk Island"),
        "MK": _("North Macedonia"),
        "MP": _("Northern Mariana Islands"),
        "NO": _("Norway"),
        "OM": _("Oman"),
        "PK": _("Pakistan"),
        "PW": _("Palau"),
        "PS": _("Palestine, State of"),
        "PA": _("Panama"),
        "PG": _("Papua New Guinea"),
        "PY": _("Paraguay"),
        "PE": _("Peru"),
        "PH": _("Philippines"),
        "PN": _("Pitcairn"),
        "PL": _("Poland"),
        "PT": _("Portugal"),
        "PR": _("Puerto Rico"),
        "QA": _("Qatar"),
        "RE": _("Réunion"),
        "RO": _("Romania"),
        "RU": _("Russian Federation"),
        "RW": _("Rwanda"),
        "BL": _("Saint Barthélemy"),
        "SH": _("Saint Helena, Ascension and Tristan da Cunha"),
        "KN": _("Saint Kitts and Nevis"),
        "LC": _("Saint Lucia"),
        "MF": _("Saint Martin (French part)"),
        "PM": _("Saint Pierre and Miquelon"),
        "VC": _("Saint Vincent and the Grenadines"),
        "WS": _("Samoa"),
        "SM": _("San Marino"),
        "ST": _("Sao Tome and Principe"),
        "SA": _("Saudi Arabia"),
        "SN": _("Senegal"),
        "RS": _("Serbia"),
        "SC": _("Seychelles"),
        "SL": _("Sierra Leone"),
        "SG": _("Singapore"),
        "SX": _("Sint Maarten (Dutch part)"),
        "SK": _("Slovakia"),
        "SI": _("Slovenia"),
        "SB": _("Solomon Islands"),
        "SO": _("Somalia"),
        "ZA": _("South Africa"),
        "GS": _("South Georgia and the South Sandwich Islands"),
        "SS": _("South Sudan"),
        "ES": _("Spain"),
        "LK": _("Sri Lanka"),
        "SD": _("Sudan"),
        "SR": _("Suriname"),
        "SJ": _("Svalbard and Jan Mayen"),
        "SE": _("Sweden"),
        "CH": _("Switzerland"),
        "SY": _("Syrian Arab Republic"),
        "TW": _("Taiwan (Province of China)"),
        "TJ": _("Tajikistan"),
        "TZ": _("Tanzania, the United Republic of"),
        "TH": _("Thailand"),
        "TL": _("Timor-Leste"),
        "TG": _("Togo"),
        "TK": _("Tokelau"),
        "TO": _("Tonga"),
        "TT": _("Trinidad and Tobago"),
        "TN": _("Tunisia"),
        "TR": _("Türkiye"),
        "TM": _("Turkmenistan"),
        "TC": _("Turks and Caicos Islands"),
        "TV": _("Tuvalu"),
        "UG": _("Uganda"),
        "UA": _("Ukraine"),
        "AE": _("United Arab Emirates"),
        "GB": _("United Kingdom of Great Britain and Northern Ireland"),
        "UM": _("United States Minor Outlying Islands"),
        "US": _("United States of America"),
        "UY": _("Uruguay"),
        "UZ": _("Uzbekistan"),
        "VU": _("Vanuatu"),
        "VE": _("Venezuela (Bolivarian Republic of)"),
        "VN": _("Viet Nam"),
        "VG": _("Virgin Islands (British)"),
        "VI": _("Virgin Islands (U.S.)"),
        "WF": _("Wallis and Futuna"),
        "EH": _("Western Sahara"),
        "YE": _("Yemen"),
        "ZM": _("Zambia"),
        "ZW": _("Zimbabwe"),
    }

    ALT_CODES = {
        "AF": ("AFG", 4),
        "AX": ("ALA", 248),
        "AL": ("ALB", 8),
        "DZ": ("DZA", 12),
        "AS": ("ASM", 16),
        "AD": ("AND", 20),
        "AO": ("AGO", 24),
        "AI": ("AIA", 660),
        "AQ": ("ATA", 10),
        "AG": ("ATG", 28),
        "AR": ("ARG", 32),
        "AM": ("ARM", 51),
        "AW": ("ABW", 533),
        "AU": ("AUS", 36),
        "AT": ("AUT", 40),
        "AZ": ("AZE", 31),
        "BS": ("BHS", 44),
        "BH": ("BHR", 48),
        "BD": ("BGD", 50),
        "BB": ("BRB", 52),
        "BY": ("BLR", 112),
        "BE": ("BEL", 56),
        "BZ": ("BLZ", 84),
        "BJ": ("BEN", 204),
        "BM": ("BMU", 60),
        "BT": ("BTN", 64),
        "BO": ("BOL", 68),
        "BQ": ("BES", 535),
        "BA": ("BIH", 70),
        "BW": ("BWA", 72),
        "BV": ("BVT", 74),
        "BR": ("BRA", 76),
        "IO": ("IOT", 86),
        "BN": ("BRN", 96),
        "BG": ("BGR", 100),
        "BF": ("BFA", 854),
        "BI": ("BDI", 108),
        "CV": ("CPV", 132),
        "KH": ("KHM", 116),
        "CM": ("CMR", 120),
        "CA": ("CAN", 124),
        "KY": ("CYM", 136),
        "CF": ("CAF", 140),
        "TD": ("TCD", 148),
        "CL": ("CHL", 152),
        "CN": ("CHN", 156),
        "CX": ("CXR", 162),
        "CC": ("CCK", 166),
        "CO": ("COL", 170),
        "KM": ("COM", 174),
        "CG": ("COG", 178),
        "CD": ("COD", 180),
        "CK": ("COK", 184),
        "CR": ("CRI", 188),
        "CI": ("CIV", 384),
        "HR": ("HRV", 191),
        "CU": ("CUB", 192),
        "CW": ("CUW", 531),
        "CY": ("CYP", 196),
        "CZ": ("CZE", 203),
        "DK": ("DNK", 208),
        "DJ": ("DJI", 262),
        "DM": ("DMA", 212),
        "DO": ("DOM", 214),
        "EC": ("ECU", 218),
        "EG": ("EGY", 818),
        "SV": ("SLV", 222),
        "GQ": ("GNQ", 226),
        "ER": ("ERI", 232),
        "EE": ("EST", 233),
        "SZ": ("SWZ", 748),
        "ET": ("ETH", 231),
        "FK": ("FLK", 238),
        "FO": ("FRO", 234),
        "FJ": ("FJI", 242),
        "FI": ("FIN", 246),
        "FR": ("FRA", 250),
        "GF": ("GUF", 254),
        "PF": ("PYF", 258),
        "TF": ("ATF", 260),
        "GA": ("GAB", 266),
        "GM": ("GMB", 270),
        "GE": ("GEO", 268),
        "DE": ("DEU", 276),
        "GH": ("GHA", 288),
        "GI": ("GIB", 292),
        "GR": ("GRC", 300),
        "GL": ("GRL", 304),
        "GD": ("GRD", 308),
        "GP": ("GLP", 312),
        "GU": ("GUM", 316),
        "GT": ("GTM", 320),
        "GG": ("GGY", 831),
        "GN": ("GIN", 324),
        "GW": ("GNB", 624),
        "GY": ("GUY", 328),
        "HT": ("HTI", 332),
        "HM": ("HMD", 334),
        "VA": ("VAT", 336),
        "HN": ("HND", 340),
        "HK": ("HKG", 344),
        "HU": ("HUN", 348),
        "IS": ("ISL", 352),
        "IN": ("IND", 356),
        "ID": ("IDN", 360),
        "IR": ("IRN", 364),
        "IQ": ("IRQ", 368),
        "IE": ("IRL", 372),
        "IM": ("IMN", 833),
        "IL": ("ISR", 376),
        "IT": ("ITA", 380),
        "JM": ("JAM", 388),
        "JP": ("JPN", 392),
        "JE": ("JEY", 832),
        "JO": ("JOR", 400),
        "KZ": ("KAZ", 398),
        "KE": ("KEN", 404),
        "KI": ("KIR", 296),
        "KP": ("PRK", 408),
        "KR": ("KOR", 410),
        "KW": ("KWT", 414),
        "KG": ("KGZ", 417),
        "LA": ("LAO", 418),
        "LV": ("LVA", 428),
        "LB": ("LBN", 422),
        "LS": ("LSO", 426),
        "LR": ("LBR", 430),
        "LY": ("LBY", 434),
        "LI": ("LIE", 438),
        "LT": ("LTU", 440),
        "LU": ("LUX", 442),
        "MO": ("MAC", 446),
        "MG": ("MDG", 450),
        "MW": ("MWI", 454),
        "MY": ("MYS", 458),
        "MV": ("MDV", 462),
        "ML": ("MLI", 466),
        "MT": ("MLT", 470),
        "MH": ("MHL", 584),
        "MQ": ("MTQ", 474),
        "MR": ("MRT", 478),
        "MU": ("MUS", 480),
        "YT": ("MYT", 175),
        "MX": ("MEX", 484),
        "FM": ("FSM", 583),
        "MD": ("MDA", 498),
        "MC": ("MCO", 492),
        "MN": ("MNG", 496),
        "ME": ("MNE", 499),
        "MS": ("MSR", 500),
        "MA": ("MAR", 504),
        "MZ": ("MOZ", 508),
        "MM": ("MMR", 104),
        "NA": ("NAM", 516),
        "NR": ("NRU", 520),
        "NP": ("NPL", 524),
        "NL": ("NLD", 528),
        "NC": ("NCL", 540),
        "NZ": ("NZL", 554),
        "NI": ("NIC", 558),
        "NE": ("NER", 562),
        "NG": ("NGA", 566),
        "NU": ("NIU", 570),
        "NF": ("NFK", 574),
        "MK": ("MKD", 807),
        "MP": ("MNP", 580),
        "NO": ("NOR", 578),
        "OM": ("OMN", 512),
        "PK": ("PAK", 586),
        "PW": ("PLW", 585),
        "PS": ("PSE", 275),
        "PA": ("PAN", 591),
        "PG": ("PNG", 598),
        "PY": ("PRY", 600),
        "PE": ("PER", 604),
        "PH": ("PHL", 608),
        "PN": ("PCN", 612),
        "PL": ("POL", 616),
        "PT": ("PRT", 620),
        "PR": ("PRI", 630),
        "QA": ("QAT", 634),
        "RE": ("REU", 638),
        "RO": ("ROU", 642),
        "RU": ("RUS", 643),
        "RW": ("RWA", 646),
        "BL": ("BLM", 652),
        "SH": ("SHN", 654),
        "KN": ("KNA", 659),
        "LC": ("LCA", 662),
        "MF": ("MAF", 663),
        "PM": ("SPM", 666),
        "VC": ("VCT", 670),
        "WS": ("WSM", 882),
        "SM": ("SMR", 674),
        "ST": ("STP", 678),
        "SA": ("SAU", 682),
        "SN": ("SEN", 686),
        "RS": ("SRB", 688),
        "SC": ("SYC", 690),
        "SL": ("SLE", 694),
        "SG": ("SGP", 702),
        "SX": ("SXM", 534),
        "SK": ("SVK", 703),
        "SI": ("SVN", 705),
        "SB": ("SLB", 90),
        "SO": ("SOM", 706),
        "ZA": ("ZAF", 710),
        "GS": ("SGS", 239),
        "SS": ("SSD", 728),
        "ES": ("ESP", 724),
        "LK": ("LKA", 144),
        "SD": ("SDN", 729),
        "SR": ("SUR", 740),
        "SJ": ("SJM", 744),
        "SE": ("SWE", 752),
        "CH": ("CHE", 756),
        "SY": ("SYR", 760),
        "TW": ("TWN", 158),
        "TJ": ("TJK", 762),
        "TZ": ("TZA", 834),
        "TH": ("THA", 764),
        "TL": ("TLS", 626),
        "TG": ("TGO", 768),
        "TK": ("TKL", 772),
        "TO": ("TON", 776),
        "TT": ("TTO", 780),
        "TN": ("TUN", 788),
        "TR": ("TUR", 792),
        "TM": ("TKM", 795),
        "TC": ("TCA", 796),
        "TV": ("TUV", 798),
        "UG": ("UGA", 800),
        "UA": ("UKR", 804),
        "AE": ("ARE", 784),
        "GB": ("GBR", 826),
        "UM": ("UMI", 581),
        "US": ("USA", 840),
        "UY": ("URY", 858),
        "UZ": ("UZB", 860),
        "VU": ("VUT", 548),
        "VE": ("VEN", 862),
        "VN": ("VNM", 704),
        "VG": ("VGB", 92),
        "VI": ("VIR", 850),
        "WF": ("WLF", 876),
        "EH": ("ESH", 732),
        "YE": ("YEM", 887),
        "ZM": ("ZMB", 894),
        "ZW": ("ZWE", 716),
    }


def check_flags(verbosity: int = 1):
    files = {}
    this_dir = os.path.dirname(__file__)
    for path in glob.glob(os.path.join(this_dir, "static", "flags", "*.gif")):
        files[os.path.basename(os.path.splitext(path)[0]).upper()] = path

    flags_missing = set(COUNTRIES) - set(files)
    if flags_missing:  # pragma: no cover
        print("The following country codes are missing a flag:")
        for code in sorted(flags_missing):
            print(f"  {code} ({COUNTRIES[code]})")
    elif verbosity:  # pragma: no cover
        print("All country codes have flags. :)")

    code_missing = set(files) - set(COUNTRIES)
    # Special-case EU and __
    for special_code in ("EU", "__"):
        code_missing.discard(special_code)
    if code_missing:  # pragma: no cover
        print("")
        print("The following flags don't have a matching country code:")
        for path in sorted(code_missing):
            print(f"  {path}")


def check_common_names() -> None:
    common_names_missing = set(CountriesBase.COMMON_NAMES) - set(COUNTRIES)
    if common_names_missing:  # pragma: no cover
        print("")
        print("The following common names do not match an official country code:")
        for code in sorted(common_names_missing):
            print(f"  {code}")