Rework the search backend

Author: danniel

api/paul_api/api/permissions.py

@@ -105,9 +105,9 @@ def has_permission(self, request, view):
         checker = ObjectPermissionChecker(user)
         user_perms = checker.get_perms(table)
 
-        READ_ACTIONS = ['csv_export', 'xlsx_export']
+        READ_ACTIONS = ["csv_export", "xlsx_export", "search"]
 
-        if view.action in READ_ACTIONS and 'view_table' in user_perms:
+        if view.action in READ_ACTIONS and "view_table" in user_perms:
             return True
 
         return False

api/paul_api/api/serializers/entries.py

@@ -54,20 +54,6 @@ def __init__(self, *args, **kwargs):
                     self.fields[field_name] = MappedField(source="data.{}".format(field_name), required=False)
 
 
-class EntryReadSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = Entry
-        fields = ["url", "id", "table", "date_created", "data"]
-
-    def get_url(self, obj):
-        return self.context["request"].build_absolute_uri(
-            reverse(
-                "table-entries-detail",
-                kwargs={"pk": obj.pk, "table_pk": obj.table.pk},
-            )
-        )
-
-
 class EntrySerializer(serializers.ModelSerializer):
     url = serializers.SerializerMethodField()
     data = serializers.SerializerMethodField()

api/paul_api/api/serializers/tables.py

@@ -235,3 +235,7 @@ def get_current_user_permissions(self, obj: Table) -> List[str]:
             table_permissions.append("")
         return table_permissions
 
+
+class TableSearchCountSerializer(serializers.Serializer):
+    table = serializers.IntegerField()
+    total = serializers.IntegerField()

api/paul_api/api/urls.py

@@ -17,7 +17,6 @@
 router.register(r"csv-imports", views.CsvImportViewSet)
 router.register(r"charts", views.ChartViewSet)
 router.register(r"cards", views.CardViewSet)
-router.register(r"entries", views.EntryGlobalViewSet)
 router.register(r"tablelinks", views.TableLinkViewSet)
 
 tables_router = routers.NestedSimpleRouter(router, "tables", lookup="table")

api/paul_api/api/views.py

@@ -5,7 +5,7 @@
 from django.core.paginator import Paginator
 from django.contrib.auth.models import Group, User
 from django.conf import settings
-from django.db.models import Q
+from django.db.models import Q, Count
 from django.http import HttpResponse, Http404
 from django.utils.translation import gettext_lazy as _
 from django_filters import rest_framework as filters
@@ -176,6 +176,8 @@ def get_permissions(self):
         base_permissions = super(self.__class__, self).get_permissions()
         if self.action in ["csv_export", "xlsx_export"]:
             base_permissions = (TableCustomActionPermissions(),)
+        elif self.action in ["search"]:
+            base_permissions = ()
         return base_permissions
 
     def create(self, request):
@@ -280,6 +282,27 @@ def create_contacts_table(self, request):
         }
         return Response(response_data)
 
+    @action(
+        detail=False,
+        methods=["get"],
+        name=_("Find tables containing text"),
+        url_path="search",
+    )
+    def search(self, request):
+        needle = request.GET.get("query").strip()
+        tables = models.Table.objects.all()
+        table_ids = []
+        for table in tables:
+            # TODO: check table view permissions
+            table_ids.append(table.id)
+
+        queryset = models.Entry.objects.filter(
+            table__id__in=table_ids, data__icontains=needle
+        ).all().values("table").annotate(total=Count("table")).order_by("table")
+
+        serializer = serializers.tables.TableSearchCountSerializer(queryset, many=True)
+        return Response(serializer.data)
+
     @action(
         detail=True,
         methods=["post"],
@@ -1046,78 +1069,6 @@ def csv_export(self, request, pk):
         return response
 
 
-class EntryGlobalViewSet(viewsets.ModelViewSet):
-    queryset = models.Entry.objects.all().order_by("id")
-    pagination_class = EntriesPagination
-    serializer_class = serializers.entries.EntryReadSerializer
-    # filter_backends = (drf_filters.SearchFilter, )
-    # search_fields = ("data", )
-    # # permission_classes = (TableEntryPermissions, )
-
-    # def list(self, request):
-    #     page = self.paginate_queryset(self.queryset)
-
-    #     if page is not None:
-    #         serializer = serializers.entries.EntryReadSerializer(
-    #             page,
-    #             many=True,
-    #             context={"request": request},
-    #         )
-    #         return self.get_paginated_response(serializer.data)
-    #     serializer = serializers.entries.EntryReadSerializer(self.queryset, many=True)
-    #     return Response(serializer.data)
-
-    def list(self, request):
-        return Http404
-
-    def create(self, request):
-        return Http404
-
-    def retrieve(self, request, pk=None):
-        return Http404
-
-    def update(self, request, pk=None):
-        return Http404
-
-    def partial_update(self, request, pk=None):
-        return Http404
-
-    def destroy(self, request, pk=None):
-        return Http404
-
-    @action(
-        detail=False,
-        methods=["get"],
-        url_name="search",
-        url_path="search",
-    )
-    def search(self, request):
-        """ Text search over the entries """
-        
-        needle = request.GET.get("query")
-
-        tables = models.Table.objects.all()
-        table_ids = []
-        for table in tables:
-            # TODO: apply permissions
-            table_ids.append(table.id)
-
-        queryset = models.Entry.objects.filter(
-            table__id__in=table_ids, data__icontains=needle).order_by("id")
-        page = self.paginate_queryset(queryset)
-
-        if page is not None:
-            serializer = serializers.entries.EntryReadSerializer(
-                page,
-                many=True,
-                context={"request": request},
-            )
-            return self.get_paginated_response(serializer.data)
-
-        serializer = serializers.entries.EntryReadSerializer(queryset, many=True)
-        return Response(serializer.data)
-
-
 class EntryViewSet(viewsets.ModelViewSet):
     pagination_class = EntriesPagination
     serializer_class = serializers.entries.EntrySerializer
@@ -1133,6 +1084,7 @@ def list(self, request, table_pk):
 
         str_fields = request.GET.get("__fields", "") if request else None
         str_order = request.GET.get("__order", "") if request else None
+        str_search = request.GET.get("search", "").strip() if request else None
         table_fields = {x.name: x.field_type for x in table.fields.all().order_by("id")}
         default_fields = {x.name: x for x in table.default_fields.all().order_by("id")}
 
@@ -1158,6 +1110,10 @@ def list(self, request, table_pk):
             queryset = table.entries.filter(filter_dict).order_by("id")
             # queryset = table.entries.annotate(date_field=Cast(KeyTextTransform('data_iesire', "data"), DateField())).filter(date_field__exact='2020-07-21').order_by("id")
 
+        # simple text search over the entire data field
+        if str_search:
+            queryset = queryset.filter(data__icontains=str_search)
+
         page = self.paginate_queryset(queryset)
 
         if page is not None: