Unify feature check for organization/project

Author: stsewd

readthedocs/organizations/views/private.py

@@ -12,7 +12,6 @@
 from readthedocs.audit.models import AuditLog
 from readthedocs.core.history import UpdateChangeReasonPostView
 from readthedocs.core.mixins import PrivateViewMixin
-from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.organizations.forms import (
     OrganizationSignupForm,
     OrganizationTeamProjectForm,
@@ -26,6 +25,7 @@
     OrganizationView,
 )
 from readthedocs.projects.utils import get_csv_file
+from readthedocs.subscriptions.models import PlanFeature
 
 
 # Organization views
@@ -170,12 +170,13 @@ def post(self, request, *args, **kwargs):
         return resp
 
 
-class OrganizationSecurityLogBase(PrivateViewMixin, OrganizationMixin, ListView):
+class OrganizationSecurityLog(PrivateViewMixin, OrganizationMixin, ListView):
 
     """Display security logs related to this organization."""
 
     model = AuditLog
     template_name = 'organizations/security_log.html'
+    feature_type = PlanFeature.TYPE_AUDIT_LOGS
 
     def get(self, request, *args, **kwargs):
         download_data = request.GET.get('download', False)
@@ -273,14 +274,16 @@ def get_queryset(self):
         )
         return self.filter.qs
 
-    def _get_retention_days_limit(self, organization):  # noqa
-        """From how many days we need to show data for this project?"""
-        return settings.RTD_AUDITLOGS_DEFAULT_RETENTION_DAYS
-
-    def _is_enabled(self, organization):  # noqa
-        """Should we show audit logs for this organization?"""
-        return True
-
+    def _is_enabled(self, organization):
+        return PlanFeature.objects.has_feature(
+            organization,
+            type=self.feature_type,
+        )
 
-class OrganizationSecurityLog(SettingsOverrideObject):
-    _default_class = OrganizationSecurityLogBase
+    def _get_retention_days_limit(self, organization):
+        """From how many days we need to show data for this organization?"""
+        return PlanFeature.objects.get_feature_value(
+            organization,
+            type=self.feature_type,
+            default=settings.RTD_AUDITLOGS_DEFAULT_RETENTION_DAYS,
+        )

readthedocs/projects/querysets.py

@@ -97,6 +97,7 @@ def max_concurrent_builds(self, project):
 
           - project
           - organization
+          - plan
           - default setting
 
         :param project: project to be checked
