Mercurial > libervia-backend
annotate libervia/backend/plugins/plugin_comp_email_gateway/__init__.py @ 4322:00837fa13e5a default tip @
tools (common/template), cli (call/gui): use font-awesome instead of fontello:
following change in Libervia Media, code has been updated to use font-awesome now instead
of fontello.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 26 Oct 2024 22:42:17 +0200 |
| parents | 055930cc81f9 |
| children |
| rev | line source |
|---|---|
| 4303 | 1 #!/usr/bin/env python3 |
| 2 | |
| 3 # Libervia Email Gateway Component | |
| 4 # Copyright (C) 2009-2024 Jérôme Poisson (goffi@goffi.org) | |
| 5 | |
| 6 # This program is free software: you can redistribute it and/or modify | |
| 7 # it under the terms of the GNU Affero General Public License as published by | |
| 8 # the Free Software Foundation, either version 3 of the License, or | |
| 9 # (at your option) any later version. | |
| 10 | |
| 11 # This program is distributed in the hope that it will be useful, | |
| 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 14 # GNU Affero General Public License for more details. | |
| 15 | |
| 16 # You should have received a copy of the GNU Affero General Public License | |
| 17 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 from email.header import decode_header | |
| 20 from email.message import EmailMessage | |
| 21 from email.mime.text import MIMEText | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
22 from email.utils import formataddr, getaddresses, parseaddr |
| 4303 | 23 from functools import partial |
| 24 import re | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
25 from typing import cast |
| 4303 | 26 |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
27 from pydantic import BaseModel |
| 4303 | 28 from twisted.internet import defer, reactor |
| 29 from twisted.mail import smtp | |
| 30 from twisted.words.protocols.jabber import jid | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
31 from twisted.words.protocols.jabber import error as jabber_error |
| 4303 | 32 from twisted.words.protocols.jabber.error import StanzaError |
| 33 from twisted.words.protocols.jabber.xmlstream import XMPPHandler | |
| 34 from twisted.words.xish import domish | |
| 35 from wokkel import data_form, disco, iwokkel | |
| 36 from zope.interface import implementer | |
| 37 | |
| 38 from libervia.backend.core import exceptions | |
| 39 from libervia.backend.core.constants import Const as C | |
| 40 from libervia.backend.core.core_types import SatXMPPEntity | |
| 41 from libervia.backend.core.i18n import D_, _ | |
| 42 from libervia.backend.core.log import getLogger | |
| 43 from libervia.backend.memory.persistent import LazyPersistentBinaryDict | |
| 44 from libervia.backend.memory.sqla import select | |
| 45 from libervia.backend.memory.sqla_mapping import PrivateIndBin | |
| 46 from libervia.backend.models.core import MessageData | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
47 from libervia.backend.plugins.plugin_xep_0033 import ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
48 RECIPIENT_FIELDS, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
49 AddressType, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
50 AddressesData, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
51 ) |
| 4303 | 52 from libervia.backend.plugins.plugin_xep_0077 import XEP_0077 |
| 53 from libervia.backend.plugins.plugin_xep_0106 import XEP_0106 | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
54 from libervia.backend.plugins.plugin_xep_0131 import XEP_0131, HeadersData, Urgency |
| 4303 | 55 from libervia.backend.tools.utils import aio |
| 56 | |
| 57 from .models import Credentials, UserData | |
| 58 from .imap import IMAPClientFactory | |
| 59 | |
| 60 | |
| 61 log = getLogger(__name__) | |
| 62 | |
| 63 IMPORT_NAME = "email-gateway" | |
| 64 NAME = "Libervia Email Gateway" | |
| 65 | |
| 66 PLUGIN_INFO = { | |
| 67 C.PI_NAME: "Email Gateway Component", | |
| 68 C.PI_IMPORT_NAME: IMPORT_NAME, | |
| 69 C.PI_MODES: [C.PLUG_MODE_COMPONENT], | |
| 70 C.PI_TYPE: C.PLUG_TYPE_ENTRY_POINT, | |
| 71 C.PI_PROTOCOLS: [], | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
72 C.PI_DEPENDENCIES: ["XEP-0033", "XEP-0077", "XEP-0106"], |
| 4303 | 73 C.PI_RECOMMENDATIONS: [], |
| 74 C.PI_MAIN: "EmailGatewayComponent", | |
| 75 C.PI_HANDLER: C.BOOL_TRUE, | |
| 76 C.PI_DESCRIPTION: D_( | |
| 77 "Gateway to handle email. Usual emails are handled as message, while mailing " | |
| 78 "lists are converted to pubsub blogs." | |
| 79 ), | |
| 80 } | |
| 81 | |
| 82 CONF_SECTION = f"component {IMPORT_NAME}" | |
| 83 PREFIX_KEY_CREDENTIALS = "CREDENTIALS_" | |
| 84 KEY_CREDENTIALS = f"{PREFIX_KEY_CREDENTIALS}{{from_jid}}" | |
| 85 | |
| 86 email_pattern = re.compile(r"[^@]+@[^@]+\.[^@]+") | |
| 87 | |
| 88 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
89 class SendMailExtra(BaseModel): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
90 addresses: AddressesData | None = None |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
91 headers: HeadersData | None = None |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
92 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
93 |
| 4303 | 94 class EmailGatewayComponent: |
| 95 IMPORT_NAME = IMPORT_NAME | |
| 96 verbose = 0 | |
| 97 | |
| 98 def __init__(self, host): | |
| 99 self.host = host | |
| 100 self.client: SatXMPPEntity | None = None | |
| 101 self.initalized = False | |
| 102 self.storage: LazyPersistentBinaryDict | None = None | |
| 103 self._iq_register = cast(XEP_0077, host.plugins["XEP-0077"]) | |
| 104 self._iq_register.register_handler( | |
| 105 self._on_registration_form, self._on_registration_submit | |
| 106 ) | |
| 107 self._e = cast(XEP_0106, host.plugins["XEP-0106"]) | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
108 self._shim = cast(XEP_0131, host.plugins["XEP-0131"]) |
| 4303 | 109 # TODO: For the moment, all credentials are kept in cache; we should only keep the |
| 110 # X latest. | |
| 111 self.users_data: dict[jid.JID, UserData] = {} | |
| 112 host.trigger.add_with_check( | |
| 113 "message_received", self, self._message_received_trigger, priority=-1000 | |
| 114 ) | |
| 115 | |
| 116 async def _init(self) -> None: | |
| 117 """Initialisation done after profile is connected""" | |
| 118 assert self.client is not None | |
| 119 self.client.identities.append(disco.DiscoIdentity("gateway", "smtp", NAME)) | |
| 120 self.storage = LazyPersistentBinaryDict(IMPORT_NAME, self.client.profile) | |
| 121 await self.connect_registered_users() | |
| 122 | |
| 123 @aio | |
| 124 async def get_registered_users(self) -> dict[jid.JID, Credentials]: | |
| 125 """Retrieve credentials for all registered users | |
| 126 | |
| 127 @return: a mapping from user JID to credentials data. | |
| 128 """ | |
| 129 assert self.client is not None | |
| 130 profile_id = self.host.memory.storage.profiles[self.client.profile] | |
| 131 async with self.host.memory.storage.session() as session: | |
| 132 query = select(PrivateIndBin).where( | |
| 133 PrivateIndBin.profile_id == profile_id, | |
| 134 PrivateIndBin.namespace == IMPORT_NAME, | |
| 135 PrivateIndBin.key.startswith(PREFIX_KEY_CREDENTIALS), | |
| 136 ) | |
| 137 result = await session.execute(query) | |
| 138 return { | |
| 139 jid.JID(p.key[len(PREFIX_KEY_CREDENTIALS) :]): p.value | |
| 140 for p in result.scalars() | |
| 141 } | |
| 142 | |
| 143 async def connect_registered_users(self) -> None: | |
| 144 """Connected users already registered to the gateway.""" | |
| 145 registered_data = await self.get_registered_users() | |
| 146 for user_jid, credentials in registered_data.items(): | |
| 147 user_data = self.users_data[user_jid] = UserData(credentials=credentials) | |
| 148 if not credentials["imap_success"]: | |
| 149 log.warning( | |
| 150 f"Ignoring unsuccessful IMAP credentials of {user_jid}. This user " | |
| 151 "won't receive message from this gateway." | |
| 152 ) | |
| 153 else: | |
| 154 try: | |
| 155 await self.connect_imap(user_jid, user_data) | |
| 156 except Exception as e: | |
| 157 log.warning(f"Can't connect {user_jid} to IMAP: {e}.") | |
| 158 else: | |
| 159 log.debug(f"Connection to IMAP server successful for {user_jid}.") | |
| 160 | |
| 161 def get_handler(self, __) -> XMPPHandler: | |
| 162 return EmailGatewayHandler() | |
| 163 | |
| 164 async def profile_connecting(self, client: SatXMPPEntity) -> None: | |
| 165 self.client = client | |
| 166 if not self.initalized: | |
| 167 await self._init() | |
| 168 self.initalized = True | |
| 169 | |
| 170 def _message_received_trigger( | |
| 171 self, | |
| 172 client: SatXMPPEntity, | |
| 173 message_elt: domish.Element, | |
| 174 post_treat: defer.Deferred, | |
| 175 ) -> bool: | |
| 176 """add the gateway workflow on post treatment""" | |
| 177 if client != self.client: | |
| 178 return True | |
| 179 post_treat.addCallback( | |
| 180 lambda mess_data: defer.ensureDeferred( | |
| 181 self.on_message(client, mess_data, message_elt) | |
| 182 ) | |
| 183 ) | |
| 184 return True | |
| 185 | |
| 186 async def on_message( | |
| 187 self, client: SatXMPPEntity, mess_data: MessageData, message_elt: domish.Element | |
| 188 ) -> dict: | |
| 189 """Called once message has been parsed | |
| 190 | |
| 191 @param client: Client session. | |
| 192 @param mess_data: Message data. | |
| 193 @return: Message data. | |
| 194 """ | |
| 195 if client != self.client: | |
| 196 return mess_data | |
| 197 from_jid = mess_data["from"].userhostJID() | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
198 extra_kw = {} |
| 4303 | 199 if mess_data["type"] not in ("chat", "normal"): |
| 200 log.warning(f"ignoring message with unexpected type: {mess_data}") | |
| 201 return mess_data | |
| 202 if not client.is_local(from_jid): | |
| 203 log.warning(f"ignoring non local message: {mess_data}") | |
| 204 return mess_data | |
| 205 if not mess_data["to"].user: | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
206 addresses = mess_data["extra"].get("addresses") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
207 if not addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
208 log.warning(f"ignoring message addressed to gateway itself: {mess_data}") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
209 return mess_data |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
210 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
211 to_email = None |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
212 extra_kw["addresses"] = addresses |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
213 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
214 try: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
215 to_email = self._e.unescape(mess_data["to"].user) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
216 except ValueError: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
217 raise exceptions.DataError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
218 f'Invalid "to" JID, can\'t send message: {message_elt.toXml()}.' |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
219 ) |
| 4303 | 220 |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
221 self._shim.move_keywords_to_headers(mess_data["extra"]) |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
222 headers = mess_data["extra"].get("headers") |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
223 if headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
224 extra_kw["headers"] = headers |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
225 |
| 4303 | 226 try: |
| 227 body_lang, body = next(iter(mess_data["message"].items())) | |
| 228 except (KeyError, StopIteration): | |
| 229 log.warning(f"No body found: {mess_data}") | |
| 230 body_lang, body = "", "" | |
| 231 try: | |
| 232 subject_lang, subject = next(iter(mess_data["subject"].items())) | |
| 233 except (KeyError, StopIteration): | |
| 234 subject_lang, subject = "", None | |
| 235 | |
| 236 if not body and not subject: | |
| 237 log.warning(f"Ignoring empty message: {mess_data}") | |
| 238 return mess_data | |
| 239 | |
| 240 try: | |
| 241 await self.send_email( | |
| 242 from_jid=from_jid, | |
| 243 to_email=to_email, | |
| 244 body=body, | |
| 245 subject=subject, | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
246 extra=SendMailExtra(**extra_kw) if extra_kw else None, |
| 4303 | 247 ) |
| 248 except exceptions.UnknownEntityError: | |
| 249 log.warning(f"Can't send message, user {from_jid} is not registered.") | |
| 250 message_error_elt = StanzaError( | |
| 251 "subscription-required", | |
| 252 text="User need to register to the gateway before sending emails.", | |
| 253 ).toResponse(message_elt) | |
| 254 await client.a_send(message_error_elt) | |
| 255 raise exceptions.CancelError("User not registered.") | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
256 except StanzaError as e: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
257 log.warning("Can't send message: {e}") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
258 message_error_elt = e.toResponse(message_elt) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
259 await client.a_send(message_error_elt) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
260 raise exceptions.CancelError("Can't send message: {e}") |
| 4303 | 261 |
| 262 return mess_data | |
| 263 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
264 def jid_to_email( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
265 self, client: SatXMPPEntity, address_jid: jid.JID, credentials: dict[str, str] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
266 ) -> str: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
267 """Convert a JID to an email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
268 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
269 If JID is from the gateway, email address will be extracted. Otherwise, the |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
270 gateway email will be used, with XMPP address specified in name part. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
271 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
272 @param address_jid: JID of the recipient. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
273 @param credentials: Sender credentials. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
274 @return: Email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
275 """ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
276 if address_jid and address_jid.host.endswith(str(client.jid)): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
277 return self._e.unescape(address_jid.user) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
278 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
279 email_address = credentials["user_email"] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
280 if address_jid: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
281 email_address = formataddr((f"xmpp:{address_jid}", email_address)) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
282 return email_address |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
283 |
| 4303 | 284 async def send_email( |
| 285 self, | |
| 286 from_jid: jid.JID, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
287 to_email: str | None, |
| 4303 | 288 body: str, |
| 289 subject: str | None, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
290 extra: SendMailExtra | None = None, |
| 4303 | 291 ) -> None: |
| 292 """Send an email using sender credentials. | |
| 293 | |
| 294 Credentials will be retrieve from cache, or database. | |
| 295 | |
| 296 @param from_jid: Bare JID of the sender. | |
| 297 @param to_email: Email address of the destinee. | |
| 298 @param body: Body of the email. | |
| 299 @param subject: Subject of the email. | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
300 @param extra: Extra data. |
| 4303 | 301 |
| 302 @raise exceptions.UnknownEntityError: Credentials for "from_jid" can't be found. | |
| 303 """ | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
304 assert self.client is not None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
305 if extra is None: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
306 extra = SendMailExtra() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
307 if to_email is None and (extra.addresses is None or not extra.addresses.to): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
308 raise exceptions.InternalError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
309 '"to_email" can\'t be None if there is no "to" address!' |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
310 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
311 |
| 4303 | 312 # We need a bare jid. |
| 313 assert self.storage is not None | |
| 314 assert not from_jid.resource | |
| 315 try: | |
| 316 user_data = self.users_data[from_jid] | |
| 317 except KeyError: | |
| 318 key = KEY_CREDENTIALS.format(from_jid=from_jid) | |
| 319 credentials = await self.storage.get(key) | |
| 320 if credentials is None: | |
| 321 raise exceptions.UnknownEntityError( | |
| 322 f"No credentials found for {from_jid}." | |
| 323 ) | |
| 324 self.users_data[from_jid] = UserData(credentials) | |
| 325 else: | |
| 326 credentials = user_data.credentials | |
| 327 | |
| 328 msg = MIMEText(body, "plain", "UTF-8") | |
| 329 if subject is not None: | |
| 330 msg["Subject"] = subject | |
| 331 msg["From"] = formataddr( | |
| 332 (credentials["user_name"] or None, credentials["user_email"]) | |
| 333 ) | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
334 if extra.addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
335 assert extra.addresses.to |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
336 main_to_address = extra.addresses.to[0] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
337 assert main_to_address.jid |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
338 to_email = self.jid_to_email(self.client, main_to_address.jid, credentials) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
339 for field in RECIPIENT_FIELDS: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
340 addresses = getattr(extra.addresses, field) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
341 if not addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
342 continue |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
343 for address in addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
344 if not address.delivered and ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
345 address.jid is None or address.jid.host != str(self.client.jid) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
346 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
347 log.warning( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
348 "Received undelivered message to external JID, this is not " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
349 "allowed! Cancelling the message sending." |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
350 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
351 stanza_err = jabber_error.StanzaError( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
352 "forbidden", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
353 text="Multicasting (XEP-0033 addresses) can only be used " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
354 "with JID from this gateway, not external ones. " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
355 f" {address.jid} can't be delivered by this gateway and " |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
356 "should be delivered by server instead.", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
357 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
358 raise stanza_err |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
359 email_addresses = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
360 self.jid_to_email(self.client, address.jid, credentials) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
361 for address in addresses |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
362 if address.jid |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
363 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
364 if email_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
365 msg[field.upper()] = ", ".join(email_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
366 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
367 assert to_email is not None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
368 msg["To"] = to_email |
| 4303 | 369 |
| 370 sender_domain = credentials["user_email"].split("@", 1)[-1] | |
| 371 | |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
372 if extra.headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
373 if extra.headers.keywords: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
374 msg["Keywords"] = extra.headers.keywords |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
375 if extra.headers.urgency: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
376 urgency = extra.headers.urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
377 if urgency == Urgency.medium: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
378 importance = "normal" |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
379 else: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
380 importance = urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
381 msg["Importance"] = importance |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
382 |
| 4303 | 383 await smtp.sendmail( |
| 384 credentials["smtp_host"].encode(), | |
| 385 credentials["user_email"].encode(), | |
| 386 [to_email.encode()], | |
| 387 msg.as_bytes(), | |
| 388 senderDomainName=sender_domain, | |
| 389 port=int(credentials["smtp_port"]), | |
| 390 username=credentials["smtp_username"].encode(), | |
| 391 password=credentials["smtp_password"].encode(), | |
| 392 requireAuthentication=True, | |
| 393 # TODO: only STARTTLS is supported right now, implicit TLS should be supported | |
| 394 # too. | |
| 395 requireTransportSecurity=True, | |
| 396 ) | |
| 397 | |
| 398 async def _on_registration_form( | |
| 399 self, client: SatXMPPEntity, iq_elt: domish.Element | |
| 400 ) -> tuple[bool, data_form.Form] | None: | |
| 401 if client != self.client: | |
| 402 return | |
| 403 assert self.storage is not None | |
| 404 from_jid = jid.JID(iq_elt["from"]) | |
| 405 key = KEY_CREDENTIALS.format(from_jid=from_jid.userhost()) | |
| 406 credentials = await self.storage.get(key) or {} | |
| 407 | |
| 408 form = data_form.Form(formType="form", title="IMAP/SMTP Credentials") | |
| 409 | |
| 410 # Add instructions | |
| 411 form.instructions = [ | |
| 412 D_( | |
| 413 "Please provide your IMAP and SMTP credentials to configure the " | |
| 414 "connection." | |
| 415 ) | |
| 416 ] | |
| 417 | |
| 418 # Add identity fields | |
| 419 form.addField( | |
| 420 data_form.Field( | |
| 421 fieldType="text-single", | |
| 422 var="user_name", | |
| 423 label="User Name", | |
| 424 desc=D_('The display name to use in the "From" field of sent emails.'), | |
| 425 value=credentials.get("user_name"), | |
| 426 required=True, | |
| 427 ) | |
| 428 ) | |
| 429 | |
| 430 form.addField( | |
| 431 data_form.Field( | |
| 432 fieldType="text-single", | |
| 433 var="user_email", | |
| 434 label="User Email", | |
| 435 desc=D_('The email address to use in the "From" field of sent emails.'), | |
| 436 value=credentials.get("user_email"), | |
| 437 required=True, | |
| 438 ) | |
| 439 ) | |
| 440 | |
| 441 # Add fields for IMAP credentials | |
| 442 form.addField( | |
| 443 data_form.Field( | |
| 444 fieldType="text-single", | |
| 445 var="imap_host", | |
| 446 label="IMAP Host", | |
| 447 desc=D_("IMAP server hostname or IP address"), | |
| 448 value=credentials.get("imap_host"), | |
| 449 required=True, | |
| 450 ) | |
| 451 ) | |
| 452 form.addField( | |
| 453 data_form.Field( | |
| 454 fieldType="text-single", | |
| 455 var="imap_port", | |
| 456 label="IMAP Port", | |
| 457 desc=D_("IMAP server port (default: 993)"), | |
| 458 value=credentials.get("imap_port", "993"), | |
| 459 ) | |
| 460 ) | |
| 461 form.addField( | |
| 462 data_form.Field( | |
| 463 fieldType="text-single", | |
| 464 var="imap_username", | |
| 465 label="IMAP Username", | |
| 466 desc=D_("Username for IMAP authentication"), | |
| 467 value=credentials.get("imap_username"), | |
| 468 required=True, | |
| 469 ) | |
| 470 ) | |
| 471 form.addField( | |
| 472 data_form.Field( | |
| 473 fieldType="text-private", | |
| 474 var="imap_password", | |
| 475 label="IMAP Password", | |
| 476 desc=D_("Password for IMAP authentication"), | |
| 477 value=credentials.get("imap_password"), | |
| 478 required=True, | |
| 479 ) | |
| 480 ) | |
| 481 | |
| 482 # Add fields for SMTP credentials | |
| 483 form.addField( | |
| 484 data_form.Field( | |
| 485 fieldType="text-single", | |
| 486 var="smtp_host", | |
| 487 label="SMTP Host", | |
| 488 desc=D_("SMTP server hostname or IP address"), | |
| 489 value=credentials.get("smtp_host"), | |
| 490 required=True, | |
| 491 ) | |
| 492 ) | |
| 493 form.addField( | |
| 494 data_form.Field( | |
| 495 fieldType="text-single", | |
| 496 var="smtp_port", | |
| 497 label="SMTP Port", | |
| 498 desc=D_("SMTP server port (default: 587)"), | |
| 499 value=credentials.get("smtp_port", "587"), | |
| 500 ) | |
| 501 ) | |
| 502 form.addField( | |
| 503 data_form.Field( | |
| 504 fieldType="text-single", | |
| 505 var="smtp_username", | |
| 506 label="SMTP Username", | |
| 507 desc=D_("Username for SMTP authentication"), | |
| 508 value=credentials.get("smtp_username"), | |
| 509 required=True, | |
| 510 ) | |
| 511 ) | |
| 512 form.addField( | |
| 513 data_form.Field( | |
| 514 fieldType="text-private", | |
| 515 var="smtp_password", | |
| 516 label="SMTP Password", | |
| 517 desc=D_("Password for SMTP authentication"), | |
| 518 value=credentials.get("smtp_password"), | |
| 519 required=True, | |
| 520 ) | |
| 521 ) | |
| 522 | |
| 523 return bool(credentials), form | |
| 524 | |
| 525 def validate_field( | |
| 526 self, | |
| 527 form: data_form.Form, | |
| 528 key: str, | |
| 529 field_type: str, | |
| 530 min_value: int | None = None, | |
| 531 max_value: int | None = None, | |
| 532 default: str | int | None = None, | |
| 533 ) -> None: | |
| 534 """Validate a single field. | |
| 535 | |
| 536 @param form: The form containing the fields. | |
| 537 @param key: The key of the field to validate. | |
| 538 @param field_type: The expected type of the field value. | |
| 539 @param min_value: Optional minimum value for integer fields. | |
| 540 @param max_value: Optional maximum value for integer fields. | |
| 541 @param default: Default value to use if the field is missing. | |
| 542 @raise StanzaError: If the field value is invalid or missing. | |
| 543 """ | |
| 544 field = form.fields.get(key) | |
| 545 if field is None: | |
| 546 if default is None: | |
| 547 raise StanzaError("bad-request", text=f"{key} is required") | |
| 548 field = data_form.Field(var=key, value=str(default)) | |
| 549 form.addField(field) | |
| 550 | |
| 551 value = field.value | |
| 552 if field_type == "int": | |
| 553 try: | |
| 554 value = int(value) | |
| 555 if (min_value is not None and value < min_value) or ( | |
| 556 max_value is not None and value > max_value | |
| 557 ): | |
| 558 raise ValueError | |
| 559 except (ValueError, TypeError): | |
| 560 raise StanzaError("bad-request", text=f"Invalid value for {key}: {value}") | |
| 561 elif field_type == "str": | |
| 562 if not isinstance(value, str): | |
| 563 raise StanzaError("bad-request", text=f"Invalid value for {key}: {value}") | |
| 564 | |
| 565 # Basic email validation for user_email field | |
| 566 if key == "user_email": | |
| 567 # XXX: This is a minimal check. A complete email validation is notoriously | |
| 568 # difficult. | |
| 569 if not email_pattern.match(value): | |
| 570 raise StanzaError( | |
| 571 "bad-request", text=f"Invalid email address: {value}" | |
| 572 ) | |
| 573 | |
| 574 def validate_imap_smtp_form(self, submit_form: data_form.Form) -> None: | |
| 575 """Validate the submitted IMAP/SMTP credentials form. | |
| 576 | |
| 577 @param submit_form: The submitted form containing IMAP/SMTP credentials. | |
| 578 @raise StanzaError: If any of the values are invalid. | |
| 579 """ | |
| 580 # Validate identity fields | |
| 581 self.validate_field(submit_form, "user_name", "str") | |
| 582 self.validate_field(submit_form, "user_email", "str") | |
| 583 | |
| 584 # Validate IMAP fields | |
| 585 self.validate_field(submit_form, "imap_host", "str") | |
| 586 self.validate_field( | |
| 587 submit_form, "imap_port", "int", min_value=1, max_value=65535, default=993 | |
| 588 ) | |
| 589 self.validate_field(submit_form, "imap_username", "str") | |
| 590 self.validate_field(submit_form, "imap_password", "str") | |
| 591 | |
| 592 # Validate SMTP fields | |
| 593 self.validate_field(submit_form, "smtp_host", "str") | |
| 594 self.validate_field( | |
| 595 submit_form, "smtp_port", "int", min_value=1, max_value=65535, default=587 | |
| 596 ) | |
| 597 self.validate_field(submit_form, "smtp_username", "str") | |
| 598 self.validate_field(submit_form, "smtp_password", "str") | |
| 599 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
600 def email_to_jid( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
601 self, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
602 client: SatXMPPEntity, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
603 user_email: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
604 user_jid: jid.JID, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
605 email_name: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
606 email_addr: str, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
607 ) -> tuple[jid.JID, str | None]: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
608 """Convert an email address to a JID and extract the name if present. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
609 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
610 @param client: Client session. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
611 @param user_email: Email address of the gateway user. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
612 @param user_jid: JID of the gateway user. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
613 @param email_name: Email associated name. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
614 @param email_addr: Email address. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
615 @return: Tuple of JID and name (if present). |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
616 """ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
617 email_name = email_name.strip() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
618 if email_name.startswith("xmpp:"): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
619 return jid.JID(email_name[5:]), None |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
620 elif email_addr == user_email: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
621 return (user_jid, None) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
622 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
623 return ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
624 jid.JID(None, (self._e.escape(email_addr), client.jid.host, None)), |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
625 email_name or None, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
626 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
627 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
628 async def on_new_email( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
629 self, user_data: UserData, user_jid: jid.JID, email: EmailMessage |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
630 ) -> None: |
| 4303 | 631 """Called when a new message has been received. |
| 632 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
633 @param user_data: user data, used to map registered user email to corresponding |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
634 jid. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
635 @param user_jid: JID of the recipient. |
| 4303 | 636 @param email: Parsed email. |
| 637 """ | |
| 638 assert self.client is not None | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
639 user_email = user_data.credentials["user_email"] |
| 4303 | 640 name, email_addr = parseaddr(email["from"]) |
| 641 email_addr = email_addr.lower() | |
| 642 from_jid = jid.JID(None, (self._e.escape(email_addr), self.client.jid.host, None)) | |
| 643 | |
| 644 # Get the email body | |
| 645 body_mime = email.get_body(("plain",)) | |
| 646 if body_mime is not None: | |
| 647 charset = body_mime.get_content_charset() or "utf-8" | |
| 648 body = body_mime.get_payload(decode=True).decode(charset, errors="replace") | |
| 649 else: | |
| 650 log.warning(f"No body found in email:\n{email}") | |
| 651 body = "" | |
| 652 | |
| 653 # Decode the subject | |
| 654 subject = email.get("subject") | |
| 655 if subject: | |
| 656 decoded_subject = decode_header(subject) | |
| 657 subject = "".join( | |
| 658 [ | |
| 659 part.decode(encoding or "utf-8") if isinstance(part, bytes) else part | |
| 660 for part, encoding in decoded_subject | |
| 661 ] | |
| 662 ).strip() | |
| 663 else: | |
| 664 subject = None | |
| 665 | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
666 # Parse recipient fields |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
667 kwargs = {} |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
668 for field in RECIPIENT_FIELDS: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
669 email_addresses = email.get_all(field) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
670 if email_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
671 jids_and_names = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
672 self.email_to_jid(self.client, user_email, user_jid, name, addr) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
673 for name, addr in getaddresses(email_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
674 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
675 kwargs[field] = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
676 AddressType(jid=jid, desc=name) for jid, name in jids_and_names |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
677 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
678 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
679 # At least "to" header should be set, so kwargs should never be empty |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
680 assert kwargs |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
681 addresses_data = AddressesData(**kwargs) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
682 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
683 # Parse reply-to field |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
684 reply_to_addresses = email.get_all("reply-to") |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
685 if reply_to_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
686 jids_with_names = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
687 self.email_to_jid(self.client, user_email, user_jid, name, addr) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
688 for name, addr in getaddresses(reply_to_addresses) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
689 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
690 addresses_data.replyto = [ |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
691 AddressType(jid=jid, desc=name) for jid, name in jids_with_names |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
692 ] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
693 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
694 # Set noreply flag |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
695 # The is no flag to indicate a no-reply message, so we check common user parts in |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
696 # from and reply-to headers. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
697 from_addresses = [email_addr] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
698 if reply_to_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
699 from_addresses.extend( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
700 addr for a in reply_to_addresses if (addr := parseaddr(a)[1]) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
701 ) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
702 for from_address in from_addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
703 from_user_part = from_address.split("@", 1)[0].lower() |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
704 if from_user_part in ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
705 "no-reply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
706 "noreply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
707 "do-not-reply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
708 "donotreply", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
709 "notification", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
710 "notifications", |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
711 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
712 addresses_data.noreply = True |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
713 break |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
714 extra = {} |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
715 |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
716 if ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
717 not addresses_data.replyto |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
718 and not addresses_data.noreply |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
719 and not addresses_data.cc |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
720 and not addresses_data.bcc |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
721 and addresses_data.to == [AddressType(jid=user_jid)] |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
722 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
723 # The main recipient is the only one, and there is no other metadata: there is |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
724 # no need to add addresses metadata. |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
725 pass |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
726 else: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
727 for address in addresses_data.addresses: |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
728 if address.jid and ( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
729 address.jid == user_jid or address.jid.host == str(self.client.jid) |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
730 ): |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
731 # Those are email address, and have been delivered by the sender, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
732 # other JID addresses will have to be delivered by us. |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
733 address.delivered = True |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
734 |
|
4317
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
735 extra["addresses"] = addresses_data.model_dump(mode="json", exclude_none=True) |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
736 |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
737 # We look for interesting headers |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
738 headers = {} |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
739 keywords_headers = email.get_all("keywords") |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
740 if keywords_headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
741 keywords = ",".join(keywords_headers) |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
742 headers["keywords"] = keywords |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
743 |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
744 importance = email["importance"] |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
745 if importance: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
746 # We convert to urgency |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
747 if importance in ("low", "high"): |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
748 headers["urgency"] = importance |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
749 elif importance == "normal": |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
750 headers["urgency"] = "medium" |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
751 else: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
752 log.warning("Ignoring invalid importance header: {importance!r}") |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
753 |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
754 if headers: |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
755 extra["headers"] = HeadersData(**headers).model_dump( |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
756 mode="json", exclude_none=True |
|
055930cc81f9
component email gateway: Add support for XEP-0131 headers:
Goffi <goffi@goffi.org>
parents:
4309
diff
changeset
|
757 ) |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
758 |
| 4303 | 759 client = self.client.get_virtual_client(from_jid) |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
760 await client.sendMessage( |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
761 user_jid, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
762 {"": body}, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
763 {"": subject} if subject else None, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
764 extra=extra, |
|
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
765 ) |
| 4303 | 766 |
| 767 async def connect_imap(self, from_jid: jid.JID, user_data: UserData) -> None: | |
| 768 """Connect to IMAP service. | |
| 769 | |
| 770 [self.on_new_email] will be used as callback on new messages. | |
| 771 | |
| 772 @param from_jid: JID of the user associated with given credentials. | |
| 773 @param credentials: Email credentials. | |
| 774 """ | |
| 775 credentials = user_data.credentials | |
| 776 | |
| 777 connected = defer.Deferred() | |
| 778 factory = IMAPClientFactory( | |
| 779 user_data, | |
|
4309
b56b1eae7994
component email gateway: add multicasting:
Goffi <goffi@goffi.org>
parents:
4303
diff
changeset
|
780 partial(self.on_new_email, user_data, from_jid.userhostJID()), |
| 4303 | 781 connected, |
| 782 ) | |
| 783 reactor.connectTCP( | |
| 784 credentials["imap_host"], int(credentials["imap_port"]), factory | |
| 785 ) | |
| 786 await connected | |
| 787 | |
| 788 async def _on_registration_submit( | |
| 789 self, | |
| 790 client: SatXMPPEntity, | |
| 791 iq_elt: domish.Element, | |
| 792 submit_form: data_form.Form | None, | |
| 793 ) -> bool | None: | |
| 794 """Handle registration submit request. | |
| 795 | |
| 796 Submit form is validated, and credentials are stored. | |
| 797 @param client: client session. | |
| 798 iq_elt: IQ stanza of the submission request. | |
| 799 submit_form: submit form. | |
| 800 @return: True if successful. | |
| 801 None if the callback is not relevant for this request. | |
| 802 """ | |
| 803 if client != self.client: | |
| 804 return | |
| 805 assert self.storage is not None | |
| 806 from_jid = jid.JID(iq_elt["from"]).userhostJID() | |
| 807 | |
| 808 if submit_form is None: | |
| 809 # This is an unregistration request. | |
| 810 try: | |
| 811 user_data = self.users_data[from_jid] | |
| 812 except KeyError: | |
| 813 pass | |
| 814 else: | |
| 815 if user_data.imap_client is not None: | |
| 816 try: | |
| 817 await user_data.imap_client.logout() | |
| 818 except Exception: | |
| 819 log.exception(f"Can't log out {from_jid} from IMAP server.") | |
| 820 key = KEY_CREDENTIALS.format(from_jid=from_jid) | |
| 821 await self.storage.adel(key) | |
| 822 log.info(f"{from_jid} unregistered from this gateway.") | |
| 823 return True | |
| 824 | |
| 825 self.validate_imap_smtp_form(submit_form) | |
| 826 credentials = {key: field.value for key, field in submit_form.fields.items()} | |
| 827 user_data = self.users_data.get(from_jid) | |
| 828 if user_data is None: | |
| 829 # The user is not in cache, we cache current credentials. | |
| 830 user_data = self.users_data[from_jid] = UserData(credentials=credentials) | |
| 831 else: | |
| 832 # The user is known, we update credentials. | |
| 833 user_data.credentials = credentials | |
| 834 key = KEY_CREDENTIALS.format(from_jid=from_jid) | |
| 835 try: | |
| 836 await self.connect_imap(from_jid, user_data) | |
| 837 except Exception as e: | |
| 838 log.warning(f"Can't connect to IMAP server for {from_jid}") | |
| 839 credentials["imap_success"] = False | |
| 840 await self.storage.aset(key, credentials) | |
| 841 raise e | |
| 842 else: | |
| 843 log.debug(f"Connection successful to IMAP server for {from_jid}") | |
| 844 credentials["imap_success"] = True | |
| 845 await self.storage.aset(key, credentials) | |
| 846 return True | |
| 847 | |
| 848 | |
| 849 @implementer(iwokkel.IDisco) | |
| 850 class EmailGatewayHandler(XMPPHandler): | |
| 851 | |
| 852 def getDiscoInfo(self, requestor, target, nodeIdentifier=""): | |
| 853 return [] | |
| 854 | |
| 855 def getDiscoItems(self, requestor, target, nodeIdentifier=""): | |
| 856 return [] |