portal.py 107 KB

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