options.py 96 KB

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