cubicweb: view.py@8167de96c523 (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	#
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	11	# logilab-common is distributed in the hope that it will be useful, but WITHOUT
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/>.
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	18	"""abstract views and templates classes for CubicWeb web client
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
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	21	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	22	__docformat__ = "restructuredtext en"
1999 b9a8f5995658 obsolete methods Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1985 diff changeset	23	_ = unicode
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	24
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	25	from cStringIO import StringIO
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	26	from warnings import warn
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	27
5389 809d3b5b3d31 [python2.6] careful: json-py provides a json package. We don't want that. Alexandre Fayolle <alexandre.fayolle@logilab.fr> parents: 5377 diff changeset	28	from cubicweb.utils import json
2613 5e19c2bb370e R [all] logilab.common 0.44 provides only deprecated Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2558 diff changeset	29	from logilab.common.deprecation import deprecated
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2217 diff changeset	30	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	31
2644 100b81ba3a98 F [view] missing import Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2613 diff changeset	32	from rql import nodes
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	33
1181 620ec8e6ae19 cleanup, various fix to get something working sylvain.thenault@logilab.fr parents: 1144 diff changeset	34	from cubicweb import NotAnEntity
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	35	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	36	from cubicweb.appobject import AppObject
708 b4728112625f move utils from cw.common to cw sylvain.thenault@logilab.fr parents: 707 diff changeset	37	from cubicweb.utils import UStringIO, HTMLStream
2217 3a8cee8f8778 explicit display_name import Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2207 diff changeset	38	from cubicweb.schema import display_name
633 087e3f1e87c8 more selectors update sylvain.thenault@logilab.fr parents: 632 diff changeset	39
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	40	# robots control
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	41	NOINDEX = u'<meta name="ROBOTS" content="NOINDEX" />'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	42	NOFOLLOW = u'<meta name="ROBOTS" content="NOFOLLOW" />'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	43
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	44	CW_XHTML_EXTENSIONS = '''[
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	45	<!ATTLIST html xmlns:cubicweb CDATA #FIXED \'http://www.logilab.org/2008/cubicweb\' >
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	46
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	47	<!ENTITY % coreattrs
522 385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	48	"id ID #IMPLIED
385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	49	class CDATA #IMPLIED
385ce5e0b30b cubicweb__loadurl -> cubicweb:lazyloadurl sylvain.thenault@logilab.fr parents: 497 diff changeset	50	style CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	51	title CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	52
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	53	cubicweb:accesskey CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	54	cubicweb:actualrql CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	55	cubicweb:dataurl CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	56	cubicweb:displayactions CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	57	cubicweb:facetName CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	58	cubicweb:facetargs CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	59	cubicweb:fallbackvid CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	60	cubicweb:fname CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	61	cubicweb:initfunc CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	62	cubicweb:inputid CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	63	cubicweb:inputname CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	64	cubicweb:limit CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	65	cubicweb:loadtype CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	66	cubicweb:loadurl CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	67	cubicweb:maxlength CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	68	cubicweb:required CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	69	cubicweb:rooteid CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	70	cubicweb:rql CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	71	cubicweb:size CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	72	cubicweb:sortvalue CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	73	cubicweb:target CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	74	cubicweb:tindex CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	75	cubicweb:tlunit CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	76	cubicweb:type CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	77	cubicweb:uselabel CDATA #IMPLIED
c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	78	cubicweb:value CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	79	cubicweb:variables CDATA #IMPLIED
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	80	cubicweb:vid CDATA #IMPLIED
3782 c69fe7493b91 [cleanup] reorder cubicweb namespace attributes declaration Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 3689 diff changeset	81	cubicweb:wdgtype CDATA #IMPLIED
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	82	"> ] '''
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	83
1421 77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	84	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
77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	85	TRANSITIONAL_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n'
77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	86	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
77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	87	STRICT_DOCTYPE_NOEXT = u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n'
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	88
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	89	# base view object ############################################################
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	90
2656 a93ae0f6c0ad R [base classes] only AppObject remaning, no more AppRsetObject Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2644 diff changeset	91	class View(AppObject):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	92	"""abstract view class, used as base for every renderable object such
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	93	as views, templates, some components...web
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	94
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	95	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	96	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	97
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	98	* `templatable` indicates if the view may be embeded in a main
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	99	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	100	instance)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	101	* 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	102	attribute to the correct MIME type (text/xhtml by default)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	103	* the `category` attribute may be used in the interface to regroup related
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	104	objects together
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	105
4702 d9e51820d0c2 fix docstring Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4459 diff changeset	106	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	107	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	108	function to use.
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	109	"""
816 9cd49a910fce kill Template class and 'templates' registry sylvain.thenault@logilab.fr parents: 781 diff changeset	110	__registry__ = 'views'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	111
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	112	templatable = True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	113	# content_type = 'application/xhtml+xml' # text/xhtml'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	114	binary = False
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	115	add_to_breadcrumbs = True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	116	category = 'view'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	117
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	118	@property
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	119	@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	120	def need_navigation(self):
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	121	return True
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	122
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	123	@property
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	124	def paginable(self):
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	125	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	126	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	127	% self.__class__, DeprecationWarning)
4244 2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	128	return self.need_navigation
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	129	return True
2c3de1953d00 rename need_navigation into paginable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4212 diff changeset	130
1143 8d097defbf2c change the way selected/__init__ are used for AppRsetObject sylvain.thenault@logilab.fr parents: 1132 diff changeset	131	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	132	super(View, self).__init__(req, rset=rset, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	133	self.w = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	134
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	135	@property
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	136	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	137	return self._cw.html_content_type()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	138
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	139	def set_stream(self, w=None):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	140	if self.w is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	141	return
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	142	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	143	if self.binary:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	144	self._stream = stream = StringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	145	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	146	self._stream = stream = UStringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	147	w = stream.write
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	148	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	149	stream = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	150	self.w = w
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	151	return stream
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	152
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	153	# main view interface #####################################################
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	154
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1511 diff changeset	155	def render(self, w=None, **context):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	156	"""called to render a view object for a result set.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	157
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	158	This method is a dispatched to an actual method selected
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	159	according to optional row and col parameters, which are locating
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	160	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	161
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	162	* if row is specified, `cell_call` is called
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	163	* 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	164	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	165	called
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	166	"""
1132 96752791c2b6 pylint cleanup sylvain.thenault@logilab.fr parents: 986 diff changeset	167	row = context.get('row')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	168	if row is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	169	context.setdefault('col', 0)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	170	view_func = self.cell_call
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	171	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	172	view_func = self.call
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	173	stream = self.set_stream(w)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	174	# stream = self.set_stream(context)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	175	view_func(**context)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	176	# return stream content if we have created it
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	177	if stream is not None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	178	return self._stream.getvalue()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	179
2795 59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	180	def tal_render(self, template, variables):
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	181	"""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	182	dictionary as context
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	183	"""
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	184	from cubicweb.ext.tal import CubicWebContext
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	185	context = CubicWebContext()
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	186	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	187	'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	188	context.update(variables)
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	189	output = UStringIO()
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	190	template.expand(context, output)
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	191	return output.getvalue()
59965167bef3 move tal_render to View Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2788 diff changeset	192
2788 8d3dbe577d3a R put version info in deprecation warnings Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2656 diff changeset	193	dispatch = deprecated('[3.4] .dispatch is deprecated, use .render')(render)
1723 30c3a713ab61 View.dispatch -> View.render sylvain.thenault@logilab.fr parents: 1511 diff changeset	194
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	195	# should default .call() method add a <div classs="section"> around each
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	196	# rset item
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	197	add_div_section = True
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	198
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	199	def call(self, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	200	"""the view is called for an entire result set, by default loop
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	201	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	202	particular row
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	203
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	204	Views applicable on None result sets have to override this method
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	205	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	206	rset = self.cw_rset
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	207	if rset is None:
4141 637170c17643 improve error message Pierre-Yves David <pierre-yves.david@logilab.fr> parents: 4063 diff changeset	208	raise NotImplementedError, (self, "an rset is required")
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	209	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	210	# XXX propagate self.extra_kwars?
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	211	for i in xrange(len(rset)):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	212	if wrap:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	213	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	214	self.wview(self.__regid__, rset, row=i, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	215	if wrap:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	216	self.w(u"</div>")
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	217
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	218	def cell_call(self, row, col, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	219	"""the view is called for a particular result set cell"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	220	raise NotImplementedError, self
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	221
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	222	def linkable(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	223	"""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	224
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	225	by default views without title are not meant to be displayed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	226	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	227	if not getattr(self, 'title', None):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	228	return False
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	229	return True
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	230
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	231	def is_primary(self):
4045 f4a52abb6f4f cw 3.6 api update Sandrine Ribeau <sandrine.ribeau@logilab.fr> parents: 3998 diff changeset	232	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	233
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	234	def url(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	235	"""return the url associated with this view. Should not be
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	236	necessary for non linkable views, but a default implementation
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	237	is provided anyway.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	238	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	239	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	240	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	241	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	242	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	243	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	244	etype = iter(coltypes).next()
4045 f4a52abb6f4f cw 3.6 api update Sandrine Ribeau <sandrine.ribeau@logilab.fr> parents: 3998 diff changeset	245	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	246	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	247	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	248	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	249	# 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	250	# 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	251	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	252	# 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	253	# "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	254	# True
93853b6f3bad move all view.url() logic in a single implementation Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2418 diff changeset	255	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	256	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	257	if norestriction:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	258	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	259	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	260
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	261	def set_request_content_type(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	262	"""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	263	self._cw.set_content_type(self.content_type)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	264
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	265	# view utilities ##########################################################
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	266
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	267	def wview(self, __vid, rset=None, __fallback_vid=None, **kwargs):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	268	"""shortcut to self.view method automatically passing self.w as argument
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	269	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	270	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	271
819 7fd66f389ef7 fix w/ template drop sylvain.thenault@logilab.fr parents: 816 diff changeset	272	# XXX Template bw compat
2788 8d3dbe577d3a R put version info in deprecation warnings Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 2656 diff changeset	273	template = deprecated('[3.4] .template is deprecated, use .view')(wview)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	274
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	275	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	276	self._cw.html_headers.write(data)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	277
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	278	def wdata(self, data):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	279	"""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	280	self.w(xml_escape(data))
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 html_headers(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	283	"""return a list of html headers (eg something to be inserted between
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	284	<head> and </head> of the returned page
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	285
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	286	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	287	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	288	return [NOINDEX]
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	289
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	290	def page_title(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	291	"""returns a title according to the result set - used for the
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	292	title in the HTML header
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	293	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	294	vtitle = self._cw.form.get('vtitle')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	295	if vtitle:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	296	return self._cw._(vtitle)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	297	# 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	298	# seem clear enough
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	299	vtitle = getattr(self, 'title', None) or u''
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	300	if vtitle:
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._(vtitle)
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	302	rset = self.cw_rset
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	303	if rset and rset.rowcount:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	304	if rset.rowcount == 1:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	305	try:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	306	entity = rset.complete_entity(0, 0)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	307	# use long_title to get context information if any
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	308	clabel = entity.dc_long_title()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	309	except NotAnEntity:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	310	clabel = display_name(self._cw, rset.description[0][0])
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	311	clabel = u'%s (%s)' % (clabel, vtitle)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	312	else :
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	313	etypes = rset.column_types(0)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	314	if len(etypes) == 1:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	315	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	316	clabel = display_name(self._cw, etype, 'plural')
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	317	else :
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	318	clabel = u'#[*] (%s)' % 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	clabel = vtitle
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	321	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	322
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	323	def output_url_builder( self, name, url, args ):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	324	self.w(u'<script language="JavaScript"><!--\n' \
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	325	u'function %s( %s ) {\n' % (name, ','.join(args) ) )
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	326	url_parts = url.split("%s")
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	327	self.w(u' url="%s"' % url_parts[0] )
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	328	for arg, part in zip(args, url_parts[1:]):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	329	self.w(u'+str(%s)' % arg )
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	330	if part:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	331	self.w(u'+"%s"' % part)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	332	self.w('\n document.window.href=url;\n')
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	333	self.w('}\n-->\n</script>\n')
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	334
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	335	def create_url(self, etype, **kwargs):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	336	""" return the url of the entity creation form for a given entity type"""
3890 d7a270f50f54 backport stable branch (one more time painfully) Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3720 3839 diff changeset	337	return self._cw.build_url('add/%s' % etype, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	338
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	339	def field(self, label, value, row=True, show_label=True, w=None, tr=True, table=False):
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	340	"""read-only field"""
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	341	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	342	w = self.w
3809 1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	343	if table:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	344	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	345	else:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	346	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	347	if show_label and label:
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	348	if tr:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	349	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	350	if table:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	351	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	352	else:
3839 84c9aab84d8c missing space between label and value Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3809 diff changeset	353	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	354	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	355	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	356	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	357	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	358	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	359	else:
1b9b51ee543e [web ui] PrimaryView.render_attributes now uses a table Nicolas Chauvat <nicolas.chauvat@logilab.fr> parents: 3782 diff changeset	360	w(u'<span>%s</span></div>' % value)
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	361
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	362
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	363
640 8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	364	# concrete views base classes #################################################
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	365
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	366	class EntityView(View):
843 5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	367	"""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	368	__select__ = non_final_entity()
640 8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	369	category = 'entityview'
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	370
8e64f12be69c drop EntityAction usage in cw, upgrade rql_condition and friends sylvain.thenault@logilab.fr parents: 635 diff changeset	371
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	372	class StartupView(View):
843 5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	373	"""base class for views which doesn't need a particular result set to be
5676811ef760 cleanup sylvain.thenault@logilab.fr parents: 822 diff changeset	374	displayed (so they can always be displayed !)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	375	"""
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	376	__select__ = none_rset()
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	377
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	378	category = 'startupview'
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	379
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	380	def html_headers(self):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	381	"""return a list of html headers (eg something to be inserted between
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	382	<head> and </head> of the returned page
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	383
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	384	by default startup views are indexed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	385	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	386	return []
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	387
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	388
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	389	class EntityStartupView(EntityView):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	390	"""base class for entity views which may also be applied to None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	391	result set (usually a default rql is provided by the view class)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	392	"""
781 323656dd85a9 fix import, use non_final_entity instead of implements('Any') sylvain.thenault@logilab.fr parents: 757 diff changeset	393	__select__ = none_rset() \| non_final_entity()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	394
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	395	default_rql = None
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	396
2418 8f06e4f02733 optional rset Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2312 diff changeset	397	def __init__(self, req, rset=None, **kwargs):
2890 fdcb8a2bb6eb fix __init__ parameters Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2822 diff changeset	398	super(EntityStartupView, self).__init__(req, rset=rset, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	399	if rset is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	400	# this instance is not in the "entityview" category
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	401	self.category = 'startupview'
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	402
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	403	def startup_rql(self):
873 3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	404	"""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	405	return self.default_rql
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	406
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	407	def call(self, **kwargs):
873 3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	408	"""override call to execute rql returned by the .startup_rql method if
3d9df99b0bfa cleanup sylvain.thenault@logilab.fr parents: 843 diff changeset	409	necessary
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	410	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	411	rset = self.cw_rset
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	412	if rset is None:
6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	413	rset = self.cw_rset = self._cw.execute(self.startup_rql())
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	414	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	415	self.wview(self.__regid__, rset, row=i, **kwargs)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	416
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	417
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	418	class AnyRsetView(View):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	419	"""base class for views applying on any non empty result sets"""
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	420	__select__ = nonempty_rset()
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	421
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	422	category = 'anyrsetview'
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	423
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	424	def columns_labels(self, mainindex=0, tr=True):
370 7e76f651314b fix rset xml view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 369 diff changeset	425	if tr:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	426	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	427	else:
2207 5fad58e603f4 fix translate argument Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2203 diff changeset	428	translate = lambda val: val
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	429	# 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	430	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	431	translate)[0]
369 c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	432	labels = []
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	433	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	434	# compute column header
2203 efdd3a9f9028 update to new rql get_description api Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 1999 diff changeset	435	if label == 'Any': # find a better label
2207 5fad58e603f4 fix translate argument Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2203 diff changeset	436	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	437	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	438	labels.append(label)
c8a6edc224bb new rsetxml view, reusing most code from csvexport view Sylvain Thenault <sylvain.thenault@logilab.fr> parents: 361 diff changeset	439	return labels
543 c0f2b6378f70 simplification of lazy tabs mechanism Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: 522 diff changeset	440
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	441
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	442	# concrete template base classes ##############################################
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	443
816 9cd49a910fce kill Template class and 'templates' registry sylvain.thenault@logilab.fr parents: 781 diff changeset	444	class MainTemplate(View):
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	445	"""main template are primary access point to render a full HTML page.
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	446	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	447	one to display error if the first one failed
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	448	"""
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	449
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	450	@property
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	451	def doctype(self):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	452	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	453	return STRICT_DOCTYPE
77ee26df178f doc type handling refactoring: do the ext substitution at the module level sylvain.thenault@logilab.fr parents: 1181 diff changeset	454	return STRICT_DOCTYPE_NOEXT
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	455
1424 0a440312913b set_stream simplification sylvain.thenault@logilab.fr parents: 1421 diff changeset	456	def set_stream(self, w=None):
0a440312913b set_stream simplification sylvain.thenault@logilab.fr parents: 1421 diff changeset	457	if self.w is not None:
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	458	return
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	459	if w is None:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	460	if self.binary:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	461	self._stream = stream = StringIO()
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	462	else:
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	463	self._stream = stream = HTMLStream(self._cw)
0 b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	464	w = stream.write
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	465	else:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	466	stream = None
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	467	self.w = w
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	468	return stream
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	469
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	470	def write_doctype(self, xmldecl=True):
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	471	assert isinstance(self._stream, HTMLStream)
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	472	self._stream.doctype = self.doctype
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	473	if not xmldecl:
b97547f5f1fa Showtime ! Adrien Di Mascio <Adrien.DiMascio@logilab.fr> parents: diff changeset	474	self._stream.xmldecl = u''
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	475
822 e3d8db01f3f5 test_views fixes sylvain.thenault@logilab.fr parents: 819 diff changeset	476	def linkable(self):
e3d8db01f3f5 test_views fixes sylvain.thenault@logilab.fr parents: 819 diff changeset	477	return False
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	478
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	479	# concrete component base classes #############################################
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	480
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	481	class ReloadableMixIn(object):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	482	"""simple mixin for reloadable parts of UI"""
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	483
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	484	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	485	"""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	486	inserted in html
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	487	"""
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	488	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	489	if nonify:
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	490	_cb = cb
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	491	def cb(*args):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	492	_cb(*args)
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	493	cbname = self._cw.register_onetime_callback(cb, *args)
2312 af4d8f75c5db use xml_escape Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 2217 diff changeset	494	return self.build_js(cbname, xml_escape(msg or ''))
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	495
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	496	def build_update_js_call(self, cbname, msg):
4059 f1da1a7ef29b backport stable Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4045 4058 diff changeset	497	rql = self.cw_rset.printable_rql()
4058 b3578583b57b properly escape arguments of user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3973 diff changeset	498	return "javascript:userCallbackThenUpdateUI('%s', '%s', %s, %s, '%s', '%s')" % (
5389 809d3b5b3d31 [python2.6] careful: json-py provides a json package. We don't want that. Alexandre Fayolle <alexandre.fayolle@logilab.fr> parents: 5377 diff changeset	499	cbname, self.id, json.dumps(rql), json.dumps(msg),
4058 b3578583b57b properly escape arguments of user callbacks Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 3973 diff changeset	500	self.__registry__, self.div_id())
1433 091ac3ba5d51 remove trailing white spaces sylvain.thenault@logilab.fr parents: 1432 diff changeset	501
4062 d16b2927afe6 oops, bad indent Sylvain Thénault <sylvain.thenault@logilab.fr> parents: 4060 diff changeset	502	def build_reload_js_call(self, cbname, msg):
5389 809d3b5b3d31 [python2.6] careful: json-py provides a json package. We don't want that. Alexandre Fayolle <alexandre.fayolle@logilab.fr> parents: 5377 diff changeset	503	return "javascript:userCallbackThenReloadPage('%s', %s)" % (cbname, json.dumps(msg))
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	504
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	505	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	506
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	507	def div_id(self):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	508	return ''
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	509
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	510
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	511	class Component(ReloadableMixIn, View):
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	512	"""base class for components"""
4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	513	__registry__ = 'components'
707 21a59b468f1a __selectors__ -> __select__ sylvain.thenault@logilab.fr parents: 700 diff changeset	514	__select__ = yes()
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	515
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	516	# XXX huummm, much probably useless
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	517	htmlclass = 'mainRelated'
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	518	def div_class(self):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	519	return '%s %s' % (self.htmlclass, self.__regid__)
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	520
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	521	# XXX a generic '%s%s' % (self.__regid__, self.__registry__.capitalize()) would probably be nicer
661 4f61eb8a96b7 properly kill/depreciate component base class, only keep Component sylvain.thenault@logilab.fr parents: 660 diff changeset	522	def div_id(self):
3451 6b46d73823f5 [api] work in progress, use __regid__, cw_, etc. Adrien Di Mascio <Adrien.DiMascio@logilab.fr>* parents: 3369 diff changeset	523	return '%sComponent' % self.__regid__

author	Sylvain Thénault <sylvain.thenault@logilab.fr>
	Wed, 28 Apr 2010 10:06:01 +0200
branch	stable
changeset 5421	8167de96c523
parent 5389	809d3b5b3d31
child 5424	8ecbcbff9777
permissions	-rw-r--r--