gajim-plural/gajim/common/pep.py

158 lines
5.1 KiB
Python

# -*- coding:utf-8 -*-
## src/common/pep.py
##
## Copyright (C) 2007 Piotr Gaczkowski <doomhammerng AT gmail.com>
## Copyright (C) 2007-2014 Yann Leboulanger <asterix AT lagaule.org>
## Copyright (C) 2008 Brendan Taylor <whateley AT gmail.com>
## Jean-Marie Traissard <jim AT lapin.org>
## Jonathan Schleifer <js-common.gajim AT webkeks.org>
## Stephan Erb <steve-e AT h3c.de>
##
## This file is part of Gajim.
##
## Gajim is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published
## by the Free Software Foundation; version 3 only.
##
## Gajim 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 General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
##
import logging
log = logging.getLogger('gajim.c.pep')
import nbxmpp
from gajim.common import app
class AbstractPEP(object):
type_ = ''
namespace = ''
@classmethod
def get_tag_as_PEP(cls, jid, account, event_tag):
items = event_tag.getTag('items', {'node': cls.namespace})
if items:
log.debug("Received PEP 'user %s' from %s" % (cls.type_, jid))
return cls(jid, account, items)
else:
return None
def __init__(self, jid, account, items):
self._pep_specific_data, self._retracted = self._extract_info(items)
self._update_contacts(jid, account)
if jid == app.get_jid_from_account(account):
self._update_account(account)
self._on_receive(jid, account)
def _extract_info(self, items):
'''To be implemented by subclasses'''
raise NotImplementedError
def _update_contacts(self, jid, account):
for contact in app.contacts.get_contacts(account, jid):
if self._retracted:
if self.type_ in contact.pep:
del contact.pep[self.type_]
else:
contact.pep[self.type_] = self
def _update_account(self, account):
acc = app.connections[account]
if self._retracted:
if self.type_ in acc.pep:
del acc.pep[self.type_]
else:
acc.pep[self.type_] = self
def asMarkupText(self):
'''SHOULD be implemented by subclasses'''
return ''
def _on_receive(self, jid, account):
'''SHOULD be implemented by subclasses'''
pass
class UserNicknamePEP(AbstractPEP):
'''XEP-0172: User Nickname'''
type_ = 'nickname'
namespace = nbxmpp.NS_NICK
def _extract_info(self, items):
nick = ''
for item in items.getTags('item'):
child = item.getTag('nick')
if child:
nick = child.getData()
break
retracted = items.getTag('retract') or not nick
return (nick, retracted)
def _update_contacts(self, jid, account):
nick = '' if self._retracted else self._pep_specific_data
for contact in app.contacts.get_contacts(account, jid):
contact.contact_name = nick
def _update_account(self, account):
if self._retracted:
app.nicks[account] = app.config.get_per('accounts', account, 'name')
else:
app.nicks[account] = self._pep_specific_data
class AvatarNotificationPEP(AbstractPEP):
'''XEP-0084: Avatars'''
type_ = 'avatar-notification'
namespace = 'urn:xmpp:avatar:metadata'
def _extract_info(self, items):
self.avatar = None
for item in items.getTags('item'):
metadata = item.getTag('metadata')
if metadata is None:
app.log('c.m.user_avatar').warning(
'Invalid avatar stanza:\n%s', items)
break
info = item.getTag('metadata').getTag('info')
if info is not None:
self.avatar = info.getAttrs()
break
return (None, False)
def _on_receive(self, jid, account):
con = app.connections[account]
if self.avatar is None:
# Remove avatar
app.log('c.m.user_avatar').info('Remove: %s', jid)
app.contacts.set_avatar(account, jid, None)
own_jid = con.get_own_jid().getStripped()
app.logger.set_avatar_sha(own_jid, jid, None)
app.interface.update_avatar(account, jid)
else:
sha = app.contacts.get_avatar_sha(account, jid)
app.log('c.m.user_avatar').info(
'Update: %s %s', jid, self.avatar['id'])
if sha == self.avatar['id']:
app.log('c.m.user_avatar').info(
'Avatar already known: %s %s',
jid, self.avatar['id'])
return
con.get_module('UserAvatar').get_pubsub_avatar(
jid, self.avatar['id'])
SUPPORTED_PERSONAL_USER_EVENTS = [
UserNicknamePEP, AvatarNotificationPEP]