Updates all metadata in the Tautulli database after moving Plex libraries.

.gitignore

.env

Pipfile

[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]

[packages]
plexapi = "*"
requests = "*"
python-dotenv = "*"

[requires]
python_version = "3"

Pipfile.lock

{
    "_meta": {
        "hash": {
            "sha256": "9804c0c9e49210b24ad4a890bae9973c9a134ef3e938135025a03a4cbb12dbbc"
        },
        "pipfile-spec": 6,
        "requires": {
            "python_version": "3"
        },
        "sources": [
            {
                "name": "pypi",
                "url": "https://pypi.org/simple",
                "verify_ssl": true
            }
        ]
    },
    "default": {
        "certifi": {
            "hashes": [
                "sha256:0f0d56dc5a6ad56fd4ba36484d6cc34451e1c6548c61daad8c320169f91eddc7",
                "sha256:c6c2e98f5c7869efca1f8916fed228dd91539f9f1b444c314c06eef02980c716"
            ],
            "markers": "python_version >= '3.6'",
            "version": "==2023.5.7"
        },
        "charset-normalizer": {
            "hashes": [
                "sha256:04afa6387e2b282cf78ff3dbce20f0cc071c12dc8f685bd40960cc68644cfea6",
                "sha256:04eefcee095f58eaabe6dc3cc2262f3bcd776d2c67005880894f447b3f2cb9c1",
                "sha256:0be65ccf618c1e7ac9b849c315cc2e8a8751d9cfdaa43027d4f6624bd587ab7e",
                "sha256:0c95f12b74681e9ae127728f7e5409cbbef9cd914d5896ef238cc779b8152373",
                "sha256:0ca564606d2caafb0abe6d1b5311c2649e8071eb241b2d64e75a0d0065107e62",
                "sha256:10c93628d7497c81686e8e5e557aafa78f230cd9e77dd0c40032ef90c18f2230",
                "sha256:11d117e6c63e8f495412d37e7dc2e2fff09c34b2d09dbe2bee3c6229577818be",
                "sha256:11d3bcb7be35e7b1bba2c23beedac81ee893ac9871d0ba79effc7fc01167db6c",
                "sha256:12a2b561af122e3d94cdb97fe6fb2bb2b82cef0cdca131646fdb940a1eda04f0",
                "sha256:12d1a39aa6b8c6f6248bb54550efcc1c38ce0d8096a146638fd4738e42284448",
                "sha256:1435ae15108b1cb6fffbcea2af3d468683b7afed0169ad718451f8db5d1aff6f",
                "sha256:1c60b9c202d00052183c9be85e5eaf18a4ada0a47d188a83c8f5c5b23252f649",
                "sha256:1e8fcdd8f672a1c4fc8d0bd3a2b576b152d2a349782d1eb0f6b8e52e9954731d",
                "sha256:20064ead0717cf9a73a6d1e779b23d149b53daf971169289ed2ed43a71e8d3b0",
                "sha256:21fa558996782fc226b529fdd2ed7866c2c6ec91cee82735c98a197fae39f706",
                "sha256:22908891a380d50738e1f978667536f6c6b526a2064156203d418f4856d6e86a",
                "sha256:3160a0fd9754aab7d47f95a6b63ab355388d890163eb03b2d2b87ab0a30cfa59",
                "sha256:322102cdf1ab682ecc7d9b1c5eed4ec59657a65e1c146a0da342b78f4112db23",
                "sha256:34e0a2f9c370eb95597aae63bf85eb5e96826d81e3dcf88b8886012906f509b5",
                "sha256:3573d376454d956553c356df45bb824262c397c6e26ce43e8203c4c540ee0acb",
                "sha256:3747443b6a904001473370d7810aa19c3a180ccd52a7157aacc264a5ac79265e",
                "sha256:38e812a197bf8e71a59fe55b757a84c1f946d0ac114acafaafaf21667a7e169e",
                "sha256:3a06f32c9634a8705f4ca9946d667609f52cf130d5548881401f1eb2c39b1e2c",
                "sha256:3a5fc78f9e3f501a1614a98f7c54d3969f3ad9bba8ba3d9b438c3bc5d047dd28",
                "sha256:3d9098b479e78c85080c98e1e35ff40b4a31d8953102bb0fd7d1b6f8a2111a3d",
                "sha256:3dc5b6a8ecfdc5748a7e429782598e4f17ef378e3e272eeb1340ea57c9109f41",
                "sha256:4155b51ae05ed47199dc5b2a4e62abccb274cee6b01da5b895099b61b1982974",
                "sha256:49919f8400b5e49e961f320c735388ee686a62327e773fa5b3ce6721f7e785ce",
                "sha256:53d0a3fa5f8af98a1e261de6a3943ca631c526635eb5817a87a59d9a57ebf48f",
                "sha256:5f008525e02908b20e04707a4f704cd286d94718f48bb33edddc7d7b584dddc1",
                "sha256:628c985afb2c7d27a4800bfb609e03985aaecb42f955049957814e0491d4006d",
                "sha256:65ed923f84a6844de5fd29726b888e58c62820e0769b76565480e1fdc3d062f8",
                "sha256:6734e606355834f13445b6adc38b53c0fd45f1a56a9ba06c2058f86893ae8017",
                "sha256:6baf0baf0d5d265fa7944feb9f7451cc316bfe30e8df1a61b1bb08577c554f31",
                "sha256:6f4f4668e1831850ebcc2fd0b1cd11721947b6dc7c00bf1c6bd3c929ae14f2c7",
                "sha256:6f5c2e7bc8a4bf7c426599765b1bd33217ec84023033672c1e9a8b35eaeaaaf8",
                "sha256:6f6c7a8a57e9405cad7485f4c9d3172ae486cfef1344b5ddd8e5239582d7355e",
                "sha256:7381c66e0561c5757ffe616af869b916c8b4e42b367ab29fedc98481d1e74e14",
                "sha256:73dc03a6a7e30b7edc5b01b601e53e7fc924b04e1835e8e407c12c037e81adbd",
                "sha256:74db0052d985cf37fa111828d0dd230776ac99c740e1a758ad99094be4f1803d",
                "sha256:75f2568b4189dda1c567339b48cba4ac7384accb9c2a7ed655cd86b04055c795",
                "sha256:78cacd03e79d009d95635e7d6ff12c21eb89b894c354bd2b2ed0b4763373693b",
                "sha256:80d1543d58bd3d6c271b66abf454d437a438dff01c3e62fdbcd68f2a11310d4b",
                "sha256:830d2948a5ec37c386d3170c483063798d7879037492540f10a475e3fd6f244b",
                "sha256:891cf9b48776b5c61c700b55a598621fdb7b1e301a550365571e9624f270c203",
                "sha256:8f25e17ab3039b05f762b0a55ae0b3632b2e073d9c8fc88e89aca31a6198e88f",
                "sha256:9a3267620866c9d17b959a84dd0bd2d45719b817245e49371ead79ed4f710d19",
                "sha256:a04f86f41a8916fe45ac5024ec477f41f886b3c435da2d4e3d2709b22ab02af1",
                "sha256:aaf53a6cebad0eae578f062c7d462155eada9c172bd8c4d250b8c1d8eb7f916a",
                "sha256:abc1185d79f47c0a7aaf7e2412a0eb2c03b724581139193d2d82b3ad8cbb00ac",
                "sha256:ac0aa6cd53ab9a31d397f8303f92c42f534693528fafbdb997c82bae6e477ad9",
                "sha256:ac3775e3311661d4adace3697a52ac0bab17edd166087d493b52d4f4f553f9f0",
                "sha256:b06f0d3bf045158d2fb8837c5785fe9ff9b8c93358be64461a1089f5da983137",
                "sha256:b116502087ce8a6b7a5f1814568ccbd0e9f6cfd99948aa59b0e241dc57cf739f",
                "sha256:b82fab78e0b1329e183a65260581de4375f619167478dddab510c6c6fb04d9b6",
                "sha256:bd7163182133c0c7701b25e604cf1611c0d87712e56e88e7ee5d72deab3e76b5",
                "sha256:c36bcbc0d5174a80d6cccf43a0ecaca44e81d25be4b7f90f0ed7bcfbb5a00909",
                "sha256:c3af8e0f07399d3176b179f2e2634c3ce9c1301379a6b8c9c9aeecd481da494f",
                "sha256:c84132a54c750fda57729d1e2599bb598f5fa0344085dbde5003ba429a4798c0",
                "sha256:cb7b2ab0188829593b9de646545175547a70d9a6e2b63bf2cd87a0a391599324",
                "sha256:cca4def576f47a09a943666b8f829606bcb17e2bc2d5911a46c8f8da45f56755",
                "sha256:cf6511efa4801b9b38dc5546d7547d5b5c6ef4b081c60b23e4d941d0eba9cbeb",
                "sha256:d16fd5252f883eb074ca55cb622bc0bee49b979ae4e8639fff6ca3ff44f9f854",
                "sha256:d2686f91611f9e17f4548dbf050e75b079bbc2a82be565832bc8ea9047b61c8c",
                "sha256:d7fc3fca01da18fbabe4625d64bb612b533533ed10045a2ac3dd194bfa656b60",
                "sha256:dd5653e67b149503c68c4018bf07e42eeed6b4e956b24c00ccdf93ac79cdff84",
                "sha256:de5695a6f1d8340b12a5d6d4484290ee74d61e467c39ff03b39e30df62cf83a0",
                "sha256:e0ac8959c929593fee38da1c2b64ee9778733cdf03c482c9ff1d508b6b593b2b",
                "sha256:e1b25e3ad6c909f398df8921780d6a3d120d8c09466720226fc621605b6f92b1",
                "sha256:e633940f28c1e913615fd624fcdd72fdba807bf53ea6925d6a588e84e1151531",
                "sha256:e89df2958e5159b811af9ff0f92614dabf4ff617c03a4c1c6ff53bf1c399e0e1",
                "sha256:ea9f9c6034ea2d93d9147818f17c2a0860d41b71c38b9ce4d55f21b6f9165a11",
                "sha256:f645caaf0008bacf349875a974220f1f1da349c5dbe7c4ec93048cdc785a3326",
                "sha256:f8303414c7b03f794347ad062c0516cee0e15f7a612abd0ce1e25caf6ceb47df",
                "sha256:fca62a8301b605b954ad2e9c3666f9d97f63872aa4efcae5492baca2056b74ab"
            ],
            "markers": "python_full_version >= '3.7.0'",
            "version": "==3.1.0"
        },
        "idna": {
            "hashes": [
                "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4",
                "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"
            ],
            "markers": "python_version >= '3.5'",
            "version": "==3.4"
        },
        "plexapi": {
            "hashes": [
                "sha256:7e665278f68ddf659d42c4c249c2a87c96c280e01ea48adf9343bd525b3a59db",
                "sha256:fc62b16fbf80e382e9a1e69064e6a003a7d3099f90622c56e4a06e2a6e1cc4b9"
            ],
            "index": "pypi",
            "version": "==4.14.0"
        },
        "python-dotenv": {
            "hashes": [
                "sha256:a8df96034aae6d2d50a4ebe8216326c61c3eb64836776504fcca410e5937a3ba",
                "sha256:f5971a9226b701070a4bf2c38c89e5a3f0d64de8debda981d1db98583009122a"
            ],
            "index": "pypi",
            "version": "==1.0.0"
        },
        "requests": {
            "hashes": [
                "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f",
                "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"
            ],
            "index": "pypi",
            "version": "==2.31.0"
        },
        "urllib3": {
            "hashes": [
                "sha256:48e7fafa40319d358848e1bc6809b208340fafe2096f1725d05d67443d0483d1",
                "sha256:bee28b5e56addb8226c96f7f13ac28cb4c301dd5ea8a6ca179c0b9835e032825"
            ],
            "markers": "python_version >= '3.7'",
            "version": "==2.0.3"
        }
    },
    "develop": {}
}

