| 1 |
from django.apps import apps |
| 2 |
from django.contrib.admin.exceptions import NotRegistered |
| 3 |
from django.core.exceptions import FieldDoesNotExist, PermissionDenied |
| 4 |
from django.http import Http404, JsonResponse |
| 5 |
from django.views.generic.list import BaseListView |
| 6 |
|
| 7 |
|
| 8 |
class AutocompleteJsonView(BaseListView): |
| 9 |
"""Handle AutocompleteWidget's AJAX requests for data.""" |
| 10 |
|
| 11 |
paginate_by = 20 |
| 12 |
admin_site = None |
| 13 |
|
| 14 |
def get(self, request, *args, **kwargs): |
| 15 |
""" |
| 16 |
Return a JsonResponse with search results as defined in |
| 17 |
serialize_result(), by default: |
| 18 |
{ |
| 19 |
results: [{id: "123" text: "foo"}], |
| 20 |
pagination: {more: true} |
| 21 |
} |
| 22 |
""" |
| 23 |
( |
| 24 |
self.term, |
| 25 |
self.model_admin, |
| 26 |
self.source_field, |
| 27 |
to_field_name, |
| 28 |
) = self.process_request(request) |
| 29 |
|
| 30 |
if not self.has_perm(request): |
| 31 |
raise PermissionDenied |
| 32 |
|
| 33 |
self.object_list = self.get_queryset() |
| 34 |
context = self.get_context_data() |
| 35 |
return JsonResponse( |
| 36 |
{ |
| 37 |
"results": [ |
| 38 |
self.serialize_result(obj, to_field_name) |
| 39 |
for obj in context["object_list"] |
| 40 |
], |
| 41 |
"pagination": {"more": context["page_obj"].has_next()}, |
| 42 |
} |
| 43 |
) |
| 44 |
|
| 45 |
def serialize_result(self, obj, to_field_name): |
| 46 |
""" |
| 47 |
Convert the provided model object to a dictionary that is added to the |
| 48 |
results list. |
| 49 |
""" |
| 50 |
return {"id": str(getattr(obj, to_field_name)), "text": str(obj)} |
| 51 |
|
| 52 |
def get_paginator(self, *args, **kwargs): |
| 53 |
"""Use the ModelAdmin's paginator.""" |
| 54 |
return self.model_admin.get_paginator(self.request, *args, **kwargs) |
| 55 |
|
| 56 |
def get_queryset(self): |
| 57 |
"""Return queryset based on ModelAdmin.get_search_results().""" |
| 58 |
qs = self.model_admin.get_queryset(self.request) |
| 59 |
qs = qs.complex_filter(self.source_field.get_limit_choices_to()) |
| 60 |
qs, search_use_distinct = self.model_admin.get_search_results( |
| 61 |
self.request, qs, self.term |
| 62 |
) |
| 63 |
if search_use_distinct: |
| 64 |
qs = qs.distinct() |
| 65 |
return qs |
| 66 |
|
| 67 |
def process_request(self, request): |
| 68 |
""" |
| 69 |
Validate request integrity, extract and return request parameters. |
| 70 |
|
| 71 |
Since the subsequent view permission check requires the target model |
| 72 |
admin, which is determined here, raise PermissionDenied if the |
| 73 |
requested app, model or field are malformed. |
| 74 |
|
| 75 |
Raise Http404 if the target model admin is not configured properly with |
| 76 |
search_fields. |
| 77 |
""" |
| 78 |
term = request.GET.get("term", "") |
| 79 |
try: |
| 80 |
app_label = request.GET["app_label"] |
| 81 |
model_name = request.GET["model_name"] |
| 82 |
field_name = request.GET["field_name"] |
| 83 |
except KeyError as e: |
| 84 |
raise PermissionDenied from e |
| 85 |
|
| 86 |
# Retrieve objects from parameters. |
| 87 |
try: |
| 88 |
source_model = apps.get_model(app_label, model_name) |
| 89 |
except LookupError as e: |
| 90 |
raise PermissionDenied from e |
| 91 |
|
| 92 |
try: |
| 93 |
source_field = source_model._meta.get_field(field_name) |
| 94 |
except FieldDoesNotExist as e: |
| 95 |
raise PermissionDenied from e |
| 96 |
try: |
| 97 |
remote_model = source_field.remote_field.model |
| 98 |
except AttributeError as e: |
| 99 |
raise PermissionDenied from e |
| 100 |
try: |
| 101 |
model_admin = self.admin_site.get_model_admin(remote_model) |
| 102 |
except NotRegistered as e: |
| 103 |
raise PermissionDenied from e |
| 104 |
|
| 105 |
# Validate suitability of objects. |
| 106 |
if not model_admin.get_search_fields(request): |
| 107 |
raise Http404( |
| 108 |
"%s must have search_fields for the autocomplete_view." |
| 109 |
% type(model_admin).__qualname__ |
| 110 |
) |
| 111 |
|
| 112 |
to_field_name = getattr( |
| 113 |
source_field.remote_field, "field_name", remote_model._meta.pk.attname |
| 114 |
) |
| 115 |
to_field_name = remote_model._meta.get_field(to_field_name).attname |
| 116 |
if not model_admin.to_field_allowed(request, to_field_name): |
| 117 |
raise PermissionDenied |
| 118 |
|
| 119 |
return term, model_admin, source_field, to_field_name |
| 120 |
|
| 121 |
def has_perm(self, request, obj=None): |
| 122 |
"""Check if user has permission to access the related model.""" |
| 123 |
return self.model_admin.has_view_permission(request, obj=obj) |