# copyright 2003-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr## This file is part of CubicWeb.## CubicWeb is free software: you can redistribute it and/or modify it under the# terms of the GNU Lesser General Public License as published by the Free# Software Foundation, either version 2.1 of the License, or (at your option)# any later version.## CubicWeb is distributed in the hope that it will be useful, but WITHOUT# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more# details.## You should have received a copy of the GNU Lesser General Public License along# with CubicWeb. If not, see <http://www.gnu.org/licenses/>."""abstract box classes for CubicWeb web client"""__docformat__="restructuredtext en"_=unicodefromlogilab.mtconverterimportxml_escapefromlogilab.common.deprecationimportclass_deprecated,class_renamedfromcubicwebimportUnauthorized,roleasget_rolefromcubicweb.schemaimportdisplay_namefromcubicweb.selectorsimportno_cnx,one_line_rsetfromcubicweb.viewimportViewfromcubicweb.webimportINTERNAL_FIELD_VALUE,stdmsgsfromcubicweb.web.htmlwidgetsimport(BoxLink,BoxWidget,SideBoxWidget,RawBoxItem,BoxSeparator)fromcubicweb.web.actionimportUnregisteredActiondefsort_by_category(actions,categories_in_order=None):"""return a list of (category, actions_sorted_by_title)"""result=[]actions_by_cat={}foractioninactions:actions_by_cat.setdefault(action.category,[]).append((action.title,action))forkey,valuesinactions_by_cat.items():actions_by_cat[key]=[actfortitle,actinsorted(values)]ifcategories_in_order:forcatincategories_in_order:ifcatinactions_by_cat:result.append((cat,actions_by_cat[cat]))foriteminsorted(actions_by_cat.items()):result.append(item)returnresult# old box system, deprecated ###################################################classBoxTemplate(View):"""base template for boxes, usually a (contextual) list of possible actions. Various classes attributes may be used to control the box rendering. You may override one of the formatting callbacks if this is not necessary for your custom box. Classes inheriting from this class usually only have to override call to fetch desired actions, and then to do something like :: box.render(self.w) """__metaclass__=class_deprecated__deprecation_warning__='[3.10] *BoxTemplate classes are deprecated, use *CtxComponent instead (%(cls)s)'__registry__='ctxcomponents'__select__=~no_cnx()categories_in_order=()cw_property_defs={_('visible'):dict(type='Boolean',default=True,help=_('display the box or not')),_('order'):dict(type='Int',default=99,help=_('display order of the box')),# XXX 'incontext' boxes are handled by the default primary view_('context'):dict(type='String',default='left',vocabulary=(_('left'),_('incontext'),_('right')),help=_('context where this box should be displayed')),}context='left'defsort_actions(self,actions):"""return a list of (category, actions_sorted_by_title)"""returnsort_by_category(actions,self.categories_in_order)defmk_action(self,title,url,escape=True,**kwargs):"""factory function to create dummy actions compatible with the .format_actions method """ifescape:title=xml_escape(title)returnself.box_action(self._action(title,url,**kwargs))def_action(self,title,url,**kwargs):returnUnregisteredAction(self._cw,title,url,**kwargs)# formating callbacksdefboxitem_link_tooltip(self,action):ifaction.__regid__:returnu'keyword: %s'%action.__regid__returnu''defbox_action(self,action):klass=getattr(action,'html_class',lambda:None)()returnBoxLink(action.url(),self._cw._(action.title),klass,self.boxitem_link_tooltip(action))classRQLBoxTemplate(BoxTemplate):"""abstract box for boxes displaying the content of a rql query not related to the current result set. """# to be defined in concrete classesrql=title=Nonedefto_display_rql(self):assertself.rqlisnotNone,self.__regid__return(self.rql,)defcall(self,**kwargs):try:rset=self._cw.execute(*self.to_display_rql())exceptUnauthorized:# can't access to something in the query, forget this boxreturniflen(rset)==0:returnbox=BoxWidget(self._cw._(self.title),self.__regid__)fori,(teid,tname)inenumerate(rset):entity=rset.get_entity(i,0)box.append(self.mk_action(tname,entity.absolute_url()))box.render(w=self.w)classUserRQLBoxTemplate(RQLBoxTemplate):"""same as rql box template but the rql is build using the eid of the request's user """defto_display_rql(self):assertself.rqlisnotNone,self.__regid__return(self.rql,{'x':self._cw.user.eid})classEntityBoxTemplate(BoxTemplate):"""base class for boxes related to a single entity"""__select__=BoxTemplate.__select__&one_line_rset()context='incontext'defcall(self,row=0,col=0,**kwargs):"""classes inheriting from EntityBoxTemplate should define cell_call"""self.cell_call(row,col,**kwargs)fromcubicweb.web.componentimportAjaxEditRelationCtxComponent,EditRelationMixInclassEditRelationBoxTemplate(EditRelationMixIn,EntityBoxTemplate):"""base class for boxes which let add or remove entities linked by a given relation subclasses should define at least id, rtype and target class attributes. """rtype=Nonedefcell_call(self,row,col,view=None,**kwargs):self._cw.add_js('cubicweb.ajax.js')entity=self.cw_rset.get_entity(row,col)title=display_name(self._cw,self.rtype,get_role(self),context=entity.__regid__)box=SideBoxWidget(title,self.__regid__)related=self.related_boxitems(entity)unrelated=self.unrelated_boxitems(entity)box.extend(related)ifrelatedandunrelated:box.append(BoxSeparator())box.extend(unrelated)box.render(self.w)defbox_item(self,entity,etarget,rql,label):label=super(EditRelationBoxTemplate,self).box_item(entity,etarget,rql,label)returnRawBoxItem(label,liclass=u'invisible')AjaxEditRelationBoxTemplate=class_renamed('AjaxEditRelationBoxTemplate',AjaxEditRelationCtxComponent,'[3.10] AjaxEditRelationBoxTemplate has been renamed to AjaxEditRelationCtxComponent (%(cls)s)')