@@ -105,6 +106,8 @@ def max_concurrent_builds(self, project):
         :returns: number of max concurrent builds for the project
         :rtype: int
         """
+        from readthedocs.subscriptions.models import PlanFeature
+
         max_concurrent_organization = None
         organization = project.organizations.first()
         if organization:
@@ -113,7 +116,11 @@ def max_concurrent_builds(self, project):
         return (
             project.max_concurrent_builds or
             max_concurrent_organization or
-            settings.RTD_MAX_CONCURRENT_BUILDS
+            PlanFeature.objects.get_feature_value(
+                project,
+                type=PlanFeature.TYPE_CONCURRENT_BUILDS,
+                default=settings.RTD_MAX_CONCURRENT_BUILDS,
+            )
         )
 
     def prefetch_latest_build(self):

readthedocs/projects/views/private.py

@@ -1,7 +1,6 @@
 """Project views for authenticated users."""
 
 import structlog
-
 from allauth.socialaccount.models import SocialAccount
 from django.conf import settings
 from django.contrib import messages
@@ -40,7 +39,6 @@
 )
 from readthedocs.core.history import UpdateChangeReasonPostView
 from readthedocs.core.mixins import ListViewWithForm, PrivateViewMixin
-from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.integrations.models import HttpExchange, Integration
 from readthedocs.oauth.services import registry
 from readthedocs.oauth.tasks import attach_webhook
@@ -79,6 +77,8 @@
     ProjectRelationListMixin,
 )
 from readthedocs.search.models import SearchQuery
+from readthedocs.subscriptions.models import PlanFeature
+
 
 log = structlog.get_logger(__name__)
 
@@ -747,6 +747,7 @@ class DomainMixin(ProjectAdminMixin, PrivateViewMixin):
     model = Domain
     form_class = DomainForm
     lookup_url_kwarg = 'domain_pk'
+    feature_type = PlanFeature.TYPE_CNAME
 
     def get_success_url(self):
         return reverse('projects_domains', args=[self.get_project().slug])
@@ -758,11 +759,13 @@ def get_context_data(self, **kwargs):
         return context
 
     def _is_enabled(self, project):
-        """Should we allow custom domains for this project?"""
-        return True
+        return PlanFeature.objects.has_feature(
+            project,
+            type=self.feature_type,
+        )
 
 
-class DomainListBase(DomainMixin, ListViewWithForm):
+class DomainList(DomainMixin, ListViewWithForm):
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
@@ -777,12 +780,7 @@ def get_context_data(self, **kwargs):
         return ctx
 
 
-class DomainList(SettingsOverrideObject):
-
-    _default_class = DomainListBase
-
-
-class DomainCreateBase(DomainMixin, CreateView):
+class DomainCreate(DomainMixin, CreateView):
 
     def post(self, request, *args, **kwargs):
         project = self.get_project()
@@ -801,12 +799,7 @@ def get_success_url(self):
         )
 
 
-class DomainCreate(SettingsOverrideObject):
-
-    _default_class = DomainCreateBase
-
-
-class DomainUpdateBase(DomainMixin, UpdateView):
+class DomainUpdate(DomainMixin, UpdateView):
 
     def post(self, request, *args, **kwargs):
         project = self.get_project()
@@ -815,11 +808,6 @@ def post(self, request, *args, **kwargs):
         return HttpResponse('Action not allowed', status=401)
 
 
-class DomainUpdate(SettingsOverrideObject):
-
-    _default_class = DomainUpdateBase
-
-
 class DomainDelete(DomainMixin, DeleteView):
 
     pass
@@ -1062,10 +1050,11 @@ class RegexAutomationRuleUpdate(RegexAutomationRuleMixin, UpdateView):
     pass
 
 
-class SearchAnalyticsBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class SearchAnalytics(ProjectAdminMixin, PrivateViewMixin, TemplateView):
 
     template_name = 'projects/projects_search_analytics.html'
     http_method_names = ['get']
+    feature_type = PlanFeature.TYPE_SEARCH_ANALYTICS
 
     def get(self, request, *args, **kwargs):
         download_data = request.GET.get('download', False)
@@ -1149,21 +1138,25 @@ def _get_csv_data(self):
 
     def _get_retention_days_limit(self, project):
         """From how many days we need to show data for this project?"""
-        return settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS
+        return PlanFeature.objects.get_feature_value(
+            project,
+            type=self.feature_type,
+            default=settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS,
+        )
 
     def _is_enabled(self, project):
         """Should we show search analytics for this project?"""
-        return True
-
-
-class SearchAnalytics(SettingsOverrideObject):
-    _default_class = SearchAnalyticsBase
+        return PlanFeature.objects.has_feature(
+            project,
+            type=self.feature_type,
+        )
 
 
-class TrafficAnalyticsViewBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class TrafficAnalyticsView(ProjectAdminMixin, PrivateViewMixin, TemplateView):
 
     template_name = 'projects/project_traffic_analytics.html'
     http_method_names = ['get']
+    feature_type = PlanFeature.TYPE_PAGEVIEW_ANALYTICS
 
     def get(self, request, *args, **kwargs):
         download_data = request.GET.get('download', False)
@@ -1239,12 +1232,15 @@ def _get_csv_data(self):
 
     def _get_retention_days_limit(self, project):
         """From how many days we need to show data for this project?"""
-        return settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS
+        return PlanFeature.objects.get_feature_value(
+            project,
+            type=self.feature_type,
+            default=settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS,
+        )
 
     def _is_enabled(self, project):
         """Should we show traffic analytics for this project?"""
-        return True
-
-
-class TrafficAnalyticsView(SettingsOverrideObject):
-    _default_class = TrafficAnalyticsViewBase
+        return PlanFeature.objects.has_feature(
+            project,
+            type=self.feature_type,
+        )

readthedocs/proxito/tests/test_full.py

@@ -985,6 +985,7 @@ def test_sitemap_all_private_versions(self):
     ALLOW_PRIVATE_REPOS=True,
     PUBLIC_DOMAIN='dev.readthedocs.io',
     PUBLIC_DOMAIN_USES_HTTPS=True,
+    RTD_ALL_FEATURES_ENABLED=True,
 )
 class TestCDNCache(BaseDocServing):
 

readthedocs/settings/base.py

@@ -683,6 +683,7 @@ def DOCKER_LIMITS(self):
     DEFAULT_PRIVACY_LEVEL = 'public'
     DEFAULT_VERSION_PRIVACY_LEVEL = 'public'
     ALLOW_ADMIN = True
+    RTD_ALL_FEATURES_ENABLED = True
 
     # Organization settings
     RTD_ALLOW_ORGANIZATIONS = False

readthedocs/subscriptions/managers.py

@@ -218,3 +218,29 @@ def get_feature(self, obj, type):
             plan__subscriptions__organization=organization,
         )
         return feature.first()
+
+    # pylint: disable=redefined-builtin
+    def get_feature_value(self, obj, type, default=None):
+        """
+        Get the value of the given feature.
+
+        Use this function instead of ``get_feature().value``
+        when you need to respect the ``RTD_ALL_FEATURES_ENABLED`` setting.
+        """
+        if not settings.RTD_ALL_FEATURES_ENABLED:
+            feature = self.get_feature(obj, type)
+            if feature:
+                return feature.value
+        return default
+
+    # pylint: disable=redefined-builtin
+    def has_feature(self, obj, type):
+        """
+        Get the value of the given feature.
+
+        Use this function instead of ``bool(get_feature())``
+        when you need to respect the ``RTD_ALL_FEATURES_ENABLED`` setting.
+        """
+        if settings.RTD_ALL_FEATURES_ENABLED:
+            return True
+        return self.get_feature(obj, type) is not None