portal.py 111 KB

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