| author | sylvain.thenault@logilab.fr |
| Fri, 24 Apr 2009 17:04:14 +0200 | |
| branch | tls-sprint |
| changeset 1477 | b056a49c16dc |
| parent 1453 | a9841184be7c |
| parent 1457 | 89567fcc6b15 |
| child 1491 | 742aff97dbf7 |
| permissions | -rw-r--r-- |
| 0 | 1 |
"""Set of HTML generic base views: |
2 |
||
3 |
* noresult, final |
|
4 |
* primary, sidebox |
|
5 |
* secondary, oneline, incontext, outofcontext, text |
|
6 |
* list |
|
7 |
||
8 |
||
9 |
:organization: Logilab |
|
| 479 | 10 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
| 0 | 11 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
12 |
""" |
|
|
964
a711c7c185d1
gargl, this shouldn't be there in case we're running py 2.4
sylvain.thenault@logilab.fr
parents:
958
diff
changeset
|
13 |
#from __future__ import with_statement |
|
958
6053622aae81
fix name error, filter out non empty rset
sylvain.thenault@logilab.fr
parents:
956
diff
changeset
|
14 |
|
| 0 | 15 |
__docformat__ = "restructuredtext en" |
16 |
||
|
528
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
17 |
from warnings import warn |
| 0 | 18 |
|
19 |
from rql import nodes |
|
20 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
21 |
from logilab.mtconverter import TransformError, html_escape |
| 0 | 22 |
|
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
23 |
from cubicweb import Unauthorized, NoSelectableObject |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
24 |
from cubicweb.selectors import yes, empty_rset |
| 756 | 25 |
from cubicweb.view import EntityView, AnyRsetView, View |
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
26 |
from cubicweb.common.uilib import cut, printable_value |
| 0 | 27 |
|
28 |
_ = unicode |
|
29 |
||
30 |
class NullView(AnyRsetView): |
|
31 |
"""default view when no result has been found""" |
|
32 |
id = 'null' |
|
|
758
0c0dfd33a76d
instantiate selectors wherever needed
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
742
diff
changeset
|
33 |
__select__ = yes() |
| 0 | 34 |
def call(self, **kwargs): |
35 |
pass |
|
36 |
cell_call = call |
|
37 |
||
38 |
||
| 632 | 39 |
class NoResultView(View): |
| 0 | 40 |
"""default view when no result has been found""" |
|
742
99115e029dca
replaced most of __selectors__ assignments with __select__
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
647
diff
changeset
|
41 |
__select__ = empty_rset() |
| 0 | 42 |
id = 'noresult' |
| 1451 | 43 |
|
| 0 | 44 |
def call(self, **kwargs): |
45 |
self.w(u'<div class="searchMessage"><strong>%s</strong></div>\n' |
|
46 |
% self.req._('No result matching query')) |
|
47 |
||
48 |
||
49 |
class FinalView(AnyRsetView): |
|
50 |
"""display values without any transformation (i.e. get a number for |
|
| 1451 | 51 |
entities) |
| 0 | 52 |
""" |
53 |
id = 'final' |
|
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
54 |
# record generated i18n catalog messages |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
55 |
_('%d years') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
56 |
_('%d months') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
57 |
_('%d weeks') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
58 |
_('%d days') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
59 |
_('%d hours') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
60 |
_('%d minutes') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
61 |
_('%d seconds') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
62 |
_('%d years') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
63 |
_('%d months') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
64 |
_('%d weeks') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
65 |
_('%d days') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
66 |
_('%d hours') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
67 |
_('%d minutes') |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
68 |
_('%d seconds') |
| 1451 | 69 |
|
|
573
9c8fd72ba6c1
try to get raw text values in rset csv view
sylvain.thenault@logilab.fr
parents:
570
diff
changeset
|
70 |
def cell_call(self, row, col, props=None, displaytime=False, format='text/html'): |
| 0 | 71 |
etype = self.rset.description[row][col] |
72 |
value = self.rset.rows[row][col] |
|
73 |
if etype == 'String': |
|
74 |
entity, rtype = self.rset.related_entity(row, col) |
|
75 |
if entity is not None: |
|
76 |
# yes ! |
|
|
573
9c8fd72ba6c1
try to get raw text values in rset csv view
sylvain.thenault@logilab.fr
parents:
570
diff
changeset
|
77 |
self.w(entity.printable_value(rtype, value, format=format)) |
| 0 | 78 |
return |
79 |
if etype in ('Time', 'Interval'): |
|
| 1451 | 80 |
# value is DateTimeDelta but we have no idea about what is the |
| 0 | 81 |
# reference date here, so we can only approximate years and months |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
82 |
if format == 'text/html': |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
83 |
space = ' ' |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
84 |
else: |
|
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
85 |
space = ' ' |
| 0 | 86 |
if value.days > 730: # 2 years |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
87 |
self.w(self.req.__('%%d%syears' % space) % (value.days // 365)) |
| 0 | 88 |
elif value.days > 60: # 2 months |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
89 |
self.w(self.req.__('%%d%smonths' % space) % (value.days // 30)) |
| 0 | 90 |
elif value.days > 14: # 2 weeks |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
91 |
self.w(self.req.__('%%d%sweeks' % space) % (value.days // 7)) |
| 0 | 92 |
elif value.days > 2: |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
93 |
self.w(self.req.__('%%d%sdays' % space) % int(value.days)) |
| 0 | 94 |
elif value.hours > 2: |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
95 |
self.w(self.req.__('%%d%shours' % space) % int(value.hours)) |
| 0 | 96 |
elif value.minutes >= 2: |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
97 |
self.w(self.req.__('%%d%sminutes' % space) % int(value.minutes)) |
| 0 | 98 |
else: |
|
978
536c748e7b3f
use non-breakable space in time display
sylvain.thenault@logilab.fr
parents:
964
diff
changeset
|
99 |
self.w(self.req.__('%%d%sseconds' % space) % int(value.seconds)) |
| 0 | 100 |
return |
101 |
self.wdata(printable_value(self.req, etype, value, props, displaytime=displaytime)) |
|
102 |
||
103 |
||
104 |
PRIMARY_SKIP_RELS = set(['is', 'is_instance_of', 'identity', |
|
| 1451 | 105 |
'owned_by', 'created_by', |
| 0 | 106 |
'in_state', 'wf_info_for', 'require_permission', |
107 |
'from_entity', 'to_entity', |
|
108 |
'see_also']) |
|
109 |
||
110 |
class PrimaryView(EntityView): |
|
111 |
"""the full view of an non final entity""" |
|
112 |
id = 'primary' |
|
113 |
title = _('primary') |
|
114 |
show_attr_label = True |
|
115 |
show_rel_label = True |
|
116 |
skip_none = True |
|
117 |
skip_attrs = ('eid', 'creation_date', 'modification_date') |
|
118 |
skip_rels = () |
|
119 |
main_related_section = True |
|
120 |
||
121 |
def html_headers(self): |
|
122 |
"""return a list of html headers (eg something to be inserted between |
|
123 |
<head> and </head> of the returned page |
|
124 |
||
125 |
by default primary views are indexed |
|
126 |
""" |
|
127 |
return [] |
|
| 1451 | 128 |
|
129 |
def cell_call(self, row, col): |
|
| 0 | 130 |
self.row = row |
|
213
6842c3dee34b
adding files (formely appearing in jpl) specific to cubicweb
Laure Bourgois <Laure.Bourgois@logilab.fr>
parents:
179
diff
changeset
|
131 |
# XXX move render_entity implementation here |
| 0 | 132 |
self.render_entity(self.complete_entity(row, col)) |
| 1451 | 133 |
|
| 0 | 134 |
def render_entity(self, entity): |
135 |
"""return html to display the given entity""" |
|
136 |
siderelations = [] |
|
137 |
self.render_entity_title(entity) |
|
138 |
self.render_entity_metadata(entity) |
|
139 |
# entity's attributes and relations, excluding meta data |
|
140 |
# if the entity isn't meta itself |
|
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
141 |
boxes = self._preinit_side_related(entity, siderelations) |
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
142 |
if boxes: |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
143 |
self.w(u'<table width="100%"><tr><td width="75%">') |
|
988
b73f3cd23d43
remplacing tables by div for right (and left) box layout
Laure Bourgois <Laure.Bourgois@logilab.fr>
parents:
978
diff
changeset
|
144 |
self.w(u'<div>') |
| 0 | 145 |
self.w(u'<div class="mainInfo">') |
146 |
self.render_entity_attributes(entity, siderelations) |
|
147 |
self.w(u'</div>') |
|
|
528
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
148 |
self.content_navigation_components('navcontenttop') |
| 0 | 149 |
if self.main_related_section: |
150 |
self.render_entity_relations(entity, siderelations) |
|
|
1457
89567fcc6b15
fixe the wrong indent
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1456
diff
changeset
|
151 |
self.w(u'</div>') |
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
152 |
if boxes: |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
153 |
self.w(u'</td><td>') |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
154 |
# side boxes |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
155 |
self.w(u'<div class="primaryRight">') |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
156 |
self.render_side_related(entity, siderelations) |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
157 |
self.w(u'</div>') |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
158 |
self.w(u'</td></tr></table>') |
|
528
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
159 |
self.content_navigation_components('navcontentbottom') |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
160 |
|
| 1477 | 161 |
|
|
528
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
162 |
def content_navigation_components(self, context): |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
163 |
self.w(u'<div class="%s">' % context) |
| 0 | 164 |
for comp in self.vreg.possible_vobjects('contentnavigation', |
|
528
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
165 |
self.req, self.rset, row=self.row, |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
166 |
view=self, context=context): |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
167 |
try: |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
168 |
comp.dispatch(w=self.w, row=self.row, view=self) |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
169 |
except NotImplementedError: |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
170 |
warn('component %s doesnt implement cell_call, please update' |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
171 |
% comp.__class__, DeprecationWarning) |
|
60bd171ecd04
give row when selecting/dispatching content navigation component
sylvain.thenault@logilab.fr
parents:
479
diff
changeset
|
172 |
comp.dispatch(w=self.w, view=self) |
| 0 | 173 |
self.w(u'</div>') |
| 1451 | 174 |
|
| 0 | 175 |
def iter_attributes(self, entity): |
176 |
for rschema, targetschema in entity.e_schema.attribute_definitions(): |
|
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
177 |
if rschema.type in self.skip_attrs: |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
178 |
continue |
| 0 | 179 |
yield rschema, targetschema |
| 1451 | 180 |
|
| 0 | 181 |
def iter_relations(self, entity): |
182 |
skip = set(self.skip_rels) |
|
183 |
skip.update(PRIMARY_SKIP_RELS) |
|
184 |
for rschema, targetschemas, x in entity.e_schema.relation_definitions(): |
|
185 |
if rschema.type in skip: |
|
186 |
continue |
|
187 |
yield rschema, targetschemas, x |
|
188 |
||
189 |
def render_entity_title(self, entity): |
|
190 |
title = self.content_title(entity) # deprecate content_title? |
|
191 |
if title: |
|
192 |
self.w(u'<h1><span class="etype">%s</span> %s</h1>' |
|
193 |
% (entity.dc_type().capitalize(), title)) |
|
| 1451 | 194 |
|
| 0 | 195 |
def content_title(self, entity): |
196 |
"""default implementation return an empty string""" |
|
197 |
return u'' |
|
| 1451 | 198 |
|
| 0 | 199 |
def render_entity_metadata(self, entity): |
200 |
entity.view('metadata', w=self.w) |
|
201 |
summary = self.summary(entity) # deprecate summary? |
|
202 |
if summary: |
|
203 |
self.w(u'<div class="summary">%s</div>' % summary) |
|
| 1451 | 204 |
|
| 0 | 205 |
def summary(self, entity): |
206 |
"""default implementation return an empty string""" |
|
| 1451 | 207 |
return u'' |
208 |
||
| 0 | 209 |
def render_entity_attributes(self, entity, siderelations): |
210 |
for rschema, targetschema in self.iter_attributes(entity): |
|
211 |
attr = rschema.type |
|
212 |
if targetschema.type in ('Password', 'Bytes'): |
|
213 |
continue |
|
214 |
try: |
|
215 |
wdg = entity.get_widget(attr) |
|
216 |
except Exception, ex: |
|
217 |
value = entity.printable_value(attr, entity[attr], targetschema.type) |
|
218 |
else: |
|
219 |
value = wdg.render(entity) |
|
220 |
if self.skip_none and (value is None or value == ''): |
|
221 |
continue |
|
222 |
if rschema.meta: |
|
223 |
continue |
|
224 |
self._render_related_entities(entity, rschema, value) |
|
225 |
||
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
226 |
def _preinit_side_related(self, entity, siderelations): |
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
227 |
self._sideboxes = None |
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
228 |
self._related_entities = [] |
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
229 |
if hasattr(self, 'get_side_boxes_defs'): |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
230 |
self._sideboxes = [(label, rset) for label, rset in self.get_side_boxes_defs(entity) |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
231 |
if rset] |
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
232 |
else: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
233 |
eschema = entity.e_schema |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
234 |
maxrelated = self.req.property_value('navigation.related-limit') |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
235 |
for rschema, targetschemas, x in self.iter_relations(entity): |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
236 |
try: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
237 |
related = entity.related(rschema.type, x, limit=maxrelated+1) |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
238 |
except Unauthorized: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
239 |
continue |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
240 |
if not related: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
241 |
continue |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
242 |
if self.is_side_related(rschema, eschema): |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
243 |
siderelations.append((rschema, related, x)) |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
244 |
continue |
| 1477 | 245 |
self._related_entities.append((rschema, related, x)) |
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
246 |
self._boxes_in_context = list(self.vreg.possible_vobjects('boxes', self.req, self.rset, |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
247 |
row=self.row, view=self, |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
248 |
context='incontext')) |
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
249 |
return self._sideboxes or self._boxes_in_context or self._related_entities or siderelations |
| 1477 | 250 |
|
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
251 |
def render_entity_relations(self, entity, siderelations): |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
252 |
if self._related_entities: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
253 |
for rschema, related, x in self._related_entities: |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
254 |
self._render_related_entities(entity, rschema, related, x) |
|
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
255 |
|
| 0 | 256 |
|
257 |
def render_side_related(self, entity, siderelations): |
|
258 |
"""display side related relations: |
|
259 |
non-meta in a first step, meta in a second step |
|
260 |
""" |
|
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
261 |
if self._sideboxes: |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
262 |
for label, rset in self._sideboxes: |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
263 |
self.w(u'<div class="sideRelated">') |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
264 |
self.wview('sidebox', rset, title=label) |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
265 |
self.w(u'</div>') |
| 0 | 266 |
elif siderelations: |
267 |
self.w(u'<div class="sideRelated">') |
|
268 |
for relatedinfos in siderelations: |
|
269 |
# if not relatedinfos[0].meta: |
|
270 |
# continue |
|
271 |
self._render_related_entities(entity, *relatedinfos) |
|
272 |
self.w(u'</div>') |
|
|
1413
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
273 |
|
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
274 |
if self._boxes_in_context: |
|
ad19d7e6a291
create a table for siderelation
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1194
diff
changeset
|
275 |
for box in self._boxes_in_context: |
|
953
ded89d49c0b4
xhtml fixes: table has no align attribute, avoid inserting empty table
sylvain.thenault@logilab.fr
parents:
925
diff
changeset
|
276 |
try: |
|
ded89d49c0b4
xhtml fixes: table has no align attribute, avoid inserting empty table
sylvain.thenault@logilab.fr
parents:
925
diff
changeset
|
277 |
box.dispatch(w=self.w, row=self.row) |
|
ded89d49c0b4
xhtml fixes: table has no align attribute, avoid inserting empty table
sylvain.thenault@logilab.fr
parents:
925
diff
changeset
|
278 |
except NotImplementedError: |
|
ded89d49c0b4
xhtml fixes: table has no align attribute, avoid inserting empty table
sylvain.thenault@logilab.fr
parents:
925
diff
changeset
|
279 |
# much probably a context insensitive box, which only implements |
|
ded89d49c0b4
xhtml fixes: table has no align attribute, avoid inserting empty table
sylvain.thenault@logilab.fr
parents:
925
diff
changeset
|
280 |
# .call() and not cell_call() |
| 1451 | 281 |
box.dispatch(w=self.w) |
282 |
||
| 0 | 283 |
def is_side_related(self, rschema, eschema): |
284 |
return rschema.meta and \ |
|
285 |
not rschema.schema_relation() == eschema.schema_entity() |
|
286 |
||
287 |
def _render_related_entities(self, entity, rschema, related, |
|
288 |
role='subject'): |
|
289 |
if rschema.is_final(): |
|
290 |
value = related |
|
291 |
show_label = self.show_attr_label |
|
292 |
else: |
|
293 |
if not related: |
|
294 |
return |
|
295 |
show_label = self.show_rel_label |
|
296 |
# if not too many entities, show them all in a list |
|
297 |
maxrelated = self.req.property_value('navigation.related-limit') |
|
298 |
if related.rowcount <= maxrelated: |
|
299 |
if related.rowcount == 1: |
|
300 |
value = self.view('incontext', related, row=0) |
|
301 |
elif 1 < related.rowcount <= 5: |
|
302 |
value = self.view('csv', related) |
|
303 |
else: |
|
304 |
value = '<div>' + self.view('simplelist', related) + '</div>' |
|
305 |
# else show links to display related entities |
|
306 |
else: |
|
307 |
rql = related.printable_rql() |
|
308 |
related.limit(maxrelated) |
|
309 |
value = '<div>' + self.view('simplelist', related) |
|
310 |
value += '[<a href="%s">%s</a>]' % (self.build_url(rql=rql), |
|
311 |
self.req._('see them all')) |
|
312 |
value += '</div>' |
|
313 |
label = display_name(self.req, rschema.type, role) |
|
|
1453
a9841184be7c
guess_field now takes an entity schema as first argument, not an entity class
sylvain.thenault@logilab.fr
parents:
1451
diff
changeset
|
314 |
self.field(label, value, show_label=show_label, tr=False) |
| 0 | 315 |
|
316 |
||
317 |
class SecondaryView(EntityView): |
|
318 |
id = 'secondary' |
|
319 |
title = _('secondary') |
|
| 1451 | 320 |
|
| 0 | 321 |
def cell_call(self, row, col): |
322 |
"""the secondary view for an entity |
|
323 |
secondary = icon + view(oneline) |
|
324 |
""" |
|
325 |
entity = self.entity(row, col) |
|
326 |
self.w(u' ') |
|
327 |
self.wview('oneline', self.rset, row=row, col=col) |
|
328 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
329 |
|
| 0 | 330 |
class OneLineView(EntityView): |
331 |
id = 'oneline' |
|
| 1451 | 332 |
title = _('oneline') |
| 0 | 333 |
|
334 |
def cell_call(self, row, col): |
|
335 |
"""the one line view for an entity: linked text view |
|
336 |
""" |
|
337 |
entity = self.entity(row, col) |
|
338 |
self.w(u'<a href="%s">' % html_escape(entity.absolute_url())) |
|
339 |
self.w(html_escape(self.view('text', self.rset, row=row, col=col))) |
|
340 |
self.w(u'</a>') |
|
341 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
342 |
|
| 0 | 343 |
class TextView(EntityView): |
|
532
ce3e94cbb074
specify content type for text views
sylvain.thenault@logilab.fr
parents:
531
diff
changeset
|
344 |
"""the simplest text view for an entity""" |
| 0 | 345 |
id = 'text' |
346 |
title = _('text') |
|
|
532
ce3e94cbb074
specify content type for text views
sylvain.thenault@logilab.fr
parents:
531
diff
changeset
|
347 |
content_type = 'text/plain' |
|
647
49bb57a9606b
some selectors update + drop EntityRelationView (only used by jpl)
sylvain.thenault@logilab.fr
parents:
632
diff
changeset
|
348 |
|
| 0 | 349 |
def call(self, **kwargs): |
350 |
"""the view is called for an entire result set, by default loop |
|
351 |
other rows of the result set and call the same view on the |
|
352 |
particular row |
|
353 |
||
354 |
Views applicable on None result sets have to override this method |
|
355 |
""" |
|
356 |
rset = self.rset |
|
357 |
if rset is None: |
|
358 |
raise NotImplementedError, self |
|
359 |
for i in xrange(len(rset)): |
|
360 |
self.wview(self.id, rset, row=i, **kwargs) |
|
361 |
if len(rset) > 1: |
|
362 |
self.w(u"\n") |
|
| 1451 | 363 |
|
| 0 | 364 |
def cell_call(self, row, col=0, **kwargs): |
365 |
entity = self.entity(row, col) |
|
366 |
self.w(cut(entity.dc_title(), |
|
367 |
self.req.property_value('navigation.short-line-size'))) |
|
368 |
||
|
137
7e45cf48c2f1
don't display additional owners in metadata, this is confusing
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
0
diff
changeset
|
369 |
|
| 0 | 370 |
class MetaDataView(EntityView): |
371 |
"""paragraph view of some metadata""" |
|
372 |
id = 'metadata' |
|
373 |
show_eid = True |
|
| 1451 | 374 |
|
| 0 | 375 |
def cell_call(self, row, col): |
376 |
_ = self.req._ |
|
377 |
entity = self.entity(row, col) |
|
378 |
self.w(u'<div class="metadata">') |
|
379 |
if self.show_eid: |
|
380 |
self.w(u'#%s - ' % entity.eid) |
|
381 |
if entity.modification_date != entity.creation_date: |
|
382 |
self.w(u'<span>%s</span> ' % _('latest update on')) |
|
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
383 |
self.w(u'<span class="value">%s</span>, ;' |
| 0 | 384 |
% self.format_date(entity.modification_date)) |
385 |
# entities from external source may not have a creation date (eg ldap) |
|
| 1451 | 386 |
if entity.creation_date: |
| 0 | 387 |
self.w(u'<span>%s</span> ' % _('created on')) |
388 |
self.w(u'<span class="value">%s</span>' |
|
389 |
% self.format_date(entity.creation_date)) |
|
390 |
if entity.creator: |
|
|
1456
998ff29c3390
related entitied must be computed in _preinit_side_related
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents:
1431
diff
changeset
|
391 |
self.w(u' <span>%s</span> ' % _('by')) |
| 0 | 392 |
self.w(u'<span class="value">%s</span>' % entity.creator.name()) |
393 |
self.w(u'</div>') |
|
394 |
||
395 |
||
396 |
# new default views for finner control in general views , to use instead of |
|
397 |
# oneline / secondary |
|
398 |
||
399 |
class InContextTextView(TextView): |
|
400 |
id = 'textincontext' |
|
401 |
title = None # not listed as a possible view |
|
402 |
def cell_call(self, row, col): |
|
403 |
entity = self.entity(row, col) |
|
404 |
self.w(entity.dc_title()) |
|
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
405 |
|
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
406 |
|
| 0 | 407 |
class OutOfContextTextView(InContextTextView): |
408 |
id = 'textoutofcontext' |
|
409 |
||
410 |
def cell_call(self, row, col): |
|
411 |
entity = self.entity(row, col) |
|
412 |
self.w(entity.dc_long_title()) |
|
413 |
||
414 |
||
415 |
class InContextView(EntityView): |
|
416 |
id = 'incontext' |
|
417 |
||
418 |
def cell_call(self, row, col): |
|
419 |
entity = self.entity(row, col) |
|
420 |
desc = cut(entity.dc_description(), 50) |
|
421 |
self.w(u'<a href="%s" title="%s">' % (html_escape(entity.absolute_url()), |
|
422 |
html_escape(desc))) |
|
423 |
self.w(html_escape(self.view('textincontext', self.rset, row=row, col=col))) |
|
424 |
self.w(u'</a>') |
|
425 |
||
| 1451 | 426 |
|
| 0 | 427 |
class OutOfContextView(EntityView): |
428 |
id = 'outofcontext' |
|
429 |
||
430 |
def cell_call(self, row, col): |
|
431 |
self.w(u'<a href="%s">' % self.entity(row, col).absolute_url()) |
|
432 |
self.w(html_escape(self.view('textoutofcontext', self.rset, row=row, col=col))) |
|
433 |
self.w(u'</a>') |
|
434 |
||
435 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
436 |
# list views ################################################################## |
| 0 | 437 |
|
438 |
class ListView(EntityView): |
|
439 |
id = 'list' |
|
440 |
title = _('list') |
|
441 |
item_vid = 'listitem' |
|
| 1451 | 442 |
|
| 0 | 443 |
def call(self, klass=None, title=None, subvid=None, listid=None, **kwargs): |
444 |
"""display a list of entities by calling their <item_vid> view |
|
| 1451 | 445 |
|
| 0 | 446 |
:param listid: the DOM id to use for the root element |
447 |
""" |
|
448 |
if subvid is None and 'subvid' in self.req.form: |
|
449 |
subvid = self.req.form.pop('subvid') # consume it |
|
450 |
if listid: |
|
451 |
listid = u' id="%s"' % listid |
|
452 |
else: |
|
453 |
listid = u'' |
|
454 |
if title: |
|
455 |
self.w(u'<div%s class="%s"><h4>%s</h4>\n' % (listid, klass or 'section', title)) |
|
456 |
self.w(u'<ul>\n') |
|
457 |
else: |
|
458 |
self.w(u'<ul%s class="%s">\n' % (listid, klass or 'section')) |
|
459 |
for i in xrange(self.rset.rowcount): |
|
460 |
self.cell_call(row=i, col=0, vid=subvid, **kwargs) |
|
461 |
self.w(u'</ul>\n') |
|
462 |
if title: |
|
463 |
self.w(u'</div>\n') |
|
464 |
||
465 |
def cell_call(self, row, col=0, vid=None, **kwargs): |
|
466 |
self.w(u'<li>') |
|
467 |
self.wview(self.item_vid, self.rset, row=row, col=col, vid=vid, **kwargs) |
|
468 |
self.w(u'</li>\n') |
|
469 |
||
470 |
def url(self): |
|
471 |
"""overrides url method so that by default, the view list is called |
|
472 |
with sorted entities |
|
473 |
""" |
|
474 |
coltypes = self.rset.column_types(0) |
|
475 |
# don't want to generate the rql if there is some restriction on |
|
476 |
# something else than the entity type |
|
477 |
if len(coltypes) == 1: |
|
478 |
# XXX norestriction is not correct here. For instance, in cases like |
|
479 |
# Any P,N WHERE P is Project, P name N |
|
480 |
# norestriction should equal True |
|
481 |
restr = self.rset.syntax_tree().children[0].where |
|
482 |
norestriction = (isinstance(restr, nodes.Relation) and |
|
483 |
restr.is_types_restriction()) |
|
484 |
if norestriction: |
|
485 |
etype = iter(coltypes).next() |
|
486 |
return self.build_url(etype.lower(), vid=self.id) |
|
487 |
if len(self.rset) == 1: |
|
488 |
entity = self.rset.get_entity(0, 0) |
|
489 |
return self.build_url(entity.rest_path(), vid=self.id) |
|
490 |
return self.build_url(rql=self.rset.printable_rql(), vid=self.id) |
|
491 |
||
| 1451 | 492 |
|
| 0 | 493 |
class ListItemView(EntityView): |
494 |
id = 'listitem' |
|
| 1451 | 495 |
|
| 0 | 496 |
@property |
497 |
def redirect_vid(self): |
|
498 |
if self.req.search_state[0] == 'normal': |
|
499 |
return 'outofcontext' |
|
500 |
return 'outofcontext-search' |
|
| 1451 | 501 |
|
| 0 | 502 |
def cell_call(self, row, col, vid=None, **kwargs): |
503 |
if not vid: |
|
504 |
vid = self.redirect_vid |
|
505 |
try: |
|
506 |
self.wview(vid, self.rset, row=row, col=col, **kwargs) |
|
507 |
except NoSelectableObject: |
|
508 |
if vid == self.redirect_vid: |
|
509 |
raise |
|
510 |
self.wview(self.redirect_vid, self.rset, row=row, col=col, **kwargs) |
|
511 |
||
512 |
||
513 |
class SimpleListView(ListItemView): |
|
514 |
"""list without bullets""" |
|
515 |
id = 'simplelist' |
|
516 |
redirect_vid = 'incontext' |
|
517 |
||
518 |
||
519 |
class CSVView(SimpleListView): |
|
520 |
id = 'csv' |
|
521 |
redirect_vid = 'incontext' |
|
| 1451 | 522 |
|
| 0 | 523 |
def call(self, **kwargs): |
524 |
rset = self.rset |
|
525 |
for i in xrange(len(rset)): |
|
526 |
self.cell_call(i, 0, vid=kwargs.get('vid')) |
|
527 |
if i < rset.rowcount-1: |
|
528 |
self.w(u", ") |
|
529 |
||
530 |
||
531 |
class TreeItemView(ListItemView): |
|
532 |
id = 'treeitem' |
|
533 |
||
534 |
def cell_call(self, row, col): |
|
535 |
self.wview('incontext', self.rset, row=row, col=col) |
|
536 |
||
537 |
class TextSearchResultView(EntityView): |
|
538 |
"""this view is used to display full-text search |
|
539 |
||
540 |
It tries to highlight part of data where the search word appears. |
|
541 |
||
542 |
XXX: finish me (fixed line width, fixed number of lines, CSS, etc.) |
|
543 |
""" |
|
544 |
id = 'tsearch' |
|
545 |
||
546 |
def cell_call(self, row, col, **kwargs): |
|
547 |
entity = self.complete_entity(row, col) |
|
548 |
self.w(entity.view('incontext')) |
|
549 |
searched = self.rset.searched_text() |
|
550 |
if searched is None: |
|
551 |
return |
|
552 |
searched = searched.lower() |
|
553 |
highlighted = '<b>%s</b>' % searched |
|
554 |
for attr in entity.e_schema.indexable_attributes(): |
|
555 |
try: |
|
556 |
value = html_escape(entity.printable_value(attr, format='text/plain').lower()) |
|
557 |
except TransformError, ex: |
|
558 |
continue |
|
559 |
except: |
|
560 |
continue |
|
561 |
if searched in value: |
|
562 |
contexts = [] |
|
563 |
for ctx in value.split(searched): |
|
564 |
if len(ctx) > 30: |
|
565 |
contexts.append(u'...' + ctx[-30:]) |
|
566 |
else: |
|
567 |
contexts.append(ctx) |
|
568 |
value = u'\n' + highlighted.join(contexts) |
|
| 1451 | 569 |
self.w(value.replace('\n', '<br/>')) |
| 0 | 570 |
|
571 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
572 |
class TooltipView(EntityView): |
| 0 | 573 |
"""A entity view used in a tooltip""" |
574 |
id = 'tooltip' |
|
575 |
def cell_call(self, row, col): |
|
576 |
self.wview('oneline', self.rset, row=row, col=col) |
|
577 |
||
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
578 |
|
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
579 |
# XXX bw compat |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
580 |
|
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
581 |
from logilab.common.deprecation import class_moved |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
582 |
|
| 0 | 583 |
try: |
584 |
from cubicweb.web.views.tableview import TableView |
|
585 |
TableView = class_moved(TableView) |
|
586 |
except ImportError: |
|
587 |
pass # gae has no tableview module (yet) |
|
|
824
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
588 |
|
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
589 |
from cubicweb.web.views import boxes, xmlrss |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
590 |
SideBoxView = class_moved(boxes.SideBoxView) |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
591 |
XmlView = class_moved(xmlrss.XmlView) |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
592 |
XmlItemView = class_moved(xmlrss.XmlItemView) |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
593 |
XmlRsetView = class_moved(xmlrss.XmlRsetView) |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
594 |
RssView = class_moved(xmlrss.RssView) |
|
a5e6acffde30
merge, split baseviews (new csvexport, xmlrss and editviews modules)
sylvain.thenault@logilab.fr
parents:
795
diff
changeset
|
595 |
RssItemView = class_moved(xmlrss.RssItemView) |
| 1451 | 596 |