author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
Fri, 19 Mar 2010 14:43:49 +0100 | |
changeset 4960 | 26b2468a1e73 |
parent 4903 | 627fcd90e08f |
child 4961 | 03e083faefbf |
permissions | -rw-r--r-- |
4511 | 1 |
"""Some utilities for CubicWeb server/clients. |
0 | 2 |
|
3 |
:organization: Logilab |
|
4212
ab6573088b4a
update copyright: welcome 2010
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4000
diff
changeset
|
4 |
:copyright: 2001-2010 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:
1751
diff
changeset
|
6 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
0 | 7 |
""" |
8 |
__docformat__ = "restructuredtext en" |
|
9 |
||
3316 | 10 |
import sys |
11 |
import decimal |
|
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
12 |
import datetime |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
13 |
import random |
4833
41a78fb4107c
3.7 depends on python >= 2.5
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4693
diff
changeset
|
14 |
from uuid import uuid4 |
4830
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
15 |
from warnings import warn |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
16 |
|
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
17 |
from logilab.mtconverter import xml_escape |
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
18 |
from logilab.common.deprecation import deprecated |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
19 |
|
4830
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
20 |
_MARKER = object() |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
21 |
|
1024
bb96289257bf
remove unused working_hours function, new todate function since we can't compare date and datetime objects
sylvain.thenault@logilab.fr
parents:
1016
diff
changeset
|
22 |
# initialize random seed from current time |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
23 |
random.seed() |
1024
bb96289257bf
remove unused working_hours function, new todate function since we can't compare date and datetime objects
sylvain.thenault@logilab.fr
parents:
1016
diff
changeset
|
24 |
|
4880
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
25 |
def make_uid(key=None): |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
26 |
"""Return a unique identifier string. |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
27 |
|
4880
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
28 |
if specified, `key` is used to prefix the generated uid so it can be used |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
29 |
for instance as a DOM id or as sql table names. |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
30 |
|
4880
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
31 |
See uuid.uuid4 documentation for the shape of the generated identifier, but |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
32 |
this is basicallly a 32 bits hexadecimal string. |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
33 |
""" |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
34 |
if key is None: |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
35 |
return uuid4().hex |
fa6671e83639
[utils] make_uid imrovment: using .hex already remove '-', make key argument optional, document it
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4879
diff
changeset
|
36 |
return str(key) + uuid4().hex |
3364
039d1694f36d
fix uid generation for py >= 2.5
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3316
diff
changeset
|
37 |
|
0 | 38 |
|
39 |
def dump_class(cls, clsname): |
|
40 |
"""create copy of a class by creating an empty class inheriting |
|
41 |
from the given cls. |
|
42 |
||
43 |
Those class will be used as place holder for attribute and relation |
|
44 |
description |
|
45 |
""" |
|
46 |
# type doesn't accept unicode name |
|
47 |
# return type.__new__(type, str(clsname), (cls,), {}) |
|
48 |
# __autogenerated__ attribute is just a marker |
|
4881
39fc30001a20
[utils] improve dump_class by copying back original class doc and module name
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4880
diff
changeset
|
49 |
return type(str(clsname), (cls,), {'__autogenerated__': True, |
39fc30001a20
[utils] improve dump_class by copying back original class doc and module name
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4880
diff
changeset
|
50 |
'__doc__': cls.__doc__, |
39fc30001a20
[utils] improve dump_class by copying back original class doc and module name
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4880
diff
changeset
|
51 |
'__module__': cls.__module__}) |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
52 |
|
0 | 53 |
|
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
54 |
# use networkX instead ? |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
55 |
# http://networkx.lanl.gov/reference/algorithms.traversal.html#module-networkx.algorithms.traversal.astar |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
56 |
def transitive_closure_of(entity, relname, _seen=None): |
4317
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
57 |
"""return transitive closure *for the subgraph starting from the given |
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
58 |
entity* (eg 'parent' entities are not included in the results) |
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
59 |
""" |
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
60 |
if _seen is None: |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
61 |
_seen = set() |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
62 |
_seen.add(entity.eid) |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
63 |
yield entity |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
64 |
for child in getattr(entity, relname): |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
65 |
if child.eid in _seen: |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
66 |
continue |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
67 |
for subchild in transitive_closure_of(child, relname, _seen): |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
68 |
yield subchild |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
69 |
|
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
70 |
|
0 | 71 |
class SizeConstrainedList(list): |
72 |
"""simple list that makes sure the list does not get bigger |
|
73 |
than a given size. |
|
74 |
||
75 |
when the list is full and a new element is added, the first |
|
76 |
element of the list is removed before appending the new one |
|
77 |
||
78 |
>>> l = SizeConstrainedList(2) |
|
79 |
>>> l.append(1) |
|
80 |
>>> l.append(2) |
|
81 |
>>> l |
|
82 |
[1, 2] |
|
83 |
>>> l.append(3) |
|
84 |
[2, 3] |
|
85 |
""" |
|
86 |
def __init__(self, maxsize): |
|
87 |
self.maxsize = maxsize |
|
88 |
||
89 |
def append(self, element): |
|
90 |
if len(self) == self.maxsize: |
|
91 |
del self[0] |
|
92 |
super(SizeConstrainedList, self).append(element) |
|
93 |
||
94 |
def extend(self, sequence): |
|
95 |
super(SizeConstrainedList, self).extend(sequence) |
|
96 |
keepafter = len(self) - self.maxsize |
|
97 |
if keepafter > 0: |
|
98 |
del self[:keepafter] |
|
99 |
||
100 |
__iadd__ = extend |
|
101 |
||
102 |
||
103 |
class UStringIO(list): |
|
104 |
"""a file wrapper which automatically encode unicode string to an encoding |
|
105 |
specifed in the constructor |
|
106 |
""" |
|
107 |
||
108 |
def __nonzero__(self): |
|
109 |
return True |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
110 |
|
0 | 111 |
def write(self, value): |
112 |
assert isinstance(value, unicode), u"unicode required not %s : %s"\ |
|
113 |
% (type(value).__name__, repr(value)) |
|
114 |
self.append(value) |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
115 |
|
0 | 116 |
def getvalue(self): |
117 |
return u''.join(self) |
|
118 |
||
119 |
def __repr__(self): |
|
120 |
return '<%s at %#x>' % (self.__class__.__name__, id(self)) |
|
121 |
||
122 |
||
123 |
class HTMLHead(UStringIO): |
|
124 |
"""wraps HTML header's stream |
|
125 |
||
126 |
Request objects use a HTMLHead instance to ease adding of |
|
127 |
javascripts and stylesheets |
|
128 |
""" |
|
129 |
js_unload_code = u'jQuery(window).unload(unloadPageData);' |
|
130 |
||
131 |
def __init__(self): |
|
132 |
super(HTMLHead, self).__init__() |
|
133 |
self.jsvars = [] |
|
134 |
self.jsfiles = [] |
|
135 |
self.cssfiles = [] |
|
136 |
self.ie_cssfiles = [] |
|
137 |
self.post_inlined_scripts = [] |
|
138 |
self.pagedata_unload = False |
|
139 |
||
140 |
||
141 |
def add_raw(self, rawheader): |
|
142 |
self.write(rawheader) |
|
143 |
||
3838
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
144 |
def define_var(self, var, value, override=True): |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
145 |
"""adds a javascript var declaration / assginment in the header |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
146 |
|
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
147 |
:param var: the variable name |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
148 |
:param value: the variable value (as a raw python value, |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
149 |
it will be jsonized later) |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
150 |
:param override: if False, don't set the variable value if the variable |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
151 |
is already defined. Default is True. |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
152 |
""" |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
153 |
self.jsvars.append( (var, value, override) ) |
0 | 154 |
|
155 |
def add_post_inline_script(self, content): |
|
156 |
self.post_inlined_scripts.append(content) |
|
28
9b7067bfaa15
introduce html_headers.on_load() method as a shortcut for add_post_inline_script('''jQuery(document).ready(...''')
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
0
diff
changeset
|
157 |
|
4830
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
158 |
def add_onload(self, jscode, jsoncall=_MARKER): |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
159 |
if jsoncall is not _MARKER: |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
160 |
warn('[3.7] specifying jsoncall is not needed anymore', |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
161 |
DeprecationWarning, stacklevel=2) |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
162 |
self.add_post_inline_script(u"""jQuery(CubicWeb).one('server-response', function(event) { |
4903
627fcd90e08f
fix bad conflict resolution
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4899
diff
changeset
|
163 |
%s});""" % jscode) |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
164 |
|
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
165 |
|
0 | 166 |
def add_js(self, jsfile): |
167 |
"""adds `jsfile` to the list of javascripts used in the webpage |
|
168 |
||
169 |
This function checks if the file has already been added |
|
170 |
:param jsfile: the script's URL |
|
171 |
""" |
|
172 |
if jsfile not in self.jsfiles: |
|
173 |
self.jsfiles.append(jsfile) |
|
174 |
||
175 |
def add_css(self, cssfile, media): |
|
176 |
"""adds `cssfile` to the list of javascripts used in the webpage |
|
177 |
||
178 |
This function checks if the file has already been added |
|
179 |
:param cssfile: the stylesheet's URL |
|
180 |
""" |
|
181 |
if (cssfile, media) not in self.cssfiles: |
|
182 |
self.cssfiles.append( (cssfile, media) ) |
|
183 |
||
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
184 |
def add_ie_css(self, cssfile, media='all', iespec=u'[if lt IE 8]'): |
0 | 185 |
"""registers some IE specific CSS""" |
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
186 |
if (cssfile, media, iespec) not in self.ie_cssfiles: |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
187 |
self.ie_cssfiles.append( (cssfile, media, iespec) ) |
0 | 188 |
|
189 |
def add_unload_pagedata(self): |
|
190 |
"""registers onunload callback to clean page data on server""" |
|
191 |
if not self.pagedata_unload: |
|
192 |
self.post_inlined_scripts.append(self.js_unload_code) |
|
193 |
self.pagedata_unload = True |
|
194 |
||
643
616191014b8b
[jsoncontroller] reorganize _html_exec (used by replacePageChunk) to output required css and js scripts
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
28
diff
changeset
|
195 |
def getvalue(self, skiphead=False): |
0 | 196 |
"""reimplement getvalue to provide a consistent (and somewhat browser |
197 |
optimzed cf. http://stevesouders.com/cuzillion) order in external |
|
198 |
resources declaration |
|
199 |
""" |
|
200 |
w = self.write |
|
201 |
# 1/ variable declaration if any |
|
202 |
if self.jsvars: |
|
2554
3b6a6d2f9d7e
make jsvars declaration xhtml and html compatible
Fabrice <fabrice@secondweb.fr>
parents:
2361
diff
changeset
|
203 |
w(u'<script type="text/javascript"><!--//--><![CDATA[//><!--\n') |
3838
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
204 |
for var, value, override in self.jsvars: |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
205 |
vardecl = u'%s = %s;' % (var, dumps(value)) |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
206 |
if not override: |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
207 |
vardecl = (u'if (typeof %s == "undefined") {%s}' % |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
208 |
(var, vardecl)) |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
209 |
w(vardecl + u'\n') |
2554
3b6a6d2f9d7e
make jsvars declaration xhtml and html compatible
Fabrice <fabrice@secondweb.fr>
parents:
2361
diff
changeset
|
210 |
w(u'//--><!]]></script>\n') |
0 | 211 |
# 2/ css files |
212 |
for cssfile, media in self.cssfiles: |
|
213 |
w(u'<link rel="stylesheet" type="text/css" media="%s" href="%s"/>\n' % |
|
3091
c3d73cecb29e
[html-head] escape js and css urls
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2678
diff
changeset
|
214 |
(media, xml_escape(cssfile))) |
0 | 215 |
# 3/ ie css if necessary |
216 |
if self.ie_cssfiles: |
|
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
217 |
for cssfile, media, iespec in self.ie_cssfiles: |
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
218 |
w(u'<!--%s>\n' % iespec) |
0 | 219 |
w(u'<link rel="stylesheet" type="text/css" media="%s" href="%s"/>\n' % |
3091
c3d73cecb29e
[html-head] escape js and css urls
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2678
diff
changeset
|
220 |
(media, xml_escape(cssfile))) |
0 | 221 |
w(u'<![endif]--> \n') |
222 |
# 4/ js files |
|
223 |
for jsfile in self.jsfiles: |
|
3091
c3d73cecb29e
[html-head] escape js and css urls
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2678
diff
changeset
|
224 |
w(u'<script type="text/javascript" src="%s"></script>\n' % |
c3d73cecb29e
[html-head] escape js and css urls
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2678
diff
changeset
|
225 |
xml_escape(jsfile)) |
0 | 226 |
# 5/ post inlined scripts (i.e. scripts depending on other JS files) |
227 |
if self.post_inlined_scripts: |
|
228 |
w(u'<script type="text/javascript">\n') |
|
229 |
w(u'\n\n'.join(self.post_inlined_scripts)) |
|
230 |
w(u'\n</script>\n') |
|
643
616191014b8b
[jsoncontroller] reorganize _html_exec (used by replacePageChunk) to output required css and js scripts
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
28
diff
changeset
|
231 |
header = super(HTMLHead, self).getvalue() |
616191014b8b
[jsoncontroller] reorganize _html_exec (used by replacePageChunk) to output required css and js scripts
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
28
diff
changeset
|
232 |
if skiphead: |
616191014b8b
[jsoncontroller] reorganize _html_exec (used by replacePageChunk) to output required css and js scripts
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
28
diff
changeset
|
233 |
return header |
616191014b8b
[jsoncontroller] reorganize _html_exec (used by replacePageChunk) to output required css and js scripts
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
28
diff
changeset
|
234 |
return u'<head>\n%s</head>\n' % header |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
235 |
|
0 | 236 |
|
237 |
class HTMLStream(object): |
|
238 |
"""represents a HTML page. |
|
239 |
||
240 |
This is used my main templates so that HTML headers can be added |
|
241 |
at any time during the page generation. |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
242 |
|
0 | 243 |
HTMLStream uses the (U)StringIO interface to be compliant with |
244 |
existing code. |
|
245 |
""" |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
246 |
|
0 | 247 |
def __init__(self, req): |
248 |
# stream for <head> |
|
249 |
self.head = req.html_headers |
|
250 |
# main stream |
|
251 |
self.body = UStringIO() |
|
252 |
self.doctype = u'' |
|
253 |
# xmldecl and html opening tag |
|
254 |
self.xmldecl = u'<?xml version="1.0" encoding="%s"?>\n' % req.encoding |
|
255 |
self.htmltag = u'<html xmlns="http://www.w3.org/1999/xhtml" ' \ |
|
256 |
'xmlns:cubicweb="http://www.logilab.org/2008/cubicweb" ' \ |
|
257 |
'xml:lang="%s" lang="%s">' % (req.lang, req.lang) |
|
3094
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3091
diff
changeset
|
258 |
# keep main_stream's reference on req for easier text/html demoting |
978ed8c2c0e4
[googlemap] #344872 set request content-type to text/html
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3091
diff
changeset
|
259 |
req.main_stream = self |
0 | 260 |
|
261 |
def write(self, data): |
|
262 |
"""StringIO interface: this method will be assigned to self.w |
|
263 |
""" |
|
264 |
self.body.write(data) |
|
265 |
||
266 |
def getvalue(self): |
|
267 |
"""writes HTML headers, closes </head> tag and writes HTML body""" |
|
268 |
return u'%s\n%s\n%s\n%s\n%s\n</html>' % (self.xmldecl, self.doctype, |
|
269 |
self.htmltag, |
|
270 |
self.head.getvalue(), |
|
271 |
self.body.getvalue()) |
|
272 |
||
273 |
||
2935
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
274 |
def can_do_pdf_conversion(__answer=[None]): |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
275 |
"""pdf conversion depends on |
3789
fb22b55f80f8
update docstring, xml escape exception description
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
3372
diff
changeset
|
276 |
* pysixt (python package) |
2935
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
277 |
* fop 0.9x |
0 | 278 |
""" |
2935
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
279 |
if __answer[0] is not None: |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
280 |
return __answer[0] |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
281 |
try: |
2936
f35b64718d02
follow name change, fix pdf template registration, add debian package tracking
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2935
diff
changeset
|
282 |
import pysixt |
2935
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
283 |
except ImportError: |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
284 |
__answer[0] = False |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
285 |
return False |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
286 |
from subprocess import Popen, STDOUT |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
287 |
import os |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
288 |
try: |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
289 |
Popen(['/usr/bin/fop', '-q'], |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
290 |
stdout=open(os.devnull, 'w'), |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
291 |
stderr=STDOUT) |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
292 |
except OSError, e: |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
293 |
print e |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
294 |
__answer[0] = False |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
295 |
return False |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
296 |
__answer[0] = True |
e06b3eadef31
[views,pdf] minimal support for xhtml->pdf conversion
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2932
diff
changeset
|
297 |
return True |
3231
3ee43e2f8560
[utils] provide a class to extend the default simplejson encoder to be able to dump standard yams attribute types
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3101
diff
changeset
|
298 |
|
4879
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
299 |
|
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
300 |
try: |
3372 | 301 |
# may not be there if cubicweb-web not installed |
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
302 |
from simplejson import dumps, JSONEncoder |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
303 |
except ImportError: |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
304 |
pass |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
305 |
else: |
3231
3ee43e2f8560
[utils] provide a class to extend the default simplejson encoder to be able to dump standard yams attribute types
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3101
diff
changeset
|
306 |
|
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
307 |
class CubicWebJsonEncoder(JSONEncoder): |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
308 |
"""define a simplejson encoder to be able to encode yams std types""" |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
309 |
def default(self, obj): |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
310 |
if isinstance(obj, datetime.datetime): |
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
311 |
return obj.strftime('%Y/%m/%d %H:%M:%S') |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
312 |
elif isinstance(obj, datetime.date): |
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
313 |
return obj.strftime('%Y/%m/%d') |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
314 |
elif isinstance(obj, datetime.time): |
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
315 |
return obj.strftime('%H:%M:%S') |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
316 |
elif isinstance(obj, datetime.timedelta): |
4000
4b16a7c01a25
fix jsonization of interval
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3902
diff
changeset
|
317 |
return (obj.days * 24 * 60 * 60) + obj.seconds |
3371
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
318 |
elif isinstance(obj, decimal.Decimal): |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
319 |
return float(obj) |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
320 |
try: |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
321 |
return JSONEncoder.default(self, obj) |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
322 |
except TypeError: |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
323 |
# we never ever want to fail because of an unknown type, |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
324 |
# just return None in those cases. |
762a7bc3b73d
this has probably be killed by a bad merge...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3364
diff
changeset
|
325 |
return None |
4652
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
326 |
|
4879
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
327 |
|
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
328 |
@deprecated('[3.7] merge_dicts is deprecated') |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
329 |
def merge_dicts(dict1, dict2): |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
330 |
"""update a copy of `dict1` with `dict2`""" |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
331 |
dict1 = dict(dict1) |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
332 |
dict1.update(dict2) |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
333 |
return dict1 |
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
334 |
|
4652
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
335 |
from logilab.common import date |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
336 |
_THIS_MOD_NS = globals() |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
337 |
for funcname in ('date_range', 'todate', 'todatetime', 'datetime2ticks', |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
338 |
'days_in_month', 'days_in_year', 'previous_month', |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
339 |
'next_month', 'first_day', 'last_day', 'ustrftime', |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
340 |
'strptime'): |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
341 |
msg = '[3.6] %s has been moved to logilab.common.date' % funcname |
7c41eea7fc30
restore 3.5 compat for date functions moved to lgc.date in 3.6 (closes #716055)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4511
diff
changeset
|
342 |
_THIS_MOD_NS[funcname] = deprecated(msg)(getattr(date, funcname)) |