Mercurial > libervia-backend
annotate sat/plugins/plugin_misc_email_invitation.py @ 3024:c2e7bb251e3e
install: added doc to MANIFEST.in
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 24 Jul 2019 19:54:29 +0200 |
| parents | 420897488080 |
| children | ab2696e34d29 |
| rev | line source |
|---|---|
| 2184 | 1 #!/usr/bin/env python2 |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT plugin for file tansfer | |
| 2771 | 5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org) |
| 2184 | 6 |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
20 import shortuuid |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
21 from twisted.internet import defer |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
22 from twisted.words.protocols.jabber import jid |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
23 from twisted.words.protocols.jabber import error |
| 2184 | 24 from sat.core.i18n import _, D_ |
| 25 from sat.core.constants import Const as C | |
| 26 from sat.core import exceptions | |
| 27 from sat.core.log import getLogger | |
| 28 from sat.tools import utils | |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
29 from sat.tools.common import data_format |
| 2184 | 30 from sat.memory import persistent |
|
3007
420897488080
plugins account, email invitation: fixed import of "email" module after it has been moved
Goffi <goffi@goffi.org>
parents:
2912
diff
changeset
|
31 from sat.tools.common import email as sat_email |
| 2184 | 32 |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
33 log = getLogger(__name__) |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
34 |
| 2184 | 35 |
| 36 PLUGIN_INFO = { | |
| 37 C.PI_NAME: "Invitations", | |
|
2912
a3faf1c86596
plugin events: refactored invitation and personal lists logic:
Goffi <goffi@goffi.org>
parents:
2909
diff
changeset
|
38 C.PI_IMPORT_NAME: "EMAIL_INVITATION", |
| 2184 | 39 C.PI_TYPE: C.PLUG_TYPE_MISC, |
| 40 C.PI_DEPENDENCIES: ['XEP-0077'], | |
|
2256
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
41 C.PI_RECOMMENDATIONS: ["IDENTITY"], |
| 2184 | 42 C.PI_MAIN: "InvitationsPlugin", |
| 43 C.PI_HANDLER: "no", | |
| 44 C.PI_DESCRIPTION: _(u"""invitation of people without XMPP account""") | |
| 45 } | |
| 46 | |
| 47 | |
| 48 SUFFIX_MAX = 5 | |
| 49 INVITEE_PROFILE_TPL = u"guest@@{uuid}" | |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
50 KEY_ID = u'id' |
|
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
51 KEY_JID = u'jid' |
| 2184 | 52 KEY_CREATED = u'created' |
| 53 KEY_LAST_CONNECTION = u'last_connection' | |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
54 KEY_GUEST_PROFILE = u'guest_profile' |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
55 KEY_PASSWORD = u'password' |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
56 KEY_EMAILS_EXTRA = u'emails_extra' |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
57 EXTRA_RESERVED = {KEY_ID, KEY_JID, KEY_CREATED, u'jid_', u'jid', KEY_LAST_CONNECTION, |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
58 KEY_GUEST_PROFILE, KEY_PASSWORD, KEY_EMAILS_EXTRA} |
| 2184 | 59 DEFAULT_SUBJECT = D_(u"You have been invited by {host_name} to {app_name}") |
| 60 DEFAULT_BODY = D_(u"""Hello {name}! | |
| 61 | |
| 62 You have received an invitation from {host_name} to participate to "{app_name}". | |
| 63 To join, you just have to click on the following URL: | |
| 64 {url} | |
| 65 | |
| 66 Please note that this URL should not be shared with anybody! | |
| 67 If you want more details on {app_name}, you can check {app_url}. | |
| 68 | |
| 69 Welcome! | |
| 70 """) | |
| 71 | |
| 72 | |
| 73 class InvitationsPlugin(object): | |
| 74 | |
| 75 def __init__(self, host): | |
| 76 log.info(_(u"plugin Invitations initialization")) | |
| 77 self.host = host | |
| 78 self.invitations = persistent.LazyPersistentBinaryDict(u'invitations') | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
79 host.bridge.addMethod("invitationCreate", ".plugin", in_sign='sasssssssssa{ss}s', |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
80 out_sign='a{ss}', |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
81 method=self._create, |
| 2184 | 82 async=True) |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
83 host.bridge.addMethod("invitationGet", ".plugin", in_sign='s', out_sign='a{ss}', |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
84 method=self.get, |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
85 async=True) |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
86 host.bridge.addMethod("invitationModify", ".plugin", in_sign='sa{ss}b', |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
87 out_sign='', |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
88 method=self._modify, |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
89 async=True) |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
90 host.bridge.addMethod("invitationList", ".plugin", in_sign='s', |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
91 out_sign='a{sa{ss}}', |
|
2230
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
92 method=self._list, |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
93 async=True) |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
94 |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
95 def checkExtra(self, extra): |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
96 if EXTRA_RESERVED.intersection(extra): |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
97 raise ValueError( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
98 _(u"You can't use following key(s) in extra, they are reserved: {}") |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
99 .format(u', '.join(EXTRA_RESERVED.intersection(extra)))) |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
100 |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
101 def _create(self, email=u'', emails_extra=None, jid_=u'', password=u'', name=u'', |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
102 host_name=u'', language=u'', url_template=u'', message_subject=u'', |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
103 message_body=u'', extra=None, profile=u''): |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
104 # XXX: we don't use **kwargs here to keep arguments name for introspection with |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
105 # D-Bus bridge |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
106 if emails_extra is None: |
|
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
107 emails_extra = [] |
| 2184 | 108 |
| 109 if extra is None: | |
| 110 extra = {} | |
| 111 else: | |
| 112 extra = {unicode(k): unicode(v) for k,v in extra.iteritems()} | |
| 113 | |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
114 kwargs = {"extra": extra, |
|
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
115 KEY_EMAILS_EXTRA: [unicode(e) for e in emails_extra] |
|
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
116 } |
|
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
117 |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
118 # we need to be sure that values are unicode, else they won't be pickled correctly |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
119 # with D-Bus |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
120 for key in ("jid_", "password", "name", "host_name", "email", "language", |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
121 "url_template", "message_subject", "message_body", "profile"): |
| 2184 | 122 value = locals()[key] |
| 123 if value: | |
| 124 kwargs[key] = unicode(value) | |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
125 d = self.create(**kwargs) |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
126 def serialize(data): |
|
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
127 data[KEY_JID] = data[KEY_JID].full() |
|
2230
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
128 return data |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
129 d.addCallback(serialize) |
|
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
130 return d |
| 2184 | 131 |
| 132 @defer.inlineCallbacks | |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
133 def create(self, **kwargs): |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
134 ur"""Create an invitation |
| 2184 | 135 |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
136 This will create an XMPP account and a profile, and use a UUID to retrieve them. |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
137 The profile is automatically generated in the form guest@@[UUID], this way they |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
138 can be retrieved easily |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
139 **kwargs: keywords arguments which can have the following keys, unset values are |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
140 equivalent to None: |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
141 jid_(jid.JID, None): jid to use for invitation, the jid will be created using |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
142 XEP-0077 |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
143 if the jid has no user part, an anonymous account will be used (no XMPP |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
144 account created in this case) |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
145 if None, automatically generate an account name (in the form |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
146 "invitation-[random UUID]@domain.tld") (note that this UUID is not the |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
147 same as the invitation one, as jid can be used publicly (leaking the |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
148 UUID), and invitation UUID give access to account. |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
149 in case of conflict, a suffix number is added to the account until a free |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
150 one if found (with a failure if SUFFIX_MAX is reached) |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
151 password(unicode, None): password to use (will be used for XMPP account and |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
152 profile) |
| 2184 | 153 None to automatically generate one |
| 154 name(unicode, None): name of the invitee | |
|
2256
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
155 will be set as profile identity if present |
| 2184 | 156 host_name(unicode, None): name of the host |
| 157 email(unicode, None): email to send the invitation to | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
158 if None, no invitation email is sent, you can still associate email using |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
159 extra |
| 2184 | 160 if email is used, extra can't have "email" key |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
161 language(unicode): language of the invitee (used notabily to translate the |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
162 invitation) |
| 2184 | 163 TODO: not used yet |
| 164 url_template(unicode, None): template to use to construct the invitation URL | |
| 165 use {uuid} as a placeholder for identifier | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
166 use None if you don't want to include URL (or if it is already specified |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
167 in custom message) |
| 2184 | 168 /!\ you must put full URL, don't forget https:// |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
169 /!\ the URL will give access to the invitee account, you should warn in |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
170 message to not publish it publicly |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
171 message_subject(unicode, None): customised message body for the invitation |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
172 email |
| 2184 | 173 None to use default subject |
| 174 uses the same substitution as for message_body | |
| 175 message_body(unicode, None): customised message body for the invitation email | |
| 176 None to use default body | |
| 177 use {name} as a place holder for invitee name | |
| 178 use {url} as a placeholder for the invitation url | |
| 179 use {uuid} as a placeholder for the identifier | |
| 180 use {app_name} as a placeholder for this software name | |
| 181 use {app_url} as a placeholder for this software official website | |
| 182 use {profile} as a placeholder for host's profile | |
| 183 use {host_name} as a placeholder for host's name | |
| 184 extra(dict, None): extra data to associate with the invitee | |
| 185 some keys are reserved: | |
| 186 - created (creation date) | |
| 187 if email argument is used, "email" key can't be used | |
| 188 profile(unicode, None): profile of the host (person who is inviting) | |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
189 @return (dict[unicode, unicode]): dictionary with: |
|
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
190 - UUID associated with the invitee (key: id) |
| 2184 | 191 - filled extra dictionary, as saved in the databae |
| 192 """ | |
| 193 ## initial checks | |
| 194 extra = kwargs.pop('extra', {}) | |
| 195 if set(kwargs).intersection(extra): | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
196 raise ValueError( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
197 _(u"You can't use following key(s) in both args and extra: {}").format( |
| 2184 | 198 u', '.join(set(kwargs).intersection(extra)))) |
| 199 | |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
200 self.checkExtra(extra) |
| 2184 | 201 |
|
2255
ba613d32ca60
plugin invitations: doesn't raise an exception anymore if url_template is not set while email is not requested
Goffi <goffi@goffi.org>
parents:
2241
diff
changeset
|
202 email = kwargs.pop(u'email', None) |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
203 emails_extra = kwargs.pop(u'emails_extra', []) |
|
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
204 if not email and emails_extra: |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
205 raise ValueError( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
206 _(u'You need to provide a main email address before using emails_extra')) |
|
2255
ba613d32ca60
plugin invitations: doesn't raise an exception anymore if url_template is not set while email is not requested
Goffi <goffi@goffi.org>
parents:
2241
diff
changeset
|
207 |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
208 if (email is not None |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
209 and not 'url_template' in kwargs |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
210 and not 'message_body' in kwargs): |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
211 raise ValueError( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
212 _(u"You need to provide url_template if you use default message body")) |
|
2210
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
213 |
| 2184 | 214 ## uuid |
| 215 log.info(_(u"creating an invitation")) | |
| 216 id_ = unicode(shortuuid.uuid()) | |
| 217 | |
| 218 ## XMPP account creation | |
| 219 password = kwargs.pop(u'password', None) | |
| 220 if password is None: | |
| 221 password = utils.generatePassword() | |
| 222 assert password | |
| 223 # XXX: password is here saved in clear in database | |
| 224 # it is needed for invitation as the same password is used for profile | |
| 225 # and SàT need to be able to automatically open the profile with the uuid | |
| 226 # FIXME: we could add an extra encryption key which would be used with the uuid | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
227 # when the invitee is connecting (e.g. with URL). This key would not be |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
228 # saved and could be used to encrypt profile password. |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
229 extra[KEY_PASSWORD] = password |
| 2184 | 230 |
| 231 jid_ = kwargs.pop(u'jid_', None) | |
| 232 if not jid_: | |
| 233 domain = self.host.memory.getConfig(None, 'xmpp_domain') | |
| 234 if not domain: | |
| 235 # TODO: fallback to profile's domain | |
| 236 raise ValueError(_(u"You need to specify xmpp_domain in sat.conf")) | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
237 jid_ = u"invitation-{uuid}@{domain}".format(uuid=shortuuid.uuid(), |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
238 domain=domain) |
| 2184 | 239 jid_ = jid.JID(jid_) |
| 240 if jid_.user: | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
241 # we don't register account if there is no user as anonymous login is then |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
242 # used |
| 2184 | 243 try: |
| 244 yield self.host.plugins['XEP-0077'].registerNewAccount(jid_, password) | |
| 245 except error.StanzaError as e: | |
| 246 prefix = jid_.user | |
| 247 idx = 0 | |
| 248 while e.condition == u'conflict': | |
| 249 if idx >= SUFFIX_MAX: | |
| 250 raise exceptions.ConflictError(_(u"Can't create XMPP account")) | |
| 251 jid_.user = prefix + '_' + unicode(idx) | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
252 log.info(_(u"requested jid already exists, trying with {}".format( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
253 jid_.full()))) |
| 2184 | 254 try: |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
255 yield self.host.plugins['XEP-0077'].registerNewAccount(jid_, |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
256 password) |
| 2184 | 257 except error.StanzaError as e: |
| 258 idx += 1 | |
| 259 else: | |
| 260 break | |
| 261 if e.condition != u'conflict': | |
| 262 raise e | |
| 263 | |
| 264 log.info(_(u"account {jid_} created").format(jid_=jid_.full())) | |
| 265 | |
| 266 ## profile creation | |
|
2256
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
267 |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
268 extra[KEY_GUEST_PROFILE] = guest_profile = INVITEE_PROFILE_TPL.format(uuid=id_) |
| 2184 | 269 # profile creation should not fail as we generate unique name ourselves |
| 270 yield self.host.memory.createProfile(guest_profile, password) | |
| 271 yield self.host.memory.startSession(password, guest_profile) | |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
272 yield self.host.memory.setParam("JabberID", jid_.full(), "Connection", |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
273 profile_key=guest_profile) |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
274 yield self.host.memory.setParam("Password", password, "Connection", |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
275 profile_key=guest_profile) |
|
2256
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
276 name = kwargs.pop(u'name', None) |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
277 if name is not None: |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
278 extra[u'name'] = name |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
279 try: |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
280 id_plugin = self.host.plugins[u'IDENTITY'] |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
281 except KeyError: |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
282 pass |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
283 else: |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
284 yield self.host.connect(guest_profile, password) |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
285 guest_client = self.host.getClient(guest_profile) |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
286 yield id_plugin.setIdentity(guest_client, {u'nick': name}) |
|
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
287 yield self.host.disconnect(guest_profile) |
| 2184 | 288 |
| 289 ## email | |
| 290 language = kwargs.pop(u'language', None) | |
| 291 if language is not None: | |
|
2322
310a454c8657
plugins invitation, XEP-0277: strip language, we don't want spaces
Goffi <goffi@goffi.org>
parents:
2291
diff
changeset
|
292 extra[u'language'] = language.strip() |
| 2184 | 293 |
| 294 if email is not None: | |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
295 extra[u'email'] = email |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
296 data_format.iter2dict(KEY_EMAILS_EXTRA, extra) |
| 2184 | 297 url_template = kwargs.pop(u'url_template', '') |
| 298 format_args = { | |
| 299 u'uuid': id_, | |
| 300 u'app_name': C.APP_NAME, | |
| 301 u'app_url': C.APP_URL} | |
| 302 | |
| 303 if name is None: | |
| 304 format_args[u'name'] = email | |
| 305 else: | |
|
2256
61e836cc9512
plugin invitations: name is now registered as nickname on XMPP server thanks to plugin identity
Goffi <goffi@goffi.org>
parents:
2255
diff
changeset
|
306 format_args[u'name'] = name |
| 2184 | 307 |
| 308 profile = kwargs.pop(u'profile', None) | |
| 309 if profile is None: | |
| 310 format_args[u'profile'] = u'' | |
| 311 else: | |
| 312 format_args[u'profile'] = extra[u'profile'] = profile | |
| 313 | |
| 314 host_name = kwargs.pop(u'host_name', None) | |
| 315 if host_name is None: | |
| 316 format_args[u'host_name'] = profile or _(u"somebody") | |
| 317 else: | |
| 318 format_args[u'host_name'] = extra[u'host_name'] = host_name | |
| 319 | |
| 320 invite_url = url_template.format(**format_args) | |
| 321 format_args[u'url'] = invite_url | |
| 322 | |
| 323 yield sat_email.sendEmail( | |
| 324 self.host, | |
|
2291
c05000d00dbb
plugin events, invitations + jp (event/create, invitation/invitee/invite): several emails addresses can now be specified for a single invitation:
Goffi <goffi@goffi.org>
parents:
2256
diff
changeset
|
325 [email] + emails_extra, |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
326 (kwargs.pop(u'message_subject', None) or DEFAULT_SUBJECT).format( |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
327 **format_args), |
| 2184 | 328 (kwargs.pop(u'message_body', None) or DEFAULT_BODY).format(**format_args), |
| 329 ) | |
| 330 | |
| 331 ## extra data saving | |
| 332 self.invitations[id_] = extra | |
| 333 | |
| 334 if kwargs: | |
| 335 log.warning(_(u"Not all arguments have been consumed: {}").format(kwargs)) | |
| 336 | |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
337 extra[KEY_ID] = id_ |
|
2230
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
338 extra[KEY_JID] = jid_ |
|
2211
df115e4a36c7
plugin invitations: invitation id and invitee jid are now added to return dict in invitationCreate, bridge signature has changed too
Goffi <goffi@goffi.org>
parents:
2210
diff
changeset
|
339 defer.returnValue(extra) |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
340 |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
341 def get(self, id_): |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
342 """Retrieve invitation linked to uuid if it exists |
|
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
343 |
|
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
344 @param id_(unicode): UUID linked to an invitation |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
345 @return (dict[unicode, unicode]): data associated to the invitation |
|
2212
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
346 @raise KeyError: there is not invitation with this id_ |
|
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
347 """ |
|
eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
Goffi <goffi@goffi.org>
parents:
2211
diff
changeset
|
348 return self.invitations[id_] |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
349 |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
350 def _modify(self, id_, new_extra, replace): |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
351 return self.modify(id_, {unicode(k): unicode(v) for k,v in new_extra.iteritems()}, |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
352 replace) |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
353 |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
354 def modify(self, id_, new_extra, replace=False): |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
355 """Modify invitation data |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
356 |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
357 @param id_(unicode): UUID linked to an invitation |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
358 @param new_extra(dict[unicode, unicode]): data to update |
|
2241
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
359 empty values will be deleted if replace is True |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
360 @param replace(bool): if True replace the data |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
361 else update them |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
362 @raise KeyError: there is not invitation with this id_ |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
363 """ |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
364 self.checkExtra(new_extra) |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
365 def gotCurrentData(current_data): |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
366 if replace: |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
367 new_data = new_extra |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
368 for k in EXTRA_RESERVED: |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
369 try: |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
370 new_data[k] = current_data[k] |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
371 except KeyError: |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
372 continue |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
373 else: |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
374 new_data = current_data |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
375 for k,v in new_extra.iteritems(): |
|
2241
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
376 if k in EXTRA_RESERVED: |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
377 log.warning(_(u"Skipping reserved key {key}".format(k))) |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
378 continue |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
379 if v: |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
380 new_data[k] = v |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
381 else: |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
382 try: |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
383 del new_data[k] |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
384 except KeyError: |
|
f87b673c7d17
plugin invitations: on modify an empty value delete corresponding extra keys, and reserved keys are now ignored.
Goffi <goffi@goffi.org>
parents:
2230
diff
changeset
|
385 pass |
|
2219
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
386 |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
387 self.invitations[id_] = new_data |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
388 |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
389 d = self.invitations[id_] |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
390 d.addCallback(gotCurrentData) |
|
77a3d0a28642
plugin invitations: added modify method (+ bridge) and fixed email setting in extra
Goffi <goffi@goffi.org>
parents:
2212
diff
changeset
|
391 return d |
|
2230
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
392 |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
393 def _list(self, profile=C.PROF_KEY_NONE): |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
394 return self.list(profile) |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
395 |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
396 @defer.inlineCallbacks |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
397 def list(self, profile=C.PROF_KEY_NONE): |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
398 """List invitations |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
399 |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
400 @param profile(unicode): return invitation linked to this profile only |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
401 C.PROF_KEY_NONE: don't filter invitations |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
402 @return list(unicode): invitations uids |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
403 """ |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
404 invitations = yield self.invitations.items() |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
405 if profile != C.PROF_KEY_NONE: |
|
2909
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
406 invitations = {id_:data for id_, data in invitations.iteritems() |
|
90146552cde5
core (memory), plugin XEP-0329, plugin invitation: minor style improvments
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
407 if data.get(u'profile') == profile} |
|
2230
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
408 |
|
ebc0c1701811
plugin invitations: added invitationList command
Goffi <goffi@goffi.org>
parents:
2223
diff
changeset
|
409 defer.returnValue(invitations) |