layouts.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. from UserDict import IterableUserDict
  2. from django.utils import formats
  3. class FormLayout(object):
  4. def __init__(self, form, fieldsets=False):
  5. scaffold_fields = FormFields(form)
  6. scaffold_fieldsets = FormFieldsets(form, scaffold_fields.fields, fieldsets)
  7. self.multipart_form = scaffold_fields.multipart_form
  8. self.fieldsets = scaffold_fieldsets.fieldsets
  9. self.fields = scaffold_fields.fields
  10. self.hidden = scaffold_fields.hidden
  11. class FormFields(object):
  12. """
  13. Hydrator that builds fields list from form and blueprint
  14. """
  15. def __init__(self, form):
  16. self.multipart_form = False
  17. self.fields = {}
  18. self.hidden = []
  19. # Extract widgets from meta
  20. self.meta_widgets = {}
  21. try:
  22. self.meta_widgets = form.Meta.widgets
  23. except AttributeError:
  24. pass
  25. # Find out field input types
  26. for field in form.fields.keys():
  27. widget = self._get_widget(field, form.fields[field])
  28. widget_name = widget.__class__.__name__
  29. bound_field = form[field]
  30. blueprint = {
  31. 'attrs': {
  32. 'id': bound_field.auto_id,
  33. 'name': bound_field.html_name,
  34. },
  35. 'endrow': False,
  36. 'errors': [],
  37. 'has_value': bound_field.value() != None,
  38. 'help_text': bound_field.help_text,
  39. 'hidden': widget.is_hidden,
  40. 'html_id': bound_field.auto_id,
  41. 'html_name': bound_field.html_name,
  42. 'id': field,
  43. 'initial': bound_field.field.initial,
  44. 'label': bound_field.label,
  45. 'last': False,
  46. 'nested': [],
  47. 'required': bound_field.field.widget.is_required,
  48. 'show_hidden_initial': bound_field.field.show_hidden_initial,
  49. 'value': bound_field.value(),
  50. 'width': 100,
  51. 'widget': '',
  52. 'choices': [],
  53. }
  54. # Set multipart form
  55. if widget.needs_multipart_form:
  56. self.multipart_form = True
  57. # Get errors?
  58. if form.is_bound:
  59. for error in bound_field._errors():
  60. blueprint['errors'].append(error)
  61. try:
  62. for error in form.errors[field]:
  63. if not error in blueprint['errors']:
  64. blueprint['errors'].append(error)
  65. except KeyError:
  66. pass
  67. # Use clean value instead?
  68. try:
  69. if field in form.cleaned_data:
  70. blueprint['value'] = form.cleaned_data[field]
  71. except AttributeError:
  72. pass
  73. # TextInput
  74. if widget_name in ['TextInput', 'PasswordInput', 'Textarea']:
  75. blueprint['widget'] = 'text'
  76. blueprint['attrs']['type'] = 'text'
  77. try:
  78. blueprint['attrs']['maxlength'] = bound_field.field.max_length
  79. except AttributeError:
  80. pass
  81. # PasswordInput
  82. if widget_name == 'PasswordInput':
  83. blueprint['attrs']['type'] = 'password'
  84. # Textarea
  85. if widget_name == 'Textarea':
  86. blueprint['widget'] = 'textarea'
  87. # ReCaptcha
  88. if widget_name == 'ReCaptchaWidget':
  89. from recaptcha.client.captcha import displayhtml
  90. blueprint['widget'] = 'recaptcha'
  91. blueprint['attrs'] = {'html': displayhtml(
  92. form.request.settings['recaptcha_public'],
  93. form.request.settings['recaptcha_ssl'],
  94. bound_field.field.api_error,
  95. )}
  96. # HiddenInput
  97. if widget_name == 'HiddenInput':
  98. blueprint['widget'] = 'hidden'
  99. # MultipleHiddenInput
  100. if widget_name == 'MultipleHiddenInput':
  101. blueprint['widget'] = 'multiple_hidden'
  102. blueprint['attrs'] = {
  103. 'choices': widget.choices
  104. }
  105. # FileInput
  106. if widget_name == 'FileInput':
  107. blueprint['widget'] = 'file'
  108. # ClearableFileInput
  109. if widget_name == 'ClearableFileInput':
  110. blueprint['widget'] = 'file_clearable'
  111. # DateInput
  112. if widget_name == 'DateInput':
  113. blueprint['widget'] = 'date'
  114. try:
  115. blueprint['value'] = blueprint['value'].strftime('%Y-%m-%d')
  116. except AttributeError as e:
  117. pass
  118. # DateTimeInput
  119. if widget_name == 'DateTimeInput':
  120. blueprint['widget'] = 'datetime'
  121. try:
  122. blueprint['value'] = blueprint['value'].strftime('%Y-%m-%d %H:%M')
  123. except AttributeError as e:
  124. pass
  125. # TimeInput
  126. if widget_name == 'TimeInput':
  127. blueprint['widget'] = 'time'
  128. try:
  129. blueprint['value'] = blueprint['value'].strftime('%H:%M')
  130. except AttributeError as e:
  131. pass
  132. # CheckboxInput
  133. if widget_name == 'CheckboxInput':
  134. blueprint['widget'] = 'checkbox'
  135. # Select, NullBooleanSelect, SelectMultiple, RadioSelect, CheckboxSelectMultiple
  136. if widget_name in ['Select', 'NullBooleanSelect', 'SelectMultiple', 'RadioSelect', 'CheckboxSelectMultiple']:
  137. blueprint['choices'] = widget.choices
  138. # Yes-no radio select
  139. if widget_name == 'YesNoSwitch':
  140. blueprint['widget'] = 'yes_no_switch'
  141. # Select
  142. if widget_name == 'Select':
  143. blueprint['widget'] = 'select'
  144. if not blueprint['value']:
  145. blueprint['value'] = u''
  146. # NullBooleanSelect
  147. if widget_name == 'NullBooleanSelect':
  148. blueprint['widget'] = 'null_boolean_select'
  149. # SelectMultiple
  150. if widget_name == 'SelectMultiple':
  151. blueprint['widget'] = 'select_multiple'
  152. # RadioSelect
  153. if widget_name == 'RadioSelect':
  154. blueprint['widget'] = 'radio_select'
  155. if not blueprint['value']:
  156. blueprint['value'] = u''
  157. # CheckboxSelectMultiple
  158. if widget_name == 'CheckboxSelectMultiple':
  159. blueprint['widget'] = 'checkbox_select_multiple'
  160. # MultiWidget
  161. if widget_name == 'MultiWidget':
  162. blueprint['widget'] = 'multi'
  163. # SplitDateTimeWidget
  164. if widget_name == 'SplitDateTimeWidget':
  165. blueprint['widget'] = 'split_datetime'
  166. # SplitHiddenDateTimeWidget
  167. if widget_name == 'SplitHiddenDateTimeWidget':
  168. blueprint['widget'] = 'split_hidden_datetime'
  169. # SelectDateWidget
  170. if widget_name == 'SelectDateWidget':
  171. blueprint['widget'] = 'select_date'
  172. blueprint['years'] = widget.years
  173. # Store field in either of collections
  174. if blueprint['hidden']:
  175. blueprint['attrs']['type'] = 'hidden'
  176. self.hidden.append(blueprint)
  177. else:
  178. self.fields[field] = blueprint
  179. def _get_widget(self, name, field):
  180. if name in self.meta_widgets:
  181. return self.meta_widgets[name]
  182. return field.widget
  183. class FormFieldsets(object):
  184. """
  185. Hydrator that builds fieldset from form and blueprint
  186. """
  187. def __init__(self, form, fields, fieldsets=None):
  188. self.fieldsets = []
  189. # Use form layout
  190. if not fieldsets:
  191. try:
  192. fieldsets = form.layout
  193. except AttributeError:
  194. pass
  195. # Build fieldsets data
  196. if fieldsets:
  197. for blueprint in fieldsets:
  198. fieldset = {'legend': None, 'fields': [], 'help': None, 'last': False}
  199. fieldset['legend'] = blueprint[0]
  200. row_width = 0
  201. for field in blueprint[1]:
  202. try:
  203. if isinstance(field, basestring):
  204. fieldset['fields'].append(fields[field])
  205. elif field[0] == 'nested':
  206. subfields = {'label': None, 'help_text': None, 'nested': [], 'errors':[], 'endrow': False, 'last': False, 'width': 100}
  207. subfiels_ids = []
  208. try:
  209. subfields = field[2].update(subfields)
  210. except IndexError:
  211. pass
  212. for subfield in field[1]:
  213. if isinstance(subfield, basestring):
  214. subfiels_ids.append(subfield)
  215. subfields['nested'].append(fields[subfield])
  216. for error in fields[subfield]['errors']:
  217. if not error in subfields['errors']:
  218. subfields['errors'].append(error)
  219. else:
  220. subfiels_ids.append(subfield[0])
  221. try:
  222. subfield[1]['attrs'] = dict(fields[subfield[0]]['attrs'], **subfield[1]['attrs'])
  223. except KeyError:
  224. pass
  225. subfields['nested'].append(dict(fields[subfield[0]], **subfield[1]))
  226. for error in fields[subfield[0]]['errors']:
  227. if not error in subfields['errors']:
  228. subfields['errors'].append(error)
  229. if not subfields['label']:
  230. subfields['label'] = subfields['nested'][0]['label']
  231. if not subfields['help_text']:
  232. subfields['help_text'] = subfields['nested'][0]['help_text']
  233. try:
  234. subfields['errors'] = form.errors["_".join(subfiels_ids)]
  235. except KeyError:
  236. pass
  237. fieldset['fields'].append(subfields)
  238. else:
  239. try:
  240. field[1]['attrs'] = dict(fields[field[0]]['attrs'], **field[1]['attrs'])
  241. except KeyError:
  242. pass
  243. fieldset['fields'].append(dict(fields[field[0]], **field[1]))
  244. row_width += fieldset['fields'][-1]['width']
  245. if row_width >= 100:
  246. fieldset['fields'][-1]['endrow'] = True
  247. row_width = 0
  248. except (AttributeError, IndexError, KeyError):
  249. pass
  250. if fieldset['fields']:
  251. fieldset['fields'][-1]['endrow'] = True
  252. fieldset['fields'][-1]['last'] = True
  253. try:
  254. fieldset['help'] = blueprint[2]
  255. except IndexError:
  256. pass
  257. # Append complete fieldset
  258. if fieldset['fields']:
  259. self.fieldsets.append(fieldset)
  260. self.fieldsets[-1]['last'] = True