Mercurial > libervia-backend
annotate src/plugins/plugin_misc_invitations.py @ 2212:eaf2467d19ce
plugin invitations: added getInvitation method, it return invitation data and raise an error if it is not found
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 29 Mar 2017 19:42:42 +0200 |
| parents | df115e4a36c7 |
| children | 77a3d0a28642 |
| rev | line source |
|---|---|
| 2184 | 1 #!/usr/bin/env python2 |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT plugin for file tansfer | |
| 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) | |
| 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 | |
| 20 from sat.core.i18n import _, D_ | |
| 21 from sat.core.constants import Const as C | |
| 22 from sat.core import exceptions | |
| 23 from sat.core.log import getLogger | |
| 24 log = getLogger(__name__) | |
| 25 import shortuuid | |
| 26 from sat.tools import utils | |
| 27 from twisted.internet import defer | |
| 28 from twisted.words.protocols.jabber import jid | |
| 29 from twisted.words.protocols.jabber import error | |
| 30 from sat.memory import persistent | |
| 31 from sat.tools import email as sat_email | |
| 32 | |
| 33 | |
| 34 PLUGIN_INFO = { | |
| 35 C.PI_NAME: "Invitations", | |
| 36 C.PI_IMPORT_NAME: "INVITATIONS", | |
| 37 C.PI_TYPE: C.PLUG_TYPE_MISC, | |
| 38 C.PI_DEPENDENCIES: ['XEP-0077'], | |
| 39 C.PI_MAIN: "InvitationsPlugin", | |
| 40 C.PI_HANDLER: "no", | |
| 41 C.PI_DESCRIPTION: _(u"""invitation of people without XMPP account""") | |
| 42 } | |
| 43 | |
| 44 | |
| 45 SUFFIX_MAX = 5 | |
| 46 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
|
47 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
|
48 KEY_JID = u'jid' |
| 2184 | 49 KEY_CREATED = u'created' |
| 50 KEY_LAST_CONNECTION = u'last_connection' | |
|
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
|
51 EXTRA_RESERVED = {KEY_ID, KEY_JID, KEY_CREATED, u'jid_', u'jid', KEY_LAST_CONNECTION} |
| 2184 | 52 DEFAULT_SUBJECT = D_(u"You have been invited by {host_name} to {app_name}") |
| 53 DEFAULT_BODY = D_(u"""Hello {name}! | |
| 54 | |
| 55 You have received an invitation from {host_name} to participate to "{app_name}". | |
| 56 To join, you just have to click on the following URL: | |
| 57 {url} | |
| 58 | |
| 59 Please note that this URL should not be shared with anybody! | |
| 60 If you want more details on {app_name}, you can check {app_url}. | |
| 61 | |
| 62 Welcome! | |
| 63 """) | |
| 64 | |
| 65 | |
| 66 class InvitationsPlugin(object): | |
| 67 | |
| 68 def __init__(self, host): | |
| 69 log.info(_(u"plugin Invitations initialization")) | |
| 70 self.host = host | |
| 71 self.invitations = persistent.LazyPersistentBinaryDict(u'invitations') | |
|
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
|
72 host.bridge.addMethod("invitationCreate", ".plugin", in_sign='sssssssssa{ss}s', out_sign='a{ss}', |
| 2184 | 73 method=self._createInvitation, |
| 74 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
|
75 host.bridge.addMethod("invitationGet", ".plugin", in_sign='s', out_sign='a{ss}', |
|
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
|
76 method=self.getInvitation, |
|
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
|
77 async=True) |
|
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
|
78 |
| 2184 | 79 def _createInvitation(self, jid_=u'', password=u'', name=u'', host_name=u'', email=u'', language=u'', url_template=u'', message_subject=u'', message_body=u'', extra=None, profile=u''): |
| 80 # XXX: we don't use **kwargs here to keep arguments name for introspection with D-Bus bridge | |
| 81 | |
| 82 if extra is None: | |
| 83 extra = {} | |
| 84 else: | |
| 85 extra = {unicode(k): unicode(v) for k,v in extra.iteritems()} | |
| 86 | |
| 87 # we need to be sure that values are unicode, else they won't be pickled correctly with D-Bus | |
| 88 kwargs = {"extra": extra} | |
| 89 for key in ("jid_", "password", "name", "host_name", "email", "language", "url_template", "message_subject", "message_body", "profile"): | |
| 90 value = locals()[key] | |
| 91 if value: | |
| 92 kwargs[key] = unicode(value) | |
|
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
|
93 d = self.createInvitation(**kwargs) |
|
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
|
94 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
|
95 data[KEY_JID] = data[KEY_JID].full() |
|
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
|
96 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
|
97 return d |
| 2184 | 98 |
| 99 @defer.inlineCallbacks | |
| 100 def createInvitation(self, **kwargs): | |
| 101 ur"""create an invitation | |
| 102 | |
| 103 this will create an XMPP account and a profile, and use a UUID to retrieve them. | |
| 104 the profile is automatically generated in the form guest@@[UUID], this way they can be retrieved easily | |
| 105 **kwargs: keywords arguments which can have the following keys, unset values are equivalent to None: | |
| 106 jid_(jid.JID, None): jid to use for invitation, the jid will be created using XEP-0077 | |
| 107 if the jid has no user part, an anonymous account will be used (no XMPP account created in this case) | |
|
2208
c316c6f6a737
plugin invitations: fixed leak of uuid in jid
Goffi <goffi@goffi.org>
parents:
2185
diff
changeset
|
108 if None, automatically generate an account name (in the form "invitation-[random UUID]@domain.tld") (note that this UUID is not the |
|
c316c6f6a737
plugin invitations: fixed leak of uuid in jid
Goffi <goffi@goffi.org>
parents:
2185
diff
changeset
|
109 same as the invitation one, as jid can be used publicly (leaking the UUID), and invitation UUID give access to account. |
| 2184 | 110 in case of conflict, a suffix number is added to the account until a free one if found (with a failure if SUFFIX_MAX is reached) |
| 111 password(unicode, None): password to use (will be used for XMPP account and profile) | |
| 112 None to automatically generate one | |
| 113 name(unicode, None): name of the invitee | |
| 114 host_name(unicode, None): name of the host | |
| 115 email(unicode, None): email to send the invitation to | |
| 116 if None, no invitation email is sent, you can still associate email using extra | |
| 117 if email is used, extra can't have "email" key | |
| 118 language(unicode): language of the invitee (used notabily to translate the invitation) | |
| 119 TODO: not used yet | |
| 120 url_template(unicode, None): template to use to construct the invitation URL | |
| 121 use {uuid} as a placeholder for identifier | |
| 122 use None if you don't want to include URL (or if it is already specified in custom message) | |
| 123 /!\ you must put full URL, don't forget https:// | |
| 124 /!\ the URL will give access to the invitee account, you should warn in message to not publish it publicly | |
|
2210
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
125 message_subject(unicode, None): customised message body for the invitation email |
| 2184 | 126 None to use default subject |
| 127 uses the same substitution as for message_body | |
| 128 message_body(unicode, None): customised message body for the invitation email | |
| 129 None to use default body | |
| 130 use {name} as a place holder for invitee name | |
| 131 use {url} as a placeholder for the invitation url | |
| 132 use {uuid} as a placeholder for the identifier | |
| 133 use {app_name} as a placeholder for this software name | |
| 134 use {app_url} as a placeholder for this software official website | |
| 135 use {profile} as a placeholder for host's profile | |
| 136 use {host_name} as a placeholder for host's name | |
| 137 extra(dict, None): extra data to associate with the invitee | |
| 138 some keys are reserved: | |
| 139 - created (creation date) | |
| 140 if email argument is used, "email" key can't be used | |
| 141 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
|
142 @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
|
143 - UUID associated with the invitee (key: id) |
| 2184 | 144 - filled extra dictionary, as saved in the databae |
| 145 """ | |
| 146 ## initial checks | |
| 147 extra = kwargs.pop('extra', {}) | |
| 148 if set(kwargs).intersection(extra): | |
| 149 raise exceptions.ValueError(_(u"You can't use following key(s) in both args and extra: {}").format( | |
| 150 u', '.join(set(kwargs).intersection(extra)))) | |
| 151 | |
| 152 if EXTRA_RESERVED.intersection(extra): | |
| 153 raise exceptions.ValueError(_(u"You can't use following key(s) in extra, they are reserved: {}").format( | |
| 154 u', '.join(EXTRA_RESERVED.intersection(extra)))) | |
| 155 | |
|
2210
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
156 if not 'url_template' in extra and not 'message_body' in extra: |
|
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
157 raise ValueError(_(u"You need to provide url_template if you use default message body")) |
|
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
158 |
|
f8d61592f1fc
plugin invitations: raise ValueError if url_template and message_body are both not specified
Goffi <goffi@goffi.org>
parents:
2208
diff
changeset
|
159 |
| 2184 | 160 ## uuid |
| 161 log.info(_(u"creating an invitation")) | |
| 162 id_ = unicode(shortuuid.uuid()) | |
| 163 | |
| 164 ## XMPP account creation | |
| 165 password = kwargs.pop(u'password', None) | |
| 166 if password is None: | |
| 167 password = utils.generatePassword() | |
| 168 assert password | |
| 169 # XXX: password is here saved in clear in database | |
| 170 # it is needed for invitation as the same password is used for profile | |
| 171 # and SàT need to be able to automatically open the profile with the uuid | |
| 172 # FIXME: we could add an extra encryption key which would be used with the uuid | |
| 173 # when the invitee is connecting (e.g. with URL). This key would not be saved | |
| 174 # and could be used to encrypt profile password. | |
| 175 extra[u'password'] = password | |
| 176 | |
| 177 jid_ = kwargs.pop(u'jid_', None) | |
| 178 if not jid_: | |
| 179 domain = self.host.memory.getConfig(None, 'xmpp_domain') | |
| 180 if not domain: | |
| 181 # TODO: fallback to profile's domain | |
| 182 raise ValueError(_(u"You need to specify xmpp_domain in sat.conf")) | |
|
2208
c316c6f6a737
plugin invitations: fixed leak of uuid in jid
Goffi <goffi@goffi.org>
parents:
2185
diff
changeset
|
183 jid_ = u"invitation-{uuid}@{domain}".format(uuid=shortuuid.uuid(), domain=domain) |
| 2184 | 184 jid_ = jid.JID(jid_) |
| 185 if jid_.user: | |
| 186 # we don't register account if there is no user as anonymous login is then used | |
| 187 try: | |
| 188 yield self.host.plugins['XEP-0077'].registerNewAccount(jid_, password) | |
| 189 except error.StanzaError as e: | |
| 190 prefix = jid_.user | |
| 191 idx = 0 | |
| 192 while e.condition == u'conflict': | |
| 193 if idx >= SUFFIX_MAX: | |
| 194 raise exceptions.ConflictError(_(u"Can't create XMPP account")) | |
| 195 jid_.user = prefix + '_' + unicode(idx) | |
| 196 log.info(_(u"requested jid already exists, trying with {}".format(jid_.full()))) | |
| 197 try: | |
| 198 yield self.host.plugins['XEP-0077'].registerNewAccount(jid_, password) | |
| 199 except error.StanzaError as e: | |
| 200 idx += 1 | |
| 201 else: | |
| 202 break | |
| 203 if e.condition != u'conflict': | |
| 204 raise e | |
| 205 | |
| 206 log.info(_(u"account {jid_} created").format(jid_=jid_.full())) | |
| 207 | |
| 208 ## profile creation | |
| 209 extra['guest_profile'] = guest_profile = INVITEE_PROFILE_TPL.format(uuid=id_) | |
| 210 # profile creation should not fail as we generate unique name ourselves | |
| 211 yield self.host.memory.createProfile(guest_profile, password) | |
| 212 yield self.host.memory.startSession(password, guest_profile) | |
| 213 yield self.host.memory.setParam("JabberID", jid_.full(), "Connection", profile_key=guest_profile) | |
| 214 yield self.host.memory.setParam("Password", password, "Connection", profile_key=guest_profile) | |
| 215 | |
| 216 ## email | |
| 217 language = kwargs.pop(u'language', None) | |
| 218 if language is not None: | |
| 219 extra[u'language'] = language | |
| 220 email = kwargs.pop(u'email', None) | |
| 221 | |
| 222 if email is not None: | |
| 223 url_template = kwargs.pop(u'url_template', '') | |
| 224 format_args = { | |
| 225 u'uuid': id_, | |
| 226 u'app_name': C.APP_NAME, | |
| 227 u'app_url': C.APP_URL} | |
| 228 | |
| 229 name = kwargs.pop(u'name', None) | |
| 230 if name is None: | |
| 231 format_args[u'name'] = email | |
| 232 else: | |
| 233 format_args[u'name'] = extra[u'name'] = name | |
| 234 | |
| 235 profile = kwargs.pop(u'profile', None) | |
| 236 if profile is None: | |
| 237 format_args[u'profile'] = u'' | |
| 238 else: | |
| 239 format_args[u'profile'] = extra[u'profile'] = profile | |
| 240 | |
| 241 host_name = kwargs.pop(u'host_name', None) | |
| 242 if host_name is None: | |
| 243 format_args[u'host_name'] = profile or _(u"somebody") | |
| 244 else: | |
| 245 format_args[u'host_name'] = extra[u'host_name'] = host_name | |
| 246 | |
| 247 invite_url = url_template.format(**format_args) | |
| 248 format_args[u'url'] = invite_url | |
| 249 | |
| 250 yield sat_email.sendEmail( | |
| 251 self.host, | |
| 252 [email], | |
| 253 (kwargs.pop(u'message_subject', None) or DEFAULT_SUBJECT).format(**format_args), | |
| 254 (kwargs.pop(u'message_body', None) or DEFAULT_BODY).format(**format_args), | |
| 255 ) | |
| 256 | |
| 257 ## extra data saving | |
| 258 self.invitations[id_] = extra | |
| 259 | |
| 260 if kwargs: | |
| 261 log.warning(_(u"Not all arguments have been consumed: {}").format(kwargs)) | |
| 262 | |
|
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
|
263 extra[KEY_ID] = 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
|
264 extra[KEY_JID] = jid |
|
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
|
265 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
|
266 |
|
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
|
267 def getInvitation(self, 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
|
268 """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
|
269 |
|
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
|
270 @param id_(unicode): UUID linked to an invitation |
|
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
|
271 @return dict(unicode, unicode): data associated to the invitation |
|
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
|
272 @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
|
273 """ |
|
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
|
274 return self.invitations[id_] |