"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Thursday, 19th Dec., 2024

    OBJECTIVE:

        To update tags on SMS messages.

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

# Common:
from shared import constants

# Data Models:
from models.core.user import CoreUserInfoModel
from models.api.sms.tags import SMSUpdateTagsRequestHeaders, SMSUpdateTagsRequestData

# Helpers:
from api.helpers.user import token_check

# To work with MongoDB:
from bson import ObjectId

# For asynchronous activities:
import asyncio


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


# Related to Quart:
sms_update_tags_bp = Blueprint("sms_upd_tags", __name__)


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


# --- Nothing Yet


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


@sms_update_tags_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


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


@sms_update_tags_bp.route("/tags", methods = ["PATCH"])
@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 = "smsUpdTagsApi",
    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: SMSUpdateTagsRequestHeaders(**x).model_dump(),
    data_validator = lambda x: SMSUpdateTagsRequestData(**x)
)
@handle_cancelled_request()
async def update_sms_tags(
        inbound_headers: dict | SMSUpdateTagsRequestHeaders = None,
        inbound_data: dict | SMSUpdateTagsRequestData = None,
        inbound_files: dict = None,
        **kwargs
):

    """
    Use this APi when the user wants to update the tags on one SMS.
    :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
        )

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

    # Get the message:
    message = await current_app.sms_controller.get_message(
        mongo_data_conn = current_app.data_mongo,
        message_id = inbound_data.messageId
    )

    # ┏┓          ┓ •    ┏┓┓    ┓
    # ┃┃┓┏┏┏┓┏┓┏┓┏┣┓┓┏┓  ┃ ┣┓┏┓┏┃┏
    # ┗┛┗┻┛┛┗┗ ┛ ┛┛┗┗┣┛  ┗┛┛┗┗ ┗┛┗
    #                ┛

    # Check if the token(s) belong to the user claiming ownership:
    if not await token_check.is_authorized(
        mongo_conn = current_app.data_mongo,
        user_info = CoreUserInfoModel(**kwargs["session_info"]),
        token_ids = [message.tokenId]
    ): return ResponseModel(
        status_code = StatusCodes.FAILED,
        http_code = HttpCodes.UNAUTHORIZED,
        message = "User doesn't have rights to this message."
    )

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

    # Update the message:
    success = await current_app.sms_controller.update_tags(
        mongo_data_conn = current_app.data_mongo,
        message_id = inbound_data.messageId,
        unset_tags = inbound_data.unsetTags,
        set_tags = inbound_data.setTags
    )

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

    # Done here:
    return ResponseModel(
        status_code = StatusCodes.OK if success else StatusCodes.FAILED,
        http_code = HttpCodes.SUCCESS if success else HttpCodes.INTERNAL_SERVER_ERROR
    )


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


if __name__ == "__main__":

    pass
