v1.4.16

fix result type, fixup responses from the ui to api

API.md

@@ -37,11 +37,11 @@ Get to the chopper!
 
 
 ### backup_config
-Create a manual backup of the `config.ini` file. 
+Create a manual backup of the `config.ini` file.
 
 
 ### backup_db
-Create a manual backup of the `plexpy.db` file. 
+Create a manual backup of the `plexpy.db` file.
 
 
 ### delete_all_library_history
@@ -142,6 +142,10 @@ Returns:
 ```
 
 
+### delete_temp_sessions
+Flush out all of the temporary sessions in the database.
+
+
 ### delete_user
 Delete a user from PlexPy. Also erases all history for the user.
 
@@ -158,11 +162,11 @@ Returns:
 
 
 ### docs
-Return the api docs as a dict where commands are keys, docstring are value. 
+Return the api docs as a dict where commands are keys, docstring are value.
 
 
 ### docs_md
-Return the api docs formatted with markdown. 
+Return the api docs formatted with markdown.
 
 
 ### download_log
@@ -755,11 +759,11 @@ Optional parameters:
 
 Returns:
     json:
-        [{"loglevel": "DEBUG", 
-          "msg": "Latest version is 2d10b0748c7fa2ee4cf59960c3d3fffc6aa9512b", 
-          "thread": "MainThread", 
+        [{"loglevel": "DEBUG",
+          "msg": "Latest version is 2d10b0748c7fa2ee4cf59960c3d3fffc6aa9512b",
+          "thread": "MainThread",
           "time": "2016-05-08 09:36:51 "
-          }, 
+          },
          {...},
          {...}
          ]
@@ -1814,15 +1818,15 @@ Returns:
 
 
 ### refresh_libraries_list
-Refresh the PlexPy libraries list. 
+Refresh the PlexPy libraries list.
 
 
 ### refresh_users_list
-Refresh the PlexPy users list. 
+Refresh the PlexPy users list.
 
 
 ### restart
-Restart PlexPy. 
+Restart PlexPy.
 
 
 ### search
@@ -1905,7 +1909,7 @@ Uninstalls the GeoLite2 database
 
 
 ### update
-Check for PlexPy updates on Github. 
+Check for PlexPy updates on Github.
 
 
 ### update_metadata_details

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v1.4.16 (2016-11-25)
+
+* Fix: Websocket for new json response on PMS 1.3.0.
+* Fix: Update stream and transcoder tooltip percent.
+* Fix: Typo in the edit user modal.
+
+
+## v1.4.15 (2016-11-11)
+
+* New: Add stream and transcoder progress percent to the current activity tooltip.
+* Fix: Refreshing of images in the cache when authentication is disabled.
+* Fix: Plex.tv authentication with special characters in the username or password.
+* Fix: Line breaks in the info page summaries.
+* Fix: Redirect to the proper http root when restarting.
+* Fix: API result type and responses showing incorrectly. (Thanks @Hellowlol)
+* Change: Use https URL for app.plex.tv.
+* Change: Show API traceback errors in the browser with debugging enabled. (Thanks @Hellowlol)
+* Change: Increase table width on mobile devices and max width set to 1750px. (Thanks @XusBadia)
+
+
 ## v1.4.14 (2016-10-12)
 
 * Fix: History logging locking up if media is removed from Plex before PlexPy can save the session.

data/interfaces/default/css/plexpy.css

@@ -2251,7 +2251,8 @@ a .home-platforms-list-cover-face:hover
     margin-right: auto;
     margin-top: 20px;
     margin-bottom: 20px;
-    width: 90%;
+    width: 100%;
+    max-width: 1750px;
     overflow: hidden;
 }
 .table-card-header {
@@ -2263,7 +2264,8 @@ a .home-platforms-list-cover-face:hover
     margin-right: auto;
     margin-top: 20px;
     margin-bottom: -20px;
-    width: 90%;
+    width: 100%;
+    max-width: 1750px;
     overflow: hidden;
 }
 .table-card-back td {
@@ -3064,4 +3066,4 @@ a:hover .overlay-refresh-image:hover {
 }
 #api_key.form-control[readonly]:focus {
     background-color: #fff;
-}
+}

data/interfaces/default/current_activity_instance.html

@@ -207,8 +207,8 @@ DOCUMENTATION :: END
         % endif
         <div class="dashboard-activity-progress">
             <div class="dashboard-activity-progress-bar">
-                <div id="bufferbar-${data['session_key']}" class="bufferbar" style="width: ${data['transcode_progress']}%" data-toggle="tooltip" title="Transcoder Progress">${data['transcode_progress']}%</div>
-                <div id="bar-${data['session_key']}" class="bar" style="width: ${data['progress_percent']}%" data-toggle="tooltip" title="Stream Progress">${data['progress_percent']}%</div>
+                <div id="bufferbar-${data['session_key']}" class="bufferbar" style="width: ${data['transcode_progress']}%" data-toggle="tooltip" title="Transcoder Progress ${data['transcode_progress']}%">${data['transcode_progress']}%</div>
+                <div id="bar-${data['session_key']}" class="bar" style="width: ${data['progress_percent']}%" data-toggle="tooltip" title="Stream Progress ${data['progress_percent']}%">${data['progress_percent']}%</div>
             </div>
         </div>
     </div>

data/interfaces/default/edit_user.html

@@ -45,7 +45,7 @@ DOCUMENTATION :: END
                             <input type="text" class="form-control" id="friendly_name" name="friendly_name" value="${data['friendly_name']}" size="30">
                         </div>
                     </div>
-                    <p class="help-block">Replace all occurances of the username with this name.</p>
+                    <p class="help-block">Replace all occurrences of the username with this name.</p>
                 </div>
                 <div class="form-group">
                     <label for="profile_url">Profile Picture URL</label>

data/interfaces/default/index.html

@@ -204,8 +204,11 @@
 
                         // update the progress bars
                         // percent - 3 because of 3px padding-right
-                        $('#bufferbar-' + key).width(parseInt(s.transcode_progress) - 3 + '%').html(s.transcode_progress + '%');
-                        $('#bar-' + key).width(parseInt(s.progress_percent) - 3 + '%').html(s.progress_percent + '%');
+                        $('#bufferbar-' + key).width(parseInt(s.transcode_progress) - 3 + '%').html(s.transcode_progress + '%')
+                            .attr('data-original-title', 'Transcoder Progress ' + s.transcode_progress + '%');
+                        $('#bar-' + key).width(parseInt(s.progress_percent) - 3 + '%').html(s.progress_percent + '%')
+                            .attr('data-original-title', 'Stream Progress ' + s.progress_percent + '%');
+
 
                         // add temporary class so we know which instances are still active
                         instance.addClass('updated-temp');

data/interfaces/default/info.html

@@ -53,6 +53,9 @@ DOCUMENTATION :: END
             if re.match(pattern, codec):
                 return file
         return codec
+
+    def br(text):
+        return text.replace('\n', '<br /><br />')
 %>
 
 <%inherit file="base.html"/>
@@ -112,9 +115,9 @@ DOCUMENTATION :: END
                 <div class="col-md-9">
                     <div class="summary-content-poster hidden-xs hidden-sm">
                         % 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="_blank" title="View in Plex Web">
+                        <a href="https://app.plex.tv/web/app#!/server/${config['pms_identifier']}/details/%2Flibrary%2Fmetadata%2F${data['parent_rating_key']}" target="_blank" title="View in Plex Web">
                         % else:
-                        <a href="http://app.plex.tv/web/app#!/server/${config['pms_identifier']}/details/%2Flibrary%2Fmetadata%2F${data['rating_key']}" target="_blank" title="View in Plex Web">
+                        <a href="https://app.plex.tv/web/app#!/server/${config['pms_identifier']}/details/%2Flibrary%2Fmetadata%2F${data['rating_key']}" target="_blank" title="View in Plex Web">
                         % endif
                             % 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=art);">
@@ -250,7 +253,7 @@ DOCUMENTATION :: END
                         </div>
                         % endif
                         <div class="summary-content-summary">
-                            <p> ${data['summary']} </p>
+                            <p> ${data['summary'] | br, n} </p>
                         </div>
                     </div>
                 </div>

data/interfaces/default/shutdown.html

@@ -47,7 +47,7 @@
 
         // Redirect to home page after countdown.
         function reloadPage() {
-            window.location.href = "index";
+            window.location.href = "${new_http_root}index";
         }
     </script>
 </%def>

plexpy/api2.py

@@ -47,7 +47,7 @@ class API2:
         self._api_cmd = None
         self._api_apikey = None
         self._api_callback = None  # JSONP
-        self._api_result_type = 'failed'
+        self._api_result_type = 'error'
         self._api_profileme = None  # For profiling the api call
         self._api_kwargs = None  # Cleaned kwargs
 
@@ -64,12 +64,12 @@ class API2:
         return docs
 
     def docs_md(self):
-        """ Return the api docs formatted with markdown. """
+        """ Return the api docs formatted with markdown."""
 
         return self._api_make_md()
 
     def docs(self):
-        """ Return the api docs as a dict where commands are keys, docstring are value. """
+        """ Return the api docs as a dict where commands are keys, docstring are value."""
 
         return self._api_docs()
 
@@ -95,7 +95,7 @@ class API2:
             self._api_msg = 'Parameter cmd is required. Possible commands are: %s' % ', '.join(self._api_valid_methods)
 
         elif 'cmd' in kwargs and kwargs.get('cmd') not in self._api_valid_methods:
-            self._api_msg = 'Unknown command: %s. Possible commands are: %s' % (kwargs.get('cmd', ''), ', '.join(self._api_valid_methods))
+            self._api_msg = 'Unknown command: %s. Possible commands are: %s' % (kwargs.get('cmd', ''), ', '.join(sorted(self._api_valid_methods)))
 
         self._api_callback = kwargs.pop('callback', None)
         self._api_apikey = kwargs.pop('apikey', None)
@@ -137,17 +137,16 @@ class API2:
 
             Returns:
                 json:
-                    [{"loglevel": "DEBUG", 
-                      "msg": "Latest version is 2d10b0748c7fa2ee4cf59960c3d3fffc6aa9512b", 
-                      "thread": "MainThread", 
+                    [{"loglevel": "DEBUG",
+                      "msg": "Latest version is 2d10b0748c7fa2ee4cf59960c3d3fffc6aa9512b",
+                      "thread": "MainThread",
                       "time": "2016-05-08 09:36:51 "
-                      }, 
+                      },
                      {...},
                      {...}
                      ]
             ```
         """
-
         logfile = os.path.join(plexpy.CONFIG.LOG_DIR, logger.FILENAME)
         templog = []
         start = int(kwargs.get('start', 0))
@@ -213,7 +212,6 @@ class API2:
         if order == 'desc':
             templog = templog[::-1]
 
-        self.data = templog
         return templog
 
     def get_settings(self, key=''):
@@ -257,7 +255,7 @@ class API2:
                 config[k]['interface_list'] = interface_list
 
         if key:
-            return config.get(key, None)
+            return config.get(key)
 
         return config
 
@@ -277,81 +275,69 @@ class API2:
                 None
             ```
         """
