portal.py 111 KB

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