# 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.

# You must generate a "Long-Lived Access Token". This can be done from your
# Home Assistant Profile page.

from json import dumps
from uuid import uuid4

import requests

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


class NotifyHomeAssistant(NotifyBase):
    """A wrapper for Home Assistant Notifications."""

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

    # The services URL
    service_url = "https://www.home-assistant.io/"

    # Insecure Protocol Access
    protocol = "hassio"

    # Secure Protocol
    secure_protocol = "hassios"

    # Default to Home Assistant Default Insecure port of 8123 instead of 80
    default_insecure_port = 8123

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

    # Define object templates
    templates = (
        "{schema}://{host}/{accesstoken}",
        "{schema}://{host}:{port}/{accesstoken}",
        "{schema}://{user}@{host}/{accesstoken}",
        "{schema}://{user}@{host}:{port}/{accesstoken}",
        "{schema}://{user}:{password}@{host}/{accesstoken}",
        "{schema}://{user}:{password}@{host}:{port}/{accesstoken}",
    )

    # Define our template tokens
    template_tokens = dict(
        NotifyBase.template_tokens,
        **{
            "host": {
                "name": _("Hostname"),
                "type": "string",
                "required": True,
            },
            "port": {
                "name": _("Port"),
                "type": "int",
                "min": 1,
                "max": 65535,
            },
            "user": {
                "name": _("Username"),
                "type": "string",
            },
            "password": {
                "name": _("Password"),
                "type": "string",
                "private": True,
            },
            "accesstoken": {
                "name": _("Long-Lived Access Token"),
                "type": "string",
                "private": True,
                "required": True,
            },
        },
    )

    # Define our template arguments
    template_args = dict(
        NotifyBase.template_args,
        **{
            "nid": {
                # Optional Unique Notification ID
                "name": _("Notification ID"),
                "type": "string",
                "regex": (r"^[a-z0-9_-]+$", "i"),
            },
        },
    )

    def __init__(self, accesstoken, nid=None, **kwargs):
        """Initialize Home Assistant Object."""
        super().__init__(**kwargs)

        self.fullpath = kwargs.get("fullpath", "")

        if not (self.secure or self.port):
            # Use default insecure port
            self.port = self.default_insecure_port

        # Long-Lived Access token (generated from User Profile)
        self.accesstoken = validate_regex(accesstoken)
        if not self.accesstoken:
            msg = (
                "An invalid Home Assistant Long-Lived Access Token "
                f"({accesstoken}) was specified."
            )
            self.logger.warning(msg)
            raise TypeError(msg)

        # An Optional Notification Identifier
        self.nid = None
        if nid:
            self.nid = validate_regex(nid, *self.template_args["nid"]["regex"])
            if not self.nid:
                msg = (
                    "An invalid Home Assistant Notification Identifier "
                    f"({nid}) was specified."
                )
                self.logger.warning(msg)
                raise TypeError(msg)

        return

    def send(self, body, title="", notify_type=NotifyType.INFO, **kwargs):
        """Sends Message."""

        # Prepare our persistent_notification.create payload
        payload = {
            "title": title,
            "message": body,
            # Use a unique ID so we don't over-write the last message
            # we posted. Otherwise use the notification id specified
            "notification_id": self.nid if self.nid else str(uuid4()),
        }

        # Prepare our headers
        headers = {
            "User-Agent": self.app_id,
            "Content-Type": "application/json",
            "Authorization": f"Bearer {self.accesstoken}",
        }

        auth = None
        if self.user:
            auth = (self.user, self.password)

        # Set our schema
        schema = "https" if self.secure else "http"

        url = f"{schema}://{self.host}"
        if isinstance(self.port, int):
            url += f":{self.port}"

        url += (
            self.fullpath.rstrip("/")
            + "/api/services/persistent_notification/create"
        )

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

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

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

                self.logger.warning(
                    "Failed to send Home Assistant 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 Home Assistant notification.")

        except requests.RequestException as e:
            self.logger.warning(
                "A Connection error occurred sending Home Assistant "
                f"notification to {self.host}."
            )
            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 if self.secure else self.protocol,
            self.user,
            self.password,
            self.host,
            (
                self.port
                if self.port
                else (443 if self.secure else self.default_insecure_port)
            ),
            self.fullpath.rstrip("/"),
            self.accesstoken,
        )

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

        # Define any URL parameters
        params = {}
        if self.nid:
            params["nid"] = self.nid

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

        # Determine Authentication
        auth = ""
        if self.user and self.password:
            auth = "{user}:{password}@".format(
                user=NotifyHomeAssistant.quote(self.user, safe=""),
                password=self.pprint(
                    self.password, privacy, mode=PrivacyMode.Secret, safe=""
                ),
            )
        elif self.user:
            auth = "{user}@".format(
                user=NotifyHomeAssistant.quote(self.user, safe=""),
            )

        default_port = 443 if self.secure else self.default_insecure_port

        url = (
            "{schema}://{auth}{hostname}{port}{fullpath}"
            "{accesstoken}/?{params}"
        )

        return url.format(
            schema=self.secure_protocol if self.secure else self.protocol,
            auth=auth,
            # never encode hostname since we're expecting it to be a valid one
            hostname=self.host,
            port=(
                ""
                if not self.port or self.port == default_port
                else f":{self.port}"
            ),
            fullpath=(
                "/"
                if not self.fullpath
                else "/{}/".format(
                    NotifyHomeAssistant.quote(
                        self.fullpath.strip("/"), safe="/"
                    )
                )
            ),
            accesstoken=self.pprint(self.accesstoken, privacy, safe=""),
            params=NotifyHomeAssistant.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

        # Get our Long-Lived Access Token
        if "accesstoken" in results["qsd"] and len(
            results["qsd"]["accesstoken"]
        ):
            results["accesstoken"] = NotifyHomeAssistant.unquote(
                results["qsd"]["accesstoken"]
            )

        else:
            # Acquire our full path
            fullpath = NotifyHomeAssistant.split_path(results["fullpath"])

            # Otherwise pop the last element from our path to be it
            results["accesstoken"] = fullpath.pop() if fullpath else None

            # Re-assemble our full path
            results["fullpath"] = "/" + "/".join(fullpath) if fullpath else ""

        # Allow the specification of a unique notification_id so that
        # it will always replace the last one sent.
        if "nid" in results["qsd"] and len(results["qsd"]["nid"]):
            results["nid"] = NotifyHomeAssistant.unquote(results["qsd"]["nid"])

        return results
