Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

helpers.py 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  1. import json
  2. from django import forms
  3. from django.conf import settings
  4. from django.contrib.admin.utils import (
  5. display_for_field, flatten_fieldsets, help_text_for_field, label_for_field,
  6. lookup_field,
  7. )
  8. from django.core.exceptions import ObjectDoesNotExist
  9. from django.db.models.fields.related import ManyToManyRel
  10. from django.forms.utils import flatatt
  11. from django.template.defaultfilters import capfirst, linebreaksbr
  12. from django.utils.html import conditional_escape, format_html
  13. from django.utils.safestring import mark_safe
  14. from django.utils.translation import gettext, gettext_lazy as _
  15. ACTION_CHECKBOX_NAME = '_selected_action'
  16. class ActionForm(forms.Form):
  17. action = forms.ChoiceField(label=_('Action:'))
  18. select_across = forms.BooleanField(
  19. label='',
  20. required=False,
  21. initial=0,
  22. widget=forms.HiddenInput({'class': 'select-across'}),
  23. )
  24. checkbox = forms.CheckboxInput({'class': 'action-select'}, lambda value: False)
  25. class AdminForm:
  26. def __init__(self, form, fieldsets, prepopulated_fields, readonly_fields=None, model_admin=None):
  27. self.form, self.fieldsets = form, fieldsets
  28. self.prepopulated_fields = [{
  29. 'field': form[field_name],
  30. 'dependencies': [form[f] for f in dependencies]
  31. } for field_name, dependencies in prepopulated_fields.items()]
  32. self.model_admin = model_admin
  33. if readonly_fields is None:
  34. readonly_fields = ()
  35. self.readonly_fields = readonly_fields
  36. def __iter__(self):
  37. for name, options in self.fieldsets:
  38. yield Fieldset(
  39. self.form, name,
  40. readonly_fields=self.readonly_fields,
  41. model_admin=self.model_admin,
  42. **options
  43. )
  44. @property
  45. def errors(self):
  46. return self.form.errors
  47. @property
  48. def non_field_errors(self):
  49. return self.form.non_field_errors
  50. @property
  51. def media(self):
  52. media = self.form.media
  53. for fs in self:
  54. media = media + fs.media
  55. return media
  56. class Fieldset:
  57. def __init__(self, form, name=None, readonly_fields=(), fields=(), classes=(),
  58. description=None, model_admin=None):
  59. self.form = form
  60. self.name, self.fields = name, fields
  61. self.classes = ' '.join(classes)
  62. self.description = description
  63. self.model_admin = model_admin
  64. self.readonly_fields = readonly_fields
  65. @property
  66. def media(self):
  67. if 'collapse' in self.classes:
  68. extra = '' if settings.DEBUG else '.min'
  69. js = [
  70. 'vendor/jquery/jquery%s.js' % extra,
  71. 'jquery.init.js',
  72. 'collapse%s.js' % extra,
  73. ]
  74. return forms.Media(js=['admin/js/%s' % url for url in js])
  75. return forms.Media()
  76. def __iter__(self):
  77. for field in self.fields:
  78. yield Fieldline(self.form, field, self.readonly_fields, model_admin=self.model_admin)
  79. class Fieldline:
  80. def __init__(self, form, field, readonly_fields=None, model_admin=None):
  81. self.form = form # A django.forms.Form instance
  82. if not hasattr(field, "__iter__") or isinstance(field, str):
  83. self.fields = [field]
  84. else:
  85. self.fields = field
  86. self.has_visible_field = not all(
  87. field in self.form.fields and self.form.fields[field].widget.is_hidden
  88. for field in self.fields
  89. )
  90. self.model_admin = model_admin
  91. if readonly_fields is None:
  92. readonly_fields = ()
  93. self.readonly_fields = readonly_fields
  94. def __iter__(self):
  95. for i, field in enumerate(self.fields):
  96. if field in self.readonly_fields:
  97. yield AdminReadonlyField(self.form, field, is_first=(i == 0), model_admin=self.model_admin)
  98. else:
  99. yield AdminField(self.form, field, is_first=(i == 0))
  100. def errors(self):
  101. return mark_safe(
  102. '\n'.join(
  103. self.form[f].errors.as_ul() for f in self.fields if f not in self.readonly_fields
  104. ).strip('\n')
  105. )
  106. class AdminField:
  107. def __init__(self, form, field, is_first):
  108. self.field = form[field] # A django.forms.BoundField instance
  109. self.is_first = is_first # Whether this field is first on the line
  110. self.is_checkbox = isinstance(self.field.field.widget, forms.CheckboxInput)
  111. self.is_readonly = False
  112. def label_tag(self):
  113. classes = []
  114. contents = conditional_escape(self.field.label)
  115. if self.is_checkbox:
  116. classes.append('vCheckboxLabel')
  117. if self.field.field.required:
  118. classes.append('required')
  119. if not self.is_first:
  120. classes.append('inline')
  121. attrs = {'class': ' '.join(classes)} if classes else {}
  122. # checkboxes should not have a label suffix as the checkbox appears
  123. # to the left of the label.
  124. return self.field.label_tag(
  125. contents=mark_safe(contents), attrs=attrs,
  126. label_suffix='' if self.is_checkbox else None,
  127. )
  128. def errors(self):
  129. return mark_safe(self.field.errors.as_ul())
  130. class AdminReadonlyField:
  131. def __init__(self, form, field, is_first, model_admin=None):
  132. # Make self.field look a little bit like a field. This means that
  133. # {{ field.name }} must be a useful class name to identify the field.
  134. # For convenience, store other field-related data here too.
  135. if callable(field):
  136. class_name = field.__name__ if field.__name__ != '<lambda>' else ''
  137. else:
  138. class_name = field
  139. if form._meta.labels and class_name in form._meta.labels:
  140. label = form._meta.labels[class_name]
  141. else:
  142. label = label_for_field(field, form._meta.model, model_admin, form=form)
  143. if form._meta.help_texts and class_name in form._meta.help_texts:
  144. help_text = form._meta.help_texts[class_name]
  145. else:
  146. help_text = help_text_for_field(class_name, form._meta.model)
  147. self.field = {
  148. 'name': class_name,
  149. 'label': label,
  150. 'help_text': help_text,
  151. 'field': field,
  152. }
  153. self.form = form
  154. self.model_admin = model_admin
  155. self.is_first = is_first
  156. self.is_checkbox = False
  157. self.is_readonly = True
  158. self.empty_value_display = model_admin.get_empty_value_display()
  159. def label_tag(self):
  160. attrs = {}
  161. if not self.is_first:
  162. attrs["class"] = "inline"
  163. label = self.field['label']
  164. return format_html('<label{}>{}:</label>', flatatt(attrs), capfirst(label))
  165. def contents(self):
  166. from django.contrib.admin.templatetags.admin_list import _boolean_icon
  167. field, obj, model_admin = self.field['field'], self.form.instance, self.model_admin
  168. try:
  169. f, attr, value = lookup_field(field, obj, model_admin)
  170. except (AttributeError, ValueError, ObjectDoesNotExist):
  171. result_repr = self.empty_value_display
  172. else:
  173. if field in self.form.fields:
  174. widget = self.form[field].field.widget
  175. # This isn't elegant but suffices for contrib.auth's
  176. # ReadOnlyPasswordHashWidget.
  177. if getattr(widget, 'read_only', False):
  178. return widget.render(field, value)
  179. if f is None:
  180. if getattr(attr, 'boolean', False):
  181. result_repr = _boolean_icon(value)
  182. else:
  183. if hasattr(value, "__html__"):
  184. result_repr = value
  185. else:
  186. result_repr = linebreaksbr(value)
  187. else:
  188. if isinstance(f.remote_field, ManyToManyRel) and value is not None:
  189. result_repr = ", ".join(map(str, value.all()))
  190. else:
  191. result_repr = display_for_field(value, f, self.empty_value_display)
  192. result_repr = linebreaksbr(result_repr)
  193. return conditional_escape(result_repr)
  194. class InlineAdminFormSet:
  195. """
  196. A wrapper around an inline formset for use in the admin system.
  197. """
  198. def __init__(self, inline, formset, fieldsets, prepopulated_fields=None,
  199. readonly_fields=None, model_admin=None, has_add_permission=True,
  200. has_change_permission=True, has_delete_permission=True,
  201. has_view_permission=True):
  202. self.opts = inline
  203. self.formset = formset
  204. self.fieldsets = fieldsets
  205. self.model_admin = model_admin
  206. if readonly_fields is None:
  207. readonly_fields = ()
  208. self.readonly_fields = readonly_fields
  209. if prepopulated_fields is None:
  210. prepopulated_fields = {}
  211. self.prepopulated_fields = prepopulated_fields
  212. self.classes = ' '.join(inline.classes) if inline.classes else ''
  213. self.has_add_permission = has_add_permission
  214. self.has_change_permission = has_change_permission
  215. self.has_delete_permission = has_delete_permission
  216. self.has_view_permission = has_view_permission
  217. def __iter__(self):
  218. if self.has_change_permission:
  219. readonly_fields_for_editing = self.readonly_fields
  220. else:
  221. readonly_fields_for_editing = self.readonly_fields + flatten_fieldsets(self.fieldsets)
  222. for form, original in zip(self.formset.initial_forms, self.formset.get_queryset()):
  223. view_on_site_url = self.opts.get_view_on_site_url(original)
  224. yield InlineAdminForm(
  225. self.formset, form, self.fieldsets, self.prepopulated_fields,
  226. original, readonly_fields_for_editing, model_admin=self.opts,
  227. view_on_site_url=view_on_site_url,
  228. )
  229. for form in self.formset.extra_forms:
  230. yield InlineAdminForm(
  231. self.formset, form, self.fieldsets, self.prepopulated_fields,
  232. None, self.readonly_fields, model_admin=self.opts,
  233. )
  234. if self.has_add_permission:
  235. yield InlineAdminForm(
  236. self.formset, self.formset.empty_form,
  237. self.fieldsets, self.prepopulated_fields, None,
  238. self.readonly_fields, model_admin=self.opts,
  239. )
  240. def fields(self):
  241. fk = getattr(self.formset, "fk", None)
  242. empty_form = self.formset.empty_form
  243. meta_labels = empty_form._meta.labels or {}
  244. meta_help_texts = empty_form._meta.help_texts or {}
  245. for i, field_name in enumerate(flatten_fieldsets(self.fieldsets)):
  246. if fk and fk.name == field_name:
  247. continue
  248. if not self.has_change_permission or field_name in self.readonly_fields:
  249. yield {
  250. 'label': meta_labels.get(field_name) or label_for_field(field_name, self.opts.model, self.opts),
  251. 'widget': {'is_hidden': False},
  252. 'required': False,
  253. 'help_text': meta_help_texts.get(field_name) or help_text_for_field(field_name, self.opts.model),
  254. }
  255. else:
  256. form_field = empty_form.fields[field_name]
  257. label = form_field.label
  258. if label is None:
  259. label = label_for_field(field_name, self.opts.model, self.opts)
  260. yield {
  261. 'label': label,
  262. 'widget': form_field.widget,
  263. 'required': form_field.required,
  264. 'help_text': form_field.help_text,
  265. }
  266. def inline_formset_data(self):
  267. verbose_name = self.opts.verbose_name
  268. return json.dumps({
  269. 'name': '#%s' % self.formset.prefix,
  270. 'options': {
  271. 'prefix': self.formset.prefix,
  272. 'addText': gettext('Add another %(verbose_name)s') % {
  273. 'verbose_name': capfirst(verbose_name),
  274. },
  275. 'deleteText': gettext('Remove'),
  276. }
  277. })
  278. @property
  279. def forms(self):
  280. return self.formset.forms
  281. @property
  282. def non_form_errors(self):
  283. return self.formset.non_form_errors
  284. @property
  285. def media(self):
  286. media = self.opts.media + self.formset.media
  287. for fs in self:
  288. media = media + fs.media
  289. return media
  290. class InlineAdminForm(AdminForm):
  291. """
  292. A wrapper around an inline form for use in the admin system.
  293. """
  294. def __init__(self, formset, form, fieldsets, prepopulated_fields, original,
  295. readonly_fields=None, model_admin=None, view_on_site_url=None):
  296. self.formset = formset
  297. self.model_admin = model_admin
  298. self.original = original
  299. self.show_url = original and view_on_site_url is not None
  300. self.absolute_url = view_on_site_url
  301. super().__init__(form, fieldsets, prepopulated_fields, readonly_fields, model_admin)
  302. def __iter__(self):
  303. for name, options in self.fieldsets:
  304. yield InlineFieldset(
  305. self.formset, self.form, name, self.readonly_fields,
  306. model_admin=self.model_admin, **options
  307. )
  308. def needs_explicit_pk_field(self):
  309. return (
  310. # Auto fields are editable, so check for auto or non-editable pk.
  311. self.form._meta.model._meta.auto_field or not self.form._meta.model._meta.pk.editable or
  312. # Also search any parents for an auto field. (The pk info is
  313. # propagated to child models so that does not need to be checked
  314. # in parents.)
  315. any(parent._meta.auto_field or not parent._meta.model._meta.pk.editable
  316. for parent in self.form._meta.model._meta.get_parent_list())
  317. )
  318. def pk_field(self):
  319. return AdminField(self.form, self.formset._pk_field.name, False)
  320. def fk_field(self):
  321. fk = getattr(self.formset, "fk", None)
  322. if fk:
  323. return AdminField(self.form, fk.name, False)
  324. else:
  325. return ""
  326. def deletion_field(self):
  327. from django.forms.formsets import DELETION_FIELD_NAME
  328. return AdminField(self.form, DELETION_FIELD_NAME, False)
  329. def ordering_field(self):
  330. from django.forms.formsets import ORDERING_FIELD_NAME
  331. return AdminField(self.form, ORDERING_FIELD_NAME, False)
  332. class InlineFieldset(Fieldset):
  333. def __init__(self, formset, *args, **kwargs):
  334. self.formset = formset
  335. super().__init__(*args, **kwargs)
  336. def __iter__(self):
  337. fk = getattr(self.formset, "fk", None)
  338. for field in self.fields:
  339. if not fk or fk.name != field:
  340. yield Fieldline(self.form, field, self.readonly_fields, model_admin=self.model_admin)
  341. class AdminErrorList(forms.utils.ErrorList):
  342. """Store errors for the form/formsets in an add/change view."""
  343. def __init__(self, form, inline_formsets):
  344. super().__init__()
  345. if form.is_bound:
  346. self.extend(form.errors.values())
  347. for inline_formset in inline_formsets:
  348. self.extend(inline_formset.non_form_errors())
  349. for errors_in_inline_form in inline_formset.errors:
  350. self.extend(errors_in_inline_form.values())