portal.py 106 KB

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