| author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
| Tue, 18 Aug 2009 00:23:15 +0200 | |
| changeset 2892 | 7ae3d62a8328 |
| parent 2890 | fdcb8a2bb6eb |
| child 3023 | 7864fee8b4ec |
| permissions | -rw-r--r-- |
| 0 | 1 |
"""abstract views and templates classes for CubicWeb web client |
2 |
||
3 |
||
4 |
:organization: Logilab |
|
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1756
diff
changeset
|
5 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
| 0 | 6 |
: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:
1756
diff
changeset
|
7 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
| 0 | 8 |
""" |
9 |
__docformat__ = "restructuredtext en" |
|
|
1999
b9a8f5995658
obsolete methods
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1985
diff
changeset
|
10 |
_ = unicode |
| 0 | 11 |
|
12 |
from cStringIO import StringIO |
|
13 |
||
|
2613
5e19c2bb370e
R [all] logilab.common 0.44 provides only deprecated
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2558
diff
changeset
|
14 |
from logilab.common.deprecation import deprecated |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2217
diff
changeset
|
15 |
from logilab.mtconverter import xml_escape |
|
2644
100b81ba3a98
F [view] missing import
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2613
diff
changeset
|
16 |
from rql import nodes |
| 0 | 17 |
|
|
1181
620ec8e6ae19
cleanup, various fix to get something working
sylvain.thenault@logilab.fr
parents:
1144
diff
changeset
|
18 |
from cubicweb import NotAnEntity |
| 1132 | 19 |
from cubicweb.selectors import yes, non_final_entity, nonempty_rset, none_rset |
|
2656
a93ae0f6c0ad
R [base classes] only AppObject remaning, no more AppRsetObject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2644
diff
changeset
|
20 |
from cubicweb.appobject import AppObject |
|
708
b4728112625f
move utils from cw.common to cw
sylvain.thenault@logilab.fr
parents:
707
diff
changeset
|
21 |
from cubicweb.utils import UStringIO, HTMLStream |
|
2217
3a8cee8f8778
explicit display_name import
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2207
diff
changeset
|
22 |
from cubicweb.schema import display_name |
| 633 | 23 |
|
| 0 | 24 |
# robots control |
25 |
NOINDEX = u'<meta name="ROBOTS" content="NOINDEX" />' |
|
26 |
NOFOLLOW = u'<meta name="ROBOTS" content="NOFOLLOW" />' |
|
27 |
||
28 |
CW_XHTML_EXTENSIONS = '''[ |
|
29 |
<!ATTLIST html xmlns:cubicweb CDATA #FIXED \'http://www.logilab.org/2008/cubicweb\' > |
|
30 |
||
31 |
<!ENTITY % coreattrs |
|
|
522
385ce5e0b30b
cubicweb__loadurl -> cubicweb:lazyloadurl
sylvain.thenault@logilab.fr
parents:
497
diff
changeset
|
32 |
"id ID #IMPLIED |
|
385ce5e0b30b
cubicweb__loadurl -> cubicweb:lazyloadurl
sylvain.thenault@logilab.fr
parents:
497
diff
changeset
|
33 |
class CDATA #IMPLIED |
|
385ce5e0b30b
cubicweb__loadurl -> cubicweb:lazyloadurl
sylvain.thenault@logilab.fr
parents:
497
diff
changeset
|
34 |
style CDATA #IMPLIED |
| 0 | 35 |
title CDATA #IMPLIED |
36 |
||
37 |
cubicweb:sortvalue CDATA #IMPLIED |
|
38 |
cubicweb:target CDATA #IMPLIED |
|
39 |
cubicweb:limit CDATA #IMPLIED |
|
40 |
cubicweb:type CDATA #IMPLIED |
|
41 |
cubicweb:loadtype CDATA #IMPLIED |
|
42 |
cubicweb:wdgtype CDATA #IMPLIED |
|
43 |
cubicweb:initfunc CDATA #IMPLIED |
|
44 |
cubicweb:inputid CDATA #IMPLIED |
|
45 |
cubicweb:tindex CDATA #IMPLIED |
|
46 |
cubicweb:inputname CDATA #IMPLIED |
|
47 |
cubicweb:value CDATA #IMPLIED |
|
48 |
cubicweb:required CDATA #IMPLIED |
|
49 |
cubicweb:accesskey CDATA #IMPLIED |
|
50 |
cubicweb:maxlength CDATA #IMPLIED |
|
51 |
cubicweb:variables CDATA #IMPLIED |
|
52 |
cubicweb:displayactions CDATA #IMPLIED |
|
53 |
cubicweb:fallbackvid CDATA #IMPLIED |
|
|
1498
2c6eec0b46b9
fix imports, cleanup, repair some ajax calls
sylvain.thenault@logilab.fr
parents:
1433
diff
changeset
|
54 |
cubicweb:fname CDATA #IMPLIED |
| 0 | 55 |
cubicweb:vid CDATA #IMPLIED |
56 |
cubicweb:rql CDATA #IMPLIED |
|
57 |
cubicweb:actualrql CDATA #IMPLIED |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
58 |
cubicweb:rooteid CDATA #IMPLIED |
| 0 | 59 |
cubicweb:dataurl CDATA #IMPLIED |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
60 |
cubicweb:size CDATA #IMPLIED |
| 0 | 61 |
cubicweb:tlunit CDATA #IMPLIED |
62 |
cubicweb:loadurl CDATA #IMPLIED |
|
63 |
cubicweb:uselabel CDATA #IMPLIED |
|
| 472 | 64 |
cubicweb:facetargs CDATA #IMPLIED |
65 |
cubicweb:facetName CDATA #IMPLIED |
|
| 0 | 66 |
"> ] ''' |
67 |
||
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
68 |
TRANSITIONAL_DOCTYPE = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" %s>\n' % CW_XHTML_EXTENSIONS |
|
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
69 |
TRANSITIONAL_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n' |
|
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
70 |
STRICT_DOCTYPE = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" %s>\n' % CW_XHTML_EXTENSIONS |
|
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
71 |
STRICT_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n' |
| 0 | 72 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
73 |
# base view object ############################################################ |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
74 |
|
|
2656
a93ae0f6c0ad
R [base classes] only AppObject remaning, no more AppRsetObject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2644
diff
changeset
|
75 |
class View(AppObject): |
| 0 | 76 |
"""abstract view class, used as base for every renderable object such |
77 |
as views, templates, some components...web |
|
78 |
||
79 |
A view is instantiated to render a [part of a] result set. View |
|
80 |
subclasses may be parametred using the following class attributes: |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
81 |
|
| 0 | 82 |
* `templatable` indicates if the view may be embeded in a main |
83 |
template or if it has to be rendered standalone (i.e. XML for |
|
84 |
instance) |
|
85 |
* if the view is not templatable, it should set the `content_type` class |
|
86 |
attribute to the correct MIME type (text/xhtml by default) |
|
87 |
* the `category` attribute may be used in the interface to regroup related |
|
88 |
objects together |
|
89 |
||
90 |
At instantiation time, the standard `req`, `rset`, and `cursor` |
|
91 |
attributes are added and the `w` attribute will be set at rendering |
|
92 |
time to a write function to use. |
|
93 |
""" |
|
|
816
9cd49a910fce
kill Template class and 'templates' registry
sylvain.thenault@logilab.fr
parents:
781
diff
changeset
|
94 |
__registry__ = 'views' |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
95 |
|
| 0 | 96 |
templatable = True |
97 |
need_navigation = True |
|
98 |
# content_type = 'application/xhtml+xml' # text/xhtml' |
|
99 |
binary = False |
|
100 |
add_to_breadcrumbs = True |
|
101 |
category = 'view' |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
102 |
|
|
1143
8d097defbf2c
change the way selected/__init__ are used for AppRsetObject
sylvain.thenault@logilab.fr
parents:
1132
diff
changeset
|
103 |
def __init__(self, req=None, rset=None, **kwargs): |
|
2822
f26578339214
deprecate appobject.vreg and rename appobject instance attributes using cw_ prefix
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2819
diff
changeset
|
104 |
super(View, self).__init__(req, rset=rset, **kwargs) |
| 0 | 105 |
self.w = None |
106 |
||
107 |
@property |
|
108 |
def content_type(self): |
|
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
109 |
return self.req.html_content_type() |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
110 |
|
| 0 | 111 |
def set_stream(self, w=None): |
112 |
if self.w is not None: |
|
113 |
return |
|
114 |
if w is None: |
|
115 |
if self.binary: |
|
116 |
self._stream = stream = StringIO() |
|
117 |
else: |
|
118 |
self._stream = stream = UStringIO() |
|
119 |
w = stream.write |
|
120 |
else: |
|
121 |
stream = None |
|
122 |
self.w = w |
|
123 |
return stream |
|
124 |
||
125 |
# main view interface ##################################################### |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
126 |
|
| 1723 | 127 |
def render(self, w=None, **context): |
| 0 | 128 |
"""called to render a view object for a result set. |
129 |
||
130 |
This method is a dispatched to an actual method selected |
|
131 |
according to optional row and col parameters, which are locating |
|
132 |
a particular row or cell in the result set: |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
133 |
|
| 1132 | 134 |
* if row is specified, `cell_call` is called |
| 0 | 135 |
* if none of them is supplied, the view is considered to apply on |
136 |
the whole result set (which may be None in this case), `call` is |
|
137 |
called |
|
138 |
""" |
|
| 1132 | 139 |
row = context.get('row') |
| 0 | 140 |
if row is not None: |
141 |
context.setdefault('col', 0) |
|
142 |
view_func = self.cell_call |
|
143 |
else: |
|
144 |
view_func = self.call |
|
145 |
stream = self.set_stream(w) |
|
146 |
# stream = self.set_stream(context) |
|
147 |
view_func(**context) |
|
148 |
# return stream content if we have created it |
|
149 |
if stream is not None: |
|
150 |
return self._stream.getvalue() |
|
151 |
||
|
2795
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
152 |
def tal_render(self, template, variables): |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
153 |
"""render a precompiled page template with variables in the given |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
154 |
dictionary as context |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
155 |
""" |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
156 |
from cubicweb.ext.tal import CubicWebContext |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
157 |
context = CubicWebContext() |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
158 |
context.update({'self': self, 'rset': self.rset, '_' : self.req._, |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
159 |
'req': self.req, 'user': self.req.user}) |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
160 |
context.update(variables) |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
161 |
output = UStringIO() |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
162 |
template.expand(context, output) |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
163 |
return output.getvalue() |
|
59965167bef3
move tal_render to View
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2788
diff
changeset
|
164 |
|
|
2788
8d3dbe577d3a
R put version info in deprecation warnings
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2656
diff
changeset
|
165 |
dispatch = deprecated('[3.4] .dispatch is deprecated, use .render')(render) |
| 1723 | 166 |
|
| 0 | 167 |
# should default .call() method add a <div classs="section"> around each |
168 |
# rset item |
|
169 |
add_div_section = True |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
170 |
|
| 0 | 171 |
def call(self, **kwargs): |
172 |
"""the view is called for an entire result set, by default loop |
|
173 |
other rows of the result set and call the same view on the |
|
174 |
particular row |
|
175 |
||
176 |
Views applicable on None result sets have to override this method |
|
177 |
""" |
|
178 |
rset = self.rset |
|
179 |
if rset is None: |
|
180 |
raise NotImplementedError, self |
|
181 |
wrap = self.templatable and len(rset) > 1 and self.add_div_section |
|
182 |
for i in xrange(len(rset)): |
|
183 |
if wrap: |
|
184 |
self.w(u'<div class="section">') |
|
185 |
self.wview(self.id, rset, row=i, **kwargs) |
|
186 |
if wrap: |
|
187 |
self.w(u"</div>") |
|
188 |
||
189 |
def cell_call(self, row, col, **kwargs): |
|
190 |
"""the view is called for a particular result set cell""" |
|
191 |
raise NotImplementedError, self |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
192 |
|
| 0 | 193 |
def linkable(self): |
194 |
"""return True if the view may be linked in a menu |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
195 |
|
| 0 | 196 |
by default views without title are not meant to be displayed |
197 |
""" |
|
198 |
if not getattr(self, 'title', None): |
|
199 |
return False |
|
200 |
return True |
|
201 |
||
202 |
def is_primary(self): |
|
203 |
return self.id == 'primary' |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
204 |
|
| 0 | 205 |
def url(self): |
206 |
"""return the url associated with this view. Should not be |
|
207 |
necessary for non linkable views, but a default implementation |
|
208 |
is provided anyway. |
|
209 |
""" |
|
|
2468
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
210 |
rset = self.rset |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
211 |
if rset is None: |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
212 |
return self.build_url('view', vid=self.id) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
213 |
coltypes = rset.column_types(0) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
214 |
if len(coltypes) == 1: |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
215 |
etype = iter(coltypes).next() |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
216 |
if not self.schema.eschema(etype).is_final(): |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
217 |
if len(rset) == 1: |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
218 |
entity = rset.get_entity(0, 0) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
219 |
return entity.absolute_url(vid=self.id) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
220 |
# don't want to generate /<etype> url if there is some restriction |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
221 |
# on something else than the entity type |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
222 |
restr = rset.syntax_tree().children[0].where |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
223 |
# XXX norestriction is not correct here. For instance, in cases like |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
224 |
# "Any P,N WHERE P is Project, P name N" norestriction should equal |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
225 |
# True |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
226 |
norestriction = (isinstance(restr, nodes.Relation) and |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
227 |
restr.is_types_restriction()) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
228 |
if norestriction: |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
229 |
return self.build_url(etype.lower(), vid=self.id) |
|
93853b6f3bad
move all view.url() logic in a single implementation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2418
diff
changeset
|
230 |
return self.build_url('view', rql=rset.printable_rql(), vid=self.id) |
| 0 | 231 |
|
232 |
def set_request_content_type(self): |
|
233 |
"""set the content type returned by this view""" |
|
234 |
self.req.set_content_type(self.content_type) |
|
235 |
||
236 |
# view utilities ########################################################## |
|
| 1433 | 237 |
|
|
1985
9c1db4e06095
move view method's logic on the registry, so it's easier to call it from outside an appobject. Also make rset argument optional
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
238 |
def wview(self, __vid, rset=None, __fallback_vid=None, **kwargs): |
| 0 | 239 |
"""shortcut to self.view method automatically passing self.w as argument |
240 |
""" |
|
241 |
self.view(__vid, rset, __fallback_vid, w=self.w, **kwargs) |
|
| 1433 | 242 |
|
| 819 | 243 |
# XXX Template bw compat |
|
2788
8d3dbe577d3a
R put version info in deprecation warnings
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
2656
diff
changeset
|
244 |
template = deprecated('[3.4] .template is deprecated, use .view')(wview) |
| 0 | 245 |
|
246 |
def whead(self, data): |
|
247 |
self.req.html_headers.write(data) |
|
248 |
||
249 |
def wdata(self, data): |
|
250 |
"""simple helper that escapes `data` and writes into `self.w`""" |
|
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2217
diff
changeset
|
251 |
self.w(xml_escape(data)) |
| 0 | 252 |
|
253 |
def html_headers(self): |
|
254 |
"""return a list of html headers (eg something to be inserted between |
|
255 |
<head> and </head> of the returned page |
|
256 |
||
257 |
by default return a meta tag to disable robot indexation of the page |
|
258 |
""" |
|
259 |
return [NOINDEX] |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
260 |
|
| 0 | 261 |
def page_title(self): |
262 |
"""returns a title according to the result set - used for the |
|
263 |
title in the HTML header |
|
264 |
""" |
|
265 |
vtitle = self.req.form.get('vtitle') |
|
266 |
if vtitle: |
|
267 |
return self.req._(vtitle) |
|
268 |
# class defined title will only be used if the resulting title doesn't |
|
269 |
# seem clear enough |
|
270 |
vtitle = getattr(self, 'title', None) or u'' |
|
271 |
if vtitle: |
|
272 |
vtitle = self.req._(vtitle) |
|
273 |
rset = self.rset |
|
274 |
if rset and rset.rowcount: |
|
275 |
if rset.rowcount == 1: |
|
276 |
try: |
|
277 |
entity = self.complete_entity(0) |
|
278 |
# use long_title to get context information if any |
|
279 |
clabel = entity.dc_long_title() |
|
280 |
except NotAnEntity: |
|
281 |
clabel = display_name(self.req, rset.description[0][0]) |
|
282 |
clabel = u'%s (%s)' % (clabel, vtitle) |
|
283 |
else : |
|
284 |
etypes = rset.column_types(0) |
|
285 |
if len(etypes) == 1: |
|
286 |
etype = iter(etypes).next() |
|
287 |
clabel = display_name(self.req, etype, 'plural') |
|
288 |
else : |
|
289 |
clabel = u'#[*] (%s)' % vtitle |
|
290 |
else: |
|
291 |
clabel = vtitle |
|
292 |
return u'%s (%s)' % (clabel, self.req.property_value('ui.site-title')) |
|
293 |
||
294 |
def output_url_builder( self, name, url, args ): |
|
295 |
self.w(u'<script language="JavaScript"><!--\n' \ |
|
296 |
u'function %s( %s ) {\n' % (name, ','.join(args) ) ) |
|
297 |
url_parts = url.split("%s") |
|
298 |
self.w(u' url="%s"' % url_parts[0] ) |
|
299 |
for arg, part in zip(args, url_parts[1:]): |
|
300 |
self.w(u'+str(%s)' % arg ) |
|
301 |
if part: |
|
302 |
self.w(u'+"%s"' % part) |
|
303 |
self.w('\n document.window.href=url;\n') |
|
304 |
self.w('}\n-->\n</script>\n') |
|
305 |
||
306 |
def create_url(self, etype, **kwargs): |
|
307 |
""" return the url of the entity creation form for a given entity type""" |
|
308 |
return self.req.build_url('add/%s'%etype, **kwargs) |
|
309 |
||
310 |
def field(self, label, value, row=True, show_label=True, w=None, tr=True): |
|
311 |
""" read-only field """ |
|
312 |
if w is None: |
|
313 |
w = self.w |
|
314 |
if row: |
|
315 |
w(u'<div class="row">') |
|
316 |
if show_label: |
|
317 |
if tr: |
|
318 |
label = display_name(self.req, label) |
|
319 |
w(u'<span class="label">%s</span>' % label) |
|
320 |
w(u'<div class="field">%s</div>' % value) |
|
321 |
if row: |
|
322 |
w(u'</div>') |
|
| 1433 | 323 |
|
| 0 | 324 |
|
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
325 |
|
|
640
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
326 |
# concrete views base classes ################################################# |
|
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
327 |
|
|
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
328 |
class EntityView(View): |
| 843 | 329 |
"""base class for views applying on an entity (i.e. uniform result set)""" |
|
781
323656dd85a9
fix import, use non_final_entity instead of implements('Any')
sylvain.thenault@logilab.fr
parents:
757
diff
changeset
|
330 |
__select__ = non_final_entity() |
|
640
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
331 |
category = 'entityview' |
|
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
332 |
|
|
8e64f12be69c
drop EntityAction usage in cw, upgrade rql_condition and friends
sylvain.thenault@logilab.fr
parents:
635
diff
changeset
|
333 |
|
| 0 | 334 |
class StartupView(View): |
| 843 | 335 |
"""base class for views which doesn't need a particular result set to be |
336 |
displayed (so they can always be displayed !) |
|
| 0 | 337 |
""" |
| 707 | 338 |
__select__ = none_rset() |
| 1433 | 339 |
|
| 0 | 340 |
category = 'startupview' |
| 1433 | 341 |
|
| 0 | 342 |
def html_headers(self): |
343 |
"""return a list of html headers (eg something to be inserted between |
|
344 |
<head> and </head> of the returned page |
|
345 |
||
346 |
by default startup views are indexed |
|
347 |
""" |
|
348 |
return [] |
|
349 |
||
350 |
||
351 |
class EntityStartupView(EntityView): |
|
352 |
"""base class for entity views which may also be applied to None |
|
353 |
result set (usually a default rql is provided by the view class) |
|
354 |
""" |
|
|
781
323656dd85a9
fix import, use non_final_entity instead of implements('Any')
sylvain.thenault@logilab.fr
parents:
757
diff
changeset
|
355 |
__select__ = none_rset() | non_final_entity() |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
356 |
|
| 0 | 357 |
default_rql = None |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
358 |
|
|
2418
8f06e4f02733
optional rset
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2312
diff
changeset
|
359 |
def __init__(self, req, rset=None, **kwargs): |
|
2890
fdcb8a2bb6eb
fix __init__ parameters
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2822
diff
changeset
|
360 |
super(EntityStartupView, self).__init__(req, rset=rset, **kwargs) |
| 0 | 361 |
if rset is None: |
362 |
# this instance is not in the "entityview" category |
|
363 |
self.category = 'startupview' |
|
364 |
||
365 |
def startup_rql(self): |
|
| 873 | 366 |
"""return some rql to be executed if the result set is None""" |
| 0 | 367 |
return self.default_rql |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
368 |
|
| 0 | 369 |
def call(self, **kwargs): |
| 873 | 370 |
"""override call to execute rql returned by the .startup_rql method if |
371 |
necessary |
|
| 0 | 372 |
""" |
373 |
if self.rset is None: |
|
374 |
self.rset = self.req.execute(self.startup_rql()) |
|
375 |
rset = self.rset |
|
376 |
for i in xrange(len(rset)): |
|
377 |
self.wview(self.id, rset, row=i, **kwargs) |
|
378 |
||
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
379 |
|
| 0 | 380 |
class AnyRsetView(View): |
381 |
"""base class for views applying on any non empty result sets""" |
|
| 707 | 382 |
__select__ = nonempty_rset() |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
383 |
|
| 0 | 384 |
category = 'anyrsetview' |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
385 |
|
|
2203
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
386 |
def columns_labels(self, mainindex=0, tr=True): |
|
370
7e76f651314b
fix rset xml view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
369
diff
changeset
|
387 |
if tr: |
|
2207
5fad58e603f4
fix translate argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2203
diff
changeset
|
388 |
translate = lambda val, req=self.req: display_name(req, val) |
|
370
7e76f651314b
fix rset xml view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
369
diff
changeset
|
389 |
else: |
|
2207
5fad58e603f4
fix translate argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2203
diff
changeset
|
390 |
translate = lambda val: val |
|
2203
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
391 |
# XXX [0] because of missing Union support |
|
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
392 |
rqlstdescr = self.rset.syntax_tree().get_description(mainindex, |
|
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
393 |
translate)[0] |
|
369
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
361
diff
changeset
|
394 |
labels = [] |
|
2203
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
395 |
for colindex, label in enumerate(rqlstdescr): |
|
369
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
361
diff
changeset
|
396 |
# compute column header |
|
2203
efdd3a9f9028
update to new rql get_description api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1999
diff
changeset
|
397 |
if label == 'Any': # find a better label |
|
2207
5fad58e603f4
fix translate argument
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2203
diff
changeset
|
398 |
label = ','.join(translate(et) |
|
369
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
361
diff
changeset
|
399 |
for et in self.rset.column_types(colindex)) |
|
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
361
diff
changeset
|
400 |
labels.append(label) |
|
c8a6edc224bb
new rsetxml view, reusing most code from csvexport view
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
361
diff
changeset
|
401 |
return labels |
|
543
c0f2b6378f70
simplification of lazy tabs mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
522
diff
changeset
|
402 |
|
| 1433 | 403 |
|
| 0 | 404 |
# concrete template base classes ############################################## |
405 |
||
|
816
9cd49a910fce
kill Template class and 'templates' registry
sylvain.thenault@logilab.fr
parents:
781
diff
changeset
|
406 |
class MainTemplate(View): |
| 0 | 407 |
"""main template are primary access point to render a full HTML page. |
408 |
There is usually at least a regular main template and a simple fallback |
|
409 |
one to display error if the first one failed |
|
410 |
""" |
|
411 |
||
412 |
@property |
|
413 |
def doctype(self): |
|
|
2558
81c8b5312f9c
move test on force-html-content-type to xhtml_browser method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2555
diff
changeset
|
414 |
if self.req.xhtml_browser(): |
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
415 |
return STRICT_DOCTYPE |
|
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1181
diff
changeset
|
416 |
return STRICT_DOCTYPE_NOEXT |
| 0 | 417 |
|
| 1424 | 418 |
def set_stream(self, w=None): |
419 |
if self.w is not None: |
|
| 0 | 420 |
return |
421 |
if w is None: |
|
422 |
if self.binary: |
|
423 |
self._stream = stream = StringIO() |
|
424 |
else: |
|
425 |
self._stream = stream = HTMLStream(self.req) |
|
426 |
w = stream.write |
|
427 |
else: |
|
428 |
stream = None |
|
429 |
self.w = w |
|
430 |
return stream |
|
431 |
||
432 |
def write_doctype(self, xmldecl=True): |
|
433 |
assert isinstance(self._stream, HTMLStream) |
|
434 |
self._stream.doctype = self.doctype |
|
435 |
if not xmldecl: |
|
436 |
self._stream.xmldecl = u'' |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
437 |
|
| 822 | 438 |
def linkable(self): |
439 |
return False |
|
| 1433 | 440 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
441 |
# concrete component base classes ############################################# |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
442 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
443 |
class ReloadableMixIn(object): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
444 |
"""simple mixin for reloadable parts of UI""" |
| 1433 | 445 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
446 |
def user_callback(self, cb, args, msg=None, nonify=False): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
447 |
"""register the given user callback and return an url to call it ready to be |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
448 |
inserted in html |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
449 |
""" |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
450 |
self.req.add_js('cubicweb.ajax.js') |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
451 |
if nonify: |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
452 |
_cb = cb |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
453 |
def cb(*args): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
454 |
_cb(*args) |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
455 |
cbname = self.req.register_onetime_callback(cb, *args) |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2217
diff
changeset
|
456 |
return self.build_js(cbname, xml_escape(msg or '')) |
| 1433 | 457 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
458 |
def build_update_js_call(self, cbname, msg): |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2217
diff
changeset
|
459 |
rql = xml_escape(self.rset.printable_rql()) |
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
460 |
return "javascript:userCallbackThenUpdateUI('%s', '%s', '%s', '%s', '%s', '%s')" % ( |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
461 |
cbname, self.id, rql, msg, self.__registry__, self.div_id()) |
| 1433 | 462 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
463 |
def build_reload_js_call(self, cbname, msg): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
464 |
return "javascript:userCallbackThenReloadPage('%s', '%s')" % (cbname, msg) |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
465 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
466 |
build_js = build_update_js_call # expect updatable component by default |
| 1433 | 467 |
|
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
468 |
def div_id(self): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
469 |
return '' |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
470 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
471 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
472 |
class Component(ReloadableMixIn, View): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
473 |
"""base class for components""" |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
474 |
__registry__ = 'components' |
| 707 | 475 |
__select__ = yes() |
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
476 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
477 |
def div_class(self): |
|
2818
326375561412
propagate some api changes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2799
diff
changeset
|
478 |
return '%s %s' % (self.cw_propval('htmlclass'), self.id) |
|
661
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
479 |
|
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
480 |
def div_id(self): |
|
4f61eb8a96b7
properly kill/depreciate component base class, only keep Component
sylvain.thenault@logilab.fr
parents:
660
diff
changeset
|
481 |
return '%sComponent' % self.id |