public
/
django_aws_ses
7
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

updates to settings.py

This commit is contained in:
Raymond Jessop 2025-04-18 14:33:58 -05:00
parent c2bb823bd4
commit 0d9aa2f4a7
1 changed files with 81 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

144
django_aws_ses/settings.py
View File

@ -1,12 +1,13 @@
import logging import logging
import os import os
from django.conf import settings
from django.conf import settings as django_settings
from django.contrib.sites.models import Site from django.contrib.sites.models import Site
from django.core.exceptions import ImproperlyConfigured from django.core.exceptions import ImproperlyConfigured
from .models import AwsSesSettings from .models import AwsSesSettings
# Define constants for default values # Default configuration values
DEFAULTS = { DEFAULTS = {
'AWS_SES_REGION_NAME': 'us-east-1', 'AWS_SES_REGION_NAME': 'us-east-1',
'AWS_SES_REGION_ENDPOINT': 'email.us-east-1.amazonaws.com', 'AWS_SES_REGION_ENDPOINT': 'email.us-east-1.amazonaws.com',
@ -20,43 +21,68 @@ DEFAULTS = {
'SES_BOUNCE_LIMIT': 1, 'SES_BOUNCE_LIMIT': 1,
'SES_BACKEND_DEBUG': False, 'SES_BACKEND_DEBUG': False,
'SES_BACKEND_DEBUG_LOGFILE_FORMATTER': '%(asctime)s - %(name)s - %(levelname)s - %(message)s', 'SES_BACKEND_DEBUG_LOGFILE_FORMATTER': '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
'DEFAULT_FROM_EMAIL': 'no_reply@example.com', 'DEFAULT_FROM_EMAIL': 'no-reply@example.com',
'UNSUBSCRIBE_TEMPLATE': 'django_aws_ses/unsubscribe.html', 'UNSUBSCRIBE_TEMPLATE': 'django_aws_ses/unsubscribe.html',
'BASE_TEMPLATE': 'django_aws_ses/base.html', 'BASE_TEMPLATE': 'django_aws_ses/base.html',
} }
# Selectively export key settings # Exported settings
__all__ = ( __all__ = (
'ACCESS_KEY', 'SECRET_KEY', 'AWS_SES_REGION_NAME', 'AWS_SES_REGION_ENDPOINT', 'ACCESS_KEY',
'AWS_SES_AUTO_THROTTLE', 'AWS_SES_RETURN_PATH', 'AWS_SES_CONFIGURATION_SET', 'SECRET_KEY',
'DKIM_DOMAIN', 'DKIM_PRIVATE_KEY', 'DKIM_SELECTOR', 'DKIM_HEADERS', 'AWS_SES_REGION_NAME',
'TIME_ZONE', 'BASE_DIR', 'SES_BOUNCE_LIMIT', 'SES_BACKEND_DEBUG', 'AWS_SES_REGION_ENDPOINT',
'SES_BACKEND_DEBUG_LOGFILE_PATH', 'SES_BACKEND_DEBUG_LOGFILE_FORMATTER', 'AWS_SES_AUTO_THROTTLE',
'DEFAULT_FROM_EMAIL', 'HOME_URL', 'UNSUBSCRIBE_TEMPLATE', 'BASE_TEMPLATE', 'AWS_SES_RETURN_PATH',
'VERIFY_BOUNCE_SIGNATURES', 'BOUNCE_CERT_DOMAINS', 'logger', 'AWS_SES_CONFIGURATION_SET',
'DKIM_DOMAIN',
'DKIM_PRIVATE_KEY',
'DKIM_SELECTOR',
'DKIM_HEADERS',
'TIME_ZONE',
'BASE_DIR',
'SES_BOUNCE_LIMIT',
'SES_BACKEND_DEBUG',
'SES_BACKEND_DEBUG_LOGFILE_PATH',
'SES_BACKEND_DEBUG_LOGFILE_FORMATTER',
'DEFAULT_FROM_EMAIL',
'HOME_URL',
'UNSUBSCRIBE_TEMPLATE',
'BASE_TEMPLATE',
'VERIFY_BOUNCE_SIGNATURES',
'BOUNCE_CERT_DOMAINS',
'logger',
) )
def get_aws_ses_settings(): def get_aws_ses_settings():
""" """Retrieve AwsSesSettings from the database for the current site.
Retrieve AwsSesSettings from the database for the current site.
Returns None if the settings cannot be retrieved. Returns:
AwsSesSettings: The settings object, or None if not found.
""" """
try: try:
return AwsSesSettings.objects.get(site_id=settings.SITE_ID) return AwsSesSettings.objects.get(site_id=django_settings.SITE_ID)
except (AwsSesSettings.DoesNotExist, AttributeError) as e: except (AwsSesSettings.DoesNotExist, AttributeError) as e:
logger.warning("Failed to retrieve AwsSesSettings: %s", e) logger.warning(f"Failed to retrieve AwsSesSettings: {e}")
return None return None
def configure_logger(debug, log_file_path, formatter): def configure_logger(debug, log_file_path, formatter):
""" """Configure the logger for the AWS SES app.
Configure the logger for the AWS SES app.
Sets up file logging if debug is enabled and a valid log file path is provided. Args:
debug (bool): Enable debug logging if True.
log_file_path (str): Path to the log file.
formatter (str): Logging formatter string.
Returns:
logging.Logger: Configured logger instance.
""" """
logger = logging.getLogger('django_aws_ses') logger = logging.getLogger('django_aws_ses')
logger.setLevel(logging.DEBUG if debug else logging.WARNING) logger.setLevel(logging.DEBUG if debug else logging.WARNING)
if debug and log_file_path: if debug and log_file_path:
# Validate log file path
log_dir = os.path.dirname(log_file_path) log_dir = os.path.dirname(log_file_path)
if log_dir and not os.path.exists(log_dir): if log_dir and not os.path.exists(log_dir):
os.makedirs(log_dir, exist_ok=True) os.makedirs(log_dir, exist_ok=True)
@ -67,87 +93,79 @@ def configure_logger(debug, log_file_path, formatter):
handler.setFormatter(formatter) handler.setFormatter(formatter)
logger.addHandler(handler) logger.addHandler(handler)
except OSError as e: except OSError as e:
logger.error("Failed to configure log file %s: %s", log_file_path, e) logger.error(f"Failed to configure log file {log_file_path}: {e}")
return logger return logger
# Initialize logger early to capture any setup errors
BASE_DIR = getattr(settings, 'BASE_DIR', None)
if not BASE_DIR:
raise ImproperlyConfigured(
"BASE_DIR must be defined in Django settings and point to the project root directory."
)
# Temporary logger for setup phase # Initialize logger
logger = logging.getLogger('django_aws_ses') logger = logging.getLogger('django_aws_ses')
# Validate BASE_DIR
BASE_DIR = getattr(django_settings, 'BASE_DIR', None)
if not BASE_DIR:
raise ImproperlyConfigured("BASE_DIR must be defined in Django settings.")
# Fetch AwsSesSettings from database # Fetch AwsSesSettings from database
aws_ses_settings = get_aws_ses_settings() aws_ses_settings = get_aws_ses_settings()
# AWS Credentials # AWS Credentials
ACCESS_KEY = aws_ses_settings.access_key if aws_ses_settings else getattr( ACCESS_KEY = aws_ses_settings.access_key if aws_ses_settings else getattr(
settings, 'AWS_SES_ACCESS_KEY_ID', getattr(settings, 'AWS_ACCESS_KEY_ID', None) django_settings, 'AWS_SES_ACCESS_KEY_ID', getattr(django_settings, 'AWS_ACCESS_KEY_ID', None)
) )
SECRET_KEY = aws_ses_settings.secret_key if aws_ses_settings else getattr( SECRET_KEY = aws_ses_settings.secret_key if aws_ses_settings else getattr(
settings, 'AWS_SES_SECRET_ACCESS_KEY', getattr(settings, 'AWS_SECRET_ACCESS_KEY', None) django_settings, 'AWS_SES_SECRET_ACCESS_KEY', getattr(django_settings, 'AWS_SECRET_ACCESS_KEY', None)
) )
# Validate credentials
if not (ACCESS_KEY and SECRET_KEY): if not (ACCESS_KEY and SECRET_KEY):
raise ImproperlyConfigured( raise ImproperlyConfigured(
"AWS SES credentials (ACCESS_KEY and SECRET_KEY) must be provided via AwsSesSettings or Django settings." "AWS SES credentials (AWS_SES_ACCESS_KEY_ID and AWS_SES_SECRET_ACCESS_KEY) must be provided "
"via AwsSesSettings or Django settings."
) )
# AWS SES Configuration # AWS SES Configuration
AWS_SES_REGION_NAME = aws_ses_settings.region_name if aws_ses_settings else getattr( AWS_SES_REGION_NAME = aws_ses_settings.region_name if aws_ses_settings else getattr(
settings, 'AWS_SES_REGION_NAME', getattr(settings, 'AWS_DEFAULT_REGION', DEFAULTS['AWS_SES_REGION_NAME']) django_settings, 'AWS_SES_REGION_NAME', DEFAULTS['AWS_SES_REGION_NAME']
) )
AWS_SES_REGION_ENDPOINT = aws_ses_settings.region_endpoint if aws_ses_settings else getattr( AWS_SES_REGION_ENDPOINT = aws_ses_settings.region_endpoint if aws_ses_settings else getattr(
settings, 'AWS_SES_REGION_ENDPOINT', DEFAULTS['AWS_SES_REGION_ENDPOINT'] django_settings, 'AWS_SES_REGION_ENDPOINT', DEFAULTS['AWS_SES_REGION_ENDPOINT']
) )
AWS_SES_AUTO_THROTTLE = getattr(settings, 'AWS_SES_AUTO_THROTTLE', DEFAULTS['AWS_SES_AUTO_THROTTLE']) AWS_SES_AUTO_THROTTLE = getattr(django_settings, 'AWS_SES_AUTO_THROTTLE', DEFAULTS['AWS_SES_AUTO_THROTTLE'])
AWS_SES_RETURN_PATH = getattr(settings, 'AWS_SES_RETURN_PATH', DEFAULTS['AWS_SES_RETURN_PATH']) AWS_SES_RETURN_PATH = getattr(django_settings, 'AWS_SES_RETURN_PATH', DEFAULTS['AWS_SES_RETURN_PATH'])
AWS_SES_CONFIGURATION_SET = getattr(settings, 'AWS_SES_CONFIGURATION_SET', DEFAULTS['AWS_SES_CONFIGURATION_SET']) AWS_SES_CONFIGURATION_SET = getattr(django_settings, 'AWS_SES_CONFIGURATION_SET', DEFAULTS['AWS_SES_CONFIGURATION_SET'])
# DKIM Settings # DKIM Settings
DKIM_DOMAIN = getattr(settings, 'DKIM_DOMAIN', None) DKIM_DOMAIN = getattr(django_settings, 'DKIM_DOMAIN', None)
DKIM_PRIVATE_KEY = getattr(settings, 'DKIM_PRIVATE_KEY', None) DKIM_PRIVATE_KEY = getattr(django_settings, 'DKIM_PRIVATE_KEY', None)
DKIM_SELECTOR = getattr(settings, 'DKIM_SELECTOR', DEFAULTS['DKIM_SELECTOR']) DKIM_SELECTOR = getattr(django_settings, 'DKIM_SELECTOR', DEFAULTS['DKIM_SELECTOR'])
DKIM_HEADERS = getattr(settings, 'DKIM_HEADERS', DEFAULTS['DKIM_HEADERS']) DKIM_HEADERS = getattr(django_settings, 'DKIM_HEADERS', DEFAULTS['DKIM_HEADERS'])
# Email Settings # Email Settings
try: try:
site = Site.objects.get_current() site = Site.objects.get_current()
DEFAULT_FROM_EMAIL = getattr(settings, 'DEFAULT_FROM_EMAIL', f"no-reply@{site.domain}") DEFAULT_FROM_EMAIL = getattr(django_settings, 'DEFAULT_FROM_EMAIL', f"no-reply@{site.domain}")
except Site.DoesNotExist: except Site.DoesNotExist:
DEFAULT_FROM_EMAIL = getattr(settings, 'DEFAULT_FROM_EMAIL', DEFAULTS['DEFAULT_FROM_EMAIL']) DEFAULT_FROM_EMAIL = getattr(django_settings, 'DEFAULT_FROM_EMAIL', DEFAULTS['DEFAULT_FROM_EMAIL'])
logger.warning( logger.warning(
"Django sites framework not configured. Using DEFAULT_FROM_EMAIL: %s. " f"Django sites framework not configured. Using DEFAULT_FROM_EMAIL: {DEFAULT_FROM_EMAIL}. "
"Configure the Site model or set DEFAULT_FROM_EMAIL in settings.", DEFAULT_FROM_EMAIL "Configure the Site model or set DEFAULT_FROM_EMAIL in settings."
) )
HOME_URL = getattr(settings, 'HOME_URL', '') # Other Settings
HOME_URL = getattr(django_settings, 'HOME_URL', '')
# Template Settings UNSUBSCRIBE_TEMPLATE = getattr(django_settings, 'UNSUBSCRIBE_TEMPLATE', DEFAULTS['UNSUBSCRIBE_TEMPLATE'])
UNSUBSCRIBE_TEMPLATE = getattr(settings, 'UNSUBSCRIBE_TEMPLATE', DEFAULTS['UNSUBSCRIBE_TEMPLATE']) BASE_TEMPLATE = getattr(django_settings, 'BASE_TEMPLATE', DEFAULTS['BASE_TEMPLATE'])
BASE_TEMPLATE = getattr(settings, 'BASE_TEMPLATE', DEFAULTS['BASE_TEMPLATE']) VERIFY_BOUNCE_SIGNATURES = getattr(django_settings, 'AWS_SES_VERIFY_BOUNCE_SIGNATURES', DEFAULTS['VERIFY_BOUNCE_SIGNATURES'])
BOUNCE_CERT_DOMAINS = getattr(django_settings, 'AWS_SNS_BOUNCE_CERT_TRUSTED_DOMAINS', DEFAULTS['BOUNCE_CERT_DOMAINS'])
# Bounce and Verification Settings SES_BOUNCE_LIMIT = getattr(django_settings, 'SES_BOUNCE_LIMIT', DEFAULTS['SES_BOUNCE_LIMIT'])
VERIFY_BOUNCE_SIGNATURES = getattr(settings, 'AWS_SES_VERIFY_BOUNCE_SIGNATURES', DEFAULTS['VERIFY_BOUNCE_SIGNATURES']) SES_BACKEND_DEBUG = getattr(django_settings, 'SES_BACKEND_DEBUG', DEFAULTS['SES_BACKEND_DEBUG'])
BOUNCE_CERT_DOMAINS = getattr(settings, 'AWS_SNS_BOUNCE_CERT_TRUSTED_DOMAINS', DEFAULTS['BOUNCE_CERT_DOMAINS'])
SES_BOUNCE_LIMIT = getattr(settings, 'SES_BOUNCE_LIMIT', DEFAULTS['SES_BOUNCE_LIMIT'])
# Debug Settings
SES_BACKEND_DEBUG = getattr(settings, 'SES_BACKEND_DEBUG', DEFAULTS['SES_BACKEND_DEBUG'])
SES_BACKEND_DEBUG_LOGFILE_PATH = getattr( SES_BACKEND_DEBUG_LOGFILE_PATH = getattr(
settings, 'SES_BACKEND_DEBUG_LOGFILE_PATH', os.path.join(BASE_DIR, 'aws_ses.log') django_settings, 'SES_BACKEND_DEBUG_LOGFILE_PATH', os.path.join(BASE_DIR, 'aws_ses.log')
) )
SES_BACKEND_DEBUG_LOGFILE_FORMATTER = getattr( SES_BACKEND_DEBUG_LOGFILE_FORMATTER = getattr(
settings, 'SES_BACKEND_DEBUG_LOGFILE_FORMATTER', DEFAULTS['SES_BACKEND_DEBUG_LOGFILE_FORMATTER'] django_settings, 'SES_BACKEND_DEBUG_LOGFILE_FORMATTER', DEFAULTS['SES_BACKEND_DEBUG_LOGFILE_FORMATTER']
) )
TIME_ZONE = django_settings.TIME_ZONE
# Timezone
TIME_ZONE = settings.TIME_ZONE
# Configure logger with final settings # Configure logger with final settings
logger = configure_logger(SES_BACKEND_DEBUG, SES_BACKEND_DEBUG_LOGFILE_PATH, SES_BACKEND_DEBUG_LOGFILE_FORMATTER) logger = configure_logger(SES_BACKEND_DEBUG, SES_BACKEND_DEBUG_LOGFILE_PATH, SES_BACKEND_DEBUG_LOGFILE_FORMATTER)