Refactor search code

docs/development/search.rst

@@ -41,8 +41,8 @@ Architecture
 ------------
 The search architecture is devided into 2 parts.
 
-* One part is responsible for **indexing** the documents and projects (`documents.py`)
-* The other part is responsible for **querying** the Index to show the proper results to users (`faceted_search.py`)
+* One part is responsible for **indexing** the documents and projects (``documents.py``)
+* The other part is responsible for **querying** the Index to show the proper results to users (``faceted_search.py``)
 
 We use the `django-elasticsearch-dsl`_ package for our Document abstraction.
 `django-elasticsearch-dsl`_ is a wrapper around `elasticsearch-dsl`_ for easy configuration

readthedocs/search/api.py

@@ -62,7 +62,7 @@ def get_queryset(self):
         # Validate all the required params are there
         self.validate_query_params()
         query = self.request.query_params.get('q', '')
-        kwargs = {}
+        kwargs = {'filter_user': False}
         kwargs['projects_list'] = [p.slug for p in self.get_all_projects()]
         kwargs['versions_list'] = self.request.query_params.get('version')
         user = self.request.user
@@ -107,7 +107,10 @@ def get_all_projects(self):
         :raises: Http404 if project is not found
         """
         project_slug = self.request.query_params.get('project')
-        all_projects = get_project_list_or_404(project_slug=project_slug, user=self.request.user)
+        version_slug = self.request.query_params.get('version')
+        all_projects = get_project_list_or_404(
+            project_slug=project_slug, user=self.request.user, version_slug=version_slug,
+        )
         return all_projects
 
     def get_all_projects_url(self):

readthedocs/search/documents.py

@@ -66,11 +66,12 @@ class Meta(object):
         ignore_signals = True
 
     @classmethod
-    def faceted_search(cls, query, user, projects_list=None, versions_list=None):
+    def faceted_search(cls, query, user, projects_list=None, versions_list=None, filter_user=True):
         from readthedocs.search.faceted_search import PageSearch
         kwargs = {
             'user': user,
             'query': query,
+            'filter_user': filter_user,
         }
 
         filters = {}

readthedocs/search/faceted_search.py

@@ -21,19 +21,10 @@ def __init__(self, user, **kwargs):
             but is used on the .com
         """
         self.user = user
+        if 'filter_user' in kwargs:
+            self.filter_user = kwargs.pop('filter_user')
         super().__init__(**kwargs)
 
-    def search(self):
-        """
-        Filter out full content on search results.
-
-        This was causing all of the indexed content to be returned, which was
-        never used on the client side.
-        """
-        s = super().search()
-        s = s.source(exclude=['content', 'headers'])
-        return s
-
     def query(self, search, query):
         """
         Add query part to ``search`` when needed.
@@ -42,6 +33,7 @@ def query(self, search, query):
         """
         search = super().query(search, query)
         search = search.highlight_options(encoder='html', number_of_fragments=3)
+        search = search.source(exclude=['content', 'headers'])
         return search
 
 

readthedocs/search/utils.py

@@ -7,6 +7,7 @@
 from django.shortcuts import get_object_or_404
 from django_elasticsearch_dsl.registries import registry
 
+from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project
 
 
@@ -15,14 +16,20 @@
 
 # TODO: Rewrite all the views using this in Class Based View,
 # and move this function to a mixin
-def get_project_list_or_404(project_slug, user):
-    """Return list of project and its subprojects."""
-    queryset = Project.objects.api(user).only('slug')
-
-    project = get_object_or_404(queryset, slug=project_slug)
-    subprojects = queryset.filter(superprojects__parent_id=project.id)
+def get_project_list_or_404(project_slug, user, version_slug=None):
+    """
+    Return list of project and its subprojects.
 
-    project_list = list(subprojects) + [project]
+    It filters by Version privacy instead of Project privacy.
+    """
+    # Support private projects with public versions
+    project_list = []
+    main_project = get_object_or_404(Project.objects.all(), slug=project_slug)
+    subprojects = Project.objects.filter(superprojects__parent_id=main_project.id)
+    for project in list(subprojects) + [main_project]:
+        version = Version.objects.public(user).filter(project__slug=project.slug, slug=version_slug)
+        if version.count():
+            project_list.append(version[0].project)
     return project_list
 
 

readthedocs/search/views.py

@@ -52,13 +52,9 @@ def elastic_search(request):
         elif user_input.type == 'file':
             kwargs = {}
             if user_input.project:
-                projects_list = get_project_list_or_404(
-                    project_slug=user_input.project, user=request.user
-                )
-                project_slug_list = [project.slug for project in projects_list]
-                kwargs['projects_list'] = project_slug_list
+                kwargs['projects_list'] = [user_input.project]
             if user_input.version:
-                kwargs['versions_list'] = user_input.version
+                kwargs['versions_list'] = [user_input.version]
 
             page_search = PageDocument.faceted_search(
                 query=user_input.query, user=request.user, **kwargs