portal.py 111 KB

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