-        if not plexpy.CONFIG.API_SQL or not query:
+        if not plexpy.CONFIG.API_SQL:
+            self._api_msg = 'SQL not enabled for the API.'
+            return
+
+        if not query:
+            self._api_msg = 'No SQL query provided.'
             return
 
         # allow the user to shoot them self
         # in the foot but not in the head..
-        if not len(os.listdir(plexpy.BACKUP_DIR)):
-            self.backupdb()
+        if not len(os.listdir(plexpy.CONFIG.BACKUP_DIR)):
+            self.backup_db()
         else:
             # If the backup is less then 24 h old lets make a backup
-            if any([os.path.getctime(os.path.join(plexpy.BACKUP_DIR, file_)) <
-                   (time.time() - 86400) for file_ in os.listdir(plexpy.BACKUP_DIR)]):
-                self.backupdb()
+            if any([os.path.getctime(os.path.join(plexpy.CONFIG.BACKUP_DIR, file_)) < (time.time() - 86400)
+                   and file_.endswith('.db') for file_ in os.listdir(plexpy.CONFIG.BACKUP_DIR)]):
+                self.backup_db()
 
         db = database.MonitorDatabase()
         rows = db.select(query)
-        self.data = rows
         return rows
 
     def backup_config(self):
-        """ Create a manual backup of the `config.ini` file. """
+        """ Create a manual backup of the `config.ini` file."""
 
         data = config.make_backup()
