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

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, используемый, когда Redirect не найден для запрошенного пути или имеет пустое значение new_path.

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

response_redirect_class

Класс HttpResponse, который обрабатывает перенаправление.

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