OSIT-AE-API-FastAPI/app/models/site_domain_models.py

import datetime, pytz

from typing import Dict, List, Optional, Set, Union
from pydantic import BaseModel, EmailStr, Field, Json, PrivateAttr, ValidationError, validator, root_validator

from app.db_sql import get_id_random, redis_lookup_id_random
from app.lib_general import log, logging

from app.models.common_field_schema import base_fields, default_num_bytes


# ### BEGIN ### API Site Domain Models ### Site_Domain_Base() ###
class Site_Domain_Base(BaseModel):
    log.setLevel(logging.WARNING) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL
    log.debug(locals())

    # --- Standardized Vision IDs (Strings) ---
    id: Optional[str] = Field(None, **base_fields['site_domain_id_random'])
    site_domain_id: Optional[str] = Field(None, **base_fields['site_domain_id_random'])
    site_id: Optional[str] = Field(None, **base_fields['site_id_random'])
    account_id: Optional[str] = Field(None, **base_fields['account_id_random'])

    fqdn: Optional[str]

    # restrict_access: Optional[bool]
    access_key: Optional[str]
    required_referrer: Optional[str]

    access_code_kv_json: Optional[Union[Json, None]]

    valid_for: Optional[int] # number of hours
    enable: Optional[bool]

    cfg_json: Optional[Union[Json, None]] # In use 2024-03-04

    hide: Optional[bool] = None # Field missing in physical table but common in views
    # priority: Optional[bool] # MISSING in physical table
    # sort: Optional[int] # MISSING in physical table
    # group: Optional[str] # MISSING in physical table

    notes: Optional[str] = None # MISSING in physical table
    created_on: Optional[datetime.datetime] = None
    updated_on: Optional[datetime.datetime] = None

    # Convenience fields from v_site_domain view (joined from account/site)
    account_code: Optional[str] = None
    account_name: Optional[str] = None
    account_enable: Optional[bool] = None
    account_enable_from: Optional[datetime.datetime] = None
    account_enable_to: Optional[datetime.datetime] = None

    site_enable_from: Optional[datetime.datetime] = None
    site_enable_to: Optional[datetime.datetime] = None
    site_domain_access_key: Optional[str] = None

    logo_path: Optional[str] = None
    style_href: Optional[str] = None
    script_src: Optional[str] = None

    google_tracking_id: Optional[str] = None

    _processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now)

    @root_validator(pre=True)
    def map_v3_ids(cls, values):
        """
        Vision Transformer:
        Map DB-centric keys to clean API keys and strip internal integers.
        """
        # 1. Map Random Strings to Clean Names
        # We prioritize the random strings to ensure the Vision is string-based.
        if rid := values.get('id_random') or values.get('site_domain_id_random'):
            values['id'] = rid
            values['site_domain_id'] = rid

        if s_rid := values.get('site_id_random'):
            values['site_id'] = s_rid

        if a_rid := values.get('account_id_random'):
            values['account_id'] = a_rid

        # 2. Prevent "Collision Population"
        for k in ['id', 'site_id', 'account_id']:
            if k in values and not isinstance(values[k], str):
                del values[k]

        return values

    class Config:
        underscore_attrs_are_private = True
        allow_population_by_field_name = False
# ### END ### API Site Domain Models ### Site_Domain_Base() ###


# ### BEGIN ### API Site Domain Models ### Site_Domain_FQDN_ID_Base() ###
class Site_Domain_FQDN_ID_Base(BaseModel):
    log.setLevel(logging.WARNING) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL
    log.debug(locals())

    # --- Standardized Vision IDs (Strings) ---
    id: Optional[str] = Field(None, **base_fields['site_domain_id_random'])
    site_domain_id: Optional[str] = Field(None, **base_fields['site_domain_id_random'])
    site_id: Optional[str] = Field(None, **base_fields['site_id_random'])
    account_id: Optional[str] = Field(None, **base_fields['account_id_random'])

    fqdn: Optional[str]

    # restrict_access: Optional[bool]
    access_key: Optional[str]
    required_referrer: Optional[str]

    access_code_kv_json: Optional[Union[Json, None]]

    valid_for: Optional[int] # number of hours
    enable: Optional[bool]

    hide: Optional[bool] = None

    notes: Optional[str] = None
    created_on: Optional[datetime.datetime] = None
    updated_on: Optional[datetime.datetime] = None

    # Including convenience data
    account_code: Optional[str] # Useful for export file naming
    account_name: Optional[str] # Generally useful for display
    account_enable: Optional[bool]
    account_enable_from: Optional[datetime.datetime]
    account_enable_to: Optional[datetime.datetime]

    site_enable_from: Optional[datetime.datetime]
    site_enable_to: Optional[datetime.datetime]
    site_domain_access_key: Optional[str]

    logo_path: Optional[str]
    style_href: Optional[str]
    script_src: Optional[str]

    google_tracking_id: Optional[str]

    cfg_json: Optional[Union[Json, None]] # In use 2024-03-04

    _processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now)

    @root_validator(pre=True)
    def map_v3_ids(cls, values):
        if rid := values.get('id_random') or values.get('site_domain_id_random'):
            values['id'] = rid
            values['site_domain_id'] = rid
        if s_rid := values.get('site_id_random'):
            values['site_id'] = s_rid
        if a_rid := values.get('account_id_random'):
            values['account_id'] = a_rid

        for k in ['id', 'site_id', 'account_id']:
            if k in values and not isinstance(values[k], str):
                del values[k]
        return values

    class Config:
        underscore_attrs_are_private = True
        allow_population_by_field_name = False
# ### END ### API Site Domain Models ### Site_Domain_FQDN_ID_Base() ###