Refactor search logic to a create an 'omnisearch' (#484)

PyRIGS/decorators.py

@@ -9,9 +9,8 @@ from RIGS import models
 
 def get_oembed(login_url, request, oembed_view, kwargs):
     context = {}
-    context['oembed_url'] = "{0}://{1}{2}".format(request.scheme, request.META['HTTP_HOST'],
-                                                  reverse(oembed_view, kwargs=kwargs))
-    context['login_url'] = "{0}?{1}={2}".format(login_url, REDIRECT_FIELD_NAME, request.get_full_path())
+    context['oembed_url'] = f"{request.scheme}://{request.META['HTTP_HOST']}{reverse(oembed_view, kwargs=kwargs)}"
+    context['login_url'] = f"{login_url}?{REDIRECT_FIELD_NAME}={request.get_full_path()}"
     resp = render(request, 'login_redirect.html', context=context)
     return resp
 
@@ -25,7 +24,7 @@ def has_oembed(oembed_view, login_url=settings.LOGIN_URL):
                 if oembed_view is not None:
                     return get_oembed(login_url, request, oembed_view, kwargs)
                 else:
-                    return HttpResponseRedirect('%s?%s=%s' % (login_url, REDIRECT_FIELD_NAME, request.get_full_path()))
+                    return HttpResponseRedirect(f'{login_url}?{REDIRECT_FIELD_NAME}={request.get_full_path()}')
 
         _checklogin.__doc__ = view_func.__doc__
         _checklogin.__dict__ = view_func.__dict__
@@ -55,7 +54,7 @@ def user_passes_test_with_403(test_func, login_url=None, oembed_view=None):
                 if oembed_view is not None:
                     return get_oembed(login_url, request, oembed_view, kwargs)
                 else:
-                    return HttpResponseRedirect('%s?%s=%s' % (login_url, REDIRECT_FIELD_NAME, request.get_full_path()))
+                    return HttpResponseRedirect(f'{login_url}?{REDIRECT_FIELD_NAME}={request.get_full_path()}')
             else:
                 resp = render(request, '403.html')
                 resp.status_code = 403

PyRIGS/tests/test_unit.py

@@ -10,6 +10,7 @@ from pytest_django.asserts import assertTemplateUsed, assertInHTML
 from PyRIGS import urls
 from RIGS.models import Event, Profile
 from assets.models import Asset
+from training.tests.test_unit import get_response
 from django.db import connection
 from django.template.defaultfilters import striptags
 from django.urls.exceptions import NoReverseMatch
@@ -135,3 +136,11 @@ def test_keyholder_access(client):
     assertContains(response, 'View Revision History')
     client.logout()
     call_command('deleteSampleData')
+
+
+def test_search(admin_client, admin_user):
+    url = reverse('search')
+    response = admin_client.get(url, {'q': "Definetelynothingfoundifwesearchthis"})
+    assertContains(response, "No results found")
+    response = admin_client.get(url, {'q': admin_user.first_name})
+    assertContains(response, admin_user.first_name)

PyRIGS/urls.py

@@ -23,6 +23,7 @@ urlpatterns = [
          name="api_secure"),
 
     path('closemodal/', views.CloseModal.as_view(), name='closemodal'),
+    path('search/', login_required(views.Search.as_view()), name='search'),
     path('search_help/', login_required(views.SearchHelp.as_view()), name='search_help'),
 
     path('', include('users.urls')),

PyRIGS/views.py

@@ -1,6 +1,7 @@
 import datetime
 import operator
 from functools import reduce
+from itertools import chain
 
 from django.contrib.auth.decorators import login_required
 from django.contrib import messages
@@ -120,7 +121,7 @@ class SecureAPIRequest(generic.View):
                     'text': o.name,
                 }
                 try:  # See if there is a valid update URL
-                    data['update'] = reverse("%s_update" % model, kwargs={'pk': o.pk})
+                    data['update'] = reverse(f"{model}_update", kwargs={'pk': o.pk})
                 except NoReverseMatch:
                     pass
                 results.append(data)
@@ -182,20 +183,7 @@ class GenericListView(generic.ListView):
         return context
 
     def get_queryset(self):
-        q = self.request.GET.get('q', "")
-
-        filter = Q(name__icontains=q) | Q(email__icontains=q) | Q(address__icontains=q) | Q(notes__icontains=q) | Q(
-            phone__startswith=q) | Q(phone__endswith=q)
-
-        # try and parse an int
-        try:
-            val = int(q)
-            filter = filter | Q(pk=val)
-        except:  # noqa
-            # not an integer
-            pass
-
-        object_list = self.model.objects.filter(filter)
+        object_list = self.model.objects.search(query=self.request.GET.get('q', ""))
 
         orderBy = self.request.GET.get('orderBy', "name")
         if orderBy != "":
@@ -236,6 +224,53 @@ class GenericCreateView(generic.CreateView):
         return context
 
 
+class Search(generic.ListView):
+    template_name = 'search_results.html'
+    paginate_by = 20
+    count = 0
+
+    def get_context_data(self, *args, **kwargs):
+        context = super().get_context_data(*args, **kwargs)
+        context['count'] = self.count or 0
+        context['query'] = self.request.GET.get('q')
+        context['page_title'] = f"{context['count']} search results for <b>{context['query']}</b>"
+        return context
+
+    def get_queryset(self):
+        request = self.request
+        query = request.GET.get('q', None)
+
+        if query is not None:
+            event_results = models.Event.objects.search(query)
+            person_results = models.Person.objects.search(query)
+            organisation_results = models.Organisation.objects.search(query)
+            venue_results = models.Venue.objects.search(query)
+            invoice_results = models.Invoice.objects.search(query)
+            asset_results = asset_models.Asset.objects.search(query)
+            supplier_results = asset_models.Supplier.objects.search(query)
+            trainee_results = training_models.Trainee.objects.search(query)
+            training_item_results = training_models.TrainingItem.objects.search(query)
+
+            # combine querysets
+            queryset_chain = chain(
+                event_results,
+                person_results,
+                organisation_results,
+                venue_results,
+                invoice_results,
+                asset_results,
+                supplier_results,
+                trainee_results,
+                training_item_results,
+            )
+            qs = sorted(queryset_chain,
+                        key=lambda instance: instance.pk,
+                        reverse=True)
+            self.count = len(qs)  # since qs is actually a list
+            return qs
+        return models.Event.objects.none()  # just an empty queryset as default
+
+
 class SearchHelp(generic.TemplateView):
     template_name = 'search_help.html'