-
-        if data:
-            self.result_type = 'success'
-        else:
-            self.result_type = 'failed'
+        self._api_result_type = 'success' if data else 'error'
 
         return data
 
     def backup_db(self):
-        """ Create a manual backup of the `plexpy.db` file. """
+        """ Create a manual backup of the `plexpy.db` file."""
 
         data = database.make_backup()
-
-        if data:
-            self.result_type = 'success'
-        else:
-            self.result_type = 'failed'
+        self._api_result_type = 'success' if data else 'error'
 
         return data
 
     def restart(self, **kwargs):
-        """ Restart PlexPy. """
+        """ Restart PlexPy."""
 
         plexpy.SIGNAL = 'restart'
-        self.msg = 'Restarting plexpy'
-        self.result_type = 'success'
+        self._api_msg = 'Restarting plexpy'
+        self._api_result_type = 'success'
 
     def update(self, **kwargs):
-        """ Check for PlexPy updates on Github. """
+        """ Check for PlexPy updates on Github."""
 
         plexpy.SIGNAL = 'update'
-        self.msg = 'Updating plexpy'
-        self.result_type = 'success'
+        self._api_msg = 'Updating plexpy'
+        self._api_result_type = 'success'
 
     def refresh_libraries_list(self, **kwargs):
-        """ Refresh the PlexPy libraries list. """
+        """ Refresh the PlexPy libraries list."""
         data = pmsconnect.refresh_libraries()
