Unify feature check for organization/project

Author: stsewd

readthedocs/core/mixins.py

@@ -6,6 +6,7 @@
 from vanilla import ListView
 
 from readthedocs.projects.models import Feature
+from readthedocs.subscriptions.models import PlanFeature
 
 
 class ListViewWithForm(ListView):
@@ -67,3 +68,27 @@ def _is_cache_enabled(self, project):
         """Helper function to check if CND is enabled for a project."""
         # TODO: check for the organization's plan.
         return settings.ALLOW_PRIVATE_REPOS and project.has_feature(Feature.CDN_ENABLED)
+
+
+class FeaturedView:
+
+    feature_type = None
+
+    def _get_feature(self, obj):
+        feature = PlanFeature.objects.get_feature(
+            obj=obj,
+            type=self.feature_type,
+        )
+        return feature
+
+    def _get_feature_value(self, obj, default=None):
+        if settings.RTD_ALLOW_ORGANIZATIONS:
+            feature = self._get_feature(obj)
+            if feature:
+                return feature.value
+        return default
+
+    def _is_enabled(self, obj):
+        if settings.RTD_ALLOW_ORGANIZATIONS:
+            return self._get_feature(obj) is not None
+        return True

readthedocs/organizations/views/private.py

@@ -11,8 +11,7 @@
 from readthedocs.audit.filters import OrganizationSecurityLogFilter
 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.core.mixins import FeaturedView, PrivateViewMixin
 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,18 @@ def post(self, request, *args, **kwargs):
         return resp
 
 
-class OrganizationSecurityLogBase(PrivateViewMixin, OrganizationMixin, ListView):
+class OrganizationSecurityLog(
+        FeaturedView,
+        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 +279,9 @@ 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
-
-
-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 self._get_feature_value(
+            organization,
+            default=settings.RTD_AUDITLOGS_DEFAULT_RETENTION_DAYS,
+        )

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
@@ -39,8 +38,7 @@
     VersionAutomationRule,
 )
 from readthedocs.core.history import UpdateChangeReasonPostView
-from readthedocs.core.mixins import ListViewWithForm, PrivateViewMixin
-from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.core.mixins import ListViewWithForm, PrivateViewMixin, FeaturedView
 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__)
 
@@ -743,10 +743,11 @@ def post(self, request, *args, **kwargs):
         return HttpResponseRedirect(self.get_success_url())
 
 
-class DomainMixin(ProjectAdminMixin, PrivateViewMixin):
+class DomainMixin(FeaturedView, 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])
@@ -757,12 +758,8 @@ def get_context_data(self, **kwargs):
         context['enabled'] = self._is_enabled(project)
         return context
 
-    def _is_enabled(self, project):
-        """Should we allow custom domains for this project?"""
-        return True
-
 
-class DomainListBase(DomainMixin, ListViewWithForm):
+class DomainList(DomainMixin, ListViewWithForm):
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
@@ -777,12 +774,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 +793,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 +802,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 +1044,16 @@ class RegexAutomationRuleUpdate(RegexAutomationRuleMixin, UpdateView):
     pass
 
 
-class SearchAnalyticsBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class SearchAnalytics(
+        FeaturedView,
+        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 +1137,22 @@ 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
-
-    def _is_enabled(self, project):
-        """Should we show search analytics for this project?"""
-        return True
-
-
-class SearchAnalytics(SettingsOverrideObject):
-    _default_class = SearchAnalyticsBase
+        return self._get_feature_value(
+            project,
+            default=settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS,
+        )
 
 
-class TrafficAnalyticsViewBase(ProjectAdminMixin, PrivateViewMixin, TemplateView):
+class TrafficAnalyticsView(
+        FeaturedView,
+        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 +1228,7 @@ 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
-
-    def _is_enabled(self, project):
-        """Should we show traffic analytics for this project?"""
-        return True
-
-
-class TrafficAnalyticsView(SettingsOverrideObject):
-    _default_class = TrafficAnalyticsViewBase
+        return self._get_feature_value(
+            project,
+            default=settings.RTD_ANALYTICS_DEFAULT_RETENTION_DAYS,
+        )