#
# Copyright 2002-2006 Zuza Software Foundation
#
# This file is part of translate.
#
# translate is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# translate is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.

"""
Convert Gettext PO localization files to Java/Mozilla .properties files.

See: http://docs.translatehouse.org/projects/translate-toolkit/en/latest/commands/prop2po.html
for examples and usage instructions.
"""

import warnings

from translate.convert import accesskey, convert
from translate.convert.prop2po import EMPTY_KEY_MARKER
from translate.lang import data
from translate.misc import quote
from translate.storage import po, properties

eol = "\n"


def _get_key_end(line, delimiter_pos, key, personality):
    """Return where the output key ends in the template line."""
    key_start = len(line[:delimiter_pos]) - len(line[:delimiter_pos].lstrip())
    key_wrap_char = personality.key_wrap_char
    if key_wrap_char and line[key_start : key_start + 1] == key_wrap_char:
        key_end = key_start + 1
        while key_end < delimiter_pos:
            if line[key_end] == key_wrap_char and line[key_end - 1] != "\\":
                return key_end + 1
            key_end += 1
    return min(key_start + len(key), delimiter_pos)


def _get_delimiter_spacing(line, delimiter_pos, key_end):
    """Return the whitespace around the delimiter."""
    postspace_end = delimiter_pos + 1
    while postspace_end < len(line) and line[postspace_end].isspace():
        postspace_end += 1
    postspace = line[delimiter_pos + 1 : postspace_end]

    return line[key_end:delimiter_pos], postspace


def applytranslation(key, propunit, inunit, mixedkeys):
    """Applies the translation for key in the po unit to the prop unit."""
    # this converts the po-style string to a prop-style string
    value = inunit.target
    # handle mixed keys
    for labelsuffix in properties.labelsuffixes:
        if key.endswith(labelsuffix) and key in mixedkeys:
            value, _akey = accesskey.extract(value)
            break
    else:
        for akeysuffix in properties.accesskeysuffixes:
            if key.endswith(akeysuffix) and key in mixedkeys:
                _label, value = accesskey.extract(value)
                if not value:
                    warnings.warn(f"Could not find accesskey for {key}")
                    # Use the source language accesskey
                    _label, value = accesskey.extract(inunit.source)
                else:
                    original = propunit.source
                    # For the sake of diffs we keep the case of the
                    # accesskey the same if we know the translation didn't
                    # change. Casing matters in XUL.
                    if value == propunit.source and original.lower() == value.lower():
                        if original.isupper():
                            value = value.upper()
                        elif original.islower():
                            value = value.lower()
    return value


class reprop:
    def __init__(
        self,
        templatefile,
        inputstore,
        personality,
        encoding=None,
        remove_untranslated=False,
    ) -> None:
        self.templatefile = templatefile
        self.inputstore = inputstore
        self.personality = properties.get_dialect(personality)
        self.encoding = encoding
        if self.encoding is None:
            self.encoding = self.personality.default_encoding
        self.remove_untranslated = remove_untranslated
        self.mixer = accesskey.UnitMixer(
            properties.labelsuffixes, properties.accesskeysuffixes
        )

    def convertstore(self, includefuzzy=False):
        self.includefuzzy = includefuzzy
        self.inmultilinemsgid = False
        self.inecho = False
        self.inputstore.makeindex()
        if self.personality.name == "gaia":
            self._explode_gaia_plurals()
        if self.personality.name == "gwt":
            self._explode_gwt_plurals()
        outputlines = []
        # Readlines doesn't work for UTF-16, we read() and splitlines(keepends) instead
        content = self.templatefile.read().decode(self.encoding)
        for line in content.splitlines(True):
            outputstr = self.convertline(line)
            outputlines.append(outputstr)
        return "".join(outputlines).encode(self.encoding)

    def _handle_accesskeys(self, inunit, currkey):
        value = inunit.target
        if self.personality.name == "mozilla":
            keys = inunit.getlocations()
            mixedkeys = self.mixer.match_entities(keys)
            for key in keys:
                if key == currkey and key in self.inputstore.locationindex:
                    propunit = self.inputstore.locationindex[key]  # find the prop
                    value = applytranslation(key, propunit, inunit, mixedkeys)
                    break

        return value

    def _explode_gaia_plurals(self) -> None:
        """Explode the gaia plurals."""
        for unit in self.inputstore.units:
            if not unit.hasplural():
                continue
            if (unit.isfuzzy() and not self.includefuzzy) or not unit.istranslated():
                continue

            names = data.cldr_plural_categories
            location = unit.getlocations()[0]
            for category, text in zip(names, unit.target.strings, strict=True):
                # TODO: for now we assume all forms are present. We need to
                # fill in the rest after mapping things to the proper CLDR names.
                if category == "zero":
                    # [zero] cases are translated as separate units
                    continue
                new_unit = self.inputstore.addsourceunit("fish")  # not used
                new_location = f"{location}[{category}]"
                new_unit.addlocation(new_location)
                new_unit.target = text
                self.inputstore.locationindex[new_location] = new_unit

            # We don't want the plural marker to be translated:
            del self.inputstore.locationindex[location]

    def _explode_gwt_plurals(self) -> None:
        """Explode the gwt plurals."""
        # cldr names to GWT variants
        cldr2gwt = {
            "zero": "none",
            "one": "one",
            "two": "two",
            "few": "few",
            "many": "many",
            "other": "",
        }

        for unit in self.inputstore.units:
            if not unit.hasplural():
                continue
            if (unit.isfuzzy() and not self.includefuzzy) or not unit.istranslated():
                continue

            names = data.cldr_plural_categories
            names = [cldr2gwt.get(name) for name in names]
            location = unit.getlocations()[0]
            for category, text in zip(names, unit.target.strings, strict=True):
                new_unit = self.inputstore.addsourceunit("fish")  # not used
                new_location = f"{location}[{category}]" if category else f"{location}"
                new_unit.addlocation(new_location)
                new_unit.target = text
                self.inputstore.locationindex[new_location] = new_unit

    def convertline(self, line):
        returnline = ""
        # handle multiline msgid if we're in one
        if self.inmultilinemsgid:
            msgid = quote.rstripeol(line).strip()
            # see if there's more
            self.inmultilinemsgid = msgid[-1:] == "\\"
            # if we're echoing...
            if self.inecho:
                returnline = line
        # otherwise, this could be a comment
        elif line.strip()[:1] == "#":
            returnline = quote.rstripeol(line) + eol
        else:
            line = quote.rstripeol(line)
            delimiter_char, delimiter_pos = self.personality.find_delimiter(line)
            if quote.rstripeol(line)[-1:] == "\\":
                self.inmultilinemsgid = True
            if delimiter_pos == -1:
                key = self.personality.key_strip(line)
                delimiter = f" {self.personality.delimiters[0]} "
            else:
                key = self.personality.key_strip(line[:delimiter_pos])
                key_end = _get_key_end(line, delimiter_pos, key, self.personality)
                prespace, postspace = _get_delimiter_spacing(
                    line, delimiter_pos, key_end
                )
                delimiter = prespace + delimiter_char + postspace
            # Check for the special marker used for empty keys (e.g., "=value")
            lookup_key = key or EMPTY_KEY_MARKER
            if lookup_key in self.inputstore.locationindex:
                unit = self.inputstore.locationindex[lookup_key]
                if unit is None or (
                    not unit.istranslated()
                    and bool(unit.source)
                    and self.remove_untranslated
                ):
                    returnline = ""
                    self.inecho = False
                else:
                    if (unit.isfuzzy() and not self.includefuzzy) or len(
                        unit.target
                    ) == 0:
                        value = unit.source
                    else:
                        value = self._handle_accesskeys(unit, key)
                    self.inecho = False
                    assert isinstance(value, str)
                    returnline = f"{self.personality.key_wrap_char}{key}{self.personality.key_wrap_char}{delimiter if delimiter_pos != -1 or value else ''}{self.personality.value_wrap_char}{self.personality.encode(value)}{self.personality.value_wrap_char}{self.personality.pair_terminator}{eol}"
            else:
                self.inecho = True
                returnline = line + eol
        assert isinstance(returnline, str)
        return returnline


