portal.py 103 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611
  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. _, content = await self._convert_instagram_media(source, intent, item)
  1006. # Post shares (layout type 0): media title text
  1007. # Reel shares/replies/reactions (layout type 4): item text
  1008. caption_text = media.title_text or item.text or ""
  1009. if media.subtitle_text:
  1010. caption_text = (
  1011. f"{caption_text}\n{media.subtitle_text}" if caption_text else media.subtitle_text
  1012. )
  1013. if media.target_url:
  1014. caption_body = (
  1015. f"> {caption_text}\n\n{media.target_url}" if caption_text else media.target_url
  1016. )
  1017. else:
  1018. caption_body = f"> {caption_text}"
  1019. escaped_caption_text = html.escape(caption_text).replace("\n", "<br>")
  1020. escaped_header_text = html.escape(media.header_title_text or "")
  1021. # For post shares, the media title starts with the username, which is also the header.
  1022. # That part should be bolded.
  1023. if (
  1024. escaped_header_text
  1025. and escaped_caption_text
  1026. and escaped_caption_text.startswith(escaped_header_text)
  1027. ):
  1028. escaped_caption_text = (
  1029. f"<strong>{escaped_header_text}</strong>"
  1030. f"{escaped_caption_text[len(escaped_header_text):]}"
  1031. )
  1032. if item.message_item_type == "animated_media":
  1033. anim = await self._reupload_instagram_file(
  1034. source,
  1035. url=item.animated_media.images.fixed_height.webp,
  1036. msgtype=MessageType.IMAGE,
  1037. info=ImageInfo(
  1038. width=int(item.animated_media.images.fixed_height.width),
  1039. height=int(item.animated_media.images.fixed_height.height),
  1040. ),
  1041. intent=intent,
  1042. )
  1043. inline_img = (
  1044. f'<img src="{anim.url}" width={anim.info.width} height={anim.info.height}/>'
  1045. )
  1046. escaped_caption_text = (
  1047. f"{escaped_caption_text}<br/>{inline_img}" if escaped_caption_text else inline_img
  1048. )
  1049. caption_formatted_body = (
  1050. f"<blockquote>{escaped_caption_text}</blockquote>" if escaped_caption_text else ""
  1051. )
  1052. if media.target_url:
  1053. target_url_pretty = str(URL(media.target_url).with_query(None)).replace(
  1054. "https://www.", ""
  1055. )
  1056. caption_formatted_body += (
  1057. f'<p><a href="{media.target_url}">{target_url_pretty}</a></p>'
  1058. )
  1059. # Add auxiliary text as prefix for caption
  1060. if item.auxiliary_text:
  1061. caption_formatted_body = (
  1062. f"<p>{html.escape(item.auxiliary_text)}</p>{caption_formatted_body}"
  1063. )
  1064. caption_body = f"{item.auxiliary_text}\n\n{caption_body}"
  1065. caption = TextMessageEventContent(
  1066. msgtype=MessageType.TEXT,
  1067. body=caption_body,
  1068. formatted_body=caption_formatted_body,
  1069. format=Format.HTML,
  1070. )
  1071. if media.target_url:
  1072. content.external_url = media.target_url
  1073. caption.external_url = media.target_url
  1074. if self.bridge.config["bridge.caption_in_message"]:
  1075. if isinstance(content, TextMessageEventContent):
  1076. content.ensure_has_html()
  1077. caption.ensure_has_html()
  1078. content.body += f"\n\n{caption.body}"
  1079. content.formatted_body = (
  1080. f"<p><b>{content.formatted_body}</b></p>{caption.formatted_body}"
  1081. )
  1082. else:
  1083. content["filename"] = content.body
  1084. content.body = caption.body
  1085. content["format"] = str(Format.HTML)
  1086. content["formatted_body"] = caption.formatted_body
  1087. content["org.matrix.msc1767.caption"] = {
  1088. "org.matrix.msc1767.text": content.body,
  1089. "org.matrix.msc1767.html": content["formatted_body"],
  1090. }
  1091. return [(EventType.ROOM_MESSAGE, content)]
  1092. else:
  1093. return [(EventType.ROOM_MESSAGE, content), (EventType.ROOM_MESSAGE, caption)]
  1094. # TODO this is probably unused
  1095. async def _convert_instagram_reel_share(
  1096. self, source: u.User, intent: IntentAPI, item: ThreadItem
  1097. ) -> list[ConvertedMessage]:
  1098. assert item.reel_share
  1099. media = item.reel_share.media
  1100. prefix_html = None
  1101. if item.reel_share.type == ReelShareType.REPLY:
  1102. if item.reel_share.reel_owner_id == source.igpk:
  1103. prefix = "Replied to your story"
  1104. else:
  1105. username = media.user.username
  1106. prefix = f"Sent @{username}'s story"
  1107. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1108. prefix_html = f"Sent {user_link}'s story"
  1109. elif item.reel_share.type == ReelShareType.REACTION:
  1110. if item.reel_share.reel_owner_id == source.igpk:
  1111. prefix = "Reacted to your story"
  1112. elif item.user_id == source.igpk:
  1113. prefix = "You reacted to their story"
  1114. else:
  1115. prefix = "Reacted to a story"
  1116. elif item.reel_share.type == ReelShareType.MENTION:
  1117. if item.reel_share.mentioned_user_id == source.igpk:
  1118. prefix = "Mentioned you in their story"
  1119. else:
  1120. prefix = "You mentioned them in your story"
  1121. else:
  1122. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  1123. return []
  1124. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  1125. if prefix_html:
  1126. prefix_content.format = Format.HTML
  1127. prefix_content.formatted_body = prefix_html
  1128. caption_content = TextMessageEventContent(
  1129. msgtype=MessageType.TEXT, body=item.reel_share.text
  1130. )
  1131. if not caption_content.body and isinstance(media, MediaShareItem):
  1132. caption_content.body = media.caption.text if media.caption else ""
  1133. if not caption_content.body:
  1134. caption_content.body = "<no caption>"
  1135. media_content = None
  1136. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  1137. if isinstance(media, ExpiredMediaItem):
  1138. media_content = TextMessageEventContent(
  1139. msgtype=MessageType.NOTICE, body="Story expired"
  1140. )
  1141. else:
  1142. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  1143. if existing:
  1144. # If the user already reacted or replied to the same reel share item,
  1145. # use a Matrix reply instead of reposting the image.
  1146. caption_content.set_reply(existing.mxid)
  1147. else:
  1148. _, media_content = await self._convert_instagram_media(source, intent, item)
  1149. if self.bridge.config["bridge.caption_in_message"]:
  1150. if media_content:
  1151. if isinstance(media_content, TextMessageEventContent):
  1152. media_content.ensure_has_html()
  1153. prefix_content.ensure_has_html()
  1154. caption_content.ensure_has_html()
  1155. combined = TextMessageEventContent(
  1156. msgtype=MessageType.TEXT,
  1157. body="\n".join(
  1158. (media_content.body, prefix_content.body, caption_content.body)
  1159. ),
  1160. formatted_body=(
  1161. f"<p><b>{media_content.formatted_body}</b></p>"
  1162. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1163. f"<p>{caption_content.formatted_body}</p>"
  1164. ),
  1165. format=Format.HTML,
  1166. )
  1167. else:
  1168. prefix_content.ensure_has_html()
  1169. caption_content.ensure_has_html()
  1170. combined_body = "\n".join((prefix_content.body, caption_content.body))
  1171. combined_formatted_body = (
  1172. f"<p><i>{prefix_content.formatted_body}</i></p>"
  1173. f"<p>{caption_content.formatted_body}</p>"
  1174. )
  1175. combined = media_content
  1176. combined["filename"] = combined.body
  1177. combined.body = combined_body
  1178. combined["format"] = str(Format.HTML)
  1179. combined["org.matrix.msc1767.caption"] = {
  1180. "org.matrix.msc1767.text": combined_body,
  1181. "org.matrix.msc1767.html": combined_formatted_body,
  1182. }
  1183. combined["formatted_body"] = combined_formatted_body
  1184. else:
  1185. combined = caption_content
  1186. return [(EventType.ROOM_MESSAGE, combined)]
  1187. else:
  1188. await self._send_message(intent, prefix_content, timestamp=item.timestamp_ms)
  1189. converted: list[ConvertedMessage] = []
  1190. if media_content:
  1191. converted.append((EventType.ROOM_MESSAGE, media_content))
  1192. converted.append((EventType.ROOM_MESSAGE, caption_content))
  1193. return converted
  1194. async def _convert_instagram_link(
  1195. self,
  1196. source: u.User,
  1197. intent: IntentAPI,
  1198. item: ThreadItem,
  1199. ) -> ConvertedMessage:
  1200. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.link.text)
  1201. link = item.link.link_context
  1202. preview = {
  1203. "og:url": link.link_url,
  1204. "og:title": link.link_title,
  1205. "og:description": link.link_summary,
  1206. }
  1207. if link.link_image_url:
  1208. reuploaded = await self._reupload_instagram_file(
  1209. source, link.link_image_url, msgtype=None, info=ImageInfo(), intent=intent
  1210. )
  1211. preview["og:image"] = reuploaded.url
  1212. preview["og:image:type"] = reuploaded.info.mimetype
  1213. preview["og:image:width"] = reuploaded.info.width
  1214. preview["og:image:height"] = reuploaded.info.height
  1215. preview["matrix:image:size"] = reuploaded.info.size
  1216. if reuploaded.file:
  1217. preview["beeper:image:encryption"] = reuploaded.file.serialize()
  1218. preview = {k: v for k, v in preview.items() if v}
  1219. content["com.beeper.linkpreviews"] = [preview] if "og:title" in preview else []
  1220. await self._add_instagram_reply(content, item.replied_to_message)
  1221. return EventType.ROOM_MESSAGE, content
  1222. async def _convert_expired_placeholder(
  1223. self, source: u.User, item: ThreadItem, action: str
  1224. ) -> ConvertedMessage:
  1225. if item.user_id == source.igpk:
  1226. prefix = f"{action} your story"
  1227. elif item.user_id == source.igpk:
  1228. prefix = f"You {action.lower()} their story"
  1229. else:
  1230. prefix = f"{action} a story"
  1231. body = f"{prefix}\n\nNo longer available"
  1232. html = f"<p>{prefix}</p><p><i>No longer available</i></p>"
  1233. content = TextMessageEventContent(
  1234. msgtype=MessageType.NOTICE, body=body, format=Format.HTML, formatted_body=html
  1235. )
  1236. return EventType.ROOM_MESSAGE, content
  1237. async def _convert_instagram_text(self, item: ThreadItem, text: str) -> ConvertedMessage:
  1238. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  1239. content["com.beeper.linkpreviews"] = []
  1240. await self._add_instagram_reply(content, item.replied_to_message)
  1241. return EventType.ROOM_MESSAGE, content
  1242. async def _convert_instagram_unhandled(self, item: ThreadItem) -> ConvertedMessage:
  1243. content = TextMessageEventContent(
  1244. msgtype=MessageType.NOTICE, body=f"Unsupported message type {item.item_type.value}"
  1245. )
  1246. await self._add_instagram_reply(content, item.replied_to_message)
  1247. return EventType.ROOM_MESSAGE, content
  1248. async def _convert_instagram_location(self, item: ThreadItem) -> ConvertedMessage | None:
  1249. loc = item.location
  1250. if not loc or not loc.lng or not loc.lat:
  1251. # TODO handle somehow
  1252. return None
  1253. long_char = "E" if loc.lng > 0 else "W"
  1254. lat_char = "N" if loc.lat > 0 else "S"
  1255. body = (
  1256. f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  1257. f"{round(abs(loc.lng), 4)}° {long_char}"
  1258. )
  1259. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  1260. external_url = None
  1261. if loc.external_source == "facebook_places":
  1262. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  1263. content = LocationMessageEventContent(
  1264. msgtype=MessageType.LOCATION,
  1265. geo_uri=f"geo:{loc.lat},{loc.lng}",
  1266. body=f"Location: {body}\n{url}",
  1267. external_url=external_url,
  1268. )
  1269. content["format"] = str(Format.HTML)
  1270. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  1271. await self._add_instagram_reply(content, item.replied_to_message)
  1272. return EventType.ROOM_MESSAGE, content
  1273. async def _convert_instagram_profile(self, item: ThreadItem) -> ConvertedMessage:
  1274. username = item.profile.username
  1275. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  1276. text = f"Shared @{username}'s profile"
  1277. html = f"Shared {user_link}'s profile"
  1278. content = TextMessageEventContent(
  1279. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1280. )
  1281. await self._add_instagram_reply(content, item.replied_to_message)
  1282. return EventType.ROOM_MESSAGE, content
  1283. async def _convert_instagram_xma_profile_share(
  1284. self, item: ThreadItem
  1285. ) -> list[ConvertedMessage]:
  1286. assert item.xma_profile
  1287. profile_messages = []
  1288. for profile in item.xma_profile:
  1289. username = profile.header_title_text
  1290. user_link = f'<a href="{profile.target_url}">@{username}</a>'
  1291. text = f"Shared @{username}'s profile"
  1292. html = f"Shared {user_link}'s profile"
  1293. content = TextMessageEventContent(
  1294. msgtype=MessageType.TEXT, format=Format.HTML, body=text, formatted_body=html
  1295. )
  1296. await self._add_instagram_reply(content, item.replied_to_message)
  1297. profile_messages.append((EventType.ROOM_MESSAGE, content))
  1298. return profile_messages
  1299. async def _add_instagram_reply(
  1300. self, content: MessageEventContent, reply_to: ThreadItem | None
  1301. ) -> None:
  1302. if not reply_to:
  1303. return
  1304. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  1305. if not message:
  1306. return
  1307. content.set_reply(message.mxid)
  1308. if not isinstance(content, TextMessageEventContent):
  1309. return
  1310. try:
  1311. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  1312. except (MNotFound, MForbidden):
  1313. evt = None
  1314. if not evt:
  1315. return
  1316. if evt.type == EventType.ROOM_ENCRYPTED:
  1317. try:
  1318. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  1319. except SessionNotFound:
  1320. return
  1321. if isinstance(evt.content, TextMessageEventContent):
  1322. evt.content.trim_reply_fallback()
  1323. content.set_reply(evt)
  1324. async def handle_instagram_item(
  1325. self, source: u.User, sender: p.Puppet, item: MessageSyncMessage
  1326. ):
  1327. client_context = item.client_context
  1328. link_client_context = item.link.client_context if item.link else None
  1329. cc = client_context
  1330. if link_client_context:
  1331. if not client_context:
  1332. cc = f"link:{link_client_context}"
  1333. elif client_context != link_client_context:
  1334. cc = f"{client_context}/link:{link_client_context}"
  1335. if client_context and client_context in self._reqid_dedup:
  1336. self.log.debug(
  1337. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1338. " as it was sent by us (client_context in dedup queue)"
  1339. )
  1340. return []
  1341. elif link_client_context and link_client_context in self._reqid_dedup:
  1342. self.log.debug(
  1343. f"Ignoring message {item.item_id} ({cc}) by {item.user_id}"
  1344. " as it was sent by us (link.client_context in dedup queue)"
  1345. )
  1346. return []
  1347. # Check in-memory queues for duplicates
  1348. if item.item_id in self._msgid_dedup:
  1349. self.log.debug(
  1350. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1351. " as it was already handled (message.id in dedup queue)"
  1352. )
  1353. return
  1354. self._msgid_dedup.appendleft(item.item_id)
  1355. # Check database for duplicates
  1356. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1357. self.log.debug(
  1358. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1359. " as it was already handled (message.id in database)"
  1360. )
  1361. return
  1362. self.log.debug(
  1363. f"Handling Instagram message {item.item_id} ({item.client_context}) by {item.user_id}"
  1364. )
  1365. if not self.mxid:
  1366. thread = await source.client.get_thread(item.thread_id)
  1367. mxid = await self.create_matrix_room(source, thread.thread)
  1368. if not mxid:
  1369. # Failed to create
  1370. return
  1371. if self.config["bridge.backfill.enable"]:
  1372. if self.config["bridge.backfill.msc2716"]:
  1373. await self.enqueue_immediate_backfill(source, 0)
  1374. intent = sender.intent_for(self)
  1375. asyncio.create_task(intent.set_typing(self.mxid, timeout=0))
  1376. event_ids = []
  1377. for event_type, content in await self.convert_instagram_item(source, sender, item):
  1378. event_ids.append(
  1379. await self._send_message(
  1380. intent, content, event_type=event_type, timestamp=item.timestamp_ms
  1381. )
  1382. )
  1383. event_ids = [event_id for event_id in event_ids if event_id]
  1384. if not event_ids:
  1385. self.log.warning(f"Unhandled Instagram message {item.item_id}")
  1386. return
  1387. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_ids}")
  1388. await DBMessage(
  1389. mxid=event_ids[-1],
  1390. mx_room=self.mxid,
  1391. item_id=item.item_id,
  1392. client_context=item.client_context,
  1393. receiver=self.receiver,
  1394. sender=sender.igpk,
  1395. ig_timestamp=item.timestamp,
  1396. ).insert()
  1397. await self._send_delivery_receipt(event_ids[-1])
  1398. async def convert_instagram_item(
  1399. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1400. ) -> list[ConvertedMessage]:
  1401. if not isinstance(item, ThreadItem):
  1402. # Parsing these items failed, they should have been logged already
  1403. return []
  1404. try:
  1405. return await self._convert_instagram_item(source, sender, item)
  1406. except Exception:
  1407. self.log.exception("Fatal error converting Instagram item")
  1408. self.log.trace("Item content: %s", item.serialize())
  1409. return []
  1410. async def _convert_instagram_item(
  1411. self, source: u.User, sender: p.Puppet, item: ThreadItem
  1412. ) -> list[ConvertedMessage]:
  1413. intent = sender.intent_for(self)
  1414. if (
  1415. item.xma_media_share
  1416. or item.xma_reel_share
  1417. or item.xma_reel_mention
  1418. or item.xma_story_share
  1419. or item.generic_xma
  1420. ):
  1421. return await self._convert_instagram_xma_media_share(source, intent, item)
  1422. converted: list[ConvertedMessage] = []
  1423. handle_text = True
  1424. if item.media or item.animated_media or item.voice_media or item.visual_media:
  1425. converted.append(await self._convert_instagram_media(source, intent, item))
  1426. elif item.location:
  1427. if loc_content := await self._convert_instagram_location(item):
  1428. converted.append(loc_content)
  1429. elif item.profile:
  1430. converted.append(await self._convert_instagram_profile(item))
  1431. elif item.xma_profile:
  1432. converted.extend(await self._convert_instagram_xma_profile_share(item))
  1433. elif item.reel_share:
  1434. converted.extend(await self._convert_instagram_reel_share(source, intent, item))
  1435. elif (
  1436. item.media_share
  1437. or item.direct_media_share
  1438. or item.story_share
  1439. or item.clip
  1440. or item.felix_share
  1441. ):
  1442. converted.extend(await self._convert_instagram_media_share(source, intent, item))
  1443. elif item.item_type == ThreadItemType.EXPIRED_PLACEHOLDER:
  1444. if item.message_item_type == "reaction":
  1445. action = "Reacted to"
  1446. else:
  1447. action = "Shared"
  1448. msg_type, expired = await self._convert_expired_placeholder(source, item, action)
  1449. if self.bridge.config["bridge.caption_in_message"] and item.text:
  1450. _, text = await self._convert_instagram_text(item, item.text)
  1451. expired.ensure_has_html()
  1452. text.ensure_has_html()
  1453. combined = TextMessageEventContent(
  1454. msgtype=MessageType.TEXT,
  1455. body="\n".join((expired.body, text.body)),
  1456. formatted_body=f"{expired.formatted_body}<p>{text.formatted_body}</p>",
  1457. format=Format.HTML,
  1458. )
  1459. handle_text = False
  1460. converted.append((msg_type, combined))
  1461. else:
  1462. converted.append((msg_type, expired))
  1463. elif item.action_log:
  1464. # These probably don't need to be bridged
  1465. self.log.debug(f"Ignoring action log message {item.item_id}")
  1466. return []
  1467. # TODO handle item.clip?
  1468. # TODO should these be put into a caption?
  1469. if handle_text and item.text:
  1470. converted.append(await self._convert_instagram_text(item, item.text))
  1471. elif item.like:
  1472. # We handle likes as text because Matrix clients do big emoji on their own.
  1473. converted.append(await self._convert_instagram_text(item, item.like))
  1474. elif item.link:
  1475. converted.append(await self._convert_instagram_link(source, intent, item))
  1476. if len(converted) == 0:
  1477. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  1478. converted.append(await self._convert_instagram_unhandled(item))
  1479. return converted
  1480. def _deterministic_event_id(
  1481. self, sender: p.Puppet, item_id: str, part_name: int | None = None
  1482. ) -> EventID:
  1483. hash_content = f"{self.mxid}/instagram/{sender.igpk}/{item_id}"
  1484. if part_name:
  1485. hash_content += f"/{part_name}"
  1486. hashed = hashlib.sha256(hash_content.encode("utf-8")).digest()
  1487. b64hash = base64.urlsafe_b64encode(hashed).decode("utf-8").rstrip("=")
  1488. return EventID(f"${b64hash}:instagram.com")
  1489. async def handle_instagram_remove(self, item_id: str) -> None:
  1490. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  1491. if message is None:
  1492. return
  1493. await message.delete()
  1494. if message.mxid:
  1495. sender = await p.Puppet.get_by_pk(message.sender)
  1496. try:
  1497. await sender.intent_for(self).redact(self.mxid, message.mxid)
  1498. except MForbidden:
  1499. await self.main_intent.redact(self.mxid, message.mxid)
  1500. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  1501. async def handle_instagram_reaction(self, item: ThreadItem, remove: bool) -> None:
  1502. sender = await p.Puppet.get_by_pk(item.new_reaction.sender_id)
  1503. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1504. if not message:
  1505. self.log.debug(f"Dropping reaction by {sender.pk} to unknown message {item.item_id}")
  1506. return
  1507. emoji = item.new_reaction.emoji
  1508. async with self._reaction_lock:
  1509. existing = await DBReaction.get_by_item_id(item.item_id, self.receiver, sender.pk)
  1510. if not existing and remove:
  1511. self.log.debug(
  1512. f"Ignoring duplicate reaction removal by {sender.pk} to {item.item_id}"
  1513. )
  1514. return
  1515. elif not remove and existing and existing.reaction == emoji:
  1516. self.log.debug(f"Ignoring duplicate reaction by {sender.pk} to {item.item_id}")
  1517. return
  1518. intent = sender.intent_for(self)
  1519. if remove:
  1520. await existing.delete()
  1521. await intent.redact(self.mxid, existing.mxid)
  1522. self.log.debug(
  1523. f"Removed {sender.pk}'s reaction to {item.item_id} (redacted {existing.mxid})"
  1524. )
  1525. else:
  1526. timestamp = item.new_reaction.timestamp_ms
  1527. reaction_event_id = await intent.react(
  1528. self.mxid, message.mxid, key=emoji, timestamp=timestamp
  1529. )
  1530. await self._upsert_reaction(
  1531. existing, intent, reaction_event_id, message, sender, emoji, timestamp
  1532. )
  1533. self.log.debug(
  1534. f"Handled {sender.pk}'s reaction to {item.item_id} -> {reaction_event_id}"
  1535. )
  1536. async def _handle_instagram_reactions(
  1537. self, message: DBMessage, reactions: list[Reaction]
  1538. ) -> None:
  1539. old_reactions: dict[int, DBReaction]
  1540. old_reactions = {
  1541. reaction.ig_sender: reaction
  1542. for reaction in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)
  1543. }
  1544. for new_reaction in reactions:
  1545. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  1546. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  1547. continue
  1548. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  1549. intent = puppet.intent_for(self)
  1550. timestamp = int(time.time() * 1000)
  1551. reaction_event_id = await intent.react(
  1552. self.mxid, message.mxid, new_reaction.emoji, timestamp=timestamp
  1553. )
  1554. await self._upsert_reaction(
  1555. old_reaction,
  1556. intent,
  1557. reaction_event_id,
  1558. message,
  1559. puppet,
  1560. new_reaction.emoji,
  1561. timestamp,
  1562. )
  1563. for old_reaction in old_reactions.values():
  1564. await old_reaction.delete()
  1565. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  1566. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  1567. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  1568. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  1569. if not message:
  1570. return
  1571. if item.has_seen:
  1572. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  1573. if puppet:
  1574. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  1575. else:
  1576. async with self._reaction_lock:
  1577. await self._handle_instagram_reactions(
  1578. message, (item.reactions.emojis if item.reactions else [])
  1579. )
  1580. # endregion
  1581. # region Updating portal info
  1582. def _get_thread_name(self, thread: Thread) -> str:
  1583. if self.is_direct:
  1584. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  1585. return "Instagram chat with yourself"
  1586. elif len(thread.users) == 1:
  1587. tpl = self.config["bridge.private_chat_name_template"]
  1588. ui = thread.users[0]
  1589. return tpl.format(
  1590. displayname=ui.full_name or ui.username, id=ui.pk, username=ui.username
  1591. )
  1592. elif thread.thread_title:
  1593. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  1594. return ""
  1595. async def _get_thread_avatar(self, source: u.User, thread: Thread) -> Optional[ContentURI]:
  1596. if self.is_direct or not thread.thread_image:
  1597. return None
  1598. if self.thread_image_id == thread.thread_image.id:
  1599. return self.avatar_url
  1600. best: Optional[ThreadImageCandidate] = None
  1601. for candidate in thread.thread_image.image_versions2.candidates:
  1602. if best is None or candidate.width > best.width:
  1603. best = candidate
  1604. if not best:
  1605. return None
  1606. data, mimetype = await self._download_instagram_file(source, best.url)
  1607. if not data:
  1608. return None
  1609. mxc = await self.main_intent.upload_media(
  1610. data=data,
  1611. mime_type=mimetype,
  1612. filename=thread.thread_image.id,
  1613. async_upload=self.config["homeserver.async_media"],
  1614. )
  1615. self.thread_image_id = thread.thread_image.id
  1616. return mxc
  1617. async def update_info(self, thread: Thread, source: u.User) -> None:
  1618. changed = await self._update_name(self._get_thread_name(thread))
  1619. if thread_avatar := await self._get_thread_avatar(source, thread):
  1620. changed = await self._update_photo(thread_avatar)
  1621. changed = await self._update_participants(thread.users, source) or changed
  1622. if changed:
  1623. await self.update_bridge_info()
  1624. await self.update()
  1625. # TODO update power levels with thread.admin_user_ids
  1626. async def update_info_from_puppet(self, puppet: p.Puppet | None = None) -> None:
  1627. if not self.is_direct:
  1628. return
  1629. if not puppet:
  1630. puppet = await self.get_dm_puppet()
  1631. await self._update_photo_from_puppet(puppet)
  1632. if self.name and not self.name_set:
  1633. await self._update_name(self.name)
  1634. async def _update_name(self, name: str) -> bool:
  1635. if name and (self.name != name or not self.name_set):
  1636. self.name = name
  1637. if self.mxid:
  1638. try:
  1639. await self.main_intent.set_room_name(self.mxid, name)
  1640. self.name_set = True
  1641. except Exception:
  1642. self.log.exception("Failed to update name")
  1643. self.name_set = False
  1644. return True
  1645. return False
  1646. async def _update_photo_from_puppet(self, puppet: p.Puppet) -> bool:
  1647. if not self.private_chat_portal_meta and not self.encrypted:
  1648. return False
  1649. return await self._update_photo(puppet.photo_mxc)
  1650. async def _update_photo(self, photo_mxc: ContentURI) -> bool:
  1651. if self.avatar_set and self.avatar_url == photo_mxc:
  1652. return False
  1653. self.avatar_url = photo_mxc
  1654. if self.mxid:
  1655. try:
  1656. await self.main_intent.set_room_avatar(self.mxid, photo_mxc)
  1657. self.avatar_set = True
  1658. except Exception:
  1659. self.log.exception("Failed to set room avatar")
  1660. self.avatar_set = False
  1661. return True
  1662. async def _update_participants(self, users: list[ThreadUser], source: u.User) -> bool:
  1663. meta_changed = False
  1664. # Make sure puppets who should be here are here
  1665. for user in users:
  1666. puppet = await p.Puppet.get_by_pk(user.pk)
  1667. await puppet.update_info(user, source)
  1668. if self.mxid:
  1669. await puppet.intent_for(self).ensure_joined(self.mxid)
  1670. if puppet.pk == self.other_user_pk:
  1671. meta_changed = await self._update_photo_from_puppet(puppet)
  1672. if self.mxid:
  1673. # Kick puppets who shouldn't be here
  1674. current_members = {int(user.pk) for user in users}
  1675. for user_id in await self.main_intent.get_room_members(self.mxid):
  1676. pk = p.Puppet.get_id_from_mxid(user_id)
  1677. if pk and pk not in current_members and pk != self.other_user_pk:
  1678. await self.main_intent.kick_user(
  1679. self.mxid,
  1680. p.Puppet.get_mxid_from_id(pk),
  1681. reason="User had left this Instagram DM",
  1682. )
  1683. return meta_changed
  1684. async def _update_read_receipts(self, receipts: dict[int | str, ThreadUserLastSeenAt]) -> None:
  1685. for user_id, receipt in receipts.items():
  1686. message: DBMessage | DBReaction
  1687. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  1688. if not message:
  1689. reaction: DBReaction
  1690. message, reaction = await asyncio.gather(
  1691. DBMessage.get_closest(self.mxid, int(receipt.timestamp)),
  1692. DBReaction.get_closest(self.mxid, receipt.timestamp_ms),
  1693. )
  1694. if (not message or not message.mxid) and not reaction:
  1695. self.log.debug(
  1696. "Couldn't find message %s to mark as read by %s", receipt, user_id
  1697. )
  1698. continue
  1699. elif not message or (reaction and reaction.mx_timestamp > message.ig_timestamp_ms):
  1700. message = reaction
  1701. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  1702. if not puppet:
  1703. continue
  1704. try:
  1705. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  1706. except Exception:
  1707. self.log.warning(
  1708. f"Failed to mark {message.mxid} in {message.mx_room} "
  1709. f"as read by {puppet.intent.mxid}",
  1710. exc_info=True,
  1711. )
  1712. async def get_dm_puppet(self) -> p.Puppet | None:
  1713. if not self.is_direct:
  1714. return None
  1715. return await p.Puppet.get_by_pk(self.other_user_pk)
  1716. # endregion
  1717. # region Backfill
  1718. async def enqueue_immediate_backfill(self, source: u.User, priority: int) -> None:
  1719. assert self.config["bridge.backfill.msc2716"]
  1720. if not await Backfill.get(source.mxid, self.thread_id, self.receiver):
  1721. await Backfill.new(
  1722. source.mxid,
  1723. priority,
  1724. self.thread_id,
  1725. self.receiver,
  1726. self.config["bridge.backfill.incremental.max_pages"],
  1727. self.config["bridge.backfill.incremental.page_delay"],
  1728. self.config["bridge.backfill.incremental.post_batch_delay"],
  1729. self.config["bridge.backfill.incremental.max_total_pages"],
  1730. ).insert()
  1731. async def backfill(self, source: u.User, backfill_request: Backfill) -> None:
  1732. try:
  1733. last_message_ig_timestamp = await self._backfill(source, backfill_request)
  1734. if (
  1735. last_message_ig_timestamp is not None
  1736. and not self.bridge.homeserver_software.is_hungry
  1737. and self.config["bridge.backfill.msc2716"]
  1738. ):
  1739. await self.send_post_backfill_dummy(last_message_ig_timestamp)
  1740. finally:
  1741. # Always sleep after the backfill request is finished processing, even if it errors.
  1742. await asyncio.sleep(backfill_request.post_batch_delay)
  1743. async def _backfill(self, source: u.User, backfill_request: Backfill) -> int | None:
  1744. assert source.client
  1745. self.log.debug("Backfill request: %s", backfill_request)
  1746. num_pages = backfill_request.num_pages
  1747. self.log.debug(
  1748. "Backfilling up to %d pages of history in %s through %s",
  1749. num_pages,
  1750. self.mxid,
  1751. source.mxid,
  1752. )
  1753. try:
  1754. if self.cursor:
  1755. self.log.debug(
  1756. f"There is a cursor for the chat, fetching messages before {self.cursor}"
  1757. )
  1758. resp = await source.client.get_thread(
  1759. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1760. )
  1761. else:
  1762. self.log.debug(
  1763. "There is no first message in the chat, starting with the most recent messages"
  1764. )
  1765. resp = await source.client.get_thread(self.thread_id, seq_id=source.seq_id)
  1766. except IGRateLimitError as e:
  1767. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1768. self.log.warning(
  1769. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds before "
  1770. f"resuming. Error: {e}"
  1771. )
  1772. await asyncio.sleep(backoff)
  1773. raise
  1774. async def dedup_messages(messages: list[ThreadItem]) -> list[ThreadItem]:
  1775. deduped = []
  1776. # Sometimes (seems like on Facebook chats) it fetches the first message in the chat over
  1777. # and over again.
  1778. for item in messages:
  1779. # Check in-memory queues for duplicates
  1780. if item.item_id in self._msgid_dedup:
  1781. self.log.debug(
  1782. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1783. " as it was already handled (message.id in dedup queue)"
  1784. )
  1785. continue
  1786. self._msgid_dedup.appendleft(item.item_id)
  1787. # Check database for duplicates
  1788. if await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  1789. self.log.debug(
  1790. f"Ignoring message {item.item_id} ({item.client_context}) by {item.user_id}"
  1791. " as it was already handled (message.id in database)"
  1792. )
  1793. continue
  1794. deduped.append(item)
  1795. return deduped
  1796. messages = await dedup_messages(resp.thread.items)
  1797. cursor = resp.thread.oldest_cursor
  1798. backfill_more = resp.thread.has_older
  1799. if len(messages) == 0:
  1800. self.log.debug("No messages to backfill.")
  1801. return None
  1802. last_message_timestamp = messages[-1].timestamp_ms
  1803. pages_to_backfill = backfill_request.num_pages
  1804. if backfill_request.max_total_pages > -1:
  1805. pages_to_backfill = min(pages_to_backfill, backfill_request.max_total_pages)
  1806. pages_backfilled = 0
  1807. for i in range(pages_to_backfill):
  1808. base_insertion_event_id = await self.backfill_message_page(
  1809. source, list(reversed(messages))
  1810. )
  1811. self.cursor = cursor
  1812. await self.save()
  1813. pages_backfilled += 1
  1814. if base_insertion_event_id:
  1815. self.historical_base_insertion_event_id = base_insertion_event_id
  1816. await self.save()
  1817. if backfill_more and i < pages_to_backfill - 1:
  1818. # Sleep before fetching another page of messages.
  1819. await asyncio.sleep(backfill_request.page_delay)
  1820. # Fetch more messages
  1821. try:
  1822. resp = await source.client.get_thread(
  1823. self.thread_id, seq_id=source.seq_id, cursor=self.cursor
  1824. )
  1825. messages = await dedup_messages(resp.thread.items)
  1826. cursor = resp.thread.oldest_cursor
  1827. backfill_more &= resp.thread.has_older
  1828. except IGRateLimitError as e:
  1829. backoff = self.config.get("bridge.backfill.backoff.message_history", 300)
  1830. self.log.warning(
  1831. f"Backfilling failed due to rate limit. Waiting for {backoff} seconds "
  1832. "before resuming."
  1833. )
  1834. await asyncio.sleep(backoff)
  1835. # If we hit the rate limit, then we will want to give up for now, but enqueue
  1836. # additional backfill to do later.
  1837. break
  1838. if backfill_request.max_total_pages == -1:
  1839. new_max_total_pages = -1
  1840. else:
  1841. new_max_total_pages = backfill_request.max_total_pages - pages_backfilled
  1842. if new_max_total_pages <= 0:
  1843. backfill_more = False
  1844. if backfill_more:
  1845. self.log.debug("Enqueueing more backfill")
  1846. await Backfill.new(
  1847. source.mxid,
  1848. # Always enqueue subsequent backfills at the lowest priority
  1849. 2,
  1850. self.thread_id,
  1851. self.receiver,
  1852. backfill_request.num_pages,
  1853. backfill_request.page_delay,
  1854. backfill_request.post_batch_delay,
  1855. new_max_total_pages,
  1856. ).insert()
  1857. else:
  1858. self.log.debug("No more messages to backfill")
  1859. await self._update_read_receipts(resp.thread.last_seen_at)
  1860. return last_message_timestamp
  1861. async def backfill_message_page(
  1862. self,
  1863. source: u.User,
  1864. message_page: list[ThreadItem],
  1865. forward: bool = False,
  1866. last_message: DBMessage | None = None,
  1867. mark_read: bool = False,
  1868. ) -> EventID | None:
  1869. """
  1870. Backfills a page of messages to Matrix. The messages should be in order from oldest to
  1871. newest.
  1872. Returns: a tuple containing the number of messages that were actually bridged, the
  1873. timestamp of the oldest bridged message and the base insertion event ID if it exists.
  1874. """
  1875. assert source.client
  1876. if len(message_page) == 0:
  1877. return None
  1878. if forward:
  1879. assert (last_message and last_message.mxid) or self.first_event_id
  1880. prev_event_id = last_message.mxid if last_message else self.first_event_id
  1881. else:
  1882. assert self.config["bridge.backfill.msc2716"]
  1883. assert self.first_event_id
  1884. prev_event_id = self.first_event_id
  1885. assert self.mxid
  1886. oldest_message_in_page = message_page[0]
  1887. oldest_msg_timestamp = oldest_message_in_page.timestamp_ms
  1888. batch_messages: list[BatchSendEvent] = []
  1889. state_events_at_start: list[BatchSendStateEvent] = []
  1890. added_members = set()
  1891. current_members = await self.main_intent.state_store.get_members(
  1892. self.mxid, memberships=(Membership.JOIN,)
  1893. )
  1894. def add_member(puppet: p.Puppet, mxid: UserID):
  1895. assert self.mxid
  1896. if mxid in added_members:
  1897. return
  1898. if (
  1899. self.bridge.homeserver_software.is_hungry
  1900. or not self.config["bridge.backfill.msc2716"]
  1901. ):
  1902. # Hungryserv doesn't expect or check state events at start.
  1903. added_members.add(mxid)
  1904. return
  1905. content_args = {"avatar_url": puppet.photo_mxc, "displayname": puppet.name}
  1906. state_events_at_start.extend(
  1907. [
  1908. BatchSendStateEvent(
  1909. content=MemberStateEventContent(Membership.INVITE, **content_args),
  1910. type=EventType.ROOM_MEMBER,
  1911. sender=self.main_intent.mxid,
  1912. state_key=mxid,
  1913. timestamp=oldest_msg_timestamp,
  1914. ),
  1915. BatchSendStateEvent(
  1916. content=MemberStateEventContent(Membership.JOIN, **content_args),
  1917. type=EventType.ROOM_MEMBER,
  1918. sender=mxid,
  1919. state_key=mxid,
  1920. timestamp=oldest_msg_timestamp,
  1921. ),
  1922. ]
  1923. )
  1924. added_members.add(mxid)
  1925. async def intent_for(user_id: int) -> tuple[p.Puppet, IntentAPI]:
  1926. puppet: p.Puppet = await p.Puppet.get_by_pk(user_id)
  1927. if puppet:
  1928. intent = puppet.intent_for(self)
  1929. else:
  1930. intent = self.main_intent
  1931. if puppet.is_real_user and not self._can_double_puppet_backfill(intent.mxid):
  1932. intent = puppet.default_mxid_intent
  1933. return puppet, intent
  1934. message_infos: list[tuple[ThreadItem | Reaction, int]] = []
  1935. intents: list[IntentAPI] = []
  1936. for message in message_page:
  1937. puppet, intent = await intent_for(message.user_id)
  1938. # Convert the message
  1939. converted = await self.convert_instagram_item(source, puppet, message)
  1940. if not converted:
  1941. self.log.debug(f"Skipping unsupported message in backfill {message.item_id}")
  1942. continue
  1943. if intent.mxid not in current_members:
  1944. add_member(puppet, intent.mxid)
  1945. d_event_id = None
  1946. for index, (event_type, content) in enumerate(converted):
  1947. if self.encrypted and self.matrix.e2ee:
  1948. event_type, content = await self.matrix.e2ee.encrypt(
  1949. self.mxid, event_type, content
  1950. )
  1951. if intent.api.is_real_user and intent.api.bridge_name is not None:
  1952. content[DOUBLE_PUPPET_SOURCE_KEY] = intent.api.bridge_name
  1953. if self.bridge.homeserver_software.is_hungry:
  1954. d_event_id = self._deterministic_event_id(puppet, message.item_id, index)
  1955. message_infos.append((message, index))
  1956. batch_messages.append(
  1957. BatchSendEvent(
  1958. content=content,
  1959. type=event_type,
  1960. sender=intent.mxid,
  1961. timestamp=message.timestamp_ms,
  1962. event_id=d_event_id,
  1963. )
  1964. )
  1965. intents.append(intent)
  1966. if self.bridge.homeserver_software.is_hungry and message.reactions:
  1967. for reaction in message.reactions.emojis:
  1968. puppet, intent = await intent_for(reaction.sender_id)
  1969. reaction_event = ReactionEventContent()
  1970. reaction_event.relates_to = RelatesTo(
  1971. rel_type=RelationType.ANNOTATION, event_id=d_event_id, key=reaction.emoji
  1972. )
  1973. if intent.api.is_real_user and intent.api.bridge_name is not None:
  1974. reaction_event[DOUBLE_PUPPET_SOURCE_KEY] = intent.api.bridge_name
  1975. message_infos.append((reaction, 0))
  1976. batch_messages.append(
  1977. BatchSendEvent(
  1978. content=reaction_event,
  1979. type=EventType.REACTION,
  1980. sender=intent.mxid,
  1981. timestamp=reaction.timestamp_ms or message.timestamp_ms,
  1982. )
  1983. )
  1984. if not batch_messages:
  1985. return None
  1986. if (
  1987. not self.bridge.homeserver_software.is_hungry
  1988. and self.config["bridge.backfill.msc2716"]
  1989. and (forward or self.next_batch_id is None)
  1990. ):
  1991. self.log.debug("Sending dummy event to avoid forward extremity errors")
  1992. await self.az.intent.send_message_event(
  1993. self.mxid, EventType("fi.mau.dummy.pre_backfill", EventType.Class.MESSAGE), {}
  1994. )
  1995. self.log.info(
  1996. "Sending %d %s messages to %s with batch ID %s and previous event ID %s",
  1997. len(batch_messages),
  1998. "new" if forward else "historical",
  1999. self.mxid,
  2000. self.next_batch_id,
  2001. prev_event_id,
  2002. )
  2003. if self.bridge.homeserver_software.is_hungry:
  2004. self.log.debug("Batch message event IDs %s", [m.event_id for m in batch_messages])
  2005. base_insertion_event_id = None
  2006. if self.config["bridge.backfill.msc2716"]:
  2007. batch_send_resp = await self.main_intent.batch_send(
  2008. self.mxid,
  2009. prev_event_id,
  2010. batch_id=self.next_batch_id,
  2011. events=batch_messages,
  2012. state_events_at_start=state_events_at_start,
  2013. beeper_new_messages=forward,
  2014. beeper_mark_read_by=source.mxid if mark_read else None,
  2015. )
  2016. base_insertion_event_id = batch_send_resp.base_insertion_event_id
  2017. event_ids = batch_send_resp.event_ids
  2018. else:
  2019. batch_send_resp = None
  2020. event_ids = [
  2021. await intent.send_message_event(
  2022. self.mxid, evt.type, evt.content, timestamp=evt.timestamp
  2023. )
  2024. for evt, intent in zip(reversed(batch_messages), reversed(intents))
  2025. ]
  2026. await self._finish_batch(event_ids, message_infos)
  2027. if not forward:
  2028. assert batch_send_resp
  2029. self.log.debug("Got next batch ID %s for %s", batch_send_resp.next_batch_id, self.mxid)
  2030. self.next_batch_id = batch_send_resp.next_batch_id
  2031. await self.save()
  2032. return base_insertion_event_id
  2033. def _can_double_puppet_backfill(self, custom_mxid: UserID) -> bool:
  2034. return self.config["bridge.backfill.double_puppet_backfill"] and (
  2035. # Hungryserv can batch send any users
  2036. self.bridge.homeserver_software.is_hungry
  2037. # Non-MSC2716 backfill can use any double puppet
  2038. or not self.config["bridge.backfill.msc2716"]
  2039. # Local users can be double puppeted even with MSC2716
  2040. or (custom_mxid[custom_mxid.index(":") + 1 :] == self.config["homeserver.domain"])
  2041. )
  2042. async def _finish_batch(
  2043. self, event_ids: list[EventID], message_infos: list[tuple[ThreadItem | Reaction, int]]
  2044. ):
  2045. # We have to do this slightly annoying processing of the event IDs and message infos so
  2046. # that we only map the last event ID to the message.
  2047. # When inline captions are enabled, this will have no effect since index will always be 0
  2048. # since there's only ever one event per message.
  2049. current_message = None
  2050. messages = []
  2051. reactions = []
  2052. message_id = None
  2053. for event_id, (message_or_reaction, index) in zip(event_ids, message_infos):
  2054. if isinstance(message_or_reaction, ThreadItem):
  2055. message = message_or_reaction
  2056. if index == 0 and current_message:
  2057. # This means that all of the events for the previous message have been processed,
  2058. # and the current_message is the most recent event for that message.
  2059. messages.append(current_message)
  2060. current_message = DBMessage(
  2061. mxid=event_id,
  2062. mx_room=self.mxid,
  2063. item_id=message.item_id,
  2064. client_context=message.client_context,
  2065. receiver=self.receiver,
  2066. sender=message.user_id,
  2067. ig_timestamp=message.timestamp,
  2068. )
  2069. message_id = message.item_id
  2070. else:
  2071. assert message_id
  2072. reaction = message_or_reaction
  2073. reactions.append(
  2074. DBReaction(
  2075. mxid=event_id,
  2076. mx_room=self.mxid,
  2077. ig_item_id=message_id,
  2078. ig_receiver=self.receiver,
  2079. ig_sender=reaction.sender_id,
  2080. reaction=reaction.emoji,
  2081. mx_timestamp=reaction.timestamp_ms,
  2082. )
  2083. )
  2084. if current_message:
  2085. messages.append(current_message)
  2086. try:
  2087. await DBMessage.bulk_insert(messages)
  2088. except Exception:
  2089. self.log.exception("Failed to store batch message IDs")
  2090. try:
  2091. for reaction in reactions:
  2092. await reaction.insert()
  2093. except Exception:
  2094. self.log.exception("Failed to store backfilled reactions")
  2095. async def send_post_backfill_dummy(
  2096. self,
  2097. last_message_ig_timestamp: int,
  2098. base_insertion_event_id: EventID | None = None,
  2099. ):
  2100. if not self.config["bridge.backfill.msc2716"]:
  2101. return
  2102. assert self.mxid
  2103. if not base_insertion_event_id:
  2104. base_insertion_event_id = self.historical_base_insertion_event_id
  2105. if not base_insertion_event_id:
  2106. self.log.debug(
  2107. "No base insertion event ID in database or from batch send response. Not sending"
  2108. " dummy event."
  2109. )
  2110. return
  2111. event_id = await self.main_intent.send_message_event(
  2112. self.mxid,
  2113. event_type=HistorySyncMarkerMessage,
  2114. content={
  2115. "org.matrix.msc2716.marker.insertion": base_insertion_event_id,
  2116. "m.marker.insertion": base_insertion_event_id,
  2117. },
  2118. )
  2119. await DBMessage(
  2120. mxid=event_id,
  2121. mx_room=self.mxid,
  2122. item_id=f"fi.mau.instagram.post_backfill_dummy.{last_message_ig_timestamp}",
  2123. client_context=None,
  2124. receiver=self.receiver,
  2125. sender=0,
  2126. ig_timestamp=last_message_ig_timestamp,
  2127. ).insert()
  2128. # endregion
  2129. # region Bridge info state event
  2130. @property
  2131. def bridge_info_state_key(self) -> str:
  2132. return f"net.maunium.instagram://instagram/{self.thread_id}"
  2133. @property
  2134. def bridge_info(self) -> dict[str, Any]:
  2135. return {
  2136. "bridgebot": self.az.bot_mxid,
  2137. "creator": self.main_intent.mxid,
  2138. "protocol": {
  2139. "id": "instagram",
  2140. "displayname": "Instagram DM",
  2141. "avatar_url": self.config["appservice.bot_avatar"],
  2142. },
  2143. "channel": {
  2144. "id": self.thread_id,
  2145. "displayname": self.name,
  2146. "avatar_url": self.avatar_url,
  2147. },
  2148. }
  2149. async def update_bridge_info(self) -> None:
  2150. if not self.mxid:
  2151. self.log.debug("Not updating bridge info: no Matrix room created")
  2152. return
  2153. try:
  2154. self.log.debug("Updating bridge info...")
  2155. await self.main_intent.send_state_event(
  2156. self.mxid, StateBridge, self.bridge_info, self.bridge_info_state_key
  2157. )
  2158. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2159. await self.main_intent.send_state_event(
  2160. self.mxid, StateHalfShotBridge, self.bridge_info, self.bridge_info_state_key
  2161. )
  2162. except Exception:
  2163. self.log.warning("Failed to update bridge info", exc_info=True)
  2164. # endregion
  2165. # region Creating Matrix rooms
  2166. async def create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  2167. if self.mxid:
  2168. try:
  2169. await self.update_matrix_room(source, info)
  2170. except Exception:
  2171. self.log.exception("Failed to update portal")
  2172. return self.mxid
  2173. async with self._create_room_lock:
  2174. try:
  2175. return await self._create_matrix_room(source, info)
  2176. except Exception:
  2177. self.log.exception("Failed to create portal")
  2178. return None
  2179. def _get_invite_content(self, double_puppet: p.Puppet | None) -> dict[str, bool]:
  2180. invite_content = {}
  2181. if double_puppet:
  2182. invite_content["fi.mau.will_auto_accept"] = True
  2183. if self.is_direct:
  2184. invite_content["is_direct"] = True
  2185. return invite_content
  2186. async def update_matrix_room(self, source: u.User, info: Thread) -> None:
  2187. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2188. await self.main_intent.invite_user(
  2189. self.mxid,
  2190. source.mxid,
  2191. check_cache=True,
  2192. extra_content=self._get_invite_content(puppet),
  2193. )
  2194. if puppet:
  2195. did_join = await puppet.intent.ensure_joined(self.mxid)
  2196. if did_join and self.is_direct:
  2197. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2198. await self.update_info(info, source)
  2199. await self._update_read_receipts(info.last_seen_at)
  2200. async def _create_matrix_room(self, source: u.User, info: Thread) -> RoomID | None:
  2201. if self.mxid:
  2202. await self.update_matrix_room(source, info)
  2203. return self.mxid
  2204. await self.update_info(info, source)
  2205. self.log.debug("Creating Matrix room")
  2206. name: str | None = None
  2207. initial_state = [
  2208. {
  2209. "type": str(StateBridge),
  2210. "state_key": self.bridge_info_state_key,
  2211. "content": self.bridge_info,
  2212. },
  2213. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  2214. {
  2215. "type": str(StateHalfShotBridge),
  2216. "state_key": self.bridge_info_state_key,
  2217. "content": self.bridge_info,
  2218. },
  2219. ]
  2220. invites = []
  2221. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  2222. self.encrypted = True
  2223. initial_state.append(
  2224. {
  2225. "type": "m.room.encryption",
  2226. "content": self.get_encryption_state_event_json(),
  2227. }
  2228. )
  2229. if self.is_direct:
  2230. invites.append(self.az.bot_mxid)
  2231. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  2232. name = self.name
  2233. creation_content = {}
  2234. if not self.config["bridge.federate_rooms"]:
  2235. creation_content["m.federate"] = False
  2236. self.mxid = await self.main_intent.create_room(
  2237. name=name,
  2238. is_direct=self.is_direct,
  2239. initial_state=initial_state,
  2240. invitees=invites,
  2241. creation_content=creation_content,
  2242. )
  2243. if not self.mxid:
  2244. raise Exception("Failed to create room: no mxid returned")
  2245. if self.encrypted and self.matrix.e2ee and self.is_direct:
  2246. try:
  2247. await self.az.intent.ensure_joined(self.mxid)
  2248. except Exception:
  2249. self.log.warning(f"Failed to add bridge bot to new private chat {self.mxid}")
  2250. await self.update()
  2251. self.log.debug(f"Matrix room created: {self.mxid}")
  2252. self.by_mxid[self.mxid] = self
  2253. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  2254. await self.main_intent.invite_user(
  2255. self.mxid, source.mxid, extra_content=self._get_invite_content(puppet)
  2256. )
  2257. if puppet:
  2258. try:
  2259. if self.is_direct:
  2260. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  2261. await puppet.intent.join_room_by_id(self.mxid)
  2262. except MatrixError:
  2263. self.log.debug(
  2264. "Failed to join custom puppet into newly created portal", exc_info=True
  2265. )
  2266. await self._update_participants(info.users, source)
  2267. self.log.trace("Sending portal post-create dummy event")
  2268. self.first_event_id = await self.az.intent.send_message_event(
  2269. self.mxid, PortalCreateDummy, {}
  2270. )
  2271. await self.update()
  2272. return self.mxid
  2273. # endregion
  2274. # region Database getters
  2275. async def postinit(self) -> None:
  2276. self.by_thread_id[(self.thread_id, self.receiver)] = self
  2277. if self.mxid:
  2278. self.by_mxid[self.mxid] = self
  2279. self._main_intent = (
  2280. (await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  2281. if self.other_user_pk
  2282. else self.az.intent
  2283. )
  2284. async def delete(self) -> None:
  2285. await DBMessage.delete_all(self.mxid)
  2286. self.by_mxid.pop(self.mxid, None)
  2287. self.mxid = None
  2288. self.encrypted = False
  2289. await self.update()
  2290. async def save(self) -> None:
  2291. await self.update()
  2292. @classmethod
  2293. def all_with_room(cls) -> AsyncGenerator[Portal, None]:
  2294. return cls._db_to_portals(super().all_with_room())
  2295. @classmethod
  2296. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator[Portal, None]:
  2297. return cls._db_to_portals(super().find_private_chats_with(other_user))
  2298. @classmethod
  2299. async def find_private_chat(cls, receiver: int, other_user: int) -> Portal | None:
  2300. thread_id = await super().find_private_chat_id(receiver, other_user)
  2301. if not thread_id:
  2302. return None
  2303. return await cls.get_by_thread_id(thread_id, receiver=receiver, is_group=False)
  2304. @classmethod
  2305. async def _db_to_portals(cls, query: Awaitable[list[Portal]]) -> AsyncGenerator[Portal, None]:
  2306. portals = await query
  2307. for index, portal in enumerate(portals):
  2308. try:
  2309. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  2310. except KeyError:
  2311. await portal.postinit()
  2312. yield portal
  2313. @classmethod
  2314. @async_getter_lock
  2315. async def get_by_mxid(cls, mxid: RoomID) -> Portal | None:
  2316. try:
  2317. return cls.by_mxid[mxid]
  2318. except KeyError:
  2319. pass
  2320. portal = cast(cls, await super().get_by_mxid(mxid))
  2321. if portal is not None:
  2322. await portal.postinit()
  2323. return portal
  2324. return None
  2325. @classmethod
  2326. @async_getter_lock
  2327. async def get_by_thread_id(
  2328. cls,
  2329. thread_id: str,
  2330. *,
  2331. receiver: int,
  2332. is_group: bool | None = None,
  2333. other_user_pk: int | None = None,
  2334. ) -> Portal | None:
  2335. if is_group and receiver != 0:
  2336. receiver = 0
  2337. try:
  2338. return cls.by_thread_id[(thread_id, receiver)]
  2339. except KeyError:
  2340. pass
  2341. if is_group is None and receiver != 0:
  2342. try:
  2343. return cls.by_thread_id[(thread_id, 0)]
  2344. except KeyError:
  2345. pass
  2346. portal = cast(
  2347. cls,
  2348. await super().get_by_thread_id(
  2349. thread_id, receiver=receiver, rec_must_match=is_group is not None
  2350. ),
  2351. )
  2352. if portal is not None:
  2353. await portal.postinit()
  2354. return portal
  2355. if is_group is not None:
  2356. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  2357. await portal.insert()
  2358. await portal.postinit()
  2359. return portal
  2360. return None
  2361. @classmethod
  2362. async def get_by_thread(cls, thread: Thread, receiver: int) -> Portal | None:
  2363. if thread.is_group:
  2364. receiver = 0
  2365. other_user_pk = None
  2366. else:
  2367. if len(thread.users) == 0:
  2368. other_user_pk = receiver
  2369. else:
  2370. other_user_pk = thread.users[0].pk
  2371. return await cls.get_by_thread_id(
  2372. thread.thread_id,
  2373. receiver=receiver,
  2374. is_group=thread.is_group,
  2375. other_user_pk=other_user_pk,
  2376. )
  2377. # endregion