portal.py 104 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626
  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, Optional, Union, cast
  18. from collections import deque
  19. from io import BytesIO
  20. import asyncio
  21. import base64
  22. import hashlib
  23. import html
  24. import json
  25. import mimetypes
  26. import re
  27. import sqlite3
  28. import time
  29. from yarl import URL
  30. import asyncpg
  31. import magic
  32. from mauigpapi.errors import IGRateLimitError
  33. from mauigpapi.types import (
  34. AnimatedMediaItem,
  35. CommandResponse,
  36. ExpiredMediaItem,
  37. MediaShareItem,
  38. MediaType,
  39. MessageSyncMessage,
  40. Reaction,
  41. ReactionStatus,
  42. ReelMediaShareItem,
  43. ReelShareType,
  44. RegularMediaItem,
  45. Thread,
  46. ThreadImageCandidate,
  47. ThreadItem,
  48. ThreadItemType,
  49. ThreadUser,
  50. ThreadUserLastSeenAt,
  51. TypingStatus,
  52. VoiceMediaItem,
  53. XMAMediaShareItem,
  54. )
  55. from mautrix.appservice import DOUBLE_PUPPET_SOURCE_KEY, IntentAPI
  56. from mautrix.bridge import BasePortal, async_getter_lock
  57. from mautrix.errors import MatrixError, MForbidden, MNotFound, SessionNotFound
  58. from mautrix.types import (
  59. AudioInfo,
  60. BatchID,
  61. BatchSendEvent,
  62. BatchSendStateEvent,
  63. BeeperMessageStatusEventContent,
  64. ContentURI,
  65. EventID,
  66. EventType,
  67. Format,
  68. ImageInfo,
  69. LocationMessageEventContent,
  70. MediaMessageEventContent,
  71. Membership,
  72. MemberStateEventContent,
  73. MessageEventContent,
  74. MessageStatus,
  75. MessageStatusReason,
  76. MessageType,
  77. ReactionEventContent,
  78. RelatesTo,
  79. RelationType,
  80. RoomID,
  81. TextMessageEventContent,
  82. UserID,
  83. VideoInfo,
  84. )
  85. from mautrix.util import ffmpeg
  86. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  87. from . import matrix as m, puppet as p, user as u
  88. from .config import Config
  89. from .db import Backfill, Message as DBMessage, Portal as DBPortal, Reaction as DBReaction
  90. if TYPE_CHECKING:
  91. from .__main__ import InstagramBridge
  92. try:
  93. from mautrix.crypto.attachments import decrypt_attachment, encrypt_attachment
  94. except ImportError:
  95. encrypt_attachment = decrypt_attachment = None
  96. try:
  97. from PIL import Image
  98. except ImportError:
  99. Image = None
  100. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  101. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  102. MediaData = Union[
  103. AnimatedMediaItem,
  104. ExpiredMediaItem,
  105. MediaShareItem,
  106. ReelMediaShareItem,
  107. RegularMediaItem,
  108. VoiceMediaItem,
  109. XMAMediaShareItem,
  110. ]
  111. MediaUploadFunc = Callable[["u.User", MediaData, IntentAPI], Awaitable[MediaMessageEventContent]]
  112. PortalCreateDummy = EventType.find("fi.mau.dummy.portal_created", EventType.Class.MESSAGE)
  113. HistorySyncMarkerMessage = EventType.find("org.matrix.msc2716.marker", EventType.Class.MESSAGE)
  114. ConvertedMessage = tuple[EventType, MessageEventContent]
  115. # This doesn't need to capture all valid URLs, it's enough to catch most of them.
  116. # False negatives simply mean the link won't be linkified on Instagram,
  117. # but false positives will cause the message to fail to send.
  118. SIMPLE_URL_REGEX = re.compile(
  119. r"(?P<url>https?://[\da-z.-]+\.[a-z]{2,}(?:/[^\s]*)?)", flags=re.IGNORECASE
  120. )
  121. class UnsupportedAttachmentError(NotImplementedError):
  122. pass
  123. class Portal(DBPortal, BasePortal):
  124. by_mxid: dict[RoomID, Portal] = {}
  125. by_thread_id: dict[tuple[str, int], Portal] = {}
  126. config: Config
  127. matrix: m.MatrixHandler
  128. private_chat_portal_meta: bool
  129. _main_intent: IntentAPI | None
  130. _create_room_lock: asyncio.Lock
  131. _msgid_dedup: deque[str]
  132. _reqid_dedup: set[str]
  133. _last_participant_update: set[int]
  134. _reaction_lock: asyncio.Lock
  135. _typing: set[UserID]
  136. def __init__(
  137. self,
  138. thread_id: str,
  139. receiver: int,
  140. other_user_pk: int | None,
  141. mxid: RoomID | None = None,
  142. name: str | None = None,
  143. avatar_url: ContentURI | None = None,
  144. encrypted: bool = False,
  145. name_set: bool = False,
  146. avatar_set: bool = False,
  147. relay_user_id: UserID | None = None,
  148. first_event_id: EventID | None = None,
  149. next_batch_id: BatchID | None = None,
  150. historical_base_insertion_event_id: EventID | None = None,
  151. cursor: str | None = None,
  152. thread_image_id: int | None = None,
  153. ) -> None:
  154. super().__init__(
  155. thread_id,
  156. receiver,
  157. other_user_pk,
  158. mxid,
  159. name,
  160. avatar_url,
  161. encrypted,
  162. name_set,
  163. avatar_set,
  164. relay_user_id,
  165. first_event_id,
  166. next_batch_id,
  167. historical_base_insertion_event_id,
  168. cursor,
  169. thread_image_id,
  170. )
  171. self._create_room_lock = asyncio.Lock()
  172. self.log = self.log.getChild(thread_id)
  173. self._msgid_dedup = deque(maxlen=100)
  174. self._reqid_dedup = set()
  175. self._last_participant_update = set()
  176. self._main_intent = None
  177. self._reaction_lock = asyncio.Lock()
  178. self._typing = set()
  179. self._relay_user = None
  180. @property
  181. def is_direct(self) -> bool:
  182. return self.other_user_pk is not None
  183. @property
  184. def main_intent(self) -> IntentAPI:
  185. if not self._main_intent:
  186. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  187. return self._main_intent
  188. @classmethod
  189. def init_cls(cls, bridge: "InstagramBridge") -> None:
  190. BasePortal.bridge = bridge
  191. cls.config = bridge.config
  192. cls.matrix = bridge.matrix
  193. cls.az = bridge.az
  194. cls.loop = bridge.loop
  195. cls.bridge = bridge
  196. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  197. # region Misc
  198. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  199. if event_id and self.config["bridge.delivery_receipts"]:
  200. try:
  201. await self.az.intent.mark_read(self.mxid, event_id)
  202. except Exception:
  203. self.log.exception("Failed to send delivery receipt for %s", event_id)
  204. async def _send_bridge_success(
  205. self,
  206. sender: u.User,
  207. event_id: EventID,
  208. event_type: EventType,
  209. msgtype: MessageType | None = None,
  210. ) -> None:
  211. sender.send_remote_checkpoint(
  212. status=MessageSendCheckpointStatus.SUCCESS,
  213. event_id=event_id,
  214. room_id=self.mxid,
  215. event_type=event_type,
  216. message_type=msgtype,
  217. )
  218. asyncio.create_task(self._send_message_status(event_id, err=None))
  219. await self._send_delivery_receipt(event_id)
  220. async def _send_bridge_error(
  221. self,
  222. sender: u.User,
  223. err: Exception,
  224. event_id: EventID,
  225. event_type: EventType,
  226. message_type: MessageType | None = None,
  227. confirmed: bool = False,
  228. ) -> None:
  229. sender.send_remote_checkpoint(
  230. self._status_from_exception(err),
  231. event_id,
  232. self.mxid,
  233. event_type,
  234. message_type=message_type,
  235. error=err,
  236. )
  237. if self.config["bridge.delivery_error_reports"]:
  238. event_type_str = {
  239. EventType.REACTION: "reaction",
  240. EventType.ROOM_REDACTION: "redaction",
  241. }.get(event_type, "message")
  242. error_type = "was not" if confirmed else "may not have been"
  243. await self._send_message(
  244. self.main_intent,
  245. TextMessageEventContent(
  246. msgtype=MessageType.NOTICE,
  247. body=f"\u26a0 Your {event_type_str} {error_type} bridged: {str(err)}",
  248. ),
  249. )
  250. asyncio.create_task(self._send_message_status(event_id, err))
  251. async def _send_message_status(self, event_id: EventID, err: Exception | None) -> None:
  252. if not self.config["bridge.message_status_events"]:
  253. return
  254. intent = self.az.intent if self.encrypted else self.main_intent
  255. status = BeeperMessageStatusEventContent(
  256. network=self.bridge_info_state_key,
  257. relates_to=RelatesTo(
  258. rel_type=RelationType.REFERENCE,
  259. event_id=event_id,
  260. ),
  261. )
  262. if err:
  263. status.error = str(err)
  264. if isinstance(err, NotImplementedError):
  265. if isinstance(err, UnsupportedAttachmentError):
  266. status.message = str(err)
  267. status.reason = MessageStatusReason.UNSUPPORTED
  268. status.status = MessageStatus.FAIL
  269. else:
  270. status.reason = MessageStatusReason.GENERIC_ERROR
  271. status.status = MessageStatus.RETRIABLE
  272. else:
  273. status.status = MessageStatus.SUCCESS
  274. await intent.send_message_event(
  275. room_id=self.mxid,
  276. event_type=EventType.BEEPER_MESSAGE_STATUS,
  277. content=status,
  278. )
  279. async def _upsert_reaction(
  280. self,
  281. existing: DBReaction | None,
  282. intent: IntentAPI,
  283. mxid: EventID,
  284. message: DBMessage,
  285. sender: u.User | p.Puppet,
  286. reaction: str,
  287. mx_timestamp: int,
  288. ) -> None:
  289. if existing:
  290. self.log.debug(
  291. f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  292. f" (message: {message.mxid})"
  293. )
  294. await intent.redact(existing.mx_room, existing.mxid)
  295. await existing.edit(
  296. reaction=reaction, mxid=mxid, mx_room=message.mx_room, mx_timestamp=mx_timestamp
  297. )
  298. else:
  299. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  300. await DBReaction(
  301. mxid=mxid,
  302. mx_room=message.mx_room,
  303. ig_item_id=message.item_id,
  304. ig_receiver=self.receiver,
  305. ig_sender=sender.igpk,
  306. reaction=reaction,
  307. mx_timestamp=mx_timestamp,
  308. ).insert()
  309. # endregion
  310. # region Matrix event handling
  311. @staticmethod
  312. def _status_from_exception(e: Exception) -> MessageSendCheckpointStatus:
  313. if isinstance(e, NotImplementedError):
  314. return MessageSendCheckpointStatus.UNSUPPORTED
  315. elif isinstance(e, asyncio.TimeoutError):
  316. return MessageSendCheckpointStatus.TIMEOUT
  317. return MessageSendCheckpointStatus.PERM_FAILURE
  318. async def handle_matrix_message(
  319. self, sender: u.User, message: MessageEventContent, event_id: EventID
  320. ) -> None:
  321. try:
  322. await self._handle_matrix_message(sender, message, event_id)
  323. except Exception as e:
  324. self.log.exception(f"Error handling Matrix event {event_id}")
  325. await self._send_bridge_error(
  326. sender,
  327. e,
  328. event_id,
  329. EventType.ROOM_MESSAGE,
  330. message_type=message.msgtype,
  331. confirmed=True,
  332. )
  333. else:
  334. await self._send_bridge_success(
  335. sender, event_id, EventType.ROOM_MESSAGE, message.msgtype
  336. )
  337. async def _handle_matrix_giphy(
  338. self,
  339. sender: u.User,
  340. event_id: EventID,
  341. request_id: str,
  342. giphy_id: str,
  343. ) -> CommandResponse:
  344. self.log.trace(f"Broadcasting giphy from {event_id} with request ID {request_id}")
  345. return await sender.client.broadcast(
  346. self.thread_id,
  347. ThreadItemType.ANIMATED_MEDIA,
  348. client_context=request_id,
  349. id=giphy_id,
  350. )
  351. async def _handle_matrix_image(
  352. self,
  353. sender: u.User,
  354. event_id: EventID,
  355. request_id: str,
  356. data: bytes,
  357. mime_type: str,
  358. width: int | None = None,
  359. height: int | None = None,
  360. ) -> CommandResponse:
  361. if mime_type != "image/jpeg":
  362. if Image is None:
  363. raise UnsupportedAttachmentError(
  364. "Instagram does not allow non-JPEG images, and Pillow is not installed, "
  365. "so the bridge couldn't convert the image automatically"
  366. )
  367. with BytesIO(data) as inp, BytesIO() as out:
  368. img = Image.open(inp)
  369. img.convert("RGB").save(out, format="JPEG", quality=80)
  370. data = out.getvalue()
  371. mime_type = "image/jpeg"
  372. self.log.trace(f"Uploading photo from {event_id} (mime: {mime_type})")
  373. upload_resp = await sender.client.upload_photo(
  374. data, mime=mime_type, width=width, height=height
  375. )
  376. self.log.trace(f"Broadcasting uploaded photo with request ID {request_id}")
  377. return await sender.client.broadcast(
  378. self.thread_id,
  379. ThreadItemType.CONFIGURE_PHOTO,
  380. client_context=request_id,
  381. upload_id=upload_resp.upload_id,
  382. allow_full_aspect_ratio="true",
  383. )
  384. async def _handle_matrix_video(
  385. self,
  386. sender: u.User,
  387. event_id: EventID,
  388. request_id: str,
  389. data: bytes,
  390. mime_type: str,
  391. duration: int | None = None,
  392. width: int | None = None,
  393. height: int | None = None,
  394. ) -> CommandResponse:
  395. if mime_type != "video/mp4":
  396. data = await ffmpeg.convert_bytes(
  397. data,
  398. output_extension=".mp4",
  399. output_args=("-c:v", "libx264", "-c:a", "aac"),
  400. input_mime=mime_type,
  401. )
  402. self.log.trace(f"Uploading video from {event_id}")
  403. _, upload_id = await sender.client.upload_mp4(
  404. data, duration_ms=duration, width=width, height=height
  405. )
  406. self.log.trace(f"Broadcasting uploaded video with request ID {request_id}")
  407. return await sender.client.broadcast(
  408. self.thread_id,
  409. ThreadItemType.CONFIGURE_VIDEO,
  410. client_context=request_id,
  411. upload_id=upload_id,
  412. video_result="",
  413. )
  414. async def _handle_matrix_audio(
  415. self,
  416. sender: u.User,
  417. event_id: EventID,
  418. request_id: str,
  419. data: bytes,
  420. mime_type: str,
  421. waveform: list[int],
  422. duration: int | None = None,
  423. ) -> CommandResponse:
  424. if mime_type != "audio/mp4":
  425. data = await ffmpeg.convert_bytes(
  426. data, output_extension=".m4a", output_args=("-c:a", "aac"), input_mime=mime_type
  427. )
  428. self.log.trace(f"Uploading audio from {event_id}")
  429. _, upload_id = await sender.client.upload_mp4(data, audio=True, duration_ms=duration)
  430. self.log.trace(f"Broadcasting uploaded audio with request ID {request_id}")
  431. return await sender.client.broadcast(
  432. self.thread_id,
  433. ThreadItemType.SHARE_VOICE,
  434. client_context=request_id,
  435. upload_id=upload_id,
  436. waveform=json.dumps([(part or 0) / 1024 for part in waveform], separators=(",", ":")),
  437. waveform_sampling_frequency_hz="10",
  438. )
  439. async def _handle_matrix_message(
  440. self, orig_sender: u.User, message: MessageEventContent, event_id: EventID
  441. ) -> None:
  442. sender, is_relay = await self.get_relay_sender(orig_sender, f"message {event_id}")
  443. assert sender, "user is not logged in"
  444. assert sender.is_connected, "You're not connected to Instagram"
  445. if is_relay:
  446. await self.apply_relay_message_format(orig_sender, message)
  447. reply_to = {}
  448. if message.get_reply_to():
  449. msg = await DBMessage.get_by_mxid(message.get_reply_to(), self.mxid)
  450. if msg and msg.client_context:
  451. reply_to = {
  452. "replied_to_item_id": msg.item_id,
  453. "replied_to_client_context": msg.client_context,
  454. }
  455. request_id = sender.state.gen_client_context()
  456. self._reqid_dedup.add(request_id)
  457. self.log.debug(
  458. f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  459. f"with request ID {request_id}"
  460. )
  461. if message.msgtype == MessageType.NOTICE and not self.config["bridge.bridge_notices"]:
  462. self.log.debug(f"Dropping m.notice event {event_id}")
  463. # TODO send checkpoint
  464. return
  465. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT, MessageType.NOTICE):
  466. text = message.body
  467. if message.msgtype == MessageType.EMOTE:
  468. text = f"/me {text}"
  469. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  470. urls = SIMPLE_URL_REGEX.findall(text) or None
  471. if not self.is_direct:
  472. # Instagram groups don't seem to support sending link previews,
  473. # and the client_context-based deduplication breaks when trying to send them.
  474. urls = None
  475. resp = await sender.mqtt.send_text(
  476. self.thread_id, text=text, urls=urls, client_context=request_id, **reply_to
  477. )
  478. elif message.msgtype.is_media and "fi.mau.instagram.giphy_id" in message:
  479. resp = await self._handle_matrix_giphy(
  480. sender, event_id, request_id, message["fi.mau.instagram.giphy_id"]
  481. )
  482. elif message.msgtype.is_media:
  483. if message.file and decrypt_attachment:
  484. data = await self.main_intent.download_media(message.file.url)
  485. data = decrypt_attachment(
  486. data, message.file.key.key, message.file.hashes.get("sha256"), message.file.iv
  487. )
  488. else:
  489. data = await self.main_intent.download_media(message.url)
  490. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  491. if message.msgtype == MessageType.IMAGE:
  492. resp = await self._handle_matrix_image(
  493. sender,
  494. event_id,
  495. request_id,
  496. data,
  497. mime_type,
  498. width=message.info.width,
  499. height=message.info.height,
  500. )
  501. elif message.msgtype == MessageType.AUDIO:
  502. waveform = message.get("org.matrix.msc1767.audio", {}).get("waveform", [0] * 30)
  503. resp = await self._handle_matrix_audio(
  504. sender,
  505. event_id,
  506. request_id,
  507. data,
  508. mime_type,
  509. waveform,
  510. duration=message.info.duration,
  511. )
  512. elif message.msgtype == MessageType.VIDEO:
  513. resp = await self._handle_matrix_video(
  514. sender,
  515. event_id,
  516. request_id,
  517. data,
  518. mime_type,
  519. duration=message.info.duration,
  520. width=message.info.width,
  521. height=message.info.height,
  522. )
  523. else:
  524. raise UnsupportedAttachmentError(
  525. "Non-image/video/audio files are currently not supported"
  526. )
  527. else:
  528. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  529. self.log.trace(f"Got response to message send {request_id}: {resp}")
  530. if resp.status != "ok" or not resp.payload:
  531. self.log.warning(f"Failed to handle {event_id}: {resp}")
  532. raise Exception(f"Sending message failed: {resp.error_message}")
  533. else:
  534. self._msgid_dedup.appendleft(resp.payload.item_id)
  535. try:
  536. await DBMessage(
  537. mxid=event_id,
  538. mx_room=self.mxid,
  539. item_id=resp.payload.item_id,
  540. client_context=resp.payload.client_context,
  541. receiver=self.receiver,
  542. sender=sender.igpk,
  543. ig_timestamp=int(resp.payload.timestamp),
  544. ).insert()
  545. except (asyncpg.UniqueViolationError, sqlite3.IntegrityError) as e:
  546. self.log.warning(
  547. f"Error while persisting {event_id} ({resp.payload.client_context}) "
  548. f"-> {resp.payload.item_id}: {e}"
  549. )
  550. self._reqid_dedup.remove(request_id)
  551. self.log.debug(
  552. f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  553. f"-> {resp.payload.item_id}"
  554. )
  555. async def handle_matrix_reaction(
  556. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  557. ) -> None:
  558. try:
  559. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji, timestamp)
  560. except Exception as e:
  561. self.log.exception(f"Error handling Matrix reaction {event_id}")
  562. await self._send_bridge_error(
  563. sender,
  564. e,
  565. event_id,
  566. EventType.REACTION,
  567. confirmed=True,
  568. )
  569. else:
  570. await self._send_bridge_success(sender, event_id, EventType.REACTION)
  571. async def _handle_matrix_reaction(
  572. self, sender: u.User, event_id: EventID, reacting_to: EventID, emoji: str, timestamp: int
  573. ) -> None:
  574. if not await sender.is_logged_in():
  575. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  576. raise NotImplementedError("User is not logged in")
  577. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  578. if not message or message.is_internal:
  579. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  580. await self.main_intent.redact(self.mxid, event_id, reason="Unknown target message")
  581. raise NotImplementedError("Unknown target message")
  582. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  583. if existing and existing.reaction == emoji:
  584. return
  585. async with self._reaction_lock:
  586. resp = await sender.mqtt.send_reaction(
  587. self.thread_id, item_id=message.item_id, emoji=emoji
  588. )
  589. if resp.status != "ok":
  590. if resp.payload and resp.payload.message == "invalid unicode emoji":
  591. # Instagram doesn't support this reaction. Notify the user, and redact it
  592. # so that it doesn't get confusing.
  593. await self.main_intent.redact(self.mxid, event_id, reason="Unsupported emoji")
  594. raise NotImplementedError(f"Instagram does not support the {emoji} emoji.")
  595. raise Exception(f"Unknown response error: {resp}")
  596. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  597. await self._upsert_reaction(
  598. existing, self.main_intent, event_id, message, sender, emoji, timestamp
  599. )
  600. async def handle_matrix_redaction(
  601. self, orig_sender: u.User, event_id: EventID, redaction_event_id: EventID
  602. ) -> None:
  603. sender = None
  604. try:
  605. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  606. if not sender:
  607. raise Exception("User is not logged in")
  608. await self._handle_matrix_redaction(sender, event_id)
  609. except Exception as e:
  610. self.log.exception(f"Error handling Matrix redaction {event_id}")
  611. await self._send_bridge_error(
  612. sender or orig_sender,
  613. e,
  614. redaction_event_id,
  615. EventType.ROOM_REDACTION,
  616. confirmed=True,
  617. )
  618. else:
  619. await self._send_bridge_success(sender, redaction_event_id, EventType.ROOM_REDACTION)
  620. async def _handle_matrix_redaction(self, sender: u.User, event_id: EventID) -> None:
  621. if not sender.is_connected:
  622. raise Exception("You're not connected to Instagram")
  623. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  624. if reaction:
  625. try:
  626. await reaction.delete()
  627. await sender.mqtt.send_reaction(
  628. self.thread_id,
  629. item_id=reaction.ig_item_id,
  630. reaction_status=ReactionStatus.DELETED,
  631. emoji="",
  632. )
  633. except Exception as e:
  634. raise Exception(f"Removing reaction failed: {e}")
  635. else:
  636. self.log.trace(f"Removed reaction to {reaction.ig_item_id} after Matrix redaction")
  637. return
  638. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  639. if message and not message.is_internal:
  640. try:
  641. await message.delete()
  642. await sender.client.delete_item(self.thread_id, message.item_id)
  643. self.log.trace(f"Removed {message} after Matrix redaction")
  644. except Exception as e:
  645. raise Exception(f"Removing message failed: {e}")
  646. else:
  647. self.log.trace(f"Removed message {message.item_id} after Matrix redaction")
  648. return
  649. raise NotImplementedError("No message or reaction found for redaction")
  650. async def handle_matrix_typing(self, users: set[UserID]) -> None:
  651. if users == self._typing:
  652. return
  653. old_typing = self._typing
  654. self._typing = users
  655. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  656. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  657. async def _handle_matrix_typing(self, users: set[UserID], status: TypingStatus) -> None:
  658. for mxid in users:
  659. user = await u.User.get_by_mxid(mxid, create=False)
  660. if (
  661. not user
  662. or not await user.is_logged_in()
  663. or user.remote_typing_status == status
  664. or not user.is_connected
  665. ):
  666. continue
  667. user.remote_typing_status = None
  668. await user.mqtt.indicate_activity(self.thread_id, status)
  669. async def handle_matrix_leave(self, user: u.User) -> None:
  670. if not await user.is_logged_in():
  671. return
  672. if self.is_direct:
  673. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  674. if user.igpk == self.receiver:
  675. self.log.info(
  676. f"{user.mxid} was the recipient of this portal. Cleaning up and deleting..."
  677. )
  678. await self.cleanup_and_delete()
  679. else:
  680. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  681. # TODO cleanup if empty
  682. # endregion
  683. # region Instagram event handling
  684. async def _reupload_instagram_media(
  685. self, source: u.User, media: RegularMediaItem, intent: IntentAPI
  686. ) -> MediaMessageEventContent:
  687. if media.media_type == MediaType.IMAGE:
  688. image = media.best_image
  689. if not image:
  690. raise ValueError("Attachment not available: didn't find photo URL")
  691. url = image.url
  692. msgtype = MessageType.IMAGE
  693. info = ImageInfo(height=image.height, width=image.width)
  694. elif media.media_type == MediaType.VIDEO:
  695. video = media.best_video
  696. if not video:
  697. raise ValueError("Attachment not available: didn't find video URL")
  698. url = video.url
  699. msgtype = MessageType.VIDEO
  700. info = VideoInfo(height=video.height, width=video.width)
  701. elif media.media_type == MediaType.CAROUSEL:
  702. raise ValueError(
  703. "Carousel media is not currently supported, "
  704. "please view the post on Instagram via the link below"
  705. )
  706. else:
  707. raise ValueError(
  708. f"Attachment not available: unsupported media type {media.media_type.human_name}"
  709. )
  710. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  711. async def _reupload_instagram_animated(
  712. self, source: u.User, media: AnimatedMediaItem, intent: IntentAPI
  713. ) -> MediaMessageEventContent:
  714. url = media.images.fixed_height.webp
  715. info = ImageInfo(
  716. height=int(media.images.fixed_height.height),
  717. width=int(media.images.fixed_height.width),
  718. )
  719. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  720. async def _reupload_instagram_xma(
  721. self, source: u.User, media: XMAMediaShareItem, intent: IntentAPI
  722. ) -> MediaMessageEventContent:
  723. url = media.preview_url
  724. info = ImageInfo(
  725. mimetype=media.preview_url_mime_type,
  726. )
  727. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  728. async def _reupload_instagram_voice(
  729. self, source: u.User, media: VoiceMediaItem, intent: IntentAPI
  730. ) -> MediaMessageEventContent:
  731. async def convert_to_ogg(data, mimetype):
  732. converted = await ffmpeg.convert_bytes(
  733. data, ".ogg", output_args=("-c:a", "libopus"), input_mime=mimetype
  734. )
  735. return converted, "audio/ogg"
  736. url = media.media.audio.audio_src
  737. info = AudioInfo(duration=media.media.audio.duration)
  738. waveform = [int(p * 1024) for p in media.media.audio.waveform_data]
  739. content = await self._reupload_instagram_file(
  740. source, url, MessageType.AUDIO, info, intent, convert_to_ogg
  741. )
  742. content["org.matrix.msc1767.audio"] = {
  743. "duration": media.media.audio.duration,
  744. "waveform": waveform,
  745. }
  746. content["org.matrix.msc3245.voice"] = {}
  747. return content
  748. async def _download_instagram_file(
  749. self, source: u.User, url: str
  750. ) -> tuple[Optional[bytes], str]:
  751. async with source.client.raw_http_get(url) as resp:
  752. try:
  753. length = int(resp.headers["Content-Length"])
  754. except KeyError:
  755. # TODO can the download be short-circuited if there's too much data?
  756. self.log.warning(
  757. "Got file download response with no Content-Length header,"
  758. "reading data dangerously"
  759. )
  760. length = 0
  761. if length > self.matrix.media_config.upload_size:
  762. self.log.debug(
  763. f"{url} was too large ({length} > {self.matrix.media_config.upload_size})"
  764. )
  765. raise ValueError("Attachment not available: too large")
  766. data = await resp.read()
  767. if not data:
  768. return None, ""
  769. mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  770. return data, mimetype
  771. async def _reupload_instagram_file(
  772. self,
  773. source: u.User,
  774. url: str,
  775. msgtype: MessageType | None,
  776. info: ImageInfo | VideoInfo | AudioInfo,
  777. intent: IntentAPI,
  778. convert_fn: Callable[[bytes, str], Awaitable[tuple[bytes, str]]] | None = None,
  779. allow_encrypt: bool = True,
  780. ) -> MediaMessageEventContent:
  781. data, mimetype = await self._download_instagram_file(source, url)
  782. assert data is not None
  783. info.mimetype = mimetype
  784. # Run the conversion function on the data.
  785. if convert_fn is not None:
  786. data, info.mimetype = await convert_fn(data, info.mimetype)
  787. if info.mimetype.startswith("image/") and not info.width and not info.height:
  788. with BytesIO(data) as inp, Image.open(inp) as img:
  789. info.width, info.height = img.size
  790. info.size = len(data)
  791. extension = {
  792. "image/webp": ".webp",
  793. "image/jpeg": ".jpg",
  794. "video/mp4": ".mp4",
  795. "audio/mp4": ".m4a",
  796. "audio/ogg": ".ogg",
  797. }.get(info.mimetype)
  798. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  799. file_name = f"{msgtype.value[2:]}{extension}" if msgtype else None
  800. upload_mime_type = info.mimetype
  801. upload_file_name = file_name
  802. decryption_info = None
  803. if allow_encrypt and self.encrypted and encrypt_attachment:
  804. data, decryption_info = encrypt_attachment(data)
  805. upload_mime_type = "application/octet-stream"
  806. upload_file_name = None
  807. mxc = await intent.upload_media(
  808. data,
  809. mime_type=upload_mime_type,
  810. filename=upload_file_name,
  811. async_upload=self.config["homeserver.async_media"],
  812. )
  813. if decryption_info:
  814. decryption_info.url = mxc
  815. mxc = None
  816. return MediaMessageEventContent(
  817. body=file_name,
  818. external_url=url,
  819. url=mxc,
  820. file=decryption_info,
  821. info=info,
  822. msgtype=msgtype,
  823. )
  824. def _get_instagram_media_info(self, item: ThreadItem) -> tuple[MediaUploadFunc, MediaData]:
  825. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  826. method = self._reupload_instagram_media
  827. if (
  828. item.xma_media_share
  829. or item.xma_story_share
  830. or item.xma_reel_share
  831. or item.xma_reel_mention
  832. or item.generic_xma
  833. ):
  834. media_data = (
  835. item.xma_media_share
  836. or item.xma_story_share
  837. or item.xma_reel_share
  838. or item.xma_reel_mention
  839. or item.generic_xma
  840. )[0]
  841. method = self._reupload_instagram_xma
  842. elif item.media:
  843. media_data = item.media
  844. elif item.visual_media:
  845. media_data = item.visual_media.media
  846. elif item.animated_media:
  847. media_data = item.animated_media
  848. method = self._reupload_instagram_animated
  849. elif item.voice_media:
  850. media_data = item.voice_media
  851. method = self._reupload_instagram_voice
  852. elif item.reel_share:
  853. media_data = item.reel_share.media
  854. elif item.story_share:
  855. media_data = item.story_share.media
  856. elif item.clip:
  857. media_data = item.clip.clip
  858. elif item.felix_share and item.felix_share.video:
  859. media_data = item.felix_share.video
  860. elif item.media_share:
  861. media_data = item.media_share
  862. elif item.direct_media_share:
  863. media_data = item.direct_media_share.media
  864. else:
  865. self.log.debug(f"Unknown media type in {item}")
  866. raise ValueError("Attachment not available: unsupported media type")
  867. if not media_data:
  868. self.log.debug(f"Didn't get media_data in {item}")
  869. raise ValueError("Attachment not available: unsupported media type")
  870. elif isinstance(media_data, ExpiredMediaItem):
  871. self.log.debug(f"Expired media in item {item}")
  872. raise ValueError("Attachment not available: media expired")
  873. return method, media_data
  874. async def _convert_instagram_media(
  875. self, source: u.User, intent: IntentAPI, item: ThreadItem
  876. ) -> ConvertedMessage:
  877. try:
  878. reupload_func, media_data = self._get_instagram_media_info(item)
  879. content = await reupload_func(source, media_data, intent)
  880. except ValueError as e:
  881. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  882. except Exception:
  883. self.log.warning("Failed to upload media", exc_info=True)
  884. content = TextMessageEventContent(
  885. body="Attachment not available: failed to copy file", msgtype=MessageType.NOTICE
  886. )
  887. await self._add_instagram_reply(content, item.replied_to_message)
  888. return EventType.ROOM_MESSAGE, content
  889. # TODO this might be unused
  890. async def _convert_instagram_media_share(
  891. self, source: u.User, intent: IntentAPI, item: ThreadItem
  892. ) -> list[ConvertedMessage]:
  893. item_type_name = None
  894. if item.media_share:
  895. share_item = item.media_share
  896. elif item.clip:
  897. share_item = item.clip.clip
  898. item_type_name = "clip"
  899. elif item.felix_share and item.felix_share.video:
  900. share_item = item.felix_share.video
  901. elif item.story_share:
  902. share_item = item.story_share.media
  903. item_type_name = "story"
  904. elif item.direct_media_share:
  905. share_item = item.direct_media_share.media
  906. else:
  907. self.log.debug("No media share to bridge")
  908. return []
  909. item_type_name = item_type_name or share_item.media_type.human_name
  910. user_text = f"@{share_item.user.username}"
  911. user_link = (
  912. f'<a href="https://www.instagram.com/{share_item.user.username}/">{user_text}</a>'
  913. )
  914. prefix = TextMessageEventContent(
  915. msgtype=MessageType.NOTICE,
  916. format=Format.HTML,
  917. body=f"Sent {user_text}'s {item_type_name}",
  918. formatted_body=f"Sent {user_link}'s {item_type_name}",
  919. )
  920. if item.direct_media_share and item.direct_media_share.media_share_type == "tag":
  921. tagged_user_id = item.direct_media_share.tagged_user_id
  922. if tagged_user_id == source.igpk and share_item.user.pk == self.other_user_pk:
  923. prefix.body = prefix.formatted_body = "Tagged you in their post"
  924. elif share_item.user.pk == source.igpk and tagged_user_id == self.other_user_pk:
  925. prefix.body = prefix.formatted_body = "Tagged them in your post"
  926. _, content = await self._convert_instagram_media(source, intent, item)
  927. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  928. if share_item.caption:
  929. caption_body = (
  930. f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  931. f"{external_url}"
  932. )
  933. caption_formatted_body = (
  934. f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  935. f" {html.escape(share_item.caption.text)}</blockquote>"
  936. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  937. )
  938. else:
  939. caption_body = external_url
  940. caption_formatted_body = (
  941. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>'
  942. )
  943. caption = TextMessageEventContent(
  944. msgtype=MessageType.TEXT,
  945. body=caption_body,
  946. formatted_body=caption_formatted_body,
  947. format=Format.HTML,
  948. external_url=external_url,
  949. )
  950. if self.bridge.config["bridge.caption_in_message"]:
  951. if isinstance(content, TextMessageEventContent):
  952. content.ensure_has_html()
  953. prefix.ensure_has_html()
  954. caption.ensure_has_html()
  955. combined = TextMessageEventContent(
  956. msgtype=MessageType.TEXT,
  957. body="\n".join((content.body, prefix.body, caption.body)),
  958. formatted_body=(
  959. f"<p><b>{content.formatted_body}</b></p>"
  960. f"<p><i>{prefix.formatted_body}</p>"
  961. f"<p>{caption.formatted_body}</p>"
  962. ),
  963. format=Format.HTML,
  964. external_url=external_url,
  965. )
  966. else:
  967. prefix.ensure_has_html()
  968. caption.ensure_has_html()
  969. combined_body = "\n".join((prefix.body, caption.body))
  970. combined_formatted_body = (
  971. f"<p><i>{prefix.formatted_body}</i></p><p>{caption.formatted_body}</p>"
  972. )
  973. combined = content
  974. combined["filename"] = content.body
  975. combined.body = combined_body
  976. combined["format"] = str(Format.HTML)
  977. combined["org.matrix.msc1767.caption"] = {
  978. "org.matrix.msc1767.text": combined_body,
  979. "org.matrix.msc1767.html": combined_formatted_body,
  980. }
  981. combined["formatted_body"] = combined_formatted_body
  982. return [(EventType.ROOM_MESSAGE, combined)]
  983. else:
  984. return [
  985. (EventType.ROOM_MESSAGE, prefix),
  986. (EventType.ROOM_MESSAGE, content),
  987. (EventType.ROOM_MESSAGE, caption),
  988. ]
  989. async def _convert_instagram_xma_media_share(
  990. self, source: u.User, intent: IntentAPI, item: ThreadItem
  991. ) -> list[ConvertedMessage]:
  992. # N.B. _get_instagram_media_info also only supports downloading the first xma item
  993. xma_list = (
  994. item.xma_media_share
  995. or item.xma_story_share
  996. or item.xma_reel_share
  997. or item.xma_reel_mention
  998. or item.generic_xma
  999. )
  1000. media = xma_list[0]
  1001. if len(xma_list) != 1:
  1002. self.log.warning(f"Item {item.item_id} has multiple xma media share parts")
  1003. if media.xma_layout_type not in (0, 4):
  1004. self.log.warning(f"Unrecognized xma layout type {media.xma_layout_type}")
  1005. if media.preview_url:
  1006. _, content = await self._convert_instagram_media(source, intent, item)
  1007. else:
  1008. content = None
  1009. # Post shares (layout type 0): media title text
  1010. # Reel shares/replies/reactions (layout type 4): item text
  1011. caption_text = media.title_text or item.text or ""
  1012. post_caption_text = None
  1013. if media.subtitle_text:
  1014. caption_text = (
  1015. f"{caption_text}\n{media.subtitle_text}" if caption_text else media.subtitle_text
  1016. )
  1017. header_text = media.header_title_text or ""
  1018. # Note replies have title_text for sender username, caption_body_text for the original note
  1019. # and item.text for the reply itself.
  1020. if not header_text and media.caption_body_text:
  1021. header_text = caption_text
  1022. caption_text = media.caption_body_text
  1023. post_caption_text = item.text
  1024. escaped_caption_text = html.escape(caption_text).replace("\n", "<br>")
  1025. escaped_header_text = html.escape(header_text)
  1026. # For post shares, the media title starts with the username, which is also the header.
  1027. # That part should be bolded.
  1028. if (
  1029. escaped_header_text
  1030. and escaped_caption_text
  1031. and escaped_caption_text.startswith(escaped_header_text)
  1032. ):
  1033. escaped_caption_text = (
  1034. f"<strong>{escaped_header_text}</strong>"
  1035. f"{escaped_caption_text[len(escaped_header_text):]}"
  1036. )
  1037. if item.message_item_type == "animated_media":
  1038. anim = await self._reupload_instagram_file(
  1039. source,
  1040. url=item.animated_media.images.fixed_height.webp,
  1041. msgtype=MessageType.IMAGE,
  1042. info=ImageInfo(
  1043. width=int(item.animated_media.images.fixed_height.width),
  1044. height=int(item.animated_media.images.fixed_height.height),
  1045. ),
  1046. intent=intent,
  1047. )
  1048. inline_img = (
  1049. f'<img src="{anim.url}" width={anim.info.width} height={anim.info.height}/>'
  1050. )
  1051. escaped_caption_text = (
  1052. f"{escaped_caption_text}<br/>{inline_img}" if escaped_caption_text else inline_img
  1053. )
  1054. caption_formatted_body = (
  1055. f"<blockquote>{escaped_caption_text}</blockquote>" if escaped_caption_text else ""
  1056. )
  1057. if media.target_url:
  1058. caption_body = (
  1059. f"> {caption_text}\n\n{media.target_url}" if caption_text else media.target_url
  1060. )
  1061. else:
  1062. caption_body = f"> {caption_text}"
  1063. if media.target_url:
  1064. target_url_pretty = str(URL(media.target_url).with_query(None)).replace(
  1065. "https://www.", ""
  1066. )
  1067. caption_formatted_body += (
  1068. f'<p><a href="{media.target_url}">{target_url_pretty}</a></p>'
  1069. )
  1070. if post_caption_text:
  1071. caption_formatted_body += f"<p>{html.escape(post_caption_text)}</p>"
  1072. caption_body += f"\n\n{post_caption_text}"
  1073. # Add auxiliary text as prefix for caption
  1074. if item.auxiliary_text:
  1075. caption_formatted_body = (
  1076. f"<p>{html.escape(item.auxiliary_text)}</p>{caption_formatted_body}"
  1077. )
  1078. caption_body = f"{item.auxiliary_text}\n\n{caption_body}"
  1079. caption = TextMessageEventContent(
  1080. msgtype=MessageType.TEXT,
  1081. body=caption_body,
  1082. formatted_body=caption_formatted_body,
  1083. format=Format.HTML,
  1084. )
  1085. if content and media.target_url:
  1086. content.external_url = media.target_url
  1087. caption.external_url = media.target_url
  1088. if content is None:
  1089. return [(EventType.ROOM_MESSAGE, caption)]
  1090. elif self.bridge.config["bridge.caption_in_message"]:
  1091. if isinstance(content, TextMessageEventContent):
  1092. content.ensure_has_html()
  1093. caption.ensure_has_html()
  1094. content.body += f"\n\n{caption.body}"
  1095. content.formatted_body = (
  1096. f"<p><b>{content.formatted_body}</b></p>{caption.formatted_body}"
  1097. )
  1098. else:
  1099. content["filename"] = content.body
  1100. content.body = caption.body
  1101. content["format"] = str(Format.HTML)
  1102. content["formatted_body"] = caption.formatted_body
  1103. content["org.matrix.msc1767.caption"] = {
  1104. "org.matrix.msc1767.text": content.body,
  1105. "org.matrix.msc1767.html": content["formatted_body"],
  1106. }
  1107. return [(EventType.ROOM_MESSAGE, content)]
  1108. else:
  1109. return [(EventType.ROOM_MESSAGE, content), (EventType.ROOM_MESSAGE, caption)]
  1110. # TODO this is probably unused
  1111. async def _convert_instagram_reel_share(
  1112. self, source: u.User, intent: IntentAPI, item: ThreadItem
  1113. ) -> list[ConvertedMessage]:
  1114. assert item.reel_share
  1115. media = item.reel_share.media
  1116. prefix_html = None
  1117. if item.reel_share.type == ReelShareType.REPLY:
  1118. if item.reel_share.reel_owner_id == source.igpk:
  1119. prefix = "Replied to your story"
  1120. else:
  1121. username = media.user.username
  1122. prefix = f"Sent @{username}'s story"
  1123. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1124. prefix_html = f"Sent {user_link}'s story"
  1125. elif item.reel_share.type == ReelShareType.REACTION:
  1126. if item.reel_share.reel_owner_id == source.igpk:
  1127. prefix = "Reacted to your story"
  1128. elif item.user_id == source.igpk:
  1129. prefix = "You reacted to their story"
  1130. else:
  1131. prefix = "Reacted to a story"
  1132. elif item.reel_share.type == ReelShareType.MENTION:
  1133. if item.reel_share.mentioned_user_id == source.igpk:
  1134. prefix = "Mentioned you in their story"
  1135. else:
  1136. prefix = "You mentioned them in your story"
  1137. else:
  1138. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  1139. return []
  1140. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  1141. if prefix_html:
  1142. prefix_content.format = Format.HTML
  1143. prefix_content.formatted_body = prefix_html
  1144. caption_content = TextMessageEventContent(
  1145. msgtype=MessageType.TEXT, body=item.reel_share.text
  1146. )
  1147. if not caption_content.body and isinstance(media, MediaShareItem):
  1148. caption_content.body = media.caption.text if media.caption else ""
  1149. if not caption_content.body:
  1150. caption_content.body = "<no caption>"
  1151. media_content = None
  1152. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  1153. if isinstance(media, ExpiredMediaItem):
  1154. media_content = TextMessageEventContent(
  1155. msgtype=MessageType.NOTICE, body="Story expired"
  1156. )
  1157. else:
  1158. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  1159. if existing:
  1160. # If the user already reacted or replied to the same reel share item,
  1161. # use a Matrix reply instead of reposting the image.
  1162. caption_content.set_reply(existing.mxid)
  1163. else:
  1164. _, media_content = await self._convert_instagram_media(source, intent, item)
  1165. if self.bridge.config["bridge.caption_in_message"]:
  1166. if media_content:
  1167. if isinstance(media_content, TextMessageEventContent):
  1168. media_content.ensure_has_html()
  1169. prefix_content.ensure_has_html()
  1170. caption_content.ensure_has_html()
  1171. combined = TextMessageEventContent(
  1172. msgtype=MessageType.TEXT,
  1173. body="\n".join(
  1174. (media_content.body, prefix_content.body, caption_content.body)
  1175. ),
  1176. formatted_body=(
  1177. f"<p><b>{media_content.formatted_body}</b></p>"
  1178. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1179. f"<p>{caption_content.formatted_body}</p>"
  1180. ),
  1181. format=Format.HTML,
  1182. )
  1183. else:
  1184. prefix_content.ensure_has_html()
  1185. caption_content.ensure_has_html()
  1186. combined_body = "\n".join((prefix_content.body, caption_content.body))
  1187. combined_formatted_body = (
  1188. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1189. f"<p>{caption_content.formatted_body}</p>"
  1190. )
  1191. combined = media_content
  1192. combined["filename"] = combined.body
  1193. combined.body = combined_body
  1194. combined["format"] = str(Format.HTML)
  1195. combined["org.matrix.msc1767.caption"] = {
  1196. "org.matrix.msc1767.text": combined_body,
  1197. "org.matrix.msc1767.html": combined_formatted_body,
  1198. }
  1199. combined["formatted_body"] = combined_formatted_body
  1200. else:
  1201. combined = caption_content
  1202. return [(EventType.ROOM_MESSAGE, combined)]
  1203. else:
  1204. await self._send_message(intent, prefix_content, timestamp=item.timestamp_ms)
  1205. converted: list[ConvertedMessage] = []
  1206. if media_content:
  1207. converted.append((EventType.ROOM_MESSAGE, media_content))
  1208. converted.append((EventType.ROOM_MESSAGE, caption_content))
  1209. return converted
  1210. async def _convert_instagram_link(
  1211. self,
  1212. source: u.User,
  1213. intent: IntentAPI,
  1214. item: ThreadItem,
  1215. ) -> ConvertedMessage:
  1216. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.link.text)
  1217. link = item.link.link_context
  1218. preview = {
  1219. "og:url": link.link_url,
  1220. "og:title": link.link_title,
  1221. "og:description": link.link_summary,
  1222. }
  1223. if link.link_image_url:
  1224. reuploaded = await self._reupload_instagram_file(
  1225. source, link.link_image_url, msgtype=None, info=ImageInfo(), intent=intent
  1226. )
  1227. preview["og:image"] = reuploaded.url
  1228. preview["og:image:type"] = reuploaded.info.mimetype
  1229. preview["og:image:width"] = reuploaded.info.width
  1230. preview["og:image:height"] = reuploaded.info.height
  1231. preview["matrix:image:size"] = reuploaded.info.size
  1232. if reuploaded.file:
  1233. preview["beeper:image:encryption"] = reuploaded.file.serialize()
  1234. preview = {k: v for k, v in preview.items() if v}
  1235. content["com.beeper.linkpreviews"] = [preview] if "og:title" in preview else []
  1236. await self._add_instagram_reply(content, item.replied_to_message)
  1237. return EventType.ROOM_MESSAGE, content
  1238. async def _convert_expired_placeholder(
  1239. self, source: u.User, item: ThreadItem, action: str
  1240. ) -> ConvertedMessage:
  1241. if item.user_id == source.igpk:
  1242. prefix = f"{action} your story"
  1243. elif item.user_id == source.igpk:
  1244. prefix = f"You {action.lower()} their story"
  1245. else:
  1246. prefix = f"{action} a story"
  1247. body = f"{prefix}\n\nNo longer available"
  1248. html = f"<p>{prefix}</p><p><i>No longer available</i></p>"
  1249. content = TextMessageEventContent(
  1250. msgtype=MessageType.NOTICE, body=body, format=Format.HTML, formatted_body=html
  1251. )
  1252. return EventType.ROOM_MESSAGE, content
  1253. async def _convert_instagram_text(self, item: ThreadItem, text: str) -> ConvertedMessage:
  1254. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  1255. content["com.beeper.linkpreviews"] = []
  1256. await self._add_instagram_reply(content, item.replied_to_message)
  1257. return EventType.ROOM_MESSAGE, content
  1258. async def _convert_instagram_unhandled(self, item: ThreadItem) -> ConvertedMessage:
  1259. content = TextMessageEventContent(
  1260. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  1261. )
  1262. await self._add_instagram_reply(content, item.replied_to_message)
  1263. return EventType.ROOM_MESSAGE, content
  1264. async def _convert_instagram_location(self, item: ThreadItem) -> ConvertedMessage | None:
  1265. loc = item.location
  1266. if not loc or not loc.lng or not loc.lat:
  1267. # TODO handle somehow
  1268. return None
  1269. long_char = "E" if loc.lng > 0 else "W"
  1270. lat_char = "N" if loc.lat > 0 else "S"
  1271. body = (
  1272. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  1273. f"{round(abs(loc.lng), 4)}° {long_char}"
  1274. )
  1275. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  1276. external_url = None
  1277. if loc.external_source == "facebook_places":
  1278. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  1279. content = LocationMessageEventContent(
  1280. msgtype=MessageType.LOCATION,
  1281. geo_uri=f"geo:{loc.lat},{loc.lng}",
  1282. body=f"Location: {body}\n{url}",
  1283. external_url=external_url,
  1284. )
  1285. content["format"] = str(Format.HTML)
  1286. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  1287. await self._add_instagram_reply(content, item.replied_to_message)
  1288. return EventType.ROOM_MESSAGE, content
  1289. async def _convert_instagram_profile(self, item: ThreadItem) -> ConvertedMessage:
  1290. username = item.profile.username
  1291. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1292. text = f"Shared @{username}'s profile"
  1293. html = f"Shared {user_link}'s profile"
  1294. content = TextMessageEventContent(
  1295. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1296. )
  1297. await self._add_instagram_reply(content, item.replied_to_message)
  1298. return EventType.ROOM_MESSAGE, content
  1299. async def _convert_instagram_xma_profile_share(
  1300. self, item: ThreadItem
  1301. ) -> list[ConvertedMessage]:
  1302. assert item.xma_profile
  1303. profile_messages = []
  1304. for profile in item.xma_profile:
  1305. username = profile.header_title_text
  1306. user_link = f'<a href="{profile.target_url}">@{username}</a>'
  1307. text = f"Shared @{username}'s profile"
  1308. html = f"Shared {user_link}'s profile"
  1309. content = TextMessageEventContent(
  1310. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1311. )
  1312. await self._add_instagram_reply(content, item.replied_to_message)
  1313. profile_messages.append((EventType.ROOM_MESSAGE, content))
  1314. return profile_messages
  1315. async def _add_instagram_reply(
  1316. self, content: MessageEventContent, reply_to: ThreadItem | None
  1317. ) -> None:
  1318. if not reply_to:
  1319. return
  1320. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  1321. if not message:
  1322. return
  1323. content.set_reply(message.mxid)
  1324. if not isinstance(content, TextMessageEventContent):
  1325. return
  1326. try:
  1327. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  1328. except (MNotFound, MForbidden):
  1329. evt = None
  1330. if not evt:
  1331. return
  1332. if evt.type == EventType.ROOM_ENCRYPTED:
  1333. try:
  1334. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  1335. except SessionNotFound:
  1336. return
  1337. if isinstance(evt.content, TextMessageEventContent):
  1338. evt.content.trim_reply_fallback()
  1339. content.set_reply(evt)
  1340. async def handle_instagram_item(
  1341. self, source: u.User, sender: p.Puppet, item: MessageSyncMessage
  1342. ):
  1343. client_context = item.client_context
  1344. link_client_context = item.link.client_context if item.link else None
  1345. cc = client_context
  1346. if link_client_context:
  1347. if not client_context:
  1348. cc = f"link:{link_client_context}"
  1349. elif client_context != link_client_context:
  1350. cc = f"{client_context}/link:{link_client_context}"
  1351. if client_context and client_context in self._reqid_dedup:
  1352. self.log.debug(
  1353. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1354. " as it was sent by us (client_context in dedup queue)"
  1355. )
  1356. return []
  1357. elif link_client_context and link_client_context in self._reqid_dedup:
  1358. self.log.debug(
  1359. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1360. " as it was sent by us (link.client_context in dedup queue)"
  1361. )
  1362. return []
  1363. # Check in-memory queues for duplicates
  1364. if item.item_id in self._msgid_dedup:
  1365. self.log.debug(
  1366. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1367. " as it was already handled (message.id in dedup queue)"
  1368. )
  1369. return
  1370. self._msgid_dedup.appendleft(item.item_id)
  1371. # Check database for duplicates
  1372. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1373. self.log.debug(
  1374. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1375. " as it was already handled (message.id in database)"
  1376. )
  1377. return
  1378. self.log.debug(
  1379. f"Handling Instagram message {item.item_id} ({item.client_context}) by {item.user_id}"
  1380. )
  1381. if not self.mxid:
  1382. thread = await source.client.get_thread(item.thread_id)
  1383. mxid = await self.create_matrix_room(source, thread.thread)
  1384. if not mxid:
  1385. # Failed to create
  1386. return
  1387. if self.config["bridge.backfill.enable"] and self.config["bridge.backfill.msc2716"]:
  1388. await self.enqueue_immediate_backfill(source, 0)
  1389. intent = sender.intent_for(self)
  1390. asyncio.create_task(intent.set_typing(self.mxid, timeout=0))
  1391. event_ids = []
  1392. for event_type, content in await self.convert_instagram_item(source, sender, item):
  1393. event_ids.append(
  1394. await self._send_message(
  1395. intent, content, event_type=event_type, timestamp=item.timestamp_ms
  1396. )
  1397. )
  1398. event_ids = [event_id for event_id in event_ids if event_id]
  1399. if not event_ids:
  1400. self.log.warning(f"Unhandled Instagram message {item.item_id}")
  1401. return
  1402. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_ids}")
  1403. await DBMessage(
  1404. mxid=event_ids[-1],
  1405. mx_room=self.mxid,
  1406. item_id=item.item_id,
  1407. client_context=item.client_context,
  1408. receiver=self.receiver,
  1409. sender=sender.igpk,
  1410. ig_timestamp=item.timestamp,
  1411. ).insert()
  1412. await self._send_delivery_receipt(event_ids[-1])
  1413. async def convert_instagram_item(
  1414. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1415. ) -> list[ConvertedMessage]:
  1416. if not isinstance(item, ThreadItem):
  1417. # Parsing these items failed, they should have been logged already
  1418. return []
  1419. try:
  1420. return await self._convert_instagram_item(source, sender, item)
  1421. except Exception:
  1422. self.log.exception("Fatal error converting Instagram item")
  1423. self.log.trace("Item content: %s", item.serialize())
  1424. return []
  1425. async def _convert_instagram_item(
  1426. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1427. ) -> list[ConvertedMessage]:
  1428. intent = sender.intent_for(self)
  1429. if (
  1430. item.xma_media_share
  1431. or item.xma_reel_share
  1432. or item.xma_reel_mention
  1433. or item.xma_story_share
  1434. or item.generic_xma
  1435. ):
  1436. return await self._convert_instagram_xma_media_share(source, intent, item)
  1437. converted: list[ConvertedMessage] = []
  1438. handle_text = True
  1439. if item.media or item.animated_media or item.voice_media or item.visual_media:
  1440. converted.append(await self._convert_instagram_media(source, intent, item))
  1441. elif item.location:
  1442. if loc_content := await self._convert_instagram_location(item):
  1443. converted.append(loc_content)
  1444. elif item.profile:
  1445. converted.append(await self._convert_instagram_profile(item))
  1446. elif item.xma_profile:
  1447. converted.extend(await self._convert_instagram_xma_profile_share(item))
  1448. elif item.reel_share:
  1449. converted.extend(await self._convert_instagram_reel_share(source, intent, item))
  1450. elif (
  1451. item.media_share
  1452. or item.direct_media_share
  1453. or item.story_share
  1454. or item.clip
  1455. or item.felix_share
  1456. ):
  1457. converted.extend(await self._convert_instagram_media_share(source, intent, item))
  1458. elif item.item_type == ThreadItemType.EXPIRED_PLACEHOLDER:
  1459. if item.message_item_type == "reaction":
  1460. action = "Reacted to"
  1461. else:
  1462. action = "Shared"
  1463. msg_type, expired = await self._convert_expired_placeholder(source, item, action)
  1464. if self.bridge.config["bridge.caption_in_message"] and item.text:
  1465. _, text = await self._convert_instagram_text(item, item.text)
  1466. expired.ensure_has_html()
  1467. text.ensure_has_html()
  1468. combined = TextMessageEventContent(
  1469. msgtype=MessageType.TEXT,
  1470. body="\n".join((expired.body, text.body)),
  1471. formatted_body=f"{expired.formatted_body}<p>{text.formatted_body}</p>",
  1472. format=Format.HTML,
  1473. )
  1474. handle_text = False
  1475. converted.append((msg_type, combined))
  1476. else:
  1477. converted.append((msg_type, expired))
  1478. elif item.action_log:
  1479. # These probably don't need to be bridged
  1480. self.log.debug(f"Ignoring action log message {item.item_id}")
  1481. return []
  1482. # TODO handle item.clip?
  1483. # TODO should these be put into a caption?
  1484. if handle_text and item.text:
  1485. converted.append(await self._convert_instagram_text(item, item.text))
  1486. elif item.like:
  1487. # We handle likes as text because Matrix clients do big emoji on their own.
  1488. converted.append(await self._convert_instagram_text(item, item.like))
  1489. elif item.link:
  1490. converted.append(await self._convert_instagram_link(source, intent, item))
  1491. if len(converted) == 0:
  1492. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1493. converted.append(await self._convert_instagram_unhandled(item))
  1494. return converted
  1495. def _deterministic_event_id(
  1496. self, sender: p.Puppet, item_id: str, part_name: int | None = None
  1497. ) -> EventID:
  1498. hash_content = f"{self.mxid}/instagram/{sender.igpk}/{item_id}"
  1499. if part_name:
  1500. hash_content += f"/{part_name}"
  1501. hashed = hashlib.sha256(hash_content.encode("utf-8")).digest()
  1502. b64hash = base64.urlsafe_b64encode(hashed).decode("utf-8").rstrip("=")
  1503. return EventID(f"${b64hash}:instagram.com")
  1504. async def handle_instagram_remove(self, item_id: str) -> None:
  1505. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1506. if message is None:
  1507. return
  1508. await message.delete()
  1509. if message.mxid:
  1510. sender = await p.Puppet.get_by_pk(message.sender)
  1511. try:
  1512. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1513. except MForbidden:
  1514. await self.main_intent.redact(self.mxid, message.mxid)
  1515. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1516. async def handle_instagram_reaction(self, item: ThreadItem, remove: bool) -> None:
  1517. sender = await p.Puppet.get_by_pk(item.new_reaction.sender_id)
  1518. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1519. if not message:
  1520. self.log.debug(f"Dropping reaction by {sender.pk} to unknown message {item.item_id}")
  1521. return
  1522. emoji = item.new_reaction.emoji
  1523. async with self._reaction_lock:
  1524. existing = await DBReaction.get_by_item_id(item.item_id, self.receiver, sender.pk)
  1525. if not existing and remove:
  1526. self.log.debug(
  1527. f"Ignoring duplicate reaction removal by {sender.pk} to {item.item_id}"
  1528. )
  1529. return
  1530. elif not remove and existing and existing.reaction == emoji:
  1531. self.log.debug(f"Ignoring duplicate reaction by {sender.pk} to {item.item_id}")
  1532. return
  1533. intent = sender.intent_for(self)
  1534. if remove:
  1535. await existing.delete()
  1536. await intent.redact(self.mxid, existing.mxid)
  1537. self.log.debug(
  1538. f"Removed {sender.pk}'s reaction to {item.item_id} (redacted {existing.mxid})"
  1539. )
  1540. else:
  1541. timestamp = item.new_reaction.timestamp_ms
  1542. reaction_event_id = await intent.react(
  1543. self.mxid, message.mxid, key=emoji, timestamp=timestamp
  1544. )
  1545. await self._upsert_reaction(
  1546. existing, intent, reaction_event_id, message, sender, emoji, timestamp
  1547. )
  1548. self.log.debug(
  1549. f"Handled {sender.pk}'s reaction to {item.item_id} -> {reaction_event_id}"
  1550. )
  1551. async def _handle_instagram_reactions(
  1552. self, message: DBMessage, reactions: list[Reaction]
  1553. ) -> None:
  1554. old_reactions: dict[int, DBReaction]
  1555. old_reactions = {
  1556. reaction.ig_sender: reaction
  1557. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1558. }
  1559. for new_reaction in reactions:
  1560. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1561. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1562. continue
  1563. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1564. intent = puppet.intent_for(self)
  1565. timestamp = int(time.time() * 1000)
  1566. reaction_event_id = await intent.react(
  1567. self.mxid, message.mxid, new_reaction.emoji, timestamp=timestamp
  1568. )
  1569. await self._upsert_reaction(
  1570. old_reaction,
  1571. intent,
  1572. reaction_event_id,
  1573. message,
  1574. puppet,
  1575. new_reaction.emoji,
  1576. timestamp,
  1577. )
  1578. for old_reaction in old_reactions.values():
  1579. await old_reaction.delete()
  1580. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1581. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1582. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1583. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1584. if not message:
  1585. return
  1586. if item.has_seen:
  1587. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1588. if puppet:
  1589. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1590. else:
  1591. async with self._reaction_lock:
  1592. await self._handle_instagram_reactions(
  1593. message, (item.reactions.emojis if item.reactions else [])
  1594. )
  1595. # endregion
  1596. # region Updating portal info
  1597. def _get_thread_name(self, thread: Thread) -> str:
  1598. if self.is_direct:
  1599. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1600. return "Instagram chat with yourself"
  1601. elif len(thread.users) == 1:
  1602. tpl = self.config["bridge.private_chat_name_template"]
  1603. ui = thread.users[0]
  1604. return tpl.format(
  1605. displayname=ui.full_name or ui.username, id=ui.pk, username=ui.username
  1606. )
  1607. elif thread.thread_title:
  1608. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1609. return ""
  1610. async def _get_thread_avatar(self, source: u.User, thread: Thread) -> Optional[ContentURI]:
  1611. if self.is_direct or not thread.thread_image:
  1612. return None
  1613. if self.thread_image_id == thread.thread_image.id:
  1614. return self.avatar_url
  1615. best: Optional[ThreadImageCandidate] = None
  1616. for candidate in thread.thread_image.image_versions2.candidates:
  1617. if best is None or candidate.width > best.width:
  1618. best = candidate
  1619. if not best:
  1620. return None
  1621. data, mimetype = await self._download_instagram_file(source, best.url)
  1622. if not data:
  1623. return None
  1624. mxc = await self.main_intent.upload_media(
  1625. data=data,
  1626. mime_type=mimetype,
  1627. filename=thread.thread_image.id,
  1628. async_upload=self.config["homeserver.async_media"],
  1629. )
  1630. self.thread_image_id = thread.thread_image.id
  1631. return mxc
  1632. async def update_info(self, thread: Thread, source: u.User) -> None:
  1633. changed = await self._update_name(self._get_thread_name(thread))
  1634. if thread_avatar := await self._get_thread_avatar(source, thread):
  1635. changed = await self._update_photo(thread_avatar)
  1636. changed = await self._update_participants(thread.users, source) or changed
  1637. if changed:
  1638. await self.update_bridge_info()
  1639. await self.update()
  1640. # TODO update power levels with thread.admin_user_ids
  1641. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1642. if not self.is_direct:
  1643. return
  1644. if not puppet:
  1645. puppet = await self.get_dm_puppet()
  1646. await self._update_photo_from_puppet(puppet)
  1647. if self.name and not self.name_set:
  1648. await self._update_name(self.name)
  1649. async def _update_name(self, name: str) -> bool:
  1650. if name and (self.name != name or not self.name_set):
  1651. self.name = name
  1652. if self.mxid:
  1653. try:
  1654. await self.main_intent.set_room_name(self.mxid, name)
  1655. self.name_set = True
  1656. except Exception:
  1657. self.log.exception("Failed to update name")
  1658. self.name_set = False
  1659. return True
  1660. return False
  1661. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1662. if not self.private_chat_portal_meta and not self.encrypted:
  1663. return False
  1664. return await self._update_photo(puppet.photo_mxc)
  1665. async def _update_photo(self, photo_mxc: ContentURI) -> bool:
  1666. if self.avatar_set and self.avatar_url == photo_mxc:
  1667. return False
  1668. self.avatar_url = photo_mxc
  1669. if self.mxid:
  1670. try:
  1671. await self.main_intent.set_room_avatar(self.mxid, photo_mxc)
  1672. self.avatar_set = True
  1673. except Exception:
  1674. self.log.exception("Failed to set room avatar")
  1675. self.avatar_set = False
  1676. return True
  1677. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1678. meta_changed = False
  1679. # Make sure puppets who should be here are here
  1680. for user in users:
  1681. puppet = await p.Puppet.get_by_pk(user.pk)
  1682. await puppet.update_info(user, source)
  1683. if self.mxid:
  1684. await puppet.intent_for(self).ensure_joined(self.mxid)
  1685. if puppet.pk == self.other_user_pk:
  1686. meta_changed = await self._update_photo_from_puppet(puppet)
  1687. if self.mxid:
  1688. # Kick puppets who shouldn't be here
  1689. current_members = {int(user.pk) for user in users}
  1690. for user_id in await self.main_intent.get_room_members(self.mxid):
  1691. pk = p.Puppet.get_id_from_mxid(user_id)
  1692. if pk and pk not in current_members and pk != self.other_user_pk:
  1693. await self.main_intent.kick_user(
  1694. self.mxid,
  1695. p.Puppet.get_mxid_from_id(pk),
  1696. reason="User had left this Instagram DM",
  1697. )
  1698. return meta_changed
  1699. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1700. for user_id, receipt in receipts.items():
  1701. message: DBMessage | DBReaction
  1702. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1703. if not message:
  1704. reaction: DBReaction
  1705. message, reaction = await asyncio.gather(
  1706. DBMessage.get_closest(self.mxid, int(receipt.timestamp)),
  1707. DBReaction.get_closest(self.mxid, receipt.timestamp_ms),
  1708. )
  1709. if (not message or not message.mxid) and not reaction:
  1710. self.log.debug(
  1711. "Couldn't find message %s to mark as read by %s", receipt, user_id
  1712. )
  1713. continue
  1714. elif not message or (reaction and reaction.mx_timestamp > message.ig_timestamp_ms):
  1715. message = reaction
  1716. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1717. if not puppet:
  1718. continue
  1719. try:
  1720. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1721. except Exception:
  1722. self.log.warning(
  1723. f"Failed to mark {message.mxid} in {message.mx_room} "
  1724. f"as read by {puppet.intent.mxid}",
  1725. exc_info=True,
  1726. )
  1727. async def get_dm_puppet(self) -> p.Puppet | None:
  1728. if not self.is_direct:
  1729. return None
  1730. return await p.Puppet.get_by_pk(self.other_user_pk)
  1731. # endregion
  1732. # region Backfill
  1733. async def enqueue_immediate_backfill(self, source: u.User, priority: int) -> None:
  1734. assert self.config["bridge.backfill.msc2716"]
  1735. if not await Backfill.get(source.mxid, self.thread_id, self.receiver):
  1736. await Backfill.new(
  1737. source.mxid,
  1738. priority,
  1739. self.thread_id,
  1740. self.receiver,
  1741. self.config["bridge.backfill.incremental.max_pages"],
  1742. self.config["bridge.backfill.incremental.page_delay"],
  1743. self.config["bridge.backfill.incremental.post_batch_delay"],
  1744. self.config["bridge.backfill.incremental.max_total_pages"],
  1745. ).insert()
  1746. async def backfill(self, source: u.User, backfill_request: Backfill) -> None:
  1747. try:
  1748. last_message_ig_timestamp = await self._backfill(source, backfill_request)
  1749. if (
  1750. last_message_ig_timestamp is not None
  1751. and not self.bridge.homeserver_software.is_hungry
  1752. and self.config["bridge.backfill.msc2716"]
  1753. ):
  1754. await self.send_post_backfill_dummy(last_message_ig_timestamp)
  1755. finally:
  1756. # Always sleep after the backfill request is finished processing, even if it errors.
  1757. await asyncio.sleep(backfill_request.post_batch_delay)
  1758. async def _backfill(self, source: u.User, backfill_request: Backfill) -> int | None:
  1759. assert source.client
  1760. self.log.debug("Backfill request: %s", backfill_request)
  1761. num_pages = backfill_request.num_pages
  1762. self.log.debug(
  1763. "Backfilling up to %d pages of history in %s through %s",
  1764. num_pages,
  1765. self.mxid,
  1766. source.mxid,
  1767. )
  1768. try:
  1769. if self.cursor:
  1770. self.log.debug(
  1771. f"There is a cursor for the chat, fetching messages before {self.cursor}"
  1772. )
  1773. resp = await source.client.get_thread(
  1774. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1775. )
  1776. else:
  1777. self.log.debug(
  1778. "There is no first message in the chat, starting with the most recent messages"
  1779. )
  1780. resp = await source.client.get_thread(self.thread_id, seq_id=source.seq_id)
  1781. except IGRateLimitError as e:
  1782. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1783. self.log.warning(
  1784. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds before "
  1785. f"resuming. Error: {e}"
  1786. )
  1787. await asyncio.sleep(backoff)
  1788. raise
  1789. async def dedup_messages(messages: list[ThreadItem]) -> list[ThreadItem]:
  1790. deduped = []
  1791. # Sometimes (seems like on Facebook chats) it fetches the first message in the chat over
  1792. # and over again.
  1793. for item in messages:
  1794. # Check in-memory queues for duplicates
  1795. if item.item_id in self._msgid_dedup:
  1796. self.log.debug(
  1797. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1798. " as it was already handled (message.id in dedup queue)"
  1799. )
  1800. continue
  1801. self._msgid_dedup.appendleft(item.item_id)
  1802. # Check database for duplicates
  1803. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1804. self.log.debug(
  1805. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1806. " as it was already handled (message.id in database)"
  1807. )
  1808. continue
  1809. deduped.append(item)
  1810. return deduped
  1811. messages = await dedup_messages(resp.thread.items)
  1812. cursor = resp.thread.oldest_cursor
  1813. backfill_more = resp.thread.has_older
  1814. if len(messages) == 0:
  1815. self.log.debug("No messages to backfill.")
  1816. return None
  1817. last_message_timestamp = messages[-1].timestamp_ms
  1818. pages_to_backfill = backfill_request.num_pages
  1819. if backfill_request.max_total_pages > -1:
  1820. pages_to_backfill = min(pages_to_backfill, backfill_request.max_total_pages)
  1821. pages_backfilled = 0
  1822. for i in range(pages_to_backfill):
  1823. base_insertion_event_id = await self.backfill_message_page(
  1824. source, list(reversed(messages))
  1825. )
  1826. self.cursor = cursor
  1827. await self.save()
  1828. pages_backfilled += 1
  1829. if base_insertion_event_id:
  1830. self.historical_base_insertion_event_id = base_insertion_event_id
  1831. await self.save()
  1832. if backfill_more and i < pages_to_backfill - 1:
  1833. # Sleep before fetching another page of messages.
  1834. await asyncio.sleep(backfill_request.page_delay)
  1835. # Fetch more messages
  1836. try:
  1837. resp = await source.client.get_thread(
  1838. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1839. )
  1840. messages = await dedup_messages(resp.thread.items)
  1841. cursor = resp.thread.oldest_cursor
  1842. backfill_more &= resp.thread.has_older
  1843. except IGRateLimitError as e:
  1844. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1845. self.log.warning(
  1846. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds "
  1847. "before resuming."
  1848. )
  1849. await asyncio.sleep(backoff)
  1850. # If we hit the rate limit, then we will want to give up for now, but enqueue
  1851. # additional backfill to do later.
  1852. break
  1853. if backfill_request.max_total_pages == -1:
  1854. new_max_total_pages = -1
  1855. else:
  1856. new_max_total_pages = backfill_request.max_total_pages - pages_backfilled
  1857. if new_max_total_pages <= 0:
  1858. backfill_more = False
  1859. if backfill_more:
  1860. self.log.debug("Enqueueing more backfill")
  1861. await Backfill.new(
  1862. source.mxid,
  1863. # Always enqueue subsequent backfills at the lowest priority
  1864. 2,
  1865. self.thread_id,
  1866. self.receiver,
  1867. backfill_request.num_pages,
  1868. backfill_request.page_delay,
  1869. backfill_request.post_batch_delay,
  1870. new_max_total_pages,
  1871. ).insert()
  1872. else:
  1873. self.log.debug("No more messages to backfill")
  1874. await self._update_read_receipts(resp.thread.last_seen_at)
  1875. return last_message_timestamp
  1876. async def backfill_message_page(
  1877. self,
  1878. source: u.User,
  1879. message_page: list[ThreadItem],
  1880. forward: bool = False,
  1881. last_message: DBMessage | None = None,
  1882. mark_read: bool = False,
  1883. ) -> EventID | None:
  1884. """
  1885. Backfills a page of messages to Matrix. The messages should be in order from oldest to
  1886. newest.
  1887. Returns: a tuple containing the number of messages that were actually bridged, the
  1888. timestamp of the oldest bridged message and the base insertion event ID if it exists.
  1889. """
  1890. assert source.client
  1891. if len(message_page) == 0:
  1892. return None
  1893. if forward:
  1894. assert (last_message and last_message.mxid) or self.first_event_id
  1895. prev_event_id = last_message.mxid if last_message else self.first_event_id
  1896. else:
  1897. assert self.config["bridge.backfill.msc2716"]
  1898. assert self.first_event_id
  1899. prev_event_id = self.first_event_id
  1900. assert self.mxid
  1901. oldest_message_in_page = message_page[0]
  1902. oldest_msg_timestamp = oldest_message_in_page.timestamp_ms
  1903. batch_messages: list[BatchSendEvent] = []
  1904. state_events_at_start: list[BatchSendStateEvent] = []
  1905. added_members = set()
  1906. current_members = await self.main_intent.state_store.get_members(
  1907. self.mxid, memberships=(Membership.JOIN,)
  1908. )
  1909. def add_member(puppet: p.Puppet, mxid: UserID):
  1910. assert self.mxid
  1911. if mxid in added_members:
  1912. return
  1913. if (
  1914. self.bridge.homeserver_software.is_hungry
  1915. or not self.config["bridge.backfill.msc2716"]
  1916. ):
  1917. # Hungryserv doesn't expect or check state events at start.
  1918. added_members.add(mxid)
  1919. return
  1920. content_args = {"avatar_url": puppet.photo_mxc, "displayname": puppet.name}
  1921. state_events_at_start.extend(
  1922. [
  1923. BatchSendStateEvent(
  1924. content=MemberStateEventContent(Membership.INVITE, **content_args),
  1925. type=EventType.ROOM_MEMBER,
  1926. sender=self.main_intent.mxid,
  1927. state_key=mxid,
  1928. timestamp=oldest_msg_timestamp,
  1929. ),
  1930. BatchSendStateEvent(
  1931. content=MemberStateEventContent(Membership.JOIN, **content_args),
  1932. type=EventType.ROOM_MEMBER,
  1933. sender=mxid,
  1934. state_key=mxid,
  1935. timestamp=oldest_msg_timestamp,
  1936. ),
  1937. ]
  1938. )
  1939. added_members.add(mxid)
  1940. async def intent_for(user_id: int) -> tuple[p.Puppet, IntentAPI]:
  1941. puppet: p.Puppet = await p.Puppet.get_by_pk(user_id)
  1942. if puppet:
  1943. intent = puppet.intent_for(self)
  1944. else:
  1945. intent = self.main_intent
  1946. if puppet.is_real_user and not self._can_double_puppet_backfill(intent.mxid):
  1947. intent = puppet.default_mxid_intent
  1948. return puppet, intent
  1949. message_infos: list[tuple[ThreadItem | Reaction, int]] = []
  1950. intents: list[IntentAPI] = []
  1951. for message in message_page:
  1952. puppet, intent = await intent_for(message.user_id)
  1953. # Convert the message
  1954. converted = await self.convert_instagram_item(source, puppet, message)
  1955. if not converted:
  1956. self.log.debug(f"Skipping unsupported message in backfill {message.item_id}")
  1957. continue
  1958. if intent.mxid not in current_members:
  1959. add_member(puppet, intent.mxid)
  1960. d_event_id = None
  1961. for index, (event_type, content) in enumerate(converted):
  1962. if self.encrypted and self.matrix.e2ee:
  1963. event_type, content = await self.matrix.e2ee.encrypt(
  1964. self.mxid, event_type, content
  1965. )
  1966. if intent.api.is_real_user and intent.api.bridge_name is not None:
  1967. content[DOUBLE_PUPPET_SOURCE_KEY] = intent.api.bridge_name
  1968. if self.bridge.homeserver_software.is_hungry:
  1969. d_event_id = self._deterministic_event_id(puppet, message.item_id, index)
  1970. message_infos.append((message, index))
  1971. batch_messages.append(
  1972. BatchSendEvent(
  1973. content=content,
  1974. type=event_type,
  1975. sender=intent.mxid,
  1976. timestamp=message.timestamp_ms,
  1977. event_id=d_event_id,
  1978. )
  1979. )
  1980. intents.append(intent)
  1981. if self.bridge.homeserver_software.is_hungry and message.reactions:
  1982. for reaction in message.reactions.emojis:
  1983. puppet, intent = await intent_for(reaction.sender_id)
  1984. reaction_event = ReactionEventContent()
  1985. reaction_event.relates_to = RelatesTo(
  1986. rel_type=RelationType.ANNOTATION, event_id=d_event_id, key=reaction.emoji
  1987. )
  1988. if intent.api.is_real_user and intent.api.bridge_name is not None:
  1989. reaction_event[DOUBLE_PUPPET_SOURCE_KEY] = intent.api.bridge_name
  1990. message_infos.append((reaction, 0))
  1991. batch_messages.append(
  1992. BatchSendEvent(
  1993. content=reaction_event,
  1994. type=EventType.REACTION,
  1995. sender=intent.mxid,
  1996. timestamp=reaction.timestamp_ms or message.timestamp_ms,
  1997. )
  1998. )
  1999. if not batch_messages:
  2000. return None
  2001. if (
  2002. not self.bridge.homeserver_software.is_hungry
  2003. and self.config["bridge.backfill.msc2716"]
  2004. and (forward or self.next_batch_id is None)
  2005. ):
  2006. self.log.debug("Sending dummy event to avoid forward extremity errors")
  2007. await self.az.intent.send_message_event(
  2008. self.mxid, EventType("fi.mau.dummy.pre_backfill", EventType.Class.MESSAGE), {}
  2009. )
  2010. self.log.info(
  2011. "Sending %d %s messages to %s with batch ID %s and previous event ID %s",
  2012. len(batch_messages),
  2013. "new" if forward else "historical",
  2014. self.mxid,
  2015. self.next_batch_id,
  2016. prev_event_id,
  2017. )
  2018. if self.bridge.homeserver_software.is_hungry:
  2019. self.log.debug("Batch message event IDs %s", [m.event_id for m in batch_messages])
  2020. base_insertion_event_id = None
  2021. if self.config["bridge.backfill.msc2716"]:
  2022. batch_send_resp = await self.main_intent.batch_send(
  2023. self.mxid,
  2024. prev_event_id,
  2025. batch_id=self.next_batch_id,
  2026. events=batch_messages,
  2027. state_events_at_start=state_events_at_start,
  2028. beeper_new_messages=forward,
  2029. beeper_mark_read_by=source.mxid if mark_read else None,
  2030. )
  2031. base_insertion_event_id = batch_send_resp.base_insertion_event_id
  2032. event_ids = batch_send_resp.event_ids
  2033. else:
  2034. batch_send_resp = None
  2035. event_ids = [
  2036. await intent.send_message_event(
  2037. self.mxid, evt.type, evt.content, timestamp=evt.timestamp
  2038. )
  2039. for evt, intent in zip(reversed(batch_messages), reversed(intents))
  2040. ]
  2041. await self._finish_batch(event_ids, message_infos)
  2042. if not forward:
  2043. assert batch_send_resp
  2044. self.log.debug("Got next batch ID %s for %s", batch_send_resp.next_batch_id, self.mxid)
  2045. self.next_batch_id = batch_send_resp.next_batch_id
  2046. await self.save()
  2047. return base_insertion_event_id
  2048. def _can_double_puppet_backfill(self, custom_mxid: UserID) -> bool:
  2049. return self.config["bridge.backfill.double_puppet_backfill"] and (
  2050. # Hungryserv can batch send any users
  2051. self.bridge.homeserver_software.is_hungry
  2052. # Non-MSC2716 backfill can use any double puppet
  2053. or not self.config["bridge.backfill.msc2716"]
  2054. # Local users can be double puppeted even with MSC2716
  2055. or (custom_mxid[custom_mxid.index(":") + 1 :] == self.config["homeserver.domain"])
  2056. )
  2057. async def _finish_batch(
  2058. self, event_ids: list[EventID], message_infos: list[tuple[ThreadItem | Reaction, int]]
  2059. ):
  2060. # We have to do this slightly annoying processing of the event IDs and message infos so
  2061. # that we only map the last event ID to the message.
  2062. # When inline captions are enabled, this will have no effect since index will always be 0
  2063. # since there's only ever one event per message.
  2064. current_message = None
  2065. messages = []
  2066. reactions = []
  2067. message_id = None
  2068. for event_id, (message_or_reaction, index) in zip(event_ids, message_infos):
  2069. if isinstance(message_or_reaction, ThreadItem):
  2070. message = message_or_reaction
  2071. if index == 0 and current_message:
  2072. # This means that all of the events for the previous message have been processed,
  2073. # and the current_message is the most recent event for that message.
  2074. messages.append(current_message)
  2075. current_message = DBMessage(
  2076. mxid=event_id,
  2077. mx_room=self.mxid,
  2078. item_id=message.item_id,
  2079. client_context=message.client_context,
  2080. receiver=self.receiver,
  2081. sender=message.user_id,
  2082. ig_timestamp=message.timestamp,
  2083. )
  2084. message_id = message.item_id
  2085. else:
  2086. assert message_id
  2087. reaction = message_or_reaction
  2088. reactions.append(
  2089. DBReaction(
  2090. mxid=event_id,
  2091. mx_room=self.mxid,
  2092. ig_item_id=message_id,
  2093. ig_receiver=self.receiver,
  2094. ig_sender=reaction.sender_id,
  2095. reaction=reaction.emoji,
  2096. mx_timestamp=reaction.timestamp_ms,
  2097. )
  2098. )
  2099. if current_message:
  2100. messages.append(current_message)
  2101. try:
  2102. await DBMessage.bulk_insert(messages)
  2103. except Exception:
  2104. self.log.exception("Failed to store batch message IDs")
  2105. try:
  2106. for reaction in reactions:
  2107. await reaction.insert()
  2108. except Exception:
  2109. self.log.exception("Failed to store backfilled reactions")
  2110. async def send_post_backfill_dummy(
  2111. self,
  2112. last_message_ig_timestamp: int,
  2113. base_insertion_event_id: EventID | None = None,
  2114. ):
  2115. if not self.config["bridge.backfill.msc2716"]:
  2116. return
  2117. assert self.mxid
  2118. if not base_insertion_event_id:
  2119. base_insertion_event_id = self.historical_base_insertion_event_id
  2120. if not base_insertion_event_id:
  2121. self.log.debug(
  2122. "No base insertion event ID in database or from batch send response. Not sending"
  2123. " dummy event."
  2124. )
  2125. return
  2126. event_id = await self.main_intent.send_message_event(
  2127. self.mxid,
  2128. event_type=HistorySyncMarkerMessage,
  2129. content={
  2130. "org.matrix.msc2716.marker.insertion": base_insertion_event_id,
  2131. "m.marker.insertion": base_insertion_event_id,
  2132. },
  2133. )
  2134. await DBMessage(
  2135. mxid=event_id,
  2136. mx_room=self.mxid,
  2137. item_id=f"fi.mau.instagram.post_backfill_dummy.{last_message_ig_timestamp}",
  2138. client_context=None,
  2139. receiver=self.receiver,
  2140. sender=0,
  2141. ig_timestamp=last_message_ig_timestamp,
  2142. ).insert()
  2143. # endregion
  2144. # region Bridge info state event
  2145. @property
  2146. def bridge_info_state_key(self) -> str:
  2147. return f"net.maunium.instagram://instagram/{self.thread_id}"
  2148. @property
  2149. def bridge_info(self) -> dict[str, Any]:
  2150. return {
  2151. "bridgebot": self.az.bot_mxid,
  2152. "creator": self.main_intent.mxid,
  2153. "protocol": {
  2154. "id": "instagram",
  2155. "displayname": "Instagram DM",
  2156. "avatar_url": self.config["appservice.bot_avatar"],
  2157. },
  2158. "channel": {
  2159. "id": self.thread_id,
  2160. "displayname": self.name,
  2161. "avatar_url": self.avatar_url,
  2162. },
  2163. }
  2164. async def update_bridge_info(self) -> None:
  2165. if not self.mxid:
  2166. self.log.debug("Not updating bridge info: no Matrix room created")
  2167. return
  2168. try:
  2169. self.log.debug("Updating bridge info...")
  2170. await self.main_intent.send_state_event(
  2171. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  2172. )
  2173. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2174. await self.main_intent.send_state_event(
  2175. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  2176. )
  2177. except Exception:
  2178. self.log.warning("Failed to update bridge info", exc_info=True)
  2179. # endregion
  2180. # region Creating Matrix rooms
  2181. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  2182. if self.mxid:
  2183. try:
  2184. await self.update_matrix_room(source, info)
  2185. except Exception:
  2186. self.log.exception("Failed to update portal")
  2187. return self.mxid
  2188. async with self._create_room_lock:
  2189. try:
  2190. return await self._create_matrix_room(source, info)
  2191. except Exception:
  2192. self.log.exception("Failed to create portal")
  2193. return None
  2194. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  2195. invite_content = {}
  2196. if double_puppet:
  2197. invite_content["fi.mau.will_auto_accept"] = True
  2198. if self.is_direct:
  2199. invite_content["is_direct"] = True
  2200. return invite_content
  2201. async def update_matrix_room(self, source: u.User, info: Thread) -> None:
  2202. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2203. await self.main_intent.invite_user(
  2204. self.mxid,
  2205. source.mxid,
  2206. check_cache=True,
  2207. extra_content=self._get_invite_content(puppet),
  2208. )
  2209. if puppet:
  2210. did_join = await puppet.intent.ensure_joined(self.mxid)
  2211. if did_join and self.is_direct:
  2212. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2213. await self.update_info(info, source)
  2214. await self._update_read_receipts(info.last_seen_at)
  2215. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  2216. if self.mxid:
  2217. await self.update_matrix_room(source, info)
  2218. return self.mxid
  2219. await self.update_info(info, source)
  2220. self.log.debug("Creating Matrix room")
  2221. name: str | None = None
  2222. initial_state = [
  2223. {
  2224. "type": str(StateBridge),
  2225. "state_key": self.bridge_info_state_key,
  2226. "content": self.bridge_info,
  2227. },
  2228. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2229. {
  2230. "type": str(StateHalfShotBridge),
  2231. "state_key": self.bridge_info_state_key,
  2232. "content": self.bridge_info,
  2233. },
  2234. ]
  2235. invites = []
  2236. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  2237. self.encrypted = True
  2238. initial_state.append(
  2239. {
  2240. "type": "m.room.encryption",
  2241. "content": self.get_encryption_state_event_json(),
  2242. }
  2243. )
  2244. if self.is_direct:
  2245. invites.append(self.az.bot_mxid)
  2246. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  2247. name = self.name
  2248. creation_content = {}
  2249. if not self.config["bridge.federate_rooms"]:
  2250. creation_content["m.federate"] = False
  2251. self.mxid = await self.main_intent.create_room(
  2252. name=name,
  2253. is_direct=self.is_direct,
  2254. initial_state=initial_state,
  2255. invitees=invites,
  2256. creation_content=creation_content,
  2257. )
  2258. if not self.mxid:
  2259. raise Exception("Failed to create room: no mxid returned")
  2260. if self.encrypted and self.matrix.e2ee and self.is_direct:
  2261. try:
  2262. await self.az.intent.ensure_joined(self.mxid)
  2263. except Exception:
  2264. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  2265. await self.update()
  2266. self.log.debug(f"Matrix room created: {self.mxid}")
  2267. self.by_mxid[self.mxid] = self
  2268. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2269. await self.main_intent.invite_user(
  2270. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  2271. )
  2272. if puppet:
  2273. try:
  2274. if self.is_direct:
  2275. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2276. await puppet.intent.join_room_by_id(self.mxid)
  2277. except MatrixError:
  2278. self.log.debug(
  2279. "Failed to join custom puppet into newly created portal", exc_info=True
  2280. )
  2281. await self._update_participants(info.users, source)
  2282. self.log.trace("Sending portal post-create dummy event")
  2283. self.first_event_id = await self.az.intent.send_message_event(
  2284. self.mxid, PortalCreateDummy, {}
  2285. )
  2286. await self.update()
  2287. return self.mxid
  2288. # endregion
  2289. # region Database getters
  2290. async def postinit(self) -> None:
  2291. self.by_thread_id[(self.thread_id, self.receiver)] = self
  2292. if self.mxid:
  2293. self.by_mxid[self.mxid] = self
  2294. self._main_intent = (
  2295. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  2296. if self.other_user_pk
  2297. else self.az.intent
  2298. )
  2299. async def delete(self) -> None:
  2300. await DBMessage.delete_all(self.mxid)
  2301. self.by_mxid.pop(self.mxid, None)
  2302. self.mxid = None
  2303. self.encrypted = False
  2304. await self.update()
  2305. async def save(self) -> None:
  2306. await self.update()
  2307. @classmethod
  2308. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  2309. return cls._db_to_portals(super().all_with_room())
  2310. @classmethod
  2311. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  2312. return cls._db_to_portals(super().find_private_chats_with(other_user))
  2313. @classmethod
  2314. async def find_private_chat(cls, receiver: int, other_user: int) -> Portal | None:
  2315. thread_id = await super().find_private_chat_id(receiver, other_user)
  2316. if not thread_id:
  2317. return None
  2318. return await cls.get_by_thread_id(thread_id, receiver=receiver, is_group=False)
  2319. @classmethod
  2320. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  2321. portals = await query
  2322. for index, portal in enumerate(portals):
  2323. try:
  2324. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  2325. except KeyError:
  2326. await portal.postinit()
  2327. yield portal
  2328. @classmethod
  2329. @async_getter_lock
  2330. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  2331. try:
  2332. return cls.by_mxid[mxid]
  2333. except KeyError:
  2334. pass
  2335. portal = cast(cls, await super().get_by_mxid(mxid))
  2336. if portal is not None:
  2337. await portal.postinit()
  2338. return portal
  2339. return None
  2340. @classmethod
  2341. @async_getter_lock
  2342. async def get_by_thread_id(
  2343. cls,
  2344. thread_id: str,
  2345. *,
  2346. receiver: int,
  2347. is_group: bool | None = None,
  2348. other_user_pk: int | None = None,
  2349. ) -> Portal | None:
  2350. if is_group and receiver != 0:
  2351. receiver = 0
  2352. try:
  2353. return cls.by_thread_id[(thread_id, receiver)]
  2354. except KeyError:
  2355. pass
  2356. if is_group is None and receiver != 0:
  2357. try:
  2358. return cls.by_thread_id[(thread_id, 0)]
  2359. except KeyError:
  2360. pass
  2361. portal = cast(
  2362. cls,
  2363. await super().get_by_thread_id(
  2364. thread_id, receiver=receiver, rec_must_match=is_group is not None
  2365. ),
  2366. )
  2367. if portal is not None:
  2368. await portal.postinit()
  2369. return portal
  2370. if is_group is not None:
  2371. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  2372. await portal.insert()
  2373. await portal.postinit()
  2374. return portal
  2375. return None
  2376. @classmethod
  2377. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  2378. if thread.is_group:
  2379. receiver = 0
  2380. other_user_pk = None
  2381. else:
  2382. if len(thread.users) == 0:
  2383. other_user_pk = receiver
  2384. else:
  2385. other_user_pk = thread.users[0].pk
  2386. return await cls.get_by_thread_id(
  2387. thread.thread_id,
  2388. receiver=receiver,
  2389. is_group=thread.is_group,
  2390. other_user_pk=other_user_pk,
  2391. )
  2392. # endregion