layouts.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  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. for error in bound_field._errors():
  59. blueprint['errors'].append(error)
  60. try:
  61. for error in form.errors[field]:
  62. if not error in blueprint['errors']:
  63. blueprint['errors'].append(error)
  64. except KeyError:
  65. pass
  66. # Use clean value instead?
  67. try:
  68. if field in form.cleaned_data:
  69. blueprint['value'] = form.cleaned_data[field]
  70. except AttributeError:
  71. pass
  72. # TextInput
  73. if widget_name in ['TextInput', 'PasswordInput', 'Textarea']:
  74. blueprint['widget'] = 'text'
  75. blueprint['attrs']['type'] = 'text'
  76. try:
  77. blueprint['attrs']['maxlength'] = bound_field.field.max_length
  78. except AttributeError:
  79. pass
  80. # PasswordInput
  81. if widget_name == 'PasswordInput':
  82. blueprint['attrs']['type'] = 'password'
  83. # Textarea
  84. if widget_name == 'Textarea':
  85. blueprint['widget'] = 'textarea'
  86. # ReCaptcha
  87. if widget_name == 'ReCaptchaWidget':
  88. blueprint['widget'] = 'recaptcha'
  89. blueprint['attrs'] = get_captcha_dict(
  90. form.request.settings,
  91. bound_field.field.api_error
  92. )
  93. # HiddenInput
  94. if widget_name == 'HiddenInput':
  95. blueprint['widget'] = 'hidden'
  96. # MultipleHiddenInput
  97. if widget_name == 'MultipleHiddenInput':
  98. blueprint['widget'] = 'multiple_hidden'
  99. blueprint['attrs'] = {
  100. 'choices': widget.choices
  101. }
  102. # FileInput
  103. if widget_name == 'FileInput':
  104. blueprint['widget'] = 'file'
  105. # ClearableFileInput
  106. if widget_name == 'ClearableFileInput':
  107. blueprint['widget'] = 'file_clearable'
  108. # DateInput
  109. if widget_name == 'DateInput':
  110. blueprint['widget'] = 'date'
  111. try:
  112. blueprint['value'] = blueprint['value'].strftime('%Y-%m-%d')
  113. except AttributeError as e:
  114. pass
  115. # DateTimeInput
  116. if widget_name == 'DateTimeInput':
  117. blueprint['widget'] = 'datetime'
  118. try:
  119. blueprint['value'] = blueprint['value'].strftime('%Y-%m-%d %H:%M')
  120. except AttributeError as e:
  121. pass
  122. # TimeInput
  123. if widget_name == 'TimeInput':
  124. blueprint['widget'] = 'time'
  125. try:
  126. blueprint['value'] = blueprint['value'].strftime('%H:%M')
  127. except AttributeError as e:
  128. pass
  129. # CheckboxInput
  130. if widget_name == 'CheckboxInput':
  131. blueprint['widget'] = 'checkbox'
  132. # Select, NullBooleanSelect, SelectMultiple, RadioSelect, CheckboxSelectMultiple
  133. if widget_name in ['Select', 'NullBooleanSelect', 'SelectMultiple', 'RadioSelect', 'CheckboxSelectMultiple']:
  134. blueprint['choices'] = widget.choices
  135. # Yes-no radio select
  136. if widget_name == 'YesNoSwitch':
  137. blueprint['widget'] = 'yes_no_switch'
  138. # Select
  139. if widget_name == 'Select':
  140. blueprint['widget'] = 'select'
  141. if not blueprint['value']:
  142. blueprint['value'] = u''
  143. # NullBooleanSelect
  144. if widget_name == 'NullBooleanSelect':
  145. blueprint['widget'] = 'null_boolean_select'
  146. # SelectMultiple
  147. if widget_name == 'SelectMultiple':
  148. blueprint['widget'] = 'select_multiple'
  149. # RadioSelect
  150. if widget_name == 'RadioSelect':
  151. blueprint['widget'] = 'radio_select'
  152. if not blueprint['value']:
  153. blueprint['value'] = u''
  154. # CheckboxSelectMultiple
  155. if widget_name == 'CheckboxSelectMultiple':
  156. blueprint['widget'] = 'checkbox_select_multiple'
  157. # MultiWidget
  158. if widget_name == 'MultiWidget':
  159. blueprint['widget'] = 'multi'
  160. # SplitDateTimeWidget
  161. if widget_name == 'SplitDateTimeWidget':
  162. blueprint['widget'] = 'split_datetime'
  163. # SplitHiddenDateTimeWidget
  164. if widget_name == 'SplitHiddenDateTimeWidget':
  165. blueprint['widget'] = 'split_hidden_datetime'
  166. # SelectDateWidget
  167. if widget_name == 'SelectDateWidget':
  168. blueprint['widget'] = 'select_date'
  169. blueprint['years'] = widget.years
  170. # Store field in either of collections
  171. if blueprint['hidden']:
  172. blueprint['attrs']['type'] = 'hidden'
  173. self.hidden.append(blueprint)
  174. else:
  175. self.fields[field] = blueprint
  176. def _get_widget(self, name, field):
  177. if name in self.meta_widgets:
  178. return self.meta_widgets[name]
  179. return field.widget
  180. class FormFieldsets(object):
  181. """
  182. Hydrator that builds fieldset from form and blueprint
  183. """
  184. def __init__(self, form, fields, fieldsets=None):
  185. self.fieldsets = []
  186. # Use form layout
  187. if not fieldsets:
  188. try:
  189. fieldsets = form.layout
  190. except AttributeError:
  191. pass
  192. # Build fieldsets data
  193. if fieldsets:
  194. for blueprint in fieldsets:
  195. fieldset = {'legend': None, 'fields': [], 'help': None, 'last': False}
  196. fieldset['legend'] = blueprint[0]
  197. row_width = 0
  198. for field in blueprint[1]:
  199. try:
  200. if isinstance(field, basestring):
  201. fieldset['fields'].append(fields[field])
  202. elif field[0] == 'nested':
  203. subfields = {'label': None, 'help_text': None, 'nested': [], 'errors':[], 'endrow': False, 'last': False, 'width': 100}
  204. subfiels_ids = []
  205. try:
  206. subfields = field[2].update(subfields)
  207. except IndexError:
  208. pass
  209. for subfield in field[1]:
  210. if isinstance(subfield, basestring):
  211. subfiels_ids.append(subfield)
  212. subfields['nested'].append(fields[subfield])
  213. for error in fields[subfield]['errors']:
  214. if not error in subfields['errors']:
  215. subfields['errors'].append(error)
  216. else:
  217. subfiels_ids.append(subfield[0])
  218. try:
  219. subfield[1]['attrs'] = dict(fields[subfield[0]]['attrs'], **subfield[1]['attrs'])
  220. except KeyError:
  221. pass
  222. subfields['nested'].append(dict(fields[subfield[0]], **subfield[1]))
  223. for error in fields[subfield[0]]['errors']:
  224. if not error in subfields['errors']:
  225. subfields['errors'].append(error)
  226. if not subfields['label']:
  227. subfields['label'] = subfields['nested'][0]['label']
  228. if not subfields['help_text']:
  229. subfields['help_text'] = subfields['nested'][0]['help_text']
  230. try:
  231. subfields['errors'] = form.errors["_".join(subfiels_ids)]
  232. except KeyError:
  233. pass
  234. fieldset['fields'].append(subfields)
  235. else:
  236. try:
  237. field[1]['attrs'] = dict(fields[field[0]]['attrs'], **field[1]['attrs'])
  238. except KeyError:
  239. pass
  240. fieldset['fields'].append(dict(fields[field[0]], **field[1]))
  241. row_width += fieldset['fields'][-1]['width']
  242. if row_width >= 100:
  243. fieldset['fields'][-1]['endrow'] = True
  244. row_width = 0
  245. except (AttributeError, IndexError, KeyError):
  246. pass
  247. if fieldset['fields']:
  248. fieldset['fields'][-1]['endrow'] = True
  249. fieldset['fields'][-1]['last'] = True
  250. try:
  251. fieldset['help'] = blueprint[2]
  252. except IndexError:
  253. pass
  254. # Append complete fieldset
  255. if fieldset['fields']:
  256. self.fieldsets.append(fieldset)
  257. self.fieldsets[-1]['last'] = True