author | Adrien Di Mascio <Adrien.DiMascio@logilab.fr> |
Wed, 05 Aug 2009 09:05:40 +0200 | |
changeset 3384 | f76a38731bc1 |
parent 2516 | b58826130680 |
child 2808 | 497424219fb0 |
child 2933 | d511ddcd2689 |
child 2996 | 866a2c135c33 |
permissions | -rw-r--r-- |
0 | 1 |
# -*- coding: utf-8 -*- |
2 |
"""user interface libraries |
|
3 |
||
4 |
contains some functions designed to help implementation of cubicweb user interface |
|
5 |
||
6 |
:organization: Logilab |
|
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1647
diff
changeset
|
7 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
0 | 8 |
: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:
1647
diff
changeset
|
9 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
0 | 10 |
""" |
11 |
__docformat__ = "restructuredtext en" |
|
12 |
||
13 |
import csv |
|
14 |
import re |
|
15 |
from urllib import quote as urlquote |
|
1635
866563e2d0fc
don't depends on simplejson outside web/
sylvain.thenault@logilab.fr
parents:
1623
diff
changeset
|
16 |
from StringIO import StringIO |
0 | 17 |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
18 |
from logilab.mtconverter import xml_escape, html_unescape |
0 | 19 |
|
709 | 20 |
from cubicweb.utils import ustrftime |
0 | 21 |
|
22 |
def rql_for_eid(eid): |
|
23 |
"""return the rql query necessary to fetch entity with the given eid. This |
|
24 |
function should only be used to generate link with rql inside, not to give |
|
25 |
to cursor.execute (in which case you won't benefit from rql cache). |
|
26 |
||
27 |
:Parameters: |
|
28 |
- `eid`: the eid of the entity we should search |
|
29 |
:rtype: str |
|
30 |
:return: the rql query |
|
31 |
""" |
|
32 |
return 'Any X WHERE X eid %s' % eid |
|
33 |
||
34 |
||
35 |
def printable_value(req, attrtype, value, props=None, displaytime=True): |
|
36 |
"""return a displayable value (i.e. unicode string)""" |
|
37 |
if value is None or attrtype == 'Bytes': |
|
38 |
return u'' |
|
39 |
if attrtype == 'String': |
|
40 |
# don't translate empty value if you don't want strange results |
|
41 |
if props is not None and value and props.get('internationalizable'): |
|
42 |
return req._(value) |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
43 |
|
0 | 44 |
return value |
45 |
if attrtype == 'Date': |
|
46 |
return ustrftime(value, req.property_value('ui.date-format')) |
|
47 |
if attrtype == 'Time': |
|
48 |
return ustrftime(value, req.property_value('ui.time-format')) |
|
49 |
if attrtype == 'Datetime': |
|
50 |
if not displaytime: |
|
51 |
return ustrftime(value, req.property_value('ui.date-format')) |
|
52 |
return ustrftime(value, req.property_value('ui.datetime-format')) |
|
53 |
if attrtype == 'Boolean': |
|
54 |
if value: |
|
55 |
return req._('yes') |
|
56 |
return req._('no') |
|
57 |
if attrtype == 'Float': |
|
58 |
value = req.property_value('ui.float-format') % value |
|
59 |
return unicode(value) |
|
60 |
||
61 |
||
62 |
# text publishing ############################################################# |
|
63 |
||
64 |
try: |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
65 |
from cubicweb.ext.rest import rest_publish # pylint: disable-msg=W0611 |
0 | 66 |
except ImportError: |
67 |
def rest_publish(entity, data): |
|
68 |
"""default behaviour if docutils was not found""" |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
69 |
return xml_escape(data) |
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
70 |
|
0 | 71 |
TAG_PROG = re.compile(r'</?.*?>', re.U) |
72 |
def remove_html_tags(text): |
|
73 |
"""Removes HTML tags from text |
|
74 |
||
75 |
>>> remove_html_tags('<td>hi <a href="http://www.google.fr">world</a></td>') |
|
76 |
'hi world' |
|
77 |
>>> |
|
78 |
""" |
|
79 |
return TAG_PROG.sub('', text) |
|
80 |
||
81 |
||
82 |
REF_PROG = re.compile(r"<ref\s+rql=([\'\"])([^\1]*?)\1\s*>([^<]*)</ref>", re.U) |
|
83 |
def _subst_rql(view, obj): |
|
84 |
delim, rql, descr = obj.groups() |
|
85 |
return u'<a href="%s">%s</a>' % (view.build_url(rql=rql), descr) |
|
86 |
||
87 |
def html_publish(view, text): |
|
88 |
"""replace <ref rql=''> links by <a href="...">""" |
|
89 |
if not text: |
|
90 |
return u'' |
|
91 |
return REF_PROG.sub(lambda obj, view=view:_subst_rql(view, obj), text) |
|
92 |
||
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
93 |
# fallback implementation, nicer one defined below if lxml is available |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
94 |
def soup2xhtml(data, encoding): |
2208
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
95 |
# normalize line break |
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
96 |
# see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7.1 |
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
97 |
return u'\n'.join(data.splitlines()) |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
98 |
|
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
99 |
# fallback implementation, nicer one defined below if lxml> 2.0 is available |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
100 |
def safe_cut(text, length): |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
101 |
"""returns a string of length <length> based on <text>, removing any html |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
102 |
tags from given text if cut is necessary.""" |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
103 |
if text is None: |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
104 |
return u'' |
362
a6a319f000c3
use mtconverter's html_unescape rather than saxutils' escape to deal with any html entity
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
350
diff
changeset
|
105 |
noenttext = html_unescape(text) |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
106 |
text_nohtml = remove_html_tags(noenttext) |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
107 |
# try to keep html tags if text is short enough |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
108 |
if len(text_nohtml) <= length: |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
109 |
return text |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
110 |
# else if un-tagged text is too long, cut it |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
111 |
return xml_escape(text_nohtml[:length] + u'...') |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
112 |
|
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
113 |
fallback_safe_cut = safe_cut |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
114 |
|
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
115 |
|
0 | 116 |
try: |
117 |
from lxml import etree |
|
228
27b958dc72ae
[lxml] lxml version < 2 does not provide an iter method on some elements
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
165
diff
changeset
|
118 |
except (ImportError, AttributeError): |
0 | 119 |
# gae environment: lxml not availabel |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
120 |
pass |
0 | 121 |
else: |
122 |
||
123 |
def soup2xhtml(data, encoding): |
|
124 |
"""tidy (at least try) html soup and return the result |
|
125 |
Note: the function considers a string with no surrounding tag as valid |
|
126 |
if <div>`data`</div> can be parsed by an XML parser |
|
127 |
""" |
|
2208
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
128 |
# normalize line break |
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
129 |
# see http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7.1 |
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
130 |
data = u'\n'.join(data.splitlines()) |
1c73148ed912
normalize line breaks (actually fix https://www.logilab.net/cwo/ticket/343754)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
131 |
# XXX lxml 1.1 support still needed ? |
0 | 132 |
xmltree = etree.HTML('<div>%s</div>' % data) |
133 |
# NOTE: lxml 1.1 (etch platforms) doesn't recognize |
|
134 |
# the encoding=unicode parameter (lxml 2.0 does), this is |
|
135 |
# why we specify an encoding and re-decode to unicode later |
|
136 |
body = etree.tostring(xmltree[0], encoding=encoding) |
|
137 |
# remove <body> and </body> and decode to unicode |
|
138 |
return body[11:-13].decode(encoding) |
|
139 |
||
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
140 |
if hasattr(etree.HTML('<div>test</div>'), 'iter'): |
165 | 141 |
|
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
142 |
def safe_cut(text, length): |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
143 |
"""returns an html document of length <length> based on <text>, |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
144 |
and cut is necessary. |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
145 |
""" |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
146 |
if text is None: |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
147 |
return u'' |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
148 |
dom = etree.HTML(text) |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
149 |
curlength = 0 |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
150 |
add_ellipsis = False |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
151 |
for element in dom.iter(): |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
152 |
if curlength >= length: |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
153 |
parent = element.getparent() |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
154 |
parent.remove(element) |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
155 |
if curlength == length and (element.text or element.tail): |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
156 |
add_ellipsis = True |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
157 |
else: |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
158 |
if element.text is not None: |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
159 |
element.text = cut(element.text, length - curlength) |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
160 |
curlength += len(element.text) |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
161 |
if element.tail is not None: |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
162 |
if curlength < length: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
163 |
element.tail = cut(element.tail, length - curlength) |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
164 |
curlength += len(element.tail) |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
165 |
elif curlength == length: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
166 |
element.tail = '...' |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
167 |
else: |
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
168 |
element.tail = '' |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
169 |
text = etree.tounicode(dom[0])[6:-7] # remove wrapping <body></body> |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
170 |
if add_ellipsis: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
171 |
return text + u'...' |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
172 |
return text |
1157
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
173 |
|
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
174 |
def text_cut(text, nbwords=30, gotoperiod=True): |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
175 |
"""from the given plain text, return a text with at least <nbwords> words, |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
176 |
trying to go to the end of the current sentence. |
277
a11a3c231050
fix lxml is available, we can have a nicer version of soup2xhtml even if its lxml < 2.0
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
228
diff
changeset
|
177 |
|
1157
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
178 |
:param nbwords: the minimum number of words required |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
179 |
:param gotoperiod: specifies if the function should try to go to |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
180 |
the first period after the cut (i.e. finish |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
181 |
the sentence if possible) |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
182 |
|
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
183 |
Note that spaces are normalized. |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
184 |
""" |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
185 |
if text is None: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
186 |
return u'' |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
187 |
words = text.split() |
927
bfcc610c3d5e
text_cut must return unicode not string
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
525
diff
changeset
|
188 |
text = u' '.join(words) # normalize spaces |
1157
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
189 |
textlength = minlength = len(' '.join(words[:nbwords])) |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
190 |
if gotoperiod: |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
191 |
textlength = text.find('.', minlength) + 1 |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
192 |
if textlength == 0: # no period found |
81a383cdda5c
text_cut() accepts a gotoperiod parameter
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
927
diff
changeset
|
193 |
textlength = minlength |
350
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
194 |
return text[:textlength] |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
195 |
|
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
196 |
def cut(text, length): |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
197 |
"""returns a string of a maximum length <length> based on <text> |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
198 |
(approximatively, since if text has been cut, '...' is added to the end of the string, |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
199 |
resulting in a string of len <length> + 3) |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
200 |
""" |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
201 |
if text is None: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
202 |
return u'' |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
203 |
if len(text) <= length: |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
204 |
return text |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
205 |
# else if un-tagged text is too long, cut it |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
206 |
return text[:length] + u'...' |
f34ef2c64605
cleanup/fix cut variants
Sylvain Thenault <sylvain.thenault@logilab.fr>
parents:
277
diff
changeset
|
207 |
|
165 | 208 |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
209 |
|
0 | 210 |
# HTML generation helper functions ############################################ |
211 |
||
2398
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
212 |
HTML4_EMPTY_TAGS = frozenset(('base', 'meta', 'link', 'hr', 'br', 'param', |
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
213 |
'img', 'area', 'input', 'col')) |
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
214 |
|
2516
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
215 |
def sgml_attributes(attrs): |
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
216 |
return u' '.join(u'%s="%s"' % (attr, xml_escape(unicode(value))) |
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
217 |
for attr, value in sorted(attrs.items()) |
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
218 |
if value is not None) |
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
219 |
|
1623 | 220 |
def simple_sgml_tag(tag, content=None, escapecontent=True, **attrs): |
525
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
221 |
"""generation of a simple sgml tag (eg without children tags) easier |
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
222 |
|
2399
68799e25f893
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
223 |
content and attri butes will be escaped |
525
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
224 |
""" |
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
225 |
value = u'<%s' % tag |
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
226 |
if attrs: |
980
59552ba2015f
more tags, map klass -> class avoiding needs to use **dict
sylvain.thenault@logilab.fr
parents:
862
diff
changeset
|
227 |
try: |
59552ba2015f
more tags, map klass -> class avoiding needs to use **dict
sylvain.thenault@logilab.fr
parents:
862
diff
changeset
|
228 |
attrs['class'] = attrs.pop('klass') |
59552ba2015f
more tags, map klass -> class avoiding needs to use **dict
sylvain.thenault@logilab.fr
parents:
862
diff
changeset
|
229 |
except KeyError: |
59552ba2015f
more tags, map klass -> class avoiding needs to use **dict
sylvain.thenault@logilab.fr
parents:
862
diff
changeset
|
230 |
pass |
2516
b58826130680
extract function: sgml_attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2458
diff
changeset
|
231 |
value += u' ' + sgml_attributes(attrs) |
525
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
232 |
if content: |
1623 | 233 |
if escapecontent: |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
234 |
content = xml_escape(unicode(content)) |
1623 | 235 |
value += u'>%s</%s>' % (content, tag) |
525
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
236 |
else: |
2398
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
237 |
if tag in HTML4_EMPTY_TAGS: |
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
238 |
value += u' />' |
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
239 |
else: |
a8d18e320ef3
a standard-conformant fix for sgml_tags
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
2375
diff
changeset
|
240 |
value += u'></%s>' % tag |
525
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
241 |
return value |
bd4e03297cf0
function to make generation of a simple sgml tag
sylvain.thenault@logilab.fr
parents:
362
diff
changeset
|
242 |
|
0 | 243 |
def tooltipize(text, tooltip, url=None): |
244 |
"""make an HTML tooltip""" |
|
245 |
url = url or '#' |
|
246 |
return u'<a href="%s" title="%s">%s</a>' % (url, tooltip, text) |
|
247 |
||
248 |
def toggle_action(nodeid): |
|
249 |
"""builds a HTML link that uses the js toggleVisibility function""" |
|
250 |
return u"javascript: toggleVisibility('%s')" % nodeid |
|
251 |
||
252 |
def toggle_link(nodeid, label): |
|
253 |
"""builds a HTML link that uses the js toggleVisibility function""" |
|
254 |
return u'<a href="%s">%s</a>' % (toggle_action(nodeid), label) |
|
255 |
||
256 |
||
257 |
def ureport_as_html(layout): |
|
258 |
from logilab.common.ureports import HTMLWriter |
|
259 |
formater = HTMLWriter(True) |
|
260 |
stream = StringIO() #UStringIO() don't want unicode assertion |
|
261 |
formater.format(layout, stream) |
|
262 |
res = stream.getvalue() |
|
263 |
if isinstance(res, str): |
|
264 |
res = unicode(res, 'UTF8') |
|
265 |
return res |
|
266 |
||
267 |
def render_HTML_tree(tree, selected_node=None, render_node=None, caption=None): |
|
268 |
""" |
|
269 |
Generate a pure HTML representation of a tree given as an instance |
|
270 |
of a logilab.common.tree.Node |
|
271 |
||
272 |
selected_node is the currently selected node (if any) which will |
|
273 |
have its surrounding <div> have id="selected" (which default |
|
274 |
to a bold border libe with the default CSS). |
|
275 |
||
276 |
render_node is a function that should take a Node content (Node.id) |
|
277 |
as parameter and should return a string (what will be displayed |
|
278 |
in the cell). |
|
279 |
||
280 |
Warning: proper rendering of the generated html code depends on html_tree.css |
|
281 |
""" |
|
282 |
tree_depth = tree.depth_down() |
|
283 |
if render_node is None: |
|
284 |
render_node = str |
|
285 |
||
286 |
# helper function that build a matrix from the tree, like: |
|
287 |
# +------+-----------+-----------+ |
|
288 |
# | root | child_1_1 | child_2_1 | |
|
289 |
# | root | child_1_1 | child_2_2 | |
|
290 |
# | root | child_1_2 | | |
|
291 |
# | root | child_1_3 | child_2_3 | |
|
292 |
# | root | child_1_3 | child_2_4 | |
|
293 |
# +------+-----------+-----------+ |
|
294 |
# from: |
|
295 |
# root -+- child_1_1 -+- child_2_1 |
|
296 |
# | | |
|
297 |
# | +- child_2_2 |
|
298 |
# +- child_1_2 |
|
299 |
# | |
|
300 |
# +- child1_3 -+- child_2_3 |
|
301 |
# | |
|
302 |
# +- child_2_2 |
|
303 |
def build_matrix(path, matrix): |
|
304 |
if path[-1].is_leaf(): |
|
305 |
matrix.append(path[:]) |
|
306 |
else: |
|
307 |
for child in path[-1].children: |
|
308 |
build_matrix(path[:] + [child], matrix) |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
309 |
|
0 | 310 |
matrix = [] |
311 |
build_matrix([tree], matrix) |
|
312 |
||
313 |
# make all lines in the matrix have the same number of columns |
|
314 |
for line in matrix: |
|
315 |
line.extend([None]*(tree_depth-len(line))) |
|
316 |
for i in range(len(matrix)-1, 0, -1): |
|
317 |
prev_line, line = matrix[i-1:i+1] |
|
318 |
for j in range(len(line)): |
|
319 |
if line[j] == prev_line[j]: |
|
320 |
line[j] = None |
|
321 |
||
322 |
# We build the matrix of link types (between 2 cells on a line of the matrix) |
|
323 |
# link types are : |
|
324 |
link_types = {(True, True, True ): 1, # T |
|
325 |
(False, False, True ): 2, # | |
|
326 |
(False, True, True ): 3, # + (actually, vert. bar with horiz. bar on the right) |
|
327 |
(False, True, False): 4, # L |
|
328 |
(True, True, False): 5, # - |
|
329 |
} |
|
330 |
links = [] |
|
331 |
for i, line in enumerate(matrix): |
|
332 |
links.append([]) |
|
333 |
for j in range(tree_depth-1): |
|
334 |
cell_11 = line[j] is not None |
|
335 |
cell_12 = line[j+1] is not None |
|
336 |
cell_21 = line[j+1] is not None and line[j+1].next_sibling() is not None |
|
337 |
link_type = link_types.get((cell_11, cell_12, cell_21), 0) |
|
1132 | 338 |
if link_type == 0 and i > 0 and links[i-1][j] in (1, 2, 3): |
0 | 339 |
link_type = 2 |
340 |
links[-1].append(link_type) |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
341 |
|
0 | 342 |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
343 |
# We can now generate the HTML code for the <table> |
0 | 344 |
s = u'<table class="tree">\n' |
345 |
if caption: |
|
346 |
s += '<caption>%s</caption>\n' % caption |
|
347 |
||
348 |
for i, link_line in enumerate(links): |
|
349 |
line = matrix[i] |
|
350 |
||
351 |
s += '<tr>' |
|
352 |
for j, link_cell in enumerate(link_line): |
|
353 |
cell = line[j] |
|
354 |
if cell: |
|
355 |
if cell.id == selected_node: |
|
356 |
s += '<td class="tree_cell" rowspan="2"><div id="selected" class="tree_cell">%s</div></td>' % (render_node(cell.id)) |
|
357 |
else: |
|
358 |
s += '<td class="tree_cell" rowspan="2"><div class="tree_cell">%s</div></td>' % (render_node(cell.id)) |
|
359 |
else: |
|
360 |
s += '<td rowspan="2"> </td>' |
|
361 |
s += '<td class="tree_cell_%d_1"> </td>' % link_cell |
|
362 |
s += '<td class="tree_cell_%d_2"> </td>' % link_cell |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
363 |
|
0 | 364 |
cell = line[-1] |
365 |
if cell: |
|
366 |
if cell.id == selected_node: |
|
367 |
s += '<td class="tree_cell" rowspan="2"><div id="selected" class="tree_cell">%s</div></td>' % (render_node(cell.id)) |
|
368 |
else: |
|
369 |
s += '<td class="tree_cell" rowspan="2"><div class="tree_cell">%s</div></td>' % (render_node(cell.id)) |
|
370 |
else: |
|
371 |
s += '<td rowspan="2"> </td>' |
|
372 |
||
373 |
s += '</tr>\n' |
|
374 |
if link_line: |
|
375 |
s += '<tr>' |
|
376 |
for j, link_cell in enumerate(link_line): |
|
377 |
s += '<td class="tree_cell_%d_3"> </td>' % link_cell |
|
378 |
s += '<td class="tree_cell_%d_4"> </td>' % link_cell |
|
379 |
s += '</tr>\n' |
|
380 |
||
381 |
s += '</table>' |
|
382 |
return s |
|
383 |
||
384 |
||
385 |
||
386 |
# traceback formatting ######################################################## |
|
387 |
||
388 |
import traceback |
|
389 |
||
390 |
def rest_traceback(info, exception): |
|
391 |
"""return a ReST formated traceback""" |
|
392 |
res = [u'Traceback\n---------\n::\n'] |
|
393 |
for stackentry in traceback.extract_tb(info[2]): |
|
394 |
res.append(u'\tFile %s, line %s, function %s' % tuple(stackentry[:3])) |
|
395 |
if stackentry[3]: |
|
396 |
res.append(u'\t %s' % stackentry[3].decode('utf-8', 'replace')) |
|
397 |
res.append(u'\n') |
|
398 |
try: |
|
399 |
res.append(u'\t Error: %s\n' % exception) |
|
400 |
except: |
|
401 |
pass |
|
402 |
return u'\n'.join(res) |
|
403 |
||
404 |
||
405 |
def html_traceback(info, exception, title='', |
|
406 |
encoding='ISO-8859-1', body=''): |
|
407 |
""" return an html formatted traceback from python exception infos. |
|
408 |
""" |
|
409 |
tcbk = info[2] |
|
410 |
stacktb = traceback.extract_tb(tcbk) |
|
411 |
strings = [] |
|
412 |
if body: |
|
413 |
strings.append(u'<div class="error_body">') |
|
414 |
# FIXME |
|
415 |
strings.append(body) |
|
416 |
strings.append(u'</div>') |
|
417 |
if title: |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
418 |
strings.append(u'<h1 class="error">%s</h1>'% xml_escape(title)) |
0 | 419 |
try: |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
420 |
strings.append(u'<p class="error">%s</p>' % xml_escape(str(exception)).replace("\n","<br />")) |
0 | 421 |
except UnicodeError: |
422 |
pass |
|
423 |
strings.append(u'<div class="error_traceback">') |
|
424 |
for index, stackentry in enumerate(stacktb): |
|
425 |
strings.append(u'<b>File</b> <b class="file">%s</b>, <b>line</b> ' |
|
426 |
u'<b class="line">%s</b>, <b>function</b> ' |
|
427 |
u'<b class="function">%s</b>:<br/>'%( |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
428 |
xml_escape(stackentry[0]), stackentry[1], xml_escape(stackentry[2]))) |
0 | 429 |
if stackentry[3]: |
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
430 |
string = xml_escape(stackentry[3]).decode('utf-8', 'replace') |
0 | 431 |
strings.append(u' %s<br/>\n' % (string)) |
432 |
# add locals info for each entry |
|
433 |
try: |
|
434 |
local_context = tcbk.tb_frame.f_locals |
|
435 |
html_info = [] |
|
436 |
chars = 0 |
|
437 |
for name, value in local_context.iteritems(): |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
438 |
value = xml_escape(repr(value)) |
0 | 439 |
info = u'<span class="name">%s</span>=%s, ' % (name, value) |
440 |
line_length = len(name) + len(value) |
|
441 |
chars += line_length |
|
442 |
# 150 is the result of *years* of research ;-) (CSS might be helpful here) |
|
443 |
if chars > 150: |
|
444 |
info = u'<br/>' + info |
|
445 |
chars = line_length |
|
446 |
html_info.append(info) |
|
447 |
boxid = 'ctxlevel%d' % index |
|
448 |
strings.append(u'[%s]' % toggle_link(boxid, '+')) |
|
449 |
strings.append(u'<div id="%s" class="pycontext hidden">%s</div>' % |
|
450 |
(boxid, ''.join(html_info))) |
|
451 |
tcbk = tcbk.tb_next |
|
452 |
except Exception: |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
453 |
pass # doesn't really matter if we have no context info |
0 | 454 |
strings.append(u'</div>') |
455 |
return '\n'.join(strings) |
|
456 |
||
457 |
# csv files / unicode support ################################################# |
|
458 |
||
459 |
class UnicodeCSVWriter: |
|
460 |
"""proxies calls to csv.writer.writerow to be able to deal with unicode""" |
|
1581
80ee6397c087
fix rest import, html_escape in null rest_publish
sylvain.thenault@logilab.fr
parents:
1263
diff
changeset
|
461 |
|
0 | 462 |
def __init__(self, wfunc, encoding, **kwargs): |
463 |
self.writer = csv.writer(self, **kwargs) |
|
464 |
self.wfunc = wfunc |
|
465 |
self.encoding = encoding |
|
466 |
||
467 |
def write(self, data): |
|
468 |
self.wfunc(data) |
|
469 |
||
470 |
def writerow(self, row): |
|
471 |
csvrow = [] |
|
472 |
for elt in row: |
|
473 |
if isinstance(elt, unicode): |
|
474 |
csvrow.append(elt.encode(self.encoding)) |
|
475 |
else: |
|
476 |
csvrow.append(str(elt)) |
|
477 |
self.writer.writerow(csvrow) |
|
478 |
||
479 |
def writerows(self, rows): |
|
480 |
for row in rows: |
|
481 |
self.writerow(row) |
|
482 |
||
483 |
||
484 |
# some decorators ############################################################# |
|
485 |
||
486 |
class limitsize(object): |
|
487 |
def __init__(self, maxsize): |
|
488 |
self.maxsize = maxsize |
|
489 |
||
490 |
def __call__(self, function): |
|
491 |
def newfunc(*args, **kwargs): |
|
492 |
ret = function(*args, **kwargs) |
|
493 |
if isinstance(ret, basestring): |
|
494 |
return ret[:self.maxsize] |
|
495 |
return ret |
|
496 |
return newfunc |
|
497 |
||
498 |
||
499 |
def htmlescape(function): |
|
500 |
def newfunc(*args, **kwargs): |
|
501 |
ret = function(*args, **kwargs) |
|
502 |
assert isinstance(ret, basestring) |
|
2312
af4d8f75c5db
use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2208
diff
changeset
|
503 |
return xml_escape(ret) |
0 | 504 |
return newfunc |