"""

    AUTHOR:

        Khushal P Soonderji

    DATE:

        Tuesday, 17th Dec., 2024

    OBJECTIVE:

        To list payment records that are already present in our database.

    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

# To work with MongoDB:
from bson.objectid import ObjectId

# Data Models:
from models.api.finstitutions.payments.list import PGPaymentListHeaders, PGPaymentListData
from models.core.auth_token import CoreAuthTokenModel
from models.core.payment import CorePaymentModel, PaymentEvent

# For asynchronous activities:
import asyncio


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


# Related to Quart:
pg_list_bp = Blueprint("pg_list", __name__)


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


# --- Nothing Yet


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


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


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


@pg_list_bp.route("/list", methods = ["GET"])
@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 = "pgListApi",
    log_input = True,
    log_output = 1,
    sensitive_keys = ["sessionToken", "X-Session-Token"]
)
@log_chain_to_mongo(attr_name = "logs_mongo")
@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
@validate_input(
    header_validator = lambda x: PGPaymentListHeaders(**x).model_dump(),
    data_validator = lambda x: PGPaymentListData(**x)
)
@handle_cancelled_request()
async def payment_list(
        inbound_headers: dict | PGPaymentListHeaders = None,
        inbound_data: dict | PGPaymentListData = None,
        inbound_files: dict = None,
        **kwargs
):

    """
    To filter and enlist payment records here.
    :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 ids from the token keys:
    auth_tokens = await current_app.payment_controller.get_tokens(
        mongo_conn = current_app.data_mongo,
        token_keys = inbound_data.tokenKeys
    )
    token_ids = [t.authTokenId for t in auth_tokens]

    print("TOKEN IDS:", json.to_string(token_ids, default = str))

    # Build the additional filter:
    additional_filter = {}
    if inbound_data.tags: additional_filter["tags"] = {"$in": inbound_data.tags}
    if inbound_data.paymentStatus: additional_filter["lastPaymentStatus"] = {"$in": inbound_data.paymentStatus}
    additional_filter = additional_filter or None

    print("ADDFIL:", json.to_string(additional_filter))

    # Get the mails:
    payment_records = await current_app.payment_controller.list_payments(
        mongo_conn = current_app.data_mongo,
        token_ids = token_ids,
        limit = inbound_data.count,
        skip = inbound_data.fromCount,
        additional_filter = additional_filter
    )

    # Done here:
    return ResponseModel(
        status_code = StatusCodes.OK if payment_records else StatusCodes.FAILED,
        http_code = HttpCodes.SUCCESS if payment_records else HttpCodes.NOT_FOUND,
        data = [record.preview for record in payment_records],
        message = f"{len(payment_records) if payment_records else 0} records(s) found"
    )


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


if __name__ == "__main__":

    pass
