cubicweb/utils.py
author Laurent Peuch <cortex@worlddomination.be>
Tue, 26 Nov 2019 20:26:58 +0100
changeset 12777 7c4216ed7497
parent 12753 38d24fb2ae48
permissions -rw-r--r--
[debug-toolbar/display_source_code] add links to files in tracebacks
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
11715
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
    22
import base64
3316
c4c07aab1c39 backport old head
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3231 3155
diff changeset
    23
import decimal
4466
8b0ca7904820 moved generic datetime manipulation function to lgc
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4335
diff changeset
    24
import datetime
4653
ca11228a5268 import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4652
diff changeset
    25
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
    26
import re
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
    27
import json
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
    28
from operator import itemgetter
12567
26744ad37953 Drop python2 support
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12542
diff changeset
    29
from inspect import getfullargspec as 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
    30
from itertools import repeat
4833
41a78fb4107c 3.7 depends on python >= 2.5
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4693
diff changeset
    31
from uuid import uuid4
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
    32
from threading import Lock
10603
65ad6980976e [py3k] import URL mangling functions using six.moves
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10510
diff changeset
    33
from logging import getLogger
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
    34
4653
ca11228a5268 import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4652
diff changeset
    35
from logilab.mtconverter import xml_escape
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
    36
from logilab.common.date import ustrftime
1549
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
    37
11715
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
    38
from cubicweb import Binary
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
    39
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
    40