update_all_metadata.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Description:  Updates all metadata in the Tautulli database after moving Plex libraries.
# Author:       /u/SwiftPanda16
# Requires:     plexapi, requests

from plexapi.server import PlexServer
from dotenv import load_dotenv
import requests
import os

load_dotenv()

### EDIT SETTINGS ###

## Install the required modules listed above with:
##    python -m pip install plexapi
##    python -m pip install requests

TAUTULLI_URL = os.getenv('TAUTULLI_URL')
TAUTULLI_APIKEY = os.getenv('TAUTULLI_APIKEY')
PLEX_URL = os.getenv('PLEX_URL')
PLEX_TOKEN = os.getenv('PLEX_TOKEN')

FALLBACK_MATCH_TITLE_YEAR = True  # True or False, fallback to matching by title and year if matching by ID fails
FALLBACK_MATCH_TITLE = True       # True or False, fallback to matching by title ONLY if matching by title and year fails
DRY_RUN = True                    # True to dry run without making changes to the Tautulli database, False to make changes



## CODE BELOW ##

def get_id_from_guid(guid):
    #print(guid)
    id = None
    if 'imdb://' in guid:
        id = 'imdb://' + guid.split('imdb://')[1].split('?')[0]
    elif 'themoviedb://' in guid:
        id = 'tmdb://' + guid.split('themoviedb://')[1].split('?')[0]
    elif 'thetvdb://' in guid:
        id = 'tvdb://' + guid.split('thetvdb://')[1].split('?')[0].split('/')[0]
    elif 'plex://' in guid:
        id = 'plex://' + guid.split('plex://')[1]
    elif 'com.plexapp.agents.hama://' in guid:
        id = 'com.plexapp.agents.hama://' + guid.split('com.plexapp.agents.hama://')[1].split('?')[0].split('/')[0]
    elif 'tmdb://' in guid or 'tvdb://' in guid or 'mbid://' in guid:
        id = guid
    return id


