Merge pull request #4483 from rtfd/davidfischer/custom-domains-use-https

Allow enforcing HTTPS for custom domains

Author: davidfischer

readthedocs/core/resolver.py

@@ -129,7 +129,7 @@ def resolve_path(self, project, filename='', version_slug=None,
     def resolve_domain(self, project, private=None):
         # pylint: disable=unused-argument
         canonical_project = self._get_canonical_project(project)
-        domain = canonical_project.domains.filter(canonical=True).first()
+        domain = self._get_project_custom_domain(canonical_project)
         if domain:
             return domain.domain
         elif self._use_subdomain():
@@ -144,13 +144,26 @@ def resolve(self, project, protocol='http', filename='', private=None,
                 version_slug = project.get_default_version()
             private = self._get_private(project, version_slug)
 
-        domain = self.resolve_domain(project, private=private)
+        canonical_project = self._get_canonical_project(project)
+        custom_domain = self._get_project_custom_domain(canonical_project)
 
-        # Use HTTPS if settings specify
-        public_domain = getattr(settings, 'PUBLIC_DOMAIN', None)
-        use_https = getattr(settings, 'PUBLIC_DOMAIN_USES_HTTPS', False)
-        if use_https and public_domain and public_domain in domain:
-            protocol = 'https'
+        # This duplication from resolve_domain is for performance purposes
+        # in order to check whether a custom domain should be HTTPS
+        if custom_domain:
+            domain = custom_domain.domain
+        elif self._use_subdomain():
+            domain = self._get_project_subdomain(canonical_project)
+        else:
+            domain = getattr(settings, 'PRODUCTION_DOMAIN')
+
+        if custom_domain:
+            protocol = 'https' if custom_domain.https else 'http'
+        else:
+            # Use HTTPS if settings specify
+            public_domain = getattr(settings, 'PUBLIC_DOMAIN', None)
+            use_https = getattr(settings, 'PUBLIC_DOMAIN_USES_HTTPS', False)
+            if use_https and public_domain and public_domain in domain:
+                protocol = 'https'
 
         return '{protocol}://{domain}{path}'.format(
             protocol=protocol,
@@ -196,6 +209,9 @@ def _get_project_subdomain(self, project):
             subdomain_slug = project.slug.replace('_', '-')
             return "%s.%s" % (subdomain_slug, public_domain)
 
+    def _get_project_custom_domain(self, project):
+        return project.domains.filter(canonical=True).first()
+
     def _get_private(self, project, version_slug):
         from readthedocs.builds.models import Version
         try:

readthedocs/projects/admin.py

@@ -184,7 +184,7 @@ class DomainAdmin(admin.ModelAdmin):
     list_display = ('domain', 'project', 'https', 'count')
     search_fields = ('domain', 'project__slug')
     raw_id_fields = ('project',)
-    list_filter = ('canonical',)
+    list_filter = ('canonical', 'https')
     model = Domain
 
 

readthedocs/projects/forms.py

@@ -634,7 +634,7 @@ class DomainForm(forms.ModelForm):
 
     class Meta(object):
         model = Domain
-        exclude = ['machine', 'cname', 'count', 'https']
+        exclude = ['machine', 'cname', 'count']
 
     def __init__(self, *args, **kwargs):
         self.project = kwargs.pop('project', None)

readthedocs/projects/models.py

@@ -985,7 +985,7 @@ class Domain(models.Model):
     https = models.BooleanField(
         _('Use HTTPS'),
         default=False,
-        help_text=_('SSL is enabled for this domain')
+        help_text=_('Always use HTTPS for this domain')
     )
     count = models.IntegerField(default=0, help_text=_(
         'Number of times this domain has been hit'),)

readthedocs/rtd_tests/tests/test_resolver.py

@@ -471,6 +471,22 @@ def test_resolver_domain(self):
             url = resolve(project=self.pip)
             self.assertEqual(url, 'http://docs.foobar.com/en/latest/')
 
+    @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
+    def test_resolver_domain_https(self):
+        self.domain = fixture.get(
+            Domain,
+            domain='docs.foobar.com',
+            project=self.pip,
+            https=True,
+            canonical=True,
+        )
+        with override_settings(USE_SUBDOMAIN=False):
+            url = resolve(project=self.pip)
+            self.assertEqual(url, 'https://docs.foobar.com/en/latest/')
+        with override_settings(USE_SUBDOMAIN=True):
+            url = resolve(project=self.pip)
+            self.assertEqual(url, 'https://docs.foobar.com/en/latest/')
+
     @override_settings(PRODUCTION_DOMAIN='readthedocs.org')
     def test_resolver_subproject(self):
         with override_settings(USE_SUBDOMAIN=False):
@@ -740,7 +756,7 @@ def test_subproject_with_translation_with_custom_domain(self):
             domain='docs.example.com',
             canonical=True,
             cname=True,
-            https=True,
+            https=False,
             project=self.superproject_en,
         )
 

readthedocs/templates/projects/domain_form.html

@@ -21,6 +21,14 @@
 {% endblock %}
 
 {% block project_edit_content %}
+  {% if domain.domainssl %}
+    {# This references optional code to get the SSL certificate status #}
+    <p>
+      <strong>HTTPS status: </strong>
+      <span>{{ domain.domainssl.status }}</span>
+    </p>
+  {% endif %}
+
   {% if domain %}
     {% url 'projects_domains_edit' project.slug domain.pk as action_url %}
   {% else %}