Приложение перенаправлений

Django поставляется с необязательным приложением перенаправлений. Оно позволяет хранить перенаправления в базе данных и обрабатывать их за вас. По умолчанию оно использует код состояния HTTP-ответа 301 Moved Permanently.

Установка

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

1. Убедитесь, что фреймворк django.contrib.sites установлен.
2. Добавьте 'django.contrib.redirects' в свой параметр INSTALLED_APPS.
3. Добавьте 'django.contrib.redirects.middleware.RedirectFallbackMiddleware' в свой параметр MIDDLEWARE.
4. Выполните команду manage.py migrate.

Как это работает

manage.py migrate создает таблицу django_redirect в вашей базе данных. Это таблица поиска с полями site_id, old_path и new_path.

Весь процесс выполняет RedirectFallbackMiddleware. Каждый раз, когда какое-либо приложение Django генерирует ошибку 404, этот middleware проверяет базу данных перенаправлений на запрашиваемый URL в качестве последнего средства. Конкретно, он ищет перенаправление с заданным old_path и идентификатором сайта, соответствующим параметру SITE_ID.

• Если он находит совпадение, и new_path не пусто, он перенаправляет на new_path с помощью перенаправления 301 (“Перемещено постоянно”). Вы можете создать подкласс RedirectFallbackMiddleware и установить response_redirect_class на django.http.HttpResponseRedirect, чтобы использовать перенаправление 302 Moved Temporarily вместо этого.
• Если он находит совпадение, и new_path пусто, он отправляет HTTP-заголовок 410 (“Удалён”) и пустой (без содержимого) ответ.
• Если совпадение не найдено, запрос продолжает обрабатываться как обычно.

Middleware активируется только для ошибок 404 — не для 500 и ответов с другими кодами состояния.

Обратите внимание, что порядок параметра MIDDLEWARE важен. Обычно RedirectFallbackMiddleware размещают в конце списка, так как это крайнее средство.

Дополнительную информацию о middleware можно найти в документации по middleware.

Как добавить, изменить и удалить перенаправления

Через интерфейс администрирования

Если вы активировали автоматический интерфейс администрирования Django, вы должны увидеть раздел «Перенаправления» на главной странице администрирования. Редактируйте перенаправления так же, как и любые другие объекты в системе.

Через Python API

class models.Redirect

Перенаправления представляются стандартной моделью Django, которая находится в django/contrib/redirects/models.py. Вы можете получить доступ к объектам перенаправления через API базы данных Django. Например:

>>> from django.conf import settings
>>> from django.contrib.redirects.models import Redirect
>>> # Add a new redirect.
>>> redirect = Redirect.objects.create(
...     site_id=1,
...     old_path="/contact-us/",
...     new_path="/contact/",
... )
>>> # Change a redirect.
>>> redirect.new_path = "/contact-details/"
>>> redirect.save()
>>> redirect
<Redirect: /contact-us/ ---> /contact-details/>
>>> # Delete a redirect.
>>> Redirect.objects.filter(site_id=1, old_path="/contact-us/").delete()
(1, {'redirects.Redirect': 1})

Middleware

class middleware.RedirectFallbackMiddleware

Вы можете изменить классы HttpResponse, используемые middleware, создав подкласс RedirectFallbackMiddleware и переопределив response_gone_class и/или response_redirect_class.

response_gone_class

Класс HttpResponse, используемый, когда для запрошенного пути не найдено перенаправление или значение new_path пустое.

По умолчанию HttpResponseGone.

response_redirect_class

Класс HttpResponse, отвечающий за перенаправление.

По умолчанию HttpResponsePermanentRedirect.