"""abstract box classes for CubicWeb web client:organization: Logilab:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses"""__docformat__="restructuredtext en"fromlogilab.mtconverterimporthtml_escapefromcubicwebimportUnauthorized,roleasget_role,targetasget_targetfromcubicweb.selectorsimport(one_line_rset,primary_view,match_context_prop,partial_has_related_entities,accepts_compat,has_relation_compat,condition_compat,require_group_compat)fromcubicweb.viewimportView,ReloadableMixInfromcubicweb.web.htmlwidgetsimport(BoxLink,BoxWidget,SideBoxWidget,RawBoxItem,BoxSeparator)fromcubicweb.web.actionimportUnregisteredAction_=unicodeclassBoxTemplate(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 on of the formatting callbacks is 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) """__registry__='boxes'__select__=match_context_prop()registered=classmethod(require_group_compat(View.registered))categories_in_order=()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'htmlitemclass='boxItem'defsort_actions(self,actions):"""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)]forcatinself.categories_in_order:ifcatinactions_by_cat:result.append((cat,actions_by_cat[cat]))foriteminsorted(actions_by_cat.items()):result.append(item)returnresultdefmk_action(self,title,path,escape=True,**kwargs):"""factory function to create dummy actions compatible with the .format_actions method """ifescape:title=html_escape(title)returnself.box_action(self._action(title,path,**kwargs))def_action(self,title,path,**kwargs):returnUnregisteredAction(self.req,self.rset,title,path,**kwargs)# formating callbacksdefboxitem_link_tooltip(self,action):ifaction.id:returnu'keyword: %s'%action.idreturnu''defbox_action(self,action):cls=getattr(action,'html_class',lambda:None)()orself.htmlitemclassreturnBoxLink(action.url(),self.req._(action.title),cls,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. It rely on etype, rtype (both optional, usable to control registration according to application schema and display according to connected user's rights) and rql attributes """#XXX __selectors__ = BoxTemplate.__selectors__ + (etype_rtype_selector,)rql=Nonedefto_display_rql(self):assertself.rqlisnotNone,self.idreturn(self.rql,)defcall(self,**kwargs):try:rset=self.req.execute(*self.to_display_rql())exceptUnauthorized:# can't access to something in the query, forget this boxreturniflen(rset)==0:returnbox=BoxWidget(self.req._(self.title),self.id)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.idreturn(self.rql,{'x':self.req.user.eid},'x')classEntityBoxTemplate(BoxTemplate):"""base class for boxes related to a single entity"""__select__=BoxTemplate.__select__&one_line_rset()&primary_view()registered=accepts_compat(has_relation_compat(condition_compat(BoxTemplate.registered)))context='incontext'defcall(self,row=0,col=0,**kwargs):"""classes inheriting from EntityBoxTemplate should define cell_call"""self.cell_call(row,col,**kwargs)classRelatedEntityBoxTemplate(EntityBoxTemplate):__select__=EntityBoxTemplate.__select__&partial_has_related_entities()defcell_call(self,row,col,**kwargs):entity=self.entity(row,col)limit=self.req.property_value('navigation.related-limit')+1role=get_role(self)self.w(u'<div class="sideBox">')self.wview('sidebox',entity.related(self.rtype,role,limit=limit),title=display_name(self.req,self.rtype,role))self.w(u'</div>')classEditRelationBoxTemplate(ReloadableMixIn,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. """defcell_call(self,row,col,view=None,**kwargs):self.req.add_js('cubicweb.ajax.js')entity=self.entity(row,col)box=SideBoxWidget(display_name(self.req,self.rtype),self.id)count=self.w_related(box,entity)ifcount:box.append(BoxSeparator())ifnotself.w_unrelated(box,entity):delbox.items[-1]# remove useless separatorbox.render(self.w)defdiv_id(self):returnself.iddefbox_item(self,entity,etarget,rql,label):"""builds HTML link to edit relation between `entity` and `etarget` """role,target=get_role(self),get_target(self)args={role[0]:entity.eid,target[0]:etarget.eid}url=self.user_rql_callback((rql,args))# for each target, provide a link to edit the relationlabel=u'[<a href="%s">%s</a>] %s'%(url,label,etarget.view('incontext'))returnRawBoxItem(label,liclass=u'invisible')defw_related(self,box,entity):"""appends existing relations to the `box`"""rql='DELETE S %s O WHERE S eid %%(s)s, O eid %%(o)s'%self.rtyperelated=self.related_entities(entity)foretargetinrelated:box.append(self.box_item(entity,etarget,rql,u'-'))returnlen(related)defw_unrelated(self,box,entity):"""appends unrelated entities to the `box`"""rql='SET S %s O WHERE S eid %%(s)s, O eid %%(o)s'%self.rtypei=0foretargetinself.unrelated_entities(entity):box.append(self.box_item(entity,etarget,rql,u'+'))i+=1returnidefunrelated_entities(self,entity):"""returns the list of unrelated entities if etype is not defined on the Box's class, the default behaviour is to use the entity's appropraite vocabulary function """# use entity.unrelated if we've been asked for a particular etypeifhasattr(self,'etype'):returnentity.unrelated(self.rtype,self.etype,get_role(self)).entities()# in other cases, use vocabulary functionsentities=[]form=self.vreg.select_object('forms','edition',self.req,self.rset,row=self.rowor0)field=form.field_by_name(self.rtype,get_role(self),entity.e_schema)for_,eidinform.form_field_vocabulary(field):ifeidisnotNone:rset=self.req.eid_rset(eid)entities.append(rset.get_entity(0,0))returnentitiesdefrelated_entities(self,entity):returnentity.related(self.rtype,get_role(self),entities=True)