(20250116) Started upgrading the mail module (to eventually work on cron).

controllers_v2/message/mail/base.py

@@ -0,0 +1,224 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Thursday, 16th Jan., 2025.
+
+    OBJECTIVE:
+
+        To handle all mail-related behaviour from one place. The initially known client is only Gmail.
+
+    REFERENCES:
+
+        N/A
+
+    DOWNLOADS:
+
+        N/A
+
+"""
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                   IMPORT                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# To make sibling directories accessible for imports:
+import sys
+sys.path.append(".")
+sys.path.append("..")
+
+# My async utils:
+from utils_v2.database.async_mongo_v2 import AsyncMongo
+from utils_v2.database.async_mysql_v2 import AsyncMySQL
+from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache
+
+# Controllers:
+from controllers_v2.core.message import CoreMessageController
+
+# Models:
+from models.core.user import CoreUserInfoModel
+from models.core.auth_token import CoreAuthTokenModel
+from models.api.message.mail.oauth import (
+    OAuthMailAuthorizationRequestHeaders,
+    OAuthMailAuthorizationRequestData
+)
+from models.message.mail.oauth import OAuthMailGetAuthorizationURLResponse
+
+# Mail Client(s):
+from utils_v2.goog.controllers.gmail.gmail_client import AsyncGMailClient
+
+# To work with datatypes:
+from typing import List, Any
+
+# To make HTTP requests:
+import httpx
+
+# To make abstract classes:
+from abc import ABC, abstractmethod
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                   CLASSES                                                     ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+class MailController(CoreMessageController, ABC):
+
+    # ┏┓
+    # ┃ ┏┓┏┓┏╋┏┓┓┏┏╋┏┓┏┓
+    # ┗┛┗┛┛┗┛┗┛ ┗┻┗┗┗┛┛
+
+    def __init__(
+            self,
+            cache: AsyncRedisCache = None,
+            http_client: httpx.AsyncClient = None,
+            alert_url: str = None,
+            base_filter: dict = None,
+            debug: bool = True,
+            debug_prefix: str = "Mail (C) | ",
+            debug_only_errors: bool = True
+    ):
+
+        """
+        This is the foundational controller for all mail services. This is built on top of the core message controller,
+        and, in turn, all individual mail client controllers must be built on top of this.
+        :param cache: The object to use for caching results from database calls.
+        :param http_client: The HTTP client
+        :param base_filter: The basic filter that will be applied to all fetching/updating queries. WARNING: THE BASE
+            FILTER WILL ALWAYS BE APPLIED AUTOMATICALLY. SET THIS UP WISELY.
+        :param debug: Whether, or not, you would like to print debugging messages:
+        :param debug_prefix: The prefix to print with the debugging messages.
+        :param debug_only_errors: Whether you would like to print only error messages or all messages.
+        :return: None.
+        """
+
+        # Prepare the combined base filter:
+        sms_filter = {}
+        for k, v in (base_filter or {}).items(): sms_filter[k] = v
+        sms_filter["serviceType"] = "sms"
+
+        # Invoke the parent's constructor:
+        CoreMessageController.__init__(
+            self,
+            cache = cache,
+            alert_url = alert_url,
+            http_client = http_client,
+            base_filter = sms_filter,
+            debug = debug,
+            debug_prefix = debug_prefix,
+            debug_only_errors = debug_only_errors
+        )
+
+    # ┏┓┏┓   ┓ ┏┓ ┏┓
+    # ┃┃┣┫┓┏╋┣┓┏┛ ┃┫
+    # ┗┛┛┗┗┻┗┛┗┗━•┗┛
+
+    @abstractmethod
+    async def get_authorization_url(
+            self,
+            sql_conn: AsyncMySQL,
+            mongo_data_conn: AsyncMongo,
+            mail_client: AsyncGMailClient,
+            user_info: CoreUserInfoModel,
+            inbound_data: OAuthMailAuthorizationRequestData,
+            session_token: str
+    ) -> OAuthMailGetAuthorizationURLResponse:
+
+        """
+        To accept an incoming request for mail integration and provide a URL that the user can use to authorize your
+        service to access his mail inbox.
+        :param sql_conn: The database connection to use to perform this task.
+        :param mongo_data_conn: The database connection to use to perform this task.
+        :param mail_client: The instance of the third-party mail client that will be used to get the URL.
+        :param user_info: The information about your user who is trying to use this system.
+        :param inbound_data: The data that came in with the request (API call).
+        :param session_token: The session token of the user.
+        :return: A structure response with details about the URL generation process.
+        """
+
+        pass
+
+    # ┳┳┓  •┓  ┏┓            •    •
+    # ┃┃┃┏┓┓┃  ┗┓┓┏┏┳┓┏┳┓┏┓┏┓┓┓┏┓╋┓┏┓┏┓
+    # ┛ ┗┗┻┗┗  ┗┛┗┻┛┗┗┛┗┗┗┻┛ ┗┗┗┻┗┗┗┛┛┗
+
+    pass
+
+    # ┳┳┓  •┓  ┏┓     ╹•
+    # ┃┃┃┏┓┓┃  ┗┓┓┏┏┓┏ ┓┏┓┏┓
+    # ┛ ┗┗┻┗┗  ┗┛┗┫┛┗┗ ┗┛┗┗┫
+    #             ┛        ┛
+
+    # To synchronize the mails on the third-party client's server and your server. You are effectively making a copy of
+    # the mail on your database.
+
+    pass
+
+    # ┳┳┓  •┓  ┓ •  •
+    # ┃┃┃┏┓┓┃  ┃ ┓┏╋┓┏┓┏┓
+    # ┛ ┗┗┻┗┗  ┗┛┗┛┗┗┛┗┗┫
+    #                   ┛
+
+    # Use these to show your users their mails once the mails are on your server. This would include activities like
+    # listing mails, showing full mails, showing mail trails, etc.
+
+    pass
+
+    # ┳┳┓  •┓  ┏┓     ┓•
+    # ┃┃┃┏┓┓┃  ┗┓┏┓┏┓┏┫┓┏┓┏┓
+    # ┛ ┗┗┻┗┗  ┗┛┗ ┛┗┗┻┗┛┗┗┫
+    #                      ┛
+
+    pass
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass