# -*- coding: utf-8 -*- # This file is part of Tautulli. # # Tautulli 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. # # Tautulli 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 Tautulli. If not, see . import sqlite3 from xml.dom import minidom import arrow from plexpy import activity_processor from plexpy import database from plexpy import helpers from plexpy import logger from plexpy import users def extract_plexivity_xml(xml=None): output = {} clean_xml = helpers.latinToAscii(xml) try: xml_parse = minidom.parseString(clean_xml) except: logger.warn("Tautulli Importer :: Error parsing XML for Plexivity database.") return None # I think Plexivity only tracked videos and not music? xml_head = xml_parse.getElementsByTagName('Video') if not xml_head: logger.warn("Tautulli Importer :: Error parsing XML for Plexivity database.") return None for a in xml_head: rating_key = helpers.get_xml_attr(a, 'ratingKey') added_at = helpers.get_xml_attr(a, 'addedAt') art = helpers.get_xml_attr(a, 'art') duration = helpers.get_xml_attr(a, 'duration') grandparent_rating_key = helpers.get_xml_attr(a, 'grandparentRatingKey') grandparent_thumb = helpers.get_xml_attr(a, 'grandparentThumb') grandparent_title = helpers.get_xml_attr(a, 'grandparentTitle') original_title = helpers.get_xml_attr(a, 'originalTitle') guid = helpers.get_xml_attr(a, 'guid') section_id = helpers.get_xml_attr(a, 'librarySectionID') media_index = helpers.get_xml_attr(a, 'index') originally_available_at = helpers.get_xml_attr(a, 'originallyAvailableAt') last_viewed_at = helpers.get_xml_attr(a, 'lastViewedAt') parent_rating_key = helpers.get_xml_attr(a, 'parentRatingKey') parent_media_index = helpers.get_xml_attr(a, 'parentIndex') parent_thumb = helpers.get_xml_attr(a, 'parentThumb') parent_title = helpers.get_xml_attr(a, 'parentTitle') rating = helpers.get_xml_attr(a, 'rating') thumb = helpers.get_xml_attr(a, 'thumb') media_type = helpers.get_xml_attr(a, 'type') updated_at = helpers.get_xml_attr(a, 'updatedAt') view_offset = helpers.get_xml_attr(a, 'viewOffset') year = helpers.get_xml_attr(a, 'year') studio = helpers.get_xml_attr(a, 'studio') title = helpers.get_xml_attr(a, 'title') tagline = helpers.get_xml_attr(a, 'tagline') directors = [] if a.getElementsByTagName('Director'): director_elem = a.getElementsByTagName('Director') for b in director_elem: directors.append(helpers.get_xml_attr(b, 'tag')) aspect_ratio = '' audio_channels = None audio_codec = '' bitrate = None container = '' height = None video_codec = '' video_framerate = '' video_resolution = '' width = None if a.getElementsByTagName('Media'): media_elem = a.getElementsByTagName('Media') for c in media_elem: aspect_ratio = helpers.get_xml_attr(c, 'aspectRatio') audio_channels = helpers.get_xml_attr(c, 'audioChannels') audio_codec = helpers.get_xml_attr(c, 'audioCodec') bitrate = helpers.get_xml_attr(c, 'bitrate') container = helpers.get_xml_attr(c, 'container') height = helpers.get_xml_attr(c, 'height') video_codec = helpers.get_xml_attr(c, 'videoCodec') video_framerate = helpers.get_xml_attr(c, 'videoFrameRate') video_resolution = helpers.get_xml_attr(c, 'videoResolution') width = helpers.get_xml_attr(c, 'width') ip_address = '' machine_id = '' platform = '' player = '' if a.getElementsByTagName('Player'): player_elem = a.getElementsByTagName('Player') for d in player_elem: ip_address = helpers.get_xml_attr(d, 'address').split('::ffff:')[-1] machine_id = helpers.get_xml_attr(d, 'machineIdentifier') platform = helpers.get_xml_attr(d, 'platform') player = helpers.get_xml_attr(d, 'title') transcode_audio_channels = None transcode_audio_codec = '' audio_decision = 'direct play' transcode_container = '' transcode_height = None transcode_protocol = '' transcode_video_codec = '' video_decision = 'direct play' transcode_width = None if a.getElementsByTagName('TranscodeSession'): transcode_elem = a.getElementsByTagName('TranscodeSession') for e in transcode_elem: transcode_audio_channels = helpers.get_xml_attr(e, 'audioChannels') transcode_audio_codec = helpers.get_xml_attr(e, 'audioCodec') audio_decision = helpers.get_xml_attr(e, 'audioDecision') transcode_container = helpers.get_xml_attr(e, 'container') transcode_height = helpers.get_xml_attr(e, 'height') transcode_protocol = helpers.get_xml_attr(e, 'protocol') transcode_video_codec = helpers.get_xml_attr(e, 'videoCodec') video_decision = helpers.get_xml_attr(e, 'videoDecision') transcode_width = helpers.get_xml_attr(e, 'width') # Generate a combined transcode decision value if video_decision == 'transcode' or audio_decision == 'transcode': transcode_decision = 'transcode' elif video_decision == 'copy' or audio_decision == 'copy': transcode_decision = 'copy' else: transcode_decision = 'direct play' user_id = None if a.getElementsByTagName('User'): user_elem = a.getElementsByTagName('User') for f in user_elem: user_id = helpers.get_xml_attr(f, 'id') writers = [] if a.getElementsByTagName('Writer'): writer_elem = a.getElementsByTagName('Writer') for g in writer_elem: writers.append(helpers.get_xml_attr(g, 'tag')) actors = [] if a.getElementsByTagName('Role'): actor_elem = a.getElementsByTagName('Role') for h in actor_elem: actors.append(helpers.get_xml_attr(h, 'tag')) genres = [] if a.getElementsByTagName('Genre'): genre_elem = a.getElementsByTagName('Genre') for i in genre_elem: genres.append(helpers.get_xml_attr(i, 'tag')) labels = [] if a.getElementsByTagName('Lables'): label_elem = a.getElementsByTagName('Lables') for i in label_elem: labels.append(helpers.get_xml_attr(i, 'tag')) output = {'rating_key': rating_key, 'added_at': added_at, 'art': art, 'duration': duration, 'grandparent_rating_key': grandparent_rating_key, 'grandparent_thumb': grandparent_thumb, 'title': title, 'parent_title': parent_title, 'grandparent_title': grandparent_title, 'original_title': original_title, 'tagline': tagline, 'guid': guid, 'section_id': section_id, 'media_index': media_index, 'originally_available_at': originally_available_at, 'last_viewed_at': last_viewed_at, 'parent_rating_key': parent_rating_key, 'parent_media_index': parent_media_index, 'parent_thumb': parent_thumb, 'rating': rating, 'thumb': thumb, 'media_type': media_type, 'updated_at': updated_at, 'view_offset': view_offset, 'year': year, 'directors': directors, 'aspect_ratio': aspect_ratio, 'audio_channels': audio_channels, 'audio_codec': audio_codec, 'bitrate': bitrate, 'container': container, 'height': height, 'video_codec': video_codec, 'video_framerate': video_framerate, 'video_resolution': video_resolution, 'width': width, 'ip_address': ip_address, 'machine_id': machine_id, 'platform': platform, 'player': player, 'transcode_audio_channels': transcode_audio_channels, 'transcode_audio_codec': transcode_audio_codec, 'audio_decision': audio_decision, 'transcode_container': transcode_container, 'transcode_height': transcode_height, 'transcode_protocol': transcode_protocol, 'transcode_video_codec': transcode_video_codec, 'video_decision': video_decision, 'transcode_width': transcode_width, 'transcode_decision': transcode_decision, 'user_id': user_id, 'writers': writers, 'actors': actors, 'genres': genres, 'studio': studio, 'labels': labels } return output def validate_database(database_file=None, table_name=None): try: connection = sqlite3.connect(database_file, timeout=20) except sqlite3.OperationalError: logger.error("Tautulli Importer :: Invalid database specified.") return 'Invalid database specified.' except ValueError: logger.error("Tautulli Importer :: Invalid database specified.") return 'Invalid database specified.' except: logger.error("Tautulli Importer :: Uncaught exception.") return 'Uncaught exception.' try: connection.execute('SELECT xml from %s' % table_name) connection.close() except sqlite3.OperationalError: logger.error("Tautulli Importer :: Invalid database specified.") return 'Invalid database specified.' except: logger.error("Tautulli Importer :: Uncaught exception.") return 'Uncaught exception.' return 'success' def import_from_plexivity(database_file=None, table_name=None, import_ignore_interval=0): try: connection = sqlite3.connect(database_file, timeout=20) connection.row_factory = sqlite3.Row except sqlite3.OperationalError: logger.error("Tautulli Importer :: Invalid filename.") return None except ValueError: logger.error("Tautulli Importer :: Invalid filename.") return None try: connection.execute('SELECT xml from %s' % table_name) except sqlite3.OperationalError: logger.error("Tautulli Importer :: Database specified does not contain the required fields.") return None logger.debug("Tautulli Importer :: Plexivity data import in progress...") database.set_is_importing(True) ap = activity_processor.ActivityProcessor() user_data = users.Users() # Get the latest friends list so we can pull user id's try: users.refresh_users() except: logger.debug("Tautulli Importer :: Unable to refresh the users list. Aborting import.") return None query = "SELECT id AS id, " \ "time AS started, " \ "stopped, " \ "null AS user_id, " \ "user, " \ "ip_address, " \ "paused_counter, " \ "platform AS player, " \ "null AS platform, " \ "null as machine_id, " \ "null AS media_type, " \ "null AS view_offset, " \ "xml, " \ "rating as content_rating," \ "summary," \ "title AS full_title," \ "(case when orig_title_ep = 'n/a' then orig_title else " \ "orig_title_ep end) as title," \ "(case when orig_title_ep != 'n/a' then orig_title else " \ "null end) as grandparent_title " \ "FROM " + table_name + " ORDER BY id" result = connection.execute(query) for row in result: # Extract the xml from the Plexivity db xml field. extracted_xml = extract_plexivity_xml(row['xml']) # If we get back None from our xml extractor skip over the record and log error. if not extracted_xml: logger.error("Tautulli Importer :: Skipping record with id %s due to malformed xml." % str(row['id'])) continue # Skip line if we don't have a ratingKey to work with #if not row['rating_key']: # logger.error("Tautulli Importer :: Skipping record due to null ratingKey.") # 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']) else: user_id = extracted_xml['user_id'] session_history = {'started': arrow.get(row['started']).timestamp(), 'stopped': arrow.get(row['stopped']).timestamp(), 'rating_key': extracted_xml['rating_key'], 'title': row['title'], 'parent_title': extracted_xml['parent_title'], 'grandparent_title': row['grandparent_title'], 'original_title': extracted_xml['original_title'], 'full_title': row['full_title'], 'user_id': user_id, 'user': row['user'], 'ip_address': row['ip_address'] if row['ip_address'] else extracted_xml['ip_address'], 'paused_counter': row['paused_counter'], 'player': row['player'], 'platform': extracted_xml['platform'], 'machine_id': extracted_xml['machine_id'], 'parent_rating_key': extracted_xml['parent_rating_key'], 'grandparent_rating_key': extracted_xml['grandparent_rating_key'], 'media_type': extracted_xml['media_type'], 'view_offset': extracted_xml['view_offset'], 'section_id': extracted_xml['section_id'], 'video_decision': extracted_xml['video_decision'], 'audio_decision': extracted_xml['audio_decision'], 'transcode_decision': extracted_xml['transcode_decision'], 'duration': extracted_xml['duration'], 'width': extracted_xml['width'], 'height': extracted_xml['height'], 'container': extracted_xml['container'], 'video_codec': extracted_xml['video_codec'], 'audio_codec': extracted_xml['audio_codec'], 'bitrate': extracted_xml['bitrate'], 'video_resolution': extracted_xml['video_resolution'], 'video_framerate': extracted_xml['video_framerate'], 'aspect_ratio': extracted_xml['aspect_ratio'], 'audio_channels': extracted_xml['audio_channels'], 'transcode_protocol': extracted_xml['transcode_protocol'], 'transcode_container': extracted_xml['transcode_container'], 'transcode_video_codec': extracted_xml['transcode_video_codec'], 'transcode_audio_codec': extracted_xml['transcode_audio_codec'], 'transcode_audio_channels': extracted_xml['transcode_audio_channels'], 'transcode_width': extracted_xml['transcode_width'], 'transcode_height': extracted_xml['transcode_height'] } session_history_metadata = {'rating_key': extracted_xml['rating_key'], 'parent_rating_key': extracted_xml['parent_rating_key'], 'grandparent_rating_key': extracted_xml['grandparent_rating_key'], 'title': row['title'], 'parent_title': extracted_xml['parent_title'], 'grandparent_title': row['grandparent_title'], 'original_title': extracted_xml['original_title'], 'media_index': extracted_xml['media_index'], 'parent_media_index': extracted_xml['parent_media_index'], 'thumb': extracted_xml['thumb'], 'parent_thumb': extracted_xml['parent_thumb'], 'grandparent_thumb': extracted_xml['grandparent_thumb'], 'art': extracted_xml['art'], 'media_type': extracted_xml['media_type'], 'year': extracted_xml['year'], 'originally_available_at': extracted_xml['originally_available_at'], 'added_at': extracted_xml['added_at'], 'updated_at': extracted_xml['updated_at'], 'last_viewed_at': extracted_xml['last_viewed_at'], 'content_rating': row['content_rating'], 'summary': row['summary'], 'tagline': extracted_xml['tagline'], 'rating': extracted_xml['rating'], 'duration': extracted_xml['duration'], 'guid': extracted_xml['guid'], 'directors': extracted_xml['directors'], 'writers': extracted_xml['writers'], 'actors': extracted_xml['actors'], 'genres': extracted_xml['genres'], 'studio': extracted_xml['studio'], 'labels': extracted_xml['labels'], 'full_title': row['full_title'], 'width': extracted_xml['width'], 'height': extracted_xml['height'], 'container': extracted_xml['container'], 'video_codec': extracted_xml['video_codec'], 'audio_codec': extracted_xml['audio_codec'], 'bitrate': extracted_xml['bitrate'], 'video_resolution': extracted_xml['video_resolution'], 'video_framerate': extracted_xml['video_framerate'], 'aspect_ratio': extracted_xml['aspect_ratio'], 'audio_channels': extracted_xml['audio_channels'] } # 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(): ap.write_session_history(session=session_history, import_metadata=session_history_metadata, is_import=True, import_ignore_interval=import_ignore_interval) else: logger.debug("Tautulli Importer :: Item has bad rating_key: %s" % session_history_metadata['rating_key']) import_users() logger.debug("Tautulli Importer :: Plexivity data import complete.") database.set_is_importing(False) def import_users(): logger.debug("Tautulli Importer :: Importing Plexivity Users...") monitor_db = database.MonitorDatabase() query = "INSERT OR IGNORE INTO users (user_id, username) " \ "SELECT user_id, user " \ "FROM session_history WHERE user_id != 1 GROUP BY user_id" try: monitor_db.action(query) logger.debug("Tautulli Importer :: Users imported.") except: logger.debug("Tautulli Importer :: Failed to import users.")