1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
|
from __future__ import annotations
import asyncio
import contextlib
import json
import logging
import ssl
import struct
import time
import traceback
from base64 import urlsafe_b64decode
from contextlib import suppress as contextlib_suppress
from dataclasses import dataclass
from enum import Enum
from typing import TYPE_CHECKING, Any, Callable
from aiohttp import ClientSession
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives.serialization import load_der_private_key
from google.protobuf.json_format import MessageToJson
from google.protobuf.message import Message
from http_ece import decrypt as http_decrypt # type: ignore[import-untyped]
from .const import (
MCS_HOST,
MCS_PORT,
MCS_SELECTIVE_ACK_ID,
MCS_VERSION,
)
from .fcmregister import FcmRegister, FcmRegisterConfig
from .proto.mcs_pb2 import ( # pylint: disable=no-name-in-module
Close,
DataMessageStanza,
HeartbeatAck,
HeartbeatPing,
IqStanza,
LoginRequest,
LoginResponse,
SelectiveAck,
StreamErrorStanza,
)
_logger = logging.getLogger(__name__)
OnNotificationCallable = Callable[[dict[str, Any], str, Any], None]
CredentialsUpdatedCallable = Callable[[dict[str, Any]], None]
# MCS Message Types and Tags
MCS_MESSAGE_TAG = {
HeartbeatPing: 0,
HeartbeatAck: 1,
LoginRequest: 2,
LoginResponse: 3,
Close: 4,
"MessageStanza": 5,
"PresenceStanza": 6,
IqStanza: 7,
DataMessageStanza: 8,
"BatchPresenceStanza": 9,
StreamErrorStanza: 10,
"HttpRequest": 11,
"HttpResponse": 12,
"BindAccountRequest": 13,
"BindAccountResponse": 14,
"TalkMetadata": 15,
}
class ErrorType(Enum):
CONNECTION = 1
READ = 2
LOGIN = 3
NOTIFY = 4
class FcmPushClientRunState(Enum):
CREATED = (1,)
STARTING_TASKS = (2,)
STARTING_CONNECTION = (3,)
STARTING_LOGIN = (4,)
STARTED = (5,)
RESETTING = (6,)
STOPPING = (7,)
STOPPED = (8,)
@dataclass
class FcmPushClientConfig: # pylint:disable=too-many-instance-attributes
"""Class to provide configuration to
:class:`firebase_messaging.FcmPushClientConfig`.FcmPushClient."""
server_heartbeat_interval: int | None = 10
"""Time in seconds to request the server to send heartbeats"""
client_heartbeat_interval: int | None = 20
"""Time in seconds to send heartbeats to the server"""
send_selective_acknowledgements: bool = True
"""True to send selective acknowledgements for each message received.
Currently if false the client does not send any acknowlegements."""
connection_retry_count: int = 5
"""Number of times to retry the connection before giving up."""
start_seconds_before_retry_connect: float = 3
"""Time in seconds to wait before attempting to retry
the connection after failure."""
reset_interval: float = 3
"""Time in seconds to wait between resets after errors or disconnection."""
heartbeat_ack_timeout: float = 5
"""Time in seconds to wait for a heartbeat ack before resetting."""
abort_on_sequential_error_count: int | None = 3
"""Number of sequential errors of the same time to wait before aborting.
If set to None the client will not abort."""
monitor_interval: float = 1
"""Time in seconds for the monitor task to fire and check for heartbeats,
stale connections and shut down of the main event loop."""
log_warn_limit: int | None = 5
"""Number of times to log specific warning messages before going silent for
a specific warning type."""
log_debug_verbose: bool = False
"""Set to True to log all message info including tokens."""
class FcmPushClient: # pylint:disable=too-many-instance-attributes
"""Client that connects to Firebase Cloud Messaging and receives messages.
:param credentials: credentials object returned by register()
:param credentials_updated_callback: callback when new credentials are
created to allow client to store them
:param received_persistent_ids: any persistent id's you already received.
:param config: configuration class of
:class:`firebase_messaging.FcmPushClientConfig`
"""
def __init__(
self,
callback: Callable[[dict, str, Any | None], None],
fcm_config: FcmRegisterConfig,
credentials: dict | None = None,
credentials_updated_callback: CredentialsUpdatedCallable | None = None,
*,
callback_context: object | None = None,
received_persistent_ids: list[str] | None = None,
config: FcmPushClientConfig | None = None,
http_client_session: ClientSession | None = None,
):
"""Initializes the receiver."""
self.callback = callback
self.callback_context = callback_context
self.fcm_config = fcm_config
self.credentials = credentials
self.credentials_updated_callback = credentials_updated_callback
self.persistent_ids = received_persistent_ids if received_persistent_ids else []
self.config = config if config else FcmPushClientConfig()
if self.config.log_debug_verbose:
_logger.setLevel(logging.DEBUG)
self._http_client_session = http_client_session
self.reader: asyncio.StreamReader | None = None
self.writer: asyncio.StreamWriter | None = None
self.do_listen = False
self.sequential_error_counters: dict[ErrorType, int] = {}
self.log_warn_counters: dict[str, int] = {}
# reset variables
self.input_stream_id = 0
self.last_input_stream_id_reported = -1
self.first_message = True
self.last_login_time: float | None = None
self.last_message_time: float | None = None
self.run_state: FcmPushClientRunState = FcmPushClientRunState.CREATED
self.tasks: list[asyncio.Task] = []
self.reset_lock: asyncio.Lock | None = None
self.stopping_lock: asyncio.Lock | None = None
def _msg_str(self, msg: Message) -> str:
if self.config.log_debug_verbose:
return type(msg).__name__ + "\n" + MessageToJson(msg, indent=4)
return type(msg).__name__
def _log_verbose(self, msg: str, *args: object) -> None:
if self.config.log_debug_verbose:
_logger.debug(msg, *args)
def _log_warn_with_limit(self, msg: str, *args: object) -> None:
if msg not in self.log_warn_counters:
self.log_warn_counters[msg] = 0
if (
self.config.log_warn_limit
and self.config.log_warn_limit > self.log_warn_counters[msg]
):
self.log_warn_counters[msg] += 1
_logger.warning(msg, *args)
async def _do_writer_close(self) -> None:
writer = self.writer
self.writer = None
if writer:
writer.close()
with contextlib.suppress(Exception):
await writer.wait_closed()
async def _reset(self) -> None:
if (
(self.reset_lock and self.reset_lock.locked())
or (self.stopping_lock and self.stopping_lock.locked())
or not self.do_listen
):
return
async with self.reset_lock: # type: ignore[union-attr]
_logger.debug("Resetting connection")
self.run_state = FcmPushClientRunState.RESETTING
await self._do_writer_close()
now = time.time()
time_since_last_login = now - self.last_login_time # type: ignore[operator]
if time_since_last_login < self.config.reset_interval:
_logger.debug("%ss since last reset attempt.", time_since_last_login)
await asyncio.sleep(self.config.reset_interval - time_since_last_login)
_logger.debug("Reestablishing connection")
if not await self._connect_with_retry():
_logger.error(
"Unable to connect to MCS endpoint "
+ "after %s tries, shutting down",
self.config.connection_retry_count,
)
self._terminate()
return
_logger.debug("Re-connected to ssl socket")
await self._login()
# protobuf variable length integers are encoded in base 128
# each byte contains 7 bits of the integer and the msb is set if there's
# more. pretty simple to implement
async def _read_varint32(self) -> int:
res = 0
shift = 0
while True:
r = await self.reader.readexactly(1) # type: ignore[union-attr]
(b,) = struct.unpack("B", r)
res |= (b & 0x7F) << shift
if (b & 0x80) == 0:
break
shift += 7
return res
@staticmethod
def _encode_varint32(x: int) -> bytes:
if x == 0:
return bytes(bytearray([0]))
res = bytearray([])
while x != 0:
b = x & 0x7F
x >>= 7
if x != 0:
b |= 0x80
res.append(b)
return bytes(res)
@staticmethod
def _make_packet(msg: Message, include_version: bool) -> bytes:
tag = MCS_MESSAGE_TAG[type(msg)]
header = bytearray([MCS_VERSION, tag]) if include_version else bytearray([tag])
payload = msg.SerializeToString()
buf = bytes(header) + FcmPushClient._encode_varint32(len(payload)) + payload
return buf
async def _send_msg(self, msg: Message) -> None:
self._log_verbose("Sending packet to server: %s", self._msg_str(msg))
buf = FcmPushClient._make_packet(msg, self.first_message)
self.writer.write(buf) # type: ignore[union-attr]
await self.writer.drain() # type: ignore[union-attr]
async def _receive_msg(self) -> Message | None:
if self.first_message:
r = await self.reader.readexactly(2) # type: ignore[union-attr]
version, tag = struct.unpack("BB", r)
if version < MCS_VERSION and version != 38:
raise RuntimeError(f"protocol version {version} unsupported")
self.first_message = False
else:
r = await self.reader.readexactly(1) # type: ignore[union-attr]
(tag,) = struct.unpack("B", r)
size = await self._read_varint32()
self._log_verbose(
"Received message with tag %s and size %s",
tag,
size,
)
if not size >= 0:
self._log_warn_with_limit("Unexpected message size %s", size)
return None
buf = await self.reader.readexactly(size) # type: ignore[union-attr]
msg_class = next(iter([c for c, t in MCS_MESSAGE_TAG.items() if t == tag]))
if not msg_class:
self._log_warn_with_limit("Unexpected message tag %s", tag)
return None
if isinstance(msg_class, str):
self._log_warn_with_limit("Unconfigured message class %s", msg_class)
return None
payload = msg_class() # type: ignore[operator]
payload.ParseFromString(buf)
self._log_verbose("Received payload: %s", self._msg_str(payload))
return payload
async def _login(self) -> None:
self.run_state = FcmPushClientRunState.STARTING_LOGIN
now = time.time()
self.input_stream_id = 0
self.last_input_stream_id_reported = -1
self.first_message = True
self.last_login_time = now
try:
android_id = self.credentials["gcm"]["android_id"] # type: ignore[index]
req = LoginRequest()
req.adaptive_heartbeat = False
req.auth_service = LoginRequest.ANDROID_ID # 2
req.auth_token = self.credentials["gcm"]["security_token"] # type: ignore[index]
req.id = self.fcm_config.chrome_version
req.domain = "mcs.android.com"
req.device_id = f"android-{int(android_id):x}"
req.network_type = 1
req.resource = android_id
req.user = android_id
req.use_rmq2 = True
req.setting.add(name="new_vc", value="1")
req.received_persistent_id.extend(self.persistent_ids)
if (
self.config.server_heartbeat_interval
and self.config.server_heartbeat_interval > 0
):
req.heartbeat_stat.ip = ""
req.heartbeat_stat.timeout = True
req.heartbeat_stat.interval_ms = (
1000 * self.config.server_heartbeat_interval
)
await self._send_msg(req)
_logger.debug("Sent login request")
except Exception as ex:
_logger.error("Received an exception logging in: %s", ex)
if self._try_increment_error_count(ErrorType.LOGIN):
await self._reset()
@staticmethod
def _decrypt_raw_data(
credentials: dict[str, dict[str, str]],
crypto_key_str: str,
salt_str: str,
raw_data: bytes,
) -> bytes:
crypto_key = urlsafe_b64decode(crypto_key_str.encode("ascii"))
salt = urlsafe_b64decode(salt_str.encode("ascii"))
der_data_str = credentials["keys"]["private"]
der_data = urlsafe_b64decode(der_data_str.encode("ascii") + b"========")
secret_str = credentials["keys"]["secret"]
secret = urlsafe_b64decode(secret_str.encode("ascii") + b"========")
privkey = load_der_private_key(
der_data, password=None, backend=default_backend()
)
decrypted = http_decrypt(
raw_data,
salt=salt,
private_key=privkey,
dh=crypto_key,
version="aesgcm",
auth_secret=secret,
)
return decrypted
def _app_data_by_key(
self, p: DataMessageStanza, key: str, do_not_raise: bool = False
) -> str:
for x in p.app_data:
if x.key == key:
return x.value
if do_not_raise:
return ""
raise RuntimeError(f"couldn't find in app_data {key}")
def _handle_data_message(
self,
msg: DataMessageStanza,
) -> None:
_logger.debug(
"Received data message Stream ID: %s, Last: %s, Status: %s",
msg.stream_id,
msg.last_stream_id_received,
msg.status,
)
if (
self._app_data_by_key(msg, "message_type", do_not_raise=True)
== "deleted_messages"
):
# The deleted_messages message does not contain data.
return
crypto_key = self._app_data_by_key(msg, "crypto-key")[3:] # strip dh=
salt = self._app_data_by_key(msg, "encryption")[5:] # strip salt=
subtype = self._app_data_by_key(msg, "subtype")
if TYPE_CHECKING:
assert self.credentials
if subtype != self.credentials["gcm"]["app_id"]:
self._log_warn_with_limit(
"Subtype %s in data message does not match"
+ "app id client was registered with %s",
subtype,
self.credentials["gcm"]["app_id"],
)
if not self.credentials:
return
decrypted = self._decrypt_raw_data(
self.credentials, crypto_key, salt, msg.raw_data
)
with contextlib_suppress(json.JSONDecodeError, ValueError):
decrypted_json = json.loads(decrypted.decode("utf-8"))
ret_val = decrypted_json if decrypted_json else decrypted
self._log_verbose(
"Decrypted data for message %s is: %s", msg.persistent_id, ret_val
)
try:
self.callback(ret_val, msg.persistent_id, self.callback_context)
self._reset_error_count(ErrorType.NOTIFY)
except Exception:
_logger.exception("Unexpected exception calling notification callback\n")
self._try_increment_error_count(ErrorType.NOTIFY)
def _new_input_stream_id_available(self) -> bool:
return self.last_input_stream_id_reported != self.input_stream_id
def _get_input_stream_id(self) -> int:
self.last_input_stream_id_reported = self.input_stream_id
return self.input_stream_id
async def _handle_ping(self, p: HeartbeatPing) -> None:
_logger.debug(
"Received heartbeat ping, sending ack: Stream ID: %s, Last: %s, Status: %s",
p.stream_id,
p.last_stream_id_received,
p.status,
)
req = HeartbeatAck()
if self._new_input_stream_id_available():
req.last_stream_id_received = self._get_input_stream_id()
await self._send_msg(req)
async def _handle_iq(self, p: IqStanza) -> None:
if not p.extension:
self._log_warn_with_limit(
"Unexpected IqStanza id received with no extension", str(p)
)
return
if p.extension.id not in (12, 13):
self._log_warn_with_limit(
"Unexpected extension id received: %s", p.extension.id
)
return
async def _send_selective_ack(self, persistent_id: str) -> None:
iqs = IqStanza()
iqs.type = IqStanza.IqType.SET
iqs.id = ""
iqs.extension.id = MCS_SELECTIVE_ACK_ID
sa = SelectiveAck()
sa.id.extend([persistent_id])
iqs.extension.data = sa.SerializeToString()
_logger.debug("Sending selective ack for message id %s", persistent_id)
await self._send_msg(iqs)
async def _send_heartbeat(self) -> None:
req = HeartbeatPing()
if self._new_input_stream_id_available():
req.last_stream_id_received = self._get_input_stream_id()
await self._send_msg(req)
_logger.debug("Sent heartbeat ping")
def _terminate(self) -> None:
self.run_state = FcmPushClientRunState.STOPPING
self.do_listen = False
current_task = asyncio.current_task()
for task in self.tasks:
if (
current_task != task and not task.done()
): # cancel return if task is done so no need to check
task.cancel()
async def _do_monitor(self) -> None:
while self.do_listen:
await asyncio.sleep(self.config.monitor_interval)
if self.run_state == FcmPushClientRunState.STARTED:
# if server_heartbeat_interval is set and less than
# client_heartbeat_interval then the last_message_time
# will be within the client window if connected
if self.config.client_heartbeat_interval:
now = time.time()
if (
self.last_message_time + self.config.client_heartbeat_interval # type: ignore[operator]
< now
):
await self._send_heartbeat()
await asyncio.sleep(self.config.heartbeat_ack_timeout)
now = time.time()
if ( # Check state hasn't changed during sleep
self.last_message_time # type: ignore[operator]
+ self.config.client_heartbeat_interval
< now
and self.do_listen
and self.run_state == FcmPushClientRunState.STARTED
):
await self._reset()
elif self.config.server_heartbeat_interval:
now = time.time()
if ( # We give the server 2 extra seconds
self.last_message_time + self.config.server_heartbeat_interval # type: ignore[operator]
< now - 2
):
await self._reset()
def _reset_error_count(self, error_type: ErrorType) -> None:
self.sequential_error_counters[error_type] = 0
def _try_increment_error_count(self, error_type: ErrorType) -> bool:
if error_type not in self.sequential_error_counters:
self.sequential_error_counters[error_type] = 0
self.sequential_error_counters[error_type] += 1
if (
self.config.abort_on_sequential_error_count
and self.sequential_error_counters[error_type]
>= self.config.abort_on_sequential_error_count
):
_logger.error(
"Shutting down push receiver due to "
+ f"{self.sequential_error_counters[error_type]} sequential"
+ f" errors of type {error_type}"
)
self._terminate()
return False
return True
async def _handle_message(self, msg: Message) -> None:
self.last_message_time = time.time()
self.input_stream_id += 1
if isinstance(msg, Close):
self._log_warn_with_limit("Server sent Close message, resetting")
if self._try_increment_error_count(ErrorType.CONNECTION):
await self._reset()
return
if isinstance(msg, LoginResponse):
if str(msg.error):
_logger.error("Received login error response: %s", msg)
if self._try_increment_error_count(ErrorType.LOGIN):
await self._reset()
else:
_logger.info("Succesfully logged in to MCS endpoint")
self._reset_error_count(ErrorType.LOGIN)
self.run_state = FcmPushClientRunState.STARTED
self.persistent_ids = []
return
if isinstance(msg, DataMessageStanza):
self._handle_data_message(msg)
self.persistent_ids.append(msg.persistent_id)
if self.config.send_selective_acknowledgements:
await self._send_selective_ack(msg.persistent_id)
elif isinstance(msg, HeartbeatPing):
await self._handle_ping(msg)
elif isinstance(msg, HeartbeatAck):
_logger.debug("Received heartbeat ack: %s", msg)
elif isinstance(msg, IqStanza):
pass
else:
self._log_warn_with_limit("Unexpected message type %s.", type(msg).__name__)
# Reset error count if a read has been succesful
self._reset_error_count(ErrorType.READ)
self._reset_error_count(ErrorType.CONNECTION)
@staticmethod
async def _open_connection(
host: str, port: int, ssl_context: ssl.SSLContext
) -> tuple[asyncio.StreamReader, asyncio.StreamWriter]:
return await asyncio.open_connection(host=host, port=port, ssl=ssl_context)
async def _connect(self) -> bool:
try:
loop = asyncio.get_running_loop()
# create_default_context() blocks the event loop
ssl_context = await loop.run_in_executor(None, ssl.create_default_context)
self.reader, self.writer = await self._open_connection(
host=MCS_HOST, port=MCS_PORT, ssl_context=ssl_context
)
_logger.debug("Connected to MCS endpoint (%s,%s)", MCS_HOST, MCS_PORT)
return True
except OSError as oex:
_logger.error(
"Could not connected to MCS endpoint (%s,%s): %s",
MCS_HOST,
MCS_PORT,
oex,
)
return False
async def _connect_with_retry(self) -> bool:
self.run_state = FcmPushClientRunState.STARTING_CONNECTION
trycount = 0
connected = False
while (
trycount < self.config.connection_retry_count
and not connected
and self.do_listen
):
trycount += 1
connected = await self._connect()
if not connected:
sleep_time = (
self.config.start_seconds_before_retry_connect * trycount * trycount
)
_logger.info(
"Could not connect to MCS Endpoint on "
+ "try %s, sleeping for %s seconds",
trycount,
sleep_time,
)
await asyncio.sleep(sleep_time)
if not connected:
_logger.error(
"Unable to connect to MCS endpoint after %s tries, aborting", trycount
)
return connected
async def _listen(self) -> None:
"""listens for push notifications."""
if not await self._connect_with_retry():
return
try:
await self._login()
while self.do_listen:
try:
if self.run_state == FcmPushClientRunState.RESETTING:
await asyncio.sleep(1)
elif msg := await self._receive_msg():
await self._handle_message(msg)
except (OSError, EOFError) as osex:
if (
isinstance(
osex,
(
ConnectionResetError,
TimeoutError,
asyncio.IncompleteReadError,
ssl.SSLError,
),
)
and self.run_state == FcmPushClientRunState.RESETTING
):
if (
isinstance(osex, ssl.SSLError) # pylint: disable=no-member
and osex.reason != "APPLICATION_DATA_AFTER_CLOSE_NOTIFY"
):
self._log_warn_with_limit(
"Unexpected SSLError reason during reset of %s",
osex.reason,
)
else:
self._log_verbose(
"Expected read error during reset: %s",
type(osex).__name__,
)
else:
_logger.exception("Unexpected exception during read\n")
if self._try_increment_error_count(ErrorType.CONNECTION):
await self._reset()
except Exception as ex:
_logger.error(
"Unknown error: %s, shutting down FcmPushClient.\n%s",
ex,
traceback.format_exc(),
)
self._terminate()
finally:
await self._do_writer_close()
async def checkin_or_register(self) -> str:
"""Check in if you have credentials otherwise register as a new client.
:param sender_id: sender id identifying push service you are connecting to.
:param app_id: identifier for your application.
:return: The FCM token which is used to identify you with the push end
point application.
"""
self.register = FcmRegister(
self.fcm_config,
self.credentials,
self.credentials_updated_callback,
http_client_session=self._http_client_session,
)
self.credentials = await self.register.checkin_or_register()
# await self.register.fcm_refresh_install()
await self.register.close()
return self.credentials["fcm"]["registration"]["token"]
async def start(self) -> None:
"""Connect to FCM and start listening for push notifications."""
self.reset_lock = asyncio.Lock()
self.stopping_lock = asyncio.Lock()
self.do_listen = True
self.run_state = FcmPushClientRunState.STARTING_TASKS
try:
self.tasks = [
asyncio.create_task(self._listen()),
asyncio.create_task(self._do_monitor()),
]
except Exception as ex:
_logger.error("Unexpected error running FcmPushClient: %s", ex)
async def stop(self) -> None:
if (
self.stopping_lock
and self.stopping_lock.locked()
or self.run_state
in (
FcmPushClientRunState.STOPPING,
FcmPushClientRunState.STOPPED,
)
):
return
async with self.stopping_lock: # type: ignore[union-attr]
try:
self.run_state = FcmPushClientRunState.STOPPING
self.do_listen = False
for task in self.tasks:
if not task.done():
task.cancel()
finally:
self.run_state = FcmPushClientRunState.STOPPED
self.fcm_thread = None
self.listen_event_loop = None
def is_started(self) -> bool:
return self.run_state == FcmPushClientRunState.STARTED
async def send_message(self, raw_data: bytes, persistent_id: str) -> None:
"""Not implemented, does nothing atm."""
dms = DataMessageStanza()
dms.persistent_id = persistent_id
# Not supported yet
|