def convertstrings(
    inputfile,
    outputfile,
    templatefile,
    personality=None,
    includefuzzy=False,
    encoding=None,
    outputthreshold=None,
    remove_untranslated=False,
):
    """.strings specific convertor function."""
    return convertprop(
        inputfile,
        outputfile,
        templatefile,
        personality=personality or "strings",
        includefuzzy=includefuzzy,
        encoding=encoding,
        outputthreshold=outputthreshold,
        remove_untranslated=remove_untranslated,
    )


def convertmozillaprop(
    inputfile,
    outputfile,
    templatefile,
    includefuzzy=False,
    remove_untranslated=False,
    outputthreshold=None,
):
    """Mozilla specific convertor function."""
    return convertprop(
        inputfile,
        outputfile,
        templatefile,
        personality="mozilla",
        includefuzzy=includefuzzy,
        remove_untranslated=remove_untranslated,
        outputthreshold=outputthreshold,
    )


def convertprop(
    inputfile,
    outputfile,
    templatefile,
    personality=None,
    includefuzzy=False,
    encoding=None,
    remove_untranslated=False,
    outputthreshold=None,
) -> bool:
    personality = personality or "java"
    inputstore = po.pofile(inputfile)

    if not convert.should_output_store(inputstore, outputthreshold):
        return False

    if templatefile is None:
        raise ValueError("must have template file for properties files")
    convertor = reprop(
        templatefile, inputstore, personality, encoding, remove_untranslated
    )
    outputprop = convertor.convertstore(includefuzzy)
    outputfile.write(outputprop)
    return True


formats = {
    ("po", "properties"): ("properties", convertprop),
    ("po", "lang"): ("lang", convertprop),
    ("po", "strings"): ("strings", convertstrings),
}


def main(argv=None) -> None:
    # handle command line options
    parser = convert.ConvertOptionParser(
        formats, usetemplates=True, description=__doc__
    )
    parser.add_option(
        "",
        "--personality",
        dest="personality",
        default=None,
        type="choice",
        choices=list(properties.dialects),
        help=f"override the input file format: {', '.join(properties.dialects)} (for .properties files, default: {properties.default_dialect})",
        metavar="TYPE",
    )
    parser.add_option(
        "",
        "--encoding",
        dest="encoding",
        default=None,
        help="override the encoding set by the personality",
        metavar="ENCODING",
    )
    parser.add_threshold_option()
    parser.add_fuzzy_option()
    parser.add_remove_untranslated_option()
    parser.passthrough.append("personality")
    parser.passthrough.append("encoding")
    parser.run(argv)


if __name__ == "__main__":
    main()
