# This file is part of PlexPy. # # PlexPy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # PlexPy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with PlexPy. If not, see . import base64 import bleach import json import cherrypy from email.mime.multipart import MIMEMultipart from email.mime.text import MIMEText import email.utils from httplib import HTTPSConnection import os import requests import shlex import smtplib import subprocess import threading import time import urllib from urllib import urlencode import urllib2 from urlparse import urlparse import uuid import gntp.notifier import facebook import twitter import pynma import plexpy import database import helpers import logger import request from plexpy.config import _BLACKLIST_KEYS, _WHITELIST_KEYS from plexpy.helpers import checked AGENT_IDS = {'growl': 0, 'prowl': 1, 'xbmc': 2, 'plex': 3, 'nma': 4, 'pushalot': 5, 'pushbullet': 6, 'pushover': 7, 'osx': 8, 'boxcar': 9, 'email': 10, 'twitter': 11, 'ifttt': 12, 'telegram': 13, 'slack': 14, 'scripts': 15, 'facebook': 16, 'browser': 17, 'join': 18, 'hipchat': 19, 'discord': 20 } def available_notification_agents(): agents = [{'label': 'Boxcar', 'name': 'boxcar', 'id': AGENT_IDS['boxcar'] }, {'label': 'Browser', 'name': 'browser', 'id': AGENT_IDS['browser'] }, {'label': 'Discord', 'name': 'discord', 'id': AGENT_IDS['discord'], }, {'label': 'Email', 'name': 'email', 'id': AGENT_IDS['email'] }, {'label': 'Facebook', 'name': 'facebook', 'id': AGENT_IDS['facebook'] }, {'label': 'Growl', 'name': 'growl', 'id': AGENT_IDS['growl'] }, {'label': 'Hipchat', 'name': 'hipchat', 'id': AGENT_IDS['hipchat'] }, {'label': 'IFTTT', 'name': 'ifttt', 'id': AGENT_IDS['ifttt'] }, {'label': 'Join', 'name': 'join', 'id': AGENT_IDS['join'] }, {'label': 'Notify My Android', 'name': 'nma', 'id': AGENT_IDS['nma'] }, {'label': 'Plex Home Theater', 'name': 'plex', 'id': AGENT_IDS['plex'] }, {'label': 'Prowl', 'name': 'prowl', 'id': AGENT_IDS['prowl'] }, {'label': 'Pushalot', 'name': 'pushalot', 'id': AGENT_IDS['pushalot'] }, {'label': 'Pushbullet', 'name': 'pushbullet', 'id': AGENT_IDS['pushbullet'] }, {'label': 'Pushover', 'name': 'pushover', 'id': AGENT_IDS['pushover'] }, {'label': 'Script', 'name': 'scripts', 'id': AGENT_IDS['scripts'] }, {'label': 'Slack', 'name': 'slack', 'id': AGENT_IDS['slack'] }, {'label': 'Telegram', 'name': 'telegram', 'id': AGENT_IDS['telegram'] }, {'label': 'Twitter', 'name': 'twitter', 'id': AGENT_IDS['twitter'] }, {'label': 'XBMC', 'name': 'xbmc', 'id': AGENT_IDS['xbmc'] } ] # OSX Notifications should only be visible if it can be used if OSX().validate(): agents.append({'label': 'OSX Notify', 'name': 'osx', 'id': AGENT_IDS['OSX Notify'] }) return agents def available_notification_actions(): actions = [{'label': 'Playback Start', 'name': 'on_play', 'description': 'Trigger a notification when a stream is started.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) started playing {title}.', 'icon': 'fa-play', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Playback Stop', 'name': 'on_stop', 'description': 'Trigger a notification when a stream is stopped.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) has stopped {title}.', 'icon': 'fa-stop', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Playback Pause', 'name': 'on_pause', 'description': 'Trigger a notification when a stream is paused.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) has paused {title}.', 'icon': 'fa-pause', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Playback Resume', 'name': 'on_resume', 'description': 'Trigger a notification when a stream is resumed.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) has resumed {title}.', 'icon': 'fa-play', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Watched', 'name': 'on_watched', 'description': 'Trigger a notification when a video stream reaches the specified watch percentage.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) has watched {title}.', 'icon': 'fa-eye', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Buffer Warning', 'name': 'on_buffer', 'description': 'Trigger a notification when a stream exceeds the specified buffer threshold.', 'subject': 'PlexPy ({server_name})', 'body': '{user} ({player}) is buffering {title}.', 'icon': 'fa-spinner', 'media_types': ('movie', 'episode', 'track') }, {'label': 'User Concurrent Streams', 'name': 'on_concurrent', 'description': 'Trigger a notification when a user exceeds the concurrent stream threshold.', 'subject': 'PlexPy ({server_name})', 'body': '{user} has {user_streams} concurrent streams.', 'icon': 'fa-arrow-circle-o-right', 'media_types': ('movie', 'episode', 'track') }, {'label': 'User New Device', 'name': 'on_newdevice', 'description': 'Trigger a notification when a user streams from a new device.', 'subject': 'PlexPy ({server_name})', 'body': '{user} is streaming from a new device: {player}.', 'icon': 'fa-desktop', 'media_types': ('movie', 'episode', 'track') }, {'label': 'Recently Added', 'name': 'on_created', 'description': 'Trigger a notification when a media item is added to the Plex Media Server.', 'subject': 'PlexPy ({server_name})', 'body': '{title} was recently added to Plex.', 'icon': 'fa-download', 'media_types': ('movie', 'show', 'season', 'episode', 'artist', 'album', 'track') }, {'label': 'Plex Server Down', 'name': 'on_intdown', 'description': 'Trigger a notification when the Plex Media Server cannot be reached internally.', 'subject': 'PlexPy ({server_name})', 'body': 'The Plex Media Server is down.', 'icon': 'fa-server', 'media_types': ('server',) }, {'label': 'Plex Server Back Up', 'name': 'on_intup', 'description': 'Trigger a notification when the Plex Media Server can be reached internally after being down.', 'subject': 'PlexPy ({server_name})', 'body': 'The Plex Media Server is back up.', 'icon': 'fa-server', 'media_types': ('server',) }, {'label': 'Plex Remote Access Down', 'name': 'on_extdown', 'description': 'Trigger a notification when the Plex Media Server cannot be reached externally.', 'subject': 'PlexPy ({server_name})', 'body': 'The Plex Media Server remote access is down.', 'icon': 'fa-server', 'media_types': ('server',) }, {'label': 'Plex Remote Access Back Up', 'name': 'on_extup', 'description': 'Trigger a notification when the Plex Media Server can be reached externally after being down.', 'subject': 'PlexPy ({server_name})', 'body': 'The Plex Media Server remote access is back up.', 'icon': 'fa-server', 'media_types': ('server',) }, {'label': 'Plex Update Available', 'name': 'on_pmsupdate', 'description': 'Trigger a notification when an update for the Plex Media Server is available.', 'subject': 'PlexPy ({server_name})', 'body': 'An update is available for the Plex Media Server (version {update_version}).', 'icon': 'fa-refresh', 'media_types': ('server',) }, {'label': 'PlexPy Update Available', 'name': 'on_plexpyupdate', 'description': 'Trigger a notification when an update for the PlexPy is available.', 'subject': 'PlexPy ({server_name})', 'body': 'An update is available for PlexPy (version {plexpy_update_version}).', 'icon': 'fa-refresh', 'media_types': ('server',) } ] return actions def get_agent_class(agent_id=None, config=None): if str(agent_id).isdigit(): agent_id = int(agent_id) if agent_id == 0: return GROWL(config=config) elif agent_id == 1: return PROWL(config=config) elif agent_id == 2: return XBMC(config=config) elif agent_id == 3: return PLEX(config=config) elif agent_id == 4: return NMA(config=config) elif agent_id == 5: return PUSHALOT(config=config) elif agent_id == 6: return PUSHBULLET(config=config) elif agent_id == 7: return PUSHOVER(config=config) elif agent_id == 8: return OSX(config=config) elif agent_id == 9: return BOXCAR(config=config) elif agent_id == 10: return EMAIL(config=config) elif agent_id == 11: return TWITTER(config=config) elif agent_id == 12: return IFTTT(config=config) elif agent_id == 13: return TELEGRAM(config=config) elif agent_id == 14: return SLACK(config=config) elif agent_id == 15: return SCRIPTS(config=config) elif agent_id == 16: return FACEBOOK(config=config) elif agent_id == 17: return BROWSER(config=config) elif agent_id == 18: return JOIN(config=config) elif agent_id == 19: return HIPCHAT(config=config) elif agent_id == 20: return DISCORD(config=config) else: return Notifier(config=config) else: return None def get_notify_agents(): return tuple(a['name'] for a in sorted(available_notification_agents(), key=lambda k: k['label'])) def get_notify_actions(): return tuple(a['name'] for a in available_notification_actions()) def get_notifiers(notifier_id=None, notify_action=None): notify_actions = get_notify_actions() where = where_id = where_action = '' if notifier_id or notify_action: where = 'WHERE ' if notifier_id: where_id += 'notifier_id = %s' % notifier_id if notify_action and notify_action in notify_actions: where_action = '%s = 1' % notify_action where += ' AND '.join([w for w in [where_id, where_action] if w]) monitor_db = database.MonitorDatabase() result = monitor_db.select('SELECT id, agent_id, agent_name, agent_label, friendly_name, %s FROM notifiers %s' % (', '.join(notify_actions), where)) for item in result: item['active'] = int(any([item.pop(k) for k in item.keys() if k in notify_actions])) return result def delete_notifier(notifier_id=None): monitor_db = database.MonitorDatabase() if str(notifier_id).isdigit(): logger.debug(u"PlexPy Notifiers :: Deleting notifier_id %s from the database." % notifier_id) result = monitor_db.action('DELETE FROM notifiers WHERE id = ?', [notifier_id]) return True else: return False def get_notifier_config(notifier_id=None): if str(notifier_id).isdigit(): notifier_id = int(notifier_id) else: logger.error(u"PlexPy Notifiers :: Unable to retrieve notifier config: invalid notifier_id %s." % notifier_id) return None monitor_db = database.MonitorDatabase() result = monitor_db.select_single('SELECT * FROM notifiers WHERE id = ?', args=[notifier_id]) if not result: return None config = json.loads(result.pop('notifier_config') or '{}') notifier_agent = get_agent_class(agent_id=result['agent_id'], config=config) notifier_config = notifier_agent.return_config_options() notify_actions = get_notify_actions() notifier_actions = {} notifier_text = {} for k in result.keys(): if k in notify_actions: notifier_actions[k] = helpers.cast_to_int(result.pop(k)) notifier_text[k] = {'subject': result.pop(k + '_subject'), 'body': result.pop(k + '_body')} result['config'] = config result['config_options'] = notifier_config result['actions'] = notifier_actions result['notify_text'] = notifier_text return result def add_notifier_config(agent_id=None, **kwargs): if str(agent_id).isdigit(): agent_id = int(agent_id) else: logger.error(u"PlexPy Notifiers :: Unable to add new notifier: invalid agent_id %s." % agent_id) return False agent = next((a for a in available_notification_agents() if a['id'] == agent_id), None) if not agent: logger.error(u"PlexPy Notifiers :: Unable to retrieve new notification agent: invalid agent_id %s." % agent_id) return False keys = {'id': None} values = {'agent_id': agent['id'], 'agent_name': agent['name'], 'agent_label': agent['label'], 'friendly_name': '', 'notifier_config': json.dumps(get_agent_class(agent_id=agent['id']).config) } if agent['name'] == 'scripts': for a in available_notification_actions(): values[a['name'] + '_subject'] = '' values[a['name'] + '_body'] = '' else: for a in available_notification_actions(): values[a['name'] + '_subject'] = a['subject'] values[a['name'] + '_body'] = a['body'] monitor_db = database.MonitorDatabase() try: monitor_db.upsert(table_name='notifiers', key_dict=keys, value_dict=values) notifier_id = monitor_db.last_insert_id() logger.info(u"PlexPy Notifiers :: Added new notification agent: %s (notifier_id %s)." % (agent['label'], notifier_id)) return notifier_id except Exception as e: logger.warn(u"PlexPy Notifiers :: Unable to add notification agent: %s." % e) return False def set_notifier_config(notifier_id=None, agent_id=None, **kwargs): if str(agent_id).isdigit(): agent_id = int(agent_id) else: logger.error(u"PlexPy Notifiers :: Unable to set exisiting notifier: invalid agent_id %s." % agent_id) return False agent = next((a for a in available_notification_agents() if a['id'] == agent_id), None) if not agent: logger.error(u"PlexPy Notifiers :: Unable to retrieve existing notification agent: invalid agent_id %s." % agent_id) return False notify_actions = get_notify_actions() config_prefix = agent['name'] + '_' actions = {k: helpers.cast_to_int(kwargs.pop(k)) for k in kwargs.keys() if k in notify_actions} subject_text = {k: kwargs.pop(k) for k in kwargs.keys() if k.startswith(notify_actions) and k.endswith('_subject')} body_text = {k: kwargs.pop(k) for k in kwargs.keys() if k.startswith(notify_actions) and k.endswith('_body')} notifier_config = {k[len(config_prefix):]: kwargs.pop(k) for k in kwargs.keys() if k.startswith(config_prefix)} notifier_config = get_agent_class(agent['id']).set_config(config=notifier_config) keys = {'id': notifier_id} values = {'agent_id': agent['id'], 'agent_name': agent['name'], 'agent_label': agent['label'], 'friendly_name': kwargs.get('friendly_name', ''), 'notifier_config': json.dumps(notifier_config), } values.update(actions) values.update(subject_text) values.update(body_text) monitor_db = database.MonitorDatabase() try: monitor_db.upsert(table_name='notifiers', key_dict=keys, value_dict=values) logger.info(u"PlexPy Notifiers :: Updated notification agent: %s (notifier_id %s)." % (agent['label'], notifier_id)) return True except Exception as e: logger.warn(u"PlexPy Notifiers :: Unable to update notification agent: %s." % e) return False def send_notification(notifier_id=None, subject='', body='', notify_action='', **kwargs): notifier_config = get_notifier_config(notifier_id=notifier_id) if notifier_config: agent = get_agent_class(agent_id=notifier_config['agent_id'], config=notifier_config['config']) return agent.notify(subject=subject, body=body, action=notify_action.split('on_')[-1], **kwargs) else: logger.debug(u"PlexPy Notifiers :: Notification requested but no notifier_id received.") def blacklist_logger(): monitor_db = database.MonitorDatabase() notifiers = monitor_db.select('SELECT notifier_config FROM notifiers') blacklist = [] blacklist_keys = [w.lstrip('_') for w in _BLACKLIST_KEYS] for n in notifiers: config = json.loads(n['notifier_config'] or '{}') for key, value in config.iteritems(): if isinstance(value, basestring) and len(value.strip()) > 5 and \ key.upper() not in _WHITELIST_KEYS and any(bk in key.upper() for bk in blacklist_keys): blacklist.append(value.strip()) logger._BLACKLIST_WORDS.extend(blacklist) class PrettyMetadata(object): def __init__(self, parameters): self.parameters = parameters self.media_type = parameters['media_type'] def get_poster_url(self): self.poster_url = self.parameters['poster_url'] if not self.poster_url: if self.media_type in ('artist', 'album', 'track'): self.poster_url = 'https://raw.githubusercontent.com/%s/plexpy/master/data/interfaces/default/images/cover.png' % plexpy.CONFIG.GIT_USER else: self.poster_url = 'https://raw.githubusercontent.com/%s/plexpy/master/data/interfaces/default/images/poster.png' % plexpy.CONFIG.GIT_USER return self.poster_url def get_provider(self): self.provider = '' if self.parameters['thetvdb_url']: self.provider = 'TheTVDB' elif self.parameters['themoviedb_url']: self.provider = 'The Movie Database' elif self.parameters['imdb_url']: self.provider = 'IMDb' elif self.parameters['lastfm_url']: self.provider = 'Last.fm' return self.provider def get_provider_link(self): self.provider_link = '' if self.parameters['thetvdb_url']: self.provider_link = self.parameters['thetvdb_url'] elif self.parameters['themoviedb_url']: self.provider_link = self.parameters['themoviedb_url'] elif self.parameters['imdb_url']: self.provider_link = self.parameters['imdb_url'] elif self.parameters['lastfm_url']: self.provider_link = self.parameters['lastfm_url'] return self.provider_link def get_caption(self): self.caption = '' if self.parameters['thetvdb_url']: self.caption = 'View on TheTVDB' elif self.parameters['themoviedb_url']: self.caption = 'View on The Movie Database' elif self.parameters['imdb_url']: self.caption = 'View on IMDB' elif self.parameters['lastfm_url']: self.caption = 'View on Last.fm' return self.caption def get_title(self, divider = '-'): self.title = '' if self.media_type == 'movie': self.title = '%s (%s)' % (self.parameters['title'], self.parameters['year']) elif self.media_type == 'show': self.title = '%s (%s)' % (self.parameters['show_name'], self.parameters['year']) elif self.media_type == 'season': self.title = '%s - Season %s' % (self.parameters['show_name'], self.parameters['season_num']) elif self.media_type == 'episode': self.title = '%s - %s (S%s %s E%s)' % (self.parameters['show_name'], self.parameters['episode_name'], self.parameters['season_num'], divider, self.parameters['episode_num']) elif self.media_type == 'artist': self.title = self.parameters['artist_name'] elif self.media_type == 'album': self.title = '%s - %s' % (self.parameters['artist_name'], self.parameters['album_name']) elif self.media_type == 'track': self.title = '%s - %s' % (self.parameters['artist_name'], self.parameters['track_name']) return self.title.encode("utf-8") def get_subtitle(self): if self.media_type == 'track': self.subtitle = self.parameters['album_name'] else: self.subtitle = self.parameters['summary'] return self.subtitle.encode("utf-8") def get_plex_url(self): self.plex_url = self.parameters['plex_url'] return self.plex_url class Notifier(object): _DEFAULT_CONFIG = {} def __init__(self, config=None): self.set_config(config) def set_config(self, config=None): self.config = self._validate_config(config) return self.config def _validate_config(self, config=None): if config is None: return self._DEFAULT_CONFIG new_config = {} for k, v in self._DEFAULT_CONFIG.iteritems(): if isinstance(v, int): new_config[k] = helpers.cast_to_int(config.get(k, v)) else: new_config[k] = config.get(k, v) return new_config def notify(self, subject='', body='', action='', **kwargs): pass def return_config_options(self): config_options = [] return config_options class BOXCAR(Notifier): """ Boxcar notifications """ _DEFAULT_CONFIG = {'token': '', 'sound': '' } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return try: data = urllib.urlencode({ 'user_credentials': self.config['token'], 'notification[title]': subject.encode('utf-8'), 'notification[long_message]': body.encode('utf-8'), 'notification[sound]': self.config['sound'] }) req = urllib2.Request('https://new.boxcar.io/api/notifications') handle = urllib2.urlopen(req, data) handle.close() logger.info(u"PlexPy Notifiers :: Boxcar2 notification sent.") return True except urllib2.URLError as e: logger.warn(u"PlexPy Notifiers :: Boxcar2 notification failed: %s" % e) return False def get_sounds(self): sounds = {'': '', 'beep-crisp': 'Beep (Crisp)', 'beep-soft': 'Beep (Soft)', 'bell-modern': 'Bell (Modern)', 'bell-one-tone': 'Bell (One Tone)', 'bell-simple': 'Bell (Simple)', 'bell-triple': 'Bell (Triple)', 'bird-1': 'Bird (1)', 'bird-2': 'Bird (2)', 'boing': 'Boing', 'cash': 'Cash', 'clanging': 'Clanging', 'detonator-charge': 'Detonator Charge', 'digital-alarm': 'Digital Alarm', 'done': 'Done', 'echo': 'Echo', 'flourish': 'Flourish', 'harp': 'Harp', 'light': 'Light', 'magic-chime':'Magic Chime', 'magic-coin': 'Magic Coin', 'no-sound': 'No Sound', 'notifier-1': 'Notifier (1)', 'notifier-2': 'Notifier (2)', 'notifier-3': 'Notifier (3)', 'orchestral-long': 'Orchestral (Long)', 'orchestral-short': 'Orchestral (Short)', 'score': 'Score', 'success': 'Success', 'up': 'Up'} return sounds def return_config_options(self): config_option = [{'label': 'Boxcar Access Token', 'value': self.config['token'], 'name': 'boxcar_token', 'description': 'Your Boxcar access token.', 'input_type': 'text' }, {'label': 'Sound', 'value': self.config['sound'], 'name': 'boxcar_sound', 'description': 'Set the notification sound. Leave blank for the default sound.', 'input_type': 'select', 'select_options': self.get_sounds() } ] return config_option class BROWSER(Notifier): """ Browser notifications """ _DEFAULT_CONFIG = {'enabled': 0, 'auto_hide_delay': 5 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return logger.info(u"PlexPy Notifiers :: Browser notification sent.") return True def get_notifications(self): if not self.config['enabled']: return monitor_db = database.MonitorDatabase() result = monitor_db.select('SELECT subject_text, body_text FROM notify_log ' 'WHERE agent_id = 17 AND timestamp >= ? ', args=[time.time() - 3]) notifications = [] for item in result: notification = {'subject_text': item['subject_text'], 'body_text': item['body_text'], 'delay': self.config['auto_hide_delay']} notifications.append(notification) return {'notifications': notifications} def return_config_options(self): config_option = [{'label': 'Enable Browser Notifications', 'value': self.config['enabled'], 'name': 'browser_enabled', 'description': 'Enable to display desktop notifications from your browser.', 'input_type': 'checkbox' }, {'label': 'Allow Notifications', 'value': 'Allow Notifications', 'name': 'browser_allow_browser', 'description': 'Click to allow browser notifications. You must click this button for each browser.', 'input_type': 'button' }, {'label': 'Auto Hide Delay', 'value': self.config['auto_hide_delay'], 'name': 'browser_auto_hide_delay', 'description': 'Set the number of seconds for the notification to remain visible. \ Set 0 to disable auto hiding. (Note: Some browsers have a maximum time limit.)', 'input_type': 'number' } ] return config_option class DISCORD(Notifier): """ Discord Notifications """ _DEFAULT_CONFIG = {'hook': '', 'username': '', 'avatar_url': '', 'color': '', 'tts': 0, 'incl_pmslink': 0, 'incl_poster': 0, 'incl_subject': 1 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return if self.config['incl_subject']: text = subject.encode('utf-8') + '\r\n' + body.encode("utf-8") else: text = body.encode("utf-8") data = {'content': text} if self.config['username']: data['username'] = self.config['username'] if self.config['avatar_url']: data['avatar_url'] = self.config['avatar_url'] if self.config['tts']: data['tts'] = True if self.config['incl_poster'] and kwargs.get('parameters', {}).get('media_type'): # Grab formatted metadata pretty_metadata = PrettyMetadata(kwargs['parameters']) poster_url = pretty_metadata.get_poster_url() plex_url = pretty_metadata.get_plex_url() provider = pretty_metadata.get_provider() provider_link = pretty_metadata.get_provider_link() title = pretty_metadata.get_title('\xc2\xb7'.decode('utf8')) subtitle = pretty_metadata.get_subtitle() # Build Discord post attachment attachment = {'title': title, 'description': subtitle, 'thumbnail': {'url': poster_url} } if self.config['color'] and self.config['color'].startswith('#'): hex = self.config['color'].lstrip('#') attachment['color'] = helpers.hex_to_int(hex) fields = [] if provider_link: attachment['url'] = provider_link fields.append({'name': 'View Details', 'value': '[%s](%s)' % (provider, provider_link.encode('utf-8')), 'inline': True}) if self.config['incl_pmslink']: fields.append({'name': 'View Details', 'value': '[Plex Web](%s)' % plex_url.encode('utf-8'), 'inline': True}) if fields: attachment['fields'] = fields data['embeds'] = [attachment] host = urlparse(self.config['hook']).hostname path = urlparse(self.config['hook']).path query_params = {'wait': True} query_string = urllib.urlencode(query_params) http_handler = HTTPSConnection(host) http_handler.request("POST", path + '?' + query_string, headers={'Content-type': "application/json"}, body=json.dumps(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Discord notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Discord notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Discord notification failed.") return False def return_config_options(self): config_option = [{'label': 'Discord Webhook URL', 'value': self.config['hook'], 'name': 'discord_hook', 'description': 'Your Discord incoming webhook URL.', 'input_type': 'text' }, {'label': 'Discord Username', 'value': self.config['username'], 'name': 'discord_username', 'description': 'The Discord username which will be used. Leave blank for webhook integration default.', 'input_type': 'text' }, {'label': 'Discord Avatar', 'value': self.config['avatar_url'], 'description': 'The image url for the avatar which will be used. Leave blank for webhook integration default.', 'name': 'discord_avatar_url', 'input_type': 'text' }, {'label': 'Discord Color', 'value': self.config['color'], 'description': 'The hex color value (begins with \'#\') for the border along the left side of the message attachment.', 'name': 'discord_color', 'input_type': 'text' }, {'label': 'TTS', 'value': self.config['tts'], 'name': 'discord_tts', 'description': 'Send the notification using text-to-speech.', 'input_type': 'checkbox' }, {'label': 'Include Poster Image', 'value': self.config['incl_poster'], 'name': 'discord_incl_poster', 'description': 'Include a poster with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Link to Plex Web', 'value': self.config['incl_pmslink'], 'name': 'discord_incl_pmslink', 'description': 'Include a link to the media in Plex Web with the notifications.
' 'If disabled, the link will go to IMDB, TVDB, TMDb, or Last.fm instead, if available.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'discord_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' } ] return config_option class EMAIL(Notifier): """ Email notifications """ _DEFAULT_CONFIG = {'from_name': '', 'from': '', 'to': '', 'cc': '', 'bcc': '', 'smtp_server': '', 'smtp_port': 25, 'smtp_user': '', 'smtp_password': '', 'tls': 0, 'html_support': 1 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return if self.config['html_support']: body = body.replace('\n', '
') msg = MIMEMultipart('alternative') msg.attach(MIMEText(bleach.clean(body, strip=True), 'plain', 'utf-8')) msg.attach(MIMEText(body, 'html', 'utf-8')) else: msg = MIMEText(body, 'plain', 'utf-8') msg['Subject'] = subject msg['From'] = email.utils.formataddr((self.config['from_name'], self.config['from'])) msg['To'] = self.config['to'] msg['CC'] = self.config['cc'] recipients = [x.strip() for x in self.config['to'].split(';')] \ + [x.strip() for x in self.config['cc'].split(';')] \ + [x.strip() for x in self.config['bcc'].split(';')] recipients = filter(None, recipients) try: mailserver = smtplib.SMTP(self.config['smtp_server'], self.config['smtp_port']) if self.config['tls']: mailserver.starttls() mailserver.ehlo() if self.config['smtp_user']: mailserver.login(self.config['smtp_user'], self.config['smtp_password']) mailserver.sendmail(self.config['from'], recipients, msg.as_string()) mailserver.quit() logger.info(u"PlexPy Notifiers :: Email notification sent.") return True except Exception as e: logger.warn(u"PlexPy Notifiers :: Email notification failed: %s" % e) return False def return_config_options(self): config_option = [{'label': 'From Name', 'value': self.config['from_name'], 'name': 'email_from_name', 'description': 'The name of the sender.', 'input_type': 'text' }, {'label': 'From', 'value': self.config['from'], 'name': 'email_from', 'description': 'The email address of the sender.', 'input_type': 'text' }, {'label': 'To', 'value': self.config['to'], 'name': 'email_to', 'description': 'The email address(es) of the recipients, separated by semicolons (;).', 'input_type': 'text' }, {'label': 'CC', 'value': self.config['cc'], 'name': 'email_cc', 'description': 'The email address(es) to CC, separated by semicolons (;).', 'input_type': 'text' }, {'label': 'BCC', 'value': self.config['bcc'], 'name': 'email_bcc', 'description': 'The email address(es) to BCC, separated by semicolons (;).', 'input_type': 'text' }, {'label': 'SMTP Server', 'value': self.config['smtp_server'], 'name': 'email_smtp_server', 'description': 'Host for the SMTP server.', 'input_type': 'text' }, {'label': 'SMTP Port', 'value': self.config['smtp_port'], 'name': 'email_smtp_port', 'description': 'Port for the SMTP server.', 'input_type': 'number' }, {'label': 'SMTP User', 'value': self.config['smtp_user'], 'name': 'email_smtp_user', 'description': 'User for the SMTP server.', 'input_type': 'text' }, {'label': 'SMTP Password', 'value': self.config['smtp_password'], 'name': 'email_smtp_password', 'description': 'Password for the SMTP server.', 'input_type': 'password' }, {'label': 'TLS', 'value': self.config['tls'], 'name': 'email_tls', 'description': 'Does the server use encryption.', 'input_type': 'checkbox' }, {'label': 'Enable HTML Support', 'value': self.config['html_support'], 'name': 'email_html_support', 'description': 'Style your messages using HTML tags. ' 'Line breaks (<br>) will be inserted automatically.', 'input_type': 'checkbox' } ] return config_option class FACEBOOK(Notifier): """ Facebook notifications """ _DEFAULT_CONFIG = {'redirect_uri': '', 'access_token': '', 'app_id': '', 'app_secret': '', 'group_id': '', 'incl_pmslink': 0, 'incl_poster': 0, 'incl_subject': 1 } def _get_authorization(self, app_id='', app_secret='', redirect_uri=''): # Temporarily store settings in the config so we can retrieve them in Facebook step 2. # Assume the user won't be requesting authorization for multiple Facebook notifiers at the same time. plexpy.CONFIG.FACEBOOK_APP_ID = app_id plexpy.CONFIG.FACEBOOK_APP_SECRET = app_secret plexpy.CONFIG.FACEBOOK_REDIRECT_URI = redirect_uri plexpy.CONFIG.FACEBOOK_TOKEN = 'temp' return facebook.auth_url(app_id=app_id, canvas_url=redirect_uri + '/facebookStep2', perms=['user_managed_groups','publish_actions']) def _get_credentials(self, code=''): logger.info(u"PlexPy Notifiers :: Requesting access token from Facebook") app_id = plexpy.CONFIG.FACEBOOK_APP_ID app_secret = plexpy.CONFIG.FACEBOOK_APP_SECRET redirect_uri = plexpy.CONFIG.FACEBOOK_REDIRECT_URI try: # Request user access token api = facebook.GraphAPI(version='2.5') response = api.get_access_token_from_code(code=code, redirect_uri=redirect_uri + '/facebookStep2', app_id=app_id, app_secret=app_secret) access_token = response['access_token'] # Request extended user access token api = facebook.GraphAPI(access_token=access_token, version='2.5') response = api.extend_access_token(app_id=app_id, app_secret=app_secret) plexpy.CONFIG.FACEBOOK_TOKEN = response['access_token'] except Exception as e: logger.error(u"PlexPy Notifiers :: Error requesting Facebook access token: %s" % e) plexpy.CONFIG.FACEBOOK_TOKEN = '' # Clear out temporary config values plexpy.CONFIG.FACEBOOK_APP_ID = '' plexpy.CONFIG.FACEBOOK_APP_SECRET = '' plexpy.CONFIG.FACEBOOK_REDIRECT_URI = '' return plexpy.CONFIG.FACEBOOK_TOKEN def _post_facebook(self, message=None, attachment=None): if self.config['group_id']: api = facebook.GraphAPI(access_token=self.config['access_token'], version='2.5') try: api.put_wall_post(profile_id=self.config['group_id'], message=message, attachment=attachment) logger.info(u"PlexPy Notifiers :: Facebook notification sent.") return True except Exception as e: logger.warn(u"PlexPy Notifiers :: Error sending Facebook post: %s" % e) return False else: logger.warn(u"PlexPy Notifiers :: Error sending Facebook post: No Facebook Group ID provided.") return False def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return attachment = {} if self.config['incl_poster'] and kwargs.get('parameters', {}).get('media_type'): # Grab formatted metadata pretty_metadata = PrettyMetadata(kwargs['parameters']) poster_url = pretty_metadata.get_poster_url() plex_url = pretty_metadata.get_plex_url() provider_link = pretty_metadata.get_provider_link() caption = pretty_metadata.get_caption() title = pretty_metadata.get_title('\xc2\xb7'.decode('utf8')) subtitle = pretty_metadata.get_subtitle() # Build Facebook post attachment if self.config['incl_pmslink']: attachment['link'] = plex_url attachment['caption'] = 'View on Plex Web' elif provider_link: attachment['link'] = provider_link attachment['caption'] = caption else: attachment['link'] = poster_url attachment['picture'] = poster_url attachment['name'] = title attachment['description'] = subtitle if self.config['incl_subject']: return self._post_facebook(subject + '\r\n' + body, attachment=attachment) else: return self._post_facebook(body, attachment=attachment) def return_config_options(self): config_option = [{'label': 'Instructions', 'description': 'Step 1: Visit \ Facebook Developers to add a new app using basic setup.
\ Step 2: Click Add Product on the left, then Get Started \ for Facebook Login.
\ Step 3: Fill in Valid OAuth redirect URIs with your PlexPy URL (e.g. http://localhost:8181).
\ Step 4: Click App Review on the left and toggle "make public" to Yes.
\ Step 5: Fill in the PlexPy URL below with the exact same URL from Step 3.
\ Step 6: Fill in the App ID and App Secret below.
\ Step 7: Click the Request Authorization button below to retrieve your access token.
\ Step 8: Fill in your Access Token below if it is not filled in automatically.
\ Step 9: Fill in your Group ID below.', 'input_type': 'help' }, {'label': 'PlexPy URL', 'value': self.config['redirect_uri'], 'name': 'facebook_redirect_uri', 'description': 'Your PlexPy URL. This will tell Facebook where to redirect you after authorization.\ (e.g. http://localhost:8181)', 'input_type': 'text' }, {'label': 'Facebook App ID', 'value': self.config['app_id'], 'name': 'facebook_app_id', 'description': 'Your Facebook app ID.', 'input_type': 'text' }, {'label': 'Facebook App Secret', 'value': self.config['app_secret'], 'name': 'facebook_app_secret', 'description': 'Your Facebook app secret.', 'input_type': 'text' }, {'label': 'Request Authorization', 'value': 'Request Authorization', 'name': 'facebook_facebookStep1', 'description': 'Request Facebook authorization. (Ensure you allow the browser pop-up).', 'input_type': 'button' }, {'label': 'Facebook Access Token', 'value': self.config['access_token'], 'name': 'facebook_access_token', 'description': 'Your Facebook access token. Automatically filled in after requesting authorization.', 'input_type': 'text' }, {'label': 'Facebook Group ID', 'value': self.config['group_id'], 'name': 'facebook_group_id', 'description': 'Your Facebook Group ID.', 'input_type': 'text' }, {'label': 'Include Poster Image', 'value': self.config['incl_poster'], 'name': 'facebook_incl_poster', 'description': 'Include a poster with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Link to Plex Web', 'value': self.config['incl_pmslink'], 'name': 'facebook_incl_pmslink', 'description': 'Include a link to the media in Plex Web with the notifications.
' 'If disabled, the link will go to IMDB, TVDB, TMDb, or Last.fm instead, if available.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'facebook_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' } ] return config_option class GROWL(Notifier): """ Growl notifications, for OS X. """ _DEFAULT_CONFIG = {'host': '', 'password': '' } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return # Split host and port if self.config['host'] == "": host, port = "localhost", 23053 if ":" in self.config['host']: host, port = self.config['host'].split(':', 1) port = int(port) else: host, port = self.config['host'], 23053 # If password is empty, assume none if self.config['password'] == "": password = None else: password = self.config['password'] # Register notification growl = gntp.notifier.GrowlNotifier( applicationName='PlexPy', notifications=['New Event'], defaultNotifications=['New Event'], hostname=host, port=port, password=password ) try: growl.register() except gntp.notifier.errors.NetworkError: logger.warn(u"PlexPy Notifiers :: Growl notification failed: network error") return False except gntp.notifier.errors.AuthError: logger.warn(u"PlexPy Notifiers :: Growl notification failed: authentication error") return False # Fix message body = body.encode(plexpy.SYS_ENCODING, "replace") # Send it, including an image image_file = os.path.join(str(plexpy.PROG_DIR), "data/interfaces/default/images/favicon.png") with open(image_file, 'rb') as f: image = f.read() try: growl.notify( noteType='New Event', title=subject, description=body, icon=image ) logger.info(u"PlexPy Notifiers :: Growl notification sent.") return True except gntp.notifier.errors.NetworkError: logger.warn(u"PlexPy Notifiers :: Growl notification failed: network error") return False def return_config_options(self): config_option = [{'label': 'Growl Host', 'value': self.config['host'], 'name': 'growl_host', 'description': 'Your Growl hostname.', 'input_type': 'text' }, {'label': 'Growl Password', 'value': self.config['password'], 'name': 'growl_password', 'description': 'Your Growl password.', 'input_type': 'password' } ] return config_option class HIPCHAT(Notifier): """ Hipchat notifications """ _DEFAULT_CONFIG = {'api_url': '', 'color': '', 'emoticon': '', 'incl_pmslink': 0, 'incl_poster': 0, 'incl_subject': 1 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return data = {'notify': 'false'} text = body.encode('utf-8') if self.config['incl_subject']: data['from'] = subject.encode('utf-8') if self.config['color']: data['color'] = self.config['color'] if self.config['incl_poster'] and kwargs.get('parameters', {}).get('media_type'): # Grab formatted metadata pretty_metadata = PrettyMetadata(kwargs['parameters']) poster_url = pretty_metadata.get_poster_url() provider = pretty_metadata.get_provider() provider_link = pretty_metadata.get_provider_link() title = pretty_metadata.get_title() subtitle = pretty_metadata.get_subtitle() plex_url = pretty_metadata.get_plex_url() card = {'title': title, 'format': 'medium', 'style': 'application', 'id': uuid.uuid4().hex, 'activity': {'html': text, 'icon': {'url': poster_url}}, 'description': {'format': 'text', 'value': subtitle}, 'thumbnail': {'url': poster_url} } attributes = [] if provider_link: card['url'] = provider_link attributes.append({'label': 'View Details', 'value': {'label': provider, 'url': provider_link}}) if self.config['incl_pmslink']: attributes.append({'label': 'View Details', 'value': {'label': 'Plex Web', 'url': plex_url}}) if attributes: card['attributes'] = attributes data['message'] = text data['card'] = card else: if self.config['emoticon']: text = self.config['emoticon'] + ' ' + text data['message'] = text data['message_format'] = 'text' hiphost = urlparse(self.config['api_url']).hostname hipfullq = urlparse(self.config['api_url']).path + '?' + urlparse(self.config['api_url']).query http_handler = HTTPSConnection(hiphost) http_handler.request("POST", hipfullq, headers={'Content-type': "application/json"}, body=json.dumps(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200 or request_status == 204: logger.info(u"PlexPy Notifiers :: Hipchat notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Hipchat notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Hipchat notification failed.") return False def return_config_options(self): config_option = [{'label': 'Hipchat Custom Integrations Full URL', 'value': self.config['api_url'], 'name': 'hipchat_api_url', 'description': 'Your Hipchat BYO integration URL. You can get a key from' ' here.', 'input_type': 'text' }, {'label': 'Hipchat Color', 'value': self.config['color'], 'name': 'hipchat_color', 'description': 'Background color for the message.', 'input_type': 'select', 'select_options': {'': '', 'gray': 'gray', 'green': 'green', 'purple': 'purple', 'random': 'random', 'red': 'red', 'yellow': 'yellow' } }, {'label': 'Hipchat Emoticon', 'value': self.config['emoticon'], 'name': 'hipchat_emoticon', 'description': 'Include an emoticon tag at the beginning of text notifications (e.g. (taco)). Leave blank for none.' ' Use a stock emoticon or create a custom emoticon' ' here.', 'input_type': 'text' }, {'label': 'Include Poster', 'value': self.config['incl_poster'], 'name': 'hipchat_incl_poster', 'description': 'Include a poster with the notifications.
Note: This will change the notification type to HTML and emoticons will no longer work.', 'input_type': 'checkbox' }, {'label': 'Include Link to Plex Web', 'value': self.config['incl_pmslink'], 'name': 'hipchat_incl_pmslink', 'description': 'Include a link to the media in Plex Web with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'hipchat_incl_subject', 'description': 'Includes the subject with the notifications.', 'input_type': 'checkbox' } ] return config_option class IFTTT(Notifier): """ IFTTT notifications """ _DEFAULT_CONFIG = {'key': '', 'event': 'plexpy' } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return event = unicode(self.config['event']).format(action=action) data = {'value1': subject.encode("utf-8"), 'value2': body.encode("utf-8")} http_handler = HTTPSConnection("maker.ifttt.com") http_handler.request("POST", "/trigger/%s/with/key/%s" % (event, self.config['key']), headers={'Content-type': "application/json"}, body=json.dumps(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Ifttt notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Ifttt notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Ifttt notification failed.") return False def return_config_options(self): config_option = [{'label': 'Ifttt Maker Channel Key', 'value': self.config['key'], 'name': 'ifttt_key', 'description': 'Your Ifttt key. You can get a key from' ' here.', 'input_type': 'text' }, {'label': 'Ifttt Event', 'value': self.config['event'], 'name': 'ifttt_event', 'description': 'The Ifttt maker event to fire. You can include' ' the {action} to be substituted with the action name.' ' The notification subject and body will be sent' ' as value1 and value2 respectively.', 'input_type': 'text' } ] return config_option class JOIN(Notifier): """ Join notifications """ _DEFAULT_CONFIG = {'apikey': '', 'device_id': '', 'incl_subject': 1 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return deviceid_key = 'deviceId%s' % ('s' if len(self.config['device_id'].split(',')) > 1 else '') data = {'apikey': self.config['apikey'], deviceid_key: self.config['device_id'], 'text': body.encode("utf-8")} if self.config['incl_subject']: data['title'] = subject.encode("utf-8") response = requests.post('https://joinjoaomgcd.appspot.com/_ah/api/messaging/v1/sendPush', params=data) request_status = response.status_code if request_status == 200: data = json.loads(response.text) if data.get('success'): logger.info(u"PlexPy Notifiers :: Join notification sent.") return True else: error_msg = data.get('errorMessage') logger.info(u"PlexPy Notifiers :: Join notification failed: %s" % error_msg) return False elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Join notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Join notification failed.") return False def get_devices(self): if self.config['apikey']: http_handler = HTTPSConnection("joinjoaomgcd.appspot.com") http_handler.request("GET", "/_ah/api/registration/v1/listDevices?%s" % urlencode({'apikey': self.config['apikey']})) response = http_handler.getresponse() request_status = response.status if request_status == 200: data = json.loads(response.read()) if data.get('success'): devices = data.get('records', []) devices = {d['deviceId']: d['deviceName'] for d in devices} devices.update({'': ''}) return devices else: error_msg = data.get('errorMessage') logger.info(u"PlexPy Notifiers :: Unable to retrieve Join devices list: %s" % error_msg) return {'': ''} elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Join devices list: %s" % response.reason) return {'': ''} else: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Join devices list.") return {'': ''} else: return {'': ''} def return_config_options(self): devices = '
'.join(['%s: %s' % (v, k) for k, v in self.get_devices().iteritems() if k]) if not devices: devices = 'Enter your Join API key to load your device list.' config_option = [{'label': 'Join API Key', 'value': self.config['apikey'], 'name': 'join_apikey', 'description': 'Your Join API key. Required for group notifications.', 'input_type': 'text', 'refresh': True }, {'label': 'Device ID(s) or Group ID', 'value': self.config['device_id'], 'name': 'join_device_id', 'description': 'Set your Join device ID or group ID. ' \ 'Separate multiple devices with commas (,).', 'input_type': 'text', }, {'label': 'Your Devices IDs', 'description': devices, 'input_type': 'help' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'join_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' } ] return config_option class NMA(Notifier): """ Notify My Android notifications """ _DEFAULT_CONFIG = {'apikey': '', 'priority': 0 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return title = 'PlexPy' batch = False p = pynma.PyNMA() keys = self.config['apikey'].split(',') p.addkey(keys) if len(keys) > 1: batch = True response = p.push(title, subject, body, priority=self.config['priority'], batch_mode=batch) if not response[self.config['apikey']][u'code'] == u'200': logger.warn(u"PlexPy Notifiers :: NotifyMyAndroid notification failed.") return False else: logger.info(u"PlexPy Notifiers :: NotifyMyAndroid notification sent.") return True def return_config_options(self): config_option = [{'label': 'NotifyMyAndroid API Key', 'value': self.config['apikey'], 'name': 'nma_apikey', 'description': 'Your NotifyMyAndroid API key. Separate multiple api keys with commas.', 'input_type': 'text' }, {'label': 'Priority', 'value': self.config['priority'], 'name': 'nma_priority', 'description': 'Set the priority.', 'input_type': 'select', 'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2} } ] return config_option class OSX(Notifier): """ OSX notifications """ _DEFAULT_CONFIG = {'notify_app': '/Applications/PlexPy' } def __init__(self, config=None): self.set_config(config) try: self.objc = __import__("objc") self.AppKit = __import__("AppKit") except: # logger.error(u"PlexPy Notifiers :: Cannot load OSX Notifications agent.") pass def validate(self): try: self.objc = __import__("objc") self.AppKit = __import__("AppKit") return True except: return False def _swizzle(self, cls, SEL, func): old_IMP = cls.instanceMethodForSelector_(SEL) def wrapper(self, *args, **kwargs): return func(self, old_IMP, *args, **kwargs) new_IMP = self.objc.selector(wrapper, selector=old_IMP.selector, signature=old_IMP.signature) self.objc.classAddMethod(cls, SEL, new_IMP) def _swizzled_bundleIdentifier(self, original, swizzled): return 'ade.plexpy.osxnotify' def notify(self, subject='', body='', action='', **kwargs): subtitle = kwargs.get('subtitle', '') sound = kwargs.get('sound', '') image = kwargs.get('image', '') try: self._swizzle(self.objc.lookUpClass('NSBundle'), b'bundleIdentifier', self._swizzled_bundleIdentifier) NSUserNotification = self.objc.lookUpClass('NSUserNotification') NSUserNotificationCenter = self.objc.lookUpClass('NSUserNotificationCenter') NSAutoreleasePool = self.objc.lookUpClass('NSAutoreleasePool') if not NSUserNotification or not NSUserNotificationCenter: return False pool = NSAutoreleasePool.alloc().init() notification = NSUserNotification.alloc().init() notification.setTitle_(subject) if subtitle: notification.setSubtitle_(subtitle) if body: notification.setInformativeText_(body) if sound: notification.setSoundName_("NSUserNotificationDefaultSoundName") if image: source_img = self.AppKit.NSImage.alloc().initByReferencingFile_(image) notification.setContentImage_(source_img) # notification.set_identityImage_(source_img) notification.setHasActionButton_(False) notification_center = NSUserNotificationCenter.defaultUserNotificationCenter() notification_center.deliverNotification_(notification) logger.info(u"PlexPy Notifiers :: OSX Notify notification sent.") del pool return True except Exception as e: logger.warn(u"PlexPy Notifiers :: OSX notification failed: %s" % e) return False def return_config_options(self): config_option = [{'label': 'Register Notify App', 'value': self.config['notify_app'], 'name': 'osx_notify_app', 'description': 'Enter the path/application name to be registered with the ' 'Notification Center, default is /Applications/PlexPy.', 'input_type': 'text' } ] return config_option class PLEX(Notifier): """ Plex Home Theater notifications """ _DEFAULT_CONFIG = {'hosts': '', 'username': '', 'password': '', 'display_time': 5, 'image': '' } def _sendhttp(self, host, command): url_command = urllib.urlencode(command) url = host + '/xbmcCmds/xbmcHttp/?' + url_command if self.config['password']: return request.request_content(url, auth=(self.config['username'], self.config['password'])) else: return request.request_content(url) def _sendjson(self, host, method, params={}): data = [{'id': 0, 'jsonrpc': '2.0', 'method': method, 'params': params}] headers = {'Content-Type': 'application/json'} url = host + '/jsonrpc' if self.config['password']: response = request.request_json(url, method="post", data=json.dumps(data), headers=headers, auth=(self.config['username'], self.config['password'])) else: response = request.request_json(url, method="post", data=json.dumps(data), headers=headers) if response: return response[0]['result'] def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return hosts = [x.strip() for x in self.config['hosts'].split(',')] if self.config['display_time'] > 0: display_time = 1000 * self.config['display_time'] # in ms else: display_time = 5000 if self.config['image']: image = self.config['image'] else: image = os.path.join(plexpy.DATA_DIR, os.path.abspath("data/interfaces/default/images/favicon.png")) for host in hosts: logger.info(u"PlexPy Notifiers :: Sending notification command to Plex Home Theater @ " + host) try: version = self._sendjson(host, 'Application.GetProperties', {'properties': ['version']})['version']['major'] if version < 12: # Eden notification = subject + "," + body + "," + str(display_time) notifycommand = {'command': 'ExecBuiltIn', 'parameter': 'Notification(' + notification + ')'} request = self._sendhttp(host, notifycommand) else: # Frodo params = {'title': subject, 'message': body, 'displaytime': display_time, 'image': image} request = self._sendjson(host, 'GUI.ShowNotification', params) if not request: raise Exception else: logger.info(u"PlexPy Notifiers :: Plex Home Theater notification sent.") except Exception as e: logger.warn(u"PlexPy Notifiers :: Plex Home Theater notification failed: %s." % e) return False return True def return_config_options(self): config_option = [{'label': 'Plex Home Theater Host:Port', 'value': self.config['hosts'], 'name': 'plex_hosts', 'description': 'Host running Plex Home Theater (eg. http://localhost:3005). Separate multiple hosts with commas (,).', 'input_type': 'text' }, {'label': 'Plex Home Theater Username', 'value': self.config['username'], 'name': 'plex_username', 'description': 'Username of your Plex Home Theater client API (blank for none).', 'input_type': 'text' }, {'label': 'Plex Home Theater Password', 'value': self.config['password'], 'name': 'plex_password', 'description': 'Password of your Plex Home Theater client API (blank for none).', 'input_type': 'password' }, {'label': 'Notification Duration', 'value': self.config['display_time'], 'name': 'plex_display_time', 'description': 'The duration (in seconds) for the notification to stay on screen.', 'input_type': 'number' }, {'label': 'Notification Icon', 'value': self.config['image'], 'name': 'plex_image', 'description': 'Full path or URL to an image to display with the notification. Leave blank for the default.', 'input_type': 'text' } ] return config_option class PROWL(Notifier): """ Prowl notifications. """ _DEFAULT_CONFIG = {'keys': '', 'priority': 0 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return data = {'apikey': self.config['keys'], 'application': 'PlexPy', 'event': subject.encode("utf-8"), 'description': body.encode("utf-8"), 'priority': self.config['priority']} http_handler = HTTPSConnection("api.prowlapp.com") http_handler.request("POST", "/publicapi/add", headers={'Content-type': "application/x-www-form-urlencoded"}, body=urlencode(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Prowl notification sent.") return True elif request_status == 401: logger.warn(u"PlexPy Notifiers :: Prowl notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Prowl notification failed.") return False def return_config_options(self): config_option = [{'label': 'Prowl API Key', 'value': self.config['keys'], 'name': 'prowl_keys', 'description': 'Your Prowl API key.', 'input_type': 'text' }, {'label': 'Priority', 'value': self.config['priority'], 'name': 'prowl_priority', 'description': 'Set the priority.', 'input_type': 'select', 'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2} } ] return config_option class PUSHALOT(Notifier): """ Pushalot notifications """ _DEFAULT_CONFIG = {'apikey': '' } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return data = {'AuthorizationToken': self.config['apikey'], 'Title': subject.encode('utf-8'), 'Body': body.encode("utf-8")} http_handler = HTTPSConnection("pushalot.com") http_handler.request("POST", "/api/sendmessage", headers={'Content-type': "application/x-www-form-urlencoded"}, body=urlencode(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Pushalot notification sent.") return True elif request_status == 410: logger.warn(u"PlexPy Notifiers :: Pushalot notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Pushalot notification failed.") return False def return_config_options(self): config_option = [{'label': 'Pushalot API Key', 'value': self.config['apikey'], 'name': 'pushalot_apikey', 'description': 'Your Pushalot API key.', 'input_type': 'text' } ] return config_option class PUSHBULLET(Notifier): """ Pushbullet notifications """ _DEFAULT_CONFIG = {'apikey': '', 'deviceid': '', 'channel_tag': '' } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return data = {'type': "note", 'title': subject.encode("utf-8"), 'body': body.encode("utf-8")} # Can only send to a device or channel, not both. if self.config['deviceid']: data['device_iden'] = self.config['deviceid'] elif self.config['channel_tag']: data['channel_tag'] = self.config['channel_tag'] http_handler = HTTPSConnection("api.pushbullet.com") http_handler.request("POST", "/v2/pushes", headers={'Content-type': "application/json", 'Authorization': 'Basic %s' % base64.b64encode(self.config['apikey'] + ":")}, body=json.dumps(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: PushBullet notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: PushBullet notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: PushBullet notification failed.") return False def get_devices(self): if self.config['apikey']: http_handler = HTTPSConnection("api.pushbullet.com") http_handler.request("GET", "/v2/devices", headers={'Content-type': "application/json", 'Authorization': 'Basic %s' % base64.b64encode(self.config['apikey'] + ":")}) response = http_handler.getresponse() request_status = response.status if request_status == 200: data = json.loads(response.read()) devices = data.get('devices', []) devices = {d['iden']: d['nickname'] for d in devices if d['active']} devices.update({'': ''}) return devices elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Pushbullet devices list: %s" % response.reason) return {'': ''} else: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Pushbullet devices list.") return {'': ''} else: return {'': ''} def return_config_options(self): config_option = [{'label': 'Pushbullet API Key', 'value': self.config['apikey'], 'name': 'pushbullet_apikey', 'description': 'Your Pushbullet API key.', 'input_type': 'text', 'refresh': True }, {'label': 'Device', 'value': self.config['deviceid'], 'name': 'pushbullet_deviceid', 'description': 'Set your Pushbullet device. If set, will override channel tag. ' \ 'Leave blank to notify on all devices.', 'input_type': 'select', 'select_options': self.get_devices() }, {'label': 'Channel', 'value': self.config['channel_tag'], 'name': 'pushbullet_channel_tag', 'description': 'A channel tag (optional).', 'input_type': 'text' } ] return config_option class PUSHOVER(Notifier): """ Pushover notifications """ _DEFAULT_CONFIG = {'apitoken': '', 'keys': '', 'html_support': 1, 'priority': 0, 'sound': '', 'incl_url': 1, 'incl_pmslink': 0 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return data = {'token': self.config['apitoken'], 'user': self.config['keys'], 'title': subject.encode("utf-8"), 'message': body.encode("utf-8"), 'sound': self.config['sound'], 'html': self.config['html_support'], 'priority': self.config['priority']} if self.config['incl_url'] and kwargs.get('parameters', {}).get('media_type'): # Grab formatted metadata pretty_metadata = PrettyMetadata(kwargs['parameters']) plex_url = pretty_metadata.get_plex_url() provider_link = pretty_metadata.get_provider_link() caption = pretty_metadata.get_caption() if self.config['incl_pmslink']: data['url'] = plex_url data['url_title'] = 'View on Plex Web' else: data['url'] = provider_link data['url_title'] = caption http_handler = HTTPSConnection("api.pushover.net") http_handler.request("POST", "/1/messages.json", headers={'Content-type': "application/x-www-form-urlencoded"}, body=urlencode(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Pushover notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Pushover notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Pushover notification failed.") return False def get_sounds(self): if self.config['apitoken']: http_handler = HTTPSConnection("api.pushover.net") http_handler.request("GET", "/1/sounds.json?token=" + self.config['apitoken']) response = http_handler.getresponse() request_status = response.status if request_status == 200: data = json.loads(response.read()) sounds = data.get('sounds', {}) sounds.update({'': ''}) return sounds elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Pushover notification sounds list: %s" % response.reason) return {'': ''} else: logger.warn(u"PlexPy Notifiers :: Unable to retrieve Pushover notification sounds list.") return {'': ''} else: return {'': ''} def return_config_options(self): config_option = [{'label': 'Pushover API Token', 'value': self.config['apitoken'], 'name': 'pushover_apitoken', 'description': 'Your Pushover API token.', 'input_type': 'text', 'refresh': True }, {'label': 'Pushover User or Group Key', 'value': self.config['keys'], 'name': 'pushover_keys', 'description': 'Your Pushover user or group key.', 'input_type': 'text' }, {'label': 'Priority', 'value': self.config['priority'], 'name': 'pushover_priority', 'description': 'Set the priority.', 'input_type': 'select', 'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2} }, {'label': 'Sound', 'value': self.config['sound'], 'name': 'pushover_sound', 'description': 'Set the notification sound. Leave blank for the default sound.', 'input_type': 'select', 'select_options': self.get_sounds() }, {'label': 'Enable HTML Support', 'value': self.config['html_support'], 'name': 'pushover_html_support', 'description': 'Style your messages using these HTML tags: b, i, u, a[href], font[color]', 'input_type': 'checkbox' }, {'label': 'Include supplementary URL', 'value': self.config['incl_url'], 'name': 'pushover_incl_url', 'description': 'Include a supplementary URL to IMDB, TVDB, TMDb, or Last.fm with the notifications.', 'input_type': 'checkbox' }, {'label': 'Supplementary URL to Plex Web', 'value': self.config['incl_pmslink'], 'name': 'pushover_incl_pmslink', 'description': 'Enable to change the supplementary URL to the media in Plex Web.', 'input_type': 'checkbox' } ] return config_option class SCRIPTS(Notifier): """ Script notifications """ _DEFAULT_CONFIG = {'script_folder': '', 'script': '', 'timeout': 30 } def __init__(self, config=None): self.set_config(config) self.script_exts = {'.bat': '', '.cmd': '', '.exe': '', '.php': 'php', '.pl': 'perl', '.ps1': 'powershell -executionPolicy bypass -file', '.py': 'python', '.pyw': 'pythonw', '.rb': 'ruby', '.sh': '' } def list_scripts(self): scriptdir = self.config['script_folder'] scripts = {'': ''} if scriptdir and not os.path.exists(scriptdir): return scripts for root, dirs, files in os.walk(scriptdir): for f in files: name, ext = os.path.splitext(f) if ext in self.script_exts.keys(): rfp = os.path.join(os.path.relpath(root, scriptdir), f) fp = os.path.join(root, f) scripts[fp] = rfp return scripts def run_script(self, script): def kill_script(process): logger.warn(u"PlexPy Notifiers :: Script exceeded timeout limit of %d seconds. " "Script killed." % self.config['timeout']) process.kill() self.script_killed = True self.script_killed = False output = error = '' try: process = subprocess.Popen(script, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=self.config['script_folder']) if self.config['timeout'] > 0: timer = threading.Timer(self.config['timeout'], kill_script, (process,)) else: timer = None try: if timer: timer.start() output, error = process.communicate() status = process.returncode finally: if timer: timer.cancel() except OSError as e: logger.error(u"PlexPy Notifiers :: Failed to run script: %s" % e) return False if error: err = '\n '.join([l for l in error.splitlines()]) logger.error(u"PlexPy Notifiers :: Script error: \n %s" % err) return False if output: out = '\n '.join([l for l in output.splitlines()]) logger.debug(u"PlexPy Notifiers :: Script returned: \n %s" % out) if not self.script_killed: logger.info(u"PlexPy Notifiers :: Script notification sent.") return True def notify(self, subject='', body='', action='', **kwargs): """ Args: subject(string, optional): Subject text, body(string, optional): Body text, action(string): 'play' """ if not self.config['script_folder']: logger.error(u"PlexPy Notifiers :: No script folder specified.") return script_args = subject or None logger.debug(u"PlexPy Notifiers :: Trying to run notify script, action: %s, arguments: %s" % (action, script_args)) if not script_args: script_args = [] script = kwargs.get('script', self.config.get('script', '')) # Don't try to run the script if the action does not have one if action and not script: logger.debug(u"PlexPy Notifiers :: No script selected for action %s, exiting..." % action) return elif not script: logger.debug(u"PlexPy Notifiers :: No script selected, exiting...") return name, ext = os.path.splitext(script) prefix = self.script_exts.get(ext, '') if os.name == 'nt': script = script.encode(plexpy.SYS_ENCODING, 'ignore') if prefix: script = prefix.split() + [script] else: script = [script] # For manual notifications if script_args and isinstance(script_args, basestring): # attemps for format it for the user script_args = shlex.split(script_args) # Windows handles unicode very badly. # https://bugs.python.org/issue19264 if script_args and os.name == 'nt': script_args = [s.encode(plexpy.SYS_ENCODING, 'ignore') for s in script_args] # Allow overrides for shitty systems if prefix and script_args: if script_args[0] in ('python2', 'python', 'pythonw', 'php', 'ruby', 'perl'): script[0] = script_args[0] del script_args[0] script.extend(script_args) logger.debug(u"PlexPy Notifiers :: Full script is: %s" % script) logger.debug(u"PlexPy Notifiers :: Executing script in a new thread.") thread = threading.Thread(target=self.run_script, args=(script,)).start() return True def return_config_options(self): config_option = [{'label': 'Supported File Types', 'description': '' + \ ', '.join(self.script_exts.keys()) + '', 'input_type': 'help' }, {'label': 'Script Folder', 'value': self.config['script_folder'], 'name': 'scripts_script_folder', 'description': 'Enter the full path to your script folder.', 'input_type': 'text', 'refresh': True }, {'label': 'Script File', 'value': self.config['script'], 'name': 'scripts_script', 'description': 'Select the script file to run.', 'input_type': 'select', 'select_options': self.list_scripts() }, {'label': 'Script Timeout', 'value': self.config['timeout'], 'name': 'scripts_timeout', 'description': 'The number of seconds to wait before killing the script. 0 to disable timeout.', 'input_type': 'number' } ] return config_option class SLACK(Notifier): """ Slack Notifications """ _DEFAULT_CONFIG = {'hook': '', 'channel': '', 'username': '', 'icon_emoji': '', 'color': '', 'incl_pmslink': 0, 'incl_poster': 0, 'incl_subject': 1 } def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return if self.config['incl_subject']: text = subject.encode('utf-8') + '\r\n' + body.encode("utf-8") else: text = body.encode("utf-8") data = {'text': text} if self.config['channel'] and self.config['channel'].startswith('#'): data['channel'] = self.config['channel'] if self.config['username']: data['username'] = self.config['username'] if self.config['icon_emoji']: if urlparse(self.config['icon_emoji']).scheme == '': data['icon_emoji'] = self.config['icon_emoji'] else: data['icon_url'] = self.config['icon_emoji'] if self.config['incl_poster'] and kwargs.get('parameters', {}).get('media_type'): # Grab formatted metadata pretty_metadata = PrettyMetadata(kwargs['parameters']) poster_url = pretty_metadata.get_poster_url() plex_url = pretty_metadata.get_plex_url() provider = pretty_metadata.get_provider() provider_link = pretty_metadata.get_provider_link() title = pretty_metadata.get_title() subtitle = pretty_metadata.get_subtitle() # Build Slack post attachment attachment = {'fallback': 'Image for %s' % title, 'title': title, 'text': subtitle, 'image_url': poster_url, 'thumb_url': poster_url } if self.config['color'] and self.config['color'].startswith('#'): attachment['color'] = self.config['color'] fields = [] if provider_link: attachment['title_link'] = provider_link fields.append({'title': 'View Details', 'value': '<%s|%s>' % (provider_link, provider), 'short': True}) if self.config['incl_pmslink']: fields.append({'title': 'View Details', 'value': '<%s|%s>' % (plex_url, 'Plex Web'), 'short': True}) if fields: attachment['fields'] = fields data['attachments'] = [attachment] host = urlparse(self.config['hook']).hostname path = urlparse(self.config['hook']).path http_handler = HTTPSConnection(host) http_handler.request("POST", path, headers={'Content-type': "application/json"}, body=json.dumps(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Slack notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Slack notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Slack notification failed.") return False def return_config_options(self): config_option = [{'label': 'Slack Webhook URL', 'value': self.config['hook'], 'name': 'slack_hook', 'description': 'Your Slack incoming webhook URL.', 'input_type': 'text' }, {'label': 'Slack Channel', 'value': self.config['channel'], 'name': 'slack_channel', 'description': 'The Slack channel name (begins with \'#\') which will be used. Leave blank for webhook integration default.', 'input_type': 'text' }, {'label': 'Slack Username', 'value': self.config['username'], 'name': 'slack_username', 'description': 'The Slack username which will be used. Leave blank for webhook integration default.', 'input_type': 'text' }, {'label': 'Slack Icon', 'value': self.config['icon_emoji'], 'description': 'The Slack emoji or image url for the icon which will be used. Leave blank for webhook integration default.', 'name': 'slack_icon_emoji', 'input_type': 'text' }, {'label': 'Slack Color', 'value': self.config['color'], 'description': 'The hex color value (begins with \'#\') for the border along the left side of the message attachment.', 'name': 'slack_color', 'input_type': 'text' }, {'label': 'Include Poster Image', 'value': self.config['incl_poster'], 'name': 'slack_incl_poster', 'description': 'Include a poster with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Link to Plex Web', 'value': self.config['incl_pmslink'], 'name': 'slack_incl_pmslink', 'description': 'Include a second link to the media in Plex Web with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'slack_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' } ] return config_option class TELEGRAM(Notifier): """ Telegram notifications """ _DEFAULT_CONFIG = {'bot_token': '', 'chat_id': '', 'disable_web_preview': 0, 'html_support': 1, 'incl_poster': 0, 'incl_subject': 1 } def notify(self, subject='', body='', action='', **kwargs): if not body or not subject: return data = {'chat_id': self.config['chat_id']} if self.config['incl_subject']: text = subject.encode('utf-8') + '\r\n' + body.encode('utf-8') else: text = body.encode('utf-8') if self.config['incl_poster'] and kwargs.get('parameters'): poster_data = {'chat_id': self.config['chat_id'], 'disable_notification': True} parameters = kwargs['parameters'] poster_url = parameters.get('poster_url','') if poster_url: files = {'photo': (poster_url, urllib.urlopen(poster_url).read())} response = requests.post('https://api.telegram.org/bot%s/%s' % (self.config['bot_token'], 'sendPhoto'), data=poster_data, files=files) request_status = response.status_code request_content = json.loads(response.text) if request_status == 200: logger.info(u"PlexPy Notifiers :: Telegram poster sent.") elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Telegram poster failed: %s" % request_content.get('description')) else: logger.warn(u"PlexPy Notifiers :: Telegram poster failed.") data['text'] = text if self.config['html_support']: data['parse_mode'] = 'HTML' if self.config['disable_web_preview']: data['disable_web_page_preview'] = True http_handler = HTTPSConnection("api.telegram.org") http_handler.request('POST', '/bot%s/%s' % (self.config['bot_token'], 'sendMessage'), headers={'Content-type': 'application/x-www-form-urlencoded'}, body=urlencode(data)) response = http_handler.getresponse() request_status = response.status if request_status == 200: logger.info(u"PlexPy Notifiers :: Telegram notification sent.") return True elif request_status >= 400 and request_status < 500: logger.warn(u"PlexPy Notifiers :: Telegram notification failed: [%s] %s" % (request_status, response.reason)) return False else: logger.warn(u"PlexPy Notifiers :: Telegram notification failed.") return False def return_config_options(self): config_option = [{'label': 'Telegram Bot Token', 'value': self.config['bot_token'], 'name': 'telegram_bot_token', 'description': 'Your Telegram bot token. ' 'Contact @BotFather' ' on Telegram to get one.', 'input_type': 'text' }, {'label': 'Telegram Chat ID, Group ID, or Channel Username', 'value': self.config['chat_id'], 'name': 'telegram_chat_id', 'description': 'Your Telegram Chat ID, Group ID, or @channelusername. ' 'Contact @myidbot' ' on Telegram to get an ID.', 'input_type': 'text' }, {'label': 'Include Poster Image', 'value': self.config['incl_poster'], 'name': 'telegram_incl_poster', 'description': 'Include a poster with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'telegram_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' }, {'label': 'Enable HTML Support', 'value': self.config['html_support'], 'name': 'telegram_html_support', 'description': 'Style your messages using these HTML tags: b, i, a[href], code, pre.', 'input_type': 'checkbox' }, {'label': 'Disable Web Page Previews', 'value': self.config['disable_web_preview'], 'name': 'telegram_disable_web_preview', 'description': 'Disables automatic link previews for links in the message', 'input_type': 'checkbox' } ] return config_option class TWITTER(Notifier): """ Twitter notifications """ REQUEST_TOKEN_URL = 'https://api.twitter.com/oauth/request_token' ACCESS_TOKEN_URL = 'https://api.twitter.com/oauth/access_token' AUTHORIZATION_URL = 'https://api.twitter.com/oauth/authorize' SIGNIN_URL = 'https://api.twitter.com/oauth/authenticate' _DEFAULT_CONFIG = {'access_token': '', 'access_token_secret': '', 'consumer_key': '', 'consumer_secret': '', 'incl_poster': 0, 'incl_subject': 1 } def _send_tweet(self, message=None, attachment=None): consumer_key = self.config['consumer_key'] consumer_secret = self.config['consumer_secret'] access_token = self.config['access_token'] access_token_secret = self.config['access_token_secret'] # logger.info(u"PlexPy Notifiers :: Sending tweet: " + message) api = twitter.Api(consumer_key, consumer_secret, access_token, access_token_secret) try: api.PostUpdate(message, media=attachment) logger.info(u"PlexPy Notifiers :: Twitter notification sent.") return True except Exception as e: logger.warn(u"PlexPy Notifiers :: Twitter notification failed: %s" % e) return False def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return poster_url = '' if self.config['incl_poster'] and kwargs.get('parameters'): parameters = kwargs['parameters'] poster_url = parameters.get('poster_url','') if self.config['incl_subject']: return self._send_tweet(subject + '\r\n' + body, attachment=poster_url) else: return self._send_tweet(body, attachment=poster_url) def return_config_options(self): config_option = [{'label': 'Instructions', 'description': 'Step 1: Visit \ Twitter Apps to Create New App. A vaild "Website" is not required.
\ Step 2: Go to Keys and Access Tokens and click \ Create my access token.
\ Step 3: Fill in the Consumer Key, Consumer Secret, \ Access Token, and Access Token Secret below.', 'input_type': 'help' }, {'label': 'Twitter Consumer Key', 'value': self.config['consumer_key'], 'name': 'twitter_consumer_key', 'description': 'Your Twitter consumer key.', 'input_type': 'text' }, {'label': 'Twitter Consumer Secret', 'value': self.config['consumer_secret'], 'name': 'twitter_consumer_secret', 'description': 'Your Twitter consumer secret.', 'input_type': 'text' }, {'label': 'Twitter Access Token', 'value': self.config['access_token'], 'name': 'twitter_access_token', 'description': 'Your Twitter access token.', 'input_type': 'text' }, {'label': 'Twitter Access Token Secret', 'value': self.config['access_token_secret'], 'name': 'twitter_access_token_secret', 'description': 'Your Twitter access token secret.', 'input_type': 'text' }, {'label': 'Include Poster Image', 'value': self.config['incl_poster'], 'name': 'twitter_incl_poster', 'description': 'Include a poster with the notifications.', 'input_type': 'checkbox' }, {'label': 'Include Subject Line', 'value': self.config['incl_subject'], 'name': 'twitter_incl_subject', 'description': 'Include the subject line with the notifications.', 'input_type': 'checkbox' } ] return config_option class XBMC(Notifier): """ XBMC notifications """ _DEFAULT_CONFIG = {'hosts': '', 'username': '', 'password': '', 'display_time': 5, 'image': '' } def _sendhttp(self, host, command): url_command = urllib.urlencode(command) url = host + '/xbmcCmds/xbmcHttp/?' + url_command if self.config['password']: return request.request_content(url, auth=(self.config['username'], self.config['password'])) else: return request.request_content(url) def _sendjson(self, host, method, params={}): data = [{'id': 0, 'jsonrpc': '2.0', 'method': method, 'params': params}] headers = {'Content-Type': 'application/json'} url = host + '/jsonrpc' if self.config['password']: response = request.request_json(url, method="post", data=json.dumps(data), headers=headers, auth=(self.config['username'], self.config['password'])) else: response = request.request_json(url, method="post", data=json.dumps(data), headers=headers) if response: return response[0]['result'] def notify(self, subject='', body='', action='', **kwargs): if not subject or not body: return hosts = [x.strip() for x in self.config['hosts'].split(',')] if self.config['display_time'] > 0: display_time = 1000 * self.config['display_time'] # in ms else: display_time = 5000 if self.config['image']: image = self.config['image'] else: image = os.path.join(plexpy.DATA_DIR, os.path.abspath("data/interfaces/default/images/favicon.png")) for host in hosts: logger.info(u"PlexPy Notifiers :: Sending notification command to XMBC @ " + host) try: version = self._sendjson(host, 'Application.GetProperties', {'properties': ['version']})['version']['major'] if version < 12: # Eden notification = subject + "," + body + "," + str(display_time) notifycommand = {'command': 'ExecBuiltIn', 'parameter': 'Notification(' + notification + ')'} request = self._sendhttp(host, notifycommand) else: # Frodo params = {'title': subject, 'message': body, 'displaytime': display_time, 'image': image} request = self._sendjson(host, 'GUI.ShowNotification', params) if not request: raise Exception else: logger.info(u"PlexPy Notifiers :: XBMC notification sent.") except Exception as e: logger.warn(u"PlexPy Notifiers :: Plex Home Theater notification failed: %s." % e) return False return True def return_config_options(self): config_option = [{'label': 'XBMC Host:Port', 'value': self.config['hosts'], 'name': 'xbmc_hosts', 'description': 'Host running XBMC (e.g. http://localhost:8080). Separate multiple hosts with commas (,).', 'input_type': 'text' }, {'label': 'XBMC Username', 'value': self.config['username'], 'name': 'xbmc_username', 'description': 'Username of your XBMC client API (blank for none).', 'input_type': 'text' }, {'label': 'XBMC Password', 'value': self.config['password'], 'name': 'xbmc_password', 'description': 'Password of your XBMC client API (blank for none).', 'input_type': 'password' }, {'label': 'Notification Duration', 'value': self.config['display_time'], 'name': 'xbmc_display_time', 'description': 'The duration (in seconds) for the notification to stay on screen.', 'input_type': 'number' }, {'label': 'Notification Icon', 'value': self.config['image'], 'name': 'xbmc_image', 'description': 'Full path or URL to an image to display with the notification. Leave blank for the default.', 'input_type': 'text' } ] return config_option def upgrade_config_to_db(): logger.info(u"PlexPy Notifiers :: Upgrading to new notification system...") # Set flag first in case something fails we don't want to keep re-adding the notifiers plexpy.CONFIG.__setattr__('UPDATE_NOTIFIERS_DB', 0) plexpy.CONFIG.write() # Config section names from the {new: old} config section_overrides = {'xbmc': 'XBMC', 'nma': 'NMA', 'pushbullet': 'PushBullet', 'osx': 'OSX_Notify', 'ifttt': 'IFTTT' } # Config keys from the {new: old} config config_key_overrides = {'plex': {'hosts': 'client_host'}, 'facebook': {'access_token': 'token', 'group_id': 'group'}, 'join': {'device_id': 'deviceid'}, 'hipchat': {'api_url': 'url'}, 'osx': {'notify_app': 'app'}, 'scripts': {'script_folder': 'folder'} } # Get Monitoring config section monitoring = plexpy.CONFIG._config['Monitoring'] # Get the new default notification subject and body text defualt_subject_text = {a['name']: a['subject'] for a in available_notification_actions()} defualt_body_text = {a['name']: a['body'] for a in available_notification_actions()} # Get the old notification subject and body text notify_text = {} for action in get_notify_actions(): subject_key = 'notify_' + action + '_subject_text' body_key = 'notify_' + action + '_body_text' notify_text[action + '_subject'] = monitoring.get(subject_key, defualt_subject_text[action]) notify_text[action + '_body'] = monitoring.get(body_key, defualt_body_text[action]) # Check through each notification agent for agent in get_notify_agents(): agent_id = AGENT_IDS[agent] # Get the old config section for the agent agent_section = section_overrides.get(agent, agent.capitalize()) agent_config = plexpy.CONFIG._config.get(agent_section) agent_config_key = agent_section.lower() # Make sure there is an existing config section (to prevent adding v2 agents) if not agent_config: continue # Get all the actions for the agent agent_actions = {} for action in get_notify_actions(): a_key = agent_config_key + '_' + action agent_actions[action] = helpers.cast_to_int(agent_config.get(a_key, 0)) # Check if any of the actions were enabled # If so, the agent will be added to the database if any(agent_actions.values()): # Get the new default config for the agent notifier_default_config = get_agent_class(agent_id).config # Update the new config with the old config values notifier_config = {} for conf, val in notifier_default_config.iteritems(): c_key = agent_config_key + '_' + config_key_overrides.get(agent, {}).get(conf, conf) notifier_config[agent + '_' + conf] = agent_config.get(c_key, val) # Special handling for scripts - one script with multiple actions if agent == 'scripts': # Get the old script arguments script_args = monitoring.get('notify_scripts_args_text', '') # Get the old scripts for each action action_scripts = {} for action in get_notify_actions(): s_key = agent + '_' + action + '_script' action_scripts[action] = agent_config.get(s_key, '') # Reverse the dict to {script: [actions]} script_actions = {} for k, v in action_scripts.items(): if v: script_actions.setdefault(v, set()).add(k) # Add a new script notifier for each script if the action was enabled for script, actions in script_actions.items(): if any(agent_actions[a] for a in actions): temp_config = notifier_config temp_config.update({a: 0 for a in agent_actions.keys()}) temp_config.update({a + '_subject': '' for a in agent_actions.keys()}) for a in actions: if agent_actions[a]: temp_config[a] = agent_actions[a] temp_config[a + '_subject'] = script_args temp_config[agent + '_script'] = script # Add a new notifier and update the config notifier_id = add_notifier_config(agent_id=agent_id) set_notifier_config(notifier_id=notifier_id, agent_id=agent_id, **temp_config) else: notifier_config.update(agent_actions) notifier_config.update(notify_text) # Add a new notifier and update the config notifier_id = add_notifier_config(agent_id=agent_id) set_notifier_config(notifier_id=notifier_id, agent_id=agent_id, **notifier_config)