/
admin.py
909 lines (782 loc) · 33.4 KB
/
admin.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
import logging
import warnings
import django
from django.conf import settings
from django.contrib import admin, messages
from django.contrib.admin.models import ADDITION, CHANGE, DELETION, LogEntry
from django.contrib.auth import get_permission_codename
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import PermissionDenied
from django.forms import MultipleChoiceField, MultipleHiddenInput
from django.http import HttpResponse, HttpResponseRedirect
from django.shortcuts import render
from django.template.response import TemplateResponse
from django.urls import path, reverse
from django.utils.decorators import method_decorator
from django.utils.module_loading import import_string
from django.utils.translation import gettext_lazy as _
from django.views.decorators.http import require_POST
from .forms import ConfirmImportForm, ImportForm, SelectableFieldsExportForm
from .mixins import BaseExportMixin, BaseImportMixin
from .results import RowResult
from .signals import post_export, post_import
from .tmp_storages import TempFolderStorage
logger = logging.getLogger(__name__)
class ImportExportMixinBase:
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.init_change_list_template()
def init_change_list_template(self):
# Store already set change_list_template to allow users to independently
# customize the change list object tools. This treats the cases where
# `self.change_list_template` is `None` (the default in `ModelAdmin`) or
# where `self.import_export_change_list_template` is `None` as falling
# back on the default templates.
if getattr(self, "change_list_template", None):
self.ie_base_change_list_template = self.change_list_template
else:
self.ie_base_change_list_template = "admin/change_list.html"
try:
self.change_list_template = getattr(
self, "import_export_change_list_template", None
)
except AttributeError:
logger.warning("failed to assign change_list_template attribute")
if self.change_list_template is None:
self.change_list_template = self.ie_base_change_list_template
def get_model_info(self):
app_label = self.model._meta.app_label
return (app_label, self.model._meta.model_name)
def changelist_view(self, request, extra_context=None):
extra_context = extra_context or {}
extra_context[
"ie_base_change_list_template"
] = self.ie_base_change_list_template
return super().changelist_view(request, extra_context)
class ImportMixin(BaseImportMixin, ImportExportMixinBase):
"""
Import mixin.
This is intended to be mixed with django.contrib.admin.ModelAdmin
https://docs.djangoproject.com/en/dev/ref/contrib/admin/
"""
#: template for change_list view
import_export_change_list_template = "admin/import_export/change_list_import.html"
#: template for import view
import_template_name = "admin/import_export/import.html"
#: form class to use for the initial import step
import_form_class = ImportForm
#: form class to use for the confirm import step
confirm_form_class = ConfirmImportForm
#: import data encoding
from_encoding = "utf-8-sig"
skip_admin_log = None
# storage class for saving temporary files
tmp_storage_class = None
def get_skip_admin_log(self):
if self.skip_admin_log is None:
return getattr(settings, "IMPORT_EXPORT_SKIP_ADMIN_LOG", False)
else:
return self.skip_admin_log
def get_tmp_storage_class(self):
if self.tmp_storage_class is None:
tmp_storage_class = getattr(
settings,
"IMPORT_EXPORT_TMP_STORAGE_CLASS",
TempFolderStorage,
)
else:
tmp_storage_class = self.tmp_storage_class
if isinstance(tmp_storage_class, str):
tmp_storage_class = import_string(tmp_storage_class)
return tmp_storage_class
def get_tmp_storage_class_kwargs(self):
"""Override this method to provide additional kwargs to temp storage class."""
return {}
def has_import_permission(self, request):
"""
Returns whether a request has import permission.
"""
IMPORT_PERMISSION_CODE = getattr(
settings, "IMPORT_EXPORT_IMPORT_PERMISSION_CODE", None
)
if IMPORT_PERMISSION_CODE is None:
return True
opts = self.opts
codename = get_permission_codename(IMPORT_PERMISSION_CODE, opts)
return request.user.has_perm("%s.%s" % (opts.app_label, codename))
def get_urls(self):
urls = super().get_urls()
info = self.get_model_info()
my_urls = [
path(
"process_import/",
self.admin_site.admin_view(self.process_import),
name="%s_%s_process_import" % info,
),
path(
"import/",
self.admin_site.admin_view(self.import_action),
name="%s_%s_import" % info,
),
]
return my_urls + urls
@method_decorator(require_POST)
def process_import(self, request, *args, **kwargs):
"""
Perform the actual import action (after the user has confirmed the import)
"""
if not self.has_import_permission(request):
raise PermissionDenied
confirm_form = self.create_confirm_form(request)
if confirm_form.is_valid():
import_formats = self.get_import_formats()
input_format = import_formats[int(confirm_form.cleaned_data["format"])](
encoding=self.from_encoding
)
encoding = None if input_format.is_binary() else self.from_encoding
tmp_storage_cls = self.get_tmp_storage_class()
tmp_storage = tmp_storage_cls(
name=confirm_form.cleaned_data["import_file_name"],
encoding=encoding,
read_mode=input_format.get_read_mode(),
**self.get_tmp_storage_class_kwargs(),
)
data = tmp_storage.read()
dataset = input_format.create_dataset(data)
result = self.process_dataset(
dataset, confirm_form, request, *args, **kwargs
)
tmp_storage.remove()
return self.process_result(result, request)
def process_dataset(
self,
dataset,
confirm_form,
request,
*args,
**kwargs,
):
res_kwargs = self.get_import_resource_kwargs(
request, form=confirm_form, **kwargs
)
resource = self.choose_import_resource_class(confirm_form)(**res_kwargs)
imp_kwargs = self.get_import_data_kwargs(request, form=confirm_form, **kwargs)
imp_kwargs["retain_instance_in_row_result"] = True
return resource.import_data(
dataset,
dry_run=False,
file_name=confirm_form.cleaned_data.get("original_file_name"),
user=request.user,
**imp_kwargs,
)
def process_result(self, result, request):
self.generate_log_entries(result, request)
self.add_success_message(result, request)
post_import.send(sender=None, model=self.model)
url = reverse(
"admin:%s_%s_changelist" % self.get_model_info(),
current_app=self.admin_site.name,
)
return HttpResponseRedirect(url)
def generate_log_entries(self, result, request):
if not self.get_skip_admin_log():
# Add imported objects to LogEntry
if django.VERSION >= (5, 1):
self._log_actions(result, request)
else:
logentry_map = {
RowResult.IMPORT_TYPE_NEW: ADDITION,
RowResult.IMPORT_TYPE_UPDATE: CHANGE,
RowResult.IMPORT_TYPE_DELETE: DELETION,
}
content_type_id = ContentType.objects.get_for_model(self.model).pk
for row in result:
if (
row.import_type != row.IMPORT_TYPE_ERROR
and row.import_type != row.IMPORT_TYPE_SKIP
):
with warnings.catch_warnings():
warnings.filterwarnings(
"ignore", category=PendingDeprecationWarning
)
LogEntry.objects.log_action(
user_id=request.user.pk,
content_type_id=content_type_id,
object_id=row.object_id,
object_repr=row.object_repr,
action_flag=logentry_map[row.import_type],
change_message=_(
"%s through import_export" % row.import_type
),
)
def add_success_message(self, result, request):
opts = self.model._meta
success_message = _(
"Import finished: {} new, {} updated, {} deleted and {} skipped {}."
).format(
result.totals[RowResult.IMPORT_TYPE_NEW],
result.totals[RowResult.IMPORT_TYPE_UPDATE],
result.totals[RowResult.IMPORT_TYPE_DELETE],
result.totals[RowResult.IMPORT_TYPE_SKIP],
opts.verbose_name_plural,
)
messages.success(request, success_message)
def get_import_context_data(self, **kwargs):
return self.get_context_data(**kwargs)
def get_context_data(self, **kwargs):
return {}
def create_import_form(self, request):
"""
.. versionadded:: 3.0
Return a form instance to use for the 'initial' import step.
This method can be extended to make dynamic form updates to the
form after it has been instantiated. You might also look to
override the following:
* :meth:`~import_export.admin.ImportMixin.get_import_form_class`
* :meth:`~import_export.admin.ImportMixin.get_import_form_kwargs`
* :meth:`~import_export.admin.ImportMixin.get_import_form_initial`
* :meth:`~import_export.mixins.BaseImportMixin.get_import_resource_classes`
"""
formats = self.get_import_formats()
form_class = self.get_import_form_class(request)
kwargs = self.get_import_form_kwargs(request)
return form_class(formats, self.get_import_resource_classes(), **kwargs)
def get_import_form_class(self, request):
"""
.. versionadded:: 3.0
Return the form class to use for the 'import' step. If you only have
a single custom form class, you can set the ``import_form_class``
attribute to change this for your subclass.
"""
return self.import_form_class
def get_import_form_kwargs(self, request):
"""
.. versionadded:: 3.0
Return a dictionary of values with which to initialize the 'import'
form (including the initial values returned by
:meth:`~import_export.admin.ImportMixin.get_import_form_initial`).
"""
return {
"data": request.POST or None,
"files": request.FILES or None,
"initial": self.get_import_form_initial(request),
}
def get_import_form_initial(self, request):
"""
.. versionadded:: 3.0
Return a dictionary of initial field values to be provided to the
'import' form.
"""
return {}
def create_confirm_form(self, request, import_form=None):
"""
.. versionadded:: 3.0
Return a form instance to use for the 'confirm' import step.
This method can be extended to make dynamic form updates to the
form after it has been instantiated. You might also look to
override the following:
* :meth:`~import_export.admin.ImportMixin.get_confirm_form_class`
* :meth:`~import_export.admin.ImportMixin.get_confirm_form_kwargs`
* :meth:`~import_export.admin.ImportMixin.get_confirm_form_initial`
"""
form_class = self.get_confirm_form_class(request)
kwargs = self.get_confirm_form_kwargs(request, import_form)
return form_class(**kwargs)
def get_confirm_form_class(self, request):
"""
.. versionadded:: 3.0
Return the form class to use for the 'confirm' import step. If you only
have a single custom form class, you can set the ``confirm_form_class``
attribute to change this for your subclass.
"""
return self.confirm_form_class
def get_confirm_form_kwargs(self, request, import_form=None):
"""
.. versionadded:: 3.0
Return a dictionary of values with which to initialize the 'confirm'
form (including the initial values returned by
:meth:`~import_export.admin.ImportMixin.get_confirm_form_initial`).
"""
if import_form:
# When initiated from `import_action()`, the 'posted' data
# is for the 'import' form, not this one.
data = None
files = None
else:
data = request.POST or None
files = request.FILES or None
return {
"data": data,
"files": files,
"initial": self.get_confirm_form_initial(request, import_form),
}
def get_confirm_form_initial(self, request, import_form):
"""
.. versionadded:: 3.0
Return a dictionary of initial field values to be provided to the
'confirm' form.
"""
if import_form is None:
return {}
return {
"import_file_name": import_form.cleaned_data[
"import_file"
].tmp_storage_name,
"original_file_name": import_form.cleaned_data["import_file"].name,
"format": import_form.cleaned_data["format"],
"resource": import_form.cleaned_data.get("resource", ""),
}
def get_import_data_kwargs(self, request, *args, **kwargs):
"""
Prepare kwargs for import_data.
"""
form = kwargs.get("form")
if form:
kwargs.pop("form")
return kwargs
return {}
def write_to_tmp_storage(self, import_file, input_format):
encoding = None
if not input_format.is_binary():
encoding = self.from_encoding
tmp_storage_cls = self.get_tmp_storage_class()
tmp_storage = tmp_storage_cls(
encoding=encoding,
read_mode=input_format.get_read_mode(),
**self.get_tmp_storage_class_kwargs(),
)
data = bytes()
for chunk in import_file.chunks():
data += chunk
tmp_storage.save(data)
return tmp_storage
def add_data_read_fail_error_to_form(self, form, e):
exc_name = repr(type(e).__name__)
msg = _(
"%(exc_name)s encountered while trying to read file. "
"Ensure you have chosen the correct format for the file."
) % {"exc_name": exc_name}
form.add_error("import_file", msg)
def import_action(self, request, *args, **kwargs):
"""
Perform a dry_run of the import to make sure the import will not
result in errors. If there are no errors, save the user
uploaded file to a local temp file that will be used by
'process_import' for the actual import.
"""
if not self.has_import_permission(request):
raise PermissionDenied
context = self.get_import_context_data()
import_formats = self.get_import_formats()
import_form = self.create_import_form(request)
resources = list()
if request.POST and import_form.is_valid():
input_format = import_formats[int(import_form.cleaned_data["format"])]()
if not input_format.is_binary():
input_format.encoding = self.from_encoding
import_file = import_form.cleaned_data["import_file"]
if getattr(settings, "IMPORT_EXPORT_SKIP_ADMIN_CONFIRM", False):
# This setting means we are going to skip the import confirmation step.
# Go ahead and process the file for import in a transaction
# If there are any errors, we roll back the transaction.
# rollback_on_validation_errors is set to True so that we rollback on
# validation errors. If this is not done validation errors would be
# silently skipped.
data = bytes()
for chunk in import_file.chunks():
data += chunk
try:
dataset = input_format.create_dataset(data)
except Exception as e:
self.add_data_read_fail_error_to_form(import_form, e)
if not import_form.errors:
result = self.process_dataset(
dataset,
import_form,
request,
*args,
raise_errors=False,
rollback_on_validation_errors=True,
**kwargs,
)
if not result.has_errors() and not result.has_validation_errors():
return self.process_result(result, request)
else:
context["result"] = result
else:
# first always write the uploaded file to disk as it may be a
# memory file or else based on settings upload handlers
tmp_storage = self.write_to_tmp_storage(import_file, input_format)
# allows get_confirm_form_initial() to include both the
# original and saved file names from form.cleaned_data
import_file.tmp_storage_name = tmp_storage.name
try:
# then read the file, using the proper format-specific mode
# warning, big files may exceed memory
data = tmp_storage.read()
dataset = input_format.create_dataset(data)
except Exception as e:
self.add_data_read_fail_error_to_form(import_form, e)
if not import_form.errors:
# prepare kwargs for import data, if needed
res_kwargs = self.get_import_resource_kwargs(
request, form=import_form, **kwargs
)
resource = self.choose_import_resource_class(import_form)(
**res_kwargs
)
resources = [resource]
# prepare additional kwargs for import_data, if needed
imp_kwargs = self.get_import_data_kwargs(
request, *args, form=import_form, **kwargs
)
result = resource.import_data(
dataset,
dry_run=True,
raise_errors=False,
file_name=import_file.name,
user=request.user,
**imp_kwargs,
)
context["result"] = result
if not result.has_errors() and not result.has_validation_errors():
context["confirm_form"] = self.create_confirm_form(
request, import_form=import_form
)
else:
res_kwargs = self.get_import_resource_kwargs(
request, form=import_form, **kwargs
)
resource_classes = self.get_import_resource_classes()
resources = [
resource_class(**res_kwargs) for resource_class in resource_classes
]
context.update(self.admin_site.each_context(request))
context["title"] = _("Import")
context["form"] = import_form
context["opts"] = self.model._meta
context["media"] = self.media + import_form.media
context["fields_list"] = [
(
resource.get_display_name(),
[f.column_name for f in resource.get_user_visible_fields()],
)
for resource in resources
]
request.current_app = self.admin_site.name
return TemplateResponse(request, [self.import_template_name], context)
def changelist_view(self, request, extra_context=None):
if extra_context is None:
extra_context = {}
extra_context["has_import_permission"] = self.has_import_permission(request)
return super().changelist_view(request, extra_context)
def _log_actions(self, result, request):
"""
Create appropriate LogEntry instances for the result.
"""
rows = dict()
for row in result:
rows.setdefault(row.import_type, list())
rows[row.import_type].append(row.instance)
self._create_log_entries(request.user.pk, rows)
def _create_log_entries(self, user_pk, rows):
logentry_map = {
RowResult.IMPORT_TYPE_NEW: ADDITION,
RowResult.IMPORT_TYPE_UPDATE: CHANGE,
RowResult.IMPORT_TYPE_DELETE: DELETION,
}
for import_type, instances in rows.items():
action_flag = logentry_map[import_type]
self._create_log_entry(user_pk, rows[import_type], import_type, action_flag)
def _create_log_entry(self, user_pk, rows, import_type, action_flag):
if len(rows) > 0:
LogEntry.objects.log_actions(
user_pk,
rows,
action_flag,
change_message=_("%s through import_export" % import_type),
single_object=len(rows) == 1,
)
class ExportMixin(BaseExportMixin, ImportExportMixinBase):
"""
Export mixin.
This is intended to be mixed with
`ModelAdmin <https://docs.djangoproject.com/en/stable/ref/contrib/admin/>`_.
"""
#: template for change_list view
import_export_change_list_template = "admin/import_export/change_list_export.html"
#: template for export view
export_template_name = "admin/import_export/export.html"
#: export data encoding
to_encoding = None
#: Form class to use for the initial export step.
#: Assign to :class:`~import_export.forms.ExportForm` if you would
#: like to disable selectable fields feature.
export_form_class = SelectableFieldsExportForm
def get_urls(self):
urls = super().get_urls()
my_urls = [
path(
"export/",
self.admin_site.admin_view(self.export_action),
name="%s_%s_export" % self.get_model_info(),
),
]
return my_urls + urls
def has_export_permission(self, request):
"""
Returns whether a request has export permission.
"""
EXPORT_PERMISSION_CODE = getattr(
settings, "IMPORT_EXPORT_EXPORT_PERMISSION_CODE", None
)
if EXPORT_PERMISSION_CODE is None:
return True
opts = self.opts
codename = get_permission_codename(EXPORT_PERMISSION_CODE, opts)
return request.user.has_perm("%s.%s" % (opts.app_label, codename))
def get_export_queryset(self, request):
"""
Returns export queryset.
Default implementation respects applied search and filters.
"""
list_display = self.get_list_display(request)
list_display_links = self.get_list_display_links(request, list_display)
list_select_related = self.get_list_select_related(request)
list_filter = self.get_list_filter(request)
search_fields = self.get_search_fields(request)
if self.get_actions(request):
list_display = ["action_checkbox"] + list(list_display)
ChangeList = self.get_changelist(request)
changelist_kwargs = {
"request": request,
"model": self.model,
"list_display": list_display,
"list_display_links": list_display_links,
"list_filter": list_filter,
"date_hierarchy": self.date_hierarchy,
"search_fields": search_fields,
"list_select_related": list_select_related,
"list_per_page": self.list_per_page,
"list_max_show_all": self.list_max_show_all,
"list_editable": self.list_editable,
"model_admin": self,
"sortable_by": self.sortable_by,
}
if django.VERSION >= (4, 0):
changelist_kwargs["search_help_text"] = self.search_help_text
class ExportChangeList(ChangeList):
def get_results(self, request):
"""
Overrides ChangeList.get_results() to bypass default operations like
pagination and result counting, which are not needed for export. This
prevents executing unnecessary COUNT queries during ChangeList
initialization.
"""
pass
cl = ExportChangeList(**changelist_kwargs)
# get_queryset() is already called during initialization,
# it is enough to get its results
if hasattr(cl, "queryset"):
return cl.queryset
# Fallback in case the ChangeList doesn't have queryset attribute set
return cl.get_queryset(request)
def get_export_data(self, file_format, queryset, *args, **kwargs):
"""
Returns file_format representation for given queryset.
"""
request = kwargs.pop("request")
if not self.has_export_permission(request):
raise PermissionDenied
data = self.get_data_for_export(
request,
queryset,
**kwargs,
)
export_data = file_format.export_data(data)
encoding = kwargs.get("encoding")
if not file_format.is_binary() and encoding:
export_data = export_data.encode(encoding)
return export_data
def get_export_context_data(self, **kwargs):
return self.get_context_data(**kwargs)
def get_context_data(self, **kwargs):
return {}
def get_export_form_class(self):
"""
Get the form class used to read the export format.
"""
return self.export_form_class
def export_action(self, request):
if not self.has_export_permission(request):
raise PermissionDenied
form_type = self.get_export_form_class()
formats = self.get_export_formats()
form = form_type(
formats,
self.get_export_resource_classes(),
data=request.POST or None,
)
form.fields["export_items"] = MultipleChoiceField(
widget=MultipleHiddenInput,
required=False,
choices=[(o.id, o.id) for o in self.model.objects.all()],
)
if form.is_valid():
file_format = formats[int(form.cleaned_data["format"])]()
if "export_items" in form.changed_data:
# this request has arisen from an Admin UI action
# export item pks are stored in form data
# so generate the queryset from the stored pks
queryset = self.model.objects.filter(
pk__in=form.cleaned_data["export_items"]
)
else:
queryset = self.get_export_queryset(request)
export_data = self.get_export_data(
file_format,
queryset,
request=request,
encoding=self.to_encoding,
export_form=form,
)
content_type = file_format.get_content_type()
response = HttpResponse(export_data, content_type=content_type)
response["Content-Disposition"] = 'attachment; filename="%s"' % (
self.get_export_filename(request, queryset, file_format),
)
post_export.send(sender=None, model=self.model)
return response
context = self.init_request_context_data(request, form)
request.current_app = self.admin_site.name
return TemplateResponse(request, [self.export_template_name], context=context)
def changelist_view(self, request, extra_context=None):
if extra_context is None:
extra_context = {}
extra_context["has_export_permission"] = self.has_export_permission(request)
return super().changelist_view(request, extra_context)
def get_export_filename(self, request, queryset, file_format):
return super().get_export_filename(file_format)
def init_request_context_data(self, request, form):
context = self.get_export_context_data()
context.update(self.admin_site.each_context(request))
context["title"] = _("Export")
context["form"] = form
context["opts"] = self.model._meta
context["fields_list"] = [
(
res.get_display_name(),
[
field.column_name
for field in res(model=self.model).get_user_visible_fields()
],
)
for res in self.get_export_resource_classes()
]
return context
class ImportExportMixin(ImportMixin, ExportMixin):
"""
Import and export mixin.
"""
#: template for change_list view
import_export_change_list_template = (
"admin/import_export/change_list_import_export.html"
)
class ImportExportModelAdmin(ImportExportMixin, admin.ModelAdmin):
"""
Subclass of ModelAdmin with import/export functionality.
"""
class ExportActionMixin(ExportMixin):
"""
Mixin with export functionality implemented as an admin action.
"""
#: template for change form
change_form_template = "admin/import_export/change_form.html"
#: Flag to indicate whether to show 'export' button on change form
show_change_form_export = True
# This action will receive a selection of items as a queryset,
# store them in the context, and then render the 'export' admin form page,
# so that users can select file format and resource
def change_view(self, request, object_id, form_url="", extra_context=None):
extra_context = extra_context or {}
extra_context["show_change_form_export"] = self.show_change_form_export
return super().change_view(
request,
object_id,
form_url,
extra_context=extra_context,
)
def response_change(self, request, obj):
if "_export-item" in request.POST:
return self.export_admin_action(
request, self.model.objects.filter(id=obj.id)
)
return super().response_change(request, obj)
def export_admin_action(self, request, queryset):
"""
Action runs on POST from instance action menu (if enabled).
"""
formats = self.get_export_formats()
if (
getattr(settings, "IMPORT_EXPORT_SKIP_ADMIN_ACTION_EXPORT_UI", False)
is True
):
file_format = formats[0]()
export_data = self.get_export_data(
file_format, queryset, request=request, encoding=self.to_encoding
)
content_type = file_format.get_content_type()
response = HttpResponse(export_data, content_type=content_type)
response["Content-Disposition"] = 'attachment; filename="%s"' % (
self.get_export_filename(request, queryset, file_format),
)
return response
form_type = self.get_export_form_class()
formats = self.get_export_formats()
form = form_type(
formats=formats,
resources=self.get_export_resource_classes(),
initial={"export_items": list(queryset.values_list("id", flat=True))},
)
# selected items are to be stored as a hidden input on the form
form.fields["export_items"] = MultipleChoiceField(
widget=MultipleHiddenInput,
required=False,
choices=[(str(o), str(o)) for o in queryset.all()],
)
context = self.init_request_context_data(request, form)
# this is necessary to render the FORM action correctly
# i.e. so the POST goes to the correct URL
export_url = reverse(
"%s:%s_%s_export"
% (
self.admin_site.name,
self.model._meta.app_label,
self.model._meta.model_name,
)
)
context["export_url"] = export_url
return render(request, "admin/import_export/export.html", context=context)
def get_actions(self, request):
"""
Adds the export action to the list of available actions.
"""
actions = super().get_actions(request)
actions.update(
export_admin_action=(
type(self).export_admin_action,
"export_admin_action",
_("Export selected %(verbose_name_plural)s"),
)
)
return actions
class ExportActionModelAdmin(ExportActionMixin, admin.ModelAdmin):
"""
Subclass of ModelAdmin with export functionality implemented as an
admin action.
"""
class ImportExportActionModelAdmin(ImportMixin, ExportActionModelAdmin):
"""
Subclass of ExportActionModelAdmin with import/export functionality.
Export functionality is implemented as an admin action.
"""