-
-        if data:
-            self.result_type = 'success'
-        else:
-            self.result_type = 'failed'
+        self._api_result_type = 'success' if data else 'error'
 
         return data
 
     def refresh_users_list(self, **kwargs):
-        """ Refresh the PlexPy users list. """
+        """ Refresh the PlexPy users list."""
         data = plextv.refresh_users()
-
-        if data:
-            self.result_type = 'success'
-        else:
-            self.result_type = 'failed'
+        self._api_result_type = 'success' if data else 'error'
 
         return data
 
@@ -418,30 +404,30 @@ General optional parameters:
                 string:             "apikey"
             ```
          """
-
+        data = None
         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
+                    data = plexpy.CONFIG.API_KEY
                 else:
-                    self.data = apikey
+                    data = apikey
                     plexpy.CONFIG.API_KEY = apikey
                     plexpy.CONFIG.write()
             else:
-                self.msg = 'Authentication is enabled, please add the correct username and password to the parameters'
+                self._api_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
+                data = plexpy.CONFIG.API_KEY
             else:
                 # Make a apikey if the doesn't exist
-                self.data = apikey
+                data = apikey
                 plexpy.CONFIG.API_KEY = apikey
                 plexpy.CONFIG.write()
 
-        return self.data
+        return data
 
-    def _api_responds(self, result_type='success', data=None, msg=''):
+    def _api_responds(self, result_type='error', data=None, msg=''):
         """ Formats the result to a predefined dict so we can hange it the to
             the desired output by _api_out_as """
 
@@ -478,6 +464,7 @@ General optional parameters:
                 logger.info(u'PlexPy APIv2 :: ' + traceback.format_exc())
                 out['message'] = traceback.format_exc()
                 out['result'] = 'error'
+
         elif self._api_out_type == 'xml':
             cherrypy.response.headers['Content-Type'] = 'application/xml'
             try:
@@ -519,13 +506,16 @@ General optional parameters:
 
             # We allow this to fail so we get a
             # traceback in the browser
-            if self._api_debug:
+            try:
+
                 result = call(**self._api_kwargs)
-            else:
-                try:
-                    result = call(**self._api_kwargs)
-                except Exception as e:
-                    logger.error(u'PlexPy APIv2 :: Failed to run %s %s %s' % (self._api_cmd, self._api_kwargs, e))
+            except Exception as e:
+                logger.error(u'PlexPy APIv2 :: Failed to run %s with %s: %s' % (self._api_cmd, self._api_kwargs, e))
+                if self._api_debug:
+                    cherrypy.request.show_tracebacks = True
+                    # Reraise the exception so the traceback hits the browser
+                    raise
+                self._api_msg = 'Check the logs'
 
         ret = None
         # The api decorated function can return different result types.
@@ -556,4 +546,14 @@ General optional parameters:
         else:
             self._api_result_type = 'error'
 
+        # Since some of them metods use a api like response for the ui
+        # {result: error, message: 'Some shit happend'}
+        if isinstance(ret, dict):
+            if ret.get('message'):
+                self._api_msg = ret.get('message', {})
+                ret = {}
+
+            if ret.get('result'):
+                self._api_result_type = ret.get('result')
+
         return self._api_out_as(self._api_responds(result_type=self._api_result_type, msg=self._api_msg, data=ret))

plexpy/notification_handler.py

@@ -666,7 +666,7 @@ def build_notify_text(session=None, timeline=None, notify_action=None, agent_id=
     remaining_duration = duration - view_offset
 
     # Build Plex URL
-    metadata['plex_url'] = 'http://app.plex.tv/web/app#!/server/{0}/details/%2Flibrary%2Fmetadata%2F{1}'.format(
+    metadata['plex_url'] = 'https://app.plex.tv/web/app#!/server/{0}/details/%2Flibrary%2Fmetadata%2F{1}'.format(
         plexpy.CONFIG.PMS_IDENTIFIER, str(rating_key))
 
     # Get media IDs from guid and build URLs

plexpy/plextv.py

@@ -144,7 +144,7 @@ class PlexTV(object):
     Plex.tv authentication
     """
 
-    def __init__(self, username=None, password=None, token=None):
+    def __init__(self, username='', password='', token=None):
         self.protocol = 'HTTPS'
         self.username = username
         self.password = password
@@ -168,7 +168,7 @@ class PlexTV(object):
 
     def get_plex_auth(self, output_format='raw'):
         uri = '/users/sign_in.xml'
-        base64string = base64.encodestring('%s:%s' % (self.username, self.password)).replace('\n', '')
+        base64string = base64.b64encode(('%s:%s' % (self.username, self.password)).encode('utf-8'))
         headers = {'Content-Type': 'application/xml; charset=utf-8',
                    'X-Plex-Device-Name': 'PlexPy',
                    'X-Plex-Product': 'PlexPy',

plexpy/pmsconnect.py

@@ -564,7 +564,6 @@ class PmsConnect(object):
         for a in xml_head:
             if a.getAttribute('size'):
                 if a.getAttribute('size') != '1':
-                    metadata_list = {'metadata': None}
                     return metadata_list
 
             if a.getElementsByTagName('Directory'):

plexpy/version.py

@@ -1,2 +1,2 @@
 PLEXPY_VERSION = "master"
-PLEXPY_RELEASE_VERSION = "1.4.14"
+PLEXPY_RELEASE_VERSION = "1.4.16"

plexpy/web_socket.py

@@ -142,11 +142,12 @@ def process(opcode, data):
 
     try:
         info = json.loads(data)
-    except Exception as ex:
-        logger.warn(u"PlexPy WebSocket :: Error decoding message from websocket: %s" % ex)
+    except Exception as e:
+        logger.warn(u"PlexPy WebSocket :: Error decoding message from websocket: %s" % e)
         logger.debug(data)
         return False
 
+    info = info.get('NotificationContainer', info)
     type = info.get('type')
 
     if not type:
@@ -154,9 +155,9 @@ def process(opcode, data):
 
     if type == 'playing':
         # logger.debug('%s.playing %s' % (name, info))
-        try:
-            time_line = info.get('_children')
-        except:
+        time_line = info.get('PlaySessionStateNotification', info.get('_children'))
+
+        if not time_line:
             logger.debug(u"PlexPy WebSocket :: Session found but unable to get timeline data.")
             return False
 

plexpy/webserve.py

@@ -329,7 +329,9 @@ class WebInterface(object):
     @cherrypy.expose
     @cherrypy.tools.json_out()
     @requireAuth(member_of("admin"))
+    @addtoapi()
     def delete_temp_sessions(self, **kwargs):
+        """ Flush out all of the temporary sessions in the database."""
 
         result = database.delete_sessions()
 
@@ -3212,8 +3214,13 @@ class WebInterface(object):
         quote = self.random_arnold_quotes()
         plexpy.SIGNAL = signal
 
+        if plexpy.CONFIG.HTTP_ROOT:
+            new_http_root = '/' + plexpy.CONFIG.HTTP_ROOT.strip('/') + '/'
+        else:
+            new_http_root = '/'
+
         return serve_template(templatename="shutdown.html", title=title,
-                              message=message, timer=timer, quote=quote)
+                              new_http_root=new_http_root, message=message, timer=timer, quote=quote)
 
     @cherrypy.expose
     @requireAuth(member_of("admin"))
@@ -3245,14 +3252,14 @@ class WebInterface(object):
         if source == 'history':
             data_factory = datafactory.DataFactory()
             result = data_factory.get_metadata_details(rating_key=rating_key)
-            if result:
+            if result and result['metadata']:
                 metadata = result['metadata']
                 poster_url = data_factory.get_poster_url(metadata=metadata)
                 metadata['poster_url'] = poster_url
         else:
             pms_connect = pmsconnect.PmsConnect()
             result = pms_connect.get_metadata_details(rating_key=rating_key, get_media_info=True)
-            if result:
+            if result and result['metadata']:
                 metadata = result['metadata']
                 data_factory = datafactory.DataFactory()
                 poster_url = data_factory.get_poster_url(metadata=metadata)
@@ -3289,8 +3296,7 @@ class WebInterface(object):
 
         refresh = False
         if kwargs.get('refresh'):
-            mo = member_of('admin')
-            refresh = True if mo() else False
+            refresh = False if get_session_user_id() else True
 
         kwargs['refresh'] = refresh