portal.py 77 KB

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