# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2026, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import contextlib

import requests

from ..common import NotifyType
from ..locale import gettext_lazy as _
from ..utils.parse import validate_regex
from .base import NotifyBase


# Priorities
class ProwlPriority:
    LOW = -2
    MODERATE = -1
    NORMAL = 0
    HIGH = 1
    EMERGENCY = 2


PROWL_PRIORITIES = {
    # Note: This also acts as a reverse lookup mapping
    ProwlPriority.LOW: "low",
    ProwlPriority.MODERATE: "moderate",
    ProwlPriority.NORMAL: "normal",
    ProwlPriority.HIGH: "high",
    ProwlPriority.EMERGENCY: "emergency",
}

PROWL_PRIORITY_MAP = {
    # Maps against string 'low'
    "l": ProwlPriority.LOW,
    # Maps against string 'moderate'
    "m": ProwlPriority.MODERATE,
    # Maps against string 'normal'
    "n": ProwlPriority.NORMAL,
    # Maps against string 'high'
    "h": ProwlPriority.HIGH,
    # Maps against string 'emergency'
    "e": ProwlPriority.EMERGENCY,
    # Entries to additionally support (so more like Prowl's API)
    "-2": ProwlPriority.LOW,
    "-1": ProwlPriority.MODERATE,
    "0": ProwlPriority.NORMAL,
    "1": ProwlPriority.HIGH,
    "2": ProwlPriority.EMERGENCY,
}

# Provide some known codes Prowl uses and what they translate to:
PROWL_HTTP_ERROR_MAP = {
    406: "IP address has exceeded API limit",
    409: "Request not aproved.",
}