4830
10e8bc190695 [javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 4693
diff changeset
    41
_MARKER = object()
10e8bc190695 [javascript] fix #736185: add_onload / jQuery.bind() vs. jQuery.one()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 4693
diff changeset
    42
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
    43
# initialize random seed from current time
4653
ca11228a5268 import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4652
diff changeset
    44
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
    45
12046
9056a41d91ba Fix flake8 some errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 12044
diff changeset
    46
10118
78ab2b14048a [utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 10090
diff changeset
    47
def admincnx(appid):
12044
70bb46dfa87b [repo] Drop repo.new_session method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 12032
diff changeset
    48
    from cubicweb import repoapi
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
    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
    50
    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
    51
    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
    52
78ab2b14048a [utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 10090
diff changeset
    53
    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
    54
    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
    55
11984
55f57038e553 [utils] Do not pass a tasks manager to Repository in admincnx()
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11983
diff changeset
    56
    repo = Repository(config)
11983
5de78b6fff2e [server] Separate repository bootstrap from initialization
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11909
diff changeset
    57
    repo.bootstrap()
12044
70bb46dfa87b [repo] Drop repo.new_session method
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 12032
diff changeset
    58
    return repoapi.connect(repo, login, password=password)
10118
78ab2b14048a [utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 10090
diff changeset
    59
78ab2b14048a [utils] provide a function to return an admin connection from an appid
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 10090
diff changeset
    60
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
    61
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
    62
    """Return a unique identifier string.
4653
ca11228a5268 import cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4652
diff changeset
    63
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
    64
    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
    65
    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
    66
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
    67
    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
    68
    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
    69
    """
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
    70
    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
    71
        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
    72
    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
    73
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    74
6067
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6044
diff changeset
    75
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
    76
    """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
    77
    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
    78
        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
    79
    argspec = getargspec(callable)
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6044
diff changeset
    80
    if argspec[2]:
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6044
diff changeset
    81
        return True
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6044
diff changeset
    82
    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
    83
        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
    84
            return False
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6044
diff changeset
    85
    return True
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    86
6141
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
    87
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
    88
class wrap_on_write(object):
6580
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    89
    """ Sometimes it is convenient to NOT write some container element
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    90
    if it happens that there is nothing to be written within,
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    91
    but this cannot be known beforehand.
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    92
    Hence one can do this:
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    93
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    94
    .. sourcecode:: python
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
       with wrap_on_write(w, '<div class="foo">', '</div>') as wow:
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    97
           component.render_stuff(wow)
798200432f50 some docstrings
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6492
diff changeset
    98
    """
6141
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
    99
    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
   100
        self.written = False
12567
26744ad37953 Drop python2 support
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12542
diff changeset
   101
        self.tag = tag
6141
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.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
   103
        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
   104
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
   105
    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
   106
        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
   107
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
   108
    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
   109
        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
   110
            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
   111
            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
   112
        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
   113
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
   114
    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
   115
        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
   116
            if self.closetag:
12567
26744ad37953 Drop python2 support
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12542
diff changeset
   117
                self.w(self.closetag)
6141
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6067
diff changeset
   118
            else:
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(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
   120
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   121
3882
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   122
# use networkX instead ?
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   123
# http://networkx.lanl.gov/reference/algorithms.traversal.html#module-networkx.algorithms.traversal.astar
6854
ffc982faa264 [views] delete ``permission`` tab in ``SchemaView``
cheb
parents: 6684
diff changeset
   124
def transitive_closure_of(entity, rtype, _seen=None):
4317
b2093f8f0493 some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4212
diff changeset
   125
    """return transitive closure *for the subgraph starting from the given
b2093f8f0493 some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4212
diff changeset
   126
    entity* (eg 'parent' entities are not included in the results)
b2093f8f0493 some docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4212
diff changeset
   127
    """
3882
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   128
    if _seen is None:
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   129
        _seen = set()
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   130
    _seen.add(entity.eid)
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   131
    yield entity
6854
ffc982faa264 [views] delete ``permission`` tab in ``SchemaView``
cheb
parents: 6684
diff changeset
   132
    for child in getattr(entity, rtype):
3882
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   133
        if child.eid in _seen:
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   134
            continue
6854
ffc982faa264 [views] delete ``permission`` tab in ``SchemaView``
cheb
parents: 6684
diff changeset
   135
        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
   136
            yield subchild
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   137
addc715f4fcd backported from confman
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3851
diff changeset
   138
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
   139
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
   140
    """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
   141
    __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
   142
    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
   143
        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
   144
        self._item = item
5883
7a5f370c5be1 [utils] improve repr() of RepeatList
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5726
diff changeset
   145
    def __repr__(self):
7a5f370c5be1 [utils] improve repr() of RepeatList
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 5726
diff changeset
   146
        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
   147
            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
   148
    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
   149
        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
   150
    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
   151
        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
   152
    def __getitem__(self, index):
10691
af266f27c4d5 [py3k] __getslice__ → __getitem__ with slice support
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10690
diff changeset
   153
        if isinstance(index, slice):
af266f27c4d5 [py3k] __getslice__ → __getitem__ with slice support
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10690
diff changeset
   154
            # XXX could be more efficient, but do we bother?
af266f27c4d5 [py3k] __getslice__ → __getitem__ with slice support
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10690
diff changeset
   155
            return ([self._item] * self._size)[index]
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
   156
        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
   157
    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
   158
        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
   159
        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
   160
    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
   161
        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
   162
            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
   163
                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
   164
            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
   165
        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
   166
    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
   167
        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
   168
            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
   169
                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
   170
            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
   171
        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
   172
    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
   173
        if isinstance(other, RepeatList):
6492
47a284c0d012 fix some pylint detected errors
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6448
diff changeset
   174
            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
   175
        return self[:] == other
10661
e6eb0c7c2e98 implement __ne__ whenever we implement __eq__
Julien Cristau <julien.cristau@logilab.fr>
parents: 10603
diff changeset
   176
    def __ne__(self, other):
e6eb0c7c2e98 implement __ne__ whenever we implement __eq__
Julien Cristau <julien.cristau@logilab.fr>
parents: 10603
diff changeset
   177
        return not (self == other)
e6eb0c7c2e98 implement __ne__ whenever we implement __eq__
Julien Cristau <julien.cristau@logilab.fr>
parents: 10603
diff changeset
   178
    def __hash__(self):
e6eb0c7c2e98 implement __ne__ whenever we implement __eq__
Julien Cristau <julien.cristau@logilab.fr>
parents: 10603
diff changeset
   179
        raise NotImplementedError
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
   180
    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
   181
        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
   182
6684
b8bd0ecced2e minor cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6580
diff changeset
   183
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   184
class UStringIO(list):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   185
    """a file wrapper which automatically encode unicode string to an encoding
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   186
    specifed in the constructor
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   187
    """
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   188
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
   189
    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
   190
        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
   191
        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
   192
10690
c6290d727c0c [py3k] __nonzero__ → __bool__
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10689
diff changeset
   193
    def __bool__(self):
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   194
        return True
1549
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
   195
10690
c6290d727c0c [py3k] __nonzero__ → __bool__
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10689
diff changeset
   196
    __nonzero__ = __bool__
c6290d727c0c [py3k] __nonzero__ → __bool__
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10689
diff changeset
   197
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   198
    def write(self, 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
   199
        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
   200
            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
   201
            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
   202
            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
   203
            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
   204
            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
   205
            value = tpl % (escaped_stack, escaped_html)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   206
        self.append(value)
1549
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
   207
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   208
    def getvalue(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   209
        return u''.join(self)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   210
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   211
    def __repr__(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   212
        return '<%s at %#x>' % (self.__class__.__name__, id(self))
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   213
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   214
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   215
class HTMLHead(UStringIO):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   216
    """wraps HTML header's stream
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   217
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   218
    Request objects use a HTMLHead instance to ease adding of
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   219
    javascripts and stylesheets
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   220
    """
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
   221
    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
   222
    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
   223
    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
   224
}'''
8941
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   225
    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
   226
    script_closing = u'\n</script>'
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   227
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
   228
    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
   229
        super(HTMLHead, self).__init__(*args, **kwargs)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   230
        self.jsvars = []
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   231
        self.jsfiles = []
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   232
        self.cssfiles = []
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   233
        self.ie_cssfiles = []
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   234
        self.post_inlined_scripts = []
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   235
        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
   236
        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
   237
        self.datadir_url = req.datadir_url
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   238
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   239
    def add_raw(self, rawheader):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   240
        self.write(rawheader)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   241
3838
9cc134372bf8 [web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3789
diff changeset
   242
    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
   243
        """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
   244
9cc134372bf8 [web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3789
diff changeset
   245
        :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
   246
        :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
   247
                      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
   248
        :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
   249
                         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
   250
        """
9cc134372bf8 [web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3789
diff changeset
   251
        self.jsvars.append( (var, value, override) )
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   252
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   253
    def add_post_inline_script(self, content):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   254
        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
   255
8795
772cd62e1295 [utils] drop pre-3.7 compat in util
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 8682
diff changeset
   256
    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
   257
        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
   258
%s});""" % jscode)
1549
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
   259
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
   260
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   261
    def add_js(self, jsfile):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   262
        """adds `jsfile` to the list of javascripts used in the webpage
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   263
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   264
        This function checks if the file has already been added
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   265
        :param jsfile: the script's URL
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   266
        """
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   267
        if jsfile not in self.jsfiles:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   268
            self.jsfiles.append(jsfile)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   269
7277
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   270
    def add_css(self, cssfile, media='all'):
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   271
        """adds `cssfile` to the list of javascripts used in the webpage
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   272
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   273
        This function checks if the file has already been added
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   274
        :param cssfile: the stylesheet's URL
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   275
        """
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   276
        if (cssfile, media) not in self.cssfiles:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   277
            self.cssfiles.append( (cssfile, media) )
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   278
4860
cedb6afdb7da [web] fix #736332: iespec functionality for add_css
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 4859
diff changeset
   279
    def add_ie_css(self, cssfile, media='all', iespec=u'[if lt IE 8]'):
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   280
        """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
   281
        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
   282
            self.ie_cssfiles.append( (cssfile, media, iespec) )
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   283
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   284
    def add_unload_pagedata(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   285
        """registers onunload callback to clean page data on server"""
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   286
        if not self.pagedata_unload:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   287
            self.post_inlined_scripts.append(self.js_unload_code)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   288
            self.pagedata_unload = True
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   289
7277
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   290
    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
   291
        """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
   292
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   293
        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
   294
        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
   295
        :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
   296
        """
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   297
        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
   298
            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
   299
        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
   300
        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
   301
        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
   302
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 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
   304
        """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
   305
        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
   306
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   307
        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
   308
        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
   309
        :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
   310
        """
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   311
        concatable = []
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   312
        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
   313
        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
   314
        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
   315
            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
   316
            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
   317
                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
   318
                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
   319
            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
   320
                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
   321
            else:
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   322
                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
   323
            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
   324
            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
   325
        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
   326
            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
   327
acd7f0e9f276 [etwist] Generates apache's mod_concat-like urls for js and css
Quentin Roquefort <roquefort.quentin@gmail.com>
parents: 7187
diff changeset
   328
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
   329
    def getvalue(self, skiphead=False):
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   330
        """reimplement getvalue to provide a consistent (and somewhat browser
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   331
        optimzed cf. http://stevesouders.com/cuzillion) order in external
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   332
        resources declaration
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   333
        """
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   334
        w = self.write
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   335
        # 1/ variable declaration if any
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   336
        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
   337
            if skiphead:
0095961df66c [utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10118
diff changeset
   338
                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
   339
            else:
0095961df66c [utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10118
diff changeset
   340
                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
   341
            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
   342
                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
   343
                if not override:
9cc134372bf8 [web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3789
diff changeset
   344
                    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
   345
                               (var, vardecl))
9cc134372bf8 [web] safety belt to avoid overriding pageid with loadxhtml()
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3789
diff changeset
   346
                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
   347
            if skiphead:
0095961df66c [utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10118
diff changeset
   348
                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
   349
            else:
0095961df66c [utils] Fix define_var in ajax context (closes #4881301)
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10118
diff changeset
   350
                w(self.script_closing)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   351
        # 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
   352
        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
   353
        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
   354
            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
   355
            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
   356
            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
   357
        else:
a3f9ba4d44eb [web] add option to make resources-concat optional (implements #1910615)
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7660
diff changeset
   358
            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
   359
            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
   360
        for cssfile, media in cssfiles:
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   361
            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
   362
              (media, xml_escape(cssfile)))
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   363
        # 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
   364
        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
   365
            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
   366
                w(u'<!--%s>\n' % iespec)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   367
                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
   368
                  (media, xml_escape(cssfile)))
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   369
            w(u'<![endif]--> \n')
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   370
        # 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
   371
        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
   372
            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
   373
                # 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
   374
                # 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
   375
                # 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
   376
                # `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
   377
                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
   378
                  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
   379
                # 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
   380
                #        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
   381
                #        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
   382
                #            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
   383
                #        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
   384
                #            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
   385
            else:
ede740bd7077 [ajax, IE] rewrite some code to avoid duplicated evaluation with IE
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7575
diff changeset
   386
                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
   387
                  xml_escape(jsfile))
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   388
        # 5/ post inlined scripts (i.e. scripts depending on other JS files)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   389
        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
   390
            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
   391
                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
   392
                    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
   393
                    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
   394
                    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
   395
            else:
8941
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   396
                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
   397
                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
   398
                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
   399
        # 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
   400
        # 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
   401
        # 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
   402
        # 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
   403
        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
   404
        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
   405
            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
   406
            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
   407
        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
   408
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   409
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   410
class HTMLStream(object):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   411
    """represents a HTML page.
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   412
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   413
    This is used my main templates so that HTML headers can be added
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   414
    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
   415
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   416
    HTMLStream uses the (U)StringIO interface to be compliant with
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   417
    existing code.
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   418
    """
1549
f87561822e27 some basic calendar manipulation functions, delete-trailing-whitespace
sylvain.thenault@logilab.fr
parents: 1397
diff changeset
   419
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   420
    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
   421
        self.tracehtml = req.tracehtml
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   422
        # stream for <head>
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   423
        self.head = req.html_headers
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   424
        # 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
   425
        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
   426
        # 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
   427
        self.write = self.body.write
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   428
        self.doctype = u''
8941
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   429
        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
   430
        # 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
   431
        req.main_stream = self
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   432
7187
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   433
    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
   434
        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
   435
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   436
    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
   437
        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
   438
12542
85194bd49119 Drop more deprecated code
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 12508
diff changeset
   439
    def set_doctype(self, doctype):
7187
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   440
        self.doctype = doctype
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   441
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   442
    @property
496f51b92154 [views] extend HTMLStream API to be able to change doctype / xmldecl
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 7140
diff changeset
   443
    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
   444
        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
   445
                         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
   446
        if attrs:
9523
cd5738fc440f [ajax] use a custom tag to handle dynamically loaded js
Julien Cristau <julien.cristau@logilab.fr>
parents: 9279
diff changeset
   447
            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
   448
        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
   449
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   450
    def getvalue(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   451
        """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
   452
        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
   453
            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
   454
                              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
   455
                              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
   456
                              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
   457
                              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
   458
                              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
   459
                              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
   460
                              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
   461
                              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
   462
            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
   463
            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
   464
                    + 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
   465
                    + 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
   466
                    + 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
   467
                    + 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
   468
                    + 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
   469
                    + 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
   470
                    + 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
   471
                    + u'</body>\n</html>')
8941
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   472
        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
   473
                                             self.htmltag,
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   474
                                             self.head.getvalue(),
7b26fe71404f drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 8795
diff changeset
   475
                                             self.body.getvalue())
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   476
5940
0e3ae19b181a [uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5883
diff changeset
   477
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   478
class CubicWebJsonEncoder(json.JSONEncoder):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   479
    """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
   480
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   481
    def default(self, obj):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   482
        if hasattr(obj, '__json_encode__'):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   483
            return obj.__json_encode__()
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   484
        if isinstance(obj, datetime.datetime):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   485
            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
   486
        elif isinstance(obj, datetime.date):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   487
            return ustrftime(obj, '%Y/%m/%d')
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   488
        elif isinstance(obj, datetime.time):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   489
            return obj.strftime('%H:%M:%S')
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   490
        elif isinstance(obj, datetime.timedelta):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   491
            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
   492
        elif isinstance(obj, decimal.Decimal):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   493
            return float(obj)
11715
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
   494
        elif isinstance(obj, Binary):
760d5c0ae08f [utils] Encode Binary value in base64 for JSON export
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11057
diff changeset
   495
            return base64.b64encode(obj.getvalue()).decode('ascii')
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   496
        try:
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   497
            return json.JSONEncoder.default(self, obj)
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   498
        except TypeError:
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   499
            # 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
   500
            # just return None in those cases.
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   501
            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
   502
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   503
def json_dumps(value, **kwargs):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   504
    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
   505
4879
56c16efedc51 deprecates merge_dicts
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4844
diff changeset
   506
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   507
class JSString(str):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   508
    """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
   509
    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
   510
    """
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
   511
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   512
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
   513
    if predictable:
10662
10942ed172de [py3k] dict.iteritems → dict.items
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10661
diff changeset
   514
        it = sorted(d.items())
10258
61dfc689830a [utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents: 10236
diff changeset
   515
    else:
10662
10942ed172de [py3k] dict.iteritems → dict.items
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10661
diff changeset
   516
        it = d.items()
11909
244cd7f407b8 [uilib] Fix incorrect serialization of python dicts into javascript objects
Florent Cayré <florent.cayre@gmail.com>
parents: 11767
diff changeset
   517
    res = [js_dumps(key, predictable) + ': ' + js_dumps(val, predictable)
10258
61dfc689830a [utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents: 10236
diff changeset
   518
           for key, val in it]
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   519
    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
   520
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   521
def _list2js(l, predictable=False):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   522
    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
   523
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   524
def js_dumps(something, predictable=False):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   525
    """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
   526
    :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
   527
    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
   528
9579
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   529
    >>> 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
   530
    '{bar: null, hop: $.hop}'
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   531
    >>> js_dumps({'hop': '$.hop'})
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   532
    '{hop: "$.hop"}'
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   533
    >>> js_dumps({'hip': {'hop': JSString('momo')}})
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   534
    '{hip: {hop: momo}}'
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   535
    """
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   536
    if isinstance(something, dict):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   537
        return _dict2js(something, predictable)
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   538
    if isinstance(something, list):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   539
        return _list2js(something, predictable)
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   540
    if isinstance(something, JSString):
d5b0e1f4c5c5 [utils] the json module is always available
Julien Cristau <julien.cristau@logilab.fr>
parents: 9523
diff changeset
   541
        return something
10258
61dfc689830a [utils] use the "predictable" argument to js_dumps
Julien Cristau <julien.cristau@logilab.fr>
parents: 10236
diff changeset
   542
    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
   543
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
   544
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
   545
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
   546
    """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
   547
9ef285eb20f4 [utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7990
diff changeset
   548
    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
   549
9ef285eb20f4 [utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7990
diff changeset
   550
    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
   551
    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
   552
    ``%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
   553
    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
   554
    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
   555
9ef285eb20f4 [utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7990
diff changeset
   556
    >>> 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
   557
    '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
   558
    >>> 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
   559
    '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
   560
    >>> 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
   561
    '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
   562
    >>> 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
   563
    '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
   564
    """
9ef285eb20f4 [utils] add a ``js_href`` function to generated proper javascript href
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7990
diff changeset
   565
    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
   566
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
   567
12743
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   568
def get_pdb():
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   569
    "return ipdb if its installed, otherwise pdb"
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   570
    try:
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   571
        import ipdb
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   572
    except ImportError:
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   573
        import pdb
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   574
        return pdb
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   575
    else:
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   576
        return ipdb
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   577
a74e77469540 [mod] move get_pdb to utils.py
Laurent Peuch <cortex@worlddomination.be>
parents: 12567
diff changeset
   578
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   579
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
   580
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   581
class QueryCache(object):
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   582
    """ 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
   583
    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
   584
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   585
    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
   586
    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
   587
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   588
    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
   589
    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
   590
    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
   591
    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
   592
    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
   593
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   594
    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
   595
    * frequently used elements
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   596
    * occasional elements
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   597
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   598
    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
   599
    warmup.
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   600
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   601
    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
   602
    end-user (web-ui provided) requests. These have to be cleaned up
10510
51321946da37 Spelling fixes in comments and docstrings
Rémi Cardona <remi.cardona@logilab.fr>
parents: 10258
diff changeset
   603
    when they fill the cache, without evicting the useful, frequently
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   604
    used entries.
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   605
    """
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   606
    # 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
   607
    # 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
   608
    _maxlevel = 15
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   609
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   610
    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
   611
        self._max = ceiling
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   612
        # 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
   613
        self._permanent = set()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   614
        # 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
   615
        self._transient = {}
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   616
        self._data = {}
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   617
        self._lock = Lock()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   618
12753
38d24fb2ae48 [cubicweb/utils] add QueryCache.__contains__() to improve dict-like behavior. Closes #255426
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 12743
diff changeset
   619
    def __contains__(self, key):
38d24fb2ae48 [cubicweb/utils] add QueryCache.__contains__() to improve dict-like behavior. Closes #255426
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 12743
diff changeset
   620
        return key in self._data
38d24fb2ae48 [cubicweb/utils] add QueryCache.__contains__() to improve dict-like behavior. Closes #255426
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 12743
diff changeset
   621
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   622
    def __len__(self):
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   623
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   624
            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
   625
12308
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   626
    def items(self):
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   627
        """Get an iterator over the dictionary's items: (key, value) pairs"""
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   628
        with self._lock:
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   629
            for k, v in self._data.items():
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   630
                yield k, v
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   631
12305
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   632
    def get(self, k, default=None):
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   633
        """Get the value associated to the specified key
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   634
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   635
        :param k: The key to look for
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   636
        :param default: The default value when the key is not found
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   637
        :return: The associated value (or the default value)
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   638
        """
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   639
        try:
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   640
            return self._data[k]
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   641
        except KeyError:
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   642
            return default
9fd7d496e27e [utils] Added new get method to QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12303
diff changeset
   643
12306
c96dd92e480e [utils] Implements __iter__ on QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12305
diff changeset
   644
    def __iter__(self):
c96dd92e480e [utils] Implements __iter__ on QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12305
diff changeset
   645
        with self._lock:
12308
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   646
            for k in iter(self._data):
cbbcfa69a0e7 [utils] Fixes compatiblity of QueryCache with expected dict interface
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12306
diff changeset
   647
                yield k
12306
c96dd92e480e [utils] Implements __iter__ on QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12305
diff changeset
   648
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   649
    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
   650
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   651
            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
   652
                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
   653
            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
   654
            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
   655
                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
   656
                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
   657
            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
   658
                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
   659
                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
   660
            else:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   661
                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
   662
            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
   663
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   664
    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
   665
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   666
            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
   667
                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
   668
            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
   669
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   670
    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
   671
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   672
            try:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   673
                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
   674
                    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
   675
                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
   676
            finally:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   677
                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
   678
                    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
   679
                else:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   680
                    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
   681
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   682
    def clear(self):
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   683
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   684
            self._clear()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   685
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   686
    def _clear(self):
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   687
        self._permanent = set()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   688
        self._transient = {}
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   689
        self._data = {}
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   690
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   691
    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
   692
        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
   693
        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
   694
        level = 0
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   695
        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
   696
            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
   697
            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
   698
            if v > level:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   699
                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
   700
                if datalen == 0:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   701
                    return
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   702
                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
   703
                    break
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   704
                level = v
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   705
        else:
12303
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   706
            # we removed cruft
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   707
            if len(self._data) >= self._max:
12303
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   708
                if len(self._permanent) >= self._max:
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   709
                    # we really are full with permanents => clear
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   710
                    logger.warning('Cache %s is full.' % id(self))
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   711
                    self._clear()
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   712
                else:
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   713
                    # pathological case where _transient was probably empty ...
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   714
                    # drop all non-permanents
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   715
                    to_drop = set(self._data.keys()).difference(self._permanent)
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   716
                    for k in to_drop:
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   717
                        # should not be in _transient
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   718
                        assert k not in self._transient
198cb7d7b4ac [utils] Fixed issue in clearing QueryCache
Laurent Wouters <lwouters@cenotelie.fr>
parents: 12046
diff changeset
   719
                        self._data.pop(k, None)
7954
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   720
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   721
    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
   722
        with self._lock:
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   723
            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
   724
                    '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
   725
                    '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
   726
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   727
    def popitem(self):
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   728
        raise NotImplementedError()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   729
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   730
    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
   731
        raise NotImplementedError()
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   732
a3d3220669d6 [cache] replace lgc.cache with something more appropriate (closes #1921713)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7876
diff changeset
   733
    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
   734
        raise NotImplementedError()