conn.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907
  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 Any, Awaitable, Callable, Iterable, Type, TypeVar
  18. from collections import defaultdict
  19. from socket import error as SocketError, socket
  20. import asyncio
  21. import json
  22. import logging
  23. import re
  24. import time
  25. import urllib.request
  26. import zlib
  27. from yarl import URL
  28. import paho.mqtt.client as pmc
  29. from mautrix.util.logging import TraceLogger
  30. from ..errors import (
  31. IrisSubscribeError,
  32. MQTTConnectionUnauthorized,
  33. MQTTNotConnected,
  34. MQTTNotLoggedIn,
  35. )
  36. from ..state import AndroidState
  37. from ..types import (
  38. AppPresenceEventPayload,
  39. ClientConfigUpdatePayload,
  40. CommandResponse,
  41. IrisPayload,
  42. IrisPayloadData,
  43. LiveVideoCommentPayload,
  44. MessageSyncEvent,
  45. MessageSyncMessage,
  46. PubsubEvent,
  47. PubsubPayload,
  48. ReactionStatus,
  49. RealtimeDirectEvent,
  50. RealtimeZeroProvisionPayload,
  51. ThreadAction,
  52. ThreadItemType,
  53. ThreadSyncEvent,
  54. TypingStatus,
  55. )
  56. from .events import Connect, Disconnect, NewSequenceID
  57. from .otclient import MQTToTClient
  58. from .subscription import GraphQLQueryID, RealtimeTopic, everclear_subscriptions
  59. from .thrift import ForegroundStateConfig, IncomingMessage, RealtimeClientInfo, RealtimeConfig
  60. try:
  61. import socks
  62. except ImportError:
  63. socks = None
  64. T = TypeVar("T")
  65. ACTIVITY_INDICATOR_REGEX = re.compile(
  66. r"/direct_v2/threads/([\w_]+)/activity_indicator_id/([\w_]+)"
  67. )
  68. INBOX_THREAD_REGEX = re.compile(r"/direct_v2/inbox/threads/([\w_]+)")
  69. class AndroidMQTT:
  70. _loop: asyncio.AbstractEventLoop
  71. _client: MQTToTClient
  72. log: TraceLogger
  73. state: AndroidState
  74. _graphql_subs: set[str]
  75. _skywalker_subs: set[str]
  76. _iris_seq_id: int | None
  77. _iris_snapshot_at_ms: int | None
  78. _publish_waiters: dict[int, asyncio.Future]
  79. _response_waiters: dict[RealtimeTopic, asyncio.Future]
  80. _response_waiter_locks: dict[RealtimeTopic, asyncio.Lock]
  81. _message_response_waiters: dict[str, asyncio.Future]
  82. _disconnect_error: Exception | None
  83. _event_handlers: dict[Type[T], list[Callable[[T], Awaitable[None]]]]
  84. _outgoing_events: asyncio.Queue
  85. _event_dispatcher_task: asyncio.Task | None
  86. # region Initialization
  87. def __init__(
  88. self,
  89. state: AndroidState,
  90. loop: asyncio.AbstractEventLoop | None = None,
  91. log: TraceLogger | None = None,
  92. ) -> None:
  93. self._graphql_subs = set()
  94. self._skywalker_subs = set()
  95. self._iris_seq_id = None
  96. self._iris_snapshot_at_ms = None
  97. self._publish_waiters = {}
  98. self._response_waiters = {}
  99. self._message_response_waiters = {}
  100. self._disconnect_error = None
  101. self._response_waiter_locks = defaultdict(lambda: asyncio.Lock())
  102. self._event_handlers = defaultdict(lambda: [])
  103. self._event_dispatcher_task = None
  104. self._outgoing_events = asyncio.Queue()
  105. self.log = log or logging.getLogger("mauigpapi.mqtt")
  106. self._loop = loop or asyncio.get_event_loop()
  107. self.state = state
  108. self._client = MQTToTClient(
  109. client_id=self._form_client_id(),
  110. clean_session=True,
  111. protocol=pmc.MQTTv31,
  112. transport="tcp",
  113. )
  114. try:
  115. http_proxy = urllib.request.getproxies()["http"]
  116. except KeyError:
  117. http_proxy = None
  118. if http_proxy and socks and URL:
  119. proxy_url = URL(http_proxy)
  120. proxy_type = {
  121. "http": socks.HTTP,
  122. "https": socks.HTTP,
  123. "socks": socks.SOCKS5,
  124. "socks5": socks.SOCKS5,
  125. "socks4": socks.SOCKS4,
  126. }[proxy_url.scheme]
  127. self._client.proxy_set(
  128. proxy_type=proxy_type,
  129. proxy_addr=proxy_url.host,
  130. proxy_port=proxy_url.port,
  131. proxy_username=proxy_url.user,
  132. proxy_password=proxy_url.password,
  133. )
  134. self._client.enable_logger()
  135. self._client.tls_set()
  136. # mqtt.max_inflight_messages_set(20) # The rest will get queued
  137. # mqtt.max_queued_messages_set(0) # Unlimited messages can be queued
  138. # mqtt.message_retry_set(20) # Retry sending for at least 20 seconds
  139. # mqtt.reconnect_delay_set(min_delay=1, max_delay=120)
  140. self._client.connect_async("edge-mqtt.facebook.com", 443, keepalive=60)
  141. self._client.on_message = self._on_message_handler
  142. self._client.on_publish = self._on_publish_handler
  143. self._client.on_connect = self._on_connect_handler
  144. self._client.on_disconnect = self._on_disconnect_handler
  145. self._client.on_socket_open = self._on_socket_open
  146. self._client.on_socket_close = self._on_socket_close
  147. self._client.on_socket_register_write = self._on_socket_register_write
  148. self._client.on_socket_unregister_write = self._on_socket_unregister_write
  149. def _clear_response_waiters(self) -> None:
  150. for waiter in self._response_waiters.values():
  151. if not waiter.done():
  152. waiter.set_exception(
  153. MQTTNotConnected("MQTT disconnected before request returned response")
  154. )
  155. for waiter in self._publish_waiters.values():
  156. if not waiter.done():
  157. waiter.set_exception(
  158. MQTTNotConnected("MQTT disconnected before request was published")
  159. )
  160. self._response_waiters = {}
  161. self._publish_waiters = {}
  162. def _form_client_id(self) -> bytes:
  163. subscribe_topics = [
  164. RealtimeTopic.PUBSUB, # 88
  165. RealtimeTopic.SUB_IRIS_RESPONSE, # 135
  166. RealtimeTopic.RS_REQ, # 244
  167. RealtimeTopic.REALTIME_SUB, # 149
  168. RealtimeTopic.REGION_HINT, # 150
  169. RealtimeTopic.RS_RESP, # 245
  170. RealtimeTopic.T_RTC_LOG, # 274
  171. RealtimeTopic.SEND_MESSAGE_RESPONSE, # 133
  172. RealtimeTopic.MESSAGE_SYNC, # 146
  173. RealtimeTopic.LIGHTSPEED_RESPONSE, # 179
  174. RealtimeTopic.UNKNOWN_PP, # 34
  175. ]
  176. subscribe_topic_ids = [int(topic.encoded) for topic in subscribe_topics]
  177. password = f"authorization={self.state.session.authorization}"
  178. # if not self.state.session.authorization:
  179. # password = f"sessionid={self.state.cookies['sessionid']}"
  180. cfg = RealtimeConfig(
  181. client_identifier=self.state.device.phone_id[:20],
  182. client_info=RealtimeClientInfo(
  183. user_id=int(self.state.user_id),
  184. user_agent=self.state.user_agent,
  185. client_capabilities=0b10110111,
  186. endpoint_capabilities=0,
  187. publish_format=1,
  188. no_automatic_foreground=True,
  189. make_user_available_in_foreground=False,
  190. device_id=self.state.device.phone_id,
  191. is_initially_foreground=False,
  192. network_type=1,
  193. network_subtype=0,
  194. client_mqtt_session_id=int(time.time() * 1000) & 0xFFFFFFFF,
  195. subscribe_topics=subscribe_topic_ids,
  196. client_type="cookie_auth",
  197. app_id=567067343352427,
  198. region_preference=self.state.session.region_hint or "LLA",
  199. device_secret="",
  200. client_stack=3,
  201. ),
  202. password=password,
  203. app_specific_info={
  204. "app_version": self.state.application.APP_VERSION,
  205. "X-IG-Capabilities": self.state.application.CAPABILITIES,
  206. "everclear_subscriptions": json.dumps(everclear_subscriptions),
  207. "User-Agent": self.state.user_agent,
  208. "Accept-Language": self.state.device.language.replace("_", "-"),
  209. "platform": "android",
  210. "ig_mqtt_route": "django",
  211. "pubsub_msg_type_blacklist": "direct, typing_type",
  212. "auth_cache_enabled": "1",
  213. },
  214. )
  215. return zlib.compress(cfg.to_thrift(), level=9)
  216. # endregion
  217. def _on_socket_open(self, client: MQTToTClient, _: Any, sock: socket) -> None:
  218. self._loop.add_reader(sock, client.loop_read)
  219. def _on_socket_close(self, client: MQTToTClient, _: Any, sock: socket) -> None:
  220. self._loop.remove_reader(sock)
  221. def _on_socket_register_write(self, client: MQTToTClient, _: Any, sock: socket) -> None:
  222. self._loop.add_writer(sock, client.loop_write)
  223. def _on_socket_unregister_write(self, client: MQTToTClient, _: Any, sock: socket) -> None:
  224. self._loop.remove_writer(sock)
  225. def _on_connect_handler(
  226. self, client: MQTToTClient, _: Any, flags: dict[str, Any], rc: int
  227. ) -> None:
  228. if rc != 0:
  229. err = pmc.connack_string(rc)
  230. self.log.error("MQTT Connection Error: %s (%d)", err, rc)
  231. if rc == pmc.CONNACK_REFUSED_NOT_AUTHORIZED:
  232. self._disconnect_error = MQTTConnectionUnauthorized()
  233. self.disconnect()
  234. return
  235. self._loop.create_task(self._post_connect())
  236. def _on_disconnect_handler(self, client: MQTToTClient, _: Any, rc: int) -> None:
  237. err_str = "Generic error." if rc == pmc.MQTT_ERR_NOMEM else pmc.error_string(rc)
  238. self.log.debug(f"MQTT disconnection code %d: %s", rc, err_str)
  239. self._clear_response_waiters()
  240. async def _post_connect(self) -> None:
  241. await self._dispatch(Connect())
  242. self.log.debug("Re-subscribing to things after connect")
  243. if self._graphql_subs:
  244. res = await self.graphql_subscribe(self._graphql_subs)
  245. self.log.trace("GraphQL subscribe response: %s", res)
  246. if self._skywalker_subs:
  247. res = await self.skywalker_subscribe(self._skywalker_subs)
  248. self.log.trace("Skywalker subscribe response: %s", res)
  249. if self._iris_seq_id:
  250. retry = 0
  251. while True:
  252. try:
  253. await self.iris_subscribe(self._iris_seq_id, self._iris_snapshot_at_ms)
  254. break
  255. except (asyncio.TimeoutError, IrisSubscribeError) as e:
  256. self.log.exception("Error requesting iris subscribe")
  257. retry += 1
  258. if retry >= 5 or isinstance(e, IrisSubscribeError):
  259. self._disconnect_error = e
  260. self.disconnect()
  261. break
  262. await asyncio.sleep(5)
  263. self.log.debug("Retrying iris subscribe")
  264. def _on_publish_handler(self, client: MQTToTClient, _: Any, mid: int) -> None:
  265. try:
  266. waiter = self._publish_waiters[mid]
  267. except KeyError:
  268. self.log.trace(f"Got publish confirmation for {mid}, but no waiters")
  269. return
  270. self.log.trace(f"Got publish confirmation for {mid}")
  271. waiter.set_result(None)
  272. # region Incoming event parsing
  273. def _parse_direct_thread_path(self, path: str) -> dict:
  274. try:
  275. blank, direct_v2, threads, thread_id, *rest = path.split("/")
  276. except (ValueError, IndexError) as e:
  277. self.log.debug(f"Got {e!r} while parsing path {path}")
  278. raise
  279. if (blank, direct_v2, threads) != ("", "direct_v2", "threads"):
  280. self.log.debug(f"Got unexpected first parts in direct thread path {path}")
  281. raise ValueError("unexpected first three parts in _parse_direct_thread_path")
  282. additional = {"thread_id": thread_id}
  283. if rest:
  284. subitem_key = rest[0]
  285. if subitem_key == "approval_required_for_new_members":
  286. additional["approval_required_for_new_members"] = True
  287. elif subitem_key == "participants" and len(rest) > 2 and rest[2] == "has_seen":
  288. additional["has_seen"] = int(rest[1])
  289. elif subitem_key == "items":
  290. additional["item_id"] = rest[1]
  291. # TODO wtf is this?
  292. # it has something to do with reactions
  293. if len(rest) > 4:
  294. additional[rest[2]] = {
  295. rest[3]: rest[4],
  296. }
  297. elif subitem_key in "admin_user_ids":
  298. additional["admin_user_id"] = int(rest[1])
  299. elif subitem_key == "activity_indicator_id":
  300. additional["activity_indicator_id"] = rest[1]
  301. self.log.trace("Parsed path %s -> %s", path, additional)
  302. return additional
  303. def _on_messager_sync_item(self, part: IrisPayloadData, parsed_item: IrisPayload) -> bool:
  304. if part.path.startswith("/direct_v2/threads/"):
  305. raw_message = {
  306. "path": part.path,
  307. "op": part.op,
  308. **self._parse_direct_thread_path(part.path),
  309. }
  310. try:
  311. raw_message = {
  312. **raw_message,
  313. **json.loads(part.value),
  314. }
  315. except (json.JSONDecodeError, TypeError):
  316. raw_message["value"] = part.value
  317. message = MessageSyncMessage.deserialize(raw_message)
  318. evt = MessageSyncEvent(iris=parsed_item, message=message)
  319. elif part.path.startswith("/direct_v2/inbox/threads/"):
  320. raw_message = {
  321. "path": part.path,
  322. "op": part.op,
  323. **json.loads(part.value),
  324. }
  325. evt = ThreadSyncEvent.deserialize(raw_message)
  326. else:
  327. self.log.warning(f"Unsupported path {part.path}")
  328. return False
  329. self._outgoing_events.put_nowait(evt)
  330. return True
  331. def _on_message_sync(self, payload: bytes) -> None:
  332. parsed = json.loads(payload.decode("utf-8"))
  333. self.log.trace("Got message sync event: %s", parsed)
  334. has_items = False
  335. for sync_item in parsed:
  336. parsed_item = IrisPayload.deserialize(sync_item)
  337. if self._iris_seq_id < parsed_item.seq_id:
  338. self.log.trace(f"Got new seq_id: {parsed_item.seq_id}")
  339. self._iris_seq_id = parsed_item.seq_id
  340. self._iris_snapshot_at_ms = int(time.time() * 1000)
  341. asyncio.create_task(
  342. self._dispatch(NewSequenceID(self._iris_seq_id, self._iris_snapshot_at_ms))
  343. )
  344. for part in parsed_item.data:
  345. has_items = self._on_messager_sync_item(part, parsed_item) or has_items
  346. if has_items and not self._event_dispatcher_task:
  347. self._event_dispatcher_task = asyncio.create_task(self._dispatcher_loop())
  348. def _on_pubsub(self, payload: bytes) -> None:
  349. parsed_thrift = IncomingMessage.from_thrift(payload)
  350. self.log.trace(f"Got pubsub event {parsed_thrift.topic} / {parsed_thrift.payload}")
  351. message = PubsubPayload.parse_json(parsed_thrift.payload)
  352. for data in message.data:
  353. match = ACTIVITY_INDICATOR_REGEX.match(data.path)
  354. if match:
  355. evt = PubsubEvent(
  356. data=data,
  357. base=message,
  358. thread_id=match.group(1),
  359. activity_indicator_id=match.group(2),
  360. )
  361. self._loop.create_task(self._dispatch(evt))
  362. elif not data.double_publish:
  363. self.log.debug("Pubsub: no activity indicator on data: %s", data)
  364. else:
  365. self.log.debug("Pubsub: double publish: %s", data.path)
  366. def _parse_realtime_sub_item(self, topic: str | GraphQLQueryID, raw: dict) -> Iterable[Any]:
  367. if topic == GraphQLQueryID.APP_PRESENCE:
  368. yield AppPresenceEventPayload.deserialize(raw).presence_event
  369. elif topic == GraphQLQueryID.ZERO_PROVISION:
  370. yield RealtimeZeroProvisionPayload.deserialize(raw).zero_product_provisioning_event
  371. elif topic == GraphQLQueryID.CLIENT_CONFIG_UPDATE:
  372. yield ClientConfigUpdatePayload.deserialize(raw).client_config_update_event
  373. elif topic == GraphQLQueryID.LIVE_REALTIME_COMMENTS:
  374. yield LiveVideoCommentPayload.deserialize(raw).live_video_comment_event
  375. elif topic == "direct":
  376. event = raw["event"]
  377. for item in raw["data"]:
  378. yield RealtimeDirectEvent.deserialize(
  379. {
  380. "event": event,
  381. **self._parse_direct_thread_path(item["path"]),
  382. **item,
  383. }
  384. )
  385. def _on_realtime_sub(self, payload: bytes) -> None:
  386. parsed_thrift = IncomingMessage.from_thrift(payload)
  387. try:
  388. topic = GraphQLQueryID(parsed_thrift.topic)
  389. except ValueError:
  390. topic = parsed_thrift.topic
  391. self.log.trace(f"Got realtime sub event {topic} / {parsed_thrift.payload}")
  392. allowed = (
  393. "direct",
  394. GraphQLQueryID.APP_PRESENCE,
  395. GraphQLQueryID.ZERO_PROVISION,
  396. GraphQLQueryID.CLIENT_CONFIG_UPDATE,
  397. GraphQLQueryID.LIVE_REALTIME_COMMENTS,
  398. )
  399. if topic not in allowed:
  400. return
  401. parsed_json = json.loads(parsed_thrift.payload)
  402. for evt in self._parse_realtime_sub_item(topic, parsed_json):
  403. self._loop.create_task(self._dispatch(evt))
  404. def _on_message_handler(self, client: MQTToTClient, _: Any, message: pmc.MQTTMessage) -> None:
  405. try:
  406. topic = RealtimeTopic.decode(message.topic)
  407. # Instagram Android MQTT messages are always compressed
  408. message.payload = zlib.decompress(message.payload)
  409. if topic == RealtimeTopic.MESSAGE_SYNC:
  410. self._on_message_sync(message.payload)
  411. elif topic == RealtimeTopic.PUBSUB:
  412. self._on_pubsub(message.payload)
  413. elif topic == RealtimeTopic.REALTIME_SUB:
  414. self._on_realtime_sub(message.payload)
  415. elif topic == RealtimeTopic.SEND_MESSAGE_RESPONSE:
  416. try:
  417. data = json.loads(message.payload.decode("utf-8"))
  418. ccid = data["payload"]["client_context"]
  419. waiter = self._message_response_waiters.pop(ccid)
  420. except KeyError as e:
  421. self.log.debug(
  422. "No handler for send message response: %s (missing %s key)",
  423. message.payload,
  424. e,
  425. )
  426. else:
  427. self.log.trace("Got response to %s: %s", ccid, message.payload)
  428. waiter.set_result(message)
  429. else:
  430. try:
  431. waiter = self._response_waiters.pop(topic)
  432. except KeyError:
  433. self.log.debug(
  434. "No handler for MQTT message in %s: %s", topic.value, message.payload
  435. )
  436. else:
  437. self.log.trace("Got response %s: %s", topic.value, message.payload)
  438. waiter.set_result(message)
  439. except Exception:
  440. self.log.exception("Error in incoming MQTT message handler")
  441. self.log.trace("Errored MQTT payload: %s", message.payload)
  442. # endregion
  443. async def _reconnect(self) -> None:
  444. try:
  445. self.log.trace("Trying to reconnect to MQTT")
  446. self._client.reconnect()
  447. except (SocketError, OSError, pmc.WebsocketConnectionError) as e:
  448. # TODO custom class
  449. raise MQTTNotLoggedIn("MQTT reconnection failed") from e
  450. def add_event_handler(
  451. self, evt_type: Type[T], handler: Callable[[T], Awaitable[None]]
  452. ) -> None:
  453. self._event_handlers[evt_type].append(handler)
  454. async def _dispatch(self, evt: T) -> None:
  455. for handler in self._event_handlers[type(evt)]:
  456. try:
  457. await handler(evt)
  458. except Exception:
  459. self.log.exception(f"Error in {type(evt).__name__} handler")
  460. def disconnect(self) -> None:
  461. self._client.disconnect()
  462. async def _dispatcher_loop(self) -> None:
  463. loop_id = f"{hex(id(self))}#{time.monotonic()}"
  464. self.log.debug(f"Dispatcher loop {loop_id} starting")
  465. try:
  466. while True:
  467. evt = await self._outgoing_events.get()
  468. await asyncio.shield(self._dispatch(evt))
  469. except asyncio.CancelledError:
  470. tasks = self._outgoing_events
  471. self._outgoing_events = asyncio.Queue()
  472. if not tasks.empty():
  473. self.log.debug(
  474. f"Dispatcher loop {loop_id} stopping after dispatching {tasks.qsize()} events"
  475. )
  476. while not tasks.empty():
  477. await self._dispatch(tasks.get_nowait())
  478. raise
  479. finally:
  480. self.log.debug(f"Dispatcher loop {loop_id} stopped")
  481. async def listen(
  482. self,
  483. graphql_subs: set[str] | None = None,
  484. skywalker_subs: set[str] | None = None,
  485. seq_id: int = None,
  486. snapshot_at_ms: int = None,
  487. retry_limit: int = 5,
  488. ) -> None:
  489. self._graphql_subs = graphql_subs or set()
  490. self._skywalker_subs = skywalker_subs or set()
  491. self._iris_seq_id = seq_id
  492. self._iris_snapshot_at_ms = snapshot_at_ms
  493. self.log.debug("Connecting to Instagram MQTT")
  494. await self._reconnect()
  495. connection_retries = 0
  496. while True:
  497. try:
  498. await asyncio.sleep(1)
  499. except asyncio.CancelledError:
  500. self.disconnect()
  501. # this might not be necessary
  502. self._client.loop_misc()
  503. break
  504. rc = self._client.loop_misc()
  505. # If disconnect() has been called
  506. # Beware, internal API, may have to change this to something more stable!
  507. if self._client._state == pmc.mqtt_cs_disconnecting:
  508. break # Stop listening
  509. if rc != pmc.MQTT_ERR_SUCCESS:
  510. # If known/expected error
  511. if rc == pmc.MQTT_ERR_CONN_LOST:
  512. await self._dispatch(Disconnect(reason="Connection lost, retrying"))
  513. elif rc == pmc.MQTT_ERR_NOMEM:
  514. # This error is wrongly classified
  515. # See https://github.com/eclipse/paho.mqtt.python/issues/340
  516. await self._dispatch(Disconnect(reason="Connection lost, retrying"))
  517. elif rc == pmc.MQTT_ERR_CONN_REFUSED:
  518. raise MQTTNotLoggedIn("MQTT connection refused")
  519. elif rc == pmc.MQTT_ERR_NO_CONN:
  520. if connection_retries > retry_limit:
  521. raise MQTTNotConnected(f"Connection failed {connection_retries} times")
  522. sleep = connection_retries * 2
  523. await self._dispatch(
  524. Disconnect(
  525. reason="MQTT Error: no connection, retrying "
  526. f"in {connection_retries} seconds"
  527. )
  528. )
  529. await asyncio.sleep(sleep)
  530. else:
  531. err = pmc.error_string(rc)
  532. self.log.error("MQTT Error: %s", err)
  533. await self._dispatch(Disconnect(reason=f"MQTT Error: {err}, retrying"))
  534. await self._reconnect()
  535. connection_retries += 1
  536. else:
  537. connection_retries = 0
  538. if self._event_dispatcher_task:
  539. self._event_dispatcher_task.cancel()
  540. self._event_dispatcher_task = None
  541. if self._disconnect_error:
  542. self.log.info("disconnect_error is set, raising and clearing variable")
  543. err = self._disconnect_error
  544. self._disconnect_error = None
  545. raise err
  546. # region Basic outgoing MQTT
  547. def publish(self, topic: RealtimeTopic, payload: str | bytes | dict) -> asyncio.Future:
  548. if isinstance(payload, dict):
  549. payload = json.dumps(payload)
  550. if isinstance(payload, str):
  551. payload = payload.encode("utf-8")
  552. self.log.trace(f"Publishing message in {topic.value} ({topic.encoded}): {payload}")
  553. payload = zlib.compress(payload, level=9)
  554. info = self._client.publish(topic.encoded, payload, qos=1)
  555. self.log.trace(f"Published message ID: {info.mid}")
  556. fut = asyncio.Future()
  557. self._publish_waiters[info.mid] = fut
  558. return fut
  559. async def request(
  560. self,
  561. topic: RealtimeTopic,
  562. response: RealtimeTopic,
  563. payload: str | bytes | dict,
  564. timeout: int | None = None,
  565. ) -> pmc.MQTTMessage:
  566. async with self._response_waiter_locks[response]:
  567. fut = asyncio.Future()
  568. self._response_waiters[response] = fut
  569. await self.publish(topic, payload)
  570. self.log.trace(
  571. f"Request published to {topic.value}, waiting for response {response.name}"
  572. )
  573. return await asyncio.wait_for(fut, timeout)
  574. async def iris_subscribe(self, seq_id: int, snapshot_at_ms: int) -> None:
  575. self.log.debug(f"Requesting iris subscribe {seq_id}/{snapshot_at_ms}")
  576. resp = await self.request(
  577. RealtimeTopic.SUB_IRIS,
  578. RealtimeTopic.SUB_IRIS_RESPONSE,
  579. {
  580. "seq_id": seq_id,
  581. "snapshot_at_ms": snapshot_at_ms,
  582. "snapshot_app_version": self.state.application.APP_VERSION,
  583. "timezone_offset": int(self.state.device.timezone_offset),
  584. "subscription_type": "message",
  585. },
  586. timeout=20,
  587. )
  588. self.log.debug("Iris subscribe response: %s", resp.payload.decode("utf-8"))
  589. resp_dict = json.loads(resp.payload.decode("utf-8"))
  590. if resp_dict["error_type"] and resp_dict["error_message"]:
  591. raise IrisSubscribeError(resp_dict["error_type"], resp_dict["error_message"])
  592. latest_seq_id = resp_dict.get("latest_seq_id")
  593. if latest_seq_id > self._iris_seq_id:
  594. self.log.info(f"Latest sequence ID is {latest_seq_id}, catching up from {seq_id}")
  595. self._iris_seq_id = latest_seq_id
  596. self._iris_snapshot_at_ms = resp_dict.get("subscribed_at_ms", int(time.time() * 1000))
  597. asyncio.create_task(
  598. self._dispatch(NewSequenceID(self._iris_seq_id, self._iris_snapshot_at_ms))
  599. )
  600. def graphql_subscribe(self, subs: set[str]) -> asyncio.Future:
  601. self._graphql_subs |= subs
  602. return self.publish(RealtimeTopic.REALTIME_SUB, {"sub": list(subs)})
  603. def graphql_unsubscribe(self, subs: set[str]) -> asyncio.Future:
  604. self._graphql_subs -= subs
  605. return self.publish(RealtimeTopic.REALTIME_SUB, {"unsub": list(subs)})
  606. def skywalker_subscribe(self, subs: set[str]) -> asyncio.Future:
  607. self._skywalker_subs |= subs
  608. return self.publish(RealtimeTopic.PUBSUB, {"sub": list(subs)})
  609. def skywalker_unsubscribe(self, subs: set[str]) -> asyncio.Future:
  610. self._skywalker_subs -= subs
  611. return self.publish(RealtimeTopic.PUBSUB, {"unsub": list(subs)})
  612. # endregion
  613. # region Actually sending messages and stuff
  614. async def send_foreground_state(self, state: ForegroundStateConfig) -> None:
  615. self.log.debug("Updating foreground state: %s", state)
  616. await self.publish(
  617. RealtimeTopic.FOREGROUND_STATE, zlib.compress(state.to_thrift(), level=9)
  618. )
  619. if state.keep_alive_timeout:
  620. self._client._keepalive = state.keep_alive_timeout
  621. async def send_command(
  622. self,
  623. thread_id: str,
  624. action: ThreadAction,
  625. client_context: str | None = None,
  626. **kwargs: Any,
  627. ) -> CommandResponse | None:
  628. client_context = client_context or self.state.gen_client_context()
  629. req = {
  630. "thread_id": thread_id,
  631. "client_context": client_context,
  632. "offline_threading_id": client_context,
  633. "action": action.value,
  634. # "device_id": self.state.cookies["ig_did"],
  635. **kwargs,
  636. }
  637. if action in (ThreadAction.MARK_SEEN,):
  638. # Some commands don't have client_context in the response, so we can't properly match
  639. # them to the requests. We probably don't need the data, so just ignore it.
  640. await self.publish(RealtimeTopic.SEND_MESSAGE, payload=req)
  641. return None
  642. else:
  643. fut = asyncio.Future()
  644. self._message_response_waiters[client_context] = fut
  645. await self.publish(RealtimeTopic.SEND_MESSAGE, req)
  646. self.log.trace(
  647. f"Request published to {RealtimeTopic.SEND_MESSAGE}, "
  648. f"waiting for response {RealtimeTopic.SEND_MESSAGE_RESPONSE}"
  649. )
  650. resp = await fut
  651. return CommandResponse.parse_json(resp.payload.decode("utf-8"))
  652. def send_item(
  653. self,
  654. thread_id: str,
  655. item_type: ThreadItemType,
  656. shh_mode: bool = False,
  657. client_context: str | None = None,
  658. **kwargs: Any,
  659. ) -> Awaitable[CommandResponse]:
  660. return self.send_command(
  661. thread_id,
  662. item_type=item_type.value,
  663. is_shh_mode=str(int(shh_mode)),
  664. action=ThreadAction.SEND_ITEM,
  665. client_context=client_context,
  666. **kwargs,
  667. )
  668. def send_hashtag(
  669. self,
  670. thread_id: str,
  671. hashtag: str,
  672. text: str = "",
  673. shh_mode: bool = False,
  674. client_context: str | None = None,
  675. ) -> Awaitable[CommandResponse]:
  676. return self.send_item(
  677. thread_id,
  678. text=text,
  679. item_id=hashtag,
  680. shh_mode=shh_mode,
  681. item_type=ThreadItemType.HASHTAG,
  682. client_context=client_context,
  683. )
  684. def send_like(
  685. self, thread_id: str, shh_mode: bool = False, client_context: str | None = None
  686. ) -> Awaitable[CommandResponse]:
  687. return self.send_item(
  688. thread_id,
  689. shh_mode=shh_mode,
  690. item_type=ThreadItemType.LIKE,
  691. client_context=client_context,
  692. )
  693. def send_location(
  694. self,
  695. thread_id: str,
  696. venue_id: str,
  697. text: str = "",
  698. shh_mode: bool = False,
  699. client_context: str | None = None,
  700. ) -> Awaitable[CommandResponse]:
  701. return self.send_item(
  702. thread_id,
  703. text=text,
  704. item_id=venue_id,
  705. shh_mode=shh_mode,
  706. item_type=ThreadItemType.LOCATION,
  707. client_context=client_context,
  708. )
  709. def send_media(
  710. self,
  711. thread_id: str,
  712. media_id: str,
  713. text: str = "",
  714. shh_mode: bool = False,
  715. client_context: str | None = None,
  716. ) -> Awaitable[CommandResponse]:
  717. return self.send_item(
  718. thread_id,
  719. text=text,
  720. media_id=media_id,
  721. shh_mode=shh_mode,
  722. item_type=ThreadItemType.MEDIA_SHARE,
  723. client_context=client_context,
  724. )
  725. def send_profile(
  726. self,
  727. thread_id: str,
  728. user_id: str,
  729. text: str = "",
  730. shh_mode: bool = False,
  731. client_context: str | None = None,
  732. ) -> Awaitable[CommandResponse]:
  733. return self.send_item(
  734. thread_id,
  735. text=text,
  736. item_id=user_id,
  737. shh_mode=shh_mode,
  738. item_type=ThreadItemType.PROFILE,
  739. client_context=client_context,
  740. )
  741. def send_reaction(
  742. self,
  743. thread_id: str,
  744. emoji: str,
  745. item_id: str,
  746. reaction_status: ReactionStatus = ReactionStatus.CREATED,
  747. target_item_type: ThreadItemType = ThreadItemType.TEXT,
  748. shh_mode: bool = False,
  749. client_context: str | None = None,
  750. ) -> Awaitable[CommandResponse]:
  751. return self.send_item(
  752. thread_id,
  753. reaction_status=reaction_status.value,
  754. node_type="item",
  755. reaction_type="like",
  756. target_item_type=target_item_type.value,
  757. emoji=emoji,
  758. item_id=item_id,
  759. reaction_action_source="double_tap",
  760. shh_mode=shh_mode,
  761. item_type=ThreadItemType.REACTION,
  762. client_context=client_context,
  763. )
  764. def send_user_story(
  765. self,
  766. thread_id: str,
  767. media_id: str,
  768. text: str = "",
  769. shh_mode: bool = False,
  770. client_context: str | None = None,
  771. ) -> Awaitable[CommandResponse]:
  772. return self.send_item(
  773. thread_id,
  774. text=text,
  775. item_id=media_id,
  776. shh_mode=shh_mode,
  777. item_type=ThreadItemType.REEL_SHARE,
  778. client_context=client_context,
  779. )
  780. def send_text(
  781. self,
  782. thread_id: str,
  783. text: str = "",
  784. urls: list[str] | None = None,
  785. shh_mode: bool = False,
  786. client_context: str | None = None,
  787. replied_to_item_id: str | None = None,
  788. replied_to_client_context: str | None = None,
  789. ) -> Awaitable[CommandResponse]:
  790. args = {
  791. "text": text,
  792. }
  793. item_type = ThreadItemType.TEXT
  794. if urls is not None:
  795. args = {
  796. "link_text": text,
  797. "link_urls": json.dumps(urls or []),
  798. }
  799. item_type = ThreadItemType.LINK
  800. return self.send_item(
  801. thread_id,
  802. **args,
  803. shh_mode=shh_mode,
  804. item_type=item_type,
  805. client_context=client_context,
  806. replied_to_item_id=replied_to_item_id,
  807. replied_to_client_context=replied_to_client_context,
  808. )
  809. def mark_seen(
  810. self, thread_id: str, item_id: str, client_context: str | None = None
  811. ) -> Awaitable[None]:
  812. return self.send_command(
  813. thread_id,
  814. item_id=item_id,
  815. action=ThreadAction.MARK_SEEN,
  816. client_context=client_context,
  817. )
  818. def mark_visual_item_seen(
  819. self, thread_id: str, item_id: str, client_context: str | None = None
  820. ) -> Awaitable[CommandResponse]:
  821. return self.send_command(
  822. thread_id,
  823. item_id=item_id,
  824. action=ThreadAction.MARK_VISUAL_ITEM_SEEN,
  825. client_context=client_context,
  826. )
  827. def indicate_activity(
  828. self,
  829. thread_id: str,
  830. activity_status: TypingStatus = TypingStatus.TEXT,
  831. client_context: str | None = None,
  832. ) -> Awaitable[CommandResponse]:
  833. return self.send_command(
  834. thread_id,
  835. activity_status=activity_status.value,
  836. action=ThreadAction.INDICATE_ACTIVITY,
  837. client_context=client_context,
  838. )
  839. # endregion