2016-10-26 15:59:37 +00:00
|
|
|
"""
|
|
|
|
|
Pulling together User IP information and Email.
|
|
|
|
|
|
2018-03-19 16:33:44 +00:00
|
|
|
Adding to Tautulli
|
|
|
|
|
Tautulli > Settings > Notification Agents > Scripts > Bell icon:
|
2017-08-05 11:57:09 +00:00
|
|
|
[X] Notify on playback start
|
2018-03-19 16:33:44 +00:00
|
|
|
Tautulli > Settings > Notification Agents > Scripts > Gear icon:
|
2017-08-05 11:57:09 +00:00
|
|
|
Playback Start: notify_newip.py
|
|
|
|
|
|
2018-03-19 16:33:44 +00:00
|
|
|
Arguments passed from Tautulli
|
2018-03-19 15:35:48 +00:00
|
|
|
-sn {show_name} -ena {episode_name} -ssn {season_num00} -enu {episode_num00} -srv {server_name} -med {media_type}
|
|
|
|
|
-pos {poster_url} -tt {title} -sum {summary} -lbn {library_name} -ip {ip_address} -us {user} -uid {user_id}
|
|
|
|
|
-pf {platform} -pl {player} -da {datestamp} -ti {timestamp}
|
2017-08-05 11:57:09 +00:00
|
|
|
|
|
|
|
|
|
2016-10-26 15:59:37 +00:00
|
|
|
"""
|
|
|
|
|
import argparse
|
|
|
|
|
import requests
|
|
|
|
|
import sys
|
|
|
|
|
|
|
|
|
|
## EDIT THESE SETTINGS ##
|
2018-03-19 16:33:44 +00:00
|
|
|
TAUTULLI_APIKEY = '' # Your Tautulli API key
|
|
|
|
|
TAUTULLI_URL = 'http://localhost:8181/' # Your Tautulli URL
|
2018-03-19 15:35:48 +00:00
|
|
|
NOTIFIER_ID = 12 # The notification notifier ID
|
2016-10-26 15:59:37 +00:00
|
|
|
|
|
|
|
|
# Replace LAN IP addresses that start with the LAN_SUBNET with a WAN IP address
|
|
|
|
|
# to retrieve geolocation data. Leave REPLACEMENT_WAN_IP blank for no replacement.
|
|
|
|
|
LAN_SUBNET = '192.168.0'
|
|
|
|
|
REPLACEMENT_WAN_IP = ''
|
|
|
|
|
|
|
|
|
|
# The notification subject and body
|
|
|
|
|
# - Use "{p.argument}" for script arguments
|
|
|
|
|
# - Use "{g.value}" for geolocation data
|
|
|
|
|
# - Use "{u.value}" for user data
|
|
|
|
|
SUBJECT_TEXT = "New IP has been detected using Plex."
|
|
|
|
|
BODY_TEXT = """\
|
|
|
|
|
<html>
|
|
|
|
|
<head></head>
|
|
|
|
|
<body>
|
2016-10-27 02:11:39 +00:00
|
|
|
<p>Hi!<br>
|
2018-03-19 15:35:48 +00:00
|
|
|
<br><a href="mailto:{u.email}"><img src="{u.user_thumb}" alt="Poster unavailable" height="50" width="50"></a>
|
|
|
|
|
{p.user} has watched {p.media_type}:{p.title} from a new IP address: {p.ip_address}<br>
|
|
|
|
|
<br>On {p.platform}[{p.player}] in
|
|
|
|
|
<a href="http://maps.google.com/?q={g.city},{g.country},{g.postal_code}">{g.city}, {g.country} {g.postal_code}</a>
|
|
|
|
|
at {p.timestamp} on {p.datestamp}<br>
|
2016-10-27 02:11:39 +00:00
|
|
|
<br><br>
|
|
|
|
|
<br>User email is: {u.email}<br>
|
|
|
|
|
</p>
|
2016-10-26 15:59:37 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
"""
|
2018-03-19 15:35:48 +00:00
|
|
|
|
|
|
|
|
|
2016-10-26 15:59:37 +00:00
|
|
|
class GeoData(object):
|
2016-10-27 02:11:39 +00:00
|
|
|
def __init__(self, data=None):
|
|
|
|
|
data = data or {}
|
|
|
|
|
self.country = data.get('country', 'N/A')
|
|
|
|
|
self.city = data.get('city', 'N/A')
|
|
|
|
|
self.postal_code = data.get('postal_code', 'N/A')
|
2016-10-26 15:59:37 +00:00
|
|
|
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-26 15:59:37 +00:00
|
|
|
class UserEmail(object):
|
2016-10-27 02:11:39 +00:00
|
|
|
def __init__(self, data=None):
|
|
|
|
|
data = data or {}
|
|
|
|
|
self.email = data.get('email', 'N/A')
|
|
|
|
|
self.user_id = data.get('user_id', 'N/A')
|
|
|
|
|
self.user_thumb = data.get('user_thumb', 'N/A')
|
2018-03-19 15:35:48 +00:00
|
|
|
|
|
|
|
|
|
2016-10-26 15:59:37 +00:00
|
|
|
def get_user_ip_addresses(user_id='', ip_address=''):
|
2018-03-19 16:33:44 +00:00
|
|
|
# Get the user IP list from Tautulli
|
|
|
|
|
payload = {'apikey': TAUTULLI_APIKEY,
|
2016-10-27 02:11:39 +00:00
|
|
|
'cmd': 'get_user_ips',
|
|
|
|
|
'user_id': user_id,
|
|
|
|
|
'search': ip_address}
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
try:
|
2018-03-19 16:33:44 +00:00
|
|
|
r = requests.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=payload)
|
2016-10-27 02:11:39 +00:00
|
|
|
response = r.json()
|
|
|
|
|
|
|
|
|
|
if response['response']['result'] == 'success':
|
|
|
|
|
data = response['response']['data']
|
|
|
|
|
if data.get('error'):
|
|
|
|
|
raise Exception(data['error'])
|
|
|
|
|
else:
|
|
|
|
|
sys.stdout.write("Successfully retrieved UserIPs data.")
|
|
|
|
|
if response['response']['data']['recordsFiltered'] == 0:
|
|
|
|
|
sys.stdout.write("IP has no history.")
|
2018-03-19 15:35:48 +00:00
|
|
|
return data
|
2016-10-27 02:11:39 +00:00
|
|
|
else:
|
|
|
|
|
sys.stdout.write("IP has history, killing script.")
|
|
|
|
|
exit()
|
|
|
|
|
else:
|
|
|
|
|
raise Exception(response['response']['message'])
|
|
|
|
|
except Exception as e:
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stderr.write("Tautulli API 'get_user_ip_addresses' request failed: {0}.".format(e))
|
2018-03-19 15:35:48 +00:00
|
|
|
return
|
|
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
|
|
|
|
|
def get_geoip_info(ip_address=''):
|
2018-03-19 16:33:44 +00:00
|
|
|
# Get the geo IP lookup from Tautulli
|
|
|
|
|
payload = {'apikey': TAUTULLI_APIKEY,
|
2016-10-27 02:11:39 +00:00
|
|
|
'cmd': 'get_geoip_lookup',
|
|
|
|
|
'ip_address': ip_address}
|
|
|
|
|
|
|
|
|
|
try:
|
2018-03-19 16:33:44 +00:00
|
|
|
r = requests.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=payload)
|
2016-10-27 02:11:39 +00:00
|
|
|
response = r.json()
|
|
|
|
|
|
|
|
|
|
if response['response']['result'] == 'success':
|
|
|
|
|
data = response['response']['data']
|
|
|
|
|
if data.get('error'):
|
|
|
|
|
raise Exception(data['error'])
|
|
|
|
|
else:
|
|
|
|
|
sys.stdout.write("Successfully retrieved geolocation data.")
|
|
|
|
|
return GeoData(data=data)
|
|
|
|
|
else:
|
|
|
|
|
raise Exception(response['response']['message'])
|
|
|
|
|
except Exception as e:
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stderr.write("Tautulli API 'get_geoip_lookup' request failed: {0}.".format(e))
|
2016-10-27 02:11:39 +00:00
|
|
|
return GeoData()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_user_email(user_id=''):
|
2018-03-19 16:33:44 +00:00
|
|
|
# Get the user email from Tautulli
|
|
|
|
|
payload = {'apikey': TAUTULLI_APIKEY,
|
2016-10-27 02:11:39 +00:00
|
|
|
'cmd': 'get_user',
|
|
|
|
|
'user_id': user_id}
|
|
|
|
|
|
|
|
|
|
try:
|
2018-03-19 16:33:44 +00:00
|
|
|
r = requests.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=payload)
|
2016-10-27 02:11:39 +00:00
|
|
|
response = r.json()
|
|
|
|
|
|
|
|
|
|
if response['response']['result'] == 'success':
|
|
|
|
|
data = response['response']['data']
|
|
|
|
|
if data.get('error'):
|
|
|
|
|
raise Exception(data['error'])
|
|
|
|
|
else:
|
|
|
|
|
sys.stdout.write("Successfully retrieved user email data.")
|
|
|
|
|
return UserEmail(data=data)
|
|
|
|
|
else:
|
|
|
|
|
raise Exception(response['response']['message'])
|
|
|
|
|
except Exception as e:
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stderr.write("Tautulli API 'get_user' request failed: {0}.".format(e))
|
2016-10-27 02:11:39 +00:00
|
|
|
return UserEmail()
|
|
|
|
|
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
def send_notification(arguments=None, geodata=None, useremail=None):
|
|
|
|
|
# Format notification text
|
|
|
|
|
try:
|
|
|
|
|
subject = SUBJECT_TEXT.format(p=arguments, g=geodata, u=useremail)
|
|
|
|
|
body = BODY_TEXT.format(p=arguments, g=geodata, u=useremail)
|
|
|
|
|
except LookupError as e:
|
|
|
|
|
sys.stderr.write("Unable to substitute '{0}' in the notification subject or body".format(e))
|
|
|
|
|
return None
|
2018-03-19 16:33:44 +00:00
|
|
|
# Send the notification through Tautulli
|
|
|
|
|
payload = {'apikey': TAUTULLI_APIKEY,
|
2016-10-27 02:11:39 +00:00
|
|
|
'cmd': 'notify',
|
2018-03-19 15:35:48 +00:00
|
|
|
'notifier_id': NOTIFIER_ID,
|
2016-10-27 02:11:39 +00:00
|
|
|
'subject': subject,
|
|
|
|
|
'body': body}
|
|
|
|
|
|
|
|
|
|
try:
|
2018-03-19 16:33:44 +00:00
|
|
|
r = requests.post(TAUTULLI_URL.rstrip('/') + '/api/v2', params=payload)
|
2016-10-27 02:11:39 +00:00
|
|
|
response = r.json()
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
if response['response']['result'] == 'success':
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stdout.write("Successfully sent Tautulli notification.")
|
2016-10-27 02:11:39 +00:00
|
|
|
else:
|
|
|
|
|
raise Exception(response['response']['message'])
|
|
|
|
|
except Exception as e:
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stderr.write("Tautulli API 'notify' request failed: {0}.".format(e))
|
2016-10-27 02:11:39 +00:00
|
|
|
return None
|
|
|
|
|
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
if __name__ == '__main__':
|
2018-03-19 16:33:44 +00:00
|
|
|
# Parse arguments from Tautulli
|
2016-10-27 02:11:39 +00:00
|
|
|
parser = argparse.ArgumentParser()
|
|
|
|
|
|
|
|
|
|
parser.add_argument('-ip', '--ip_address', action='store', default='',
|
|
|
|
|
help='The IP address of the stream')
|
|
|
|
|
parser.add_argument('-us', '--user', action='store', default='',
|
|
|
|
|
help='Username of the person watching the stream')
|
|
|
|
|
parser.add_argument('-uid', '--user_id', action='store', default='',
|
2018-03-19 15:35:48 +00:00
|
|
|
help='User_ID of the person watching the stream')
|
2016-10-27 02:11:39 +00:00
|
|
|
parser.add_argument('-med', '--media_type', action='store', default='',
|
|
|
|
|
help='The media type of the stream')
|
|
|
|
|
parser.add_argument('-tt', '--title', action='store', default='',
|
|
|
|
|
help='The title of the media')
|
|
|
|
|
parser.add_argument('-pf', '--platform', action='store', default='',
|
|
|
|
|
help='The platform of the stream')
|
|
|
|
|
parser.add_argument('-pl', '--player', action='store', default='',
|
|
|
|
|
help='The player of the stream')
|
|
|
|
|
parser.add_argument('-da', '--datestamp', action='store', default='',
|
|
|
|
|
help='The date of the stream')
|
|
|
|
|
parser.add_argument('-ti', '--timestamp', action='store', default='',
|
|
|
|
|
help='The time of the stream')
|
|
|
|
|
parser.add_argument('-sn', '--show_name', action='store', default='',
|
|
|
|
|
help='The name of the TV show')
|
|
|
|
|
parser.add_argument('-ena', '--episode_name', action='store', default='',
|
|
|
|
|
help='The name of the episode')
|
|
|
|
|
parser.add_argument('-ssn', '--season_num', action='store', default='',
|
|
|
|
|
help='The season number of the TV show')
|
|
|
|
|
parser.add_argument('-enu', '--episode_num', action='store', default='',
|
|
|
|
|
help='The episode number of the TV show')
|
|
|
|
|
parser.add_argument('-srv', '--plex_server', action='store', default='',
|
|
|
|
|
help='The name of the Plex server')
|
|
|
|
|
parser.add_argument('-pos', '--poster', action='store', default='',
|
|
|
|
|
help='The poster url')
|
|
|
|
|
parser.add_argument('-sum', '--summary', action='store', default='',
|
|
|
|
|
help='The summary of the TV show')
|
|
|
|
|
parser.add_argument('-lbn', '--library_name', action='store', default='',
|
|
|
|
|
help='The name of the TV show')
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
p = parser.parse_args()
|
|
|
|
|
|
|
|
|
|
# Check to make sure there is an IP address before proceeding
|
|
|
|
|
if p.ip_address:
|
|
|
|
|
if p.ip_address.startswith(LAN_SUBNET) and REPLACEMENT_WAN_IP:
|
|
|
|
|
ip_address = REPLACEMENT_WAN_IP
|
|
|
|
|
else:
|
|
|
|
|
ip_address = p.ip_address
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
g = get_geoip_info(ip_address=ip_address)
|
|
|
|
|
u = get_user_email(user_id=p.user_id)
|
|
|
|
|
get_user_ip_addresses(user_id=p.user_id, ip_address=p.ip_address)
|
|
|
|
|
send_notification(arguments=p, geodata=g, useremail=u)
|
2018-03-19 15:35:48 +00:00
|
|
|
|
2016-10-27 02:11:39 +00:00
|
|
|
else:
|
2018-03-19 16:33:44 +00:00
|
|
|
sys.stdout.write("No IP address passed from Tautulli.")
|
