Skip to content

Hide Banned Projects from the Site #6231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions readthedocs/projects/querysets.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ class ProjectQuerySetBase(models.QuerySet):

use_for_related_fields = True

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)

self.users_not_banned = (
Q(users__profile__banned=False) |
Q(users__profile__isnull=True) |
Q(users__isnull=True)
)

def _add_user_repos(self, queryset, user):
if user.has_perm('projects.view_project'):
return self.all()
Expand All @@ -36,21 +45,28 @@ def for_admin_user(self, user):
return self.none()

def public(self, user=None):
queryset = self.filter(privacy_level=constants.PUBLIC)
queryset = self.filter(
self.users_not_banned,
privacy_level=constants.PUBLIC
)
if user:
queryset = self._add_user_repos(queryset, user)
return queryset.distinct()

def protected(self, user=None):
queryset = self.filter(
privacy_level__in=[constants.PUBLIC, constants.PROTECTED],
self.users_not_banned,
privacy_level__in=[constants.PUBLIC, constants.PROTECTED]
)
if user:
queryset = self._add_user_repos(queryset, user)
return queryset.distinct()

def private(self, user=None):
queryset = self.filter(privacy_level=constants.PRIVATE)
queryset = self.filter(
self.users_not_banned,
privacy_level=constants.PRIVATE
)
if user:
queryset = self._add_user_repos(queryset, user)
return queryset.distinct()
Expand Down
1 change: 0 additions & 1 deletion readthedocs/projects/views/public.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ class ProjectIndex(ListView):

def get_queryset(self):
queryset = Project.objects.public(self.request.user)
queryset = queryset.exclude(users__profile__banned=True)

if self.kwargs.get('tag'):
self.tag = get_object_or_404(Tag, slug=self.kwargs.get('tag'))
Expand Down
128 changes: 124 additions & 4 deletions readthedocs/rtd_tests/tests/test_project_querysets.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,24 @@ class ProjectQuerySetTests(TestCase):

def setUp(self):
self.user = get(User)
self.user.profile.banned = False
self.user.profile.save()

self.another_user = get(User)
self.another_user.profile.banned = False
self.another_user.profile.save()

self.project = get(
Project,
privacy_level=PUBLIC,
users=[self.user],
main_language_project=None,
)
self.project_no_user = get(
Project,
privacy_level=PUBLIC,
main_language_project=None,
)
self.project_private = get(
Project,
privacy_level=PRIVATE,
Expand Down Expand Up @@ -145,6 +155,19 @@ def test_private(self):
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_private_excludes_banned_projects(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.private()

projects = {
self.another_project_private,
self.shared_project_private,
}
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_private_user(self):
query = Project.objects.private(user=self.user)
projects = (
Expand All @@ -162,10 +185,43 @@ def test_private_user(self):
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_private_with_banned_user(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.private(user=self.user)
projects = (
self.user_projects |
{self.another_project_private}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

query = Project.objects.private(user=self.another_user)
projects = (
self.another_user_projects
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_public(self):
query = Project.objects.public()
projects = {
self.project,
self.project_no_user,
self.another_project,
self.shared_project,
}
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_public_excludes_banned_projects(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.public()
projects = {
self.project_no_user,
self.another_project,
self.shared_project,
}
Expand All @@ -176,15 +232,35 @@ def test_public_user(self):
query = Project.objects.public(user=self.user)
projects = (
self.user_projects |
{self.another_project}
{self.project_no_user, self.another_project}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

query = Project.objects.public(user=self.another_user)
projects = (
self.another_user_projects |
{self.project, self.project_no_user}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_public_with_banned_user(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.public(user=self.user)
projects = (
self.user_projects |
{self.project_no_user, self.another_project}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

query = Project.objects.public(user=self.another_user)
projects = (
self.another_user_projects |
{self.project}
{self.project_no_user}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)
Expand All @@ -194,6 +270,7 @@ def test_protected(self):
query = Project.objects.protected()
projects = {
self.project,
self.project_no_user,
self.project_protected,
self.another_project,
self.another_project_protected,
Expand All @@ -203,19 +280,62 @@ def test_protected(self):
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_protected_excludes_banned_projects(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.protected()
projects = {
self.project_no_user,
self.another_project,
self.another_project_protected,
self.shared_project,
self.shared_project_protected,
}
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_protected_user(self):
query = Project.objects.protected(user=self.user)
projects = (
self.user_projects |
{self.another_project, self.another_project_protected}
{
self.project_no_user,
self.another_project,
self.another_project_protected
}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

query = Project.objects.protected(user=self.another_user)
projects = (
self.another_user_projects |
{self.project, self.project_protected, self.project_no_user}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

def test_protected_with_banned_user(self):
self.user.profile.banned = True
self.user.profile.save()

query = Project.objects.protected(user=self.user)
projects = (
self.user_projects |
{
self.project_no_user,
self.another_project,
self.another_project_protected
}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)

query = Project.objects.protected(user=self.another_user)
projects = (
self.another_user_projects |
{self.project, self.project_protected}
{self.project_no_user}
)
self.assertEqual(query.count(), len(projects))
self.assertEqual(set(query), projects)
Expand Down