80ef13612b
- moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
970 lines
46 KiB
Python
Executable file
970 lines
46 KiB
Python
Executable file
#!/usr/bin/env python2
|
||
# -*- coding: utf-8 -*-
|
||
|
||
# SAT plugin for microblogging over XMPP (xep-0277)
|
||
# Copyright (C) 2009-2018 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/>.
|
||
|
||
from sat.core.i18n import _
|
||
from sat.core.constants import Const as C
|
||
from sat.core.log import getLogger
|
||
log = getLogger(__name__)
|
||
from twisted.words.protocols.jabber import jid, error
|
||
from twisted.words.protocols.jabber.xmlstream import XMPPHandler
|
||
from twisted.words.xish import domish
|
||
from twisted.internet import defer
|
||
from twisted.python import failure
|
||
from sat.core import exceptions
|
||
from sat.tools import xml_tools
|
||
from sat.tools import sat_defer
|
||
from sat.tools import utils
|
||
from sat.tools.common import data_format
|
||
from sat.tools.common import uri as xmpp_uri
|
||
|
||
# XXX: sat_tmp.wokkel.pubsub is actually used instead of wokkel version
|
||
from wokkel import pubsub
|
||
from wokkel import disco, iwokkel
|
||
from zope.interface import implements
|
||
import shortuuid
|
||
import time
|
||
import dateutil
|
||
import calendar
|
||
import urlparse
|
||
|
||
NS_MICROBLOG = 'urn:xmpp:microblog:0'
|
||
NS_ATOM = 'http://www.w3.org/2005/Atom'
|
||
NS_PUBSUB_EVENT = "{}{}".format(pubsub.NS_PUBSUB, "#event")
|
||
NS_COMMENT_PREFIX = '{}:comments/'.format(NS_MICROBLOG)
|
||
|
||
|
||
PLUGIN_INFO = {
|
||
C.PI_NAME: "Microblogging over XMPP Plugin",
|
||
C.PI_IMPORT_NAME: "XEP-0277",
|
||
C.PI_TYPE: "XEP",
|
||
C.PI_PROTOCOLS: ["XEP-0277"],
|
||
C.PI_DEPENDENCIES: ["XEP-0163", "XEP-0060", "TEXT-SYNTAXES"],
|
||
C.PI_RECOMMENDATIONS: ["XEP-0059", "EXTRA-PEP"],
|
||
C.PI_MAIN: "XEP_0277",
|
||
C.PI_HANDLER: "yes",
|
||
C.PI_DESCRIPTION: _("""Implementation of microblogging Protocol""")
|
||
}
|
||
|
||
|
||
class NodeAccessChangeException(Exception):
|
||
pass
|
||
|
||
|
||
class XEP_0277(object):
|
||
namespace = NS_MICROBLOG
|
||
|
||
def __init__(self, host):
|
||
log.info(_(u"Microblogging plugin initialization"))
|
||
self.host = host
|
||
host.registerNamespace('microblog', NS_MICROBLOG)
|
||
self._p = self.host.plugins["XEP-0060"] # this facilitate the access to pubsub plugin
|
||
self.rt_sessions = sat_defer.RTDeferredSessions()
|
||
self.host.plugins["XEP-0060"].addManagedNode(NS_MICROBLOG, items_cb=self._itemsReceived)
|
||
|
||
host.bridge.addMethod("mbSend", ".plugin",
|
||
in_sign='ssa{ss}s', out_sign='',
|
||
method=self._mbSend,
|
||
async=True)
|
||
host.bridge.addMethod("mbRetract", ".plugin",
|
||
in_sign='ssss', out_sign='',
|
||
method=self._mbRetract,
|
||
async=True)
|
||
host.bridge.addMethod("mbGet", ".plugin",
|
||
in_sign='ssiasa{ss}s', out_sign='(aa{ss}a{ss})',
|
||
method=self._mbGet,
|
||
async=True)
|
||
host.bridge.addMethod("mbSetAccess", ".plugin", in_sign='ss', out_sign='',
|
||
method=self.mbSetAccess,
|
||
async=True)
|
||
host.bridge.addMethod("mbSubscribeToMany", ".plugin", in_sign='sass', out_sign='s',
|
||
method=self._mbSubscribeToMany)
|
||
host.bridge.addMethod("mbGetFromManyRTResult", ".plugin", in_sign='ss', out_sign='(ua(sssaa{ss}a{ss}))',
|
||
method=self._mbGetFromManyRTResult, async=True)
|
||
host.bridge.addMethod("mbGetFromMany", ".plugin", in_sign='sasia{ss}s', out_sign='s',
|
||
method=self._mbGetFromMany)
|
||
host.bridge.addMethod("mbGetFromManyWithCommentsRTResult", ".plugin", in_sign='ss', out_sign='(ua(sssa(a{ss}a(sssaa{ss}a{ss}))a{ss}))',
|
||
method=self._mbGetFromManyWithCommentsRTResult, async=True)
|
||
host.bridge.addMethod("mbGetFromManyWithComments", ".plugin", in_sign='sasiia{ss}a{ss}s', out_sign='s',
|
||
method=self._mbGetFromManyWithComments)
|
||
|
||
def getHandler(self, client):
|
||
return XEP_0277_handler()
|
||
|
||
def _checkFeaturesCb(self, available):
|
||
return {'available': C.BOOL_TRUE}
|
||
|
||
def _checkFeaturesEb(self, fail):
|
||
return {'available': C.BOOL_FALSE}
|
||
|
||
def getFeatures(self, profile):
|
||
client = self.host.getClient(profile)
|
||
d = self.host.checkFeatures(client, [], identity=('pubsub', 'pep'))
|
||
d.addCallbacks(self._checkFeaturesCb, self._checkFeaturesEb)
|
||
return d
|
||
|
||
## plugin management methods ##
|
||
|
||
def _itemsReceived(self, client, itemsEvent):
|
||
"""Callback which manage items notifications (publish + retract)"""
|
||
def manageItem(data, event):
|
||
self.host.bridge.psEvent(C.PS_MICROBLOG, itemsEvent.sender.full(), itemsEvent.nodeIdentifier, event, data, client.profile)
|
||
|
||
for item in itemsEvent.items:
|
||
if item.name == C.PS_ITEM:
|
||
self.item2mbdata(item).addCallbacks(manageItem, lambda failure: None, (C.PS_PUBLISH,))
|
||
elif item.name == C.PS_RETRACT:
|
||
manageItem({'id': item['id']}, C.PS_RETRACT)
|
||
else:
|
||
raise exceptions.InternalError("Invalid event value")
|
||
|
||
|
||
## data/item transformation ##
|
||
|
||
@defer.inlineCallbacks
|
||
def item2mbdata(self, item_elt):
|
||
"""Convert an XML Item to microblog data used in bridge API
|
||
|
||
@param item_elt: domish.Element of microblog item
|
||
@return: microblog data (dictionary)
|
||
"""
|
||
microblog_data = {}
|
||
|
||
def check_conflict(key, increment=False):
|
||
"""Check if key is already in microblog data
|
||
|
||
@param key(unicode): key to check
|
||
@param increment(bool): if suffix the key with an increment
|
||
instead of raising an exception
|
||
@raise exceptions.DataError: the key already exists
|
||
(not raised if increment is True)
|
||
"""
|
||
if key in microblog_data:
|
||
if not increment:
|
||
raise failure.Failure(exceptions.DataError("key {} is already present for item {}").format(key, item_elt['id']))
|
||
else:
|
||
idx=1 # the idx 0 is the key without suffix
|
||
fmt = "{}#{}"
|
||
new_key = fmt.format(key, idx)
|
||
while new_key in microblog_data:
|
||
idx+=1
|
||
new_key = fmt.format(key, idx)
|
||
key = new_key
|
||
return key
|
||
|
||
@defer.inlineCallbacks
|
||
def parseElement(elem):
|
||
"""Parse title/content elements and fill microblog_data accordingly"""
|
||
type_ = elem.getAttribute('type')
|
||
if type_ == 'xhtml':
|
||
data_elt = elem.firstChildElement()
|
||
if data_elt is None:
|
||
raise failure.Failure(exceptions.DataError(u"XHML content not wrapped in a <div/> element, this is not standard !"))
|
||
if data_elt.uri != C.NS_XHTML:
|
||
raise failure.Failure(exceptions.DataError(_('Content of type XHTML must declare its namespace!')))
|
||
key = check_conflict(u'{}_xhtml'.format(elem.name))
|
||
data = data_elt.toXml()
|
||
microblog_data[key] = yield self.host.plugins["TEXT-SYNTAXES"].cleanXHTML(data)
|
||
else:
|
||
key = check_conflict(elem.name)
|
||
microblog_data[key] = unicode(elem)
|
||
|
||
|
||
id_ = item_elt.getAttribute('id', '') # there can be no id for transient nodes
|
||
microblog_data[u'id'] = id_
|
||
if item_elt.uri not in (pubsub.NS_PUBSUB, NS_PUBSUB_EVENT):
|
||
msg = u"Unsupported namespace {ns} in pubsub item {id_}".format(ns=item_elt.uri, id_=id_)
|
||
log.warning(msg)
|
||
raise failure.Failure(exceptions.DataError(msg))
|
||
|
||
try:
|
||
entry_elt = item_elt.elements(NS_ATOM, 'entry').next()
|
||
except StopIteration:
|
||
msg = u'No atom entry found in the pubsub item {}'.format(id_)
|
||
raise failure.Failure(exceptions.DataError(msg))
|
||
|
||
# language
|
||
try:
|
||
microblog_data[u'language'] = entry_elt[(C.NS_XML, u'lang')].strip()
|
||
except KeyError:
|
||
pass
|
||
|
||
# atom:id
|
||
try:
|
||
id_elt = entry_elt.elements(NS_ATOM, 'id').next()
|
||
except StopIteration:
|
||
msg = u'No atom id found in the pubsub item {}, this is not standard !'.format(id_)
|
||
log.warning(msg)
|
||
microblog_data[u'atom_id'] = ""
|
||
else:
|
||
microblog_data[u'atom_id'] = unicode(id_elt)
|
||
|
||
# title/content(s)
|
||
|
||
# FIXME: ATOM and XEP-0277 only allow 1 <title/> element
|
||
# but in the wild we have some blogs with several ones
|
||
# so we don't respect the standard for now (it doesn't break
|
||
# anything anyway), and we'll find a better option later
|
||
# try:
|
||
# title_elt = entry_elt.elements(NS_ATOM, 'title').next()
|
||
# except StopIteration:
|
||
# msg = u'No atom title found in the pubsub item {}'.format(id_)
|
||
# raise failure.Failure(exceptions.DataError(msg))
|
||
title_elts = list(entry_elt.elements(NS_ATOM, 'title'))
|
||
if not title_elts:
|
||
msg = u'No atom title found in the pubsub item {}'.format(id_)
|
||
raise failure.Failure(exceptions.DataError(msg))
|
||
for title_elt in title_elts:
|
||
yield parseElement(title_elt)
|
||
|
||
# FIXME: as for <title/>, Atom only authorise at most 1 content
|
||
# but XEP-0277 allows several ones. So for no we handle as
|
||
# if more than one can be present
|
||
for content_elt in entry_elt.elements(NS_ATOM, 'content'):
|
||
yield parseElement(content_elt)
|
||
|
||
# we check that text content is present
|
||
for key in ('title', 'content'):
|
||
if key not in microblog_data and ('{}_xhtml'.format(key)) in microblog_data:
|
||
log.warning(u"item {id_} provide a {key}_xhtml data but not a text one".format(id_=id_, key=key))
|
||
# ... and do the conversion if it's not
|
||
microblog_data[key] = yield self.host.plugins["TEXT-SYNTAXES"].\
|
||
convert(microblog_data[u'{}_xhtml'.format(key)],
|
||
self.host.plugins["TEXT-SYNTAXES"].SYNTAX_XHTML,
|
||
self.host.plugins["TEXT-SYNTAXES"].SYNTAX_TEXT,
|
||
False)
|
||
|
||
if 'content' not in microblog_data:
|
||
# use the atom title data as the microblog body content
|
||
microblog_data[u'content'] = microblog_data[u'title']
|
||
del microblog_data[u'title']
|
||
if 'title_xhtml' in microblog_data:
|
||
microblog_data[u'content_xhtml'] = microblog_data[u'title_xhtml']
|
||
del microblog_data[u'title_xhtml']
|
||
|
||
# published/updated dates
|
||
try:
|
||
updated_elt = entry_elt.elements(NS_ATOM, 'updated').next()
|
||
except StopIteration:
|
||
msg = u'No atom updated element found in the pubsub item {}'.format(id_)
|
||
raise failure.Failure(exceptions.DataError(msg))
|
||
microblog_data[u'updated'] = unicode(calendar.timegm(dateutil.parser.parse(unicode(updated_elt)).utctimetuple()))
|
||
try:
|
||
published_elt = entry_elt.elements(NS_ATOM, 'published').next()
|
||
except StopIteration:
|
||
microblog_data[u'published'] = microblog_data[u'updated']
|
||
else:
|
||
microblog_data[u'published'] = unicode(calendar.timegm(dateutil.parser.parse(unicode(published_elt)).utctimetuple()))
|
||
|
||
# links
|
||
for link_elt in entry_elt.elements(NS_ATOM, 'link'):
|
||
if link_elt.getAttribute('rel') == 'replies' and link_elt.getAttribute('title') == 'comments':
|
||
key = check_conflict('comments', True)
|
||
microblog_data[key] = link_elt['href']
|
||
try:
|
||
service, node = self.parseCommentUrl(microblog_data[key])
|
||
except:
|
||
log.warning(u"Can't parse url {}".format(microblog_data[key]))
|
||
del microblog_data[key]
|
||
else:
|
||
microblog_data[u'{}_service'.format(key)] = service.full()
|
||
microblog_data[u'{}_node'.format(key)] = node
|
||
else:
|
||
rel = link_elt.getAttribute('rel','')
|
||
title = link_elt.getAttribute('title','')
|
||
href = link_elt.getAttribute('href','')
|
||
log.warning(u"Unmanaged link element: rel={rel} title={title} href={href}".format(rel=rel, title=title, href=href))
|
||
|
||
# author
|
||
try:
|
||
author_elt = entry_elt.elements(NS_ATOM, 'author').next()
|
||
except StopIteration:
|
||
log.debug(u"Can't find author element in item {}".format(id_))
|
||
else:
|
||
publisher = item_elt.getAttribute("publisher")
|
||
# name
|
||
try:
|
||
name_elt = author_elt.elements(NS_ATOM, 'name').next()
|
||
except StopIteration:
|
||
log.warning(u"No name element found in author element of item {}".format(id_))
|
||
else:
|
||
microblog_data[u'author'] = unicode(name_elt)
|
||
# uri
|
||
try:
|
||
uri_elt = author_elt.elements(NS_ATOM, 'uri').next()
|
||
except StopIteration:
|
||
log.debug(u"No uri element found in author element of item {}".format(id_))
|
||
if publisher:
|
||
microblog_data[u'author_jid'] = publisher
|
||
else:
|
||
uri = unicode(uri_elt)
|
||
if uri.startswith("xmpp:"):
|
||
uri = uri[5:]
|
||
microblog_data[u'author_jid'] = uri
|
||
else:
|
||
microblog_data[u'author_jid'] = item_elt.getAttribute(u"publisher") or ""
|
||
|
||
if not publisher:
|
||
log.debug(u"No publisher attribute, we can't verify author jid")
|
||
microblog_data[u'author_jid_verified'] = C.BOOL_FALSE
|
||
elif jid.JID(publisher).userhostJID() == jid.JID(uri).userhostJID():
|
||
microblog_data[u'author_jid_verified'] = C.BOOL_TRUE
|
||
else:
|
||
log.warning(u"item atom:uri differ from publisher attribute, spoofing attempt ? atom:uri = {} publisher = {}".format(uri, item_elt.getAttribute("publisher")))
|
||
microblog_data[u'author_jid_verified'] = C.BOOL_FALSE
|
||
# email
|
||
try:
|
||
email_elt = author_elt.elements(NS_ATOM, 'email').next()
|
||
except StopIteration:
|
||
pass
|
||
else:
|
||
microblog_data[u'author_email'] = unicode(email_elt)
|
||
|
||
# categories
|
||
categories = (category_elt.getAttribute('term','') for category_elt in entry_elt.elements(NS_ATOM, 'category'))
|
||
data_format.iter2dict('tag', categories, microblog_data)
|
||
|
||
## the trigger ##
|
||
# if other plugins have things to add or change
|
||
yield self.host.trigger.point("XEP-0277_item2data", item_elt, entry_elt, microblog_data)
|
||
|
||
defer.returnValue(microblog_data)
|
||
|
||
@defer.inlineCallbacks
|
||
def data2entry(self, client, data, item_id, service, node):
|
||
"""Convert a data dict to en entry usable to create an item
|
||
|
||
@param data: data dict as given by bridge method.
|
||
@param item_id(unicode): id of the item to use
|
||
@param service(jid.JID, None): pubsub service where the item is sent
|
||
Needed to construct Atom id
|
||
@param node(unicode): pubsub node where the item is sent
|
||
Needed to construct Atom id
|
||
@return: deferred which fire domish.Element
|
||
"""
|
||
entry_elt = domish.Element((NS_ATOM, 'entry'))
|
||
|
||
## language ##
|
||
if u'language' in data:
|
||
entry_elt[(C.NS_XML, u'lang')] = data[u'language'].strip()
|
||
|
||
## content and title ##
|
||
synt = self.host.plugins["TEXT-SYNTAXES"]
|
||
|
||
for elem_name in ('title', 'content'):
|
||
for type_ in ['', '_rich', '_xhtml']:
|
||
attr = "{}{}".format(elem_name, type_)
|
||
if attr in data:
|
||
elem = entry_elt.addElement(elem_name)
|
||
if type_:
|
||
if type_ == '_rich': # convert input from current syntax to XHTML
|
||
xml_content = yield synt.convert(data[attr], synt.getCurrentSyntax(client.profile), "XHTML")
|
||
if '{}_xhtml'.format(elem_name) in data:
|
||
raise failure.Failure(exceptions.DataError(_("Can't have xhtml and rich content at the same time")))
|
||
else:
|
||
xml_content = data[attr]
|
||
|
||
div_elt = xml_tools.ElementParser()(xml_content, namespace=C.NS_XHTML)
|
||
if div_elt.name != 'div' or div_elt.uri != C.NS_XHTML or div_elt.attributes:
|
||
# we need a wrapping <div/> at the top with XHTML namespace
|
||
wrap_div_elt = domish.Element((C.NS_XHTML, 'div'))
|
||
wrap_div_elt.addChild(div_elt)
|
||
div_elt = wrap_div_elt
|
||
elem.addChild(div_elt)
|
||
elem['type'] = 'xhtml'
|
||
if elem_name not in data:
|
||
# there is raw text content, which is mandatory
|
||
# so we create one from xhtml content
|
||
elem_txt = entry_elt.addElement(elem_name)
|
||
text_content = yield self.host.plugins["TEXT-SYNTAXES"].convert(xml_content,
|
||
self.host.plugins["TEXT-SYNTAXES"].SYNTAX_XHTML,
|
||
self.host.plugins["TEXT-SYNTAXES"].SYNTAX_TEXT,
|
||
False)
|
||
elem_txt.addContent(text_content)
|
||
elem_txt['type'] = 'text'
|
||
|
||
else: # raw text only needs to be escaped to get HTML-safe sequence
|
||
elem.addContent(data[attr])
|
||
elem['type'] = 'text'
|
||
|
||
try:
|
||
entry_elt.elements(NS_ATOM, 'title').next()
|
||
except StopIteration:
|
||
# we have no title element which is mandatory
|
||
# so we transform content element to title
|
||
elems = list(entry_elt.elements(NS_ATOM, 'content'))
|
||
if not elems:
|
||
raise exceptions.DataError("There must be at least one content or title element")
|
||
for elem in elems:
|
||
elem.name = 'title'
|
||
|
||
## author ##
|
||
author_elt = entry_elt.addElement('author')
|
||
try:
|
||
author_name = data['author']
|
||
except KeyError:
|
||
# FIXME: must use better name
|
||
author_name = client.jid.user
|
||
author_elt.addElement('name', content=author_name)
|
||
|
||
try:
|
||
author_jid_s = data['author_jid']
|
||
except KeyError:
|
||
author_jid_s = client.jid.userhost()
|
||
author_elt.addElement('uri', content="xmpp:{}".format(author_jid_s))
|
||
|
||
try:
|
||
author_jid_s = data['author_email']
|
||
except KeyError:
|
||
pass
|
||
|
||
## published/updated time ##
|
||
current_time = time.time()
|
||
entry_elt.addElement('updated',
|
||
content = utils.xmpp_date(float(data.get('updated', current_time))))
|
||
entry_elt.addElement('published',
|
||
content = utils.xmpp_date(float(data.get('published', current_time))))
|
||
|
||
## categories ##
|
||
for tag in data_format.dict2iter("tag", data):
|
||
category_elt = entry_elt.addElement("category")
|
||
category_elt['term'] = tag
|
||
|
||
## id ##
|
||
entry_id = data.get('id', xmpp_uri.buildXMPPUri(
|
||
u'pubsub',
|
||
path=service.full() if service is not None else client.jid.userhost(),
|
||
node=node,
|
||
item=item_id))
|
||
entry_elt.addElement('id', content=entry_id) #
|
||
|
||
## comments ##
|
||
if 'comments' in data:
|
||
link_elt = entry_elt.addElement('link')
|
||
link_elt['href'] = data['comments']
|
||
link_elt['rel'] = 'replies'
|
||
link_elt['title'] = 'comments'
|
||
|
||
## final item building ##
|
||
item_elt = pubsub.Item(id=item_id, payload=entry_elt)
|
||
|
||
## the trigger ##
|
||
# if other plugins have things to add or change
|
||
yield self.host.trigger.point("XEP-0277_data2entry", client, data, entry_elt, item_elt)
|
||
|
||
defer.returnValue(item_elt)
|
||
|
||
## publish ##
|
||
|
||
def getCommentsNode(self, item_id):
|
||
"""Generate comment node
|
||
|
||
@param item_id(unicode): id of the parent item
|
||
@return (unicode): comment node to use
|
||
"""
|
||
return u"{}{}".format(NS_COMMENT_PREFIX, item_id)
|
||
|
||
def getCommentsService(self, client, parent_service=None):
|
||
"""Get prefered PubSub service to create comment node
|
||
|
||
@param pubsub_service(jid.JID, None): PubSub service of the parent item
|
||
@param return((D)jid.JID, None): PubSub service to use
|
||
"""
|
||
if parent_service is not None:
|
||
if parent_service.user:
|
||
# we are on a PEP
|
||
if parent_service.host == client.jid.host:
|
||
# it's our server, we use already found client.pubsub_service below
|
||
pass
|
||
else:
|
||
# other server, let's try to find a non PEP service there
|
||
d = self.host.findServiceEntity(client, "pubsub", "service", parent_service)
|
||
d.addCallback(lambda entity: entity or parent_service)
|
||
else:
|
||
# parent is already on a normal Pubsub service, we re-use it
|
||
return defer.succeed(parent_service)
|
||
|
||
return defer.succeed(client.pubsub_service if client.pubsub_service is not None else parent_service)
|
||
|
||
@defer.inlineCallbacks
|
||
def _manageComments(self, client, mb_data, service, node, item_id, access=None):
|
||
"""Check comments keys in mb_data and create comments node if necessary
|
||
|
||
if mb_data['comments'] exists, it is used (or mb_data['comments_service'] and/or mb_data['comments_node']),
|
||
else it is generated (if allow_comments is True).
|
||
@param mb_data(dict): microblog mb_data
|
||
@param service(jid.JID, None): PubSub service of the parent item
|
||
@param node(unicode): node of the parent item
|
||
@param item_id(unicode): id of the parent item
|
||
@param access(unicode, None): access model
|
||
None to use same access model as parent item
|
||
"""
|
||
# FIXME: if 'comments' already exists in mb_data, it is not used to create the Node
|
||
allow_comments = C.bool(mb_data.pop("allow_comments", "false"))
|
||
if not allow_comments:
|
||
if 'comments' in mb_data:
|
||
log.warning(u"comments are not allowed but there is already a comments node, it may be lost: {uri}".format(uri=mb_data['comments']))
|
||
del mb_data['comments']
|
||
return
|
||
|
||
if access is None:
|
||
# TODO: cache access models per service/node
|
||
parent_node_config = yield self._p.getConfiguration(client, service, node)
|
||
access = parent_node_config.get(self._p.OPT_ACCESS_MODEL, self._p.ACCESS_OPEN)
|
||
|
||
options = {self._p.OPT_ACCESS_MODEL: access,
|
||
self._p.OPT_PERSIST_ITEMS: 1,
|
||
self._p.OPT_MAX_ITEMS: -1,
|
||
self._p.OPT_DELIVER_PAYLOADS: 1,
|
||
self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
|
||
# FIXME: would it make sense to restrict publish model to subscribers?
|
||
self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN,
|
||
}
|
||
|
||
# if other plugins need to change the options
|
||
yield self.host.trigger.point("XEP-0277_comments", client, mb_data, options)
|
||
|
||
try:
|
||
comments_node = mb_data['comments_node']
|
||
except KeyError:
|
||
comments_node = self.getCommentsNode(item_id)
|
||
else:
|
||
if not comments_node:
|
||
raise exceptions.DataError(u"if comments_node is present, it must not be empty")
|
||
|
||
try:
|
||
comments_service = jid.JID(mb_data['comments_service'])
|
||
except KeyError:
|
||
comments_service = yield self.getCommentsService(client, service)
|
||
|
||
try:
|
||
yield self._p.createNode(client, comments_service, comments_node, options)
|
||
except error.StanzaError as e:
|
||
if e.condition == 'conflict':
|
||
log.info(u"node {} already exists on service {}".format(comments_node, comments_service))
|
||
else:
|
||
raise e
|
||
else:
|
||
if access == self._p.ACCESS_WHITELIST:
|
||
# for whitelist access we need to copy affiliations from parent item
|
||
comments_affiliations = yield self._p.getNodeAffiliations(client, service, node)
|
||
# …except for "member", that we transform to publisher
|
||
# because we wants members to be able to write to comments
|
||
for jid_, affiliation in comments_affiliations.items():
|
||
if affiliation == 'member':
|
||
comments_affiliations[jid_] == 'publisher'
|
||
|
||
yield self._p.setNodeAffiliations(client, comments_service, comments_node, comments_affiliations)
|
||
|
||
if comments_service is None:
|
||
comments_service = client.jid.userhostJID()
|
||
|
||
if 'comments' in mb_data:
|
||
if not mb_data['comments']:
|
||
raise exceptions.DataError(u"if comments is present, it must not be empty")
|
||
if 'comments_node' in mb_data or 'comments_service' in mb_data:
|
||
raise exceptions.DataError(u"You can't use comments_service/comments_node and comments at the same time")
|
||
else:
|
||
mb_data['comments'] = self._p.getNodeURI(comments_service, comments_node)
|
||
|
||
def _mbSend(self, service, node, data, profile_key):
|
||
service = jid.JID(service) if service else None
|
||
node = node if node else NS_MICROBLOG
|
||
client = self.host.getClient(profile_key)
|
||
return self.send(client, data, service, node)
|
||
|
||
@defer.inlineCallbacks
|
||
def send(self, client, data, service=None, node=NS_MICROBLOG):
|
||
"""Send XEP-0277's microblog data
|
||
|
||
@param data(dict): microblog data (must include at least a "content" or a "title" key).
|
||
see http://wiki.goffi.org/wiki/Bridge_API_-_Microblogging/en for details
|
||
@param service(jid.JID, None): PubSub service where the microblog must be published
|
||
None to publish on profile's PEP
|
||
@param node(unicode, None): PubSub node to use (defaut to microblog NS)
|
||
None is equivalend as using default value
|
||
"""
|
||
# TODO: check that all data keys are used, this would avoid sending publicly a private message
|
||
# by accident (e.g. if group pluging is not loaded, and "grou*" key are not used)
|
||
if node is None:
|
||
node = NS_MICROBLOG
|
||
|
||
item_id = data.get('id') or unicode(shortuuid.uuid())
|
||
|
||
try:
|
||
yield self._manageComments(client, data, service, node, item_id, access=None)
|
||
except error.StanzaError:
|
||
log.warning(u"Can't create comments node for item {}".format(item_id))
|
||
item = yield self.data2entry(client, data, item_id, service, node)
|
||
ret = yield self._p.publish(client, service, node, [item])
|
||
defer.returnValue(ret)
|
||
|
||
## retract ##
|
||
|
||
def _mbRetract(self, service_jid_s, nodeIdentifier, itemIdentifier, profile_key):
|
||
"""Call self._p._retractItem, but use default node if node is empty"""
|
||
return self._p._retractItem(service_jid_s, nodeIdentifier or NS_MICROBLOG, itemIdentifier, True, profile_key)
|
||
|
||
## get ##
|
||
|
||
def _mbGet(self, service='', node='', max_items=10, item_ids=None, extra_dict=None, profile_key=C.PROF_KEY_NONE):
|
||
"""
|
||
@param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
|
||
@param item_ids (list[unicode]): list of item IDs
|
||
"""
|
||
client = self.host.getClient(profile_key)
|
||
service = jid.JID(service) if service else None
|
||
max_items = None if max_items == C.NO_LIMIT else max_items
|
||
extra = self._p.parseExtra(extra_dict)
|
||
return self.mbGet(client, service, node or None, max_items, item_ids, extra.rsm_request, extra.extra)
|
||
|
||
|
||
@defer.inlineCallbacks
|
||
def mbGet(self, client, service=None, node=None, max_items=10, item_ids=None, rsm_request=None, extra=None):
|
||
"""Get some microblogs
|
||
|
||
@param service(jid.JID, None): jid of the publisher
|
||
None to get profile's PEP
|
||
@param node(unicode, None): node to get (or microblog node if None)
|
||
@param max_items(int): maximum number of item to get, None for no limit
|
||
@param item_ids (list[unicode]): list of item IDs
|
||
@param rsm_request (rsm.RSMRequest): RSM request data
|
||
@param extra (dict): extra data
|
||
|
||
@return: a deferred couple with the list of items and metadatas.
|
||
"""
|
||
if node is None:
|
||
node = NS_MICROBLOG
|
||
items_data = yield self._p.getItems(client, service, node, max_items=max_items, item_ids=item_ids, rsm_request=rsm_request, extra=extra)
|
||
serialised = yield self._p.serItemsDataD(items_data, self.item2mbdata)
|
||
defer.returnValue(serialised)
|
||
|
||
def parseCommentUrl(self, node_url):
|
||
"""Parse a XMPP URI
|
||
|
||
Determine the fields comments_service and comments_node of a microblog data
|
||
from the href attribute of an entry's link element. For example this input:
|
||
xmpp:sat-pubsub.example.net?;node=urn%3Axmpp%3Acomments%3A_af43b363-3259-4b2a-ba4c-1bc33aa87634__urn%3Axmpp%3Agroupblog%3Asomebody%40example.net
|
||
will return(JID(u'sat-pubsub.example.net'), 'urn:xmpp:comments:_af43b363-3259-4b2a-ba4c-1bc33aa87634__urn:xmpp:groupblog:somebody@example.net')
|
||
@return (tuple[jid.JID, unicode]): service and node
|
||
"""
|
||
parsed_url = urlparse.urlparse(node_url, 'xmpp')
|
||
service = jid.JID(parsed_url.path)
|
||
parsed_queries = urlparse.parse_qs(parsed_url.query.encode('utf-8'))
|
||
node = parsed_queries.get('node', [''])[0].decode('utf-8')
|
||
|
||
if not node:
|
||
raise failure.Failure(exceptions.DataError('Invalid comments link'))
|
||
|
||
return (service, node)
|
||
|
||
## configure ##
|
||
|
||
def mbSetAccess(self, access="presence", profile_key=C.PROF_KEY_NONE):
|
||
"""Create a microblog node on PEP with given access
|
||
|
||
If the node already exists, it change options
|
||
@param access: Node access model, according to xep-0060 #4.5
|
||
@param profile_key: profile key
|
||
"""
|
||
# FIXME: check if this mehtod is need, deprecate it if not
|
||
client = self.host.getClient(profile_key)
|
||
|
||
_options = {self._p.OPT_ACCESS_MODEL: access, self._p.OPT_PERSIST_ITEMS: 1, self._p.OPT_MAX_ITEMS: -1, self._p.OPT_DELIVER_PAYLOADS: 1, self._p.OPT_SEND_ITEM_SUBSCRIBE: 1}
|
||
|
||
def cb(result):
|
||
#Node is created with right permission
|
||
log.debug(_(u"Microblog node has now access %s") % access)
|
||
|
||
def fatal_err(s_error):
|
||
#Something went wrong
|
||
log.error(_(u"Can't set microblog access"))
|
||
raise NodeAccessChangeException()
|
||
|
||
def err_cb(s_error):
|
||
#If the node already exists, the condition is "conflict",
|
||
#else we have an unmanaged error
|
||
if s_error.value.condition == 'conflict':
|
||
#d = self.host.plugins["XEP-0060"].deleteNode(client, client.jid.userhostJID(), NS_MICROBLOG)
|
||
#d.addCallback(lambda x: create_node().addCallback(cb).addErrback(fatal_err))
|
||
change_node_options().addCallback(cb).addErrback(fatal_err)
|
||
else:
|
||
fatal_err(s_error)
|
||
|
||
def create_node():
|
||
return self._p.createNode(client, client.jid.userhostJID(), NS_MICROBLOG, _options)
|
||
|
||
def change_node_options():
|
||
return self._p.setOptions(client.jid.userhostJID(), NS_MICROBLOG, client.jid.userhostJID(), _options, profile_key=profile_key)
|
||
|
||
create_node().addCallback(cb).addErrback(err_cb)
|
||
|
||
## methods to manage several stanzas/jids at once ##
|
||
|
||
# common
|
||
|
||
def _getClientAndNodeData(self, publishers_type, publishers, profile_key):
|
||
"""Helper method to construct node_data from publishers_type/publishers
|
||
|
||
@param publishers_type: type of the list of publishers, one of:
|
||
C.ALL: get all jids from roster, publishers is not used
|
||
C.GROUP: get jids from groups
|
||
C.JID: use publishers directly as list of jids
|
||
@param publishers: list of publishers, according to "publishers_type" (None, list of groups or list of jids)
|
||
@param profile_key: %(doc_profile_key)s
|
||
"""
|
||
client = self.host.getClient(profile_key)
|
||
if publishers_type == C.JID:
|
||
jids_set = set(publishers)
|
||
else:
|
||
jids_set = client.roster.getJidsSet(publishers_type, publishers)
|
||
if publishers_type == C.ALL:
|
||
try: # display messages from salut-a-toi@libervia.org or other PEP services
|
||
services = self.host.plugins["EXTRA-PEP"].getFollowedEntities(profile_key)
|
||
except KeyError:
|
||
pass # plugin is not loaded
|
||
else:
|
||
if services:
|
||
log.debug("Extra PEP followed entities: %s" % ", ".join([unicode(service) for service in services]))
|
||
jids_set.update(services)
|
||
|
||
node_data = []
|
||
for jid_ in jids_set:
|
||
node_data.append((jid_, NS_MICROBLOG))
|
||
return client, node_data
|
||
|
||
def _checkPublishers(self, publishers_type, publishers):
|
||
"""Helper method to deserialise publishers coming from bridge
|
||
|
||
publishers_type(unicode): type of the list of publishers, one of:
|
||
publishers: list of publishers according to type
|
||
@return: deserialised (publishers_type, publishers) tuple
|
||
"""
|
||
if publishers_type == C.ALL:
|
||
if publishers:
|
||
raise failure.Failure(ValueError("Can't use publishers with {} type".format(publishers_type)))
|
||
else:
|
||
publishers = None
|
||
elif publishers_type == C.JID:
|
||
publishers[:] = [jid.JID(publisher) for publisher in publishers]
|
||
return publishers_type, publishers
|
||
|
||
# subscribe #
|
||
|
||
def _mbSubscribeToMany(self, publishers_type, publishers, profile_key):
|
||
"""
|
||
|
||
@return (str): session id: Use pubsub.getSubscribeRTResult to get the results
|
||
"""
|
||
publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
|
||
return self.mbSubscribeToMany(publishers_type, publishers, profile_key)
|
||
|
||
def mbSubscribeToMany(self, publishers_type, publishers, profile_key):
|
||
"""Subscribe microblogs for a list of groups or jids
|
||
|
||
@param publishers_type: type of the list of publishers, one of:
|
||
C.ALL: get all jids from roster, publishers is not used
|
||
C.GROUP: get jids from groups
|
||
C.JID: use publishers directly as list of jids
|
||
@param publishers: list of publishers, according to "publishers_type" (None, list of groups or list of jids)
|
||
@param profile: %(doc_profile)s
|
||
@return (str): session id
|
||
"""
|
||
client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
|
||
return self._p.subscribeToMany(node_data, client.jid.userhostJID(), profile_key=profile_key)
|
||
|
||
# get #
|
||
|
||
def _mbGetFromManyRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
|
||
"""Get real-time results for mbGetFromMany session
|
||
|
||
@param session_id: id of the real-time deferred session
|
||
@param return (tuple): (remaining, results) where:
|
||
- remaining is the number of still expected results
|
||
- results is a list of tuple with
|
||
- service (unicode): pubsub service
|
||
- node (unicode): pubsub node
|
||
- failure (unicode): empty string in case of success, error message else
|
||
- items_data(list): data as returned by [mbGet]
|
||
- items_metadata(dict): metadata as returned by [mbGet]
|
||
@param profile_key: %(doc_profile_key)s
|
||
"""
|
||
def onSuccess(items_data):
|
||
"""convert items elements to list of microblog data in items_data"""
|
||
d = self._p.serItemsDataD(items_data, self.item2mbdata)
|
||
d.addCallback(lambda serialised:('', serialised))
|
||
return d
|
||
|
||
profile = self.host.getClient(profile_key).profile
|
||
d = self._p.getRTResults(session_id,
|
||
on_success = onSuccess,
|
||
on_error = lambda failure: (unicode(failure.value), ([],{})),
|
||
profile = profile)
|
||
d.addCallback(lambda ret: (ret[0],
|
||
[(service.full(), node, failure, items, metadata)
|
||
for (service, node), (success, (failure, (items, metadata))) in ret[1].iteritems()]))
|
||
return d
|
||
|
||
def _mbGetFromMany(self, publishers_type, publishers, max_items=10, extra_dict=None, profile_key=C.PROF_KEY_NONE):
|
||
"""
|
||
@param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
|
||
"""
|
||
max_items = None if max_items == C.NO_LIMIT else max_items
|
||
publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
|
||
extra = self._p.parseExtra(extra_dict)
|
||
return self.mbGetFromMany(publishers_type, publishers, max_items, extra.rsm_request, extra.extra, profile_key)
|
||
|
||
def mbGetFromMany(self, publishers_type, publishers, max_items=None, rsm_request=None, extra=None, profile_key=C.PROF_KEY_NONE):
|
||
"""Get the published microblogs for a list of groups or jids
|
||
|
||
@param publishers_type (str): type of the list of publishers (one of "GROUP" or "JID" or "ALL")
|
||
@param publishers (list): list of publishers, according to publishers_type (list of groups or list of jids)
|
||
@param max_items (int): optional limit on the number of retrieved items.
|
||
@param rsm_request (rsm.RSMRequest): RSM request data, common to all publishers
|
||
@param extra (dict): Extra data
|
||
@param profile_key: profile key
|
||
@return (str): RT Deferred session id
|
||
"""
|
||
# XXX: extra is unused here so far
|
||
client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
|
||
return self._p.getFromMany(node_data, max_items, rsm_request, profile_key=profile_key)
|
||
|
||
# comments #
|
||
|
||
def _mbGetFromManyWithCommentsRTResult(self, session_id, profile_key=C.PROF_KEY_DEFAULT):
|
||
"""Get real-time results for [mbGetFromManyWithComments] session
|
||
|
||
@param session_id: id of the real-time deferred session
|
||
@param return (tuple): (remaining, results) where:
|
||
- remaining is the number of still expected results
|
||
- results is a list of 5-tuple with
|
||
- service (unicode): pubsub service
|
||
- node (unicode): pubsub node
|
||
- failure (unicode): empty string in case of success, error message else
|
||
- items(list[tuple(dict, list)]): list of 2-tuple with
|
||
- item(dict): item microblog data
|
||
- comments_list(list[tuple]): list of 5-tuple with
|
||
- service (unicode): pubsub service where the comments node is
|
||
- node (unicode): comments node
|
||
- failure (unicode): empty in case of success, else error message
|
||
- comments(list[dict]): list of microblog data
|
||
- comments_metadata(dict): metadata of the comment node
|
||
- metadata(dict): original node metadata
|
||
@param profile_key: %(doc_profile_key)s
|
||
"""
|
||
profile = self.host.getClient(profile_key).profile
|
||
d = self.rt_sessions.getResults(session_id, profile=profile)
|
||
d.addCallback(lambda ret: (ret[0],
|
||
[(service.full(), node, failure, items, metadata)
|
||
for (service, node), (success, (failure, (items, metadata))) in ret[1].iteritems()]))
|
||
return d
|
||
|
||
def _mbGetFromManyWithComments(self, publishers_type, publishers, max_items=10, max_comments=C.NO_LIMIT, extra_dict=None, extra_comments_dict=None, profile_key=C.PROF_KEY_NONE):
|
||
"""
|
||
@param max_items(int): maximum number of item to get, C.NO_LIMIT for no limit
|
||
@param max_comments(int): maximum number of comments to get, C.NO_LIMIT for no limit
|
||
"""
|
||
max_items = None if max_items == C.NO_LIMIT else max_items
|
||
max_comments = None if max_comments == C.NO_LIMIT else max_comments
|
||
publishers_type, publishers = self._checkPublishers(publishers_type, publishers)
|
||
extra = self._p.parseExtra(extra_dict)
|
||
extra_comments = self._p.parseExtra(extra_comments_dict)
|
||
return self.mbGetFromManyWithComments(publishers_type, publishers, max_items, max_comments or None,
|
||
extra.rsm_request,
|
||
extra.extra,
|
||
extra_comments.rsm_request,
|
||
extra_comments.extra,
|
||
profile_key)
|
||
|
||
def mbGetFromManyWithComments(self, publishers_type, publishers, max_items=None, max_comments=None, rsm_request=None, extra=None, rsm_comments=None, extra_comments=None, profile_key=C.PROF_KEY_NONE):
|
||
"""Helper method to get the microblogs and their comments in one shot
|
||
|
||
@param publishers_type (str): type of the list of publishers (one of "GROUP" or "JID" or "ALL")
|
||
@param publishers (list): list of publishers, according to publishers_type (list of groups or list of jids)
|
||
@param max_items (int): optional limit on the number of retrieved items.
|
||
@param max_comments (int): maximum number of comments to retrieve
|
||
@param rsm_request (rsm.RSMRequest): RSM request for initial items only
|
||
@param extra (dict): extra configuration for initial items only
|
||
@param rsm_comments (rsm.RSMRequest): RSM request for comments only
|
||
@param extra_comments (dict): extra configuration for comments only
|
||
@param profile_key: profile key
|
||
@return (str): RT Deferred session id
|
||
"""
|
||
# XXX: this method seems complicated because it do a couple of treatments
|
||
# to serialise and associate the data, but it make life in frontends side
|
||
# a lot easier
|
||
|
||
client, node_data = self._getClientAndNodeData(publishers_type, publishers, profile_key)
|
||
|
||
def getComments(items_data):
|
||
"""Retrieve comments and add them to the items_data
|
||
|
||
@param items_data: serialised items data
|
||
@return (defer.Deferred): list of items where each item is associated
|
||
with a list of comments data (service, node, list of items, metadata)
|
||
"""
|
||
items, metadata = items_data
|
||
items_dlist = [] # deferred list for items
|
||
for item in items:
|
||
dlist = [] # deferred list for comments
|
||
for key, value in item.iteritems():
|
||
# we look for comments
|
||
if key.startswith('comments') and key.endswith('_service'):
|
||
prefix = key[:key.find('_')]
|
||
service_s = value
|
||
node = item["{}{}".format(prefix, "_node")]
|
||
# time to get the comments
|
||
d = self._p.getItems(client, jid.JID(service_s), node, max_comments, rsm_request=rsm_comments, extra=extra_comments)
|
||
# then serialise
|
||
d.addCallback(lambda items_data: self._p.serItemsDataD(items_data, self.item2mbdata))
|
||
# with failure handling
|
||
d.addCallback(lambda serialised_items_data: ('',) + serialised_items_data)
|
||
d.addErrback(lambda failure: (unicode(failure.value), [], {}))
|
||
# and associate with service/node (needed if there are several comments nodes)
|
||
d.addCallback(lambda serialised, service_s=service_s, node=node: (service_s, node) + serialised)
|
||
dlist.append(d)
|
||
# we get the comments
|
||
comments_d = defer.gatherResults(dlist)
|
||
# and add them to the item data
|
||
comments_d.addCallback(lambda comments_data, item=item: (item, comments_data))
|
||
items_dlist.append(comments_d)
|
||
# we gather the items + comments in a list
|
||
items_d = defer.gatherResults(items_dlist)
|
||
# and add the metadata
|
||
items_d.addCallback(lambda items_completed: (items_completed, metadata))
|
||
return items_d
|
||
|
||
deferreds = {}
|
||
for service, node in node_data:
|
||
d = deferreds[(service, node)] = self._p.getItems(client, service, node, max_items, rsm_request=rsm_request, extra=extra)
|
||
d.addCallback(lambda items_data: self._p.serItemsDataD(items_data, self.item2mbdata))
|
||
d.addCallback(getComments)
|
||
d.addCallback(lambda items_comments_data: ('', items_comments_data))
|
||
d.addErrback(lambda failure: (unicode(failure.value), ([],{})))
|
||
|
||
return self.rt_sessions.newSession(deferreds, client.profile)
|
||
|
||
|
||
class XEP_0277_handler(XMPPHandler):
|
||
implements(iwokkel.IDisco)
|
||
|
||
def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
|
||
return [disco.DiscoFeature(NS_MICROBLOG)]
|
||
|
||
def getDiscoItems(self, requestor, target, nodeIdentifier=''):
|
||
return []
|