Merge pull request readthedocs#5727 from saadmk11/permanent-redirects

Permanent redirect feature added

Author: ericholscher

readthedocs/redirects/managers.py

@@ -8,16 +8,16 @@
 
 class RedirectQuerySet(QuerySet):
 
-    def get_redirect_path(self, path, language=None, version_slug=None):
+    def get_redirect_path_with_status(self, path, language=None, version_slug=None):
         for redirect in self.select_related('project'):
             new_path = redirect.get_redirect_path(
                 path=path,
                 language=language,
                 version_slug=version_slug,
             )
             if new_path:
-                return new_path
-        return None
+                return new_path, redirect.http_status
+        return (None, None)
 
 
 RedirectManager = Manager.from_queryset(RedirectQuerySet)

readthedocs/redirects/migrations/0003_add_default_redirect_http_status_to_302.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.20 on 2019-05-23 15:25
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+def change_http_status(apps, schema_editor):
+    Redirect = apps.get_model('redirects', 'Redirect')
+    Redirect.objects.update(http_status=302)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('redirects', '0002_add_missing_model_change_migrations'),
+    ]
+
+    operations = [
+        migrations.RunPython(change_http_status),
+        migrations.AlterField(
+            model_name='redirect',
+            name='http_status',
+            field=models.SmallIntegerField(choices=[(301, '301 - Permanent Redirect'), (302, '302 - Temporary Redirect')], default=302, verbose_name='HTTP Status'),
+        ),
+    ]

readthedocs/redirects/models.py

@@ -87,7 +87,7 @@ class Redirect(models.Model):
     http_status = models.SmallIntegerField(
         _('HTTP Status'),
         choices=HTTP_STATUS_CHOICES,
-        default=301,
+        default=302,
     )
     status = models.BooleanField(choices=STATUS_CHOICES, default=True)
 

readthedocs/redirects/utils.py

@@ -11,7 +11,7 @@
 import re
 from urllib.parse import urlparse, urlunparse
 
-from django.http import HttpResponseRedirect
+from django.http import HttpResponseRedirect, HttpResponsePermanentRedirect
 
 from readthedocs.constants import LANGUAGES_REGEX
 from readthedocs.projects.models import Project
@@ -79,7 +79,7 @@ def get_redirect_response(request, full_path):
     if not project.single_version:
         language, version_slug, path = language_and_version_from_path(path)
 
-    path = project.redirects.get_redirect_path(
+    path, http_status = project.redirects.get_redirect_path_with_status(
         path=path, language=language, version_slug=version_slug
     )
 
@@ -91,4 +91,8 @@ def get_redirect_response(request, full_path):
     # Re-use the domain and protocol used in the current request.
     # Redirects shouldn't change the domain, version or language.
     new_path = request.build_absolute_uri(new_path)
+
+    if http_status and http_status == 301:
+        return HttpResponsePermanentRedirect(new_path)
+
     return HttpResponseRedirect(new_path)

readthedocs/rtd_tests/tests/test_redirects.py

@@ -374,6 +374,18 @@ def test_redirect_htmldir(self):
             r['Location'], 'http://pip.readthedocs.org/en/latest/faq/',
         )
 
+    @override_settings(USE_SUBDOMAIN=True)
+    def test_redirect_root_with_301_status(self):
+        Redirect.objects.create(
+            project=self.pip, redirect_type='prefix',
+            from_url='/woot/', http_status=301,
+        )
+        r = self.client.get('/woot/faq.html', HTTP_HOST='pip.readthedocs.org')
+        self.assertEqual(r.status_code, 301)
+        self.assertEqual(
+            r['Location'], 'http://pip.readthedocs.org/en/latest/faq.html',
+        )
+
 
 class CustomRedirectTests(TestCase):