diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..8f266283 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,11 @@ +.git +.github +.gitignore +contrib +init-scripts +package +pylintrc +snap +*.md +!CHANGELOG*.md +start.bat diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..79319ae1 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +github: JonnyWong16 +patreon: Tautulli +custom: ["https://bit.ly/2InPp15", "https://bit.ly/2WTq83m"] \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 00000000..34f617df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,103 @@ +name: Bug Report +description: Please do not use bug reports for support issues. +labels: ['status:awaiting-triage', 'type:bug'] +body: + - type: markdown + attributes: + value: | + **THIS IS NOT THE PLACE TO ASK FOR SUPPORT!** Please use [Discord](https://tautulli.com/discord) for support issues. + - type: textarea + id: description + attributes: + label: Describe the Bug + description: A clear and concise description of the bug. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: List each action required in order to reproduce the issue. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Provide screenshots to help explain your problem. + - type: textarea + id: relevant + attributes: + label: Relevant Settings + description: Include all settings/configuration that are relevant to your issue. For example, Plex Media Server, newsletter, or notification settings. + placeholder: | + - eg. Plex Media Server IP address/port/checkboxes/proxy/etc. + - eg. Notification agent configuration/triggers/conditions/text/delay/grouping/etc. + - eg. Newsletter agent configuration/checkboxes/template/etc. + - Other settings + - type: input + id: version + attributes: + label: Tautulli Version + description: Check Tautulli Settings > Help & Info page. + placeholder: eg. v2.7.5 + validations: + required: true + - type: input + id: branch + attributes: + label: Git Branch + description: Check Tautulli Settings > Help & Info page. + placeholder: eg. master + validations: + required: true + - type: input + id: hash + attributes: + label: Git Commit Hash + description: Check Tautulli Settings > Help & Info page. + placeholder: eg. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c + validations: + required: true + - type: input + id: platform + attributes: + label: Platform and Version + description: Check Tautulli Settings > Help & Info page. + placeholder: eg. Windows 10 + validations: + required: true + - type: input + id: python + attributes: + label: Python Version + description: Check Tautulli Settings > Help & Info page. + placeholder: eg. 3.8.10 + validations: + required: true + - type: input + id: browser + attributes: + label: Browser and Version + placeholder: eg. Chrome 88 + validations: + required: true + - type: input + id: logs + attributes: + label: Link to Logs + description: Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com). + validations: + required: true + - type: markdown + attributes: + value: | + Make sure to close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 00000000..70e2ab33 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest a new feature for Tautulli. +labels: ['status:awaiting-triage', 'type:enhancement'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to help improve Tautulli! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: If so, please provide clear and concise description of the problem. + placeholder: eg. I'm always frustrated when '...' + - type: textarea + id: feature + attributes: + label: What is your feature request? + description: A clear and concise description of the feature. + validations: + required: true + - type: textarea + id: workaround + attributes: + label: Are there any workarounds? + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..16aef760 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Tautulli Wiki + url: https://github.com/Tautulli/Tautulli/wiki + about: Please check the wiki to see if your question has already been answered. + - name: Discord + url: https://tautulli.com/discord + about: Please use Discord to ask for support. diff --git a/.github/codeql-config.yml b/.github/codeql-config.yml new file mode 100644 index 00000000..574f9b33 --- /dev/null +++ b/.github/codeql-config.yml @@ -0,0 +1,4 @@ +name: CodeQL Config + +paths-ignore: + - lib diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..1028cc5a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + target-branch: "nightly" + open-pull-requests-limit: 20 + + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" + target-branch: "nightly" + open-pull-requests-limit: 20 diff --git a/.github/label-actions.yml b/.github/label-actions.yml new file mode 100644 index 00000000..ae236e9a --- /dev/null +++ b/.github/label-actions.yml @@ -0,0 +1,48 @@ +# Configuration for Label Actions - https://github.com/dessant/label-actions + +added: + comment: > + This feature has been added and will be available in the next release of Tautulli. + This issue will be automatically closed once the update is available. + +fixed: + comment: > + This bug has been fixed and will be available in the next release of Tautulli. + This issue will be automatically closed once the update is available. + +invalid:duplicate: + comment: > + :wave: @{issue-author}, this appears to be a duplicate of a pre-existing issue. + close: true + lock: true + unlabel: 'status:awaiting-triage' + +-invalid:duplicate: + reopen: true + unlock: true + +invalid:support: + comment: > + :wave: @{issue-author}, we use the issue tracker exclusively for bug reports. + However, this issue appears to be a support request. Please use our + [Discord Server](https://tautulli.com/discord) to get help with Tautulli. Thanks. + close: true + lock: true + lock-reason: 'off-topic' + unlabel: 'status:awaiting-triage' + +-invalid:support: + reopen: true + unlock: true + +invalid:template-incomplete: + issues: + comment: > + :wave: @{issue-author}, please edit your issue to complete the template with + all the required info. Your issue will be automatically closed in 5 days if + the template is not completed. Thanks. + prs: + comment: > + :wave: @{issue-author}, please edit your PR to complete the template with + all the required info. Your PR will be automatically closed in 5 days if + the template is not completed. Thanks. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..63ab24be --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +## Description + +Please include a summary of the changes. + +### Screenshot + +Include screenshots if the changes are UI-related. + +### Issues Fixed or Closed + +- Fixes #(issue) + +## Type of Change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added or updated the docstring for new or existing methods diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 00000000..e9c8e05d --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,38 @@ +name: CodeQL + +on: + push: + branches: [nightly] + pull_request: + branches: [nightly] + schedule: + - cron: '05 10 * * 1' + +jobs: + codeql-analysis: + name: CodeQL Analysis + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: ['javascript', 'python'] + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + config-file: ./.github/codeql-config.yml + languages: ${{ matrix.language }} + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/issues-stale.yml b/.github/workflows/issues-stale.yml new file mode 100644 index 00000000..b805e266 --- /dev/null +++ b/.github/workflows/issues-stale.yml @@ -0,0 +1,48 @@ +name: Stale Issues / PRs + +on: + schedule: + - cron: '00 19 * * *' + +jobs: + stale: + name: Check Issues / PRs + runs-on: ubuntu-latest + steps: + - name: Stale + uses: actions/stale@v9 + with: + stale-issue-message: > + This issue is stale because it has been open for 30 days with no activity. + Remove the stale label or comment, otherwise this will be closed in 5 days. + close-issue-message: > + This issue was closed because it has been stalled for 5 days with no activity. + stale-issue-label: 'stale' + exempt-issue-labels: 'added,fixed,type:enhancement,status:awaiting-triage,status:in-progress' + stale-pr-message: > + This PR is stale because it has been open for 30 days with no activity. + Remove the stale label or comment, otherwise this will be closed in 5 days. + close-pr-message: > + This PR was closed because it has been stalled for 5 days with no activity. + stale-pr-label: 'stale' + exempt-pr-labels: 'status:in-progress,status:in-review,dependencies' + days-before-stale: 30 + days-before-close: 5 + + - name: Invalid Template + uses: actions/stale@v9 + with: + stale-issue-message: > + Invalid issues template. + close-issue-message: > + This issue was closed because the the template was not completed after 5 days. + stale-issue-label: 'invalid:template-incomplete' + stale-pr-message: > + Invalid PR template. + close-pr-message: > + This PR was closed because the the template was not completed after 5 days. + stale-pr-label: 'invalid:template-incomplete' + exempt-pr-labels: 'status:in-progress,status:in-review,dependencies' + only-labels: 'invalid:template-incomplete' + days-before-stale: 0 + days-before-close: 5 diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml new file mode 100644 index 00000000..a60987f5 --- /dev/null +++ b/.github/workflows/issues.yml @@ -0,0 +1,15 @@ +name: Issues + +on: + issues: + types: [labeled, unlabeled] + +jobs: + label: + name: Label Issues + runs-on: ubuntu-latest + steps: + - name: Label Issues + uses: dessant/label-actions@v4 + with: + github-token: ${{ github.token }} diff --git a/.github/workflows/publish-docker.yml b/.github/workflows/publish-docker.yml new file mode 100644 index 00000000..62c3f86c --- /dev/null +++ b/.github/workflows/publish-docker.yml @@ -0,0 +1,108 @@ +name: Publish Docker + +on: + workflow_dispatch: ~ + push: + branches: [master, beta, nightly] + tags: [v*] + +jobs: + build-docker: + name: Build Docker Image + runs-on: ubuntu-latest + if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }} + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Prepare + id: prepare + run: | + if [[ $GITHUB_REF == refs/tags/* ]]; then + echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT + elif [[ $GITHUB_REF == refs/heads/master ]]; then + echo "tag=latest" >> $GITHUB_OUTPUT + else + echo "tag=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT + fi + if [[ $GITHUB_REF == refs/tags/*-beta ]]; then + echo "branch=beta" >> $GITHUB_OUTPUT + elif [[ $GITHUB_REF == refs/tags/* ]]; then + echo "branch=master" >> $GITHUB_OUTPUT + else + echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT + fi + echo "commit=${GITHUB_SHA}" >> $GITHUB_OUTPUT + echo "docker_platforms=linux/amd64,linux/arm64/v8,linux/arm/v7,linux/arm/v6" >> $GITHUB_OUTPUT + echo "docker_image=${{ secrets.DOCKER_REPO }}/tautulli" >> $GITHUB_OUTPUT + + - name: Set Up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + id: buildx + with: + version: latest + + - name: Cache Docker Layers + uses: actions/cache@v4 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }} + restore-keys: | + ${{ runner.os }}-buildx- + + - name: Login to DockerHub + uses: docker/login-action@v3 + if: success() + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_TOKEN }} + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + if: success() + with: + registry: ghcr.io + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.GHCR_TOKEN }} + + - name: Extract Docker Metadata + id: metadata + uses: docker/metadata-action@v5 + with: + images: ${{ steps.prepare.outputs.docker_image }} + + - name: Docker Build and Push + uses: docker/build-push-action@v6 + if: success() + with: + context: . + file: ./Dockerfile + push: true + platforms: ${{ steps.prepare.outputs.docker_platforms }} + build-args: | + TAG=${{ steps.prepare.outputs.tag }} + BRANCH=${{ steps.prepare.outputs.branch }} + COMMIT=${{ steps.prepare.outputs.commit }} + tags: | + ${{ steps.prepare.outputs.docker_image }}:${{ steps.prepare.outputs.tag }} + ghcr.io/${{ steps.prepare.outputs.docker_image }}:${{ steps.prepare.outputs.tag }} + labels: ${{ steps.metadata.outputs.labels }} + cache-from: type=local,src=/tmp/.buildx-cache + cache-to: type=local,dest=/tmp/.buildx-cache + + discord: + name: Discord Notification + needs: build-docker + if: always() && !contains(github.event.head_commit.message, '[skip ci]') + runs-on: ubuntu-latest + steps: + - name: Post Status to Discord + uses: sarisia/actions-status-discord@v1 + with: + webhook: ${{ secrets.DISCORD_WEBHOOK }} + status: ${{ needs.build-docker.result == 'success' && 'success' || contains(needs.*.result, 'failure') && 'failure' || 'cancelled' }} + title: ${{ github.workflow }} + nofail: true diff --git a/.github/workflows/publish-installers.yml b/.github/workflows/publish-installers.yml new file mode 100644 index 00000000..b4a66960 --- /dev/null +++ b/.github/workflows/publish-installers.yml @@ -0,0 +1,178 @@ +name: Publish Installers + +on: + workflow_dispatch: ~ + push: + branches: [master, beta, nightly] + tags: [v*] + +env: + PYTHON_VERSION: '3.11' + +jobs: + build-installer: + name: Build ${{ matrix.os_upper }} Installer + runs-on: ${{ matrix.os }}-${{ matrix.os_version }} + if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }} + strategy: + fail-fast: false + matrix: + include: + - os: 'windows' + os_upper: 'Windows' + os_version: 'latest' + arch: 'x64' + ext: 'exe' + - os: 'macos' + os_upper: 'MacOS' + os_version: '14' + arch: 'universal' + ext: 'pkg' + + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Set Release Version + id: get_version + shell: bash + run: | + if [[ $GITHUB_REF == refs/tags/* ]]; then + echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV + VERSION_NSIS=${GITHUB_REF#refs/tags/v}.1 + echo "VERSION_NSIS=${VERSION_NSIS/%-beta.1/.0}" >> $GITHUB_OUTPUT + echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT + echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT + else + echo "VERSION=0.0.0" >> $GITHUB_ENV + echo "VERSION_NSIS=0.0.0.0" >> $GITHUB_OUTPUT + echo "VERSION=0.0.0" >> $GITHUB_OUTPUT + echo "RELEASE_VERSION=${GITHUB_SHA::7}" >> $GITHUB_OUTPUT + fi + if [[ $GITHUB_REF == refs/tags/*-beta ]]; then + echo "beta" > branch.txt + elif [[ $GITHUB_REF == refs/tags/* ]]; then + echo "master" > branch.txt + else + echo ${GITHUB_REF#refs/heads/} > branch.txt + fi + echo $GITHUB_SHA > version.txt + + - name: Set Up Python + uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + cache: pip + cache-dependency-path: '**/requirements*.txt' + + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install -r package/requirements-package.txt --no-binary cffi + + - name: Build Package + run: | + pyinstaller -y ./package/Tautulli-${{ matrix.os }}.spec + + - name: Create Windows Installer + uses: joncloud/makensis-action@v4.1 + if: matrix.os == 'windows' + with: + script-file: ./package/Tautulli.nsi + arguments: > + /DVERSION=${{ steps.get_version.outputs.VERSION_NSIS }} + /DINSTALLER_NAME=..\Tautulli-${{ matrix.os }}-${{ steps.get_version.outputs.RELEASE_VERSION }}-${{ matrix.arch }}.${{ matrix.ext }} + additional-plugin-paths: package/nsis-plugins + + - name: Create MacOS Installer + if: matrix.os == 'macos' + run: | + sudo pkgbuild \ + --install-location /Applications \ + --version ${{ steps.get_version.outputs.VERSION }} \ + --component ./dist/Tautulli.app \ + --scripts ./package/macos-scripts \ + Tautulli-${{ matrix.os }}-${{ steps.get_version.outputs.RELEASE_VERSION }}-${{ matrix.arch }}.${{ matrix.ext }} + + - name: Upload Installer + uses: actions/upload-artifact@v4 + with: + name: Tautulli-${{ matrix.os }}-installer + path: Tautulli-${{ matrix.os }}-${{ steps.get_version.outputs.RELEASE_VERSION }}-${{ matrix.arch }}.${{ matrix.ext }} + + virus-total: + name: VirusTotal Scan + needs: build-installer + if: needs.build-installer.result == 'success' && !contains(github.event.head_commit.message, '[skip ci]') + runs-on: ubuntu-latest + steps: + - name: Download Installers + if: needs.build-installer.result == 'success' + uses: actions/download-artifact@v4 + + - name: Upload to VirusTotal + uses: crazy-max/ghaction-virustotal@v4 + with: + vt_api_key: ${{ secrets.VT_API_KEY }} + files: | + Tautulli-windows-installer/Tautulli-windows-*-x64.exe + Tautulli-macos-installer/Tautulli-macos-*-universal.pkg + + release: + name: Release Installers + needs: build-installer + if: always() && startsWith(github.ref, 'refs/tags/') && !contains(github.event.head_commit.message, '[skip ci]') + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Set Release Version + id: get_version + run: | + echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT + + - name: Download Installers + if: needs.build-installer.result == 'success' + uses: actions/download-artifact@v4 + + - name: Get Changelog + id: get_changelog + run: | + CHANGELOG="$( sed -n '/^## /{p; :loop n; p; /^## /q; b loop}' CHANGELOG.md \ + | sed '$d' | sed '$d' | sed '$d' )" + EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) + echo "CHANGELOG<<$EOF" >> $GITHUB_OUTPUT + echo "$CHANGELOG" >> $GITHUB_OUTPUT + echo "$EOF" >> $GITHUB_OUTPUT + + - name: Create Release + uses: softprops/action-gh-release@v2 + id: create_release + env: + GITHUB_TOKEN: ${{ secrets.GHACTIONS_TOKEN }} + with: + tag_name: ${{ steps.get_version.outputs.RELEASE_VERSION }} + name: Tautulli ${{ steps.get_version.outputs.RELEASE_VERSION }} + body: | + ## Changelog + + ##${{ steps.get_changelog.outputs.CHANGELOG }} + prerelease: ${{ endsWith(steps.get_version.outputs.RELEASE_VERSION, '-beta') }} + files: | + Tautulli-windows-installer/Tautulli-windows-${{ steps.get_version.outputs.RELEASE_VERSION }}-x64.exe + Tautulli-macos-installer/Tautulli-macos-${{ steps.get_version.outputs.RELEASE_VERSION }}-universal.pkg + + discord: + name: Discord Notification + needs: [build-installer, release] + if: always() && !contains(github.event.head_commit.message, '[skip ci]') + runs-on: ubuntu-latest + steps: + - name: Post Status to Discord + uses: sarisia/actions-status-discord@v1 + with: + webhook: ${{ secrets.DISCORD_WEBHOOK }} + status: ${{ needs.build-installer.result == 'success' && 'success' || contains(needs.*.result, 'failure') && 'failure' || 'cancelled' }} + title: ${{ github.workflow }} + nofail: true diff --git a/.github/workflows/publish-snap.yml b/.github/workflows/publish-snap.yml new file mode 100644 index 00000000..b3898a38 --- /dev/null +++ b/.github/workflows/publish-snap.yml @@ -0,0 +1,78 @@ +name: Publish Snap + +on: + workflow_dispatch: ~ + push: + branches: [master, beta, nightly] + tags: [v*] + +jobs: + build-snap: + name: Build Snap Package (${{ matrix.architecture }}) + runs-on: ubuntu-latest + if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }} + strategy: + fail-fast: false + matrix: + architecture: + - amd64 + - arm64 + - armhf + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Prepare + id: prepare + run: | + git fetch --prune --unshallow --tags + if [[ $GITHUB_REF == refs/tags/*-beta || $GITHUB_REF == refs/heads/beta ]]; then + echo "RELEASE=beta" >> $GITHUB_OUTPUT + elif [[ $GITHUB_REF == refs/tags/* || $GITHUB_REF == refs/heads/master ]]; then + echo "RELEASE=stable" >> $GITHUB_OUTPUT + else + echo "RELEASE=edge" >> $GITHUB_OUTPUT + fi + + - name: Set Up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Build Snap Package + uses: diddlesnaps/snapcraft-multiarch-action@master + id: build + with: + architecture: ${{ matrix.architecture }} + + - name: Upload Snap Package + uses: actions/upload-artifact@v4 + with: + name: Tautulli-snap-package-${{ matrix.architecture }} + path: ${{ steps.build.outputs.snap }} + + - name: Review Snap Package + uses: diddlesnaps/snapcraft-review-tools-action@master + with: + snap: ${{ steps.build.outputs.snap }} + + - name: Publish Snap Package + uses: snapcore/action-publish@v1 + if: startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/nightly' + env: + SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAP_LOGIN }} + with: + snap: ${{ steps.build.outputs.snap }} + release: ${{ steps.prepare.outputs.RELEASE }} + + discord: + name: Discord Notification + needs: build-snap + if: always() && !contains(github.event.head_commit.message, '[skip ci]') + runs-on: ubuntu-latest + steps: + - name: Post Status to Discord + uses: sarisia/actions-status-discord@v1 + with: + webhook: ${{ secrets.DISCORD_WEBHOOK }} + status: ${{ needs.build-snap.result == 'success' && 'success' || contains(needs.*.result, 'failure') && 'failure' || 'cancelled' }} + title: ${{ github.workflow }} + nofail: true diff --git a/.github/workflows/pull-requests.yml b/.github/workflows/pull-requests.yml new file mode 100644 index 00000000..ac550fe2 --- /dev/null +++ b/.github/workflows/pull-requests.yml @@ -0,0 +1,27 @@ +name: Pull Requests + +on: + pull_request_target: + types: [opened, synchronize, edited, reopened] + +jobs: + check-branch: + name: Check Pull Request + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Comment on Pull Request + uses: mshick/add-pr-comment@v2 + if: github.base_ref != 'nightly' + with: + message: Pull requests must be made to the `nightly` branch. Thanks. + repo-token: ${{ secrets.GITHUB_TOKEN }} + + - name: Fail Workflow + if: github.base_ref != 'nightly' + run: | + echo Base: "$GITHUB_BASE_REF" + echo Head: "$GITHUB_HEAD_REF" + exit 1 diff --git a/.github/workflows/submit-winget.yml b/.github/workflows/submit-winget.yml new file mode 100644 index 00000000..efa6cee7 --- /dev/null +++ b/.github/workflows/submit-winget.yml @@ -0,0 +1,44 @@ +name: Submit winget + +on: + workflow_dispatch: ~ + release: + types: [published] + +jobs: + winget: + name: Submit Winget Package + runs-on: windows-latest + if: ${{ !github.event.release.prerelease }} + steps: + - name: Sync Winget Fork + run: gh repo sync ${{ secrets.WINGET_USERNAME }}/winget-pkgs -b master + env: + GH_TOKEN: ${{ secrets.WINGET_TOKEN }} + + - name: Submit package to Windows Package Manager Community Repository + run: | + $wingetPackage = "Tautulli.Tautulli" + $gitToken = "${{ secrets.WINGET_TOKEN }}" + + $github = Invoke-RestMethod -uri "https://api.github.com/repos/Tautulli/Tautulli/releases/latest" + $installerUrl = $github | Select -ExpandProperty assets -First 1 | Where-Object -Property name -match "Tautulli-windows-.*-x64.exe" | Select -ExpandProperty browser_download_url + $version = "$($github.tag_name.Trim('v')).1" + + # getting latest wingetcreate file + iwr https://aka.ms/wingetcreate/latest -OutFile wingetcreate.exe + .\wingetcreate.exe update $wingetPackage -s -v $version -u $installerUrl -t $gitToken + + virus-total: + name: VirusTotal Scan + runs-on: ubuntu-latest + steps: + - name: Upload to VirusTotal + uses: crazy-max/ghaction-virustotal@v4 + with: + vt_api_key: ${{ secrets.VT_API_KEY }} + github_token: ${{ secrets.GHACTIONS_TOKEN }} + update_release_body: true + files: | + .exe$ + .pkg$ diff --git a/.gitignore b/.gitignore index 93f0cb0b..1e54132b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # Compiled source # ################### +__pycache__ *.pyc *.py~ *.pyproj @@ -12,10 +13,24 @@ *.db* *.db-journal *.ini +release.lock version.lock +lib/*.dist-info +lib/*.egg-info +lib/*.pth +lib/*/*.pyd +lib/_distutils_hack +lib/pkg_resources +lib/setuptools logs/* +backups/* cache/* +exports/* +newsletters/* *.mmdb +version.txt +branch.txt +.TEST # HTTPS Cert/Key # ################## @@ -38,6 +53,9 @@ Thumbs.db #Ignore files generated by PyCharm *.idea/* +#Ignore files generated by VSCode +*.vscode/* + #Ignore files generated by vi *.swp @@ -58,7 +76,6 @@ Thumbs.db *.bak *.cache *.ilk -*.log [Bb]in [Dd]ebug*/ *.lib @@ -71,3 +88,16 @@ _ReSharper*/ /logs .project .pydevproject + +#Ignore files generated by pyinstaller +/build +/dist + +#snapcraft specifics +/parts/ +/stage/ +/prime/ +*.snap +.snapcraft +*_source.tar.bz2 +snap/.snapcraft \ No newline at end of file diff --git a/API.md b/API.md index c07b6b51..827c7c6b 100644 --- a/API.md +++ b/API.md @@ -1,1958 +1,3 @@ # API Reference -The API is still pretty new and needs some serious cleaning up on the backend but should be reasonably functional. There are no error codes yet. - -## General structure -The API endpoint is `http://ip:port + HTTP_ROOT + /api/v2?apikey=$apikey&cmd=$command` - -Response example (default `json`) -``` -{ - "response": { - "data": [ - { - "loglevel": "INFO", - "msg": "Signal 2 caught, saving and exiting...", - "thread": "MainThread", - "time": "22-sep-2015 01:42:56 " - } - ], - "message": null, - "result": "success" - } -} -``` -``` -General optional parameters: - - out_type: "json" or "xml" - callback: "pong" - debug: 1 -``` - -## API methods - -### arnold -Get to the chopper! - - -### backup_config -Create a manual backup of the `config.ini` file. - - -### backup_db -Create a manual backup of the `plexpy.db` file. - - -### delete_all_library_history -Delete all PlexPy history for a specific library. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - None -``` - - -### delete_all_user_history -Delete all PlexPy history for a specific user. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - None - -Returns: - None -``` - - -### delete_cache -Delete and recreate the cache directory. - - -### delete_datatable_media_info_cache -Delete the media info table cache for a specific library. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - None -``` - - -### delete_image_cache -Delete and recreate the image cache directory. - - -### delete_library -Delete a library section from PlexPy. Also erases all history for the library. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - None -``` - - -### delete_login_log -Delete the PlexPy login logs. - -``` -Required paramters: - None - -Optional parameters: - None - -Returns: - None -``` - - -### delete_notification_log -Delete the PlexPy notification logs. - -``` -Required paramters: - None - -Optional parameters: - None - -Returns: - None -``` - - -### delete_temp_sessions -Flush out all of the temporary sessions in the database. - - -### delete_user -Delete a user from PlexPy. Also erases all history for the user. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - None - -Returns: - None -``` - - -### docs -Return the api docs as a dict where commands are keys, docstring are value. - - -### docs_md -Return the api docs formatted with markdown. - - -### download_log -Download the PlexPy log file. - - -### download_plex_log -Download the Plex log file. - - -### edit_library -Update a library section on PlexPy. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - custom_thumb (str): The URL for the custom library thumbnail - do_notify (int): 0 or 1 - do_notify_created (int): 0 or 1 - keep_history (int): 0 or 1 - -Returns: - None -``` - - -### edit_user -Update a user on PlexPy. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional paramters: - friendly_name(str): The friendly name of the user - custom_thumb (str): The URL for the custom user thumbnail - do_notify (int): 0 or 1 - do_notify_created (int): 0 or 1 - keep_history (int): 0 or 1 - -Returns: - None -``` - - -### get_activity -Get the current activity on the PMS. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - {"stream_count": 3, - "session": - [{"art": "/library/metadata/1219/art/1462175063", - "aspect_ratio": "1.78", - "audio_channels": "6", - "audio_codec": "ac3", - "audio_decision": "transcode", - "bif_thumb": "/library/parts/274169/indexes/sd/", - "bitrate": "10617", - "container": "mkv", - "content_rating": "TV-MA", - "duration": "2998290", - "friendly_name": "Mother of Dragons", - "grandparent_rating_key": "1219", - "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", - "grandparent_title": "Game of Thrones", - "height": "1078", - "indexes": 1, - "ip_address": "xxx.xxx.xxx.xxx", - "labels": [], - "machine_id": "83f189w617623ccs6a1lqpby", - "media_index": "1", - "media_type": "episode", - "parent_media_index": "6", - "parent_rating_key": "153036", - "parent_thumb": "/library/metadata/153036/thumb/1462175062", - "parent_title": "", - "platform": "Chrome", - "player": "Plex Web (Chrome)", - "progress_percent": "0", - "rating_key": "153037", - "section_id": "2", - "session_key": "291", - "state": "playing", - "throttled": "1", - "thumb": "/library/metadata/153037/thumb/1462175060", - "title": "The Red Woman", - "transcode_audio_channels": "2", - "transcode_audio_codec": "aac", - "transcode_container": "mkv", - "transcode_height": "1078", - "transcode_key": "tiv5p524wcupe8nxegc26s9k9", - "transcode_progress": 2, - "transcode_protocol": "http", - "transcode_speed": "0.0", - "transcode_video_codec": "h264", - "transcode_width": "1920", - "user": "DanyKhaleesi69", - "user_id": 8008135, - "user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar", - "video_codec": "h264", - "video_decision": "copy", - "video_framerate": "24p", - "video_resolution": "1080", - "view_offset": "", - "width": "1920", - "year": "2016" - }, - {...}, - {...} - ] - } -``` - - -### get_apikey -Get the apikey. Username and password are required -if auth is enabled. Makes and saves the apikey if it does not exist. - -``` -Required parameters: - None - -Optional parameters: - username (str): Your PlexPy username - password (str): Your PlexPy password - -Returns: - string: "apikey" -``` - - -### get_date_formats -Get the date and time formats used by PlexPy. - - ``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - {"date_format": "YYYY-MM-DD", - "time_format": "HH:mm", - } -``` - - -### get_geoip_lookup -Get the geolocation info for an IP address. The GeoLite2 database must be installed. - -``` -Required parameters: - ip_address - -Optional parameters: - None - -Returns: - json: - {"continent": "North America", - "country": "United States", - "region": "California", - "city": "Mountain View", - "postal_code": "94035", - "timezone": "America/Los_Angeles", - "latitude": 37.386, - "longitude": -122.0838, - "accuracy": 1000 - } - json: - {"error": "The address 127.0.0.1 is not in the database." - } -``` - - -### get_history -Get the PlexPy history. - -``` -Required parameters: - None - -Optional parameters: - grouping (int): 0 or 1 - user (str): "Jon Snow" - user_id (int): 133788 - rating_key (int): 4348 - parent_rating_key (int): 544 - grandparent_rating_key (int): 351 - start_date (str): "YYYY-MM-DD" - section_id (int): 2 - media_type (str): "movie", "episode", "track" - transcode_decision (str): "direct play", "copy", "transcode", - order_column (str): "date", "friendly_name", "ip_address", "platform", "player", - "full_title", "started", "paused_counter", "stopped", "duration" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "Thrones" - -Returns: - json: - {"draw": 1, - "recordsTotal": 1000, - "recordsFiltered": 250, - "total_duration": "42 days 5 hrs 18 mins", - "filter_duration": "10 hrs 12 mins", - "data": - [{"year": 2016, - "paused_counter": 0, - "player": "Plex Web (Chrome)", - "parent_rating_key": 544, - "parent_title": "", - "duration": 263, - "transcode_decision": "transcode", - "rating_key": 4348, - "user_id": 8008135, - "thumb": "/library/metadata/4348/thumb/1462414561", - "id": 1124, - "platform": "Chrome", - "media_type": "episode", - "grandparent_rating_key": 351, - "started": 1462688107, - "full_title": "Game of Thrones - The Red Woman", - "reference_id": 1123, - "date": 1462687607, - "percent_complete": 84, - "ip_address": "xxx.xxx.xxx.xxx", - "group_ids": "1124", - "media_index": 17, - "friendly_name": "Mother of Dragons", - "watched_status": 0, - "group_count": 1, - "stopped": 1462688370, - "parent_media_index": 7, - "user": "DanyKhaleesi69" - }, - {...}, - {...} - ] - } -``` - - -### get_home_stats -Get the homepage watch statistics. - -``` -Required parameters: - None - -Optional parameters: - grouping (int): 0 or 1 - time_range (str): The time range to calculate statistics, '30' - stats_type (int): 0 for plays, 1 for duration - stats_count (str): The number of top items to list, '5' - -Returns: - json: - [{"stat_id": "top_movies", - "stat_type": "total_plays", - "rows": [{...}] - }, - {"stat_id": "popular_movies", - "rows": [{...}] - }, - {"stat_id": "top_tv", - "stat_type": "total_plays", - "rows": - [{"content_rating": "TV-MA", - "friendly_name": "", - "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", - "labels": [], - "last_play": 1462380698, - "media_type": "episode", - "platform": "", - "platform_type": "", - "rating_key": 1219, - "row_id": 1116, - "section_id": 2, - "thumb": "", - "title": "Game of Thrones", - "total_duration": 213302, - "total_plays": 69, - "user": "", - "users_watched": "" - }, - {...}, - {...} - ] - }, - {"stat_id": "popular_tv", - "rows": [{...}] - }, - {"stat_id": "top_music", - "stat_type": "total_plays", - "rows": [{...}] - }, - {"stat_id": "popular_music", - "rows": [{...}] - }, - {"stat_id": "last_watched", - "rows": [{...}] - }, - {"stat_id": "top_users", - "stat_type": "total_plays", - "rows": [{...}] - }, - {"stat_id": "top_platforms", - "stat_type": "total_plays", - "rows": [{...}] - }, - {"stat_id": "most_concurrent", - "rows": [{...}] - } - ] -``` - - -### get_libraries -Get a list of all libraries on your server. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"art": "/:/resources/show-fanart.jpg", - "child_count": "3745", - "count": "62", - "parent_count": "240", - "section_id": "2", - "section_name": "TV Shows", - "section_type": "show", - "thumb": "/:/resources/show.png" - }, - {...}, - {...} - ] -``` - - -### get_libraries_table -Get the data on the PlexPy libraries table. - -``` -Required parameters: - None - -Optional parameters: - order_column (str): "library_thumb", "section_name", "section_type", "count", "parent_count", - "child_count", "last_accessed", "last_played", "plays", "duration" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "Movies" - -Returns: - json: - {"draw": 1, - "recordsTotal": 10, - "recordsFiltered": 10, - "data": - [{"child_count": 3745, - "content_rating": "TV-MA", - "count": 62, - "do_notify": "Checked", - "do_notify_created": "Checked", - "duration": 1578037, - "id": 1128, - "keep_history": "Checked", - "labels": [], - "last_accessed": 1462693216, - "last_played": "Game of Thrones - The Red Woman", - "library_art": "/:/resources/show-fanart.jpg", - "library_thumb": "", - "media_index": 1, - "media_type": "episode", - "parent_count": 240, - "parent_media_index": 6, - "parent_title": "", - "plays": 772, - "rating_key": 153037, - "section_id": 2, - "section_name": "TV Shows", - "section_type": "Show", - "thumb": "/library/metadata/153036/thumb/1462175062", - "year": 2016 - }, - {...}, - {...} - ] - } -``` - - -### get_library -Get a library's details. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - json: - {"child_count": null, - "count": 887, - "do_notify": 1, - "do_notify_created": 1, - "keep_history": 1, - "library_art": "/:/resources/movie-fanart.jpg", - "library_thumb": "/:/resources/movie.png", - "parent_count": null, - "section_id": 1, - "section_name": "Movies", - "section_type": "movie" - } -``` - - -### get_library_media_info -Get the data on the PlexPy media info tables. - -``` -Required parameters: - section_id (str): The id of the Plex library section, OR - rating_key (str): The grandparent or parent rating key - -Optional parameters: - section_type (str): "movie", "show", "artist", "photo" - order_column (str): "added_at", "title", "container", "bitrate", "video_codec", - "video_resolution", "video_framerate", "audio_codec", "audio_channels", - "file_size", "last_played", "play_count" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "Thrones" - -Returns: - json: - {"draw": 1, - "recordsTotal": 82, - "recordsFiltered": 82, - "filtered_file_size": 2616760056742, - "total_file_size": 2616760056742, - "data": - [{"added_at": "1403553078", - "audio_channels": "", - "audio_codec": "", - "bitrate": "", - "container": "", - "file_size": 253660175293, - "grandparent_rating_key": "", - "last_played": 1462380698, - "media_index": "1", - "media_type": "show", - "parent_media_index": "", - "parent_rating_key": "", - "play_count": 15, - "rating_key": "1219", - "section_id": 2, - "section_type": "show", - "thumb": "/library/metadata/1219/thumb/1436265995", - "title": "Game of Thrones", - "video_codec": "", - "video_framerate": "", - "video_resolution": "", - "year": "2011" - }, - {...}, - {...} - ] - } -``` - - -### get_library_names -Get a list of library sections and ids on the PMS. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"section_id": 1, "section_name": "Movies"}, - {"section_id": 7, "section_name": "Music"}, - {"section_id": 2, "section_name": "TV Shows"}, - {...} - ] -``` - - -### get_library_user_stats -Get a library's user statistics. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - json: - [{"friendly_name": "Jon Snow", - "total_plays": 170, - "user_id": 133788, - "user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar" - }, - {"platform_type": "DanyKhaleesi69", - "total_plays": 42, - "user_id": 8008135, - "user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar" - }, - {...}, - {...} - ] -``` - - -### get_library_watch_time_stats -Get a library's watch time statistics. - -``` -Required parameters: - section_id (str): The id of the Plex library section - -Optional parameters: - None - -Returns: - json: - [{"query_days": 1, - "total_plays": 0, - "total_time": 0 - }, - {"query_days": 7, - "total_plays": 3, - "total_time": 15694 - }, - {"query_days": 30, - "total_plays": 35, - "total_time": 63054 - }, - {"query_days": 0, - "total_plays": 508, - "total_time": 1183080 - } - ] -``` - - -### get_logs -Get the PlexPy logs. - -``` -Required parameters: - None - -Optional parameters: - sort (str): "time", "thread", "msg", "loglevel" - search (str): A string to search for - order (str): "desc" or "asc" - regex (str): A regex string to search for - start (int): Row number to start from - end (int): Row number to end at - -Returns: - json: - [{"loglevel": "DEBUG", - "msg": "Latest version is 2d10b0748c7fa2ee4cf59960c3d3fffc6aa9512b", - "thread": "MainThread", - "time": "2016-05-08 09:36:51 " - }, - {...}, - {...} - ] -``` - - -### get_metadata -Get the metadata for a media item. - -``` -Required parameters: - rating_key (str): Rating key of the item - media_info (bool): True or False whether to get media info - -Optional parameters: - None - -Returns: - json: - {"actors": [ - "Kit Harington", - "Emilia Clarke", - "Isaac Hempstead-Wright", - "Maisie Williams", - "Liam Cunningham", - ], - "added_at": "1461572396", - "art": "/library/metadata/1219/art/1462175063", - "content_rating": "TV-MA", - "directors": [ - "Jeremy Podeswa" - ], - "duration": "2998290", - "genres": [ - "Adventure", - "Drama", - "Fantasy" - ], - "grandparent_rating_key": "1219", - "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", - "grandparent_title": "Game of Thrones", - "guid": "com.plexapp.agents.thetvdb://121361/6/1?lang=en", - "labels": [], - "last_viewed_at": "1462165717", - "library_name": "TV Shows", - "media_index": "1", - "media_type": "episode", - "originally_available_at": "2016-04-24", - "parent_media_index": "6", - "parent_rating_key": "153036", - "parent_thumb": "/library/metadata/153036/thumb/1462175062", - "parent_title": "", - "rating": "7.8", - "rating_key": "153037", - "section_id": "2", - "studio": "HBO", - "summary": "Jon Snow is dead. Daenerys meets a strong man. Cersei sees her daughter again.", - "tagline": "", - "thumb": "/library/metadata/153037/thumb/1462175060", - "title": "The Red Woman", - "updated_at": "1462175060", - "writers": [ - "David Benioff", - "D. B. Weiss" - ], - "year": "2016" - } -``` - - -### get_new_rating_keys -Get a list of new rating keys for the PMS of all of the item's parent/children. - -``` -Required parameters: - rating_key (str): '12345' - media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" - -Optional parameters: - None - -Returns: - json: - {} -``` - - -### get_notification_log -Get the data on the PlexPy notification logs table. - -``` -Required parameters: - None - -Optional parameters: - order_column (str): "timestamp", "agent_name", "notify_action", - "subject_text", "body_text", "script_args" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "Telegram" - -Returns: - json: - {"draw": 1, - "recordsTotal": 1039, - "recordsFiltered": 163, - "data": - [{"agent_id": 13, - "agent_name": "Telegram", - "body_text": "Game of Thrones - S06E01 - The Red Woman [Transcode].", - "id": 1000, - "notify_action": "play", - "poster_url": "http://i.imgur.com/ZSqS8Ri.jpg", - "rating_key": 153037, - "script_args": "[]", - "session_key": 147, - "subject_text": "PlexPy (Winterfell-Server)", - "timestamp": 1462253821, - "user": "DanyKhaleesi69", - "user_id": 8008135 - }, - {...}, - {...} - ] - } -``` - - -### get_old_rating_keys -Get a list of old rating keys from the PlexPy database for all of the item's parent/children. - -``` -Required parameters: - rating_key (str): '12345' - media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" - -Optional parameters: - None - -Returns: - json: - {} -``` - - -### get_plays_by_date -Get graph data by date. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["YYYY-MM-DD", "YYYY-MM-DD", ...] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plays_by_dayofweek -Get graph data by day of the week. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["Sunday", "Monday", "Tuesday", ..., "Saturday"] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plays_by_hourofday -Get graph data by hour of the day. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["00", "01", "02", ..., "23"] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plays_by_source_resolution -Get graph data by source resolution. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["720", "1080", "sd", ...] - "series": - [{"name": "Direct Play", "data": [...]} - {"name": "Direct Stream", "data": [...]}, - {"name": "Transcode", "data": [...]} - ] - } -``` - - -### get_plays_by_stream_resolution -Get graph data by stream resolution. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["720", "1080", "sd", ...] - "series": - [{"name": "Direct Play", "data": [...]} - {"name": "Direct Stream", "data": [...]}, - {"name": "Transcode", "data": [...]} - ] - } -``` - - -### get_plays_by_stream_type -Get graph data by stream type by date. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["YYYY-MM-DD", "YYYY-MM-DD", ...] - "series": - [{"name": "Direct Play", "data": [...]} - {"name": "Direct Stream", "data": [...]}, - {"name": "Transcode", "data": [...]} - ] - } -``` - - -### get_plays_by_top_10_platforms -Get graph data by top 10 platforms. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["iOS", "Android", "Chrome", ...] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plays_by_top_10_users -Get graph data by top 10 users. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["Jon Snow", "DanyKhaleesi69", "A Girl", ...] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plays_per_month -Get graph data by month. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["Jan 2016", "Feb 2016", "Mar 2016", ...] - "series": - [{"name": "Movies", "data": [...]} - {"name": "TV", "data": [...]}, - {"name": "Music", "data": [...]} - ] - } -``` - - -### get_plex_log -Get the PMS logs. - -``` -Required parameters: - None - -Optional parameters: - window (int): The number of tail lines to return - log_type (str): "server" or "scanner" - -Returns: - json: - [["May 08, 2016 09:35:37", - "DEBUG", - "Auth: Came in with a super-token, authorization succeeded." - ], - [...], - [...] - ] -``` - - -### get_pms_token -Get the user's Plex token used for PlexPy. - -``` -Required parameters: - username (str): The Plex.tv username - password (str): The Plex.tv password - -Optional parameters: - None - -Returns: - string: The Plex token used for PlexPy -``` - - -### get_pms_update -Check for updates to the Plex Media Server. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - {"update_available": true, - "platform": "Windows", - "release_date": "1473721409", - "version": "1.1.4.2757-24ffd60", - "requirements": "...", - "extra_info": "...", - "changelog_added": "...", - "changelog_fixed": "...", - "label": "Download", - "distro": "english", - "distro_build": "windows-i386", - "download_url": "https://downloads.plex.tv/...", - } -``` - - -### get_recently_added -Get all items that where recelty added to plex. - -``` -Required parameters: - count (str): Number of items to return - -Optional parameters: - start (str): The item number to start at - section_id (str): The id of the Plex library section - -Returns: - json: - {"recently_added": - [{"added_at": "1461572396", - "grandparent_rating_key": "1219", - "grandparent_thumb": "/library/metadata/1219/thumb/1462175063", - "grandparent_title": "Game of Thrones", - "library_name": "", - "media_index": "1", - "media_type": "episode", - "parent_media_index": "6", - "parent_rating_key": "153036", - "parent_thumb": "/library/metadata/153036/thumb/1462175062", - "parent_title": "", - "rating_key": "153037", - "section_id": "2", - "thumb": "/library/metadata/153037/thumb/1462175060", - "title": "The Red Woman", - "year": "2016" - }, - {...}, - {...} - ] - } -``` - - -### get_server_friendly_name -Get the name of the PMS. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - string: "Winterfell-Server" -``` - - -### get_server_id -Get the PMS server identifier. - -``` -Required parameters: - hostname (str): 'localhost' or '192.160.0.10' - port (int): 32400 - -Optional parameters: - ssl (int): 0 or 1 - remote (int): 0 or 1 - -Returns: - string: The unique PMS identifier -``` - - -### get_server_identity -Get info about the local server. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"machine_identifier": "ds48g4r354a8v9byrrtr697g3g79w", - "version": "0.9.15.x.xxx-xxxxxxx" - } - ] -``` - - -### get_server_list -Get all your servers that are published to Plex.tv. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"clientIdentifier": "ds48g4r354a8v9byrrtr697g3g79w", - "httpsRequired": "0", - "ip": "xxx.xxx.xxx.xxx", - "label": "Winterfell-Server", - "local": "1", - "port": "32400", - "value": "xxx.xxx.xxx.xxx" - }, - {...}, - {...} - ] -``` - - -### get_server_pref -Get a specified PMS server preference. - -``` -Required parameters: - pref (str): Name of preference - -Returns: - string: Value of preference -``` - - -### get_servers_info -Get info about the PMS. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"port": "32400", - "host": "10.0.0.97", - "version": "0.9.15.2.1663-7efd046", - "name": "Winterfell-Server", - "machine_identifier": "ds48g4r354a8v9byrrtr697g3g79w" - } - ] -``` - - -### get_settings -Gets all settings from the config file. - -``` -Required parameters: - None - -Optional parameters: - key (str): Name of a config section to return - -Returns: - json: - {"General": {"api_enabled": true, ...} - "Advanced": {"cache_sizemb": "32", ...}, - ... - } -``` - - -### get_stream_type_by_top_10_platforms -Get graph data by stream type by top 10 platforms. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["iOS", "Android", "Chrome", ...] - "series": - [{"name": "Direct Play", "data": [...]} - {"name": "Direct Stream", "data": [...]}, - {"name": "Transcode", "data": [...]} - ] - } -``` - - -### get_stream_type_by_top_10_users -Get graph data by stream type by top 10 users. - -``` -Required parameters: - None - -Optional parameters: - time_range (str): The number of days of data to return - y_axis (str): "plays" or "duration" - user_id (str): The user id to filter the data - -Returns: - json: - {"categories": - ["Jon Snow", "DanyKhaleesi69", "A Girl", ...] - "series": - [{"name": "Direct Play", "data": [...]} - {"name": "Direct Stream", "data": [...]}, - {"name": "Transcode", "data": [...]} - ] - } -``` - - -### get_synced_items -Get a list of synced items on the PMS. - -``` -Required parameters: - machine_id (str): The PMS identifier - -Optional parameters: - user_id (str): The id of the Plex user - -Returns: - json: - [{"content_type": "video", - "device_name": "Tyrion's iPad", - "failure": "", - "friendly_name": "Tyrion Lannister", - "item_complete_count": "0", - "item_count": "1", - "item_downloaded_count": "0", - "item_downloaded_percent_complete": 0, - "metadata_type": "movie", - "music_bitrate": "192", - "photo_quality": "74", - "platform": "iOS", - "rating_key": "154092", - "root_title": "Deadpool", - "state": "pending", - "sync_id": "11617019", - "title": "Deadpool", - "total_size": "0", - "user_id": "696969", - "username": "DrukenDwarfMan", - "video_quality": "60" - }, - {...}, - {...} - ] -``` - - -### get_user -Get a user's details. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - None - -Returns: - json: - {"allow_guest": 1, - "deleted_user": 0, - "do_notify": 1, - "email": "Jon.Snow.1337@CastleBlack.com", - "friendly_name": "Jon Snow", - "is_allow_sync": 1, - "is_home_user": 1, - "is_restricted": 0, - "keep_history": 1, - "shared_libraries": ["10", "1", "4", "5", "15", "20", "2"], - "user_id": 133788, - "user_thumb": "https://plex.tv/users/k10w42309cynaopq/avatar", - "username": "LordCommanderSnow" - } -``` - - -### get_user_ips -Get the data on PlexPy users IP table. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - order_column (str): "last_seen", "ip_address", "platform", "player", - "last_played", "play_count" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "xxx.xxx.xxx.xxx" - -Returns: - json: - {"draw": 1, - "recordsTotal": 2344, - "recordsFiltered": 10, - "data": - [{"friendly_name": "Jon Snow", - "id": 1121, - "ip_address": "xxx.xxx.xxx.xxx", - "last_played": "Game of Thrones - The Red Woman", - "last_seen": 1462591869, - "media_index": 1, - "media_type": "episode", - "parent_media_index": 6, - "parent_title": "", - "platform": "Chrome", - "play_count": 149, - "player": "Plex Web (Chrome)", - "rating_key": 153037, - "thumb": "/library/metadata/153036/thumb/1462175062", - "transcode_decision": "transcode", - "user_id": 133788, - "year": 2016 - }, - {...}, - {...} - ] - } -``` - - -### get_user_logins -Get the data on PlexPy user login table. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - order_column (str): "date", "time", "ip_address", "host", "os", "browser" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "xxx.xxx.xxx.xxx" - -Returns: - json: - {"draw": 1, - "recordsTotal": 2344, - "recordsFiltered": 10, - "data": - [{"browser": "Safari 7.0.3", - "friendly_name": "Jon Snow", - "host": "http://plexpy.castleblack.com", - "ip_address": "xxx.xxx.xxx.xxx", - "os": "Mac OS X", - "timestamp": 1462591869, - "user": "LordCommanderSnow", - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A", - "user_group": "guest", - "user_id": 133788 - }, - {...}, - {...} - ] - } -``` - - -### get_user_names -Get a list of all user and user ids. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"friendly_name": "Jon Snow", "user_id": 133788}, - {"friendly_name": "DanyKhaleesi69", "user_id": 8008135}, - {"friendly_name": "Tyrion Lannister", "user_id": 696969}, - {...}, - ] -``` - - -### get_user_player_stats -Get a user's player statistics. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - None - -Returns: - json: - [{"platform_type": "Chrome", - "player_name": "Plex Web (Chrome)", - "result_id": 1, - "total_plays": 170 - }, - {"platform_type": "Chromecast", - "player_name": "Chromecast", - "result_id": 2, - "total_plays": 42 - }, - {...}, - {...} - ] -``` - - -### get_user_watch_time_stats -Get a user's watch time statistics. - -``` -Required parameters: - user_id (str): The id of the Plex user - -Optional parameters: - None - -Returns: - json: - [{"query_days": 1, - "total_plays": 0, - "total_time": 0 - }, - {"query_days": 7, - "total_plays": 3, - "total_time": 15694 - }, - {"query_days": 30, - "total_plays": 35, - "total_time": 63054 - }, - {"query_days": 0, - "total_plays": 508, - "total_time": 1183080 - } - ] -``` - - -### get_users -Get a list of all users that have access to your server. - -``` -Required parameters: - None - -Optional parameters: - None - -Returns: - json: - [{"email": "Jon.Snow.1337@CastleBlack.com", - "filter_all": "", - "filter_movies": "", - "filter_music": "", - "filter_photos": "", - "filter_tv": "", - "is_allow_sync": null, - "is_home_user": "1", - "is_restricted": "0", - "thumb": "https://plex.tv/users/k10w42309cynaopq/avatar", - "user_id": "133788", - "username": "Jon Snow" - }, - {...}, - {...} - ] -``` - - -### get_users_table -Get the data on PlexPy users table. - -``` -Required parameters: - None - -Optional parameters: - order_column (str): "user_thumb", "friendly_name", "last_seen", "ip_address", "platform", - "player", "last_played", "plays", "duration" - order_dir (str): "desc" or "asc" - start (int): Row to start from, 0 - length (int): Number of items to return, 25 - search (str): A string to search for, "Jon Snow" - -Returns: - json: - {"draw": 1, - "recordsTotal": 10, - "recordsFiltered": 10, - "data": - [{"allow_guest": "Checked", - "do_notify": "Checked", - "duration": 2998290, - "friendly_name": "Jon Snow", - "id": 1121, - "ip_address": "xxx.xxx.xxx.xxx", - "keep_history": "Checked", - "last_played": "Game of Thrones - The Red Woman", - "last_seen": 1462591869, - "media_index": 1, - "media_type": "episode", - "parent_media_index": 6, - "parent_title": "", - "platform": "Chrome", - "player": "Plex Web (Chrome)", - "plays": 487, - "rating_key": 153037, - "thumb": "/library/metadata/153036/thumb/1462175062", - "transcode_decision": "transcode", - "user_id": 133788, - "user_thumb": "https://plex.tv/users/568gwwoib5t98a3a/avatar", - "year": 2016 - }, - {...}, - {...} - ] - } -``` - - -### get_whois_lookup -Get the connection info for an IP address. - -``` -Required parameters: - ip_address - -Optional parameters: - None - -Returns: - json: - {"host": "google-public-dns-a.google.com", - "nets": [{"description": "Google Inc.", - "address": "1600 Amphitheatre Parkway", - "city": "Mountain View", - "state": "CA", - "postal_code": "94043", - "country": "United States", - ... - }, - {...} - ] - json: - {"host": "Not available", - "nets": [], - "error": "IPv4 address 127.0.0.1 is already defined as Loopback via RFC 1122, Section 3.2.1.3." - } -``` - - -### import_database -Import a PlexWatch or Plexivity database into PlexPy. - -``` -Required parameters: - app (str): "plexwatch" or "plexivity" - database_path (str): The full path to the plexwatch database file - table_name (str): "processed" or "grouped" - -Optional parameters: - import_ignore_interval (int): The minimum number of seconds for a stream to import - -Returns: - None -``` - - -### install_geoip_db -Downloads and installs the GeoLite2 database - - -### notify -Send a notification using PlexPy. - -``` -Required parameters: - agent_id(str): The id of the notification agent to use - 9 # Boxcar2 - 17 # Browser - 10 # Email - 16 # Facebook - 0 # Growl - 19 # Hipchat - 12 # IFTTT - 18 # Join - 4 # NotifyMyAndroid - 3 # Plex Home Theater - 1 # Prowl - 5 # Pushalot - 6 # Pushbullet - 7 # Pushover - 15 # Scripts - 14 # Slack - 13 # Telegram - 11 # Twitter - 2 # XBMC - subject(str): The subject of the message - body(str): The body of the message - -Optional parameters: - None - -Returns: - None -``` - - -### pms_image_proxy -Gets an image from the PMS and saves it to the image cache directory. - -``` -Required parameters: - img (str): /library/metadata/153037/thumb/1462175060 - or - rating_key (str): 54321 - -Optional parameters: - width (str): 150 - height (str): 255 - fallback (str): "poster", "cover", "art" - refresh (bool): True or False whether to refresh the image cache - -Returns: - None -``` - - -### refresh_libraries_list -Refresh the PlexPy libraries list. - - -### refresh_users_list -Refresh the PlexPy users list. - - -### restart -Restart PlexPy. - - -### search -Get search results from the PMS. - -``` -Required parameters: - query (str): The query string to search for - -Returns: - json: - {"results_count": 69, - "results_list": - {"movie": - [{...}, - {...}, - ] - }, - {"episode": - [{...}, - {...}, - ] - }, - {...} - } -``` - - -### sql -Query the PlexPy database with raw SQL. Automatically makes a backup of -the database if the latest backup is older then 24h. `api_sql` must be -manually enabled in the config file. - -``` -Required parameters: - query (str): The SQL query - -Optional parameters: - None - -Returns: - None -``` - - -### undelete_library -Restore a deleted library section to PlexPy. - -``` -Required parameters: - section_id (str): The id of the Plex library section - section_name (str): The name of the Plex library section - -Optional parameters: - None - -Returns: - None -``` - - -### undelete_user -Restore a deleted user to PlexPy. - -``` -Required parameters: - user_id (str): The id of the Plex user - username (str): The username of the Plex user - -Optional parameters: - None - -Returns: - None -``` - - -### uninstall_geoip_db -Uninstalls the GeoLite2 database - - -### update -Check for PlexPy updates on Github. - - -### update_metadata_details -Update the metadata in the PlexPy database by matching rating keys. -Also updates all parents or children of the media item if it is a show/season/episode -or artist/album/track. - -``` -Required parameters: - old_rating_key (str): 12345 - new_rating_key (str): 54321 - media_type (str): "movie", "show", "season", "episode", "artist", "album", "track" - -Optional parameters: - None - -Returns: - None -``` - +Tautulli API documentation has been moved to the [wiki page](https://github.com/Tautulli/Tautulli/wiki/Tautulli-API-Reference). \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index a3ecb5ef..b349b355 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,1933 @@ # Changelog +## v2.15.3 (2025-08-03) + +* Exporter: + * New: Added hearingImpaired for subtitles and visualImpaired for audio attributes to exporter fields. +* Graphs: + * Fix: Remove duplicate "Total" entry in graph tooltips. (Thanks @zdimension) (#2534) +* UI: + * Fix: Failing to retrieve collections / playlists with over 1000 items. + * Fix: Scrollbar not showing on macosx and webkit browsers. (#2221) + * Fix: Incorrect rounding of minutes in global stats play duration. + * Fix: Disable browser autocomplete for notification agent and newsletter agent configurations. (#2557) +* API: + * New: Added ability to return svg files using pms_image_proxy API command. +* Other: + * New: Added ability to set config values using environment variables. (Thanks @komuw) (#2309, #2543) + + +## v2.15.2 (2025-04-12) + +* Activity: + * New: Added link to library by clicking media type icon. + * New: Added stream count to tab title on homepage. (#2517) +* History: + * Fix: Check stream watched status before stream stopped status. (#2506) +* Notifications: + * Fix: ntfy notifications failing to send if provider link is blank. + * Fix: Check Pushover notification attachment is under 5MB limit. (#2396) + * Fix: Track URLs redirecting to the correct media page. (#2513) + * New: Added audio profile notification parameters. + * New: Added PATCH method for Webhook notifications. +* Graphs: + * New: Added Total line to daily streams graph. (Thanks @zdimension) (#2497) +* UI: + * Fix: Do not redirect API requests to the login page. (#2490) + * Change: Swap source and stream columns in stream info modal. +* Other: + * Fix: Various typos. (Thanks @luzpaz) (#2520) + * Fix: CherryPy CORS response header not being set correctly. (#2279) + + +## v2.15.1 (2025-01-11) + +* Activity: + * Fix: Detection of HDR transcodes. (Thanks @cdecker08) (#2412, #2466) +* Newsletters: + * Fix: Disable basic authentication for /newsletter and /image endpoints. (#2472) +* Exporter: + * New: Added logos to season and episode exports. +* Other: + * Fix: Docker container https health check. + + +## v2.15.0 (2024-11-24) + +* Notes: + * Support for Python 3.8 has been dropped. The minimum Python version is now 3.9. +* Notifications: + * New: Allow Telegram blockquote and tg-emoji HTML tags. (Thanks @MythodeaLoL) (#2427) + * New: Added Plex slug and Plex Watch URL notification parameters. (#2420) + * Change: Update OneSignal API calls to use the new API endpoint for Tautulli Remote App notifications. +* Newsletters: + * Fix: Dumping custom dates in raw newsletter json. +* History: + * Fix: Unable to fix match for artists. (#2429) +* Exporter: + * New: Added movie and episode hasVoiceActivity attribute to exporter fields. + * New: Added subtitle canAutoSync attribute to exporter fields. + * New: Added logos to the exporter fields. +* UI: + * New: Add friendly name to the top bar of config modals. (Thanks @peagravel) (#2432) +* API: + * New: Added plex slugs to metadata in the get_metadata API command. +* Other: + * Fix: Tautulli failing to start with Python 3.13. (#2426) + + +## v2.14.6 (2024-10-12) + +* Newsletters: + * Fix: Allow formatting newsletter date parameters. + * Change: Support apscheduler compatible cron expressions. +* UI: + * Fix: Round runtime before converting to human duration. + * Fix: Make recently added/watched rows touch scrollable. +* Other: + * Fix: Auto-updater not running. + + +## v2.14.5 (2024-09-20) + +* Activity: + * Fix: Display of 2k resolution on activity card. +* Notifications: + * Fix: ntfy notifications with special characters failing to send. +* Other: + * Fix: Memory leak with database closing. (#2404) + + +## v2.14.4 (2024-08-10) + +* Notifications: + * Fix: Update Slack notification info card. + * New: Added ntfy notification agent. (Thanks @nwithan8) (#2356, #2000) +* UI: + * Fix: macOS platform capitalization. +* Other: + * Fix: Remove deprecated getdefaultlocale. (Thanks @teodorstelian) (#2364, #2345) + + +## v2.14.3 (2024-06-19) + +* Graphs: + * Fix: History table not loading when clicking on the graphs in some instances. +* UI: + * Fix: Scheduled tasks table not loading when certain tasks are disabled. + * Removed: Unnecessary Remote Server checkbox from the settings page. +* Other: + * Fix: Webserver not restarting after the setup wizard. + * Fix: Workaround webserver crashing in some instances. + + +## v2.14.2 (2024-05-18) + +* History: + * Fix: Live TV activity not logging to history. + * Fix: Incorrect grouping of live TV history. +* Notifications: + * Fix: Pushover configuration settings refreshing after entering a token. + * Fix: Plex remote access down notifications not triggering. + * Fix: Deleting all images from Cloudinary only deleting 1000 images. + * New: Added platform version and product version notification parameters. (#2244) + * New: Added LAN streams and WAN streams notification parameters. (#2276) + * New: Added Dolby Vision notification parameters. (#2240) + * New: Added live TV channel notification parameters. + * Change: Improved Tautulli Remote App notification encryption method. + * Note: Requires Tautulli Remote App version 3.2.4. +* Exporter: + * New: Added slug attribute to exporter fields. + * New: Added track genres to exporter fields. + * New: Added playlist source URI to exporter fields. + * New: Added artProvider and thumbProvider to exporter fields. +* UI: + * Fix: Mask deleted usernames in the logs. + * Fix: Live TV watch stats not showing on the media info page. + * Fix: Users without access to Plex server not showing as inactive. + * Removed: Deprecated synced item pages. + * Removed: Anonymous redirect settings. Links now use browser no-referrer policy instead. +* API: + * New: Added Dolby Vision info to the get_metadata API command. + * New: Added before and after parameters to the get_home_stats API command. (#2231) +* Packages: + * New: Universal binary for macOS for Apple silicon. + * New: Bump Snap package to core22. +* Other: + * Change: Login cookie expires changed to max-age. + * Change: Improved key generation for login password. It is recommended to reenter your HTTP Password in the settings after upgrading. + * Removed: Python 2 compatibility code. (#2098, #2226) (Thanks @zdimension) + + +## v2.13.4 (2023-12-07) + +* UI: + * Fix: Tautulli configuration settings page not loading when system language is None. + * Fix: Login cookie expiring too quickly. + + +## v2.13.3 (2023-12-03) + +* Notifications: + * New: Added duration_time notification parameter. + * New: Added file_size_bytes notification parameter. + * New: Added time formats notification text modifiers. + * New: Added support for thetvdb_url for movies. +* UI: + * Fix: Activity card overflowing due to screen scaling. (#2033) + * Fix: Stream duration on activity card not being updated on track changes in some cases. (#2206) + + +## v2.13.2 (2023-10-26) + +* History: + * New: Added quarter values icons for history watch status. (#2179, #2156) (Thanks @herby2212) +* Graphs: + * New: Added concurrent streams per day graph. (#2046) (Thanks @herby2212) +* Exporter: + * New: Added metadata directory to exporter fields. + * Removed: Banner exporter fields for tv shows. +* UI: + * New: Added last triggered time to notification agents and newsletter agent lists. +* Other: + * New: Added X-Plex-Language header override to config file. + + +## v2.13.1 (2023-08-25) + +* Notes: + * Support for Python 3.7 has been dropped. The minimum Python version is now 3.8. +* Other: + * Fix: Tautulli failing to start on some systems. + + +## v2.13.0 (2023-08-25) + +* Notes: + * Support for Python 3.7 has been dropped. The minimum Python version is now 3.8. +* Notifications: + * Fix: Improved watched notification trigger description. (#2104) + * New: Added notification image option for iOS Tautulli Remote app. +* Exporter: + * New: Added track chapter export fields. + * New: Added on-demand subtitle export fields. + + +## v2.12.5 (2023-07-13) + +* Activity: + * New: Added d3d11va to list of hardware decoders. +* History: + * Fix: Incorrect grouping of play history. + * New: Added button in settings to regroup play history. +* Notifications: + * Fix: Incorrect concurrent streams notifications by IP addresss for IPv6 addresses (#2096) (Thanks @pooley182) +* UI: + * Fix: Occasional UI crashing on Python 3.11. + * New: Added multiselect user filters to History and Graphs pages. (#2090) (Thanks @zdimension) +* API: + * New: Added regroup_history API command. + * Change: Updated graph API commands to accept a comma separated list of user IDs. + + +## v2.12.4 (2023-05-23) + +* History: + * Fix: Set view offset equal to duration if a stream is stopped within the last 10 sec. +* Other: + * Fix: Database import may fail for some older databases. + * Fix: Double-quoted strings for newer versions of SQLite. (#2015, #2057) +* API: + * Change: Return the ID for async API calls (export_metadata, notify, notify_newsletter). + + +## v2.12.3 (2023-04-14) + +* Activity: + * Fix: Incorrect subtitle decision shown when subtitles are transcoded. +* History: + * Fix: Incorrect order when sorting by the duration column in the history tables. +* Notifications: + * Fix: Logging error when running scripts that use PlexAPI. +* UI: + * Fix: Calculate file sizes setting causing the media info table to fail to load. + * Fix: Incorrect artwork and thumbnail shown for Live TV on the Most Active Libraries statistics card. +* API: + * Change: Renamed duration to play_duration in the get_history API response. (Note: duration kept for backwards compatibility.) + + +## v2.12.2 (2023-03-16) + +* Other: + * Fix: Tautulli not starting on FreeBSD jails. + + +## v2.12.1 (2023-03-14) + +* Activity: + * Fix: Stop checking for deprecated sync items sessions. + * Change: Do not show audio language on activity cards for music. +* Other: + * Fix: Tautulli not starting on macOS. + + +## v2.12.0 (2023-03-13) + +* Notifications: + * New: Added support for Telegram group topics. (#1980) + * New: Added anidb_id and anidb_url notification parameters. (#1973) + * New: Added notification triggers for Intro Marker, Commercial Marker, and Credits Marker. + * New: Added various intro, commercial, and credits marker notification parameters. + * New: Allow setting a custom Pushover notification sound. (#2005) + * Change: Notification images are now uploaded directly to Discord without the need for a 3rd party image hosting service. + * Change: Automatically strip whitespace from notification condition values. + * Change: Trigger watched notifications based on the video watched completion behaviour setting. +* Exporter: + * Fix: Unable to run exporter when using the Snap package. (#2007) + * New: Added credits marker, and audio/subtitle settings to export fields. +* UI: + * Fix: Incorrect styling and missing content for collection media info pages. + * New: Added edition details field on movie media info pages. (#1957) (Thanks @herby2212) + * New: Added setting to change the video watched completion behaviour. + * New: Added watch time and user statistics to collection and playlist media info pages. (#1982, #2012) (Thanks @herby2212) + * New: Added history table to collection and playlist media info pages. + * New: Dynamically change watched status in the UI based on video watched completion behaviour setting. + * New: Added hidden setting to override server name. + * Change: Move track artist to a details field instead of in the title on track media info pages. +* API: + * New: Added section_id and user_id parameters to get_home_stats API command. (#1944) + * New: Added marker info to get_metadata API command results. + * New: Added media_type parameter to get_item_watch_time_stats and get_item_user_stats API commands. (#1982) (Thanks @herby2212) + * New: Added last_refreshed timestamp to get_library_media_info API command response. +* Other: + * Change: Migrate analytics to Google Analytics 4. + + +## v2.11.1 (2022-12-22) + +* Activity: + * Fix: Use source language instead of stream language on activity cards. +* Notifications: + * Fix: Blank start time notification parameters causing recently added notifications to fail. (#1940) +* Other: + * Fix: Tautulli failing to start when using python 3.7. + * Fix: Snap install failing to start. (#1941) + * Fix: Update check crashing when git is missing. (#1943) (Thanks @Minituff) + + +## v2.11.0 (2022-12-22) + +* Activity: + * New: Added audio and subtitle language to activity cards. (#1831, #1900) (Thanks @fscorrupt) +* History: + * New: Log subtitle language and subtitle forced to database. (#1826) +* Notifications: + * Fix: Validating condition operators would fail with a blank parameter. + * New: Added start time and stop time notification parameters. (#1931) + * New: Added session_key to LunaSea notification payload. (#1929) (Thanks @JagandeepBrar) +* Newsletters: + * Fix: Allow CSS to support light and dark themes. +* Exporter: + * New: Added editionTitle to movie exporter fields. + * Change: m3u8 export changed to .m3u file extension. File is still encoded using UTF-8. +* UI: + * Fix: Link watch statistics to media page using metadata from history. (#1882) + * New: Show subtitle language and subtitle forced flag in stream data modal. +* Other: + * Fix: Mask more user and metadata fields for guest access. (#1913) + * Change: Disable TLS 1.0 and 1.1 for the webserver. Minimum TLS version is 1.2. (#1870) + * Change: Use system language for requests to Plex Media Server. + + +## v2.10.5 (2022-11-07) + +* Notifications: + * New: Added edition_title notification parameter. (#1838) + * Change: Track notifications link to MusicBrainz track instead of album. +* Newsletters: + * New: Added months time frame for newsletters. (#1876) +* UI: + * Fix: Broken link on library statistic cards. (#1852) + * Fix: Check for IPv6 host when generating QR code for app registration. + * Fix: Missing padding on condition operator dropdown on small screens. +* Other: + * Fix: Launching browser when webserver is bound to IPv6. + * New: Tautulli can be installed via the Windows Package Manager (winget). + * Change: Separate stdout and stderr console logging. (#1874) +* API: + * Fix: API not returning 400 response code. + * New: Added edition_title to get_metadata API response. + * New: Added collections to get_children_metadata API response. + * New: Added user_thumb to get_history API response. + * New: Validate custom notification conditions before saving notification agents. (#1846) + * Change: Fallback to parent_thumb for seasons in get_metadata API response. + + +## v2.10.4 (2022-09-05) + +* Activity: + * New: Added tooltip for quality profile on activity cards. +* Notifications: + * New: Added "does not begin with" and "does not end with" condition operators. +* UI: + * Fix: Album count showing 0 on library statistics. + * Fix: Library statistics not showing up for libraries without any history. + + +## v2.10.3 (2022-08-09) + +* Notifications: + * New: Added JSON support for MQTT notifications. (#1763) + * New: Added show year notification parameter. +* Exporter: + * New: Added guids to artist, album, and track metadata export fields. + * New: Added languageTag to stream media info export fields. +* UI: + * Fix: Long channel identifier overflowing activity card. (#1802) + * Change: Use the last played item's artwork for library statistics cards. +* Other: + * Fix: Username log filter causing database to lock up. (#1705) + * Change: Username log filter only applies to usernames longer than 3 characters. (#1806) +* API: + * New: Added parent_year and grandparent_year to get_metadata_details API command. + * New: Added last played metadata to top_libraries and top_users in get_home_stats API command. + * New: Allow fallback to another PMS image in pms_image_proxy API command. + + +## v2.10.2 (2022-07-03) + +* Activity: + * Fix: Incorrect audio stream info shown on the activity card when playing a secondary audio track. +* UI: + * Fix: Usernames not showing on the home statistics cards. + * Fix: Do not save a user's friendly name if it is the same as the username. + * Change: Update library icons to the latest Plex style. + + +## v2.10.1 (2022-06-01) + +* Notifications: + * New: Added support for MusicBrainz (mbid://) guids in notification parameters without MusicBrainz lookup enabled. Requires Plex Media Server 1.27.0 or newer with refreshed Plex Music agent metadata. +* Mobile App: + * Fix: OneSignal validation failing when registering a device. +* API: + * New: Added grandparent_guids and parent_guids to get_metadata API command. + * Change: Updated continent in get_geoip_lookup API command. + * Change: Removed server_token from from get_users API command. + * Change: shared_libraries changed to a list instead of a string for get_users API command. + + +## v2.10.0 (2022-05-23) + +* Activity: + * Fix: Detection of Dolby Vision missing for PMS 1.26.1. +* Notifications: + * Fix: Parsing of filename notification parameter incorrect for Windows PMS. +* Exporter: + * New: Added additional theme and label export fields. +* UI: + * Fix: Slow loading of collections and playlists tables. + * Change: Update default user thumbnail image to match Plex Web. +* API: + * Change: Values for get_users_table and get_libraries_table return an integer instead of "Checked". + + +## v2.9.7 (2022-04-11) + +* UI: + * Fix: Managed user missing the username in the Users table. + + +## v2.9.6 (2022-04-10) + +* Activity: + * New: Improved display of dynamic range on the activity cards. (Thanks @herby2212) +* Notifications: + * Change: Make include summary option apply to all media types for Discord and Slack notifications. +* UI: + * Fix: Validating Plex login in the setup wizard. (#1697) + * New: Added hidden username, email, and full name columns to users table. +* Other: + * Fix: Apply pms_timeout setting to websocket connection. + * Fix: Importing of Plex username instead of the full name. (#1710) + + +## v2.9.5 (2022-03-26) + +* Note: + * Updated Snap packages are currently unavailable due to an upstream issue. +* Activity: + * Change: Improve calculation for transcode progress bar percentage on the activity cards. +* History: + * Fix: Live TV history filter not working. (#1691) +* Newsletter: + * Fix: Newsletter not showing different album types. (#1559) +* UI: + * Fix: Display season summary on the media info page if available with a fallback to show summary. (#1657) + * Change: Colour active filter buttons to improve contrast. (#1663) +* API: + * New: Added transcode offset keys to get_activity command. +* Other: + * Fix: Reschedule backup task after changing backup interval. (#1662) + * Fix: Dynamic anonymous redirect setting not being enabled by default after the setup wizard. + * Fix: Usernames with special characters not being filtered in the logs. + + +## v2.9.4 (2022-02-12) + +* UI: + * Fix: Setup wizard appearing when restarting after saving settings. +* Other: + * Fix: Stop Tautulli from starting multiple instances on Windows after a clean reinstall. Check the startup items in Windows Task Manager if it is still occurring. + + +## v2.9.3 (2022-02-09) + +* UI: + * Fix: Setup wizard looping. +* Other: + * Fix: Logger username masking preventing Tautulli from starting on new installs. + + +## v2.9.2 (2022-02-08) + +* Notification: + * New: Added support for additional Telegram HTML tags. + * Removed: Revert Telegram defaulting to MarkdownV2 and only support HTML. (#1635) +* Other: + * Fix: The Local user being masked in the logs. + + +## v2.9.1 (2022-02-07) + +* Other: + * Fix: Incorrect changelog version number and date. + + +## v2.9.0 (2022-02-07) + +* Notification: + * New: Added track disc number notification parameter. + * Change: Default Telegram messages to MarkdownV2 when HTML is disabled. (#1635) +* Exporter: + * Fix: Images not being included in export zip file download. +* UI: + * Fix: Favicon missing from the newsletter authentication page. + * Fix: IPv6 details not being shown in IP address modal. (#1629) + * Fix: PWA not respecting device rotation settings. (#1633) + * New: Added intermediary login page to the Plex XML shortcuts. + * New: Added setting to mask usernames in logs (enabled by default). + * New: Added location, secure connection, and Plex Relay details to IP address modal. + * Change: Remove Plex token from the settings page. + * Change: Increase verifying server timeout to 30 seconds. +* API: + * New: Added get_tautulli_info API command. + * New: Added location, secure, and relayed to get_history API response. + * Change: Null pms_token and jwt_token in the response of the get_settings API command. (#1616) +* Other: + * Fix: Better validation of config when saving settings. + * Fix: Correct section_id and prevent rating_key collisions when updating metadata. (#1640) + * Change: Proxy Plex token check and Plex downloads json through the Tautulli server. + * Change: Remove tokens from downloaded database and config files. + * Change: Do not import pms_token or jwt_secret when importing a config file. + + +## v2.8.1 (2022-01-04) + +* API: + * New: Added grouping and query_days parameters to the get_item_watch_time_stats API command. + * New: Added grouping parameter to the get_item_user_stats API command. + * New: Added total_time to the get_library_user_stats, get_user_player_stats, and get_item_user_stats API command responses. + * Removed: media_type parameter no longer required for the get_item_watch_time_stats, and get_item_user_stats API commands. The media type is determined automatically. +* Other: + * Fix: Clean .pyc files automatically after updating. + * New: Allow Snap package to access /media and /mnt locations. Refer to the FAQ for instructions on how to enable access. + + +## v2.8.0 (2021-12-15) + +* History: + * Fix: Live TV history filter not working correctly when combined with other filters. + * Fix: Direct Stream history filter not remembering the state when reloading the page. + * Fix: History table not loading when no filters are selected. + * New: Added watch time and user stats to media info pages. (Thanks @herby2212) (#1417, #1471) +* Notifications: + * New: Added Microsoft Teams notification agent. (#1514) + * New: Added Gotify notification agent. (#1584) + * New: Add warning message that passwords are not copied when duplicating a notification or newsletter agent. (#1540) +* Newsletters: + * Fix: Different album types not shown on newsletter. (#1559) +* Exporter: + * New: Added album formats, subformats, and sonic analysis export fields. +* UI: + * Fix: Docker config volume message overlapping modal windows. (#1567) + * Fix: Different album types not shown on artist media info page. + * New: Added show more/less toggle for summaries on media info pages. (#1546) + * Change: Do not save datatable page or search states when reloading the page. (#1532) + * Change: Improve the Plex log reader. +* API: + * New: Added before and after parameters to the get_history API command. +* Other: + * Fix: Updated Python dependencies. (#1499) + * Fix: Some websocket connections not respecting the verify SSL setting. (Thanks @nmaggioni) (#1541) + * New: Support for Python 3.10. (#1522) + * New: Added dynamic anonymous redirect service setting. (#1526) + + +## v2.7.7 (2021-10-14) + +* Notifications: + * Fix: Colons and exclamation marks being replaced outside of expressions. + * New: Added LunaSea notification agent. Note: Requires a future LunaSea app update to function. +* Newsletters: + * Fix: Star rating not showing on newsletter with the new Plex metadata agents. (#1511) +* UI: + * Fix: Sorting of mobile devices table with uppercase and lowercase device names. + * Fix: Various dropdown menus with centered text to left-aligned text. +* Other: + * Fix: Plex.tv account token not changing when fetching a new token. + * New: Added check and warning message for missing Docker container volume mount. + + +## v2.7.6 (2021-08-31) + +* Notifications: + * Fix: Unable to parse colons (:) and exclamation marks (!) in notification text eval strings. +* Exporter: + * Fix: Unable to export playlists and collections from a library. (#1484) + * New: Added new episode export fields. +* Mobile App: + * Fix: Unable to scan QR code with dark mode enabled. + * New: Tautulli Remote App is out of beta for iOS and can be downloaded in the App Store. +* Other: + * New: Update PlexAPI to 4.6.3. + * New: Added popup alert message for Windows and macOS when Tautulli fails to start. + + +## v2.7.5 (2021-07-15) + +* History: + * Fix: Guest users were unable to view history. + * Fix: Most Active Library statistics was counting deleted libraries. +* Newsletters: + * Fix: Incorrect padding on the newsletter configuration modal. +* Mobile App: + * New: Tautulli Remote App is out of beta on Android. The iOS app is available for beta testing on TestFlight. +* API: + * New: Added mobile device platform and version to device registration. +* Other: + * Fix: Unable to remove authentication. + * Change: Improve API key and device token security on Python 3. + * Remove: Basic Authentication setting. + + +## v2.7.4 (2021-06-19) + +* Activity: + * Fix: Incorrect quality profile shown on the activity card. +* Notifications: + * New: Added ability to evaluate Python expressions in notification parameters. + * New: Added tilde (~) to represent blank notification condition values. +* Exporter: + * Fix: Blank fields missing from csv and json exports. + * New: Added some new exporter fields. +* Graphs: + * Fix: Play counts and durations not matching the homepage statistics. +* UI: + * New: Show search bar in the collapsed menu on the mobile layout. (#1446) + * Change: Do not show seconds for total played duration on Users and Libraries tables. +* Other: + * Fix: Check the Tautulli data folder is writable on startup. (#1441) + * New: Update PlexAPI to 4.6.1. + * Change: Always hash HTTP password in config file. + + +## v2.7.3 (2021-05-22) + +* Activity: + * Fix: Incorrect quality profile being shown when transcoding to a higher bitrate. +* Notifications: + * New: Added notification parameters for duration values in seconds. (#1434) + * New: Added setting to allow repeat Tautulli update notifications. By default the Tautulli update notification will only notify once. + * New: Added setting to allow repeat Plex Media Server update notifications. By default the Plex Media Server update notification will only notify once. + * New: Added setting to configure the Tautulli update check interval. +* UI: + * Fix: Prevent accidentally closing modals when dragging the mouse outside the window. + * Fix: Recently added queue modal not loading. (#1429) + * New: Show collections tab in music libraries. (#1421) + * New: Added method to logout of active Tautulli sessions from the login logs. +* API: + * Fix: Update edit_user and edit_library doc strings for required parameters. (#1432) +* Other: + * New: Added advanced hidden setting for CherryPy thread pool size. (Thanks @psaab #1425) + + +## v2.7.2 (2021-04-24) + +* UI: + * New: Show smart collections in the library collections tab. + + +## v2.7.1 (2021-04-22) + +* Notifications: + * Fix: Recently added single episode being sent as a show notification. (#1420) +* Newsletters: + * Change: Ignore items with incorrect added at dates in the future. +* Exporter: + * Fix: Exporting not working for libraries, collections, and playlists. (#1408) +* UI: + * Fix: Collections and playlist tabs not loading on library and user pages. (#1408) + * Fix: Header overlapping graphs tabs on mobile layout. + * Change: Rename "Plays by Period" graph tab to "Media Type". + * Removed: Clear logs button removed from main Tautulli logs. + + +## v2.7.0 (2021-04-10) + +* History: + * New: Added transcode decision filter added to history tables. + * New: History table filters changed to allow multiple selections. +* Notifications: + * Fix: Recently added notifications failing due to metadata not being available yet on the Plex server. (#1392) + * New: Added separate SSL/TLS support for Email notifications. + * New: Added notification image type setting for Tautulli Remote App notifications. + * New: Added guid notification parameter. + * New: Added a Plex server down notification threshold setting. +* Newsletters: + * Fix: Newsletters would fail if an episode was missing a season number. +* UI: + * Fix: Fixed spacing of rating images on the media info pages. + * Fix: Fixed refreshing cached image in the browser. + * Fix: Bootstrap tooltips logging javascript errors in some instances. + * Fix: Activity card progress bar not filling at 100%. (#1404) + * New: Added blurred background to the Most Active Users statistics card. + * New: Added transcode decision filter for all history tables. + * New: Added an error popup message if the Plex.tv token is no longer valid when visiting the settings page. + * New: Added Amazon Alexa platform logo. + * Change: Improved loading times for the homepage watch statistics. + * Change: Improved loading times for user and library watch time statistics. + * Change: Improved loading of the graph's history modal popup. + * Change: Automatically trim trailing slashes from the Tautulli Public Domain setting. + * Change: Renamed the Plex Media Server "Use SSL" setting to "Use Secure Connection". + * Change: Update Microsoft Edge platform logo. + * Change: Consider link local IP addresses as local addresses. + * Change: Reveal token fields if they are blank to make it easier to input new values. +* Mobile App: + * New: Accept disabled OneSignal ID during device registration. +* API: + * New: Added user fallback image option to the pms_image_proxy command. + * New: Added optional include_last_seen parameter to the get_user command. + * New: Added optional include_last_accessed parameter to the get_library command. + * New: Allow comma separated filter values for the get_history command. +* Other: + * Fix: Importing the newsletter table would fail when manually repairing a corrupted database. + * Fix: Make fix match in Tautulli for music case-insensitive. + * New: Update PlexAPI to 4.5.2. + * Change: Migrate section_id from the session_history_metadata database table to session_history. + * Change: Copy the database file to the cache folder when importing a database using the browse option. + * Change: Delete the cached database file after successfully importing. + + +## v2.6.10 (2021-03-17) + +* Other: + * Fix: Configuration upgrade would fail if the Most Active User card was disabled. (#1395) + + +## v2.6.9 (2021-03-17) + +* Notifications: + * New: Added tautulli_update_exe and tautulli_update_exe notification parameters for Tautulli update notifications. +* Exporter: + * New: Added new TV show export fields for the beta Plex TV agent. +* UI: + * Fix: Some popover images not showing up on hover. (#1391) + * Remove: HTTP Host setting removed from the UI. This setting may still be changed in the config file. + * New: Added a Most Active Libraries statistics card to the homepage. (Thanks @herby2212) + * New: Mask sensitive text fields in the settings. Settings can be revealed by clicking on the eye icon. +* Mobile App: + * Change: Make OneSignal validation asynchronous to help timeout issues when registering a device. +* API: + * Added top_libraries stat_id option to get_home_stats API commaand. +* Ohter: + * New: Updated PlexAPI to 4.4.1. + + +## v2.6.8 (2021-03-08) + +* Mobile App: + * New: An all new Tautulli Remote App 2.0. Go to the Google Play link in the settings to download the new version. + * Fix: Registering the new app would fail if OneSignal is blocked. + + +## v2.6.7 (2021-03-07) + +* History: + * New: Added audio language to detailed stream info. (Thanks @herby2212) +* Notifications: + * New: Added season_name notification parameter. + * New: Update notifications to support custom season titles. +* Newsletters: + * New: Update recently added newsletter template to support custom season titles. +* Exporter: + * New: Added originalTitle and bannerFile to TV show export fields. +* UI: + * New: Added TVDB rating image to info page for the new Plex TV agent. + * New: Update the UI to support custom season titles. +* API: + * Fix: Return rating key for collections/playlists in get_synced_items. + * Fix: Return error when delete_synced_item fails. + * New: Return sync_media_type for collections/playlist in get_synced_items. + * New: Update pms_image_proxy to support playlist composite images. +* Other: + * Remove: Auto-updater for the Windows exe installer due to it being flagged by antivirus software. + * New: Updated PlexAPI to 4.4.0. + + +## v2.6.6 (2021-02-06) + +* Exporter: + * Fix: Exporting failed with long file paths on Windows. + * New: Updated various exporter fields. + * Change: Renamed collection children to collection items. +* UI: + * Fix: Client side login redirect changed to server side. + * Change: Renamed "Fix Metadata" button to "Fix Match". +* API: + * New: Added get_children_metadata API command. + * New: Return more metadata from the get_home_stats API command. +* Other: + * New: Updated PlexAPI to 4.3.1. + + +## v2.6.5 (2021-01-09) + +* Other: + * Fix: Some IP addresses not being masked in the logs. + * New: Auto-updater for Windows exe installer. + * Change: Allow Snap package to access the user home directory. + * Change: Migrate Snap user data to a persistent location that is retained if Tautulli is reinstalled. + + +## v2.6.4 (2020-12-20) + +* Other: + * Fix: Restore Snap data folder from previous installs. + + +## v2.6.3 (2020-12-19) + +* Announcements: + * This is the last Tautulli version to support Python 2. Python 3 will be required to continue receiving updates. You can check your Python version on the settings page. +* Exporter: + * Fix: Accessible and exists attributes were blank for media info export level 9. +* UI: + * Fix: Guest usernames were not masked on mouse hover. +* Other: + * Fix: macOS menu bar icon for light and dark mode. + * New: Tautulli can officially be installed on Linux using a Snap package. See the installation wiki for details. + + +## v2.6.2 (2020-12-05) + +* Notifications: + * Change: Send a notification of a user new device for the first time only. This can be toggled off in the settings. +* Exporter: + * Fix: Allow exporting child fields only without requiring the parent fields as well. + * Fix: Exporting individual collection would fail. + * Change: Remove accessible and exists fields from the default media info export levels. This prevents the Plex server from reading the media files unnecessarily. +* Other: + * Fix: Enable high resolution for the macOS system tray icon and menu. + * New: Added rate limiting for failed login attempts. + * Change: Use a white logo for the macOS system tray icon. +* API: + * New: Added machine_id to the get_history API response. + + +## v2.6.1 (2020-11-03) + +* Other: + * Fix: High CPU/memory usage in some instances. + * Fix: Logger error preventing Tautulli from starting. + * Fix: Database issue with non-unique image hashes. + + +## v2.6.0 (2020-10-31) + +* Exporter: + * New: New exporter feature that allows you to export the metadata and images for any library, collection, playlist, or media item to csv, json, xml, or m3u8. Refer to the Exporter Guide in the wiki for more details. +* UI: + * Fix: Margin on the homepage activity and statistic/library cards. (Thanks @dotsam) + * Fix: Movie ratings not showing on the info page for the new Plex Movie agent. + * New: Added ability to browse collections and playlists from the library and user pages. + * Change: Updated platform brand logos and colours. +* API: + * New: Added export_metadata, download_export, and delete_export API commands. + * New: Added get_collections_table, and get_playlists_table API commands. + * New: Added min_version parameter to the register_device API command. + * New: Added include_activity parameter to the get_history API command. + * New: Added sync_id parameter to the get_metadata API command. + * New: Added delete_synced_item API command. + * New: Added a stat_id and stats_start parameters to the get_home_stats API command. + * New: Allow deleting a mobile device using the registration device_id for the delete_mobile_device API command. + * Change: Return Plex server info and Tautulli info from the register_device command. +* Other: + * New: The Docker container is now also built for the arm32v6 architecture. + * New: The Docker container is also published to the GitHub Container Registry at ghcr.io/tautulli/tautulli. + * Change: Tautulli is now using a forked version of plexapi 3.6.0. This is to support the exporter feature while still maintaining Python 2 compatibility. + * Change: Updated systemd script to remove process forking. (Thanks @MichaIng) + * Change: Cache GitHub update check on startup. + + +## v2.5.6 (2020-10-02) + +* Activity: + * Change: Renamed container "Transcode" to "Converting" on activity cards. +* Notifications: + * New: Added a silent notification option for Telegram. (Thanks @JohnnyKing94) + * New: Added container_decision notification parameter. + * New: Added notification trigger for Playback Error. + * New: Added remote access down notification threshold setting. +* Newsletter: + * Change: Stop flooring newsletter start date. +* UI: + * Fix: Unable to purge history from the library edit modal. + * Fix: QR code not showing up for localhost address when trying to register a device. + * New: Added library name to the fix metadata modal. +* API: + * New: Added default thumb and art to the Live TV library. +* Other: + * Fix: Synced items not loading for guest access. + * New: Schedule some more automatic database optimizations. + * Change: Added automatic uninstall before installing to the Windows installer. + + +## v2.5.5 (2020-09-06) + +* Activity: + * Fix: Filter out TV show background theme music sessions. +* Notifications: + * New: Check Plex external guids for notification metadata provider links. +* UI: + * Fix: Incorrect sorting for user/library recently played items. +* API: + * Fix: get_synced_items API command returning error with empty result. + * Fix: Download API commands not returning the file. + * Fix: get_logs API command encoding error. + * Fix: get_user_player_stats API command returning error instead of empty result. + * New: Added get_server_info API command. + * New: Added external guids to get_metadata API command. + * New: Added support for multi-column sorting for datatable API commands. + * Change: get_activity API command return thumbnail override for clips. + * Change: get_libraries_table API command return custom library artwork. +* Other: + * Fix: Tautulli failed to run with a stale pid file. + * New: Added scheduled task to optimize the Tautulli database. + * Change: Update plexapi to 3.6.0. + * Change: Update some libraries for Python 3 compatibility. + + +## v2.5.4 (2020-07-31) + +* Monitoring: + * Change: Montitoring remote access changed to use websockets. Refer to Tautulli/Tautulli-Issues#251 for details. +* Notifications: + * Fix: Uploading images to Cloudinary failed for titles with non-ASCII characters on Python 2. + * New: Added plex_id notification parameter. + * Remove: Running .exe files directly using script notifications is no longer supported. + * Remove: php, perl, and ruby prefix overrides for script notifications is no longer supported. + * Change: Stricter checking of file extensions for script notifications. + * Change: Fallback to The Movie Database lookup using title and year. + * Change: Fallback to TVmaze lookup using title. +* UI: + * New: Added ability to import a previous Tautullli configuration file in the settings. + * New: Added a browse button for settings which require a folder or file input. + * New: Added first streamed column to user IP addresses table. (Thanks @dotsam) + * New: Added The Movie Database rating image to media page. + * Change: Different icon to represent direct stream in the history tables. +* API: + * New: Updated API docs for importing a database and configuration file. + + +## v2.5.3 (2020-07-10) + +* History: + * Fix: Unable to delete more than 1000 history entries at the same time. +* Notifications: + * Change: Python script notifications to run using the same Python interpreter as Tautulli. +* Newsletters: + * Fix: Unable to view newsletters with special characters. +* Other: + * Fix: Tautulli failing to start after enabling HTTPS when installed using the Windows / macOS installers. + * Fix: Startup script not working on macOS. + * Fix: Unable to hide dock icon on macOS with the pkg install. Refer to the FAQ regarding the Python rocket dock icon. + * Change: Added path to Python interpreter in system startup (daemon) scripts. + * Change: Added Python version to Google analytics. + + +## v2.5.2 (2020-07-01) + +* Announcements: + * Tautulli now supports Python 3! + * Python 2 is still supported for the time being, but it is recommended to upgrade to Python 3. +* Notifications: + * Fix: Error uploading images to Cloudinary on Python 2. + * Fix: Testing browser notifications alert not disappearing. + * Change: Default recently added notification delay set to 300 seconds. +* UI: + * Fix: MacOS menu bar icon causing Tautulli to fail to start. + * Fix: Unable to login to Tautulli on Python 2. + * New: Windows and MacOS setting to enable Tautulli to start automatically when you login. + * New: Added menu bar icon for MacOS. + * New: Ability to import a Tautulli database in the settings. + * New: Added Tautulli news area on the settings page. + * New: Added platform icon for LG devices. + * Remove: Ability to login to Tautulli using a Plex username and password has been removed. Login using a Plex.tv account is only supported via OAuth. +* Mobile App: + * Fix: Improved API security and validation when registering the Android app. +* Docker: + * Fix: Docker container not respecting the PUID and PGID environment variables. +* Other: + * Fix: Error creating self-signed certificates on Python 3. + * Fix: Tautulli login session cookie not set on the HTTP root path. + * New: Windows and MacOS app installers to install Tautulli without needing Python installed. + + +## v2.2.4 (2020-05-16) + +* Monitoring: + * Fix: Show "None" as the subtitle source on the activity card for user selected subtitles. +* UI: + * Fix: Deleted libraries were showing up on the homepage library cards. + * Fix: Libraries could get stuck as inactive in the database in some instances. +* API: + * Fix: Incorrect title was being returned for the get_history API command. +* Other: + * Fix: Plex remote access check was not being rescheduled after changing the settings. + + +## v2.2.3 (2020-05-01) + +* Notifications: + * Fix: Notification grouping by season/album and show/artist not enabled by default. + * Fix: The rating key notification parameter was being overwritten when 3rd party lookup was enabled. + * Fix: Missing artist value for Musicbrainz lookup in certain situations. + * New: Added notification trigger for Tautulli database corruption. + * New: Added TAUTULLI_PYTHON_VERSION to script notification environment variables. + * New: Added Plex Android / iOS App notification agent. + * New: Added bandwidth notification parameters. + * New: Added user thumb to notification parameters. + * New: Added initial stream notification parameter and threshold setting to determine if a stream is the first stream of a continuous streaming session. + * New: Added Plex remote access notification parameters. + * Change: The file size notification parameter is now reported in SI units. (Thanks @aaronldunlap) +* UI: + * Fix: Delete lookup info from the media info page failing. + * Fix: XBMC platform icon not being redirected to the Kodi platform icon. + * Fix: History table was not being refreshed after deleting entries. + * New: Added icon on the users table to indicate if the user is not on the Plex server. + * New: Added icon on the libraries table to indicate if the library is not on the Plex server. + * Change: Improved deleting libraries so libraries with the same section ID are not also deleted. +* Mobile App: + * Fix: Temporary device token was not being invalidated after cancelling device registration. +* API: + * Fix: Returning XML from the API failing due to unicode characters. + * Fix: Grouping parameter for various API commands not falling back to default setting. + * New: Added time_queries parameter to get_library_watch_time_stats and get_user_watch_time_stats API command. (Thanks @KaasKop97) + * New: Added an "is_active" return value to the get_user, get_users, get_library, and get_libraries API commands which indicates if the user or library is on the Plex server. + * New: Added delete_history API command. + * Change: Added optional parameter for row_ids for delete_library, delete_user, delete_all_library_history, and delete_all_user_history API commands. +* Other: + * Fix: Update failing on CentOS due to an older git version. + * Fix: Manifest file for creating a web app had incorrect info. + * Fix: Auto-updater was not scheduled when enabling the setting unless Tautulli was restarted. + * New: Docker images updated to support ARM platforms. + * Change: Remove the unnecessary optional Plex logs volume from the Docker image. + * Change: Use Plex.tv for GeoIP lookup instead of requiring the MaxMind GeoLite2 database. + + +## v2.2.1 (2020-03-28) + +* Notifications: + * Fix: File size notification parameter incorrectly truncated to an integer. + * Fix: Notification grouping by season/album not enabled by default. + * New: Added transcode decision counts to notification parameters. + * Change: Tags (<>) are no longer stripped from from Webhook notification text. +* Newsletter: + * New: Added favicon to newsletter template when viewing as a web page. +* UI: + * Fix: Username missing from the Synced Items table. + * Fix: Windows system tray icon not enabled by default. + * Fix: Saving a mobile device with a blank friendly name caused an error. + * New: Added IMDb and Rotten Tomato Ratings to info pages. + * New: Added button in settings to delete all 3rd party metadata lookup info in the database. + * New: Added button in settings to flush recently added items in the database. +* API: + * New: Added delete_recenly_added API command to flush recently added items. + * Change: Updated delete_lookup_info API command parameters to allow deleteing all 3rd party metadata lookup info. + + +## v2.2.0 (2020-03-08) + +* Important Note! + * All Live TV changes requires Plex Media Server 1.18.7 or higher. +* Monitoring: + * Fix: Improved IPv6 display on the activity cards. (Thanks @felixbuenemann) + * New: Added Live TV metadata and posters to the activity cards. + * Change: Show bandwidth in Gbps when greater than 1000 Mbps. +* History: + * New: Added history logging for Live TV sessions. + * New: Added a fake "Live TV" library to collect Live TV history. + * Note: This library will show up the first time that Live TV is played. + * New: Added the ability to filter history by Live TV. +* Graphs: + * New: Added Live TV series to the "Plays by Period" and "Play Totals" graphs. + * Change: Media type series on the graphs are only shown if the corresponding library type is present. +* Notifications: + * Fix: Race condition causing stream count to be incorrect for playback stop notifications. + * New: Added Live TV channel notification parameters. + * New: Added Plex background art notification parameter. + * Note: This is the Plex API endpoint to retrieve the background art, not the actual image. + * New: Added poster images for clip notifications. + * Change: Default Webhook notification method to POST. +* UI: + * Fix: Windows platform showing up twice on the Most Active Platforms statistics card. + * New: Added option to change the background art for library sections when editing a library. + * New: Added button to reset Tautulli git installation in settings to fix failed git updates. +* API: + * New: Added ability to filter history using a "live" media type and by guid for the get_history API command. + * New: Added cutsom_art parameter to the edit_library API command. +* Other: + * Change: Add crossorigin use-credentials attribute to manifest tags. (Thanks @pkoenig10) + * Change: Disable automatic updates for Docker containers. Updates are now handled by updating the Docker container. + * Note: If you are using an old Docker container created before v2.2.0, then you may need to completely remove and recreate the container to update for the first time. + * Note: Use the ":latest" Docker tag for the newest stable release, or the ":beta" or ":nightly" tags to access the beta or nightly branches. + + +## v2.1.44 (2020-02-05) + +* Monitoring: + * Fix: SDR source video being identified as HDR stream video. +* Notifications: + * Fix: Unable to select condition operator for video color parameters. +* UI: + * Fix: Capitalization for platforms on history tables. + + +## v2.1.43 (2020-02-03) + +* Monitoring: + * New: Added HDR indicator on activity card. + * New: Added dynamic range to history steam info modal. +* Notifications: + * Fix: Webhook notification body sent as incorrect data type when Content-Type header is overridden. + * Fix: Telegram notification character limit incorrect for unicode characters. + * New: Added color and dynamic range notification parameters. +* Newsletters: + * Fix: Episodes and Albums plural spelling on recently added newsletter section headers. +* UI: + * Fix: Windows and macOS platform capitalization. + * Fix: Season number 0 not shown for episodes on history tables. +* Other: + * Change: Mask email addresses in logs. + * Change: Update deprecated GitHub access token URL parameter to Authorization header. + + +## v2.1.42 (2020-01-04) + +* Other: + * Fix: SSL certificate error when installing GeoLite2 database. + * Change: Verify MaxMind license key and GeoLite2 database path before installing. + * Change: Disable GeoLite2 database uninstall button when it is not installed. + + +## v2.1.41 (2019-12-30) + +* Other: + * Fix: Failing to extract the GeoLite2 database on Windows. + + +## v2.1.40 (2019-12-30) + +* UI: + * Change: Moved 3rd Party API settings to new tab in the settings. +* Graphs: + * Change: Improve calculating month ranges for Play Totals graphs. +* Other: + * Fix: Failing to verify a Plex Media Server using a hostname. + * Change: A license key is now required to install the MaxMind GeoLite2 database for IP geolocation. Please follow the guide in the wiki to reinstall the GeoLite2 database. + * Change: The GeoLite2 database will now automatically update periodically if installed. + + +## v2.1.39 (2019-12-08) + +* UI: + * New: Added creating admin username and password to setup wizard. +* API: + * Change: Remove default notification subject and body for notify API command. +* Other: + * Change: Check for database corruption when making backup. + + +## v2.1.38 (2019-11-17) + +* Notifications: + * New: Added custom JSON headers to the webhook notification agent. +* UI: + * Fix: Homepage recently watched card not showing grouped history. +* Other: + * New: Added GitHub sponsor donation option. + * Change: Improve resolving hostnames. + + +## v2.1.37 (2019-10-11) + +* Notifications: + * Fix: Last.fm URLs linking to artist page instead of the album page. + * New: Added option for MusicBrainz lookup for music notifications. Option must be enabled under 3rd Party APIs in the settings. + * New: Added MusicBrainz ID and MusicBrainz URL notification parameters. + * Change: Automatically truncate Discord description summary to 2048 characters. + + +## v2.1.36-beta (2019-10-05) + +* Monitoring: + * Fix: Activity card title not updating after pre-rolls or auto-play. +* History: + * Fix: Display correct interlaced or progressive video scan type on stream data modal. +* Graphs: + * New: Separate interlaced and progressive video scan type on source and stream resolution graphs. +* API: + * New: Added parent_guid and grandparent_guid to get_activity and get_metadata commands. + + +## v2.1.35-beta (2019-09-24) + +* Monitoring: + * Fix: Audio shown as blank on activity cards when changing audio tracks during direct play. + * Fix: Display correct interlaced or progressive video scan type on activity cards. + * New: Added flag for Nvidia hardware decoding on activity cards. +* Notifications: + * Fix: Notification parameter prefix and suffix were not substituted correctly. + * Fix: Release Date notification parameter was incorrectly casted to an integer instead of a string. + * New: Added video scan type and full resolution notification parameters. +* UI: + * Fix: Movies with the same title but different year being grouped on the homepage stats cards. +* API: + * New: Added video scan type and full resolution values to get_activity command. +* Other: + * Fix: Tautulli logging out every time after saving settings and restarting. + + +## v2.1.34 (2019-09-03) + +* History: + * New: Added Product column to history tables. +* Notifications: + * Fix: IMDB/TMDb/TVDB/TVmaze ID notification parameters showing blank values after lookup. +* UI: + * Fix: Libraries and Users tables did not respect the group history setting. +* API: + * Fix: Title field was not searchable in get_library_media_info command. + * New: Added grouping option to get_libraries_table and get_users_table commands. + * New: Added product value to get_history command. +* Other: + * Fix: Could not verify Plex Media Server with unpublished hostnames. + * Change: Automatically logout all Tautulli instances when changing the admin password. + + +## v2.1.33 (2019-07-27) + +* Notifications: + * Change: Mask notification agent password fields. + * Change: Enable searching by email address in dropdown menu. +* Other: + * Fix: Version number being overwritten with "None" which prevented updating in some instances. + * Change: Update Plex OAuth request headers. + + +## v2.1.32 (2019-06-26) + +* Newsletters: + * Fix: Newsletter scheduler issue for QNAP devices using an invalid "local" timezone preventing Tautulli from starting. + + +## v2.1.31 (2019-06-24) + +* No additional changes from v2.1.31-beta. + + +## v2.1.31-beta (2019-06-13) + +* Monitoring: + * Fix: Synced content showing incorrect stream info. +* Other: + * Fix: Unable to view database status when authentication is enabled. + * Change: Default database synchronous mode changed to prevent database corruption. Database response may be slower. + + +## v2.1.30-beta (2019-05-11) + +* Monitoring: + * Fix: Activity crashing with Plex's Artist TV feature. + * New: Added setting for Plex Media Server Update Check Interval. (Thanks @abiacco) +* Notifications: + * New: Added secure and relayed connection notification parameters. + * New: Added PLEX_USER_TOKEN to script environment variables. + * Change: Schedule notifications using UTC to prevent missing notifications due to misconfigured timezones. +* API: + * New: Added status API command to check the status of Tautulli. + + +## v2.1.29 (2019-05-11) + +* No additional changes from v2.1.29-beta. + + +## v2.1.29-beta (2019-04-14) + +* Monitoring: + * Change: "Required Bandwidth" changed to "Reserved Bandwidth" in order to match the Plex dashboard. +* Notifications: + * New: Added prefix and suffix notification text modifiers. See the "Notification Text Modifiers" help modal for details. +* UI: + * New: Added "Undelete" button to the edit library and edit user modals. + * Fix: User IP address history table showing incorrect "Last Seen" values. +* API: + * Fix: Search API only returning 3 results. + * Fix: Terminate stream API failing when both session_key and session_id were provided. + * Change: Improved API response HTTP status codes and error messages. + + +## v2.1.28 (2019-03-10) + +* Monitoring: + * New: Added secure/insecure connection icon on the activity cards. Requires Plex Media Server v1.15+. +* Other: + * Change: Improved mass deleting of all images from Cloudinary. Requires all previous images on Cloudinary to be manually tagged with "tautulli". New uploads are automatically tagged. + + +## v2.1.27-beta (2019-03-03) + +* Monitoring: + * Fix: Error when playing synced optimized versions. + * Change: Show message to complete the setup wizard instead of error communicating with server message. + * Change: URL changed on Plex.tv for Plex Media Server beta updates. +* Notifications: + * New: Show the media type exclusion tags in the text preview modal. + * Fix: Unicode error in the Email notification failed response message. + * Fix: Error when a notification agent response is missing the "Content-Type" header. +* UI: + * Fix: Usernames were not being sanitized in dropdown selectors. + * Change: Different display of "All" recently added items on the homepage due to change in the Plex Media Server v1.15+ API. +* API: + * New: Added current Tautulli version to update_check API response. + * Change: API no longer returns sanitized HTML response data. +* Other: + * New: Added auto-restart to systemd init script. + * Fix: Patreon donation URL. + * Remove: Crypto donation options. + + +## v2.1.26 (2018-12-01) + +* Monitoring: + * Fix: Resume event not being triggered after buffering. +* Notifications: + * New: Added user email as a notification parameter. +* Graphs: + * Fix: History model showing no results for stream info graph. +* API: + * Fix: API returning error when missing a cmd. + + +## v2.1.25 (2018-11-03) + +* Monitoring: + * Fix: Audio and video codec showing up as * on the activity cards. + * New: Poster and background image on the activity cards for live TV. +* UI: + * Fix: Alert message for invalid Tautulli Public Domain setting. + + +## v2.1.24-beta (2018-10-29) + +* Monitoring: + * Fix: Transcode change events creating invalid sessions in the database. +* Notifications: + * Change: Update Telegram character limit to 1024. +* History: + * Fix: Save history table states separately for multiple Tautulli instances. +* Graphs: + * Fix: Save graphs states separately for multiple Tautulli instances. + * Change: Version graphs to bypass browser cache. +* UI: + * New: Added queued tasks modals to the scheduled tasks table for debugging. +* Other: + * Change: Updated timezone info and display in configuration table. + + +## v2.1.23-beta (2018-10-14) + +* Monitoring: + * Fix: Buffer events not being triggered properly. + * Fix: Watched progress sometimes not saved correctly. (Thanks @Sheigutn) +* Notifications: + * New: Added notification trigger for transcode decision change. + * Fix: Multiple buffer notifications being triggered within the same second. + * Change: Default buffer notification threshold changed to 10 for buffer thresholds less than 10. +* Newsletter: + * New: Added Other Video libraries to the newsletter. +* Homepage: + * New: Added Other Video type to recently added on the homepage. + * Change: Save homepage recently added media type toggle state. + * Change: Save homepage stats config to local storage instead of the server. +* History: + * Change: Save history table media type toggle state. +* Graphs: + * Change: Save series visibility state when toggling the legend. + * Change: Save graph config to local storage instead of the server. +* UI: + * New: Show the remote app device token and id in the edit device modal. + * Change: Lock certain settings if using the Tautulli docker container. +* API: + * Fix: download_config, download_database, download_log, and download_plex_log API commands not working. + * Change: get_recently_added command 'type' parameter renamed to 'media_type'. Backwards compatibility is maintained. + * Change: get_home_stats command 'stats_type' parameter change to string 'plays' or 'duration'. Backwards compatibility is maintained. + + +## v2.1.22 (2018-10-05) + +* Notifications: + * Fix: Notification agent settings not loading when failed to retrieve some data. +* UI: + * Fix: Incorrectly showing localhost server in the setup wizard. +* Other: + * Fix: Incorrect redirect to HTTP when HTTPS proxy header is present. + * Fix: Websocket not connecting automatically after the setup wizard. + + +## v2.1.21 (2018-09-21) + +* Notifications: + * Fix: Content Rating notification condition always evaluating to True. (Thanks @Arcanemagus) + * Fix: Script arguments not showing substituted values in the notification logs. +* UI: + * New: Unsupported browser warning when using IE or Edge. + * Fix: Misaligned refresh image icon in album search results. (Thanks @Sheigutn) + * Fix: Music history showing as pre-Tautulli in stream info modal. +* Other: + * Fix: Typo in Systemd init script group value. (Thanks @ldumont) + * Fix: Execute permissions in Fedora/CentOS and Systemd init scripts. (Thanks @wilmardo) + * Fix: Systemd init script instructions per Linux distro. (Thanks @samwiseg00) + * Change: Fallback to Tautulli data directory if logs/backup/cache/newsletter directories are not writable. + * Change: Check for alternative reverse proxy headers if X-Forwarded-Host is missing. + + +## v2.1.20 (2018-09-05) + +* No additional changes from v2.1.20-beta. + + +## v2.1.20-beta (2018-09-02) + +* Monitoring: + * Fix: Fetch messing season info when "Hide Seasons" is enabled for a show. + * Fix: Video and Audio details sometimes missing on activity cards. +* Notifications: + * New: Added UTC timestamp to notification parameters. (Thanks @samwiseg00) + * New: Added TAUTULLI_PUBLIC_URL to script environment variables. (Thanks @samwiseg00) +* UI: + * Change: Automatically redirect '/' to HTTP root if enabled. +* API: + * New: Added return_hash parameter to pms_image_proxy command. + * New: Added session_id parameter to get_activity command. +* Other: + * Change: Linux systemd startup script to use the "tautulli" group permission. (Thanks @samwiseg00) + + +## v2.1.19-beta (2018-08-19) + +* Notifications: + * New: Added Webhook notification agent. + * Fix: Scripts failing due to unicode characters in substituted script arguments. + * Change: Ability to override PYTHONPATH for scripts. + * Remove: Notify My Android notification agent. +* Newsletters: + * New: Added option for threaded newsletter emails. + * Fix: Missing space in newsletter format. +* UI: + * New: Added Windows system tray icon. + * Fix: Plex OAuth not working with Plex remote access disabled. (Thanks @samwiseg00) +* API: + * Fix: SQL command creating a database backup every time. (Thanks @samwiseg00) + + +## v2.1.18 (2018-07-27) + +* Monitoring: + * Fix: Progress bar on activity cards showing incorrect 100% when starting a stream. +* Notifications: + * Fix: Notification text boxes scrolling to top when inputting text. + * Change: Skip formatting invalid notification parameters instead of returning default text. +* UI: + * Fix: Padding around search bar causing the navigation bar to break on smaller screens. + + +## v2.1.17-beta (2018-07-22) + +* Notifications: + * Change: Use default selected stream for media info in notifications. +* UI: + * New: Automatically discover localhost Plex servers in server selection dropdown. + * Change: Save Datatables state indefinitely. + + +## v2.1.16-beta (2018-07-06) + +* Monitoring: + * Fix: Plex server not detected as down during sudden network loss. +* Notifications: + * Fix: Incorrect rounding of percentages in some cases. + * Fix: Incorrect stream duration value for playback start notifications. + * New: Added critic rating parameter for Rotten Tomatoes ratings. +* Newsletters: + * Fix: Typo in "seasons" when there is only one additional season. +* UI: + * New: Added ability to use Plex OAuth to login to Tautulli. +* API: + * Fix: Unicode characters causing get_logs command to return bad data. + * New: Added rating_image and audience_rating_image to get_activity and get_metadata commands. + + +## v2.1.15-beta (2018-07-01) + +* Monitoring: + * Fix: Progress percent displaying NaN for live TV. + * Fix: Unable to terminate sessions with unicode characters in the message. + * Change: Tizen platform to display the Samsung icon. +* Notifications: + * New: Added PYTHONPATH to script environment variables so scripts can automatically import from Tautulli libraries. + * Fix: Proper handling of unicode script arguments. + * Fix: Incorrect TAUTULLI_URL environment variable if the HTTP host setting is changed. + * Fix: Email addresses selectize box not expanding. +* Newsletters: + * Change: HTTPS URLS for images hosted on tautulli.com. +* Graphs: + * Fix: SD resolution sometimes not grouped together. + + +## v2.1.14 (2018-06-21) + +* Notifications: + * Fix: Parsing script arguments in quotes. +* UI: + * Fix: Slow loading due to Font Awesome 5 javascript. + * Change: Play counts on user an library pages now respect the history grouping setting. +* API: + * New: Added optional grouping parameter to user and library watch statistics. + + +## v2.1.13 (2018-06-16) + +* Monitoring: + * Fix: Soft crash when viewing photos not in an album. +* Notifications: + * New: Added current date and time notification parameters. +* UI: + * New: Added support page with embedded Discord chat using WidgetBot. + + +## v2.1.12 (2018-06-08) + +* Notifications: + * Change: Blank notification link source means disabled instead of default. +* Newsletters: + * New: Make collection tags available in the raw newsletter data for custom templates. +* API: + * New: Ability to terminate a stream using the session key. + + +## v2.1.11-beta (2018-06-02) + +* Monitoring: + * Fix: Activity progress bar not updating in some cases. + * Fix: Monitory Remote Access setting disabled due to Plex Media Server API changes. + * Change: Improved logic for grouping history items without being successive plays. +* Notifications: + * New: Added filename to notification parameters. +* Other: + * Fix: Update metadata failing for tracks without track numbers. + + +## v2.1.10-beta (2018-05-28) + +* Monitoring: + * Fix: Improved monitoring of live tv sessions. + * Change: Use track artist instead of album artist. +* Notifications: + * New: Added timestamp to Discord notification embeds. (Thanks @samwiseg00) + * New: Enable notifications for "clip" media types. + * Fix: Actually add the "live" notification parameter. + * Change: Update Twitter for 280 characters. + * Change: Use HTTPS url for Cloudinary images. +* Newsletters: + * Fix: Artist summaries not showing up on newsletter cards. + * Change: Do not send the newsletter if the template fails to render. + + +## v2.1.9 (2018-05-21) + +* Notifications: + * New: Added "live" to notification parameters. + + +## v2.1.8-beta (2018-05-19) + +* Newsletters: + * New: Added authentication options for self-hosted newsletters. + * Change: Check if the Tautulli footer has been removed in custom newsletter templates. +* Notifications: + * Fix: Cloudinary images not working for Twitter notifications. +* API: + * Fix: Return proper HTTP status codes for errors. + + +## v2.1.7-beta (2018-05-13) + +* Newsletters: + * New: Option to toggle between inline or internal CSS style templates. + * New: Button to delete all uploaded images from Imgur/Cloudinary. + * Fix: Long titles overflowing the newsletter cards. + * Change: Self-hosted images on newsletters to use the /image endpoint instead of proxying through /newsletter/image. + * Change: Strip whitespace from newsletter for smaller file size before sending to email. +* API: + * New: Added get_stream_data command to API. + * New: Added newsletter API commands to documentation. + + +## v2.1.6-beta (2018-05-09) + +* Newsletters: + * Change: Setting to specify static URL ID name instead of using the newsletter ID number. + * Change: Reorganize newsletter config options. + + +## v2.1.5-beta (2018-05-07) + +* Newsletters: + * New: Added setting for a custom newsletter template folder. + * New: Added option to enable static newsletter URLs to retrieve the last sent scheduled newsletter. + * New: Added ability to change the newsletter output directory and filenames. + * New: Added option to save the newsletter file without sending it to a notification agent. + * Fix: Check for disabled image hosting setting. + * Fix: Cache newsletter images when refreshing the page. + * Fix: Refresh image from the Plex server when uploading to image hosting. + * Change: Allow all image hosting options with self-hosted newsletters. +* UI: + * Change: Don't retrieve recently added on the homepage if the Plex Cloud server is sleeping. +* Other: + * Fix: Imgur database upgrade migration. + + +## v2.1.4 (2018-05-05) + +* Newsletters: + * Fix: Newsletter URL without an HTTP root. + + +## v2.1.3-beta (2018-05-04) + +* Newsletters: + * Fix: HTTP root doubled in newsletter URL. + * Fix: Configuration would not open with failed hostname resolution. + * Fix: Schedule one day off when using weekday names in cron. + * Fix: Images not refreshing when changed in Plex. + * Fix: Cloudinary upload with non-ASCII image titles. +* Other: + * Fix: Potential XSS vulnerability in search. + + +## v2.1.2-beta (2018-05-01) + +* Newsletters: + * New: Added Cloudinary option for image hosting. +* Notifications: + * New: Added Message-ID to Email header (Thanks @Dam64) + * Fix: Posters not showing up on Twitter with self-hosted images. + * Fix: Incorrect action parameter for new device notifications. + * Change: Hardcode Pushover sound list instead of fetching the list every time. +* API: + * Fix: Success result for empty response data. + * Change: Do not send notification when checking for Tautulli updates via the API. + + +## v2.1.1-beta (2018-04-11) + +* Monitoring: + * Fix: Live TV transcoding showing incorrectly as direct play. +* Newsletters: + * New: Added week number as parameter. (Thanks @samip5) + * Fix: Fallback to cover art on the newsletter cards. + * Change: Option to set newsletter time frame by calendar days or hours. +* Notifications: + * New: Added week number as parameter. (Thanks @samip5) +* Other: + * New: Added plexapi library for custom scripts. + + +## v2.1.0-beta (2018-04-07) + +* Newsletters: + * New: A completely new scheduled newsletter system. + * Beautiful HTML formatted newsletter for recently added movies, TV shows, or music. + * Send newsletters on a daily, weekly, or monthly schedule to your users. + * Customize the number of days of recently added content and the libraries to include on the newsletter. + * Add a custom message to be included on the newsletter. + * Option to either send an HTML formatted email, or a link to a self-hosted newsletter on your own domain to any notification agent. +* Notifications: + * New: Ability to use self-hosted images on your own domain instead of using Imgur. + + +## v2.0.28 (2018-04-02) + +* Monitoring: + * Fix: Homepage activity header text. + + +## v2.0.27 (2018-04-02) + +* Monitoring: + * Change: Move activity refresh interval setting to the settings page. + + +## v2.0.26-beta (2018-03-30) + +* Monitoring: + * New: Setting to change the refresh interval on the homepage. + * Fix: Identify extras correctly on the activity cards. +* Notifications: + * Change: Send Telegram image and text separately if the caption is longer than 200 characters. +* UI: + * Fix: Error when clicking on synced playlist links. + + +## v2.0.25 (2018-03-22) + +* Monitoring: + * Fix: Websocket not reconnecting causing activity monitoring and notifications to not work. + * Fix: Error checking for synced streams without Plex Pass. + + +## v2.0.24 (2018-03-18) + +* Monitoring: + * Fix: Fix stream data not showing for history recorded before v2. +* Notifications: + * Fix: Set all environment variables for scripts. + * Change: Moved all notification agent instructions to the wiki. + * Change: XBMC notification agent renamed to Kodi. + * Change: OSX Notify notification agent renamed to macOS Notification Center. + + +## v2.0.23-beta (2018-03-16) + +* Monitoring: + * Fix: Certain transcode stream showing incorrectly as direct play in history. Fix is not retroactive. +* Notifications: + * New: Added season/episode/album/track count to notification parameters. + * New: Added "Value 3" setting for IFTTT notifications. + * New: Set PLEX_URL, PLEX_TOKEN, TAUTULLI_URL, and TAUTULLI_APIKEY environment variables for scripts. + * Fix: Notifications failing to send with invalid custom conditions json. + * Fix: Email notifications failing with unicode username/passwords. + * Change: Facebook Graph API version updated to v2.12. +* UI: + * New: Show the Plex Server URL in the settings. + * Fix: Incorrect info displayed in the Tautulli login logs. +* API: + * Fix: API returning empty data if a message was in the original data. + * Change: get_server_id command returns json instead of string. +* Other: + * Fix: Forgot git pull when changing branches in the web UI. + + +## v2.0.22 (2018-03-10) + +* Tautulli v2 release! + + +## v2.0.22-beta (2018-03-09) + +* Notifications: + * Fix: Pushover notifications failing with priority 2 is set. + * Fix: Expanding selectize box for some notification agent settings. +* Other: + * Fix: Update check failing when an update is available. + * Fix: Item count incorrect for photo libraries. + + +## v2.0.21-beta (2018-03-04) + +* Monitoring: + * New: Identify if a stream is using Plex Relay. + * Change: Don't ping the Plex server if the websocket is disconnected. +* Notifications: + * Fix: Pause/resume state not being sent correctly in some instances. +* Other: + * New: Add Patreon donation method. + * Fix: Catch failure to send analytics. + * Fix: IP address connection lookup error when the country is missing. + * Change: Updated all init scripts to Tautulli. + * Change: Move database to tautulli.db. + * Change: Move logs to tautulli.log. + * Change: Move startup file to Tautulli.py. + + +## v2.0.20-beta (2018-02-24) + +* Notifications: + * New: Add poster support for Pushover notifications. + * New: Add poster support for Pushbullet notifications. + * Fix: Incorrect Plex/Tautulli update notification parameter types. + * Change: Poster and text sent as a single message for Telegram. + * Change: Posters uploaded directly to Telegram without Imgur. +* UI: + * New: Add "Delete" button to synced items table on user pages. + * Fix: Button spacing/positioning on mobile site. + * Fix: Music statistic cards not using the fallback thumbnail. + * Fix: Logo not showing up when using an SVG. + * Change: Graphs now respect the "Group History" setting. +* API: + * New: Add grouping to graph API commands. +* Other: + * New: Added Google Analytics to collect installation metrics. + * Fix: Reconnecting to the Plex server when server settings are not changed. + + +## v2.0.19-beta (2018-02-16) + +* Monitoring: + * Fix: Connect to Plex Cloud server without keeping it awake. + * Fix: Reconnect to Plex Cloud server after the server wakes up from sleeping. +* Notifications: + * Fix: Don't send Plex Server Up/Down notifications when Tautulli starts up. + * Change: Better handling of Watched notifications. +* UI: + * New: Added Plex server selection dropdown in the settings. + * Fix: Libraries and Users tables not refreshing properly. + * Change: Updated the masked info shown to guests. + * Change: Check for updates without refreshing to the homepage. +* API: + * New: Added update_check to the API. + * Fix: delete_media_info_cache not deleting the cache. + * Change: Document "refresh" parameter for get_library_media_info. +* Other: + * Fix: Show the full changelog since v2 on a fresh install. + + +## v2.0.18-beta (2018-02-12) + +* Notifications: + * Fix: Default text for Tautulli update notifications using the wrong parameter. + * Fix: Playback pause and resume notifications only triggering once. + * Change: Negative operators for custom conditions now use "and" instead of "or". +* UI: + * New: Added button to delete the 3rd party lookup info from the info pages. + * Fix: Missing host info in the login logs when logging in using Firefox. + * Change: Cleaned up settings. Advanced settings are now hidden behind a toggle. +* API: + * New: Updated API documentation for v2. +* Other: + * Fix: DeprecationWarning when using HTTPS with self-signed certificates. + * Change: Deleting the Imgur poster URL also deletes the poster from Imgur (only available for new uploads). + * Change: GitHub repository moved to Tautulli/Tautulli. Old GitHub URLs will still work. + + +## v2.0.17-beta (2018-02-03) + +* Notifications: + * Fix: Unable to use @ mentions tags for Discord and Slack. + * New: Added Zapier notification agent. +* API: + * Fix: get_synced_items returning no results. + * Fix: get_library_media_info returning incorrect media type for photo albums. + * Fix: get_library_media_info not being able to sort by title. + + +## v2.0.16-beta (2018-01-30) + +* Monitoring: + * Fix: Timestamp sometimes showing as "0:60" on the activity cards. + * Fix: Incorrect session information being shown for playback of synced content. + * Fix: Sessions not being stopped when "Playback Stopped" notifications were enabled. +* UI: + * Fix: Stream resolution showing up as "unknown" on the graphs. + * New: Added user filter to the Synced Items table. +* Other: + * New: Option to use the Plex server update channel when checking for updates. + + +## v2.0.15-beta (2018-01-27) + +* Monitoring: + * Fix: Live TV sessions not being stopped in History. + * Fix: Stream location showing as "unknown" on the activity cards. + * New: Improved Live TV details on the activity cards. +* Notifications: + * New: Added labels and collections to notification parameters. + * New: Added more server details to notification parameters. + * Change: Renamed "PlexPy" update notification parameters to "Tautulli". + + +## v2.0.14-beta (2018-01-20) + +* Monitoring: + * Change: Added "Cellular" bandwidth to "WAN" in activity header. +* Notifications: + * Fix: Plex Web URL for tracks now go to the album page. + * Fix: Recently added notifications being sent for the entire library when DVR EPG data was refreshed. + * Fix: Notifier settings not loading with an apostrophe in the custom condition values. + * Fix: Custom email addresses not being saved when closing the notifier settings. + * Change: Re-enabled Browser notifications. + * Change: Renamed "PlexPy" update notification parameters to "Tautulli". + * Change: Emails no longer automatically insert HTML line breaks. + * Change: "Date" header added to email notifications. +* UI: + * Change: Show all changelogs since the previous version when updating. + + +## v2.0.13-beta (2018-01-13) + +* Notifications: + * New: Added dropdown selection for email addresses of shared users. + * New: Added more notification options for Join. + * Change: Show "OR" between custom condition values. +* Other: + * New: Use JSON Web Tokens for authentication. Login now works with SSO applications. + * New: Allow the Plex server admin to login as a Tautulli admin using their Plex.tv account. + + +## v2.0.12-beta (2018-01-07) + +* Notifications: + * Fix: Incorrect Plex URL parameter value. + * Change: Custom condition logic is now optional. An implicit "and" is applied between all conditions if the logic is blank. +* UI: + * New: Added separate required LAN/WAN bandwidth in the activity header. +* API: + * Fix: Notify API command not sending notifications. + + +## v2.0.11-beta (2018-01-05) + +* Notifications: + * Fix: Some notification parameters showing up blank. +* UI: + * Fix: Stream data showing up as "None" for pre-v2 history. +* Other: + * Fix: Ability to login using the hashed password. + + ## v2.0.10-beta (2018-01-04) * Monitoring: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b283b2e6..46a644e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,61 +1,20 @@ -# Contributing to PlexPy - -## Issues -In case you read this because you are posting an issue, please take a minute and conside the things below. The issue tracker is not a support forum. It is primarily intended to submit bugs. However, we are glad to help you, and make sure the problem is not caused by PlexPy, but don't expect step-by-step answers. - -##### Many issues can simply be solved by: - -- Making sure you update to the latest version. -- Turning your device off and on again. -- Analyzing your logs, you just might find the solution yourself! -- Using the **search** function to see if this issue has already been reported/solved. -- Checking the [Wiki](https://github.com/JonnyWong16/plexpy/wiki) for -[ [Installation] ](https://github.com/JonnyWong16/plexpy/wiki/Installation) and -[ [FAQs] ](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)). -- For basic questions try asking on [Gitter](https://gitter.im/plexpy/general) or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue. - -##### If nothing has worked: - -1. Open a new issue on the GitHub [issue tracker](http://github.com/JonnyWong16/plexpy/issues). -2. Provide a clear title to easily help identify your problem. -3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks). -4. Make sure you provide the following information: - - [ ] Version - - [ ] Branch - - [ ] Commit hash - - [ ] Operating system - - [ ] Python version - - [ ] What you did? - - [ ] What happened? - - [ ] What you expected? - - [ ] How can we reproduce your issue? - - [ ] What are your (relevant) settings? - - [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). -5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. - -## Feature Requests - -Feature requests are handled on [FeatHub](http://feathub.com/JonnyWong16/plexpy). - -1. Search the existing requests to see if your suggestion has already been submitted. -2. If a similar request exists, give it a thumbs up (+1), or add additional comments to the request. -3. If no similar requests exist, you can create a new one. Make sure to provide a clear title to easily identify the feature request. +# Contributing to Tautulli ## Pull Requests -If you think you can contribute code to the PlexPy repository, do not hesitate to submit a pull request. +If you think you can contribute code to the Tautulli repository, do not hesitate to submit a pull request. ### Branches -All pull requests should be based on the `dev` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/dev -b FEATURE_NAME`. Use meaningful commit messages. +All pull requests should be based on the `nightly` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/nightly -b FEATURE_NAME`. Use meaningful commit messages. ### Python Code #### Compatibility -The code should work with Python 2.6 and 2.7. Note that PlexPy runs on different platforms, including Network Attached Storage devices such as Synology. +The code should work with Python 3.8+. Note that Tautulli runs on many different platforms. Re-use existing code. Do not hesitate to add logging in your code. You can the logger module `plexpy.logger.*` for this. Web requests are invoked via `plexpy.request.*` and derived ones. Use these methods to automatically add proper and meaningful error handling. #### Code conventions -Although PlexPy did not adapt a code convention in the past, we try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you (copied from http://wiki.ros.org/PyStyleGuide): +Although Tautulli did not adopt a code convention in the past, we try to follow [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you (copied from http://wiki.ros.org/PyStyleGuide): * 4 space indentation * 80 characters per line @@ -70,16 +29,13 @@ Although PlexPy did not adapt a code convention in the past, we try to follow th #### Documentation Document your code. Use docstrings See [PEP-257](https://www.python.org/dev/peps/pep-0257/) for more information. -#### Continuous Integration -PlexPy has a configuration file for [travis-ci](https://travis-ci.org/). You can add your forked repo to Travis to have it check your code against PEP8, PyLint, and PyFlakes for you. Your pull request will show a green check mark or a red cross on each tested commit, depending on if linting passes. - ### HTML/Template code #### Compatibility -HTML5 compatible browsers are targetted. There is no specific mobile version of PlexPy yet. +HTML5 compatible browsers are targeted. #### Conventions * 4 space indentation * `methodName` * `variableName` -* `ClassName` \ No newline at end of file +* `ClassName` diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..8d8c324b --- /dev/null +++ b/Dockerfile @@ -0,0 +1,28 @@ +FROM ghcr.io/tautulli/tautulli-baseimage:python3 + +LABEL maintainer="Tautulli" + +ARG BRANCH +ARG COMMIT + +ENV TAUTULLI_DOCKER=True +ENV TZ=UTC + +WORKDIR /app +COPY . /app +RUN \ + groupadd -g 1000 tautulli && \ + useradd -u 1000 -g 1000 tautulli && \ + echo ${BRANCH} > /app/branch.txt && \ + echo ${COMMIT} > /app/version.txt + +RUN \ + mkdir /config && \ + touch /config/DOCKER +VOLUME /config + +CMD [ "python", "Tautulli.py", "--datadir", "/config" ] +ENTRYPOINT [ "./start.sh" ] + +EXPOSE 8181 +HEALTHCHECK --start-period=90s CMD curl -ILfks https://localhost:8181/status > /dev/null || curl -ILfs http://localhost:8181/status > /dev/null || exit 1 diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 1ac80899..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,41 +0,0 @@ - - -**Version:** - -**Branch:** - -**Commit hash:** - -**Operating system:** - -**Python version:** - -**What you did?** - -**What happened?** - -**What you expected?** - -**How can we reproduce your issue?** - - -**What are your (relevant) settings?** - -**Link to logs:** - - - diff --git a/PlexPy.py b/PlexPy.py index bcc17654..eb9ceea4 100755 --- a/PlexPy.py +++ b/PlexPy.py @@ -1,8 +1,4 @@ -#!/bin/sh -''''which python >/dev/null 2>&1 && exec python "$0" "$@" # ''' -''''which python2 >/dev/null 2>&1 && exec python2 "$0" "$@" # ''' -''''which python2.7 >/dev/null 2>&1 && exec python2.7 "$0" "$@" # ''' -''''exec echo "Error: Python not found!" # ''' +#!/usr/bin/env python # -*- coding: utf-8 -*- @@ -21,246 +17,8 @@ # You should have received a copy of the GNU General Public License # along with Tautulli. If not, see . -import os -import sys +from Tautulli import main -# Ensure lib added to path, before any other imports -sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'lib/')) - -import argparse -import locale -import signal -import time - -import plexpy -from plexpy import config, database, logger, web_socket, webstart - - -# Register signals, such as CTRL + C -signal.signal(signal.SIGINT, plexpy.sig_handler) -signal.signal(signal.SIGTERM, plexpy.sig_handler) - - -def main(): - """ - Tautulli application entry point. Parses arguments, setups encoding and - initializes the application. - """ - - # Fixed paths to Tautulli - if hasattr(sys, 'frozen'): - plexpy.FULL_PATH = os.path.abspath(sys.executable) - else: - plexpy.FULL_PATH = os.path.abspath(__file__) - - plexpy.PROG_DIR = os.path.dirname(plexpy.FULL_PATH) - plexpy.ARGS = sys.argv[1:] - - # From sickbeard - plexpy.SYS_PLATFORM = sys.platform - plexpy.SYS_ENCODING = None - - try: - locale.setlocale(locale.LC_ALL, "") - plexpy.SYS_ENCODING = locale.getpreferredencoding() - except (locale.Error, IOError): - pass - - # for OSes that are poorly configured I'll just force UTF-8 - if not plexpy.SYS_ENCODING or plexpy.SYS_ENCODING in ('ANSI_X3.4-1968', 'US-ASCII', 'ASCII'): - plexpy.SYS_ENCODING = 'UTF-8' - - # Set up and gather command line arguments - parser = argparse.ArgumentParser( - description='A Python based monitoring and tracking tool for Plex Media Server.') - - parser.add_argument( - '-v', '--verbose', action='store_true', help='Increase console logging verbosity') - parser.add_argument( - '-q', '--quiet', action='store_true', help='Turn off console logging') - parser.add_argument( - '-d', '--daemon', action='store_true', help='Run as a daemon') - parser.add_argument( - '-p', '--port', type=int, help='Force Tautulli to run on a specified port') - parser.add_argument( - '--dev', action='store_true', help='Start Tautulli in the development environment') - parser.add_argument( - '--datadir', help='Specify a directory where to store your data files') - parser.add_argument( - '--config', help='Specify a config file to use') - parser.add_argument( - '--nolaunch', action='store_true', help='Prevent browser from launching on startup') - parser.add_argument( - '--pidfile', help='Create a pid file (only relevant when running as a daemon)') - parser.add_argument( - '--nofork', action='store_true', help='Start Tautulli as a service, do not fork when restarting') - - args = parser.parse_args() - - if args.verbose: - plexpy.VERBOSE = True - if args.quiet: - plexpy.QUIET = True - - # Do an intial setup of the logger. - logger.initLogger(console=not plexpy.QUIET, log_dir=False, - verbose=plexpy.VERBOSE) - - if args.dev: - plexpy.DEV = True - logger.debug(u"Tautulli is running in the dev environment.") - - if args.daemon: - if sys.platform == 'win32': - sys.stderr.write( - "Daemonizing not supported under Windows, starting normally\n") - else: - plexpy.DAEMON = True - plexpy.QUIET = True - - if args.nofork: - plexpy.NOFORK = True - logger.info("Tautulli is running as a service, it will not fork when restarted.") - - if args.pidfile: - plexpy.PIDFILE = str(args.pidfile) - - # If the pidfile already exists, plexpy may still be running, so - # exit - if os.path.exists(plexpy.PIDFILE): - try: - with open(plexpy.PIDFILE, 'r') as fp: - pid = int(fp.read()) - os.kill(pid, 0) - except IOError as e: - raise SystemExit("Unable to read PID file: %s", e) - except OSError: - logger.warn("PID file '%s' already exists, but PID %d is " \ - "not running. Ignoring PID file." % - (plexpy.PIDFILE, pid)) - else: - # The pidfile exists and points to a live PID. plexpy may - # still be running, so exit. - raise SystemExit("PID file '%s' already exists. Exiting." % - plexpy.PIDFILE) - - # The pidfile is only useful in daemon mode, make sure we can write the - # file properly - if plexpy.DAEMON: - plexpy.CREATEPID = True - - try: - with open(plexpy.PIDFILE, 'w') as fp: - fp.write("pid\n") - except IOError as e: - raise SystemExit("Unable to write PID file: %s", e) - else: - logger.warn("Not running in daemon mode. PID file creation " \ - "disabled.") - - # Determine which data directory and config file to use - if args.datadir: - plexpy.DATA_DIR = args.datadir - else: - plexpy.DATA_DIR = plexpy.PROG_DIR - - if args.config: - config_file = args.config - else: - config_file = os.path.join(plexpy.DATA_DIR, config.FILENAME) - - # Try to create the DATA_DIR if it doesn't exist - if not os.path.exists(plexpy.DATA_DIR): - try: - os.makedirs(plexpy.DATA_DIR) - except OSError: - raise SystemExit( - 'Could not create data directory: ' + plexpy.DATA_DIR + '. Exiting....') - - # Make sure the DATA_DIR is writeable - if not os.access(plexpy.DATA_DIR, os.W_OK): - raise SystemExit( - 'Cannot write to the data directory: ' + plexpy.DATA_DIR + '. Exiting...') - - # Put the database in the DATA_DIR - plexpy.DB_FILE = os.path.join(plexpy.DATA_DIR, database.FILENAME) - - if plexpy.DAEMON: - plexpy.daemonize() - - # Read config and start logging - plexpy.initialize(config_file) - - # Start the background threads - plexpy.start() - - # Open connection for websocket - try: - web_socket.start_thread() - except: - logger.warn(u"Websocket :: Unable to open connection.") - plexpy.initialize_scheduler() - - # Force the http port if neccessary - if args.port: - http_port = args.port - logger.info('Using forced web server port: %i', http_port) - else: - http_port = int(plexpy.CONFIG.HTTP_PORT) - - # Check if pyOpenSSL is installed. It is required for certificate generation - # and for CherryPy. - if plexpy.CONFIG.ENABLE_HTTPS: - try: - import OpenSSL - except ImportError: - logger.warn("The pyOpenSSL module is missing. Install this " \ - "module to enable HTTPS. HTTPS will be disabled.") - plexpy.CONFIG.ENABLE_HTTPS = False - - # Try to start the server. Will exit here is address is already in use. - web_config = { - 'http_port': http_port, - 'http_host': plexpy.CONFIG.HTTP_HOST, - 'http_root': plexpy.CONFIG.HTTP_ROOT, - 'http_environment': plexpy.CONFIG.HTTP_ENVIRONMENT, - 'http_proxy': plexpy.CONFIG.HTTP_PROXY, - 'enable_https': plexpy.CONFIG.ENABLE_HTTPS, - 'https_cert': plexpy.CONFIG.HTTPS_CERT, - 'https_cert_chain': plexpy.CONFIG.HTTPS_CERT_CHAIN, - 'https_key': plexpy.CONFIG.HTTPS_KEY, - 'http_username': plexpy.CONFIG.HTTP_USERNAME, - 'http_password': plexpy.CONFIG.HTTP_PASSWORD, - 'http_basic_auth': plexpy.CONFIG.HTTP_BASIC_AUTH - } - webstart.initialize(web_config) - - # Open webbrowser - if plexpy.CONFIG.LAUNCH_BROWSER and not args.nolaunch and not plexpy.DEV: - plexpy.launch_browser(plexpy.CONFIG.HTTP_HOST, http_port, - plexpy.CONFIG.HTTP_ROOT) - - # Wait endlessy for a signal to happen - while True: - if not plexpy.SIGNAL: - try: - time.sleep(1) - except KeyboardInterrupt: - plexpy.SIGNAL = 'shutdown' - else: - logger.info('Received signal: %s', plexpy.SIGNAL) - - if plexpy.SIGNAL == 'shutdown': - plexpy.shutdown() - elif plexpy.SIGNAL == 'restart': - plexpy.shutdown(restart=True) - elif plexpy.SIGNAL == 'checkout': - plexpy.shutdown(restart=True, checkout=True) - else: - plexpy.shutdown(restart=True, update=True) - - plexpy.SIGNAL = None - -# Call main() +# Call main() from Tautulli.py if __name__ == "__main__": main() diff --git a/README.md b/README.md index 281589b9..37829290 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,163 @@ # Tautulli -[![Discord](https://img.shields.io/badge/Discord-Tautulli-7289DA.svg?style=flat-square)](https://discord.gg/36ggawe) -[![Reddit](https://img.shields.io/badge/Reddit-Tautulli-FF5700.svg?style=flat-square)](https://www.reddit.com/r/Tautulli/) -[![Plex Forums](https://img.shields.io/badge/Plex%20Forums-Tautulli-E5A00D.svg?style=flat-square)](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) +A python based web application for monitoring, analytics and notifications for +[Plex Media Server](https://plex.tv). -A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv). - -This project is based on code from [Headphones](https://github.com/rembo10/headphones) and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb). +This project is based on code from [Headphones](https://github.com/rembo10/headphones) +and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb). ## Features -* Responsive web design viewable on desktop, tablet and mobile web browsers. -* Themed to complement Plex/Web. -* Easy configuration setup (no separate web server required). -* Monitor current Plex Media Server activity. -* Fully customizable notifications for stream activity and recently added media. -* Top statistics on home page with configurable duration and measurement metric. -* Global watching history with search/filtering & dynamic column sorting. -* Full user list with general information and comparison stats. -* Individual user information including devices IP addresses. -* Complete library statistics and media file information. -* Rich analytics presented using Highcharts graphing. -* Beautiful content information pages. -* Full sync list data on all users syncing items from your library. -* And many more!! +- Responsive web design viewable on desktop, tablet and mobile web browsers. +- Themed to complement Plex/Web. +- Easy configuration setup (no separate web server required). +- Monitor current Plex Media Server activity. +- Fully customizable notifications for stream activity and recently added media. +- Top statistics on home page with configurable duration and measurement metric. +- Global watching history with search/filtering & dynamic column sorting. +- Full user list with general information and comparison stats. +- Individual user information including devices IP addresses. +- Complete library statistics and media file information. +- Rich analytics presented using Highcharts graphing. +- Beautiful content information pages. +- Full sync list data on all users syncing items from your library. +- And many more!! ## Preview -* [Full preview gallery on our website](http://tautulli.com) +[Full preview gallery available on our website][Tautulli] -![Tautulli Homepage](http://tautulli.com/images/screenshots/activity.png?v=2) +![Tautulli Homepage](https://tautulli.com/images/screenshots/activity-compressed.jpg?v=2) -## Installation and Support +## Installation -* [Installation Guides](https://github.com/JonnyWong16/plexpy/wiki/Installation) shows you how to install Tautulli. -* [FAQs](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)) in the wiki can help you with common problems. +[![Python][badge-python]][Python] +[![Docker Pulls][badge-docker-pulls]][DockerHub] +[![Docker Stars][badge-docker-stars]][DockerHub] +[![Downloads][badge-downloads]][Releases Latest] -**Support** the project by implementing new features, solving support tickets and provide bug fixes. +[badge-python]: https://img.shields.io/badge/python->=3.9-blue?style=flat-square +[badge-docker-pulls]: https://img.shields.io/docker/pulls/tautulli/tautulli?style=flat-square +[badge-docker-stars]: https://img.shields.io/docker/stars/tautulli/tautulli?style=flat-square +[badge-downloads]: https://img.shields.io/github/downloads/Tautulli/Tautulli/total?style=flat-square -## Issues +| Status | Branch: `master` | Branch: `beta` | Branch: `nightly` | +| --- | --- | --- | --- | +| Release | [![Release@master][badge-release-master]][Releases Latest]
[![Release Date@master][badge-release-master-date]][Releases Latest] | [![Release@beta][badge-release-beta]][Releases]
[![Commits@beta][badge-release-beta-commits]][Commits Beta] | [![Last Commits@nightly][badge-release-nightly-last-commit]][commits Nightly]
[![Commits@nightly][badge-release-nightly-commits]][Commits Nightly] | +| Docker | [![Docker@master][badge-docker-master]][DockerHub]
[![Docker Build@master][badge-docker-master-ci]][Publish Docker Master] | [![Docker@beta][badge-docker-beta]][DockerHub]
[![Docker Build@beta][badge-docker-beta-ci]][Publish Docker Beta] | [![Docker@nightly][badge-docker-nightly]][DockerHub]
[![Docker Build@nightly][badge-docker-nightly-ci]][Publish Docker Nightly] | +| Snap | [![Snap@master][badge-snap-master]][Snapcraft]
[![Snap Build@master][badge-snap-master-ci]][Publish Snap Master] | [![Snap@beta][badge-snap-beta]][Snapcraft]
[![Snap Build@beta][badge-snap-beta-ci]][Publish Snap Beta] | [![Snap@nightly][badge-snap-nightly]][Snapcraft]
[![Snap Build@nightly][badge-snap-nightly-ci]][Publish Snap Nightly] | +| Installer | [![Windows@master][badge-installer-master-win]][Releases Latest]
[![MacOS@master][badge-installer-master-macos]][Releases Latest]
[![Installer Build@master][badge-installer-master-ci]][Publish Installer Master] | [![Windows@beta][badge-installer-beta-win]][Releases]
[![MacOS@beta][badge-installer-beta-macos]][Releases]
[![Installer Build@beta][badge-installer-beta-ci]][Publish Installer Beta] | [![Installer Build@nightly][badge-installer-nightly-ci]][Publish Installer Nightly] | -##### Many issues can simply be solved by: +Read the [Installation Guides][Installation] for instructions on how to install Tautulli. -- Making sure you update to the latest version. -- Turning your device off and on again. -- Analyzing your logs, you just might find the solution yourself! -- Using the **search** function to see if this issue has already been reported/solved. -- Checking the [Wiki](https://github.com/JonnyWong16/plexpy/wiki) for -[ [Installation] ](https://github.com/JonnyWong16/plexpy/wiki/Installation) and -[ [FAQs] ](https://github.com/JonnyWong16/plexpy/wiki/Frequently-Asked-Questions-(FAQ)). -- For basic questions try asking on [Discord](https://discord.gg/36ggawe), [Reddit](https://www.reddit.com/r/Tautulli), or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue. +[badge-release-master]: https://img.shields.io/github/v/release/Tautulli/Tautulli?style=flat-square +[badge-release-master-date]: https://img.shields.io/github/release-date/Tautulli/Tautulli?style=flat-square&color=blue +[badge-release-beta]: https://img.shields.io/github/v/release/Tautulli/Tautulli?include_prereleases&style=flat-square +[badge-release-beta-commits]: https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/beta?style=flat-square&color=blue +[badge-release-nightly-last-commit]: https://img.shields.io/github/last-commit/Tautulli/Tautulli/nightly?style=flat-square&color=blue +[badge-release-nightly-commits]: https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/nightly?style=flat-square&color=blue +[badge-docker-master]: https://img.shields.io/badge/docker-latest-blue?style=flat-square +[badge-docker-master-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-docker.yml?style=flat-square&branch=master +[badge-docker-beta]: https://img.shields.io/badge/docker-beta-blue?style=flat-square +[badge-docker-beta-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-docker.yml?style=flat-square&branch=beta +[badge-docker-nightly]: https://img.shields.io/badge/docker-nightly-blue?style=flat-square +[badge-docker-nightly-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-docker.yml?style=flat-square&branch=nightly +[badge-snap-master]: https://img.shields.io/badge/snap-stable-blue?style=flat-square +[badge-snap-master-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-snap.yml?style=flat-square&branch=master +[badge-snap-beta]: https://img.shields.io/badge/snap-beta-blue?style=flat-square +[badge-snap-beta-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-snap.yml?style=flat-square&branch=beta +[badge-snap-nightly]: https://img.shields.io/badge/snap-edge-blue?style=flat-square +[badge-snap-nightly-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-snap.yml?style=flat-square&branch=nightly +[badge-installer-master-win]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=windows&style=flat-square +[badge-installer-master-macos]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=macos&style=flat-square +[badge-installer-master-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-installers.yml?style=flat-square&branch=master +[badge-installer-beta-win]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=windows&include_prereleases&style=flat-square +[badge-installer-beta-macos]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=macos&include_prereleases&style=flat-square +[badge-installer-beta-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-installers.yml?style=flat-square&branch=beta +[badge-installer-nightly-ci]: https://img.shields.io/github/actions/workflow/status/Tautulli/Tautulli/.github/workflows/publish-installers.yml?style=flat-square&branch=nightly -##### If nothing has worked: +## Support -1. Open a new issue on the GitHub [issue tracker](http://github.com/JonnyWong16/plexpy/issues). -2. Provide a clear title to easily help identify your problem. -3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks). -4. Make sure you provide the following information: - - [ ] Version - - [ ] Branch - - [ ] Commit hash - - [ ] Operating system - - [ ] Python version - - [ ] What you did? - - [ ] What happened? - - [ ] What you expected? - - [ ] How can we reproduce your issue? - - [ ] What are your (relevant) settings? - - [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). -5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. +[![Wiki][badge-wiki]][Wiki] +[![Discord][badge-discord]][Discord] +[![Reddit][badge-reddit]][Reddit] +[![Plex Forums][badge-forums]][Plex Forums] +[![Issues][badge-issues]][Issues] + +[badge-wiki]: https://img.shields.io/badge/github-wiki-black?style=flat-square +[badge-discord]: https://img.shields.io/discord/183396325142822912?label=discord&style=flat-square&color=7289DA +[badge-reddit]: https://img.shields.io/reddit/subreddit-subscribers/tautulli?label=reddit&style=flat-square&color=FF5700 +[badge-forums]: https://img.shields.io/badge/plex%20forums-discussion-E5A00D?style=flat-square +[badge-issues]: https://img.shields.io/badge/github-issues-black?style=flat-square + +If you think you've found a bug in Tautulli make sure you have read the [FAQ][] +first to make sure it hasn't been covered by one of the questions there. If your +problem isn't answered in the FAQ try the following first: + +- Update to the latest version of Tautulli. +- Turning your device off and on again. +- Analyzing your logs, you just might find the solution yourself! +- Using the **search** function to see if this issue has already been reported/solved. +- Checking the [Wiki][] for [Installation][] instructions and reading the [FAQs][FAQ]. +- For basic questions try asking on [Discord][], [Reddit][], + or the [Plex Forums][] first before opening an issue. + +**If nothing has worked:** + +1. Please check the [issues tracker][Issues] to see if someone else has already reported the bug. +2. If this is a new bug, open a [bug report][Issue New] on the issues tracker. +3. Provide a clear title to easily help identify your problem. +4. Use proper [Markdown syntax][] to structure your post (i.e. code/log in code blocks). +5. Make sure to fill out the required information on the issue template. +6. Close your issue when it's solved! If you found the solution yourself please + comment so that others benefit from it. ## Feature Requests -Feature requests are handled on [FeatHub](http://feathub.com/JonnyWong16/plexpy). - -1. Search the existing requests to see if your suggestion has already been submitted. -2. If a similar request exists, give it a thumbs up (+1), or add additional comments to the request. -3. If no similar requests exist, you can create a new one. Make sure to provide a clear title to easily identify the feature request. +1. Pleases check the [issues tracker][Issues] to see if someone else has already requested the feature. + If a similar idea has already been requested, _give it a thumbs up_. **Do not comment + with `+1` or something similar as it creates unnecessary spam.** +2. If this is a new feature request, open a [feature request][Issue New] on the issues tracker. ## License -This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included. +[![License][badge-license]][License] -This software includes Highsoft software libraries which you may freely distribute for non-commercial use. Commerical users must licence this software, for more information visit https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution. \ No newline at end of file +[badge-license]: https://img.shields.io/github/license/Tautulli/Tautulli?style=flat-square + +This is free software under the GPL v3 open source license. Feel free to do with it what you wish, +but any modification must be open sourced. A copy of the license is included. + +This software includes Highsoft software libraries which you may freely distribute for +non-commercial use. Commercial users must licence this software, for more information visit +https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution. + + +[Python]: https://python.org/downloads +[DockerHub]: https://hub.docker.com/r/tautulli/tautulli +[Releases]: https://github.com/Tautulli/Tautulli/releases +[Releases Latest]: https://github.com/Tautulli/Tautulli/releases/latest +[License]: https://github.com/Tautulli/Tautulli/blob/master/LICENSE +[FAQ]: https://github.com/Tautulli/Tautulli/wiki/Frequently-Asked-Questions +[Installation]: https://github.com/Tautulli/Tautulli/wiki/Installation +[Issues]: https://github.com/Tautulli/Tautulli/issues +[Issue New]: https://github.com/Tautulli/Tautulli/issues/new/choose +[Markdown syntax]: https://help.github.com/articles/github-flavored-markdown +[Tautulli]: http://tautulli.com +[Wiki]: https://github.com/Tautulli/Tautulli/wiki +[Discord]: https://tautulli.com/discord +[Reddit]: https://reddit.com/r/Tautulli +[Plex Forums]: https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242 +[Snapcraft]: https://snapcraft.io/tautulli +[Commits Beta]: https://github.com/Tautulli/Tautulli/commits/beta +[Commits Nightly]: https://github.com/Tautulli/Tautulli/commits/nightly + +[Publish Docker Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Amaster +[Publish Docker Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Abeta +[Publish Docker Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Anightly +[Publish Snap Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Amaster +[Publish Snap Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Abeta +[Publish Snap Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Anightly +[Publish Installer Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Amaster +[Publish Installer Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Abeta +[Publish Installer Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Anightly diff --git a/Tautulli.py b/Tautulli.py new file mode 100755 index 00000000..b3cf4736 --- /dev/null +++ b/Tautulli.py @@ -0,0 +1,342 @@ +#!/usr/bin/env python + +# -*- coding: utf-8 -*- + +# This file is part of Tautulli. +# +# Tautulli is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Tautulli is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Tautulli. If not, see . + +import os +import sys + +# Ensure lib added to path, before any other imports +sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), 'lib')) + + +import argparse +import datetime +import locale +import platformdirs +import pytz +import signal +import shutil +import time +import threading +import tzlocal +import ctypes + +import plexpy +from plexpy import common, config, database, helpers, logger, webstart +if common.PLATFORM == 'Windows': + from plexpy import windows +elif common.PLATFORM == 'Darwin': + from plexpy import macos + +# Register signals, such as CTRL + C +signal.signal(signal.SIGINT, plexpy.sig_handler) +signal.signal(signal.SIGTERM, plexpy.sig_handler) + + +def main(): + """ + Tautulli application entry point. Parses arguments, setups encoding and + initializes the application. + """ + + # Fixed paths to Tautulli + if hasattr(sys, 'frozen') and hasattr(sys, '_MEIPASS'): + plexpy.FROZEN = True + plexpy.FULL_PATH = os.path.abspath(sys.executable) + plexpy.PROG_DIR = sys._MEIPASS + else: + plexpy.FULL_PATH = os.path.abspath(__file__) + plexpy.PROG_DIR = os.path.dirname(plexpy.FULL_PATH) + + plexpy.ARGS = sys.argv[1:] + + # From sickbeard + plexpy.SYS_PLATFORM = sys.platform + plexpy.SYS_ENCODING = None + + try: + + # Attempt to get the system's locale settings + language_code, encoding = locale.getlocale() + + # Special handling for Windows platform + if sys.platform == 'win32': + # Get the user's current language settings on Windows + windll = ctypes.windll.kernel32 + lang_id = windll.GetUserDefaultLCID() + + # Map Windows language ID to locale identifier + language_code = locale.windows_locale.get(lang_id, '') + + # Get the preferred encoding + encoding = locale.getpreferredencoding() + + # Assign values to application-specific variable + plexpy.SYS_LANGUAGE = language_code + plexpy.SYS_ENCODING = encoding + + except (locale.Error, IOError): + pass + + # for OSes that are poorly configured I'll just force UTF-8 + if not plexpy.SYS_ENCODING or plexpy.SYS_ENCODING in ('ANSI_X3.4-1968', 'US-ASCII', 'ASCII'): + plexpy.SYS_ENCODING = 'UTF-8' + + # Set up and gather command line arguments + parser = argparse.ArgumentParser( + description='A Python based monitoring and tracking tool for Plex Media Server.') + + parser.add_argument( + '-v', '--verbose', action='store_true', help='Increase console logging verbosity') + parser.add_argument( + '-q', '--quiet', action='store_true', help='Turn off console logging') + parser.add_argument( + '-d', '--daemon', action='store_true', help='Run as a daemon') + parser.add_argument( + '-p', '--port', type=int, help='Force Tautulli to run on a specified port') + parser.add_argument( + '--dev', action='store_true', help='Start Tautulli in the development environment') + parser.add_argument( + '--datadir', help='Specify a directory where to store your data files') + parser.add_argument( + '--config', help='Specify a config file to use') + parser.add_argument( + '--nolaunch', action='store_true', help='Prevent browser from launching on startup') + parser.add_argument( + '--pidfile', help='Create a pid file (only relevant when running as a daemon)') + parser.add_argument( + '--nofork', action='store_true', help='Start Tautulli as a service, do not fork when restarting') + + args = parser.parse_args() + + if args.verbose: + plexpy.VERBOSE = True + if args.quiet: + plexpy.QUIET = True + + # Do an initial setup of the logger. + # Require verbose for pre-initilization to see critical errors + logger.initLogger(console=not plexpy.QUIET, log_dir=False, verbose=True) + + try: + plexpy.SYS_TIMEZONE = tzlocal.get_localzone() + except (pytz.UnknownTimeZoneError, LookupError, ValueError) as e: + logger.error("Could not determine system timezone: %s" % e) + plexpy.SYS_TIMEZONE = pytz.UTC + + plexpy.SYS_UTC_OFFSET = datetime.datetime.now(plexpy.SYS_TIMEZONE).strftime('%z') + + if helpers.bool_true(os.getenv('TAUTULLI_DOCKER', False)): + plexpy.DOCKER = True + plexpy.DOCKER_MOUNT = not os.path.isfile('/config/DOCKER') + if helpers.bool_true(os.getenv('TAUTULLI_SNAP', False)): + plexpy.SNAP = True + + if args.dev: + plexpy.DEV = True + logger.debug("Tautulli is running in the dev environment.") + + if args.daemon: + if sys.platform == 'win32': + logger.warn("Daemonizing not supported under Windows, starting normally") + else: + plexpy.DAEMON = True + plexpy.QUIET = True + + if args.nofork: + plexpy.NOFORK = True + logger.info("Tautulli is running as a service, it will not fork when restarted.") + + if args.pidfile: + plexpy.PIDFILE = str(args.pidfile) + + # If the pidfile already exists, plexpy may still be running, so + # exit + if os.path.exists(plexpy.PIDFILE): + try: + with open(plexpy.PIDFILE, 'r') as fp: + pid = int(fp.read()) + except IOError as e: + raise SystemExit("Unable to read PID file: %s", e) + + try: + os.kill(pid, 0) + except OSError: + logger.warn("PID file '%s' already exists, but PID %d is " + "not running. Ignoring PID file." % + (plexpy.PIDFILE, pid)) + else: + # The pidfile exists and points to a live PID. plexpy may + # still be running, so exit. + raise SystemExit("PID file '%s' already exists. Exiting." % + plexpy.PIDFILE) + + # The pidfile is only useful in daemon mode, make sure we can write the + # file properly + if plexpy.DAEMON: + plexpy.CREATEPID = True + + try: + with open(plexpy.PIDFILE, 'w') as fp: + fp.write("pid\n") + except IOError as e: + raise SystemExit("Unable to write PID file: %s", e) + else: + logger.warn("Not running in daemon mode. PID file creation " \ + "disabled.") + + # Determine which data directory and config file to use + if args.datadir: + plexpy.DATA_DIR = args.datadir + elif plexpy.FROZEN: + plexpy.DATA_DIR = platformdirs.user_data_dir("Tautulli", False) + else: + plexpy.DATA_DIR = plexpy.PROG_DIR + + # Migrate Snap data dir + if plexpy.SNAP: + snap_common = os.environ['SNAP_COMMON'] + old_data_dir = os.path.join(snap_common, 'Tautulli') + if os.path.exists(old_data_dir) and os.listdir(old_data_dir): + plexpy.SNAP_MIGRATE = True + logger.info("Migrating Snap user data.") + shutil.move(old_data_dir, plexpy.DATA_DIR) + + if args.config: + config_file = args.config + else: + config_file = os.path.join(plexpy.DATA_DIR, config.FILENAME) + + # Try to create the DATA_DIR if it doesn't exist + if not os.path.exists(plexpy.DATA_DIR): + try: + os.makedirs(plexpy.DATA_DIR) + except OSError: + raise SystemExit( + 'Could not create data directory: ' + plexpy.DATA_DIR + '. Exiting....') + + # Make sure the DATA_DIR is writeable + test_file = os.path.join(plexpy.DATA_DIR, '.TEST') + try: + with open(test_file, 'w'): + pass + except IOError: + raise SystemExit( + 'Cannot write to the data directory: ' + plexpy.DATA_DIR + '. Exiting...') + finally: + try: + os.remove(test_file) + except OSError: + pass + + # Put the database in the DATA_DIR + plexpy.DB_FILE = os.path.join(plexpy.DATA_DIR, database.FILENAME) + + # Move 'plexpy.db' to 'tautulli.db' + if os.path.isfile(os.path.join(plexpy.DATA_DIR, 'plexpy.db')) and \ + not os.path.isfile(os.path.join(plexpy.DATA_DIR, plexpy.DB_FILE)): + try: + os.rename(os.path.join(plexpy.DATA_DIR, 'plexpy.db'), plexpy.DB_FILE) + except OSError as e: + raise SystemExit("Unable to rename plexpy.db to tautulli.db: %s", e) + + if plexpy.DAEMON: + plexpy.daemonize() + + # Read config and start logging + plexpy.initialize(config_file) + + # Start the background threads + plexpy.start() + + # Force the http port if necessary + if args.port: + plexpy.HTTP_PORT = args.port + logger.info('Using forced web server port: %i', plexpy.HTTP_PORT) + else: + plexpy.HTTP_PORT = int(plexpy.CONFIG.HTTP_PORT) + + # Try to start the server. Will exit here is address is already in use. + webstart.start() + + if common.PLATFORM == 'Windows': + if plexpy.CONFIG.SYS_TRAY_ICON: + plexpy.WIN_SYS_TRAY_ICON = windows.WindowsSystemTray() + plexpy.WIN_SYS_TRAY_ICON.start() + windows.set_startup() + elif common.PLATFORM == 'Darwin': + macos.set_startup() + + # Open webbrowser + if plexpy.CONFIG.LAUNCH_BROWSER and not args.nolaunch and not plexpy.DEV: + plexpy.launch_browser(plexpy.CONFIG.HTTP_HOST, plexpy.HTTP_PORT, + plexpy.HTTP_ROOT) + + if common.PLATFORM == 'Darwin' and plexpy.CONFIG.SYS_TRAY_ICON: + if not macos.HAS_PYOBJC: + logger.warn("The pyobjc module is missing. Install this " + "module to enable the MacOS menu bar icon.") + plexpy.CONFIG.SYS_TRAY_ICON = False + + if plexpy.CONFIG.SYS_TRAY_ICON: + # MacOS menu bar icon must be run on the main thread and is blocking + # Start the rest of Tautulli on a new thread + thread = threading.Thread(target=wait) + thread.daemon = True + thread.start() + + plexpy.MAC_SYS_TRAY_ICON = macos.MacOSSystemTray() + plexpy.MAC_SYS_TRAY_ICON.start() + else: + wait() + else: + wait() + + +def wait(): + logger.info("Tautulli is ready!") + + # Wait endlessly for a signal to happen + while True: + if not plexpy.SIGNAL: + try: + time.sleep(1) + except KeyboardInterrupt: + plexpy.SIGNAL = 'shutdown' + else: + logger.info('Received signal: %s', plexpy.SIGNAL) + + if plexpy.SIGNAL == 'shutdown': + plexpy.shutdown() + elif plexpy.SIGNAL == 'restart': + plexpy.shutdown(restart=True) + elif plexpy.SIGNAL == 'checkout': + plexpy.shutdown(restart=True, checkout=True) + elif plexpy.SIGNAL == 'reset': + plexpy.shutdown(restart=True, reset=True) + elif plexpy.SIGNAL == 'update': + plexpy.shutdown(restart=True, update=True) + else: + logger.error('Unknown signal. Shutting down...') + plexpy.shutdown() + + plexpy.SIGNAL = None + + +if __name__ == "__main__": + main() diff --git a/contrib/clean_pyc.bat b/contrib/clean_pyc.bat new file mode 100755 index 00000000..e4436dea --- /dev/null +++ b/contrib/clean_pyc.bat @@ -0,0 +1,11 @@ +@echo off +:: Display information +echo This script will remove *.pyc files. These files are generated by Python, but they can cause conflicts after an upgrade. It's safe to remove them, because they will be regenerated. +echo Press enter to continue, or CTRL + C to quit. +pause + +cd ..\ +:: Remove *.pyc files +del /S *.pyc +:: Remove __pycache__ folders +for /d /r . %%d in (__pycache__) do @if exist "%%d" rd /s /q "%%d" \ No newline at end of file diff --git a/contrib/clean_pyc.sh b/contrib/clean_pyc.sh index e3d47e44..ea555159 100755 --- a/contrib/clean_pyc.sh +++ b/contrib/clean_pyc.sh @@ -1,9 +1,11 @@ -#!/bin/bash +#!/usr/bin/env bash # Display information echo "This script will remove *.pyc files. These files are generated by Python, but they can cause conflicts after an upgrade. It's safe to remove them, because they will be regenerated." echo "Press enter to continue, or CTRL + C to quit." read -# Remove the *.pyc -find "`dirname $0`/.." -type f -name "*.pyc" -exec rm -rf {} \; \ No newline at end of file +# Remove *.pyc files +find "`dirname $0`/.." -type f -name "*.pyc" -exec rm -rf {} \; +# Remove __pycache__ folders +find "`dirname $0`/.." -type d -name "__pycache__" -exec rm -rf {} \; \ No newline at end of file diff --git a/contrib/downgrade.sh b/contrib/downgrade.sh index edd4779e..e4822c46 100755 --- a/contrib/downgrade.sh +++ b/contrib/downgrade.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash # Parameter check if [ -z "$1" ]; then diff --git a/data/interfaces/default/app_import.html b/data/interfaces/default/app_import.html index 0f0c8351..74af4313 100644 --- a/data/interfaces/default/app_import.html +++ b/data/interfaces/default/app_import.html @@ -5,46 +5,105 @@

Import ${app} Database

-

- <% - v = '' - if app == 'PlexWatch': - v = '0.3.2' - elif app == 'Plexivity': - v = '0.9.8' - %> - Please ensure your ${app} database is at version ${v} or higher. -

-
- -
-
- +
+ + % if app in ('PlexWatch', 'Plexivity'): +

+ <% + v = '' + if app == 'PlexWatch': + v = '0.3.2' + elif app == 'Plexivity': + v = '0.9.8' + %> + Please ensure your ${app} database is at version ${v} or higher. +

+ % endif +
+ +
+
+
+ + +
+
+

Upload the ${app} database file you wish to import (max file size is 1GB).

-

Enter the path and file name for the ${app} database you wish to import.

-
-
- -
-
- +
+ +
+
+
+ + + + +
+
+

Browse for the ${app} database file you wish to import.

-

The table name from which you wish to import. Only import one of these, importing both will result in duplicated data.

-
-
- -
-
- + % if app == 'Tautulli': +
+ +
+
+ +
+

Select how you would like to import the Tautulli history.

+
    +
  • Merge will add all history and remove any duplicates from the imported database into the current database.
    • +
  • Overwrite will replace all history in the current database with the imported database.
    • +
-

Enter the minimum duration (in seconds) an item must have been active for. Set to 0 to import all.

-
+
+ +

Automatically create a backup of the current database before importing.

+
+
+ +

The following data will also be imported:

+
    +
  • Libraries and Users
    • +
  • Notification / Newsletter Agents
    • +
  • Registered Mobile Devices
    • +
+
+ % else: +
+ +
+
+ +
+
+

Select the table name from which you wish to import. Only import one of these, importing both will result in duplicated data.

+
+
+ +
+
+ +
+
+

Enter the minimum duration (in seconds) an item must have been active for. Set to 0 to import all.

+
+ % endif +
@@ -55,24 +114,87 @@
+ + + + + + + + - + + ${next.javascriptIncludes()} diff --git a/data/interfaces/default/config_import.html b/data/interfaces/default/config_import.html new file mode 100644 index 00000000..984e482f --- /dev/null +++ b/data/interfaces/default/config_import.html @@ -0,0 +1,138 @@ +
+
+
+ +

${title}

+
+
+
+
+ +
+
+
+ + +
+
+
+

Upload the Tautulli configuration file you wish to import.

+
+
+ +
+
+
+ + + + +
+
+
+

Browse for the Tautulli configuration file you wish to import.

+
+
+ +

Automatically create a backup of the current configuration before importing.

+
+
+ +

The following settings will not be imported:

+
    +
  • Git Path, Log / Backup / Cache Directory, Plex Logs Folder
    • +
  • Custom Newsletter Templates Folder, Newsletter Output Directory
    • +
  • HTTP Host / Port / Root / Username / Password
    • +
  • Enable HTTPS, HTTPS Certificate / Certificate Chain / Key
    • +
+
+
+
+
+
+ + +
+
+
+
+ \ No newline at end of file diff --git a/data/interfaces/default/configuration_table.html b/data/interfaces/default/configuration_table.html index ee6e8943..e0f3155d 100644 --- a/data/interfaces/default/configuration_table.html +++ b/data/interfaces/default/configuration_table.html @@ -11,6 +11,7 @@ DOCUMENTATION :: END <%! import os + import sqlite3 import sys import plexpy from plexpy import common, logger @@ -22,11 +23,11 @@ DOCUMENTATION :: END % if plexpy.CURRENT_VERSION: Git Branch: - ${plexpy.CONFIG.GIT_BRANCH} + ${plexpy.CONFIG.GIT_BRANCH} Git Commit Hash: - ${plexpy.CURRENT_VERSION} + ${plexpy.CURRENT_VERSION} % endif @@ -35,7 +36,7 @@ DOCUMENTATION :: END Database File: - ${plexpy.DB_FILE} + ${plexpy.DB_FILE} | Status Log File: @@ -50,12 +51,12 @@ DOCUMENTATION :: END ${plexpy.CONFIG.CACHE_DIR} - GeoLite2 Database: - % if plexpy.CONFIG.GEOIP_DB: - ${plexpy.CONFIG.GEOIP_DB} | Reinstall / Update | Uninstall - % else: - Click here to install the GeoLite2 database. - % endif + Export Directory: + ${plexpy.CONFIG.EXPORT_DIR} + + + Newsletter Directory: + ${plexpy.CONFIG.NEWSLETTER_DIR} % if plexpy.ARGS: @@ -65,28 +66,40 @@ DOCUMENTATION :: END % endif Platform: - ${common.PLATFORM} ${common.PLATFORM_VERSION} + ${'[Docker] ' if plexpy.DOCKER else ''}${common.PLATFORM} ${common.PLATFORM_RELEASE} (${common.PLATFORM_VERSION + (' - {}'.format(common.PLATFORM_LINUX_DISTRO) if common.PLATFORM_LINUX_DISTRO else '')}) + + + System Timezone: + ${str(plexpy.SYS_TIMEZONE)} (${'UTC{}'.format(plexpy.SYS_UTC_OFFSET)}) + + + System Language: + ${plexpy.SYS_LANGUAGE}${' (override {})'.format(plexpy.CONFIG.PMS_LANGUAGE) if plexpy.CONFIG.PMS_LANGUAGE else ''} Python Version: ${sys.version} + + SQLite Version: + ${sqlite3.sqlite_version} + Resources: - Tautulli Website | - GitHub Source | - GitHub Issues | - GitHub Wiki & FAQ | - FeatHub Feature Requests | + Tautulli Website | + Source | + Wiki | + Bug Reports | + Feature Requests Support: - Tautulli Discord Server | - Tautulli Subreddit | - Plex Forums + Tautulli Discord Server | + Tautulli Subreddit | + Plex Forums @@ -94,22 +107,6 @@ DOCUMENTATION :: END + % if len(data['ip_address']) > 20: + ${data['ip_address']} + % else: + ${data['ip_address']} + % endif + % if data['relayed']: + + % else: + + + + + % endif % else: N/A % endif @@ -289,17 +345,18 @@ DOCUMENTATION :: END
  • Bandwidth
    - % if data['media_type'] != 'photo' and helpers.cast_to_int(data['bandwidth']): + % if data['media_type'] != 'photo' and data['bandwidth'] != 'Unknown': <% - bw = helpers.cast_to_int(data['bandwidth']) - if bw != "Unknown": - if bw > 1000: - bw = str(round(bw / 1000.0, 1)) + ' Mbps' - else: - bw = str(bw) + ' kbps' + bw = cast_to_int(data['bandwidth']) + if bw > 1000000: + bw = str(round(bw / 1000000.0, 1)) + ' Gbps' + elif bw > 1000: + bw = str(round(bw / 1000.0, 1)) + ' Mbps' + else: + bw = str(bw) + ' kbps' %> ${bw} - + % elif data['synced_version'] == 1 or data['channel_stream'] == 1: None % else: @@ -312,7 +369,9 @@ DOCUMENTATION :: END
    % if data['media_type'] != 'photo':
    - % if data['view_offset']: + % if data['live']: +
    ${data['channel_title'] or (data['channel_vcn'] + ' ' + data['channel_call_sign'])} + % elif data['view_offset']: ETA: % endif \ No newline at end of file diff --git a/data/interfaces/default/edit_user.html b/data/interfaces/default/edit_user.html index f53a63ca..ebb18867 100644 --- a/data/interfaces/default/edit_user.html +++ b/data/interfaces/default/edit_user.html @@ -21,6 +21,7 @@ is_restricted Returns bool value for whether the user account is restricte do_notify Returns bool value for whether to send notifications for the user. keep_history Returns bool value for whether to keep history for the user. allow_guest Returns bool value for whether to allow guest access for the user. +deleted_user Returns bool value for whether the user is marked as deleted. DOCUMENTATION :: END @@ -74,6 +75,12 @@ DOCUMENTATION :: END

    DANGER ZONE! Click the purge button to remove all history logged for this user. This is permanent!

    % endif + % if data['deleted_user']: +
    + +

    Click to re-add the user to the Tautulli users list.

    +
    + % endif
    • @@ -122,12 +129,10 @@ DOCUMENTATION :: END confirmAjaxCall(url, msg, { user_id: '${data["user_id"]}' }, null, function () { location.reload(); }); }); - $(document).ready(function() { - // Move #confirm-modal-purge to parent container - if (!($('#edit-user-modal').next().is('#confirm-modal-purge'))) { - $('#confirm-modal-purge').appendTo($('#edit-user-modal').parent()); - } - $('#edit-user-modal > #confirm-modal-purge').remove(); + $('#undelete-user').click(function () { + var msg = 'Are you sure you want to undelete this user?'; + var url = 'undelete_user'; + confirmAjaxCall(url, msg, { user_id: '${data["user_id"]}' }, null, function () { location.reload(); }); }); % endif \ No newline at end of file diff --git a/data/interfaces/default/export_modal.html b/data/interfaces/default/export_modal.html new file mode 100644 index 00000000..390ee268 --- /dev/null +++ b/data/interfaces/default/export_modal.html @@ -0,0 +1,310 @@ +<%doc> +USAGE DOCUMENTATION :: PLEASE LEAVE THIS AT THE TOP OF THIS FILE + +For Mako templating syntax documentation please visit: http://docs.makotemplates.org/en/latest/ + +Filename: export_modal.html +Version: 0.1 +Variable names: data [list] + +data :: Usable parameters + +== Global keys == + +DOCUMENTATION :: END + +<% + import plexpy + from plexpy import exporter + from plexpy.helpers import anon_url + export = exporter.Export() + thumb_media_types = ', '.join([export.PLURAL_MEDIA_TYPES[k] for k, v in export.MEDIA_TYPES.items() if v[0]]) + art_media_types = ', '.join([export.PLURAL_MEDIA_TYPES[k] for k, v in export.MEDIA_TYPES.items() if v[1]]) + logo_media_types = ', '.join([export.PLURAL_MEDIA_TYPES[k] for k, v in export.MEDIA_TYPES.items() if v[2]]) +%> +
    +
    +
    + + +
    +
    +
    + + + + + + +
    + +

    + Please see the Exporter Guide for more details about each option. +

    +
    +
    + +
    +
    + +
    +
    +

    Select the export data file format.

    +
    + % if not rating_key: +
    + +

    Enable to export one file for each ${media_type} instead of a single file containing all ${media_type}s.

    +
    + % endif +
    + +
    +
    + +
    +
    +

    Select the metadata export level. Higher levels include all fields from the lower levels.

    +
    +
    + +
    +
    + +
    +
    +

    Add additional fields to the selected metadata export level.

    +
    +
    + +
    +
    + +
    +
    +

    Select the media info export level. Higher levels include all fields from the lower levels.

    +
    +
    + +
    +
    + +
    +
    +

    Add additional fields to the selected media info export level.

    +
    +
    + +
    +
    + +
    +
    +

    + Select the level to export poster and cover image files.
    Note: Only applies to ${thumb_media_types}. +

    +
    +
    + +
    +
    + +
    +
    +

    + Select the level to export background artwork image files.
    Note: Only applies to ${art_media_types}. +

    +
    +
    + +
    +
    + +
    +
    +

    + Select the level to export logo image files.
    Note: Only applies to ${logo_media_types}. +

    +
    +

    + Warning: Exporting images may take a long time! Images will be saved to a folder alongside the data file. +

    +
    +
    +
    +
    + +
    +
    +
    +
    + + \ No newline at end of file diff --git a/data/interfaces/default/fonts/FontAwesome.otf b/data/interfaces/default/fonts/FontAwesome.otf deleted file mode 100644 index 681bdd4d..00000000 Binary files a/data/interfaces/default/fonts/FontAwesome.otf and /dev/null differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-brands-400.eot b/data/interfaces/default/fonts/font-awesome/fa-brands-400.eot new file mode 100644 index 00000000..f8e48185 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-brands-400.eot differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-brands-400.svg b/data/interfaces/default/fonts/font-awesome/fa-brands-400.svg new file mode 100644 index 00000000..68eb65a1 --- /dev/null +++ b/data/interfaces/default/fonts/font-awesome/fa-brands-400.svg @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/data/interfaces/default/fonts/font-awesome/fa-brands-400.ttf b/data/interfaces/default/fonts/font-awesome/fa-brands-400.ttf new file mode 100644 index 00000000..2b00dae7 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-brands-400.ttf differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff b/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff new file mode 100644 index 00000000..9e4b7e1c Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff2 b/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff2 new file mode 100644 index 00000000..b9e58c5e Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-brands-400.woff2 differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-regular-400.eot b/data/interfaces/default/fonts/font-awesome/fa-regular-400.eot new file mode 100644 index 00000000..5217c95f Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-regular-400.eot differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-regular-400.svg b/data/interfaces/default/fonts/font-awesome/fa-regular-400.svg new file mode 100644 index 00000000..5f495431 --- /dev/null +++ b/data/interfaces/default/fonts/font-awesome/fa-regular-400.svg @@ -0,0 +1,467 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/data/interfaces/default/fonts/font-awesome/fa-regular-400.ttf b/data/interfaces/default/fonts/font-awesome/fa-regular-400.ttf new file mode 100644 index 00000000..cefbd50f Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-regular-400.ttf differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff b/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff new file mode 100644 index 00000000..954b0593 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff2 b/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff2 new file mode 100644 index 00000000..bd35950e Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-regular-400.woff2 differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-solid-900.eot b/data/interfaces/default/fonts/font-awesome/fa-solid-900.eot new file mode 100644 index 00000000..cc691d63 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-solid-900.eot differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-solid-900.svg b/data/interfaces/default/fonts/font-awesome/fa-solid-900.svg new file mode 100644 index 00000000..1534b64b --- /dev/null +++ b/data/interfaces/default/fonts/font-awesome/fa-solid-900.svg @@ -0,0 +1,2231 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/data/interfaces/default/fonts/font-awesome/fa-solid-900.ttf b/data/interfaces/default/fonts/font-awesome/fa-solid-900.ttf new file mode 100644 index 00000000..618136ab Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-solid-900.ttf differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff b/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff new file mode 100644 index 00000000..af476578 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff differ diff --git a/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff2 b/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff2 new file mode 100644 index 00000000..9ef566a9 Binary files /dev/null and b/data/interfaces/default/fonts/font-awesome/fa-solid-900.woff2 differ diff --git a/data/interfaces/default/fonts/fontawesome-webfont.eot b/data/interfaces/default/fonts/fontawesome-webfont.eot deleted file mode 100644 index a30335d7..00000000 Binary files a/data/interfaces/default/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/data/interfaces/default/fonts/fontawesome-webfont.svg b/data/interfaces/default/fonts/fontawesome-webfont.svg deleted file mode 100644 index 6fd19abc..00000000 --- a/data/interfaces/default/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,640 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/data/interfaces/default/fonts/fontawesome-webfont.ttf b/data/interfaces/default/fonts/fontawesome-webfont.ttf deleted file mode 100644 index d7994e13..00000000 Binary files a/data/interfaces/default/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/data/interfaces/default/fonts/fontawesome-webfont.woff b/data/interfaces/default/fonts/fontawesome-webfont.woff deleted file mode 100644 index 6fd4ede0..00000000 Binary files a/data/interfaces/default/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/data/interfaces/default/fonts/fontawesome-webfont.woff2 b/data/interfaces/default/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 5560193c..00000000 Binary files a/data/interfaces/default/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/data/interfaces/default/graphs.html b/data/interfaces/default/graphs.html index ac6a8294..7201c35f 100644 --- a/data/interfaces/default/graphs.html +++ b/data/interfaces/default/graphs.html @@ -1,8 +1,9 @@ <%inherit file="base.html"/> <%def name="headIncludes()"> - - + + + <%def name="body()"> @@ -11,155 +12,49 @@
    Graphs
    - -
    -