portal.py 69 KB

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