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
|
"""Support for issuing callbacks for Plex client updates via websockets."""
import asyncio
from datetime import datetime
import logging
import aiohttp
_LOGGER = logging.getLogger(__name__)
SIGNAL_CONNECTION_STATE = "plexwebsocket_state"
ERROR_AUTH_FAILURE = "Authorization failure"
ERROR_TOO_MANY_RETRIES = "Too many retries"
ERROR_UNKNOWN = "Unknown"
MAX_FAILED_ATTEMPTS = 5
STATE_CONNECTED = "connected"
STATE_DISCONNECTED = "disconnected"
STATE_STARTING = "starting"
STATE_STOPPED = "stopped"
class WebsocketPlayer: # pylint: disable=too-few-public-methods
"""Represent an individual player state in the Plex websocket stream."""
def __init__(self, session_id, state, media_key, position):
"""Initialize a WebsocketPlayer instance."""
self.session_id = session_id
self.state = state
self.media_key = media_key
self.position = position
self.timestamp = datetime.now()
def significant_position_change(self, timestamp, new_position):
"""Determine if position change indicates a seek."""
timediff = (timestamp - self.timestamp).total_seconds()
posdiff = (new_position - self.position) / 1000
diffdiff = timediff - posdiff
if abs(diffdiff) > 5:
return True
return False
class PlexWebsocket:
"""Represent a websocket connection to a Plex server."""
# pylint: disable=too-many-instance-attributes
def __init__(
self,
plex_server,
callback,
subscriptions=["playing"],
session=None,
verify_ssl=True,
):
"""Initialize a PlexWebsocket instance.
Parameters:
plex_server (plexapi.server.PlexServer):
A connected PlexServer instance.
callback (Runnable):
Called when interesting events occur. Provides arguments:
msgtype (str): Message type or SIGNAL_* constant
data (str): Current STATE_* or websocket payload contents
error (str): Error message if any or None
subscriptions (list<str>):
A list of event types to receive updates. See KNOWN_TYPES.
verify_ssl:
Set to False to disable SSL certificate validation.
session (aiohttp.ClientSession, optional):
Provide an optional session object.
"""
self.session = session or aiohttp.ClientSession()
self.uri = self._get_uri(plex_server)
self.players = {}
self.callback = callback
self.subscriptions = subscriptions
self._ssl = False if verify_ssl is False else None
self._state = None
self.failed_attempts = 0
self._error_reason = None
@property
def state(self):
"""Return the current state."""
return self._state
@state.setter
def state(self, value):
"""Set the state."""
self._state = value
_LOGGER.debug("Websocket %s", value)
self.callback(SIGNAL_CONNECTION_STATE, value, self._error_reason)
self._error_reason = None
@staticmethod
def _get_uri(plex_server):
"""Generate the websocket URI using the `plexapi` library."""
return plex_server.url(
"/:/websockets/notifications", includeToken=True
).replace("http", "ws")
async def running(self):
"""Open a persistent websocket connection and act on events."""
self.state = STATE_STARTING
try:
async with self.session.ws_connect(
self.uri, heartbeat=15, ssl=self._ssl
) as ws_client:
self.state = STATE_CONNECTED
self.failed_attempts = 0
async for message in ws_client:
if self.state == STATE_STOPPED:
break
if message.type == aiohttp.WSMsgType.TEXT:
msg = message.json()["NotificationContainer"]
msgtype = msg["type"]
if msgtype not in self.subscriptions:
_LOGGER.debug("Ignoring: %s", msg)
continue
if msgtype == "playing":
if self.player_event(msg):
self.callback(msgtype, msg, None)
else:
_LOGGER.debug("Ignoring player update: %s", msg)
else:
self.callback(msgtype, msg, None)
elif message.type == aiohttp.WSMsgType.CLOSED:
_LOGGER.warning("AIOHTTP websocket connection closed")
break
elif message.type == aiohttp.WSMsgType.ERROR:
_LOGGER.error("AIOHTTP websocket error")
break
except aiohttp.ClientResponseError as error:
if error.code == 401:
_LOGGER.error("Credentials rejected: %s", error)
self._error_reason = ERROR_AUTH_FAILURE
else:
_LOGGER.error("Unexpected response received: %s", error)
self._error_reason = ERROR_UNKNOWN
self.state = STATE_STOPPED
except (aiohttp.ClientConnectionError, asyncio.TimeoutError) as error:
if self.failed_attempts >= MAX_FAILED_ATTEMPTS:
self._error_reason = ERROR_TOO_MANY_RETRIES
self.state = STATE_STOPPED
elif self.state != STATE_STOPPED:
retry_delay = min(2 ** (self.failed_attempts - 1) * 30, 300)
self.failed_attempts += 1
_LOGGER.error(
"Websocket connection failed, retrying in %ds: %s",
retry_delay,
error,
)
self.state = STATE_DISCONNECTED
await asyncio.sleep(retry_delay)
except Exception as error: # pylint: disable=broad-except
if self.state != STATE_STOPPED:
_LOGGER.exception("Unexpected exception occurred: %s", error)
self._error_reason = ERROR_UNKNOWN
self.state = STATE_STOPPED
else:
if self.state != STATE_STOPPED:
self.state = STATE_DISCONNECTED
# Session IDs reset if Plex server has restarted, be safe
self.players.clear()
await asyncio.sleep(5)
def player_event(self, msg):
"""Determine if messages relate to an interesting player event."""
should_fire = False
payload = msg["PlaySessionStateNotification"][0]
_LOGGER.debug("Payload received: %s", payload)
if (session_id := payload.get("sessionKey")) is None:
return False
state = payload["state"]
media_key = payload["key"]
position = payload["viewOffset"]
if session_id not in self.players:
self.players[session_id] = WebsocketPlayer(
session_id, state, media_key, position
)
_LOGGER.debug("New session: %s", payload)
return True
if state == "stopped":
# Sessions "end" when stopped
self.players.pop(session_id)
_LOGGER.debug("Session ended: %s", payload)
return True
player = self.players[session_id]
now = datetime.now()
# Ignore buffering states as transient
if state != "buffering":
if player.media_key != media_key or player.state != state:
# State or playback item changed
_LOGGER.debug("State/media changed: %s", payload)
should_fire = True
elif state == "playing" and player.significant_position_change(
now, position
):
# Client continues to play and a seek was detected
_LOGGER.debug("Seek detected: %s", payload)
should_fire = True
player.state = state
player.media_key = media_key
player.position = position
player.timestamp = now
return should_fire
async def listen(self):
"""Close the listening websocket."""
self.failed_attempts = 0
while self.state != STATE_STOPPED:
await self.running()
def close(self):
"""Close the listening websocket."""
self.state = STATE_STOPPED
|