portal.py 107 KB

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