portal.py 84 KB

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