author | sylvain.thenault@logilab.fr |
Fri, 17 Apr 2009 11:13:44 +0200 | |
branch | tls-sprint |
changeset 1391 | 2a80b14fc548 |
parent 1386 | 8ba1f0d36c7e |
child 1392 | d6279efff7b3 |
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) |
1147 | 23 |
from cubicweb.web.formrenderers import FormRenderer |
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 |
|
32 |
||
1147 | 33 |
def __init__(self, req, rset, **kwargs): |
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
34 |
super(FormViewMixIn, self).__init__(req, rset, **kwargs) |
0 | 35 |
# get validation session data which may have been previously set. |
36 |
# deleting validation errors here breaks form reloading (errors are |
|
37 |
# no more available), they have to be deleted by application's publish |
|
38 |
# method on successful commit |
|
39 |
formurl = req.url() |
|
40 |
forminfo = req.get_session_data(formurl) |
|
41 |
if forminfo: |
|
42 |
req.data['formvalues'] = forminfo['values'] |
|
43 |
req.data['formerrors'] = errex = forminfo['errors'] |
|
44 |
req.data['displayederrors'] = set() |
|
45 |
# if some validation error occured on entity creation, we have to |
|
46 |
# get the original variable name from its attributed eid |
|
47 |
foreid = errex.entity |
|
48 |
for var, eid in forminfo['eidmap'].items(): |
|
49 |
if foreid == eid: |
|
50 |
errex.eid = var |
|
51 |
break |
|
52 |
else: |
|
53 |
errex.eid = foreid |
|
54 |
||
55 |
def html_headers(self): |
|
56 |
"""return a list of html headers (eg something to be inserted between |
|
57 |
<head> and </head> of the returned page |
|
58 |
||
59 |
by default forms are neither indexed nor followed |
|
60 |
""" |
|
61 |
return [NOINDEX, NOFOLLOW] |
|
62 |
||
63 |
def linkable(self): |
|
64 |
"""override since forms are usually linked by an action, |
|
65 |
so we don't want them to be listed by appli.possible_views |
|
66 |
""" |
|
67 |
return False |
|
68 |
||
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
69 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
70 |
# XXX should disappear |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
71 |
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
|
72 |
"""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
|
73 |
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
|
74 |
""" |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
75 |
|
1289
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
76 |
def initialize_varmaker(self): |
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
77 |
varmaker = self.req.get_page_data('rql_varmaker') |
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
78 |
if varmaker is None: |
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
79 |
varmaker = self.req.varmaker |
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
80 |
self.req.set_page_data('rql_varmaker', varmaker) |
5eff2ef92977
move initialize_varmaker on the FormMixIn class
sylvain.thenault@logilab.fr
parents:
1272
diff
changeset
|
81 |
self.varmaker = varmaker |
0 | 82 |
|
1318
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
83 |
# XXX deprecated with new form system. Should disappear |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
84 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
85 |
domid = 'entityForm' |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
86 |
category = 'form' |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
87 |
controller = 'edit' |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
88 |
http_cache_manager = NoHTTPCacheManager |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
89 |
add_to_breadcrumbs = False |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
90 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
91 |
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
|
92 |
super(FormMixIn, self).__init__(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
|
93 |
# 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
|
94 |
# 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
|
95 |
# 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
|
96 |
# method on successful commit |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
97 |
formurl = req.url() |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
98 |
forminfo = req.get_session_data(formurl) |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
99 |
if forminfo: |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
100 |
req.data['formvalues'] = forminfo['values'] |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
101 |
req.data['formerrors'] = errex = forminfo['errors'] |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
102 |
req.data['displayederrors'] = set() |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
103 |
# 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
|
104 |
# get the original variable name from its attributed eid |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
105 |
foreid = errex.entity |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
106 |
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
|
107 |
if foreid == eid: |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
108 |
errex.eid = var |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
109 |
break |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
110 |
else: |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
111 |
errex.eid = foreid |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
112 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
113 |
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
|
114 |
"""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
|
115 |
<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
|
116 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
117 |
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
|
118 |
""" |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
119 |
return [NOINDEX, NOFOLLOW] |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
120 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
121 |
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
|
122 |
"""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
|
123 |
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
|
124 |
""" |
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
125 |
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
|
126 |
|
50e1a778c5ee
new FormViewMixIn class, cleanup FormMixIn (to remove once cubes doesn't use it anymore)
sylvain.thenault@logilab.fr
parents:
1315
diff
changeset
|
127 |
|
1147 | 128 |
def button(self, label, klass='validateButton', tabindex=None, **kwargs): |
129 |
if tabindex is None: |
|
130 |
tabindex = self.req.next_tabindex() |
|
131 |
return tags.input(value=label, klass=klass, **kwargs) |
|
132 |
||
133 |
def action_button(self, label, onclick=None, __action=None, **kwargs): |
|
134 |
if onclick is None: |
|
135 |
onclick = "postForm('__action_%s', \'%s\', \'%s\')" % ( |
|
136 |
__action, label, self.domid) |
|
137 |
return self.button(label, onclick=onclick, **kwargs) |
|
138 |
||
139 |
def button_ok(self, label=None, type='submit', name='defaultsubmit', |
|
140 |
**kwargs): |
|
141 |
label = self.req._(label or stdmsgs.BUTTON_OK).capitalize() |
|
142 |
return self.button(label, name=name, type=type, **kwargs) |
|
143 |
||
144 |
def button_apply(self, label=None, type='button', **kwargs): |
|
145 |
label = self.req._(label or stdmsgs.BUTTON_APPLY).capitalize() |
|
146 |
return self.action_button(label, __action='apply', type=type, **kwargs) |
|
147 |
||
148 |
def button_delete(self, label=None, type='button', **kwargs): |
|
149 |
label = self.req._(label or stdmsgs.BUTTON_DELETE).capitalize() |
|
150 |
return self.action_button(label, __action='delete', type=type, **kwargs) |
|
151 |
||
152 |
def button_cancel(self, label=None, type='button', **kwargs): |
|
153 |
label = self.req._(label or stdmsgs.BUTTON_CANCEL).capitalize() |
|
154 |
return self.action_button(label, __action='cancel', type=type, **kwargs) |
|
155 |
||
156 |
def button_reset(self, label=None, type='reset', name='__action_cancel', |
|
157 |
**kwargs): |
|
158 |
label = self.req._(label or stdmsgs.BUTTON_CANCEL).capitalize() |
|
159 |
return self.button(label, type=type, **kwargs) |
|
160 |
||
1305
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
161 |
def need_multipart(self, entity, categories=('primary', 'secondary')): |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
162 |
"""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
|
163 |
""" |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
164 |
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
|
165 |
if entity.get_widget(rschema, x).need_multipart: |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
166 |
return True |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
167 |
# 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
|
168 |
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
|
169 |
assert len(targettypes) == 1, \ |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
170 |
"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
|
171 |
ttype = targettypes[0] |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
172 |
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
|
173 |
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
|
174 |
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
|
175 |
return True |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
176 |
return False |
395ef7f2b95b
cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents:
1304
diff
changeset
|
177 |
|
0 | 178 |
def error_message(self): |
179 |
"""return formatted error message |
|
180 |
||
181 |
This method should be called once inlined field errors has been consumed |
|
182 |
""" |
|
183 |
errex = self.req.data.get('formerrors') |
|
184 |
# get extra errors |
|
185 |
if errex is not None: |
|
186 |
errormsg = self.req._('please correct the following errors:') |
|
187 |
displayed = self.req.data['displayederrors'] |
|
188 |
errors = sorted((field, err) for field, err in errex.errors.items() |
|
189 |
if not field in displayed) |
|
190 |
if errors: |
|
191 |
if len(errors) > 1: |
|
192 |
templstr = '<li>%s</li>\n' |
|
193 |
else: |
|
194 |
templstr = ' %s\n' |
|
195 |
for field, err in errors: |
|
196 |
if field is None: |
|
197 |
errormsg += templstr % err |
|
198 |
else: |
|
199 |
errormsg += templstr % '%s: %s' % (self.req._(field), err) |
|
200 |
if len(errors) > 1: |
|
201 |
errormsg = '<ul>%s</ul>' % errormsg |
|
202 |
return u'<div class="errorMessage">%s</div>' % errormsg |
|
203 |
return u'' |
|
844 | 204 |
|
205 |
||
206 |
############################################################################### |
|
207 |
||
208 |
class metafieldsform(type): |
|
209 |
def __new__(mcs, name, bases, classdict): |
|
210 |
allfields = [] |
|
211 |
for base in bases: |
|
212 |
if hasattr(base, '_fields_'): |
|
213 |
allfields += base._fields_ |
|
214 |
clsfields = (item for item in classdict.items() |
|
215 |
if isinstance(item[1], Field)) |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
216 |
for fieldname, field in sorted(clsfields, key=lambda x: x[1].creation_rank): |
844 | 217 |
if not field.name: |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
218 |
field.set_name(fieldname) |
844 | 219 |
allfields.append(field) |
220 |
classdict['_fields_'] = allfields |
|
221 |
return super(metafieldsform, mcs).__new__(mcs, name, bases, classdict) |
|
1270 | 222 |
|
844 | 223 |
|
1270 | 224 |
class FieldNotFound(Exception): |
225 |
"""raised by field_by_name when a field with the given name has not been |
|
226 |
found |
|
227 |
""" |
|
228 |
||
1147 | 229 |
class FieldsForm(FormMixIn, AppRsetObject): |
844 | 230 |
__metaclass__ = metafieldsform |
1047
21d4d5e6aa45
make forms selectable (appobject)
sylvain.thenault@logilab.fr
parents:
1032
diff
changeset
|
231 |
__registry__ = 'forms' |
21d4d5e6aa45
make forms selectable (appobject)
sylvain.thenault@logilab.fr
parents:
1032
diff
changeset
|
232 |
__select__ = yes() |
1147 | 233 |
|
234 |
is_subform = False |
|
235 |
||
236 |
# attributes overrideable through __init__ |
|
1082 | 237 |
internal_fields = ('__errorurl',) + NAV_FORM_PARAMETERS |
1311
4cc6e2723dc7
move ajax.js to base form class
sylvain.thenault@logilab.fr
parents:
1308
diff
changeset
|
238 |
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
|
239 |
needs_css = ('cubicweb.form.css',) |
1147 | 240 |
domid = 'form' |
241 |
title = None |
|
242 |
action = None |
|
243 |
onsubmit = "return freezeFormButtons('%(domid)s');" |
|
244 |
cssclass = None |
|
245 |
cssstyle = None |
|
246 |
cwtarget = None |
|
247 |
redirect_path = None |
|
248 |
set_error_url = True |
|
249 |
copy_nav_params = False |
|
1304 | 250 |
form_buttons = None # form buttons (button widgets instances) |
1147 | 251 |
|
1271
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
252 |
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
|
253 |
**kwargs): |
1147 | 254 |
super(FieldsForm, self).__init__(req, rset, row=row, col=col) |
255 |
for key, val in kwargs.items(): |
|
256 |
assert hasattr(self.__class__, key) and not key[0] == '_', key |
|
257 |
setattr(self, key, val) |
|
844 | 258 |
self.fields = list(self.__class__._fields_) |
1147 | 259 |
if self.set_error_url: |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
260 |
self.form_add_hidden('__errorurl', req.url()) |
1147 | 261 |
if self.copy_nav_params: |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
262 |
for param in NAV_FORM_PARAMETERS: |
1147 | 263 |
value = kwargs.get(param, req.form.get(param)) |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
264 |
if value: |
1326
1d389a6b99b1
should not name that parameter
sylvain.thenault@logilab.fr
parents:
1318
diff
changeset
|
265 |
self.form_add_hidden(param, value) |
1271
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
266 |
if submitmsg is not None: |
0a5257f5d723
handle __message in FieldsForm, not only in EntityFieldsForm
sylvain.thenault@logilab.fr
parents:
1270
diff
changeset
|
267 |
self.form_add_hidden('__message', submitmsg) |
1053 | 268 |
self.context = None |
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
269 |
|
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
270 |
@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
|
271 |
def field_by_name(cls_or_self, name, role='subject'): |
1270 | 272 |
"""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
|
273 |
if isinstance(cls_or_self, type): |
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
274 |
fields = cls_or_self._fields_ |
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
275 |
else: |
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
276 |
fields = cls_or_self.fields |
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
277 |
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
|
278 |
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
|
279 |
return field |
1270 | 280 |
raise FieldNotFound(name) |
1058
c27be37daef8
field_by_name method (on class or instance)
sylvain.thenault@logilab.fr
parents:
1056
diff
changeset
|
281 |
|
1147 | 282 |
@iclassmethod |
283 |
def remove_field(cls_or_self, field): |
|
1391 | 284 |
"""remove a field from form class or instance""" |
1147 | 285 |
if isinstance(cls_or_self, type): |
286 |
fields = cls_or_self._fields_ |
|
287 |
else: |
|
288 |
fields = cls_or_self.fields |
|
289 |
fields.remove(field) |
|
290 |
||
1272 | 291 |
@iclassmethod |
292 |
def append_field(cls_or_self, field): |
|
1391 | 293 |
"""append a field to form class or instance""" |
1272 | 294 |
if isinstance(cls_or_self, type): |
295 |
fields = cls_or_self._fields_ |
|
296 |
else: |
|
297 |
fields = cls_or_self.fields |
|
298 |
fields.append(field) |
|
299 |
||
844 | 300 |
@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
|
301 |
def form_needs_multipart(self): |
1391 | 302 |
"""true if the form needs enctype=multipart/form-data""" |
844 | 303 |
return any(field.needs_multipart for field in self.fields) |
0 | 304 |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
305 |
def form_add_hidden(self, name, value=None, **kwargs): |
1391 | 306 |
"""add an hidden field to the form""" |
1147 | 307 |
field = StringField(name=name, widget=fwdgs.HiddenInput, initial=value, |
308 |
**kwargs) |
|
1338
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
309 |
if 'id' in kwargs: |
9e038f84dbb3
setdomid should be true when id specified in kwargs
sylvain.thenault@logilab.fr
parents:
1326
diff
changeset
|
310 |
# 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
|
311 |
# 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
|
312 |
field.widget.setdomid = True |
1147 | 313 |
self.fields.append(field) |
314 |
return field |
|
315 |
||
1097
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
316 |
def add_media(self): |
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
317 |
"""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
|
318 |
if self.needs_js: |
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
319 |
self.req.add_js(self.needs_js) |
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
320 |
if self.needs_css: |
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
321 |
self.req.add_css(self.needs_css) |
611bacbbe001
pylint fixes, media definitions on form as well
sylvain.thenault@logilab.fr
parents:
1082
diff
changeset
|
322 |
|
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
|
323 |
def form_render(self, **values): |
1391 | 324 |
"""render this form, using the renderer given in args or the default |
325 |
FormRenderer() |
|
326 |
""" |
|
844 | 327 |
renderer = values.pop('renderer', FormRenderer()) |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
328 |
return renderer.render(self, values) |
844 | 329 |
|
1391 | 330 |
def form_build_context(self, rendervalues=None): |
331 |
"""build form context values (the .context attribute which is a |
|
332 |
dictionary with field instance as key associated to a dictionary |
|
333 |
containing field 'name' (qualified), 'id', 'value' (for display, always |
|
334 |
a string). |
|
335 |
||
336 |
rendervalues is an optional dictionary containing extra kwargs given to |
|
337 |
form_render() |
|
338 |
""" |
|
844 | 339 |
self.context = context = {} |
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
340 |
# on validation error, we get a dictionnary of previously submitted values |
1312 | 341 |
if values is None: |
342 |
values = {} |
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
343 |
previous_values = self.req.data.get('formvalues') |
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
344 |
if previous_values: |
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
345 |
values.update(previous_values) |
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
|
346 |
for field in self.fields: |
894 | 347 |
for field in field.actual_fields(self): |
1304 | 348 |
field.form_init(self) |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
349 |
value = self.form_field_value(field, values) |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
350 |
context[field] = {'value': field.format_value(self.req, value), |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
351 |
'rawvalue': value, |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
352 |
'name': self.form_field_name(field), |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
353 |
'id': self.form_field_id(field), |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
354 |
} |
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
|
355 |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
356 |
def form_field_value(self, field, values, load_bytes=False): |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
357 |
"""looks for field's value in |
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
358 |
1. kw args given to render_form (including previously submitted form |
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
359 |
values if any) |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
360 |
2. req.form |
1386
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
361 |
3. default_<fieldname> attribute / method on the form |
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
362 |
4. field's initial value |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
363 |
""" |
1386
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
364 |
defaultattr = 'default_%s' % field.name |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
365 |
if field.name in values: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
366 |
value = values[field.name] |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
367 |
elif field.name in self.req.form: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
368 |
value = self.req.form[field.name] |
1386
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
369 |
elif hasattr(self, defaultattr): |
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
370 |
value = getattr(self, defaultattr) |
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
371 |
if callable(value): |
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
372 |
value = value() |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
373 |
else: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
374 |
value = field.initial |
1386
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
375 |
if callable(value): |
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
376 |
value = value(self) |
897
f5b91f11d8b6
provide basic methods to build fields from schema constraints / cardinality
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
896
diff
changeset
|
377 |
return value |
1147 | 378 |
|
379 |
def form_field_error(self, field): |
|
380 |
"""return validation error for widget's field, if any""" |
|
381 |
errex = self.req.data.get('formerrors') |
|
382 |
if errex and field.name in errex.errors: |
|
383 |
self.req.data['displayederrors'].add(field.name) |
|
384 |
return u'<span class="error">%s</span>' % errex.errors[field.name] |
|
385 |
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
|
386 |
|
1060
d795477ad16b
rename method to form_field_format
sylvain.thenault@logilab.fr
parents:
1059
diff
changeset
|
387 |
def form_field_format(self, field): |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
388 |
return self.req.property_value('ui.default-text-format') |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
389 |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
390 |
def form_field_encoding(self, field): |
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
391 |
return self.req.encoding |
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
392 |
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
393 |
def form_field_name(self, 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
|
394 |
return field.name |
844 | 395 |
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
396 |
def form_field_id(self, 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
|
397 |
return field.id |
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
|
398 |
|
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
|
399 |
def form_field_vocabulary(self, field, limit=None): |
844 | 400 |
raise NotImplementedError |
401 |
||
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
402 |
|
844 | 403 |
class EntityFieldsForm(FieldsForm): |
1147 | 404 |
__select__ = (match_kwargs('entity') | (one_line_rset & non_final_entity())) |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
405 |
|
1082 | 406 |
internal_fields = FieldsForm.internal_fields + ('__type', 'eid') |
1147 | 407 |
domid = 'entityForm' |
1082 | 408 |
|
844 | 409 |
def __init__(self, *args, **kwargs): |
1147 | 410 |
self.edited_entity = kwargs.pop('entity', None) |
411 |
msg = kwargs.pop('submitmsg', None) |
|
844 | 412 |
super(EntityFieldsForm, self).__init__(*args, **kwargs) |
1147 | 413 |
if self.edited_entity is None: |
1369
49497136e977
must specify col where entity's eid is
sylvain.thenault@logilab.fr
parents:
1360
diff
changeset
|
414 |
self.edited_entity = self.complete_entity(self.row, self.col) |
887
51e371245bc5
various fixes to have change state and deletion forms working
sylvain.thenault@logilab.fr
parents:
874
diff
changeset
|
415 |
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
|
416 |
self.form_add_hidden('eid') |
1147 | 417 |
if msg is not None: |
418 |
# If we need to directly attach the new object to another one |
|
419 |
for linkto in self.req.list_form_param('__linkto'): |
|
420 |
self.form_add_hidden('__linkto', linkto) |
|
421 |
msg = '%s %s' % (msg, self.req._('and linked')) |
|
422 |
self.form_add_hidden('__message', msg) |
|
844 | 423 |
|
1315
86bddd181e03
should set None as default here as well
sylvain.thenault@logilab.fr
parents:
1312
diff
changeset
|
424 |
def form_build_context(self, values=None): |
1147 | 425 |
self.form_add_entity_hiddens(self.edited_entity.e_schema) |
1308
3d01229d9f6a
override form_build_context instead of form_render so we get sure to call form_add_entity_hiddens even on subforms
sylvain.thenault@logilab.fr
parents:
1305
diff
changeset
|
426 |
return super(EntityFieldsForm, self).form_build_context(values) |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
427 |
|
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
428 |
def form_add_entity_hiddens(self, eschema): |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
429 |
for field in self.fields[:]: |
894 | 430 |
for field in field.actual_fields(self): |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
431 |
fieldname = field.name |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
432 |
if fieldname != 'eid' and ( |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
433 |
(eschema.has_subject_relation(fieldname) or |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
434 |
eschema.has_object_relation(fieldname))): |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
435 |
field.eidparam = True |
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
436 |
self.fields.append(self.form_entity_hidden_field(field)) |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
437 |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
438 |
def form_entity_hidden_field(self, field): |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
439 |
"""returns the hidden field which will indicate the value |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
440 |
before the modification |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
441 |
""" |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
442 |
# Only RelationField has a `role` attribute, others are used |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
443 |
# to describe attribute fields => role is 'subject' |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
444 |
if getattr(field, 'role', 'subject') == 'subject': |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
445 |
name = 'edits-%s' % field.name |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
446 |
else: |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
447 |
name = 'edito-%s' % field.name |
898
583f64567256
fix HiddenRelationField bug
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
897
diff
changeset
|
448 |
return HiddenInitialValueField(field, name=name) |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
449 |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
450 |
def form_field_value(self, field, values, load_bytes=False): |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
451 |
"""look for field's value with the following rules: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
452 |
1. handle special __type and eid fields |
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
453 |
2. looks in kw args given to render_form (including previously submitted |
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
454 |
form values if any) |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
455 |
3. looks in req.form |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
456 |
4. if entity has an eid: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
457 |
1. looks for an associated attribute / method |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
458 |
2. use field's initial value |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
459 |
else: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
460 |
1. looks for a default_<fieldname> attribute / method on the form |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
461 |
2. use field's initial value |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
462 |
|
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
463 |
values found in step 4 may be a callable which'll then be called. |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
464 |
""" |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
465 |
fieldname = field.name |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
466 |
if fieldname.startswith('edits-') or fieldname.startswith('edito-'): |
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
467 |
# edit[s|o]- fieds must have the actual value stored on the entity |
1147 | 468 |
if hasattr(field, 'visible_field'): |
469 |
if self.edited_entity.has_eid(): |
|
470 |
value = self._form_field_entity_value(field.visible_field, |
|
471 |
default_initial=False) |
|
472 |
else: |
|
473 |
value = INTERNAL_FIELD_VALUE |
|
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
474 |
else: |
1147 | 475 |
value = field.initial |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
476 |
elif fieldname == '__type': |
1147 | 477 |
value = self.edited_entity.id |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
478 |
elif fieldname == 'eid': |
1147 | 479 |
value = self.edited_entity.eid |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
480 |
elif fieldname in values: |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
481 |
value = values[fieldname] |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
482 |
elif fieldname in self.req.form: |
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
483 |
value = self.req.form[fieldname] |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
484 |
else: |
1147 | 485 |
if self.edited_entity.has_eid() and field.eidparam: |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
486 |
# use value found on the entity or field's initial value if it's |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
487 |
# not an attribute of the entity (XXX may conflicts and get |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
488 |
# undesired value) |
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
489 |
value = self._form_field_entity_value(field, default_initial=True, |
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
490 |
load_bytes=load_bytes) |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
491 |
else: |
863
4fde01fc39ca
restore previous hidden input behaviour (edits- / edito- fields)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
849
diff
changeset
|
492 |
defaultattr = 'default_%s' % fieldname |
1147 | 493 |
if hasattr(self.edited_entity, defaultattr): |
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
494 |
# XXX bw compat, default_<field name> on the entity |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
495 |
warn('found %s on %s, should be set on a specific form' |
1147 | 496 |
% (defaultattr, self.edited_entity.id), DeprecationWarning) |
497 |
value = getattr(self.edited_entity, defaultattr) |
|
848
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
498 |
elif hasattr(self, defaultattr): |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
499 |
# search for default_<field name> on the form instance |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
500 |
value = getattr(self, defaultattr) |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
501 |
else: |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
502 |
# use field's initial value |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
503 |
value = field.initial |
f5aca5c5f6ca
set __errorurl, fix retreiving of field's value
sylvain.thenault@logilab.fr
parents:
847
diff
changeset
|
504 |
if callable(value): |
1386
8ba1f0d36c7e
initial form values can now also be a callable of the field or the form itself
Florent <florent@secondweb.fr>
parents:
1369
diff
changeset
|
505 |
value = value(self) |
897
f5b91f11d8b6
provide basic methods to build fields from schema constraints / cardinality
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
896
diff
changeset
|
506 |
return value |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
507 |
|
1060
d795477ad16b
rename method to form_field_format
sylvain.thenault@logilab.fr
parents:
1059
diff
changeset
|
508 |
def form_field_format(self, field): |
1147 | 509 |
entity = self.edited_entity |
1107
961a478593a5
has_metadata is a schema method
sylvain.thenault@logilab.fr
parents:
1101
diff
changeset
|
510 |
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
|
511 |
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
|
512 |
return self.edited_entity.attr_metadata(field.name, 'format') |
892
1558772340a7
rich field / fckeditor handling
sylvain.thenault@logilab.fr
parents:
888
diff
changeset
|
513 |
return self.req.property_value('ui.default-text-format') |
844 | 514 |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
515 |
def form_field_encoding(self, field): |
1147 | 516 |
entity = self.edited_entity |
1107
961a478593a5
has_metadata is a schema method
sylvain.thenault@logilab.fr
parents:
1101
diff
changeset
|
517 |
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
|
518 |
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
|
519 |
return self.edited_entity.attr_metadata(field.name, 'encoding') |
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
520 |
return super(EntityFieldsForm, self).form_field_encoding(field) |
1147 | 521 |
|
522 |
def form_field_error(self, field): |
|
523 |
"""return validation error for widget's field, if any""" |
|
524 |
errex = self.req.data.get('formerrors') |
|
525 |
if errex and errex.eid == self.edited_entity.eid and field.name in errex.errors: |
|
526 |
self.req.data['displayederrors'].add(field.name) |
|
527 |
return u'<span class="error">%s</span>' % errex.errors[field.name] |
|
528 |
return u'' |
|
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
529 |
|
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
530 |
def _form_field_entity_value(self, field, default_initial=True, load_bytes=False): |
1147 | 531 |
attr = field.name |
532 |
entity = self.edited_entity |
|
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
533 |
if field.role == 'object': |
1049
f8e92c2f3bef
fix attribute name for object relation
sylvain.thenault@logilab.fr
parents:
1048
diff
changeset
|
534 |
attr = 'reverse_' + attr |
1147 | 535 |
elif entity.e_schema.subject_relation(attr).is_final(): |
536 |
attrtype = entity.e_schema.destination(attr) |
|
907 | 537 |
if attrtype == 'Password': |
1147 | 538 |
return entity.has_eid() and INTERNAL_FIELD_VALUE or '' |
907 | 539 |
if attrtype == 'Bytes': |
1147 | 540 |
if entity.has_eid(): |
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
541 |
if load_bytes: |
1147 | 542 |
return getattr(entity, attr) |
1061
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
543 |
# XXX value should reflect if some file is already attached |
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
544 |
return True |
7d2e6b5fae3c
* new load_bytes argument to form_field_value
sylvain.thenault@logilab.fr
parents:
1060
diff
changeset
|
545 |
return False |
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
546 |
if default_initial: |
1147 | 547 |
value = getattr(entity, attr, field.initial) |
888
603327e9aef4
fix field value for hidden edit[s|Ã ] fields
sylvain.thenault@logilab.fr
parents:
887
diff
changeset
|
548 |
else: |
1147 | 549 |
value = getattr(entity, attr) |
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
|
550 |
if isinstance(field, RelationField): |
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
|
551 |
# in this case, value is the list of related entities |
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
|
552 |
value = [ent.eid for ent in value] |
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
|
553 |
return value |
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
|
554 |
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
555 |
def form_field_name(self, 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
|
556 |
if field.eidparam: |
1147 | 557 |
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
|
558 |
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
|
559 |
|
849
8591d896db7e
update some prototype, ChangeStateForm
sylvain.thenault@logilab.fr
parents:
848
diff
changeset
|
560 |
def form_field_id(self, 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
|
561 |
if field.eidparam: |
1147 | 562 |
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
|
563 |
return field.id |
844 | 564 |
|
1031
1a89683cb687
restore limit on form_field_vocabulary, actually used
sylvain.thenault@logilab.fr
parents:
1016
diff
changeset
|
565 |
def form_field_vocabulary(self, field, limit=None): |
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
|
566 |
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
|
567 |
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
|
568 |
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
|
569 |
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
|
570 |
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
|
571 |
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
|
572 |
# 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
|
573 |
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
|
574 |
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
|
575 |
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
|
576 |
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
|
577 |
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
|
578 |
% (method, self.edited_entity.id), DeprecationWarning) |
1009 | 579 |
# NOTE: it is the responsibility of `vocabfunc` to sort the result |
580 |
# (direclty through RQL or via a python sort). This is also |
|
581 |
# important because `vocabfunc` might return a list with |
|
582 |
# couples (label, None) which act as separators. In these |
|
583 |
# 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
|
584 |
return vocabfunc(rtype, limit) |
844 | 585 |
|
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
586 |
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
|
587 |
"""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
|
588 |
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
|
589 |
""" |
1147 | 590 |
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
|
591 |
if isinstance(rtype, basestring): |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
592 |
rtype = entity.schema.rschema(rtype) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
593 |
done = None |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
594 |
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
|
595 |
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
|
596 |
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
|
597 |
result = [] |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
598 |
rsetsize = None |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
599 |
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
|
600 |
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
|
601 |
rsetsize = limit - len(result) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
602 |
result += self.relation_vocabulary(rtype, objtype, 'subject', |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
603 |
rsetsize, done) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
604 |
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
|
605 |
break |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
606 |
return result |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
607 |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
608 |
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
|
609 |
"""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
|
610 |
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
|
611 |
""" |
1147 | 612 |
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
|
613 |
if isinstance(rtype, basestring): |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
614 |
rtype = entity.schema.rschema(rtype) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
615 |
done = None |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
616 |
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
|
617 |
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
|
618 |
result = [] |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
619 |
rsetsize = None |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
620 |
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
|
621 |
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
|
622 |
rsetsize = limit - len(result) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
623 |
result += self.relation_vocabulary(rtype, subjtype, 'object', |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
624 |
rsetsize, done) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
625 |
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
|
626 |
break |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
627 |
return result |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
628 |
|
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
629 |
def relation_vocabulary(self, rtype, targettype, role, |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
630 |
limit=None, done=None): |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
631 |
if done is None: |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
632 |
done = set() |
1147 | 633 |
rset = self.edited_entity.unrelated(rtype, targettype, role, limit) |
902
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
634 |
res = [] |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
635 |
for entity in rset.entities(): |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
636 |
if entity.eid in done: |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
637 |
continue |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
638 |
done.add(entity.eid) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
639 |
res.append((entity.view('combobox'), entity.eid)) |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
640 |
return res |
e4de959c76af
vocabulary methods are now defined on forms, not on entities
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
901
diff
changeset
|
641 |
|
1175
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
642 |
def subject_in_state_vocabulary(self, rschema, limit=None): |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
643 |
"""vocabulary method for the in_state relation, looking for |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
644 |
relation's object entities (i.e. self is the subject) according |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
645 |
to initial_state, state_of and next_state relation |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
646 |
""" |
1184
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
647 |
entity = self.edited_entity |
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
648 |
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
|
649 |
# get the initial state |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
650 |
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
|
651 |
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
|
652 |
if rset: |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
653 |
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
|
654 |
return [] |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
655 |
results = [] |
1184
a33deae7c6a2
oops, this method doesn't belong anymore to entity class
sylvain.thenault@logilab.fr
parents:
1183
diff
changeset
|
656 |
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
|
657 |
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
|
658 |
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
|
659 |
return sorted(results) |
96747df28a1f
backport subject_in_state_vocabulary to EntityFieldsForm, deprecate the old one
sylvain.thenault@logilab.fr
parents:
1147
diff
changeset
|
660 |
|
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
661 |
|
1147 | 662 |
class CompositeForm(FieldsForm): |
663 |
"""form composed for sub-forms""" |
|
664 |
||
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
665 |
def __init__(self, *args, **kwargs): |
1147 | 666 |
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
|
667 |
self.forms = [] |
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
668 |
|
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
669 |
def form_add_subform(self, subform): |
1147 | 670 |
subform.is_subform = True |
869
168ad6d424d1
form to edit multiple entities, use it in DeleteConfForm
sylvain.thenault@logilab.fr
parents:
867
diff
changeset
|
671 |
self.forms.append(subform) |