class NotifyProwl(NotifyBase):
    """A wrapper for Prowl Notifications."""

    # The default descriptive name associated with the Notification
    service_name = "Prowl"

    # The services URL
    service_url = "https://www.prowlapp.com/"

    # The default secure protocol
    secure_protocol = "prowl"

    # A URL that takes you to the setup/help of the specific protocol
    setup_url = "https://appriseit.com/services/prowl/"

    # Prowl uses the http protocol with JSON requests
    notify_url = "https://api.prowlapp.com/publicapi/add"

    # Disable throttle rate for Prowl requests since they are normally
    # local anyway
    request_rate_per_sec = 0

    # The maximum allowable characters allowed in the body per message
    body_maxlen = 10000

    # Defines the maximum allowable characters in the title
    title_maxlen = 1024

    # Define object templates
    templates = (
        "{schema}://{apikey}",
        "{schema}://{apikey}/{providerkey}",
    )

    # Define our template tokens
    template_tokens = dict(
        NotifyBase.template_tokens,
        **{
            "apikey": {
                "name": _("API Key"),
                "type": "string",
                "private": True,
                "required": True,
                "regex": (r"^[A-Za-z0-9]{40}$", "i"),
            },
            "providerkey": {
                "name": _("Provider Key"),
                "type": "string",
                "private": True,
                "regex": (r"^[A-Za-z0-9]{40}$", "i"),
            },
        },
    )

    # Define our template arguments
    template_args = dict(
        NotifyBase.template_args,
        **{
            "priority": {
                "name": _("Priority"),
                "type": "choice:int",
                "values": PROWL_PRIORITIES,
                "default": ProwlPriority.NORMAL,
            },
        },
    )

    def __init__(self, apikey, providerkey=None, priority=None, **kwargs):
        """Initialize Prowl Object."""
        super().__init__(**kwargs)

        # The Priority of the message
        self.priority = (
            NotifyProwl.template_args["priority"]["default"]
            if not priority
            else next(
                (
                    v
                    for k, v in PROWL_PRIORITY_MAP.items()
                    if str(priority).lower().startswith(k)
                ),
                NotifyProwl.template_args["priority"]["default"],
            )
        )

        # API Key (associated with project)
        self.apikey = validate_regex(
            apikey, *self.template_tokens["apikey"]["regex"]
        )
        if not self.apikey:
            msg = f"An invalid Prowl API Key ({apikey}) was specified."
            self.logger.warning(msg)
            raise TypeError(msg)

        # Store the provider key (if specified)
        if providerkey:
            self.providerkey = validate_regex(
                providerkey, *self.template_tokens["providerkey"]["regex"]
            )
            if not self.providerkey:
                msg = (
                    "An invalid Prowl Provider Key "
                    f"({providerkey}) was specified."
                )
                self.logger.warning(msg)
                raise TypeError(msg)

        else:
            # No provider key was set
            self.providerkey = None

        return

    def send(self, body, title="", notify_type=NotifyType.INFO, **kwargs):
        """Perform Prowl Notification."""

        headers = {
            "User-Agent": self.app_id,
            "Content-type": "application/x-www-form-urlencoded",
        }

        # prepare JSON Object
        payload = {
            "apikey": self.apikey,
            "application": self.app_id,
            "event": title,
            "description": body,
            "priority": self.priority,
        }

        if self.providerkey:
            payload["providerkey"] = self.providerkey

        self.logger.debug(
            "Prowl POST URL:"
            f" {self.notify_url} (cert_verify={self.verify_certificate!r})"
        )
        self.logger.debug(f"Prowl Payload: {payload!s}")

        # Always call throttle before any remote server i/o is made
        self.throttle()

        try:
            r = requests.post(
                self.notify_url,
                data=payload,
                headers=headers,
                verify=self.verify_certificate,
                timeout=self.request_timeout,
            )
            if r.status_code != requests.codes.ok:
                # We had a problem
                status_str = NotifyBase.http_response_code_lookup(
                    r.status_code, PROWL_HTTP_ERROR_MAP
                )

                self.logger.warning(
                    "Failed to send Prowl notification:{}{}error={}.".format(
                        status_str, ", " if status_str else "", r.status_code
                    )
                )

                self.logger.debug(
                    "Response Details:\r\n%r", (r.content or b"")[:2000])

                # Return; we're done
                return False

            else:
                self.logger.info("Sent Prowl notification.")

        except requests.RequestException as e:
            self.logger.warning(
                "A Connection error occurred sending Prowl notification."
            )
            self.logger.debug(f"Socket Exception: {e!s}")

            # Return; we're done
            return False

        return True

    @property
    def url_identifier(self):
        """Returns all of the identifiers that make this URL unique from
        another simliar one.

        Targets or end points should never be identified here.
        """
        return (self.secure_protocol, self.apikey, self.providerkey)

    def url(self, privacy=False, *args, **kwargs):
        """Returns the URL built dynamically based on specified arguments."""

        # Define any URL parameters
        params = {
            "priority": (
                PROWL_PRIORITIES[self.template_args["priority"]["default"]]
                if self.priority not in PROWL_PRIORITIES
                else PROWL_PRIORITIES[self.priority]
            ),
        }

        # Extend our parameters
        params.update(self.url_parameters(privacy=privacy, *args, **kwargs))

        return "{schema}://{apikey}/{providerkey}/?{params}".format(
            schema=self.secure_protocol,
            apikey=self.pprint(self.apikey, privacy, safe=""),
            providerkey=self.pprint(self.providerkey, privacy, safe=""),
            params=NotifyProwl.urlencode(params),
        )

    @staticmethod
    def parse_url(url):
        """Parses the URL and returns enough arguments that can allow us to re-
        instantiate this object."""
        results = NotifyBase.parse_url(url, verify_host=False)
        if not results:
            # We're done early as we couldn't load the results
            return results

        # Set the API Key
        results["apikey"] = NotifyProwl.unquote(results["host"])

        # Optionally try to find the provider key
        with contextlib.suppress(IndexError):
            results["providerkey"] = NotifyProwl.split_path(
                results["fullpath"]
            )[0]

        # Set our priority
        if "priority" in results["qsd"] and len(results["qsd"]["priority"]):
            results["priority"] = NotifyProwl.unquote(
                results["qsd"]["priority"]
            )

        return results