def main():
    session = requests.Session()

    new_key_map = {}
    old_key_map = {}

    # Check for DRY_RUN. Backup Tautulli database if needed.
    if DRY_RUN:
        print("Dry run enabled. No changes will be made to the Tautulli database.")
    else:
        print("Not dry run. Creating a backup of the Tautulli database.")
        params = {
            'cmd': 'backup_db',
            'apikey': TAUTULLI_APIKEY,
        }
        session.post(TAUTULLI_URL.rstrip('/') + '/api/v2', params=params)

    # Get all old items from the Tautulli database (using raw SQL)
    print("Retrieving all history items from the Tautulli database...")

    recordsFiltered = None
    count = 0
    start = 0
    while recordsFiltered is None or count < recordsFiltered:
        params = {
            'cmd': 'get_history',
            'apikey': TAUTULLI_APIKEY,
            'grouping': 0,
            'include_activity': 0,
            'media_type': 'movie,episode,track',
            'order_column': 'date',
            'order_dir': 'desc',
            'start': start,
            'length': 1000
        }
        r = session.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=params).json()

        if r['response']['result'] == 'error':
            print("Error retrieving Tautulli history: {}".format(r['response']['message']))
            print("Exiting script...")
            return
        
        else:
            if recordsFiltered is None:
                recordsFiltered = r['response']['data']['recordsFiltered']

            for row in r['response']['data']['data']:
                count += 1

                if row['media_type'] not in ('movie', 'episode'):
                    continue

                id = get_id_from_guid(row['guid'])
                if id:
                    key = row['grandparent_rating_key'] or row['rating_key']
                    media_type = 'show' if row['media_type'] == 'episode' else row['media_type']
                    title = row['grandparent_title'] or row['title']
                    year = str(row['year'])

                    old_key_map[id] = (key, media_type, title, year)
                else:
                    title = row['grandparent_title'] or row['title']
                    print("\tUnsupported guid for '{title}' in the Tautulli database [Guid: {guid}]. Skipping...".format(title=title, guid=row['guid']))

        start += 1000

    # Get all new items from the Plex server
    print("Retrieving all library items from the Plex server...")

    plex = PlexServer(PLEX_URL, PLEX_TOKEN)

    for library in plex.library.sections():
        if library.type not in ('movie', 'show') or library.agent == 'com.plexapp.agents.none':
            print("\tSkipping library: {title}".format(title=library.title))
            continue

        print("\tScanning library: {title}".format(title=library.title))
        for item in library.all():
            id = get_id_from_guid(item.guid)
            if id:
                new_key_map[id] = (item.ratingKey, item.type, item.title, str(item.year))
            else:
                print("\t\tUnsupported guid for '{title}' in the Plex library [Guid: {guid}]. Skipping...".format(title=item.title, guid=item.guid))

            for guid in item.guids:  # Also parse <Guid> tags for new Plex agents
                id = get_id_from_guid(guid.id)
                if id:
                    new_key_map[id] = (item.ratingKey, item.type, item.title, str(item.year))

    new_title_year_map = {(title, year): (id, key, media_type) for id, (key, media_type, title, year) in new_key_map.items()}
    new_title_map = {title: (id, key, media_type, year) for id, (key, media_type, title, year) in new_key_map.items()}

    # Update metadata in the Tautulli database
    print("{}Matching Tautulli items with Plex items...".format("(DRY RUN) " if DRY_RUN else ""))
    if FALLBACK_MATCH_TITLE_YEAR:
        print("\tUsing fallback to match by title and year.")
    if FALLBACK_MATCH_TITLE:
        print("\tUsing fallback to match by title ONLY.")
    if not FALLBACK_MATCH_TITLE_YEAR and not FALLBACK_MATCH_TITLE:
        print("\tNot using any fallback to title or year.")

    updated = []
    no_mapping = set()

    for id, (old_rating_key, old_type, title, year) in old_key_map.items():
        new_rating_key, new_type, _, _ = new_key_map.get(id, (None, None, None, None))
        new_year = None
        warning_year = False

        if not new_rating_key and FALLBACK_MATCH_TITLE_YEAR:
            _, new_rating_key, new_type = new_title_year_map.get((title, year), (None, None, None))
            if not new_rating_key and FALLBACK_MATCH_TITLE:
                _, new_rating_key, new_type, new_year = new_title_map.get(title, (None, None, None, None))
            
        if new_rating_key:
            if new_rating_key != old_rating_key and new_type == old_type:
                if new_year is not None and new_year != year:
                    warning_year = True
                updated.append((title, year, old_rating_key, new_rating_key, new_type, new_year, warning_year))
        else:
            no_mapping.add((title, year, old_rating_key))

    if updated:
        if not DRY_RUN:
            url = TAUTULLI_URL.rstrip('/') + '/api/v2'
            for title, year, old_rating_key, new_rating_key, new_type, new_year, warning_year in updated:
                params = {
                    'cmd': 'update_metadata_details',
                    'apikey': TAUTULLI_APIKEY,
                    'old_rating_key': old_rating_key,
                    'new_rating_key': new_rating_key,
                    'media_type': new_type
                }
                session.post(url, params=params)

        print("{}Updated metadata for {} items:".format("(DRY RUN) " if DRY_RUN else "", len(updated)))
        for title, year, old_rating_key, new_rating_key, new_type, new_year, warning_year in updated:
            if warning_year:
                print("\t{title} ({year} --> {new_year}) [Rating Key: {old} --> {new}]".format(
                      title=title, year=year, new_year=new_year, old=old_rating_key, new=new_rating_key))
            else:
                print("\t{title} ({year}) [Rating Key: {old} --> {new}]".format(
                      title=title, year=year, old=old_rating_key, new=new_rating_key))

    if no_mapping:
        print("{}No match found for {} Tautulli items on the Plex server:".format("(DRY RUN) " if DRY_RUN else "", len(no_mapping)))
        for title, year, old_rating_key in no_mapping:
            print("\t{title} ({year}) [Rating Key: {old}]".format(
                  title=title, year=year, old=old_rating_key))

    # Clear all recently added items in the Tautulli database
    print("{}Clearing all recently added items in the Tautulli database...".format("(DRY RUN) " if DRY_RUN else ""))
    
    if not DRY_RUN:
        params = {
            'cmd': 'delete_recently_added',
            'apikey': TAUTULLI_APIKEY
        }
        r = session.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=params).json()

        if r['response']['result'] == 'error':
            print("Error clearing the Tautulli recently added database table: {}".format(r['response']['message']))
            print("Exiting script...")
            return

    print("Cleared all items from the Tautulli recently added database table.")


if __name__ == "__main__":
    main()

    print("Done.")