mirror of
https://github.com/pkkid/python-plexapi
synced 2024-12-11 20:52:28 +00:00
66 lines
2.7 KiB
Python
66 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
import json
|
|
import threading
|
|
from plexapi import log
|
|
from plexapi.exceptions import Unsupported
|
|
|
|
|
|
class AlertListener(threading.Thread):
|
|
""" Creates a websocket connection to the PlexServer to optionally recieve alert notifications.
|
|
These often include messages from Plex about media scans as well as updates to currently running
|
|
Transcode Sessions. This class implements threading.Thread, therfore to start monitoring
|
|
alerts you must call .start() on the object once it's created. When calling
|
|
`PlexServer.startAlertListener()`, the thread will be started for you.
|
|
|
|
In order to use this feature, you must have websocket-client installed in your Python path.
|
|
This can be installed vis pip `pip install websocket-client`.
|
|
|
|
Parameters:
|
|
server (:class:`~plexapi.server.PlexServer`): PlexServer this listener is connected to.
|
|
callback (func): Callback function to call on recieved messages. The callback function
|
|
will be sent a single argument 'data' which will contain a dictionary of data
|
|
recieved from the server. :samp:`def my_callback(data): ...`
|
|
"""
|
|
key = '/:/websockets/notifications'
|
|
|
|
def __init__(self, server, callback=None):
|
|
self._server = server
|
|
self._callback = callback
|
|
self._ws = None
|
|
super(AlertListener, self).__init__()
|
|
|
|
def run(self):
|
|
# try importing websocket-client package
|
|
try:
|
|
import websocket
|
|
except:
|
|
raise Unsupported('Websocket-client package is required to use this feature.')
|
|
# create the websocket connection
|
|
url = self._server.url(self.key).replace('http', 'ws')
|
|
log.info('Starting AlertListener: %s', url)
|
|
self._ws = websocket.WebSocketApp(url,
|
|
on_message=self._onMessage,
|
|
on_error=self._onError)
|
|
self._ws.run_forever()
|
|
|
|
def stop(self):
|
|
""" Stop the AlertListener thread. Once the notifier is stopped, it cannot be diractly
|
|
started again. You must call :func:`plexapi.server.PlexServer.startAlertListener()`
|
|
from a PlexServer instance.
|
|
"""
|
|
log.info('Stopping AlertListener.')
|
|
self._ws.close()
|
|
|
|
def _onMessage(self, ws, message):
|
|
""" Called when websocket message is recieved. """
|
|
try:
|
|
data = json.loads(message)['NotificationContainer']
|
|
log.debug('Alert: %s', data)
|
|
if self._callback:
|
|
self._callback(data)
|
|
except Exception as err:
|
|
log.error('AlertListener Msg Error: %s', err)
|
|
|
|
def _onError(self, ws, err):
|
|
""" Called when websocket error is recieved. """
|
|
log.error('AlertListener Error: %s' % err)
|