options.py 98 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556
  1. import copy
  2. import enum
  3. import json
  4. import re
  5. from functools import partial, update_wrapper
  6. from urllib.parse import parse_qsl
  7. from urllib.parse import quote as urlquote
  8. from urllib.parse import urlparse
  9. from django import forms
  10. from django.conf import settings
  11. from django.contrib import messages
  12. from django.contrib.admin import helpers, widgets
  13. from django.contrib.admin.checks import (
  14. BaseModelAdminChecks,
  15. InlineModelAdminChecks,
  16. ModelAdminChecks,
  17. )
  18. from django.contrib.admin.exceptions import DisallowedModelAdminToField, NotRegistered
  19. from django.contrib.admin.templatetags.admin_urls import add_preserved_filters
  20. from django.contrib.admin.utils import (
  21. NestedObjects,
  22. construct_change_message,
  23. flatten_fieldsets,
  24. get_deleted_objects,
  25. lookup_spawns_duplicates,
  26. model_format_dict,
  27. model_ngettext,
  28. quote,
  29. unquote,
  30. )
  31. from django.contrib.admin.widgets import AutocompleteSelect, AutocompleteSelectMultiple
  32. from django.contrib.auth import get_permission_codename
  33. from django.core.exceptions import (
  34. FieldDoesNotExist,
  35. FieldError,
  36. PermissionDenied,
  37. ValidationError,
  38. )
  39. from django.core.paginator import Paginator
  40. from django.db import models, router, transaction
  41. from django.db.models.constants import LOOKUP_SEP
  42. from django.forms.formsets import DELETION_FIELD_NAME, all_valid
  43. from django.forms.models import (
  44. BaseInlineFormSet,
  45. inlineformset_factory,
  46. modelform_defines_fields,
  47. modelform_factory,
  48. modelformset_factory,
  49. )
  50. from django.forms.widgets import CheckboxSelectMultiple, SelectMultiple
  51. from django.http import HttpResponseRedirect
  52. from django.http.response import HttpResponseBase
  53. from django.template.response import SimpleTemplateResponse, TemplateResponse
  54. from django.urls import reverse
  55. from django.utils.decorators import method_decorator
  56. from django.utils.html import format_html
  57. from django.utils.http import urlencode
  58. from django.utils.safestring import mark_safe
  59. from django.utils.text import (
  60. capfirst,
  61. format_lazy,
  62. get_text_list,
  63. smart_split,
  64. unescape_string_literal,
  65. )
  66. from django.utils.translation import gettext as _
  67. from django.utils.translation import ngettext
  68. from django.views.decorators.csrf import csrf_protect
  69. from django.views.generic import RedirectView
  70. IS_POPUP_VAR = "_popup"
  71. TO_FIELD_VAR = "_to_field"
  72. IS_FACETS_VAR = "_facets"
  73. class ShowFacets(enum.Enum):
  74. NEVER = "NEVER"
  75. ALLOW = "ALLOW"
  76. ALWAYS = "ALWAYS"
  77. HORIZONTAL, VERTICAL = 1, 2
  78. def get_content_type_for_model(obj):
  79. # Since this module gets imported in the application's root package,
  80. # it cannot import models from other applications at the module level.
  81. from django.contrib.contenttypes.models import ContentType
  82. return ContentType.objects.get_for_model(obj, for_concrete_model=False)
  83. def get_ul_class(radio_style):
  84. return "radiolist" if radio_style == VERTICAL else "radiolist inline"
  85. class IncorrectLookupParameters(Exception):
  86. pass
  87. # Defaults for formfield_overrides. ModelAdmin subclasses can change this
  88. # by adding to ModelAdmin.formfield_overrides.
  89. FORMFIELD_FOR_DBFIELD_DEFAULTS = {
  90. models.DateTimeField: {
  91. "form_class": forms.SplitDateTimeField,
  92. "widget": widgets.AdminSplitDateTime,
  93. },
  94. models.DateField: {"widget": widgets.AdminDateWidget},
  95. models.TimeField: {"widget": widgets.AdminTimeWidget},
  96. models.TextField: {"widget": widgets.AdminTextareaWidget},
  97. models.URLField: {"widget": widgets.AdminURLFieldWidget},
  98. models.IntegerField: {"widget": widgets.AdminIntegerFieldWidget},
  99. models.BigIntegerField: {"widget": widgets.AdminBigIntegerFieldWidget},
  100. models.CharField: {"widget": widgets.AdminTextInputWidget},
  101. models.ImageField: {"widget": widgets.AdminFileWidget},
  102. models.FileField: {"widget": widgets.AdminFileWidget},
  103. models.EmailField: {"widget": widgets.AdminEmailInputWidget},
  104. models.UUIDField: {"widget": widgets.AdminUUIDInputWidget},
  105. }
  106. csrf_protect_m = method_decorator(csrf_protect)
  107. class BaseModelAdmin(metaclass=forms.MediaDefiningClass):
  108. """Functionality common to both ModelAdmin and InlineAdmin."""
  109. autocomplete_fields = ()
  110. raw_id_fields = ()
  111. fields = None
  112. exclude = None
  113. fieldsets = None
  114. form = forms.ModelForm
  115. filter_vertical = ()
  116. filter_horizontal = ()
  117. radio_fields = {}
  118. prepopulated_fields = {}
  119. formfield_overrides = {}
  120. readonly_fields = ()
  121. ordering = None
  122. sortable_by = None
  123. view_on_site = True
  124. show_full_result_count = True
  125. checks_class = BaseModelAdminChecks
  126. def check(self, **kwargs):
  127. return self.checks_class().check(self, **kwargs)
  128. def __init__(self):
  129. # Merge FORMFIELD_FOR_DBFIELD_DEFAULTS with the formfield_overrides
  130. # rather than simply overwriting.
  131. overrides = copy.deepcopy(FORMFIELD_FOR_DBFIELD_DEFAULTS)
  132. for k, v in self.formfield_overrides.items():
  133. overrides.setdefault(k, {}).update(v)
  134. self.formfield_overrides = overrides
  135. def formfield_for_dbfield(self, db_field, request, **kwargs):
  136. """
  137. Hook for specifying the form Field instance for a given database Field
  138. instance.
  139. If kwargs are given, they're passed to the form Field's constructor.
  140. """
  141. # If the field specifies choices, we don't need to look for special
  142. # admin widgets - we just need to use a select widget of some kind.
  143. if db_field.choices:
  144. return self.formfield_for_choice_field(db_field, request, **kwargs)
  145. # ForeignKey or ManyToManyFields
  146. if isinstance(db_field, (models.ForeignKey, models.ManyToManyField)):
  147. # Combine the field kwargs with any options for formfield_overrides.
  148. # Make sure the passed in **kwargs override anything in
  149. # formfield_overrides because **kwargs is more specific, and should
  150. # always win.
  151. if db_field.__class__ in self.formfield_overrides:
  152. kwargs = {**self.formfield_overrides[db_field.__class__], **kwargs}
  153. # Get the correct formfield.
  154. if isinstance(db_field, models.ForeignKey):
  155. formfield = self.formfield_for_foreignkey(db_field, request, **kwargs)
  156. elif isinstance(db_field, models.ManyToManyField):
  157. formfield = self.formfield_for_manytomany(db_field, request, **kwargs)
  158. # For non-raw_id fields, wrap the widget with a wrapper that adds
  159. # extra HTML -- the "add other" interface -- to the end of the
  160. # rendered output. formfield can be None if it came from a
  161. # OneToOneField with parent_link=True or a M2M intermediary.
  162. if formfield and db_field.name not in self.raw_id_fields:
  163. try:
  164. related_modeladmin = self.admin_site.get_model_admin(
  165. db_field.remote_field.model
  166. )
  167. except NotRegistered:
  168. wrapper_kwargs = {}
  169. else:
  170. wrapper_kwargs = {
  171. "can_add_related": related_modeladmin.has_add_permission(
  172. request
  173. ),
  174. "can_change_related": related_modeladmin.has_change_permission(
  175. request
  176. ),
  177. "can_delete_related": related_modeladmin.has_delete_permission(
  178. request
  179. ),
  180. "can_view_related": related_modeladmin.has_view_permission(
  181. request
  182. ),
  183. }
  184. formfield.widget = widgets.RelatedFieldWidgetWrapper(
  185. formfield.widget,
  186. db_field.remote_field,
  187. self.admin_site,
  188. **wrapper_kwargs,
  189. )
  190. return formfield
  191. # If we've got overrides for the formfield defined, use 'em. **kwargs
  192. # passed to formfield_for_dbfield override the defaults.
  193. for klass in db_field.__class__.mro():
  194. if klass in self.formfield_overrides:
  195. kwargs = {**copy.deepcopy(self.formfield_overrides[klass]), **kwargs}
  196. return db_field.formfield(**kwargs)
  197. # For any other type of field, just call its formfield() method.
  198. return db_field.formfield(**kwargs)
  199. def formfield_for_choice_field(self, db_field, request, **kwargs):
  200. """
  201. Get a form Field for a database Field that has declared choices.
  202. """
  203. # If the field is named as a radio_field, use a RadioSelect
  204. if db_field.name in self.radio_fields:
  205. # Avoid stomping on custom widget/choices arguments.
  206. if "widget" not in kwargs:
  207. kwargs["widget"] = widgets.AdminRadioSelect(
  208. attrs={
  209. "class": get_ul_class(self.radio_fields[db_field.name]),
  210. }
  211. )
  212. if "choices" not in kwargs:
  213. kwargs["choices"] = db_field.get_choices(
  214. include_blank=db_field.blank, blank_choice=[("", _("None"))]
  215. )
  216. return db_field.formfield(**kwargs)
  217. def get_field_queryset(self, db, db_field, request):
  218. """
  219. If the ModelAdmin specifies ordering, the queryset should respect that
  220. ordering. Otherwise don't specify the queryset, let the field decide
  221. (return None in that case).
  222. """
  223. try:
  224. related_admin = self.admin_site.get_model_admin(db_field.remote_field.model)
  225. except NotRegistered:
  226. return None
  227. else:
  228. ordering = related_admin.get_ordering(request)
  229. if ordering is not None and ordering != ():
  230. return db_field.remote_field.model._default_manager.using(db).order_by(
  231. *ordering
  232. )
  233. return None
  234. def formfield_for_foreignkey(self, db_field, request, **kwargs):
  235. """
  236. Get a form Field for a ForeignKey.
  237. """
  238. db = kwargs.get("using")
  239. if "widget" not in kwargs:
  240. if db_field.name in self.get_autocomplete_fields(request):
  241. kwargs["widget"] = AutocompleteSelect(
  242. db_field, self.admin_site, using=db
  243. )
  244. elif db_field.name in self.raw_id_fields:
  245. kwargs["widget"] = widgets.ForeignKeyRawIdWidget(
  246. db_field.remote_field, self.admin_site, using=db
  247. )
  248. elif db_field.name in self.radio_fields:
  249. kwargs["widget"] = widgets.AdminRadioSelect(
  250. attrs={
  251. "class": get_ul_class(self.radio_fields[db_field.name]),
  252. }
  253. )
  254. kwargs["empty_label"] = (
  255. kwargs.get("empty_label", _("None")) if db_field.blank else None
  256. )
  257. if "queryset" not in kwargs:
  258. queryset = self.get_field_queryset(db, db_field, request)
  259. if queryset is not None:
  260. kwargs["queryset"] = queryset
  261. return db_field.formfield(**kwargs)
  262. def formfield_for_manytomany(self, db_field, request, **kwargs):
  263. """
  264. Get a form Field for a ManyToManyField.
  265. """
  266. # If it uses an intermediary model that isn't auto created, don't show
  267. # a field in admin.
  268. if not db_field.remote_field.through._meta.auto_created:
  269. return None
  270. db = kwargs.get("using")
  271. if "widget" not in kwargs:
  272. autocomplete_fields = self.get_autocomplete_fields(request)
  273. if db_field.name in autocomplete_fields:
  274. kwargs["widget"] = AutocompleteSelectMultiple(
  275. db_field,
  276. self.admin_site,
  277. using=db,
  278. )
  279. elif db_field.name in self.raw_id_fields:
  280. kwargs["widget"] = widgets.ManyToManyRawIdWidget(
  281. db_field.remote_field,
  282. self.admin_site,
  283. using=db,
  284. )
  285. elif db_field.name in [*self.filter_vertical, *self.filter_horizontal]:
  286. kwargs["widget"] = widgets.FilteredSelectMultiple(
  287. db_field.verbose_name, db_field.name in self.filter_vertical
  288. )
  289. if "queryset" not in kwargs:
  290. queryset = self.get_field_queryset(db, db_field, request)
  291. if queryset is not None:
  292. kwargs["queryset"] = queryset
  293. form_field = db_field.formfield(**kwargs)
  294. if (
  295. isinstance(form_field.widget, SelectMultiple)
  296. and form_field.widget.allow_multiple_selected
  297. and not isinstance(
  298. form_field.widget, (CheckboxSelectMultiple, AutocompleteSelectMultiple)
  299. )
  300. ):
  301. msg = _(
  302. "Hold down “Control”, or “Command” on a Mac, to select more than one."
  303. )
  304. help_text = form_field.help_text
  305. form_field.help_text = (
  306. format_lazy("{} {}", help_text, msg) if help_text else msg
  307. )
  308. return form_field
  309. def get_autocomplete_fields(self, request):
  310. """
  311. Return a list of ForeignKey and/or ManyToMany fields which should use
  312. an autocomplete widget.
  313. """
  314. return self.autocomplete_fields
  315. def get_view_on_site_url(self, obj=None):
  316. if obj is None or not self.view_on_site:
  317. return None
  318. if callable(self.view_on_site):
  319. return self.view_on_site(obj)
  320. elif hasattr(obj, "get_absolute_url"):
  321. # use the ContentType lookup if view_on_site is True
  322. return reverse(
  323. "admin:view_on_site",
  324. kwargs={
  325. "content_type_id": get_content_type_for_model(obj).pk,
  326. "object_id": obj.pk,
  327. },
  328. current_app=self.admin_site.name,
  329. )
  330. def get_empty_value_display(self):
  331. """
  332. Return the empty_value_display set on ModelAdmin or AdminSite.
  333. """
  334. try:
  335. return mark_safe(self.empty_value_display)
  336. except AttributeError:
  337. return mark_safe(self.admin_site.empty_value_display)
  338. def get_exclude(self, request, obj=None):
  339. """
  340. Hook for specifying exclude.
  341. """
  342. return self.exclude
  343. def get_fields(self, request, obj=None):
  344. """
  345. Hook for specifying fields.
  346. """
  347. if self.fields:
  348. return self.fields
  349. # _get_form_for_get_fields() is implemented in subclasses.
  350. form = self._get_form_for_get_fields(request, obj)
  351. return [*form.base_fields, *self.get_readonly_fields(request, obj)]
  352. def get_fieldsets(self, request, obj=None):
  353. """
  354. Hook for specifying fieldsets.
  355. """
  356. if self.fieldsets:
  357. return self.fieldsets
  358. return [(None, {"fields": self.get_fields(request, obj)})]
  359. def get_inlines(self, request, obj):
  360. """Hook for specifying custom inlines."""
  361. return self.inlines
  362. def get_ordering(self, request):
  363. """
  364. Hook for specifying field ordering.
  365. """
  366. return self.ordering or () # otherwise we might try to *None, which is bad ;)
  367. def get_readonly_fields(self, request, obj=None):
  368. """
  369. Hook for specifying custom readonly fields.
  370. """
  371. return self.readonly_fields
  372. def get_prepopulated_fields(self, request, obj=None):
  373. """
  374. Hook for specifying custom prepopulated fields.
  375. """
  376. return self.prepopulated_fields
  377. def get_queryset(self, request):
  378. """
  379. Return a QuerySet of all model instances that can be edited by the
  380. admin site. This is used by changelist_view.
  381. """
  382. qs = self.model._default_manager.get_queryset()
  383. # TODO: this should be handled by some parameter to the ChangeList.
  384. ordering = self.get_ordering(request)
  385. if ordering:
  386. qs = qs.order_by(*ordering)
  387. return qs
  388. def get_sortable_by(self, request):
  389. """Hook for specifying which fields can be sorted in the changelist."""
  390. return (
  391. self.sortable_by
  392. if self.sortable_by is not None
  393. else self.get_list_display(request)
  394. )
  395. # RemovedInDjango60Warning: when the deprecation ends, replace with:
  396. # def lookup_allowed(self, lookup, value, request):
  397. def lookup_allowed(self, lookup, value, request=None):
  398. from django.contrib.admin.filters import SimpleListFilter
  399. model = self.model
  400. # Check FKey lookups that are allowed, so that popups produced by
  401. # ForeignKeyRawIdWidget, on the basis of ForeignKey.limit_choices_to,
  402. # are allowed to work.
  403. for fk_lookup in model._meta.related_fkey_lookups:
  404. # As ``limit_choices_to`` can be a callable, invoke it here.
  405. if callable(fk_lookup):
  406. fk_lookup = fk_lookup()
  407. if (lookup, value) in widgets.url_params_from_lookup_dict(
  408. fk_lookup
  409. ).items():
  410. return True
  411. relation_parts = []
  412. prev_field = None
  413. for part in lookup.split(LOOKUP_SEP):
  414. try:
  415. field = model._meta.get_field(part)
  416. except FieldDoesNotExist:
  417. # Lookups on nonexistent fields are ok, since they're ignored
  418. # later.
  419. break
  420. if not prev_field or (
  421. prev_field.is_relation
  422. and field not in model._meta.parents.values()
  423. and field is not model._meta.auto_field
  424. and (
  425. model._meta.auto_field is None
  426. or part not in getattr(prev_field, "to_fields", [])
  427. )
  428. ):
  429. relation_parts.append(part)
  430. if not getattr(field, "path_infos", None):
  431. # This is not a relational field, so further parts
  432. # must be transforms.
  433. break
  434. prev_field = field
  435. model = field.path_infos[-1].to_opts.model
  436. if len(relation_parts) <= 1:
  437. # Either a local field filter, or no fields at all.
  438. return True
  439. valid_lookups = {self.date_hierarchy}
  440. # RemovedInDjango60Warning: when the deprecation ends, replace with:
  441. # for filter_item in self.get_list_filter(request):
  442. list_filter = (
  443. self.get_list_filter(request) if request is not None else self.list_filter
  444. )
  445. for filter_item in list_filter:
  446. if isinstance(filter_item, type) and issubclass(
  447. filter_item, SimpleListFilter
  448. ):
  449. valid_lookups.add(filter_item.parameter_name)
  450. elif isinstance(filter_item, (list, tuple)):
  451. valid_lookups.add(filter_item[0])
  452. else:
  453. valid_lookups.add(filter_item)
  454. # Is it a valid relational lookup?
  455. return not {
  456. LOOKUP_SEP.join(relation_parts),
  457. LOOKUP_SEP.join(relation_parts + [part]),
  458. }.isdisjoint(valid_lookups)
  459. def to_field_allowed(self, request, to_field):
  460. """
  461. Return True if the model associated with this admin should be
  462. allowed to be referenced by the specified field.
  463. """
  464. try:
  465. field = self.opts.get_field(to_field)
  466. except FieldDoesNotExist:
  467. return False
  468. # Always allow referencing the primary key since it's already possible
  469. # to get this information from the change view URL.
  470. if field.primary_key:
  471. return True
  472. # Allow reverse relationships to models defining m2m fields if they
  473. # target the specified field.
  474. for many_to_many in self.opts.many_to_many:
  475. if many_to_many.m2m_target_field_name() == to_field:
  476. return True
  477. # Make sure at least one of the models registered for this site
  478. # references this field through a FK or a M2M relationship.
  479. registered_models = set()
  480. for model, admin in self.admin_site._registry.items():
  481. registered_models.add(model)
  482. for inline in admin.inlines:
  483. registered_models.add(inline.model)
  484. related_objects = (
  485. f
  486. for f in self.opts.get_fields(include_hidden=True)
  487. if (f.auto_created and not f.concrete)
  488. )
  489. for related_object in related_objects:
  490. related_model = related_object.related_model
  491. remote_field = related_object.field.remote_field
  492. if (
  493. any(issubclass(model, related_model) for model in registered_models)
  494. and hasattr(remote_field, "get_related_field")
  495. and remote_field.get_related_field() == field
  496. ):
  497. return True
  498. return False
  499. def has_add_permission(self, request):
  500. """
  501. Return True if the given request has permission to add an object.
  502. Can be overridden by the user in subclasses.
  503. """
  504. opts = self.opts
  505. codename = get_permission_codename("add", opts)
  506. return request.user.has_perm("%s.%s" % (opts.app_label, codename))
  507. def has_change_permission(self, request, obj=None):
  508. """
  509. Return True if the given request has permission to change the given
  510. Django model instance, the default implementation doesn't examine the
  511. `obj` parameter.
  512. Can be overridden by the user in subclasses. In such case it should
  513. return True if the given request has permission to change the `obj`
  514. model instance. If `obj` is None, this should return True if the given
  515. request has permission to change *any* object of the given type.
  516. """
  517. opts = self.opts
  518. codename = get_permission_codename("change", opts)
  519. return request.user.has_perm("%s.%s" % (opts.app_label, codename))
  520. def has_delete_permission(self, request, obj=None):
  521. """
  522. Return True if the given request has permission to delete the given
  523. Django model instance, the default implementation doesn't examine the
  524. `obj` parameter.
  525. Can be overridden by the user in subclasses. In such case it should
  526. return True if the given request has permission to delete the `obj`
  527. model instance. If `obj` is None, this should return True if the given
  528. request has permission to delete *any* object of the given type.
  529. """
  530. opts = self.opts
  531. codename = get_permission_codename("delete", opts)
  532. return request.user.has_perm("%s.%s" % (opts.app_label, codename))
  533. def has_view_permission(self, request, obj=None):
  534. """
  535. Return True if the given request has permission to view the given
  536. Django model instance. The default implementation doesn't examine the
  537. `obj` parameter.
  538. If overridden by the user in subclasses, it should return True if the
  539. given request has permission to view the `obj` model instance. If `obj`
  540. is None, it should return True if the request has permission to view
  541. any object of the given type.
  542. """
  543. opts = self.opts
  544. codename_view = get_permission_codename("view", opts)
  545. codename_change = get_permission_codename("change", opts)
  546. return request.user.has_perm(
  547. "%s.%s" % (opts.app_label, codename_view)
  548. ) or request.user.has_perm("%s.%s" % (opts.app_label, codename_change))
  549. def has_view_or_change_permission(self, request, obj=None):
  550. return self.has_view_permission(request, obj) or self.has_change_permission(
  551. request, obj
  552. )
  553. def has_module_permission(self, request):
  554. """
  555. Return True if the given request has any permission in the given
  556. app label.
  557. Can be overridden by the user in subclasses. In such case it should
  558. return True if the given request has permission to view the module on
  559. the admin index page and access the module's index page. Overriding it
  560. does not restrict access to the add, change or delete views. Use
  561. `ModelAdmin.has_(add|change|delete)_permission` for that.
  562. """
  563. return request.user.has_module_perms(self.opts.app_label)
  564. class ModelAdmin(BaseModelAdmin):
  565. """Encapsulate all admin options and functionality for a given model."""
  566. list_display = ("__str__",)
  567. list_display_links = ()
  568. list_filter = ()
  569. list_select_related = False
  570. list_per_page = 100
  571. list_max_show_all = 200
  572. list_editable = ()
  573. search_fields = ()
  574. search_help_text = None
  575. date_hierarchy = None
  576. save_as = False
  577. save_as_continue = True
  578. save_on_top = False
  579. paginator = Paginator
  580. preserve_filters = True
  581. show_facets = ShowFacets.ALLOW
  582. inlines = ()
  583. # Custom templates (designed to be over-ridden in subclasses)
  584. add_form_template = None
  585. change_form_template = None
  586. change_list_template = None
  587. delete_confirmation_template = None
  588. delete_selected_confirmation_template = None
  589. object_history_template = None
  590. popup_response_template = None
  591. # Actions
  592. actions = ()
  593. action_form = helpers.ActionForm
  594. actions_on_top = True
  595. actions_on_bottom = False
  596. actions_selection_counter = True
  597. checks_class = ModelAdminChecks
  598. def __init__(self, model, admin_site):
  599. self.model = model
  600. self.opts = model._meta
  601. self.admin_site = admin_site
  602. super().__init__()
  603. def __str__(self):
  604. return "%s.%s" % (self.opts.app_label, self.__class__.__name__)
  605. def __repr__(self):
  606. return (
  607. f"<{self.__class__.__qualname__}: model={self.model.__qualname__} "
  608. f"site={self.admin_site!r}>"
  609. )
  610. def get_inline_instances(self, request, obj=None):
  611. inline_instances = []
  612. for inline_class in self.get_inlines(request, obj):
  613. inline = inline_class(self.model, self.admin_site)
  614. if request:
  615. if not (
  616. inline.has_view_or_change_permission(request, obj)
  617. or inline.has_add_permission(request, obj)
  618. or inline.has_delete_permission(request, obj)
  619. ):
  620. continue
  621. if not inline.has_add_permission(request, obj):
  622. inline.max_num = 0
  623. inline_instances.append(inline)
  624. return inline_instances
  625. def get_urls(self):
  626. from django.urls import path
  627. def wrap(view):
  628. def wrapper(*args, **kwargs):
  629. return self.admin_site.admin_view(view)(*args, **kwargs)
  630. wrapper.model_admin = self
  631. return update_wrapper(wrapper, view)
  632. info = self.opts.app_label, self.opts.model_name
  633. return [
  634. path("", wrap(self.changelist_view), name="%s_%s_changelist" % info),
  635. path("add/", wrap(self.add_view), name="%s_%s_add" % info),
  636. path(
  637. "<path:object_id>/history/",
  638. wrap(self.history_view),
  639. name="%s_%s_history" % info,
  640. ),
  641. path(
  642. "<path:object_id>/delete/",
  643. wrap(self.delete_view),
  644. name="%s_%s_delete" % info,
  645. ),
  646. path(
  647. "<path:object_id>/change/",
  648. wrap(self.change_view),
  649. name="%s_%s_change" % info,
  650. ),
  651. # For backwards compatibility (was the change url before 1.9)
  652. path(
  653. "<path:object_id>/",
  654. wrap(
  655. RedirectView.as_view(
  656. pattern_name="%s:%s_%s_change"
  657. % ((self.admin_site.name,) + info)
  658. )
  659. ),
  660. ),
  661. ]
  662. @property
  663. def urls(self):
  664. return self.get_urls()
  665. @property
  666. def media(self):
  667. extra = "" if settings.DEBUG else ".min"
  668. js = [
  669. "vendor/jquery/jquery%s.js" % extra,
  670. "jquery.init.js",
  671. "core.js",
  672. "admin/RelatedObjectLookups.js",
  673. "actions.js",
  674. "urlify.js",
  675. "prepopulate.js",
  676. "vendor/xregexp/xregexp%s.js" % extra,
  677. ]
  678. return forms.Media(js=["admin/js/%s" % url for url in js])
  679. def get_model_perms(self, request):
  680. """
  681. Return a dict of all perms for this model. This dict has the keys
  682. ``add``, ``change``, ``delete``, and ``view`` mapping to the True/False
  683. for each of those actions.
  684. """
  685. return {
  686. "add": self.has_add_permission(request),
  687. "change": self.has_change_permission(request),
  688. "delete": self.has_delete_permission(request),
  689. "view": self.has_view_permission(request),
  690. }
  691. def _get_form_for_get_fields(self, request, obj):
  692. return self.get_form(request, obj, fields=None)
  693. def get_form(self, request, obj=None, change=False, **kwargs):
  694. """
  695. Return a Form class for use in the admin add view. This is used by
  696. add_view and change_view.
  697. """
  698. if "fields" in kwargs:
  699. fields = kwargs.pop("fields")
  700. else:
  701. fields = flatten_fieldsets(self.get_fieldsets(request, obj))
  702. excluded = self.get_exclude(request, obj)
  703. exclude = [] if excluded is None else list(excluded)
  704. readonly_fields = self.get_readonly_fields(request, obj)
  705. exclude.extend(readonly_fields)
  706. # Exclude all fields if it's a change form and the user doesn't have
  707. # the change permission.
  708. if (
  709. change
  710. and hasattr(request, "user")
  711. and not self.has_change_permission(request, obj)
  712. ):
  713. exclude.extend(fields)
  714. if excluded is None and hasattr(self.form, "_meta") and self.form._meta.exclude:
  715. # Take the custom ModelForm's Meta.exclude into account only if the
  716. # ModelAdmin doesn't define its own.
  717. exclude.extend(self.form._meta.exclude)
  718. # if exclude is an empty list we pass None to be consistent with the
  719. # default on modelform_factory
  720. exclude = exclude or None
  721. # Remove declared form fields which are in readonly_fields.
  722. new_attrs = dict.fromkeys(
  723. f for f in readonly_fields if f in self.form.declared_fields
  724. )
  725. form = type(self.form.__name__, (self.form,), new_attrs)
  726. defaults = {
  727. "form": form,
  728. "fields": fields,
  729. "exclude": exclude,
  730. "formfield_callback": partial(self.formfield_for_dbfield, request=request),
  731. **kwargs,
  732. }
  733. if defaults["fields"] is None and not modelform_defines_fields(
  734. defaults["form"]
  735. ):
  736. defaults["fields"] = forms.ALL_FIELDS
  737. try:
  738. return modelform_factory(self.model, **defaults)
  739. except FieldError as e:
  740. raise FieldError(
  741. "%s. Check fields/fieldsets/exclude attributes of class %s."
  742. % (e, self.__class__.__name__)
  743. )
  744. def get_changelist(self, request, **kwargs):
  745. """
  746. Return the ChangeList class for use on the changelist page.
  747. """
  748. from django.contrib.admin.views.main import ChangeList
  749. return ChangeList
  750. def get_changelist_instance(self, request):
  751. """
  752. Return a `ChangeList` instance based on `request`. May raise
  753. `IncorrectLookupParameters`.
  754. """
  755. list_display = self.get_list_display(request)
  756. list_display_links = self.get_list_display_links(request, list_display)
  757. # Add the action checkboxes if any actions are available.
  758. if self.get_actions(request):
  759. list_display = ["action_checkbox", *list_display]
  760. sortable_by = self.get_sortable_by(request)
  761. ChangeList = self.get_changelist(request)
  762. return ChangeList(
  763. request,
  764. self.model,
  765. list_display,
  766. list_display_links,
  767. self.get_list_filter(request),
  768. self.date_hierarchy,
  769. self.get_search_fields(request),
  770. self.get_list_select_related(request),
  771. self.list_per_page,
  772. self.list_max_show_all,
  773. self.list_editable,
  774. self,
  775. sortable_by,
  776. self.search_help_text,
  777. )
  778. def get_object(self, request, object_id, from_field=None):
  779. """
  780. Return an instance matching the field and value provided, the primary
  781. key is used if no field is provided. Return ``None`` if no match is
  782. found or the object_id fails validation.
  783. """
  784. queryset = self.get_queryset(request)
  785. model = queryset.model
  786. field = (
  787. model._meta.pk if from_field is None else model._meta.get_field(from_field)
  788. )
  789. try:
  790. object_id = field.to_python(object_id)
  791. return queryset.get(**{field.name: object_id})
  792. except (model.DoesNotExist, ValidationError, ValueError):
  793. return None
  794. def get_changelist_form(self, request, **kwargs):
  795. """
  796. Return a Form class for use in the Formset on the changelist page.
  797. """
  798. defaults = {
  799. "formfield_callback": partial(self.formfield_for_dbfield, request=request),
  800. **kwargs,
  801. }
  802. if defaults.get("fields") is None and not modelform_defines_fields(
  803. defaults.get("form")
  804. ):
  805. defaults["fields"] = forms.ALL_FIELDS
  806. return modelform_factory(self.model, **defaults)
  807. def get_changelist_formset(self, request, **kwargs):
  808. """
  809. Return a FormSet class for use on the changelist page if list_editable
  810. is used.
  811. """
  812. defaults = {
  813. "formfield_callback": partial(self.formfield_for_dbfield, request=request),
  814. **kwargs,
  815. }
  816. return modelformset_factory(
  817. self.model,
  818. self.get_changelist_form(request),
  819. extra=0,
  820. fields=self.list_editable,
  821. **defaults,
  822. )
  823. def get_formsets_with_inlines(self, request, obj=None):
  824. """
  825. Yield formsets and the corresponding inlines.
  826. """
  827. for inline in self.get_inline_instances(request, obj):
  828. yield inline.get_formset(request, obj), inline
  829. def get_paginator(
  830. self, request, queryset, per_page, orphans=0, allow_empty_first_page=True
  831. ):
  832. return self.paginator(queryset, per_page, orphans, allow_empty_first_page)
  833. def log_addition(self, request, obj, message):
  834. """
  835. Log that an object has been successfully added.
  836. The default implementation creates an admin LogEntry object.
  837. """
  838. from django.contrib.admin.models import ADDITION, LogEntry
  839. return LogEntry.objects.log_action(
  840. user_id=request.user.pk,
  841. content_type_id=get_content_type_for_model(obj).pk,
  842. object_id=obj.pk,
  843. object_repr=str(obj),
  844. action_flag=ADDITION,
  845. change_message=message,
  846. )
  847. def log_change(self, request, obj, message):
  848. """
  849. Log that an object has been successfully changed.
  850. The default implementation creates an admin LogEntry object.
  851. """
  852. from django.contrib.admin.models import CHANGE, LogEntry
  853. return LogEntry.objects.log_action(
  854. user_id=request.user.pk,
  855. content_type_id=get_content_type_for_model(obj).pk,
  856. object_id=obj.pk,
  857. object_repr=str(obj),
  858. action_flag=CHANGE,
  859. change_message=message,
  860. )
  861. def log_deletion(self, request, obj, object_repr):
  862. """
  863. Log that an object will be deleted. Note that this method must be
  864. called before the deletion.
  865. The default implementation creates an admin LogEntry object.
  866. """
  867. from django.contrib.admin.models import DELETION, LogEntry
  868. return LogEntry.objects.log_action(
  869. user_id=request.user.pk,
  870. content_type_id=get_content_type_for_model(obj).pk,
  871. object_id=obj.pk,
  872. object_repr=object_repr,
  873. action_flag=DELETION,
  874. )
  875. def action_checkbox(self, obj):
  876. """
  877. A list_display column containing a checkbox widget.
  878. """
  879. attrs = {
  880. "class": "action-select",
  881. "aria-label": format_html(_("Select this object for an action - {}"), obj),
  882. }
  883. checkbox = forms.CheckboxInput(attrs, lambda value: False)
  884. return checkbox.render(helpers.ACTION_CHECKBOX_NAME, str(obj.pk))
  885. @staticmethod
  886. def _get_action_description(func, name):
  887. return getattr(func, "short_description", capfirst(name.replace("_", " ")))
  888. def _get_base_actions(self):
  889. """Return the list of actions, prior to any request-based filtering."""
  890. actions = []
  891. base_actions = (self.get_action(action) for action in self.actions or [])
  892. # get_action might have returned None, so filter any of those out.
  893. base_actions = [action for action in base_actions if action]
  894. base_action_names = {name for _, name, _ in base_actions}
  895. # Gather actions from the admin site first
  896. for name, func in self.admin_site.actions:
  897. if name in base_action_names:
  898. continue
  899. description = self._get_action_description(func, name)
  900. actions.append((func, name, description))
  901. # Add actions from this ModelAdmin.
  902. actions.extend(base_actions)
  903. return actions
  904. def _filter_actions_by_permissions(self, request, actions):
  905. """Filter out any actions that the user doesn't have access to."""
  906. filtered_actions = []
  907. for action in actions:
  908. callable = action[0]
  909. if not hasattr(callable, "allowed_permissions"):
  910. filtered_actions.append(action)
  911. continue
  912. permission_checks = (
  913. getattr(self, "has_%s_permission" % permission)
  914. for permission in callable.allowed_permissions
  915. )
  916. if any(has_permission(request) for has_permission in permission_checks):
  917. filtered_actions.append(action)
  918. return filtered_actions
  919. def get_actions(self, request):
  920. """
  921. Return a dictionary mapping the names of all actions for this
  922. ModelAdmin to a tuple of (callable, name, description) for each action.
  923. """
  924. # If self.actions is set to None that means actions are disabled on
  925. # this page.
  926. if self.actions is None or IS_POPUP_VAR in request.GET:
  927. return {}
  928. actions = self._filter_actions_by_permissions(request, self._get_base_actions())
  929. return {name: (func, name, desc) for func, name, desc in actions}
  930. def get_action_choices(self, request, default_choices=models.BLANK_CHOICE_DASH):
  931. """
  932. Return a list of choices for use in a form object. Each choice is a
  933. tuple (name, description).
  934. """
  935. choices = [] + default_choices
  936. for func, name, description in self.get_actions(request).values():
  937. choice = (name, description % model_format_dict(self.opts))
  938. choices.append(choice)
  939. return choices
  940. def get_action(self, action):
  941. """
  942. Return a given action from a parameter, which can either be a callable,
  943. or the name of a method on the ModelAdmin. Return is a tuple of
  944. (callable, name, description).
  945. """
  946. # If the action is a callable, just use it.
  947. if callable(action):
  948. func = action
  949. action = action.__name__
  950. # Next, look for a method. Grab it off self.__class__ to get an unbound
  951. # method instead of a bound one; this ensures that the calling
  952. # conventions are the same for functions and methods.
  953. elif hasattr(self.__class__, action):
  954. func = getattr(self.__class__, action)
  955. # Finally, look for a named method on the admin site
  956. else:
  957. try:
  958. func = self.admin_site.get_action(action)
  959. except KeyError:
  960. return None
  961. description = self._get_action_description(func, action)
  962. return func, action, description
  963. def get_list_display(self, request):
  964. """
  965. Return a sequence containing the fields to be displayed on the
  966. changelist.
  967. """
  968. return self.list_display
  969. def get_list_display_links(self, request, list_display):
  970. """
  971. Return a sequence containing the fields to be displayed as links
  972. on the changelist. The list_display parameter is the list of fields
  973. returned by get_list_display().
  974. """
  975. if (
  976. self.list_display_links
  977. or self.list_display_links is None
  978. or not list_display
  979. ):
  980. return self.list_display_links
  981. else:
  982. # Use only the first item in list_display as link
  983. return list(list_display)[:1]
  984. def get_list_filter(self, request):
  985. """
  986. Return a sequence containing the fields to be displayed as filters in
  987. the right sidebar of the changelist page.
  988. """
  989. return self.list_filter
  990. def get_list_select_related(self, request):
  991. """
  992. Return a list of fields to add to the select_related() part of the
  993. changelist items query.
  994. """
  995. return self.list_select_related
  996. def get_search_fields(self, request):
  997. """
  998. Return a sequence containing the fields to be searched whenever
  999. somebody submits a search query.
  1000. """
  1001. return self.search_fields
  1002. def get_search_results(self, request, queryset, search_term):
  1003. """
  1004. Return a tuple containing a queryset to implement the search
  1005. and a boolean indicating if the results may contain duplicates.
  1006. """
  1007. # Apply keyword searches.
  1008. def construct_search(field_name):
  1009. if field_name.startswith("^"):
  1010. return "%s__istartswith" % field_name.removeprefix("^")
  1011. elif field_name.startswith("="):
  1012. return "%s__iexact" % field_name.removeprefix("=")
  1013. elif field_name.startswith("@"):
  1014. return "%s__search" % field_name.removeprefix("@")
  1015. # Use field_name if it includes a lookup.
  1016. opts = queryset.model._meta
  1017. lookup_fields = field_name.split(LOOKUP_SEP)
  1018. # Go through the fields, following all relations.
  1019. prev_field = None
  1020. for path_part in lookup_fields:
  1021. if path_part == "pk":
  1022. path_part = opts.pk.name
  1023. try:
  1024. field = opts.get_field(path_part)
  1025. except FieldDoesNotExist:
  1026. # Use valid query lookups.
  1027. if prev_field and prev_field.get_lookup(path_part):
  1028. return field_name
  1029. else:
  1030. prev_field = field
  1031. if hasattr(field, "path_infos"):
  1032. # Update opts to follow the relation.
  1033. opts = field.path_infos[-1].to_opts
  1034. # Otherwise, use the field with icontains.
  1035. return "%s__icontains" % field_name
  1036. may_have_duplicates = False
  1037. search_fields = self.get_search_fields(request)
  1038. if search_fields and search_term:
  1039. orm_lookups = [
  1040. construct_search(str(search_field)) for search_field in search_fields
  1041. ]
  1042. term_queries = []
  1043. for bit in smart_split(search_term):
  1044. if bit.startswith(('"', "'")) and bit[0] == bit[-1]:
  1045. bit = unescape_string_literal(bit)
  1046. or_queries = models.Q.create(
  1047. [(orm_lookup, bit) for orm_lookup in orm_lookups],
  1048. connector=models.Q.OR,
  1049. )
  1050. term_queries.append(or_queries)
  1051. queryset = queryset.filter(models.Q.create(term_queries))
  1052. may_have_duplicates |= any(
  1053. lookup_spawns_duplicates(self.opts, search_spec)
  1054. for search_spec in orm_lookups
  1055. )
  1056. return queryset, may_have_duplicates
  1057. def get_preserved_filters(self, request):
  1058. """
  1059. Return the preserved filters querystring.
  1060. """
  1061. match = request.resolver_match
  1062. if self.preserve_filters and match:
  1063. current_url = "%s:%s" % (match.app_name, match.url_name)
  1064. changelist_url = "admin:%s_%s_changelist" % (
  1065. self.opts.app_label,
  1066. self.opts.model_name,
  1067. )
  1068. if current_url == changelist_url:
  1069. preserved_filters = request.GET.urlencode()
  1070. else:
  1071. preserved_filters = request.GET.get("_changelist_filters")
  1072. if preserved_filters:
  1073. return urlencode({"_changelist_filters": preserved_filters})
  1074. return ""
  1075. def construct_change_message(self, request, form, formsets, add=False):
  1076. """
  1077. Construct a JSON structure describing changes from a changed object.
  1078. """
  1079. return construct_change_message(form, formsets, add)
  1080. def message_user(
  1081. self, request, message, level=messages.INFO, extra_tags="", fail_silently=False
  1082. ):
  1083. """
  1084. Send a message to the user. The default implementation
  1085. posts a message using the django.contrib.messages backend.
  1086. Exposes almost the same API as messages.add_message(), but accepts the
  1087. positional arguments in a different order to maintain backwards
  1088. compatibility. For convenience, it accepts the `level` argument as
  1089. a string rather than the usual level number.
  1090. """
  1091. if not isinstance(level, int):
  1092. # attempt to get the level if passed a string
  1093. try:
  1094. level = getattr(messages.constants, level.upper())
  1095. except AttributeError:
  1096. levels = messages.constants.DEFAULT_TAGS.values()
  1097. levels_repr = ", ".join("`%s`" % level for level in levels)
  1098. raise ValueError(
  1099. "Bad message level string: `%s`. Possible values are: %s"
  1100. % (level, levels_repr)
  1101. )
  1102. messages.add_message(
  1103. request, level, message, extra_tags=extra_tags, fail_silently=fail_silently
  1104. )
  1105. def save_form(self, request, form, change):
  1106. """
  1107. Given a ModelForm return an unsaved instance. ``change`` is True if
  1108. the object is being changed, and False if it's being added.
  1109. """
  1110. return form.save(commit=False)
  1111. def save_model(self, request, obj, form, change):
  1112. """
  1113. Given a model instance save it to the database.
  1114. """
  1115. obj.save()
  1116. def delete_model(self, request, obj):
  1117. """
  1118. Given a model instance delete it from the database.
  1119. """
  1120. obj.delete()
  1121. def delete_queryset(self, request, queryset):
  1122. """Given a queryset, delete it from the database."""
  1123. queryset.delete()
  1124. def save_formset(self, request, form, formset, change):
  1125. """
  1126. Given an inline formset save it to the database.
  1127. """
  1128. formset.save()
  1129. def save_related(self, request, form, formsets, change):
  1130. """
  1131. Given the ``HttpRequest``, the parent ``ModelForm`` instance, the
  1132. list of inline formsets and a boolean value based on whether the
  1133. parent is being added or changed, save the related objects to the
  1134. database. Note that at this point save_form() and save_model() have
  1135. already been called.
  1136. """
  1137. form.save_m2m()
  1138. for formset in formsets:
  1139. self.save_formset(request, form, formset, change=change)
  1140. def render_change_form(
  1141. self, request, context, add=False, change=False, form_url="", obj=None
  1142. ):
  1143. app_label = self.opts.app_label
  1144. preserved_filters = self.get_preserved_filters(request)
  1145. form_url = add_preserved_filters(
  1146. {"preserved_filters": preserved_filters, "opts": self.opts}, form_url
  1147. )
  1148. view_on_site_url = self.get_view_on_site_url(obj)
  1149. has_editable_inline_admin_formsets = False
  1150. for inline in context["inline_admin_formsets"]:
  1151. if (
  1152. inline.has_add_permission
  1153. or inline.has_change_permission
  1154. or inline.has_delete_permission
  1155. ):
  1156. has_editable_inline_admin_formsets = True
  1157. break
  1158. context.update(
  1159. {
  1160. "add": add,
  1161. "change": change,
  1162. "has_view_permission": self.has_view_permission(request, obj),
  1163. "has_add_permission": self.has_add_permission(request),
  1164. "has_change_permission": self.has_change_permission(request, obj),
  1165. "has_delete_permission": self.has_delete_permission(request, obj),
  1166. "has_editable_inline_admin_formsets": (
  1167. has_editable_inline_admin_formsets
  1168. ),
  1169. "has_file_field": context["adminform"].form.is_multipart()
  1170. or any(
  1171. admin_formset.formset.is_multipart()
  1172. for admin_formset in context["inline_admin_formsets"]
  1173. ),
  1174. "has_absolute_url": view_on_site_url is not None,
  1175. "absolute_url": view_on_site_url,
  1176. "form_url": form_url,
  1177. "opts": self.opts,
  1178. "content_type_id": get_content_type_for_model(self.model).pk,
  1179. "save_as": self.save_as,
  1180. "save_on_top": self.save_on_top,
  1181. "to_field_var": TO_FIELD_VAR,
  1182. "is_popup_var": IS_POPUP_VAR,
  1183. "app_label": app_label,
  1184. }
  1185. )
  1186. if add and self.add_form_template is not None:
  1187. form_template = self.add_form_template
  1188. else:
  1189. form_template = self.change_form_template
  1190. request.current_app = self.admin_site.name
  1191. return TemplateResponse(
  1192. request,
  1193. form_template
  1194. or [
  1195. "admin/%s/%s/change_form.html" % (app_label, self.opts.model_name),
  1196. "admin/%s/change_form.html" % app_label,
  1197. "admin/change_form.html",
  1198. ],
  1199. context,
  1200. )
  1201. def _get_preserved_qsl(self, request, preserved_filters):
  1202. query_string = urlparse(request.build_absolute_uri()).query
  1203. return parse_qsl(query_string.replace(preserved_filters, ""))
  1204. def response_add(self, request, obj, post_url_continue=None):
  1205. """
  1206. Determine the HttpResponse for the add_view stage.
  1207. """
  1208. opts = obj._meta
  1209. preserved_filters = self.get_preserved_filters(request)
  1210. preserved_qsl = self._get_preserved_qsl(request, preserved_filters)
  1211. obj_url = reverse(
  1212. "admin:%s_%s_change" % (opts.app_label, opts.model_name),
  1213. args=(quote(obj.pk),),
  1214. current_app=self.admin_site.name,
  1215. )
  1216. # Add a link to the object's change form if the user can edit the obj.
  1217. if self.has_change_permission(request, obj):
  1218. obj_repr = format_html('<a href="{}">{}</a>', urlquote(obj_url), obj)
  1219. else:
  1220. obj_repr = str(obj)
  1221. msg_dict = {
  1222. "name": opts.verbose_name,
  1223. "obj": obj_repr,
  1224. }
  1225. # Here, we distinguish between different save types by checking for
  1226. # the presence of keys in request.POST.
  1227. if IS_POPUP_VAR in request.POST:
  1228. to_field = request.POST.get(TO_FIELD_VAR)
  1229. if to_field:
  1230. attr = str(to_field)
  1231. else:
  1232. attr = obj._meta.pk.attname
  1233. value = obj.serializable_value(attr)
  1234. popup_response_data = json.dumps(
  1235. {
  1236. "value": str(value),
  1237. "obj": str(obj),
  1238. }
  1239. )
  1240. return TemplateResponse(
  1241. request,
  1242. self.popup_response_template
  1243. or [
  1244. "admin/%s/%s/popup_response.html"
  1245. % (opts.app_label, opts.model_name),
  1246. "admin/%s/popup_response.html" % opts.app_label,
  1247. "admin/popup_response.html",
  1248. ],
  1249. {
  1250. "popup_response_data": popup_response_data,
  1251. },
  1252. )
  1253. elif "_continue" in request.POST or (
  1254. # Redirecting after "Save as new".
  1255. "_saveasnew" in request.POST
  1256. and self.save_as_continue
  1257. and self.has_change_permission(request, obj)
  1258. ):
  1259. msg = _("The {name} “{obj}” was added successfully.")
  1260. if self.has_change_permission(request, obj):
  1261. msg += " " + _("You may edit it again below.")
  1262. self.message_user(request, format_html(msg, **msg_dict), messages.SUCCESS)
  1263. if post_url_continue is None:
  1264. post_url_continue = obj_url
  1265. post_url_continue = add_preserved_filters(
  1266. {
  1267. "preserved_filters": preserved_filters,
  1268. "preserved_qsl": preserved_qsl,
  1269. "opts": opts,
  1270. },
  1271. post_url_continue,
  1272. )
  1273. return HttpResponseRedirect(post_url_continue)
  1274. elif "_addanother" in request.POST:
  1275. msg = format_html(
  1276. _(
  1277. "The {name} “{obj}” was added successfully. You may add another "
  1278. "{name} below."
  1279. ),
  1280. **msg_dict,
  1281. )
  1282. self.message_user(request, msg, messages.SUCCESS)
  1283. redirect_url = request.path
  1284. redirect_url = add_preserved_filters(
  1285. {
  1286. "preserved_filters": preserved_filters,
  1287. "preserved_qsl": preserved_qsl,
  1288. "opts": opts,
  1289. },
  1290. redirect_url,
  1291. )
  1292. return HttpResponseRedirect(redirect_url)
  1293. else:
  1294. msg = format_html(
  1295. _("The {name} “{obj}” was added successfully."), **msg_dict
  1296. )
  1297. self.message_user(request, msg, messages.SUCCESS)
  1298. return self.response_post_save_add(request, obj)
  1299. def response_change(self, request, obj):
  1300. """
  1301. Determine the HttpResponse for the change_view stage.
  1302. """
  1303. if IS_POPUP_VAR in request.POST:
  1304. opts = obj._meta
  1305. to_field = request.POST.get(TO_FIELD_VAR)
  1306. attr = str(to_field) if to_field else opts.pk.attname
  1307. value = request.resolver_match.kwargs["object_id"]
  1308. new_value = obj.serializable_value(attr)
  1309. popup_response_data = json.dumps(
  1310. {
  1311. "action": "change",
  1312. "value": str(value),
  1313. "obj": str(obj),
  1314. "new_value": str(new_value),
  1315. }
  1316. )
  1317. return TemplateResponse(
  1318. request,
  1319. self.popup_response_template
  1320. or [
  1321. "admin/%s/%s/popup_response.html"
  1322. % (opts.app_label, opts.model_name),
  1323. "admin/%s/popup_response.html" % opts.app_label,
  1324. "admin/popup_response.html",
  1325. ],
  1326. {
  1327. "popup_response_data": popup_response_data,
  1328. },
  1329. )
  1330. opts = self.opts
  1331. preserved_filters = self.get_preserved_filters(request)
  1332. preserved_qsl = self._get_preserved_qsl(request, preserved_filters)
  1333. msg_dict = {
  1334. "name": opts.verbose_name,
  1335. "obj": format_html('<a href="{}">{}</a>', urlquote(request.path), obj),
  1336. }
  1337. if "_continue" in request.POST:
  1338. msg = format_html(
  1339. _(
  1340. "The {name} “{obj}” was changed successfully. You may edit it "
  1341. "again below."
  1342. ),
  1343. **msg_dict,
  1344. )
  1345. self.message_user(request, msg, messages.SUCCESS)
  1346. redirect_url = request.path
  1347. redirect_url = add_preserved_filters(
  1348. {
  1349. "preserved_filters": preserved_filters,
  1350. "preserved_qsl": preserved_qsl,
  1351. "opts": opts,
  1352. },
  1353. redirect_url,
  1354. )
  1355. return HttpResponseRedirect(redirect_url)
  1356. elif "_saveasnew" in request.POST:
  1357. msg = format_html(
  1358. _(
  1359. "The {name} “{obj}” was added successfully. You may edit it again "
  1360. "below."
  1361. ),
  1362. **msg_dict,
  1363. )
  1364. self.message_user(request, msg, messages.SUCCESS)
  1365. redirect_url = reverse(
  1366. "admin:%s_%s_change" % (opts.app_label, opts.model_name),
  1367. args=(obj.pk,),
  1368. current_app=self.admin_site.name,
  1369. )
  1370. redirect_url = add_preserved_filters(
  1371. {"preserved_filters": preserved_filters, "opts": opts}, redirect_url
  1372. )
  1373. return HttpResponseRedirect(redirect_url)
  1374. elif "_addanother" in request.POST:
  1375. msg = format_html(
  1376. _(
  1377. "The {name} “{obj}” was changed successfully. You may add another "
  1378. "{name} below."
  1379. ),
  1380. **msg_dict,
  1381. )
  1382. self.message_user(request, msg, messages.SUCCESS)
  1383. redirect_url = reverse(
  1384. "admin:%s_%s_add" % (opts.app_label, opts.model_name),
  1385. current_app=self.admin_site.name,
  1386. )
  1387. redirect_url = add_preserved_filters(
  1388. {
  1389. "preserved_filters": preserved_filters,
  1390. "preserved_qsl": preserved_qsl,
  1391. "opts": opts,
  1392. },
  1393. redirect_url,
  1394. )
  1395. return HttpResponseRedirect(redirect_url)
  1396. else:
  1397. msg = format_html(
  1398. _("The {name} “{obj}” was changed successfully."), **msg_dict
  1399. )
  1400. self.message_user(request, msg, messages.SUCCESS)
  1401. return self.response_post_save_change(request, obj)
  1402. def _response_post_save(self, request, obj):
  1403. if self.has_view_or_change_permission(request):
  1404. post_url = reverse(
  1405. "admin:%s_%s_changelist" % (self.opts.app_label, self.opts.model_name),
  1406. current_app=self.admin_site.name,
  1407. )
  1408. preserved_filters = self.get_preserved_filters(request)
  1409. post_url = add_preserved_filters(
  1410. {"preserved_filters": preserved_filters, "opts": self.opts}, post_url
  1411. )
  1412. else:
  1413. post_url = reverse("admin:index", current_app=self.admin_site.name)
  1414. return HttpResponseRedirect(post_url)
  1415. def response_post_save_add(self, request, obj):
  1416. """
  1417. Figure out where to redirect after the 'Save' button has been pressed
  1418. when adding a new object.
  1419. """
  1420. return self._response_post_save(request, obj)
  1421. def response_post_save_change(self, request, obj):
  1422. """
  1423. Figure out where to redirect after the 'Save' button has been pressed
  1424. when editing an existing object.
  1425. """
  1426. return self._response_post_save(request, obj)
  1427. def response_action(self, request, queryset):
  1428. """
  1429. Handle an admin action. This is called if a request is POSTed to the
  1430. changelist; it returns an HttpResponse if the action was handled, and
  1431. None otherwise.
  1432. """
  1433. # There can be multiple action forms on the page (at the top
  1434. # and bottom of the change list, for example). Get the action
  1435. # whose button was pushed.
  1436. try:
  1437. action_index = int(request.POST.get("index", 0))
  1438. except ValueError:
  1439. action_index = 0
  1440. # Construct the action form.
  1441. data = request.POST.copy()
  1442. data.pop(helpers.ACTION_CHECKBOX_NAME, None)
  1443. data.pop("index", None)
  1444. # Use the action whose button was pushed
  1445. try:
  1446. data.update({"action": data.getlist("action")[action_index]})
  1447. except IndexError:
  1448. # If we didn't get an action from the chosen form that's invalid
  1449. # POST data, so by deleting action it'll fail the validation check
  1450. # below. So no need to do anything here
  1451. pass
  1452. action_form = self.action_form(data, auto_id=None)
  1453. action_form.fields["action"].choices = self.get_action_choices(request)
  1454. # If the form's valid we can handle the action.
  1455. if action_form.is_valid():
  1456. action = action_form.cleaned_data["action"]
  1457. select_across = action_form.cleaned_data["select_across"]
  1458. func = self.get_actions(request)[action][0]
  1459. # Get the list of selected PKs. If nothing's selected, we can't
  1460. # perform an action on it, so bail. Except we want to perform
  1461. # the action explicitly on all objects.
  1462. selected = request.POST.getlist(helpers.ACTION_CHECKBOX_NAME)
  1463. if not selected and not select_across:
  1464. # Reminder that something needs to be selected or nothing will happen
  1465. msg = _(
  1466. "Items must be selected in order to perform "
  1467. "actions on them. No items have been changed."
  1468. )
  1469. self.message_user(request, msg, messages.WARNING)
  1470. return None
  1471. if not select_across:
  1472. # Perform the action only on the selected objects
  1473. queryset = queryset.filter(pk__in=selected)
  1474. response = func(self, request, queryset)
  1475. # Actions may return an HttpResponse-like object, which will be
  1476. # used as the response from the POST. If not, we'll be a good
  1477. # little HTTP citizen and redirect back to the changelist page.
  1478. if isinstance(response, HttpResponseBase):
  1479. return response
  1480. else:
  1481. return HttpResponseRedirect(request.get_full_path())
  1482. else:
  1483. msg = _("No action selected.")
  1484. self.message_user(request, msg, messages.WARNING)
  1485. return None
  1486. def response_delete(self, request, obj_display, obj_id):
  1487. """
  1488. Determine the HttpResponse for the delete_view stage.
  1489. """
  1490. if IS_POPUP_VAR in request.POST:
  1491. popup_response_data = json.dumps(
  1492. {
  1493. "action": "delete",
  1494. "value": str(obj_id),
  1495. }
  1496. )
  1497. return TemplateResponse(
  1498. request,
  1499. self.popup_response_template
  1500. or [
  1501. "admin/%s/%s/popup_response.html"
  1502. % (self.opts.app_label, self.opts.model_name),
  1503. "admin/%s/popup_response.html" % self.opts.app_label,
  1504. "admin/popup_response.html",
  1505. ],
  1506. {
  1507. "popup_response_data": popup_response_data,
  1508. },
  1509. )
  1510. self.message_user(
  1511. request,
  1512. _("The %(name)s “%(obj)s” was deleted successfully.")
  1513. % {
  1514. "name": self.opts.verbose_name,
  1515. "obj": obj_display,
  1516. },
  1517. messages.SUCCESS,
  1518. )
  1519. if self.has_change_permission(request, None):
  1520. post_url = reverse(
  1521. "admin:%s_%s_changelist" % (self.opts.app_label, self.opts.model_name),
  1522. current_app=self.admin_site.name,
  1523. )
  1524. preserved_filters = self.get_preserved_filters(request)
  1525. post_url = add_preserved_filters(
  1526. {"preserved_filters": preserved_filters, "opts": self.opts}, post_url
  1527. )
  1528. else:
  1529. post_url = reverse("admin:index", current_app=self.admin_site.name)
  1530. return HttpResponseRedirect(post_url)
  1531. def render_delete_form(self, request, context):
  1532. app_label = self.opts.app_label
  1533. request.current_app = self.admin_site.name
  1534. context.update(
  1535. to_field_var=TO_FIELD_VAR,
  1536. is_popup_var=IS_POPUP_VAR,
  1537. media=self.media,
  1538. )
  1539. return TemplateResponse(
  1540. request,
  1541. self.delete_confirmation_template
  1542. or [
  1543. "admin/{}/{}/delete_confirmation.html".format(
  1544. app_label, self.opts.model_name
  1545. ),
  1546. "admin/{}/delete_confirmation.html".format(app_label),
  1547. "admin/delete_confirmation.html",
  1548. ],
  1549. context,
  1550. )
  1551. def get_inline_formsets(self, request, formsets, inline_instances, obj=None):
  1552. # Edit permissions on parent model are required for editable inlines.
  1553. can_edit_parent = (
  1554. self.has_change_permission(request, obj)
  1555. if obj
  1556. else self.has_add_permission(request)
  1557. )
  1558. inline_admin_formsets = []
  1559. for inline, formset in zip(inline_instances, formsets):
  1560. fieldsets = list(inline.get_fieldsets(request, obj))
  1561. readonly = list(inline.get_readonly_fields(request, obj))
  1562. if can_edit_parent:
  1563. has_add_permission = inline.has_add_permission(request, obj)
  1564. has_change_permission = inline.has_change_permission(request, obj)
  1565. has_delete_permission = inline.has_delete_permission(request, obj)
  1566. else:
  1567. # Disable all edit-permissions, and override formset settings.
  1568. has_add_permission = (
  1569. has_change_permission
  1570. ) = has_delete_permission = False
  1571. formset.extra = formset.max_num = 0
  1572. has_view_permission = inline.has_view_permission(request, obj)
  1573. prepopulated = dict(inline.get_prepopulated_fields(request, obj))
  1574. inline_admin_formset = helpers.InlineAdminFormSet(
  1575. inline,
  1576. formset,
  1577. fieldsets,
  1578. prepopulated,
  1579. readonly,
  1580. model_admin=self,
  1581. has_add_permission=has_add_permission,
  1582. has_change_permission=has_change_permission,
  1583. has_delete_permission=has_delete_permission,
  1584. has_view_permission=has_view_permission,
  1585. )
  1586. inline_admin_formsets.append(inline_admin_formset)
  1587. return inline_admin_formsets
  1588. def get_changeform_initial_data(self, request):
  1589. """
  1590. Get the initial form data from the request's GET params.
  1591. """
  1592. initial = dict(request.GET.items())
  1593. for k in initial:
  1594. try:
  1595. f = self.opts.get_field(k)
  1596. except FieldDoesNotExist:
  1597. continue
  1598. # We have to special-case M2Ms as a list of comma-separated PKs.
  1599. if isinstance(f, models.ManyToManyField):
  1600. initial[k] = initial[k].split(",")
  1601. return initial
  1602. def _get_obj_does_not_exist_redirect(self, request, opts, object_id):
  1603. """
  1604. Create a message informing the user that the object doesn't exist
  1605. and return a redirect to the admin index page.
  1606. """
  1607. msg = _("%(name)s with ID “%(key)s” doesn’t exist. Perhaps it was deleted?") % {
  1608. "name": opts.verbose_name,
  1609. "key": unquote(object_id),
  1610. }
  1611. self.message_user(request, msg, messages.WARNING)
  1612. url = reverse("admin:index", current_app=self.admin_site.name)
  1613. return HttpResponseRedirect(url)
  1614. @csrf_protect_m
  1615. def changeform_view(self, request, object_id=None, form_url="", extra_context=None):
  1616. with transaction.atomic(using=router.db_for_write(self.model)):
  1617. return self._changeform_view(request, object_id, form_url, extra_context)
  1618. def _changeform_view(self, request, object_id, form_url, extra_context):
  1619. to_field = request.POST.get(TO_FIELD_VAR, request.GET.get(TO_FIELD_VAR))
  1620. if to_field and not self.to_field_allowed(request, to_field):
  1621. raise DisallowedModelAdminToField(
  1622. "The field %s cannot be referenced." % to_field
  1623. )
  1624. if request.method == "POST" and "_saveasnew" in request.POST:
  1625. object_id = None
  1626. add = object_id is None
  1627. if add:
  1628. if not self.has_add_permission(request):
  1629. raise PermissionDenied
  1630. obj = None
  1631. else:
  1632. obj = self.get_object(request, unquote(object_id), to_field)
  1633. if request.method == "POST":
  1634. if not self.has_change_permission(request, obj):
  1635. raise PermissionDenied
  1636. else:
  1637. if not self.has_view_or_change_permission(request, obj):
  1638. raise PermissionDenied
  1639. if obj is None:
  1640. return self._get_obj_does_not_exist_redirect(
  1641. request, self.opts, object_id
  1642. )
  1643. fieldsets = self.get_fieldsets(request, obj)
  1644. ModelForm = self.get_form(
  1645. request, obj, change=not add, fields=flatten_fieldsets(fieldsets)
  1646. )
  1647. if request.method == "POST":
  1648. form = ModelForm(request.POST, request.FILES, instance=obj)
  1649. formsets, inline_instances = self._create_formsets(
  1650. request,
  1651. form.instance,
  1652. change=not add,
  1653. )
  1654. form_validated = form.is_valid()
  1655. if form_validated:
  1656. new_object = self.save_form(request, form, change=not add)
  1657. else:
  1658. new_object = form.instance
  1659. if all_valid(formsets) and form_validated:
  1660. self.save_model(request, new_object, form, not add)
  1661. self.save_related(request, form, formsets, not add)
  1662. change_message = self.construct_change_message(
  1663. request, form, formsets, add
  1664. )
  1665. if add:
  1666. self.log_addition(request, new_object, change_message)
  1667. return self.response_add(request, new_object)
  1668. else:
  1669. self.log_change(request, new_object, change_message)
  1670. return self.response_change(request, new_object)
  1671. else:
  1672. form_validated = False
  1673. else:
  1674. if add:
  1675. initial = self.get_changeform_initial_data(request)
  1676. form = ModelForm(initial=initial)
  1677. formsets, inline_instances = self._create_formsets(
  1678. request, form.instance, change=False
  1679. )
  1680. else:
  1681. form = ModelForm(instance=obj)
  1682. formsets, inline_instances = self._create_formsets(
  1683. request, obj, change=True
  1684. )
  1685. if not add and not self.has_change_permission(request, obj):
  1686. readonly_fields = flatten_fieldsets(fieldsets)
  1687. else:
  1688. readonly_fields = self.get_readonly_fields(request, obj)
  1689. admin_form = helpers.AdminForm(
  1690. form,
  1691. list(fieldsets),
  1692. # Clear prepopulated fields on a view-only form to avoid a crash.
  1693. self.get_prepopulated_fields(request, obj)
  1694. if add or self.has_change_permission(request, obj)
  1695. else {},
  1696. readonly_fields,
  1697. model_admin=self,
  1698. )
  1699. media = self.media + admin_form.media
  1700. inline_formsets = self.get_inline_formsets(
  1701. request, formsets, inline_instances, obj
  1702. )
  1703. for inline_formset in inline_formsets:
  1704. media += inline_formset.media
  1705. if add:
  1706. title = _("Add %s")
  1707. elif self.has_change_permission(request, obj):
  1708. title = _("Change %s")
  1709. else:
  1710. title = _("View %s")
  1711. context = {
  1712. **self.admin_site.each_context(request),
  1713. "title": title % self.opts.verbose_name,
  1714. "subtitle": str(obj) if obj else None,
  1715. "adminform": admin_form,
  1716. "object_id": object_id,
  1717. "original": obj,
  1718. "is_popup": IS_POPUP_VAR in request.POST or IS_POPUP_VAR in request.GET,
  1719. "to_field": to_field,
  1720. "media": media,
  1721. "inline_admin_formsets": inline_formsets,
  1722. "errors": helpers.AdminErrorList(form, formsets),
  1723. "preserved_filters": self.get_preserved_filters(request),
  1724. }
  1725. # Hide the "Save" and "Save and continue" buttons if "Save as New" was
  1726. # previously chosen to prevent the interface from getting confusing.
  1727. if (
  1728. request.method == "POST"
  1729. and not form_validated
  1730. and "_saveasnew" in request.POST
  1731. ):
  1732. context["show_save"] = False
  1733. context["show_save_and_continue"] = False
  1734. # Use the change template instead of the add template.
  1735. add = False
  1736. context.update(extra_context or {})
  1737. return self.render_change_form(
  1738. request, context, add=add, change=not add, obj=obj, form_url=form_url
  1739. )
  1740. def add_view(self, request, form_url="", extra_context=None):
  1741. return self.changeform_view(request, None, form_url, extra_context)
  1742. def change_view(self, request, object_id, form_url="", extra_context=None):
  1743. return self.changeform_view(request, object_id, form_url, extra_context)
  1744. def _get_edited_object_pks(self, request, prefix):
  1745. """Return POST data values of list_editable primary keys."""
  1746. pk_pattern = re.compile(
  1747. r"{}-\d+-{}$".format(re.escape(prefix), self.opts.pk.name)
  1748. )
  1749. return [value for key, value in request.POST.items() if pk_pattern.match(key)]
  1750. def _get_list_editable_queryset(self, request, prefix):
  1751. """
  1752. Based on POST data, return a queryset of the objects that were edited
  1753. via list_editable.
  1754. """
  1755. object_pks = self._get_edited_object_pks(request, prefix)
  1756. queryset = self.get_queryset(request)
  1757. validate = queryset.model._meta.pk.to_python
  1758. try:
  1759. for pk in object_pks:
  1760. validate(pk)
  1761. except ValidationError:
  1762. # Disable the optimization if the POST data was tampered with.
  1763. return queryset
  1764. return queryset.filter(pk__in=object_pks)
  1765. @csrf_protect_m
  1766. def changelist_view(self, request, extra_context=None):
  1767. """
  1768. The 'change list' admin view for this model.
  1769. """
  1770. from django.contrib.admin.views.main import ERROR_FLAG
  1771. app_label = self.opts.app_label
  1772. if not self.has_view_or_change_permission(request):
  1773. raise PermissionDenied
  1774. try:
  1775. cl = self.get_changelist_instance(request)
  1776. except IncorrectLookupParameters:
  1777. # Wacky lookup parameters were given, so redirect to the main
  1778. # changelist page, without parameters, and pass an 'invalid=1'
  1779. # parameter via the query string. If wacky parameters were given
  1780. # and the 'invalid=1' parameter was already in the query string,
  1781. # something is screwed up with the database, so display an error
  1782. # page.
  1783. if ERROR_FLAG in request.GET:
  1784. return SimpleTemplateResponse(
  1785. "admin/invalid_setup.html",
  1786. {
  1787. "title": _("Database error"),
  1788. },
  1789. )
  1790. return HttpResponseRedirect(request.path + "?" + ERROR_FLAG + "=1")
  1791. # If the request was POSTed, this might be a bulk action or a bulk
  1792. # edit. Try to look up an action or confirmation first, but if this
  1793. # isn't an action the POST will fall through to the bulk edit check,
  1794. # below.
  1795. action_failed = False
  1796. selected = request.POST.getlist(helpers.ACTION_CHECKBOX_NAME)
  1797. actions = self.get_actions(request)
  1798. # Actions with no confirmation
  1799. if (
  1800. actions
  1801. and request.method == "POST"
  1802. and "index" in request.POST
  1803. and "_save" not in request.POST
  1804. ):
  1805. if selected:
  1806. response = self.response_action(
  1807. request, queryset=cl.get_queryset(request)
  1808. )
  1809. if response:
  1810. return response
  1811. else:
  1812. action_failed = True
  1813. else:
  1814. msg = _(
  1815. "Items must be selected in order to perform "
  1816. "actions on them. No items have been changed."
  1817. )
  1818. self.message_user(request, msg, messages.WARNING)
  1819. action_failed = True
  1820. # Actions with confirmation
  1821. if (
  1822. actions
  1823. and request.method == "POST"
  1824. and helpers.ACTION_CHECKBOX_NAME in request.POST
  1825. and "index" not in request.POST
  1826. and "_save" not in request.POST
  1827. ):
  1828. if selected:
  1829. response = self.response_action(
  1830. request, queryset=cl.get_queryset(request)
  1831. )
  1832. if response:
  1833. return response
  1834. else:
  1835. action_failed = True
  1836. if action_failed:
  1837. # Redirect back to the changelist page to avoid resubmitting the
  1838. # form if the user refreshes the browser or uses the "No, take
  1839. # me back" button on the action confirmation page.
  1840. return HttpResponseRedirect(request.get_full_path())
  1841. # If we're allowing changelist editing, we need to construct a formset
  1842. # for the changelist given all the fields to be edited. Then we'll
  1843. # use the formset to validate/process POSTed data.
  1844. formset = cl.formset = None
  1845. # Handle POSTed bulk-edit data.
  1846. if request.method == "POST" and cl.list_editable and "_save" in request.POST:
  1847. if not self.has_change_permission(request):
  1848. raise PermissionDenied
  1849. FormSet = self.get_changelist_formset(request)
  1850. modified_objects = self._get_list_editable_queryset(
  1851. request, FormSet.get_default_prefix()
  1852. )
  1853. formset = cl.formset = FormSet(
  1854. request.POST, request.FILES, queryset=modified_objects
  1855. )
  1856. if formset.is_valid():
  1857. changecount = 0
  1858. with transaction.atomic(using=router.db_for_write(self.model)):
  1859. for form in formset.forms:
  1860. if form.has_changed():
  1861. obj = self.save_form(request, form, change=True)
  1862. self.save_model(request, obj, form, change=True)
  1863. self.save_related(request, form, formsets=[], change=True)
  1864. change_msg = self.construct_change_message(
  1865. request, form, None
  1866. )
  1867. self.log_change(request, obj, change_msg)
  1868. changecount += 1
  1869. if changecount:
  1870. msg = ngettext(
  1871. "%(count)s %(name)s was changed successfully.",
  1872. "%(count)s %(name)s were changed successfully.",
  1873. changecount,
  1874. ) % {
  1875. "count": changecount,
  1876. "name": model_ngettext(self.opts, changecount),
  1877. }
  1878. self.message_user(request, msg, messages.SUCCESS)
  1879. return HttpResponseRedirect(request.get_full_path())
  1880. # Handle GET -- construct a formset for display.
  1881. elif cl.list_editable and self.has_change_permission(request):
  1882. FormSet = self.get_changelist_formset(request)
  1883. formset = cl.formset = FormSet(queryset=cl.result_list)
  1884. # Build the list of media to be used by the formset.
  1885. if formset:
  1886. media = self.media + formset.media
  1887. else:
  1888. media = self.media
  1889. # Build the action form and populate it with available actions.
  1890. if actions:
  1891. action_form = self.action_form(auto_id=None)
  1892. action_form.fields["action"].choices = self.get_action_choices(request)
  1893. media += action_form.media
  1894. else:
  1895. action_form = None
  1896. selection_note_all = ngettext(
  1897. "%(total_count)s selected", "All %(total_count)s selected", cl.result_count
  1898. )
  1899. context = {
  1900. **self.admin_site.each_context(request),
  1901. "module_name": str(self.opts.verbose_name_plural),
  1902. "selection_note": _("0 of %(cnt)s selected") % {"cnt": len(cl.result_list)},
  1903. "selection_note_all": selection_note_all % {"total_count": cl.result_count},
  1904. "title": cl.title,
  1905. "subtitle": None,
  1906. "is_popup": cl.is_popup,
  1907. "to_field": cl.to_field,
  1908. "cl": cl,
  1909. "media": media,
  1910. "has_add_permission": self.has_add_permission(request),
  1911. "opts": cl.opts,
  1912. "action_form": action_form,
  1913. "actions_on_top": self.actions_on_top,
  1914. "actions_on_bottom": self.actions_on_bottom,
  1915. "actions_selection_counter": self.actions_selection_counter,
  1916. "preserved_filters": self.get_preserved_filters(request),
  1917. **(extra_context or {}),
  1918. }
  1919. request.current_app = self.admin_site.name
  1920. return TemplateResponse(
  1921. request,
  1922. self.change_list_template
  1923. or [
  1924. "admin/%s/%s/change_list.html" % (app_label, self.opts.model_name),
  1925. "admin/%s/change_list.html" % app_label,
  1926. "admin/change_list.html",
  1927. ],
  1928. context,
  1929. )
  1930. def get_deleted_objects(self, objs, request):
  1931. """
  1932. Hook for customizing the delete process for the delete view and the
  1933. "delete selected" action.
  1934. """
  1935. return get_deleted_objects(objs, request, self.admin_site)
  1936. @csrf_protect_m
  1937. def delete_view(self, request, object_id, extra_context=None):
  1938. with transaction.atomic(using=router.db_for_write(self.model)):
  1939. return self._delete_view(request, object_id, extra_context)
  1940. def _delete_view(self, request, object_id, extra_context):
  1941. "The 'delete' admin view for this model."
  1942. app_label = self.opts.app_label
  1943. to_field = request.POST.get(TO_FIELD_VAR, request.GET.get(TO_FIELD_VAR))
  1944. if to_field and not self.to_field_allowed(request, to_field):
  1945. raise DisallowedModelAdminToField(
  1946. "The field %s cannot be referenced." % to_field
  1947. )
  1948. obj = self.get_object(request, unquote(object_id), to_field)
  1949. if not self.has_delete_permission(request, obj):
  1950. raise PermissionDenied
  1951. if obj is None:
  1952. return self._get_obj_does_not_exist_redirect(request, self.opts, object_id)
  1953. # Populate deleted_objects, a data structure of all related objects that
  1954. # will also be deleted.
  1955. (
  1956. deleted_objects,
  1957. model_count,
  1958. perms_needed,
  1959. protected,
  1960. ) = self.get_deleted_objects([obj], request)
  1961. if request.POST and not protected: # The user has confirmed the deletion.
  1962. if perms_needed:
  1963. raise PermissionDenied
  1964. obj_display = str(obj)
  1965. attr = str(to_field) if to_field else self.opts.pk.attname
  1966. obj_id = obj.serializable_value(attr)
  1967. self.log_deletion(request, obj, obj_display)
  1968. self.delete_model(request, obj)
  1969. return self.response_delete(request, obj_display, obj_id)
  1970. object_name = str(self.opts.verbose_name)
  1971. if perms_needed or protected:
  1972. title = _("Cannot delete %(name)s") % {"name": object_name}
  1973. else:
  1974. title = _("Are you sure?")
  1975. context = {
  1976. **self.admin_site.each_context(request),
  1977. "title": title,
  1978. "subtitle": None,
  1979. "object_name": object_name,
  1980. "object": obj,
  1981. "deleted_objects": deleted_objects,
  1982. "model_count": dict(model_count).items(),
  1983. "perms_lacking": perms_needed,
  1984. "protected": protected,
  1985. "opts": self.opts,
  1986. "app_label": app_label,
  1987. "preserved_filters": self.get_preserved_filters(request),
  1988. "is_popup": IS_POPUP_VAR in request.POST or IS_POPUP_VAR in request.GET,
  1989. "to_field": to_field,
  1990. **(extra_context or {}),
  1991. }
  1992. return self.render_delete_form(request, context)
  1993. def history_view(self, request, object_id, extra_context=None):
  1994. "The 'history' admin view for this model."
  1995. from django.contrib.admin.models import LogEntry
  1996. from django.contrib.admin.views.main import PAGE_VAR
  1997. # First check if the user can see this history.
  1998. model = self.model
  1999. obj = self.get_object(request, unquote(object_id))
  2000. if obj is None:
  2001. return self._get_obj_does_not_exist_redirect(
  2002. request, model._meta, object_id
  2003. )
  2004. if not self.has_view_or_change_permission(request, obj):
  2005. raise PermissionDenied
  2006. # Then get the history for this object.
  2007. app_label = self.opts.app_label
  2008. action_list = (
  2009. LogEntry.objects.filter(
  2010. object_id=unquote(object_id),
  2011. content_type=get_content_type_for_model(model),
  2012. )
  2013. .select_related()
  2014. .order_by("action_time")
  2015. )
  2016. paginator = self.get_paginator(request, action_list, 100)
  2017. page_number = request.GET.get(PAGE_VAR, 1)
  2018. page_obj = paginator.get_page(page_number)
  2019. page_range = paginator.get_elided_page_range(page_obj.number)
  2020. context = {
  2021. **self.admin_site.each_context(request),
  2022. "title": _("Change history: %s") % obj,
  2023. "subtitle": None,
  2024. "action_list": page_obj,
  2025. "page_range": page_range,
  2026. "page_var": PAGE_VAR,
  2027. "pagination_required": paginator.count > 100,
  2028. "module_name": str(capfirst(self.opts.verbose_name_plural)),
  2029. "object": obj,
  2030. "opts": self.opts,
  2031. "preserved_filters": self.get_preserved_filters(request),
  2032. **(extra_context or {}),
  2033. }
  2034. request.current_app = self.admin_site.name
  2035. return TemplateResponse(
  2036. request,
  2037. self.object_history_template
  2038. or [
  2039. "admin/%s/%s/object_history.html" % (app_label, self.opts.model_name),
  2040. "admin/%s/object_history.html" % app_label,
  2041. "admin/object_history.html",
  2042. ],
  2043. context,
  2044. )
  2045. def get_formset_kwargs(self, request, obj, inline, prefix):
  2046. formset_params = {
  2047. "instance": obj,
  2048. "prefix": prefix,
  2049. "queryset": inline.get_queryset(request),
  2050. }
  2051. if request.method == "POST":
  2052. formset_params.update(
  2053. {
  2054. "data": request.POST.copy(),
  2055. "files": request.FILES,
  2056. "save_as_new": "_saveasnew" in request.POST,
  2057. }
  2058. )
  2059. return formset_params
  2060. def _create_formsets(self, request, obj, change):
  2061. "Helper function to generate formsets for add/change_view."
  2062. formsets = []
  2063. inline_instances = []
  2064. prefixes = {}
  2065. get_formsets_args = [request]
  2066. if change:
  2067. get_formsets_args.append(obj)
  2068. for FormSet, inline in self.get_formsets_with_inlines(*get_formsets_args):
  2069. prefix = FormSet.get_default_prefix()
  2070. prefixes[prefix] = prefixes.get(prefix, 0) + 1
  2071. if prefixes[prefix] != 1 or not prefix:
  2072. prefix = "%s-%s" % (prefix, prefixes[prefix])
  2073. formset_params = self.get_formset_kwargs(request, obj, inline, prefix)
  2074. formset = FormSet(**formset_params)
  2075. def user_deleted_form(request, obj, formset, index, inline):
  2076. """Return whether or not the user deleted the form."""
  2077. return (
  2078. inline.has_delete_permission(request, obj)
  2079. and "{}-{}-DELETE".format(formset.prefix, index) in request.POST
  2080. )
  2081. # Bypass validation of each view-only inline form (since the form's
  2082. # data won't be in request.POST), unless the form was deleted.
  2083. if not inline.has_change_permission(request, obj if change else None):
  2084. for index, form in enumerate(formset.initial_forms):
  2085. if user_deleted_form(request, obj, formset, index, inline):
  2086. continue
  2087. form._errors = {}
  2088. form.cleaned_data = form.initial
  2089. formsets.append(formset)
  2090. inline_instances.append(inline)
  2091. return formsets, inline_instances
  2092. class InlineModelAdmin(BaseModelAdmin):
  2093. """
  2094. Options for inline editing of ``model`` instances.
  2095. Provide ``fk_name`` to specify the attribute name of the ``ForeignKey``
  2096. from ``model`` to its parent. This is required if ``model`` has more than
  2097. one ``ForeignKey`` to its parent.
  2098. """
  2099. model = None
  2100. fk_name = None
  2101. formset = BaseInlineFormSet
  2102. extra = 3
  2103. min_num = None
  2104. max_num = None
  2105. template = None
  2106. verbose_name = None
  2107. verbose_name_plural = None
  2108. can_delete = True
  2109. show_change_link = False
  2110. checks_class = InlineModelAdminChecks
  2111. classes = None
  2112. def __init__(self, parent_model, admin_site):
  2113. self.admin_site = admin_site
  2114. self.parent_model = parent_model
  2115. self.opts = self.model._meta
  2116. self.has_registered_model = admin_site.is_registered(self.model)
  2117. super().__init__()
  2118. if self.verbose_name_plural is None:
  2119. if self.verbose_name is None:
  2120. self.verbose_name_plural = self.opts.verbose_name_plural
  2121. else:
  2122. self.verbose_name_plural = format_lazy("{}s", self.verbose_name)
  2123. if self.verbose_name is None:
  2124. self.verbose_name = self.opts.verbose_name
  2125. @property
  2126. def media(self):
  2127. extra = "" if settings.DEBUG else ".min"
  2128. js = ["vendor/jquery/jquery%s.js" % extra, "jquery.init.js", "inlines.js"]
  2129. if self.filter_vertical or self.filter_horizontal:
  2130. js.extend(["SelectBox.js", "SelectFilter2.js"])
  2131. if self.classes and "collapse" in self.classes:
  2132. js.append("collapse.js")
  2133. return forms.Media(js=["admin/js/%s" % url for url in js])
  2134. def get_extra(self, request, obj=None, **kwargs):
  2135. """Hook for customizing the number of extra inline forms."""
  2136. return self.extra
  2137. def get_min_num(self, request, obj=None, **kwargs):
  2138. """Hook for customizing the min number of inline forms."""
  2139. return self.min_num
  2140. def get_max_num(self, request, obj=None, **kwargs):
  2141. """Hook for customizing the max number of extra inline forms."""
  2142. return self.max_num
  2143. def get_formset(self, request, obj=None, **kwargs):
  2144. """Return a BaseInlineFormSet class for use in admin add/change views."""
  2145. if "fields" in kwargs:
  2146. fields = kwargs.pop("fields")
  2147. else:
  2148. fields = flatten_fieldsets(self.get_fieldsets(request, obj))
  2149. excluded = self.get_exclude(request, obj)
  2150. exclude = [] if excluded is None else list(excluded)
  2151. exclude.extend(self.get_readonly_fields(request, obj))
  2152. if excluded is None and hasattr(self.form, "_meta") and self.form._meta.exclude:
  2153. # Take the custom ModelForm's Meta.exclude into account only if the
  2154. # InlineModelAdmin doesn't define its own.
  2155. exclude.extend(self.form._meta.exclude)
  2156. # If exclude is an empty list we use None, since that's the actual
  2157. # default.
  2158. exclude = exclude or None
  2159. can_delete = self.can_delete and self.has_delete_permission(request, obj)
  2160. defaults = {
  2161. "form": self.form,
  2162. "formset": self.formset,
  2163. "fk_name": self.fk_name,
  2164. "fields": fields,
  2165. "exclude": exclude,
  2166. "formfield_callback": partial(self.formfield_for_dbfield, request=request),
  2167. "extra": self.get_extra(request, obj, **kwargs),
  2168. "min_num": self.get_min_num(request, obj, **kwargs),
  2169. "max_num": self.get_max_num(request, obj, **kwargs),
  2170. "can_delete": can_delete,
  2171. **kwargs,
  2172. }
  2173. base_model_form = defaults["form"]
  2174. can_change = self.has_change_permission(request, obj) if request else True
  2175. can_add = self.has_add_permission(request, obj) if request else True
  2176. class DeleteProtectedModelForm(base_model_form):
  2177. def hand_clean_DELETE(self):
  2178. """
  2179. We don't validate the 'DELETE' field itself because on
  2180. templates it's not rendered using the field information, but
  2181. just using a generic "deletion_field" of the InlineModelAdmin.
  2182. """
  2183. if self.cleaned_data.get(DELETION_FIELD_NAME, False):
  2184. using = router.db_for_write(self._meta.model)
  2185. collector = NestedObjects(using=using)
  2186. if self.instance._state.adding:
  2187. return
  2188. collector.collect([self.instance])
  2189. if collector.protected:
  2190. objs = []
  2191. for p in collector.protected:
  2192. objs.append(
  2193. # Translators: Model verbose name and instance
  2194. # representation, suitable to be an item in a
  2195. # list.
  2196. _("%(class_name)s %(instance)s")
  2197. % {"class_name": p._meta.verbose_name, "instance": p}
  2198. )
  2199. params = {
  2200. "class_name": self._meta.model._meta.verbose_name,
  2201. "instance": self.instance,
  2202. "related_objects": get_text_list(objs, _("and")),
  2203. }
  2204. msg = _(
  2205. "Deleting %(class_name)s %(instance)s would require "
  2206. "deleting the following protected related objects: "
  2207. "%(related_objects)s"
  2208. )
  2209. raise ValidationError(
  2210. msg, code="deleting_protected", params=params
  2211. )
  2212. def is_valid(self):
  2213. result = super().is_valid()
  2214. self.hand_clean_DELETE()
  2215. return result
  2216. def has_changed(self):
  2217. # Protect against unauthorized edits.
  2218. if not can_change and not self.instance._state.adding:
  2219. return False
  2220. if not can_add and self.instance._state.adding:
  2221. return False
  2222. return super().has_changed()
  2223. defaults["form"] = DeleteProtectedModelForm
  2224. if defaults["fields"] is None and not modelform_defines_fields(
  2225. defaults["form"]
  2226. ):
  2227. defaults["fields"] = forms.ALL_FIELDS
  2228. return inlineformset_factory(self.parent_model, self.model, **defaults)
  2229. def _get_form_for_get_fields(self, request, obj=None):
  2230. return self.get_formset(request, obj, fields=None).form
  2231. def get_queryset(self, request):
  2232. queryset = super().get_queryset(request)
  2233. if not self.has_view_or_change_permission(request):
  2234. queryset = queryset.none()
  2235. return queryset
  2236. def _has_any_perms_for_target_model(self, request, perms):
  2237. """
  2238. This method is called only when the ModelAdmin's model is for an
  2239. ManyToManyField's implicit through model (if self.opts.auto_created).
  2240. Return True if the user has any of the given permissions ('add',
  2241. 'change', etc.) for the model that points to the through model.
  2242. """
  2243. opts = self.opts
  2244. # Find the target model of an auto-created many-to-many relationship.
  2245. for field in opts.fields:
  2246. if field.remote_field and field.remote_field.model != self.parent_model:
  2247. opts = field.remote_field.model._meta
  2248. break
  2249. return any(
  2250. request.user.has_perm(
  2251. "%s.%s" % (opts.app_label, get_permission_codename(perm, opts))
  2252. )
  2253. for perm in perms
  2254. )
  2255. def has_add_permission(self, request, obj):
  2256. if self.opts.auto_created:
  2257. # Auto-created intermediate models don't have their own
  2258. # permissions. The user needs to have the change permission for the
  2259. # related model in order to be able to do anything with the
  2260. # intermediate model.
  2261. return self._has_any_perms_for_target_model(request, ["change"])
  2262. return super().has_add_permission(request)
  2263. def has_change_permission(self, request, obj=None):
  2264. if self.opts.auto_created:
  2265. # Same comment as has_add_permission().
  2266. return self._has_any_perms_for_target_model(request, ["change"])
  2267. return super().has_change_permission(request)
  2268. def has_delete_permission(self, request, obj=None):
  2269. if self.opts.auto_created:
  2270. # Same comment as has_add_permission().
  2271. return self._has_any_perms_for_target_model(request, ["change"])
  2272. return super().has_delete_permission(request, obj)
  2273. def has_view_permission(self, request, obj=None):
  2274. if self.opts.auto_created:
  2275. # Same comment as has_add_permission(). The 'change' permission
  2276. # also implies the 'view' permission.
  2277. return self._has_any_perms_for_target_model(request, ["view", "change"])
  2278. return super().has_view_permission(request)
  2279. class StackedInline(InlineModelAdmin):
  2280. template = "admin/edit_inline/stacked.html"
  2281. class TabularInline(InlineModelAdmin):
  2282. template = "admin/edit_inline/tabular.html"