portal.py 114 KB

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