portal.py 108 KB

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