cubicweb: view.py@84b67ae41a0d (annotated)

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	1	# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
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/>.
5528 5d1b2ae7d459 cleanup Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5424 diff changeset	18	"""abstract views and templates classes for CubicWeb web client"""
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"
1999 b9a8f5995658 obsolete methods Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1985 diff changeset	21	_ = unicode
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	22
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	23	from cStringIO import StringIO
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	24	from warnings import warn
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	25
2613 5e19c2bb370e R [all] logilab.common 0.44 provides only deprecated Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2558 diff changeset	26	from logilab.common.deprecation import deprecated
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2217 diff changeset	27	from logilab.mtconverter import xml_escape
4058 b3578583b57b properly escape arguments of user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3973 diff changeset	28
2644 100b81ba3a98 F [view] missing import Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2613 diff changeset	29	from rql import nodes
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	30
1181 620ec8e6ae19 cleanup, various fix to get something working sylvain.thenault@logilab.fr parents: 1144 diff changeset	31	from cubicweb import NotAnEntity
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	32	from cubicweb.selectors import yes, non_final_entity, nonempty_rset, none_rset
2656 a93ae0f6c0ad R [base classes] only AppObject remaning, no more AppRsetObject Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2644 diff changeset	33	from cubicweb.appobject import AppObject
708 b4728112625f move utils from cw.common to cw sylvain.thenault@logilab.fr parents: 707 diff changeset	34	from cubicweb.utils import UStringIO, HTMLStream
6044 9e48ebd5400c [view] use the new magic js object to generate javascript func call for auto reload user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6038 diff changeset	35	from cubicweb.uilib import domid, js
2217 3a8cee8f8778 explicit display_name import Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2207 diff changeset	36	from cubicweb.schema import display_name
5725 b5d595b66c35 [adapters] enhanced warning Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5715 diff changeset	37	from cubicweb.vregistry import classid
633 087e3f1e87c8 more selectors update sylvain.thenault@logilab.fr parents: 632 diff changeset	38
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	39	# robots control
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	40	NOINDEX = u'<meta name="ROBOTS" content="NOINDEX" />'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	41	NOFOLLOW = u'<meta name="ROBOTS" content="NOFOLLOW" />'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	42
6761 84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	43
84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	44	CW_XMLNS = '''[
84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	45	<!ATTLIST html xmlns:cubicweb CDATA #FIXED \'http://www.logilab.org/2008/cubicweb\' >
84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	46	]
84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	47	'''
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	48	CW_XHTML_EXTENSIONS = '''[
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	49	<!ATTLIST html xmlns:cubicweb CDATA #FIXED \'http://www.logilab.org/2008/cubicweb\' >
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	50
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	51	<!ENTITY % coreattrs
522 385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	52	"id ID #IMPLIED
385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	53	class CDATA #IMPLIED
385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	54	style CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	55	title CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	56
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	57	cubicweb:accesskey CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	58	cubicweb:actualrql CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	59	cubicweb:dataurl CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	60	cubicweb:facetName CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	61	cubicweb:facetargs CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	62	cubicweb:fallbackvid CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	63	cubicweb:fname CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	64	cubicweb:initfunc CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	65	cubicweb:inputid CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	66	cubicweb:inputname CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	67	cubicweb:limit CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	68	cubicweb:loadtype CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	69	cubicweb:loadurl CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	70	cubicweb:maxlength CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	71	cubicweb:required CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	72	cubicweb:rooteid CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	73	cubicweb:rql CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	74	cubicweb:size CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	75	cubicweb:sortvalue CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	76	cubicweb:target CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	77	cubicweb:tindex CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	78	cubicweb:tlunit CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	79	cubicweb:type CDATA #IMPLIED
5533 5cb121d4f02f [dtd] add unselimg attribute use by widget for HasRelationFacet Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5528 diff changeset	80	cubicweb:unselimg CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	81	cubicweb:uselabel CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	82	cubicweb:value CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	83	cubicweb:variables CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	84	cubicweb:vid CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	85	cubicweb:wdgtype CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	86	"> ] '''
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	87
1421 77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	88	TRANSITIONAL_DOCTYPE = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" %s>\n' % CW_XHTML_EXTENSIONS
6761 84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	89	TRANSITIONAL_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" %s>\n' % CW_XMLNS
1421 77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	90	STRICT_DOCTYPE = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" %s>\n' % CW_XHTML_EXTENSIONS
6761 84b67ae41a0d [html generation] even when doctype without extension are asked, we should define the xmlns:cubicweb attribute to avoid html validation error during tests (break tests with new calendar view in default branch since it demote to html) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6563 diff changeset	91	STRICT_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" %s>\n' % CW_XMLNS
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	92
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	93	# base view object ############################################################
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	94
2656 a93ae0f6c0ad R [base classes] only AppObject remaning, no more AppRsetObject Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2644 diff changeset	95	class View(AppObject):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	96	"""abstract view class, used as base for every renderable object such
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	97	as views, templates, some components...web
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	98
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	99	A view is instantiated to render a [part of a] result set. View
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	100	subclasses may be parametred using the following class attributes:
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	101
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	102	* `templatable` indicates if the view may be embeded in a main
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	103	template or if it has to be rendered standalone (i.e. XML for
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	104	instance)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	105	* if the view is not templatable, it should set the `content_type` class
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	106	attribute to the correct MIME type (text/xhtml by default)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	107	* the `category` attribute may be used in the interface to regroup related
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	108	objects together
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	109
4702 d9e51820d0c2 fix docstring Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4459 diff changeset	110	At instantiation time, the standard `_cw`, and `cw_rset` attributes are
d9e51820d0c2 fix docstring Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4459 diff changeset	111	added and the `w` attribute will be set at rendering time to a write
d9e51820d0c2 fix docstring Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4459 diff changeset	112	function to use.
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	113	"""
816 9cd49a910fce kill Template class and 'templates' registry sylvain.thenault@logilab.fr parents: 781 diff changeset	114	__registry__ = 'views'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	115
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	116	templatable = True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	117	# content_type = 'application/xhtml+xml' # text/xhtml'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	118	binary = False
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	119	add_to_breadcrumbs = True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	120	category = 'view'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	121
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	122	@property
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	123	@deprecated('[3.6] need_navigation is deprecated, use .paginable')
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	124	def need_navigation(self):
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	125	return True
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	126
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	127	@property
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	128	def paginable(self):
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	129	if not isinstance(self.__class__.need_navigation, property):
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	130	warn('[3.6] %s.need_navigation is deprecated, use .paginable'
4456 e0ee73794898 fix typo Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4244 diff changeset	131	% self.__class__, DeprecationWarning)
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	132	return self.need_navigation
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	133	return True
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	134
1143 8d097defbf2c change the way selected/__init__ are used for AppRsetObject sylvain.thenault@logilab.fr parents: 1132 diff changeset	135	def __init__(self, req=None, rset=None, **kwargs):
2822 f26578339214 deprecate appobject.vreg and rename appobject instance attributes using cw_ prefix Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2819 diff changeset	136	super(View, self).__init__(req, rset=rset, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	137	self.w = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	138
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	139	@property
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	140	def content_type(self):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	141	return self._cw.html_content_type()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	142
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	143	def set_stream(self, w=None):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	144	if self.w is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	145	return
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	146	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	147	if self.binary:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	148	self._stream = stream = StringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	149	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	150	self._stream = stream = UStringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	151	w = stream.write
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	152	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	153	stream = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	154	self.w = w
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	155	return stream
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	156
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	157	# main view interface #####################################################
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	158
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1511 diff changeset	159	def render(self, w=None, **context):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	160	"""called to render a view object for a result set.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	161
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	162	This method is a dispatched to an actual method selected
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	163	according to optional row and col parameters, which are locating
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	164	a particular row or cell in the result set:
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	165
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	166	* if row is specified, `cell_call` is called
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	167	* if none of them is supplied, the view is considered to apply on
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	168	the whole result set (which may be None in this case), `call` is
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	169	called
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	170	"""
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	171	row = context.get('row')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	172	if row is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	173	context.setdefault('col', 0)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	174	view_func = self.cell_call
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	175	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	176	view_func = self.call
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	177	stream = self.set_stream(w)
6563 33343d6eae0a [view] log error on view_func call Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6458 diff changeset	178	try:
33343d6eae0a [view] log error on view_func call Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6458 diff changeset	179	view_func(**context)
33343d6eae0a [view] log error on view_func call Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6458 diff changeset	180	except:
33343d6eae0a [view] log error on view_func call Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6458 diff changeset	181	self.debug('view call %s failed (context=%s)', view_func, context)
33343d6eae0a [view] log error on view_func call Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6458 diff changeset	182	raise
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	183	# return stream content if we have created it
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	184	if stream is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	185	return self._stream.getvalue()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	186
2795 59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	187	def tal_render(self, template, variables):
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	188	"""render a precompiled page template with variables in the given
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	189	dictionary as context
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	190	"""
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	191	from cubicweb.ext.tal import CubicWebContext
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	192	context = CubicWebContext()
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	193	context.update({'self': self, 'rset': self.cw_rset, '_' : self._cw._,
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	194	'req': self._cw, 'user': self._cw.user})
2795 59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	195	context.update(variables)
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	196	output = UStringIO()
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	197	template.expand(context, output)
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	198	return output.getvalue()
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	199
2788 8d3dbe577d3a R put version info in deprecation warnings Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2656 diff changeset	200	dispatch = deprecated('[3.4] .dispatch is deprecated, use .render')(render)
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1511 diff changeset	201
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	202	# should default .call() method add a <div classs="section"> around each
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	203	# rset item
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	204	add_div_section = True
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	205
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	206	def call(self, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	207	"""the view is called for an entire result set, by default loop
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	208	other rows of the result set and call the same view on the
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	209	particular row
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	210
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	211	Views applicable on None result sets have to override this method
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	212	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	213	rset = self.cw_rset
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	214	if rset is None:
4141 637170c17643 improve error message Pierre-Yves David <pierre-yves.david@logilab.fr> parents: 4063 diff changeset	215	raise NotImplementedError, (self, "an rset is required")
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	216	wrap = self.templatable and len(rset) > 1 and self.add_div_section
3973 1c09d2fd38c5 allow to override is_primary result using an argument given to object constructor (have to be given to 'initargs' argument of .render like initargs={'is_primary': False} Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3969 diff changeset	217	# XXX propagate self.extra_kwars?
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	218	for i in xrange(len(rset)):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	219	if wrap:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	220	self.w(u'<div class="section">')
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	221	self.wview(self.__regid__, rset, row=i, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	222	if wrap:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	223	self.w(u"</div>")
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	224
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	225	def cell_call(self, row, col, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	226	"""the view is called for a particular result set cell"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	227	raise NotImplementedError, self
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	228
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	229	def linkable(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	230	"""return True if the view may be linked in a menu
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	231
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	232	by default views without title are not meant to be displayed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	233	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	234	if not getattr(self, 'title', None):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	235	return False
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	236	return True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	237
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	238	def is_primary(self):
4045 f4a52abb6f4f cw 3.6 api update Sandrine Ribeau <sandrine.ribeau@logilab.fr> parents: 3998 diff changeset	239	return self.cw_extra_kwargs.get('is_primary', self.__regid__ == 'primary')
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	240
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	241	def url(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	242	"""return the url associated with this view. Should not be
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	243	necessary for non linkable views, but a default implementation
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	244	is provided anyway.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	245	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	246	rset = self.cw_rset
2468 93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	247	if rset is None:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	248	return self._cw.build_url('view', vid=self.__regid__)
2468 93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	249	coltypes = rset.column_types(0)
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	250	if len(coltypes) == 1:
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	251	etype = iter(coltypes).next()
4045 f4a52abb6f4f cw 3.6 api update Sandrine Ribeau <sandrine.ribeau@logilab.fr> parents: 3998 diff changeset	252	if not self._cw.vreg.schema.eschema(etype).final:
2468 93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	253	if len(rset) == 1:
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	254	entity = rset.get_entity(0, 0)
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	255	return entity.absolute_url(vid=self.__regid__)
2468 93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	256	# don't want to generate /<etype> url if there is some restriction
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	257	# on something else than the entity type
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	258	restr = rset.syntax_tree().children[0].where
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	259	# XXX norestriction is not correct here. For instance, in cases like
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	260	# "Any P,N WHERE P is Project, P name N" norestriction should equal
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	261	# True
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	262	norestriction = (isinstance(restr, nodes.Relation) and
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	263	restr.is_types_restriction())
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	264	if norestriction:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	265	return self._cw.build_url(etype.lower(), vid=self.__regid__)
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	266	return self._cw.build_url('view', rql=rset.printable_rql(), vid=self.__regid__)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	267
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	268	def set_request_content_type(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	269	"""set the content type returned by this view"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	270	self._cw.set_content_type(self.content_type)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	271
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	272	# view utilities ##########################################################
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	273
1985 9c1db4e06095 move view method's logic on the registry, so it's easier to call it from outside an appobject. Also make rset argument optional Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1977 diff changeset	274	def wview(self, __vid, rset=None, __fallback_vid=None, **kwargs):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	275	"""shortcut to self.view method automatically passing self.w as argument
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	276	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	277	self._cw.view(__vid, rset, __fallback_vid, w=self.w, **kwargs)
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	278
819 7fd66f389ef7 fix w/ template drop sylvain.thenault@logilab.fr parents: 816 diff changeset	279	# XXX Template bw compat
2788 8d3dbe577d3a R put version info in deprecation warnings Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2656 diff changeset	280	template = deprecated('[3.4] .template is deprecated, use .view')(wview)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	281
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	282	def whead(self, data):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	283	self._cw.html_headers.write(data)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	284
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	285	def wdata(self, data):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	286	"""simple helper that escapes `data` and writes into `self.w`"""
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2217 diff changeset	287	self.w(xml_escape(data))
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	288
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	289	def html_headers(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	290	"""return a list of html headers (eg something to be inserted between
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	291	<head> and </head> of the returned page
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	292
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	293	by default return a meta tag to disable robot indexation of the page
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	294	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	295	return [NOINDEX]
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	296
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	297	def page_title(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	298	"""returns a title according to the result set - used for the
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	299	title in the HTML header
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	300	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	301	vtitle = self._cw.form.get('vtitle')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	302	if vtitle:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	303	return self._cw._(vtitle)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	304	# class defined title will only be used if the resulting title doesn't
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	305	# seem clear enough
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	306	vtitle = getattr(self, 'title', None) or u''
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	307	if vtitle:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	308	vtitle = self._cw._(vtitle)
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	309	rset = self.cw_rset
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	310	if rset and rset.rowcount:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	311	if rset.rowcount == 1:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	312	try:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	313	entity = rset.complete_entity(0, 0)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	314	# use long_title to get context information if any
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	315	clabel = entity.dc_long_title()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	316	except NotAnEntity:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	317	clabel = display_name(self._cw, rset.description[0][0])
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	318	clabel = u'%s (%s)' % (clabel, vtitle)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	319	else :
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	320	etypes = rset.column_types(0)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	321	if len(etypes) == 1:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	322	etype = iter(etypes).next()
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	323	clabel = display_name(self._cw, etype, 'plural')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	324	else :
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	325	clabel = u'#[*] (%s)' % vtitle
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	326	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	327	clabel = vtitle
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	328	return u'%s (%s)' % (clabel, self._cw.property_value('ui.site-title'))
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	329
6039 6e84db1b3e44 [view] deprecate create_url in favor of a cw_create_url class method on entity classes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5725 diff changeset	330	@deprecated('[3.10] use vreg["etypes"].etype_class(etype).cw_create_url(req)')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	331	def create_url(self, etype, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	332	""" return the url of the entity creation form for a given entity type"""
6039 6e84db1b3e44 [view] deprecate create_url in favor of a cw_create_url class method on entity classes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5725 diff changeset	333	return self._cw.vreg["etypes"].etype_class(etype).cw_create_url(
6e84db1b3e44 [view] deprecate create_url in favor of a cw_create_url class method on entity classes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5725 diff changeset	334	self._cw, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	335
6038 5c5d819e8e93 small cleanups Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5725 diff changeset	336	def field(self, label, value, row=True, show_label=True, w=None, tr=True,
5c5d819e8e93 small cleanups Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5725 diff changeset	337	table=False):
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	338	"""read-only field"""
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	339	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	340	w = self.w
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	341	if table:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	342	w(u'<tr class="entityfield">')
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	343	else:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	344	w(u'<div class="entityfield">')
3326 e3089ceee1ea don't show label if no label given Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3010 diff changeset	345	if show_label and label:
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	346	if tr:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	347	label = display_name(self._cw, label)
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	348	if table:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	349	w(u'<th>%s</th>' % label)
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	350	else:
3839 84c9aab84d8c missing space between label and value Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3809 diff changeset	351	w(u'<span>%s</span> ' % label)
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	352	if table:
3969 970a748684b5 when fields are displayed in a table and label should'nt be displayed, set colspan to 2 on the field value cell Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3839 diff changeset	353	if not (show_label and label):
970a748684b5 when fields are displayed in a table and label should'nt be displayed, set colspan to 2 on the field value cell Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3839 diff changeset	354	w(u'<td colspan="2">%s</td></tr>' % value)
970a748684b5 when fields are displayed in a table and label should'nt be displayed, set colspan to 2 on the field value cell Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3839 diff changeset	355	else:
970a748684b5 when fields are displayed in a table and label should'nt be displayed, set colspan to 2 on the field value cell Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3839 diff changeset	356	w(u'<td>%s</td></tr>' % value)
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	357	else:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	358	w(u'<span>%s</span></div>' % value)
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	359
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	360
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	361
640 8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	362	# concrete views base classes #################################################
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	363
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	364	class EntityView(View):
843 5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	365	"""base class for views applying on an entity (i.e. uniform result set)"""
781 323656dd85a9 fix import, use non_final_entity instead of implements('Any') sylvain.thenault@logilab.fr parents: 757 diff changeset	366	__select__ = non_final_entity()
640 8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	367	category = 'entityview'
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	368
5715 2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	369	def call(self, **kwargs):
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	370	if self.cw_rset is None:
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	371	self.entity_call(self.cw_extra_kwargs.pop('entity'))
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	372	else:
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	373	super(EntityView, self).call(**kwargs)
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	374
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	375	def cell_call(self, row, col, **kwargs):
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	376	self.entity_call(self.cw_rset.get_entity(row, col), **kwargs)
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	377
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	378	def entity_call(self, entity, **kwargs):
2c3e83817a8e [view] add a new entity_call method to entity view protocol, allowing some to work with not yet created entities. Also, start considering 'eid' form parameters where we only consider 'rql', so we can move on bloquing arbitrary rql inputs (more to do on this...) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5679 diff changeset	379	raise NotImplementedError()
640 8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	380
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	381	class StartupView(View):
843 5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	382	"""base class for views which doesn't need a particular result set to be
5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	383	displayed (so they can always be displayed !)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	384	"""
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	385	__select__ = none_rset()
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	386
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	387	category = 'startupview'
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	388
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	389	def html_headers(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	390	"""return a list of html headers (eg something to be inserted between
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	391	<head> and </head> of the returned page
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	392
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	393	by default startup views are indexed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	394	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	395	return []
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	396
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	397
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	398	class EntityStartupView(EntityView):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	399	"""base class for entity views which may also be applied to None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	400	result set (usually a default rql is provided by the view class)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	401	"""
781 323656dd85a9 fix import, use non_final_entity instead of implements('Any') sylvain.thenault@logilab.fr parents: 757 diff changeset	402	__select__ = none_rset() \| non_final_entity()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	403
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	404	default_rql = None
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	405
2418 8f06e4f02733 optional rset Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2312 diff changeset	406	def __init__(self, req, rset=None, **kwargs):
2890 fdcb8a2bb6eb fix __init__ parameters Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2822 diff changeset	407	super(EntityStartupView, self).__init__(req, rset=rset, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	408	if rset is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	409	# this instance is not in the "entityview" category
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	410	self.category = 'startupview'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	411
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	412	def startup_rql(self):
873 3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	413	"""return some rql to be executed if the result set is None"""
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	414	return self.default_rql
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	415
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	416	def call(self, **kwargs):
873 3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	417	"""override call to execute rql returned by the .startup_rql method if
3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	418	necessary
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	419	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	420	rset = self.cw_rset
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	421	if rset is None:
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	422	rset = self.cw_rset = self._cw.execute(self.startup_rql())
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	423	for i in xrange(len(rset)):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	424	self.wview(self.__regid__, rset, row=i, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	425
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	426
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	427	class AnyRsetView(View):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	428	"""base class for views applying on any non empty result sets"""
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	429	__select__ = nonempty_rset()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	430
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	431	category = 'anyrsetview'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	432
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	433	def columns_labels(self, mainindex=0, tr=True):
370 7e76f651314b fix rset xml view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 369 diff changeset	434	if tr:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	435	translate = lambda val, req=self._cw: display_name(req, val)
370 7e76f651314b fix rset xml view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 369 diff changeset	436	else:
2207 5fad58e603f4 fix translate argument Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2203 diff changeset	437	translate = lambda val: val
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	438	# XXX [0] because of missing Union support
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	439	rqlstdescr = self.cw_rset.syntax_tree().get_description(mainindex,
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	440	translate)[0]
369 c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	441	labels = []
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	442	for colindex, label in enumerate(rqlstdescr):
369 c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	443	# compute column header
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	444	if label == 'Any': # find a better label
2207 5fad58e603f4 fix translate argument Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2203 diff changeset	445	label = ','.join(translate(et)
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	446	for et in self.cw_rset.column_types(colindex))
369 c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	447	labels.append(label)
c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	448	return labels
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	449
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	450
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	451	# concrete template base classes ##############################################
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	452
816 9cd49a910fce kill Template class and 'templates' registry sylvain.thenault@logilab.fr parents: 781 diff changeset	453	class MainTemplate(View):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	454	"""main template are primary access point to render a full HTML page.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	455	There is usually at least a regular main template and a simple fallback
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	456	one to display error if the first one failed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	457	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	458
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	459	@property
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	460	def doctype(self):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	461	if self._cw.xhtml_browser():
1421 77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	462	return STRICT_DOCTYPE
77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	463	return STRICT_DOCTYPE_NOEXT
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	464
1424 0a440312913b set_stream simplification sylvain.thenault@logilab.fr parents: 1421 diff changeset	465	def set_stream(self, w=None):
0a440312913b set_stream simplification sylvain.thenault@logilab.fr parents: 1421 diff changeset	466	if self.w is not None:
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	467	return
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	468	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	469	if self.binary:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	470	self._stream = stream = StringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	471	else:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	472	self._stream = stream = HTMLStream(self._cw)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	473	w = stream.write
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	474	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	475	stream = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	476	self.w = w
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	477	return stream
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	478
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	479	def write_doctype(self, xmldecl=True):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	480	assert isinstance(self._stream, HTMLStream)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	481	self._stream.doctype = self.doctype
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	482	if not xmldecl:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	483	self._stream.xmldecl = u''
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	484
822 e3d8db01f3f5 test_views fixes sylvain.thenault@logilab.fr parents: 819 diff changeset	485	def linkable(self):
e3d8db01f3f5 test_views fixes sylvain.thenault@logilab.fr parents: 819 diff changeset	486	return False
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	487
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	488	# concrete component base classes #############################################
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	489
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	490	class ReloadableMixIn(object):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	491	"""simple mixin for reloadable parts of UI"""
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	492
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	493	def user_callback(self, cb, args, msg=None, nonify=False):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	494	"""register the given user callback and return an url to call it ready to be
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	495	inserted in html
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	496	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	497	self._cw.add_js('cubicweb.ajax.js')
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	498	if nonify:
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	499	_cb = cb
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	500	def cb(*args):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	501	_cb(*args)
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	502	cbname = self._cw.register_onetime_callback(cb, *args)
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2217 diff changeset	503	return self.build_js(cbname, xml_escape(msg or ''))
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	504
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	505	def build_update_js_call(self, cbname, msg):
4059 f1da1a7ef29b backport stable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4045 4058 diff changeset	506	rql = self.cw_rset.printable_rql()
6044 9e48ebd5400c [view] use the new magic js object to generate javascript func call for auto reload user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6038 diff changeset	507	return "javascript: %s" % js.userCallbackThenUpdateUI(
9e48ebd5400c [view] use the new magic js object to generate javascript func call for auto reload user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6038 diff changeset	508	cbname, self.__regid__, rql, msg, self.__registry__, self.domid)
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	509
4062 d16b2927afe6 oops, bad indent Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4060 diff changeset	510	def build_reload_js_call(self, cbname, msg):
6044 9e48ebd5400c [view] use the new magic js object to generate javascript func call for auto reload user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6038 diff changeset	511	return "javascript: %s" % js.userCallbackThenReloadPage(cbname, msg)
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	512
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	513	build_js = build_update_js_call # expect updatable component by default
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	514
6140 65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	515	@property
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	516	def domid(self):
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	517	return domid(self.__regid__)
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	518
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	519	@deprecated('[3.10] use .domid property')
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	520	def div_id(self):
6140 65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	521	return self.domid
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	522
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	523
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	524	class Component(ReloadableMixIn, View):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	525	"""base class for components"""
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	526	__registry__ = 'components'
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	527	__select__ = yes()
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	528
6140 65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	529	# XXX huummm, much probably useless (should be...)
3010 684a0c546774 [ui props] drop htmlclass as a persistent property, this is definitly useless/unusable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2656 diff changeset	530	htmlclass = 'mainRelated'
6140 65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	531	@property
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	532	def cssclass(self):
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	533	return '%s %s' % (self.htmlclass, domid(self.__regid__))
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	534
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	535	# XXX should rely on ReloadableMixIn.domid
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	536	@property
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	537	def domid(self):
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	538	return '%sComponent' % domid(self.__regid__)
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	539
65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	540	@deprecated('[3.10] use .cssclass property')
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	541	def div_class(self):
6140 65a619eb31c4 [boxes] introduce new boxes system Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 6047 diff changeset	542	return self.cssclass
5556 9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	543
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	544
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	545	class Adapter(AppObject):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	546	"""base class for adapters"""
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	547	__registry__ = 'adapters'
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	548
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	549
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	550	class EntityAdapter(Adapter):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	551	"""base class for entity adapters (eg adapt an entity to an interface)"""
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	552	def __init__(self, _cw, **kwargs):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	553	try:
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	554	self.entity = kwargs.pop('entity')
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	555	except KeyError:
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	556	self.entity = kwargs['rset'].get_entity(kwargs.get('row') or 0,
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	557	kwargs.get('col') or 0)
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	558	Adapter.__init__(self, _cw, **kwargs)
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	559
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	560
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	561	def implements_adapter_compat(iface):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	562	def _pre39_compat(func):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	563	def decorated(self, args, *kwargs):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	564	entity = self.entity
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	565	if hasattr(entity, func.__name__):
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	566	warn('[3.9] %s method is deprecated, define it on a custom '
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	567	'%s for %s instead' % (func.__name__, iface,
5725 b5d595b66c35 [adapters] enhanced warning Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5715 diff changeset	568	classid(entity.__class__)),
5556 9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	569	DeprecationWarning)
5571 5d024bf9424b [adapters compat] make implements_adapter_compat selector compatible with attributes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5556 diff changeset	570	member = getattr(entity, func.__name__)
5d024bf9424b [adapters compat] make implements_adapter_compat selector compatible with attributes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5556 diff changeset	571	if callable(member):
5d024bf9424b [adapters compat] make implements_adapter_compat selector compatible with attributes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5556 diff changeset	572	return member(args, *kwargs)
5d024bf9424b [adapters compat] make implements_adapter_compat selector compatible with attributes Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5556 diff changeset	573	return member
5556 9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	574	return func(self, args, *kwargs)
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	575	return decorated
9ab2b4c74baf [entity] introduce a new 'adapters' registry Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 5533 diff changeset	576	return _pre39_compat

author	Sylvain Thénault <sylvain.thenault@logilab.fr>
	Tue, 04 Jan 2011 14:11:41 +0100
branch	stable
changeset 6761	84b67ae41a0d
parent 6563	33343d6eae0a
child 6769	d784d64f28d0
permissions	-rw-r--r--