web/views/facets.py
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 14 Oct 2011 09:21:45 +0200
changeset 7953 a37531c8a4a6
parent 7949 ce64860b3cdc
parent 7939 e107204d3b27
child 7956 db49658b2812
permissions -rw-r--r--
merge and fix cubicwebSortValueExtraction pb which disappeared when tablesorter.js has been updated
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7402
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
     1
# copyright 2003-2011 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/>.
5940
0e3ae19b181a [uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5424
diff changeset
    18
"""the facets box and some basic facets"""
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    19
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    20
__docformat__ = "restructuredtext en"
6582
8eb7883b4223 [pylint] fix a bug of pylint detected errors and i18n pb (calling builtins._ instead of req._)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6463
diff changeset
    21
_ = unicode
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    22
2312
af4d8f75c5db use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2283
diff changeset
    23
from logilab.mtconverter import xml_escape
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    24
2657
de974465d381 [appobject] kill VObject class, move base selector classes to appobject
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2650
diff changeset
    25
from cubicweb.appobject import objectify_selector
4320
4efd4c306746 closes #345410: two_lines_rset, two_cols_rset, two_etypes_rset are badly named
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4252
diff changeset
    26
from cubicweb.selectors import (non_final_entity, multi_lines_rset,
1132
96752791c2b6 pylint cleanup
sylvain.thenault@logilab.fr
parents: 758
diff changeset
    27
                                match_context_prop, yes, relation_possible)
5940
0e3ae19b181a [uilib] refactor json_dumps code organization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5424
diff changeset
    28
from cubicweb.utils import json_dumps
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    29
from cubicweb.web import component, facet as facetbase
7936
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    30
from cubicweb.rqlrewrite import add_types_restriction
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    31
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    32
def facets(req, rset, context, mainvar=None):
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    33
    """return the base rql and a list of widgets for facets applying to the
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    34
    given rset/context (cached version of :func:`_facet`)
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    35
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    36
    :param req: A :class:`~cubicweb.req.RequestSessionBase` object
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    37
    :param rset: A :class:`~cubicweb.rset.ResultSet`
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    38
    :param context: A string that match the ``__regid__`` of a ``FacetFilter``
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    39
    :param mainvar: A string that match a select var from the rset
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    40
    """
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    41
    try:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    42
        cache = req.__rset_facets
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    43
    except AttributeError:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    44
        cache = req.__rset_facets = {}
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    45
    try:
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    46
        return cache[(rset, context, mainvar)]
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    47
    except KeyError:
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    48
        facets = _facets(req, rset, context, mainvar)
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    49
        cache[(rset, context, mainvar)] = facets
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    50
        return facets
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    51
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    52
def _facets(req, rset, context, mainvar):
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    53
    """return the base rql and a list of widgets for facets applying to the
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    54
    given rset/context
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    55
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    56
    :param req: A :class:`~cubicweb.req.RequestSessionBase` object
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    57
    :param rset: A :class:`~cubicweb.rset.ResultSet`
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    58
    :param context: A string that match the ``__regid__`` of a ``FacetFilter``
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    59
    :param mainvar: A string that match a select var from the rset
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    60
    """
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    61
    ### initialisation
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    62
    # XXX done by selectors, though maybe necessary when rset has been hijacked
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    63
    # (e.g. contextview_selector matched)
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    64
    origqlst = rset.syntax_tree()
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    65
    # union not yet supported
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    66
    if len(origqlst.children) != 1:
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    67
        req.debug('facette disabled on union request %s', origqlst)
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    68
        return None, ()
7936
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    69
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    70
    # Add type restriction to rql. This allow the get_type() method to return
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    71
    # useful value on variable extracted from a select statement.
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    72
    #
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    73
    # This is done on origqlst to ensure all rql related objects are properly
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    74
    # enriched when handled by a Facet:
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    75
    #    - the rset.syntax_tree() during selection
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    76
    #    - the select during selection
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    77
    #    - the select during filtering
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    78
82d76492e21e [facet] Add infered type restriction to Filtered result set (closes #1988776)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    79
    add_types_restriction(req.vreg.schema, origqlst.children[0])
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    80
    rqlst = origqlst.copy()
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    81
    select = rqlst.children[0]
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    82
    filtered_variable, baserql = facetbase.init_facets(rset, select, mainvar)
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    83
    ### Selection
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    84
    possible_facets = req.vreg['facets'].poss_visible_objects(
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    85
                        req,
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    86
                        rset=rset,
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    87
                        rqlst=origqlst,
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    88
                        select=select,
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    89
                        context=context,
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    90
                        filtered_variable=filtered_variable)
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
    91
    wdgs = [(facet, facet.get_widget()) for facet in possible_facets]
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
    92
    return baserql, [wdg for facet, wdg in wdgs if wdg is not None]
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
    93
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    94
742
99115e029dca replaced most of __selectors__ assignments with __select__
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 692
diff changeset
    95
@objectify_selector
2161
200481e7b156 prepare time where it won't be mandatory to give rset to select()
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 1977
diff changeset
    96
def contextview_selector(cls, req, rset=None, row=None, col=None, view=None,
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
    97
                         **kwargs):
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
    98
    if view:
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
    99
        try:
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   100
            getcontext = getattr(view, 'filter_box_context_info')
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   101
        except AttributeError:
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   102
            return 0
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   103
        rset = getcontext()[0]
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   104
        if rset is None or rset.rowcount < 2:
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   105
            return 0
7664
e286216515d6 unsaved change...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7663
diff changeset
   106
        wdgs = facets(req, rset, cls.__regid__)[1]
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   107
        return len(wdgs)
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   108
    return 0
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   109
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   110
@objectify_selector
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
   111
def has_facets(cls, req, rset=None, mainvar=None, **kwargs):
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   112
    if rset is None or rset.rowcount < 2:
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   113
        return 0
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   114
    wdgs = facets(req, rset, cls.__regid__, mainvar)[1]
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   115
    return len(wdgs)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   116
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   117
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   118
def filter_hiddens(w, baserql, wdgs, **kwargs):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   119
    kwargs['facets'] = ','.join(wdg.facet.__regid__ for wdg in wdgs)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   120
    kwargs['baserql'] = baserql
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   121
    for key, val in kwargs.items():
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   122
        w(u'<input type="hidden" name="%s" value="%s" />' % (
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   123
            key, xml_escape(val)))
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   124
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   125
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   126
class FacetFilterMixIn(object):
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   127
    """Mixin Class to generate Facet Filter Form
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   128
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   129
    To generate the form, you need to explicitly the following methode with the
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   130
    right argument:
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   131
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   132
    .. automethod:: generate_form
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   133
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   134
    The most useful function to overwrite is:
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   135
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   136
    .. automethod:: layout_widgets
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   137
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   138
    """
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   139
    needs_js = ['cubicweb.ajax.js', 'cubicweb.facets.js']
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   140
    needs_css = ['cubicweb.facets.css']
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   141
    roundcorners = True
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   142
7949
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   143
    def generate_form(self, w, rset, divid, vid, vidargs=None,
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   144
                      paginate=False, cssclass='', **hiddens):
7937
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   145
        """display a form to filter some view's content
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   146
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   147
        :param w:        Write function
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   148
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   149
        :param rset:     ResultSet to be filtered
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   150
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   151
        :param divid:    Dom ID of the div where the rendering of the view is done.
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   152
        :type divid:     string
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   153
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   154
        :param vid:      ID of the view display in the div
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   155
        :type vid:       string
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   156
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   157
        :param paginate: Is the view paginated ?
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   158
        :type paginate:  boolean
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   159
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   160
        :param cssclass: Additional css classes to put on the form.
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   161
        :type cssclass:  string
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   162
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   163
        :param hiddens:  other hidden parametters to include in the forms.
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   164
        :type hiddens:   dict from extra keyword argument
3453c5f0db21 [facets] FacetFilterMixIn: add documention for class and generate_form
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7849
diff changeset
   165
        """
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
   166
        mainvar = self.cw_extra_kwargs.get('mainvar')
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
   167
        baserql, wdgs = facets(self._cw, rset, self.__regid__, mainvar)
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   168
        assert wdgs
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   169
        self._cw.add_js(self.needs_js)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   170
        self._cw.add_css(self.needs_css)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   171
        self._cw.html_headers.define_var('facetLoadingMsg',
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   172
                                         self._cw._('facet-loading-msg'))
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   173
        if self.roundcorners:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   174
            self._cw.html_headers.add_onload(
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   175
                'jQuery(".facet").corner("tl br 10px");')
7949
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   176
        if vidargs is not None:
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   177
            warn("[3.14] vidargs is deprecated. Maybe you're using some TableView?",
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   178
                 DeprecationWarning, stacklevel=2)
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   179
        else:
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   180
            vidargs = {}
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   181
        vidargs = dict((k, v) for k, v in vidargs.iteritems() if v)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   182
        facetargs = xml_escape(json_dumps([divid, vid, paginate, vidargs]))
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   183
        w(u'<form id="%sForm" class="%s" method="post" action="" '
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   184
          'cubicweb:facetargs="%s" >' % (divid, cssclass, facetargs))
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   185
        w(u'<fieldset>')
7606
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
   186
        if mainvar:
01b49ec8fe80 [facets] allow to specify on which rqlst's variable facets should be applied. Closes #1795915
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7605
diff changeset
   187
            hiddens['mainvar'] = mainvar
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   188
        filter_hiddens(w, baserql, wdgs, **hiddens)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   189
        self.layout_widgets(w, self.sorted_widgets(wdgs))
7939
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   190
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   191
        # <Enter> is supposed to submit the form only if there is a single
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   192
        # input:text field. However most browsers will submit the form
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   193
        # on <Enter> anyway if there is an input:submit field.
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   194
        #
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   195
        # see: http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   196
        #
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   197
        # Firefox 7.0.1 does not submit form on <Enter> if there is more than a
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   198
        # input:text field and not input:submit but does it if there is an
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   199
        # input:submit.
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   200
        #
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   201
        # IE 6 or Firefox 2 behave the same way.
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   202
        w(u'<input type="submit" class="hidden" />')
e107204d3b27 Add a hidden input:submit field in facets form (closes #1988784)
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 7936
diff changeset
   203
        #
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   204
        w(u'</fieldset>\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   205
        w(u'</form>\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   206
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   207
    def sorted_widgets(self, wdgs):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   208
        """sort widgets: by default sort by widget height, then according to
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   209
        widget.order (the original widgets order)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   210
        """
7943
ad0581296e2c [facets] try to get rid of arbitrary constants, be prettier and eat less space (closes #1988706)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7937
diff changeset
   211
        return sorted(wdgs, key=lambda x: x.height)
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   212
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   213
    def layout_widgets(self, w, wdgs):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   214
        """layout widgets: by default simply render each of them
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   215
        (i.e. succession of <div>)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   216
        """
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   217
        for wdg in wdgs:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   218
            wdg.render(w=w)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   219
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   220
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   221
class FilterBox(FacetFilterMixIn, component.CtxComponent):
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   222
    """filter results of a query"""
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   223
    __regid__ = 'facet.filterbox'
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   224
    __select__ = ((non_final_entity() & has_facets())
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   225
                  | contextview_selector()) # can't use has_facets because of
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   226
                                            # contextview mecanism
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6040
diff changeset
   227
    context = 'left' # XXX doesn't support 'incontext', only 'left' or 'right'
6463
67b0ad068f5d i18n update
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6427
diff changeset
   228
    title = _('facet.filters')
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   229
    visible = True # functionality provided by the search box by default
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   230
    order = 1
2214
a6b42cf05407 [facets] slightly better attr names
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2213
diff changeset
   231
2325
363b66a15668 [cleaning] minor cleaning over last two checkins
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 2323
diff changeset
   232
    bk_linkbox_template = u'<div class="facetTitle">%s</div>'
2283
dc13ec07a70a cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2260
diff changeset
   233
7614
40f33b3d3ea6 [facetbox] put the facet box in a box
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7610
diff changeset
   234
    def render_body(self, w, **kwargs):
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   235
        req = self._cw
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   236
        rset, vid, divid, paginate = self._get_context()
7663
fb2501d29587 [facets] closes #1827464: facet box always appear
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7614
diff changeset
   237
        assert len(rset) > 1
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   238
        if vid is None:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   239
            vid = req.form.get('vid')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   240
        if self.bk_linkbox_template and req.vreg.schema['Bookmark'].has_perm(req, 'add'):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   241
            w(self.bookmark_link(rset))
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   242
        hiddens = {}
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   243
        for param in ('subvid', 'vtitle'):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   244
            if param in req.form:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   245
                hiddens[param] = req.form[param]
7949
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   246
        self.generate_form(w, rset, divid, vid, paginate=paginate, **hiddens)
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   247
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6040
diff changeset
   248
    def _get_context(self):
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6040
diff changeset
   249
        view = self.cw_extra_kwargs.get('view')
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   250
        context = getattr(view, 'filter_box_context_info', lambda: None)()
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   251
        if context:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   252
            rset, vid, divid, paginate = context
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   253
        else:
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   254
            rset = self.cw_rset
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   255
            vid, divid = None, 'pageContent'
4244
2c3de1953d00 rename need_navigation into paginable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4212
diff changeset
   256
            paginate = view and view.paginable
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   257
        return rset, vid, divid, paginate
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   258
6040
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   259
    def bookmark_link(self, rset):
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   260
        req = self._cw
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   261
        bk_path = u'rql=%s' % req.url_quote(rset.printable_rql())
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   262
        if req.form.get('vid'):
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   263
            bk_path += u'&vid=%s' % req.url_quote(req.form['vid'])
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   264
        bk_path = u'view?' + bk_path
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   265
        bk_title = req._('my custom search')
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   266
        linkto = u'bookmarked_by:%s:subject' % req.user.eid
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   267
        bkcls = req.vreg['etypes'].etype_class('Bookmark')
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   268
        bk_add_url = bkcls.cw_create_url(req, path=bk_path, title=bk_title,
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   269
                                         __linkto=linkto)
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   270
        bk_base_url = bkcls.cw_create_url(req, title=bk_title, __linkto=linkto)
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   271
        bk_link = u'<a cubicweb:target="%s" id="facetBkLink" href="%s">%s</a>' % (
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   272
                xml_escape(bk_base_url), xml_escape(bk_add_url),
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   273
                req._('bookmark this search'))
9ae260b2d1c4 [facet] refactor bookmark this search link creation: check perm before calling the method, and use the new create url factory
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5940
diff changeset
   274
        return self.bk_linkbox_template % bk_link
2260
080167dad19e split FilterBox call function
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2215
diff changeset
   275
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   276
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   277
from cubicweb.view import AnyRsetView
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   278
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   279
class FilterTable(FacetFilterMixIn, AnyRsetView):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   280
    __regid__ = 'facet.filtertable'
7610
838a0c910bb5 [selectors, facet] make is_instance and other EClassSelector subclass gather entity classes from 'select' and 'filtered_variable' context information. Closes #1796732
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7606
diff changeset
   281
    __select__ = has_facets()
7842
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   282
    compact_layout_threshold = 5
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   283
7949
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   284
    def call(self, vid, divid, vidargs=None, cssclass=''):
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   285
        self.generate_form(self.w, self.cw_rset, divid, vid, vidargs=vidargs,
ce64860b3cdc [facets] on the way to vidargs removal
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7943
diff changeset
   286
                           cssclass=cssclass, fromformfilter='1')
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   287
7842
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   288
    def _simple_horizontal_layout(self, w, wdgs):
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   289
        w(u'<table class="filter">\n')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   290
        w(u'<tr>\n')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   291
        for wdg in wdgs:
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   292
            w(u'<td>')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   293
            wdg.render(w=w)
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   294
            w(u'</td>')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   295
        w(u'</tr>\n')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   296
        w(u'</table>\n')
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   297
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   298
    def layout_widgets(self, w, wdgs):
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   299
        """layout widgets: put them in a table where each column should have
7943
ad0581296e2c [facets] try to get rid of arbitrary constants, be prettier and eat less space (closes #1988706)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7937
diff changeset
   300
        sum(wdg.height) < wdg_stack_size.
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   301
        """
7842
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   302
        if len(wdgs) < self.compact_layout_threshold:
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   303
            self._simple_horizontal_layout(w, wdgs)
fa7e463cae9d [views/facets] simple horizontal layout when there are a few facets only (closes #1921709)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7664
diff changeset
   304
            return
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   305
        w(u'<table class="filter">\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   306
        widget_queue = []
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   307
        queue_height = 0
7943
ad0581296e2c [facets] try to get rid of arbitrary constants, be prettier and eat less space (closes #1988706)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7937
diff changeset
   308
        wdg_stack_size = max(wdgs, key=lambda wdg:wdg.height).height
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   309
        w(u'<tr>\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   310
        for wdg in wdgs:
7943
ad0581296e2c [facets] try to get rid of arbitrary constants, be prettier and eat less space (closes #1988706)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7937
diff changeset
   311
            height = wdg.height
7849
7937cf60f2ce [facets] fix height computation (incorporates and/or element if present, use css value to compute likely maximum height, kill wdg_stack_size) (closes #1954077)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7842
diff changeset
   312
            if queue_height + height <= wdg_stack_size:
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   313
                widget_queue.append(wdg)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   314
                queue_height += height
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   315
                continue
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   316
            w(u'<td>')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   317
            for queued in widget_queue:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   318
                queued.render(w=w)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   319
            w(u'</td>')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   320
            widget_queue = [wdg]
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   321
            queue_height = height
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   322
        if widget_queue:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   323
            w(u'<td>')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   324
            for queued in widget_queue:
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   325
                queued.render(w=w)
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   326
            w(u'</td>')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   327
        w(u'</tr>\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   328
        w(u'</table>\n')
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   329
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   330
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   331
# facets ######################################################################
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   332
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   333
class CWSourceFacet(facetbase.RelationFacet):
6427
c8a5ac2d1eaa [schema / sources] store data sources as cubicweb entities
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6141
diff changeset
   334
    __regid__ = 'cw_source-facet'
c8a5ac2d1eaa [schema / sources] store data sources as cubicweb entities
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6141
diff changeset
   335
    rtype = 'cw_source'
c8a5ac2d1eaa [schema / sources] store data sources as cubicweb entities
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6141
diff changeset
   336
    target_attr = 'name'
c8a5ac2d1eaa [schema / sources] store data sources as cubicweb entities
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6141
diff changeset
   337
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   338
class CreatedByFacet(facetbase.RelationFacet):
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3023
diff changeset
   339
    __regid__ = 'created_by-facet'
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   340
    rtype = 'created_by'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   341
    target_attr = 'login'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   342
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   343
class InGroupFacet(facetbase.RelationFacet):
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3023
diff changeset
   344
    __regid__ = 'in_group-facet'
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   345
    rtype = 'in_group'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   346
    target_attr = 'name'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   347
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   348
class InStateFacet(facetbase.RelationAttributeFacet):
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3023
diff changeset
   349
    __regid__ = 'in_state-facet'
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   350
    rtype = 'in_state'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   351
    target_attr = 'name'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   352
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   353
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   354
# inherit from RelationFacet to benefit from its possible_values implementation
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   355
class ETypeFacet(facetbase.RelationFacet):
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3023
diff changeset
   356
    __regid__ = 'etype-facet'
742
99115e029dca replaced most of __selectors__ assignments with __select__
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 692
diff changeset
   357
    __select__ = yes()
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   358
    order = 1
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   359
    rtype = 'is'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   360
    target_attr = 'name'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   361
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   362
    @property
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   363
    def title(self):
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   364
        return self._cw._('entity type')
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   365
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   366
    def vocabulary(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   367
        """return vocabulary for this facet, eg a list of 2-uple (label, value)
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   368
        """
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   369
        etypes = self.cw_rset.column_types(0)
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   370
        return sorted((self._cw._(etype), etype) for etype in etypes)
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   371
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   372
    def add_rql_restrictions(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   373
        """add restriction for this facet into the rql syntax tree"""
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   374
        value = self._cw.form.get(self.__regid__)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   375
        if not value:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   376
            return
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   377
        self.select.add_type_restriction(self.filtered_variable, value)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   378
2337
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   379
    def possible_values(self):
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   380
        """return a list of possible values (as string since it's used to
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   381
        compare to a form value in javascript) for this facet
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   382
        """
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   383
        select = self.select
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   384
        select.save_state()
2337
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   385
        try:
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   386
            facetbase.cleanup_select(select, self.filtered_variable)
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   387
            etype_var = facetbase.prepare_vocabulary_select(
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   388
                select, self.filtered_variable, self.rtype, self.role)
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   389
            attrvar = select.make_variable()
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   390
            select.add_selected(attrvar)
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   391
            select.add_relation(etype_var, 'name', attrvar)
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   392
            return [etype for _, etype in self.rqlexec(select.as_string())]
2337
6620e5abcd99 select right possible_values for ETypeFacet
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 2323
diff changeset
   393
        finally:
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   394
            select.recover()
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   395
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   396
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   397
class HasTextFacet(facetbase.AbstractFacet):
742
99115e029dca replaced most of __selectors__ assignments with __select__
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 692
diff changeset
   398
    __select__ = relation_possible('has_text', 'subject') & match_context_prop()
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3023
diff changeset
   399
    __regid__ = 'has_text-facet'
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   400
    rtype = 'has_text'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   401
    role = 'subject'
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   402
    order = 0
7402
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
   403
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
   404
    @property
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
   405
    def wdgclass(self):
7600
75d208ab8444 [facets] factorize table filter form / facets box generation, moving out filter form from the table view so it's usable from other views. Closes #1794009
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7402
diff changeset
   406
        return facetbase.FacetStringWidget
7402
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
   407
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   408
    @property
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   409
    def title(self):
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   410
        return self._cw._('has_text')
1802
d628defebc17 delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 1132
diff changeset
   411
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   412
    def get_widget(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   413
        """return the widget instance to use to display this facet
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   414
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   415
        default implentation expects a .vocabulary method on the facet and
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   416
        return a combobox displaying this vocabulary
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   417
        """
7402
826e5663a686 [facets/table] vertically group facets by two when possible in order to have a more compact horizontal layout in table filter form
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 7300
diff changeset
   418
        return self.wdgclass(self)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   419
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   420
    def add_rql_restrictions(self):
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   421
        """add restriction for this facet into the rql syntax tree"""
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   422
        value = self._cw.form.get(self.__regid__)
0
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   423
        if not value:
b97547f5f1fa Showtime !
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
diff changeset
   424
            return
7605
48abeac162fd [facets] refactor / cleanup facet api: more consistent variable naming and easier to reuse function. Closes #1796804
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7600
diff changeset
   425
        self.select.add_constant_restriction(self.filtered_variable, 'has_text', value, 'String')