forked from home-assistant-libs/pychromecast
-
Notifications
You must be signed in to change notification settings - Fork 0
/
socket_client.py
1157 lines (996 loc) · 40.3 KB
/
socket_client.py
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
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Module to interact with the ChromeCast via protobuf-over-socket.
Big thanks goes out to Fred Clift <fred@clift.org> who build the first
version of this code: https://github.com/minektur/chromecast-python-poc.
Without him this would not have been possible.
"""
# pylint: disable=too-many-lines
from __future__ import annotations
import abc
import errno
import json
import logging
import selectors
import socket
import ssl
import threading
import time
from collections import defaultdict
from dataclasses import dataclass
from struct import pack, unpack
import zeroconf
from .const import MESSAGE_TYPE, REQUEST_ID, SESSION_ID
from .controllers import BaseController, CallbackType
from .controllers.media import MediaController
from .controllers.receiver import CastStatus, CastStatusListener, ReceiverController
from .dial import get_host_from_service
from .error import (
ChromecastConnectionError,
ControllerNotRegistered,
NotConnected,
PyChromecastStopped,
UnsupportedNamespace,
)
# pylint: disable-next=no-name-in-module
from .generated.cast_channel_pb2 import CastMessage
from .models import HostServiceInfo, MDNSServiceInfo
NS_CONNECTION = "urn:x-cast:com.google.cast.tp.connection"
NS_HEARTBEAT = "urn:x-cast:com.google.cast.tp.heartbeat"
PLATFORM_DESTINATION_ID = "receiver-0"
TYPE_PING = "PING"
TYPE_PONG = "PONG"
TYPE_CONNECT = "CONNECT"
TYPE_CLOSE = "CLOSE"
TYPE_LOAD = "LOAD"
# The socket connection is being setup
CONNECTION_STATUS_CONNECTING = "CONNECTING"
# The socket connection was complete
CONNECTION_STATUS_CONNECTED = "CONNECTED"
# The socket connection has been disconnected
CONNECTION_STATUS_DISCONNECTED = "DISCONNECTED"
# Connecting to socket failed (after a CONNECTION_STATUS_CONNECTING)
CONNECTION_STATUS_FAILED = "FAILED"
# Failed to resolve service name
CONNECTION_STATUS_FAILED_RESOLVE = "FAILED_RESOLVE"
# The socket connection was lost and needs to be retried
CONNECTION_STATUS_LOST = "LOST"
HB_PING_TIME = 10
HB_PONG_TIME = 10
TIMEOUT_TIME = 30.0
RETRY_TIME = 5.0
class InterruptLoop(Exception):
"""The chromecast has been manually stopped."""
def _dict_from_message_payload(message: CastMessage) -> dict:
"""Parses a PB2 message as a JSON dict."""
try:
data = json.loads(message.payload_utf8)
if not isinstance(data, dict):
logger = logging.getLogger(__name__)
logger.debug(
"Non dict json in namespace %s: '%s'",
message.namespace,
message.payload_utf8,
)
return {}
return data
except ValueError:
logger = logging.getLogger(__name__)
logger.debug(
"Invalid json in namespace %s: '%s'",
message.namespace,
message.payload_utf8,
)
return {}
def _message_to_string(
message: CastMessage,
data: dict | None = None,
) -> str:
"""Gives a string representation of a PB2 message."""
if data is None:
data = _dict_from_message_payload(message)
return (
f"Message {message.namespace} from {message.source_id} to "
f"{message.destination_id}: {data or message.payload_utf8}"
)
@dataclass(frozen=True)
class NetworkAddress:
"""Network address container."""
address: str
port: int | None
@dataclass(frozen=True)
class ConnectionStatus:
"""Connection status container."""
status: str
address: NetworkAddress | None
service: HostServiceInfo | MDNSServiceInfo | None
class ConnectionStatusListener(abc.ABC):
"""Listener for receiving connection status events."""
@abc.abstractmethod
def new_connection_status(self, status: ConnectionStatus) -> None:
"""Updated connection status."""
# pylint: disable-next=too-many-instance-attributes
class SocketClient(threading.Thread, CastStatusListener):
"""
Class to interact with a Chromecast through a socket.
:param host: The host to connect to.
:param port: The port to use when connecting to the device, set to None to
use the default of 8009. Special devices such as Cast Groups
may return a different port number so we need to use that.
:param cast_type: The type of chromecast to connect to, see
dial.CAST_TYPE_* for types.
:param tries: Number of retries to perform if the connection fails.
None for infinite retries.
:param timeout: A floating point number specifying the socket timeout in
seconds. None means to use the default which is 30 seconds.
:param retry_wait: A floating point number specifying how many seconds to
wait between each retry. None means to use the default
which is 5 seconds.
:param services: A list of mDNS services to try to connect to. If present,
parameters host and port are ignored and host and port are
instead resolved through mDNS. The list of services may be
modified, for example if speaker group leadership is handed
over. SocketClient will catch modifications to the list when
attempting reconnect.
:param zconf: A zeroconf instance, needed if a list of services is passed.
The zeroconf instance may be obtained from the browser returned by
pychromecast.start_discovery().
"""
# pylint: disable-next=too-many-arguments
def __init__(
self,
*,
cast_type: str,
tries: int | None,
timeout: float | None,
retry_wait: float | None,
services: set[HostServiceInfo | MDNSServiceInfo],
zconf: zeroconf.Zeroconf | None,
) -> None:
super().__init__()
self.daemon = True
self.logger = logging.getLogger(__name__)
self._force_recon = False
self.cast_type = cast_type
self.fn: str | None = None # pylint:disable=invalid-name
self.tries = tries
self.timeout = timeout or TIMEOUT_TIME
self.retry_wait = retry_wait or RETRY_TIME
self.services = services
self.zconf = zconf
self.host = "unknown"
self.port = 8009
self.source_id = "sender-0"
self.stop = threading.Event()
# socketpair used to interrupt the worker thread
self.socketpair = socket.socketpair()
self.app_namespaces: list[str] = []
self.destination_id: str | None = None
self.session_id: str | None = None
self._request_id = 0
self._request_callbacks: dict[int, CallbackType] = {}
self._open_channels: list[str] = []
self.connecting = True
self.first_connection = True
self.socket: socket.socket | ssl.SSLSocket | None = None
self.selector = selectors.DefaultSelector()
self.wakeup_selector_key = self.selector.register(
self.socketpair[0], selectors.EVENT_READ
)
self.remote_selector_key: selectors.SelectorKey | None = None
# dict mapping namespace on Controller objects
self._handlers: dict[str, set[BaseController]] = defaultdict(set)
self._connection_listeners: list[ConnectionStatusListener] = []
self.receiver_controller = ReceiverController(cast_type)
self.media_controller = MediaController()
self.heartbeat_controller = HeartbeatController()
self.register_handler(self.heartbeat_controller)
self.register_handler(ConnectionController())
self.register_handler(self.receiver_controller)
self.register_handler(self.media_controller)
self.receiver_controller.register_status_listener(self)
def initialize_connection( # pylint:disable=too-many-statements, too-many-branches
self,
) -> None:
"""Initialize a socket to a Chromecast, retrying as necessary."""
tries = self.tries
if self.socket is not None:
self.selector.unregister(self.socket)
self.socket.close()
self.socket = None
self.remote_selector_key = None
# Make sure nobody is blocking.
for callback_function in self._request_callbacks.values():
callback_function(False, None)
self.app_namespaces = []
self.destination_id = None
self.session_id = None
self._request_id = 0
self._request_callbacks = {}
self._open_channels = []
self.connecting = True
retry_log_fun = self.logger.error
# Dict keeping track of individual retry delay for each named service
retries: dict[HostServiceInfo | MDNSServiceInfo, dict[str, float]] = {}
def mdns_backoff(
service: HostServiceInfo | MDNSServiceInfo,
retry: dict[str, float],
) -> None:
"""Exponentional backoff for service name mdns lookups."""
now = time.time()
retry["next_retry"] = now + retry["delay"]
retry["delay"] = min(retry["delay"] * 2, 300)
retries[service] = retry
while not self.stop.is_set() and (
tries is None or tries > 0
): # pylint:disable=too-many-nested-blocks
# Prune retries dict
retries = {
key: retries[key]
for key in self.services.copy()
if (key is not None and key in retries)
}
for service in self.services.copy():
now = time.time()
retry = retries.get(
service, {"delay": self.retry_wait, "next_retry": now}
)
if now < retry["next_retry"]:
continue
try:
if self.socket is not None:
# If we retry connecting, we need to clean up the socket again
self.selector.unregister(self.socket) # type: ignore[unreachable]
self.socket.close()
self.socket = None
self.remote_selector_key = None
self.socket = new_socket()
self.remote_selector_key = self.selector.register(
self.socket, selectors.EVENT_READ
)
self.socket.settimeout(self.timeout)
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_CONNECTING,
NetworkAddress(self.host, self.port),
None,
)
)
# Resolve the service name.
host = None
port = None
host, port, service_info = get_host_from_service(
service, self.zconf
)
if host and port:
if service_info:
try:
# Mypy does not understand that we catch errors, ignore it
self.fn = service_info.properties[b"fn"].decode("utf-8") # type: ignore[union-attr]
except (AttributeError, KeyError, UnicodeError):
pass
self.logger.debug(
"[%s(%s):%s] Resolved service %s to %s:%s",
self.fn or "",
self.host,
self.port,
service,
host,
port,
)
self.host = host
self.port = port
else:
self.logger.debug(
"[%s(%s):%s] Failed to resolve service %s",
self.fn or "",
self.host,
self.port,
service,
)
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_FAILED_RESOLVE,
None,
service,
)
)
mdns_backoff(service, retry)
# If zeroconf fails to receive the necessary data,
# try next service
continue
self.logger.debug(
"[%s(%s):%s] Connecting to %s:%s",
self.fn or "",
self.host,
self.port,
self.host,
self.port,
)
self.socket.connect((self.host, self.port))
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
self.socket = context.wrap_socket(self.socket)
self.connecting = False
self._force_recon = False
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_CONNECTED,
NetworkAddress(self.host, self.port),
None,
)
)
self.receiver_controller.update_status()
self.heartbeat_controller.ping()
self.heartbeat_controller.reset()
if self.first_connection:
self.first_connection = False
self.logger.debug(
"[%s(%s):%s] Connected!",
self.fn or "",
self.host,
self.port,
)
else:
self.logger.info(
"[%s(%s):%s] Connection reestablished!",
self.fn or "",
self.host,
self.port,
)
return
# OSError raised if connecting to the socket fails, NotConnected raised
# if another thread tries - and fails - to send a message before the
# calls to receiver_controller and heartbeat_controller.
except (OSError, NotConnected) as err:
self.connecting = True
if self.stop.is_set():
self.logger.error(
"[%s(%s):%s] Failed to connect: %s. aborting due to stop signal.",
self.fn or "",
self.host,
self.port,
err,
)
raise ChromecastConnectionError("Failed to connect") from err
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_FAILED,
NetworkAddress(self.host, self.port),
None,
)
)
retry_log_fun(
"[%s(%s):%s] Failed to connect to service %s, retrying in %.1fs",
self.fn or "",
self.host,
self.port,
service,
retry["delay"],
)
mdns_backoff(service, retry)
retry_log_fun = self.logger.debug
# Only sleep if we have another retry remaining
if tries is None or tries > 1:
self.logger.debug(
"[%s(%s):%s] Not connected, sleeping for %.1fs. Services: %s",
self.fn or "",
self.host,
self.port,
self.retry_wait,
self.services,
)
time.sleep(self.retry_wait)
if tries:
tries -= 1
self.stop.set()
self.logger.error(
"[%s(%s):%s] Failed to connect. No retries.",
self.fn or "",
self.host,
self.port,
)
raise ChromecastConnectionError("Failed to connect")
def disconnect(self) -> None:
"""Disconnect socket connection to Chromecast device"""
self.stop.set()
try:
# Write to the socket to interrupt the worker thread
self.socketpair[1].send(b"x")
except socket.error:
# The socketpair may already be closed during shutdown, ignore it
pass
def register_handler(self, handler: BaseController) -> None:
"""Register a new namespace handler."""
self._handlers[handler.namespace].add(handler)
handler.registered(self)
def unregister_handler(self, handler: BaseController) -> None:
"""Register a new namespace handler."""
if (
handler.namespace in self._handlers
and handler in self._handlers[handler.namespace]
):
self._handlers[handler.namespace].remove(handler)
handler.unregistered()
def new_cast_status(self, status: CastStatus) -> None:
"""Called when a new cast status has been received."""
new_channel = self.destination_id != status.transport_id
if new_channel and self.destination_id is not None:
self.disconnect_channel(self.destination_id)
self.app_namespaces = status.namespaces
self.destination_id = status.transport_id
self.session_id = status.session_id
# When a new cast status is received, give Audible time to load
if status.app_id == "25456794":
self.logger.debug("Detected Audible connection. Sleeping for 1s")
time.sleep(1)
if new_channel and self.destination_id is not None:
# If any of the namespaces of the new app are supported
# we will automatically connect to it to receive updates
for namespace in self.app_namespaces:
if namespace in self._handlers:
self._ensure_channel_connected(self.destination_id)
for handler in set(self._handlers[namespace]):
handler.channel_connected()
def _gen_request_id(self) -> int:
"""Generates a unique request id."""
self._request_id += 1
return self._request_id
@property
def is_connected(self) -> bool:
"""
Returns True if the client is connected, False if it is stopped
(or trying to connect).
"""
return not self.connecting
@property
def is_stopped(self) -> bool:
"""
Returns True if the connection has been stopped, False if it is
running.
"""
return self.stop.is_set()
def run(self) -> None:
"""Connect to the cast and start polling the socket."""
try:
self.initialize_connection()
except ChromecastConnectionError:
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_DISCONNECTED,
NetworkAddress(self.host, self.port),
None,
)
)
return
self.heartbeat_controller.reset()
self.logger.debug("Thread started...")
while not self.stop.is_set():
try:
if self._run_once() == 1:
break
except Exception: # pylint: disable=broad-except
self._force_recon = True
self.logger.exception(
"[%s(%s):%s] Unhandled exception in worker thread, attempting reconnect",
self.fn or "",
self.host,
self.port,
)
self.logger.debug("Thread done...")
# Clean up
self._cleanup()
def _run_once(self) -> int:
"""Receive from the socket and handle data."""
# pylint: disable=too-many-branches, too-many-statements, too-many-return-statements
try:
if not self._check_connection():
return 0
except ChromecastConnectionError:
return 1
# A connection has been established at this point by self._check_connection
assert self.socket is not None
# poll the socket, as well as the socketpair to allow us to be interrupted
try:
ready = self.selector.select()
except (ValueError, OSError) as exc:
self.logger.error(
"[%s(%s):%s] Error in select call: %s",
self.fn or "",
self.host,
self.port,
exc,
)
self._force_recon = True
return 0
can_read = {key for key, _ in ready}
# read message from chromecast
message = None
if self.remote_selector_key in can_read and not self._force_recon:
try:
message = self._read_message()
except InterruptLoop as exc:
if self.stop.is_set():
self.logger.info(
"[%s(%s):%s] Stopped while reading message, disconnecting.",
self.fn or "",
self.host,
self.port,
)
else:
self.logger.error(
"[%s(%s):%s] Interruption caught without being stopped: %s",
self.fn or "",
self.host,
self.port,
exc,
)
return 1
except ssl.SSLError as exc:
if exc.errno == ssl.SSL_ERROR_EOF:
if self.stop.is_set():
return 1
raise
except socket.error:
self._force_recon = True
self.logger.error(
"[%s(%s):%s] Error reading from socket.",
self.fn or "",
self.host,
self.port,
)
else:
data = _dict_from_message_payload(message)
if self.wakeup_selector_key in can_read:
# Clear the socket's buffer
self.socketpair[0].recv(128)
# If we are stopped after receiving a message we skip the message
# and tear down the connection
if self.stop.is_set():
return 1
if not message:
return 0
# See if any handlers will accept this message
self._route_message(message, data)
if REQUEST_ID in data and data[REQUEST_ID] in self._request_callbacks:
self._request_callbacks.pop(data[REQUEST_ID])(True, data)
return 0
def _check_connection(self) -> bool:
"""
Checks if the connection is active, and if not reconnect
:return: True if the connection is active, False if the connection was
reset.
"""
# check if connection is expired
reset = False
if self._force_recon:
self.logger.warning(
"[%s(%s):%s] Error communicating with socket, resetting connection",
self.fn or "",
self.host,
self.port,
)
reset = True
elif self.heartbeat_controller.is_expired():
self.logger.warning(
"[%s(%s):%s] Heartbeat timeout, resetting connection",
self.fn or "",
self.host,
self.port,
)
reset = True
if reset:
self.receiver_controller.disconnected()
for channel in self._open_channels:
self.disconnect_channel(channel)
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_LOST, NetworkAddress(self.host, self.port), None
)
)
try:
self.initialize_connection()
except ChromecastConnectionError:
self.stop.set()
return False
return True
def _route_message(self, message: CastMessage, data: dict) -> None:
"""Route message to any handlers on the message namespace"""
# route message to handlers
if message.namespace in self._handlers:
# debug messages
if message.namespace != NS_HEARTBEAT:
self.logger.debug(
"[%s(%s):%s] Received: %s",
self.fn or "",
self.host,
self.port,
_message_to_string(message, data),
)
# message handlers
for handler in set(self._handlers[message.namespace]):
try:
handled = handler.receive_message(message, data)
if not handled:
if data.get(REQUEST_ID) not in self._request_callbacks:
self.logger.debug(
"[%s(%s):%s] Message unhandled: %s",
self.fn or "",
self.host,
self.port,
_message_to_string(message, data),
)
except Exception: # pylint: disable=broad-except
self.logger.exception(
(
"[%s(%s):%s] Exception caught while sending message to "
"controller %s: %s"
),
self.fn or "",
self.host,
self.port,
type(handler).__name__,
_message_to_string(message, data),
)
else:
self.logger.debug(
"[%s(%s):%s] Received unknown namespace: %s",
self.fn or "",
self.host,
self.port,
_message_to_string(message, data),
)
def _cleanup(self) -> None:
"""Cleanup open channels and handlers"""
for channel in self._open_channels:
try:
self.disconnect_channel(channel)
except Exception: # pylint: disable=broad-except
pass
for handlers in self._handlers.values():
for handler in set(handlers):
try:
handler.tear_down()
except Exception: # pylint: disable=broad-except
pass
if self.socket is not None:
try:
self.socket.close()
except Exception: # pylint: disable=broad-except
self.logger.exception(
"[%s(%s):%s] _cleanup", self.fn or "", self.host, self.port
)
self._report_connection_status(
ConnectionStatus(
CONNECTION_STATUS_DISCONNECTED,
NetworkAddress(self.host, self.port),
None,
)
)
self.socketpair[0].close()
self.socketpair[1].close()
self.selector.close()
self.connecting = True
def _report_connection_status(self, status: ConnectionStatus) -> None:
"""Report a change in the connection status to any listeners"""
for listener in self._connection_listeners:
try:
self.logger.debug(
"[%s(%s):%s] connection listener: %x (%s) %s",
self.fn or "",
self.host,
self.port,
id(listener),
type(listener).__name__,
status,
)
listener.new_connection_status(status)
except Exception: # pylint: disable=broad-except
self.logger.exception(
"[%s(%s):%s] Exception thrown when calling connection listener",
self.fn or "",
self.host,
self.port,
)
def _read_bytes_from_socket(self, msglen: int) -> bytes:
"""Read bytes from the socket."""
# It is a programming error if this is called when we don't have a socket
assert self.socket is not None
chunks = []
bytes_recd = 0
while bytes_recd < msglen:
if self.stop.is_set():
raise InterruptLoop("Stopped while reading from socket")
try:
chunk = self.socket.recv(min(msglen - bytes_recd, 2048))
if chunk == b"":
raise socket.error("socket connection broken")
chunks.append(chunk)
bytes_recd += len(chunk)
except TimeoutError:
self.logger.debug(
"[%s(%s):%s] timeout in : _read_bytes_from_socket",
self.fn or "",
self.host,
self.port,
)
continue
return b"".join(chunks)
def _read_message(self) -> CastMessage:
"""Reads a message from the socket and converts it to a message."""
# first 4 bytes is Big-Endian payload length
payload_info = self._read_bytes_from_socket(4)
read_len = unpack(">I", payload_info)[0]
# now read the payload
payload = self._read_bytes_from_socket(read_len)
message = CastMessage()
message.ParseFromString(payload)
return message
# pylint: disable=too-many-arguments, too-many-branches
def send_message(
self,
destination_id: str,
namespace: str,
data: dict,
*,
inc_session_id: bool = False,
callback_function: CallbackType | None = None,
no_add_request_id: bool = False,
force: bool = False,
) -> None:
"""Send a message to the Chromecast."""
# namespace is a string containing namespace
# data is a dict that will be converted to json
# wait_for_response only works if we have a request id
# If channel is not open yet, connect to it.
self._ensure_channel_connected(destination_id)
if not no_add_request_id:
request_id = self._gen_request_id()
data[REQUEST_ID] = request_id
if inc_session_id:
data[SESSION_ID] = self.session_id
msg = CastMessage()
msg.protocol_version = msg.CASTV2_1_0
msg.source_id = self.source_id
msg.destination_id = destination_id
msg.payload_type = CastMessage.STRING
msg.namespace = namespace
msg.payload_utf8 = json.dumps(data, ensure_ascii=False)
# prepend message with Big-Endian 4 byte payload size
be_size = pack(">I", msg.ByteSize())
# Log all messages except heartbeat
if msg.namespace != NS_HEARTBEAT:
self.logger.debug(
"[%s(%s):%s] Sending: %s",
self.fn or "",
self.host,
self.port,
_message_to_string(msg, data),
)
if not force and self.stop.is_set():
if callback_function:
callback_function(False, None)
raise PyChromecastStopped("Socket client's thread is stopped.")
if not self.connecting and not self._force_recon:
# We have a socket
assert self.socket is not None
try:
if callback_function:
if not no_add_request_id:
self._request_callbacks[request_id] = callback_function
else:
callback_function(True, None)
self.socket.sendall(be_size + msg.SerializeToString())
except socket.error:
if callback_function:
callback_function(False, None)
if not no_add_request_id:
self._request_callbacks.pop(request_id, None)
self._force_recon = True
self.logger.info(
"[%s(%s):%s] Error writing to socket.",
self.fn or "",
self.host,
self.port,
)
else:
if callback_function:
callback_function(False, None)
raise NotConnected(f"Chromecast {self.host}:{self.port} is connecting...")
def send_platform_message(
self,
namespace: str,
message: dict,
*,
inc_session_id: bool = False,
callback_function: CallbackType | None = None,
no_add_request_id: bool = False,
) -> None:
"""Helper method to send a message to the platform."""
return self.send_message(
PLATFORM_DESTINATION_ID,
namespace,
message,
inc_session_id=inc_session_id,
callback_function=callback_function,
no_add_request_id=no_add_request_id,
)
def send_app_message(
self,
namespace: str,
message: dict,
*,
inc_session_id: bool = False,
callback_function: CallbackType | None = None,
no_add_request_id: bool = False,
) -> None:
"""Helper method to send a message to current running app."""
if namespace not in self.app_namespaces:
if callback_function:
callback_function(False, None)
raise UnsupportedNamespace(
f"Namespace {namespace} is not supported by current app. "
f"Supported are {', '.join(self.app_namespaces)}"
)
if self.destination_id is None:
if callback_function:
callback_function(False, None)
raise NotConnected(
"Attempting send a message when destination_id is not set"
)
return self.send_message(
self.destination_id,
namespace,
message,
inc_session_id=inc_session_id,
callback_function=callback_function,
no_add_request_id=no_add_request_id,
)
def register_connection_listener(self, listener: ConnectionStatusListener) -> None:
"""Register a connection listener for when the socket connection
changes. Listeners will be called with
listener.new_connection_status(status)"""
self._connection_listeners.append(listener)
def _ensure_channel_connected(self, destination_id: str) -> None:
"""Ensure we opened a channel to destination_id."""
if destination_id not in self._open_channels:
self._open_channels.append(destination_id)
self.send_message(
destination_id,
NS_CONNECTION,
{
MESSAGE_TYPE: TYPE_CONNECT,
"origin": {},
"userAgent": "PyChromecast",
"senderInfo": {
"sdkType": 2,
"version": "15.605.1.3",
"browserVersion": "44.0.2403.30",
"platform": 4,
"systemVersion": "Macintosh; Intel Mac OS X10_10_3",
"connectionType": 1,
},
},
no_add_request_id=True,