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

author	Sylvain Thénault <sylvain.thenault@logilab.fr>
	Tue, 18 May 2010 10:28:50 +0200
branch	stable
changeset 5533	5cb121d4f02f
parent 5528	5d1b2ae7d459
child 5556	9ab2b4c74baf
child 5668	7bd6a8a126b8
permissions	-rw-r--r--