Merge pull request #4387 from rtfd/davidfischer/ad-free-nag-fix

Do not access database from builds to check ad-free

Author: davidfischer

readthedocs/doc_builder/backends/mkdocs.py

@@ -172,7 +172,7 @@ def generate_rtd_data(self, docs_dir, mkdocs_config):
             'docroot': docs_dir,
             'source_suffix': ".md",
             'api_host': getattr(settings, 'PUBLIC_API_URL', 'https://readthedocs.org'),
-            'ad_free': self.project.ad_free or self.project.gold_owners.exists(),
+            'ad_free': not self.project.show_advertising,
             'commit': self.version.project.vcs_repo(self.version.slug).commit,
             'global_analytics_code': getattr(settings, 'GLOBAL_ANALYTICS_CODE', 'UA-17997319-1'),
             'user_analytics_code': analytics_code,

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

@@ -115,7 +115,7 @@ context = {
     'using_theme': (html_theme == "default"),
     'new_theme': (html_theme == "sphinx_rtd_theme"),
     'source_suffix': SUFFIX,
-    'ad_free': {% if project.gold_owners.exists or project.ad_free %}True{% else %}False{% endif %},
+    'ad_free': {% if project.show_advertising %}False{% else %}True{% endif %},
     'user_analytics_code': '{{ project.analytics_code|default_if_none:'' }}',
     'global_analytics_code': '{{ settings.GLOBAL_ANALYTICS_CODE }}',
     'commit': {% if project.repo_type == 'git' %}'{{ commit|slice:"8" }}'{% else %}'{{ commit }}'{% endif %},

readthedocs/projects/models.py

@@ -849,6 +849,18 @@ def get_feature_value(self, feature, positive, negative):
         """
         return positive if self.has_feature(feature) else negative
 
+    @property
+    def show_advertising(self):
+        """
+        Whether this project is ad-free
+
+        :return: ``True`` if advertising should be shown and ``False`` otherwise
+        """
+        if self.ad_free or self.gold_owners.exists():
+            return False
+
+        return True
+
 
 class APIProject(Project):
 

readthedocs/restapi/serializers.py

@@ -43,6 +43,11 @@ class ProjectAdminSerializer(ProjectSerializer):
         slug_field='feature_id',
     )
 
+    show_advertising = serializers.SerializerMethodField()
+
+    def get_show_advertising(self, obj):
+        return obj.show_advertising
+
     class Meta(ProjectSerializer.Meta):
         fields = ProjectSerializer.Meta.fields + (
             'enable_epub_build',
@@ -62,7 +67,7 @@ class Meta(ProjectSerializer.Meta):
             'features',
             'has_valid_clone',
             'has_valid_webhook',
-            'ad_free',
+            'show_advertising',
         )
 
 

readthedocs/rtd_tests/tests/test_api.py

@@ -906,7 +906,6 @@ def test_get_version_by_id(self):
             'id': 18,
             'active': True,
             'project': {
-                'ad_free': False,
                 'analytics_code': None,
                 'canonical_url': 'http://readthedocs.org/docs/pip/en/latest/',
                 'cdn_enabled': False,
@@ -932,6 +931,7 @@ def test_get_version_by_id(self):
                 'repo': 'https://github.com/pypa/pip',
                 'repo_type': 'git',
                 'requirements_file': None,
+                'show_advertising': True,
                 'skip': False,
                 'slug': 'pip',
                 'suffix': '.rst',