view src/browser/sat_browser/contact_widget.py @ 671:2201ff543a05 frontends_multi_profiles

browser_side: replace ContactsPanel and ContactBox init "parent" attribute with "host" + menus bound to the avatar can be parameterized
author souliane <souliane@mailoo.org>
date Mon, 09 Mar 2015 16:30:06 +0100
parents 267761bf7f08
children 849ffb24d5bf
line wrap: on
line source

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Libervia: a Salut à Toi frontend
# Copyright (C) 2011, 2012, 2013, 2014 Jérôme Poisson <goffi@goffi.org>

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import pyjd  # this is dummy in pyjs
from sat.core.log import getLogger
log = getLogger(__name__)

from sat.core import exceptions
from pyjamas.ui.VerticalPanel import VerticalPanel
from pyjamas.ui.HTML import HTML
from pyjamas.ui.Image import Image
from pyjamas.ui.ClickListener import ClickHandler
from constants import Const as C
import html_tools
import base_widget
import libervia_widget

unicode = str # XXX: pyjama doesn't manage unicode


class ContactLabel(HTML):
    """Display a contact in HTML, selecting best display (jid/nick/etc)"""

    def __init__(self, host, jid_, display=C.CONTACT_DEFAULT_DISPLAY):
        """

        @param host (SatWebFrontend): host instance
        @param jid_ (jid.JID): contact JID
        @param display (tuple): prioritize the display methods of the contact's
            label with values in ("jid", "nick", "bare", "resource").
        """
        # TODO: add a listener for nick changes
        HTML.__init__(self)
        self.host = host
        self.jid = jid_
        if "nick" in display:
            self.nick = self.host.contact_lists[C.PROF_KEY_NONE].getCache(self.jid, "nick")
        self.display = display
        self.alert = False
        self.refresh()
        self.setStyleName('contactLabel')

    def refresh(self):
        alert_html = "<strong>(*)</strong>&nbsp;" if self.alert else ""
        contact_raw = None
        for disp in self.display:
            if disp == "jid":
                contact_raw = unicode(self.jid)
            elif disp == "nick":
                contact_raw = self.nick
            elif disp == "bare":
                contact_raw = unicode(self.jid.bare)
            elif disp == "resource":
                contact_raw = self.jid.resource
            else:
                raise exceptions.InternalError(u"Unknown display argument [{}]".format(disp))
            if contact_raw:
                break
        if not contact_raw:
            log.error(u"Counld not find a contact display for jid {jid} (display: {display})".format(jid=self.jid, display=self.display))
            contact_raw = "UNNAMED"
        contact_html = html_tools.html_sanitize(contact_raw)
        html = "%(alert)s%(contact)s" % {'alert': alert_html,
                                         'contact': contact_html}
        self.setHTML(html)

    def updateNick(self, new_nick):
        """Change the current nick

        @param new_nick(unicode): new nick to use
        """
        self.nick = new_nick
        self.refresh()

    def setAlert(self, alert):
        """Show a visual indicator

        @param alert: True if alert must be shown
        """
        self.alert = alert
        self.refresh()


class ContactMenuBar(base_widget.WidgetMenuBar):

    def onBrowserEvent(self, event):
        base_widget.WidgetMenuBar.onBrowserEvent(self, event)
        event.stopPropagation()  # prevent opening the chat dialog

    @classmethod
    def getCategoryHTML(cls, menu_name_i18n, type_):
        return '<img src="%s"/>' % C.DEFAULT_AVATAR_URL

    def setUrl(self, url):
        """Set the URL of the contact avatar."""
        self.items[0].setHTML('<img src="%s" />' % url)


class ContactBox(VerticalPanel, ClickHandler, libervia_widget.DragLabel):

    def __init__(self, host, jid_, style_name=None, menu_types=None, display=C.CONTACT_DEFAULT_DISPLAY):
        """
        @param host (SatWebFrontend): host instance
        @param jid_ (jid.JID): contact JID
        @param style_name (unicode): CSS style name
        @param menu_types (tuple): define the menu types that fit this
            contact panel, with values from the menus type constants.
        @param contacts_display (tuple): prioritize the display methods of the
            contact's label with values in ("jid", "nick", "bare", "resource").

        """
        VerticalPanel.__init__(self, StyleName=style_name or 'contactBox', VerticalAlignment='middle')
        ClickHandler.__init__(self)
        libervia_widget.DragLabel.__init__(self, jid_, "CONTACT", host)
        self.jid = jid_
        self.label = ContactLabel(host, self.jid, display=display)
        self.menu_types = menu_types
        self.avatar = ContactMenuBar(self, host) if menu_types else Image()
        try:  # FIXME: dirty hack to force using an Image when the menu is actually empty
            self.avatar.items[0]
        except IndexError:
            self.avatar = Image()
        self.updateAvatar(host.getAvatarURL(self.jid.bare))
        self.add(self.avatar)
        self.add(self.label)
        self.addClickListener(self)

    def addMenus(self, menu_bar):
        for menu_type in self.menu_types:
            menu_bar.addCachedMenus(menu_type, {'jid': unicode(self.jid.bare)})

    def setAlert(self, alert):
        """Show a visual indicator

        @param alert: True if alert indicator show be shown"""
        self.label.setAlert(alert)

    def updateAvatar(self, url):
        """Update the avatar.

        @param url (unicode): image url
        """
        self.avatar.setUrl(url)

    def updateNick(self, new_nick):
        """Update the nickname.

        @param new_nick (unicode): new nickname to use
        """
        self.label.updateNick(new_nick)

    def onClick(self, sender):
        try:
            self.parent.onClick(self.jid.bare)
        except (AttributeError, TypeError):
            pass
        else:
            self.setAlert(False)