autocomplete.py 4.3 KB

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