portal.py 111 KB

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