yatmesh
230 lines
8.8 KiB
Python
230 lines
8.8 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Omkar Khandare
|
|
|
|
DATE:
|
|
|
|
Friday, 4th July., 2025.
|
|
|
|
OBJECTIVE:
|
|
|
|
To receive authorization requests (OAuth2.0) for various mail providers and accordingly respond with the
|
|
authorization request URLs.
|
|
|
|
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
|
|
)
|
|
|
|
# GMail-related utils:
|
|
from utils_v2.goog.controllers.gmail.gmail_client import SCOPES_GMAIL_MAIL_MANAGEMENT
|
|
|
|
# Common:
|
|
from shared import constants
|
|
|
|
# Data Models:
|
|
from models.core.user import CoreUserInfoModel
|
|
from models.api.software.places.oauth import (
|
|
OAuthPlacesAuthorizationRequestHeaders,
|
|
OAuthPlacesAuthorizationRequestData
|
|
)
|
|
from models.core.auth_token import CoreAuthTokenModel
|
|
|
|
# For asynchronous activities:
|
|
import asyncio
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# Related to Quart:
|
|
places_oauth_request_bp = Blueprint("places_oauth", __name__)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
@places_oauth_request_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
|
|
|
|
|
|
# ---------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
@places_oauth_request_bp.route("/oauth", 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 = "placesOAuthUrlReqApi",
|
|
log_input = True,
|
|
log_output = True,
|
|
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: OAuthPlacesAuthorizationRequestHeaders(**x).model_dump(),
|
|
data_validator = lambda x: OAuthPlacesAuthorizationRequestData(**x)
|
|
)
|
|
@handle_cancelled_request()
|
|
async def request_oauth_authorization_url(
|
|
inbound_headers: dict | OAuthPlacesAuthorizationRequestHeaders = None,
|
|
inbound_data: dict | OAuthPlacesAuthorizationRequestData = None,
|
|
inbound_files: dict = None,
|
|
**kwargs
|
|
):
|
|
|
|
"""
|
|
Use this when requesting access to someone's GMail account. This API should be used from the UI. A button click
|
|
"Connect to GMail" should hit this API, which will generate a request to gain access to the user's GMail account.
|
|
When the URL is hit, it opens Google's own UI, and, when the user clicks "Continue", Google hits your 'redirect_url'
|
|
to inform you about the user's action.
|
|
: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
|
|
)
|
|
|
|
# ┳┓ ┳┳┓ •┓ ┏┓┓•
|
|
# ┣┫┏┓┓┏╋┏┓ ╋┏┓ ┃┃┃┏┓┓┃ ┃ ┃┓┏┓┏┓╋
|
|
# ┛┗┗┛┗┻┗┗ ┗┗┛ ┛ ┗┗┻┗┗ ┗┛┗┗┗ ┛┗┗
|
|
|
|
# Start by assuming failure:
|
|
client_controller = None
|
|
client_connector = None
|
|
client_response = None
|
|
|
|
# Figure out the client connector:
|
|
match inbound_data.client:
|
|
case "googlePlaces": client_controller, client_connector = current_app.places_controller, current_app.google_places_client
|
|
case _: client_controller, client_connector = None, None
|
|
|
|
# If a client connector was matched:
|
|
if client_controller is not None and client_connector is not None:
|
|
client_response = await client_controller.get_authorization_url(
|
|
sql_conn = current_app.sql_writer,
|
|
mongo_data_conn = current_app.data_mongo,
|
|
client = client_connector,
|
|
user_info = CoreUserInfoModel(**kwargs["session_info"]),
|
|
inbound_data = inbound_data,
|
|
session_token = inbound_headers["X-Session-Token"]
|
|
)
|
|
|
|
# ┳┓
|
|
# ┣┫┏┓┏┏┓┏┓┏┓┏┏┓
|
|
# ┛┗┗ ┛┣┛┗┛┛┗┛┗
|
|
# ┛
|
|
|
|
# Unknown client:
|
|
if client_controller is None or client_connector is None: return ResponseModel(
|
|
status_code = StatusCodes.FAILED,
|
|
http_code = HttpCodes.BAD_REQUEST,
|
|
message = f"Unknown/unimplemented client '{inbound_data.client}'."
|
|
)
|
|
|
|
# Known client (could be a success or a failure):
|
|
return ResponseModel(
|
|
status_code = StatusCodes.OK if client_response.success else StatusCodes.FAILED,
|
|
http_code = HttpCodes.SUCCESS if client_response.success else HttpCodes.INTERNAL_SERVER_ERROR,
|
|
message = client_response.message,
|
|
data = {
|
|
"client": inbound_data.client,
|
|
"authorizationUrl": client_response.url
|
|
} if client_response.success else None
|
|
)
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|