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

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, этот мидлвейр проверяет базу данных перенаправлений на запрашиваемый URL в качестве последнего средства. В частности, он ищет перенаправление с заданным old_path и ID сайта, соответствующим параметру SITE_ID.

• Если совпадение найдено, и new_path не пусто, он перенаправляет на new_path с перенаправлением 301 («Permanently Moved»). Вы можете подклассифицировать RedirectFallbackMiddleware и установить response_redirect_class на django.http.HttpResponseRedirect, чтобы использовать перенаправление 302 Moved Temporarily вместо этого.
• Если совпадение найдено, и new_path пусто, он отправляет HTTP-заголовок 410 («Gone») и пустой (без содержимого) ответ.
• Если совпадения не найдено, обработка запроса продолжается как обычно.

Мидлвейр активируется только для ошибок 404 – а не для 500 или ответов с любым другим кодом статуса.

Обратите внимание на порядок следования MIDDLEWARE. Как правило, RedirectFallbackMiddleware можно поместить в конец списка, поскольку он используется в последнюю очередь.

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

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

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

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

Через API Python

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})

Мидлвейр

class middleware.RedirectFallbackMiddleware

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

response_gone_class

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

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

response_redirect_class

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

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