views.py

"""Specific views for person entities

:organization: Logilab
:copyright: 2003-2009 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
"""
__docformat__ = "restructuredtext en"

from logilab.mtconverter import xml_escape

from cubicweb.selectors import implements, rql_condition
from cubicweb.web import uicfg, action
from cubicweb.web.views import baseviews, primary, vcard
from cubicweb.web.facet import AttributeFacet

for attr in ('civility', 'description', 'firstname', 'surname'):
    uicfg.primaryview_section.tag_attribute(('Person', attr), 'hidden')
for rtype in ('phone', 'use_email', 'primary_email'):
    uicfg.primaryview_section.tag_subject_of(('Person', rtype, '*'), 'hidden')

uicfg.autoform_is_inlined.tag_subject_of(('Person', 'phone', '*'), True)
uicfg.autoform_is_inlined.tag_subject_of(('Person', 'postal_address', '*'), True)

class PersonPrimaryView(primary.PrimaryView):
    __select__ = implements('Person')

    def render_entity_title(self, entity):
        self.w(u'<h1>%s</h1>' % xml_escape(entity.name(civility=True)))

    def render_entity_attributes(self, entity):
        if getattr(entity, 'phone', None):
            self.field('phone', ', '.join(xml_escape(e.view('text'))
                                          for e in entity.phone))
        if entity.use_email:
            self.field('use_email',
                       ', '.join(e.view('oneline') for e in entity.use_email))

        if getattr(entity, 'postal_address', None):
            self.w(u"<table>")
            for postaladdress in entity.postal_address:
                self.w(u'<tr><th class="labelCol">%s</th><td>%s</td></tr>' % 
                       (display_name(self.req, 'PostalAddress'),
                        postaladdress.view('incontext')) )
            self.w(u"</table>")
        super(PersonPrimaryView, self).render_entity_attributes(entity)

    def summary(self, entity):
        return entity.view('reledit', rtype='description')


class PersonTextView(baseviews.TextView):
    __select__ = implements('Person')

    def cell_call(self, row, col):
        entity = self.entity(row, col)
        self.w(entity.name())


class PersonEmailView(baseviews.EntityView):
    """display emails sent or received by one of this person's addresses"""
    id = 'emails'
    __select__ = implements('Person')
    title = _('emails')

    def cell_call(self, row, col=0):
        entity = self.entity(row, col)
        self.w(u'<h3>')
        self.w(self.req._('emails sent or received by %s')
               % xml_escape(entity.dc_title()))
        self.w(u'</h3>')
        done = set()
        if getattr(entity, 'primary_email', None):
            email = entity.primary_email[0]
            email.view('shortprimary', w=self.w, skipeids=done)
            pemaileid = email.eid
        else:
            pemaileid = None
        for email in getattr(entity, 'use_email', ()):
            if email.eid == pemaileid:
                continue
            email.view('shortprimary', w=self.w, skipeids=done)


class VCardPersonView(vcard.VCardCWUserView):
    """export a person information as a vcard"""
    __select__ = implements('Person')

    def vcard_content(self, entity):
        w = self.w
        who = u'%s %s' % (entity.surname or '',
                          entity.firstname or '')
        w(u'FN:%s\n' % who)
        w(u'N:%s;;;;\n' % who)
        w(u'TITLE:%s\n' % who)
        # XXX
        #if entity.address:
        #    w(u'ADR;TYPE=WORK,POSTAL,PARCEL:;;%s\n' % ';'.join(entity.address.splitlines()))
        for phone in getattr(entity, 'phone', ()):
            ptype = vcard.VCARD_PHONE_TYPES.get(phone.type, phone.type.upper())
            w(u'TEL;TYPE=%s;VOICE:%s\n' % (ptype, phone.number))
        for email in getattr(entity, 'use_email', ()):
            w(u'EMAIL;TYPE=INTERNET:%s\n' % email.address)


## actions ####################################################################

class AddPersonFromEmailAction(action.LinkToEntityAction):
    id = 'addperson-fromemail'
    __select__ = implements('EmailAddress') & rql_condition('NOT P use_email X')

    title = _('add Person use_email EmailAddress object')
    etype = 'Person'
    rtype = 'use_email'
    target = 'subject'

## facets #####################################################################

class CivilityFacet(AttributeFacet):
    id = 'civility-facet'
    __select__ = implements('Person')
    rtype = 'civility'