author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
Fri, 25 Sep 2009 11:56:31 +0200 | |
changeset 3482 | 9a868f462fa4 |
parent 3451 | 6b46d73823f5 |
child 4094 | 8b0c6c272ad9 |
permissions | -rw-r--r-- |
0 | 1 |
"""abstract box classes for CubicWeb web client |
2 |
||
3 |
:organization: Logilab |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1885
diff
changeset
|
4 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
0 | 5 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1885
diff
changeset
|
6 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
0 | 7 |
""" |
8 |
__docformat__ = "restructuredtext en" |
|
2159 | 9 |
_ = unicode |
0 | 10 |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2159
diff
changeset
|
11 |
from logilab.mtconverter import xml_escape |
0 | 12 |
|
1149 | 13 |
from cubicweb import Unauthorized, role as get_role, target as get_target |
2710
40789c3044f3
[web.box] remove deprecation warnings
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2381
diff
changeset
|
14 |
from cubicweb.schema import display_name |
652
603c782dc092
various SyntaxErrors / missing import fixes + reorganization of the `registered` classmethod
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
640
diff
changeset
|
15 |
from cubicweb.selectors import (one_line_rset, primary_view, |
2819
b864288fd316
remove more 3.2 deprecated code, reintroduce checkbox used by formrenderers
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2799
diff
changeset
|
16 |
match_context_prop, partial_has_related_entities) |
816
9cd49a910fce
kill Template class and 'templates' registry
sylvain.thenault@logilab.fr
parents:
809
diff
changeset
|
17 |
from cubicweb.view import View, ReloadableMixIn |
0 | 18 |
|
19 |
from cubicweb.web.htmlwidgets import (BoxLink, BoxWidget, SideBoxWidget, |
|
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
20 |
RawBoxItem, BoxSeparator) |
0 | 21 |
from cubicweb.web.action import UnregisteredAction |
22 |
||
23 |
||
816
9cd49a910fce
kill Template class and 'templates' registry
sylvain.thenault@logilab.fr
parents:
809
diff
changeset
|
24 |
class BoxTemplate(View): |
0 | 25 |
"""base template for boxes, usually a (contextual) list of possible |
1493 | 26 |
|
0 | 27 |
actions. Various classes attributes may be used to control the box |
28 |
rendering. |
|
1493 | 29 |
|
0 | 30 |
You may override on of the formatting callbacks is this is not necessary |
31 |
for your custom box. |
|
1493 | 32 |
|
0 | 33 |
Classes inheriting from this class usually only have to override call |
34 |
to fetch desired actions, and then to do something like :: |
|
35 |
||
36 |
box.render(self.w) |
|
37 |
""" |
|
38 |
__registry__ = 'boxes' |
|
809 | 39 |
__select__ = match_context_prop() |
1493 | 40 |
|
0 | 41 |
categories_in_order = () |
2799
b703639614e7
refactor property handling to avoid name conflicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2789
diff
changeset
|
42 |
cw_property_defs = { |
0 | 43 |
_('visible'): dict(type='Boolean', default=True, |
44 |
help=_('display the box or not')), |
|
45 |
_('order'): dict(type='Int', default=99, |
|
46 |
help=_('display order of the box')), |
|
47 |
# XXX 'incontext' boxes are handled by the default primary view |
|
48 |
_('context'): dict(type='String', default='left', |
|
49 |
vocabulary=(_('left'), _('incontext'), _('right')), |
|
50 |
help=_('context where this box should be displayed')), |
|
51 |
} |
|
52 |
context = 'left' |
|
53 |
htmlitemclass = 'boxItem' |
|
54 |
||
55 |
def sort_actions(self, actions): |
|
56 |
"""return a list of (category, actions_sorted_by_title)""" |
|
57 |
result = [] |
|
58 |
actions_by_cat = {} |
|
59 |
for action in actions: |
|
3220
11b6016e3970
cleanup, futur warning fixes :)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2757
diff
changeset
|
60 |
actions_by_cat.setdefault(action.category, []).append( |
11b6016e3970
cleanup, futur warning fixes :)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2757
diff
changeset
|
61 |
(action.title, action) ) |
0 | 62 |
for key, values in actions_by_cat.items(): |
63 |
actions_by_cat[key] = [act for title, act in sorted(values)] |
|
64 |
for cat in self.categories_in_order: |
|
65 |
if cat in actions_by_cat: |
|
66 |
result.append( (cat, actions_by_cat[cat]) ) |
|
67 |
for item in sorted(actions_by_cat.items()): |
|
68 |
result.append(item) |
|
69 |
return result |
|
70 |
||
71 |
def mk_action(self, title, path, escape=True, **kwargs): |
|
72 |
"""factory function to create dummy actions compatible with the |
|
73 |
.format_actions method |
|
74 |
""" |
|
75 |
if escape: |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2159
diff
changeset
|
76 |
title = xml_escape(title) |
0 | 77 |
return self.box_action(self._action(title, path, **kwargs)) |
1493 | 78 |
|
0 | 79 |
def _action(self, title, path, **kwargs): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
80 |
return UnregisteredAction(self._cw, self.cw_rset, title, path, **kwargs) |
0 | 81 |
|
82 |
# formating callbacks |
|
83 |
||
84 |
def boxitem_link_tooltip(self, action): |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
85 |
if action.__regid__: |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
86 |
return u'keyword: %s' % action.__regid__ |
0 | 87 |
return u'' |
88 |
||
89 |
def box_action(self, action): |
|
90 |
cls = getattr(action, 'html_class', lambda: None)() or self.htmlitemclass |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
91 |
return BoxLink(action.url(), self._cw._(action.title), |
0 | 92 |
cls, self.boxitem_link_tooltip(action)) |
1493 | 93 |
|
0 | 94 |
|
95 |
class RQLBoxTemplate(BoxTemplate): |
|
96 |
"""abstract box for boxes displaying the content of a rql query not |
|
97 |
related to the current result set. |
|
1493 | 98 |
|
0 | 99 |
It rely on etype, rtype (both optional, usable to control registration |
100 |
according to application schema and display according to connected |
|
101 |
user's rights) and rql attributes |
|
102 |
""" |
|
640
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
526
diff
changeset
|
103 |
#XXX __selectors__ = BoxTemplate.__selectors__ + (etype_rtype_selector,) |
0 | 104 |
|
105 |
rql = None |
|
1493 | 106 |
|
0 | 107 |
def to_display_rql(self): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
108 |
assert self.rql is not None, self.__regid__ |
0 | 109 |
return (self.rql,) |
1493 | 110 |
|
0 | 111 |
def call(self, **kwargs): |
112 |
try: |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
113 |
rset = self._cw.execute(*self.to_display_rql()) |
0 | 114 |
except Unauthorized: |
115 |
# can't access to something in the query, forget this box |
|
116 |
return |
|
117 |
if len(rset) == 0: |
|
118 |
return |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
119 |
box = BoxWidget(self._cw._(self.title), self.__regid__) |
0 | 120 |
for i, (teid, tname) in enumerate(rset): |
121 |
entity = rset.get_entity(i, 0) |
|
122 |
box.append(self.mk_action(tname, entity.absolute_url())) |
|
123 |
box.render(w=self.w) |
|
124 |
||
1493 | 125 |
|
0 | 126 |
class UserRQLBoxTemplate(RQLBoxTemplate): |
127 |
"""same as rql box template but the rql is build using the eid of the |
|
128 |
request's user |
|
129 |
""" |
|
130 |
||
131 |
def to_display_rql(self): |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
132 |
assert self.rql is not None, self.__regid__ |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
133 |
return (self.rql, {'x': self._cw.user.eid}, 'x') |
1493 | 134 |
|
0 | 135 |
|
136 |
class EntityBoxTemplate(BoxTemplate): |
|
137 |
"""base class for boxes related to a single entity""" |
|
809 | 138 |
__select__ = BoxTemplate.__select__ & one_line_rset() & primary_view() |
0 | 139 |
context = 'incontext' |
1493 | 140 |
|
0 | 141 |
def call(self, row=0, col=0, **kwargs): |
526 | 142 |
"""classes inheriting from EntityBoxTemplate should define cell_call""" |
0 | 143 |
self.cell_call(row, col, **kwargs) |
144 |
||
145 |
||
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
146 |
class RelatedEntityBoxTemplate(EntityBoxTemplate): |
838
f2c56312b03a
rename abstract_* selectors into partial_* + add docstrings
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
816
diff
changeset
|
147 |
__select__ = EntityBoxTemplate.__select__ & partial_has_related_entities() |
742
99115e029dca
replaced most of __selectors__ assignments with __select__
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
670
diff
changeset
|
148 |
|
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
149 |
def cell_call(self, row, col, **kwargs): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
150 |
entity = self.cw_rset.get_entity(row, col) |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
151 |
limit = self._cw.property_value('navigation.related-limit') + 1 |
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
152 |
role = get_role(self) |
1885
c2011d238e98
replace sideRelated with sideBox
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1696
diff
changeset
|
153 |
self.w(u'<div class="sideBox">') |
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
154 |
self.wview('sidebox', entity.related(self.rtype, role, limit=limit), |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
155 |
title=display_name(self._cw, self.rtype, role)) |
250
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
156 |
self.w(u'</div>') |
7fd7a0d387d7
new RelatedEntityBoxTemplate base class
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
237
diff
changeset
|
157 |
|
0 | 158 |
|
159 |
class EditRelationBoxTemplate(ReloadableMixIn, EntityBoxTemplate): |
|
160 |
"""base class for boxes which let add or remove entities linked |
|
161 |
by a given relation |
|
162 |
||
163 |
subclasses should define at least id, rtype and target |
|
164 |
class attributes. |
|
165 |
""" |
|
1493 | 166 |
|
1624
baf484a182cd
should take arbitrary arguments
sylvain.thenault@logilab.fr
parents:
1493
diff
changeset
|
167 |
def cell_call(self, row, col, view=None, **kwargs): |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
168 |
self._cw.add_js('cubicweb.ajax.js') |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
169 |
entity = self.cw_rset.get_entity(row, col) |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
170 |
box = SideBoxWidget(display_name(self._cw, self.rtype), self.__regid__) |
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
171 |
related = self.related_boxitems(entity) |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
172 |
unrelated = self.unrelated_boxitems(entity) |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
173 |
box.extend(related) |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
174 |
if related and unrelated: |
0 | 175 |
box.append(BoxSeparator()) |
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
176 |
box.extend(unrelated) |
0 | 177 |
box.render(self.w) |
178 |
||
179 |
def div_id(self): |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
180 |
return self.__regid__ |
1493 | 181 |
|
0 | 182 |
def box_item(self, entity, etarget, rql, label): |
183 |
"""builds HTML link to edit relation between `entity` and `etarget` |
|
184 |
""" |
|
1149 | 185 |
role, target = get_role(self), get_target(self) |
186 |
args = {role[0] : entity.eid, target[0] : etarget.eid} |
|
0 | 187 |
url = self.user_rql_callback((rql, args)) |
188 |
# for each target, provide a link to edit the relation |
|
189 |
label = u'[<a href="%s">%s</a>] %s' % (url, label, |
|
190 |
etarget.view('incontext')) |
|
191 |
return RawBoxItem(label, liclass=u'invisible') |
|
1493 | 192 |
|
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
193 |
def related_boxitems(self, entity): |
0 | 194 |
rql = 'DELETE S %s O WHERE S eid %%(s)s, O eid %%(o)s' % self.rtype |
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
195 |
related = [] |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
196 |
for etarget in self.related_entities(entity): |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
197 |
related.append(self.box_item(entity, etarget, rql, u'-')) |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
198 |
return related |
1493 | 199 |
|
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
200 |
def unrelated_boxitems(self, entity): |
0 | 201 |
rql = 'SET S %s O WHERE S eid %%(s)s, O eid %%(o)s' % self.rtype |
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
202 |
unrelated = [] |
0 | 203 |
for etarget in self.unrelated_entities(entity): |
2757
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
204 |
unrelated.append(self.box_item(entity, etarget, rql, u'+')) |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
205 |
return unrelated |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
206 |
|
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
207 |
def related_entities(self, entity): |
c8e28e1754f0
B [web.box] fix EditRelationBoxTemplate in case neither related nor unrelated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2710
diff
changeset
|
208 |
return entity.related(self.rtype, get_role(self), entities=True) |
0 | 209 |
|
210 |
def unrelated_entities(self, entity): |
|
211 |
"""returns the list of unrelated entities |
|
212 |
||
213 |
if etype is not defined on the Box's class, the default |
|
214 |
behaviour is to use the entity's appropraite vocabulary function |
|
215 |
""" |
|
216 |
# use entity.unrelated if we've been asked for a particular etype |
|
217 |
if hasattr(self, 'etype'): |
|
1149 | 218 |
return entity.unrelated(self.rtype, self.etype, get_role(self)).entities() |
0 | 219 |
# in other cases, use vocabulary functions |
220 |
entities = [] |
|
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
221 |
form = self.vreg['forms'].select('edition', self._cw, rset=self.cw_rset, |
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
222 |
row=self.cw_row or 0) |
1695
9a9822f3cb6c
update implementation to get vocab from form instead of entity
sylvain.thenault@logilab.fr
parents:
1624
diff
changeset
|
223 |
field = form.field_by_name(self.rtype, get_role(self), entity.e_schema) |
9a9822f3cb6c
update implementation to get vocab from form instead of entity
sylvain.thenault@logilab.fr
parents:
1624
diff
changeset
|
224 |
for _, eid in form.form_field_vocabulary(field): |
0 | 225 |
if eid is not None: |
3451
6b46d73823f5
[api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3230
diff
changeset
|
226 |
rset = self._cw.eid_rset(eid) |
0 | 227 |
entities.append(rset.get_entity(0, 0)) |
228 |
return entities |
|
1493 | 229 |