From 1efb4d85431ef49c15bdb7d53024c0676c1724d5 Mon Sep 17 00:00:00 2001 From: luigi311 Date: Wed, 6 Jul 2022 17:22:35 -0600 Subject: [PATCH 1/4] Fix debug --- src/functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/functions.py b/src/functions.py index 6ca8751..5ad3ef7 100644 --- a/src/functions.py +++ b/src/functions.py @@ -13,7 +13,7 @@ def logger(message: str, log_type=0): output = str(message) if log_type == 0: pass - elif log_type == 1 and (debug or debug_level == "info"): + elif log_type == 1 and (debug and debug_level == "info"): output = f"[INFO]: {output}" elif log_type == 2: output = f"[ERROR]: {output}" From 88a7526721e57e703973d564f0e04a671189a096 Mon Sep 17 00:00:00 2001 From: Luigi311 Date: Sun, 10 Jul 2022 01:30:12 -0600 Subject: [PATCH 2/4] Use async for jellyfin (#23) * Use async * Massive jellyfin watched speedup Co-authored-by: Luigi311 --- .env.sample | 84 +- .github/workflows/ci.yml | 172 ++-- .gitignore | 264 +++--- .vscode/launch.json | 32 +- Dockerfile | 70 +- LICENSE | 1348 ++++++++++++++--------------- README.md | 146 ++-- main.py | 20 +- requirements.txt | 7 +- src/functions.py | 321 +++---- src/jellyfin.py | 720 ++++++++------- src/main.py | 891 +++++++++---------- src/plex.py | 630 +++++++------- test/requirements.txt | 2 +- test/test_main_.py | 94 +- test/test_main_cleanup_watched.py | 352 ++++---- 16 files changed, 2623 insertions(+), 2530 deletions(-) diff --git a/.env.sample b/.env.sample index cce23ea..49bbe65 100644 --- a/.env.sample +++ b/.env.sample @@ -1,42 +1,42 @@ -## Do not mark any shows/movies as played and instead just output to log if they would of been marked. -DRYRUN = "True" -## Additional logging information -DEBUG = "True" -## Debugging level, "info" is default, "debug" is more verbose -DEBUG_LEVEL = "info" -## How often to run the script in seconds -SLEEP_DURATION = "3600" -## Log file where all output will be written to -LOGFILE = "log.log" -## Map usernames between plex and jellyfin in the event that they are different, order does not matter -#USER_MAPPING = { "testuser2": "testuser3" } -## Map libraries between plex and jellyfin in the even that they are different, order does not matter -#LIBRARY_MAPPING = { "Shows": "TV Shows" } - - -## Recommended to use token as it is faster to connect as it is direct to the server instead of going through the plex servers -## URL of the plex server, use hostname or IP address if the hostname is not resolving correctly -## Comma seperated list for multiple servers -PLEX_BASEURL = "http://localhost:32400" -## Plex token https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ -PLEX_TOKEN = "SuperSecretToken" -## If not using plex token then use username and password of the server admin along with the servername -#PLEX_USERNAME = "" -#PLEX_PASSWORD = "" -#PLEX_SERVERNAME = "Plex Server" - - -## Jellyfin server URL, use hostname or IP address if the hostname is not resolving correctly -## Comma seperated list for multiple servers -JELLYFIN_BASEURL = "http://localhost:8096" -## Jellyfin api token, created manually by logging in to the jellyfin server admin dashboard and creating an api key -JELLYFIN_TOKEN = "SuperSecretToken" - - -## Blacklisting/Whitelisting libraries, library types such as Movies/TV Shows, and users. Mappings apply so if the mapping for the user or library exist then both will be excluded. -#BLACKLIST_LIBRARY = "" -#WHITELIST_LIBRARY = "" -#BLACKLIST_LIBRARY_TYPE = "" -#WHITELIST_LIBRARY_TYPE = "" -#BLACKLIST_USERS = "" -WHITELIST_USERS = "testuser1,testuser2" +## Do not mark any shows/movies as played and instead just output to log if they would of been marked. +DRYRUN = "True" +## Additional logging information +DEBUG = "True" +## Debugging level, "info" is default, "debug" is more verbose +DEBUG_LEVEL = "info" +## How often to run the script in seconds +SLEEP_DURATION = "3600" +## Log file where all output will be written to +LOGFILE = "log.log" +## Map usernames between plex and jellyfin in the event that they are different, order does not matter +#USER_MAPPING = { "testuser2": "testuser3" } +## Map libraries between plex and jellyfin in the even that they are different, order does not matter +#LIBRARY_MAPPING = { "Shows": "TV Shows" } + + +## Recommended to use token as it is faster to connect as it is direct to the server instead of going through the plex servers +## URL of the plex server, use hostname or IP address if the hostname is not resolving correctly +## Comma seperated list for multiple servers +PLEX_BASEURL = "http://localhost:32400" +## Plex token https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/ +PLEX_TOKEN = "SuperSecretToken" +## If not using plex token then use username and password of the server admin along with the servername +#PLEX_USERNAME = "" +#PLEX_PASSWORD = "" +#PLEX_SERVERNAME = "Plex Server" + + +## Jellyfin server URL, use hostname or IP address if the hostname is not resolving correctly +## Comma seperated list for multiple servers +JELLYFIN_BASEURL = "http://localhost:8096" +## Jellyfin api token, created manually by logging in to the jellyfin server admin dashboard and creating an api key +JELLYFIN_TOKEN = "SuperSecretToken" + + +## Blacklisting/Whitelisting libraries, library types such as Movies/TV Shows, and users. Mappings apply so if the mapping for the user or library exist then both will be excluded. +#BLACKLIST_LIBRARY = "" +#WHITELIST_LIBRARY = "" +#BLACKLIST_LIBRARY_TYPE = "" +#WHITELIST_LIBRARY_TYPE = "" +#BLACKLIST_USERS = "" +WHITELIST_USERS = "testuser1,testuser2" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e56dbcb..24535c1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,86 +1,86 @@ -name: CI -on: - push: - paths-ignore: - - .gitignore - - "*.md" - pull_request: - paths-ignore: - - .gitignore - - "*.md" - -jobs: - pytest: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - - name: "Install dependencies" - run: pip install -r requirements.txt && pip install -r test/requirements.txt - - - name: "Run tests" - run: pytest -vvv - - docker: - runs-on: ubuntu-latest - needs: pytest - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Docker meta - id: docker_meta - env: - DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} - if: "${{ env.DOCKER_USERNAME != '' }}" - uses: docker/metadata-action@v4 - with: - images: ${{ secrets.DOCKER_USERNAME }}/jellyplex-watched # list of Docker images to use as base name for tags - tags: | - type=raw,value=latest,enable={{is_default_branch}} - type=ref,event=branch - type=ref,event=pr - type=semver,pattern={{version}} - type=semver,pattern={{major}}.{{minor}} - type=sha - - - name: Set up QEMU - uses: docker/setup-qemu-action@v1 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v1 - - - name: Login to DockerHub - if: "${{ steps.docker_meta.outcome == 'success' }}" - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_TOKEN }} - - - name: Build - id: build - if: "${{ steps.docker_meta.outcome == 'skipped' }}" - uses: docker/build-push-action@v2 - with: - context: . - file: ./Dockerfile - platforms: linux/amd64,linux/arm64 - push: false - tags: jellyplex-watched:action - - - name: Build Push - id: build_push - if: "${{ steps.docker_meta.outcome == 'success' }}" - uses: docker/build-push-action@v2 - with: - context: . - file: ./Dockerfile - platforms: linux/amd64,linux/arm64 - push: true - tags: ${{ steps.docker_meta.outputs.tags }} - labels: ${{ steps.docker_meta.outputs.labels }} - - # Echo digest so users can validate their image - - name: Image digest - if: "${{ steps.docker_meta.outcome == 'success' }}" - run: echo "${{ steps.build_push.outputs.digest }}" +name: CI +on: + push: + paths-ignore: + - .gitignore + - "*.md" + pull_request: + paths-ignore: + - .gitignore + - "*.md" + +jobs: + pytest: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: "Install dependencies" + run: pip install -r requirements.txt && pip install -r test/requirements.txt + + - name: "Run tests" + run: pytest -vvv + + docker: + runs-on: ubuntu-latest + needs: pytest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Docker meta + id: docker_meta + env: + DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} + if: "${{ env.DOCKER_USERNAME != '' }}" + uses: docker/metadata-action@v4 + with: + images: ${{ secrets.DOCKER_USERNAME }}/jellyplex-watched # list of Docker images to use as base name for tags + tags: | + type=raw,value=latest,enable={{is_default_branch}} + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + type=sha + + - name: Set up QEMU + uses: docker/setup-qemu-action@v1 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Login to DockerHub + if: "${{ steps.docker_meta.outcome == 'success' }}" + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_TOKEN }} + + - name: Build + id: build + if: "${{ steps.docker_meta.outcome == 'skipped' }}" + uses: docker/build-push-action@v2 + with: + context: . + file: ./Dockerfile + platforms: linux/amd64,linux/arm64 + push: false + tags: jellyplex-watched:action + + - name: Build Push + id: build_push + if: "${{ steps.docker_meta.outcome == 'success' }}" + uses: docker/build-push-action@v2 + with: + context: . + file: ./Dockerfile + platforms: linux/amd64,linux/arm64 + push: true + tags: ${{ steps.docker_meta.outputs.tags }} + labels: ${{ steps.docker_meta.outputs.labels }} + + # Echo digest so users can validate their image + - name: Image digest + if: "${{ steps.docker_meta.outcome == 'success' }}" + run: echo "${{ steps.build_push.outputs.digest }}" diff --git a/.gitignore b/.gitignore index 06e876a..de129d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,132 +1,132 @@ -.env -*.prof - -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ +.env +*.prof + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/.vscode/launch.json b/.vscode/launch.json index aa73483..5092265 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -1,16 +1,16 @@ -{ - // Use IntelliSense to learn about possible attributes. - // Hover to view descriptions of existing attributes. - // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 - "version": "0.2.0", - "configurations": [ - { - "name": "Python: Main", - "type": "python", - "request": "launch", - "program": "main.py", - "console": "integratedTerminal", - "justMyCode": true - } - ] -} +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Python: Main", + "type": "python", + "request": "launch", + "program": "main.py", + "console": "integratedTerminal", + "justMyCode": true + } + ] +} diff --git a/Dockerfile b/Dockerfile index ab72099..114ec3b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,35 +1,35 @@ -FROM python:3-slim - -ENV DRYRUN 'True' -ENV DEBUG 'True' -ENV DEBUG_LEVEL 'INFO' -ENV SLEEP_DURATION '3600' -ENV LOGFILE 'log.log' - -ENV USER_MAPPING '{ "User Test": "User Test2" }' -ENV LIBRARY_MAPPING '{ "Shows Test": "TV Shows Test" }' - -ENV PLEX_BASEURL 'http://localhost:32400' -ENV PLEX_TOKEN '' -ENV PLEX_USERNAME '' -ENV PLEX_PASSWORD '' -ENV PLEX_SERVERNAME '' - -ENV JELLYFIN_BASEURL 'http://localhost:8096' -ENV JELLYFIN_TOKEN '' - -ENV BLACKLIST_LIBRARY '' -ENV WHITELIST_LIBRARY '' -ENV BLACKLIST_LIBRARY_TYPE '' -ENV WHITELIST_LIBRARY_TYPE '' -ENV BLACKLIST_USERS '' -ENV WHITELIST_USERS '' - -WORKDIR /app - -COPY ./requirements.txt ./ -RUN pip install --no-cache-dir -r requirements.txt - -COPY . . - -CMD ["python", "-u", "main.py"] +FROM python:3-slim + +ENV DRYRUN 'True' +ENV DEBUG 'True' +ENV DEBUG_LEVEL 'INFO' +ENV SLEEP_DURATION '3600' +ENV LOGFILE 'log.log' + +ENV USER_MAPPING '{ "User Test": "User Test2" }' +ENV LIBRARY_MAPPING '{ "Shows Test": "TV Shows Test" }' + +ENV PLEX_BASEURL 'http://localhost:32400' +ENV PLEX_TOKEN '' +ENV PLEX_USERNAME '' +ENV PLEX_PASSWORD '' +ENV PLEX_SERVERNAME '' + +ENV JELLYFIN_BASEURL 'http://localhost:8096' +ENV JELLYFIN_TOKEN '' + +ENV BLACKLIST_LIBRARY '' +ENV WHITELIST_LIBRARY '' +ENV BLACKLIST_LIBRARY_TYPE '' +ENV WHITELIST_LIBRARY_TYPE '' +ENV BLACKLIST_USERS '' +ENV WHITELIST_USERS '' + +WORKDIR /app + +COPY ./requirements.txt ./ +RUN pip install --no-cache-dir -r requirements.txt + +COPY . . + +CMD ["python", "-u", "main.py"] diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program 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. - - This program 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 this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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. + + This program 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 this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 0da25f4..48ae295 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,73 @@ -# JellyPlex-Watched - -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/26b47c5db63942f28f02f207f692dc85)](https://www.codacy.com/gh/luigi311/JellyPlex-Watched/dashboard?utm_source=github.com&utm_medium=referral&utm_content=luigi311/JellyPlex-Watched&utm_campaign=Badge_Grade) - -Sync watched between jellyfin and plex - -## Description - -Keep in sync all your users watched history between jellyfin and plex servers locally. This uses the imdb ids and any other matching id to find the correct episode/movie between the two. This is not perfect but it works for most cases. You can use this for as many servers as you want by enterying multiple options in the .env plex/jellyfin section seperated by commas. - -## Configuration - - - -## Installation - -### Baremetal - -- Setup virtualenv of your choice - -- Install dependencies - - ```bash - pip install -r requirements.txt - ``` - -- Create a .env file similar to .env.sample, uncomment whitelist and blacklist if needed, fill in baseurls and tokens - -- Run - - ```bash - python main.py - ``` - -### Docker - -- Build docker image - - ```bash - docker build -t jellyplex-watched . - ``` - -- or use pre-built image - - ```bash - docker pull luigi311/jellyplex-watched:latest - ``` - -#### With variables - -- Run - - ```bash - docker run --rm -it -e PLEX_TOKEN='SuperSecretToken' luigi311/jellyplex-watched:latest - ``` - -#### With .env - -- Create a .env file similar to .env.sample and set the MNEMONIC variable to your seed phrase - -- Run - - ```bash - docker run --rm -it -v "$(pwd)/.env:/app/.env" luigi311/jellyplex-watched:latest - ``` - -## Contributing - -I am open to recieving pull requests. If you are submitting a pull request, please make sure run it locally for a day or two to make sure it is working as expected and stable. Make all pull requests against the dev branch and nothing will be merged into the main without going through the lower branches. - -## License - -This is currently under the GNU General Public License v3.0. +# JellyPlex-Watched + +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/26b47c5db63942f28f02f207f692dc85)](https://www.codacy.com/gh/luigi311/JellyPlex-Watched/dashboard?utm_source=github.com&utm_medium=referral&utm_content=luigi311/JellyPlex-Watched&utm_campaign=Badge_Grade) + +Sync watched between jellyfin and plex + +## Description + +Keep in sync all your users watched history between jellyfin and plex servers locally. This uses the imdb ids and any other matching id to find the correct episode/movie between the two. This is not perfect but it works for most cases. You can use this for as many servers as you want by enterying multiple options in the .env plex/jellyfin section seperated by commas. + +## Configuration + + + +## Installation + +### Baremetal + +- Setup virtualenv of your choice + +- Install dependencies + + ```bash + pip install -r requirements.txt + ``` + +- Create a .env file similar to .env.sample, uncomment whitelist and blacklist if needed, fill in baseurls and tokens + +- Run + + ```bash + python main.py + ``` + +### Docker + +- Build docker image + + ```bash + docker build -t jellyplex-watched . + ``` + +- or use pre-built image + + ```bash + docker pull luigi311/jellyplex-watched:latest + ``` + +#### With variables + +- Run + + ```bash + docker run --rm -it -e PLEX_TOKEN='SuperSecretToken' luigi311/jellyplex-watched:latest + ``` + +#### With .env + +- Create a .env file similar to .env.sample and set the MNEMONIC variable to your seed phrase + +- Run + + ```bash + docker run --rm -it -v "$(pwd)/.env:/app/.env" luigi311/jellyplex-watched:latest + ``` + +## Contributing + +I am open to recieving pull requests. If you are submitting a pull request, please make sure run it locally for a day or two to make sure it is working as expected and stable. Make all pull requests against the dev branch and nothing will be merged into the main without going through the lower branches. + +## License + +This is currently under the GNU General Public License v3.0. diff --git a/main.py b/main.py index 866f866..1e5ee99 100644 --- a/main.py +++ b/main.py @@ -1,10 +1,10 @@ -import sys - -if __name__ == '__main__': - # Check python version 3.6 or higher - if not (3, 6) <= tuple(map(int, sys.version_info[:2])): - print("This script requires Python 3.6 or higher") - sys.exit(1) - - from src.main import main - main() +import sys + +if __name__ == '__main__': + # Check python version 3.6 or higher + if not (3, 6) <= tuple(map(int, sys.version_info[:2])): + print("This script requires Python 3.6 or higher") + sys.exit(1) + + from src.main import main + main() diff --git a/requirements.txt b/requirements.txt index 8e3b517..b5d8e22 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ -plexapi -requests -python-dotenv +plexapi +requests +python-dotenv +aiohttp diff --git a/src/functions.py b/src/functions.py index 5ad3ef7..64718d8 100644 --- a/src/functions.py +++ b/src/functions.py @@ -1,155 +1,166 @@ -import os -from concurrent.futures import ThreadPoolExecutor -from dotenv import load_dotenv - -load_dotenv(override=True) - -logfile = os.getenv("LOGFILE","log.log") - -def logger(message: str, log_type=0): - debug = str_to_bool(os.getenv("DEBUG", "True")) - debug_level = os.getenv("DEBUG_LEVEL", "info").lower() - - output = str(message) - if log_type == 0: - pass - elif log_type == 1 and (debug and debug_level == "info"): - output = f"[INFO]: {output}" - elif log_type == 2: - output = f"[ERROR]: {output}" - elif log_type == 3 and (debug and debug_level == "debug"): - output = f"[DEBUG]: {output}" - else: - output = None - - if output is not None: - print(output) - file = open(logfile, "a", encoding="utf-8") - file.write(output + "\n") - -# Reimplementation of distutils.util.strtobool due to it being deprecated -# Source: https://github.com/PostHog/posthog/blob/01e184c29d2c10c43166f1d40a334abbc3f99d8a/posthog/utils.py#L668 -def str_to_bool(value: any) -> bool: - if not value: - return False - return str(value).lower() in ("y", "yes", "t", "true", "on", "1") - -# Get mapped value -def search_mapping(dictionary: dict, key_value: str): - if key_value in dictionary.keys(): - return dictionary[key_value] - elif key_value.lower() in dictionary.keys(): - return dictionary[key_value.lower()] - elif key_value in dictionary.values(): - return list(dictionary.keys())[list(dictionary.values()).index(key_value)] - elif key_value.lower() in dictionary.values(): - return list(dictionary.keys())[list(dictionary.values()).index(key_value.lower())] - else: - return None - - -def check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping): - skip_reason = None - - if library_type.lower() in blacklist_library_type: - skip_reason = "is blacklist_library_type" - - if library_title.lower() in [x.lower() for x in blacklist_library]: - skip_reason = "is blacklist_library" - - library_other = None - if library_mapping: - library_other = search_mapping(library_mapping, library_title) - if library_other: - if library_other.lower() in [x.lower() for x in blacklist_library]: - skip_reason = "is blacklist_library" - - if len(whitelist_library_type) > 0: - if library_type.lower() not in whitelist_library_type: - skip_reason = "is not whitelist_library_type" - - # if whitelist is not empty and library is not in whitelist - if len(whitelist_library) > 0: - if library_title.lower() not in [x.lower() for x in whitelist_library]: - skip_reason = "is not whitelist_library" - - if library_other: - if library_other.lower() not in [x.lower() for x in whitelist_library]: - skip_reason = "is not whitelist_library" - - return skip_reason - - -def generate_library_guids_dict(user_list: dict): - show_output_dict = {} - episode_output_dict = {} - movies_output_dict = {} - - try: - show_output_keys = user_list.keys() - show_output_keys = ([ dict(x) for x in list(show_output_keys) ]) - for show_key in show_output_keys: - for provider_key, provider_value in show_key.items(): - # Skip title - if provider_key.lower() == "title": - continue - if provider_key.lower() not in show_output_dict: - show_output_dict[provider_key.lower()] = [] - if provider_key.lower() == "locations": - for show_location in provider_value: - show_output_dict[provider_key.lower()].append(show_location) - else: - show_output_dict[provider_key.lower()].append(provider_value.lower()) - except: - pass - - try: - for show in user_list: - for season in user_list[show]: - for episode in user_list[show][season]: - for episode_key, episode_value in episode.items(): - if episode_key.lower() not in episode_output_dict: - episode_output_dict[episode_key.lower()] = [] - if episode_key == "locations": - for episode_location in episode_value: - episode_output_dict[episode_key.lower()].append(episode_location) - else: - episode_output_dict[episode_key.lower()].append(episode_value.lower()) - except: - pass - - try: - for movie in user_list: - for movie_key, movie_value in movie.items(): - if movie_key.lower() not in movies_output_dict: - movies_output_dict[movie_key.lower()] = [] - if movie_key == "locations": - for movie_location in movie_value: - movies_output_dict[movie_key.lower()].append(movie_location) - else: - movies_output_dict[movie_key.lower()].append(movie_value.lower()) - except: - pass - - return show_output_dict, episode_output_dict, movies_output_dict - -def future_thread_executor(args: list, workers: int = -1): - futures_list = [] - results = [] - - if workers == -1: - workers = min(32, os.cpu_count()*1.25) - - with ThreadPoolExecutor(max_workers=workers) as executor: - for arg in args: - # * arg unpacks the list into actual arguments - futures_list.append(executor.submit(*arg)) - - for future in futures_list: - try: - result = future.result() - results.append(result) - except Exception as e: - raise Exception(e) - - return results +import os +from concurrent.futures import ThreadPoolExecutor +from dotenv import load_dotenv + +load_dotenv(override=True) + +logfile = os.getenv("LOGFILE","log.log") + +def logger(message: str, log_type=0): + debug = str_to_bool(os.getenv("DEBUG", "True")) + debug_level = os.getenv("DEBUG_LEVEL", "info").lower() + + output = str(message) + if log_type == 0: + pass + elif log_type == 1 and (debug and debug_level == "info"): + output = f"[INFO]: {output}" + elif log_type == 2: + output = f"[ERROR]: {output}" + elif log_type == 3 and (debug and debug_level == "debug"): + output = f"[DEBUG]: {output}" + else: + output = None + + if output is not None: + print(output) + file = open(logfile, "a", encoding="utf-8") + file.write(output + "\n") + +# Reimplementation of distutils.util.strtobool due to it being deprecated +# Source: https://github.com/PostHog/posthog/blob/01e184c29d2c10c43166f1d40a334abbc3f99d8a/posthog/utils.py#L668 +def str_to_bool(value: any) -> bool: + if not value: + return False + return str(value).lower() in ("y", "yes", "t", "true", "on", "1") + +# Get mapped value +def search_mapping(dictionary: dict, key_value: str): + if key_value in dictionary.keys(): + return dictionary[key_value] + elif key_value.lower() in dictionary.keys(): + return dictionary[key_value.lower()] + elif key_value in dictionary.values(): + return list(dictionary.keys())[list(dictionary.values()).index(key_value)] + elif key_value.lower() in dictionary.values(): + return list(dictionary.keys())[list(dictionary.values()).index(key_value.lower())] + else: + return None + + +def check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping): + skip_reason = None + + if library_type.lower() in blacklist_library_type: + skip_reason = "is blacklist_library_type" + + if library_title.lower() in [x.lower() for x in blacklist_library]: + skip_reason = "is blacklist_library" + + library_other = None + if library_mapping: + library_other = search_mapping(library_mapping, library_title) + if library_other: + if library_other.lower() in [x.lower() for x in blacklist_library]: + skip_reason = "is blacklist_library" + + if len(whitelist_library_type) > 0: + if library_type.lower() not in whitelist_library_type: + skip_reason = "is not whitelist_library_type" + + # if whitelist is not empty and library is not in whitelist + if len(whitelist_library) > 0: + if library_title.lower() not in [x.lower() for x in whitelist_library]: + skip_reason = "is not whitelist_library" + + if library_other: + if library_other.lower() not in [x.lower() for x in whitelist_library]: + skip_reason = "is not whitelist_library" + + return skip_reason + + +def generate_library_guids_dict(user_list: dict): + show_output_dict = {} + episode_output_dict = {} + movies_output_dict = {} + + try: + show_output_keys = user_list.keys() + show_output_keys = ([ dict(x) for x in list(show_output_keys) ]) + for show_key in show_output_keys: + for provider_key, provider_value in show_key.items(): + # Skip title + if provider_key.lower() == "title": + continue + if provider_key.lower() not in show_output_dict: + show_output_dict[provider_key.lower()] = [] + if provider_key.lower() == "locations": + for show_location in provider_value: + show_output_dict[provider_key.lower()].append(show_location) + else: + show_output_dict[provider_key.lower()].append(provider_value.lower()) + except: + pass + + try: + for show in user_list: + for season in user_list[show]: + for episode in user_list[show][season]: + for episode_key, episode_value in episode.items(): + if episode_key.lower() not in episode_output_dict: + episode_output_dict[episode_key.lower()] = [] + if episode_key == "locations": + for episode_location in episode_value: + episode_output_dict[episode_key.lower()].append(episode_location) + else: + episode_output_dict[episode_key.lower()].append(episode_value.lower()) + except: + pass + + try: + for movie in user_list: + for movie_key, movie_value in movie.items(): + if movie_key.lower() not in movies_output_dict: + movies_output_dict[movie_key.lower()] = [] + if movie_key == "locations": + for movie_location in movie_value: + movies_output_dict[movie_key.lower()].append(movie_location) + else: + movies_output_dict[movie_key.lower()].append(movie_value.lower()) + except: + pass + + return show_output_dict, episode_output_dict, movies_output_dict + +def combine_watched_dicts(dicts: list): + combined_dict = {} + for dict in dicts: + for key, value in dict.items(): + if key not in combined_dict: + combined_dict[key] = {} + for subkey, subvalue in value.items(): + combined_dict[key][subkey] = subvalue + + return combined_dict + +def future_thread_executor(args: list, workers: int = -1): + futures_list = [] + results = [] + + if workers == -1: + workers = min(32, os.cpu_count()*1.25) + + with ThreadPoolExecutor(max_workers=workers) as executor: + for arg in args: + # * arg unpacks the list into actual arguments + futures_list.append(executor.submit(*arg)) + + for future in futures_list: + try: + result = future.result() + results.append(result) + except Exception as e: + raise Exception(e) + + return results diff --git a/src/jellyfin.py b/src/jellyfin.py index 8534ed8..38757cc 100644 --- a/src/jellyfin.py +++ b/src/jellyfin.py @@ -1,327 +1,393 @@ -import requests -from src.functions import logger, search_mapping, str_to_bool, check_skip_logic, generate_library_guids_dict, future_thread_executor - -class Jellyfin(): - def __init__(self, baseurl, token): - self.baseurl = baseurl - self.token = token - self.session = requests.Session() - - if not self.baseurl: - raise Exception("Jellyfin baseurl not set") - - if not self.token: - raise Exception("Jellyfin token not set") - - self.users = self.get_users() - - - def query(self, query, query_type): - try: - response = None - - headers = { - "Accept": "application/json", - "X-Emby-Token": self.token - } - if query_type == "get": - response = self.session.get(self.baseurl + query, headers=headers) - - elif query_type == "post": - authorization = ( - 'MediaBrowser , ' - 'Client="other", ' - 'Device="script", ' - 'DeviceId="script", ' - 'Version="0.0.0"' - ) - headers["X-Emby-Authorization"] = authorization - response = self.session.post(self.baseurl + query, headers=headers) - - return response.json() - - except Exception as e: - logger(f"Jellyfin: Query failed {e}", 2) - raise Exception(e) - - def get_users(self): - try: - users = {} - - query = "/Users" - response = self.query(query, "get") - - # If reponse is not empty - if response: - for user in response: - users[user["Name"]] = user["Id"] - - return users - except Exception as e: - logger(f"Jellyfin: Get users failed {e}", 2) - raise Exception(e) - - def get_user_watched(self, user_name, user_id, library_type, library_id, library_title): - try: - user_name = user_name.lower() - user_watched = {} - user_watched[user_name] = {} - - logger(f"Jellyfin: Generating watched for {user_name} in library {library_title}", 0) - # Movies - if library_type == "Movie": - user_watched[user_name][library_title] = [] - watched = self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=true&ParentId={library_id}&Filters=IsPlayed&Fields=ItemCounts,ProviderIds,MediaSources", "get") - for movie in watched["Items"]: - if movie["UserData"]["Played"] == True: - movie_guids = {} - movie_guids["title"] = movie["Name"] - if movie["ProviderIds"]: - # Lowercase movie["ProviderIds"] keys - movie_guids = {k.lower(): v for k, v in movie["ProviderIds"].items()} - if movie["MediaSources"]: - movie_guids["locations"] = tuple([x["Path"].split("/")[-1] for x in movie["MediaSources"]]) - user_watched[user_name][library_title].append(movie_guids) - - # TV Shows - if library_type == "Episode": - user_watched[user_name][library_title] = {} - watched = self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=true&ParentId={library_id}&Fields=ItemCounts,ProviderIds,Path", "get") - watched_shows = [x for x in watched["Items"] if x["Type"] == "Series"] - - for show in watched_shows: - show_guids = {k.lower(): v for k, v in show["ProviderIds"].items()} - show_guids["title"] = show["Name"] - show_guids["locations"] = tuple([show["Path"].split("/")[-1]]) - show_guids = frozenset(show_guids.items()) - seasons = self.query(f"/Shows/{show['Id']}/Seasons?userId={user_id}&Fields=ItemCounts,ProviderIds", "get") - if len(seasons["Items"]) > 0: - for season in seasons["Items"]: - episodes = self.query(f"/Shows/{show['Id']}/Episodes?seasonId={season['Id']}&userId={user_id}&Fields=ItemCounts,ProviderIds,MediaSources", "get") - if len(episodes["Items"]) > 0: - for episode in episodes["Items"]: - if episode["UserData"]["Played"] == True: - if episode["ProviderIds"] or episode["MediaSources"]: - if show_guids not in user_watched[user_name][library_title]: - user_watched[user_name][library_title][show_guids] = {} - if season["Name"] not in user_watched[user_name][library_title][show_guids]: - user_watched[user_name][library_title][show_guids][season["Name"]] = [] - - # Lowercase episode["ProviderIds"] keys - episode_guids = {} - if episode["ProviderIds"]: - episode_guids = {k.lower(): v for k, v in episode["ProviderIds"].items()} - if episode["MediaSources"]: - episode_guids["locations"] = tuple([x["Path"].split("/")[-1] for x in episode["MediaSources"]]) - user_watched[user_name][library_title][show_guids][season["Name"]].append(episode_guids) - - return user_watched - except Exception as e: - logger(f"Jellyfin: Failed to get watched for {user_name} in library {library_title}, Error: {e}", 2) - raise Exception(e) - - - def get_watched(self, users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping=None): - try: - users_watched = {} - args = [] - - for user_name, user_id in users.items(): - # Get all libraries - user_name = user_name.lower() - - libraries = self.query(f"/Users/{user_id}/Views", "get")["Items"] - - for library in libraries: - library_title = library["Name"] - library_id = library["Id"] - watched = self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=true&ParentId={library_id}&Filters=IsPlayed&limit=1", "get") - - if len(watched["Items"]) == 0: - logger(f"Jellyfin: No watched items found in library {library_title}", 1) - continue - else: - library_type = watched["Items"][0]["Type"] - - skip_reason = check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) - - if skip_reason: - logger(f"Jellyfin: Skipping library {library_title} {skip_reason}", 1) - continue - - args.append([self.get_user_watched, user_name, user_id, library_type, library_id, library_title]) - - for user_watched in future_thread_executor(args): - for user, user_watched_temp in user_watched.items(): - if user not in users_watched: - users_watched[user] = {} - users_watched[user].update(user_watched_temp) - - return users_watched - except Exception as e: - logger(f"Jellyfin: Failed to get watched, Error: {e}", 2) - raise Exception(e) - - def update_user_watched(self, user_name, user_id, library, library_id, videos, dryrun): - try: - logger(f"Jellyfin: Updating watched for {user_name} in library {library}", 1) - videos_shows_ids, videos_episodes_ids, videos_movies_ids = generate_library_guids_dict(videos) - - logger(f"Jellyfin: mark list\nShows: {videos_shows_ids}\nEpisodes: {videos_episodes_ids}\nMovies: {videos_movies_ids}", 1) - - if videos_movies_ids: - jellyfin_search = self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=false&ParentId={library_id}&isPlayed=false&Fields=ItemCounts,ProviderIds,MediaSources", "get") - for jellyfin_video in jellyfin_search["Items"]: - movie_found = False - - if "MediaSources" in jellyfin_video: - for movie_location in jellyfin_video["MediaSources"]: - if movie_location["Path"].split("/")[-1] in videos_movies_ids["locations"]: - movie_found = True - break - - if not movie_found: - for movie_provider_source, movie_provider_id in jellyfin_video["ProviderIds"].items(): - if movie_provider_source.lower() in videos_movies_ids: - if movie_provider_id.lower() in videos_movies_ids[movie_provider_source.lower()]: - movie_found = True - break - - if movie_found: - jellyfin_video_id = jellyfin_video["Id"] - msg = f"{jellyfin_video['Name']} as watched for {user_name} in {library} for Jellyfin" - if not dryrun: - logger(f"Marking {msg}", 0) - self.query(f"/Users/{user_id}/PlayedItems/{jellyfin_video_id}", "post") - else: - logger(f"Dryrun {msg}", 0) - else: - logger(f"Jellyfin: Skipping movie {jellyfin_video['Name']} as it is not in mark list for {user_name}", 1) - - - - # TV Shows - if videos_shows_ids and videos_episodes_ids: - jellyfin_search = self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=false&ParentId={library_id}&isPlayed=false&Fields=ItemCounts,ProviderIds,Path", "get") - jellyfin_shows = [x for x in jellyfin_search["Items"]] - - for jellyfin_show in jellyfin_shows: - show_found = False - - if "Path" in jellyfin_show: - if jellyfin_show["Path"].split("/")[-1] in videos_shows_ids["locations"]: - show_found = True - - if not show_found: - for show_provider_source, show_provider_id in jellyfin_show["ProviderIds"].items(): - if show_provider_source.lower() in videos_shows_ids: - if show_provider_id.lower() in videos_shows_ids[show_provider_source.lower()]: - show_found = True - break - - if show_found: - logger(f"Jellyfin: Updating watched for {user_name} in library {library} for show {jellyfin_show['Name']}", 1) - jellyfin_show_id = jellyfin_show["Id"] - jellyfin_episodes = self.query(f"/Shows/{jellyfin_show_id}/Episodes?userId={user_id}&Fields=ItemCounts,ProviderIds,MediaSources", "get") - - for jellyfin_episode in jellyfin_episodes["Items"]: - episode_found = False - - if "MediaSources" in jellyfin_episode: - for episode_location in jellyfin_episode["MediaSources"]: - if episode_location["Path"].split("/")[-1] in videos_episodes_ids["locations"]: - episode_found = True - break - - if not episode_found: - for episode_provider_source, episode_provider_id in jellyfin_episode["ProviderIds"].items(): - if episode_provider_source.lower() in videos_episodes_ids: - if episode_provider_id.lower() in videos_episodes_ids[episode_provider_source.lower()]: - episode_found = True - break - - if episode_found: - jellyfin_episode_id = jellyfin_episode["Id"] - msg = f"{jellyfin_episode['SeriesName']} {jellyfin_episode['SeasonName']} Episode {jellyfin_episode['Name']} as watched for {user_name} in {library} for Jellyfin" - if not dryrun: - logger(f"Marked {msg}", 0) - self.query(f"/Users/{user_id}/PlayedItems/{jellyfin_episode_id}", "post") - else: - logger(f"Dryrun {msg}", 0) - else: - logger(f"Jellyfin: Skipping episode {jellyfin_episode['Name']} as it is not in mark list for {user_name}", 1) - else: - logger(f"Jellyfin: Skipping show {jellyfin_show['Name']} as it is not in mark list for {user_name}", 1) - - if not videos_movies_ids and not videos_shows_ids and not videos_episodes_ids: - logger(f"Jellyfin: No videos to mark as watched for {user_name} in library {library}", 1) - - except Exception as e: - logger(f"Jellyfin: Error updating watched for {user_name} in library {library}", 2) - raise Exception(e) - - - def update_watched(self, watched_list, user_mapping=None, library_mapping=None, dryrun=False): - try: - args = [] - for user, libraries in watched_list.items(): - logger(f"Jellyfin: Updating for entry {user}, {libraries}", 1) - user_other = None - user_name = None - if user_mapping: - if user in user_mapping.keys(): - user_other = user_mapping[user] - elif user in user_mapping.values(): - user_other = search_mapping(user_mapping, user) - - user_id = None - for key in self.users.keys(): - if user.lower() == key.lower(): - user_id = self.users[key] - user_name = key - break - elif user_other and user_other.lower() == key.lower(): - user_id = self.users[key] - user_name = key - break - - if not user_id: - logger(f"{user} {user_other} not found in Jellyfin", 2) - continue - - jellyfin_libraries = self.query(f"/Users/{user_id}/Views", "get")["Items"] - - for library, videos in libraries.items(): - library_other = None - if library_mapping: - if library in library_mapping.keys(): - library_other = library_mapping[library] - elif library in library_mapping.values(): - library_other = search_mapping(library_mapping, library) - - - if library.lower() not in [x["Name"].lower() for x in jellyfin_libraries]: - if library_other: - if library_other.lower() in [x["Name"].lower() for x in jellyfin_libraries]: - logger(f"Jellyfin: Library {library} not found, but {library_other} found, using {library_other}", 1) - library = library_other - else: - logger(f"Jellyfin: Library {library} or {library_other} not found in library list", 2) - continue - else: - logger(f"Jellyfin: Library {library} not found in library list", 2) - continue - - library_id = None - for jellyfin_library in jellyfin_libraries: - if jellyfin_library["Name"] == library: - library_id = jellyfin_library["Id"] - continue - - if library_id: - args.append([self.update_user_watched, user_name, user_id, library, library_id, videos, dryrun]) - - future_thread_executor(args) - except Exception as e: - logger(f"Jellyfin: Error updating watched", 2) - raise Exception(e) +import asyncio, aiohttp +from src.functions import logger, search_mapping, str_to_bool, check_skip_logic, generate_library_guids_dict, future_thread_executor, combine_watched_dicts + +class Jellyfin(): + def __init__(self, baseurl, token): + self.baseurl = baseurl + self.token = token + + if not self.baseurl: + raise Exception("Jellyfin baseurl not set") + + if not self.token: + raise Exception("Jellyfin token not set") + + self.users = asyncio.run(self.get_users()) + + + async def query(self, query, query_type, session, identifiers=None): + try: + results = None + headers = { + "Accept": "application/json", + "X-Emby-Token": self.token + } + authorization = ( + 'MediaBrowser , ' + 'Client="other", ' + 'Device="script", ' + 'DeviceId="script", ' + 'Version="0.0.0"' + ) + headers["X-Emby-Authorization"] = authorization + + if query_type == "get": + async with session.get(self.baseurl + query, headers=headers) as response: + results = await response.json() + + elif query_type == "post": + async with session.post(self.baseurl + query, headers=headers) as response: + results = await response.json() + + # append identifiers to results + if identifiers: + results["Identifiers"] = identifiers + return results + + except Exception as e: + logger(f"Jellyfin: Query failed {e}", 2) + raise Exception(e) + + + async def get_users(self): + try: + users = {} + + query_string = "/Users" + async with aiohttp.ClientSession() as session: + response = await self.query(query_string, "get", session) + + # If reponse is not empty + if response: + for user in response: + users[user["Name"]] = user["Id"] + + return users + except Exception as e: + logger(f"Jellyfin: Get users failed {e}", 2) + raise Exception(e) + + + async def get_user_watched(self, user_name, user_id, library_type, library_id, library_title): + try: + user_name = user_name.lower() + user_watched = {} + user_watched[user_name] = {} + + logger(f"Jellyfin: Generating watched for {user_name} in library {library_title}", 0) + # Movies + async with aiohttp.ClientSession() as session: + if library_type == "Movie": + user_watched[user_name][library_title] = [] + watched = await self.query(f"/Users/{user_id}/Items?ParentId={library_id}&Filters=IsPlayed&Fields=ItemCounts,ProviderIds,MediaSources", "get", session) + for movie in watched["Items"]: + if movie["UserData"]["Played"] == True: + movie_guids = {} + movie_guids["title"] = movie["Name"] + if "ProviderIds" in movie: + # Lowercase movie["ProviderIds"] keys + movie_guids = {k.lower(): v for k, v in movie["ProviderIds"].items()} + if "MediaSources" in movie: + movie_guids["locations"] = tuple([x["Path"].split("/")[-1] for x in movie["MediaSources"]]) + user_watched[user_name][library_title].append(movie_guids) + + # TV Shows + if library_type == "Series": + user_watched[user_name][library_title] = {} + watched_shows = await self.query(f"/Users/{user_id}/Items?ParentId={library_id}&isPlaceHolder=false&Fields=ProviderIds,Path,RecursiveItemCount", "get", session) + watched_shows_filtered = [] + for show in watched_shows["Items"]: + if "PlayedPercentage" in show["UserData"]: + if show["UserData"]["PlayedPercentage"] > 0: + watched_shows_filtered.append(show) + seasons_tasks = [] + for show in watched_shows_filtered: + show_guids = {k.lower(): v for k, v in show["ProviderIds"].items()} + show_guids["title"] = show["Name"] + show_guids["locations"] = tuple([show["Path"].split("/")[-1]]) + show_guids = frozenset(show_guids.items()) + identifiers = {"show_guids": show_guids, "show_id": show["Id"]} + task = asyncio.ensure_future(self.query(f"/Shows/{show['Id']}/Seasons?userId={user_id}&isPlaceHolder=false&Fields=ProviderIds,RecursiveItemCount", "get", session, frozenset(identifiers.items()))) + seasons_tasks.append(task) + + seasons_watched = await asyncio.gather(*seasons_tasks) + seasons_watched_filtered = [] + + for seasons in seasons_watched: + seasons_watched_filtered_dict = {} + seasons_watched_filtered_dict["Identifiers"] = seasons["Identifiers"] + seasons_watched_filtered_dict["Items"] = [] + for season in seasons["Items"]: + if "PlayedPercentage" in season["UserData"]: + if season["UserData"]["PlayedPercentage"] > 0: + seasons_watched_filtered_dict["Items"].append(season) + + if seasons_watched_filtered_dict["Items"]: + seasons_watched_filtered.append(seasons_watched_filtered_dict) + + episodes_tasks = [] + for seasons in seasons_watched_filtered: + if len(seasons["Items"]) > 0: + for season in seasons["Items"]: + season_identifiers = dict(seasons["Identifiers"]) + season_identifiers["season_id"] = season["Id"] + season_identifiers["season_name"] = season["Name"] + task = asyncio.ensure_future(self.query(f"/Shows/{season_identifiers['show_id']}/Episodes?seasonId={season['Id']}&userId={user_id}&isPlaceHolder=false&isPlayed=true&Fields=ProviderIds,MediaSources", "get", session, frozenset(season_identifiers.items()))) + episodes_tasks.append(task) + + watched_episodes = await asyncio.gather(*episodes_tasks) + for episodes in watched_episodes: + if len(episodes["Items"]) > 0: + for episode in episodes["Items"]: + if episode["UserData"]["Played"] == True: + if "ProviderIds" in episode or "MediaSources" in episode: + episode_identifiers = dict(episodes["Identifiers"]) + show_guids = episode_identifiers["show_guids"] + if show_guids not in user_watched[user_name][library_title]: + user_watched[user_name][library_title][show_guids] = {} + if episode_identifiers["season_name"] not in user_watched[user_name][library_title][show_guids]: + user_watched[user_name][library_title][show_guids][episode_identifiers["season_name"]] = [] + + episode_guids = {} + if "ProviderIds" in episode: + episode_guids = {k.lower(): v for k, v in episode["ProviderIds"].items()} + if "MediaSources" in episode: + episode_guids["locations"] = tuple([x["Path"].split("/")[-1] for x in episode["MediaSources"]]) + user_watched[user_name][library_title][show_guids][episode_identifiers["season_name"]].append(episode_guids) + + return user_watched + except Exception as e: + logger(f"Jellyfin: Failed to get watched for {user_name} in library {library_title}, Error: {e}", 2) + raise Exception(e) + + + async def get_users_watched(self, user_name, user_id, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping): + try: + # Get all libraries + user_name = user_name.lower() + tasks_watched = [] + + tasks_libraries = [] + async with aiohttp.ClientSession() as session: + libraries = await self.query(f"/Users/{user_id}/Views", "get", session) + for library in libraries["Items"]: + library_id = library["Id"] + library_title = library["Name"] + identifiers = {"library_id": library_id, "library_title": library_title} + task = asyncio.ensure_future(self.query(f"/Users/{user_id}/Items?ParentId={library_id}&Filters=IsPlayed&limit=1", "get", session, identifiers=identifiers)) + tasks_libraries.append(task) + + libraries = await asyncio.gather(*tasks_libraries, return_exceptions=True) + + for watched in libraries: + if len(watched["Items"]) == 0: + continue + + library_id = watched["Identifiers"]["library_id"] + library_title = watched["Identifiers"]["library_title"] + library_type = watched["Items"][0]["Type"] + + skip_reason = check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) + + if skip_reason: + logger(f"Jellyfin: Skipping library {library_title} {skip_reason}", 1) + continue + + # Get watched for user + task = asyncio.ensure_future(self.get_user_watched(user_name, user_id, library_type, library_id, library_title)) + tasks_watched.append(task) + + watched = await asyncio.gather(*tasks_watched, return_exceptions=True) + return watched + except Exception as e: + logger(f"Jellyfin: Failed to get users watched, Error: {e}", 2) + raise Exception(e) + + + async def get_watched(self, users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping=None): + try: + users_watched = {} + watched = [] + + for user_name, user_id in users.items(): + watched.append(await self.get_users_watched(user_name, user_id, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping)) + + for user_watched in watched: + user_watched_temp = combine_watched_dicts(user_watched) + for user, user_watched_temp in user_watched_temp.items(): + if user not in users_watched: + users_watched[user] = {} + users_watched[user].update(user_watched_temp) + + return users_watched + except Exception as e: + logger(f"Jellyfin: Failed to get watched, Error: {e}", 2) + raise Exception(e) + + + async def update_user_watched(self, user_name, user_id, library, library_id, videos, dryrun): + try: + logger(f"Jellyfin: Updating watched for {user_name} in library {library}", 1) + videos_shows_ids, videos_episodes_ids, videos_movies_ids = generate_library_guids_dict(videos) + + logger(f"Jellyfin: mark list\nShows: {videos_shows_ids}\nEpisodes: {videos_episodes_ids}\nMovies: {videos_movies_ids}", 1) + async with aiohttp.ClientSession() as session: + if videos_movies_ids: + jellyfin_search = await self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=false&ParentId={library_id}&isPlayed=false&Fields=ItemCounts,ProviderIds,MediaSources", "get", session) + for jellyfin_video in jellyfin_search["Items"]: + movie_found = False + + if "MediaSources" in jellyfin_video: + for movie_location in jellyfin_video["MediaSources"]: + if movie_location["Path"].split("/")[-1] in videos_movies_ids["locations"]: + movie_found = True + break + + if not movie_found: + for movie_provider_source, movie_provider_id in jellyfin_video["ProviderIds"].items(): + if movie_provider_source.lower() in videos_movies_ids: + if movie_provider_id.lower() in videos_movies_ids[movie_provider_source.lower()]: + movie_found = True + break + + if movie_found: + jellyfin_video_id = jellyfin_video["Id"] + msg = f"{jellyfin_video['Name']} as watched for {user_name} in {library} for Jellyfin" + if not dryrun: + logger(f"Marking {msg}", 0) + await self.query(f"/Users/{user_id}/PlayedItems/{jellyfin_video_id}", "post", session) + else: + logger(f"Dryrun {msg}", 0) + else: + logger(f"Jellyfin: Skipping movie {jellyfin_video['Name']} as it is not in mark list for {user_name}", 1) + + + + # TV Shows + if videos_shows_ids and videos_episodes_ids: + jellyfin_search = await self.query(f"/Users/{user_id}/Items?SortBy=SortName&SortOrder=Ascending&Recursive=false&ParentId={library_id}&isPlayed=false&Fields=ItemCounts,ProviderIds,Path", "get", session) + jellyfin_shows = [x for x in jellyfin_search["Items"]] + + for jellyfin_show in jellyfin_shows: + show_found = False + + if "Path" in jellyfin_show: + if jellyfin_show["Path"].split("/")[-1] in videos_shows_ids["locations"]: + show_found = True + + if not show_found: + for show_provider_source, show_provider_id in jellyfin_show["ProviderIds"].items(): + if show_provider_source.lower() in videos_shows_ids: + if show_provider_id.lower() in videos_shows_ids[show_provider_source.lower()]: + show_found = True + break + + if show_found: + logger(f"Jellyfin: Updating watched for {user_name} in library {library} for show {jellyfin_show['Name']}", 1) + jellyfin_show_id = jellyfin_show["Id"] + jellyfin_episodes = await self.query(f"/Shows/{jellyfin_show_id}/Episodes?userId={user_id}&Fields=ItemCounts,ProviderIds,MediaSources", "get", session) + + for jellyfin_episode in jellyfin_episodes["Items"]: + episode_found = False + + if "MediaSources" in jellyfin_episode: + for episode_location in jellyfin_episode["MediaSources"]: + if episode_location["Path"].split("/")[-1] in videos_episodes_ids["locations"]: + episode_found = True + break + + if not episode_found: + for episode_provider_source, episode_provider_id in jellyfin_episode["ProviderIds"].items(): + if episode_provider_source.lower() in videos_episodes_ids: + if episode_provider_id.lower() in videos_episodes_ids[episode_provider_source.lower()]: + episode_found = True + break + + if episode_found: + jellyfin_episode_id = jellyfin_episode["Id"] + msg = f"{jellyfin_episode['SeriesName']} {jellyfin_episode['SeasonName']} Episode {jellyfin_episode['Name']} as watched for {user_name} in {library} for Jellyfin" + if not dryrun: + logger(f"Marked {msg}", 0) + await self.query(f"/Users/{user_id}/PlayedItems/{jellyfin_episode_id}", "post", session) + else: + logger(f"Dryrun {msg}", 0) + else: + logger(f"Jellyfin: Skipping episode {jellyfin_episode['Name']} as it is not in mark list for {user_name}", 1) + else: + logger(f"Jellyfin: Skipping show {jellyfin_show['Name']} as it is not in mark list for {user_name}", 1) + + if not videos_movies_ids and not videos_shows_ids and not videos_episodes_ids: + logger(f"Jellyfin: No videos to mark as watched for {user_name} in library {library}", 1) + + except Exception as e: + logger(f"Jellyfin: Error updating watched for {user_name} in library {library}", 2) + raise Exception(e) + + + async def update_watched(self, watched_list, user_mapping=None, library_mapping=None, dryrun=False): + try: + tasks = [] + async with aiohttp.ClientSession() as session: + for user, libraries in watched_list.items(): + logger(f"Jellyfin: Updating for entry {user}, {libraries}", 1) + user_other = None + user_name = None + if user_mapping: + if user in user_mapping.keys(): + user_other = user_mapping[user] + elif user in user_mapping.values(): + user_other = search_mapping(user_mapping, user) + + user_id = None + for key in self.users.keys(): + if user.lower() == key.lower(): + user_id = self.users[key] + user_name = key + break + elif user_other and user_other.lower() == key.lower(): + user_id = self.users[key] + user_name = key + break + + if not user_id: + logger(f"{user} {user_other} not found in Jellyfin", 2) + continue + + jellyfin_libraries = await self.query(f"/Users/{user_id}/Views", "get", session) + jellyfin_libraries = [x for x in jellyfin_libraries["Items"]] + + for library, videos in libraries.items(): + library_other = None + if library_mapping: + if library in library_mapping.keys(): + library_other = library_mapping[library] + elif library in library_mapping.values(): + library_other = search_mapping(library_mapping, library) + + + if library.lower() not in [x["Name"].lower() for x in jellyfin_libraries]: + if library_other: + if library_other.lower() in [x["Name"].lower() for x in jellyfin_libraries]: + logger(f"Jellyfin: Library {library} not found, but {library_other} found, using {library_other}", 1) + library = library_other + else: + logger(f"Jellyfin: Library {library} or {library_other} not found in library list", 2) + continue + else: + logger(f"Jellyfin: Library {library} not found in library list", 2) + continue + + library_id = None + for jellyfin_library in jellyfin_libraries: + if jellyfin_library["Name"] == library: + library_id = jellyfin_library["Id"] + continue + + if library_id: + task = self.update_user_watched(user_name, user_id, library, library_id, videos, dryrun) + tasks.append(task) + + await asyncio.gather(*tasks, return_exceptions=True) + except Exception as e: + logger(f"Jellyfin: Error updating watched", 2) + raise Exception(e) diff --git a/src/main.py b/src/main.py index d674eea..fbbf6e4 100644 --- a/src/main.py +++ b/src/main.py @@ -1,441 +1,450 @@ -import copy, os, traceback, json -from dotenv import load_dotenv -from time import sleep - -from src.functions import logger, str_to_bool, search_mapping, generate_library_guids_dict, future_thread_executor -from src.plex import Plex -from src.jellyfin import Jellyfin - -load_dotenv(override=True) - -def cleanup_watched(watched_list_1, watched_list_2, user_mapping=None, library_mapping=None): - modified_watched_list_1 = copy.deepcopy(watched_list_1) - - # remove entries from plex_watched that are in jellyfin_watched - for user_1 in watched_list_1: - user_other = None - if user_mapping: - user_other = search_mapping(user_mapping, user_1) - if user_1 in modified_watched_list_1: - if user_1 in watched_list_2: - user_2 = user_1 - elif user_other in watched_list_2: - user_2 = user_other - else: - logger(f"User {user_1} and {user_other} not found in watched list 2", 1) - continue - - for library_1 in watched_list_1[user_1]: - library_other = None - if library_mapping: - library_other = search_mapping(library_mapping, library_1) - if library_1 in modified_watched_list_1[user_1]: - if library_1 in watched_list_2[user_2]: - library_2 = library_1 - elif library_other in watched_list_2[user_2]: - library_2 = library_other - else: - logger(f"library {library_1} and {library_other} not found in watched list 2", 1) - continue - - # Movies - if isinstance(watched_list_1[user_1][library_1], list): - _, _, movies_watched_list_2_keys_dict = generate_library_guids_dict(watched_list_2[user_2][library_2]) - for movie in watched_list_1[user_1][library_1]: - movie_found = False - for movie_key, movie_value in movie.items(): - if movie_key == "locations": - for location in movie_value: - if location in movies_watched_list_2_keys_dict["locations"]: - movie_found = True - break - else: - if movie_key in movies_watched_list_2_keys_dict.keys(): - if movie_value in movies_watched_list_2_keys_dict[movie_key]: - movie_found = True - - if movie_found: - logger(f"Removing {movie} from {library_1}", 3) - modified_watched_list_1[user_1][library_1].remove(movie) - break - - - # TV Shows - elif isinstance(watched_list_1[user_1][library_1], dict): - # Generate full list of provider ids for episodes in watch_list_2 to easily compare if they exist in watch_list_1 - _, episode_watched_list_2_keys_dict, _ = generate_library_guids_dict(watched_list_2[user_2][library_2]) - - for show_key_1 in watched_list_1[user_1][library_1].keys(): - show_key_dict = dict(show_key_1) - for season in watched_list_1[user_1][library_1][show_key_1]: - for episode in watched_list_1[user_1][library_1][show_key_1][season]: - episode_found = False - for episode_key, episode_value in episode.items(): - # If episode_key and episode_value are in episode_watched_list_2_keys_dict exactly, then remove from watch_list_1 - if episode_key == "locations": - for location in episode_value: - if location in episode_watched_list_2_keys_dict["locations"]: - episode_found = True - break - - else: - if episode_key in episode_watched_list_2_keys_dict.keys(): - if episode_value in episode_watched_list_2_keys_dict[episode_key]: - episode_found = True - - if episode_found: - if episode in modified_watched_list_1[user_1][library_1][show_key_1][season]: - logger(f"Removing {episode} from {show_key_dict['title']}", 3) - modified_watched_list_1[user_1][library_1][show_key_1][season].remove(episode) - break - - # Remove empty seasons - if len(modified_watched_list_1[user_1][library_1][show_key_1][season]) == 0: - if season in modified_watched_list_1[user_1][library_1][show_key_1]: - logger(f"Removing {season} from {show_key_dict['title']} because it is empty", 3) - del modified_watched_list_1[user_1][library_1][show_key_1][season] - - # If the show is empty, remove the show - if len(modified_watched_list_1[user_1][library_1][show_key_1]) == 0: - if show_key_1 in modified_watched_list_1[user_1][library_1]: - logger(f"Removing {show_key_dict['title']} from {library_1} because it is empty", 1) - del modified_watched_list_1[user_1][library_1][show_key_1] - - for user_1 in watched_list_1: - for library_1 in watched_list_1[user_1]: - if library_1 in modified_watched_list_1[user_1]: - # If library is empty then remove it - if len(modified_watched_list_1[user_1][library_1]) == 0: - logger(f"Removing {library_1} from {user_1} because it is empty", 1) - del modified_watched_list_1[user_1][library_1] - - if user_1 in modified_watched_list_1: - # If user is empty delete user - if len(modified_watched_list_1[user_1]) == 0: - logger(f"Removing {user_1} from watched list 1 because it is empty", 1) - del modified_watched_list_1[user_1] - - return modified_watched_list_1 - -def setup_black_white_lists(blacklist_library: str, whitelist_library: str, blacklist_library_type: str, whitelist_library_type: str, blacklist_users: str, whitelist_users: str, library_mapping=None, user_mapping=None): - if blacklist_library: - if len(blacklist_library) > 0: - blacklist_library = blacklist_library.split(",") - blacklist_library = [x.strip() for x in blacklist_library] - if library_mapping: - temp_library = [] - for library in blacklist_library: - library_other = search_mapping(library_mapping, library) - if library_other: - temp_library.append(library_other) - - blacklist_library = blacklist_library + temp_library - else: - blacklist_library = [] - logger(f"Blacklist Library: {blacklist_library}", 1) - - if whitelist_library: - if len(whitelist_library) > 0: - whitelist_library = whitelist_library.split(",") - whitelist_library = [x.strip() for x in whitelist_library] - if library_mapping: - temp_library = [] - for library in whitelist_library: - library_other = search_mapping(library_mapping, library) - if library_other: - temp_library.append(library_other) - - whitelist_library = whitelist_library + temp_library - else: - whitelist_library = [] - logger(f"Whitelist Library: {whitelist_library}", 1) - - if blacklist_library_type: - if len(blacklist_library_type) > 0: - blacklist_library_type = blacklist_library_type.split(",") - blacklist_library_type = [x.lower().strip() for x in blacklist_library_type] - else: - blacklist_library_type = [] - logger(f"Blacklist Library Type: {blacklist_library_type}", 1) - - if whitelist_library_type: - if len(whitelist_library_type) > 0: - whitelist_library_type = whitelist_library_type.split(",") - whitelist_library_type = [x.lower().strip() for x in whitelist_library_type] - else: - whitelist_library_type = [] - logger(f"Whitelist Library Type: {whitelist_library_type}", 1) - - if blacklist_users: - if len(blacklist_users) > 0: - blacklist_users = blacklist_users.split(",") - blacklist_users = [x.lower().strip() for x in blacklist_users] - if user_mapping: - temp_users = [] - for user in blacklist_users: - user_other = search_mapping(user_mapping, user) - if user_other: - temp_users.append(user_other) - - blacklist_users = blacklist_users + temp_users - else: - blacklist_users = [] - logger(f"Blacklist Users: {blacklist_users}", 1) - - if whitelist_users: - if len(whitelist_users) > 0: - whitelist_users = whitelist_users.split(",") - whitelist_users = [x.lower().strip() for x in whitelist_users] - if user_mapping: - temp_users = [] - for user in whitelist_users: - user_other = search_mapping(user_mapping, user) - if user_other: - temp_users.append(user_other) - - whitelist_users = whitelist_users + temp_users - else: - whitelist_users = [] - else: - whitelist_users = [] - logger(f"Whitelist Users: {whitelist_users}", 1) - - return blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users - -def setup_users(server_1, server_2, blacklist_users, whitelist_users, user_mapping=None): - - # generate list of users from server 1 and server 2 - server_1_type = server_1[0] - server_1_connection = server_1[1] - server_2_type = server_2[0] - server_2_connection = server_2[1] - - server_1_users = [] - if server_1_type == "plex": - server_1_users = [ x.title.lower() for x in server_1_connection.users ] - elif server_1_type == "jellyfin": - server_1_users = [ key.lower() for key in server_1_connection.users.keys() ] - - server_2_users = [] - if server_2_type == "plex": - server_2_users = [ x.title.lower() for x in server_2_connection.users ] - elif server_2_type == "jellyfin": - server_2_users = [ key.lower() for key in server_2_connection.users.keys() ] - - - # combined list of overlapping users from plex and jellyfin - users = {} - - for server_1_user in server_1_users: - if user_mapping: - jellyfin_plex_mapped_user = search_mapping(user_mapping, server_1_user) - if jellyfin_plex_mapped_user: - users[server_1_user] = jellyfin_plex_mapped_user - continue - - if server_1_user in server_2_users: - users[server_1_user] = server_1_user - - for server_2_user in server_2_users: - if user_mapping: - plex_jellyfin_mapped_user = search_mapping(user_mapping, server_2_user) - if plex_jellyfin_mapped_user: - users[plex_jellyfin_mapped_user] = server_2_user - continue - - if server_2_user in server_1_users: - users[server_2_user] = server_2_user - - logger(f"User list that exist on both servers {users}", 1) - - users_filtered = {} - for user in users: - # whitelist_user is not empty and user lowercase is not in whitelist lowercase - if len(whitelist_users) > 0: - if user not in whitelist_users and users[user] not in whitelist_users: - logger(f"{user} or {users[user]} is not in whitelist", 1) - continue - - if user not in blacklist_users and users[user] not in blacklist_users: - users_filtered[user] = users[user] - - logger(f"Filtered user list {users_filtered}", 1) - - if server_1_type == "plex": - output_server_1_users = [] - for plex_user in server_1_connection.users: - if plex_user.title.lower() in users_filtered.keys() or plex_user.title.lower() in users_filtered.values(): - output_server_1_users.append(plex_user) - elif server_1_type == "jellyfin": - output_server_1_users = {} - for jellyfin_user, jellyfin_id in server_1_connection.users.items(): - if jellyfin_user.lower() in users_filtered.keys() or jellyfin_user.lower() in users_filtered.values(): - output_server_1_users[jellyfin_user] = jellyfin_id - - if server_2_type == "plex": - output_server_2_users = [] - for plex_user in server_2_connection.users: - if plex_user.title.lower() in users_filtered.keys() or plex_user.title.lower() in users_filtered.values(): - output_server_2_users.append(plex_user) - elif server_2_type == "jellyfin": - output_server_2_users = {} - for jellyfin_user, jellyfin_id in server_2_connection.users.items(): - if jellyfin_user.lower() in users_filtered.keys() or jellyfin_user.lower() in users_filtered.values(): - output_server_2_users[jellyfin_user] = jellyfin_id - - if len(output_server_1_users) == 0: - raise Exception(f"No users found for server 1, users found {users} filtered users {users_filtered}") - - if len(output_server_2_users) == 0: - raise Exception(f"No users found for server 2, users found {users} filtered users {users_filtered}") - - logger(f"Server 1 users: {output_server_1_users}", 1) - logger(f"Server 2 users: {output_server_2_users}", 1) - - return output_server_1_users, output_server_2_users - -def generate_server_connections(): - servers = [] - - plex_baseurl = os.getenv("PLEX_BASEURL", None) - plex_token = os.getenv("PLEX_TOKEN", None) - plex_username = os.getenv("PLEX_USERNAME", None) - plex_password = os.getenv("PLEX_PASSWORD", None) - plex_servername = os.getenv("PLEX_SERVERNAME", None) - - if plex_baseurl and plex_token: - plex_baseurl = plex_baseurl.split(",") - plex_token = plex_token.split(",") - - if len(plex_baseurl) != len(plex_token): - raise Exception("PLEX_BASEURL and PLEX_TOKEN must have the same number of entries") - - for i, url in enumerate(plex_baseurl): - servers.append(("plex", Plex(baseurl=url.strip(), token=plex_token[i].strip(), username=None, password=None, servername=None))) - - if plex_username and plex_password and plex_servername: - plex_username = plex_username.split(",") - plex_password = plex_password.split(",") - plex_servername = plex_servername.split(",") - - if len(plex_username) != len(plex_password) or len(plex_username) != len(plex_servername): - raise Exception("PLEX_USERNAME, PLEX_PASSWORD and PLEX_SERVERNAME must have the same number of entries") - - for i, username in enumerate(plex_username): - servers.append(("plex", Plex(baseurl=None, token=None, username=username.strip(), password=plex_password[i].strip(), servername=plex_servername[i].strip()))) - - jellyfin_baseurl = os.getenv("JELLYFIN_BASEURL", None) - jellyfin_token = os.getenv("JELLYFIN_TOKEN", None) - - if jellyfin_baseurl and jellyfin_token: - jellyfin_baseurl = jellyfin_baseurl.split(",") - jellyfin_token = jellyfin_token.split(",") - - if len(jellyfin_baseurl) != len(jellyfin_token): - raise Exception("JELLYFIN_BASEURL and JELLYFIN_TOKEN must have the same number of entries") - - for i, baseurl in enumerate(jellyfin_baseurl): - servers.append(("jellyfin", Jellyfin(baseurl=baseurl.strip(), token=jellyfin_token[i].strip()))) - - return servers - -def main_loop(): - logfile = os.getenv("LOGFILE","log.log") - # Delete logfile if it exists - if os.path.exists(logfile): - os.remove(logfile) - - dryrun = str_to_bool(os.getenv("DRYRUN", "False")) - logger(f"Dryrun: {dryrun}", 1) - - user_mapping = os.getenv("USER_MAPPING") - if user_mapping: - user_mapping = json.loads(user_mapping.lower()) - logger(f"User Mapping: {user_mapping}", 1) - - library_mapping = os.getenv("LIBRARY_MAPPING") - if library_mapping: - library_mapping = json.loads(library_mapping) - logger(f"Library Mapping: {library_mapping}", 1) - - # Create (black/white)lists - logger("Creating (black/white)lists", 1) - blacklist_library = os.getenv("BLACKLIST_LIBRARY", None) - whitelist_library = os.getenv("WHITELIST_LIBRARY", None) - blacklist_library_type = os.getenv("BLACKLIST_LIBRARY_TYPE", None) - whitelist_library_type = os.getenv("WHITELIST_LIBRARY_TYPE", None) - blacklist_users = os.getenv("BLACKLIST_USERS", None) - whitelist_users = os.getenv("WHITELIST_USERS", None) - - blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users, library_mapping, user_mapping) - - # Create server connections - logger("Creating server connections", 1) - servers = generate_server_connections() - - for server_1 in servers: - # If server is the final server in the list, then we are done with the loop - if server_1 == servers[-1]: - break - - # Start server_2 at the next server in the list - for server_2 in servers[servers.index(server_1) + 1:]: - - server_1_connection = server_1[1] - server_2_connection = server_2[1] - - # Create users list - logger("Creating users list", 1) - server_1_users, server_2_users = setup_users(server_1, server_2, blacklist_users, whitelist_users, user_mapping) - - logger("Creating watched lists", 1) - args = [[server_1_connection.get_watched, server_1_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping] - , [server_2_connection.get_watched, server_2_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping]] - - results = future_thread_executor(args) - server_1_watched = results[0] - server_2_watched = results[1] - logger(f"Server 1 watched: {server_1_watched}", 3) - logger(f"Server 2 watched: {server_2_watched}", 3) - - # clone watched so it isnt modified in the cleanup function so all duplicates are actually removed - server_1_watched_filtered = copy.deepcopy(server_1_watched) - server_2_watched_filtered = copy.deepcopy(server_2_watched) - - logger("Cleaning Server 1 Watched", 1) - server_1_watched_filtered = cleanup_watched(server_1_watched, server_2_watched, user_mapping, library_mapping) - - logger("Cleaning Server 2 Watched", 1) - server_2_watched_filtered = cleanup_watched(server_2_watched, server_1_watched, user_mapping, library_mapping) - - logger(f"server 1 watched that needs to be synced to server 2:\n{server_1_watched_filtered}", 1) - logger(f"server 2 watched that needs to be synced to server 1:\n{server_2_watched_filtered}", 1) - - args= [[server_1_connection.update_watched, server_2_watched_filtered, user_mapping, library_mapping, dryrun] - , [server_2_connection.update_watched, server_1_watched_filtered, user_mapping, library_mapping, dryrun]] - - future_thread_executor(args) - -def main(): - sleep_duration = float(os.getenv("SLEEP_DURATION", "3600")) - - while(True): - try: - main_loop() - logger(f"Looping in {sleep_duration}") - sleep(sleep_duration) - except Exception as error: - if isinstance(error, list): - for message in error: - logger(message, log_type=2) - else: - logger(error, log_type=2) - - - logger(traceback.format_exc(), 2) - logger(f"Retrying in {sleep_duration}", log_type=0) - sleep(sleep_duration) - - except KeyboardInterrupt: - logger("Exiting", log_type=0) - os._exit(0) +import copy, os, traceback, json, asyncio +from dotenv import load_dotenv +from time import sleep, perf_counter + +from src.functions import logger, str_to_bool, search_mapping, generate_library_guids_dict, future_thread_executor +from src.plex import Plex +from src.jellyfin import Jellyfin + +load_dotenv(override=True) + +def cleanup_watched(watched_list_1, watched_list_2, user_mapping=None, library_mapping=None): + modified_watched_list_1 = copy.deepcopy(watched_list_1) + + # remove entries from plex_watched that are in jellyfin_watched + for user_1 in watched_list_1: + user_other = None + if user_mapping: + user_other = search_mapping(user_mapping, user_1) + if user_1 in modified_watched_list_1: + if user_1 in watched_list_2: + user_2 = user_1 + elif user_other in watched_list_2: + user_2 = user_other + else: + logger(f"User {user_1} and {user_other} not found in watched list 2", 1) + continue + + for library_1 in watched_list_1[user_1]: + library_other = None + if library_mapping: + library_other = search_mapping(library_mapping, library_1) + if library_1 in modified_watched_list_1[user_1]: + if library_1 in watched_list_2[user_2]: + library_2 = library_1 + elif library_other in watched_list_2[user_2]: + library_2 = library_other + else: + logger(f"library {library_1} and {library_other} not found in watched list 2", 1) + continue + + _, episode_watched_list_2_keys_dict, movies_watched_list_2_keys_dict = generate_library_guids_dict(watched_list_2[user_2][library_2]) + + # Movies + if isinstance(watched_list_1[user_1][library_1], list): + for movie in watched_list_1[user_1][library_1]: + movie_found = False + for movie_key, movie_value in movie.items(): + if movie_key == "locations": + if "locations" in movies_watched_list_2_keys_dict.keys(): + for location in movie_value: + if location in movies_watched_list_2_keys_dict["locations"]: + movie_found = True + break + else: + if movie_key in movies_watched_list_2_keys_dict.keys(): + if movie_value in movies_watched_list_2_keys_dict[movie_key]: + movie_found = True + + if movie_found: + logger(f"Removing {movie} from {library_1}", 3) + modified_watched_list_1[user_1][library_1].remove(movie) + break + + + # TV Shows + elif isinstance(watched_list_1[user_1][library_1], dict): + # Generate full list of provider ids for episodes in watch_list_2 to easily compare if they exist in watch_list_1 + + for show_key_1 in watched_list_1[user_1][library_1].keys(): + show_key_dict = dict(show_key_1) + for season in watched_list_1[user_1][library_1][show_key_1]: + for episode in watched_list_1[user_1][library_1][show_key_1][season]: + episode_found = False + for episode_key, episode_value in episode.items(): + # If episode_key and episode_value are in episode_watched_list_2_keys_dict exactly, then remove from watch_list_1 + if episode_key == "locations": + if "locations" in episode_watched_list_2_keys_dict.keys(): + for location in episode_value: + if location in episode_watched_list_2_keys_dict["locations"]: + episode_found = True + break + + else: + if episode_key in episode_watched_list_2_keys_dict.keys(): + if episode_value in episode_watched_list_2_keys_dict[episode_key]: + episode_found = True + + if episode_found: + if episode in modified_watched_list_1[user_1][library_1][show_key_1][season]: + logger(f"Removing {episode} from {show_key_dict['title']}", 3) + modified_watched_list_1[user_1][library_1][show_key_1][season].remove(episode) + break + + # Remove empty seasons + if len(modified_watched_list_1[user_1][library_1][show_key_1][season]) == 0: + if season in modified_watched_list_1[user_1][library_1][show_key_1]: + logger(f"Removing {season} from {show_key_dict['title']} because it is empty", 3) + del modified_watched_list_1[user_1][library_1][show_key_1][season] + + # If the show is empty, remove the show + if len(modified_watched_list_1[user_1][library_1][show_key_1]) == 0: + if show_key_1 in modified_watched_list_1[user_1][library_1]: + logger(f"Removing {show_key_dict['title']} from {library_1} because it is empty", 1) + del modified_watched_list_1[user_1][library_1][show_key_1] + + for user_1 in watched_list_1: + for library_1 in watched_list_1[user_1]: + if library_1 in modified_watched_list_1[user_1]: + # If library is empty then remove it + if len(modified_watched_list_1[user_1][library_1]) == 0: + logger(f"Removing {library_1} from {user_1} because it is empty", 1) + del modified_watched_list_1[user_1][library_1] + + if user_1 in modified_watched_list_1: + # If user is empty delete user + if len(modified_watched_list_1[user_1]) == 0: + logger(f"Removing {user_1} from watched list 1 because it is empty", 1) + del modified_watched_list_1[user_1] + + return modified_watched_list_1 + +def setup_black_white_lists(blacklist_library: str, whitelist_library: str, blacklist_library_type: str, whitelist_library_type: str, blacklist_users: str, whitelist_users: str, library_mapping=None, user_mapping=None): + if blacklist_library: + if len(blacklist_library) > 0: + blacklist_library = blacklist_library.split(",") + blacklist_library = [x.strip() for x in blacklist_library] + if library_mapping: + temp_library = [] + for library in blacklist_library: + library_other = search_mapping(library_mapping, library) + if library_other: + temp_library.append(library_other) + + blacklist_library = blacklist_library + temp_library + else: + blacklist_library = [] + logger(f"Blacklist Library: {blacklist_library}", 1) + + if whitelist_library: + if len(whitelist_library) > 0: + whitelist_library = whitelist_library.split(",") + whitelist_library = [x.strip() for x in whitelist_library] + if library_mapping: + temp_library = [] + for library in whitelist_library: + library_other = search_mapping(library_mapping, library) + if library_other: + temp_library.append(library_other) + + whitelist_library = whitelist_library + temp_library + else: + whitelist_library = [] + logger(f"Whitelist Library: {whitelist_library}", 1) + + if blacklist_library_type: + if len(blacklist_library_type) > 0: + blacklist_library_type = blacklist_library_type.split(",") + blacklist_library_type = [x.lower().strip() for x in blacklist_library_type] + else: + blacklist_library_type = [] + logger(f"Blacklist Library Type: {blacklist_library_type}", 1) + + if whitelist_library_type: + if len(whitelist_library_type) > 0: + whitelist_library_type = whitelist_library_type.split(",") + whitelist_library_type = [x.lower().strip() for x in whitelist_library_type] + else: + whitelist_library_type = [] + logger(f"Whitelist Library Type: {whitelist_library_type}", 1) + + if blacklist_users: + if len(blacklist_users) > 0: + blacklist_users = blacklist_users.split(",") + blacklist_users = [x.lower().strip() for x in blacklist_users] + if user_mapping: + temp_users = [] + for user in blacklist_users: + user_other = search_mapping(user_mapping, user) + if user_other: + temp_users.append(user_other) + + blacklist_users = blacklist_users + temp_users + else: + blacklist_users = [] + logger(f"Blacklist Users: {blacklist_users}", 1) + + if whitelist_users: + if len(whitelist_users) > 0: + whitelist_users = whitelist_users.split(",") + whitelist_users = [x.lower().strip() for x in whitelist_users] + if user_mapping: + temp_users = [] + for user in whitelist_users: + user_other = search_mapping(user_mapping, user) + if user_other: + temp_users.append(user_other) + + whitelist_users = whitelist_users + temp_users + else: + whitelist_users = [] + else: + whitelist_users = [] + logger(f"Whitelist Users: {whitelist_users}", 1) + + return blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users + +def setup_users(server_1, server_2, blacklist_users, whitelist_users, user_mapping=None): + + # generate list of users from server 1 and server 2 + server_1_type = server_1[0] + server_1_connection = server_1[1] + server_2_type = server_2[0] + server_2_connection = server_2[1] + print(f"Server 1: {server_1_type} {server_1_connection}") + print(f"Server 2: {server_2_type} {server_2_connection}") + + server_1_users = [] + if server_1_type == "plex": + server_1_users = [ x.title.lower() for x in server_1_connection.users ] + elif server_1_type == "jellyfin": + server_1_users = [ key.lower() for key in server_1_connection.users.keys() ] + + server_2_users = [] + if server_2_type == "plex": + server_2_users = [ x.title.lower() for x in server_2_connection.users ] + elif server_2_type == "jellyfin": + server_2_users = [ key.lower() for key in server_2_connection.users.keys() ] + + + # combined list of overlapping users from plex and jellyfin + users = {} + + for server_1_user in server_1_users: + if user_mapping: + jellyfin_plex_mapped_user = search_mapping(user_mapping, server_1_user) + if jellyfin_plex_mapped_user: + users[server_1_user] = jellyfin_plex_mapped_user + continue + + if server_1_user in server_2_users: + users[server_1_user] = server_1_user + + for server_2_user in server_2_users: + if user_mapping: + plex_jellyfin_mapped_user = search_mapping(user_mapping, server_2_user) + if plex_jellyfin_mapped_user: + users[plex_jellyfin_mapped_user] = server_2_user + continue + + if server_2_user in server_1_users: + users[server_2_user] = server_2_user + + logger(f"User list that exist on both servers {users}", 1) + + users_filtered = {} + for user in users: + # whitelist_user is not empty and user lowercase is not in whitelist lowercase + if len(whitelist_users) > 0: + if user not in whitelist_users and users[user] not in whitelist_users: + logger(f"{user} or {users[user]} is not in whitelist", 1) + continue + + if user not in blacklist_users and users[user] not in blacklist_users: + users_filtered[user] = users[user] + + logger(f"Filtered user list {users_filtered}", 1) + + if server_1_type == "plex": + output_server_1_users = [] + for plex_user in server_1_connection.users: + if plex_user.title.lower() in users_filtered.keys() or plex_user.title.lower() in users_filtered.values(): + output_server_1_users.append(plex_user) + elif server_1_type == "jellyfin": + output_server_1_users = {} + for jellyfin_user, jellyfin_id in server_1_connection.users.items(): + if jellyfin_user.lower() in users_filtered.keys() or jellyfin_user.lower() in users_filtered.values(): + output_server_1_users[jellyfin_user] = jellyfin_id + + if server_2_type == "plex": + output_server_2_users = [] + for plex_user in server_2_connection.users: + if plex_user.title.lower() in users_filtered.keys() or plex_user.title.lower() in users_filtered.values(): + output_server_2_users.append(plex_user) + elif server_2_type == "jellyfin": + output_server_2_users = {} + for jellyfin_user, jellyfin_id in server_2_connection.users.items(): + if jellyfin_user.lower() in users_filtered.keys() or jellyfin_user.lower() in users_filtered.values(): + output_server_2_users[jellyfin_user] = jellyfin_id + + if len(output_server_1_users) == 0: + raise Exception(f"No users found for server 1, users found {users} filtered users {users_filtered}") + + if len(output_server_2_users) == 0: + raise Exception(f"No users found for server 2, users found {users} filtered users {users_filtered}") + + logger(f"Server 1 users: {output_server_1_users}", 1) + logger(f"Server 2 users: {output_server_2_users}", 1) + + return output_server_1_users, output_server_2_users + +def generate_server_connections(): + servers = [] + + plex_baseurl = os.getenv("PLEX_BASEURL", None) + plex_token = os.getenv("PLEX_TOKEN", None) + plex_username = os.getenv("PLEX_USERNAME", None) + plex_password = os.getenv("PLEX_PASSWORD", None) + plex_servername = os.getenv("PLEX_SERVERNAME", None) + ssl_bypass = str_to_bool(os.getenv("SSL_BYPASS", "False")) + + if plex_baseurl and plex_token: + plex_baseurl = plex_baseurl.split(",") + plex_token = plex_token.split(",") + + if len(plex_baseurl) != len(plex_token): + raise Exception("PLEX_BASEURL and PLEX_TOKEN must have the same number of entries") + + for i, url in enumerate(plex_baseurl): + servers.append(("plex", Plex(baseurl=url.strip(), token=plex_token[i].strip(), username=None, password=None, servername=None, ssl_bypass=ssl_bypass))) + + if plex_username and plex_password and plex_servername: + plex_username = plex_username.split(",") + plex_password = plex_password.split(",") + plex_servername = plex_servername.split(",") + + if len(plex_username) != len(plex_password) or len(plex_username) != len(plex_servername): + raise Exception("PLEX_USERNAME, PLEX_PASSWORD and PLEX_SERVERNAME must have the same number of entries") + + for i, username in enumerate(plex_username): + servers.append(("plex", Plex(baseurl=None, token=None, username=username.strip(), password=plex_password[i].strip(), servername=plex_servername[i].strip(), ssl_bypass=ssl_bypass))) + + jellyfin_baseurl = os.getenv("JELLYFIN_BASEURL", None) + jellyfin_token = os.getenv("JELLYFIN_TOKEN", None) + + if jellyfin_baseurl and jellyfin_token: + jellyfin_baseurl = jellyfin_baseurl.split(",") + jellyfin_token = jellyfin_token.split(",") + + if len(jellyfin_baseurl) != len(jellyfin_token): + raise Exception("JELLYFIN_BASEURL and JELLYFIN_TOKEN must have the same number of entries") + + for i, baseurl in enumerate(jellyfin_baseurl): + servers.append(("jellyfin", Jellyfin(baseurl=baseurl.strip(), token=jellyfin_token[i].strip()))) + + return servers + + +def main_loop(): + logfile = os.getenv("LOGFILE","log.log") + # Delete logfile if it exists + #if os.path.exists(logfile): + # os.remove(logfile) + + dryrun = str_to_bool(os.getenv("DRYRUN", "False")) + logger(f"Dryrun: {dryrun}", 1) + + user_mapping = os.getenv("USER_MAPPING") + if user_mapping: + user_mapping = json.loads(user_mapping.lower()) + logger(f"User Mapping: {user_mapping}", 1) + + library_mapping = os.getenv("LIBRARY_MAPPING") + if library_mapping: + library_mapping = json.loads(library_mapping) + logger(f"Library Mapping: {library_mapping}", 1) + + # Create (black/white)lists + logger("Creating (black/white)lists", 1) + blacklist_library = os.getenv("BLACKLIST_LIBRARY", None) + whitelist_library = os.getenv("WHITELIST_LIBRARY", None) + blacklist_library_type = os.getenv("BLACKLIST_LIBRARY_TYPE", None) + whitelist_library_type = os.getenv("WHITELIST_LIBRARY_TYPE", None) + blacklist_users = os.getenv("BLACKLIST_USERS", None) + whitelist_users = os.getenv("WHITELIST_USERS", None) + + blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users, library_mapping, user_mapping) + + # Create server connections + logger("Creating server connections", 1) + servers = generate_server_connections() + + for server_1 in servers: + # If server is the final server in the list, then we are done with the loop + if server_1 == servers[-1]: + break + + # Start server_2 at the next server in the list + for server_2 in servers[servers.index(server_1) + 1:]: + + server_1_connection = server_1[1] + server_2_connection = server_2[1] + + # Create users list + logger("Creating users list", 1) + server_1_users, server_2_users = setup_users(server_1, server_2, blacklist_users, whitelist_users, user_mapping) + + logger("Creating watched lists", 1) + server_1_watched = server_1_connection.get_watched(server_1_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) + logger("Finished creating watched list server 1", 0) + server_2_watched = asyncio.run(server_2_connection.get_watched(server_2_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping)) + logger("Finished creating watched list server 2", 0) + logger(f"Server 1 watched: {server_1_watched}", 3) + logger(f"Server 2 watched: {server_2_watched}", 3) + + # clone watched so it isnt modified in the cleanup function so all duplicates are actually removed + server_1_watched_filtered = copy.deepcopy(server_1_watched) + server_2_watched_filtered = copy.deepcopy(server_2_watched) + + logger("Cleaning Server 1 Watched", 1) + server_1_watched_filtered = cleanup_watched(server_1_watched, server_2_watched, user_mapping, library_mapping) + + logger("Cleaning Server 2 Watched", 1) + server_2_watched_filtered = cleanup_watched(server_2_watched, server_1_watched, user_mapping, library_mapping) + + logger(f"server 1 watched that needs to be synced to server 2:\n{server_1_watched_filtered}", 1) + logger(f"server 2 watched that needs to be synced to server 1:\n{server_2_watched_filtered}", 1) + + server_1_connection.update_watched(server_2_watched_filtered, user_mapping, library_mapping, dryrun) + asyncio.run(server_2_connection.update_watched(server_1_watched_filtered, user_mapping, library_mapping, dryrun)) + +def main(): + sleep_duration = float(os.getenv("SLEEP_DURATION", "3600")) + times = [] + while(True): + try: + start = perf_counter() + main_loop() + end = perf_counter() + times.append(end - start) + + logger(f"Looping in {sleep_duration}") + sleep(sleep_duration) + + except Exception as error: + if isinstance(error, list): + for message in error: + logger(message, log_type=2) + else: + logger(error, log_type=2) + + + logger(traceback.format_exc(), 2) + logger(f"Retrying in {sleep_duration}", log_type=0) + sleep(sleep_duration) + + except KeyboardInterrupt: + if len(times) > 0: + logger(f"Average time: {sum(times) / len(times)}", 0) + logger("Exiting", log_type=0) + os._exit(0) diff --git a/src/plex.py b/src/plex.py index 8637733..866a8c5 100644 --- a/src/plex.py +++ b/src/plex.py @@ -1,312 +1,318 @@ -import re, requests - -from plexapi.server import PlexServer -from plexapi.myplex import MyPlexAccount - -from src.functions import logger, search_mapping, check_skip_logic, generate_library_guids_dict, future_thread_executor - - -# class plex accept base url and token and username and password but default with none -class Plex: - def __init__(self, baseurl=None, token=None, username=None, password=None, servername=None, ssl_bypass=False): - self.baseurl = baseurl - self.token = token - self.username = username - self.password = password - self.servername = servername - self.plex = self.login() - self.admin_user = self.plex.myPlexAccount() - self.users = self.get_users() - - def login(self): - try: - if self.baseurl and self.token: - # Login via token - plex = PlexServer(self.baseurl, self.token) - elif self.username and self.password and self.servername: - # Login via plex account - account = MyPlexAccount(self.username, self.password) - plex = account.resource(self.servername).connect() - else: - raise Exception("No complete plex credentials provided") - - return plex - except Exception as e: - if self.username or self.password: - msg = f"Failed to login via plex account {self.username}" - logger(f"Plex: Failed to login, {msg}, Error: {e}", 2) - else: - logger(f"Plex: Failed to login, Error: {e}", 2) - raise Exception(e) - - - def get_users(self): - try: - users = self.plex.myPlexAccount().users() - - # append self to users - users.append(self.plex.myPlexAccount()) - - return users - except Exception as e: - logger(f"Plex: Failed to get users, Error: {e}", 2) - raise Exception(e) - - def get_user_watched(self, user, user_plex, library): - try: - user_name = user.title.lower() - user_watched = {} - user_watched[user_name] = {} - - logger(f"Plex: Generating watched for {user_name} in library {library.title}", 0) - - if library.type == "movie": - user_watched[user_name][library.title] = [] - - library_videos = user_plex.library.section(library.title) - for video in library_videos.search(unwatched=False): - movie_guids = {} - for guid in video.guids: - guid_source = re.search(r'(.*)://', guid.id).group(1).lower() - guid_id = re.search(r'://(.*)', guid.id).group(1) - movie_guids[guid_source] = guid_id - - movie_guids["title"] = video.title - movie_guids["locations"] = tuple([x.split("/")[-1] for x in video.locations]) - - user_watched[user_name][library.title].append(movie_guids) - - elif library.type == "show": - user_watched[user_name][library.title] = {} - - library_videos = user_plex.library.section(library.title) - for show in library_videos.search(unwatched=False): - show_guids = {} - for show_guid in show.guids: - # Extract after :// from guid.id - show_guid_source = re.search(r'(.*)://', show_guid.id).group(1).lower() - show_guid_id = re.search(r'://(.*)', show_guid.id).group(1) - show_guids[show_guid_source] = show_guid_id - - show_guids["title"] = show.title - show_guids["locations"] = tuple([x.split("/")[-1] for x in show.locations]) - show_guids = frozenset(show_guids.items()) - - for season in show.seasons(): - episode_guids = [] - for episode in season.episodes(): - if episode.viewCount > 0: - episode_guids_temp = {} - for guid in episode.guids: - # Extract after :// from guid.id - guid_source = re.search(r'(.*)://', guid.id).group(1).lower() - guid_id = re.search(r'://(.*)', guid.id).group(1) - episode_guids_temp[guid_source] = guid_id - - episode_guids_temp["locations"] = tuple([x.split("/")[-1] for x in episode.locations]) - episode_guids.append(episode_guids_temp) - - if episode_guids: - # append show, season, episode - if show_guids not in user_watched[user_name][library.title]: - user_watched[user_name][library.title][show_guids] = {} - if season.title not in user_watched[user_name][library.title][show_guids]: - user_watched[user_name][library.title][show_guids][season.title] = {} - user_watched[user_name][library.title][show_guids][season.title] = episode_guids - - - return user_watched - except Exception as e: - logger(f"Plex: Failed to get watched for {user_name} in library {library.title}, Error: {e}", 2) - raise Exception(e) - - - def get_watched(self, users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping): - try: - # Get all libraries - users_watched = {} - args = [] - - for user in users: - if self.admin_user == user: - user_plex = self.plex - else: - user_plex = PlexServer(self.plex._baseurl, user.get_token(self.plex.machineIdentifier)) - - libraries = user_plex.library.sections() - - for library in libraries: - library_title = library.title - library_type = library.type - - skip_reason = check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) - - if skip_reason: - logger(f"Plex: Skipping library {library_title} {skip_reason}", 1) - continue - - args.append([self.get_user_watched, user, user_plex, library]) - - for user_watched in future_thread_executor(args): - for user, user_watched_temp in user_watched.items(): - if user not in users_watched: - users_watched[user] = {} - users_watched[user].update(user_watched_temp) - - return users_watched - except Exception as e: - logger(f"Plex: Failed to get watched, Error: {e}", 2) - raise Exception(e) - - - def update_user_watched (self, user, user_plex, library, videos, dryrun): - try: - logger(f"Plex: Updating watched for {user.title} in library {library}", 1) - videos_shows_ids, videos_episodes_ids, videos_movies_ids = generate_library_guids_dict(videos) - logger(f"Plex: mark list\nShows: {videos_shows_ids}\nEpisodes: {videos_episodes_ids}\nMovies: {videos_movies_ids}", 1) - - library_videos = user_plex.library.section(library) - if videos_movies_ids: - for movies_search in library_videos.search(unwatched=True): - movie_found = False - for movie_location in movies_search.locations: - if movie_location.split("/")[-1] in videos_movies_ids["locations"]: - movie_found = True - break - - if not movie_found: - for movie_guid in movies_search.guids: - movie_guid_source = re.search(r'(.*)://', movie_guid.id).group(1).lower() - movie_guid_id = re.search(r'://(.*)', movie_guid.id).group(1) - - # If movie provider source and movie provider id are in videos_movie_ids exactly, then the movie is in the list - if movie_guid_source in videos_movies_ids.keys(): - if movie_guid_id in videos_movies_ids[movie_guid_source]: - movie_found = True - break - - if movie_found: - msg = f"{movies_search.title} as watched for {user.title} in {library} for Plex" - if not dryrun: - logger(f"Marked {msg}", 0) - movies_search.markWatched() - else: - logger(f"Dryrun {msg}", 0) - else: - logger(f"Plex: Skipping movie {movies_search.title} as it is not in mark list for {user.title}", 1) - - - if videos_shows_ids and videos_episodes_ids: - for show_search in library_videos.search(unwatched=True): - show_found = False - for show_location in show_search.locations: - if show_location.split("/")[-1] in videos_shows_ids["locations"]: - show_found = True - break - - if not show_found: - for show_guid in show_search.guids: - show_guid_source = re.search(r'(.*)://', show_guid.id).group(1).lower() - show_guid_id = re.search(r'://(.*)', show_guid.id).group(1) - - # If show provider source and show provider id are in videos_shows_ids exactly, then the show is in the list - if show_guid_source in videos_shows_ids.keys(): - if show_guid_id in videos_shows_ids[show_guid_source]: - show_found = True - break - - if show_found: - for episode_search in show_search.episodes(): - episode_found = False - - for episode_location in episode_search.locations: - if episode_location.split("/")[-1] in videos_episodes_ids["locations"]: - episode_found = True - break - - if not episode_found: - for episode_guid in episode_search.guids: - episode_guid_source = re.search(r'(.*)://', episode_guid.id).group(1).lower() - episode_guid_id = re.search(r'://(.*)', episode_guid.id).group(1) - - # If episode provider source and episode provider id are in videos_episodes_ids exactly, then the episode is in the list - if episode_guid_source in videos_episodes_ids.keys(): - if episode_guid_id in videos_episodes_ids[episode_guid_source]: - episode_found = True - break - - if episode_found: - msg = f"{show_search.title} {episode_search.title} as watched for {user.title} in {library} for Plex" - if not dryrun: - logger(f"Marked {msg}", 0) - episode_search.markWatched() - else: - logger(f"Dryrun {msg}", 0) - else: - logger(f"Plex: Skipping episode {episode_search.title} as it is not in mark list for {user.title}", 1) - else: - logger(f"Plex: Skipping show {show_search.title} as it is not in mark list for {user.title}", 1) - - if not videos_movies_ids and not videos_shows_ids and not videos_episodes_ids: - logger(f"Jellyfin: No videos to mark as watched for {user.title} in library {library}", 1) - - except Exception as e: - logger(f"Plex: Failed to update watched for {user.title} in library {library}, Error: {e}", 2) - raise Exception(e) - - - def update_watched(self, watched_list, user_mapping=None, library_mapping=None, dryrun=False): - try: - args = [] - - for user, libraries in watched_list.items(): - user_other = None - # If type of user is dict - if user_mapping: - if user in user_mapping.keys(): - user_other = user_mapping[user] - elif user in user_mapping.values(): - user_other = search_mapping(user_mapping, user) - - for index, value in enumerate(self.users): - if user.lower() == value.title.lower(): - user = self.users[index] - break - elif user_other and user_other.lower() == value.title.lower(): - user = self.users[index] - break - - if self.admin_user == user: - user_plex = self.plex - else: - user_plex = PlexServer(self.plex._baseurl, user.get_token(self.plex.machineIdentifier)) - - for library, videos in libraries.items(): - library_other = None - if library_mapping: - if library in library_mapping.keys(): - library_other = library_mapping[library] - elif library in library_mapping.values(): - library_other = search_mapping(library_mapping, library) - - # if library in plex library list - library_list = user_plex.library.sections() - if library.lower() not in [x.title.lower() for x in library_list]: - if library_other: - if library_other.lower() in [x.title.lower() for x in library_list]: - logger(f"Plex: Library {library} not found, but {library_other} found, using {library_other}", 1) - library = library_other - else: - logger(f"Plex: Library {library} or {library_other} not found in library list", 2) - continue - else: - logger(f"Plex: Library {library} not found in library list", 2) - continue - - - args.append([self.update_user_watched, user, user_plex, library, videos, dryrun]) - - future_thread_executor(args) - except Exception as e: - logger(f"Plex: Failed to update watched, Error: {e}", 2) - raise Exception(e) +import re, requests + +from plexapi.server import PlexServer +from plexapi.myplex import MyPlexAccount + +from src.functions import logger, search_mapping, check_skip_logic, generate_library_guids_dict, future_thread_executor + + +# class plex accept base url and token and username and password but default with none +class Plex: + def __init__(self, baseurl=None, token=None, username=None, password=None, servername=None, ssl_bypass=False): + self.baseurl = baseurl + self.token = token + self.username = username + self.password = password + self.servername = servername + self.plex = self.login(ssl_bypass) + self.admin_user = self.plex.myPlexAccount() + self.users = self.get_users() + + def login(self, ssl_bypass=False): + try: + if self.baseurl and self.token: + # Login via token + if ssl_bypass: + session = requests.Session() + session.verify = False + plex = PlexServer(self.baseurl, self.token, session=session) + else: + plex = PlexServer(self.baseurl, self.token) + elif self.username and self.password and self.servername: + # Login via plex account + account = MyPlexAccount(self.username, self.password) + plex = account.resource(self.servername).connect() + else: + raise Exception("No complete plex credentials provided") + + return plex + except Exception as e: + if self.username or self.password: + msg = f"Failed to login via plex account {self.username}" + logger(f"Plex: Failed to login, {msg}, Error: {e}", 2) + else: + logger(f"Plex: Failed to login, Error: {e}", 2) + raise Exception(e) + + + def get_users(self): + try: + users = self.plex.myPlexAccount().users() + + # append self to users + users.append(self.plex.myPlexAccount()) + + return users + except Exception as e: + logger(f"Plex: Failed to get users, Error: {e}", 2) + raise Exception(e) + + + def get_user_watched(self, user, user_plex, library): + try: + user_name = user.title.lower() + user_watched = {} + user_watched[user_name] = {} + + logger(f"Plex: Generating watched for {user_name} in library {library.title}", 0) + + if library.type == "movie": + user_watched[user_name][library.title] = [] + + library_videos = user_plex.library.section(library.title) + for video in library_videos.search(unwatched=False): + movie_guids = {} + for guid in video.guids: + guid_source = re.search(r'(.*)://', guid.id).group(1).lower() + guid_id = re.search(r'://(.*)', guid.id).group(1) + movie_guids[guid_source] = guid_id + + movie_guids["title"] = video.title + movie_guids["locations"] = tuple([x.split("/")[-1] for x in video.locations]) + + user_watched[user_name][library.title].append(movie_guids) + + elif library.type == "show": + user_watched[user_name][library.title] = {} + + library_videos = user_plex.library.section(library.title) + for show in library_videos.search(unwatched=False): + show_guids = {} + for show_guid in show.guids: + # Extract after :// from guid.id + show_guid_source = re.search(r'(.*)://', show_guid.id).group(1).lower() + show_guid_id = re.search(r'://(.*)', show_guid.id).group(1) + show_guids[show_guid_source] = show_guid_id + + show_guids["title"] = show.title + show_guids["locations"] = tuple([x.split("/")[-1] for x in show.locations]) + show_guids = frozenset(show_guids.items()) + + for season in show.seasons(): + episode_guids = [] + for episode in season.episodes(): + if episode.viewCount > 0: + episode_guids_temp = {} + for guid in episode.guids: + # Extract after :// from guid.id + guid_source = re.search(r'(.*)://', guid.id).group(1).lower() + guid_id = re.search(r'://(.*)', guid.id).group(1) + episode_guids_temp[guid_source] = guid_id + + episode_guids_temp["locations"] = tuple([x.split("/")[-1] for x in episode.locations]) + episode_guids.append(episode_guids_temp) + + if episode_guids: + # append show, season, episode + if show_guids not in user_watched[user_name][library.title]: + user_watched[user_name][library.title][show_guids] = {} + if season.title not in user_watched[user_name][library.title][show_guids]: + user_watched[user_name][library.title][show_guids][season.title] = {} + user_watched[user_name][library.title][show_guids][season.title] = episode_guids + + + return user_watched + except Exception as e: + logger(f"Plex: Failed to get watched for {user_name} in library {library.title}, Error: {e}", 2) + raise Exception(e) + + + def get_watched(self, users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping): + try: + # Get all libraries + users_watched = {} + args = [] + + for user in users: + if self.admin_user == user: + user_plex = self.plex + else: + user_plex = PlexServer(self.plex._baseurl, user.get_token(self.plex.machineIdentifier)) + + libraries = user_plex.library.sections() + + for library in libraries: + library_title = library.title + library_type = library.type + + skip_reason = check_skip_logic(library_title, library_type, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) + + if skip_reason: + logger(f"Plex: Skipping library {library_title} {skip_reason}", 1) + continue + + args.append([self.get_user_watched, user, user_plex, library]) + + for user_watched in future_thread_executor(args): + for user, user_watched_temp in user_watched.items(): + if user not in users_watched: + users_watched[user] = {} + users_watched[user].update(user_watched_temp) + + return users_watched + except Exception as e: + logger(f"Plex: Failed to get watched, Error: {e}", 2) + raise Exception(e) + + + def update_user_watched (self, user, user_plex, library, videos, dryrun): + try: + logger(f"Plex: Updating watched for {user.title} in library {library}", 1) + videos_shows_ids, videos_episodes_ids, videos_movies_ids = generate_library_guids_dict(videos) + logger(f"Plex: mark list\nShows: {videos_shows_ids}\nEpisodes: {videos_episodes_ids}\nMovies: {videos_movies_ids}", 1) + + library_videos = user_plex.library.section(library) + if videos_movies_ids: + for movies_search in library_videos.search(unwatched=True): + movie_found = False + for movie_location in movies_search.locations: + if movie_location.split("/")[-1] in videos_movies_ids["locations"]: + movie_found = True + break + + if not movie_found: + for movie_guid in movies_search.guids: + movie_guid_source = re.search(r'(.*)://', movie_guid.id).group(1).lower() + movie_guid_id = re.search(r'://(.*)', movie_guid.id).group(1) + + # If movie provider source and movie provider id are in videos_movie_ids exactly, then the movie is in the list + if movie_guid_source in videos_movies_ids.keys(): + if movie_guid_id in videos_movies_ids[movie_guid_source]: + movie_found = True + break + + if movie_found: + msg = f"{movies_search.title} as watched for {user.title} in {library} for Plex" + if not dryrun: + logger(f"Marked {msg}", 0) + movies_search.markWatched() + else: + logger(f"Dryrun {msg}", 0) + else: + logger(f"Plex: Skipping movie {movies_search.title} as it is not in mark list for {user.title}", 1) + + + if videos_shows_ids and videos_episodes_ids: + for show_search in library_videos.search(unwatched=True): + show_found = False + for show_location in show_search.locations: + if show_location.split("/")[-1] in videos_shows_ids["locations"]: + show_found = True + break + + if not show_found: + for show_guid in show_search.guids: + show_guid_source = re.search(r'(.*)://', show_guid.id).group(1).lower() + show_guid_id = re.search(r'://(.*)', show_guid.id).group(1) + + # If show provider source and show provider id are in videos_shows_ids exactly, then the show is in the list + if show_guid_source in videos_shows_ids.keys(): + if show_guid_id in videos_shows_ids[show_guid_source]: + show_found = True + break + + if show_found: + for episode_search in show_search.episodes(): + episode_found = False + + for episode_location in episode_search.locations: + if episode_location.split("/")[-1] in videos_episodes_ids["locations"]: + episode_found = True + break + + if not episode_found: + for episode_guid in episode_search.guids: + episode_guid_source = re.search(r'(.*)://', episode_guid.id).group(1).lower() + episode_guid_id = re.search(r'://(.*)', episode_guid.id).group(1) + + # If episode provider source and episode provider id are in videos_episodes_ids exactly, then the episode is in the list + if episode_guid_source in videos_episodes_ids.keys(): + if episode_guid_id in videos_episodes_ids[episode_guid_source]: + episode_found = True + break + + if episode_found: + msg = f"{show_search.title} {episode_search.title} as watched for {user.title} in {library} for Plex" + if not dryrun: + logger(f"Marked {msg}", 0) + episode_search.markWatched() + else: + logger(f"Dryrun {msg}", 0) + else: + logger(f"Plex: Skipping episode {episode_search.title} as it is not in mark list for {user.title}", 1) + else: + logger(f"Plex: Skipping show {show_search.title} as it is not in mark list for {user.title}", 1) + + if not videos_movies_ids and not videos_shows_ids and not videos_episodes_ids: + logger(f"Jellyfin: No videos to mark as watched for {user.title} in library {library}", 1) + + except Exception as e: + logger(f"Plex: Failed to update watched for {user.title} in library {library}, Error: {e}", 2) + raise Exception(e) + + + def update_watched(self, watched_list, user_mapping=None, library_mapping=None, dryrun=False): + try: + args = [] + + for user, libraries in watched_list.items(): + user_other = None + # If type of user is dict + if user_mapping: + if user in user_mapping.keys(): + user_other = user_mapping[user] + elif user in user_mapping.values(): + user_other = search_mapping(user_mapping, user) + + for index, value in enumerate(self.users): + if user.lower() == value.title.lower(): + user = self.users[index] + break + elif user_other and user_other.lower() == value.title.lower(): + user = self.users[index] + break + + if self.admin_user == user: + user_plex = self.plex + else: + user_plex = PlexServer(self.plex._baseurl, user.get_token(self.plex.machineIdentifier)) + + for library, videos in libraries.items(): + library_other = None + if library_mapping: + if library in library_mapping.keys(): + library_other = library_mapping[library] + elif library in library_mapping.values(): + library_other = search_mapping(library_mapping, library) + + # if library in plex library list + library_list = user_plex.library.sections() + if library.lower() not in [x.title.lower() for x in library_list]: + if library_other: + if library_other.lower() in [x.title.lower() for x in library_list]: + logger(f"Plex: Library {library} not found, but {library_other} found, using {library_other}", 1) + library = library_other + else: + logger(f"Plex: Library {library} or {library_other} not found in library list", 2) + continue + else: + logger(f"Plex: Library {library} not found in library list", 2) + continue + + + args.append([self.update_user_watched, user, user_plex, library, videos, dryrun]) + + future_thread_executor(args) + except Exception as e: + logger(f"Plex: Failed to update watched, Error: {e}", 2) + raise Exception(e) diff --git a/test/requirements.txt b/test/requirements.txt index e079f8a..4f76727 100644 --- a/test/requirements.txt +++ b/test/requirements.txt @@ -1 +1 @@ -pytest +pytest diff --git a/test/test_main_.py b/test/test_main_.py index 2b15392..30d8ab0 100644 --- a/test/test_main_.py +++ b/test/test_main_.py @@ -1,47 +1,47 @@ -import sys -import os - -# getting the name of the directory -# where the this file is present. -current = os.path.dirname(os.path.realpath(__file__)) - -# Getting the parent directory name -# where the current directory is present. -parent = os.path.dirname(current) - -# adding the parent directory to -# the sys.path. -sys.path.append(parent) - -from src.main import setup_black_white_lists - -def test_setup_black_white_lists(): - # Simple - blacklist_library = 'library1, library2' - whitelist_library = 'library1, library2' - blacklist_library_type = 'library_type1, library_type2' - whitelist_library_type = 'library_type1, library_type2' - blacklist_users = 'user1, user2' - whitelist_users = 'user1, user2' - - results_blacklist_library, return_whitelist_library, return_blacklist_library_type, return_whitelist_library_type, return_blacklist_users, return_whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users) - - assert results_blacklist_library == ['library1', 'library2'] - assert return_whitelist_library == ['library1', 'library2'] - assert return_blacklist_library_type == ['library_type1', 'library_type2'] - assert return_whitelist_library_type == ['library_type1', 'library_type2'] - assert return_blacklist_users == ['user1', 'user2'] - assert return_whitelist_users == ['user1', 'user2'] - - # Library Mapping and user mapping - library_mapping = { "library1": "library3" } - user_mapping = { "user1": "user3" } - - results_blacklist_library, return_whitelist_library, return_blacklist_library_type, return_whitelist_library_type, return_blacklist_users, return_whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users, library_mapping, user_mapping) - - assert results_blacklist_library == ['library1', 'library2', 'library3'] - assert return_whitelist_library == ['library1', 'library2', 'library3'] - assert return_blacklist_library_type == ['library_type1', 'library_type2'] - assert return_whitelist_library_type == ['library_type1', 'library_type2'] - assert return_blacklist_users == ['user1', 'user2', 'user3'] - assert return_whitelist_users == ['user1', 'user2', 'user3'] +import sys +import os + +# getting the name of the directory +# where the this file is present. +current = os.path.dirname(os.path.realpath(__file__)) + +# Getting the parent directory name +# where the current directory is present. +parent = os.path.dirname(current) + +# adding the parent directory to +# the sys.path. +sys.path.append(parent) + +from src.main import setup_black_white_lists + +def test_setup_black_white_lists(): + # Simple + blacklist_library = 'library1, library2' + whitelist_library = 'library1, library2' + blacklist_library_type = 'library_type1, library_type2' + whitelist_library_type = 'library_type1, library_type2' + blacklist_users = 'user1, user2' + whitelist_users = 'user1, user2' + + results_blacklist_library, return_whitelist_library, return_blacklist_library_type, return_whitelist_library_type, return_blacklist_users, return_whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users) + + assert results_blacklist_library == ['library1', 'library2'] + assert return_whitelist_library == ['library1', 'library2'] + assert return_blacklist_library_type == ['library_type1', 'library_type2'] + assert return_whitelist_library_type == ['library_type1', 'library_type2'] + assert return_blacklist_users == ['user1', 'user2'] + assert return_whitelist_users == ['user1', 'user2'] + + # Library Mapping and user mapping + library_mapping = { "library1": "library3" } + user_mapping = { "user1": "user3" } + + results_blacklist_library, return_whitelist_library, return_blacklist_library_type, return_whitelist_library_type, return_blacklist_users, return_whitelist_users = setup_black_white_lists(blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, blacklist_users, whitelist_users, library_mapping, user_mapping) + + assert results_blacklist_library == ['library1', 'library2', 'library3'] + assert return_whitelist_library == ['library1', 'library2', 'library3'] + assert return_blacklist_library_type == ['library_type1', 'library_type2'] + assert return_whitelist_library_type == ['library_type1', 'library_type2'] + assert return_blacklist_users == ['user1', 'user2', 'user3'] + assert return_whitelist_users == ['user1', 'user2', 'user3'] diff --git a/test/test_main_cleanup_watched.py b/test/test_main_cleanup_watched.py index 4d2bbcd..4e1bd7d 100644 --- a/test/test_main_cleanup_watched.py +++ b/test/test_main_cleanup_watched.py @@ -1,176 +1,176 @@ -import sys -import os - -# getting the name of the directory -# where the this file is present. -current = os.path.dirname(os.path.realpath(__file__)) - -# Getting the parent directory name -# where the current directory is present. -parent = os.path.dirname(current) - -# adding the parent directory to -# the sys.path. -sys.path.append(parent) - -from src.main import cleanup_watched - -tv_shows_watched_list_1 = { - frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { - "Season 1": [ - {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)}, - {'imdb': 'tt0550487', 'tmdb': '282861', 'tvdb': '300385', 'locations': ('Criminal Minds S01E02 Compulsion WEBDL-720p.mkv',)} - ] - }, - frozenset({("title", "Test"), ("locations", ("Test",))}): { - "Season 1": [ - {'locations': ('Test S01E01.mkv',)}, - {'locations': ('Test S01E02.mkv',)} - ] - } -} - -movies_watched_list_1 = [ - {"imdb":"tt2380307", "tmdb":"354912", 'title': 'Coco', 'locations': ('Coco (2017) Remux-1080p.mkv',)}, - {"tmdbcollection":"448150", "imdb":"tt1431045", "tmdb":"293660", 'title': 'Deadpool', 'locations': ('Deadpool (2016) Remux-1080p.mkv',)}, -] - -tv_shows_watched_list_2 = { - frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { - "Season 1": [ - {'imdb': 'tt0550487', 'tmdb': '282861', 'tvdb': '300385', 'locations': ('Criminal Minds S01E02 Compulsion WEBDL-720p.mkv',)}, - {'imdb': 'tt0550498', 'tmdb': '282865', 'tvdb': '300474', 'locations': ("Criminal Minds S01E03 Won't Get Fooled Again WEBDL-720p.mkv",)} - ] - }, - frozenset({("title", "Test"), ("locations", ("Test",))}): { - "Season 1": [ - {'locations': ('Test S01E02.mkv',)}, - {'locations': ('Test S01E03.mkv',)} - ] - } -} - -movies_watched_list_2 = [ - {"imdb":"tt2380307", "tmdb":"354912", 'title': 'Coco', 'locations': ('Coco (2017) Remux-1080p.mkv',)}, - {'imdb': 'tt0384793', 'tmdb': '9788', 'tvdb': '9103', 'title': 'Accepted', 'locations': ('Accepted (2006) Remux-1080p.mkv',)} -] - -# Test to see if objects get deleted all the way up to the root. -tv_shows_2_watched_list_1 = { - frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { - "Season 1": [ - {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)}, - ] - } -} - -expected_tv_show_watched_list_1 = { - frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { - "Season 1": [ - {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)} - ] - }, - frozenset({("title", "Test"), ("locations", ("Test",))}): { - "Season 1": [ - {'locations': ('Test S01E01.mkv',)} - ] - } -} - -expected_movie_watched_list_1 = [ - {"tmdbcollection":"448150", "imdb":"tt1431045", "tmdb":"293660", 'title': 'Deadpool', 'locations': ('Deadpool (2016) Remux-1080p.mkv',)} -] - -expected_tv_show_watched_list_2 = { - frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { - "Season 1": [ - {'imdb': 'tt0550498', 'tmdb': '282865', 'tvdb': '300474', 'locations': ("Criminal Minds S01E03 Won't Get Fooled Again WEBDL-720p.mkv",)} - ] - }, - frozenset({("title", "Test"), ("locations", ("Test",))}): { - "Season 1": [ - {'locations': ('Test S01E03.mkv',)} - ] - } -} - -expected_movie_watched_list_2 = [ - {'imdb': 'tt0384793', 'tmdb': '9788', 'tvdb': '9103', 'title': 'Accepted', 'locations': ('Accepted (2006) Remux-1080p.mkv',)} -] - - -def test_simple_cleanup_watched(): - user_watched_list_1 = { - "user1": { - "TV Shows": tv_shows_watched_list_1, - "Movies": movies_watched_list_1, - "Other Shows": tv_shows_2_watched_list_1 - }, - } - user_watched_list_2 = { - "user1": { - "TV Shows": tv_shows_watched_list_2, - "Movies": movies_watched_list_2, - "Other Shows": tv_shows_2_watched_list_1 - } - } - - expected_watched_list_1 = { - "user1": { - "TV Shows": expected_tv_show_watched_list_1 - , "Movies": expected_movie_watched_list_1 - } - } - - expected_watched_list_2 = { - "user1": { - "TV Shows": expected_tv_show_watched_list_2 - , "Movies": expected_movie_watched_list_2 - } - } - - return_watched_list_1 = cleanup_watched(user_watched_list_1, user_watched_list_2) - return_watched_list_2 = cleanup_watched(user_watched_list_2, user_watched_list_1) - - assert return_watched_list_1 == expected_watched_list_1 - assert return_watched_list_2 == expected_watched_list_2 - - -def test_mapping_cleanup_watched(): - user_watched_list_1 = { - "user1": { - "TV Shows": tv_shows_watched_list_1, - "Movies": movies_watched_list_1, - "Other Shows": tv_shows_2_watched_list_1 - }, - } - user_watched_list_2 = { - "user2": { - "Shows": tv_shows_watched_list_2, - "Movies": movies_watched_list_2, - "Other Shows": tv_shows_2_watched_list_1 - } - } - - expected_watched_list_1 = { - "user1": { - "TV Shows": expected_tv_show_watched_list_1 - , "Movies": expected_movie_watched_list_1 - } - } - - expected_watched_list_2 = { - "user2": { - "Shows": expected_tv_show_watched_list_2 - , "Movies": expected_movie_watched_list_2 - } - } - - user_mapping = { "user1": "user2" } - library_mapping = { "TV Shows": "Shows" } - - return_watched_list_1 = cleanup_watched(user_watched_list_1, user_watched_list_2, user_mapping=user_mapping, library_mapping=library_mapping) - return_watched_list_2 = cleanup_watched(user_watched_list_2, user_watched_list_1, user_mapping=user_mapping, library_mapping=library_mapping) - - assert return_watched_list_1 == expected_watched_list_1 - assert return_watched_list_2 == expected_watched_list_2 +import sys +import os + +# getting the name of the directory +# where the this file is present. +current = os.path.dirname(os.path.realpath(__file__)) + +# Getting the parent directory name +# where the current directory is present. +parent = os.path.dirname(current) + +# adding the parent directory to +# the sys.path. +sys.path.append(parent) + +from src.main import cleanup_watched + +tv_shows_watched_list_1 = { + frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { + "Season 1": [ + {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)}, + {'imdb': 'tt0550487', 'tmdb': '282861', 'tvdb': '300385', 'locations': ('Criminal Minds S01E02 Compulsion WEBDL-720p.mkv',)} + ] + }, + frozenset({("title", "Test"), ("locations", ("Test",))}): { + "Season 1": [ + {'locations': ('Test S01E01.mkv',)}, + {'locations': ('Test S01E02.mkv',)} + ] + } +} + +movies_watched_list_1 = [ + {"imdb":"tt2380307", "tmdb":"354912", 'title': 'Coco', 'locations': ('Coco (2017) Remux-1080p.mkv',)}, + {"tmdbcollection":"448150", "imdb":"tt1431045", "tmdb":"293660", 'title': 'Deadpool', 'locations': ('Deadpool (2016) Remux-1080p.mkv',)}, +] + +tv_shows_watched_list_2 = { + frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { + "Season 1": [ + {'imdb': 'tt0550487', 'tmdb': '282861', 'tvdb': '300385', 'locations': ('Criminal Minds S01E02 Compulsion WEBDL-720p.mkv',)}, + {'imdb': 'tt0550498', 'tmdb': '282865', 'tvdb': '300474', 'locations': ("Criminal Minds S01E03 Won't Get Fooled Again WEBDL-720p.mkv",)} + ] + }, + frozenset({("title", "Test"), ("locations", ("Test",))}): { + "Season 1": [ + {'locations': ('Test S01E02.mkv',)}, + {'locations': ('Test S01E03.mkv',)} + ] + } +} + +movies_watched_list_2 = [ + {"imdb":"tt2380307", "tmdb":"354912", 'title': 'Coco', 'locations': ('Coco (2017) Remux-1080p.mkv',)}, + {'imdb': 'tt0384793', 'tmdb': '9788', 'tvdb': '9103', 'title': 'Accepted', 'locations': ('Accepted (2006) Remux-1080p.mkv',)} +] + +# Test to see if objects get deleted all the way up to the root. +tv_shows_2_watched_list_1 = { + frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { + "Season 1": [ + {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)}, + ] + } +} + +expected_tv_show_watched_list_1 = { + frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { + "Season 1": [ + {'imdb': 'tt0550489', 'tmdb': '282843', 'tvdb': '176357', 'locations': ('Criminal Minds S01E01 Extreme Aggressor WEBDL-720p.mkv',)} + ] + }, + frozenset({("title", "Test"), ("locations", ("Test",))}): { + "Season 1": [ + {'locations': ('Test S01E01.mkv',)} + ] + } +} + +expected_movie_watched_list_1 = [ + {"tmdbcollection":"448150", "imdb":"tt1431045", "tmdb":"293660", 'title': 'Deadpool', 'locations': ('Deadpool (2016) Remux-1080p.mkv',)} +] + +expected_tv_show_watched_list_2 = { + frozenset({("tvdb", "75710"), ("title", "Criminal Minds"), ("imdb", "tt0452046"), ("locations", ("Criminal Minds",)), ("tmdb", "4057")}): { + "Season 1": [ + {'imdb': 'tt0550498', 'tmdb': '282865', 'tvdb': '300474', 'locations': ("Criminal Minds S01E03 Won't Get Fooled Again WEBDL-720p.mkv",)} + ] + }, + frozenset({("title", "Test"), ("locations", ("Test",))}): { + "Season 1": [ + {'locations': ('Test S01E03.mkv',)} + ] + } +} + +expected_movie_watched_list_2 = [ + {'imdb': 'tt0384793', 'tmdb': '9788', 'tvdb': '9103', 'title': 'Accepted', 'locations': ('Accepted (2006) Remux-1080p.mkv',)} +] + + +def test_simple_cleanup_watched(): + user_watched_list_1 = { + "user1": { + "TV Shows": tv_shows_watched_list_1, + "Movies": movies_watched_list_1, + "Other Shows": tv_shows_2_watched_list_1 + }, + } + user_watched_list_2 = { + "user1": { + "TV Shows": tv_shows_watched_list_2, + "Movies": movies_watched_list_2, + "Other Shows": tv_shows_2_watched_list_1 + } + } + + expected_watched_list_1 = { + "user1": { + "TV Shows": expected_tv_show_watched_list_1 + , "Movies": expected_movie_watched_list_1 + } + } + + expected_watched_list_2 = { + "user1": { + "TV Shows": expected_tv_show_watched_list_2 + , "Movies": expected_movie_watched_list_2 + } + } + + return_watched_list_1 = cleanup_watched(user_watched_list_1, user_watched_list_2) + return_watched_list_2 = cleanup_watched(user_watched_list_2, user_watched_list_1) + + assert return_watched_list_1 == expected_watched_list_1 + assert return_watched_list_2 == expected_watched_list_2 + + +def test_mapping_cleanup_watched(): + user_watched_list_1 = { + "user1": { + "TV Shows": tv_shows_watched_list_1, + "Movies": movies_watched_list_1, + "Other Shows": tv_shows_2_watched_list_1 + }, + } + user_watched_list_2 = { + "user2": { + "Shows": tv_shows_watched_list_2, + "Movies": movies_watched_list_2, + "Other Shows": tv_shows_2_watched_list_1 + } + } + + expected_watched_list_1 = { + "user1": { + "TV Shows": expected_tv_show_watched_list_1 + , "Movies": expected_movie_watched_list_1 + } + } + + expected_watched_list_2 = { + "user2": { + "Shows": expected_tv_show_watched_list_2 + , "Movies": expected_movie_watched_list_2 + } + } + + user_mapping = { "user1": "user2" } + library_mapping = { "TV Shows": "Shows" } + + return_watched_list_1 = cleanup_watched(user_watched_list_1, user_watched_list_2, user_mapping=user_mapping, library_mapping=library_mapping) + return_watched_list_2 = cleanup_watched(user_watched_list_2, user_watched_list_1, user_mapping=user_mapping, library_mapping=library_mapping) + + assert return_watched_list_1 == expected_watched_list_1 + assert return_watched_list_2 == expected_watched_list_2 From 827ace2e97a8ecf3905bdcd1efbfdcba60332d8b Mon Sep 17 00:00:00 2001 From: Luigi311 Date: Wed, 17 Aug 2022 21:20:28 -0600 Subject: [PATCH 3/4] cleanup --- src/functions.py | 8 +++++--- src/main.py | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/functions.py b/src/functions.py index 64718d8..fc41163 100644 --- a/src/functions.py +++ b/src/functions.py @@ -19,6 +19,8 @@ def logger(message: str, log_type=0): output = f"[ERROR]: {output}" elif log_type == 3 and (debug and debug_level == "debug"): output = f"[DEBUG]: {output}" + elif log_type == 4: + output = f"[WARNING]: {output}" else: output = None @@ -101,7 +103,7 @@ def generate_library_guids_dict(user_list: dict): else: show_output_dict[provider_key.lower()].append(provider_value.lower()) except: - pass + logger(f"Generating show_output_dict failed, skipping", 1) try: for show in user_list: @@ -116,7 +118,7 @@ def generate_library_guids_dict(user_list: dict): else: episode_output_dict[episode_key.lower()].append(episode_value.lower()) except: - pass + logger(f"Generating episode_output_dict failed, skipping", 1) try: for movie in user_list: @@ -129,7 +131,7 @@ def generate_library_guids_dict(user_list: dict): else: movies_output_dict[movie_key.lower()].append(movie_value.lower()) except: - pass + logger(f"Generating movies_output_dict failed, skipping", 1) return show_output_dict, episode_output_dict, movies_output_dict diff --git a/src/main.py b/src/main.py index fbbf6e4..5c4372f 100644 --- a/src/main.py +++ b/src/main.py @@ -396,9 +396,9 @@ def main_loop(): logger("Creating watched lists", 1) server_1_watched = server_1_connection.get_watched(server_1_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping) - logger("Finished creating watched list server 1", 0) + logger("Finished creating watched list server 1", 1) server_2_watched = asyncio.run(server_2_connection.get_watched(server_2_users, blacklist_library, whitelist_library, blacklist_library_type, whitelist_library_type, library_mapping)) - logger("Finished creating watched list server 2", 0) + logger("Finished creating watched list server 2", 1) logger(f"Server 1 watched: {server_1_watched}", 3) logger(f"Server 2 watched: {server_2_watched}", 3) From 942ec3533f73b84bc0f3b604f3c3c16c350e2d6f Mon Sep 17 00:00:00 2001 From: Luigi311 Date: Wed, 17 Aug 2022 21:43:51 -0600 Subject: [PATCH 4/4] Cleanup log file on runs --- src/main.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main.py b/src/main.py index 5c4372f..fa5abca 100644 --- a/src/main.py +++ b/src/main.py @@ -348,8 +348,8 @@ def generate_server_connections(): def main_loop(): logfile = os.getenv("LOGFILE","log.log") # Delete logfile if it exists - #if os.path.exists(logfile): - # os.remove(logfile) + if os.path.exists(logfile): + os.remove(logfile) dryrun = str_to_bool(os.getenv("DRYRUN", "False")) logger(f"Dryrun: {dryrun}", 1)