From fd43cf5dd446ad11d36e498a4b4d5389d33d0783 Mon Sep 17 00:00:00 2001 From: Jonathan Wong Date: Thu, 19 Nov 2015 19:40:50 -0800 Subject: [PATCH] Add setting to enable remote access monitoring --- .../default/notification_triggers_modal.html | 2 +- data/interfaces/default/settings.html | 10 +++- plexpy/activity_pinger.py | 58 ++++++++++--------- plexpy/config.py | 5 +- plexpy/notification_handler.py | 4 +- plexpy/webserve.py | 3 +- 6 files changed, 46 insertions(+), 36 deletions(-) diff --git a/data/interfaces/default/notification_triggers_modal.html b/data/interfaces/default/notification_triggers_modal.html index 8b752907..82971ac2 100644 --- a/data/interfaces/default/notification_triggers_modal.html +++ b/data/interfaces/default/notification_triggers_modal.html @@ -67,7 +67,7 @@ from plexpy import helpers

Trigger notification when the Plex Media Server cannot be reached externally.

diff --git a/data/interfaces/default/settings.html b/data/interfaces/default/settings.html index 47cda611..2a4f45d1 100644 --- a/data/interfaces/default/settings.html +++ b/data/interfaces/default/settings.html @@ -403,6 +403,12 @@ available_notification_agents = sorted(notifiers.available_notification_agents()

Instead of polling the server at regular intervals let the server tell us when something happens. This is currently experimental. Encrypted websocket is not currently supported.

+
+ +

Enable to have PlexPy check if remote access to the Plex Media Server goes down. (Must have remote access set up in Plex.)

+

History Logging

@@ -659,7 +665,7 @@ available_notification_agents = sorted(notifiers.available_notification_agents()
  • -
     Plex External Port Down
    +
     Plex Remote Access Down
    • @@ -1305,7 +1311,7 @@ $(document).ready(function() { 'X-Plex-Version': '${common.VERSION_NUMBER}', 'X-Plex-Platform': '${common.PLATFORM}', 'X-Plex-Platform-Version': '${common.PLATFORM_VERSION}', - 'X-Plex-Client-Identifier': '${config['pms_uuid']}', + 'X-Plex-Client-Identifier': '${config["pms_uuid"]}', 'Authorization': 'Basic ' + btoa($("#pms_username").val() + ':' + $("#pms_password").val()) }, error: function(jqXHR, textStatus, errorThrown) { diff --git a/plexpy/activity_pinger.py b/plexpy/activity_pinger.py index 9f4b6a0e..d2340d4a 100644 --- a/plexpy/activity_pinger.py +++ b/plexpy/activity_pinger.py @@ -225,32 +225,9 @@ def check_recently_added(): def check_server_response(): with monitor_lock: - plex_tv = plextv.PlexTV() - external_response = plex_tv.get_server_response() pms_connect = pmsconnect.PmsConnect() internal_response = pms_connect.get_server_response() - - global ext_ping_count global int_ping_count - - if not external_response: - ext_ping_count += 1 - logger.warn(u"PlexPy Monitor :: Plex remote access port mapping failed, ping attempt %s." \ - % str(ext_ping_count)) - else: - host = external_response[0]['host'] - port = external_response[0]['port'] - - try: - http_response = urllib2.urlopen('http://' + host + ':' + port) - except urllib2.HTTPError, e: - ext_ping_count = 0 - except urllib2.URLError, e: - ext_ping_count += 1 - logger.warn(u"PlexPy Monitor :: Unable to get an external response from the server, ping attempt %s." \ - % str(ext_ping_count)) - else: - ext_ping_count = 0 if not internal_response: int_ping_count += 1 @@ -259,11 +236,36 @@ def check_server_response(): else: int_ping_count = 0 - if ext_ping_count == 3: - # Fire off notifications - threading.Thread(target=notification_handler.notify_timeline, - kwargs=dict(notify_action='extdown')).start() + if plexpy.CONFIG.MONITOR_REMOTE_ACCESS: + plex_tv = plextv.PlexTV() + external_response = plex_tv.get_server_response() + global ext_ping_count + + if not external_response: + ext_ping_count += 1 + logger.warn(u"PlexPy Monitor :: Plex remote access port mapping failed, ping attempt %s." \ + % str(ext_ping_count)) + else: + host = external_response[0]['host'] + port = external_response[0]['port'] + + try: + http_response = urllib2.urlopen('http://' + host + ':' + port) + except urllib2.HTTPError, e: + ext_ping_count = 0 + except urllib2.URLError, e: + ext_ping_count += 1 + logger.warn(u"PlexPy Monitor :: Unable to get an external response from the server, ping attempt %s." \ + % str(ext_ping_count)) + else: + ext_ping_count = 0 + if int_ping_count == 3: # Fire off notifications threading.Thread(target=notification_handler.notify_timeline, - kwargs=dict(notify_action='intdown')).start() \ No newline at end of file + kwargs=dict(notify_action='intdown')).start() + + if ext_ping_count == 3: + # Fire off notifications + threading.Thread(target=notification_handler.notify_timeline, + kwargs=dict(notify_action='extdown')).start() \ No newline at end of file diff --git a/plexpy/config.py b/plexpy/config.py index ae233fe1..c0f4b104 100644 --- a/plexpy/config.py +++ b/plexpy/config.py @@ -134,6 +134,7 @@ _CONFIG_DEFINITIONS = { 'MUSIC_NOTIFY_ON_STOP': (int, 'Monitoring', 0), 'MUSIC_NOTIFY_ON_PAUSE': (int, 'Monitoring', 0), 'MUSIC_LOGGING_ENABLE': (int, 'Monitoring', 0), + 'MONITOR_REMOTE_ACCESS': (int, 'Monitoring', 0), 'MONITORING_INTERVAL': (int, 'Monitoring', 60), 'MONITORING_USE_WEBSOCKET': (int, 'Monitoring', 0), 'NMA_APIKEY': (str, 'NMA', ''), @@ -167,9 +168,9 @@ _CONFIG_DEFINITIONS = { 'NOTIFY_ON_CREATED_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'), 'NOTIFY_ON_CREATED_BODY_TEXT': (str, 'Monitoring', '{title} was recently added to Plex.'), 'NOTIFY_ON_EXTDOWN_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'), - 'NOTIFY_ON_EXTDOWN_BODY_TEXT': (str, 'Monitoring', 'The Plex external port is down.'), + 'NOTIFY_ON_EXTDOWN_BODY_TEXT': (str, 'Monitoring', 'The Plex Media Server remote access is down.'), 'NOTIFY_ON_INTDOWN_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'), - 'NOTIFY_ON_INTDOWN_BODY_TEXT': (str, 'Monitoring', 'The Plex server is down.'), + 'NOTIFY_ON_INTDOWN_BODY_TEXT': (str, 'Monitoring', 'The Plex Media Server is down.'), 'OSX_NOTIFY_APP': (str, 'OSX_Notify', '/Applications/PlexPy'), 'OSX_NOTIFY_ENABLED': (int, 'OSX_Notify', 0), 'OSX_NOTIFY_ON_PLAY': (int, 'OSX_Notify', 0), diff --git a/plexpy/notification_handler.py b/plexpy/notification_handler.py index 4a9f7b7e..9d943697 100644 --- a/plexpy/notification_handler.py +++ b/plexpy/notification_handler.py @@ -638,7 +638,7 @@ def build_server_notify_text(state=None): if state == 'extdown': # Default body text - body_text = 'The Plex external port is down.' + body_text = 'The Plex Media Server remote access is down.' if on_extdown_subject and on_extdown_body: try: @@ -660,7 +660,7 @@ def build_server_notify_text(state=None): return [subject_text, body_text] elif state == 'intdown': # Default body text - body_text = 'The Plex server is down.' + body_text = 'The Plex Media Server is down.' if on_intdown_subject and on_intdown_body: try: diff --git a/plexpy/webserve.py b/plexpy/webserve.py index 12a79f42..24233bc1 100644 --- a/plexpy/webserve.py +++ b/plexpy/webserve.py @@ -435,6 +435,7 @@ class WebInterface(object): "tv_notify_on_pause": checked(plexpy.CONFIG.TV_NOTIFY_ON_PAUSE), "movie_notify_on_pause": checked(plexpy.CONFIG.MOVIE_NOTIFY_ON_PAUSE), "music_notify_on_pause": checked(plexpy.CONFIG.MUSIC_NOTIFY_ON_PAUSE), + "monitor_remote_access": checked(plexpy.CONFIG.MONITOR_REMOTE_ACCESS), "monitoring_interval": plexpy.CONFIG.MONITORING_INTERVAL, "monitoring_use_websocket": checked(plexpy.CONFIG.MONITORING_USE_WEBSOCKET), "refresh_users_interval": plexpy.CONFIG.REFRESH_USERS_INTERVAL, @@ -490,7 +491,7 @@ class WebInterface(object): "tv_notify_on_stop", "movie_notify_on_stop", "music_notify_on_stop", "tv_notify_on_pause", "movie_notify_on_pause", "music_notify_on_pause", "refresh_users_on_startup", "ip_logging_enable", "video_logging_enable", "music_logging_enable", "pms_is_remote", "home_stats_type", - "group_history_tables", "notify_consecutive", "notify_recently_added_grandparent" + "group_history_tables", "notify_consecutive", "notify_recently_added_grandparent", "monitor_remote_access" ] for checked_config in checked_configs: if checked_config not in kwargs: