sat_tmp: wokkel/mam.py annotate

annotate wokkel/mam.py @ 10:2cd4f0ab9ad1

add tests for sat.tmp.wokkel

author	souliane <souliane@mailoo.org>
date	Tue, 14 Jul 2015 15:22:02 +0200
parents	a07bf3fb4b54
children	81f9b53ec7e4

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

Mercurial > sat_tmp

annotate wokkel/mam.py @ 10:2cd4f0ab9ad1