portal.py 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256
  1. # mautrix-instagram - A Matrix-Instagram puppeting bridge.
  2. # Copyright (C) 2021 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 typing import (Dict, Tuple, Optional, List, Deque, Set, Any, Union, AsyncGenerator,
  17. Awaitable, Callable, TYPE_CHECKING, cast)
  18. from collections import deque
  19. from io import BytesIO
  20. import mimetypes
  21. import asyncio
  22. import asyncpg
  23. import magic
  24. from mautrix.types.event.message import Audio, ExtensibleFile, Voice
  25. from mautrix.util.message_send_checkpoint import MessageSendCheckpointStatus
  26. from mauigpapi.types import (Thread, ThreadUser, ThreadItem, RegularMediaItem, MediaType,
  27. ReactionStatus, Reaction, AnimatedMediaItem, ThreadItemType,
  28. VoiceMediaItem, ExpiredMediaItem, MessageSyncMessage, ReelShareType,
  29. TypingStatus, ThreadUserLastSeenAt, MediaShareItem, ReelMediaShareItem)
  30. from mautrix.appservice import AppService, IntentAPI
  31. from mautrix.bridge import BasePortal, NotificationDisabler, async_getter_lock
  32. from mautrix.types import (EventID, MessageEventContent, RoomID, EventType, MessageType, ImageInfo,
  33. VideoInfo, MediaMessageEventContent, TextMessageEventContent, AudioInfo,
  34. ContentURI, LocationMessageEventContent, Format, UserID)
  35. from mautrix.errors import MatrixError, MForbidden, MNotFound, SessionNotFound
  36. from mautrix.util.simple_lock import SimpleLock
  37. from .db import Portal as DBPortal, Message as DBMessage, Reaction as DBReaction
  38. from .config import Config
  39. from . import user as u, puppet as p, matrix as m
  40. if TYPE_CHECKING:
  41. from .__main__ import InstagramBridge
  42. try:
  43. from mautrix.crypto.attachments import encrypt_attachment, decrypt_attachment
  44. except ImportError:
  45. encrypt_attachment = decrypt_attachment = None
  46. try:
  47. from PIL import Image
  48. except ImportError:
  49. Image = None
  50. StateBridge = EventType.find("m.bridge", EventType.Class.STATE)
  51. StateHalfShotBridge = EventType.find("uk.half-shot.bridge", EventType.Class.STATE)
  52. FileInfo = Union[AudioInfo, ImageInfo, VideoInfo]
  53. MediaData = Union[
  54. AnimatedMediaItem,
  55. ExpiredMediaItem,
  56. MediaShareItem,
  57. ReelMediaShareItem,
  58. RegularMediaItem,
  59. VoiceMediaItem,
  60. ]
  61. MediaUploadFunc = Callable[['u.User', MediaData, IntentAPI], Awaitable[MediaMessageEventContent]]
  62. class Portal(DBPortal, BasePortal):
  63. by_mxid: Dict[RoomID, 'Portal'] = {}
  64. by_thread_id: Dict[Tuple[str, int], 'Portal'] = {}
  65. config: Config
  66. matrix: 'm.MatrixHandler'
  67. az: AppService
  68. private_chat_portal_meta: bool
  69. _main_intent: Optional[IntentAPI]
  70. _create_room_lock: asyncio.Lock
  71. backfill_lock: SimpleLock
  72. _msgid_dedup: Deque[str]
  73. _reqid_dedup: Set[str]
  74. _reaction_dedup: Deque[Tuple[str, int, str]]
  75. _main_intent: IntentAPI
  76. _last_participant_update: Set[int]
  77. _reaction_lock: asyncio.Lock
  78. _backfill_leave: Optional[Set[IntentAPI]]
  79. _typing: Set[UserID]
  80. def __init__(self, thread_id: str, receiver: int, other_user_pk: Optional[int],
  81. mxid: Optional[RoomID] = None, name: Optional[str] = None,
  82. avatar_url: Optional[ContentURI] = None, encrypted: bool = False,
  83. name_set: bool = False, avatar_set: bool = False,
  84. relay_user_id: Optional[UserID] = None) -> None:
  85. super().__init__(thread_id, receiver, other_user_pk, mxid, name, avatar_url, encrypted,
  86. name_set, avatar_set, relay_user_id)
  87. self._create_room_lock = asyncio.Lock()
  88. self.log = self.log.getChild(thread_id)
  89. self._msgid_dedup = deque(maxlen=100)
  90. self._reaction_dedup = deque(maxlen=100)
  91. self._reqid_dedup = set()
  92. self._last_participant_update = set()
  93. self.backfill_lock = SimpleLock("Waiting for backfilling to finish before handling %s",
  94. log=self.log)
  95. self._backfill_leave = None
  96. self._main_intent = None
  97. self._reaction_lock = asyncio.Lock()
  98. self._typing = set()
  99. self._relay_user = None
  100. @property
  101. def is_direct(self) -> bool:
  102. return self.other_user_pk is not None
  103. @property
  104. def main_intent(self) -> IntentAPI:
  105. if not self._main_intent:
  106. raise ValueError("Portal must be postinit()ed before main_intent can be used")
  107. return self._main_intent
  108. @classmethod
  109. def init_cls(cls, bridge: 'InstagramBridge') -> None:
  110. cls.config = bridge.config
  111. cls.matrix = bridge.matrix
  112. cls.az = bridge.az
  113. cls.loop = bridge.loop
  114. cls.bridge = bridge
  115. cls.private_chat_portal_meta = cls.config["bridge.private_chat_portal_meta"]
  116. NotificationDisabler.puppet_cls = p.Puppet
  117. NotificationDisabler.config_enabled = cls.config["bridge.backfill.disable_notifications"]
  118. # region Misc
  119. async def _send_delivery_receipt(self, event_id: EventID) -> None:
  120. if event_id and self.config["bridge.delivery_receipts"]:
  121. try:
  122. await self.az.intent.mark_read(self.mxid, event_id)
  123. except Exception:
  124. self.log.exception("Failed to send delivery receipt for %s", event_id)
  125. async def _send_bridge_error(self, sender: 'u.User', err: Union[Exception, str],
  126. event_id: EventID, event_type: EventType,
  127. message_type: Optional[MessageType] = None,
  128. msg: Optional[str] = None, confirmed: bool = False,
  129. status: MessageSendCheckpointStatus = MessageSendCheckpointStatus.PERM_FAILURE,
  130. ) -> None:
  131. sender.send_remote_checkpoint(
  132. status,
  133. event_id,
  134. self.mxid,
  135. event_type,
  136. message_type=message_type,
  137. error=err,
  138. )
  139. if self.config["bridge.delivery_error_reports"]:
  140. event_type_str = {
  141. EventType.REACTION: "reaction",
  142. EventType.ROOM_REDACTION: "redaction",
  143. }.get(event_type, "message")
  144. error_type = "was not" if confirmed else "may not have been"
  145. await self._send_message(self.main_intent, TextMessageEventContent(
  146. msgtype=MessageType.NOTICE,
  147. body=f"\u26a0 Your {event_type_str} {error_type} bridged: {msg or str(err)}"))
  148. async def _upsert_reaction(self, existing: Optional[DBReaction], intent: IntentAPI,
  149. mxid: EventID, message: DBMessage,
  150. sender: Union['u.User', 'p.Puppet'], reaction: str) -> None:
  151. if existing:
  152. self.log.debug(f"_upsert_reaction redacting {existing.mxid} and inserting {mxid}"
  153. f" (message: {message.mxid})")
  154. await intent.redact(existing.mx_room, existing.mxid)
  155. await existing.edit(reaction=reaction, mxid=mxid, mx_room=message.mx_room)
  156. else:
  157. self.log.debug(f"_upsert_reaction inserting {mxid} (message: {message.mxid})")
  158. await DBReaction(mxid=mxid, mx_room=message.mx_room, ig_item_id=message.item_id,
  159. ig_receiver=self.receiver, ig_sender=sender.igpk, reaction=reaction
  160. ).insert()
  161. # endregion
  162. # region Matrix event handling
  163. def _status_from_exception(self, e: Exception) -> MessageSendCheckpointStatus:
  164. if isinstance(e, NotImplementedError):
  165. return MessageSendCheckpointStatus.UNSUPPORTED
  166. return MessageSendCheckpointStatus.PERM_FAILURE
  167. async def handle_matrix_message(self, sender: 'u.User', message: MessageEventContent,
  168. event_id: EventID) -> None:
  169. try:
  170. await self._handle_matrix_message(sender, message, event_id)
  171. except Exception as e:
  172. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  173. await self._send_bridge_error(
  174. sender,
  175. e,
  176. event_id,
  177. EventType.ROOM_MESSAGE,
  178. message_type=message.msgtype,
  179. status=self._status_from_exception(e),
  180. confirmed=True,
  181. )
  182. async def _handle_matrix_message(self, orig_sender: 'u.User', message: MessageEventContent,
  183. event_id: EventID) -> None:
  184. sender, is_relay = await self.get_relay_sender(orig_sender, f"message {event_id}")
  185. assert sender, "user is not logged in"
  186. assert sender.is_connected, "You're not connected to Instagram"
  187. if is_relay:
  188. await self.apply_relay_message_format(orig_sender, message)
  189. request_id = sender.state.gen_client_context()
  190. self._reqid_dedup.add(request_id)
  191. self.log.debug(f"Handling Matrix message {event_id} from {sender.mxid}/{sender.igpk} "
  192. f"with request ID {request_id}")
  193. if message.msgtype in (MessageType.EMOTE, MessageType.TEXT):
  194. text = message.body
  195. if message.msgtype == MessageType.EMOTE:
  196. text = f"/me {text}"
  197. self.log.trace(f"Sending Matrix text from {event_id} with request ID {request_id}")
  198. resp = await sender.mqtt.send_text(self.thread_id, text=text,
  199. client_context=request_id)
  200. elif message.msgtype.is_media:
  201. if message.file and decrypt_attachment:
  202. data = await self.main_intent.download_media(message.file.url)
  203. data = decrypt_attachment(data, message.file.key.key,
  204. message.file.hashes.get("sha256"), message.file.iv)
  205. else:
  206. data = await self.main_intent.download_media(message.url)
  207. mime_type = message.info.mimetype or magic.from_buffer(data, mime=True)
  208. if mime_type != "image/jpeg" and mime_type.startswith("image/"):
  209. with BytesIO(data) as inp:
  210. img = Image.open(inp)
  211. with BytesIO() as out:
  212. img.convert("RGB").save(out, format="JPEG", quality=80)
  213. data = out.getvalue()
  214. mime_type = "image/jpeg"
  215. if mime_type == "image/jpeg":
  216. self.log.trace(f"Uploading photo from {event_id}")
  217. upload_resp = await sender.client.upload_jpeg_photo(data)
  218. self.log.trace(f"Broadcasting uploaded photo with request ID {request_id}")
  219. # TODO is it possible to do this with MQTT?
  220. resp = await sender.client.broadcast(self.thread_id,
  221. ThreadItemType.CONFIGURE_PHOTO,
  222. client_context=request_id,
  223. upload_id=upload_resp.upload_id,
  224. allow_full_aspect_ratio="1")
  225. else:
  226. raise NotImplementedError("Non-image files are currently not supported")
  227. else:
  228. raise NotImplementedError(f"Unknown message type {message.msgtype}")
  229. self.log.trace(f"Got response to message send {request_id}: {resp}")
  230. if resp.status != "ok":
  231. self.log.warning(f"Failed to handle {event_id}: {resp}")
  232. raise Exception(f"Failed to handle event. Error: {resp.payload.message}")
  233. else:
  234. sender.send_remote_checkpoint(
  235. status=MessageSendCheckpointStatus.SUCCESS,
  236. event_id=event_id,
  237. room_id=self.mxid,
  238. event_type=EventType.ROOM_MESSAGE,
  239. message_type=message.msgtype,
  240. )
  241. await self._send_delivery_receipt(event_id)
  242. self._msgid_dedup.appendleft(resp.payload.item_id)
  243. try:
  244. await DBMessage(mxid=event_id, mx_room=self.mxid, item_id=resp.payload.item_id,
  245. receiver=self.receiver, sender=sender.igpk).insert()
  246. except asyncpg.UniqueViolationError as e:
  247. self.log.warning(f"Error while persisting {event_id} "
  248. f"({resp.payload.client_context}) -> {resp.payload.item_id}: {e}")
  249. self._reqid_dedup.remove(request_id)
  250. self.log.debug(f"Handled Matrix message {event_id} ({resp.payload.client_context}) "
  251. f"-> {resp.payload.item_id}")
  252. async def handle_matrix_reaction(self, sender: 'u.User', event_id: EventID,
  253. reacting_to: EventID, emoji: str) -> None:
  254. try:
  255. await self._handle_matrix_reaction(sender, event_id, reacting_to, emoji)
  256. except Exception as e:
  257. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  258. await self._send_bridge_error(
  259. sender,
  260. e,
  261. event_id,
  262. EventType.REACTION,
  263. status=self._status_from_exception(e),
  264. confirmed=True,
  265. msg="Fatal error handling reaction (see logs for more details)",
  266. )
  267. async def _handle_matrix_reaction(self, sender: 'u.User', event_id: EventID,
  268. reacting_to: EventID, emoji: str) -> None:
  269. message = await DBMessage.get_by_mxid(reacting_to, self.mxid)
  270. if not message or message.is_internal:
  271. self.log.debug(f"Ignoring reaction to unknown event {reacting_to}")
  272. return
  273. if not await sender.is_logged_in():
  274. self.log.debug(f"Ignoring reaction by non-logged-in user {sender.mxid}")
  275. return
  276. existing = await DBReaction.get_by_item_id(message.item_id, message.receiver, sender.igpk)
  277. if existing and existing.reaction == emoji:
  278. sender.send_remote_checkpoint(
  279. status=MessageSendCheckpointStatus.SUCCESS,
  280. event_id=event_id,
  281. room_id=self.mxid,
  282. event_type=EventType.REACTION,
  283. )
  284. return
  285. dedup_id = (message.item_id, sender.igpk, emoji)
  286. self._reaction_dedup.appendleft(dedup_id)
  287. async with self._reaction_lock:
  288. try:
  289. resp = await sender.mqtt.send_reaction(self.thread_id, item_id=message.item_id,
  290. emoji=emoji)
  291. if resp.status != "ok":
  292. raise Exception(f"Failed to react to {event_id}: {resp}")
  293. except Exception as e:
  294. self.log.exception(f"Failed to handle {event_id}: {e}")
  295. raise
  296. else:
  297. sender.send_remote_checkpoint(
  298. status=MessageSendCheckpointStatus.SUCCESS,
  299. event_id=event_id,
  300. room_id=self.mxid,
  301. event_type=EventType.REACTION,
  302. )
  303. await self._send_delivery_receipt(event_id)
  304. self.log.trace(f"{sender.mxid} reacted to {message.item_id} with {emoji}")
  305. await self._upsert_reaction(existing, self.main_intent, event_id, message, sender,
  306. emoji)
  307. async def handle_matrix_redaction(self, orig_sender: 'u.User', event_id: EventID,
  308. redaction_event_id: EventID) -> None:
  309. sender = None
  310. try:
  311. sender, _ = await self.get_relay_sender(orig_sender, f"redaction {event_id}")
  312. if not sender:
  313. raise Exception("User is not logged in")
  314. await self._handle_matrix_redaction(sender, event_id, redaction_event_id)
  315. except Exception as e:
  316. self.log.exception(f"Fatal error handling Matrix event {event_id}: {e}")
  317. await self._send_bridge_error(
  318. sender or orig_sender,
  319. e,
  320. redaction_event_id,
  321. EventType.ROOM_REDACTION,
  322. status=self._status_from_exception(e),
  323. confirmed=True,
  324. )
  325. async def _handle_matrix_redaction(self, sender: 'u.User', event_id: EventID,
  326. redaction_event_id: EventID) -> None:
  327. if not sender.is_connected:
  328. raise Exception("You're not connected to Instagram")
  329. reaction = await DBReaction.get_by_mxid(event_id, self.mxid)
  330. if reaction:
  331. try:
  332. await reaction.delete()
  333. await sender.mqtt.send_reaction(self.thread_id, item_id=reaction.ig_item_id,
  334. reaction_status=ReactionStatus.DELETED, emoji="")
  335. except Exception as e:
  336. raise Exception(f"Removing reaction failed: {e}")
  337. else:
  338. sender.send_remote_checkpoint(
  339. status=MessageSendCheckpointStatus.SUCCESS,
  340. event_id=redaction_event_id,
  341. room_id=self.mxid,
  342. event_type=EventType.ROOM_REDACTION,
  343. )
  344. await self._send_delivery_receipt(redaction_event_id)
  345. self.log.trace(f"Removed {reaction} after Matrix redaction")
  346. return
  347. message = await DBMessage.get_by_mxid(event_id, self.mxid)
  348. if message and not message.is_internal:
  349. try:
  350. await message.delete()
  351. await sender.client.delete_item(self.thread_id, message.item_id)
  352. self.log.trace(f"Removed {message} after Matrix redaction")
  353. except Exception as e:
  354. raise Exception(f"Removing message failed: {e}")
  355. else:
  356. sender.send_remote_checkpoint(
  357. status=MessageSendCheckpointStatus.SUCCESS,
  358. event_id=redaction_event_id,
  359. room_id=self.mxid,
  360. event_type=EventType.ROOM_REDACTION,
  361. )
  362. await self._send_delivery_receipt(redaction_event_id)
  363. self.log.trace(f"Removed {reaction} after Matrix redaction")
  364. return
  365. raise Exception("No message or reaction found for redaction")
  366. async def handle_matrix_typing(self, users: Set[UserID]) -> None:
  367. if users == self._typing:
  368. return
  369. old_typing = self._typing
  370. self._typing = users
  371. await self._handle_matrix_typing(old_typing - users, TypingStatus.OFF)
  372. await self._handle_matrix_typing(users - old_typing, TypingStatus.TEXT)
  373. async def _handle_matrix_typing(self, users: Set[UserID], status: TypingStatus) -> None:
  374. for mxid in users:
  375. user = await u.User.get_by_mxid(mxid, create=False)
  376. if ((not user or not await user.is_logged_in() or user.remote_typing_status == status
  377. or not user.is_connected)):
  378. continue
  379. user.remote_typing_status = None
  380. await user.mqtt.indicate_activity(self.thread_id, status)
  381. async def handle_matrix_leave(self, user: 'u.User') -> None:
  382. if not await user.is_logged_in():
  383. return
  384. if self.is_direct:
  385. self.log.info(f"{user.mxid} left private chat portal with {self.other_user_pk}")
  386. if user.igpk == self.receiver:
  387. self.log.info(f"{user.mxid} was the recipient of this portal. "
  388. "Cleaning up and deleting...")
  389. await self.cleanup_and_delete()
  390. else:
  391. self.log.debug(f"{user.mxid} left portal to {self.thread_id}")
  392. # TODO cleanup if empty
  393. # endregion
  394. # region Instagram event handling
  395. async def _reupload_instagram_media(self, source: 'u.User', media: RegularMediaItem,
  396. intent: IntentAPI) -> MediaMessageEventContent:
  397. if media.media_type == MediaType.IMAGE:
  398. image = media.best_image
  399. if not image:
  400. raise ValueError("Attachment not available: didn't find photo URL")
  401. url = image.url
  402. msgtype = MessageType.IMAGE
  403. info = ImageInfo(height=image.height, width=image.width)
  404. elif media.media_type == MediaType.VIDEO:
  405. video = media.best_video
  406. if not video:
  407. raise ValueError("Attachment not available: didn't find video URL")
  408. url = video.url
  409. msgtype = MessageType.VIDEO
  410. info = VideoInfo(height=video.height, width=video.width)
  411. else:
  412. raise ValueError("Attachment not available: unsupported media type")
  413. return await self._reupload_instagram_file(source, url, msgtype, info, intent)
  414. async def _reupload_instagram_animated(self, source: 'u.User', media: AnimatedMediaItem,
  415. intent: IntentAPI) -> MediaMessageEventContent:
  416. url = media.images.fixed_height.webp
  417. info = ImageInfo(height=int(media.images.fixed_height.height),
  418. width=int(media.images.fixed_height.width))
  419. return await self._reupload_instagram_file(source, url, MessageType.IMAGE, info, intent)
  420. async def _reupload_instagram_voice(self, source: 'u.User', media: VoiceMediaItem,
  421. intent: IntentAPI) -> MediaMessageEventContent:
  422. url = media.media.audio.audio_src
  423. info = AudioInfo(duration=media.media.audio.duration)
  424. waveform = [int(p * 1000) for p in media.media.audio.waveform_data]
  425. content = await self._reupload_instagram_file(source, url, MessageType.AUDIO, info, intent)
  426. content.extensible_file = ExtensibleFile(
  427. file=content.file,
  428. name=content.body,
  429. mimetype=content.info.mimetype,
  430. size=content.info.size,
  431. )
  432. content.audio = Audio(duration=media.media.audio.duration, waveform=waveform)
  433. content.voice = Voice()
  434. return content
  435. async def _reupload_instagram_file(self, source: 'u.User', url: str, msgtype: MessageType,
  436. info: FileInfo, intent: IntentAPI
  437. ) -> MediaMessageEventContent:
  438. async with await source.client.raw_http_get(url) as resp:
  439. try:
  440. length = int(resp.headers["Content-Length"])
  441. except KeyError:
  442. # TODO can the download be short-circuited if there's too much data?
  443. self.log.warning("Got file download response with no Content-Length header,"
  444. "reading data dangerously")
  445. length = 0
  446. if length > self.matrix.media_config.upload_size:
  447. self.log.debug(f"{url} was too large ({length} "
  448. f"> {self.matrix.media_config.upload_size})")
  449. raise ValueError("Attachment not available: too large")
  450. data = await resp.read()
  451. info.mimetype = resp.headers["Content-Type"] or magic.from_buffer(data, mime=True)
  452. info.size = len(data)
  453. extension = {
  454. "image/webp": ".webp",
  455. "image/jpeg": ".jpg",
  456. "video/mp4": ".mp4",
  457. "audio/mp4": ".m4a",
  458. }.get(info.mimetype)
  459. extension = extension or mimetypes.guess_extension(info.mimetype) or ""
  460. file_name = f"{msgtype.value[2:]}{extension}"
  461. upload_mime_type = info.mimetype
  462. upload_file_name = file_name
  463. decryption_info = None
  464. if self.encrypted and encrypt_attachment:
  465. data, decryption_info = encrypt_attachment(data)
  466. upload_mime_type = "application/octet-stream"
  467. upload_file_name = None
  468. mxc = await intent.upload_media(data, mime_type=upload_mime_type,
  469. filename=upload_file_name)
  470. if decryption_info:
  471. decryption_info.url = mxc
  472. mxc = None
  473. return MediaMessageEventContent(
  474. body=file_name,
  475. external_url=url,
  476. url=mxc,
  477. file=decryption_info,
  478. info=info,
  479. msgtype=msgtype,
  480. )
  481. def _get_instagram_media_info(self, item: ThreadItem) -> Tuple[MediaUploadFunc, MediaData]:
  482. # TODO maybe use a dict and item.item_type instead of a ton of ifs
  483. method = self._reupload_instagram_media
  484. if item.media:
  485. media_data = item.media
  486. elif item.visual_media:
  487. media_data = item.visual_media.media
  488. elif item.animated_media:
  489. media_data = item.animated_media
  490. method = self._reupload_instagram_animated
  491. elif item.voice_media:
  492. media_data = item.voice_media
  493. method = self._reupload_instagram_voice
  494. elif item.reel_share:
  495. media_data = item.reel_share.media
  496. elif item.story_share:
  497. media_data = item.story_share.media
  498. elif item.media_share:
  499. media_data = item.media_share
  500. else:
  501. self.log.debug(f"Unknown media type in {item}")
  502. raise ValueError("Attachment not available: unsupported media type")
  503. if not media_data:
  504. self.log.debug(f"Didn't get media_data in {item}")
  505. raise ValueError("Attachment not available: unsupported media type")
  506. elif isinstance(media_data, ExpiredMediaItem):
  507. self.log.debug(f"Expired media in item {item}")
  508. raise ValueError("Attachment not available: media expired")
  509. return method, media_data
  510. async def _handle_instagram_media(self, source: 'u.User', intent: IntentAPI, item: ThreadItem
  511. ) -> Optional[EventID]:
  512. try:
  513. reupload_func, media_data = self._get_instagram_media_info(item)
  514. content = await reupload_func(source, media_data, intent)
  515. except ValueError as e:
  516. content = TextMessageEventContent(body=str(e), msgtype=MessageType.NOTICE)
  517. except Exception:
  518. self.log.warning("Failed to upload media", exc_info=True)
  519. content = TextMessageEventContent(body="Attachment not available: failed to copy file",
  520. msgtype=MessageType.NOTICE)
  521. await self._add_instagram_reply(content, item.replied_to_message)
  522. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  523. async def _handle_instagram_media_share(self, source: 'u.User', intent: IntentAPI,
  524. item: ThreadItem) -> Optional[EventID]:
  525. share_item = item.media_share or item.story_share.media
  526. user_text = f"@{share_item.user.username}"
  527. user_link = (f'<a href="https://www.instagram.com/{share_item.user.username}/">'
  528. f'{user_text}</a>')
  529. item_type_name = item.media_share.media_type.human_name if item.media_share else "story"
  530. prefix = TextMessageEventContent(msgtype=MessageType.NOTICE, format=Format.HTML,
  531. body=f"Sent {user_text}'s {item_type_name}",
  532. formatted_body=f"Sent {user_link}'s {item_type_name}")
  533. await self._send_message(intent, prefix, timestamp=item.timestamp // 1000)
  534. event_id = await self._handle_instagram_media(source, intent, item)
  535. if share_item.caption:
  536. external_url = f"https://www.instagram.com/p/{share_item.code}/"
  537. body = (f"> {share_item.caption.user.username}: {share_item.caption.text}\n\n"
  538. f"{external_url}")
  539. formatted_body = (f"<blockquote><strong>{share_item.caption.user.username}</strong>"
  540. f" {share_item.caption.text}</blockquote>"
  541. f'<a href="{external_url}">instagram.com/p/{share_item.code}</a>')
  542. caption = TextMessageEventContent(msgtype=MessageType.TEXT, body=body,
  543. formatted_body=formatted_body, format=Format.HTML,
  544. external_url=external_url)
  545. await self._send_message(intent, caption, timestamp=item.timestamp // 1000)
  546. return event_id
  547. async def _handle_instagram_reel_share(self, source: 'u.User', intent: IntentAPI,
  548. item: ThreadItem) -> Optional[EventID]:
  549. media = item.reel_share.media
  550. prefix_html = None
  551. if item.reel_share.type == ReelShareType.REPLY:
  552. if item.reel_share.reel_owner_id == source.igpk:
  553. prefix = "Replied to your story"
  554. else:
  555. username = media.user.username
  556. prefix = f"Sent @{username}'s story"
  557. user_link = f'<a href="https://www.instagram.com/{username}/">@{username}</a>'
  558. prefix_html = f"Sent {user_link}'s story"
  559. elif item.reel_share.type == ReelShareType.REACTION:
  560. prefix = "Reacted to your story"
  561. elif item.reel_share.type == ReelShareType.MENTION:
  562. if item.reel_share.mentioned_user_id == source.igpk:
  563. prefix = "Mentioned you in their story"
  564. else:
  565. prefix = "You mentioned them in your story"
  566. else:
  567. self.log.debug(f"Unsupported reel share type {item.reel_share.type}")
  568. return None
  569. prefix_content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=prefix)
  570. if prefix_html:
  571. prefix_content.format = Format.HTML
  572. prefix_content.formatted_body = prefix_html
  573. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=item.reel_share.text)
  574. if not content.body and isinstance(media, MediaShareItem):
  575. content.body = media.caption.text if media.caption else ""
  576. if not content.body:
  577. content.body = "<no caption>"
  578. await self._send_message(intent, prefix_content, timestamp=item.timestamp // 1000)
  579. if isinstance(media, ExpiredMediaItem):
  580. # TODO send message about expired story
  581. pass
  582. else:
  583. fake_item_id = f"fi.mau.instagram.reel_share.{item.user_id}.{media.pk}"
  584. existing = await DBMessage.get_by_item_id(fake_item_id, self.receiver)
  585. if existing:
  586. # If the user already reacted or replied to the same reel share item,
  587. # use a Matrix reply instead of reposting the image.
  588. content.set_reply(existing.mxid)
  589. else:
  590. media_event_id = await self._handle_instagram_media(source, intent, item)
  591. await DBMessage(mxid=media_event_id, mx_room=self.mxid, item_id=fake_item_id,
  592. receiver=self.receiver, sender=media.user.pk).insert()
  593. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  594. async def _handle_instagram_text(self, intent: IntentAPI, item: ThreadItem, text: str,
  595. ) -> EventID:
  596. content = TextMessageEventContent(msgtype=MessageType.TEXT, body=text)
  597. await self._add_instagram_reply(content, item.replied_to_message)
  598. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  599. async def _send_instagram_unhandled(self, intent: IntentAPI, item: ThreadItem) -> EventID:
  600. content = TextMessageEventContent(msgtype=MessageType.NOTICE,
  601. body="Unsupported message type")
  602. await self._add_instagram_reply(content, item.replied_to_message)
  603. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  604. async def _handle_instagram_location(self, intent: IntentAPI, item: ThreadItem
  605. ) -> Optional[EventID]:
  606. loc = item.location
  607. if not loc.lng or not loc.lat:
  608. # TODO handle somehow
  609. return None
  610. long_char = "E" if loc.lng > 0 else "W"
  611. lat_char = "N" if loc.lat > 0 else "S"
  612. body = (f"{loc.name} - {round(abs(loc.lat), 4)}° {lat_char}, "
  613. f"{round(abs(loc.lng), 4)}° {long_char}")
  614. url = f"https://www.openstreetmap.org/#map=15/{loc.lat}/{loc.lng}"
  615. external_url = None
  616. if loc.external_source == "facebook_places":
  617. external_url = f"https://www.facebook.com/{loc.short_name}-{loc.facebook_places_id}"
  618. content = LocationMessageEventContent(
  619. msgtype=MessageType.LOCATION, geo_uri=f"geo:{loc.lat},{loc.lng}",
  620. body=f"Location: {body}\n{url}", external_url=external_url)
  621. content["format"] = str(Format.HTML)
  622. content["formatted_body"] = f"Location: <a href='{url}'>{body}</a>"
  623. await self._add_instagram_reply(content, item.replied_to_message)
  624. return await self._send_message(intent, content, timestamp=item.timestamp // 1000)
  625. async def handle_instagram_item(self, source: 'u.User', sender: 'p.Puppet', item: ThreadItem,
  626. is_backfill: bool = False) -> None:
  627. try:
  628. await self._handle_instagram_item(source, sender, item, is_backfill)
  629. except Exception:
  630. self.log.exception("Fatal error handling Instagram item")
  631. self.log.trace("Item content: %s", item.serialize())
  632. async def _add_instagram_reply(self, content: MessageEventContent,
  633. reply_to: Optional[ThreadItem]) -> None:
  634. if not reply_to:
  635. return
  636. message = await DBMessage.get_by_item_id(reply_to.item_id, self.receiver)
  637. if not message:
  638. return
  639. content.set_reply(message.mxid)
  640. if not isinstance(content, TextMessageEventContent):
  641. return
  642. try:
  643. evt = await self.main_intent.get_event(message.mx_room, message.mxid)
  644. except (MNotFound, MForbidden):
  645. evt = None
  646. if not evt:
  647. return
  648. if evt.type == EventType.ROOM_ENCRYPTED:
  649. try:
  650. evt = await self.matrix.e2ee.decrypt(evt, wait_session_timeout=0)
  651. except SessionNotFound:
  652. return
  653. if isinstance(evt.content, TextMessageEventContent):
  654. evt.content.trim_reply_fallback()
  655. content.set_reply(evt)
  656. async def _handle_instagram_item(self, source: 'u.User', sender: 'p.Puppet', item: ThreadItem,
  657. is_backfill: bool = False) -> None:
  658. if not isinstance(item, ThreadItem):
  659. # Parsing these items failed, they should have been logged already
  660. return
  661. elif item.client_context in self._reqid_dedup:
  662. self.log.debug(f"Ignoring message {item.item_id} ({item.client_context}) by "
  663. f"{item.user_id} as it was sent by us (client_context in dedup queue)")
  664. elif item.item_id in self._msgid_dedup:
  665. self.log.debug(f"Ignoring message {item.item_id} ({item.client_context}) by "
  666. f"{item.user_id} as it was already handled (message.id in dedup queue)")
  667. elif await DBMessage.get_by_item_id(item.item_id, self.receiver) is not None:
  668. self.log.debug(f"Ignoring message {item.item_id} ({item.client_context}) by "
  669. f"{item.user_id} as it was already handled (message.id in database)")
  670. else:
  671. self.log.debug(f"Starting handling of message {item.item_id} ({item.client_context}) "
  672. f"by {item.user_id}")
  673. self._msgid_dedup.appendleft(item.item_id)
  674. if self.backfill_lock.locked and sender.need_backfill_invite(self):
  675. self.log.debug("Adding %s's default puppet to room for backfilling", sender.mxid)
  676. if self.is_direct:
  677. await self.main_intent.invite_user(self.mxid, sender.default_mxid)
  678. intent = sender.default_mxid_intent
  679. await intent.ensure_joined(self.mxid)
  680. self._backfill_leave.add(intent)
  681. else:
  682. intent = sender.intent_for(self)
  683. event_id = None
  684. if item.media or item.animated_media or item.voice_media or item.visual_media:
  685. event_id = await self._handle_instagram_media(source, intent, item)
  686. elif item.location:
  687. event_id = await self._handle_instagram_location(intent, item)
  688. elif item.reel_share:
  689. event_id = await self._handle_instagram_reel_share(source, intent, item)
  690. elif item.media_share or item.story_share:
  691. event_id = await self._handle_instagram_media_share(source, intent, item)
  692. elif item.action_log:
  693. # These probably don't need to be bridged
  694. self.log.debug(f"Ignoring action log message {item.item_id}")
  695. return
  696. # TODO handle item.clip?
  697. if item.text:
  698. event_id = await self._handle_instagram_text(intent, item, item.text)
  699. elif item.like:
  700. # We handle likes as text because Matrix clients do big emoji on their own.
  701. event_id = await self._handle_instagram_text(intent, item, item.like)
  702. elif item.link:
  703. event_id = await self._handle_instagram_text(intent, item, item.link.text)
  704. handled = bool(event_id)
  705. if not event_id:
  706. self.log.debug(f"Unhandled Instagram message {item.item_id}")
  707. event_id = await self._send_instagram_unhandled(intent, item)
  708. msg = DBMessage(mxid=event_id, mx_room=self.mxid, item_id=item.item_id,
  709. receiver=self.receiver, sender=sender.pk)
  710. await msg.insert()
  711. await self._send_delivery_receipt(event_id)
  712. if handled:
  713. self.log.debug(f"Handled Instagram message {item.item_id} -> {event_id}")
  714. else:
  715. self.log.debug(f"Unhandled Instagram message {item.item_id} "
  716. f"(type {item.item_type} -> fallback error {event_id})")
  717. if is_backfill and item.reactions:
  718. await self._handle_instagram_reactions(msg, item.reactions.emojis)
  719. async def handle_instagram_remove(self, item_id: str) -> None:
  720. message = await DBMessage.get_by_item_id(item_id, self.receiver)
  721. if message is None:
  722. return
  723. await message.delete()
  724. sender = await p.Puppet.get_by_pk(message.sender)
  725. try:
  726. await sender.intent_for(self).redact(self.mxid, message.mxid)
  727. except MForbidden:
  728. await self.main_intent.redact(self.mxid, message.mxid)
  729. self.log.debug(f"Redacted {message.mxid} after Instagram unsend")
  730. async def _handle_instagram_reactions(self, message: DBMessage, reactions: List[Reaction]
  731. ) -> None:
  732. old_reactions: Dict[int, DBReaction]
  733. old_reactions = {reaction.ig_sender: reaction for reaction
  734. in await DBReaction.get_all_by_item_id(message.item_id, self.receiver)}
  735. for new_reaction in reactions:
  736. old_reaction = old_reactions.pop(new_reaction.sender_id, None)
  737. if old_reaction and old_reaction.reaction == new_reaction.emoji:
  738. continue
  739. puppet = await p.Puppet.get_by_pk(new_reaction.sender_id)
  740. intent = puppet.intent_for(self)
  741. reaction_event_id = await intent.react(self.mxid, message.mxid, new_reaction.emoji)
  742. await self._upsert_reaction(old_reaction, intent, reaction_event_id, message,
  743. puppet, new_reaction.emoji)
  744. for old_reaction in old_reactions.values():
  745. await old_reaction.delete()
  746. puppet = await p.Puppet.get_by_pk(old_reaction.ig_sender)
  747. await puppet.intent_for(self).redact(self.mxid, old_reaction.mxid)
  748. async def handle_instagram_update(self, item: MessageSyncMessage) -> None:
  749. message = await DBMessage.get_by_item_id(item.item_id, self.receiver)
  750. if not message:
  751. return
  752. if item.has_seen:
  753. puppet = await p.Puppet.get_by_pk(item.has_seen, create=False)
  754. if puppet:
  755. await puppet.intent_for(self).mark_read(self.mxid, message.mxid)
  756. else:
  757. async with self._reaction_lock:
  758. await self._handle_instagram_reactions(message, (item.reactions.emojis
  759. if item.reactions else []))
  760. # endregion
  761. # region Updating portal info
  762. def _get_thread_name(self, thread: Thread) -> str:
  763. if self.is_direct:
  764. if self.other_user_pk == thread.viewer_id and len(thread.users) == 0:
  765. return "Instagram chat with yourself"
  766. elif len(thread.users) == 1:
  767. tpl = self.config["bridge.private_chat_name_template"]
  768. ui = thread.users[0]
  769. return tpl.format(displayname=ui.full_name, id=ui.pk, username=ui.username)
  770. pass
  771. elif thread.thread_title:
  772. return self.config["bridge.group_chat_name_template"].format(name=thread.thread_title)
  773. else:
  774. return ""
  775. async def update_info(self, thread: Thread, source: 'u.User') -> None:
  776. changed = await self._update_name(self._get_thread_name(thread))
  777. changed = await self._update_participants(thread.users, source) or changed
  778. if changed:
  779. await self.update_bridge_info()
  780. await self.update()
  781. # TODO update power levels with thread.admin_user_ids
  782. async def _update_name(self, name: str) -> bool:
  783. if name and (self.name != name or not self.name_set):
  784. self.name = name
  785. if self.mxid:
  786. try:
  787. await self.main_intent.set_room_name(self.mxid, name)
  788. self.name_set = True
  789. except Exception:
  790. self.log.exception("Failed to update name")
  791. self.name_set = False
  792. return True
  793. return False
  794. async def _update_photo_from_puppet(self, puppet: 'p.Puppet') -> bool:
  795. if not self.private_chat_portal_meta and not self.encrypted:
  796. return False
  797. if self.avatar_set and self.avatar_url == puppet.photo_mxc:
  798. return False
  799. self.avatar_url = puppet.photo_mxc
  800. if self.mxid:
  801. try:
  802. await self.main_intent.set_room_avatar(self.mxid, puppet.photo_mxc)
  803. self.avatar_set = True
  804. except Exception:
  805. self.log.exception("Failed to set room avatar")
  806. self.avatar_set = False
  807. return True
  808. async def _update_participants(self, users: List[ThreadUser], source: 'u.User') -> bool:
  809. meta_changed = False
  810. # Make sure puppets who should be here are here
  811. for user in users:
  812. puppet = await p.Puppet.get_by_pk(user.pk)
  813. await puppet.update_info(user, source)
  814. if self.mxid:
  815. await puppet.intent_for(self).ensure_joined(self.mxid)
  816. if puppet.pk == self.other_user_pk:
  817. meta_changed = await self._update_photo_from_puppet(puppet)
  818. if self.mxid:
  819. # Kick puppets who shouldn't be here
  820. current_members = {int(user.pk) for user in users}
  821. for user_id in await self.main_intent.get_room_members(self.mxid):
  822. pk = p.Puppet.get_id_from_mxid(user_id)
  823. if pk and pk not in current_members and pk != self.other_user_pk:
  824. await self.main_intent.kick_user(self.mxid, p.Puppet.get_mxid_from_id(pk),
  825. reason="User had left this Instagram DM")
  826. return meta_changed
  827. async def _update_read_receipts(self, receipts: Dict[Union[int, str], ThreadUserLastSeenAt]
  828. ) -> None:
  829. for user_id, receipt in receipts.items():
  830. message = await DBMessage.get_by_item_id(receipt.item_id, self.receiver)
  831. if not message:
  832. continue
  833. puppet = await p.Puppet.get_by_pk(int(user_id), create=False)
  834. if not puppet:
  835. continue
  836. try:
  837. await puppet.intent_for(self).mark_read(message.mx_room, message.mxid)
  838. except Exception:
  839. self.log.warning(f"Failed to mark {message.mxid} in {message.mx_room} "
  840. f"as read by {puppet.intent.mxid}", exc_info=True)
  841. # endregion
  842. # region Backfilling
  843. async def backfill(self, source: 'u.User', is_initial: bool = False) -> None:
  844. limit = (self.config["bridge.backfill.initial_limit"] if is_initial
  845. else self.config["bridge.backfill.missed_limit"])
  846. if limit == 0:
  847. return
  848. elif limit < 0:
  849. limit = None
  850. with self.backfill_lock:
  851. await self._backfill(source, is_initial, limit)
  852. async def _backfill(self, source: 'u.User', is_initial: bool, limit: int) -> None:
  853. self.log.debug("Backfilling history through %s", source.mxid)
  854. entries = await self._fetch_backfill_items(source, is_initial, limit)
  855. if not entries:
  856. self.log.debug("Didn't get any items to backfill from server")
  857. return
  858. self.log.debug("Got %d entries from server", len(entries))
  859. self._backfill_leave = set()
  860. async with NotificationDisabler(self.mxid, source):
  861. for entry in reversed(entries):
  862. sender = await p.Puppet.get_by_pk(int(entry.user_id))
  863. await self.handle_instagram_item(source, sender, entry, is_backfill=True)
  864. for intent in self._backfill_leave:
  865. self.log.trace("Leaving room with %s post-backfill", intent.mxid)
  866. await intent.leave_room(self.mxid)
  867. self._backfill_leave = None
  868. self.log.info("Backfilled %d messages through %s", len(entries), source.mxid)
  869. async def _fetch_backfill_items(self, source: 'u.User', is_initial: bool, limit: int
  870. ) -> List[ThreadItem]:
  871. items = []
  872. self.log.debug("Fetching up to %d messages through %s", limit, source.igpk)
  873. async for item in source.client.iter_thread(self.thread_id):
  874. if len(items) >= limit:
  875. self.log.debug(f"Fetched {len(items)} messages (the limit)")
  876. break
  877. elif not is_initial:
  878. msg = await DBMessage.get_by_item_id(item.item_id, receiver=self.receiver)
  879. if msg is not None:
  880. self.log.debug(f"Fetched {len(items)} messages and hit a message"
  881. " that's already in the database.")
  882. break
  883. items.append(item)
  884. return items
  885. # endregion
  886. # region Bridge info state event
  887. @property
  888. def bridge_info_state_key(self) -> str:
  889. return f"net.maunium.instagram://instagram/{self.thread_id}"
  890. @property
  891. def bridge_info(self) -> Dict[str, Any]:
  892. return {
  893. "bridgebot": self.az.bot_mxid,
  894. "creator": self.main_intent.mxid,
  895. "protocol": {
  896. "id": "instagram",
  897. "displayname": "Instagram DM",
  898. "avatar_url": self.config["appservice.bot_avatar"],
  899. },
  900. "channel": {
  901. "id": self.thread_id,
  902. "displayname": self.name,
  903. "avatar_url": self.avatar_url,
  904. }
  905. }
  906. async def update_bridge_info(self) -> None:
  907. if not self.mxid:
  908. self.log.debug("Not updating bridge info: no Matrix room created")
  909. return
  910. try:
  911. self.log.debug("Updating bridge info...")
  912. await self.main_intent.send_state_event(self.mxid, StateBridge,
  913. self.bridge_info, self.bridge_info_state_key)
  914. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  915. await self.main_intent.send_state_event(self.mxid, StateHalfShotBridge,
  916. self.bridge_info, self.bridge_info_state_key)
  917. except Exception:
  918. self.log.warning("Failed to update bridge info", exc_info=True)
  919. # endregion
  920. # region Creating Matrix rooms
  921. async def create_matrix_room(self, source: 'u.User', info: Thread) -> Optional[RoomID]:
  922. if self.mxid:
  923. try:
  924. await self.update_matrix_room(source, info)
  925. except Exception:
  926. self.log.exception("Failed to update portal")
  927. return self.mxid
  928. async with self._create_room_lock:
  929. return await self._create_matrix_room(source, info)
  930. def _get_invite_content(self, double_puppet: Optional['p.Puppet']) -> Dict[str, Any]:
  931. invite_content = {}
  932. if double_puppet:
  933. invite_content["fi.mau.will_auto_accept"] = True
  934. if self.is_direct:
  935. invite_content["is_direct"] = True
  936. return invite_content
  937. async def update_matrix_room(self, source: 'u.User', info: Thread, backfill: bool = False
  938. ) -> None:
  939. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  940. await self.main_intent.invite_user(self.mxid, source.mxid, check_cache=True,
  941. extra_content=self._get_invite_content(puppet))
  942. if puppet:
  943. did_join = await puppet.intent.ensure_joined(self.mxid)
  944. if did_join and self.is_direct:
  945. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  946. await self.update_info(info, source)
  947. if backfill:
  948. last_msg = await DBMessage.get_by_item_id(info.last_permanent_item.item_id,
  949. receiver=self.receiver)
  950. if last_msg is None:
  951. self.log.debug(f"Last permanent item ({info.last_permanent_item.item_id})"
  952. " not found in database, starting backfilling")
  953. await self.backfill(source, is_initial=False)
  954. await self._update_read_receipts(info.last_seen_at)
  955. # TODO
  956. # up = DBUserPortal.get(source.fbid, self.fbid, self.fb_receiver)
  957. # if not up:
  958. # in_community = await source._community_helper.add_room(source._community_id, self.mxid)
  959. # DBUserPortal(user=source.fbid, portal=self.fbid, portal_receiver=self.fb_receiver,
  960. # in_community=in_community).insert()
  961. # elif not up.in_community:
  962. # in_community = await source._community_helper.add_room(source._community_id, self.mxid)
  963. # up.edit(in_community=in_community)
  964. async def _create_matrix_room(self, source: 'u.User', info: Thread) -> Optional[RoomID]:
  965. if self.mxid:
  966. await self.update_matrix_room(source, info)
  967. return self.mxid
  968. await self.update_info(info, source)
  969. self.log.debug("Creating Matrix room")
  970. name: Optional[str] = None
  971. initial_state = [{
  972. "type": str(StateBridge),
  973. "state_key": self.bridge_info_state_key,
  974. "content": self.bridge_info,
  975. }, {
  976. # TODO remove this once https://github.com/matrix-org/matrix-doc/pull/2346 is in spec
  977. "type": str(StateHalfShotBridge),
  978. "state_key": self.bridge_info_state_key,
  979. "content": self.bridge_info,
  980. }]
  981. invites = []
  982. if self.config["bridge.encryption.default"] and self.matrix.e2ee:
  983. self.encrypted = True
  984. initial_state.append({
  985. "type": "m.room.encryption",
  986. "content": {"algorithm": "m.megolm.v1.aes-sha2"},
  987. })
  988. if self.is_direct:
  989. invites.append(self.az.bot_mxid)
  990. if self.encrypted or self.private_chat_portal_meta or not self.is_direct:
  991. name = self.name
  992. if self.config["appservice.community_id"]:
  993. initial_state.append({
  994. "type": "m.room.related_groups",
  995. "content": {"groups": [self.config["appservice.community_id"]]},
  996. })
  997. # We lock backfill lock here so any messages that come between the room being created
  998. # and the initial backfill finishing wouldn't be bridged before the backfill messages.
  999. with self.backfill_lock:
  1000. creation_content = {}
  1001. if not self.config["bridge.federate_rooms"]:
  1002. creation_content["m.federate"] = False
  1003. self.mxid = await self.main_intent.create_room(
  1004. name=name,
  1005. is_direct=self.is_direct,
  1006. initial_state=initial_state,
  1007. invitees=invites,
  1008. creation_content=creation_content,
  1009. )
  1010. if not self.mxid:
  1011. raise Exception("Failed to create room: no mxid returned")
  1012. if self.encrypted and self.matrix.e2ee and self.is_direct:
  1013. try:
  1014. await self.az.intent.ensure_joined(self.mxid)
  1015. except Exception:
  1016. self.log.warning("Failed to add bridge bot "
  1017. f"to new private chat {self.mxid}")
  1018. await self.update()
  1019. self.log.debug(f"Matrix room created: {self.mxid}")
  1020. self.by_mxid[self.mxid] = self
  1021. puppet = await p.Puppet.get_by_custom_mxid(source.mxid)
  1022. await self.main_intent.invite_user(self.mxid, source.mxid,
  1023. extra_content=self._get_invite_content(puppet))
  1024. if puppet:
  1025. try:
  1026. if self.is_direct:
  1027. await source.update_direct_chats({self.main_intent.mxid: [self.mxid]})
  1028. await puppet.intent.join_room_by_id(self.mxid)
  1029. except MatrixError:
  1030. self.log.debug("Failed to join custom puppet into newly created portal",
  1031. exc_info=True)
  1032. await self._update_participants(info.users, source)
  1033. # TODO
  1034. # in_community = await source._community_helper.add_room(source._community_id, self.mxid)
  1035. # DBUserPortal(user=source.fbid, portal=self.fbid, portal_receiver=self.fb_receiver,
  1036. # in_community=in_community).upsert()
  1037. try:
  1038. await self.backfill(source, is_initial=True)
  1039. except Exception:
  1040. self.log.exception("Failed to backfill new portal")
  1041. await self._update_read_receipts(info.last_seen_at)
  1042. return self.mxid
  1043. # endregion
  1044. # region Database getters
  1045. async def postinit(self) -> None:
  1046. self.by_thread_id[(self.thread_id, self.receiver)] = self
  1047. if self.mxid:
  1048. self.by_mxid[self.mxid] = self
  1049. self._main_intent = ((await p.Puppet.get_by_pk(self.other_user_pk)).default_mxid_intent
  1050. if self.other_user_pk else self.az.intent)
  1051. async def delete(self) -> None:
  1052. await DBMessage.delete_all(self.mxid)
  1053. self.by_mxid.pop(self.mxid, None)
  1054. self.mxid = None
  1055. self.encrypted = False
  1056. await self.update()
  1057. async def save(self) -> None:
  1058. await self.update()
  1059. @classmethod
  1060. def all_with_room(cls) -> AsyncGenerator['Portal', None]:
  1061. return cls._db_to_portals(super().all_with_room())
  1062. @classmethod
  1063. def find_private_chats_with(cls, other_user: int) -> AsyncGenerator['Portal', None]:
  1064. return cls._db_to_portals(super().find_private_chats_with(other_user))
  1065. @classmethod
  1066. async def _db_to_portals(cls, query: Awaitable[List['Portal']]
  1067. ) -> AsyncGenerator['Portal', None]:
  1068. portals = await query
  1069. for index, portal in enumerate(portals):
  1070. try:
  1071. yield cls.by_thread_id[(portal.thread_id, portal.receiver)]
  1072. except KeyError:
  1073. await portal.postinit()
  1074. yield portal
  1075. @classmethod
  1076. @async_getter_lock
  1077. async def get_by_mxid(cls, mxid: RoomID) -> Optional['Portal']:
  1078. try:
  1079. return cls.by_mxid[mxid]
  1080. except KeyError:
  1081. pass
  1082. portal = cast(cls, await super().get_by_mxid(mxid))
  1083. if portal is not None:
  1084. await portal.postinit()
  1085. return portal
  1086. return None
  1087. @classmethod
  1088. @async_getter_lock
  1089. async def get_by_thread_id(cls, thread_id: str, *, receiver: int,
  1090. is_group: Optional[bool] = None,
  1091. other_user_pk: Optional[int] = None) -> Optional['Portal']:
  1092. if is_group and receiver != 0:
  1093. receiver = 0
  1094. try:
  1095. return cls.by_thread_id[(thread_id, receiver)]
  1096. except KeyError:
  1097. pass
  1098. if is_group is None and receiver != 0:
  1099. try:
  1100. return cls.by_thread_id[(thread_id, 0)]
  1101. except KeyError:
  1102. pass
  1103. portal = cast(cls, await super().get_by_thread_id(thread_id, receiver=receiver,
  1104. rec_must_match=is_group is not None))
  1105. if portal is not None:
  1106. await portal.postinit()
  1107. return portal
  1108. if is_group is not None:
  1109. portal = cls(thread_id, receiver, other_user_pk=other_user_pk)
  1110. await portal.insert()
  1111. await portal.postinit()
  1112. return portal
  1113. return None
  1114. @classmethod
  1115. async def get_by_thread(cls, thread: Thread, receiver: int) -> Optional['Portal']:
  1116. if thread.is_group:
  1117. receiver = 0
  1118. other_user_pk = None
  1119. else:
  1120. if len(thread.users) == 0:
  1121. other_user_pk = receiver
  1122. else:
  1123. other_user_pk = thread.users[0].pk
  1124. return await cls.get_by_thread_id(thread.thread_id, receiver=receiver,
  1125. is_group=thread.is_group, other_user_pk=other_user_pk)
  1126. # endregion