| author | sylvain.thenault@logilab.fr |
| Wed, 13 May 2009 11:06:22 +0200 | |
| branch | tls-sprint |
| changeset 1780 | 7549509ce0e6 |
| parent 1756 | 42d87dedd631 |
| child 1843 | 646c2dd1f03e |
| permissions | -rw-r--r-- |
| 0 | 1 |
"""abstract form classes for CubicWeb web client |
2 |
||
3 |
:organization: Logilab |
|
| 751 | 4 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
| 0 | 5 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
6 |
""" |
|
7 |
__docformat__ = "restructuredtext en" |
|
8 |
||
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
9 |
from warnings import warn |
|
1016
26387b836099
use datetime instead of mx.DateTime
sylvain.thenault@logilab.fr
parents:
1013
diff
changeset
|
10 |
|
| 844 | 11 |
from logilab.common.compat import any |
|
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
12 |
from logilab.common.decorators import iclassmethod |
| 0 | 13 |
|
| 1147 | 14 |
from cubicweb.appobject import AppRsetObject |
15 |
from cubicweb.selectors import yes, non_final_entity, match_kwargs, one_line_rset |
|
| 1133 | 16 |
from cubicweb.view import NOINDEX, NOFOLLOW |
|
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
17 |
from cubicweb.common import tags |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
18 |
from cubicweb.web import INTERNAL_FIELD_VALUE, eid_param, stdmsgs |
| 0 | 19 |
from cubicweb.web.httpcache import NoHTTPCacheManager |
| 1147 | 20 |
from cubicweb.web.controller import NAV_FORM_PARAMETERS |
|
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
21 |
from cubicweb.web.formfields import (Field, StringField, RelationField, |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
22 |
HiddenInitialValueField) |
|
1686
32cb9f563fc6
ease overriding of default renderer
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1651
diff
changeset
|
23 |
from cubicweb.web import formrenderers |
| 1147 | 24 |
from cubicweb.web import formwidgets as fwdgs |
|
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
25 |
|
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
26 |
class FormViewMixIn(object): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
27 |
"""abstract form view mix-in""" |
| 0 | 28 |
category = 'form' |
29 |
controller = 'edit' |
|
30 |
http_cache_manager = NoHTTPCacheManager |
|
31 |
add_to_breadcrumbs = False |
|
| 1437 | 32 |
|
| 0 | 33 |
def html_headers(self): |
34 |
"""return a list of html headers (eg something to be inserted between |
|
35 |
<head> and </head> of the returned page |
|
36 |
||
37 |
by default forms are neither indexed nor followed |
|
38 |
""" |
|
39 |
return [NOINDEX, NOFOLLOW] |
|
| 1437 | 40 |
|
| 0 | 41 |
def linkable(self): |
42 |
"""override since forms are usually linked by an action, |
|
43 |
so we don't want them to be listed by appli.possible_views |
|
44 |
""" |
|
45 |
return False |
|
46 |
||
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
47 |
|
| 1437 | 48 |
# XXX should disappear |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
49 |
class FormMixIn(object): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
50 |
"""abstract form mix-in |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
51 |
XXX: you should inherit from this FIRST (obscure pb with super call) |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
52 |
""" |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
53 |
|
|
1525
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
54 |
def session_key(self): |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
55 |
"""return the key that may be used to store / retreive data about a |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
56 |
previous post which failed because of a validation error |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
57 |
""" |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
58 |
return '%s#%s' % (self.req.url(), self.domid) |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
59 |
|
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
60 |
def __init__(self, req, rset, **kwargs): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
61 |
super(FormMixIn, self).__init__(req, rset, **kwargs) |
|
1525
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
62 |
self.restore_previous_post(self.session_key()) |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
63 |
|
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
64 |
def restore_previous_post(self, sessionkey): |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
65 |
# get validation session data which may have been previously set. |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
66 |
# deleting validation errors here breaks form reloading (errors are |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
67 |
# no more available), they have to be deleted by application's publish |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
68 |
# method on successful commit |
|
1525
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
69 |
forminfo = self.req.get_session_data(sessionkey, pop=True) |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
70 |
if forminfo: |
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
71 |
# XXX remove req.data assigment once cw.web.widget is killed |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
72 |
self.req.data['formvalues'] = self.form_previous_values = forminfo['values'] |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
73 |
self.req.data['formerrors'] = self.form_valerror = forminfo['errors'] |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
74 |
self.req.data['displayederrors'] = self.form_displayed_errors = set() |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
75 |
# if some validation error occured on entity creation, we have to |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
76 |
# get the original variable name from its attributed eid |
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
77 |
foreid = self.form_valerror.entity |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
78 |
for var, eid in forminfo['eidmap'].items(): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
79 |
if foreid == eid: |
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
80 |
self.form_valerror.eid = var |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
81 |
break |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
82 |
else: |
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
83 |
self.form_valerror.eid = foreid |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
84 |
else: |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
85 |
self.form_previous_values = {} |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
86 |
self.form_valerror = None |
| 1437 | 87 |
|
|
1519
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
88 |
# XXX deprecated with new form system. Should disappear |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
89 |
|
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
90 |
domid = 'entityForm' |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
91 |
category = 'form' |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
92 |
controller = 'edit' |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
93 |
http_cache_manager = NoHTTPCacheManager |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
94 |
add_to_breadcrumbs = False |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
95 |
|
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
96 |
def html_headers(self): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
97 |
"""return a list of html headers (eg something to be inserted between |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
98 |
<head> and </head> of the returned page |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
99 |
|
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
100 |
by default forms are neither indexed nor followed |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
101 |
""" |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
102 |
return [NOINDEX, NOFOLLOW] |
| 1437 | 103 |
|
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
104 |
def linkable(self): |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
105 |
"""override since forms are usually linked by an action, |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
106 |
so we don't want them to be listed by appli.possible_views |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
107 |
""" |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
108 |
return False |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
109 |
|
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
110 |
|
| 1147 | 111 |
def button(self, label, klass='validateButton', tabindex=None, **kwargs): |
112 |
if tabindex is None: |
|
113 |
tabindex = self.req.next_tabindex() |
|
114 |
return tags.input(value=label, klass=klass, **kwargs) |
|
115 |
||
116 |
def action_button(self, label, onclick=None, __action=None, **kwargs): |
|
117 |
if onclick is None: |
|
118 |
onclick = "postForm('__action_%s', \'%s\', \'%s\')" % ( |
|
119 |
__action, label, self.domid) |
|
120 |
return self.button(label, onclick=onclick, **kwargs) |
|
121 |
||
122 |
def button_ok(self, label=None, type='submit', name='defaultsubmit', |
|
123 |
**kwargs): |
|
124 |
label = self.req._(label or stdmsgs.BUTTON_OK).capitalize() |
|
125 |
return self.button(label, name=name, type=type, **kwargs) |
|
| 1437 | 126 |
|
| 1147 | 127 |
def button_apply(self, label=None, type='button', **kwargs): |
128 |
label = self.req._(label or stdmsgs.BUTTON_APPLY).capitalize() |
|
129 |
return self.action_button(label, __action='apply', type=type, **kwargs) |
|
130 |
||
131 |
def button_delete(self, label=None, type='button', **kwargs): |
|
132 |
label = self.req._(label or stdmsgs.BUTTON_DELETE).capitalize() |
|
133 |
return self.action_button(label, __action='delete', type=type, **kwargs) |
|
| 1437 | 134 |
|
| 1147 | 135 |
def button_cancel(self, label=None, type='button', **kwargs): |
136 |
label = self.req._(label or stdmsgs.BUTTON_CANCEL).capitalize() |
|
137 |
return self.action_button(label, __action='cancel', type=type, **kwargs) |
|
| 1437 | 138 |
|
| 1147 | 139 |
def button_reset(self, label=None, type='reset', name='__action_cancel', |
140 |
**kwargs): |
|
141 |
label = self.req._(label or stdmsgs.BUTTON_CANCEL).capitalize() |
|
142 |
return self.button(label, type=type, **kwargs) |
|
143 |
||
|
1305
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
144 |
def need_multipart(self, entity, categories=('primary', 'secondary')): |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
145 |
"""return a boolean indicating if form's enctype should be multipart |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
146 |
""" |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
147 |
for rschema, _, x in entity.relations_by_category(categories): |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
148 |
if entity.get_widget(rschema, x).need_multipart: |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
149 |
return True |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
150 |
# let's find if any of our inlined entities needs multipart |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
151 |
for rschema, targettypes, x in entity.relations_by_category('inlineview'): |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
152 |
assert len(targettypes) == 1, \ |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
153 |
"I'm not able to deal with several targets and inlineview" |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
154 |
ttype = targettypes[0] |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
155 |
inlined_entity = self.vreg.etype_class(ttype)(self.req, None, None) |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
156 |
for irschema, _, x in inlined_entity.relations_by_category(categories): |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
157 |
if inlined_entity.get_widget(irschema, x).need_multipart: |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
158 |
return True |
|
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
159 |
return False |
| 1437 | 160 |
|
| 0 | 161 |
def error_message(self): |
162 |
"""return formatted error message |
|
163 |
||
164 |
This method should be called once inlined field errors has been consumed |
|
165 |
""" |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
166 |
errex = self.req.data.get('formerrors') or self.form_valerror |
| 0 | 167 |
# get extra errors |
168 |
if errex is not None: |
|
169 |
errormsg = self.req._('please correct the following errors:') |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
170 |
displayed = self.req.data.get('displayederrors') or self.form_displayed_errors |
| 0 | 171 |
errors = sorted((field, err) for field, err in errex.errors.items() |
172 |
if not field in displayed) |
|
173 |
if errors: |
|
174 |
if len(errors) > 1: |
|
| 1437 | 175 |
templstr = '<li>%s</li>\n' |
| 0 | 176 |
else: |
177 |
templstr = ' %s\n' |
|
178 |
for field, err in errors: |
|
179 |
if field is None: |
|
180 |
errormsg += templstr % err |
|
181 |
else: |
|
182 |
errormsg += templstr % '%s: %s' % (self.req._(field), err) |
|
183 |
if len(errors) > 1: |
|
184 |
errormsg = '<ul>%s</ul>' % errormsg |
|
185 |
return u'<div class="errorMessage">%s</div>' % errormsg |
|
186 |
return u'' |
|
| 844 | 187 |
|
188 |
||
189 |
############################################################################### |
|
190 |
||
191 |
class metafieldsform(type): |
|
|
1406
133476216f4a
define self.fields before it is used ...
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1400
diff
changeset
|
192 |
"""metaclass for FieldsForm to retrieve fields defined as class attributes |
|
133476216f4a
define self.fields before it is used ...
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1400
diff
changeset
|
193 |
and put them into a single ordered list: '_fields_'. |
| 1393 | 194 |
""" |
| 844 | 195 |
def __new__(mcs, name, bases, classdict): |
196 |
allfields = [] |
|
197 |
for base in bases: |
|
198 |
if hasattr(base, '_fields_'): |
|
199 |
allfields += base._fields_ |
|
200 |
clsfields = (item for item in classdict.items() |
|
201 |
if isinstance(item[1], Field)) |
|
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
202 |
for fieldname, field in sorted(clsfields, key=lambda x: x[1].creation_rank): |
| 844 | 203 |
if not field.name: |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
204 |
field.set_name(fieldname) |
| 844 | 205 |
allfields.append(field) |
206 |
classdict['_fields_'] = allfields |
|
207 |
return super(metafieldsform, mcs).__new__(mcs, name, bases, classdict) |
|
| 1270 | 208 |
|
| 1437 | 209 |
|
| 1270 | 210 |
class FieldNotFound(Exception): |
211 |
"""raised by field_by_name when a field with the given name has not been |
|
212 |
found |
|
213 |
""" |
|
| 1437 | 214 |
|
| 1147 | 215 |
class FieldsForm(FormMixIn, AppRsetObject): |
| 844 | 216 |
__metaclass__ = metafieldsform |
|
1047
21d4d5e6aa45
make forms selectable (appobject)
sylvain.thenault@logilab.fr
parents:
1032
diff
changeset
|
217 |
__registry__ = 'forms' |
|
21d4d5e6aa45
make forms selectable (appobject)
sylvain.thenault@logilab.fr
parents:
1032
diff
changeset
|
218 |
__select__ = yes() |
| 1437 | 219 |
|
|
1686
32cb9f563fc6
ease overriding of default renderer
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1651
diff
changeset
|
220 |
renderer_cls = formrenderers.FormRenderer |
| 1147 | 221 |
is_subform = False |
| 1437 | 222 |
|
| 1147 | 223 |
# attributes overrideable through __init__ |
| 1082 | 224 |
internal_fields = ('__errorurl',) + NAV_FORM_PARAMETERS |
|
1311
4cc6e2723dc7
move ajax.js to base form class
sylvain.thenault@logilab.fr
parents:
1308
diff
changeset
|
225 |
needs_js = ('cubicweb.ajax.js', 'cubicweb.edition.js',) |
|
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
226 |
needs_css = ('cubicweb.form.css',) |
| 1147 | 227 |
domid = 'form' |
228 |
title = None |
|
229 |
action = None |
|
230 |
onsubmit = "return freezeFormButtons('%(domid)s');" |
|
231 |
cssclass = None |
|
232 |
cssstyle = None |
|
233 |
cwtarget = None |
|
234 |
redirect_path = None |
|
235 |
set_error_url = True |
|
236 |
copy_nav_params = False |
|
| 1304 | 237 |
form_buttons = None # form buttons (button widgets instances) |
| 1437 | 238 |
|
|
1271
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
239 |
def __init__(self, req, rset=None, row=None, col=None, submitmsg=None, |
|
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
240 |
**kwargs): |
| 1147 | 241 |
super(FieldsForm, self).__init__(req, rset, row=row, col=col) |
|
1406
133476216f4a
define self.fields before it is used ...
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1400
diff
changeset
|
242 |
self.fields = list(self.__class__._fields_) |
| 1147 | 243 |
for key, val in kwargs.items(): |
|
1400
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
244 |
if key in NAV_FORM_PARAMETERS: |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
245 |
self.form_add_hidden(key, val) |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
246 |
else: |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
247 |
assert hasattr(self.__class__, key) and not key[0] == '_', key |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
248 |
setattr(self, key, val) |
| 1147 | 249 |
if self.set_error_url: |
|
1525
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
250 |
self.form_add_hidden('__errorurl', self.session_key()) |
| 1147 | 251 |
if self.copy_nav_params: |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
252 |
for param in NAV_FORM_PARAMETERS: |
|
1400
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
253 |
if not param in kwargs: |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
254 |
value = req.form.get(param) |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
255 |
if value: |
|
5926626fb27b
fix navigation parameters handling: those given in kwargs should always be there
sylvain.thenault@logilab.fr
parents:
1393
diff
changeset
|
256 |
self.form_add_hidden(param, value) |
|
1271
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
257 |
if submitmsg is not None: |
|
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
258 |
self.form_add_hidden('__message', submitmsg) |
| 1053 | 259 |
self.context = None |
|
1525
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
260 |
if 'domid' in kwargs:# session key changed |
|
cc2e2cbd7019
include dom id of the form in __errorurl in case there are multiple forms in a page
sylvain.thenault@logilab.fr
parents:
1519
diff
changeset
|
261 |
self.restore_previous_post(self.session_key()) |
|
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
262 |
|
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
263 |
@iclassmethod |
|
1183
62afd820d3ae
field_by_name now takes a "role" argument, override it in AutomaticForm to call guess field if necessary
sylvain.thenault@logilab.fr
parents:
1175
diff
changeset
|
264 |
def field_by_name(cls_or_self, name, role='subject'): |
| 1270 | 265 |
"""return field with the given name and role""" |
|
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
266 |
if isinstance(cls_or_self, type): |
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
267 |
fields = cls_or_self._fields_ |
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
268 |
else: |
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
269 |
fields = cls_or_self.fields |
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
270 |
for field in fields: |
|
1183
62afd820d3ae
field_by_name now takes a "role" argument, override it in AutomaticForm to call guess field if necessary
sylvain.thenault@logilab.fr
parents:
1175
diff
changeset
|
271 |
if field.name == name and field.role == role: |
|
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
272 |
return field |
| 1270 | 273 |
raise FieldNotFound(name) |
| 1437 | 274 |
|
| 1147 | 275 |
@iclassmethod |
276 |
def remove_field(cls_or_self, field): |
|
| 1391 | 277 |
"""remove a field from form class or instance""" |
| 1147 | 278 |
if isinstance(cls_or_self, type): |
279 |
fields = cls_or_self._fields_ |
|
280 |
else: |
|
281 |
fields = cls_or_self.fields |
|
282 |
fields.remove(field) |
|
| 1437 | 283 |
|
| 1272 | 284 |
@iclassmethod |
285 |
def append_field(cls_or_self, field): |
|
| 1391 | 286 |
"""append a field to form class or instance""" |
| 1272 | 287 |
if isinstance(cls_or_self, type): |
288 |
fields = cls_or_self._fields_ |
|
289 |
else: |
|
290 |
fields = cls_or_self.fields |
|
291 |
fields.append(field) |
|
| 1437 | 292 |
|
| 844 | 293 |
@property |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
294 |
def form_needs_multipart(self): |
| 1391 | 295 |
"""true if the form needs enctype=multipart/form-data""" |
| 1437 | 296 |
return any(field.needs_multipart for field in self.fields) |
| 0 | 297 |
|
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
298 |
def form_add_hidden(self, name, value=None, **kwargs): |
| 1391 | 299 |
"""add an hidden field to the form""" |
| 1147 | 300 |
field = StringField(name=name, widget=fwdgs.HiddenInput, initial=value, |
301 |
**kwargs) |
|
|
1338
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
302 |
if 'id' in kwargs: |
|
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
303 |
# by default, hidden input don't set id attribute. If one is |
|
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
304 |
# explicitly specified, ensure it will be set |
|
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
305 |
field.widget.setdomid = True |
|
1406
133476216f4a
define self.fields before it is used ...
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1400
diff
changeset
|
306 |
self.append_field(field) |
| 1147 | 307 |
return field |
| 1437 | 308 |
|
|
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
309 |
def add_media(self): |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
310 |
"""adds media (CSS & JS) required by this widget""" |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
311 |
if self.needs_js: |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
312 |
self.req.add_js(self.needs_js) |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
313 |
if self.needs_css: |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
314 |
self.req.add_css(self.needs_css) |
|
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
315 |
|
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
316 |
def form_render(self, **values): |
| 1391 | 317 |
"""render this form, using the renderer given in args or the default |
318 |
FormRenderer() |
|
319 |
""" |
|
|
1686
32cb9f563fc6
ease overriding of default renderer
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents:
1651
diff
changeset
|
320 |
renderer = values.pop('renderer', self.renderer_cls()) |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
321 |
return renderer.render(self, values) |
| 844 | 322 |
|
| 1391 | 323 |
def form_build_context(self, rendervalues=None): |
324 |
"""build form context values (the .context attribute which is a |
|
325 |
dictionary with field instance as key associated to a dictionary |
|
326 |
containing field 'name' (qualified), 'id', 'value' (for display, always |
|
327 |
a string). |
|
328 |
||
329 |
rendervalues is an optional dictionary containing extra kwargs given to |
|
330 |
form_render() |
|
331 |
""" |
|
| 844 | 332 |
self.context = context = {} |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
333 |
# ensure rendervalues is a dict |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
334 |
if rendervalues is None: |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
335 |
rendervalues = {} |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
336 |
for field in self.fields: |
| 894 | 337 |
for field in field.actual_fields(self): |
| 1304 | 338 |
field.form_init(self) |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
339 |
value = self.form_field_display_value(field, rendervalues) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
340 |
context[field] = {'value': value, |
|
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
341 |
'name': self.form_field_name(field), |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
342 |
'id': self.form_field_id(field), |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
343 |
} |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
344 |
|
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
345 |
def form_field_display_value(self, field, rendervalues, load_bytes=False): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
346 |
"""return field's *string* value to use for display |
| 1437 | 347 |
|
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
348 |
looks in |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
349 |
1. previously submitted form values if any (eg on validation error) |
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
350 |
2. req.form |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
351 |
3. extra kw args given to render_form |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
352 |
4. field's typed value |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
353 |
|
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
354 |
values found in 1. and 2. are expected te be already some 'display' |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
355 |
value while those found in 3. and 4. are expected to be correctly typed. |
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
356 |
""" |
|
1755
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
357 |
value = self._req_display_value(field) |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
358 |
if value is None: |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
359 |
if field.name in rendervalues: |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
360 |
value = rendervalues[field.name] |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
361 |
else: |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
362 |
value = self.form_field_value(field, load_bytes) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
363 |
if callable(value): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
364 |
value = value(self) |
| 1437 | 365 |
if value != INTERNAL_FIELD_VALUE: |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
366 |
value = field.format_value(self.req, value) |
|
897
f5b91f11d8b6
provide basic methods to build fields from schema constraints / cardinality
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
896
diff
changeset
|
367 |
return value |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
368 |
|
|
1755
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
369 |
def _req_display_value(self, field): |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
370 |
qname = self.form_field_name(field) |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
371 |
if qname in self.form_previous_values: |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
372 |
return self.form_previous_values[qname] |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
373 |
if qname in self.req.form: |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
374 |
return self.req.form[qname] |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
375 |
return None |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
376 |
|
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
377 |
def form_field_value(self, field, load_bytes=False): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
378 |
"""return field's *typed* value""" |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
379 |
value = field.initial |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
380 |
if callable(value): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
381 |
value = value(self) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
382 |
return value |
| 1437 | 383 |
|
| 1147 | 384 |
def form_field_error(self, field): |
385 |
"""return validation error for widget's field, if any""" |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
386 |
if self._field_has_error(field): |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
387 |
self.form_displayed_errors.add(field.name) |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
388 |
return u'<span class="error">%s</span>' % self.form_valerror.errors[field.name] |
| 1147 | 389 |
return u'' |
|
897
f5b91f11d8b6
provide basic methods to build fields from schema constraints / cardinality
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
896
diff
changeset
|
390 |
|
|
1060
d795477ad16b
rename method to form_field_format
sylvain.thenault@logilab.fr
parents:
1059
diff
changeset
|
391 |
def form_field_format(self, field): |
| 1393 | 392 |
"""return MIME type used for the given (text or bytes) field""" |
|
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
393 |
return self.req.property_value('ui.default-text-format') |
| 1437 | 394 |
|
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
395 |
def form_field_encoding(self, field): |
| 1393 | 396 |
"""return encoding used for the given (text) field""" |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
397 |
return self.req.encoding |
| 1437 | 398 |
|
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
399 |
def form_field_name(self, field): |
| 1393 | 400 |
"""return qualified name for the given field""" |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
401 |
return field.name |
| 844 | 402 |
|
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
403 |
def form_field_id(self, field): |
| 1393 | 404 |
"""return dom id for the given field""" |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
405 |
return field.id |
| 1437 | 406 |
|
|
1183
62afd820d3ae
field_by_name now takes a "role" argument, override it in AutomaticForm to call guess field if necessary
sylvain.thenault@logilab.fr
parents:
1175
diff
changeset
|
407 |
def form_field_vocabulary(self, field, limit=None): |
| 1393 | 408 |
"""return vocabulary for the given field. Should be overriden in |
409 |
specific forms using fields which requires some vocabulary |
|
410 |
""" |
|
| 844 | 411 |
raise NotImplementedError |
412 |
||
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
413 |
def _field_has_error(self, field): |
| 1393 | 414 |
"""return true if the field has some error in given validation exception |
415 |
""" |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
416 |
return self.form_valerror and field.name in self.form_valerror.errors |
| 1393 | 417 |
|
| 1437 | 418 |
|
| 844 | 419 |
class EntityFieldsForm(FieldsForm): |
| 1147 | 420 |
__select__ = (match_kwargs('entity') | (one_line_rset & non_final_entity())) |
| 1437 | 421 |
|
|
1561
85752d14c15d
[form] __maineid missing from the special fields list
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1530
diff
changeset
|
422 |
internal_fields = FieldsForm.internal_fields + ('__type', 'eid', '__maineid') |
| 1147 | 423 |
domid = 'entityForm' |
| 1437 | 424 |
|
| 844 | 425 |
def __init__(self, *args, **kwargs): |
| 1147 | 426 |
self.edited_entity = kwargs.pop('entity', None) |
427 |
msg = kwargs.pop('submitmsg', None) |
|
| 844 | 428 |
super(EntityFieldsForm, self).__init__(*args, **kwargs) |
| 1147 | 429 |
if self.edited_entity is None: |
| 1651 | 430 |
self.edited_entity = self.complete_entity(self.row or 0, self.col or 0) |
|
887
51e371245bc5
various fixes to have change state and deletion forms working
sylvain.thenault@logilab.fr
parents:
874
diff
changeset
|
431 |
self.form_add_hidden('__type', eidparam=True) |
|
51e371245bc5
various fixes to have change state and deletion forms working
sylvain.thenault@logilab.fr
parents:
874
diff
changeset
|
432 |
self.form_add_hidden('eid') |
| 1147 | 433 |
if msg is not None: |
434 |
# If we need to directly attach the new object to another one |
|
435 |
for linkto in self.req.list_form_param('__linkto'): |
|
436 |
self.form_add_hidden('__linkto', linkto) |
|
437 |
msg = '%s %s' % (msg, self.req._('and linked')) |
|
438 |
self.form_add_hidden('__message', msg) |
|
|
1519
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
439 |
# in case of direct instanciation |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
440 |
self.schema = self.edited_entity.schema |
|
5cfc5cc1dd20
fix retreival of previously submitted error for entity forms
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
441 |
self.vreg = self.edited_entity.vreg |
| 1437 | 442 |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
443 |
def _field_has_error(self, field): |
| 1393 | 444 |
"""return true if the field has some error in given validation exception |
445 |
""" |
|
|
1710
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
446 |
return super(EntityFieldsForm, self)._field_has_error(field) \ |
|
8c717cc0b353
refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents:
1701
diff
changeset
|
447 |
and self.form_valerror.eid == self.edited_entity.eid |
| 1393 | 448 |
|
449 |
def _relation_vocabulary(self, rtype, targettype, role, |
|
450 |
limit=None, done=None): |
|
451 |
"""return unrelated entities for a given relation and target entity type |
|
452 |
for use in vocabulary |
|
453 |
""" |
|
454 |
if done is None: |
|
455 |
done = set() |
|
456 |
rset = self.edited_entity.unrelated(rtype, targettype, role, limit) |
|
457 |
res = [] |
|
458 |
for entity in rset.entities(): |
|
459 |
if entity.eid in done: |
|
460 |
continue |
|
461 |
done.add(entity.eid) |
|
462 |
res.append((entity.view('combobox'), entity.eid)) |
|
463 |
return res |
|
464 |
||
|
1755
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
465 |
def _req_display_value(self, field): |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
466 |
value = super(EntityFieldsForm, self)._req_display_value(field) |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
467 |
if value is None: |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
468 |
value = self.edited_entity.linked_to(field.name, field.role) or None |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
469 |
return value |
|
1bd225376013
consider __linkto in form_field_display_value
sylvain.thenault@logilab.fr
parents:
1710
diff
changeset
|
470 |
|
| 1393 | 471 |
def _form_field_default_value(self, field, load_bytes): |
472 |
defaultattr = 'default_%s' % field.name |
|
473 |
if hasattr(self.edited_entity, defaultattr): |
|
474 |
# XXX bw compat, default_<field name> on the entity |
|
475 |
warn('found %s on %s, should be set on a specific form' |
|
476 |
% (defaultattr, self.edited_entity.id), DeprecationWarning) |
|
477 |
value = getattr(self.edited_entity, defaultattr) |
|
478 |
if callable(value): |
|
479 |
value = value() |
|
480 |
else: |
|
481 |
value = super(EntityFieldsForm, self).form_field_value(field, |
|
482 |
load_bytes) |
|
483 |
return value |
|
| 1437 | 484 |
|
|
1315
86bddd181e03
should set None as default here as well
sylvain.thenault@logilab.fr
parents:
1312
diff
changeset
|
485 |
def form_build_context(self, values=None): |
| 1393 | 486 |
"""overriden to add edit[s|o] hidden fields and to ensure schema fields |
487 |
have eidparam set to True |
|
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
488 |
|
|
1528
864ae7c15ef5
other fixlets
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1451
diff
changeset
|
489 |
edit[s|o] hidden fields are used to indicate the value for the |
| 1393 | 490 |
associated field before the (potential) modification made when |
491 |
submitting the form. |
|
492 |
""" |
|
493 |
eschema = self.edited_entity.e_schema |
|
|
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
494 |
for field in self.fields[:]: |
| 894 | 495 |
for field in field.actual_fields(self): |
|
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
496 |
fieldname = field.name |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
497 |
if fieldname != 'eid' and ( |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
498 |
(eschema.has_subject_relation(fieldname) or |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
499 |
eschema.has_object_relation(fieldname))): |
|
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
500 |
field.eidparam = True |
| 1393 | 501 |
self.fields.append(HiddenInitialValueField(field)) |
502 |
return super(EntityFieldsForm, self).form_build_context(values) |
|
| 1437 | 503 |
|
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
504 |
def form_field_value(self, field, load_bytes=False): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
505 |
"""return field's *typed* value |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
506 |
|
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
507 |
overriden to deal with |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
508 |
* special eid / __type / edits- / edito- fields |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
509 |
* lookup for values on edited entities |
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
510 |
""" |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
511 |
attr = field.name |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
512 |
entity = self.edited_entity |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
513 |
if attr == 'eid': |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
514 |
return entity.eid |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
515 |
if not field.eidparam: |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
516 |
return super(EntityFieldsForm, self).form_field_value(field, load_bytes) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
517 |
if attr.startswith('edits-') or attr.startswith('edito-'): |
|
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
518 |
# edit[s|o]- fieds must have the actual value stored on the entity |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
519 |
assert hasattr(field, 'visible_field') |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
520 |
vfield = field.visible_field |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
521 |
assert vfield.eidparam |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
522 |
if entity.has_eid(): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
523 |
return self.form_field_value(vfield) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
524 |
return INTERNAL_FIELD_VALUE |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
525 |
if attr == '__type': |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
526 |
return entity.id |
|
1701
9fb5b4741a08
use values cached on the entity if any
sylvain.thenault@logilab.fr
parents:
1686
diff
changeset
|
527 |
if self.schema.rschema(attr).is_final(): |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
528 |
attrtype = entity.e_schema.destination(attr) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
529 |
if attrtype == 'Password': |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
530 |
return entity.has_eid() and INTERNAL_FIELD_VALUE or '' |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
531 |
if attrtype == 'Bytes': |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
532 |
if entity.has_eid(): |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
533 |
if load_bytes: |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
534 |
return getattr(entity, attr) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
535 |
# XXX value should reflect if some file is already attached |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
536 |
return True |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
537 |
return False |
|
1701
9fb5b4741a08
use values cached on the entity if any
sylvain.thenault@logilab.fr
parents:
1686
diff
changeset
|
538 |
if entity.has_eid() or attr in entity: |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
539 |
value = getattr(entity, attr) |
|
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
540 |
else: |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
541 |
value = self._form_field_default_value(field, load_bytes) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
542 |
return value |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
543 |
# non final relation field |
|
1701
9fb5b4741a08
use values cached on the entity if any
sylvain.thenault@logilab.fr
parents:
1686
diff
changeset
|
544 |
if entity.has_eid() or entity.relation_cached(attr, field.role): |
|
9fb5b4741a08
use values cached on the entity if any
sylvain.thenault@logilab.fr
parents:
1686
diff
changeset
|
545 |
value = [r[0] for r in entity.related(attr, field.role)] |
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
546 |
else: |
|
1392
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
547 |
value = self._form_field_default_value(field, load_bytes) |
|
d6279efff7b3
refactor the way field value/display value are handled to avoid getting a 'display' value when expected a 'typed' value
sylvain.thenault@logilab.fr
parents:
1391
diff
changeset
|
548 |
return value |
| 1437 | 549 |
|
|
1060
d795477ad16b
rename method to form_field_format
sylvain.thenault@logilab.fr
parents:
1059
diff
changeset
|
550 |
def form_field_format(self, field): |
| 1393 | 551 |
"""return MIME type used for the given (text or bytes) field""" |
| 1147 | 552 |
entity = self.edited_entity |
|
1107
961a478593a5
has_metadata is a schema method
sylvain.thenault@logilab.fr
parents:
1101
diff
changeset
|
553 |
if field.eidparam and entity.e_schema.has_metadata(field.name, 'format') and ( |
|
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
554 |
entity.has_eid() or '%s_format' % field.name in entity): |
|
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1338
diff
changeset
|
555 |
return self.edited_entity.attr_metadata(field.name, 'format') |
|
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
556 |
return self.req.property_value('ui.default-text-format') |
| 844 | 557 |
|
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
558 |
def form_field_encoding(self, field): |
| 1393 | 559 |
"""return encoding used for the given (text) field""" |
| 1147 | 560 |
entity = self.edited_entity |
|
1107
961a478593a5
has_metadata is a schema method
sylvain.thenault@logilab.fr
parents:
1101
diff
changeset
|
561 |
if field.eidparam and entity.e_schema.has_metadata(field.name, 'encoding') and ( |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
562 |
entity.has_eid() or '%s_encoding' % field.name in entity): |
|
1360
13ae1121835e
rename attribute_metadata method to attr_metadata to save a few chars
sylvain.thenault@logilab.fr
parents:
1338
diff
changeset
|
563 |
return self.edited_entity.attr_metadata(field.name, 'encoding') |
| 1437 | 564 |
return super(EntityFieldsForm, self).form_field_encoding(field) |
565 |
||
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
566 |
def form_field_name(self, field): |
| 1393 | 567 |
"""return qualified name for the given field""" |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
568 |
if field.eidparam: |
| 1147 | 569 |
return eid_param(field.name, self.edited_entity.eid) |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
570 |
return field.name |
|
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
571 |
|
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
572 |
def form_field_id(self, field): |
| 1393 | 573 |
"""return dom id for the given field""" |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
574 |
if field.eidparam: |
| 1147 | 575 |
return eid_param(field.id, self.edited_entity.eid) |
|
847
27c4ebe90d03
prefixed form methods to avoid potential conflicts with field names, button related method, a bit more serious renderer
sylvain.thenault@logilab.fr
parents:
844
diff
changeset
|
576 |
return field.id |
| 1437 | 577 |
|
|
1031
1a89683cb687
restore limit on form_field_vocabulary, actually used
sylvain.thenault@logilab.fr
parents:
1016
diff
changeset
|
578 |
def form_field_vocabulary(self, field, limit=None): |
| 1393 | 579 |
"""return vocabulary for the given field""" |
|
903
63a8ab7eeb9c
The value as returned by FieldWidget._render_attrs() is now always a list
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
902
diff
changeset
|
580 |
role, rtype = field.role, field.name |
|
1265
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
581 |
method = '%s_%s_vocabulary' % (role, rtype) |
|
903
63a8ab7eeb9c
The value as returned by FieldWidget._render_attrs() is now always a list
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
902
diff
changeset
|
582 |
try: |
|
1265
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
583 |
vocabfunc = getattr(self, method) |
|
903
63a8ab7eeb9c
The value as returned by FieldWidget._render_attrs() is now always a list
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
902
diff
changeset
|
584 |
except AttributeError: |
|
1265
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
585 |
try: |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
586 |
# XXX bw compat, <role>_<rtype>_vocabulary on the entity |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
587 |
vocabfunc = getattr(self.edited_entity, method) |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
588 |
except AttributeError: |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
589 |
vocabfunc = getattr(self, '%s_relation_vocabulary' % role) |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
590 |
else: |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
591 |
warn('found %s on %s, should be set on a specific form' |
|
e5cdd5c0dce3
handle sort/internationalizable on Field base class + fix guess_field to deal with internationalizable and default values
sylvain.thenault@logilab.fr
parents:
1184
diff
changeset
|
592 |
% (method, self.edited_entity.id), DeprecationWarning) |
| 1009 | 593 |
# NOTE: it is the responsibility of `vocabfunc` to sort the result |
594 |
# (direclty through RQL or via a python sort). This is also |
|
595 |
# important because `vocabfunc` might return a list with |
|
596 |
# couples (label, None) which act as separators. In these |
|
597 |
# cases, it doesn't make sense to sort results afterwards. |
|
|
1031
1a89683cb687
restore limit on form_field_vocabulary, actually used
sylvain.thenault@logilab.fr
parents:
1016
diff
changeset
|
598 |
return vocabfunc(rtype, limit) |
| 844 | 599 |
|
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
600 |
def subject_relation_vocabulary(self, rtype, limit=None): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
601 |
"""defaut vocabulary method for the given relation, looking for |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
602 |
relation's object entities (i.e. self is the subject) |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
603 |
""" |
| 1147 | 604 |
entity = self.edited_entity |
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
605 |
if isinstance(rtype, basestring): |
|
1528
864ae7c15ef5
other fixlets
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1451
diff
changeset
|
606 |
rtype = entity.schema.rschema(rtype) |
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
607 |
done = None |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
608 |
assert not rtype.is_final(), rtype |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
609 |
if entity.has_eid(): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
610 |
done = set(e.eid for e in getattr(entity, str(rtype))) |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
611 |
result = [] |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
612 |
rsetsize = None |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
613 |
for objtype in rtype.objects(entity.e_schema): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
614 |
if limit is not None: |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
615 |
rsetsize = limit - len(result) |
| 1393 | 616 |
result += self._relation_vocabulary(rtype, objtype, 'subject', |
617 |
rsetsize, done) |
|
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
618 |
if limit is not None and len(result) >= limit: |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
619 |
break |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
620 |
return result |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
621 |
|
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
622 |
def object_relation_vocabulary(self, rtype, limit=None): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
623 |
"""defaut vocabulary method for the given relation, looking for |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
624 |
relation's subject entities (i.e. self is the object) |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
625 |
""" |
| 1147 | 626 |
entity = self.edited_entity |
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
627 |
if isinstance(rtype, basestring): |
|
1528
864ae7c15ef5
other fixlets
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1451
diff
changeset
|
628 |
rtype = entity.schema.rschema(rtype) |
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
629 |
done = None |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
630 |
if entity.has_eid(): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
631 |
done = set(e.eid for e in getattr(entity, 'reverse_%s' % rtype)) |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
632 |
result = [] |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
633 |
rsetsize = None |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
634 |
for subjtype in rtype.subjects(entity.e_schema): |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
635 |
if limit is not None: |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
636 |
rsetsize = limit - len(result) |
| 1393 | 637 |
result += self._relation_vocabulary(rtype, subjtype, 'object', |
638 |
rsetsize, done) |
|
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
639 |
if limit is not None and len(result) >= limit: |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
640 |
break |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
641 |
return result |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
642 |
|
| 1451 | 643 |
def subject_in_state_vocabulary(self, rtype, limit=None): |
| 1393 | 644 |
"""vocabulary method for the in_state relation, looking for relation's |
645 |
object entities (i.e. self is the subject) according to initial_state, |
|
646 |
state_of and next_state relation |
|
|
1175
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
647 |
""" |
|
1184
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
648 |
entity = self.edited_entity |
|
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
649 |
if not entity.has_eid() or not entity.in_state: |
|
1175
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
650 |
# get the initial state |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
651 |
rql = 'Any S where S state_of ET, ET name %(etype)s, ET initial_state S' |
|
1184
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
652 |
rset = self.req.execute(rql, {'etype': str(entity.e_schema)}) |
|
1175
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
653 |
if rset: |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
654 |
return [(rset.get_entity(0, 0).view('combobox'), rset[0][0])] |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
655 |
return [] |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
656 |
results = [] |
|
1184
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
657 |
for tr in entity.in_state[0].transitions(entity): |
|
1175
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
658 |
state = tr.destination_state[0] |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
659 |
results.append((state.view('combobox'), state.eid)) |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
660 |
return sorted(results) |
|
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
661 |
|
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
662 |
|
| 1147 | 663 |
class CompositeForm(FieldsForm): |
664 |
"""form composed for sub-forms""" |
|
| 1437 | 665 |
|
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
666 |
def __init__(self, *args, **kwargs): |
| 1147 | 667 |
super(CompositeForm, self).__init__(*args, **kwargs) |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
668 |
self.forms = [] |
|
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
669 |
|
|
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
670 |
def form_add_subform(self, subform): |
| 1393 | 671 |
"""mark given form as a subform and append it""" |
| 1147 | 672 |
subform.is_subform = True |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
673 |
self.forms.append(subform) |