Структура «сайто⻶

Пример использования¶

Зачем использовать сайты? Лучше всего это объяснить на примерах.

from django.contrib.sites.models import Site
from django.db import models

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    sites = models.ManyToManyField(Site)

from django.contrib.sites.models import Site
from django.db import models

class Article(models.Model):
    headline = models.CharField(max_length=200)
    # ...
    site = models.ForeignKey(Site, on_delete=models.CASCADE)

from django.conf import settings

def my_view(request):
    if settings.SITE_ID == 3:
        # Do something.
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.shortcuts import get_current_site

def my_view(request):
    current_site = get_current_site(request)
    if current_site.domain == 'foo.com':
        # Do something
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.models import Site

def my_function_without_request():
    current_site = Site.objects.get_current()
    if current_site.domain == 'foo.com':
        # Do something
        pass
    else:
        # Do something else.
        pass

from django.contrib.sites.shortcuts import get_current_site
from django.core.mail import send_mail

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    current_site = get_current_site(request)
    send_mail(
        'Thanks for subscribing to %s alerts' % current_site.name,
        'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % (
            current_site.name,
        ),
        'editor@%s' % current_site.domain,
        [user.email],
    )

    # ...

from django.core.mail import send_mail
from django.template import loader

def register_for_newsletter(request):
    # Check form values, etc., and subscribe the user.
    # ...

    subject = loader.get_template('alerts/subject.txt').render({})
    message = loader.get_template('alerts/message.txt').render({})
    send_mail(subject, message, 'editor@ljworld.com', [user.email])

    # ...

>>> from django.contrib.sites.models import Site
>>> obj = MyModel.objects.get(id=3)
>>> obj.get_absolute_url()
'/mymodel/objects/3/'
>>> Site.objects.get_current().domain
'example.com'
>>> 'https://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())
'https://example.com/mymodel/objects/3/'

Включение рамок сайтов¶

Чтобы включить каркас сайтов, выполните следующие действия:

1. Добавьте 'django.contrib.sites' к настройке INSTALLED_APPS.

2. Определите настройку SITE_ID:

   SITE_ID = 1
   

3. Выполнить migrate.

django.contrib.sites регистрирует обработчик сигнала post_migrate, который создает сайт по умолчанию с именем example.com с доменом example.com. Этот сайт также будет создан после того, как Django создаст тестовую базу данных. Чтобы задать правильное имя и домен для вашего проекта, вы можете использовать data migration.

Чтобы обслуживать разные сайты в продакшене, вы должны создать отдельный файл настроек с каждым SITE_ID (возможно, импортируя его из общего файла настроек, чтобы избежать дублирования общих настроек) и затем указать соответствующий DJANGO_SETTINGS_MODULE для каждого сайта.

Кэширование текущего объекта Site¶

Поскольку текущий сайт хранится в базе данных, каждый вызов Site.objects.get_current() может привести к запросу к базе данных. Но Django немного умнее: при первом запросе текущий сайт кэшируется, и любой последующий вызов возвращает кэшированные данные вместо обращения к базе данных.

Если по какой-то причине вы хотите принудительно выполнить запрос к базе данных, вы можете сказать Django очистить кэш, используя Site.objects.clear_cache():

# First call; current site fetched from database.
current_site = Site.objects.get_current()
# ...

# Second call; current site fetched from cache.
current_site = Site.objects.get_current()
# ...

# Force a database query for the third call.
Site.objects.clear_cache()
current_site = Site.objects.get_current()

CurrentSiteManager¶

class managers.CurrentSiteManager¶

Если Site играет ключевую роль в вашем приложении, рассмотрите возможность использования полезной CurrentSiteManager в вашей модели (моделях). Это модель manager, которая автоматически фильтрует свои запросы, чтобы включить только объекты, связанные с текущим Site.

Используйте CurrentSiteManager, добавив его в модель в явном виде. Например:

from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
from django.db import models

class Photo(models.Model):
    photo = models.FileField(upload_to='photos')
    photographer_name = models.CharField(max_length=100)
    pub_date = models.DateField()
    site = models.ForeignKey(Site, on_delete=models.CASCADE)
    objects = models.Manager()
    on_site = CurrentSiteManager()

В этой модели Photo.objects.all() вернет все Photo объекты в базе данных, но Photo.on_site.all() вернет только Photo объекты, связанные с текущим сайтом, в соответствии с настройкой SITE_ID.

Говоря иначе, эти два утверждения эквивалентны:

Photo.objects.filter(site=settings.SITE_ID)
Photo.on_site.all()

Как CurrentSiteManager узнал, какое поле из Photo является Site? По умолчанию CurrentSiteManager ищет для фильтрации либо ForeignKey с именем site, либо ManyToManyField с именем sites. Если вы используете поле с именем, отличным от site или sites, чтобы определить, с какими Site объектами связан ваш объект, то вам нужно явно передать имя пользовательского поля в качестве параметра в CurrentSiteManager в вашей модели. Следующая модель, которая имеет поле с именем publish_on, демонстрирует это:

