portal.py 76 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939
  1. # mautrix-instagram - A Matrix-Instagram puppeting bridge.
  2. # Copyright (C) 2022 Tulir Asokan
  3. #
  4. # This program is free software: you can redistribute it and/or modify
  5. # it under the terms of the GNU Affero General Public License as published by
  6. # the Free Software Foundation, either version 3 of the License, or
  7. # (at your option) any later version.
  8. #
  9. # This program is distributed in the hope that it will be useful,
  10. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. # GNU Affero General Public License for more details.
  13. #
  14. # You should have received a copy of the GNU Affero General Public License
  15. # along with this program. If not, see <https://www.gnu.org/licenses/>.
  16. from __future__ import annotations
  17. from typing import TYPE_CHECKING, Any, AsyncGenerator, Awaitable, Callable, Union, cast
  18. from collections import deque
  19. from io import BytesIO
  20. import asyncio
  21. import json
  22. import mimetypes
  23. import re
  24. import sqlite3
  25. import time
  26. import asyncpg
  27. import magic
  28. from mauigpapi.types import (
  29. AnimatedMediaItem,
  30. CommandResponse,
  31. ExpiredMediaItem,
  32. MediaShareItem,
  33. MediaType,
  34. MessageSyncMessage,
  35. Reaction,
  36. ReactionStatus,
  37. ReelMediaShareItem,
  38. ReelShareType,
  39. RegularMediaItem,
  40. Thread,
  41. ThreadItem,
  42. ThreadItemType,
  43. ThreadUser,
  44. ThreadUserLastSeenAt,
  45. TypingStatus,
  46. VoiceMediaItem,
  47. )
  48. from mautrix.appservice import AppService, IntentAPI
  49. from mautrix.bridge import BasePortal, NotificationDisabler, async_getter_lock
  50. from mautrix.errors import MatrixError, MForbidden, MNotFound, SessionNotFound
  51. from mautrix.types import (
  52. AudioInfo,
  53. BeeperMessageStatusEventContent,
  54. ContentURI,
  55. EventID,
  56. EventType,
  57. Format,
  58. ImageInfo,
  59. LocationMessageEventContent,
  60. MediaMessageEventContent,
  61. MessageEventContent,
  62. MessageStatus,
  63. MessageStatusReason,
  64. MessageType,
  65. RelatesTo,
  66. RelationType,
  67. RoomID,
  68. TextMessageEventContent,
  69. UserID,
  70. VideoInfo,
  71. )
  72. from mautrix.util import ffmpeg
  73. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  74. from mautrix.util.simple_lock import SimpleLock
  75. from . import matrix as m, puppet as p, user as u
  76. from .config import Config
  77. from .db import Message as DBMessage, Portal as DBPortal, Reaction as DBReaction
  78. if TYPE_CHECKING:
  79. from .__main__ import InstagramBridge
  80. try:
  81. from mautrix.crypto.attachments import decrypt_attachment, encrypt_attachment
  82. except ImportError:
  83. encrypt_attachment = decrypt_attachment = None
  84. try:
  85. from PIL import Image
  86. except ImportError:
  87. Image = None
  88. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  89. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  90. MediaData = Union[
  91. AnimatedMediaItem,
  92. ExpiredMediaItem,
  93. MediaShareItem,
  94. ReelMediaShareItem,
  95. RegularMediaItem,
  96. VoiceMediaItem,
  97. ]
  98. MediaUploadFunc = Callable[["u.User", MediaData, IntentAPI], Awaitable[MediaMessageEventContent]]
  99. # This doesn't need to capture all valid URLs, it's enough to catch most of them.
  100. # False negatives simply mean the link won't be linkified on Instagram,
  101. # but false positives will cause the message to fail to send.
  102. SIMPLE_URL_REGEX = re.compile(
  103. r"(?P<url>https?://[\da-z.-]+\.[a-z]{2,}(?:/[^\s]*)?)", flags=re.IGNORECASE
  104. )
  105. class UnsupportedAttachmentError(NotImplementedError):
  106. pass
  107. class Portal(DBPortal, BasePortal):
  108. by_mxid: dict[RoomID, Portal] = {}
  109. by_thread_id: dict[tuple[str, int], Portal] = {}
  110. config: Config
  111. matrix: m.MatrixHandler
  112. az: AppService
  113. private_chat_portal_meta: bool
  114. _main_intent: IntentAPI | None
  115. _create_room_lock: asyncio.Lock
  116. backfill_lock: SimpleLock
  117. _msgid_dedup: deque[str]
  118. _reqid_dedup: set[str]
  119. _reaction_dedup: deque[tuple[str, int, str]]
  120. _last_participant_update: set[int]
  121. _reaction_lock: asyncio.Lock
  122. _backfill_leave: set[IntentAPI] | None
  123. _typing: set[UserID]
  124. def __init__(
  125. self,
  126. thread_id: str,
  127. receiver: int,
  128. other_user_pk: int | None,
  129. mxid: RoomID | None = None,
  130. name: str | None = None,
  131. avatar_url: ContentURI | None = None,
  132. encrypted: bool = False,
  133. name_set: bool = False,
  134. avatar_set: bool = False,
  135. relay_user_id: UserID | None = None,
  136. ) -> None:
  137. super().__init__(
  138. thread_id,
  139. receiver,
  140. other_user_pk,
  141. mxid,
  142. name,
  143. avatar_url,
  144. encrypted,
  145. name_set,
  146. avatar_set,
  147. relay_user_id,
  148. )
  149. self._create_room_lock = asyncio.Lock()
  150. self.log = self.log.getChild(thread_id)
  151. self._msgid_dedup = deque(maxlen=100)
  152. self._reaction_dedup = deque(maxlen=100)
  153. self._reqid_dedup = set()
  154. self._last_participant_update = set()
  155. self.backfill_lock = SimpleLock(
  156. "Waiting for backfilling to finish before handling %s", log=self.log
  157. )
  158. self._backfill_leave = None
  159. self._main_intent = None
  160. self._reaction_lock = asyncio.Lock()
  161. self._typing = set()
  162. self._relay_user = None
  163. @property
  164. def is_direct(self) -> bool:
  165. return self.other_user_pk is not None
  166. @property
  167. def main_intent(self) -> IntentAPI:
  168. if not self._main_intent:
  169. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  170. return self._main_intent
  171. @classmethod
  172. def init_cls(cls, bridge: "InstagramBridge") -> None:
  173. cls.config = bridge.config
  174. cls.matrix = bridge.matrix
  175. cls.az = bridge.az
  176. cls.loop = bridge.loop
  177. cls.bridge = bridge
  178. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  179. NotificationDisabler.puppet_cls = p.Puppet
  180. NotificationDisabler.config_enabled = cls.config["bridge.backfill.disable_notifications"]
  181. # region Misc
  182. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  183. if event_id and self.config["bridge.delivery_receipts"]:
  184. try:
  185. await self.az.intent.mark_read(self.mxid, event_id)
  186. except Exception:
  187. self.log.exception("Failed to send delivery receipt for %s", event_id)
  188. async def _send_bridge_success(
  189. self,
  190. sender: u.User,
  191. event_id: EventID,
  192. event_type: EventType,
  193. msgtype: MessageType | None = None,
  194. ) -> None:
  195. sender.send_remote_checkpoint(
  196. status=MessageSendCheckpointStatus.SUCCESS,
  197. event_id=event_id,
  198. room_id=self.mxid,
  199. event_type=event_type,
  200. message_type=msgtype,
  201. )
  202. asyncio.create_task(self._send_message_status(event_id, err=None))
  203. await self._send_delivery_receipt(event_id)
  204. async def _send_bridge_error(
  205. self,
  206. sender: u.User,
  207. err: Exception,
  208. event_id: EventID,
  209. event_type: EventType,
  210. message_type: MessageType | None = None,
  211. confirmed: bool = False,
  212. ) -> None:
  213. sender.send_remote_checkpoint(
  214. self._status_from_exception(err),
  215. event_id,
  216. self.mxid,
  217. event_type,
  218. message_type=message_type,
  219. error=err,
  220. )
  221. if self.config["bridge.delivery_error_reports"]:
  222. event_type_str = {
  223. EventType.REACTION: "reaction",
  224. EventType.ROOM_REDACTION: "redaction",
  225. }.get(event_type, "message")
  226. error_type = "was not" if confirmed else "may not have been"
  227. await self._send_message(
  228. self.main_intent,
  229. TextMessageEventContent(
  230. msgtype=MessageType.NOTICE,
  231. body=f"\u26a0 Your {event_type_str} {error_type} bridged: {str(err)}",
  232. ),
  233. )
  234. asyncio.create_task(self._send_message_status(event_id, err))
  235. async def _send_message_status(self, event_id: EventID, err: Exception | None) -> None:
  236. if not self.config["bridge.message_status_events"]:
  237. return
  238. intent = self.az.intent if self.encrypted else self.main_intent
  239. status = BeeperMessageStatusEventContent(
  240. network=self.bridge_info_state_key,
  241. relates_to=RelatesTo(
  242. rel_type=RelationType.REFERENCE,
  243. event_id=event_id,
  244. ),
  245. )
  246. if err:
  247. status.error = str(err)
  248. if isinstance(err, NotImplementedError):
  249. if isinstance(err, UnsupportedAttachmentError):
  250. status.message = str(err)
  251. status.reason = MessageStatusReason.UNSUPPORTED
  252. status.status = MessageStatus.FAIL
  253. else:
  254. status.reason = MessageStatusReason.GENERIC_ERROR
  255. status.status = MessageStatus.RETRIABLE
  256. else:
  257. status.status = MessageStatus.SUCCESS
  258. status.fill_legacy_booleans()
  259. await intent.send_message_event(
  260. room_id=self.mxid,
  261. event_type=EventType.BEEPER_MESSAGE_STATUS,
  262. content=status,
  263. )
  264. async def _upsert_reaction(
  265. self,
  266. existing: DBReaction | None,
  267. intent: IntentAPI,
  268. mxid: EventID,
  269. message: DBMessage,
  270. sender: u.User | p.Puppet,
  271. reaction: str,
  272. mx_timestamp: int,
  273. ) -> None:
  274. if existing:
  275. self.log.debug(
  276. f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  277. f" (message: {message.mxid})"
  278. )
  279. await intent.redact(existing.mx_room, existing.mxid)
  280. await existing.edit(
  281. reaction=reaction, mxid=mxid, mx_room=message.mx_room, mx_timestamp=mx_timestamp
  282. )
  283. else:
  284. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  285. await DBReaction(
  286. mxid=mxid,
  287. mx_room=message.mx_room,
  288. ig_item_id=message.item_id,
  289. ig_receiver=self.receiver,
  290. ig_sender=sender.igpk,
  291. reaction=reaction,
  292. mx_timestamp=mx_timestamp,
  293. ).insert()
  294. # endregion
  295. # region Matrix event handling
  296. @staticmethod
  297. def _status_from_exception(e: Exception) -> MessageSendCheckpointStatus:
  298. if isinstance(e, NotImplementedError):
  299. return MessageSendCheckpointStatus.UNSUPPORTED
  300. return MessageSendCheckpointStatus.PERM_FAILURE
  301. async def handle_matrix_message(
  302. self, sender: u.User, message: MessageEventContent, event_id: EventID
  303. ) -> None:
  304. try:
  305. await self._handle_matrix_message(sender, message, event_id)
  306. except Exception as e:
  307. self.log.exception(f"Error handling Matrix event {event_id}")
  308. await self._send_bridge_error(
  309. sender,
  310. e,
  311. event_id,
  312. EventType.ROOM_MESSAGE,
  313. message_type=message.msgtype,
  314. confirmed=True,
  315. )
  316. else:
  317. await self._send_bridge_success(
  318. sender, event_id, EventType.ROOM_MESSAGE, message.msgtype
  319. )
  320. async def _handle_matrix_giphy(
  321. self,
  322. sender: u.User,
  323. event_id: EventID,
  324. request_id: str,
  325. giphy_id: str,
  326. ) -> CommandResponse:
  327. self.log.trace(f"Broadcasting giphy from {event_id} with request ID {request_id}")
  328. return await sender.client.broadcast(
  329. self.thread_id,
  330. ThreadItemType.ANIMATED_MEDIA,
  331. client_context=request_id,
  332. id=giphy_id,
  333. )
  334. async def _handle_matrix_image(
  335. self,
  336. sender: u.User,
  337. event_id: EventID,
  338. request_id: str,
  339. data: bytes,
  340. mime_type: str,
  341. width: int | None = None,
  342. height: int | None = None,
  343. ) -> CommandResponse:
  344. if mime_type != "image/jpeg":
  345. if Image is None:
  346. raise UnsupportedAttachmentError(
  347. "Instagram does not allow non-JPEG images, and Pillow is not installed, "
  348. "so the bridge couldn't convert the image automatically"
  349. )
  350. with BytesIO(data) as inp, BytesIO() as out:
  351. img = Image.open(inp)
  352. img.convert("RGB").save(out, format="JPEG", quality=80)
  353. data = out.getvalue()
  354. mime_type = "image/jpeg"
  355. self.log.trace(f"Uploading photo from {event_id} (mime: {mime_type})")
  356. upload_resp = await sender.client.upload_photo(
  357. data, mime=mime_type, width=width, height=height
  358. )
  359. self.log.trace(f"Broadcasting uploaded photo with request ID {request_id}")
  360. return await sender.client.broadcast(
  361. self.thread_id,
  362. ThreadItemType.CONFIGURE_PHOTO,
  363. client_context=request_id,
  364. upload_id=upload_resp.upload_id,
  365. allow_full_aspect_ratio="true",
  366. )
  367. async def _handle_matrix_video(
  368. self,
  369. sender: u.User,
  370. event_id: EventID,
  371. request_id: str,
  372. data: bytes,
  373. mime_type: str,
  374. duration: int | None = None,
  375. width: int | None = None,
  376. height: int | None = None,
  377. ) -> CommandResponse:
  378. if mime_type != "video/mp4":
  379. data = await ffmpeg.convert_bytes(
  380. data,
  381. output_extension=".mp4",
  382. output_args=("-c:v", "libx264", "-c:a", "aac"),
  383. input_mime=mime_type,
  384. )
  385. self.log.trace(f"Uploading video from {event_id}")
  386. _, upload_id = await sender.client.upload_mp4(
  387. data, duration_ms=duration, width=width, height=height
  388. )
  389. self.log.trace(f"Broadcasting uploaded video with request ID {request_id}")
  390. return await sender.client.broadcast(
  391. self.thread_id,
  392. ThreadItemType.CONFIGURE_VIDEO,
  393. client_context=request_id,
  394. upload_id=upload_id,
  395. video_result="",
  396. )
  397. async def _handle_matrix_audio(
  398. self,
  399. sender: u.User,
  400. event_id: EventID,
  401. request_id: str,
  402. data: bytes,
  403. mime_type: str,
  404. waveform: list[int],
  405. duration: int | None = None,
  406. ) -> CommandResponse:
  407. if mime_type != "audio/mp4":
  408. data = await ffmpeg.convert_bytes(
  409. data, output_extension=".m4a", output_args=("-c:a", "aac"), input_mime=mime_type
  410. )
  411. self.log.trace(f"Uploading audio from {event_id}")
  412. _, upload_id = await sender.client.upload_mp4(data, audio=True, duration_ms=duration)
  413. self.log.trace(f"Broadcasting uploaded audio with request ID {request_id}")
  414. return await sender.client.broadcast(
  415. self.thread_id,
  416. ThreadItemType.SHARE_VOICE,
  417. client_context=request_id,
  418. upload_id=upload_id,
  419. waveform=json.dumps([(part or 0) / 1024 for part in waveform], separators=(",", ":")),
  420. waveform_sampling_frequency_hz="10",
  421. )
  422. async def _handle_matrix_message(
  423. self, orig_sender: u.User, message: MessageEventContent, event_id: EventID
  424. ) -> None:
  425. sender, is_relay = await self.get_relay_sender(orig_sender, f"message {event_id}")
  426. assert sender, "user is not logged in"
  427. assert sender.is_connected, "You're not connected to Instagram"
  428. if is_relay:
  429. await self.apply_relay_message_format(orig_sender, message)
  430. reply_to = {}
  431. if message.get_reply_to():
  432. msg = await DBMessage.get_by_mxid(message.get_reply_to(), self.mxid)
  433. if msg and msg.client_context:
  434. reply_to = {
  435. "replied_to_item_id": msg.item_id,
  436. "replied_to_client_context": msg.client_context,
  437. }
  438. request_id = sender.state.gen_client_context()
  439. self._reqid_dedup.add(request_id)
  440. self.log.debug(
  441. f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  442. f"with request ID {request_id}"
  443. )
  444. if message.msgtype == MessageType.NOTICE and not self.config["bridge.bridge_notices"]:
  445. return
  446. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT, MessageType.NOTICE):
  447. text = message.body
  448. if message.msgtype == MessageType.EMOTE:
  449. text = f"/me {text}"
  450. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  451. urls = SIMPLE_URL_REGEX.findall(text) or None
  452. if not self.is_direct:
  453. # Instagram groups don't seem to support sending link previews,
  454. # and the client_context-based deduplication breaks when trying to send them.
  455. urls = None
  456. resp = await sender.mqtt.send_text(
  457. self.thread_id, text=text, urls=urls, client_context=request_id, **reply_to
  458. )
  459. elif message.msgtype.is_media and "fi.mau.instagram.giphy_id" in message:
  460. resp = await self._handle_matrix_giphy(
  461. sender, event_id, request_id, message["fi.mau.instagram.giphy_id"]
  462. )
  463. elif message.msgtype.is_media:
  464. if message.file and decrypt_attachment:
  465. data = await self.main_intent.download_media(message.file.url)
  466. data = decrypt_attachment(
  467. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  468. )
  469. else:
  470. data = await self.main_intent.download_media(message.url)
  471. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  472. if message.msgtype == MessageType.IMAGE:
  473. resp = await self._handle_matrix_image(
  474. sender,
  475. event_id,
  476. request_id,
  477. data,
  478. mime_type,
  479. width=message.info.width,
  480. height=message.info.height,
  481. )
  482. elif message.msgtype == MessageType.AUDIO:
  483. waveform = message.get("org.matrix.msc1767.audio", {}).get("waveform", [0] * 30)
  484. resp = await self._handle_matrix_audio(
  485. sender,
  486. event_id,
  487. request_id,
  488. data,
  489. mime_type,
  490. waveform,
  491. duration=message.info.duration,
  492. )
  493. elif message.msgtype == MessageType.VIDEO:
  494. resp = await self._handle_matrix_video(
  495. sender,
  496. event_id,
  497. request_id,
  498. data,
  499. mime_type,
  500. duration=message.info.duration,
  501. width=message.info.width,
  502. height=message.info.height,
  503. )
  504. else:
  505. raise UnsupportedAttachmentError(
  506. "Non-image/video/audio files are currently not supported"
  507. )
  508. else:
  509. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  510. self.log.trace(f"Got response to message send {request_id}: {resp}")
  511. if resp.status != "ok":
  512. self.log.warning(f"Failed to handle {event_id}: {resp}")
  513. raise Exception(f"Failed to handle event. Error: {resp.payload.message}")
  514. else:
  515. self._msgid_dedup.appendleft(resp.payload.item_id)
  516. try:
  517. await DBMessage(
  518. mxid=event_id,
  519. mx_room=self.mxid,
  520. item_id=resp.payload.item_id,
  521. client_context=resp.payload.client_context,
  522. receiver=self.receiver,
  523. sender=sender.igpk,
  524. ig_timestamp=int(resp.payload.timestamp),
  525. ).insert()
  526. except (asyncpg.UniqueViolationError, sqlite3.IntegrityError) as e:
  527. self.log.warning(
  528. f"Error while persisting {event_id} ({resp.payload.client_context}) "
  529. f"-> {resp.payload.item_id}: {e}"
  530. )
  531. self._reqid_dedup.remove(request_id)
  532. self.log.debug(
  533. f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  534. f"-> {resp.payload.item_id}"
  535. )
  536. async def handle_matrix_reaction(
  537. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  538. ) -> None:
  539. try:
  540. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji, timestamp)
  541. except Exception as e:
  542. self.log.exception(f"Error handling Matrix reaction {event_id}")
  543. await self._send_bridge_error(
  544. sender,
  545. e,
  546. event_id,
  547. EventType.REACTION,
  548. confirmed=True,
  549. )
  550. else:
  551. await self._send_bridge_success(sender, event_id, EventType.REACTION)
  552. async def _handle_matrix_reaction(
  553. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  554. ) -> None:
  555. if not await sender.is_logged_in():
  556. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  557. raise NotImplementedError("User is not logged in")
  558. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  559. if not message or message.is_internal:
  560. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  561. await self.main_intent.redact(self.mxid, event_id, reason="Unknown target message")
  562. raise NotImplementedError("Unknown target message")
  563. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  564. if existing and existing.reaction == emoji:
  565. return
  566. dedup_id = (message.item_id, sender.igpk, emoji)
  567. self._reaction_dedup.appendleft(dedup_id)
  568. async with self._reaction_lock:
  569. resp = await sender.mqtt.send_reaction(
  570. self.thread_id, item_id=message.item_id, emoji=emoji
  571. )
  572. if resp.status != "ok":
  573. if resp.payload.message == "invalid unicode emoji":
  574. # Instagram doesn't support this reaction. Notify the user, and redact it
  575. # so that it doesn't get confusing.
  576. await self.main_intent.redact(self.mxid, event_id, reason="Unsupported emoji")
  577. raise NotImplementedError(f"Instagram does not support the {emoji} emoji.")
  578. raise Exception(f"Unknown response error: {resp}")
  579. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  580. await self._upsert_reaction(
  581. existing, self.main_intent, event_id, message, sender, emoji, timestamp
  582. )
  583. async def handle_matrix_redaction(
  584. self, orig_sender: u.User, event_id: EventID, redaction_event_id: EventID
  585. ) -> None:
  586. sender = None
  587. try:
  588. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  589. if not sender:
  590. raise Exception("User is not logged in")
  591. await self._handle_matrix_redaction(sender, event_id)
  592. except Exception as e:
  593. self.log.exception(f"Error handling Matrix redaction {event_id}")
  594. await self._send_bridge_error(
  595. sender or orig_sender,
  596. e,
  597. redaction_event_id,
  598. EventType.ROOM_REDACTION,
  599. confirmed=True,
  600. )
  601. else:
  602. await self._send_bridge_success(sender, redaction_event_id, EventType.ROOM_REDACTION)
  603. async def _handle_matrix_redaction(self, sender: u.User, event_id: EventID) -> None:
  604. if not sender.is_connected:
  605. raise Exception("You're not connected to Instagram")
  606. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  607. if reaction:
  608. try:
  609. await reaction.delete()
  610. await sender.mqtt.send_reaction(
  611. self.thread_id,
  612. item_id=reaction.ig_item_id,
  613. reaction_status=ReactionStatus.DELETED,
  614. emoji="",
  615. )
  616. except Exception as e:
  617. raise Exception(f"Removing reaction failed: {e}")
  618. else:
  619. self.log.trace(f"Removed reaction to {reaction.ig_item_id} after Matrix redaction")
  620. return
  621. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  622. if message and not message.is_internal:
  623. try:
  624. await message.delete()
  625. await sender.client.delete_item(self.thread_id, message.item_id)
  626. self.log.trace(f"Removed {message} after Matrix redaction")
  627. except Exception as e:
  628. raise Exception(f"Removing message failed: {e}")
  629. else:
  630. self.log.trace(f"Removed message {message.item_id} after Matrix redaction")
  631. return
  632. raise NotImplementedError("No message or reaction found for redaction")
  633. async def handle_matrix_typing(self, users: set[UserID]) -> None:
  634. if users == self._typing:
  635. return
  636. old_typing = self._typing
  637. self._typing = users
  638. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  639. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  640. async def _handle_matrix_typing(self, users: set[UserID], status: TypingStatus) -> None:
  641. for mxid in users:
  642. user = await u.User.get_by_mxid(mxid, create=False)
  643. if (
  644. not user
  645. or not await user.is_logged_in()
  646. or user.remote_typing_status == status
  647. or not user.is_connected
  648. ):
  649. continue
  650. user.remote_typing_status = None
  651. await user.mqtt.indicate_activity(self.thread_id, status)
  652. async def handle_matrix_leave(self, user: u.User) -> None:
  653. if not await user.is_logged_in():
  654. return
  655. if self.is_direct:
  656. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  657. if user.igpk == self.receiver:
  658. self.log.info(
  659. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  660. )
  661. await self.cleanup_and_delete()
  662. else:
  663. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  664. # TODO cleanup if empty
  665. # endregion
  666. # region Instagram event handling
  667. async def _reupload_instagram_media(
  668. self, source: u.User, media: RegularMediaItem, intent: IntentAPI
  669. ) -> MediaMessageEventContent:
  670. if media.media_type == MediaType.IMAGE:
  671. image = media.best_image
  672. if not image:
  673. raise ValueError("Attachment not available: didn't find photo URL")
  674. url = image.url
  675. msgtype = MessageType.IMAGE
  676. info = ImageInfo(height=image.height, width=image.width)
  677. elif media.media_type == MediaType.VIDEO:
  678. video = media.best_video
  679. if not video:
  680. raise ValueError("Attachment not available: didn't find video URL")
  681. url = video.url
  682. msgtype = MessageType.VIDEO
  683. info = VideoInfo(height=video.height, width=video.width)
  684. elif media.media_type == MediaType.CAROUSEL:
  685. raise ValueError(
  686. "Carousel media is not currently supported, "
  687. "please view the post on Instagram via the link below"
  688. )
  689. else:
  690. raise ValueError(
  691. f"Attachment not available: unsupported media type {media.media_type.human_name}"
  692. )
  693. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  694. async def _reupload_instagram_animated(
  695. self, source: u.User, media: AnimatedMediaItem, intent: IntentAPI
  696. ) -> MediaMessageEventContent:
  697. url = media.images.fixed_height.webp
  698. info = ImageInfo(
  699. height=int(media.images.fixed_height.height),
  700. width=int(media.images.fixed_height.width),
  701. )
  702. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  703. async def _reupload_instagram_voice(
  704. self, source: u.User, media: VoiceMediaItem, intent: IntentAPI
  705. ) -> MediaMessageEventContent:
  706. async def convert_to_ogg(data, mimetype):
  707. converted = await ffmpeg.convert_bytes(
  708. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=mimetype
  709. )
  710. return converted, "audio/ogg"
  711. url = media.media.audio.audio_src
  712. info = AudioInfo(duration=media.media.audio.duration)
  713. waveform = [int(p * 1024) for p in media.media.audio.waveform_data]
  714. content = await self._reupload_instagram_file(
  715. source, url, MessageType.AUDIO, info, intent, convert_to_ogg
  716. )
  717. content["org.matrix.msc1767.audio"] = {
  718. "duration": media.media.audio.duration,
  719. "waveform": waveform,
  720. }
  721. content["org.matrix.msc3245.voice"] = {}
  722. return content
  723. async def _reupload_instagram_file(
  724. self,
  725. source: u.User,
  726. url: str,
  727. msgtype: MessageType | None,
  728. info: ImageInfo | VideoInfo | AudioInfo,
  729. intent: IntentAPI,
  730. convert_fn: Callable[[bytes, str], Awaitable[tuple[bytes, str]]] | None = None,
  731. ) -> MediaMessageEventContent:
  732. async with source.client.raw_http_get(url) as resp:
  733. try:
  734. length = int(resp.headers["Content-Length"])
  735. except KeyError:
  736. # TODO can the download be short-circuited if there's too much data?
  737. self.log.warning(
  738. "Got file download response with no Content-Length header,"
  739. "reading data dangerously"
  740. )
  741. length = 0
  742. if length > self.matrix.media_config.upload_size:
  743. self.log.debug(
  744. f"{url} was too large ({length} > {self.matrix.media_config.upload_size})"
  745. )
  746. raise ValueError("Attachment not available: too large")
  747. data = await resp.read()
  748. info.mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  749. # Run the conversion function on the data.
  750. if convert_fn is not None:
  751. data, info.mimetype = await convert_fn(data, info.mimetype)
  752. info.size = len(data)
  753. extension = {
  754. "image/webp": ".webp",
  755. "image/jpeg": ".jpg",
  756. "video/mp4": ".mp4",
  757. "audio/mp4": ".m4a",
  758. "audio/ogg": ".ogg",
  759. }.get(info.mimetype)
  760. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  761. file_name = f"{msgtype.value[2:]}{extension}" if msgtype else None
  762. upload_mime_type = info.mimetype
  763. upload_file_name = file_name
  764. decryption_info = None
  765. if self.encrypted and encrypt_attachment:
  766. data, decryption_info = encrypt_attachment(data)
  767. upload_mime_type = "application/octet-stream"
  768. upload_file_name = None
  769. mxc = await intent.upload_media(
  770. data,
  771. mime_type=upload_mime_type,
  772. filename=upload_file_name,
  773. async_upload=self.config["homeserver.async_media"],
  774. )
  775. if decryption_info:
  776. decryption_info.url = mxc
  777. mxc = None
  778. return MediaMessageEventContent(
  779. body=file_name,
  780. external_url=url,
  781. url=mxc,
  782. file=decryption_info,
  783. info=info,
  784. msgtype=msgtype,
  785. )
  786. def _get_instagram_media_info(self, item: ThreadItem) -> tuple[MediaUploadFunc, MediaData]:
  787. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  788. method = self._reupload_instagram_media
  789. if item.media:
  790. media_data = item.media
  791. elif item.visual_media:
  792. media_data = item.visual_media.media
  793. elif item.animated_media:
  794. media_data = item.animated_media
  795. method = self._reupload_instagram_animated
  796. elif item.voice_media:
  797. media_data = item.voice_media
  798. method = self._reupload_instagram_voice
  799. elif item.reel_share:
  800. media_data = item.reel_share.media
  801. elif item.story_share:
  802. media_data = item.story_share.media
  803. elif item.clip:
  804. media_data = item.clip.clip
  805. elif item.felix_share and item.felix_share.video:
  806. media_data = item.felix_share.video
  807. elif item.media_share:
  808. media_data = item.media_share
  809. elif item.direct_media_share:
  810. media_data = item.direct_media_share.media
  811. else:
  812. self.log.debug(f"Unknown media type in {item}")
  813. raise ValueError("Attachment not available: unsupported media type")
  814. if not media_data:
  815. self.log.debug(f"Didn't get media_data in {item}")
  816. raise ValueError("Attachment not available: unsupported media type")
  817. elif isinstance(media_data, ExpiredMediaItem):
  818. self.log.debug(f"Expired media in item {item}")
  819. raise ValueError("Attachment not available: media expired")
  820. return method, media_data
  821. async def _convert_instagram_media(
  822. self, source: u.User, intent: IntentAPI, item: ThreadItem
  823. ) -> MessageEventContent:
  824. try:
  825. reupload_func, media_data = self._get_instagram_media_info(item)
  826. content = await reupload_func(source, media_data, intent)
  827. except ValueError as e:
  828. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  829. except Exception:
  830. self.log.warning("Failed to upload media", exc_info=True)
  831. content = TextMessageEventContent(
  832. body="Attachment not available: failed to copy file", msgtype=MessageType.NOTICE
  833. )
  834. await self._add_instagram_reply(content, item.replied_to_message)
  835. return content
  836. async def _handle_instagram_media_share(
  837. self, source: u.User, intent: IntentAPI, item: ThreadItem
  838. ) -> EventID | None:
  839. item_type_name = None
  840. if item.media_share:
  841. share_item = item.media_share
  842. elif item.clip:
  843. share_item = item.clip.clip
  844. item_type_name = "clip"
  845. elif item.felix_share and item.felix_share.video:
  846. share_item = item.felix_share.video
  847. elif item.story_share:
  848. share_item = item.story_share.media
  849. item_type_name = "story"
  850. elif item.direct_media_share:
  851. share_item = item.direct_media_share.media
  852. else:
  853. return None
  854. item_type_name = item_type_name or share_item.media_type.human_name
  855. user_text = f"@{share_item.user.username}"
  856. user_link = (
  857. f'<a href="https://www.instagram.com/{share_item.user.username}/">{user_text}</a>'
  858. )
  859. prefix = TextMessageEventContent(
  860. msgtype=MessageType.NOTICE,
  861. format=Format.HTML,
  862. body=f"Sent {user_text}'s {item_type_name}",
  863. formatted_body=f"Sent {user_link}'s {item_type_name}",
  864. )
  865. if item.direct_media_share and item.direct_media_share.media_share_type == "tag":
  866. tagged_user_id = item.direct_media_share.tagged_user_id
  867. if tagged_user_id == source.igpk and share_item.user.pk == self.other_user_pk:
  868. prefix.body = prefix.formatted_body = "Tagged you in their post"
  869. elif share_item.user.pk == source.igpk and tagged_user_id == self.other_user_pk:
  870. prefix.body = prefix.formatted_body = "Tagged them in your post"
  871. content = await self._convert_instagram_media(source, intent, item)
  872. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  873. if share_item.caption:
  874. caption_body = (
  875. f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  876. f"{external_url}"
  877. )
  878. caption_formatted_body = (
  879. f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  880. f" {share_item.caption.text}</blockquote>"
  881. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  882. )
  883. else:
  884. caption_body = external_url
  885. caption_formatted_body = (
  886. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  887. )
  888. caption = TextMessageEventContent(
  889. msgtype=MessageType.TEXT,
  890. body=caption_body,
  891. formatted_body=caption_formatted_body,
  892. format=Format.HTML,
  893. external_url=external_url,
  894. )
  895. if self.bridge.config["bridge.caption_in_message"]:
  896. if isinstance(content, TextMessageEventContent):
  897. content.ensure_has_html()
  898. prefix.ensure_has_html()
  899. caption.ensure_has_html()
  900. combined = TextMessageEventContent(
  901. msgtype=MessageType.TEXT,
  902. body="\n".join((content.body, prefix.body, caption.body)),
  903. formatted_body=(
  904. f"<p><b>{content.formatted_body}</b></p>"
  905. f"<p>{prefix.formatted_body}</p>"
  906. f"<p>{caption.formatted_body}</p>",
  907. ),
  908. format=Format.HTML,
  909. external_url=external_url,
  910. )
  911. else:
  912. prefix.ensure_has_html()
  913. caption.ensure_has_html()
  914. combined_body = "\n".join((prefix.body, caption.body))
  915. combined_formatted_body = (
  916. f"<p>{prefix.formatted_body}</p><p>{caption.formatted_body}</p>"
  917. )
  918. combined = content
  919. combined["filename"] = content.body
  920. combined.body = combined_body
  921. combined["format"] = str(Format.HTML)
  922. combined["org.matrix.msc1767.caption"] = {
  923. "org.matrix.msc1767.text": combined_body,
  924. "org.matrix.msc1767.html": combined_formatted_body,
  925. }
  926. combined["formatted_body"] = combined_formatted_body
  927. event_id = await self._send_message(intent, combined, timestamp=item.timestamp_ms)
  928. else:
  929. await self._send_message(intent, prefix, timestamp=item.timestamp_ms)
  930. event_id = await self._send_message(intent, content, timestamp=item.timestamp_ms)
  931. await self._send_message(intent, caption, timestamp=item.timestamp_ms)
  932. return event_id
  933. async def _handle_instagram_reel_share(
  934. self, source: u.User, intent: IntentAPI, item: ThreadItem
  935. ) -> EventID | None:
  936. assert item.reel_share
  937. media = item.reel_share.media
  938. prefix_html = None
  939. if item.reel_share.type == ReelShareType.REPLY:
  940. if item.reel_share.reel_owner_id == source.igpk:
  941. prefix = "Replied to your story"
  942. else:
  943. username = media.user.username
  944. prefix = f"Sent @{username}'s story"
  945. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  946. prefix_html = f"Sent {user_link}'s story"
  947. elif item.reel_share.type == ReelShareType.REACTION:
  948. if item.reel_share.reel_owner_id == source.igpk:
  949. prefix = "Reacted to your story"
  950. elif item.user_id == source.igpk:
  951. prefix = "You reacted to their story"
  952. else:
  953. prefix = "Reacted to a story"
  954. elif item.reel_share.type == ReelShareType.MENTION:
  955. if item.reel_share.mentioned_user_id == source.igpk:
  956. prefix = "Mentioned you in their story"
  957. else:
  958. prefix = "You mentioned them in your story"
  959. else:
  960. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  961. return None
  962. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  963. if prefix_html:
  964. prefix_content.format = Format.HTML
  965. prefix_content.formatted_body = prefix_html
  966. caption_content = TextMessageEventContent(
  967. msgtype=MessageType.TEXT, body=item.reel_share.text
  968. )
  969. if not caption_content.body and isinstance(media, MediaShareItem):
  970. caption_content.body = media.caption.text if media.caption else ""
  971. if not caption_content.body:
  972. caption_content.body = "<no caption>"
  973. media_content = None
  974. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  975. if isinstance(media, ExpiredMediaItem):
  976. media_content = TextMessageEventContent(
  977. msgtype=MessageType.NOTICE, body="Story expired"
  978. )
  979. else:
  980. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  981. if existing:
  982. # If the user already reacted or replied to the same reel share item,
  983. # use a Matrix reply instead of reposting the image.
  984. caption_content.set_reply(existing.mxid)
  985. else:
  986. media_content = await self._convert_instagram_media(source, intent, item)
  987. if self.bridge.config["bridge.caption_in_message"]:
  988. if media_content:
  989. if isinstance(media_content, TextMessageEventContent):
  990. media_content.ensure_has_html()
  991. prefix_content.ensure_has_html()
  992. caption_content.ensure_has_html()
  993. combined = TextMessageEventContent(
  994. msgtype=MessageType.TEXT,
  995. body="\n".join(
  996. (media_content.body, prefix_content.body, caption_content.body)
  997. ),
  998. formatted_body=(
  999. f"<p><b>{media_content.formatted_body}</b></p>"
  1000. f"<p>{prefix_content.formatted_body}</p>"
  1001. f"<p>{caption_content.formatted_body}</p>",
  1002. ),
  1003. format=Format.HTML,
  1004. )
  1005. else:
  1006. prefix_content.ensure_has_html()
  1007. caption_content.ensure_has_html()
  1008. combined_body = "\n".join((prefix_content.body, caption_content.body))
  1009. combined_formatted_body = (
  1010. f"<p>{prefix_content.formatted_body}</p>"
  1011. f"<p>{caption_content.formatted_body}</p>"
  1012. )
  1013. combined = media_content
  1014. combined["filename"] = combined.body
  1015. combined.body = combined_body
  1016. combined["format"] = str(Format.HTML)
  1017. combined["org.matrix.msc1767.caption"] = {
  1018. "org.matrix.msc1767.text": combined_body,
  1019. "org.matrix.msc1767.html": combined_formatted_body,
  1020. }
  1021. combined["formatted_body"] = combined_formatted_body
  1022. else:
  1023. combined = caption_content
  1024. event_id = await self._send_message(intent, combined, timestamp=item.timestamp_ms)
  1025. if media_content:
  1026. await DBMessage(
  1027. mxid=event_id,
  1028. mx_room=self.mxid,
  1029. item_id=fake_item_id,
  1030. client_context=None,
  1031. receiver=self.receiver,
  1032. sender=media.user.pk,
  1033. ig_timestamp=None,
  1034. ).insert()
  1035. else:
  1036. await self._send_message(intent, prefix_content, timestamp=item.timestamp_ms)
  1037. if media_content:
  1038. media_event_id = await self._send_message(
  1039. intent, media_content, timestamp=item.timestamp_ms
  1040. )
  1041. await DBMessage(
  1042. mxid=media_event_id,
  1043. mx_room=self.mxid,
  1044. item_id=fake_item_id,
  1045. client_context=None,
  1046. receiver=self.receiver,
  1047. sender=media.user.pk,
  1048. ig_timestamp=None,
  1049. ).insert()
  1050. event_id = await self._send_message(
  1051. intent, caption_content, timestamp=item.timestamp_ms
  1052. )
  1053. return event_id
  1054. async def _handle_instagram_link(
  1055. self,
  1056. source: u.User,
  1057. intent: IntentAPI,
  1058. item: ThreadItem,
  1059. ) -> EventID:
  1060. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.link.text)
  1061. link = item.link.link_context
  1062. preview = {
  1063. "og:url": link.link_url,
  1064. "og:title": link.link_title,
  1065. "og:description": link.link_summary,
  1066. }
  1067. if link.link_image_url:
  1068. reuploaded = await self._reupload_instagram_file(
  1069. source, link.link_image_url, msgtype=None, info=ImageInfo(), intent=intent
  1070. )
  1071. preview["og:image"] = reuploaded.url
  1072. preview["og:image:type"] = reuploaded.info.mimetype
  1073. preview["og:image:width"] = reuploaded.info.width
  1074. preview["og:image:height"] = reuploaded.info.height
  1075. preview["matrix:image:size"] = reuploaded.info.size
  1076. if reuploaded.file:
  1077. preview["beeper:image:encryption"] = reuploaded.file.serialize()
  1078. preview = {k: v for k, v in preview.items() if v}
  1079. content["com.beeper.linkpreviews"] = [preview] if "og:title" in preview else []
  1080. await self._add_instagram_reply(content, item.replied_to_message)
  1081. return await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1082. async def _handle_instagram_text(
  1083. self, intent: IntentAPI, item: ThreadItem, text: str
  1084. ) -> EventID:
  1085. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  1086. content["com.beeper.linkpreviews"] = []
  1087. await self._add_instagram_reply(content, item.replied_to_message)
  1088. return await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1089. async def _send_instagram_unhandled(self, intent: IntentAPI, item: ThreadItem) -> EventID:
  1090. content = TextMessageEventContent(
  1091. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  1092. )
  1093. await self._add_instagram_reply(content, item.replied_to_message)
  1094. return await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1095. async def _handle_instagram_location(
  1096. self, intent: IntentAPI, item: ThreadItem
  1097. ) -> EventID | None:
  1098. loc = item.location
  1099. if not loc.lng or not loc.lat:
  1100. # TODO handle somehow
  1101. return None
  1102. long_char = "E" if loc.lng > 0 else "W"
  1103. lat_char = "N" if loc.lat > 0 else "S"
  1104. body = (
  1105. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  1106. f"{round(abs(loc.lng), 4)}° {long_char}"
  1107. )
  1108. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  1109. external_url = None
  1110. if loc.external_source == "facebook_places":
  1111. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  1112. content = LocationMessageEventContent(
  1113. msgtype=MessageType.LOCATION,
  1114. geo_uri=f"geo:{loc.lat},{loc.lng}",
  1115. body=f"Location: {body}\n{url}",
  1116. external_url=external_url,
  1117. )
  1118. content["format"] = str(Format.HTML)
  1119. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  1120. await self._add_instagram_reply(content, item.replied_to_message)
  1121. return await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1122. async def _handle_instagram_profile(
  1123. self, intent: IntentAPI, item: ThreadItem
  1124. ) -> EventID | None:
  1125. username = item.profile.username
  1126. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1127. text = f"Shared @{username}'s profile"
  1128. html = f"Shared {user_link}'s profile"
  1129. content = TextMessageEventContent(
  1130. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1131. )
  1132. await self._add_instagram_reply(content, item.replied_to_message)
  1133. return await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1134. async def handle_instagram_item(
  1135. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  1136. ) -> None:
  1137. try:
  1138. await self._handle_instagram_item(source, sender, item, is_backfill)
  1139. except Exception:
  1140. self.log.exception("Fatal error handling Instagram item")
  1141. self.log.trace("Item content: %s", item.serialize())
  1142. async def _add_instagram_reply(
  1143. self, content: MessageEventContent, reply_to: ThreadItem | None
  1144. ) -> None:
  1145. if not reply_to:
  1146. return
  1147. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  1148. if not message:
  1149. return
  1150. content.set_reply(message.mxid)
  1151. if not isinstance(content, TextMessageEventContent):
  1152. return
  1153. try:
  1154. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  1155. except (MNotFound, MForbidden):
  1156. evt = None
  1157. if not evt:
  1158. return
  1159. if evt.type == EventType.ROOM_ENCRYPTED:
  1160. try:
  1161. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  1162. except SessionNotFound:
  1163. return
  1164. if isinstance(evt.content, TextMessageEventContent):
  1165. evt.content.trim_reply_fallback()
  1166. content.set_reply(evt)
  1167. async def _handle_instagram_item(
  1168. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  1169. ) -> None:
  1170. if not isinstance(item, ThreadItem):
  1171. # Parsing these items failed, they should have been logged already
  1172. return
  1173. client_context = item.client_context
  1174. link_client_context = item.link.client_context if item.link else None
  1175. cc = client_context
  1176. if link_client_context:
  1177. if not client_context:
  1178. cc = f"link:{link_client_context}"
  1179. elif client_context != link_client_context:
  1180. cc = f"{client_context}/link:{link_client_context}"
  1181. if client_context and client_context in self._reqid_dedup:
  1182. self.log.debug(
  1183. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1184. " as it was sent by us (client_context in dedup queue)"
  1185. )
  1186. return
  1187. elif link_client_context and link_client_context in self._reqid_dedup:
  1188. self.log.debug(
  1189. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1190. " as it was sent by us (link.client_context in dedup queue)"
  1191. )
  1192. return
  1193. if item.item_id in self._msgid_dedup:
  1194. self.log.debug(
  1195. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1196. " as it was already handled (message.id in dedup queue)"
  1197. )
  1198. return
  1199. self._msgid_dedup.appendleft(item.item_id)
  1200. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1201. self.log.debug(
  1202. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1203. " as it was already handled (message.id in database)"
  1204. )
  1205. return
  1206. self.log.debug(f"Starting handling of message {item.item_id} ({cc}) by {item.user_id}")
  1207. asyncio.create_task(sender.intent_for(self).set_typing(self.mxid, is_typing=False))
  1208. await self._handle_deduplicated_instagram_item(source, sender, item, is_backfill)
  1209. async def _handle_deduplicated_instagram_item(
  1210. self, source: u.User, sender: p.Puppet, item: ThreadItem, is_backfill: bool = False
  1211. ) -> None:
  1212. if self.backfill_lock.locked and sender.need_backfill_invite(self):
  1213. self.log.debug("Adding %s's default puppet to room for backfilling", sender.mxid)
  1214. if self.is_direct:
  1215. await self.main_intent.invite_user(self.mxid, sender.default_mxid)
  1216. intent = sender.default_mxid_intent
  1217. await intent.ensure_joined(self.mxid)
  1218. self._backfill_leave.add(intent)
  1219. else:
  1220. intent = sender.intent_for(self)
  1221. event_id = None
  1222. needs_handling = True
  1223. if item.media or item.animated_media or item.voice_media or item.visual_media:
  1224. content = await self._convert_instagram_media(source, intent, item)
  1225. event_id = await self._send_message(intent, content, timestamp=item.timestamp_ms)
  1226. elif item.location:
  1227. event_id = await self._handle_instagram_location(intent, item)
  1228. elif item.profile:
  1229. event_id = await self._handle_instagram_profile(intent, item)
  1230. elif item.reel_share:
  1231. event_id = await self._handle_instagram_reel_share(source, intent, item)
  1232. elif (
  1233. item.media_share
  1234. or item.direct_media_share
  1235. or item.story_share
  1236. or item.clip
  1237. or item.felix_share
  1238. ):
  1239. event_id = await self._handle_instagram_media_share(source, intent, item)
  1240. elif item.action_log:
  1241. # These probably don't need to be bridged
  1242. needs_handling = False
  1243. self.log.debug(f"Ignoring action log message {item.item_id}")
  1244. # TODO handle item.clip?
  1245. if item.text:
  1246. event_id = await self._handle_instagram_text(intent, item, item.text)
  1247. elif item.like:
  1248. # We handle likes as text because Matrix clients do big emoji on their own.
  1249. event_id = await self._handle_instagram_text(intent, item, item.like)
  1250. elif item.link:
  1251. event_id = await self._handle_instagram_link(source, intent, item)
  1252. handled = bool(event_id)
  1253. if not event_id and needs_handling:
  1254. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1255. event_id = await self._send_instagram_unhandled(intent, item)
  1256. cc = item.client_context
  1257. if not cc and item.link and item.link.client_context:
  1258. cc = item.link.client_context
  1259. msg = DBMessage(
  1260. mxid=event_id,
  1261. mx_room=self.mxid,
  1262. item_id=item.item_id,
  1263. client_context=cc,
  1264. receiver=self.receiver,
  1265. sender=sender.pk,
  1266. ig_timestamp=item.timestamp,
  1267. )
  1268. await msg.insert()
  1269. await self._send_delivery_receipt(event_id)
  1270. if handled:
  1271. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_id}")
  1272. elif needs_handling:
  1273. self.log.debug(
  1274. f"Unhandled Instagram message {item.item_id} "
  1275. f"(type {item.item_type} -> fallback error {event_id})"
  1276. )
  1277. if is_backfill and item.reactions:
  1278. await self._handle_instagram_reactions(msg, item.reactions.emojis, is_backfill=True)
  1279. async def handle_instagram_remove(self, item_id: str) -> None:
  1280. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1281. if message is None:
  1282. return
  1283. await message.delete()
  1284. if message.mxid:
  1285. sender = await p.Puppet.get_by_pk(message.sender)
  1286. try:
  1287. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1288. except MForbidden:
  1289. await self.main_intent.redact(self.mxid, message.mxid)
  1290. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1291. async def _handle_instagram_reactions(
  1292. self, message: DBMessage, reactions: list[Reaction], is_backfill: bool = False
  1293. ) -> None:
  1294. old_reactions: dict[int, DBReaction]
  1295. old_reactions = {
  1296. reaction.ig_sender: reaction
  1297. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1298. }
  1299. timestamp_deduplicator = 1
  1300. for new_reaction in reactions:
  1301. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1302. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1303. continue
  1304. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1305. intent = puppet.intent_for(self)
  1306. timestamp = new_reaction.timestamp_ms if is_backfill else int(time.time() * 1000)
  1307. if is_backfill:
  1308. timestamp += timestamp_deduplicator
  1309. timestamp_deduplicator += 1
  1310. reaction_event_id = await intent.react(
  1311. self.mxid, message.mxid, new_reaction.emoji, timestamp=timestamp
  1312. )
  1313. await self._upsert_reaction(
  1314. old_reaction,
  1315. intent,
  1316. reaction_event_id,
  1317. message,
  1318. puppet,
  1319. new_reaction.emoji,
  1320. timestamp,
  1321. )
  1322. for old_reaction in old_reactions.values():
  1323. await old_reaction.delete()
  1324. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1325. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1326. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1327. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1328. if not message:
  1329. return
  1330. if item.has_seen:
  1331. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1332. if puppet:
  1333. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1334. else:
  1335. async with self._reaction_lock:
  1336. await self._handle_instagram_reactions(
  1337. message, (item.reactions.emojis if item.reactions else [])
  1338. )
  1339. # endregion
  1340. # region Updating portal info
  1341. def _get_thread_name(self, thread: Thread) -> str:
  1342. if self.is_direct:
  1343. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1344. return "Instagram chat with yourself"
  1345. elif len(thread.users) == 1:
  1346. tpl = self.config["bridge.private_chat_name_template"]
  1347. ui = thread.users[0]
  1348. return tpl.format(displayname=ui.full_name, id=ui.pk, username=ui.username)
  1349. pass
  1350. elif thread.thread_title:
  1351. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1352. else:
  1353. return ""
  1354. async def update_info(self, thread: Thread, source: u.User) -> None:
  1355. changed = await self._update_name(self._get_thread_name(thread))
  1356. changed = await self._update_participants(thread.users, source) or changed
  1357. if changed:
  1358. await self.update_bridge_info()
  1359. await self.update()
  1360. # TODO update power levels with thread.admin_user_ids
  1361. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1362. if not self.is_direct:
  1363. return
  1364. if not puppet:
  1365. puppet = await self.get_dm_puppet()
  1366. await self._update_photo_from_puppet(puppet)
  1367. if self.name and not self.name_set:
  1368. await self._update_name(self.name)
  1369. async def _update_name(self, name: str) -> bool:
  1370. if name and (self.name != name or not self.name_set):
  1371. self.name = name
  1372. if self.mxid:
  1373. try:
  1374. await self.main_intent.set_room_name(self.mxid, name)
  1375. self.name_set = True
  1376. except Exception:
  1377. self.log.exception("Failed to update name")
  1378. self.name_set = False
  1379. return True
  1380. return False
  1381. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1382. if not self.private_chat_portal_meta and not self.encrypted:
  1383. return False
  1384. if self.avatar_set and self.avatar_url == puppet.photo_mxc:
  1385. return False
  1386. self.avatar_url = puppet.photo_mxc
  1387. if self.mxid:
  1388. try:
  1389. await self.main_intent.set_room_avatar(self.mxid, puppet.photo_mxc)
  1390. self.avatar_set = True
  1391. except Exception:
  1392. self.log.exception("Failed to set room avatar")
  1393. self.avatar_set = False
  1394. return True
  1395. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1396. meta_changed = False
  1397. # Make sure puppets who should be here are here
  1398. for user in users:
  1399. puppet = await p.Puppet.get_by_pk(user.pk)
  1400. await puppet.update_info(user, source)
  1401. if self.mxid:
  1402. await puppet.intent_for(self).ensure_joined(self.mxid)
  1403. if puppet.pk == self.other_user_pk:
  1404. meta_changed = await self._update_photo_from_puppet(puppet)
  1405. if self.mxid:
  1406. # Kick puppets who shouldn't be here
  1407. current_members = {int(user.pk) for user in users}
  1408. for user_id in await self.main_intent.get_room_members(self.mxid):
  1409. pk = p.Puppet.get_id_from_mxid(user_id)
  1410. if pk and pk not in current_members and pk != self.other_user_pk:
  1411. await self.main_intent.kick_user(
  1412. self.mxid,
  1413. p.Puppet.get_mxid_from_id(pk),
  1414. reason="User had left this Instagram DM",
  1415. )
  1416. return meta_changed
  1417. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1418. for user_id, receipt in receipts.items():
  1419. message: DBMessage | DBReaction
  1420. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1421. if not message:
  1422. reaction: DBReaction
  1423. message, reaction = await asyncio.gather(
  1424. DBMessage.get_closest(self.mxid, int(receipt.timestamp)),
  1425. DBReaction.get_closest(self.mxid, receipt.timestamp_ms),
  1426. )
  1427. if (not message or not message.mxid) and not reaction:
  1428. self.log.debug(
  1429. "Couldn't find message %s to mark as read by %s", receipt, user_id
  1430. )
  1431. continue
  1432. elif not message or (reaction and reaction.mx_timestamp > message.ig_timestamp_ms):
  1433. message = reaction
  1434. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1435. if not puppet:
  1436. continue
  1437. try:
  1438. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1439. except Exception:
  1440. self.log.warning(
  1441. f"Failed to mark {message.mxid} in {message.mx_room} "
  1442. f"as read by {puppet.intent.mxid}",
  1443. exc_info=True,
  1444. )
  1445. async def get_dm_puppet(self) -> p.Puppet | None:
  1446. if not self.is_direct:
  1447. return None
  1448. return await p.Puppet.get_by_pk(self.other_user_pk)
  1449. # endregion
  1450. # region Backfilling
  1451. async def backfill(self, source: u.User, thread: Thread, is_initial: bool = False) -> None:
  1452. limit = (
  1453. self.config["bridge.backfill.initial_limit"]
  1454. if is_initial
  1455. else self.config["bridge.backfill.missed_limit"]
  1456. )
  1457. if limit == 0:
  1458. return
  1459. elif limit < 0:
  1460. limit = None
  1461. with self.backfill_lock:
  1462. await self._backfill(source, thread, is_initial, limit)
  1463. async def _backfill(
  1464. self, source: u.User, thread: Thread, is_initial: bool, limit: int
  1465. ) -> None:
  1466. self.log.debug("Backfilling history through %s", source.mxid)
  1467. entries = await self._fetch_backfill_items(source, thread, is_initial, limit)
  1468. if not entries:
  1469. self.log.debug("Didn't get any items to backfill from server")
  1470. return
  1471. self.log.debug("Got %d entries from server", len(entries))
  1472. self._backfill_leave = set()
  1473. async with NotificationDisabler(self.mxid, source):
  1474. for entry in reversed(entries):
  1475. sender = await p.Puppet.get_by_pk(int(entry.user_id))
  1476. await self.handle_instagram_item(source, sender, entry, is_backfill=True)
  1477. for intent in self._backfill_leave:
  1478. self.log.trace("Leaving room with %s post-backfill", intent.mxid)
  1479. await intent.leave_room(self.mxid)
  1480. self._backfill_leave = None
  1481. self.log.info("Backfilled %d messages through %s", len(entries), source.mxid)
  1482. async def _fetch_backfill_items(
  1483. self, source: u.User, thread: Thread, is_initial: bool, limit: int
  1484. ) -> list[ThreadItem]:
  1485. items = []
  1486. excluded_count = 0
  1487. self.log.debug("Fetching up to %d messages through %s", limit, source.igpk)
  1488. async for item in source.client.iter_thread(self.thread_id, start_at=thread):
  1489. if len(items) - excluded_count >= limit:
  1490. self.log.debug(f"Fetched {len(items)} messages (the limit)")
  1491. break
  1492. elif not is_initial:
  1493. msg = await DBMessage.get_by_item_id(item.item_id, receiver=self.receiver)
  1494. if msg is not None:
  1495. self.log.debug(
  1496. f"Fetched {len(items)} messages and hit a message"
  1497. " that's already in the database."
  1498. )
  1499. break
  1500. elif not item.is_handleable:
  1501. self.log.debug(
  1502. f"Not counting {item.unhandleable_type} item {item.item_id}"
  1503. " against backfill limit"
  1504. )
  1505. excluded_count += 1
  1506. items.append(item)
  1507. return items
  1508. # endregion
  1509. # region Bridge info state event
  1510. @property
  1511. def bridge_info_state_key(self) -> str:
  1512. return f"net.maunium.instagram://instagram/{self.thread_id}"
  1513. @property
  1514. def bridge_info(self) -> dict[str, Any]:
  1515. return {
  1516. "bridgebot": self.az.bot_mxid,
  1517. "creator": self.main_intent.mxid,
  1518. "protocol": {
  1519. "id": "instagram",
  1520. "displayname": "Instagram DM",
  1521. "avatar_url": self.config["appservice.bot_avatar"],
  1522. },
  1523. "channel": {
  1524. "id": self.thread_id,
  1525. "displayname": self.name,
  1526. "avatar_url": self.avatar_url,
  1527. },
  1528. }
  1529. async def update_bridge_info(self) -> None:
  1530. if not self.mxid:
  1531. self.log.debug("Not updating bridge info: no Matrix room created")
  1532. return
  1533. try:
  1534. self.log.debug("Updating bridge info...")
  1535. await self.main_intent.send_state_event(
  1536. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  1537. )
  1538. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1539. await self.main_intent.send_state_event(
  1540. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  1541. )
  1542. except Exception:
  1543. self.log.warning("Failed to update bridge info", exc_info=True)
  1544. # endregion
  1545. # region Creating Matrix rooms
  1546. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1547. if self.mxid:
  1548. try:
  1549. await self.update_matrix_room(source, info)
  1550. except Exception:
  1551. self.log.exception("Failed to update portal")
  1552. return self.mxid
  1553. async with self._create_room_lock:
  1554. return await self._create_matrix_room(source, info)
  1555. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  1556. invite_content = {}
  1557. if double_puppet:
  1558. invite_content["fi.mau.will_auto_accept"] = True
  1559. if self.is_direct:
  1560. invite_content["is_direct"] = True
  1561. return invite_content
  1562. async def update_matrix_room(
  1563. self, source: u.User, info: Thread, backfill: bool = False
  1564. ) -> None:
  1565. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1566. await self.main_intent.invite_user(
  1567. self.mxid,
  1568. source.mxid,
  1569. check_cache=True,
  1570. extra_content=self._get_invite_content(puppet),
  1571. )
  1572. if puppet:
  1573. did_join = await puppet.intent.ensure_joined(self.mxid)
  1574. if did_join and self.is_direct:
  1575. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1576. await self.update_info(info, source)
  1577. if backfill:
  1578. last_msg = await DBMessage.get_by_item_id(
  1579. info.last_permanent_item.item_id, receiver=self.receiver
  1580. )
  1581. if last_msg is None:
  1582. self.log.debug(
  1583. f"Last permanent item ({info.last_permanent_item.item_id})"
  1584. " not found in database, starting backfilling"
  1585. )
  1586. await self.backfill(source, thread=info, is_initial=False)
  1587. await self._update_read_receipts(info.last_seen_at)
  1588. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  1589. if self.mxid:
  1590. await self.update_matrix_room(source, info)
  1591. return self.mxid
  1592. await self.update_info(info, source)
  1593. self.log.debug("Creating Matrix room")
  1594. name: str | None = None
  1595. initial_state = [
  1596. {
  1597. "type": str(StateBridge),
  1598. "state_key": self.bridge_info_state_key,
  1599. "content": self.bridge_info,
  1600. },
  1601. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  1602. {
  1603. "type": str(StateHalfShotBridge),
  1604. "state_key": self.bridge_info_state_key,
  1605. "content": self.bridge_info,
  1606. },
  1607. ]
  1608. invites = []
  1609. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  1610. self.encrypted = True
  1611. initial_state.append(
  1612. {
  1613. "type": "m.room.encryption",
  1614. "content": self.get_encryption_state_event_json(),
  1615. }
  1616. )
  1617. if self.is_direct:
  1618. invites.append(self.az.bot_mxid)
  1619. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  1620. name = self.name
  1621. # We lock backfill lock here so any messages that come between the room being created
  1622. # and the initial backfill finishing wouldn't be bridged before the backfill messages.
  1623. with self.backfill_lock:
  1624. creation_content = {}
  1625. if not self.config["bridge.federate_rooms"]:
  1626. creation_content["m.federate"] = False
  1627. self.mxid = await self.main_intent.create_room(
  1628. name=name,
  1629. is_direct=self.is_direct,
  1630. initial_state=initial_state,
  1631. invitees=invites,
  1632. creation_content=creation_content,
  1633. )
  1634. if not self.mxid:
  1635. raise Exception("Failed to create room: no mxid returned")
  1636. if self.encrypted and self.matrix.e2ee and self.is_direct:
  1637. try:
  1638. await self.az.intent.ensure_joined(self.mxid)
  1639. except Exception:
  1640. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  1641. await self.update()
  1642. self.log.debug(f"Matrix room created: {self.mxid}")
  1643. self.by_mxid[self.mxid] = self
  1644. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1645. await self.main_intent.invite_user(
  1646. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  1647. )
  1648. if puppet:
  1649. try:
  1650. if self.is_direct:
  1651. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1652. await puppet.intent.join_room_by_id(self.mxid)
  1653. except MatrixError:
  1654. self.log.debug(
  1655. "Failed to join custom puppet into newly created portal", exc_info=True
  1656. )
  1657. await self._update_participants(info.users, source)
  1658. try:
  1659. await self.backfill(source, thread=info, is_initial=True)
  1660. except Exception:
  1661. self.log.exception("Failed to backfill new portal")
  1662. await self._update_read_receipts(info.last_seen_at)
  1663. return self.mxid
  1664. # endregion
  1665. # region Database getters
  1666. async def postinit(self) -> None:
  1667. self.by_thread_id[(self.thread_id, self.receiver)] = self
  1668. if self.mxid:
  1669. self.by_mxid[self.mxid] = self
  1670. self._main_intent = (
  1671. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  1672. if self.other_user_pk
  1673. else self.az.intent
  1674. )
  1675. async def delete(self) -> None:
  1676. await DBMessage.delete_all(self.mxid)
  1677. self.by_mxid.pop(self.mxid, None)
  1678. self.mxid = None
  1679. self.encrypted = False
  1680. await self.update()
  1681. async def save(self) -> None:
  1682. await self.update()
  1683. @classmethod
  1684. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  1685. return cls._db_to_portals(super().all_with_room())
  1686. @classmethod
  1687. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  1688. return cls._db_to_portals(super().find_private_chats_with(other_user))
  1689. @classmethod
  1690. async def find_private_chat(cls, receiver: int, other_user: int) -> Portal | None:
  1691. thread_id = await super().find_private_chat_id(receiver, other_user)
  1692. if not thread_id:
  1693. return None
  1694. return await cls.get_by_thread_id(thread_id, receiver=receiver, is_group=False)
  1695. @classmethod
  1696. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  1697. portals = await query
  1698. for index, portal in enumerate(portals):
  1699. try:
  1700. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  1701. except KeyError:
  1702. await portal.postinit()
  1703. yield portal
  1704. @classmethod
  1705. @async_getter_lock
  1706. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  1707. try:
  1708. return cls.by_mxid[mxid]
  1709. except KeyError:
  1710. pass
  1711. portal = cast(cls, await super().get_by_mxid(mxid))
  1712. if portal is not None:
  1713. await portal.postinit()
  1714. return portal
  1715. return None
  1716. @classmethod
  1717. @async_getter_lock
  1718. async def get_by_thread_id(
  1719. cls,
  1720. thread_id: str,
  1721. *,
  1722. receiver: int,
  1723. is_group: bool | None = None,
  1724. other_user_pk: int | None = None,
  1725. ) -> Portal | None:
  1726. if is_group and receiver != 0:
  1727. receiver = 0
  1728. try:
  1729. return cls.by_thread_id[(thread_id, receiver)]
  1730. except KeyError:
  1731. pass
  1732. if is_group is None and receiver != 0:
  1733. try:
  1734. return cls.by_thread_id[(thread_id, 0)]
  1735. except KeyError:
  1736. pass
  1737. portal = cast(
  1738. cls,
  1739. await super().get_by_thread_id(
  1740. thread_id, receiver=receiver, rec_must_match=is_group is not None
  1741. ),
  1742. )
  1743. if portal is not None:
  1744. await portal.postinit()
  1745. return portal
  1746. if is_group is not None:
  1747. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  1748. await portal.insert()
  1749. await portal.postinit()
  1750. return portal
  1751. return None
  1752. @classmethod
  1753. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  1754. if thread.is_group:
  1755. receiver = 0
  1756. other_user_pk = None
  1757. else:
  1758. if len(thread.users) == 0:
  1759. other_user_pk = receiver
  1760. else:
  1761. other_user_pk = thread.users[0].pk
  1762. return await cls.get_by_thread_id(
  1763. thread.thread_id,
  1764. receiver=receiver,
  1765. is_group=thread.is_group,
  1766. other_user_pk=other_user_pk,
  1767. )
  1768. # endregion