125 lines
3.8 KiB
Python
125 lines
3.8 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import string
|
|
import warnings
|
|
|
|
from django.core.exceptions import ImproperlyConfigured, ValidationError
|
|
from django.db import models
|
|
from django.db.models.signals import pre_save, pre_delete
|
|
from django.utils.deprecation import RemovedInDjango19Warning
|
|
from django.utils.encoding import python_2_unicode_compatible
|
|
from django.utils.translation import ugettext_lazy as _
|
|
|
|
from .requests import RequestSite as RealRequestSite
|
|
from .shortcuts import get_current_site as real_get_current_site
|
|
|
|
|
|
SITE_CACHE = {}
|
|
|
|
|
|
def _simple_domain_name_validator(value):
|
|
"""
|
|
Validates that the given value contains no whitespaces to prevent common
|
|
typos.
|
|
"""
|
|
if not value:
|
|
return
|
|
checks = ((s in value) for s in string.whitespace)
|
|
if any(checks):
|
|
raise ValidationError(
|
|
_("The domain name cannot contain any spaces or tabs."),
|
|
code='invalid',
|
|
)
|
|
|
|
|
|
class SiteManager(models.Manager):
|
|
|
|
def _get_site_by_id(self, site_id):
|
|
if site_id not in SITE_CACHE:
|
|
site = self.get(pk=site_id)
|
|
SITE_CACHE[site_id] = site
|
|
return SITE_CACHE[site_id]
|
|
|
|
def _get_site_by_request(self, request):
|
|
host = request.get_host()
|
|
if host not in SITE_CACHE:
|
|
site = self.get(domain__iexact=host)
|
|
SITE_CACHE[host] = site
|
|
return SITE_CACHE[host]
|
|
|
|
def get_current(self, request=None):
|
|
"""
|
|
Returns the current Site based on the SITE_ID in the project's settings.
|
|
If SITE_ID isn't defined, it returns the site with domain matching
|
|
request.get_host(). The ``Site`` object is cached the first time it's
|
|
retrieved from the database.
|
|
"""
|
|
from django.conf import settings
|
|
if getattr(settings, 'SITE_ID', ''):
|
|
site_id = settings.SITE_ID
|
|
return self._get_site_by_id(site_id)
|
|
elif request:
|
|
return self._get_site_by_request(request)
|
|
|
|
raise ImproperlyConfigured(
|
|
"You're using the Django \"sites framework\" without having "
|
|
"set the SITE_ID setting. Create a site in your database and "
|
|
"set the SITE_ID setting or pass a request to "
|
|
"Site.objects.get_current() to fix this error."
|
|
)
|
|
|
|
def clear_cache(self):
|
|
"""Clears the ``Site`` object cache."""
|
|
global SITE_CACHE
|
|
SITE_CACHE = {}
|
|
|
|
|
|
@python_2_unicode_compatible
|
|
class Site(models.Model):
|
|
|
|
domain = models.CharField(_('domain name'), max_length=100,
|
|
validators=[_simple_domain_name_validator])
|
|
name = models.CharField(_('display name'), max_length=50)
|
|
objects = SiteManager()
|
|
|
|
class Meta:
|
|
db_table = 'django_site'
|
|
verbose_name = _('site')
|
|
verbose_name_plural = _('sites')
|
|
ordering = ('domain',)
|
|
|
|
def __str__(self):
|
|
return self.domain
|
|
|
|
|
|
class RequestSite(RealRequestSite):
|
|
def __init__(self, *args, **kwargs):
|
|
warnings.warn(
|
|
"Please import RequestSite from django.contrib.sites.requests.",
|
|
RemovedInDjango19Warning, stacklevel=2)
|
|
super(RequestSite, self).__init__(*args, **kwargs)
|
|
|
|
|
|
def get_current_site(request):
|
|
warnings.warn(
|
|
"Please import get_current_site from django.contrib.sites.shortcuts.",
|
|
RemovedInDjango19Warning, stacklevel=2)
|
|
return real_get_current_site(request)
|
|
|
|
|
|
def clear_site_cache(sender, **kwargs):
|
|
"""
|
|
Clears the cache (if primed) each time a site is saved or deleted
|
|
"""
|
|
instance = kwargs['instance']
|
|
try:
|
|
del SITE_CACHE[instance.pk]
|
|
except KeyError:
|
|
pass
|
|
try:
|
|
del SITE_CACHE[Site.objects.get(pk=instance.pk).domain]
|
|
except (KeyError, Site.DoesNotExist):
|
|
pass
|
|
pre_save.connect(clear_site_cache, sender=Site)
|
|
pre_delete.connect(clear_site_cache, sender=Site)
|