from django.contrib.sites.models import Site
from django.contrib.sites.managers import CurrentSiteManager
from django.db import models

class Photo(models.Model):
    photo = models.FileField(upload_to='photos')
    photographer_name = models.CharField(max_length=100)
    pub_date = models.DateField()
    publish_on = models.ForeignKey(Site, on_delete=models.CASCADE)
    objects = models.Manager()
    on_site = CurrentSiteManager('publish_on')

Если вы попытаетесь использовать CurrentSiteManager и передадите несуществующее имя поля, Django выдаст ошибку ValueError.

Наконец, обратите внимание, что вы, вероятно, захотите сохранить обычный (не специфичный для сайта) Manager на вашей модели, даже если вы используете CurrentSiteManager. Как объяснялось в manager documentation, если вы определите менеджер вручную, то Django не создаст для вас автоматический objects = models.Manager() менеджер. Также обратите внимание, что некоторые части Django - а именно, административный сайт Django и общие представления - используют тот менеджер, который определен первым в модели, поэтому если вы хотите, чтобы ваш административный сайт имел доступ ко всем объектам (а не только к объектам конкретного сайта), поместите objects = models.Manager() в вашу модель, прежде чем определять CurrentSiteManager.

Промежуточное программное обеспечение сайта¶

Если вы часто используете этот узор:

from django.contrib.sites.models import Site

def my_view(request):
    site = Site.objects.get_current()
    ...

Чтобы избежать повторений, добавьте django.contrib.sites.middleware.CurrentSiteMiddleware к MIDDLEWARE. Промежуточное ПО устанавливает атрибут site на каждом объекте запроса, поэтому вы можете использовать request.site для получения текущего сайта.

Как Django использует фреймворк для сайтов¶

Хотя использование фреймворка sites не является обязательным, оно настоятельно рекомендуется, поскольку Django использует его преимущества в нескольких местах. Даже если ваша установка Django поддерживает только один сайт, вы должны потратить две секунды на создание объекта site с помощью ваших domain и name, и указать его ID в настройках SITE_ID.

Вот как Django использует фреймворк сайтов:

• В redirects framework каждый объект редиректа связан с определенным сайтом. Когда Django ищет перенаправление, он учитывает текущий сайт.
• В flatpages framework каждая плоская страница связана с определенным сайтом. Когда создается плоская страница, вы указываете ее Site, а FlatpageFallbackMiddleware проверяет текущий сайт при поиске плоских страниц для отображения.
• В syndication framework шаблоны для title и description автоматически получают доступ к переменной {{ site }}, которая является Site объектом, представляющим текущий сайт. Кроме того, хук для предоставления URL элементов будет использовать domain из текущего объекта Site, если вы не укажете полностью определенный домен.
• В authentication framework, django.contrib.auth.views.LoginView передает текущее Site имя шаблону как {{ site_name }}.
• Представление ярлыка (django.contrib.contenttypes.views.shortcut) использует домен текущего объекта Site при вычислении URL объекта.
• В админке ссылка «view on site» использует текущее значение Site для определения домена сайта, на который она будет перенаправлять.

RequestSite объекты¶

Некоторые приложения django.contrib используют преимущества фреймворка сайтов, но построены таким образом, что не требуют установки фреймворка сайтов в вашей базе данных. (Некоторые люди не хотят или просто не могут установить дополнительную таблицу базы данных, которую требует фреймворк сайтов). Для таких случаев фреймворк предоставляет класс django.contrib.sites.requests.RequestSite, который можно использовать в качестве запасного варианта, когда фреймворк сайтов, поддерживаемый базой данных, недоступен.

class requests.RequestSite¶

Класс, который разделяет основной интерфейс Site (т.е. имеет атрибуты domain и name), но получает свои данные из объекта Django HttpRequest, а не из базы данных.

__init__(request)¶

Устанавливает атрибуты name и domain в значение get_host().

Объект RequestSite имеет такой же интерфейс, как и обычный объект Site, за исключением того, что его метод __init__() принимает объект HttpRequest. Он способен вывести domain и name, глядя на домен запроса. У него есть методы save() и delete(), соответствующие интерфейсу Site, но эти методы вызывают NotImplementedError.

get_current_site ярлык¶

Наконец, чтобы избежать повторяющегося кода возврата, фреймворк предоставляет функцию django.contrib.sites.shortcuts.get_current_site().

shortcuts.get_current_site(request)¶

Функция, которая проверяет, установлен ли django.contrib.sites и возвращает либо текущий объект Site, либо объект RequestSite в зависимости от запроса. Она ищет текущий сайт на основе request.get_host(), если параметр SITE_ID не определен.

И домен, и порт могут быть возвращены командой request.get_host(), если в заголовке Host явно указан порт, например, example.com:80. В таких случаях, если поиск не удался из-за того, что хост не соответствует записи в базе данных, порт удаляется, и поиск повторяется только с доменной частью. Это не относится к RequestSite, который всегда будет использовать немодифицированный хост.