author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Wed, 11 Jun 2014 17:14:32 +0200 | |
changeset 10365 | 21461f80f348 |
parent 10258 | 61dfc689830a |
child 10510 | 51321946da37 |
permissions | -rw-r--r-- |
10118
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
1 |
# copyright 2003-2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
2 |
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
3 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
4 |
# This file is part of CubicWeb. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
5 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
6 |
# CubicWeb is free software: you can redistribute it and/or modify it under the |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
7 |
# terms of the GNU Lesser General Public License as published by the Free |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
8 |
# Software Foundation, either version 2.1 of the License, or (at your option) |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
9 |
# any later version. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
10 |
# |
5424
8ecbcbff9777
replace logilab-common by CubicWeb in disclaimer
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5421
diff
changeset
|
11 |
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
12 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
13 |
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
14 |
# details. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
15 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
16 |
# You should have received a copy of the GNU Lesser General Public License along |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5389
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
6044
9e48ebd5400c
[view] use the new magic js object to generate javascript func call for auto reload user callbacks
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5940
diff
changeset
|
18 |
"""Some utilities for CubicWeb server/clients.""" |
7956
db49658b2812
add missing imports
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7954
diff
changeset
|
19 |
|
10067
16c554c76eb4
Remove obsolete __future__ imports
Rémi Cardona <remi.cardona@free.fr>
parents:
10004
diff
changeset
|
20 |
from __future__ import division |
7956
db49658b2812
add missing imports
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7954
diff
changeset
|
21 |
|
0 | 22 |
__docformat__ = "restructuredtext en" |
23 |
||
3316 | 24 |
import decimal |
4466
8b0ca7904820
moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4335
diff
changeset
|
25 |
import datetime |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
26 |
import random |
7998
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
27 |
import re |
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
28 |
import json |
7998
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
29 |
|
7954
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
30 |
from operator import itemgetter |
6067
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
31 |
from inspect import getargspec |
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
32 |
from itertools import repeat |
4833
41a78fb4107c
3.7 depends on python >= 2.5
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4693
diff
changeset
|
33 |
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
|
34 |
from warnings import warn |
7954
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
35 |
from threading import Lock |
8682
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
36 |
from urlparse import urlparse |
7954
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
37 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
38 |
from logging import getLogger |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
39 |
|
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
40 |
from logilab.mtconverter import xml_escape |
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
41 |
from logilab.common.deprecation import deprecated |
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
42 |
from logilab.common.date import ustrftime |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
43 |
|
4830
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
44 |
_MARKER = object() |
10e8bc190695
[javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4693
diff
changeset
|
45 |
|
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
|
46 |
# initialize random seed from current time |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
47 |
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
|
48 |
|
10118
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
49 |
def admincnx(appid): |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
50 |
from cubicweb.cwconfig import CubicWebConfiguration |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
51 |
from cubicweb.server.repository import Repository |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
52 |
from cubicweb.server.utils import TasksManager |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
53 |
config = CubicWebConfiguration.config_for(appid) |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
54 |
|
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
55 |
login = config.default_admin_config['login'] |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
56 |
password = config.default_admin_config['password'] |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
57 |
|
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
58 |
repo = Repository(config, TasksManager()) |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
59 |
session = repo.new_session(login, password=password) |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
60 |
return session.new_cnx() |
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
61 |
|
78ab2b14048a
[utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
10090
diff
changeset
|
62 |
|
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
|
63 |
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
|
64 |
"""Return a unique identifier string. |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
65 |
|
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
|
66 |
if specified, `key` is used to prefix the generated uid so it can be used |
9232
430a7dc5e2cf
[utils] fix typos in make_uid docstring
Julien Cristau <julien.cristau@logilab.fr>
parents:
8941
diff
changeset
|
67 |
for instance as a DOM id or as sql table name. |
4653
ca11228a5268
import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4652
diff
changeset
|
68 |
|
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
|
69 |
See uuid.uuid4 documentation for the shape of the generated identifier, but |
9232
430a7dc5e2cf
[utils] fix typos in make_uid docstring
Julien Cristau <julien.cristau@logilab.fr>
parents:
8941
diff
changeset
|
70 |
this is basically a 32 bits hexadecimal string. |
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
|
71 |
""" |
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
|
72 |
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
|
73 |
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
|
74 |
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
|
75 |
|
0 | 76 |
|
6067
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
77 |
def support_args(callable, *argnames): |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
78 |
"""return true if the callable support given argument names""" |
6913
ab85124dc0eb
[utils] support_args now support classes, searching if __init__ supports the arguments
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6684
diff
changeset
|
79 |
if isinstance(callable, type): |
ab85124dc0eb
[utils] support_args now support classes, searching if __init__ supports the arguments
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6684
diff
changeset
|
80 |
callable = callable.__init__ |
6067
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
81 |
argspec = getargspec(callable) |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
82 |
if argspec[2]: |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
83 |
return True |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
84 |
for argname in argnames: |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
85 |
if argname not in argspec[0]: |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
86 |
return False |
efca814587e2
[primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6044
diff
changeset
|
87 |
return True |
0 | 88 |
|
6141
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
89 |
|
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
90 |
class wrap_on_write(object): |
6580
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
91 |
""" Sometimes it is convenient to NOT write some container element |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
92 |
if it happens that there is nothing to be written within, |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
93 |
but this cannot be known beforehand. |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
94 |
Hence one can do this: |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
95 |
|
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
96 |
.. sourcecode:: python |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
97 |
|
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
98 |
with wrap_on_write(w, '<div class="foo">', '</div>') as wow: |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
99 |
component.render_stuff(wow) |
798200432f50
some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6492
diff
changeset
|
100 |
""" |
6141
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
101 |
def __init__(self, w, tag, closetag=None): |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
102 |
self.written = False |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
103 |
self.tag = unicode(tag) |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
104 |
self.closetag = closetag |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
105 |
self.w = w |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
106 |
|
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
107 |
def __enter__(self): |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
108 |
return self |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
109 |
|
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
110 |
def __call__(self, data): |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
111 |
if self.written is False: |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
112 |
self.w(self.tag) |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
113 |
self.written = True |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
114 |
self.w(data) |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
115 |
|
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
116 |
def __exit__(self, exctype, value, traceback): |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
117 |
if self.written is True: |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
118 |
if self.closetag: |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
119 |
self.w(unicode(self.closetag)) |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
120 |
else: |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
121 |
self.w(self.tag.replace('<', '</', 1)) |
b8287e54b528
[web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6067
diff
changeset
|
122 |
|
0 | 123 |
|
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
124 |
# use networkX instead ? |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
125 |
# http://networkx.lanl.gov/reference/algorithms.traversal.html#module-networkx.algorithms.traversal.astar |
6854 | 126 |
def transitive_closure_of(entity, rtype, _seen=None): |
4317
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
127 |
"""return transitive closure *for the subgraph starting from the given |
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
128 |
entity* (eg 'parent' entities are not included in the results) |
b2093f8f0493
some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4212
diff
changeset
|
129 |
""" |
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
130 |
if _seen is None: |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
131 |
_seen = set() |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
132 |
_seen.add(entity.eid) |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
133 |
yield entity |
6854 | 134 |
for child in getattr(entity, rtype): |
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
135 |
if child.eid in _seen: |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
136 |
continue |
6854 | 137 |
for subchild in transitive_closure_of(child, rtype, _seen): |
3882
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
138 |
yield subchild |
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
139 |
|
addc715f4fcd
backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3851
diff
changeset
|
140 |
|
0 | 141 |
class SizeConstrainedList(list): |
7568
c5ee33fb6a3b
[test] run and fix utils and uilib doctests
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
142 |
"""simple list that makes sure the list does not get bigger than a given |
c5ee33fb6a3b
[test] run and fix utils and uilib doctests
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
143 |
size. |
0 | 144 |
|
7568
c5ee33fb6a3b
[test] run and fix utils and uilib doctests
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
145 |
when the list is full and a new element is added, the first element of the |
c5ee33fb6a3b
[test] run and fix utils and uilib doctests
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
146 |
list is removed before appending the new one |
0 | 147 |
|
148 |
>>> l = SizeConstrainedList(2) |
|
149 |
>>> l.append(1) |
|
150 |
>>> l.append(2) |
|
151 |
>>> l |
|
152 |
[1, 2] |
|
153 |
>>> l.append(3) |
|
7568
c5ee33fb6a3b
[test] run and fix utils and uilib doctests
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7268
diff
changeset
|
154 |
>>> l |
0 | 155 |
[2, 3] |
156 |
""" |
|
157 |
def __init__(self, maxsize): |
|
158 |
self.maxsize = maxsize |
|
159 |
||
160 |
def append(self, element): |
|
161 |
if len(self) == self.maxsize: |
|
162 |
del self[0] |
|
163 |
super(SizeConstrainedList, self).append(element) |
|
164 |
||
165 |
def extend(self, sequence): |
|
166 |
super(SizeConstrainedList, self).extend(sequence) |
|
167 |
keepafter = len(self) - self.maxsize |
|
168 |
if keepafter > 0: |
|
169 |
del self[:keepafter] |
|
170 |
||
171 |
__iadd__ = extend |
|
172 |
||
173 |
||
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
174 |
class RepeatList(object): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
175 |
"""fake a list with the same element in each row""" |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
176 |
__slots__ = ('_size', '_item') |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
177 |
def __init__(self, size, item): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
178 |
self._size = size |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
179 |
self._item = item |
5883
7a5f370c5be1
[utils] improve repr() of RepeatList
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
5726
diff
changeset
|
180 |
def __repr__(self): |
7a5f370c5be1
[utils] improve repr() of RepeatList
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
5726
diff
changeset
|
181 |
return '<cubicweb.utils.RepeatList at %s item=%s size=%s>' % ( |
7a5f370c5be1
[utils] improve repr() of RepeatList
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
5726
diff
changeset
|
182 |
id(self), self._item, self._size) |
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
183 |
def __len__(self): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
184 |
return self._size |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
185 |
def __iter__(self): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
186 |
return repeat(self._item, self._size) |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
187 |
def __getitem__(self, index): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
188 |
return self._item |
6374
5adf53edfe12
[rset] support for delitem on repeat list (may be necessary in pyro source)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6176
diff
changeset
|
189 |
def __delitem__(self, idc): |
5adf53edfe12
[rset] support for delitem on repeat list (may be necessary in pyro source)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6176
diff
changeset
|
190 |
assert self._size > 0 |
5adf53edfe12
[rset] support for delitem on repeat list (may be necessary in pyro source)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6176
diff
changeset
|
191 |
self._size -= 1 |
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
192 |
def __getslice__(self, i, j): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
193 |
# XXX could be more efficient, but do we bother? |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
194 |
return ([self._item] * self._size)[i:j] |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
195 |
def __add__(self, other): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
196 |
if isinstance(other, RepeatList): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
197 |
if other._item == self._item: |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
198 |
return RepeatList(self._size + other._size, self._item) |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
199 |
return ([self._item] * self._size) + other[:] |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
200 |
return ([self._item] * self._size) + other |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
201 |
def __radd__(self, other): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
202 |
if isinstance(other, RepeatList): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
203 |
if other._item == self._item: |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
204 |
return RepeatList(self._size + other._size, self._item) |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
205 |
return other[:] + ([self._item] * self._size) |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
206 |
return other[:] + ([self._item] * self._size) |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
207 |
def __eq__(self, other): |
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
208 |
if isinstance(other, RepeatList): |
6492
47a284c0d012
fix some pylint detected errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6448
diff
changeset
|
209 |
return other._size == self._size and other._item == self._item |
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
210 |
return self[:] == other |
9279
0814b9dd9bf3
[py3k] note about future warning on __eq__ vs __hash__
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9232
diff
changeset
|
211 |
# py3k future warning "Overriding __eq__ blocks inheritance of __hash__ in 3.x" |
0814b9dd9bf3
[py3k] note about future warning on __eq__ vs __hash__
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
9232
diff
changeset
|
212 |
# is annoying but won't go away because we don't want to hash() the repeatlist |
5077
dc448c9ad9dd
[rset] cubes such as iliane hi-jack rset description by poping some lines from it. Handle this on RepeatList
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5069
diff
changeset
|
213 |
def pop(self, i): |
dc448c9ad9dd
[rset] cubes such as iliane hi-jack rset description by poping some lines from it. Handle this on RepeatList
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5069
diff
changeset
|
214 |
self._size -= 1 |
5069
135c5d7b89d0
[querier] introduce RepeatList class, used to optimize size of data returned for result set description
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4961
diff
changeset
|
215 |
|
6684
b8bd0ecced2e
minor cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6580
diff
changeset
|
216 |
|
0 | 217 |
class UStringIO(list): |
218 |
"""a file wrapper which automatically encode unicode string to an encoding |
|
219 |
specifed in the constructor |
|
220 |
""" |
|
221 |
||
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
222 |
def __init__(self, tracewrites=False, *args, **kwargs): |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
223 |
self.tracewrites = tracewrites |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
224 |
super(UStringIO, self).__init__(*args, **kwargs) |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
225 |
|
0 | 226 |
def __nonzero__(self): |
227 |
return True |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
228 |
|
0 | 229 |
def write(self, value): |
230 |
assert isinstance(value, unicode), u"unicode required not %s : %s"\ |
|
231 |
% (type(value).__name__, repr(value)) |
|
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
232 |
if self.tracewrites: |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
233 |
from traceback import format_stack |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
234 |
stack = format_stack(None)[:-1] |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
235 |
escaped_stack = xml_escape(json_dumps(u'\n'.join(stack))) |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
236 |
escaped_html = xml_escape(value).replace('\n', '<br/>\n') |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
237 |
tpl = u'<span onclick="alert(%s)">%s</span>' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
238 |
value = tpl % (escaped_stack, escaped_html) |
0 | 239 |
self.append(value) |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
240 |
|
0 | 241 |
def getvalue(self): |
242 |
return u''.join(self) |
|
243 |
||
244 |
def __repr__(self): |
|
245 |
return '<%s at %#x>' % (self.__class__.__name__, id(self)) |
|
246 |
||
247 |
||
248 |
class HTMLHead(UStringIO): |
|
249 |
"""wraps HTML header's stream |
|
250 |
||
251 |
Request objects use a HTMLHead instance to ease adding of |
|
252 |
javascripts and stylesheets |
|
253 |
""" |
|
7267
2fe2ed459e4d
[page data] don't call unload_page_data too many time (closes #1518398)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7140
diff
changeset
|
254 |
js_unload_code = u'''if (typeof(pageDataUnloaded) == 'undefined') { |
2fe2ed459e4d
[page data] don't call unload_page_data too many time (closes #1518398)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7140
diff
changeset
|
255 |
jQuery(window).unload(unloadPageData); |
2fe2ed459e4d
[page data] don't call unload_page_data too many time (closes #1518398)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7140
diff
changeset
|
256 |
pageDataUnloaded = true; |
2fe2ed459e4d
[page data] don't call unload_page_data too many time (closes #1518398)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7140
diff
changeset
|
257 |
}''' |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
258 |
script_opening = u'<script type="text/javascript">\n' |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
259 |
script_closing = u'\n</script>' |
0 | 260 |
|
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
261 |
def __init__(self, req, *args, **kwargs): |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
262 |
super(HTMLHead, self).__init__(*args, **kwargs) |
0 | 263 |
self.jsvars = [] |
264 |
self.jsfiles = [] |
|
265 |
self.cssfiles = [] |
|
266 |
self.ie_cssfiles = [] |
|
267 |
self.post_inlined_scripts = [] |
|
268 |
self.pagedata_unload = False |
|
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
269 |
self._cw = req |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
270 |
self.datadir_url = req.datadir_url |
0 | 271 |
|
272 |
def add_raw(self, rawheader): |
|
273 |
self.write(rawheader) |
|
274 |
||
3838
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
275 |
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
|
276 |
"""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
|
277 |
|
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
278 |
: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
|
279 |
: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
|
280 |
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
|
281 |
: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
|
282 |
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
|
283 |
""" |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
284 |
self.jsvars.append( (var, value, override) ) |
0 | 285 |
|
286 |
def add_post_inline_script(self, content): |
|
287 |
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
|
288 |
|
8795
772cd62e1295
[utils] drop pre-3.7 compat in util
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8682
diff
changeset
|
289 |
def add_onload(self, jscode): |
6448
8590d82e9b1b
[javascript] update to jQuery 1.4.2 and jQuery-ui 1.8.5
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
6409
diff
changeset
|
290 |
self.add_post_inline_script(u"""$(cw).one('server-response', function(event) { |
4903
627fcd90e08f
fix bad conflict resolution
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4899
diff
changeset
|
291 |
%s});""" % jscode) |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
292 |
|
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
293 |
|
0 | 294 |
def add_js(self, jsfile): |
295 |
"""adds `jsfile` to the list of javascripts used in the webpage |
|
296 |
||
297 |
This function checks if the file has already been added |
|
298 |
:param jsfile: the script's URL |
|
299 |
""" |
|
300 |
if jsfile not in self.jsfiles: |
|
301 |
self.jsfiles.append(jsfile) |
|
302 |
||
7277
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
303 |
def add_css(self, cssfile, media='all'): |
0 | 304 |
"""adds `cssfile` to the list of javascripts used in the webpage |
305 |
||
306 |
This function checks if the file has already been added |
|
307 |
:param cssfile: the stylesheet's URL |
|
308 |
""" |
|
309 |
if (cssfile, media) not in self.cssfiles: |
|
310 |
self.cssfiles.append( (cssfile, media) ) |
|
311 |
||
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
312 |
def add_ie_css(self, cssfile, media='all', iespec=u'[if lt IE 8]'): |
0 | 313 |
"""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
|
314 |
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
|
315 |
self.ie_cssfiles.append( (cssfile, media, iespec) ) |
0 | 316 |
|
317 |
def add_unload_pagedata(self): |
|
318 |
"""registers onunload callback to clean page data on server""" |
|
319 |
if not self.pagedata_unload: |
|
320 |
self.post_inlined_scripts.append(self.js_unload_code) |
|
321 |
self.pagedata_unload = True |
|
322 |
||
7277
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
323 |
def concat_urls(self, urls): |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
324 |
"""concatenates urls into one url usable by Apache mod_concat |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
325 |
|
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
326 |
This method returns the url without modifying it if there is only |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
327 |
one element in the list |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
328 |
:param urls: list of local urls/filenames to concatenate |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
329 |
""" |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
330 |
if len(urls) == 1: |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
331 |
return urls[0] |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
332 |
len_prefix = len(self.datadir_url) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
333 |
concated = u','.join(url[len_prefix:] for url in urls) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
334 |
return (u'%s??%s' % (self.datadir_url, concated)) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
335 |
|
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
336 |
def group_urls(self, urls_spec): |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
337 |
"""parses urls_spec in order to generate concatenated urls |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
338 |
for js and css includes |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
339 |
|
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
340 |
This method checks if the file is local and if it shares options |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
341 |
with direct neighbors |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
342 |
:param urls_spec: entire list of urls/filenames to inspect |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
343 |
""" |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
344 |
concatable = [] |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
345 |
prev_islocal = False |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
346 |
prev_key = None |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
347 |
for url, key in urls_spec: |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
348 |
islocal = url.startswith(self.datadir_url) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
349 |
if concatable and (islocal != prev_islocal or key != prev_key): |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
350 |
yield (self.concat_urls(concatable), prev_key) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
351 |
del concatable[:] |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
352 |
if not islocal: |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
353 |
yield (url, key) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
354 |
else: |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
355 |
concatable.append(url) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
356 |
prev_islocal = islocal |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
357 |
prev_key = key |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
358 |
if concatable: |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
359 |
yield (self.concat_urls(concatable), prev_key) |
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
360 |
|
acd7f0e9f276
[etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents:
7187
diff
changeset
|
361 |
|
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
|
362 |
def getvalue(self, skiphead=False): |
0 | 363 |
"""reimplement getvalue to provide a consistent (and somewhat browser |
364 |
optimzed cf. http://stevesouders.com/cuzillion) order in external |
|
365 |
resources declaration |
|
366 |
""" |
|
367 |
w = self.write |
|
368 |
# 1/ variable declaration if any |
|
369 |
if self.jsvars: |
|
10166
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
370 |
if skiphead: |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
371 |
w(u'<cubicweb:script>') |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
372 |
else: |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
373 |
w(self.script_opening) |
3838
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
374 |
for var, value, override in self.jsvars: |
5389
809d3b5b3d31
[python2.6] careful: json-py provides a json package. We don't want that.
Alexandre Fayolle <alexandre.fayolle@logilab.fr>
parents:
5377
diff
changeset
|
375 |
vardecl = u'%s = %s;' % (var, json.dumps(value)) |
3838
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
376 |
if not override: |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
377 |
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
|
378 |
(var, vardecl)) |
9cc134372bf8
[web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
3789
diff
changeset
|
379 |
w(vardecl + u'\n') |
10166
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
380 |
if skiphead: |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
381 |
w(u'</cubicweb:script>') |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
382 |
else: |
0095961df66c
[utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10118
diff
changeset
|
383 |
w(self.script_closing) |
0 | 384 |
# 2/ css files |
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
385 |
ie_cssfiles = ((x, (y, z)) for x, y, z in self.ie_cssfiles) |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
386 |
if self.datadir_url and self._cw.vreg.config['concat-resources']: |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
387 |
cssfiles = self.group_urls(self.cssfiles) |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
388 |
ie_cssfiles = self.group_urls(ie_cssfiles) |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
389 |
jsfiles = (x for x, _ in self.group_urls((x, None) for x in self.jsfiles)) |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
390 |
else: |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
391 |
cssfiles = self.cssfiles |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
392 |
jsfiles = self.jsfiles |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
393 |
for cssfile, media in cssfiles: |
0 | 394 |
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
|
395 |
(media, xml_escape(cssfile))) |
0 | 396 |
# 3/ ie css if necessary |
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
397 |
if self.ie_cssfiles: # use self.ie_cssfiles because `ie_cssfiles` is a genexp |
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
398 |
for cssfile, (media, iespec) in ie_cssfiles: |
4860
cedb6afdb7da
[web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
4859
diff
changeset
|
399 |
w(u'<!--%s>\n' % iespec) |
0 | 400 |
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
|
401 |
(media, xml_escape(cssfile))) |
0 | 402 |
w(u'<![endif]--> \n') |
403 |
# 4/ js files |
|
7762
a3f9ba4d44eb
[web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7660
diff
changeset
|
404 |
for jsfile in jsfiles: |
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
405 |
if skiphead: |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
406 |
# Don't insert <script> tags directly as they would be |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
407 |
# interpreted directly by some browsers (e.g. IE). |
9523
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
408 |
# Use <cubicweb:script> tags instead and let |
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
409 |
# `loadAjaxHtmlHead` handle the script insertion / execution. |
9523
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
410 |
w(u'<cubicweb:script src="%s"></cubicweb:script>\n' % |
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
411 |
xml_escape(jsfile)) |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
412 |
# FIXME: a probably better implementation might be to add |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
413 |
# JS or CSS urls in a JS list that loadAjaxHtmlHead |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
414 |
# would iterate on and postprocess: |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
415 |
# cw._ajax_js_scripts.push('myscript.js') |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
416 |
# Then, in loadAjaxHtmlHead, do something like: |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
417 |
# jQuery.each(cw._ajax_js_script, jQuery.getScript) |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
418 |
else: |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
419 |
w(u'<script type="text/javascript" src="%s"></script>\n' % |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
420 |
xml_escape(jsfile)) |
0 | 421 |
# 5/ post inlined scripts (i.e. scripts depending on other JS files) |
422 |
if self.post_inlined_scripts: |
|
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
423 |
if skiphead: |
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
424 |
for script in self.post_inlined_scripts: |
9523
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
425 |
w(u'<cubicweb:script>') |
7660
a1506b5306cc
closes #1826543: error on some ajax_replace_url call
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7649
diff
changeset
|
426 |
w(xml_escape(script)) |
9523
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
427 |
w(u'</cubicweb:script>') |
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
428 |
else: |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
429 |
w(self.script_opening) |
7649
ede740bd7077
[ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7575
diff
changeset
|
430 |
w(u'\n\n'.join(self.post_inlined_scripts)) |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
431 |
w(self.script_closing) |
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
432 |
# at the start of this function, the parent UStringIO may already have |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
433 |
# data in it, so we can't w(u'<head>\n') at the top. Instead, we create |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
434 |
# a temporary UStringIO to get the same debugging output formatting |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
435 |
# if debugging is enabled. |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
436 |
headtag = UStringIO(tracewrites=self.tracewrites) |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
437 |
if not skiphead: |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
438 |
headtag.write(u'<head>\n') |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
439 |
w(u'</head>\n') |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
440 |
return headtag.getvalue() + super(HTMLHead, self).getvalue() |
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
441 |
|
0 | 442 |
|
443 |
class HTMLStream(object): |
|
444 |
"""represents a HTML page. |
|
445 |
||
446 |
This is used my main templates so that HTML headers can be added |
|
447 |
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
|
448 |
|
0 | 449 |
HTMLStream uses the (U)StringIO interface to be compliant with |
450 |
existing code. |
|
451 |
""" |
|
1549
f87561822e27
some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents:
1397
diff
changeset
|
452 |
|
0 | 453 |
def __init__(self, req): |
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
454 |
self.tracehtml = req.tracehtml |
0 | 455 |
# stream for <head> |
456 |
self.head = req.html_headers |
|
457 |
# main stream |
|
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
458 |
self.body = UStringIO(tracewrites=req.tracehtml) |
10004
acad42456767
[utils] Remove function-in-the-middle call
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9780
diff
changeset
|
459 |
# this method will be assigned to self.w in views |
acad42456767
[utils] Remove function-in-the-middle call
Rémi Cardona <remi.cardona@logilab.fr>
parents:
9780
diff
changeset
|
460 |
self.write = self.body.write |
0 | 461 |
self.doctype = u'' |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
462 |
self._htmlattrs = [('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
|
463 |
# 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
|
464 |
req.main_stream = self |
0 | 465 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
466 |
@deprecated('[3.17] there are no namespaces in html, xhtml is not served any longer') |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
467 |
def add_namespace(self, prefix, uri): |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
468 |
pass |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
469 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
470 |
@deprecated('[3.17] there are no namespaces in html, xhtml is not served any longer') |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
471 |
def set_namespaces(self, namespaces): |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
472 |
pass |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
473 |
|
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
474 |
def add_htmlattr(self, attrname, attrvalue): |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
475 |
self._htmlattrs.append( (attrname, attrvalue) ) |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
476 |
|
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
477 |
def set_htmlattrs(self, attrs): |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
478 |
self._htmlattrs = attrs |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
479 |
|
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
480 |
def set_doctype(self, doctype, reset_xmldecl=None): |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
481 |
self.doctype = doctype |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
482 |
if reset_xmldecl is not None: |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
483 |
warn('[3.17] xhtml is no more supported', |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
484 |
DeprecationWarning, stacklevel=2) |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
485 |
|
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
486 |
@property |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
487 |
def htmltag(self): |
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
488 |
attrs = ' '.join('%s="%s"' % (attr, xml_escape(value)) |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
489 |
for attr, value in self._htmlattrs) |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
490 |
if attrs: |
9523
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
491 |
return '<html xmlns:cubicweb="http://www.cubicweb.org" %s>' % attrs |
cd5738fc440f
[ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents:
9279
diff
changeset
|
492 |
return '<html xmlns:cubicweb="http://www.cubicweb.org">' |
7187
496f51b92154
[views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
7140
diff
changeset
|
493 |
|
0 | 494 |
def getvalue(self): |
495 |
"""writes HTML headers, closes </head> tag and writes HTML body""" |
|
10090
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
496 |
if self.tracehtml: |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
497 |
css = u'\n'.join((u'span {', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
498 |
u' font-family: monospace;', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
499 |
u' word-break: break-all;', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
500 |
u' word-wrap: break-word;', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
501 |
u'}', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
502 |
u'span:hover {', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
503 |
u' color: red;', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
504 |
u' text-decoration: underline;', |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
505 |
u'}')) |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
506 |
style = u'<style type="text/css">\n%s\n</style>\n' % css |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
507 |
return (u'<!DOCTYPE html>\n' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
508 |
+ u'<html>\n<head>\n%s\n</head>\n' % style |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
509 |
+ u'<body>\n' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
510 |
+ u'<span>' + xml_escape(self.doctype) + u'</span><br/>' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
511 |
+ u'<span>' + xml_escape(self.htmltag) + u'</span><br/>' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
512 |
+ self.head.getvalue() |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
513 |
+ self.body.getvalue() |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
514 |
+ u'<span>' + xml_escape(u'</html>') + u'</span>' |
0aebb1c0f849
[utils] Add a '_cwtracehtml' GET parameter to trace self._cw.w() calls (closes #4601327)
Rémi Cardona <remi.cardona@logilab.fr>
parents:
10067
diff
changeset
|
515 |
+ u'</body>\n</html>') |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
516 |
return u'%s\n%s\n%s\n%s\n</html>' % (self.doctype, |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
517 |
self.htmltag, |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
518 |
self.head.getvalue(), |
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8795
diff
changeset
|
519 |
self.body.getvalue()) |
0 | 520 |
|
5940
0e3ae19b181a
[uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5883
diff
changeset
|
521 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
522 |
class CubicWebJsonEncoder(json.JSONEncoder): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
523 |
"""define a json encoder to be able to encode yams std types""" |
5320
848e92bb81cc
[json] provide a custom json encoder for entities that includes eid in the json object
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
5077
diff
changeset
|
524 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
525 |
def default(self, obj): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
526 |
if hasattr(obj, '__json_encode__'): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
527 |
return obj.__json_encode__() |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
528 |
if isinstance(obj, datetime.datetime): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
529 |
return ustrftime(obj, '%Y/%m/%d %H:%M:%S') |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
530 |
elif isinstance(obj, datetime.date): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
531 |
return ustrftime(obj, '%Y/%m/%d') |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
532 |
elif isinstance(obj, datetime.time): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
533 |
return obj.strftime('%H:%M:%S') |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
534 |
elif isinstance(obj, datetime.timedelta): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
535 |
return (obj.days * 24 * 60 * 60) + obj.seconds |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
536 |
elif isinstance(obj, decimal.Decimal): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
537 |
return float(obj) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
538 |
try: |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
539 |
return json.JSONEncoder.default(self, obj) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
540 |
except TypeError: |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
541 |
# we never ever want to fail because of an unknown type, |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
542 |
# just return None in those cases. |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
543 |
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
|
544 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
545 |
def json_dumps(value, **kwargs): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
546 |
return json.dumps(value, cls=CubicWebJsonEncoder, **kwargs) |
5940
0e3ae19b181a
[uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5883
diff
changeset
|
547 |
|
4879
56c16efedc51
deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4844
diff
changeset
|
548 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
549 |
class JSString(str): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
550 |
"""use this string sub class in values given to :func:`js_dumps` to |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
551 |
insert raw javascript chain in some JSON string |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
552 |
""" |
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
553 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
554 |
def _dict2js(d, predictable=False): |
10258
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
555 |
if predictable: |
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
556 |
it = sorted(d.iteritems()) |
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
557 |
else: |
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
558 |
it = d.iteritems() |
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
559 |
res = [key + ': ' + js_dumps(val, predictable) |
10258
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
560 |
for key, val in it] |
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
561 |
return '{%s}' % ', '.join(res) |
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
562 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
563 |
def _list2js(l, predictable=False): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
564 |
return '[%s]' % ', '.join([js_dumps(val, predictable) for val in l]) |
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
565 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
566 |
def js_dumps(something, predictable=False): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
567 |
"""similar as :func:`json_dumps`, except values which are instances of |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
568 |
:class:`JSString` are expected to be valid javascript and will be output |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
569 |
as is |
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
570 |
|
9579
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
571 |
>>> js_dumps({'hop': JSString('$.hop'), 'bar': None}, predictable=True) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
572 |
'{bar: null, hop: $.hop}' |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
573 |
>>> js_dumps({'hop': '$.hop'}) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
574 |
'{hop: "$.hop"}' |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
575 |
>>> js_dumps({'hip': {'hop': JSString('momo')}}) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
576 |
'{hip: {hop: momo}}' |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
577 |
""" |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
578 |
if isinstance(something, dict): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
579 |
return _dict2js(something, predictable) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
580 |
if isinstance(something, list): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
581 |
return _list2js(something, predictable) |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
582 |
if isinstance(something, JSString): |
d5b0e1f4c5c5
[utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents:
9523
diff
changeset
|
583 |
return something |
10258
61dfc689830a
[utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents:
10236
diff
changeset
|
584 |
return json_dumps(something, sort_keys=predictable) |
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
585 |
|
7998
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
586 |
PERCENT_IN_URLQUOTE_RE = re.compile(r'%(?=[0-9a-fA-F]{2})') |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
587 |
def js_href(javascript_code): |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
588 |
"""Generate a "javascript: ..." string for an href attribute. |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
589 |
|
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
590 |
Some % which may be interpreted in a href context will be escaped. |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
591 |
|
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
592 |
In an href attribute, url-quotes-looking fragments are interpreted before |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
593 |
being given to the javascript engine. Valid url quotes are in the form |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
594 |
``%xx`` with xx being a byte in hexadecimal form. This means that ``%toto`` |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
595 |
will be unaltered but ``%babar`` will be mangled because ``ba`` is the |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
596 |
hexadecimal representation of 186. |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
597 |
|
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
598 |
>>> js_href('alert("babar");') |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
599 |
'javascript: alert("babar");' |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
600 |
>>> js_href('alert("%babar");') |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
601 |
'javascript: alert("%25babar");' |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
602 |
>>> js_href('alert("%toto %babar");') |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
603 |
'javascript: alert("%toto %25babar");' |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
604 |
>>> js_href('alert("%1337%");') |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
605 |
'javascript: alert("%251337%");' |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
606 |
""" |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
607 |
return 'javascript: ' + PERCENT_IN_URLQUOTE_RE.sub(r'%25', javascript_code) |
9ef285eb20f4
[utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
7990
diff
changeset
|
608 |
|
7575
335f14e8e5a7
[uilib] new js_dumps function allowing usage of bare js string (wrapped into JSString)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
7569
diff
changeset
|
609 |
|
8682
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
610 |
def parse_repo_uri(uri): |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
611 |
""" transform a command line uri into a (protocol, hostport, appid), e.g: |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
612 |
<myapp> -> 'inmemory', None, '<myapp>' |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
613 |
inmemory://<myapp> -> 'inmemory', None, '<myapp>' |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
614 |
""" |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
615 |
parseduri = urlparse(uri) |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
616 |
scheme = parseduri.scheme |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
617 |
if scheme == '': |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
618 |
return ('inmemory', None, parseduri.path) |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
619 |
if scheme == 'inmemory': |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
620 |
return (scheme, None, parseduri.netloc) |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
621 |
raise NotImplementedError('URI protocol not implemented for `%s`' % uri) |
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
622 |
|
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
623 |
|
20bd1cdf86ae
[cwctl] fix cubicweb-ctl shell command (closes #2583919)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7998
diff
changeset
|
624 |
|
7954
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
625 |
logger = getLogger('cubicweb.utils') |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
626 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
627 |
class QueryCache(object): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
628 |
""" a minimalist dict-like object to be used by the querier |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
629 |
and native source (replaces lgc.cache for this very usage) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
630 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
631 |
To be efficient it must be properly used. The usage patterns are |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
632 |
quite specific to its current clients. |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
633 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
634 |
The ceiling value should be sufficiently high, else it will be |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
635 |
ruthlessly inefficient (there will be warnings when this happens). |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
636 |
A good (high enough) value can only be set on a per-application |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
637 |
value. A default, reasonnably high value is provided but tuning |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
638 |
e.g `rql-cache-size` can certainly help. |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
639 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
640 |
There are two kinds of elements to put in this cache: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
641 |
* frequently used elements |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
642 |
* occasional elements |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
643 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
644 |
The former should finish in the _permanent structure after some |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
645 |
warmup. |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
646 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
647 |
Occasional elements can be buggy requests (server-side) or |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
648 |
end-user (web-ui provided) requests. These have to be cleaned up |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
649 |
when they fill the cache, without evicting the usefull, frequently |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
650 |
used entries. |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
651 |
""" |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
652 |
# quite arbitrary, but we want to never |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
653 |
# immortalize some use-a-little query |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
654 |
_maxlevel = 15 |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
655 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
656 |
def __init__(self, ceiling=3000): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
657 |
self._max = ceiling |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
658 |
# keys belonging forever to this cache |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
659 |
self._permanent = set() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
660 |
# mapping of key (that can get wiped) to getitem count |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
661 |
self._transient = {} |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
662 |
self._data = {} |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
663 |
self._lock = Lock() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
664 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
665 |
def __len__(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
666 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
667 |
return len(self._data) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
668 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
669 |
def __getitem__(self, k): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
670 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
671 |
if k in self._permanent: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
672 |
return self._data[k] |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
673 |
v = self._transient.get(k, _MARKER) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
674 |
if v is _MARKER: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
675 |
self._transient[k] = 1 |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
676 |
return self._data[k] |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
677 |
if v > self._maxlevel: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
678 |
self._permanent.add(k) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
679 |
self._transient.pop(k, None) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
680 |
else: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
681 |
self._transient[k] += 1 |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
682 |
return self._data[k] |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
683 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
684 |
def __setitem__(self, k, v): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
685 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
686 |
if len(self._data) >= self._max: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
687 |
self._try_to_make_room() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
688 |
self._data[k] = v |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
689 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
690 |
def pop(self, key, default=_MARKER): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
691 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
692 |
try: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
693 |
if default is _MARKER: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
694 |
return self._data.pop(key) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
695 |
return self._data.pop(key, default) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
696 |
finally: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
697 |
if key in self._permanent: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
698 |
self._permanent.remove(key) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
699 |
else: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
700 |
self._transient.pop(key, None) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
701 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
702 |
def clear(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
703 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
704 |
self._clear() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
705 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
706 |
def _clear(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
707 |
self._permanent = set() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
708 |
self._transient = {} |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
709 |
self._data = {} |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
710 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
711 |
def _try_to_make_room(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
712 |
current_size = len(self._data) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
713 |
items = sorted(self._transient.items(), key=itemgetter(1)) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
714 |
level = 0 |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
715 |
for k, v in items: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
716 |
self._data.pop(k, None) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
717 |
self._transient.pop(k, None) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
718 |
if v > level: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
719 |
datalen = len(self._data) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
720 |
if datalen == 0: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
721 |
return |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
722 |
if (current_size - datalen) / datalen > .1: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
723 |
break |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
724 |
level = v |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
725 |
else: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
726 |
# we removed cruft but everything is permanent |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
727 |
if len(self._data) >= self._max: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
728 |
logger.warning('Cache %s is full.' % id(self)) |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
729 |
self._clear() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
730 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
731 |
def _usage_report(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
732 |
with self._lock: |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
733 |
return {'itemcount': len(self._data), |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
734 |
'transientcount': len(self._transient), |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
735 |
'permanentcount': len(self._permanent)} |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
736 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
737 |
def popitem(self): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
738 |
raise NotImplementedError() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
739 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
740 |
def setdefault(self, key, default=None): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
741 |
raise NotImplementedError() |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
742 |
|
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
743 |
def update(self, other): |
a3d3220669d6
[cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
7876
diff
changeset
|
744 |
raise NotImplementedError() |