1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
|
# -*- coding: utf-8 -*-
# -*- test-case-name: wokkel.test.test_mam -*-
#
# SàT Wokkel extension for Message Archive Management (XEP-0313)
# Copyright (C) 2015-2019 Jérôme Poisson (goffi@goffi.org)
# Copyright (C) 2015 Adien Cossa (souliane@mailoo.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/>.
"""
XMPP Message Archive Management protocol.
This protocol is specified in
U{XEP-0313<http://xmpp.org/extensions/xep-0313.html>}.
"""
from dateutil import tz
from zope.interface import implements
from zope.interface import Interface
from twisted.words.protocols.jabber import xmlstream
from twisted.words.xish import domish
from twisted.words.protocols.jabber import jid
from twisted.words.protocols.jabber import error
from twisted.internet import defer
from twisted.python import log
from wokkel import subprotocols
from wokkel import disco
from wokkel import data_form
from wokkel import delay
import rsm
NS_MAM = 'urn:xmpp:mam:2'
NS_FORWARD = 'urn:xmpp:forward:0'
NS_ORDER_BY = u"urn:xmpp:order-by:0"
FIELDS_REQUEST = "/iq[@type='get']/query[@xmlns='%s']" % NS_MAM
ARCHIVE_REQUEST = "/iq[@type='set']/query[@xmlns='%s']" % NS_MAM
PREFS_GET_REQUEST = "/iq[@type='get']/prefs[@xmlns='%s']" % NS_MAM
PREFS_SET_REQUEST = "/iq[@type='set']/prefs[@xmlns='%s']" % NS_MAM
# TODO: add the tests!
class MAMError(error.StanzaError):
"""
MAM error.
"""
def __init__(self, text=None):
error.StanzaError.__init__(self, 'bad-request', text=text)
class Unsupported(MAMError):
def __init__(self, feature, text=None):
self.feature = feature
MAMError.__init__(self, 'feature-not-implemented',
'unsupported',
feature,
text)
def __str__(self):
message = MAMError.__str__(self)
message += ', feature %r' % self.feature
return message
class MAMRequest(object):
"""
A Message Archive Management <query/> request.
@ivar form: Data Form specifing the filters.
@itype form: L{data_form.Form}
@ivar rsm: RSM request instance.
@itype rsm: L{rsm.RSMRequest}
@ivar node: pubsub node id if querying a pubsub node, else None.
@itype node: C{unicode}
@ivar query_id: id to use to track the query
@itype query_id: C{unicode}
@param orderBy: Keys to order by
@type orderBy: L{list} of L{unicode}
"""
# FIXME: should be based on generic.Stanza
def __init__(self, form=None, rsm_=None, node=None, query_id=None, sender=None,
recipient=None, orderBy=None):
if form is not None:
assert form.formType == 'submit'
assert form.formNamespace == NS_MAM
self.form = form
self.rsm = rsm_
self.node = node
self.query_id = query_id
self.sender = sender
self.recipient = recipient
self.orderBy = orderBy
@classmethod
def fromElement(cls, iq):
"""Parse the DOM representation of a MAM <query/> request.
@param iq: <iq/> element containing a MAM <query/>.
@type iq: L{Element<twisted.words.xish.domish.Element>}
@return: MAMRequest instance.
@rtype: L{MAMRequest}
"""
sender = jid.JID(iq.getAttribute('from'))
recipient = jid.JID(iq.getAttribute('to'))
try:
query = iq.elements(NS_MAM, 'query').next()
except StopIteration:
raise MAMError("Can't find MAM <query/> in element")
form = data_form.findForm(query, NS_MAM)
try:
rsm_request = rsm.RSMRequest.fromElement(query)
except rsm.RSMNotFoundError:
rsm_request = None
node = query.getAttribute('node')
query_id = query.getAttribute('queryid')
orderBy = []
for element in query.elements(NS_ORDER_BY, 'order'):
orderBy.append(element['by'])
return MAMRequest(form, rsm_request, node, query_id, sender, recipient, orderBy)
def toElement(self):
"""
Return the DOM representation of this RSM <query/> request.
@rtype: L{Element<twisted.words.xish.domish.Element>}
"""
mam_elt = domish.Element((NS_MAM, 'query'))
if self.node is not None:
mam_elt['node'] = self.node
if self.query_id is not None:
mam_elt['queryid'] = self.query_id
if self.form is not None:
mam_elt.addChild(self.form.toElement())
if self.rsm is not None:
mam_elt.addChild(self.rsm.toElement())
if self.orderBy is not None:
for by_attr in self.orderBy:
order_elt = mam_elt.addElement((NS_ORDER_BY,'order'))
order_elt['by'] = by_attr
return mam_elt
def render(self, parent):
"""Embed the DOM representation of this MAM request in the given element.
@param parent: parent IQ element.
@type parent: L{Element<twisted.words.xish.domish.Element>}
@return: MAM request element.
@rtype: L{Element<twisted.words.xish.domish.Element>}
"""
assert parent.name == 'iq'
mam_elt = self.toElement()
parent.addChild(mam_elt)
return mam_elt
class MAMPrefs(object):
"""
A Message Archive Management <prefs/> request.
@param default: A value in ('always', 'never', 'roster').
@type : C{unicode} or C{None}
@param always (list): A list of JID instances.
@type always: C{list}
@param never (list): A list of JID instances.
@type never: C{list}
"""
def __init__(self, default=None, always=None, never=None):
if default is not None:
# default must be defined in response, but can be empty in request (see http://xmpp.org/extensions/xep-0313.html#config)
assert default in ('always', 'never', 'roster')
self.default = default
if always is not None:
assert isinstance(always, list)
else:
always = []
self.always = always
if never is not None:
assert isinstance(never, list)
else:
never = []
self.never = never
@classmethod
def fromElement(cls, prefs_elt):
"""Parse the DOM representation of a MAM <prefs/> request.
@param prefs_elt: MAM <prefs/> request element.
@type prefs_elt: L{Element<twisted.words.xish.domish.Element>}
@return: MAMPrefs instance.
@rtype: L{MAMPrefs}
"""
if prefs_elt.uri != NS_MAM or prefs_elt.name != 'prefs':
raise MAMError('Element provided is not a MAM <prefs/> request')
try:
default = prefs_elt['default']
except KeyError:
# FIXME: return proper error here
raise MAMError('Element provided is not a valid MAM <prefs/> request')
prefs = {}
for attr in ('always', 'never'):
prefs[attr] = []
try:
pref = prefs_elt.elements(NS_MAM, attr).next()
except StopIteration:
# FIXME: return proper error here
raise MAMError('Element provided is not a valid MAM <prefs/> request')
else:
for jid_s in pref.elements(NS_MAM, 'jid'):
prefs[attr].append(jid.JID(jid_s))
return MAMPrefs(default, **prefs)
def toElement(self):
"""
Return the DOM representation of this RSM <prefs/>request.
@rtype: L{Element<twisted.words.xish.domish.Element>}
"""
mam_elt = domish.Element((NS_MAM, 'prefs'))
if self.default:
mam_elt['default'] = self.default
for attr in ('always', 'never'):
attr_elt = mam_elt.addElement(attr)
jids = getattr(self, attr)
for jid_ in jids:
attr_elt.addElement('jid', content=jid_.full())
return mam_elt
def render(self, parent):
"""Embed the DOM representation of this MAM request in the given element.
@param parent: parent IQ element.
@type parent: L{Element<twisted.words.xish.domish.Element>}
@return: MAM request element.
@rtype: L{Element<twisted.words.xish.domish.Element>}
"""
assert parent.name == 'iq'
mam_elt = self.toElement()
parent.addChild(mam_elt)
return mam_elt
class MAMClient(subprotocols.XMPPHandler):
"""
MAM client.
This handler implements the protocol for sending out MAM requests.
"""
def queryArchive(self, mam_query, service=None, sender=None):
"""Query a user, MUC or pubsub archive.
@param mam_query: query to use
@type form: L{MAMRequest}
@param service: Entity offering the MAM service (None for user server).
@type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param sender: Optional sender address.
@type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: A deferred that fires upon receiving a response.
@rtype: L{Deferred<twisted.internet.defer.Deferred>}
"""
iq = xmlstream.IQ(self.xmlstream, 'set')
mam_query.render(iq)
if sender is not None:
iq['from'] = unicode(sender)
return iq.send(to=service.full() if service else None)
def queryFields(self, service=None, sender=None):
"""Ask the server about supported fields.
@param service: Entity offering the MAM service (None for user archives).
@type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param sender: Optional sender address.
@type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: data Form with the fields, or None if not found
@rtype: L{Deferred<twisted.internet.defer.Deferred>}
"""
# http://xmpp.org/extensions/xep-0313.html#query-form
iq = xmlstream.IQ(self.xmlstream, 'get')
MAMRequest().render(iq)
if sender is not None:
iq['from'] = unicode(sender)
d = iq.send(to=service.full() if service else None)
d.addCallback(lambda iq_result: iq_result.elements(NS_MAM, 'query').next())
d.addCallback(data_form.findForm, NS_MAM)
return d
def queryPrefs(self, service=None, sender=None):
"""Retrieve the current user preferences.
@param service: Entity offering the MAM service (None for user archives).
@type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param sender: Optional sender address.
@type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: A deferred that fires upon receiving a response.
@rtype: L{Deferred<twisted.internet.defer.Deferred>}
"""
# http://xmpp.org/extensions/xep-0313.html#prefs
iq = xmlstream.IQ(self.xmlstream, 'get')
MAMPrefs().render(iq)
if sender is not None:
iq['from'] = unicode(sender)
return iq.send(to=service.full() if service else None)
def setPrefs(self, service=None, default='roster', always=None, never=None, sender=None):
"""Set new user preferences.
@param service: Entity offering the MAM service (None for user archives).
@type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param default: A value in ('always', 'never', 'roster').
@type : C{unicode}
@param always (list): A list of JID instances.
@type always: C{list}
@param never (list): A list of JID instances.
@type never: C{list}
@param sender: Optional sender address.
@type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: A deferred that fires upon receiving a response.
@rtype: L{Deferred<twisted.internet.defer.Deferred>}
"""
# http://xmpp.org/extensions/xep-0313.html#prefs
assert default is not None
iq = xmlstream.IQ(self.xmlstream, 'set')
MAMPrefs(default, always, never).render(iq)
if sender is not None:
iq['from'] = unicode(sender)
return iq.send(to=service.full() if service else None)
class IMAMResource(Interface):
def onArchiveRequest(self, mam):
"""
@param mam: The MAM <query/> request.
@type mam: L{MAMRequest<wokkel.mam.MAMRequest>}
@return: The RSM answer.
@rtype: L{RSMResponse<wokkel.rsm.RSMResponse>}
"""
def onPrefsGetRequest(self, requestor):
"""
@param requestor: JID of the requestor.
@type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: The current settings.
@rtype: L{wokkel.mam.MAMPrefs}
"""
def onPrefsSetRequest(self, prefs, requestor):
"""
@param prefs: The new settings to set.
@type prefs: L{wokkel.mam.MAMPrefs}
@param requestor: JID of the requestor.
@type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
@return: The new current settings.
@rtype: L{wokkel.mam.MAMPrefs}
"""
class IMAMService(Interface):
"""
Interface for XMPP MAM service.
"""
def addFilter(self, field):
"""
Add a new filter for querying MAM archive.
@param field: data form field of the filter
@type field: L{Form<wokkel.data_form.Field>}
"""
class MAMService(subprotocols.XMPPHandler, subprotocols.IQHandlerMixin):
"""
Protocol implementation for a MAM service.
This handler waits for XMPP Ping requests and sends a response.
"""
implements(IMAMService, disco.IDisco)
_request_class = MAMRequest
iqHandlers = {FIELDS_REQUEST: '_onFieldsRequest',
ARCHIVE_REQUEST: '_onArchiveRequest',
PREFS_GET_REQUEST: '_onPrefsGetRequest',
PREFS_SET_REQUEST: '_onPrefsSetRequest'
}
_mainFilters = {'start': {'fieldType': 'text-single',
'var': 'start',
'label': 'Starting time',
'desc': 'Starting time a the result period.',
},
'end': {'fieldType': 'text-single',
'var': 'end',
'label': 'Ending time',
'desc': 'Ending time of the result period.',
},
'with': {'fieldType': 'jid-single',
'var': 'with',
'label': 'Entity',
'desc': 'Entity against which to match message.',
},
}
def __init__(self, resource):
"""
@param resource: instance implementing IMAMResource
@type resource: L{object}
"""
self.resource = resource
self.extra_fields = {}
def connectionInitialized(self):
"""
Called when the XML stream has been initialized.
This sets up an observer for incoming ping requests.
"""
self.xmlstream.addObserver(FIELDS_REQUEST, self.handleRequest)
self.xmlstream.addObserver(ARCHIVE_REQUEST, self.handleRequest)
self.xmlstream.addObserver(PREFS_GET_REQUEST, self.handleRequest)
self.xmlstream.addObserver(PREFS_SET_REQUEST, self.handleRequest)
def addFilter(self, field):
"""
Add a new filter for querying MAM archive.
@param field: data form field of the filter
@type field: L{Form<wokkel.data_form.Field>}
"""
self.extra_fields[field.var] = field
def _onFieldsRequest(self, iq):
"""
Called when a fields request has been received.
This immediately replies with a result response.
"""
iq.handled = True
query = domish.Element((NS_MAM, 'query'))
query.addChild(buildForm(extra_fields=self.extra_fields).toElement(), formType='form')
return query
def _onArchiveRequest(self, iq):
"""
Called when a message archive request has been received.
This will send the list of archived message and return MAM <fin> element
@return: The MAM <fin> element
@rtype: L{Element<twisted.words.xish.domish.Element>}
"""
iq.handled = True
mam_ = self._request_class.fromElement(iq)
# remove unsupported filters
unsupported_fields = []
if mam_.form:
for key, field in mam_.form.fields.iteritems():
if key not in self._mainFilters and key not in self.extra_fields:
log.msg('Ignored unsupported MAM filter: %s' % field)
unsupported_fields.append(key)
for key in unsupported_fields:
del mam_.form.fields[key]
def forwardMessage(id_, elt, date):
msg = domish.Element((None, 'message'))
msg['to'] = iq['from']
result = msg.addElement((NS_MAM, 'result'))
if mam_.query_id is not None:
result['queryid'] = mam_.query_id
result['id'] = id_
forward = result.addElement((NS_FORWARD, 'forwarded'))
forward.addChild(delay.Delay(date).toElement())
forward.addChild(elt)
self.xmlstream.send(msg)
def cb(result):
msg_data, rsm_elt, attributes = result
for data in msg_data:
forwardMessage(*data)
fin_elt = domish.Element((NS_MAM, 'fin'))
for key, value in attributes.items():
fin_elt[key] = value
if rsm_elt is not None:
fin_elt.addChild(rsm_elt)
return fin_elt
d = defer.maybeDeferred(self.resource.onArchiveRequest, mam_)
d.addCallback(cb)
return d
def _onPrefsGetRequest(self, iq):
"""
Called when a prefs get request has been received.
This immediately replies with a result response.
"""
iq.handled = True
requestor = jid.JID(iq['from'])
def cb(prefs):
return prefs.toElement()
d = self.resource.onPrefsGetRequest(requestor).addCallback(cb)
return d
def _onPrefsSetRequest(self, iq):
"""
Called when a prefs get request has been received.
This immediately replies with a result response.
"""
iq.handled = True
prefs = MAMPrefs.fromElement(iq.prefs)
requestor = jid.JID(iq['from'])
def cb(prefs):
return prefs.toElement()
d = self.resource.onPrefsSetRequest(prefs, requestor).addCallback(cb)
return d
def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
if nodeIdentifier:
return []
return [disco.DiscoFeature(NS_MAM)]
def getDiscoItems(self, requestor, target, nodeIdentifier=''):
return []
def datetime2utc(datetime_obj):
"""Convert a datetime to a XEP-0082 compliant UTC datetime.
@param datetime_obj: Offset-aware timestamp to convert.
@type datetime_obj: L{datetime<datetime.datetime>}
@return: The datetime converted to UTC.
@rtype: C{unicode}
"""
stampFormat = '%Y-%m-%dT%H:%M:%SZ'
return datetime_obj.astimezone(tz.tzutc()).strftime(stampFormat)
def buildForm(start=None, end=None, with_jid=None, extra_fields=None, formType='submit'):
"""Prepare a Data Form for MAM.
@param start: Offset-aware timestamp to filter out older messages.
@type start: L{datetime<datetime.datetime>}
@param end: Offset-aware timestamp to filter out later messages.
@type end: L{datetime<datetime.datetime>}
@param with_jid: JID against which to match messages.
@type with_jid: L{JID<twisted.words.protocols.jabber.jid.JID>}
@param extra_fields: list of extra data form fields that are not defined by the
specification.
@type: C{list}
@param formType: The type of the Data Form ('submit' or 'form').
@type formType: C{unicode}
@return: XEP-0004 Data Form object.
@rtype: L{Form<wokkel.data_form.Form>}
"""
form = data_form.Form(formType, formNamespace=NS_MAM)
if formType == 'form':
for kwargs in MAMService._mainFilters.values():
form.addField(data_form.Field(**kwargs))
elif formType == 'submit':
if start:
form.addField(data_form.Field(var='start', value=datetime2utc(start)))
if end:
form.addField(data_form.Field(var='end', value=datetime2utc(end)))
if with_jid:
form.addField(data_form.Field(fieldType='jid-single', var='with', value=with_jid.full()))
if extra_fields is not None:
for field in extra_fields:
form.addField(field)
return form
|