libervia-backend: sat/plugins/plugin_xep

annotate sat/plugins/plugin_xep_0313.py @ 2822:5284be4c601b

plugin XEP-0045: cache presences if they are received before the room is fully joined: presences are then replayed (only the last one) once the room is fully joined.

author	Goffi <goffi@goffi.org>
date	Fri, 01 Mar 2019 12:16:57 +0100
parents	003b8b4b56a7
children	32b6893240e0

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1776 diff changeset	1 #!/usr/bin/env python2
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	3
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for Message Archive Management (XEP-0313)
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2763 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1409 diff changeset	6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	7
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	8 # This program is free software: you can redistribute it and/or modify
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	9 # it under the terms of the GNU Affero General Public License as published by
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	10 # the Free Software Foundation, either version 3 of the License, or
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	11 # (at your option) any later version.
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	12
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	13 # This program is distributed in the hope that it will be useful,
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	16 # GNU Affero General Public License for more details.
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	17
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	18 # You should have received a copy of the GNU Affero General Public License
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	20
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	21 from sat.core.constants import Const as C
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	22 from sat.core.i18n import _
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	23 from sat.core.log import getLogger
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	24 from sat.core import exceptions
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	25 from sat.tools.common import data_format
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	26 from twisted.words.protocols.jabber import jid
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	27 from twisted.internet import defer
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	28 from zope.interface import implements
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	29 from datetime import datetime
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	30 from dateutil import tz
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	31 from wokkel import disco
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	32 from wokkel import data_form
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	33 import uuid
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	34
2413 70399d1acb47 tmp: removed sat.tmp hierarchy and fixed references to it as it is now an independant sat_tmp repository Goffi <goffi@goffi.org> parents: 2145 diff changeset	35 # XXX: mam and rsm come from sat_tmp.wokkel
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	36 from wokkel import rsm
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	37 from wokkel import mam
1285 ed2c718bfe03 tmp, plugins: fixes the imports fron sat.tmp souliane <souliane@mailoo.org> parents: 1284 diff changeset	38
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	39
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	40 log = getLogger(__name__)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	41
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	42
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	43 MESSAGE_RESULT = "/message/result[@xmlns='{mam_ns}' and @queryid='{query_id}']"
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	44
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	45 PLUGIN_INFO = {
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	46 C.PI_NAME: u"Message Archive Management",
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	47 C.PI_IMPORT_NAME: u"XEP-0313",
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	48 C.PI_TYPE: u"XEP",
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	49 C.PI_PROTOCOLS: [u"XEP-0313"],
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	50 C.PI_DEPENDENCIES: [u"XEP-0059", u"XEP-0359"],
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	51 C.PI_MAIN: u"XEP_0313",
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	52 C.PI_HANDLER: u"yes",
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	53 C.PI_DESCRIPTION: _(u"""Implementation of Message Archive Management"""),
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	54 }
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	55
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	56 MAM_PREFIX = u"mam_"
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	57 FILTER_PREFIX = MAM_PREFIX + "filter_"
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	58
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	59
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	60 class XEP_0313(object):
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	61 def __init__(self, host):
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	62 log.info(_("Message Archive Management plugin initialization"))
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	63 self.host = host
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	64 self.host.registerNamespace(u"mam", mam.NS_MAM)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	65 self._rsm = host.plugins[u"XEP-0059"]
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	66 self._sid = host.plugins[u"XEP-0359"]
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	67 host.bridge.addMethod(
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	68 "MAMGet", ".plugin", in_sign='sss',
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	69 out_sign='(a(sdssa{ss}a{ss}sa{ss})a{ss}s)', method=self._getArchives,
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	70 async=True)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	71
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	72 @defer.inlineCallbacks
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	73 def profileConnected(self, client):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	74 last_mess = yield self.host.memory.historyGet(
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	75 None, None, limit=1, filters={u'not_types': C.MESS_TYPE_GROUPCHAT,
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	76 u'last_stanza_id': True},
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	77 profile=client.profile)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	78 if not last_mess:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	79 log.info(_(u"It seems that we have no MAM history yet"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	80 return
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	81 stanza_id = last_mess[0][-1][u'stanza_id']
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	82 rsm_req = rsm.RSMRequest(max_=100, after=stanza_id)
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	83 mam_req = mam.MAMRequest(rsm_=rsm_req)
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	84 complete = False
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	85 count = 0
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	86 while not complete:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	87 mam_data = yield self.getArchives(client, mam_req,
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	88 service=client.jid.userhostJID())
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	89 elt_list, rsm_response, mam_response = mam_data
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	90 complete = mam_response[u"complete"]
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	91 # we update MAM request for next iteration
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	92 mam_req.rsm.after = rsm_response.last
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	93 if not elt_list:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	94 break
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	95 else:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	96 count += len(elt_list)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	97
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	98 for mess_elt in elt_list:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	99 try:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	100 fwd_message_elt = self.getMessageFromResult(client, mess_elt, mam_req)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	101 except exceptions.DataError:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	102 continue
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	103
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	104 client.messageProt.onMessage(fwd_message_elt)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	105
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	106 if not count:
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	107 log.info(_(u"We have received no message while offline"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	108 else:
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	109 log.info(_(u"We have received {num_mess} message(s) while offline.")
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	110 .format(num_mess=count))
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	111
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 1934 diff changeset	112 def getHandler(self, client):
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	113 mam_client = client._mam = SatMAMClient()
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	114 return mam_client
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	115
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	116 def parseExtra(self, extra, with_rsm=True):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	117 """Parse extra dictionnary to retrieve MAM arguments
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	118
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	119 @param extra(dict): data for parse
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	120 @param with_rsm(bool): if True, RSM data will be parsed too
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	121 @return (data_form, None): request with parsed arguments
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	122 or None if no MAM arguments have been found
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	123 """
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	124 mam_args = {}
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	125 form_args = {}
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	126 for arg in (u"start", u"end"):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	127 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	128 value = extra.pop(MAM_PREFIX + arg)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	129 form_args[arg] = datetime.fromtimestamp(float(value), tz.tzutc())
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	130 except (TypeError, ValueError):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	131 log.warning(u"Bad value for {arg} filter ({value}), ignoring".format(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	132 arg=arg, value=value))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	133 except KeyError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	134 continue
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	135
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	136 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	137 form_args[u"with_jid"] = jid.JID(extra.pop(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	138 MAM_PREFIX + u"with"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	139 except (jid.InvalidFormat):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	140 log.warning(u"Bad value for jid filter")
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	141 except KeyError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	142 pass
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	143
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	144 for name, value in extra.iteritems():
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	145 if name.startswith(FILTER_PREFIX):
2763 c4190d5340ab XEP-0059: max value check: Goffi <goffi@goffi.org> parents: 2760 diff changeset	146 var = name[len(FILTER_PREFIX):]
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	147 extra_fields = form_args.setdefault(u"extra_fields", [])
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	148 extra_fields.append(data_form.Field(var=var, value=value))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	149
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	150 for arg in (u"node", u"query_id"):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	151 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	152 value = extra.pop(MAM_PREFIX + arg)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	153 mam_args[arg] = value
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	154 except KeyError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	155 continue
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	156
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	157 if with_rsm:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	158 rsm_request = self._rsm.parseExtra(extra)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	159 if rsm_request is not None:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	160 mam_args["rsm_"] = rsm_request
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	161
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	162 if form_args:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	163 mam_args["form"] = mam.buildForm(**form_args)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	164
2760 3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	165 # we only set orderBy if we have other MAM args
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	166 # else we would make a MAM query while it's not expected
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	167 if u"order_by" in extra and mam_args:
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	168 order_by = extra.pop(u"order_by")
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	169 assert isinstance(order_by, list)
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	170 mam_args["orderBy"] = order_by
3480d4fdf83a plugins XEP-0060, XEP-0313: implemented Order-By protoXEP: Goffi <goffi@goffi.org> parents: 2718 diff changeset	171
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	172 return mam.MAMRequest(**mam_args) if mam_args else None
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	173
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	174 def serialise(self, mam_response, data=None):
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	175 """Serialise data for MAM
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	176
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	177 Key set in data can be:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	178 - mam_complete: a bool const indicating if all items have been received
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	179 - mam_stable: a bool const which is False if items order may be changed
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	180 All values are set as strings.
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	181 @param mam_response(dict): response data to serialise
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	182 @param data(dict, None): dict to update with mam_* data.
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	183 If None, a new dict is created
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	184 @return (dict): data dict
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	185 """
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	186 if data is None:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	187 data = {}
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	188 data[u"mam_complete"] = C.boolConst(mam_response[u'complete'])
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	189 data[u"mam_stable"] = C.boolConst(mam_response[u'stable'])
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	190 return data
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	191
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	192 def getMessageFromResult(self, client, mess_elt, mam_req, service=None):
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	193 """Extract usable <message/> from MAM query result
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	194
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	195 The message will be validated, and stanza-id/delay will be added if necessary.
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	196 @param mess_elt(domish.Element): result <message/> element wrapping the message
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	197 to retrieve
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	198 @param mam_req(mam.MAMRequest): request used (needed to get query_id)
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	199 @param service(jid.JID, None): MAM service where the request has been sent
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	200 None if it's user server
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	201 @return (domish.Element): <message/> that can be used directly with onMessage
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	202 """
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	203 if mess_elt.name != u"message":
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	204 log.warning(u"unexpected stanza in archive: {xml}".format(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	205 xml=mess_elt.toXml()))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	206 raise exceptions.DataError(u"Invalid element")
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	207 service_jid = client.jid.userhostJID() if service is None else service
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	208 mess_from = mess_elt[u"from"]
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	209 # we check that the message has been sent by the right service
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	210 # if service is None (i.e. message expected from our own server)
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	211 # from can be server jid or user's bare jid
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	212 if (mess_from != service_jid.full()
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	213 and not (service is None and mess_from == client.jid.host)):
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	214 log.error(u"Message is not from our server, something went wrong: "
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	215 u"{xml}".format(xml=mess_elt.toXml()))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	216 raise exceptions.DataError(u"Invalid element")
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	217 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	218 result_elt = next(mess_elt.elements(mam.NS_MAM, u"result"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	219 forwarded_elt = next(result_elt.elements(C.NS_FORWARD, u"forwarded"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	220 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	221 delay_elt = next(forwarded_elt.elements(C.NS_DELAY, u"delay"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	222 except StopIteration:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	223 # delay_elt is not mandatory
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	224 delay_elt = None
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	225 fwd_message_elt = next(forwarded_elt.elements(C.NS_CLIENT, u"message"))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	226 except StopIteration:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	227 log.warning(u"Invalid message received from MAM: {xml}".format(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	228 xml=mess_elt.toXml()))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	229 raise exceptions.DataError(u"Invalid element")
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	230 else:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	231 if not result_elt[u"queryid"] == mam_req.query_id:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	232 log.error(u"Unexpected query id (was expecting {query_id}): {xml}"
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	233 .format(query_id=mam.query_id, xml=mess_elt.toXml()))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	234 raise exceptions.DataError(u"Invalid element")
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	235 stanza_id = self._sid.getStanzaId(fwd_message_elt,
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	236 service_jid)
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	237 if stanza_id is None:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	238 # not stanza-id element is present, we add one so message
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	239 # will be archived with it, and we won't request several times
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	240 # the same MAM achive
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	241 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	242 stanza_id = result_elt[u"id"]
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	243 except AttributeError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	244 log.warning(u'Invalid MAM result: missing "id" attribute: {xml}'
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	245 .format(xml=result_elt.toXml()))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	246 raise exceptions.DataError(u"Invalid element")
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	247 self._sid.addStanzaId(client, fwd_message_elt, stanza_id, by=service_jid)
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	248
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	249 if delay_elt is not None:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	250 fwd_message_elt.addChild(delay_elt)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	251
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	252 return fwd_message_elt
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	253
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	254 def queryFields(self, client, service=None):
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	255 """Ask the server about supported fields.
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	256
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	257 @param service: entity offering the MAM service (None for user archives)
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	258 @return (D(data_form.Form)): form with the implemented fields (cf XEP-0313 §4.1.5)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	259 """
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	260 return client._mam.queryFields(service)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	261
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	262 def queryArchive(self, client, mam_req, service=None):
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	263 """Query a user, MUC or pubsub archive.
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	264
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	265 @param mam_req(mam.MAMRequest): MAM query instance
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	266 @param service(jid.JID, None): entity offering the MAM service
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	267 None for user server
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	268 @return (D(domish.Element)): <IQ/> result
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	269 """
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	270 return client._mam.queryArchive(mam_req, service)
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	271
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	272 def _appendMessage(self, elt_list, message_cb, message_elt):
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	273 if message_cb is not None:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	274 elt_list.append(message_cb(message_elt))
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	275 else:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	276 elt_list.append(message_elt)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	277
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	278 def _queryFinished(self, iq_result, client, elt_list, event):
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	279 client.xmlstream.removeObserver(event, self._appendMessage)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	280 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	281 fin_elt = iq_result.elements(mam.NS_MAM, "fin").next()
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	282 except StopIteration:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	283 raise exceptions.DataError(u"Invalid MAM result")
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	284
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	285 mam_response = {u"complete": C.bool(fin_elt.getAttribute(u"complete", C.BOOL_FALSE)),
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	286 u"stable": C.bool(fin_elt.getAttribute(u"stable", C.BOOL_TRUE))}
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	287
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	288 try:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	289 rsm_response = rsm.RSMResponse.fromElement(fin_elt)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	290 except rsm.RSMNotFoundError:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	291 rsm_response = None
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	292
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	293 return (elt_list, rsm_response, mam_response)
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	294
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	295 def serializeArchiveResult(self, data, client, mam_req, service):
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	296 elt_list, rsm_response, mam_response = data
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	297 mess_list = []
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	298 for elt in elt_list:
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	299 fwd_message_elt = self.getMessageFromResult(client, elt, mam_req,
19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	300 service=service)
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	301 mess_data = client.messageProt.parseMessage(fwd_message_elt)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	302 mess_list.append(client.messageGetBridgeArgs(mess_data))
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	303 metadata = self._rsm.serialise(rsm_response)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	304 self.serialise(mam_response, metadata)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	305 return mess_list, metadata, client.profile
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	306
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	307 def _getArchives(self, service, extra_ser, profile_key):
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	308 """
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	309 @return: tuple with:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	310 - list of message with same data as in bridge.messageNew
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	311 - response metadata with:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	312 - rsm data (rsm_first, rsm_last, rsm_count, rsm_index)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	313 - mam data (mam_complete, mam_stable)
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	314 - profile
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	315 """
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	316 client = self.host.getClient(profile_key)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	317 service = jid.JID(service) if service else None
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	318 extra = data_format.deserialise(extra_ser, {})
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	319 mam_req = self.parseExtra(extra)
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	320
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	321 d = self.getArchives(client, mam_req, service=service)
2713 19000c506d0c plugin XEP-0313: improvments to prepare MUC MAM: Goffi <goffi@goffi.org> parents: 2701 diff changeset	322 d.addCallback(self.serializeArchiveResult, client, mam_req, service)
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	323 return d
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	324
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	325 def getArchives(self, client, query, service=None, message_cb=None):
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	326 """Query archive and gather page result
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	327
2718 bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	328 @param query(mam.MAMRequest): MAM request
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	329 @param service(jid.JID, None): MAM service to use
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	330 None to use our own server
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	331 @param message_cb(callable, None): callback to use on each message
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	332 this method can be used to unwrap messages
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	333 @return (tuple[list[domish.Element], rsm.RSMResponse, dict): result data with:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	334 - list of found elements
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	335 - RSM response
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	336 - MAM response, which is a dict with following value:
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	337 - complete: a boolean which is True if all items have been received
bb6adaa580ee plugin XEP-0313, XEP-0045: loop MAM requests until whole archive is retrieved: Goffi <goffi@goffi.org> parents: 2713 diff changeset	338 - stable: a boolean which is False if items order may be changed
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	339 """
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	340 if query.query_id is None:
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	341 query.query_id = unicode(uuid.uuid4())
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	342 elt_list = []
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	343 event = MESSAGE_RESULT.format(mam_ns=mam.NS_MAM, query_id=query.query_id)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	344 client.xmlstream.addObserver(event, self._appendMessage, 0, elt_list, message_cb)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	345 d = self.queryArchive(client, query, service)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	346 d.addCallback(self._queryFinished, client, elt_list, event)
4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	347 return d
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	348
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	349 def getPrefs(self, client, service=None):
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	350 """Retrieve the current user preferences.
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	351
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	352 @param service: entity offering the MAM service (None for user archives)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	353 @return: the server response as a Deferred domish.Element
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	354 """
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	355 # http://xmpp.org/extensions/xep-0313.html#prefs
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	356 return client._mam.queryPrefs(service)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	357
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	358 def _setPrefs(self, service_s=None, default="roster", always=None, never=None,
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2624 diff changeset	359 profile_key=C.PROF_KEY_NONE):
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	360 service = jid.JID(service_s) if service_s else None
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	361 always_jid = [jid.JID(entity) for entity in always]
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	362 never_jid = [jid.JID(entity) for entity in never]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	363 # TODO: why not build here a MAMPrefs object instead of passing the args separately?
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	364 return self.setPrefs(service, default, always_jid, never_jid, profile_key)
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	365
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	366 def setPrefs(self, client, service=None, default="roster", always=None, never=None):
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	367 """Set news user preferences.
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	368
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	369 @param service: entity offering the MAM service (None for user archives)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	370 @param default (unicode): a value in ('always', 'never', 'roster')
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	371 @param always (list): a list of JID instances
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	372 @param never (list): a list of JID instances
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	373 @param profile_key (unicode): %(doc_profile_key)s
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	374 @return: the server response as a Deferred domish.Element
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	375 """
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	376 # http://xmpp.org/extensions/xep-0313.html#prefs
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	377 return client._mam.setPrefs(service, default, always, never)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	378
3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	379
1284 41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	380 class SatMAMClient(mam.MAMClient):
41ffe2c2dddc plugin XEP-0313: update (still draft) souliane <souliane@mailoo.org> parents: 1277 diff changeset	381 implements(disco.IDisco)
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	382
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	383 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
1776 4fc1bf1af48f plugin XEP-0313: cleaning and improvments: Goffi <goffi@goffi.org> parents: 1766 diff changeset	384 return [disco.DiscoFeature(mam.NS_MAM)]
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	385
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	386 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
1277 3a3e3014f9f8 plugin XEP-0313: first draft: souliane <souliane@mailoo.org> parents: diff changeset	387 return []

Mercurial > libervia-backend

annotate sat/plugins/plugin_xep_0313.py @ 2822:5284be4c601b