"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Thursday, 19th Dec., 2024

    OBJECTIVE:

        To send SMS messages through various third-party clients.

    REFERENCES:

        N/A

    DOWNLOADS:

        N/A

    NOTES:

        N/A

"""


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                   IMPORT                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# To make sibling directories accessible for imports:
import sys
sys.path.append(".")
sys.path.append("..")

# For using Quart:
from quart import Blueprint, current_app, request

# My utils:
from utils_v2.string import json
from utils_v2.api.codes import StatusCodes, HttpCodes
from utils_v2.database.async_mongo_v2 import AsyncMongo
from utils_v2.api.response import ResponseModel
from utils_v2.api.async_quart import (
    set_api_version,
    read_input,
    get_session_info,
    log_request_to_mongo,
    log_chain_to_mongo,
    should_not_be_under_maintenance,
    only_whitelisted_ips,
    limit_rate,
    validate_input,
    handle_cancelled_request
)

# Models:
from models.core.auth_token import CoreAuthTokenModel
from models.api.sms.send import SMSSendRequestHeaders, SMSSendRequestData
from models.api.sms.send import (
    NimbusSMSIndiaMessage,
    SavvyBulkSMSKenyaMessage,
    SMSSendManyResults
)

# Common:
from shared import constants

# To work with datatypes:
from typing import List, Any

# To make HTTP requests:
import httpx

import asyncio


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                           MACROS / ONE-TIME INIT                                              ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# Related to Quart:
sms_send_bp = Blueprint("sms_send", __name__)


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                VARIABLES                                                      ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


# --- Nothing Yet


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                                  FUNCTIONS                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


@sms_send_bp.record_once
def init(blueprint_setup_state):

    # This gets called when the blueprint is registered.
    # Consider this to be a one-time setup for the whole blueprint:
    pass


# ---------------------------------------------------------------------------------------------------------------------


async def send_sms_messages(
        mongo_data_conn: AsyncMongo,
        auth_token: CoreAuthTokenModel,
        messages: List[NimbusSMSIndiaMessage | SavvyBulkSMSKenyaMessage],
        tags: List[Any]
) -> SMSSendManyResults:

    """
    This function purely tackles message sending. It is not concerned with authorization and security checks. Please
    ensure that you perform those checks before coming here.
    :param mongo_data_conn: The database connection to use to perform this task.
    :param auth_token: The auth token that will be used to send this message.
    :param messages: The list of messages to send out.
    :param tags: Any tags to attach with these SMS for filtering when querying in the listing service.
    :return: The structured result of sending many SMS messages.
    """

    # Start by assuming failure:
    results = SMSSendManyResults()

    # Select the right client:
    match auth_token.client:
        case "nimbusSmsIndia":
            results = await current_app.nimbus_sms_india_controller.send_many_sms(
                mongo_data_conn = mongo_data_conn,
                auth_token = auth_token,
                messages = messages,
                tags = tags
            )
        case "savvyBulkSmsKenya":
            results = await current_app.savvy_bulk_sms_kenya_controller.send_many_sms(
                mongo_data_conn = mongo_data_conn,
                auth_token = auth_token,
                messages = messages,
                tags = tags
            )
        case _:
            results.message = "Invalid/unimplemented SMS client."

    # Done here:
    return results


# ---------------------------------------------------------------------------------------------------------------------


@sms_send_bp.route("", methods = ["POST"])
@sms_send_bp.route("/send", methods = ["POST"])
@set_api_version(api_version = "1.0.0")
@read_input(sanitize_headers = False, sanitize_data = False)
@get_session_info(key = "X-Session-Token", session_coro = "get_session")
@log_request_to_mongo(
    attr_name = "logs_mongo",
    project = constants.PROJECT_NAME,
    log_type = constants.MODULE_NAME,
    operation = "smsSendApi",
    log_input = True,
    log_output = True,
    sensitive_keys = ["sessionToken", "X-Session-Token", "tokenKey"]
)
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@validate_input(
    header_validator = lambda x: SMSSendRequestHeaders(**x).model_dump(),
    data_validator = lambda x: SMSSendRequestData(**x)
)
@handle_cancelled_request()
async def send_sms_messages_api(
        inbound_headers: dict | SMSSendRequestHeaders = None,
        inbound_data: dict | SMSSendRequestData = None,
        inbound_files: dict = None,
        **kwargs
):

    """
    Use this API when someone wants to send one or more SMS messages.
    :param inbound_headers: auto-extracted by the decorators.
    :param inbound_data: auto-extracted by the decorators.
    :param inbound_files: auto-extracted by the decorators.
    :param kwargs: Any number of extra inputs supplied by the decorators.
    :return: A standard response structure.
    """

    # ┏┓   ┓   ┏┓┓    ┓
    # ┣┫┓┏╋┣┓  ┃ ┣┓┏┓┏┃┏
    # ┛┗┗┻┗┛┗  ┗┛┛┗┗ ┗┛┗

    # If the session token is invalid/expired:
    if kwargs.get("session_info") is None:
        return ResponseModel(
            status_code = StatusCodes.FAILED,
            http_code = HttpCodes.UNAUTHORIZED,
            message = "invalid session"
        )

    # Get the token  from the token key:
    auth_token = await current_app.sms_controller.get_token_from_key(
        mongo_data_conn = current_app.data_mongo,
        token_key = inbound_data.tokenKey
    )
    if auth_token is None: return ResponseModel(
        status_code = StatusCodes.FAILED,
        http_code = HttpCodes.UNAUTHORIZED,
        message = f"no such token key"
    )

    # ┏┓     ┓  ┏┳┓┓     ┏┓┳┳┓┏┓
    # ┗┓┏┓┏┓┏┫   ┃ ┣┓┏┓  ┗┓┃┃┃┗┓
    # ┗┛┗ ┛┗┗┻   ┻ ┛┗┗   ┗┛┛ ┗┗┛

    sending_results = await send_sms_messages(
        mongo_data_conn = current_app.data_mongo,
        auth_token = auth_token,
        messages = inbound_data.message,
        tags = inbound_data.tags
    )

    # ┳┓
    # ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
    # ┛┗┗ ┛┣┛┗┛┛┗┛┗
    #      ┛

    # Done here:
    success = True if sending_results.successCount else False
    return ResponseModel(
        status_code = StatusCodes.OK if success else StatusCodes.FAILED,
        http_code = HttpCodes.SUCCESS if success else HttpCodes.INTERNAL_SERVER_ERROR,
        data = {
            "successCount": sending_results.successCount,
            "failureCount": sending_results.failureCount,
            "totalCount": sending_results.totalCount,
        },
        message = sending_results.message
    )


#   *****************************************************************************************************************
#  *****                                                                                                          ****
# ***                                               MAIN PROGRAM                                                    ***
#  *****                                                                                                          ****
#   *****************************************************************************************************************


if __name__ == "__main__":

    pass