portal.py 81 KB

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