portal.py 107 KB

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