Merge branch 'dev'

Group watch statistics history

.gitignore

@@ -21,6 +21,7 @@ cache/*
 *.crt
 *.key
 *.csr
+*.pem
 
 # OS generated files #
 ######################

API.md

@@ -4,24 +4,77 @@ The API is still pretty new and needs some serious cleaning up on the backend bu
 ## General structure
 The API endpoint is `http://ip:port + HTTP_ROOT + /api?apikey=$apikey&cmd=$command`
 
-Data response in JSON formatted.
+Response example
+```
+{
+    "response": {
+        "data": [
+            {
+                "loglevel": "INFO",
+                "msg": "Signal 2 caught, saving and exiting...",
+                "thread": "MainThread",
+                "time": "22-sep-2015 01:42:56 "
+            }
+        ],
+        "message": null,
+        "result": "success"
+    }
+}
+```
+
+General parameters:
+	out_type: 'xml',
+	callback: 'pong',
+	'debug': 1
+
 
 ## API methods
 
 ### getLogs
-Not working yet
+Possible params: sort='', search='', order='desc', regex='', start=0, end=0
+Returns the plexpy log
+
+### getApikey
+Possible params: username='', password='' (required if auth is enabled)
+Returns the apikey
+
+### getSettings
+No params
+Returns the config file
 
 ### getVersion
+No params
 Returns some version information: git_path, install_type, current_version, installed_version, commits_behind
 
+### getHistory
+possible params: user=None, user_id=None, ,rating_key='', parent_rating_key='', grandparent_rating_key='', start_date=''
+Returns
+
+### getMetadata
+Required params: rating_key
+Returns metadata about a file
+
+### getSync
+Possible params: machine_id=None, user_id=None,
+Returns
+
+### getUserips
+Possible params: user_id=None, user=None
+
+### getPlayby
+Possible params: time_range=30, y_axis='plays', playtype='total_plays_per_month'
+
 ### checkGithub
 Updates the version information above and returns getVersion data
 
 ### shutdown
+No params
 Shut down plexpy
 
 ### restart
+No params
 Restart plexpy
 
 ### update
+No params
 Update plexpy - you may want to check the install type in get version and not allow this if type==exe

CHANGELOG.md

@@ -1,5 +1,159 @@
 # Changelog
 
+## v1.2.15 (2015-12-20)
+
+* Fix navbar covering current activity on smaller screens.
+* Fix metadata for grouped recently added notifications.
+* Fix Growl notification agent not working.
+* Change graph days selection.
+* Change watch statistics to match table history grouping.
+* Add automatic discovery of Pushbullet devices.
+* Add Most Concurrent Streams watch statistic.
+* Add precentage to current activity progress bars.
+* Add a bunch of stream details to notification options.
+* Add notification for Plex Remote Access/Plex Media Server back up.
+* Add CC/BCC and multiple recipients to email notification agent.
+* Add total watch time to history table footer.
+
+
+## v1.2.14 (2015-12-07)
+
+* Fix regression with PlexWatch db importer and buffer warnings.
+
+
+## v1.2.13 (2015-12-06)
+
+* Fix match newlines between tags in notification text.
+* Fix current activity not showing on PMS 0.9.12.
+
+
+## v1.2.12 (2015-12-06)
+
+* Fix for "too many open files" error.
+
+
+## v1.2.11 (2015-12-06)
+
+* Fix more regressions (sorry).
+
+
+## v1.2.10 (2015-12-06)
+
+* Fix broken count graphs regression.
+
+
+## v1.2.9 (2015-12-06)
+
+* Fix and improve text sanitization.
+
+
+## v1.2.8 (2015-12-06)
+
+* Fix sanitize player names
+* Fix recently added notification delay
+* Fix recently added metadata queries
+* Fix multiple lines in notification body text
+* Fix UTF-8 encoding in Prowl notifications subject line
+* Change to only log IPv4 addresses
+* Add global toggle for recently added notifcations
+* Add feature to delete users
+* Add channel support for Telegram notification agent
+* Add icon for Apple tvOS
+* Add icon for Microsoft Edge
+
+
+## v1.2.7 (2015-11-27)
+
+* Fix IP address option in notifications
+
+
+## v1.2.6 (2015-11-27)
+
+* Fixes for IP logging in PMS < 0.9.14.x.
+* Fix issue in plexWatch importer when trying to import item with no ratingKey.
+
+
+## v1.2.5 (2015-11-25)
+
+* Add video_decision and audio_decision to notification options
+* Fix IP address logging
+* Fix log spam if notifications disabled 
+
+
+## v1.2.4 (2015-11-24)
+
+* Add filtering by media type in the history table
+* Add IFTTT notification agent
+* Add Telegram notification agent
+* Add notifications for recently added media
+* Add notifications for server down and remote access down
+* Add more metadata to notifications options
+* Add IP address to notification options (for PMS 0.9.14 and above)
+* Add server uptime to notification options
+* Add IP address to current activity
+* Add IPv6 address logging
+* Add PMS server name to the page title
+* Fix bug in "Last Watched" statistic
+* Fix bug in search query
+* Fix bug on user pages for usernames with single quotes
+* Fix name for new Plex Media Center
+* Fix Pushover notifications with unicode characters
+* Fix bug with showing old usernames in datatables
+* Fix bug with "Please verify your server" in settings
+* Change IP lookup provider
+* Change notifications custom body text to larger text box
+* Change movie/tv logging and notifications into individual options
+
+
+## v1.2.3 (2015-10-18)
+
+* Added "remaining time" as notification substitution.
+* Fix bug on home stats cards.
+* Fix visual bug on user page.
+
+
+## v1.2.2 (2015-10-12)
+
+* Add server discovery on first run.
+* Add column to tables for Platform.
+* Add link to top level breadcrumbs on info pages.
+* Add ability to change notification sounds for Pushover and Boxcar.
+* Show watched percentage tooltip on progress column in history tables. 
+* More logging in event an http request fails.
+* Code cleanups and other fixes.
+* Fix ordering on sync table.
+* Fix bug on home stats cards.
+* Fix bug on activity pane where music details were not shown.
+
+
+## v1.2.1 (2015-09-29)
+
+* Fix for possible issue when paused_counter is null.
+
+
+## v1.2.0 (2015-09-29)
+
+* Added option to group consecutive plays in the history tables.
+* Added option for websocket monitoring (still slightly experimental and disabled by default).
+* Added global search option (searches your Plex library).
+* Added option to update any items that may have had their rating keys changed.
+* Added option to disable consecutive notifications. 
+* Some visual tweaks and fixes.
+* Fix bug where monitoring wouldn't start up after first run.
+* Fix bug showing incorrect transcode decisions for music tracks on history tables.
+
+
+## v1.1.10 (2015-09-20)
+
+* Added dedicated settings section for home stats configuration with ability to show/hide selected stats and sections.
+* Added support for Twitter notifications.
+* Only show music in graphs if music logging is enabled.
+* The monitoring ignore interval now excludes paused time. 
+* Fix display bug on activity panel which incorrectly reported transcoding sometimes.
+* Fix bug with Email notification TLS checkbox when it would be disabled by changing any other settings afterwards.
+* Fix issue on some Python releases where the webbrowser library isn't included.
+
+
 ## v1.1.9 (2015-09-14)
 
 * Another JonnyWong release. I'm going to stop thanking you now ;)

PlexPy.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
 # This file is part of PlexPy.
 #
 #  PlexPy is free software: you can redistribute it and/or modify
@@ -20,7 +22,7 @@ import sys
 # Ensure lib added to path, before any other imports
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'lib/'))
 
-from plexpy import webstart, logger
+from plexpy import webstart, logger, web_socket
 
 import locale
 import time
@@ -191,6 +193,16 @@ def main():
     # Start the background threads
     plexpy.start()
 
+    # Open connection for websocket
+    if plexpy.CONFIG.MONITORING_USE_WEBSOCKET:
+        try:
+            web_socket.start_thread()
+        except:
+            logger.warn(u"Websocket :: Unable to open connection.")
+            # Fallback to polling
+            plexpy.POLLING_FAILOVER = True
+            plexpy.initialize_scheduler()
+
     # Open webbrowser
     if plexpy.CONFIG.LAUNCH_BROWSER and not args.nolaunch:
         plexpy.launch_browser(plexpy.CONFIG.HTTP_HOST, http_port,

README.md

@@ -6,11 +6,7 @@ A python based web application for monitoring, analytics and notifications for P
 
 This project is based on code from Headphones (https://github.com/rembo10/headphones) and PlexWatchWeb (https://github.com/ecleese/plexWatchWeb).
 
-* plexPy forum thread: https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program
-
-If you'd like to buy me a beer, hit the donate button below. All donations go to the project maintainer (primarily for the procurement of liquid refreshment).
-
-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G9HZK9BDJLKT6)
+* PlexPy forum thread: https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program
 
 
 ###Support

data/interfaces/default/base.html

@@ -7,7 +7,7 @@ from plexpy import version
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>PlexPy - ${title}</title>
+    <title>PlexPy - ${title} | ${server_name}</title>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="description" content="">
     <meta name="author" content="">
@@ -37,7 +37,7 @@ from plexpy import version
     % elif plexpy.CONFIG.CHECK_GITHUB and plexpy.CURRENT_VERSION != plexpy.LATEST_VERSION and plexpy.COMMITS_BEHIND > 0 and plexpy.INSTALL_TYPE != 'win':
     <div id="updatebar" style="display: none;">
         A <a
-            href="https://github.com/${plexpy.CONFIG.GIT_USER}/plexpy/compare/${plexpy.CURRENT_VERSION}...${plexpy.LATEST_VERSION}">
+            href="https://github.com/${plexpy.CONFIG.GIT_USER}/plexpy/compare/${plexpy.CURRENT_VERSION}...${plexpy.LATEST_VERSION}" target="_blank">
         newer version</a> is available. You're ${plexpy.COMMITS_BEHIND} commits behind. <a href="update">Update</a> or
         <a href="#" id="updateDismiss">Close</a>
     </div>
@@ -57,6 +57,18 @@ from plexpy import version
             </div>
             <div class="collapse navbar-collapse navbar-right" id="navbar-collapse-1">
                 <ul class="nav navbar-nav">
+                    <li class="hidden-sm hidden-xs">
+                        <form action="search" method="post" class="form" id="search_form">
+                            <div class="input-group">
+                                <span class="input-textbox">
+                                    <input type="text" class="form-control" name="query" id="query" aria-label="Search" placeholder="Search..."/>
+                                </span>
+                                <span class="input-group-btn">
+                                    <button class="btn btn-dark btn-inactive" type="submit" id="search_button"><i class="fa fa-search"></i></button>
+                                </span>
+                            </div>
+                        </form>
+                    </li>
                     % if title=="Home":
                         <li class="active"><a href="home"><i class="fa fa-lg fa-home"></i></a></li>
                     % else:
@@ -117,6 +129,28 @@ ${next.headerIncludes()}
         $('#updatebar').show();
     }
 </script>
+<script>
+    $('#search_form').submit(function (e) {
+        if ($('#query').hasClass('active') && $('#query').val().trim() != '') {
+            $.ajax({
+                type: 'post',
+                url: 'search',
+                data: { 'query': $('#query').val() }
+            })
+        } else {
+            e.preventDefault();
+            $('#search_button').removeClass('btn-inactive');
+            $('#query').clearQueue().val('').animate({ right: '0', width: '200px' }).addClass('active').focus();
+        }
+    })
+    $('#query').on('blur', function (e) {
+        if ($(this).val().trim() == '') {
+            $(this).delay(200).animate({ right: '-200px', width: '0' }, function () {
+                $('#search_button').addClass('btn-inactive');
+            }).removeClass('active');
+        }
+    });
+</script>
 ${next.javascriptIncludes()}
 </body>
 </html>

data/interfaces/default/css/plexpy.css

@@ -33,6 +33,33 @@ select.input-sm {
     color: #999;
     outline: none;
 }
+select[multiple] {
+    height: 125px;
+    margin: 5px 0 5px 0;
+    color: #fff;
+    border: 0px solid #444;
+    background: #555;
+    padding: 2px 2px;
+    background-color: #555;
+    border-radius: 3px;
+    transition: background-color .3s;
+}
+select[multiple]:focus {
+    outline: 0;
+    outline: thin dotted \9;
+    color: #555;
+    background-color: #fff;
+    transition: background-color .3s;
+}
+select[multiple]:focus::-webkit-scrollbar-thumb {
+    background-color: rgba(0,0,0,.15);
+}
+select[multiple] option {
+    padding: 6px 10px;
+    -webkit-border-radius: 2px;
+    -moz-border-radius: 2px;
+    border-radius: 2px;
+}
 img {
     -webkit-box-sizing: content-box;
     -moz-box-sizing: content-box;
@@ -314,6 +341,24 @@ input[type="color"],
     border-radius: 3px;
     transition: background-color .3s;
 }
+textarea.form-control {
+    height: initial;
+    margin: 5px 0 5px 0;
+    color: #fff;
+    border: 0px solid #444;
+    background: #555;
+    padding: 6px 12px;
+    background-color: #555;
+    border-radius: 3px;
+    transition: background-color .3s;
+    resize: none;
+}
+textarea.form-control:focus {
+    outline: 0;
+    color: #555;
+    background-color: #fff;
+    transition: background-color .3s;
+}
 .pagination > li > a,
 .pagination > li > span {
     position: relative;
@@ -442,7 +487,8 @@ input[type="color"],
 .users-poster-face {
     overflow: hidden;
     float: left;
-    background-size: contain;
+    background-size: cover;
+    background-position: center;
     height: 40px;
     width: 40px;
     -webkit-border-radius: 50%;
@@ -661,6 +707,14 @@ a:hover .dashboard-activity-poster {
     white-space: nowrap;
     width: 150px;
 }
+.dashboard-activity-poster-info-ip-address {
+    position: absolute;
+    bottom: 5px;
+    left: 10px;
+    text-align: left;
+    font-size: 12px;
+    color: #eee;
+}
 .dashboard-activity-poster-info-time {
     position: absolute;
     bottom: 5px;
@@ -684,14 +738,20 @@ a:hover .dashboard-activity-poster {
     transition: all 0s;
 }
 .dashboard-activity-progress .bufferbar {
-    padding-top: 6px;
+    padding-right: 3px;
+    font-size: x-small;
+    text-align: right;
+    color: rgba(255, 255, 255, 0);
     background-color: #444;
     position: absolute;
     height: 6px;
     overflow: hidden;
 }
 .dashboard-activity-progress .bar {
-    padding-top: 6px;
+    padding-right: 3px;
+    font-size: x-small;
+    text-align: right;
+    color: rgba(255, 255, 255, 0);
     background-color: #faa732;
     background-image: -moz-linear-gradient(top, #fbb450, #f89406);
     background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#fbb450), to(#f89406));
@@ -704,6 +764,37 @@ a:hover .dashboard-activity-poster {
     height: 6px;
     overflow: hidden;
 }
+.dashboard-instance.hover .dashboard-activity-progress-bar { 
+	height: 14px; 
+	transform-origin: top;
+    transition: all .2s ease;
+	border-radius: 0px 0px 3px 3px;
+}
+.dashboard-instance.hover .bar { 
+	height: 14px; 
+	transform-origin: top;
+    transition: all .2s ease;
+	border-radius: 0px 0px 3px 3px;
+    color: rgba(255, 255, 255, 1);
+    background-image: -webkit-linear-gradient(left,rgba(0,0,0,0.25),0%,rgba(0,0,0,0),50px);
+    background-image: -moz-linear-gradient(left,rgba(0,0,0,0.25) 0%,rgba(0,0,0,0) 50px);
+    background-image: linear-gradient(to left,rgba(0,0,0,0.25) 0%,rgba(0,0,0,0) 50px);
+}
+.dashboard-instance.hover .bufferbar { 
+	height: 14px; 
+	transform-origin: top;
+    transition: all .2s ease;
+	border-radius: 0px 0px 3px 3px;
+    color: rgba(255, 255, 255, 1);
+    background-image: -webkit-linear-gradient(left,rgba(0,0,0,0.25),0%,rgba(0,0,0,0),50px);
+    background-image: -moz-linear-gradient(left,rgba(0,0,0,0.25) 0%,rgba(0,0,0,0) 50px);
+    background-image: linear-gradient(to left,rgba(0,0,0,0.25) 0%,rgba(0,0,0,0) 50px);
+}
+.dashboard-instance.hover .dashboard-activity-metadata-wrapper { 
+	margin-top: 11px;
+	transform-origin: top;
+    transition: all .2s ease;
+}
 .dashboard-activity-metadata-wrapper {
     position: relative;
     width: 100%;
@@ -934,14 +1025,24 @@ a:hover .dashboard-recent-media-cover {
     white-space: nowrap;
     overflow: hidden;
 }
-.summary-navbar-list span {
-    display: inline-block;
-    margin-right: 15px;
+.summary-navbar-list .breadcrumb {
+    padding: 0;
+    margin: 0;
+    background: none;
 }
-.summary-navbar-list span a {
+.summary-navbar-list .breadcrumb > li + li:before {
+    color: #444;
+    font-family: FontAwesome;
+    content: "\f054";
+    padding: 0 15px;
+}
+.summary-navbar-list .breadcrumb > .active {
+    color: #eee;
+}
+.summary-navbar-list .breadcrumb a {
     color: #999;
 }
-.summary-navbar-list span a:hover {
+.summary-navbar-list .breadcrumb a:hover {
     color: #F9AA03;
 }
 .summary-content-title-wrapper {
@@ -1074,7 +1175,7 @@ a:hover .dashboard-recent-media-cover {
     display: block;
     width: 100%;
     height: 100%;
-    background-image: url(../images/plex-logo-light.svg);
+    background-image: url(../images/plex-logo-light-small.png);
     background-size: 100px;
     background-repeat: no-repeat;
     background-position: center;
@@ -1219,11 +1320,39 @@ a:hover .summary-poster-face-track .summary-poster-face-overlay span {
     background-size: contain;
     height: 16px;
 }
+#children-list, #search-results-list {
+    position: relative;
+    z-index: 0;
+}
 .item-children-wrapper {
 }
+.item-children-section-title {
+    position: relative;
+    padding: 10px;
+    background-color: #2c2c2c;
+    border-bottom: 1px solid #3d3d3d;
+    border-top: 1px solid #282828;
+    height: 50px;
+    line-height: 22px;
+    padding: 13px 20px;
+    margin: 20px 0;
+}
+.item-children-section-title h4 {
+    position: relative;
+    margin: 0;
+    line-height: 22px;
+    color: #fff;
+    font-size: 16px;
+    text-align: center;
+    text-transform: uppercase;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+}
 .item-children-instance {
     list-style: none;
     margin: 0;
+    overflow: hidden;
 }
 .item-children-instance li {
     float: left;
@@ -1321,6 +1450,9 @@ a:hover .item-children-poster {
     text-align: left;
     clear: both;
 }
+.item-children-instance-text-wrapper h3.text-muted {
+    color: #777;
+}
 .item-children-list-item-odd {
     border-top: 0px solid #343434;
     border-bottom: 0px solid #343434;
@@ -1364,6 +1496,13 @@ a:hover .item-children-poster {
     width: 40px;
     margin-right: 20px;
 }
+#new_title h3 {
+    color: #F9AA03;
+    font-size: 14px;
+    line-height: 1.42857143;
+    font-weight: bold;
+    margin: 0;
+}
 .settings-alert {
     float: left;
     padding: 0;
@@ -1399,7 +1538,8 @@ a:hover .item-children-poster {
     float: left;
     margin-top: 15px;
     margin-right: 15px;
-    background-size: contain;
+    background-size: cover;
+    background-position: center;
     height: 80px;
     width: 80px;
     -webkit-border-radius: 50%;
@@ -1443,7 +1583,7 @@ a:hover .item-children-poster {
 }
 .user-overview-stats-instance {
     float: left;
-    width: 350px;
+    width: 400px;
     height: 80px;
     margin-bottom: 25px;
 }
@@ -1456,7 +1596,7 @@ a:hover .item-children-poster {
 .user-overview-stats-instance li {
     float: left;
     list-style: none;
-    width: 340px;
+    width: 100%;
     height: 90px;
 }
 .user-overview-stats-instance-text {
@@ -1500,19 +1640,19 @@ a:hover .item-children-poster {
     top: 3px;
     left: 3px;
 }
-.user-platforms ul {
+.user-player ul {
     list-style: none;
     margin: 0;
 }
-.user-platforms-instance {
+.user-player-instance {
     float: left;
     width: 240px;
     height: 80px;
     margin-bottom: 25px;
 }
-.user-platforms-instance li {
+.user-player-instance li {
 }
-.user-platforms-instance-box {
+.user-player-instance-box {
     float: left;
     width: 75px;
     border-radius: 3px;
@@ -1524,7 +1664,7 @@ a:hover .item-children-poster {
     height: 80px;
     width: 80px;
 }
-.user-platforms-instance-name {
+.user-player-instance-name {
     float: left;
     padding-top: 14px;
     color: #fff;
@@ -1537,7 +1677,7 @@ a:hover .item-children-poster {
     width: 140px;
     margin-left: 10px;
 }
-.user-platforms-instance-playcount h3 {
+.user-player-instance-playcount h3 {
     font-size: 30px;
     font-weight: bold;
     color: #F9AA03;
@@ -1547,7 +1687,7 @@ a:hover .item-children-poster {
     margin: 0 5px 0 10px;
     float: left;
 }
-.user-platforms-instance-playcount p {
+.user-player-instance-playcount p {
     color: #aaa;
     font-size: 12px;
     float: left;
@@ -2273,7 +2413,8 @@ a .home-platforms-instance-list-oval:hover,
     top: 5px;
     left: 12px;
 }
-#users-to-delete > li {
+#users-to-delete > li,
+#users-to-purge > li {
     color: #e9a049;
 }
 #updatebar {
@@ -2350,4 +2491,106 @@ a .home-platforms-instance-list-oval:hover,
     .dashboard-instance {
         width: 100%;
     }
-}
+}
+table.display tr.shown + tr div.slider {
+    display: none;
+}
+table.display tr.shown + tr > td {
+    padding-top: 0;
+    padding-bottom: 0;
+}
+table.display tr.shown + tr:hover {
+    background-color: rgba(255,255,255,0);
+}
+table.display tr.shown + tr:hover a,
+table.display tr.shown + tr td:hover a,
+table.display tr.shown + tr .pagination > .active > a,
+table.display tr.shown + tr .pagination > .active > a:hover {
+    color: #fff;
+}
+table.display tr.shown + tr table[id^='history_child'] td:hover a {
+    color: #F9AA03;
+}
+table.display tr.shown + tr .pagination > .disabled > a {
+    color: #444444;
+}
+table.display tr.shown + tr .pagination > li > a:hover {
+    color: #23527c;
+}
+table[id^='history_child'] {
+    margin-top: 0;
+    margin-left: -4px;
+    opacity: .6;
+}
+table[id^='history_child'] thead th {
+    line-height: 0;
+    height: 0 !important;
+    overflow: hidden;
+}
+#search_form {
+    width: 300px;
+    padding: 8px 15px;
+}
+#search_form span.input-textbox {
+    overflow: hidden;
+    width: 200px;
+    height: 34px;
+    display: inline-flex;
+    float: right;
+}
+#search_form #query {
+    width: 0;
+    height: 34px;
+    margin-top: 0;
+    float: right;
+    position: relative;
+    right: -200px;
+    border-radius: 3px 0 0 3px;
+}
+#search_form #query.active {
+    width: 200px;
+    right: 0px;
+}
+#search_form #search_button.btn-inactive {
+    background-color: #000;
+    border: 1px solid rgba(0,0,0,0);
+    -webkit-transition: background 0.3s;
+    -moz-transition: background 0.3s;
+    -ms-transition: background 0.3s;
+    -o-transition: background 0.3s;
+    transition: background 0.3s;
+}
+
+.notification-params {
+    margin-top: 10px;
+    background-color: #282828;
+}
+.notification-params th {
+    padding-left: 10px;
+    height: 30px;
+}
+.notification-params td {
+    height: 25px;
+}
+.notification-params td:first-child {
+    padding-left: 10px;
+    width: 200px;
+}
+.notification-params td:not(:first-child) {
+    padding-right: 10px;
+}
+.notification-params tr:nth-child(odd) td {
+    background-color: rgba(255,255,255,0.035);
+}
+.notification-params tr:nth-child(even) td {
+    background-color: rgba(255,255,255,0.010);
+}
+
+#days-selection label {
+    margin-bottom: 0;
+}
+#graph-days {
+    margin: 0;
+    width: 75px;
+    height: 34px;
+}

data/interfaces/default/css/selectize.bootstrap3.css

@@ -0,0 +1,401 @@
+/**
+ * selectize.bootstrap3.css (v0.12.1) - Bootstrap 3 Theme
+ * Copyright (c) 2013–2015 Brian Reavis & contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
+ * file except in compliance with the License. You may obtain a copy of the License at:
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+ * ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ *
+ * @author Brian Reavis <brian@thirdroute.com>
+ */
+.selectize-control.plugin-drag_drop.multi > .selectize-input > div.ui-sortable-placeholder {
+  visibility: visible !important;
+  background: #f2f2f2 !important;
+  background: rgba(0, 0, 0, 0.06) !important;
+  border: 0 none !important;
+  -webkit-box-shadow: inset 0 0 12px 4px #ffffff;
+  box-shadow: inset 0 0 12px 4px #ffffff;
+}
+.selectize-control.plugin-drag_drop .ui-sortable-placeholder::after {
+  content: '!';
+  visibility: hidden;
+}
+.selectize-control.plugin-drag_drop .ui-sortable-helper {
+  -webkit-box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
+  box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
+}
+.selectize-dropdown-header {
+  position: relative;
+  padding: 3px 12px;
+  border-bottom: 1px solid #d0d0d0;
+  background: #f8f8f8;
+  -webkit-border-radius: 4px 4px 0 0;
+  -moz-border-radius: 4px 4px 0 0;
+  border-radius: 4px 4px 0 0;
+}
+.selectize-dropdown-header-close {
+  position: absolute;
+  right: 12px;
+  top: 50%;
+  color: #333333;
+  opacity: 0.4;
+  margin-top: -12px;
+  line-height: 20px;
+  font-size: 20px !important;
+}
+.selectize-dropdown-header-close:hover {
+  color: #000000;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup {
+  border-right: 1px solid #f2f2f2;
+  border-top: 0 none;
+  float: left;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup:last-child {
+  border-right: 0 none;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup:before {
+  display: none;
+}
+.selectize-dropdown.plugin-optgroup_columns .optgroup-header {
+  border-top: 0 none;
+}
+.selectize-control.plugin-remove_button [data-value] {
+  position: relative;
+  padding-right: 24px !important;
+}
+.selectize-control.plugin-remove_button [data-value] .remove {
+  z-index: 1;
+  /* fixes ie bug (see #392) */
+  position: absolute;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  width: 17px;
+  text-align: center;
+  font-weight: bold;
+  font-size: 12px;
+  color: inherit;
+  text-decoration: none;
+  vertical-align: middle;
+  display: inline-block;
+  padding: 1px 0 0 0;
+  border-left: 1px solid rgba(0, 0, 0, 0);
+  -webkit-border-radius: 0 2px 2px 0;
+  -moz-border-radius: 0 2px 2px 0;
+  border-radius: 0 2px 2px 0;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+.selectize-control.plugin-remove_button [data-value] .remove:hover {
+  background: rgba(0, 0, 0, 0.05);
+}
+.selectize-control.plugin-remove_button [data-value].active .remove {
+  border-left-color: rgba(0, 0, 0, 0);
+}
+.selectize-control.plugin-remove_button .disabled [data-value] .remove:hover {
+  background: none;
+}
+.selectize-control.plugin-remove_button .disabled [data-value] .remove {
+  border-left-color: rgba(77, 77, 77, 0);
+}
+.selectize-control {
+  position: relative;
+}
+.selectize-dropdown,
+.selectize-input,
+.selectize-input input {
+  color: #333333;
+  font-family: inherit;
+  font-size: inherit;
+  line-height: 20px;
+  -webkit-font-smoothing: inherit;
+}
+.selectize-input,
+.selectize-control.single .selectize-input.input-active {
+  background: #ffffff;
+  cursor: text;
+  display: inline-block;
+}
+.selectize-input {
+  border: 1px solid #cccccc;
+  padding: 6px 12px;
+  display: inline-block;
+  width: 100%;
+  overflow: hidden;
+  position: relative;
+  z-index: 1;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  -webkit-box-shadow: none;
+  box-shadow: none;
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+}
+.selectize-control.multi .selectize-input.has-items {
+  padding: 5px 12px 2px;
+}
+.selectize-input.full {
+  background-color: #ffffff;
+}
+.selectize-input.disabled,
+.selectize-input.disabled * {
+  cursor: default !important;
+}
+.selectize-input.focus {
+  -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.15);
+  box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.15);
+}
+.selectize-input.dropdown-active {
+  -webkit-border-radius: 4px 4px 0 0;
+  -moz-border-radius: 4px 4px 0 0;
+  border-radius: 4px 4px 0 0;
+}
+.selectize-input > * {
+  vertical-align: baseline;
+  display: -moz-inline-stack;
+  display: inline-block;
+  zoom: 1;
+  *display: inline;
+}
+.selectize-control.multi .selectize-input > div {
+  cursor: pointer;
+  margin: 0 3px 3px 0;
+  padding: 1px 3px;
+  background: #efefef;
+  color: #333333;
+  border: 0 solid rgba(0, 0, 0, 0);
+}
+.selectize-control.multi .selectize-input > div.active {
+  background: #428bca;
+  color: #ffffff;
+  border: 0 solid rgba(0, 0, 0, 0);
+}
+.selectize-control.multi .selectize-input.disabled > div,
+.selectize-control.multi .selectize-input.disabled > div.active {
+  color: #808080;
+  background: #ffffff;
+  border: 0 solid rgba(77, 77, 77, 0);
+}
+.selectize-input > input {
+  display: inline-block !important;
+  padding: 0 !important;
+  min-height: 0 !important;
+  max-height: none !important;
+  max-width: 100% !important;
+  margin: 0 !important;
+  text-indent: 0 !important;
+  border: 0 none !important;
+  background: none !important;
+  line-height: inherit !important;
+  -webkit-user-select: auto !important;
+  -webkit-box-shadow: none !important;
+  box-shadow: none !important;
+}
+.selectize-input > input::-ms-clear {
+  display: none;
+}
+.selectize-input > input:focus {
+  outline: none !important;
+}
+.selectize-input::after {
+  content: ' ';
+  display: block;
+  clear: left;
+}
+.selectize-input.dropdown-active::before {
+  content: ' ';
+  display: block;
+  position: absolute;
+  background: #ffffff;
+  height: 1px;
+  bottom: 0;
+  left: 0;
+  right: 0;
+}
+.selectize-dropdown {
+  position: absolute;
+  z-index: 10;
+  border: 1px solid #d0d0d0;
+  background: #ffffff;
+  margin: -1px 0 0 0;
+  border-top: 0 none;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+  -webkit-border-radius: 0 0 4px 4px;
+  -moz-border-radius: 0 0 4px 4px;
+  border-radius: 0 0 4px 4px;
+}
+.selectize-dropdown [data-selectable] {
+  cursor: pointer;
+  overflow: hidden;
+}
+.selectize-dropdown [data-selectable] .highlight {
+  background: rgba(255, 237, 40, 0.4);
+  -webkit-border-radius: 1px;
+  -moz-border-radius: 1px;
+  border-radius: 1px;
+}
+.selectize-dropdown [data-selectable],
+.selectize-dropdown .optgroup-header {
+  padding: 3px 12px;
+}
+.selectize-dropdown .optgroup:first-child .optgroup-header {
+  border-top: 0 none;
+}
+.selectize-dropdown .optgroup-header {
+  color: #777777;
+  background: #ffffff;
+  cursor: default;
+}
+.selectize-dropdown .active {
+  background-color: #f5f5f5;
+  color: #262626;
+}
+.selectize-dropdown .active.create {
+  color: #262626;
+}
+.selectize-dropdown .create {
+  color: rgba(51, 51, 51, 0.5);
+}
+.selectize-dropdown-content {
+  overflow-y: auto;
+  overflow-x: hidden;
+  max-height: 200px;
+}
+.selectize-control.single .selectize-input,
+.selectize-control.single .selectize-input input {
+  cursor: pointer;
+}
+.selectize-control.single .selectize-input.input-active,
+.selectize-control.single .selectize-input.input-active input {
+  cursor: text;
+}
+.selectize-control.single .selectize-input:after {
+  content: ' ';
+  display: block;
+  position: absolute;
+  top: 50%;
+  right: 17px;
+  margin-top: -3px;
+  width: 0;
+  height: 0;
+  border-style: solid;
+  border-width: 5px 5px 0 5px;
+  border-color: #333333 transparent transparent transparent;
+}
+.selectize-control.single .selectize-input.dropdown-active:after {
+  margin-top: -4px;
+  border-width: 0 5px 5px 5px;
+  border-color: transparent transparent #333333 transparent;
+}
+.selectize-control.rtl.single .selectize-input:after {
+  left: 17px;
+  right: auto;
+}
+.selectize-control.rtl .selectize-input > input {
+  margin: 0 4px 0 -2px !important;
+}
+.selectize-control .selectize-input.disabled {
+  opacity: 0.5;
+  background-color: #ffffff;
+}
+.selectize-dropdown,
+.selectize-dropdown.form-control {
+  height: auto;
+  padding: 0;
+  margin: 2px 0 0 0;
+  z-index: 1000;
+  background: #ffffff;
+  border: 1px solid #cccccc;
+  border: 1px solid rgba(0, 0, 0, 0.15);
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+  -webkit-box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175);
+  box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175);
+}
+.selectize-dropdown .optgroup-header {
+  font-size: 12px;
+  line-height: 1.42857143;
+}
+.selectize-dropdown .optgroup:first-child:before {
+  display: none;
+}
+.selectize-dropdown .optgroup:before {
+  content: ' ';
+  display: block;
+  height: 1px;
+  margin: 9px 0;
+  overflow: hidden;
+  background-color: #e5e5e5;
+  margin-left: -12px;
+  margin-right: -12px;
+}
+.selectize-dropdown-content {
+  padding: 5px 0;
+}
+.selectize-dropdown-header {
+  padding: 6px 12px;
+}
+.selectize-input {
+  min-height: 34px;
+}
+.selectize-input.dropdown-active {
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+}
+.selectize-input.dropdown-active::before {
+  display: none;
+}
+.selectize-input.focus {
+  border-color: #66afe9;
+  outline: 0;
+  -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+  box-shadow: inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);
+}
+.has-error .selectize-input {
+  border-color: #a94442;
+  -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
+}
+.has-error .selectize-input:focus {
+  border-color: #843534;
+  -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #ce8483;
+  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #ce8483;
+}
+.selectize-control.multi .selectize-input.has-items {
+  padding-left: 9px;
+  padding-right: 9px;
+}
+.selectize-control.multi .selectize-input > div {
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+}
+.form-control.selectize-control {
+  padding: 0;
+  height: auto;
+  border: none;
+  background: none;
+  -webkit-box-shadow: none;
+  box-shadow: none;
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  border-radius: 0;
+}

data/interfaces/default/current_activity.html

@@ -19,7 +19,7 @@ session_key                 Returns a unique session id for the active stream
 rating_key                  Returns the unique identifier for the media item.
 media_index                 Returns the index of the media item.
 parent_media_index          Returns the index of the media item's parent.
-type                        Returns the type of session. Either 'track', 'episode' or 'movie'.
+media_type                  Returns the type of session. Either 'track', 'episode' or 'movie'.
 thumb                       Returns the location of the item's thumbnail. Use with pms_image_proxy.
 bif_thumb                   Returns the location of the item's bif thumbnail. Use with pms_image_proxy.
 art                         Returns the location of the item's artwork
@@ -32,6 +32,7 @@ user_thumb                  Returns the profile picture of the user owning the s
 state                       Returns the state of the current session. Either 'playing', 'paused' or 'buffering'.
 title                       Returns the name of the episode, movie or music track.
 year                        Returns the year of the episode, movie, or clip.
+ip_address                  Returns the ip address of the stream.
 player                      Returns the name of the platform used to play the stream.
 platform                    Returns the type of platform used to play the stream.
 throttled                   Returns true if the transcode session is throttled.
@@ -67,21 +68,21 @@ DOCUMENTATION :: END
 % if data['stream_count'] != '0':
 % for a in data['sessions']:
 <div class="dashboard-instance" id="instance-${a['session_key']}">
-    % if a['type'] == 'movie' or a['type'] == 'episode' or a['type'] == 'track':
+    % if a['media_type'] == 'movie' or a['media_type'] == 'episode' or a['media_type'] == 'track':
     <a href="info?item_id=${a['rating_key']}">
     % endif
         <div class="dashboard-activity-poster">
-            % if a['type'] == 'movie' and not a['indexes']:
+            % if a['media_type'] == 'movie' and not a['indexes']:
             <div class="dashboard-activity-poster-face" style="background-image: url(pms_image_proxy?img=${a['art']}&width=500&height=280);"></div>
-            % elif a['type'] == 'episode' and not a['indexes']:
+            % elif a['media_type'] == 'episode' and not a['indexes']:
             <div class="dashboard-activity-poster-face" style="background-image: url(pms_image_proxy?img=${a['art']}&width=500&height=280);"></div>
             % elif a['indexes']:
             <div class="dashboard-activity-poster-face bif" style="background-image: url(pms_image_proxy?img=${a['bif_thumb']}&width=500&height=280); display: none;"></div>
             % else:
-                % if a['type'] == 'track':
+                % if a['media_type'] == 'track':
                 <div class="dashboard-activity-cover-face-bg" style="background-image: url(pms_image_proxy?img=${a['thumb']}&width=300&height=300);"></div>
                 <div class="dashboard-activity-cover-face" style="background-image: url(pms_image_proxy?img=${a['thumb']}&width=300&height=300);"></div>
-                % elif a['type'] == 'clip':
+                % elif a['media_type'] == 'clip':
                     % if a['art'][:4] == 'http':
                     <div class="dashboard-activity-poster-face" style="background-image: url(${a['art']});"></div>
                     % elif a['thumb'][:4] == 'http':
@@ -93,7 +94,7 @@ DOCUMENTATION :: END
                         <div class="dashboard-activity-poster-face" style="background-image: url(pms_image_proxy?img=${a['thumb']}&width=500&height=280);"></div>
                         % endif
                     % endif
-                % elif a['type'] == 'photo':
+                % elif a['media_type'] == 'photo':
                 <div class="dashboard-activity-poster-face bif" style="background-image: url(pms_image_proxy?img=${a['thumb']}&width=500&height=500);"></div>
                 % else:
                 <div class="dashboard-activity-cover-face" style="background-image: url(pms_image_proxy?img=${a['thumb']}&width=300&height=300&fallback=cover);"></div>
@@ -106,7 +107,12 @@ DOCUMENTATION :: END
             </div>
             <div id="stream-${a['session_key']}" class="dashboard-activity-info-details-overlay">
                 <div class="dashboard-activity-info-details-content">
-                    <div class="dashboard-activity-info-platform" id="platform-${a['session_key']}">
+                    <div id="platform-${a['session_key']}" title="${a['platform']}">
+                        <script>
+                            $("#platform-${a['session_key']}").html("<div class='dashboard-activity-info-platform-box' style='background-image: url(" + getPlatformImagePath('${a['platform']}') + ");'>");
+                        </script>
+                    </div>
+                    <div class="dashboard-activity-info-platform">
                         <strong>${a['player']}</strong><br />
                         % if a['state'] == 'playing':
                         State &nbsp;<strong>Playing</strong>
@@ -116,9 +122,11 @@ DOCUMENTATION :: END
                         State &nbsp;<strong>Buffering</strong>
                         % endif
                     </div>
-                    % if a['type'] == 'track':
+                    % if a['media_type'] == 'track':
                         % if a['audio_decision'] == 'direct play':
                         Stream &nbsp;<strong>Direct Play</strong>
+                        % elif a['audio_decision'] == 'copy':
+                        Stream &nbsp;<strong>Direct Stream</strong>
                         % else:
                         Stream &nbsp;<strong>Transcoding
                             (Speed: ${a['transcode_speed']})
@@ -130,14 +138,16 @@ DOCUMENTATION :: END
                         <br />
                         % if a['audio_decision'] == 'direct play':
                         Audio &nbsp;<strong>Direct Play (${a['audio_codec']}) (${a['audio_channels']}ch)</strong>
-                        % elif a['audio_decision'] == 'Copy':
+                        % elif a['audio_decision'] == 'copy':
                         Audio &nbsp;<strong>Direct Stream (${a['transcode_audio_codec']}) (${a['transcode_audio_channels']}ch)</strong>
-                        % elif a['audio_decision'] != 'transcode':
+                        % elif a['audio_decision'] == 'transcode':
                         Audio &nbsp;<strong>Transcode (${a['transcode_audio_codec']}) (${a['transcode_audio_channels']}ch)</strong>
                         % endif
-                    % elif a['type'] == 'episode' or a['type'] == 'movie' or a['type'] == 'clip':
-                        % if a['video_decision'] == 'direct play':
+                    % elif a['media_type'] == 'episode' or a['media_type'] == 'movie' or a['media_type'] == 'clip':
+                        % if a['video_decision'] == 'direct play' and a['audio_decision'] == 'direct play':
                         Stream &nbsp;<strong>Direct Play</strong>
+                        % elif a['video_decision'] == 'copy' and a['audio_decision'] == 'copy':
+                        Stream &nbsp;<strong>Direct Stream</strong>
                         % else:
                         Stream &nbsp;<strong>Transcoding
                             (Speed: ${a['transcode_speed']})
@@ -162,9 +172,11 @@ DOCUMENTATION :: END
                         % elif a['audio_decision'] == 'transcode':
                         Audio &nbsp;<strong>Transcode (${a['transcode_audio_codec']}) (${a['transcode_audio_channels']}ch)</strong>
                         % endif
-                    % elif a['type'] == 'photo':
+                    % elif a['media_type'] == 'photo':
                         % if a['video_decision'] == 'direct play':
                         Stream &nbsp;<strong>Direct Play</strong>
+                        % elif a['video_decision'] == 'copy':
+                        Stream &nbsp;<strong>Direct Stream</strong>
                         % else:
                         Stream &nbsp;<strong>
                             Transcoding
@@ -178,15 +190,22 @@ DOCUMENTATION :: END
                     <br>
                 </div>
             </div>
-            % if a['type'] != 'photo':
+            % if a['media_type'] != 'photo':
             <div class="dashboard-activity-poster-info-bar">
+                <div class="dashboard-activity-poster-info-ip-address">
+                    % if a['ip_address']:
+                    <span>IP: ${a['ip_address']}</span>
+                    % else:
+                    <span>IP: N/A</span>
+                    % endif
+                </div>
                 <div class="dashboard-activity-poster-info-time">
-                    <span class="progress_time">${a['progress']}</span>/<span class="progress_time">${a['duration']}</span>
+                    <span class="progress_time">${a['view_offset']}</span>/<span class="progress_time">${a['duration']}</span>
                 </div>
             </div>
             % endif
         </div>
-    % if a['type'] == 'movie' or a['type'] == 'episode' or a['type'] == 'track':
+    % if a['media_type'] == 'movie' or a['media_type'] == 'episode' or a['media_type'] == 'track':
     </a>
     % endif
     <div class="dashboard-activity-progress">
@@ -207,45 +226,42 @@ DOCUMENTATION :: END
             % elif a['state'] == 'buffering':
             <i class="fa fa-spinner"></i>&nbsp;
             % endif
-            % if a['type'] == 'episode':
-            <a href="info?item_id=${a['rating_key']}">${a['grandparent_title']} - ${a['title']}</a>
-            % elif a['type'] == 'movie':
-            <a href="info?item_id=${a['rating_key']}">${a['title']}</a>
-            % elif a['type'] == 'clip':
-            ${a['title']}
-            % elif a['type'] == 'track':
-            <a href="info?item_id=${a['rating_key']}">${a['grandparent_title']} - ${a['title']}</a>
-            % elif a['type'] == 'photo':
-            ${a['parent_title']}
+            % if a['media_type'] == 'episode':
+            <a href="info?item_id=${a['rating_key']}" title="${a['grandparent_title']} - ${a['title']}">${a['grandparent_title']} - ${a['title']}</a>
+            % elif a['media_type'] == 'movie':
+            <a href="info?item_id=${a['rating_key']}" title="${a['title']}">${a['title']}</a>
+            % elif a['media_type'] == 'clip':
+            <span title="${a['title']}">${a['title']}</span>
+            % elif a['media_type'] == 'track':
+            <a href="info?item_id=${a['rating_key']}" title="${a['grandparent_title']} - ${a['title']}">${a['grandparent_title']} - ${a['title']}</a>
+            % elif a['media_type'] == 'photo':
+            <span title="${a['parent_title']}">${a['parent_title']}</span>
             % else:
-            ${a['title']}
+            <span title="${a['title']}">${a['title']}</span>
             % endif
         </div>
         <div class="dashboard-activity-metadata-subtitle">
-            % if a['type'] == 'episode':
-            S${a['parent_media_index']} &middot; E${a['media_index']}
-            % elif a['type'] == 'movie':
-            ${a['year']}
-            % elif a['type'] == 'track':
-            <a href="info?item_id=${a['parent_rating_key']}">${a['parent_title']}</a>
-            % elif a['type'] == 'photo':
-            ${a['title']}
+            % if a['media_type'] == 'episode':
+            <span title="S${a['parent_media_index']} &middot; E${a['media_index']}">S${a['parent_media_index']} &middot; E${a['media_index']}</span>
+            % elif a['media_type'] == 'movie':
+            <span title="${a['year']}">${a['year']}</span>
+            % elif a['media_type'] == 'track':
+            <a href="info?item_id=${a['parent_rating_key']}" title="${a['parent_title']}">${a['parent_title']}</a>
+            % elif a['media_type'] == 'photo':
+            <span title="${a['title']}">${a['title']}</span>
             % else:
-            ${a['year']}
+            <span title="${a['year']}">${a['year']}</span>
             % endif
         </div>
         <div class="dashboard-activity-metadata-user">
             % if a['user_id']:
-            <a href="user?user_id=${a['user_id']}">${a['friendly_name']}</a>
+            <a href="user?user_id=${a['user_id']}" title="${a['friendly_name']}">${a['friendly_name']}</a>
             % else:
-            <a href="user?user=${a['user']}">${a['friendly_name']}</a>
+            <a href="user?user=${a['user']}" title="${a['friendly_name']}">${a['friendly_name']}</a>
             % endif
         </div>
 </div>
 </div>
-<script>
-    $("#platform-${a['session_key']}").prepend("<div class='dashboard-activity-info-platform-box' style='background-image: url(" + getPlatformImagePath('${a['platform']}') + ");'>");
-</script>
 
 % endfor
 <script>
@@ -264,6 +280,13 @@ DOCUMENTATION :: END
         e.preventDefault();
         $($(this).attr('data-target')).toggle();
     });
+
+    // Add hover class to dashboard-instance
+    $('.dashboard-activity-poster').hover(function() {
+        $(this).closest('.dashboard-instance').addClass('hover');
+    }, function() {
+        $(this).closest('.dashboard-instance').removeClass('hover');
+    });
 </script>
 % else:
 <div class="text-muted">Nothing is currently being watched.</div><br>

data/interfaces/default/current_activity_header.html

@@ -15,11 +15,13 @@ DOCUMENTATION :: END
 </%doc>
 
 % if data != None:
-% if data == '0':
-<h3>Activity</h3>
+	% if data == '0':
+	<h3>Activity</h3>
+	% elif data == '1':
+	<h3>Activity <small>${data} stream</small></h3>
+	% else:
+	<h3>Activity <small>${data} streams</small></h3>
+	% endif
 % else:
-<h3>Activity <small>${data} stream(s)</small></h3>
+<h3>Activity</h3>
 % endif
-% else:
-<h3>Activity</h3>
-% endif

data/interfaces/default/edit_user.html

@@ -115,7 +115,7 @@ DOCUMENTATION :: END
                 success: function(data) {
                     $("#edit-user-status-message").html(data);
                     if ($.trim(friendly_name) !== '') {
-                        $(".set-username").html(friendly_name);
+                        $('.set-username').html(document.createTextNode(friendly_name));
                     }
                     $("#user-profile-thumb").attr('src', thumb);
                 }

data/interfaces/default/graphs.html

@@ -13,110 +13,132 @@
         </div>
         <div class="button-bar hidden-xs">
             <div class="btn-group" data-toggle="buttons" id="yaxis-selection">
+                % if config['graph_type'] == 'duration':
+                <label class="btn btn-dark">
+                    <input type="radio" name="yaxis-options" id="yaxis-count" value="plays" autocomplete="off"> Play Count
+                </label>
+                <label class="btn btn-dark active">
+                    <input type="radio" name="yaxis-options" id="yaxis-duration" value="duration" autocomplete="off" checked> Play Duration
+                </label>
+                % else:
                 <label class="btn btn-dark active">
                     <input type="radio" name="yaxis-options" id="yaxis-count" value="plays" autocomplete="off" checked> Play Count
                 </label>
                 <label class="btn btn-dark">
                     <input type="radio" name="yaxis-options" id="yaxis-duration" value="duration" autocomplete="off"> Play Duration
                 </label>
+                % endif
             </div>
-            <div class="btn-group" data-toggle="buttons" id="days-selection">
-                <label class="btn btn-dark">
-                    <input type="radio" name="date-options" id="graph-7" value="7" autocomplete="off"> 7 days
-                </label>
-                <label class="btn btn-dark active">
-                    <input type="radio" name="date-options" id="graph-30" value="30" autocomplete="off" checked> 30 days
-                </label>
-                <label class="btn btn-dark">
-                    <input type="radio" name="date-options" id="graph-90" value="90" autocomplete="off"> 90 days
-                </label>
-                <label class="btn btn-dark">
-                    <input type="radio" name="date-options" id="graph-365" value="365" autocomplete="off"> 1 year
+            <div class="btn-group" id="days-selection">
+                <label>
+                    <input type="number" name="graph-days" id="graph-days" value="${config['graph_days']}" min="1" /> days
                 </label>
             </div>
         </div>
     </div>
     <div class='table-card-back'>
         <ul class="nav nav-pills" role="tablist" id="graph-tabs">
+            % if config['graph_tab'] == 'tabs-3':
+            <li role="presentation"><a href="#tabs-1" aria-controls="tabs-1" data-toggle="tab" role="tab">Plays by period</a></li>
+            <li role="presentation"><a href="#tabs-2" aria-controls="tabs-2" data-toggle="tab" role="tab">Stream Info</a></li>
+            <li role="presentation" class="active"><a href="#tabs-3" aria-controls="tabs-3" data-toggle="tab" role="tab">Play Totals</a></li>
+            % elif config['graph_tab'] == 'tabs-2':
+            <li role="presentation"><a href="#tabs-1" aria-controls="tabs-1" data-toggle="tab" role="tab">Plays by period</a></li>
+            <li role="presentation" class="active"><a href="#tabs-2" aria-controls="tabs-2" data-toggle="tab" role="tab">Stream Info</a></li>
+            <li role="presentation"><a href="#tabs-3" aria-controls="tabs-3" data-toggle="tab" role="tab">Play Totals</a></li>
+            % else:
             <li role="presentation" class="active"><a href="#tabs-1" aria-controls="tabs-1" data-toggle="tab" role="tab">Plays by period</a></li>
             <li role="presentation"><a href="#tabs-2" aria-controls="tabs-2" data-toggle="tab" role="tab">Stream Info</a></li>
             <li role="presentation"><a href="#tabs-3" aria-controls="tabs-3" data-toggle="tab" role="tab">Play Totals</a></li>
+            % endif
         </ul>
         <div class="tab-content">
+            % if config['graph_tab'] != 'tabs-2' and config['graph_tab'] != 'tabs-3':
             <div role="tabpanel" class="tab-pane active" id="tabs-1">
-                <div class="row">
-                    <div class="col-md-12">
-                        <h4><i class="fa fa-history"></i> Daily <span class="yaxis-text">Play count</span> <small>Last <span class="days">30</span> days</small></h4>
-                        <p class="help-block">
-                            The total play count or duration of tv, movies, and music played per day. Click a graph point to open up a list of items played for that specific date.
-                        </p>
-                        <div class="graphs-instance">
-                            <div class="watch-chart" id="chart_div_plays_by_day">
-                                <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...</div>
-                                <br>
+            % else:
+            <div role="tabpanel" class="tab-pane" id="tabs-1">
+            % endif
+                    <div class="row">
+                        <div class="col-md-12">
+                            <h4><i class="fa fa-history"></i> Daily <span class="yaxis-text">Play count</span> <small>Last <span class="days">30</span> days</small></h4>
+                            <p class="help-block">
+                                The total play count or duration of tv, movies, and music played per day. Click a graph point to open up a list of items played for that specific date.
+                            </p>
+                            <div class="graphs-instance">
+                                <div class="watch-chart" id="chart_div_plays_by_day">
+                                    <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...</div>
+                                    <br>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                    <div class="row">
+                        <div class="col-md-6">
+                            <h4><i class="fa fa-calendar"></i> <span class="yaxis-text">Play count</span> by day of week <small>Last <span class="days">30</span> days</small></h4>
+                            <p class="help-block">
+                                The combined total of tv, movies, and music played per day of the week.
+                            </p>
+                            <div class="graphs-instance">
+                                <div class="watch-chart" id="chart_div_plays_by_dayofweek" style="float: left;">
+                                    <div class="graphs-load">
+                                        <i class="fa fa-refresh fa-spin"></i> Loading chart...
+                                    </div>
+                                    <br>
+                                </div>
+                            </div>
+                        </div>
+                        <div class="col-md-6">
+                            <h4><i class="fa fa-clock-o"></i> <span class="yaxis-text">Play count</span> by hour of day <small>Last <span class="days">30</span> days</small></h4>
+                            <p class="help-block">
+                                The combined total of tv, movies, and music played per hour of the day.
+                            </p>
+                            <div class="graphs-instance">
+                                <div class="watch-chart" id="chart_div_plays_by_hourofday">
+                                    <div class="graphs-load">
+                                        <i class="fa fa-refresh fa-spin"></i> Loading chart...
+                                    </div>
+                                    <br>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                    <div class="row">
+                        <div class="col-md-6">
+                            <h4><i class="fa fa-television"></i> <span class="yaxis-text">Play count</span> by top 10 platforms <small>Last <span class="days">30</span> days</small></h4>
+                            <p class="help-block">
+                                The combined total of tv, movies, and music played by top 10 most active platforms.
+                            </p>
+                            <div class="graphs-instance">
+                                <div class="watch-chart" id="chart_div_plays_by_platform" style="float: left;">
+                                    <div class="graphs-load">
+                                        <i class="fa fa-refresh fa-spin"></i> Loading chart...
+                                    </div>
+                                    <br>
+                                </div>
+                            </div>
+                        </div>
+                        <div class="col-md-6">
+                            <h4><i class="fa fa-user"></i> <span class="yaxis-text">Play count</span> by top 10 users <small>Last <span class="days">30</span> days</small></h4>
+                            <p class="help-block">
+                                The combined total of tv, movies, and music played by top 10 most active users.
+                            </p>
+                            <div class="graphs-instance">
+                                <div class="watch-chart" id="chart_div_plays_by_user">
+                                    <div class="graphs-load">
+                                        <i class="fa fa-refresh fa-spin"></i> Loading chart...
+                                    </div>
+                                    <br>
+                                </div>
                             </div>
                         </div>
                     </div>
                 </div>
-                <div class="row">
-                    <div class="col-md-6">
-                        <h4><i class="fa fa-calendar"></i> <span class="yaxis-text">Play count</span> by day of week <small>Last <span class="days">30</span> days</small></h4>
-                        <p class="help-block">
-                            The combined total of tv, movies, and music played per day of the week.
-                        </p>
-                        <div class="graphs-instance">
-                            <div class="watch-chart" id="chart_div_plays_by_dayofweek" style="float: left;">
-                                <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...
-                                </div>
-                                <br>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col-md-6">
-                        <h4><i class="fa fa-clock-o"></i> <span class="yaxis-text">Play count</span> by hour of day <small>Last <span class="days">30</span> days</small></h4>
-                        <p class="help-block">
-                            The combined total of tv, movies, and music played per hour of the day.
-                        </p>
-                        <div class="graphs-instance">
-                            <div class="watch-chart" id="chart_div_plays_by_hourofday">
-                                <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...
-                                </div>
-                                <br>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-                <div class="row">
-                    <div class="col-md-6">
-                        <h4><i class="fa fa-television"></i> <span class="yaxis-text">Play count</span> by top 10 platforms <small>Last <span class="days">30</span> days</small></h4>
-                        <p class="help-block">
-                            The combined total of tv, movies, and music played by top 10 most active platforms.
-                        </p>
-                        <div class="graphs-instance">
-                            <div class="watch-chart" id="chart_div_plays_by_platform" style="float: left;">
-                                <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...
-                                </div>
-                                <br>
-                            </div>
-                        </div>
-                    </div>
-                    <div class="col-md-6">
-                        <h4><i class="fa fa-user"></i> <span class="yaxis-text">Play count</span> by top 10 users <small>Last <span class="days">30</span> days</small></h4>
-                        <p class="help-block">
-                            The combined total of tv, movies, and music played by top 10 most active users.
-                        </p>
-                        <div class="graphs-instance">
-                            <div class="watch-chart" id="chart_div_plays_by_user">
-                                <div class="graphs-load"><i class="fa fa-refresh fa-spin"></i> Loading chart...
-                                </div>
-                                <br>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-            </div>
 
+            % if config['graph_tab'] == 'tabs-2':
+            <div role="tabpanel" class="tab-pane active" id="tabs-2">
+            % else:
             <div role="tabpanel" class="tab-pane" id="tabs-2">
+            % endif
                 <div class="row">
                     <div class="col-md-12">
                         <h4><i class="fa fa-video-camera"></i> Daily Stream type breakdown <small>Last <span class="days">30</span> days</small></h4>
@@ -189,7 +211,11 @@
                 </div>
             </div>
 
+            % if config['graph_tab'] == 'tabs-3':
+            <div role="tabpanel" class="tab-pane active" id="tabs-3">
+            % else:
             <div role="tabpanel" class="tab-pane" id="tabs-3">
+            % endif
                 <div class="row">
                     <div class="col-md-12">
                         <h4><i class="fa fa-calendar"></i> Plays by Month <small>Last 12 months</small></h4>
@@ -263,36 +289,14 @@
 <script>
     $(document).ready(function () {
 
-        // Save graph state to cookies
-        $('input[name=yaxis-options]').change(function() {
-            setCookie('graphType', $(this).val(), 365, '/');
-        });
-        $('input[name=date-options]').change(function() {
-            setCookie('graphDate', $(this).val(), 365, '/');
-        });
-        $('a[data-toggle=tab]').click(function() {
-            setCookie('graphTab', $(this).attr('href'), 365, '/');
-        });
+        // Initial values for graph from config
+        var yaxis = "${config['graph_type']}";
+        var current_range = ${config['graph_days']};
+        var current_tab = "${'#' + config['graph_tab']}";
         
-        // Initial values for graph if no saved state
-        var yaxis = 'plays';
-        var current_range = 30;
-        var current_tab = '#tabs-1';
-            
-        // Read saved graph state from cookies and set initial values
-        if(getCookie('graphType')) {
-            var yaxis = getCookie('graphType');
-            $('input[name=yaxis-options][value=' + yaxis + ']').prop('checked', true).trigger('click');
-        }
-        if(getCookie('graphDate')) {
-            var current_range = getCookie('graphDate');
-            $('input[name=date-options][value=' + current_range + ']').prop('checked', true).trigger('click');
-            $('.days').html(current_range);
-        }
-        if(getCookie('graphTab')) {
-            var current_tab = getCookie('graphTab');
-            $('a[data-toggle=tab][href=' + current_tab + ']').trigger('click');
-        }
+        $('.days').html(current_range);
+
+        var music_visible = (${config['music_logging_enable']} == 1 ? true : false);
 
         function loadGraphsTab1(time_range, yaxis) {
             setGraphFormat(yaxis);
@@ -319,6 +323,7 @@
                     hc_plays_by_day_options.yAxis.min = 0;
                     hc_plays_by_day_options.xAxis.categories = dateArray;
                     hc_plays_by_day_options.series = data.series;
+                    hc_plays_by_day_options.series[2].visible = music_visible;
                     var hc_plays_by_day = new Highcharts.Chart(hc_plays_by_day_options);
                 }
             });
@@ -331,6 +336,7 @@
                 success: function(data) {
                     hc_plays_by_dayofweek_options.xAxis.categories = data.categories;
                     hc_plays_by_dayofweek_options.series = data.series;
+                    hc_plays_by_dayofweek_options.series[2].visible = music_visible;
                     var hc_plays_by_dayofweek = new Highcharts.Chart(hc_plays_by_dayofweek_options);
                 }
             });
@@ -343,6 +349,7 @@
                 success: function(data) {
                     hc_plays_by_hourofday_options.xAxis.categories = data.categories;
                     hc_plays_by_hourofday_options.series = data.series;
+                    hc_plays_by_hourofday_options.series[2].visible = music_visible;
                     var hc_plays_by_hourofday = new Highcharts.Chart(hc_plays_by_hourofday_options);
                 }
             });
@@ -355,6 +362,7 @@
                 success: function(data) {
                     hc_plays_by_platform_options.xAxis.categories = data.categories;
                     hc_plays_by_platform_options.series = data.series;
+                    hc_plays_by_platform_options.series[2].visible = music_visible;
                     var hc_plays_by_platform = new Highcharts.Chart(hc_plays_by_platform_options);
                 }
             });
@@ -367,6 +375,7 @@
                 success: function(data) {
                     hc_plays_by_user_options.xAxis.categories = data.categories;
                     hc_plays_by_user_options.series = data.series;
+                    hc_plays_by_user_options.series[2].visible = music_visible;
                     var hc_plays_by_user = new Highcharts.Chart(hc_plays_by_user_options);
                 }
             });
@@ -462,46 +471,68 @@
                     hc_plays_by_month_options.yAxis.min = 0;
                     hc_plays_by_month_options.xAxis.categories = data.categories;
                     hc_plays_by_month_options.series = data.series;
+                    hc_plays_by_month_options.series[2].visible = music_visible;
                     var hc_plays_by_month = new Highcharts.Chart(hc_plays_by_month_options);
                 }
             });
         }
 
         // Set initial state
-        loadGraphsTab1(current_range, yaxis);
+        if (current_tab == '#tabs-1') { loadGraphsTab1(current_range, yaxis); }
+        if (current_tab == '#tabs-2') { loadGraphsTab2(current_range, yaxis); }
+        if (current_tab == '#tabs-3') { loadGraphsTab3(yaxis); }
 
         // Tab1 opened
         $('#graph-tabs a[href="#tabs-1"]').on('shown.bs.tab', function (e) {
             e.preventDefault();
             current_tab = $(this).attr('href');
-            $('#days-selection').show();
             loadGraphsTab1(current_range, yaxis);
+            $.ajax({
+                url: 'set_graph_config',
+                data: { graph_tab: current_tab.replace('#','') },
+                async: true
+            });
         })
 
         // Tab2 opened
         $('#graph-tabs a[href="#tabs-2"]').on('shown.bs.tab', function (e) {
             e.preventDefault();
             current_tab = $(this).attr('href');
-            $('#days-selection').show();
             loadGraphsTab2(current_range, yaxis);
+            $.ajax({
+                url: 'set_graph_config',
+                data: { graph_tab: current_tab.replace('#','') },
+                async: true
+            });
         })
 
         // Tab3 opened
         $('#graph-tabs a[href="#tabs-3"]').on('shown.bs.tab', function (e) {
             e.preventDefault();
             current_tab = $(this).attr('href');
-            $('#days-selection').hide();
-            console.log('loading....');
             loadGraphsTab3(yaxis);
+            $.ajax({
+                url: 'set_graph_config',
+                data: { graph_tab: current_tab.replace('#','') },
+                async: true
+            });
         })
 
-
         // Date range changed
-        $('#days-selection').on('change', function() {
-            current_range = $('input[name=date-options]:checked', '#days-selection').val();
+        $('#graph-days').on('change', function() {
+            current_range = $(this).val();
+            if (current_range < 1) {
+                $(this).val(7);
+                current_range = 7;
+            }
             if (current_tab == '#tabs-1') { loadGraphsTab1(current_range, yaxis); }
             if (current_tab == '#tabs-2') { loadGraphsTab2(current_range, yaxis); }
             $('.days').html(current_range);
+            $.ajax({
+                url: 'set_graph_config',
+                data: { graph_days: current_range},
+                async: true
+            });
         });
 
         // Y-axis changed
@@ -510,6 +541,11 @@
             if (current_tab == '#tabs-1') { loadGraphsTab1(current_range, yaxis); }
             if (current_tab == '#tabs-2') { loadGraphsTab2(current_range, yaxis); }
             if (current_tab == '#tabs-3') { loadGraphsTab3(yaxis); }
+            $.ajax({
+                url: 'set_graph_config',
+                data: { graph_type: yaxis},
+                async: true
+            });
         });
 
         function setGraphFormat(type) {

data/interfaces/default/history.html

@@ -30,6 +30,7 @@
                 <th align='left' id="friendly_name">User</th>
                 <th align='left' id="ip_address">IP Address</th>
                 <th align='left' id="platform">Platform</th>
+                <th align='left' id="device">Player</th>
                 <th align='left' id="title">Title</th>
                 <th align='left' id="started">Started</th>
                 <th align='left' id="paused_counter">Paused</th>
@@ -75,19 +76,50 @@
 <script src="interfaces/default/js/moment-with-locale.js"></script>
 <script src="interfaces/default/js/tables/history_table.js"></script>
 <script>
-    $(document).ready(function() {
-        history_table_options.ajax = {
-            "url": "get_history",
-            type: "post",
-            data: function ( d ) {
-                return { 'json_data': JSON.stringify( d ) };
+    $(document).ready(function () {
+        function loadHistoryTable(media_type) {
+            history_table_options.ajax = {
+                url: 'get_history',
+                type: 'post',
+                data: function (d) {
+                    return {
+                        'json_data': JSON.stringify(d),
+                        'media_type': media_type
+                    };
+                }
             }
-        }
-        history_table = $('#history_table').DataTable(history_table_options);
-        var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 10] });
-        $(colvis.button()).appendTo('div.colvis-button-bar');
+            history_table = $('#history_table').DataTable(history_table_options);
+            var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 11] });
+            $(colvis.button()).appendTo('div.colvis-button-bar');
 
-        clearSearchButton('history_table', history_table);
+            clearSearchButton('history_table', history_table);
+
+            $('#history_table_filter').prepend('<div class="btn-group" data-toggle="buttons" id="media_type-selection" style="padding-right: 15px;"> \
+                <label class="btn btn-dark active"> \
+                    <input type="radio" name="media_type-filter" id="history-all" value="all" autocomplete="off"> All \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-movies" value="movie" autocomplete="off"> Movies \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-tv_shows" value="episode" autocomplete="off"> TV Shows \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-music" value="track" autocomplete="off"> Music \
+                </label> \
+            </div>');
+
+            $('#media_type-selection').on('change', function () {
+                $('#media_type-selection > label').removeClass('active');
+                selected_filter = $('input[name=media_type-filter]:checked', '#media_type-selection');
+                $(selected_filter).closest('label').addClass('active');
+                media_type = $(selected_filter).val();
+                history_table.draw();
+            });
+        }
+
+        var media_type = 'all';
+        loadHistoryTable(media_type);
 
         $('#row-edit-mode').on('click', function() {
             $('#row-edit-mode-alert').fadeIn(200);

data/interfaces/default/history_table_modal.html

@@ -16,7 +16,7 @@
                     <th align='left' id="started">Started</th>
                     <th align='left' id="stopped">Stopped</th>
                     <th align='left' id="friendly_name">User</th>
-                    <th align='left' id="platform">Platform</th>
+                    <th align='left' id="player">Player</th>
                     <th align='left' id="title">Title</th>
                 </tr>
                 </thead>
@@ -38,6 +38,7 @@
             type: "post",
             data: function ( d ) {
                 return { 'json_data': JSON.stringify( d ),
+                         'grouping': false,
                          'start_date': '${data}'
                        };
             }

data/interfaces/default/home_stats.html

@@ -17,19 +17,19 @@ data[array_index]['rows'] :: Usable parameters
 
 row_id                  Return the db row id for a metadata item if one exists
 
-== Only if 'stat_id' is 'top_tv' or 'popular_tv' or 'top_movies' or 'popular_movies' or 'last_watched' ==
+== Only if 'stat_id' is 'top_tv' or 'popular_tv' or 'top_movies' or 'popular_movies' or 'top_music' or 'popular_music' or 'last_watched' ==
 thumb                   Return the thumb for the media item.
 
-== Only if 'stat_id' is 'top_tv' or 'popular_tv' ==
+== Only if 'stat_id' is 'top_tv' or 'popular_tv' or 'top_music' or 'popular_music' ==
 grandparent_thumb       Returns location of the item's thumbnail. Use with pms_image_proxy.
 rating_key              Returns the unique identifier for the media item.
 title                   Returns the title for the associated stat.
 
-== Only if 'stat_id' is 'top_tv' or 'top_movies' or 'top_user' or 'top_platform' ==
+== Only if 'stat_id' is 'top_tv' or 'top_movies' or 'top_music' or 'top_user' or 'top_platform' ==
 total_plays             Returns the count for the associated stat.
 total_duration          Returns the total duration for the associated stat.
 
-== Only of 'stat_id' is 'popular_tv' or 'popular_movies' ==
+== Only of 'stat_id' is 'popular_tv' or 'popular_movies' or 'popular_music' ==
 users_watched           Returns the count for the associated stat.
 
 == Only if 'stat_id' is 'top_user' or 'last_watched' ==
@@ -39,11 +39,16 @@ user_id                 Returns the user id for the associated stat.
 friendly_name           Returns the friendly name of the user for the associated stat.
 
 == Only if 'stat_id' is 'top_platform' or 'last_watched' ==
-platform_type           Returns the platform name for the associated stat.
+player                  Returns the player name for the associated stat.
 
 == Only if 'stat_id' is 'last_watched' ==
 last_watch              Returns the time the media item was last watched.
 
+== Only if 'stat_id' is 'most_concurrent' ==
+count                   Returns the count of the most concurrent streams.
+started                 Returns the start time of the most concurrent streams.
+stopped                 Returns the stop time of the most concurrent streams.
+
 DOCUMENTATION :: END
 </%doc>
 
@@ -65,7 +70,7 @@ DOCUMENTATION :: END
 %>
 
 % if data:
-% if data[0]['rows'] or data[1]['rows'] or data[2]['rows'] or data[3]['rows'] or data[4]['rows'] or data[5]['rows']:
+% if data[0]['stat_id']:
 <ul class="list-unstyled">
     % for top_stat in data:
     % if top_stat['stat_id'] == 'top_tv' and top_stat['rows']:
@@ -77,7 +82,7 @@ DOCUMENTATION :: END
                 </div>
                 <div class="home-platforms-instance-playcount">
                     <h4>
-                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                             ${top_stat['rows'][0]['title']}
                         </a>
                     </h4>
@@ -89,7 +94,7 @@ DOCUMENTATION :: END
                     % endif
                 </div>
             </div>
-            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                 % if top_stat['rows'][0]['grandparent_thumb']:
                 <div class="home-platforms-instance-poster">
                     <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['grandparent_thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -111,7 +116,7 @@ DOCUMENTATION :: END
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
-                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                             ${top_stat['rows'][loop.index]['title']}
                                         </a>
                                     </h5>
@@ -125,7 +130,7 @@ DOCUMENTATION :: END
                                     % endif
                                 </div>
                             </div>
-                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                             % if top_stat['rows'][loop.index]['grandparent_thumb']:
                             <div class="home-platforms-instance-list-poster">
                                 <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['grandparent_thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -157,7 +162,7 @@ DOCUMENTATION :: END
                 </div>
                 <div class="home-platforms-instance-playcount">
                     <h4>
-                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                             ${top_stat['rows'][0]['title']}
                         </a>
                     </h4>
@@ -165,7 +170,7 @@ DOCUMENTATION :: END
                     <p> users</p>
                 </div>
             </div>
-            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                 % if top_stat['rows'][0]['grandparent_thumb'] != '':
                 <div class="home-platforms-instance-poster">
                     <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['grandparent_thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -187,7 +192,7 @@ DOCUMENTATION :: END
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
-                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                             ${top_stat['rows'][loop.index]['title']}
                                         </a>
                                     </h5>
@@ -197,7 +202,7 @@ DOCUMENTATION :: END
                                     <p> users</p>
                                 </div>
                             </div>
-                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                 % if top_stat['rows'][loop.index]['grandparent_thumb']:
                                 <div class="home-platforms-instance-list-poster">
                                     <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['grandparent_thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -229,7 +234,7 @@ DOCUMENTATION :: END
                 </div>
                 <div class="home-platforms-instance-playcount">
                     <h4>
-                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                             ${top_stat['rows'][0]['title']}
                         </a>
                     </h4>
@@ -241,7 +246,7 @@ DOCUMENTATION :: END
                     % endif
                 </div>
             </div>
-            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                 % if top_stat['rows'][0]['thumb']:
                 <div class="home-platforms-instance-poster">
                     <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -263,7 +268,7 @@ DOCUMENTATION :: END
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
-                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                             ${top_stat['rows'][loop.index]['title']}
                                         </a>
                                     </h5>
@@ -277,7 +282,7 @@ DOCUMENTATION :: END
                                     % endif
                                 </div>
                             </div>
-                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                 % if top_stat['rows'][loop.index]['thumb']:
                                 <div class="home-platforms-instance-list-poster">
                                     <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -309,7 +314,7 @@ DOCUMENTATION :: END
                 </div>
                 <div class="home-platforms-instance-playcount">
                     <h4>
-                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                             ${top_stat['rows'][0]['title']}
                         </a>
                     </h4>
@@ -317,7 +322,7 @@ DOCUMENTATION :: END
                     <p> users</p>
                 </div>
             </div>
-            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}">
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
                 % if top_stat['rows'][0]['thumb']:
                 <div class="home-platforms-instance-poster">
                     <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -339,7 +344,7 @@ DOCUMENTATION :: END
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
-                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                             ${top_stat['rows'][loop.index]['title']}
                                         </a>
                                     </h5>
@@ -349,7 +354,7 @@ DOCUMENTATION :: END
                                     <p> users</p>
                                 </div>
                             </div>
-                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}">
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
                                 % if top_stat['rows'][loop.index]['thumb']:
                                 <div class="home-platforms-instance-list-poster">
                                     <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -372,6 +377,158 @@ DOCUMENTATION :: END
             % endif
         </li>
     </div>
+    % elif top_stat['stat_id'] == 'top_music' and top_stat['rows']:
+    <div class="home-platforms-instance">
+        <li>
+            <div class="home-platforms-instance-info">
+                <div class="home-platforms-instance-name">
+                    <h4>Most Listened to Artist</h4>
+                </div>
+                <div class="home-platforms-instance-playcount">
+                    <h4>
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
+                            ${top_stat['rows'][0]['title']}
+                        </a>
+                    </h4>
+                    % if top_stat['stat_type'] == 'total_plays':
+                    <h3>${top_stat['rows'][0]['total_plays']}</h3>
+                    <p> plays</p>
+                    % else:
+                    ${top_stat['rows'][0]['total_duration'] | hd}
+                    % endif
+                </div>
+            </div>
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
+                % if top_stat['rows'][0]['grandparent_thumb']:
+                <div class="home-platforms-instance-poster">
+                    <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['grandparent_thumb']}&width=300&height=300&fallback=poster);"></div>
+                </div>
+                % else:
+                <div class="home-platforms-instance-poster">
+                    <div class="home-platforms-poster-face" style="background-image: url(interfaces/default/images/poster.png);"></div>
+                </div>
+                % endif
+            </a>
+            %if len(top_stat['rows']) > 1:
+            <div class="home-platforms-instance-list-chevron"><i class="fa fa-chevron-down"></i></div>
+            <ul class="list-unstyled">
+                <div class="slider">
+                    <div class="home-platforms-instance-list">
+                        % for row in top_stat['rows']:
+                        %if loop.index > 0:
+                        <li>
+                            <div class="home-platforms-instance-list-info">
+                                <div class="home-platforms-instance-list-name">
+                                    <h5>
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
+                                            ${top_stat['rows'][loop.index]['title']}
+                                        </a>
+                                    </h5>
+                                </div>
+                                <div class="home-platforms-instance-list-playcount">
+                                    % if top_stat['stat_type'] == 'total_plays':
+                                    <h3>${top_stat['rows'][loop.index]['total_plays']}</h3>
+                                    <p> plays</p>
+                                    % else:
+                                    ${top_stat['rows'][loop.index]['total_duration'] | hd}
+                                    % endif
+                                </div>
+                            </div>
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
+                                % if top_stat['rows'][loop.index]['grandparent_thumb']:
+                                <div class="home-platforms-instance-list-poster">
+                                    <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['grandparent_thumb']}&width=300&height=300&fallback=poster);"></div>
+                                </div>
+                                % else:
+                                <div class="home-platforms-instance-poster2">
+                                    <div class="home-platforms-list-poster-face" style="background-image: url(interfaces/default/images/poster.png);"></div>
+                                </div>
+                                % endif
+                            </a>
+                            <div class="home-platforms-instance-list-number">
+                                <h4>${loop.index + 1}</h4>
+                            </div>
+                        </li>
+                        % endif
+                        % endfor
+                    </div>
+                </div>
+            </ul>
+            % endif
+        </li>
+    </div>
+    % elif top_stat['stat_id'] == 'popular_music' and top_stat['rows']:
+    <div class="home-platforms-instance">
+        <li>
+            <div class="home-platforms-instance-info">
+                <div class="home-platforms-instance-name">
+                    <h4>Most Popular Artist</h4>
+                </div>
+                <div class="home-platforms-instance-playcount">
+                    <h4>
+                        <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
+                            ${top_stat['rows'][0]['title']}
+                        </a>
+                    </h4>
+                    <h3>${top_stat['rows'][0]['users_watched']}</h3>
+                    <p> users</p>
+                </div>
+            </div>
+            <a href="info?item_id=${top_stat['rows'][0]['rating_key']}" title="${top_stat['rows'][0]['title']}">
+                % if top_stat['rows'][0]['grandparent_thumb'] != '':
+                <div class="home-platforms-instance-poster">
+                    <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['grandparent_thumb']}&width=300&height=300&fallback=poster);"></div>
+                </div>
+                % else:
+                <div class="home-platforms-instance-poster">
+                    <div class="home-platforms-poster-face" style="background-image: url(interfaces/default/images/poster.png);"></div>
+                </div>
+                % endif
+            </a>
+            %if len(top_stat['rows']) > 1:
+            <div class="home-platforms-instance-list-chevron"><i class="fa fa-chevron-down"></i></div>
+            <ul class="list-unstyled">
+                <div class="slider">
+                    <div class="home-platforms-instance-list">
+                        % for row in top_stat['rows']:
+                        %if loop.index > 0:
+                        <li>
+                            <div class="home-platforms-instance-list-info">
+                                <div class="home-platforms-instance-list-name">
+                                    <h5>
+                                        <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
+                                            ${top_stat['rows'][loop.index]['title']}
+                                        </a>
+                                    </h5>
+                                </div>
+                                <div class="home-platforms-instance-list-playcount">
+                                    <h3>${top_stat['rows'][loop.index]['users_watched']}</h3>
+                                    <p> users</p>
+                                </div>
+                            </div>
+                            <a href="info?item_id=${top_stat['rows'][loop.index]['rating_key']}" title="${top_stat['rows'][loop.index]['title']}">
+                                % if top_stat['rows'][loop.index]['grandparent_thumb']:
+                                <div class="home-platforms-instance-list-poster">
+                                    <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['grandparent_thumb']}&width=300&height=300&fallback=poster);"></div>
+                                </div>
+                                % else:
+                                <div class="home-platforms-instance-poster2">
+                                    <div class="home-platforms-list-poster-face" style="background-image: url(interfaces/default/images/poster.png);"></div>
+                                </div>
+                                % endif
+                            </a>
+                            <div class="home-platforms-instance-list-number">
+                                <h4>${loop.index + 1}</h4>
+                            </div>
+                        </li>
+                        % endif
+                        % endfor
+                    </div>
+                </div>
+            </ul>
+            % endif
+        </li>
+    </div>
     % elif top_stat['stat_id'] == 'top_users' and top_stat['rows']:
     <div class="home-platforms-instance">
         <li>
@@ -382,12 +539,12 @@ DOCUMENTATION :: END
                 <div class="home-platforms-instance-playcount">
                     <h4>
                         % if top_stat['rows'][0]['user_id']:
-                        <a href="user?user_id=${top_stat['rows'][0]['user_id']}">
-                            % else:
-                            <a href="user?user=${top_stat['rows'][0]['user']}">
-                                % endif
-                                ${top_stat['rows'][0]['friendly_name']}
-                            </a>
+                        <a href="user?user_id=${top_stat['rows'][0]['user_id']}" title="${top_stat['rows'][0]['friendly_name']}">
+                        % else:
+                        <a href="user?user=${top_stat['rows'][0]['user']}" title="${top_stat['rows'][0]['friendly_name']}">
+                        % endif
+                            ${top_stat['rows'][0]['friendly_name']}
+                        </a>
                     </h4>
                     % if top_stat['stat_type'] == 'total_plays':
                     <h3>${top_stat['rows'][0]['total_plays']}</h3>
@@ -398,9 +555,9 @@ DOCUMENTATION :: END
                 </div>
             </div>
             % if top_stat['rows'][0]['user_id']:
-            <a href="user?user_id=${top_stat['rows'][0]['user_id']}">
+            <a href="user?user_id=${top_stat['rows'][0]['user_id']}" title="${top_stat['rows'][0]['friendly_name']}">
             % else:
-            <a href="user?user=${top_stat['rows'][0]['user']}">
+            <a href="user?user=${top_stat['rows'][0]['user']}" title="${top_stat['rows'][0]['friendly_name']}">
             % endif
                 % if top_stat['rows'][0]['user_thumb'] != '':
                 <div class="home-platforms-instance-poster">
@@ -424,12 +581,12 @@ DOCUMENTATION :: END
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
                                         % if top_stat['rows'][loop.index]['user_id']:
-                                        <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}">
-                                            % else:
-                                            <a href="user?user=${top_stat['rows'][loop.index]['user']}">
-                                                % endif
-                                                ${top_stat['rows'][loop.index]['friendly_name']}
-                                            </a>
+                                        <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
+                                        % else:
+                                        <a href="user?user=${top_stat['rows'][loop.index]['user']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
+                                        % endif
+                                            ${top_stat['rows'][loop.index]['friendly_name']}
+                                        </a>
                                     </h5>
                                 </div>
                                 <div class="home-platforms-instance-list-playcount">
@@ -442,9 +599,9 @@ DOCUMENTATION :: END
                                 </div>
                             </div>
                             % if top_stat['rows'][loop.index]['user_id']:
-                            <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}">
+                            <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
                             % else:
-                            <a href="user?user=${top_stat['rows'][loop.index]['user']}">
+                            <a href="user?user=${top_stat['rows'][loop.index]['user']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
                             % endif
                                 % if top_stat['rows'][loop.index]['user_thumb'] != '':
                                 <div class="home-platforms-instance-poster">
@@ -476,7 +633,7 @@ DOCUMENTATION :: END
                     <h4>Most Active Platform</h4>
                 </div>
                 <div class="home-platforms-instance-playcount">
-                    <h4>${top_stat['rows'][0]['platform_type']}</h4>
+                    <h4 title="${top_stat['rows'][0]['platform_type']}">${top_stat['rows'][0]['platform_type']}</h4>
                     % if top_stat['stat_type'] == 'total_plays':
                     <h3>${top_stat['rows'][0]['total_plays']}</h3>
                     <p> plays</p>
@@ -485,7 +642,7 @@ DOCUMENTATION :: END
                     % endif
                 </div>
             </div>
-            <div id="platform-stat" class="home-platforms-instance-poster">
+            <div id="platform-stat" class="home-platforms-instance-poster" title="${top_stat['rows'][0]['platform_type']}">
                 <script>
                     $("#platform-stat").html("<div class='home-platforms-instance-box' style='background-image: url(" + getPlatformImagePath('${top_stat['rows'][0]['platform_type']}') + ");'>");
                 </script>
@@ -500,7 +657,7 @@ DOCUMENTATION :: END
                         <li>
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
-                                    <h5>
+                                    <h5 title="${top_stat['rows'][loop.index]['platform_type']}">
                                         ${top_stat['rows'][loop.index]['platform_type']}
                                     </h5>
                                 </div>
@@ -513,7 +670,7 @@ DOCUMENTATION :: END
                                     % endif
                                 </div>
                             </div>
-                            <div class="home-platforms-instance-poster" id="home-platforms-instance-poster-${loop.index + 1}">
+                            <div class="home-platforms-instance-poster" id="home-platforms-instance-poster-${loop.index + 1}" title="${top_stat['rows'][loop.index]['platform_type']}">
                                 <script>
                                     $("#home-platforms-instance-poster-${loop.index + 1}").html("<div class='home-platforms-instance-list-box' style='background-image: url(" + getPlatformImagePath('${top_stat['rows'][loop.index]['platform_type']}') + ");'>");
                                 </script>
@@ -539,16 +696,16 @@ DOCUMENTATION :: END
                 </div>
                 <div class="home-platforms-instance-last-user">
                     <h4>
-                        <a href="info?source=history&item_id=${top_stat['rows'][0]['row_id']}">
+                        <a href="info?source=history&item_id=${top_stat['rows'][0]['row_id']}" title="${top_stat['rows'][0]['title']}">
                             ${top_stat['rows'][0]['title']}
                         </a>
                     </h4>
                     <h5>
                         % if top_stat['rows'][0]['user_id']:
-                        <a href="user?user_id=${top_stat['rows'][0]['user_id']}">
+                        <a href="user?user_id=${top_stat['rows'][0]['user_id']}" title="${top_stat['rows'][0]['friendly_name']}">
                         % else:
-                        <a href="user?user=${top_stat['rows'][0]['user']}">
-                            % endif
+                        <a href="user?user=${top_stat['rows'][0]['user']}" title="${top_stat['rows'][0]['friendly_name']}">
+                        % endif
                             ${top_stat['rows'][0]['friendly_name']}
                         </a>
                     </h5>
@@ -557,11 +714,11 @@ DOCUMENTATION :: END
                             <script>
                                 $('#last-watch-stat').text(moment(${top_stat['rows'][0]['last_watch']},"X").format(date_format));
                             </script>
-                        </span> - ${top_stat['rows'][0]['platform_type']}
+                        </span> - ${top_stat['rows'][0]['player']}
                     </p>
                 </div>
             </div>
-            <a href="info?source=history&item_id=${top_stat['rows'][0]['row_id']}">
+            <a href="info?source=history&item_id=${top_stat['rows'][0]['row_id']}" title="${top_stat['rows'][0]['title']}">
                 % if top_stat['rows'][0]['thumb']:
                 <div class="home-platforms-instance-poster">
                     <div class="home-platforms-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][0]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -583,7 +740,7 @@ DOCUMENTATION :: END
                             <div class="home-platforms-instance-list-info">
                                 <div class="home-platforms-instance-list-name">
                                     <h5>
-                                        <a href="info?source=history&item_id=${top_stat['rows'][loop.index]['row_id']}">
+                                        <a href="info?source=history&item_id=${top_stat['rows'][loop.index]['row_id']}" title="${top_stat['rows'][loop.index]['title']}">
                                             ${top_stat['rows'][loop.index]['title']}
                                         </a>
                                     </h5>
@@ -591,10 +748,10 @@ DOCUMENTATION :: END
                                 <div class="home-platforms-instance-list-last-user">
                                     <h5>
                                         % if top_stat['rows'][loop.index]['user_id']:
-                                        <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}">
-                                            % else:
-                                        <a href="user?user=${top_stat['rows'][loop.index]['user']}">
-                                            % endif
+                                        <a href="user?user_id=${top_stat['rows'][loop.index]['user_id']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
+                                        % else:
+                                        <a href="user?user=${top_stat['rows'][loop.index]['user']}" title="${top_stat['rows'][loop.index]['friendly_name']}">
+                                        % endif
                                             ${top_stat['rows'][loop.index]['friendly_name']}
                                         </a>
                                     </h5>
@@ -603,11 +760,11 @@ DOCUMENTATION :: END
                                             <script>
                                                 $('#home-platforms-instance-list-last-watch-${loop.index + 1}').text(moment(${top_stat['rows'][loop.index]['last_watch']},"X").format(date_format));
                                             </script>
-                                        </span> - ${top_stat['rows'][loop.index]['platform_type']}
+                                        </span> - ${top_stat['rows'][loop.index]['player']}
                                     </p>
                                 </div>
                             </div>
-                            <a href="info?source=history&item_id=${top_stat['rows'][loop.index]['row_id']}">
+                            <a href="info?source=history&item_id=${top_stat['rows'][loop.index]['row_id']}" title="${top_stat['rows'][loop.index]['title']}">
                                 % if top_stat['rows'][loop.index]['thumb']:
                                 <div class="home-platforms-instance-list-poster">
                                     <div class="home-platforms-list-poster-face" style="background-image: url(pms_image_proxy?img=${top_stat['rows'][loop.index]['thumb']}&width=300&height=450&fallback=poster);"></div>
@@ -630,6 +787,30 @@ DOCUMENTATION :: END
             % endif
         </li>
     </div>
+    % elif top_stat['stat_id'] == 'most_concurrent' and top_stat['rows']:
+    <div class="home-platforms-instance">
+        <li>
+            <div class="home-platforms-instance-info">
+                <div class="home-platforms-instance-name">
+                    <h4>Most Concurrent Streams</h4>
+                </div>
+                <div class="home-platforms-instance-playcount">
+                    <h4>
+                        <span id="most-concurrent-start">
+                            <script>
+                                $('#most-concurrent-start').text(moment(${top_stat['rows'][0]['started']},"X").format(date_format + ' ' + time_format));
+                            </script>
+                        </span>
+                    </h4>
+                    <h3>${top_stat['rows'][0]['count']}</h3>
+                    <p> streams</p>
+                </div>
+            </div>
+            <div class="home-platforms-instance-poster">
+                <div class="home-platforms-instance-box" style="background-image: url(interfaces/default/images/home-stat_most-concurrent.png);"></div>
+            </div>
+        </li>
+    </div>
     % endif
     % endfor
 </ul>

data/interfaces/default/index.html

@@ -16,6 +16,7 @@
             </div>
         </div>
     </div>
+    % if config['home_stats_cards'] > 'watch_statistics':
     <div class="row">
         <div class="col-md-12">
             <div class="padded-header">
@@ -27,10 +28,12 @@
             </div>
         </div>
     </div>
+    % endif
+    % if config['home_library_cards'] > 'library_statistics':
     <div class="row">
         <div class="col-md-12">
             <div class="padded-header" id="library-statistics-header">
-                <h3>Library Statistics</h3>
+                <h3>Library Statistics <small>${config['pms_name']}</small></h3>
             </div>
             <div id="library-stats" class="library-platforms">
                 <div class='text-muted'><i class="fa fa-refresh fa-spin"></i> Loading stats...</div>
@@ -38,6 +41,7 @@
             </div>
         </div>
     </div>
+    % endif
     <div class='row'>
         <div class="col-md-12">
             <div class="padded-header">
@@ -82,39 +86,18 @@
     currentActivity();
     setInterval(currentActivity, 15000);
 
-    function getHomeStats(days, stat_type, stat_count) {
+    function getHomeStats(days) {
         $.ajax({
             url: 'home_stats',
             cache: false,
             async: true,
-            data: {time_range: days, stat_type: stat_type, stat_count: stat_count},
+            data: { },
             complete: function(xhr, status) {
                 $("#home-stats").html(xhr.responseText);
             }
         });
     }
 
-    function getLibraryStatsHeader() { 
-        $.ajax({
-            "url": "get_servers_info",
-            type: "post",
-            cache: false,
-            async: true,
-            data: { },
-            complete: function (xhr, status) {
-                server_info = $.parseJSON(xhr.responseText);
-                var server_name = 'Server name not found';
-                for (var i in server_info) {
-                    if (server_info[i].machine_identifier == '${config['pms_identifier']}') { 
-                        server_name = server_info[i].name
-                        break;
-                    }
-                }
-                $('#library-statistics-header h3').append(' <small>' + server_name + '</small>')
-            }
-        });
-    }
-
     function getLibraryStats() {
         $.ajax({
             url: 'library_stats',
@@ -165,8 +148,7 @@
         }
     });
 
-    getHomeStats(${config['home_stats_length']}, ${config['home_stats_type']}, ${config['home_stats_count']});
-    getLibraryStatsHeader();
+    getHomeStats();
     getLibraryStats();
 
 

data/interfaces/default/info.html

@@ -11,27 +11,40 @@ data :: Usable parameters (if not applicable for media type, blank value will be
 
 == Global keys ==
 rating_key              Returns the unique identifier for the media item.
-type                    Returns the type of media. Either 'movie', 'episode' or 'show' or 'season'.
+media_type                    Returns the type of media. Either 'movie', 'show', 'season', 'episode', 'artist', 'album', or 'track'.
 art                     Returns the location of the item's artwork
-title                   Returns the name of the episode, show, season or movie.
+title                   Returns the name of the movie, show, episode, artist, album, or track.
 duration                Returns the standard runtime of the media.
 content_rating          Returns the age rating for the media.
 summary                 Returns a brief description of the media plot.
-grandparent_title       Returns the name of the TV show.
-parent_index            Returns the season number of the TV show.
-index                   Returns the episode number.
+grandparent_title       Returns the name of the show, or artist.
+parent_index            Returns the index number of the season.
+index                   Returns the index number of the episode, or track.
 parent_thumb            Returns the location of the item's thumbnail. Use with pms_image_proxy.
 writers                 Returns an array of writers.
 thumb                   Returns the location of the item's thumbnail. Use with pms_image_proxy.
-parent_title            Returns the name of the TV show.
+parent_title            Returns the name of the show, or artist.
 rating                  Returns the 5 star rating value for the movie. Between 1 and 5.
-year                    Returns the release year of the movie.
+year                    Returns the release year of the movie, or show.
 genres                  Returns an array of genres.
 actors                  Returns an array of actors.
 directors               Returns an array of directors.
 studio                  Returns the name of the studio.
 originally_available_at Returns the air date of the item.
 
+query :: Usable parameters
+
+== Global keys ==
+query_string            Returns the string used for the search query.
+title                   Returns the name of the movie, episode, or track.
+parent_title            Returns the name of the album.
+grandparent_title       Returns the name of the show, or artist.
+media_index             Returns the index number of the episode, or track.
+parent_media_index      Returns the index number of the season.
+year                    Returns the release year of the movie, or show.
+media_type              Returns the type of media. Either 'movie', 'show', 'season', 'episode', 'artist', 'album', or 'track'.
+rating_key              Returns the unique identifier for the media item.
+
 DOCUMENTATION :: END
 </%doc>
 
@@ -47,76 +60,76 @@ DOCUMENTATION :: END
 % if data:
 <div class="container-fluid">
     <div class="row">
+        % if data['media_type'] != 'library':
         <div class="art-face" style="background-image:url(pms_image_proxy?img=${data['art']}&width=1920&height=1080)"></div>
+        % endif
         <div class="summary-container">
             <div class="summary-navbar">
                 <div class="col-md-12">
                     <div class="summary-navbar-list">
-                        % if data['type'] == 'movie':
-                        <span>Movies</span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">${data['title']}</a></span>
-                        % elif data['type'] == 'show':
-                        <span>TV Shows</span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">${data['title']}</a></span>
-                        % elif data['type'] == 'season':
-                        <span class="hidden-xs hidden-sm">TV Shows</span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">Season ${data['index']}</a></span>
-                        % elif data['type'] == 'episode':
-                        <span class="hidden-xs hidden-sm">TV Shows</span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span class="hidden-xs hidden-sm"><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="info?item_id=${data['parent_rating_key']}">Season ${data['parent_index']}</a></span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">Episode ${data['index']} - ${data['title']}</a></span>
-                        % elif data['type'] == 'artist':
-                        <span>Music</span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">${data['title']}</a></span>
-                        % elif data['type'] == 'album':
-                        <span class="hidden-xs hidden-sm">Music</span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">${data['title']}</a></span>
-                        % elif data['type'] == 'track':
-                        <span class="hidden-xs hidden-sm">Music</span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span class="hidden-xs hidden-sm"><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></span>
-                        <span class="hidden-xs hidden-sm"><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></span>
-                        <span><i class="fa fa-chevron-right"></i></span>
-                        <span><a href="#">Track ${data['index']} - ${data['title']}</a></span>
+                        <ul class="list-unstyled breadcrumb">
+                        % if data['media_type'] == 'library':
+                        % if data['library'] == 'movie':
+                        <li class="active">Movies</li>
+                        % elif data['library'] == 'show':
+                        <li class="active">TV Shows</li>
+                        % elif data['library'] == 'artist':
+                        <li class="active">Music</li>
                         % endif
+                        % elif data['media_type'] == 'movie':
+                        <li><a href="info?item_id=movie">Movies</a></li>
+                        <li class="active">${data['title']}</li>
+                        % elif data['media_type'] == 'show':
+                        <li><a href="info?item_id=show">TV Shows</a></li>
+                        <li class="active">${data['title']}</li>
+                        % elif data['media_type'] == 'season':
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=show">TV Shows</a></li>
+                        <li><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></li>
+                        <li class="active">Season ${data['index']}</li>
+                        % elif data['media_type'] == 'episode':
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=show">TV Shows</a></li>
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></li>
+                        <li><a href="info?item_id=${data['parent_rating_key']}">Season ${data['parent_index']}</a></li>
+                        <li class="active">Episode ${data['index']} - ${data['title']}</li>
+                        % elif data['media_type'] == 'artist':
+                        <li><a href="info?item_id=artist">Music</a></li>
+                        <li class="active">${data['title']}</li>
+                        % elif data['media_type'] == 'album':
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=artist">Music</a></li>
+                        <li><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></li>
+                        <li class="active">${data['title']}</li>
+                        % elif data['media_type'] == 'track':
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=artist">Music</a></li>
+                        <li class="hidden-xs hidden-sm"><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></li>
+                        <li><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></li>
+                        <li class="active">Track ${data['index']} - ${data['title']}</li>
+                        % endif
+                        </ul>
                     </div>
                 </div>
             </div>
+            % if data['media_type'] != 'library':
             <div class="summary-content-title-wrapper">
                 <div class="col-md-9">
                     <div class="summary-content-poster hidden-xs hidden-sm">
-                        % if data['type'] == 'track':
+                        % if data['media_type'] == 'track':
                         <a href="http://app.plex.tv/web/app#!/server/${config['pms_identifier']}/details/%2Flibrary%2Fmetadata%2F${data['parent_rating_key']}" target="Plex/Web" title="View in Plex/Web">
-                        % else:
+                        % elif data['media_type'] != 'library':
                         <a href="http://app.plex.tv/web/app#!/server/${config['pms_identifier']}/details/%2Flibrary%2Fmetadata%2F${data['rating_key']}" target="Plex/Web" title="View in Plex/Web">
                         % endif
-                            % if data['type'] == 'episode':
+                            % if data['media_type'] == 'episode':
                             <div class="summary-poster-face-episode" style="background-image: url(pms_image_proxy?img=${data['thumb']}&width=500&height=280&fallback=poster);">
                                 <div class="summary-poster-face-overlay">
                                     <span></span>
                                 </div>
                             </div>
-                            % elif data['type'] == 'artist' or data['type'] == 'album' or data['type'] == 'track':
+                            % elif data['media_type'] == 'artist' or data['media_type'] == 'album' or data['media_type'] == 'track':
                             <div class="summary-poster-face-track" style="background-image: url(pms_image_proxy?img=${data['thumb']}&width=500&height=500&fallback=poster);">
                                 <div class="summary-poster-face-overlay">
                                     <span></span>
                                 </div>
                             </div>
-                            % else:
+                            % elif data['media_type'] != 'library':
                             <div class="summary-poster-face" style="background-image: url(pms_image_proxy?img=${data['thumb']}&width=300&height=450&fallback=poster);">
                                 <div class="summary-poster-face-overlay">
                                     <span></span>
@@ -126,19 +139,19 @@ DOCUMENTATION :: END
                         </a>
                     </div>
                     <div class="summary-content-title">
-                        % if data['type'] == 'movie' or data['type'] == 'show' or data['type'] == 'artist':
+                        % if data['media_type'] == 'movie' or data['media_type'] == 'show' or data['media_type'] == 'artist':
                         <h1>&nbsp;</h1><h1>${data['title']}</h1>
-                        % elif data['type'] == 'season':
+                        % elif data['media_type'] == 'season':
                         <h1>&nbsp;</h1><h1><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></h1>
                         <h3 class="hidden-xs">S${data['index']}</h3>
-                        % elif data['type'] == 'episode':
+                        % elif data['media_type'] == 'episode':
                         <h1><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></h1>
                         <h2>${data['title']}</h2>
                         <h3 class="hidden-xs">S${data['parent_index']} &middot; E${data['index']}</h3>
-                        % elif data['type'] == 'album':
+                        % elif data['media_type'] == 'album':
                         <h1><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a></h1>
                         <h2>${data['title']}</h2>
-                        % elif data['type'] == 'track':
+                        % elif data['media_type'] == 'track':
                         <h1><a href="info?item_id=${data['grandparent_rating_key']}">${data['grandparent_title']}</a></h1>
                         <h2><a href="info?item_id=${data['parent_rating_key']}">${data['parent_title']}</a> - ${data['title']}</h2>
                         <h3 class="hidden-xs">T${data['index']}</h3>
@@ -146,13 +159,15 @@ DOCUMENTATION :: END
                     </div>
                 </div>
             </div>
+            % endif
             <div class="summary-content-wrapper">
+                % if data['media_type'] != 'library':
                 <div class="col-md-9">
-                    % if data['type'] == 'movie' or data['type'] == 'show' or data['type'] == 'season':
+                    % if data['media_type'] == 'movie' or data['media_type'] == 'show' or data['media_type'] == 'season':
                     <div class="summary-content-padding hidden-xs hidden-sm" style="height: 275px;"></div>
-                    % elif data['type'] == 'episode':
+                    % elif data['media_type'] == 'episode':
                     <div class="summary-content-padding hidden-xs hidden-sm" style="height: 40px;"></div>
-                    % elif data['type'] == 'artist' or data['type'] == 'album' or data['type'] == 'track':
+                    % elif data['media_type'] == 'artist' or data['media_type'] == 'album' or data['media_type'] == 'track':
                     <div class="summary-content-padding hidden-xs hidden-sm" style="height: 150px;"></div>
                     % else:
                     <div class="summary-content-padding hidden-xs hidden-sm"></div>
@@ -174,13 +189,13 @@ DOCUMENTATION :: END
                                 % endif
                             </div>
                             <div class="summary-content-details-tag">
-                                % if data['type'] == 'movie':
+                                % if data['media_type'] == 'movie':
                                 Year <strong> ${data['year']}</strong>
-                                % elif data['type'] == 'show':
+                                % elif data['media_type'] == 'show':
                                 Aired <strong> ${data['year']}</strong>
-                                % elif data['type'] == 'episode':
+                                % elif data['media_type'] == 'episode':
                                 Aired <strong> <span id="airdate">${data['originally_available_at']}</span></strong>
-                                % elif data['type'] == 'album' or data['type'] == 'track':
+                                % elif data['media_type'] == 'album' or data['media_type'] == 'track':
                                 Released <strong> ${data['year']}</strong>
                                 % endif
                             </div>
@@ -253,7 +268,7 @@ DOCUMENTATION :: END
                         % endif
                     </div>
                 </div>
-                % if data['type'] == 'show':
+                % if data['media_type'] == 'show':
                 <div class='col-md-12'>
                     <div class='table-card-header'>
                         <div class="header-bar">
@@ -261,10 +276,10 @@ DOCUMENTATION :: END
                         </div>
                     </div>
                     <div class='table-card-back'>
-                        <div id="children-list"></div>
+                        <div id="children-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading season list...</div>
                     </div>
                 </div>
-                % elif data['type'] == 'season':
+                % elif data['media_type'] == 'season':
                 <div class='col-md-12'>
                     <div class='table-card-header'>
                         <div class="header-bar">
@@ -272,10 +287,10 @@ DOCUMENTATION :: END
                         </div>
                     </div>
                     <div class='table-card-back'>
-                        <div id="children-list"></div>
+                        <div id="children-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading episode list...</div>
                     </div>
                 </div>
-                % elif data['type'] == 'artist':
+                % elif data['media_type'] == 'artist':
                 <div class='col-md-12'>
                     <div class='table-card-header'>
                         <div class="header-bar">
@@ -283,10 +298,10 @@ DOCUMENTATION :: END
                         </div>
                     </div>
                     <div class='table-card-back'>
-                        <div id="children-list"></div>
+                        <div id="children-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading album list...</div>
                     </div>
                 </div>
-                % elif data['type'] == 'album':
+                % elif data['media_type'] == 'album':
                 <div class='col-md-12'>
                     <div class='table-card-header'>
                         <div class="header-bar">
@@ -294,10 +309,11 @@ DOCUMENTATION :: END
                         </div>
                     </div>
                     <div class='table-card-back'>
-                        <div id="children-list"></div>
+                        <div id="children-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading track list...</div>
                     </div>
                 </div>
                 % endif
+                % endif
                 <div class='col-md-12'>
                     <div class='table-card-header'>
                         <div class="header-bar">
@@ -320,6 +336,7 @@ DOCUMENTATION :: END
                                     <th align='left' id="friendly_name">User</th>
                                     <th align='left' id="ip_address">IP Address</th>
                                     <th align='left' id="platform">Platform</th>
+                                    <th align='left' id="player">Player</th>
                                     <th align='left' id="title">Title</th>
                                     <th align='left' id="started">Started</th>
                                     <th align='left' id="paused_counter">Paused</th>
@@ -361,11 +378,111 @@ DOCUMENTATION :: END
 % else:
 <div class="container-fluid">
     <div class="row">
-        <div class="col-md-10">
-            <h3>
-                Error retrieving item data. This media may not be available in the Plex Media Server database
-                anymore.
-            </h3>
+        <div class="summary-container">
+            <div class="summary-navbar">
+                <div class="col-md-12">
+                    <div class="summary-navbar-list">
+                        <ul class="list-unstyled breadcrumb">
+                            % if query:
+                            % if query['media_type'] == 'movie':
+                            <li><a href="info?item_id=movie">Movies</a></li>
+                            <li class="active">${query['title']}</li>
+                            % elif query['media_type'] == 'show':
+                            <li><a href="info?item_id=show">TV Shows</a></li>
+                            <li class="active">${query['grandparent_title']}</li>
+                            % elif query['media_type'] == 'season':
+                            <li class="hidden-xs hidden-sm"><a href="info?item_id=show">TV Shows</a></li>
+                            <li class="hidden-xs hidden-sm">${query['grandparent_title']}</li>
+                            <li class="active">Season ${query['parent_media_index']}</li>
+                            % elif query['media_type'] == 'episode':
+                            <li class="hidden-xs hidden-sm"><a href="info?item_id=show">TV Shows</a></li>
+                            <li class="hidden-xs hidden-sm">${query['grandparent_title']}</li>
+                            <li>Season ${query['parent_media_index']}</li>
+                            <li class="active">Episode ${query['media_index']} - ${query['title']}</li>
+                            % elif query['media_type'] == 'artist':
+                            <li><a href="info?item_id=artist">Music</a></li>
+                            <li class="active">${query['grandparent_title']}</li>
+                            % elif query['media_type'] == 'album':
+                            <li class="hidden-xs hidden-sm"><a href="info?item_id=artist">Music</a></li>
+                            <li>${query['grandparent_title']}</li>
+                            <li class="active">${query['parent_title']}</li>
+                            % elif query['media_type'] == 'track':
+                            <li class="hidden-xs hidden-sm"><a href="info?item_id=artist">Music</a></li>
+                            <li class="hidden-xs hidden-sm">${query['grandparent_title']}</li>
+                            <li>${query['parent_title']}</li>
+                            <li class="active">Track ${query['media_index']} - ${query['title']}</li>
+                            % endif
+                            % endif
+                        </ul>
+                    </div>
+                </div>
+            </div>
+            <div class="summary-content-title-wrapper">
+                <div class="col-md-12">
+                    <h4 style="text-align: center; margin-bottom: 20px;">
+                        Error retrieving item metadata. This media item is not available in the Plex Media Server library.
+                    </h4>
+                    % if query:
+                    <h4 style="text-align: center; margin-bottom: 20px;">
+                        If the item has been moved, please select the correct match below to update the PlexPy database.
+                    </h4>
+                    % endif
+                </div>
+            </div>
+            <div class="summary-content-wrapper">
+                <div class='col-md-12'>
+                    % if query:
+                    <div class='table-card-header'>
+                        <div class="header-bar">
+                            <span>Search Results for <strong>${query['query_string']}</strong></span>
+                        </div>
+                    </div>
+                    <div class='table-card-back'>
+                        <div id="search-results-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading search results...</div>
+                    </div>
+                    <div class="modal fade" id="confirm-modal" tabindex="-1" role="dialog" aria-labelledby="confirm-modal">
+                        <div class="modal-dialog">
+                            <div class="modal-content">
+                                <div class="modal-header">
+                                    <button type="button" class="close" data-dismiss="modal" aria-hidden="true"><i class="fa fa-remove"></i></button>
+                                    <h4 class="modal-title" id="myModalLabel">Confirm Update</h4>
+                                </div>
+                                <div class="modal-body" style="text-align: center;">
+                                    <p>Are you REALLY sure you want to replace
+                                    <p><strong>
+                                        % if query['media_type'] == 'movie':
+                                        ${query['title']}<br />${query['year']}
+                                        % elif query['media_type'] == 'show':
+                                        ${query['grandparent_title']}
+                                        % elif query['media_type'] == 'season':
+                                        ${query['grandparent_title']}<br />S${query['parent_media_index']}
+                                        % elif query['media_type'] == 'episode':
+                                        ${query['grandparent_title']}<br />${query['title']}<br />S${query['parent_media_index']} &middot; E${query['media_index']}
+                                        % elif query['media_type'] == 'artist':
+                                        ${query['grandparent_title']}
+                                        % elif query['media_type'] == 'album':
+                                        ${query['grandparent_title']}<br />${query['parent_title']}
+                                        % elif query['media_type'] == 'track':
+                                        ${query['grandparent_title']}<br />${query['title']}<br />${query['parent_title']}
+                                        % endif
+                                        </strong></p>
+                                    <p> with </p>
+                                    <p><span id="new_title"></span></p>
+                                    % if query['media_type'] != 'movie':
+                                    <p>All items for <strong>${query['grandparent_title']}</strong> will also be updated.</p>
+                                    % endif
+                                    <p>This is permanent and cannot be undone!</p>
+                                </div>
+                                <div class="modal-footer">
+                                    <button type="button" class="btn btn-dark" data-dismiss="modal">Cancel</button>
+                                    <button type="button" class="btn btn-danger btn-ok" data-dismiss="modal" id="confirm-update">Update</button>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                    % endif
+                </div>
+            </div>
         </div>
     </div>
 </div>
@@ -381,49 +498,55 @@ DOCUMENTATION :: END
 <script src="interfaces/default/js/moment-with-locale.js"></script>
 
 % if data:
-% if data['type'] == 'movie' or data['type'] == 'show' or data['type'] == 'episode':
-<script>
-    // Convert rating to 5 star rating type
-    var starRating = Math.round(${data['rating']} / 2);
-    $('#stars').attr('data-rateit-value', starRating);
-</script>
-% endif
 <script src="interfaces/default/js/tables/history_table.js"></script>
-% if data['type'] == 'show' or data['type'] == 'artist':
+% if data['media_type'] == 'library':
 <script>
     function get_history() {
         history_table_options.ajax = {
-            "url": "get_history",
+            url: 'get_history',
             type: 'post',
             data: function ( d ) {
                 return { 'json_data': JSON.stringify( d ),
-                    'grandparent_rating_key': ${data['rating_key']} };
+                    'media_type': "${data['media_type_filter']}" };
             }
         }
     }
 </script>
-% elif data['type'] == 'season' or data['type'] == 'album':
+% elif data['media_type'] == 'show' or data['media_type'] == 'artist':
 <script>
     function get_history() {
         history_table_options.ajax = {
-            "url": "get_history",
+            url: 'get_history',
             type: 'post',
             data: function ( d ) {
                 return { 'json_data': JSON.stringify( d ),
-                    'parent_rating_key': ${data['rating_key']} };
+                    'grandparent_rating_key': "${data['rating_key']}" };
             }
         }
     }
 </script>
-% elif data['type'] == 'episode' or data['type'] == 'track' or data['type'] == 'movie':
+% elif data['media_type'] == 'season' or data['media_type'] == 'album':
 <script>
     function get_history() {
         history_table_options.ajax = {
-            "url": "get_history",
+            url: 'get_history',
             type: 'post',
             data: function ( d ) {
                 return { 'json_data': JSON.stringify( d ),
-                    'rating_key': ${data['rating_key']} };
+                    'parent_rating_key': "${data['rating_key']}" };
+            }
+        }
+    }
+</script>
+% elif data['media_type'] == 'episode' or data['media_type'] == 'track' or data['media_type'] == 'movie':
+<script>
+    function get_history() {
+        history_table_options.ajax = {
+            url: 'get_history',
+            type: 'post',
+            data: function ( d ) {
+                return { 'json_data': JSON.stringify( d ),
+                    'rating_key': "${data['rating_key']}" };
             }
         }
     }
@@ -433,7 +556,7 @@ DOCUMENTATION :: END
     $(document).ready(function () {
         get_history();
         history_table = $('#history_table').DataTable(history_table_options);
-        var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 10] });
+        var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 11] });
         $(colvis.button()).appendTo('div.colvis-button-bar');
 
         clearSearchButton('history_table', history_table);
@@ -476,11 +599,11 @@ DOCUMENTATION :: END
         });
     });
 </script>
-% if data['type'] == 'show' or data['type'] == 'season' or data['type'] == 'artist' or data['type'] == 'album':
+% if data['media_type'] == 'show' or data['media_type'] == 'season' or data['media_type'] == 'artist' or data['media_type'] == 'album':
 <script>
     $.ajax({
         url: 'get_item_children',
-        type: "GET",
+        type: 'GET',
         async: true,
         data: { rating_key : ${data['rating_key']} },
         complete: function(xhr, status) {
@@ -488,10 +611,66 @@ DOCUMENTATION :: END
     });
 </script>
 % endif
+% if data['media_type'] != 'library':
+<!--
+<script>
+    $('#row-edit-mode').after('<a href="info?item_id=${data['rating_key']}" class="btn btn-danger btn-edit" id="fix-metadata" \
+        data-toggle="tooltip" data-placement="left" title="Fix metadata if the item was moved in Plex"><i class="fa fa-wrench"></i> Fix Metadata</a>');
+    $('#fix-metadata').tooltip();
+</script>
+-->
+% endif
+% if data['media_type'] != 'library' and data['rating']:
+<script>
+    // Convert rating to 5 star rating type
+    var starRating = Math.round(${data['rating']} / 2);
+    $('#stars').attr('data-rateit-value', starRating);
+</script>
+% endif
 <script>
     $("#airdate").html(moment($("#airdate").text()).format('MMM DD, YYYY'));
     $("#runtime").html(millisecondsToMinutes($("#runtime").text(), true));
     $('div.art-face').animate({ opacity: 0.2 }, { duration: 1000 });
 </script>
+% elif query:
+<script>
+    $.ajax({
+        url: 'get_search_results_children',
+        type: 'GET',
+        async: true,
+        data: {'query': "${query['query_string'].replace('"','\\"')}",
+               'media_type': "${query['media_type']}",
+               'season_index': "${query['parent_media_index']}"
+        },
+        complete: function(xhr, status) {
+        $("#search-results-list").html(xhr.responseText); }
+    });
+    $(document).on('click', '#search-results-list a', function (e) {
+        e.preventDefault();
+        var new_rating_key = $(this).attr("id");
+        var new_href = $(this).attr("href");
+
+        $('#new_title').html($(this).find('.item-children-instance-text-wrapper').html());
+
+        $('#confirm-modal').modal();
+        $('#confirm-modal').one('click', '#confirm-update', function () {
+            $(this).prop('disabled', true);
+            var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspUpdating database..."
+            showMsg(msg, false, false, 0)
+
+            $.ajax({
+                url: 'update_history_rating_key',
+                data: { old_rating_key: "${query['rating_key']}",
+                    new_rating_key: new_rating_key,
+                    media_type: "${query['media_type']}"
+                    },
+                async: true,
+                success: function (data) {
+                    window.location.href = new_href;
+                }
+            });
+        });
+    });
+</script>
 % endif
 </%def>

data/interfaces/default/info_children_list.html

@@ -63,14 +63,14 @@ DOCUMENTATION :: END
                     </div>
                 </div>
                 <div class="item-children-instance-text-wrapper episode-item">
-                    <h3>${child['title']}</h3>
+                    <h3 title="${child['title']}">${child['title']}</h3>
                 </div>
                 % elif data['children_type'] == 'album':
                 <div class="item-children-poster">
                     <div class="item-children-poster-face album-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=300);"></div>
                 </div>
                 <div class="item-children-instance-text-wrapper album-item">
-                    <h3>${child['title']}</h3>
+                    <h3 title="${child['title']}">${child['title']}</h3>
                 </div>
                 % elif data['children_type'] == 'track':
                     % if loop.index % 2 == 0:

data/interfaces/default/info_search_results_list.html

@@ -0,0 +1,224 @@
+<%doc>
+USAGE DOCUMENTATION :: PLEASE LEAVE THIS AT THE TOP OF THIS FILE
+
+For Mako templating syntax documentation please visit: http://docs.makotemplates.org/en/latest/
+
+Filename:           info_children_list.html
+Version:            0.1
+Variable names:     data [list]
+
+data :: Usable parameters
+
+== Global keys ==
+results_count           Returns the number of search results.
+results_list            Returns a dictionary of search result types.
+
+data['results_list'] :: Usable paramaters
+
+== media_type keys ==
+movie                   Returns an array of movie results
+show                    Returns an array of show results
+season                  Returns an array of season results
+episode                 Returns an array of episode results
+artist                  Returns an array of artist results
+album                   Returns an array of album results
+track                   Returns an array of track results
+
+data['results_list'][media_type] :: Usable paramaters
+
+== Global keys ==
+rating_key              Returns the unique identifier for the media item.
+type                    Returns the type of media. Either 'movie', 'show', 'season', 'episode', 'artist', 'album', or 'track'.
+art                     Returns the location of the item's artwork
+title                   Returns the name of the movie, show, episode, artist, album, or track.
+duration                Returns the standard runtime of the media.
+content_rating          Returns the age rating for the media.
+summary                 Returns a brief description of the media plot.
+grandparent_title       Returns the name of the show, or artist.
+parent_index            Returns the index number of the season.
+index                   Returns the index number of the episode, or track.
+parent_thumb            Returns the location of the item's thumbnail. Use with pms_image_proxy.
+writers                 Returns an array of writers.
+thumb                   Returns the location of the item's thumbnail. Use with pms_image_proxy.
+parent_title            Returns the name of the show, or artist.
+rating                  Returns the 5 star rating value for the movie. Between 1 and 5.
+year                    Returns the release year of the movie, or show.
+genres                  Returns an array of genres.
+actors                  Returns an array of actors.
+directors               Returns an array of directors.
+studio                  Returns the name of the studio.
+originally_available_at Returns the air date of the item.
+
+DOCUMENTATION :: END
+</%doc>
+
+% if data != None:
+% if data['results_count'] > 0:
+% if 'movie' in data['results_list'] and data['results_list']['movie']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Movies</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['movie']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face season-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=450);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper season-item">
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                    <h3 class="text-muted">${child['year']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'show' in data['results_list'] and data['results_list']['show']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>TV Shows</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['show']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face season-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=450);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper season-item">
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                    <h3 class="text-muted">${child['year']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'season' in data['results_list'] and data['results_list']['season']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Seasons</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['season']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face season-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=450);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper season-item">
+                    <h3 title="${child['parent_title']}">${child['parent_title']}</h3>
+                    <h3 class="text-muted">S${child['index']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'episode' in data['results_list'] and data['results_list']['episode']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Episodes</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['episode']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face episode-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=450);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper episode-item">
+                    <h3 title="${child['grandparent_title']}">${child['grandparent_title']}</h3>
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                    <h3 class="text-muted">S${child['parent_index']} &middot; E${child['index']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'artist' in data['results_list'] and data['results_list']['artist']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Artists</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['artist']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face album-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=300);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper album-item">
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'album' in data['results_list'] and data['results_list']['album']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Albums</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['album']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face album-poster" style="background-image: url(pms_image_proxy?img=${child['thumb']}&width=300&height=300);"></div>
+                </div>
+                <div class="item-children-instance-text-wrapper album-item">
+                    <h3 title="${child['parent_title']}">${child['parent_title']}</h3>
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% if 'track' in data['results_list'] and data['results_list']['track']:
+<div class="item-children-wrapper">
+    <div class="item-children-section-title">
+        <h4>Tracks</h4>
+    </div>
+    <ul class="item-children-instance list-unstyled">
+        % for child in data['results_list']['track']:
+        <li>
+            <a href="info?item_id=${child['rating_key']}" id="${child['rating_key']}">
+                <div class="item-children-poster">
+                    <div class="item-children-poster-face album-poster" style="background-image: url(pms_image_proxy?img=${child['parent_thumb']}&width=300&height=300);">
+                        <div class="item-children-card-overlay">
+                            <div class="item-children-overlay-text">
+                                Track ${child['index']}
+                            </div>
+                        </div>
+                    </div>
+                </div>
+                <div class="item-children-instance-text-wrapper album-item">
+                    <h3 title="${child['grandparent_title']}">${child['grandparent_title']}</h3>
+                    <h3 title="${child['title']}">${child['title']}</h3>
+                    <h3 title="${child['parent_title']}" class="text-muted">${child['parent_title']}</h3>
+                </div>
+            </a>
+        </li>
+        % endfor
+    </ul>
+</div>
+% endif
+% else:
+<div class="item-children-wrapper">
+    No search results found.
+</div>
+% endif
+% endif
+

data/interfaces/default/ip_address_modal.html

@@ -17,8 +17,8 @@
                 <h4><strong>Location Details</strong></h4>
                 <ul class="list-unstyled">
                     <li>Country: <strong><span id="country"></span></strong></li>
-                    <li>City: <strong><span id="city"></span></strong></li>
                     <li>Region: <strong><span id="region"></span></strong></li>
+                    <li>City: <strong><span id="city"></span></strong></li>
                     <li>Timezone: <strong><span id="timezone"></span></strong></li>
                     <li>Latitude: <strong><span id="lat"></span></strong></li>
                     <li>Longitude: <strong><span id="lon"></span></strong></li>
@@ -27,14 +27,12 @@
             <div class="col-md-6">
                 <h4><strong>Connection Details</strong></h4>
                 <ul class="list-unstyled">
-                    <li>ISP: <strong><span id="isp"></span></strong></li>
-                    <li>Organization: <strong><span id="org"></span></strong></li>
-                    <li>AS: <strong><span id="as"></span></strong></li>
+                    <li>Organization: <strong><span id="organization"></span></strong></li>
                 </ul>
             </div>
         </div>
         <div class="modal-footer">
-            <span class="text-muted">Service provided by ip-api.com.</span>
+            <span class="text-muted">Telize service written by <a href="https://github.com/fcambus/telize" target="_blank">Frederic Cambus</a>.</span>
         </div>
     </div>
 </div>
@@ -43,7 +41,7 @@
 <script>
     function getUserLocation(ip_address) {
         $.ajax({
-            url: 'http://ip-api.com/json/' + ip_address,
+            url: 'https://telize.myhtpc.co.za/geoip/' + ip_address,
             cache: true,
             async: true,
             type: 'GET',
@@ -55,13 +53,11 @@
                 $('#modal_header_ip_address').html('<i class="fa fa-map-marker"></i> IP Address: ' + ip_address);
                 $('#country').html(data.country);
                 $('#city').html(data.city);
-                $('#region').html(data.regionName);
+                $('#region').html(data.region);
                 $('#timezone').html(data.timezone);
-                $('#lat').html(data.lat);
-                $('#lon').html(data.lon);
-                $('#isp').html(data.isp);
-                $('#org').html(data.org);
-                $('#as').html(data.as);
+                $('#lat').html(data.latitude);
+                $('#lon').html(data.longitude);
+                $('#organization').html(data.organization);
             },
             timeout: 5000
         });

data/interfaces/default/js/script.js

@@ -176,7 +176,9 @@ function getPlatformImagePath(platformName) {
     if (platformName.indexOf("Roku") > -1) {
         return 'interfaces/default/images/platforms/roku.png';
     } else if (platformName.indexOf("Apple TV") > -1) {
-        return 'interfaces/default/images/platforms/appletv.png';
+        return 'interfaces/default/images/platforms/atv.png';
+    } else if (platformName.indexOf("tvOS") > -1) {
+        return 'interfaces/default/images/platforms/atv.png';
     } else if (platformName.indexOf("Firefox") > -1) {
         return 'interfaces/default/images/platforms/firefox.png';
     } else if (platformName.indexOf("Chromecast") > -1) {
@@ -201,6 +203,8 @@ function getPlatformImagePath(platformName) {
         return 'interfaces/default/images/platforms/safari.png';
     } else if (platformName.indexOf("Internet Explorer") > -1) {
         return 'interfaces/default/images/platforms/ie.png';
+    } else if (platformName.indexOf("Microsoft Edge") > -1) {
+        return 'interfaces/default/images/platforms/msedge.png';
     } else if (platformName.indexOf("Unknown Browser") > -1) {
         return 'interfaces/default/images/platforms/dafault.png';
     } else if (platformName.indexOf("Windows-XBMC") > -1) {
@@ -213,24 +217,28 @@ function getPlatformImagePath(platformName) {
         return 'interfaces/default/images/platforms/opera.png';
     } else if (platformName.indexOf("KODI") > -1) {
         return 'interfaces/default/images/platforms/kodi.png';
-    } else if (platformName.indexOf("Mystery 3") > -1) {
+    } else if (platformName.indexOf("Playstation 3") > -1) {
         return 'interfaces/default/images/platforms/playstation.png';
-    } else if (platformName.indexOf("Mystery 4") > -1) {
+    } else if (platformName.indexOf("Playstation 4") > -1) {
         return 'interfaces/default/images/platforms/playstation.png';
-	} else if (platformName.indexOf("Mystery 5") > -1) {
+    } else if (platformName.indexOf("Xbox 360") > -1) {
         return 'interfaces/default/images/platforms/xbox.png';
-	} else if (platformName.indexOf("Windows") > -1) {
-	    return 'interfaces/default/images/platforms/win8.png';
-	} else if (platformName.indexOf("Windows phone") > -1) {
-	    return 'interfaces/default/images/platforms/wp.png';
-	} else {
+    } else if (platformName.indexOf("Windows") > -1) {
+        return 'interfaces/default/images/platforms/win8.png';
+    } else if (platformName.indexOf("Windows phone") > -1) {
+        return 'interfaces/default/images/platforms/wp.png';
+	} else if (platformName.indexOf("Plex Media Player") > -1) {
+        return 'interfaces/default/images/platforms/pmp.png';
+    } else {
         return 'interfaces/default/images/platforms/default.png';
     }
 }
 
 function isPrivateIP(ip_address) {
     if (ip_address.indexOf(".") > -1) {
-        var parts = ip_address.split('.');
+        // get IPv4 mapped address (xxx.xxx.xxx.xxx) from IPv6 addresss (::ffff:xxx.xxx.xxx.xxx)
+        var parts = ip_address.split(":");
+        var parts = parts[parts.length - 1].split('.');
         if (parts[0] === '10' ||
             (parts[0] === '172' && (parseInt(parts[1], 10) >= 16 && parseInt(parts[1], 10) <= 31)) ||
             (parts[0] === '192' && parts[1] === '168')) {

data/interfaces/default/js/tables/history_table.js

@@ -18,7 +18,7 @@ history_table_options = {
         "lengthMenu":"Show _MENU_ entries per page",
         "info":"Showing _START_ to _END_ of _TOTAL_ history items",
         "infoEmpty":"Showing 0 to 0 of 0 entries",
-        "infoFiltered":"(filtered from _MAX_ total entries)",
+        "infoFiltered":"<span class='hidden-md hidden-sm hidden-xs'>(filtered from _MAX_ total entries)</span>",
         "emptyTable": "No data in table"
     },
     "pagingType": "bootstrap",
@@ -46,13 +46,18 @@ history_table_options = {
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (rowData['stopped'] === null) {
                     $(td).html('Currently watching...');
+                } else if (rowData['group_count'] > 1) {
+                    date = moment(cellData, "X").format(date_format);
+                    expand_history = '<span class="expand-history-tooltip" data-toggle="tooltip" title="Show Detailed History"><i class="fa fa-plus-circle fa-fw"></i></span>';
+                    $(td).html('<div><a href="#"><div style="float: left;">' + expand_history + '&nbsp;' + date + '</div></a></div>');
                 } else {
-                    $(td).html(moment(cellData,"X").format(date_format));
+                    date = moment(cellData, "X").format(date_format);
+                    $(td).html('<div style="float: left;"><i class="fa fa-fw"></i>&nbsp;' + date + '</div>');
                 }
             },
             "searchable": false,
             "width": "8%",
-            "className": "no-wrap"
+            "className": "no-wrap expand-history"
         },
         {
             "targets": [2],
@@ -83,7 +88,8 @@ history_table_options = {
                             $(td).html('n/a');
                         }
                     } else {
-                        $(td).html('<a href="javascript:void(0)" data-toggle="modal" data-target="#ip-info-modal"><i class="fa fa-map-marker"></i>&nbsp' + cellData + '</a>');
+                        external_ip = '<span class="external-ip-tooltip" data-toggle="tooltip" title="External IP"><i class="fa fa-map-marker fa-fw"></i></span>';
+                        $(td).html('<a href="javascript:void(0)" data-toggle="modal" data-target="#ip-info-modal">'+ external_ip + cellData + '</a>');
                     }
                 } else {
                     $(td).html('n/a');
@@ -94,25 +100,36 @@ history_table_options = {
         },
         {
             "targets": [4],
-            "data":"player",
+            "data":"platform",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData !== '') {
-                    var transcode_dec = '';
-                    if (rowData['video_decision'] === 'transcode') {
-                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Transcode"><i class="fa fa-server fa-fw"></i></span>';
-                    } else if (rowData['video_decision'] === 'copy') {
-                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Stream"><i class="fa fa-video-camera fa-fw"></i></span>';
-                    } else if (rowData['video_decision'] === 'direct play' || rowData['video_decision'] === '') {
-                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Play"><i class="fa fa-play-circle fa-fw"></i></span>';
-                    }
-                    $(td).html('<div><a href="#" data-target="#info-modal" data-toggle="modal"><div style="float: left;">' + transcode_dec + '&nbsp' + cellData + '</div></a></div>');
+                    $(td).html(cellData);
                 }
             },
-            "width": "15%",
+            "width": "8%",
             "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
         },
         {
             "targets": [5],
+            "data": "player",
+            "createdCell": function (td, cellData, rowData, row, col) {
+                if (cellData !== '') {
+                    var transcode_dec = '';
+                    if (rowData['video_decision'] === 'transcode' || rowData['audio_decision'] === 'transcode') {
+                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Transcode"><i class="fa fa-server fa-fw"></i></span>';
+                    } else if (rowData['video_decision'] === 'copy' || rowData['audio_decision'] === 'copy') {
+                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Stream"><i class="fa fa-video-camera fa-fw"></i></span>';
+                    } else if (rowData['video_decision'] === 'direct play' || rowData['audio_decision'] === 'direct play') {
+                        transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Play"><i class="fa fa-play-circle fa-fw"></i></span>';
+                    }
+                    $(td).html('<div><a href="#" data-target="#info-modal" data-toggle="modal"><div style="float: left;">' + transcode_dec + '&nbsp;' + cellData + '</div></a></div>');
+                }
+            },
+            "width": "12%",
+            "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
+        },
+        {
+            "targets": [6],
             "data":"full_title",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData !== '') {
@@ -121,16 +138,16 @@ history_table_options = {
                     if (rowData['media_type'] === 'movie') {
                         media_type = '<span class="media-type-tooltip" data-toggle="tooltip" title="Movie"><i class="fa fa-film fa-fw"></i></span>';
                         thumb_popover = '<span class="thumb-tooltip" data-toggle="popover" data-img="pms_image_proxy?img=' + rowData['thumb'] + '&width=300&height=450&fallback=poster" data-height="120">' + cellData + ' (' + rowData['year'] + ')</span>'
-                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;">' + media_type + '&nbsp' + thumb_popover + '</div></a></div>');
+                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;">' + media_type + '&nbsp;' + thumb_popover + '</div></a></div>');
                     } else if (rowData['media_type'] === 'episode') {
                         media_type = '<span class="media-type-tooltip" data-toggle="tooltip" title="Episode"><i class="fa fa-television fa-fw"></i></span>';
                         thumb_popover = '<span class="thumb-tooltip" data-toggle="popover" data-img="pms_image_proxy?img=' + rowData['thumb'] + '&width=300&height=450&fallback=poster" data-height="120">' + cellData + ' \
                             (S' + rowData['parent_media_index'] + '&middot; E' + rowData['media_index'] + ')</span>'
-                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;" >' + media_type + '&nbsp' + thumb_popover + '</div></a></div>');
+                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;" >' + media_type + '&nbsp;' + thumb_popover + '</div></a></div>');
                     } else if (rowData['media_type'] === 'track') {
                         media_type = '<span class="media-type-tooltip" data-toggle="tooltip" title="Track"><i class="fa fa-music fa-fw"></i></span>';
                         thumb_popover = '<span class="thumb-tooltip" data-toggle="popover" data-img="pms_image_proxy?img=' + rowData['thumb'] + '&width=300&height=300&fallback=poster" data-height="80">' + cellData + ' (' + rowData['parent_title'] + ')</span>'
-                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;">' + media_type + '&nbsp' + thumb_popover + '</div></a></div>');
+                        $(td).html('<div class="history-title"><a href="info?source=history&item_id=' + rowData['id'] + '"><div style="float: left;">' + media_type + '&nbsp;' + thumb_popover + '</div></a></div>');
                     } else {
                         $(td).html('<a href="info?item_id=' + rowData['id'] + '">' + cellData + '</a>');
                     }
@@ -139,7 +156,7 @@ history_table_options = {
             "width": "35%"
         },
         {
-            "targets": [6],
+            "targets": [7],
             "data":"started",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData === null) {
@@ -153,9 +170,9 @@ history_table_options = {
             "className": "no-wrap hidden-sm hidden-xs"
         },
         {
-            "targets": [7],
+            "targets": [8],
             "data":"paused_counter",
-            "render": function ( data, type, full ) {
+            "render": function (data, type, full) {
                 if (data !== null) {
                     return Math.round(moment.duration(data, 'seconds').as('minutes')) + ' mins';
                 } else {
@@ -167,7 +184,7 @@ history_table_options = {
             "className": "no-wrap hidden-md hidden-sm hidden-xs"
         },
         {
-            "targets": [8],
+            "targets": [9],
             "data":"stopped",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData === null) {
@@ -181,9 +198,9 @@ history_table_options = {
             "className": "no-wrap hidden-sm hidden-xs"
         },
         {
-            "targets": [9],
+            "targets": [10],
             "data":"duration",
-            "render": function ( data, type, full ) {
+            "render": function (data, type, full) {
                 if (data !== null) {
                     return Math.round(moment.duration(data, 'seconds').as('minutes')) + ' mins';
                 } else {
@@ -195,15 +212,15 @@ history_table_options = {
             "className": "no-wrap hidden-xs"
         },
         {
-            "targets": [10],
-            "data":"percent_complete",
-            "render": function ( data, type, full ) {
-                if (data > 80) {
-                    return '<span class="watched-tooltip" data-toggle="tooltip" title="Watched"><i class="fa fa-lg fa-circle"></i></span>'
-                } else if (data > 40) {
-                    return '<span class="watched-tooltip" data-toggle="tooltip" title="Partial"><i class="fa fa-lg fa-adjust fa-rotate-180"></i></span>'
+            "targets": [11],
+            "data": "watched_status",
+            "createdCell": function (td, cellData, rowData, row, col) {
+                if (cellData == 1) {
+                    $(td).html('<span class="watched-tooltip" data-toggle="tooltip" title="' + rowData['percent_complete'] + '%"><i class="fa fa-lg fa-circle"></i></span>');
+                } else if (cellData == 0.5) {
+                    $(td).html('<span class="watched-tooltip" data-toggle="tooltip" title="' + rowData['percent_complete'] + '%"><i class="fa fa-lg fa-adjust fa-rotate-180"></i></span>');
                 } else {
-                    return '<span class="watched-tooltip" data-toggle="tooltip" title="Unwatched"><i class="fa fa-lg fa-circle-o"></i></span>'
+                    $(td).html('<span class="watched-tooltip" data-toggle="tooltip" title="' + rowData['percent_complete'] + '%"><i class="fa fa-lg fa-circle-o"></i></span>');
                 }
             },
             "searchable": false,
@@ -218,11 +235,14 @@ history_table_options = {
         $('#ajaxMsg').fadeOut();
 
         // Create the tooltips.
-        $('.transcode-tooltip').tooltip();
-        $('.media-type-tooltip').tooltip();
-        $('.watched-tooltip').tooltip();
+        $('.expand-history-tooltip').tooltip({ container: 'body' });
+        $('.external-ip-tooltip').tooltip({ container: 'body' });
+        $('.transcode-tooltip').tooltip({ container: 'body' });
+        $('.media-type-tooltip').tooltip({ container: 'body' });
+        $('.watched-tooltip').tooltip({ container: 'body' });
         $('.thumb-tooltip').popover({
             html: true,
+            container: 'body',
             trigger: 'hover',
             placement: 'right',
             content: function () {
@@ -231,24 +251,60 @@ history_table_options = {
         });
 
         if ($('#row-edit-mode').hasClass('active')) {
-            $('.delete-control').each(function() {
+            $('.delete-control').each(function () {
                 $(this).removeClass('hidden');
             });
         }
+
+        history_table.rows().every(function () {
+            var rowData = this.data();
+            if (rowData['group_count'] != 1 && rowData['reference_id'] in history_child_table) {
+                // if grouped row and a child table was already created
+                $(this.node()).find('i.fa').toggleClass('fa-plus-circle').toggleClass('fa-minus-circle');
+                this.child(childTableFormat(rowData)).show();
+                createChildTable(this, rowData)
+            }
+        });
+
+        $("#history_table_info").append('<span class="hidden-md hidden-sm hidden-xs"> with a duration of ' + settings.json.filter_duration +
+            ' (filtered from ' + settings.json.total_duration + ' total)</span>');
     },
     "preDrawCallback": function(settings) {
-        var msg = "<div class='msg'><i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...</div>";
+        var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...";
         showMsg(msg, false, false, 0)
     },
-    "rowCallback": function (row, rowData) {
-        if ($.inArray(rowData['id'], history_to_delete) !== -1) {
+    "rowCallback": function (row, rowData, rowIndex) {
+        if (rowData['group_count'] == 1) {
+            // if no grouped rows simply toggle the delete button
+            if ($.inArray(rowData['id'], history_to_delete) !== -1) {
+                $(row).find('button[data-id="' + rowData['id'] + '"]').toggleClass('btn-warning').toggleClass('btn-danger');
+            }
+        } else {
+            // if grouped rows
+            // toggle the parent button to danger
             $(row).find('button[data-id="' + rowData['id'] + '"]').toggleClass('btn-warning').toggleClass('btn-danger');
+            // check if any child rows are not selected
+            var group_ids = rowData['group_ids'].split(',').map(Number);
+            group_ids.forEach(function (id) {
+                var index = $.inArray(id, history_to_delete);
+                if (index == -1) {
+                    $(row).find('button[data-id="' + rowData['id'] + '"]').addClass('btn-warning').removeClass('btn-danger');
+                }
+            });
         }
+
+        if (rowData['group_count'] != 1 && rowData['reference_id'] in history_child_table) {
+            // if grouped row and a child table was already created
+            $(row).addClass('shown')
+            history_table.row(row).child(childTableFormat(rowData)).show();
+        }
+
     }
 }
 
-$('#history_table').on('click', 'td.modal-control', function () {
-    var tr = $(this).parents('tr');
+// Parent table platform modal
+$('#history_table').on('click', '> tbody > tr > td.modal-control', function () {
+    var tr = $(this).closest('tr');
     var row = history_table.row( tr );
     var rowData = row.data();
 
@@ -266,8 +322,9 @@ $('#history_table').on('click', 'td.modal-control', function () {
     showStreamDetails();
 });
 
-$('#history_table').on('click', 'td.modal-control-ip', function () {
-    var tr = $(this).parents('tr');
+// Parent table ip address modal
+$('#history_table').on('click', '> tbody > tr > td.modal-control-ip', function () {
+    var tr = $(this).closest('tr');
     var row = history_table.row( tr );
     var rowData = row.data();
 
@@ -288,16 +345,239 @@ $('#history_table').on('click', 'td.modal-control-ip', function () {
     getUserLocation(rowData['ip_address']);
 });
 
-$('#history_table').on('click', 'td.delete-control > button', function () {
-    var tr = $(this).parents('tr');
+// Parent table delete mode
+$('#history_table').on('click', '> tbody > tr > td.delete-control > button', function () {
+    var tr = $(this).closest('tr');
     var row = history_table.row( tr );
     var rowData = row.data();
 
-    var index = $.inArray(rowData['id'], history_to_delete);
-    if (index === -1) {
-        history_to_delete.push(rowData['id']);
+    if (rowData['group_count'] == 1) {
+        // if no grouped rows simply add or remove row from history_to_delete
+        var index = $.inArray(rowData['id'], history_to_delete);
+        if (index === -1) {
+            history_to_delete.push(rowData['id']);
+        } else {
+            history_to_delete.splice(index, 1);
+        }
+        $(this).toggleClass('btn-warning').toggleClass('btn-danger');
     } else {
-        history_to_delete.splice(index, 1);
+        // if grouped rows
+        if ($(this).hasClass('btn-warning')) {
+            // add all grouped rows to history_to_delete
+            var group_ids = rowData['group_ids'].split(',').map(Number);
+            group_ids.forEach(function (id) {
+                var index = $.inArray(id, history_to_delete);
+                if (index == -1) {
+                    history_to_delete.push(id);
+                }
+            });
+            $(this).toggleClass('btn-warning').toggleClass('btn-danger');
+            if (row.child.isShown()) {
+                // if child table is visible, toggle all child buttons to danger
+                tr.next().find('td.delete-control > button.btn-warning').toggleClass('btn-warning').toggleClass('btn-danger');
+            }
+        } else {
+            // remove all grouped rows to history_to_delete
+            var group_ids = rowData['group_ids'].split(',').map(Number);
+            group_ids.forEach(function (id) {
+                var index = $.inArray(id, history_to_delete);
+                if (index != -1) {
+                    history_to_delete.splice(index, 1);
+                }
+            });
+            $(this).toggleClass('btn-warning').toggleClass('btn-danger');
+            if (row.child.isShown()) {
+                // if child table is visible, toggle all child buttons to warning
+                tr.next().find('td.delete-control > button.btn-danger').toggleClass('btn-warning').toggleClass('btn-danger');
+            }
+        }
     }
-    $(this).toggleClass('btn-warning').toggleClass('btn-danger');
-});
+});
+
+// Parent table expand detailed history
+$('#history_table').on('click', '> tbody > tr > td.expand-history a', function () {
+    var tr = $(this).closest('tr');
+    var row = history_table.row(tr);
+    var rowData = row.data();
+    
+    $(this).find('i.fa').toggleClass('fa-plus-circle').toggleClass('fa-minus-circle');
+
+    if (row.child.isShown()) {
+        $('div.slider', row.child()).slideUp(function () {
+            row.child.hide();
+            tr.removeClass('shown');
+            delete history_child_table[rowData['reference_id']];
+        });
+    } else {
+        tr.addClass('shown');
+        row.child(childTableFormat(rowData)).show();
+        createChildTable(row, rowData);
+    }
+});
+
+
+// Initialize the detailed history child table options using the parent table options
+function childTableOptions(rowData) {
+    history_child_options = history_table_options;
+    // Remove settings that are not necessary
+    history_child_options.searching = false;
+    history_child_options.lengthChange = false;
+    history_child_options.info = false;
+    history_child_options.pageLength = 10;
+    history_child_options.bStateSave = false;
+    history_child_options.ajax = {
+        "url": "get_history",
+        type: "post",
+        data: function (d) {
+            return {
+                'json_data': JSON.stringify(d),
+                'grouping': false,
+                'reference_id': rowData['reference_id']
+            };
+        }
+    }
+    history_child_options.fnDrawCallback = function (settings) {
+        $('#ajaxMsg').fadeOut();
+
+        // Create the tooltips.
+        $('.expand-history-tooltip').tooltip({ container: 'body' });
+        $('.external-ip-tooltip').tooltip();
+        $('.transcode-tooltip').tooltip();
+        $('.media-type-tooltip').tooltip();
+        $('.watched-tooltip').tooltip();
+        $('.thumb-tooltip').popover({
+            html: true,
+            trigger: 'hover',
+            placement: 'right',
+            content: function () {
+                return '<div class="history-thumbnail" style="background-image: url(' + $(this).data('img') + '); height: ' + $(this).data('height') + 'px;" />';
+            }
+        });
+
+        if ($('#row-edit-mode').hasClass('active')) {
+            $('.delete-control').each(function () {
+                $(this).removeClass('hidden');
+            });
+        }
+
+        $(this).closest('div.slider').slideDown();
+    }
+
+    return history_child_options;
+}
+
+// Format the detailed history child table
+function childTableFormat(rowData) {
+    return '<div class="slider">' +
+            '<table id="history_child-' + rowData['reference_id'] + '">' +
+            '<thead>' +
+            '<tr>' +
+                '<th align="left" id="delete_row">Delete</th>' +
+                '<th align="left" id="time">Time</th>' +
+                '<th align="left" id="friendly_name">User</th>' +
+                '<th align="left" id="ip_address">IP Address</th>' +
+                '<th align="left" id="platform">Platform</th>' +
+                '<th align="left" id="platform">Player</th>' +
+                '<th align="left" id="title">Title</th>' +
+                '<th align="left" id="started">Started</th>' +
+                '<th align="left" id="paused_counter">Paused</th>' +
+                '<th align="left" id="stopped">Stopped</th>' +
+                '<th align="left" id="duration">Duration</th>' +
+                '<th align="left" id="percent_complete"></th>' +
+            '</tr>' +
+            '</thead>' +
+            '<tbody>' +
+            '</tbody>' +
+            '</table>' +
+            '</div>';
+}
+
+// Create the detailed history child table
+history_child_table = {};
+function createChildTable(row, rowData) {
+    history_child_options = childTableOptions(rowData);
+    // initialize the child table
+    history_child_table[rowData['reference_id']] = $('#history_child-' + rowData['reference_id']).DataTable(history_child_options);
+
+    // Set child table column visibility to match parent table
+    var visibility = history_table.columns().visible();
+    for (var i = 0; i < visibility.length; i++) {
+        if (!(visibility[i])) { history_child_table[rowData['reference_id']].column(i).visible(visibility[i]); }
+    }
+    history_table.on('column-visibility', function (e, settings, colIdx, visibility) {
+        if (row.child.isShown()) {
+            history_child_table[rowData['reference_id']].column(colIdx).visible(visibility);
+        }
+    });
+
+    // Child table platform modal
+    $('#history_child-' + rowData['reference_id']).on('click', 'td.modal-control', function () {
+        var tr = $(this).closest('tr');
+        var childRow = history_child_table[rowData['reference_id']].row(tr);
+        var childRowData = childRow.data();
+
+        function showStreamDetails() {
+            $.ajax({
+                url: 'get_stream_data',
+                data: { row_id: childRowData['id'], user: childRowData['friendly_name'] },
+                cache: false,
+                async: true,
+                complete: function (xhr, status) {
+                    $("#info-modal").html(xhr.responseText);
+                }
+            });
+        }
+        showStreamDetails();
+    });
+
+    // Child table ip address modal
+    $('#history_child-' + rowData['reference_id']).on('click', 'td.modal-control-ip', function () {
+        var tr = $(this).closest('tr');
+        var childRow = history_child_table[rowData['reference_id']].row(tr);
+        var childRowData = childRow.data();
+
+        function getUserLocation(ip_address) {
+            if (isPrivateIP(ip_address)) {
+                return "n/a"
+            } else {
+                $.ajax({
+                    url: 'get_ip_address_details',
+                    data: { ip_address: ip_address },
+                    async: true,
+                    complete: function (xhr, status) {
+                        $("#ip-info-modal").html(xhr.responseText);
+                    }
+                });
+            }
+        }
+        getUserLocation(childRowData['ip_address']);
+    });
+
+    // Child table delete mode
+    $('#history_child-' + rowData['reference_id']).on('click', 'td.delete-control > button', function () {
+        var tr = $(this).closest('tr');
+        var childRow = history_child_table[rowData['reference_id']].row(tr);
+        var childRowData = childRow.data();
+
+        // add or remove row from history_to_delete
+        var index = $.inArray(childRowData['id'], history_to_delete);
+        if (index === -1) {
+            history_to_delete.push(childRowData['id']);
+        } else {
+            history_to_delete.splice(index, 1);
+        }
+        $(this).toggleClass('btn-warning').toggleClass('btn-danger');
+
+        tr.parents('tr').prev().find('td.delete-control > button.btn-warning').toggleClass('btn-warning').toggleClass('btn-danger');
+        // check if any child rows are not selected
+        var group_ids = rowData['group_ids'].split(',').map(Number);
+        group_ids.forEach(function (id) {
+            var index = $.inArray(id, history_to_delete);
+            if (index == -1) {
+                // if any child row is not selected, toggle parent button to warning
+                tr.parents('tr').prev().find('td.delete-control > button.btn-danger').addClass('btn-warning').removeClass('btn-danger');
+            }
+        });
+    });
+}
+

data/interfaces/default/js/tables/history_table_modal.js

@@ -77,11 +77,11 @@ history_table_modal_options = {
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData !== '') {
                     var transcode_dec = '';
-                    if (rowData['video_decision'] === 'transcode') {
+                    if (rowData['video_decision'] === 'transcode' || rowData['audio_decision'] === 'transcode') {
                         transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Transcode"><i class="fa fa-server fa-fw"></i></span>';
-                    } else if (rowData['video_decision'] === 'copy') {
+                    } else if (rowData['video_decision'] === 'copy' || rowData['audio_decision'] === 'copy') {
                         transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Stream"><i class="fa fa-video-camera fa-fw"></i></span>';
-                    } else if (rowData['video_decision'] === 'direct play' || rowData['video_decision'] === '') {
+                    } else if (rowData['video_decision'] === 'direct play' || rowData['audio_decision'] === 'direct play') {
                         transcode_dec = '<span class="transcode-tooltip" data-toggle="tooltip" title="Direct Play"><i class="fa fa-play-circle fa-fw"></i></span>';
                     }
                     $(td).html('<div><a href="#" data-target="#info-modal" data-toggle="modal"><div style="float: left;">' + transcode_dec + '&nbsp' + cellData + '</div></a></div>');
@@ -126,6 +126,7 @@ history_table_modal_options = {
         $('.media-type-tooltip').tooltip();
         $('.thumb-tooltip').popover({
             html: true,
+            container: '#history-modal',
             trigger: 'hover',
             placement: 'right',
             content: function () {
@@ -134,7 +135,7 @@ history_table_modal_options = {
         });
     },
     "preDrawCallback": function(settings) {
-        var msg = "<div class='msg'><i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...</div>";
+        var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...";
         showMsg(msg, false, false, 0)
     }
 }

data/interfaces/default/js/tables/logs.js

@@ -35,7 +35,7 @@ var log_table_options = {
         $('#ajaxMsg').fadeOut();
     },
     "preDrawCallback": function(settings) {
-        var msg = "<div class='msg'><i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...</div>";
+        var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...";
         showMsg(msg, false, false, 0)
     }
 }

data/interfaces/default/js/tables/sync_table.js

@@ -2,7 +2,7 @@ sync_table_options = {
     "processing": false,
     "serverSide": false,
     "pagingType": "bootstrap",
-    "order": [ 0, 'desc'],
+    "order": [ [ 0, 'desc'], [ 1, 'asc'], [2, 'asc'] ],
     "pageLength": 25,
     "stateSave": true,
     "language": {
@@ -67,13 +67,13 @@ sync_table_options = {
         },
         {
             "targets": [4],
-            "data": "device_name",
-            "className": "no-wrap hidden-xs"
+            "data": "platform",
+            "className": "no-wrap hidden-sm hidden-xs"
         },
         {
             "targets": [5],
-            "data": "platform",
-            "className": "no-wrap hidden-sm hidden-xs"
+            "data": "device_name",
+            "className": "no-wrap hidden-xs"
         },
         {
             "targets": [6],

data/interfaces/default/js/tables/user_ips.js

@@ -49,7 +49,18 @@ user_ip_table_options = {
         },
         {
             "targets": [2],
-            "data":"platform",
+            "data": "platform",
+            "createdCell": function (td, cellData, rowData, row, col) {
+                if (cellData !== '') {
+                    $(td).html(cellData);
+                }
+            },
+            "width": "15%",
+            "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
+        },
+        {
+            "targets": [3],
+            "data":"player",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData) {
                     var transcode_dec = '';
@@ -69,7 +80,7 @@ user_ip_table_options = {
             "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
         },
         {
-            "targets": [3],
+            "targets": [4],
             "data":"last_watched",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData !== '') {
@@ -94,10 +105,11 @@ user_ip_table_options = {
                     }
                 }
             },
+            "width": "30%",
             "className": "hidden-sm hidden-xs"
         },
         {
-            "targets": [4],
+            "targets": [5],
             "data":"play_count",
             "searchable": false,
             "width": "10%"
@@ -123,7 +135,7 @@ user_ip_table_options = {
 
     },
     "preDrawCallback": function(settings) {
-        var msg = "<div class='msg'><i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...</div>";
+        var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...";
         showMsg(msg, false, false, 0)
     }
 }

data/interfaces/default/js/tables/users.js

@@ -1,3 +1,4 @@
+var users_to_delete = [];
 var users_to_purge = [];
 
 users_list_table_options = {
@@ -22,7 +23,8 @@ users_list_table_options = {
             "targets": [0],
             "data": null,
             "createdCell": function (td, cellData, rowData, row, col) {
-                $(td).html('<div class="edit-user-toggles"><button class="btn btn-xs btn-warning" data-id="' + rowData['user_id'] + '" data-toggle="button"><i class="fa fa-eraser fa-fw"></i> Purge</button>&nbsp&nbsp&nbsp' +
+                $(td).html('<div class="edit-user-toggles"><button class="btn btn-xs btn-warning delete-user" data-id="' + rowData['user_id'] + '" data-toggle="button"><i class="fa fa-trash-o fa-fw"></i> Delete</button>&nbsp' +
+                    '<button class="btn btn-xs btn-warning purge-user" data-id="' + rowData['user_id'] + '" data-toggle="button"><i class="fa fa-eraser fa-fw"></i> Purge</button>&nbsp&nbsp&nbsp' +
                     '<input type="checkbox" id="do_notify-' + rowData['user_id'] + '" name="do_notify" value="1" ' + rowData['do_notify'] + '><label class="edit-tooltip" for="do_notify-' + rowData['user_id'] + '" data-toggle="tooltip" title="Toggle Notifications"><i class="fa fa-bell fa-lg fa-fw"></i></label>&nbsp' +
                     '<input type="checkbox" id="keep_history-' + rowData['user_id'] + '" name="keep_history" value="1" ' + rowData['keep_history'] + '><label class="edit-tooltip" for="keep_history-' + rowData['user_id'] + '" data-toggle="tooltip" title="Toggle History"><i class="fa fa-history fa-lg fa-fw"></i></label>&nbsp');
                     // Show/hide user currently doesn't work
@@ -64,7 +66,7 @@ users_list_table_options = {
                     $(td).html(cellData);
                 }
             },
-            "width": "12%",
+            "width": "10%",
             "className": "edit-user-control no-wrap"
         },
         {
@@ -78,7 +80,7 @@ users_list_table_options = {
                 }
             },
             "searchable": false,
-            "width": "12%",
+            "width": "10%",
             "className": "no-wrap hidden-xs"
         },
         {
@@ -99,12 +101,25 @@ users_list_table_options = {
                     $(td).html('n/a');
                 }
             },
-            "width": "12%",
+            "width": "10%",
             "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control-ip"
         },
         {
             "targets": [5],
-            "data":"platform",
+            "data": "platform",
+            "createdCell": function (td, cellData, rowData, row, col) {
+                if (cellData !== '') {
+                    $(td).html(cellData);
+                } else {
+                    $(td).html('n/a');
+                }
+            },
+            "width": "10%",
+            "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
+        },
+        {
+            "targets": [6],
+            "data":"player",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData) {
                     var transcode_dec = '';
@@ -120,11 +135,11 @@ users_list_table_options = {
                     $(td).html('n/a');
                 }
             },
-            "width": "12%",
+            "width": "15%",
             "className": "no-wrap hidden-md hidden-sm hidden-xs modal-control"
         },
         {
-            "targets": [6],
+            "targets": [7],
             "data":"last_watched",
             "createdCell": function (td, cellData, rowData, row, col) {
                 if (cellData !== '') {
@@ -153,7 +168,7 @@ users_list_table_options = {
             "className": "hidden-sm hidden-xs"
         },
         {
-            "targets": [7],
+            "targets": [8],
             "data": "plays",
             "searchable": false,
             "width": "10%"
@@ -187,7 +202,7 @@ users_list_table_options = {
         }
     },
     "preDrawCallback": function(settings) {
-        var msg = "<div class='msg'><i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...</div>";
+        var msg = "<i class='fa fa-refresh fa-spin'></i>&nbspFetching rows...";
         showMsg(msg, false, false, 0)
     },
     "rowCallback": function (row, rowData) {
@@ -273,16 +288,44 @@ $('#users_list_table').on('change', 'td.edit-control > .edit-user-toggles > inpu
     });
 });
 
-$('#users_list_table').on('click', 'td.edit-control > .edit-user-toggles > button', function () {
+$('#users_list_table').on('click', 'td.edit-control > .edit-user-toggles > button.delete-user', function () {
     var tr = $(this).parents('tr');
     var row = users_list_table.row(tr);
     var rowData = row.data();
 
-    var index = $.inArray(rowData['user_id'], users_to_purge);
-    if (index === -1) {
+    var index_delete = $.inArray(rowData['user_id'], users_to_delete);
+    var index_purge = $.inArray(rowData['user_id'], users_to_purge);
+
+    if (index_delete === -1) {
+        users_to_delete.push(rowData['user_id']);
+        if (index_purge === -1) {
+            tr.find('button.purge-user').click();
+        }
+    } else {
+        users_to_delete.splice(index_delete, 1);
+        if (index_purge != -1) {
+            tr.find('button.purge-user').click();
+        }
+    }
+    $(this).toggleClass('btn-warning').toggleClass('btn-danger');
+
+});
+
+$('#users_list_table').on('click', 'td.edit-control > .edit-user-toggles > button.purge-user', function () {
+    var tr = $(this).parents('tr');
+    var row = users_list_table.row(tr);
+    var rowData = row.data();
+
+    var index_delete = $.inArray(rowData['user_id'], users_to_delete);
+    var index_purge = $.inArray(rowData['user_id'], users_to_purge);
+
+    if (index_purge === -1) {
         users_to_purge.push(rowData['user_id']);
     } else {
-        users_to_purge.splice(index, 1);
+        users_to_purge.splice(index_purge, 1);
+        if (index_delete != -1) {
+            tr.find('button.delete-user').click();
+        }
     }
     $(this).toggleClass('btn-warning').toggleClass('btn-danger');
 });

data/interfaces/default/library_stats.html

@@ -37,7 +37,13 @@ DOCUMENTATION :: END
         <li>
             <div class="home-platforms-instance-info">
                 <div class="home-platforms-instance-name">
+                    % if library['type'] != 'photo':
+                    <h4>
+                        <a href="info?item_id=${library['type']}" title="${library['rows']['title']}">${library['rows']['title']}</a>
+                    </h4>
+                    % else:
                     <h4>${library['rows']['title']}</h4>
+                    % endif
                 </div>
                 <div class="home-platforms-instance-playcount">
                     <h5>${library['rows']['count_type']}</h5>
@@ -73,6 +79,6 @@ DOCUMENTATION :: END
     % endfor
 </ul>
 % else:
-<div class="text-muted">Unable to retrieve data from database. Please check your <a href="settings">settings</a>.
+<div class="text-muted">Unable to retrieve data from server. Please check your <a href="settings">settings</a>.
 </div><br>
 % endif

data/interfaces/default/notification_config.html

@@ -1,31 +1,66 @@
+<%!
+from plexpy import helpers
+%>
 % if data:
 <div class="modal-dialog" role="document">
     <div class="modal-content">
         <div class="modal-header">
             <button type="button" class="close" data-dismiss="modal" aria-hidden="true"><i class="fa fa-remove"></i></button>
-            <h4 class="modal-title" id="notification-config-modal-header">Set Config</h4>
+            <h4 class="modal-title" id="notification-config-modal-header">${agent['name']} Settings</h4>
         </div>
         <div class="modal-body">
             <div class="container-fluid">
                 <div class="row">
                     <form action="set_notification_config" method="post" class="form" id="set_notification_config" data-parsley-validate>
-                    <div class="col-md-6">
+                    <div class="col-md-12">
                     % for item in data:
-                        % if item['input_type'] != 'checkbox':
+                        % if item['input_type'] == 'text' or item['input_type'] == 'number' or item['input_type'] == 'password':
                         <div class="form-group">
                             <label for="${item['name']}">${item['label']}</label>
-                            <input type="${item['input_type']}" class="form-control" id="${item['name']}" name="${item['name']}" value="${item['value']}" size="30">
-                            % if item['name'] == 'osx_notify_app':
-                                <a href="javascript:void(0)" id="osxnotifyregister">Register</a>
-                            % endif
-                            <p class="help-block">${item['description']}</p>
+                            <div class="row">
+                                <div class="col-md-8">
+                                    <input type="${item['input_type']}" class="form-control" id="${item['name']}" name="${item['name']}" value="${item['value']}" size="30">
+                                    % if item['name'] == 'osx_notify_app':
+                                    <a href="javascript:void(0)" id="osxnotifyregister">Register</a>
+                                    % endif
+                                </div>
+                            </div>
+                            <p class="help-block">${item['description'] | n}</p>
+                        </div>
+                        % elif item['input_type'] == 'button':
+                        <div class="form-group">
+                            <div class="row">
+                                <div class="col-md-8">
+                                    <input type="${item['input_type']}" class="btn btn-bright" id="${item['name']}" name="${item['name']}" value="${item['value']}">
+                                </div>
+                            </div>
+                            <p class="help-block">${item['description'] | n}</p>
                         </div>
                         % elif item['input_type'] == 'checkbox':
                         <div class="checkbox">
                             <label>
-                                <input type="checkbox" id="${item['name']}" name="${item['name']}" value="1" ${item['value']}> ${item['label']}
+                                <input type="checkbox" data-id="${item['name']}" class="checkboxes" value="1" ${helpers.checked(item['value'])}> ${item['label']}
                             </label>
-                            <p class="help-block">${item['description']}</p>
+                            <p class="help-block">${item['description'] | n}</p>
+                            <input type="hidden" id="${item['name']}" name="${item['name']}" value="${item['value']}">
+                        </div>
+                        % elif item['input_type'] == 'select':
+                        <div class="form-group">
+                            <label for="${item['name']}">${item['label']}</label>
+                            <div class="row">
+                                <div class="col-md-5">
+                                    <select class="form-control" id="${item['name']}" name="${item['name']}" >
+                                        % for key, value in sorted(item['select_options'].iteritems()):
+                                        % if key == item['value']:
+                                        <option value="${key}" selected>${value}</option>
+                                        % else:
+                                        <option value="${key}">${value}</option>
+                                        % endif
+                                        % endfor
+                                    </select>
+                                </div>
+                            </div>
+                            <p class="help-block">${item['description'] | n}</p>
                         </div>
                         % endif
                     % endfor
@@ -35,22 +70,81 @@
             </div>
         </div>
         <div class="modal-footer">
-            <input type="button" id="save-notification-item" class="btn btn-bright" value="Save">
+            <%
+                nosave = any(d['input_type'] == 'nosave' for d in data)
+            %>
+            % if not nosave:
+                <input type="button" id="save-notification-item" class="btn btn-bright" value="Save">
+            % else:
+                <input type="button" class="btn btn-bright" data-dismiss="modal" value="Close">
+            % endif
         </div>
     </div>
 </div>
 % endif
 
 <script>
+
+    function reloadModal() {
+        $.ajax({
+            url: 'get_notification_agent_config',
+            data: { config_id: '${agent["id"]}' },
+            cache: false,
+            async: true,
+            complete: function (xhr, status) {
+                $("#notification-config-modal").html(xhr.responseText);
+            }
+        });
+    }
+
     $('#osxnotifyregister').click(function () {
         var osx_notify_app = $("#osx_notify_app").val();
-        $.get("/osxnotifyregister", {'app': osx_notify_app}, function (data) { $('#ajaxMsg').html("<div class='msg'><span class='ui-icon ui-icon-check'></span>"+data+"</div>"); });
-        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut()
+        $.get("/osxnotifyregister", { 'app': osx_notify_app }, function (data) { $('#ajaxMsg').html("<i class='fa fa-check'></i> " + data); });
+        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut();
     })
 
-    var notificationConfig = $("#set_notification_config");
-    $('#save-notification-item').click(function() {
-        doAjaxCall('set_notification_config',$(this),'tabs',true);
+    $('#save-notification-item').click(function () {
+        doAjaxCall('set_notification_config', $(this), 'tabs', true);
+        // Reload modal to update certain fields
+        reloadModal();
         return false;
     });
+
+    $('#twitterStep1').click(function () {
+        $.get("/twitterStep1", function (data) {window.open(data); })
+        .done(function () { $('#ajaxMsg').html("<i class='fa fa-check'></i> Confirm Authorization. Check pop-up blocker if no response."); });
+        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut();
+    });
+    $('#twitterStep2').click(function () {
+        var twitter_key = $("#twitter_key").val();
+        $.get("/twitterStep2", { 'key': twitter_key }, function (data) { $('#ajaxMsg').html("<i class='fa fa-check'></i> " + data); });
+        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut();
+    });
+    $('#testTwitter').click(function () {
+        $.get("/testTwitter",
+            function (data) { $('#ajaxMsg').html("<i class='fa fa-check'></i> " + data); });
+        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut();
+    });
+
+    $('#testIFTTT').click(function () {
+        $.get("/test_ifttt",
+            function (data) { $('#ajaxMsg').html("<i class='fa fa-check'></i> " + data); });
+        $('#ajaxMsg').addClass('success').fadeIn().delay(3000).fadeOut();
+    });
+
+    $('#pushbullet_apikey').on('change', function () {
+        doAjaxCall('set_notification_config', $(this), 'tabs', true);
+        reloadModal();
+        return false;
+    });
+    
+    // Never send checkbox values directly, always substitute value in hidden input.
+    $('.checkboxes').click(function () {
+        var configToggle = $(this).data('id');
+        if ($(this).is(":checked")) {
+            $("#"+configToggle).val(1);
+        } else {
+            $("#"+configToggle).val(0);
+        }
+    });
 </script>

data/interfaces/default/notification_triggers_modal.html

@@ -57,6 +57,41 @@ from plexpy import helpers
                             </label>
                             <p class="help-block">Trigger notification when a media item triggers the defined buffer threshold.</p>
                         </div>
+                        <div class="checkbox">
+                            <label>
+                                <input type="checkbox" data-size="small" data-id="${data['id']}" data-config-name="${data['config_prefix']}_on_created" ${helpers.checked(data['on_created'])} class="toggle-switches">
+                                Notify on recently added
+                            </label>
+                            <p class="help-block">Trigger notification when a media item is added to the Plex Media Server.</p>
+                        </div>
+                        <div class="checkbox">
+                            <label>
+                                <input type="checkbox" data-size="small" data-id="${data['id']}" data-config-name="${data['config_prefix']}_on_extdown" ${helpers.checked(data['on_extdown'])} class="toggle-switches">
+                                Notify on Plex remote access down
+                            </label>
+                            <p class="help-block">Trigger notification when the Plex Media Server cannot be reached externally.</p>
+                        </div>
+                        <div class="checkbox">
+                            <label>
+                                <input type="checkbox" data-size="small" data-id="${data['id']}" data-config-name="${data['config_prefix']}_on_intdown" ${helpers.checked(data['on_intdown'])} class="toggle-switches">
+                                Notify on Plex server down
+                            </label>
+                            <p class="help-block">Trigger notification when the Plex Media Server cannot be reached internally.</p>
+                        </div>
+                        <div class="checkbox">
+                            <label>
+                                <input type="checkbox" data-size="small" data-id="${data['id']}" data-config-name="${data['config_prefix']}_on_extup" ${helpers.checked(data['on_extup'])} class="toggle-switches">
+                                Notify on Plex remote access back up
+                            </label>
+                            <p class="help-block">Trigger notification when the Plex Media Server can be reached externally after being down.</p>
+                        </div>
+                        <div class="checkbox">
+                            <label>
+                                <input type="checkbox" data-size="small" data-id="${data['id']}" data-config-name="${data['config_prefix']}_on_intup" ${helpers.checked(data['on_intup'])} class="toggle-switches">
+                                Notify on Plex server back up
+                            </label>
+                            <p class="help-block">Trigger notification when the Plex Media Server can be reached internally after being down.</p>
+                        </div>
                     </div>
                 </div>
             </div>
@@ -81,6 +116,7 @@ from plexpy import helpers
                     console.log('success');
                 }
             });
+            $('.toggle-notification-triggers-modal[data-id=' + configToggle + ']').addClass('active');
         } else {
             var data = {};
             data[$(this).data('config-name')] = 0;
@@ -92,6 +128,9 @@ from plexpy import helpers
                     console.log('success');
                 }
             });
+            if (!($('.toggle-switches').is(":checked"))) {
+                $('.toggle-notification-triggers-modal[data-id=' + configToggle + ']').removeClass('active');
+            }
         }
     });
 </script>

data/interfaces/default/recently_added.html

@@ -11,13 +11,13 @@ data[array_index] :: Usable parameters
 
 == Global keys ==
 rating_key              Returns the unique identifier for the media item.
-type                    Returns the type of media. Either 'movie' or 'season'.
+media_type              Returns the media type of media. Either 'movie' or 'season' or 'album'.
 thumb                   Returns the location of the item's thumbnail. Use with pms_image_proxy.
 added_at                Returns the time when the media was added to the library.
 title                   Returns the name of the movie or season.
 parent_title            Returns the name of the TV Show a season belongs too.
 
-== Only if 'type' is 'movie' ==
+== Only if 'media_type' is 'movie' ==
 year                    Returns the movie release year.
 
 DOCUMENTATION :: END
@@ -29,7 +29,7 @@ DOCUMENTATION :: END
         % for item in data:
         <div class="dashboard-recent-media-instance">
             <li>
-                % if item['type'] == 'season' or item['type'] == 'movie':
+                % if item['media_type'] == 'season' or item['media_type'] == 'movie':
 				<a href="info?item_id=${item['rating_key']}">
 					<div class="dashboard-recent-media-poster">
 						<div class="dashboard-recent-media-poster-face" style="background-image: url(pms_image_proxy?img=${item['thumb']}&width=300&height=450&fallback=poster);">
@@ -43,16 +43,16 @@ DOCUMENTATION :: END
                         </div>
                     </div>
 					<div class="dashboard-recent-media-metacontainer">
-						% if item['type'] == 'season':
-						<h3>${item['parent_title']}</h3>
+						% if item['media_type'] == 'season':
+						<h3 title="${item['parent_title']}">${item['parent_title']}</h3>
 						<h3 class="text-muted">${item['title']}</h3>
-						% elif item['type'] == 'movie':
-						<h3>${item['title']}</h3>
+						% elif item['media_type'] == 'movie':
+						<h3 title="${item['title']}">${item['title']}</h3>
 						<h3 class="text-muted">${item['year']}</h3>
 						% endif
 					</div>
 				</a>
-				% elif item['type'] == 'album':
+				% elif item['media_type'] == 'album':
                 <a href="info?item_id=${item['rating_key']}">
                     <div class="dashboard-recent-media-cover">
                         <div class="dashboard-recent-media-cover-face" style="background-image: url(pms_image_proxy?img=${item['thumb']}&width=300&height=300&fallback=cover);">
@@ -66,7 +66,7 @@ DOCUMENTATION :: END
                         </div>
                     </div>
                     <div class="dashboard-recent-media-metacontainer">
-                        <h3>${item['parent_title']}</h3>
+                        <h3 title="${item['parent_title']}">${item['parent_title']}</h3>
                         <h3 class="text-muted">${item['title']}</h3>
                     </div>
                 </a>

data/interfaces/default/search.html

@@ -0,0 +1,41 @@
+<%inherit file="base.html"/>
+
+<%def name="headIncludes()">
+</%def>
+
+<%def name="headerIncludes()">
+</%def>
+
+<%def name="body()">
+<div class='container-fluid'>
+    <div class='table-card-header'>
+        <div class="header-bar">
+            <span><i class="fa fa-search"></i> Search Results 
+            % if query:
+            for <strong>${query}</strong>
+            % endif
+            </span>
+        </div>
+    </div>
+    <div class='table-card-back'>
+        <div id="search-results-list"><i class="fa fa-refresh fa-spin"></i>&nbsp; Loading search results...</div>
+    </div>
+</div>
+</%def>
+
+<%def name="javascriptIncludes()">
+<script>
+    $('#search_button').removeClass('btn-inactive');
+    $('#query').val("${query.replace('"','\\"')}").css({ right: '0', width: '250px' }).addClass('active');
+
+    $.ajax({
+        url: 'get_search_results_children',
+        type: "GET",
+        async: true,
+        data: {'query': "${query.replace('"','\\"')}"},
+        complete: function (xhr, status) {
+            $("#search-results-list").html(xhr.responseText);
+        }
+    });
+</script>
+</%def>

data/interfaces/default/sync.html

@@ -26,11 +26,11 @@
             <thead>
             <tr>
                 <th align='left' id="state">State</th>
-                <th align='left' id="username">Username</th>
+                <th align='left' id="user">User</th>
                 <th align='left' id="title">Title</th>
                 <th align='left' id="type">Type</th>
-                <th align='left' id="device">Device</th>
                 <th align='left' id="platform">Platform</th>
+                <th align='left' id="device">Device</th>
                 <th align='left' id="size">Total Size</th>
                 <th align='left' id="items">Total Items</th>
                 <th align='left' id="converted">Converted</th>

data/interfaces/default/user.html

@@ -85,11 +85,11 @@ from plexpy import helpers
                 <div class="col-md-12">
                     <div class="table-card-header">
                         <div class="header-bar">
-                            <span><i class="fa fa-television"></i> Platform Stats</span>
+                            <span><i class="fa fa-television"></i> Player Stats</span>
                         </div>
                     </div>
                     <div class="table-card-back">
-                        <div id="user-platform-stats" class="user-platforms">
+                        <div id="user-player-stats" class="user-player">
                             <div class='muted'><i class="fa fa-refresh fa-spin"></i> Loading data...</div>
                             <br>
                         </div>
@@ -133,6 +133,7 @@ from plexpy import helpers
                                 <th align="left">Last Seen</th>
                                 <th align="left">IP Address</th>
                                 <th align="left">Last Platform</th>
+                                <th align="left">Last Player</th>
                                 <th align="left">Last Watched</th>
                                 <th align="left">Play Count</th>
                             </tr>
@@ -170,6 +171,7 @@ from plexpy import helpers
                                 <th align='left' id="friendly_name">User</th>
                                 <th align='left' id="ip_address">IP Address</th>
                                 <th align='left' id="platform">Platform</th>
+                                <th align='left' id="player">Player</th>
                                 <th align='left' id="title">Title</th>
                                 <th align='left' id="started">Started</th>
                                 <th align='left' id="paused_counter">Paused</th>
@@ -207,8 +209,8 @@ from plexpy import helpers
                                 <th align='left' id="username">Username</th>
                                 <th align='left' id="sync_title">Title</th>
                                 <th align='left' id="type">Type</th>
-                                <th align='left' id="device">Device</th>
                                 <th align='left' id="sync_platform">Platform</th>
+                                <th align='left' id="device">Device</th>
                                 <th align='left' id="size">Total Size</th>
                                 <th align='left' id="items">Total Items</th>
                                 <th align='left' id="converted">Converted</th>
@@ -260,33 +262,6 @@ from plexpy import helpers
 <script src="interfaces/default/js/tables/user_ips.js"></script>
 <script src="interfaces/default/js/tables/sync_table.js"></script>
 <script>
-    function recentlyWatched() {
-        var widthVal = $('body').find("#user-recently-watched").width();
-        var tmp = (widthVal-32) / 180;
-
-        if (tmp > 0) {
-            containerSize = parseInt(tmp);
-        } else {
-            containerSize = 1;
-        }
-        
-        % if data['user_id']:
-            var user_id = ${data['user_id']};
-        % else:
-            var user_id = null;
-        % endif
-
-        // Populate recently watched
-        $.ajax({
-            url: 'get_user_recently_watched',
-            async: true,
-            data: { user_id: user_id, user: '${data['username']}', limit: containerSize },
-            complete: function(xhr, status) {
-                $("#user-recently-watched").html(xhr.responseText);
-            }
-        });        
-    }
-    
     $(document).ready(function () {
 
         % if data['user_id']:
@@ -295,13 +270,15 @@ from plexpy import helpers
             var user_id = null;
         % endif
 
+        var username = '${data['username'].replace("'", "\\'")}';
+
         $("#edit-user-tooltip").tooltip();
 
         // Populate watch time stats
         $.ajax({
             url: 'get_user_watch_time_stats',
             async: true,
-            data: { user_id: user_id, user: '${data['username']}' },
+            data: { user_id: user_id, user: username },
             complete: function(xhr, status) {
                 $("#user-time-stats").html(xhr.responseText);
             }
@@ -309,33 +286,63 @@ from plexpy import helpers
 
         // Populate platform stats
         $.ajax({
-            url: 'get_user_platform_stats',
+            url: 'get_user_player_stats',
             async: true,
-            data: { user_id: user_id, user: '${data['username']}' },
+            data: { user_id: user_id, user: username },
             complete: function(xhr, status) {
-                $("#user-platform-stats").html(xhr.responseText);
+                $("#user-player-stats").html(xhr.responseText);
             }
         });
 
-        $( "#history-tab-btn" ).one( "click", function() {
+        function loadHistoryTable(media_type) {
             // Build watch history table
             history_table_options.ajax = {
-                "url": "get_history",
+                url: 'get_history',
                 type: 'post',
                 data: function ( d ) {
-                    return { 'json_data': JSON.stringify( d ),
-                             'user_id': user_id,
-                             'user': "${data['username']}"
+                    return {
+                        'json_data': JSON.stringify( d ),
+                        'user_id': user_id,
+                        'user': username,
+                        'media_type': media_type
                     };
                 }
             }
             history_table = $('#history_table').DataTable(history_table_options);
             history_table.column(2).visible(false);
 
-            var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 10] });
+            var colvis = new $.fn.dataTable.ColVis(history_table, { buttonText: '<i class="fa fa-columns"></i> Select columns', buttonClass: 'btn btn-dark', exclude: [0, 11] });
             $(colvis.button()).appendTo('#button-bar-history');
             
             clearSearchButton('history_table', history_table);
+
+            $('#history_table_filter').prepend('<div class="btn-group" data-toggle="buttons" id="media_type-selection" style="padding-right: 15px;"> \
+                <label class="btn btn-dark active"> \
+                    <input type="radio" name="media_type-filter" id="history-all" value="all" autocomplete="off"> All \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-movies" value="movie" autocomplete="off"> Movies \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-tv_shows" value="episode" autocomplete="off"> TV Shows \
+                </label> \
+                <label class="btn btn-dark"> \
+                    <input type="radio" name="media_type-filter" id="history-music" value="track" autocomplete="off"> Music \
+                </label> \
+            </div>');
+
+            $('#media_type-selection').on('change', function () {
+                $('#media_type-selection > label').removeClass('active');
+                selected_filter = $('input[name=media_type-filter]:checked', '#media_type-selection');
+                $(selected_filter).closest('label').addClass('active');
+                media_type = $(selected_filter).val();
+                history_table.draw();
+            });
+        }
+
+        $( "#history-tab-btn" ).one( "click", function() {
+            var media_type = 'all';
+            loadHistoryTable(media_type);
         });
 
         $( "#ip-tab-btn" ).one( "click", function() {
@@ -346,7 +353,7 @@ from plexpy import helpers
                 data: function ( d ) {
                     return { 'json_data': JSON.stringify( d ),
                              'user_id': user_id,
-                             'user': "${data['username']}"
+                             'user': username
                     };
                 }
             }
@@ -361,7 +368,7 @@ from plexpy import helpers
                 "url": "get_sync",
                 "data": function(d) {
                    d.user_id = user_id;
-                   d.user = "${data['username']}";
+                   d.user = username;
                 }
             }
             sync_table = $('#sync_table').DataTable(sync_table_options);
@@ -378,7 +385,7 @@ from plexpy import helpers
             $("#edit-user-tooltip").tooltip('hide');
             $.ajax({
                 url: 'edit_user_dialog',
-                data: { user_id: user_id, user: '${data['username']}' },
+                data: { user_id: user_id, user: username },
                 cache: false,
                 async: true,
                 complete: function(xhr, status) {
@@ -423,6 +430,33 @@ from plexpy import helpers
                 });
             }
         });
+
+        function recentlyWatched() {
+            var widthVal = $('body').find("#user-recently-watched").width();
+            var tmp = (widthVal-32) / 180;
+
+            if (tmp > 0) {
+                containerSize = parseInt(tmp);
+            } else {
+                containerSize = 1;
+            }
+
+            % if data['user_id']:
+                var user_id = ${data['user_id']};
+            % else:
+                var user_id = null;
+            % endif
+
+            // Populate recently watched
+            $.ajax({
+                url: 'get_user_recently_watched',
+                async: true,
+                data: { user_id: user_id, user: username, limit: containerSize },
+                complete: function(xhr, status) {
+                    $("#user-recently-watched").html(xhr.responseText);
+                }
+            });
+        }
         
         recentlyWatched();
         $(window).resize(function() {

data/interfaces/default/user_player_stats.html

@@ -11,8 +11,9 @@ data[array_index] :: Usable parameters
 
 == Global keys ==
 result_id               Returns a unique identifier for the result.
-platform_name           Returns the name of the platform.
-total_plays             Returns the play count for the platform.
+player_name             Returns the name of the player.
+platform_type           Returns the name of the platform
+total_plays             Returns the play count for the player.
 
 DOCUMENTATION :: END
 </%doc>
@@ -20,13 +21,13 @@ DOCUMENTATION :: END
 % if data != None:
 % for a in data:
 <ul class="list-unstyled">
-    <div class="user-platforms-instance">
+    <div class="user-player-instance">
         <li>
-            <span id="user-platform-image-${a['result_id']}"></span>
-            <div class="user-platforms-instance-name">
-                ${a['platform_name']}
+            <span id="user-player-image-${a['result_id']}"></span>
+            <div class="user-player-instance-name">
+                ${a['player_name']}
             </div>
-            <div class="user-platforms-instance-playcount">
+            <div class="user-player-instance-playcount">
                 <h3>${a['total_plays']}</h3>
                 <p> plays</p>
             </div>
@@ -34,7 +35,7 @@ DOCUMENTATION :: END
     </div>
 </ul>
 <script>
-    $("#user-platform-image-${a['result_id']}").html("<div class='user-platforms-instance-box' style='background-image: url(" + getPlatformImagePath('${a['platform_type']}') + ");'>");
+    $("#user-player-image-${a['result_id']}").html("<div class='user-player-instance-box' style='background-image: url(" + getPlatformImagePath('${a['platform_type']}') + ");'>");
 </script>
 % endfor
 % else:

data/interfaces/default/user_recently_watched.html

@@ -48,11 +48,11 @@ DOCUMENTATION :: END
                 </div>
 				<div class="dashboard-recent-media-metacontainer">
 					% if item['type'] == 'episode':
-					<h3>${item['grandparent_title']}</h3>
-					<h3>${item['title']}</h3>
+					<h3 title="${item['grandparent_title']}">${item['grandparent_title']}</h3>
+					<h3 title="${item['title']}">${item['title']}</h3>
 					<h3 class="text-muted">S${item['parent_index']} &middot; E${item['index']}</h3>
 					% elif item['type'] == 'movie':
-					<h3>${item['title']}</h3>
+					<h3 title="${item['title']}">${item['title']}</h3>
 					<h3 class="text-muted">${item['year']}</h3>
 					% endif
 					<div class="text-muted" id="time-${item['time']}">
@@ -73,8 +73,8 @@ DOCUMENTATION :: END
                     </div>
                 </div>
                 <div class="dashboard-recent-media-metacontainer">
-                    <h3>${item['grandparent_title']}</h3>
-                    <h3>${item['title']}</h3>
+                    <h3 title="${item['grandparent_title']}">${item['grandparent_title']}</h3>
+                    <h3 title="${item['title']}">${item['title']}</h3>
                     <h3 class="text-muted">${item['parent_title']}</h3>
                 </div>
             </a>

data/interfaces/default/user_watch_time_stats.html

@@ -32,13 +32,14 @@ DOCUMENTATION :: END
                 <h3>${a['total_plays']}</h3>
                 <p>plays</p>
                 <h3><strong>/</strong></h3>
-                <span id="total-time-${a['query_days']}"></span>
+                <span id="total-time-${a['query_days']}">
+                    <script>
+                        $('#total-time-${a['query_days']}').html(humanTime(${a['total_time']}));
+                    </script>
+                </span>
             </div>
         </li>
     </div>
-    <script>
-        $('#total-time-${a['query_days']}').html(humanTime(${a['total_time']}));
-    </script>
     % endfor
 </ul>
 % else:

data/interfaces/default/users.html

@@ -16,7 +16,7 @@
             <button class="btn btn-danger btn-edit" data-toggle="button" aria-pressed="false" autocomplete="off" id="row-edit-mode">
                 <i class="fa fa-pencil"></i> Edit mode
             </button>&nbsp
-            <div class="alert alert-danger alert-edit" role="alert" id="row-edit-mode-alert"><i class="fa fa-exclamation-triangle"></i>&nbspSelect users to purge. Data is purged upon exiting edit mode.</div>
+            <div class="alert alert-danger alert-edit" role="alert" id="row-edit-mode-alert"><i class="fa fa-exclamation-triangle"></i>&nbspSelect users to delete/purge. Data is deleted/purged upon exiting edit mode.</div>
         </div>
     </div>
     <div class='table-card-back'>
@@ -29,6 +29,7 @@
                 <th align="left" id="last_seen">Last Seen</th>
                 <th align="left" id="last_known_ip">Last Known IP</th>
                 <th align="left" id="last_platform">Last Platform</th>
+                <th align="left" id="last_player">Last Player</th>
                 <th align="left" id="last_watched">Last Watched</th>
                 <th align="left" id="total_plays">Total Plays</th>
             </tr>
@@ -45,16 +46,16 @@
                 <div class="modal-content">
                     <div class="modal-header">
                         <button type="button" class="close" data-dismiss="modal" aria-hidden="true"><i class="fa fa-remove"></i></button>
-                        <h4 class="modal-title" id="myModalLabel">Confirm Purge</h4>
+                        <h4 class="modal-title" id="myModalLabel">Confirm Delete/Purge</h4>
                     </div>
                     <div class="modal-body" style="text-align: center;">
-                        <p>Are you REALLY sure you want to purge all history for the following users:</p>
                         <ul id="users-to-delete" class="list-unstyled"></ul>
+                        <ul id="users-to-purge" class="list-unstyled"></ul>
                         <p>This is permanent and cannot be undone!</p>
                     </div>
                     <div class="modal-footer">
                         <button type="button" class="btn btn-dark" data-dismiss="modal">Cancel</button>
-                        <button type="button" class="btn btn-danger btn-ok" data-dismiss="modal" id="confirm-purge">Purge</button>
+                        <button type="button" class="btn btn-danger btn-ok" data-dismiss="modal" id="confirm-delete">Confirm</button>
                     </div>
                 </div>
             </div>
@@ -73,8 +74,8 @@
 <script>
     $(document).ready(function () {
         users_list_table_options.ajax = {
-            "url": "get_user_list",
-            type: "post",
+            url: 'get_user_list',
+            type: 'POST',
             data: function ( d ) {
                 return { 'json_data': JSON.stringify( d ) };
             }
@@ -87,18 +88,46 @@
         $('#row-edit-mode').on('click', function () {
             $('#row-edit-mode-alert').fadeIn(200);
             $('#users-to-delete').html('');
+            $('#users-to-purge').html('');
 
             if ($(this).hasClass('active')) {
-                if (users_to_purge.length > 0) {
+                if (users_to_delete.length > 0 || users_to_purge.length > 0) {
                     $('.edit-control').each(function () {
                         $(this).find('button.btn-danger').toggleClass('btn-warning').toggleClass('btn-danger');
                     });
 
-                    for (var i = 0; i < users_to_purge.length; i++) {
-                        $('#users-to-delete').append('<li>' + $('div[data-id=' + users_to_purge[i] + '] > input').val() + '</li>');
+                    users_to_purge = $.grep(users_to_purge, function (value) {
+                        return $.inArray(value, users_to_delete) < 0;
+                    });
+
+                    if (users_to_delete.length > 0) {
+                        $('#users-to-delete').prepend('<p>Are you REALLY sure you want to delete the following users:</p>')
+                        for (var i = 0; i < users_to_delete.length; i++) {
+                            $('#users-to-delete').append('<li>' + $('div[data-id=' + users_to_delete[i] + '] > input').val() + '</li>');
+                        }
                     }
+
+                    if (users_to_purge.length > 0) {
+                        $('#users-to-purge').prepend('<p>Are you REALLY sure you want to purge all history for the following users:</p>')
+                        for (var i = 0; i < users_to_purge.length; i++) {
+                            $('#users-to-purge').append('<li>' + $('div[data-id=' + users_to_purge[i] + '] > input').val() + '</li>');
+                        }
+                    }
+
                     $('#confirm-modal').modal();
-                    $('#confirm-modal').one('click', '#confirm-purge', function () {
+                    $('#confirm-modal').one('click', '#confirm-delete', function () {
+                        for (var i = 0; i < users_to_delete.length; i++) {
+                            $.ajax({
+                                url: 'delete_user',
+                                data: { user_id: users_to_delete[i] },
+                                cache: false,
+                                async: true,
+                                success: function (data) {
+                                    var msg = "User deleted";
+                                    showMsg(msg, false, true, 2000);
+                                }
+                            });
+                        }
                         for (var i = 0; i < users_to_purge.length; i++) {
                             $.ajax({
                                 url: 'delete_all_user_history',
@@ -128,6 +157,7 @@
                 });
 
             } else {
+                users_to_delete = [];
                 users_to_purge = [];
                 $('.edit-control').each(function () {
                     $(this).find('button.btn-danger').toggleClass('btn-warning').toggleClass('btn-danger');
@@ -146,12 +176,12 @@
             url: 'refresh_users_list',
             cache: false,
             async: true,
-            success : function(data) {
+            success: function(data) {
                 showMsg('<i class="fa fa-check"></i>&nbspUser list refresh started...',false,true,2000,false)
             },
             error: function(jqXHR, textStatus, errorThrown) {
                 showMsg('<i class="fa fa-exclamation-circle"></i>&nbspUnable to refresh user list.',false,true,2000,true)
-            },
+            }
         });
     });
 </script>

data/interfaces/default/welcome.html

@@ -1,4 +1,4 @@
-<%
+<%
 import plexpy
 from plexpy import common
 %>
@@ -15,6 +15,7 @@ from plexpy import common
     <link href="interfaces/default/css/bootstrap3/bootstrap.css" rel="stylesheet">
     <link href="interfaces/default/css/bootstrap-wizard.css" rel="stylesheet">
     <link href="interfaces/default/css/plexpy.css" rel="stylesheet">
+    <link href="interfaces/default/css/selectize.bootstrap3.css" rel="stylesheet">
     <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
     <link href="interfaces/default/css/font-awesome.min.css" rel="stylesheet">
     <link rel="icon" type="image/x-icon" href="interfaces/default/images/favicon.ico"/>
@@ -40,45 +41,6 @@ from plexpy import common
                 </div>
             </div>
             <div class="wizard-card" data-cardname="card2">
-                <h3>Plex Media Server</h3>
-                <form>
-                    <p class="help-block">Enter your Plex Server details and then click the Verify button to make sure PlexPy can reach the server.</p>
-                <div class="wizard-input-section">
-                    <label for="pms_ip">Plex IP or Hostname</label>
-                    <div class="row">
-                        <div class="col-xs-8">
-                            <input type="text" class="form-control pms-settings" name="pms_ip" id="pms_ip" placeholder="127.0.0.1" value="${config['pms_ip']}" required>
-                        </div>
-                    </div>
-                </div>
-                <div class="wizard-input-section">
-                    <label for="pms_port">Port Number</label>
-                    <div class="row">
-                        <div class="col-xs-3">
-                            <input type="text" class="form-control pms-settings" name="pms_port" id="pms_port" placeholder="32400" value="${config['pms_port']}" required>
-                        </div>
-                        <div class="col-xs-4">
-                            <div class="checkbox">
-                                <label>
-                                    <input type="checkbox" id="pms_ssl" name="pms_ssl" value="1" ${config['pms_ssl']}> Force SSL
-                                </label>
-                            </div>
-                        </div>
-                        <div class="col-xs-4">
-                            <div class="checkbox">
-                                <label>
-                                    <input type="checkbox" id="pms_is_remote" name="pms_is_remote" value="1" ${config['pms_is_remote']}> Remote Server
-                                </label>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-                <input type="hidden" class="form-control pms-settings" id="pms_valid" data-validate="validatePMSip" value="">
-                <input type="hidden" class="form-control pms-settings" id="pms_identifier" name="pms_identifier" value="${config['pms_identifier']}">
-                <a class="btn btn-dark" id="verify-plex-server" href="#" role="button">Verify</a><span style="margin-left: 10px; display: none;" id="pms-verify-status"></span>
-            </div>
-
-            <div class="wizard-card" data-cardname="card3">
                 <h3>Plex Authentication</h3>
                 <p class="help-block">Enter your Plex.tv username and password. PlexPy does not store your username or password.</p>
                 <div class="wizard-input-section">
@@ -100,11 +62,57 @@ from plexpy import common
                 <input type="hidden" class="form-control pms-auth" name="pms_token" id="pms_token" value="${config['pms_token']}" data-validate="validatePMStoken">
                 <a class="btn btn-dark" id="pms-authenticate" href="#" role="button">Authenticate</a><span style="margin-left: 10px; display: none;" id="pms-token-status"></span>
             </div>
+            <div class="wizard-card" data-cardname="card3">
+                <h3>Plex Media Server</h3>
+                <form>
+                    <p class="help-block">Enter your Plex Server details and then click the Verify button to make sure PlexPy can reach the server.</p>
+                <div class="wizard-input-section">
+                    <label for="pms_ip">Plex IP or Hostname</label>
+                    <div class="row">
+                        <div class="col-xs-8">
+                            <select id="pms_ip" name="pms_ip"></select>
+                        </div>
+                    </div>
+                </div>
+                <div class="wizard-input-section">
+                    <label for="pms_port">Port Number</label>
+                    <div class="row">
+                        <div class="col-xs-3">
+                            <input type="text" class="form-control pms_settings" name="pms_port" id="pms_port" placeholder="32400" value="${config['pms_port']}" required>
+                        </div>
+                        <div class="col-xs-4">
+                            <div class="checkbox">
+                                <label>
+                                    <input type="checkbox" id="pms_ssl" name="pms_ssl" value="1"> Force SSL
+                                </label>
+                            </div>
+                        </div>
+                        <div class="col-xs-4">
+                            <div class="checkbox">
+                                <label>
+                                    <input type="checkbox" id="pms_is_remote" name="pms_is_remote" value="1"> Remote Server
+                                </label>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+                <input type="hidden" class="form-control pms-settings" id="pms_valid" data-validate="validatePMSip" value="">
+                <input type="hidden" class="form-control pms-settings" id="pms_identifier" name="pms_identifier" value="${config['pms_identifier']}">
+                <a class="btn btn-dark" id="verify-plex-server" href="#" role="button">Verify</a><span style="margin-left: 10px; display: none;" id="pms-verify-status"></span>
+            </div>
+
+
             <div class="wizard-card" data-cardname="card4">
                 <h3>Monitoring</h3>
+                <p class="help-block">Keep records of all movie, TV show, or music items played from your Plex Media Server.</p>
                 <div class="wizard-input-section">
-                    <input type="checkbox" id="video_logging_enable" name="video_logging_enable" value="1" ${config['video_logging_enable']}> Log Movies and TV
-                    <p class="help-block">Keep records of all video items played from your Plex Media Server.</p>
+                    <input type="checkbox" id="movie_logging_enable" name="movie_logging_enable" value="1" ${config['movie_logging_enable']}> Enable Movie Logging
+                </div>
+                <div class="wizard-input-section">
+                    <input type="checkbox" id="tv_logging_enable" name="tv_logging_enable" value="1" ${config['tv_logging_enable']}> Enable TV Show Logging
+                </div>
+                <div class="wizard-input-section">
+                    <input type="checkbox" id="music_logging_enable" name="music_logging_enable" value="1" ${config['music_logging_enable']}> Enable Music Logging
                 </div>
                 <div class="wizard-input-section">
                     <label for="logging_ignore_interval">Ignore Interval</label>
@@ -116,19 +124,16 @@ from plexpy import common
                     </div>
                     <p class="help-block">The interval (in seconds) PlexPy will wait for a video item to be active before logging it. 0 to disable.</p>
                 </div>
-                <!-- Music logging is still very experimental -- leave this for now.
-                <div class="wizard-input-section">
-                    <input type="checkbox" id="music_logging_enable" name="music_logging_enable" value="1"> Log Music
-                    <p class="help-block">Keep records of all audio items played from your Plex Media Server. VERY experimental.</p>
-                </div>
-                -->
             </div>
             <div class="wizard-card" data-cardname="card5" data-validate="validateNotifications">
                 <h3>Notifications</h3>
                 <p class="help-block">PlexPy supports a wide variety of notification options. To set up a notification agent conifgure this in <strong>Settings -> Notification Agents</strong>
                 after you have completed this setup wizard.</p><br/>
                 <div class="wizard-input-section">
-                    <input type="checkbox" name="movie_notify_enable" id="movie_notify_enable" value="1" ${config['movie_notify_enable']}> Enable notifications on Movie and TV playback
+                    <input type="checkbox" name="movie_notify_enable" id="movie_notify_enable" value="1" ${config['movie_notify_enable']}> Enable notifications on Movie playback
+                </div>
+                <div class="wizard-input-section">
+                    <input type="checkbox" name="tv_notify_enable" id="tv_notify_enable" value="1" ${config['tv_notify_enable']}> Enable notifications on TV Show playback
                 </div>
                 <div class="wizard-input-section">
                     <input type="checkbox" name="music_notify_enable" id="music_notify_enable" value="1" ${config['music_notify_enable']}> Enable notifications on Music playback
@@ -184,6 +189,7 @@ from plexpy import common
 
 <script src="interfaces/default/js/jquery-2.1.4.min.js"></script>
 <script src="interfaces/default/js/bootstrap3/bootstrap.min.js"></script>
+<script src="interfaces/default/js/selectize.min.js"></script>
 <script src="interfaces/default/js/script.js"></script>
 <script src="interfaces/default/js/bootstrap-wizard.min.js"></script>
 <script>
@@ -218,6 +224,74 @@ from plexpy import common
                 }
             })
         });
+
+        $select_pms = $('#pms_ip').selectize({
+            create: true,
+            createOnBlur: true,
+            openOnFocus: true,
+            maxItems: 1,
+            closeAfterSelect: true,
+            onInitialize: function () {
+                var s = this;
+                this.revertSettings.$children.each(function () {
+                    $.extend(s.options[this.value], $(this).data());
+                });
+
+            },
+            render: {
+                option: function (item, escape) {
+                    return '<div data-use_ssl="' + item.httpsRequired + '" data-local="' + item.local + '" data-ci="' + item.clientIdentifier + '" data-ip="' + item.ip + '" data-port="' + item.port + '">' + item.value + '</div>';
+                },
+                item: function (item, escape) {
+                    // first item is rendered before initialization bug?
+                    if (!item.ci) {
+                        $.extend(item,
+                        $(this.revertSettings.$children)
+                            .filter('[value="' + item.value + '"]').data());
+
+                    }
+                    return '<div data-use_ssl="' + item.httpsRequired + '" data-local="' + item.local + '" data-ci="' + item.clientIdentifier + '" data-ip="' + item.ip + '" data-port="' + item.port + '">' + item.value + '</div>';
+                }
+            },
+            onChange: function (item) {
+                var ci = $('.selectize-input').find('div').attr('data-ci');
+                var port = $('.selectize-input').find('div').attr('data-port')
+                var local = $('.selectize-input').find('div').attr('data-local')
+                var ssl = $('.selectize-input').find('div').attr('data-use_ssl')
+
+                $("#pms-verify-status").html("");
+                // If a option was added by a user its
+                // data-xxx="undefined"
+                if (ci != "undefined") {
+                    // To allow next step in the guide.
+                    // servers with clientIdentifier is verified
+                    $("#pms_identifier").val(ci);
+                    $("#pms_valid").val("valid");
+                    $("#pms-verify-status").html('<i class="fa fa-check"></i> Server found!').show();
+                } else {
+                    // Self made options must be verified
+                    $("#pms_valid").val("");
+                    $("#pms-verify-status").html("").hide();
+                }
+                // If the server is verified set the correct port
+                if (port != "undefined") {
+                    $('#pms_port').val(port);
+                } else {
+                    // set default port
+                    $('#pms_port').val("32400");
+                }
+                if (local != "undefined" && local == '0') {
+                    $('#pms_is_remote').prop('checked', true);
+                } else {
+                    $('#pms_is_remote').prop('checked', false);
+                }
+                if (ssl != "undefined" && ssl == "1") {
+                    $('#pms_ssl').prop('checked', true);
+                } else {
+                    $('#pms_ssl').prop('checked', false);
+                }
+            }
+        });
     });
 
 
@@ -371,6 +445,7 @@ from plexpy import common
                     $('#pms-token-status').fadeIn('fast');
                     $("#pms_token").val(authToken);
                     authenticated = true;
+                    getServerOptions(authToken)
                 }
             });
         } else {
@@ -399,7 +474,19 @@ from plexpy import common
             }
         });
     });
+
+    function getServerOptions(token) {
+        /* Set token and returns server options */
+        $.ajax({
+            url: "discover/" + token,
+            success: function (result) {
+                $('#pms_ip').html("")
+                // Add all servers to the "combobox"
+                $select_pms[0].selectize.addOption(result);
+            }
+        })
+    }
 </script>
 
 </body>
-</html>
+</html>

lib/websocket/__init__.py

@@ -0,0 +1,25 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+from ._core import *
+from ._app import WebSocketApp
+
+__version__ = "0.32.0"

lib/websocket/_abnf.py

@@ -0,0 +1,382 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+import six
+import array
+import struct
+import os
+from ._exceptions import *
+from ._utils import validate_utf8
+
+# closing frame status codes.
+STATUS_NORMAL = 1000
+STATUS_GOING_AWAY = 1001
+STATUS_PROTOCOL_ERROR = 1002
+STATUS_UNSUPPORTED_DATA_TYPE = 1003
+STATUS_STATUS_NOT_AVAILABLE = 1005
+STATUS_ABNORMAL_CLOSED = 1006
+STATUS_INVALID_PAYLOAD = 1007
+STATUS_POLICY_VIOLATION = 1008
+STATUS_MESSAGE_TOO_BIG = 1009
+STATUS_INVALID_EXTENSION = 1010
+STATUS_UNEXPECTED_CONDITION = 1011
+STATUS_TLS_HANDSHAKE_ERROR = 1015
+
+VALID_CLOSE_STATUS = (
+    STATUS_NORMAL,
+    STATUS_GOING_AWAY,
+    STATUS_PROTOCOL_ERROR,
+    STATUS_UNSUPPORTED_DATA_TYPE,
+    STATUS_INVALID_PAYLOAD,
+    STATUS_POLICY_VIOLATION,
+    STATUS_MESSAGE_TOO_BIG,
+    STATUS_INVALID_EXTENSION,
+    STATUS_UNEXPECTED_CONDITION,
+    )
+
+class ABNF(object):
+    """
+    ABNF frame class.
+    see http://tools.ietf.org/html/rfc5234
+    and http://tools.ietf.org/html/rfc6455#section-5.2
+    """
+
+    # operation code values.
+    OPCODE_CONT   = 0x0
+    OPCODE_TEXT   = 0x1
+    OPCODE_BINARY = 0x2
+    OPCODE_CLOSE  = 0x8
+    OPCODE_PING   = 0x9
+    OPCODE_PONG   = 0xa
+
+    # available operation code value tuple
+    OPCODES = (OPCODE_CONT, OPCODE_TEXT, OPCODE_BINARY, OPCODE_CLOSE,
+                OPCODE_PING, OPCODE_PONG)
+
+    # opcode human readable string
+    OPCODE_MAP = {
+        OPCODE_CONT: "cont",
+        OPCODE_TEXT: "text",
+        OPCODE_BINARY: "binary",
+        OPCODE_CLOSE: "close",
+        OPCODE_PING: "ping",
+        OPCODE_PONG: "pong"
+        }
+
+    # data length threashold.
+    LENGTH_7  = 0x7e
+    LENGTH_16 = 1 << 16
+    LENGTH_63 = 1 << 63
+
+    def __init__(self, fin=0, rsv1=0, rsv2=0, rsv3=0,
+                 opcode=OPCODE_TEXT, mask=1, data=""):
+        """
+        Constructor for ABNF.
+        please check RFC for arguments.
+        """
+        self.fin = fin
+        self.rsv1 = rsv1
+        self.rsv2 = rsv2
+        self.rsv3 = rsv3
+        self.opcode = opcode
+        self.mask = mask
+        if data == None:
+            data = ""
+        self.data = data
+        self.get_mask_key = os.urandom
+
+    def validate(self, skip_utf8_validation=False):
+        """
+        validate the ABNF frame.
+        skip_utf8_validation: skip utf8 validation.
+        """
+        if self.rsv1 or self.rsv2 or self.rsv3:
+            raise WebSocketProtocolException("rsv is not implemented, yet")
+
+        if self.opcode not in ABNF.OPCODES:
+            raise WebSocketProtocolException("Invalid opcode %r", self.opcode)
+
+        if self.opcode == ABNF.OPCODE_PING and not self.fin:
+            raise WebSocketProtocolException("Invalid ping frame.")
+
+        if self.opcode == ABNF.OPCODE_CLOSE:
+            l = len(self.data)
+            if not l:
+                return
+            if l == 1 or l >= 126:
+                raise WebSocketProtocolException("Invalid close frame.")
+            if l > 2 and not skip_utf8_validation and not validate_utf8(self.data[2:]):
+                raise WebSocketProtocolException("Invalid close frame.")
+
+            code = 256*six.byte2int(self.data[0:1]) + six.byte2int(self.data[1:2])
+            if not self._is_valid_close_status(code):
+                raise WebSocketProtocolException("Invalid close opcode.")
+
+    def _is_valid_close_status(self, code):
+        return code in VALID_CLOSE_STATUS or (3000 <= code <5000)
+
+    def __str__(self):
+        return "fin=" + str(self.fin) \
+                + " opcode=" + str(self.opcode) \
+                + " data=" + str(self.data)
+
+    @staticmethod
+    def create_frame(data, opcode, fin=1):
+        """
+        create frame to send text, binary and other data.
+
+        data: data to send. This is string value(byte array).
+            if opcode is OPCODE_TEXT and this value is uniocde,
+            data value is conveted into unicode string, automatically.
+
+        opcode: operation code. please see OPCODE_XXX.
+
+        fin: fin flag. if set to 0, create continue fragmentation.
+        """
+        if opcode == ABNF.OPCODE_TEXT and isinstance(data, six.text_type):
+            data = data.encode("utf-8")
+        # mask must be set if send data from client
+        return ABNF(fin, 0, 0, 0, opcode, 1, data)
+
+    def format(self):
+        """
+        format this object to string(byte array) to send data to server.
+        """
+        if any(x not in (0, 1) for x in [self.fin, self.rsv1, self.rsv2, self.rsv3]):
+            raise ValueError("not 0 or 1")
+        if self.opcode not in ABNF.OPCODES:
+            raise ValueError("Invalid OPCODE")
+        length = len(self.data)
+        if length >= ABNF.LENGTH_63:
+            raise ValueError("data is too long")
+
+        frame_header = chr(self.fin << 7
+                           | self.rsv1 << 6 | self.rsv2 << 5 | self.rsv3 << 4
+                           | self.opcode)
+        if length < ABNF.LENGTH_7:
+            frame_header += chr(self.mask << 7 | length)
+            frame_header = six.b(frame_header)
+        elif length < ABNF.LENGTH_16:
+            frame_header += chr(self.mask << 7 | 0x7e)
+            frame_header = six.b(frame_header)
+            frame_header += struct.pack("!H", length)
+        else:
+            frame_header += chr(self.mask << 7 | 0x7f)
+            frame_header = six.b(frame_header)
+            frame_header += struct.pack("!Q", length)
+
+        if not self.mask:
+            return frame_header + self.data
+        else:
+            mask_key = self.get_mask_key(4)
+            return frame_header + self._get_masked(mask_key)
+
+    def _get_masked(self, mask_key):
+        s = ABNF.mask(mask_key, self.data)
+
+        if isinstance(mask_key, six.text_type):
+            mask_key = mask_key.encode('utf-8')
+
+        return mask_key + s
+
+    @staticmethod
+    def mask(mask_key, data):
+        """
+        mask or unmask data. Just do xor for each byte
+
+        mask_key: 4 byte string(byte).
+
+        data: data to mask/unmask.
+        """
+        if data == None:
+            data = ""
+        if isinstance(mask_key, six.text_type):
+            mask_key = six.b(mask_key)
+
+        if isinstance(data, six.text_type):
+            data = six.b(data)
+
+        _m = array.array("B", mask_key)
+        _d = array.array("B", data)
+        for i in range(len(_d)):
+            _d[i] ^= _m[i % 4]
+
+        if six.PY3:
+            return _d.tobytes()
+        else:
+            return _d.tostring()
+
+
+class frame_buffer(object):
+    _HEADER_MASK_INDEX = 5
+    _HEADER_LENGHT_INDEX = 6
+
+    def __init__(self, recv_fn, skip_utf8_validation):
+        self.recv = recv_fn
+        self.skip_utf8_validation = skip_utf8_validation
+        # Buffers over the packets from the layer beneath until desired amount
+        # bytes of bytes are received.
+        self.recv_buffer = []
+        self.clear()
+
+    def clear(self):
+        self.header = None
+        self.length = None
+        self.mask = None
+
+    def has_received_header(self):
+        return  self.header is None
+
+    def recv_header(self):
+        header = self.recv_strict(2)
+        b1 = header[0]
+
+        if six.PY2:
+            b1 = ord(b1)
+
+        fin = b1 >> 7 & 1
+        rsv1 = b1 >> 6 & 1
+        rsv2 = b1 >> 5 & 1
+        rsv3 = b1 >> 4 & 1
+        opcode = b1 & 0xf
+        b2 = header[1]
+
+        if six.PY2:
+            b2 = ord(b2)
+
+        has_mask = b2 >> 7 & 1
+        length_bits = b2 & 0x7f
+
+        self.header = (fin, rsv1, rsv2, rsv3, opcode, has_mask, length_bits)
+
+    def has_mask(self):
+        if not self.header:
+            return False
+        return self.header[frame_buffer._HEADER_MASK_INDEX]
+
+
+    def has_received_length(self):
+        return self.length is None
+
+    def recv_length(self):
+        bits = self.header[frame_buffer._HEADER_LENGHT_INDEX]
+        length_bits = bits & 0x7f
+        if length_bits == 0x7e:
+            v = self.recv_strict(2)
+            self.length = struct.unpack("!H", v)[0]
+        elif length_bits == 0x7f:
+            v = self.recv_strict(8)
+            self.length = struct.unpack("!Q", v)[0]
+        else:
+            self.length = length_bits
+
+    def has_received_mask(self):
+        return self.mask is None
+
+    def recv_mask(self):
+        self.mask = self.recv_strict(4) if self.has_mask() else ""
+
+    def recv_frame(self):
+        # Header
+        if self.has_received_header():
+            self.recv_header()
+        (fin, rsv1, rsv2, rsv3, opcode, has_mask, _) = self.header
+
+        # Frame length
+        if self.has_received_length():
+            self.recv_length()
+        length = self.length
+
+        # Mask
+        if self.has_received_mask():
+            self.recv_mask()
+        mask = self.mask
+
+        # Payload
+        payload = self.recv_strict(length)
+        if has_mask:
+            payload = ABNF.mask(mask, payload)
+
+        # Reset for next frame
+        self.clear()
+
+        frame = ABNF(fin, rsv1, rsv2, rsv3, opcode, has_mask, payload)
+        frame.validate(self.skip_utf8_validation)
+
+        return frame
+
+    def recv_strict(self, bufsize):
+        shortage = bufsize - sum(len(x) for x in self.recv_buffer)
+        while shortage > 0:
+            # Limit buffer size that we pass to socket.recv() to avoid
+            # fragmenting the heap -- the number of bytes recv() actually
+            # reads is limited by socket buffer and is relatively small,
+            # yet passing large numbers repeatedly causes lots of large
+            # buffers allocated and then shrunk, which results in fragmentation.
+            bytes = self.recv(min(16384, shortage))
+            self.recv_buffer.append(bytes)
+            shortage -= len(bytes)
+
+        unified = six.b("").join(self.recv_buffer)
+
+        if shortage == 0:
+            self.recv_buffer = []
+            return unified
+        else:
+            self.recv_buffer = [unified[bufsize:]]
+            return unified[:bufsize]
+
+
+class continuous_frame(object):
+    def __init__(self, fire_cont_frame, skip_utf8_validation):
+        self.fire_cont_frame = fire_cont_frame
+        self.skip_utf8_validation = skip_utf8_validation
+        self.cont_data = None
+        self.recving_frames = None
+
+    def validate(self, frame):
+        if not self.recving_frames and frame.opcode == ABNF.OPCODE_CONT:
+            raise WebSocketProtocolException("Illegal frame")
+        if self.recving_frames and frame.opcode in (ABNF.OPCODE_TEXT, ABNF.OPCODE_BINARY):
+            raise WebSocketProtocolException("Illegal frame")
+
+    def add(self, frame):
+        if self.cont_data:
+            self.cont_data[1] += frame.data
+        else:
+            if frame.opcode in (ABNF.OPCODE_TEXT, ABNF.OPCODE_BINARY):
+                self.recving_frames = frame.opcode
+            self.cont_data = [frame.opcode, frame.data]
+
+        if frame.fin:
+            self.recving_frames = None
+
+    def is_fire(self, frame):
+        return frame.fin or self.fire_cont_frame
+
+    def extract(self, frame):
+        data = self.cont_data
+        self.cont_data = None
+        frame.data = data[1]
+        if not self.fire_cont_frame and data[0] == ABNF.OPCODE_TEXT and not self.skip_utf8_validation and not validate_utf8(frame.data):
+            raise WebSocketPayloadException("cannot decode: " + repr(frame.data))
+
+        return [data[0], frame]

lib/websocket/_app.py

@@ -0,0 +1,236 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+"""
+WebSocketApp provides higher level APIs.
+"""
+import threading
+import time
+import traceback
+import sys
+import select
+import six
+
+from ._core import WebSocket, getdefaulttimeout
+from ._exceptions import *
+from ._logging import *
+from websocket._abnf import ABNF
+
+__all__ = ["WebSocketApp"]
+
+
+class WebSocketApp(object):
+    """
+    Higher level of APIs are provided.
+    The interface is like JavaScript WebSocket object.
+    """
+    def __init__(self, url, header=[],
+                 on_open=None, on_message=None, on_error=None,
+                 on_close=None, on_ping=None, on_pong=None,
+                 on_cont_message=None,
+                 keep_running=True, get_mask_key=None, cookie=None,
+                 subprotocols=None):
+        """
+        url: websocket url.
+        header: custom header for websocket handshake.
+        on_open: callable object which is called at opening websocket.
+          this function has one argument. The arugment is this class object.
+        on_message: callbale object which is called when recieved data.
+         on_message has 2 arguments.
+         The 1st arugment is this class object.
+         The passing 2nd arugment is utf-8 string which we get from the server.
+        on_error: callable object which is called when we get error.
+         on_error has 2 arguments.
+         The 1st arugment is this class object.
+         The passing 2nd arugment is exception object.
+        on_close: callable object which is called when closed the connection.
+         this function has one argument. The arugment is this class object.
+        on_cont_message: callback object which is called when recieve continued
+         frame data.
+         on_message has 3 arguments.
+         The 1st arugment is this class object.
+         The passing 2nd arugment is utf-8 string which we get from the server.
+         The 3rd arugment is continue flag. if 0, the data continue
+         to next frame data
+        keep_running: a boolean flag indicating whether the app's main loop
+          should keep running, defaults to True
+        get_mask_key: a callable to produce new mask keys,
+          see the WebSocket.set_mask_key's docstring for more information
+        subprotocols: array of available sub protocols. default is None.
+        """
+        self.url = url
+        self.header = header
+        self.cookie = cookie
+        self.on_open = on_open
+        self.on_message = on_message
+        self.on_error = on_error
+        self.on_close = on_close
+        self.on_ping = on_ping
+        self.on_pong = on_pong
+        self.on_cont_message = on_cont_message
+        self.keep_running = keep_running
+        self.get_mask_key = get_mask_key
+        self.sock = None
+        self.last_ping_tm = 0
+        self.subprotocols = subprotocols
+
+    def send(self, data, opcode=ABNF.OPCODE_TEXT):
+        """
+        send message.
+        data: message to send. If you set opcode to OPCODE_TEXT,
+              data must be utf-8 string or unicode.
+        opcode: operation code of data. default is OPCODE_TEXT.
+        """
+
+        if not self.sock or self.sock.send(data, opcode) == 0:
+            raise WebSocketConnectionClosedException("Connection is already closed.")
+
+    def close(self):
+        """
+        close websocket connection.
+        """
+        self.keep_running = False
+        if self.sock:
+            self.sock.close()
+
+    def _send_ping(self, interval, event):
+        while not event.wait(interval):
+            self.last_ping_tm = time.time()
+            if self.sock:
+                self.sock.ping()
+
+    def run_forever(self, sockopt=None, sslopt=None,
+                    ping_interval=0, ping_timeout=None,
+                    http_proxy_host=None, http_proxy_port=None,
+                    http_no_proxy=None, http_proxy_auth=None,
+                    skip_utf8_validation=False,
+                    host=None, origin=None):
+        """
+        run event loop for WebSocket framework.
+        This loop is infinite loop and is alive during websocket is available.
+        sockopt: values for socket.setsockopt.
+            sockopt must be tuple
+            and each element is argument of sock.setscokopt.
+        sslopt: ssl socket optional dict.
+        ping_interval: automatically send "ping" command
+            every specified period(second)
+            if set to 0, not send automatically.
+        ping_timeout: timeout(second) if the pong message is not recieved.
+        http_proxy_host: http proxy host name.
+        http_proxy_port: http proxy port. If not set, set to 80.
+        http_no_proxy: host names, which doesn't use proxy.
+        skip_utf8_validation: skip utf8 validation.
+        host: update host header.
+        origin: update origin header.
+        """
+
+        if not ping_timeout or ping_timeout <= 0:
+            ping_timeout = None
+        if sockopt is None:
+            sockopt = []
+        if sslopt is None:
+            sslopt = {}
+        if self.sock:
+            raise WebSocketException("socket is already opened")
+        thread = None
+        close_frame = None
+
+        try:
+            self.sock = WebSocket(self.get_mask_key,
+                sockopt=sockopt, sslopt=sslopt,
+                fire_cont_frame=self.on_cont_message and True or False,
+                skip_utf8_validation=skip_utf8_validation)
+            self.sock.settimeout(getdefaulttimeout())
+            self.sock.connect(self.url, header=self.header, cookie=self.cookie,
+                http_proxy_host=http_proxy_host,
+                http_proxy_port=http_proxy_port,
+                http_no_proxy=http_no_proxy, http_proxy_auth=http_proxy_auth,
+                subprotocols=self.subprotocols,
+                host=host, origin=origin)
+            self._callback(self.on_open)
+
+            if ping_interval:
+                event = threading.Event()
+                thread = threading.Thread(target=self._send_ping, args=(ping_interval, event))
+                thread.setDaemon(True)
+                thread.start()
+
+            while self.sock.connected:
+                r, w, e = select.select((self.sock.sock, ), (), (), ping_timeout)
+                if not self.keep_running:
+                    break
+                if ping_timeout and self.last_ping_tm and time.time() - self.last_ping_tm > ping_timeout:
+                    self.last_ping_tm = 0
+                    raise WebSocketTimeoutException("ping timed out")
+
+                if r:
+                    op_code, frame = self.sock.recv_data_frame(True)
+                    if op_code == ABNF.OPCODE_CLOSE:
+                        close_frame = frame
+                        break
+                    elif op_code == ABNF.OPCODE_PING:
+                        self._callback(self.on_ping, frame.data)
+                    elif op_code == ABNF.OPCODE_PONG:
+                        self._callback(self.on_pong, frame.data)
+                    elif op_code == ABNF.OPCODE_CONT and self.on_cont_message:
+                        self._callback(self.on_cont_message, frame.data, frame.fin)
+                    else:
+                        data = frame.data
+                        if six.PY3 and frame.opcode == ABNF.OPCODE_TEXT:
+                            data = data.decode("utf-8")
+                        self._callback(self.on_message, data)
+        except Exception as e:
+            self._callback(self.on_error, e)
+        finally:
+            if thread:
+                event.set()
+                thread.join()
+                self.keep_running = False
+            self.sock.close()
+            self._callback(self.on_close,
+                *self._get_close_args(close_frame.data if close_frame else None))
+            self.sock = None
+
+    def _get_close_args(self, data):
+        """ this functions extracts the code, reason from the close body
+        if they exists, and if the self.on_close except three arguments """
+        import inspect
+        # if the on_close callback is "old", just return empty list
+        if not self.on_close or len(inspect.getargspec(self.on_close).args) != 3:
+            return []
+
+        if data and len(data) >= 2:
+            code = 256*six.byte2int(data[0:1]) + six.byte2int(data[1:2])
+            reason = data[2:].decode('utf-8')
+            return [code, reason]
+
+        return [None, None]
+
+    def _callback(self, callback, *args):
+        if callback:
+            try:
+                callback(self, *args)
+            except Exception as e:
+                error(e)
+                if isEnabledForDebug():
+                    _, _, tb = sys.exc_info()
+                    traceback.print_tb(tb)

lib/websocket/_core.py

@@ -0,0 +1,482 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+from __future__ import print_function
+
+
+import six
+import socket
+
+if six.PY3:
+    from base64 import encodebytes as base64encode
+else:
+    from base64 import encodestring as base64encode
+
+import struct
+import threading
+
+# websocket modules
+from ._exceptions import *
+from ._abnf import *
+from ._socket import *
+from ._utils import *
+from ._url import *
+from ._logging import *
+from ._http import *
+from ._handshake import *
+from ._ssl_compat import *
+
+"""
+websocket python client.
+=========================
+
+This version support only hybi-13.
+Please see http://tools.ietf.org/html/rfc6455 for protocol.
+"""
+
+
+def create_connection(url, timeout=None, **options):
+    """
+    connect to url and return websocket object.
+
+    Connect to url and return the WebSocket object.
+    Passing optional timeout parameter will set the timeout on the socket.
+    If no timeout is supplied,
+    the global default timeout setting returned by getdefauttimeout() is used.
+    You can customize using 'options'.
+    If you set "header" list object, you can set your own custom header.
+
+    >>> conn = create_connection("ws://echo.websocket.org/",
+         ...     header=["User-Agent: MyProgram",
+         ...             "x-custom: header"])
+
+
+    timeout: socket timeout time. This value is integer.
+             if you set None for this value,
+             it means "use default_timeout value"
+
+
+    options: "header" -> custom http header list.
+             "cookie" -> cookie value.
+             "origin" -> custom origin url.
+             "host"   -> custom host header string.
+             "http_proxy_host" - http proxy host name.
+             "http_proxy_port" - http proxy port. If not set, set to 80.
+             "http_no_proxy"   - host names, which doesn't use proxy.
+             "http_proxy_auth" - http proxy auth infomation.
+                                    tuple of username and password.
+                                    default is None
+             "enable_multithread" -> enable lock for multithread.
+             "sockopt" -> socket options
+             "sslopt" -> ssl option
+             "subprotocols" - array of available sub protocols.
+                              default is None.
+             "skip_utf8_validation" - skip utf8 validation.
+    """
+    sockopt = options.get("sockopt", [])
+    sslopt = options.get("sslopt", {})
+    fire_cont_frame = options.get("fire_cont_frame", False)
+    enable_multithread = options.get("enable_multithread", False)
+    skip_utf8_validation = options.get("skip_utf8_validation", False)
+    websock = WebSocket(sockopt=sockopt, sslopt=sslopt,
+                        fire_cont_frame=fire_cont_frame,
+                        enable_multithread=enable_multithread,
+                        skip_utf8_validation=skip_utf8_validation)
+    websock.settimeout(timeout if timeout is not None else getdefaulttimeout())
+    websock.connect(url, **options)
+    return websock
+
+
+class WebSocket(object):
+    """
+    Low level WebSocket interface.
+    This class is based on
+      The WebSocket protocol draft-hixie-thewebsocketprotocol-76
+      http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
+
+    We can connect to the websocket server and send/recieve data.
+    The following example is a echo client.
+
+    >>> import websocket
+    >>> ws = websocket.WebSocket()
+    >>> ws.connect("ws://echo.websocket.org")
+    >>> ws.send("Hello, Server")
+    >>> ws.recv()
+    'Hello, Server'
+    >>> ws.close()
+
+    get_mask_key: a callable to produce new mask keys, see the set_mask_key
+      function's docstring for more details
+    sockopt: values for socket.setsockopt.
+        sockopt must be tuple and each element is argument of sock.setscokopt.
+    sslopt: dict object for ssl socket option.
+    fire_cont_frame: fire recv event for each cont frame. default is False
+    enable_multithread: if set to True, lock send method.
+    skip_utf8_validation: skip utf8 validation.
+    """
+
+    def __init__(self, get_mask_key=None, sockopt=None, sslopt=None,
+                 fire_cont_frame=False, enable_multithread=False,
+                 skip_utf8_validation=False):
+        """
+        Initalize WebSocket object.
+        """
+        self.sock_opt = sock_opt(sockopt, sslopt)
+        self.handshake_response = None
+        self.sock = None
+
+        self.connected = False
+        self.get_mask_key = get_mask_key
+        # These buffer over the build-up of a single frame.
+        self.frame_buffer = frame_buffer(self._recv, skip_utf8_validation)
+        self.cont_frame = continuous_frame(fire_cont_frame, skip_utf8_validation)
+
+        if enable_multithread:
+            self.lock = threading.Lock()
+        else:
+            self.lock = NoLock()
+
+    def __iter__(self):
+        """
+        Allow iteration over websocket, implying sequential `recv` executions.
+        """
+        while True:
+            yield self.recv()
+
+    def __next__(self):
+        return self.recv()
+
+    def next(self):
+        return self.__next__()
+
+    def fileno(self):
+        return self.sock.fileno()
+
+    def set_mask_key(self, func):
+        """
+        set function to create musk key. You can custumize mask key generator.
+        Mainly, this is for testing purpose.
+
+        func: callable object. the fuct must 1 argument as integer.
+              The argument means length of mask key.
+              This func must be return string(byte array),
+              which length is argument specified.
+        """
+        self.get_mask_key = func
+
+    def gettimeout(self):
+        """
+        Get the websocket timeout(second).
+        """
+        return self.sock_opt.timeout
+
+    def settimeout(self, timeout):
+        """
+        Set the timeout to the websocket.
+
+        timeout: timeout time(second).
+        """
+        self.sock_opt.timeout = timeout
+        if self.sock:
+            self.sock.settimeout(timeout)
+
+    timeout = property(gettimeout, settimeout)
+
+    def getsubprotocol(self):
+        """
+        get subprotocol
+        """
+        if self.handshake_response:
+            return self.handshake_response.subprotocol
+        else:
+            return None
+
+    subprotocol = property(getsubprotocol)
+
+    def getstatus(self):
+        """
+        get handshake status
+        """
+        if self.handshake_response:
+            return self.handshake_response.status
+        else:
+            return None
+
+    status = property(getstatus)
+
+    def getheaders(self):
+        """
+        get handshake response header
+        """
+        if self.handshake_response:
+            return self.handshake_response.headers
+        else:
+            return None
+
+    headers = property(getheaders)
+
+    def connect(self, url, **options):
+        """
+        Connect to url. url is websocket url scheme.
+        ie. ws://host:port/resource
+        You can customize using 'options'.
+        If you set "header" list object, you can set your own custom header.
+
+        >>> ws = WebSocket()
+        >>> ws.connect("ws://echo.websocket.org/",
+                ...     header=["User-Agent: MyProgram",
+                ...             "x-custom: header"])
+
+        timeout: socket timeout time. This value is integer.
+                 if you set None for this value,
+                 it means "use default_timeout value"
+
+        options: "header" -> custom http header list.
+                 "cookie" -> cookie value.
+                 "origin" -> custom origin url.
+                 "host"   -> custom host header string.
+                 "http_proxy_host" - http proxy host name.
+                 "http_proxy_port" - http proxy port. If not set, set to 80.
+                 "http_no_proxy"   - host names, which doesn't use proxy.
+                 "http_proxy_auth" - http proxy auth infomation.
+                                     tuple of username and password.
+                                     defualt is None
+                 "subprotocols" - array of available sub protocols.
+                                  default is None.
+
+        """
+        self.sock, addrs = connect(url, self.sock_opt, proxy_info(**options))
+
+        try:
+            self.handshake_response = handshake(self.sock, *addrs, **options)
+            self.connected = True
+        except:
+            if self.sock:
+                self.sock.close()
+                self.sock = None
+            raise
+
+    def send(self, payload, opcode=ABNF.OPCODE_TEXT):
+        """
+        Send the data as string.
+
+        payload: Payload must be utf-8 string or unicode,
+                  if the opcode is OPCODE_TEXT.
+                  Otherwise, it must be string(byte array)
+
+        opcode: operation code to send. Please see OPCODE_XXX.
+        """
+
+        frame = ABNF.create_frame(payload, opcode)
+        return self.send_frame(frame)
+
+    def send_frame(self, frame):
+        """
+        Send the data frame.
+
+        frame: frame data created  by ABNF.create_frame
+
+        >>> ws = create_connection("ws://echo.websocket.org/")
+        >>> frame = ABNF.create_frame("Hello", ABNF.OPCODE_TEXT)
+        >>> ws.send_frame(frame)
+        >>> cont_frame = ABNF.create_frame("My name is ", ABNF.OPCODE_CONT, 0)
+        >>> ws.send_frame(frame)
+        >>> cont_frame = ABNF.create_frame("Foo Bar", ABNF.OPCODE_CONT, 1)
+        >>> ws.send_frame(frame)
+
+        """
+        if self.get_mask_key:
+            frame.get_mask_key = self.get_mask_key
+        data = frame.format()
+        length = len(data)
+        trace("send: " + repr(data))
+
+        with self.lock:
+            while data:
+                l = self._send(data)
+                data = data[l:]
+
+        return length
+
+    def send_binary(self, payload):
+        return self.send(payload, ABNF.OPCODE_BINARY)
+
+    def ping(self, payload=""):
+        """
+        send ping data.
+
+        payload: data payload to send server.
+        """
+        if isinstance(payload, six.text_type):
+            payload = payload.encode("utf-8")
+        self.send(payload, ABNF.OPCODE_PING)
+
+    def pong(self, payload):
+        """
+        send pong data.
+
+        payload: data payload to send server.
+        """
+        if isinstance(payload, six.text_type):
+            payload = payload.encode("utf-8")
+        self.send(payload, ABNF.OPCODE_PONG)
+
+    def recv(self):
+        """
+        Receive string data(byte array) from the server.
+
+        return value: string(byte array) value.
+        """
+        opcode, data = self.recv_data()
+        if six.PY3 and opcode == ABNF.OPCODE_TEXT:
+            return data.decode("utf-8")
+        elif opcode == ABNF.OPCODE_TEXT or opcode == ABNF.OPCODE_BINARY:
+            return data
+        else:
+            return ''
+
+    def recv_data(self, control_frame=False):
+        """
+        Recieve data with operation code.
+
+        control_frame: a boolean flag indicating whether to return control frame
+        data, defaults to False
+
+        return  value: tuple of operation code and string(byte array) value.
+        """
+        opcode, frame = self.recv_data_frame(control_frame)
+        return opcode, frame.data
+
+    def recv_data_frame(self, control_frame=False):
+        """
+        Recieve data with operation code.
+
+        control_frame: a boolean flag indicating whether to return control frame
+        data, defaults to False
+
+        return  value: tuple of operation code and string(byte array) value.
+        """
+        while True:
+            frame = self.recv_frame()
+            if not frame:
+                # handle error:
+                # 'NoneType' object has no attribute 'opcode'
+                raise WebSocketProtocolException("Not a valid frame %s" % frame)
+            elif frame.opcode in (ABNF.OPCODE_TEXT, ABNF.OPCODE_BINARY, ABNF.OPCODE_CONT):
+                self.cont_frame.validate(frame)
+                self.cont_frame.add(frame)
+
+                if self.cont_frame.is_fire(frame):
+                    return self.cont_frame.extract(frame)
+
+            elif frame.opcode == ABNF.OPCODE_CLOSE:
+                self.send_close()
+                return (frame.opcode, frame)
+            elif frame.opcode == ABNF.OPCODE_PING:
+                if len(frame.data) < 126:
+                    self.pong(frame.data)
+                else:
+                    raise WebSocketProtocolException("Ping message is too long")
+                if control_frame:
+                    return (frame.opcode, frame)
+            elif frame.opcode == ABNF.OPCODE_PONG:
+                if control_frame:
+                    return (frame.opcode, frame)
+
+    def recv_frame(self):
+        """
+        recieve data as frame from server.
+
+        return value: ABNF frame object.
+        """
+        return self.frame_buffer.recv_frame()
+
+    def send_close(self, status=STATUS_NORMAL, reason=six.b("")):
+        """
+        send close data to the server.
+
+        status: status code to send. see STATUS_XXX.
+
+        reason: the reason to close. This must be string or bytes.
+        """
+        if status < 0 or status >= ABNF.LENGTH_16:
+            raise ValueError("code is invalid range")
+        self.connected = False
+        self.send(struct.pack('!H', status) + reason, ABNF.OPCODE_CLOSE)
+
+    def close(self, status=STATUS_NORMAL, reason=six.b("")):
+        """
+        Close Websocket object
+
+        status: status code to send. see STATUS_XXX.
+
+        reason: the reason to close. This must be string.
+        """
+        if self.connected:
+            if status < 0 or status >= ABNF.LENGTH_16:
+                raise ValueError("code is invalid range")
+
+            try:
+                self.connected = False
+                self.send(struct.pack('!H', status) + reason, ABNF.OPCODE_CLOSE)
+                timeout = self.sock.gettimeout()
+                self.sock.settimeout(3)
+                try:
+                    frame = self.recv_frame()
+                    if isEnabledForError():
+                        recv_status = struct.unpack("!H", frame.data)[0]
+                        if recv_status != STATUS_NORMAL:
+                            error("close status: " + repr(recv_status))
+                except:
+                    pass
+                self.sock.settimeout(timeout)
+                self.sock.shutdown(socket.SHUT_RDWR)
+            except:
+                pass
+
+        self.shutdown()
+
+    def abort(self):
+        """
+        Low-level asynchonous abort, wakes up other threads that are waiting in recv_*
+        """
+        if self.connected:
+            self.sock.shutdown(socket.SHUT_RDWR)
+
+    def shutdown(self):
+        "close socket, immediately."
+        if self.sock:
+            self.sock.close()
+            self.sock = None
+            self.connected = False
+
+    def _send(self, data):
+        return send(self.sock, data)
+
+    def _recv(self, bufsize):
+        try:
+            return recv(self.sock, bufsize)
+        except WebSocketConnectionClosedException:
+            if self.sock:
+                self.sock.close()
+            self.sock = None
+            self.connected = False
+            raise

lib/websocket/_exceptions.py

@@ -0,0 +1,65 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+
+"""
+define websocket exceptions
+"""
+
+class WebSocketException(Exception):
+    """
+    websocket exeception class.
+    """
+    pass
+
+class WebSocketProtocolException(WebSocketException):
+    """
+    If the webscoket protocol is invalid, this exception will be raised.
+    """
+    pass
+
+class WebSocketPayloadException(WebSocketException):
+    """
+    If the webscoket payload is invalid, this exception will be raised.
+    """
+    pass
+
+class WebSocketConnectionClosedException(WebSocketException):
+    """
+    If remote host closed the connection or some network error happened,
+    this exception will be raised.
+    """
+    pass
+
+class WebSocketTimeoutException(WebSocketException):
+    """
+    WebSocketTimeoutException will be raised at socket timeout during read/write data.
+    """
+    pass
+
+class WebSocketProxyException(WebSocketException):
+    """
+    WebSocketProxyException will be raised when proxy error occured.
+    """
+    pass
+
+

lib/websocket/_handshake.py

@@ -0,0 +1,155 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+import six
+if six.PY3:
+    from base64 import encodebytes as base64encode
+else:
+    from base64 import encodestring as base64encode
+
+import uuid
+import hashlib
+
+from ._logging import *
+from ._url import *
+from ._socket import*
+from ._http import *
+from ._exceptions import *
+
+__all__ = ["handshake_response", "handshake"]
+
+# websocket supported version.
+VERSION = 13
+
+
+class handshake_response(object):
+    def __init__(self, status, headers, subprotocol):
+        self.status = status
+        self.headers = headers
+        self.subprotocol = subprotocol
+
+
+def handshake(sock, hostname, port, resource, **options):
+    headers, key = _get_handshake_headers(resource, hostname, port, options)
+
+    header_str = "\r\n".join(headers)
+    send(sock, header_str)
+    dump("request header", header_str)
+
+    status, resp = _get_resp_headers(sock)
+    success, subproto = _validate(resp, key, options.get("subprotocols"))
+    if not success:
+        raise WebSocketException("Invalid WebSocket Header")
+
+    return handshake_response(status, resp, subproto)
+
+
+def _get_handshake_headers(resource, host, port, options):
+    headers = []
+    headers.append("GET %s HTTP/1.1" % resource)
+    headers.append("Upgrade: websocket")
+    headers.append("Connection: Upgrade")
+    if port == 80:
+        hostport = host
+    else:
+        hostport = "%s:%d" % (host, port)
+
+    if "host" in options and options["host"]:
+        headers.append("Host: %s" % options["host"])
+    else:
+        headers.append("Host: %s" % hostport)
+
+    if "origin" in options and options["origin"]:
+        headers.append("Origin: %s" % options["origin"])
+    else:
+        headers.append("Origin: http://%s" % hostport)
+
+    key = _create_sec_websocket_key()
+    headers.append("Sec-WebSocket-Key: %s" % key)
+    headers.append("Sec-WebSocket-Version: %s" % VERSION)
+
+    subprotocols = options.get("subprotocols")
+    if subprotocols:
+        headers.append("Sec-WebSocket-Protocol: %s" % ",".join(subprotocols))
+
+    if "header" in options:
+        headers.extend(options["header"])
+
+    cookie = options.get("cookie", None)
+
+    if cookie:
+        headers.append("Cookie: %s" % cookie)
+
+    headers.append("")
+    headers.append("")
+
+    return headers, key
+
+
+def _get_resp_headers(sock, success_status=101):
+    status, resp_headers = read_headers(sock)
+    if status != success_status:
+        raise WebSocketException("Handshake status %d" % status)
+    return status, resp_headers
+
+_HEADERS_TO_CHECK = {
+    "upgrade": "websocket",
+    "connection": "upgrade",
+    }
+
+
+def _validate(headers, key, subprotocols):
+    subproto = None
+    for k, v in _HEADERS_TO_CHECK.items():
+        r = headers.get(k, None)
+        if not r:
+            return False, None
+        r = r.lower()
+        if v != r:
+            return False, None
+
+    if subprotocols:
+        subproto = headers.get("sec-websocket-protocol", None).lower()
+        if not subproto or subproto not in [s.lower() for s in subprotocols]:
+            error("Invalid subprotocol: " + str(subprotocols))
+            return False, None
+
+    result = headers.get("sec-websocket-accept", None)
+    if not result:
+        return False, None
+    result = result.lower()
+
+    if isinstance(result, six.text_type):
+        result = result.encode('utf-8')
+
+    value = (key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11").encode('utf-8')
+    hashed = base64encode(hashlib.sha1(value).digest()).strip().lower()
+    success = (hashed == result)
+    if success:
+        return True, subproto
+    else:
+        return False, None
+
+
+def _create_sec_websocket_key():
+    uid = uuid.uuid4()
+    return base64encode(uid.bytes).decode('utf-8').strip()

lib/websocket/_http.py

@@ -0,0 +1,215 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+import six
+import socket
+import errno
+import os
+import sys
+
+if six.PY3:
+    from base64 import encodebytes as base64encode
+else:
+    from base64 import encodestring as base64encode
+
+from ._logging import *
+from ._url import *
+from ._socket import*
+from ._exceptions import *
+from ._ssl_compat import *
+
+__all__ = ["proxy_info", "connect", "read_headers"]
+
+class proxy_info(object):
+    def __init__(self, **options):
+        self.host = options.get("http_proxy_host", None)
+        if self.host:
+            self.port = options.get("http_proxy_port", 0)
+            self.auth =  options.get("http_proxy_auth", None)
+            self.no_proxy = options.get("http_no_proxy", None)
+        else:
+            self.port = 0
+            self.auth = None
+            self.no_proxy = None
+
+def connect(url, options, proxy):
+    hostname, port, resource, is_secure = parse_url(url)
+    addrinfo_list, need_tunnel, auth = _get_addrinfo_list(hostname, port, is_secure, proxy)
+    if not addrinfo_list:
+        raise WebSocketException(
+            "Host not found.: " + hostname + ":" + str(port))
+
+    sock = None
+    try:
+        sock = _open_socket(addrinfo_list, options.sockopt, options.timeout)
+        if need_tunnel:
+            sock = _tunnel(sock, hostname, port, auth)
+
+        if is_secure:
+            if HAVE_SSL:
+                sock = _ssl_socket(sock, options.sslopt, hostname)
+            else:
+                raise WebSocketException("SSL not available.")
+
+        return sock, (hostname, port, resource)
+    except:
+        if sock:
+            sock.close()
+        raise
+
+
+def _get_addrinfo_list(hostname, port, is_secure, proxy):
+    phost, pport, pauth = get_proxy_info(hostname, is_secure,
+        proxy.host, proxy.port, proxy.auth, proxy.no_proxy)
+    if not phost:
+        addrinfo_list = socket.getaddrinfo(hostname, port, 0, 0, socket.SOL_TCP)
+        return addrinfo_list, False, None
+    else:
+        pport = pport and pport or 80
+        addrinfo_list = socket.getaddrinfo(phost, pport, 0, 0, socket.SOL_TCP)
+        return addrinfo_list, True, pauth
+
+
+def _open_socket(addrinfo_list, sockopt, timeout):
+    err = None
+    for addrinfo in addrinfo_list:
+        family = addrinfo[0]
+        sock = socket.socket(family)
+        sock.settimeout(timeout)
+        for opts in DEFAULT_SOCKET_OPTION:
+            sock.setsockopt(*opts)
+        for opts in sockopt:
+            sock.setsockopt(*opts)
+
+        address = addrinfo[4]
+        try:
+            sock.connect(address)
+        except socket.error as error:
+            error.remote_ip = str(address[0])
+            if error.errno in (errno.ECONNREFUSED, ):
+                err = error
+                continue
+            else:
+                raise
+        else:
+            break
+    else:
+        raise err
+
+    return sock
+
+
+def _can_use_sni():
+    return (six.PY2 and sys.version_info[1] >= 7 and sys.version_info[2] >= 9) or (six.PY3 and sys.version_info[2] >= 2)
+
+
+def _wrap_sni_socket(sock, sslopt, hostname, check_hostname):
+    context = ssl.SSLContext(sslopt.get('ssl_version', ssl.PROTOCOL_SSLv23))
+
+    context.load_verify_locations(cafile=sslopt.get('ca_certs', None))
+    # see https://github.com/liris/websocket-client/commit/b96a2e8fa765753e82eea531adb19716b52ca3ca#commitcomment-10803153
+    context.verify_mode = sslopt['cert_reqs']
+    if HAVE_CONTEXT_CHECK_HOSTNAME:
+        context.check_hostname = check_hostname
+    if 'ciphers' in sslopt:
+        context.set_ciphers(sslopt['ciphers'])
+
+    return context.wrap_socket(
+        sock,
+        do_handshake_on_connect=sslopt.get('do_handshake_on_connect', True),
+        suppress_ragged_eofs=sslopt.get('suppress_ragged_eofs', True),
+        server_hostname=hostname,
+    )
+
+
+def _ssl_socket(sock, user_sslopt, hostname):
+    sslopt = dict(cert_reqs=ssl.CERT_REQUIRED)
+    certPath = os.path.join(
+        os.path.dirname(__file__), "cacert.pem")
+    if os.path.isfile(certPath):
+        sslopt['ca_certs'] = certPath
+    sslopt.update(user_sslopt)
+    check_hostname = sslopt["cert_reqs"] != ssl.CERT_NONE and sslopt.pop('check_hostname', True)
+
+    if _can_use_sni():
+        sock = _wrap_sni_socket(sock, sslopt, hostname, check_hostname)
+    else:
+        sslopt.pop('check_hostname', True)
+        sock = ssl.wrap_socket(sock, **sslopt)
+
+    if not HAVE_CONTEXT_CHECK_HOSTNAME and check_hostname:
+        match_hostname(sock.getpeercert(), hostname)
+
+    return sock
+
+def _tunnel(sock, host, port, auth):
+    debug("Connecting proxy...")
+    connect_header = "CONNECT %s:%d HTTP/1.0\r\n" % (host, port)
+    # TODO: support digest auth.
+    if auth and auth[0]:
+        auth_str = auth[0]
+        if auth[1]:
+            auth_str += ":" + auth[1]
+        encoded_str = base64encode(auth_str.encode()).strip().decode()
+        connect_header += "Proxy-Authorization: Basic %s\r\n" % encoded_str
+    connect_header += "\r\n"
+    dump("request header", connect_header)
+
+    send(sock, connect_header)
+
+    try:
+        status, resp_headers = read_headers(sock)
+    except Exception as e:
+        raise WebSocketProxyException(str(e))
+
+    if status != 200:
+        raise WebSocketProxyException(
+            "failed CONNECT via proxy status: %r" + status)
+    
+    return sock
+
+def read_headers(sock):
+    status = None
+    headers = {}
+    trace("--- response header ---")
+
+    while True:
+        line = recv_line(sock)
+        line = line.decode('utf-8').strip()
+        if not line:
+            break
+        trace(line)
+        if not status:
+
+            status_info = line.split(" ", 2)
+            status = int(status_info[1])
+        else:
+            kv = line.split(":", 1)
+            if len(kv) == 2:
+                key, value = kv
+                headers[key.lower()] = value.strip().lower()
+            else:
+                raise WebSocketException("Invalid header")
+
+    trace("-----------------------")
+
+    return status, headers

lib/websocket/_logging.py

@@ -0,0 +1,71 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+import logging
+
+_logger = logging.getLogger()
+_traceEnabled = False
+
+__all__ = ["enableTrace", "dump", "error", "debug", "trace",
+           "isEnabledForError", "isEnabledForDebug"]
+
+
+def enableTrace(tracable):
+    """
+    turn on/off the tracability.
+
+    tracable: boolean value. if set True, tracability is enabled.
+    """
+    global _traceEnabled
+    _traceEnabled = tracable
+    if tracable:
+        if not _logger.handlers:
+            _logger.addHandler(logging.StreamHandler())
+        _logger.setLevel(logging.DEBUG)
+
+
+def dump(title, message):
+    if _traceEnabled:
+        _logger.debug("--- " + title + " ---")
+        _logger.debug(message)
+        _logger.debug("-----------------------")
+
+
+def error(msg):
+    _logger.error(msg)
+
+
+def debug(msg):
+    _logger.debug(msg)
+
+
+def trace(msg):
+    if _traceEnabled:
+        _logger.debug(msg)
+
+
+def isEnabledForError():
+    return _logger.isEnabledFor(logging.ERROR)
+
+
+def isEnabledForDebug():
+    return _logger.isEnabledFor(logging.DEBUG)

lib/websocket/_socket.py

@@ -0,0 +1,121 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1335  USA
+
+"""
+
+import socket
+import six
+
+from ._exceptions import *
+from ._utils import *
+from ._ssl_compat import *
+
+DEFAULT_SOCKET_OPTION = [(socket.SOL_TCP, socket.TCP_NODELAY, 1)]
+if hasattr(socket, "SO_KEEPALIVE"):
+    DEFAULT_SOCKET_OPTION.append((socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1))
+if hasattr(socket, "TCP_KEEPIDLE"):
+    DEFAULT_SOCKET_OPTION.append((socket.SOL_TCP, socket.TCP_KEEPIDLE, 30))
+if hasattr(socket, "TCP_KEEPINTVL"):
+    DEFAULT_SOCKET_OPTION.append((socket.SOL_TCP, socket.TCP_KEEPINTVL, 10))
+if hasattr(socket, "TCP_KEEPCNT"):
+    DEFAULT_SOCKET_OPTION.append((socket.SOL_TCP, socket.TCP_KEEPCNT, 3))
+
+_default_timeout = None
+
+__all__ = ["DEFAULT_SOCKET_OPTION", "sock_opt", "setdefaulttimeout", "getdefaulttimeout",
+           "recv", "recv_line", "send"]
+
+class sock_opt(object):
+    def __init__(self, sockopt, sslopt):
+        if sockopt is None:
+            sockopt = []
+        if sslopt is None:
+            sslopt = {}
+        self.sockopt = sockopt
+        self.sslopt = sslopt
+        self.timeout = None
+
+def setdefaulttimeout(timeout):
+    """
+    Set the global timeout setting to connect.
+
+    timeout: default socket timeout time. This value is second.
+    """
+    global _default_timeout
+    _default_timeout = timeout
+
+
+def getdefaulttimeout():
+    """
+    Return the global timeout setting(second) to connect.
+    """
+    return _default_timeout
+
+
+def recv(sock, bufsize):
+    if not sock:
+        raise WebSocketConnectionClosedException("socket is already closed.")
+
+    try:
+        bytes = sock.recv(bufsize)
+    except socket.timeout as e:
+        message = extract_err_message(e)
+        raise WebSocketTimeoutException(message)
+    except SSLError as e:
+        message = extract_err_message(e)
+        if message == "The read operation timed out":
+            raise WebSocketTimeoutException(message)
+        else:
+            raise
+
+    if not bytes:
+        raise WebSocketConnectionClosedException("Connection is already closed.")
+
+    return bytes
+
+
+def recv_line(sock):
+    line = []
+    while True:
+        c = recv(sock, 1)
+        line.append(c)
+        if c == six.b("\n"):
+            break
+    return six.b("").join(line)
+
+
+def send(sock, data):
+    if isinstance(data, six.text_type):
+        data = data.encode('utf-8')
+
+    if not sock:
+        raise WebSocketConnectionClosedException("socket is already closed.")
+
+    try:
+        return sock.send(data)
+    except socket.timeout as e:
+        message = extract_err_message(e)
+        raise WebSocketTimeoutException(message)
+    except Exception as e:
+        message = extract_err_message(e)
+        if message and "timed out" in message:
+            raise WebSocketTimeoutException(message)
+        else:
+            raise

lib/websocket/_ssl_compat.py

@@ -0,0 +1,45 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1335  USA
+
+"""
+
+__all__ = ["HAVE_SSL", "ssl", "SSLError"]
+
+try:
+    import ssl
+    from ssl import SSLError
+    if hasattr(ssl, 'SSLContext') and hasattr(ssl.SSLContext, 'check_hostname'):
+        HAVE_CONTEXT_CHECK_HOSTNAME = True
+    else:
+        HAVE_CONTEXT_CHECK_HOSTNAME = False
+        if hasattr(ssl, "match_hostname"):
+            from ssl import match_hostname
+        else:
+            from backports.ssl_match_hostname import match_hostname
+        __all__.append("match_hostname")
+    __all__.append("HAVE_CONTEXT_CHECK_HOSTNAME")
+
+    HAVE_SSL = True
+except ImportError:
+    # dummy class of SSLError for ssl none-support environment.
+    class SSLError(Exception):
+        pass
+
+    HAVE_SSL = False

lib/websocket/_url.py

@@ -0,0 +1,126 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA  02110-1335  USA
+
+"""
+
+from six.moves.urllib.parse import urlparse
+import os
+
+__all__ = ["parse_url", "get_proxy_info"]
+
+
+def parse_url(url):
+    """
+    parse url and the result is tuple of
+    (hostname, port, resource path and the flag of secure mode)
+
+    url: url string.
+    """
+    if ":" not in url:
+        raise ValueError("url is invalid")
+
+    scheme, url = url.split(":", 1)
+
+    parsed = urlparse(url, scheme="ws")
+    if parsed.hostname:
+        hostname = parsed.hostname
+    else:
+        raise ValueError("hostname is invalid")
+    port = 0
+    if parsed.port:
+        port = parsed.port
+
+    is_secure = False
+    if scheme == "ws":
+        if not port:
+            port = 80
+    elif scheme == "wss":
+        is_secure = True
+        if not port:
+            port = 443
+    else:
+        raise ValueError("scheme %s is invalid" % scheme)
+
+    if parsed.path:
+        resource = parsed.path
+    else:
+        resource = "/"
+
+    if parsed.query:
+        resource += "?" + parsed.query
+
+    return (hostname, port, resource, is_secure)
+
+
+DEFAULT_NO_PROXY_HOST = ["localhost", "127.0.0.1"]
+
+
+def _is_no_proxy_host(hostname, no_proxy):
+    if not no_proxy:
+        v = os.environ.get("no_proxy", "").replace(" ", "")
+        no_proxy = v.split(",")
+    if not no_proxy:
+        no_proxy = DEFAULT_NO_PROXY_HOST
+
+    return hostname in no_proxy
+
+
+def get_proxy_info(hostname, is_secure,
+            proxy_host=None, proxy_port=0, proxy_auth=None, no_proxy=None):
+    """
+    try to retrieve proxy host and port from environment
+    if not provided in options.
+    result is (proxy_host, proxy_port, proxy_auth).
+    proxy_auth is tuple of username and password
+     of proxy authentication information.
+
+    hostname: websocket server name.
+
+    is_secure:  is the connection secure? (wss)
+                looks for "https_proxy" in env
+                before falling back to "http_proxy"
+
+    options:    "http_proxy_host" - http proxy host name.
+                "http_proxy_port" - http proxy port.
+                "http_no_proxy"   - host names, which doesn't use proxy.
+                "http_proxy_auth" - http proxy auth infomation.
+                                    tuple of username and password.
+                                    defualt is None
+    """
+    if _is_no_proxy_host(hostname, no_proxy):
+        return None, 0, None
+
+    if proxy_host:
+        port = proxy_port
+        auth = proxy_auth
+        return proxy_host, port, auth
+
+    env_keys = ["http_proxy"]
+    if is_secure:
+        env_keys.insert(0, "https_proxy")
+
+    for key in env_keys:
+        value = os.environ.get(key, None)
+        if value:
+            proxy = urlparse(value)
+            auth = (proxy.username, proxy.password) if proxy.username else None
+            return proxy.hostname, proxy.port, auth
+
+    return None, 0, None

lib/websocket/_utils.py

@@ -0,0 +1,88 @@
+"""
+websocket - WebSocket client library for Python
+
+Copyright (C) 2010 Hiroki Ohtani(liris)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library 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
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1335  USA
+
+"""
+
+import six
+
+__all__ = ["NoLock", "validate_utf8", "extract_err_message"]
+
+class NoLock(object):
+    def __enter__(self):
+        pass
+
+    def __exit__(self,type, value, traceback):
+        pass
+
+
+# UTF-8 validator
+# python implementation of http://bjoern.hoehrmann.de/utf-8/decoder/dfa/
+
+UTF8_ACCEPT = 0
+UTF8_REJECT=12
+
+_UTF8D = [
+    # The first part of the table maps bytes to character classes that
+    # to reduce the size of the transition table and create bitmasks.
+    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+    0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,  0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+    1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,  9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,
+    7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,  7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,
+    8,8,2,2,2,2,2,2,2,2,2,2,2,2,2,2,  2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
+    10,3,3,3,3,3,3,3,3,3,3,3,3,4,3,3, 11,6,6,6,5,8,8,8,8,8,8,8,8,8,8,8,
+
+    # The second part is a transition table that maps a combination
+    # of a state of the automaton and a character class to a state.
+    0,12,24,36,60,96,84,12,12,12,48,72, 12,12,12,12,12,12,12,12,12,12,12,12,
+    12, 0,12,12,12,12,12, 0,12, 0,12,12, 12,24,12,12,12,12,12,24,12,24,12,12,
+    12,12,12,12,12,12,12,24,12,12,12,12, 12,24,12,12,12,12,12,12,12,24,12,12,
+    12,12,12,12,12,12,12,36,12,36,12,12, 12,36,12,12,12,12,12,36,12,36,12,12,
+    12,36,12,12,12,12,12,12,12,12,12,12, ]
+
+def _decode(state, codep, ch):
+    tp = _UTF8D[ch]
+
+    codep = (ch & 0x3f ) | (codep << 6) if (state != UTF8_ACCEPT)  else (0xff >> tp) & (ch)
+    state = _UTF8D[256 + state + tp]
+
+    return state, codep;
+
+def validate_utf8(utfbytes):
+    """
+    validate utf8 byte string.
+    utfbytes: utf byte string to check.
+    return value: if valid utf8 string, return true. Otherwise, return false.
+    """
+    state = UTF8_ACCEPT
+    codep = 0
+    for i in utfbytes:
+        if six.PY2:
+            i = ord(i)
+        state, codep = _decode(state, codep, i)
+        if state == UTF8_REJECT:
+            return False
+
+    return True
+
+
+def extract_err_message(exception):
+    return getattr(exception, 'strerror', str(exception))

lib/websocket/tests/data/header01.txt

@@ -0,0 +1,6 @@
+HTTP/1.1 101 WebSocket Protocol Handshake
+Connection: Upgrade 
+Upgrade: WebSocket
+Sec-WebSocket-Accept: Kxep+hNu9n51529fGidYu7a3wO0=
+some_header: something
+

lib/websocket/tests/data/header02.txt

@@ -0,0 +1,6 @@
+HTTP/1.1 101 WebSocket Protocol Handshake
+Connection: Upgrade
+Upgrade WebSocket
+Sec-WebSocket-Accept: Kxep+hNu9n51529fGidYu7a3wO0=
+some_header: something
+

lib/websocket/tests/test_websocket.py

@@ -0,0 +1,660 @@
+# -*- coding: utf-8 -*-
+#
+
+import six
+import sys
+sys.path[0:0] = [""]
+
+import os
+import os.path
+import base64
+import socket
+try:
+    from ssl import SSLError
+except ImportError:
+    # dummy class of SSLError for ssl none-support environment.
+    class SSLError(Exception):
+        pass
+
+if sys.version_info[0] == 2 and sys.version_info[1] < 7:
+    import unittest2 as unittest
+else:
+    import unittest
+
+import uuid
+
+if six.PY3:
+    from base64 import decodebytes as base64decode
+else:
+    from base64 import decodestring as base64decode
+
+
+# websocket-client
+import websocket as ws
+from websocket._handshake import _create_sec_websocket_key
+from websocket._url import parse_url, get_proxy_info
+from websocket._utils import validate_utf8
+from websocket._handshake import _validate as _validate_header
+from websocket._http import read_headers
+
+
+# Skip test to access the internet.
+TEST_WITH_INTERNET = os.environ.get('TEST_WITH_INTERNET', '0') == '1'
+
+# Skip Secure WebSocket test.
+TEST_SECURE_WS = True
+TRACABLE = False
+
+
+def create_mask_key(n):
+    return "abcd"
+
+
+class SockMock(object):
+    def __init__(self):
+        self.data = []
+        self.sent = []
+
+    def add_packet(self, data):
+        self.data.append(data)
+
+    def recv(self, bufsize):
+        if self.data:
+            e = self.data.pop(0)
+            if isinstance(e, Exception):
+                raise e
+            if len(e) > bufsize:
+                self.data.insert(0, e[bufsize:])
+            return e[:bufsize]
+
+    def send(self, data):
+        self.sent.append(data)
+        return len(data)
+
+    def close(self):
+        pass
+
+
+class HeaderSockMock(SockMock):
+
+    def __init__(self, fname):
+        SockMock.__init__(self)
+        path = os.path.join(os.path.dirname(__file__), fname)
+        with open(path, "rb") as f:
+            self.add_packet(f.read())
+
+
+class WebSocketTest(unittest.TestCase):
+    def setUp(self):
+        ws.enableTrace(TRACABLE)
+
+    def tearDown(self):
+        pass
+
+    def testDefaultTimeout(self):
+        self.assertEqual(ws.getdefaulttimeout(), None)
+        ws.setdefaulttimeout(10)
+        self.assertEqual(ws.getdefaulttimeout(), 10)
+        ws.setdefaulttimeout(None)
+
+    def testParseUrl(self):
+        p = parse_url("ws://www.example.com/r")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 80)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com/r/")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 80)
+        self.assertEqual(p[2], "/r/")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com/")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 80)
+        self.assertEqual(p[2], "/")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 80)
+        self.assertEqual(p[2], "/")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com:8080/r")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com:8080/")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://www.example.com:8080")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("wss://www.example.com:8080/r")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], True)
+
+        p = parse_url("wss://www.example.com:8080/r?key=value")
+        self.assertEqual(p[0], "www.example.com")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/r?key=value")
+        self.assertEqual(p[3], True)
+
+        self.assertRaises(ValueError, parse_url, "http://www.example.com/r")
+
+        if sys.version_info[0] == 2 and sys.version_info[1] < 7:
+            return
+
+        p = parse_url("ws://[2a03:4000:123:83::3]/r")
+        self.assertEqual(p[0], "2a03:4000:123:83::3")
+        self.assertEqual(p[1], 80)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("ws://[2a03:4000:123:83::3]:8080/r")
+        self.assertEqual(p[0], "2a03:4000:123:83::3")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], False)
+
+        p = parse_url("wss://[2a03:4000:123:83::3]/r")
+        self.assertEqual(p[0], "2a03:4000:123:83::3")
+        self.assertEqual(p[1], 443)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], True)
+
+        p = parse_url("wss://[2a03:4000:123:83::3]:8080/r")
+        self.assertEqual(p[0], "2a03:4000:123:83::3")
+        self.assertEqual(p[1], 8080)
+        self.assertEqual(p[2], "/r")
+        self.assertEqual(p[3], True)
+
+    def testWSKey(self):
+        key = _create_sec_websocket_key()
+        self.assertTrue(key != 24)
+        self.assertTrue(six.u("¥n") not in key)
+
+    def testWsUtils(self):
+        key = "c6b8hTg4EeGb2gQMztV1/g=="
+        required_header = {
+            "upgrade": "websocket",
+            "connection": "upgrade",
+            "sec-websocket-accept": "Kxep+hNu9n51529fGidYu7a3wO0=",
+            }
+        self.assertEqual(_validate_header(required_header, key, None), (True, None))
+
+        header = required_header.copy()
+        header["upgrade"] = "http"
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+        del header["upgrade"]
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+
+        header = required_header.copy()
+        header["connection"] = "something"
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+        del header["connection"]
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+
+        header = required_header.copy()
+        header["sec-websocket-accept"] = "something"
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+        del header["sec-websocket-accept"]
+        self.assertEqual(_validate_header(header, key, None), (False, None))
+
+        header = required_header.copy()
+        header["sec-websocket-protocol"] = "sub1"
+        self.assertEqual(_validate_header(header, key, ["sub1", "sub2"]), (True, "sub1"))
+        self.assertEqual(_validate_header(header, key, ["sub2", "sub3"]), (False, None))
+
+        header = required_header.copy()
+        header["sec-websocket-protocol"] = "sUb1"
+        self.assertEqual(_validate_header(header, key, ["Sub1", "suB2"]), (True, "sub1"))
+
+
+    def testReadHeader(self):
+        status, header = read_headers(HeaderSockMock("data/header01.txt"))
+        self.assertEqual(status, 101)
+        self.assertEqual(header["connection"], "upgrade")
+
+        HeaderSockMock("data/header02.txt")
+        self.assertRaises(ws.WebSocketException, read_headers, HeaderSockMock("data/header02.txt"))
+
+    def testSend(self):
+        # TODO: add longer frame data
+        sock = ws.WebSocket()
+        sock.set_mask_key(create_mask_key)
+        s = sock.sock = HeaderSockMock("data/header01.txt")
+        sock.send("Hello")
+        self.assertEqual(s.sent[0], six.b("\x81\x85abcd)\x07\x0f\x08\x0e"))
+
+        sock.send("こんにちは")
+        self.assertEqual(s.sent[1], six.b("\x81\x8fabcd\x82\xe3\xf0\x87\xe3\xf1\x80\xe5\xca\x81\xe2\xc5\x82\xe3\xcc"))
+
+        sock.send(u"こんにちは")
+        self.assertEqual(s.sent[1], six.b("\x81\x8fabcd\x82\xe3\xf0\x87\xe3\xf1\x80\xe5\xca\x81\xe2\xc5\x82\xe3\xcc"))
+
+        sock.send("x" * 127)
+
+    def testRecv(self):
+        # TODO: add longer frame data
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        something = six.b("\x81\x8fabcd\x82\xe3\xf0\x87\xe3\xf1\x80\xe5\xca\x81\xe2\xc5\x82\xe3\xcc")
+        s.add_packet(something)
+        data = sock.recv()
+        self.assertEqual(data, "こんにちは")
+
+        s.add_packet(six.b("\x81\x85abcd)\x07\x0f\x08\x0e"))
+        data = sock.recv()
+        self.assertEqual(data, "Hello")
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testIter(self):
+        count = 2
+        for rsvp in ws.create_connection('ws://stream.meetup.com/2/rsvps'):
+            count -= 1
+            if count == 0:
+                break
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testNext(self):
+        sock = ws.create_connection('ws://stream.meetup.com/2/rsvps')
+        self.assertEqual(str, type(next(sock)))
+
+    def testInternalRecvStrict(self):
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        s.add_packet(six.b("foo"))
+        s.add_packet(socket.timeout())
+        s.add_packet(six.b("bar"))
+        # s.add_packet(SSLError("The read operation timed out"))
+        s.add_packet(six.b("baz"))
+        with self.assertRaises(ws.WebSocketTimeoutException):
+            data = sock.frame_buffer.recv_strict(9)
+        # if six.PY2:
+        #     with self.assertRaises(ws.WebSocketTimeoutException):
+        #         data = sock._recv_strict(9)
+        # else:
+        #     with self.assertRaises(SSLError):
+        #         data = sock._recv_strict(9)
+        data = sock.frame_buffer.recv_strict(9)
+        self.assertEqual(data, six.b("foobarbaz"))
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            data = sock.frame_buffer.recv_strict(1)
+
+    def testRecvTimeout(self):
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        s.add_packet(six.b("\x81"))
+        s.add_packet(socket.timeout())
+        s.add_packet(six.b("\x8dabcd\x29\x07\x0f\x08\x0e"))
+        s.add_packet(socket.timeout())
+        s.add_packet(six.b("\x4e\x43\x33\x0e\x10\x0f\x00\x40"))
+        with self.assertRaises(ws.WebSocketTimeoutException):
+            data = sock.recv()
+        with self.assertRaises(ws.WebSocketTimeoutException):
+            data = sock.recv()
+        data = sock.recv()
+        self.assertEqual(data, "Hello, World!")
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            data = sock.recv()
+
+    def testRecvWithSimpleFragmentation(self):
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        # OPCODE=TEXT, FIN=0, MSG="Brevity is "
+        s.add_packet(six.b("\x01\x8babcd#\x10\x06\x12\x08\x16\x1aD\x08\x11C"))
+        # OPCODE=CONT, FIN=1, MSG="the soul of wit"
+        s.add_packet(six.b("\x80\x8fabcd\x15\n\x06D\x12\r\x16\x08A\r\x05D\x16\x0b\x17"))
+        data = sock.recv()
+        self.assertEqual(data, "Brevity is the soul of wit")
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            sock.recv()
+
+    def testRecvWithFireEventOfFragmentation(self):
+        sock = ws.WebSocket(fire_cont_frame=True)
+        s = sock.sock = SockMock()
+        # OPCODE=TEXT, FIN=0, MSG="Brevity is "
+        s.add_packet(six.b("\x01\x8babcd#\x10\x06\x12\x08\x16\x1aD\x08\x11C"))
+        # OPCODE=CONT, FIN=0, MSG="Brevity is "
+        s.add_packet(six.b("\x00\x8babcd#\x10\x06\x12\x08\x16\x1aD\x08\x11C"))
+        # OPCODE=CONT, FIN=1, MSG="the soul of wit"
+        s.add_packet(six.b("\x80\x8fabcd\x15\n\x06D\x12\r\x16\x08A\r\x05D\x16\x0b\x17"))
+
+        _, data = sock.recv_data()
+        self.assertEqual(data, six.b("Brevity is "))
+        _, data = sock.recv_data()
+        self.assertEqual(data, six.b("Brevity is "))
+        _, data = sock.recv_data()
+        self.assertEqual(data, six.b("the soul of wit"))
+
+        # OPCODE=CONT, FIN=0, MSG="Brevity is "
+        s.add_packet(six.b("\x80\x8babcd#\x10\x06\x12\x08\x16\x1aD\x08\x11C"))
+
+        with self.assertRaises(ws.WebSocketException):
+            sock.recv_data()
+
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            sock.recv()
+
+    def testClose(self):
+        sock = ws.WebSocket()
+        sock.sock = SockMock()
+        sock.connected = True
+        sock.close()
+        self.assertEqual(sock.connected, False)
+
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        sock.connected = True
+        s.add_packet(six.b('\x88\x80\x17\x98p\x84'))
+        sock.recv()
+        self.assertEqual(sock.connected, False)
+
+    def testRecvContFragmentation(self):
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        # OPCODE=CONT, FIN=1, MSG="the soul of wit"
+        s.add_packet(six.b("\x80\x8fabcd\x15\n\x06D\x12\r\x16\x08A\r\x05D\x16\x0b\x17"))
+        self.assertRaises(ws.WebSocketException, sock.recv)
+
+    def testRecvWithProlongedFragmentation(self):
+        sock = ws.WebSocket()
+        s = sock.sock = SockMock()
+        # OPCODE=TEXT, FIN=0, MSG="Once more unto the breach, "
+        s.add_packet(six.b("\x01\x9babcd.\x0c\x00\x01A\x0f\x0c\x16\x04B\x16\n\x15" \
+                           "\rC\x10\t\x07C\x06\x13\x07\x02\x07\tNC"))
+        # OPCODE=CONT, FIN=0, MSG="dear friends, "
+        s.add_packet(six.b("\x00\x8eabcd\x05\x07\x02\x16A\x04\x11\r\x04\x0c\x07" \
+                           "\x17MB"))
+        # OPCODE=CONT, FIN=1, MSG="once more"
+        s.add_packet(six.b("\x80\x89abcd\x0e\x0c\x00\x01A\x0f\x0c\x16\x04"))
+        data = sock.recv()
+        self.assertEqual(
+            data,
+            "Once more unto the breach, dear friends, once more")
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            sock.recv()
+
+    def testRecvWithFragmentationAndControlFrame(self):
+        sock = ws.WebSocket()
+        sock.set_mask_key(create_mask_key)
+        s = sock.sock = SockMock()
+        # OPCODE=TEXT, FIN=0, MSG="Too much "
+        s.add_packet(six.b("\x01\x89abcd5\r\x0cD\x0c\x17\x00\x0cA"))
+        # OPCODE=PING, FIN=1, MSG="Please PONG this"
+        s.add_packet(six.b("\x89\x90abcd1\x0e\x06\x05\x12\x07C4.,$D\x15\n\n\x17"))
+        # OPCODE=CONT, FIN=1, MSG="of a good thing"
+        s.add_packet(six.b("\x80\x8fabcd\x0e\x04C\x05A\x05\x0c\x0b\x05B\x17\x0c" \
+                           "\x08\x0c\x04"))
+        data = sock.recv()
+        self.assertEqual(data, "Too much of a good thing")
+        with self.assertRaises(ws.WebSocketConnectionClosedException):
+            sock.recv()
+        self.assertEqual(
+            s.sent[0],
+            six.b("\x8a\x90abcd1\x0e\x06\x05\x12\x07C4.,$D\x15\n\n\x17"))
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testWebSocket(self):
+        s = ws.create_connection("ws://echo.websocket.org/")
+        self.assertNotEqual(s, None)
+        s.send("Hello, World")
+        result = s.recv()
+        self.assertEqual(result, "Hello, World")
+
+        s.send(u"こにゃにゃちは、世界")
+        result = s.recv()
+        self.assertEqual(result, "こにゃにゃちは、世界")
+        s.close()
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testPingPong(self):
+        s = ws.create_connection("ws://echo.websocket.org/")
+        self.assertNotEqual(s, None)
+        s.ping("Hello")
+        s.pong("Hi")
+        s.close()
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    @unittest.skipUnless(TEST_SECURE_WS, "wss://echo.websocket.org doesn't work well.")
+    def testSecureWebSocket(self):
+        if 1:
+            import ssl
+            s = ws.create_connection("wss://echo.websocket.org/")
+            self.assertNotEqual(s, None)
+            self.assertTrue(isinstance(s.sock, ssl.SSLSocket))
+            s.send("Hello, World")
+            result = s.recv()
+            self.assertEqual(result, "Hello, World")
+            s.send(u"こにゃにゃちは、世界")
+            result = s.recv()
+            self.assertEqual(result, "こにゃにゃちは、世界")
+            s.close()
+        #except:
+        #    pass
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testWebSocketWihtCustomHeader(self):
+        s = ws.create_connection("ws://echo.websocket.org/",
+                                 headers={"User-Agent": "PythonWebsocketClient"})
+        self.assertNotEqual(s, None)
+        s.send("Hello, World")
+        result = s.recv()
+        self.assertEqual(result, "Hello, World")
+        s.close()
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testAfterClose(self):
+        s = ws.create_connection("ws://echo.websocket.org/")
+        self.assertNotEqual(s, None)
+        s.close()
+        self.assertRaises(ws.WebSocketConnectionClosedException, s.send, "Hello")
+        self.assertRaises(ws.WebSocketConnectionClosedException, s.recv)
+
+    def testUUID4(self):
+        """ WebSocket key should be a UUID4.
+        """
+        key = _create_sec_websocket_key()
+        u = uuid.UUID(bytes=base64decode(key.encode("utf-8")))
+        self.assertEqual(4, u.version)
+
+
+class WebSocketAppTest(unittest.TestCase):
+
+    class NotSetYet(object):
+        """ A marker class for signalling that a value hasn't been set yet.
+        """
+
+    def setUp(self):
+        ws.enableTrace(TRACABLE)
+
+        WebSocketAppTest.keep_running_open = WebSocketAppTest.NotSetYet()
+        WebSocketAppTest.keep_running_close = WebSocketAppTest.NotSetYet()
+        WebSocketAppTest.get_mask_key_id = WebSocketAppTest.NotSetYet()
+
+    def tearDown(self):
+        WebSocketAppTest.keep_running_open = WebSocketAppTest.NotSetYet()
+        WebSocketAppTest.keep_running_close = WebSocketAppTest.NotSetYet()
+        WebSocketAppTest.get_mask_key_id = WebSocketAppTest.NotSetYet()
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testKeepRunning(self):
+        """ A WebSocketApp should keep running as long as its self.keep_running
+        is not False (in the boolean context).
+        """
+
+        def on_open(self, *args, **kwargs):
+            """ Set the keep_running flag for later inspection and immediately
+            close the connection.
+            """
+            WebSocketAppTest.keep_running_open = self.keep_running
+
+            self.close()
+
+        def on_close(self, *args, **kwargs):
+            """ Set the keep_running flag for the test to use.
+            """
+            WebSocketAppTest.keep_running_close = self.keep_running
+
+        app = ws.WebSocketApp('ws://echo.websocket.org/', on_open=on_open, on_close=on_close)
+        app.run_forever()
+
+        self.assertFalse(isinstance(WebSocketAppTest.keep_running_open,
+                                    WebSocketAppTest.NotSetYet))
+
+        self.assertFalse(isinstance(WebSocketAppTest.keep_running_close,
+                                    WebSocketAppTest.NotSetYet))
+
+        self.assertEqual(True, WebSocketAppTest.keep_running_open)
+        self.assertEqual(False, WebSocketAppTest.keep_running_close)
+
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testSockMaskKey(self):
+        """ A WebSocketApp should forward the received mask_key function down
+        to the actual socket.
+        """
+
+        def my_mask_key_func():
+            pass
+
+        def on_open(self, *args, **kwargs):
+            """ Set the value so the test can use it later on and immediately
+            close the connection.
+            """
+            WebSocketAppTest.get_mask_key_id = id(self.get_mask_key)
+            self.close()
+
+        app = ws.WebSocketApp('ws://echo.websocket.org/', on_open=on_open, get_mask_key=my_mask_key_func)
+        app.run_forever()
+
+        # Note: We can't use 'is' for comparing the functions directly, need to use 'id'.
+        self.assertEqual(WebSocketAppTest.get_mask_key_id, id(my_mask_key_func))
+
+
+class SockOptTest(unittest.TestCase):
+    @unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
+    def testSockOpt(self):
+        sockopt = ((socket.IPPROTO_TCP, socket.TCP_NODELAY, 1),)
+        s = ws.create_connection("ws://echo.websocket.org", sockopt=sockopt)
+        self.assertNotEqual(s.sock.getsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY), 0)
+        s.close()
+
+class UtilsTest(unittest.TestCase):
+    def testUtf8Validator(self):
+        state = validate_utf8(six.b('\xf0\x90\x80\x80'))
+        self.assertEqual(state, True)
+        state = validate_utf8(six.b('\xce\xba\xe1\xbd\xb9\xcf\x83\xce\xbc\xce\xb5\xed\xa0\x80edited'))
+        self.assertEqual(state, False)
+        state = validate_utf8(six.b(''))
+        self.assertEqual(state, True)
+
+class ProxyInfoTest(unittest.TestCase):
+    def setUp(self):
+        self.http_proxy = os.environ.get("http_proxy", None)
+        self.https_proxy = os.environ.get("https_proxy", None)
+        if "http_proxy" in os.environ:
+            del os.environ["http_proxy"]
+        if "https_proxy" in os.environ:
+            del os.environ["https_proxy"]
+
+    def tearDown(self):
+        if self.http_proxy:
+            os.environ["http_proxy"] = self.http_proxy
+        elif "http_proxy" in os.environ:
+            del os.environ["http_proxy"]
+
+        if self.https_proxy:
+            os.environ["https_proxy"] = self.https_proxy
+        elif "https_proxy" in os.environ:
+            del os.environ["https_proxy"]
+
+
+    def testProxyFromArgs(self):
+        self.assertEqual(get_proxy_info("echo.websocket.org", False, proxy_host="localhost"), ("localhost", 0, None))
+        self.assertEqual(get_proxy_info("echo.websocket.org", False, proxy_host="localhost", proxy_port=3128), ("localhost", 3128, None))
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost"), ("localhost", 0, None))
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost", proxy_port=3128), ("localhost", 3128, None))
+
+        self.assertEqual(get_proxy_info("echo.websocket.org", False, proxy_host="localhost", proxy_auth=("a", "b")),
+            ("localhost", 0, ("a", "b")))
+        self.assertEqual(get_proxy_info("echo.websocket.org", False, proxy_host="localhost", proxy_port=3128, proxy_auth=("a", "b")),
+            ("localhost", 3128, ("a", "b")))
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost", proxy_auth=("a", "b")),
+            ("localhost", 0, ("a", "b")))
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost", proxy_port=3128, proxy_auth=("a", "b")),
+            ("localhost", 3128, ("a", "b")))
+
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost", proxy_port=3128, no_proxy=["example.com"], proxy_auth=("a", "b")),
+            ("localhost", 3128, ("a", "b")))
+        self.assertEqual(get_proxy_info("echo.websocket.org", True, proxy_host="localhost", proxy_port=3128, no_proxy=["echo.websocket.org"], proxy_auth=("a", "b")),
+            (None, 0, None))
+
+
+    def testProxyFromEnv(self):
+        os.environ["http_proxy"] = "http://localhost/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", None, None))
+        os.environ["http_proxy"] = "http://localhost:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", 3128, None))
+
+        os.environ["http_proxy"] = "http://localhost/"
+        os.environ["https_proxy"] = "http://localhost2/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", None, None))
+        os.environ["http_proxy"] = "http://localhost:3128/"
+        os.environ["https_proxy"] = "http://localhost2:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", 3128, None))
+
+        os.environ["http_proxy"] = "http://localhost/"
+        os.environ["https_proxy"] = "http://localhost2/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", True), ("localhost2", None, None))
+        os.environ["http_proxy"] = "http://localhost:3128/"
+        os.environ["https_proxy"] = "http://localhost2:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", True), ("localhost2", 3128, None))
+
+
+        os.environ["http_proxy"] = "http://a:b@localhost/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", None, ("a", "b")))
+        os.environ["http_proxy"] = "http://a:b@localhost:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", 3128, ("a", "b")))
+
+        os.environ["http_proxy"] = "http://a:b@localhost/"
+        os.environ["https_proxy"] = "http://a:b@localhost2/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", None, ("a", "b")))
+        os.environ["http_proxy"] = "http://a:b@localhost:3128/"
+        os.environ["https_proxy"] = "http://a:b@localhost2:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", False), ("localhost", 3128, ("a", "b")))
+
+        os.environ["http_proxy"] = "http://a:b@localhost/"
+        os.environ["https_proxy"] = "http://a:b@localhost2/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", True), ("localhost2", None, ("a", "b")))
+        os.environ["http_proxy"] = "http://a:b@localhost:3128/"
+        os.environ["https_proxy"] = "http://a:b@localhost2:3128/"
+        self.assertEqual(get_proxy_info("echo.websocket.org", True), ("localhost2", 3128, ("a", "b")))
+
+        os.environ["http_proxy"] = "http://a:b@localhost/"
+        os.environ["https_proxy"] = "http://a:b@localhost2/"
+        os.environ["no_proxy"] = "example1.com,example2.com"
+        self.assertEqual(get_proxy_info("example.1.com", True), ("localhost2", None, ("a", "b")))
+        os.environ["http_proxy"] = "http://a:b@localhost:3128/"
+        os.environ["https_proxy"] = "http://a:b@localhost2:3128/"
+        os.environ["no_proxy"] = "example1.com,example2.com, echo.websocket.org"
+        self.assertEqual(get_proxy_info("echo.websocket.org", True), (None, 0, None))
+
+
+
+
+
+if __name__ == "__main__":
+    unittest.main()

plexpy/__init__.py

@@ -17,16 +17,21 @@ import os
 import sys
 import subprocess
 import threading
-import webbrowser
 import sqlite3
 import cherrypy
 import datetime
 import uuid
+# Some cut down versions of Python may not include this module and it's not critical for us
+try:
+    import webbrowser
+    no_browser = False
+except ImportError:
+    no_browser = True
 
 from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.triggers.interval import IntervalTrigger
 
-from plexpy import versioncheck, logger, monitor, plextv
+from plexpy import versioncheck, logger, activity_pinger, plextv, pmsconnect
 import plexpy.config
 
 PROG_DIR = None
@@ -66,6 +71,7 @@ COMMITS_BEHIND = None
 
 UMASK = None
 
+POLLING_FAILOVER = False
 
 def initialize(config_file):
     with INIT_LOCK:
@@ -75,6 +81,7 @@ def initialize(config_file):
         global CURRENT_VERSION
         global LATEST_VERSION
         global UMASK
+        global POLLING_FAILOVER
 
         CONFIG = plexpy.config.Config(config_file)
 
@@ -162,6 +169,7 @@ def initialize(config_file):
         # Get the real PMS urls for SSL and remote access
         if CONFIG.PMS_TOKEN and CONFIG.PMS_IP and CONFIG.PMS_PORT:
             plextv.get_real_pms_url()
+            pmsconnect.get_server_friendly_name()
 
         # Refresh the users list on startup
         if CONFIG.PMS_TOKEN and CONFIG.REFRESH_USERS_ON_STARTUP:
@@ -228,18 +236,19 @@ def daemonize():
 
 
 def launch_browser(host, port, root):
-    if host == '0.0.0.0':
-        host = 'localhost'
+    if not no_browser:
+        if host == '0.0.0.0':
+            host = 'localhost'
 
-    if CONFIG.ENABLE_HTTPS:
-        protocol = 'https'
-    else:
-        protocol = 'http'
+        if CONFIG.ENABLE_HTTPS:
+            protocol = 'https'
+        else:
+            protocol = 'http'
 
-    try:
-        webbrowser.open('%s://%s:%i%s' % (protocol, host, port, root))
-    except Exception as e:
-        logger.error('Could not launch browser: %s', e)
+        try:
+            webbrowser.open('%s://%s:%i%s' % (protocol, host, port, root))
+        except Exception as e:
+            logger.error('Could not launch browser: %s', e)
 
 
 def initialize_scheduler():
@@ -272,8 +281,29 @@ def initialize_scheduler():
             seconds = 0
 
         if CONFIG.PMS_IP and CONFIG.PMS_TOKEN:
-            schedule_job(plextv.get_real_pms_url, 'Refresh Plex Server URLs', hours=12, minutes=0, seconds=0)
-            schedule_job(monitor.check_active_sessions, 'Check for active sessions', hours=0, minutes=0, seconds=seconds)
+            schedule_job(plextv.get_real_pms_url, 'Refresh Plex Server URLs',
+                         hours=12, minutes=0, seconds=0)
+            schedule_job(pmsconnect.get_server_friendly_name, 'Refresh Plex Server Name',
+                         hours=12, minutes=0, seconds=0)
+
+            if CONFIG.NOTIFY_RECENTLY_ADDED:
+                schedule_job(activity_pinger.check_recently_added, 'Check for recently added items',
+                             hours=0, minutes=0, seconds=seconds)
+            else:
+                schedule_job(activity_pinger.check_recently_added, 'Check for recently added items',
+                             hours=0, minutes=0, seconds=0)
+
+            if CONFIG.MONITOR_REMOTE_ACCESS:
+                schedule_job(activity_pinger.check_server_response, 'Check for server response',
+                             hours=0, minutes=0, seconds=seconds)
+            else:
+                schedule_job(activity_pinger.check_server_response, 'Check for server response',
+                             hours=0, minutes=0, seconds=0)
+
+            # If we're not using websockets then fall back to polling
+            if not CONFIG.MONITORING_USE_WEBSOCKET or POLLING_FAILOVER:
+                schedule_job(activity_pinger.check_active_sessions, 'Check for active sessions',
+                             hours=0, minutes=0, seconds=seconds)
 
         # Refresh the users list
         if CONFIG.REFRESH_USERS_INTERVAL:
@@ -349,12 +379,12 @@ def dbcheck():
         'audio_channels INTEGER, transcode_protocol TEXT, transcode_container TEXT, '
         'transcode_video_codec TEXT, transcode_audio_codec TEXT, transcode_audio_channels INTEGER,'
         'transcode_width INTEGER, transcode_height INTEGER, buffer_count INTEGER DEFAULT 0, '
-        'buffer_last_triggered INTEGER)'
+        'buffer_last_triggered INTEGER, last_paused INTEGER)'
     )
 
     # session_history table :: This is a history table which logs essential stream details
     c_db.execute(
-        'CREATE TABLE IF NOT EXISTS session_history (id INTEGER PRIMARY KEY AUTOINCREMENT, '
+        'CREATE TABLE IF NOT EXISTS session_history (id INTEGER PRIMARY KEY AUTOINCREMENT, reference_id INTEGER, '
         'started INTEGER, stopped INTEGER, rating_key INTEGER, user_id INTEGER, user TEXT, '
         'ip_address TEXT, paused_counter INTEGER DEFAULT 0, player TEXT, platform TEXT, machine_id TEXT, '
         'parent_rating_key INTEGER, grandparent_rating_key INTEGER, media_type TEXT, view_offset INTEGER DEFAULT 0)'
@@ -386,9 +416,9 @@ def dbcheck():
     c_db.execute(
         'CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY AUTOINCREMENT, '
         'user_id INTEGER DEFAULT NULL UNIQUE, username TEXT NOT NULL UNIQUE, '
-        'friendly_name TEXT, thumb TEXT, email TEXT, is_home_user INTEGER DEFAULT NULL, '
+        'friendly_name TEXT, thumb TEXT, email TEXT, custom_avatar_url TEXT, is_home_user INTEGER DEFAULT NULL, '
         'is_allow_sync INTEGER DEFAULT NULL, is_restricted INTEGER DEFAULT NULL, do_notify INTEGER DEFAULT 1, '
-        'keep_history INTEGER DEFAULT 1, custom_avatar_url TEXT)'
+        'keep_history INTEGER DEFAULT 1, deleted_user INTEGER DEFAULT 0)'
     )
 
     # Upgrade sessions table from earlier versions
@@ -540,7 +570,7 @@ def dbcheck():
         'CREATE TABLE IF NOT EXISTS notify_log (id INTEGER PRIMARY KEY AUTOINCREMENT, '
         'session_key INTEGER, rating_key INTEGER, user_id INTEGER, user TEXT, '
         'agent_id INTEGER, agent_name TEXT, on_play INTEGER, on_stop INTEGER, on_watched INTEGER, '
-        'on_pause INTEGER, on_resume INTEGER, on_buffer INTEGER)'
+        'on_pause INTEGER, on_resume INTEGER, on_buffer INTEGER, on_created INTEGER)'
     )
 
     # Upgrade users table from earlier versions
@@ -576,6 +606,15 @@ def dbcheck():
             'ALTER TABLE notify_log ADD COLUMN on_buffer INTEGER'
         )
 
+    # Upgrade notify_log table from earlier versions
+    try:
+        c_db.execute('SELECT on_created from notify_log')
+    except sqlite3.OperationalError:
+        logger.debug(u"Altering database. Updating database table notify_log.")
+        c_db.execute(
+            'ALTER TABLE notify_log ADD COLUMN on_created INTEGER'
+        )
+
     # Upgrade sessions table from earlier versions
     try:
         c_db.execute('SELECT buffer_count from sessions')
@@ -597,12 +636,53 @@ def dbcheck():
             'ALTER TABLE users ADD COLUMN custom_avatar_url TEXT'
         )
 
+    # Upgrade sessions table from earlier versions
+    try:
+        c_db.execute('SELECT last_paused from sessions')
+    except sqlite3.OperationalError:
+        logger.debug(u"Altering database. Updating database table sessions.")
+        c_db.execute(
+            'ALTER TABLE sessions ADD COLUMN last_paused INTEGER'
+        )
+
     # Add "Local" user to database as default unauthenticated user.
     result = c_db.execute('SELECT id FROM users WHERE username = "Local"')
     if not result.fetchone():
         logger.debug(u'User "Local" does not exist. Adding user.')
         c_db.execute('INSERT INTO users (user_id, username) VALUES (0, "Local")')
 
+    # Upgrade session_history table from earlier versions
+    try:
+        c_db.execute('SELECT reference_id from session_history')
+    except sqlite3.OperationalError:
+        logger.debug(u"Altering database. Updating database table session_history.")
+        c_db.execute(
+            'ALTER TABLE session_history ADD COLUMN reference_id INTEGER DEFAULT 0'
+        )
+        # Set reference_id to the first row where (user_id = previous row, rating_key != previous row) and user_id = user_id
+        c_db.execute(
+            'UPDATE session_history ' \
+            'SET reference_id = (SELECT (CASE \
+             WHEN (SELECT MIN(id) FROM session_history WHERE id > ( \
+                 SELECT MAX(id) FROM session_history \
+                 WHERE (user_id = t1.user_id AND rating_key <> t1.rating_key AND id < t1.id)) AND user_id = t1.user_id) IS NULL \
+             THEN (SELECT MIN(id) FROM session_history WHERE (user_id = t1.user_id)) \
+             ELSE (SELECT MIN(id) FROM session_history WHERE id > ( \
+                 SELECT MAX(id) FROM session_history \
+                 WHERE (user_id = t1.user_id AND rating_key <> t1.rating_key AND id < t1.id)) AND user_id = t1.user_id) END) ' \
+            'FROM session_history AS t1 ' \
+            'WHERE t1.id = session_history.id) '
+        )
+
+    # Upgrade users table from earlier versions
+    try:
+        c_db.execute('SELECT deleted_user from users')
+    except sqlite3.OperationalError:
+        logger.debug(u"Altering database. Updating database table users.")
+        c_db.execute(
+            'ALTER TABLE users ADD COLUMN deleted_user INTEGER DEFAULT 0'
+        )
+
     conn_db.commit()
     c_db.close()
 
@@ -610,10 +690,6 @@ def shutdown(restart=False, update=False):
     cherrypy.engine.exit()
     SCHED.shutdown(wait=False)
 
-    # Clear any sessions in the db - Not sure yet if we should do this. More testing required
-    # logger.debug(u'Clearing Plex sessions.')
-    # monitor.drop_session_db()
-
     CONFIG.write()
 
     if not restart and not update:

plexpy/activity_handler.py

@@ -0,0 +1,265 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+import time
+import plexpy
+
+from plexpy import logger, pmsconnect, activity_processor, threading, notification_handler
+
+
+class ActivityHandler(object):
+
+    def __init__(self, timeline):
+        self.timeline = timeline
+        # print timeline
+
+    def is_valid_session(self):
+        if 'sessionKey' in self.timeline:
+            if str(self.timeline['sessionKey']).isdigit():
+                return True
+
+        return False
+
+    def get_session_key(self):
+        if self.is_valid_session():
+            return int(self.timeline['sessionKey'])
+
+        return None
+
+    def get_live_session(self):
+        pms_connect = pmsconnect.PmsConnect()
+        session_list = pms_connect.get_current_activity()
+
+        for session in session_list['sessions']:
+            if int(session['session_key']) == self.get_session_key():
+                return session
+
+        return None
+
+    def update_db_session(self):
+        # Update our session temp table values
+        monitor_proc = activity_processor.ActivityProcessor()
+        monitor_proc.write_session(session=self.get_live_session(), notify=False)
+
+    def on_start(self):
+        if self.is_valid_session():
+            logger.debug(u"PlexPy ActivityHandler :: Session %s has started." % str(self.get_session_key()))
+
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify,
+                             kwargs=dict(stream_data=self.get_live_session(), notify_action='play')).start()
+
+            # Write the new session to our temp session table
+            self.update_db_session()
+
+    def on_stop(self, force_stop=False):
+        if self.is_valid_session():
+            logger.debug(u"PlexPy ActivityHandler :: Session %s has stopped." % str(self.get_session_key()))
+
+            # Set the session last_paused timestamp
+            ap = activity_processor.ActivityProcessor()
+            ap.set_session_last_paused(session_key=self.get_session_key(), timestamp=None)
+
+            # Update the session state and viewOffset
+            # Set force_stop to true to disable the state set
+            if not force_stop:
+                ap.set_session_state(session_key=self.get_session_key(),
+                                     state=self.timeline['state'],
+                                     view_offset=self.timeline['viewOffset'])
+
+            # Retrieve the session data from our temp table
+            db_session = ap.get_session_by_key(session_key=self.get_session_key())
+
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify,
+                             kwargs=dict(stream_data=db_session, notify_action='stop')).start()
+
+            # Write it to the history table
+            monitor_proc = activity_processor.ActivityProcessor()
+            monitor_proc.write_session_history(session=db_session)
+
+            # Remove the session from our temp session table
+            ap.delete_session(session_key=self.get_session_key())
+
+    def on_pause(self):
+        if self.is_valid_session():
+            logger.debug(u"PlexPy ActivityHandler :: Session %s has been paused." % str(self.get_session_key()))
+
+            # Set the session last_paused timestamp
+            ap = activity_processor.ActivityProcessor()
+            ap.set_session_last_paused(session_key=self.get_session_key(), timestamp=int(time.time()))
+
+            # Update the session state and viewOffset
+            ap.set_session_state(session_key=self.get_session_key(),
+                                 state=self.timeline['state'],
+                                 view_offset=self.timeline['viewOffset'])
+
+            # Retrieve the session data from our temp table
+            db_session = ap.get_session_by_key(session_key=self.get_session_key())
+
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify,
+                             kwargs=dict(stream_data=db_session, notify_action='pause')).start()
+
+    def on_resume(self):
+        if self.is_valid_session():
+            logger.debug(u"PlexPy ActivityHandler :: Session %s has been resumed." % str(self.get_session_key()))
+
+            # Set the session last_paused timestamp
+            ap = activity_processor.ActivityProcessor()
+            ap.set_session_last_paused(session_key=self.get_session_key(), timestamp=None)
+
+            # Update the session state and viewOffset
+            ap.set_session_state(session_key=self.get_session_key(),
+                                 state=self.timeline['state'],
+                                 view_offset=self.timeline['viewOffset'])
+
+            # Retrieve the session data from our temp table
+            db_session = ap.get_session_by_key(session_key=self.get_session_key())
+
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify,
+                             kwargs=dict(stream_data=db_session, notify_action='resume')).start()
+
+    def on_buffer(self):
+        if self.is_valid_session():
+            logger.debug(u"PlexPy ActivityHandler :: Session %s is buffering." % self.get_session_key())
+            ap = activity_processor.ActivityProcessor()
+            db_stream = ap.get_session_by_key(session_key=self.get_session_key())
+
+            # Increment our buffer count
+            ap.increment_session_buffer_count(session_key=self.get_session_key())
+
+            # Get our current buffer count
+            current_buffer_count = ap.get_session_buffer_count(self.get_session_key())
+            logger.debug(u"PlexPy ActivityHandler :: Session %s buffer count is %s." %
+                         (self.get_session_key(), current_buffer_count))
+
+            # Get our last triggered time
+            buffer_last_triggered = ap.get_session_buffer_trigger_time(self.get_session_key())
+
+            time_since_last_trigger = 0
+            if buffer_last_triggered:
+                logger.debug(u"PlexPy ActivityHandler :: Session %s buffer last triggered at %s." %
+                             (self.get_session_key(), buffer_last_triggered))
+                time_since_last_trigger = int(time.time()) - int(buffer_last_triggered)
+
+            if current_buffer_count >= plexpy.CONFIG.BUFFER_THRESHOLD and time_since_last_trigger == 0 or \
+                            time_since_last_trigger >= plexpy.CONFIG.BUFFER_WAIT:
+                ap.set_session_buffer_trigger_time(session_key=self.get_session_key())
+                threading.Thread(target=notification_handler.notify,
+                                 kwargs=dict(stream_data=db_stream, notify_action='buffer')).start()
+
+    # This function receives events from our websocket connection
+    def process(self):
+        if self.is_valid_session():
+            from plexpy import helpers
+
+            ap = activity_processor.ActivityProcessor()
+            db_session = ap.get_session_by_key(session_key=self.get_session_key())
+
+            this_state = self.timeline['state']
+            this_key = str(self.timeline['ratingKey'])
+
+            # If we already have this session in the temp table, check for state changes
+            if db_session:
+                last_state = db_session['state']
+                last_key = str(db_session['rating_key'])
+
+                # Make sure the same item is being played
+                if this_key == last_key:
+                    # Update the session state and viewOffset
+                    if this_state == 'playing':
+                        ap.set_session_state(session_key=self.get_session_key(),
+                                             state=this_state,
+                                             view_offset=self.timeline['viewOffset'])
+                    # Start our state checks
+                    if this_state != last_state:
+                        if this_state == 'paused':
+                            self.on_pause()
+                        elif last_state == 'paused' and this_state == 'playing':
+                            self.on_resume()
+                        elif this_state == 'stopped':
+                            self.on_stop()
+                    elif this_state == 'buffering':
+                        self.on_buffer()
+                # If a client doesn't register stop events (I'm looking at you PHT!) check if the ratingKey has changed
+                else:
+                    # Manually stop and start
+                    # Set force_stop so that we don't overwrite our last viewOffset
+                    self.on_stop(force_stop=True)
+                    self.on_start()
+
+                # Monitor if the stream has reached the watch percentage for notifications
+                # The only purpose of this is for notifications
+                progress_percent = helpers.get_percent(self.timeline['viewOffset'], db_session['duration'])
+                if progress_percent >= plexpy.CONFIG.NOTIFY_WATCHED_PERCENT and this_state != 'buffering':
+                    threading.Thread(target=notification_handler.notify,
+                                     kwargs=dict(stream_data=db_session, notify_action='watched')).start()
+
+            else:
+                # We don't have this session in our table yet, start a new one.
+                if this_state != 'buffering':
+                    self.on_start()
+
+class TimelineHandler(object):
+
+    def __init__(self, timeline):
+        self.timeline = timeline
+        #logger.debug(timeline)
+
+    def is_item(self):
+        if 'itemID' in self.timeline:
+            return True
+
+        return False
+
+    def get_rating_key(self):
+        if self.is_item():
+            return int(self.timeline['itemID'])
+
+        return None
+
+    def get_metadata(self):
+        pms_connect = pmsconnect.PmsConnect()
+        metadata_list = pms_connect.get_metadata_details(self.get_rating_key())
+
+        if metadata_list:
+            return metadata_list['metadata']
+
+        return None
+
+    def on_created(self):
+        if self.is_item():
+            logger.debug(u"PlexPy TimelineHandler :: Library item %s has been added to Plex." % str(self.get_rating_key()))
+
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify_timeline,
+                             kwargs=dict(timeline_data=self.get_metadata(), notify_action='created')).start()
+
+    # This function receives events from our websocket connection
+    def process(self):
+        if self.is_item():
+
+            this_state = self.timeline['state']
+            this_type = self.timeline['type']
+            this_metadataState = self.timeline.get('metadataState', None)
+            this_mediaState = self.timeline.get('mediaState', None)
+
+            # state:    5: done processing metadata
+            # type:     1: movie, 2: tv show, 4: episode, 8: artist, 10: track
+            types = [1, 2, 4, 8, 10]
+            if this_state == 5 and this_type in types and this_metadataState == None and this_mediaState == None:
+                self.on_created()

plexpy/activity_pinger.py

@@ -0,0 +1,285 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+from plexpy import logger, pmsconnect, plextv, notification_handler, database, helpers, activity_processor
+
+import threading
+import plexpy
+import time
+
+monitor_lock = threading.Lock()
+ext_ping_count = 0
+int_ping_count = 0
+
+
+def check_active_sessions(ws_request=False):
+
+    with monitor_lock:
+        pms_connect = pmsconnect.PmsConnect()
+        session_list = pms_connect.get_current_activity()
+        monitor_db = database.MonitorDatabase()
+        monitor_process = activity_processor.ActivityProcessor()
+        # logger.debug(u"PlexPy Monitor :: Checking for active streams.")
+
+        global int_ping_count
+
+        if session_list:
+            if int_ping_count >= 3:
+                logger.info(u"PlexPy Monitor :: The Plex Media Server is back up.")
+                # Fire off notifications
+                threading.Thread(target=notification_handler.notify_timeline,
+                                    kwargs=dict(notify_action='intup')).start()
+            int_ping_count = 0
+
+            media_container = session_list['sessions']
+
+            # Check our temp table for what we must do with the new streams
+            db_streams = monitor_db.select('SELECT started, session_key, rating_key, media_type, title, parent_title, '
+                                           'grandparent_title, user_id, user, friendly_name, ip_address, player, '
+                                           'platform, machine_id, parent_rating_key, grandparent_rating_key, state, '
+                                           'view_offset, duration, video_decision, audio_decision, width, height, '
+                                           'container, video_codec, audio_codec, bitrate, video_resolution, '
+                                           'video_framerate, aspect_ratio, audio_channels, transcode_protocol, '
+                                           'transcode_container, transcode_video_codec, transcode_audio_codec, '
+                                           'transcode_audio_channels, transcode_width, transcode_height, '
+                                           'paused_counter, last_paused '
+                                           'FROM sessions')
+            for stream in db_streams:
+                if any(d['session_key'] == str(stream['session_key']) and d['rating_key'] == str(stream['rating_key'])
+                       for d in media_container):
+                    # The user's session is still active
+                    for session in media_container:
+                        if session['session_key'] == str(stream['session_key']) and \
+                                session['rating_key'] == str(stream['rating_key']):
+                            # The user is still playing the same media item
+                            # Here we can check the play states
+                            if session['state'] != stream['state']:
+                                if session['state'] == 'paused':
+                                    # Push any notifications -
+                                    # Push it on it's own thread so we don't hold up our db actions
+                                    threading.Thread(target=notification_handler.notify,
+                                                     kwargs=dict(stream_data=stream, notify_action='pause')).start()
+
+                                if session['state'] == 'playing' and stream['state'] == 'paused':
+                                    # Push any notifications -
+                                    # Push it on it's own thread so we don't hold up our db actions
+                                    threading.Thread(target=notification_handler.notify,
+                                                     kwargs=dict(stream_data=stream, notify_action='resume')).start()
+
+                            if stream['state'] == 'paused' and not ws_request:
+                                # The stream is still paused so we need to increment the paused_counter
+                                # Using the set config parameter as the interval, probably not the most accurate but
+                                # it will have to do for now. If it's a websocket request don't use this method.
+                                paused_counter = int(stream['paused_counter']) + plexpy.CONFIG.MONITORING_INTERVAL
+                                monitor_db.action('UPDATE sessions SET paused_counter = ? '
+                                                  'WHERE session_key = ? AND rating_key = ?',
+                                                  [paused_counter, stream['session_key'], stream['rating_key']])
+
+                            if session['state'] == 'buffering' and plexpy.CONFIG.BUFFER_THRESHOLD > 0:
+                                # The stream is buffering so we need to increment the buffer_count
+                                # We're going just increment on every monitor ping,
+                                # would be difficult to keep track otherwise
+                                monitor_db.action('UPDATE sessions SET buffer_count = buffer_count + 1 '
+                                                  'WHERE session_key = ? AND rating_key = ?',
+                                                  [stream['session_key'], stream['rating_key']])
+
+                                # Check the current buffer count and last buffer to determine if we should notify
+                                buffer_values = monitor_db.select('SELECT buffer_count, buffer_last_triggered '
+                                                                  'FROM sessions '
+                                                                  'WHERE session_key = ? AND rating_key = ?',
+                                                                  [stream['session_key'], stream['rating_key']])
+
+                                if buffer_values[0]['buffer_count'] >= plexpy.CONFIG.BUFFER_THRESHOLD:
+                                    # Push any notifications -
+                                    # Push it on it's own thread so we don't hold up our db actions
+                                    # Our first buffer notification
+                                    if buffer_values[0]['buffer_count'] == plexpy.CONFIG.BUFFER_THRESHOLD:
+                                        logger.info(u"PlexPy Monitor :: User '%s' has triggered a buffer warning."
+                                                    % stream['user'])
+                                        # Set the buffer trigger time
+                                        monitor_db.action('UPDATE sessions '
+                                                          'SET buffer_last_triggered = strftime("%s","now") '
+                                                          'WHERE session_key = ? AND rating_key = ?',
+                                                          [stream['session_key'], stream['rating_key']])
+
+                                        threading.Thread(target=notification_handler.notify,
+                                                         kwargs=dict(stream_data=stream, notify_action='buffer')).start()
+                                    else:
+                                        # Subsequent buffer notifications after wait time
+                                        if int(time.time()) > buffer_values[0]['buffer_last_triggered'] + \
+                                                plexpy.CONFIG.BUFFER_WAIT:
+                                            logger.info(u"PlexPy Monitor :: User '%s' has triggered multiple buffer warnings."
+                                                    % stream['user'])
+                                            # Set the buffer trigger time
+                                            monitor_db.action('UPDATE sessions '
+                                                              'SET buffer_last_triggered = strftime("%s","now") '
+                                                              'WHERE session_key = ? AND rating_key = ?',
+                                                              [stream['session_key'], stream['rating_key']])
+
+                                            threading.Thread(target=notification_handler.notify,
+                                                             kwargs=dict(stream_data=stream, notify_action='buffer')).start()
+
+                                logger.debug(u"PlexPy Monitor :: Stream buffering. Count is now %s. Last triggered %s."
+                                             % (buffer_values[0]['buffer_count'],
+                                                buffer_values[0]['buffer_last_triggered']))
+
+                            # Check if the user has reached the offset in the media we defined as the "watched" percent
+                            # Don't trigger if state is buffer as some clients push the progress to the end when
+                            # buffering on start.
+                            if session['view_offset'] and session['duration'] and session['state'] != 'buffering':
+                                if helpers.get_percent(session['view_offset'],
+                                                       session['duration']) > plexpy.CONFIG.NOTIFY_WATCHED_PERCENT:
+                                    # Push any notifications -
+                                    # Push it on it's own thread so we don't hold up our db actions
+                                    threading.Thread(target=notification_handler.notify,
+                                                     kwargs=dict(stream_data=stream, notify_action='watched')).start()
+
+                else:
+                    # The user has stopped playing a stream
+                    logger.debug(u"PlexPy Monitor :: Removing sessionKey %s ratingKey %s from session queue"
+                                 % (stream['session_key'], stream['rating_key']))
+                    monitor_db.action('DELETE FROM sessions WHERE session_key = ? AND rating_key = ?',
+                                      [stream['session_key'], stream['rating_key']])
+
+                    # Check if the user has reached the offset in the media we defined as the "watched" percent
+                    if stream['view_offset'] and stream['duration']:
+                        if helpers.get_percent(stream['view_offset'],
+                                               stream['duration']) > plexpy.CONFIG.NOTIFY_WATCHED_PERCENT:
+                            # Push any notifications -
+                            # Push it on it's own thread so we don't hold up our db actions
+                            threading.Thread(target=notification_handler.notify,
+                                             kwargs=dict(stream_data=stream, notify_action='watched')).start()
+
+                    # Push any notifications - Push it on it's own thread so we don't hold up our db actions
+                    threading.Thread(target=notification_handler.notify,
+                                     kwargs=dict(stream_data=stream, notify_action='stop')).start()
+
+                    # Write the item history on playback stop
+                    monitor_process.write_session_history(session=stream)
+
+            # Process the newly received session data
+            for session in media_container:
+                monitor_process.write_session(session)
+        else:
+            logger.debug(u"PlexPy Monitor :: Unable to read session list.")
+
+            int_ping_count += 1
+            logger.warn(u"PlexPy Monitor :: Unable to get an internal response from the server, ping attempt %s." \
+                        % str(int_ping_count))
+
+        if int_ping_count == 3:
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify_timeline,
+                                kwargs=dict(notify_action='intdown')).start()
+
+
+def check_recently_added():
+
+    with monitor_lock:
+        # add delay to allow for metadata processing
+        delay = plexpy.CONFIG.NOTIFY_RECENTLY_ADDED_DELAY
+        time_threshold = int(time.time()) - delay
+        time_interval = plexpy.CONFIG.MONITORING_INTERVAL
+
+        pms_connect = pmsconnect.PmsConnect()
+        recently_added_list = pms_connect.get_recently_added_details(count='10')
+
+        if recently_added_list:
+            recently_added = recently_added_list['recently_added']
+
+            for item in recently_added:
+                metadata = []
+                
+                if 0 < time_threshold - int(item['added_at']) <= time_interval:
+                    if item['media_type'] == 'movie':
+                        metadata_list = pms_connect.get_metadata_details(item['rating_key'])
+                        if metadata_list:
+                            metadata = [metadata_list['metadata']]
+                        else:
+                            logger.error(u"PlexPy Monitor :: Unable to retrieve metadata for rating_key %s" \
+                                         % str(item['rating_key']))
+
+                    else:
+                        metadata_list = pms_connect.get_metadata_children_details(item['rating_key'])
+                        if metadata_list:
+                            metadata = metadata_list['metadata']
+                        else:
+                            logger.error(u"PlexPy Monitor :: Unable to retrieve children metadata for rating_key %s" \
+                                         % str(item['rating_key']))
+
+                if metadata:
+                    if not plexpy.CONFIG.NOTIFY_RECENTLY_ADDED_GRANDPARENT:
+                        for item in metadata:
+                            if 0 < time_threshold - int(item['added_at']) <= time_interval:
+                                logger.debug(u"PlexPy Monitor :: Library item %s has been added to Plex." % str(item['rating_key']))
+                                # Fire off notifications
+                                threading.Thread(target=notification_handler.notify_timeline,
+                                                 kwargs=dict(timeline_data=item, notify_action='created')).start()
+                    
+                    else:
+                        item = max(metadata, key=lambda x:x['added_at'])
+
+                        if 0 < time_threshold - int(item['added_at']) <= time_interval:
+                            if item['media_type'] == 'episode' or item['media_type'] == 'track':
+                                metadata_list = pms_connect.get_metadata_details(item['grandparent_rating_key'])
+
+                                if metadata_list:
+                                    item = metadata_list['metadata']
+                                else:
+                                    logger.error(u"PlexPy Monitor :: Unable to retrieve grandparent metadata for grandparent_rating_key %s" \
+                                                 % str(item['rating_key']))
+
+                            logger.debug(u"PlexPy Monitor :: Library item %s has been added to Plex." % str(item['rating_key']))
+                            # Fire off notifications
+                            threading.Thread(target=notification_handler.notify_timeline,
+                                             kwargs=dict(timeline_data=item, notify_action='created')).start()
+
+def check_server_response():
+
+    with monitor_lock:
+        pms_connect = pmsconnect.PmsConnect()
+        server_response = pms_connect.get_server_response()
+
+        global ext_ping_count
+
+        # Check for remote access
+        if server_response:
+        
+            mapping_state = server_response['mapping_state']
+            mapping_error = server_response['mapping_error']
+
+            # Check if the port is mapped
+            if not mapping_state == 'mapped':
+                ext_ping_count += 1
+                logger.warn(u"PlexPy Monitor :: Plex remote access port not mapped, ping attempt %s." \
+                            % str(ext_ping_count))
+            # Check if the port is open
+            elif mapping_error == 'unreachable':
+                ext_ping_count += 1
+                logger.warn(u"PlexPy Monitor :: Plex remote access port mapped, but mapping failed, ping attempt %s." \
+                            % str(ext_ping_count))
+            # Reset external ping counter
+            else:
+                if ext_ping_count >= 3:
+                    logger.info(u"PlexPy Monitor :: Plex remote access is back up.")
+                    # Fire off notifications
+                    threading.Thread(target=notification_handler.notify_timeline,
+                                        kwargs=dict(notify_action='extup')).start()
+                ext_ping_count = 0
+
+        if ext_ping_count == 3:
+            # Fire off notifications
+            threading.Thread(target=notification_handler.notify_timeline,
+                                kwargs=dict(notify_action='extdown')).start()

plexpy/activity_processor.py

@@ -0,0 +1,422 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+from plexpy import logger, pmsconnect, notification_handler, log_reader, database
+
+import threading
+import plexpy
+import re
+import time
+
+
+class ActivityProcessor(object):
+
+    def __init__(self):
+        self.db = database.MonitorDatabase()
+
+    def write_session(self, session=None, notify=True):
+        if session:
+            values = {'session_key': session['session_key'],
+                      'rating_key': session['rating_key'],
+                      'media_type': session['media_type'],
+                      'state': session['state'],
+                      'user_id': session['user_id'],
+                      'user': session['user'],
+                      'machine_id': session['machine_id'],
+                      'title': session['title'],
+                      'parent_title': session['parent_title'],
+                      'grandparent_title': session['grandparent_title'],
+                      'friendly_name': session['friendly_name'],
+                      #'ip_address': session['ip_address'],
+                      'player': session['player'],
+                      'platform': session['platform'],
+                      'parent_rating_key': session['parent_rating_key'],
+                      'grandparent_rating_key': session['grandparent_rating_key'],
+                      'view_offset': session['view_offset'],
+                      'duration': session['duration'],
+                      'video_decision': session['video_decision'],
+                      'audio_decision': session['audio_decision'],
+                      'width': session['width'],
+                      'height': session['height'],
+                      'container': session['container'],
+                      'video_codec': session['video_codec'],
+                      'audio_codec': session['audio_codec'],
+                      'bitrate': session['bitrate'],
+                      'video_resolution': session['video_resolution'],
+                      'video_framerate': session['video_framerate'],
+                      'aspect_ratio': session['aspect_ratio'],
+                      'audio_channels': session['audio_channels'],
+                      'transcode_protocol': session['transcode_protocol'],
+                      'transcode_container': session['transcode_container'],
+                      'transcode_video_codec': session['transcode_video_codec'],
+                      'transcode_audio_codec': session['transcode_audio_codec'],
+                      'transcode_audio_channels': session['transcode_audio_channels'],
+                      'transcode_width': session['transcode_width'],
+                      'transcode_height': session['transcode_height']
+                      }
+
+            # Add ip_address back into values
+            if session['ip_address']:
+                values.update({'ip_address': session['ip_address']})
+
+            keys = {'session_key': session['session_key'],
+                    'rating_key': session['rating_key']}
+
+            result = self.db.upsert('sessions', values, keys)
+
+            if result == 'insert':
+                # Push any notifications - Push it on it's own thread so we don't hold up our db actions
+                if notify:
+                    values.update({'ip_address': session['ip_address']})
+                    threading.Thread(target=notification_handler.notify,
+                                     kwargs=dict(stream_data=values, notify_action='play')).start()
+
+                # If it's our first write then time stamp it.
+                started = int(time.time())
+                timestamp = {'started': started}
+                self.db.upsert('sessions', timestamp, keys)
+
+                # Try and grab IP address from logs (fallback if not on PMS 0.9.14 and above)
+                if not session['ip_address']:
+                    if plexpy.CONFIG.IP_LOGGING_ENABLE and plexpy.CONFIG.PMS_LOGS_FOLDER:
+                        ip_address = self.find_session_ip(rating_key=session['rating_key'],
+                                                          machine_id=session['machine_id'])
+                        ip_address = {'ip_address': ip_address}
+                        self.db.upsert('sessions', ip_address, keys)
+
+    def write_session_history(self, session=None, import_metadata=None, is_import=False, import_ignore_interval=0):
+        from plexpy import users
+
+        user_data = users.Users()
+        user_details = user_data.get_user_friendly_name(user=session['user'])
+
+        if session:
+            logging_enabled = False
+
+            if is_import:
+                if str(session['stopped']).isdigit():
+                    stopped = int(session['stopped'])
+                else:
+                    stopped = int(time.time())
+            else:
+                stopped = int(time.time())
+
+            if plexpy.CONFIG.MOVIE_LOGGING_ENABLE and str(session['rating_key']).isdigit() and \
+                    session['media_type'] == 'movie':
+                logging_enabled = True
+            elif plexpy.CONFIG.TV_LOGGING_ENABLE and str(session['rating_key']).isdigit() and \
+                    session['media_type'] == 'episode':
+                logging_enabled = True
+            elif plexpy.CONFIG.MUSIC_LOGGING_ENABLE and str(session['rating_key']).isdigit() and \
+                    session['media_type'] == 'track':
+                logging_enabled = True
+            else:
+                logger.debug(u"PlexPy ActivityProcessor :: ratingKey %s not logged. Does not meet logging criteria. "
+                             u"Media type is '%s'" % (session['rating_key'], session['media_type']))
+
+            if str(session['paused_counter']).isdigit():
+                real_play_time = stopped - session['started'] - int(session['paused_counter'])
+            else:
+                real_play_time = stopped - session['started']
+
+            if plexpy.CONFIG.LOGGING_IGNORE_INTERVAL and not is_import:
+                if (session['media_type'] == 'movie' or session['media_type'] == 'episode') and \
+                        (real_play_time < int(plexpy.CONFIG.LOGGING_IGNORE_INTERVAL)):
+                    logging_enabled = False
+                    logger.debug(u"PlexPy ActivityProcessor :: Play duration for ratingKey %s is %s secs which is less than %s "
+                                 u"seconds, so we're not logging it." %
+                                 (session['rating_key'], str(real_play_time), plexpy.CONFIG.LOGGING_IGNORE_INTERVAL))
+            if session['media_type'] == 'track' and not is_import:
+                if real_play_time < 15 and session['duration'] >= 30:
+                    logging_enabled = False
+                    logger.debug(u"PlexPy ActivityProcessor :: Play duration for ratingKey %s is %s secs, "
+                                 u"looks like it was skipped so we're not logging it" %
+                                 (session['rating_key'], str(real_play_time)))
+            elif is_import and import_ignore_interval:
+                if (session['media_type'] == 'movie' or session['media_type'] == 'episode') and \
+                        (real_play_time < int(import_ignore_interval)):
+                    logging_enabled = False
+                    logger.debug(u"PlexPy ActivityProcessor :: Play duration for ratingKey %s is %s secs which is less than %s "
+                                 u"seconds, so we're not logging it." %
+                                 (session['rating_key'], str(real_play_time),
+                                  import_ignore_interval))
+
+            if not user_details['keep_history'] and not is_import:
+                logging_enabled = False
+                logger.debug(u"PlexPy ActivityProcessor :: History logging for user '%s' is disabled." % session['user'])
+
+            if logging_enabled:
+                # logger.debug(u"PlexPy ActivityProcessor :: Attempting to write to session_history table...")
+                query = 'INSERT INTO session_history (started, stopped, rating_key, parent_rating_key, ' \
+                        'grandparent_rating_key, media_type, user_id, user, ip_address, paused_counter, player, ' \
+                        'platform, machine_id, view_offset) VALUES ' \
+                        '(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
+
+                args = [session['started'], stopped, session['rating_key'], session['parent_rating_key'],
+                        session['grandparent_rating_key'], session['media_type'], session['user_id'], session['user'],
+                        session['ip_address'], session['paused_counter'], session['player'], session['platform'],
+                        session['machine_id'], session['view_offset']]
+
+                # logger.debug(u"PlexPy ActivityProcessor :: Writing session_history transaction...")
+                self.db.action(query=query, args=args)
+
+                # Check if we should group the session, select the last two rows from the user
+                query = 'SELECT id, rating_key, user_id, reference_id FROM session_history \
+                         WHERE user_id = ? ORDER BY id DESC LIMIT 2 '
+
+                args = [session['user_id']]
+
+                result = self.db.select(query=query, args=args)
+                
+                new_session = {'id': result[0]['id'],
+                               'rating_key': result[0]['rating_key'],
+                               'user_id': result[0]['user_id'],
+                               'reference_id': result[0]['reference_id']}
+
+                if len(result) == 1:
+                    prev_session = None
+                else:
+                    prev_session = {'id': result[1]['id'],
+                                    'rating_key': result[1]['rating_key'],
+                                    'user_id': result[1]['user_id'],
+                                    'reference_id': result[1]['reference_id']}
+
+                query = 'UPDATE session_history SET reference_id = ? WHERE id = ? '
+                # If rating_key is the same in the previous session, then set the reference_id to the previous row, else set the reference_id to the new id
+                if (prev_session is not None) and (prev_session['rating_key'] == new_session['rating_key']):
+                    args = [prev_session['reference_id'], new_session['id']]
+                else:
+                    args = [new_session['id'], new_session['id']]
+
+                self.db.action(query=query, args=args)
+                
+                # logger.debug(u"PlexPy ActivityProcessor :: Successfully written history item, last id for session_history is %s"
+                #              % last_id)
+
+                # Write the session_history_media_info table
+                # logger.debug(u"PlexPy ActivityProcessor :: Attempting to write to session_history_media_info table...")
+                query = 'INSERT INTO session_history_media_info (id, rating_key, video_decision, audio_decision, ' \
+                        'duration, width, height, container, video_codec, audio_codec, bitrate, video_resolution, ' \
+                        'video_framerate, aspect_ratio, audio_channels, transcode_protocol, transcode_container, ' \
+                        'transcode_video_codec, transcode_audio_codec, transcode_audio_channels, transcode_width, ' \
+                        'transcode_height) VALUES ' \
+                        '(last_insert_rowid(), ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
+
+                args = [session['rating_key'], session['video_decision'], session['audio_decision'],
+                        session['duration'], session['width'], session['height'], session['container'],
+                        session['video_codec'], session['audio_codec'], session['bitrate'],
+                        session['video_resolution'], session['video_framerate'], session['aspect_ratio'],
+                        session['audio_channels'], session['transcode_protocol'], session['transcode_container'],
+                        session['transcode_video_codec'], session['transcode_audio_codec'],
+                        session['transcode_audio_channels'], session['transcode_width'], session['transcode_height']]
+
+                # logger.debug(u"PlexPy ActivityProcessor :: Writing session_history_media_info transaction...")
+                self.db.action(query=query, args=args)
+
+                if not is_import:
+                    logger.debug(u"PlexPy ActivityProcessor :: Fetching metadata for item ratingKey %s" % session['rating_key'])
+                    pms_connect = pmsconnect.PmsConnect()
+                    result = pms_connect.get_metadata_details(rating_key=str(session['rating_key']))
+                    metadata = result['metadata']
+                else:
+                    metadata = import_metadata
+
+                # Write the session_history_metadata table
+                directors = ";".join(metadata['directors'])
+                writers = ";".join(metadata['writers'])
+                actors = ";".join(metadata['actors'])
+                genres = ";".join(metadata['genres'])
+
+                # Build media item title
+                if session['media_type'] == 'episode' or session['media_type'] == 'track':
+                    full_title = '%s - %s' % (metadata['grandparent_title'], metadata['title'])
+                elif session['media_type'] == 'movie':
+                    full_title = metadata['title']
+                else:
+                    full_title = metadata['title']
+
+                # logger.debug(u"PlexPy ActivityProcessor :: Attempting to write to session_history_metadata table...")
+                query = 'INSERT INTO session_history_metadata (id, rating_key, parent_rating_key, ' \
+                        'grandparent_rating_key, title, parent_title, grandparent_title, full_title, media_index, ' \
+                        'parent_media_index, thumb, parent_thumb, grandparent_thumb, art, media_type, year, ' \
+                        'originally_available_at, added_at, updated_at, last_viewed_at, content_rating, summary, ' \
+                        'tagline, rating, duration, guid, directors, writers, actors, genres, studio) VALUES ' \
+                        '(last_insert_rowid(), ' \
+                        '?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
+
+                args = [session['rating_key'], session['parent_rating_key'], session['grandparent_rating_key'],
+                        session['title'], session['parent_title'], session['grandparent_title'], full_title,
+                        metadata['index'], metadata['parent_index'], metadata['thumb'], metadata['parent_thumb'],
+                        metadata['grandparent_thumb'], metadata['art'], session['media_type'], metadata['year'],
+                        metadata['originally_available_at'], metadata['added_at'], metadata['updated_at'],
+                        metadata['last_viewed_at'], metadata['content_rating'], metadata['summary'], metadata['tagline'], 
+                        metadata['rating'], metadata['duration'], metadata['guid'], directors, writers, actors, genres, metadata['studio']]
+
+                # logger.debug(u"PlexPy ActivityProcessor :: Writing session_history_metadata transaction...")
+                self.db.action(query=query, args=args)
+
+    def find_session_ip(self, rating_key=None, machine_id=None):
+
+        logger.debug(u"PlexPy ActivityProcessor :: Requesting log lines...")
+        log_lines = log_reader.get_log_tail(window=5000, parsed=False)
+
+        rating_key_line = 'ratingKey=' + rating_key
+        rating_key_line_2 = 'metadata%2F' + rating_key
+        machine_id_line = 'session=' + machine_id
+
+        for line in reversed(log_lines):
+            # We're good if we find a line with both machine id and rating key
+            # This is usually when there is a transcode session
+            if machine_id_line in line and (rating_key_line in line or rating_key_line_2 in line):
+                # Currently only checking for ipv4 addresses
+                ipv4 = re.findall(r'[0-9]+(?:\.[0-9]+){3}', line)
+                if ipv4:
+                    # The logged IP will always be the first match and we don't want localhost entries
+                    if ipv4[0] != '127.0.0.1':
+                        # check if IPv4 mapped IPv6 address (::ffff:xxx.xxx.xxx.xxx)
+                        #if '::ffff:' + ipv4[0] in line:
+                        #    logger.debug(u"PlexPy ActivityProcessor :: Matched IP address (%s) for stream ratingKey %s "
+                        #                 u"and machineIdentifier %s."
+                        #                 % ('::ffff:' + ipv4[0], rating_key, machine_id))
+                        #    return '::ffff:' + ipv4[0]
+                        #else:
+                        logger.debug(u"PlexPy ActivityProcessor :: Matched IP address (%s) for stream ratingKey %s "
+                                        u"and machineIdentifier %s."
+                                        % (ipv4[0], rating_key, machine_id))
+                        return ipv4[0]
+
+        logger.debug(u"PlexPy ActivityProcessor :: Unable to find IP address on first pass. "
+                     u"Attempting fallback check in 5 seconds...")
+
+        # Wait for the log to catch up and read in new lines
+        time.sleep(5)
+
+        logger.debug(u"PlexPy ActivityProcessor :: Requesting log lines...")
+        log_lines = log_reader.get_log_tail(window=5000, parsed=False)
+
+        for line in reversed(log_lines):
+            if 'GET /:/timeline' in line and (rating_key_line in line or rating_key_line_2 in line):
+                # Currently only checking for ipv4 addresses
+                # This method can return the wrong IP address if more than one user
+                # starts watching the same media item around the same time.
+                ipv4 = re.findall(r'[0-9]+(?:\.[0-9]+){3}', line)
+                if ipv4:
+                    # The logged IP will always be the first match and we don't want localhost entries
+                    if ipv4[0] != '127.0.0.1':
+                        #if '::ffff:' + ipv4[0] in line:
+                        #    logger.debug(u"PlexPy ActivityProcessor :: Matched IP address (%s) for stream ratingKey %s." %
+                        #                 ('::ffff:' + ipv4[0], rating_key))
+                        #    return '::ffff:' + ipv4[0]
+                        #else:
+                        logger.debug(u"PlexPy ActivityProcessor :: Matched IP address (%s) for stream ratingKey %s." %
+                                        (ipv4[0], rating_key))
+                        return ipv4[0]
+
+        logger.debug(u"PlexPy ActivityProcessor :: Unable to find IP address on fallback search. Not logging IP address.")
+
+        return None
+
+    def get_session_by_key(self, session_key=None):
+        if str(session_key).isdigit():
+            result = self.db.select('SELECT started, session_key, rating_key, media_type, title, parent_title, '
+                                    'grandparent_title, user_id, user, friendly_name, ip_address, player, '
+                                    'platform, machine_id, parent_rating_key, grandparent_rating_key, state, '
+                                    'view_offset, duration, video_decision, audio_decision, width, height, '
+                                    'container, video_codec, audio_codec, bitrate, video_resolution, '
+                                    'video_framerate, aspect_ratio, audio_channels, transcode_protocol, '
+                                    'transcode_container, transcode_video_codec, transcode_audio_codec, '
+                                    'transcode_audio_channels, transcode_width, transcode_height, '
+                                    'paused_counter, last_paused '
+                                    'FROM sessions WHERE session_key = ? LIMIT 1', args=[session_key])
+            for session in result:
+                if session:
+                    return session
+
+        return None
+
+    def set_session_state(self, session_key=None, state=None, view_offset=0):
+        if str(session_key).isdigit() and str(view_offset).isdigit():
+            values = {'view_offset': int(view_offset)}
+            if state:
+                values['state'] = state
+
+            keys = {'session_key': session_key}
+            result = self.db.upsert('sessions', values, keys)
+
+            return result
+
+        return None
+
+    def delete_session(self, session_key=None):
+        if str(session_key).isdigit():
+            self.db.action('DELETE FROM sessions WHERE session_key = ?', [session_key])
+
+    def set_session_last_paused(self, session_key=None, timestamp=None):
+        if str(session_key).isdigit():
+            result = self.db.select('SELECT last_paused, paused_counter '
+                                    'FROM sessions '
+                                    'WHERE session_key = ?', args=[session_key])
+
+            paused_counter = None
+            for session in result:
+                if session['last_paused']:
+                    paused_offset = int(time.time()) - int(session['last_paused'])
+                    if session['paused_counter']:
+                        paused_counter = int(session['paused_counter']) + int(paused_offset)
+                    else:
+                        paused_counter = int(paused_offset)
+
+            values = {'state': 'playing',
+                      'last_paused': timestamp
+                      }
+            if paused_counter:
+                values['paused_counter'] = paused_counter
+
+            keys = {'session_key': session_key}
+            self.db.upsert('sessions', values, keys)
+
+    def increment_session_buffer_count(self, session_key=None):
+        if str(session_key).isdigit():
+            self.db.action('UPDATE sessions SET buffer_count = buffer_count + 1 '
+                           'WHERE session_key = ?',
+                           [session_key])
+
+    def get_session_buffer_count(self, session_key=None):
+        if str(session_key).isdigit():
+            buffer_count = self.db.select_single('SELECT buffer_count '
+                                                 'FROM sessions '
+                                                 'WHERE session_key = ?',
+                                                 [session_key])
+            if buffer_count:
+                return buffer_count['buffer_count']
+
+            return 0
+
+    def set_session_buffer_trigger_time(self, session_key=None):
+        if str(session_key).isdigit():
+            self.db.action('UPDATE sessions SET buffer_last_triggered = strftime("%s","now") '
+                           'WHERE session_key = ?',
+                           [session_key])
+
+    def get_session_buffer_trigger_time(self, session_key=None):
+        if str(session_key).isdigit():
+            last_time = self.db.select_single('SELECT buffer_last_triggered '
+                                              'FROM sessions '
+                                              'WHERE session_key = ?',
+                                              [session_key])
+            if last_time:
+                return last_time['buffer_last_triggered']
+
+            return None

plexpy/api.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
 #  This file is part of PlexPy.
 #
 #  PlexPy is free software: you can redistribute it and/or modify
@@ -13,86 +16,143 @@
 #  You should have received a copy of the GNU General Public License
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
-from plexpy import db, cache, versioncheck, logger, helpers
-
+from plexpy import versioncheck, logger, plextv, pmsconnect, datafactory, graphs, users
+import os
 import plexpy
 import json
-from xml.dom import minidom
+import traceback
+import cherrypy
+import re
+import hashlib
+import random
+import xmltodict
 
-cmd_list = ['getHistory', 'getLogs', 'getVersion', 'checkGithub', 'shutdown', 'restart', 'update']
+cmd_list = ['getLogs', 'getVersion', 'checkGithub', 'shutdown',
+            'getSettings', 'restart', 'update', 'getApikey', 'getHistory',
+            'getMetadata', 'getUserips', 'getPlayby', 'getSync']
 
 
 class Api(object):
-
-    def __init__(self):
+    def __init__(self, out='json'):
 
         self.apikey = None
+        self.authenticated = False
         self.cmd = None
-        self.id = None
-
         self.kwargs = None
-
+        # For the responses
         self.data = None
-
+        self.msg = None
+        self.result_type = 'error'
+        # Possible general params
         self.callback = None
+        self.out_type = out
+        self.debug = None
 
     def checkParams(self, *args, **kwargs):
 
         if not plexpy.CONFIG.API_ENABLED:
-            self.data = 'API not enabled'
-            return
-        if not plexpy.CONFIG.API_KEY:
-            self.data = 'API key not generated'
-            return
-        if len(plexpy.CONFIG.API_KEY) != 32:
-            self.data = 'API key not generated correctly'
-            return
+            self.msg = 'API not enabled'
+        elif not plexpy.CONFIG.API_KEY:
+            self.msg = 'API key not generated'
+        elif len(plexpy.CONFIG.API_KEY) != 32:
+            self.msg = 'API key not generated correctly'
+        elif 'apikey' not in kwargs:
+            self.msg = 'Parameter apikey is required'
+        elif kwargs.get('apikey', '') != plexpy.CONFIG.API_KEY:
+            self.msg = 'Invalid apikey'
+        elif 'cmd' not in kwargs:
+            self.msg = 'Parameter %s required. possible commands are: %s' % ', '.join(cmd_list)
+        elif 'cmd' in kwargs and kwargs.get('cmd') not in cmd_list:
+            self.msg = 'Unknown command, %s possible commands are: %s' % (kwargs.get('cmd', ''), ', '.join(cmd_list))
 
-        if 'apikey' not in kwargs:
-            self.data = 'Missing api key'
-            return
+        # Set default values or remove them from kwargs
 
-        if kwargs['apikey'] != plexpy.CONFIG.API_KEY:
-            self.data = 'Incorrect API key'
-            return
-        else:
-            self.apikey = kwargs.pop('apikey')
+        self.callback = kwargs.pop('callback', None)
+        self.apikey = kwargs.pop('apikey', None)
+        self.cmd = kwargs.pop('cmd', None)
+        self.debug = kwargs.pop('debug', False)
+        # Allow override for the api.
+        self.out_type = kwargs.pop('out_type', 'json')
 
-        if 'cmd' not in kwargs:
-            self.data = 'Missing parameter: cmd'
-            return
-
-        if kwargs['cmd'] not in cmd_list:
-            self.data = 'Unknown command: %s' % kwargs['cmd']
-            return
-        else:
-            self.cmd = kwargs.pop('cmd')
+        if self.apikey == plexpy.CONFIG.API_KEY and plexpy.CONFIG.API_ENABLED and self.cmd in cmd_list:
+            self.authenticated = True
+            self.msg = None
+        elif self.cmd == 'getApikey' and plexpy.CONFIG.API_ENABLED:
+            self.authenticated = True
+            # Remove the old error msg
+            self.msg = None
 
         self.kwargs = kwargs
-        self.data = 'OK'
+
+    def _responds(self, result_type='success', data=None, msg=''):
+
+        if data is None:
+            data = {}
+        return {"response": {"result": result_type, "message": msg, "data": data}}
+
+    def _out_as(self, out):
+
+        if self.out_type == 'json':
+            cherrypy.response.headers['Content-Type'] = 'application/json;charset=UTF-8'
+            try:
+                out = json.dumps(out, indent=4, sort_keys=True)
+                if self.callback is not None:
+                    cherrypy.response.headers['Content-Type'] = 'application/javascript'
+                    # wrap with JSONP call if requested
+                    out = self.callback + '(' + out + ');'
+            # if we fail to generate the output fake an error
+            except Exception as e:
+                logger.info(u"API :: " + traceback.format_exc())
+                out['message'] = traceback.format_exc()
+                out['result'] = 'error'
+        if self.out_type == 'xml':
+            cherrypy.response.headers['Content-Type'] = 'application/xml'
+            try:
+                out = xmltodict.unparse(out, pretty=True)
+            except ValueError as e:
+                logger.error('Failed to parse xml result')
+                try:
+                    out['message'] = e
+                    out['result'] = 'error'
+                    out = xmltodict.unparse(out, pretty=True)
+
+                except Exception as e:
+                    logger.error('Failed to parse xml result error message')
+                    out = '''<?xml version="1.0" encoding="utf-8"?>
+                                <response>
+                                    <message>%s</message>
+                                    <data></data>
+                                    <result>error</result>
+                                </response>
+                          ''' % e
+
+        return out
 
     def fetchData(self):
 
-        if self.data == 'OK':
-            logger.info('Recieved API command: %s', self.cmd)
-            methodToCall = getattr(self, "_" + self.cmd)
-            methodToCall(**self.kwargs)
-            if 'callback' not in self.kwargs:
-                if isinstance(self.data, basestring):
-                    return self.data
-                else:
-                    return json.dumps(self.data)
+        logger.info('Recieved API command: %s' % self.cmd)
+        if self.cmd and self.authenticated:
+            methodtocall = getattr(self, "_" + self.cmd)
+            # Let the traceback hit cherrypy so we can
+            # see the traceback there
+            if self.debug:
+                methodtocall(**self.kwargs)
             else:
-                self.callback = self.kwargs['callback']
-                self.data = json.dumps(self.data)
-                self.data = self.callback + '(' + self.data + ');'
-                return self.data
-        else:
-            return self.data
+                try:
+                    methodtocall(**self.kwargs)
+                except Exception as e:
+                    logger.error(traceback.format_exc())
+
+        # Im just lazy, fix me plx
+        if self.data or isinstance(self.data, (dict, list)):
+            if len(self.data):
+                self.result_type = 'success'
+
+        return self._out_as(self._responds(result_type=self.result_type, msg=self.msg, data=self.data))
 
     def _dic_from_query(self, query):
 
-        myDB = db.DBConnection()
+        myDB = database.DBConnection()
         rows = myDB.select(query)
 
         rows_as_dic = []
@@ -103,104 +163,115 @@ class Api(object):
 
         return rows_as_dic
 
-    def _getHistory(self, iDisplayStart=0, iDisplayLength=100, sSearch="", iSortCol_0='0', sSortDir_0='asc', **kwargs):
-        iDisplayStart = int(iDisplayStart)
-        iDisplayLength = int(iDisplayLength)
-        filtered = []
-        totalcount = 0
-        myDB = db.DBConnection()
-        db_table = db.DBConnection().get_history_table_name()
+    def _getApikey(self, username='', password=''):
+        """ Returns api key, requires username and password is active """
 
-        sortcolumn = 'time'
-        sortbyhavepercent = False
-        if iSortCol_0 == '1':
-            sortcolumn = 'user'
-        if iSortCol_0 == '2':
-            sortcolumn = 'platform'
-        elif iSortCol_0 == '3':
-            sortcolumn = 'ip_address'
-        elif iSortCol_0 == '4':
-            sortcolumn = 'title'
-        elif iSortCol_0 == '5':
-            sortcolumn = 'time'
-        elif iSortCol_0 == '6':
-            sortcolumn = 'paused_counter'
-        elif iSortCol_0 == '7':
-            sortcolumn = 'stopped'
-        elif iSortCol_0 == '8':
-            sortbyhavepercent = True
-
-        if sSearch == "":
-            query = 'SELECT * from %s order by %s COLLATE NOCASE %s' % (db_table, sortcolumn, sSortDir_0)
-            filtered = myDB.select(query)
-            totalcount = len(filtered)
-        else:
-            query = 'SELECT * from ' + db_table + ' WHERE user LIKE "%' + sSearch + \
-                    '%" OR title LIKE "%' + sSearch + '%"' + 'ORDER BY %s COLLATE NOCASE %s' % (sortcolumn, sSortDir_0)
-            filtered = myDB.select(query)
-            totalcount = myDB.select('SELECT COUNT(*) from processed')[0][0]
-
-        history = filtered[iDisplayStart:(iDisplayStart + iDisplayLength)]
-        rows = []
-        for item in history:
-            row = {"date": item['time'],
-                      "user": item["user"],
-                      "platform": item["platform"],
-                      "ip_address": item["ip_address"],
-                      "title": item["title"],
-                      "started": item["time"],
-                      "paused": item["paused_counter"],
-                      "stopped": item["stopped"],
-                      "duration": "",
-                      "percent_complete": 0,
-                      }
-
-            if item['paused_counter'] > 0:
-                row['paused'] = item['paused_counter']
+        apikey = hashlib.sha224(str(random.getrandbits(256))).hexdigest()[0:32]
+        if plexpy.CONFIG.HTTP_USERNAME and plexpy.CONFIG.HTTP_PASSWORD:
+            if username == plexpy.HTTP_USERNAME and password == plexpy.CONFIG.HTTP_PASSWORD:
+                if plexpy.CONFIG.API_KEY:
+                    self.data = plexpy.CONFIG.API_KEY
+                else:
+                    self.data = apikey
+                    plexpy.CONFIG.API_KEY = apikey
+                    plexpy.CONFIG.write()
             else:
-                row['paused'] = 0
+                self.msg = 'Authentication is enabled, please add the correct username and password to the parameters'
+        else:
+            if plexpy.CONFIG.API_KEY:
+                self.data = plexpy.CONFIG.API_KEY
+            else:
+                # Make a apikey if the doesn't exist
+                self.data = apikey
+                plexpy.CONFIG.API_KEY = apikey
+                plexpy.CONFIG.write()
 
-            if item['time']:
-                if item['stopped'] > 0:
-                    stopped = item['stopped']
-                else:
-                    stopped = 0
-                if item['paused_counter'] > 0:
-                    paused_counter = item['paused_counter']
-                else:
-                    paused_counter = 0
+        return self.data
 
-                row['duration'] = stopped - item['time'] + paused_counter
+    def _getLogs(self, sort='', search='', order='desc', regex='', **kwargs):
+        """
+            Returns the log
+
+            Returns [{"response":
+                                {"msg": "Hey",
+                                 "result": "success"},
+                                 "data": [{"time": "29-sept.2015",
+                                            "thread: "MainThread",
+                                            "msg: "Called x from y",
+                                            "loglevel": "DEBUG"
+                                           }
+                                        ]
+
+                                }
+                    ]
+        """
+        logfile = os.path.join(plexpy.CONFIG.LOG_DIR, 'plexpy.log')
+        templog = []
+        start = int(kwargs.get('start', 0))
+        end = int(kwargs.get('end', 0))
+
+        if regex:
+            logger.debug('Filtering log using regex %s' % regex)
+            reg = re.compile('u' + regex, flags=re.I)
+
+        for line in open(logfile, 'r').readlines():
+            temp_loglevel_and_time = None
 
             try:
-                xml_parse = minidom.parseString(helpers.latinToAscii(item['xml']))
-            except IOError, e:
-                logger.warn("Error parsing XML in PlexWatch db: %s" % e)
+                temp_loglevel_and_time = line.split('- ')
+                loglvl = temp_loglevel_and_time[1].split(' :')[0].strip()
+                tl_tread = line.split(' :: ')
+                if loglvl is None:
+                    msg = line.replace('\n', '')
+                else:
+                    msg = line.split(' : ')[1].replace('\n', '')
+                thread = tl_tread[1].split(' : ')[0]
+            except IndexError:
+                # We assume this is a traceback
+                tl = (len(templog) - 1)
+                templog[tl]['msg'] += line.replace('\n', '')
+                continue
 
-            xml_head = xml_parse.getElementsByTagName('opt')
-            if not xml_head:
-                logger.warn("Error parsing XML in PlexWatch db: %s" % e)
+            if len(line) > 1 and temp_loglevel_and_time is not None and loglvl in line:
 
-            for s in xml_head:
-                if s.getAttribute('duration') and s.getAttribute('viewOffset'):
-                    view_offset = helpers.cast_to_float(s.getAttribute('viewOffset'))
-                    duration = helpers.cast_to_float(s.getAttribute('duration'))
-                    if duration > 0:
-                        row['percent_complete'] = (view_offset / duration)*100
-                    else:
-                        row['percent_complete'] = 0
-
-            rows.append(row)
-
-        dict = {'iTotalDisplayRecords': len(filtered),
-                'iTotalRecords': totalcount,
-                'aaData': rows,
+                d = {
+                    'time': temp_loglevel_and_time[0],
+                    'loglevel': loglvl,
+                    'msg': msg.replace('\n', ''),
+                    'thread': thread
                 }
-        self.data = json.dumps(dict)
-        #cherrypy.response.headers['Content-type'] = 'application/json'
+                templog.append(d)
 
-    def _getLogs(self, **kwargs):
-        pass
+        if end > 0:
+                logger.debug('Slicing the log from %s to %s' % (start, end))
+                templog = templog[start:end]
+
+        if sort:
+            logger.debug('Sorting log based on %s' % sort)
+            templog = sorted(templog, key=lambda k: k[sort])
+
+        if search:
+            logger.debug('Searching log values for %s' % search)
+            tt = [d for d in templog for k, v in d.items() if search.lower() in v.lower()]
+
+            if len(tt):
+                templog = tt
+
+        if regex:
+            tt = []
+            for l in templog:
+                stringdict = ' '.join('{}{}'.format(k, v) for k, v in l.items())
+                if reg.search(stringdict):
+                    tt.append(l)
+
+            if len(tt):
+                templog = tt
+
+        if order == 'desc':
+            templog = templog[::-1]
+
+        self.data = templog
+        return templog
 
     def _getVersion(self, **kwargs):
         self.data = {
@@ -210,6 +281,7 @@ class Api(object):
             'latest_version': plexpy.LATEST_VERSION,
             'commits_behind': plexpy.COMMITS_BEHIND,
         }
+        self.result_type = 'success'
 
     def _checkGithub(self, **kwargs):
         versioncheck.checkGithub()
@@ -217,9 +289,212 @@ class Api(object):
 
     def _shutdown(self, **kwargs):
         plexpy.SIGNAL = 'shutdown'
+        self.msg = 'Shutting down plexpy'
+        self.result_type = 'success'
 
     def _restart(self, **kwargs):
         plexpy.SIGNAL = 'restart'
+        self.msg = 'Restarting plexpy'
+        self.result_type = 'success'
 
     def _update(self, **kwargs):
         plexpy.SIGNAL = 'update'
+        self.msg = 'Updating plexpy'
+        self.result_type = 'success'
+
+    def _getHistory(self, user=None, user_id=None, rating_key='', parent_rating_key='', grandparent_rating_key='', start_date='', **kwargs):
+
+        custom_where = []
+        if user_id:
+            custom_where = [['user_id', user_id]]
+        elif user:
+            custom_where = [['user', user]]
+        if 'rating_key' in kwargs:
+            rating_key = kwargs.get('rating_key', "")
+            custom_where = [['rating_key', rating_key]]
+        if 'parent_rating_key' in kwargs:
+            rating_key = kwargs.get('parent_rating_key', "")
+            custom_where = [['parent_rating_key', rating_key]]
+        if 'grandparent_rating_key' in kwargs:
+            rating_key = kwargs.get('grandparent_rating_key', "")
+            custom_where = [['grandparent_rating_key', rating_key]]
+        if 'start_date' in kwargs:
+            start_date = kwargs.get('start_date', "")
+            custom_where = [['strftime("%Y-%m-%d", datetime(date, "unixepoch", "localtime"))', start_date]]
+
+        data_factory = datafactory.DataFactory()
+        history = data_factory.get_history(kwargs=kwargs, custom_where=custom_where)
+
+        self.data = history
+        return self.data
+
+    def _getSync(self, machine_id=None, user_id=None, **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        server_id = pms_connect.get_server_identity()
+
+        plex_tv = plextv.PlexTV()
+        if not machine_id:
+            result = plex_tv.get_synced_items(machine_id=server_id['machine_identifier'], user_id=user_id)
+        else:
+            result = plex_tv.get_synced_items(machine_id=machine_id, user_id=user_id)
+
+        if result:
+            self.data = result
+            return result
+        else:
+            self.msg = 'Unable to retrieve sync data for user'
+            logger.warn('Unable to retrieve sync data for user.')
+
+    def _getMetadata(self, rating_key='', **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        result = pms_connect.get_metadata(rating_key, 'dict')
+
+        if result:
+            self.data = result
+            return result
+        else:
+            self.msg = 'Unable to retrive metadata %s' % rating_key
+            logger.warn('Unable to retrieve data.')
+
+    def _getSettings(self):
+        interface_dir = os.path.join(plexpy.PROG_DIR, 'data/interfaces/')
+        interface_list = [name for name in os.listdir(interface_dir) if
+                          os.path.isdir(os.path.join(interface_dir, name))]
+
+        config = {
+            "http_host": plexpy.CONFIG.HTTP_HOST,
+            "http_username": plexpy.CONFIG.HTTP_USERNAME,
+            "http_port": plexpy.CONFIG.HTTP_PORT,
+            "http_password": plexpy.CONFIG.HTTP_PASSWORD,
+            "launch_browser": bool(plexpy.CONFIG.LAUNCH_BROWSER),
+            "enable_https": bool(plexpy.CONFIG.ENABLE_HTTPS),
+            "https_cert": plexpy.CONFIG.HTTPS_CERT,
+            "https_key": plexpy.CONFIG.HTTPS_KEY,
+            "api_enabled": plexpy.CONFIG.API_ENABLED,
+            "api_key": plexpy.CONFIG.API_KEY,
+            "update_db_interval": plexpy.CONFIG.UPDATE_DB_INTERVAL,
+            "freeze_db": bool(plexpy.CONFIG.FREEZE_DB),
+            "log_dir": plexpy.CONFIG.LOG_DIR,
+            "cache_dir": plexpy.CONFIG.CACHE_DIR,
+            "check_github": bool(plexpy.CONFIG.CHECK_GITHUB),
+            "interface_list": interface_list,
+            "cache_sizemb": plexpy.CONFIG.CACHE_SIZEMB,
+            "pms_identifier": plexpy.CONFIG.PMS_IDENTIFIER,
+            "pms_ip": plexpy.CONFIG.PMS_IP,
+            "pms_logs_folder": plexpy.CONFIG.PMS_LOGS_FOLDER,
+            "pms_port": plexpy.CONFIG.PMS_PORT,
+            "pms_token": plexpy.CONFIG.PMS_TOKEN,
+            "pms_ssl": bool(plexpy.CONFIG.PMS_SSL),
+            "pms_use_bif": bool(plexpy.CONFIG.PMS_USE_BIF),
+            "pms_uuid": plexpy.CONFIG.PMS_UUID,
+            "date_format": plexpy.CONFIG.DATE_FORMAT,
+            "time_format": plexpy.CONFIG.TIME_FORMAT,
+            "grouping_global_history": bool(plexpy.CONFIG.GROUPING_GLOBAL_HISTORY),
+            "grouping_user_history": bool(plexpy.CONFIG.GROUPING_USER_HISTORY),
+            "grouping_charts": bool(plexpy.CONFIG.GROUPING_CHARTS),
+            "movie_notify_enable": bool(plexpy.CONFIG.MOVIE_NOTIFY_ENABLE),
+            "tv_notify_enable": bool(plexpy.CONFIG.TV_NOTIFY_ENABLE),
+            "music_notify_enable": bool(plexpy.CONFIG.MUSIC_NOTIFY_ENABLE),
+            "tv_notify_on_start": bool(plexpy.CONFIG.TV_NOTIFY_ON_START),
+            "movie_notify_on_start": bool(plexpy.CONFIG.MOVIE_NOTIFY_ON_START),
+            "music_notify_on_start": bool(plexpy.CONFIG.MUSIC_NOTIFY_ON_START),
+            "tv_notify_on_stop": bool(plexpy.CONFIG.TV_NOTIFY_ON_STOP),
+            "movie_notify_on_stop": bool(plexpy.CONFIG.MOVIE_NOTIFY_ON_STOP),
+            "music_notify_on_stop": bool(plexpy.CONFIG.MUSIC_NOTIFY_ON_STOP),
+            "tv_notify_on_pause": bool(plexpy.CONFIG.TV_NOTIFY_ON_PAUSE),
+            "movie_notify_on_pause": bool(plexpy.CONFIG.MOVIE_NOTIFY_ON_PAUSE),
+            "music_notify_on_pause": bool(plexpy.CONFIG.MUSIC_NOTIFY_ON_PAUSE),
+            "monitoring_interval": plexpy.CONFIG.MONITORING_INTERVAL,
+            "refresh_users_interval": plexpy.CONFIG.REFRESH_USERS_INTERVAL,
+            "refresh_users_on_startup": bool(plexpy.CONFIG.REFRESH_USERS_ON_STARTUP),
+            "ip_logging_enable": bool(plexpy.CONFIG.IP_LOGGING_ENABLE),
+            "movie_logging_enable": bool(plexpy.CONFIG.MOVIE_LOGGING_ENABLE),
+            "tv_logging_enable": bool(plexpy.CONFIG.TV_LOGGING_ENABLE),
+            "music_logging_enable": bool(plexpy.CONFIG.MUSIC_LOGGING_ENABLE),
+            "logging_ignore_interval": plexpy.CONFIG.LOGGING_IGNORE_INTERVAL,
+            "pms_is_remote": bool(plexpy.CONFIG.PMS_IS_REMOTE),
+            "notify_watched_percent": plexpy.CONFIG.NOTIFY_WATCHED_PERCENT,
+            "notify_on_start_subject_text": plexpy.CONFIG.NOTIFY_ON_START_SUBJECT_TEXT,
+            "notify_on_start_body_text": plexpy.CONFIG.NOTIFY_ON_START_BODY_TEXT,
+            "notify_on_stop_subject_text": plexpy.CONFIG.NOTIFY_ON_STOP_SUBJECT_TEXT,
+            "notify_on_stop_body_text": plexpy.CONFIG.NOTIFY_ON_STOP_BODY_TEXT,
+            "notify_on_pause_subject_text": plexpy.CONFIG.NOTIFY_ON_PAUSE_SUBJECT_TEXT,
+            "notify_on_pause_body_text": plexpy.CONFIG.NOTIFY_ON_PAUSE_BODY_TEXT,
+            "notify_on_resume_subject_text": plexpy.CONFIG.NOTIFY_ON_RESUME_SUBJECT_TEXT,
+            "notify_on_resume_body_text": plexpy.CONFIG.NOTIFY_ON_RESUME_BODY_TEXT,
+            "notify_on_buffer_subject_text": plexpy.CONFIG.NOTIFY_ON_BUFFER_SUBJECT_TEXT,
+            "notify_on_buffer_body_text": plexpy.CONFIG.NOTIFY_ON_BUFFER_BODY_TEXT,
+            "notify_on_watched_subject_text": plexpy.CONFIG.NOTIFY_ON_WATCHED_SUBJECT_TEXT,
+            "notify_on_watched_body_text": plexpy.CONFIG.NOTIFY_ON_WATCHED_BODY_TEXT,
+            "home_stats_length": plexpy.CONFIG.HOME_STATS_LENGTH,
+            "home_stats_type": bool(plexpy.CONFIG.HOME_STATS_TYPE),
+            "home_stats_count": plexpy.CONFIG.HOME_STATS_COUNT,
+            "home_stats_cards": plexpy.CONFIG.HOME_STATS_CARDS,
+            "home_library_cards": plexpy.CONFIG.HOME_LIBRARY_CARDS,
+            "buffer_threshold": plexpy.CONFIG.BUFFER_THRESHOLD,
+            "buffer_wait": plexpy.CONFIG.BUFFER_WAIT
+        }
+
+        self.data = config
+        return config
+
+    def _getUserips(self, user_id=None, user=None, **kwargs):
+        custom_where = []
+        if user_id:
+            custom_where = [['user_id', user_id]]
+        elif user:
+            custom_where = [['user', user]]
+
+        user_data = users.Users()
+        history = user_data.get_user_unique_ips(kwargs=kwargs,
+                                                custom_where=custom_where)
+
+        if history:
+            self.data = history
+            return history
+        else:
+            self.msg = 'Failed to find users ips'
+
+    def _getPlayby(self, time_range='30', y_axis='plays', playtype='total_plays_per_month', **kwargs):
+
+        graph = graphs.Graphs()
+        if playtype == 'total_plays_per_month':
+            result = graph.get_total_plays_per_month(y_axis=y_axis)
+
+        elif playtype == 'total_plays_per_day':
+            result = graph.get_total_plays_per_day(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_per_hourofday':
+            result = graph.get_total_plays_per_hourofday(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_per_dayofweek':
+            result = graph.get_total_plays_per_dayofweek(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'stream_type_by_top_10_users':
+            result = graph.get_stream_type_by_top_10_users(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'stream_type_by_top_10_platforms':
+            result = graph.get_stream_type_by_top_10_platforms(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_by_stream_resolution':
+            result = graph.get_total_plays_by_stream_resolution(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_by_source_resolution':
+            result = graph.get_total_plays_by_source_resolution(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_per_stream_type':
+            result = graph.get_total_plays_per_stream_type(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_by_top_10_users':
+            result = graph.get_total_plays_by_top_10_users(time_range=time_range, y_axis=y_axis)
+
+        elif playtype == 'total_plays_by_top_10_platforms':
+            result = graph.get_total_plays_by_top_10_platforms(time_range=time_range, y_axis=y_axis)
+
+        if result:
+            self.data = result
+            return result
+        else:
+            logger.warn('Unable to retrieve %s from db' % playtype)

plexpy/common.py

@@ -41,4 +41,9 @@ notify_strings[NOTIFY_STOPPED] = "Playback stopped"
 
 DEFAULT_USER_THUMB = "interfaces/default/images/gravatar-default-80x80.png"
 DEFAULT_POSTER_THUMB = "interfaces/default/images/poster.png"
-DEFAULT_COVER_THUMB = "interfaces/default/images/cover.png"
+DEFAULT_COVER_THUMB = "interfaces/default/images/cover.png"
+
+PLATFORM_NAME_OVERRIDES = {'Konvergo': 'Plex Media Player',
+                           'Mystery 3': 'Playstation 3',
+                           'Mystery 4': 'Playstation 4',
+                           'Mystery 5': 'Xbox 360'}

plexpy/config.py

@@ -26,6 +26,7 @@ _CONFIG_DEFINITIONS = {
     'PMS_IP': (str, 'PMS', '127.0.0.1'),
     'PMS_IS_REMOTE': (int, 'PMS', 0),
     'PMS_LOGS_FOLDER': (str, 'PMS', ''),
+    'PMS_NAME': (unicode, 'PMS', ''),
     'PMS_PORT': (int, 'PMS', 32400),
     'PMS_TOKEN': (str, 'PMS', ''),
     'PMS_SSL': (int, 'General', 0),
@@ -37,12 +38,18 @@ _CONFIG_DEFINITIONS = {
     'API_KEY': (str, 'General', ''),
     'BOXCAR_ENABLED': (int, 'Boxcar', 0),
     'BOXCAR_TOKEN': (str, 'Boxcar', ''),
+    'BOXCAR_SOUND': (str, 'Boxcar', ''),
     'BOXCAR_ON_PLAY': (int, 'Boxcar', 0),
     'BOXCAR_ON_STOP': (int, 'Boxcar', 0),
     'BOXCAR_ON_PAUSE': (int, 'Boxcar', 0),
     'BOXCAR_ON_RESUME': (int, 'Boxcar', 0),
     'BOXCAR_ON_BUFFER': (int, 'Boxcar', 0),
     'BOXCAR_ON_WATCHED': (int, 'Boxcar', 0),
+    'BOXCAR_ON_CREATED': (int, 'Boxcar', 0),
+    'BOXCAR_ON_EXTDOWN': (int, 'Boxcar', 0),
+    'BOXCAR_ON_INTDOWN': (int, 'Boxcar', 0),
+    'BOXCAR_ON_EXTUP': (int, 'Boxcar', 0),
+    'BOXCAR_ON_INTUP': (int, 'Boxcar', 0),
     'BUFFER_THRESHOLD': (int, 'Monitoring', 3),
     'BUFFER_WAIT': (int, 'Monitoring', 900),
     'CACHE_DIR': (str, 'General', ''),
@@ -56,6 +63,8 @@ _CONFIG_DEFINITIONS = {
     'EMAIL_ENABLED': (int, 'Email', 0),
     'EMAIL_FROM': (str, 'Email', ''),
     'EMAIL_TO': (str, 'Email', ''),
+    'EMAIL_CC': (str, 'Email', ''),
+    'EMAIL_BCC': (str, 'Email', ''),
     'EMAIL_SMTP_SERVER': (str, 'Email', ''),
     'EMAIL_SMTP_USER': (str, 'Email', ''),
     'EMAIL_SMTP_PASSWORD': (str, 'Email', ''),
@@ -67,12 +76,21 @@ _CONFIG_DEFINITIONS = {
     'EMAIL_ON_RESUME': (int, 'Email', 0),
     'EMAIL_ON_BUFFER': (int, 'Email', 0),
     'EMAIL_ON_WATCHED': (int, 'Email', 0),
+    'EMAIL_ON_CREATED': (int, 'Email', 0),
+    'EMAIL_ON_EXTDOWN': (int, 'Email', 0),
+    'EMAIL_ON_INTDOWN': (int, 'Email', 0),
+    'EMAIL_ON_EXTUP': (int, 'Email', 0),
+    'EMAIL_ON_INTUP': (int, 'Email', 0),
     'ENABLE_HTTPS': (int, 'General', 0),
     'FIRST_RUN_COMPLETE': (int, 'General', 0),
     'FREEZE_DB': (int, 'General', 0),
     'GIT_BRANCH': (str, 'General', 'master'),
     'GIT_PATH': (str, 'General', ''),
     'GIT_USER': (str, 'General', 'drzoidberg33'),
+    'GRAPH_TYPE': (str, 'General', 'plays'),
+    'GRAPH_DAYS': (int, 'General', 30),
+    'GRAPH_TAB': (str, 'General', 'tabs-1'),
+    'GROUP_HISTORY_TABLES': (int, 'General', 0),
     'GROWL_ENABLED': (int, 'Growl', 0),
     'GROWL_HOST': (str, 'Growl', ''),
     'GROWL_PASSWORD': (str, 'Growl', ''),
@@ -82,9 +100,17 @@ _CONFIG_DEFINITIONS = {
     'GROWL_ON_RESUME': (int, 'Growl', 0),
     'GROWL_ON_BUFFER': (int, 'Growl', 0),
     'GROWL_ON_WATCHED': (int, 'Growl', 0),
+    'GROWL_ON_CREATED': (int, 'Growl', 0),
+    'GROWL_ON_EXTDOWN': (int, 'Growl', 0),
+    'GROWL_ON_INTDOWN': (int, 'Growl', 0),
+    'GROWL_ON_EXTUP': (int, 'Growl', 0),
+    'GROWL_ON_INTUP': (int, 'Growl', 0),
+    'HOME_LIBRARY_CARDS': (str, 'General', 'library_statistics_first'),
     'HOME_STATS_LENGTH': (int, 'General', 30),
     'HOME_STATS_TYPE': (int, 'General', 0),
     'HOME_STATS_COUNT': (int, 'General', 5),
+    'HOME_STATS_CARDS': (str, 'General', 'watch_statistics, top_tv, popular_tv, top_movies, popular_movies, ' \
+        'top_music, popular_music, last_watched, top_users, top_platforms, most_concurrent'),
     'HTTPS_CERT': (str, 'General', ''),
     'HTTPS_KEY': (str, 'General', ''),
     'HTTP_HOST': (str, 'General', '0.0.0.0'),
@@ -95,20 +121,37 @@ _CONFIG_DEFINITIONS = {
     'HTTP_USERNAME': (str, 'General', ''),
     'INTERFACE': (str, 'General', 'default'),
     'IP_LOGGING_ENABLE': (int, 'General', 0),
+    'IFTTT_KEY': (str, 'IFTTT', ''),
+    'IFTTT_EVENT': (str, 'IFTTT', 'plexpy'),
+    'IFTTT_ENABLED': (int, 'IFTTT', 0),
+    'IFTTT_ON_PLAY': (int, 'IFTTT', 0),
+    'IFTTT_ON_STOP': (int, 'IFTTT', 0),
+    'IFTTT_ON_PAUSE': (int, 'IFTTT', 0),
+    'IFTTT_ON_RESUME': (int, 'IFTTT', 0),
+    'IFTTT_ON_BUFFER': (int, 'IFTTT', 0),
+    'IFTTT_ON_WATCHED': (int, 'IFTTT', 0),
+    'IFTTT_ON_CREATED': (int, 'IFTTT', 0),
+    'IFTTT_ON_EXTDOWN': (int, 'IFTTT', 0),
+    'IFTTT_ON_INTDOWN': (int, 'IFTTT', 0),
+    'IFTTT_ON_EXTUP': (int, 'IFTTT', 0),
+    'IFTTT_ON_INTUP': (int, 'IFTTT', 0),
     'JOURNAL_MODE': (str, 'Advanced', 'wal'),
     'LAUNCH_BROWSER': (int, 'General', 1),
     'LOG_DIR': (str, 'General', ''),
     'LOGGING_IGNORE_INTERVAL': (int, 'Monitoring', 120),
+    'MOVIE_LOGGING_ENABLE': (int, 'Monitoring', 1),
     'MOVIE_NOTIFY_ENABLE': (int, 'Monitoring', 0),
     'MOVIE_NOTIFY_ON_START': (int, 'Monitoring', 1),
     'MOVIE_NOTIFY_ON_STOP': (int, 'Monitoring', 0),
     'MOVIE_NOTIFY_ON_PAUSE': (int, 'Monitoring', 0),
+    'MUSIC_LOGGING_ENABLE': (int, 'Monitoring', 1),
     'MUSIC_NOTIFY_ENABLE': (int, 'Monitoring', 0),
     'MUSIC_NOTIFY_ON_START': (int, 'Monitoring', 1),
     'MUSIC_NOTIFY_ON_STOP': (int, 'Monitoring', 0),
     'MUSIC_NOTIFY_ON_PAUSE': (int, 'Monitoring', 0),
-    'MUSIC_LOGGING_ENABLE': (int, 'Monitoring', 0),
+    'MONITOR_REMOTE_ACCESS': (int, 'Monitoring', 0),
     'MONITORING_INTERVAL': (int, 'Monitoring', 60),
+    'MONITORING_USE_WEBSOCKET': (int, 'Monitoring', 0),
     'NMA_APIKEY': (str, 'NMA', ''),
     'NMA_ENABLED': (int, 'NMA', 0),
     'NMA_PRIORITY': (int, 'NMA', 0),
@@ -118,19 +161,38 @@ _CONFIG_DEFINITIONS = {
     'NMA_ON_RESUME': (int, 'NMA', 0),
     'NMA_ON_BUFFER': (int, 'NMA', 0),
     'NMA_ON_WATCHED': (int, 'NMA', 0),
+    'NMA_ON_CREATED': (int, 'NMA', 0),
+    'NMA_ON_EXTDOWN': (int, 'NMA', 0),
+    'NMA_ON_INTDOWN': (int, 'NMA', 0),
+    'NMA_ON_EXTUP': (int, 'NMA', 0),
+    'NMA_ON_INTUP': (int, 'NMA', 0),
+    'NOTIFY_CONSECUTIVE': (int, 'Monitoring', 1),
+    'NOTIFY_RECENTLY_ADDED': (int, 'Monitoring', 0),
+    'NOTIFY_RECENTLY_ADDED_GRANDPARENT': (int, 'Monitoring', 0),
+    'NOTIFY_RECENTLY_ADDED_DELAY': (int, 'Monitoring', 60),
     'NOTIFY_WATCHED_PERCENT': (int, 'Monitoring', 85),
-    'NOTIFY_ON_START_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_START_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) started playing {title}.'),
-    'NOTIFY_ON_STOP_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_STOP_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) has stopped {title}.'),
-    'NOTIFY_ON_PAUSE_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_PAUSE_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) has paused {title}.'),
-    'NOTIFY_ON_RESUME_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_RESUME_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) has resumed {title}.'),
-    'NOTIFY_ON_BUFFER_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_BUFFER_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) is buffering {title}.'),
-    'NOTIFY_ON_WATCHED_SUBJECT_TEXT': (str, 'Monitoring', 'PlexPy ({server_name})'),
-    'NOTIFY_ON_WATCHED_BODY_TEXT': (str, 'Monitoring', '{user} ({player}) has watched {title}.'),
+    'NOTIFY_ON_START_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_START_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) started playing {title}.'),
+    'NOTIFY_ON_STOP_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_STOP_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) has stopped {title}.'),
+    'NOTIFY_ON_PAUSE_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_PAUSE_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) has paused {title}.'),
+    'NOTIFY_ON_RESUME_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_RESUME_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) has resumed {title}.'),
+    'NOTIFY_ON_BUFFER_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_BUFFER_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) is buffering {title}.'),
+    'NOTIFY_ON_WATCHED_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_WATCHED_BODY_TEXT': (unicode, 'Monitoring', '{user} ({player}) has watched {title}.'),
+    'NOTIFY_ON_CREATED_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_CREATED_BODY_TEXT': (unicode, 'Monitoring', '{title} was recently added to Plex.'),
+    'NOTIFY_ON_EXTDOWN_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_EXTDOWN_BODY_TEXT': (unicode, 'Monitoring', 'The Plex Media Server remote access is down.'),
+    'NOTIFY_ON_INTDOWN_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_INTDOWN_BODY_TEXT': (unicode, 'Monitoring', 'The Plex Media Server is down.'),
+    'NOTIFY_ON_EXTUP_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_EXTUP_BODY_TEXT': (unicode, 'Monitoring', 'The Plex Media Server remote access is back up.'),
+    'NOTIFY_ON_INTUP_SUBJECT_TEXT': (unicode, 'Monitoring', 'PlexPy ({server_name})'),
+    'NOTIFY_ON_INTUP_BODY_TEXT': (unicode, 'Monitoring', 'The Plex Media Server is back up.'),
     'OSX_NOTIFY_APP': (str, 'OSX_Notify', '/Applications/PlexPy'),
     'OSX_NOTIFY_ENABLED': (int, 'OSX_Notify', 0),
     'OSX_NOTIFY_ON_PLAY': (int, 'OSX_Notify', 0),
@@ -139,6 +201,11 @@ _CONFIG_DEFINITIONS = {
     'OSX_NOTIFY_ON_RESUME': (int, 'OSX_Notify', 0),
     'OSX_NOTIFY_ON_BUFFER': (int, 'OSX_Notify', 0),
     'OSX_NOTIFY_ON_WATCHED': (int, 'OSX_Notify', 0),
+    'OSX_NOTIFY_ON_CREATED': (int, 'OSX_Notify', 0),
+    'OSX_NOTIFY_ON_EXTDOWN': (int, 'OSX_Notify', 0),
+    'OSX_NOTIFY_ON_INTDOWN': (int, 'OSX_Notify', 0),
+    'OSX_NOTIFY_ON_EXTUP': (int, 'OSX_Notify', 0),
+    'OSX_NOTIFY_ON_INTUP': (int, 'OSX_Notify', 0),
     'PLEX_CLIENT_HOST': (str, 'Plex', ''),
     'PLEX_ENABLED': (int, 'Plex', 0),
     'PLEX_PASSWORD': (str, 'Plex', ''),
@@ -149,6 +216,11 @@ _CONFIG_DEFINITIONS = {
     'PLEX_ON_RESUME': (int, 'Plex', 0),
     'PLEX_ON_BUFFER': (int, 'Plex', 0),
     'PLEX_ON_WATCHED': (int, 'Plex', 0),
+    'PLEX_ON_CREATED': (int, 'Plex', 0),
+    'PLEX_ON_EXTDOWN': (int, 'Plex', 0),
+    'PLEX_ON_INTDOWN': (int, 'Plex', 0),
+    'PLEX_ON_EXTUP': (int, 'Plex', 0),
+    'PLEX_ON_INTUP': (int, 'Plex', 0),
     'PROWL_ENABLED': (int, 'Prowl', 0),
     'PROWL_KEYS': (str, 'Prowl', ''),
     'PROWL_PRIORITY': (int, 'Prowl', 0),
@@ -158,6 +230,11 @@ _CONFIG_DEFINITIONS = {
     'PROWL_ON_RESUME': (int, 'Prowl', 0),
     'PROWL_ON_BUFFER': (int, 'Prowl', 0),
     'PROWL_ON_WATCHED': (int, 'Prowl', 0),
+    'PROWL_ON_CREATED': (int, 'Prowl', 0),
+    'PROWL_ON_EXTDOWN': (int, 'Prowl', 0),
+    'PROWL_ON_INTDOWN': (int, 'Prowl', 0),
+    'PROWL_ON_EXTUP': (int, 'Prowl', 0),
+    'PROWL_ON_INTUP': (int, 'Prowl', 0),
     'PUSHALOT_APIKEY': (str, 'Pushalot', ''),
     'PUSHALOT_ENABLED': (int, 'Pushalot', 0),
     'PUSHALOT_ON_PLAY': (int, 'Pushalot', 0),
@@ -166,6 +243,11 @@ _CONFIG_DEFINITIONS = {
     'PUSHALOT_ON_RESUME': (int, 'Pushalot', 0),
     'PUSHALOT_ON_BUFFER': (int, 'Pushalot', 0),
     'PUSHALOT_ON_WATCHED': (int, 'Pushalot', 0),
+    'PUSHALOT_ON_CREATED': (int, 'Pushalot', 0),
+    'PUSHALOT_ON_EXTDOWN': (int, 'Pushalot', 0),
+    'PUSHALOT_ON_INTDOWN': (int, 'Pushalot', 0),
+    'PUSHALOT_ON_EXTUP': (int, 'Pushalot', 0),
+    'PUSHALOT_ON_INTUP': (int, 'Pushalot', 0),
     'PUSHBULLET_APIKEY': (str, 'PushBullet', ''),
     'PUSHBULLET_DEVICEID': (str, 'PushBullet', ''),
     'PUSHBULLET_CHANNEL_TAG': (str, 'PushBullet', ''),
@@ -176,26 +258,63 @@ _CONFIG_DEFINITIONS = {
     'PUSHBULLET_ON_RESUME': (int, 'PushBullet', 0),
     'PUSHBULLET_ON_BUFFER': (int, 'PushBullet', 0),
     'PUSHBULLET_ON_WATCHED': (int, 'PushBullet', 0),
+    'PUSHBULLET_ON_CREATED': (int, 'PushBullet', 0),
+    'PUSHBULLET_ON_EXTDOWN': (int, 'PushBullet', 0),
+    'PUSHBULLET_ON_INTDOWN': (int, 'PushBullet', 0),
+    'PUSHBULLET_ON_EXTUP': (int, 'PushBullet', 0),
+    'PUSHBULLET_ON_INTUP': (int, 'PushBullet', 0),
     'PUSHOVER_APITOKEN': (str, 'Pushover', ''),
     'PUSHOVER_ENABLED': (int, 'Pushover', 0),
     'PUSHOVER_KEYS': (str, 'Pushover', ''),
     'PUSHOVER_PRIORITY': (int, 'Pushover', 0),
+    'PUSHOVER_SOUND': (str, 'Pushover', ''),
     'PUSHOVER_ON_PLAY': (int, 'Pushover', 0),
     'PUSHOVER_ON_STOP': (int, 'Pushover', 0),
     'PUSHOVER_ON_PAUSE': (int, 'Pushover', 0),
     'PUSHOVER_ON_RESUME': (int, 'Pushover', 0),
     'PUSHOVER_ON_BUFFER': (int, 'Pushover', 0),
     'PUSHOVER_ON_WATCHED': (int, 'Pushover', 0),
+    'PUSHOVER_ON_CREATED': (int, 'Pushover', 0),
+    'PUSHOVER_ON_EXTDOWN': (int, 'Pushover', 0),
+    'PUSHOVER_ON_INTDOWN': (int, 'Pushover', 0),
+    'PUSHOVER_ON_EXTUP': (int, 'Pushover', 0),
+    'PUSHOVER_ON_INTUP': (int, 'Pushover', 0),
     'REFRESH_USERS_INTERVAL': (int, 'Monitoring', 12),
     'REFRESH_USERS_ON_STARTUP': (int, 'Monitoring', 1),
+    'TELEGRAM_BOT_TOKEN': (str, 'Telegram', ''),
+    'TELEGRAM_ENABLED': (int, 'Telegram', 0),
+    'TELEGRAM_CHAT_ID': (str, 'Telegram', ''),
+    'TELEGRAM_ON_PLAY': (int, 'Telegram', 0),
+    'TELEGRAM_ON_STOP': (int, 'Telegram', 0),
+    'TELEGRAM_ON_PAUSE': (int, 'Telegram', 0),
+    'TELEGRAM_ON_RESUME': (int, 'Telegram', 0),
+    'TELEGRAM_ON_BUFFER': (int, 'Telegram', 0),
+    'TELEGRAM_ON_WATCHED': (int, 'Telegram', 0),
+    'TELEGRAM_ON_CREATED': (int, 'Telegram', 0),
+    'TELEGRAM_ON_EXTDOWN': (int, 'Telegram', 0),
+    'TELEGRAM_ON_INTDOWN': (int, 'Telegram', 0),
+    'TELEGRAM_ON_EXTUP': (int, 'Telegram', 0),
+    'TELEGRAM_ON_INTUP': (int, 'Telegram', 0),
+    'TV_LOGGING_ENABLE': (int, 'Monitoring', 1),
     'TV_NOTIFY_ENABLE': (int, 'Monitoring', 0),
     'TV_NOTIFY_ON_START': (int, 'Monitoring', 1),
     'TV_NOTIFY_ON_STOP': (int, 'Monitoring', 0),
     'TV_NOTIFY_ON_PAUSE': (int, 'Monitoring', 0),
     'TWITTER_ENABLED': (int, 'Twitter', 0),
     'TWITTER_PASSWORD': (str, 'Twitter', ''),
-    'TWITTER_PREFIX': (str, 'Twitter', 'Headphones'),
+    'TWITTER_PREFIX': (str, 'Twitter', 'PlexPy'),
     'TWITTER_USERNAME': (str, 'Twitter', ''),
+    'TWITTER_ON_PLAY': (int, 'Twitter', 0),
+    'TWITTER_ON_STOP': (int, 'Twitter', 0),
+    'TWITTER_ON_PAUSE': (int, 'Twitter', 0),
+    'TWITTER_ON_RESUME': (int, 'Twitter', 0),
+    'TWITTER_ON_BUFFER': (int, 'Twitter', 0),
+    'TWITTER_ON_WATCHED': (int, 'Twitter', 0),
+    'TWITTER_ON_CREATED': (int, 'Twitter', 0),
+    'TWITTER_ON_EXTDOWN': (int, 'Twitter', 0),
+    'TWITTER_ON_INTDOWN': (int, 'Twitter', 0),
+    'TWITTER_ON_EXTUP': (int, 'Twitter', 0),
+    'TWITTER_ON_INTUP': (int, 'Twitter', 0),
     'UPDATE_DB_INTERVAL': (int, 'General', 24),
     'VERIFY_SSL_CERT': (bool_int, 'Advanced', 1),
     'VIDEO_LOGGING_ENABLE': (int, 'Monitoring', 1),
@@ -208,7 +327,12 @@ _CONFIG_DEFINITIONS = {
     'XBMC_ON_PAUSE': (int, 'XBMC', 0),
     'XBMC_ON_RESUME': (int, 'XBMC', 0),
     'XBMC_ON_BUFFER': (int, 'XBMC', 0),
-    'XBMC_ON_WATCHED': (int, 'XBMC', 0)
+    'XBMC_ON_WATCHED': (int, 'XBMC', 0),
+    'XBMC_ON_CREATED': (int, 'XBMC', 0),
+    'XBMC_ON_EXTDOWN': (int, 'XBMC', 0),
+    'XBMC_ON_INTDOWN': (int, 'XBMC', 0),
+    'XBMC_ON_EXTUP': (int, 'XBMC', 0),
+    'XBMC_ON_INTUP': (int, 'XBMC', 0)
 }
 # pylint:disable=R0902
 # it might be nice to refactor for fewer instance variables
@@ -221,6 +345,7 @@ class Config(object):
         self._config = ConfigObj(self._config_file, encoding='utf-8')
         for key in _CONFIG_DEFINITIONS.keys():
             self.check_setting(key)
+        self._upgrade()
 
     def _define(self, name):
         key = name.upper()
@@ -309,4 +434,18 @@ class Config(object):
         """
         for name, value in kwargs.items():
             key, definition_type, section, ini_key, default = self._define(name)
-            self._config[section][ini_key] = definition_type(value)
+            self._config[section][ini_key] = definition_type(value)
+
+    def _upgrade(self):
+        """
+        Upgrades config file from previous verisions and bumps up config version
+        """
+        if self.CONFIG_VERSION == '0':
+            # Separate out movie and tv notifications
+            if self.MOVIE_NOTIFY_ENABLE == 1:
+                self.TV_NOTIFY_ENABLE = 1
+            # Separate out movie and tv logging
+            if self.VIDEO_LOGGING_ENABLE == 0:
+                self.MOVIE_LOGGING_ENABLE = 0
+                self.TV_LOGGING_ENABLE = 0
+            self.CONFIG_VERSION = '1'

plexpy/database.py

@@ -18,7 +18,10 @@ from plexpy import logger
 import sqlite3
 import os
 import plexpy
+import time
+import threading
 
+db_lock = threading.Lock()
 
 def drop_session_db():
     monitor_db = MonitorDatabase()
@@ -43,6 +46,13 @@ def get_cache_size():
         return 0
     return int(plexpy.CONFIG.CACHE_SIZEMB)
 
+def dict_factory(cursor, row):
+    d = {}
+    for idx, col in enumerate(cursor.description):
+        d[col[0]] = row[idx]
+
+    return d
+
 
 class MonitorDatabase(object):
 
@@ -55,34 +65,40 @@ class MonitorDatabase(object):
         self.connection.execute("PRAGMA journal_mode = %s" % plexpy.CONFIG.JOURNAL_MODE)
         # 64mb of cache memory, probably need to make it user configurable
         self.connection.execute("PRAGMA cache_size=-%s" % (get_cache_size() * 1024))
-        self.connection.row_factory = sqlite3.Row
+        self.connection.row_factory = dict_factory
 
     def action(self, query, args=None, return_last_id=False):
-
         if query is None:
             return
 
-        sql_result = None
+        with db_lock:
+            sql_result = None
+            attempts = 0
 
-        try:
-            with self.connection as c:
-                if args is None:
-                    sql_result = c.execute(query)
-                else:
-                    sql_result = c.execute(query, args)
+            while attempts < 5:
+                try:
+                    with self.connection as c:
+                        if args is None:
+                            sql_result = c.execute(query)
+                        else:
+                            sql_result = c.execute(query, args)
+                    # Our transaction was successful, leave the loop
+                    break
 
-        except sqlite3.OperationalError, e:
-            if "unable to open database file" in e.message or "database is locked" in e.message:
-                logger.warn('Database Error: %s', e)
-            else:
-                logger.error('Database error: %s', e)
-                raise
+                except sqlite3.OperationalError, e:
+                    if "unable to open database file" in e.message or "database is locked" in e.message:
+                        logger.warn('Database Error: %s', e)
+                        attempts += 1
+                        time.sleep(1)
+                    else:
+                        logger.error('Database error: %s', e)
+                        raise
 
-        except sqlite3.DatabaseError, e:
-            logger.error('Fatal Error executing %s :: %s', query, e)
-            raise
+                except sqlite3.DatabaseError, e:
+                    logger.error('Fatal Error executing %s :: %s', query, e)
+                    raise
 
-        return sql_result
+            return sql_result
 
     def select(self, query, args=None):
 
@@ -95,7 +111,7 @@ class MonitorDatabase(object):
 
     def select_single(self, query, args=None):
 
-        sql_results = self.action(query, args).fetchone()[0]
+        sql_results = self.action(query, args).fetchone()
 
         if sql_results is None or sql_results == "":
             return ""

plexpy/datatables.py

@@ -1,4 +1,4 @@
-# This file is part of PlexPy.
+# 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
@@ -70,6 +70,39 @@ class DataTables(object):
         else:
             grouping = False
 
+        # Build join parameters
+        if join_types:
+            counter = 0
+            for join_type in join_types:
+                if join_type.upper() == 'LEFT OUTER JOIN':
+                    join_item = 'LEFT OUTER JOIN %s ON %s = %s ' % \
+                                (join_tables[counter], join_evals[counter][0], join_evals[counter][1])
+                elif join_type.upper() == 'JOIN' or join_type.upper() == 'INNER JOIN':
+                    join_item = 'JOIN %s ON %s = %s ' % \
+                                (join_tables[counter], join_evals[counter][0], join_evals[counter][1])
+                else:
+                    join_item = ''
+
+                counter += 1
+                join += join_item
+
+        # Build custom where parameters
+        if custom_where:
+            for w in custom_where:
+                c_where += w[0] + ' = ? AND '
+
+                # The order of our args changes if we are grouping
+                #if grouping:
+                #    args.insert(0, w[1])
+                #else:
+                #    args.append(w[1])
+
+                # My testing shows that order of args doesn't change
+                args.append(w[1])
+
+            if c_where:
+                c_where = 'WHERE ' + c_where.rstrip(' AND ')
+
         # Build ordering
         for o in parameters['order']:
             sort_order = ' COLLATE NOCASE'
@@ -119,36 +152,6 @@ class DataTables(object):
             if where:
                 where = 'WHERE ' + where.rstrip(' OR ')
 
-        # Build join parameters
-        if join_types:
-            counter = 0
-            for join_type in join_types:
-                if join_type.upper() == 'LEFT OUTER JOIN':
-                    join_item = 'LEFT OUTER JOIN %s ON %s = %s ' % \
-                                (join_tables[counter], join_evals[counter][0], join_evals[counter][1])
-                elif join_type.upper() == 'JOIN' or join_type.upper() == 'INNER JOIN':
-                    join_item = 'JOIN %s ON %s = %s ' % \
-                                (join_tables[counter], join_evals[counter][0], join_evals[counter][1])
-                else:
-                    join_item = ''
-
-                counter += 1
-                join += join_item
-
-        # Build custom where parameters
-        if custom_where:
-            for w in custom_where:
-                c_where += w[0] + ' = ? AND '
-
-                # The order of our args changes if we are grouping
-                if grouping:
-                    args.insert(0, w[1])
-                else:
-                    args.append(w[1])
-
-            if c_where:
-                c_where = 'WHERE ' + c_where.rstrip(' AND ')
-
         # Build our queries
         if grouping:
             if c_where == '':
@@ -175,12 +178,18 @@ class DataTables(object):
         filtered = self.ssp_db.select(query, args=args)
 
         # Build grand totals
-        totalcount = self.ssp_db.select('SELECT COUNT(id) from %s' % table_name)[0][0]
+        totalcount = self.ssp_db.select('SELECT COUNT(id) as total_count from %s' % table_name)[0]['total_count']
 
         # Get draw counter
         draw_counter = int(parameters['draw'])
 
+        # Paginate results
         result = filtered[parameters['start']:(parameters['start'] + parameters['length'])]
+
+        # Sanitize on the way out
+        result = [{k: helpers.sanitize(v) if isinstance(v, basestring) else v for k, v in row.iteritems()}
+                  for row in result]
+
         output = {'result': result,
                   'draw': draw_counter,
                   'filteredCount': len(filtered),

plexpy/graphs.py

@@ -13,7 +13,7 @@
 #  You should have received a copy of the GNU General Public License
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
-from plexpy import logger, database, helpers
+from plexpy import logger, database, helpers, common
 
 import datetime
 
@@ -44,11 +44,11 @@ class Graphs(object):
             else:
                 query = 'SELECT date(started, "unixepoch", "localtime") as date_played, ' \
                         'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                         'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                         'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count ' \
                         'FROM session_history ' \
                         'WHERE datetime(stopped, "unixepoch", "localtime") >= datetime("now", "-%s days", "localtime") ' \
                         'GROUP BY date_played ' \
@@ -76,10 +76,10 @@ class Graphs(object):
             series_2_value = 0
             series_3_value = 0
             for item in result:
-                if date_string == item[0]:
-                    series_1_value = item[1]
-                    series_2_value = item[2]
-                    series_3_value = item[3]
+                if date_string == item['date_played']:
+                    series_1_value = item['tv_count']
+                    series_2_value = item['movie_count']
+                    series_3_value = item['music_count']
                     break
                 else:
                     series_1_value = 0
@@ -138,11 +138,11 @@ class Graphs(object):
                     'when 5 then "Friday" ' \
                     'else "Saturday" end as dayofweek, ' \
                     'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                     'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count ' \
                     'FROM session_history ' \
                     'WHERE datetime(stopped, "unixepoch", "localtime") >= ' \
                     'datetime("now", "-' + time_range + ' days", "localtime") ' \
@@ -165,10 +165,10 @@ class Graphs(object):
             series_2_value = 0
             series_3_value = 0
             for item in result:
-                if day_item == item[1]:
-                    series_1_value = item[2]
-                    series_2_value = item[3]
-                    series_3_value = item[4]
+                if day_item == item['dayofweek']:
+                    series_1_value = item['tv_count']
+                    series_2_value = item['movie_count']
+                    series_3_value = item['music_count']
                     break
                 else:
                     series_1_value = 0
@@ -211,11 +211,11 @@ class Graphs(object):
         else:
             query = 'select strftime("%H", datetime(started, "unixepoch", "localtime")) as hourofday, ' \
                     'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                     'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count ' \
                     'FROM session_history ' \
                     'WHERE datetime(stopped, "unixepoch", "localtime") >= ' \
                     'datetime("now", "-' + time_range + ' days", "localtime") ' \
@@ -240,10 +240,10 @@ class Graphs(object):
             series_2_value = 0
             series_3_value = 0
             for item in result:
-                if hour_item == item[0]:
-                    series_1_value = item[1]
-                    series_2_value = item[2]
-                    series_3_value = item[3]
+                if hour_item == item['hourofday']:
+                    series_1_value = item['tv_count']
+                    series_2_value = item['movie_count']
+                    series_3_value = item['music_count']
                     break
                 else:
                     series_1_value = 0
@@ -283,11 +283,11 @@ class Graphs(object):
         else:
             query = 'SELECT strftime("%Y-%m", datetime(started, "unixepoch", "localtime")) as datestring, ' \
                     'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                     'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count ' \
                     'FROM session_history ' \
                     'WHERE datetime(started, "unixepoch", "localtime") >= datetime("now", "-12 months", "localtime") ' \
                     'GROUP BY strftime("%Y-%m", datetime(started, "unixepoch", "localtime")) ' \
@@ -316,10 +316,10 @@ class Graphs(object):
             series_2_value = 0
             series_3_value = 0
             for item in result:
-                if date_string == item[0]:
-                    series_1_value = item[1]
-                    series_2_value = item[2]
-                    series_3_value = item[3]
+                if date_string == item['datestring']:
+                    series_1_value = item['tv_count']
+                    series_2_value = item['movie_count']
+                    series_3_value = item['music_count']
                     break
                 else:
                     series_1_value = 0
@@ -364,11 +364,11 @@ class Graphs(object):
         else:
             query = 'SELECT platform, ' \
                     'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                     'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count, ' \
                     'SUM(case when stopped > 0 then (stopped - started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
                     'FROM session_history ' \
@@ -386,17 +386,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
-
-        # Rename Mystery platform names
-        platform_names = [('Mystery 3', 'Playstation 3'),
-                          ('Mystery 4', 'Playstation 4'),
-                          ('Mystery 5', 'Xbox 360')]
-        for old_name, new_name in platform_names:
-            categories = [item.replace(old_name, new_name) for item in categories]
+            categories.append(common.PLATFORM_NAME_OVERRIDES.get(item['platform'], item['platform']))
+            series_1.append(item['tv_count'])
+            series_2.append(item['movie_count'])
+            series_3.append(item['music_count'])
 
         series_1_output = {'name': 'TV',
                            'data': series_1}
@@ -417,7 +410,7 @@ class Graphs(object):
 
         if y_axis == 'plays':
             query = 'SELECT ' \
-                    '(case when users.friendly_name is null then session_history.user else ' \
+                    '(case when users.friendly_name is null then users.username else ' \
                     'users.friendly_name end) as friendly_name,' \
                     'SUM(case when media_type = "episode" then 1 else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" then 1 else 0 end) as movie_count, ' \
@@ -434,14 +427,14 @@ class Graphs(object):
             result = monitor_db.select(query)
         else:
             query = 'SELECT ' \
-                    '(case when users.friendly_name is null then session_history.user else ' \
+                    '(case when users.friendly_name is null then users.username else ' \
                     'users.friendly_name end) as friendly_name,' \
                     'SUM(case when media_type = "episode" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tv_count, ' \
                     'SUM(case when media_type = "movie" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as movie_count, ' \
                     'SUM(case when media_type = "track" and stopped > 0 then (stopped - started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as music_count, ' \
                     'SUM(case when stopped > 0 then (stopped - started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
                     'FROM session_history ' \
@@ -460,10 +453,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
+            categories.append(item['friendly_name'])
+            series_1.append(item['tv_count'])
+            series_2.append(item['movie_count'])
+            series_3.append(item['music_count'])
 
         series_1_output = {'name': 'TV',
                            'data': series_1}
@@ -508,15 +501,15 @@ class Graphs(object):
                         'SUM(case when (session_history_media_info.video_decision = "direct play" ' \
                         'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "direct play")) ' \
                         'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_duration, ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_count, ' \
                         'SUM(case when (session_history_media_info.video_decision = "copy" ' \
                         'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "copy")) ' \
                         'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_duration, ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_count, ' \
                         'SUM(case when (session_history_media_info.video_decision = "transcode" ' \
                         'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "transcode")) ' \
                         'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_duration ' \
+                        ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_count ' \
                         'FROM session_history ' \
                         'JOIN session_history_media_info ON session_history.id = session_history_media_info.id ' \
                         'WHERE datetime(session_history.stopped, "unixepoch", "localtime") >= ' \
@@ -547,10 +540,10 @@ class Graphs(object):
             series_2_value = 0
             series_3_value = 0
             for item in result:
-                if date_string == item[0]:
-                    series_1_value = item[1]
-                    series_2_value = item[2]
-                    series_3_value = item[3]
+                if date_string == item['date_played']:
+                    series_1_value = item['dp_count']
+                    series_2_value = item['ds_count']
+                    series_3_value = item['tc_count']
                     break
                 else:
                     series_1_value = 0
@@ -605,15 +598,15 @@ class Graphs(object):
                     'SUM(case when (session_history_media_info.video_decision = "direct play" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "direct play")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "copy" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "copy")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "transcode" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "transcode")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_count, ' \
                     'SUM(case when stopped > 0 then (stopped - started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
                     'FROM session_history ' \
@@ -633,10 +626,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
+            categories.append(item['resolution'])
+            series_1.append(item['dp_count'])
+            series_2.append(item['ds_count'])
+            series_3.append(item['tc_count'])
 
         series_1_output = {'name': 'Direct Play',
                            'data': series_1}
@@ -702,15 +695,15 @@ class Graphs(object):
                     'SUM(case when (session_history_media_info.video_decision = "direct play" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "direct play")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "copy" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "copy")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "transcode" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "transcode")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_count, ' \
                     'SUM(case when stopped > 0 then (stopped - started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
                     'FROM session_history ' \
@@ -730,10 +723,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
+            categories.append(item['resolution'])
+            series_1.append(item['dp_count'])
+            series_2.append(item['ds_count'])
+            series_3.append(item['tc_count'])
 
         series_1_output = {'name': 'Direct Play',
                            'data': series_1}
@@ -780,15 +773,15 @@ class Graphs(object):
                     'SUM(case when (session_history_media_info.video_decision = "direct play" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "direct play")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "copy" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "copy")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "transcode" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "transcode")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_count, ' \
                     'SUM(case when session_history.stopped > 0 ' \
                     'then (session_history.stopped - session_history.started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
@@ -808,17 +801,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
-
-        # Rename Mystery platform names
-        platform_names = [('Mystery 3', 'Playstation 3'),
-                          ('Mystery 4', 'Playstation 4'),
-                          ('Mystery 5', 'Xbox 360')]
-        for old_name, new_name in platform_names:
-            categories = [item.replace(old_name, new_name) for item in categories]
+            categories.append(common.PLATFORM_NAME_OVERRIDES.get(item['platform'], item['platform']))
+            series_1.append(item['dp_count'])
+            series_2.append(item['ds_count'])
+            series_3.append(item['tc_count'])
 
         series_1_output = {'name': 'Direct Play',
                            'data': series_1}
@@ -867,15 +853,15 @@ class Graphs(object):
                     'SUM(case when (session_history_media_info.video_decision = "direct play" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "direct play")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as dp_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "copy" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "copy")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as ds_count, ' \
                     'SUM(case when (session_history_media_info.video_decision = "transcode" ' \
                     'or (session_history_media_info.video_decision = "" and session_history_media_info.audio_decision = "transcode")) ' \
                     'and session_history.stopped > 0 then (session_history.stopped - session_history.started) ' \
-                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_duration, ' \
+                    ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as tc_count, ' \
                     'SUM(case when session_history.stopped > 0 ' \
                     'then (session_history.stopped - session_history.started) ' \
                     ' - (case when paused_counter is NULL then 0 else paused_counter end) else 0 end) as total_duration ' \
@@ -896,10 +882,10 @@ class Graphs(object):
         series_3 = []
 
         for item in result:
-            categories.append(item[0])
-            series_1.append(item[1])
-            series_2.append(item[2])
-            series_3.append(item[3])
+            categories.append(item['username'])
+            series_1.append(item['dp_count'])
+            series_2.append(item['ds_count'])
+            series_3.append(item['tc_count'])
 
         series_1_output = {'name': 'Direct Play',
                            'data': series_1}

plexpy/helpers.py

@@ -1,4 +1,4 @@
-#  This file is part of PlexPy.
+#  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
@@ -92,13 +92,15 @@ def latinToAscii(unicrap):
     }
 
     r = ''
-    for i in unicrap:
-        if ord(i) in xlate:
-            r += xlate[ord(i)]
-        elif ord(i) >= 0x80:
-            pass
-        else:
-            r += str(i)
+    if unicrap:
+        for i in unicrap:
+            if ord(i) in xlate:
+                r += xlate[ord(i)]
+            elif ord(i) >= 0x80:
+                pass
+            else:
+                r += str(i)
+
     return r
 
 
@@ -144,6 +146,35 @@ def now():
     now = datetime.datetime.now()
     return now.strftime("%Y-%m-%d %H:%M:%S")
 
+def human_duration(s, sig='dhms'):
+
+    hd = ''
+
+    if str(s).isdigit():
+        d = int(s / 84600)
+        h = int((s % 84600) / 3600)
+        m = int(((s % 84600) % 3600) / 60)
+        s = int(((s % 84600) % 3600) % 60)
+
+        hd_list = []
+        if sig >= 'd' and d > 0:
+            d = d + 1 if sig == 'd' and h >= 12 else d
+            hd_list.append(str(d) + ' days')
+
+        if sig >= 'dh' and h > 0:
+            h = h + 1 if sig == 'dh' and m >= 30 else h
+            hd_list.append(str(h) + ' hrs')
+            
+        if sig >= 'dhm' and m > 0:
+            m = m + 1 if sig == 'dhm' and s >= 30 else m
+            hd_list.append(str(m) + ' mins')
+
+        if sig >= 'dhms' and s > 0:
+            hd_list.append(str(s) + ' secs')
+
+        hd = ' '.join(hd_list)
+
+    return hd
 
 def get_age(date):
 
@@ -177,7 +208,7 @@ def piratesize(size):
     split = size.split(" ")
     factor = float(split[0])
     unit = split[1].upper()
-    
+
     if unit == 'MiB':
         size = factor * 1048576
     elif unit == 'MB':
@@ -403,3 +434,9 @@ def process_json_kwargs(json_kwargs):
         params = json.loads(json_kwargs)
 
     return params
+
+def sanitize(string):
+    if string:
+        return unicode(string).replace('<','&lt;').replace('>','&gt;')
+    else:
+        return ''

plexpy/http_handler.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
 # This file is part of PlexPy.
 #
 #  PlexPy is free software: you can redistribute it and/or modify
@@ -14,12 +17,11 @@
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
 from plexpy import logger, helpers
-
 from httplib import HTTPSConnection
 from httplib import HTTPConnection
-
 import ssl
 
+
 class HTTPHandler(object):
     """
     Retrieve data from Plex Server
@@ -81,25 +83,32 @@ class HTTPHandler(object):
                 logger.warn(u"Failed to access uri endpoint %s with error %s" % (uri, e))
                 return None
             except Exception, e:
-                logger.warn(u"Failed to access uri endpoint %s. Is your server maybe accepting SSL connections only?" % uri)
+                logger.warn(u"Failed to access uri endpoint %s. Is your server maybe accepting SSL connections only? %s" % (uri, e))
                 return None
             except:
                 logger.warn(u"Failed to access uri endpoint %s with Uncaught exception." % uri)
+                return None
 
             if request_status == 200:
-                if output_format == 'dict':
-                    output = helpers.convert_xml_to_dict(request_content)
-                elif output_format == 'json':
-                    output = helpers.convert_xml_to_json(request_content)
-                elif output_format == 'xml':
-                    output = helpers.parse_xml(request_content)
-                else:
-                    output = request_content
+                try:
+                    if output_format == 'dict':
+                        output = helpers.convert_xml_to_dict(request_content)
+                    elif output_format == 'json':
+                        output = helpers.convert_xml_to_json(request_content)
+                    elif output_format == 'xml':
+                        output = helpers.parse_xml(request_content)
+                    else:
+                        output = request_content
 
-                if return_type:
-                    return output, content_type
+                    if return_type:
+                        return output, content_type
+
+                    return output
+
+                except Exception as e:
+                    logger.warn(u"Failed format response from uri %s to %s error %s" % (uri, output_format, e))
+                    return None
 
-                return output
             else:
                 logger.warn(u"Failed to access uri endpoint %s. Status code %r" % (uri, request_status))
                 return None

plexpy/monitor.py

@@ -1,408 +0,0 @@
-# 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 <http://www.gnu.org/licenses/>.
-
-from plexpy import logger, pmsconnect, notification_handler, log_reader, common, database, helpers
-
-import threading
-import plexpy
-import re
-import time
-
-monitor_lock = threading.Lock()
-
-def check_active_sessions():
-
-    with monitor_lock:
-        pms_connect = pmsconnect.PmsConnect()
-        session_list = pms_connect.get_current_activity()
-        monitor_db = database.MonitorDatabase()
-        monitor_process = MonitorProcessing()
-        # logger.debug(u"PlexPy Monitor :: Checking for active streams.")
-
-        if session_list:
-            media_container = session_list['sessions']
-
-            # Check our temp table for what we must do with the new streams
-            db_streams = monitor_db.select('SELECT started, session_key, rating_key, media_type, title, parent_title, '
-                                           'grandparent_title, user_id, user, friendly_name, ip_address, player, '
-                                           'platform, machine_id, parent_rating_key, grandparent_rating_key, state, '
-                                           'view_offset, duration, video_decision, audio_decision, width, height, '
-                                           'container, video_codec, audio_codec, bitrate, video_resolution, '
-                                           'video_framerate, aspect_ratio, audio_channels, transcode_protocol, '
-                                           'transcode_container, transcode_video_codec, transcode_audio_codec, '
-                                           'transcode_audio_channels, transcode_width, transcode_height, paused_counter '
-                                           'FROM sessions')
-            for stream in db_streams:
-                if any(d['session_key'] == str(stream['session_key']) and d['rating_key'] == str(stream['rating_key'])
-                       for d in media_container):
-                    # The user's session is still active
-                    for session in media_container:
-                        if session['session_key'] == str(stream['session_key']) and \
-                                session['rating_key'] == str(stream['rating_key']):
-                            # The user is still playing the same media item
-                            # Here we can check the play states
-                            if session['state'] != stream['state']:
-                                if session['state'] == 'paused':
-                                    # Push any notifications -
-                                    # Push it on it's own thread so we don't hold up our db actions
-                                    threading.Thread(target=notification_handler.notify,
-                                                     kwargs=dict(stream_data=stream, notify_action='pause')).start()
-                                if session['state'] == 'playing' and stream['state'] == 'paused':
-                                    # Push any notifications -
-                                    # Push it on it's own thread so we don't hold up our db actions
-                                    threading.Thread(target=notification_handler.notify,
-                                                     kwargs=dict(stream_data=stream, notify_action='resume')).start()
-                            if stream['state'] == 'paused':
-                                # The stream is still paused so we need to increment the paused_counter
-                                # Using the set config parameter as the interval, probably not the most accurate but
-                                # it will have to do for now.
-                                paused_counter = int(stream['paused_counter']) + plexpy.CONFIG.MONITORING_INTERVAL
-                                monitor_db.action('UPDATE sessions SET paused_counter = ? '
-                                                  'WHERE session_key = ? AND rating_key = ?',
-                                                  [paused_counter, stream['session_key'], stream['rating_key']])
-                            if session['state'] == 'buffering' and plexpy.CONFIG.BUFFER_THRESHOLD > 0:
-                                # The stream is buffering so we need to increment the buffer_count
-                                # We're going just increment on every monitor ping,
-                                # would be difficult to keep track otherwise
-                                monitor_db.action('UPDATE sessions SET buffer_count = buffer_count + 1 '
-                                                  'WHERE session_key = ? AND rating_key = ?',
-                                                  [stream['session_key'], stream['rating_key']])
-
-                                # Check the current buffer count and last buffer to determine if we should notify
-                                buffer_values = monitor_db.select('SELECT buffer_count, buffer_last_triggered '
-                                                                  'FROM sessions '
-                                                                  'WHERE session_key = ? AND rating_key = ?',
-                                                                  [stream['session_key'], stream['rating_key']])
-
-                                if buffer_values[0]['buffer_count'] >= plexpy.CONFIG.BUFFER_THRESHOLD:
-                                    # Push any notifications -
-                                    # Push it on it's own thread so we don't hold up our db actions
-                                    # Our first buffer notification
-                                    if buffer_values[0]['buffer_count'] == plexpy.CONFIG.BUFFER_THRESHOLD:
-                                        logger.info(u"PlexPy Monitor :: User '%s' has triggered a buffer warning."
-                                                    % stream['user'])
-                                        # Set the buffer trigger time
-                                        monitor_db.action('UPDATE sessions '
-                                                          'SET buffer_last_triggered = strftime("%s","now") '
-                                                          'WHERE session_key = ? AND rating_key = ?',
-                                                          [stream['session_key'], stream['rating_key']])
-
-                                        threading.Thread(target=notification_handler.notify,
-                                                         kwargs=dict(stream_data=stream, notify_action='buffer')).start()
-                                    else:
-                                        # Subsequent buffer notifications after wait time
-                                        if int(time.time()) > buffer_values[0]['buffer_last_triggered'] + \
-                                                plexpy.CONFIG.BUFFER_WAIT:
-                                            logger.info(u"PlexPy Monitor :: User '%s' has triggered multiple buffer warnings."
-                                                    % stream['user'])
-                                            # Set the buffer trigger time
-                                            monitor_db.action('UPDATE sessions '
-                                                              'SET buffer_last_triggered = strftime("%s","now") '
-                                                              'WHERE session_key = ? AND rating_key = ?',
-                                                              [stream['session_key'], stream['rating_key']])
-
-                                            threading.Thread(target=notification_handler.notify,
-                                                             kwargs=dict(stream_data=stream, notify_action='buffer')).start()
-
-                                logger.debug(u"PlexPy Monitor :: Stream buffering. Count is now %s. Last triggered %s."
-                                             % (buffer_values[0][0], buffer_values[0][1]))
-
-                            # Check if the user has reached the offset in the media we defined as the "watched" percent
-                            # Don't trigger if state is buffer as some clients push the progress to the end when
-                            # buffering on start.
-                            if session['progress'] and session['duration'] and session['state'] != 'buffering':
-                                if helpers.get_percent(session['progress'],
-                                                       session['duration']) > plexpy.CONFIG.NOTIFY_WATCHED_PERCENT:
-                                    # Push any notifications -
-                                    # Push it on it's own thread so we don't hold up our db actions
-                                    threading.Thread(target=notification_handler.notify,
-                                                     kwargs=dict(stream_data=stream, notify_action='watched')).start()
-
-                else:
-                    # The user has stopped playing a stream
-                    logger.debug(u"PlexPy Monitor :: Removing sessionKey %s ratingKey %s from session queue"
-                                 % (stream['session_key'], stream['rating_key']))
-                    monitor_db.action('DELETE FROM sessions WHERE session_key = ? AND rating_key = ?',
-                                      [stream['session_key'], stream['rating_key']])
-
-                    # Check if the user has reached the offset in the media we defined as the "watched" percent
-                    if stream['view_offset'] and stream['duration']:
-                        if helpers.get_percent(stream['view_offset'],
-                                               stream['duration']) > plexpy.CONFIG.NOTIFY_WATCHED_PERCENT:
-                            # Push any notifications -
-                            # Push it on it's own thread so we don't hold up our db actions
-                            threading.Thread(target=notification_handler.notify,
-                                             kwargs=dict(stream_data=stream, notify_action='watched')).start()
-
-                    # Push any notifications - Push it on it's own thread so we don't hold up our db actions
-                    threading.Thread(target=notification_handler.notify,
-                                     kwargs=dict(stream_data=stream, notify_action='stop')).start()
-
-                    # Write the item history on playback stop
-                    monitor_process.write_session_history(session=stream)
-
-            # Process the newly received session data
-            for session in media_container:
-                monitor_process.write_session(session)
-        else:
-            logger.debug(u"PlexPy Monitor :: Unable to read session list.")
-
-
-class MonitorProcessing(object):
-
-    def __init__(self):
-        self.db = database.MonitorDatabase()
-
-    def write_session(self, session=None):
-
-        values = {'session_key': session['session_key'],
-                  'rating_key': session['rating_key'],
-                  'media_type': session['type'],
-                  'state': session['state'],
-                  'user_id': session['user_id'],
-                  'user': session['user'],
-                  'machine_id': session['machine_id'],
-                  'title': session['title'],
-                  'parent_title': session['parent_title'],
-                  'grandparent_title': session['grandparent_title'],
-                  'friendly_name': session['friendly_name'],
-                  'player': session['player'],
-                  'platform': session['platform'],
-                  'parent_rating_key': session['parent_rating_key'],
-                  'grandparent_rating_key': session['grandparent_rating_key'],
-                  'view_offset': session['progress'],
-                  'duration': session['duration'],
-                  'video_decision': session['video_decision'],
-                  'audio_decision': session['audio_decision'],
-                  'width': session['width'],
-                  'height': session['height'],
-                  'container': session['container'],
-                  'video_codec': session['video_codec'],
-                  'audio_codec': session['audio_codec'],
-                  'bitrate': session['bitrate'],
-                  'video_resolution': session['video_resolution'],
-                  'video_framerate': session['video_framerate'],
-                  'aspect_ratio': session['aspect_ratio'],
-                  'audio_channels': session['audio_channels'],
-                  'transcode_protocol': session['transcode_protocol'],
-                  'transcode_container': session['transcode_container'],
-                  'transcode_video_codec': session['transcode_video_codec'],
-                  'transcode_audio_codec': session['transcode_audio_codec'],
-                  'transcode_audio_channels': session['transcode_audio_channels'],
-                  'transcode_width': session['transcode_width'],
-                  'transcode_height': session['transcode_height']
-                  }
-
-        keys = {'session_key': session['session_key'],
-                'rating_key': session['rating_key']}
-
-        result = self.db.upsert('sessions', values, keys)
-
-        if result == 'insert':
-            # Push any notifications - Push it on it's own thread so we don't hold up our db actions
-            threading.Thread(target=notification_handler.notify,
-                             kwargs=dict(stream_data=values,notify_action='play')).start()
-
-            started = int(time.time())
-
-            # Try and grab IP address from logs
-            if plexpy.CONFIG.IP_LOGGING_ENABLE and plexpy.CONFIG.PMS_LOGS_FOLDER:
-                ip_address = self.find_session_ip(rating_key=session['rating_key'],
-                                                  machine_id=session['machine_id'])
-            else:
-                ip_address = None
-
-            timestamp = {'started': started,
-                         'ip_address': ip_address}
-
-            # If it's our first write then time stamp it.
-            self.db.upsert('sessions', timestamp, keys)
-
-    def write_session_history(self, session=None, import_metadata=None, is_import=False, import_ignore_interval=0):
-        from plexpy import users
-
-        user_data = users.Users()
-        user_details = user_data.get_user_friendly_name(user=session['user'])
-
-        if session:
-            logging_enabled = False
-
-            if is_import:
-                if str(session['stopped']).isdigit():
-                    stopped = session['stopped']
-                else:
-                    stopped = int(time.time())
-            else:
-                stopped = int(time.time())
-
-            if plexpy.CONFIG.VIDEO_LOGGING_ENABLE and str(session['rating_key']).isdigit() and \
-                    (session['media_type'] == 'movie' or session['media_type'] == 'episode'):
-                logging_enabled = True
-            elif plexpy.CONFIG.MUSIC_LOGGING_ENABLE and str(session['rating_key']).isdigit() and \
-                    session['media_type'] == 'track':
-                logging_enabled = True
-            else:
-                logger.debug(u"PlexPy Monitor :: ratingKey %s not logged. Does not meet logging criteria. "
-                             u"Media type is '%s'" % (session['rating_key'], session['media_type']))
-
-            if plexpy.CONFIG.LOGGING_IGNORE_INTERVAL and not is_import:
-                if (session['media_type'] == 'movie' or session['media_type'] == 'episode') and \
-                        (int(stopped) - session['started'] < int(plexpy.CONFIG.LOGGING_IGNORE_INTERVAL)):
-                    logging_enabled = False
-                    logger.debug(u"PlexPy Monitor :: Play duration for ratingKey %s is %s secs which is less than %s "
-                                 u"seconds, so we're not logging it." %
-                                 (session['rating_key'], str(int(stopped) - session['started']),
-                                  plexpy.CONFIG.LOGGING_IGNORE_INTERVAL))
-            elif is_import and import_ignore_interval:
-                if (session['media_type'] == 'movie' or session['media_type'] == 'episode') and \
-                        (int(stopped) - session['started'] < int(import_ignore_interval)):
-                    logging_enabled = False
-                    logger.debug(u"PlexPy Monitor :: Play duration for ratingKey %s is %s secs which is less than %s "
-                                 u"seconds, so we're not logging it." %
-                                 (session['rating_key'], str(int(stopped) - session['started']),
-                                  import_ignore_interval))
-
-            if not user_details['keep_history'] and not is_import:
-                logging_enabled = False
-                logger.debug(u"PlexPy Monitor :: History logging for user '%s' is disabled." % session['user'])
-
-            if logging_enabled:
-                # logger.debug(u"PlexPy Monitor :: Attempting to write to session_history table...")
-                query = 'INSERT INTO session_history (started, stopped, rating_key, parent_rating_key, ' \
-                        'grandparent_rating_key, media_type, user_id, user, ip_address, paused_counter, player, ' \
-                        'platform, machine_id, view_offset) VALUES ' \
-                        '(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
-
-                args = [session['started'], stopped, session['rating_key'], session['parent_rating_key'],
-                        session['grandparent_rating_key'], session['media_type'], session['user_id'], session['user'],
-                        session['ip_address'], session['paused_counter'], session['player'], session['platform'],
-                        session['machine_id'], session['view_offset']]
-
-                # logger.debug(u"PlexPy Monitor :: Writing session_history transaction...")
-                self.db.action(query=query, args=args)
-
-                # logger.debug(u"PlexPy Monitor :: Successfully written history item, last id for session_history is %s"
-                #              % last_id)
-
-                # Write the session_history_media_info table
-                # logger.debug(u"PlexPy Monitor :: Attempting to write to session_history_media_info table...")
-                query = 'INSERT INTO session_history_media_info (id, rating_key, video_decision, audio_decision, ' \
-                        'duration, width, height, container, video_codec, audio_codec, bitrate, video_resolution, ' \
-                        'video_framerate, aspect_ratio, audio_channels, transcode_protocol, transcode_container, ' \
-                        'transcode_video_codec, transcode_audio_codec, transcode_audio_channels, transcode_width, ' \
-                        'transcode_height) VALUES ' \
-                        '(last_insert_rowid(), ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
-
-                args = [session['rating_key'], session['video_decision'], session['audio_decision'],
-                        session['duration'], session['width'], session['height'], session['container'],
-                        session['video_codec'], session['audio_codec'], session['bitrate'],
-                        session['video_resolution'], session['video_framerate'], session['aspect_ratio'],
-                        session['audio_channels'], session['transcode_protocol'], session['transcode_container'],
-                        session['transcode_video_codec'], session['transcode_audio_codec'],
-                        session['transcode_audio_channels'], session['transcode_width'], session['transcode_height']]
-
-                # logger.debug(u"PlexPy Monitor :: Writing session_history_media_info transaction...")
-                self.db.action(query=query, args=args)
-
-                if not is_import:
-                    logger.debug(u"PlexPy Monitor :: Fetching metadata for item ratingKey %s" % session['rating_key'])
-                    pms_connect = pmsconnect.PmsConnect()
-                    result = pms_connect.get_metadata_details(rating_key=str(session['rating_key']))
-                    metadata = result['metadata']
-                else:
-                    metadata = import_metadata
-
-                # Write the session_history_metadata table
-                directors = ";".join(metadata['directors'])
-                writers = ";".join(metadata['writers'])
-                actors = ";".join(metadata['actors'])
-                genres = ";".join(metadata['genres'])
-
-                # Build media item title
-                if session['media_type'] == 'episode' or session['media_type'] == 'track':
-                    full_title = '%s - %s' % (metadata['grandparent_title'], metadata['title'])
-                elif session['media_type'] == 'movie':
-                    full_title = metadata['title']
-                else:
-                    full_title = metadata['title']
-
-                # logger.debug(u"PlexPy Monitor :: Attempting to write to session_history_metadata table...")
-                query = 'INSERT INTO session_history_metadata (id, rating_key, parent_rating_key, ' \
-                        'grandparent_rating_key, title, parent_title, grandparent_title, full_title, media_index, ' \
-                        'parent_media_index, thumb, parent_thumb, grandparent_thumb, art, media_type, year, ' \
-                        'originally_available_at, added_at, updated_at, last_viewed_at, content_rating, summary, ' \
-                        'tagline, rating, duration, guid, directors, writers, actors, genres, studio) VALUES ' \
-                        '(last_insert_rowid(), ' \
-                        '?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)'
-
-                args = [session['rating_key'], session['parent_rating_key'], session['grandparent_rating_key'],
-                        session['title'], session['parent_title'], session['grandparent_title'], full_title,
-                        metadata['index'], metadata['parent_index'], metadata['thumb'], metadata['parent_thumb'],
-                        metadata['grandparent_thumb'], metadata['art'], session['media_type'], metadata['year'],
-                        metadata['originally_available_at'], metadata['added_at'], metadata['updated_at'],
-                        metadata['last_viewed_at'], metadata['content_rating'], metadata['summary'], metadata['tagline'], 
-                        metadata['rating'], metadata['duration'], metadata['guid'], directors, writers, actors, genres, metadata['studio']]
-
-                # logger.debug(u"PlexPy Monitor :: Writing session_history_metadata transaction...")
-                self.db.action(query=query, args=args)
-
-    def find_session_ip(self, rating_key=None, machine_id=None):
-
-        logger.debug(u"PlexPy Monitor :: Requesting log lines...")
-        log_lines = log_reader.get_log_tail(window=5000, parsed=False)
-
-        rating_key_line = 'ratingKey=' + rating_key
-        rating_key_line_2 = 'metadata%2F' + rating_key
-        machine_id_line = 'session=' + machine_id
-
-        for line in reversed(log_lines):
-            # We're good if we find a line with both machine id and rating key
-            # This is usually when there is a transcode session
-            if machine_id_line in line and (rating_key_line in line or rating_key_line_2 in line):
-                # Currently only checking for ipv4 addresses
-                ipv4 = re.findall(r'[0-9]+(?:\.[0-9]+){3}', line)
-                if ipv4:
-                    # The logged IP will always be the first match and we don't want localhost entries
-                    if ipv4[0] != '127.0.0.1':
-                        logger.debug(u"PlexPy Monitor :: Matched IP address (%s) for stream ratingKey %s "
-                                     u"and machineIdentifier %s."
-                                     % (ipv4[0], rating_key, machine_id))
-                        return ipv4[0]
-
-        logger.debug(u"PlexPy Monitor :: Unable to find IP address on first pass. "
-                     u"Attempting fallback check in 5 seconds...")
-
-        # Wait for the log to catch up and read in new lines
-        time.sleep(5)
-
-        logger.debug(u"PlexPy Monitor :: Requesting log lines...")
-        log_lines = log_reader.get_log_tail(window=5000, parsed=False)
-
-        for line in reversed(log_lines):
-            if 'GET /:/timeline' in line and (rating_key_line in line or rating_key_line_2 in line):
-                # Currently only checking for ipv4 addresses
-                # This method can return the wrong IP address if more than one user
-                # starts watching the same media item around the same time.
-                ipv4 = re.findall(r'[0-9]+(?:\.[0-9]+){3}', line)
-                if ipv4:
-                    # The logged IP will always be the first match and we don't want localhost entries
-                    if ipv4[0] != '127.0.0.1':
-                        logger.debug(u"PlexPy Monitor :: Matched IP address (%s) for stream ratingKey %s." %
-                                     (ipv4[0], rating_key))
-                        return ipv4[0]
-
-        logger.debug(u"PlexPy Monitor :: Unable to find IP address on fallback search. Not logging IP address.")
-
-        return None

plexpy/notification_handler.py

@@ -13,7 +13,7 @@
 #  You should have received a copy of the GNU General Public License
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
-from plexpy import logger, config, notifiers, database
+from plexpy import logger, config, notifiers, database, helpers, plextv, pmsconnect
 
 import plexpy
 import time
@@ -30,139 +30,191 @@ def notify(stream_data=None, notify_action=None):
         if not user_details['do_notify']:
             return
 
-        if stream_data['media_type'] == 'movie' or stream_data['media_type'] == 'episode':
-            if plexpy.CONFIG.MOVIE_NOTIFY_ENABLE or plexpy.CONFIG.TV_NOTIFY_ENABLE:
+        if (stream_data['media_type'] == 'movie' and plexpy.CONFIG.MOVIE_NOTIFY_ENABLE) \
+            or (stream_data['media_type'] == 'episode' and plexpy.CONFIG.TV_NOTIFY_ENABLE):
 
-                for agent in notifiers.available_notification_agents():
-                    if agent['on_play'] and notify_action == 'play':
+            progress_percent = helpers.get_percent(stream_data['view_offset'], stream_data['duration'])
+
+            for agent in notifiers.available_notification_agents():
+                if agent['on_play'] and notify_action == 'play':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
+
+                elif agent['on_stop'] and notify_action == 'stop' \
+                    and (plexpy.CONFIG.NOTIFY_CONSECUTIVE or progress_percent < plexpy.CONFIG.NOTIFY_WATCHED_PERCENT):
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
+
+                elif agent['on_pause'] and notify_action == 'pause' \
+                    and (plexpy.CONFIG.NOTIFY_CONSECUTIVE or progress_percent < 99):
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
+
+                elif agent['on_resume'] and notify_action == 'resume' \
+                    and (plexpy.CONFIG.NOTIFY_CONSECUTIVE or progress_percent < 99):
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
+
+                elif agent['on_buffer'] and notify_action == 'buffer':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
+
+                elif agent['on_watched'] and notify_action == 'watched':
+                    # Get the current states for notifications from our db
+                    notify_states = get_notify_state(session=stream_data)
+
+                    # If there is nothing in the notify_log for our agent id but it is enabled we should notify
+                    if not any(d['agent_id'] == agent['id'] for d in notify_states):
                         # Build and send notification
                         notify_strings = build_notify_text(session=stream_data, state=notify_action)
                         notifiers.send_notification(config_id=agent['id'],
                                                     subject=notify_strings[0],
                                                     body=notify_strings[1])
                         # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='play', agent_info=agent)
+                        set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                    elif agent['on_stop'] and notify_action == 'stop':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
+                    else:
+                        # Check in our notify log if the notification has already been sent
+                        for notify_state in notify_states:
+                            if not notify_state['on_watched'] and (notify_state['agent_id'] == agent['id']):
+                                # Build and send notification
+                                notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                                notifiers.send_notification(config_id=agent['id'],
+                                                            subject=notify_strings[0],
+                                                            body=notify_strings[1])
+                                # Set the notification state in the db
+                                set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                        set_notify_state(session=stream_data, state='stop', agent_info=agent)
+        elif (stream_data['media_type'] == 'track' and plexpy.CONFIG.MUSIC_NOTIFY_ENABLE):
 
-                    elif agent['on_pause'] and notify_action == 'pause':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
+            for agent in notifiers.available_notification_agents():
+                if agent['on_play'] and notify_action == 'play':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                        set_notify_state(session=stream_data, state='pause', agent_info=agent)
+                elif agent['on_stop'] and notify_action == 'stop':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                    elif agent['on_resume'] and notify_action == 'resume':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
+                elif agent['on_pause'] and notify_action == 'pause':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                        set_notify_state(session=stream_data, state='resume', agent_info=agent)
+                elif agent['on_resume'] and notify_action == 'resume':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
-                    elif agent['on_buffer'] and notify_action == 'buffer':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-
-                        set_notify_state(session=stream_data, state='buffer', agent_info=agent)
-
-                    elif agent['on_watched'] and notify_action == 'watched':
-                        # Get the current states for notifications from our db
-                        notify_states = get_notify_state(session=stream_data)
-
-                        # If there is nothing in the notify_log for our agent id but it is enabled we should notify
-                        if not any(d['agent_id'] == agent['id'] for d in notify_states):
-                            # Build and send notification
-                            notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                            notifiers.send_notification(config_id=agent['id'],
-                                                        subject=notify_strings[0],
-                                                        body=notify_strings[1])
-                            # Set the notification state in the db
-                            set_notify_state(session=stream_data, state='watched', agent_info=agent)
-
-                        else:
-                            # Check in our notify log if the notification has already been sent
-                            for notify_state in notify_states:
-                                if not notify_state['on_watched'] and (notify_state['agent_id'] == agent['id']):
-                                    # Build and send notification
-                                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                                    notifiers.send_notification(config_id=agent['id'],
-                                                                subject=notify_strings[0],
-                                                                body=notify_strings[1])
-                                    # Set the notification state in the db
-                                    set_notify_state(session=stream_data, state='watched', agent_info=agent)
-
-        elif stream_data['media_type'] == 'track':
-            if plexpy.CONFIG.MUSIC_NOTIFY_ENABLE:
-
-                for agent in notifiers.available_notification_agents():
-                    if agent['on_play'] and notify_action == 'play':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-                        # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='play', agent_info=agent)
-
-                    elif agent['on_stop'] and notify_action == 'stop':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-                        # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='stop', agent_info=agent)
-
-                    elif agent['on_pause'] and notify_action == 'pause':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-                        # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='pause', agent_info=agent)
-
-                    elif agent['on_resume'] and notify_action == 'resume':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-                        # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='resume', agent_info=agent)
-
-                    elif agent['on_buffer'] and notify_action == 'buffer':
-                        # Build and send notification
-                        notify_strings = build_notify_text(session=stream_data, state=notify_action)
-                        notifiers.send_notification(config_id=agent['id'],
-                                                    subject=notify_strings[0],
-                                                    body=notify_strings[1])
-                        # Set the notification state in the db
-                        set_notify_state(session=stream_data, state='buffer', agent_info=agent)
+                elif agent['on_buffer'] and notify_action == 'buffer':
+                    # Build and send notification
+                    notify_strings = build_notify_text(session=stream_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=stream_data, state=notify_action, agent_info=agent)
 
         elif stream_data['media_type'] == 'clip':
             pass
         else:
-            logger.debug(u"PlexPy Notifier :: Notify called with unsupported media type.")
+            #logger.debug(u"PlexPy Notifier :: Notify called with unsupported media type.")
             pass
     else:
         logger.debug(u"PlexPy Notifier :: Notify called but incomplete data received.")
 
 
+def notify_timeline(timeline_data=None, notify_action=None):
+    if timeline_data and notify_action:
+        if (timeline_data['media_type'] == 'movie' and plexpy.CONFIG.MOVIE_NOTIFY_ENABLE) \
+            or ((timeline_data['media_type'] == 'show' or timeline_data['media_type'] == 'episode') \
+                and plexpy.CONFIG.TV_NOTIFY_ENABLE) \
+            or ((timeline_data['media_type'] == 'artist' or timeline_data['media_type'] == 'track') \
+                and plexpy.CONFIG.MUSIC_NOTIFY_ENABLE):
+
+            for agent in notifiers.available_notification_agents():
+                if agent['on_created'] and notify_action == 'created':
+                    # Build and send notification
+                    notify_strings = build_notify_text(timeline=timeline_data, state=notify_action)
+                    notifiers.send_notification(config_id=agent['id'],
+                                                subject=notify_strings[0],
+                                                body=notify_strings[1])
+                    # Set the notification state in the db
+                    set_notify_state(session=timeline_data, state=notify_action, agent_info=agent)
+
+    elif not timeline_data and notify_action:
+        for agent in notifiers.available_notification_agents():
+            if agent['on_extdown'] and notify_action == 'extdown':
+                # Build and send notification
+                notify_strings = build_server_notify_text(state=notify_action)
+                notifiers.send_notification(config_id=agent['id'],
+                                            subject=notify_strings[0],
+                                            body=notify_strings[1])
+            if agent['on_intdown'] and notify_action == 'intdown':
+                # Build and send notification
+                notify_strings = build_server_notify_text(state=notify_action)
+                notifiers.send_notification(config_id=agent['id'],
+                                            subject=notify_strings[0],
+                                            body=notify_strings[1])
+            if agent['on_extup'] and notify_action == 'extup':
+                # Build and send notification
+                notify_strings = build_server_notify_text(state=notify_action)
+                notifiers.send_notification(config_id=agent['id'],
+                                            subject=notify_strings[0],
+                                            body=notify_strings[1])
+            if agent['on_intup'] and notify_action == 'intup':
+                # Build and send notification
+                notify_strings = build_server_notify_text(state=notify_action)
+                notifiers.send_notification(config_id=agent['id'],
+                                            subject=notify_strings[0],
+                                            body=notify_strings[1])
+    else:
+        logger.debug(u"PlexPy Notifier :: Notify timeline called but incomplete data received.")
+
+
 def get_notify_state(session):
     monitor_db = database.MonitorDatabase()
     result = monitor_db.select('SELECT on_play, on_stop, on_pause, on_resume, on_buffer, on_watched, agent_id '
@@ -174,13 +226,28 @@ def get_notify_state(session):
                                args=[session['session_key'], session['rating_key'], session['user']])
     notify_states = []
     for item in result:
-        notify_state = {'on_play': item[0],
-                        'on_stop': item[1],
-                        'on_pause': item[2],
-                        'on_resume': item[3],
-                        'on_buffer': item[4],
-                        'on_watched': item[5],
-                        'agent_id': item[6]}
+        notify_state = {'on_play': item['on_play'],
+                        'on_stop': item['on_stop'],
+                        'on_pause': item['on_pause'],
+                        'on_resume': item['on_resume'],
+                        'on_buffer': item['on_buffer'],
+                        'on_watched': item['on_watched'],
+                        'agent_id': item['agent_id']}
+        notify_states.append(notify_state)
+
+    return notify_states
+
+def get_notify_state_timeline(timeline):
+    monitor_db = database.MonitorDatabase()
+    result = monitor_db.select('SELECT on_created, agent_id '
+                               'FROM notify_log '
+                               'WHERE rating_key = ? '
+                               'ORDER BY id DESC',
+                               args=[timeline['rating_key']])
+    notify_states = []
+    for item in result:
+        notify_state = {'on_created': item['on_created'],
+                        'agent_id': item['agent_id']}
         notify_states.append(notify_state)
 
     return notify_states
@@ -203,53 +270,77 @@ def set_notify_state(session, state, agent_info):
             values = {'on_buffer': int(time.time())}
         elif state == 'watched':
             values = {'on_watched': int(time.time())}
+        elif state == 'created':
+            values = {'on_created': int(time.time())}
         else:
             return
 
-        keys = {'session_key': session['session_key'],
-                'rating_key': session['rating_key'],
-                'user_id': session['user_id'],
-                'user': session['user'],
-                'agent_id': agent_info['id'],
-                'agent_name': agent_info['name']}
+        if state == 'created':
+            keys = {'rating_key': session['rating_key'],
+                    'agent_id': agent_info['id'],
+                    'agent_name': agent_info['name']}
+        else:
+            keys = {'session_key': session['session_key'],
+                    'rating_key': session['rating_key'],
+                    'user_id': session['user_id'],
+                    'user': session['user'],
+                    'agent_id': agent_info['id'],
+                    'agent_name': agent_info['name']}
 
         monitor_db.upsert(table_name='notify_log', key_dict=keys, value_dict=values)
     else:
         logger.error('PlexPy Notifier :: Unable to set notify state.')
 
 
-def build_notify_text(session, state):
-    from plexpy import pmsconnect, helpers
+def build_notify_text(session=None, timeline=None, state=None):
     import re
 
     # Get the server name
-    pms_connect = pmsconnect.PmsConnect()
-    server_name = pms_connect.get_server_pref(pref='FriendlyName')
+    server_name = plexpy.CONFIG.PMS_NAME
+
+    # Get the server uptime
+    plex_tv = plextv.PlexTV()
+    server_times = plex_tv.get_server_times()
+
+    if server_times:
+        updated_at = server_times[0]['updated_at']
+        server_uptime = helpers.human_duration(int(time.time() - helpers.cast_to_float(updated_at)))
+    else:
+        logger.error(u"PlexPy Notifier :: Unable to retrieve server uptime.")
+        server_uptime = 'N/A'
 
     # Get metadata feed for item
-    metadata = pms_connect.get_metadata_details(rating_key=session['rating_key'])
+    if session:
+        rating_key = session['rating_key']
+    elif timeline:
+        rating_key = timeline['rating_key']
 
-    if metadata:
-        item_metadata = metadata['metadata']
+    pms_connect = pmsconnect.PmsConnect()
+    metadata_list = pms_connect.get_metadata_details(rating_key=rating_key)
+
+    if metadata_list:
+        metadata = metadata_list['metadata']
     else:
-        logger.error(u"PlexPy Notifier :: Unable to retrieve metadata for rating_key %s" % str(session['rating_key']))
+        logger.error(u"PlexPy Notifier :: Unable to retrieve metadata for rating_key %s" % str(rating_key))
         return []
 
     # Check for exclusion tags
-    if session['media_type'] == 'episode':
+    if metadata['media_type'] == 'movie':
         # Regex pattern to remove the text in the tags we don't want
-        pattern = re.compile('<movie>[^>]+.</movie>|<music>[^>]+.</music>', re.IGNORECASE)
-    elif session['media_type'] == 'movie':
+        pattern = re.compile('\n*<tv>[^>]+.</tv>\n*|\n*<music>[^>]+.</music>\n*', re.IGNORECASE|re.DOTALL)
+    elif metadata['media_type'] == 'show' or metadata['media_type'] == 'episode':
         # Regex pattern to remove the text in the tags we don't want
-        pattern = re.compile('<tv>[^>]+.</tv>|<music>[^>]+.</music>', re.IGNORECASE)
-    elif session['media_type'] == 'track':
+        pattern = re.compile('\n*<movie>[^>]+.</movie>\n*|\n*?<music>[^>]+.</music>\n*', re.IGNORECASE|re.DOTALL)
+    elif metadata['media_type'] == 'artist' or metadata['media_type'] == 'track':
         # Regex pattern to remove the text in the tags we don't want
-        pattern = re.compile('<tv>[^>]+.</tv>|<movie>[^>]+.</movie>', re.IGNORECASE)
+        pattern = re.compile('\n*<tv>[^>]+.</tv>\n*|\n*<movie>[^>]+.</movie>\n*', re.IGNORECASE|re.DOTALL)
     else:
         pattern = None
 
-    if session['media_type'] == 'episode' or session['media_type'] == 'movie' or session['media_type'] == 'track' \
-            and pattern:
+    if metadata['media_type'] == 'movie' \
+        or metadata['media_type'] == 'show' or metadata['media_type'] == 'episode' \
+        or metadata['media_type'] == 'artist' or metadata['media_type'] == 'track' \
+        and pattern:
         # Remove the unwanted tags and strip any unmatch tags too.
         on_start_subject = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_START_SUBJECT_TEXT))
         on_start_body = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_START_BODY_TEXT))
@@ -263,6 +354,8 @@ def build_notify_text(session, state):
         on_buffer_body = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_BUFFER_BODY_TEXT))
         on_watched_subject = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_WATCHED_SUBJECT_TEXT))
         on_watched_body = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_WATCHED_BODY_TEXT))
+        on_created_subject = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_CREATED_SUBJECT_TEXT))
+        on_created_body = strip_tag(re.sub(pattern, '', plexpy.CONFIG.NOTIFY_ON_CREATED_BODY_TEXT))
     else:
         on_start_subject = plexpy.CONFIG.NOTIFY_ON_START_SUBJECT_TEXT
         on_start_body = plexpy.CONFIG.NOTIFY_ON_START_BODY_TEXT
@@ -276,66 +369,154 @@ def build_notify_text(session, state):
         on_buffer_body = plexpy.CONFIG.NOTIFY_ON_BUFFER_BODY_TEXT
         on_watched_subject = plexpy.CONFIG.NOTIFY_ON_WATCHED_SUBJECT_TEXT
         on_watched_body = plexpy.CONFIG.NOTIFY_ON_WATCHED_BODY_TEXT
+        on_created_subject = plexpy.CONFIG.NOTIFY_ON_CREATED_SUBJECT_TEXT
+        on_created_body = plexpy.CONFIG.NOTIFY_ON_CREATED_BODY_TEXT
 
     # Create a title
-    if session['media_type'] == 'episode':
-        full_title = '%s - %s' % (session['grandparent_title'],
-                                  session['title'])
-    elif session['media_type'] == 'track':
-        full_title = '%s - %s' % (session['grandparent_title'],
-                                  session['title'])
+    if metadata['media_type'] == 'episode' or metadata['media_type'] == 'track':
+        full_title = '%s - %s' % (metadata['grandparent_title'],
+                                  metadata['title'])
     else:
-        full_title = session['title']
+        full_title = metadata['title']
 
-    # Generate a combined transcode decision value
-    if session['video_decision']:
-        if session['video_decision'] == 'transcode':
+    duration = helpers.convert_milliseconds_to_minutes(metadata['duration'])
+
+    # Default values
+    user = ''
+    platform = ''
+    player = ''
+    ip_address = 'N/A'
+    stream_duration = 0
+    view_offset = 0
+    container = ''
+    video_codec = ''
+    video_bitrate = ''
+    video_width = ''
+    video_height = ''
+    video_resolution = ''
+    video_framerate = ''
+    aspect_ratio = ''
+    audio_codec = ''
+    audio_channels = ''
+    transcode_decision = ''
+    video_decision = ''
+    audio_decision = ''
+    transcode_container = ''
+    transcode_video_codec = ''
+    transcode_video_width = ''
+    transcode_video_height = ''
+    transcode_audio_codec = ''
+    transcode_audio_channels = ''
+
+    # Session values
+    if session:
+        # Generate a combined transcode decision value
+        video_decision = session['video_decision'].title()
+        audio_decision = session['audio_decision'].title()
+
+        if session['video_decision'] == 'transcode' or session['audio_decision'] == 'transcode':
             transcode_decision = 'Transcode'
         elif session['video_decision'] == 'copy' or session['audio_decision'] == 'copy':
             transcode_decision = 'Direct Stream'
         else:
             transcode_decision = 'Direct Play'
-    else:
-        if session['audio_decision'] == 'transcode':
-            transcode_decision = 'Transcode'
-        else:
-            transcode_decision = 'Direct Play'
 
-    duration = helpers.convert_milliseconds_to_minutes(item_metadata['duration'])
-    view_offset = helpers.convert_milliseconds_to_minutes(session['view_offset'])
-    stream_duration = 0
-    if state != 'play':
-        if session['paused_counter']:
-            stream_duration = int((time.time() - helpers.cast_to_float(session['started']) -
-                                   helpers.cast_to_float(session['paused_counter'])) / 60)
-        else:
-            stream_duration = int((time.time() - helpers.cast_to_float(session['started'])) / 60)
+        if state != 'play':
+            if session['paused_counter']:
+                stream_duration = int((time.time() - helpers.cast_to_float(session['started']) -
+                                       helpers.cast_to_float(session['paused_counter'])) / 60)
+            else:
+                stream_duration = int((time.time() - helpers.cast_to_float(session['started'])) / 60)
+
+        view_offset = helpers.convert_milliseconds_to_minutes(session['view_offset'])
+        user = session['friendly_name']
+        platform = session['platform']
+        player = session['player']
+        ip_address = session['ip_address'] if session['ip_address'] else 'N/A'
+        container = session['container']
+        video_codec = session['video_codec']
+        video_bitrate = session['bitrate']
+        video_width = session['width']
+        video_height = session['height']
+        video_resolution = session['video_resolution']
+        video_framerate = session['video_framerate']
+        aspect_ratio = session['aspect_ratio']
+        audio_codec = session['audio_codec']
+        audio_channels = session['audio_channels']
+        transcode_container = session['transcode_container']
+        transcode_video_codec = session['transcode_video_codec']
+        transcode_video_width = session['transcode_width']
+        transcode_video_height = session['transcode_height']
+        transcode_audio_codec = session['transcode_audio_codec']
+        transcode_audio_channels = session['transcode_audio_channels']
 
     progress_percent = helpers.get_percent(view_offset, duration)
 
+    # Fix metadata params for notify recently added grandparent
+    if plexpy.CONFIG.NOTIFY_RECENTLY_ADDED_GRANDPARENT:
+        show_name = metadata['title']
+        episode_name = ''
+        artist_name = metadata['title']
+        album_name = ''
+        track_name = ''
+    else:
+        show_name = metadata['grandparent_title']
+        episode_name = metadata['title']
+        artist_name = metadata['grandparent_title']
+        album_name = metadata['parent_title']
+        track_name = metadata['title']
+    
     available_params = {'server_name': server_name,
-                        'user': session['friendly_name'],
-                        'player': session['player'],
-                        'title': full_title,
-                        'show_name': item_metadata['grandparent_title'],
-                        'episode_name': item_metadata['title'],
-                        'platform': session['platform'],
-                        'media_type': session['media_type'],
-                        'transcode_decision': transcode_decision,
-                        'year': item_metadata['year'],
-                        'studio': item_metadata['studio'],
-                        'content_rating': item_metadata['content_rating'],
-                        'summary': item_metadata['summary'],
-                        'season_num': item_metadata['parent_index'],
-                        'season_num00': item_metadata['parent_index'].zfill(2),
-                        'episode_num': item_metadata['index'],
-                        'episode_num00': item_metadata['index'].zfill(2),
-                        'album_name': item_metadata['parent_title'],
-                        'rating': item_metadata['rating'],
-                        'duration': duration,
+                        'server_uptime': server_uptime,
+                        'user': user,
+                        'platform': platform,
+                        'player': player,
+                        'ip_address': ip_address,
+                        'media_type': metadata['media_type'],
                         'stream_duration': stream_duration,
+                        'remaining_duration': duration - view_offset,
                         'progress': view_offset,
-                        'progress_percent': progress_percent
+                        'progress_percent': progress_percent,
+                        'container': container,
+                        'video_codec': video_codec,
+                        'video_bitrate': video_bitrate,
+                        'video_width': video_width,
+                        'video_height': video_height,
+                        'video_resolution': video_resolution,
+                        'video_framerate': video_framerate,
+                        'aspect_ratio': aspect_ratio,
+                        'audio_codec': audio_codec,
+                        'audio_channels': audio_channels,
+                        'transcode_decision': transcode_decision,
+                        'video_decision': video_decision,
+                        'audio_decision': audio_decision,
+                        'transcode_container': transcode_container,
+                        'transcode_video_codec': transcode_video_codec,
+                        'transcode_video_width': transcode_video_width,
+                        'transcode_video_height': transcode_video_height,
+                        'transcode_audio_codec': transcode_audio_codec,
+                        'transcode_audio_channels': transcode_audio_channels,
+                        'title': full_title,
+                        'show_name': show_name,
+                        'episode_name': episode_name,
+                        'artist_name': artist_name,
+                        'album_name': album_name,
+                        'track_name': track_name,
+                        'season_num': metadata['parent_index'].zfill(1),
+                        'season_num00': metadata['parent_index'].zfill(2),
+                        'episode_num': metadata['index'].zfill(1),
+                        'episode_num00': metadata['index'].zfill(2),
+                        'year': metadata['year'],
+                        'studio': metadata['studio'],
+                        'content_rating': metadata['content_rating'],
+                        'directors': ', '.join(metadata['directors']),
+                        'writers': ', '.join(metadata['writers']),
+                        'actors': ', '.join(metadata['actors']),
+                        'genres': ', '.join(metadata['genres']),
+                        'summary': metadata['summary'],
+                        'tagline': metadata['tagline'],
+                        'rating': metadata['rating'],
+                        'duration': duration
                         }
 
     # Default subject text
@@ -482,12 +663,154 @@ def build_notify_text(session, state):
             except:
                 logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
 
+            return [subject_text, body_text]
+        else:
+            return [subject_text, body_text]
+    elif state == 'created':
+        # Default body text
+        body_text = '%s was recently added to Plex.' % full_title
+
+        if on_created_subject and on_created_body:
+            try:
+                subject_text = unicode(on_created_subject).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification subject. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification subject. Using fallback.")
+
+            try:
+                body_text = unicode(on_created_body).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification body. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
+
             return [subject_text, body_text]
         else:
             return [subject_text, body_text]
     else:
         return None
 
+def build_server_notify_text(state=None):
+    # Get the server name
+    server_name = plexpy.CONFIG.PMS_NAME
+
+    # Get the server uptime
+    plex_tv = plextv.PlexTV()
+    server_times = plex_tv.get_server_times()
+
+    if server_times:
+        updated_at = server_times[0]['updated_at']
+        server_uptime = helpers.human_duration(int(time.time() - helpers.cast_to_float(updated_at)))
+    else:
+        logger.error(u"PlexPy Notifier :: Unable to retrieve server uptime.")
+        server_uptime = 'N/A'
+
+    on_extdown_subject = plexpy.CONFIG.NOTIFY_ON_EXTDOWN_SUBJECT_TEXT
+    on_extdown_body = plexpy.CONFIG.NOTIFY_ON_EXTDOWN_BODY_TEXT
+    on_intdown_subject = plexpy.CONFIG.NOTIFY_ON_INTDOWN_SUBJECT_TEXT
+    on_intdown_body = plexpy.CONFIG.NOTIFY_ON_INTDOWN_BODY_TEXT
+    on_extup_subject = plexpy.CONFIG.NOTIFY_ON_EXTUP_SUBJECT_TEXT
+    on_extup_body = plexpy.CONFIG.NOTIFY_ON_EXTUP_BODY_TEXT
+    on_intup_subject = plexpy.CONFIG.NOTIFY_ON_INTUP_SUBJECT_TEXT
+    on_intup_body = plexpy.CONFIG.NOTIFY_ON_INTUP_BODY_TEXT
+
+    available_params = {'server_name': server_name,
+                        'server_uptime': server_uptime}
+
+    # Default text
+    subject_text = 'PlexPy (%s)' % server_name
+
+    if state == 'extdown':
+        # Default body text
+        body_text = 'The Plex Media Server remote access is down.'
+
+        if on_extdown_subject and on_extdown_body:
+            try:
+                subject_text = unicode(on_extdown_subject).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification subject. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification subject. Using fallback.")
+
+            try:
+                body_text = unicode(on_extdown_body).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification body. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
+
+            return [subject_text, body_text]
+        else:
+            return [subject_text, body_text]
+    elif state == 'intdown':
+        # Default body text
+        body_text = 'The Plex Media Server is down.'
+
+        if on_intdown_subject and on_intdown_body:
+            try:
+                subject_text = unicode(on_intdown_subject).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification subject. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification subject. Using fallback.")
+
+            try:
+                body_text = unicode(on_intdown_body).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification body. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
+
+            return [subject_text, body_text]
+        else:
+            return [subject_text, body_text]
+    if state == 'extup':
+        # Default body text
+        body_text = 'The Plex Media Server remote access is back up.'
+
+        if on_extup_subject and on_extup_body:
+            try:
+                subject_text = unicode(on_extup_subject).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification subject. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification subject. Using fallback.")
+
+            try:
+                body_text = unicode(on_extup_body).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification body. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
+
+            return [subject_text, body_text]
+        else:
+            return [subject_text, body_text]
+    elif state == 'intup':
+        # Default body text
+        body_text = 'The Plex Media Server is back up.'
+
+        if on_intup_subject and on_intup_body:
+            try:
+                subject_text = unicode(on_intup_subject).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification subject. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification subject. Using fallback.")
+
+            try:
+                body_text = unicode(on_intup_body).format(**available_params)
+            except LookupError, e:
+                logger.error(u"PlexPy Notifier :: Unable to parse field %s in notification body. Using fallback." % e)
+            except:
+                logger.error(u"PlexPy Notifier :: Unable to parse custom notification body. Using fallback.")
+
+            return [subject_text, body_text]
+        else:
+            return [subject_text, body_text]
+    else:
+        return None
 
 def strip_tag(data):
     import re

plexpy/notifiers.py

@@ -1,4 +1,4 @@
-#  This file is part of PlexPy.
+#  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
@@ -49,7 +49,10 @@ AGENT_IDS = {"Growl": 0,
              "Pushover": 7,
              "OSX Notify": 8,
              "Boxcar2": 9,
-             "Email": 10}
+             "Email": 10,
+             "Twitter": 11,
+             "IFTTT": 12,
+             "Telegram": 13}
 
 def available_notification_agents():
     agents = [{'name': 'Growl',
@@ -62,7 +65,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.GROWL_ON_PAUSE,
                'on_resume': plexpy.CONFIG.GROWL_ON_RESUME,
                'on_buffer': plexpy.CONFIG.GROWL_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.GROWL_ON_WATCHED
+               'on_watched': plexpy.CONFIG.GROWL_ON_WATCHED,
+               'on_created': plexpy.CONFIG.GROWL_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.GROWL_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.GROWL_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.GROWL_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.GROWL_ON_INTUP
                },
               {'name': 'Prowl',
                'id': AGENT_IDS['Prowl'],
@@ -74,7 +82,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.PROWL_ON_PAUSE,
                'on_resume': plexpy.CONFIG.PROWL_ON_RESUME,
                'on_buffer': plexpy.CONFIG.PROWL_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.PROWL_ON_WATCHED
+               'on_watched': plexpy.CONFIG.PROWL_ON_WATCHED,
+               'on_created': plexpy.CONFIG.PROWL_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.PROWL_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.PROWL_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.PROWL_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.PROWL_ON_INTUP
                },
               {'name': 'XBMC',
                'id': AGENT_IDS['XBMC'],
@@ -86,7 +99,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.XBMC_ON_PAUSE,
                'on_resume': plexpy.CONFIG.XBMC_ON_RESUME,
                'on_buffer': plexpy.CONFIG.XBMC_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.XBMC_ON_WATCHED
+               'on_watched': plexpy.CONFIG.XBMC_ON_WATCHED,
+               'on_created': plexpy.CONFIG.XBMC_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.XBMC_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.XBMC_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.XBMC_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.XBMC_ON_INTUP
                },
               {'name': 'Plex',
                'id': AGENT_IDS['Plex'],
@@ -98,7 +116,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.PLEX_ON_PAUSE,
                'on_resume': plexpy.CONFIG.PLEX_ON_RESUME,
                'on_buffer': plexpy.CONFIG.PLEX_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.PLEX_ON_WATCHED
+               'on_watched': plexpy.CONFIG.PLEX_ON_WATCHED,
+               'on_created': plexpy.CONFIG.PLEX_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.PLEX_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.PLEX_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.PLEX_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.PLEX_ON_INTUP
                },
               {'name': 'NotifyMyAndroid',
                'id': AGENT_IDS['NMA'],
@@ -110,7 +133,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.NMA_ON_PAUSE,
                'on_resume': plexpy.CONFIG.NMA_ON_RESUME,
                'on_buffer': plexpy.CONFIG.NMA_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.NMA_ON_WATCHED
+               'on_watched': plexpy.CONFIG.NMA_ON_WATCHED,
+               'on_created': plexpy.CONFIG.NMA_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.NMA_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.NMA_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.NMA_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.NMA_ON_INTUP
                },
               {'name': 'Pushalot',
                'id': AGENT_IDS['Pushalot'],
@@ -122,7 +150,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.PUSHALOT_ON_PAUSE,
                'on_resume': plexpy.CONFIG.PUSHALOT_ON_RESUME,
                'on_buffer': plexpy.CONFIG.PUSHALOT_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.PUSHALOT_ON_WATCHED
+               'on_watched': plexpy.CONFIG.PUSHALOT_ON_WATCHED,
+               'on_created': plexpy.CONFIG.PUSHALOT_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.PUSHALOT_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.PUSHALOT_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.PUSHALOT_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.PUSHALOT_ON_INTUP
                },
               {'name': 'Pushbullet',
                'id': AGENT_IDS['Pushbullet'],
@@ -134,7 +167,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.PUSHBULLET_ON_PAUSE,
                'on_resume': plexpy.CONFIG.PUSHBULLET_ON_RESUME,
                'on_buffer': plexpy.CONFIG.PUSHBULLET_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.PUSHBULLET_ON_WATCHED
+               'on_watched': plexpy.CONFIG.PUSHBULLET_ON_WATCHED,
+               'on_created': plexpy.CONFIG.PUSHBULLET_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.PUSHBULLET_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.PUSHBULLET_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.PUSHBULLET_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.PUSHBULLET_ON_INTUP
                },
               {'name': 'Pushover',
                'id': AGENT_IDS['Pushover'],
@@ -146,7 +184,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.PUSHOVER_ON_PAUSE,
                'on_resume': plexpy.CONFIG.PUSHOVER_ON_RESUME,
                'on_buffer': plexpy.CONFIG.PUSHOVER_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.PUSHOVER_ON_WATCHED
+               'on_watched': plexpy.CONFIG.PUSHOVER_ON_WATCHED,
+               'on_created': plexpy.CONFIG.PUSHOVER_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.PUSHOVER_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.PUSHOVER_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.PUSHOVER_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.PUSHOVER_ON_INTUP
                },
               {'name': 'Boxcar2',
                'id': AGENT_IDS['Boxcar2'],
@@ -158,7 +201,12 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.BOXCAR_ON_PAUSE,
                'on_resume': plexpy.CONFIG.BOXCAR_ON_RESUME,
                'on_buffer': plexpy.CONFIG.BOXCAR_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.BOXCAR_ON_WATCHED
+               'on_watched': plexpy.CONFIG.BOXCAR_ON_WATCHED,
+               'on_created': plexpy.CONFIG.BOXCAR_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.BOXCAR_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.BOXCAR_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.BOXCAR_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.BOXCAR_ON_INTUP
                },
               {'name': 'E-mail',
                'id': AGENT_IDS['Email'],
@@ -170,7 +218,63 @@ def available_notification_agents():
                'on_pause': plexpy.CONFIG.EMAIL_ON_PAUSE,
                'on_resume': plexpy.CONFIG.EMAIL_ON_RESUME,
                'on_buffer': plexpy.CONFIG.EMAIL_ON_BUFFER,
-               'on_watched': plexpy.CONFIG.EMAIL_ON_WATCHED
+               'on_watched': plexpy.CONFIG.EMAIL_ON_WATCHED,
+               'on_created': plexpy.CONFIG.EMAIL_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.EMAIL_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.EMAIL_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.EMAIL_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.EMAIL_ON_INTUP
+               },
+              {'name': 'Twitter',
+               'id': AGENT_IDS['Twitter'],
+               'config_prefix': 'twitter',
+               'has_config': True,
+               'state': checked(plexpy.CONFIG.TWITTER_ENABLED),
+               'on_play': plexpy.CONFIG.TWITTER_ON_PLAY,
+               'on_stop': plexpy.CONFIG.TWITTER_ON_STOP,
+               'on_pause': plexpy.CONFIG.TWITTER_ON_PAUSE,
+               'on_resume': plexpy.CONFIG.TWITTER_ON_RESUME,
+               'on_buffer': plexpy.CONFIG.TWITTER_ON_BUFFER,
+               'on_watched': plexpy.CONFIG.TWITTER_ON_WATCHED,
+               'on_created': plexpy.CONFIG.TWITTER_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.TWITTER_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.TWITTER_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.TWITTER_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.TWITTER_ON_INTUP
+               },
+              {'name': 'IFTTT',
+               'id': AGENT_IDS['IFTTT'],
+               'config_prefix': 'ifttt',
+               'has_config': True,
+               'state': checked(plexpy.CONFIG.IFTTT_ENABLED),
+               'on_play': plexpy.CONFIG.IFTTT_ON_PLAY,
+               'on_stop': plexpy.CONFIG.IFTTT_ON_STOP,
+               'on_pause': plexpy.CONFIG.IFTTT_ON_PAUSE,
+               'on_resume': plexpy.CONFIG.IFTTT_ON_RESUME,
+               'on_buffer': plexpy.CONFIG.IFTTT_ON_BUFFER,
+               'on_watched': plexpy.CONFIG.IFTTT_ON_WATCHED,
+               'on_created': plexpy.CONFIG.IFTTT_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.IFTTT_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.IFTTT_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.IFTTT_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.IFTTT_ON_INTUP
+               },
+              {'name': 'Telegram',
+               'id': AGENT_IDS['Telegram'],
+               'config_prefix': 'telegram',
+               'has_config': True,
+               'state': checked(plexpy.CONFIG.TELEGRAM_ENABLED),
+               'on_play': plexpy.CONFIG.TELEGRAM_ON_PLAY,
+               'on_stop': plexpy.CONFIG.TELEGRAM_ON_STOP,
+               'on_pause': plexpy.CONFIG.TELEGRAM_ON_PAUSE,
+               'on_resume': plexpy.CONFIG.TELEGRAM_ON_RESUME,
+               'on_buffer': plexpy.CONFIG.TELEGRAM_ON_BUFFER,
+               'on_watched': plexpy.CONFIG.TELEGRAM_ON_WATCHED,
+               'on_created': plexpy.CONFIG.TELEGRAM_ON_CREATED,
+               'on_extdown': plexpy.CONFIG.TELEGRAM_ON_EXTDOWN,
+               'on_intdown': plexpy.CONFIG.TELEGRAM_ON_INTDOWN,
+               'on_extup': plexpy.CONFIG.TELEGRAM_ON_EXTUP,
+               'on_intup': plexpy.CONFIG.TELEGRAM_ON_INTUP
                }
               ]
 
@@ -187,7 +291,12 @@ def available_notification_agents():
                        'on_pause': plexpy.CONFIG.OSX_NOTIFY_ON_PAUSE,
                        'on_resume': plexpy.CONFIG.OSX_NOTIFY_ON_RESUME,
                        'on_buffer': plexpy.CONFIG.OSX_NOTIFY_ON_BUFFER,
-                       'on_watched': plexpy.CONFIG.OSX_NOTIFY_ON_WATCHED
+                       'on_watched': plexpy.CONFIG.OSX_NOTIFY_ON_WATCHED,
+                       'on_created': plexpy.CONFIG.OSX_NOTIFY_ON_CREATED,
+                       'on_extdown': plexpy.CONFIG.OSX_NOTIFY_ON_EXTDOWN,
+                       'on_intdown': plexpy.CONFIG.OSX_NOTIFY_ON_INTDOWN,
+                       'on_extup': plexpy.CONFIG.OSX_NOTIFY_ON_EXTUP,
+                       'on_intup': plexpy.CONFIG.OSX_NOTIFY_ON_INTUP
                        })
 
     return agents
@@ -229,13 +338,22 @@ def get_notification_agent_config(config_id):
         elif config_id == 10:
             email = Email()
             return email.return_config_options()
+        elif config_id == 11:
+            tweet = TwitterNotifier()
+            return tweet.return_config_options()
+        elif config_id == 12:
+            iftttClient = IFTTT()
+            return iftttClient.return_config_options()
+        elif config_id == 13:
+          telegramClient = TELEGRAM()
+          return telegramClient.return_config_options()
         else:
             return []
     else:
         return []
 
 def send_notification(config_id, subject, body):
-    if config_id:
+    if str(config_id).isdigit():
         config_id = int(config_id)
 
         if config_id == 0:
@@ -271,6 +389,15 @@ def send_notification(config_id, subject, body):
         elif config_id == 10:
             email = Email()
             email.notify(subject=subject, message=body)
+        elif config_id == 11:
+            tweet = TwitterNotifier()
+            tweet.notify(subject=subject, message=body)
+        elif config_id == 12:
+            iftttClient = IFTTT()
+            iftttClient.notify(subject=subject, message=body)
+        elif config_id == 13:
+          telegramClient = TELEGRAM()
+          telegramClient.notify(message=body, event=subject)
         else:
             logger.debug(u"PlexPy Notifier :: Unknown agent id received.")
     else:
@@ -286,9 +413,6 @@ class GROWL(object):
         self.enabled = plexpy.CONFIG.GROWL_ENABLED
         self.host = plexpy.CONFIG.GROWL_HOST
         self.password = plexpy.CONFIG.GROWL_PASSWORD
-        self.on_play = plexpy.CONFIG.GROWL_ON_PLAY
-        self.on_stop = plexpy.CONFIG.GROWL_ON_STOP
-        self.on_watched = plexpy.CONFIG.GROWL_ON_WATCHED
 
     def conf(self, options):
         return cherrypy.config['config'].get('Growl', options)
@@ -336,7 +460,7 @@ class GROWL(object):
 
         # Send it, including an image
         image_file = os.path.join(str(plexpy.PROG_DIR),
-            "data/images/plexpylogo.png")
+            "data/interfaces/default/images/favicon.png")
 
         with open(image_file, 'rb') as f:
             image = f.read()
@@ -366,16 +490,16 @@ class GROWL(object):
         self.notify('ZOMG Lazors Pewpewpew!', 'Test Message')
 
     def return_config_options(self):
-        config_option = [{'label': 'Host',
+        config_option = [{'label': 'Growl Host',
                           'value': self.host,
                           'name': 'growl_host',
-                          'description': 'Set the hostname.',
+                          'description': 'Your Growl hostname.',
                           'input_type': 'text'
                           },
-                         {'label': 'Password',
+                         {'label': 'Growl Password',
                           'value': self.password,
                           'name': 'growl_password',
-                          'description': 'Set the password.',
+                          'description': 'Your Growl password.',
                           'input_type': 'password'
                           }
                          ]
@@ -391,9 +515,6 @@ class PROWL(object):
         self.enabled = plexpy.CONFIG.PROWL_ENABLED
         self.keys = plexpy.CONFIG.PROWL_KEYS
         self.priority = plexpy.CONFIG.PROWL_PRIORITY
-        self.on_play = plexpy.CONFIG.PROWL_ON_PLAY
-        self.on_stop = plexpy.CONFIG.PROWL_ON_STOP
-        self.on_watched = plexpy.CONFIG.PROWL_ON_WATCHED
 
     def conf(self, options):
         return cherrypy.config['config'].get('Prowl', options)
@@ -406,7 +527,7 @@ class PROWL(object):
 
         data = {'apikey': plexpy.CONFIG.PROWL_KEYS,
                 'application': 'PlexPy',
-                'event': event,
+                'event': event.encode("utf-8"),
                 'description': message.encode("utf-8"),
                 'priority': plexpy.CONFIG.PROWL_PRIORITY}
 
@@ -439,17 +560,18 @@ class PROWL(object):
         self.notify('ZOMG Lazors Pewpewpew!', 'Test Message')
 
     def return_config_options(self):
-        config_option = [{'label': 'API Key',
+        config_option = [{'label': 'Prowl API Key',
                           'value': self.keys,
                           'name': 'prowl_keys',
-                          'description': 'Set the API key.',
+                          'description': 'Your Prowl API key.',
                           'input_type': 'text'
                           },
-                         {'label': 'Priority (-2,-1,0,1 or 2)',
+                         {'label': 'Priority',
                           'value': self.priority,
                           'name': 'prowl_priority',
                           'description': 'Set the priority.',
-                          'input_type': 'number'
+                          'input_type': 'select',
+                          'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2}
                           }
                          ]
 
@@ -465,9 +587,6 @@ class XBMC(object):
         self.hosts = plexpy.CONFIG.XBMC_HOST
         self.username = plexpy.CONFIG.XBMC_USERNAME
         self.password = plexpy.CONFIG.XBMC_PASSWORD
-        self.on_play = plexpy.CONFIG.XBMC_ON_PLAY
-        self.on_stop = plexpy.CONFIG.XBMC_ON_STOP
-        self.on_watched = plexpy.CONFIG.XBMC_ON_WATCHED
 
     def _sendhttp(self, host, command):
         url_command = urllib.urlencode(command)
@@ -523,19 +642,19 @@ class XBMC(object):
         config_option = [{'label': 'XBMC Host:Port',
                           'value': self.hosts,
                           'name': 'xbmc_host',
-                          'description': 'e.g. http://localhost:8080. Separate hosts with commas.',
+                          'description': 'Host running XBMC (e.g. http://localhost:8080). Separate multiple hosts with commas.',
                           'input_type': 'text'
                           },
-                         {'label': 'Username',
+                         {'label': 'XBMC Username',
                           'value': self.username,
                           'name': 'xbmc_username',
-                          'description': 'Set the Username.',
+                          'description': 'Your XBMC username.',
                           'input_type': 'text'
                           },
-                         {'label': 'Password',
+                         {'label': 'XBMC Password',
                           'value': self.password,
                           'name': 'xbmc_password',
-                          'description': 'Set the Password.',
+                          'description': 'Your XMBC password.',
                           'input_type': 'password'
                           }
                          ]
@@ -548,9 +667,6 @@ class Plex(object):
         self.client_hosts = plexpy.CONFIG.PLEX_CLIENT_HOST
         self.username = plexpy.CONFIG.PLEX_USERNAME
         self.password = plexpy.CONFIG.PLEX_PASSWORD
-        self.on_play = plexpy.CONFIG.PLEX_ON_PLAY
-        self.on_stop = plexpy.CONFIG.PLEX_ON_STOP
-        self.on_watched = plexpy.CONFIG.PLEX_ON_WATCHED
 
     def _sendhttp(self, host, command):
 
@@ -628,9 +744,6 @@ class NMA(object):
     def __init__(self):
         self.api = plexpy.CONFIG.NMA_APIKEY
         self.nma_priority = plexpy.CONFIG.NMA_PRIORITY
-        self.on_play = plexpy.CONFIG.NMA_ON_PLAY
-        self.on_stop = plexpy.CONFIG.NMA_ON_STOP
-        self.on_watched = plexpy.CONFIG.NMA_ON_WATCHED
 
     def notify(self, subject=None, message=None):
         if not subject or not message:
@@ -670,14 +783,15 @@ class NMA(object):
         config_option = [{'label': 'NotifyMyAndroid API Key',
                           'value': plexpy.CONFIG.NMA_APIKEY,
                           'name': 'nma_apikey',
-                          'description': 'Separate multiple api keys with commas.',
+                          'description': 'Your NotifyMyAndroid API key. Separate multiple api keys with commas.',
                           'input_type': 'text'
                           },
                          {'label': 'Priority',
                           'value': plexpy.CONFIG.NMA_PRIORITY,
                           'name': 'nma_priority',
-                          'description': 'Priority (-2,-1,0,1 or 2).',
-                          'input_type': 'number'
+                          'description': 'Set the priority.',
+                          'input_type': 'select',
+                          'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2}
                           }
                          ]
 
@@ -689,9 +803,6 @@ class PUSHBULLET(object):
         self.apikey = plexpy.CONFIG.PUSHBULLET_APIKEY
         self.deviceid = plexpy.CONFIG.PUSHBULLET_DEVICEID
         self.channel_tag = plexpy.CONFIG.PUSHBULLET_CHANNEL_TAG
-        self.on_play = plexpy.CONFIG.PUSHBULLET_ON_PLAY
-        self.on_stop = plexpy.CONFIG.PUSHBULLET_ON_STOP
-        self.on_watched = plexpy.CONFIG.PUSHBULLET_ON_WATCHED
 
     def conf(self, options):
         return cherrypy.config['config'].get('PUSHBULLET', options)
@@ -741,18 +852,45 @@ class PUSHBULLET(object):
 
         self.notify('Main Screen Activate', 'Test Message')
 
+    def get_devices(self):
+        if plexpy.CONFIG.PUSHBULLET_APIKEY:
+            http_handler = HTTPSConnection("api.pushbullet.com")
+            http_handler.request("GET", "/v2/devices",
+                                    headers={'Content-type': "application/json",
+                                             'Authorization': 'Basic %s' % base64.b64encode(plexpy.CONFIG.PUSHBULLET_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.info(u"Unable to retrieve Pushbullet devices list: %s" % response.reason)
+                return {'': ''}
+            else:
+                logger.info(u"Unable to retrieve Pushbullet devices list.")
+                return {'': ''}
+
+        else:
+            return {'': ''}
+
     def return_config_options(self):
-        config_option = [{'label': 'API Key',
+        config_option = [{'label': 'Pushbullet API Key',
                           'value': self.apikey,
                           'name': 'pushbullet_apikey',
                           'description': 'Your Pushbullet API key.',
                           'input_type': 'text'
                           },
-                         {'label': 'Device ID',
+                         {'label': 'Device',
                           'value': self.deviceid,
                           'name': 'pushbullet_deviceid',
-                          'description': 'A device ID (optional). If set, will override channel tag.',
-                          'input_type': 'text'
+                          '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.channel_tag,
@@ -768,9 +906,6 @@ class PUSHALOT(object):
 
     def __init__(self):
         self.api_key = plexpy.CONFIG.PUSHALOT_APIKEY
-        self.on_play = plexpy.CONFIG.PUSHALOT_ON_PLAY
-        self.on_stop = plexpy.CONFIG.PUSHALOT_ON_STOP
-        self.on_watched = plexpy.CONFIG.PUSHALOT_ON_WATCHED
 
     def notify(self, message, event):
         if not message or not event:
@@ -778,9 +913,9 @@ class PUSHALOT(object):
 
         pushalot_authorizationtoken = plexpy.CONFIG.PUSHALOT_APIKEY
 
-        logger.debug(u"Pushalot event: " + event)
-        logger.debug(u"Pushalot message: " + message)
-        logger.debug(u"Pushalot api: " + pushalot_authorizationtoken)
+        #logger.debug(u"Pushalot event: " + event)
+        #logger.debug(u"Pushalot message: " + message)
+        #logger.debug(u"Pushalot api: " + pushalot_authorizationtoken)
 
         http_handler = HTTPSConnection("pushalot.com")
 
@@ -795,9 +930,9 @@ class PUSHALOT(object):
         response = http_handler.getresponse()
         request_status = response.status
 
-        logger.debug(u"Pushalot response status: %r" % request_status)
-        logger.debug(u"Pushalot response headers: %r" % response.getheaders())
-        logger.debug(u"Pushalot response body: %r" % response.read())
+        #logger.debug(u"Pushalot response status: %r" % request_status)
+        #logger.debug(u"Pushalot response headers: %r" % response.getheaders())
+        #logger.debug(u"Pushalot response body: %r" % response.read())
 
         if request_status == 200:
                 logger.info(u"Pushalot notifications sent.")
@@ -810,7 +945,7 @@ class PUSHALOT(object):
                 return False
 
     def return_config_options(self):
-        config_option = [{'label': 'API Key',
+        config_option = [{'label': 'Pushalot API Key',
                           'value': plexpy.CONFIG.PUSHALOT_APIKEY,
                           'name': 'pushalot_apikey',
                           'description': 'Your Pushalot API key.',
@@ -826,9 +961,7 @@ class PUSHOVER(object):
         self.enabled = plexpy.CONFIG.PUSHOVER_ENABLED
         self.keys = plexpy.CONFIG.PUSHOVER_KEYS
         self.priority = plexpy.CONFIG.PUSHOVER_PRIORITY
-        self.on_play = plexpy.CONFIG.PUSHOVER_ON_PLAY
-        self.on_stop = plexpy.CONFIG.PUSHOVER_ON_STOP
-        self.on_watched = plexpy.CONFIG.PUSHOVER_ON_WATCHED
+        self.sound = plexpy.CONFIG.PUSHOVER_SOUND
 
         if plexpy.CONFIG.PUSHOVER_APITOKEN:
             self.application_token = plexpy.CONFIG.PUSHOVER_APITOKEN
@@ -846,14 +979,15 @@ class PUSHOVER(object):
 
         data = {'token': self.application_token,
                 'user': plexpy.CONFIG.PUSHOVER_KEYS,
-                'title': event,
+                'title': event.encode("utf-8"),
                 'message': message.encode("utf-8"),
+                'sound': plexpy.CONFIG.PUSHOVER_SOUND,
                 'priority': plexpy.CONFIG.PUSHOVER_PRIORITY}
 
         http_handler.request("POST",
-                                "/1/messages.json",
-                                headers={'Content-type': "application/x-www-form-urlencoded"},
-                                body=urlencode(data))
+                             "/1/messages.json",
+                             headers={'Content-type': "application/x-www-form-urlencoded"},
+                             body=urlencode(data))
         response = http_handler.getresponse()
         request_status = response.status
         # logger.debug(u"Pushover response status: %r" % request_status)
@@ -874,30 +1008,57 @@ class PUSHOVER(object):
         #For uniformity reasons not removed
         return
 
-    def test(self, keys, priority):
+    def test(self, keys, priority, sound):
         self.enabled = True
         self.keys = keys
         self.priority = priority
+        self.sound = sound
 
         self.notify('Main Screen Activate', 'Test Message')
 
+    def get_sounds(self):
+        http_handler = HTTPSConnection("api.pushover.net")
+        http_handler.request("GET", "/1/sounds.json?token=" + self.application_token)
+        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.info(u"Unable to retrieve Pushover notification sounds list: %s" % response.reason)
+            return {'': ''}
+        else:
+            logger.info(u"Unable to retrieve Pushover notification sounds list.")
+            return {'': ''}
+
     def return_config_options(self):
-        config_option = [{'label': 'API Key',
+        config_option = [{'label': 'Pushover User or Group Key',
                           'value': self.keys,
                           'name': 'pushover_keys',
-                          'description': 'Your Pushover API key.',
+                          'description': 'Your Pushover user or group key.',
                           'input_type': 'text'
                           },
                          {'label': 'Priority',
                           'value': self.priority,
                           'name': 'pushover_priority',
-                          'description': 'Priority (-1,0, or 1).',
-                          'input_type': 'number'
+                          'description': 'Set the priority.',
+                          'input_type': 'select',
+                          'select_options': {-2: -2, -1: -1, 0: 0, 1: 1, 2: 2}
                           },
-                         {'label': 'API Token',
+                         {'label': 'Sound',
+                          'value': self.sound,
+                          'name': 'pushover_sound',
+                          'description': 'Set the notification sound. Leave blank for the default sound.',
+                          'input_type': 'select',
+                          'select_options': self.get_sounds()
+                          },
+                         {'label': 'Pushover API Token',
                           'value': plexpy.CONFIG.PUSHOVER_APITOKEN,
                           'name': 'pushover_apitoken',
-                          'description': 'Leave blank to use PlexPy default.',
+                          'description': 'Your Pushover API token. Leave blank to use PlexPy default.',
                           'input_type': 'text'
                           }
                          ]
@@ -912,19 +1073,17 @@ class TwitterNotifier(object):
     SIGNIN_URL = 'https://api.twitter.com/oauth/authenticate'
 
     def __init__(self):
-        self.consumer_key = "oYKnp2ddX5gbARjqX8ZAAg"
-        self.consumer_secret = "A4Xkw9i5SjHbTk7XT8zzOPqivhj9MmRDR9Qn95YA9sk"
+        self.consumer_key = "2LdJKXHDUwJtjYBsdwJisIOsh"
+        self.consumer_secret = "QWbUcZzAIiL4zbDCIhy2EdUkV8yEEav3qMdo5y3FugxCFelWrA"
 
-    def notify_snatch(self, title):
-        if plexpy.CONFIG.TWITTER_ONSNATCH:
-            self._notifyTwitter(common.notifyStrings[common.NOTIFY_SNATCH] + ': ' + title + ' at ' + helpers.now())
-
-    def notify_download(self, title):
-        if plexpy.CONFIG.TWITTER_ENABLED:
-            self._notifyTwitter(common.notifyStrings[common.NOTIFY_DOWNLOAD] + ': ' + title + ' at ' + helpers.now())
+    def notify(self, subject, message):
+        if not subject or not message:
+            return
+        else:
+            self._send_tweet(subject + ': ' + message)
 
     def test_notify(self):
-        return self._notifyTwitter("This is a test notification from PlexPy at " + helpers.now(), force=True)
+        return self._send_tweet("This is a test notification from PlexPy at " + helpers.now())
 
     def _get_authorization(self):
 
@@ -958,7 +1117,7 @@ class TwitterNotifier(object):
         logger.info('Generating and signing request for an access token using key ' + key)
 
         oauth_consumer = oauth.Consumer(key=self.consumer_key, secret=self.consumer_secret)
-        logger.info('oauth_consumer: ' + str(oauth_consumer))
+        # logger.debug('oauth_consumer: ' + str(oauth_consumer))
         oauth_client = oauth.Client(oauth_consumer, token)
         logger.info('oauth_client: ' + str(oauth_client))
         resp, content = oauth_client.request(self.ACCESS_TOKEN_URL, method='POST', body='oauth_verifier=%s' % key)
@@ -979,7 +1138,6 @@ class TwitterNotifier(object):
             return True
 
     def _send_tweet(self, message=None):
-
         username = self.consumer_key
         password = self.consumer_secret
         access_token_key = plexpy.CONFIG.TWITTER_USERNAME
@@ -997,20 +1155,40 @@ class TwitterNotifier(object):
 
         return True
 
-    def _notifyTwitter(self, message='', force=False):
-        prefix = plexpy.CONFIG.TWITTER_PREFIX
+    def return_config_options(self):
+        config_option = [{'label': 'Request Authorisation',
+                          'value': 'Request Authorisation',
+                          'name': 'twitterStep1',
+                          'description': 'Step 1: Click Request button above. (Ensure you allow the browser pop-up).',
+                          'input_type': 'button'
+                          },
+                          {'label': 'Authorisation Key',
+                           'value': '',
+                           'name': 'twitter_key',
+                           'description': 'Step 2: Input the authorisation key you received from Step 1.',
+                           'input_type': 'text'
+                          },
+                          {'label': 'Verify Key',
+                           'value': 'Verify Key',
+                           'name': 'twitterStep2',
+                           'description': 'Step 3: Verify the key.',
+                           'input_type': 'button'
+                          },
+                          {'label': 'Test Twitter',
+                           'value': 'Test Twitter',
+                           'name': 'testTwitter',
+                           'description': 'Test if Twitter notifications are working. See logs for troubleshooting.',
+                           'input_type': 'button'
+                          },
+                          {'input_type': 'nosave'
+                          }
+                         ]
 
-        if not plexpy.CONFIG.TWITTER_ENABLED and not force:
-            return False
-
-        return self._send_tweet(prefix + ": " + message)
+        return config_option
 
 class OSX_NOTIFY(object):
 
     def __init__(self):
-        self.on_play = plexpy.CONFIG.OSX_NOTIFY_ON_PLAY
-        self.on_stop = plexpy.CONFIG.OSX_NOTIFY_ON_STOP
-        self.on_watched = plexpy.CONFIG.OSX_NOTIFY_ON_WATCHED
         try:
             self.objc = __import__("objc")
             self.AppKit = __import__("AppKit")
@@ -1067,6 +1245,7 @@ class OSX_NOTIFY(object):
 
             notification_center = NSUserNotificationCenter.defaultUserNotificationCenter()
             notification_center.deliverNotification_(notification)
+            logger.info(u"OSX Notify notifications sent.")
 
             del pool
             return True
@@ -1095,9 +1274,7 @@ class BOXCAR(object):
     def __init__(self):
         self.url = 'https://new.boxcar.io/api/notifications'
         self.token = plexpy.CONFIG.BOXCAR_TOKEN
-        self.on_play = plexpy.CONFIG.BOXCAR_ON_PLAY
-        self.on_stop = plexpy.CONFIG.BOXCAR_ON_STOP
-        self.on_watched = plexpy.CONFIG.BOXCAR_ON_WATCHED
+        self.sound = plexpy.CONFIG.BOXCAR_SOUND
 
     def notify(self, title, message):
         if not title or not message:
@@ -1108,12 +1285,13 @@ class BOXCAR(object):
                 'user_credentials': plexpy.CONFIG.BOXCAR_TOKEN,
                 'notification[title]': title.encode('utf-8'),
                 'notification[long_message]': message.encode('utf-8'),
-                'notification[sound]': "done"
+                'notification[sound]': plexpy.CONFIG.BOXCAR_SOUND
                 })
 
             req = urllib2.Request(self.url)
             handle = urllib2.urlopen(req, data)
             handle.close()
+            logger.info(u"Boxcar2 notifications sent.")
             return True
 
         except urllib2.URLError as e:
@@ -1121,11 +1299,47 @@ class BOXCAR(object):
             return False
 
     def return_config_options(self):
-        config_option = [{'label': 'Access Token',
+        config_option = [{'label': 'Boxcar Access Token',
                           'value': plexpy.CONFIG.BOXCAR_TOKEN,
                           'name': 'boxcar_token',
                           'description': 'Your Boxcar access token.',
                           'input_type': 'text'
+                          },
+                         {'label': 'Sound',
+                          'value': self.sound,
+                          'name': 'boxcar_sound',
+                          'description': 'Set the notification sound. Leave blank for the default sound.',
+                          'input_type': 'select',
+                          'select_options': {'': '',
+                                             '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'}
                           }
                          ]
 
@@ -1134,9 +1348,7 @@ class BOXCAR(object):
 class Email(object):
 
     def __init__(self):
-        self.on_play = plexpy.CONFIG.EMAIL_ON_PLAY
-        self.on_stop = plexpy.CONFIG.EMAIL_ON_STOP
-        self.on_watched = plexpy.CONFIG.EMAIL_ON_WATCHED
+        pass
 
     def notify(self, subject, message):
         if not subject or not message:
@@ -1146,6 +1358,12 @@ class Email(object):
         message['Subject'] = subject
         message['From'] = email.utils.formataddr(('PlexPy', plexpy.CONFIG.EMAIL_FROM))
         message['To'] = plexpy.CONFIG.EMAIL_TO
+        message['CC'] = plexpy.CONFIG.EMAIL_CC
+
+        recipients = [x.strip() for x in plexpy.CONFIG.EMAIL_TO.split(';')] \
+                   + [x.strip() for x in plexpy.CONFIG.EMAIL_CC.split(';')] \
+                   + [x.strip() for x in plexpy.CONFIG.EMAIL_BCC.split(';')]
+        recipients = filter(None, recipients)
 
         try:
             mailserver = smtplib.SMTP(plexpy.CONFIG.EMAIL_SMTP_SERVER, plexpy.CONFIG.EMAIL_SMTP_PORT)
@@ -1158,8 +1376,10 @@ class Email(object):
             if plexpy.CONFIG.EMAIL_SMTP_USER:
                 mailserver.login(plexpy.CONFIG.EMAIL_SMTP_USER, plexpy.CONFIG.EMAIL_SMTP_PASSWORD)
 
-            mailserver.sendmail(plexpy.CONFIG.EMAIL_FROM, plexpy.CONFIG.EMAIL_TO, message.as_string())
+            mailserver.sendmail(plexpy.CONFIG.EMAIL_FROM, recipients, message.as_string())
             mailserver.quit()
+
+            logger.info(u"Email notifications sent.")
             return True
 
         except Exception, e:
@@ -1170,13 +1390,25 @@ class Email(object):
         config_option = [{'label': 'From',
                           'value': plexpy.CONFIG.EMAIL_FROM,
                           'name': 'email_from',
-                          'description': 'Who should the sender be.',
+                          'description': 'The email address of the sender.',
                           'input_type': 'text'
                           },
                          {'label': 'To',
                           'value': plexpy.CONFIG.EMAIL_TO,
                           'name': 'email_to',
-                          'description': 'Who should the recipeint be.',
+                          'description': 'The email address(es) of the recipients, separated by semicolons (;).',
+                          'input_type': 'text'
+                          },
+                         {'label': 'CC',
+                          'value': plexpy.CONFIG.EMAIL_CC,
+                          'name': 'email_cc',
+                          'description': 'The email address(es) to CC, separated by semicolons (;).',
+                          'input_type': 'text'
+                          },
+                         {'label': 'BCC',
+                          'value': plexpy.CONFIG.EMAIL_BCC,
+                          'name': 'email_bcc',
+                          'description': 'The email address(es) to BCC, separated by semicolons (;).',
                           'input_type': 'text'
                           },
                          {'label': 'SMTP Server',
@@ -1204,11 +1436,141 @@ class Email(object):
                           'input_type': 'password'
                           },
                          {'label': 'TLS',
-                          'value': checked(plexpy.CONFIG.EMAIL_TLS),
+                          'value': plexpy.CONFIG.EMAIL_TLS,
                           'name': 'email_tls',
                           'description': 'Does the server use encryption.',
                           'input_type': 'checkbox'
                           }
                          ]
 
-        return config_option
+        return config_option
+
+
+class IFTTT(object):
+
+    def __init__(self):
+        self.apikey = plexpy.CONFIG.IFTTT_KEY
+        self.event = plexpy.CONFIG.IFTTT_EVENT
+
+    def notify(self, message, subject):
+        if not message or not subject:
+            return
+
+        http_handler = HTTPSConnection("maker.ifttt.com")
+
+        data = {'value1': subject.encode("utf-8"),
+                'value2': message.encode("utf-8")}
+
+        # logger.debug("Ifttt SENDING: %s" % json.dumps(data))
+
+        http_handler.request("POST",
+                             "/trigger/%s/with/key/%s" % (self.event, self.apikey),
+                             headers={'Content-type': "application/json"},
+                             body=json.dumps(data))
+        response = http_handler.getresponse()
+        request_status = response.status
+        # logger.debug(u"Ifttt response status: %r" % request_status)
+        # logger.debug(u"Ifttt response headers: %r" % response.getheaders())
+        # logger.debug(u"Ifttt response body: %r" % response.read())
+
+        if request_status == 200:
+                logger.info(u"Ifttt notifications sent.")
+                return True
+        elif request_status >= 400 and request_status < 500:
+                logger.info(u"Ifttt request failed: %s" % response.reason)
+                return False
+        else:
+                logger.info(u"Ifttt notification failed serverside.")
+                return False
+
+    def test(self):
+        return self.notify('PlexPy', 'Test Message')
+
+    def return_config_options(self):
+        config_option = [{'label': 'Ifttt Maker Channel Key',
+                          'value': self.apikey,
+                          'name': 'ifttt_key',
+                          'description': 'Your Ifttt  key. You can get a key from <a href="https://ifttt.com/maker" target="_blank">here</a>.',
+                          'input_type': 'text'
+                          },
+                         {'label': 'Ifttt Event',
+                          'value': self.event,
+                          'name': 'ifttt_event',
+                          'description': 'The Ifttt maker event to fire. The notification subject and body will be sent'
+                                         ' as value1 and value2 respectively.',
+                          'input_type': 'text'
+                          },
+                         {'label': 'Test Event',
+                           'value': 'Test Event',
+                           'name': 'testIFTTT',
+                           'description': 'Test if IFTTT notifications are working. See logs for troubleshooting.',
+                           'input_type': 'button'
+                          }
+                         ]
+
+        return config_option
+
+class TELEGRAM(object):
+
+    def __init__(self):
+        self.enabled = plexpy.CONFIG.TELEGRAM_ENABLED
+        self.bot_token = plexpy.CONFIG.TELEGRAM_BOT_TOKEN
+        self.chat_id = plexpy.CONFIG.TELEGRAM_CHAT_ID
+
+    def conf(self, options):
+        return cherrypy.config['config'].get('Telegram', options)
+
+    def notify(self, message, event):
+        if not message or not event:
+            return
+
+        http_handler = HTTPSConnection("api.telegram.org")
+
+        data = {'chat_id': self.chat_id,
+                'text': event.encode('utf-8') + ': ' + message.encode("utf-8")}
+
+        http_handler.request("POST",
+                                "/bot%s/%s" % (self.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"Telegram notifications sent.")
+                return True
+        elif request_status >= 400 and request_status < 500:
+                logger.info(u"Telegram request failed: %s" % response.reason)
+                return False
+        else:
+                logger.info(u"Telegram notification failed serverside.")
+                return False
+
+    def updateLibrary(self):
+        #For uniformity reasons not removed
+        return
+
+    def test(self, bot_token, chat_id):
+        self.enabled = True
+        self.bot_token = bot_token
+        self.chat_id = chat_id
+
+        self.notify('Main Screen Activate', 'Test Message')
+
+    def return_config_options(self):
+        config_option = [{'label': 'Telegram Bot Token',
+                          'value': self.bot_token,
+                          'name': 'telegram_bot_token',
+                          'description': 'Your Telegram bot token. Contact <a href="http://telegram.me/BotFather" target="_blank">@BotFather</a> on Telegram to get one.',
+                          'input_type': 'text'
+                          },
+                         {'label': 'Telegram Chat ID',
+                          'value': self.chat_id,
+                          'name': 'telegram_chat_id',
+                          'description': 'Your Telegram Chat ID, Group ID, or channel username. Contact <a href="http://telegram.me/myidbot" target="_blank">@myidbot</a> on Telegram to get an ID.',
+                          'input_type': 'text'
+                          }
+                         ]
+
+        return config_option

plexpy/plextv.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
 # This file is part of PlexPy.
 #
 #  PlexPy is free software: you can redistribute it and/or modify
@@ -14,12 +17,14 @@
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
 from plexpy import logger, helpers, users, http_handler, database
-
+import xmltodict
+import json
 from xml.dom import minidom
 
 import base64
 import plexpy
 
+
 def refresh_users():
     logger.info("Requesting users list refresh...")
     result = PlexTV().get_full_users_list()
@@ -54,6 +59,7 @@ def refresh_users():
     else:
         logger.warn("Unable to refresh users list.")
 
+
 def get_real_pms_url():
     logger.info("Requesting URLs for server...")
 
@@ -91,6 +97,7 @@ def get_real_pms_url():
         plexpy.CONFIG.__setattr__('PMS_URL', fallback_url)
         plexpy.CONFIG.write()
 
+
 class PlexTV(object):
     """
     Plex.tv authentication
@@ -133,7 +140,7 @@ class PlexTV(object):
         if plextv_response:
             xml_head = plextv_response.getElementsByTagName('user')
             if not xml_head:
-                logger.warn("Error parsing XML for Plex.tv token: %s" % e)
+                logger.warn("Error parsing XML for Plex.tv token")
                 return []
 
             auth_token = xml_head[0].getAttribute('authenticationToken')
@@ -335,13 +342,13 @@ class PlexTV(object):
 
                         rating_key = clean_uri.rpartition('%2F')[-1]
 
-                        sync_details = {"device_name": device_name,
-                                        "platform": device_platform,
-                                        "username": device_username,
-                                        "friendly_name": device_friendly_name,
+                        sync_details = {"device_name": helpers.sanitize(device_name),
+                                        "platform": helpers.sanitize(device_platform),
+                                        "username": helpers.sanitize(device_username),
+                                        "friendly_name": helpers.sanitize(device_friendly_name),
                                         "user_id": device_user_id,
-                                        "root_title": sync_root_title,
-                                        "title": sync_title,
+                                        "root_title": helpers.sanitize(sync_root_title),
+                                        "title": helpers.sanitize(sync_title),
                                         "metadata_type": sync_metadata_type,
                                         "content_type": sync_content_type,
                                         "rating_key": rating_key,
@@ -401,4 +408,58 @@ class PlexTV(object):
 
                     server_urls.append(server_details)
 
-        return server_urls
+        return server_urls
+
+    def discover(self):
+        """ Query plex for all servers online. Returns the ones you own in a selectize format """
+        result = self.get_plextv_resources(include_https=True, output_format='raw')
+        servers = xmltodict.parse(result, process_namespaces=True, attr_prefix='')
+        clean_servers = []
+
+        try:
+            if servers:
+                # Fix if its only one "device"
+                if int(servers['MediaContainer']['size']) == 1:
+                    servers['MediaContainer']['Device'] = [servers['MediaContainer']['Device']]
+
+                for server in servers['MediaContainer']['Device']:
+                    # Only grab servers online and own
+                    if server.get('presence', None) == '1' and server.get('owned', None) == '1' and server.get('provides', None) == 'server':
+                        # If someone only has one connection..
+                        if isinstance(server['Connection'], dict):
+                            server['Connection'] = [server['Connection']]
+
+                        for s in server['Connection']:
+                            # to avoid circular ref
+                            d = {}
+                            d.update(s)
+                            d.update(server)
+                            d['label'] = d['name']
+                            d['value'] = d['address']
+                            del d['Connection']
+                            clean_servers.append(d)
+
+        except Exception as e:
+            logger.warn('Failed to get servers from plex %s' % e)
+            return clean_servers
+
+        return json.dumps(clean_servers, indent=4)
+
+    def get_server_times(self):
+        servers = self.get_plextv_server_list(output_format='xml')
+        server_times = []
+
+        try:
+            xml_head = servers.getElementsByTagName('Server')
+        except:
+            logger.warn("Error parsing XML for Plex servers.")
+            return []
+
+        for a in xml_head:
+            if helpers.get_xml_attr(a, 'machineIdentifier') == plexpy.CONFIG.PMS_IDENTIFIER:
+                server_times.append({"created_at": helpers.get_xml_attr(a, 'createdAt'),
+                                     "updated_at": helpers.get_xml_attr(a, 'updatedAt')
+                                     })
+                break
+
+        return server_times

plexpy/plexwatch_import.py

@@ -1,4 +1,4 @@
-# This file is part of PlexPy.
+# 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
@@ -15,7 +15,7 @@
 
 import sqlite3
 
-from plexpy import logger, helpers, monitor, users, plextv
+from plexpy import logger, helpers, activity_pinger, activity_processor, users, plextv
 from xml.dom import minidom
 
 import plexpy
@@ -245,9 +245,12 @@ def import_from_plexwatch(database=None, table_name=None, import_ignore_interval
     logger.debug(u"PlexPy Importer :: PlexWatch data import in progress...")
 
     logger.debug(u"PlexPy Importer :: Disabling monitoring while import in progress.")
-    plexpy.schedule_job(monitor.check_active_sessions, 'Check for active sessions', hours=0, minutes=0, seconds=0)
+    plexpy.schedule_job(activity_pinger.check_active_sessions, 'Check for active sessions',
+                        hours=0, minutes=0, seconds=0)
+    plexpy.schedule_job(activity_pinger.check_recently_added, 'Check for recently added items',
+                        hours=0, minutes=0, seconds=0)
 
-    monitor_processing = monitor.MonitorProcessing()
+    ap = activity_processor.ActivityProcessor()
     user_data = users.Users()
 
     # Get the latest friends list so we can pull user id's
@@ -289,10 +292,15 @@ def import_from_plexwatch(database=None, table_name=None, import_ignore_interval
 
         # If we get back None from our xml extractor skip over the record and log error.
         if not extracted_xml:
-            logger.error(u"PlexPy Importer :: Skipping line with ratingKey %s due to malformed xml."
+            logger.error(u"PlexPy Importer :: Skipping record with ratingKey %s due to malformed xml."
                          % str(row['rating_key']))
             continue
 
+        # Skip line if we don't have a ratingKey to work with
+        if not row['rating_key']:
+            logger.error(u"PlexPy Importer :: Skipping record due to null ratingRey.")
+            continue
+
         # If the user_id no longer exists in the friends list, pull it from the xml.
         if user_data.get_user_id(user=row['user']):
             user_id = user_data.get_user_id(user=row['user'])
@@ -373,10 +381,10 @@ def import_from_plexwatch(database=None, table_name=None, import_ignore_interval
         # On older versions of PMS, "clip" items were still classified as "movie" and had bad ratingKey values
         # Just make sure that the ratingKey is indeed an integer
         if session_history_metadata['rating_key'].isdigit():
-            monitor_processing.write_session_history(session=session_history,
-                                                     import_metadata=session_history_metadata,
-                                                     is_import=True,
-                                                     import_ignore_interval=import_ignore_interval)
+            ap.write_session_history(session=session_history,
+                                     import_metadata=session_history_metadata,
+                                     is_import=True,
+                                     import_ignore_interval=import_ignore_interval)
         else:
             logger.debug(u"PlexPy Importer :: Item has bad rating_key: %s" % session_history_metadata['rating_key'])
 

plexpy/pmsconnect.py

@@ -13,11 +13,29 @@
 #  You should have received a copy of the GNU General Public License
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
-from plexpy import logger, helpers, users, http_handler
+from plexpy import logger, helpers, users, http_handler, common
 from urlparse import urlparse
 
 import plexpy
+import urllib2
 
+def get_server_friendly_name():
+    logger.info("Requesting name from server...")
+    server_name = PmsConnect().get_server_pref(pref='FriendlyName')
+    
+    # If friendly name is blank
+    if not server_name:
+        servers_info = PmsConnect().get_servers_info()
+        for server in servers_info:
+            if server['machine_identifier'] == plexpy.CONFIG.PMS_IDENTIFIER:
+                server_name = server['name']
+                break
+    
+    if server_name and server_name != plexpy.CONFIG.PMS_NAME:
+        plexpy.CONFIG.__setattr__('PMS_NAME', server_name)
+        plexpy.CONFIG.write()
+
+    return server_name
 
 class PmsConnect(object):
     """
@@ -72,6 +90,23 @@ class PmsConnect(object):
 
         return request
 
+    """
+    Return metadata for children of the request item.
+
+    Parameters required:    rating_key { Plex ratingKey }
+    Optional parameters:    output_format { dict, json }
+
+    Output: array
+    """
+    def get_metadata_children(self, rating_key='', output_format=''):
+        uri = '/library/metadata/' + rating_key + '/children'
+        request = self.request_handler.make_request(uri=uri,
+                                                    proto=self.protocol,
+                                                    request_type='GET',
+                                                    output_format=output_format)
+
+        return request
+
     """
     Return list of recently added items.
 
@@ -220,6 +255,52 @@ class PmsConnect(object):
         return request
 
     """
+    Return search results.
+
+    Optional parameters:    output_format { dict, json }
+
+    Output: array
+    """
+    def get_search(self, query='', track='', output_format=''):
+        uri = '/search?query=' + urllib2.quote(query.encode('utf8')) + track
+        request = self.request_handler.make_request(uri=uri,
+                                                    proto=self.protocol,
+                                                    request_type='GET',
+                                                    output_format=output_format)
+
+        return request
+
+    """
+    Return account details.
+
+    Optional parameters:    output_format { dict, json }
+
+    Output: array
+    """
+    def get_account(self, output_format=''):
+        uri = '/myplex/account'
+        request = self.request_handler.make_request(uri=uri,
+                                                    proto=self.protocol,
+                                                    request_type='GET',
+                                                    output_format=output_format)
+
+        return request
+
+    """
+    Refresh Plex remote access port mapping.
+
+    Optional parameters:    None
+
+    Output: None
+    """
+    def put_refresh_reachability(self):
+        uri = '/myplex/refreshReachability'
+        request = self.request_handler.make_request(uri=uri,
+                                                    proto=self.protocol,
+                                                    request_type='PUT')
+
+        return request
+    """
     Return processed and validated list of recently added items.
 
     Parameters required:    count { number of results to return }
@@ -247,10 +328,13 @@ class PmsConnect(object):
                 recents_main = a.getElementsByTagName('Directory')
                 for item in recents_main:
                     recent_type = helpers.get_xml_attr(item, 'type')
-                    recent_items = {'type': recent_type,
+                    recent_items = {'media_type': recent_type,
                                     'rating_key': helpers.get_xml_attr(item, 'ratingKey'),
+                                    'parent_rating_key': helpers.get_xml_attr(item, 'parentRatingKey'),
                                     'title': helpers.get_xml_attr(item, 'title'),
                                     'parent_title': helpers.get_xml_attr(item, 'parentTitle'),
+                                    'library_id': helpers.get_xml_attr(item, 'librarySectionID'),
+                                    'library_title': helpers.get_xml_attr(item, 'librarySectionTitle'),
                                     'thumb': helpers.get_xml_attr(item, 'thumb'),
                                     'added_at': helpers.get_xml_attr(item, 'addedAt')
                                     }
@@ -262,10 +346,12 @@ class PmsConnect(object):
                     recent_type = helpers.get_xml_attr(item, 'type')
 
                     if recent_type == 'movie':
-                        recent_items = {'type': recent_type,
+                        recent_items = {'media_type': recent_type,
                                         'rating_key': helpers.get_xml_attr(item, 'ratingKey'),
                                         'title': helpers.get_xml_attr(item, 'title'),
                                         'parent_title': helpers.get_xml_attr(item, 'parentTitle'),
+                                        'library_id': helpers.get_xml_attr(item, 'librarySectionID'),
+                                        'library_title': helpers.get_xml_attr(item, 'librarySectionTitle'),
                                         'year': helpers.get_xml_attr(item, 'year'),
                                         'thumb': helpers.get_xml_attr(item, 'thumb'),
                                         'added_at': helpers.get_xml_attr(item, 'addedAt')
@@ -335,7 +421,7 @@ class PmsConnect(object):
                 directors.append(helpers.get_xml_attr(director, 'tag'))
 
         if metadata_type == 'show':
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'grandparent_title': helpers.get_xml_attr(metadata_main, 'grandparentTitle'),
                         'parent_index': helpers.get_xml_attr(metadata_main, 'parentIndex'),
@@ -367,16 +453,16 @@ class PmsConnect(object):
         elif metadata_type == 'season':
             parent_rating_key = helpers.get_xml_attr(metadata_main, 'parentRatingKey')
             show_details = self.get_metadata_details(parent_rating_key)
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'parent_rating_key': helpers.get_xml_attr(metadata_main, 'parentRatingKey'),
                         'grandparent_title': helpers.get_xml_attr(metadata_main, 'grandparentTitle'),
                         'parent_index': helpers.get_xml_attr(metadata_main, 'parentIndex'),
                         'parent_title': helpers.get_xml_attr(metadata_main, 'parentTitle'),
                         'index': helpers.get_xml_attr(metadata_main, 'index'),
-                        'studio': helpers.get_xml_attr(metadata_main, 'studio'),
+                        'studio': show_details['metadata']['studio'],
                         'title': helpers.get_xml_attr(metadata_main, 'title'),
-                        'content_rating': helpers.get_xml_attr(metadata_main, 'contentRating'),
+                        'content_rating': show_details['metadata']['content_rating'],
                         'summary': show_details['metadata']['summary'],
                         'tagline': helpers.get_xml_attr(metadata_main, 'tagline'),
                         'rating': helpers.get_xml_attr(metadata_main, 'rating'),
@@ -391,14 +477,16 @@ class PmsConnect(object):
                         'updated_at': helpers.get_xml_attr(metadata_main, 'updatedAt'),
                         'last_viewed_at': helpers.get_xml_attr(metadata_main, 'lastViewedAt'),
                         'guid': helpers.get_xml_attr(metadata_main, 'guid'),
-                        'genres': genres,
-                        'actors': actors,
-                        'writers': writers,
-                        'directors': directors
+                        'genres': show_details['metadata']['genres'],
+                        'actors': show_details['metadata']['actors'],
+                        'writers': show_details['metadata']['writers'],
+                        'directors': show_details['metadata']['directors']
                         }
             metadata_list = {'metadata': metadata}
         elif metadata_type == 'episode':
-            metadata = {'type': metadata_type,
+            grandparent_rating_key = helpers.get_xml_attr(metadata_main, 'grandparentRatingKey')
+            show_details = self.get_metadata_details(grandparent_rating_key)
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'parent_rating_key': helpers.get_xml_attr(metadata_main, 'parentRatingKey'),
                         'grandparent_rating_key': helpers.get_xml_attr(metadata_main, 'grandparentRatingKey'),
@@ -406,7 +494,7 @@ class PmsConnect(object):
                         'parent_index': helpers.get_xml_attr(metadata_main, 'parentIndex'),
                         'parent_title': helpers.get_xml_attr(metadata_main, 'parentTitle'),
                         'index': helpers.get_xml_attr(metadata_main, 'index'),
-                        'studio': helpers.get_xml_attr(metadata_main, 'studio'),
+                        'studio': show_details['metadata']['studio'],
                         'title': helpers.get_xml_attr(metadata_main, 'title'),
                         'content_rating': helpers.get_xml_attr(metadata_main, 'contentRating'),
                         'summary': helpers.get_xml_attr(metadata_main, 'summary'),
@@ -423,14 +511,14 @@ class PmsConnect(object):
                         'updated_at': helpers.get_xml_attr(metadata_main, 'updatedAt'),
                         'last_viewed_at': helpers.get_xml_attr(metadata_main, 'lastViewedAt'),
                         'guid': helpers.get_xml_attr(metadata_main, 'guid'),
+                        'genres': show_details['metadata']['genres'],
+                        'actors': show_details['metadata']['actors'],
                         'writers': writers,
-                        'directors': directors,
-                        'genres': genres,
-                        'actors': actors
+                        'directors': directors
                         }
             metadata_list = {'metadata': metadata}
         elif metadata_type == 'movie':
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'grandparent_title': helpers.get_xml_attr(metadata_main, 'grandparentTitle'),
                         'parent_index': helpers.get_xml_attr(metadata_main, 'parentIndex'),
@@ -460,7 +548,7 @@ class PmsConnect(object):
                         }
             metadata_list = {'metadata': metadata}
         elif metadata_type == 'artist':
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'grandparent_title': helpers.get_xml_attr(metadata_main, 'grandparentTitle'),
                         'parent_index': helpers.get_xml_attr(metadata_main, 'parentIndex'),
@@ -492,7 +580,7 @@ class PmsConnect(object):
         elif metadata_type == 'album':
             parent_rating_key = helpers.get_xml_attr(metadata_main, 'parentRatingKey')
             artist_details = self.get_metadata_details(parent_rating_key)
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'parent_rating_key': helpers.get_xml_attr(metadata_main, 'parentRatingKey'),
                         'grandparent_title': helpers.get_xml_attr(metadata_main, 'grandparentTitle'),
@@ -525,7 +613,7 @@ class PmsConnect(object):
         elif metadata_type == 'track':
             parent_rating_key = helpers.get_xml_attr(metadata_main, 'parentRatingKey')
             album_details = self.get_metadata_details(parent_rating_key)
-            metadata = {'type': metadata_type,
+            metadata = {'media_type': metadata_type,
                         'rating_key': helpers.get_xml_attr(metadata_main, 'ratingKey'),
                         'parent_rating_key': helpers.get_xml_attr(metadata_main, 'parentRatingKey'),
                         'grandparent_rating_key': helpers.get_xml_attr(metadata_main, 'grandparentRatingKey'),
@@ -550,7 +638,7 @@ class PmsConnect(object):
                         'updated_at': helpers.get_xml_attr(metadata_main, 'updatedAt'),
                         'last_viewed_at': helpers.get_xml_attr(metadata_main, 'lastViewedAt'),
                         'guid': helpers.get_xml_attr(metadata_main, 'guid'),
-                        'genres': genres,
+                        'genres': album_details['metadata']['genres'],
                         'actors': actors,
                         'writers': writers,
                         'directors': directors
@@ -561,6 +649,49 @@ class PmsConnect(object):
 
         return metadata_list
 
+    """
+    Return processed and validated metadata list for all children of requested item.
+
+    Parameters required:    rating_key { Plex ratingKey }
+
+    Output: array
+    """
+    def get_metadata_children_details(self, rating_key=''):
+        metadata = self.get_metadata_children(str(rating_key), output_format='xml')
+
+        try:
+            xml_head = metadata.getElementsByTagName('MediaContainer')
+        except:
+            logger.warn("Unable to parse XML for get_metadata_children.")
+            return []
+
+        metadata_list = []
+
+        for a in xml_head:
+            if a.getAttribute('size'):
+                if a.getAttribute('size') == '0':
+                    metadata_list = {'metadata': None}
+                    return metadata_list
+
+            if a.getElementsByTagName('Video'):
+                metadata_main = a.getElementsByTagName('Video')
+                for item in metadata_main:
+                    child_rating_key = helpers.get_xml_attr(item, 'ratingKey')
+                    metadata = self.get_metadata_details(str(child_rating_key))
+                    if metadata:
+                        metadata_list.append(metadata['metadata'])
+
+            elif a.getElementsByTagName('Track'):
+                metadata_main = a.getElementsByTagName('Track')
+                for item in metadata_main:
+                    child_rating_key = helpers.get_xml_attr(item, 'ratingKey')
+                    metadata = self.get_metadata_details(str(child_rating_key))
+                    if metadata:
+                        metadata_list.append(metadata['metadata'])
+                    
+        output = {'metadata': metadata_list}
+        return output
+
     """
     Return processed and validated session list.
 
@@ -672,6 +803,7 @@ class PmsConnect(object):
                               'user_id': user_details['user_id'],
                               'friendly_name': user_details['friendly_name'],
                               'user_thumb': user_details['thumb'],
+                              'ip_address': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'address').split(':')[-1],
                               'player': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'title'),
                               'platform': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'platform'),
                               'machine_id': machine_id,
@@ -683,7 +815,7 @@ class PmsConnect(object):
                               'parent_rating_key': helpers.get_xml_attr(session, 'parentRatingKey'),
                               'grandparent_rating_key': helpers.get_xml_attr(session, 'grandparentRatingKey'),
                               'throttled': throttled,
-                              'transcode_progress': transcode_progress,
+                              'transcode_progress': int(round(helpers.cast_to_float(transcode_progress), 0)),
                               'transcode_speed': str(round(helpers.cast_to_float(transcode_speed), 1)),
                               'audio_decision': audio_decision,
                               'audio_channels': audio_channels,
@@ -705,9 +837,9 @@ class PmsConnect(object):
                               'transcode_container': transcode_container,
                               'transcode_protocol': transcode_protocol,
                               'duration': duration,
-                              'progress': progress,
+                              'view_offset': progress,
                               'progress_percent': str(helpers.get_percent(progress, duration)),
-                              'type': 'track',
+                              'media_type': 'track',
                               'indexes': 0
                               }
 
@@ -792,6 +924,7 @@ class PmsConnect(object):
                                   'user_id': user_details['user_id'],
                                   'friendly_name': user_details['friendly_name'],
                                   'user_thumb': user_details['thumb'],
+                                  'ip_address': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'address').split(':')[-1],
                                   'player': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'title'),
                                   'platform': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'platform'),
                                   'machine_id': machine_id,
@@ -804,7 +937,7 @@ class PmsConnect(object):
                                   'parent_rating_key': helpers.get_xml_attr(session, 'parentRatingKey'),
                                   'grandparent_rating_key': helpers.get_xml_attr(session, 'grandparentRatingKey'),
                                   'throttled': throttled,
-                                  'transcode_progress': transcode_progress,
+                                  'transcode_progress': int(round(helpers.cast_to_float(transcode_progress), 0)),
                                   'transcode_speed': str(round(helpers.cast_to_float(transcode_speed), 1)),
                                   'audio_decision': audio_decision,
                                   'audio_channels': audio_channels,
@@ -826,14 +959,14 @@ class PmsConnect(object):
                                   'transcode_container': transcode_container,
                                   'transcode_protocol': transcode_protocol,
                                   'duration': duration,
-                                  'progress': progress,
+                                  'view_offset': progress,
                                   'progress_percent': str(helpers.get_percent(progress, duration)),
                                   'indexes': use_indexes
                                   }
                 if helpers.get_xml_attr(session, 'ratingKey').isdigit():
-                    session_output['type'] = helpers.get_xml_attr(session, 'type')
+                    session_output['media_type'] = helpers.get_xml_attr(session, 'type')
                 else:
-                    session_output['type'] = 'clip'
+                    session_output['media_type'] = 'clip'
 
             elif helpers.get_xml_attr(session, 'type') == 'movie':
                 session_output = {'session_key': helpers.get_xml_attr(session, 'sessionKey'),
@@ -848,6 +981,7 @@ class PmsConnect(object):
                                   'user_id': user_details['user_id'],
                                   'friendly_name': user_details['friendly_name'],
                                   'user_thumb': user_details['thumb'],
+                                  'ip_address': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'address').split(':')[-1],
                                   'player': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'title'),
                                   'platform': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'platform'),
                                   'machine_id': machine_id,
@@ -860,7 +994,7 @@ class PmsConnect(object):
                                   'parent_rating_key': helpers.get_xml_attr(session, 'parentRatingKey'),
                                   'grandparent_rating_key': helpers.get_xml_attr(session, 'grandparentRatingKey'),
                                   'throttled': throttled,
-                                  'transcode_progress': transcode_progress,
+                                  'transcode_progress': int(round(helpers.cast_to_float(transcode_progress), 0)),
                                   'transcode_speed': str(round(helpers.cast_to_float(transcode_speed), 1)),
                                   'audio_decision': audio_decision,
                                   'audio_channels': audio_channels,
@@ -882,14 +1016,14 @@ class PmsConnect(object):
                                   'transcode_container': transcode_container,
                                   'transcode_protocol': transcode_protocol,
                                   'duration': duration,
-                                  'progress': progress,
+                                  'view_offset': progress,
                                   'progress_percent': str(helpers.get_percent(progress, duration)),
                                   'indexes': use_indexes
                                   }
                 if helpers.get_xml_attr(session, 'ratingKey').isdigit():
-                    session_output['type'] = helpers.get_xml_attr(session, 'type')
+                    session_output['media_type'] = helpers.get_xml_attr(session, 'type')
                 else:
-                    session_output['type'] = 'clip'
+                    session_output['media_type'] = 'clip'
 
             elif helpers.get_xml_attr(session, 'type') == 'clip':
                 session_output = {'session_key': helpers.get_xml_attr(session, 'sessionKey'),
@@ -904,6 +1038,7 @@ class PmsConnect(object):
                                   'user_id': user_details['user_id'],
                                   'friendly_name': user_details['friendly_name'],
                                   'user_thumb': user_details['thumb'],
+                                  'ip_address': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'address').split(':')[-1],
                                   'player': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'title'),
                                   'platform': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'platform'),
                                   'machine_id': machine_id,
@@ -916,7 +1051,7 @@ class PmsConnect(object):
                                   'parent_rating_key': helpers.get_xml_attr(session, 'parentRatingKey'),
                                   'grandparent_rating_key': helpers.get_xml_attr(session, 'grandparentRatingKey'),
                                   'throttled': throttled,
-                                  'transcode_progress': transcode_progress,
+                                  'transcode_progress': int(round(helpers.cast_to_float(transcode_progress), 0)),
                                   'transcode_speed': str(round(helpers.cast_to_float(transcode_speed), 1)),
                                   'audio_decision': audio_decision,
                                   'audio_channels': audio_channels,
@@ -938,9 +1073,9 @@ class PmsConnect(object):
                                   'transcode_container': transcode_container,
                                   'transcode_protocol': transcode_protocol,
                                   'duration': duration,
-                                  'progress': progress,
+                                  'view_offset': progress,
                                   'progress_percent': str(helpers.get_percent(progress, duration)),
-                                  'type': helpers.get_xml_attr(session, 'type'),
+                                  'media_type': helpers.get_xml_attr(session, 'type'),
                                   'indexes': 0
                                   }
 
@@ -993,6 +1128,7 @@ class PmsConnect(object):
                               'user_id': user_details['user_id'],
                               'friendly_name': user_details['friendly_name'],
                               'user_thumb': user_details['thumb'],
+                              'ip_address': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'address').split(':')[-1],
                               'player': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'title'),
                               'platform': helpers.get_xml_attr(session.getElementsByTagName('Player')[0], 'platform'),
                               'machine_id': machine_id,
@@ -1005,7 +1141,7 @@ class PmsConnect(object):
                               'parent_rating_key': helpers.get_xml_attr(session, 'parentRatingKey'),
                               'grandparent_rating_key': helpers.get_xml_attr(session, 'grandparentRatingKey'),
                               'throttled': throttled,
-                              'transcode_progress': transcode_progress,
+                              'transcode_progress': int(round(helpers.cast_to_float(transcode_progress), 0)),
                               'transcode_speed': str(round(helpers.cast_to_float(transcode_speed), 1)),
                               'audio_decision': '',
                               'audio_channels': '',
@@ -1027,15 +1163,19 @@ class PmsConnect(object):
                               'transcode_container': transcode_container,
                               'transcode_protocol': transcode_protocol,
                               'duration': '',
-                              'progress': '',
+                              'view_offset': '',
                               'progress_percent': '100',
-                              'type': 'photo',
+                              'media_type': 'photo',
                               'indexes': 0
                               }
 
         else:
             logger.warn(u"No known stream types found in session list.")
 
+        # Rename Mystery platform names
+        session_output['platform'] = common.PLATFORM_NAME_OVERRIDES.get(session_output['platform'],
+                                                                        session_output['platform'])
+
         return session_output
 
     """
@@ -1083,7 +1223,6 @@ class PmsConnect(object):
                                       }
                     children_list.append(children_output)
 
-
         output = {'children_count': helpers.get_xml_attr(xml_head[0], 'size'),
                   'children_type': helpers.get_xml_attr(xml_head[0], 'viewGroup'),
                   'title': helpers.get_xml_attr(xml_head[0], 'title2'),
@@ -1208,7 +1347,7 @@ class PmsConnect(object):
                   'title': helpers.get_xml_attr(xml_head[0], 'title1'),
                   'libraries_list': libraries_list
                   }
-
+        
         return output
 
     """
@@ -1270,11 +1409,11 @@ class PmsConnect(object):
         return output
 
     """
-    Return processed and validated server statistics.
+    Return processed and validated library statistics.
 
     Output: array
     """
-    def get_library_stats(self):
+    def get_library_stats(self, library_cards=''):
         server_libraries = self.get_server_children()
 
         server_library_stats = []
@@ -1285,7 +1424,10 @@ class PmsConnect(object):
             for library in libraries_list:
                 library_type = library['type']
                 section_key = library['key']
-                library_list = self.get_library_children(library_type, section_key)
+                if section_key in library_cards:
+                    library_list = self.get_library_children(library_type, section_key)
+                else:
+                    continue
 
                 if library_list['library_count'] != '0':
                     library_stats = {'title': library['title'],
@@ -1338,3 +1480,224 @@ class PmsConnect(object):
         else:
             logger.error("Image proxy queries but no input received.")
             return None
+
+    """
+    Return processed list of search results.
+
+    Output: array
+    """
+    def get_search_results(self, query=''):
+        search_results = self.get_search(query=query, output_format='xml')
+        search_results_tracks = self.get_search(query=query, track='&type=10', output_format='xml')
+
+        xml_head = []
+        try:
+            try:
+                xml_head += search_results.getElementsByTagName('MediaContainer')
+            except:
+                pass
+            try:
+                xml_head += search_results_tracks.getElementsByTagName('MediaContainer')
+            except:
+                pass
+        except:
+            logger.warn("Unable to parse XML for get_search_result_details.")
+            return []
+        
+        search_results_count = 0
+        search_results_list = {'movie': [],
+                               'show': [],
+                               'season': [],
+                               'episode': [],
+                               'artist': [],
+                               'album': [],
+                               'track': []
+                               }
+
+        totalSize = 0
+        for a in xml_head:
+            if a.getAttribute('size'):
+                totalSize += int(a.getAttribute('size'))
+        if totalSize == 0:
+            logger.debug(u"No search results.")
+            search_results_list = {'results_count': search_results_count,
+                                    'results_list': []
+                                    }
+            return search_results_list
+
+        for a in xml_head:
+            if a.getElementsByTagName('Video'):
+                result_data = a.getElementsByTagName('Video')
+                for result in result_data:
+                    rating_key = helpers.get_xml_attr(result, 'ratingKey')
+                    metadata = self.get_metadata_details(rating_key=rating_key)
+                    if metadata['metadata']['media_type'] == 'movie':
+                        search_results_list['movie'].append(metadata['metadata'])
+                    elif metadata['metadata']['media_type'] == 'episode':
+                        search_results_list['episode'].append(metadata['metadata'])
+                    search_results_count += 1
+
+            if a.getElementsByTagName('Directory'):
+                result_data = a.getElementsByTagName('Directory')
+                for result in result_data:
+                    rating_key = helpers.get_xml_attr(result, 'ratingKey')
+                    metadata = self.get_metadata_details(rating_key=rating_key)
+                    if metadata['metadata']['media_type'] == 'show':
+                        search_results_list['show'].append(metadata['metadata'])
+
+                        show_seasons = self.get_item_children(rating_key=metadata['metadata']['rating_key'])
+                        if show_seasons['children_count'] != '0':
+                            for season in show_seasons['children_list']:
+                                if season['rating_key']:
+                                    rating_key = season['rating_key']
+                                    metadata = self.get_metadata_details(rating_key=rating_key)
+                                    search_results_list['season'].append(metadata['metadata'])
+                                    search_results_count += 1
+
+                    elif metadata['metadata']['media_type'] == 'artist':
+                        search_results_list['artist'].append(metadata['metadata'])
+                    elif metadata['metadata']['media_type'] == 'album':
+                        search_results_list['album'].append(metadata['metadata'])
+                    search_results_count += 1
+
+            if a.getElementsByTagName('Track'):
+                result_data = a.getElementsByTagName('Track')
+                for result in result_data:
+                    rating_key = helpers.get_xml_attr(result, 'ratingKey')
+                    metadata = self.get_metadata_details(rating_key=rating_key)
+                    search_results_list['track'].append(metadata['metadata'])
+                    search_results_count += 1
+
+        output = {'results_count': search_results_count,
+                  'results_list': search_results_list
+                  }
+
+        return output
+
+    """
+    Return processed list of grandparent/parent/child rating keys.
+
+    Output: array
+    """
+    def get_rating_keys_list(self, rating_key='', media_type=''):
+
+        if media_type == 'movie':
+            key_list = {0: {'rating_key': int(rating_key)}}
+            return key_list
+
+        if media_type == 'artist' or media_type == 'album' or media_type == 'track':
+            match_type = 'title'
+        else:
+            match_type = 'index'
+        
+        # get grandparent rating key
+        if media_type == 'season' or media_type == 'album':
+            try:
+                metadata = self.get_metadata_details(rating_key=rating_key)
+                rating_key = metadata['metadata']['parent_rating_key']
+            except:
+                logger.warn("Unable to get parent_rating_key for get_rating_keys_list.")
+                return {}
+
+        elif media_type == 'episode' or media_type == 'track':
+            try:
+                metadata = self.get_metadata_details(rating_key=rating_key)
+                rating_key = metadata['metadata']['grandparent_rating_key']
+            except:
+                logger.warn("Unable to get grandparent_rating_key for get_rating_keys_list.")
+                return {}
+
+        # get parent_rating_keys
+        metadata = self.get_metadata_children(str(rating_key), output_format='xml')
+
+        try:
+            xml_head = metadata.getElementsByTagName('MediaContainer')
+        except:
+            logger.warn("Unable to parse XML for get_rating_keys_list.")
+            return {}
+
+        for a in xml_head:
+            if a.getAttribute('size'):
+                if a.getAttribute('size') == '0':
+                    return {}
+            
+            title = helpers.get_xml_attr(a, 'title2')
+
+            if a.getElementsByTagName('Directory'):
+                parents_metadata = a.getElementsByTagName('Directory')
+            else:
+                parents_metadata = []
+
+            parents = {}
+            for item in parents_metadata:
+                parent_rating_key = helpers.get_xml_attr(item, 'ratingKey')
+                parent_index = helpers.get_xml_attr(item, 'index')
+                parent_title = helpers.get_xml_attr(item, 'title')
+
+                if parent_rating_key:
+                    # get rating_keys
+                    metadata = self.get_metadata_children(str(parent_rating_key), output_format='xml')
+
+                    try:
+                        xml_head = metadata.getElementsByTagName('MediaContainer')
+                    except:
+                        logger.warn("Unable to parse XML for get_rating_keys_list.")
+                        return {}
+
+                    for a in xml_head:
+                        if a.getAttribute('size'):
+                            if a.getAttribute('size') == '0':
+                                return {}
+
+                        if a.getElementsByTagName('Video'):
+                            children_metadata = a.getElementsByTagName('Video')
+                        elif a.getElementsByTagName('Track'):
+                            children_metadata = a.getElementsByTagName('Track')
+                        else:
+                            children_metadata = []
+
+                        children = {}
+                        for item in children_metadata:
+                            child_rating_key = helpers.get_xml_attr(item, 'ratingKey')
+                            child_index = helpers.get_xml_attr(item, 'index')
+                            child_title = helpers.get_xml_attr(item, 'title')
+
+                            if child_rating_key:
+                                key = int(child_index)
+                                children.update({key: {'rating_key': int(child_rating_key)}})
+                    
+                    key = int(parent_index) if match_type == 'index' else parent_title
+                    parents.update({key: 
+                                {'rating_key': int(parent_rating_key),
+                                'children': children}
+                                })
+        
+        key = 0 if match_type == 'index' else title
+        key_list = {key:
+                    {'rating_key': int(rating_key),
+                     'children': parents}
+                    }
+
+        return key_list
+
+    def get_server_response(self):
+        # Refresh Plex remote access port mapping first
+        self.put_refresh_reachability()
+        account_data = self.get_account(output_format='xml')
+        
+        try:
+            xml_head = account_data.getElementsByTagName('MyPlex')
+        except:
+            logger.warn("Unable to parse XML for get_server_response.")
+            return None
+        
+        server_response = {}
+
+        for a in xml_head:
+            server_response = {'mapping_state': helpers.get_xml_attr(a, 'mappingState'),
+                               'mapping_error': helpers.get_xml_attr(a, 'mappingError'),
+                               'public_address': helpers.get_xml_attr(a, 'publicAddress'),
+                               'public_port': helpers.get_xml_attr(a, 'publicPort')
+                               }
+        
+        return server_response

plexpy/users.py

@@ -24,6 +24,8 @@ class Users(object):
     def get_user_list(self, kwargs=None):
         data_tables = datatables.DataTables()
 
+        custom_where = ['users.deleted_user', 0]
+
         columns = ['session_history.id',
                    'users.user_id as user_id',
                    'users.custom_avatar_url as user_thumb',
@@ -32,7 +34,8 @@ class Users(object):
                    'MAX(session_history.started) as last_seen',
                    'session_history.ip_address as ip_address',
                    'COUNT(session_history.id) as plays',
-                   'session_history.player as platform',
+                   'session_history.platform as platform',
+                   'session_history.player as player',
                    'session_history_metadata.full_title as last_watched',
                    'session_history_metadata.thumb',
                    'session_history_metadata.parent_thumb',
@@ -47,7 +50,7 @@ class Users(object):
         try:
             query = data_tables.ssp_query(table_name='users',
                                           columns=columns,
-                                          custom_where=[],
+                                          custom_where=[custom_where],
                                           group_by=['users.user_id'],
                                           join_types=['LEFT OUTER JOIN',
                                                       'LEFT OUTER JOIN',
@@ -83,12 +86,16 @@ class Users(object):
             else:
                 user_thumb = item['user_thumb']
 
+            # Rename Mystery platform names
+            platform = common.PLATFORM_NAME_OVERRIDES.get(item["platform"], item["platform"])
+
             row = {"id": item['id'],
                    "plays": item['plays'],
                    "last_seen": item['last_seen'],
                    "friendly_name": item['friendly_name'],
                    "ip_address": item['ip_address'],
-                   "platform": item['platform'],
+                   "platform": platform,
+                   "player": item["player"],
                    "last_watched": item['last_watched'],
                    "thumb": thumb,
                    "media_type": item['media_type'],
@@ -121,7 +128,8 @@ class Users(object):
                    'session_history.started as last_seen',
                    'session_history.ip_address as ip_address',
                    'COUNT(session_history.id) as play_count',
-                   'session_history.player as platform',
+                   'session_history.platform as platform',
+                   'session_history.player as player',
                    'session_history_metadata.full_title as last_watched',
                    'session_history_metadata.thumb',
                    'session_history_metadata.parent_thumb',
@@ -169,11 +177,15 @@ class Users(object):
             else:
                 thumb = item["thumb"]
 
+            # Rename Mystery platform names
+            platform = common.PLATFORM_NAME_OVERRIDES.get(item["platform"], item["platform"])
+
             row = {"id": item['id'],
                    "last_seen": item['last_seen'],
                    "ip_address": item['ip_address'],
                    "play_count": item['play_count'],
-                   "platform": item['platform'],
+                   "platform": platform,
+                   "player": item['player'],
                    "last_watched": item['last_watched'],
                    "thumb": thumb,
                    "media_type": item['media_type'],
@@ -253,17 +265,17 @@ class Users(object):
         if user_id:
             monitor_db = database.MonitorDatabase()
             query = 'select username, ' \
-                    '(CASE WHEN friendly_name IS NULL THEN username ELSE friendly_name END),' \
+                    '(CASE WHEN friendly_name IS NULL THEN username ELSE friendly_name END) as friendly_name,' \
                     'do_notify, keep_history, custom_avatar_url as thumb ' \
                     'FROM users WHERE user_id = ?'
             result = monitor_db.select(query, args=[user_id])
             if result:
                 user_detail = {'user_id': user_id,
-                               'user': result[0][0],
-                               'friendly_name': result[0][1],
-                               'thumb': result[0][4],
-                               'do_notify': helpers.checked(result[0][2]),
-                               'keep_history': helpers.checked(result[0][3])
+                               'user': result[0]['username'],
+                               'friendly_name': result[0]['friendly_name'],
+                               'thumb': result[0]['thumb'],
+                               'do_notify': helpers.checked(result[0]['do_notify']),
+                               'keep_history': helpers.checked(result[0]['keep_history'])
                                }
                 return user_detail
             else:
@@ -277,17 +289,17 @@ class Users(object):
         elif user:
             monitor_db = database.MonitorDatabase()
             query = 'select user_id, ' \
-                    '(CASE WHEN friendly_name IS NULL THEN username ELSE friendly_name END),' \
+                    '(CASE WHEN friendly_name IS NULL THEN username ELSE friendly_name END) as friendly_name,' \
                     'do_notify, keep_history, custom_avatar_url as thumb  ' \
                     'FROM users WHERE username = ?'
             result = monitor_db.select(query, args=[user])
             if result:
-                user_detail = {'user_id': result[0][0],
+                user_detail = {'user_id': result[0]['user_id'],
                                'user': user,
-                               'friendly_name': result[0][1],
-                               'thumb': result[0][4],
-                               'do_notify': helpers.checked(result[0][2]),
-                               'keep_history': helpers.checked(result[0][3])}
+                               'friendly_name': result[0]['friendly_name'],
+                               'thumb': result[0]['thumb'],
+                               'do_notify': helpers.checked(result[0]['do_notify']),
+                               'keep_history': helpers.checked(result[0]['keep_history'])}
                 return user_detail
             else:
                 user_detail = {'user_id': None,
@@ -307,7 +319,7 @@ class Users(object):
                 query = 'select user_id FROM users WHERE username = ?'
                 result = monitor_db.select_single(query, args=[user])
                 if result:
-                    return result
+                    return result['user_id']
                 else:
                     return None
             except:
@@ -474,9 +486,9 @@ class Users(object):
                 result = monitor_db.select(query, args=[user])
 
             for item in result:
-                if item[0]:
-                    total_time = item[0]
-                    total_plays = item[1]
+                if item['total_time']:
+                    total_time = item['total_time']
+                    total_plays = item['total_plays']
                 else:
                     total_time = 0
                     total_plays = 0
@@ -490,10 +502,10 @@ class Users(object):
 
         return user_watch_time_stats
 
-    def get_user_platform_stats(self, user=None, user_id=None):
+    def get_user_player_stats(self, user=None, user_id=None):
         monitor_db = database.MonitorDatabase()
 
-        platform_stats = []
+        player_stats = []
         result_id = 0
 
         try:
@@ -516,12 +528,15 @@ class Users(object):
             return None
 
         for item in result:
-            row = {'platform_name': item[0],
-                   'platform_type': item[2],
-                   'total_plays': item[1],
+            # Rename Mystery platform names
+            platform_type = common.PLATFORM_NAME_OVERRIDES.get(item['platform'], item['platform'])
+
+            row = {'player_name': item['player'],
+                   'platform_type': platform_type,
+                   'total_plays': item['player_count'],
                    'result_id': result_id
                    }
-            platform_stats.append(row)
+            player_stats.append(row)
             result_id += 1
 
-        return platform_stats
+        return player_stats

plexpy/version.py

@@ -1,2 +1,2 @@
-PLEXPY_VERSION = "master"
-PLEXPY_RELEASE_VERSION = "1.1.9"
+PLEXPY_VERSION = "master"
+PLEXPY_RELEASE_VERSION = "1.2.15"

plexpy/web_socket.py

@@ -0,0 +1,152 @@
+# 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 <http://www.gnu.org/licenses/>.
+
+# Mostly borrowed from https://github.com/trakt/Plex-Trakt-Scrobbler
+
+from plexpy import logger, activity_pinger
+
+import threading
+import plexpy
+import json
+import time
+import websocket
+
+name = 'websocket'
+opcode_data = (websocket.ABNF.OPCODE_TEXT, websocket.ABNF.OPCODE_BINARY)
+
+
+def start_thread():
+    # Check for any existing sessions on start up
+    activity_pinger.check_active_sessions(ws_request=True)
+    # Start the websocket listener on it's own thread
+    threading.Thread(target=run).start()
+
+
+def run():
+    from websocket import create_connection
+
+    uri = 'ws://%s:%s/:/websockets/notifications' % (
+        plexpy.CONFIG.PMS_IP,
+        plexpy.CONFIG.PMS_PORT
+    )
+
+    # Set authentication token (if one is available)
+    if plexpy.CONFIG.PMS_TOKEN:
+        uri += '?X-Plex-Token=' + plexpy.CONFIG.PMS_TOKEN
+
+    ws_connected = False
+    reconnects = 0
+
+    # Try an open the websocket connection - if it fails after 15 retries fallback to polling
+    while not ws_connected and reconnects <= 15:
+        try:
+            logger.info(u'PlexPy WebSocket :: Opening websocket, connection attempt %s.' % str(reconnects + 1))
+            ws = create_connection(uri)
+            reconnects = 0
+            ws_connected = True
+            logger.info(u'PlexPy WebSocket :: Ready')
+        except IOError, e:
+            logger.error(u'PlexPy WebSocket :: %s.' % e)
+            reconnects += 1
+            time.sleep(5)
+
+    while ws_connected:
+        try:
+            process(*receive(ws))
+
+            # successfully received data, reset reconnects counter
+            reconnects = 0
+        except websocket.WebSocketConnectionClosedException:
+            if reconnects <= 15:
+                reconnects += 1
+
+                # Sleep 5 between connection attempts
+                if reconnects > 1:
+                    time.sleep(5)
+
+                logger.warn(u'PlexPy WebSocket :: Connection has closed, reconnecting...')
+                try:
+                    ws = create_connection(uri)
+                except IOError, e:
+                    logger.info(u'PlexPy WebSocket :: %s.' % e)
+
+            else:
+                ws_connected = False
+                break
+
+    if not ws_connected:
+        logger.error(u'PlexPy WebSocket :: Connection unavailable, falling back to polling.')
+        plexpy.POLLING_FAILOVER = True
+        plexpy.initialize_scheduler()
+
+    logger.debug(u'PlexPy WebSocket :: Leaving thread.')
+
+
+def receive(ws):
+    frame = ws.recv_frame()
+
+    if not frame:
+        raise websocket.WebSocketException("Not a valid frame %s" % frame)
+    elif frame.opcode in opcode_data:
+        return frame.opcode, frame.data
+    elif frame.opcode == websocket.ABNF.OPCODE_CLOSE:
+        ws.send_close()
+        return frame.opcode, None
+    elif frame.opcode == websocket.ABNF.OPCODE_PING:
+        ws.pong("Hi!")
+
+    return None, None
+
+
+def process(opcode, data):
+    from plexpy import activity_handler
+
+    if opcode not in opcode_data:
+        return False
+
+    try:
+        info = json.loads(data)
+    except Exception as ex:
+        logger.warn(u'PlexPy WebSocket :: Error decoding message from websocket: %s' % ex)
+        logger.debug(data)
+        return False
+
+    type = info.get('type')
+
+    if not type:
+        return False
+
+    if type == 'playing':
+        # logger.debug('%s.playing %s' % (name, info))
+        try:
+            time_line = info.get('_children')
+        except:
+            logger.debug(u"PlexPy WebSocket :: Session found but unable to get timeline data.")
+            return False
+
+        activity = activity_handler.ActivityHandler(timeline=time_line[0])
+        activity.process()
+
+    #if type == 'timeline':
+    #    try:
+    #        time_line = info.get('_children')
+    #    except:
+    #        logger.debug(u"PlexPy WebSocket :: Timeline event found but unable to get timeline data.")
+    #        return False
+
+    #    activity = activity_handler.TimelineHandler(timeline=time_line[0])
+    #    activity.process()
+
+    return True

plexpy/webserve.py

@@ -13,7 +13,7 @@
 #  You should have received a copy of the GNU General Public License
 #  along with PlexPy.  If not, see <http://www.gnu.org/licenses/>.
 
-from plexpy import logger, notifiers, plextv, pmsconnect, common, log_reader, datafactory, graphs, users
+from plexpy import logger, notifiers, plextv, pmsconnect, common, log_reader, datafactory, graphs, users, helpers
 from plexpy.helpers import checked, radio
 
 from mako.lookup import TemplateLookup
@@ -41,11 +41,13 @@ def serve_template(templatename, **kwargs):
     interface_dir = os.path.join(str(plexpy.PROG_DIR), 'data/interfaces/')
     template_dir = os.path.join(str(interface_dir), plexpy.CONFIG.INTERFACE)
 
-    _hplookup = TemplateLookup(directories=[template_dir])
+    _hplookup = TemplateLookup(directories=[template_dir], default_filters=['unicode', 'h'])
+
+    server_name = plexpy.CONFIG.PMS_NAME
 
     try:
         template = _hplookup.get_template(templatename)
-        return template.render(**kwargs)
+        return template.render(server_name=server_name, **kwargs)
     except:
         return exceptions.html_error_template().render()
 
@@ -66,9 +68,10 @@ class WebInterface(object):
     def home(self):
         config = {
             "home_stats_length": plexpy.CONFIG.HOME_STATS_LENGTH,
-            "home_stats_type": plexpy.CONFIG.HOME_STATS_TYPE,
-            "home_stats_count": plexpy.CONFIG.HOME_STATS_COUNT,
+            "home_stats_cards": plexpy.CONFIG.HOME_STATS_CARDS,
+            "home_library_cards": plexpy.CONFIG.HOME_LIBRARY_CARDS,
             "pms_identifier": plexpy.CONFIG.PMS_IDENTIFIER,
+            "pms_name": plexpy.CONFIG.PMS_NAME
         }
         return serve_template(templatename="index.html", title="Home", config=config)
 
@@ -84,21 +87,22 @@ class WebInterface(object):
             "pms_token": plexpy.CONFIG.PMS_TOKEN,
             "pms_ssl": checked(plexpy.CONFIG.PMS_SSL),
             "pms_uuid": plexpy.CONFIG.PMS_UUID,
-            "tv_notify_enable": checked(plexpy.CONFIG.TV_NOTIFY_ENABLE),
             "movie_notify_enable": checked(plexpy.CONFIG.MOVIE_NOTIFY_ENABLE),
+            "tv_notify_enable": checked(plexpy.CONFIG.TV_NOTIFY_ENABLE),
             "music_notify_enable": checked(plexpy.CONFIG.MUSIC_NOTIFY_ENABLE),
-            "tv_notify_on_start": checked(plexpy.CONFIG.TV_NOTIFY_ON_START),
             "movie_notify_on_start": checked(plexpy.CONFIG.MOVIE_NOTIFY_ON_START),
+            "tv_notify_on_start": checked(plexpy.CONFIG.TV_NOTIFY_ON_START),
             "music_notify_on_start": checked(plexpy.CONFIG.MUSIC_NOTIFY_ON_START),
-            "video_logging_enable": checked(plexpy.CONFIG.VIDEO_LOGGING_ENABLE),
+            "movie_logging_enable": checked(plexpy.CONFIG.MOVIE_LOGGING_ENABLE),
+            "tv_logging_enable": checked(plexpy.CONFIG.TV_LOGGING_ENABLE),
             "music_logging_enable": checked(plexpy.CONFIG.MUSIC_LOGGING_ENABLE),
             "logging_ignore_interval": plexpy.CONFIG.LOGGING_IGNORE_INTERVAL,
             "check_github": checked(plexpy.CONFIG.CHECK_GITHUB)
         }
 
         # The setup wizard just refreshes the page on submit so we must redirect to home if config set.
-        # Also redirecting to home if a PMS token already exists - will remove this in future.
-        if plexpy.CONFIG.FIRST_RUN_COMPLETE or plexpy.CONFIG.PMS_TOKEN:
+        if plexpy.CONFIG.FIRST_RUN_COMPLETE:
+            plexpy.initialize_scheduler()
             raise cherrypy.HTTPRedirect("home")
         else:
             return serve_template(templatename="welcome.html", title="Welcome", config=config)
@@ -121,16 +125,43 @@ class WebInterface(object):
         return json.dumps(formats)
 
     @cherrypy.expose
-    def home_stats(self, time_range='30', stat_type='0', stat_count='5', **kwargs):
+    def home_stats(self, **kwargs):
         data_factory = datafactory.DataFactory()
-        stats_data = data_factory.get_home_stats(time_range=time_range, stat_type=stat_type, stat_count=stat_count)
+
+        grouping = plexpy.CONFIG.GROUP_HISTORY_TABLES
+        time_range = plexpy.CONFIG.HOME_STATS_LENGTH
+        stats_type = plexpy.CONFIG.HOME_STATS_TYPE
+        stats_count = plexpy.CONFIG.HOME_STATS_COUNT
+        stats_cards = plexpy.CONFIG.HOME_STATS_CARDS.split(', ')
+        notify_watched_percent = plexpy.CONFIG.NOTIFY_WATCHED_PERCENT
+
+        stats_data = data_factory.get_home_stats(grouping=grouping,
+                                                 time_range=time_range,
+                                                 stats_type=stats_type,
+                                                 stats_count=stats_count,
+                                                 stats_cards=stats_cards,
+                                                 notify_watched_percent=notify_watched_percent)
 
         return serve_template(templatename="home_stats.html", title="Stats", data=stats_data)
 
     @cherrypy.expose
     def library_stats(self, **kwargs):
         pms_connect = pmsconnect.PmsConnect()
-        stats_data = pms_connect.get_library_stats()
+
+        library_cards = plexpy.CONFIG.HOME_LIBRARY_CARDS.split(', ')
+
+        if library_cards == ['library_statistics_first']:
+            library_cards = ['library_statistics']
+            server_children = pms_connect.get_server_children()
+            server_libraries = server_children['libraries_list']
+
+            for library in server_libraries:
+                library_cards.append(library['key'])
+
+            plexpy.CONFIG.HOME_LIBRARY_CARDS = ', '.join(library_cards)
+            plexpy.CONFIG.write()
+
+        stats_data = pms_connect.get_library_stats(library_cards=library_cards)
 
         return serve_template(templatename="library_stats.html", title="Library Stats", data=stats_data)
 
@@ -144,7 +175,15 @@ class WebInterface(object):
 
     @cherrypy.expose
     def graphs(self):
-        return serve_template(templatename="graphs.html", title="Graphs")
+
+        config = {
+            "graph_type": plexpy.CONFIG.GRAPH_TYPE,
+            "graph_days": plexpy.CONFIG.GRAPH_DAYS,
+            "graph_tab": plexpy.CONFIG.GRAPH_TAB,
+            "music_logging_enable": plexpy.CONFIG.MUSIC_LOGGING_ENABLE
+        }
+
+        return serve_template(templatename="graphs.html", title="Graphs", config=config)
 
     @cherrypy.expose
     def sync(self):
@@ -373,46 +412,7 @@ class WebInterface(object):
             "cache_dir": plexpy.CONFIG.CACHE_DIR,
             "check_github": checked(plexpy.CONFIG.CHECK_GITHUB),
             "interface_list": interface_list,
-            "growl_enabled": checked(plexpy.CONFIG.GROWL_ENABLED),
-            "growl_host": plexpy.CONFIG.GROWL_HOST,
-            "growl_password": plexpy.CONFIG.GROWL_PASSWORD,
-            "prowl_enabled": checked(plexpy.CONFIG.PROWL_ENABLED),
-            "prowl_keys": plexpy.CONFIG.PROWL_KEYS,
-            "prowl_priority": plexpy.CONFIG.PROWL_PRIORITY,
-            "xbmc_enabled": checked(plexpy.CONFIG.XBMC_ENABLED),
-            "xbmc_host": plexpy.CONFIG.XBMC_HOST,
-            "xbmc_username": plexpy.CONFIG.XBMC_USERNAME,
-            "xbmc_password": plexpy.CONFIG.XBMC_PASSWORD,
-            "plex_enabled": checked(plexpy.CONFIG.PLEX_ENABLED),
-            "plex_client_host": plexpy.CONFIG.PLEX_CLIENT_HOST,
-            "plex_username": plexpy.CONFIG.PLEX_USERNAME,
-            "plex_password": plexpy.CONFIG.PLEX_PASSWORD,
-            "nma_enabled": checked(plexpy.CONFIG.NMA_ENABLED),
-            "nma_apikey": plexpy.CONFIG.NMA_APIKEY,
-            "nma_priority": int(plexpy.CONFIG.NMA_PRIORITY),
-            "pushalot_enabled": checked(plexpy.CONFIG.PUSHALOT_ENABLED),
-            "pushalot_apikey": plexpy.CONFIG.PUSHALOT_APIKEY,
-            "pushover_enabled": checked(plexpy.CONFIG.PUSHOVER_ENABLED),
-            "pushover_keys": plexpy.CONFIG.PUSHOVER_KEYS,
-            "pushover_apitoken": plexpy.CONFIG.PUSHOVER_APITOKEN,
-            "pushover_priority": plexpy.CONFIG.PUSHOVER_PRIORITY,
-            "pushbullet_enabled": checked(plexpy.CONFIG.PUSHBULLET_ENABLED),
-            "pushbullet_apikey": plexpy.CONFIG.PUSHBULLET_APIKEY,
-            "pushbullet_deviceid": plexpy.CONFIG.PUSHBULLET_DEVICEID,
-            "twitter_enabled": checked(plexpy.CONFIG.TWITTER_ENABLED),
-            "osx_notify_enabled": checked(plexpy.CONFIG.OSX_NOTIFY_ENABLED),
-            "osx_notify_app": plexpy.CONFIG.OSX_NOTIFY_APP,
-            "boxcar_enabled": checked(plexpy.CONFIG.BOXCAR_ENABLED),
-            "boxcar_token": plexpy.CONFIG.BOXCAR_TOKEN,
             "cache_sizemb": plexpy.CONFIG.CACHE_SIZEMB,
-            "email_enabled": checked(plexpy.CONFIG.EMAIL_ENABLED),
-            "email_from": plexpy.CONFIG.EMAIL_FROM,
-            "email_to": plexpy.CONFIG.EMAIL_TO,
-            "email_smtp_server": plexpy.CONFIG.EMAIL_SMTP_SERVER,
-            "email_smtp_user": plexpy.CONFIG.EMAIL_SMTP_USER,
-            "email_smtp_password": plexpy.CONFIG.EMAIL_SMTP_PASSWORD,
-            "email_smtp_port": int(plexpy.CONFIG.EMAIL_SMTP_PORT),
-            "email_tls": checked(plexpy.CONFIG.EMAIL_TLS),
             "pms_identifier": plexpy.CONFIG.PMS_IDENTIFIER,
             "pms_ip": plexpy.CONFIG.PMS_IP,
             "pms_logs_folder": plexpy.CONFIG.PMS_LOGS_FOLDER,
@@ -421,14 +421,13 @@ class WebInterface(object):
             "pms_ssl": checked(plexpy.CONFIG.PMS_SSL),
             "pms_use_bif": checked(plexpy.CONFIG.PMS_USE_BIF),
             "pms_uuid": plexpy.CONFIG.PMS_UUID,
-            "plexwatch_database": plexpy.CONFIG.PLEXWATCH_DATABASE,
             "date_format": plexpy.CONFIG.DATE_FORMAT,
             "time_format": plexpy.CONFIG.TIME_FORMAT,
             "grouping_global_history": checked(plexpy.CONFIG.GROUPING_GLOBAL_HISTORY),
             "grouping_user_history": checked(plexpy.CONFIG.GROUPING_USER_HISTORY),
             "grouping_charts": checked(plexpy.CONFIG.GROUPING_CHARTS),
-            "tv_notify_enable": checked(plexpy.CONFIG.TV_NOTIFY_ENABLE),
             "movie_notify_enable": checked(plexpy.CONFIG.MOVIE_NOTIFY_ENABLE),
+            "tv_notify_enable": checked(plexpy.CONFIG.TV_NOTIFY_ENABLE),
             "music_notify_enable": checked(plexpy.CONFIG.MUSIC_NOTIFY_ENABLE),
             "tv_notify_on_start": checked(plexpy.CONFIG.TV_NOTIFY_ON_START),
             "movie_notify_on_start": checked(plexpy.CONFIG.MOVIE_NOTIFY_ON_START),
@@ -439,14 +438,21 @@ class WebInterface(object):
             "tv_notify_on_pause": checked(plexpy.CONFIG.TV_NOTIFY_ON_PAUSE),
             "movie_notify_on_pause": checked(plexpy.CONFIG.MOVIE_NOTIFY_ON_PAUSE),
             "music_notify_on_pause": checked(plexpy.CONFIG.MUSIC_NOTIFY_ON_PAUSE),
+            "monitor_remote_access": checked(plexpy.CONFIG.MONITOR_REMOTE_ACCESS),
             "monitoring_interval": plexpy.CONFIG.MONITORING_INTERVAL,
+            "monitoring_use_websocket": checked(plexpy.CONFIG.MONITORING_USE_WEBSOCKET),
             "refresh_users_interval": plexpy.CONFIG.REFRESH_USERS_INTERVAL,
             "refresh_users_on_startup": checked(plexpy.CONFIG.REFRESH_USERS_ON_STARTUP),
             "ip_logging_enable": checked(plexpy.CONFIG.IP_LOGGING_ENABLE),
-            "video_logging_enable": checked(plexpy.CONFIG.VIDEO_LOGGING_ENABLE),
+            "movie_logging_enable": checked(plexpy.CONFIG.MOVIE_LOGGING_ENABLE),
+            "tv_logging_enable": checked(plexpy.CONFIG.TV_LOGGING_ENABLE),
             "music_logging_enable": checked(plexpy.CONFIG.MUSIC_LOGGING_ENABLE),
             "logging_ignore_interval": plexpy.CONFIG.LOGGING_IGNORE_INTERVAL,
             "pms_is_remote": checked(plexpy.CONFIG.PMS_IS_REMOTE),
+            "notify_consecutive": checked(plexpy.CONFIG.NOTIFY_CONSECUTIVE),
+            "notify_recently_added": checked(plexpy.CONFIG.NOTIFY_RECENTLY_ADDED),
+            "notify_recently_added_grandparent": checked(plexpy.CONFIG.NOTIFY_RECENTLY_ADDED_GRANDPARENT),
+            "notify_recently_added_delay": plexpy.CONFIG.NOTIFY_RECENTLY_ADDED_DELAY,
             "notify_watched_percent": plexpy.CONFIG.NOTIFY_WATCHED_PERCENT,
             "notify_on_start_subject_text": plexpy.CONFIG.NOTIFY_ON_START_SUBJECT_TEXT,
             "notify_on_start_body_text": plexpy.CONFIG.NOTIFY_ON_START_BODY_TEXT,
@@ -460,11 +466,24 @@ class WebInterface(object):
             "notify_on_buffer_body_text": plexpy.CONFIG.NOTIFY_ON_BUFFER_BODY_TEXT,
             "notify_on_watched_subject_text": plexpy.CONFIG.NOTIFY_ON_WATCHED_SUBJECT_TEXT,
             "notify_on_watched_body_text": plexpy.CONFIG.NOTIFY_ON_WATCHED_BODY_TEXT,
+            "notify_on_created_subject_text": plexpy.CONFIG.NOTIFY_ON_CREATED_SUBJECT_TEXT,
+            "notify_on_created_body_text": plexpy.CONFIG.NOTIFY_ON_CREATED_BODY_TEXT,
+            "notify_on_extdown_subject_text": plexpy.CONFIG.NOTIFY_ON_EXTDOWN_SUBJECT_TEXT,
+            "notify_on_extdown_body_text": plexpy.CONFIG.NOTIFY_ON_EXTDOWN_BODY_TEXT,
+            "notify_on_intdown_subject_text": plexpy.CONFIG.NOTIFY_ON_INTDOWN_SUBJECT_TEXT,
+            "notify_on_intdown_body_text": plexpy.CONFIG.NOTIFY_ON_INTDOWN_BODY_TEXT,
+            "notify_on_extup_subject_text": plexpy.CONFIG.NOTIFY_ON_EXTUP_SUBJECT_TEXT,
+            "notify_on_extup_body_text": plexpy.CONFIG.NOTIFY_ON_EXTUP_BODY_TEXT,
+            "notify_on_intup_subject_text": plexpy.CONFIG.NOTIFY_ON_INTUP_SUBJECT_TEXT,
+            "notify_on_intup_body_text": plexpy.CONFIG.NOTIFY_ON_INTUP_BODY_TEXT,
             "home_stats_length": plexpy.CONFIG.HOME_STATS_LENGTH,
             "home_stats_type": checked(plexpy.CONFIG.HOME_STATS_TYPE),
             "home_stats_count": plexpy.CONFIG.HOME_STATS_COUNT,
+            "home_stats_cards": plexpy.CONFIG.HOME_STATS_CARDS,
+            "home_library_cards": plexpy.CONFIG.HOME_LIBRARY_CARDS,
             "buffer_threshold": plexpy.CONFIG.BUFFER_THRESHOLD,
-            "buffer_wait": plexpy.CONFIG.BUFFER_WAIT
+            "buffer_wait": plexpy.CONFIG.BUFFER_WAIT,
+            "group_history_tables": checked(plexpy.CONFIG.GROUP_HISTORY_TABLES)
         }
 
         return serve_template(templatename="settings.html", title="Settings", config=config)
@@ -474,18 +493,15 @@ class WebInterface(object):
         # Handle the variable config options. Note - keys with False values aren't getting passed
 
         checked_configs = [
-            "launch_browser", "enable_https", "api_enabled", "freeze_db", "growl_enabled",
-            "prowl_enabled", "xbmc_enabled", "check_github",
-            "plex_enabled", "nma_enabled", "pushalot_enabled",
-            "pushover_enabled", "pushbullet_enabled",
-            "twitter_enabled", "osx_notify_enabled",
-            "boxcar_enabled", "email_enabled", "email_tls",
+            "launch_browser", "enable_https", "api_enabled", "freeze_db", "check_github",
             "grouping_global_history", "grouping_user_history", "grouping_charts", "pms_use_bif", "pms_ssl",
-            "tv_notify_enable", "movie_notify_enable", "music_notify_enable",
+            "movie_notify_enable", "tv_notify_enable", "music_notify_enable", "monitoring_use_websocket",
             "tv_notify_on_start", "movie_notify_on_start", "music_notify_on_start",
             "tv_notify_on_stop", "movie_notify_on_stop", "music_notify_on_stop",
             "tv_notify_on_pause", "movie_notify_on_pause", "music_notify_on_pause", "refresh_users_on_startup",
-            "ip_logging_enable", "video_logging_enable", "music_logging_enable", "pms_is_remote", "home_stats_type"
+            "ip_logging_enable", "movie_logging_enable", "tv_logging_enable", "music_logging_enable", 
+            "pms_is_remote", "home_stats_type", "group_history_tables", "notify_consecutive", 
+            "notify_recently_added", "notify_recently_added_grandparent", "monitor_remote_access"
         ]
         for checked_config in checked_configs:
             if checked_config not in kwargs:
@@ -510,11 +526,27 @@ class WebInterface(object):
             if (kwargs['monitoring_interval'] != str(plexpy.CONFIG.MONITORING_INTERVAL)) or \
                     (kwargs['refresh_users_interval'] != str(plexpy.CONFIG.REFRESH_USERS_INTERVAL)):
                 reschedule = True
+        
+        if 'notify_recently_added' in kwargs and \
+            (kwargs['notify_recently_added'] != plexpy.CONFIG.NOTIFY_RECENTLY_ADDED):
+            reschedule = True
+
+        if 'monitor_remote_access' in kwargs and \
+            (kwargs['monitor_remote_access'] != plexpy.CONFIG.MONITOR_REMOTE_ACCESS):
+            reschedule = True
 
         if 'pms_ip' in kwargs:
             if kwargs['pms_ip'] != plexpy.CONFIG.PMS_IP:
                 refresh_users = True
 
+        if 'home_stats_cards' in kwargs:
+            if kwargs['home_stats_cards'] != 'watch_statistics':
+                kwargs['home_stats_cards'] = ', '.join(kwargs['home_stats_cards'])
+
+        if 'home_library_cards' in kwargs:
+            if kwargs['home_library_cards'] != 'library_statistics':
+                kwargs['home_library_cards'] = ', '.join(kwargs['home_library_cards'])
+
         plexpy.CONFIG.process_kwargs(kwargs)
 
         # Write the config
@@ -535,15 +567,6 @@ class WebInterface(object):
 
     @cherrypy.expose
     def set_notification_config(self, **kwargs):
-        # Handle the variable config options. Note - keys with False values aren't getting passed
-
-        checked_configs = [
-            "email_tls"
-        ]
-        for checked_config in checked_configs:
-            if checked_config not in kwargs:
-                # checked items should be zero or one. if they were not sent then the item was not checked
-                kwargs[checked_config] = 0
 
         for plain_config, use_config in [(x[4:], x) for x in kwargs if x.startswith('use_')]:
             # the use prefix is fairly nice in the html, but does not match the actual config
@@ -567,28 +590,42 @@ class WebInterface(object):
                               message=message, timer=timer, quote=quote)
 
     @cherrypy.expose
-    def get_history(self, user=None, user_id=None, **kwargs):
+    def get_history(self, user=None, user_id=None, grouping=0, **kwargs):
 
-        custom_where=[]
+        if grouping == 'false':
+            grouping = 0
+        else:
+            grouping = plexpy.CONFIG.GROUP_HISTORY_TABLES
+
+        watched_percent = plexpy.CONFIG.NOTIFY_WATCHED_PERCENT
+
+        custom_where = []
         if user_id:
-            custom_where = [['user_id', user_id]]
+            custom_where.append(['session_history.user_id', user_id])
         elif user:
-            custom_where = [['user', user]]
+            custom_where.append(['session_history.user', user])
         if 'rating_key' in kwargs:
             rating_key = kwargs.get('rating_key', "")
-            custom_where = [['rating_key', rating_key]]
+            custom_where.append(['session_history.rating_key', rating_key])
         if 'parent_rating_key' in kwargs:
             rating_key = kwargs.get('parent_rating_key', "")
-            custom_where = [['parent_rating_key', rating_key]]
+            custom_where.append(['session_history.parent_rating_key', rating_key])
         if 'grandparent_rating_key' in kwargs:
             rating_key = kwargs.get('grandparent_rating_key', "")
-            custom_where = [['grandparent_rating_key', rating_key]]
+            custom_where.append(['session_history.grandparent_rating_key', rating_key])
         if 'start_date' in kwargs:
             start_date = kwargs.get('start_date', "")
-            custom_where = [['strftime("%Y-%m-%d", datetime(date, "unixepoch", "localtime"))', start_date]]
+            custom_where.append(['strftime("%Y-%m-%d", datetime(started, "unixepoch", "localtime"))', start_date])
+        if 'reference_id' in kwargs:
+            reference_id = kwargs.get('reference_id', "")
+            custom_where.append(['session_history.reference_id', reference_id])
+        if 'media_type' in kwargs:
+            media_type = kwargs.get('media_type', "")
+            if media_type != 'all':
+               custom_where.append(['session_history.media_type', media_type])
 
         data_factory = datafactory.DataFactory()
-        history = data_factory.get_history(kwargs=kwargs, custom_where=custom_where)
+        history = data_factory.get_history(kwargs=kwargs, custom_where=custom_where, grouping=grouping, watched_percent=watched_percent)
 
         cherrypy.response.headers['Content-type'] = 'application/json'
         return json.dumps(history)
@@ -646,6 +683,16 @@ class WebInterface(object):
         else:
             return "Error sending tweet"
 
+    @cherrypy.expose
+    def test_ifttt(self):
+        cherrypy.response.headers['Cache-Control'] = "max-age=0,no-cache,no-store"
+        event = notifiers.IFTTT()
+        result = event.test()
+        if result:
+            return "Notification successful."
+        else:
+            return "Error sending event."
+
     @cherrypy.expose
     def osxnotifyregister(self, app):
         cherrypy.response.headers['Cache-Control'] = "max-age=0,no-cache,no-store"
@@ -691,6 +738,13 @@ class WebInterface(object):
         try:
             pms_connect = pmsconnect.PmsConnect()
             result = pms_connect.get_current_activity()
+
+            data_factory = datafactory.DataFactory()
+            for session in result['sessions']:
+                if not session['ip_address']:
+                    ip_address = data_factory.get_session_ip(session['session_key'])
+                    session['ip_address'] = ip_address
+
         except:
             return serve_template(templatename="current_activity.html", data=None)
 
@@ -761,6 +815,7 @@ class WebInterface(object):
     @cherrypy.expose
     def info(self, item_id=None, source=None, **kwargs):
         metadata = None
+        query = None
 
         config = {
             "pms_identifier": plexpy.CONFIG.PMS_IDENTIFIER
@@ -769,17 +824,26 @@ class WebInterface(object):
         if source == 'history':
             data_factory = datafactory.DataFactory()
             metadata = data_factory.get_metadata_details(row_id=item_id)
+        elif item_id == 'movie':
+            metadata = {'media_type': 'library', 'library': 'movie', 'media_type_filter': 'movie', 'title': 'Movies'}
+        elif item_id == 'show':
+            metadata = {'media_type': 'library', 'library': 'show', 'media_type_filter': 'episode', 'title': 'TV Shows'}
+        elif item_id == 'artist':
+            metadata = {'media_type': 'library', 'library': 'artist', 'media_type_filter': 'track', 'title': 'Music'}
         else:
             pms_connect = pmsconnect.PmsConnect()
             result = pms_connect.get_metadata_details(rating_key=item_id)
             if result:
                 metadata = result['metadata']
+            else:
+                data_factory = datafactory.DataFactory()
+                query = data_factory.get_search_query(rating_key=item_id)
 
         if metadata:
             return serve_template(templatename="info.html", data=metadata, title="Info", config=config)
         else:
             logger.warn('Unable to retrieve data.')
-            return serve_template(templatename="info.html", data=None, title="Info")
+            return serve_template(templatename="info.html", data=None, query=query, title="Info")
 
     @cherrypy.expose
     def get_user_recently_watched(self, user=None, user_id=None, limit='10', **kwargs):
@@ -808,17 +872,17 @@ class WebInterface(object):
             return serve_template(templatename="user_watch_time_stats.html", data=None, title="Watch Stats")
 
     @cherrypy.expose
-    def get_user_platform_stats(self, user=None, user_id=None, **kwargs):
+    def get_user_player_stats(self, user=None, user_id=None, **kwargs):
 
         user_data = users.Users()
-        result = user_data.get_user_platform_stats(user_id=user_id, user=user)
+        result = user_data.get_user_player_stats(user_id=user_id, user=user)
 
         if result:
-            return serve_template(templatename="user_platform_stats.html", data=result,
-                                  title="Platform Stats")
+            return serve_template(templatename="user_player_stats.html", data=result,
+                                  title="Player Stats")
         else:
             logger.warn('Unable to retrieve data.')
-            return serve_template(templatename="user_platform_stats.html", data=None, title="Platform Stats")
+            return serve_template(templatename="user_player_stats.html", data=None, title="Player Stats")
 
     @cherrypy.expose
     def get_item_children(self, rating_key='', **kwargs):
@@ -883,7 +947,7 @@ class WebInterface(object):
     @cherrypy.expose
     def get_user_ips(self, user_id=None, user=None, **kwargs):
 
-        custom_where=[]
+        custom_where = []
         if user_id:
             custom_where = [['user_id', user_id]]
         elif user:
@@ -896,6 +960,20 @@ class WebInterface(object):
         cherrypy.response.headers['Content-type'] = 'application/json'
         return json.dumps(history)
 
+    @cherrypy.expose
+    def set_graph_config(self, graph_type=None, graph_days=None, graph_tab=None):
+        if graph_type:
+            plexpy.CONFIG.__setattr__('GRAPH_TYPE', graph_type)
+            plexpy.CONFIG.write()
+        if graph_days:
+            plexpy.CONFIG.__setattr__('GRAPH_DAYS', graph_days)
+            plexpy.CONFIG.write()
+        if graph_tab:
+            plexpy.CONFIG.__setattr__('GRAPH_TAB', graph_tab)
+            plexpy.CONFIG.write()
+
+        return "Updated graphs config values."
+
     @cherrypy.expose
     def get_plays_by_date(self, time_range='30', y_axis='plays', **kwargs):
 
@@ -1101,10 +1179,9 @@ class WebInterface(object):
             logger.warn('Unable to retrieve data.')
 
     @cherrypy.expose
-    def get_server_prefs(self, **kwargs):
+    def get_server_friendly_name(self, **kwargs):
 
-        pms_connect = pmsconnect.PmsConnect()
-        result = pms_connect.get_server_prefs(output_format='json')
+        result = pmsconnect.get_server_friendly_name()
 
         if result:
             cherrypy.response.headers['Content-type'] = 'application/json'
@@ -1112,6 +1189,33 @@ class WebInterface(object):
         else:
             logger.warn('Unable to retrieve data.')
 
+    @cherrypy.expose
+    def get_server_prefs(self, pref=None, **kwargs):
+
+        if pref:
+            pms_connect = pmsconnect.PmsConnect()
+            result = pms_connect.get_server_pref(pref=pref)
+        else:
+            result = None
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return result
+        else:
+            logger.warn('Unable to retrieve data.')
+
+    @cherrypy.expose
+    def get_server_children(self, **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        result = pms_connect.get_server_children()
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps(result)
+        else:
+            logger.warn('Unable to retrieve data.')
+
     @cherrypy.expose
     def get_activity(self, **kwargs):
 
@@ -1272,12 +1376,22 @@ class WebInterface(object):
 
     @cherrypy.expose
     def get_notification_agent_config(self, config_id, **kwargs):
-        config = notifiers.get_notification_agent_config(config_id=config_id)
+        if config_id.isdigit():
+            config = notifiers.get_notification_agent_config(config_id=config_id)
+            agents = notifiers.available_notification_agents()
+            for agent in agents:
+                if int(config_id) == agent['id']:
+                    this_agent = agent
+                    break
+                else:
+                    this_agent = None
+        else:
+            return None
 
         checkboxes = {'email_tls': checked(plexpy.CONFIG.EMAIL_TLS)}
 
         return serve_template(templatename="notification_config.html", title="Notification Configuration",
-                              data=config, checkboxes=checkboxes)
+                              agent=this_agent, data=config, checkboxes=checkboxes)
 
     @cherrypy.expose
     def get_notification_agent_triggers(self, config_id, **kwargs):
@@ -1323,3 +1437,153 @@ class WebInterface(object):
             cherrypy.response.headers['Content-type'] = 'application/json'
             return json.dumps({'message': 'no data received'})
 
+    @cherrypy.expose
+    def delete_user(self, user_id, **kwargs):
+        data_factory = datafactory.DataFactory()
+
+        if user_id:
+            delete_row = data_factory.delete_user(user_id=user_id)
+
+            if delete_row:
+                cherrypy.response.headers['Content-type'] = 'application/json'
+                return json.dumps({'message': delete_row})
+        else:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps({'message': 'no data received'})
+
+    @cherrypy.expose
+    def undelete_user(self, user_id=None, username=None, **kwargs):
+        data_factory = datafactory.DataFactory()
+        
+        if user_id:
+            delete_row = data_factory.undelete_user(user_id=user_id)
+
+            if delete_row:
+                cherrypy.response.headers['Content-type'] = 'application/json'
+                return json.dumps({'message': delete_row})
+        elif username:
+            delete_row = data_factory.undelete_user(username=username)
+
+            if delete_row:
+                cherrypy.response.headers['Content-type'] = 'application/json'
+                return json.dumps({'message': delete_row})
+        else:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps({'message': 'no data received'})
+
+    @cherrypy.expose
+    def search(self, query=''):
+
+        return serve_template(templatename="search.html", title="Search", query=query)
+
+    @cherrypy.expose
+    def search_results(self, query, **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        result = pms_connect.get_search_results(query)
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps(result)
+        else:
+            logger.warn('Unable to retrieve data.')
+
+    @cherrypy.expose
+    def get_search_results_children(self, query, media_type=None, season_index=None, **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        result = pms_connect.get_search_results(query)
+
+        if media_type:
+            result['results_list'] = {media_type: result['results_list'][media_type]}
+        if media_type == 'season' and season_index:
+            for season in result['results_list']['season']:
+                if season['index'] == season_index:
+                    result['results_list']['season'] = [season]
+                    break
+
+        if result:
+            return serve_template(templatename="info_search_results_list.html", data=result, title="Search Result List")
+        else:
+            logger.warn('Unable to retrieve data.')
+            return serve_template(templatename="info_search_results_list.html", data=None, title="Search Result List")
+
+    @cherrypy.expose
+    def update_history_rating_key(self, old_rating_key, new_rating_key, media_type, **kwargs):
+        data_factory = datafactory.DataFactory()
+        pms_connect = pmsconnect.PmsConnect()
+
+        old_key_list = data_factory.get_rating_keys_list(rating_key=old_rating_key, media_type=media_type)
+        new_key_list = pms_connect.get_rating_keys_list(rating_key=new_rating_key, media_type=media_type)
+
+        update_db = data_factory.update_rating_key(old_key_list=old_key_list,
+                                                   new_key_list=new_key_list,
+                                                   media_type=media_type)
+
+        if update_db:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps({'message': update_db})
+        else:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps({'message': 'no data received'})
+
+    # test code
+    @cherrypy.expose
+    def get_new_rating_keys(self, rating_key='', media_type='', **kwargs):
+
+        pms_connect = pmsconnect.PmsConnect()
+        result = pms_connect.get_rating_keys_list(rating_key=rating_key, media_type=media_type)
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps(result)
+        else:
+            logger.warn('Unable to retrieve data.')
+
+    @cherrypy.expose
+    def get_old_rating_keys(self, rating_key='', media_type='', **kwargs):
+
+        data_factory = datafactory.DataFactory()
+        result = data_factory.get_rating_keys_list(rating_key=rating_key, media_type=media_type)
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps(result)
+        else:
+            logger.warn('Unable to retrieve data.')
+
+    @cherrypy.expose
+    def get_map_rating_keys(self, old_rating_key, new_rating_key, media_type, **kwargs):
+
+        data_factory = datafactory.DataFactory()
+        pms_connect = pmsconnect.PmsConnect()
+
+        if new_rating_key:
+            old_key_list = data_factory.get_rating_keys_list(rating_key=old_rating_key, media_type=media_type)
+            new_key_list = pms_connect.get_rating_keys_list(rating_key=new_rating_key, media_type=media_type)
+
+            result = data_factory.update_rating_key(old_key_list=old_key_list,
+                                                    new_key_list=new_key_list,
+                                                    media_type=media_type)
+
+        if result:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return json.dumps(result)
+        else:
+            logger.warn('Unable to retrieve data.')
+
+    @cherrypy.expose
+    def discover(self, token=''):
+        """
+        Returns the servers that you own as a
+        list of dicts (formatted for selectize)
+        """
+        # Need to set token so result dont return http 401
+        plexpy.CONFIG.__setattr__('PMS_TOKEN', token)
+        plexpy.CONFIG.write()
+
+        result = plextv.PlexTV()
+        servers = result.discover()
+        if servers:
+            cherrypy.response.headers['Content-type'] = 'application/json'
+            return servers