portal.py 112 KB

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