(20241206) Started Telegram integration.

2024-12-06 10:40:36 +05:30
parent 7fb90bc948
commit c260529ef2
7 changed files with 585 additions and 1 deletions
@@ -0,0 +1,196 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Friday, 6th Dec., 2024
+
+    OBJECTIVE:
+
+        To register a telegram bot with our system and send a request to Telegram to set it up the webhook.
+
+    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, render_template
+
+# 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
+)
+
+# Data Models:
+from models.data.chat.auth import ChatAuthRequestHeaders, ChatAuthRequestData
+
+# Common:
+from shared import constants
+
+# For asynchronous activities:
+import asyncio
+
+# For random choices:
+import random
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# Related to Quart:
+chat_webhook_bp = Blueprint("chat_whook_bp", __name__)
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+@chat_webhook_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
+
+
+# ---------------------------------------------------------------------------------------------------------------------
+
+
+@chat_webhook_bp.route("/webhook/<token_id>", methods = ["POST", "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 = "chatWHookApi",
+    log_input = True,
+    log_output = True,
+    sensitive_keys = None
+)
+@log_chain_to_mongo(attr_name = "logs_mongo")
+@should_not_be_under_maintenance(attr_name = "is_under_maintenance")
+# @validate_input(
+#     header_validator = lambda x: ChatAuthRequestHeaders(**x).model_dump(),
+#     data_validator = lambda x: ChatAuthRequestData(**x)
+# )
+@handle_cancelled_request()
+async def callback_test(
+        token_id: str = None,
+        inbound_headers: dict = None,
+        inbound_data: dict = None,
+        inbound_files: dict = None,
+        **kwargs
+):
+    """
+    This URL receives messages from chatbots as webhooks.
+    :param token_id: The identifier of the bot.
+    :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.
+    """
+
+    # Construct a message:
+    message = "🪝 *WEBHOOK/CALLBACK ALERT!* 🪝\n\n"
+    message += f"Method: *{request.method}*\nLog Id.: `{kwargs.get('log_id')}`\n\n"
+    message += "*Headers:*\n```json\n"
+    message += json.to_string({k: v for k, v in request.headers.items()})
+    message += "\n```\n"
+    message += "*Query Args:*\n```json\n"
+    message += json.to_string(request.args.to_dict())
+    message += "\n```\n"
+    message += "*JSON:*\n```json\n"
+    message += json.to_string(await request.get_json())
+    message += "\n```\n"
+    message += "*Form-Data:*\n```json\n"
+    message += json.to_string((await request.form).to_dict())
+    message += "\n```\n"
+    message += "*Form-Files:*\n```json\n"
+    message += json.to_string(inbound_files, default=str)
+    message += "\n```\n"
+
+    # Send a message on Telegram:
+    api_response = await current_app.http_client.post(
+        url = current_app.script_data["alerts"]["url"],
+        json = {
+            "message": message,
+            "type": "info",
+            "chatId": "1275560043"  # ... KPS
+        }
+    )
+
+    # Return a success response:
+    return ResponseModel(
+        status_code = StatusCodes.OK,
+        data = {"accepted": True}
+    )
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass